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         'post\.ly/[[:alnum:]]+',
 166         '1\.ly/[[:alnum:]]+',
 167         '2\.ly/[[:alnum:]]+',
 168         't\.co/[[:alnum:]]+',
 169         'shar\.es/[[:alnum:]]+',
 170         );
 171     my $ua = LWP::UserAgent->new(agent => 'Mozilla', max_redirect => 0);
 172     my $i = 10;
 173
 174     OUTER: while (($os ne $s) and ($i > 0)) {
 175         study($s);
 176         $os = $s;
 177         $i--;
 178
 179         foreach my $pattern (@urlshortener) {
 180             my $p = "https?:\/\/" . $pattern;
 181
 182             write_debug("Matching %s against %s", $p, $s);
 183             if ($s =~ m|($p)|) {
 184                 my $matched = $1;
 185                 my $res;
 186
 187                 write_debug("Found %s", $matched);
 188                 $res = $ua->head($matched);
 189                 if ($res->is_redirect()) {
 190                     my $new = $res->headers()->header("Location");
 191
 192                     write_debug("Replacing %s with %s", $matched, $new);
 193                     $s =~ s/$matched/$new/;
 194                     next OUTER;
 195                 } else {
 196                     write_debug("Error resolving %s", $matched);
 197                 }
 198             }
 199         }
 200     }
 201
 202     if ($i == 0) {
 203         write_debug("Loop terminated by counter");
 204     }
 205
 206     write_debug("Final string: %s", $s);
 207
 208     return $s;
 209 }
 210
 211
 212 sub check_for_link {
 213     my $event = shift;
 214     my $message = $event->message();
 215     my $witem = $event->channel();
 216     my $g;
 217     my $m;
 218     my $p;
 219
 220
 221     # Look if we should ignore this line
 222     if ($message =~ m,(?:\s|^)/nosave(?:\s|$),) {
 223         return;
 224     }
 225
 226     push_output($event->ewpf);
 227     $message = expand_url_shortener($message);
 228
 229     study($message);
 230
 231     # Offer the message to all Grabbers in turn
 232     GRABBER: foreach $g (@grabbers) {
 233         ($m, $p) = $g->get($message);
 234         while (defined($m)) {
 235             write_debug('Metadata: %s', Dumper($m));
 236             if ('download' eq ($conf->{'videosite'}->{'mode'})) {
 237                 write_irssi('%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
 238                 unless($getter->get($m)) {
 239                     write_irssi('%%R>>> FAILED');
 240                 }
 241             } elsif ('display' eq ($conf->{'videosite'}->{'mode'})) {
 242                 write_irssi('%%M>>> %%NSaw %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
 243             } else {
 244                 write_irssi('%%R>>> Invalid operation mode');
 245             }
 246
 247             # Remove the matched part from the message and try again (there may be
 248             # more!)
 249             $message =~ s/$p//;
 250             study($message);
 251             last GRABBER if ($message =~ /^\s*$/);
 252
 253             ($m, $p) = $g->get($message);
 254         }
 255     }
 256
 257     pop_output();
 258 }
 259
 260 sub cmd_save {
 261
 262     eval {
 263         open(CONF, '>'.$conffile) or die 'Could not open config file';
 264         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
 265         close(CONF);
 266     };
 267     if ($@) {
 268         write_irssi('Could not save config to %s: %s', ($conffile, $@));
 269     } else {
 270         write_irssi('configuration saved to %s', $conffile);
 271     }
 272 }
 273
 274 sub cmd_set {
 275     my $target = shift;
 276     my $key = shift;
 277     my $val = shift;
 278     my $p;
 279
 280     foreach $p (@getters, @grabbers) {
 281         if ($p->{'NAME'} eq $target) {
 282             $p->setval($key, $val);
 283             return;
 284         }
 285     }
 286     write_irssi('No such module');
 287 }
 288
 289
 290 sub cmd_enable {
 291     my $target = shift;
 292     my $p;
 293
 294     foreach $p (@grabbers) {
 295         if ($p->{'NAME'} eq $target) {
 296             $p->enable();
 297             return;
 298         }
 299     }
 300     write_irssi('No such module');
 301 }
 302
 303
 304 sub cmd_disable {
 305     my $target = shift;
 306     my $p;
 307
 308     foreach $p (@grabbers) {
 309         if ($p->{'NAME'} eq $target) {
 310             $p->disable();
 311             return;
 312         }
 313     }
 314     write_irssi('No such module');
 315 }
 316
 317
 318 sub cmd_show {
 319     my $target = shift;
 320     my $p;
 321     my $e;
 322
 323     if (defined($target)) {
 324         foreach $p (@getters, @grabbers) {
 325             if ($p->{'NAME'} eq $target) {
 326                 write_irssi($p->getconfstr());
 327                 return;
 328             }
 329         }
 330         write_irssi('No such module');
 331     } else {
 332         write_irssi('Loaded grabbers (* denotes enabled modules):');
 333         foreach $p (@grabbers) {
 334             $e = $p->_getval('enabled');
 335             write_irssi(' %s%s', $p->{'NAME'}, $e?'*':'');
 336         };
 337
 338         write_irssi('Loaded getters:');
 339         foreach $p (@getters) {
 340             write_irssi(' %s', $p->{'NAME'});
 341         };
 342     }
 343 }
 344
 345 sub cmd_help {
 346     my $target = shift;
 347     my $p;
 348
 349     if (defined($target)) {
 350         foreach $p (@getters, @grabbers) {
 351             if ($p->{'NAME'} eq $target) {
 352                 write_irssi($p->gethelpstr());
 353                 return;
 354             }
 355         }
 356         write_irssi('No such module');
 357     } else {
 358         write_irssi(<<'EOT');
 359 Supported commands:
 360  save: save the current configuration
 361  help [modulename]: display this help, or module specific help
 362  show [modulename]: show loaded modules, or the current parameters of a module
 363  set modulename parameter value: set a module parameter to a new value
 364  getter [modulename]: display or set the getter to use
 365  enable [modulename]: enable the usage of this module (grabbers only)
 366  disable [modulename]: disable the usage of this module (grabbers only)
 367  reload: reload all modules (this is somewhat experimental)
 368  mode [modename]: display or set the operation mode (download/display)
 369  debug: enable debugging messages
 370  nodebug: disable debugging messages
 371 EOT
 372     }
 373 }
 374
 375 sub cmd_getter {
 376     my $target = shift;
 377     my $p;
 378
 379     if (defined($target)) {
 380         foreach $p (@getters) {
 381             if ($p->{'NAME'} eq $target) {
 382                 $getter = $p;
 383                 $conf->{'videosite'}->{'getter'} = $target;
 384                 write_irssi("Getter changed to %s", $target);
 385                 return;
 386             }
 387         }
 388         write_irssi('No such getter');
 389     } else {
 390         write_irssi('Current getter: %s', $conf->{'videosite'}->{'getter'});
 391     }
 392 }
 393
 394 sub cmd_mode {
 395     my $mode = shift;
 396
 397     if (defined($mode)) {
 398         $mode = lc($mode);
 399         if (('download' eq $mode) or ('display' eq $mode)) {
 400             $conf->{'videosite'}->{'mode'} = $mode;
 401             write_irssi('Now using %s mode', $mode);
 402         } else {
 403             write_irssi('Invalid mode: %s', $mode);
 404         }
 405     } else {
 406         write_irssi('Current mode: %s', $conf->{'videosite'}->{'mode'});
 407     }
 408 }
 409
 410
 411 # save on unload
 412 sub sig_command_script_unload {
 413     my $script = shift;
 414     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
 415         cmd_save();
 416     }
 417 }
 418
 419 sub ploader {
 420
 421     my $dir = shift;
 422     my $pattern = shift;
 423     my $type = shift;
 424     my @list;
 425     my $p;
 426     my $g;
 427     my @g = ();
 428
 429     opendir(D, $dir) || return ();
 430     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
 431     closedir(D);
 432
 433     foreach $p (@list) {
 434         write_debug("Trying to load $p:");
 435         $p =~ s/\.pm$//;
 436         eval qq{ require videosite::$p; };
 437         if ($@) {
 438             write_irssi("Failed to load plugin: $@");
 439             next;
 440         }
 441
 442         $g = eval qq{ videosite::$p->new(); };
 443         if ($@) {
 444             write_irssi("Failed to instanciate: $@");
 445             delete($INC{$p});
 446             next;
 447         }
 448
 449         write_debug("found $g->{'TYPE'} $g->{'NAME'}");
 450         if ($type eq $g->{'TYPE'}) {
 451             push(@g, $g);
 452             $g->setio(\&write_irssi);
 453         } else {
 454             write_irssi('%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
 455             delete($INC{$p});
 456         }
 457     }
 458
 459     write_debug("Loaded %d plugins", $#g+1);
 460
 461     return @g;
 462 }
 463
 464 sub _load_modules($) {
 465
 466     my $path = shift;
 467
 468     foreach (keys(%INC)) {
 469         if ($INC{$_} =~ m|^$path|) {
 470             write_debug("Removing %s from \$INC", $_);
 471             delete($INC{$_});
 472         }
 473     }
 474     @grabbers = ploader($path, '.*Grabber\.pm$', 'grabber');
 475     @getters = ploader($path, '.*Getter\.pm$', 'getter');
 476 }
 477
 478
 479 sub init_videosite {
 480
 481     my $bindings = shift;
 482     my $p;
 483
 484     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
 485         # No config, start with an empty one
 486         write_debug('No config found, using defaults');
 487         $conf = { 'videosite' => { }};
 488     }
 489     foreach (keys(%{$PARAMS})) {
 490         unless (exists($conf->{'videosite'}->{$_})) {
 491             $conf->{'videosite'}->{$_} = $PARAMS->{$_};
 492         }
 493     }
 494
 495     _load_modules($plugindir);
 496
 497     unless (defined(@grabbers) && defined(@getters)) {
 498         write_irssi('No grabbers or no getters found, can not proceed.');
 499         return;
 500     }
 501
 502     $getter = $getters[0];
 503     foreach $p (@getters) {
 504         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
 505             $getter = $p;
 506         }
 507     }
 508     write_debug('Selected %s as getter', $getter->{'NAME'});
 509     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
 510
 511     # Loop through all plugins and load the config
 512     foreach $p (@grabbers, @getters) {
 513         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
 514     }
 515
 516     if ($bindings) {
 517
 518         Irssi::signal_add_first('command script load', 'sig_command_script_unload');
 519         Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
 520         Irssi::signal_add('setup saved', 'cmd_save');
 521
 522
 523         Irssi::command_bind(_bcb('videosite' => \&cmdhandler));
 524     }
 525
 526     write_irssi('initialized successfully');
 527 }
 528
 529 sub sig_complete {
 530     my ($complist, $window, $word, $linestart, $want_space) = @_;
 531     my @matches;
 532
 533     if ($linestart !~ m|^/videosite\b|) {
 534         return;
 535     }
 536
 537     if ('/videosite' eq $linestart) {
 538         # No command enterd so far. Produce a list of possible follow-ups
 539         @matches = grep {/^$word/} keys (%{$videosite_commands});
 540     } elsif ('/videosite set' eq $linestart) {
 541         # 'set' command entered. Produce a list of modules
 542         foreach (@grabbers, @getters) {
 543             push(@matches, $_->{'NAME'}) if $_->{'NAME'} =~ m|^$word|;
 544         };
 545     } elsif ($linestart =~ m|^/videosite set (\w+)$|) {
 546         my $module = $1;
 547
 548         foreach my $p (@getters, @grabbers) {
 549             if ($p->{'NAME'} eq $module) {
 550                 @matches = $p->getparamlist($word);
 551                 last;
 552             }
 553         }
 554     } elsif ($linestart =~ m|/videosite set (\w+) (\w+)$|) {
 555         my $module = $1;
 556         my $param = $2;
 557
 558         foreach my $p (@getters, @grabbers) {
 559             if ($p->{'NAME'} eq $module) {
 560                 @matches = $p->getparamvalues($param, $word);
 561                 last;
 562             }
 563         }
 564     }
 565
 566
 567     push(@{$complist}, sort @matches);
 568     ${$want_space} = 0;
 569
 570     Irssi::signal_stop();
 571 }
 572
 573 sub cmdhandler {
 574     my $event = shift;
 575     my ($cmd, @params) = split(/\s+/, $event->message());
 576
 577     push_output($event->ewpf);
 578
 579     if (exists($videosite_commands->{$cmd})) {
 580         $videosite_commands->{$cmd}->(@params);
 581     }
 582
 583     pop_output();
 584 }
 585
 586 unshift(@INC, $scriptdir);
 587 init_videosite(1);