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