archive-zip 0.1.0

data/lib/archive/zip/error.rb

@@ -0,0 +1,22 @@
+module Archive; class Zip;
+  # Archive::Zip::Error is the base class of all archive-related errors raised
+  # by the Archive::Zip library.
+  class Error < StandardError; end
+
+  # Archive::Zip::EntryError is raised when there is an error while processing
+  # ZIP archive entries.
+  class EntryError < Error; end
+
+  # Archive::Zip::ExtraFieldError is raised when there is an error while
+  # processing an extra field in a ZIP archive entry.
+  class ExtraFieldError < Error; end
+
+  # Archive::Zip::IOError is raised in various places where either an IOError is
+  # raised or an operation on an Archive::Zip object is disallowed because of
+  # the state of the object.
+  class IOError < Error; end
+
+  # Archive::Zip::UnzipError is raised when attempting to extract an archive
+  # fails but no more exact error class exists for reporting the error.
+  class UnzipError < Error; end
+end; end

data/lib/archive/zip/extrafield.rb

@@ -0,0 +1,23 @@
+module Archive; class Zip
+  module ExtraField
+    # A Hash used to map extra field header identifiers to extra field classes.
+    EXTRA_FIELDS = {}
+
+    # Returns an instance of an extra field class by selecting the class using
+    # _header_id_ and passing _data_ to the class' _parse_ method.  If there is
+    # no mapping from a given value of _header_id_ to an extra field class, an
+    # instance of Archive::Zip::Entry::ExtraField::Raw is returned.
+    def self.parse(header_id, data)
+      if EXTRA_FIELDS.has_key?(header_id) then
+        EXTRA_FIELDS[header_id].parse(data)
+      else
+        Raw.parse(header_id, data)
+      end
+    end
+  end
+end; end
+
+# Load the standard extra field classes.
+require 'archive/zip/extrafield/extendedtimestamp'
+require 'archive/zip/extrafield/raw'
+require 'archive/zip/extrafield/unix'

data/lib/archive/zip/extrafield/extendedtimestamp.rb

@@ -0,0 +1,101 @@
+require 'archive/zip/error'
+
+module Archive; class Zip; module ExtraField
+  # Archive::Zip::Entry::ExtraField::ExtendedTimestamp represents an extra field
+  # which optionally contains the last modified time, last accessed time, and
+  # file creation time for a ZIP archive entry and stored in a Unix time format
+  # (seconds since the epoc).
+  class ExtendedTimestamp
+    # The identifier reserved for this extra field type.
+    ID = 0x5455
+
+    # Register this extra field for use.
+    EXTRA_FIELDS[ID] = self
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Parses _data_ which is expected to be a String formatted according to the
+    # documentation provided with InfoZip's sources.
+    #
+    # Raises Archive::Zip::ExtraFieldError if _data_ contains invalid data.
+    def self.parse(data)
+      unless data.size == 5 || data.size == 9 || data.size == 13 then
+        raise Zip::ExtraFieldError,
+          "invalid size for extended timestamp: #{data.size}"
+      end
+      flags, *times = data.unpack('C' + 'V' * ((data.size - 1) / 4))
+      mtime = nil
+      atime = nil
+      crtime = nil
+      if flags & 0b001 != 0 then
+        if times.size == 0 then
+          # Report an error if the flags indicate that the last modified time
+          # field should be present when it is not.
+          raise Zip::ExtraFieldError,
+            'corrupt extended timestamp: last modified time field not present'
+        end
+        mtime = Time.at(times.shift)
+      end
+      if flags & 0b010 != 0 then
+        # HACK:
+        # InfoZip does not follow their own documentation for this extra field
+        # when creating one for an entry's central file record.  They flag that
+        # the atime field should be present when it is not.  Ignore the flag in
+        # that case.
+        if times.size > 0 then
+          atime = Time.at(times.shift)
+        end
+      end
+      if flags & 0b100 != 0 then
+        if times.size == 0 then
+          # Report an error if the flags indicate that the file creation time
+          # field should be present when it is not.
+          raise Zip::ExtraFieldError,
+            'corrupt extended timestamp: file creation time field not present'
+        end
+        crtime = Time.at(times.shift)
+      end
+      new(mtime, atime, crtime)
+    end
+
+    # Creates a new instance of this class.  _mtime_, _atime_, and _crtime_
+    # should be Time instances or +nil+.  When set to +nil+ the field is
+    # considered to be unset and will not be stored in the archive.
+    def initialize(mtime, atime, crtime)
+      @mtime = mtime
+      @atime = atime
+      @crtime = crtime
+    end
+
+    # The last modified time for an entry.
+    attr_accessor :mtime
+    # The last accessed time for an entry.
+    attr_accessor :atime
+    # The creation time for an entry.
+    attr_accessor :crtime
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Returns a String suitable to writing to a ZIP archive file which contains
+    # the data for this object.
+    def dump
+      flags = 0
+      times = []
+      unless mtime.nil? then
+        flags |= 0b001
+        times << mtime.to_i
+      end
+      unless atime.nil? then
+        flags |= 0b010
+        times << atime.to_i
+      end
+      unless crtime.nil? then
+        flags |= 0b100
+        times << crtime.to_i
+      end
+      ([ID, 4 * times.size + 1, flags] + times).pack('vvC' + 'V' * times.size)
+    end
+  end
+end; end; end

