partoo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8b81246eb7b48a99da7050cb30080b40226670f8
+  data.tar.gz: 20ec46d107e331ccd25ba8a27d735af7e7027d87
+SHA512:
+  metadata.gz: d67efda133a325960372ed02188f6f6f837104aad02eccde4baeb6cd0d2863e3907e89196cb1f66fb6fe05208c28ce11247b9a7980d217f21d377d66d52e0156
+  data.tar.gz: 0fa54c15a945f7b1983b4c1c6f0b462db5b30f68afe030dff57516c81e5aeca9231f27788a54f35440834df9853ae31e96d368f0cebce91451ba6f4bb2543855

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.4
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in partoo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Matt Cover
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Partoo
+
+Do cool things with par2 files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partoo'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install partoo
+
+## Usage
+
+```
+Commands:
+  partoo dump <par2 file>                 # Dump packets in a par2 file as a data structure
+  partoo help [COMMAND]                   # Describe available commands or one specific command
+  partoo inspect <attribute> <par2 file>  # Inspect a particular attribute of a par2 file
+  partoo list <par2 file>                 # Lists files described in a par2 file
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/werekraken/partoo.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "partoo"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/partoo

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'partoo/cli'
+
+Partoo::CLI.start

data/lib/partoo.rb

@@ -0,0 +1,46 @@
+require 'partoo/par2_file'
+require 'partoo/version'
+
+module Partoo
+  class << self
+
+    # TODO: implement #create
+    # TODO: implement #repair
+    # TODO: implement #verify
+
+    def dump(par2_file)
+      io = File.open(par2_file)
+      Par2File.read(io)
+    end
+
+    def list(par2_file)
+      io = File.open(par2_file)
+      f = Par2File.read(io)
+      f.list
+    end
+
+    def creator(par2_file)
+      io = File.open(par2_file)
+      f = Par2File.read(io)
+      f.creator
+    end
+
+    def recovery_set_file_count(par2_file)
+      io = File.open(par2_file)
+      f = Par2File.read(io)
+      f.recovery_set_file_count
+    end
+
+    def recovery_set_id(par2_file)
+      io = File.open(par2_file)
+      f = Par2File.read(io)
+      f.recovery_set_id
+    end
+
+    def slice_size(par2_file)
+      io = File.open(par2_file)
+      f = Par2File.read(io)
+      f.slice_size
+    end
+  end
+end

data/lib/partoo/cli.rb

@@ -0,0 +1,42 @@
+require 'partoo'
+require 'pp'
+require 'thor'
+
+module Partoo
+  class CLI < Thor
+
+    desc "dump <par2 file>", "Dump packets in a par2 file as a data structure"
+    def dump(par2_file)
+      pp Partoo.dump(par2_file)
+    end
+
+    desc "inspect <attribute> <par2 file>", "Inspect a particular attribute of a par2 file"
+    long_desc <<-LONGDESC
+    Inspect a particular attribute of a par2 file"
+
+    Attributes:
+      creator
+      recovery-set-file-count
+      recovery-set-id
+      slice-size
+    LONGDESC
+    def inspect(item, par2_file)
+      attributes = ['creator', 'recovery-set-file-count', 'recovery-set-id', 'slice-size']
+      raise ArgumentError, "#{item} is not one of #{attributes}" if ! attributes.include?(item)
+      method = item.gsub(/-/, '_')
+      if method == 'recovery_set_id'
+        puts Partoo.send(method, par2_file).to_hex
+      else
+        puts Partoo.send(method, par2_file)
+      end
+    end
+
+    desc "list <par2 file>", "Lists files described in a par2 file"
+    def list(par2_file)
+      Partoo.list(par2_file).each do |f|
+        puts "#{f[0]['file_md5'].to_hex} #{f[1][:file_crc32].to_s(16).rjust(8, '0')} #{f[0]['file_length']} #{f[0]['file_name']}"
+      end
+    end
+
+  end
+end

data/lib/partoo/crc32.rb

@@ -0,0 +1,77 @@
+module Partoo
+  module CRC32
+
+    GF2_DIM = 32;
+
+    def self.crc32_trim_trailing(crc1, crc2, len2)
+
+      even = Array.new(32, 0) # even-power-of-two zeros operator
+      odd  = Array.new(32, 0) # odd-power-of-two zeros operator
+
+      # degenerate case (also disallow negative lengths)
+      return crc1 if len2 <= 0
+
+      # get crcA0
+      crc1 ^= crc2
+
+      # put operator for one zero bit in odd
+      odd[0] = 0xdb710641 # CRC-32 trim polynomial
+      row = 0x80000000
+      n = 1
+      while n < GF2_DIM
+        odd[n] = row
+        row >>= 1
+        n += 1
+      end
+
+      # put operator for two zero bits in even
+      gf2_matrix_square_trim(even, odd)
+
+      # put operator for four zero bits in odd
+      gf2_matrix_square_trim(odd, even)
+
+      # remove len2 zeros from crc1 (first square will put the operator for one
+      # zero byte, eight zero bits, in even)
+      loop do
+        # apply zeros operator for this bit of len2
+        gf2_matrix_square_trim(even, odd)
+
+        crc1 = gf2_matrix_times_trim(even, crc1) if len2 & 1 != 0
+        len2 >>= 1
+
+        # if no more bits set, then done
+        break if len2 == 0
+
+        # another iteration of the loop with odd and even swapped
+        gf2_matrix_square_trim(odd, even)
+
+        crc1 = gf2_matrix_times_trim(odd, crc1) if len2 & 1 != 0
+        len2 >>= 1
+
+        # if no more bits set, then done
+        break if len2 == 0
+      end
+
+      crc1
+    end
+
+    def self.gf2_matrix_square_trim(square, mat)
+      n = 0
+      while n < GF2_DIM
+        square[n] = gf2_matrix_times_trim(mat, mat[n])
+        n += 1
+      end
+    end
+
+    def self.gf2_matrix_times_trim(mat, vec)
+      n = 0
+      sum = 0
+      while vec > 0
+        sum ^= mat[n] if vec & 0x80000000 != 0
+        vec = (vec << 1) & 0xffffffff
+        n += 1
+      end
+      sum
+    end
+  end
+end

data/lib/partoo/par2_file.rb

@@ -0,0 +1,69 @@
+require 'bindata'
+require 'partoo/crc32'
+require 'zlib'
+
+module Partoo
+  class Par2File < BinData::Record
+
+    require 'partoo/par2_file/packet'
+
+    array :packets, type: :packet, read_until: :eof
+
+    def list
+      file_ids.map do |id|
+        [file_description_packet_by_id(id)[0]['body'], {:file_crc32 => crc32_by_id(id)}]
+      end
+    end
+
+    def crc32_by_id(id)
+      crc = ""
+      input_file_slice_checksum_packet_by_id(id)[0]['body']['chunk_checksums'].each do |cc|
+        crc_b = cc['crc32']
+        if crc != ""
+          crc = Zlib.crc32_combine(crc, crc_b, slice_size)
+        else
+          crc = crc_b
+        end
+      end
+      pad_length = slice_size - file_description_packet_by_id(id)[0]['body'].file_length % slice_size
+      crc_z = Zlib.crc32("\0" * pad_length)
+      Partoo::CRC32.crc32_trim_trailing(crc, crc_z, pad_length)
+    end
+
+    def creator
+      creator_packet[0]['body']['creator']
+    end
+
+    def file_ids
+      main_packet[0]['body']['file_ids']
+    end
+
+    def slice_size
+      main_packet[0]['body']['slice_size']
+    end
+
+    def recovery_set_file_count
+      main_packet[0]['body']['recovery_set_file_count']
+    end
+
+    def recovery_set_id
+      main_packet[0]['recovery_set_id']
+    end
+
+    def creator_packet
+      packets.select {|p| p['packet_type'] == "PAR 2.0\0Creator\0" }
+    end
+
+    def file_description_packet_by_id(id)
+      packets.select {|p| p['packet_type'] == "PAR 2.0\0FileDesc" && p['body']['file_id'] == id }
+    end
+
+    def input_file_slice_checksum_packet_by_id(id)
+      packets.select {|p| p['packet_type'] == "PAR 2.0\0IFSC\0\0\0\0" && p['body']['file_id'] == id }
+    end
+
+    def main_packet
+      packets.select {|p| p['packet_type'] == "PAR 2.0\0Main\0\0\0\0" }
+    end
+  end
+end

data/lib/partoo/par2_file/packet.rb

@@ -0,0 +1,33 @@
+require 'bindata'
+
+module Partoo
+  class Par2File
+    class Packet < BinData::Record
+
+      require 'partoo/par2_file/packet/creator'
+      require 'partoo/par2_file/packet/input_file_slice_checksum'
+      require 'partoo/par2_file/packet/file_description'
+      require 'partoo/par2_file/packet/main'
+      require 'partoo/par2_file/packet/recovery_slice'
+
+      endian  :little
+      string  :magic, :read_length => 8, :initial_value => "PAR2\0PKT"
+      uint64  :packet_length
+      uint128 :packet_md5
+      uint128 :recovery_set_id
+      string  :packet_type, :read_length => 16
+
+      choice :body, :selection => :packet_type do
+        creator                   "PAR 2.0\0Creator\0"
+        input_file_slice_checksum "PAR 2.0\0IFSC\0\0\0\0"
+        file_description          "PAR 2.0\0FileDesc"
+        main                      "PAR 2.0\0Main\0\0\0\0"
+        recovery_slice            "PAR 2.0\0RecvSlic"
+      end
+
+      def body_length
+        packet_length - 64
+      end
+    end
+  end
+end

data/lib/partoo/par2_file/packet/creator.rb

@@ -0,0 +1,10 @@
+module Partoo
+  class Par2File
+    class Packet
+      class Creator < BinData::Record
+        endian  :little
+        string  :creator, :read_length => :body_length, trim_padding: true
+      end
+    end
+  end
+end

data/lib/partoo/par2_file/packet/file_description.rb

@@ -0,0 +1,14 @@
+module Partoo
+  class Par2File
+    class Packet
+      class FileDescription < BinData::Record
+        endian  :little
+        uint128 :file_id
+        uint128 :file_md5
+        uint128 :file_md5_16k
+        uint64  :file_length
+        string  :file_name, :read_length => lambda { body_length - 56 }, trim_padding: true
+      end
+    end
+  end
+end

data/lib/partoo/par2_file/packet/input_file_slice_checksum.rb

@@ -0,0 +1,15 @@
+module Partoo
+  class Par2File
+    class Packet
+      class InputFileSliceChecksum < BinData::Record
+        endian  :little
+        uint128 :file_id
+
+        array :chunk_checksums, :read_until => lambda { index == (body_length - 16) / 20 - 1 } do
+          uint128 :md5
+          uint32  :crc32
+        end
+      end
+    end
+  end
+end

data/lib/partoo/par2_file/packet/main.rb

@@ -0,0 +1,23 @@
+module Partoo
+  class Par2File
+    class Packet
+      class Main < BinData::Record
+        endian  :little
+        uint64  :slice_size
+        uint32  :recovery_set_file_count
+
+        # TODO: need to split recovery set id and non-recovery set id arrays
+        #
+        #   this works for recovery
+        #     array :recovery_set_file_ids, :read_until => lambda { index == recovery_set_file_count - 1 } do
+        #
+        #   this doesn't error, but causes no additional packets to be parsed
+        #     array :non_recovery_set_file_ids, :read_until => lambda { index == (body_length - 8 - 4) / 16 - 1 - recovery_set_file_count } do
+        #
+        array :file_ids, :read_until => lambda { index == (body_length - 8 - 4) / 16 - 1 } do
+          uint128 :md5
+        end
+      end
+    end
+  end
+end

data/lib/partoo/par2_file/packet/recovery_slice.rb

@@ -0,0 +1,14 @@
+module Partoo
+  class Par2File
+    class Packet
+      class RecoverySlice < BinData::Record
+        endian  :little
+        uint32  :exponent
+
+        array :recovery_data, :read_until => lambda { index == (body_length - 4) / 4 - 1 } do
+          uint32  :recovery_chunk
+        end
+      end
+    end
+  end
+end

data/lib/partoo/version.rb

@@ -0,0 +1,3 @@
+module Partoo
+  VERSION = "0.1.0"
+end

data/partoo.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partoo/version'
+
+Gem::Specification.new do |s|
+  s.name          = "partoo"
+  s.version       = Partoo::VERSION
+  s.authors       = ["matt.cover"]
+  s.email         = ["werekraken@gmail.com"]
+
+  s.summary       = "Do cool things with par2 files."
+  s.description   = "Partoo parses data from par2 files allowing programatic access."
+  s.homepage      = "https://github.com/werekraken/partoo"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  s.bindir        = "exe"
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "bindata"
+  s.add_dependency "thor"
+
+  s.add_development_dependency "aruba"
+  s.add_development_dependency "bundler", "~> 1.14"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "rake", "~> 10.0"
+  s.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,165 @@
+--- !ruby/object:Gem::Specification
+name: partoo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- matt.cover
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Partoo parses data from par2 files allowing programatic access.
+email:
+- werekraken@gmail.com
+executables:
+- partoo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/partoo
+- lib/partoo.rb
+- lib/partoo/cli.rb
+- lib/partoo/crc32.rb
+- lib/partoo/par2_file.rb
+- lib/partoo/par2_file/packet.rb
+- lib/partoo/par2_file/packet/creator.rb
+- lib/partoo/par2_file/packet/file_description.rb
+- lib/partoo/par2_file/packet/input_file_slice_checksum.rb
+- lib/partoo/par2_file/packet/main.rb
+- lib/partoo/par2_file/packet/recovery_slice.rb
+- lib/partoo/version.rb
+- partoo.gemspec
+homepage: https://github.com/werekraken/partoo
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Do cool things with par2 files.
+test_files: []