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