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