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
15 # make sure that modules are searched in the order local then perl
19 # root of directory tree for this system
21 $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
23 unshift @INC, "$root/perl"; # this IS the right way round!
24 unshift @INC, "$root/local";
26 # do some validation of the input
27 die "The directory $root doesn't exist, please RTFM" unless -d $root;
28 die "$root/local doesn't exist, please RTFM" unless -d "$root/local";
29 die "$root/local/DXVars.pm doesn't exist, please RTFM" unless -e "$root/local/DXVars.pm";
31 mkdir "$root/local_cmd", 0777 unless -d "$root/local_cmd";
34 # try to create and lock a lockfile (this isn't atomic but
36 $lockfn = "$root/local/cluster.lck"; # lock file name
38 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
42 die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
47 open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
51 $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
114 use POSIX ":sys_wait_h";
123 use vars qw(@inqueue $systime $starttime $lockfn @outstanding_connects
124 $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
125 $clusterport $mycall $decease $is_win $routeroot $me $reqreg $bumpexisting
126 $allowdxby $dbh $dsn $dbuser $dbpass $do_xml $systime_days $systime_daystart
127 $can_encode $maxconnect_user $maxconnect_node $idle_interval $log_flush_interval
131 @inqueue = (); # the main input queue, an array of hashes
132 $systime = 0; # the time now (in seconds)
133 $starttime = 0; # the starting time of the cluster
134 @outstanding_connects = (); # list of outstanding connects
135 @listeners = (); # list of listeners
136 $reqreg = 0; # 1 = registration required, 2 = deregister people
137 $bumpexisting = 1; # 1 = allow new connection to disconnect old, 0 - don't allow it
138 $allowdxby = 0; # 1 = allow "dx by <othercall>", 0 - don't allow it
139 $maxconnect_user = 3; # the maximum no of concurrent connections a user can have at a time
140 $maxconnect_node = 0; # Ditto but for nodes. In either case if a new incoming connection
141 # takes the no of references in the routing table above these numbers
142 # then the connection is refused. This only affects INCOMING connections.
143 $idle_interval = 0.500; # the wait between invocations of the main idle loop processing.
144 $log_flush_interval = 2; # interval to wait between log flushes
146 our $ending; # signal that we are ending;
147 our $broadcast_debug; # allow broadcasting of debug info down "enhanced" user connections
151 # send a message to call on conn and disconnect
154 my ($conn, $call, $mess) = @_;
156 $conn->disable_read(1);
157 dbg("-> D $call $mess\n") if isdbg('chan');
158 $conn->send_now("D$call|$mess");
163 # handle incoming messages
166 my ($conn, $msg) = @_;
167 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
168 return unless defined $sort;
170 unless (is_callsign($call)) {
171 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
175 # set up the basic channel info
176 # is there one already connected to me - locally?
177 my $user = DXUser::get_current($call);
178 my $dxchan = DXChannel::get($call);
180 if ($user && $user->is_node) {
181 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
185 my $ip = $conn->peerhost || 'unknown';
186 $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
187 LogDbg('DXCommand', "$call bumped off by $ip, disconnected");
190 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
195 # (fairly) politely disconnect people that are connected to too many other places at once
196 my $r = Route::get($call);
197 if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
199 my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
200 my $c = $user->maxconnect;
202 $v = defined $c ? $c : $m;
203 if ($v && @n >= $v) {
204 my $nodes = join ',', @n;
205 LogDbg('DXCommand', "$call has too many connections ($v) at $nodes - disconnected");
206 already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
212 my $basecall = $call;
213 $basecall =~ s/-\d+$//;
214 my $baseuser = DXUser::get_current($basecall);
215 my $lock = $user->lockout if $user;
216 if ($baseuser && $baseuser->lockout || $lock) {
217 if (!$user || !defined $lock || $lock) {
218 my $host = $conn->peerhost || "unknown";
219 LogDbg('DXCommand', "$call on $host is locked out, disconnected");
226 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
228 $user = DXUser->new($call);
232 if ($user->is_node) {
233 $dxchan = DXProt->new($call, $conn, $user);
234 } elsif ($user->is_user) {
235 $dxchan = DXCommandmode->new($call, $conn, $user);
236 # } elsif ($user->is_bbs) { # there is no support so
237 # $dxchan = BBS->new($call, $conn, $user); # don't allow it!!!
239 die "Invalid sort of user on $call = $sort";
242 # check that the conn has a callsign
243 $conn->conns($call) if $conn->isa('IntMsg');
246 $conn->set_error(sub {my $err = shift; LogDbg('DXCommand', "Comms error '$err' received for call $dxchan->{call}"); $dxchan->disconnect(1);});
247 $conn->set_on_eof(sub {$dxchan->disconnect});
248 $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
255 return \&new_channel;
260 # cease running this program, close down all the connections nicely
265 cluck("ceasing") if $ceasing;
267 return if $ceasing++;
270 $SIG{'TERM'} = 'IGNORE';
271 $SIG{'INT'} = 'IGNORE';
276 if (defined &Local::finish) {
278 Local::finish(); # end local processing
280 dbg("Local::finish error $@") if $@;
288 # disconnect UDP customers
291 # end everything else
295 # close all databases
298 # close all listeners
299 foreach my $l (@listeners) {
303 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitversion) ended");
304 dbg("bye bye everyone - bye bye");
308 $dbh->finish if $dbh;
313 # the reaper of children
317 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
318 dbg("cpid: $cpid") if isdbg('reap');
319 # Msg->pid_gone($cpid);
320 $zombies-- if $zombies > 0;
322 dbg("cpid: $cpid") if isdbg('reap');
325 # this is where the input queue is dealt with and things are dispatched off to other parts of
330 my $t = $systime - $starttime;
331 my $days = int $t / 86400;
333 my $hours = int $t / 3600;
335 my $mins = int $t / 60;
336 return sprintf "%d %02d:%02d", $days, $hours, $mins;
341 AGWMsg::init(\&new_channel);
344 our $io_disconnected;
351 # DXChannel::process();
355 # do timed stuff, ongoing processing happens one a second
356 if ($timenow != $systime) {
359 my $days = int ($systime / 86400);
360 if ($systime_days != $days) {
361 $systime_days = $days;
362 $systime_daystart = $days * 86400;
364 IsoTime::update($systime);
365 DXCron::process(); # do cron jobs
366 DXCommandmode::process(); # process ongoing command mode stuff
368 DXProt::process(); # process ongoing ak1a pcxx stuff
369 DXConnect::process();
374 DXCron::process(); # do cron jobs
375 IsoTime::update($systime);
376 DXProt::process(); # process ongoing ak1a pcxx stuff
377 DXConnect::process();
385 if (defined &Local::process) {
387 Local::process(); # do any localised processing
389 dbg("Local::process error $@") if $@;
395 dbg("DXSpider Ending $ending");
397 unless ($io_disconnected++) {
400 foreach $dxchan (DXChannel::get_all_users) {
405 foreach $dxchan (DXChannel::get_all_nodes) {
406 next if $dxchan == $main::me;
407 $dxchan->disconnect(2);
409 $main::me->disconnect;
412 Mojo::IOLoop->stop if --$ending <= 0;
419 #############################################################
421 # The start of the main line of code
423 #############################################################
425 $starttime = $systime = time;
426 $systime_days = int ($systime / 86400);
427 $systime_daystart = $systime_days * 86400;
428 $lang = 'en' unless $lang;
430 unless ($DB::VERSION) {
431 $SIG{INT} = $SIG{TERM} = \&cease;
434 # open the debug file, set various FHs to be unbuffered
435 dbginit($broadcast_debug ? \&DXCommandmode::broadcast_debug : undef);
439 STDOUT->autoflush(1);
441 # try to load the database
442 if (DXSql::init($dsn)) {
443 $dbh = DXSql->new($dsn);
444 $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
447 # try to load Encode and Git
450 my $w = $SIG{__DIE__};
451 $SIG{__DIE__} = 'IGNORE';
452 eval { require Encode; };
457 eval { require Git; };
461 # determine the real version number
462 my $repo = Git->repository(Directory => "$root/.git");
464 my $desc = $repo->command_oneline(['describe', '--long'], STDERR => 0);
466 my ($v, $s, $b, $g) = $desc =~ /^([\d.]+)(?:\.(\d+))?-(\d+)-g([0-9a-f]+)/;
469 $gitversion = "$g\[r]";
476 # try to load XML::Simple
480 my ($year) = (gmtime)[5];
482 LogDbg('cluster', "DXSpider V$version, build $build (git: $gitversion) started");
483 dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
486 dbg("loading prefixes ...");
488 my $r = Prefix::init();
492 dbg("loading band data ...");
495 # initialise User file system
496 dbg("loading user file system ...");
497 DXUser->init($userfn, 1);
499 # look for the sysop and the alias user and complain if they aren't there
501 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;
502 my $ref = DXUser::get($mycall);
503 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
504 $ref = DXUser::get($myalias);
505 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
508 # start listening for incoming messages/connects
509 dbg("starting listeners ...");
510 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
511 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
512 push @listeners, $conn;
513 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
514 foreach my $l (@main::listen) {
516 my $pkg = $l->[2] || 'ExtMsg';
517 my $login = $l->[3] || 'login';
519 $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
520 $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
521 push @listeners, $conn;
522 dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
525 dbg("AGW Listener") if $AGWMsg::enable;
528 dbg("BPQ Listener") if $BPQMsg::enable;
529 BPQMsg::init(\&new_channel);
531 dbg("UDP Listener") if $UDPMsg::enable;
532 UDPMsg::init(\&new_channel);
535 dbg("load badwords: " . (BadWords::load or "Ok"));
538 unless ($DB::VERSION) {
539 $SIG{INT} = $SIG{TERM} = sub { $ending = 10; };
543 $SIG{HUP} = 'IGNORE';
544 $SIG{CHLD} = sub { $zombies++ };
546 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
547 $SIG{IO} = sub { dbg("SIGIO received"); };
548 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
549 $SIG{KILL} = 'DEFAULT'; # as if it matters....
551 # catch the rest with a hopeful message
554 # dbg("Catching SIG $_") if isdbg('chan');
555 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
561 dbg("Starting Dupe system");
564 # read in system messages
565 dbg("Read in Messages");
568 # read in command aliases
569 dbg("Read in Aliases");
572 # initialise the Geomagnetic data engine
578 # initial the Spot stuff
579 dbg("Starting DX Spot system");
582 # initialise the protocol engine
583 dbg("Start Protocol Engines ...");
586 # put in a DXCluster node for us here so we can add users and take them away
587 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
588 $routeroot->do_pc9x(1);
589 $routeroot->via_pc92(1);
591 # make sure that there is a routing OUTPUT node default file
592 #unless (Filter::read_in('route', 'node_default', 0)) {
593 # my $dxcc = $main::me->dxcc;
594 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
597 # read in any existing message headers and clean out old crap
598 dbg("reading existing message headers ...");
602 # read in any cron jobs
603 dbg("reading cron jobs ...");
606 # read in database desriptors
607 dbg("reading database descriptors ...");
610 # starting local stuff
611 dbg("doing local initialisation ...");
613 if (defined &Local::init) {
617 dbg("Local::init error $@") if $@;
621 # this, such as it is, is the main loop!
622 dbg("orft we jolly well go ...");
623 my $script = new Script "startup";
624 $script->run($main::me) if $script;
626 #open(DB::OUT, "|tee /tmp/aa");
632 my $main_loop = Mojo::IOLoop->recurring($idle_interval => \&idle_loop);
633 my $log_flush_loop = Mojo::IOLoop->recurring($log_flush_interval => \&DXLog::flushall);