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