]> git.donarmstrong.com Git - infobot.git/blob - src/CommandStubs.pl
added 'verstats'
[infobot.git] / src / CommandStubs.pl
1 #
2 # User Command Extension Stubs
3 #
4
5 if (&IsParam("useStrict")) { use strict; }
6
7 $babel::lang_regex = "";        # lame fix.
8
9 ### PROPOSED COMMAND HOOK IMPLEMENTATION.
10 # addCmdHook("SECTION", 'TEXT_HOOK',
11 #       (CODEREF        => 'Blah', 
12 #       Forker          => 1,
13 #       CheckModule     => 1,                   # ???
14 #       Module          => 'blah.pl'            # preload module.
15 #       Identifier      => 'config_label',      # change to Config?
16 #       Help            => 'help_label',
17 #       Cmdstats        => 'text_label',)
18 #}
19 ###
20
21 sub addCmdHook {
22     my ($hashname, $ident, %hash) = @_;
23
24     if (exists ${"hooks_$hashname"}{$ident}) {
25 ###     &WARN("aCH: cmd hooks \%$hashname{$ident} already exists.");
26         return;
27     }
28
29     &VERB("aCH: added $ident",2);       # use $hash{'Identifier'}?
30     ### hrm... prevent warnings?
31     ${"hooks_$hashname"}{$ident} = \%hash;
32 }
33
34 # RUN IF ADDRESSED.
35 sub parseCmdHook {
36     my ($hashname, $line) = @_;
37     $line =~ /^(\S+)( (.*))?$/;
38     my @args    = split(' ', $3 || '');
39     my $flatarg = $3;
40     my $cmd     = $1;   # command name is whitespaceless.
41     my $done    = 0;
42
43     &shmFlush();
44
45     if (!defined %{"hooks_$hashname"}) {
46         &WARN("cmd hooks \%$hashname does not exist.");
47         return 0;
48     }
49
50     foreach (keys %{"hooks_$hashname"}) {
51         my $ident = $_;
52
53         next unless ($cmd =~ /^$ident$/i);
54
55         if ($done) {
56             &WARN("pCH: Multiple hook match: $ident");
57             next;
58         }
59
60         &DEBUG("pCH(hooks_$hashname): $cmd matched $ident");
61         my %hash = %{ ${"hooks_$hashname"}{$ident} };
62
63         if (!scalar keys %hash) {
64             &WARN("CmdHook: hash is NULL?");
65             return 1;
66         }
67
68         if (!exists $hash{CODEREF}) {
69             &ERROR("CODEREF undefined for $cmd or $ident.");
70             return 1;
71         }
72
73         ### DEBUG.
74         foreach (keys %hash) {
75             &DEBUG(" $cmd->$_ => '$hash{$_}'.");
76         }
77
78         ### HELP.
79         if (exists $hash{'Help'} and !scalar(@args)) {
80             &help( $hash{'Help'} );
81             return 1;
82         }
83
84         ### IDENTIFIER.
85         if (exists $hash{'Identifier'}) {
86             return unless (&hasParam($hash{'Identifier'}));
87         }
88
89         ### USER FLAGS.
90         if (exists $hash{'UserFlag'}) {
91             return unless (&hasFlag($hash{'UserFlag'}));
92         }
93
94         ### FORKER,IDENTIFIER,CODEREF.
95         if (exists $hash{'Forker'}) {
96             $hash{'Identifier'} .= "-" if ($hash{'Forker'} eq "NULL");
97
98             ### FLAT_ARG / ARRAY option.
99
100             &Forker($hash{'Identifier'}, sub { \&{$hash{'CODEREF'}}(@args) } );
101         } else {
102             if (exists $hash{'Module'}) {
103                 &loadMyModule($myModules{ $hash{'Module'} });
104             }
105
106             ### TODO: check if CODEREF exists.
107
108             if (exists $hash{'FlatArg'} and $hash{'FlatArg'} == 0) {
109                 &status("CmdHook: using args as array.");
110                 &{$hash{'CODEREF'}}(@args);
111             } else {
112                 &{$hash{'CODEREF'}}($flatarg);
113             }
114         }
115
116         ### CMDSTATS.
117         if (exists $hash{'Cmdstats'}) {
118             $cmdstats{ $hash{'Cmdstats'} }++;
119         }
120
121         &DEBUG("pCH: ended.");
122
123         $done = 1;
124     }
125
126     return 1 if ($done);
127     return 0;
128 }
129
130 ###
131 ### START ADDING HOOKS.
132 ###
133 &addCmdHook("extra", 'd?bugs', ('CODEREF' => 'debianBugs',
134         'Forker' => 1, 'Identifier' => 'debianExtra',
135         'Cmdstats' => 'Debian Bugs') );
136 &addCmdHook("extra", 'dauthor', ('CODEREF' => 'Debian::searchAuthor',
137         'Forker' => 1, 'Identifier' => 'debian',
138         'Cmdstats' => 'Debian Author Search', 'Help' => "dauthor" ) );
139 &addCmdHook("extra", '(d|search)desc', ('CODEREF' => 'Debian::searchDesc',
140         'Forker' => 1, 'Identifier' => 'debian',
141         'Cmdstats' => 'Debian Desc Search', 'Help' => "ddesc" ) );
142 &addCmdHook("extra", 'dnew', ('CODEREF' => 'DebianNew',
143         'Identifier' => 'debian' ) );
144 &addCmdHook("extra", 'dincoming', ('CODEREF' => 'Debian::generateIncoming',
145         'Forker' => 1, 'Identifier' => 'debian' ) );
146 &addCmdHook("extra", 'dstats', ('CODEREF' => 'Debian::infoStats',
147         'Forker' => 1, 'Identifier' => 'debian',
148         'Cmdstats' => 'Debian Statistics' ) );
149 &addCmdHook("extra", 'd?contents', ('CODEREF' => 'Debian::searchContents',
150         'Forker' => 1, 'Identifier' => 'debian',
151         'Cmdstats' => 'Debian Contents Search', 'Help' => "contents" ) );
152 &addCmdHook("extra", 'd?find', ('CODEREF' => 'Debian::DebianFind',
153         'Forker' => 1, 'Identifier' => 'debian',
154         'Cmdstats' => 'Debian Search', 'Help' => "find" ) );
155 &addCmdHook("extra", 'insult', ('CODEREF' => 'Insult::Insult',
156         'Forker' => 1, 'Identifier' => 'insult', 'Help' => "insult" ) );
157 &addCmdHook("extra", 'kernel', ('CODEREF' => 'Kernel::Kernel',
158         'Forker' => 1, 'Identifier' => 'kernel',
159         'Cmdstats' => 'Kernel') );
160 &addCmdHook("extra", 'listauth', ('CODEREF' => 'CmdListAuth',
161         'Identifier' => 'search', Module => 'factoids', 
162         'Help' => 'listauth') );
163 &addCmdHook("extra", 'quote', ('CODEREF' => 'Quote::Quote',
164         'Forker' => 1, 'Identifier' => 'quote',
165         'Help' => 'quote', 'Cmdstats' => 'Quote') );
166 &addCmdHook("extra", 'countdown', ('CODEREF' => 'Countdown',
167         'Module' => 'countdown', 'Identifier' => 'countdown',
168         'Cmdstats' => 'Countdown') );
169 &addCmdHook("extra", 'lart', ('CODEREF' => 'lart',
170         'Identifier' => 'lart', 'Help' => 'lart') );
171 &addCmdHook("extra", 'convert', ('CODEREF' => 'convert',
172         'Forker' => 1, 'Identifier' => 'units',
173         'Help' => 'convert') );
174 &addCmdHook("extra", '(cookie|random)', ('CODEREF' => 'cookie',
175         'Forker' => 1, 'Identifier' => 'factoids') );
176 &addCmdHook("extra", 'u(ser)?info', ('CODEREF' => 'userinfo',
177         'Identifier' => 'userinfo', 'Help' => 'userinfo',
178         'Module' => 'userinfo') );
179 &addCmdHook("extra", 'rootWarn', ('CODEREF' => 'CmdrootWarn',
180         'Identifier' => 'rootWarn', 'Module' => 'rootwarn') );
181 &addCmdHook("extra", 'seen', ('CODEREF' => 'seen', 'Identifier' =>
182         'seen') );
183 &addCmdHook("extra", 'dict', ('CODEREF' => 'Dict::Dict',
184         'Identifier' => 'dict', 'Help' => 'dict',
185         'Forker' => 1, 'Cmdstats' => 'Dict') );
186 &addCmdHook("extra", 'slashdot', ('CODEREF' => 'Slashdot::Slashdot',
187         'Identifier' => 'slashdot', 'Forker' => 1,
188         'Cmdstats' => 'Slashdot') );
189 &addCmdHook("extra", 'uptime', ('CODEREF' => 'uptime', 'Identifier' => 'uptime',
190         'Cmdstats' => 'Uptime') );
191 &addCmdHook("extra", 'nullski', ('CODEREF' => 'nullski', ) );
192 sub nullski { my ($arg) = @_; foreach (`$arg`) { &msg($who,$_); } }
193 &addCmdHook("extra", '(fm|freshmeat)', ('CODEREF' => 'Freshmeat::Freshmeat',
194         'Identifier' => 'freshmeat', 'Cmdstats' => 'Freshmeat',
195         'Forker' => 1, 'Help' => 'freshmeat') );
196 &addCmdHook("extra", 'verstats', ('CODEREF' => 'do_verstats' ) );
197
198 ###
199 ### END OF ADDING HOOKS.
200 ###
201 &status("CMD: loaded ".scalar(keys %hooks_extra)." EXTRA command hooks.");
202
203 sub Modules {
204     if (!defined $message) {
205         &WARN("Modules: message is undefined. should never happen.");
206         return;
207     }
208
209     # babel bot: Jonathan Feinberg++
210     if (&IsParam("babelfish") and $message =~ m{
211                 ^\s*
212                 (?:babel(?:fish)?|x|xlate|translate)
213                 \s+
214                 (to|from)               # direction of translation (through)
215                 \s+
216                 ($babel::lang_regex)\w* # which language?
217                 \s*
218                 (.+)                    # The phrase to be translated
219         }xoi) {
220
221         &Forker("babelfish", sub { &babel::babelfish(lc $1, lc $2, $3); } );
222
223         $cmdstats{'BabelFish'}++;
224         return;
225     }
226
227     if (&IsParam("debian")) {
228         my $debiancmd    = 'conflicts?|depends?|desc|file|info|provides?';
229         $debiancmd      .= '|recommends?|suggests?|maint|maintainer';
230         if ($message =~ /^($debiancmd)(\s+(.*))?$/i) {
231             my $package = lc $3;
232
233             if (defined $package) {
234                 &Forker("debian", sub { &Debian::infoPackages($1, $package); } );
235             } else {
236                 &help($1);
237             }
238
239             return;
240         }
241     }
242
243     # google searching. Simon++
244     if (&IsParam("wwwsearch") and $message =~ /^(?:search\s+)?(\S+)\s+for\s+['"]?(.*?)['"]?\s*\?*$/i) {
245         return unless (&hasParam("wwwsearch"));
246
247         &Forker("wwwsearch", sub { &W3Search::W3Search($1,$2); } );
248
249         $cmdstats{'WWWSearch'}++;
250         return;
251     }
252
253     # list{keys|values}. xk++. Idea taken from #linuxwarez@EFNET
254     if ($message =~ /^list(\S+)( (.*))?$/i) {
255         return unless (&hasParam("search"));
256
257         my $thiscmd     = lc($1);
258         my $args        = $3;
259
260         $thiscmd =~ s/^vals$/values/;
261         return if ($thiscmd ne "keys" && $thiscmd ne "values");
262
263         # Usage:
264         if (!defined $args) {
265             &help("list". $thiscmd);
266             return;
267         }
268
269         if (length $args == 1) {
270             &msg($who,"search string is too short.");
271             return;
272         }
273
274         &Forker("search", sub { &Search::Search($thiscmd, $args); } );
275
276         $cmdstats{'Factoid Search'}++;
277         return;
278     }
279
280     # Nickometer. Adam Spiers++
281     if ($message =~ /^(?:lame|nick)ometer(?: for)? (\S+)/i) {
282         return unless (&hasParam("nickometer"));
283
284         my $term = (lc $1 eq 'me') ? $who : $1;
285
286         &loadMyModule($myModules{'nickometer'});
287
288         if ($term =~ /^$mask{chan}$/) {
289             &DEBUG("nickometer: term == chan.");
290
291             if (!&validChan($term)) {
292                 &msg($who, "error: channel is invalid.");
293                 return;
294             }
295
296             # step 1.
297             my %nickometer;
298             foreach (keys %{ $channels{lc $term}{''} }) {
299                 if (!defined $_) {
300                     &WARN("nickometer: _ is undefined.");
301                     next;
302                 }
303
304                 my $value = &nickometer($_);
305                 $nickometer{$value}{$_} = 1;
306             }
307             # step 2.
308             ### TODO: compact with map?
309             my @list;
310             foreach (sort {$a <=> $b} keys %nickometer) {
311                 my $str = join(", ", sort keys %{$nickometer{$_}});
312                 push(@list, "$str ($_)");
313             }
314
315             &pSReply( &formListReply(0, "Nickometer list for $term ", @list) );
316
317             return;
318         }
319
320         my $percentage = &nickometer($term);
321
322         if ($percentage =~ /NaN/) {
323             $percentage = "off the scale";
324         } else {
325             $percentage = sprintf("%0.4f", $percentage);
326             $percentage =~ s/\.?0+$//;
327             $percentage .= '%';
328         }
329
330         if ($msgType eq 'public') {
331             &say("'$term' is $percentage lame, $who");
332         } else {
333             &msg($who, "the 'lame nick-o-meter' reading for $term is $percentage, $who");
334         }
335
336         return;
337     }
338
339     # Topic management. xk++
340     # may want to add a flag(??) for topic in the near future. -xk
341     if ($message =~ /^topic(\s+(.*))?$/i) {
342         return unless (&hasParam("topic"));
343
344         my $chan        = $talkchannel;
345         my @args        = split(/ /, $2);
346
347         if (!scalar @args) {
348             &msg($who,"Try 'help topic'");
349             return;
350         }
351
352         $chan           = lc(shift @args) if ($msgType eq 'private');
353         my $thiscmd     = shift @args;
354
355         # topic over public:
356         if ($msgType eq 'public' && $thiscmd =~ /^#/) {
357             &msg($who, "error: channel argument is not required.");
358             &msg($who, "\002Usage\002: topic <CMD>");
359             return;
360         }
361
362         # topic over private:
363         if ($msgType eq 'private' && $chan !~ /^#/) {
364             &msg($who, "error: channel argument is required.");
365             &msg($who, "\002Usage\002: topic #channel <CMD>");
366             return;
367         }
368
369         if (&validChan($chan) == 0) {
370             &msg($who,"error: invalid channel \002$chan\002");
371             return;
372         }
373
374         # for semi-outsiders.
375         if (!&IsNickInChan($who,$chan)) {
376             &msg($who, "Failed. You ($who) are not in $chan, hey?");
377             return;
378         }
379
380         # now lets do it.
381         &loadMyModule($myModules{'topic'});
382         &Topic($chan, $thiscmd, join(' ', @args));
383         $cmdstats{'Topic'}++;
384         return;
385     }
386
387     # wingate.
388     if ($message =~ /^wingate$/i) {
389         return unless (&hasParam("wingate"));
390
391         my $reply = "Wingate statistics: scanned \002"
392                         .scalar(keys %wingate)."\002 hosts";
393         my $queue = scalar(keys %wingateToDo);
394         if ($queue) {
395             $reply .= ".  I have \002$queue\002 hosts in the queue";
396             $reply .= ".  Started the scan ".&Time2String(time() - $wingaterun)." ago";
397         }
398
399         &performStrictReply("$reply.");
400
401         return;
402     }
403
404     # do nothing and let the other routines have a go
405     return "CONTINUE";
406 }
407
408 # Freshmeat. xk++
409 sub freshmeat {
410     my ($query) = @_;
411
412     if (!defined $query) {
413         &help("freshmeat");
414         &msg($who, "I have \002".&countKeys("freshmeat")."\002 entries.");
415         return;
416     }
417
418     &Freshmeat::Freshmeat($query);
419 }
420
421 # Uptime. xk++
422 sub uptime {
423     my $count = 1;
424     &msg($who, "- Uptime for $ident -");
425     &msg($who, "Now: ". &Time2String(&uptimeNow()) ." running $bot_version");
426
427     foreach (&uptimeGetInfo()) {
428         /^(\d+)\.\d+ (.*)/;
429         my $time = &Time2String($1);
430         my $info = $2;
431
432         &msg($who, "$count: $time $2");
433         $count++;
434     }
435 }
436
437 # seen.
438 sub seen {
439     my($person) = @_;
440
441     if (!defined $person) {
442         &help("seen");
443
444         my $i = &countKeys("seen");
445         &msg($who,"there ". &fixPlural("is",$i) ." \002$i\002 ".
446                 "seen ". &fixPlural("entry",$i) ." that I know of.");
447
448         return;
449     }
450
451     my @seen;
452     $person =~ s/\?*$//;
453
454     &seenFlush();       # very evil hack. oh well, better safe than sorry.
455
456     ### TODO: Support &dbGetRowInfo(); like in &FactInfo();
457     my $select = "nick,time,channel,host,message";
458     if ($person eq "random") {
459         @seen = &randKey("seen", $select);
460     } else {
461         @seen = &dbGet("seen", "nick", $person, $select);
462     }
463
464     if (scalar @seen < 2) {
465         foreach (@seen) {
466             &DEBUG("seen: _ => '$_'.");
467         }
468         &performReply("i haven't seen '$person'");
469         return;
470     }
471
472     # valid seen.
473     my $reply;
474     ### TODO: multi channel support. may require &IsNick() to return
475     ### all channels or something.
476     my @chans = &GetNickInChans($seen[0]);
477     if (scalar @chans) {
478         $reply = "$seen[0] is currently on";
479
480         foreach (@chans) {
481             $reply .= " ".$_;
482             next unless (exists $userstats{lc $seen[0]}{'Join'});
483             $reply .= " (".&Time2String(time() - $userstats{lc $seen[0]}{'Join'}).")";
484         }
485
486         if (&IsParam("seenStats")) {
487             my $i;
488             $i = $userstats{lc $seen[0]}{'Count'};
489             $reply .= ".  Has said a total of \002$i\002 messages" if (defined $i);
490             $i = $userstats{lc $seen[0]}{'Time'};
491             $reply .= ".  Is idling for ".&Time2String(time() - $i) if (defined $i);
492         }
493     } else {
494         my $howlong = &Time2String(time() - $seen[1]);
495         $reply = "$seen[0] <$seen[3]> was last seen on IRC ".
496                  "in channel $seen[2], $howlong ago, ".
497                  "saying\002:\002 '$seen[4]'.";
498     }
499
500     &performStrictReply($reply);
501     return;
502 }
503
504 # User Information Services. requested by Flugh.
505 sub userinfo {
506     my ($arg) = join(' ',@_);
507
508     if ($arg =~ /^set(\s+(.*))?$/i) {
509         $arg = $2;
510         if (!defined $arg) {
511             &help("userinfo set");
512             return;
513         }
514
515         &UserInfoSet(split /\s+/, $arg, 2);
516     } elsif ($arg =~ /^unset(\s+(.*))?$/i) {
517         $arg = $2;
518         if (!defined $arg) {
519             &help("userinfo unset");
520             return;
521         }
522
523         &UserInfoSet($arg, "");
524     } else {
525         &UserInfoGet($arg);
526     }
527 }
528
529 # cookie (random). xk++
530 sub cookie {
531     my ($arg) = @_;
532
533     # lets find that secret cookie.
534     my $target          = ($msgType ne 'public') ? $who : $talkchannel;
535     my $cookiemsg       = &getRandom(keys %{$lang{'cookie'}});
536     my ($key,$value);
537
538     ### WILL CHEW TONS OF MEM.
539     ### TODO: convert this to a Forker function!
540     if ($arg) {
541         my @list = &searchTable("factoids", "factoid_key", "factoid_value", $arg);
542         $key  = &getRandom(@list);
543         $val  = &getFactInfo("factoids", $key, "factoid_value");
544     } else {
545         ($key,$value) = &randKey("factoids","factoid_key,factoid_value");
546     }
547
548     for ($cookiemsg) {
549         s/##KEY/\002$key\002/;
550         s/##VALUE/$value/;
551         s/##WHO/$who/;
552         s/\$who/$who/;  # cheap fix.
553         s/(\S+)?\s*<\S+>/$1 /;
554         s/\s+/ /g;
555     }
556
557     if ($cookiemsg =~ s/^ACTION //i) {
558         &action($target, $cookiemsg);
559     } else {
560         &msg($target, $cookiemsg);
561     }
562 }
563
564 sub convert {
565     my $arg = join(' ',@_);
566     my ($from,$to) = ('','');
567
568     ($from,$to) = ($1,$2) if ($arg =~ /^(.*?) to (.*)$/i);
569     ($from,$to) = ($2,$1) if ($arg =~ /^(.*?) from (.*)$/i);
570
571     if (!$to or !$from) {
572         &msg($who, "Invalid format!");
573         &help("convert");
574         return;
575     }
576
577     &Units::convertUnits($from, $to);
578
579     return;
580 }
581
582 sub lart {
583     my ($target) = &fixString($_[0]);
584     my $extra   = 0;
585     my $chan    = $talkchannel;
586
587     if ($msgType eq 'private') {
588         if ($target =~ /^($mask{chan})\s+(.*)$/) {
589             $chan       = $1;
590             $target     = $2;
591             $extra      = 1;
592         } else {
593             &msg($who, "error: invalid format or missing arguments.");
594             &help("lart");
595             return;
596         }
597     }
598
599     my $line = &getRandomLineFromFile($bot_misc_dir. "/blootbot.lart");
600     if (defined $line) {
601         if ($target =~ /^(me|you|itself|\Q$ident\E)$/i) {
602             $line =~ s/WHO/$who/g;
603         } else {
604             $line =~ s/WHO/$target/g;
605         }
606         $line .= ", courtesy of $who" if ($extra);
607
608         &action($chan, $line);
609     } else {
610         &status("lart: error reading file?");
611     }
612 }
613
614 sub DebianNew {
615     my $idx   = "debian/Packages-woody.idx";
616     my $error = 0;
617     my %pkg;
618     my @new;
619
620     $error++ unless ( -e $idx);
621     $error++ unless ( -e "$idx-old");
622
623     if ($error) {
624         $error = "no woody/woody-old index file found.";
625         &ERROR("Debian: $error");
626         &msg($who, $error);
627         return;
628     }
629
630     open(IDX1, $idx);
631     open(IDX2, "$idx-old");
632
633     while (<IDX2>) {
634         chop;
635         next if (/^\*/);
636
637         $pkg{$_} = 1;
638     }
639     close IDX2;
640
641     open(IDX1,$idx);
642     while (<IDX1>) {
643         chop;
644         next if (/^\*/);
645         next if (exists $pkg{$_});
646
647         push(@new);
648     }
649     close IDX1;
650
651     &::performStrictReply( &::formListReply(0, "New debian packages:", @new) );
652 }
653
654 sub do_verstats {
655     my ($chan)  = @_;
656
657     if (!defined $chan) {
658         &help("verstats");
659         return;
660     }
661
662     if (!&validChan($chan)) {
663         &pSReply("chan $chan is invalid.");
664         return;
665     }
666
667     if (scalar keys %ver) {
668         &DEBUG("keys ver exists... stopping.");
669         return;
670     }
671
672     &msg($who, "Sending CTCP VERSION...");
673     $conn->ctcp("VERSION", $chan);
674     $conn->schedule(60, sub {
675         my $total = 0;
676
677         foreach (keys %ver) {
678             $total += scalar keys %{ $ver{$_} };
679         }
680
681         my %sorted;
682         foreach (keys %ver) {
683             my $count = scalar keys %{ $ver{$_} };
684             my $perc  = sprintf("%.01f", $count * 100 / $total);
685             $perc =~ s/.0$//;   # lame compression.
686
687             $sorted{$perc} = "$_ - $count ($perc %)";
688         }
689
690         ### can be compressed to a map?
691         my @list;
692         foreach ( sort { $a <=> $b } keys %sorted ) {
693             push(@list, $sorted{$_});
694         }
695
696         &pSReply( &formListReply(0, "IRC Client versions for $chan ", @list) );
697
698         undef %ver;     # clean it up.
699     } );
700
701     return;
702 }
703
704 1;