manageiq-smartstate 0.1.0

data/lib/fs/iso9660/boot_sector.rb

@@ -0,0 +1,170 @@
+require 'fs/iso9660/util'
+
+require 'binary_struct'
+require 'util/miq-unicode'
+
+module Iso9660
+  class BootSector
+    # Universal Volume Descriptor ID.
+    DESCRIPTOR_ID = "CD001"
+
+    # Volume descriptor types.
+    TYPE_BOOT       = 0 # The descriptor is a boot record.
+    TYPE_PRIM_DESC  = 1 # The descriptor is a primary volume descriptor.
+    TYPE_SUPP_DESC  = 2 # The descriptor is a supplementary volume descriptor.
+    TYPE_PART_DESC  = 3 # The descriptor is a volume partition descriptor.
+    TYPE_TERMINATOR = 255 # Marks the end of descriptor records.
+    # NOTE: the spec says terminator is 4, but it seems to be 255.
+
+    # This serves as both the primary and supplementary descriptor structure.
+    VOLUME_DESCRIPTOR = BinaryStruct.new([
+      'C',    'desc_type',                # TYPE_ enum.
+      'a5',   'id',                       # Always "CD001".
+      'C',    'version',                  # Must be 1.
+      'C',    'vol_flags',                # Unused on primary.
+      'a32',  'system_id',                # An 'extra' label.
+      'a32',  'volume_id',                # Usually known as label.
+      'a8',   'unused2',
+      'L',    'vol_space_sizeLE',         # Size in sectors.
+      'L',    'vol_space_sizeBE',
+      'a32',  'esc_sequences',            # Unused on primary, Joliet CDs do not always record escape sequences (assume UCS-2L3).
+      'S',    'vol_set_sizeLE',
+      'S',    'vol_set_sizeBE',
+      'S',    'vol_seq_numberLE',
+      'S',    'vol_seq_numberBE',
+      'S',    'log_block_sizeLE',         # Sector size in bytes (so far, alwyas 2048).
+      'S',    'log_block_sizeBE',
+      'L',    'path_table_sizeLE',        # This implementation ignores the path tables.
+      'L',    'path_table_sizeBE',
+      'S',    'type_1_path_tableLE',
+      'S',    'type_1_path_tableBE',
+      'S',    'opt_type_1_path_tableLE',
+      'S',    'opt_type_1_path_tableBE',
+      'S',    'type_m_path_tableLE',
+      'S',    'type_m_path_tableBE',
+      'S',    'opt_type_m_path_tableLE',
+      'S',    'opt_type_m_path_tableBE',
+      'a34',  'root_dir_record',          # DirectoryEntry representing root dir.
+      'a128', 'vol_set_id',
+      'a128', 'publisher_id',
+      'a128', 'preparer_id',
+      'a128', 'application_id',
+      'a37',  'copyright_file_id',
+      'a37',  'abstract_file_id',
+      'a37',  'biblographic_file_id',
+      'a17',  'creation_date',            # Dates are in ISO long date format.
+      'a17',  'modification_date',
+      'a17',  'experation_date',
+      'a17',  'effective_date',
+      'C',    'file_structure_version',   # Must be 1.
+      'C',    'unused4',
+      'a512', 'application_data',
+      'a653', 'unused5'
+    ])
+    SIZEOF_VOLUME_DESCRIPTOR = VOLUME_DESCRIPTOR.size
+
+    attr_reader :sectorSize, :descType, :fsId, :volName
+    attr_reader :cTime, :mTime, :expirationDate, :effectiveDate
+    attr_reader :rootEntry, :recId, :suff
+
+    def initialize(stream, joliet = false)
+      raise "Nil stream" if stream.nil?
+      @stream = stream
+      @isJoliet = joliet
+      @jolietVerified = false
+
+      # Get the suffix to use for all members.
+      @suff = getSuffix
+
+      # Read & check descriptor.
+      @bs = VOLUME_DESCRIPTOR.decode(@stream.read(SIZEOF_VOLUME_DESCRIPTOR))
+      @descType = @bs['desc_type']
+      raise "Descriptor type mismatch (type is #{@descType})" if @descType != (@isJoliet ? TYPE_SUPP_DESC : TYPE_PRIM_DESC)
+      @recId = @bs['id']
+      raise "Descriptor ID mismatch" if @recId != "CD001"
+      raise "Descriptor version mismatch" if @bs['version'] != 1
+      raise "File structure version mismatch" if @bs['file_structure_version'] != 1
+
+      # If this is supposed to be Joliet then try to verify.
+      if @isJoliet
+        esc = @bs['esc_sequences'].strip
+        if esc[0, 2] == '%/'
+          level = esc[2, 1]
+          @jolietVerified = true if level == '@' || level == 'C' || level == 'E'
+        end
+      end
+      # From now on, assume Joliet if @isJoliet is true.
+      # If verification fails it's up to Directory & DirectoryEntry to be careful.
+
+      # Read fs params.
+      @sectorSize = @bs["log_block_size#{@suff}"]
+      @volName = @bs['volume_id']
+      @volName.Ucs2ToAscii! if @isJoliet
+      # fsId can come from Rock Ridge ext if present.
+      # Don't forget there's a serial number too if RR isn't there.
+      @cTime = Util.IsoToRubyDate(@bs['creation_date'])
+      @mTime = Util.IsoToRubyDate(@bs['modification_date'])
+      @expirationDate = Util.IsoToRubyDate(@bs['expiration_date'])
+      @effectiveDate = Util.IsoToRubyDate(@bs['effective_date'])
+
+      # Filesystem root.
+      @rootEntry = @bs['root_dir_record']
+    end
+
+    def diskSize
+      @bs["vol_space_size#{@suff}"] * @sectorSize
+    end
+
+    def getSectors(sector, num = 1)
+      @stream.seek(sector * @sectorSize)
+      @stream.read(@sectorSize * num)
+    end
+
+    def isJoliet?
+      @isJoliet
+    end
+
+    def getSuffix
+      if Sys::Platform::ARCH == :x86
+        @@suff = 'LE'
+      else
+        # Other architectures are bi-endian and must be determined at run time.
+        p = [0xaa, 0x55].pack('N')
+        u = p.unpack('L')
+        @@suff = u == 0xaa55 ? 'BE' : 'LE'
+      end
+    end
+
+    # This is a raw dump with no character set conversion.
+    def dump
+      out = "\n"
+      out += "Type            : #{@bs['desc_type']}\n"
+      out += "Record ID       : #{@bs['id']}\n"
+      out += "Version         : #{@bs['version']}\n"
+      out += "System ID       : #{@bs['system_id'].strip}\n"
+      out += "Volume ID       : #{@volName}\n"
+      out += "Vol space size  : #{@bs["vol_space_size#{@suff}"]} (sectors)\n"
+      out += "Vol set size    : #{@bs["vol_set_size#{@suff}"]}\n"
+      out += "Vol sequence num: #{@bs["vol_seq_number#{@suff}"]}\n"
+      out += "Logical blk size: #{@bs["log_block_size#{@suff}"]} (sector size)\n"
+      out += "Path table size : #{@bs["path_table_size#{@suff}"]}\n"
+      out += "Type 1 path tbl : #{@bs["type_1_path_table#{@suff}"]}\n"
+      out += "Opt type 1 pth  : #{@bs["opt_type_1_path_table#{@suff}"]}\n"
+      out += "Type M path tbl : #{@bs["type_m_path_table#{@suff}"]}\n"
+      out += "Opt type M pth  : #{@bs["opt_type_m_path_table#{@suff}"]}\n"
+      out += "Vol set ID      : #{@bs['vol_set_id'].strip}\n"
+      out += "Publisher ID    : #{@bs['publisher_id'].strip}\n"
+      out += "Preparer ID     : #{@bs['preparer_id'].strip}\n"
+      out += "Application ID  : #{@bs['application_id'].strip}\n"
+      out += "Copyright       : #{@bs['copyright_file_id'].strip}\n"
+      out += "Abstract        : #{@bs['abstract_file_id'].strip}\n"
+      out += "Biblographic    : #{@bs['biblographic_file_id'].strip}\n"
+      out += "Creation date   : #{@bs['creation_date'].strip} (#{@cTime}, tz = #{Util.GetTimezone(@bs['creation_date'])})\n"
+      out += "Mod date        : #{@bs['modification_date'].strip} (#{@mTime}, tz = #{Util.GetTimezone(@bs['modification_date'])})\n"
+      out += "Expiration date : #{@bs['experation_date'].strip} (#{@expirationDate}, tz = #{Util.GetTimezone(@bs['experation_date'])})\n"
+      out += "Effective date  : #{@bs['effective_date'].strip} (#{@effectiveDate}, tz = #{Util.GetTimezone(@bs['effective_date'])})\n"
+      out += "File strct ver  : #{@bs['file_structure_version']}\n"
+      out += "Application data: #{@bs['application_data'].strip}\n"
+    end
+  end # class
+end # module

