add DXCIDR, fix version no tracking
[spider.git] / perl / cluster.pl
index 20726684de2c7bbbd8f77d583dbe654a41e6d470..143713babc1e0346bada54066d1bb5617dae601b 100755 (executable)
@@ -7,19 +7,30 @@
 #
 # Copyright (c) 1998 Dirk Koopman G1TLH
 #
-# $Id$
-# 
+#
+#
 
 require 5.004;
 
+package main;
+
+# set default paths, these should be overwritten by DXVars.pm
+use vars qw($data $system $cmd $localcmd $userfn $clusteraddr $clusterport $yes $no $user_interval $lang);
+
+$lang = 'en';                   # default language
+$yes = 'Yes';                   # visual representation of yes
+$no = 'No';                     # ditto for no
+$user_interval = 11*60;         # the interval between unsolicited prompts if no traffic
+
+
 # make sure that modules are searched in the order local then perl
 BEGIN {
        umask 002;
-       
+
        # root of directory tree for this system
-       $root = "/spider"; 
+       $root = "/spider";
        $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
-       
+
        unshift @INC, "$root/perl";     # this IS the right way round!
        unshift @INC, "$root/local";
 
@@ -27,18 +38,26 @@ BEGIN {
        die "The directory $root doesn't exist, please RTFM" unless -d $root;
        die "$root/local doesn't exist, please RTFM" unless -d "$root/local";
        die "$root/local/DXVars.pm doesn't exist, please RTFM" unless -e "$root/local/DXVars.pm";
-       
+
        mkdir "$root/local_cmd", 0777 unless -d "$root/local_cmd";
-       
 
-       # try to create and lock a lockfile (this isn't atomic but 
+       $data = "$root/data";
+       $system = "$root/sys";
+       $cmd = "$root/cmd";
+       $localcmd = "$root/local_cmd";
+       $userfn = "$data/users";
+
+       # try to create and lock a lockfile (this isn't atomic but
        # should do for now
        $lockfn = "$root/local/cluster.lck";       # lock file name
-       if (-e $lockfn) {
+       if (-w $lockfn) {
                open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
                my $pid = <CLLOCK>;
-               chomp $pid;
-               die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
+               if ($pid) {
+                       chomp $pid;
+                       die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
+               }
+               unlink $lockfn;
                close CLLOCK;
        }
        open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
@@ -68,7 +87,6 @@ use DXCommandmode;
 use DXProtVars;
 use DXProtout;
 use DXProt;
-use QXProt;
 use DXMsg;
 use DXCron;
 use DXConnect;
@@ -99,13 +117,15 @@ use Mrtg;
 use USDB;
 use UDPMsg;
 use QSL;
-use Thingy;
-use RouteDB;
-use AMsg;
+use DXXml;
+use DXSql;
+use IsoTime;
+use BPQMsg;
+use DXCIDR;
 
 use Data::Dumper;
 use IO::File;
-use Fcntl ':flock'; 
+use Fcntl ':flock';
 use POSIX ":sys_wait_h";
 
 use Local;
@@ -113,38 +133,38 @@ use Local;
 package main;
 
 use strict;
-use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects 
-                       $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr 
-                       $clusterport $mycall $decease $is_win $routeroot $me $reqreg $bumpexisting
-                       $allowdxby
+use vars qw(@inqueue $systime $starttime $lockfn @outstanding_connects
+                       $zombies $root @listeners $lang $myalias @debug $userfn
+                       $mycall $decease $is_win $routeroot $me $reqreg $bumpexisting
+                       $allowdxby $dbh $dsn $dbuser $dbpass $do_xml $systime_days $systime_daystart
+                       $can_encode $maxconnect_user $maxconnect_node
                   );
 
+
+$clusteraddr //= '127.0.0.1';     # cluster tcp host address - used for things like console.pl
+$clusterport //= 27754;           # cluster tcp port
 @inqueue = ();                                 # the main input queue, an array of hashes
 $systime = 0;                                  # the time now (in seconds)
-$version = "1.51";                             # the version no of the software
-$starttime = 0;                 # the starting time of the cluster   
-#@outstanding_connects = ();     # list of outstanding connects
+$starttime = 0;                 # the starting time of the cluster
+@outstanding_connects = ();     # list of outstanding connects
 @listeners = ();                               # list of listeners
 $reqreg = 0;                                   # 1 = registration required, 2 = deregister people
 $bumpexisting = 1;                             # 1 = allow new connection to disconnect old, 0 - don't allow it
 $allowdxby = 0;                                        # 1 = allow "dx by <othercall>", 0 - don't allow it
+$maxconnect_user = 3;                  # the maximum no of concurrent connections a user can have at a time
+$maxconnect_node = 0;                  # Ditto but for nodes. In either case if a new incoming connection
+                                                               # takes the no of references in the routing table above these numbers
+                                                               # then the connection is refused. This only affects INCOMING connections.
 
+use vars qw($version $subversion $build $gitversion $gitbranch);
 
-use vars qw($VERSION $BRANCH $build $branch);
-$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
-$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/  || (0,0));
-$main::build += 1;                             # add an offset to make it bigger than last system
-$main::build += $VERSION;
-$main::branch += $BRANCH;
-
-      
 # send a message to call on conn and disconnect
 sub already_conn
 {
        my ($conn, $call, $mess) = @_;
 
        $conn->disable_read(1);
-       dbg("-> D $call $mess\n") if isdbg('chan'); 
+       dbg("-> D $call $mess\n") if isdbg('chan');
        $conn->send_now("D$call|$mess");
        sleep(2);
        $conn->disconnect;
@@ -170,19 +190,18 @@ sub new_channel
        }
 
        # set up the basic channel info
-       # is there one already connected to me - locally? 
-       my $user = DXUser->get_current($call);
-       my $dxchan = DXChannel->get($call);
+       # is there one already connected to me - locally?
+       my $user = DXUser::get_current($call);
+       my $dxchan = DXChannel::get($call);
        if ($dxchan) {
                if ($user && $user->is_node) {
                        already_conn($conn, $call, DXM::msg($lang, 'concluster', $call, $main::mycall));
                        return;
                }
                if ($bumpexisting) {
-                       my $ip = $conn->{peerhost} || 'unknown';
+                       my $ip = $conn->peerhost || 'unknown';
                        $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
-                       Log('DXCommand', "$call bumped off by $ip, disconnected");
-                       dbg("$call bumped off by $ip, disconnected");
+                       LogDbg('DXCommand', "$call bumped off by $ip, disconnected");
                        $dxchan->disconnect;
                } else {
                        already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
@@ -190,33 +209,49 @@ sub new_channel
                }
        }
 
+       # (fairly) politely disconnect people that are connected to too many other places at once
+       my $r = Route::get($call);
+       if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
+               my @n = $r->parents;
+               my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
+               my $c = $user->maxconnect;
+               my $v;
+               $v = defined $c ? $c : $m;
+               if ($v && @n >= $v) {
+                       my $nodes = join ',', @n;
+                       LogDbg('DXCommand', "$call has too many connections ($v) at $nodes - disconnected");
+                       already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
+                       return;
+               }
+       }
+
        # is he locked out ?
        my $basecall = $call;
        $basecall =~ s/-\d+$//;
-       my $baseuser = DXUser->get_current($basecall);
+       my $baseuser = DXUser::get_current($basecall);
        my $lock = $user->lockout if $user;
        if ($baseuser && $baseuser->lockout || $lock) {
                if (!$user || !defined $lock || $lock) {
-                       my $host = $conn->{peerhost} || "unknown";
-                       Log('DXCommand', "$call on $host is locked out, disconnected");
+                       my $host = $conn->peerhost || "unknown";
+                       LogDbg('DXCommand', "$call on $host is locked out, disconnected");
                        $conn->disconnect;
                        return;
                }
        }
-       
+
        if ($user) {
                $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
        } else {
                $user = DXUser->new($call);
        }
-       
+
        # create the channel
        if ($user->is_node) {
                $dxchan = DXProt->new($call, $conn, $user);
        } elsif ($user->is_user) {
                $dxchan = DXCommandmode->new($call, $conn, $user);
-       } elsif ($user->is_bbs) {
-               $dxchan = BBS->new($call, $conn, $user);
+#      } elsif ($user->is_bbs) {                                  # there is no support so
+#              $dxchan = BBS->new($call, $conn, $user);               # don't allow it!!!
        } else {
                die "Invalid sort of user on $call = $sort";
        }
@@ -226,29 +261,10 @@ sub new_channel
 
        # set callbacks
        $conn->set_error(sub {error_handler($dxchan)});
-       $conn->set_rproc(sub {my ($conn,$msg) = @_; rec($dxchan, $conn, $msg);});
-       rec($dxchan, $conn, $msg);
+       $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
+       $dxchan->rec($msg);
 }
 
-sub rec        
-{
-       my ($dxchan, $conn, $msg) = @_;
-       
-       # 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;
-       }
-}
-
-# remove any outstanding entries on the inqueue after a disconnection (usually)
-sub clean_inqueue
-{
-       my $dxchan = shift;
-       @inqueue = grep {$_->{dxchan} != $dxchan} @inqueue;
-}
 
 sub login
 {
@@ -264,27 +280,30 @@ sub cease
                $SIG{'TERM'} = 'IGNORE';
                $SIG{'INT'} = 'IGNORE';
        }
-       
+
        DXUser::sync;
 
-       eval {
-               Local::finish();   # end local processing
-       };
-       dbg("Local::finish error $@") if $@;
+       if (defined &Local::finish) {
+               eval {
+                       Local::finish();   # end local processing
+               };
+               dbg("Local::finish error $@") if $@;
+       }
 
        # disconnect nodes
-       foreach $dxchan (DXChannel->get_all_nodes) {
+       foreach $dxchan (DXChannel::get_all_nodes) {
            $dxchan->disconnect(2) unless $dxchan == $main::me;
        }
        Msg->event_loop(100, 0.01);
 
        # disconnect users
-       foreach $dxchan (DXChannel->get_all_users) {
+       foreach $dxchan (DXChannel::get_all_users) {
                $dxchan->disconnect;
        }
 
        # disconnect AGW
        AGWMsg::finish();
+       BPQMsg::finish();
 
        # disconnect UDP customers
        UDPMsg::finish();
@@ -302,10 +321,12 @@ sub cease
                $l->close_server;
        }
 
-       dbg("DXSpider version $version, build $build ended") if isdbg('chan');
-       Log('cluster', "DXSpider V$version, build $build ended");
+       LogDbg('cluster', "DXSpider v$version build $build (git: $gitbranch/$gitversion) using perl $^V on $^O ended");
        dbgclose();
        Logclose();
+
+       $dbh->finish if $dbh;
+
        unlink $lockfn;
 #      $SIG{__WARN__} = $SIG{__DIE__} =  sub {my $a = shift; cluck($a); };
        exit(0);
@@ -325,45 +346,6 @@ sub reap
 
 # this is where the input queue is dealt with and things are dispatched off to other parts of
 # the cluster
-sub process_inqueue
-{
-       while (@inqueue) {
-               my $self = shift @inqueue;
-               return if !$self;
-
-               my $data = $self->{data};
-               my $dxchan = $self->{dxchan};
-               my $error;
-               my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
-               return unless defined $sort;
-       
-               # do the really sexy console interface bit! (Who is going to do the TK interface then?)
-               dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
-               if ($self->{disconnecting}) {
-                       dbg('In disconnection, ignored');
-                       next;
-               }
-               
-               # handle A records
-               my $user = $dxchan->user;
-               if ($sort eq 'A' || $sort eq 'O') {
-                       $dxchan->start($line, $sort);  
-               } elsif ($sort eq 'I') {
-                       die "\$user not defined for $call" if !defined $user;
-
-                       # normal input
-                       $dxchan->normal($line);
-               } elsif ($sort eq 'Z') {
-                       $dxchan->disconnect;
-               } elsif ($sort eq 'D') {
-                       ;                                       # ignored (an echo)
-               } elsif ($sort eq 'G') {
-                       $dxchan->enhanced($line);
-               } else {
-                       print STDERR atime, " Unknown command letter ($sort) received from $call\n";
-               }
-       }
-}
 
 sub uptime
 {
@@ -383,13 +365,21 @@ sub AGWrestart
 
 #############################################################
 #
-# The start of the main line of code 
+# The start of the main line of code
 #
 #############################################################
 
+chdir $root;
+
 $starttime = $systime = time;
+$systime_days = int ($systime / 86400);
+$systime_daystart = $systime_days * 86400;
 $lang = 'en' unless $lang;
 
+unless ($DB::VERSION) {
+       $SIG{INT} = $SIG{TERM} = \&cease;
+}
+
 # open the debug file, set various FHs to be unbuffered
 dbginit(\&DXCommandmode::broadcast_debug);
 foreach (@debug) {
@@ -397,15 +387,62 @@ foreach (@debug) {
 }
 STDOUT->autoflush(1);
 
-# calculate build number
-$build += $main::version;
-$build = "$build.$branch" if $branch;
+# try to load the database
+if (DXSql::init($dsn)) {
+       $dbh = DXSql->new($dsn);
+       $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
+}
+
+# try to load Encode and Git
+{
+       local $^W = 0;
+       my $w = $SIG{__DIE__};
+       $SIG{__DIE__} = 'IGNORE';
+       eval { require Encode; };
+       unless ($@) {
+               import Encode;
+               $can_encode = 1;
+       }
+       
+       $gitbranch = 'none';
+       $gitversion = 'none';
+
+       # determine the real Git build number and branch
+       my $desc;
+       eval {$desc = `git --git-dir=$root/.git describe --long`};
+       if (!$@ && $desc) {
+               my ($v, $s, $b, $g) = $desc =~ /^([\d\.]+)(?:\.(\d+))?-(\d+)-g([0-9a-f]+)/;
+               $version = $v;
+               $subversion = $s || 0;
+               $build = $b || 0;
+               $gitversion = "$g\[r]";
+       }
+    if (!$@) {
+               my @branch;
+               
+               eval {@branch = `git --git-dir=$root/.git branch`};
+               unless ($@) {
+                       for (@branch) {
+                               my ($star, $b) = split /\s+/;
+                               if ($star eq '*') {
+                                       $gitbranch = $b;
+                                       last;
+                               }
+                       }
+               }
+       }
+
+       $SIG{__DIE__} = $w;
+}
 
-Log('cluster', "DXSpider V$version, build $build started");
+# try to load XML::Simple
+DXXml::init();
 
 # banner
-dbg("Copyright (c) 1998-2002 Dirk Koopman G1TLH");
-dbg("DXSpider Version $version, build $build started");
+my ($year) = (gmtime)[5];
+$year += 1900;
+LogDbg('cluster', "DXSpider v$version build $build (git: $gitbranch/$gitversion) using perl $^V on $^O started");
+dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
 
 # load Prefixes
 dbg("loading prefixes ...");
@@ -418,17 +455,32 @@ dbg("loading band data ...");
 Bands::load();
 
 # initialise User file system
-dbg("loading user file system ..."); 
+dbg("loading user file system ...");
 DXUser->init($userfn, 1);
 
+
 # look for the sysop and the alias user and complain if they aren't there
 {
-       my $ref = DXUser->get($mycall);
+       die "\$myalias \& \$mycall are the same ($mycall)!, they must be different (hint: make \$mycall = '${mycall}-2';). Oh and don't forget to rerun create_sysop.pl!" if $mycall eq $myalias;
+       my $ref = DXUser::get($mycall);
        die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
-       $ref = DXUser->get($myalias);
+       my $oldsort = $ref->sort;
+       if ($oldsort ne 'S') {
+               $ref->sort('S');
+               dbg "Resetting node type from $oldsort -> DXSpider ('S')";
+       }
+       $ref = DXUser::get($myalias);
        die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
+       $oldsort = $ref->sort;
+       if ($oldsort ne 'U') {
+               $ref->sort('U');
+               dbg "Resetting sysop user type from $oldsort -> User ('U')";
+       }
 }
 
+# get any bad IPs 
+DXCIDR::init();
+
 # start listening for incoming messages/connects
 dbg("starting listeners ...");
 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
@@ -438,15 +490,20 @@ dbg("Internal port: $clusteraddr $clusterport using IntMsg");
 foreach my $l (@main::listen) {
        no strict 'refs';
        my $pkg = $l->[2] || 'ExtMsg';
-       $conn = $pkg->new_server($l->[0], $l->[1], \&login);
-       $conn->conns("Server $l->[0]/$l->[1] using $pkg");
+       my $login = $l->[3] || 'login';
+
+       $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
+       $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
        push @listeners, $conn;
-       dbg("External Port: $l->[0] $l->[1] using $pkg");
+       dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
 }
 
 dbg("AGW Listener") if $AGWMsg::enable;
 AGWrestart();
 
+dbg("BPQ Listener") if $BPQMsg::enable;
+BPQMsg::init(\&new_channel);
+
 dbg("UDP Listener") if $UDPMsg::enable;
 UDPMsg::init(\&new_channel);
 
@@ -461,7 +518,7 @@ unless ($DB::VERSION) {
 unless ($is_win) {
        $SIG{HUP} = 'IGNORE';
        $SIG{CHLD} = sub { $zombies++ };
-       
+
        $SIG{PIPE} = sub {      dbg("Broken PIPE signal received"); };
        $SIG{IO} = sub {        dbg("SIGIO received"); };
        $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
@@ -471,7 +528,7 @@ unless ($is_win) {
        for (keys %SIG) {
                if (!$SIG{$_}) {
                        #               dbg("Catching SIG $_") if isdbg('chan');
-                       $SIG{$_} = sub { my $sig = shift;       DXDebug::confess("Caught signal $sig");  }; 
+                       $SIG{$_} = sub { my $sig = shift;       DXDebug::confess("Caught signal $sig");  };
                }
        }
 }
@@ -501,10 +558,11 @@ Spot->init();
 # initialise the protocol engine
 dbg("Start Protocol Engines ...");
 DXProt->init();
-QXProt->init();
 
 # put in a DXCluster node for us here so we can add users and take them away
 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
+$routeroot->do_pc9x(1);
+$routeroot->via_pc92(1);
 
 # make sure that there is a routing OUTPUT node default file
 #unless (Filter::read_in('route', 'node_default', 0)) {
@@ -521,17 +579,20 @@ DXMsg::clean_old();
 dbg("reading cron jobs ...");
 DXCron->init();
 
-# read in database descriptors
+# read in database desriptors
 dbg("reading database descriptors ...");
 DXDb::load();
 
 # starting local stuff
 dbg("doing local initialisation ...");
 QSL::init(1);
-eval {
-       Local::init();
-};
-dbg("Local::init error $@") if $@;
+if (defined &Local::init) {
+       eval {
+               Local::init();
+       };
+       dbg("Local::init error $@") if $@;
+}
+
 
 # this, such as it is, is the main loop!
 dbg("orft we jolly well go ...");
@@ -542,34 +603,44 @@ $script->run($main::me) if $script;
 
 for (;;) {
 #      $DB::trace = 1;
-       
+
        Msg->event_loop(10, 0.010);
        my $timenow = time;
-       process_inqueue();                      # read in lines from the input queue and despatch them
+
+       DXChannel::process();
+
 #      $DB::trace = 0;
-       
+
        # do timed stuff, ongoing processing happens one a second
        if ($timenow != $systime) {
-               reap if $zombies;
+               reap() if $zombies;
                $systime = $timenow;
+               my $days = int ($systime / 86400);
+               if ($systime_days != $days) {
+                       $systime_days = $days;
+                       $systime_daystart = $days * 86400;
+               }
+               IsoTime::update($systime);
                DXCron::process();      # do cron jobs
                DXCommandmode::process(); # process ongoing command mode stuff
+               DXXml::process();
                DXProt::process();              # process ongoing ak1a pcxx stuff
-               QXProt::process();
                DXConnect::process();
                DXMsg::process();
                DXDb::process();
                DXUser::process();
                DXDupe::process();
                AGWMsg::process();
+               BPQMsg::process();
 
-               # this where things really start to happen (in DXSpider 2)
-               Thingy::process();
+               DXLog::flushall();
                
-               eval { 
-                       Local::process();       # do any localised processing
-               };
-               dbg("Local::process error $@") if $@;
+               if (defined &Local::process) {
+                       eval {
+                               Local::process();       # do any localised processing
+                       };
+                       dbg("Local::process error $@") if $@;
+               }
        }
        if ($decease) {
                last if --$decease <= 0;