el_finder 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,19 @@
+CHANGELOG
+
+2010-10-15  Philip Hallstrom
+
+        * update manifest
+        * test each of the connector methods
+        * use base64 encode/decode for hash to get around javascript unfriendly characters
+        * add image size/resize handling
+        * almost functionally complete
+        * migrate over alpha code from past project
+
+2010-10-14  Philip Hallstrom
+
+        * begin work on connector
+        * enforce that all pathnames reside beneath the root
+        * initial library and tests for mime_type/pathname
+        * bin/elfinder not necessary
+        * Initial commit
+

data/Manifest.txt

@@ -0,0 +1,22 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/el_finder.rb
+lib/el_finder/connector.rb
+lib/el_finder/image_resize.rb
+lib/el_finder/image_size.rb
+lib/el_finder/mime_type.rb
+lib/el_finder/pathname.rb
+test/files/README.txt
+test/files/elfinder.png
+test/files/foo/philip.txt
+test/files/foo/sam.txt
+test/files/foo/sandy.txt
+test/files/foo/tom.txt
+test/files/pjkh.png
+test/test_el_finder.rb
+test/test_el_finder_image_size.rb
+test/test_el_finder_mime_type.rb
+test/test_el_finder_pathname.rb

data/README.txt

@@ -0,0 +1,98 @@
+== el_finder
+
+* http://elrte.org/redmine/projects/elfinder
+
+== Description:
+
+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 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.
+
+== Requirements:
+
+The gem, by default, relies upon the 'imagesize' ruby gem and ImageMagick's 'mogrify' command.
+These requirements can be changed by implementing custom methods for determining image size
+and resizing of an image.
+
+== Install:
+
+* Install elFinder (http://elrte.org/redmine/projects/elfinder/wiki/Install_EN)
+* Install ImageMagick (http://www.imagemagick.org/)
+* Do whatever is necessary for your Ruby framework to tie it together.
+
+=== Rails 3
+
+* Add "gem 'el_finder'" to Gemfile
+* % bundle install
+* Switch to using jQuery instead of Prototype
+* Add the following action to a controller of your choosing.
+
+    skip_before_filter :verify_authenticity_token, :only => ['elfinder']
+    def elfinder
+      h, r = ElFinder::Connector.new(
+        :root => File.join(Rails.public_path, 'system', 'elfinder'),
+        :url => '/system/elfinder'
+      ).run(params)
+      headers.merge!(h)
+      render (r.empty? ? {:nothing => true} : {:text => r.to_json}), :layout => false
+    end
+
+* Add the appropriate route to config/routes.rb such as:
+
+    match 'elfinder' => 'home#elfinder'
+
+* Add the following to your layout. The paths may be different depending 
+on where you installed the various js/css files.
+
+    <%= stylesheet_link_tag 'jquery-ui/base/jquery.ui.all', 'elfinder' %>
+    <%= javascript_include_tag :defaults, 'elfinder/elfinder.min' %>
+
+* Add the following to the view that will display elFinder:
+
+    <%= javascript_tag do %>
+      $().ready(function() { 
+        $('#elfinder').elfinder({ 
+          url: '/elfinder',
+          lang: 'en'
+        })
+      })
+    <% end %>
+    <div id='elfinder'></div>
+
+* That's it.  I think.  If not, check out the example rails application at http://github.com/phallstrom/el_finder-rails-example.
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2010 Philip Hallstrom
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,13 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'el_finder' do
+  developer('Philip Hallstrom', 'philip@pjkh.com')
+  self.extra_deps = [
+    ["imagesize",">=0.1.1"]
+  ]
+end
+
+# vim: syntax=ruby

data/lib/el_finder.rb

@@ -0,0 +1,11 @@
+require 'fileutils'
+
+module ElFinder
+  VERSION = '1.0.0'
+end # of module ElFinder
+
+require 'el_finder/pathname'
+require 'el_finder/mime_type'
+require 'el_finder/image_size'
+require 'el_finder/image_resize'
+require 'el_finder/connector'

data/lib/el_finder/connector.rb

@@ -0,0 +1,342 @@
+require 'base64'
+
+module ElFinder
+  class Connector
+    
+    VALID_COMMANDS = %w[archive duplicate edit extract mkdir mkfile open paste ping read rename resize rm tmb upload]
+
+    DEFAULT_OPTIONS = {
+      :mime_handler => ElFinder::MimeType,
+      :image_size_handler => ElFinder::ImageSize,
+      :image_resize_handler => ElFinder::ImageResize,
+      :original_filename_method => lambda {|file| file.original_filename},
+      :disabled_commands => [],
+      :show_dot_files => true,
+      :upload_max_size => '50M',
+      :archivers => [],
+      :extractors => [],
+      :home => 'Home',
+    }
+
+    #
+    def initialize(options = {})
+      @options = DEFAULT_OPTIONS.merge(options)
+
+      raise(RuntimeError, "Missing required :url option") unless @options.key?(:url) 
+      raise(RuntimeError, "Missing required :root option") unless @options.key?(:root) 
+
+      @mime_handler = @options.delete(:mime_handler)
+      raise(RuntimeError, "Mime Handler is invalid") unless @mime_handler.respond_to?(:for)
+
+      @image_size_handler = @options.delete(:image_size_handler)
+      raise(RuntimeError, "Image Size Handler is invalid") unless @image_size_handler.nil? || @image_size_handler.respond_to?(:for)
+
+      @image_resize_handler = @options.delete(:image_resize_handler)
+      raise(RuntimeError, "Image Resize Handler is invalid") unless @image_resize_handler.nil? || @image_resize_handler.respond_to?(:resize)
+
+      @root = ElFinder::Pathname.new(options[:root])
+
+      @headers = {}
+      @response = {}
+    end # of initialize
+
+    #
+    def run(params = {})
+      @params = params.dup
+
+      if VALID_COMMANDS.include?(@params[:cmd])
+
+        @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
+      end
+
+      return @headers, @response
+    end # of run
+
+    #
+    def to_hash(pathname)
+      Base64.encode64(pathname == @root ? '/' : pathname.relative_path_from(@root).to_s).chomp
+    end # of to_hash
+
+    #
+    def from_hash(hash)
+      pathname = ElFinder::Pathname.new_with_root(@root, Base64.decode64(hash))
+    end # of from_hash
+
+    ################################################################################
+    protected
+
+    #
+    def _open(target = nil)
+      target ||= @target
+
+      if target.nil?
+        _open(@root)
+      elsif target.file?
+        command_not_implemented
+      elsif target.directory?
+        @response[:cwd] = cwd_for(target)
+        @response[:cdc] = target.children.map{|e| cdc_for(e)}
+
+        if @params[:tree]
+          @response[:tree] = {
+            :name => @options[:home],
+            :hash => to_hash(@root),
+            :read => @root.readable?,              
+            :write => @root.writable?,            
+            :dirs => tree_for(@root)
+          }
+        end
+
+        if @params[:init]
+          @response[:disabled] = @options[:disabled_commands]
+          @response[:params] = {
+            :dotFiles => @options[:show_dot_files],
+            :uplMaxSize => @options[:upload_max_size],
+            :archives => @options[:archivers],
+            :extract => @options[:extractors],
+            :url => @options[:url]
+          }
+        end
+
+        # FIXME - add 'tmb:true' when necessary
+        
+      else
+        @response[:error] = "Directory does not exist"
+        _open(@root)
+      end
+
+    end # of open
+
+    #
+    def _mkdir
+      dir = @current + @params[:name]
+      if !dir.exist? && dir.mkdir
+        @params[:tree] = true
+        @response[:select] = [to_hash(dir)]
+        _open(@current)
+      else
+        @response[:error] = "Unable to create folder"
+      end
+    end # of mkdir
+
+    #
+    def _mkfile
+      file = @current + @params[:name]
+      if !file.exist? && FileUtils.touch(file)
+        @response[:select] = [to_hash(file)]
+        _open(@current)
+      else
+        @response[:error] = "Unable to create file"
+      end
+    end # of mkfile
+
+    #
+    def _rename
+      to = @current + @params[:name]
+      if to.exist?
+        @response[:error] = "Unable to rename #{@target.ftype}. '#{to.basename}' already exists"
+      elsif @target.rename(to)
+        @params[:tree] = to.directory?
+        @response[:select] = [to_hash(to)]
+        _open(@current)
+      else
+        @response[:error] = "Unable to rename #{@target.ftype}"
+      end
+    end # of rename
+
+    #
+    def _upload
+      select = []
+      @params[:upload].to_a.each do |file|
+        dst = @current + @options[:original_filename_method].call(file)
+        File.rename(file.path, dst)
+        select << to_hash(dst)
+      end
+      @response[:select] = select
+      _open(@current)
+    end # of upload
+
+    #
+    def _ping
+      @headers['Connection'] = 'Close'
+    end # of ping
+
+    #
+    def _paste
+      @targets.to_a.each do |src|
+        dst = from_hash(@params[:dst]) + src.basename
+        if dst.exist?
+          @response[:error] = 'Some files were unable to be copied'
+          @response[:errorData] ||= {}
+          @response[:errorData][src.basename] = "already exists in '#{dst.dirname.relative_path_from(@root)}'"
+        else
+          if @params[:cut].to_i > 0
+            File.rename(src, dst)
+          else
+            if src.directory?
+              FileUtils.cp_r(src, dst)
+            else
+              FileUtils.copy(src, dst)
+            end
+          end
+        end
+      end
+      @params[:tree] = true
+      _open(@current)
+    end # of paste
+
+    #
+    def _rm
+      if @targets.empty?
+        @response[:error] = "No files were selected for removal"
+      else
+        FileUtils.rm_rf(@targets)
+        @params[:tree] = true
+        _open(@current)
+      end
+    end # of rm
+
+    #
+    def _duplicate
+      duplicate = @target.duplicate
+      if @target.directory?
+        FileUtils.cp_r(@target, duplicate)
+      else
+        FileUtils.copy(@target, duplicate)
+      end
+      @response[:select] = [to_hash(duplicate)]
+      _open(@current)
+    end # of duplicate
+
+    # 
+    def _read
+      @response[:content] = @target.read
+    end # of read
+
+    #
+    def _edit
+      @target.open('w') { |f| f.write @params[:content] }
+      @response[:file] = cdc_for(@target)
+    end # of edit
+
+    #
+    def _extract
+      command_not_implemented
+    end # of extract
+
+    #
+    def _archive
+      command_not_implemented
+    end # of archive
+
+    #
+    def _tmb
+      command_not_implemented
+    end # of tmb
+
+    #
+    def _resize
+      if @image_resize_handler.nil?
+        command_not_implemented
+      else
+        if @target.file?
+          @image_resize_handler.resize(@target, :width => @params[:width].to_i, :height => @params[:height].to_i)
+          @response[:select] = [to_hash(@target)]
+          _open(@current)
+        else
+          @response[:error] = "Unable to resize file. It does not exist"
+        end
+      end
+    end # of resize
+    
+    ################################################################################
+    private
+
+    # 
+    def cwd_for(pathname)
+      {
+        :name => pathname.basename.to_s,
+        :hash => to_hash(pathname),
+        :mime => 'directory',
+        :rel => (@options[:home] + '/' + pathname.relative_path_from(@root)),
+        :size => 0,
+        :date => pathname.mtime.to_s,
+        :read => pathname.readable?,
+        :write => pathname.writable?,
+        :rm => (pathname != @root && pathname.writable?),
+      }
+    end
+
+    # TODO - Implement link, linkTo, and parent
+    def cdc_for(pathname)
+      response = {
+        :name => pathname.basename.to_s,
+        :hash => to_hash(pathname),
+        :date => pathname.mtime.to_s,
+        :read => pathname.readable?,
+        :write => pathname.writable?,
+        :rm => pathname.writable?,
+      }
+
+      if pathname.directory?
+        response.merge!(
+          :size => 0,
+          :mime => 'directory'
+        )
+      elsif pathname.symlink?
+        response.merge!(
+          :link => 'FIXME',
+          :linkTo => 'FIXME',
+          :parent => 'FIXME'
+        )
+      elsif pathname.file?
+        response.merge!(
+          :size => pathname.size, 
+          :mime => @mime_handler.for(pathname),
+          :url => (@options[:url] + '/' + pathname.relative_path_from(@root))
+        )
+
+        if response[:mime] =~ /image/ && !@image_size_handler.nil? && !@image_resize_handler.nil?
+          response.merge!(
+            :resize => true,
+            :dim => @image_size_handler.for(pathname)
+          )
+        end
+
+      end
+
+      return response
+    end
+
+    #
+    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),
+         :read => child.readable?,
+         :write => child.writable?,
+         :dirs => tree_for(child),
+        }
+      }
+    end # of tree_for
+    
+    #
+    def invalid_request
+      @response[:error] = "Invalid command '#{@params[:cmd]}'"
+    end # of invalid_request
+
+    #
+    def command_not_implemented
+      @response[:error] = "Command '#{@params[:cmd]}' not yet implemented"
+    end # of command_not_implemented
+
+  end # of class Connector
+end # of module ElFinder

