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