hydra-head 4.0.3 → 4.1.0

data/lib/hydra/controller/file_assets_behavior.rb

@@ -0,0 +1,142 @@
+# will move to lib/hydra/controller / file_assets_controller_behavior.rb in release 5.x
+module Hydra::Controller::FileAssetsBehavior
+  extend ActiveSupport::Concern
+  
+  included do
+    include Hydra::AccessControlsEnforcement
+    include Hydra::AssetsControllerHelper
+    include Hydra::Controller::UploadBehavior 
+    include Hydra::Controller::RepositoryControllerBehavior
+    include Hydra::UI::Controller
+    include Blacklight::SolrHelper
+    include Hydra::SubmissionWorkflow
+    include Blacklight::Configurable
+    copy_blacklight_config_from(CatalogController)
+    prepend_before_filter :sanitize_update_params
+    helper :hydra_uploader
+  end
+  
+  def index
+    if params[:layout] == "false"
+      layout = false
+    end
+
+    if params[:asset_id].nil?
+      @solr_result = FileAsset.find_by_solr(:all)
+    else
+      container_uri = "info:fedora/#{params[:asset_id]}"
+      escaped_uri = container_uri.gsub(/(:)/, '\\:')
+      extra_controller_params =  {:q=>"is_part_of_s:#{escaped_uri}", :qt=>'standard'}
+      @response, @document_list = get_search_results( extra_controller_params )
+      
+      # Including this line so permissions tests can be run against the container
+      @container_response, @document = get_solr_response_for_doc_id(params[:asset_id])
+      
+      # Including these lines for backwards compatibility (until we can use Rails3 callbacks)
+      @container =  ActiveFedora::Base.find(params[:asset_id], :cast=>true)
+      @solr_result = @container.parts(:response_format=>:solr)
+    end
+    
+    # Load permissions_solr_doc based on params[:asset_id]
+    load_permissions_from_solr(params[:asset_id])
+    
+    render :action=>params[:action], :layout=>layout
+  end
+  
+  def new
+    render :partial=>"new", :layout=>false
+  end
+  
+  # Creates and Saves a File Asset to contain the the Uploaded file 
+  # If container_id is provided:
+  # * the File Asset will use RELS-EXT to assert that it's a part of the specified container
+  # * the method will redirect to the container object's edit view after saving
+  def create
+    if params.has_key?(:number_of_files) and params[:number_of_files] != "0"
+      return redirect_to edit_catalog_path(params[:id], :wf_step => :files, :number_of_files => params[:number_of_files])
+    elsif params.has_key?(:number_of_files) and params[:number_of_files] == "0"
+      return redirect_to next_step(params[:id])
+    end
+    
+    if params.has_key?(:Filedata)
+      notice = process_files
+      flash[:notice] = notice.join("<br/>".html_safe) unless notice.blank?
+    else
+      flash[:notice] = "You must specify a file to upload."
+    end
+    
+    if params[:container_id]
+      redirect_to next_step(params[:container_id])
+    else
+      redirect_to catalog_index_path
+    end
+
+  end
+
+  def process_files
+    @file_assets = create_and_save_file_assets_from_params
+    notice = []
+    @file_assets.each do |file_asset|
+      apply_depositor_metadata(file_asset)
+
+      notice << render_to_string(:partial=>'hydra/file_assets/asset_saved_flash', :locals => { :file_asset => file_asset })
+        
+      if !params[:container_id].nil?
+        associate_file_asset_with_container(file_asset,'info:fedora/' + params[:container_id])
+      end
+
+      ## Apply any posted file metadata
+      unless params[:asset].nil?
+        logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
+        apply_file_metadata
+      end
+      # If redirect_params has not been set, use {:action=>:index}
+      logger.debug "Created #{file_asset.pid}."
+    end
+    notice
+  end
+  
+  # Common destroy method for all AssetsControllers 
+  def destroy
+    ActiveFedora::Base.find(params[:id], :cast=>true).delete 
+
+    flash[:notice] = "Deleted #{params[:id]} from #{params[:container_id]}."
+    
+    if !params[:container_id].nil?
+      redirect_params = edit_catalog_path(params[:container_id], :anchor => "file_assets")
+    end
+    redirect_params ||= {:action => 'index', :q => nil , :f => nil}
+    
+    redirect_to redirect_params
+    
+  end
+  
+  
+  def show
+    begin
+      @file_asset = FileAsset.find(params[:id])
+    rescue ActiveFedora::ObjectNotFoundError
+      logger.warn("No such file asset: " + params[:id])
+      flash[:notice]= "No such file asset."
+      redirect_to(:action => 'index', :q => nil , :f => nil)
+      return
+    end
+    # get containing object for this FileAsset
+    pid = @file_asset.container_id
+    parent = ActiveFedora::Base.find(pid, :cast=>true)
+    @downloadable = false
+    # A FileAsset is downloadable iff the user has read or higher access to a parent
+
+    if can? :read, parent
+      # First try to use datastream_id value (set in FileAssetsHelper)
+      if @file_asset.datastreams.include?(datastream_id)
+        send_datastream @file_asset.datastreams[datastream_id]
+      elsif @file_asset.datastreams.include?("DS1")
+        send_datastream @file_asset.datastreams["DS1"]
+      end
+    else
+      raise Hydra::AccessDenied.new("You do not have sufficient access privileges to download this file.")
+    end
+  end
+end
+

