src/IRC/Schedulers.pl

   1 #
   2 # ProcessExtra.pl: Extensions to Process.pl
   3 #          Author: dms
   4 #         Version: v0.4b (20000923)
   5 #         Created: 20000117
   6 #
   7
   8 if (&IsParam("useStrict")) { use strict; }
   9
  10 sub setupSchedulers {
  11     &VERB("Starting schedulers...",2);
  12
  13     # ONCE OFF.
  14
  15     # REPETITIVE.
  16     &uptimeCycle(1)     if (&IsParam("uptime"));
  17     &randomQuote(1)     if (&IsParam("randomQuote"));
  18     &randomFactoid(1)   if (&IsParam("randomFactoid"));
  19     &logCycle(1)        if (defined fileno LOG and &IsParam("logfile") and &IsParam("maxLogSize"));
  20     &chanlimitCheck(1)  if (&IsParam("chanlimitcheck"));
  21     &netsplitCheck(1);  # mandatory
  22     &floodCycle(1);     # mandatory
  23     &seenFlush(1)       if (&IsParam("seen") and &IsParam("seenFlushInterval"));
  24     &leakCheck(1);      # mandatory
  25     &ignoreListCheck(1);# mandatory
  26     &seenFlushOld(1)    if (&IsParam("seen"));
  27     &ircCheck(1);       # mandatory
  28     &miscCheck(1);      # mandatory
  29     &shmFlush(1);       # mandatory
  30     &slashdotCycle(1)   if (&IsParam("slashdot") and &IsParam("slashdotAnnounce"));
  31     &freshmeatCycle(1)  if (&IsParam("freshmeat") and &IsParam("freshmeatAnnounce"));
  32     &kernelCycle(1)     if (&IsParam("kernel") and &IsParam("kernelAnnounce"));
  33     &wingateWriteFile(1) if (&IsParam("wingate"));
  34     &factoidCheck(1)    if (&IsParam("factoidDeleteDelay"));
  35 }
  36
  37 sub ScheduleThis {
  38     my ($interval, $codename, @args) = @_;
  39     my $waittime = &getRandomInt($interval);
  40
  41     &VERB("Scheduling \&$codename() for ".&Time2String($waittime),3);
  42     $conn->schedule($waittime, \&$codename, @args);
  43 }
  44
  45 sub randomQuote {
  46     my $line = &getRandomLineFromFile($bot_misc_dir. "/blootbot.randtext");
  47     if (!defined $line) {
  48         &ERROR("random Quote: weird error?");
  49         return;
  50     }
  51
  52     my @channels = split(/[\s\t]+/, lc $param{'randomQuoteChannels'});
  53     @channels    = keys(%channels) unless (scalar @channels);
  54
  55     my $good = 0;
  56     foreach (@channels) {
  57         next unless (&validChan($_));
  58
  59         &status("sending random Quote to $_.");
  60         &action($_, "Ponders: ".$line);
  61         $good++;
  62     }
  63
  64     if (!$good and scalar @channels) {
  65         &WARN("randomQuote: no valid channels?");
  66     }
  67
  68     my $interval = $param{'randomQuoteInterval'} || 60;
  69     &ScheduleThis($interval, "randomQuote") if (@_);
  70 }
  71
  72 sub randomFactoid {
  73     my ($key,$val);
  74     my $error = 0;
  75     while (1) {
  76         ($key,$val) = &randKey("factoids","factoid_key,factoid_value");
  77 ###     $val =~ tr/^[A-Z]/[a-z]/;       # blah is Good => blah is good.
  78         last if ($val !~ /^</);
  79         $error++;
  80         if ($error == 5) {
  81             &ERROR("rF: tried 5 times but failed.");
  82             return;
  83         }
  84     }
  85
  86     my @channels = split(/[\s\t]+/, lc $param{'randomFactoidChannels'});
  87     @channels    = keys(%channels) unless (scalar @channels);
  88
  89     my $good = 0;
  90     foreach (@channels) {
  91         next unless (&validChan($_));
  92
  93         &status("sending random Factoid to $_.");
  94 ###     &msg($_, "$key is $val");
  95         &action($_, "Thinks: \037$key\037 is $val");
  96         ### FIXME: Use &getReply() on above to format factoid properly?
  97         $good++;
  98     }
  99
 100     if (!$good and scalar @channels) {
 101         &WARN("randomFactoid: no valid channels?");
 102     }
 103
 104     my $interval = $param{'randomFactoidInterval'} || 60;
 105     &ScheduleThis($interval, "randomFactoid") if (@_);
 106 }
 107
 108 sub logCycle {
 109     # check if current size is too large.
 110     if ( -s $file{log} > $param{'maxLogSize'}) {
 111         my $date = sprintf("%04d%02d%02d", (localtime)[5,4,3]);
 112         $file{log} = $param{'logfile'} ."-". $date;
 113         &status("cycling log file.");
 114
 115         if ( -e $file{log}) {
 116             my $i = 1;
 117             my $newlog;
 118             while () {
 119                 $newlog = $file{log}."-".$i;
 120                 last if (! -e $newlog);
 121                 $i++;
 122             }
 123             $file{log} = $newlog;
 124         }
 125
 126         &closeLog();
 127         system("/bin/mv '$param{'logfile'}' '$file{log}'");
 128         &compress($file{log});
 129         &openLog();
 130         &status("cycling log file.");
 131     }
 132
 133     # check if all the logs exceed size.
 134     my $logdir = "$bot_base_dir/log/";
 135     if (opendir(LOGS, $logdir)) {
 136         my $tsize = 0;
 137         my (%age, %size);
 138
 139         while (defined($_ = readdir LOGS)) {
 140             my $logfile = "$logdir/$_";
 141
 142             next unless ( -f $logfile);
 143             my $size = -s $logfile;
 144             my $age = (stat $logfile)[9]; ### or 8 ?
 145
 146             $age{$age}          = $logfile;
 147             $size{$logfile}     = $size;
 148
 149             $tsize              += $size;
 150         }
 151         closedir LOGS;
 152
 153         my $delete = 0;
 154         while ($tsize > $param{'maxLogSize'}) {
 155             &status("LOG: current size > max ($tsize > $param{'maxLogSize'})");
 156             my $oldest = (sort {$a <=> $b} keys %age)[0];
 157             &status("LOG: unlinking $age{$oldest}.");
 158             unlink $age{$oldest};
 159             $tsize -= $oldest;
 160             $delete++;
 161         }
 162
 163         ### TODO: add how many b,kb,mb removed?
 164         &status("LOG: removed $delete logs.") if ($delete);
 165     } else {
 166         &WARN("could not open dir $logdir");
 167     }
 168
 169     &ScheduleThis(60, "logCycle") if (@_);
 170 }
 171
 172 sub seenFlushOld {
 173     my $max_time = $param{'seenMaxDays'}*60*60*24;
 174     my $delete   = 0;
 175
 176     if ($param{'DBType'} =~ /^pg|postgres|mysql/i) {
 177         my $query = "SELECT nick,time FROM seen GROUP BY nick HAVING UNIX_TIMESTAMP() - time > $max_time";
 178         my $sth = $dbh->prepare($query);
 179         $sth->execute;
 180
 181         while (my @row = $sth->fetchrow_array) {
 182             my ($nick,$time) = @row;
 183
 184             &dbDel("seen","nick",$nick);
 185             $delete++;
 186         }
 187         $sth->finish;
 188     } elsif ($param{'DBType'} =~ /^dbm/i) {
 189         my $time = time();
 190
 191         foreach (keys %seen) {
 192             my $delta_time = $time - &dbGet("seen", "NULL", $_, "time");
 193             next unless ($delta_time > $max_time);
 194
 195             &DEBUG("seenFlushOld: ".&Time2String($delta_time) );
 196             delete $seen{$_};
 197             $delete++;
 198         }
 199     } else {
 200         &FIXME("seenFlushOld: for PG/NO-DB.");
 201     }
 202     &VERB("SEEN deleted $delete seen entries.",2);
 203
 204     &ScheduleThis(1440, "seenFlushOld") if (@_);
 205 }
 206
 207 sub chanlimitCheck {
 208     my $limitplus = $param{'chanlimitcheckPlus'} || 5;
 209     my @channels = split(/[\s\t]+/, lc $param{'chanlimitcheck'});
 210
 211     foreach (@channels) {
 212         next unless (&validChan($_));
 213
 214         my $newlimit = scalar(keys %{$channels{$_}{''}}) + $limitplus;
 215         my $limit = $channels{$_}{'l'};
 216
 217         if (scalar keys %{$channels{$_}{''}} > $limit) {
 218             &status("LIMIT: set too low!!! FIXME");
 219         }
 220
 221         next unless (!defined $limit or $limit != $newlimit);
 222
 223         if (scalar keys %netsplit and $limit) {
 224             &status("Removing limit for $_ [netsplit!!!]");
 225             &rawout("MODE $_ -l");
 226             return;
 227         }
 228
 229         if (!exists $channels{$_}{'o'}{$ident}) {
 230             &ERROR("chanlimitcheck: dont have ops on $_.");
 231             next;
 232         }
 233         &rawout("MODE $_ +l $newlimit");
 234     }
 235
 236     my $interval = $param{'chanlimitcheckInterval'} || 10;
 237     &ScheduleThis($interval, "chanlimitCheck") if (@_);
 238 }
 239
 240 sub netsplitCheck {
 241     my ($s1,$s2);
 242
 243     foreach $s1 (keys %netsplitservers) {
 244         foreach $s2 (keys %{$netsplitservers{$s1}}) {
 245             if (time() - $netsplitservers{$s1}{$s2} > 3600) {
 246                 &status("netsplit between $s1 and $s2 appears to be stale.");
 247                 delete $netsplitservers{$s1}{$s2};
 248             }
 249         }
 250     }
 251
 252     # %netsplit hash checker.
 253     foreach (keys %netsplit) {
 254         if (&IsNickInAnyChan($_)) {
 255             &DEBUG("netsplitC: $_ is in some chan; removing from netsplit list.");
 256             delete $netsplit{$_};
 257         }
 258         next unless (time() - $netsplit{$_} > 60*60*2); # 2 hours.
 259         next if (&IsNickInAnyChan($_));
 260
 261         &DEBUG("netsplitC: $_ didn't come back from netsplit in 2 hours; removing from netsplit list.");
 262         delete $netsplit{$_};
 263     }
 264
 265     &ScheduleThis(30, "netsplitCheck") if (@_);
 266 }
 267
 268 sub floodCycle {
 269     my $interval = $param{'floodInterval'} || 60;       # seconds.
 270     my $delete = 0;
 271
 272     my $who;
 273     foreach $who (keys %flood) {
 274         foreach (keys %{$flood{$who}}) {
 275             if (time() - $flood{$who}{$_} > $interval) {
 276                 delete $flood{$who}{$_};
 277                 $delete++;
 278             }
 279         }
 280     }
 281     &VERB("floodCycle: deleted $delete items.",2);
 282
 283     &ScheduleThis($interval, "floodCycle") if (@_);     # minutes.
 284 }
 285
 286 sub seenFlush {
 287     my $nick;
 288     my $flushed = 0;
 289     my %stats;
 290     $stats{'count_old'} = &countKeys("seen");
 291     $stats{'new'}       = 0;
 292     $stats{'old'}       = 0;
 293
 294     if ($param{'DBType'} =~ /^mysql|pg|postgres/i) {
 295         foreach $nick (keys %seencache) {
 296             my $exists = &dbGet("seen","nick", $nick, "nick");
 297
 298             if (defined $exists and $exists) {
 299                 &dbUpdate("seen", "nick", $nick, (
 300                         "time" => $seencache{$nick}{'time'},
 301                         "host" => $seencache{$nick}{'host'},
 302                         "channel" => $seencache{$nick}{'chan'},
 303                         "message" => $seencache{$nick}{'msg'},
 304                 ) );
 305                 $stats{'old'}++;
 306             } else {
 307                 my $retval = &dbInsert("seen", $nick, (
 308                         "nick" => $seencache{$nick}{'nick'},
 309                         "time" => $seencache{$nick}{'time'},
 310                         "host" => $seencache{$nick}{'host'},
 311                         "channel" => $seencache{$nick}{'chan'},
 312                         "message" => $seencache{$nick}{'msg'},
 313                 ) );
 314                 $stats{'new'}++;
 315
 316                 ### TODO: put bad nick into a list and don't do it again!
 317                 &FIXME("Should never happen! (nick => $nick)") if !$retval;
 318             }
 319
 320             delete $seencache{$nick};
 321             $flushed++;
 322         }
 323
 324     } elsif ($param{'DBType'} =~ /^dbm/i) {
 325
 326         foreach $nick (keys %seencache) {
 327             my $retval = &dbInsert("seen", $nick, (
 328                 "nick" => $seencache{$nick}{'nick'},
 329                 "time" => $seencache{$nick}{'time'},
 330                 "host" => $seencache{$nick}{'host'},
 331                 "channel" => $seencache{$nick}{'chan'},
 332                 "message" => $seencache{$nick}{'msg'},
 333             ) );
 334
 335             ### TODO: put bad nick into a list and don't do it again!
 336             &FIXME("Should never happen! (nick => $nick)") if !$retval;
 337
 338             delete $seencache{$nick};
 339             $flushed++;
 340         }
 341     } else {
 342         &DEBUG("seenFlush: NO VALID FACTOID SUPPORT?");
 343     }
 344
 345     &status("Flushed $flushed seen entries.")           if ($flushed);
 346     &VERB(sprintf("  new seen: %03.01f%% (%d/%d)",
 347         $stats{'new'}*100/$stats{'count_old'},
 348         $stats{'new'}, $stats{'count_old'} ), 2)        if ($stats{'new'});
 349     &VERB(sprintf("  now seen: %3.1f%% (%d/%d)",
 350         $stats{'old'}*100/&countKeys("seen"),
 351         $stats{'old'}, &countKeys("seen") ), 2)         if ($stats{'old'});
 352
 353     &WARN("scalar keys seenflush != 0!")        if (scalar keys %seenflush);
 354
 355     my $interval = $param{'seenFlushInterval'} || 60;
 356     &ScheduleThis($interval, "seenFlush") if (@_);
 357 }
 358
 359 sub leakCheck {
 360     my ($blah1,$blah2);
 361     my $count = 0;
 362
 363     # flood.
 364     foreach $blah1 (keys %flood) {
 365         foreach $blah2 (keys %{$flood{$blah1}}) {
 366             $count += scalar(keys %{$flood{$blah1}{$blah2}});
 367         }
 368     }
 369     &VERB("\%flood has $count total keys.",2);
 370
 371     my $chan;
 372     foreach $chan (grep /[A-Z]/, keys %channels) {
 373         &DEBUG("leak: chan => '$chan'.");
 374         my ($i,$j);
 375         foreach $i (keys %{$channels{$chan}}) {
 376             foreach (keys %{$channels{$chan}{$i}}) {
 377                 &DEBUG("leak:   \$channels{$chan}{$i}{$_} ...");
 378             }
 379         }
 380     }
 381
 382     &ScheduleThis(60, "leakCheck") if (@_);
 383 }
 384
 385 sub ignoreListCheck {
 386     my $time = time();
 387     my $count = 0;
 388
 389     foreach (keys %ignoreList) {
 390         next if ($ignoreList{$_} == 1);
 391         next unless ($time > $ignoreList{$_});
 392
 393         delete $ignoreList{$_};
 394         &status("ignore: $_ has expired.");
 395         $count++;
 396     }
 397     &VERB("ignore: $count items deleted.",2);
 398
 399     &ScheduleThis(30, "ignoreListCheck") if (@_);
 400 }
 401
 402 sub ircCheck {
 403     my @array = split /[\t\s]+/, $param{'join_channels'};
 404     my $iconf = scalar(@array);
 405     my $inow  = scalar(keys %channels);
 406     if ($iconf > 2 and $inow * 2 <= $iconf) {
 407         &FIXME("ircCheck: current channels * 2 <= config channels. FIXME.");
 408     }
 409
 410     if (!$conn->connected and time - $msgtime > 3600) {
 411         &WARN("ircCheck: no msg for 3600 and disco'd! reconnecting!");
 412         $msgtime = time();      # just in case.
 413         &ircloop();
 414     }
 415
 416     if ($ident !~ /^\Q$param{ircNick}\E$/) {
 417         &WARN("ircCheck: ident($ident) != param{ircNick}($param{IrcNick}).");
 418     }
 419
 420     &joinNextChan();
 421         # if scalar @joinnext => join more channels
 422         # else check for chanserv.
 423
 424     if (grep /^\s*$/, keys %channels) {
 425         &WARN("we have a NULL chan in hash channels? removing!");
 426         delete $channels{''};
 427         &status("channels now:");
 428         foreach (keys %channels) {
 429             &status("  $_");
 430         }
 431     }
 432
 433
 434     &ScheduleThis(240, "ircCheck") if (@_);
 435 }
 436
 437 sub miscCheck {
 438     # SHM check.
 439     my @ipcs;
 440     if ( -x "/usr/bin/ipcs") {
 441         @ipcs = `/usr/bin/ipcs`;
 442     } else {
 443         &WARN("ircCheck: no 'ipcs' binary.");
 444     }
 445
 446     # shmid stale remove.
 447     foreach (@ipcs) {
 448         chop;
 449
 450         # key, shmid, owner, perms, bytes, nattch
 451         next unless (/^(0x\d+) (\d+)\s+(\S+)\s+(\d+)\s+(\d+)\s+/);
 452
 453         my ($shmid, $size) = ($2,$5);
 454         next unless ($shmid != $shm and $size == 2000);
 455
 456         &status("SHM: nuking shmid $shmid");
 457         system("/usr/bin/ipcrm shm $shmid >/dev/null");
 458     }
 459
 460     ### check modules if they've been modified. might be evil.
 461     &reloadAllModules();
 462
 463     &ScheduleThis(240, "miscCheck") if (@_);
 464 }
 465
 466 sub shmFlush {
 467     my $shmmsg = &shmRead($shm);
 468     $shmmsg =~ s/\0//g;         # remove padded \0's.
 469
 470     return if ($$ != $main::bot_pid); # fork protection.
 471
 472     foreach (split '\|\|', $shmmsg) {
 473         &VERB("shm: Processing '$_'.",2);
 474
 475         if (/^DCC SEND (\S+) (\S+)$/) {
 476             my ($nick,$file) = ($1,$2);
 477             if (exists $dcc{'SEND'}{$who}) {
 478                 &msg($nick,"DCC already active.");
 479             } else {
 480                 &DEBUG("shm: dcc sending $2 to $1.");
 481                 $conn->new_send($1,$2);
 482                 $dcc{'SEND'}{$who} = time();
 483             }
 484         } elsif (/^SET FORKPID (\S+) (\S+)/) {
 485             $forked{$1}{PID} = $2;
 486         } elsif (/^DELETE FORK (\S+)$/) {
 487             delete $forked{$1};
 488         } elsif (/^EVAL (.*)$/) {
 489             &DEBUG("evaling '$1'.");
 490             eval $1;
 491         } else {
 492             &DEBUG("shm: unknown msg. ($_)");
 493         }
 494     }
 495
 496     &shmWrite($shm,"") if ($shmmsg ne "");
 497
 498     &ScheduleThis(5, "shmFlush") if (@_);
 499 }
 500
 501 ### this is semi-scheduled
 502 sub getNickInUse {
 503     if ($ident eq $param{'ircNick'}) {
 504         &status("okay, got my nick back.");
 505         return;
 506     }
 507
 508     &status("Trying to get my nick back.");
 509     &nick($param{'ircNick'});
 510
 511     &ScheduleThis(5, "getNickInUse") if (@_);
 512 }
 513
 514 sub uptimeCycle {
 515     &uptimeWriteFile();
 516
 517     &ScheduleThis(60, "uptimeCycle") if (@_);
 518 }
 519
 520 sub slashdotCycle {
 521     &Forker("slashdot", sub { &Slashdot::slashdotAnnounce(); } );
 522
 523     &ScheduleThis(60, "slashdotCycle") if (@_);
 524 }
 525
 526 sub freshmeatCycle {
 527     &Forker("freshmeat", sub { &Freshmeat::freshmeatAnnounce(); } );
 528
 529     &ScheduleThis(60, "freshmeatCycle") if (@_);
 530 }
 531
 532 sub kernelCycle {
 533     &Forker("kernel", sub { &Kernel::kernelAnnounce(); } );
 534
 535     &ScheduleThis(240, "kernelCycle") if (@_);
 536 }
 537
 538 sub wingateCheck {
 539     return unless &IsParam("wingate");
 540     return unless ($param{'wingate'} =~ /^(.*\s+)?$chan(\s+.*)?$/i);
 541
 542     ### FILE CACHE OF OFFENDING WINGATES.
 543     foreach (grep /^$host$/, @wingateBad) {
 544         &status("Wingate: RUNNING ON $host BY $who");
 545         &ban("*!*\@$host", "") if &IsParam("wingateBan");
 546
 547         next unless (&IsParam("wingateKick"));
 548         &kick($who, "", $param{'wingateKick'})
 549     }
 550
 551     ### RUN CACHE OF TRIED WINGATES.
 552     if (grep /^$host$/, @wingateCache) {
 553         push(@wingateNow, $host);       # per run.
 554         push(@wingateCache, $host);     # cache per run.
 555     } else {
 556         &DEBUG("Already scanned $host. good.");
 557     }
 558
 559     my $interval = $param{'wingateInterval'} || 60;     # seconds.
 560     return if (defined $forked{'wingate'});
 561     return if (time() - $wingaterun <= $interval);
 562     return unless (scalar(keys %wingateToDo));
 563
 564     $wingaterun = time();
 565
 566     &Forker("wingate", sub { &Wingate::Wingates(keys %wingateToDo); } );
 567     undef @wingateNow;
 568 }
 569
 570 ### TODO.
 571 sub wingateWriteFile {
 572     return unless (scalar @wingateCache);
 573
 574     my $file = "$bot_base_dir/$param{'ircUser'}.wingate";
 575     if ($bot_pid != $$) {
 576         &DEBUG("wingateWriteFile: Reorganising!");
 577
 578         open(IN, $file);
 579         while (<IN>) {
 580             chop;
 581             push(@wingateNow, $_);
 582         }
 583         close IN;
 584
 585         # very lame hack.
 586         my %hash = map { $_ => 1 } @wingateNow;
 587         @wingateNow = sort keys %hash;
 588     }
 589
 590     &DEBUG("wingateWF: writing...");
 591     open(OUT, ">$file");
 592     foreach (@wingateNow) {
 593         print OUT "$_\n";
 594     }
 595     close OUT;
 596
 597     &ScheduleThis(60, "wingateWriteFile") if (@_);
 598 }
 599
 600 sub factoidCheck {
 601     my @list = &searchTable("factoids", "factoid_key", "factoid_key", " #DEL#");
 602     my $stale = $param{'factoidDeleteDelay'}*60*60*24;
 603
 604     foreach (@list) {
 605         my $age = &getFactInfo($_, "modified_time");
 606         next unless (time() - $age > $stale);
 607
 608         my $fix = $_;
 609         $fix =~ s/ #DEL#$//g;
 610         &VERB("safedel: Removing $fix for good.",2);
 611         &delFactoid($_);
 612     }
 613
 614     &ScheduleThis(1440, "factoidCheck") if (@_);
 615 }
 616
 617 sub schedulerSTUB {
 618
 619     &ScheduleThis(TIME_IN_MINUTES, "FUNCTION") if (@_);
 620 }
 621
 622 1;