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