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