zipruby 0.3.0 → 0.3.1

data/ChangeLog

@@ -0,0 +1,10 @@
+2009-05-16 winebarrel
+
+	* improve Zip::Archive#open_buffer, add_io, replace_io, replace_function
+
+	* fixes bug: Zip::Archive#add_io, <<
+
+	* add method: Zip::Archive#add_dir
+
+	* zipruby/README.txt: fixes example code.
+

data/README.txt

@@ -68,32 +68,36 @@ https://rubyforge.org/frs/?group_id=6124
 
     require 'zipruby'
     
+    bar_txt =  open('bar.txt')
+    
     Zip::Archive.open('filename.zip', Zip::CREATE) do |ar|
-      ar.add_file('foo.txt') # add file to zip archive
+      # if overwrite: ..., Zip::CREATE | Zip::TRUNC) do |ar|
+    
+        ar.add_file('foo.txt') # add file to zip archive
     
       # add file to zip archive from File object
-      open('bar.txt') do |f|
-        ar << f # or ar.add_io(f)
-      end
+      ar << bar_txt # or ar.add_io(bar_txt)
     
       # add file to zip archive from buffer
       ar.add_buffer('zoo.txt', 'Hello, world!')
     end
     
+    bar_txt.rewind
+    
     # include directory in zip archive
     Zip::Archive.open('filename.zip') do |ar|
       ar.add_file('dirname/foo.txt', 'foo.txt')
-          # args: <entry name>,      <source>
+          # args: <entry name>     ,  <source>
     
-      open('bar.txt') do |f|
-        ar.add_io('dirname/bar.txt', f)
-             # args: <entry name>,      <source>
-      end
+      ar.add_io('dirname/bar.txt', bar_txt)
+        # args: <entry name>     , <source>
     
       ar.add_buffer('dirname/zoo.txt', 'Hello, world!')
-            # args: <entry name>,      <source>
+            # args: <entry name>     , <source>
     end
     
+    bar_txt.close # close file after archive closed
+    
     # add huge file
     source = %w(London Bridge is falling down)
     
@@ -108,18 +112,18 @@ https://rubyforge.org/frs/?group_id=6124
 
     require 'zipruby'
     
+    bar_txt = open('bar.txt')
+    
     Zip::Archive.open('filename.zip') do |ar|
       # replace file in zip archive
       ar.replace_file(0, 'foo.txt')
     
       # replace file in zip archive with File object
-      open('bar.txt') do |f|
-        ar.replace_io(1, f)
-      end
-      
+      ar.replace_io(1, bar_txt)
+    
       # if commit changes
       # ar.commit
-     
+    
       # replace file in zip archive with buffer
       ar.replace_buffer(2, 'Hello, world!')
       # or
@@ -128,7 +132,7 @@ https://rubyforge.org/frs/?group_id=6124
       # ar.replace_buffer('entry name', 'Hello, world!', Zip::FL_NOCASE)
       
       # add or replace file in zip archive
-      ar.add_or_replace_file(3, 'foo.txt')
+      ar.add_or_replace_file('zoo.txt', 'foo.txt')
     end
     
     # append comment    
@@ -140,6 +144,8 @@ https://rubyforge.org/frs/?group_id=6124
       EOS
     end
     
+    bar_txt.close # close file after archive closed
+    
     # ar1 import ar2 entries
     Zip::Archive.open('ar1.zip') do |ar1|
       Zip::Archive.open('ar2.zip') do |ar2|
@@ -152,16 +158,16 @@ https://rubyforge.org/frs/?group_id=6124
     require 'zipruby'
     
     # encrypt
-    Zip::Archive.encrypt('filename.zip', 'password')
+    Zip::Archive.encrypt('filename.zip', 'password') # return true if encrypted
     # or
-    # Zip::Archive.encrypt('filename.zip') do |ar|
+    # Zip::Archive.open('filename.zip') do |ar|
     #   ar.encrypt('password')
     # end
     
     # decrypt
-    Zip::Archive.decrypt('filename.zip', 'password')
+    Zip::Archive.decrypt('filename.zip', 'password') # return true if encrypted
     # or
