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?
112 use POSIX ":sys_wait_h";
120 use vars qw(@inqueue $systime $starttime $lockfn @outstanding_connects
121 $zombies $root @listeners $lang $myalias @debug $userfn $clusteraddr
122 $clusterport $mycall $decease $is_win $routeroot $me $reqreg $bumpexisting
123 $allowdxby $dbh $dsn $dbuser $dbpass $do_xml $systime_days $systime_daystart
124 $can_encode $maxconnect_user $maxconnect_node
127 @inqueue = (); # the main input queue, an array of hashes
128 $systime = 0; # the time now (in seconds)
129 $starttime = 0; # the starting time of the cluster
130 @outstanding_connects = (); # list of outstanding connects
131 @listeners = (); # list of listeners
132 $reqreg = 0; # 1 = registration required, 2 = deregister people
133 $bumpexisting = 1; # 1 = allow new connection to disconnect old, 0 - don't allow it
134 $allowdxby = 0; # 1 = allow "dx by <othercall>", 0 - don't allow it
135 $maxconnect_user = 3; # the maximum no of concurrent connections a user can have at a time
136 $maxconnect_node = 0; # Ditto but for nodes. In either case if a new incoming connection
137 # takes the no of references in the routing table above these numbers
138 # then the connection is refused. This only affects INCOMING connections.
140 # send a message to call on conn and disconnect
143 my ($conn, $call, $mess) = @_;
145 $conn->disable_read(1);
146 dbg("-> D $call $mess\n") if isdbg('chan');
147 $conn->send_now("D$call|$mess");
155 $dxchan->{conn}->set_error(undef) if exists $dxchan->{conn};
156 $dxchan->disconnect(1);
159 # handle incoming messages
162 my ($conn, $msg) = @_;
163 my ($sort, $call, $line) = DXChannel::decode_input(0, $msg);
164 return unless defined $sort;
166 unless (is_callsign($call)) {
167 already_conn($conn, $call, DXM::msg($lang, "illcall", $call));
171 # set up the basic channel info
172 # is there one already connected to me - locally?
173 my $user = DXUser::get_current($call);
174 my $dxchan = DXChannel::get($call);
176 if ($user && $user->is_node) {
177 already_conn($conn, $call, DXM::msg($lang, 'concluster', $call, $main::mycall));
181 my $ip = $conn->peerhost || 'unknown';
182 $dxchan->send_now('D', DXM::msg($lang, 'conbump', $call, $ip));
183 LogDbg('DXCommand', "$call bumped off by $ip, disconnected");
186 already_conn($conn, $call, DXM::msg($lang, 'conother', $call, $main::mycall));
191 # (fairly) politely disconnect people that are connected to too many other places at once
192 my $r = Route::get($call);
193 if ($conn->{sort} && $conn->{sort} =~ /^I/ && $r && $user) {
195 my $m = $r->isa('Route::Node') ? $maxconnect_node : $maxconnect_user;
196 my $c = $user->maxconnect;
198 $v = defined $c ? $c : $m;
199 if ($v && @n >= $v) {
200 my $nodes = join ',', @n;
201 LogDbg('DXCommand', "$call has too many connections ($v) at $nodes - disconnected");
202 already_conn($conn, $call, DXM::msg($lang, 'contomany', $call, $v, $nodes));
208 my $basecall = $call;
209 $basecall =~ s/-\d+$//;
210 my $baseuser = DXUser::get_current($basecall);
211 my $lock = $user->lockout if $user;
212 if ($baseuser && $baseuser->lockout || $lock) {
213 if (!$user || !defined $lock || $lock) {
214 my $host = $conn->peerhost || "unknown";
215 LogDbg('DXCommand', "$call on $host is locked out, disconnected");
222 $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
224 $user = DXUser->new($call);
228 if ($user->is_node) {
229 $dxchan = DXProt->new($call, $conn, $user);
230 } elsif ($user->is_user) {
231 $dxchan = DXCommandmode->new($call, $conn, $user);
232 # } elsif ($user->is_bbs) { # there is no support so
233 # $dxchan = BBS->new($call, $conn, $user); # don't allow it!!!
235 die "Invalid sort of user on $call = $sort";
238 # check that the conn has a callsign
239 $conn->conns($call) if $conn->isa('IntMsg');
242 $conn->set_error(sub {error_handler($dxchan)});
243 $conn->set_rproc(sub {my ($conn,$msg) = @_; $dxchan->rec($msg);});
250 return \&new_channel;
253 # cease running this program, close down all the connections nicely
259 $SIG{'TERM'} = 'IGNORE';
260 $SIG{'INT'} = 'IGNORE';
265 if (defined &Local::finish) {
267 Local::finish(); # end local processing
269 dbg("Local::finish error $@") if $@;
273 foreach $dxchan (DXChannel::get_all_nodes) {
274 $dxchan->disconnect(2) unless $dxchan == $main::me;
276 Msg->event_loop(100, 0.01);
279 foreach $dxchan (DXChannel::get_all_users) {
287 # disconnect UDP customers
290 # end everything else
291 Msg->event_loop(100, 0.01);
295 # close all databases
298 # close all listeners
299 foreach my $l (@listeners) {
303 LogDbg('cluster', "DXSpider V$version, build $subversion.$build (git: $gitversion) ended");
307 $dbh->finish if $dbh;
310 # $SIG{__WARN__} = $SIG{__DIE__} = sub {my $a = shift; cluck($a); };
314 # the reaper of children
318 while (($cpid = waitpid(-1, WNOHANG)) > 0) {
319 dbg("cpid: $cpid") if isdbg('reap');
320 # Msg->pid_gone($cpid);
321 $zombies-- if $zombies > 0;
323 dbg("cpid: $cpid") if isdbg('reap');
326 # this is where the input queue is dealt with and things are dispatched off to other parts of
331 my $t = $systime - $starttime;
332 my $days = int $t / 86400;
334 my $hours = int $t / 3600;
336 my $mins = int $t / 60;
337 return sprintf "%d %02d:%02d", $days, $hours, $mins;
342 AGWMsg::init(\&new_channel);
345 #############################################################
347 # The start of the main line of code
349 #############################################################
351 $starttime = $systime = time;
352 $systime_days = int ($systime / 86400);
353 $systime_daystart = $systime_days * 86400;
354 $lang = 'en' unless $lang;
356 unless ($DB::VERSION) {
357 $SIG{INT} = $SIG{TERM} = \&cease;
360 # open the debug file, set various FHs to be unbuffered
361 dbginit(\&DXCommandmode::broadcast_debug);
365 STDOUT->autoflush(1);
367 # try to load the database
368 if (DXSql::init($dsn)) {
369 $dbh = DXSql->new($dsn);
370 $dbh = $dbh->connect($dsn, $dbuser, $dbpass) if $dbh;
376 my $w = $SIG{__DIE__};
377 $SIG{__DIE__} = 'IGNORE';
378 eval { require Encode; };
386 # try to load XML::Simple
390 my ($year) = (gmtime)[5];
392 LogDbg('cluster', "DXSpider V$version, build $subversion.$build (git: $gitversion) started");
393 dbg("Copyright (c) 1998-$year Dirk Koopman G1TLH");
396 dbg("loading prefixes ...");
398 my $r = Prefix::init();
402 dbg("loading band data ...");
405 # initialise User file system
406 dbg("loading user file system ...");
407 DXUser->init($userfn, 1);
409 # look for the sysop and the alias user and complain if they aren't there
411 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;
412 my $ref = DXUser::get($mycall);
413 die "$mycall missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
414 $ref = DXUser::get($myalias);
415 die "$myalias missing, run the create_sysop.pl script and please RTFM" unless $ref && $ref->priv == 9;
418 # start listening for incoming messages/connects
419 dbg("starting listeners ...");
420 my $conn = IntMsg->new_server($clusteraddr, $clusterport, \&login);
421 $conn->conns("Server $clusteraddr/$clusterport using IntMsg");
422 push @listeners, $conn;
423 dbg("Internal port: $clusteraddr $clusterport using IntMsg");
424 foreach my $l (@main::listen) {
426 my $pkg = $l->[2] || 'ExtMsg';
427 my $login = $l->[3] || 'login';
429 $conn = $pkg->new_server($l->[0], $l->[1], \&{"${pkg}::${login}"});
430 $conn->conns("Server $l->[0]/$l->[1] using ${pkg}::${login}");
431 push @listeners, $conn;
432 dbg("External Port: $l->[0] $l->[1] using ${pkg}::${login}");
435 dbg("AGW Listener") if $AGWMsg::enable;
438 dbg("BPQ Listener") if $BPQMsg::enable;
439 BPQMsg::init(\&new_channel);
441 dbg("UDP Listener") if $UDPMsg::enable;
442 UDPMsg::init(\&new_channel);
445 dbg("load badwords: " . (BadWords::load or "Ok"));
448 unless ($DB::VERSION) {
449 $SIG{INT} = $SIG{TERM} = sub { $decease = 1 };
453 $SIG{HUP} = 'IGNORE';
454 $SIG{CHLD} = sub { $zombies++ };
456 $SIG{PIPE} = sub { dbg("Broken PIPE signal received"); };
457 $SIG{IO} = sub { dbg("SIGIO received"); };
458 $SIG{WINCH} = $SIG{STOP} = $SIG{CONT} = 'IGNORE';
459 $SIG{KILL} = 'DEFAULT'; # as if it matters....
461 # catch the rest with a hopeful message
464 # dbg("Catching SIG $_") if isdbg('chan');
465 $SIG{$_} = sub { my $sig = shift; DXDebug::confess("Caught signal $sig"); };
471 dbg("Starting Dupe system");
474 # read in system messages
475 dbg("Read in Messages");
478 # read in command aliases
479 dbg("Read in Aliases");
482 # initialise the Geomagnetic data engine
488 # initial the Spot stuff
489 dbg("Starting DX Spot system");
492 # initialise the protocol engine
493 dbg("Start Protocol Engines ...");
496 # put in a DXCluster node for us here so we can add users and take them away
497 $routeroot = Route::Node->new($mycall, $version*100+5300, Route::here($main::me->here)|Route::conf($main::me->conf));
498 $routeroot->do_pc9x(1);
499 $routeroot->via_pc92(1);
501 # make sure that there is a routing OUTPUT node default file
502 #unless (Filter::read_in('route', 'node_default', 0)) {
503 # my $dxcc = $main::me->dxcc;
504 # $Route::filterdef->cmd($main::me, 'route', 'accept', "node_default call $mycall" );
507 # read in any existing message headers and clean out old crap
508 dbg("reading existing message headers ...");
512 # read in any cron jobs
513 dbg("reading cron jobs ...");
516 # read in database desriptors
517 dbg("reading database descriptors ...");
520 # starting local stuff
521 dbg("doing local initialisation ...");
523 if (defined &Local::init) {
527 dbg("Local::init error $@") if $@;
531 # this, such as it is, is the main loop!
532 dbg("orft we jolly well go ...");
533 my $script = new Script "startup";
534 $script->run($main::me) if $script;
536 #open(DB::OUT, "|tee /tmp/aa");
541 Msg->event_loop(10, 0.010);
544 DXChannel::process();
548 # do timed stuff, ongoing processing happens one a second
549 if ($timenow != $systime) {
552 my $days = int ($systime / 86400);
553 if ($systime_days != $days) {
554 $systime_days = $days;
555 $systime_daystart = $days * 86400;
557 IsoTime::update($systime);
558 DXCron::process(); # do cron jobs
559 DXCommandmode::process(); # process ongoing command mode stuff
561 DXProt::process(); # process ongoing ak1a pcxx stuff
562 DXConnect::process();
570 if (defined &Local::process) {
572 Local::process(); # do any localised processing
574 dbg("Local::process error $@") if $@;
578 last if --$decease <= 0;