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