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
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
35 # make sure that modules are searched in the order local then perl
38 $SIG{'__WARN__'} = sub { warn $_[0] if $DOWARN };
40 # take into account any local::lib that might be present
44 import local::lib unless ($@);
46 # root of directory tree for this system
48 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
50 unshift @INC, "$root/perl"; # this IS the right way round!
51 unshift @INC, "$root/local";
53 # do some validation of the input
54 die "The directory $root doesn't exist, please RTFM" unless -d $root;
55 die "$root/local doesn't exist, please RTFM" unless -d "$root/local";
56 die "$root/local/DXVars.pm doesn't exist, please RTFM" unless -e "$root/local/DXVars.pm";
58 # create some directories
59 mkdir "$root/local_cmd", 02774 unless -d "$root/local_cmd";
61 # locally stored data lives here
62 my $local_data = "$root/local_data";
63 mkdir $local_data, 02774 unless -d $local_data;
65 # try to create and lock a lockfile (this isn't atomic but
67 $lockfn = "$root/local_data/cluster.lck"; # lock file name
69 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
74 warn "Lockfile ($lockfn) and process $pid exist, another cluster running?\n";
81 open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
85 $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
93 # order here is important - DXDebug snarfs Carp et al so that Mojo errors go into the debug log
156 use POSIX ":sys_wait_h";
159 use vars qw($version $build $gitversion $gitbranch);
166 @inqueue = (); # the main input queue, an array of hashes
167 $systime = 0; # the time now (in seconds)
168 $starttime = 0; # the starting time of the cluster
169 @outstanding_connects = (); # list of outstanding connects
170 @listeners = (); # list of listeners
171 $reqreg = 0; # 1 = registration required, 2 = deregister people
172 $bumpexisting = 1; # 1 = allow new connection to disconnect old, 0 - don't allow it
173 our $allowmultiple = 0; # This is used in conjunction with $bumpexisting, in a rather weird way.
174 our $min_reconnection_rate = 5*60; # minimum value of seconds between connections per user to allow co-existing users
175 our $max_ssid = 15; # highest ssid to be searched for a spare one on multiple connections
177 # If $allowmultiple > 0 and the $reconnection_rate is some value of seconds
178 # based on the average connection time calculated from the $user->conntimel entries / frequency is
179 # less than $reconnection_rate then we assume that there is more than one device (probably HRD) trying
180 # to connect "at once". In which case we probe for a spare SSID for a user callsign to allow up to
181 # $allowmultiple connections per callsign.
183 $allowdxby = 0; # 1 = allow "dx by <othercall>", 0 - don't allow it
184 $maxconnect_user = 3; # the maximum no of concurrent connections a user can have at a time
185 $maxconnect_node = 0; # Ditto but for nodes. In either case if a new incoming connection
186 # takes the no of references in the routing table above these numbers
187 # then the connection is refused. This only affects INCOMING connections.
188 $idle_interval = 0.500; # the wait between invocations of the main idle loop processing.
189 $log_flush_interval = 2; # interval to wait between log flushes
191 our $ending; # signal that we are ending;
192 our $broadcast_debug; # allow broadcasting of debug info down "enhanced" user connections
193 our $clssecs; # the amount of cpu time the DXSpider process have consumed
194 our $cldsecs; # the amount of cpu time any child processes have consumed
195 our $allowslashcall; # Allow / in connecting callsigns (ie PA0/G1TLH, or even PA0/G1TLH/2)
198 # send a message to call on conn and disconnect
201 my ($conn, $call, $mess) = @_;
203 $conn->disable_read(1);
204 dbg("-> D $call $mess\n") if isdbg('chan');
205 $conn->send_now("D$call|$mess");
210 # handle incoming messages
213 my ($conn, $msg) = @_;
214 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
215 return unless defined $sort;
219 if (is_webcall($call) && $conn->isa('IntMsg')) {
220 my $newcall = find_next_webcall();
222 already_conn($conn, $call, "Maximum no of web connected connects ($Web::maxssid) exceeded");
226 $user = DXUser::get_current($call);
228 $user = DXUser->new($call);
232 $user->qth('on the web');
233 $user->homenode($main::mycall);
234 $user->lat($main::mylatitude);
235 $user->long($main::mylongitude);
236 $user->qra($main::mylocator);
238 $user->startt($main::systime);
240 $dxchan = Web->new($call, $conn, $user);
241 $dxchan->enhanced(1);
243 $msg =~ s/^A#WEB|/A$call|/;
244 $conn->send_now("C$call");
246 # "Normal" connections
247 unless (is_callsign($call)) {
248 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
253 $user = DXUser::get_current($call);
255 my $basecall = $call;
256 $basecall =~ s/-\d+$//; # remember this for later multiple user processing
259 # make sure we act on any locked status that the actual incoming call has.
260 $lock = $user->lockout;
261 } elsif ($allowmultiple && $call ne $basecall) {
262 # if we are allowing multiple connections and there is a basecall minus incoming ssid, use the basecall's lock status
263 $user = DXUser::get_current($basecall);
264 $lock = $user->lockout if $user;
267 # now deal with the lock
269 my $host = $conn->peerhost;
270 LogDbg('', "$call on $host is locked out, disconnected");
275 # set up the basic channel info for "Normal" Users
276 # is there one already connected to me - locally?
278 $dxchan = DXChannel::get($call);
281 if ($user && $user->is_node) {
282 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
285 if ($allowmultiple && $user->is_user) {
286 # determine whether we are a candidate, have we flip-flopped frequently enough?
287 my @lastconns = @{$user->connlist} if $user->connlist;
289 if (@lastconns >= $DXUser::maxconnlist) {
290 $allow = $lastconns[-1]->[0] - $lastconns[0]->[0] < $min_reconnection_rate;
292 # search for a spare ssid
293 L1: for (my $count = $call =~ /-\d+$/?0:1; $allow && $count < $allowmultiple; ) { # remember we have one call already
295 for (; $lastid < $max_ssid && $count < $allowmultiple; ++$lastid) {
296 my $chan = DXChannel::get("$basecall-$lastid");
301 # we have a free call-ssid, save it
302 $newcall = "$basecall-$lastid";
308 # handle "normal" (non-multiple) connections in the existing way
309 if ($call eq $newcall) {
311 my $ip = $dxchan->hostname;
312 $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
313 LogDbg('', "$call bumped off by $ip, disconnected");
316 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
321 # make sure that the conn has the (possibly) new callsign
322 $conn->conns($newcall);
323 $msg =~ s/$call/$newcall/;
327 # (fairly) politely disconnect people that are connected to too many other places at once
328 my $r = Route::get($call);
329 if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
331 my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
332 my $c = $user->maxconnect;
334 $v = defined $c ? $c : $m;
335 if ($v && @n >= $v+$allowmultiple) {
336 my $nodes = join ',', @n;
337 LogDbg('', "$call has too many connections ($v) at $nodes - disconnected");
338 already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
344 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
346 $user = DXUser->new($call);
350 # NOTE we are SHARING the same $user if $allowmultiple is > 1
352 $user->startt($systime); # mark the start time of this connection
353 if ($user->is_node) {
354 $dxchan = DXProt->new($call, $conn, $user);
355 } elsif ($user->is_rbn) {
356 $dxchan = RBN->new($newcall, $conn, $user);
357 } elsif ($user->is_user) {
358 $dxchan = DXCommandmode->new($newcall, $conn, $user);
360 die "Invalid sort of user on $call = $sort";
366 $conn->set_error(sub {my $err = shift; LogDbg('', "Comms error '$err' received for call $dxchan->{call}"); $dxchan->disconnect(1);});
367 $conn->set_on_eof(sub {$dxchan->disconnect});
368 $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
370 $dxchan->enhanced(1);
379 return \&new_channel;
384 # cease running this program, close down all the connections nicely
389 cluck("ceasing") if $ceasing;
391 return if $ceasing++;
394 $SIG{'TERM'} = 'IGNORE';
395 $SIG{'INT'} = 'IGNORE';
399 if (defined &Local::finish) {
401 Local::finish(); # end local processing
403 dbg("Local::finish error $@") if $@;
411 # disconnect UDP customers
414 # end everything else
418 # close all databases
421 # close all listeners
422 foreach my $l (@listeners) {
426 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitbranch/$gitversion) ended");
427 dbg("bye bye everyone - bye bye");
431 $dbh->finish if $dbh;
436 # the reaper of children
440 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
441 dbg("cpid: $cpid") if isdbg('reap');
442 # Msg->pid_gone($cpid);
443 $zombies-- if $zombies > 0;
445 dbg("cpid: $cpid") if isdbg('reap');
448 # this is where the input queue is dealt with and things are dispatched off to other parts of
453 my $t = $systime - $starttime;
454 my $days = int $t / 86400;
456 my $hours = int $t / 3600;
458 my $mins = int $t / 60;
459 return sprintf "%d %02d:%02d", $days, $hours, $mins;
464 AGWMsg::init(\&new_channel);
471 #############################################################
473 # The start of the main line of code
475 #############################################################
477 $starttime = $systime = time;
478 $systime_days = int ($systime / 86400);
479 $systime_daystart = $systime_days * 86400;
480 $lang = 'en' unless $lang;
482 unless ($DB::VERSION) {
483 $SIG{INT} = $SIG{TERM} = \&cease;
486 # open the debug file, set various FHs to be unbuffered
487 dbginit($broadcast_debug ? \&DXCommandmode::broadcast_debug : undef);
491 STDOUT->autoflush(1);
494 # try to load the database
495 if (DXSql::init($dsn)) {
496 $dbh = DXSql->new($dsn);
497 $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
500 # try to load Encode and Git
503 my $w = $SIG{__DIE__};
504 $SIG{__DIE__} = 'IGNORE';
505 eval { require Encode; };
511 $gitversion = 'none';
512 eval { require Git; };
516 # determine the real version number
517 my $repo = Git->repository(Directory => "$root/.git");
519 my $desc = $repo->command_oneline(['describe', '--long'], STDERR => 0);
521 my ($v, $s, $b, $g) = $desc =~ /^([\d.]+)(?:\.(\d+))?-(\d+)-g([0-9a-f]+)/;
523 dbg("Git: $desc") if isdbg('git');
524 dbg("Git: V=$v S=$s B=$b g=$g") if isdbg('git');
527 $gitversion = "$g\[r]";
529 my @branch = $repo->command([qw{branch}], STDERR=>0);
531 my ($star, $b) = split /\s+/;
542 # try to load XML::Simple
546 my ($year) = (gmtime)[5];
548 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitbranch/$gitversion) started");
549 dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
552 dbg("loading prefixes ...");
554 my $r = Prefix::init();
558 dbg("loading band data ...");
561 # initialise User file system
562 dbg("loading user file system ...");
563 DXUser::init(4); # version 4 == json format
565 # look for the sysop and the alias user and complain if they aren't there
567 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;
568 my $ref = DXUser::get($mycall);
569 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
570 my $oldsort = $ref->sort;
571 if ($oldsort ne 'S') {
573 dbg("Resetting node type from $oldsort -> DXSpider ('S')");
575 $ref = DXUser::get($myalias);
576 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
577 $oldsort = $ref->sort;
578 if ($oldsort ne 'U') {
580 dbg("Resetting sysop user type from $oldsort -> User ('U')");
584 # start listening for incoming messages/connects
585 dbg("starting listeners ...");
586 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
587 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
588 push @listeners, $conn;
589 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
590 foreach my $l (@main::listen) {
592 my $pkg = $l->[2] || 'ExtMsg';
593 my $login = $l->[3] || 'login';
595 $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
596 $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
597 push @listeners, $conn;
598 dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
601 dbg("AGW Listener") if $AGWMsg::enable;
604 dbg("BPQ Listener") if $BPQMsg::enable;
605 BPQMsg::init(\&new_channel);
607 dbg("UDP Listener") if $UDPMsg::enable;
608 UDPMsg::init(\&new_channel);
611 dbg("load badwords: " . (BadWords::load or "Ok"));
614 unless ($DB::VERSION) {
615 $SIG{INT} = $SIG{TERM} = sub { $ending = 10; };
619 $SIG{HUP} = 'IGNORE';
620 $SIG{CHLD} = sub { $zombies++ };
622 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
623 $SIG{IO} = sub { dbg("SIGIO received"); };
624 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
625 $SIG{KILL} = 'DEFAULT'; # as if it matters....
627 # catch the rest with a hopeful message
630 # dbg("Catching SIG $_") if isdbg('chan');
631 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
637 dbg("Starting Dupe system");
640 # read in system messages
641 dbg("Read in Messages");
644 # read in command aliases
645 dbg("Read in Aliases");
648 # initialise the Geomagnetic data engine
654 # initial the Spot stuff
655 dbg("Starting DX Spot system");
658 # initialise the protocol engine
659 dbg("Start Protocol Engines ...");
662 # put in a DXCluster node for us here so we can add users and take them away
663 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
664 $routeroot->do_pc9x(1);
665 $routeroot->via_pc92(1);
667 # make sure that there is a routing OUTPUT node default file
668 #unless (Filter::read_in('route', 'node_default', 0)) {
669 # my $dxcc = $main::me->dxcc;
670 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
673 # read in any existing message headers and clean out old crap
674 dbg("reading existing message headers ...");
678 # read in any cron jobs
679 dbg("reading cron jobs ...");
682 # read in database desriptors
683 dbg("reading database descriptors ...");
686 # starting local stuff
687 dbg("doing local initialisation ...");
689 if (defined &Local::init) {
693 dbg("Local::init error $@") if $@;
697 # this, such as it is, is the main loop!
698 dbg("orft we jolly well go ...");
699 my $script = new Script "startup";
700 $script->run($main::me) if $script;
702 #open(DB::OUT, "|tee /tmp/aa");
705 our $io_disconnected;
710 # DXCommandmode::process(); # process ongoing command mode stuff
711 # DXProt::process(); # process ongoing ak1a pcxx stuff
713 if (defined &Local::process) {
715 Local::process(); # do any localised processing
717 dbg("Local::process error $@") if $@;
723 dbg("DXSpider Ending $ending");
725 unless ($io_disconnected++) {
728 foreach $dxchan (DXChannel::get_all_users) {
733 foreach $dxchan (DXChannel::get_all_nodes) {
734 next if $dxchan == $main::me;
735 $dxchan->disconnect(2);
737 $main::me->disconnect;
740 Mojo::IOLoop->stop if --$ending <= 0;
750 my $days = int ($systime / 86400);
751 if ($systime_days != $days) {
752 $systime_days = $days;
753 $systime_daystart = $days * 86400;
755 IsoTime::update($systime);
756 DXCommandmode::process(); # process ongoing command mode stuff
757 DXProt::process(); # process ongoing ak1a pcxx stuff
759 DXConnect::process();
764 IsoTime::update($systime);
765 DXConnect::process();
768 DXCron::process(); # do cron jobs
786 RBN::per_10_minute();
801 dbg("Before Web::start_node");
803 Mojo::IOLoop->start unless Mojo::IOLoop->is_running;
805 dbg("After Web::start_node");
810 my $main_loop = Mojo::IOLoop->recurring($idle_interval => \&idle_loop);
811 my $log_flush_loop = Mojo::IOLoop->recurring($log_flush_interval => \&DXLog::flushall);
812 my $cpusecs_loop = Mojo::IOLoop->recurring(5 => sub {my @t = times; $clssecs = $t[0]+$t[1]; $cldsecs = $t[2]+$t[3]});
813 my $persec = Mojo::IOLoop->recurring(1 => \&per_sec);
814 my $per10sec = Mojo::IOLoop->recurring(10 => \&per_10_sec);
815 my $permin = Mojo::IOLoop->recurring(60 => \&per_minute);
816 my $per10min = Mojo::IOLoop->recurring(600 => \&per_10_minute);
817 my $perhour = Mojo::IOLoop->recurring(3600 => \&per_hour);
818 my $perday = Mojo::IOLoop->recurring(86400 => \&per_day);