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
  23 # activate debug here
  24 my $debug = 0;
  25
  26 # "message public", SERVER_REC, char *msg, char *nick, char *address, char *target
  27 signal_add_last("message public" => sub {check_for_link(\@_,1,4,2,0);});
  28 # "message own_public", SERVER_REC, char *msg, char *target
  29 signal_add_last("message own_public" => sub {check_for_link(\@_,1,2,-1,0);});
  30
  31 # "message private", SERVER_REC, char *msg, char *nick, char *address
  32 signal_add_last("message private" => sub {check_for_link(\@_,1,-1,2,0);});
  33 # "message own_private", SERVER_REC, char *msg, char *target, char *orig_target
  34 signal_add_last("message own_private" => sub {check_for_link(\@_,1,2,-1,0);});
  35
  36 # "message irc action", SERVER_REC, char *msg, char *nick, char *address, char *target
  37 signal_add_last("message irc action" => sub {check_for_link(\@_,1,4,2,0);});
  38 # "message irc own_action", SERVER_REC, char *msg, char *target
  39 signal_add_last("message irc own_action" => sub {check_for_link(\@_,1,2,-1,0);});
  40
  41 sub write_irssi {
  42     my $witem = shift;
  43     my @text = @_;
  44
  45     if (defined $witem) {
  46         $witem->print(sprintf(shift(@text), @text), MSGLEVEL_CLIENTCRAP);
  47     } else {
  48         Irssi::print(sprintf(shift(@text), @text));
  49     }
  50
  51 }
  52
  53 sub write_debug {
  54     if ($debug) {
  55         write_irssi(shift, @_);
  56     }
  57 }
  58
  59 sub check_for_link {
  60     my ($signal,$parammessage,$paramchannel,$paramnick,$paramserver) = @_;
  61     my $server = $signal->[$paramserver];
  62     my $target = $signal->[$paramchannel];
  63     my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
  64     my $g;
  65     my $m;
  66
  67
  68     my $witem;
  69     if (defined $server) {
  70         $witem = $server->window_item_find($target);
  71     } else {
  72         $witem = Irssi::window_item_find($target);
  73     }
  74
  75     # Look if we should ignore this line
  76     if ($message =~ m,(?:\s|^)/nosave(?:\s|$),) {
  77         return;
  78     }
  79
  80     # Offer the message to all Grabbers in turn
  81     foreach $g (@grabbers) {
  82         if (defined($m = $g->get($message))) {
  83             write_debug($witem, 'Metadata: %s', Dumper($m));
  84             write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
  85             unless($getter->get($m)) {
  86                 write_irssi($witem, '%%R>>> FAILED');
  87             }
  88         }
  89     }
  90 }
  91
  92 sub cmd_save {
  93
  94     eval {
  95         open(CONF, '>'.$conffile) or die 'Could not open config file';
  96         print CONF XML::Simple::XMLout($conf, KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'});
  97         close(CONF);
  98     };
  99     if ($@) {
 100         write_irssi(undef, 'videosite: Could not save config to %s: %s', ($conffile, $@));
 101     } else {
 102         write_irssi(undef, 'Videosite configuration saved to %s', $conffile);
 103     }
 104 }
 105
 106 sub cmd_set {
 107     my $target = shift;
 108     my $key = shift;
 109     my $val = shift;
 110     my $p;
 111
 112     foreach $p (@getters, @grabbers) {
 113         if ($p->{'NAME'} eq $target) {
 114             $p->setval($key, $val);
 115             return;
 116         }
 117     }
 118     write_irssi(undef, 'No such module');
 119 }
 120
 121 sub cmd_show {
 122     my $target = shift;
 123     my $p;
 124
 125     if (defined($target)) {
 126         foreach $p (@getters, @grabbers) {
 127             if ($p->{'NAME'} eq $target) {
 128                 write_irssi(undef, $p->getconfstr());
 129                 return;
 130             }
 131         }
 132         write_irssi(undef, 'No such module');
 133     } else {
 134         write_irssi(undef, 'Loaded grabbers:');
 135         foreach $p (@grabbers) {
 136             write_irssi(undef, ' ' . $p->{'NAME'});
 137         };
 138
 139         write_irssi(undef, 'Loaded getters:');
 140         foreach $p (@getters) {
 141             write_irssi(undef, ' ' . $p->{'NAME'});
 142         };
 143     }
 144 }
 145
 146 sub cmd_help {
 147     my $target = shift;
 148     my $p;
 149
 150     if (defined($target)) {
 151         foreach $p (@getters, @grabbers) {
 152             if ($p->{'NAME'} eq $target) {
 153                 write_irssi(undef, $p->gethelpstr());
 154                 return;
 155             }
 156         }
 157         write_irssi(undef, 'No such module');
 158     } else {
 159         write_irssi(undef, <<'EOT');
 160 Supported commands:
 161  save: Save the current configuration
 162  help [modulename]: Display this help, or module specific help
 163  show [modulename]: Show loaded modules, or the current parameters of a module
 164  set modulename parameter value: set a module parameter to a new value
 165  getter [modulename]: display or set the getter to use
 166  debug: enable debugging messages
 167  nodebug: disable debugging messages
 168 EOT
 169     }
 170 }
 171
 172 sub cmd_getter {
 173     my $target = shift;
 174     my $p;
 175
 176     if (defined($target)) {
 177         foreach $p (@getters, @grabbers) {
 178             if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
 179                 $getter = $p;
 180                 $conf->{'videosite'}->{'getter'} = $target;
 181                 return;
 182             }
 183         }
 184         write_irssi(undef, 'No such getter');
 185     } else {
 186         write_irssi(undef, 'Current getter: %s', $conf->{'videosite'}->{'getter'});
 187     }
 188 }
 189
 190
 191 # save on unload
 192 sub sig_command_script_unload {
 193     my $script = shift;
 194     if ($script =~ /(.*\/)?videosite(\.pl)?$/) {
 195         cmd_save();
 196     }
 197 }
 198
 199 sub ploader {
 200
 201     my $dir = shift;
 202     my $pattern = shift;
 203     my $type = shift;
 204     my @list;
 205     my $p;
 206     my $g;
 207     my @g = ();
 208
 209     opendir(D, $dir) || return ();
 210     @list = grep {/$pattern/ && -f File::Spec->catfile($dir, $_) } readdir(D);
 211     closedir(D);
 212
 213     foreach $p (@list) {
 214         write_debug(undef, "Trying to load $p:");
 215         $p =~ s/\.pm$//;
 216         eval qq{ require $p; };
 217         if ($@) {
 218             write_debug(undef, "Failed to load plugin: $@");
 219             next;
 220         }
 221
 222         $g = eval $p.q{->new();};
 223         if ($@) {
 224             write_debug(undef, "Failed to instanciate: $@");
 225             next;
 226         }
 227
 228         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
 229         if ($type eq $g->{'TYPE'}) {
 230             push(@g, $g);
 231         } else {
 232             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
 233         }
 234     }
 235
 236     write_debug(undef, "Loaded %d plugins", $#g+1);
 237
 238     return @g;
 239 }
 240
 241 sub init_videosite {
 242
 243     my $p;
 244
 245     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
 246         # No config, start with an empty one
 247         write_debug(undef, 'No config found, using defaults');
 248         $conf = { 'videosite' => { 'getter' => '' }};
 249     }
 250
 251     unshift(@INC, File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'));
 252     @grabbers = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Grabber\.pm$', 'grabber');
 253     @getters = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Getter\.pm$', 'getter');
 254
 255     unless (defined(@grabbers) && defined(@getters)) {
 256         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
 257         return;
 258     }
 259
 260     $getter = $getters[0];
 261     foreach $p (@getters) {
 262         if ($conf->{'videosite'}->{'getter'} eq $p->{'NAME'}) {
 263             $getter = $p;
 264         }
 265     }
 266     write_debug(undef, 'Selected %s as getter', $getter->{'NAME'});
 267     $conf->{'videosite'}->{'getter'} = $getter->{'NAME'};
 268
 269     # Loop through all plugins and load the config
 270     foreach $p (@grabbers, @getters) {
 271         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
 272     }
 273
 274     Irssi::signal_add_first('command script load', 'sig_command_script_unload');
 275     Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
 276     Irssi::signal_add('setup saved', 'cmd_save');
 277
 278
 279     Irssi::command_bind('videosite' => \&cmdhandler);
 280 }
 281
 282 sub cmdhandler {
 283     my ($data, $server, $item) = @_;
 284     my @params = split(/\s+/, $data);
 285
 286     if ($params[0] eq 'save') {
 287         cmd_save();
 288     } elsif ($params[0] eq 'set') {
 289         shift(@params);
 290         cmd_set(@params);
 291     } elsif ($params[0] eq 'show') {
 292         shift(@params);
 293         cmd_show(@params);
 294     } elsif ($params[0] eq 'help') {
 295         shift(@params);
 296         cmd_help(@params);
 297     } elsif ($params[0] eq 'getter') {
 298         shift(@params);
 299         cmd_getter(@params);
 300     } elsif ($params[0] eq 'debug') {
 301         $debug = 1;
 302         foreach (@grabbers, @getters) {
 303             $_->setdebug(1);
 304         }
 305         write_irssi(undef, 'Enabled debugging');
 306     } elsif ($params[0] eq 'nodebug') {
 307         $debug = 0;
 308         foreach (@grabbers, @getters) {
 309             $_->setdebug(0);
 310         }
 311         write_irssi(undef, 'Disabled debugging');
 312     }
 313 }
 314
 315 init_videosite();