hrr_rb_sftp 0.1.0 → 0.2.0

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/008_ssh_fxp_fstat.rb

@@ -1,22 +1,39 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_FSTAT
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_FSTAT packet type, format, and responder.
+        #
+        class SSH_FXP_FSTAT < Packet
+
+          #
+          # Represents SSH_FXP_FSTAT packet type.
+          #
           TYPE = 8
 
+          #
+          # Represents SSH_FXP_FSTAT packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"handle"    ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
           ]
 
+          #
+          # Responds to SSH_FXP_FSTAT request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_FSTAT request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_ATTRS. In other cases, its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
-              raise "Specified handle does not exist" unless @handles.has_key?(request[:"handle"])
-              file = @handles[request[:"handle"]]
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              log_debug { "file = handles[#{request[:"handle"].inspect}]" }
+              file = handles[request[:"handle"]]
+              log_debug { "file.stat" }
               stat = file.stat
               attrs = Hash.new
               attrs[:"size"]        = stat.size       if stat.size

data/lib/hrr_rb_sftp/protocol/version1/packets/009_ssh_fxp_setstat.rb

@@ -0,0 +1,92 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_SETSTAT packet type, format, and responder.
+        #
+        class SSH_FXP_SETSTAT < Packet
+
+          #
+          # Represents SSH_FXP_SETSTAT packet type.
+          #
+          TYPE = 9
+
+          #
+          # Represents SSH_FXP_SETSTAT packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
+            [DataTypes::Attrs,  :"attrs"     ],
+          ]
+
+          #
+          # Responds to SSH_FXP_SETSTAT request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_SETSTAT request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              path = request[:"path"]
+              attrs = request[:"attrs"]
+              if attrs.has_key?(:"size")
+                log_debug { "File.truncate(#{path.inspect}, #{attrs[:"size"].inspect})" }
+                File.truncate(path, attrs[:"size"])
+              end
+              if attrs.has_key?(:"permissions")
+                log_debug { "File.chmod(#{attrs[:"permissions"].inspect}, #{path.inspect})" }
+                File.chmod(attrs[:"permissions"], path)
+              end
+              if attrs.has_key?(:"atime") && attrs.has_key?(:"mtime")
+                log_debug { "File.utime(#{attrs[:"atime"].inspect}, #{attrs[:"mtime"].inspect}, #{path.inspect})" }
+                File.utime(attrs[:"atime"], attrs[:"mtime"], path)
+              end
+              if attrs.has_key?(:"uid") && attrs.has_key?(:"gid")
+                log_debug { "File.chown(#{attrs[:"uid"].inspect}, #{attrs[:"gid"].inspect}, #{path.inspect})" }
+                File.chown(attrs[:"uid"], attrs[:"gid"], path)
+              end
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_OK,
+                :"error message" => "Success",
+                :"language tag"  => "",
+              }
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_NO_SUCH_FILE,
+                :"error message" => "No such file or directory",
+                :"language tag"  => "",
+              }
+            rescue Errno::EACCES, Errno::EPERM => e
+              log_debug { e.message }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
+                :"error message" => "Permission denied",
+                :"language tag"  => "",
+              }
+            rescue => e
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
+                :"error message" => e.message,
+                :"language tag"  => "",
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/packets/010_ssh_fxp_fsetstat.rb

