commonwealth-vlr-engine 0.0.4 → 0.0.7

data/config/initializers/patch_blacklight_range_limit.rb

@@ -0,0 +1,18 @@
+# need to override RangeLimitHelper#add_range_missing, this seems to be only way that works
+
+RangeLimitHelper.module_eval do
+
+  def add_range_missing(solr_field, my_params = params)
+    my_params = Marshal.load(Marshal.dump(my_params))
+    my_params["range"] ||= {}
+    my_params["range"][solr_field] ||= {}
+    my_params["range"][solr_field]["missing"] = "true"
+
+    # Need to ensure there's a search_field to trick Blacklight
+    # into displaying results, not placeholder page. Kind of hacky,
+    # but works for now.
+    my_params["search_field"] ||= "dummy_range"
+    search_catalog_path(my_params.except('controller', 'action'))
+  end
+
+end

data/config/jetty.yml

@@ -3,5 +3,5 @@ development:
   jetty_port: 8983 
 test:
   startup_wait: 60
-  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8888 %> 
+  jetty_port: <%= ENV['TEST_JETTY_PORT'] || 8983 %>
   <%= ENV['TEST_JETTY_PATH'] ? "jetty_home: " + ENV['TEST_JETTY_PATH'] : '' %>

data/config/locales/commonwealth-vlr-engine.en.yml

@@ -6,6 +6,8 @@ en:
           page_title: 'Search'
           title: 'Search - %{application_name}'
           limit: 'Narrow your search:'
+          constraints:
+            date: 'Date Range'
 
     application_name: 'SITE_NAME'
     application_desc: 'SITE DESCRIPTION'
@@ -79,8 +81,15 @@ en:
     did_you_mean: 'Search for %{options} instead?'
 
     downloads:
+          cc: 'Learn more about this Creative Commons license'
           link_info: '(links open in new window)'
           title: 'Downloads'
+          images:
+            access800: 'Medium (800px)'
+            accessFull: 'Original (full resolution)'
+            georectifiedMaster: 'GeoTIFF (georeferenced)'
+            JPEG2000: 'Original (full resolution)'
+            productionMaster: 'Master (full resolution, uncompressed)'
 
     email:
           form:
@@ -343,6 +352,9 @@ en:
           explore:
             title: 'Explore'
 
+    range_limit:
+          submit_limit: 'Apply'
+
     saved_searches:
           clear:
                   action_title: 'clear all'

data/config/routes.rb

@@ -13,10 +13,12 @@ Rails.application.routes.draw do
   get 'search/:id/metadata_view', :to => 'catalog#metadata_view', :as => 'metadata_view_catalog'
 
   # collections
+  get 'collections/range_limit', to: 'collections#range_limit'
   resources :collections, :only => [:index, :show]
   get 'collections/facet/:id', :to => 'collections#facet', :as => 'collections_facet'
 
   # institutions
+  get 'institutions/range_limit', to: 'institutions#range_limit'
   resources :institutions, :only => [:index, :show]
   get 'institutions/facet/:id', :to => 'institutions#facet', :as => 'institutions_facet'
 
@@ -55,6 +57,10 @@ Rails.application.routes.draw do
   # OCR search results
   get 'search/:id/fulltext', :to => 'ocr_search#index', :as => 'ocr_search'
 
+  # downloads
+  resources :downloads, :only => [:show]
+  get 'start_download/:id', :to => 'downloads#trigger_download', :as => 'trigger_downloads'
+
   # DEPRECATED ROUTES AND EXAMPLES
 
   # this is generated into local app via CommonwealthVlrEngine::RoutesGenerator

data/lib/commonwealth-vlr-engine.rb

@@ -16,6 +16,7 @@ module CommonwealthVlrEngine
   require 'commonwealth-vlr-engine/finder'
   require 'commonwealth-vlr-engine/notifier'
   require 'commonwealth-vlr-engine/iiif_manifest'
+  require 'commonwealth-vlr-engine/streaming'
 
   def self.config
     @config ||= YAML::load(File.open(config_path))[env]

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

@@ -47,8 +47,13 @@ module CommonwealthVlrEngine
       page_sequence
     end
 
+    def not_found
+      raise ActionController::RoutingError.new('Not Found')
+    end
+
     # override of Blacklight::Controller#search_action_path
-    # for proper constraints linking in collections#index and institutions#index
+    # for proper constraints and facet links in collections and institution views
+    # gets a bit tricky for collections#facet, since this has multiple contexts (collections#index and collections#show)
     def search_action_path *args
       if args.first.is_a? Hash
         args.first[:only_path] = true
