el_finder 1.0.7 → 1.0.8

data/README.rdoc

@@ -7,10 +7,6 @@
 Ruby library to provide server side functionality for elFinder.  elFinder is an
 open-source file manager for web, written in JavaScript using jQuery UI.
 
-== Features/Problems:
-
-* Does not yet support thumbnail generation.
-
 == Todo:
 
 * Document library.
@@ -18,7 +14,7 @@ open-source file manager for web, written in JavaScript using jQuery UI.
 
 == Requirements:
 
-The gem, by default, relies upon the 'image_size' ruby gem and ImageMagick's 'mogrify' command.
+The gem, by default, relies upon the 'image_size' ruby gem and ImageMagick's 'mogrify' and 'convert' commands.
 These requirements can be changed by implementing custom methods for determining image size
 and resizing of an image.
 

data/el_finder.gemspec

@@ -20,5 +20,6 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_dependency('image_size', '>= 1.0.0')
+  s.requirements << 'ImageMagick'
 
 end

data/lib/el_finder/connector.rb

@@ -1,3 +1,7 @@
+#
+# http://elrte.org/redmine/projects/elfinder/wiki/Client-Server_Protocol_EN
+#
+
 require 'base64'
 
 module ElFinder
@@ -7,8 +11,7 @@ module ElFinder
 
     DEFAULT_OPTIONS = {
       :mime_handler => ElFinder::MimeType,
-      :image_size_handler => ElFinder::ImageSize,
-      :image_resize_handler => ElFinder::ImageResize,
+      :image_handler => ElFinder::Image,
       :original_filename_method => lambda {|file| file.original_filename},
       :disabled_commands => [],
       :show_dot_files => true,
@@ -17,7 +20,11 @@ module ElFinder
       :extractors => {},
       :home => 'Home',
       :default_perms => {:read => true, :write => true, :rm => true},
-      :perms => []
+      :perms => [],
+      :thumbs => false,
+      :thumbs_directory => '.thumbs',
+      :thumbs_size => 48,
+      :thumbs_at_once => 5,
     }
 
     #
@@ -27,8 +34,7 @@ module ElFinder
       raise(RuntimeError, "Missing required :url option") unless @options.key?(:url) 
       raise(RuntimeError, "Missing required :root option") unless @options.key?(:root) 
       raise(RuntimeError, "Mime Handler is invalid") unless mime_handler.respond_to?(:for)
-      raise(RuntimeError, "Image Size Handler is invalid") unless image_size_handler.nil? || image_size_handler.respond_to?(:for)
-      raise(RuntimeError, "Image Resize Handler is invalid") unless image_resize_handler.nil? || image_resize_handler.respond_to?(:resize)
+      raise(RuntimeError, "Image Handler is invalid") unless image_handler.nil? || ([:size, :resize, :thumbnail].all?{|m| image_handler.respond_to?(m)})
 
       @root = ElFinder::Pathname.new(options[:root])
 
@@ -39,18 +45,24 @@ module ElFinder
     #
     def run(params = {})
       @params = params.dup
+      @headers = {}
+      @response = {}
       @response[:errorData] = {}
 
       if VALID_COMMANDS.include?(@params[:cmd])
 
+        if @options[:thumbs]
+          @thumb_directory = @root + @options[:thumbs_directory]
+          @thumb_directory.mkdir unless @thumb_directory.exist? 
+          raise(RuntimeError, "Unable to create thumbs directory") unless @thumb_directory.directory?
+        end
+
         @current = @params[:current] ? from_hash(@params[:current]) : nil
         @target = @params[:target] ? from_hash(@params[:target]) : nil
         if params[:targets]
           @targets = @params[:targets].map{|t| from_hash(t)}
         end
 
-
-
         send("_#{@params[:cmd]}")
       else
         invalid_request
@@ -99,7 +111,7 @@ module ElFinder
         command_not_implemented
       elsif target.directory?
         @response[:cwd] = cwd_for(target)