data/lib/hydra/controller/repository_controller_behavior.rb

@@ -0,0 +1,119 @@
+# Hydra-repository Contoller is a controller layer mixin. It is in the controller scope: request params, session etc.
+# 
+# will move to lib/hydra/controller/repository_controller_behavior in release 5.x
+# 
+# NOTE: Be careful when creating variables here as they may be overriding something that already exists.
+# The ActionController docs: http://api.rubyonrails.org/classes/ActionController/Base.html
+#
+# Override these methods in your own controller for customizations:
+# 
+# class HomeController < ActionController::Base
+#   
+#   include Stanford::SolrHelper
+#   
+#   def solr_search_params
+#     super.merge :per_page=>10
+#   end
+#   
+# end
+#
+module Hydra::Controller::RepositoryControllerBehavior
+  
+  def self.included(c)
+    if c.respond_to?(:helper_method)
+      c.helper_method :solr_name
+      c.helper_method :format_pid
+    end
+  end
+  
+  
+  #
+  # This method converts pid strings into xhtml safe IDs, since xhmlt expects namespaces to be defined. 
+  # I.E. hydrus:123 = hydrus_123
+  def format_pid(pid)
+    pid.gsub(":", "_")
+  end
+  
+  
+  
+  def solr_name(field_name, field_type = :text)
+    ::ActiveFedora::SolrService.solr_name(field_name, field_type)
+  end
+  
+  
+  # Returns a list of datastreams for download.
+  # Uses user's roles and "mime_type" value in submitted params to decide what to return.
+  # if you pass the optional argument of :canonical=>true, it will return the canonical datastream for this object (a single object not a hash of datastreams)
+  def downloadables(fedora_object=@fedora_object, opts={})
+    if opts[:canonical]
+      mime_type = opts[:mime_type] ? opts[:mime_type] : "application/pdf"
+      result = filter_datastreams_for_mime_type(fedora_object.datastreams, mime_type).sort.first[1]
+    elsif can? :edit, fedora_object
+      if params["mime_type"] == "all"
+        result = fedora_object.datastreams
+      else
+        result = Hash[]
+        fedora_object.datastreams.each_pair do |dsid,ds|
+          if !ds.new_object?
+            mime_type = ds.mimeType ? ds.mimeType : ""
+            if mime_type.include?("pdf") || ds.label.include?("_TEXT.xml") || ds.label.include?("_METS.xml")
+             result[dsid] = ds
+            end 
+          end 
+        end
+      end
+    else
+      result = Hash[]
+      fedora_object.datastreams.each_pair do |dsid,ds|
+         if ds.mimeType.include?("pdf")
+           result[dsid] = ds
+         end  
+       end
+    end 
+    # puts "downloadables result: #{result}"
+    return result    
+  end
+
+  protected 
+  def load_document
+    @document = load_document_from_params
+  end
+
+  # Uses submitted params Hash to figure out what Model to load
+  # params should contain :content_type and :id
+  def load_document_from_params
+    af_model = retrieve_af_model(params[:content_type])
+    unless af_model 
+      af_model = ModsAsset
+    end
+    return af_model.find(params[:id])
+  end
+  
+  def retrieve_af_model(class_name, opts={})
+    if !class_name.nil?
+      klass = Module.const_get(class_name.camelcase)
+    else
+      klass = nil
+    end
+    if klass.is_a?(Class) && klass.superclass == ActiveFedora::Base
+      return klass
+    else
+      return opts.fetch(:default, false)
+    end
+    rescue NameError
+      return false
+  end
+
+  private
+  
+  def filter_datastreams_for_mime_type(datastreams_hash, mime_type)
+    result = Hash[]
+    datastreams_hash.each_pair do |dsid,ds|
+      ds_mime_type = ds.mimeType ? ds.mimeType : ""
+      if ds_mime_type == mime_type
+       result[dsid] = ds
+      end  
+    end
+    return result
+  end
+end