@@ -58,8 +63,18 @@ module CommonwealthVlrEngine
 
       if params[:controller] == 'institutions' && params[:action] == 'index'
         institutions_url *args
-      elsif params[:controller] == 'collections' && (params[:action] == 'index' || params[:action] == 'facet')
-        collections_url *args
+      elsif params[:controller] == 'collections'
+        if params[:action] == 'index'
+          collections_url *args
+        elsif params[:action] == 'facet'
+          if request.query_parameters['f'] && request.query_parameters['f'][blacklight_config.collection_field]
+            search_action_url *args
+          else
+            collections_url *args
+          end
+        else
+          search_action_url *args
+        end
       else
         search_action_url *args
       end

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

@@ -14,7 +14,12 @@ module CommonwealthVlrEngine
       # add BlacklightMaps
       self.send(:include, BlacklightMaps::ControllerOverride)
 
+      # add BlacklightRangeLimit
+      self.send(:include, BlacklightRangeLimit::ControllerOverride)
+
+      # HEADS UP: these filters get inherited by any subclass of CatalogController
       before_filter :get_object_files, :only => [:show]
+      before_filter :mlt_results_for_show, :only => [:show]
       before_filter :set_nav_context, :only => [:index]
       before_filter :mlt_search, :only => [:index]
       before_filter :add_institution_fields, :only => [:index, :facet]
@@ -38,8 +43,8 @@ module CommonwealthVlrEngine
         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.maxzoom = 14
+        config.view.maps.show_initial_zoom = 12
         config.view.maps.facet_mode = 'geojson'
 
         # helper that returns thumbnail URLs
@@ -47,8 +52,6 @@ module CommonwealthVlrEngine
 
         # configuration for search results/index views
         config.index.partials = [:thumbnail, :index_header, :index]
-        #config.index.document_actions
-        config.index.document_actions.delete(:bookmark) # don't show bookmark control
 
         # solr field configuration for document/show views
         config.show.title_field = 'title_info_primary_tsi'