-        @response[:cdc] = target.children.map{|e| cdc_for(e)}
+        @response[:cdc] = target.children.map{|e| cdc_for(e)}.compact
 
         if @params[:tree]
           @response[:tree] = {
@@ -120,8 +132,6 @@ module ElFinder
           }
         end
 
-        # FIXME - add 'tmb:true' when necessary
-        
       else
         @response[:error] = "Directory does not exist"
         _open(@root)
@@ -334,18 +344,33 @@ module ElFinder
 
     #
     def _tmb
-      command_not_implemented
+      if image_handler.nil?
+        command_not_implemented
+      else
+        @response[:current] = to_hash(@current)
+        @response[:images] = {}
+        @current.children.select{|e| mime_handler.for(e) =~ /image/}.each_with_index do |img, idx|
+          if idx >= @options[:thumbs_at_once]
+            @response[:tmb] = true
+            break
+          end
+          thumbnail = thumbnail_for(img)
+          image_handler.thumbnail(img, thumbnail, :width => @options[:thumbs_size].to_i, :height => @options[:thumbs_size].to_i)
+          @response[:images][to_hash(img)] = @options[:url] + '/' + thumbnail.path.to_s
+        end
+      end
+
     end # of tmb
 
     #
     def _resize
-      if image_resize_handler.nil?
+      if image_handler.nil?
         command_not_implemented
       else
         if @target.file?
           perms = perms_for(@target)
           if perms[:read] == true && perms[:write] == true
-            image_resize_handler.resize(@target, :width => @params[:width].to_i, :height => @params[:height].to_i)
+            image_handler.resize(@target, :width => @params[:width].to_i, :height => @params[:height].to_i)
             @response[:select] = [to_hash(@target)]
             _open(@current)
           else
@@ -360,6 +385,11 @@ module ElFinder
     ################################################################################
     private
 
+    #
+    def thumbnail_for(pathname)
+      @thumb_directory + "#{to_hash(pathname)}.png"
+    end
+
     #
     def remove_target(target)
       if target.directory?
@@ -373,6 +403,9 @@ module ElFinder
       else
         begin
           target.unlink
+          if (thumbnail = thumbnail_for(target)).file?
+            thumbnail.unlink
+          end
         rescue
           @response[:error] ||= 'Some files/directories were unable to be removed'
           @response[:errorData][target.basename.to_s] = "Remove failed"
@@ -386,13 +419,8 @@ module ElFinder
     end
 
     #
-    def image_size_handler
-      @options[:image_size_handler]
-    end
-
-    #
-    def image_resize_handler
-      @options[:image_resize_handler]
+    def image_handler
+      @options[:image_handler]
     end
 
     # 
@@ -408,6 +436,7 @@ module ElFinder
     end
 
     def cdc_for(pathname)
+      return nil if @options[:thumbs] && pathname.to_s == @thumb_directory.to_s
       response = {
         :name => pathname.basename.to_s,
         :hash => to_hash(pathname),
@@ -427,10 +456,11 @@ module ElFinder
           :url => (@options[:url] + '/' + pathname.path.to_s)
         )
 
-        if pathname.readable? && response[:mime] =~ /image/ && !image_size_handler.nil? && !image_resize_handler.nil?
+        if pathname.readable? && response[:mime] =~ /image/ && !image_handler.nil?
+          @response[:tmb] = true if @options[:thumbs] && !thumbnail_for(pathname).exist?
           response.merge!(
             :resize => true,
-            :dim => image_size_handler.for(pathname)
+            :dim => image_handler.size(pathname)
           )
         end
 
@@ -449,11 +479,15 @@ module ElFinder
 
     #
     def tree_for(root)
