change build number calculation to be more accurate
[spider.git] / perl / Msg.pm
index 6702f152bc6811334a8cf1f6661791f0d0a2c7b7..3f52e39dfe8057d4fb202f364be81eb36567ceb3 100644 (file)
 package Msg;
 
 use strict;
+
+use vars qw($VERSION $BRANCH);
+$VERSION = sprintf( "%d.%03d", q$Revision$ =~ /(\d+)\.(\d+)/ );
+$BRANCH = sprintf( "%d.%03d", q$Revision$ =~ /\d+\.\d+\.(\d+)\.(\d+)/ ) || 0;
+$main::build += $VERSION;
+$main::branch += $BRANCH;
+
 use IO::Select;
 use IO::Socket;
-#use DXDebug;
+use DXDebug;
+use Timer;
 
-use vars qw(%rd_callbacks %wt_callbacks $rd_handles $wt_handles $now @timerchain);
+use vars qw(%rd_callbacks %wt_callbacks %er_callbacks $rd_handles $wt_handles $er_handles $now %conns $noconns $blocking_supported $cnum);
 
 %rd_callbacks = ();
 %wt_callbacks = ();
+%er_callbacks = ();
 $rd_handles   = IO::Select->new();
 $wt_handles   = IO::Select->new();
-$now = time;
-@timerchain = ();
+$er_handles   = IO::Select->new();
 
-my $blocking_supported = 0;
+$now = time;
 
 BEGIN {
     # Checks if blocking is supported
     eval {
-        require POSIX; POSIX->import(qw (F_SETFL O_NONBLOCK EAGAIN));
+        require POSIX; POSIX->import(qw(O_NONBLOCK F_SETFL F_GETFL))
     };
-    $blocking_supported = 1 unless $@;
+       if ($@ || $main::is_win) {
+#              print STDERR "POSIX Blocking *** NOT *** supported $@\n";
+               $blocking_supported = 0;
+       } else {
+               $blocking_supported = 1;
+#              print STDERR "POSIX Blocking enabled\n";
+       }
+
+
+       # import as many of these errno values as are available
+       eval {
+               require Errno; Errno->import(qw(EAGAIN EINPROGRESS EWOULDBLOCK));
+       };
 }
 
+my $w = $^W;
+$^W = 0;
+my $eagain = eval {EAGAIN()};
+my $einprogress = eval {EINPROGRESS()};
+my $ewouldblock = eval {EWOULDBLOCK()};
+$^W = $w;
+$cnum = 0;
+
+
 #
 #-----------------------------------------------------------------
 # Generalised initializer
@@ -52,11 +81,77 @@ sub new
                lineend => "\r\n",
                csort => 'telnet',
                timeval => 60,
+               blocking => 0,
+               cnum => (($cnum < 999) ? (++$cnum) : ($cnum = 1)),
     };
 
+       $noconns++;
+       
+       dbg("Connection created ($noconns)") if isdbg('connll');
        return bless $conn, $class;
 }
 