-    # Zip::Archive.decrypt('filename.zip') do |ar|
+    # Zip::Archive.open('filename.zip') do |ar|
     #   ar.decrypt('password')
     # end
 
@@ -182,10 +188,14 @@ https://rubyforge.org/frs/?group_id=6124
         puts f.name
       end
     end
-
-    # read from stream    
-    zip_data = open('foo.zip').raed
-    stream = lambda { return !zip_data.slice(0, 256) }
+    
+    # read from stream
+    zip_data = open('foo.zip') do |f|
+      f.binmode
+      f.read
+    end
+    
+    stream = lambda { return zip_data.slice!(0, 256) }
     
     Zip::Archive.open_buffer(stream) do |ar|
       puts ar.num_files
@@ -198,7 +208,44 @@ https://rubyforge.org/frs/?group_id=6124
       end
     end
 
+=== adding directory recursively
+
+    require 'zipruby'
+    
+    Zip::Archive.open('filename.zip', Zip::CREATE) do |ar|
+      ar.add_dir('dir')
+    
+      Dir.glob('dir/**/*').each do |path|
+        if File.directory?(path)
+          ar.add_dir(path)
+        else
+          ar.add_file(path, path) # add_file(<entry name>, <source path>)
+        end
+      end
+    end
+
+=== extract all files
+
+    require 'zipruby'
+    require 'fileutils'
+    
+    Zip::Archive.open('filename.zip') do |ar|
+      ar.each do |zf|
+        if zf.directory?
+          FileUtils.mkdir_p(zf.name)
+        else
+          dirname = File.dirname(zf.name)
+          FileUtils.mkdir_p(dirname) unless File.exist?(dirname)
+    
+          open(zf.name, 'wb') do |f|
+            f << zf.read
+          end
+        end
+      end
+    end
+
 == License
+
     Copyright (c) 2008,2009 SUGAWARA Genki <sgwr_dts@yahoo.co.jp>
     All rights reserved.
     
@@ -226,6 +273,7 @@ https://rubyforge.org/frs/?group_id=6124
     DAMAGE.
 
 === libzip
+
 Zip/Ruby contains libzip.
 
 libzip is a C library for reading, creating, and modifying zip archives.

data/ext/zipruby.h

@@ -19,7 +19,9 @@
   } \
 } while(0)
 
-#define VERSION "0.3.0"
+#define TIME2LONG(v) NUM2LONG(rb_funcall((v), rb_intern("tv_sec"), 0))
+
+#define VERSION "0.3.1"
 #define ERRSTR_BUFSIZE 256
 #define DATA_BUFSIZE 8192
 

data/ext/zipruby_archive.c

@@ -4,6 +4,7 @@
 #include "zipruby.h"
 #include "zipruby_archive.h"
 #include "zipruby_zip_source_proc.h"
+#include "zipruby_zip_source_io.h"
 #include "tmpfile.h"
 #include "ruby.h"
 #ifndef RUBY_VM
@@ -24,7 +25,7 @@ static VALUE zipruby_archive_fopen(int argc, VALUE *argv, VALUE self);
 static VALUE zipruby_archive_get_stat(int argc, VALUE *argv, VALUE self);
 static VALUE zipruby_archive_add_buffer(VALUE self, VALUE name, VALUE source);
 static VALUE zipruby_archive_add_file(int argc, VALUE *argv, VALUE self);
-static VALUE zipruby_archive_add_io(VALUE self, VALUE name, VALUE io);
+static VALUE zipruby_archive_add_io(int argc, VALUE *argv, VALUE self);
 static VALUE zipruby_archive_add_function(int argc, VALUE *argv, VALUE self);
 static VALUE zipruby_archive_replace_buffer(int argc, VALUE *argv, VALUE self);
 static VALUE zipruby_archive_replace_file(int argc, VALUE* argv, VALUE self);
@@ -52,6 +53,7 @@ static VALUE zipruby_archive_is_open(VALUE self);
 static VALUE zipruby_archive_decrypt(VALUE self, VALUE password);
 static VALUE zipruby_archive_encrypt(VALUE self, VALUE password);
 static VALUE zipruby_archive_read(VALUE self);