-      root.children.select{ |child| child.directory? }.sort_by{|e| e.basename.to_s.downcase}.map { |child|
-        {:name => child.basename.to_s,
-         :hash => to_hash(child),
-         :dirs => tree_for(child),
-        }.merge(perms_for(child))
+      root.children.
+      select{ |child| child.directory? }.
+      reject{ |child| child.to_s == @thumb_directory.to_s }.
+      sort_by{|e| e.basename.to_s.downcase}.
+      map { |child|
+          {:name => child.basename.to_s,
+           :hash => to_hash(child),
+           :dirs => tree_for(child),
+          }.merge(perms_for(child))
       }
     end # of tree_for
 

data/lib/el_finder/image.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'shellwords'
+require 'image_size'
+
+module ElFinder
+
+  class Image
+
+    def self.size(pathname)
+      return nil unless File.exist?(pathname)
+      s = ::ImageSize.new(File.open(pathname)).size.to_s
+      s = nil if s.empty?
+      return s
+    end
+
+    def self.resize(pathname, options = {})
+      return nil unless File.exist?(pathname)
+      system( ::Shellwords.join(['mogrify', '-resize', "#{options[:width]}x#{options[:height]}!", pathname.to_s]) ) 
+    end # of self.resize
+
+    def self.thumbnail(src, dst, options = {})
+      return nil unless File.exist?(src)
+      system( ::Shellwords.join(['convert', '-resize', "#{options[:width]}x#{options[:height]}!", src.to_s, dst.to_s]) ) 
+    end # of self.resize
+
+  end # of class Image
+
+end # of module ElFinder

data/lib/el_finder/version.rb

@@ -1,3 +1,3 @@
 module ElFinder
-  VERSION = '1.0.7'
+  VERSION = '1.0.8'
 end 

data/lib/el_finder.rb

@@ -2,6 +2,5 @@ require 'fileutils'
 
 require 'el_finder/pathname'
 require 'el_finder/mime_type'
-require 'el_finder/image_size'
-require 'el_finder/image_resize'
+require 'el_finder/image'
 require 'el_finder/connector'

data/test/el_finder/test_image.rb

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

data/test/test_el_finder.rb

@@ -193,8 +193,8 @@ class TestElFinder < Test::Unit::TestCase
 
   def test_rm
     h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
-    h, r = @elfinder.run(:cmd => 'rm', :current => r[:cwd][:hash], :targets => [])
-    assert_match(/no files/i, r[:error])
+    h, r1 = @elfinder.run(:cmd => 'rm', :current => r[:cwd][:hash], :targets => [])
+    assert_match(/no files/i, r1[:error])
 
     h, r = @elfinder.run(:cmd => 'rm', :targets => r[:cdc].reject{|e| e[:mime] =~ /image/}.map{|e| e[:hash]})
     assert !File.exist?(File.join(@vroot, 'README.txt'))
@@ -234,7 +234,7 @@ class TestElFinder < Test::Unit::TestCase
     file = r[:cdc].find{|e| e[:name] == 'pjkh.png'}
     h, r = @elfinder.run(:cmd => 'resize', :target => file[:hash], :current => r[:cwd][:hash], :width => '50', :height => '25')
     assert File.exist?(File.join(@vroot, 'pjkh.png'))
-    assert_equal '50x25', ElFinder::ImageSize.for(File.join(@vroot, 'pjkh.png')).to_s
+    assert_equal '50x25', ElFinder::Image.size(File.join(@vroot, 'pjkh.png')).to_s
   end
 
   ################################################################################

data/test/test_el_finder_permissions.rb

@@ -341,7 +341,7 @@ class TestElFinder < Test::Unit::TestCase
     h, r = @elfinder.run(:cmd => 'resize', :target => file[:hash], :current => r[:cwd][:hash], :width => '50', :height => '25')
     assert_match(/access denied/i, r[:error])
     assert File.exist?(File.join(@vroot, 'pjkh.png'))
-    assert_equal '100x100', ElFinder::ImageSize.for(File.join(@vroot, 'pjkh.png')).to_s
+    assert_equal '100x100', ElFinder::Image.size(File.join(@vroot, 'pjkh.png')).to_s
   end
 
   def test_resize_permissions_read
@@ -355,7 +355,7 @@ class TestElFinder < Test::Unit::TestCase
     h, r = @elfinder.run(:cmd => 'resize', :target => file[:hash], :current => r[:cwd][:hash], :width => '50', :height => '25')
     assert_match(/access denied/i, r[:error])
     assert File.exist?(File.join(@vroot, 'pjkh.png'))
-    assert_equal '100x100', ElFinder::ImageSize.for(File.join(@vroot, 'pjkh.png')).to_s
+    assert_equal '100x100', ElFinder::Image.size(File.join(@vroot, 'pjkh.png')).to_s
   end
 
 

data/test/test_el_finder_thumbs.rb

@@ -0,0 +1,115 @@
+require 'el_finder_test_case'
+
+class TestElFinderThumbs < Test::Unit::TestCase
+
+  include ElFinderTestCase
+
+  ################################################################################
+
+  def test_tmb_is_false_by_default
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    assert_equal nil, r[:tmb]
+  end
+
+  def test_thumbs_directory_does_not_show_in_output
+    @elfinder.options = { :thumbs => true, :thumbs_directory => '.thumbs' }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    target = r[:cdc].find{|e| e[:name] == '.thumbs'}
+    assert_equal true, target.nil?
+  end
+
+  def test_thumbs_directory_exists
+    @elfinder.options = { :thumbs => true, :thumbs_directory => '.thumbs' }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    assert File.directory?(File.join(@vroot, '.thumbs'))
+  end
+
+  def test_thumbs_directory_cannot_be_created
+    FileUtils.touch(File.join(@vroot, '.thumbs'))
+    @elfinder.options = { :thumbs => true, :thumbs_directory => '.thumbs' }
+    assert_raise RuntimeError do
+      h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    end
+  end
+
+  # 
+  # In the root there are a two images: elfinder.png, pjkh.png
+  #
+
+  def test_tmb_is_true_when_thumbs_enabled_and_images_exist_without_thumbnail
+    @elfinder.options = { :thumbs => true }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    assert_equal true, r[:tmb]
+  end
+
+  def test_tmb_is_false_when_thumbs_enabled_and_images_exist_with_thumbnail
+    @elfinder.options = { :thumbs => true }
+    Dir.mkdir(File.join(@vroot, '.thumbs'))
+    FileUtils.touch(File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))}.png"))
+    FileUtils.touch(File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'pjkh.png'))}.png"))
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    assert_equal nil, r[:tmb]
+  end
+
+  def test_thumbs_are_created_when_requested
+    @elfinder.options = { :thumbs => true }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'tmb', :current => '')
+    assert File.exist?(File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))}.png"))
+    assert File.exist?(File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'pjkh.png'))}.png"))
+  end
+
+  def test_thumbs_of_non_images_are_not_created
+    @elfinder.options = { :thumbs => true }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'tmb', :current => '')
+    assert !File.exist?(File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'README.txt'))}.png"))
+  end
+
+  def test_tmb_response
+    @elfinder.options = { :thumbs => true }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'tmb', :current => '')
+
+    elfinder_hash = @elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))
+    pjkh_hash = @elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))
+
+    assert_equal 2, r[:images].size
+    assert_equal "/elfinder/.thumbs/#{elfinder_hash}.png", r[:images][elfinder_hash]
+    assert_equal "/elfinder/.thumbs/#{pjkh_hash}.png", r[:images][pjkh_hash]
+  end
+
+  def test_tmb_more_to_be_created
+    @elfinder.options = { :thumbs => true, :thumbs_at_once => 1 }
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'tmb', :current => '')
+
+    elfinder_hash = @elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))
+    pjkh_hash = @elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))
+
+    assert_equal true, r[:tmb]
+    assert_equal 1, r[:images].size
+  end
+
+  def test_thumbnail_removed_when_image_removed
+    @elfinder.options = { :thumbs => true }
+    pjkh_thumb = File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))}.png")
+    elfinder_thumb = File.join(@vroot, '.thumbs', "#{@elfinder.to_hash(ElFinder::Pathname.new(@vroot, 'elfinder.png'))}.png")
+    Dir.mkdir(File.join(@vroot, '.thumbs'))
+    FileUtils.touch pjkh_thumb
+    FileUtils.touch elfinder_thumb
+
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'rm', :targets => r[:cdc].select{|e| e[:mime] =~ /image/}.map{|e| e[:hash]})
+
+    assert !File.exist?(pjkh_thumb)
+    assert !File.exist?(elfinder_thumb)
+
+  end
+
+
+
+  ################################################################################
+
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: el_finder
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: false
   segments: 
   - 1
   - 0