data/lib/el_finder/image_resize.rb

@@ -0,0 +1,14 @@
+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

@@ -0,0 +1,17 @@
+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)).get_size.join('x').to_s
+      s = nil if s == 'x'
+      return s
+    end
+
+  end # of class ImageSize
+
+end # of module ElFinder

data/lib/el_finder/mime_type.rb

@@ -0,0 +1,78 @@
+module ElFinder
+
+  class MimeType
+
+    TYPES = {
+      'ai'    => 'application/postscript',
+      'eps'   => 'application/postscript',
+      'exe'   => 'application/octet-stream',
+      'doc'   => 'application/vnd.ms-word',
+      'xls'   => 'application/vnd.ms-excel',
+      'ppt'   => 'application/vnd.ms-powerpoint',
+      'pps'   => 'application/vnd.ms-powerpoint',
+      'pdf'   => 'application/pdf',
+      'xml'   => 'application/xml',
+      'odt'   => 'application/vnd.oasis.opendocument.text',
+      'swf'   => 'application/x-shockwave-flash',
+      # archives
+      'gz'    => 'application/x-gzip',
+      'tgz'   => 'application/x-gzip',
+      'bz'    => 'application/x-bzip2',
+      'bz2'   => 'application/x-bzip2',
+      'tbz'   => 'application/x-bzip2',
+      'zip'   => 'application/zip',
+      'rar'   => 'application/x-rar',
+      'tar'   => 'application/x-tar',
+      '7z'    => 'application/x-7z-compressed',
+      # texts
+      'txt'   => 'text/plain',
+      'php'   => 'text/x-php',
+      'html'  => 'text/html',
+      'htm'   => 'text/html',
+      'js'    => 'text/javascript',
+      'css'   => 'text/css',
+      'rtf'   => 'text/rtf',
+      'rtfd'  => 'text/rtfd',
+      'py'    => 'text/x-python',
+      'java'  => 'text/x-java-source',
+      'rb'    => 'text/x-ruby',
+      'sh'    => 'text/x-shellscript',
+      'pl'    => 'text/x-perl',
+      'sql'   => 'text/x-sql',
+      # images
+      'bmp'   => 'image/x-ms-bmp',
+      'jpg'   => 'image/jpeg',
+      'jpeg'  => 'image/jpeg',
+      'gif'   => 'image/gif',
+      'png'   => 'image/png',
+      'tif'   => 'image/tiff',
+      'tiff'  => 'image/tiff',
+      'tga'   => 'image/x-targa',
+      'psd'   => 'image/vnd.adobe.photoshop',
+      # audio
+      'mp3'   => 'audio/mpeg',
+      'mid'   => 'audio/midi',
+      'ogg'   => 'audio/ogg',
+      'mp4a'  => 'audio/mp4',
+      'wav'   => 'audio/wav',
+      'wma'   => 'audio/x-ms-wma',
+      # video
+      'avi'   => 'video/x-msvideo',
+      'dv'    => 'video/x-dv',
+      'mp4'   => 'video/mp4',
+      'mpeg'  => 'video/mpeg',
+      'mpg'   => 'video/mpeg',
+      'mov'   => 'video/quicktime',
+      'wm'    => 'video/x-ms-wmv',
+      'flv'   => 'video/x-flv',
+      'mkv'   => 'video/x-matroska'
+    }
+		
+    def self.for(pathname)
+      pathname = ::Pathname.new(pathname) if pathname.is_a?(String)
+      TYPES[pathname.extname.downcase[1..-1]] || 'unknown/unknown'
+    end # of for
+
+  end # of class MimeType
+
+end # of module ElFinder

