Unzipping archive from Ruby (Mac and Windows)

[tt_su]

@eneroth3 said:

What sort of license applies to unzip.exe? I cannot find it anywhere and I'd like to use it for my next plugin.

Unless you need support for SketchUp older than SU2014 I'd go with the zip gem that john mentions.

[eneroth3]

Thanks! The gem rubyzip gem does exactly what I wanted .

However I don't know what's the best practice to use a gem. Should I ask the user to install it or should I check if it exists when the plugin loads and otherwise install it? Should I in that case use statusbar texts to tell the user the gem is being installed and that it may take some time?

[driven]

It only instals into Sketchup gems, so if they want your plugin they will need it...

If it not already installed:
I guess you could ask if they want the download or to use 'your' supplied copy, but you would need to keep 'yours' up to date as other plugins use it already...

it's very fast to load, did you try?

Definitely mention it in your documentation...

john

[TIG]

There are 'built-in' zip and unzip methods in Ruby2 - using 'zlib', with no gems.
See my ZipUp Plugin which uses its own shipped rubies to make things easier [Rubyzip].
https://github.com/rubyzip/rubyzip
Mine also uses some js and system zipping [MAC is easy, but on WIN is convoluted] when it's older SketchUp versions, < Ruby2...
It's in an RBS, but suffice it to say that it uses the additional zip.rb loaded commands to make the Ruby2 'zlib' code much less cumbersome to use...

[eneroth3]

It took me 69,12 seconds to install the gem :S . I think I have a quite good Internet connection, at least a decent one, but it might be my dying hard drive.

I still suppose it's better to download the most current version than rely on something I pack with the plugin. If I pack it with my files I suppose it has to be in my own namespace to avoid collisions if another plugin requires a newer version.

Perhaps there should be a web dialog telling the user the gem is being installed so they know Sketchup hasn't just frozen.

[driven]

it really depends on what your zipping/unzipping...
for mac the system zip and unzip are the cleanest and fastest...
I use it on .skm's and .layout's mainly.
for .rbz I use Sketchup.install_from_archive and let SU move the files...

[eneroth3]

TIG: I experimented a little with Zlib before but I couldn't find a way to save multiple files in the same archive which I need for my plugin, it doesn't seem to be supported.

[TIG]

Mine only loads zlib.so and requires the ruby zip.rb stuff if it's not already been installed.
So if another plugin already installed it it uses that.
You can of course so it entirely in vbs/mac-shell for all versions....
These are all inside begin/rescue/ensure sections...
` require('zlib') unless defined?(Zlib)

in case it is already loaded, and in case it fails it's in a 'rescue'`

To allow my require('zip') to work I briefly add the path to the plugins own subfolder into $: thus:
` ...
rubyzip=File.join(DATA, 'Rubyzip')

where DATA is a constant referring to that plugin's subfolder named 'Rubyzip'

$: << rubyzip
...
require('zip') unless defined?(Zip)

in case not already installed by another plugin...

...
$:.delete(rubyzip)

to tidy up, ad it's no longer needed...

...`

The Rubyzip methods allow you to add multiple files into a ZIP file - in fact you can do most ZIP/unZIP things with it in conjunction with zlib...

[TIG]

Using Rubyzip...

zipped = Zip;;File.open(zip, Zip;;File;;CREATE) do |zipfile|
  # - The name of the file as it will appear in the archive
  # - The original file, including the path to find it
  zipfile.add(skp, tempskp)
  zipfile.add(txt, temptxt)
end

This opens a ZIP file, whose full-path ref is 'zip' [in this case a new one].
It then adds a file to that ZIP, whose full-path ref is in 'tempskp', and which will appear in the ZIP as the reference 'skp' - in this case it's the SKP's name...
It then adds another file to the ZIP, whose full-path ref is in 'temptxt', and which will appear in the ZIP as the reference 'txt' - in this case it's the TXT file's name...
You can also add subfolders etc as desired - read the Rubyzip usage notes...

You don't need to install the 'gem' for the users - just look how I am pre-including them in ../PluginsZipUp/Data/Rubyzip ... with the RBZ installer...

[driven]

@tig
how do you 'test' a zipped folder with Rubyzip?

for example with unzip you have the -t flag...

      def is_texture(file)
        %x( unzip -t "#{file}"  ).include? "ref\/.*g" # file = path to skm and ref/ means it has a texture folder
      end

[TIG]

Yours is the simple MAC way !
You can find/read the contents of an existing ZIP for a match in this kind of example...

