omnizip 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fb48a1e9cf9e94fbe0c406af0fde7ec27db02f5df14791c017e95494178ae9a
-  data.tar.gz: b14fb70164a7e0727f99bb68ad15c6a203ed4ba4398b4f25f0d01198528f4409
+  metadata.gz: 6f138ecaafda0455b4a5d3abce1ce426dcbfc2fd851bcdf0e0b0892a9b9b4287
+  data.tar.gz: 1f94b97bd5e7b102abb907170d393edf4b192059c6aa5862d81b5b48ee354466
 SHA512:
-  metadata.gz: 5d4b645f7a4145c45b84ac9e4fb8b80047ac0d4467803506bdef910a8f9627db1d790de98d001189126f46d5e89cc2e408b9bb72c0c221233815f303b5119daa
-  data.tar.gz: 6cd81ea56d60d3955c86018d7e746cbe78807f3667139f4f577dde28763f62ab43102ed09e4ff095f6eb5448e1f09d51c85efe366f3ce48a3ec0ea0432fb8ef9
+  metadata.gz: 946e0c8adee99dde0acbf309a1ca30765459f15d543775f1964ca603eee24bd1628582797aa7567ed367c46d0f6adf03f56541071e83dfe0ca91f476289f0166
+  data.tar.gz: 3e9760f59d981bd97976099dd46eae135ad569a1259d37205a51b4e8a081379ff3f53c08d262a680a131619ca16dd8cdeb27aec89e381e1347d4c2436ac24a62

data/README.adoc

@@ -367,6 +367,100 @@ All libarchive XAR test cases pass, including:
 * ✅ Extended attributes
 * ✅ Various checksum algorithms
 
+==== RPM Format Support (v0.4.0)
+
+Omnizip provides complete RPM package format support for reading package metadata and extracting file contents.
+
+**Status**: ✅ **Full Support** - Complete RPM reading and extraction
+
+**What Works**:
+
+* ✅ RPM lead parsing (magic, version, name, architecture)
+* ✅ Header parsing with tag extraction (NAME, VERSION, RELEASE, etc.)
+* ✅ File list extraction (basenames, directories, permissions)
+* ✅ Dependency information (requires, provides, conflicts)
+* ✅ Payload extraction with multiple compression formats
+* ✅ gzip, bzip2, xz, zstd decompression support
+
+**Usage**:
+
+[source,ruby]
+----
+require 'omnizip'
+
+# Read RPM package metadata
+Omnizip::Formats::Rpm.open('package.rpm') do |rpm|
+  puts "Name: #{rpm.name}"
+  puts "Version: #{rpm.version}"
+  puts "Release: #{rpm.release}"
+  puts "Architecture: #{rpm.architecture}"
+  puts "Files: #{rpm.files.count}"
+end
+
+# Extract RPM contents
+Omnizip::Formats::Rpm.extract('package.rpm', 'output/')
+
+# List files in RPM
+files = Omnizip::Formats::Rpm.list('package.rpm')
+files.each { |f| puts f }
+
+# Get package information
+info = Omnizip::Formats::Rpm.info('package.rpm')
+puts "#{info[:name]}-#{info[:version]}-#{info[:release]}"
+----
+
+**Architecture**:
+
+* `Formats::Rpm::Reader` - Public API for reading RPM packages
+* `Formats::Rpm::Lead` - 96-byte lead parser
+* `Formats::Rpm::Header` - Header structure with tag extraction
+* `Formats::Rpm::Entry` - File entry model
+
+==== OLE Format Support (v0.4.0)
+
+Omnizip provides complete OLE (Object Linking and Embedding) compound document format support for reading Microsoft compound files.
+
+**Status**: ✅ **Full Support** - Complete OLE reading
+
+**What Works**:
+
+* ✅ OLE compound document header parsing
+* ✅ Block allocation tables (BAT, SBAT, XBAT)
+* ✅ Directory entry navigation
+* ✅ File stream extraction
+* ✅ Support for .doc, .xls, .ppt, .msi files
+* ✅ Property set storage
+
+**Usage**:
+
+[source,ruby]
+----
+require 'omnizip'
+
+# Open OLE compound document
+Omnizip::Formats::Ole.open('document.doc') do |ole|
+  # List all streams in the document
+  ole.each_entry do |entry|
+    puts "#{entry.name} (#{entry.size} bytes)"
+  end
+
+  # Read a specific stream
+  data = ole.read_stream('WordDocument')
+end
+
+# Extract all streams
+Omnizip::Formats::Ole.extract('document.doc', 'output/')
+----
+
+**Architecture**:
+
+* `Formats::Ole::Storage` - Core storage implementation
+* `Formats::Ole::Header` - 512-byte header parser
+* `Formats::Ole::AllocationTable` - BAT/SBAT management
+* `Formats::Ole::Dirent` - 128-byte directory entry
+* `Formats::Ole::RangesIO` - Range-based IO wrapper
+* `Formats::Ole::Types` - Type serialization (Variant, Lpstr, FileTime, etc.)
+
 === Preprocessing Filters
 
 * **BCJ Filters** - Branch-Call-Jump filters for executables (x86, ARM, ARM64, PPC, SPARC, IA-64)
