]> scm.dxcluster.org Git - spider.git/blob - perl/cluster.pl
removed ~ from the end of a PC18
[spider.git] / perl / cluster.pl
1 #!/usr/bin/perl -w
2 #
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.
5 #
6 # Hence the name of 'spider' (although it may become 'dxspider')
7 #
8 # Copyright (c) 1998 Dirk Koopman G1TLH
9 #
10 # $Id$
11
12
13 require 5.004;
14
15 # make sure that modules are searched in the order local then perl
16 BEGIN {
17         umask 002;
18         
19         # root of directory tree for this system
20         $root = "/spider"; 
21         $root = $ENV{'DXSPIDER_ROOT'} if $ENV{'DXSPIDER_ROOT'};
22         
23         unshift @INC, "$root/perl";     # this IS the right way round!
24         unshift @INC, "$root/local";
25
26         # try to create and lock a lockfile (this isn't atomic but 
27         # should do for now
28         $lockfn = "$root/perl/cluster.lock";       # lock file name
29         if (-e $lockfn) {
30                 open(CLLOCK, "$lockfn") or die "Can't open Lockfile ($lockfn) $!";
31                 my $pid = <CLLOCK>;
32                 chomp $pid;
33                 die "Lockfile ($lockfn) and process $pid exist, another cluster running?" if kill 0, $pid;
34                 close CLLOCK;
35         }
36         open(CLLOCK, ">$lockfn") or die "Can't open Lockfile ($lockfn) $!";
37         print CLLOCK "$$\n";
38         close CLLOCK;
39 }
40
41 use Msg;
42 use DXVars;
43 use DXDebug;
44 use DXLog;
45 use DXLogPrint;
46 use DXUtil;
47 use DXChannel;
48 use DXUser;
49 use DXM;
50 use DXCommandmode;
51 use DXProt;
52 use DXMsg;
53 use DXCluster;
54 use DXCron;
55 use DXConnect;
56 use Prefix;
57 use Bands;
58 use Geomag;
59 use CmdAlias;
60 use Filter;
61 use Local;
62 use Fcntl ':flock'; 
63
64 use Carp qw(cluck);
65
66 package main;
67
68 @inqueue = ();                                  # the main input queue, an array of hashes
69 $systime = 0;                                   # the time now (in seconds)
70 $version = "1.34";                              # the version no of the software
71 $starttime = 0;                 # the starting time of the cluster   
72 $lockfn = "cluster.lock";       # lock file name
73       
74 # handle disconnections
75 sub disconnect
76 {
77         my $dxchan = shift;
78         return if !defined $dxchan;
79         $dxchan->disconnect();
80 }
81
82 # send a message to call on conn and disconnect
83 sub already_conn
84 {
85         my ($conn, $call, $mess) = @_;
86         
87         dbg('chan', "-> D $call $mess\n"); 
88         $conn->send_now("D$call|$mess");
89         sleep(1);
90         dbg('chan', "-> Z $call bye\n");
91         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
92         sleep(1);
93         $conn->disconnect;
94 }
95
96 # handle incoming messages
97 sub rec
98 {
99         my ($conn, $msg, $err) = @_;
100         my $dxchan = DXChannel->get_by_cnum($conn); # get the dxconnnect object for this message
101         
102         if (defined $err && $err) {
103                 disconnect($dxchan) if defined $dxchan;
104                 return;
105         }
106         
107         # set up the basic channel info - this needs a bit more thought - there is duplication here
108         if (!defined $dxchan) {
109                 my ($sort, $call, $line) = $msg =~ /^(\w)(\S+)\|(.*)$/;
110
111                 # is there one already connected to me ? 
112                 my $user = DXUser->get($call);
113                 if (DXChannel->get($call)) {
114                         my $mess = DXM::msg($lang, $user->sort eq 'A' ? 'concluster' : 'conother', $call);
115                         already_conn($conn, $call, $mess);
116                         return;
117                 }
118                 
119                 # is there one already connected elsewhere in the cluster (and not a cluster)
120                 if ($user) {
121                         if (($user->sort eq 'A' || $call eq $myalias) && !DXCluster->get_exact($call)) {
122                                 ;
123                         } else {
124                                 if (DXCluster->get($call) || DXChannel->get($call)) {
125                                         my $mess = DXM::msg($lang, $user->sort eq 'A' ? 'concluster' : 'conother', $call);
126                                         already_conn($conn, $call, $mess);
127                                         return;
128                                 }
129                         }
130                         $user->{lang} = $main::lang if !$user->{lang}; # to autoupdate old systems
131                 } else {
132                         if (DXCluster->get($call)) {
133                                 my $mess = DXM::msg($lang, 'conother', $call);
134                                 already_conn($conn, $call, $mess);
135                                 return;
136                         }
137                         $user = DXUser->new($call);
138                 }
139
140                 # is he locked out ?
141                 if ($user->lockout) {
142                         Log('DXCommand', "$call is locked out, disconnected");
143                         $conn->send_now("Z$call|bye"); # this will cause 'client' to disconnect
144                         return;
145                 }
146
147                 # create the channel
148                 $dxchan = DXCommandmode->new($call, $conn, $user) if ($user->sort eq 'U');
149                 $dxchan = DXProt->new($call, $conn, $user) if ($user->sort eq 'A');
150                 die "Invalid sort of user on $call = $sort" if !$dxchan;
151         }
152         
153         # queue the message and the channel object for later processing
154         if (defined $msg) {
155                 my $self = bless {}, "inqueue";
156                 $self->{dxchan} = $dxchan;
157                 $self->{data} = $msg;
158                 push @inqueue, $self;
159         }
160 }
161
162 sub login
163 {
164         return \&rec;
165 }
166
167 # cease running this program, close down all the connections nicely
168 sub cease
169 {
170         my $dxchan;
171
172         $SIG{'TERM'} = 'IGNORE';
173         $SIG{'INT'} = 'IGNORE';
174         
175         eval {
176                 Local::finish();   # end local processing
177         };
178         dbg('local', "Local::finish error $@") if $@;
179
180         # disconnect users
181         foreach $dxchan (DXChannel->get_all()) {
182                 next if $dxchan->is_ak1a;
183                 disconnect($dxchan) unless $dxchan == $DXProt::me;
184         }
185         Msg->event_loop(1, 0.05);
186         Msg->event_loop(1, 0.05);
187         Msg->event_loop(1, 0.05);
188         Msg->event_loop(1, 0.05);
189         Msg->event_loop(1, 0.05);
190         Msg->event_loop(1, 0.05);
191
192         # disconnect nodes
193         foreach $dxchan (DXChannel->get_all()) {
194                 next unless $dxchan->is_ak1a;
195                 disconnect($dxchan) unless $dxchan == $DXProt::me;
196         }
197         Msg->event_loop(1, 0.05);
198         Msg->event_loop(1, 0.05);
199         Msg->event_loop(1, 0.05);
200         Msg->event_loop(1, 0.05);
201         Msg->event_loop(1, 0.05);
202         Msg->event_loop(1, 0.05);
203         Msg->event_loop(1, 0.05);
204         Msg->event_loop(1, 0.05);
205         Msg->event_loop(1, 0.05);
206         Msg->event_loop(1, 0.05);
207         Msg->event_loop(1, 0.05);
208         Msg->event_loop(1, 0.05);
209         DXUser::finish();
210         dbg('chan', "DXSpider version $version ended");
211         Log('cluster', "DXSpider V$version stopped");
212         dbgclose();
213         Logclose();
214         unlink $lockfn;
215 #       $SIG{__WARN__} = $SIG{__DIE__} =  sub {my $a = shift; cluck($a); };
216         exit(0);
217 }
218
219 # the reaper of children
220 sub reap
221 {
222         $SIG{'CHLD'} = \&reap;
223         my $cpid = wait;
224 }
225
226 # this is where the input queue is dealt with and things are dispatched off to other parts of
227 # the cluster
228 sub process_inqueue
229 {
230         my $self = shift @inqueue;
231         return if !$self;
232         
233         my $data = $self->{data};
234         my $dxchan = $self->{dxchan};
235         my ($sort, $call, $line) = $data =~ /^(\w)([A-Z0-9\-]+)\|(.*)$/;
236         my $error;
237         
238         # the above regexp must work
239         return unless ($sort && $call && $line);
240         
241         # translate any crappy characters into hex characters 
242         if ($line =~ /[\x00-\x06\x08\x0a-\x1f\x7f-\xff]/o) {
243                 $line =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
244                 ++$error;
245 #               dbg('chan', "<- $sort $call **CRAP**: $line");
246 #               return;
247         }
248         
249         # do the really sexy console interface bit! (Who is going to do the TK interface then?)
250         dbg('chan', "<- $sort $call $line\n") unless $sort eq 'D';
251
252         # handle A records
253         my $user = $dxchan->user;
254         if ($sort eq 'A' || $sort eq 'O') {
255                 $dxchan->start($line, $sort);  
256         } elsif ($sort eq 'I') {
257                 die "\$user not defined for $call" if !defined $user;
258
259                 if ($error) {
260                         dbg('chan', "DROPPED with $error duff characters");
261                 } else {
262                         # normal input
263                         $dxchan->normal($line);
264                 }
265                 disconnect($dxchan) if ($dxchan->{state} eq 'bye');
266         } elsif ($sort eq 'Z') {
267                 disconnect($dxchan);
268         } elsif ($sort eq 'D') {
269                 ;                       # ignored (an echo)
270         } else {
271                 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
272         }
273 }
274
275 sub uptime
276 {
277         my $t = $systime - $starttime;
278         my $days = int $t / 86400;
279         $t -= $days * 86400;
280         my $hours = int $t / 3600;
281         $t -= $hours * 3600;
282         my $mins = int $t / 60;
283         return sprintf "%d %02d:%02d", $days, $hours, $mins;
284 }
285 #############################################################
286 #
287 # The start of the main line of code 
288 #
289 #############################################################
290
291 $starttime = $systime = time;
292
293 # open the debug file, set various FHs to be unbuffered
294 dbginit();
295 foreach (@debug) {
296         dbgadd($_);
297 }
298 STDOUT->autoflush(1);
299
300 Log('cluster', "DXSpider V$version started");
301
302 # banner
303 print "DXSpider DX Cluster Version $version\nCopyright (c) 1998 Dirk Koopman G1TLH\n";
304
305 # load Prefixes
306 print "loading prefixes ...\n";
307 Prefix::load();
308
309 # load band data
310 print "loading band data ...\n";
311 Bands::load();
312
313 # initialise User file system
314 print "loading user file system ...\n"; 
315 DXUser->init($userfn, 1);
316
317 # start listening for incoming messages/connects
318 print "starting listener ...\n";
319 Msg->new_server("$clusteraddr", $clusterport, \&login);
320
321 # prime some signals
322 $SIG{'INT'} = \&cease;
323 $SIG{'TERM'} = \&cease;
324 $SIG{'HUP'} = 'IGNORE';
325 $SIG{'CHLD'} = \&reap;
326
327 # read in system messages
328 DXM->init();
329
330 # read in command aliases
331 CmdAlias->init();
332
333 # initialise the Geomagnetic data engine
334 Geomag->init();
335
336 # initial the Spot stuff
337 Spot->init();
338
339 # initialise the protocol engine
340 print "reading in duplicate spot and WWV info ...\n";
341 DXProt->init();
342
343
344 # put in a DXCluster node for us here so we can add users and take them away
345 DXNode->new(0, $mycall, 0, 1, $DXProt::myprot_version); 
346
347 # read in any existing message headers and clean out old crap
348 print "reading existing message headers ...\n";
349 DXMsg->init();
350 DXMsg::clean_old();
351
352 # read in any cron jobs
353 print "reading cron jobs ...\n";
354 DXCron->init();
355
356 # starting local stuff
357 print "doing local initialisation ...\n";
358 eval {
359         Local::init();
360 };
361 dbg('local', "Local::init error $@") if $@;
362
363 # print various flags
364 #print "useful info - \$^D: $^D \$^W: $^W \$^S: $^S \$^P: $^P\n";
365
366 # this, such as it is, is the main loop!
367 print "orft we jolly well go ...\n";
368 dbg('chan', "DXSpider version $version started...");
369 for (;;) {
370         my $timenow;
371         Msg->event_loop(1, 0.1);
372         $timenow = time;
373         process_inqueue();                      # read in lines from the input queue and despatch them
374         
375         # do timed stuff, ongoing processing happens one a second
376         if ($timenow != $systime) {
377                 $systime = $timenow;
378                 $cldate = &cldate();
379                 $ztime = &ztime();
380                 DXCron::process();      # do cron jobs
381                 DXCommandmode::process(); # process ongoing command mode stuff
382                 DXProt::process();              # process ongoing ak1a pcxx stuff
383                 DXConnect::process();
384                 DXMsg::process();
385                 eval { 
386                         Local::process();       # do any localised processing
387                 };
388                 dbg('local', "Local::process error $@") if $@;
389         }
390         if ($decease) {
391                 last if --$decease <= 0;
392         }
393 }
394 cease(0);
395 exit(0);
396
397