cul_scv_hydra 0.3.0

data/lib/cul_scv_hydra/controllers/helpers/resources_helper_behavior.rb

@@ -0,0 +1,160 @@
+require 'hydra'
+require 'net/http'
+require 'open-uri'
+require 'tempfile'
+require 'uri'
+module Cul::Scv::Hydra::Controllers::Helpers
+module ResourcesHelperBehavior
+  IMAGE_MIME_TYPES = [
+    'image/bmp',
+    'image/gif',
+    'image/jpeg',
+    'image/png',
+    'image/tiff'
+  ]
+  
+  # Creates a Resource, adding the posted blob to the Resource's datastreams and saves the Resource
+  #
+  # @return [Resource] the Resource  
+  def create_and_save_resources_from_params
+    if params.has_key?(:Fileurl)
+      # parse url for file name, default to index.html
+      file_url = params[:Fileurl]
+      file_url = URI.parse(file_url) unless file_url.nil?
+      file_name = 'index.html'
+      if file_url.scheme
+        file_name = file_url.path[1...file_url.path.length]
+      end
+      # download resource; override file name with header value if present
+      blob = Tempfile.new('temp')
+      blob.binmode
+      # download header? buffered writing?
+      response = Net::HTTP.get_response(file_url)
+      blob.write response.body
+      if response['Content-Disposition']
+        header = response['Content-Disposition']
+        if header =~ /filename=\"?(\w+)\"?/
+          file_name = $1
+        end
+      end
+      # add filename and resource to params
+      params[:Filedata] = [ActionDispatch::Http::UploadedFile.new(:tempfile=>blob,:filename=>file_name,:type=>mime_type(file_name))]
+    end
+    if params.has_key?(:Filedata)
+      @resources = []
+      params[:Filedata].each do |file|
+        file.content_type = mime_type(file.original_filename) unless file.content_type
+        @resource = create_resource_from_file(file)
+        @resource.save
+        @resources << @resource
+        @resource.refresh
+        add_posted_blob_to_resource(file, @resource)
+        @resource.save
+      end
+    else
+      render :text => "400 Bad Request", :status => 400
+    end
+    @resources
+  end
+  
+  def update_resource_from_params
+    if params.has_key?(:Fileurl)
+      # parse url for file name, default to index.html
+      file_url = params[:Fileurl]
+      file_url = URI.parse(file_url) unless file_url.nil?
+      file_name = 'index.html'
+      if file_url.scheme
+        file_name = file_url.path[1...file_url.path.length]
+      end
+      # download resource; override file name with header value if present
+      blob = Tempfile.new('temp')
+      blob.binmode
+      # download header? buffered writing?
+      response = Net::HTTP.get_response(file_url)
+      blob.write response.body
+      if response['Content-Disposition']
+        header = response['Content-Disposition']
+        if header =~ /filename=\"?(\w+)\"?/
+          file_name = $1
+        end
+      end
+      # add filename and resource to params
+      params[:Filedata] = ActionDispatch::Http::UploadedFile.new(:tempfile=>blob,:filename=>file_name,:type=>mime_type(file_name))
+    end
+    if params.has_key?(:Filedata)
+      file = params[:Filedata]
+      file.content_type = mime_type(file.original_filename) unless file.content_type
+      update_resource_from_file(@document_fedora,file)
+      add_posted_blob_to_resource(file, @document_fedora)
+      @document_fedora.save
+    else
+      render :text => "400 Bad Request", :status => 400
+    end
+    @document_fedora
+  end
+  def update_resource_from_file(resource,file)
+    file_name = filename_for(file)
+    resource.label = file_name
+    resource.datastreams["DC"].update_values([:source=>0]=>[file_name])
+    resource
+  end
+  def create_resource_from_file(file)
+    resource = Resource.new
+    resource.datastreams["rightsMetadata"].ng_xml = Hydra::RightsMetadata.xml_template
+    update_resource_from_file(resource,file)
+  end
+  
+  # Puts the contents of params[:Filedata] (posted blob) into a datastream within the given @resource
+  # Sets resource label and title to filename if they're empty
+  #
+  # @param [Resource] the Resource to add the blob to
+  # @return [Resource] the Resource  
+  def add_posted_blob_to_resource(file, resource=@resource)
+    resource.add_content_blob(file.tempfile, :file_name=>file.original_filename, :mime_type=>file.content_type)
+  end
+  
+  # Associate the new file resource with its container
+  def associate_resource_with_container(resource=@resource, container_id=nil)
+    if container_id.nil?
+      container_id = params[:container_id]
+    end
+    container_id = "info:fedora/#{container_id}" unless container_id =~ /info:fedora\/.+/
+    resource.containers_append(container_id)
+    resource.datastreams["RELS-EXT"].dirty = true
+  end
+  
+  def remove_resource_from_container(resource=nil, container_id=nil)
+    if container_id.nil?
+      container_id = params[:container_id]
+    end
+    if resource.nil?
+      resource = @resource
+    end
+    resource.containers_remove(container_id)
+    #resource.remove_relationship(:cul_member_of, container_id)
+    resource.datastreams["RELS-EXT"].dirty = true
+  end
+  
+  # Apply any posted file metadata to the file asset
+  def apply_posted_file_metadata(resource=@resource)         
+    @metadata_update_response = update_document(resource, @sanitized_params)
+  end
+  
+  
+  # A best-guess filename
+  # If Filename was submitted, it uses that.  Otherwise, it calls +original_filename+ on the posted file
+  def filename_for(file)
+    file.instance_variable_get(:@original_filename) || file.original_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
+end

