commonwealth-vlr-engine 0.0.1

data/app/controllers/folder_items_controller.rb

@@ -0,0 +1,90 @@
+class FolderItemsController < CatalogController
+
+  # give controller access to useful BL/Solr methods
+  #include Blacklight::Configurable
+  #include Blacklight::SearchHelper
+
+  before_action :verify_user
+
+  def update
+    create
+  end
+
+  def create
+    @response, @document = fetch(params[:id])
+    if params[:folder_items]
+      @folder_items = params[:folder_items]
+    else
+      @folder_items = [{ :document_id => params[:id], :folder_id => params[:folder_id] }]
+    end
+
+    success = @folder_items.all? do |f_item|
+      folder_to_update = current_user.folders.find(f_item[:folder_id])
+      folder_to_update.folder_items.create!(:document_id => f_item[:document_id]) and folder_to_update.touch unless folder_to_update.has_folder_item(f_item[:document_id])
+    end
+
+    unless request.xhr?
+      flash[:notice] = t('blacklight.folder_items.add.success')
+    end
+
+    respond_to do |format|
+      format.html { redirect_to :back }
+      format.js
+    end
+
+  end
+
+
+  # Beware, :id is the Solr document_id, not the actual Bookmark id.
+  # idempotent, as DELETE is supposed to be.
+  # PRETTY SURE THIS METHOD IS NEVER USED!
+  def destroy
+    @response, @document = fetch(params[:id])
+    folder_item = current_user.existing_folder_item_for(params[:id])
+
+    # success = (!folder_item) || FolderItem.find(folder_item).destroy
+
+    Bpluser::Folder.find(folder_item.folder_id).touch
+    Bpluser::FolderItem.find(folder_item.id).destroy
+
+    respond_to do |format|
+      format.html { redirect_to :back }
+      format.js
+    end
+
+  end
+
+  def clear
+    @folder = Bpluser::Folder.find(params[:id])
+    if current_user.folders.find(@folder.id).folder_items.clear
+      @folder.touch
+      flash[:notice] = I18n.t('blacklight.folder_items.clear.success')
+    else
+      flash[:error] = I18n.t('blacklight.folder_items.clear.failure')
+    end
+    redirect_to :controller => "folders", :action => "show", :id => @folder
+  end
+
+  # PRETTY SURE THIS METHOD IS NEVER USED!
+  def delete_selected
+    @folder = Bpluser::Folder.find(params[:id])
+    if params[:selected]
+      if @folder.folder_items.where(:document_id => params[:selected]).delete_all
+        @folder.touch
+        flash[:notice] = t('blacklight.folders.update_items.remove.success')
+      else
+        flash[:error] = t('blacklight.folders.update_items.remove.failure')
+      end
+      redirect_to :controller => "folders", :action => "show", :id => @folder
+    else
+      redirect_to :back
+      flash[:error] = t('blacklight.folders.update_items.remove.no_items')
+    end
+  end
+
+  protected
+  def verify_user
+    flash[:notice] = I18n.t('blacklight.folders.need_login') and raise Blacklight::Exceptions::AccessDenied unless current_user
+  end
+
+end

data/app/controllers/folders_controller.rb

