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/perl/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?
102 use POSIX ":sys_wait_h";
109 use vars qw(@inqueue $systime $version $starttime $lockfn @outstanding_connects
110 $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
111 $clusterport $mycall $decease $is_win $routeroot $me $reqreg
114 @inqueue = (); # the main input queue, an array of hashes
115 $systime = 0; # the time now (in seconds)
116 $version = "1.50"; # the version no of the software
117 $starttime = 0; # the starting time of the cluster
118 #@outstanding_connects = (); # list of outstanding connects
119 @listeners = (); # list of listeners
120 $reqreg = 0; # 1 = registration required, 2 = deregister people
122 use vars qw($VERSION $BRANCH $build $branch);
123 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
124 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
125 $main::build += 12; # add an offset to make it bigger than last system
126 $main::build += $VERSION;
127 $main::branch += $BRANCH;
130 # send a message to call on conn and disconnect
133 my ($conn, $call, $mess) = @_;
135 $conn->disable_read(1);
136 dbg("-> D $call $mess\n") if isdbg('chan');
137 $conn->send_now("D$call|$mess");
145 $dxchan->{conn}->set_error(undef) if exists $dxchan->{conn};
146 $dxchan->disconnect(1);
149 # handle incoming messages
152 my ($conn, $msg) = @_;
153 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
154 return unless defined $sort;
156 unless (is_callsign($call)) {
157 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
161 # set up the basic channel info
162 # is there one already connected to me - locally?
163 my $user = DXUser->get($call);
164 my $dxchan = DXChannel->get($call);
166 my $mess = DXM::msg($lang, ($user && $user->is_node) ? 'concluster' : 'conother', $call, $main::mycall);
167 already_conn($conn, $call, $mess);
172 my $basecall = $call;
173 $basecall =~ s/-\d+$//;
174 my $baseuser = DXUser->get($basecall);
175 my $lock = $user->lockout if $user;
176 if ($baseuser && $baseuser->lockout || $lock) {
177 if (!$user || !defined $lock || $lock) {
178 my $host = $conn->{peerhost} || "unknown";
179 Log('DXCommand', "$call on $host is locked out, disconnected");
186 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
188 $user = DXUser->new($call);
193 if ($user->is_spider) {
194 $dxchan = QXProt->new($call, $conn, $user);
195 } elsif ($user->is_node) {
196 $dxchan = DXProt->new($call, $conn, $user);
197 } elsif ($user->is_user) {
198 $dxchan = DXCommandmode->new($call, $conn, $user);
199 } elsif ($user->is_bbs) {
200 $dxchan = BBS->new($call, $conn, $user);
202 die "Invalid sort of user on $call = $sort";
205 # check that the conn has a callsign
206 $conn->conns($call) if $conn->isa('IntMsg');
209 $conn->set_error(sub {error_handler($dxchan)});
210 $conn->set_rproc(sub {my ($conn,$msg) = @_; rec($dxchan, $conn, $msg);});
211 rec($dxchan, $conn, $msg);
216 my ($dxchan, $conn, $msg) = @_;
218 # queue the message and the channel object for later processing
220 my $self = bless {}, "inqueue";
221 $self->{dxchan} = $dxchan;
222 $self->{data} = $msg;
223 push @inqueue, $self;
229 return \&new_channel;
232 # cease running this program, close down all the connections nicely
238 $SIG{'TERM'} = 'IGNORE';
239 $SIG{'INT'} = 'IGNORE';
245 Local::finish(); # end local processing
247 dbg("Local::finish error $@") if $@;
250 foreach $dxchan (DXChannel->get_all_nodes) {
251 $dxchan->disconnect(2) unless $dxchan == $main::me;
253 Msg->event_loop(100, 0.01);
256 foreach $dxchan (DXChannel->get_all_users) {
263 # end everything else
264 Msg->event_loop(100, 0.01);
268 # close all databases
271 # close all listeners
272 foreach my $l (@listeners) {
276 dbg("DXSpider version $version, build $build ended") if isdbg('chan');
277 Log('cluster', "DXSpider V$version, build $build ended");
281 # $SIG{__WARN__} = $SIG{__DIE__} = sub {my $a = shift; cluck($a); };
285 # the reaper of children
289 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
290 dbg("cpid: $cpid") if isdbg('reap');
291 # Msg->pid_gone($cpid);
292 $zombies-- if $zombies > 0;
294 dbg("cpid: $cpid") if isdbg('reap');
297 # this is where the input queue is dealt with and things are dispatched off to other parts of
302 my $self = shift @inqueue;
305 my $data = $self->{data};
306 my $dxchan = $self->{dxchan};
308 my ($sort, $call, $line) = DXChannel::decode_input($dxchan, $data);
309 return unless defined $sort;
311 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
312 dbg("<- $sort $call $line\n") if $sort ne 'D' && isdbg('chan');
313 if ($self->{disconnecting}) {
314 dbg('In disconnection, ignored');
319 my $user = $dxchan->user;
320 if ($sort eq 'A' || $sort eq 'O') {
321 $dxchan->start($line, $sort);
322 } elsif ($sort eq 'I') {
323 die "\$user not defined for $call" if !defined $user;
326 $dxchan->normal($line);
327 } elsif ($sort eq 'Z') {
329 } elsif ($sort eq 'D') {
330 ; # ignored (an echo)
331 } elsif ($sort eq 'G') {
332 $dxchan->enhanced($line);
334 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
341 my $t = $systime - $starttime;
342 my $days = int $t / 86400;
344 my $hours = int $t / 3600;
346 my $mins = int $t / 60;
347 return sprintf "%d %02d:%02d", $days, $hours, $mins;
352 AGWMsg::init(\&new_channel);
355 #############################################################
357 # The start of the main line of code
359 #############################################################
361 $starttime = $systime = time;
362 $lang = 'en' unless $lang;
364 # open the debug file, set various FHs to be unbuffered
365 dbginit(\&DXCommandmode::broadcast_debug);
369 STDOUT->autoflush(1);
371 # calculate build number
372 $build += $main::version;
373 $build = "$build.$branch" if $branch;
375 Log('cluster', "DXSpider V$version, build $build started");
378 dbg("Copyright (c) 1998-2002 Dirk Koopman G1TLH");
379 dbg("DXSpider Version $version, build $build started");
382 dbg("loading prefixes ...");
386 dbg("loading band data ...");
389 # initialise User file system
390 dbg("loading user file system ...");
391 DXUser->init($userfn, 1);
393 # look for the sysop and the alias user and complain if they aren't there
395 my $ref = DXUser->get($mycall);
396 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
397 $ref = DXUser->get($myalias);
398 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
401 # start listening for incoming messages/connects
402 dbg("starting listeners ...");
403 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
404 $conn->conns("Server $clusteraddr/$clusterport");
405 push @listeners, $conn;
406 dbg("Internal port: $clusteraddr $clusterport");
407 foreach my $l (@main::listen) {
408 $conn = ExtMsg->new_server($l->[0], $l->[1], \&login);
409 $conn->conns("Server $l->[0]/$l->[1]");
410 push @listeners, $conn;
411 dbg("External Port: $l->[0] $l->[1]");
416 dbg("load badwords: " . (BadWords::load or "Ok"));
419 unless ($DB::VERSION) {
420 $SIG{INT} = $SIG{TERM} = sub { $decease = 1 };
424 $SIG{HUP} = 'IGNORE';
425 $SIG{CHLD} = sub { $zombies++ };
427 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
428 $SIG{IO} = sub { dbg("SIGIO received"); };
429 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
430 $SIG{KILL} = 'DEFAULT'; # as if it matters....
432 # catch the rest with a hopeful message
435 # dbg("Catching SIG $_") if isdbg('chan');
436 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
444 # read in system messages
447 # read in command aliases
450 # initialise the Geomagnetic data engine
454 # initial the Spot stuff
457 # initialise the protocol engine
458 dbg("reading in duplicate spot and WWV info ...");
461 # put in a DXCluster node for us here so we can add users and take them away
462 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
464 # make sure that there is a routing OUTPUT node default file
465 #unless (Filter::read_in('route', 'node_default', 0)) {
466 # my $dxcc = $main::me->dxcc;
467 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
470 # read in any existing message headers and clean out old crap
471 dbg("reading existing message headers ...");
475 # read in any cron jobs
476 dbg("reading cron jobs ...");
479 # read in database descriptors
480 dbg("reading database descriptors ...");
483 # starting local stuff
484 dbg("doing local initialisation ...");
488 dbg("Local::init error $@") if $@;
490 # this, such as it is, is the main loop!
491 dbg("orft we jolly well go ...");
492 my $script = new Script "startup";
493 $script->run($main::me) if $script;
495 #open(DB::OUT, "|tee /tmp/aa");
500 Msg->event_loop(10, 0.010);
502 process_inqueue(); # read in lines from the input queue and despatch them
505 # do timed stuff, ongoing processing happens one a second
506 if ($timenow != $systime) {
509 DXCron::process(); # do cron jobs
510 DXCommandmode::process(); # process ongoing command mode stuff
511 DXProt::process(); # process ongoing ak1a pcxx stuff
513 DXConnect::process();
521 Local::process(); # do any localised processing
523 dbg("Local::process error $@") if $@;
526 last if --$decease <= 0;