quotesite.pl

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