commonwealth-vlr-engine 0.0.1

data/config/routes.rb

@@ -0,0 +1,92 @@
+Rails.application.routes.draw do
+
+  mount Bpluser::Engine => '/bpluser'
+
+  # alias for map browse
+  get 'places', :to => 'catalog#map', :as => 'places_facet'
+
+  # formats browse
+  get 'formats', :to => 'catalog#formats_facet', :as => 'formats_facet'
+
+  # MODS metadata view
+  get 'search/:id/metadata_view', :to => 'catalog#metadata_view', :as => 'metadata_view_catalog'
+
+  # collections
+  resources :collections, :only => [:index, :show]
+  get 'collections/facet/:id', :to => 'collections#facet', :as => 'collections_facet'
+
+  # institutions
+  resources :institutions, :only => [:index, :show]
+  get 'institutions/facet/:id', :to => 'institutions#facet', :as => 'institutions_facet'
+
+  # contact form
+  # for some reason feedback submit won't work w/o this addition
+  match 'feedback', :to => 'feedback#show', :via => [:get, :post]
+  get 'feedback/complete', :to => 'feedback#complete'
+
+  # folders
+  get 'folders/public', :to => 'folders#public_list', :as => 'public_folders'
+  resources :folders
+  delete 'folder/:id/clear', :to => 'folder_items#clear', :as => 'clear_folder_items'
+  put 'folder/:id/item_actions', :to => 'folder_items_actions#folder_item_actions', :as => 'selected_folder_items_actions'
+
+  # folder items
+  resources :folder_items
+
+  # user account management (not login/auth)
+  resources :users, :only => [:show, :index]
+
+  # multi-image viewers
+  get 'image_viewer/:id', :to => 'image_viewer#show', :as => 'image_viewer'
+  get 'book_viewer/:id', :to => 'image_viewer#book_viewer', :as => 'book_viewer'
+
+  # static pages
+  get 'explore', :to => 'pages#explore', :as => 'explore'
+  get 'about', :to => 'pages#about', :as => 'about'
+  get 'about_this_site', :to => 'pages#about_site', :as => 'about_site'
+
+  # IIIF manifest
+  get 'search/:id/manifest', :to => 'iiif_manifest#manifest', :as => 'iiif_manifest'
+  get 'search/:id/canvas/:canvas_object_id', :to => 'iiif_manifest#canvas', :as => 'iiif_canvas'
+  get 'search/:id/annotation/:annotation_object_id', :to => 'iiif_manifest#annotation', :as => 'iiif_annotation'
+  get 'search/:id/iiif_collection', :to => 'iiif_manifest#collection', :as => 'iiif_collection'
+
+  # OCR search results
+  get 'search/:id/fulltext', :to => 'ocr_search#index', :as => 'ocr_search'
+
+  # DEPRECATED ROUTES AND EXAMPLES
+
+  # this is generated into local app via CommonwealthVlrEngine::RoutesGenerator
+  #devise_for :users, :controllers => {:omniauth_callbacks => "users/omniauth_callbacks", :registrations => "users/registrations", :sessions => "users/sessions"}
+
+  # this is added to Blacklight::Routes via CommonwealthVlrEngine::Routes
+  #put 'bookmarks/item_actions', :to => 'folder_items_actions#folder_item_actions', :as => 'selected_bookmarks_actions'
+
+  # custom 'search' path routes are added to Blacklight::Routes::RouteSets via CommonwealthVlrEngine::RouteSets
+  # copy the below into local app to add all BL routes manually (remove blacklight_for call)
+  #delete 'bookmarks/clear', :to => 'bookmarks#clear', :as => 'clear_bookmarks'
+  #resources :bookmarks
+  #get 'search_history', :to => 'search_history#index', :as => 'search_history'
+  #delete 'search_history/clear', :to => 'search_history#clear', :as => 'clear_search_history'
+  #delete 'saved_searches/clear', :to => 'saved_searches#clear', :as => 'clear_saved_searches'
+  #get 'saved_searches', :to => 'saved_searches#index', :as => 'saved_searches'
+  #put 'saved_searches/save/:id', :to => 'saved_searches#save', :as => 'save_search'
+  #delete 'saved_searches/forget/:id', :to => 'saved_searches#forget', :as => 'forget_search'
+  #post 'saved_searches/forget/:id', :to => 'saved_searches#forget'
+  #get 'search/opensearch', :to => 'catalog#opensearch', :as => 'opensearch_catalog'
+  #get 'search/citation', :to => 'catalog#citation', :as => 'citation_catalog'
+  #get 'search/email', :as => 'email_catalog'
+  #post 'search/email'
+  #match 'search/email', :to => 'catalog#email', :as => 'email_catalog', :via => [:get, :post]
+  #get 'search/facet/:id', :to => 'catalog#facet', :as => 'catalog_facet'
+  #get 'search', :to => 'catalog#index', :as => 'catalog_index'
+  #resources :solr_document, :path => 'search', :controller => 'catalog', :only => [:show, :update] do
+  #  member do
+  #    post 'track'
+  #  end
+  #end
+  # :show and :update are for backwards-compatibility with catalog_url named routes
+  #resources :catalog, :only => [:show, :update]
+  # end local BL routes override
+
+end

