archive-zip 0.3.0 → 0.4.0

data/lib/archive/zip/error.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 module Archive; class Zip;
   # Archive::Zip::Error is the base class of all archive-related errors raised
   # by the Archive::Zip library.

data/lib/archive/zip/extra_field.rb

@@ -1,17 +1,31 @@
+# encoding: UTF-8
+
 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)
+    # _header_id_ and passing _data_ to the class' _parse_central_ 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_central(header_id, data)
+      if EXTRA_FIELDS.has_key?(header_id) then
+        EXTRA_FIELDS[header_id].parse_central(data)
+      else
+        Raw.parse_central(header_id, data)
+      end
+    end
+
+    # Returns an instance of an extra field class by selecting the class using
+    # _header_id_ and passing _data_ to the class' _parse_local_ 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_local(header_id, data)
       if EXTRA_FIELDS.has_key?(header_id) then
-        EXTRA_FIELDS[header_id].parse(data)
+        EXTRA_FIELDS[header_id].parse_local(data)
       else
-        Raw.parse(header_id, data)
+        Raw.parse_local(header_id, data)
       end
     end
   end

data/lib/archive/zip/extra_field/extended_timestamp.rb

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'archive/zip/error'
 
 module Archive; class Zip; module ExtraField
@@ -12,90 +14,169 @@ module Archive; class Zip; module ExtraField
     # 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.
+    class << 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 parse_central(data)
+        unless data.size == 5 || data.size == 9 || data.size == 13 then
           raise Zip::ExtraFieldError,
-            'corrupt extended timestamp: last modified time field not present'
+            "invalid size for extended timestamp: #{data.size}"
         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)
+        flags, *times = data.unpack('CV*')
+        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
+          # If parsing the central file record version of this field, this flag
+          # may be set without having the corresponding time value.
+          # Use the time value if available, but ignore it if it's missing.
+          if times.size > 0 then
+            atime = Time.at(times.shift)
+          end
+        end
+        if flags & 0b100 != 0 then
+          # If parsing the central file record version of this field, this flag
+          # may be set without having the corresponding time value.
+          # Use the time value if available, but ignore it if it's missing.
+          if times.size > 0 then
+            crtime = Time.at(times.shift)
+          end
         end
+        new(mtime, atime, crtime)
       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.
+
+      # 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 parse_local(data)
+        unless data.size == 5 || data.size == 9 || data.size == 13 then
           raise Zip::ExtraFieldError,
-            'corrupt extended timestamp: file creation time field not present'
+            "invalid size for extended timestamp: #{data.size}"
+        end
+        flags, *times = data.unpack('CV*')
+        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
+          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 accessed time field not present'
+          end
+          atime = Time.at(times.shift)
+        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
-        crtime = Time.at(times.shift)
+        new(mtime, atime, crtime)
       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
+      @header_id = ID
+      self.mtime = mtime unless mtime.nil?
+      self.atime = atime unless atime.nil?
+      self.crtime = crtime unless crtime.nil?
     end
 
-    # The last modified time for an entry.
+    # Returns the header ID for this ExtraField.
+    attr_reader :header_id
+    # The last modified time for an entry.  Set to either a Time instance or
+    # +nil+.
     attr_accessor :mtime
-    # The last accessed time for an entry.
+    # The last accessed time for an entry.  Set to either a Time instance or
+    # +nil+.
     attr_accessor :atime
-    # The creation time for an entry.
+    # The creation time for an entry.  Set to either a Time instance or +nil+.
     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
+    # Merges the attributes of _other_ into this object and returns +self+.
+    #
+    # Raises ArgumentError if _other_ is not the same class as this object.
+    def merge(other)
+      if self.class != other.class then
+        raise ArgumentError, "#{self.class} is not the same as #{other.class}"
       end
+
+      @mtime = other.mtime unless other.mtime.nil?
+      @atime = other.atime unless other.atime.nil?
+      @crtime = other.crtime unless other.crtime.nil?
+
+      self
+    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 central file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_central
+      times = []
+      times << mtime.to_i unless mtime.nil?
       ([ID, 4 * times.size + 1, flags] + times).pack('vvC' + 'V' * times.size)
     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 local file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_local
+      times = []
+      times << mtime.to_i unless mtime.nil?
+      times << atime.to_i unless atime.nil?
+      times << crtime.to_i unless crtime.nil?
+      ([ID, 4 * times.size + 1, flags] + times).pack('vvC' + 'V' * times.size)
+    end
+
+    private
+
+    def flags
+      flags = 0
+      flags |= 0b001 unless mtime.nil?
+      flags |= 0b010 unless atime.nil?
+      flags |= 0b100 unless crtime.nil?
+      flags
+    end
   end
 end; end; end

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

