commonwealth-vlr-engine 0.0.4 → 0.0.7

data/app/controllers/concerns/commonwealth_vlr_engine/institutions_controller_behavior.rb

@@ -0,0 +1,70 @@
+module CommonwealthVlrEngine
+  module InstitutionsControllerBehavior
+    extend ActiveSupport::Concern
+    ##
+    # Give Bookmarks access to the CatalogController configuration
+    include Blacklight::Configurable
+    include Blacklight::SearchHelper
+
+    included do
+      copy_blacklight_config_from(CatalogController)
+
+      before_filter :institutions_index_config, :only => [:index]
+      # remove collection facet and collapse others
+      before_filter :relation_base_blacklight_config, :only => [:show]
+
+      helper_method :search_action_url
+    end
+
+    def index
+      @nav_li_active = 'explore'
+      params[:per_page] = params[:per_page].presence || '50'
+      (@response, @document_list) = search_results(params)
+      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'})
+
+      # 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]})
+
+      respond_to do |format|
+        format.html
+      end
+
+    end
+
+    def range_limit
+      redirect_to range_limit_catalog_path(params.except('controller', 'action')) and return
+    end
+
+    protected
+
+    # Blacklight uses #search_action_url to figure out the right URL for the global search box
+    def search_action_url options = {}
+      search_catalog_url(options.except(:controller, :action))
+    end
+
+    # remove grid view from blacklight_config, use correct SearchBuilder for index view
+    def institutions_index_config
+      blacklight_config.search_builder_class = CommonwealthInstitutionsSearchBuilder
+      blacklight_config.view.delete(:gallery)
+      blacklight_config.view.delete(:masonry)
+      blacklight_config.view.delete(:slideshow)
+    end
+  end
+end

data/app/controllers/downloads_controller.rb

@@ -0,0 +1,4 @@
+class DownloadsController < ApplicationController
+  include CommonwealthVlrEngine::DownloadsControllerBehavior
+
+end

data/app/controllers/iiif_manifest_controller.rb

@@ -21,7 +21,7 @@ class IiifManifestController < CatalogController
     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]))
+      image_files = image_file_pids(get_image_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],
@@ -38,7 +38,7 @@ class IiifManifestController < CatalogController
 
   def annotation
     response, document = fetch(params[:id])
-    if has_image_files?(get_files(params[:id])).include?(params[:annotation_object_id])
+    if image_file_pids(get_image_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
@@ -66,9 +66,4 @@ class IiifManifestController < CatalogController
     headers['Access-Control-Allow-Origin'] = "*"
   end
 
-  def not_found
-    raise ActionController::RoutingError.new('Not Found')
-  end
-
-
 end

data/app/controllers/image_viewer_controller.rb

@@ -5,9 +5,9 @@ class ImageViewerController < CatalogController
 
   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])
