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         $lockfn = "$root/perl/cluster.lck";       # 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         $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
  41         $systime = time;
  42 }
  43
  44 use DXVars;
  45 use Msg;
  46 use IntMsg;
  47 use Internet;
  48 use Listeners;
  49 use ExtMsg;
  50 use AGWConnect;
  51 use AGWMsg;
  52 use DXDebug;
  53 use DXLog;
  54 use DXLogPrint;
  55 use DXUtil;
  56 use DXChannel;
  57 use DXUser;
  58 use DXM;
  59 use DXCommandmode;
  60 use DXProtVars;
  61 use DXProtout;
  62 use DXProt;
  63 use DXMsg;
  64 use DXCron;
  65 use DXConnect;
  66 use DXBearing;
  67 use DXDb;
  68 use DXHash;
  69 use DXDupe;
  70 use Prefix;
  71 use Spot;
  72 use Bands;
  73 use Keps;
  74 use Minimuf;
  75 use Sun;
  76 use Geomag;
  77 use CmdAlias;
  78 use Filter;
  79 use AnnTalk;
  80 use BBS;
  81 use WCY;
  82 use BadWords;
  83 use Timer;
  84 use Route;
  85 use Route::Node;
  86 use Route::User;
  87
  88 use Data::Dumper;
  89 use IO::File;
  90 use Fcntl ':flock';
  91 use POSIX ":sys_wait_h";
  92
  93 use Local;
  94
  95 package main;
  96
  97 use strict;
  98 use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects
  99                         $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
 100                         $clusterport $mycall $decease $build $is_win $routeroot
 101                    );
 102
 103 @inqueue = ();                                  # the main input queue, an array of hashes
 104 $systime = 0;                                   # the time now (in seconds)
 105 $version = "1.48";                              # the version no of the software
 106 $starttime = 0;                 # the starting time of the cluster
 107 #@outstanding_connects = ();     # list of outstanding connects
 108 @listeners = ();                                # list of listeners
 109
 110
 111 # send a message to call on conn and disconnect
 112 sub already_conn
 113 {
 114         my ($conn, $call, $mess) = @_;
 115
 116         $conn->disable_read(1);
 117         dbg('chan', "-> D $call $mess\n");
 118         $conn->send_now("D$call|$mess");
 119         sleep(2);
 120         $conn->disconnect;
 121 }
 122
 123 sub error_handler
 124 {
 125         my $dxchan = shift;
 126         $dxchan->{conn}->set_error(undef) if exists $dxchan->{conn};
 127         $dxchan->disconnect(1);
 128 }
 129
 130 # handle incoming messages
 131 sub new_channel
 132 {
 133         my ($conn, $msg) = @_;
 134         my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
 135         return unless defined $sort;
 136
 137         # set up the basic channel info
 138         # is there one already connected to me - locally?
 139         my $user = DXUser->get($call);
 140         my $dxchan = DXChannel->get($call);
 141         if ($dxchan) {
 142                 my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call, $main::mycall);
 143                 already_conn($conn, $call, $mess);
 144                 return;
 145         }
 146
 147         if ($user) {
 148                 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
 149         } else {
 150                 $user = DXUser->new($call);
 151         }
 152
 153         # is he locked out ?
 154         if ($user->lockout) {
 155                 Log('DXCommand', "$call is locked out, disconnected");
 156                 $conn->disconnect;
 157                 return;
 158         }
 159
 160         # create the channel
 161         $dxchan = DXCommandmode->new($call, $conn, $user) if $user->is_user;
 162         $dxchan = DXProt->new($call, $conn, $user) if $user->is_node;
 163         $dxchan = BBS->new($call, $conn, $user) if $user->is_bbs;
 164         die "Invalid sort of user on $call = $sort" if !$dxchan;
 165
 166         # check that the conn has a callsign
 167         $conn->conns($call) if $conn->isa('IntMsg');
 168
 169         # set callbacks
 170         $conn->set_error(sub {error_handler($dxchan)});
 171         $conn->set_rproc(sub {my ($conn,$msg) = @_; rec($dxchan, $conn, $msg);});
 172         rec($dxchan, $conn, $msg);
 173 }
 174
 175 sub rec
 176 {
 177         my ($dxchan, $conn, $msg) = @_;
 178
 179         # queue the message and the channel object for later processing
 180         if (defined $msg) {
 181                 my $self = bless {}, "inqueue";
 182                 $self->{dxchan} = $dxchan;
 183                 $self->{data} = $msg;
 184                 push @inqueue, $self;
 185         }
 186 }
 187
 188 sub login
 189 {
 190         return \&new_channel;
 191 }
 192
 193 # cease running this program, close down all the connections nicely
 194 sub cease
 195 {
 196         my $dxchan;
 197
 198         unless ($is_win) {
 199                 $SIG{'TERM'} = 'IGNORE';
 200                 $SIG{'INT'} = 'IGNORE';
 201         }
 202
 203         DXUser::sync;
 204
 205         eval {
 206                 Local::finish();   # end local processing
 207         };
 208         dbg('local', "Local::finish error $@") if $@;
 209
 210         # disconnect nodes
 211         foreach $dxchan (DXChannel->get_all_nodes) {
 212             $dxchan->disconnect(2) unless $dxchan == $DXProt::me;
 213         }
 214         Msg->event_loop(100, 0.01);
 215
 216         # disconnect users
 217         foreach $dxchan (DXChannel->get_all_users) {
 218                 $dxchan->disconnect;
 219         }
 220
 221         # disconnect AGW
 222         AGWMsg::finish();
 223
 224         # end everything else
 225         Msg->event_loop(100, 0.01);
 226         DXUser::finish();
 227         DXDupe::finish();
 228
 229         # close all databases
 230         DXDb::closeall;
 231
 232         # close all listeners
 233         foreach my $l (@listeners) {
 234                 $l->close_server;
 235         }
 236
 237         dbg('chan', "DXSpider version $version, build $build ended");
 238         Log('cluster', "DXSpider V$version, build $build ended");
 239         dbgclose();
 240         Logclose();
 241         unlink $lockfn;
 242 #       $SIG{__WARN__} = $SIG{__DIE__} =  sub {my $a = shift; cluck($a); };
 243         exit(0);
 244 }
 245
 246 # the reaper of children
 247 sub reap
 248 {
 249         my $cpid;
 250         while (($cpid = waitpid(-1, WNOHANG)) > 0) {
 251                 dbg('reap', "cpid: $cpid");
 252 #               Msg->pid_gone($cpid);
 253                 $zombies-- if $zombies > 0;
 254         }
 255         dbg('reap', "cpid: $cpid");
 256 }
 257
 258 # this is where the input queue is dealt with and things are dispatched off to other parts of
 259 # the cluster
 260 sub process_inqueue
 261 {
 262         my $self = shift @inqueue;
 263         return if !$self;
 264
 265         my $data = $self->{data};
 266         my $dxchan = $self->{dxchan};
 267         my $error;
 268         my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
 269         return unless defined $sort;
 270
 271         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
 272         dbg('chan', "<- $sort $call $line\n") unless $sort eq 'D';
 273
 274         # handle A records
 275         my $user = $dxchan->user;
 276         if ($sort eq 'A' || $sort eq 'O') {
 277                 $dxchan->start($line, $sort);
 278         } elsif ($sort eq 'I') {
 279                 die "\$user not defined for $call" if !defined $user;
 280                 # normal input
 281                 $dxchan->normal($line);
 282                 $dxchan->disconnect if ($dxchan->{state} eq 'bye');
 283         } elsif ($sort eq 'Z') {
 284                 $dxchan->disconnect;
 285         } elsif ($sort eq 'D') {
 286                 ;                       # ignored (an echo)
 287         } else {
 288                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
 289         }
 290 }
 291
 292 sub uptime
 293 {
 294         my $t = $systime - $starttime;
 295         my $days = int $t / 86400;
 296         $t -= $days * 86400;
 297         my $hours = int $t / 3600;
 298         $t -= $hours * 3600;
 299         my $mins = int $t / 60;
 300         return sprintf "%d %02d:%02d", $days, $hours, $mins;
 301 }
 302
 303 sub AGWrestart
 304 {
 305         AGWMsg::init(\&new_channel);
 306 }
 307
 308 #############################################################
 309 #
 310 # The start of the main line of code
 311 #
 312 #############################################################
 313
 314 $starttime = $systime = time;
 315 $lang = 'en' unless $lang;
 316
 317 # open the debug file, set various FHs to be unbuffered
 318 dbginit();
 319 foreach (@debug) {
 320         dbgadd($_);
 321 }
 322 STDOUT->autoflush(1);
 323
 324 # calculate build number
 325 $build = $main::version;
 326
 327 my @fn;
 328 open(CL, "$main::root/perl/cluster.pl") or die "Cannot open cluster.pl $!";
 329 while (<CL>) {
 330         next unless /^use\s+([\w:_]+)/;
 331         push @fn, $1;
 332 }
 333 close CL;
 334 my $subbuild;
 335 foreach my $fn (@fn) {
 336         $fn =~ s|::|/|g;
 337         open(CL, "$main::root/perl/${fn}.pm") or next;
 338         while (<CL>) {
 339                 if (/^#\s+\$Id:\s+[\w\._]+,v\s+(\d+\.\d+)\.?(\d+.\d+)?/ ) {
 340                         $build += $1;
 341                         $subbuild += $2 if $2;
 342                         last;
 343                 }
 344         }
 345         close CL;
 346 }
 347 $build = "$build.$subbuild" if $subbuild;
 348
 349 Log('cluster', "DXSpider V$version, build $build started");
 350
 351 # banner
 352 dbg('err', "DXSpider Version $version, build $build started", "Copyright (c) 1998-2001 Dirk Koopman G1TLH");
 353
 354 # load Prefixes
 355 dbg('err', "loading prefixes ...");
 356 Prefix::load();
 357
 358 # load band data
 359 dbg('err', "loading band data ...");
 360 Bands::load();
 361
 362 # initialise User file system
 363 dbg('err', "loading user file system ...");
 364 DXUser->init($userfn, 1);
 365
 366 # start listening for incoming messages/connects
 367 dbg('err', "starting listeners ...");
 368 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
 369 $conn->conns("Server $clusteraddr/$clusterport");
 370 push @listeners, $conn;
 371 dbg('err', "Internal port: $clusteraddr $clusterport");
 372 foreach my $l (@main::listen) {
 373         $conn = ExtMsg->new_server($l->[0], $l->[1], \&login);
 374         $conn->conns("Server $l->[0]/$l->[1]");
 375         push @listeners, $conn;
 376         dbg('err', "External Port: $l->[0] $l->[1]");
 377 }
 378 AGWrestart();
 379
 380 # load bad words
 381 dbg('err', "load badwords: " . (BadWords::load or "Ok"));
 382
 383 # prime some signals
 384 unless ($DB::VERSION) {
 385         $SIG{INT} = $SIG{TERM} = sub { $decease = 1 };
 386 }
 387
 388 unless ($is_win) {
 389         $SIG{HUP} = 'IGNORE';
 390         $SIG{CHLD} = sub { $zombies++ };
 391
 392         $SIG{PIPE} = sub {      dbg('err', "Broken PIPE signal received"); };
 393         $SIG{IO} = sub {        dbg('err', "SIGIO received"); };
 394         $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
 395         $SIG{KILL} = 'DEFAULT';     # as if it matters....
 396
 397         # catch the rest with a hopeful message
 398         for (keys %SIG) {
 399                 if (!$SIG{$_}) {
 400                         #               dbg('chan', "Catching SIG $_");
 401                         $SIG{$_} = sub { my $sig = shift;       DXDebug::confess("Caught signal $sig");  };
 402                 }
 403         }
 404 }
 405
 406 # start dupe system
 407 DXDupe::init();
 408
 409 # read in system messages
 410 DXM->init();
 411
 412 # read in command aliases
 413 CmdAlias->init();
 414
 415 # initialise the Geomagnetic data engine
 416 Geomag->init();
 417 WCY->init();
 418
 419 # initial the Spot stuff
 420 Spot->init();
 421
 422 # initialise the protocol engine
 423 dbg('err', "reading in duplicate spot and WWV info ...");
 424 DXProt->init();
 425
 426 # put in a DXCluster node for us here so we can add users and take them away
 427 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($DXProt::me->here)|Route::conf($DXProt::me->conf));
 428
 429 # make sure that there is a routing OUTPUT node default file
 430 unless (Filter::read_in('route', 'node_default', 0)) {
 431         my $dxcc = $DXProt::me->dxcc;
 432         $Route::filterdef->cmd($DXProt::me, 'route', 'accept', "node_default call $mycall" );
 433 }
 434
 435 # read in any existing message headers and clean out old crap
 436 dbg('err', "reading existing message headers ...");
 437 DXMsg->init();
 438 DXMsg::clean_old();
 439
 440 # read in any cron jobs
 441 dbg('err', "reading cron jobs ...");
 442 DXCron->init();
 443
 444 # read in database descriptors
 445 dbg('err', "reading database descriptors ...");
 446 DXDb::load();
 447
 448 # starting local stuff
 449 dbg('err', "doing local initialisation ...");
 450 eval {
 451         Local::init();
 452 };
 453 dbg('local', "Local::init error $@") if $@;
 454
 455 # print various flags
 456 #dbg('err', "seful info - \$^D: $^D \$^W: $^W \$^S: $^S \$^P: $^P");
 457
 458 # this, such as it is, is the main loop!
 459 dbg('err', "orft we jolly well go ...");
 460
 461 #open(DB::OUT, "|tee /tmp/aa");
 462
 463 for (;;) {
 464 #       $DB::trace = 1;
 465
 466         Msg->event_loop(10, 0.010);
 467         my $timenow = time;
 468         process_inqueue();                      # read in lines from the input queue and despatch them
 469 #       $DB::trace = 0;
 470
 471         # do timed stuff, ongoing processing happens one a second
 472         if ($timenow != $systime) {
 473                 reap if $zombies;
 474                 $systime = $timenow;
 475                 DXCron::process();      # do cron jobs
 476                 DXCommandmode::process(); # process ongoing command mode stuff
 477                 DXProt::process();              # process ongoing ak1a pcxx stuff
 478                 DXConnect::process();
 479                 DXMsg::process();
 480                 DXDb::process();
 481                 DXUser::process();
 482                 DXDupe::process();
 483                 AGWMsg::process();
 484
 485                 eval {
 486                         Local::process();       # do any localised processing
 487                 };
 488                 dbg('local', "Local::process error $@") if $@;
 489         }
 490         if ($decease) {
 491                 last if --$decease <= 0;
 492         }
 493 }
 494 cease(0);
 495 exit(0);
 496
 497