+sub set_error
+{
+       my $conn = shift;
+       my $callback = shift;
+       $conn->{eproc} = $callback;
+       set_event_handler($conn->{sock}, error => $callback) if exists $conn->{sock};
+}
+
+sub set_rproc
+{
+       my $conn = shift;
+       my $callback = shift;
+       $conn->{rproc} = $callback;
+}
+
+sub blocking
+{
+       return unless $blocking_supported;
+       
+       my $flags = fcntl ($_[0], F_GETFL, 0);
+       if ($_[1]) {
+               $flags &= ~O_NONBLOCK;
+       } else {
+               $flags |= O_NONBLOCK;
+       }
+       fcntl ($_[0], F_SETFL, $flags);
+}
+
+# save it
+sub conns
+{
+       my $pkg = shift;
+       my $call = shift;
+       my $ref;
+       
+       if (ref $pkg) {
+               $call = $pkg->{call} unless $call;
+               return undef unless $call;
+               dbg("changing $pkg->{call} to $call") if isdbg('connll') && exists $pkg->{call} && $call ne $pkg->{call};
+               delete $conns{$pkg->{call}} if exists $pkg->{call} && exists $conns{$pkg->{call}} && $pkg->{call} ne $call; 
+               $pkg->{call} = $call;
+               $ref = $conns{$call} = $pkg;
+               dbg("Connection $pkg->{cnum} $call stored") if isdbg('connll');
+       } else {
+               $ref = $conns{$call};
+       }
+       return $ref;
+}
+
+# this is only called by any dependent processes going away unexpectedly
+sub pid_gone
+{
+       my ($pkg, $pid) = @_;
+       
+       my @pid = grep {$_->{pid} == $pid} values %conns;
+       foreach my $p (@pid) {
+               &{$p->{eproc}}($p, "$pid has gorn") if exists $p->{eproc};
+               $p->disconnect;
+       }
+}
+
 #-----------------------------------------------------------------
 # Send side routines
 sub connect {
@@ -67,34 +162,65 @@ sub connect {
        unless (ref $pkg) {
                $conn = $pkg->new($rproc);
        }
+       $conn->{peerhost} = $to_host;
+       $conn->{peerport} = $to_port;
+       $conn->{sort} = 'Outgoing';
        
     # Create a new internet socket
-    my $sock = IO::Socket::INET->new (
-                                      PeerAddr => $to_host,
-                                      PeerPort => $to_port,
-                                      Proto    => 'tcp',
-                                      Reuse    => 1,
-                                                                         Timeout  => $conn->{timeval} / 2);
-
+    my $sock = IO::Socket::INET->new();
     return undef unless $sock;
+       
+       my $proto = getprotobyname('tcp');
+       $sock->socket(AF_INET, SOCK_STREAM, $proto) or return undef;
+       
+       blocking($sock, 0);
+       $conn->{blocking} = 0;
 
+       my $ip = gethostbyname($to_host);
+#      my $r = $sock->connect($to_port, $ip);
+       my $r = connect($sock, pack_sockaddr_in($to_port, $ip));
+       return undef unless $r || _err_will_block($!);
+       
        $conn->{sock} = $sock;
     
     if ($conn->{rproc}) {
-        my $callback = sub {_rcv($conn)};
-        set_event_handler ($sock, "read" => $callback);
+        my $callback = sub {$conn->_rcv};
+        set_event_handler ($sock, read => $callback);
     }
     return $conn;
 }
 
 sub disconnect {
     my $conn = shift;
+       return if exists $conn->{disconnecting};
+
+       $conn->{disconnecting} = 1;
     my $sock = delete $conn->{sock};
        $conn->{state} = 'E';
-       delete $conn->{cmd};
-       $conn->{timeout}->del_timer if $conn->{timeout};
+       $conn->{timeout}->del if $conn->{timeout};
+
+       # be careful to delete the correct one
+       my $call;
+       if ($call = $conn->{call}) {
+               my $ref = $conns{$call};
+               delete $conns{$call} if $ref && $ref == $conn;
+       }
+       $call ||= 'unallocated';
+       dbg("Connection $conn->{cnum} $call disconnected") if isdbg('connll');
+       
+       unless ($main::is_win) {
+               kill 'TERM', $conn->{pid} if exists $conn->{pid};
+       }
+
+       # get rid of any references
+       for (keys %$conn) {
+               if (ref($conn->{$_})) {
+                       delete $conn->{$_};
+               }
+       }
+
        return unless defined($sock);
-    set_event_handler ($sock, "read" => undef, "write" => undef);
+    set_event_handler ($sock, read => undef, write => undef, error => undef);
     shutdown($sock, 3);
        close($sock);
 }
@@ -110,12 +236,12 @@ sub send_later {
     $conn->enqueue($msg);
     my $sock = $conn->{sock};
     return unless defined($sock);
-    set_event_handler ($sock, "write" => sub {$conn->_send(0)});
+    set_event_handler ($sock, write => sub {$conn->_send(0)});
 }
 
 sub enqueue {
     my $conn = shift;
-    push (@{$conn->{outqueue}}, $_[0]);
+    push (@{$conn->{outqueue}}, defined $_[0] ? $_[0] : '');
 }
 
 sub _send {
@@ -130,7 +256,10 @@ sub _send {
     # return to the event loop only after every message, or if it
     # is likely to block in the middle of a message.
 
-    $flush ? $conn->set_blocking() : $conn->set_non_blocking();
+       if ($conn->{blocking} != $flush) {
+               blocking($sock, $flush);
+               $conn->{blocking} = $flush;
+       }
     my $offset = (exists $conn->{send_offset}) ? $conn->{send_offset} : 0;
 
     while (@$rq) {
@@ -151,57 +280,59 @@ sub _send {
                     # be called back eventually, and will resume sending
                     return 1;
                 } else {    # Uh, oh
-                                       delete $conn->{send_offset};
-                    $conn->handle_send_err($!);
+                                       &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
                                        $conn->disconnect;
                     return 0; # fail. Message remains in queue ..
                 }
-            }
+            } elsif (isdbg('raw')) {
+                               my $call = $conn->{call} || 'none';
+                               dbgdump('raw', "$call send $bytes_written: ", $msg);
+                       }
             $offset         += $bytes_written;
             $bytes_to_write -= $bytes_written;
         }
         delete $conn->{send_offset};
         $offset = 0;
         shift @$rq;
-        last unless $flush; # Go back to select and wait
+        #last unless $flush; # Go back to select and wait
                             # for it to fire again.
     }
     # Call me back if queue has not been drained.
