pakspy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b396c939066b3794ad12095be2c3008c7c0c20b2b134c4d75a5dbf94d1775e94
+  data.tar.gz: 963338f9731f59c1a7f0ea51ebb716dbaf2d189084c6463556c9a58ea753bb37
+SHA512:
+  metadata.gz: d49070223f57749f0550e1ea83e6766614de10cc604bcc0bb7b8611ea83f1c1f09fd050d4f0b2891adc28b993cad89efaeffb070d785109fd92498c4cad34553
+  data.tar.gz: 29bd18461565800c335a6711bc28bf3a3f5861abce20436e87884b5c3a440117994274217089a9e9c0e46ad8c057c9f05d6e6a2674e48af11d2759627ed5e70d

data/bin/pakspy

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+require 'pakspy'
+
+def print_usage
+  puts "Usage:"
+  puts "pakspy list <pak>"
+  puts "       Lists contents of a PAK file"
+  puts "pakspy dump <pak> <directory-to>"
+  puts "       Extracts a PAK file to a directory"
+  puts "pakspy extract <pak> <file-in-pak> <file-on-fs>"
+  puts "       Extracts a single file from PAK to file system"
+  puts "pakspy create <pak> <directory-from>"
+  puts "       Creates a PAK from a directory"
+  puts "pakspy insert <pak> <file-on-fs> <file-in-pak>"
+  puts "       Inserts a file in existing PAK"
+end
+
+if ARGV.length > 1
+  command, *arguments = ARGV
+
+  case command
+  when "list"
+    if arguments.length == 1
+      pak = PAKFile.new arguments[0]
+      pak.list.each do |name|
+        puts name
+      end
+    else
+      print_usage
+    end
+  when "dump"
+    if arguments.length == 2
+      pak = PAKFile.new arguments[0]
+      pak.extract_all arguments[1]
+    else
+      print_usage
+    end
+  when "extract"
+    if arguments.length == 3
+      pak = PAKFile.new arguments[0]
+      pak.extract arguments[1], arguments[2]
+    else
+      print_usage
+    end
+  when "create"
+    if arguments.length == 2
+      pak = PAKFile.new
+      pak.insert_all arguments[1]
+      pak.save arguments[0]
+    else
+      print_usage
+    end
+  when "insert"
+    if arguments.length == 3
+      pak = PAKFile.new arguments[0]
+      pak.insert arguments[1], arguments[2]
+      pak.save arguments[0]
+    else
+      print_usage
+    end
+  else
+    print_usage
+  end
+else
+  print_usage
+end

data/lib/pakspy.rb

