em-ssh 0.4.1 → 0.4.2

data/lib/em-ssh.rb

@@ -26,6 +26,8 @@ module EventMachine
     class ConnectionFailed < SshError; end
     class ConnectionTimeout < ConnectionFailed; end
     class ConnectionTerminated < SshError; end
+    # The server failed to negotiate an ssh protocol version
+    class NegotiationTimeout < ConnectionFailed; end
 
 
     class << self

data/lib/em-ssh/callbacks.rb

@@ -90,6 +90,7 @@ module EventMachine
         def cancel
           raise "#{@obj} does not have any callbacks for #{@event.inspect}" unless @obj.respond_to?(:callbacks) && @obj.callbacks.respond_to?(:[]) && @obj.callbacks[@event].respond_to?(:delete)
           @obj.callbacks[@event].delete(self)
+          @obj = nil
           self
         end # cancel
       end # class::Callback

data/lib/em-ssh/connection.rb

@@ -100,11 +100,35 @@ module EventMachine
         @data         = @socket.input
       end # post_init
 
-      # @return
       def unbind
         debug("#{self} is unbound")
         fire(:closed)
         @closed = true
+        @socket && @socket.close
+        @socket = nil
+        @data   = nil
+        @error_callback = nil
+
+        failed_timeout = [@contimeout, @negotimeout, @algotimeout].find { |t| t }
+        instance_variables.each do |iv|
+          if (t = instance_variable_get(iv)) && (t.is_a?(EM::Timer) || t.is_a?(EM::PeriodicTimer))
+            t.cancel
+            instance_variable_set(iv, nil)
+          end
+        end
+
+        if @algorithms
+          @algorithms.instance_variable_set(:@session, nil)
+          @algorithms = nil
+        end
+
+        callbacks.values.flatten.each(&:cancel)
+        callbacks.clear
+        instance_variables.select{|iv| (t = instance_variable_get(iv)) && t.is_a?(EM::Ssh::Callbacks::Callback) }.each do |iv|
+          instance_variable_set(iv, nil)
+        end
+
+        fail(NegotiationTimeout.new(@host)) if failed_timeout
       end
 
       def receive_data(data)
@@ -116,7 +140,7 @@ module EventMachine
       def connection_completed
         @contimeout.cancel
         @nocon.cancel
-      end # connection_completed
+      end
 
       def initialize(options = {})
         debug("#{self.class}.new(#{options})")
@@ -129,7 +153,7 @@ module EventMachine
 
         begin
           on(:connected) do |session|
-            @connected = true
+            @connected    = true
             succeed(session, @host)
           end
           on(:error) do |e|
@@ -141,11 +165,20 @@ module EventMachine
             fail(ConnectionFailed.new(@host))
             close_connection
           end
+
           @contimeout     = EM::Timer.new(@timeout) do
             fail(ConnectionTimeout.new(@host))
             close_connection
           end
 
+          @negotimeout = EM::Timer.new(options[:nego_timeout] || @timeout) do
+            fail(NegotiationTimeout.new(@host))
+          end
+
+          @algotimeout = EM::Timer.new(options[:nego_timeout] || @timeout) do
+            fail(NegotiationTimeout.new(@host))
+          end
+
           @nonego         = on(:closed) do
             fail(ConnectionTerminated.new(@host))
             close_connection
@@ -160,12 +193,16 @@ module EventMachine
           @host_key_verifier = select_host_key_verifier(options[:paranoid])
           @server_version    = ServerVersion.new(self)
           on(:version_negotiated) do
+            @negotimeout.cancel
+            @negotimeout = nil
             @data.consume!(@server_version.header.length)
             @algorithms = Net::SSH::Transport::Algorithms.new(self, options)
 
             register_data_handler
 
             on_next(:algo_init) do
+              @algotimeout.cancel
+              @algotimeout = nil
               auth = AuthenticationSession.new(self, options)
               user = options.fetch(:user, user)
               Fiber.new do

data/lib/em-ssh/packet-stream.rb

@@ -34,6 +34,12 @@ module EventMachine
         @packet     = nil
       end # initialize(content="")
 