data/lib/hydra/controller/upload_behavior.rb

@@ -0,0 +1,139 @@
+# will move to lib/hydra/controller / upload_behavior.rb in release 5.x
+module Hydra::Controller::UploadBehavior
+  
+  # Creates a File Asset, adding the posted blob to the File Asset's datastreams and saves the File Asset
+  #
+  # @return [FileAsset] the File Asset  
+  def create_and_save_file_assets_from_params
+    if params.has_key?(:Filedata)
+      @file_assets = []
+      params[:Filedata].each do |file|
+        @file_asset = create_asset_from_file(file)
+        add_posted_blob_to_asset(@file_asset,file)
+        @file_asset.save
+        @file_assets << @file_asset
+      end
+      return @file_assets
+    else
+      render :text => "400 Bad Request", :status => 400
+    end
+  end
+  
+  # Puts the contents of params[:Filedata] (posted blob) into a datastream within the given @asset
+  # Sets asset label and title to filename if they're empty
+  #
+  # @param [FileAsset] asset the File Asset to add the blob to
+  # @return [FileAsset] file the File Asset  
+  def add_posted_blob_to_asset(asset, file)
+    #file_name = filename_from_params
+    file_name = file.original_filename
+    options = {:label=>file_name, :mimeType=>mime_type(file_name)}
+    dsid = datastream_id #Only call this once so that it could be a sequence
+    options[:dsid] = dsid if dsid
+    asset.add_file_datastream(file, options)
+    asset.set_title_and_label( file_name, :only_if_blank=>true )
+  end
+
+  #Override this if you want to specify the datastream_id (dsID) for the created blob
+  def datastream_id
+    "content"
+  end
+  
+  # Associate the new file asset with its container
+  def associate_file_asset_with_container(file_asset=nil, container_id=nil)
+    if container_id.nil?
+      container_id = params[:asset_id]
+    end
+    if file_asset.nil?
+      file_asset = @file_asset
+    end
+    file_asset.add_relationship(:is_part_of, container_id)
+    file_asset.datastreams["RELS-EXT"].dirty = true
+    file_asset.save
+  end
+  
+  # Apply any posted file metadata to the file asset
+  def apply_posted_file_metadata         
+    @metadata_update_response = update_document(@file_asset, @sanitized_params)
+    @file_asset.save
+  end
+  
+  
+  # The posted File 
+  # @return [File] the posted file.  Defaults to nil if no file was posted.
+  def posted_file
+    params[:Filedata]
+  end
+  
+  # A best-guess filename based on POST params
+  # If Filename was submitted, it uses that.  Otherwise, it calls +original_filename+ on the posted file
+  def filename_from_params
+    if !params[:Filename].nil?
+      file_name = params[:Filename]      
+    else
+      file_name = posted_file.original_filename
+      params[:Filename] = file_name
+    end
+  end
+
+  # Creates a File Asset and sets its label from params[:Filename]
+  #
+  # @return [FileAsset] the File Asset
+  def create_asset_from_params    
+    file_asset = FileAsset.new
+    file_asset.label = params[:Filename]
+    
+    return file_asset
+  end
+  
+  # Creates a File Asset and sets its label from filename
+  #
+  # @return [FileAsset] the File Asset
+  def create_asset_from_file(file)
+    file_asset = FileAsset.new
+    file_asset.label = file.original_filename
+
+    return file_asset
+  end
+  
+  
+  # This is pre-Hydra code that created an AudioAsset, VideoAsset or ImageAsset based on the
+  # current params in the controller.
+  #
+  # @return [Constant] the recommended Asset class 
+  def asset_class_from_params
+    if params.has_key?(:type)
+      chosen_type = case params[:type]
+      when "AudioAsset"
+        AudioAsset
+      when "VideoAsset"
+        VideoAsset
+      when "ImageAsset"
+        ImageAsset
+      else
+        FileAsset
+      end
+    elsif params.has_key?(:Filename)
+      chosen_type = choose_model_by_filename( params[:Filename] )
+    else
+      chosen_type = FileAsset
+    end
+    
+    return chosen_type
+  end
+  
+  def choose_model_by_filename(filename)
+    choose_model_by_filename_extension( File.extname(filename) )
+  end
+  
+
+  private
+  # Return the mimeType for a given file name
+  # @param [String] file_name The filename to use to get the mimeType
+  # @return [String] mimeType for filename passed in. Default: application/octet-stream if mimeType cannot be determined
+  def mime_type file_name
+    mime_types = MIME::Types.of(file_name)
+    mime_type = mime_types.empty? ? "application/octet-stream" : mime_types.first.content_type
+  end
+  
+end