data/lib/cul_scv_hydra/controllers/resources.rb

@@ -0,0 +1,162 @@
+module Cul::Scv::Hydra::Controllers
+module Resources
+  extend ActiveSupport::Concern
+
+  included do
+    include Hydra::AssetsControllerHelper
+    include Cul::Scv::Hydra::Controllers::Helpers::ResourcesHelperBehavior
+    include Hydra::Controller  
+    include Hydra::RepositoryController  
+    include MediaShelf::ActiveFedoraHelper
+    include Blacklight::SolrHelper
+    before_filter :require_solr, :only=>[:index, :create, :show, :destroy]
+    before_filter :load_fedora_document, :only=>[:update]
+    prepend_before_filter :sanitize_update_params
+  end
+
+  def index
+    if params[:layout] == "false"
+      # action = "index_embedded"
+      layout = false
+    end
+    if !params[:container_id].nil?
+      container_uri = "info:fedora/#{params[:container_id]}"
+      escaped_uri = container_uri.gsub(/(:)/, '\\:')
+      extra_controller_params =  {:q=>"cul_member_of_s:#{escaped_uri}"}
+      @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[:container_id])
+      
+      # Including these lines for backwards compatibility (until we can use Rails3 callbacks)
+      @container =  ActiveFedora::Base.load_instance(params[:container_id])
+      @solr_result = @container.file_objects(:response_format=>:solr)
+    else
+      # @solr_result = ActiveFedora::SolrService.instance.conn.query('has_model_field:info\:fedora/ldpd\:Resource', @search_params)
+      @solr_result = Resource.find_by_solr(:all)
+    end
+    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?(:Filedata) or params.has_key?(:Fileurl)
+      flash[:notice] = process_files # "The file #{params[:Filename]} has been saved in <a href=\"#{asset_url(@resource.pid)}\">#{@resource.pid}</a>."
+    else
+      flash[:notice] = "You must specify a file to upload."
+    end
+    
+    if !params[:container_id].nil?
+      redirect_params = {:controller=>"catalog", :id=>params[:container_id], :action=>:edit}
+    end
+    
+    redirect_params ||= {:action=>:index}
+    
+    redirect_to redirect_params
+  end
+  
+  def update
+    if params.has_key?(:Filedata) or params.has_key?(:Fileurl)
+      flash[:notice] = update_file # "The file #{params[:Filename]} has been saved in <a href=\"#{asset_url(@resource.pid)}\">#{@resource.pid}</a>."
+    else
+      flash[:notice] = "You must specify a file to upload."
+    end
+    if !params[:id].nil?
+      redirect_params = {:controller=>"catalog", :id=>params[:id], :action=>:edit}
+    end
+    
+    redirect_params ||= {:action=>:index}
+    
+    redirect_to redirect_params
+  end
+    
+  def process_files
+    @resources = create_and_save_resources_from_params
+    notice = []
+    @resources.each do |resource|
+      apply_depositor_metadata(resource)
+      notice << "The file #{resource.label} has been saved in <a href=\"#{asset_url(resource.pid)}\">#{resource.pid}</a>."
+      if !params[:container_id].nil?
+        associate_resource_with_container(resource,params[:container_id])
+      end
+      ## Apply any posted file metadata
+      unless params[:asset].nil?
+        logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
+        apply_posted_file_metadata(resource)
+      end
+      resource.save
+      logger.debug("Created #{resource.pid}.")
+    end
+  end
+  
+  def update_file
+    update_resource_from_params
+    apply_depositor_metadata(@document_fedora)
+    notice << "The file #{@document_fedora.label} has been saved in <a href=\"#{asset_url(@document_fedora.pid)}\">#{@document_fedora.pid}</a>."
+    unless params[:asset].nil?
+      logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
+      apply_posted_file_metadata(@document_fedora)
+    end
+    @document_fedora.save
+    logger.debug("Created #{@document_fedora.pid}.")
+  end
+  # Common destroy method for all AssetsControllers 
+  def destroy
+    # The correct implementation, with garbage collection:
+    # if params.has_key?(:container_id)
+    #   container = ActiveFedora::Base.load_instance(params[:container_id]) 
+    #   container.file_objects_remove(params[:id])
+    #   FileAsset.garbage_collect(params[:id])
+    # else
+    
+    # The dirty implementation (leaves relationship in container object, deletes regardless of whether the file object has other containers)
+    ActiveFedora::Base.load_instance(params[:id]).delete 
+    flash[:notice] = "Deleted #{params[:id]}."
+    if !params[:container_id].nil?
+      redirect_params = {:controller=>"catalog", :id=>params[:container_id], :action=>:edit}
+    end
+    
+    redirect_params ||= {:action=>:index}
+    
+    redirect_to redirect_params
+  end
+  
+  
+  def show
+    @file_asset = Resource.find(params[:id])
+    if (@file_asset.nil?)
+      logger.warn("No such resource: " + params[:id])
+      flash[:notice]= "No such resource."
+      redirect_to(:action => 'index', :q => nil , :f => nil)
+    else
+      # get array of parent (container) objects for this FileAsset
+      @id_array = @file_asset.containers(:response_format => :id_array)
+      @downloadable = false
+      # A FileAsset is downloadable iff the user has read or higher access to a parent
+      @id_array.each do |pid|
+        @response, @document = get_solr_response_for_doc_id(pid)
+        if reader?
+          @downloadable = true
+          break
+        end
+      end
+
+      if @downloadable
+        if @file_asset.datastreams_in_memory.include?("CONTENT")
+          send_datastream @file_asset.datastreams_in_memory["CONTENT"]
+        end
+      else
+        flash[:notice]= "You do not have sufficient access privileges to download this document, which has been marked private."
+        redirect_to(:action => 'index', :q => nil , :f => nil)
+      end
+    end
+  end
+end
+end

