narc 0.0.0

data/README

@@ -0,0 +1,12 @@
+== narc
+
+=== Description
+This gem provides a simple API for packing/unpacking *NARC* (Nitro ARChive) files, an archive file format commonly used in Nintendo DS games. It also counts with a (very) simple command line interface.
+
+=== Known Bugs/Issues
+* Unable to pack/unpack NARC files containing files with filenames and/or folders.
+
+=== Version Log
+
+==== 0.0.0
+* Initial version.

data/Rakefile

@@ -0,0 +1,47 @@
+# 
+# To change this template, choose Tools | Templates
+# and open the template in the editor.
+ 
+
+require 'rake'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+
+spec = Gem::Specification.new do |s|
+  s.name = 'narc'
+  s.version = '0.0.0'
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ['README']
+  s.summary = 'A NARC file packing/unpacking gem.'
+  s.description = 'This gem provides a simple API for packing/unpacking NARC (Nitro ARChive) files, an archive file format commonly used in Nintendo DS games. It also counts with a (very) simple command line interface.'
+  s.author = 'arc_meta'
+  s.email = 'arc_nerotech@hotmail.com'
+  s.homepage = 'https://rubygems.org/gems/narc'
+  s.executables << 'narc'
+  s.files = %w(README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.require_path = "lib"
+  s.bindir = "bin"
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+  p.need_tar = true
+  p.need_zip = true
+end
+
+Rake::RDocTask.new do |rdoc|
+  files =['README', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README" # page to start on
+  rdoc.title = "narc Docs"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
+  rdoc.options << '--line-numbers'
+end
+
+Rake::TestTask.new do |t|
+  t.test_files = FileList['test/**/*.rb']
+end

data/bin/narc

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'narc.rb'
+
+begin
+  Narc::CLI.new(ARGV)
+rescue Exception => e
+  puts "Sorry, an error has occurred: #{e.message}." 
+end

data/lib/narc.rb

@@ -0,0 +1,171 @@
+
+module Narc
+  Element = Struct.new(:name, :data)
+
+  NarcSignature = "NARC\xFE\xFF\x00\x01".force_encoding("binary")
+  FatbSignature = "BTAF".force_encoding("binary")
+  FntbSignature = "BTNF".force_encoding("binary")
+  FimgSignature = "GMIF".force_encoding("binary")
+  
+  class NarcException < StandardError; end 
+  
+end
+
+require 'narc/cli.rb'
+
+class NarcFile
+  attr_accessor :name, :elements
+  
+  def initialize(name = "narc")
+    @name = name
+    @elements = []
+    @offsets = {}
+    @size_offsets = {}
+  end
+  
+  def self.open(filename)
+    io = File.open(filename, "rb")
+    narc = self.new(File.basename(filename, ".narc"))
+    narc.get_data(io)
+    io.close
+    return narc
+  end
+
+  def extract_to_folder(folder_name = nil)
+    folder_name ||= "ex_" + @name
+    Dir.mkdir(folder_name) unless Dir.exists?(folder_name)
+    Dir.chdir(folder_name) do
+      for element in @elements
+        File.open(element.name, "wb") do |file|
+          file.write(element.data)
+        end
+      end
+    end
+  end
+
+  def self.from_folder(dir)
+    narc = self.new(File.basename(dir))
+    files = Dir.entries(dir).sort - [".", ".."]
+    narc.elements = Array.new(files.size) do Narc::Element.new end
+    Dir.chdir(dir) do
+      files.each_with_index do |file, i|
+        narc.elements[i].name = file.split("_")[-1]
+        File.open(file, "rb") do |f|
+          narc.elements[i].data = f.read
+        end
+      end
+    end
+    return narc
+  end
+
+  def save(filename = nil, include_names = false)
+    filename ||= "saved_" + self.name
+    File.open(filename, "w+b") do |f|
+      write_narc_section(f)
+      write_fatb_section(f)
+      write_fntb_section(f)
+      write_fimg_section(f)
+      write_size_data(f)
+    end
+  end
+
+  def get_data(io)
+    check_signature(io)
+    get_section_offsets(io)
+    get_elements(io)
+  end
+  
+  private 
+  def check_signature(io)
+    io.pos = 0
+    raise Narc::NarcException, "Signature does not match (is it really a NARC file?)" unless io.read(4) == 'NARC'
+  end
+  
+  def get_section_offsets(io)
+    @offsets[:narc] = 0x0
+    @offsets[:btaf] = 0x10
+    io.pos = @offsets[:btaf] + 0x8                       # Number of elements
+    @offsets[:btnf] = io.read(4).unpack('V')[0] * 8 + @offsets[:btaf] + 0xC
+    io.pos = @offsets[:btnf] + 0x4                       # FNTB Size
+    @offsets[:gmif] = @offsets[:btnf] + io.read(4).unpack('V')[0]
+  end
+
+  def get_elements(io)
+    io.pos = @offsets[:btaf] + 0x8
+    @elements = Array.new(io.read(4).unpack('V')[0]) do Narc::Element.new end
+    io.pos = @offsets[:btnf] + 0x8
+    names = io.read(4).unpack('V')[0] == 0x00000004 ? false : true
+    @elements.size.times do |i|
+      @elements[i].name = @name + "_" + "%04d" % i
+      io.pos = @offsets[:btaf] + 12 + i * 0x8
+      elem_start, elem_end = io.read(8).unpack('V2')
+      io.pos = @offsets[:gmif] + 0x8 + elem_start
+      size = elem_end - elem_start
+      @elements[i].data = io.read(size)
+    end
+  end
+
+  def write_narc_section(file)
+    @offsets[:narc] = file.pos
+    file.write(Narc::NarcSignature)                  # Signature
+    @size_offsets[:file] = file.pos                  # File size
+    file.write([0x0].pack('V'))
+    file.write([0x10].pack('v'))                     # Section size
+    file.write([0x3].pack('v'))                      # Number of sections
+  end
+
+  def write_fatb_section(file)
+    @offsets[:btaf] = file.pos
+    file.write(Narc::FatbSignature)                  # Signature
+    @size_offsets[:fatb] = file.pos                  # FATB block size
+    file.write([0x0].pack('V'))
+    file.write([self.elements.size].pack('V'))       # Number of entries
+    offset = 0
+    self.elements.size.times do |i|                  # Element offsets
+      offset += 1 until offset % 4 == 0
+      file.write([offset].pack('V'))
+      offset += self.elements[i].data.size
+      file.write([offset].pack('V'))
+    end
+  end
+
+  def write_fntb_section(file)
+    @offsets[:btnf] = file.pos
+    file.write(Narc::FntbSignature)
+    file.write([0x10, 0x4, 0x10000].pack('V3'))
+  end
+
+  def write_fimg_section(file)
+    @offsets[:gmif] = file.pos
+    file.write(Narc::FimgSignature)
+    @size_offsets[:fimg] = file.pos                  # FIMG block size
+    file.write([0x0].pack('V'))
+    offset = 0
+    self.elements.size.times do |i|
+      until offset % 4 == 0
+        file.write("\xFF")
+        offset += 1
+      end
+      file.write(self.elements[i].data)
+      offset += self.elements[i].data.size
+    end
+  end
+
+  def write_size_data(file)
+    file.pos = 0
+    filesize = file.stat.size
+    file.pos = @size_offsets[:file]
+    file.write([filesize].pack('V'))
+    file.pos = @size_offsets[:fatb]
+    file.write([0x8 + 0x4 + (self.elements.size * 8)].pack('V'))
+
+    fimgsize = get_fimg_size(file)
+    file.pos = @size_offsets[:fimg]
+    file.write([fimgsize].pack('V'))
+  end
+
+  def get_fimg_size(file)
+    file.pos = @offsets[:btnf] - 0x4                 # The size of the FIMG block == the end offset of the last file in the FIMG block + 0x8
+    return (file.read(4).unpack('V')[0] + 0x8)
+  end
+end

data/lib/narc/cli.rb

@@ -0,0 +1,53 @@
+Narc::Usage = <<DOC
+
+narc command usage:
+
+narc        
+    (with no arguments) Show this help.
+
+narc -x <narc file> <output folder>   
+    Extracts the contents of a narc file to a folder. If the <output folder> 
+    arguments is missing, extracts to a folder with the same name of the narc 
+    file.
+
+narc -c <input folder> <narc file>
+    Creates a narc file with the contents of <input folder> folder. If <narc 
+    file> is absent, the name of the narc file will be the same as the input 
+    folder name.
+
+DOC
+
+module Narc
+  class CLI
+    def initialize(args)
+      @args = args
+      process_cmds
+    end
+    
+    def process_cmds
+      if @args.size == 0
+        puts Narc::Usage
+      end
+      case @args[0]
+      when '-x'
+        unless @args[1]
+          puts "You must provide the path of the narc file as argument." 
+          return
+        end
+        puts "Extracting..."
+        narc = NarcFile.open(@args[1])
+        narc.extract_to_folder(@args[2])
+        puts "Extract successful."
+      when '-c'
+        unless @args[1]
+          puts "You must provide the path of the folder as argument." 
+          return
+        end
+        puts "Creating narc file..."
+        narc = NarcFile.from_folder(@args[1])
+        narc.save(@args[2])
+        puts "Narc file was created successfully."
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: narc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- arc_meta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-08 00:00:00.000000000Z
+dependencies: []
+description: This gem provides a simple API for packing/unpacking NARC (Nitro ARChive)
+  files, an archive file format commonly used in Nintendo DS games. It also counts
+  with a (very) simple command line interface.
+email: arc_nerotech@hotmail.com
+executables:
+- narc
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- README
+- Rakefile
+- bin/narc
+- lib/narc/cli.rb
+- lib/narc.rb
+homepage: https://rubygems.org/gems/narc
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A NARC file packing/unpacking gem.
+test_files: []