issue updates
[videosite.git] / videosite.pl
index 5fa6006..70b3ffb 100644 (file)
@@ -1,6 +1,6 @@
 # autodownload flash videos
 #
-# (c) 2007 by Ralf Ertzinger <ralf@camperquake.de>
+# (c) 2007-2008 by Ralf Ertzinger <ralf@camperquake.de>
 # licensed under GNU GPL v2
 #
 # Based on youtube.pl by Christian Garbs <mitch@cgarbs.de>
@@ -19,6 +19,14 @@ my @getters;
 my $getter;
 my $conf;
 my $conffile = File::Spec->catfile(Irssi::get_irssi_dir(), 'videosite.xml');
+my $scriptdir = File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts');
+my $plugindir = File::Spec->catfile($scriptdir, 'videosite');
+
+my $PARAMS = {
+    'getter' => '',
+    'mode' => 'download'
+};
+
 
 # activate debug here
 my $debug = 0;
@@ -38,10 +46,69 @@ signal_add_last("message irc action" => sub {check_for_link(\@_,1,4,2,0);});
 # "message irc own_action", SERVER_REC, char *msg, char *target
 signal_add_last("message irc own_action" => sub {check_for_link(\@_,1,2,-1,0);});
 
+# For tab completion
+signal_add_first('complete word', \&sig_complete);
+
+my $videosite_commands = {
+    'save' => sub {
+        cmd_save();
+    },
+
+    'set' => sub {
+        cmd_set(@_);
+    },
+    
+    'show' => sub {
+        cmd_show(@_);
+    },
+
+    'help' => sub {
+        cmd_help(@_);
+    },
+
+    'getter' => sub {
+        cmd_getter(@_);
+    },
+
+    'enable' => sub {
+        cmd_enable(@_);
+    },
+
+    'disable' => sub {
+        cmd_disable(@_);
+    },
+
+    'reload' => sub {
+        init_videosite(0);
+    },
+
+    'mode' => sub {
+        cmd_mode(@_);
+    },
+
+    'debug' => sub {
+        $debug = 1;
+        foreach (@grabbers, @getters) {
+            $_->setdebug(1);
+        }
+        write_irssi(undef, 'Enabled debugging');
+    },
+
+    'nodebug' => sub {
+        $debug = 0;
+        foreach (@grabbers, @getters) {
+            $_->setdebug(0);
+        }
+        write_irssi(undef, 'Disabled debugging');
+    },
+};
+
 sub write_irssi {
     my $witem = shift;
     my @text = @_;
 
+    $text[0] = 'videosite: ' . $text[0];
+
     if (defined $witem) {
         $witem->print(sprintf(shift(@text), @text), MSGLEVEL_CLIENTCRAP);
     } else {
@@ -63,6 +130,7 @@ sub check_for_link {
     my $message = ($parammessage == -1) ? '' : $signal->[$parammessage];
     my $g;
     my $m;
+    my $p;
 
 
     my $witem;
@@ -77,14 +145,30 @@ sub check_for_link {
         return;
     }
 
+    study($message);
+
     # Offer the message to all Grabbers in turn
     foreach $g (@grabbers) {
-        if (defined($m = $g->get($message))) {
+        ($m, $p) = $g->get($message);
+        while (defined($m)) {
             write_debug($witem, 'Metadata: %s', Dumper($m));
-            write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
-            unless($getter->get($m)) {
-                write_irssi($witem, '%%R>>> FAILED');
+            if ('download' eq ($conf->{'videosite'}->{'mode'})) {
+                write_irssi($witem, '%%R>>> %%NSaving %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
+                unless($getter->get($m)) {
+                    write_irssi($witem, '%%R>>> FAILED');
+                }
+            } elsif ('display' eq ($conf->{'videosite'}->{'mode'})) {
+                write_irssi($witem, '%%M>>> %%NSaw %%Y%s%%N %%G%s', $m->{'SOURCE'}, $m->{'TITLE'});
+            } else {
+                write_irssi($witem, '%%R>>> Invalid operation mode');
             }
+
+            # Remove the matched part from the message and try again (there may be
+            # more!)
+            $message =~ s/$p//;
+            study($message);
+
+            ($m, $p) = $g->get($message);
         }
     }
 }
@@ -97,9 +181,9 @@ sub cmd_save {
         close(CONF);
     };
     if ($@) {
-        write_irssi(undef, 'videosite: Could not save config to %s: %s', ($conffile, $@));
+        write_irssi(undef, 'Could not save config to %s: %s', ($conffile, $@));
     } else {
-        write_irssi(undef, 'Videosite configuration saved to %s', $conffile);
+        write_irssi(undef, 'configuration saved to %s', $conffile);
     }
 }
 
@@ -118,9 +202,39 @@ sub cmd_set {
     write_irssi(undef, 'No such module');
 }
 
+
+sub cmd_enable {
+    my $target = shift;
+    my $p;
+
+    foreach $p (@grabbers) {
+        if ($p->{'NAME'} eq $target) {
+            $p->enable();
+            return;
+        }
+    }
+    write_irssi(undef, 'No such module');
+}
+
+
+sub cmd_disable {
+    my $target = shift;
+    my $p;
+
+    foreach $p (@grabbers) {
+        if ($p->{'NAME'} eq $target) {
+            $p->disable();
+            return;
+        }
+    }
+    write_irssi(undef, 'No such module');
+}
+
+
 sub cmd_show {
     my $target = shift;
     my $p;
+    my $e;
 
     if (defined($target)) {
         foreach $p (@getters, @grabbers) {
@@ -131,14 +245,15 @@ sub cmd_show {
         }
         write_irssi(undef, 'No such module');
     } else {
-        write_irssi(undef, 'Loaded grabbers:');
+        write_irssi(undef, 'Loaded grabbers (* denotes enabled modules):');
         foreach $p (@grabbers) {
-            write_irssi(undef, ' ' . $p->{'NAME'});
+            $e = $p->_getval('enabled');
+            write_irssi(undef, ' %s%s', $p->{'NAME'}, $e?'*':'');
         };
 
         write_irssi(undef, 'Loaded getters:');
         foreach $p (@getters) {
-            write_irssi(undef, ' ' . $p->{'NAME'});
+            write_irssi(undef, ' %s', $p->{'NAME'});
         };
     }
 }
@@ -158,11 +273,15 @@ sub cmd_help {
     } else {
         write_irssi(undef, <<'EOT');
 Supported commands:
- save: Save the current configuration
- help [modulename]: Display this help, or module specific help
- show [modulename]: Show loaded modules, or the current parameters of a module
+ save: save the current configuration
+ help [modulename]: display this help, or module specific help
+ show [modulename]: show loaded modules, or the current parameters of a module
  set modulename parameter value: set a module parameter to a new value
  getter [modulename]: display or set the getter to use
+ enable [modulename]: enable the usage of this module (grabbers only)
+ disable [modulename]: disable the usage of this module (grabbers only)
+ reload: reload all modules (this is somewhat experimental)
+ mode [modename]: display or set the operation mode (download/display)
  debug: enable debugging messages
  nodebug: disable debugging messages
 EOT
@@ -174,8 +293,8 @@ sub cmd_getter {
     my $p;
 
     if (defined($target)) {
-        foreach $p (@getters, @grabbers) {
-            if (($p->{'NAME'} eq $target) && ($p->{'TYPE'} eq 'getter')) {
+        foreach $p (@getters) {
+            if ($p->{'NAME'} eq $target) {
                 $getter = $p;
                 $conf->{'videosite'}->{'getter'} = $target;
                 return;
@@ -187,6 +306,21 @@ sub cmd_getter {
     }
 }
 
+sub cmd_mode {
+    my $mode = shift;
+
+    if (defined($mode)) {
+        $mode = lc($mode);
+        if (('download' eq $mode) or ('display' eq $mode)) {
+            $conf->{'videosite'}->{'mode'} = $mode;
+        } else {
+            write_irssi(undef, 'Invalid mode: %s', $mode);
+        }
+    } else {
+        write_irssi(undef, 'Current mode: %s', $conf->{'videosite'}->{'mode'});
+    }
+}
+
 
 # save on unload
 sub sig_command_script_unload {
@@ -213,23 +347,26 @@ sub ploader {
     foreach $p (@list) {
         write_debug(undef, "Trying to load $p:");
         $p =~ s/\.pm$//;
-        eval qq{ require $p; };
+        eval qq{ require videosite::$p; };
         if ($@) {
-            write_debug(undef, "Failed to load plugin: $@");
+            write_irssi(undef, "Failed to load plugin: $@");
             next;
         }
 
-        $g = eval $p.q{->new();};
+        $g = eval qq{ videosite::$p->new(); };
         if ($@) {
-            write_debug(undef, "Failed to instanciate: $@");
+            write_irssi(undef, "Failed to instanciate: $@");
+            delete($INC{$p});
             next;
         }
 
         write_debug(undef, "found $g->{'TYPE'} $g->{'NAME'}");
         if ($type eq $g->{'TYPE'}) {
             push(@g, $g);
+            $g->setio(sub {Irssi::print(shift)});
         } else {
             write_irssi(undef, '%s has wrong type (got %s, expected %s)', $p, $g->{'TYPE'}, $type);
+            delete($INC{$p});
         }
     }
 
@@ -238,19 +375,38 @@ sub ploader {
     return @g;
 }
 
+sub _load_modules($) {
+
+    my $path = shift;
+
+    foreach (keys(%INC)) {
+        if ($INC{$_} =~ m|^$path|) {
+            write_debug(undef, "Removing %s from \$INC", $_);
+            delete($INC{$_});
+        }
+    }
+    @grabbers = ploader($path, '.*Grabber\.pm$', 'grabber');
+    @getters = ploader($path, '.*Getter\.pm$', 'getter');
+}
+
+
 sub init_videosite {
 
+    my $bindings = shift;
     my $p;
 
     unless(-r $conffile && defined($conf = XML::Simple::XMLin($conffile, ForceArray => ['config', 'option'], KeepRoot => 1, KeyAttr => {'config' => 'module', 'option' => 'key'}))) {
         # No config, start with an empty one
         write_debug(undef, 'No config found, using defaults');
-        $conf = { 'videosite' => { 'getter' => '' }};
+        $conf = { 'videosite' => { }};
+    }
+    foreach (keys(%{$PARAMS})) {
+        unless (exists($conf->{'videosite'}->{$_})) {
+            $conf->{'videosite'}->{$_} = $PARAMS->{$_};
+        }
     }
 
-    unshift(@INC, File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'));
-    @grabbers = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Grabber\.pm$', 'grabber');
-    @getters = ploader(File::Spec->catfile(Irssi::get_irssi_dir(), 'scripts', 'videosite'), '.*Getter\.pm$', 'getter');
+    _load_modules($plugindir);
 
     unless (defined(@grabbers) && defined(@getters)) {
         write_irssi(undef, 'No grabbers or no getters found, can not proceed.');
@@ -271,45 +427,71 @@ sub init_videosite {
         $conf->{'videosite'}->{'config'}->{$p->{'NAME'}} = $p->mergeconfig($conf->{'videosite'}->{'config'}->{$p->{'NAME'}});
     }
 
-    Irssi::signal_add_first('command script load', 'sig_command_script_unload');
-    Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
-    Irssi::signal_add('setup saved', 'cmd_save');
+    if ($bindings) {
+
+        Irssi::signal_add_first('command script load', 'sig_command_script_unload');
+        Irssi::signal_add_first('command script unload', 'sig_command_script_unload');
+        Irssi::signal_add('setup saved', 'cmd_save');
 
 
-    Irssi::command_bind('videosite' => \&cmdhandler);
+        Irssi::command_bind('videosite' => \&cmdhandler);
+    }
+
+    write_irssi(undef, 'videosite initialized');
 }
 
-sub cmdhandler {
-    my ($data, $server, $item) = @_;
-    my @params = split(/\s+/, $data);
+sub sig_complete {
+    my ($complist, $window, $word, $linestart, $want_space) = @_;
+    my @matches;
 
-    if ($params[0] eq 'save') {
-        cmd_save();
-    } elsif ($params[0] eq 'set') {
-        shift(@params);
-        cmd_set(@params);
-    } elsif ($params[0] eq 'show') {
-        shift(@params);
-        cmd_show(@params);
-    } elsif ($params[0] eq 'help') {
-        shift(@params);
-        cmd_help(@params);
-    } elsif ($params[0] eq 'getter') {
-        shift(@params);
-        cmd_getter(@params);
-    } elsif ($params[0] eq 'debug') {
-        $debug = 1;
+    if ($linestart !~ m|^/videosite\b|) {
+        return;
+    }
+
+    if ('/videosite' eq $linestart) {
+        # No command enterd so far. Produce a list of possible follow-ups
+        @matches = grep {/^$word/} keys (%{$videosite_commands});
+    } elsif ('/videosite set' eq $linestart) {
+        # 'set' command entered. Produce a list of modules
         foreach (@grabbers, @getters) {
-            $_->setdebug(1);
+            push(@matches, $_->{'NAME'}) if $_->{'NAME'} =~ m|^$word|;
+        };
+    } elsif ($linestart =~ m|^/videosite set (\w+)$|) {
+        my $module = $1;
+
+        foreach my $p (@getters, @grabbers) {
+            if ($p->{'NAME'} eq $module) {
+                @matches = $p->getparamlist($word);
+                last;
+            }
         }
-        write_irssi(undef, 'Enabled debugging');
-    } elsif ($params[0] eq 'nodebug') {
-        $debug = 0;
-        foreach (@grabbers, @getters) {
-            $_->setdebug(0);
+    } elsif ($linestart =~ m|/videosite set (\w+) (\w+)$|) {
+        my $module = $1;
+        my $param = $2;
+
+        foreach my $p (@getters, @grabbers) {
+            if ($p->{'NAME'} eq $module) {
+                @matches = $p->getparamvalues($param, $word);
+                last;
+            }
         }
-        write_irssi(undef, 'Disabled debugging');
+    }
+
+
+    push(@{$complist}, sort @matches);
+    ${$want_space} = 0;
+
+    Irssi::signal_stop();
+}
+
+sub cmdhandler {
+    my ($data, $server, $item) = @_;
+    my ($cmd, @params) = split(/\s+/, $data);
+
+    if (exists($videosite_commands->{$cmd})) {
+        $videosite_commands->{$cmd}->(@params);
     }
 }
 
-init_videosite();
+unshift(@INC, $scriptdir);
+init_videosite(1);