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