rubyzip 1.3.0 → 3.0.0.alpha

data/lib/zip/file_split.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Zip
+  module FileSplit # :nodoc:
+    MAX_SEGMENT_SIZE = 3_221_225_472
+    MIN_SEGMENT_SIZE = 65_536
+    DATA_BUFFER_SIZE = 8192
+
+    def get_segment_size_for_split(segment_size)
+      if MIN_SEGMENT_SIZE > segment_size
+        MIN_SEGMENT_SIZE
+      elsif MAX_SEGMENT_SIZE < segment_size
+        MAX_SEGMENT_SIZE
+      else
+        segment_size
+      end
+    end
+
+    def get_partial_zip_file_name(zip_file_name, partial_zip_file_name)
+      unless partial_zip_file_name.nil?
+        partial_zip_file_name = zip_file_name.sub(
+          /#{::File.basename(zip_file_name)}\z/,
+          partial_zip_file_name + ::File.extname(zip_file_name)
+        )
+      end
+      partial_zip_file_name ||= zip_file_name
+      partial_zip_file_name
+    end
+
+    def get_segment_count_for_split(zip_file_size, segment_size)
+      (zip_file_size / segment_size).to_i +
+        ((zip_file_size % segment_size).zero? ? 0 : 1)
+    end
+
+    def put_split_signature(szip_file, segment_size)
+      signature_packed = [SPLIT_FILE_SIGNATURE].pack('V')
+      szip_file << signature_packed
+      segment_size - signature_packed.size
+    end
+
+    #
+    # TODO: Make the code more understandable
+    #
+    def save_splited_part(
+      zip_file, partial_zip_file_name, zip_file_size,
+      szip_file_index, segment_size, segment_count
+    )
+      ssegment_size  = zip_file_size - zip_file.pos
+      ssegment_size  = segment_size if ssegment_size > segment_size
+      szip_file_name = "#{partial_zip_file_name}.#{format('%03d', szip_file_index)}"
+      ::File.open(szip_file_name, 'wb') do |szip_file|
+        if szip_file_index == 1
+          ssegment_size = put_split_signature(szip_file, segment_size)
+        end
+        chunk_bytes = 0
+        until ssegment_size == chunk_bytes || zip_file.eof?
+          segment_bytes_left = ssegment_size - chunk_bytes
+          buffer_size        = [segment_bytes_left, DATA_BUFFER_SIZE].min
+          chunk              = zip_file.read(buffer_size)
+          chunk_bytes += buffer_size
+          szip_file << chunk
+          # Info for track splitting
+          yield segment_count, szip_file_index, chunk_bytes, ssegment_size if block_given?
+        end
+      end
+    end
+
+    # Splits an archive into parts with segment size
+    def split(
+      zip_file_name, segment_size: MAX_SEGMENT_SIZE,
+      delete_original: true, partial_zip_file_name: nil
+    )
+      raise Error, "File #{zip_file_name} not found" unless ::File.exist?(zip_file_name)
+      raise Errno::ENOENT, zip_file_name unless ::File.readable?(zip_file_name)
+
+      zip_file_size = ::File.size(zip_file_name)
+      segment_size  = get_segment_size_for_split(segment_size)
+      return if zip_file_size <= segment_size
+
+      segment_count = get_segment_count_for_split(zip_file_size, segment_size)
+      ::Zip::File.open(zip_file_name) {} # Check for correct zip structure.
+      partial_zip_file_name = get_partial_zip_file_name(zip_file_name, partial_zip_file_name)
+      szip_file_index       = 0
+      ::File.open(zip_file_name, 'rb') do |zip_file|
+        until zip_file.eof?
+          szip_file_index += 1
+          save_splited_part(
+            zip_file, partial_zip_file_name, zip_file_size,
+            szip_file_index, segment_size, segment_count
+          )
+        end
+      end
+      ::File.delete(zip_file_name) if delete_original
+      szip_file_index
+    end
+  end
+end