data/lib/commonwealth-vlr-engine.rb

@@ -0,0 +1,55 @@
+require 'commonwealth-vlr-engine/engine'
+require 'commonwealth-vlr-engine/version'
+
+module CommonwealthVlrEngine
+
+  require 'commonwealth-vlr-engine/controller_override'
+  require 'commonwealth-vlr-engine/commonwealth_search_builder'
+  require 'commonwealth-vlr-engine/controller'
+  require 'commonwealth-vlr-engine/render_constraints_override'
+  require 'commonwealth-vlr-engine/pages'
+  require 'commonwealth-vlr-engine/routes'
+  require 'commonwealth-vlr-engine/route_sets'
+  require 'commonwealth-vlr-engine/finder'
+  require 'commonwealth-vlr-engine/notifier'
+  require 'commonwealth-vlr-engine/iiif_manifest'
+
+  def self.config
+    @config ||= YAML::load(File.open(config_path))[env]
+    .with_indifferent_access
+  end
+
+  def self.app_root
+    return @app_root if @app_root
+    @app_root = Rails.root if defined?(Rails) and defined?(Rails.root)
+    @app_root ||= APP_ROOT if defined?(APP_ROOT)
+    @app_root ||= '.'
+  end
+
+  def self.env
+    return @env if @env
+    #The following commented line always returns "test" in a rails c production console. Unsure of how to fix this yet...
+    #@env = ENV["RAILS_ENV"] = "test" if ENV
+    @env ||= Rails.env if defined?(Rails) and defined?(Rails.root)
+    @env ||= 'development'
+  end
+
+  def self.config_path
+    File.join(app_root, 'config', 'vlr.yml')
+  end
+
+  def self.inject!
+
+    CatalogController.send(:include, CommonwealthVlrEngine::RenderConstraintsOverride)
+    CatalogController.send(:helper, CommonwealthVlrEngine::RenderConstraintsOverride) unless
+        CatalogController.helpers.is_a?(CommonwealthVlrEngine::RenderConstraintsOverride)
+
+    # inject into SearchHistory and SavedSearches so mlt queries display properly
+    SearchHistoryController.send(:helper, CommonwealthVlrEngine::RenderConstraintsOverride) unless
+        SearchHistoryController.helpers.is_a?(CommonwealthVlrEngine::RenderConstraintsOverride)
+    SavedSearchesController.send(:helper, CommonwealthVlrEngine::RenderConstraintsOverride) unless
+        SavedSearchesController.helpers.is_a?(CommonwealthVlrEngine::RenderConstraintsOverride)
+  end
+
+end
+

data/lib/commonwealth-vlr-engine/commonwealth_search_builder.rb

