hydra-head 4.1.3 → 5.0.0.pre1

data/lib/hydra/controller/assets_controller_behavior.rb

@@ -1,143 +0,0 @@
-# @deprecated  Create Model-specific Controllers instead ie. ArticlesController, ETDController, etc.
-# Also see Hydra::Controller::AssetsControllerBehavior for more info.
-# will move to lib/hydra/controller / assets_controller_behavior.rb in release 5.x
-require 'om'
-
-module Hydra::Controller::AssetsControllerBehavior
-  extend ActiveSupport::Concern
-
-  include Blacklight::SolrHelper
-  include Hydra::Controller::RepositoryControllerBehavior
-  include Hydra::AssetsControllerHelper
-  include ReleaseProcessHelper
-  include Blacklight::Catalog
-
-  included do
-    helper :hydra
-    include Hydra::UI::Controller
-    before_filter :search_session, :history_session
-    before_filter :load_document, :only => :update # allows other filters to operate on the document before the update method is called
-
-    include Hydra::SubmissionWorkflow
-    include Hydra::AccessControlsEnforcement
-    
-    
-    prepend_before_filter :sanitize_update_params, :only=>:update
-    before_filter :check_embargo_date_format, :only=>:update
-    before_filter :enforce_access_controls
-  end
-      
-  def show
-    if params.has_key?("field")
-      
-      @response, @document = get_solr_response_for_doc_id
-      result = @document["#{params["field"]}_t"]
-      unless result.nil?
-        if params.has_key?("field_index")
-          result = result[params["field_index"].to_i-1]
-        elsif result.kind_of?(Array)
-          result = result.first
-        end
-      end
-      respond_to do |format|
-        format.html     { render :text=>result }
-        format.textile  { render :text=> RedCloth.new(result, [:sanitize_html]).to_html  }
-      end
-    else
-      redirect_to catalog_path(params[:id])
-    end
-  end
-
-  # Uses the update_indexed_attributes method provided by ActiveFedora::Base
-  # This should behave pretty much like the ActiveRecord update_indexed_attributes method
-  # For more information, see the ActiveFedora docs.
-  # 
-  # @example Appends a new "subject" value of "My Topic" to on the descMetadata datastream in in the _PID_ document.
-  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"subject"=>{"-1"=>"My Topic"}}
-  # @example Sets the 1st and 2nd "medium" values on the descMetadata datastream in the _PID_ document, overwriting any existing values.
-  #   put :update, :id=>"_PID_", "asset"=>{"descMetadata"=>{"medium"=>{"0"=>"Paper Document", "1"=>"Image"}}
-  def update
-    logger.debug("attributes submitted: #{@sanitized_params.inspect}")
-         
-    @response = update_document(@document, @sanitized_params)
-   
-    @document.save
-    flash[:notice] = "Your changes have been saved."
-    
-    #logger.debug("returning #{@response.inspect}")
-    
-    respond_to do |want| 
-      want.html {
-        redirect_to next_step(params[:id])
-      }
-      want.js {
-        render :json=> tidy_response_from_update(@response)  
-      }
-      want.textile {
-        if @response.kind_of?(Hash)
-          textile_response = tidy_response_from_update(@response).values.first
-        end
-        render :text=> RedCloth.new(textile_response, [:sanitize_html]).to_html
-      }
-    end
-  end
-  
-  def new
-    af_model = retrieve_af_model(params[:content_type])
-    raise "Can't find a model for #{params[:content_type]}" unless af_model
-    @asset = af_model.new
-    apply_depositor_metadata(@asset)
-    set_collection_type(@asset, params[:content_type])
-    @asset.save
-    model_display_name = af_model.to_s.camelize.scan(/[A-Z][^A-Z]*/).join(" ")
-    msg = "Created a #{model_display_name} with pid #{@asset.pid}. Now it's ready to be edited."
-    flash[:notice]= msg
-    session[:scripts] = params[:combined] == "true"
-
-    redirect_to edit_catalog_path(@asset.pid, :new_asset=>true)
-  end
-  
-  def destroy
-    af = ActiveFedora::Base.find(params[:id], :cast=>true)
-    authorize! :destroy, af
-    assets = af.destroy_child_assets
-    af.delete
-    msg = "Deleted #{params[:id]}"
-    msg.concat(" and associated file_asset(s): #{assets.join(", ")}") unless assets.empty?
-    flash[:notice]= msg
-    redirect_to catalog_index_path()
-  end
-
-  
-  # This is a method to simply remove the item from SOLR but keep the object in fedora. 
-  alias_method :withdraw, :destroy
-  
-  protected
-
-
-  
-  def mods_assets_update_validation
-    desc_metadata = params[:asset][:descMetadata]
-    rights_metadata = params[:asset][:rightsMetadata]
-    if !rights_metadata.nil? and rights_metadata.has_key?(:embargo_embargo_release_date)
-      unless rights_metadata[:embargo_embargo_release_date]["0"].blank?
-        begin
-          parsed_date = Date.parse(rights_metadata[:embargo_embargo_release_date]["0"]).to_s
-          params[:asset][:rightsMetadata][:embargo_embargo_release_date]["0"] = parsed_date
-        rescue
-          flash[:error] = "You must enter a valid release date."
-          return false
-        end
-      end
-    end
-    
-    if !desc_metadata.nil? and desc_metadata.has_key?(:title_info_main_title) and desc_metadata.has_key?(:journal_0_title_info_main_title)
-      if desc_metadata[:title_info_main_title]["0"].blank? or desc_metadata[:journal_0_title_info_main_title]["0"].blank?
-        flash[:error] = "The title fields are required."
-        return false
-      end
-    end
-    
-    return true
-  end
-end

