added the hooks for internationalisation
[spider.git] / perl / cluster.pl
index c324930fad4b8ac9d9190b2fcd1bac07c6a31342..07c405038e68874dc70e94938ded9045a6903f5d 100755 (executable)
 #!/usr/bin/perl
 #
-# A thing that implements dxcluster 'protocol'
+# This is the DX cluster 'daemon'. It sits in the middle of its little
+# web of client routines sucking and blowing data where it may.
 #
-# This is a perl module/program that sits on the end of a dxcluster
-# 'protocol' connection and deals with anything that might come along.
-#
-# this program is called by ax25d and gets raw ax25 text on its input
+# Hence the name of 'spider' (although it may become 'dxspider')
 #
 # Copyright (c) 1998 Dirk Koopman G1TLH
 #
+# $Id$
 # 
 
+# make sure that modules are searched in the order local then perl
+BEGIN {
+       # root of directory tree for this system
+       $root = "/spider"; 
+       $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
+       
+       unshift @INC, "$root/perl";     # this IS the right way round!
+       unshift @INC, "$root/local";
+}
+
 use Msg;
 use DXVars;
 use DXUtil;
-use DXConnect;
+use DXChannel;
 use DXUser;
+use DXM;
+use DXCommandmode;
+use DXProt;
+use DXMsg;
+use DXCluster;
+use DXDebug;
+use DXCron;
+use DXConnect;
+use Prefix;
+use Bands;
+use Geomag;
+use CmdAlias;
+use Carp;
 
 package main;
 