Zip;;File.open(path_to_some_foo_zip') do |zip_file|
  # Handle entries one by one
  zip_file.each do |entry|
    # Extract to file/directory/symlink
    puts "Extracting #{entry.name}"
    entry.extract(dest_file)
    # Read into memory
    content = entry.get_input_stream.read
  end
  # Find specific entry
  entry = zip_file.glob('*.csv').first
  puts entry.get_input_stream.read
end

You need to set up your reference variables...

[eneroth3]

These examples use rubyzip but from a subdirectory rather than a Gem. Is it possible to only use the Zlib without rubyzip to put multiple files in the same zip archive?

I use these archives to store information for what can be drawn with my plugin. In my previous plugin I stored railroad tracks in a similar way but in their own folders instead of archives. Each folder contained a few .skp models for things to draw when drawing the track, e.g profiles, a preview image for web dialogs and a text file containing some information dynamically displayed in the web dialogs without loading the models and littering the definition list.

In this project I want to store all that data in one single file to make it easier for users to exchange them. I've already managed to do that but I don't know what's considered best practice, installing a Gem or copy the code into my own plugin's folder.

[driven]

have you tried this...

system( 'ROBOCOPY', files_directory, new_zip_folder_path )

if it works [I don't have a PC to test], The mac version is almost the same...

system('zip', '-r', new_zip_folder_path,  files_directory)

john

[TIG]

Your MAC ' zip' example is much like I use on older SketchUp version MACs with no Ruby zip built-in [with -q ?].

Your ' ROBOCOPY' examples just makes a copy of the files in the source-folder in a new folder named ' xxxx.zip' - not zipped ! and it flashes up a black cmd window - just like in any WIN system call.

On PCs you can make a longer set of strings that are VB commands. and put them into a ' xxxx.vbs' file which then runs silently using UI.openURL("file:///#{path_to_vbs_file}"), and it will make a proper ZIP file... I use that in older SketchUp version PCs with no Ruby zip built-in.

txt="Const FOF_CREATEPROGRESSDLG = &H0&
Const MyZip = \"#{zip.tr("/","\\")}\"
Const File1 = \"#{tskp1.tr("/","\\")}\"
Const File2 = \"#{tskp2.tr("/","\\")}\"
'Create the basis of new zip file
CreateObject(\"Scripting.FileSystemObject\").CreateTextFile(MyZip, True).Write \"PK\" & Chr(5) & Chr(6) & String(18, vbNullChar)
'get ready to add files to zip
With CreateObject(\"Shell.Application\")
'add files
.NameSpace(MyZip).CopyHere File1, FOF_CREATEPROGRESSDLG
wScript.Sleep 200
.NameSpace(MyZip).CopyHere File2
End With
' wait 3 secs, to let it finish...
wScript.Sleep 3000
'''

Where ' zip' is the path to the new ZIP file, and ' tskp1' etc paths to SKP files - the tr makes / into \ for VBS use
You can get it to write a temp txt file at the end so you know it's done...

[fredo6]

Yes, I noticed there is a Zip module that seems to ship in Ruby 2.0 in the standard Sketchup installation.

I did not find the documentation however, but this could be the answer, at least for SU2014 and SU2015.

Fredo

[driven]

301 Moved Permanently

(ruby-doc.org)

[tt_su]

@eneroth3 said:

Thanks! The gem rubyzip gem does exactly what I wanted .

However I don't know what's the best practice to use a gem. Should I ask the user to install it or should I check if it exists when the plugin loads and otherwise install it? Should I in that case use statusbar texts to tell the user the gem is being installed and that it may take some time?

What I've done is wrap the require in a begin/rescue that catch LoadErrors (you don't want to catch other errors) and then use Gem.install to install it if it's missing.

[tt_su]

@fredo6 said:

Yes, I noticed there is a Zip module that seems to ship in Ruby 2.0 in the standard Sketchup installation.

I did not find the documentation however, but this could be the answer, at least for SU2014 and SU2015.

Fredo

It doesn't support ZIP files, it for general compression and GZ files.

[driven]

cheers for the explanation...

as I follow up to your last reply, this works on mac...

      def is_texture(file)
          result = false
          Zip;;InputStream;;open(file) {|io|
            while (entry = io.get_next_entry)
              result = true if entry.to_s.include? "ref\/"
            end
          result
          }
      end

could you test on Win with a skm path as file...
john
EDIT: added result = false although it is working...

[fredo6]

@driven said:

301 Moved Permanently

(ruby-doc.org)

This is ZLib. Is the Zip module just a wrapper of it?

Fredo