@@ -0,0 +1,230 @@
+##
+# Class handles Quake style PAK files
+class PAKFile
+  ##
+  # Opens an existing PAK file at +path+ or if not specified creates a virtual PAK
+  def initialize(path = nil)
+    @file_hash = Hash.new
+    @pak_file = nil
+
+    unless path.nil?
+      @pak_file = File.open path, "rb"
+
+      header = Header.new @pak_file.read 12
+      puts "Warning: Might not be a real PAK" unless header.magic == "PACK"
+      file_count = header.size / 64
+
+      @pak_file.seek header.offset
+      file_count.times do
+        entry = FileEntryPAK.new self, @pak_file.read(64)
+        file_add entry
+      end
+    end
+  end
+
+  def finalize
+    @pak_file.close unless @pak_file.nil?
+  end
+
+  ##
+  # Extracts a file +name+ from this PAKFile to +path+ on system
+  def extract(name, path)
+    file_entry = file_find(name)
+    raise ArgumentError, "No such file #{name} in this PAK." if file_entry.nil?
+    
+    # Create the necessary directories
+    path_current = ""
+    File.dirname(path).split(/[\/\\]/).each do |dir|
+      path_current += dir
+      Dir.mkdir path_current unless Dir.exists?(path_current)
+      path_current += "/"
+    end
+
+    # Transfer contents
+    file = File.open path, "wb"
+    file.write file_entry.read
+
+    file.close
+  end
+
+  ##
+  # Extracts all files in PAK to +dir+ directory
+  def extract_all(dir)
+    files_list.each do |file_name|
+      extract file_name, dir + "/" + file_name
+    end
+  end
+
+  ##
+  # Inserts a system file at +path+ as +name+
+  def insert(path, name)
+    file_add FileEntrySystem.new self, path, name
+  end
+
+  ##
+  # Inserts a directory +dir+ recursively contents as their names
+  def insert_all(dir)
+    insert_all_helper(dir, "")
+  end
+
+  ##
+  # Saves all the changes to +path+
+  def save(path)
+    tmp_path = "#{path}.tmp_"
+    file = File.open tmp_path, "wb"
+    
+    file_entries = Array.new
+
+    # Will finish header later when we know where the file entries will be
+    file.write "PACK"
+    file.seek 12
+
+    # Insert all of the files
+    files_list.each do |name|
+      entry = file_find name
+
+      file_entry = Hash.new
+      file_entry[:name] = entry.name
+      file_entry[:offset] = file.pos
+
+      file.write entry.read
+
+      file_entry[:size] = file.pos - file_entry[:offset]
+      file_entries.push file_entry
+    end
+
+    # Now we know the rest of the info needed for the header
+    file_entry_pos = file.pos
+    file.seek 4
+    file.write [file_entry_pos, file_entries.length * 64].pack("VV")
+
+    # And finally add the file entries
+    file.seek file_entry_pos
+    file_entries.each do |file_entry|
+      file.write [file_entry[:name], file_entry[:offset], file_entry[:size]].pack("a56VV")
+    end
+    
+    # close so we can open it again
+    file.close
+
+    # And finally move it to the correct place
+    File.rename tmp_path, path
+  end
+
+  ##
+  # Lists all files in PAK to an array
+  def list
+    files_list
+  end
+
+  attr_reader :pak_file
+
+  private
+  
+  ##
+  # Adds +file_entry+ to pak
+  def file_add(file_entry)
+    @file_hash[file_entry.name] = file_entry
+  end
+  
+  ##
+  # Finds file called +name+ in pak
+  def file_find(name)
+    @file_hash[name]
+  end
+
+  ##
+  # Returns a list of all the files as an array of strings
+  def files_list
+    @file_hash.values.map { |entry| entry.name }
+  end
+
+  def insert_all_helper(dir, prefix)
+    Dir.entries(dir).each do |entry|
+      unless entry == "." or entry == ".."
+        if File.directory? "#{dir}/#{entry}"
+          insert_all_helper("#{dir}/#{entry}", "#{prefix}#{entry}/")
+        else
+          insert("#{dir}/#{entry}", "#{prefix}#{entry}")
+        end
+      end
+    end
+  end
+
+  ##
+  # Reperesents PAK header block
+  class Header
+    attr_accessor :magic, :offset, :size
+
+    ##
+    # Unpacks the 12 header bytes from +entry+
+    def initialize(header)
+      # magic  - 4 byte arbitary string (not null terminated)
+      # offset - 4 byte integer (little endian)
+      # size   - 4 byte integer (little endian)
+      data = header.unpack "a4VV"
+
+      @magic  = data[0]
+      @offset = data[1]
+      @size   = data[2]
+    end
+  end
+
+  ##
+  # Base class for all files handled by PAKFile
+  class FileEntry
+    attr_accessor :name
+
+    ##
+    # +pack+ has to be PAKFile that owns this entry
+    def initialize(pack)
+      @pack = pack
+      @name = ""
+    end
+
+    def read
+      puts "This is just a base class..."
+      ""
+    end
+  end
+
+  ##
+  # File located inside the PAK itself
+  class FileEntryPAK < FileEntry
+    def initialize(pack, entry)
+      super pack
+
+      # name   - max 58 byte null terminated string
+      # offset - 4 byte integer (little endian)
+      # size   - 4 byte integer (little endian)
+      data = entry.unpack "a56VV"
+
+      @name   = data[0].rstrip
+      @offset = data[1]
+      @size   = data[2]
+    end
+
+    def read
+      @pack.pak_file.seek @offset
+      @pack.pak_file.read @size
+    end
+  end
+
+  ##
+  # File located on a file system, not in the pack
+  class FileEntrySystem < FileEntry
+    def initialize(pack, path, name)
+      super pack
+      @path = path
+      @name = name
+    end
+
+    def read
+      f = File.open @path, "rb"
+      data = f.read
+      f.close
+      data
+    end
+  end
+end
+

metadata

@@ -0,0 +1,45 @@
+--- !ruby/object:Gem::Specification
+name: pakspy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Valters Mednis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-02 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: valters.mednis@gmail.com
+executables:
+- pakspy
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/pakspy
+- lib/pakspy.rb
+homepage: https://github.com/vmednis/pakspy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Tools for working with Quake style PAK files.
+test_files: []