data/lib/fs/iso9660/directory.rb

@@ -0,0 +1,90 @@
+require 'fs/iso9660/directory_entry'
+require 'binary_struct'
+
+module Iso9660
+  class Directory
+    # Find entry flags.
+    FE_DIR = 0
+    FE_FILE = 1
+    FE_EITHER = 2
+
+    # System Use Sharing Protocol header (for Rock Ridge in this implementation).
+    SUSP = BinaryStruct.new([
+      'a2', 'signature',
+      'C',  'len',
+      'C',  'version',
+      'n',  'check',
+      'C',  'skip_bytes'
+    ])
+    SUSP_SIGNATURE  = "SP"
+    SUSP_SIZE       = 7
+    SUSP_VERSION    = 1
+    SUSP_CHECK_WORD = 0xbeef
+
+    attr_reader :myEnt, :susp
+
+    def initialize(bs, thisEntry)
+      raise "Boot sector is nil." if bs.nil?
+      raise "No directory entry specified." if thisEntry.nil?
+      raise "Given entry is not a DirectoryEntry" if thisEntry.class.to_s != "Iso9660::DirectoryEntry"
+
+      @bs = bs
+      @myEnt = thisEntry
+      @data = getDirData
+
+      # Check for RockRidge extensions.
+      @susp = checkRockRidge(DirectoryEntry.new(@data, @bs.suff))
+    end
+
+    def getDirData
+      @bs.getSectors(@myEnt.fileStart, @myEnt.fileSize / @bs.sectorSize)
+    end
+
+    def globNames
+      names = []
+      globEntries.each { |de| names << de.name }
+      names
+    end
+
+    def findEntry(name, _flags = FE_EITHER)
+      # TODO: enable flags
+      globEntries.each do |de|
+        return de if de.name == name        # Joliet & RR are case sensitive.
+        return de if de.name == name.upcase # ISO 9660 is ucase only.
+      end
+      nil
+    end
+
+    def globEntries
+      # Prep flag bits.
+      flags = EXT_NONE
+      flags |= EXT_JOLIET if @bs.isJoliet?
+      flags |= EXT_ROCKRIDGE if @susp
+
+      # Glob entries.
+      entries = []
+      offset = 0
+      loop do
+        de = DirectoryEntry.new(@data[offset..-1], @bs.suff, flags)
+        break if de.length == 0
+        entries << de
+        # Debugging only.
+        # puts "#{de.dump}\n"
+        offset += de.length
+      end
+      entries
+    end
+
+    def checkRockRidge(de)
+      if de.sua
+        susp = SUSP.decode(de.sua)
+        return nil if susp['signature'] != SUSP_SIGNATURE
+        return nil if susp['len'] != SUSP_SIZE
+        return nil if susp['check'] != SUSP_CHECK_WORD
+        raise "System Use Sharing Protocol version mismatch" if susp['version'] != SUSP_VERSION
+        return susp
+      end
+      nil
+    end
+  end # class
+end # module

