train-core 1.4.4

data/lib/train/file/local.rb

@@ -0,0 +1,75 @@
+# encoding: utf-8
+
+module Train
+  class File
+    class Local < Train::File
+      %w{
+        exist? file? socket? directory? symlink? pipe? size basename
+      }.each do |m|
+        define_method m.to_sym do
+          ::File.method(m.to_sym).call(@path)
+        end
+      end
+
+      def content
+        @content ||= ::File.read(@path, encoding: 'UTF-8')
+      rescue StandardError => _
+        nil
+      end
+
+      def link_path
+        return nil unless symlink?
+        begin
+          @link_path ||= ::File.realpath(@path)
+        rescue Errno::ELOOP => _
+          # Leave it blank on symbolic loop, same as readlink
+          @link_path = ''
+        end
+      end
+
+      def block_device?
+        ::File.blockdev?(@path)
+      end
+
+      def character_device?
+        ::File.chardev?(@path)
+      end
+
+      def type
+        case ::File.ftype(@path)
+        when 'blockSpecial'
+          :block_device
+        when 'characterSpecial'
+          :character_device
+        when 'link'
+          :symlink
+        when 'fifo'
+          :pipe
+        else
+          ::File.ftype(@path).to_sym
+        end
+      end
+
+      %w{
+        mode owner group uid gid mtime selinux_label
+      }.each do |field|
+        define_method field.to_sym do
+          stat[field.to_sym]
+        end
+      end
+
+      def mode?(sth)
+        mode == sth
+      end
+
+      def linked_to?(dst)
+        link_path == dst
+      end
+    end
+  end
+end
+
+# subclass requires are loaded after Train::File::Local is defined
+# to avoid superclass mismatch errors
+require 'train/file/local/unix'
+require 'train/file/local/windows'

data/lib/train/file/local/unix.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+require 'shellwords'
+require 'train/extras/stat'
+
+module Train
+  class File
+    class Local
+      class Unix < Train::File::Local
+        def sanitize_filename(path)
+          @spath = Shellwords.escape(path) || @path
+        end
+
+        def stat
+          return @stat if defined?(@stat)
+
+          begin
+            file_stat =
+              if @follow_symlink
+                ::File.stat(@path)
+              else
+                ::File.lstat(@path)
+              end
+          rescue StandardError => _err
+            return @stat = {}
+          end
+
+          @stat = {
+            type: Train::Extras::Stat.find_type(file_stat.mode),
+            mode: file_stat.mode & 07777,
+            mtime: file_stat.mtime.to_i,
+            size: file_stat.size,
+            owner: pw_username(file_stat.uid),
+            uid: file_stat.uid,
+            group: pw_groupname(file_stat.gid),
+            gid: file_stat.gid,
+          }
+
+          lstat = @follow_symlink ? ' -L' : ''
+          res = @backend.run_command("stat#{lstat} #{@spath} 2>/dev/null --printf '%C'")
+          if res.exit_status == 0 && !res.stdout.empty? && res.stdout != '?'
+            @stat[:selinux_label] = res.stdout.strip
+          end
+
+          @stat
+        end
+
+        def mounted
+          @mounted ||=
+            @backend.run_command("mount | grep -- ' on #{@spath} '")
+        end
+
+        def grouped_into?(sth)
+          group == sth
+        end
+
+        def unix_mode_mask(owner, type)
+          o = UNIX_MODE_OWNERS[owner.to_sym]
+          return nil if o.nil?
+
+          t = UNIX_MODE_TYPES[type.to_sym]
+          return nil if t.nil?
+
+          t & o
+        end
+
+        private
+
+        def pw_username(uid)
+          Etc.getpwuid(uid).name
+        rescue ArgumentError => _
+          nil
+        end
+
+        def pw_groupname(gid)
+          Etc.getgrgid(gid).name
+        rescue ArgumentError => _
+          nil
+        end
+
+        UNIX_MODE_OWNERS = {
+          all:   00777,
+          owner: 00700,
+          group: 00070,
+          other: 00007,
+        }.freeze
+
+        UNIX_MODE_TYPES = {
+          r: 00444,
+          w: 00222,
+          x: 00111,
+        }.freeze
+      end
+    end
+  end
+end