@@ -1,32 +1,90 @@
+# encoding: UTF-8
+
 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.
+  #
+  # Do not use this class directly.  Define a new class which supports the extra
+  # field of interest directly instead.
   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)
+    class << self
+      # Simply stores _header_id_ and _data_ for later reproduction by
+      # #dump_central.
+      # This is essentially and alias for #new.
+      def parse_central(header_id, data)
+        new(header_id, data, true)
+      end
+
+      # Simply stores _header_id_ and _data_ for later reproduction by
+      # #dump_local.
+      # This is essentially and alias for #new.
+      def parse_local(header_id, data)
+        new(header_id, data, false)
+      end
     end
 
-    # Simply stores _header_id_ and _data_ for later reproduction by #dump.
-    def initialize(header_id, data)
+    # Simply stores _header_id_ and _data_ for later reproduction by
+    # #dump_central or #dump_local.  _central_record_ indicates that this field
+    # resides in the central file record for an entry when +true+.  When
+    # +false+, it indicates that this field resides in the local file record for
+    # an entry.
+    def initialize(header_id, data, central_record)
       @header_id = header_id
-      @data = data
+      @central_record_data = []
+      @local_record_data = []
+      if central_record then
+        @central_record_data << data
+      else
+        @local_record_data << data
+      end
     end
 
     # Returns the header ID for this ExtraField.
     attr_reader :header_id
     # Returns the data contained within this ExtraField.
-    attr_reader :data
+    attr_reader :central_record_data
+    attr_reader :local_record_data
+
+    # This method signature is part of the interface contract expected by
+    # Archive::Zip::Entry for extra field objects.
+    #
+    # Merges the attributes of _other_ into this object and returns +self+.
+    #
+    # Raises ArgumentError if _other_ does not have the same header ID as this
+    # object.
+    def merge(other)
+      if header_id != other.header_id then
+        raise ArgumentError,
+          "Header ID mismatch: #{header_id} != #{other.header_id}"
+      end
+
+      @central_record_data += other.central_record_data
+      @local_record_data += other.local_record_data
+
+      self
+    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 central file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_central
+      @central_record_data.collect do |data|
+        [header_id, data.size].pack('vv') + data
+      end
+    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
-      [header_id, @data.size].pack('vv') + @data
+    # Returns a String suitable to writing to a local file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_local
+      @local_record_data.collect do |data|
+        [header_id, data.size].pack('vv') + data
+      end
     end
   end
 end; end; end

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

@@ -1,3 +1,5 @@
+# encoding: UTF-8
+
 require 'archive/zip/error'
 
 module Archive; class Zip; module ExtraField
@@ -17,28 +19,32 @@ module Archive; class Zip; module ExtraField
     # 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}"
+    class << 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 parse_central(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
-      atime, mtime, uid, gid, rest = data.unpack('VVvva')
-      new(Time.at(mtime), Time.at(atime), uid, gid, rest)
+      alias :parse_local :parse_central
     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
+    # instances.  _uid_ and _gid_ should be user and group IDs as Integers
     # 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 = '')
+      @header_id = ID
       @mtime = mtime
       @atime = atime
       @uid = uid
@@ -46,6 +52,8 @@ module Archive; class Zip; module ExtraField
       @data = data
     end
 
+    # Returns the header ID for this ExtraField.
+    attr_reader :header_id
     # 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.
@@ -85,9 +93,38 @@ module Archive; class Zip; module ExtraField
     # 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
+    # Merges the attributes of _other_ into this object and returns +self+.
+    #
+    # Raises ArgumentError if _other_ is not the same class as this object.
+    def merge(other)
+      if self.class != other.class then
+        raise ArgumentError, "#{self.class} is not the same as #{other.class}"
+      end
+
+      @atime = other.atime
+      @mtime = other.mtime
+      @uid = other.uid
+      @gid = other.gid
+      @data = other.data
+
+      self
+    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 central file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_central
+      ''
+    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 local file record in a ZIP
+    # archive file which contains the data for this object.
+    def dump_local
       [
         ID,
         12 + @data.size,
@@ -97,5 +134,10 @@ module Archive; class Zip; module ExtraField
         @gid
       ].pack('vvVVvv') + @data
     end
+    alias :dump_local :dump_central
+
+    protected
+
+    attr_reader :data
   end
 end; end; end