data/lib/fs/iso9660/directory_entry.rb

@@ -0,0 +1,147 @@
+require 'fs/iso9660/util'
+require 'fs/iso9660/rock_ridge'
+
+require 'binary_struct'
+require 'util/miq-unicode'
+
+module Iso9660
+  # FlagBits: FB_
+  FB_HIDDEN     = 0x01  # 0 if not hidden.
+  FB_DIRECTORY  = 0x02  # 0 if file.
+  FB_ASSOCIATED = 0x04  # 0 if not 'associated' (?)
+  FB_RFS        = 0x08  # RecordFormatSpecified: 0 if not.
+  FB_PS         = 0x10  # PermissionsSpecified: 0 if not.
+  FB_UNUSED1    = 0x20  # No info.
+  FB_UNUSED2    = 0x40  # No info.
+  FB_NOT_LAST   = 0x80  # 0 if last entry.
+
+  # Extensions.
+  EXT_NONE      = 0
+  EXT_JOLIET    = 1
+  EXT_ROCKRIDGE = 2
+
+  class DirectoryEntry
+    DIR_ENT = BinaryStruct.new([
+      'C',  'length',           # Bytes, must be even.
+      'C',  'ext_attr_length',  # Sectors.
+      'L',  'extentLE',         # First sector of data.
+      'L',  'extentBE',
+      'L',  'sizeLE',           # Size of data in bytes.
+      'L',  'sizeBE',
+      'a7', 'date',             # ISODATE
+      'C',  'flags',            # Flags, see FB_ above.
+      'C',  'file_unit_size',   # For interleaved files: not supported.
+      'C',  'interleave',       # Not supported.
+      'S',  'vol_seq_numLE',    # Not used.
+      'S',  'vol_seq_numBE',
+      'C',  'name_len',         # Bytes.
+    ])
+    # Here follows a name. Character set is limited ASCII.
+    # Here follows an optional padding byte (if name_len is even).
+    # Here follows unspecified extra data, size is included in member length.
+    SIZEOF_DIR_ENT = DIR_ENT.size
+
+    attr_reader :date, :length, :myEnt
+
+    def initialize(data, suff, flags = EXT_NONE)
+      raise "Data is nil." if data.nil?
+
+      @suff = suff
+      # Get data.
+      @de = DIR_ENT.decode(data)
+      @length = @de['length']
+      @myEnt = data[0...@length]
+      @date = Util.IsoShortToRubyDate(@de['date'])
+      offset = SIZEOF_DIR_ENT
+      len = @de['name_len']
+      if len > 0
+        name = data[offset...(offset + len)]
+        # Convert 00 to dot and 01 to dotdot.
+        if len == 1 && (name[0] == 0 || name[0] == 1)
+          name = "." if name[0] == 0
+          name = ".." if name[0] == 1
+        else
+          name.Ucs2ToAscii! if flags & EXT_JOLIET == EXT_JOLIET
+        end
+        offset += len
+        offset += 1 if len & 1 == 0 && (flags & EXT_JOLIET == 0) # Cheap test for even/odd.
+      end
+      @de['name'] = name
+      @de['sua'] = data[offset...@de['length'] - 1] if offset < @de['length']
+      processRockRidge if flags & EXT_ROCKRIDGE == EXT_ROCKRIDGE
+    end
+
+    def name
+      @de['name']
+    end
+
+    def sua
+      @de['sua']
+    end
+
+    def fileStart
+      @de["extent#{@suff}"]
+    end
+
+    def fileSize
+      return @de["size#{@suff}"] if @rr.nil?
+      size = checkExt("linkData")
+      return size.size unless size.nil?
+      @de["size#{@suff}"]
+    end
+
+    def isFile?
+      @de['flags'] & FB_DIRECTORY == 0
+    end
+
+    def isDir?
+      @de['flags'] & FB_DIRECTORY == FB_DIRECTORY
+    end
+
+    def isSymLink?
+      return false if @rr.nil?
+      isLink = checkExt("linkData")
+      return true unless isLink.nil?
+      false
+    end
+
+    def checkExt(sym)
+      return nil if @rr.nil?
+      res = nil
+      @rr.extensions.each do |extension|
+        ext = extension.ext
+        begin
+          res = ext.send(sym)
+        rescue
+          break unless res.nil?
+        end
+      end
+      res
+    end
+
+    def processRockRidge
+      return if length == 0
+      @rr = RockRidge.new(self)
+      # Check for alternate name.
+      new_name = checkExt("name")
+      @de['name'] = new_name unless new_name.nil?
+    end
+
+    def dump
+      out = ""
+      out << "Length  : #{@de['length']}\n"
+      out << "Attr len: #{@de['ext_attr_length']} (sectors)\n"
+      out << "Data sec: #{@de["extent#{@suff}"]}\n"
+      out << "Size    : #{@de["size#{@suff}"]}\n"
+      out << "Date    : #{@date}\n"
+      out << "Flags   : 0x#{'%02x' % @de['flags']}\n"
+      out << "Name len: #{@de['name_len']}\n"
+      out << "Name    : #{@de['name']}\n"
+      if @de['sua']
+        out << "System U:\n"
+        out << @de['sua'].hex_dump
+      end
+      out
+    end
+  end # class
+end # module