-    if (@$rq) {
-        set_event_handler ($sock, "write" => sub {$conn->_send(0)});
-    } else {
-        set_event_handler ($sock, "write" => undef);
+    unless (@$rq) {
+        set_event_handler ($sock, write => undef);
+               if (exists $conn->{close_on_empty}) {
+                       &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
+                       $conn->disconnect; 
+               }
     }
     1;  # Success
 }
 
-sub _err_will_block {
-    if ($blocking_supported) {
-        return ($_[0] == EAGAIN());
-    }
-    return 0;
-}
-sub set_non_blocking {                        # $conn->set_blocking
-    if ($blocking_supported) {
-        # preserve other fcntl flags
-        my $flags = fcntl ($_[0], F_GETFL(), 0);
-        fcntl ($_[0], F_SETFL(), $flags | O_NONBLOCK());
-    }
+sub dup_sock
+{
+       my $conn = shift;
+       my $oldsock = $conn->{sock};
+       my $rc = $rd_callbacks{$oldsock};
+       my $wc = $wt_callbacks{$oldsock};
+       my $ec = $er_callbacks{$oldsock};
+       my $sock = $oldsock->new_from_fd($oldsock, "w+");
+       if ($sock) {
+               set_event_handler($oldsock, read=>undef, write=>undef, error=>undef);
+               $conn->{sock} = $sock;
+               set_event_handler($sock, read=>$rc, write=>$wc, error=>$ec);
+               $oldsock->close;
+       }
 }
-sub set_blocking {
-    if ($blocking_supported) {
-        my $flags = fcntl ($_[0], F_GETFL(), 0);
-        $flags  &= ~O_NONBLOCK(); # Clear blocking, but preserve other flags
-        fcntl ($_[0], F_SETFL(), $flags);
-    }
+
+sub _err_will_block {
+       return 0 unless $blocking_supported;
+       return ($_[0] == $eagain || $_[0] == $ewouldblock || $_[0] == $einprogress);
 }
 
-sub handle_send_err {
-   # For more meaningful handling of send errors, subclass Msg and
-   # rebless $conn.  
-   my ($conn, $err_msg) = @_;
-   warn "Error while sending: $err_msg \n";
-   set_event_handler ($conn->{sock}, "write" => undef);
+sub close_on_empty
+{
+       my $conn = shift;
+       $conn->{close_on_empty} = 1;
 }
 
 #-----------------------------------------------------------------
@@ -215,22 +346,28 @@ sub new_server {
     $self->{sock} = IO::Socket::INET->new (
                                           LocalAddr => $my_host,
                                           LocalPort => $my_port,
-                                          Listen    => 5,
+                                          Listen    => SOMAXCONN,
                                           Proto     => 'tcp',
                                           Reuse     => 1);
     die "Could not create socket: $! \n" unless $self->{sock};
-    set_event_handler ($self->{sock}, "read" => sub { $self->new_client }  );
+    set_event_handler ($self->{sock}, read => sub { $self->new_client }  );
        return $self;
 }
 
 sub dequeue
 {
        my $conn = shift;
-       my $msg;
-       
-       while ($msg = shift @{$conn->{inqueue}}){
-               &{$conn->{rproc}}($conn, $msg, $!);
-               $! = 0;
+
+       if ($conn->{msg} =~ /\n/) {
+               my @lines = split /\r?\n/, $conn->{msg};
+               if ($conn->{msg} =~ /\n$/) {
+                       delete $conn->{msg};
+               } else {
+                       $conn->{msg} = pop @lines;
+               }
+               for (@lines) {
+                       &{$conn->{rproc}}($conn, defined $_ ? $_ : '');
+               }
        }
 }
 
@@ -242,26 +379,17 @@ sub _rcv {                     # Complement to _send
     return unless defined($sock);
 
        my @lines;
-    $conn->set_non_blocking();
+       if ($conn->{blocking}) {
+               blocking($sock, 0);
+               $conn->{blocking} = 0;
+       }
        $bytes_read = sysread ($sock, $msg, 1024, 0);
        if (defined ($bytes_read)) {
                if ($bytes_read > 0) {
-                       if ($msg =~ /\n/) {
-                               @lines = split /\r?\n/, $msg;
-                               if (@lines) {
-                                       $lines[0] = $conn->{msg} . $lines[0] if exists $conn->{msg};
-                               } else {
-                                       $lines[0] = $conn->{msg} if exists $conn->{msg};
-                                       push @lines, '' unless @lines;
-                               }
-                               if ($msg =~ /\n$/) {
-                                       delete $conn->{msg};
-                               } else {
-                                       $conn->{msg} = pop @lines;
-                               }
-                               push @{$conn->{inqueue}}, @lines if @lines;
-                       } else {
-                               $conn->{msg} .= $msg;
+                       $conn->{msg} .= $msg;
+                       if (isdbg('raw')) {
+                               my $call = $conn->{call} || 'none';
+                               dbgdump('raw', "$call read $bytes_read: ", $msg);
                        }
                } 
        } else {
@@ -274,36 +402,65 @@ sub _rcv {                     # Complement to _send
 
 FINISH:
     if (defined $bytes_read && $bytes_read == 0) {
-#              $conn->disconnect();
-               &{$conn->{rproc}}($conn, undef, $!);
-               delete $conn->{inqueue};
+               &{$conn->{eproc}}($conn, $!) if exists $conn->{eproc};
+               $conn->disconnect;
     } else {
-               $conn->dequeue;
+               unless ($conn->{disable_read}) {
+                       $conn->dequeue if exists $conn->{msg};
+               }
        }
 }
 
 sub new_client {
        my $server_conn = shift;
     my $sock = $server_conn->{sock}->accept();
-    my $conn = $server_conn->new($server_conn->{rproc});
-       $conn->{sock} = $sock;
-    my $rproc = &{$server_conn->{rproc}} ($conn, $sock->peerhost(), $sock->peerport());
-    if ($rproc) {
-        $conn->{rproc} = $rproc;
-        my $callback = sub {_rcv($conn)};
-        set_event_handler ($sock, "read" => $callback);
-    } else {  # Login failed
-        $conn->disconnect();
-    }
+       if ($sock) {
+               my $conn = $server_conn->new($server_conn->{rproc});
+               $conn->{sock} = $sock;
+               blocking($sock, 0);
+               $conn->{blocking} = 0;
+               my ($rproc, $eproc) = &{$server_conn->{rproc}} ($conn, $conn->{peerhost} = $sock->peerhost(), $conn->{peerport} = $sock->peerport());
+               $conn->{sort} = 'Incoming';
+               if ($eproc) {
+                       $conn->{eproc} = $eproc;
+                       set_event_handler ($sock, error => $eproc);
+               }
+               if ($rproc) {
+                       $conn->{rproc} = $rproc;
+                       my $callback = sub {$conn->_rcv};
+                       set_event_handler ($sock, read => $callback);
+               } else {  # Login failed
+                       &{$conn->{eproc}}($conn, undef) if exists $conn->{eproc};
+                       $conn->disconnect();
+               }
+       } else {
+               dbg("Msg: error on accept ($!)") if isdbg('err');
+       }
 }
 
 sub close_server
 {
        my $conn = shift;
-       set_event_handler ($conn->{sock}, "read" => undef);
+       set_event_handler ($conn->{sock}, read => undef, write => undef, error => undef );
        $conn->{sock}->close;
 }
 
+# close all clients (this is for forking really)
+sub close_all_clients
+{
+       foreach my $conn (values %conns) {
+               $conn->disconnect;
+       }
+}
+
+sub disable_read
+{
+       my $conn = shift;
+       set_event_handler ($conn->{sock}, read => undef);
+       return $_[0] ? $conn->{disable_read} = $_[0] : $_[0];
+}
+
+#
 #----------------------------------------------------
 # Event loop routines used by both client and server
 
@@ -331,54 +488,39 @@ sub set_event_handler {
             $rd_handles->remove($handle);
        }
     }
-}
-
-sub new_timer
-{
-    my ($pkg, $time, $proc, $recur) = @_;
-       my $obj = ref($pkg);
-       my $class = $obj || $pkg;
-       my $self = bless { t=>$time + time, proc=>$proc }, $class;
-       $self->{interval} = $time if $recur;
-       push @timerchain, $self;
-       return $self;
-}
-
-sub del_timer
-{
-       my $self = shift;
-       @timerchain = grep {$_ != $self} @timerchain;
+    if (exists $args{'error'}) {
+        $callback = $args{'error'};
+        if ($callback) {
+            $er_callbacks{$handle} = $callback;
+            $er_handles->add($handle);
+        } else {
+            delete $er_callbacks{$handle};
+            $er_handles->remove($handle);
+       }
+    }
 }
 
 sub event_loop {
     my ($pkg, $loop_count, $timeout) = @_; # event_loop(1) to process events once
-    my ($conn, $r, $w, $rset, $wset);
+    my ($conn, $r, $w, $e, $rset, $wset, $eset);
     while (1) {
  
        # Quit the loop if no handles left to process
         last unless ($rd_handles->count() || $wt_handles->count());
         
-               ($rset, $wset) =
-            IO::Select->select ($rd_handles, $wt_handles, undef, $timeout);
-               $now = time;
+               ($rset, $wset, $eset) = IO::Select->select($rd_handles, $wt_handles, $er_handles, $timeout);
                
+        foreach $e (@$eset) {
+            &{$er_callbacks{$e}}($e) if exists $er_callbacks{$e};
+        }
         foreach $r (@$rset) {
-            &{$rd_callbacks{$r}} ($r) if exists $rd_callbacks{$r};
+            &{$rd_callbacks{$r}}($r) if exists $rd_callbacks{$r};
         }
         foreach $w (@$wset) {
             &{$wt_callbacks{$w}}($w) if exists $wt_callbacks{$w};
         }
 
-               # handle things on the timer chain
-               for (@timerchain) {
-                       if ($now >= $_->{t}) {
-                               &{$_->{proc}}();
-                               $_->{t} = $now + $_->{interval} if exists $_->{interval};
-                       }
-               }
-
-               # remove dead timers
-               @timerchain = grep { $_->{t} > $now } @timerchain;
+               Timer::handler;
                
         if (defined($loop_count)) {
             last unless --$loop_count;
@@ -386,6 +528,25 @@ sub event_loop {
     }
 }
 
+sub sleep
+{
+       my ($pkg, $interval) = @_;
+       my $now = time;
+       while (time - $now < $interval) {
+               $pkg->event_loop(10, 0.01);
+       }
+}
+
+sub DESTROY
+{
+       my $conn = shift;
+       my $call = $conn->{call} || 'unallocated';
+       my $host = $conn->{peerhost} || '';
+       my $port = $conn->{peerport} || '';
+       dbg("Connection $conn->{cnum} $call [$host $port] being destroyed") if isdbg('connll');
+       $noconns--;
+}
+
 1;
 
 __END__