@@ -0,0 +1,132 @@
+class FoldersController < CatalogController
+
+  ##
+  # Give Bookmarks access to the CatalogController configuration
+  include Blacklight::Configurable
+  include Blacklight::SearchHelper
+
+  copy_blacklight_config_from(CatalogController)
+
+  # Blacklight uses #search_action_url to figure out the right URL for
+  # the global search box
+  def search_action_url options = {}
+    catalog_index_url(options.except(:controller, :action))
+  end
+  helper_method :search_action_url
+
+  before_filter :verify_user, :except => [:index, :show, :public_list]
+  before_filter :check_visibility, :only => [:show]
+  before_filter :correct_user_for_folder, :only => [:update, :destroy]
+
+  def index
+    if current_user
+      @folders = current_user.folders
+    end
+  end
+
+  def show
+    # @folder is set by correct_user_for_folder
+    @folder_items = @folder.folder_items
+    folder_items_ids = @folder_items.collect { |f_item| f_item.document_id.to_s }
+    params[:sort] ||= 'title_info_primary_ssort asc, date_start_dtsi asc'
+    @response, @document_list = fetch(folder_items_ids)
+
+    # have to declare this so view uses catalog/index partials
+    # uh, maybe not? default templates won't get invoked if below is set
+    #@partial_path_templates = ["catalog/%{action_name}_%{index_view_type}_%{format}"]
+  end
+
+  def new
+    @folder = current_user.folders.new
+  end
+
+  def create
+    @folder = current_user.folders.build(folder_params)
+    if @folder.save
+      flash[:notice] = "Folder created."
+      redirect_to :action => "index"
+    else
+      render :action => "new"
+    end
+  end
+
+  # create a folder in a modal window in the item show view
+  #def create_folder_catalog
+  #  if request.post?
+  #    unless params[:title].empty?
+  #      @folder = current_user.folders.build(:title => params[:title], :description => params[:description])
+  #      if @folder.save
+  #        flash[:success] = "Folder created; " + t('blacklight.folder_items.add.success')
+  #        current_user.folders.first.folder_items.create!(:document_id => params['id'].first)
+  #        redirect_to catalog_path(params['id']) unless request.xhr?
+  #      else
+  #        flash[:error] = t('blacklight.folders.create.error.no_save')
+  #      end
+  #    else
+  #      flash[:error] = t('blacklight.folders.create.error.no_title')
+  #    end
+  #  end
+
+  #  unless !request.xhr? && flash[:success]
+  #    respond_to do |format|
+  #      format.js { render :layout => false }
+  #      format.html { redirect_to :action => "new" }
+  #    end
+  #  end
+
+  #end
+
+  def edit
+    @folder = Bpluser::Folder.find(params[:id])
+  end
+
+  def update
+    # @folder is set by correct_user_for_folder
+    if @folder.update_attributes(folder_params)
+      flash[:notice] = "Folder updated."
+      redirect_to @folder
+    else
+      render :action => "edit"
+    end
+  end
+
+  def destroy
+    # @folder is set by correct_user_for_folder
+    @folder.destroy
+    flash[:notice] = t('blacklight.folders.delete.success')
+    redirect_to :action => "index"
+  end
+
+  # return a list of publicly visible folders that have items
+  def public_list
+    # TODO create a named scope for this query in Bplmodels::Folder?
+    @folders = Bpluser::Folder.where(:visibility => 'public').joins(:folder_items).uniq.order('updated_at DESC')
+  end
+
+  private
+
+    def folder_params
+      params.require(:folder).permit(:id, :title, :description, :visibility)
+    end
+
+    def verify_user
+      flash[:notice] = t('blacklight.folders.need_login') and raise Blacklight::Exceptions::AccessDenied unless current_user
+    end
+
+    def check_visibility
+      @folder = Bpluser::Folder.find(params[:id])
+      if @folder.visibility != 'public'
+        correct_user_for_folder
+      end
+    end
+
+    def correct_user_for_folder
+      @folder ||= Bpluser::Folder.find(params[:id])
+      if current_user
+        flash[:notice] = t('blacklight.folders.private') and redirect_to root_path unless current_user.folders.include?(@folder)
+      else
+        flash[:notice] = t('blacklight.folders.private') and redirect_to root_path
+      end
+    end
+
+end

data/app/controllers/iiif_manifest_controller.rb

