2 # module to manage channel lists & data
4 # This is the base class for all channel operations, which is everything to do
5 # with input and output really.
7 # The instance variable in the outside world will be generally be called $dxchan
9 # This class is 'inherited' (if that is the goobledegook for what I am doing)
10 # by various other modules. The point to understand is that the 'instance variable'
11 # is in fact what normal people would call the state vector and all useful info
12 # about a connection goes in there.
14 # Another point to note is that a vector may contain a list of other vectors.
15 # I have simply added another variable to the vector for 'simplicity' (or laziness
16 # as it is more commonly called)
18 # PLEASE NOTE - I am a C programmer using this as a method of learning perl
19 # firstly and OO about ninthly (if you don't like the design and you can't
20 # improve it with better OO and thus make it smaller and more efficient, then tough).
22 # Copyright (c) 1998-2000 - Dirk Koopman G1TLH
38 use vars qw(%channels %valid @ISA $count);
45 conn => '9,Msg Conn ref',
46 user => '9,DXUser ref',
47 startt => '0,Start Time,atime',
49 pc50_t => '5,Last PC50 Time,atime',
50 priv => '9,Privilege',
51 state => '0,Current State',
52 oldstate => '5,Last State',
53 list => '9,Dep Chan List',
54 name => '0,User Name',
55 consort => '5,Connection Type',
56 'sort' => '5,Type of Channel',
57 wwv => '0,Want WWV,yesno',
58 wcy => '0,Want WCY,yesno',
59 wx => '0,Want WX,yesno',
60 talk => '0,Want Talk,yesno',
61 ann => '0,Want Announce,yesno',
62 here => '0,Here?,yesno',
63 conf => '0,In Conference?,yesno',
64 dx => '0,DX Spots,yesno',
65 redirect => '0,Redirect messages to',
68 loc => '9,Local Vars', # used by func to store local variables in
69 beep => '0,Want Beeps,yesno',
70 lastread => '5,Last Msg Read',
71 outbound => '5,outbound?,yesno',
72 remotecmd => '9,doing rcmd,yesno',
73 pagelth => '0,Page Length',
74 pagedata => '9,Page Data Store',
75 group => '0,Access Group,parray', # used to create a group of users/nodes for some purpose or other
76 isolate => '5,Isolate network,yesno',
77 delayed => '5,Delayed messages,parray',
78 annfilter => '5,Ann Filt-out',
79 wwvfilter => '5,WWV Filt-out',
80 wcyfilter => '5,WCY Filt-out',
81 spotsfilter => '5,Spot Filt-out',
82 routefilter => '5,Route Filt-out',
83 inannfilter => '5,Ann Filt-inp',
84 inwwvfilter => '5,WWV Filt-inp',
85 inwcyfilter => '5,WCY Filt-inp',
86 inspotsfilter => '5,Spot Filt-inp',
87 inroutefilter => '5,Route Filt-inp',
88 passwd => '9,Passwd List,yesno',
89 pingint => '5,Ping Interval ',
90 nopings => '5,Ping Obs Count',
91 lastping => '5,Ping last sent,atime',
92 pingtime => '5,Ping totaltime,parray',
93 pingave => '0,Ping ave time',
94 logininfo => '9,Login info req,yesno',
95 talklist => '0,Talk List,parray',
96 cluster => '5,Cluster data',
97 isbasic => '9,Internal Connection',
99 route => '9,Route Data',
100 dxcc => '0,Country Code',
103 enhanced => '5,Enhanced Client,yesno',
104 gtk => '5,Using GTK,yesno',
105 senddbg => '8,Sending Debug,yesno',
106 width => '0,Column Width',
107 disconnecting => '9,Disconnecting,yesno',
108 ann_talk => '0,Suppress Talk Anns,yesno',
109 metric => '1,Route metric',
110 badcount => '1,Bad Word Count',
111 edit => '7,Edit Function',
112 registered => '9,Registered?,yesno',
113 prompt => '0,Required Prompt',
114 version => '1,Node Version',
115 build => '1,Node Build',
116 verified => '9,Verified?,yesno',
117 newroute => '1,New Style Routing,yesno',
118 ve7cc => '0,VE7CC program special,yesno',
119 lastmsgpoll => '0,Last Msg Poll,atime',
120 inscript => '9,In a script,yesno',
121 handle_xml => '9,Handles XML,yesno',
122 inqueue => '9,Input Queue,parray',
125 use vars qw($VERSION $BRANCH);
126 $VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
127 $BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ || (0,0));
128 $main::build += $VERSION;
129 $main::branch += $BRANCH;
136 if (ref($self->{$_})) {
140 dbg("DXChannel $self->{call} destroyed ($count)") if isdbg('chan');
144 # create a new channel object [$obj = DXChannel->new($call, $msg_conn_obj, $user_obj)]
147 my ($pkg, $call, $conn, $user) = @_;
150 die "trying to create a duplicate channel for $call" if $channels{$call};
151 $self->{call} = $call;
153 $self->{conn} = $conn if defined $conn; # if this isn't defined then it must be a list
155 $self->{user} = $user;
156 $self->{lang} = $user->lang;
157 $user->new_group unless $user->group;
158 $user->new_buddies unless $user->buddies;
159 $self->{group} = $user->group;
160 $self->{sort} = $user->sort;
162 $self->{startt} = $self->{t} = time;
164 $self->{oldstate} = 0;
165 $self->{lang} = $main::lang if !$self->{lang};
168 # add in all the dxcc, itu, zone info
169 my @dxcc = Prefix::extract($call);
171 $self->{dxcc} = $dxcc[1]->dxcc;
172 $self->{itu} = $dxcc[1]->itu;
173 $self->{cq} = $dxcc[1]->cq;
175 $self->{inqueue} = [];
178 dbg("DXChannel $self->{call} created ($count)") if isdbg('chan');
180 return $channels{$call} = $self;
183 # rebless this channel as something else
188 return $channels{$self->{call}} = bless $self, $class;
193 my ($self, $msg) = @_;
195 # queue the message and the channel object for later processing
197 push @{$self->{inqueue}}, $msg;
201 # obtain a channel object by callsign [$obj = DXChannel::get($call)]
205 return $channels{$call};
208 # obtain all the channel objects
211 return values(%channels);
215 # gimme all the ak1a nodes
221 foreach $ref (values %channels) {
222 push @out, $ref if $ref->is_node;
227 # return a list of all users
232 foreach $ref (values %channels) {
233 push @out, $ref if $ref->is_user;
238 # return a list of all user callsigns
239 sub get_all_user_calls
243 foreach $ref (values %channels) {
244 push @out, $ref->{call} if $ref->is_user;
249 # obtain a channel object by searching for its connection reference
252 my ($pkg, $conn) = @_;
255 foreach $self (values(%channels)) {
256 return $self if ($self->{conn} == $conn);
261 # get rid of a channel object [$obj->del()]
266 $self->{group} = undef; # belt and braces
267 delete $channels{$self->{call}};
274 return $self->{'sort'} eq 'B';
280 return $self->{'sort'} =~ /[ACRSXW]/;
282 # is it an ak1a node ?
286 return $self->{'sort'} eq 'A';
293 return $self->{'sort'} eq 'U';
300 return $self->{'sort'} eq 'C';
307 return $self->{'sort'} eq 'W';
310 # is it a spider node
314 return $self->{'sort'} eq 'S';
321 return $self->{'sort'} eq 'X';
324 # is it a ar-cluster node
328 return $self->{'sort'} eq 'R';
331 # for perl 5.004's benefit
335 return @_ ? $self->{'sort'} = shift : $self->{'sort'} ;
338 # find out whether we are prepared to believe this callsign on this interface
344 return grep $call eq $_, $self->user->believe;
347 # handle out going messages, immediately without waiting for the select to drop
348 # this could, in theory, block
352 my $conn = $self->{conn};
355 my $call = $self->{call};
359 my @lines = split /\n/;
361 $conn->send_now("$sort$call|$_");
362 # debug log it, but not if it is a log message
363 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
370 # send later with letter (more control)
376 my $conn = $self->{conn};
379 my $call = $self->{call};
383 my @lines = split /\n/;
385 $conn->send_later("$sort$call|$_");
386 # debug log it, but not if it is a log message
387 dbg("-> $sort $call $_") if $sort ne 'L' && isdbg('chan');
394 # the normal output routine
396 sub send # this is always later and always data
399 my $conn = $self->{conn};
401 my $call = $self->{call};
404 for (ref $l ? @$l : $l) {
405 my @lines = split /\n/;
407 $conn->send_later("D$call|$_");
408 dbg("-> D $call $_") if isdbg('chan');
412 $self->{t} = $main::systime;
415 # send a file (always later)
418 my ($self, $fn) = @_;
419 my $call = $self->{call};
420 my $conn = $self->{conn};
423 open(F, $fn) or die "can't open $fn for sending file ($!)";
429 # this will implement language independence (in time)
433 return DXM::msg($self->{lang}, @_);
436 # stick a broadcast on the delayed queue (but only up to 20 items)
442 $self->{delayed} = [] unless $self->{delayed};
443 push @{$self->{delayed}}, $s;
444 if (@{$self->{delayed}} >= 20) {
445 shift @{$self->{delayed}}; # lose oldest one
449 # change the state of the channel - lots of scope for debugging here :-)
454 $self->{oldstate} = $self->{state};
455 $self->{state} = shift;
456 $self->{func} = '' unless defined $self->{func};
457 dbg("$self->{call} channel func $self->{func} state $self->{oldstate} -> $self->{state}\n") if isdbg('state');
459 # if there is any queued up broadcasts then splurge them out here
460 if ($self->{delayed} && ($self->{state} eq 'prompt' || $self->{state} eq 'talk')) {
461 $self->send (@{$self->{delayed}});
462 delete $self->{delayed};
465 return $self->{state};
468 # disconnect this channel
472 my $user = $self->{user};
474 $user->close() if defined $user;
475 $self->{conn}->disconnect;
480 # just close all the socket connections down without any fiddling about, cleaning, being
481 # nice to other processes and otherwise telling them what is going on.
483 # This is for the benefit of forked processes to prepare for starting new programs, they
484 # don't want or need all this baggage.
490 foreach $ref (values %channels) {
491 $ref->{conn}->disconnect() if $ref->{conn};
496 # Tell all the users that we have come in or out (if they want to know)
500 my ($self, $m, $call) = @_;
502 $call ||= $self->{call};
504 # send info to all logged in thingies
505 my @dxchan = get_all_users();
507 foreach $dxchan (@dxchan) {
508 next if $dxchan == $self;
509 next if $dxchan->{call} eq $main::mycall;
510 $dxchan->send($dxchan->msg($m, $call)) if $dxchan->{logininfo};
515 # Tell all the users if a buddy is logged or out
519 my ($self, $m, $call, $node) = @_;
521 $call ||= $self->{call};
525 # send info to all logged in thingies
526 my @dxchan = get_all_users();
528 foreach $dxchan (@dxchan) {
529 next if $dxchan == $self;
530 next if $dxchan->{call} eq $main::mycall;
531 $dxchan->send($dxchan->msg($m, $call, $node)) if grep $_ eq $call, @{$dxchan->{user}->{buddies}} ;
535 # various access routines
538 # return a list of valid elements
547 # return a prompt for a field
552 my ($self, $ele) = @_;
556 # take a standard input message and decode it into its standard parts
561 my ($sort, $call, $line) = $data =~ /^([A-Z])([A-Z0-9\-]{3,9})\|(.*)$/;
563 my $chcall = (ref $dxchan) ? $dxchan->call : "UN.KNOWN";
565 # the above regexp must work
566 unless (defined $sort && defined $call && defined $line) {
567 # $data =~ s/([\x00-\x1f\x7f-\xff])/uc sprintf("%%%02x",ord($1))/eg;
568 dbg("DUFF Line on $chcall: $data");
572 if(ref($dxchan) && $call ne $chcall) {
573 dbg("DUFF Line come in for $call on wrong channel $chcall");
577 return ($sort, $call, $line);
582 my ($self, $flag, $node, $user) = @_;
583 my $nref = Route::Node::get($node);
584 my $dxchan = $nref->dxchan if $nref;
585 if ($nref && $dxchan) {
586 if ($dxchan == $self) {
587 return 1 unless $user;
588 return 1 if $user eq $node;
589 my @users = $nref->users;
590 return 1 if @users == 0 || grep $user eq $_, @users;
591 dbg("RSPF: $user not on $node") if isdbg('chanerr');
593 dbg("RSPF: Shortest path for $node is " . $nref->dxchan->{call}) if isdbg('chanerr');
597 dbg("RSPF: required $node not found" ) if isdbg('chanerr');
602 # broadcast a message to all clusters taking into account isolation
603 # [except those mentioned after buffer]
606 my $s = shift; # the line to be rebroadcast
607 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
608 my @dxchan = get_all_nodes();
611 # send it if it isn't the except list and isn't isolated and still has a hop count
612 foreach $dxchan (@dxchan) {
613 next if grep $dxchan == $_, @except;
614 next if $dxchan == $main::me;
616 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
618 $dxchan->send($routeit) unless $dxchan->{isolate} || !$routeit;
622 # broadcast a message to all clusters ignoring isolation
623 # [except those mentioned after buffer]
624 sub broadcast_all_nodes
626 my $s = shift; # the line to be rebroadcast
627 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
628 my @dxchan = get_all_nodes();
631 # send it if it isn't the except list and isn't isolated and still has a hop count
632 foreach $dxchan (@dxchan) {
633 next if grep $dxchan == $_, @except;
634 next if $dxchan == $main::me;
636 my $routeit = $dxchan->can('adjust_hops') ? $dxchan->adjust_hops($s) : $s; # adjust its hop count by node name
637 $dxchan->send($routeit);
641 # broadcast to all users
642 # storing the spot or whatever until it is in a state to receive it
645 my $s = shift; # the line to be rebroadcast
646 my $sort = shift; # the type of transmission
647 my $fref = shift; # a reference to an object to filter on
648 my @except = @_; # to all channels EXCEPT these (dxchannel refs)
649 my @dxchan = get_all_users();
653 foreach $dxchan (@dxchan) {
654 next if grep $dxchan == $_, @except;
657 broadcast_list($s, $sort, $fref, @out);
661 # broadcast to a list of users
669 foreach $dxchan (@_) {
671 next if $dxchan == $main::me;
674 next unless $dxchan->{dx};
675 ($filter) = $dxchan->{spotsfilter}->it(@{$fref}) if ref $fref;
678 next if $sort eq 'ann' && !$dxchan->{ann} && $s !~ /^To\s+LOCAL\s+de\s+(?:$main::myalias|$main::mycall)/i;
679 next if $sort eq 'wwv' && !$dxchan->{wwv};
680 next if $sort eq 'wcy' && !$dxchan->{wcy};
681 next if $sort eq 'wx' && !$dxchan->{wx};
683 $s =~ s/\a//og unless $dxchan->{beep};
685 if ($dxchan->{state} eq 'prompt' || $dxchan->{state} eq 'talk') {
695 foreach my $dxchan (get_all()) {
697 while (my $data = shift @{$dxchan->{inqueue}}) {
698 my ($sort, $call, $line) = $dxchan->decode_input($data);
699 next unless defined $sort;
701 # do the really sexy console interface bit! (Who is going to do the TK interface then?)
702 dbg("<- $sort $call $line") if $sort ne 'D' && isdbg('chan');
703 if ($dxchan->{disconnecting}) {
704 dbg('In disconnection, ignored');
709 my $user = $dxchan->user;
710 if ($sort eq 'A' || $sort eq 'O') {
711 $dxchan->start($line, $sort);
712 } elsif ($sort eq 'I') {
713 die "\$user not defined for $call" if !defined $user;
716 $dxchan->normal($line);
717 } elsif ($sort eq 'Z') {
719 } elsif ($sort eq 'D') {
720 ; # ignored (an echo)
721 } elsif ($sort eq 'G') {
722 $dxchan->enhanced($line);
724 print STDERR atime, " Unknown command letter ($sort) received from $call\n";
735 if (DXXml::available()) {
736 $r = $self->{handle_xml} || 0;
738 delete $self->{handle_xml} if exists $self->{handle_xml};
747 my $name = $AUTOLOAD;
748 return if $name =~ /::DESTROY$/;
751 confess "Non-existant field '$AUTOLOAD'" if !$valid{$name};
753 # this clever line of code creates a subroutine which takes over from autoload
754 # from OO Perl - Conway
755 *$AUTOLOAD = sub {@_ > 1 ? $_[0]->{$name} = $_[1] : $_[0]->{$name}};