data/lib/zip/filesystem/dir.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Zip
+  module FileSystem
+    class Dir # :nodoc:all
+      def initialize(mapped_zip)
+        @mapped_zip = mapped_zip
+      end
+
+      attr_writer :file
+
+      def new(directory_name)
+        DirectoryIterator.new(entries(directory_name))
+      end
+
+      def open(directory_name)
+        dir_iter = new(directory_name)
+        if block_given?
+          begin
+            yield(dir_iter)
+            return nil
+          ensure
+            dir_iter.close
+          end
+        end
+        dir_iter
+      end
+
+      def pwd
+        @mapped_zip.pwd
+      end
+      alias getwd pwd
+
+      def chdir(directory_name)
+        unless @file.stat(directory_name).directory?
+          raise Errno::EINVAL, "Invalid argument - #{directory_name}"
+        end
+
+        @mapped_zip.pwd = @file.expand_path(directory_name)
+      end
+
+      def entries(directory_name)
+        entries = []
+        foreach(directory_name) { |e| entries << e }
+        entries
+      end
+
+      def glob(*args, &block)
+        @mapped_zip.glob(*args, &block)
+      end
+
+      def foreach(directory_name)
+        unless @file.stat(directory_name).directory?
+          raise Errno::ENOTDIR, directory_name
+        end
+
+        path = @file.expand_path(directory_name)
+        path << '/' unless path.end_with?('/')
+        path = Regexp.escape(path)
+        subdir_entry_regex = Regexp.new("^#{path}([^/]+)$")
+        @mapped_zip.each do |filename|
+          match = subdir_entry_regex.match(filename)
+          yield(match[1]) unless match.nil?
+        end
+      end
+
+      def delete(entry_name)
+        unless @file.stat(entry_name).directory?
+          raise Errno::EINVAL, "Invalid argument - #{entry_name}"
+        end
+
+        @mapped_zip.remove(entry_name)
+      end
+      alias rmdir delete
+      alias unlink delete
+
+      def mkdir(entry_name, permissions = 0o755)
+        @mapped_zip.mkdir(entry_name, permissions)
+      end
+
+      def chroot(*_args)
+        raise NotImplementedError, 'The chroot() function is not implemented'
+      end
+    end
+  end
+end

data/lib/zip/filesystem/directory_iterator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Zip
+  module FileSystem
+    class DirectoryIterator # :nodoc:all
+      include Enumerable
+
+      def initialize(filenames)
+        @filenames = filenames
+        @index = 0
+      end
+
+      def close
+        @filenames = nil
+      end
+
+      def each(&a_proc)
+        raise IOError, 'closed directory' if @filenames.nil?
+
+        @filenames.each(&a_proc)
+      end
+
+      def read
+        raise IOError, 'closed directory' if @filenames.nil?
+
+        @filenames[(@index += 1) - 1]
+      end
+
+      def rewind
+        raise IOError, 'closed directory' if @filenames.nil?
+
+        @index = 0
+      end
+
+      def seek(position)
+        raise IOError, 'closed directory' if @filenames.nil?
+
+        @index = position
+      end
+
+      def tell
+        raise IOError, 'closed directory' if @filenames.nil?
+
+        @index
+      end
+    end
+  end
+end

data/lib/zip/filesystem/file.rb