@@ -0,0 +1,85 @@
+module HrrRbSftp
+  class Protocol
+    module Version1
+      class Packets
+
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_FSETSTAT packet type, format, and responder.
+        #
+        class SSH_FXP_FSETSTAT < Packet
+
+          #
+          # Represents SSH_FXP_FSETSTAT packet type.
+          #
+          TYPE = 10
+
+          #
+          # Represents SSH_FXP_FSETSTAT packet format.
+          #
+          FORMAT = [
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
+            [DataTypes::Attrs,  :"attrs"     ],
+          ]
+
+          #
+          # Responds to SSH_FXP_FSETSTAT request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_FSETSTAT request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              log_debug { "file = handles[#{request[:"handle"].inspect}]" }
+              file = handles[request[:"handle"]]
+              attrs = request[:"attrs"]
+              if attrs.has_key?(:"size")
+                log_debug { "file.truncate(#{attrs[:"size"].inspect})" }
+                file.truncate(attrs[:"size"])
+              end
+              if attrs.has_key?(:"permissions")
+                log_debug { "file.chmod(#{attrs[:"permissions"].inspect})" }
+                file.chmod(attrs[:"permissions"])
+              end
+              if attrs.has_key?(:"atime") && attrs.has_key?(:"mtime")
+                log_debug { "File.utime(#{attrs[:"atime"].inspect}, #{attrs[:"mtime"].inspect}, #{file.path.inspect})" }
+                File.utime(attrs[:"atime"], attrs[:"mtime"], file.path)
+              end
+              if attrs.has_key?(:"uid") && attrs.has_key?(:"gid")
+                log_debug { "file.chown(#{attrs[:"uid"].inspect}, #{attrs[:"gid"].inspect})" }
+                file.chown(attrs[:"uid"], attrs[:"gid"])
+              end
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_OK,
+                :"error message" => "Success",
+                :"language tag"  => "",
+              }
+            rescue Errno::EPERM => e
+              log_debug { e.message }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_PERMISSION_DENIED,
+                :"error message" => "Permission denied",
+                :"language tag"  => "",
+              }
+            rescue => e
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
+                :"error message" => e.message,
+                :"language tag"  => "",
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/011_ssh_fxp_opendir.rb

@@ -1,29 +1,48 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_OPENDIR
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_OPENDIR packet type, format, and responder.
+        #
+        class SSH_FXP_OPENDIR < Packet
+
+          #
+          # Represents SSH_FXP_OPENDIR packet type.
+          #
           TYPE = 11
 
+          #
+          # Represents SSH_FXP_OPENDIR packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"path"      ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"path"      ],
           ]
 
+          #
+          # Responds to SSH_FXP_OPENDIR request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_OPENDIR request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_HANDLE. In other cases, its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
+              log_debug { "dir = Dir.open(#{request[:"path"].inspect})" }
               dir = ::Dir.open(request[:"path"])
+              log_debug { "handle = #{dir.object_id.to_s(16).inspect}" }
               handle = dir.object_id.to_s(16)
-              @handles[handle] = dir
+              log_debug { "handles[#{handle.inspect}] = dir" }
+              handles[handle] = dir
               {
                 :"type"       => SSH_FXP_HANDLE::TYPE,
                 :"request-id" => request[:"request-id"],
                 :"handle"     => handle,
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -31,7 +50,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -39,7 +59,8 @@ module HrrRbSftp
                 :"error message" => "Permission denied",
                 :"language tag"  => "",
               }
-            rescue Errno::ENOTDIR
+            rescue Errno::ENOTDIR => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/012_ssh_fxp_readdir.rb

@@ -1,18 +1,84 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_READDIR
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_READDIR packet type, format, and responder.
+        #
+        class SSH_FXP_READDIR < Packet
+
+          #
+          # Represents SSH_FXP_READDIR packet type.
+          #
           TYPE = 12
 
+          #
+          # Represents SSH_FXP_READDIR packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"handle"    ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"handle"    ],
           ]
 
+          #
+          # Responds to SSH_FXP_READDIR request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_READDIR request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. In case of success, its type is SSH_FXP_NAME. In other cases, its type is SSH_FXP_STATUS.
+          #
+          def respond_to request
+            begin
+              raise "Specified handle does not exist" unless handles.has_key?(request[:"handle"])
+              log_debug { "dir = handles[#{request[:"handle"].inspect}]" }
+              dir = handles[request[:"handle"]]
+              raise "Specified handle is not directory" unless dir.instance_of?(::Dir)
+              entries = ::Array.new
+              while entry = dir.read
+                log_debug { "#{entry.inspect} = dir.read" }
+                log_debug { "entries.push #{entry.inspect}" }
+                entries.push entry
+              end
+              unless entries.empty?
+                log_debug { "entries is not empty" }
+                log_debug { "count = #{entries.size.inspect}" }
+                count = entries.size
+                response = {
+                  :"type"       => SSH_FXP_NAME::TYPE,
+                  :"request-id" => request[:"request-id"],
+                  :"count"      => count,
+                }
+                entries.each.with_index do |entry, idx|
+                  response[:"filename[#{idx}]"] = entry
+                  response[:"longname[#{idx}]"] = longname(dir, entry)
+                  response[:"attrs[#{idx}]"]    = attrs(dir, entry)
+                end
+                response
+              else
+                log_debug { "entries is empty" }
+                {
+                  :"type"          => SSH_FXP_STATUS::TYPE,
+                  :"request-id"    => request[:"request-id"],
+                  :"code"          => SSH_FXP_STATUS::SSH_FX_EOF,
+                  :"error message" => "End of file",
+                  :"language tag"  => "",
+                }
+              end
+            rescue => e
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+              {
+                :"type"          => SSH_FXP_STATUS::TYPE,
+                :"request-id"    => request[:"request-id"],
+                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
+                :"error message" => e.message,
+                :"language tag"  => "",
+              }
+            end
+          end
+
+          private
+
           def longname_permissions stat
             s = ::String.new
             s += case stat.mode & 0170000
@@ -85,48 +151,6 @@ module HrrRbSftp
             attrs[:"mtime"]       = stat.mtime.to_i if stat.mtime
             attrs
           end
-
-          def respond_to request
-            begin
-              raise "Specified handle does not exist" unless @handles.has_key?(request[:"handle"])
-              dir = @handles[request[:"handle"]]
-              raise "Specified handle is not directory" unless dir.instance_of?(::Dir)
-              entries = ::Array.new
-              while entry = dir.read
-                entries.push entry
-              end
-              unless entries.empty?
-                response = {
-                  :"type"       => SSH_FXP_NAME::TYPE,
-                  :"request-id" => request[:"request-id"],
-                  :"count"      => entries.size,
-                }
-                entries.each.with_index do |entry, idx|
-                  response[:"filename[#{idx}]"] = entry
-                  response[:"longname[#{idx}]"] = longname(dir, entry)
-                  response[:"attrs[#{idx}]"]    = attrs(dir, entry)
-                end
-                response
-              else
-                {
-                  :"type"          => SSH_FXP_STATUS::TYPE,
-                  :"request-id"    => request[:"request-id"],
-                  :"code"          => SSH_FXP_STATUS::SSH_FX_EOF,
-                  :"error message" => "End of file",
-                  :"language tag"  => "",
-                }
-              end
-            rescue => e
-              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
-              {
-                :"type"          => SSH_FXP_STATUS::TYPE,
-                :"request-id"    => request[:"request-id"],
-                :"code"          => SSH_FXP_STATUS::SSH_FX_FAILURE,
-                :"error message" => e.message,
-                :"language tag"  => "",
-              }
-            end
-          end
         end
       end
     end

data/lib/hrr_rb_sftp/protocol/version1/{packet → packets}/013_ssh_fxp_remove.rb

@@ -1,20 +1,36 @@
 module HrrRbSftp
   class Protocol
-    class Version1
-      module Packet
-        class SSH_FXP_REMOVE
-          include Common::Packetable
+    module Version1
+      class Packets
 
+        #
+        # This class implements SFTP protocol version 1 SSH_FXP_REMOVE packet type, format, and responder.
+        #
+        class SSH_FXP_REMOVE < Packet
+
+          #
+          # Represents SSH_FXP_REMOVE packet type.
+          #
           TYPE = 13
 
+          #
+          # Represents SSH_FXP_REMOVE packet format.
+          #
           FORMAT = [
-            [DataType::Byte,   :"type"      ],
-            [DataType::Uint32, :"request-id"],
-            [DataType::String, :"filename"  ],
+            [DataTypes::Byte,   :"type"      ],
+            [DataTypes::Uint32, :"request-id"],
+            [DataTypes::String, :"filename"  ],
           ]
 
+          #
+          # Responds to SSH_FXP_REMOVE request.
+          #
+          # @param request [Hash{Symbol=>Object}] SSH_FXP_REMOVE request represented in Hash.
+          # @return [Hash{Symbol=>Object}] Response represented in Hash. Its type is SSH_FXP_STATUS.
+          #
           def respond_to request
             begin
+              log_debug { "File.delete(#{request[:"filename"].inspect})" }
               File.delete(request[:"filename"])
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
@@ -23,7 +39,8 @@ module HrrRbSftp
                 :"error message" => "Success",
                 :"language tag"  => "",
               }
-            rescue Errno::ENOENT
+            rescue Errno::ENOENT => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],
@@ -31,7 +48,8 @@ module HrrRbSftp
                 :"error message" => "No such file or directory",
                 :"language tag"  => "",
               }
-            rescue Errno::EACCES
+            rescue Errno::EACCES => e
+              log_debug { e.message }
               {
                 :"type"          => SSH_FXP_STATUS::TYPE,
                 :"request-id"    => request[:"request-id"],