net-sftp 0.5.0

data/lib/net/sftp/operations/lstat.rb

@@ -0,0 +1,31 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # The implementation of the +lstat+ operation.
+  class Lstat < Abstract
+
+    # Request attributes for the file/directory at the given path.
+    def perform( path )
+      @driver.lstat( nil, path )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/mkdir.rb

@@ -0,0 +1,33 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # The implementation of the +mkdir+ operation.
+  class Mkdir < Abstract
+
+    # Attempt to create the directory at the given path, giving it the
+    # attributes specified by the hash.
+    def perform( path, hash )
+      attrs = @driver.attr_factory.from_hash( hash )
+      @driver.mkdir( nil, path, attrs )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/open.rb

@@ -0,0 +1,32 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +open+ operation, for obtaining a handle to an open file
+  # on the server.
+  class Open < Abstract
+
+    # Performs the operation.
+    def perform( path, flags=IO::RDONLY, mode=0660 )
+      @driver.open( nil, path, flags, mode )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/opendir.rb

@@ -0,0 +1,32 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +opendir+ operation, for obtaining a handle to an open
+  # directory on the server.
+  class Opendir < Abstract
+
+    # Performs the operation.
+    def perform( path )
+      @driver.opendir( nil, path )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/read.rb

@@ -0,0 +1,84 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +read+ operation, which reads data from an open file handle.
+  # This also implements the common case of reading to the end of the file. In
+  # that case, the callback is guaranteed to receive the contents of the entire
+  # file in one chunk.
+  class Read < Abstract
+
+    # The maximum amount of data to read at once when reading an entire file.
+    # (Setting this to a larger value may cause problems, especially with
+    # very large files, so beware!)
+    CHUNK_SIZE = 64 * 1024
+
+    # Perform the operation. If length is less than 0 (the default), then the
+    # entire file (from the given offset) will be read and returned in "one
+    # fell swoop". Otherwise, the given length of data will be requested.
+    def perform( handle, offset=0, length=-1 )
+      @length = length
+      @handle = handle
+      @offset = offset
+      @data = ""
+
+      real_length = ( length < 0 ? CHUNK_SIZE : length )
+      @driver.read( nil, handle, offset, real_length )
+    end
+
+    # Invoked when a data packet is received from the server. If the original
+    # request was for an entire file, this will send another read request,
+    # offset to the end of the data that has been read so far. Otherwise, the
+    # callback will be invoked directly.
+    def do_data( data )
+      @log.debug "[#{@id}] got #{data.length} bytes" if @log.debug?
+
+      @data << data
+      if @length < 0 || @data.length < @length
+        if @length < 0
+          length = CHUNK_SIZE
+        else
+          length = @length - @data.length
+          length = length > CHUNK_SIZE ? CHUNK_SIZE : length
+        end
+
+        @log.debug "[#{@id}] requesting #{length} more bytes" if @log.debug?
+        @driver.read @id, @handle, @offset + @data.length, length
+        @session.register( @id, self )
+      else
+        @callback[ OK, @data ]
+      end
+    end
+
+    # Invoked when a status code is received from the server. If the code is
+    # FX_EOF, then no data could be read because the end of the file was
+    # reached. In this case, the callback is invoked with the data that has been
+    # read so far. Other status codes are handled by the superclass.
+    def do_status( code, message, language )
+      if code == FX_EOF
+        @log.debug "[#{@id}] got EOF" if @log.debug?
+        @callback[ OK, @data ]
+      else
+        super
+      end
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/readdir.rb

@@ -0,0 +1,55 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +readdir+ operation. This will handle the continuous calls
+  # to +readdir+ until the entire contents of the directory have been read,
+  # returning them in a single array.
+  class Readdir < Abstract
+
+    # Performs the operation.
+    def perform( handle )
+      @items = []
+      @handle = handle
+      @driver.readdir nil, @handle
+    end
+
+    # Invoked when the server returns a list of "names". Requests +readdir+
+    # again, automatically.
+    def do_name( items )
+      @log.debug "[#{@id}] got #{items.length} items" if @log.debug?
+      @items.concat items
+      @driver.readdir @id, @handle
+      @session.register @id, self
+    end
+
+    # Invoked when a status code is received from the server. If the code is
+    # FX_OK or FX_EOF then there is nothing left to read and the callback is
+    # invoked. Other status codes are handled by the superclass.
+    def do_status( code, message, language )
+      if code == FX_OK || code == FX_EOF
+        @callback[ OK, @items ]
+      else
+        super
+      end
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/realpath.rb

@@ -0,0 +1,37 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +realpath+ operation.
+  class Realpath < Abstract
+
+    # Perform the operation.
+    def perform( path )
+      @driver.realpath( nil, path )
+    end
+
+    # A convenience--returns the first (and only) element of the array of items
+    # that is returned, instead of returning the array itself.
+    def do_name( items )
+      @callback[ OK, items.first ]
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/remove.rb

@@ -0,0 +1,31 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +remove+ operation.
+  class Remove < Abstract
+
+    # Perform the operation.
+    def perform( filename )
+      @driver.remove( nil, filename )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/rename.rb

@@ -0,0 +1,32 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +rename+ operation.
+  class Rename < Abstract
+
+    # Perform the operation. The flags parameter is ignored under earlier
+    # versions of the SFTP protocol (3 and under).
+    def perform( filename, new_name, flags=0 )
+      @driver.rename( nil, filename, new_name, flags )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/rmdir.rb

@@ -0,0 +1,31 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+require 'net/sftp/operations/abstract'
+
+module Net ; module SFTP ; module Operations
+
+  # Implements the +rmdir+ operation.
+  class Rmdir < Abstract
+
+    # Perform the operation.
+    def perform( path )
+      @driver.rmdir( nil, path )
+    end
+
+  end
+
+end ; end ; end

data/lib/net/sftp/operations/services.rb

@@ -0,0 +1,42 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+#
+# This source file is distributed as part of the Net::SFTP Secure FTP Client
+# library for Ruby. This file (and the library as a whole) may be used only as
+# allowed by either the BSD license, or the Ruby license (or, by association
+# with the Ruby license, the GPL). See the "doc" subdirectory of the Net::SFTP
+# distribution for the texts of these licenses.
+# -----------------------------------------------------------------------------
+# net-sftp website: http://net-ssh.rubyforge.org/sftp
+# project website : http://rubyforge.org/projects/net-ssh
+# =============================================================================
+#++
+
+module Net ; module SFTP ; module Operations
+
+  # Register all services that implement an SFTP operation.
+  def register_services( container )
+    container.namespace :operations
+    container.operations.use :model => :prototype do |ns|
+      [
+        :open,
+        [ :close_handle, :close ],
+        :read, :write, :opendir, :readdir, :remove,
+        :stat, :lstat, :fstat, :setstat, :fsetstat,
+        :mkdir, :rmdir, :realpath, :rename
+      ].each do |op|
+        array = op.is_a?( Array )
+        ns.register( array ? op.first : op ) do |c,p|
+          require "net/sftp/operations/#{array ? op.last : op}"
+          klass_name = ( array ? op.last : op ).to_s
+          klass = const_get( klass_name[0,1].upcase + klass_name[1..-1] )
+          klass.new c[:log_for, p], c[:session], c[:protocol][:driver]
+        end
+      end
+    end
+  end
+  module_function :register_services
+
+end ; end ; end