+      def close
+        # remove reference to the connection to facilitate Garbage Collection
+        return super.tap { @connection = nil } if respond_to?(:super)
+        @connection = nil
+      end
+
       # Consumes n bytes from the buffer, where n is the current position
       # unless otherwise specified. This is useful for removing data from the
       # buffer that has previously been read, when you are expecting more data

data/lib/em-ssh/session.rb

@@ -3,7 +3,7 @@ module EventMachine
     class Session < Net::SSH::Connection::Session
       include Log
 
-      def initialize(transport, options = {})
+      def initialize(transport, options={})
         super(transport, options)
         register_callbacks
       end
@@ -28,6 +28,32 @@ module EventMachine
         transport.send_message(msg)
       end
 
+      # Override Net::SSH::Connection::Session#close to remove dangling references to
+      # EM::Ssh::Connections and EM::Ssh::Sessions. Also directly close local channels
+      # if the connection is already closed.
+      def close
+        if @chan_timer
+          @chan_timer.cancel
+          remove_instance_variable(:@chan_timer)
+        end
+
+        # Net::SSH::Connection::Session#close doesn't check if the transport is
+        # closed. If it is then calling Channel#close will will not close the
+        # channel localy and the connection will just spin.
+        if transport.closed?
+          channels.each do |id, c|
+            c.instance_variable_set(:@connection, nil)
+          end
+          channels.clear
+        else
+          channels.each { |id, channel| channel.close }
+          loop { channels.any? && !transport.closed?  }
+        end
+        # remove the reference to the connection to facilitate Garbage Collection
+        transport, @transport = @transport, nil
+        @listeners.clear
+        transport.close
+      end
 
     private
 
@@ -41,12 +67,29 @@ module EventMachine
           send(MAP[packet.type], packet)
         end #  |packet|
 
-        chan_timer = EM.add_periodic_timer(0.01) do
+        @chan_timer = EM.add_periodic_timer(0.01) do
           # we need to check the channel for any data to send and tell it to process any input
           # at some point we should override Channel#enqueue_pending_output, etc.,.
           channels.each { |id, channel| channel.process unless channel.closing? }
         end
       end # register_callbacks
+
+      def channel_close(packet)
+        channel = channels[packet[:local_id]]
+        super(packet).tap do
+          # remove the connection reference to facilitate Garbage Collection
+          channel.instance_variable_set(:@connection, nil)
+        end
+      end
+
+      def channel_open_failure(packet)
+        channel = channels[packet[:local_id]]
+        super(packet).tap do
+          # remove the connection reference to facilitate Garbage Collection
+          channel.instance_variable_set(:@connection, nil)
+        end
+      end
+
     end # class::Session
   end # class::Ssh
 end # module::EventMachine

data/lib/em-ssh/shell.rb

@@ -93,11 +93,23 @@ module EventMachine
 
       # Close the connection to the server and all child shells.
       # Disconnected shells cannot be split.
-      def disconnect
+      def disconnect(timeout = nil)
+        if timeout
+          EM::Timer.new(timeout) { disconnect! }
+        end
         close
-        session && session.close
+        @session && @session.close
+        disconnect!
       end
 
+      def disconnect!
+        @session = nil
+        if @connection
+          @connection.close_connection
+          @connection = nil
+        end
+      end # disconnect!
+
       # @return [Boolean] true if the session is still alive
       def connected?
         session && !session.closed?
@@ -108,7 +120,7 @@ module EventMachine
       # Fires :closed event.
       # @see Callbacks
       def close
-        shell.close.tap{ debug("closing") } if shell.active?
+        shell.close.tap{ debug("closing") } if shell && shell.active?
         @closed = true
         children.each { |c| c.close }
         fire(:closed)
@@ -305,6 +317,7 @@ module EventMachine
       # @see #send_and_wait
       # @param [String] d the data to send encoded as a string
       def send_data(d, send_newline=true)
+        return unless shell
         if send_newline
           shell.send_data("#{d}#{line_terminator}")
         else

data/lib/em-ssh/version.rb

@@ -1,5 +1,5 @@
 module EventMachine
   class Ssh
-    VERSION='0.4.1'
+    VERSION='0.4.2'
   end # class::Ssh
 end # module::EventMachine

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: em-ssh
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-13 00:00:00.000000000 Z
+date: 2012-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine