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.
6 # Hence the name of 'spider' (although it may become 'dxspider')
8 # Copyright (c) 1998 Dirk Koopman G1TLH
19 use vars qw($root $is_win $systime $lockfn @inqueue $starttime $lockfn @outstanding_connects
20 $zombies @listeners $lang $myalias @debug $userfn $clusteraddr
21 $clusterport $mycall $decease $routeroot $me $reqreg $bumpexisting
22 $allowdxby $dbh $dsn $dbuser $dbpass $do_xml $systime_days $systime_daystart
23 $can_encode $maxconnect_user $maxconnect_node $idle_interval $log_flush_interval
24 $broadcast_debug $yes $no $user_interval
27 #$lang = 'en'; # default language
28 #$clusteraddr = '127.0.0.1'; # cluster tcp host address - used for things like console.pl
29 #$clusterport = 27754; # cluster tcp port
30 #$yes = 'Yes'; # visual representation of yes
31 #$no = 'No'; # ditto for no
32 #$user_interval = 11*60; # the interval between unsolicited prompts if no traffic
34 # make sure that modules are searched in the order local then perl
37 $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN };
39 # take into account any local::lib that might be present
45 import local::lib qw(/spider/perl5lib);
48 # root of directory tree for this system
50 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
52 unshift @INC, "$root/perl5lib" unless grep {$_ eq "$root/perl5lib"} @INC;
53 unshift @INC, "$root/perl"; # this IS the right way round!
54 unshift @INC, "$root/local";
56 # do some validation of the input
57 die "The directory $root doesn't exist, please RTFM" unless -d $root;
58 die "$root/local doesn't exist, please RTFM" unless -d "$root/local";
59 die "$root/local/DXVars.pm doesn't exist, please RTFM" unless -e "$root/local/DXVars.pm";
61 # create some directories
62 mkdir "$root/local_cmd", 02774 unless -d "$root/local_cmd";
64 # locally stored data lives here
65 my $local_data = "$root/local_data";
66 mkdir $local_data, 02774 unless -d $local_data;
68 # try to create and lock a lockfile (this isn't atomic but
70 $lockfn = "$root/local_data/cluster.lck"; # lock file name
72 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
77 warn "Lockfile ($lockfn) and process $pid exist, another cluster running?\n";
84 open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
88 $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
97 # order here is important - DXDebug snarfs Carp et al so that Mojo errors go into the debug log
160 use POSIX ":sys_wait_h";
163 use vars qw($version $build $gitversion $gitbranch);
169 $lang //= 'en'; # default language
170 $clusteraddr //= '127.0.0.1'; # cluster tcp host address - used for things like console.pl
171 $clusterport //= 27754; # cluster tcp port
172 $yes //= 'Yes'; # visual representation of yes
173 $no //= 'No'; # ditto for no
174 $user_interval //= 11*60; # the interval between unsolicited prompts if no traffic
177 @inqueue = (); # the main input queue, an array of hashes
178 $systime = 0; # the time now (in seconds)
179 $starttime = 0; # the starting time of the cluster
180 @outstanding_connects = (); # list of outstanding connects
181 @listeners = (); # list of listeners
182 $reqreg = 0; # 1 = registration required, 2 = deregister people
183 $bumpexisting = 1; # 1 = allow new connection to disconnect old, 0 - don't allow it
184 our $allowmultiple = 0; # This is used in conjunction with $bumpexisting, in a rather weird way.
185 our $min_reconnection_rate = 5*60; # minimum value of seconds between connections per user to allow co-existing users
186 our $max_ssid = 15; # highest ssid to be searched for a spare one on multiple connections
188 # If $allowmultiple > 0 and the $reconnection_rate is some value of seconds
189 # based on the average connection time calculated from the $user->conntimel entries / frequency is
190 # less than $reconnection_rate then we assume that there is more than one device (probably HRD) trying
191 # to connect "at once". In which case we probe for a spare SSID for a user callsign to allow up to
192 # $allowmultiple connections per callsign.
194 $allowdxby = 0; # 1 = allow "dx by <othercall>", 0 - don't allow it
195 $maxconnect_user = 3; # the maximum no of concurrent connections a user can have at a time
196 $maxconnect_node = 0; # Ditto but for nodes. In either case if a new incoming connection
197 # takes the no of references in the routing table above these numbers
198 # then the connection is refused. This only affects INCOMING connections.
199 $idle_interval = 0.500; # the wait between invocations of the main idle loop processing.
200 $log_flush_interval = 2; # interval to wait between log flushes
202 our $ending; # signal that we are ending;
203 our $broadcast_debug; # allow broadcasting of debug info down "enhanced" user connections
204 our $clssecs; # the amount of cpu time the DXSpider process have consumed
205 our $cldsecs; # the amount of cpu time any child processes have consumed
206 our $allowslashcall; # Allow / in connecting callsigns (ie PA0/G1TLH, or even PA0/G1TLH/2)
209 # send a message to call on conn and disconnect
212 my ($conn, $call, $mess) = @_;
214 $conn->disable_read(1);
215 dbg("-> D $call $mess\n") if isdbg('chan');
216 $conn->send_now("D$call|$mess");
221 # handle incoming messages
224 my ($conn, $msg) = @_;
225 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
226 return unless defined $sort;
230 if (is_webcall($call) && $conn->isa('IntMsg')) {
231 my $newcall = find_next_webcall();
233 already_conn($conn, $call, "Maximum no of web connected connects ($Web::maxssid) exceeded");
236 $call = normalise_call($newcall);
238 $user = DXUser::get_current($call);
240 $user = DXUser->new($call);
244 $user->qth('on the web');
245 $user->homenode($main::mycall);
246 $user->lat($main::mylatitude);
247 $user->long($main::mylongitude);
248 $user->qra($main::mylocator);
250 $user->startt($main::systime);
252 $dxchan = Web->new($call, $conn, $user);
253 $dxchan->enhanced(1);
255 $msg =~ s/^A#WEB|/A$call|/;
256 $conn->send_now("C$call");
258 # "Normal" connections
260 # normalise calls like G1TST-0/G1TST-00/G1TST-01 to G1TST and G1TST-1 respectively
261 my $ncall = normalise_call($call);
262 if ($call ne $ncall) {
263 LogDbg('err', "new_channel login invalid $call converted to $ncall");
264 $msg =~ s/$call/$ncall/;
267 # is it a valid callsign (in format)?
268 unless (is_callsign($call)) {
269 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
276 $user = DXUser::get_current($call);
277 my $basecall = $call;
278 $basecall =~ s/-\d+$//; # remember this for later multiple user processing, it's used for other stuff than checking lockout status
280 # make sure we act on any locked status that the actual incoming call has.
281 $lock = $user->lockout;
282 } elsif ($basecall ne $call) {
283 # if there isn't a SSID on the $call, then try the base
284 my $luser = DXUser::get_current($basecall);
285 $lock = $luser->lockout if $luser;
288 # now deal with the lock
290 my $host = $conn->peerhost;
291 LogDbg('', "$call on $host is locked out, disconnected");
296 # set up the basic channel info for "Normal" Users
297 # is there one already connected to me - locally?
299 $dxchan = DXChannel::get($call);
302 if ($user && $user->is_node) {
303 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
306 if ($allowmultiple && $user->is_user) {
307 # determine whether we are a candidate, have we flip-flopped frequently enough?
308 my @lastconns = @{$user->connlist} if $user->connlist;
310 if (@lastconns >= $DXUser::maxconnlist) {
311 $allow = $lastconns[-1]->[0] - $lastconns[0]->[0] < $min_reconnection_rate;
313 # search for a spare ssid
314 L1: for (my $count = $call =~ /-\d+$/?0:1; $allow && $count < $allowmultiple; ) { # remember we have one call already
316 for (; $lastid < $max_ssid && $count < $allowmultiple; ++$lastid) {
317 my $chan = DXChannel::get("$basecall-$lastid");
322 # we have a free call-ssid, save it
323 $newcall = "$basecall-$lastid";
329 # handle "normal" (non-multiple) connections in the existing way
330 if ($call eq $newcall) {
332 my $ip = $dxchan->hostname;
333 $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
334 LogDbg('', "$call bumped off by $ip, disconnected");
337 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
342 # make sure that the conn has the (possibly) new callsign
343 $conn->conns($newcall);
344 $msg =~ s/$call/$newcall/;
348 # (fairly) politely disconnect people that are connected to too many other places at once
349 my $r = Route::get($call);
350 if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
352 my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
353 my $c = $user->maxconnect;
355 $v = defined $c ? $c : $m;
356 if ($v && @n >= $v+$allowmultiple) {
357 my $nodes = join ',', @n;
358 LogDbg('', "$call has too many connections ($v) at $nodes - disconnected");
359 already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
365 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
367 $user = DXUser->new($call);
371 # NOTE we are SHARING the same $user if $allowmultiple is > 1
373 $user->startt($systime); # mark the start time of this connection
374 if ($user->is_node) {
375 $dxchan = DXProt->new($call, $conn, $user);
376 } elsif ($user->is_rbn) {
377 $dxchan = RBN->new($newcall, $conn, $user);
378 } elsif ($user->is_user) {
379 $dxchan = DXCommandmode->new($newcall, $conn, $user);
381 die "Invalid sort of user on $call = $sort";
387 $conn->set_error(sub {my $err = shift; LogDbg('', "Comms error '$err' received for call $dxchan->{call}"); $dxchan->disconnect(1);});
388 $conn->set_on_eof(sub {$dxchan->disconnect});
389 $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
391 $dxchan->enhanced(1);
400 return \&new_channel;
405 # cease running this program, close down all the connections nicely
410 cluck("ceasing") if $ceasing;
412 return if $ceasing++;
415 $SIG{'TERM'} = 'IGNORE';
416 $SIG{'INT'} = 'IGNORE';
420 if (defined &Local::finish) {
422 Local::finish(); # end local processing
424 dbg("Local::finish error $@") if $@;
432 # disconnect UDP customers
435 # end everything else
440 # close all databases
443 # close all listeners
444 foreach my $l (@listeners) {
448 LogDbg('cluster', "DXSpider v$version build $build (git: $gitbranch/$gitversion) using perl $^V on $^O ended");
449 dbg("bye bye everyone - bye bye");
453 $dbh->finish if $dbh;
458 # the reaper of children
462 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
463 dbg("cpid: $cpid") if isdbg('reap');
464 # Msg->pid_gone($cpid);
465 $zombies-- if $zombies > 0;
467 dbg("cpid: $cpid") if isdbg('reap');
470 # this is where the input queue is dealt with and things are dispatched off to other parts of
475 my $t = $systime - $starttime;
476 my $days = int $t / 86400;
478 my $hours = int $t / 3600;
480 my $mins = int $t / 60;
481 return sprintf "%d %02d:%02d", $days, $hours, $mins;
486 AGWMsg::init(\&new_channel);
493 #############################################################
495 # The start of the main line of code
497 #############################################################
501 $starttime = $systime = time;
502 $systime_days = int ($systime / 86400);
503 $systime_daystart = $systime_days * 86400;
504 $lang = 'en' unless $lang;
506 unless ($DB::VERSION) {
507 $SIG{INT} = $SIG{TERM} = \&cease;
510 # open the debug file, set various FHs to be unbuffered
511 dbginit(undef, $broadcast_debug ? \&DXCommandmode::broadcast_debug : undef);
515 STDOUT->autoflush(1);
518 dbg "Perl path: " . join(':', @INC);
520 # try to load the database
521 if (DXSql::init($dsn)) {
522 $dbh = DXSql->new($dsn);
523 $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
526 # try to load Encode and Git
529 my $w = $SIG{__DIE__};
530 $SIG{__DIE__} = 'IGNORE';
531 eval { require Encode; };
538 $gitversion = 'none';
540 # determine the real Git build number and branch
542 eval {$desc = `git --git-dir=$root/.git describe --long`};
544 my ($v, $s, $b, $g) = $desc =~ /^([\d\.]+)(?:\.(\d+))?-(\d+)-g([0-9a-f]+)/;
546 my $subversion = $s || 0; # not used elsewhere
548 $gitversion = "$g\[r]";
553 eval {@branch = `git --git-dir=$root/.git branch`};
556 my ($star, $b) = split /\s+/;
568 # setup location of motd & issue
570 $motd = localdata($motd);
571 localdata_mv("issue");
574 # try to load XML::Simple
578 my ($year) = (gmtime)[5];
580 LogDbg('cluster', "DXSpider v$version build $build (git: $gitbranch/$gitversion) using perl $^V on $^O started");
581 dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
584 dbg("loading prefixes ...");
586 my $r = Prefix::init();
590 dbg("loading band data ...");
593 # initialise User file system
594 dbg("loading user file system ...");
595 DXUser::init(4); # version 4 == json format
597 Filter::init(); # doesn't do much, but has to be done
599 AnnTalk::init(); # initialise announce cache
603 # look for the sysop and the alias user and complain if they aren't there
605 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;
606 my $ref = DXUser::get($mycall);
607 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
608 my $oldsort = $ref->sort;
609 if ($oldsort ne 'S') {
611 dbg("Resetting node type from $oldsort -> DXSpider ('S')");
613 $ref = DXUser::get($myalias);
614 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
615 $oldsort = $ref->sort;
616 if ($oldsort ne 'U') {
618 dbg("Resetting sysop user type from $oldsort -> User ('U')");
622 # start listening for incoming messages/connects
623 dbg("starting listeners ...");
624 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
625 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
626 push @listeners, $conn;
627 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
628 foreach my $l (@main::listen) {
630 my $pkg = $l->[2] || 'ExtMsg';
631 my $login = $l->[3] || 'login';
633 $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
634 $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
635 push @listeners, $conn;
636 dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
639 dbg("AGW Listener") if $AGWMsg::enable;
642 dbg("BPQ Listener") if $BPQMsg::enable;
643 BPQMsg::init(\&new_channel);
645 dbg("UDP Listener") if $UDPMsg::enable;
646 UDPMsg::init(\&new_channel);
649 dbg("load badwords: " . (BadWords::load or "Ok"));
652 unless ($DB::VERSION) {
653 $SIG{INT} = $SIG{TERM} = sub { $ending = 10; };
657 $SIG{HUP} = 'IGNORE';
658 $SIG{CHLD} = sub { $zombies++ };
660 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
661 $SIG{IO} = sub { dbg("SIGIO received"); };
662 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
663 $SIG{KILL} = 'DEFAULT'; # as if it matters....
665 # catch the rest with a hopeful message
668 # dbg("Catching SIG $_") if isdbg('chan');
669 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
675 dbg("Starting Dupe system");
678 # read in system messages
679 dbg("Read in Messages");
682 # read in command aliases
683 dbg("Read in Aliases");
686 # initialise the Geomagnetic data engine
692 # initialise the protocol engine
693 dbg("Start Protocol Engines ...");
696 # read startup script
697 my $script = new Script "startup";
698 $script->run($main::me) if $script;
700 # put in a DXCluster node for us here so we can add users and take them away
701 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
702 $routeroot->do_pc9x(1);
703 $routeroot->via_pc92(1);
705 # make sure that there is a routing OUTPUT node default file
706 #unless (Filter::read_in('route', 'node_default', 0)) {
707 # my $dxcc = $main::me->dxcc;
708 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
711 # initial the Spot stuff
712 dbg("Starting DX Spot system");
715 # read in any existing message headers and clean out old crap
716 dbg("reading existing message headers ...");
720 # read in any cron jobs
721 dbg("reading cron jobs ...");
724 # read in database desriptors
725 dbg("reading database descriptors ...");
728 dbg("starting RBN ...");
731 # starting local stuff
732 dbg("doing local initialisation ...");
734 if (defined &Local::init) {
738 dbg("Local::init error $@") if $@;
742 # this, such as it is, is the main loop!
743 dbg("orft we jolly well go ...");
745 #open(DB::OUT, "|tee /tmp/aa");
748 our $io_disconnected;
753 # DXCommandmode::process(); # process ongoing command mode stuff
754 # DXProt::process(); # process ongoing ak1a pcxx stuff
756 if (defined &Local::process) {
758 Local::process(); # do any localised processing
760 dbg("Local::process error $@") if $@;
766 dbg("DXSpider Ending $ending");
768 unless ($io_disconnected++) {
771 foreach $dxchan (DXChannel::get_all_users) {
776 foreach $dxchan (DXChannel::get_all_nodes) {
777 next if $dxchan == $main::me;
778 $dxchan->disconnect(2);
780 $main::me->disconnect;
783 Mojo::IOLoop->stop_gracefully if --$ending <= 0;
793 my $days = int ($systime / 86400);
794 if ($systime_days != $days) {
795 $systime_days = $days;
796 $systime_daystart = $days * 86400;
798 IsoTime::update($systime);
799 DXCommandmode::process(); # process ongoing command mode stuff
800 DXProt::process(); # process ongoing ak1a pcxx stuff
802 DXConnect::process();
807 IsoTime::update($systime);
808 DXConnect::process();
811 DXCron::process(); # do cron jobs
830 RBN::per_10_minute();
845 dbg("Before Web::start_node");
847 Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
849 dbg("After Web::start_node");
854 my $main_loop = Mojo::IOLoop->recurring($idle_interval => \&idle_loop);
855 my $log_flush_loop = Mojo::IOLoop->recurring($log_flush_interval => \&DXLog::flushall);
856 my $cpusecs_loop = Mojo::IOLoop->recurring(5 => sub {my @t = times; $clssecs = $t[0]+$t[1]; $cldsecs = $t[2]+$t[3]});
857 my $persec = Mojo::IOLoop->recurring(1 => \&per_sec);
858 my $per10sec = Mojo::IOLoop->recurring(10 => \&per_10_sec);
859 my $permin = Mojo::IOLoop->recurring(60 => \&per_minute);
860 my $per10min = Mojo::IOLoop->recurring(600 => \&per_10_minute);
861 my $perhour = Mojo::IOLoop->recurring(3600 => \&per_hour);
862 my $perday = Mojo::IOLoop->recurring(86400 => \&per_day);