-  - 7
-  version: 1.0.7
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - Philip Hallstrom
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 -08:00
+date: 2011-01-14 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,12 +52,11 @@ files:
 - el_finder.gemspec
 - lib/el_finder.rb
 - lib/el_finder/connector.rb
-- lib/el_finder/image_resize.rb
-- lib/el_finder/image_size.rb
+- lib/el_finder/image.rb
 - lib/el_finder/mime_type.rb
 - lib/el_finder/pathname.rb
 - lib/el_finder/version.rb
-- test/el_finder/test_image_size.rb
+- test/el_finder/test_image.rb
 - test/el_finder/test_mime_type.rb
 - test/el_finder/test_pathname.rb
 - test/el_finder_test_case.rb
@@ -75,6 +74,7 @@ files:
 - test/test_el_finder_hash.rb
 - test/test_el_finder_permissions.rb
 - test/test_el_finder_symlink.rb
+- test/test_el_finder_thumbs.rb
 has_rdoc: true
 homepage: http://github.com/phallstrom/el_finder
 licenses: []
@@ -102,15 +102,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       segments: 
       - 0
       version: "0"
-requirements: []
-
+requirements: 
+- ImageMagick
 rubyforge_project: el_finder
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: elFinder server side connector for Ruby.
 test_files: 
