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) $!";
41 die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
44 open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
48 $is_win = ($^O =~ /^MS/ || $^O =~ /^OS-2/) ? 1 : 0; # is it Windows?
109 use POSIX ":sys_wait_h";
116 use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects
117 $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
118 $clusterport $mycall $decease $is_win $routeroot $me $reqreg
121 @inqueue = (); # the main input queue, an array of hashes
122 $systime = 0; # the time now (in seconds)
123 $version = "1.51"; # the version no of the software
124 $starttime = 0; # the starting time of the cluster
125 #@outstanding_connects = (); # list of outstanding connects
126 @listeners = (); # list of listeners
127 $reqreg = 0; # 1 = registration required, 2 = deregister people
129 use vars qw($VERSION $BRANCH $build $branch);
130 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
131 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
132 $main::build += 2; # add an offset to make it bigger than last system
133 $main::build += $VERSION;
134 $main::branch += $BRANCH;
137 # send a message to call on conn and disconnect
140 my ($conn, $call, $mess) = @_;
142 $conn->disable_read(1);
143 dbg("-> D $call $mess\n") if isdbg('chan');
144 $conn->send_now("D$call|$mess");
152 $dxchan->{conn}->set_error(undef) if exists $dxchan->{conn};
153 $dxchan->disconnect(1);
156 # handle incoming messages
159 my ($conn, $msg) = @_;
160 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
161 return unless defined $sort;
163 unless (is_callsign($call)) {
164 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
168 # set up the basic channel info
169 # is there one already connected to me - locally?
170 my $user = DXUser->get_current($call);
171 my $dxchan = DXChannel->get($call);
173 my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call, $main::mycall);
174 already_conn($conn, $call, $mess);
179 my $basecall = $call;
180 $basecall =~ s/-\d+$//;
181 my $baseuser = DXUser->get_current($basecall);
182 my $lock = $user->lockout if $user;
183 if ($baseuser && $baseuser->lockout || $lock) {
184 if (!$user || !defined $lock || $lock) {
185 my $host = $conn->{peerhost} || "unknown";
186 Log('DXCommand', "$call on $host is locked out, disconnected");
193 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
195 $user = DXUser->new($call);
201 if ($user->passphrase && $main::me->user->passphrase) {
202 $dxchan = QXProt->new($call, $conn, $user);
204 unless ($user->passphrase) {
205 Log('DXCommand', "$call using NP but has no passphrase");
206 dbg("$call using NP but has no passphrase");
208 unless ($main::me->user->passphrase) {
209 Log('DXCommand', "$main::mycall using NP but has no passphrase");
210 dbg("$main::mycall using NP but has no passphrase");
212 already_conn($conn, $call, "Need to exchange passphrases");
215 } elsif ($user->is_node) {
216 $dxchan = DXProt->new($call, $conn, $user);
217 } elsif ($user->is_user) {
218 $dxchan = DXCommandmode->new($call, $conn, $user);
219 } elsif ($user->is_bbs) {
220 $dxchan = BBS->new($call, $conn, $user);
222 die "Invalid sort of user on $call = $sort";
225 # check that the conn has a callsign
226 $conn->conns($call) if $conn->isa('IntMsg');
229 $conn->set_error(sub {error_handler($dxchan)});
230 $conn->set_rproc(sub {my ($conn,$msg) = @_; rec($dxchan, $conn, $msg);});
231 rec($dxchan, $conn, $msg);
236 my ($dxchan, $conn, $msg) = @_;
238 # queue the message and the channel object for later processing
240 my $self = bless {}, "inqueue";
241 $self->{dxchan} = $dxchan;
242 $self->{data} = $msg;
243 push @inqueue, $self;
247 # remove any outstanding entries on the inqueue after a disconnection (usually)
251 @inqueue = grep {$_->{dxchan} != $dxchan} @inqueue;
256 return \&new_channel;
259 # cease running this program, close down all the connections nicely
265 $SIG{'TERM'} = 'IGNORE';
266 $SIG{'INT'} = 'IGNORE';
272 Local::finish(); # end local processing
274 dbg("Local::finish error $@") if $@;
277 foreach $dxchan (DXChannel->get_all_nodes) {
278 $dxchan->disconnect(2) unless $dxchan == $main::me;
280 Msg->event_loop(100, 0.01);
283 foreach $dxchan (DXChannel->get_all_users) {
290 # disconnect UDP customers
293 # end everything else
294 Msg->event_loop(100, 0.01);
298 # close all databases
301 # close all listeners
302 foreach my $l (@listeners) {
306 dbg("DXSpider version $version, build $build ended") if isdbg('chan');
307 Log('cluster', "DXSpider V$version, build $build ended");
311 # $SIG{__WARN__} = $SIG{__DIE__} = sub {my $a = shift; cluck($a); };
315 # the reaper of children
319 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
320 dbg("cpid: $cpid") if isdbg('reap');
321 # Msg->pid_gone($cpid);
322 $zombies-- if $zombies > 0;
324 dbg("cpid: $cpid") if isdbg('reap');
327 # this is where the input queue is dealt with and things are dispatched off to other parts of
332 my $self = shift @inqueue;
335 my $data = $self->{data};
336 my $dxchan = $self->{dxchan};
338 my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
339 return unless defined $sort;
341 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
342 dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
343 if ($self->{disconnecting}) {
344 dbg('In disconnection, ignored');
349 my $user = $dxchan->user;
350 if ($sort eq 'A' || $sort eq 'O') {
351 $dxchan->start($line, $sort);
352 } elsif ($sort eq 'I') {
353 die "\$user not defined for $call" if !defined $user;
356 $dxchan->normal($line);
357 } elsif ($sort eq 'Z') {
359 } elsif ($sort eq 'D') {
360 ; # ignored (an echo)
361 } elsif ($sort eq 'G') {
362 $dxchan->enhanced($line);
364 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
371 my $t = $systime - $starttime;
372 my $days = int $t / 86400;
374 my $hours = int $t / 3600;
376 my $mins = int $t / 60;
377 return sprintf "%d %02d:%02d", $days, $hours, $mins;
382 AGWMsg::init(\&new_channel);
385 #############################################################
387 # The start of the main line of code
389 #############################################################
391 $starttime = $systime = time;
392 $lang = 'en' unless $lang;
394 # open the debug file, set various FHs to be unbuffered
395 dbginit(\&DXCommandmode::broadcast_debug);
399 STDOUT->autoflush(1);
401 # calculate build number
402 $build += $main::version;
403 $build = "$build.$branch" if $branch;
405 Log('cluster', "DXSpider V$version, build $build started");
408 dbg("Copyright (c) 1998-2002 Dirk Koopman G1TLH");
409 dbg("DXSpider Version $version, build $build started");
412 dbg("loading prefixes ...");
414 my $r = Prefix::init();
418 dbg("loading band data ...");
421 # initialise User file system
422 dbg("loading user file system ...");
423 DXUser->init($userfn, 1);
425 # look for the sysop and the alias user and complain if they aren't there
427 my $ref = DXUser->get($mycall);
428 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
429 $ref = DXUser->get($myalias);
430 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
433 # start listening for incoming messages/connects
434 dbg("starting listeners ...");
435 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
436 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
437 push @listeners, $conn;
438 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
439 foreach my $l (@main::listen) {
441 my $pkg = $l->[2] || 'ExtMsg';
442 $conn = $pkg->new_server($l->[0], $l->[1], \&login);
443 $conn->conns("Server $l->[0]/$l->[1] using $pkg");
444 push @listeners, $conn;
445 dbg("External Port: $l->[0] $l->[1] using $pkg");
448 dbg("AGW Listener") if $AGWMsg::enable;
451 dbg("UDP Listener") if $UDPMsg::enable;
452 UDPMsg::init(\&new_channel);
455 dbg("load badwords: " . (BadWords::load or "Ok"));
458 unless ($DB::VERSION) {
459 $SIG{INT} = $SIG{TERM} = sub { $decease = 1 };
463 $SIG{HUP} = 'IGNORE';
464 $SIG{CHLD} = sub { $zombies++ };
466 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
467 $SIG{IO} = sub { dbg("SIGIO received"); };
468 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
469 $SIG{KILL} = 'DEFAULT'; # as if it matters....
471 # catch the rest with a hopeful message
474 # dbg("Catching SIG $_") if isdbg('chan');
475 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
481 dbg("Starting Dupe system");
484 # read in system messages
485 dbg("Read in Messages");
488 # read in command aliases
489 dbg("Read in Aliases");
492 # initialise the Geomagnetic data engine
498 # initial the Spot stuff
499 dbg("Starting DX Spot system");
502 # initialise the protocol engine
503 dbg("Start Protocol Engines ...");
507 # put in a DXCluster node for us here so we can add users and take them away
508 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
510 # make sure that there is a routing OUTPUT node default file
511 #unless (Filter::read_in('route', 'node_default', 0)) {
512 # my $dxcc = $main::me->dxcc;
513 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
516 # read in any existing message headers and clean out old crap
517 dbg("reading existing message headers ...");
521 # read in any cron jobs
522 dbg("reading cron jobs ...");
525 # read in database descriptors
526 dbg("reading database descriptors ...");
529 # starting local stuff
530 dbg("doing local initialisation ...");
535 dbg("Local::init error $@") if $@;
537 # this, such as it is, is the main loop!
538 dbg("orft we jolly well go ...");
539 my $script = new Script "startup";
540 $script->run($main::me) if $script;
542 #open(DB::OUT, "|tee /tmp/aa");
547 Msg->event_loop(10, 0.010);
549 process_inqueue(); # read in lines from the input queue and despatch them
552 # do timed stuff, ongoing processing happens one a second
553 if ($timenow != $systime) {
556 DXCron::process(); # do cron jobs
557 DXCommandmode::process(); # process ongoing command mode stuff
558 DXProt::process(); # process ongoing ak1a pcxx stuff
560 DXConnect::process();
567 # this where things really start to happen (in DXSpider 2)
571 Local::process(); # do any localised processing
573 dbg("Local::process error $@") if $@;
576 last if --$decease <= 0;