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?
106 use POSIX ":sys_wait_h";
113 use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects
114 $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
115 $clusterport $mycall $decease $is_win $routeroot $me $reqreg
118 @inqueue = (); # the main input queue, an array of hashes
119 $systime = 0; # the time now (in seconds)
120 $version = "1.51"; # the version no of the software
121 $starttime = 0; # the starting time of the cluster
122 #@outstanding_connects = (); # list of outstanding connects
123 @listeners = (); # list of listeners
124 $reqreg = 0; # 1 = registration required, 2 = deregister people
126 use vars qw($VERSION $BRANCH $build $branch);
127 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
128 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
129 $main::build += 4; # add an offset to make it bigger than last system
130 $main::build += $VERSION;
131 $main::branch += $BRANCH;
134 # send a message to call on conn and disconnect
137 my ($conn, $call, $mess) = @_;
139 $conn->disable_read(1);
140 dbg("-> D $call $mess\n") if isdbg('chan');
141 $conn->send_now("D$call|$mess");
149 $dxchan->{conn}->set_error(undef) if exists $dxchan->{conn};
150 $dxchan->disconnect(1);
153 # handle incoming messages
156 my ($conn, $msg) = @_;
157 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
158 return unless defined $sort;
160 unless (is_callsign($call)) {
161 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
165 # set up the basic channel info
166 # is there one already connected to me - locally?
167 my $user = DXUser->get_current($call);
168 my $dxchan = DXChannel->get($call);
170 my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call, $main::mycall);
171 already_conn($conn, $call, $mess);
176 my $basecall = $call;
177 $basecall =~ s/-\d+$//;
178 my $baseuser = DXUser->get_current($basecall);
179 my $lock = $user->lockout if $user;
180 if ($baseuser && $baseuser->lockout || $lock) {
181 if (!$user || !defined $lock || $lock) {
182 my $host = $conn->{peerhost} || "unknown";
183 Log('DXCommand', "$call on $host is locked out, disconnected");
190 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
192 $user = DXUser->new($call);
197 if ($user->is_node) {
198 $dxchan = DXProt->new($call, $conn, $user);
199 } elsif ($user->is_user) {
200 $dxchan = DXCommandmode->new($call, $conn, $user);
201 } elsif ($user->is_bbs) {
202 $dxchan = BBS->new($call, $conn, $user);
204 die "Invalid sort of user on $call = $sort";
207 # check that the conn has a callsign
208 $conn->conns($call) if $conn->isa('IntMsg');
211 $conn->set_error(sub {error_handler($dxchan)});
212 $conn->set_rproc(sub {my ($conn,$msg) = @_; rec($dxchan, $conn, $msg);});
213 rec($dxchan, $conn, $msg);
218 my ($dxchan, $conn, $msg) = @_;
220 # queue the message and the channel object for later processing
222 my $self = bless {}, "inqueue";
223 $self->{dxchan} = $dxchan;
224 $self->{data} = $msg;
225 push @inqueue, $self;
229 # remove any outstanding entries on the inqueue after a disconnection (usually)
233 @inqueue = grep {$_->{dxchan} != $dxchan} @inqueue;
238 return \&new_channel;
241 # cease running this program, close down all the connections nicely
247 $SIG{'TERM'} = 'IGNORE';
248 $SIG{'INT'} = 'IGNORE';
254 Local::finish(); # end local processing
256 dbg("Local::finish error $@") if $@;
259 foreach $dxchan (DXChannel->get_all_nodes) {
260 $dxchan->disconnect(2) unless $dxchan == $main::me;
262 Msg->event_loop(100, 0.01);
265 foreach $dxchan (DXChannel->get_all_users) {
272 # disconnect UDP customers
275 # end everything else
276 Msg->event_loop(100, 0.01);
280 # close all databases
283 # close all listeners
284 foreach my $l (@listeners) {
288 dbg("DXSpider version $version, build $build ended") if isdbg('chan');
289 Log('cluster', "DXSpider V$version, build $build ended");
293 # $SIG{__WARN__} = $SIG{__DIE__} = sub {my $a = shift; cluck($a); };
297 # the reaper of children
301 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
302 dbg("cpid: $cpid") if isdbg('reap');
303 # Msg->pid_gone($cpid);
304 $zombies-- if $zombies > 0;
306 dbg("cpid: $cpid") if isdbg('reap');
309 # this is where the input queue is dealt with and things are dispatched off to other parts of
314 my $self = shift @inqueue;
317 my $data = $self->{data};
318 my $dxchan = $self->{dxchan};
320 my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
321 return unless defined $sort;
323 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
324 dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
325 if ($self->{disconnecting}) {
326 dbg('In disconnection, ignored');
331 my $user = $dxchan->user;
332 if ($sort eq 'A' || $sort eq 'O') {
333 $dxchan->start($line, $sort);
334 } elsif ($sort eq 'I') {
335 die "\$user not defined for $call" if !defined $user;
338 $dxchan->normal($line);
339 } elsif ($sort eq 'Z') {
341 } elsif ($sort eq 'D') {
342 ; # ignored (an echo)
343 } elsif ($sort eq 'G') {
344 $dxchan->enhanced($line);
346 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
353 my $t = $systime - $starttime;
354 my $days = int $t / 86400;
356 my $hours = int $t / 3600;
358 my $mins = int $t / 60;
359 return sprintf "%d %02d:%02d", $days, $hours, $mins;
364 AGWMsg::init(\&new_channel);
367 #############################################################
369 # The start of the main line of code
371 #############################################################
373 $starttime = $systime = time;
374 $lang = 'en' unless $lang;
376 # open the debug file, set various FHs to be unbuffered
377 dbginit(\&DXCommandmode::broadcast_debug);
381 STDOUT->autoflush(1);
383 # calculate build number
384 $build += $main::version;
385 $build = "$build.$branch" if $branch;
387 Log('cluster', "DXSpider V$version, build $build started");
390 dbg("Copyright (c) 1998-2002 Dirk Koopman G1TLH");
391 dbg("DXSpider Version $version, build $build started");
394 dbg("loading prefixes ...");
396 my $r = Prefix::init();
400 dbg("loading band data ...");
403 # initialise User file system
404 dbg("loading user file system ...");
405 DXUser->init($userfn, 1);
407 # look for the sysop and the alias user and complain if they aren't there
409 my $ref = DXUser->get($mycall);
410 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
411 $ref = DXUser->get($myalias);
412 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
415 # start listening for incoming messages/connects
416 dbg("starting listeners ...");
417 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
418 $conn->conns("Server $clusteraddr/$clusterport");
419 push @listeners, $conn;
420 dbg("Internal port: $clusteraddr $clusterport");
421 foreach my $l (@main::listen) {
422 $conn = ExtMsg->new_server($l->[0], $l->[1], \&login);
423 $conn->conns("Server $l->[0]/$l->[1]");
424 push @listeners, $conn;
425 dbg("External Port: $l->[0] $l->[1]");
428 dbg("AGW Listener") if $AGWMsg::enable;
431 dbg("UDP Listener") if $UDPMsg::enable;
432 UDPMsg::init(\&new_channel);
435 dbg("load badwords: " . (BadWords::load or "Ok"));
438 unless ($DB::VERSION) {
439 $SIG{INT} = $SIG{TERM} = sub { $decease = 1 };
443 $SIG{HUP} = 'IGNORE';
444 $SIG{CHLD} = sub { $zombies++ };
446 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
447 $SIG{IO} = sub { dbg("SIGIO received"); };
448 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
449 $SIG{KILL} = 'DEFAULT'; # as if it matters....
451 # catch the rest with a hopeful message
454 # dbg("Catching SIG $_") if isdbg('chan');
455 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
461 dbg("Starting Dupe system");
464 # read in system messages
465 dbg("Read in Messages");
468 # read in command aliases
469 dbg("Read in Aliases");
472 # initialise the Geomagnetic data engine
478 # initial the Spot stuff
479 dbg("Starting DX Spot system");
482 # initialise the protocol engine
483 dbg("Start Protocol Engines ...");
486 # put in a DXCluster node for us here so we can add users and take them away
487 $routeroot = Route::Node->new($mycall);
488 $routeroot->version($version*100+5300);
489 $routeroot->here($main::me->here || 1);
490 $routeroot->conf($main::me->conf || 0);
491 $routeroot->add_dxchan($me);
492 $routeroot->lastseen(time);
494 # make sure that there is a routing OUTPUT node default file
495 #unless (Filter::read_in('route', 'node_default', 0)) {
496 # my $dxcc = $main::me->dxcc;
497 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
500 # read in any existing message headers and clean out old crap
501 dbg("reading existing message headers ...");
505 # read in any cron jobs
506 dbg("reading cron jobs ...");
509 # read in database descriptors
510 dbg("reading database descriptors ...");
513 # starting local stuff
514 dbg("doing local initialisation ...");
519 dbg("Local::init error $@") if $@;
521 # this, such as it is, is the main loop!
522 dbg("orft we jolly well go ...");
523 my $script = new Script "startup";
524 $script->run($main::me) if $script;
526 #open(DB::OUT, "|tee /tmp/aa");
531 Msg->event_loop(10, 0.010);
533 process_inqueue(); # read in lines from the input queue and despatch them
536 # do timed stuff, ongoing processing happens one a second
537 if ($timenow != $systime) {
540 DXCron::process(); # do cron jobs
541 DXCommandmode::process(); # process ongoing command mode stuff
542 DXProt::process(); # process ongoing ak1a pcxx stuff
543 DXConnect::process();
550 # this where things really start to happen (in DXSpider 2)
554 Local::process(); # do any localised processing
556 dbg("Local::process error $@") if $@;
559 last if --$decease <= 0;