@@ -0,0 +1,262 @@
+# frozen_string_literal: true
+
+require_relative 'file_stat'
+
+module Zip
+  module FileSystem
+    # Instances of this class are normally accessed via the accessor
+    # Zip::File::file. An instance of File behaves like ruby's
+    # builtin File (class) object, except it works on Zip::File entries.
+    #
+    # The individual methods are not documented due to their
+    # similarity with the methods in File
+    class File # :nodoc:all
+      attr_writer :dir
+
+      def initialize(mapped_zip)
+        @mapped_zip = mapped_zip
+      end
+
+      def find_entry(filename)
+        unless exists?(filename)
+          raise Errno::ENOENT, "No such file or directory - #{filename}"
+        end
+
+        @mapped_zip.find_entry(filename)
+      end
+
+      def unix_mode_cmp(filename, mode)
+        e = find_entry(filename)
+        e.fstype == FSTYPE_UNIX && ((e.external_file_attributes >> 16) & mode) != 0
+      rescue Errno::ENOENT
+        false
+      end
+      private :unix_mode_cmp
+
+      def exists?(filename)
+        expand_path(filename) == '/' || !@mapped_zip.find_entry(filename).nil?
+      end
+      alias exist? exists?
+
+      # Permissions not implemented, so if the file exists it is accessible
+      alias owned? exists?
+      alias grpowned? exists?
+
+      def readable?(filename)
+        unix_mode_cmp(filename, 0o444)
+      end
+      alias readable_real? readable?
+
+      def writable?(filename)
+        unix_mode_cmp(filename, 0o222)
+      end
+      alias writable_real? writable?
+
+      def executable?(filename)
+        unix_mode_cmp(filename, 0o111)
+      end
+      alias executable_real? executable?
+
+      def setuid?(filename)
+        unix_mode_cmp(filename, 0o4000)
+      end
+
+      def setgid?(filename)
+        unix_mode_cmp(filename, 0o2000)
+      end
+
+      def sticky?(filename)
+        unix_mode_cmp(filename, 0o1000)
+      end
+
+      def umask(*args)
+        ::File.umask(*args)
+      end
+
+      def truncate(_filename, _len)
+        raise StandardError, 'truncate not supported'
+      end
+
+      def directory?(filename)
+        entry = @mapped_zip.find_entry(filename)
+        expand_path(filename) == '/' || (!entry.nil? && entry.directory?)
+      end
+
+      def open(filename, mode = 'r', permissions = 0o644, &block)
+        mode = mode.tr('b', '') # ignore b option
+        case mode
+        when 'r'
+          @mapped_zip.get_input_stream(filename, &block)
+        when 'w'
+          @mapped_zip.get_output_stream(filename, permissions, &block)
+        else
+          raise StandardError, "openmode '#{mode} not supported" unless mode == 'r'
+        end
+      end
+
+      def new(filename, mode = 'r')
+        self.open(filename, mode)
+      end
+
+      def size(filename)
+        @mapped_zip.get_entry(filename).size
+      end
+
+      # Returns nil for not found and nil for directories
+      def size?(filename)
+        entry = @mapped_zip.find_entry(filename)
+        entry.nil? || entry.directory? ? nil : entry.size
+      end
+
+      def chown(owner, group, *filenames)
+        filenames.each do |filename|
+          e = find_entry(filename)
+          e.extra.create('IUnix') unless e.extra.member?('IUnix')
+          e.extra['IUnix'].uid = owner
+          e.extra['IUnix'].gid = group
+        end
+        filenames.size
+      end
+
+      def chmod(mode, *filenames)
+        filenames.each do |filename|
+          e = find_entry(filename)
+          e.fstype = FSTYPE_UNIX # Force conversion filesystem type to unix.
+          e.unix_perms = mode
+          e.external_file_attributes = mode << 16
+        end
+        filenames.size
+      end
+
+      def zero?(filename)
+        sz = size(filename)
+        sz.nil? || sz == 0
+      rescue Errno::ENOENT
+        false
+      end
+
+      def file?(filename)
+        entry = @mapped_zip.find_entry(filename)
+        !entry.nil? && entry.file?
+      end
+
+      def dirname(filename)
+        ::File.dirname(filename)
+      end
+
+      def basename(filename)
+        ::File.basename(filename)
+      end
+
+      def split(filename)
+        ::File.split(filename)
+      end
+
+      def join(*fragments)
+        ::File.join(*fragments)
+      end
+
+      def utime(modified_time, *filenames)
+        filenames.each do |filename|
+          find_entry(filename).time = modified_time
+        end
+      end
+
+      def mtime(filename)
+        @mapped_zip.get_entry(filename).mtime
+      end
+
+      def atime(filename)
+        @mapped_zip.get_entry(filename).atime
+      end
+
+      def ctime(filename)
+        @mapped_zip.get_entry(filename).ctime
+      end
+
+      def pipe?(_filename)
+        false
+      end
+
+      def blockdev?(_filename)
+        false
+      end
+
+      def chardev?(_filename)
+        false
+      end
+
+      def symlink?(filename)
+        @mapped_zip.get_entry(filename).symlink?
+      end
+
+      def socket?(_filename)
+        false
+      end
+
+      def ftype(filename)
+        @mapped_zip.get_entry(filename).directory? ? 'directory' : 'file'
+      end
+
+      def readlink(_filename)
+        raise NotImplementedError, 'The readlink() function is not implemented'
+      end
+
+      def symlink(_filename, _symlink_name)
+        raise NotImplementedError, 'The symlink() function is not implemented'
+      end
+
+      def link(_filename, _symlink_name)
+        raise NotImplementedError, 'The link() function is not implemented'
+      end
+
+      def pipe
+        raise NotImplementedError, 'The pipe() function is not implemented'
+      end
+
+      def stat(filename)
+        raise Errno::ENOENT, filename unless exists?(filename)
+
+        Stat.new(self, filename)
+      end
+
+      alias lstat stat
+
+      def readlines(filename)
+        self.open(filename, &:readlines)
+      end
+
+      def read(filename)
+        @mapped_zip.read(filename)
+      end
+
+      def popen(*args, &a_proc)
+        ::File.popen(*args, &a_proc)
+      end
+
+      def foreach(filename, sep = $INPUT_RECORD_SEPARATOR, &a_proc)
+        self.open(filename) { |is| is.each_line(sep, &a_proc) }
+      end
+
+      def delete(*args)
+        args.each do |filename|
+          if directory?(filename)
+            raise Errno::EISDIR, "Is a directory - \"#{filename}\""
+          end
+
+          @mapped_zip.remove(filename)
+        end
+      end
+
+      def rename(file_to_rename, new_name)
+        @mapped_zip.rename(file_to_rename, new_name) { true }
+      end
+
+      alias unlink delete
+
+      def expand_path(path)
+        @mapped_zip.expand_path(path)
+      end
+    end
+  end
+end

