seven_zip_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cddf8386211bb8c27016b7bc9adc3e01397485c
+  data.tar.gz: 62bea191d4575a3788562ce06ac4354c71ac6d19
+SHA512:
+  metadata.gz: 242528879f0d204d9f36542361ac2bac674ef5d1973ccd829fd8a1f8500b96fa4d896dbd0e21a9eb352d9f7e7a0d3edc1bd0b0a75f0ca1d2420584faf6570fc3
+  data.tar.gz: e65d5c645b9e7960e8268fa44d1e02e0cb0487caa6f29c6fd6d12bb73e1acc7fa1646073ecb4faa4fe3917cf09f7a04950ac769ee9a97186eda302371b6284c5

data/.gitignore

@@ -0,0 +1,25 @@
+*.rbc
+*.o
+*.so
+*.bundle
+*.bak
+mkmf.log
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+XTAGS
+ext/seven_zip_ruby/Makefile
+ext/seven_zip_ruby/*.def
+ext/seven_zip_ruby/*.pdb
+ext/p7zip/makefile.machine

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "2.0.0"
+cache:
+  - apt
+before_install:
+  - bundle install --path=vendor/bundle
+  - sudo apt-get install p7zip-full
+install: bundle exec rake build_local
+script: bundle exec rspec spec/seven_zip_ruby_spec.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,39 @@
+Copyright (c) 2013 Masamitsu MURASE
+
+SevenZipRuby
+
+  The GNU LGPL + unRAR restriction means that you must follow both 
+  GNU LGPL rules and unRAR restriction rules.
+
+  GNU LGPL information
+  --------------------
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Lesser General Public
+    License as published by the Free Software Foundation; either
+    version 2.1 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Lesser General Public License for more details.
+
+    You can receive a copy of the GNU Lesser General Public License from 
+    http://www.gnu.org/
+
+
+  unRAR restriction
+  -----------------
+
+    The decompression engine for RAR archives was developed using source 
+    code of unRAR program.
+    All copyrights to original unRAR code are owned by Alexander Roshal.
+
+    The license for original unRAR code has the following restriction:
+
+      The unRAR sources cannot be used to re-create the RAR compression algorithm, 
+      which is proprietary. Distribution of modified unRAR sources in separate form 
+      or as a part of other software is permitted, provided that it is clearly
+      stated in the documentation and source comments that the code may
+      not be used to develop a RAR (WinRAR) compatible archiver.
+

data/README.md

@@ -0,0 +1,176 @@
+# SevenZipRuby ![Logo](https://raw.github.com/masamitsu-murase/seven_zip_ruby/master/resources/seven_zip_ruby_logo.png)
+
+[![Build Status](https://travis-ci.org/masamitsu-murase/seven_zip_ruby.png?branch=master)](https://travis-ci.org/masamitsu-murase/seven_zip_ruby)
+
+This is a Ruby gem library to handle [7-Zip](http://www.7-zip.org) archives.
+
+This extension calls the native library, 7z.dll or 7z.so, internally and it is included in this gem.
+
+## Features
+* Use official DLL, 7z.dll, internally.
+* Support extracting data into memory.
+
+## Examples
+
+**This is a beta version.**  
+The interfaces may be changed.
+
+If you have any comments about interface API, let me know please.
+
+### Extract archive
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.open(file) do |szr|
+    szr.extract_all "path_to_dir"
+  end
+end
+```
+
+You can also use handy method.
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.extract_all(file, "path_to_dir")
+end
+```
+
+### Show entries in archive
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.open(file) do |szr|
+    list = szr.entries
+    p list
+    # => [ "#<EntryInfo: 0, dir, dir/subdir>", "#<EntryInfo: 1, file, dir/file.txt>", ... ]
+  end
+end
+```
+
+### Extract encrypted archive
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.open(file, { password: "Password String" }) do |szr|
+    szr.extract_all "path_to_dir"
+  end
+end
+```
+or
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.extract_all(file, "path_to_dir", { password: "Password String" })
+end
+```
+
+
+### Verify archive
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.verify(file)
+  # => true/false
+end
+```
+
+### Compress files
+```ruby
+File.open("filename.7z", "wb") do |file|
+  SevenZipRuby::Writer.open(file) do |szr|
+    szr.add_directory("dir")
+  end
+end
+```
+or
+```ruby
+File.open("filename.7z", "wb") do |file|
+  SevenZipRuby::Writer.add_directory(file, "dir")
+end
+```
+
+## Supported platforms
+
+* Windows
+* Linux
+* Mac OSX
+
+## More examples
+
+### Extract partially
+
+Extract files whose size is less than 1024.
+
+```ruby
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.open(file) do |szr|
+    small_files = szr.entries.select{ |i| i.file? && i.size < 1024 }
+    szr.extract(small_files, "path_to_dir")
+  end
+end
+```
+
+### Get data from archive
+
+Extract data into memory.
+
+```ruby
+data = nil
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Reader.open(file) do |szr|
+    smallest_file = szr.entries.select(&:file?).min_by(&:size)
+    data = szr.extract_data(smallest_file)
+  end
+end
+p data
+#  => File content is shown.
+
+### Create archive manually
+
+```
+File.open("filename.7z", "rb") do |file|
+  SevenZipRuby::Writer.open(file) do |szr|
+    szr.add_file "entry1.txt"
+    szr.mkdir "dir1"
+    szr.mkdir "dir2"
+
+    data = [0, 1, 2, 3, 4].pack("C*")
+    szr.add_data data, "entry2.txt"
+  end
+end
+```
+
+### Set compression mode
+
+7zip supports LZMA, LZMA2, PPMD, BZIP2, DEFLATE and COPY.  
+
+```ruby
+# random data
+data = 50000000.to_enum(:times).map{ rand(256) }.pack("C*")
+
+a = StringIO.new("")
+start = Time.now
+SevenZipRuby::Writer.open(a) do |szr|
+  szr.method = "BZIP2"     # Set compression method to "BZIP2"
+  szr.multi_thread = false # Disable multi-threading mode
+  szr.add_data(data, "test.bin")
+end
+p(Time.now - start)
+#  => 11.180934
+
+a = StringIO.new("")
+start = Time.now
+SevenZipRuby::Writer.open(a) do |szr|
+  szr.method = "BZIP2"     # Set compression method to "BZIP2"
+  szr.multi_thread = true  # Enable multi-threading mode (default)
+  szr.add_data(data, "test.bin")
+end
+p(Time.now - start)
+#  => 3.607563    # Faster than single-threaded compression.
+```
+
+
+## TODO
+
+* Support file attributes on Linux and Mac OSX.
+* Support updating archive.
+* Support extracting rar archive.
+
+
+## License
+LGPL and unRAR license. Please refer to LICENSE.txt.
+

data/Rakefile

@@ -0,0 +1,47 @@
+require "fileutils"
+require "bundler/gem_tasks"
+
+BINARY_FILES = [ "seven_zip_archive.so", "seven_zip_archive.bundle" ]
+MAKE = (ENV["MAKE"] || ENV["make"] || (RUBY_PLATFORM.include?("mswin") ? "nmake" : "make"))
+
+task :build_platform => [ :pre_platform, :build, :post_platform ]
+
+task :pre_platform do
+  FileUtils.mv("seven_zip_ruby.gemspec", "seven_zip_ruby.gemspec.bak")
+  FileUtils.cp("resources/seven_zip_ruby.gemspec.platform", "seven_zip_ruby.gemspec")
+end
+
+task :post_platform do
+  FileUtils.mv("seven_zip_ruby.gemspec.bak", "seven_zip_ruby.gemspec")
+end
+
+
+task :build_local_all => [ :build_local_clean, :build_local ]
+task :build_local => [ :build_binary, :copy_binary ]
+
+task :build_local_clean do
+  Dir.chdir "ext/seven_zip_ruby" do
+    sh("#{MAKE} clean") if (File.exist?("Makefile"))
+  end
+
+  [ "ext/seven_zip_ruby", "lib/seven_zip_ruby" ].each do |dir|
+    FileUtils.rmtree(BINARY_FILES.map{ |i| "#{dir}/#{i}" })
+  end
+end
+
+task :build_binary do
+  Dir.chdir "ext/seven_zip_ruby" do
+    FileUtils.rmtree BINARY_FILES
+    sh "ruby extconf.rb"
+    sh "#{MAKE}"
+  end
+end
+
+task :copy_binary do
+  BINARY_FILES.each do |file|
+    src = File.join("ext", "seven_zip_ruby", file)
+    dest = File.join("lib", "seven_zip_ruby", file)
+    FileUtils.rmtree(dest) if (File.exist?(dest))
+    FileUtils.cp(src, dest) if (File.exist?(src))
+  end
+end

data/ext/C/Types.h

@@ -0,0 +1,254 @@
+/* Types.h -- Basic types
+2010-10-09 : Igor Pavlov : Public domain */
+
+#ifndef __7Z_TYPES_H
+#define __7Z_TYPES_H
+
+#include <stddef.h>
+
+#ifdef _WIN32
+#include <windows.h>
+#endif
+
+#ifndef EXTERN_C_BEGIN
+#ifdef __cplusplus
+#define EXTERN_C_BEGIN extern "C" {
+#define EXTERN_C_END }
+#else
+#define EXTERN_C_BEGIN
+#define EXTERN_C_END
+#endif
+#endif
+
+EXTERN_C_BEGIN
+
+#define SZ_OK 0
+
+#define SZ_ERROR_DATA 1
+#define SZ_ERROR_MEM 2
+#define SZ_ERROR_CRC 3
+#define SZ_ERROR_UNSUPPORTED 4
+#define SZ_ERROR_PARAM 5
+#define SZ_ERROR_INPUT_EOF 6
+#define SZ_ERROR_OUTPUT_EOF 7
+#define SZ_ERROR_READ 8
+#define SZ_ERROR_WRITE 9
+#define SZ_ERROR_PROGRESS 10
+#define SZ_ERROR_FAIL 11
+#define SZ_ERROR_THREAD 12
+
+#define SZ_ERROR_ARCHIVE 16
+#define SZ_ERROR_NO_ARCHIVE 17
+
+typedef int SRes;
+
+#ifdef _WIN32
+typedef DWORD WRes;
+#else
+typedef int WRes;
+#endif
+
+#ifndef RINOK
+#define RINOK(x) { int __result__ = (x); if (__result__ != 0) return __result__; }
+#endif
+
+typedef unsigned char Byte;
+typedef short Int16;
+typedef unsigned short UInt16;
+
+#ifdef _LZMA_UINT32_IS_ULONG
+typedef long Int32;
+typedef unsigned long UInt32;
+#else
+typedef int Int32;
+typedef unsigned int UInt32;
+#endif
+
+#ifdef _SZ_NO_INT_64
+
+/* define _SZ_NO_INT_64, if your compiler doesn't support 64-bit integers.
+   NOTES: Some code will work incorrectly in that case! */
+
+typedef long Int64;
+typedef unsigned long UInt64;
+
+#else
+
+#if defined(_MSC_VER) || defined(__BORLANDC__)
+typedef __int64 Int64;
+typedef unsigned __int64 UInt64;
+#define UINT64_CONST(n) n
+#else
+typedef long long int Int64;
+typedef unsigned long long int UInt64;
+#define UINT64_CONST(n) n ## ULL
+#endif
+
+#endif
+
+#ifdef _LZMA_NO_SYSTEM_SIZE_T
+typedef UInt32 SizeT;
+#else
+typedef size_t SizeT;
+#endif
+
+typedef int Bool;
+#define True 1
+#define False 0
+
+
+#ifdef _WIN32
+#define MY_STD_CALL __stdcall
+#else
+#define MY_STD_CALL
+#endif
+
+#ifdef _MSC_VER
+
+#if _MSC_VER >= 1300
+#define MY_NO_INLINE __declspec(noinline)
+#else
+#define MY_NO_INLINE
+#endif
+
+#define MY_CDECL __cdecl
+#define MY_FAST_CALL __fastcall
+
+#else
+
+#define MY_CDECL
+#define MY_FAST_CALL
+
+#endif
+
+
+/* The following interfaces use first parameter as pointer to structure */
+
+typedef struct
+{
+  Byte (*Read)(void *p); /* reads one byte, returns 0 in case of EOF or error */
+} IByteIn;
+
+typedef struct
+{
+  void (*Write)(void *p, Byte b);
+} IByteOut;
+
+typedef struct
+{
+  SRes (*Read)(void *p, void *buf, size_t *size);
+    /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.
+       (output(*size) < input(*size)) is allowed */
+} ISeqInStream;
+
+/* it can return SZ_ERROR_INPUT_EOF */
+SRes SeqInStream_Read(ISeqInStream *stream, void *buf, size_t size);
+SRes SeqInStream_Read2(ISeqInStream *stream, void *buf, size_t size, SRes errorType);
+SRes SeqInStream_ReadByte(ISeqInStream *stream, Byte *buf);
+
+typedef struct
+{
+  size_t (*Write)(void *p, const void *buf, size_t size);
+    /* Returns: result - the number of actually written bytes.
+       (result < size) means error */
+} ISeqOutStream;
+
+typedef enum
+{
+  SZ_SEEK_SET = 0,
+  SZ_SEEK_CUR = 1,
+  SZ_SEEK_END = 2
+} ESzSeek;
+
+typedef struct
+{
+  SRes (*Read)(void *p, void *buf, size_t *size);  /* same as ISeqInStream::Read */
+  SRes (*Seek)(void *p, Int64 *pos, ESzSeek origin);
+} ISeekInStream;
+
+typedef struct
+{
+  SRes (*Look)(void *p, const void **buf, size_t *size);
+    /* if (input(*size) != 0 && output(*size) == 0) means end_of_stream.
+       (output(*size) > input(*size)) is not allowed
+       (output(*size) < input(*size)) is allowed */
+  SRes (*Skip)(void *p, size_t offset);
+    /* offset must be <= output(*size) of Look */
+
+  SRes (*Read)(void *p, void *buf, size_t *size);
+    /* reads directly (without buffer). It's same as ISeqInStream::Read */
+  SRes (*Seek)(void *p, Int64 *pos, ESzSeek origin);
+} ILookInStream;
+
+SRes LookInStream_LookRead(ILookInStream *stream, void *buf, size_t *size);
+SRes LookInStream_SeekTo(ILookInStream *stream, UInt64 offset);
+
+/* reads via ILookInStream::Read */
+SRes LookInStream_Read2(ILookInStream *stream, void *buf, size_t size, SRes errorType);
+SRes LookInStream_Read(ILookInStream *stream, void *buf, size_t size);
+
+#define LookToRead_BUF_SIZE (1 << 14)
+
+typedef struct
+{
+  ILookInStream s;
+  ISeekInStream *realStream;
+  size_t pos;
+  size_t size;
+  Byte buf[LookToRead_BUF_SIZE];
+} CLookToRead;
+
+void LookToRead_CreateVTable(CLookToRead *p, int lookahead);
+void LookToRead_Init(CLookToRead *p);
+
+typedef struct
+{
+  ISeqInStream s;
+  ILookInStream *realStream;
+} CSecToLook;
+
+void SecToLook_CreateVTable(CSecToLook *p);
+
+typedef struct
+{
+  ISeqInStream s;
+  ILookInStream *realStream;
+} CSecToRead;
+
+void SecToRead_CreateVTable(CSecToRead *p);
+
+typedef struct
+{
+  SRes (*Progress)(void *p, UInt64 inSize, UInt64 outSize);
+    /* Returns: result. (result != SZ_OK) means break.
+       Value (UInt64)(Int64)-1 for size means unknown value. */
+} ICompressProgress;
+
+typedef struct
+{
+  void *(*Alloc)(void *p, size_t size);
+  void (*Free)(void *p, void *address); /* address can be 0 */
+} ISzAlloc;
+
+#define IAlloc_Alloc(p, size) (p)->Alloc((p), size)
+#define IAlloc_Free(p, a) (p)->Free((p), a)
+
+#ifdef _WIN32
+
+#define CHAR_PATH_SEPARATOR '\\'
+#define WCHAR_PATH_SEPARATOR L'\\'
+#define STRING_PATH_SEPARATOR "\\"
+#define WSTRING_PATH_SEPARATOR L"\\"
+
+#else
+
+#define CHAR_PATH_SEPARATOR '/'
+#define WCHAR_PATH_SEPARATOR L'/'
+#define STRING_PATH_SEPARATOR "/"
+#define WSTRING_PATH_SEPARATOR L"/"
+
+#endif
+
+EXTERN_C_END
+
+#endif