Notes on STREAM STATUS messages when SILENT=true

Fix one message for STREAM CONNECT that wasn't honoring SILENT setting
PING failure sends a SESSION STATUS message
Implement ping/pong in client
Delay at end of client send so data gets through in v3 mode
log tweaks
Exception catch tweaks

apps/sam/java/src/net/i2p/sam/SAMHandler.java

@@ -158,6 +158,8 @@ abstract class SAMHandler implements Runnable, Handler {
      * unregister with the bridge.
      */
     public void stopHandling() {
+        if (_log.shouldInfo())
+            _log.info("Stopping: " + this, new Exception("I did it"));
         synchronized (stopLock) {
             stopHandler = true;
         }

apps/sam/java/src/net/i2p/sam/SAMHandlerFactory.java

@@ -56,7 +56,7 @@ class SAMHandlerFactory {
             throw new SAMException("Timeout waiting for HELLO VERSION", e);
         } catch (IOException e) {
             throw new SAMException("Error reading from socket", e);
-        } catch (Exception e) {
+        } catch (RuntimeException e) {
             throw new SAMException("Unexpected error", e);
         }
 

apps/sam/java/src/net/i2p/sam/SAMv1Handler.java

@@ -187,7 +187,9 @@ class SAMv1Handler extends SAMHandler implements SAMRawReceiver, SAMDatagramRece
         } catch (IOException e) {
             if (_log.shouldLog(Log.DEBUG))
                 _log.debug("Caught IOException for message [" + msg + "]", e);
-        } catch (Exception e) {
+        } catch (SAMException e) {
+            _log.error("Unexpected exception for message [" + msg + "]", e);
+        } catch (RuntimeException e) {
             _log.error("Unexpected exception for message [" + msg + "]", e);
         } finally {
             if (_log.shouldLog(Log.DEBUG))

apps/sam/java/src/net/i2p/sam/SAMv3Handler.java

@@ -294,7 +294,7 @@ class SAMv3Handler extends SAMv1Handler
 								if (now - _lastPing >= READ_TIMEOUT) {
 									if (_log.shouldWarn())
 										_log.warn("Failed to respond to PING");
-									writeString("PING STATUS RESULT=I2P_ERROR MESSAGE=\"PONG timeout\"\n");
+									writeString("SESSION STATUS RESULT=I2P_ERROR MESSAGE=\"PONG timeout\"\n");
 									break;
 								}
 							} else {
@@ -309,7 +309,7 @@ class SAMv3Handler extends SAMv1Handler
 								if (now - _lastPing >= 2*READ_TIMEOUT) {
 									if (_log.shouldWarn())
 										_log.warn("Failed to respond to PING");
-									writeString("PING STATUS RESULT=I2P_ERROR MESSAGE=\"PONG timeout\"\n");
+									writeString("SESSION STATUS RESULT=I2P_ERROR MESSAGE=\"PONG timeout\"\n");
 									break;
 								}
 							} else if (_lastPing < 0) {
@@ -420,9 +420,11 @@ class SAMv3Handler extends SAMv1Handler
 			} // while
 		} catch (IOException e) {
 			if (_log.shouldLog(Log.DEBUG))
-				_log.debug("Caught IOException for message [" + msg + "]", e);
+				_log.debug("Caught IOException in handler", e);
-		} catch (Exception e) {
+		} catch (SAMException e) {
-			_log.error("Unexpected exception for message [" + msg + "]", e);
+			_log.error("Unexpected exception for message [" + msg + ']', e);
+		} catch (RuntimeException e) {
+			_log.error("Unexpected exception for message [" + msg + ']', e);
 		} finally {
 			if (_log.shouldLog(Log.DEBUG))
 				_log.debug("Stopping handler");
@@ -464,6 +466,8 @@ class SAMv3Handler extends SAMv1Handler
 	 */
 	@Override
 	public void stopHandling() {
+            if (_log.shouldInfo())
+                _log.info("Stopping (stolen? " + stolenSocket + "): " + this, new Exception("I did it"));
 	    synchronized (stopLock) {
 	        stopHandler = true;
 	    }
@@ -728,14 +732,16 @@ class SAMv3Handler extends SAMv1Handler
 
 	@Override
 	protected boolean execStreamConnect( Properties props) {
+		// Messages are NOT sent if SILENT=true,
+		// The specs said that they were.
+	    	boolean verbose = !Boolean.parseBoolean(props.getProperty("SILENT"));
 		try {
 			if (props.isEmpty()) {
-				notifyStreamResult(true,"I2P_ERROR","No parameters specified in STREAM CONNECT message");
+				notifyStreamResult(verbose, "I2P_ERROR","No parameters specified in STREAM CONNECT message");
 				if (_log.shouldLog(Log.DEBUG))
 					_log.debug("No parameters specified in STREAM CONNECT message");
 				return false;
 			}
-		    	boolean verbose = !Boolean.parseBoolean(props.getProperty("SILENT"));
 		
 			String dest = props.getProperty("DESTINATION");
 			if (dest == null) {
@@ -776,6 +782,9 @@ class SAMv3Handler extends SAMv1Handler
 	}
 
 	private boolean execStreamForwardIncoming( Properties props ) {
+		// Messages ARE sent if SILENT=true,
+		// which is different from CONNECT and ACCEPT.
+		// But this matched the specs.
 		try {
 			try {
 				streamForwardingSocket = true ;
@@ -794,6 +803,8 @@ class SAMv3Handler extends SAMv1Handler
 
 	private boolean execStreamAccept( Properties props )
 	{
+		// Messages are NOT sent if SILENT=true,
+		// The specs said that they were.
 	    	boolean verbose = !Boolean.parseBoolean(props.getProperty("SILENT"));
 		try {
 			try {

apps/sam/java/src/net/i2p/sam/client/SAMClientEventListenerImpl.java

@@ -14,5 +14,7 @@ public class SAMClientEventListenerImpl implements SAMReader.SAMClientEventListe
     public void streamConnectedReceived(String remoteDestination, String id) {}
     public void streamDataReceived(String id, byte[] data, int offset, int length) {}
     public void streamStatusReceived(String result, String id, String message) {}
+    public void pingReceived(String data) {}
+    public void pongReceived(String data) {}
     public void unknownMessageReceived(String major, String minor, Properties params) {}
 }

apps/sam/java/src/net/i2p/sam/client/SAMReader.java

@@ -80,6 +80,8 @@ public class SAMReader {
         public void streamDataReceived(String id, byte data[], int offset, int length);
         public void namingReplyReceived(String name, String result, String value, String message);
         public void destReplyReceived(String publicKey, String privateKey);
+        public void pingReceived(String data);
+        public void pongReceived(String data);
         
         public void unknownMessageReceived(String major, String minor, Properties params);
     }
@@ -118,13 +120,13 @@ public class SAMReader {
                 
                 StringTokenizer tok = new StringTokenizer(line);
                 
-                if (tok.countTokens() < 2) {
+                if (tok.countTokens() <= 0) {
                     _log.error("Invalid SAM line: [" + line + "]");
                     break;
                 }
                 
                 String major = tok.nextToken();
-                String minor = tok.nextToken();
+                String minor = tok.hasMoreTokens() ? tok.nextToken() : "";
                 
                 params.clear();
                 while (tok.hasMoreTokens()) {
@@ -247,6 +249,12 @@ public class SAMReader {
             } else {
                 _listener.unknownMessageReceived(major, minor, params);
             }
+        } else if ("PING".equals(major)) {
+            // this omits anything after a space
+            _listener.pingReceived(minor);
+        } else if ("PONG".equals(major)) {
+            // this omits anything after a space
+            _listener.pongReceived(minor);
         } else {
             _listener.unknownMessageReceived(major, minor, params);
         }

apps/sam/java/src/net/i2p/sam/client/SAMStreamSend.java

@@ -174,7 +174,7 @@ public class SAMStreamSend {
                     _log.info("We are " + destination);
                 }
                 return destination;
-            } catch (Exception e) {
+            } catch (IOException e) {
                 _log.error("Error handshaking", e);
                 return null;
             }
@@ -327,6 +327,12 @@ public class SAMStreamSend {
                 _reader2.stopReading();
             // stop the reader, since we're only doing this once for testing
             // you wouldn't do this in a real application
+            if (_isV3) {
+                // closing the master socket too fast will kill the data socket flushing through
+                try {
+                    Thread.sleep(10000);
+                } catch (InterruptedException ie) {}
+            }
             _reader.stopReading();
         }
     }

apps/sam/java/src/net/i2p/sam/client/SAMStreamSink.java

@@ -66,12 +66,12 @@ public class SAMStreamSink {
             _log.debug("Starting up");
         try {
             Socket sock = connect();
-            SAMEventHandler eventHandler = new SinkEventHandler(_context);
+            OutputStream out = sock.getOutputStream();
+            SAMEventHandler eventHandler = new SinkEventHandler(_context, out);
             _reader = new SAMReader(_context, sock.getInputStream(), eventHandler);
             _reader.startReading();
             if (_log.shouldLog(Log.DEBUG))
                 _log.debug("Reader created");
-            OutputStream out = sock.getOutputStream();
             String ourDest = handshake(out, version, true, eventHandler);
             if (ourDest == null)
                 throw new IOException("handshake failed");
@@ -79,12 +79,12 @@ public class SAMStreamSink {
                 _log.debug("Handshake complete.  we are " + ourDest);
             if (_isV3) {
                 Socket sock2 = connect();
-                eventHandler = new SinkEventHandler2(_context, sock2.getInputStream());
+                out = sock2.getOutputStream();
+                eventHandler = new SinkEventHandler2(_context, sock2.getInputStream(), out);
                 _reader2 = new SAMReader(_context, sock2.getInputStream(), eventHandler);
                 _reader2.startReading();
                 if (_log.shouldLog(Log.DEBUG))
                     _log.debug("Reader2 created");
-                out = sock2.getOutputStream();
                 String ok = handshake(out, version, false, eventHandler);
                 if (ok == null)
                     throw new IOException("2nd handshake failed");
@@ -99,7 +99,12 @@ public class SAMStreamSink {
     
     private class SinkEventHandler extends SAMEventHandler {
 
-        public SinkEventHandler(I2PAppContext ctx) { super(ctx); }
+        protected final OutputStream _out;
+
+        public SinkEventHandler(I2PAppContext ctx, OutputStream out) {
+            super(ctx);
+            _out = out;
+        }
 
         @Override
         public void streamClosedReceived(String result, String id, String message) {
@@ -143,14 +148,28 @@ public class SAMStreamSink {
                 _log.error("Error creating a new sink", ioe);
             }
         }
+
+        @Override
+        public void pingReceived(String data) {
+            if (_log.shouldInfo())
+                _log.info("Got PING " + data + ", sending PONG " + data);
+            synchronized (_out) {
+                try {
+                    _out.write(("PONG " + data + '\n').getBytes());
+                    _out.flush();
+                } catch (IOException ioe) {
+                    _log.error("PONG fail", ioe);
+                }
+            }
+        }
     }
 
     private class SinkEventHandler2 extends SinkEventHandler {
 
         private final InputStream _in;
 
-        public SinkEventHandler2(I2PAppContext ctx, InputStream in) {
+        public SinkEventHandler2(I2PAppContext ctx, InputStream in, OutputStream out) {
-            super(ctx);
+            super(ctx, out);
             _in = in;
         }
 
@@ -159,10 +178,9 @@ public class SAMStreamSink {
             if (_log.shouldLog(Log.DEBUG))
                 _log.debug("got STREAM STATUS, result=" + result);
             super.streamStatusReceived(result, id, message);
-            // with SILENT=true, there's nothing else coming, so fire up the Sink
             Sink sink = null;
             try {
-                String dest = "TODO if not silent";
+                String dest = "TODO_if_not_silent";
                 sink = new Sink(_v3ID, dest);
                 synchronized (_remotePeers) {
                     _remotePeers.put(_v3ID, sink);
@@ -315,7 +333,7 @@ public class SAMStreamSink {
                         _log.info(_destFile + " is located at " + destination);
                 }
                 return destination;
-            } catch (Exception e) {
+            } catch (IOException e) {
                 _log.error("Error handshaking", e);
                 return null;
             }
@@ -337,7 +355,7 @@ public class SAMStreamSink {
             fos.write(dest.getBytes());
             if (_log.shouldLog(Log.DEBUG))
                 _log.debug("My destination written to " + _destFile);
-        } catch (Exception e) {
+        } catch (IOException e) {
             _log.error("Error writing to " + _destFile, e);
             return false;
         } finally {