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