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