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         $conn->{peerhost} ||= 'ax25' if $conn->ax25;
 124         $conn->{peerhost} ||= $conn->{sock}->handle->peerhost if $conn->{sock};
 125         $conn->{peerhost} ||= 'UNKNOWN';
 126         return $conn->{peerhost};
 127 }
 128
 129 #-----------------------------------------------------------------
 130 # Send side routines
 131
 132 sub _on_connect
 133 {
 134         my $conn = shift;
 135         my $handle = shift;
 136         undef $conn->{sock};
 137         my $sock = $conn->{sock} = Mojo::IOLoop::Stream->new($handle);
 138         $sock->on(read => sub {$conn->_rcv($_[1]);} );
 139         $sock->on(error => sub {delete $conn->{sock}; $conn->disconnect;});
 140         $sock->on(close => sub {delete $conn->{sock}; $conn->disconnect;});
 141         $sock->timeout(0);
 142         $sock->start;
 143         $conn->{peerhost} = eval { $handle->peerhost; };
 144         dbg((ref $conn) . " connected $conn->{cnum} to $conn->{peerhost}:$conn->{peerport}") if isdbg('connll');
 145         if ($conn->{on_connect}) {
 146                 &{$conn->{on_connect}}($conn, $handle);
 147         }
 148 }
 149
 150 sub is_connected
 151 {
 152         my $conn = shift;
 153         my $sock = $conn->{sock};
 154         return ref $sock && $sock->isa('Mojo::IOLoop::Stream');
 155 }
 156
 157 sub connect {
 158     my ($pkg, $to_host, $to_port, %args) = @_;
 159         my $timeout = delete $args{timeout} || $connect_timeout;
 160
 161     # Create a connection end-point object
 162     my $conn = $pkg;
 163         unless (ref $pkg) {
 164                 my $rproc = delete $args{rproc};
 165                 $conn = $pkg->new($rproc);
 166         }
 167         $conn->{peerhost} = $to_host;
 168         $conn->{peerport} = $to_port;
 169         $conn->{sort} = 'Outgoing';
 170
 171         dbg((ref $conn) . " connecting $conn->{cnum} to $to_host:$to_port") if isdbg('connll');
 172
 173         my $sock;
 174         $conn->{sock} = $sock = Mojo::IOLoop::Client->new;
 175         $sock->on(connect => sub {$conn->_on_connect($_[1])} );
 176         $sock->on(error => sub {&{$conn->{eproc}}($conn, $_[1]) if exists $conn->{eproc}; $conn->disconnect});
 177         $sock->on(close => sub {$conn->disconnect});
 178
 179         # copy any args like on_connect, on_disconnect etc
 180         while (my ($k, $v) = each %args) {
 181                 $conn->{$k} = $v;
 182         }
 183
 184         $sock->connect(address => $to_host, port => $to_port, timeout => $timeout);
 185
 186     return $conn;
 187 }
 188
 189 sub start_program
 190 {
 191         my ($conn, $line, $sort) = @_;
 192         my $pid;
 193
 194 #       local $^F = 10000;              # make sure it ain't closed on exec
 195 #       my ($a, $b) = $io_socket->socketpair(AF_UNIX, SOCK_STREAM, PF_UNSPEC);
 196 #       if ($a && $b) {
 197 #               $a->autoflush(1);
 198 #               $b->autoflush(1);
 199 #               $pid = fork;
 200 #               if (defined $pid) {
 201 #                       if ($pid) {
 202 #                               close $b;
 203 #                               $conn->{sock} = $a;
 204 #                               $conn->{csort} = $sort;
 205 #                               $conn->{lineend} = "\cM" if $sort eq 'ax25';
 206 #                               $conn->{pid} = $pid;
 207 #                               if ($conn->{rproc}) {
 208 #                                       my $callback = sub {$conn->_rcv};
 209 #                                       Msg::set_event_handler ($a, read => $callback);
 210 #                               }
 211 #                               dbg("connect $conn->{cnum}: started pid: $conn->{pid} as $line") if isdbg('connect');
 212 #                       } else {
 213 #                               $^W = 0;
 214 #                               dbgclose();
 215 #                               STDIN->close;
 216 #                               STDOUT->close;
 217 #                               STDOUT->close;
 218 #                               *STDIN = IO::File->new_from_fd($b, 'r') or die;
 219 #                               *STDOUT = IO::File->new_from_fd($b, 'w') or die;
 220 #                               *STDERR = IO::File->new_from_fd($b, 'w') or die;
 221 #                               close $a;
 222 #                               unless ($main::is_win) {
 223 #                                       #                                               $SIG{HUP} = 'IGNORE';
 224 #                                       $SIG{HUP} = $SIG{CHLD} = $SIG{TERM} = $SIG{INT} = 'DEFAULT';
 225 #                                       alarm(0);
 226 #                               }
 227 #                               exec "$line" or dbg("exec '$line' failed $!");
 228 #                       }
 229 #               } else {
 230 #                       dbg("cannot fork for $line");
 231 #               }
 232 #       } else {
 233 #               dbg("no socket pair $! for $line");
 234 #       }
 235         return $pid;
 236 }
 237
 238 sub disconnect
 239 {
 240     my $conn = shift;
 241         return if exists $conn->{disconnecting};
 242
 243         $conn->{disconnecting} = 1;
 244     my $sock = delete $conn->{sock};
 245         $conn->{state} = 'E';
 246         $conn->{timeout}->del if $conn->{timeout};
 247
 248         # be careful to delete the correct one
 249         my $call;
 250         if ($call = $conn->{call}) {
 251                 my $ref = $conns{$call};
 252                 delete $conns{$call} if $ref && $ref == $conn;
 253         }
 254         $call ||= 'unallocated';
 255         dbg((ref $conn) . " Connection $conn->{cnum} $call disconnected") if isdbg('connll');
 256
 257         if ($conn->{on_disconnect}) {
 258                 &{$conn->{on_disconnect}}($conn);
 259         }
 260
 261         # get rid of any references
 262         for (keys %$conn) {
 263                 if (ref($conn->{$_})) {
 264                         delete $conn->{$_};
 265                 }
 266         }
 267
 268         $sock->close_gracefully if defined $sock && $sock->can('close_gracefully');
 269         undef $sock;
 270
 271         unless ($main::is_win) {
 272                 kill 'TERM', $conn->{pid} if exists $conn->{pid};
 273         }
 274 }
 275
 276 sub _send_stuff
 277 {
 278         my $conn = shift;
 279         my $rq = $conn->{outqueue};
 280     my $sock = $conn->{sock};
 281         return unless defined $sock;
 282         return if $conn->{disconnecting};
 283
 284         while (@$rq) {
 285                 my $data = shift @$rq;
 286                 my $lth = length $data;
 287                 my $call = $conn->{call} || 'none';
 288                 if (isdbg('raw')) {
 289                         if (isdbg('raw')) {
 290                                 dbgdump('raw', "$call send $lth: ", $lth);
 291                         }
 292                 }
 293                 if (defined $sock) {
 294                         $sock->write($data);
 295                         $total_out += $lth;
 296                 } else {
 297                         dbg("_send_stuff $call ending data ignored: $data");
 298                 }
 299         }
 300 }
 301
 302 sub send_now {
 303     my ($conn, $msg) = @_;
 304     $conn->enqueue($msg);
 305     _send_stuff($conn);
 306 }
 307
 308 sub send_later {
 309         goto &send_now;
 310 }
 311
 312 sub send_raw
 313 {
 314     my ($conn, $msg) = @_;
 315         push @{$conn->{outqueue}}, $msg;
 316         _send_stuff($conn);
 317 }
 318
 319 sub enqueue {
 320     my $conn = shift;
 321     push @{$conn->{outqueue}}, defined $_[0] ? $_[0] : '';
 322 }
 323
 324 sub _err_will_block
 325 {
 326         return 0;
 327 }
 328
 329 sub close_on_empty
 330 {
 331         my $conn = shift;
 332         $conn->{sock}->on(drain => sub {$conn->disconnect;});
 333 }
 334
 335 #-----------------------------------------------------------------
 336 # Receive side routines
 337
 338 sub new_server
 339 {
 340 #    @_ == 4 || die "Msg->new_server (myhost, myport, login_proc)\n";
 341         my ($pkg, $my_host, $my_port, $login_proc) = @_;
 342         my $conn = $pkg->new($login_proc);
 343
 344     my $sock = $conn->{sock} = Mojo::IOLoop::Server->new;
 345         $sock->on(accept=>sub{$conn->new_client($_[1]);});
 346         $sock->listen(address=>$my_host, port=>$my_port);
 347         $sock->start;
 348
 349     die "Could not create socket: $! \n" unless $conn->{sock};
 350         return $conn;
 351 }
 352
 353
 354 sub nolinger
 355 {
 356         my $conn = shift;
 357 }
 358
 359 sub dequeue
 360 {
 361         my $conn = shift;
 362         return if $conn->{disconnecting};
 363
 364         if ($conn->{msg} =~ /\cJ/) {
 365                 my @lines = split /\cM?\cJ/, $conn->{msg};
 366                 if ($conn->{msg} =~ /\cM?\cJ$/) {
 367                         delete $conn->{msg};
 368                 } else {
 369                         $conn->{msg} = pop @lines;
 370                 }
 371                 for (@lines) {
 372                         last if $conn->{disconnecting};
 373                         &{$conn->{rproc}}($conn, defined $_ ? $_ : '');
 374                 }
 375         }
 376 }
 377
 378 sub _rcv {                     # Complement to _send
 379     my $conn = shift; # $rcv_now complement of $flush
 380         my $msg = shift;
 381     my $sock = $conn->{sock};
 382     return unless defined($sock);
 383         return if $conn->{disconnecting};
 384
 385         $total_in += length $msg;
 386
 387         my @lines;
 388         if (isdbg('raw')) {
 389                 my $call = $conn->{call} || 'none';
 390                 my $lth = length $msg;
 391                 dbgdump('raw', "$call read $lth: ", $msg);
 392         }
 393         if ($conn->{echo}) {
 394                 my @ch = split //, $msg;
 395                         my $out;
 396                         for (@ch) {
 397                                 if (/[\cH\x7f]/) {
 398                                         $out .= "\cH \cH";
 399                                         $conn->{msg} =~ s/.$//;
 400                                 } else {
 401                                         $out .= $_;
 402                                         $conn->{msg} .= $_;
 403                                 }
 404                         }
 405                         if (defined $out) {
 406                                 $conn->send_raw($out);
 407                         }
 408         } else {
 409                 $conn->{msg} .= $msg;
 410         }
 411
 412         unless ($conn->{disable_read}) {
 413                 $conn->dequeue if exists $conn->{msg};
 414         }
 415 }
 416
 417 sub new_client {
 418         my $server_conn = shift;
 419         my $handle = shift;
 420
 421         my $conn = $server_conn->new($server_conn->{rproc});
 422         my $sock = $conn->{sock} = Mojo::IOLoop::Stream->new($handle);
 423         $sock->on(read => sub {$conn->_rcv($_[1])});
 424         $sock->timeout(0);
 425         $sock->start;
 426         dbg((ref $conn) . "accept $conn->{cnum} from $conn->{peerhost} $conn->{peerport}") if isdbg('connll');
 427
 428         my ($rproc, $eproc) = &{$server_conn->{rproc}} ($conn, $conn->{peerhost} = $handle->peerhost, $conn->{peerport} = $handle->peerport);
 429         $conn->{sort} = 'Incoming';
 430         if ($eproc) {
 431                 $conn->{eproc} = $eproc;
 432         }
 433         if ($rproc) {
 434                 $conn->{rproc} = $rproc;
 435         } else {  # Login failed
 436                 &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
 437                 $conn->disconnect();
 438         }
 439         return $conn;
 440 }
 441
 442 sub close_server
 443 {
 444         my $conn = shift;
 445         delete $conn->{sock};
 446 }
 447
 448 # close all clients (this is for forking really)
 449 sub close_all_clients
 450 {
 451         foreach my $conn (values %conns) {
 452                 $conn->disconnect;
 453         }
 454 }
 455
 456 sub disable_read
 457 {
 458         my $conn = shift;
 459         return defined $_[0] ? $conn->{disable_read} = $_[0] : $_[0];
 460 }
 461
 462
 463 #
 464 #----------------------------------------------------
 465 # Event loop routines used by both client and server
 466
 467 sub set_event_handler {
 468         my $sock = shift;
 469         my %args = @_;
 470         my ($pkg, $fn, $line) = caller;
 471         my $s;
 472         foreach (my ($k,$v) = each %args) {
 473                 $s .= "$k => $v, ";
 474         }
 475         $s =~ s/[\s,]$//;
 476         dbg("Msg::set_event_handler called from ${pkg}::${fn} line $line doing $s");
 477 }
 478
 479 sub sleep
 480 {
 481         my ($pkg, $interval) = @_;
 482         my $now = time;
 483         while (time - $now < $interval) {
 484                 sleep 1;
 485         }
 486 }
 487
 488 sub DESTROY
 489 {
 490         my $conn = shift;
 491         my $call = $conn->{call} || 'unallocated';
 492         my $host = $conn->{peerhost} || '';
 493         my $port = $conn->{peerport} || '';
 494         my $sock = $conn->{sock};
 495
 496         $sock->close_gracefully if defined $sock && $sock->can('close_gracefully');
 497
 498         $noconns--;
 499         dbg((ref $conn) . " Connection $conn->{cnum} $call [$host $port] being destroyed (total $noconns)") if isdbg('connll');
 500 }
 501
 502 1;
 503
 504 __END__
 505