@@ -61,7 +64,7 @@ module CommonwealthVlrEngine
         config.advanced_search = {
             qt: 'search',
             url_key: 'advanced',
-            query_parser: 'dismax',
+            query_parser: 'edismax',
             form_solr_parameters: {
                 'facet.field' => ['genre_basic_ssim', 'collection_name_ssim'],
                 'facet.limit' => -1, # return all facet values
@@ -87,7 +90,7 @@ module CommonwealthVlrEngine
         # 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 'date_facet_yearly_ssim', :label => 'Date', :range => true, :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)
@@ -98,6 +101,7 @@ module CommonwealthVlrEngine
         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
+        config.add_facet_field 'title_info_uniform_ssim', label: 'Title (uniform)', 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
@@ -153,6 +157,24 @@ module CommonwealthVlrEngine
         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)'
 
+        # remove BL default show tools
+        config.show.document_actions.delete(:email)
+        config.show.document_actions.delete(:sms)
+        config.show.document_actions.delete(:bookmark)
+        config.show.document_actions.delete(:citation)
+
+        # index actions to remove
+        config.index.document_actions.delete(:bookmark)
+
+        # add our custom tools
+        config.add_show_tools_partial :add_this, partial: 'add_this'
+        config.add_show_tools_partial :folder_items, partial: 'folder_item_control'
+        config.add_show_tools_partial :custom_email, partial: 'show_sharing_tools'
+        config.add_show_tools_partial :cite, partial: 'show_cite_tools'
+
+        # add 'more like this' params in catalog#show
+        #config.default_document_solr_params = mlt_params_for_show
+
       end
 
       # displays the MODS XML record. copied from blacklight-marc 'librarian_view'
@@ -166,7 +188,7 @@ module CommonwealthVlrEngine
         end
       end
 
-      # modify facet settings for Collections#show and Institutions#show
+      # modify BL config 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
@@ -174,8 +196,13 @@ module CommonwealthVlrEngine
         # 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['date_facet_yearly_ssim'].collapse = true
         blacklight_config.facet_fields['genre_basic_ssim'].collapse = true
+        # remove item-centric show tools (for admin)
+        blacklight_config.show.document_actions.delete(:add_this)
+        blacklight_config.show.document_actions.delete(:folder_items)
+        blacklight_config.show.document_actions.delete(:custom_email)
+        blacklight_config.show.document_actions.delete(:cite)
       end
 
     end
@@ -194,20 +221,53 @@ module CommonwealthVlrEngine
       render :facet
     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
+
+    private
+
+    # LOCAL OVERRIDE of Blacklight::SearchHelper
+    # needed so that Solr query for prev/next/total in catalog#show view uses correct SearchBuilder class
+    # because params added exclusively in SearchBuilder methods don't get saved by current_search_session
+    def get_previous_and_next_documents_for_search(index, request_params, extra_controller_params={})
+      search_builder_to_use = request_params[:mlt_id] ? CommonwealthMltSearchBuilder.new(self) : search_builder
+      p = previous_and_next_document_params(index)
+      query = search_builder_to_use.with(request_params).start(p.delete(:start)).rows(p.delete(:rows)).merge(extra_controller_params).merge(p)
+      response = repository.search(query)
+      document_list = response.documents
+
+      # only get the previous doc if there is one
+      prev_doc = document_list.first if index > 0
+      next_doc = document_list.last if (index + 1) < response.total
+      [response, [prev_doc, next_doc]]
+    end
+
     # if this is 'more like this' search, solr id = params[:mlt_id]
     def mlt_search
-      if params[:mlt_id]
+      if controller_name == 'catalog' && params[:mlt_id]
         blacklight_config.search_builder_class = CommonwealthMltSearchBuilder
       end
     end
 
     # TODO: refactor how views access files/volumes/etc.
     def get_object_files
-      @object_files = get_files(params[:id])
+      if controller_name == 'catalog' || controller_name == 'image_viewer'
+        @object_files = get_files(params[:id])
+      end
     end
 
     def set_nav_context
-      @nav_li_active = 'search'
+      @nav_li_active = 'search' if controller_name == 'catalog'
     end
 
     # add institutions if configured
@@ -218,17 +278,15 @@ module CommonwealthVlrEngine
       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
+    # run a separate search for 'more like this' items
+    # so we can explicitly set params to exclude unwanted items
+    def mlt_results_for_show
+      if controller_name == 'catalog'
+        blacklight_config.search_builder_class = CommonwealthMltSearchBuilder
+        (@mlt_response, @mlt_document_list) = search_results(mlt_id: params[:id], rows: 4)
+        # have to reset to CommonwealthSearchBuilder, or prev/next links won't work
+        blacklight_config.search_builder_class = CommonwealthSearchBuilder
       end
-      volumes.presence
     end
 
     protected

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

@@ -2,6 +2,7 @@ require 'blacklight'
 require 'blacklight/gallery'
 require 'blacklight_advanced_search'
 require 'blacklight/maps'
+require 'blacklight_range_limit'
 require 'bpluser'
 require 'typhoeus'
 require 'devise'

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

@@ -24,9 +24,22 @@ module CommonwealthVlrEngine
       super
     end
 
-    # override to add method to show constraint for 'more like this' search
+    # override to add methods to show constraints for 'more like this' and advanced search date range
     def render_constraints(localized_params = params)
-      render_mlt_query(localized_params) + super
+      render_mlt_query(localized_params) + render_advanced_date_query(localized_params) + super
+    end
+
+    # Render the advanced search date query constraints
+    def render_advanced_date_query(localized_params = params)
+      # So simple don't need a view template, we can just do it here.
+      return ''.html_safe if localized_params[:date_start].blank? && localized_params[:date_end].blank?
+
+      render_constraint_element(t('blacklight.advanced_search.constraints.date'),
+                                date_range_constraints_to_s(localized_params),
+                                :classes => ['date_range'],
+                                :remove => remove_constraint_url(localized_params.merge(date_start: nil,
+                                                                                        date_end: nil,
+                                                                                        :action=>'index')))
     end
 
     # Render the 'more like this' query constraints
@@ -42,17 +55,5 @@ module CommonwealthVlrEngine
                                                                                         :action=>'index')))
     end
 
-    # include render_search_to_s_mlt() in rendered constraints
-    # Simpler textual version of constraints, used on Search History page.
-    def render_search_to_s(params)
-      render_search_to_s_mlt(params) + super
-    end
-
-    # render the MLT search query constraint, used on Search History page.
-    def render_search_to_s_mlt(params)
-      return "".html_safe if params[:mlt_id].blank?
-      render_search_to_s_element(t('blacklight.more_like_this.constraint_label'), render_filter_value(params[:mlt_id]) )
-    end
-
   end
 end

data/lib/commonwealth-vlr-engine/search_builder/collections_search_builder.rb

@@ -4,7 +4,7 @@ class CommonwealthCollectionsSearchBuilder < Blacklight::SearchBuilder
   include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
 
   self.default_processor_chain += [
-      :exclude_unpublished_items, :collections_filter
+      :site_filter, :exclude_unpublished_items, :collections_filter
   ]
 
   unless I18n.t('blacklight.home.browse.institutions.enabled')

data/lib/commonwealth-vlr-engine/search_builder/commonwealth_search_builder_behavior.rb

