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
18 use vars qw($root $is_win $systime $lockfn @inqueue $starttime $lockfn @outstanding_connects
19 $zombies @listeners $lang $myalias @debug $userfn $clusteraddr
20 $clusterport $mycall $decease $routeroot $me $reqreg $bumpexisting
21 $allowdxby $dbh $dsn $dbuser $dbpass $do_xml $systime_days $systime_daystart
22 $can_encode $maxconnect_user $maxconnect_node $idle_interval $log_flush_interval
26 $lang = 'en'; # default language
27 $clusteraddr = '127.0.0.1'; # cluster tcp host address - used for things like console.pl
28 $clusterport = 27754; # cluster tcp port
29 $yes = 'Yes'; # visual representation of yes
30 $no = 'No'; # ditto for no
31 $user_interval = 11*60; # the interval between unsolicited prompts if no traffic
33 # make sure that modules are searched in the order local then perl
37 # take into account any local::lib that might be present
41 import local::lib unless ($@);
43 # root of directory tree for this system
45 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
47 unshift @INC, "$root/perl"; # this IS the right way round!
48 unshift @INC, "$root/local";
50 # do some validation of the input
51 die "The directory $root doesn't exist, please RTFM" unless -d $root;
52 die "$root/local doesn't exist, please RTFM" unless -d "$root/local";
53 die "$root/local/DXVars.pm doesn't exist, please RTFM" unless -e "$root/local/DXVars.pm";
55 # create some directories
56 mkdir "$root/local_cmd", 02774 unless -d "$root/local_cmd";
58 # locally stored data lives here
59 my $local_data = "$root/local_data";
60 mkdir $local_data, 02774 unless -d $local_data;
62 # try to create and lock a lockfile (this isn't atomic but
64 $lockfn = "$root/local_data/cluster.lck"; # lock file name
66 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
71 warn "Lockfile ($lockfn) and process $pid exist, another cluster running?\n";
78 open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
82 $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
92 # order here is important - DXDebug snarfs Carp et al so that Mojo errors go into the debug log
155 use POSIX ":sys_wait_h";
158 use vars qw($version $build $gitversion $gitbranch);
163 @inqueue = (); # the main input queue, an array of hashes
164 $systime = 0; # the time now (in seconds)
165 $starttime = 0; # the starting time of the cluster
166 @outstanding_connects = (); # list of outstanding connects
167 @listeners = (); # list of listeners
168 $reqreg = 0; # 1 = registration required, 2 = deregister people
169 $bumpexisting = 1; # 1 = allow new connection to disconnect old, 0 - don't allow it
170 our $allowmultiple = 0; # This is used in conjunction with $bumpexisting, in a rather weird way.
171 our $min_reconnection_rate = 5*60; # minimum value of seconds between connections per user to allow co-existing users
172 our $max_ssid = 15; # highest ssid to be searched for a spare one on multiple connections
174 # If $allowmultiple > 0 and the $reconnection_rate is some value of seconds
175 # based on the average connection time calculated from the $user->conntimel entries / frequency is
176 # less than $reconnection_rate then we assume that there is more than one device (probably HRD) trying
177 # to connect "at once". In which case we probe for a spare SSID for a user callsign to allow up to
178 # $allowmultiple connections per callsign.
180 $allowdxby = 0; # 1 = allow "dx by <othercall>", 0 - don't allow it
181 $maxconnect_user = 3; # the maximum no of concurrent connections a user can have at a time
182 $maxconnect_node = 0; # Ditto but for nodes. In either case if a new incoming connection
183 # takes the no of references in the routing table above these numbers
184 # then the connection is refused. This only affects INCOMING connections.
185 $idle_interval = 0.500; # the wait between invocations of the main idle loop processing.
186 $log_flush_interval = 2; # interval to wait between log flushes
188 our $ending; # signal that we are ending;
189 our $broadcast_debug; # allow broadcasting of debug info down "enhanced" user connections
190 our $clssecs; # the amount of cpu time the DXSpider process have consumed
191 our $cldsecs; # the amount of cpu time any child processes have consumed
194 # send a message to call on conn and disconnect
197 my ($conn, $call, $mess) = @_;
199 $conn->disable_read(1);
200 dbg("-> D $call $mess\n") if isdbg('chan');
201 $conn->send_now("D$call|$mess");
206 # handle incoming messages
209 my ($conn, $msg) = @_;
210 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
211 return unless defined $sort;
215 if (is_webcall($call) && $conn->isa('IntMsg')) {
216 my $newcall = find_next_webcall();
218 already_conn($conn, $call, "Maximum no of web connected connects ($Web::maxssid) exceeded");
222 $user = DXUser::get_current($call);
224 $user = DXUser->new($call);
228 $user->qth('on the web');
229 $user->homenode($main::mycall);
230 $user->lat($main::mylatitude);
231 $user->long($main::mylongitude);
232 $user->qra($main::mylocator);
234 $user->startt($main::systime);
236 $dxchan = Web->new($call, $conn, $user);
237 $dxchan->enhanced(1);
239 $msg =~ s/^A#WEB|/A$call|/;
240 $conn->send_now("C$call");
242 # "Normal" connections
243 unless (is_callsign($call)) {
244 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
249 my $basecall = $call;
250 $basecall =~ s/-\d+$//; # remember this for later multiple user processing
251 my $baseuser = DXUser::get_current($basecall);
252 my $lock = $user->lockout if $user;
253 if ($baseuser && $baseuser->lockout || $lock) {
254 if (!$user || !defined $lock || $lock) {
255 my $host = $conn->peerhost;
256 LogDbg('DXCommand', "$call on $host is locked out, disconnected");
262 # set up the basic channel info for "Normal" Users
263 # is there one already connected to me - locally?
265 $user = DXUser::get_current($call);
266 $dxchan = DXChannel::get($call);
269 if ($user && $user->is_node) {
270 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
273 if ($allowmultiple && $user->is_user) {
274 # determine whether we are a candidate, have we flip-flopped frequently enough?
275 my @lastconns = @{$user->connlist} if $user->connlist;
277 if (@lastconns >= $DXUser::maxconnlist) {
278 $allow = $lastconns[-1]->[0] - $lastconns[0]->[0] < $min_reconnection_rate;
280 # search for a spare ssid
281 L1: for (my $count = $call =~ /-\d+$/?0:1; $allow && $count < $allowmultiple; ) { # remember we have one call already
283 for (; $lastid < $max_ssid && $count < $allowmultiple; ++$lastid) {
284 my $chan = DXChannel::get("$basecall-$lastid");
289 # we have a free call-ssid, save it
290 $newcall = "$basecall-$lastid";
296 # handle "normal" (non-multiple) connections in the existing way
297 if ($call eq $newcall) {
299 my $ip = $dxchan->hostname;
300 $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
301 LogDbg('DXCommand', "$call bumped off by $ip, disconnected");
304 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
309 # make sure that the conn has the (possibly) new callsign
310 $conn->conns($newcall);
311 $msg =~ s/$call/$newcall/;
315 # (fairly) politely disconnect people that are connected to too many other places at once
316 my $r = Route::get($call);
317 if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
319 my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
320 my $c = $user->maxconnect;
322 $v = defined $c ? $c : $m;
323 if ($v && @n >= $v+$allowmultiple) {
324 my $nodes = join ',', @n;
325 LogDbg('DXCommand', "$call has too many connections ($v) at $nodes - disconnected");
326 already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
332 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
334 $user = DXUser->new($call);
338 # NOTE we are SHARING the same $user if $allowmultiple is > 1
340 $user->startt($systime); # mark the start time of this connection
341 if ($user->is_node) {
342 $dxchan = DXProt->new($call, $conn, $user);
343 } elsif ($user->is_user) {
344 $dxchan = DXCommandmode->new($newcall, $conn, $user);
346 die "Invalid sort of user on $call = $sort";
352 $conn->set_error(sub {my $err = shift; LogDbg('DXCommand', "Comms error '$err' received for call $dxchan->{call}"); $dxchan->disconnect(1);});
353 $conn->set_on_eof(sub {$dxchan->disconnect});
354 $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
356 $dxchan->enhanced(1);
365 return \&new_channel;
370 # cease running this program, close down all the connections nicely
375 cluck("ceasing") if $ceasing;
377 return if $ceasing++;
380 $SIG{'TERM'} = 'IGNORE';
381 $SIG{'INT'} = 'IGNORE';
385 if (defined &Local::finish) {
387 Local::finish(); # end local processing
389 dbg("Local::finish error $@") if $@;
397 # disconnect UDP customers
400 # end everything else
404 # close all databases
407 # close all listeners
408 foreach my $l (@listeners) {
412 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitbranch/$gitversion) ended");
413 dbg("bye bye everyone - bye bye");
417 $dbh->finish if $dbh;
422 # the reaper of children
426 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
427 dbg("cpid: $cpid") if isdbg('reap');
428 # Msg->pid_gone($cpid);
429 $zombies-- if $zombies > 0;
431 dbg("cpid: $cpid") if isdbg('reap');
434 # this is where the input queue is dealt with and things are dispatched off to other parts of
439 my $t = $systime - $starttime;
440 my $days = int $t / 86400;
442 my $hours = int $t / 3600;
444 my $mins = int $t / 60;
445 return sprintf "%d %02d:%02d", $days, $hours, $mins;
450 AGWMsg::init(\&new_channel);
457 #############################################################
459 # The start of the main line of code
461 #############################################################
463 $starttime = $systime = time;
464 $systime_days = int ($systime / 86400);
465 $systime_daystart = $systime_days * 86400;
466 $lang = 'en' unless $lang;
468 unless ($DB::VERSION) {
469 $SIG{INT} = $SIG{TERM} = \&cease;
472 # open the debug file, set various FHs to be unbuffered
473 dbginit($broadcast_debug ? \&DXCommandmode::broadcast_debug : undef);
477 STDOUT->autoflush(1);
480 # try to load the database
481 if (DXSql::init($dsn)) {
482 $dbh = DXSql->new($dsn);
483 $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
486 # try to load Encode and Git
489 my $w = $SIG{__DIE__};
490 $SIG{__DIE__} = 'IGNORE';
491 eval { require Encode; };
497 $gitversion = 'none';
498 eval { require Git; };
502 # determine the real version number
503 my $repo = Git->repository(Directory => "$root/.git");
505 my $desc = $repo->command_oneline(['describe', '--long'], STDERR => 0);
507 my ($v, $s, $b, $g) = $desc =~ /^([\d.]+)(?:\.(\d+))?-(\d+)-g([0-9a-f]+)/;
510 dbg("Git: V=$v S=$s B=$b g=$g");
513 $gitversion = "$g\[r]";
515 my @branch = $repo->command([qw{branch}], STDERR=>0);
517 my ($star, $b) = split /\s+/;
528 # try to load XML::Simple
532 my ($year) = (gmtime)[5];
534 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitbranch/$gitversion) started");
535 dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
538 dbg("loading prefixes ...");
540 my $r = Prefix::init();
544 dbg("loading band data ...");
547 # initialise User file system
548 dbg("loading user file system ...");
549 DXUser::init(4); # version 4 == json format
551 # look for the sysop and the alias user and complain if they aren't there
553 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;
554 my $ref = DXUser::get($mycall);
555 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
556 my $oldsort = $ref->sort;
557 if ($oldsort ne 'S') {
559 dbg "Resetting node type from $oldsort -> DXSpider ('S')";
561 $ref = DXUser::get($myalias);
562 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
563 $oldsort = $ref->sort;
564 if ($oldsort ne 'U') {
566 dbg "Resetting sysop user type from $oldsort -> User ('U')";
570 # start listening for incoming messages/connects
571 dbg("starting listeners ...");
572 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
573 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
574 push @listeners, $conn;
575 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
576 foreach my $l (@main::listen) {
578 my $pkg = $l->[2] || 'ExtMsg';
579 my $login = $l->[3] || 'login';
581 $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
582 $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
583 push @listeners, $conn;
584 dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
587 dbg("AGW Listener") if $AGWMsg::enable;
590 dbg("BPQ Listener") if $BPQMsg::enable;
591 BPQMsg::init(\&new_channel);
593 dbg("UDP Listener") if $UDPMsg::enable;
594 UDPMsg::init(\&new_channel);
597 dbg("load badwords: " . (BadWords::load or "Ok"));
600 unless ($DB::VERSION) {
601 $SIG{INT} = $SIG{TERM} = sub { $ending = 10; };
605 $SIG{HUP} = 'IGNORE';
606 $SIG{CHLD} = sub { $zombies++ };
608 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
609 $SIG{IO} = sub { dbg("SIGIO received"); };
610 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
611 $SIG{KILL} = 'DEFAULT'; # as if it matters....
613 # catch the rest with a hopeful message
616 # dbg("Catching SIG $_") if isdbg('chan');
617 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
623 dbg("Starting Dupe system");
626 # read in system messages
627 dbg("Read in Messages");
630 # read in command aliases
631 dbg("Read in Aliases");
634 # initialise the Geomagnetic data engine
640 # initial the Spot stuff
641 dbg("Starting DX Spot system");
644 # initialise the protocol engine
645 dbg("Start Protocol Engines ...");
648 # put in a DXCluster node for us here so we can add users and take them away
649 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
650 $routeroot->do_pc9x(1);
651 $routeroot->via_pc92(1);
653 # make sure that there is a routing OUTPUT node default file
654 #unless (Filter::read_in('route', 'node_default', 0)) {
655 # my $dxcc = $main::me->dxcc;
656 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
659 # read in any existing message headers and clean out old crap
660 dbg("reading existing message headers ...");
664 # read in any cron jobs
665 dbg("reading cron jobs ...");
668 # read in database desriptors
669 dbg("reading database descriptors ...");
672 # starting local stuff
673 dbg("doing local initialisation ...");
675 if (defined &Local::init) {
679 dbg("Local::init error $@") if $@;
683 # this, such as it is, is the main loop!
684 dbg("orft we jolly well go ...");
685 my $script = new Script "startup";
686 $script->run($main::me) if $script;
688 #open(DB::OUT, "|tee /tmp/aa");
691 our $io_disconnected;
696 # DXCommandmode::process(); # process ongoing command mode stuff
697 # DXProt::process(); # process ongoing ak1a pcxx stuff
699 if (defined &Local::process) {
701 Local::process(); # do any localised processing
703 dbg("Local::process error $@") if $@;
709 dbg("DXSpider Ending $ending");
711 unless ($io_disconnected++) {
714 foreach $dxchan (DXChannel::get_all_users) {
719 foreach $dxchan (DXChannel::get_all_nodes) {
720 next if $dxchan == $main::me;
721 $dxchan->disconnect(2);
723 $main::me->disconnect;
726 Mojo::IOLoop->stop if --$ending <= 0;
736 my $days = int ($systime / 86400);
737 if ($systime_days != $days) {
738 $systime_days = $days;
739 $systime_daystart = $days * 86400;
741 IsoTime::update($systime);
742 DXCommandmode::process(); # process ongoing command mode stuff
743 DXProt::process(); # process ongoing ak1a pcxx stuff
744 DXCron::process(); # do cron jobs
746 DXConnect::process();
751 DXCron::process(); # do cron jobs
752 IsoTime::update($systime);
753 DXConnect::process();
789 dbg("Before Web::start_node");
791 Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
793 dbg("After Web::start_node");
798 my $main_loop = Mojo::IOLoop->recurring($idle_interval => \&idle_loop);
799 my $log_flush_loop = Mojo::IOLoop->recurring($log_flush_interval => \&DXLog::flushall);
800 my $cpusecs_loop = Mojo::IOLoop->recurring(5 => sub {my @t = times; $clssecs = $t[0]+$t[1]; $cldsecs = $t[2]+$t[3]});
801 my $persec = Mojo::IOLoop->recurring(1 => \&per_sec);
802 my $per10sec = Mojo::IOLoop->recurring(10 => \&per_10_sec);
803 my $permin = Mojo::IOLoop->recurring(60 => \&per_minute);
804 my $per10min = Mojo::IOLoop->recurring(600 => \&per_10_minute);
805 my $perhour = Mojo::IOLoop->recurring(3600 => \&per_hour);
806 my $perday = Mojo::IOLoop->recurring(86400 => \&per_day);