data/lib/el_finder/pathname.rb

@@ -0,0 +1,47 @@
+require 'pathname'
+
+module ElFinder
+
+  class Pathname < ::Pathname
+
+    #
+    def +(other)
+      self.class.new(super(other).to_s)
+    end
+
+    #
+    def join(*args)
+      self.class.new(super(*args).to_s)
+    end
+
+    #
+    def self.new_with_root(root, path = '')
+      new(superclass.new(File.join(root, path)).cleanpath.to_s)
+    end # of self.new_with_root
+
+    #
+    def duplicate
+      _dirname = dirname
+      _extname = extname
+      _basename = basename(_extname)
+      copy = 0
+      if _basename.to_s =~ /^(.*) copy (\d+)$/
+        _basename = $1
+        copy = $2.to_i
+      end
+
+      begin
+        copy += 1
+        duplicate = self.class.superclass.new(_dirname + "#{_basename} copy #{copy}#{_extname}")
+      end while duplicate.exist?
+      duplicate
+    end # of duplicate
+
+    #
+    def relative_to(pathname)
+      self == pathname ? '' : relative_path_from(pathname).to_s
+    end # of relative_to
+
+  end # of class Pathname
+
+end # of module ElFinder

data/test/files/README.txt

@@ -0,0 +1,2 @@
+The files contained within this directory are used solely for testing the ElFinder classes.
+The tests rely on the files being exactly as they are.  Please do not add/delete/change them.

data/test/files/foo/philip.txt

@@ -0,0 +1 @@
+philip

data/test/files/foo/sam.txt

@@ -0,0 +1 @@
+sam

data/test/files/foo/sandy.txt

@@ -0,0 +1 @@
+sandy

data/test/files/foo/tom.txt

@@ -0,0 +1 @@
+tom

data/test/test_el_finder.rb

@@ -0,0 +1,265 @@
+require "test/unit"
+require "el_finder"
+
+class TestElFinder < Test::Unit::TestCase
+
+  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
+
+  ################################################################################
+
+  def test_should_fail_initialization_if_required_options_not_passed
+    assert_raise RuntimeError do
+      ElFinder::Connector.new()
+    end
+  end
+
+  def test_should_fail_initialization_if_no_root_specified
+    assert_raise RuntimeError do
+      ElFinder::Connector.new({:url => '/elfinder'})
+    end
+  end
+
+  def test_should_fail_initialization_if_no_url_specified
+    assert_raise RuntimeError do
+      ElFinder::Connector.new({:root => '/tmp/elfinder'})
+    end
+  end
+
+  def test_should_fail_initialization_if_mime_handler_is_invalid
+    assert_raise RuntimeError do
+      ElFinder::Connector.new({:root => '/tmp/elfinder', :url => '/elfinder', :mime_handler => Object})
+    end
+  end
+
+  ################################################################################
+
+  def test_should_return_two_hashes
+    h, r = @elfinder.run({})
+    assert_instance_of Hash, h
+    assert_instance_of Hash, r
+  end
+
+
+  def test_should_return_invalid_request_if_command_is_invalid
+    h, r = @elfinder.run({:cmd => 'INVALID'})
+    assert_not_nil r[:error]
+    assert_match(/invalid command/i, r[:error])
+  end
+  
+  ################################################################################
+
+  def test_to_hash_method
+    assert_equal Base64.encode64('foo/bar').chomp, @elfinder.to_hash(ElFinder::Pathname.new_with_root(@vroot, 'foo/bar'))
+    assert_equal Base64.encode64('/').chomp, @elfinder.to_hash(ElFinder::Pathname.new_with_root(@vroot))
+  end
+
+  def test_from_hash_method
+    assert_equal File.join(@vroot, 'foo/bar'), @elfinder.from_hash(Base64.encode64('foo/bar').chomp).to_s
+    assert_equal @vroot, @elfinder.from_hash(Base64.encode64('').chomp).to_s
+  end
+
+  ################################################################################
+
+  def test_init_via_open
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    assert_not_nil r[:cwd]
+    assert_not_nil r[:cdc]
+    assert_not_nil r[:disabled]
+    assert_not_nil r[:params]
+    r[:cdc].each do |e|
+      case e[:name]
+        when 'foo'
+          assert_nil e[:dim]
+          assert_nil e[:resize]
+          assert_equal 'directory', e[:mime]
+          assert_equal 0, e[:size]
+        when 'pjkh.png'
+          assert_equal '100x100', e[:dim]
+          assert e[:resize]
+          assert_equal 'image/png', e[:mime]
+          assert_equal 1142, e[:size]
+      end
+    end
+  end
+
+  def test_mkdir
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h1, r1 = @elfinder.run(:cmd => 'mkdir', :current => r[:cwd][:hash], :name => 'dir1')
+    assert File.directory?(File.join(@vroot, 'dir1'))
+    assert_not_nil r1[:select]
+
+    h1, r1 = @elfinder.run(:cmd => 'mkdir', :current => r[:cwd][:hash], :name => 'dir1')
+    assert_match(/unable/i, r1[:error])
+
+    h1, r1 = @elfinder.run(:cmd => 'mkdir', :current => r[:cwd][:hash], :name => 'foo')
+    assert_match(/unable/i, r1[:error])
+  end
+
+  def test_mkfile
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h1, r1 = @elfinder.run(:cmd => 'mkfile', :current => r[:cwd][:hash], :name => 'file1')
+    assert File.file?(File.join(@vroot, 'file1'))
+    assert_not_nil r1[:select]
+
+    h1, r1 = @elfinder.run(:cmd => 'mkfile', :current => r[:cwd][:hash], :name => 'file1')
+    assert_match(/unable/i, r1[:error])
+
+    h1, r1 = @elfinder.run(:cmd => 'mkfile', :current => r[:cwd][:hash], :name => 'README.txt')
+    assert_match(/unable/i, r1[:error])
+  end
+
+  def test_rename_ok
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    target = r[:cdc].find{|e| e[:name] == 'README.txt'}
+    h1, r1 = @elfinder.run(:cmd => 'rename', :target => target[:hash], :current => r[:cwd][:hash], :name => 'file1')
+    assert File.file?(File.join(@vroot, 'file1'))
+    assert_not_nil r1[:select]
+  end
+
+  def test_rename_fail
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    target = r[:cdc].find{|e| e[:name] == 'README.txt'}
+    h1, r1 = @elfinder.run(:cmd => 'rename', :target => target[:hash], :current => r[:cwd][:hash], :name => 'foo')
+    assert_match(/unable.*already exists/i, r1[:error])
+    assert File.file?(File.join(@vroot, 'README.txt'))
+    assert_nil r1[:select]
+  end
+
+  def test_upload
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    uploads = []
+    uploads << File.open(File.join(@vroot, 'foo/philip.txt'))
+    uploads << File.open(File.join(@vroot, 'foo/sandy.txt'))
+    h, r = @elfinder.run(:cmd => 'upload', :upload => uploads, :current => r[:cwd][:hash])
+    assert File.exist?(File.join(@vroot, 'philip.txt'))
+    assert File.exist?(File.join(@vroot, 'sandy.txt'))
+    assert_not_nil r[:select]
+  end
+
+  def test_ping
+    h, r = @elfinder.run(:cmd => 'ping')
+    assert r.empty?
+    assert_equal 'Close', h['Connection']
+  end
+
+  def test_paste_copy
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    targets = r[:cdc].select{|e| e[:mime] != 'directory'}
+    dst = r[:cdc].find{|e| e[:name] == 'foo'}
+
+    h, r = @elfinder.run(:cmd => 'paste', :targets => targets.map{|e| e[:hash]}, :dst => dst[:hash])
+    assert_not_nil r[:tree]
+    assert File.exist?(File.join(@vroot, 'README.txt'))
+    assert File.exist?(File.join(@vroot, 'pjkh.png'))
+    assert File.exist?(File.join(@vroot, 'elfinder.png'))
+    assert File.exist?(File.join(@vroot, 'foo', 'README.txt'))
+    assert File.exist?(File.join(@vroot, 'foo', 'pjkh.png'))
+    assert File.exist?(File.join(@vroot, 'foo', 'elfinder.png'))
+  end
+
+  def test_paste_cut
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    targets = r[:cdc].select{|e| e[:mime] != 'directory'}
+    dst = r[:cdc].find{|e| e[:name] == 'foo'}
+
+    h, r = @elfinder.run(:cmd => 'paste', :targets => targets.map{|e| e[:hash]}, :dst => dst[:hash], :cut => '1')
+    assert_not_nil r[:tree]
+    assert !File.exist?(File.join(@vroot, 'README.txt'))
+    assert !File.exist?(File.join(@vroot, 'pjkh.png'))
+    assert !File.exist?(File.join(@vroot, 'elfinder.png'))
+    assert File.exist?(File.join(@vroot, 'foo', 'README.txt'))
+    assert File.exist?(File.join(@vroot, 'foo', 'pjkh.png'))
+    assert File.exist?(File.join(@vroot, 'foo', 'elfinder.png'))
+  end
+
+  def test_paste_partial_failure
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    h, r = @elfinder.run(:cmd => 'mkfile', :current => r[:cwd][:hash], :name => 'philip.txt')
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+
+    targets = r[:cdc].select{|e| e[:mime] != 'directory'}
+    dst = r[:cdc].find{|e| e[:name] == 'foo'}
+
+    h, r = @elfinder.run(:cmd => 'paste', :targets => targets.map{|e| e[:hash]}, :dst => dst[:hash])
+    assert_not_nil r[:tree]
+    assert_match(/unable to be copied/i, r[:error])
+    assert_not_nil r[:errorData]
+    assert_equal 1, r[:errorData].size
+    assert File.exist?(File.join(@vroot, 'philip.txt'))
+    assert File.exist?(File.join(@vroot, 'foo', 'philip.txt'))
+    assert File.exist?(File.join(@vroot, 'foo', 'README.txt'))
+    assert File.exist?(File.join(@vroot, 'foo', 'pjkh.png'))
+    assert File.exist?(File.join(@vroot, 'foo', 'elfinder.png'))
+  end
+
+  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, 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'))
+    assert File.exist?(File.join(@vroot, 'pjkh.png'))
+    assert File.exist?(File.join(@vroot, 'elfinder.png'))
+    assert !File.exist?(File.join(@vroot, 'foo'))
+  end
+
+  def test_duplicate
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    duplicate = r[:cdc].find{|e| e[:name] == 'README.txt'}
+    assert File.exist?(File.join(@vroot, 'README.txt'))
+    h, r = @elfinder.run(:cmd => 'duplicate', :target => duplicate[:hash])
+    assert File.exist?(File.join(@vroot, 'README copy 1.txt'))
+    assert_not_nil r[:select]
+    h, r = @elfinder.run(:cmd => 'duplicate', :target => duplicate[:hash])
+    assert File.exist?(File.join(@vroot, 'README copy 2.txt'))
+  end
+
+  def test_read
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    file = r[:cdc].find{|e| e[:name] == 'README.txt'}
+    h, r = @elfinder.run(:cmd => 'read', :target => file[:hash])
+    assert_equal r[:content], File.read(File.join(@vroot, 'README.txt'))
+  end
+
+  def test_edit
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    file = r[:cdc].find{|e| e[:name] == 'README.txt'}
+    h, r = @elfinder.run(:cmd => 'edit', :target => file[:hash], :content => 'Hello')
+    assert_equal 'Hello', File.read(File.join(@vroot, 'README.txt'))
+    assert_not_nil r[:file]
+  end
+
+  def test_resize
+    h, r = @elfinder.run(:cmd => 'open', :init => 'true', :target => '')
+    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
+  end
+
+end
+
+__END__
+/Users/philip/Desktop/el_finder/test/files
+14615625       16 -rw-r--r--    1 philip   staff        7718 Oct 15 14:19 ./elfinder.png
+14569851        0 drwxr-xr-x    6 philip   staff         204 Oct 15 11:19 ./foo
+14605469        8 -rw-r--r--    1 philip   staff           7 Oct 15 11:19 ./foo/philip.txt
+14605474        8 -rw-r--r--    1 philip   staff           4 Oct 15 11:19 ./foo/sam.txt
+14605479        8 -rw-r--r--    1 philip   staff           6 Oct 15 11:19 ./foo/sandy.txt
+14605486        8 -rw-r--r--    1 philip   staff           4 Oct 15 11:19 ./foo/tom.txt
+14569820        8 -rw-r--r--    1 philip   staff        1142 Dec  6  2007 ./pjkh.png
+14605515        8 -rw-r--r--    1 philip   staff         186 Oct 15 11:20 ./README.txt

data/test/test_el_finder_image_size.rb

@@ -0,0 +1,23 @@
+require "test/unit"
+require "el_finder"
+
+class TestElFinderImageSize < 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

data/test/test_el_finder_mime_type.rb

@@ -0,0 +1,30 @@
+require "test/unit"
+require "el_finder"
+
+class TestElFinderMimeType < Test::Unit::TestCase
+
+  def test_that_method_exists
+    assert_respond_to ElFinder::MimeType, :for
+  end
+
+  def test_known_mime_types
+    assert_equal 'image/jpeg', ElFinder::MimeType.for('image.jpg')
+  end
+
+  def test_unknown_mime_types
+    assert_equal 'unknown/unknown', ElFinder::MimeType.for('image.foo')
+  end
+
+  def test_uppercase_extensions
+    assert_equal 'image/jpeg', ElFinder::MimeType.for('image.JPG')
+  end
+
+  def test_missing_extension
+    assert_equal 'unknown/unknown', ElFinder::MimeType.for('README')
+  end
+
+  def test_passing_pathname
+    assert_equal 'text/plain', ElFinder::MimeType.for(ElFinder::Pathname.new('README.txt'))
+  end
+
+end

data/test/test_el_finder_pathname.rb

@@ -0,0 +1,76 @@
+require "test/unit"
+require "el_finder"
+require "fileutils"
+
+class TestElFinderPathname < Test::Unit::TestCase
+
+  def setup
+    @vroot = '/tmp/elfinder'
+    FileUtils.mkdir_p(@vroot)
+    FileUtils.cp_r "#{File.dirname(__FILE__)}/files/.",  @vroot
+  end
+
+  def teardown
+    FileUtils.rm_rf(@vroot)
+  end
+
+  ################################################################################
+
+  def test_paths_are_always_clean
+    assert_equal File.join(@vroot, 'foo/bar'), ElFinder::Pathname.new_with_root(@vroot, File.join('foo', '..', 'foo', 'bar')).to_s
+    assert_equal @vroot, ElFinder::Pathname.new_with_root(@vroot, '').to_s
+    assert_equal File.join(@vroot, 'foo/bar'), ElFinder::Pathname.new_with_root(@vroot, File.join('/foo', 'bar')).to_s
+  end
+
+  def test_duplication_without_extension
+    assert_equal File.join(@vroot, 'README copy 1'), ElFinder::Pathname.new_with_root(@vroot,'README').duplicate.to_s
+  end
+
+  def test_2nd_duplication_without_extension
+    ::FileUtils.touch(File.join(@vroot, 'README copy 1'))
+    assert_equal File.join(@vroot, 'README copy 2'), ElFinder::Pathname.new_with_root(@vroot,'README').duplicate.to_s
+  end
+
+  def test_duplication_with_extension
+    assert_equal File.join(@vroot, 'README copy 1.txt'), ElFinder::Pathname.new_with_root(@vroot,'README.txt').duplicate.to_s
+  end
+
+  def test_2nd_duplication_with_extension
+    ::FileUtils.touch(File.join(@vroot, 'README copy 1.txt'))
+    assert_equal File.join(@vroot, 'README copy 2.txt'), ElFinder::Pathname.new_with_root(@vroot,'README.txt').duplicate.to_s
+  end
+
+  def test_duplication_of_duplication_lookalike
+    assert_equal File.join(@vroot, 'README copy A copy 1.txt'), ElFinder::Pathname.new_with_root(@vroot,'README copy A.txt').duplicate.to_s
+  end
+
+  def test_duplication_of_duplication_lookalike2
+    assert_equal File.join(@vroot, 'README copy copy 1.txt'), ElFinder::Pathname.new_with_root(@vroot,'README copy.txt').duplicate.to_s
+  end
+
+  def test_on_disk_duplication
+    file = ElFinder::Pathname.new_with_root(@vroot, 'README.txt')
+    FileUtils.touch(file)
+    assert_equal true, File.exist?(File.join(@vroot, 'README.txt'))
+    duplicate = file.duplicate
+    FileUtils.touch(duplicate)
+    assert_equal true, File.exist?(File.join(@vroot, 'README copy 1.txt'))
+  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'
+    assert_kind_of ElFinder::Pathname, ElFinder::Pathname.new_with_root(@vroot, 'foo').join('bar')
+  end
+
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification 
+name: el_finder
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Philip Hallstrom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-15 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: imagesize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 1
+        - 1
+        version: 0.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id003
+description: |-
+  Ruby library to provide server side functionality for elFinder.  elFinder is an
+  open-source file manager for web, written in JavaScript using jQuery UI.
+email: 
+- philip@pjkh.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/el_finder.rb
+- lib/el_finder/connector.rb
+- lib/el_finder/image_resize.rb
+- lib/el_finder/image_size.rb
+- lib/el_finder/mime_type.rb
+- lib/el_finder/pathname.rb
+- test/files/README.txt
+- test/files/elfinder.png
+- test/files/foo/philip.txt
+- test/files/foo/sam.txt
+- test/files/foo/sandy.txt
+- test/files/foo/tom.txt
+- test/files/pjkh.png
+- test/test_el_finder.rb
+- test/test_el_finder_image_size.rb
+- test/test_el_finder_mime_type.rb
+- test/test_el_finder_pathname.rb
+has_rdoc: true
+homepage: http://elrte.org/redmine/projects/elfinder
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: el_finder
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby library to provide server side functionality for elFinder
+test_files: 
+- test/test_el_finder.rb
+- test/test_el_finder_image_size.rb
+- test/test_el_finder_mime_type.rb
+- test/test_el_finder_pathname.rb