videosite.pl

   1 # autodownload flash videos
   2 #
   3 # (c) 2007-2008 by Ralf Ertzinger <ralf@camperquake.de>
   4 # licensed under GNU GPL v2
   5 #
   6 # Based on youtube.pl by Christian Garbs <mitch@cgarbs.de>
   7 # which in turn is
   8 # based on trigger.pl by Wouter Coekaerts <wouter@coekaerts.be>
   9
  10 use strict;
  11 use Irssi 20020324 qw (command_bind command_runsub signal_add_first signal_add_last);
  12 use vars qw($VERSION %IRSSI);
  13 use XML::Simple;
  14 use Data::Dumper;
  15 use File::Spec;
  16
  17 my @grabbers;
  18 my @getters;
  19 my $getter;
  20 my $conf;
  21 my $conffile = File::Spec->catfile(Irssi::get_irssi_dir(), 'videosite.xml');
  22 my $plugindir = File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite');
  23
  24 my $PARAMS = {
  25     'getter' => '',
  26     'mode' => 'download'
  27 };
  28
  29
  30 # activate debug here
  31 my $debug = 0;
  32
  33 # "message public", SERVER_REC, char *msg, char *nick, char *address, char *target
  34 signal_add_last("message public" => sub {check_for_link(\@_,1,4,2,0);});
  35 # "message own_public", SERVER_REC, char *msg, char *target
  36 signal_add_last("message own_public" => sub {check_for_link(\@_,1,2,-1,0);});
  37
  38 # "message private", SERVER_REC, char *msg, char *nick, char *address
  39 signal_add_last("message private" => sub {check_for_link(\@_,1,-1,2,0);});
  40 # "message own_private", SERVER_REC, char *msg, char *target, char *orig_target
  41 signal_add_last("message own_private" => sub {check_for_link(\@_,1,2,-1,0);});
  42
  43 # "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target
  44 signal_add_last("message irc action" => sub {check_for_link(\@_,1,4,2,0);});
  45 # "message irc own_action", SERVER_REC, char *msg, char *target
  46 signal_add_last("message irc own_action" => sub {check_for_link(\@_,1,2,-1,0);});
  47
  48 sub write_irssi {
  49     my $witem = shift;
  50     my @text = @_;
  51
  52     $text[0] = 'videosite: ' . $text[0];
  53
  54     if (defined $witem) {
  55         $witem->print(sprintf(shift(@text), @text), MSGLEVEL_CLIENTCRAP);
  56     } else {
  57         Irssi::print(sprintf(shift(@text), @text));
  58     }
  59
  60 }
  61
  62 sub write_debug {
  63     if ($debug) {
  64         write_irssi(shift, @_);
  65     }
  66 }
  67
  68 sub check_for_link {
  69     my ($signal,$parammessage,$paramchannel,$paramnick,$paramserver) = @_;
  70     my $server = $signal->[$paramserver];
  71     my $target = $signal->[$paramchannel];
  72     my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
  73     my $g;
  74     my $m;
  75
  76
  77     my $witem;
  78     if (defined $server) {
  79         $witem = $server->window_item_find($target);
  80     } else {
  81         $witem = Irssi::window_item_find($target);
  82     }
  83
  84     # Look if we should ignore this line
  85     if ($message =~ m,(?:\s|^)/nosave(?:\s|$),) {
  86         return;
  87     }
  88
  89     # Offer the message to all Grabbers in turn
  90     foreach $g (@grabbers) {
  91         if (defined($m = $g->get($message))) {
  92             write_debug($witem, 'Metadata: %s', Dumper($m));
  93             if ('download' eq ($conf->{'videosite'}->{'mode'})) {
  94                 write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
  95                 unless($getter->get($m)) {
  96                     write_irssi($witem, '%%R>>> FAILED');
  97                 }
  98             } elsif ('display' eq ($conf->{'videosite'}->{'mode'})) {
  99                 write_irssi($witem, '%%M>>> %%NSaw %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
 100             } else {
 101                 write_irssi($witem, '%%R>>> Invalid operation mode');
 102             }
 103         }
 104     }
 105 }
 106
 107 sub cmd_save {
 108
 109     eval {
 110         open(CONF, '>'.$conffile) or die 'Could not open config file';
 111         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
 112         close(CONF);
 113     };
 114     if ($@) {
 115         write_irssi(undef, 'Could not save config to %s: %s', ($conffile, $@));
 116     } else {
 117         write_irssi(undef, 'configuration saved to %s', $conffile);
 118     }
 119 }
 120
 121 sub cmd_set {
 122     my $target = shift;
 123     my $key = shift;
 124     my $val = shift;
 125     my $p;
 126
 127     foreach $p (@getters, @grabbers) {
 128         if ($p->{'NAME'} eq $target) {
 129             $p->setval($key, $val);
 130             return;
 131         }
 132     }
 133     write_irssi(undef, 'No such module');
 134 }
 135
 136
 137 sub cmd_enable {
 138     my $target = shift;
 139     my $p;
 140
 141     foreach $p (@grabbers) {
 142         if ($p->{'NAME'} eq $target) {
 143             $p->enable();
 144             return;
 145         }
 146     }
 147     write_irssi(undef, 'No such module');
 148 }
 149
 150
 151 sub cmd_disable {
 152     my $target = shift;
 153     my $p;
 154
 155     foreach $p (@grabbers) {
 156         if ($p->{'NAME'} eq $target) {
 157             $p->disable();
 158             return;
 159         }
 160     }
 161     write_irssi(undef, 'No such module');
 162 }
 163
 164
 165 sub cmd_show {
 166     my $target = shift;
 167     my $p;
 168     my $e;
 169
 170     if (defined($target)) {
 171         foreach $p (@getters, @grabbers) {
 172             if ($p->{'NAME'} eq $target) {
 173                 write_irssi(undef, $p->getconfstr());
 174                 return;
 175             }
 176         }
 177         write_irssi(undef, 'No such module');
 178     } else {
 179         write_irssi(undef, 'Loaded grabbers (* denotes enabled modules):');
 180         foreach $p (@grabbers) {
 181             $e = $p->_getval('enabled');
 182             write_irssi(undef, ' %s%s', $p->{'NAME'}, $e?'*':'');
 183         };
 184
 185         write_irssi(undef, 'Loaded getters:');
 186         foreach $p (@getters) {
 187             write_irssi(undef, ' %s', $p->{'NAME'});
 188         };
 189     }
 190 }
 191
 192 sub cmd_help {
 193     my $target = shift;
 194     my $p;
 195
 196     if (defined($target)) {
 197         foreach $p (@getters, @grabbers) {
 198             if ($p->{'NAME'} eq $target) {
 199                 write_irssi(undef, $p->gethelpstr());
 200                 return;
 201             }
 202         }
 203         write_irssi(undef, 'No such module');
 204     } else {
 205         write_irssi(undef, <<'EOT');
 206 Supported commands:
 207  save: Save the current configuration
 208  help [modulename]: Display this help, or module specific help
 209  show [modulename]: Show loaded modules, or the current parameters of a module
 210  set modulename parameter value: set a module parameter to a new value
 211  getter [modulename]: display or set the getter to use
 212  enable [modulename]: enable the usage of this module (grabbers only)
 213  disable [modulename]: disable the usage of this module (grabbers only)
 214  reload: reload all modules (this is somewhat experimental)
 215  mode [modename]: display or set the operation mode (download/display)
 216  debug: enable debugging messages
 217  nodebug: disable debugging messages
 218 EOT
 219     }
 220 }
 221
 222 sub cmd_getter {
 223     my $target = shift;
 224     my $p;
 225
 226     if (defined($target)) {
 227         foreach $p (@getters, @grabbers) {
 228             if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
 229                 $getter = $p;
 230                 $conf->{'videosite'}->{'getter'} = $target;
 231                 return;
 232             }
 233         }
 234         write_irssi(undef, 'No such getter');
 235     } else {
 236         write_irssi(undef, 'Current getter: %s', $conf->{'videosite'}->{'getter'});
 237     }
 238 }
 239
 240 sub cmd_mode {
 241     my $mode = shift;
 242
 243     if (defined($mode)) {
 244         $mode = lc($mode);
 245         if (('download' eq $mode) or ('display' eq $mode)) {
 246             $conf->{'videosite'}->{'mode'} = $mode;
 247         } else {
 248             write_irssi(undef, 'Invalid mode: %s', $mode);
 249         }
 250     } else {
 251         write_irssi(undef, 'Current mode: %s', $conf->{'videosite'}->{'mode'});
 252     }
 253 }
 254
 255
 256 # save on unload
 257 sub sig_command_script_unload {
 258     my $script = shift;
 259     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
 260         cmd_save();
 261     }
 262 }
 263
 264 sub ploader {
 265
 266     my $dir = shift;
 267     my $pattern = shift;
 268     my $type = shift;
 269     my @list;
 270     my $p;
 271     my $g;
 272     my @g = ();
 273
 274     opendir(D, $dir) || return ();
 275     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
 276     closedir(D);
 277
 278     foreach $p (@list) {
 279         write_debug(undef, "Trying to load $p:");
 280         $p =~ s/\.pm$//;
 281         eval qq{ require $p; };
 282         if ($@) {
 283             write_debug(undef, "Failed to load plugin: $@");
 284             next;
 285         }
 286
 287         $g = eval $p.q{->new();};
 288         if ($@) {
 289             write_debug(undef, "Failed to instanciate: $@");
 290             delete($INC{$p});
 291             next;
 292         }
 293
 294         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
 295         if ($type eq $g->{'TYPE'}) {
 296             push(@g, $g);
 297         } else {
 298             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
 299             delete($INC{$p});
 300         }
 301     }
 302
 303     write_debug(undef, "Loaded %d plugins", $#g+1);
 304
 305     return @g;
 306 }
 307
 308 sub _load_modules($) {
 309
 310     my $path = shift;
 311
 312     foreach (keys(%INC)) {
 313         if ($INC{$_} =~ m|^$path|) {
 314             write_debug(undef, "Removing %s from \$INC", $_);
 315             delete($INC{$_});
 316         }
 317     }
 318     @grabbers = ploader($path, '.*Grabber\.pm$', 'grabber');
 319     @getters = ploader($path, '.*Getter\.pm$', 'getter');
 320 }
 321
 322
 323 sub init_videosite {
 324
 325     my $bindings = shift;
 326     my $p;
 327
 328     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
 329         # No config, start with an empty one
 330         write_debug(undef, 'No config found, using defaults');
 331         $conf = { 'videosite' => { }};
 332     }
 333     foreach (keys(%{$PARAMS})) {
 334         unless (exists($conf->{'videosite'}->{$_})) {
 335             $conf->{'videosite'}->{$_} = $PARAMS->{$_};
 336         }
 337     }
 338
 339     _load_modules($plugindir);
 340
 341     unless (defined(@grabbers) && defined(@getters)) {
 342         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
 343         return;
 344     }
 345
 346     $getter = $getters[0];
 347     foreach $p (@getters) {
 348         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
 349             $getter = $p;
 350         }
 351     }
 352     write_debug(undef, 'Selected %s as getter', $getter->{'NAME'});
 353     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
 354
 355     # Loop through all plugins and load the config
 356     foreach $p (@grabbers, @getters) {
 357         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
 358     }
 359
 360     if ($bindings) {
 361
 362         Irssi::signal_add_first('command script load', 'sig_command_script_unload');
 363         Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
 364         Irssi::signal_add('setup saved', 'cmd_save');
 365
 366
 367         Irssi::command_bind('videosite' => \&cmdhandler);
 368     }
 369
 370     write_irssi(undef, 'videosite initialized');
 371 }
 372
 373 sub cmdhandler {
 374     my ($data, $server, $item) = @_;
 375     my @params = split(/\s+/, $data);
 376
 377     if ($params[0] eq 'save') {
 378         cmd_save();
 379     } elsif ($params[0] eq 'set') {
 380         shift(@params);
 381         cmd_set(@params);
 382     } elsif ($params[0] eq 'show') {
 383         shift(@params);
 384         cmd_show(@params);
 385     } elsif ($params[0] eq 'help') {
 386         shift(@params);
 387         cmd_help(@params);
 388     } elsif ($params[0] eq 'getter') {
 389         shift(@params);
 390         cmd_getter(@params);
 391     } elsif ($params[0] eq 'enable') {
 392         shift(@params);
 393         cmd_enable(@params);
 394     } elsif ($params[0] eq 'disable') {
 395         shift(@params);
 396         cmd_disable(@params);
 397     } elsif ($params[0] eq 'reload') {
 398         init_videosite(0);
 399     } elsif ($params[0] eq 'mode') {
 400         shift(@params);
 401         cmd_mode(@params);
 402     } elsif ($params[0] eq 'debug') {
 403         $debug = 1;
 404         foreach (@grabbers, @getters) {
 405             $_->setdebug(1);
 406         }
 407         write_irssi(undef, 'Enabled debugging');
 408     } elsif ($params[0] eq 'nodebug') {
 409         $debug = 0;
 410         foreach (@grabbers, @getters) {
 411             $_->setdebug(0);
 412         }
 413         write_irssi(undef, 'Disabled debugging');
 414     }
 415 }
 416
 417 unshift(@INC, $plugindir);
 418 init_videosite(1);