-- test/el_finder/test_image_size.rb
+- test/el_finder/test_image.rb
 - test/el_finder/test_mime_type.rb
 - test/el_finder/test_pathname.rb
 - test/el_finder_test_case.rb
@@ -128,3 +128,4 @@ test_files:
 - test/test_el_finder_hash.rb
 - test/test_el_finder_permissions.rb
 - test/test_el_finder_symlink.rb
+- test/test_el_finder_thumbs.rb

data/lib/el_finder/image_resize.rb

@@ -1,14 +0,0 @@
-require 'shellwords'
-
-module ElFinder
-
-  class ImageResize
-
-    def self.resize(pathname, options = {})
-      return nil unless File.exist?(pathname)
-      system( ::Shellwords.join(['mogrify', '-resize', "#{options[:width]}x#{options[:height]}!", pathname.to_s]) ) 
-    end # of self.resize
-
-  end # of class ImageSize
-
-end # of module ElFinder

data/lib/el_finder/image_size.rb

@@ -1,17 +0,0 @@
-require 'rubygems'
-require 'image_size'
-
-module ElFinder
-
-  class ImageSize < ::ImageSize
-
-    def self.for(pathname)
-      return nil unless File.exist?(pathname)
-      s = new(File.open(pathname)).size.to_s
-      s = nil if s.empty?
-      return s
-    end
-
-  end # of class ImageSize
-
-end # of module ElFinder

data/test/el_finder/test_image_size.rb

@@ -1,23 +0,0 @@
-require "test/unit"
-require "el_finder"
-
-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') )
-  end
-
-  def test_that_nil_is_returned_on_non_images
-    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') )
-  end
-
-end