-@inqueue = undef;                # the main input queue, an array of hashes 
-
-# handle out going messages
-sub send_now
-{
-  my ($conn, $sort, $call, $line) = @_;
-
-  print DEBUG "$t > $sort $call $line\n" if defined DEBUG;
-  print "> $sort $call $line\n";
-  $conn->send_now("$sort$call|$line");
-}
-
-sub send_later
-{
-  my ($conn, $sort, $call, $line) = @_;
-
-  print DEBUG "$t > $sort $call $line\n" if defined DEBUG;
-  print "> $sort $call $line\n";
-  $conn->send_later("$sort$call|$line");
-}
+@inqueue = ();                                 # the main input queue, an array of hashes
+$systime = 0;                                  # the time now (in seconds)
+$version = 1.3;                                        # the version no of the software
 
 # handle disconnections
 sub disconnect
 {
-  my $dxconn = shift;
-  my ($user) = $dxconn->{user};
-  my ($conn) = $dxconn->{conn};
-  $user->close() if defined $user;
-  $conn->disconnect();
-  $dxconn->del();
+       my $dxchan = shift;
+       return if !defined $dxchan;
+       $dxchan->disconnect();
 }
 
 # handle incoming messages
 sub rec
 {
-  my ($conn, $msg, $err) = @_;
-  my $dxconn = DXConnect->get_by_cnum($conn);      # get the dxconnnect object for this message
-  
-  if (defined $err && $err) {
-    disconnect($dxconn);
-       return;
-  } 
-  if (defined $msg) {
-    my $self = bless {}, "inqueue";
-    $self->{dxconn} = $dxconn;
-    $self->{data} = $msg;
-       push @inqueue, $self;
-  }
+       my ($conn, $msg, $err) = @_;
+       my $dxchan = DXChannel->get_by_cnum($conn); # get the dxconnnect object for this message
+       
+       if (defined $err && $err) {
+               disconnect($dxchan) if defined $dxchan;
+               return;
+       }
+       
+       # set up the basic channel info - this needs a bit more thought - there is duplication here
+       if (!defined $dxchan) {
+               my ($sort, $call, $line) = $msg =~ /^(\w)(\S+)\|(.*)$/;
+               
+               # is there one already connected?
+               if (DXChannel->get($call)) {
+                       my $mess = DXM::msg($lang, 'conother', $call);
+                       dbg('chan', "-> D $call $mess\n"); 
+                       $conn->send_now("D$call|$mess");
+                       sleep(1);
+                       dbg('chan', "-> Z $call bye\n");
+                       $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
+                       return;
+               }
+               
+               # is there one already connected elsewhere in the cluster?
+               if (DXCluster->get($call)) {
+                       my $mess = DXM::msg($lang, 'concluster', $call);
+                       dbg('chan', "-> D $call $mess\n"); 
+                       $conn->send_now("D$call|$mess");
+                       sleep(1);
+                       dbg('chan', "-> Z $call bye\n");
+                       $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
+                       return;
+               }
+               
+               my $user = DXUser->get($call);
+               if (!defined $user) {
+                       $user = DXUser->new($call);
+               } else {
+                       $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
+               }
+               
+               
+               # create the channel
+               $dxchan = DXCommandmode->new($call, $conn, $user) if ($user->sort eq 'U');
+               $dxchan = DXProt->new($call, $conn, $user) if ($user->sort eq 'A');
+               die "Invalid sort of user on $call = $sort" if !$dxchan;
+       }
+       
+       # queue the message and the channel object for later processing
+       if (defined $msg) {
+               my $self = bless {}, "inqueue";
+               $self->{dxchan} = $dxchan;
+               $self->{data} = $msg;
+               push @inqueue, $self;
+       }
 }
 
 sub login
 {
-  return \&rec;
+       return \&rec;
 }
 
 # cease running this program, close down all the connections nicely
 sub cease
 {
-  my $dxconn;
-  foreach $dxconn (DXConnect->get_all()) {
-    disconnect($dxconn);
-  }
+       my $dxchan;
+       foreach $dxchan (DXChannel->get_all()) {
+               disconnect($dxchan);
+       }
+       exit(0);
 }
 
 # this is where the input queue is dealt with and things are dispatched off to other parts of
 # the cluster
 sub process_inqueue
 {
-  my $self = shift @inqueue;
-  return if !$self;
-  
-  my $data = $self->{data};
-  my $dxconn = $self->{dxconn};
-  my ($sort, $call, $line) = $data =~ /^(\w)(\S+)|(.*)$/;
-  
-  # do the really sexy console interface bit! (Who is going to do the TK interface then?)
-  print DEBUG atime, " < $sort $call $line\n" if defined DEBUG;
-  print "< $sort $call $line\n";
-  
-  # handle A records
-  if ($sort eq 'A') {
-    if ($dxconn) {                         # there should not be one of these, disconnect
-
+       my $self = shift @inqueue;
+       return if !$self;
+       
+       my $data = $self->{data};
+       my $dxchan = $self->{dxchan};
+       my ($sort, $call, $line) = $data =~ /^(\w)(\S+)\|(.*)$/;
+       
+       # do the really sexy console interface bit! (Who is going to do the TK interface then?)
+       dbg('chan', "<- $sort $call $line\n");
+       
+       # handle A records
+       my $user = $dxchan->user;
+       if ($sort eq 'A') {
+               $dxchan->start($line);  
+       } elsif ($sort eq 'D') {
+               die "\$user not defined for $call" if !defined $user;
+               
+               # normal input
+               $dxchan->normal($line);
+               
+               disconnect($dxchan) if ($dxchan->{state} eq 'bye');
+       } elsif ($sort eq 'Z') {
+               disconnect($dxchan);
+       } else {
+               print STDERR atime, " Unknown command letter ($sort) received from $call\n";
        }
-    my $user = DXUser->get($call);         # see if we have one of these
-  }
-  
 }
 
 #############################################################
@@ -115,14 +167,29 @@ sub process_inqueue
 #############################################################
 
 # open the debug file, set various FHs to be unbuffered
-open(DEBUG, ">>$debugfn") or die "can't open $debugfn($!)\n";
-select DEBUG; $| = 1;
-select STDOUT; $| = 1;
+dbginit($debugfn);
+foreach (@debug) {
+       dbgadd($_);
+}
+STDOUT->autoflush(1);
+
+# banner
+print "DXSpider DX Cluster Version $version\nCopyright (c) 1998 Dirk Koopman G1TLH\n";
+
+# load Prefixes
+print "loading prefixes ...\n";
+Prefix::load();
+
+# load band data
+print "loading band data ...\n";
+Bands::load();
 
 # initialise User file system
+print "loading user file system ...\n"; 
 DXUser->init($userfn);
 
 # start listening for incoming messages/connects
+print "starting listener ...\n";
 Msg->new_server("$clusteraddr", $clusterport, \&login);
 
 # prime some signals
@@ -130,9 +197,50 @@ $SIG{'INT'} = \&cease;
 $SIG{'TERM'} = \&cease;
 $SIG{'HUP'} = 'IGNORE';
 
+# read in system messages
+DXM->init();
+
+# read in command aliases
+CmdAlias->init();
+
+# initialise the protocol engine
+DXProt->init();
+
+# initialise the Geomagnetic data engine
+Geomag->init();
+
+# initial the Spot stuff
+Spot->init();
+
+# put in a DXCluster node for us here so we can add users and take them away
+DXNode->new(0, $mycall, 0, 1, $DXProt::myprot_version); 
+
+# read in any existing message headers
+print "reading existing message headers\n";
+DXMsg->init();
+
+# read in any cron jobs
+print "reading cron jobs\n";
+DXCron->init();
+
 # this, such as it is, is the main loop!
+print "orft we jolly well go ...\n";
 for (;;) {
-  Msg->event_loop(1, 0.001);
-  process_inqueue();
+       my $timenow;
+       Msg->event_loop(1, 0.001);
+       $timenow = time;
+       process_inqueue();                      # read in lines from the input queue and despatch them
+       
+       # do timed stuff, ongoing processing happens one a second
+       if ($timenow != $systime) {
+               $systime = $timenow;
+               $cldate = &cldate();
+               $ztime = &ztime();
+               DXCommandmode::process(); # process ongoing command mode stuff
+               DXProt::process();              # process ongoing ak1a pcxx stuff
+               DXCron::process();
+               DXConnect::process();
+       }
 }
 
+