]> www.dxcluster.org Git - spider.git/blob - perl/Msg.pm
add dbg line to dxcron::spawn_cmd
[spider.git] / perl / Msg.pm
1 #
2 # This has been taken from the 'Advanced Perl Programming' book by Sriram Srinivasan 
3 #
4 # I am presuming that the code is distributed on the same basis as perl itself.
5 #
6 # I have modified it to suit my devious purposes (Dirk Koopman G1TLH)
7 #
8 #
9 #
10
11 package Msg;
12
13 use strict;
14
15 use DXUtil;
16
17 use Mojo::IOLoop;
18 use Mojo::IOLoop::Stream;
19
20 use DXDebug;
21 use Timer;
22
23 use vars qw($now %conns $noconns $cnum $total_in $total_out $connect_timeout);
24
25 $total_in = $total_out = 0;
26
27 $now = time;
28
29 $cnum = 0;
30 $connect_timeout = 5;
31
32 #
33 #-----------------------------------------------------------------
34 # Generalised initializer
35
36 sub new
37 {
38     my ($pkg, $rproc) = @_;
39         my $obj = ref($pkg);
40         my $class = $obj || $pkg;
41
42     my $conn = {
43         rproc => $rproc,
44                 inqueue => [],
45                 outqueue => [],
46                 state => 0,
47                 lineend => "\r\n",
48                 csort => 'telnet',
49                 timeval => 60,
50                 blocking => 0,
51                 cnum => (($cnum < 999) ? (++$cnum) : ($cnum = 1)),
52     };
53
54         $noconns++;
55         
56         dbg("$class Connection created (total $noconns)") if isdbg('connll');
57         return bless $conn, $class;
58 }
59
60 sub set_error
61 {
62         my $conn = shift;
63         my $callback = shift;
64         $conn->{sock}->on(error => sub {$callback->($_[1]);});
65 }
66
67 sub set_on_eof
68 {
69         my $conn = shift;
70         my $callback = shift;
71         $conn->{sock}->on(close => sub {$callback->()});
72 }
73
74 sub set_rproc
75 {
76         my $conn = shift;
77         my $callback = shift;
78         $conn->{rproc} = $callback;
79 }
80
81 # save it
82 sub conns
83 {
84         my $pkg = shift;
85         my $call = shift;
86         my $ref;
87         
88         if (ref $pkg) {
89                 $call = $pkg->{call} unless $call;
90                 return undef unless $call;
91                 dbg((ref $pkg) . " changing $pkg->{call} to $call") if isdbg('connll') && exists $pkg->{call} && $call ne $pkg->{call};
92                 delete $conns{$pkg->{call}} if exists $pkg->{call} && exists $conns{$pkg->{call}} && $pkg->{call} ne $call; 
93                 $pkg->{call} = $call;
94                 $ref = $conns{$call} = $pkg;
95                 dbg((ref $pkg) . " Connection $pkg->{cnum} $call stored") if isdbg('connll');
96         } else {
97                 $ref = $conns{$call};
98         }
99         return $ref;
100 }
101
102 # this is only called by any dependent processes going away unexpectedly
103 sub pid_gone
104 {
105         my ($pkg, $pid) = @_;
106         
107         my @pid = grep {$_->{pid} == $pid} values %conns;
108         foreach my $p (@pid) {
109                 &{$p->{eproc}}($p, "$pid has gorn") if exists $p->{eproc};
110                 $p->disconnect;
111         }
112 }
113
114 sub ax25
115 {
116         my $conn = shift;
117         return $conn->{csort} eq 'ax25';
118 }
119
120 sub peerhost
121 {
122         my $conn = shift;
123         unless ($conn->{peerhost}) {
124                 $conn->{peerhost} ||= 'ax25' if $conn->ax25;
125                 $conn->{peerhost} ||= $conn->{sock}->handle->peerhost if $conn->{sock};
126                 $conn->{peerhost} ||= 'UNKNOWN';
127         }
128         return $conn->{peerhost};
129 }
130
131 #-----------------------------------------------------------------
132 # Send side routines
133
134 sub _on_connect
135 {
136         my $conn = shift;
137         my $handle = shift;
138         undef $conn->{sock};
139         my $sock = $conn->{sock} = Mojo::IOLoop::Stream->new($handle);
140         $sock->on(read => sub {$conn->_rcv($_[1]);} );
141         $sock->on(error => sub {delete $conn->{sock}; $conn->disconnect;});
142         $sock->on(close => sub {delete $conn->{sock}; $conn->disconnect;});
143         $sock->timeout(0);
144         $sock->start;
145         $conn->{peerhost} = eval { $handle->peerhost; };
146         dbg((ref $conn) . " connected $conn->{cnum} to $conn->{peerhost}:$conn->{peerport}") if isdbg('connll');
147         if ($conn->{on_connect}) {
148                 &{$conn->{on_connect}}($conn, $handle);
149         }
150 }
151
152 sub is_connected
153 {
154         my $conn = shift;
155         my $sock = $conn->{sock};
156         return ref $sock && $sock->isa('Mojo::IOLoop::Stream');
157 }
158
159 sub connect {
160     my ($pkg, $to_host, $to_port, %args) = @_;
161         my $timeout = delete $args{timeout} || $connect_timeout;
162         
163     # Create a connection end-point object
164     my $conn = $pkg;
165         unless (ref $pkg) {
166                 my $rproc = delete $args{rproc}; 
167                 $conn = $pkg->new($rproc);
168         }
169         $conn->{peerhost} = $to_host;
170         $conn->{peerport} = $to_port;
171         $conn->{sort} = 'Outgoing';
172
173         dbg((ref $conn) . " connecting $conn->{cnum} to $to_host:$to_port") if isdbg('connll');
174         
175         my $sock;
176         $conn->{sock} = $sock = Mojo::IOLoop::Client->new;
177         $sock->on(connect => sub {$conn->_on_connect($_[1])} );
178         $sock->on(error => sub {&{$conn->{eproc}}($conn, $_[1]) if exists $conn->{eproc}; $conn->disconnect});
179         $sock->on(close => sub {$conn->disconnect});
180
181         # copy any args like on_connect, on_disconnect etc
182         while (my ($k, $v) = each %args) {
183                 $conn->{$k} = $v;
184         }
185         
186         $sock->connect(address => $to_host, port => $to_port, timeout => $timeout);
187         
188     return $conn;
189 }
190
191 sub start_program
192 {
193         my ($conn, $line, $sort) = @_;
194         my $pid;
195         
196 #       local $^F = 10000;              # make sure it ain't closed on exec
197 #       my ($a, $b) = $io_socket->socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC);
198 #       if ($a && $b) {
199 #               $a->autoflush(1);
200 #               $b->autoflush(1);
201 #               $pid = fork;
202 #               if (defined $pid) {
203 #                       if ($pid) {
204 #                               close $b;
205 #                               $conn->{sock} = $a;
206 #                               $conn->{csort} = $sort;
207 #                               $conn->{lineend} = "\cM" if $sort eq 'ax25';
208 #                               $conn->{pid} = $pid;
209 #                               if ($conn->{rproc}) {
210 #                                       my $callback = sub {$conn->_rcv};
211 #                                       Msg::set_event_handler ($a, read => $callback);
212 #                               }
213 #                               dbg("connect $conn->{cnum}: started pid: $conn->{pid} as $line") if isdbg('connect');
214 #                       } else {
215 #                               $^W = 0;
216 #                               dbgclose();
217 #                               STDIN->close;
218 #                               STDOUT->close;
219 #                               STDOUT->close;
220 #                               *STDIN = IO::File->new_from_fd($b, 'r') or die;
221 #                               *STDOUT = IO::File->new_from_fd($b, 'w') or die;
222 #                               *STDERR = IO::File->new_from_fd($b, 'w') or die;
223 #                               close $a;
224 #                               unless ($main::is_win) {
225 #                                       #                                               $SIG{HUP} = 'IGNORE';
226 #                                       $SIG{HUP} = $SIG{CHLD} = $SIG{TERM} = $SIG{INT} = 'DEFAULT';
227 #                                       alarm(0);
228 #                               }
229 #                               exec "$line" or dbg("exec '$line' failed $!");
230 #                       } 
231 #               } else {
232 #                       dbg("cannot fork for $line");
233 #               }
234 #       } else {
235 #               dbg("no socket pair $! for $line");
236 #       }
237         return $pid;
238 }
239
240 sub disconnect 
241 {
242     my $conn = shift;
243         return if exists $conn->{disconnecting};
244
245         $conn->{disconnecting} = 1;
246     my $sock = delete $conn->{sock};
247         $conn->{state} = 'E';
248         $conn->{timeout}->del if $conn->{timeout};
249
250         # be careful to delete the correct one
251         my $call;
252         if ($call = $conn->{call}) {
253                 my $ref = $conns{$call};
254                 delete $conns{$call} if $ref && $ref == $conn;
255         }
256         $call ||= 'unallocated';
257         dbg((ref $conn) . " Connection $conn->{cnum} $call disconnected") if isdbg('connll');
258         
259         if ($conn->{on_disconnect}) {
260                 &{$conn->{on_disconnect}}($conn);
261         }
262
263         # get rid of any references
264         for (keys %$conn) {
265                 if (ref($conn->{$_})) {
266                         delete $conn->{$_};
267                 }
268         }
269
270         $sock->close_gracefully if defined $sock && $sock->can('close_gracefully');
271         undef $sock;
272         
273         unless ($main::is_win) {
274                 kill 'TERM', $conn->{pid} if exists $conn->{pid};
275         }
276 }
277
278 sub _send_stuff
279 {
280         my $conn = shift;
281         my $rq = $conn->{outqueue};
282     my $sock = $conn->{sock};
283         return unless defined $sock;
284         return if $conn->{disconnecting};
285         
286         while (@$rq) {
287                 my $data = shift @$rq;
288                 my $lth = length $data;
289                 my $call = $conn->{call} || 'none';
290                 if (isdbg('raw')) {
291                         if (isdbg('raw')) {
292                                 dbgdump('raw', "$call send $lth: ", $lth);
293                         }
294                 }
295                 if (defined $sock) {
296                         $sock->write($data);
297                         $total_out += $lth;
298                 } else {
299                         dbg("_send_stuff $call ending data ignored: $data");
300                 }
301         }
302 }
303
304 sub send_now {
305     my ($conn, $msg) = @_;
306     $conn->enqueue($msg);
307     _send_stuff($conn);
308 }
309
310 sub send_later {
311         goto &send_now;
312 }
313
314 sub send_raw
315 {
316     my ($conn, $msg) = @_;
317         push @{$conn->{outqueue}}, $msg;
318         _send_stuff($conn);
319 }
320
321 sub enqueue {
322     my $conn = shift;
323     push @{$conn->{outqueue}}, defined $_[0] ? $_[0] : '';
324 }
325
326 sub _err_will_block 
327 {
328         return 0;
329 }
330
331 sub close_on_empty
332 {
333         my $conn = shift;
334         $conn->{sock}->on(drain => sub {$conn->disconnect;});
335 }
336
337 #-----------------------------------------------------------------
338 # Receive side routines
339
340 sub new_server 
341 {
342 #    @_ == 4 || die "Msg->new_server (myhost, myport, login_proc)\n";
343         my ($pkg, $my_host, $my_port, $login_proc) = @_;
344         my $conn = $pkg->new($login_proc);
345         
346     my $sock = $conn->{sock} = Mojo::IOLoop::Server->new;
347         $sock->on(accept=>sub{$conn->new_client($_[1]);});
348         $sock->listen(address=>$my_host, port=>$my_port);
349         $sock->start;
350         
351     die "Could not create socket: $! \n" unless $conn->{sock};
352         return $conn;
353 }
354
355
356 sub nolinger
357 {
358         my $conn = shift;
359 }
360
361 sub dequeue
362 {
363         my $conn = shift;
364         return if $conn->{disconnecting};
365         
366         if ($conn->{msg} =~ /\cJ/) {
367                 my @lines = split /\cM?\cJ/, $conn->{msg};
368                 if ($conn->{msg} =~ /\cM?\cJ$/) {
369                         delete $conn->{msg};
370                 } else {
371                         $conn->{msg} = pop @lines;
372                 }
373                 for (@lines) {
374                         last if $conn->{disconnecting};
375                         &{$conn->{rproc}}($conn, defined $_ ? $_ : '');
376                 }
377         }
378 }
379
380 sub _rcv {                     # Complement to _send
381     my $conn = shift; # $rcv_now complement of $flush
382         my $msg = shift;
383     my $sock = $conn->{sock};
384     return unless defined($sock);
385         return if $conn->{disconnecting};
386
387         $total_in += length $msg;
388
389         my @lines;
390         if (isdbg('raw')) {
391                 my $call = $conn->{call} || 'none';
392                 my $lth = length $msg;
393                 dbgdump('raw', "$call read $lth: ", $msg);
394         }
395         if ($conn->{echo}) {
396                 my @ch = split //, $msg;
397                         my $out;
398                         for (@ch) {
399                                 if (/[\cH\x7f]/) {
400                                         $out .= "\cH \cH";
401                                         $conn->{msg} =~ s/.$//;
402                                 } else {
403                                         $out .= $_;
404                                         $conn->{msg} .= $_;
405                                 }
406                         }
407                         if (defined $out) {
408                                 $conn->send_raw($out);
409                         }
410         } else {
411                 $conn->{msg} .= $msg;
412         }
413
414         unless ($conn->{disable_read}) {
415                 $conn->dequeue if exists $conn->{msg};
416         }
417 }
418
419 sub new_client {
420         my $server_conn = shift;
421         my $handle = shift;
422         
423         my $conn = $server_conn->new($server_conn->{rproc});
424         my $sock = $conn->{sock} = Mojo::IOLoop::Stream->new($handle);
425         $sock->on(read => sub {$conn->_rcv($_[1])});
426         $sock->timeout(0);
427         $sock->start;
428         dbg((ref $conn) . "accept $conn->{cnum} from $conn->{peerhost} $conn->{peerport}") if isdbg('connll');
429
430         my ($rproc, $eproc) = &{$server_conn->{rproc}} ($conn, $conn->{peerhost} = $handle->peerhost, $conn->{peerport} = $handle->peerport);
431         $conn->{sort} = 'Incoming';
432         if ($eproc) {
433                 $conn->{eproc} = $eproc;
434         }
435         if ($rproc) {
436                 $conn->{rproc} = $rproc;
437         } else {  # Login failed
438                 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
439                 $conn->disconnect();
440         }
441         return $conn;
442 }
443
444 sub close_server
445 {
446         my $conn = shift;
447         delete $conn->{sock};
448 }
449
450 # close all clients (this is for forking really)
451 sub close_all_clients
452 {
453         foreach my $conn (values %conns) {
454                 $conn->disconnect;
455         }
456 }
457
458 sub disable_read
459 {
460         my $conn = shift;
461         return defined $_[0] ? $conn->{disable_read} = $_[0] : $_[0];
462 }
463
464
465 #
466 #----------------------------------------------------
467 # Event loop routines used by both client and server
468
469 sub set_event_handler {
470         my $sock = shift;
471         my %args = @_;
472         my ($pkg, $fn, $line) = caller;
473         my $s;
474         foreach (my ($k,$v) = each %args) {
475                 $s .= "$k => $v, ";
476         }
477         $s =~ s/[\s,]$//;
478         dbg("Msg::set_event_handler called from ${pkg}::${fn} line $line doing $s");
479 }
480
481 sub sleep
482 {
483         my ($pkg, $interval) = @_;
484         my $now = time;
485         while (time - $now < $interval) {
486                 sleep 1;
487         }
488 }
489
490 sub DESTROY
491 {
492         my $conn = shift;
493         my $call = $conn->{call} || 'unallocated';
494         my $host = $conn->{peerhost} || '';
495         my $port = $conn->{peerport} || '';
496         my $sock = $conn->{sock};
497
498         $sock->close_gracefully if defined $sock && $sock->can('close_gracefully');
499         
500         $noconns--;
501         dbg((ref $conn) . " Connection $conn->{cnum} $call [$host $port] being destroyed (total $noconns)") if isdbg('connll');
502 }
503
504 1;
505
506 __END__
507