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