perl/cluster.pl

   1 #!/usr/bin/perl
   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 # make sure that modules are searched in the order local then perl
  14 BEGIN {
  15         # root of directory tree for this system
  16         $root = "/spider";
  17         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
  18
  19         unshift @INC, "$root/perl";     # this IS the right way round!
  20         unshift @INC, "$root/local";
  21
  22 #       require Exporter;
  23 #       $Exporter::Verbose = 1;
  24 }
  25
  26 use Msg;
  27 use DXVars;
  28 use DXDebug;
  29 use DXLog;
  30 use DXLogPrint;
  31 use DXUtil;
  32 use DXChannel;
  33 use DXUser;
  34 use DXM;
  35 use DXCommandmode;
  36 use DXProt;
  37 use DXMsg;
  38 use DXCluster;
  39 use DXCron;
  40 use DXConnect;
  41 use Prefix;
  42 use Bands;
  43 use Geomag;
  44 use CmdAlias;
  45 use Carp;
  46
  47 package main;
  48
  49 @inqueue = ();                                  # the main input queue, an array of hashes
  50 $systime = 0;                                   # the time now (in seconds)
  51 $version = "1.13";                              # the version no of the software
  52 $starttime = 0;                 # the starting time of the cluster
  53
  54 # handle disconnections
  55 sub disconnect
  56 {
  57         my $dxchan = shift;
  58         return if !defined $dxchan;
  59         $dxchan->disconnect();
  60 }
  61
  62 # send a message to call on conn and disconnect
  63 sub already_conn
  64 {
  65         my ($conn, $call, $mess) = @_;
  66
  67         dbg('chan', "-> D $call $mess\n");
  68         $conn->send_now("D$call|$mess");
  69         sleep(1);
  70         dbg('chan', "-> Z $call bye\n");
  71         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
  72 }
  73
  74 # handle incoming messages
  75 sub rec
  76 {
  77         my ($conn, $msg, $err) = @_;
  78         my $dxchan = DXChannel->get_by_cnum($conn); # get the dxconnnect object for this message
  79
  80         if (defined $err && $err) {
  81                 disconnect($dxchan) if defined $dxchan;
  82                 return;
  83         }
  84
  85         # set up the basic channel info - this needs a bit more thought - there is duplication here
  86         if (!defined $dxchan) {
  87                 my ($sort, $call, $line) = $msg =~ /^(\w)(\S+)\|(.*)$/;
  88
  89                 # is there one already connected elsewhere in the cluster (and not a cluster)
  90                 my $user = DXUser->get($call);
  91                 if ($user) {
  92                         if (($user->sort eq 'A' || $call == $myalias) && !DXCluster->get_exact($call)) {
  93                                 ;
  94                         } else {
  95                                 if (DXCluster->get($call) || DXChannel->get($call)) {
  96                                         my $mess = DXM::msg($lang, $user->sort eq 'A' ? 'concluster' : 'conother', $call);
  97                                         already_conn($conn, $call, $mess);
  98                                         return;
  99                                 }
 100                         }
 101                 } else {
 102                         if (DXCluster->get($call) || DXChannel->get($call)) {
 103                                 my $mess = DXM::msg($lang, 'conother', $call);
 104                                 already_conn($conn, $call, $mess);
 105                                 return;
 106                         }
 107                 }
 108
 109
 110                 # the user MAY have an SSID if local, but otherwise doesn't
 111                 $user = DXUser->get($call);
 112                 if (!defined $user) {
 113                         $user = DXUser->new($call);
 114                 } else {
 115                         $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
 116                 }
 117
 118                 # is he locked out ?
 119                 if ($user->lockout) {
 120                         Log('DXCommand', "$call is locked out, disconnected");
 121                         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
 122                         return;
 123                 }
 124
 125                 # create the channel
 126                 $dxchan = DXCommandmode->new($call, $conn, $user) if ($user->sort eq 'U');
 127                 $dxchan = DXProt->new($call, $conn, $user) if ($user->sort eq 'A');
 128                 die "Invalid sort of user on $call = $sort" if !$dxchan;
 129         }
 130
 131         # queue the message and the channel object for later processing
 132         if (defined $msg) {
 133                 my $self = bless {}, "inqueue";
 134                 $self->{dxchan} = $dxchan;
 135                 $self->{data} = $msg;
 136                 push @inqueue, $self;
 137         }
 138 }
 139
 140 sub login
 141 {
 142         return \&rec;
 143 }
 144
 145 # cease running this program, close down all the connections nicely
 146 sub cease
 147 {
 148         my $dxchan;
 149         foreach $dxchan (DXChannel->get_all()) {
 150                 disconnect($dxchan) unless $dxchan == $DXProt::me;
 151         }
 152         Log('cluster', "DXSpider V$version stopped");
 153         exit(0);
 154 }
 155
 156 # the reaper of children
 157 sub reap
 158 {
 159         my $cpid = wait;
 160 }
 161
 162 # this is where the input queue is dealt with and things are dispatched off to other parts of
 163 # the cluster
 164 sub process_inqueue
 165 {
 166         my $self = shift @inqueue;
 167         return if !$self;
 168
 169         my $data = $self->{data};
 170         my $dxchan = $self->{dxchan};
 171         my ($sort, $call, $line) = $data =~ /^(\w)(\S+)\|(.*)$/;
 172
 173         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
 174         dbg('chan', "<- $sort $call $line\n") unless $sort eq 'D';
 175
 176         # handle A records
 177         my $user = $dxchan->user;
 178         if ($sort eq 'A' || $sort eq 'O') {
 179                 $dxchan->start($line, $sort);
 180         } elsif ($sort eq 'I') {
 181                 die "\$user not defined for $call" if !defined $user;
 182
 183                 # normal input
 184                 $dxchan->normal($line);
 185
 186                 disconnect($dxchan) if ($dxchan->{state} eq 'bye');
 187         } elsif ($sort eq 'Z') {
 188                 disconnect($dxchan);
 189         } elsif ($sort eq 'D') {
 190                 ;                       # ignored (an echo)
 191         } else {
 192                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
 193         }
 194 }
 195
 196 sub uptime
 197 {
 198         my $t = $systime - $starttime;
 199         my $days = int $t / 86400;
 200         $t -= $days * 86400;
 201         my $hours = int $t / 3600;
 202         $t -= $hours * 3600;
 203         my $mins = int $t / 60;
 204         return sprintf "%d %02d:%02d", $days, $hours, $mins;
 205 }
 206 #############################################################
 207 #
 208 # The start of the main line of code
 209 #
 210 #############################################################
 211
 212 $starttime = $systime = time;
 213
 214 # open the debug file, set various FHs to be unbuffered
 215 foreach (@debug) {
 216         dbgadd($_);
 217 }
 218 STDOUT->autoflush(1);
 219
 220 Log('cluster', "DXSpider V$version started");
 221
 222 # banner
 223 print "DXSpider DX Cluster Version $version\nCopyright (c) 1998 Dirk Koopman G1TLH\n";
 224
 225 # load Prefixes
 226 print "loading prefixes ...\n";
 227 Prefix::load();
 228
 229 # load band data
 230 print "loading band data ...\n";
 231 Bands::load();
 232
 233 # initialise User file system
 234 print "loading user file system ...\n";
 235 DXUser->init($userfn);
 236
 237 # start listening for incoming messages/connects
 238 print "starting listener ...\n";
 239 Msg->new_server("$clusteraddr", $clusterport, \&login);
 240
 241 # prime some signals
 242 $SIG{'INT'} = \&cease;
 243 $SIG{'TERM'} = \&cease;
 244 $SIG{'HUP'} = 'IGNORE';
 245 $SIG{'CHLD'} = \&reap;
 246
 247 # read in system messages
 248 DXM->init();
 249
 250 # read in command aliases
 251 CmdAlias->init();
 252
 253 # initialise the protocol engine
 254 DXProt->init();
 255
 256 # initialise the Geomagnetic data engine
 257 Geomag->init();
 258
 259 # initial the Spot stuff
 260 Spot->init();
 261
 262 # put in a DXCluster node for us here so we can add users and take them away
 263 DXNode->new(0, $mycall, 0, 1, $DXProt::myprot_version);
 264
 265 # read in any existing message headers and clean out old crap
 266 print "reading existing message headers\n";
 267 DXMsg->init();
 268 DXMsg::clean_old();
 269
 270 # read in any cron jobs
 271 print "reading cron jobs\n";
 272 DXCron->init();
 273
 274 # this, such as it is, is the main loop!
 275 print "orft we jolly well go ...\n";
 276 for (;;) {
 277         my $timenow;
 278         Msg->event_loop(1, 0.001);
 279         $timenow = time;
 280         process_inqueue();                      # read in lines from the input queue and despatch them
 281
 282         # do timed stuff, ongoing processing happens one a second
 283         if ($timenow != $systime) {
 284                 $systime = $timenow;
 285                 $cldate = &cldate();
 286                 $ztime = &ztime();
 287                 DXCron::process();      # do cron jobs
 288                 DXCommandmode::process(); # process ongoing command mode stuff
 289                 DXProt::process();              # process ongoing ak1a pcxx stuff
 290                 DXConnect::process();
 291         }
 292         if ($decease) {
 293                 last if --$decease <= 0;
 294         }
 295 }
 296
 297