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     GRABBER: 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             last GRABBER if ($message =~ /^\s*$/);
 190
 191             ($m, $p) = $g->get($message);
 192         }
 193     }
 194
 195     pop_output();
 196 }
 197
 198 sub cmd_save {
 199
 200     eval {
 201         open(CONF, '>'.$conffile) or die 'Could not open config file';
 202         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
 203         close(CONF);
 204     };
 205     if ($@) {
 206         write_irssi('Could not save config to %s: %s', ($conffile, $@));
 207     } else {
 208         write_irssi('configuration saved to %s', $conffile);
 209     }
 210 }
 211
 212 sub cmd_set {
 213     my $target = shift;
 214     my $key = shift;
 215     my $val = shift;
 216     my $p;
 217
 218     foreach $p (@getters, @grabbers) {
 219         if ($p->{'NAME'} eq $target) {
 220             $p->setval($key, $val);
 221             return;
 222         }
 223     }
 224     write_irssi('No such module');
 225 }
 226
 227
 228 sub cmd_enable {
 229     my $target = shift;
 230     my $p;
 231
 232     foreach $p (@grabbers) {
 233         if ($p->{'NAME'} eq $target) {
 234             $p->enable();
 235             return;
 236         }
 237     }
 238     write_irssi('No such module');
 239 }
 240
 241
 242 sub cmd_disable {
 243     my $target = shift;
 244     my $p;
 245
 246     foreach $p (@grabbers) {
 247         if ($p->{'NAME'} eq $target) {
 248             $p->disable();
 249             return;
 250         }
 251     }
 252     write_irssi('No such module');
 253 }
 254
 255
 256 sub cmd_show {
 257     my $target = shift;
 258     my $p;
 259     my $e;
 260
 261     if (defined($target)) {
 262         foreach $p (@getters, @grabbers) {
 263             if ($p->{'NAME'} eq $target) {
 264                 write_irssi($p->getconfstr());
 265                 return;
 266             }
 267         }
 268         write_irssi('No such module');
 269     } else {
 270         write_irssi('Loaded grabbers (* denotes enabled modules):');
 271         foreach $p (@grabbers) {
 272             $e = $p->_getval('enabled');
 273             write_irssi(' %s%s', $p->{'NAME'}, $e?'*':'');
 274         };
 275
 276         write_irssi('Loaded getters:');
 277         foreach $p (@getters) {
 278             write_irssi(' %s', $p->{'NAME'});
 279         };
 280     }
 281 }
 282
 283 sub cmd_help {
 284     my $target = shift;
 285     my $p;
 286
 287     if (defined($target)) {
 288         foreach $p (@getters, @grabbers) {
 289             if ($p->{'NAME'} eq $target) {
 290                 write_irssi($p->gethelpstr());
 291                 return;
 292             }
 293         }
 294         write_irssi('No such module');
 295     } else {
 296         write_irssi(<<'EOT');
 297 Supported commands:
 298  save: save the current configuration
 299  help [modulename]: display this help, or module specific help
 300  show [modulename]: show loaded modules, or the current parameters of a module
 301  set modulename parameter value: set a module parameter to a new value
 302  getter [modulename]: display or set the getter to use
 303  enable [modulename]: enable the usage of this module (grabbers only)
 304  disable [modulename]: disable the usage of this module (grabbers only)
 305  reload: reload all modules (this is somewhat experimental)
 306  mode [modename]: display or set the operation mode (download/display)
 307  debug: enable debugging messages
 308  nodebug: disable debugging messages
 309 EOT
 310     }
 311 }
 312
 313 sub cmd_getter {
 314     my $target = shift;
 315     my $p;
 316
 317     if (defined($target)) {
 318         foreach $p (@getters) {
 319             if ($p->{'NAME'} eq $target) {
 320                 $getter = $p;
 321                 $conf->{'videosite'}->{'getter'} = $target;
 322                 write_irssi("Getter changed to %s", $target);
 323                 return;
 324             }
 325         }
 326         write_irssi('No such getter');
 327     } else {
 328         write_irssi('Current getter: %s', $conf->{'videosite'}->{'getter'});
 329     }
 330 }
 331
 332 sub cmd_mode {
 333     my $mode = shift;
 334
 335     if (defined($mode)) {
 336         $mode = lc($mode);
 337         if (('download' eq $mode) or ('display' eq $mode)) {
 338             $conf->{'videosite'}->{'mode'} = $mode;
 339             write_irssi('Now using %s mode', $mode);
 340         } else {
 341             write_irssi('Invalid mode: %s', $mode);
 342         }
 343     } else {
 344         write_irssi('Current mode: %s', $conf->{'videosite'}->{'mode'});
 345     }
 346 }
 347
 348
 349 # save on unload
 350 sub sig_command_script_unload {
 351     my $script = shift;
 352     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
 353         cmd_save();
 354     }
 355 }
 356
 357 sub ploader {
 358
 359     my $dir = shift;
 360     my $pattern = shift;
 361     my $type = shift;
 362     my @list;
 363     my $p;
 364     my $g;
 365     my @g = ();
 366
 367     opendir(D, $dir) || return ();
 368     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
 369     closedir(D);
 370
 371     foreach $p (@list) {
 372         write_debug("Trying to load $p:");
 373         $p =~ s/\.pm$//;
 374         eval qq{ require videosite::$p; };
 375         if ($@) {
 376             write_irssi("Failed to load plugin: $@");
 377             next;
 378         }
 379
 380         $g = eval qq{ videosite::$p->new(); };
 381         if ($@) {
 382             write_irssi("Failed to instanciate: $@");
 383             delete($INC{$p});
 384             next;
 385         }
 386
 387         write_debug("found $g->{'TYPE'} $g->{'NAME'}");
 388         if ($type eq $g->{'TYPE'}) {
 389             push(@g, $g);
 390             $g->setio(\&write_irssi);
 391         } else {
 392             write_irssi('%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
 393             delete($INC{$p});
 394         }
 395     }
 396
 397     write_debug("Loaded %d plugins", $#g+1);
 398
 399     return @g;
 400 }
 401
 402 sub _load_modules($) {
 403
 404     my $path = shift;
 405
 406     foreach (keys(%INC)) {
 407         if ($INC{$_} =~ m|^$path|) {
 408             write_debug("Removing %s from \$INC", $_);
 409             delete($INC{$_});
 410         }
 411     }
 412     @grabbers = ploader($path, '.*Grabber\.pm$', 'grabber');
 413     @getters = ploader($path, '.*Getter\.pm$', 'getter');
 414 }
 415
 416
 417 sub init_videosite {
 418
 419     my $bindings = shift;
 420     my $p;
 421
 422     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
 423         # No config, start with an empty one
 424         write_debug('No config found, using defaults');
 425         $conf = { 'videosite' => { }};
 426     }
 427     foreach (keys(%{$PARAMS})) {
 428         unless (exists($conf->{'videosite'}->{$_})) {
 429             $conf->{'videosite'}->{$_} = $PARAMS->{$_};
 430         }
 431     }
 432
 433     _load_modules($plugindir);
 434
 435     unless (defined(@grabbers) && defined(@getters)) {
 436         write_irssi('No grabbers or no getters found, can not proceed.');
 437         return;
 438     }
 439
 440     $getter = $getters[0];
 441     foreach $p (@getters) {
 442         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
 443             $getter = $p;
 444         }
 445     }
 446     write_debug('Selected %s as getter', $getter->{'NAME'});
 447     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
 448
 449     # Loop through all plugins and load the config
 450     foreach $p (@grabbers, @getters) {
 451         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
 452     }
 453
 454     if ($bindings) {
 455
 456         Irssi::signal_add_first('command script load', 'sig_command_script_unload');
 457         Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
 458         Irssi::signal_add('setup saved', 'cmd_save');
 459
 460
 461         Irssi::command_bind(_bcb('videosite' => \&cmdhandler));
 462     }
 463
 464     write_irssi('initialized successfully');
 465 }
 466
 467 sub sig_complete {
 468     my ($complist, $window, $word, $linestart, $want_space) = @_;
 469     my @matches;
 470
 471     if ($linestart !~ m|^/videosite\b|) {
 472         return;
 473     }
 474
 475     if ('/videosite' eq $linestart) {
 476         # No command enterd so far. Produce a list of possible follow-ups
 477         @matches = grep {/^$word/} keys (%{$videosite_commands});
 478     } elsif ('/videosite set' eq $linestart) {
 479         # 'set' command entered. Produce a list of modules
 480         foreach (@grabbers, @getters) {
 481             push(@matches, $_->{'NAME'}) if $_->{'NAME'} =~ m|^$word|;
 482         };
 483     } elsif ($linestart =~ m|^/videosite set (\w+)$|) {
 484         my $module = $1;
 485
 486         foreach my $p (@getters, @grabbers) {
 487             if ($p->{'NAME'} eq $module) {
 488                 @matches = $p->getparamlist($word);
 489                 last;
 490             }
 491         }
 492     } elsif ($linestart =~ m|/videosite set (\w+) (\w+)$|) {
 493         my $module = $1;
 494         my $param = $2;
 495
 496         foreach my $p (@getters, @grabbers) {
 497             if ($p->{'NAME'} eq $module) {
 498                 @matches = $p->getparamvalues($param, $word);
 499                 last;
 500             }
 501         }
 502     }
 503
 504
 505     push(@{$complist}, sort @matches);
 506     ${$want_space} = 0;
 507
 508     Irssi::signal_stop();
 509 }
 510
 511 sub cmdhandler {
 512     my $event = shift;
 513     my ($cmd, @params) = split(/\s+/, $event->message());
 514
 515     push_output($event->ewpf);
 516
 517     if (exists($videosite_commands->{$cmd})) {
 518         $videosite_commands->{$cmd}->(@params);
 519     }
 520
 521     pop_output();
 522 }
 523
 524 unshift(@INC, $scriptdir);
 525 init_videosite(1);