@@ -0,0 +1,74 @@
+# use to render new image in multi image viewer in catalog#show
+class IiifManifestController < CatalogController
+
+  include CommonwealthVlrEngine::CatalogHelper
+  include CommonwealthVlrEngine::IiifManifest
+
+  def manifest
+    response, document = fetch(params[:id])
+    image_files = get_image_files(params[:id])
+    if image_files.length > 0
+      iiif_manifest = create_iiif_manifest(document, image_files)
+      render :json => iiif_manifest.to_json
+    elsif get_volume_objects(params[:id]).length > 0
+      redirect_to iiif_collection_path(params[:id])
+    else
+      not_found
+    end
+  end
+
+  def canvas
+    canvas_response, canvas_document = fetch(params[:canvas_object_id])
+    if canvas_document[:is_file_of_ssim]
+      response, document = fetch(params[:id])
+      image_files = has_image_files?(get_files(params[:id]))
+      if image_files
+        image_index = Hash[image_files.map.with_index.to_a][params[:canvas_object_id]]
+        iiif_canvas = canvas_from_id(params[:canvas_object_id],
+                                     label_for_canvas(canvas_document, image_index),
+                                     document)
+        render :json => iiif_canvas.to_json
+      else
+        not_found
+      end
+    else
+      not_found
+    end
+  end
+
+  def annotation
+    response, document = fetch(params[:id])
+    if has_image_files?(get_files(params[:id])).include?(params[:annotation_object_id])
+      annotation = image_annotation_from_image_id(params[:annotation_object_id], document)
+      render :json => annotation.to_json
+    else
+      not_found
+    end
+  end
+
+  def collection
+    response, document = fetch(params[:id])
+    volumes = get_volume_objects(params[:id])
+    if volumes.length > 0
+      iiif_collection = collection_for_manifests(document, volumes)
+      render :json => iiif_collection.to_json
+    else
+      not_found
+    end
+  end
+
+  after_action :set_access_control_headers, :only => [:manifest, :canvas, :annotation, :collection]
+
+  private
+
+  # to allow apps to load manifest JSON received from a remote server
+  def set_access_control_headers
+    headers['Access-Control-Allow-Origin'] = "*"
+  end
+
+  def not_found
+    raise ActionController::RoutingError.new('Not Found')
+  end
+
+
+end

data/app/controllers/image_viewer_controller.rb

@@ -0,0 +1,34 @@
+# use to render new image in multi image viewer in catalog#show
+class ImageViewerController < CatalogController
+
+  include CommonwealthVlrEngine::CatalogHelper
+
+  def show
+    @response, @document = fetch(params[:id])
+    #@img_to_show = params[:view]
+    @title = @document[blacklight_config.index.title_field.to_sym]
+    @page_sequence = get_page_sequence(@document.id, params[:view])
+    respond_to do |format|
+      format.js
+      format.html { redirect_to catalog_path(@document.id,
+                                             :view => params[:view]) }
+    end
+  end
+
+  def book_viewer
+    @response, @document = fetch(params[:id])
+    @image_files = has_image_files?(get_files(params[:id]))
+    render(:layout => 'book_viewer')
+  end
+
+  private
+
+  def get_page_sequence(document_id, current_img_id)
+    image_files = []
+    get_image_files(document_id).each do |img_file|
+      image_files << img_file['id']
+    end
+    create_img_sequence(image_files, current_img_id)
+  end
+
+end

data/app/controllers/institutions_controller.rb

@@ -0,0 +1,62 @@
+class InstitutionsController < CatalogController
+
+  ##
+  # Give Bookmarks access to the CatalogController configuration
+  include Blacklight::Configurable
+  include Blacklight::SearchHelper
+
+  copy_blacklight_config_from(CatalogController)
+
+  # Blacklight uses #search_action_url to figure out the right URL for
+  # the global search box
+  def search_action_url options = {}
+    catalog_index_url(options.except(:controller, :action))
+  end
+  helper_method :search_action_url
+
+  def index
+    @nav_li_active = 'explore'
+    self.search_params_logic += [:institutions_filter]
+    params[:per_page] = params[:per_page].presence || '50'
+    (@response, @document_list) = search_results(params, search_params_logic)
+    params[:view] ||= 'list' # still need this or grid view is invoked
+    params[:sort] = 'title_info_primary_ssort asc'
+
+    respond_to do |format|
+      format.html
+    end
+  end
+
+  def show
+    @nav_li_active = 'explore'
+    @show_response, @document = fetch(params[:id])
+    @institution_title = @document[blacklight_config.index.title_field.to_sym]
+
+    # get the response for collection objects
+    @collex_response, @collex_documents = search_results({:f => {'active_fedora_model_suffix_ssi' => 'Collection','institution_pid_ssi' => params[:id]},:rows => 100, :sort => 'title_info_primary_ssort asc'}, search_params_logic)
+
+    # add params[:f] for proper facet links
+    params[:f] = {blacklight_config.institution_field => [@institution_title]}
+
+    # get the response for the facets representing items in collection
+    (@response, @document_list) = search_results({:f => params[:f]}, search_params_logic)
+
+    respond_to do |format|
+      format.html
+    end
+
+  end
+
+  # remove grid view from blacklight_config for index view
+  def remove_unwanted_views
+    blacklight_config.view.delete(:gallery)
+    blacklight_config.view.delete(:masonry)
+    blacklight_config.view.delete(:slideshow)
+  end
+
+  before_filter :remove_unwanted_views, :only => [:index]
+
+  # remove collection facet and collapse others
+  before_filter :relation_base_blacklight_config, :only => [:show]
+
+end