@@ -1,6 +1,12 @@
 module CommonwealthVlrEngine
   module CommonwealthSearchBuilderBehavior
 
+    # only return items corresponding to the correct site
+    def site_filter(solr_parameters = {})
+      solr_parameters[:fq] ||= []
+      solr_parameters[:fq] << '+destination_site_ssim:"' + CommonwealthVlrEngine.config[:site] + '"'
+    end
+
     # keep file assets from appearing in search results
     def exclude_unwanted_models(solr_parameters = {})
       solr_parameters[:fq] ||= []
@@ -44,8 +50,14 @@ module CommonwealthVlrEngine
     end
 
     # for 'more like this' search -- set solr id param to params[:mlt_id]
-    def set_solr_id_for_mlt(solr_parameters = {})
+    def mlt_params(solr_parameters = {})
       solr_parameters[:id] = blacklight_params[:mlt_id]
+      solr_parameters[:qt] = 'mlt'
+      solr_parameters[:mlt] = true
+      solr_parameters[:'mlt.fl'] = 'subject_facet_ssim,subject_geo_city_ssim,related_item_host_ssim'
+      solr_parameters[:'mlt.match.include'] = false
+      solr_parameters[:'mlt.mintf'] = 1
+      solr_parameters[:'mlt.qf'] = 'subject_facet_ssim^10 subject_geo_city_ssim^5 related_item_host_ssim'
     end
 
     # used by CollectionsController#index

data/lib/commonwealth-vlr-engine/search_builder/flagged_search_builder.rb

@@ -4,7 +4,7 @@ class CommonwealthFlaggedSearchBuilder < Blacklight::SearchBuilder
   include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
 
   self.default_processor_chain += [
-      :exclude_unpublished_items, :flagged_filter
+      :site_filter, :exclude_unpublished_items, :flagged_filter
   ]
 
   unless I18n.t('blacklight.home.browse.institutions.enabled')

data/lib/commonwealth-vlr-engine/search_builder/institutions_search_builder.rb

@@ -5,7 +5,7 @@ class CommonwealthInstitutionsSearchBuilder < Blacklight::SearchBuilder
   include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
 
   self.default_processor_chain += [
-      :exclude_unpublished_items, :institutions_filter
+      :site_filter, :exclude_unpublished_items, :institutions_filter
   ]
 
 end

data/lib/commonwealth-vlr-engine/search_builder/mlt_search_builder.rb

@@ -2,10 +2,11 @@ class CommonwealthMltSearchBuilder < Blacklight::SearchBuilder
 
   include Blacklight::Solr::SearchBuilderBehavior
   include BlacklightMaps::MapsSearchBuilderBehavior
+  include BlacklightRangeLimit::RangeLimitBuilder
   include CommonwealthVlrEngine::CommonwealthSearchBuilderBehavior
 
   self.default_processor_chain += [
-      :set_solr_id_for_mlt, :exclude_unpublished_items, :exclude_volumes
+      :site_filter, :mlt_params, :exclude_unpublished_items, :exclude_volumes
   ]
 
   unless I18n.t('blacklight.home.browse.institutions.enabled')

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

@@ -0,0 +1,50 @@
+# this is heavily based on ActiveFedora::File::Streaming
+module CommonwealthVlrEngine
+  module Streaming
+    extend ActiveSupport::Concern
+
+    # @param range [String] the Range HTTP header
+    # @return [Stream] an object that responds to each
+    def file_stream(uri, range = nil)
+      uri = URI.parse(uri)
+      FileBody.new(uri, stream_headers(range))
+    end
+
+    # @param range [String] from #stream
+    # @return [Hash]
+    def stream_headers(range, result = {})
+      result["Range"] = range if range
+      result
+    end
+
+    class FileBody
+      attr_reader :uri, :headers
+      def initialize(uri, headers)
+        @uri = uri
+        @headers = headers
+      end
+
+      def each(no_of_requests_limit = 3, &block)
+        raise ArgumentError, 'HTTP redirect too deep' if no_of_requests_limit.zero?
+        Net::HTTP.start(uri.host, uri.port, use_ssl: (uri.scheme == 'https')) do |http|
+          request = Net::HTTP::Get.new uri, headers
+          http.request request do |response|
+            case response
+              when Net::HTTPSuccess
+                response.read_body do |chunk|
+                  yield chunk
+                end
+              when Net::HTTPRedirection
+                no_of_requests_limit -= 1
+                @uri = URI(response["location"])
+                each(no_of_requests_limit, &block)
+              else
+                raise "Couldn't get data from Fedora (#{uri}). Response: #{response.code}"
+            end
+          end
+        end
+      end
+    end
+
+  end
+end