]> dxcluster.net Git - spider.git/blob - perl/Aranea.pm
add aranea stuff
[spider.git] / perl / Aranea.pm
1 #
2 # The new protocol for real at last
3 #
4 # $Id$
5 #
6 # Copyright (c) 2005 Dirk Koopman G1TLH
7 #
8
9 package Aranea;
10
11 use strict;
12
13 use DXUtil;
14 use DXChannel;
15 use DXUser;
16 use DXM;
17 use DXLog;
18 use DXDebug;
19 use Filter;
20 use Time::HiRes qw(gettimeofday tv_interval);
21 use DXHash;
22 use Route;
23 use Route::Node;
24 use Script;
25 use Verify;
26 use DXDupe;
27 use Thingy;
28 use RouteDB;
29
30 use vars qw($VERSION $BRANCH);
31
32 main::mkver($VERSION = q$Revision$);
33
34 use vars qw(@ISA $ntpflag $dupeage);
35
36 @ISA = qw(DXChannel);
37
38 $ntpflag = 0;                                   # should be set in startup if NTP in use
39 $dupeage = 12*60*60;                    # duplicates stored half a day 
40
41 my $seqno = 0;
42 my $dayno = 0;
43 my $daystart = 0;
44
45 sub init
46 {
47
48 }
49
50 sub new
51 {
52         my $self = DXChannel::alloc(@_);
53
54         # add this node to the table, the values get filled in later
55         my $pkg = shift;
56         my $call = shift;
57         $main::routeroot->add($call, '5251', Route::here(1)) if $call ne $main::mycall;
58         $self->{'sort'} = 'W';
59         return $self;
60 }
61
62 sub start
63 {
64         my ($self, $line, $sort) = @_;
65         my $call = $self->{call};
66         my $user = $self->{user};
67
68         # log it
69         my $host = $self->{conn}->{peerhost} || "unknown";
70         Log('Aranea', "$call connected from $host");
71         
72         # remember type of connection
73         $self->{consort} = $line;
74         $self->{outbound} = $sort eq 'O';
75         my $priv = $user->priv;
76         $priv = $user->priv(1) unless $priv;
77         $self->{priv} = $priv;     # other clusters can always be 'normal' users
78         $self->{lang} = $user->lang || 'en';
79         $self->{consort} = $line;       # save the connection type
80         $self->{here} = 1;
81         $self->{width} = 80;
82
83         # sort out registration
84         $self->{registered} = 1;
85
86         # get the output filters
87         $self->{spotsfilter} = Filter::read_in('spots', $call, 0) || Filter::read_in('spots', 'node_default', 0);
88         $self->{wwvfilter} = Filter::read_in('wwv', $call, 0) || Filter::read_in('wwv', 'node_default', 0);
89         $self->{wcyfilter} = Filter::read_in('wcy', $call, 0) || Filter::read_in('wcy', 'node_default', 0);
90         $self->{annfilter} = Filter::read_in('ann', $call, 0) || Filter::read_in('ann', 'node_default', 0) ;
91         $self->{routefilter} = Filter::read_in('route', $call, 0) || Filter::read_in('route', 'node_default', 0) unless $self->{isolate} ;
92
93
94         # get the INPUT filters (these only pertain to Clusters)
95         $self->{inspotsfilter} = Filter::read_in('spots', $call, 1) || Filter::read_in('spots', 'node_default', 1);
96         $self->{inwwvfilter} = Filter::read_in('wwv', $call, 1) || Filter::read_in('wwv', 'node_default', 1);
97         $self->{inwcyfilter} = Filter::read_in('wcy', $call, 1) || Filter::read_in('wcy', 'node_default', 1);
98         $self->{inannfilter} = Filter::read_in('ann', $call, 1) || Filter::read_in('ann', 'node_default', 1);
99         $self->{inroutefilter} = Filter::read_in('route', $call, 1) || Filter::read_in('route', 'node_default', 1) unless $self->{isolate};
100         
101         $self->conn->echo(0) if $self->conn->can('echo');
102         
103         # ping neighbour node stuff
104         my $ping = $user->pingint;
105         $ping = $DXProt::pingint unless defined $ping;
106         $self->{pingint} = $ping;
107         $self->{nopings} = $user->nopings || $DXProt::obscount;
108         $self->{pingtime} = [ ];
109         $self->{pingave} = 999;
110         $self->{metric} ||= 100;
111         $self->{lastping} = $main::systime;
112         
113         $self->state('normal');
114         $self->{pc50_t} = $main::systime;
115
116         # send info to all logged in thingies
117         $self->tell_login('loginn');
118
119         # run a script send the output to the debug file
120         my $script = new Script(lc $call) || new Script('node_default');
121         $script->run($self) if $script;
122 }
123
124 #
125 # This is the normal despatcher
126 #
127 sub normal
128 {
129         my ($self, $line) = @_;
130         my $thing = input($line);
131         $thing->queue($self) if $thing;
132 }
133
134 #
135 # periodic processing
136 #
137
138 sub process
139 {
140
141         # calc day number
142         my $d = (gmtime($main::systime))[3];
143         if ($d != $dayno) {
144                 $dayno = $d;
145                 $daystart = $main::systime - ($main::systime % 86400);
146         }
147 }
148
149 sub disconnect
150 {
151         my $self = shift;
152         my $call = $self->call;
153
154         return if $self->{disconnecting}++;
155         
156         # get rid of any PC16/17/19
157 #       eph_del_regex("^PC1[679]*$call");
158
159         # do routing stuff, remove me from routing table
160         my $node = Route::Node::get($call);
161         my @rout;
162         if ($node) {
163                 @rout = $node->del($main::routeroot);
164                 
165                 # and all my ephemera as well
166                 for (@rout) {
167                         my $c = $_->call;
168 #                       eph_del_regex("^PC1[679].*$c");
169                 }
170         }
171
172         RouteDB::delete_interface($call);
173         
174         # unbusy and stop and outgoing mail
175         my $mref = DXMsg::get_busy($call);
176         $mref->stop_msg($call) if $mref;
177         
178         # broadcast to all other nodes that all the nodes connected to via me are gone
179 #       $self->route_pc21($main::mycall, undef, @rout) if @rout;
180
181         # remove outstanding pings
182 #       delete $pings{$call};
183         
184         # I was the last node visited
185     $self->user->node($main::mycall);
186
187         # send info to all logged in thingies
188         $self->tell_login('logoutn');
189
190         Log('Aranea', $call . " Disconnected");
191
192         $self->SUPER::disconnect;
193 }
194
195
196 # generate new header (this is a general subroutine, not a method
197 # because it has to be used before a channel is fully initialised).
198 #
199
200 sub genheader
201 {
202         my $mycall = shift;
203         my $to = shift;
204         my $from = shift;
205         
206         my $date = ((($dayno << 1) | $ntpflag) << 18) |  ($main::systime % 86400);
207         my $r = "$mycall," . sprintf('%6X%04X,0', $date, $seqno);
208         $r .= ",$to" if $to;
209         $r .= "," if $from && !$to;
210         $r .= ",$from" if $from;
211         $seqno++;
212         $seqno = 0 if $seqno > 0x0ffff;
213         return $r;
214 }
215
216 #
217 # decode the date time sequence group
218 #
219
220 sub decode_dts
221 {
222         my $dts = shift;
223         my ($dt, $seqno) = map {hex} unpack "H6H4", $dts;
224         my $secs = $dt & 0x3FFFF;
225         $dt >>= 18;
226         my $day = $dt >> 1;
227         my $ntp = $dt & 1;
228         my $t;
229         if ($dayno == $day) {
230                 $t = $daystart + $secs;
231         } elsif ($dayno < $day) {
232                 $t = $daystart + (($day-$dayno) * 86400) + $secs;
233         } else {
234                 $t = $daystart + (($dayno-$day) * 86400) + $secs;
235         }
236         return ($t, $seqno, $ntp);
237 }
238
239 # subroutines to encode and decode values in lists 
240 sub tencode
241 {
242         my $s = shift;
243         $s =~ s/([\%=|,\'\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg; 
244         $s = "'$s'" if $s =~ / /;
245         return $s;
246 }
247
248 sub tdecode
249 {
250         my $s = shift;
251         $s =~ s/^'(.*)'$/$1/;
252         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
253         return $s;
254 }
255
256 sub genmsg
257 {
258         my $thing = shift;
259         my $name = shift;
260         my $head = genheader($thing->{origin}, 
261                                                  ($thing->{group} || $thing->{touser} || $thing->{tonode}),
262                                                  ($thing->{user} || $thing->{fromuser} || $thing->{fromnode})
263                                                 );
264         my $data = "$name,";
265         while (@_) {
266                 my $k = lc shift;
267                 my $v = tencode(shift);
268                 $data .= "$k=$v,";
269         }
270         chop $data;
271         return "$head|$data";
272 }
273
274
275 sub decode_input
276 {
277         my $self = shift;
278         my $line = shift;
279         return ('I', $self->{call}, $line);
280 }
281
282 sub input
283 {
284         my $line = shift;
285         my ($head, $data) = split /\|/, $line, 2;
286         return unless $head && $data;
287
288         my ($origin, $dts, $hop, $group, $user) = split /,/, $head;
289         return if DXDupe::check("Ara,$origin,$dts", $dupeage);
290         my $err;
291         $err .= "incomplete header," unless $origin && $dts && defined $hop;
292         my ($cmd, $rdata) = split /,/, $data, 2;
293
294         # validate it further
295         $err .= "missing cmd or data," unless $cmd && $data;
296         $err .= "invalid command ($cmd)," unless $cmd =~ /^[A-Z][A-Z0-9]*$/;
297         my ($gp, $tus) = split /:/, $group, 2 if $group;
298                 
299         $err .= "invalid group ($gp)," if $gp && $gp !~ /^[A-Z0-9]{2,}$/;
300         $err .= "invalid tocall ($tus)," if $tus && !is_callsign($tus);
301         $err .= "invalid fromcall ($user)," if $user && !is_callsign($user);
302
303         my $class = 'Thingy::' . ucfirst(lc $cmd);
304         my $thing;
305         my ($t, $seqno, $ntp) = decode_dts($dts) unless $err;
306         $err .= "invalid date/seq," unless $t;
307         
308         if ($err) {
309                 chop $err;
310                 dbg("Aranea input: $err");
311         } elsif ($class->can('new')) {
312                 # create the appropriate Thingy
313                 $thing = $class->new();
314
315                 # reconstitute the header but wth hop increased by one
316                 $head = join(',', $origin, $dts, ++$hop);
317                 $head .= ",$group" if $group;
318                 $head .= ",$user" if $user;
319                 $thing->{Aranea} = "$head|$data";
320
321                 # store useful data
322                 $thing->{origin} = $origin;
323                 $thing->{time} = $t;
324                 $thing->{group} = $gp if $gp;
325                 $thing->{touser} = $tus if $tus;
326                 $thing->{user} = $user if $user;
327                 $thing->{hopsaway} = $hop; 
328
329                 for (split(/,/, $rdata)) {
330                         if (/=/) {
331                                 my ($k,$v) = split /=/, $_, 2;
332                                 $thing->{$k} = tdecode($v);
333                         } else {
334                                 $thing->{$_} = 1;
335                         }
336                 }
337
338                 # post process the thing, this generally adds on semantic meaning
339                 # does parameter checking etc. It also adds / prepares the thingy so
340                 # this is compatible with older protocol and arranges data so
341                 # that the filtering can still work.
342                 if ($thing->can('from_Aranea')) {
343
344                         # if a thing is ok then return that thing, otherwise return
345                         # nothing
346                         $thing = $thing->from_Aranea;
347                 }
348         }
349         return $thing;
350 }
351
352 # this is the DXChannel send
353 # note that this does NOT send out stuff in same way as other DXChannels
354 # it is just as it comes, no extra bits added (here)
355 sub send                                                # this is always later and always data
356 {
357         my $self = shift;
358         my $conn = $self->{conn};
359         return unless $conn;
360         my $call = $self->{call};
361
362         for (@_) {
363 #               chomp;
364         my @lines = split /\n/;
365                 for (@lines) {
366                         $conn->send_later($_);
367                         dbg("-> D $call $_") if isdbg('chan');
368                 }
369         }
370         $self->{t} = $main::systime;
371 }
372
373 #
374 # load of dummies for DXChannel broadcasts
375 # these will go away in time?
376 # These are all from PC protocol
377 #
378
379 sub dx_spot
380 {
381         my $self = shift;
382         my $line = shift;
383         my $isolate = shift;
384         my ($filter, $hops);
385
386         if ($self->{spotsfilter}) {
387                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
388                 return unless $filter;
389         }
390 #       send_prot_line($self, $filter, $hops, $isolate, $line);
391 }
392
393 sub wwv
394 {
395         my $self = shift;
396         my $line = shift;
397         my $isolate = shift;
398         my ($filter, $hops);
399         
400         if ($self->{wwvfilter}) {
401                 ($filter, $hops) = $self->{wwvfilter}->it(@_);
402                 return unless $filter;
403         }
404 #       send_prot_line($self, $filter, $hops, $isolate, $line)
405 }
406
407 sub wcy
408 {
409         my $self = shift;
410         my $line = shift;
411         my $isolate = shift;
412         my ($filter, $hops);
413
414         if ($self->{wcyfilter}) {
415                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
416                 return unless $filter;
417         }
418 #       send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
419 }
420
421 sub announce
422 {
423         my $self = shift;
424         my $line = shift;
425         my $isolate = shift;
426         my $to = shift;
427         my $target = shift;
428         my $text = shift;
429         my ($filter, $hops);
430
431         if ($self->{annfilter}) {
432                 ($filter, $hops) = $self->{annfilter}->it(@_);
433                 return unless $filter;
434         }
435 #       send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
436 }
437
438 sub chat
439 {
440         goto &announce;
441 }
442
443 1;