+static VALUE zipruby_archive_add_dir(VALUE self, VALUE name);
 
 extern VALUE Zip;
 VALUE Archive;
@@ -74,7 +76,7 @@ void Init_zipruby_archive() {
   rb_define_method(Archive, "get_stat", zipruby_archive_get_stat, -1);
   rb_define_method(Archive, "add_buffer", zipruby_archive_add_buffer, 2);
   rb_define_method(Archive, "add_file", zipruby_archive_add_file, -1);
-  rb_define_method(Archive, "add_io", zipruby_archive_add_io, 2);
+  rb_define_method(Archive, "add_io", zipruby_archive_add_io, -1);
   rb_define_method(Archive, "add", zipruby_archive_add_function, -1);
   rb_define_method(Archive, "replace_buffer", zipruby_archive_replace_buffer, -1);
   rb_define_method(Archive, "replace_file", zipruby_archive_replace_file, -1);
@@ -85,7 +87,7 @@ void Init_zipruby_archive() {
   rb_define_method(Archive, "add_or_replace_io", zipruby_archive_add_or_replace_io, -1);
   rb_define_method(Archive, "add_or_replace", zipruby_archive_add_or_replace_function, -1);
   rb_define_method(Archive, "update", zipruby_archive_update, -1);
-  rb_define_method(Archive, "<<", zipruby_archive_add_io, 2);
+  rb_define_method(Archive, "<<", zipruby_archive_add_io, -1);
   rb_define_method(Archive, "get_comment", zipruby_archive_get_comment, -1);
   rb_define_method(Archive, "comment", zipruby_archive_get_comment, -1);
   rb_define_method(Archive, "comment=", zipruby_archive_set_comment, 1);
@@ -105,6 +107,7 @@ void Init_zipruby_archive() {
   rb_define_method(Archive, "decrypt", zipruby_archive_decrypt, 1);
   rb_define_method(Archive, "encrypt", zipruby_archive_encrypt, 1);
   rb_define_method(Archive, "read", zipruby_archive_read, 0);
+  rb_define_method(Archive, "add_dir", zipruby_archive_add_dir, 1);
 }
 
 static VALUE zipruby_archive_alloc(VALUE klass) {
@@ -641,28 +644,122 @@ static VALUE zipruby_archive_add_or_replace_file(int argc, VALUE *argv, VALUE se
 }
 
 /* */
-static VALUE zipruby_archive_add_io(VALUE self, VALUE name, VALUE io) {
-  VALUE source;
+static VALUE zipruby_archive_add_io(int argc, VALUE *argv, VALUE self) {
+  VALUE name, file, mtime;
+  struct zipruby_archive *p_archive;
+  struct zip_source *zsource;
+  struct read_io *z;
 
-  Check_IO(io);
-  source = rb_funcall(io, rb_intern("read"), 0);
+  rb_scan_args(argc, argv, "11", &name, &file);
+
+  if (NIL_P(file)) {
+    file = name;
+    name = Qnil;
+  }
+
+  Check_IO(file);
+
+  if (NIL_P(name)) {
+    if (rb_obj_is_kind_of(file, rb_cFile)) {
+      name = rb_funcall(rb_cFile, rb_intern("basename"), 1, rb_funcall(file, rb_intern("path"), 0));
+    } else {
+      rb_raise(rb_eRuntimeError, "Add io failed - %s: Entry name is not given", RSTRING(rb_inspect(file)));
+    }
+  }
+
+  if (rb_obj_is_kind_of(file, rb_cFile)) {
+    mtime = rb_funcall(file, rb_intern("mtime"), 0);
+  } else {
+    mtime = rb_funcall(rb_cTime, rb_intern("now"), 0);
+  }
+
+  Data_Get_Struct(self, struct zipruby_archive, p_archive); 
+  Check_Archive(p_archive);
+
+  if ((z = malloc(sizeof(struct read_io))) == NULL) {
+    zip_unchange_all(p_archive->archive);
+    zip_unchange_archive(p_archive->archive);
+    rb_raise(rb_eRuntimeError, "Add io failed - %s: Cannot allocate memory", RSTRING(rb_inspect(file)));
+  }
+
+  z->io = file;
+  z->mtime = TIME2LONG(mtime);
+
+  if ((zsource = zip_source_io(p_archive->archive, z)) == NULL) {
+    free(z);
+    rb_raise(Error, "Add io failed - %s: %s", RSTRING(rb_inspect(file)), zip_strerror(p_archive->archive));
+  }
 
-  return zipruby_archive_add_buffer(self, name,  source);
+  if (zip_add(p_archive->archive, RSTRING_PTR(name), zsource) == -1) {
+    zip_source_free(zsource);
+    zip_unchange_all(p_archive->archive);
+    zip_unchange_archive(p_archive->archive);
+    rb_raise(Error, "Add io failed - %s: %s", RSTRING_PTR(name), zip_strerror(p_archive->archive));
+  }
+
+  return Qnil;
 }
 
 /* */
 static VALUE zipruby_archive_replace_io(int argc, VALUE *argv, VALUE self) {
-  VALUE source, io, index, flags;
-  VALUE _args[3];
+  VALUE file, index, flags, mtime;
+  struct zipruby_archive *p_archive;
+  struct zip_source *zsource;
+  struct read_io *z;
+  int i_index, i_flags = 0;
 
-  rb_scan_args(argc, argv, "21", &index, &io, &flags);
-  Check_IO(io);
-  source = rb_funcall(io, rb_intern("read"), 0);
+  rb_scan_args(argc, argv, "21", &index, &file, &flags);
+
+  if (TYPE(index) != T_STRING && !FIXNUM_P(index)) {
+    rb_raise(rb_eTypeError, "wrong argument type %s (expected Fixnum or String)", rb_class2name(CLASS_OF(index)));
+  }
+
+  Check_IO(file);
+
+  if (!NIL_P(flags)) {
+    i_flags = NUM2INT(flags);
+  }
+
+  if (rb_obj_is_kind_of(file, rb_cFile)) {
+    mtime = rb_funcall(file, rb_intern("mtime"), 0);
+  } else {
+    mtime = rb_funcall(rb_cTime, rb_intern("now"), 0);
+  }
+
+  Data_Get_Struct(self, struct zipruby_archive, p_archive);
+  Check_Archive(p_archive);
 
-  _args[0] = index;
-  _args[1] = source;
-  _args[2] = flags;
-  return zipruby_archive_replace_buffer(2, _args, self);
+  if (FIXNUM_P(index)) {
+    i_index = NUM2INT(index);
+  } else if ((i_index = zip_name_locate(p_archive->archive, RSTRING_PTR(index), i_flags)) == -1) {
+    rb_raise(Error, "Replace io failed - %s: Archive does not contain a file", RSTRING_PTR(index));
+  }
+
+  Data_Get_Struct(self, struct zipruby_archive, p_archive); 
+  Check_Archive(p_archive);
+
+  if ((z = malloc(sizeof(struct read_io))) == NULL) {
+    zip_unchange_all(p_archive->archive);
+    zip_unchange_archive(p_archive->archive);
+    rb_raise(rb_eRuntimeError, "Replace io failed at %d - %s: Cannot allocate memory", i_index, RSTRING(rb_inspect(file)));
+  }
+
+  z->io = file;
+  z->mtime = TIME2LONG(mtime);
+
+  if ((zsource = zip_source_io(p_archive->archive, z)) == NULL) {
+    free(z);
+    rb_raise(Error, "Replace io failed at %d - %s: %s", i_index, RSTRING(rb_inspect(file)), zip_strerror(p_archive->archive));
+  }
+
+  if (zip_replace(p_archive->archive, i_index, zsource) == -1) {
+    zip_source_free(zsource);
+    zip_unchange_all(p_archive->archive);
+    zip_unchange_archive(p_archive->archive);
+    rb_raise(Error, "Replace io failed at %d - %s: %s", i_index, RSTRING(rb_inspect(file)), zip_strerror(p_archive->archive));
+  }
+
+  return Qnil;
 }
 
 /* */
@@ -688,7 +785,8 @@ static VALUE zipruby_archive_add_or_replace_io(int argc, VALUE *argv, VALUE self
     VALUE _args[] = {INT2NUM(index), io, flags};
     return zipruby_archive_replace_io(2, _args, self);
   } else {
-    return zipruby_archive_add_io(self, name, io);
+    VALUE _args[2] = { name, io };
+    return zipruby_archive_add_io(2, _args, self);
   }
 }
 
@@ -719,7 +817,7 @@ static VALUE zipruby_archive_add_function(int argc, VALUE *argv, VALUE self) {
   }
 
   z->proc = rb_block_proc();
-  z->mtime = mtime;
+  z->mtime = TIME2LONG(mtime);
 
   if ((zsource = zip_source_proc(p_archive->archive, z)) == NULL) {
     free(z);
@@ -738,14 +836,18 @@ static VALUE zipruby_archive_add_function(int argc, VALUE *argv, VALUE self) {
 
 /* */
 static VALUE zipruby_archive_replace_function(int argc, VALUE *argv, VALUE self) {
-  VALUE index, mtime;
+  VALUE index, flags, mtime;
   struct zipruby_archive *p_archive;
   struct zip_source *zsource;
   struct read_proc *z;
+  int i_index, i_flags = 0;
 
-  rb_scan_args(argc, argv, "11", &index, &mtime);
+  rb_scan_args(argc, argv, "12", &index, &mtime, &flags);
   rb_need_block();
-  Check_Type(index, T_FIXNUM);
+
+  if (TYPE(index) != T_STRING && !FIXNUM_P(index)) {
+    rb_raise(rb_eTypeError, "wrong argument type %s (expected Fixnum or String)", rb_class2name(CLASS_OF(index)));
+  }
 
   if (NIL_P(mtime)) {
     mtime = rb_funcall(rb_cTime, rb_intern("now"), 0);
@@ -753,28 +855,38 @@ static VALUE zipruby_archive_replace_function(int argc, VALUE *argv, VALUE self)
     rb_raise(rb_eTypeError, "wrong argument type %s (expected Time)", rb_class2name(CLASS_OF(mtime)));
   }
 
+  if (!NIL_P(flags)) {
+    i_flags = NUM2INT(flags);
+  }
+
   Data_Get_Struct(self, struct zipruby_archive, p_archive); 
   Check_Archive(p_archive);
 
+  if (FIXNUM_P(index)) {
+    i_index = NUM2INT(index);
+  } else if ((i_index = zip_name_locate(p_archive->archive, RSTRING_PTR(index), i_flags)) == -1) {
+    rb_raise(Error, "Replace file failed - %s: Archive does not contain a file", RSTRING_PTR(index));
+  }
+
   if ((z = malloc(sizeof(struct read_proc))) == NULL) {
     zip_unchange_all(p_archive->archive);
     zip_unchange_archive(p_archive->archive);
-    rb_raise(rb_eRuntimeError, "Replace failed at %d: Cannot allocate memory", NUM2INT(index));
+    rb_raise(rb_eRuntimeError, "Replace failed at %d: Cannot allocate memory", i_index);
   }
 
   z->proc = rb_block_proc();
-  z->mtime = mtime;
+  z->mtime = TIME2LONG(mtime);
 
   if ((zsource = zip_source_proc(p_archive->archive, z)) == NULL) {
     free(z);
-    rb_raise(Error, "Replace failed at %d: %s", NUM2INT(index), zip_strerror(p_archive->archive));
+    rb_raise(Error, "Replace failed at %d: %s", i_index, zip_strerror(p_archive->archive));
   }
 
-  if (zip_replace(p_archive->archive, NUM2INT(index), zsource) == -1) {
+  if (zip_replace(p_archive->archive, i_index, zsource) == -1) {
     zip_source_free(zsource);
     zip_unchange_all(p_archive->archive);
     zip_unchange_archive(p_archive->archive);
-    rb_raise(Error, "Replace failed at %d: %s", NUM2INT(index), zip_strerror(p_archive->archive));
+    rb_raise(Error, "Replace failed at %d: %s", i_index, zip_strerror(p_archive->archive));
   }
 
   return Qnil;
@@ -1328,3 +1440,20 @@ static VALUE zipruby_archive_read(VALUE self) {
 
   return retval;
 }
+
+/* */
+static VALUE zipruby_archive_add_dir(VALUE self, VALUE name) {
+  struct zipruby_archive *p_archive;
+
+  Check_Type(name, T_STRING);
+  Data_Get_Struct(self, struct zipruby_archive, p_archive);
+  Check_Archive(p_archive);
+
+  if (zip_add_dir(p_archive->archive, RSTRING_PTR(name)) == -1) {
+    zip_unchange_all(p_archive->archive);
+    zip_unchange_archive(p_archive->archive);
+    rb_raise(Error, "Add dir failed - %s: %s", RSTRING_PTR(name), zip_strerror(p_archive->archive));
+  }
+
+  return Qnil;
+}

data/ext/zipruby_file.c

@@ -31,6 +31,7 @@ static VALUE zipruby_file_mtime(VALUE self);
 static VALUE zipruby_file_comp_size(VALUE self);
 static VALUE zipruby_file_comp_method(VALUE self);
 static VALUE zipruby_file_encryption_method(VALUE self);
+static VALUE zipruby_file_is_directory(VALUE self);
 
 extern VALUE Zip;
 extern VALUE Archive;
@@ -60,6 +61,7 @@ void Init_zipruby_file() {
   rb_define_method(File, "comp_size", zipruby_file_comp_size, 0);
   rb_define_method(File, "comp_method", zipruby_file_comp_method, 0);
   rb_define_method(File, "encryption_method", zipruby_file_encryption_method, 0);
+  rb_define_method(File, "directory?", zipruby_file_is_directory, 0);
 }
 
 static VALUE zipruby_file_alloc(VALUE klass) {
@@ -324,7 +326,7 @@ static VALUE zipruby_file_name(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("name"), 0);
+  return zipruby_stat_name(p_file->v_sb);
 }
 
 /* */
@@ -334,7 +336,7 @@ static VALUE zipruby_file_index(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("index"), 0);
+  return zipruby_stat_index(p_file->v_sb);
 }
 
 /* */
@@ -344,7 +346,7 @@ static VALUE zipruby_file_crc(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("crc"), 0);
+  return zipruby_stat_crc(p_file->v_sb);
 }
 
 /* */
@@ -354,7 +356,7 @@ static VALUE zipruby_file_size(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("size"), 0);
+  return zipruby_stat_size(p_file->v_sb);
 }
 
 /* */
@@ -364,7 +366,7 @@ static VALUE zipruby_file_mtime(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("mtime"), 0);
+  return zipruby_stat_mtime(p_file->v_sb);
 }
 
 /* */
@@ -374,7 +376,7 @@ static VALUE zipruby_file_comp_size(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("comp_size"), 0);
+  return zipruby_stat_comp_size(p_file->v_sb);
 }
 
 /* */
@@ -384,7 +386,7 @@ static VALUE zipruby_file_comp_method(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("comp_method"), 0);
+  return zipruby_stat_comp_method(p_file->v_sb);
 }
 
 /* */
@@ -394,5 +396,15 @@ static VALUE zipruby_file_encryption_method(VALUE self) {
   Data_Get_Struct(self, struct zipruby_file, p_file);
   Check_File(p_file);
 
-  return rb_funcall(p_file->v_sb, rb_intern("encryption_method"), 0);
+  return zipruby_stat_encryption_method(p_file->v_sb);
+}
+
+/* */
+static VALUE zipruby_file_is_directory(VALUE self) {
+  struct zipruby_file *p_file;
+
+  Data_Get_Struct(self, struct zipruby_file, p_file);
+  Check_File(p_file);
+
+  return zipruby_stat_is_directory(p_file->v_sb);
 }