el_finder 1.0.3 → 1.0.4

data/README.rdoc

@@ -9,13 +9,10 @@ open-source file manager for web, written in JavaScript using jQuery UI.
 
 == Features/Problems:
 
-* Does not yet support archive/extraction.
 * Does not yet support thumbnail generation.
 
 == Todo:
 
-* Add support for archive/extraction.
-* Add support for thumbnail generation.
 * Document library.
 * Document how to implement custom image size/resize methods.
 
@@ -46,7 +43,24 @@ the defaults.
     def elfinder
       h, r = ElFinder::Connector.new(
         :root => File.join(Rails.public_path, 'system', 'elfinder'),
-        :url => '/system/elfinder'
+        :url => '/system/elfinder',
+         :perms => {
+           /^(Welcome|README)$/ => {:read => true, :write => false, :rm => false},
+           '.' => {:read => true, :write => false, :rm => false}, # '.' is the proper way to specify the home/root directory.
+           /^test$/ => {:read => true, :write => true, :rm => false},
+           'logo.png' => {:read => true},
+           /\.png$/ => {:read => false} # This will cause 'logo.png' to be unreadable.  
+                                        # Permissions err on the safe side. Once false, always false.
+         },
+         :extractors => { 
+           'application/zip' => ['unzip', '-qq', '-o'], # Each argument will be shellescaped (also true for archivers)
+           'application/x-gzip' => ['tar', '-xzf'],
+         },
+         :archivers => { 
+           'application/zip' => ['.zip', 'zip', '-qr9'], # Note first argument is archive extension
+           'application/x-gzip' => ['.tgz', 'tar', '-czf'],
+           },
+
       ).run(params)
       headers.merge!(h)
       render (r.empty? ? {:nothing => true} : {:text => r.to_json}), :layout => false

data/lib/el_finder/connector.rb

@@ -13,8 +13,8 @@ module ElFinder
       :disabled_commands => [],
       :show_dot_files => true,
       :upload_max_size => '50M',
-      :archivers => [],
-      :extractors => [],
+      :archivers => {},
+      :extractors => {},
       :home => 'Home',
       :default_perms => {:read => true, :write => true, :rm => true},
       :perms => []
@@ -114,8 +114,8 @@ module ElFinder
           @response[:params] = {
             :dotFiles => @options[:show_dot_files],
             :uplMaxSize => @options[:upload_max_size],
-            :archives => @options[:archivers],
-            :extract => @options[:extractors],
+            :archives => @options[:archivers].keys,
+            :extract => @options[:extractors].keys,
             :url => @options[:url]
           }
         end
@@ -303,12 +303,33 @@ module ElFinder
 
     #
     def _extract
-      command_not_implemented
+      @response[:error] = 'Invalid Parameters' and return unless @target.file? && @current.directory?
+      @response[:error] = 'Access Denied' and return unless perms_for(@target)[:read] == true && perms_for(@current)[:write] == true
+      @response[:error] = 'No extractor available for this file type' and return if (extractor = @options[:extractors][mime_handler.for(@target)]).nil?
+      cmd = ['cd', @current.shellescape, '&&', extractor.map(&:shellescape), @target.basename.shellescape].flatten.join(' ')
+      if system(cmd)
+        @params[:tree] = true
+        _open(@current)
+      else
+        @response[:error] = 'Unable to extract files from archive'
+      end
     end # of extract
 
     #
     def _archive
-      command_not_implemented
+      @response[:error] = 'Invalid Parameters' and return unless !@targets.nil? && @targets.all?{|e| e.exist?} && @current.directory?
+      @response[:error] = 'Access Denied' and return unless !@targets.nil? && @targets.all?{|e| perms_for(e)[:read]} && perms_for(@current)[:write] == true
+      @response[:error] = 'No archiver available for this file type' and return if (archiver = @options[:archivers][@params[:type]]).nil?
+      extension = archiver.shift
+      basename = @params[:name] || @targets.first.basename_without_extension
+      archive = ElFinder::Pathname.new_with_root(@root, "#{basename}#{extension}").unique
+      cmd = ['cd', @current.shellescape, '&&', archiver.map(&:shellescape), archive.shellescape, @targets.map{|t| t.basename.shellescape}].flatten.join(' ')
+      if system(cmd)
+        @response[:select] = [to_hash(archive)]
+        _open(@current)
+      else
+        @response[:error] = 'Unable to create archive'
+      end
     end # of archive
 
     #

data/lib/el_finder/pathname.rb

@@ -15,19 +15,29 @@ module ElFinder
       self.class.new(super(*args).to_s)
     end
 
+    #
+    def shellescape
+      to_s.shellescape
+    end
+
     #
     def rename(to)
       super(to)
     rescue Errno::EXDEV
       FileUtils.move(self.to_s, to.to_s)
       @path = to.to_s
-    end
+    end # of rename
 
     #
     def self.new_with_root(root, path = '')
       new(superclass.new(File.join(root, path)).cleanpath.to_s)
     end # of self.new_with_root
 
+    #
+    def basename_without_extension
+      basename(extname)
+    end
+
     #
     def duplicate
       _dirname = dirname
@@ -41,11 +51,27 @@ module ElFinder
 
       begin
         copy += 1
-        duplicate = self.class.superclass.new(_dirname + "#{_basename} copy #{copy}#{_extname}")
-      end while duplicate.exist?
-      duplicate
+        new_file = self.class.superclass.new(_dirname + "#{_basename} copy #{copy}#{_extname}")
+      end while new_file.exist?
+      new_file
     end # of duplicate
 