@@ -383,8 +477,10 @@ See link:readme-docs/preprocessing-filters.adoc[Preprocessing Filters Guide] for
 * **RAR5** - Full read/write support with STORE and LZMA compression, multi-volume, solid archives (v0.3.0)
 * **TAR** - Full read/write with POSIX extensions
 * **ISO 9660** - Full read/write with Rock Ridge/Joliet
-* **CPIO** - Full read/write (newc, CRC formats)
+* **CPIO** - Full read/write (newc, CRC formats) with RPM payload support (v0.4.0)
+* **RPM** - Full read support with metadata extraction, gzip/bzip2/xz/zstd payload decompression (v0.4.0)
 * **XAR** - Full read/write with XML TOC, gzip/bzip2/lzma compression (v0.4.0)
+* **OLE** - Full read support for Microsoft compound documents (.doc, .xls, .ppt, .msi) (v0.4.0)
 * **GZIP/XZ/BZIP2** - Single file compression formats
 
 See link:readme-docs/archive-formats.adoc[Archive Formats Documentation] for complete details.
@@ -420,11 +516,12 @@ See link:readme-docs/advanced-features.adoc[Advanced Features Guide] for details
 
 Omnizip maintains comprehensive test coverage:
 
-* **Total Tests**: 3400+ examples
+* **Total Tests**: 3540+ examples
 * **Pass Rate**: 100% (0 failures, 0 pending)
 * **Coverage**: All compression algorithms, archive formats, and features
 * **Integration**: Full round-trip verification for all formats
 * **Reference Tests**: libarchive RAR4/RAR5 compatibility verified (103 test files)
+* **New Formats**: RPM (21 tests), CPIO (25 tests), OLE (36 tests), XAR (17 tests)
 
 == Quick Start
 

data/docs/guides/archive-formats/index.adoc

@@ -7,7 +7,7 @@ has_children: true
 
 == Archive Formats Overview
 
-Omnizip supports 10 archive formats for different use cases. Each format has unique features, compression options, and compatibility characteristics.
+Omnizip supports 12 archive formats for different use cases. Each format has unique features, compression options, and compatibility characteristics.
 
 == Format Comparison
 
@@ -44,6 +44,16 @@ Omnizip supports 10 archive formats for different use cases. Each format has uni
 |LZMA2
 |None
 |System package compression
+
+|link:rpm-format.html[RPM]
+|gzip, bzip2, xz, zstd
+|GPG signatures
+|Linux package management
+
+|link:ole-format.html[OLE]
+|None (internal structure)
+|Document-specific
+|Windows compound files, MSI
 |===
 
 == Choosing a Format
@@ -71,6 +81,12 @@ Omnizip supports 10 archive formats for different use cases. Each format has uni
 
 |Software packages
 |7z or TAR.XZ
+
+|Linux package management
+|RPM
+
+|Windows compound documents
+|OLE (MSI, DOC, XLS, PPT)
 |===
 
 === By Compatibility
@@ -123,6 +139,20 @@ Omnizip supports 10 archive formats for different use cases. Each format has uni
 * **POSIX**: Full support
 * **Unix Standard**: Yes
 
