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