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.lock";       # 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
  41 use Msg;
  42 use DXVars;
  43 use DXDebug;
  44 use DXLog;
  45 use DXLogPrint;
  46 use DXUtil;
  47 use DXChannel;
  48 use DXUser;
  49 use DXM;
  50 use DXCommandmode;
  51 use DXProt;
  52 use DXMsg;
  53 use DXCluster;
  54 use DXCron;
  55 use DXConnect;
  56 use Prefix;
  57 use Bands;
  58 use Geomag;
  59 use CmdAlias;
  60 use Filter;
  61 use DXDb;
  62 use AnnTalk;
  63 use WCY;
  64
  65 use Data::Dumper;
  66 use Fcntl ':flock';
  67
  68 use Local;
  69
  70 package main;
  71
  72 @inqueue = ();                                  # the main input queue, an array of hashes
  73 $systime = 0;                                   # the time now (in seconds)
  74 $version = "1.44";                              # the version no of the software
  75 $starttime = 0;                 # the starting time of the cluster
  76 $lockfn = "cluster.lock";       # lock file name
  77 @outstanding_connects = ();     # list of outstanding connects
  78
  79 # handle disconnections
  80 sub disconnect
  81 {
  82         my $dxchan = shift;
  83         return if !defined $dxchan;
  84         $dxchan->disconnect();
  85 }
  86
  87 # send a message to call on conn and disconnect
  88 sub already_conn
  89 {
  90         my ($conn, $call, $mess) = @_;
  91
  92         dbg('chan', "-> D $call $mess\n");
  93         $conn->send_now("D$call|$mess");
  94         sleep(1);
  95         dbg('chan', "-> Z $call bye\n");
  96         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
  97         sleep(1);
  98         $conn->disconnect();
  99 }
 100
 101 # handle incoming messages
 102 sub rec
 103 {
 104         my ($conn, $msg, $err) = @_;
 105         my $dxchan = DXChannel->get_by_cnum($conn); # get the dxconnnect object for this message
 106
 107         if (!defined $msg || (defined $err && $err)) {
 108                 if ($dxchan) {
 109                         if (defined $err) {
 110                                 $conn->disconnect;
 111                                 undef $conn;
 112                                 $dxchan->conn(undef);
 113                         }
 114                         $dxchan->disconnect;
 115                 } elsif ($conn) {
 116                         $conn->disconnect;
 117                 }
 118                 return;
 119         }
 120
 121         # set up the basic channel info - this needs a bit more thought - there is duplication here
 122         if (!defined $dxchan) {
 123                 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
 124                 return unless defined $sort;
 125
 126                 # is there one already connected to me - locally?
 127                 my $user = DXUser->get($call);
 128                 if (DXChannel->get($call)) {
 129                         my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call);
 130                         already_conn($conn, $call, $mess);
 131                         return;
 132                 }
 133
 134                 # is there one already connected elsewhere in the cluster?
 135                 if ($user) {
 136                         if (($user->is_node || $call eq $myalias) && !DXCluster->get_exact($call)) {
 137                                 ;
 138                         } else {
 139                                 if (DXCluster->get_exact($call)) {
 140                                         my $mess = DXM::msg($lang, $user->is_node ? 'concluster' : 'conother', $call);
 141                                         already_conn($conn, $call, $mess);
 142                                         return;
 143                                 }
 144                         }
 145                         $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
 146                 } else {
 147                         if (DXCluster->get_exact($call)) {
 148                                 my $mess = DXM::msg($lang, 'conother', $call);
 149                                 already_conn($conn, $call, $mess);
 150                                 return;
 151                         }
 152                         $user = DXUser->new($call);
 153                 }
 154
 155                 # is he locked out ?
 156                 if ($user->lockout) {
 157                         Log('DXCommand', "$call is locked out, disconnected");
 158                         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
 159                         return;
 160                 }
 161
 162                 # create the channel
 163                 $dxchan = DXCommandmode->new($call, $conn, $user) if $user->is_user;
 164                 $dxchan = DXProt->new($call, $conn, $user) if $user->is_node;
 165                 $dxchan = BBS->new($call, $conn, $user) if $user->is_bbs;
 166                 die "Invalid sort of user on $call = $sort" if !$dxchan;
 167         }
 168
 169         # queue the message and the channel object for later processing
 170         if (defined $msg) {
 171                 my $self = bless {}, "inqueue";
 172                 $self->{dxchan} = $dxchan;
 173                 $self->{data} = $msg;
 174                 push @inqueue, $self;
 175         }
 176 }
 177
 178 sub login
 179 {
 180         return \&rec;
 181 }
 182
 183 # cease running this program, close down all the connections nicely
 184 sub cease
 185 {
 186         my $dxchan;
 187
 188         $SIG{'TERM'} = 'IGNORE';
 189         $SIG{'INT'} = 'IGNORE';
 190
 191         DXUser::sync;
 192
 193         eval {
 194                 Local::finish();   # end local processing
 195         };
 196         dbg('local', "Local::finish error $@") if $@;
 197
 198         # disconnect nodes
 199         foreach $dxchan (DXChannel->get_all()) {
 200                 next unless $dxchan->is_node;
 201                 disconnect($dxchan) unless $dxchan == $DXProt::me;
 202         }
 203         Msg->event_loop(1, 0.05);
 204         Msg->event_loop(1, 0.05);
 205         Msg->event_loop(1, 0.05);
 206         Msg->event_loop(1, 0.05);
 207         Msg->event_loop(1, 0.05);
 208         Msg->event_loop(1, 0.05);
 209
 210         # disconnect users
 211         foreach $dxchan (DXChannel->get_all()) {
 212                 next if $dxchan->is_node;
 213                 disconnect($dxchan) unless $dxchan == $DXProt::me;
 214         }
 215         Msg->event_loop(1, 0.05);
 216         Msg->event_loop(1, 0.05);
 217         Msg->event_loop(1, 0.05);
 218         Msg->event_loop(1, 0.05);
 219         Msg->event_loop(1, 0.05);
 220         Msg->event_loop(1, 0.05);
 221         DXUser::finish();
 222
 223         # close all databases
 224         DXDb::closeall;
 225
 226         dbg('chan', "DXSpider version $version ended");
 227         Log('cluster', "DXSpider V$version stopped");
 228         dbgclose();
 229         Logclose();
 230         unlink $lockfn;
 231 #       $SIG{__WARN__} = $SIG{__DIE__} =  sub {my $a = shift; cluck($a); };
 232         exit(0);
 233 }
 234
 235 # the reaper of children
 236 sub reap
 237 {
 238         $SIG{'CHLD'} = \&reap;
 239         my $cpid = wait;
 240         @outstanding_connects = grep {$_->{pid} != $cpid} @outstanding_connects;
 241 }
 242
 243 # this is where the input queue is dealt with and things are dispatched off to other parts of
 244 # the cluster
 245 sub process_inqueue
 246 {
 247         my $self = shift @inqueue;
 248         return if !$self;
 249
 250         my $data = $self->{data};
 251         my $dxchan = $self->{dxchan};
 252         my $error;
 253         my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
 254         return unless defined $sort;
 255
 256         # translate any crappy characters into hex characters
 257         if ($line =~ /[\x00-\x06\x08\x0a-\x1f\x7f-\xff]/o) {
 258                 $line =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
 259         }
 260
 261         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
 262         dbg('chan', "<- $sort $call $line\n") unless $sort eq 'D';
 263
 264         # handle A records
 265         my $user = $dxchan->user;
 266         if ($sort eq 'A' || $sort eq 'O') {
 267                 $dxchan->start($line, $sort);
 268         } elsif ($sort eq 'I') {
 269                 die "\$user not defined for $call" if !defined $user;
 270                 # normal input
 271                 $dxchan->normal($line);
 272                 disconnect($dxchan) if ($dxchan->{state} eq 'bye');
 273         } elsif ($sort eq 'Z') {
 274                 $dxchan->conn(undef);
 275                 disconnect($dxchan);
 276         } elsif ($sort eq 'D') {
 277                 ;                       # ignored (an echo)
 278         } else {
 279                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
 280         }
 281 }
 282
 283 sub uptime
 284 {
 285         my $t = $systime - $starttime;
 286         my $days = int $t / 86400;
 287         $t -= $days * 86400;
 288         my $hours = int $t / 3600;
 289         $t -= $hours * 3600;
 290         my $mins = int $t / 60;
 291         return sprintf "%d %02d:%02d", $days, $hours, $mins;
 292 }
 293 #############################################################
 294 #
 295 # The start of the main line of code
 296 #
 297 #############################################################
 298
 299 $starttime = $systime = time;
 300
 301 # open the debug file, set various FHs to be unbuffered
 302 dbginit();
 303 foreach (@debug) {
 304         dbgadd($_);
 305 }
 306 STDOUT->autoflush(1);
 307
 308 Log('cluster', "DXSpider V$version started");
 309
 310 # banner
 311 dbg('err', "DXSpider DX Cluster Version $version", "Copyright (c) 1998-2000 Dirk Koopman G1TLH");
 312
 313 # load Prefixes
 314 dbg('err', "loading prefixes ...");
 315 Prefix::load();
 316
 317 # load band data
 318 dbg('err', "loading band data ...");
 319 Bands::load();
 320
 321 # initialise User file system
 322 dbg('err', "loading user file system ...");
 323 DXUser->init($userfn, 1);
 324
 325 # start listening for incoming messages/connects
 326 dbg('err', "starting listener ...");
 327 Msg->new_server("$clusteraddr", $clusterport, \&login);
 328
 329 # prime some signals
 330 $SIG{INT} = \&cease;
 331 $SIG{TERM} = \&cease;
 332 $SIG{HUP} = 'IGNORE';
 333 $SIG{CHLD} = \&reap;
 334
 335 $SIG{PIPE} = sub {      dbg('err', "Broken PIPE signal received"); };
 336 $SIG{IO} = sub {        dbg('err', "SIGIO received"); };
 337 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
 338 $SIG{KILL} = 'DEFAULT';     # as if it matters....
 339
 340 # catch the rest with a hopeful message
 341 for (keys %SIG) {
 342         if (!$SIG{$_}) {
 343 #               dbg('chan', "Catching SIG $_");
 344                 $SIG{$_} = sub { my $sig = shift;       DXDebug::confess("Caught signal $sig");  };
 345         }
 346 }
 347
 348 # read in system messages
 349 DXM->init();
 350
 351 # read in command aliases
 352 CmdAlias->init();
 353
 354 # initialise the Geomagnetic data engine
 355 Geomag->init();
 356 WCY->init();
 357
 358 # initial the Spot stuff
 359 Spot->init();
 360
 361 # initialise the protocol engine
 362 dbg('err', "reading in duplicate spot and WWV info ...");
 363 DXProt->init();
 364
 365
 366 # put in a DXCluster node for us here so we can add users and take them away
 367 DXNode->new(0, $mycall, 0, 1, $DXProt::myprot_version);
 368
 369 # read in any existing message headers and clean out old crap
 370 dbg('err', "reading existing message headers ...");
 371 DXMsg->init();
 372 DXMsg::clean_old();
 373
 374 # read in any cron jobs
 375 dbg('err', "reading cron jobs ...");
 376 DXCron->init();
 377
 378 # read in database descriptors
 379 dbg('err', "reading database descriptors ...");
 380 DXDb::load();
 381
 382 # starting local stuff
 383 dbg('err', "doing local initialisation ...");
 384 eval {
 385         Local::init();
 386 };
 387 dbg('local', "Local::init error $@") if $@;
 388
 389 # print various flags
 390 #dbg('err', "seful info - \$^D: $^D \$^W: $^W \$^S: $^S \$^P: $^P");
 391
 392 # this, such as it is, is the main loop!
 393 dbg('err', "orft we jolly well go ...");
 394
 395 #open(DB::OUT, "|tee /tmp/aa");
 396
 397 for (;;) {
 398         my $timenow;
 399 #       $DB::trace = 1;
 400
 401         Msg->event_loop(1, 0.1);
 402         $timenow = time;
 403         process_inqueue();                      # read in lines from the input queue and despatch them
 404 #       $DB::trace = 0;
 405
 406         # do timed stuff, ongoing processing happens one a second
 407         if ($timenow != $systime) {
 408                 $systime = $timenow;
 409                 $cldate = &cldate();
 410                 $ztime = &ztime();
 411                 DXCron::process();      # do cron jobs
 412                 DXCommandmode::process(); # process ongoing command mode stuff
 413                 DXProt::process();              # process ongoing ak1a pcxx stuff
 414                 DXConnect::process();
 415                 DXMsg::process();
 416                 DXDb::process();
 417                 DXUser::process();
 418                 eval {
 419                         Local::process();       # do any localised processing
 420                 };
 421                 dbg('local', "Local::process error $@") if $@;
 422         }
 423         if ($decease) {
 424                 last if --$decease <= 0;
 425         }
 426 }
 427 cease(0);
 428 exit(0);
 429
 430