data/lib/hydra/file_assets.rb

@@ -1,146 +1,11 @@
 # will move to lib/hydra/controller / file_assets_controller_behavior.rb in release 5.x
+require 'deprecation'
 module Hydra::FileAssets
   extend ActiveSupport::Concern
   
   included do
-    include Hydra::AccessControlsEnforcement
-    include Hydra::AssetsControllerHelper
-    include Hydra::FileAssetsHelper  
-    include Hydra::RepositoryController  
-    include Hydra::UI::Controller
-    include Blacklight::SolrHelper
-    include Hydra::SubmissionWorkflow
-    include Blacklight::Configurable
-    copy_blacklight_config_from(CatalogController)
-    prepend_before_filter :sanitize_update_params
-    helper :hydra_uploader
-  end
-  
-  def index
-    if params[:layout] == "false"
-      layout = false
-    end
-
-    if params[:asset_id].nil?
-      @solr_result = FileAsset.find_by_solr(:all)
-    else
-      container_uri = "info:fedora/#{params[:asset_id]}"
-      escaped_uri = container_uri.gsub(/(:)/, '\\:')
-      extra_controller_params =  {:q=>"is_part_of_s:#{escaped_uri}", :qt=>'standard'}
-      @response, @document_list = get_search_results( extra_controller_params )
-      
-      # Including this line so permissions tests can be run against the container
-      @container_response, @document = get_solr_response_for_doc_id(params[:asset_id])
-      
-      # Including these lines for backwards compatibility (until we can use Rails3 callbacks)
-      @container =  ActiveFedora::Base.find(params[:asset_id], :cast=>true)
-      @solr_result = @container.parts(:response_format=>:solr)
-    end
-    
-    # Load permissions_solr_doc based on params[:asset_id]
-    load_permissions_from_solr(params[:asset_id])
-    
-    render :action=>params[:action], :layout=>layout
-  end
-  
-  def new
-    render :partial=>"new", :layout=>false
-  end
-  
-  # Creates and Saves a File Asset to contain the the Uploaded file 
-  # If container_id is provided:
-  # * the File Asset will use RELS-EXT to assert that it's a part of the specified container
-  # * the method will redirect to the container object's edit view after saving
-  def create
-    if params.has_key?(:number_of_files) and params[:number_of_files] != "0"
-      return redirect_to edit_catalog_path(params[:id], :wf_step => :files, :number_of_files => params[:number_of_files])
-    elsif params.has_key?(:number_of_files) and params[:number_of_files] == "0"
-      return redirect_to next_step(params[:id])
-    end
-    
-    if params.has_key?(:Filedata)
-      notice = process_files
-      flash[:notice] = notice.join("<br/>".html_safe) unless notice.blank?
-    else
-      flash[:notice] = "You must specify a file to upload."
-    end
-    
-    if params[:container_id]
-      redirect_to next_step(params[:container_id])
-    else
-      redirect_to catalog_index_path
-    end
-
-  end
-
-  def process_files
-    @file_assets = create_and_save_file_assets_from_params
-    notice = []
-    @file_assets.each do |file_asset|
-      apply_depositor_metadata(file_asset)
-
-      notice << render_to_string(:partial=>'hydra/file_assets/asset_saved_flash', :locals => { :file_asset => file_asset })
-        
-      if !params[:container_id].nil?
-        associate_file_asset_with_container(file_asset,'info:fedora/' + params[:container_id])
-      end
-
-      ## Apply any posted file metadata
-      unless params[:asset].nil?
-        logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
-        apply_file_metadata
-      end
-      # If redirect_params has not been set, use {:action=>:index}
-      logger.debug "Created #{file_asset.pid}."
-    end
-    notice
-  end
-  
-  # Common destroy method for all AssetsControllers 
-  def destroy
-    ActiveFedora::Base.find(params[:id], :cast=>true).delete 
-
-    flash[:notice] = "Deleted #{params[:id]} from #{params[:container_id]}."
-    
-    if !params[:container_id].nil?
-      redirect_params = edit_catalog_path(params[:container_id], :anchor => "file_assets")
-    end
-    redirect_params ||= {:action => 'index', :q => nil , :f => nil}
-    
-    redirect_to redirect_params
-    
-  end
-  
-  
-  def show
-    begin
-      @file_asset = FileAsset.find(params[:id])
-    rescue ActiveFedora::ObjectNotFoundError
-      logger.warn("No such file asset: " + params[:id])
-      flash[:notice]= "No such file asset."
-      redirect_to(:action => 'index', :q => nil , :f => nil)
-      return
-    end
-    # get containing object for this FileAsset
-    pid = @file_asset.container_id
-    parent = ActiveFedora::Base.find(pid, :cast=>true)
-    @downloadable = false
-    # A FileAsset is downloadable iff the user has read or higher access to a parent
-    if can? :read, parent
-      @downloadable = true
-    end
-
-    if @downloadable
-      # First try to use datastream_id value (set in FileAssetsHelper)
-      if @file_asset.datastreams.include?(datastream_id)
-        send_datastream @file_asset.datastreams[datastream_id]
-      elsif @file_asset.datastreams.include?("DS1")
-        send_datastream @file_asset.datastreams["DS1"]
-      end
-    else
-      flash[:notice]= "You do not have sufficient access privileges to download this file."
-      redirect_to :back
-    end
+    Deprecation.warn Hydra::FileAssets, "Hydra::FileAssets was moved to Hydra::Controller::FileAssetsBehavior"
+    include Hydra::Controller::FileAssetsBehavior
   end
 end