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 # For tab completion
  49 signal_add_first('complete word', \&sig_complete);
  50
  51 my $videosite_commands = {
  52     'save' => sub {
  53         cmd_save();
  54     },
  55
  56     'set' => sub {
  57         cmd_set(@_);
  58     },
  59
  60     'show' => sub {
  61         cmd_show(@_);
  62     },
  63
  64     'help' => sub {
  65         cmd_help(@_);
  66     },
  67
  68     'getter' => sub {
  69         cmd_getter(@_);
  70     },
  71
  72     'enable' => sub {
  73         cmd_enable(@_);
  74     },
  75
  76     'disable' => sub {
  77         cmd_disable(@_);
  78     },
  79
  80     'reload' => sub {
  81         init_videosite(0);
  82     },
  83
  84     'mode' => sub {
  85         cmd_mode(@_);
  86     },
  87
  88     'debug' => sub {
  89         $debug = 1;
  90         foreach (@grabbers, @getters) {
  91             $_->setdebug(1);
  92         }
  93         write_irssi(undef, 'Enabled debugging');
  94     },
  95
  96     'nodebug' => sub {
  97         $debug = 0;
  98         foreach (@grabbers, @getters) {
  99             $_->setdebug(0);
 100         }
 101         write_irssi(undef, 'Disabled debugging');
 102     },
 103 };
 104
 105 sub write_irssi {
 106     my $witem = shift;
 107     my @text = @_;
 108
 109     $text[0] = 'videosite: ' . $text[0];
 110
 111     if (defined $witem) {
 112         $witem->print(sprintf(shift(@text), @text), MSGLEVEL_CLIENTCRAP);
 113     } else {
 114         Irssi::print(sprintf(shift(@text), @text));
 115     }
 116
 117 }
 118
 119 sub write_debug {
 120     if ($debug) {
 121         write_irssi(shift, @_);
 122     }
 123 }
 124
 125 sub check_for_link {
 126     my ($signal,$parammessage,$paramchannel,$paramnick,$paramserver) = @_;
 127     my $server = $signal->[$paramserver];
 128     my $target = $signal->[$paramchannel];
 129     my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
 130     my $g;
 131     my $m;
 132     my $p;
 133
 134
 135     my $witem;
 136     if (defined $server) {
 137         $witem = $server->window_item_find($target);
 138     } else {
 139         $witem = Irssi::window_item_find($target);
 140     }
 141
 142     # Look if we should ignore this line
 143     if ($message =~ m,(?:\s|^)/nosave(?:\s|$),) {
 144         return;
 145     }
 146
 147     study($message);
 148
 149     # Offer the message to all Grabbers in turn
 150     foreach $g (@grabbers) {
 151         ($m, $p) = $g->get($message);
 152         while (defined($m)) {
 153             write_debug($witem, 'Metadata: %s', Dumper($m));
 154             if ('download' eq ($conf->{'videosite'}->{'mode'})) {
 155                 write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
 156                 unless($getter->get($m)) {
 157                     write_irssi($witem, '%%R>>> FAILED');
 158                 }
 159             } elsif ('display' eq ($conf->{'videosite'}->{'mode'})) {
 160                 write_irssi($witem, '%%M>>> %%NSaw %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
 161             } else {
 162                 write_irssi($witem, '%%R>>> Invalid operation mode');
 163             }
 164
 165             # Remove the matched part from the message and try again (there may be
 166             # more!)
 167             $message =~ s/$p//;
 168             study($message);
 169
 170             ($m, $p) = $g->get($message);
 171         }
 172     }
 173 }
 174
 175 sub cmd_save {
 176
 177     eval {
 178         open(CONF, '>'.$conffile) or die 'Could not open config file';
 179         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
 180         close(CONF);
 181     };
 182     if ($@) {
 183         write_irssi(undef, 'Could not save config to %s: %s', ($conffile, $@));
 184     } else {
 185         write_irssi(undef, 'configuration saved to %s', $conffile);
 186     }
 187 }
 188
 189 sub cmd_set {
 190     my $target = shift;
 191     my $key = shift;
 192     my $val = shift;
 193     my $p;
 194
 195     foreach $p (@getters, @grabbers) {
 196         if ($p->{'NAME'} eq $target) {
 197             $p->setval($key, $val);
 198             return;
 199         }
 200     }
 201     write_irssi(undef, 'No such module');
 202 }
 203
 204
 205 sub cmd_enable {
 206     my $target = shift;
 207     my $p;
 208
 209     foreach $p (@grabbers) {
 210         if ($p->{'NAME'} eq $target) {
 211             $p->enable();
 212             return;
 213         }
 214     }
 215     write_irssi(undef, 'No such module');
 216 }
 217
 218
 219 sub cmd_disable {
 220     my $target = shift;
 221     my $p;
 222
 223     foreach $p (@grabbers) {
 224         if ($p->{'NAME'} eq $target) {
 225             $p->disable();
 226             return;
 227         }
 228     }
 229     write_irssi(undef, 'No such module');
 230 }
 231
 232
 233 sub cmd_show {
 234     my $target = shift;
 235     my $p;
 236     my $e;
 237
 238     if (defined($target)) {
 239         foreach $p (@getters, @grabbers) {
 240             if ($p->{'NAME'} eq $target) {
 241                 write_irssi(undef, $p->getconfstr());
 242                 return;
 243             }
 244         }
 245         write_irssi(undef, 'No such module');
 246     } else {
 247         write_irssi(undef, 'Loaded grabbers (* denotes enabled modules):');
 248         foreach $p (@grabbers) {
 249             $e = $p->_getval('enabled');
 250             write_irssi(undef, ' %s%s', $p->{'NAME'}, $e?'*':'');
 251         };
 252
 253         write_irssi(undef, 'Loaded getters:');
 254         foreach $p (@getters) {
 255             write_irssi(undef, ' %s', $p->{'NAME'});
 256         };
 257     }
 258 }
 259
 260 sub cmd_help {
 261     my $target = shift;
 262     my $p;
 263
 264     if (defined($target)) {
 265         foreach $p (@getters, @grabbers) {
 266             if ($p->{'NAME'} eq $target) {
 267                 write_irssi(undef, $p->gethelpstr());
 268                 return;
 269             }
 270         }
 271         write_irssi(undef, 'No such module');
 272     } else {
 273         write_irssi(undef, <<'EOT');
 274 Supported commands:
 275  save: Save the current configuration
 276  help [modulename]: Display this help, or module specific help
 277  show [modulename]: Show loaded modules, or the current parameters of a module
 278  set modulename parameter value: set a module parameter to a new value
 279  getter [modulename]: display or set the getter to use
 280  enable [modulename]: enable the usage of this module (grabbers only)
 281  disable [modulename]: disable the usage of this module (grabbers only)
 282  reload: reload all modules (this is somewhat experimental)
 283  mode [modename]: display or set the operation mode (download/display)
 284  debug: enable debugging messages
 285  nodebug: disable debugging messages
 286 EOT
 287     }
 288 }
 289
 290 sub cmd_getter {
 291     my $target = shift;
 292     my $p;
 293
 294     if (defined($target)) {
 295         foreach $p (@getters, @grabbers) {
 296             if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
 297                 $getter = $p;
 298                 $conf->{'videosite'}->{'getter'} = $target;
 299                 return;
 300             }
 301         }
 302         write_irssi(undef, 'No such getter');
 303     } else {
 304         write_irssi(undef, 'Current getter: %s', $conf->{'videosite'}->{'getter'});
 305     }
 306 }
 307
 308 sub cmd_mode {
 309     my $mode = shift;
 310
 311     if (defined($mode)) {
 312         $mode = lc($mode);
 313         if (('download' eq $mode) or ('display' eq $mode)) {
 314             $conf->{'videosite'}->{'mode'} = $mode;
 315         } else {
 316             write_irssi(undef, 'Invalid mode: %s', $mode);
 317         }
 318     } else {
 319         write_irssi(undef, 'Current mode: %s', $conf->{'videosite'}->{'mode'});
 320     }
 321 }
 322
 323
 324 # save on unload
 325 sub sig_command_script_unload {
 326     my $script = shift;
 327     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
 328         cmd_save();
 329     }
 330 }
 331
 332 sub ploader {
 333
 334     my $dir = shift;
 335     my $pattern = shift;
 336     my $type = shift;
 337     my @list;
 338     my $p;
 339     my $g;
 340     my @g = ();
 341
 342     opendir(D, $dir) || return ();
 343     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
 344     closedir(D);
 345
 346     foreach $p (@list) {
 347         write_debug(undef, "Trying to load $p:");
 348         $p =~ s/\.pm$//;
 349         eval qq{ require $p; };
 350         if ($@) {
 351             write_irssi(undef, "Failed to load plugin: $@");
 352             next;
 353         }
 354
 355         $g = eval $p.q{->new();};
 356         if ($@) {
 357             write_irssi(undef, "Failed to instanciate: $@");
 358             delete($INC{$p});
 359             next;
 360         }
 361
 362         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
 363         if ($type eq $g->{'TYPE'}) {
 364             push(@g, $g);
 365             $g->setio(sub {Irssi::print(shift)});
 366         } else {
 367             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
 368             delete($INC{$p});
 369         }
 370     }
 371
 372     write_debug(undef, "Loaded %d plugins", $#g+1);
 373
 374     return @g;
 375 }
 376
 377 sub _load_modules($) {
 378
 379     my $path = shift;
 380
 381     foreach (keys(%INC)) {
 382         if ($INC{$_} =~ m|^$path|) {
 383             write_debug(undef, "Removing %s from \$INC", $_);
 384             delete($INC{$_});
 385         }
 386     }
 387     @grabbers = ploader($path, '.*Grabber\.pm$', 'grabber');
 388     @getters = ploader($path, '.*Getter\.pm$', 'getter');
 389 }
 390
 391
 392 sub init_videosite {
 393
 394     my $bindings = shift;
 395     my $p;
 396
 397     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
 398         # No config, start with an empty one
 399         write_debug(undef, 'No config found, using defaults');
 400         $conf = { 'videosite' => { }};
 401     }
 402     foreach (keys(%{$PARAMS})) {
 403         unless (exists($conf->{'videosite'}->{$_})) {
 404             $conf->{'videosite'}->{$_} = $PARAMS->{$_};
 405         }
 406     }
 407
 408     _load_modules($plugindir);
 409
 410     unless (defined(@grabbers) && defined(@getters)) {
 411         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
 412         return;
 413     }
 414
 415     $getter = $getters[0];
 416     foreach $p (@getters) {
 417         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
 418             $getter = $p;
 419         }
 420     }
 421     write_debug(undef, 'Selected %s as getter', $getter->{'NAME'});
 422     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
 423
 424     # Loop through all plugins and load the config
 425     foreach $p (@grabbers, @getters) {
 426         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
 427     }
 428
 429     if ($bindings) {
 430
 431         Irssi::signal_add_first('command script load', 'sig_command_script_unload');
 432         Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
 433         Irssi::signal_add('setup saved', 'cmd_save');
 434
 435
 436         Irssi::command_bind('videosite' => \&cmdhandler);
 437     }
 438
 439     write_irssi(undef, 'videosite initialized');
 440 }
 441
 442 sub sig_complete {
 443     my ($complist, $window, $word, $linestart, $want_space) = @_;
 444     my @matches;
 445
 446     if ($linestart !~ m|^/videosite\b|) {
 447         return;
 448     }
 449
 450     if ('/videosite' eq $linestart) {
 451         # No command enterd so far. Produce a list of possible follow-ups
 452         @matches = grep {/^$word/} keys (%{$videosite_commands});
 453     } elsif ('/videosite set' eq $linestart) {
 454         # 'set' command entered. Produce a list of modules
 455         foreach (@grabbers, @getters) {
 456             push(@matches, $_->{'NAME'}) if $_->{'NAME'} =~ m|^$word|;
 457         };
 458     } elsif ($linestart =~ m|^/videosite set (\w+)$|) {
 459         my $module = $1;
 460
 461         foreach my $p (@getters, @grabbers) {
 462             if ($p->{'NAME'} eq $module) {
 463                 @matches = $p->getparamlist($word);
 464                 last;
 465             }
 466         }
 467     } elsif ($linestart =~ m|/videosite set (\w+) (\w+)$|) {
 468         my $module = $1;
 469         my $param = $2;
 470
 471         foreach my $p (@getters, @grabbers) {
 472             if ($p->{'NAME'} eq $module) {
 473                 @matches = $p->getparamvalues($param, $word);
 474                 last;
 475             }
 476         }
 477     }
 478
 479
 480     push(@{$complist}, sort @matches);
 481     ${$want_space} = 0;
 482
 483     Irssi::signal_stop();
 484 }
 485
 486 sub cmdhandler {
 487     my ($data, $server, $item) = @_;
 488     my ($cmd, @params) = split(/\s+/, $data);
 489
 490     if (exists($videosite_commands->{$cmd})) {
 491         $videosite_commands->{$cmd}->(@params);
 492     }
 493 }
 494
 495 unshift(@INC, $plugindir);
 496 init_videosite(1);