data/app/controllers/ocr_search_controller.rb

@@ -0,0 +1,78 @@
+class OcrSearchController < CatalogController
+
+  ##
+  # access to the CatalogController configuration
+  include Blacklight::Configurable
+  include Blacklight::SearchHelper
+  include CommonwealthVlrEngine::CatalogHelper
+
+  copy_blacklight_config_from(CatalogController)
+
+  before_filter :modify_config_for_ocr, :only => [:index]
+  before_filter :modify_search_params_logic_for_ocr, :only => [:index]
+
+  def index
+    @doc_response, @document = fetch(params[:id])
+    if params[:ocr_q]
+      @image_pid_list = has_image_files?(get_files(params[:id]))
+      ocr_search_params = {q: params[:ocr_q],
+                           f: {'is_file_of_ssim' => "info:fedora/#{params[:id]}"}}
+      ocr_search_params[:page] = params[:page] if params[:page]
+      ocr_search_params[:sort] = params[:sort] if params[:sort]
+      # for some reason, have to set :fl here, or gets scrubbed out of ocr_search_params somehow
+      blacklight_config.default_solr_params[:fl] =
+          "id,#{blacklight_config.page_num_field},#{termfreq_query(params[:ocr_q])}"
+      (@response, @document_list) = search_results(ocr_search_params, search_params_logic)
+    else
+      (@response, @document_list) = {},[]
+    end
+
+    respond_to do |format|
+      # Draw the facet selector for users who have javascript disabled:
+      format.html
+      # Draw the partial for the ocr search results modal window:
+      format.js { render :layout => false }
+    end
+  end
+
+  private
+
+  # modify Solr query/response for OCR searches
+  def modify_config_for_ocr
+    blacklight_config.sort_fields = {}
+    blacklight_config.add_sort_field 'score desc, system_create_dtsi asc', label: 'relevance'
+    blacklight_config.add_sort_field 'system_create_dtsi asc', label: 'page #'
+    blacklight_config.add_facet_fields_to_solr_request = false
+    blacklight_config.add_index_field blacklight_config.ocr_search_field,
+                                      highlight: true,
+                                      helper_method: 'render_ocr_snippets'
+    blacklight_config.default_per_page = 5
+  end
+
+  # modify Solr search_params_logic for OCR searches
+  def modify_search_params_logic_for_ocr
+    self.search_params_logic -= [:exclude_unwanted_models, :institution_limit]
+    self.search_params_logic += [:ocr_search_params] unless self.search_params_logic.include?(:ocr_search_params)
+  end
+
+  # create the Solr function query to return term frequency
+  def termfreq_query(ocr_search_terms)
+    search_terms = if ocr_search_terms =~ (/\A"[\s\S]*"\z/) # phrase search
+                       [ocr_search_terms.gsub(/"/,'')]
+                     else
+                       ocr_search_terms.gsub(/"/,'').split(' ')
+                   end
+    if search_terms.length == 1
+      "term_freq:termfreq(#{blacklight_config.ocr_search_field},\"#{search_terms.first}\")"
+    else
+      termfreq_array = search_terms.map { |v| "termfreq(#{blacklight_config.ocr_search_field},\"#{v}\")" }
+      "term_freq:sum(#{termfreq_array.join(',')})"
+    end
+  end
+
+  # don't add OCR searches to Blacklight's search history/session
+  def start_new_search_session?
+    false
+  end
+
+end