data/lib/archive/zip/extrafield/raw.rb

@@ -0,0 +1,32 @@
+module Archive; class Zip; module ExtraField
+  # Archive::Zip::Entry::ExtraField::Raw represents an unknown extra field.  It
+  # is used to store extra fields the Archive::Zip library does not directly
+  # support.
+  class Raw
+    # Simply stores _header_id_ and _data_ for later reproduction by #dump.
+    # This is essentially and alias for #new.
+    def self.parse(header_id, data)
+      new(header_id, data)
+    end
+
+    # Simply stores _header_id_ and _data_ for later reproduction by #dump.
+    def initialize(header_id, data)
+      @header_id = header_id
+      @data = data
+    end
+
+    # Returns the header ID for this ExtraField.
+    attr_reader :header_id
+    # Returns the data contained within this ExtraField.
+    attr_reader :data
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Returns a String suitable to writing to a ZIP archive file which contains
+    # the data for this object.
+    def dump
+      [header_id, @data.size].pack('vv') + @data
+    end
+  end
+end; end; end

data/lib/archive/zip/extrafield/unix.rb

@@ -0,0 +1,101 @@
+require 'archive/zip/error'
+
+module Archive; class Zip; module ExtraField
+  # Archive::Zip::Entry::ExtraField::Unix represents an extra field which
+  # contains the last modified time, last accessed time, user name, and group
+  # name for a ZIP archive entry.  Times are in Unix time format (seconds since
+  # the epoc).
+  #
+  # This class also optionally stores either major and minor numbers for devices
+  # or a link target for either hard or soft links.  Which is in use when given
+  # and instance of this class depends upon the external file attributes for the
+  # ZIP archive entry associated with this extra field.
+  class Unix
+    # The identifier reserved for this extra field type.
+    ID = 0x000d
+
+    # Register this extra field for use.
+    EXTRA_FIELDS[ID] = self
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Parses _data_ which is expected to be a String formatted according to the
+    # official ZIP specification.
+    #
+    # Raises Archive::Zip::ExtraFieldError if _data_ contains invalid data.
+    def self.parse(data)
+      unless data.length >= 12 then
+        raise Zip::ExtraFieldError, "invalid size for Unix data: #{data.size}"
+      end
+      atime, mtime, uid, gid, rest = data.unpack('VVvva')
+      new(Time.at(mtime), Time.at(atime), uid, gid, rest)
+    end
+
+    # Creates a new instance of this class.  _mtime_ and _atime_ should be Time
+    # instances.  _uid_ and _gid_ should be user and group names as strings
+    # respectively.  _data_ should be a string containing either major and minor
+    # device numbers consecutively packed as little endian, 4-byte, unsigned
+    # integers (see the _V_ directive of Array#pack) or a path to use as a link
+    # target.
+    def initialize(mtime, atime, uid, gid, data = '')
+      @mtime = mtime
+      @atime = atime
+      @uid = uid
+      @gid = gid
+      @data = data
+    end
+
+    # A Time object representing the last accessed time for an entry.
+    attr_accessor :atime
+    # A Time object representing the last modified time for an entry.
+    attr_accessor :mtime
+    # An integer representing the user ownership for an entry.
+    attr_accessor :uid
+    # An integer representing the group ownership for an entry.
+    attr_accessor :gid
+
+    # Attempts to return a two element array representing the major and minor
+    # device numbers which may be stored in the variable data section of this
+    # object.
+    def device_numbers
+      @data.unpack('VV')
+    end
+
+    # Takes a two element array containing major and minor device numbers and
+    # stores the numbers into the variable data section of this object.
+    def device_numbers=(major_minor)
+      @data = major_minor.pack('VV')
+    end
+
+    # Attempts to return a string representing the path of a file which is
+    # either a symlink or hard link target which may be stored in the variable
+    # data section of this object.
+    def link_target
+      @data
+    end
+
+    # Takes a string containing the path to a file which is either a symlink or
+    # a hardlink target and stores it in the variable data section of this
+    # object.
+    def link_target=(link_target)
+      @data = link_target
+    end
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Returns a String suitable to writing to a ZIP archive file which contains
+    # the data for this object.
+    def dump
+      [
+        ID,
+        12 + @data.size,
+        @atime.to_i,
+        @mtime.to_i,
+        @uid,
+        @gid
+      ].pack('vvVVvv') + @data
+    end
+  end
+end; end; end