@@ -0,0 +1,66 @@
+module CommonwealthVlrEngine
+  module CommonwealthSearchBuilder
+
+    # keep file assets from appearing in search results
+    def exclude_unwanted_models(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '-has_model_ssim:"info:fedora/afmodel:Bplmodels_File"'
+    end
+
+    # keep draft/review and in-process items from appearing in search results
+    def exclude_unpublished_items(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '-workflow_state_ssi:"draft"'
+      solr_parameters[:fq] << '-workflow_state_ssi:"needs_review"'
+      solr_parameters[:fq] << '-processing_state_ssi:"derivatives"'
+      # can't implement below until all records have this field
+      # solr_parameters[:fq] << '+workflow_state_ssi:"published"'
+      # solr_parameters[:fq] << '+processing_state_ssi:"complete"'
+    end
+
+    # keep Institution objects out of the search results
+    def exclude_institutions(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '-active_fedora_model_suffix_ssi:"Institution"'
+    end
+
+    # don't return flagged items (for series images on collections#show)
+    def flagged_filter(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "-#{blacklight_config.flagged_field}:[* TO *]"
+    end
+
+    # used by InstitutionsController#index
+    def institutions_filter(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "+active_fedora_model_suffix_ssi:\"Institution\""
+    end
+
+    # for 'more like this' search -- set solr id param to params[:mlt_id]
+    def set_solr_id_for_mlt(solr_parameters = {})
+      solr_parameters[:id] = blacklight_params[:mlt_id]
+    end
+
+    # used by CollectionsController#index
+    def collections_filter(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << "+active_fedora_model_suffix_ssi:\"Collection\""
+    end
+
+    # keep Volume objects out of the search results
+    def exclude_volumes(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '-active_fedora_model_suffix_ssi:"Volume"'
+    end
+
+    # set params for ocr field searching
+    def ocr_search_params(solr_parameters = {})
+      solr_parameters[:facet] = false
+      solr_parameters[:hl] = true
+      solr_parameters[:'hl.fl'] = blacklight_config.ocr_search_field
+      solr_parameters[:'hl.fragsize'] = 135
+      solr_parameters[:'hl.snippets'] = 10
+    end
+
+  end
+end

data/lib/commonwealth-vlr-engine/controller.rb

@@ -0,0 +1,69 @@
+# -*- encoding : utf-8 -*-
+#
+# Filters added to this controller apply to all controllers in the hosting application
+# as this module is mixed-in to the application controller in the hosting app on installation.
+module CommonwealthVlrEngine
+  module Controller
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      after_filter :store_location
+
+      # extra head content
+      helper_method :create_img_sequence
+
+    end
+
+    # redirect after login to previous non-login page
+    # TODO figure out why it doesn't work for Polaris or Facebook logins
+    def store_location
+      # store last url - this is needed for post-login redirect to whatever the user last visited.
+      if (request.path != "/users/sign_in" &&
+          request.path != "/users/sign_up" &&
+          request.path != "/users/password" &&
+          request.path != "/users/password/new" &&
+          request.path != "/users/password/edit" &&
+          request.path != "/users/confirmation" &&
+          request.path != "/users/sign_out" &&
+          !request.fullpath.match(/\/users\/auth\//) &&
+              !request.xhr?) # don't store ajax calls
+        session[:previous_url] = request.fullpath
+      end
+    end
+
+    def after_sign_in_path_for(resource)
+      session[:previous_url] || root_path
+    end
+
+    def create_img_sequence(image_files, current_img_pid)
+      page_sequence = {}
+      page_sequence[:current] = current_img_pid
+      page_sequence[:index] = image_files.index(current_img_pid) + 1
+      page_sequence[:total] = image_files.length
+      page_sequence[:prev] = page_sequence[:index]-2 > -1 ? image_files[page_sequence[:index]-2] : nil
+      page_sequence[:next] = image_files[page_sequence[:index]].presence
+      page_sequence
+    end
+
+    # override of Blacklight::Controller#search_action_path
+    # for proper constraints linking in collections#index and institutions#index
+    def search_action_path *args
+      if args.first.is_a? Hash
+        args.first[:only_path] = true
+        # Rails 4.2 deprecated url helpers accepting string keys for 'controller' or 'action'
+        args[0] = args.first.except(:controller, :action)
+      end
+
+      if params[:controller] == 'institutions' && params[:action] == 'index'
+        institutions_url *args
+      elsif params[:controller] == 'collections' && (params[:action] == 'index' || params[:action] == 'facet')
+        collections_url *args
+      else
+        search_action_url *args
+      end
+    end
+
+  end
+end

data/lib/commonwealth-vlr-engine/controller_override.rb

@@ -0,0 +1,238 @@
+module CommonwealthVlrEngine
+  module ControllerOverride
+    extend ActiveSupport::Concern
+
+    included do
+
+      # adds behavior for retrieving files for an object
+      self.send(:include, CommonwealthVlrEngine::Finder)
+
+      if self.respond_to? :search_params_logic
+        search_params_logic.concat [:exclude_unwanted_models, :exclude_unpublished_items, :exclude_institutions, :exclude_volumes]
+      end
+
+      if self.blacklight_config.search_builder_class
+        self.blacklight_config.search_builder_class.send(:include,
+                                                         CommonwealthVlrEngine::CommonwealthSearchBuilder
+        ) unless
+            self.blacklight_config.search_builder_class.include?(
+                CommonwealthVlrEngine::CommonwealthSearchBuilder
+            )
+      end
+
+      before_filter :get_object_files, :only => [:show]
+      before_filter :set_nav_context, :only => [:index]
+      before_filter :mlt_search, :only => [:index]
+      before_filter :add_institution_fields, :only => [:index, :facet]
+
+      helper_method :has_volumes?
+
+      # all the commonwealth-vlr-engine CatalogController config stuff goes here
+      configure_blacklight do |config|
+
+        #set default per-page
+        config.default_per_page = 20
+
+        #blacklight-gallery stuff
+        config.view.gallery.default = true
+        config.view.gallery.partials = [:index_header]
+        config.view.gallery.icon_class = 'glyphicon-th-large'
+        config.view.masonry.partials = [:index_header]
+        config.view.slideshow.partials = [:index]
+
+        # blacklight-maps stuff
+        config.view.maps.geojson_field = 'subject_geojson_facet_ssim'
+        config.view.maps.coordinates_field = 'subject_coordinates_geospatial'
+        config.view.maps.placename_field = 'subject_geographic_ssim'
+        config.view.maps.maxzoom = 13
+        config.view.maps.show_initial_zoom = 9
+        config.view.maps.facet_mode = 'geojson'
+
+        # helper that returns thumbnail URLs
+        config.index.thumbnail_method = :create_thumb_img_element
+
+        # configuration for search results/index views
+        config.index.partials = [:thumbnail, :index_header, :index]
+        config.index.document_actions = nil # don't show bookmark control
+
+        # solr field configuration for document/show views
+        config.show.title_field = 'title_info_primary_tsi'
+        config.show.display_type_field = 'active_fedora_model_suffix_ssi'
+
+        # solr field for flagged/inappropriate content
+        config.flagged_field = 'flagged_content_ssi'
+
+        # advanced search facet limits
+        config.advanced_search = {
+            :qt => 'search',
+            :form_solr_parameters => {
+                'facet.field' => ['genre_basic_ssim', 'collection_name_ssim'],
+                'facet.limit' => -1, # return all facet values
+                'facet.sort' => 'index' # sort by byte order of values
+            }
+        }
+
+        # collection name field
+        config.collection_field = 'collection_name_ssim'
+        # institution name field
+        config.institution_field = 'institution_name_ssim'
+
+        # book stuff
+        config.ocr_search_field = 'ocr_tsiv'
+        config.page_num_field = 'page_num_label_ssi'
+
+        config.default_solr_params = {:qt => 'search', :rows => 20}
+
+        # solr field configuration for search results/index views
+        config.index.title_field = 'title_info_primary_tsi'
+        config.index.display_type_field = 'active_fedora_model_suffix_ssi'
+
+        # solr fields that will be treated as facets by the blacklight application
+        config.add_facet_field 'subject_facet_ssim', :label => 'Topic', :limit => 8, :sort => 'count', :collapse => false
+        config.add_facet_field 'subject_geographic_ssim', :label => 'Place', :limit => 8, :sort => 'count', :collapse => false
+        config.add_facet_field 'date_facet_ssim', :label => 'Date', :limit => 8, :sort => 'index', :collapse => false
+        config.add_facet_field 'genre_basic_ssim', :label => 'Format', :limit => 8, :sort => 'count', :helper_method => :render_format, :collapse => false
+        config.add_facet_field 'collection_name_ssim', :label => 'Collection', :limit => 8, :sort => 'count', :collapse => false
+        # link_to_facet fields (not in facets sidebar of search results)
+        config.add_facet_field 'related_item_host_ssim', :label => 'Collection', :include_in_request => false # Collection (local)
+        config.add_facet_field 'genre_specific_ssim', :label => 'Genre', :include_in_request => false
+        config.add_facet_field 'related_item_series_ssim', :label => 'Series', :limit => 300, :sort => 'index', :include_in_request => false
+        config.add_facet_field 'related_item_subseries_ssim', :label => 'Subseries', :include_in_request => false
+        config.add_facet_field 'related_item_subsubseries_ssim', :label => 'Sub-subseries', :include_in_request => false
+        config.add_facet_field 'institution_name_ssim', :label => 'Institution', :include_in_request => false
+        config.add_facet_field 'name_facet_ssim', :label => 'Name', :include_in_request => false
+        # facet for blacklight-maps catalog#index map view
+        # have to use '-2' to get all values
+        # because Blacklight::RequestBuilders#solr_facet_params adds '+1' to value
+        config.add_facet_field 'subject_geojson_facet_ssim', :limit => -2, :label => 'Coordinates', :show => false
+
+        # solr fields to be displayed in the index (search results) view
+        config.add_index_field 'genre_basic_ssim', :label => 'Format', :helper_method => :render_format_index
+        config.add_index_field 'collection_name_ssim', :label => 'Collection', :helper_method => :index_collection_link
+        config.add_index_field 'date_start_tsim', :label => 'Date', :helper_method => :index_date_value
+
+        # "fielded" search configuration. Used by pulldown among other places.
+        config.add_search_field('all_fields') do |field|
+          field.label = 'All Fields'
+          field.solr_parameters = { :'spellcheck.dictionary' => 'default' }
+        end
+
+        config.add_search_field('title') do |field|
+          field.solr_parameters = { :'spellcheck.dictionary' => 'default' }
+          field.solr_local_parameters = {
+              :qf => '$title_qf',
+              :pf => '$title_pf'
+          }
+        end
+
+        config.add_search_field('subject') do |field|
+          field.solr_parameters = { :'spellcheck.dictionary' => 'default' }
+          field.qt = 'search'
+          field.solr_local_parameters = {
+              :qf => '$subject_qf',
+              :pf => '$subject_pf'
+          }
+        end
+
+        config.add_search_field('place') do |field|
+          field.solr_parameters = { :'spellcheck.dictionary' => 'default' }
+          field.solr_local_parameters = {
+              :qf => '$place_qf',
+              :pf => '$place_pf'
+          }
+        end
+
+        config.add_search_field('creator') do |field|
+          field.solr_parameters = { :'spellcheck.dictionary' => 'default' }
+          field.solr_local_parameters = {
+              :qf => '$author_qf',
+              :pf => '$author_pf'
+          }
+        end
+
+        # "sort results by" select (pulldown)
+        config.add_sort_field 'score desc, title_info_primary_ssort asc', :label => 'relevance'
+        config.add_sort_field 'title_info_primary_ssort asc, date_start_dtsi asc', :label => 'title'
+        config.add_sort_field 'date_start_dtsi asc, title_info_primary_ssort asc', :label => 'date (asc)'
+        config.add_sort_field 'date_start_dtsi desc, title_info_primary_ssort asc', :label => 'date (desc)'
+
+      end
+
+      # displays the MODS XML record. copied from blacklight-marc 'librarian_view'
+      # for some reason won't work if not in the 'included' block
+      def metadata_view
+        @response, @document = fetch(params[:id])
+
+        respond_to do |format|
+          format.html
+          format.js { render :layout => false }
+        end
+      end
+
+      # modify facet settings for Collections#show and Institutions#show
+      def relation_base_blacklight_config
+        # don't show collection facet
+        blacklight_config.facet_fields['collection_name_ssim'].show = false
+        blacklight_config.facet_fields['collection_name_ssim'].if = false
+        # collapse remaining facets
+        blacklight_config.facet_fields['subject_facet_ssim'].collapse = true
+        blacklight_config.facet_fields['subject_geographic_ssim'].collapse = true
+        blacklight_config.facet_fields['date_facet_ssim'].collapse = true
+        blacklight_config.facet_fields['genre_basic_ssim'].collapse = true
+      end
+
+    end
+
+    # displays values and pagination links for Format field
+    def formats_facet
+      @nav_li_active = 'explore'
+
+      @facet = blacklight_config.facet_fields['genre_basic_ssim']
+      @response = get_facet_field_response(@facet.key, params)
+      @display_facet = @response.aggregations[@facet.key]
+
+      @pagination = facet_paginator(@facet, @display_facet)
+
+      render :facet
+    end
+
+    # if this is 'more like this' search, solr id = params[:mlt_id]
+    def mlt_search
+      if params[:mlt_id]
+        CatalogController.search_params_logic += [:set_solr_id_for_mlt] unless CatalogController.search_params_logic.include? :set_solr_id_for_mlt
+      end
+    end
+
+    # TODO: refactor how views access files/volumes/etc.
+    def get_object_files
+      @object_files = get_files(params[:id])
+    end
+
+    def set_nav_context
+      @nav_li_active = 'search'
+    end
+
+    # add institutions if configured
+    def add_institution_fields
+      if t('blacklight.home.browse.institutions.enabled')
+        blacklight_config.add_facet_field 'physical_location_ssim', :label => 'Institution', :limit => 8, :sort => 'count', :collapse => false
+        blacklight_config.add_index_field 'institution_name_ssim', :label => 'Institution', :helper_method => :index_institution_link
+      end
+    end
+
+    # TODO: refactor how views access files/volumes/etc.
+    # returns the child volumes for Book objects (if they exist)
+    # needs to be in this module because CommonwealthVlrEngine::Finder methods aren't accessible in helpers/views
+    def has_volumes?(document)
+      case document[blacklight_config.show.display_type_field.to_sym]
+        when 'Book'
+          volumes = get_volume_objects(document.id)
+        else
+          volumes = nil
+      end
+      volumes.presence
+    end
+
+  end
+
+end