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