data/lib/cul_scv_hydra/controllers/static_image_aggregators.rb

@@ -0,0 +1,106 @@
+require 'cul_scv_hydra/controllers/helpers/resources_helper_behavior'
+module Cul::Scv::Hydra::Controllers
+module StaticImageAggregators
+  extend ActiveSupport::Concern
+  
+  included do
+    include Hydra::AssetsControllerHelper
+    include Cul::Scv::Hydra::Controllers::Helpers::ResourcesHelperBehavior  
+    include Hydra::RepositoryController  
+    include MediaShelf::ActiveFedoraHelper
+    include Blacklight::SolrHelper
+    before_filter :require_fedora
+    before_filter :require_solr, :only=>[:index, :new, :create, :edit, :show, :destroy]
+    prepend_before_filter :sanitize_update_params
+  end
+  
+  def index
+    if params[:layout] == "false"
+      # action = "index_embedded"
+      layout = false
+    end
+    if !params[:container_id].nil?
+      container_uri = "info:fedora/#{params[:container_id]}"
+      escaped_uri = container_uri.gsub(/(:)/, '\\:')
+      extra_controller_params =  {:q=>"cul_member_of_s:#{escaped_uri}"}
+      @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[:container_id])
+      
+      # Including these lines for backwards compatibility (until we can use Rails3 callbacks)
+      @container =  ActiveFedora::Base.load_instance(params[:container_id])
+      @solr_result = @container.file_objects(:response_format=>:solr)
+    else
+      # @solr_result = ActiveFedora::SolrService.instance.conn.query('has_model_field:info\:fedora/ldpd\:Resource', @search_params)
+      @solr_result = Resource.find_by_solr(:all)
+    end
+    render :action=>params[:action], :layout=>layout
+  end
+  
+  def new
+    @asset = StaticImageAggregator.new
+    apply_depositor_metadata(@asset)
+    set_collection_type(@asset, params[:content_type])
+    if !params[:container_id].nil?
+      associate_resource_with_container(@asset, params[:container_id])
+    end
+    @asset.save
+    @asset.refresh
+    msg = "Created a Static Image Aggregator with pid #{@asset.pid}. Now it's ready to be edited."
+    flash[:notice]= msg
+  
+    if params.has_key?(:Filedata)
+      @file_asset = create_and_save_resource_from_params
+      apply_depositor_metadata(@file_asset)
+    
+      flash[:notice] += " The file #{params[:Filename]} has been saved in <a href=\"#{asset_url(@file_asset.pid)}\">#{@file_asset.pid}</a>."
+            
+      if !params[:container_id].nil?
+        associate_resource_with_container(@file_asset, @asset.pid)
+      end
+    
+      ## Apply any posted file metadata
+      unless params[:asset].nil?
+        logger.debug("applying submitted file metadata: #{@sanitized_params.inspect}")
+        @metadata_update_response = update_document(@file_asset, @sanitized_params)
+      end
+      @file_asset.save
+      # If redirect_params has not been set, use {:action=>:index}
+      logger.debug "Created #{@file_asset.pid}."
+    end
+    @asset.save
+    
+    session[:scripts] = params[:combined] == "true"
+    redirect_to url_for(:action=>"edit", :id=>@asset.pid, :new_asset=>true, :controller=>'catalog')
+
+  end
+
+  # Common destroy method for all AssetsControllers 
+  def destroy
+    # The correct implementation, with garbage collection:
+    # if params.has_key?(:container_id)
+    #   container = ActiveFedora::Base.load_instance(params[:container_id]) 
+    #   container.file_objects_remove(params[:id])
+    #   FileAsset.garbage_collect(params[:id])
+    # else
+    
+    # The dirty implementation (leaves relationship in container object, deletes regardless of whether the file object has other containers)
+    ActiveFedora::Base.load_instance(params[:id]).delete 
+    render :text => "Deleted #{params[:id]} from #{params[:container_id]}."
+  end
+  
+  
+  def show
+    @image_agg = StaticImageAggregator.find(params[:id])
+    if (@image_agg.nil?)
+      logger.warn("No such object: " + params[:id])
+      flash[:notice]= "No such object."
+      redirect_to(:action => 'index', :q => nil , :f => nil)
+    else
+      @id_array = @image_agg.containers(:response_format => :id_array)
+    end
+    render :action=>params[:action], :layout=>(params[:layout]=="false")
+  end
+end
+end