data/test/test_archive.rb

@@ -0,0 +1,8 @@
+require 'archive/zip'
+
+FileUtils.rm_f('export.zip')
+FileUtils.rm_rf('extract_test')
+
+Archive::Zip.archive('export.zip', 'test/data/.', :symlinks => false, :ignore_error => true)
+#Archive::Zip.archive('export.zip', 'test/data/.', :symlinks => true, :exclude => lambda { |e| e.file? })
+Archive::Zip.extract('export.zip', 'extract_test', :symlinks => true, :exclude => lambda { |e| e.symlink? })

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: archive-zip
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeremy Bopp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-10 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: io-like
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+description: Archive::Zip provides a simple Ruby-esque interface to creating, extracting, and updating ZIP archives.  This implementation is 100% Ruby and loosely modeled on the archive creation and extraction capabilities of InfoZip's zip and unzip tools.
+email: jeremy at bopp dot net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CONTRIBUTORS
+- HACKING
+- LICENSE
+- GPL
+- LEGAL
+- NEWS
+- README
+files: 
+- lib/archive/support/io-like.rb
+- lib/archive/support/io.rb
+- lib/archive/support/iowindow.rb
+- lib/archive/support/stringio.rb
+- lib/archive/support/time.rb
+- lib/archive/support/zlib.rb
+- lib/archive/zip/codec/deflate.rb
+- lib/archive/zip/codec/store.rb
+- lib/archive/zip/codec.rb
+- lib/archive/zip/datadescriptor.rb
+- lib/archive/zip/entry.rb
+- lib/archive/zip/error.rb
+- lib/archive/zip/extrafield/extendedtimestamp.rb
+- lib/archive/zip/extrafield/raw.rb
+- lib/archive/zip/extrafield/unix.rb
+- lib/archive/zip/extrafield.rb
+- lib/archive/zip.rb
+- test/test_archive.rb
+- CONTRIBUTORS
+- HACKING
+- LICENSE
+- GPL
+- LEGAL
+- NEWS
+- README
+- MANIFEST
+has_rdoc: true
+homepage: http://archive-zip.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- Archive::Zip Documentation
+- --charset
+- utf-8
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.1
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: archive-zip
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple, extensible, pure Ruby ZIP archive support.
+test_files: []
+