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 .= ",$from" if $from;
 210         $seqno++;
 211         $seqno = 0 if $seqno > 0x0ffff;
 212         return $r;
 213 }
 214
 215 #
 216 # decode the date time sequence group
 217 #
 218
 219 sub decode_dts
 220 {
 221         my $dts = shift;
 222         my ($dt, $seqno) = map {hex} unpack "H6H4", $dts;
 223         my $secs = $dt & 0x3FFFF;
 224         $dt >>= 18;
 225         my $day = $dt >> 1;
 226         my $ntp = $dt & 1;
 227         my $t;
 228         if ($dayno == $day) {
 229                 $t = $daystart + $secs;
 230         } elsif ($dayno < $day) {
 231                 $t = $daystart + (($day-$dayno) * 86400) + $secs;
 232         } else {
 233                 $t = $daystart + (($dayno-$day) * 86400) + $secs;
 234         }
 235         return ($t, $seqno, $ntp);
 236 }
 237
 238 # subroutines to encode and decode values in lists
 239 sub tencode
 240 {
 241         my $s = shift;
 242         $s =~ s/([\%=|,\'\x00-\x1f\x7f-\xff])/sprintf("%%%02X", ord($1))/eg;
 243         $s = "'$s'" if $s =~ / /;
 244         return $s;
 245 }
 246
 247 sub tdecode
 248 {
 249         my $s = shift;
 250         $s =~ s/^'(.*)'$/$1/;
 251         $s =~ s/\%([0-9A-F][0-9A-F])/chr(hex($1))/eg;
 252         return $s;
 253 }
 254
 255 sub genmsg
 256 {
 257         my $thing = shift;
 258         my $name = shift;
 259         my $head = genheader($thing->{origin},
 260                                                  ($thing->{group} || $thing->{touser} || $thing->{tonode}),
 261                                                  ($thing->{user} || $thing->{fromuser} || $thing->{fromnode})
 262                                                 );
 263         my $data = "$name,";
 264         while (@_) {
 265                 my $k = lc shift;
 266                 my $v = tencode(shift);
 267                 $data .= "$k=$v,";
 268         }
 269         chop $data;
 270         return "$head|$data";
 271 }
 272
 273
 274 sub decode_input
 275 {
 276         my $self = shift;
 277         my $line = shift;
 278         return ('I', $self->{call}, $line);
 279 }
 280
 281 sub input
 282 {
 283         my $line = shift;
 284         my ($head, $data) = split /\|/, $line, 2;
 285         return unless $head && $data;
 286
 287         my ($origin, $dts, $hop, $group, $user) = split /,/, $head;
 288         return if DXDupe::check("Ara,$origin,$dts", $dupeage);
 289         my $err;
 290         $err .= "incomplete header," unless $origin && $dts && defined $hop;
 291         my ($cmd, $rdata) = split /,/, $data, 2;
 292
 293         # validate it further
 294         $err .= "missing cmd or data," unless $cmd && $data;
 295         $err .= "invalid command ($cmd)," unless $cmd =~ /^[A-Z][A-Z0-9]*$/;
 296         my ($gp, $tus) = split /:/, $group, 2 if $group;
 297
 298         $err .= "invalid group ($gp)," if $gp && $gp !~ /^[A-Z0-9]{2,}$/;
 299         $err .= "invalid tocall ($tus)," if $tus && !is_callsign($tus);
 300         $err .= "invalid fromcall ($user)," if $user && !is_callsign($user);
 301
 302         my $class = 'Thingy::' . ucfirst(lc $cmd);
 303         my $thing;
 304         my ($t, $seqno, $ntp) = decode_dts($dts) unless $err;
 305         $err .= "invalid date/seq," unless $t;
 306
 307         if ($err) {
 308                 chop $err;
 309                 dbg("Aranea input: $err");
 310         } elsif ($class->can('new')) {
 311                 # create the appropriate Thingy
 312                 $thing = $class->new();
 313
 314                 # reconstitute the header but wth hop increased by one
 315                 $head = join(',', $origin, $dts, ++$hop);
 316                 $head .= ",$group" if $group;
 317                 $head .= ",$user" if $user;
 318                 $thing->{Aranea} = "$head|$data";
 319
 320                 # store useful data
 321                 $thing->{origin} = $origin;
 322                 $thing->{time} = $t;
 323                 $thing->{group} = $gp if $gp;
 324                 $thing->{touser} = $tus if $tus;
 325                 $thing->{user} = $user if $user;
 326                 $thing->{hopsaway} = $hop;
 327
 328                 for (split(/,/, $rdata)) {
 329                         if (/=/) {
 330                                 my ($k,$v) = split /=/, $_, 2;
 331                                 $thing->{$k} = tdecode($v);
 332                         } else {
 333                                 $thing->{$_} = 1;
 334                         }
 335                 }
 336
 337                 # post process the thing, this generally adds on semantic meaning
 338                 # does parameter checking etc. It also adds / prepares the thingy so
 339                 # this is compatible with older protocol and arranges data so
 340                 # that the filtering can still work.
 341                 if ($thing->can('from_Aranea')) {
 342
 343                         # if a thing is ok then return that thing, otherwise return
 344                         # nothing
 345                         $thing = $thing->from_Aranea;
 346                 }
 347         }
 348         return $thing;
 349 }
 350
 351 # this is the DXChannel send
 352 # note that this does NOT send out stuff in same way as other DXChannels
 353 # it is just as it comes, no extra bits added (here)
 354 sub send                                                # this is always later and always data
 355 {
 356         my $self = shift;
 357         my $conn = $self->{conn};
 358         return unless $conn;
 359         my $call = $self->{call};
 360
 361         for (@_) {
 362 #               chomp;
 363         my @lines = split /\n/;
 364                 for (@lines) {
 365                         $conn->send_later($_);
 366                         dbg("-> D $call $_") if isdbg('chan');
 367                 }
 368         }
 369         $self->{t} = $main::systime;
 370 }
 371
 372 #
 373 # load of dummies for DXChannel broadcasts
 374 # these will go away in time?
 375 # These are all from PC protocol
 376 #
 377
 378 sub dx_spot
 379 {
 380         my $self = shift;
 381         my $line = shift;
 382         my $isolate = shift;
 383         my ($filter, $hops);
 384
 385         if ($self->{spotsfilter}) {
 386                 ($filter, $hops) = $self->{spotsfilter}->it(@_);
 387                 return unless $filter;
 388         }
 389 #       send_prot_line($self, $filter, $hops, $isolate, $line);
 390 }
 391
 392 sub wwv
 393 {
 394         my $self = shift;
 395         my $line = shift;
 396         my $isolate = shift;
 397         my ($filter, $hops);
 398
 399         if ($self->{wwvfilter}) {
 400                 ($filter, $hops) = $self->{wwvfilter}->it(@_);
 401                 return unless $filter;
 402         }
 403 #       send_prot_line($self, $filter, $hops, $isolate, $line)
 404 }
 405
 406 sub wcy
 407 {
 408         my $self = shift;
 409         my $line = shift;
 410         my $isolate = shift;
 411         my ($filter, $hops);
 412
 413         if ($self->{wcyfilter}) {
 414                 ($filter, $hops) = $self->{wcyfilter}->it(@_);
 415                 return unless $filter;
 416         }
 417 #       send_prot_line($self, $filter, $hops, $isolate, $line) if $self->is_clx || $self->is_spider || $self->is_dxnet;
 418 }
 419
 420 sub announce
 421 {
 422         my $self = shift;
 423         my $line = shift;
 424         my $isolate = shift;
 425         my $to = shift;
 426         my $target = shift;
 427         my $text = shift;
 428         my ($filter, $hops);
 429
 430         if ($self->{annfilter}) {
 431                 ($filter, $hops) = $self->{annfilter}->it(@_);
 432                 return unless $filter;
 433         }
 434 #       send_prot_line($self, $filter, $hops, $isolate, $line) unless $_[1] eq $main::mycall;
 435 }
 436
 437 sub chat
 438 {
 439         goto &announce;
 440 }
 441
 442 1;