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 ### CHANGE TO STATIC.
  59 $bot_version = "blootbot cvs (20001212) -- $^O";
  60 $noreply        = "NOREPLY";
  61
  62 ##########
  63 ### misc commands.
  64 ###
  65
  66 sub doExit {
  67     my ($sig)   = @_;
  68
  69     if (defined $flag_quit) {
  70         &WARN("doExit: quit already called.");
  71         return;
  72     }
  73     $flag_quit  = 1;
  74
  75     if (!defined $bot_pid) {    # independent.
  76         exit 0;
  77     } elsif ($bot_pid == $$) {  # parent.
  78         &status("parent caught SIG$sig (pid $$).") if (defined $sig);
  79
  80         &status("--- Start of quit.");
  81
  82         &closeDCC();
  83         &closePID();
  84         &seenFlush();
  85         &quit($param{'quitMsg'}) if (&whatInterface() =~ /IRC/);
  86         &writeUserFile();
  87         &writeChanFile();
  88         &uptimeWriteFile()      if (&ChanConfList("uptime"));
  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     ### TODO: -option is included aswell though.
 135     return keys %chan;
 136 }
 137
 138 #####
 139 #  Usage: &getChanConfList($param)
 140 #  About: gets channels with 'param' enabled, internal use only.
 141 # Return: hash of channels
 142 sub getChanConfList {
 143     my $param   = $_[0];
 144     my %chan;
 145
 146     return unless (defined $param);
 147
 148     foreach (keys %chanconf) {
 149         my $chan        = $_;
 150 #       &DEBUG("chan => $chan");
 151         my @array       = grep /^$param$/, keys %{ $chanconf{$chan} };
 152
 153         next unless (scalar @array);
 154
 155         if (scalar @array > 1) {
 156             &WARN("multiple items found?");
 157         }
 158
 159         if ($array[0] eq "0") {
 160             $chan{$chan}        = -1;
 161         } else {
 162             $chan{$chan}        =  1;
 163         }
 164     }
 165
 166     return %chan;
 167 }
 168
 169 #####
 170 #  Usage: &IsChanConf($param);
 171 #  About: Check for 'param' on the basis of channel config.
 172 # Return: 1 for enabled, 0 for passive disable, -1 for active disable.
 173 sub IsChanConf {
 174     my($param)  = shift;
 175
 176     if (!defined $param) {
 177         &WARN("param == NULL.");
 178         return 0;
 179     }
 180
 181     ### TODO: VERBOSITY on how chanconf returned 1 or 0 or -1.
 182     my %chan    = &getChanConfList($param);
 183     if (!defined $msgType) {
 184         return $chan{_default} || 0;
 185     }
 186
 187     if ($msgType eq "public") {
 188         return $chan{lc $chan} || $chan{_default} || 0;
 189     }
 190
 191     if ($msgType eq "private") {
 192         return $chan{_default} || 0;
 193     }
 194
 195 ### debug purposes only.
 196 #    &DEBUG("param => $param, msgType => $msgType.");
 197 #    foreach (keys %chan) {
 198 #       &DEBUG("   $_ => $chan{$_}");
 199 #    }
 200
 201     return 0;
 202 }
 203
 204 #####
 205 #  Usage: &getChanConf($param);
 206 #  About: Retrieve value for 'param' value in current/default chan.
 207 # Return: scalar for success, undef for failure.
 208 sub getChanConf {
 209     my($param,$chan)    = @_;
 210
 211     if (!defined $param) {
 212         &WARN("param == NULL.");
 213         return 0;
 214     }
 215
 216     $chan       ||= "_default";
 217     my @c       = grep /^$chan$/i, keys %chanconf;
 218
 219     if (@c and $c[0] ne $chan) {
 220         &WARN("c ne chan ($c[0] ne $chan)");
 221     }
 222
 223     return $chanconf{$c[0] || "_default"}{$param};
 224 }
 225
 226 sub showProc {
 227     my ($prefix) = $_[0] || "";
 228
 229     if (!open(IN, "/proc/$$/status")) {
 230         &ERROR("cannot open '/proc/$$/status'.");
 231         return;
 232     }
 233
 234     if ($^O eq "linux") {
 235         while (<IN>) {
 236             $memusage = $1 if (/^VmSize:\s+(\d+) kB/);
 237         }
 238         close IN;
 239
 240         if (defined $memusageOld and &IsParam("DEBUG")) {
 241             # it's always going to be increase.
 242             my $delta = $memusage - $memusageOld;
 243             my $str;
 244             if ($delta == 0) {
 245                 return;
 246             } elsif ($delta > 500) {
 247                 $str = "MEM:$prefix increased by $delta kB. (total: $memusage kB)";
 248             } elsif ($delta > 0) {
 249                 $str = "MEM:$prefix increased by $delta kB";
 250             } else {    # delta < 0.
 251                 $delta = -$delta;
 252                 # never knew RSS could decrease, probably Size can't?
 253                 $str = "MEM:$prefix decreased by $delta kB. YES YES YES";
 254             }
 255
 256             &status($str);
 257         }
 258         $memusageOld = $memusage;
 259     } else {
 260         $memusage = "UNKNOWN";
 261     }
 262     ### TODO: FreeBSD/*BSD support.
 263 }
 264
 265 ######
 266 ###### SETUP
 267 ######
 268
 269 sub setup {
 270     &showProc(" (\&openLog before)");
 271     &openLog();         # write, append.
 272     &status("--- Started logging.");
 273
 274     foreach ("debian") {
 275         my $dir = "$bot_base_dir/$_/";
 276         next if ( -d $dir);
 277         &status("Making dir $_");
 278         mkdir $dir, 0755;
 279     }
 280
 281     # read.
 282     &loadLang($bot_misc_dir.            "/blootbot.lang");
 283     &loadIRCServers($bot_misc_dir.      "/ircII.servers");
 284     &readUserFile();
 285     &readChanFile();
 286     &loadMyModulesNow();        # must be after chan file.
 287
 288     $shm = &openSHM();
 289     &openSQLDebug()     if (&IsParam("SQLDebug"));
 290     &openDB($param{'DBName'}, $param{'SQLUser'}, $param{'SQLPass'});
 291
 292     &status("Setup: ". &countKeys("factoids") ." factoids.");
 293
 294     $param{tempDir} =~ s#\~/#$ENV{HOME}/#;
 295
 296     &status("Initial memory usage: $memusage kB");
 297 }
 298
 299 sub setupConfig {
 300     $param{'VERBOSITY'} = 1;
 301     &loadConfig($bot_misc_dir."/blootbot.config");
 302
 303     foreach ("ircNick", "ircUser", "ircName", "DBType", "tempDir") {
 304         next if &IsParam($_);
 305         &ERROR("Parameter $_ has not been defined.");
 306         exit 1;
 307     }
 308
 309     if ($param{tempDir} =~ s#\~/#$ENV{HOME}/#) {
 310         &VERB("Fixing up tempDir.",2);
 311     }
 312
 313     if ($param{tempDir} =~ /~/) {
 314         &ERROR("parameter tempDir still contains tilde.");
 315         exit 1;
 316     }
 317
 318     if (! -d $param{tempDir}) {
 319         &status("making $param{tempDir}...");
 320         system("mkdir $param{tempDir}");
 321     }
 322
 323     # static scalar variables.
 324     $file{utm}  = "$bot_base_dir/$param{'ircUser'}.uptime";
 325     $file{PID}  = "$bot_base_dir/$param{'ircUser'}.pid";
 326 }
 327
 328 sub startup {
 329     if (&IsParam("DEBUG")) {
 330         &status("enabling debug diagnostics.");
 331         ### I thought disabling this reduced memory usage by 1000 kB.
 332         use diagnostics;
 333     }
 334
 335     $count{'Question'}  = 0;
 336     $count{'Update'}    = 0;
 337     $count{'Dunno'}     = 0;
 338     $count{'Moron'}     = 0;
 339 }
 340
 341 sub shutdown {
 342     # reverse order of &setup().
 343     &DEBUG("shutdown called.");
 344
 345     &closeDB();
 346     &closeSHM($shm);    # aswell. TODO: use this in &doExit?
 347     &closeLog();
 348     ### is this valid?
 349     &writeUserFile();
 350     &writeChanFile();
 351 }
 352
 353 sub restart {
 354     my ($sig) = @_;
 355
 356     if ($$ == $bot_pid) {
 357         &status("--- $sig called.");
 358
 359         ### crappy bug in Net::IRC?
 360         if (!$conn->connected and time - $msgtime > 900) {
 361             &status("reconnecting because of uncaught disconnect.");
 362 ##          $irc->start;
 363             $conn->connect();
 364             return;
 365         }
 366
 367         &DCCBroadcast("-HUP called.","m");
 368         &shutdown();
 369         &loadConfig($bot_misc_dir."/blootbot.config");
 370         &reloadAllModules() if (&IsParam("DEBUG"));
 371         &setup();
 372
 373         &status("--- End of $sig.");
 374     } else {
 375         &status("$sig called; ignoring restart.");
 376     }
 377 }
 378
 379 # File: Configuration.
 380 sub loadConfig {
 381     my ($file) = @_;
 382
 383     if (!open(FILE, $file)) {
 384         &ERROR("FAILED loadConfig ($file): $!");
 385         &status("Please copy files/sample.config to files/blootbot.config");
 386         &status("  and edit files/blootbot.config, modify to tastes.");
 387         exit 0;
 388     }
 389
 390     my $count = 0;
 391     while (<FILE>) {
 392         chomp;
 393         next if /^\s*\#/;
 394         next unless /\S/;
 395         my ($set,$key,$val) = split(/\s+/, $_, 3);
 396
 397         if ($set ne "set") {
 398             &status("loadConfig: invalid line '$_'.");
 399             next;
 400         }
 401
 402         # perform variable interpolation
 403         $val =~ s/(\$(\w+))/$param{$2}/g;
 404
 405         $param{$key} = $val;
 406
 407         ++$count;
 408     }
 409     close FILE;
 410
 411     $file =~ s/^.*\///;
 412     &status("Loaded config $file ($count items)");
 413 }
 414
 415 1;