data/lib/train/file/local/windows.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+
+module Train
+  class File
+    class Local
+      class Windows < Train::File::Local
+        # Ensures we do not use invalid characters for file names
+        # @see https://msdn.microsoft.com/en-us/library/windows/desktop/aa365247(v=vs.85).aspx#naming_conventions
+        def sanitize_filename(path)
+          return if path.nil?
+          # we do not filter :, backslash and forward slash, since they are part of the path
+          @spath = path.gsub(/[<>"|?*]/, '')
+        end
+
+        def product_version
+          @product_version ||= @backend.run_command(
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").ProductVersion").stdout.chomp
+        end
+
+        def file_version
+          @file_version ||= @backend.run_command(
+            "[System.Diagnostics.FileVersionInfo]::GetVersionInfo(\"#{@spath}\").FileVersion").stdout.chomp
+        end
+
+        def owner
+          owner = @backend.run_command(
+            "Get-Acl \"#{@spath}\" | select -expand Owner").stdout.strip
+          return if owner.empty?
+          owner
+        end
+
+        def stat
+          return @stat if defined?(@stat)
+
+          begin
+            file_stat =
+              if @follow_symlink
+                ::File.stat(@path)
+              else
+                ::File.lstat(@path)
+              end
+          rescue StandardError => _err
+            return @stat = {}
+          end
+
+          @stat = {
+            type: type,
+            mode: file_stat.mode,
+            mtime: file_stat.mtime.to_i,
+            size: file_stat.size,
+            owner: owner,
+            uid: file_stat.uid,
+            group: nil,
+            gid: file_stat.gid,
+            selinux_label: nil,
+          }
+
+          @stat
+        end
+      end
+    end
+  end
+end

data/lib/train/file/remote.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+module Train
+  class File
+    class Remote < Train::File
+      def basename(suffix = nil, sep = '/')
+        fail 'Not yet supported: Suffix in file.basename' unless suffix.nil?
+        @basename ||= detect_filename(path, sep || '/')
+      end
+
+      def stat
+        return @stat if defined?(@stat)
+        @stat = Train::Extras::Stat.stat(@spath, @backend, @follow_symlink)
+      end
+
+      # helper methods provided to any implementing class
+      private
+
+      def detect_filename(path, sep)
+        idx = path.rindex(sep)
+        return path if idx.nil?
+        idx += 1
+        return detect_filename(path[0..-2], sep) if idx == path.length
+        path[idx..-1]
+      end
+    end
+  end
+end
+
+# subclass requires are loaded after Train::File::Remote is defined
+# to avoid superclass mismatch errors
+require 'train/file/remote/aix'
+require 'train/file/remote/linux'
+require 'train/file/remote/qnx'
+require 'train/file/remote/unix'
+require 'train/file/remote/windows'

data/lib/train/file/remote/aix.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+require 'train/file/remote/unix'
+
+module Train
+  class File
+    class Remote
+      class Aix < Train::File::Remote::Unix
+        def link_path
+          return nil unless symlink?
+          @link_path ||=
+            @backend.run_command("perl -e 'print readlink shift' #{@spath}").stdout.chomp
+        end
+
+        def mounted
+          @mounted ||= @backend.run_command("lsfs -c #{@spath}")
+        end
+      end
+    end
+  end
+end

data/lib/train/file/remote/linux.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+require 'train/file/remote/unix'
+
+module Train
+  class File
+    class Remote
+      class Linux < Train::File::Remote::Unix
+        def content
+          return @content if defined?(@content)
+          @content = @backend.run_command("cat #{@spath} || echo -n").stdout
+          return @content unless @content.empty?
+          @content = nil if directory? or size.nil? or size > 0
+          @content
+        end
+      end
+    end
+  end
+end

data/lib/train/file/remote/qnx.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+#
+# author: Christoph Hartmann
+# author: Dominik Richter
+
+require 'train/file/remote/unix'
+
+module Train
+  class File
+    class Remote
+      class Qnx < Train::File::Remote::Unix
+        def content
+          cat = 'cat'
+          cat = '/proc/boot/cat' if @backend.os[:release].to_i >= 7
+          @content ||= case
+                       when !exist?
+                         nil
+                       else
+                         @backend.run_command("#{cat} #{@spath}").stdout || ''
+                       end
+        end
+
+        def type
+          if @backend.run_command("file #{@spath}").stdout.include?('directory')
+            return :directory
+          else
+            return :file
+          end
+        end
+
+        %w{
+          mode owner group uid gid mtime size selinux_label link_path mounted stat
+        }.each do |field|
+          define_method field.to_sym do
+            fail NotImplementedError, "QNX does not implement the #{field}() method yet."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/train/file/remote/unix.rb

@@ -0,0 +1,106 @@
+# encoding: utf-8
+
+require 'shellwords'
+
+module Train
+  class File
+    class Remote
+      class Unix < Train::File::Remote
+        attr_reader :path
+
+        def sanitize_filename(path)
+          @spath = Shellwords.escape(path) || @path
+        end
+
+        def content
+          @content ||=
+            if !exist? || directory?
+              nil
+            elsif size.nil? || size.zero?
+              ''
+            else
+              @backend.run_command("cat #{@spath}").stdout || ''
+            end
+        end
+
+        def exist?
+          @exist ||= (
+            f = @follow_symlink ? '' : " || test -L #{@spath}"
+            @backend.run_command("test -e #{@spath}"+f)
+                    .exit_status == 0
+          )
+        end
+
+        def mounted
+          @mounted ||=
+            @backend.run_command("mount | grep -- ' on #{@spath} '")
+        end
+
+        %w{
+          type mode owner group uid gid mtime size selinux_label
+        }.each do |field|
+          define_method field.to_sym do
+            stat[field.to_sym]
+          end
+        end
+
+        def mode?(sth)
+          mode == sth
+        end
+
+        def grouped_into?(sth)
+          group == sth
+        end
+
+        def linked_to?(dst)
+          link_path == dst
+        end
+
+        def link_path
+          symlink? ? path : nil
+        end
+
+        def unix_mode_mask(owner, type)
+          o = UNIX_MODE_OWNERS[owner.to_sym]
+          return nil if o.nil?
+
+          t = UNIX_MODE_TYPES[type.to_sym]
+          return nil if t.nil?
+
+          t & o
+        end
+
+        def path
+          return @path unless @follow_symlink && symlink?
+          @link_path ||= read_target_path
+        end
+
+        private
+
+        # Returns full path of a symlink target(real dest) or '' on symlink loop
+        def read_target_path
+          full_path = @backend.run_command("readlink -n #{@spath} -f").stdout
+          # Needed for some OSes like OSX that returns relative path
+          # when the link and target are in the same directory
+          if !full_path.start_with?('/') && full_path != ''
+            full_path = ::File.expand_path("../#{full_path}", @spath)
+          end
+          full_path
+        end
+
+        UNIX_MODE_OWNERS = {
+          all:   00777,
+          owner: 00700,
+          group: 00070,
+          other: 00007,
+        }.freeze
+
+        UNIX_MODE_TYPES = {
+          r: 00444,
+          w: 00222,
+          x: 00111,
+        }.freeze
+      end
+    end
+  end
+end