+    # @object_files is already set by before_filter in CommonwealthVlrEngine::ControllerOverride
+    @page_sequence = create_img_sequence(image_file_pids(@object_files[:images]), params[:view])
     respond_to do |format|
       format.js
       format.html { redirect_to solr_document_path(@document.id,
@@ -17,18 +17,8 @@ class ImageViewerController < CatalogController
 
   def book_viewer
     @response, @document = fetch(params[:id])
-    @image_files = has_image_files?(get_files(params[:id]))
+    @image_files = image_file_pids(get_image_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

@@ -1,68 +1,4 @@
 class InstitutionsController < CatalogController
-
-  ##
-  # Give Bookmarks access to the CatalogController configuration
-  include Blacklight::Configurable
-  include Blacklight::SearchHelper
-
-  copy_blacklight_config_from(CatalogController)
-
-  before_filter :institutions_index_config, :only => [:index]
-  # remove collection facet and collapse others
-  before_filter :relation_base_blacklight_config, :only => [:show]
-
-  # Blacklight uses #search_action_url to figure out the right URL for
-  # the global search box
-  def search_action_url options = {}
-    search_catalog_url(options.except(:controller, :action))
-  end
-  helper_method :search_action_url
-
-  def index
-    @nav_li_active = 'explore'
-    params[:per_page] = params[:per_page].presence || '50'
-    (@response, @document_list) = search_results(params)
-    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'})
-
-    # 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]})
-
-    # get an image for the institution
-    if @document[:exemplary_image_ssi]
-      @institution_image_pid = @document[:exemplary_image_ssi]
-    end
-
-    respond_to do |format|
-      format.html
-    end
-
-  end
-
-  private
-
-  # remove grid view from blacklight_config, use correct SearchBuilder for index view
-  def institutions_index_config
-    blacklight_config.search_builder_class = CommonwealthInstitutionsSearchBuilder
-    blacklight_config.view.delete(:gallery)
-    blacklight_config.view.delete(:masonry)
-    blacklight_config.view.delete(:slideshow)
-  end
+  include CommonwealthVlrEngine::InstitutionsControllerBehavior
 
 end

data/app/controllers/ocr_search_controller.rb

@@ -13,7 +13,7 @@ class OcrSearchController < CatalogController
   def index
     @doc_response, @document = fetch(params[:id])
     if params[:ocr_q]
-      @image_pid_list = has_image_files?(get_files(params[:id]))
+      @image_pid_list = image_file_pids(get_image_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]

data/app/controllers/saved_searches_controller.rb

@@ -4,5 +4,7 @@ class SavedSearchesController < ApplicationController
 
   helper BlacklightAdvancedSearch::RenderConstraintsOverride
   helper BlacklightMaps::RenderConstraintsOverride
+  helper BlacklightRangeLimit::ViewHelperOverride
+  helper RangeLimitHelper
   helper CommonwealthVlrEngine::RenderConstraintsOverride
 end

data/app/controllers/search_history_controller.rb

@@ -4,5 +4,7 @@ class SearchHistoryController < ApplicationController
 
   helper BlacklightAdvancedSearch::RenderConstraintsOverride
   helper BlacklightMaps::RenderConstraintsOverride
+  helper BlacklightRangeLimit::ViewHelperOverride
+  helper RangeLimitHelper
   helper CommonwealthVlrEngine::RenderConstraintsOverride
 end

data/app/helpers/commonwealth_vlr_engine/application_helper.rb

@@ -29,8 +29,8 @@ module CommonwealthVlrEngine
       end
     end
 
-    def render_format_index(args)
-      render_format(args[:document][args[:field]])
+    def render_format_index(options={})
+      options[:value].map { |v| render_format(v) }.join('; ')
     end
 
     # return the path to the icon for objects with no thumbnail
@@ -48,6 +48,19 @@ module CommonwealthVlrEngine
       "commonwealth-vlr-engine/dc_#{icon}-icon.png"
     end
 
+    # render date range constraints from Advanced Search form
+    # used by CommonwealthVlrEngine::RenderConstraintsOverride
+    # and CommonwealthVlrEngine::SearchHistoryConstraintsHelper
+    def date_range_constraints_to_s(params)
+      if params[:date_start].blank?
+        "before #{params[:date_end]}"
+      elsif params[:date_end].blank?
+        "after #{params[:date_start]}"
+      else
+        "#{params[:date_start]}-#{params[:date_end]}"
+      end
+    end
+
     #from psu scholarsphere
     # TODO: this isn't used anywhere in the app, get rid of it?
     def link_to_field(fieldname, fieldvalue, displayvalue = nil)
@@ -195,6 +208,11 @@ module CommonwealthVlrEngine
       }.to_json
     end
 
+    # adds apple-touch-icon tags to <head>
+    def render_mobile_icon_tags
+      render partial: 'shared/mobile_icon_tags'
+    end
+
   end
 end
 

data/app/helpers/commonwealth_vlr_engine/catalog_helper.rb

@@ -32,25 +32,6 @@ module CommonwealthVlrEngine
       'commonwealth-vlr-engine/dc_collection-icon.png'
     end
 
-    def create_download_links(document, files_hash, link_class)
-      file_types = [files_hash[:audio], files_hash[:documents], files_hash[:ereader], files_hash[:generic]]
-      download_links = []
-      file_types.each do |file_type|
-        file_type.each do |file|
-          object_profile_json = JSON.parse(file['object_profile_ssm'].first)
-          file_name_ext = object_profile_json["objLabel"].split('.')
-          download_link_title = document['identifier_ia_id_ssi'] ? ia_download_title(file_name_ext[1]) : file_name_ext[0]
-          download_links << link_to(download_link_title,
-                                    datastream_disseminator_url(file['id'],'productionMaster'),
-                                    :target => '_blank',
-                                    :class => link_class) + content_tag(:span,
-                                                                        "(#{file_name_ext[1].upcase}, #{number_to_human_size(object_profile_json["datastreams"]["productionMaster"]["dsSize"])})",
-                                                                        :class => 'download_info')
-        end
-      end
-      download_links
-    end
-
     def create_thumb_img_element(document, img_class=[])
       image_classes = img_class.class == Array ? img_class.join(' ') : ''
       image_tag(thumbnail_url(document),
@@ -68,38 +49,16 @@ module CommonwealthVlrEngine
       end
     end
 
-    def has_downloadable_files? files_hash
-      files_hash[:documents].present? ||
-          files_hash[:audio].present? ||
-          files_hash[:generic].present? ||
-          files_hash[:ereader].present?
-    end
-
     def has_image_files? files_hash
-      image_file_pids = nil
-      unless files_hash[:images].empty?
-        image_file_pids = []
-        files_hash[:images].each do |image_file|
-          image_file_pids << image_file['id']
-        end
-      end
-      image_file_pids
+      files_hash[:images].present?
     end
 
-    # render the file type names for Internet Archive book item download links
-    def ia_download_title(file_extension)
-      case file_extension
-        when 'mobi'
-          'Kindle'
-        when 'zip'
-          'Daisy'
-        when 'pdf'
-          'PDF'
-        when 'epub'
-          'EPUB'
-        else
-          file_extension.upcase
+    def image_file_pids images_hash
+      image_file_pids = []
+      images_hash.each do |image_file|
+        image_file_pids << image_file['id']
       end
+      image_file_pids
     end
 
     # render collection name as a link in catalog#index list view
@@ -266,12 +225,11 @@ module CommonwealthVlrEngine
 
     # render the 'more like this' search link if doc has subjects
     def render_mlt_search_link(document)
-      if document[:subject_facet_ssim] || document[:subject_geo_city_ssim]
-        content_tag :div, :id => 'more_mlt_link_wrapper' do
+      if document[:subject_facet_ssim] || document[:subject_geo_city_ssim] || document[:related_item_host_ssim]
+        content_tag :div, id: 'more_mlt_link_wrapper' do
           link_to t('blacklight.more_like_this.more_mlt_link'),
-                  search_catalog_path(:mlt_id => document.id,
-                                     :qt => 'mlt'),
-                  :id => 'more_mlt_link'
+                  search_catalog_path(mlt_id: document.id),
+                  id: 'more_mlt_link'
         end
       end
     end
@@ -297,7 +255,7 @@ module CommonwealthVlrEngine
         prefix = date_qualifier == 'approximate' ? '[ca. ' : '['
         suffix = date_qualifier == 'questionable' ? '?]' : ']'
       end
-      prefix << 'c' if date_type == 'copyrightDate'
+      prefix << '(c) ' if date_type == 'copyrightDate'
       if date_end && date_end != 'nil'
         date_start_suffix = '?' if date_qualifier == 'questionable'
         prefix + normalize_date(date_start) + date_start_suffix + t('blacklight.metadata_display.date_range_connector') + normalize_date(date_end) + suffix
@@ -306,6 +264,31 @@ module CommonwealthVlrEngine
       end
     end
 
+    # have to override to display non-typical constraints
+    # (e.g. coordinates, mlt, range limit, advanced search)
+    # need this until:
+    # https://github.com/projectblacklight/blacklight_advanced_search/issues/53
+    # https://github.com/projectblacklight/blacklight-maps/issues/84
+    # https://github.com/projectblacklight/blacklight_range_limit/issues/49
+    # are resolved
+    def render_search_to_page_title(params)
+      # this is ugly, but easiest way to deal with it; too many gems to try and solve it all here
+      html_constraints = render_search_to_s(params).gsub(/<span class="filterValues">/,' ')
+      html_constraints = html_constraints.gsub(/<\/span>[\s]*<span class="constraint">/,' / ')
+      sanitize(html_constraints, :tags=>[])
+
+      ## TODO: remove above and uncomment lines below after all issues have been resolved with
+      ##       blacklight_advanced_search, blacklight_range_limit, and blacklight-maps
+      # constraints = [render_search_to_page_title_mlt(params), super(params)]
+      # constraints.reject { |item| item.blank? }.join(' / ')
+    end
+
+    # TODO: uncomment and write spec after issues identified with render_search_to_page_title resolved
+    #def render_search_to_page_title_mlt(params)
+    #  return "".html_safe if params[:mlt_id].blank?
+    #  "#{t('blacklight.search.filters.label', :label => t('blacklight.more_like_this.constraint_label'))} #{h(params[:mlt_id])}"
+    #end
+
     def render_mods_xml_record(document_id)
       mods_xml_file_path = datastream_disseminator_url(document_id, 'descMetadata')
       mods_response = Typhoeus::Request.get(mods_xml_file_path)

data/app/helpers/commonwealth_vlr_engine/downloads_helper_behavior.rb

@@ -0,0 +1,192 @@
+module CommonwealthVlrEngine
+  module DownloadsHelperBehavior
+
+    # create an array of download links
+    # images have to be handled by a separate function since there are multiple sizes
+    def create_download_links(document, files_hash)
+      download_links = []
+      non_img_file_types = [files_hash[:audio], files_hash[:documents], files_hash[:ereader], files_hash[:generic]]
+      if has_downloadable_images?(document, files_hash) && !files_hash[:images].empty?
+        download_links.concat(image_download_links(document, files_hash[:images]))
+      end
+      non_img_file_types.each do |file_type|
+        file_type.each do |file|
+          object_profile_json = JSON.parse(file['object_profile_ssm'].first)
+          download_links << file_download_link(file['id'],
+                                               download_link_title(document, object_profile_json),
+                                               object_profile_json,
+                                               'productionMaster',
+                                               download_link_options)
+        end
+      end
+      download_links
+    end
+
+    def download_link_class
+      'sidebar_downloads_link'
+    end
+
+    def download_link_options
+      {class: download_link_class, rel: 'nofollow', data: {:ajax_modal => 'trigger'}}
+    end
+
+    def download_link_title(document, object_profile, datastream_id=nil)
+      if !object_profile || (document[:has_model_ssim].include? "info:fedora/afmodel:Bplmodels_ImageFile")
+        link_title = t("blacklight.downloads.images.#{datastream_id}")
+      else
+        file_name_ext = object_profile["objLabel"].split('.')
+        if document[:identifier_ia_id_ssi] || (document[:active_fedora_model_ssi] == "Bplmodels::EreaderFile")
+          link_title = ia_download_title(file_name_ext[1])
+        else
+          link_title = file_name_ext[0]
+        end
+      end
+      link_title
+    end
+
+    def has_downloadable_files?(document, files_hash)
+      has_downloadable_images?(document, files_hash) ||
+          files_hash[:documents].present? ||
+          files_hash[:audio].present? ||
+          files_hash[:generic].present? ||
+          files_hash[:ereader].present?
+    end
+
+    def has_downloadable_images?(document, files_hash)
+      has_image_files?(files_hash) && license_allows_download?(document)
+    end
+
+    # render the file type names for Internet Archive book item download links
+    def ia_download_title(file_extension)
+      case file_extension
+        when 'mobi'
+          'Kindle'
+        when 'zip'
+          'Daisy'
+        else
+          file_extension.upcase
+      end
+    end
+
+    def image_datastreams(object_profile_json)
+      image_datastreams = []
+      stored_datastreams = %w(productionMaster access800 georectifiedMaster)
+      stored_datastreams.each do |datastream_id|
+        image_datastreams << datastream_id if object_profile_json["datastreams"][datastream_id]
+      end
+      image_datastreams.insert(1, 'accessFull')
+    end
+
+    def image_download_links(document, image_files_hash)
+      if document[:identifier_ia_id_ssi]
+        [file_download_link(document[:id],
+                            t("blacklight.downloads.images.accessFull"),
+                            nil,
+                            'JPEG2000',
+                            download_link_options)]
+      else
+        object_profile_json = JSON.parse(image_files_hash.first['object_profile_ssm'].first)
+        image_links = []
+        image_datastreams(object_profile_json).each do |datastream_id|
+          if image_files_hash.length == 1
+            object_profile = object_profile_json
+            object_id = image_files_hash.first['id']
+          else
+            object_profile = setup_zip_object_profile(image_files_hash, datastream_id)
+            object_id = document[:id]
+          end
+          image_links << file_download_link(object_id,
+                                            t("blacklight.downloads.images.#{datastream_id}"),
+                                            object_profile,
+                                            datastream_id,
+                                            download_link_options)
+        end
+        image_links
+      end
+    end
+
+    # parse the license statement and return true if image downloads are allowed
+    def license_allows_download? document
+      document[:license_ssm].to_s =~ /(Creative Commons|No known restrictions)/
+    end
+
+    def file_download_link(object_pid, link_title, object_profile_json, datastream_id, link_options={})
+      link_to(link_title,
+              download_path(object_pid, datastream_id: datastream_id),
+              link_options) + content_tag(:span,
+                                          "(#{file_type_string(datastream_id, object_profile_json)}, #{file_size_string(datastream_id, object_profile_json)})",
+                                          class: 'download_info')
+    end
+
+    def file_type_string(datastream_id, object_profile_json)
+      if object_profile_json
+        if datastream_id == 'accessFull' || datastream_id == 'access800'
+          file_type_string = 'JPEG'
+        else
+          #file_type_string = object_profile_json["datastreams"][datastream_id]["dsMIME"].split('/')[1].upcase
+          file_type_string = object_profile_json["objLabel"].split('.')[1].upcase
+        end
+        file_type_string << ', multi-file ZIP' if object_profile_json["zip"]
+      else
+        file_type_string = case datastream_id
+                             when 'productionMaster'
+                               'TIF'
+                             when 'JPEG2000'
+                               datastream_id
+                             else
+                               'JPEG'
+                           end
+      end
+      file_type_string
+    end
+
+    def file_size_string(datastream_id, object_profile_json)
+      if object_profile_json
+        if datastream_id == 'accessFull'
+          file_size_string = '~' +
+              number_to_human_size((object_profile_json["datastreams"]["productionMaster"]["dsSize"] * 0.083969078))
+        else
+          file_size_string = number_to_human_size(object_profile_json["datastreams"][datastream_id]["dsSize"])
+          file_size_string.insert(0,'~') if object_profile_json["zip"]
+        end
+      else
+        file_size_string = 'multi-file ZIP'
+      end
+      file_size_string
+    end
+
+    # create a composite object_profile_json object from multiple file objects
+    # used to display size of ZIP archive
+    def setup_zip_object_profile(image_files_hash, datastream_id)
+      datastream_id_to_use = datastream_id == 'accessFull' ? 'productionMaster' : datastream_id
+      object_profile = {zip: true,
+                        objLabel: datastream_id == 'productionMaster' ? '.TIF' : '.JPEG',
+                        datastreams: {datastream_id_to_use.to_sym => {}}}
+      zip_size = 0
+      image_files_hash.each do |image_file|
+        img_object_profile_json = JSON.parse(image_file['object_profile_ssm'].first)
+        zip_size += img_object_profile_json["datastreams"][datastream_id_to_use]["dsSize"]
+      end
+      # estimate compression, pretty rough
+      zip_size = case datastream_id
+                   when 'productionMaster'
+                     zip_size * 0.798
+                   when 'accessFull'
+                     zip_size * 0.839
+                   else
+                     zip_size * 0.927
+                 end
+      object_profile[:datastreams][datastream_id_to_use.to_sym][:dsSize] = zip_size
+      object_profile.deep_stringify_keys
+    end
+
+    def url_for_download(document, datastream_id)
+      if document[:identifier_ia_id_ssi] && datastream_id == 'JPEG2000'
+        "https://archive.org/download/#{document[:identifier_ia_id_ssi]}/#{document[:identifier_ia_id_ssi]}_jp2.zip"
+      else
+        trigger_downloads_path(document.id, datastream_id: datastream_id)
+      end
+    end
+
+  end
+end