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