perl/cluster.pl

   1 #!/usr/bin/perl -w
   2 #
   3 # This is the DX cluster 'daemon'. It sits in the middle of its little
   4 # web of client routines sucking and blowing data where it may.
   5 #
   6 # Hence the name of 'spider' (although it may become 'dxspider')
   7 #
   8 # Copyright (c) 1998 Dirk Koopman G1TLH
   9 #
  10 # $Id$
  11 #
  12
  13 require 5.004;
  14
  15 # make sure that modules are searched in the order local then perl
  16 BEGIN {
  17         umask 002;
  18
  19         # root of directory tree for this system
  20         $root = "/spider";
  21         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
  22
  23         unshift @INC, "$root/perl";     # this IS the right way round!
  24         unshift @INC, "$root/local";
  25
  26         # try to create and lock a lockfile (this isn't atomic but
  27         # should do for now
  28         my $lockfn = "$root/perl/cluster.lock";       # lock file name
  29         if (-e $lockfn) {
  30                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
  31                 my $pid = <CLLOCK>;
  32                 chomp $pid;
  33                 die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
  34                 close CLLOCK;
  35         }
  36         open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
  37         print CLLOCK "$$\n";
  38         close CLLOCK;
  39 }
  40
  41 use Msg;
  42 use IntMsg;
  43 use ExtMsg;
  44 use DXVars;
  45 use DXDebug;
  46 use DXLog;
  47 use DXLogPrint;
  48 use DXUtil;
  49 use DXChannel;
  50 use DXUser;
  51 use DXM;
  52 use DXCommandmode;
  53 use DXProt;
  54 use DXMsg;
  55 use DXCluster;
  56 use DXCron;
  57 use DXConnect;
  58 use Prefix;
  59 use Bands;
  60 use Geomag;
  61 use CmdAlias;
  62 use Filter;
  63 use DXDb;
  64 use AnnTalk;
  65 use WCY;
  66 use DXDupe;
  67 use BadWords;
  68
  69 use Data::Dumper;
  70 use Fcntl ':flock';
  71 use POSIX ":sys_wait_h";
  72
  73 use Local;
  74
  75 package main;
  76
  77 #use strict;
  78 #use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects $zombies $root
  79 #                  $lang $myalias @debug $userfn $clusteraddr $clusterport $mycall $decease );
  80
  81 @inqueue = ();                                  # the main input queue, an array of hashes
  82 $systime = 0;                                   # the time now (in seconds)
  83 $version = "1.47";                              # the version no of the software
  84 $starttime = 0;                 # the starting time of the cluster
  85 $lockfn = "cluster.lock";       # lock file name
  86 @outstanding_connects = ();     # list of outstanding connects
  87 @listeners = ();                                # list of listeners
  88
  89
  90 # send a message to call on conn and disconnect
  91 sub already_conn
  92 {
  93         my ($conn, $call, $mess) = @_;
  94
  95         dbg('chan', "-> D $call $mess\n");
  96         $conn->send_now("D$call|$mess");
  97         sleep(1);
  98         dbg('chan', "-> Z $call bye\n");
  99         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
 100         sleep(1);
 101         $conn->disconnect;
 102 }
 103
 104 # handle incoming messages
 105 sub rec
 106 {
 107         my ($conn, $msg, $err) = @_;
 108         my $dxchan = DXChannel->get_by_cnum($conn); # get the dxconnnect object for this message
 109
 110         if (!defined $msg || (defined $err && $err)) {
 111                 if ($dxchan) {
 112                         if (defined $err) {
 113                                 $conn->disconnect;
 114                                 undef $conn;
 115                                 $dxchan->conn(undef);
 116                         }
 117                         $dxchan->disconnect;
 118                 } elsif ($conn) {
 119                         $conn->disconnect;
 120                 }
 121                 return;
 122         }
 123
 124         # set up the basic channel info - this needs a bit more thought - there is duplication here
 125         if (!defined $dxchan) {
 126                 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
 127                 return unless defined $sort;
 128
 129                 # is there one already connected to me - locally?
 130                 my $user = DXUser->get($call);
 131                 if (DXChannel->get($call)) {
 132                         my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call, $main::mycall);
 133                         already_conn($conn, $call, $mess);
 134                         return;
 135                 }
 136
 137                 # is there one already connected elsewhere in the cluster?
 138                 if ($user) {
 139                         if (($user->is_node || $call eq $myalias) && !DXCluster->get_exact($call)) {
 140                                 ;
 141                         } else {
 142                                 if (my $ref = DXCluster->get_exact($call)) {
 143                                         my $mess = DXM::msg($lang, 'concluster', $call, $ref->mynode->call);
 144                                         already_conn($conn, $call, $mess);
 145                                         return;
 146                                 }
 147                         }
 148                         $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
 149                 } else {
 150                         if (my $ref = DXCluster->get_exact($call)) {
 151                                 my $mess = DXM::msg($lang, 'concluster', $call, $ref->mynode->call);
 152                                 already_conn($conn, $call, $mess);
 153                                 return;
 154                         }
 155                         $user = DXUser->new($call);
 156                 }
 157
 158                 # is he locked out ?
 159                 if ($user->lockout) {
 160                         Log('DXCommand', "$call is locked out, disconnected");
 161                         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
 162                         $conn->disconect;
 163                         return;
 164                 }
 165
 166                 # create the channel
 167                 $dxchan = DXCommandmode->new($call, $conn, $user) if $user->is_user;
 168                 $dxchan = DXProt->new($call, $conn, $user) if $user->is_node;
 169                 $dxchan = BBS->new($call, $conn, $user) if $user->is_bbs;
 170                 die "Invalid sort of user on $call = $sort" if !$dxchan;
 171         }
 172
 173         # queue the message and the channel object for later processing
 174         if (defined $msg) {
 175                 my $self = bless {}, "inqueue";
 176                 $self->{dxchan} = $dxchan;
 177                 $self->{data} = $msg;
 178                 push @inqueue, $self;
 179         }
 180 }
 181
 182 sub login
 183 {
 184         return \&rec;
 185 }
 186
 187 # cease running this program, close down all the connections nicely
 188 sub cease
 189 {
 190         my $dxchan;
 191
 192         $SIG{'TERM'} = 'IGNORE';
 193         $SIG{'INT'} = 'IGNORE';
 194
 195         DXUser::sync;
 196
 197         eval {
 198                 Local::finish();   # end local processing
 199         };
 200         dbg('local', "Local::finish error $@") if $@;
 201
 202         # disconnect nodes
 203         foreach $dxchan (DXChannel->get_all()) {
 204                 next unless $dxchan->is_node;
 205             $dxchan->disconnect unless $dxchan == $DXProt::me;
 206         }
 207         Msg->event_loop(1, 0.05);
 208         Msg->event_loop(1, 0.05);
 209
 210         # disconnect users
 211         foreach $dxchan (DXChannel->get_all()) {
 212                 next if $dxchan->is_node;
 213                 $dxchan->disconnect unless $dxchan == $DXProt::me;
 214         }
 215         Msg->event_loop(1, 0.05);
 216         Msg->event_loop(1, 0.05);
 217         Msg->event_loop(1, 0.05);
 218         Msg->event_loop(1, 0.05);
 219         Msg->event_loop(1, 0.05);
 220         Msg->event_loop(1, 0.05);
 221         DXUser::finish();
 222         DXDupe::finish();
 223
 224         # close all databases
 225         DXDb::closeall;
 226
 227         # close all listeners
 228         for (@listeners) {
 229                 $_->close_server;
 230         }
 231
 232         dbg('chan', "DXSpider version $version ended");
 233         Log('cluster', "DXSpider V$version stopped");
 234         dbgclose();
 235         Logclose();
 236         unlink $lockfn;
 237 #       $SIG{__WARN__} = $SIG{__DIE__} =  sub {my $a = shift; cluck($a); };
 238         exit(0);
 239 }
 240
 241 # the reaper of children
 242 sub reap
 243 {
 244         my $cpid;
 245         while (($cpid = waitpid(-1, WNOHANG)) > 0) {
 246                 dbg('reap', "cpid: $cpid");
 247                 @outstanding_connects = grep {$_->{pid} != $cpid} @outstanding_connects;
 248                 $zombies-- if $zombies > 0;
 249         }
 250         dbg('reap', "cpid: $cpid");
 251 }
 252
 253 # this is where the input queue is dealt with and things are dispatched off to other parts of
 254 # the cluster
 255 sub process_inqueue
 256 {
 257         my $self = shift @inqueue;
 258         return if !$self;
 259
 260         my $data = $self->{data};
 261         my $dxchan = $self->{dxchan};
 262         my $error;
 263         my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
 264         return unless defined $sort;
 265
 266         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
 267         dbg('chan', "<- $sort $call $line\n") unless $sort eq 'D';
 268
 269         # handle A records
 270         my $user = $dxchan->user;
 271         if ($sort eq 'A' || $sort eq 'O') {
 272                 $dxchan->start($line, $sort);
 273         } elsif ($sort eq 'I') {
 274                 die "\$user not defined for $call" if !defined $user;
 275                 # normal input
 276                 $dxchan->normal($line);
 277                 $dxchan->disconnect if ($dxchan->{state} eq 'bye');
 278         } elsif ($sort eq 'Z') {
 279                 $dxchan->conn(undef);
 280                 $dxchan->disconnect;
 281         } elsif ($sort eq 'D') {
 282                 ;                       # ignored (an echo)
 283         } else {
 284                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
 285         }
 286 }
 287
 288 sub uptime
 289 {
 290         my $t = $systime - $starttime;
 291         my $days = int $t / 86400;
 292         $t -= $days * 86400;
 293         my $hours = int $t / 3600;
 294         $t -= $hours * 3600;
 295         my $mins = int $t / 60;
 296         return sprintf "%d %02d:%02d", $days, $hours, $mins;
 297 }
 298 #############################################################
 299 #
 300 # The start of the main line of code
 301 #
 302 #############################################################
 303
 304 $starttime = $systime = time;
 305 $lang = 'en' unless $lang;
 306
 307 # open the debug file, set various FHs to be unbuffered
 308 dbginit();
 309 foreach (@debug) {
 310         dbgadd($_);
 311 }
 312 STDOUT->autoflush(1);
 313
 314 Log('cluster', "DXSpider V$version started");
 315
 316 # banner
 317 dbg('err', "DXSpider DX Cluster Version $version", "Copyright (c) 1998-2001 Dirk Koopman G1TLH");
 318
 319 # load Prefixes
 320 dbg('err', "loading prefixes ...");
 321 Prefix::load();
 322
 323 # load band data
 324 dbg('err', "loading band data ...");
 325 Bands::load();
 326
 327 # initialise User file system
 328 dbg('err', "loading user file system ...");
 329 DXUser->init($userfn, 1);
 330
 331 # start listening for incoming messages/connects
 332 use Listeners;
 333
 334 dbg('err', "starting listeners ...");
 335 push @listeners, IntMsg->new_server("$clusteraddr", $clusterport, \&login);
 336 dbg('err', "Internal port: $clusteraddr $clusterport");
 337 for (@main::listen) {
 338         push @listeners, ExtMsg->new_server($_->[0], $_->[1], \&login);
 339         dbg('err', "External Port: $_->[0] $_->[1]");
 340 }
 341
 342 # load bad words
 343 dbg('err', "load badwords: " . (BadWords::load or "Ok"));
 344
 345 # prime some signals
 346 unless ($^O =~ /^MS/) {
 347         unless ($DB::VERSION) {
 348                 $SIG{INT} = \&cease;
 349                 $SIG{TERM} = \&cease;
 350         }
 351         $SIG{HUP} = 'IGNORE';
 352         $SIG{CHLD} = sub { $zombies++ };
 353
 354         $SIG{PIPE} = sub {      dbg('err', "Broken PIPE signal received"); };
 355         $SIG{IO} = sub {        dbg('err', "SIGIO received"); };
 356         $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
 357         $SIG{KILL} = 'DEFAULT';     # as if it matters....
 358
 359         # catch the rest with a hopeful message
 360         for (keys %SIG) {
 361                 if (!$SIG{$_}) {
 362                         #               dbg('chan', "Catching SIG $_");
 363                         $SIG{$_} = sub { my $sig = shift;       DXDebug::confess("Caught signal $sig");  };
 364                 }
 365         }
 366 }
 367
 368 # start dupe system
 369 DXDupe::init();
 370
 371 # read in system messages
 372 DXM->init();
 373
 374 # read in command aliases
 375 CmdAlias->init();
 376
 377 # initialise the Geomagnetic data engine
 378 Geomag->init();
 379 WCY->init();
 380
 381 # initial the Spot stuff
 382 Spot->init();
 383
 384 # initialise the protocol engine
 385 dbg('err', "reading in duplicate spot and WWV info ...");
 386 DXProt->init();
 387
 388 # put in a DXCluster node for us here so we can add users and take them away
 389 DXNode->new($DXProt::me, $mycall, 0, 1, $DXProt::myprot_version);
 390
 391 # read in any existing message headers and clean out old crap
 392 dbg('err', "reading existing message headers ...");
 393 DXMsg->init();
 394 DXMsg::clean_old();
 395
 396 # read in any cron jobs
 397 dbg('err', "reading cron jobs ...");
 398 DXCron->init();
 399
 400 # read in database descriptors
 401 dbg('err', "reading database descriptors ...");
 402 DXDb::load();
 403
 404 # starting local stuff
 405 dbg('err', "doing local initialisation ...");
 406 eval {
 407         Local::init();
 408 };
 409 dbg('local', "Local::init error $@") if $@;
 410
 411 # print various flags
 412 #dbg('err', "seful info - \$^D: $^D \$^W: $^W \$^S: $^S \$^P: $^P");
 413
 414 # this, such as it is, is the main loop!
 415 dbg('err', "orft we jolly well go ...");
 416
 417 #open(DB::OUT, "|tee /tmp/aa");
 418
 419 for (;;) {
 420 #       $DB::trace = 1;
 421
 422         Msg->event_loop(1, 0.1);
 423         my $timenow = time;
 424         process_inqueue();                      # read in lines from the input queue and despatch them
 425 #       $DB::trace = 0;
 426
 427         # do timed stuff, ongoing processing happens one a second
 428         if ($timenow != $systime) {
 429                 reap if $zombies;
 430                 $systime = $timenow;
 431                 DXCron::process();      # do cron jobs
 432                 DXCommandmode::process(); # process ongoing command mode stuff
 433                 DXProt::process();              # process ongoing ak1a pcxx stuff
 434                 DXConnect::process();
 435                 DXMsg::process();
 436                 DXDb::process();
 437                 DXUser::process();
 438                 DXDupe::process();
 439
 440                 eval {
 441                         Local::process();       # do any localised processing
 442                 };
 443                 dbg('local', "Local::process error $@") if $@;
 444         }
 445         if ($decease) {
 446                 last if --$decease <= 0;
 447         }
 448 }
 449 cease(0);
 450 exit(0);
 451
 452