data/lib/fs/iso9660/file_data.rb

@@ -0,0 +1,78 @@
+require 'memory_buffer'
+
+module Iso9660
+  class FileData
+    attr_reader :pos
+
+    # Initialization
+    def initialize(dirEntry, bootSector)
+      raise "Nil directory entry" if dirEntry.nil?
+      raise "Nil boot sector" if bootSector.nil?
+
+      @bs = bootSector
+      @de = dirEntry
+      @last_sect = @de.fileSize.divmod(@bs.sectorSize)
+      @last_sect[0] += 1 if @last_sect[1] > 0
+      @last_sect = @last_sect[0]
+      rewind
+    end
+
+    def rewind
+      @pos = 0
+    end
+
+    def seek(offset, method = IO::SEEK_SET)
+      @pos = case method
+             when IO::SEEK_SET then offset
+             when IO::SEEK_CUR then @pos + offset
+             when IO::SEEK_END then @de.length - offset
+             end
+      @pos = 0 if @pos < 0
+      @pos = @de.fileSize if @pos > @de.fileSize
+      @pos
+    end
+
+    def read(bytes = @de.fileSize)
+      return nil if @pos >= @de.fileSize
+      bytes = @de.fileSize - @pos if @pos + bytes > @de.fileSize
+
+      # Get start & end locs.
+      ss = @bs.sectorSize
+      startSector, startOffset = @pos.divmod(ss)
+      endSector, endOffset = (@pos + (bytes - 1)).divmod(ss)
+
+      # Single sector.
+      if startSector == endSector
+        @pos += (endOffset - startOffset)
+        return getSector(startSector)[startOffset..endOffset]
+      end
+
+      # Span sectors.
+      out = MemoryBuffer.create(bytes)
+      totalLen = 0
+      (startSector..endSector).each do |sect|
+        offset = 0; len = ss
+        if sect == startSector
+          offset = startOffset
+          len -= offset
+        end
+        len -= (ss - (endOffset + 1)) if sect == endSector
+        out[totalLen, len] = getSector(sect)[offset, len]
+        totalLen += len
+        @pos += len
+      end
+      out[0..totalLen]
+    end
+
+    def getSector(vsn)
+      lsn = getLSN(vsn)
+      raise "No logical sector for virtual sector #{vsn}." if lsn == -1
+      @bs.getSectors(lsn, 1)
+    end
+
+    def getLSN(vsn)
+      return -1 if vsn > @last_sect
+      @de.fileStart + vsn
+    end
+  end
+end # module Iso9660