capistrano-file-transfer-ext 0.0.1 → 0.0.2

data/lib/capistrano/configuration/actions/file_transfer_ext.rb

@@ -7,36 +7,121 @@ module Capistrano
   class Configuration
     module Actions
       module FileTransferExt
+        DIGEST_FILTER_CMD = %{awk '{for(n=1;n<=NF;n++){if(match($n,"^[0-9a-z]{16,}$")){print($n);break}}}'}
+
         def safe_put(data, path, options={})
           opts = options.dup
           safe_upload(StringIO.new(data), path, opts)
         end
 
+        # upload file from local to remote.
+        # this method uses temporary file to avoid incomplete transmission of files.
+        #
+        # The +options+ hash may include any of the following keys:
+        #
+        # * :transfer - use transfer_if_modified if :if_modified is set
+        # * :place - use place_if_modified if :if_modified is set
+        # * :run_method - the default is :run.
         def safe_upload(from, to, options={}, &block)
-          mode = options.delete(:mode)
-          via = ( options.delete(:via) || :run )
-          compare_method = ( options.delete(:compare_method) || :cmp )
+          transfer_method = options.delete(:transfer) == :if_modified ? :transfer_if_modified : :transfer
+          place_method = options.delete(:place) == :if_modified ? :place_if_modified : :place
+          run_method = ( options.delete(:run_method) || :run )
           begin
             tempname = File.join("/tmp", File.basename(to) + ".XXXXXXXXXX")
             tempfile = capture("mktemp #{tempname.dump}").strip
             run("rm -f #{tempfile.dump}", options)
-            transfer(:up, from, tempfile, options, &block)
-            execute = []
-            case compare_method
-            when :diff
-              execute << "( diff -u #{to.dump} #{tempfile.dump} || mv -f #{tempfile.dump} #{to.dump} )"
-            else
-              execute << "( cmp #{to.dump} #{tempfile.dump} || mv -f #{tempfile.dump} #{to.dump} )"
-            end
-            if mode
-              mode = mode.is_a?(Numeric) ? mode.to_s(8) : mode.to_s
-              execute << "chmod #{mode} #{to}"
-            end
-            invoke_command(execute.join(" && "), options.merge(:via => via))
+            send(transfer_method, :up, from, tempfile, options, &block)
+            send(place_method, tempfile, to, options.merge(:via => run_method), &block)
           ensure
             run("rm -f #{tempfile.dump}", options) rescue nil
           end
         end
+
+        # transfer file (or IO like object) from local to remote, only if the file checksum is differ.
+        # do not care if the transfer has been completed or not.
+        #
+        # The +options+ hash may include any of the following keys:
+        #
+        # * :digest - digest algorithm. the default is "md5".
+        # * :digest_cmd - the digest command. the default is "#{digest}sum".
+        #
+        def transfer_if_modified(direction, from, to, options={}, &block)
+          digest_method = options.fetch(:digest, "md5")
+          digest_cmd = options.fetch(:digest_cmd, "#{digest_method.downcase}sum")
+          require "digest/#{digest_method.downcase}"
+          target = direction == :up ? from : to
+          remote_target = direction == :up ? to : from
+          if target.respond_to?(:read)
+            pos = target.pos
+            digest = Digest.const_get(digest_method.upcase).hexdigest(target.read)
+            target.pos = pos
+          else
+            begin
+              digest = Digest::const_get(digest_method.upcase).hexdigest(File.read(target))
+            rescue SystemCallError
+              digest = nil
+            end
+          end
+          if dry_run
+            logger.debug("transfering: #{[direction, from, to] * ', '}")
+          else
+            execute_on_servers(options) do |servers|
+              targets = servers.map { |server| sessions[server] }.reject { |session|
+                remote_digest = session.exec!("test -f #{remote_target.dump} && #{digest_cmd} #{remote_target.dump} | #{DIGEST_FILTER_CMD}")
+                result = !( digest.nil? or remote_digest.nil? ) && digest == remote_digest.strip
+                logger.info("#{session.xserver.host}: skip transfering since no changes: #{[direction, from, to] * ', '}") if result
+                result
+              }
+              Capistrano::Transfer.process(direction, from, to, targets, options.merge(:logger => logger), &block) unless targets.empty?
+            end
+          end
+        end
+
+        # place a file on remote.
+        #
+        # The +options+ hash may include any of the following keys:
+        #
+        # * :mode - permission of the file.
+        # * :sudo - use sudo if set true. the default is false.
+        #
+        def place(from, to, options={}, &block)
+          mode = options.delete(:mode)
+          try_sudo = options.delete(:sudo) ? sudo : ""
+          execute = []
+          execute << "( test -d #{File.dirname(to).dump} || #{try_sudo} mkdir -p #{File.dirname(to).dump} )"
+          execute << "#{try_sudo} mv -f #{from.dump} #{to.dump}"
+          if mode
+            mode = mode.is_a?(Numeric) ? mode.to_s(8) : mode.to_s
+            execute << "#{try_sudo} chmod #{mode} #{to.dump}"
+          end
+          invoke_command(execute.join(" && "), options)
+        end
+
+        # place a file on remote, only if the destination is differ from source.
+        #
+        # The +options+ hash may include any of the following keys:
+        #
+        # * :mode - permission of the file.
+        # * :sudo - use sudo if set true. the default is false.
+        # * :digest - digest algorithm. the default is "md5".
+        # * :digest_cmd - the digest command. the default is "#{digest}sum".
+        #
+        def place_if_modified(from, to, options={}, &block)
+          mode = options.delete(:mode)
+          try_sudo = options.delete(:sudo) ? sudo : ""
+          digest_method = options.fetch(:digest, "md5")
+          digest_cmd = options.fetch(:digest_cmd, "#{digest_method.downcase}sum")
+          execute = []
+          execute << %{( test -d #{File.dirname(to).dump} || #{try_sudo} mkdir -p #{File.dirname(to).dump} )}
+          execute << %{from=$(#{digest_cmd} #{from.dump} | #{DIGEST_FILTER_CMD})}
+          execute << %{to=$(#{digest_cmd} #{to.dump} | #{DIGEST_FILTER_CMD})}
+          execute << %{( test "x${from}" = "x${to}" || ( echo #{from.dump} '->' #{to.dump}; #{try_sudo} mv -f #{from.dump} #{to.dump} ) )}
+          if mode
+            mode = mode.is_a?(Numeric) ? mode.to_s(8) : mode.to_s
+            execute << "#{try_sudo} chmod #{mode} #{to.dump}"
+          end
+          invoke_command(execute.join(" && "), options)
+        end
       end
     end
   end

data/lib/capistrano/configuration/actions/file_transfer_ext/version.rb

@@ -2,7 +2,7 @@ module Capistrano
   class Configuration
     module Actions
       module FileTransferExt
-        VERSION = "0.0.1"
+        VERSION = "0.0.2"
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-file-transfer-ext
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-19 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano