bcms_webdav 1.0.4 → 2.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gemspec
+gem "jquery-rails"
+gem 'sqlite3'
+
+group :test do 
+	gem 'mocha'
+end

data/README.rdoc

@@ -23,33 +23,30 @@ In order to take advantage of this module, users will need a WebDAV client. Many
 * Transmit (Mac OS) -  http://panic.com/transmit/
 * CrossFTP Pro (Windows, etc) - http://www.crossftp.com/
 
-This module has been tested with both of the above client. In addition, operating systems support accessing WebDAV
+This module has been tested with both of the above clients. In addition, operating systems support accessing WebDAV
 servers via mounted drives. See: http://en.wikipedia.org/wiki/WebDAV for more discussion.
 
 === Installation
 
-Due to the dependancy on rack 1.1.0 or later, this gem only works with a Rails 2.3.11 project, so you may need to upgrade older rails projects before using.
+	$ gem install bcms_webdav
+    $ rails g cms:install bcms_webdav
 
-    gem install bcms_webdav
+In your config/environments/development.rb, add the following:
 
-Add the gem to your project.
-
-    # config/environment.rb
-    config.gem 'dav4rack'
-    config.gem 'bcms_webdav'
-
-Add the following file to your project.
-
-    # config/initializers/bcms_webdav.rb
-    Rails.configuration.middleware.use Bcms::WebDavMiddleware, :port=>3001
+    config.middleware.use Bcms::WebDavMiddleware, :port=>3001
 
 This configures the WebDAV server to listen on port 3001 for WeDAV requests in development. To access the WebDAV API,
 you will need to start another rails server instance like so:
 
     script/server --port=3001
 
-In production, a subdomain should be used rather than a port. You will need to configure another subdomain on your webserver, much like the cms.
-subdomain is used for the admin interface. The default subdomain is 'webdav'. Here's an example apache config file, with a new subdomain configured:
+==== For production
+
+In your production.rb, add the following:
+
+		config.middleware.use Bcms::WebDavMiddleware
+		
+In production, a subdomain should be used rather than a port. You will need to configure another subdomain on your webserver, much like the cms. subdomain is used for the admin interface. The default subdomain is 'webdav'. Here's an example apache config file, with a new subdomain configured:
 
      <VirtualHost *:80>
       ServerName webdav.mysite.com
@@ -70,8 +67,7 @@ This means there should be a total of three domains in place for a site in produ
 
 You can change the subdomain that this module listens for requests on via:
 
-    # config/initializers/bcms_webdav.rb
-    Rails.configuration.middleware.use Bcms::WebDavMiddleware, :port=>3001, :subdomain=>"dav"
+    config.middleware.use Bcms::WebDavMiddleware, :port=>3001, :subdomain=>"dav"
 
 This would change the subdomain from 'webdav' to 'dav'. This webserver config file would also need to be changed as well.
 
@@ -84,8 +80,7 @@ make 'webdav.localhost' map to your local development environment, like so:
 
 Then configure the module so its no longer listening on port 3001, like so:
 
-    # config/initializers/bcms_webdav.rb
-    Rails.configuration.middleware.use Bcms::WebDavMiddleware
+    config.middleware.use Bcms::WebDavMiddleware
 
 Now you can make web requests to localhost:3000 and WebDAV requests to webdav.localhost:3000
 
@@ -102,8 +97,11 @@ This is an incomplete implementation of WebDAV, so many operations are not expli
 * All files are uploaded as 'FileBlocks', regardless of whether they are images or not.
 * All content_types are set to 'application/octet-stream' regardless of their actual type.
 * Links do not appear in the list of content items returned.
+* Uploading a file with a space in it will not replace the existing file. Since we convert spaces into _, they are treated as two separate resources.
+* Refactoring to avoid the need for configuring the middleware is possible. Engines can self setup middleware now.
 
 === Performance
 
 This module almost certainly needs performance testing when dealing with larger sites. Certain FTP clients will make more requests for
-resources than others. (CrossFTP seems 'chattier' than Transmit for instance).
+resources than others. (CrossFTP seems 'chattier' than Transmit for instance).
+

data/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/javascripts/bcms_webdav/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/bcms_webdav/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/bcms_webdav/application_controller.rb

@@ -0,0 +1,4 @@
+module BcmsWebdav
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/bcms_webdav/application_helper.rb

@@ -0,0 +1,4 @@
+module BcmsWebdav
+  module ApplicationHelper
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+BcmsWebdav::Engine.routes.draw do
+end

data/lib/bcms_webdav.rb

@@ -1,5 +1,7 @@
-require 'bcms_webdav/routes'
-require 'bcms_webdav/web_dav_middleware'
+require "bcms_webdav/engine"
 require 'bcms_webdav/file'
-require 'bcms_webdav/bcms_attachment_extensions'
 require 'bcms_webdav/resource'
+require 'bcms_webdav/web_dav_middleware'
+
+module BcmsWebdav
+end

data/lib/bcms_webdav/bcms_attachment_extensions.rb

@@ -1,7 +1,26 @@
-Attachment.class_eval do
-
-  # Exist to ensure compliance with Resource API for WebDAV (like Section and Pages).
-  def path
-    file_path
+# Exist to ensure compliance with Resource API for WebDAV (like Section and Pages).
+module BcmsWebdav
+  
+  # Attachment#path is actually the file path, so we have to define a new method that all
+  # child_nodes can use.
+  module Extensions
+    module Attachments
+      def relative_path
+        url
+      end
+    end
+    
+    module Pages
+      def relative_path
+        path
+      end
+    end
+    
+    module Sections
+      def relative_path
+        path
+      end
+    end
+    
   end
-end
+end

data/lib/bcms_webdav/engine.rb

@@ -0,0 +1,16 @@
+require 'browsercms'
+require 'dav4rack'
+
+module BcmsWebdav
+  class Engine < ::Rails::Engine
+    isolate_namespace BcmsWebdav
+    include Cms::Module
+
+    config.to_prepare do
+      require 'bcms_webdav/bcms_attachment_extensions'
+      Cms::Attachment.send(:include, BcmsWebdav::Extensions::Attachments)
+      Cms::Page.send(:include, BcmsWebdav::Extensions::Pages)
+      Cms::Section.send(:include, BcmsWebdav::Extensions::Sections)
+    end
+  end
+end

data/lib/bcms_webdav/file.rb

@@ -5,26 +5,21 @@ module Bcms
     # public path of CMS files is different that actual file path.
     class File < Rack::File
 
-      # This should be an absolute file path
+      # @param [String] absolute_file_path Absolute path to the file on the server.
       def initialize(absolute_file_path)
-        @path = absolute_file_path
+        @cms_path_to_file = absolute_file_path
+        
+        # Normally, files are restricted under the root of the web application.
+        # Here, we set the root to blank. The cms_path_to_file is the complete path to the file.
+        @root = ""
       end
 
-      # Don't look up from PATH, look up from passed in variable
-      def _call(env)
-        Rails.logger.debug "Starting to serve file @ path #{@path}"
-
-        # From here down is a copy&paste of Rack::File#_call
-        begin
-          if F.file?(@path) && F.readable?(@path)
-            serving
-          else
-            raise Errno::EPERM
-          end
-        rescue SystemCallError
-          not_found
-        end
+      # As of Rack 1.4.1, we override this call to have it stuff the CMS path into the PATH_INFO
+      def call(env)
+        env['PATH_INFO'] = @cms_path_to_file
+        dup._call(env)
       end
+
     end
   end
 end

data/lib/bcms_webdav/resource.rb

@@ -26,7 +26,7 @@ module Bcms
 
       def authenticate(username, password)
         log "Authenticating user '#{username}'"
-        user = User.authenticate(username, password)
+        user = Cms::User.authenticate(username, password)
 
         unless user
           Rails.logger.error "Failed authentication attempt by user '#{username}'"
@@ -52,20 +52,20 @@ module Bcms
       # This should always be called by DAV4Rack controller before any other primary operation (get, put) on a resource.
       def exist?
         path_to_find = Resource.normalize_path(path)
-        @section = Section.with_path(path_to_find).first
+        @section = Cms::Section.with_path(path_to_find).first
 
         if have_section
           log_exists('section', path_to_find)
           @resource = @section if have_section
         end
 
-        @page = Page.with_path(path_to_find).first
+        @page = Cms::Page.with_path(path_to_find).first
         if have_page
           log_exists('page', path_to_find)
           @resource = @page
         end
 
-        @file = Attachment.find_by_file_path(path)
+        @file = Cms::Attachment.find_live_by_file_path(path)
         if have_file
           log_exists('file', path_to_find)
           @resource = @file
@@ -73,7 +73,14 @@ module Bcms
 
         have_section || have_page || have_file
       end
-
+      
+      # Find the parent resource. We cache the result here so it can be loaded from the DB properly.
+      def parent
+        return @parent if @parent
+        @parent = super
+        @parent
+      end
+    
       def children
         if exist?
           child_nodes = @section.child_nodes
@@ -88,12 +95,14 @@ module Bcms
         end
       end
 
+      # 1 year ago handles missing files (which is hopefully a temporary bug while trying to upgrade to CMS 3.5)
       def creation_date
-        @resource.created_at
+        @resource ? @resource.created_at : 1.year.ago
       end
 
       def last_modified
-        @resource.created_at if exist?
+        return @resource.created_at if exist?
+        1.year.ago
       end
 
       def collection?
@@ -109,16 +118,16 @@ module Bcms
       end
 
       def content_length
-        have_file ? @resource.file_size : 0
+        have_file ? @resource.size : 0
       end
 
       def get(request, response)
-        log "GET request for #{request.path}"
+        # log "GET request for #{request.path}"
         if have_file
-          file_location = @resource.full_file_location
-          log "For attachment '#{@resource}' file location is '#{file_location}"
-          file = Bcms::WebDAV::File.new(file_location)
-          log "Sending file '#{file.path}'"
+          path_to_file = @resource.data.path
+          # log "For attachment '#{@resource}' path to file is '#{path_to_file}"
+          file = Bcms::WebDAV::File.new(path_to_file)
+          log "Sending file '#{path_to_file}'"
           response.body = file
         end
       end
@@ -126,82 +135,75 @@ module Bcms
       # Handle uploading file.
       def put(request, response)
         temp_file = extract_tempfile(request)
-
-        add_rails_like_methods(temp_file)
-
         section = find_section_for(path)
 
-        file_block = FileBlock.new(:name=>path, :attachment_file=>temp_file, :attachment_section => section, :attachment_file_path=>path, :publish_on_save=>true)
+        file_block = Cms::FileBlock.new(:name=>path, :publish_on_save=>true)
+        file_block.attachments.build(:data => temp_file, :attachment_name => 'file', :parent => section, :data_file_path => path)
+        
+        # Ensure the file pointer is at the beginning so Paperclip can copy after the block is saved.
+        # Something in assigning the tempfile to the Block is not correctly rewinding the file.
+        # Not doing this causes an empty file to be saved in uploads directory.
+        temp_file.rewind
+        
         unless file_block.save
           log "Couldn't save file."
           file_block.errors.each do |error|
             log error
           end
-          return
+          work_around_dav4rack_bug
+          return InternalServerError
         end
-        OK
+        Created
       end
 
+
+      # Ensures path is encoded. In most cases, an encoded path may occur after uploading a file (PUT) with special characters in it.
+      def public_path
+        p = super
+        begin
+          URI(p)
+        rescue URI::InvalidURIError
+          return URI.escape(p)
+        end
+        p
+      end
+      
+      # If Created isn't returned, dav4rack controller will set the body to nil, which will cause Rack to blow up.
+      # i.e. response.body = response['Location'] but 'Location' is only set if Created == true
+      # See https://github.com/chrisroberts/dav4rack/blob/master/lib/dav4rack/controller.rb#put
+      def work_around_dav4rack_bug
+        response['Location'] = ''
+      end
+      
       def find_section_for(path)
-        log "Looking up section for path '#{path}"
         path_obj = Path.new(path)
         section_path = path_obj.path_without_filename
         path_to_find = Resource.normalize_path(section_path)
-
-        log "Section.path = #{path_to_find}"
-        Section.with_path(path_to_find).first
+        Cms::Section.with_path(path_to_find).first
       end
 
       private
 
-      # Different webservers have slightly different behavior for uploaded files.
-      #   1. Webrick/mongrel - body is a TempFile
-      #   2. Passenger - body is a PhusionPassenger::Utils::RewindableInput
-      #
-      # Until Rails 3, which may have a consistent middleware for extracting a Tempfile, we have to do it this way.
+      # Save and return the tempfile. This is slightly duplicative of how Rack/Rails save a tempfile, then Paperclip automatically 
+      # handles copying it. In our case, since WebDAV isn't like a form multipart upload, we have to explicitly save it 
+      # rather than having Rails implicitly handle this for us.
       def extract_tempfile(request)
-        input = request.body
-        if input
-          # Handle Mongrel
-          return input if input.is_a?(Tempfile)
-
-          # Handle Passenger
-          # This is highly brittle and terrible.
-          if input.respond_to?(:make_rewindable, true)
-            input.size # Force creation of Tempfile
-            return input.instance_variable_get(:@rewindable_io)
-          end
-        end
-
 
+        uploaded_file = Paperclip.io_adapters.for(request.body)
+        uploaded_path = Path.new(path)
+        uploaded_file.original_filename = uploaded_path.file_name
+        uploaded_file.content_type = 'application/octet-stream'
+        uploaded_file
       end
 
       def log_exists(type, path)
         log "Resource of type '#{type}' with path '#{path}' exists."
       end
 
-      # Make this TempFile object act like a RailsTempFile
-      def add_rails_like_methods(temp_file)
-        # For the purposes of Rails 2, this will have to do. Rails 3 make this much easier by providing additional
-        # Rack processors for ActionDispatch::Http::UploadedFile which makes this unncessary.
-
-        def temp_file.content_type
-          'application/octet-stream'
-        end
-
-        def temp_file.original_filename
-          path
-        end
-
-        def temp_file.local_path
-          self.path
-        end
-      end
-
       def child_node(section_node)
         node_object = section_node.node
-        return nil if node_object == nil || node_object.is_a?(Link)
-        child_node = self.class.new(node_object.path, node_object.path, request, response, options.merge(:user => @user))
+        return nil if node_object == nil || node_object.is_a?(Cms::Link)
+        child_node = self.class.new(node_object.relative_path, node_object.relative_path, request, response, options.merge(:user => @user))
         child_node.exist? # Force lookup of info from DB.
         child_node
       end
@@ -232,6 +234,10 @@ module Bcms
         @parts = scanned[0]
       end
 
+      def sanitize_file_path(path)
+        Cms::Attachment.sanitize_file_path(path)
+      end
+      
       def parts
         @parts
       end