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