+    #
+    def unique
+      return self.dup unless self.file?
+
+      _dirname = dirname
+      _extname = extname
+      _basename = basename(_extname)
+      copy = 0
+
+      begin
+        copy += 1
+        new_file = self.class.superclass.new(_dirname + "#{_basename} #{copy}#{_extname}")
+      end while new_file.exist?
+      new_file
+    end # of unique
+
     #
     def relative_to(pathname)
       self == pathname ? '' : relative_path_from(pathname).to_s

data/lib/el_finder/version.rb

@@ -1,3 +1,3 @@
 module ElFinder
-  VERSION = '1.0.3'
+  VERSION = '1.0.4'
 end 

data/test/{test_el_finder_image_size.rb → el_finder/test_image_size.rb}

@@ -1,23 +1,23 @@
 require "test/unit"
 require "el_finder"
 
-class TestElFinderImageSize < Test::Unit::TestCase
+class TestImageSize < Test::Unit::TestCase
 
   def test_that_method_exists
     assert_respond_to ElFinder::ImageSize, :for
   end
 
   def test_that_logos_are_correct_size
-    assert_equal '70x66', ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), 'files/elfinder.png') )
-    assert_equal '100x100', ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), 'files/pjkh.png') )
+    assert_equal '70x66', ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), '../files/elfinder.png') )
+    assert_equal '100x100', ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), '../files/pjkh.png') )
   end
 
   def test_that_nil_is_returned_on_non_images
-    assert_equal nil, ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), 'files/README.txt') )
+    assert_equal nil, ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), '../files/README.txt') )
   end
 
   def test_that_nil_is_returned_on_nonexistint_files
-    assert_equal nil, ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), 'files/NON_EXIST') )
+    assert_equal nil, ElFinder::ImageSize.for( File.join(File.dirname(__FILE__), '../files/NON_EXIST') )
   end
 
 end

data/test/{test_el_finder_mime_type.rb → el_finder/test_mime_type.rb}

@@ -1,7 +1,7 @@
 require "test/unit"
 require "el_finder"
 
-class TestElFinderMimeType < Test::Unit::TestCase
+class TestMimeType < Test::Unit::TestCase
 
   def test_that_method_exists
     assert_respond_to ElFinder::MimeType, :for

data/test/{test_el_finder_pathname.rb → el_finder/test_pathname.rb}

@@ -2,12 +2,12 @@ require "test/unit"
 require "el_finder"
 require "fileutils"
 
-class TestElFinderPathname < Test::Unit::TestCase
+class TestPathname < Test::Unit::TestCase
 
   def setup
     @vroot = '/tmp/elfinder'
     FileUtils.mkdir_p(@vroot)
-    FileUtils.cp_r "#{File.dirname(__FILE__)}/files/.",  @vroot
+    FileUtils.cp_r "#{File.dirname(__FILE__)}/../files/.",  @vroot
   end
 
   def teardown
@@ -83,14 +83,38 @@ class TestElFinderPathname < Test::Unit::TestCase
 
   ################################################################################
 
+  def test_shellescape
+    assert_respond_to ElFinder::Pathname.new_with_root(@vroot, 'foo.txt'), :shellescape
+  end
+
+  def test_basename_without_extension
+    file = ElFinder::Pathname.new_with_root(@vroot, 'foo.txt')
+    assert_respond_to file, :basename_without_extension
+    assert_equal 'foo', file.basename_without_extension.to_s
+  end
+
+  def test_unique_on_create
+    file = ElFinder::Pathname.new_with_root(@vroot, 'foo.txt')
+    assert_equal 'foo.txt', file.unique.basename.to_s
+  end
+
+  def test_unique_conflict
+    file = ElFinder::Pathname.new_with_root(@vroot, 'pjkh.png')
+    assert_equal 'pjkh 1.png', file.unique.basename.to_s
+  end
+
+  def test_unique_conflict_twice
+    FileUtils.touch ElFinder::Pathname.new_with_root(@vroot, 'pjkh 1.png')
+    file = ElFinder::Pathname.new_with_root(@vroot, 'pjkh.png')
+    assert_equal 'pjkh 2.png', file.unique.basename.to_s
+  end
+
   def test_relative_to_method
     assert_equal "", ElFinder::Pathname.new_with_root(@vroot).relative_to(::Pathname.new(@vroot)).to_s
     assert_equal "foo.txt", ElFinder::Pathname.new_with_root(@vroot, 'foo.txt').relative_to(::Pathname.new(@vroot)).to_s
     assert_equal "foo/bar.txt", ElFinder::Pathname.new_with_root(@vroot, 'foo/bar.txt').relative_to(::Pathname.new(@vroot)).to_s
   end
 
-  ################################################################################
-
   def test_class_type
     assert_kind_of ElFinder::Pathname, ElFinder::Pathname.new_with_root(@vroot, 'foo')
     assert_kind_of ElFinder::Pathname, ElFinder::Pathname.new_with_root(@vroot, 'foo') + 'bar'

data/test/el_finder_test_case.rb

@@ -0,0 +1,22 @@
+require 'test/unit'
+require 'el_finder'
+require 'pp'
+
+module ElFinderTestCase 
+
+  def setup
+    @vroot = '/tmp/elfinder'
+    FileUtils.mkdir_p(@vroot)
+    FileUtils.cp_r "#{File.dirname(__FILE__)}/files/.",  @vroot
+    @elfinder = ElFinder::Connector.new({
+      :root => @vroot, 
+      :url => '/elfinder', 
+      :original_filename_method => lambda {|file| File.basename(file.path)}
+    })
+  end
+
+  def teardown
+    FileUtils.rm_rf(@vroot)
+  end
+
+end