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