+=== RPM Format
+
+* **Compression**: gzip, bzip2, xz, zstd (payload)
+* **Encryption**: GPG signatures
+* **Payload**: CPIO archive
+* **Metadata**: Rich package information
+
+=== OLE Format
+
+* **Structure**: FAT-like file system
+* **Streams**: Multiple streams and sub-storages
+* **Types**: MSI, DOC, XLS, PPT, MSG
+* **Metadata**: Summary information streams
+
 == See Also
 
 * link:../compression-algorithms/[Compression Algorithms] - Choose the right compression

data/docs/guides/archive-formats/ole-format.adoc

@@ -0,0 +1,316 @@
+---
+title: OLE Format
+nav_order: 10
+parent: Archive Formats
+grand_parent: Guides
+---
+
+[[ole-format]]
+== Purpose
+
+OLE (Object Linking and Embedding) Compound Document format is used by Microsoft for storing structured data in a single file. Common OLE files include:
+- MSI (Windows Installer packages)
+- DOC (legacy Word documents)
+- XLS (legacy Excel spreadsheets)
+- PPT (legacy PowerPoint presentations)
+- THM (Microsoft Theme files)
+- MSG (Outlook messages)
+
+OLE uses a FAT-like file system within a single file, supporting up to 4GB of structured data.
+
+== Key Characteristics
+
+[cols="1,3"]
+|===
+|Property |Value
+
+|Max Size
+|2GB (standard), 4GB (with 4KB sectors)
+
+|Sector Sizes
+|512 bytes (standard), 4KB (large)
+
+|Streams
+|Multiple streams and sub-storages
+
+|Encryption
+|Optional (document-specific)
+
+|Best For
+|Windows compound files, legacy Office documents, MSI installers
+|===
+
+== Basic Usage
+
+=== Open an OLE File
+
+[source,ruby]
+----
+# Open OLE compound document
+ole = Omnizip::Ole.open('document.doc')
+
+# Access root storage
+root = ole.root
+puts "Root storage: #{root.name}"
+
+# List streams and storages
+root.each do |entry|
+  puts "#{entry.name} (#{entry.size} bytes)" if entry.file?
+  puts "#{entry.name}/" if entry.directory?
+end
+
+ole.close
+----
+
+=== Read Stream Data
+
+[source,ruby]
+----
+# Read a specific stream
+ole = Omnizip::Ole.open('document.doc')
+
+# Access \x01SummaryInformation stream (document metadata)
+summary = ole.open_stream("\x01SummaryInformation")
+if summary
+  data = summary.read
+  puts "Summary size: #{data.size} bytes"
+end
+
+# Access WordDocument stream (main content)
+word_stream = ole.open_stream("WordDocument")
+if word_stream
+  content = word_stream.read
+  puts "Document content size: #{content.size} bytes"
+end
+
+ole.close
+----
+
+=== Extract All Files
+
+[source,ruby]
+----
+# Extract all streams from OLE to files
+Omnizip::Ole.open('document.doc') do |ole|
+  ole.extract_to('/output/directory/')
+end
+
+# Extract specific stream
+Omnizip::Ole.open('spreadsheet.xls') do |ole|
+  workbook = ole.open_stream('Workbook')
+  File.binwrite('workbook.bin', workbook.read)
+end
+----
+
+== MSI Package Inspection
+
+MSI files are OLE compound documents containing Windows Installer data:
+
+[source,ruby]
+----
+# Open MSI package
+msi = Omnizip::Ole.open('installer.msi')
+
+# List MSI tables (storages)
+tables = msi.root.select { |e| e.directory? }
+puts "MSI Tables:"
+tables.each { |t| puts "  #{t.name}" }
+
+# Access \x05SummaryInformation
+summary = msi.open_stream("\x05SummaryInformation")
+if summary
+  puts "Summary information found"
+end
+
+# Access _Tables stream (list of all tables)
+tables_stream = msi.open_stream("_Tables")
+if tables_stream
+  puts "Tables stream size: #{tables_stream.size}"
+end
+
+msi.close
+----
+
+== Storage Structure
+
+OLE files have a hierarchical structure like a file system:
+
+[source]
+----
+Root Storage/
+├── \x01SummaryInformation     (document metadata)
+├── \x01DocumentSummaryInformation
+├── WordDocument              (main content)
+├── 1Table                    (data tables)
+├── Data/
+│   ├── Mso1Table
+│   └── Mso0Table
+└── ObjectPool/
+    └── _1000000000/
+        └── Ole10Native
+----
+
+[source,ruby]
+----
+# Navigate storage hierarchy
+ole = Omnizip::Ole.open('document.doc')
+
+# Access nested storage
+pool = ole.root.find("ObjectPool")
+if pool
+  pool.each do |entry|
+    puts "ObjectPool/#{entry.name}"
+  end
+end
+
+ole.close
+----
+
+== Summary Information
+
+OLE documents contain standard metadata streams:
+
+[source,ruby]
+----
+# Read summary information
+ole = Omnizip::Ole.open('document.doc')
+
+# Access summary stream
+summary_stream = ole.open_stream("\x01SummaryInformation")
+if summary_stream
+  # Summary information is in a specific binary format
+  # Omnizip provides helpers to decode it
+  summary = ole.summary_information
+  if summary
+    puts "Title: #{summary.title}"
+    puts "Author: #{summary.author}"
+    puts "Subject: #{summary.subject}"
+    puts "Keywords: #{summary.keywords}"
+    puts "Created: #{summary.create_time}"
+    puts "Modified: #{summary.last_save_time}"
+  end
+end
+
+ole.close
+----
+
+== File Format Detection
+
+OLE files can be identified by their signature:
+
+[source,ruby]
+----
+# Check if file is OLE
+File.open('document.doc', 'rb') do |f|
+  header = f.read(8)
+  if Omnizip::Ole.ole_signature?(header)
+    puts "This is an OLE compound document"
+  end
+end
+
+# Get OLE file type
+ole = Omnizip::Ole.open('document.doc')
+case ole.file_type
+when :word_document
+  puts "Microsoft Word document"
+when :excel_spreadsheet
+  puts "Microsoft Excel spreadsheet"
+when :powerpoint
+  puts "Microsoft PowerPoint presentation"
+when :msi_package
+  puts "Windows Installer package"
+else
+  puts "Unknown OLE type: #{ole.file_type}"
+end
+ole.close
+----
+
+== Supported File Types
+
+Omnizip supports reading the following OLE-based formats:
+
+[cols="2,1,1"]
+|===
+|Format |Extension |Read Support
+
+|Microsoft Word
+|.doc
+|Yes
+
+|Microsoft Excel
+|.xls
+|Yes
+
+|Microsoft PowerPoint
+|.ppt
+|Yes
+
+|Windows Installer
+|.msi
+|Yes
+
+|Microsoft Theme
+|.thm
+|Yes
+
+|Outlook Message
+|.msg
+|Yes
+
+|Generic OLE
+|.ole
+|Yes
+|===
+
+== Low-Level Access
+
+For advanced use cases, you can access the OLE internals directly:
+
+[source,ruby]
+----
+# Access BAT (Block Allocation Table)
+ole = Omnizip::Ole.open('document.doc')
+
+# Get sector size
+puts "Sector size: #{ole.sector_size}"
+
+# Access BAT entries
+bat = ole.bat
+puts "BAT entries: #{bat.size}"
+
+# Access SBAT (Small Block Allocation Table)
+sbat = ole.sbat
+puts "SBAT entries: #{sbat.size}" if sbat
+
+# Access directory entries
+ole.root.each do |entry|
+  puts "#{entry.name}: starting_sector=#{entry.starting_sector}, size=#{entry.size}"
+end
+
+ole.close
+----
+
+== Performance Considerations
+
+OLE files can be large. For efficient reading:
+
+[source,ruby]
+----
+# Stream read large OLE files efficiently
+Omnizip::Ole.open('large.msi') do |ole|
+  # Only read streams you need
+  summary = ole.open_stream("\x05SummaryInformation")
+  if summary
+    # Read in chunks for large streams
+    chunk_size = 65536
+    while chunk = summary.read(chunk_size)
+      process(chunk)
+    end
+  end
+end
+----
+
+== See Also
+
+* link:seven-zip-format.html[7z Format] - Can contain OLE files
+* link:zip-format.html[ZIP Format] - Modern Office uses ZIP (docx, xlsx, pptx)