data/lib/zip/filesystem/file_stat.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module Zip
+  module FileSystem
+    class File # :nodoc:all
+      class Stat # :nodoc:all
+        class << self
+          def delegate_to_fs_file(*methods)
+            methods.each do |method|
+              class_exec do
+                define_method(method) do
+                  @zip_fs_file.__send__(method, @entry_name)
+                end
+              end
+            end
+          end
+        end
+
+        def initialize(zip_fs_file, entry_name)
+          @zip_fs_file = zip_fs_file
+          @entry_name = entry_name
+        end
+
+        def kind_of?(type)
+          super || type == ::File::Stat
+        end
+
+        delegate_to_fs_file :file?, :directory?, :pipe?, :chardev?, :symlink?,
+                            :socket?, :blockdev?, :readable?, :readable_real?, :writable?, :ctime,
+                            :writable_real?, :executable?, :executable_real?, :sticky?, :owned?,
+                            :grpowned?, :setuid?, :setgid?, :zero?, :size, :size?, :mtime, :atime
+
+        def blocks
+          nil
+        end
+
+        def gid
+          e = find_entry
+          if e.extra.member? 'IUnix'
+            e.extra['IUnix'].gid || 0
+          else
+            0
+          end
+        end
+
+        def uid
+          e = find_entry
+          if e.extra.member? 'IUnix'
+            e.extra['IUnix'].uid || 0
+          else
+            0
+          end
+        end
+
+        def ino
+          0
+        end
+
+        def dev
+          0
+        end
+
+        def rdev
+          0
+        end
+
+        def rdev_major
+          0
+        end
+
+        def rdev_minor
+          0
+        end
+
+        def ftype
+          if file?
+            'file'
+          elsif directory?
+            'directory'
+          else
+            raise StandardError, 'Unknown file type'
+          end
+        end
+
+        def nlink
+          1
+        end
+
+        def blksize
+          nil
+        end
+
+        def mode
+          e = find_entry
+          if e.fstype == FSTYPE_UNIX
+            e.external_file_attributes >> 16
+          else
+            0o100_666 # Equivalent to -rw-rw-rw-.
+          end
+        end
+
+        private
+
+        def find_entry
+          @zip_fs_file.find_entry(@entry_name)
+        end
+      end
+    end
+  end
+end

data/lib/zip/filesystem/zip_file_name_mapper.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Zip
+  module FileSystem
+    # All access to Zip::File from FileSystem::File and FileSystem::Dir
+    # goes through a ZipFileNameMapper, which has one responsibility: ensure
+    class ZipFileNameMapper # :nodoc:all
+      include Enumerable
+
+      def initialize(zip_file)
+        @zip_file = zip_file
+        @pwd = '/'
+      end
+
+      attr_accessor :pwd
+
+      def find_entry(filename)
+        @zip_file.find_entry(expand_to_entry(filename))
+      end
+
+      def get_entry(filename)
+        @zip_file.get_entry(expand_to_entry(filename))
+      end
+
+      def get_input_stream(filename, &a_proc)
+        @zip_file.get_input_stream(expand_to_entry(filename), &a_proc)
+      end
+
+      def get_output_stream(filename, permissions = nil, &a_proc)
+        @zip_file.get_output_stream(
+          expand_to_entry(filename), permissions: permissions, &a_proc
+        )
+      end
+
+      def glob(pattern, *flags, &block)
+        @zip_file.glob(expand_to_entry(pattern), *flags, &block)
+      end
+
+      def read(filename)
+        @zip_file.read(expand_to_entry(filename))
+      end
+
+      def remove(filename)
+        @zip_file.remove(expand_to_entry(filename))
+      end
+
+      def rename(filename, new_name, &continue_on_exists_proc)
+        @zip_file.rename(
+          expand_to_entry(filename),
+          expand_to_entry(new_name),
+          &continue_on_exists_proc
+        )
+      end
+
+      def mkdir(filename, permissions = 0o755)
+        @zip_file.mkdir(expand_to_entry(filename), permissions)
+      end
+
+      # Turns entries into strings and adds leading /
+      # and removes trailing slash on directories
+      def each
+        @zip_file.each do |e|
+          yield("/#{e.to_s.chomp('/')}")
+        end
+      end
+
+      def expand_path(path)
+        expanded = path.start_with?('/') ? path.dup : ::File.join(@pwd, path)
+        expanded.gsub!(/\/\.(\/|$)/, '')
+        expanded.gsub!(/[^\/]+\/\.\.(\/|$)/, '')
+        expanded.empty? ? '/' : expanded
+      end
+
+      private
+
+      def expand_to_entry(path)
+        expand_path(path)[1..-1]
+      end
+    end
+  end
+end