data/lib/hydra/controller/catalog_controller_behavior.rb

@@ -1,56 +0,0 @@
-# *Using this Module is not necessary if you're writing Controllers in Rails3.*  
-# In a Rails3 app, simply define regular Rails Controllers to expose the Resources & Actions you need and use Hydra::Controller to add Hydra support.
-# For search & discovery in those apps, use Blacklight and customize the "index" partials for each type of content to include links to the show/edit actions of the corresponding Controllers.
-#
-# This Module extends Blacklight Catalog behaviors to give you a "Hydra" Catalog with edit and show behaviors on top of the Blacklight search behaviors.
-# Include this module into any of your Blacklight Catalog classes (ie. CatalogController) to add Hydra functionality.
-#
-# will move to lib/hydra/controller/catalog_controller_behavior in release 5.x
-require 'deprecation'
-module Hydra::Controller::CatalogControllerBehavior
-  extend ActiveSupport::Concern
-  extend Deprecation
-
-  self.deprecation_horizon = 'hydra-head 5.x'
-  
-  
-  included do
-    Deprecation.warn(Hydra::Controller::CatalogControllerBehavior, "CatalogControllerBehavior is deprecated. You should make your own controllers using the Hydra::Controller::ControllerBehavior")
-    # Other modules to auto-include
-    include Hydra::UI::Controller
-    
-    # Controller filters
-    # Also see the generator (or generated CatalogController) to see more before_filters in action
-    before_filter :load_fedora_document, :only=>[:show,:edit]
-    
-    # View Helpers
-    helper :hydra_uploader
-    helper :article_metadata
-    rescue_from ActiveFedora::ObjectNotFoundError, :with => :nonexistent_document
-  end
-  
-  def edit
-    show
-    render "show"
-  end
-  #deprecation_deprecate :edit
-  
-  # This will render the "delete" confirmation page and a form to submit a destroy request to the assets controller
-  def delete
-    show
-    render "show"
-  end
-  #deprecation_deprecate :delete
-  
-  def nonexistent_document *args
-    if Rails.env == "development"
-      render "nonexistent_document"
-    else
-      flash[:notice] = "Sorry, you have requested a record that doesn't exist."
-      params.delete(:id)
-      index
-      render "index", :status => 404
-    end
-  end
-  #deprecation_deprecate :nonexistent_document
-end

data/lib/hydra/controller/controller_behavior.rb

@@ -1,59 +0,0 @@
-# Include this module into any of your Controller classes to add Hydra functionality
-#
-# The primary function of this module is to mix in a number of other Hydra Modules, including 
-#   Hydra::AccessControlsEnforcement
-#
-# @example 
-#  class CustomHydraController < ApplicationController  
-#    include Hydra::Controller
-#  end
-#
-# will move to lib/hydra/controller/controller_behavior in release 5.x
-require 'deprecation'
-module Hydra::Controller::ControllerBehavior
-  extend ActiveSupport::Concern
-  extend Deprecation
-  self.deprecation_horizon = 'hydra-head 5.x'
-
-  included do
-    # Other modules to auto-include
-    include Hydra::AccessControlsEnforcement
-    include Hydra::Controller::RepositoryControllerBehavior
-  
-    helper :hydra
-    helper :hydra_assets
-
-    # Catch permission errors
-    rescue_from Hydra::AccessDenied do |exception|
-      if (exception.action == :edit)
-        redirect_to({:action=>'show'}, :alert => exception.message)
-      elsif current_user and current_user.persisted?
-        redirect_to root_url, :alert => exception.message
-      else
-        session["user_return_to"] = request.url
-        redirect_to new_user_session_url, :alert => exception.message
-      end
-    end
-  end
-  
-  # Use params[:id] to load an object from Fedora.  Inspects the object for known models and mixes in any of those models' behaviors.
-  # Sets @document_fedora with the loaded object
-  # Sets @file_assets with file objects that are children of the loaded object
-  def load_fedora_document
-    @document_fedora = ActiveFedora::Base.find(params[:id], :cast=>true)
-    unless @document_fedora.class.include?(Hydra::ModelMethods)
-      @document_fedora.class.send :include, Hydra::ModelMethods
-    end
-    
-    @file_assets = @document_fedora.parts(:response_format=>:solr)
-  end
-  deprecation_deprecate :load_fedora_document
-  
-  
-  # get the currently configured user identifier.  Can be overridden to return whatever (ie. login, email, etc)
-  # defaults to using whatever you have set as the Devise authentication_key
-  def user_key
-    current_user.user_key if current_user
-  end
-  
-end

data/lib/hydra/controller/file_assets_behavior.rb

@@ -1,144 +0,0 @@
-# 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
-    authorize! :edit, (params[:container_id] || params[:id])
-    
-    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
-    authorize! :destroy, params[:id]
-    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

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