keeguon-ruby-ole 1.2.11.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 58fa07a027f1749169976efdfd28765389a64427
+  data.tar.gz: 2bab2adf00827a519565157b2ab29ff558f91bfd
+SHA512:
+  metadata.gz: 856d34198b96fb409778dac630f9ecc83a40eded7771e2551910a886be6ab2e2ce134e7fe3f4b71e6b2fd0968d3d4e509509d018791d1bb0168741196ebd6dfa
+  data.tar.gz: d76eab9e94ebf6cfa3c8f10af7d0e7ef4cf51fcf2090a6ec463dd2e2cdc4187457becfdef0c647f4fc63ba3089fceaa136d1c65e3487b362e53ac119773be5d5

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2010 Charles Lowe
+
+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/ChangeLog

@@ -0,0 +1,140 @@
+== 1.2.11.7 / 2013-06-24
+
+- Various encoding fixes to make tests pass on current rubies.
+- Fix RangesIO#write behaviour when passed an encoded string (github #14,
+  romuloceccon).
+- Fix Dirent#each_child attempting iteration on file children (github #13).
+- Unused variable fixes to avoid warnings (github #12, kachick).
+
+== 1.2.11.6 / 2012-12-10
+
+- Fix breakage of writable IO stream detection on Windows (github #11).
+
+== 1.2.11.5 / 2012-11-06
+
+- Fix breakage of IO.parse_mode on Rubinius (issue #10).
+- Make tests pass on rubinius (issue #11).
+- Improve RangesIO test coverage.
+- Don't warn when mbat_start is AVAIL instead of EOC (github #9).
+
+== 1.2.11.4 / 2012-07-03
+
+- Embed PropertySet meta data GUIDs and field lists, to avoid hitting the
+  filesystem and remove dependency on YAML.
+- Update Rakefile to avoid warnings about both deprecated tasks and space
+  before parentheses.
+- Remove Dirent#children=.
+
+== 1.2.11.3 / 2012-02-25
+
+- Various fixes for ruby 1.9.3 - handle iconv deprecation and
+  fix FileTime.from_time (github #7, brawnski).
+- Avoid constant redefinition warning in gemspec.
+
+== 1.2.11.2 / 2011-09-07
+
+- Remove empty dirents after constructing tree (fixes non-contiguous
+  allocation table usage).
+- Fix fallback Symbol#to_proc to match activesupport definition in case
+  we get loaded first (github #2, lazylester).
+- Use method_defined? for fallback guards to support newer versions of
+  ruby (jocker).
+- Add guard on FileTime#initialize to skip for newer versions of ruby.
+  Missing required methods, but optimization no longer relevant
+  anyway (github #4, sagmor).
+
+== 1.2.11.1 / 2010-10-24
+
+- Add gemspec and docs to packages so tests can pass again.
+- Build tarballs again in package task.
+
+== 1.2.11 / 2010-10-17
+
+- Add COPYING for packaging (issue #7)
+- Make tests pass using home_run (github #1)
+- Make tests pass using mathn.
+- Updates to suppress warnings on 1.9.2.
+- Split out gemspec into separate file and use for Rakefile.
+
+== 1.2.10.1 / 2010-03-19
+
+- Avoid use of DateTime#new! (issue #4)
+- Remove warning about unexpected root names (issue #5)
+
+== 1.2.10 / 2009-07-20
+
+- Mostly more performance enhancements, significantly faster for
+  certain operations.
+- Using lots of files is faster due to new hash lookup for dirents by name.
+- Writes of many files are faster now too as Dirent & FileTime serialization
+  has been improved.
+- Certain operations from the filesystem api have been profiled and sped up.
+- Don't use syswrite on jruby to avoid the buffered stream warnings.
+
+== 1.2.9 / 2009-07-14
+
+- Lots of performance enhancements for RangesIO.
+
+== 1.2.8.2 / 2009-01-01
+
+- Update code to support ruby 1.9.1
+
+== 1.2.8.1 / 2008-10-22
+
+- Fix a couple of breakages when using $KCODE = 'UTF8'
+
+== 1.2.8 / 2008-10-08
+
+- Check in the new fixes to the mbat support.
+- Update README to be a bit more useful.
+
+== 1.2.7 / 2008-08-12
+
+- Prepare Ole::Types::PropertySet for write support.
+- Introduce Ole::Storage#meta_data as an easy interface to meta data stored
+  within various property sets.
+- Add new --metadata action to oletool to dump said metadata.
+- Add new --mimetype action to oletool, and corresponding Ole::Storage#mime_type
+  function to try to guess mime type of a file based on some simple heuristics.
+- Restructure project files a bit, and pull in file_system & meta_data support
+  by default.
+- More tests - now have 100% coverage.
+
+== 1.2.6 / 2008-07-21
+
+- Fix FileClass#expand_path to work properly on darwin (issue #2)
+- Guard against Enumerable#sum clash with active support (issue #3)
+
+== 1.2.5 / 2008-02-16
+
+- Make all tests pass on ruby 1.9.
+
+== 1.2.4 / 2008-01-09
+
+- Make all tests pass on windows (issue #1).
+- Make all tests pass on a power pc (running ubuntu).
+- Property set convenience access functions.
+
+== 1.2.3 / 2007-12-28
+
+- MBAT write support re-implmented. Can now write files over ~8mb again.
+- Minor fixes (truncation in #flush, file modification timestamps)
+- More test coverage
+- Initial (read-only) property set support.
+- Complete filesystem api, to pass most of the rubyzip tests.
+- Add a ChangeLog :).
+
+== 1.2.2 / 2007-11-05
+
+- Lots of test updates, 90% coverage.
+- Fix +to_tree+ method to be more efficient, and stream output.
+- Optimizations from benchmarks and profiling, mostly for writes. Fixed
+  AllocationTable#resize_chain, RangesIOResizable#truncate and
+  AllocationTable#free_block.
+- Add in filesystem test file from rubyzip, and start working on a
+  filesystem api.
+
+== 1.2.1 / 2007-08-20
+
+- Separate out from ruby-msg as new project.
+

data/README

@@ -0,0 +1,116 @@
+= Introduction
+
+The ruby-ole library provides a variety of functions primarily for
+working with OLE2 structured storage files, such as those produced by
+Microsoft Office - eg *.doc, *.msg etc.
+
+= Example Usage
+
+Here are some examples of how to use the library functionality,
+categorised roughly by purpose.
+
+1. Reading and writing files within an OLE container
+
+   The recommended way to manipulate the contents is via the
+   "file_system" API, whereby you use Ole::Storage instance methods
+   similar to the regular File and Dir class methods.
+
+     ole = Ole::Storage.open('oleWithDirs.ole', 'rb+')
+     p ole.dir.entries('.') # => [".", "..", "dir1", "dir2", "file1"]
+     p ole.file.read('file1')[0, 25] # => "this is the entry 'file1'"
+     ole.dir.mkdir('newdir')
+
+2. Accessing OLE meta data
+
+   Some convenience functions are provided for (currently read only)
+   access to OLE property sets and other sources of meta data.
+
+     ole = Ole::Storage.open('test_word_95.doc')
+     p ole.meta_data.file_format # => "MSWordDoc"
+     p ole.meta_data.mime_type # => "application/msword"
+     p ole.meta_data.doc_author.split.first # => "Charles"
+
+3. Raw access to underlying OLE internals
+
+   This is probably of little interest to most developers using the
+   library, but for some use cases you may need to drop down to the
+   lower level API on which the "file_system" API is constructed,
+   which exposes more of the format details.
+
+   <tt>Ole::Storage</tt> files can have multiple files with the same name,
+   or with a slash in the name, and other things that are probably
+   strictly invalid. This API is the only way to access those files.
+
+   You can access the header object directly:
+
+     p ole.header.num_sbat # => 1
+     p ole.header.magic.unpack('H*') # => ["d0cf11e0a1b11ae1"]
+
+   You can directly access the array of all Dirent objects,
+   including the root:
+
+     p ole.dirents.length # => 5
+     puts ole.root.to_tree
+     # =>
+     - #<Dirent:"Root Entry">
+       |- #<Dirent:"\001Ole" size=20 data="\001\000\000\002\000...">
+       |- #<Dirent:"\001CompObj" size=98 data="\001\000\376\377\003...">
+       |- #<Dirent:"WordDocument" size=2574 data="\334\245e\000-...">
+       \- #<Dirent:"\005SummaryInformation" size=54788 data="\376\377\000\000\001...">
+
+   You can access (through RangesIO methods, or by using the
+   relevant Dirent and AllocationTable methods) information like where within
+   the container a stream is located (these are offset/length pairs):
+
+     p ole.root["\001CompObj"].open { |io| io.ranges } # => [[0, 64], [64, 34]]
+
+See the documentation for each class for more details.
+
+= Thanks
+
+* The code contained in this project was initially based on chicago's libole
+  (source available at http://prdownloads.sf.net/chicago/ole.tgz).
+
+* It was later augmented with some corrections by inspecting pole, and (purely
+  for header definitions) gsf.
+
+* The property set parsing code came from the apache java project POIFS.
+
+* The excellent idea for using a pseudo file system style interface by providing
+  #file and #dir methods which mimic File and Dir, was borrowed (along with almost
+  unchanged tests!) from Thomas Sondergaard's rubyzip.
+
+= TODO
+
+== 1.2.12
+
+* internal api cleanup
+* add buffering to rangesio so that performance for small reads and writes
+  isn't so awful. maybe try and remove the bottlenecks of unbuffered first
+  with more profiling, then implement the buffering on top of that.
+* fix mode strings - like truncate when using 'w+', supporting append
+  'a+' modes etc. done?
+* make ranges io obey readable vs writeable modes.
+* more RangesIO completion. ie, doesn't support #<< at the moment.
+* maybe some oletool doc.
+* make sure `rake test' runs tests both with $KCODE='UTF8', and without,
+  and maybe ensure i don't regress on 1.9 and jruby either now that they're
+  fixed.
+
+== 1.3.1
+
+* case insensitive open mode would be nice
+* fix property sets a bit more. see TODO in Ole::Storage::MetaData
+* ability to zero out padding and unused blocks
+* better tests for mbat support.
+* further doc cleanup
+* add in place testing for jruby and ruby1.9
+
+== Longer term
+
+* more benchmarking, profiling, and speed fixes. was thinking vs other
+  ruby filesystems (eg, vs File/Dir itself, and vs rubyzip), and vs other
+  ole implementations (maybe perl's, and poifs) just to check its in the
+  ballpark, with no remaining silly bottlenecks.
+* supposedly vba does something weird to ole files. test that.
+

data/Rakefile

@@ -0,0 +1,91 @@
+require 'rubygems'
+require 'rake/testtask'
+
+require 'rbconfig'
+require 'fileutils'
+
+spec = eval File.read('ruby-ole.gemspec')
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+	t.test_files = FileList["test/test_*.rb"]
+	t.warning = true
+	t.verbose = true
+end
+
+begin
+	require 'rcov/rcovtask'
+	# NOTE: this will not do anything until you add some tests
+	desc "Create a cross-referenced code coverage report"
+	Rcov::RcovTask.new do |t|
+		t.test_files = FileList['test/test*.rb']
+		t.ruby_opts << "-Ilib" # in order to use this rcov
+		t.rcov_opts << "--xrefs"  # comment to disable cross-references
+		t.verbose = true
+	end
+rescue LoadError
+	# Rcov not available
+end
+
+begin
+	require 'rdoc/task'
+	RDoc::Task.new do |t|
+		t.rdoc_dir = 'doc'
+		t.rdoc_files.include 'lib/**/*.rb'
+		t.rdoc_files.include 'README', 'ChangeLog'
+		t.title    = "#{PKG_NAME} documentation"
+		t.options += %w[--line-numbers --inline-source --tab-width 2]
+		t.main	   = 'README'
+	end
+rescue LoadError
+	# RDoc not available or too old (<2.4.2)
+end
+
+begin
+	require 'rubygems/package_task'
+	Gem::PackageTask.new(spec) do |t|
+		t.need_tar = true
+		t.need_zip = false
+		t.package_dir = 'build'
+	end
+rescue LoadError
+	# RubyGems too old (<1.3.2)
+end
+
+desc 'Run various benchmarks'
+task :benchmark do
+	require 'benchmark'
+	require 'tempfile'
+	require 'ole/storage'
+
+	# should probably add some read benchmarks too
+	def write_benchmark opts={}
+		files, size = opts[:files], opts[:size]
+		block_size = opts[:block_size] || 100_000
+		block = 0.chr * block_size
+		blocks, remaining = size.divmod block_size
+		remaining = 0.chr * remaining
+		Tempfile.open 'ole_storage_benchmark' do |temp|
+			Ole::Storage.open temp do |ole|
+				files.times do |i|
+					ole.file.open "file_#{i}", 'w' do |f|
+						blocks.times { f.write block }
+						f.write remaining
+					end
+				end
+			end
+		end
+	end
+
+	Benchmark.bm do |bm|
+		bm.report 'write_1mb_1x5' do
+			5.times { write_benchmark :files => 1, :size => 1_000_000 }
+		end
+
+		bm.report 'write_1mb_2x5' do
+			5.times { write_benchmark :files => 1_000, :size => 1_000 }
+		end
+	end
+end
+

data/bin/oletool

@@ -0,0 +1,40 @@
+#! /usr/bin/ruby
+
+require 'optparse'
+require 'ole/storage'
+
+def oletool
+	opts = {:verbose => false, :action => :tree}
+	op = OptionParser.new do |op|
+		op.banner = "Usage: oletool [options] [files]"
+		op.separator ''
+		op.on('-t', '--tree', 'Dump ole trees for files (default)') { opts[:action] = :tree }
+		op.on('-r', '--repack', 'Repack the ole files in canonical form') { opts[:action] = :repack }
+		op.on('-m', '--mimetype', 'Print the guessed mime types') { opts[:action] = :mimetype }
+		op.on('-y', '--metadata', 'Dump the internal meta data as YAML') { opts[:action] = :metadata }
+		op.separator ''
+		op.on('-v', '--[no-]verbose', 'Run verbosely') { |v| opts[:verbose] = v }
+		op.on_tail('-h', '--help', 'Show this message') { puts op; exit }
+	end
+	files = op.parse ARGV
+	if files.empty?
+		puts 'Must specify 1 or more msg files.'
+		puts op
+		exit 1
+	end
+	Ole::Log.level = opts[:verbose] ? Logger::WARN : Logger::FATAL
+	files.each do |file|
+		case opts[:action]
+		when :tree
+			Ole::Storage.open(file) { |ole| puts ole.root.to_tree }
+		when :repack
+			Ole::Storage.open file, 'rb+', &:repack
+		when :metadata
+			Ole::Storage.open(file) { |ole| y ole.meta_data.to_h }
+		when :mimetype
+			puts Ole::Storage.open(file) { |ole| ole.meta_data.mime_type }
+		end
+	end
+end
+
+oletool

data/lib/ole/base.rb

@@ -0,0 +1,10 @@
+# encoding: ASCII-8BIT
+
+
+require 'ole/support'
+require 'ole/storage/version'
+
+module Ole # :nodoc:
+	Log = Logger.new_with_callstack
+end
+

data/lib/ole/file_system.rb

@@ -0,0 +1,7 @@
+warn <<-end
+Use of ole/file_system is deprecated. Use ole/storage (the file_system api
+is recommended and enabled by default).
+end
+
+require 'ole/storage'
+

data/lib/ole/ranges_io.rb

@@ -0,0 +1,267 @@
+# encoding: ASCII-8BIT
+
+# need Ole::IOMode
+require 'ole/support'
+
+#
+# = Introduction
+#
+# +RangesIO+ is a basic class for wrapping another IO object allowing you to arbitrarily reorder
+# slices of the input file by providing a list of ranges. Intended as an initial measure to curb
+# inefficiencies in the Dirent#data method just reading all of a file's data in one hit, with
+# no method to stream it.
+# 
+# This class will encapuslate the ranges (corresponding to big or small blocks) of any ole file
+# and thus allow reading/writing directly to the source bytes, in a streamed fashion (so just
+# getting 16 bytes doesn't read the whole thing).
+#
+# In the simplest case it can be used with a single range to provide a limited io to a section of
+# a file.
+#
+# = Limitations
+#
+# * No buffering. by design at the moment. Intended for large reads
+# 
+# = TODO
+# 
+# On further reflection, this class is something of a joining/optimization of
+# two separate IO classes. a SubfileIO, for providing access to a range within
+# a File as a separate IO object, and a ConcatIO, allowing the presentation of
+# a bunch of io objects as a single unified whole.
+# 
+# I will need such a ConcatIO if I'm to provide Mime#to_io, a method that will
+# convert a whole mime message into an IO stream, that can be read from.
+# It will just be the concatenation of a series of IO objects, corresponding to
+# headers and boundaries, as StringIO's, and SubfileIO objects, coming from the
+# original message proper, or RangesIO as provided by the Attachment#data, that
+# will then get wrapped by Mime in a Base64IO or similar, to get encoded on-the-
+# fly. Thus the attachment, in its plain or encoded form, and the message as a
+# whole never exists as a single string in memory, as it does now. This is a
+# fair bit of work to achieve, but generally useful I believe.
+# 
+# This class isn't ole specific, maybe move it to my general ruby stream project.
+# 
+class RangesIO
+	attr_reader :io, :mode, :ranges, :size, :pos
+	# +io+:: the parent io object that we are wrapping.
+	# +mode+:: the mode to use
+	# +params+:: hash of params.
+	# * :ranges - byte offsets, either:
+	#   1. an array of ranges [1..2, 4..5, 6..8] or
+	#   2. an array of arrays, where the second is length [[1, 1], [4, 1], [6, 2]] for the above
+	#      (think the way String indexing works)
+	# * :close_parent - boolean to close parent when this object is closed
+	#
+	# NOTE: the +ranges+ can overlap.
+	def initialize io, mode='r', params={}
+		mode, params = 'r', mode if Hash === mode
+		ranges = params[:ranges]
+		@params = {:close_parent => false}.merge params
+		@mode = Ole::IOMode.new mode
+		@io = io
+		# initial position in the file
+		@pos = 0
+		self.ranges = ranges || [[0, io.size]]
+		# handle some mode flags
+		truncate 0 if @mode.truncate?
+		seek size if @mode.append?
+	end
+	
+	# add block form. TODO add test for this
+	def self.open(*args, &block)
+		ranges_io = new(*args)
+		if block_given?
+			begin;  yield ranges_io
+			ensure; ranges_io.close
+			end
+		else
+			ranges_io
+		end
+	end
+
+	def ranges= ranges
+		# convert ranges to arrays. check for negative ranges?
+		ranges = ranges.map { |r| Range === r ? [r.begin, r.end - r.begin] : r }
+		# combine ranges
+		if @params[:combine] == false
+			# might be useful for debugging...
+			@ranges = ranges
+		else
+			@ranges = []
+			next_pos = nil
+			ranges.each do |pos, len|
+				if next_pos == pos
+					@ranges.last[1] += len
+					next_pos += len
+				else
+					@ranges << [pos, len]
+					next_pos = pos + len
+				end
+			end
+		end
+		# calculate cumulative offsets from range sizes
+		@size = 0
+		@offsets = []
+		@ranges.each do |pos, len|
+			@offsets << @size
+			@size += len
+		end
+		self.pos = @pos
+	end
+
+	def pos= pos, whence=IO::SEEK_SET
+		case whence
+		when IO::SEEK_SET
+		when IO::SEEK_CUR
+			pos += @pos
+		when IO::SEEK_END
+			pos = @size + pos
+		else raise Errno::EINVAL
+		end
+		raise Errno::EINVAL unless (0..@size) === pos
+		@pos = pos
+
+		# do a binary search throuh @offsets to find the active range.
+		a, c, b = 0, 0, @offsets.length
+		while a < b
+			c = (a + b).div(2)
+			pivot = @offsets[c]
+			if pos == pivot
+				@active = c
+				return
+			elsif pos < pivot
+				b = c
+			else
+				a = c + 1
+			end
+		end
+
+		@active = a - 1
+	end
+
+	alias seek :pos=
+	alias tell :pos
+
+	def rewind
+		seek 0
+	end
+
+	def close
+		@io.close if @params[:close_parent]
+	end
+
+	def eof?
+		@pos == @size
+	end
+
+	# read bytes from file, to a maximum of +limit+, or all available if unspecified.
+	def read limit=nil
+		data = ''
+		return data if eof?
+		limit ||= size
+		pos, len = @ranges[@active]
+		diff = @pos - @offsets[@active]
+		pos += diff
+		len -= diff
+		loop do
+			@io.seek pos
+			if limit < len
+				s = @io.read(limit).to_s
+				@pos += s.length
+				data << s
+				break
+			end
+			s = @io.read(len).to_s
+			@pos += s.length
+			data << s
+			break if s.length != len
+			limit -= len
+			break if @active == @ranges.length - 1
+			@active += 1
+			pos, len = @ranges[@active]
+		end
+		data
+	end
+
+	# you may override this call to update @ranges and @size, if applicable.
+	def truncate size
+		raise NotImplementedError, 'truncate not supported'
+	end
+
+	# using explicit forward instead of an alias now for overriding.
+	# should override truncate.
+	def size=	size
+		truncate size
+	end
+
+	def write data
+		# duplicates object to avoid side effects for the caller, but do so only if
+		# encoding isn't already ASCII-8BIT (slight optimization)
+		if data.respond_to?(:encoding) and data.encoding != Encoding::ASCII_8BIT
+			data = data.dup.force_encoding(Encoding::ASCII_8BIT)
+		end
+		return 0 if data.empty?
+		data_pos = 0
+		# if we don't have room, we can use the truncate hook to make more space.
+		if data.length > @size - @pos
+			begin
+				truncate @pos + data.length
+			rescue NotImplementedError
+				raise IOError, "unable to grow #{inspect} to write #{data.length} bytes" 
+			end
+		end
+		pos, len = @ranges[@active]
+		diff = @pos - @offsets[@active]
+		pos += diff
+		len -= diff
+		loop do
+			@io.seek pos
+			if data_pos + len > data.length
+				chunk = data[data_pos..-1]
+				@io.write chunk
+				@pos += chunk.length
+				data_pos = data.length
+				break
+			end
+			@io.write data[data_pos, len]
+			@pos += len
+			data_pos += len
+			break if @active == @ranges.length - 1
+			@active += 1
+			pos, len = @ranges[@active]
+		end
+		data_pos
+	end
+	
+	alias << write
+
+	# i can wrap it in a buffered io stream that
+	# provides gets, and appropriately handle pos,
+	# truncate. mostly added just to past the tests.
+	# FIXME
+	def gets
+		s = read 1024
+		i = s.index "\n"
+		self.pos -= s.length - (i+1)
+		s[0..i]
+	end
+	alias readline :gets
+
+	def inspect
+		"#<#{self.class} io=#{io.inspect}, size=#{@size}, pos=#{@pos}>"
+	end
+end
+
+# this subclass of ranges io explicitly ignores the truncate part of 'w' modes.
+# only really needed for the allocation table writes etc. maybe just use explicit modes
+# for those
+# better yet write a test that breaks before I fix it. added nodoc for the 
+# time being.
+class RangesIONonResizeable < RangesIO # :nodoc:
+	def initialize io, mode='r', params={}
+		mode, params = 'r', mode if Hash === mode
+		flags = Ole::IOMode.new(mode).flags & ~IO::TRUNC
+		super io, flags, params
+	end
+end
+