data/lib/cul_scv_hydra/controllers/suggestions.rb

@@ -0,0 +1,127 @@
+require 'cul_scv_hydra'
+require 'json'
+module Cul::Scv::Hydra::Controllers
+module Suggestions
+  extend ActiveSupport::Concern
+  included do
+    include Blacklight::SolrHelper
+    include MediaShelf::ActiveFedoraHelper
+    before_filter :require_solr, :only=>[:index]
+  end
+
+  def index
+    stub = params[:term] || ""
+    if params[:term_id].nil?
+      raise "Cannot provide suggestions without a term name"
+    end
+    field_name = params[:term_id]
+    field_key = field_key_from(field_name, Cul::Scv::Hydra::Om::ModsDocument.terminology)
+    solr_name = get_solr_name(field_key, Cul::Scv::Hydra::Om::ModsDocument)
+    solr_params = {}
+    solr_params['wt'] = 'json'
+    solr_params['terms'] = 'true'
+    solr_params['terms.fl'] = solr_name
+    solr_params['terms.lower'] = stub
+    solr_params['terms.lower.incl'] = false
+    solr_params['terms.prefix'] = stub
+    solr_params['terms.sort'] = 'index'
+    solr_response = Blacklight.solr.get 'terms', {:params => solr_params}
+    result = []
+    hash = {}
+    (1...solr_response['terms'].length).step(2) { |ix|
+      solr_response['terms'][ix].each { |val|
+        result << val if val.is_a? String
+      }
+    }
+    send_data result.to_json, :disposition => 'inline', :type => 'text/plain'
+    return
+  end
+
+## field_key_from(field_name) to reverse this method from HydraFedoraMetadataHelper
+#  def field_name_for(field_key)
+#   if field_key.kind_of?(Array)
+#     return OM::XML::Terminology.term_hierarchical_name(*field_key)
+#   else
+#     field_key.to_s
+#   end
+#  end
+
+  def field_key_from(field_name, terminology)
+    # this is a hack, but necessary until/unless OM generates names differently
+   candidates = field_name.split('__')
+   field_key = []
+   candidates.each_with_index { |candidate, ix|
+     if (candidates[ix + 1] and candidates[ix + 1].match(/\d+/))
+       field_key << {OM.destringify(candidate) => Integer(candidates.delete_at(ix + 1))}
+     else
+       field_key << OM.destringify(candidate)
+     end
+   }
+   logger.debug field_key.inspect
+   field_key
+  end
+
+  # ** largely copied from ActiveFedora::NokogiriDatastream.get_values **
+  def get_solr_name(term_pointer, dsClass)
+    term = dsClass.terminology.retrieve_term(*OM.pointers_to_flat_array(term_pointer, false))
+    names = []
+    if is_hierarchical_term_pointer?(*term_pointer)
+      bases = []
+      #add first item in term_pointer as start of bases
+      # then iterate through possible nodes that might exist
+      term_pointer.first.kind_of?(Hash) ? bases << term_pointer.first.keys.first : bases << term_pointer.first
+      for i in 1..(term_pointer.length-1)
+        #iterate in reverse so that we can modify the bases array while iterating
+        (bases.length-1).downto(0) do |j|
+          current_last = (term_pointer[i].kind_of?(Hash) ? term_pointer[i].keys.first : term_pointer[i])
+          if (term_pointer[i-1].kind_of?(Hash))
+            #just use index supplied instead of trying possibilities
+            index = term_pointer[i-1].values.first
+            solr_name_base = OM::XML::Terminology.term_hierarchical_name({bases[j]=>index},current_last)
+            solr_name = generate_solr_symbol(solr_name_base, term.data_type)
+            bases.delete_at(j)
+            #insert the new solr name base if found
+            bases.insert(j,solr_name_base) if has_solr_name?(solr_name,solr_doc)
+          else
+            #detect how many nodes exist
+            index = 0
+            current_base = bases[j]
+            bases.delete_at(j)
+            solr_name_base = OM::XML::Terminology.term_hierarchical_name({current_base=>index},current_last)
+            solr_name = generate_solr_symbol(solr_name_base, term.data_type)
+            bases.insert(j,solr_name_base)
+          end
+        end
+      end
+      bases.each do |base|
+        names << generate_solr_symbol(base.to_sym, term.data_type)
+      end
+    else
+#this is not hierarchical and we can simply look for the solr name created using the terms without any indexes
+      generic_field_name_base = OM::XML::Terminology.term_generic_name(*term_pointer)
+      names << generate_solr_symbol(generic_field_name_base, term.data_type)
+    end
+    names
+  end
+
+  # ** copied from ActiveFedora::NokogiriDatastream **
+  #@return true if the term_pointer contains an index
+  # ====Example:
+  #     [:image, {:title_set=>1}, :title] return true
+  #     [:image, :title_set, :title]      return false
+  def is_hierarchical_term_pointer?(*term_pointer)
+    if term_pointer.length>1
+      term_pointer.each do |pointer|
+        if pointer.kind_of?(Hash)
+          return true
+        end
+      end
+    end
+    return false
+  end
+  # ** copied from ActiveFedora::NokogiriDatastream **
+  def generate_solr_symbol(base, data_type)
+    Solrizer::XML::TerminologyBasedSolrizer.default_field_mapper.solr_name(base.to_sym, data_type)
+  end
+end
+end