src/core.pl

   1 #
   2 #   core.pl: Important functions stuff...
   3 #    Author: dms
   4 #   Version: v0.4 (20000718)
   5 #   Created: 20000322
   6 #
   7
   8 use strict;
   9
  10 # dynamic scalar. MUST BE REDUCED IN SIZE!!!
  11 ### TODO: reorder.
  12 use vars qw(
  13         $answer $correction_plausible $talkchannel
  14         $statcount $memusage $user $memusageOld $bot_version $dbh
  15         $shm $host $msg $bot_misc_dir $bot_pid $bot_base_dir $noreply
  16         $bot_src_dir $conn $irc $learnok $nick $ident $no_syscall
  17         $force_public_reply $addrchar $userHandle $addressedother
  18         $floodwho $chan $msgtime $server $firsttime $wingaterun
  19         $flag_quit $msgType
  20         $utime_userfile $wtime_userfile $ucount_userfile
  21         $utime_chanfile $wtime_chanfile $ucount_chanfile
  22 );
  23
  24 # dynamic hash.
  25 use vars qw(@joinchan @ircServers @wingateBad @wingateNow @wingateCache
  26 );
  27
  28 ### dynamic hash. MUST BE REDUCED IN SIZE!!!
  29 #
  30 use vars qw(%count %netsplit %netsplitservers %flood %dcc %orig
  31             %nuh %talkWho %seen %floodwarn %param %dbh %ircPort
  32             %topic %moduleAge %last %time %mask %file
  33             %forked %chanconf %channels
  34 );
  35
  36 # Signals.
  37 $SIG{'HUP'}  = 'restart'; #  1.
  38 $SIG{'INT'}  = 'doExit';  #  2.
  39 $SIG{'KILL'} = 'doExit';  #  9. DOES NOT WORK. 'man perlipc' for details.
  40 $SIG{'TERM'} = 'doExit';  # 15.
  41 $SIG{'__WARN__'} = 'doWarn';
  42
  43 # initialize variables.
  44 $last{buflen}   = 0;
  45 $last{say}      = "";
  46 $last{msg}      = "";
  47 $userHandle     = "default";
  48 $msgtime        = time();
  49 $wingaterun     = time();
  50 $firsttime      = 1;
  51 $utime_userfile = 0;
  52 $wtime_userfile = 0;
  53 $ucount_userfile = 0;
  54 $utime_chanfile = 0;
  55 $wtime_chanfile = 0;
  56 $ucount_chanfile = 0;
  57
  58 $bot_version    = "blootbot cvs (20010214) -- $^O";
  59 $noreply        = "NOREPLY";
  60
  61 ##########
  62 ### misc commands.
  63 ###
  64
  65 sub doExit {
  66     my ($sig)   = @_;
  67
  68     if (defined $flag_quit) {
  69         &WARN("doExit: quit already called.");
  70         return;
  71     }
  72     $flag_quit  = 1;
  73
  74     if (!defined $bot_pid) {    # independent.
  75         exit 0;
  76     } elsif ($bot_pid == $$) {  # parent.
  77         &status("parent caught SIG$sig (pid $$).") if (defined $sig);
  78
  79         &status("--- Start of quit.");
  80
  81         &closeDCC();
  82         &closePID();
  83         &seenFlush();
  84         &quit($param{'quitMsg'}) if (&whatInterface() =~ /IRC/);
  85         &writeUserFile();
  86         &writeChanFile();
  87         &uptimeWriteFile()      if (&ChanConfList("uptime"));
  88         &News::writeNews()      if (&ChanConfList("news"));
  89         &closeDB();
  90         &closeSHM($shm);
  91         &dumpallvars()          if (&IsParam("dumpvarsAtExit"));
  92         &closeLog();
  93         &closeSQLDebug()        if (&IsParam("SQLDebug"));
  94
  95         &status("--- QUIT.");
  96     } else {                                    # child.
  97         &status("child caught SIG$sig (pid $$).");
  98     }
  99
 100     exit 0;
 101 }
 102
 103 sub doWarn {
 104     $SIG{__WARN__} = sub { warn $_[0]; };
 105
 106     foreach (@_) {
 107         &WARN("PERL: $_");
 108     }
 109
 110     $SIG{__WARN__} = 'doWarn';  # ???
 111 }
 112
 113 # Usage: &IsParam($param);
 114 # blootbot.config specific.
 115 sub IsParam {
 116     my $param = $_[0];
 117
 118     return 0 unless (defined $param);
 119     return 0 unless (exists $param{$param});
 120     return 0 unless ($param{$param});
 121     return 0 if $param{$param} =~ /^false$/i;
 122     return 1;
 123 }
 124
 125 #####
 126 #  Usage: &ChanConfList($param)
 127 #  About: gets channels with 'param' enabled. (!!!)
 128 # Return: array of channels
 129 sub ChanConfList {
 130     my $param   = $_[0];
 131     return unless (defined $param);
 132     my %chan    = &getChanConfList($param);
 133
 134     if (exists $chan{_default}) {
 135         return keys %chanconf;
 136     } else {
 137         return keys %chan;
 138     }
 139 }
 140
 141 #####
 142 #  Usage: &getChanConfList($param)
 143 #  About: gets channels with 'param' enabled, internal use only.
 144 # Return: hash of channels
 145 sub getChanConfList {
 146     my $param   = $_[0];
 147     my %chan;
 148
 149     return unless (defined $param);
 150
 151     foreach (keys %chanconf) {
 152         my $chan        = $_;
 153 #       &DEBUG("chan => $chan");
 154         my @array       = grep /^$param$/, keys %{ $chanconf{$chan} };
 155
 156         next unless (scalar @array);
 157
 158         if (scalar @array > 1) {
 159             &WARN("multiple items found?");
 160         }
 161
 162         if ($array[0] eq "0") {
 163             $chan{$chan}        = -1;
 164         } else {
 165             $chan{$chan}        =  1;
 166         }
 167     }
 168
 169     return %chan;
 170 }
 171
 172 #####
 173 #  Usage: &IsChanConf($param);
 174 #  About: Check for 'param' on the basis of channel config.
 175 # Return: 1 for enabled, 0 for passive disable, -1 for active disable.
 176 sub IsChanConf {
 177     my($param)  = shift;
 178
 179     if (!defined $param) {
 180         &WARN("param == NULL.");
 181         return 0;
 182     }
 183
 184     ### TODO: VERBOSITY on how chanconf returned 1 or 0 or -1.
 185     my %chan    = &getChanConfList($param);
 186     if (!defined $msgType) {
 187 #       &DEBUG("icc: !def msgType...");
 188         return $chan{_default} || 0;
 189     }
 190
 191     if ($msgType eq "public") {
 192         if ($chan{lc $chan}) {
 193 #           &DEBUG("iCC: public: $chan/$param");
 194         } elsif ($chan{_default}) {
 195 #           &DEBUG("iCC: public: _default/$param")
 196         } else {
 197 #           &DEBUG("iCC: public: 0/$param");
 198         }
 199
 200         return $chan{lc $chan} || $chan{_default} || 0;
 201     }
 202
 203     if ($msgType eq "private") {
 204         if ($chan{_default}) {
 205 #           &DEBUG("iCC: private: _default/$param");
 206         } elsif ($chan{lc $chan}) {
 207 #           &DEBUG("iCC: private: $chan/$param");
 208         } else {
 209 #           &DEBUG("iCC: private: 0/$param");
 210         }
 211
 212         return $chan{lc $chan} || $chan{_default} || 0;
 213     }
 214
 215 ### debug purposes only.
 216 #    &DEBUG("param => $param, msgType => $msgType.");
 217 #    foreach (keys %chan) {
 218 #       &DEBUG("   $_ => $chan{$_}");
 219 #    }
 220
 221     &DEBUG("icc: returning 0...");
 222
 223     return 0;
 224 }
 225
 226 #####
 227 #  Usage: &getChanConf($param);
 228 #  About: Retrieve value for 'param' value in current/default chan.
 229 # Return: scalar for success, undef for failure.
 230 sub getChanConf {
 231     my($param,$chan)    = @_;
 232
 233     if (!defined $param) {
 234         &WARN("param == NULL.");
 235         return 0;
 236     }
 237
 238     $chan       ||= "_default";
 239     my @c       = grep /^$chan$/i, keys %chanconf;
 240
 241     if (@c and $c[0] ne $chan) {
 242         &WARN("c ne chan ($c[0] ne $chan)");
 243     }
 244
 245     return $chanconf{$c[0] || "_default"}{$param};
 246 }
 247
 248 sub showProc {
 249     my ($prefix) = $_[0] || "";
 250
 251     if (!open(IN, "/proc/$$/status")) {
 252         &ERROR("cannot open '/proc/$$/status'.");
 253         return;
 254     }
 255
 256     if ($^O eq "linux") {
 257         while (<IN>) {
 258             $memusage = $1 if (/^VmSize:\s+(\d+) kB/);
 259         }
 260         close IN;
 261
 262     } elsif ($^O eq "netbsd") {
 263         $memusage = (stat "/proc/$$/mem")[7]/1024;
 264
 265     } elsif ($^O =~ /^(free|open)bsd$/) {
 266         my @info  = split /\s+/, `/bin/ps -l -p $$`;
 267         $memusage = $info[20];
 268
 269     } else {
 270         $memusage = "UNKNOWN";
 271         return;
 272     }
 273
 274     if (defined $memusageOld and &IsParam("DEBUG")) {
 275         # it's always going to be increase.
 276         my $delta = $memusage - $memusageOld;
 277         my $str;
 278         if ($delta == 0) {
 279             return;
 280         } elsif ($delta > 500) {
 281             $str = "MEM:$prefix increased by $delta kB. (total: $memusage kB)";
 282         } elsif ($delta > 0) {
 283             $str = "MEM:$prefix increased by $delta kB";
 284         } else {        # delta < 0.
 285             $delta = -$delta;
 286             # never knew RSS could decrease, probably Size can't?
 287             $str = "MEM:$prefix decreased by $delta kB. YES YES YES";
 288         }
 289
 290         &status($str);
 291     }
 292     $memusageOld = $memusage;
 293 }
 294
 295 ######
 296 ###### SETUP
 297 ######
 298
 299 sub setup {
 300     &showProc(" (\&openLog before)");
 301     &openLog();         # write, append.
 302     &status("--- Started logging.");
 303
 304     foreach ("debian") {
 305         my $dir = "$bot_base_dir/$_/";
 306         next if ( -d $dir);
 307         &status("Making dir $_");
 308         mkdir $dir, 0755;
 309     }
 310
 311     # read.
 312     &loadLang($bot_misc_dir.            "/blootbot.lang");
 313     &loadIRCServers();
 314     &readUserFile();
 315     &readChanFile();
 316     &loadMyModulesNow();        # must be after chan file.
 317
 318     $shm = &openSHM();
 319     &openSQLDebug()     if (&IsParam("SQLDebug"));
 320     &openDB($param{'DBName'}, $param{'SQLUser'}, $param{'SQLPass'});
 321
 322     &status("Setup: ". &countKeys("factoids") ." factoids.");
 323     &News::readNews() if (&ChanConfList("news"));
 324
 325     $param{tempDir} =~ s#\~/#$ENV{HOME}/#;
 326
 327     &status("Initial memory usage: $memusage kB");
 328 }
 329
 330 sub setupConfig {
 331     $param{'VERBOSITY'} = 1;
 332     &loadConfig($bot_misc_dir."/blootbot.config");
 333
 334     foreach ("ircNick", "ircUser", "ircName", "DBType", "tempDir") {
 335         next if &IsParam($_);
 336         &ERROR("Parameter $_ has not been defined.");
 337         exit 1;
 338     }
 339
 340     if ($param{tempDir} =~ s#\~/#$ENV{HOME}/#) {
 341         &VERB("Fixing up tempDir.",2);
 342     }
 343
 344     if ($param{tempDir} =~ /~/) {
 345         &ERROR("parameter tempDir still contains tilde.");
 346         exit 1;
 347     }
 348
 349     if (! -d $param{tempDir}) {
 350         &status("making $param{tempDir}...");
 351         system("mkdir $param{tempDir}");
 352     }
 353
 354     # static scalar variables.
 355     $file{utm}  = "$bot_base_dir/$param{'ircUser'}.uptime";
 356     $file{PID}  = "$bot_base_dir/$param{'ircUser'}.pid";
 357 }
 358
 359 sub startup {
 360     if (&IsParam("DEBUG")) {
 361         &status("enabling debug diagnostics.");
 362         ### I thought disabling this reduced memory usage by 1000 kB.
 363         use diagnostics;
 364     }
 365
 366     $count{'Question'}  = 0;
 367     $count{'Update'}    = 0;
 368     $count{'Dunno'}     = 0;
 369     $count{'Moron'}     = 0;
 370 }
 371
 372 sub shutdown {
 373     # reverse order of &setup().
 374     &DEBUG("shutdown called.");
 375
 376     # opened files must be written to on shutdown/hup/whatever
 377     # unless they're write-only, like uptime.
 378     &writeUserFile();
 379     &writeChanFile();
 380     &News::writeNews()  if (&ChanConfList("news"));
 381
 382     &closeDB();
 383     &closeSHM($shm);    # aswell. TODO: use this in &doExit?
 384     &closeLog();
 385 }
 386
 387 sub restart {
 388     my ($sig) = @_;
 389
 390     if ($$ == $bot_pid) {
 391         &status("--- $sig called.");
 392
 393         ### crappy bug in Net::IRC?
 394         if (!$conn->connected and time - $msgtime > 900) {
 395             &status("reconnecting because of uncaught disconnect.");
 396 ##          $irc->start;
 397             $conn->connect();
 398             return;
 399         }
 400
 401         &DCCBroadcast("-HUP called.","m");
 402         &shutdown();
 403         &loadConfig($bot_misc_dir."/blootbot.config");
 404         &reloadAllModules() if (&IsParam("DEBUG"));
 405         &setup();
 406
 407         &status("--- End of $sig.");
 408     } else {
 409         &status("$sig called; ignoring restart.");
 410     }
 411 }
 412
 413 # File: Configuration.
 414 sub loadConfig {
 415     my ($file) = @_;
 416
 417     if (!open(FILE, $file)) {
 418         &ERROR("FAILED loadConfig ($file): $!");
 419         &status("Please copy files/sample.config to files/blootbot.config");
 420         &status("  and edit files/blootbot.config, modify to tastes.");
 421         exit 0;
 422     }
 423
 424     my $count = 0;
 425     while (<FILE>) {
 426         chomp;
 427         next if /^\s*\#/;
 428         next unless /\S/;
 429         my ($set,$key,$val) = split(/\s+/, $_, 3);
 430
 431         if ($set ne "set") {
 432             &status("loadConfig: invalid line '$_'.");
 433             next;
 434         }
 435
 436         # perform variable interpolation
 437         $val =~ s/(\$(\w+))/$param{$2}/g;
 438
 439         $param{$key} = $val;
 440
 441         ++$count;
 442     }
 443     close FILE;
 444
 445     $file =~ s/^.*\///;
 446     &status("Loaded config $file ($count items)");
 447 }
 448
 449 1;