added more routing code
[spider.git] / perl / Thingy.pm
1 #
2 # Thingy handling
3 #
4 # This is the new fundamental protocol engine handler
5
6 # This is where all the new things (and eventually all the old things
7 # as well) happen.
8 #
9 # $Id$
10 #
11 # Copyright (c) 2004 Dirk Koopman G1TLH
12 #
13
14 use strict;
15
16 package Thingy;
17
18 use vars qw($VERSION $BRANCH @queue @permin @persec);
19
20 main::mkver($VERSION = q$Revision$);
21
22 @queue = ();                                    # the input / processing queue
23
24 #
25 # these are set up using the Thingy->add_second_process($addr, $name)
26 # and Thingy->add_minute_process($addr, $name)
27 #
28 # They replace the old cycle in cluster.pl
29 #
30
31 @persec = ();                                   # this replaces the cycle in cluster.pl
32 @permin = ();                                   # this is an extra per minute cycle
33
34 my $lastsec = time;
35 my $lastmin = time;
36
37 use DXChannel;
38 use DXDebug;
39
40 # we expect all thingies to be subclassed
41 sub new
42 {
43         my $class = shift;
44         my $thing = {@_};
45         
46         bless $thing, $class;
47         return $thing;
48 }
49
50 # send it out in the format asked for, if available
51 sub send
52 {
53         my $thing = shift;
54         my $dxchan = shift;
55         my $class;
56         if (@_) {
57                 $class = shift;
58         } elsif ($dxchan->isa('DXChannel')) {
59                 $class = ref $dxchan;
60         }
61
62         # do output filtering
63         if ($thing->can('out_filter')) {
64                 return unless $thing->out_filter($dxchan);
65         }
66
67         # generate the line which may (or not) be cached
68         my $ref;
69         unless ($ref = $thing->{class}) {
70                 no strict 'refs';
71                 my $sub = "gen_$class";
72                 $ref = $thing->$sub($dxchan) if $thing->can($sub);
73         }
74         $dxchan->send(ref $ref ? @$ref : $ref) if $ref;
75 }
76
77 # broadcast to all except @_
78 sub broadcast
79 {
80         my $thing = shift;
81         dbg("Thingy::broadcast: " . $thing->ascii) if isdbg('thing'); 
82
83         foreach my $dxchan (DXChannel::get_all()) {
84                 next if $dxchan == $main::me;
85                 next if grep $dxchan == $_, @_;
86                 $thing->send($dxchan); 
87         }
88 }
89
90 # queue this thing for processing
91 sub queue
92 {
93         my $thing = shift;
94         my $dxchan = shift;
95         $thing->{dxchan} = $dxchan->call;
96         push @queue, $thing;
97 }
98
99 # this is the main commutator loop. In due course it will
100 # become the *only* commutator loop
101 sub process
102 {
103         my $thing;
104         while (@queue) {
105                 $thing = shift @queue;
106                 my $dxchan = DXChannel->get($thing->{dxchan});
107                 if ($dxchan) {
108                         if ($thing->can('in_filter')) {
109                                 next unless $thing->in_filter($dxchan);
110                         }
111
112                         # remember any useful routes
113                         RouteDB::update($thing->{origin}, $dxchan->{call}, $thing->{hopsaway});
114                         RouteDB::update($thing->{user}, $dxchan->{call}, $thing->{hopsaway}) if exists $thing->{user};
115                 
116                         $thing->handle($dxchan);
117                 }
118         }
119
120         # per second and per minute processing
121         if ($main::systime != $lastsec) {
122                 if ($main::systime >= $lastmin+60) {
123                         foreach my $r (@permin) {
124                                 &{$r->[0]}();
125                         }
126                         $lastmin = $main::systime;
127                 }
128                 foreach my $r (@persec) {
129                         &{$r->[0]}();
130                 }
131                 $lastsec = $main::systime;
132         }
133 }
134
135 sub add_minute_process
136 {
137         my $pkg = shift;
138         my $addr = shift;
139         my $name = shift;
140         dbg('Adding $name to Thingy per minute queue');
141         push @permin, [$addr, $name];
142 }
143
144 sub add_second_process
145 {
146         my $pkg = shift;
147         my $addr = shift;
148         my $name = shift;
149         dbg('Adding $name to Thingy per second queue');
150         push @persec, [$addr, $name];
151 }
152
153
154 sub ascii
155 {
156         my $thing = shift;
157         my $dd = new Data::Dumper([$thing]);
158         $dd->Indent(0);
159         $dd->Terse(1);
160         $dd->Sortkeys(1);
161     $dd->Quotekeys($] < 5.005 ? 1 : 0);
162         return $dd->Dumpxs;
163 }
164 1;
165