commonwealth-vlr-engine 0.0.1

data/app/controllers/pages_controller.rb

@@ -0,0 +1,5 @@
+class PagesController < ApplicationController
+
+  include CommonwealthVlrEngine::Pages
+
+end

data/app/controllers/users/omniauth_callbacks_controller.rb

@@ -0,0 +1,10 @@
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+
+  #https://github.com/plataformatec/devise/issues/2432
+
+  # this is the only spot where we allow CSRF, our openid / oauth redirect
+  # will not have a CSRF token, however the payload is all validated so its safe
+  skip_before_filter :verify_authenticity_token
+
+  include Bpluser::Users::OmniauthCallbacksController
+end

data/app/controllers/users/registrations_controller.rb

@@ -0,0 +1,3 @@
+class Users::RegistrationsController < Devise::RegistrationsController
+  include Bpluser::Users::RegistrationsController
+end

data/app/controllers/users/sessions_controller.rb

@@ -0,0 +1,3 @@
+class Users::SessionsController < Devise::SessionsController
+  include Bpluser::Users::SessionsController
+end

data/app/controllers/users_controller.rb

@@ -0,0 +1,27 @@
+class UsersController < ApplicationController
+
+  before_action :authenticate_user!, :correct_user, :only => [:show]
+
+  def show
+    @user = User.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb.bak
+      format.xml { render :xml => @user }
+    end
+  end
+
+  # getting some weird intermittent errors where users are being redirected
+  # to '/users' after signup. this is a failsafe last-resort solution
+  def index
+    redirect_to root_path
+  end
+
+  protected
+
+  def correct_user
+    @user = User.find(params[:id])
+    redirect_to root_path unless current_user.id == @user.id
+  end
+
+end

data/app/helpers/blacklight_maps_helper.rb

@@ -0,0 +1,3 @@
+module BlacklightMapsHelper
+  include CommonwealthVlrEngine::VlrBlacklightMapsHelperBehavior
+end

data/app/helpers/collections_helper.rb

@@ -0,0 +1,3 @@
+module CollectionsHelper
+  include CommonwealthVlrEngine::CollectionsHelperBehavior
+end

data/app/helpers/commonwealth_vlr_engine/application_helper.rb

@@ -0,0 +1,200 @@
+module CommonwealthVlrEngine
+  module ApplicationHelper
+
+    # show the display-friendly value for the Format facet
+    def render_format(value)
+      case value
+        when 'Albums'
+          'Albums/Scrapbooks'
+        when 'Drawings'
+          'Drawings/Illustrations'
+        when 'Maps'
+          'Maps/Atlases'
+        when 'Motion pictures'
+          'Film/Video'
+        when 'Music'
+          'Music (recordings)'
+        when 'Objects'
+          'Objects/Artifacts'
+        when 'Musical notation'
+          'Sheet music'
+        when 'Sound recordings'
+          'Audio recordings (nonmusical)'
+        when 'Cards'
+          'Postcards/Cards'
+        when 'Correspondence'
+          'Letters/Correspondence'
+        else
+          value
+      end
+    end
+
+    def render_format_index(args)
+      render_format(args[:document][args[:field]])
+    end
+
+    # return the path to the icon for objects with no thumbnail
+    def render_object_icon_path(format)
+      case format
+        when 'still image'
+          icon = 'image'
+        when 'sound recording', 'sound recording-nonmusical', 'sound recording-musical'
+          icon = 'audio'
+        when 'moving image'
+          icon = 'moving-image'
+        else
+          icon = 'text'
+      end
+      "commonwealth-vlr-engine/dc_#{icon}-icon.png"
+    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)
+      p = {:search_field => fieldname, :q => '"'+fieldvalue+'"'}
+      link_url = catalog_index_path(p)
+      display = displayvalue.blank? ? fieldvalue: displayvalue
+      link_to(display, link_url)
+    end
+
+    def link_to_facet(field_value, field, displayvalue = nil)
+      if field == 'genre_basic_ssim'
+        link_to(render_format(field_value), catalog_index_path(:f => {field => [field_value]}))
+      else
+        link_to(displayvalue.presence || field_value, catalog_index_path(:f => {field => [field_value]}))
+      end
+    end
+
+    # link to a combination of facets (series + subseries, for ex)
+    def link_to_facets(field_values, fields, displayvalue = nil)
+      facets = {}
+      fields.each_with_index do |field, index|
+        facets[field] = [field_values[index]]
+      end
+      link_to(displayvalue.presence || field_values[0], catalog_index_path(:f => facets))
+    end
+
+    def link_to_county_facet(field_value, field)
+      link_to(field_value + ' County', catalog_index_path(:f => {field => [field_value + ' (county)']}))
+    end
+
+    # returns the direct URL to a datastream in Fedora
+    def datastream_disseminator_url pid, datastream_id
+      "#{FEDORA_URL['url']}/objects/#{pid}/datastreams/#{datastream_id}/content"
+    end
+
+    # create an image tag from an IIIF image server
+    def iiif_image_tag(image_pid,options)
+      image_tag iiif_image_url(image_pid, options), :alt => options[:alt].presence, :class => options[:class].presence
+    end
+
+    # return the IIIF image url
+    def iiif_image_url(image_pid, options)
+      size = options[:size] ? options[:size] : 'full'
+      region = options[:region] ? options[:region] : 'full'
+      "#{IIIF_SERVER['url']}#{image_pid}/#{region}/#{size}/0/default.jpg"
+    end
+
+    # return a square image of the supplied size (in pixels)
+    def iiif_square_img_path(image_pid, size)
+      img_info = get_image_metadata(image_pid)
+      width = img_info[:width]
+      height = img_info[:height]
+      if width > height
+        offset = (width - height) / 2
+        iiif_image_url(image_pid,
+                       {:region => "#{offset},0,#{height},#{height}", :size => "#{size},#{size}"})
+      elsif height > width
+        offset = (height - width) / 2
+        iiif_image_url(image_pid,
+                       {:region => "0,#{offset},#{width},#{width}", :size => "#{size},#{size}"})
+      else
+        iiif_image_url(image_pid, {:size => "#{size},#{size}"})
+      end
+    end
+
+    # returns a hash with width/height from IIIF info.json response
+    def get_image_metadata(image_pid)
+      iiif_response = Typhoeus::Request.get(IIIF_SERVER['url'] + image_pid + '/info.json')
+      if iiif_response.response_code == 200 && !iiif_response.response_body.empty?
+        iiif_info = JSON.parse(iiif_response.body)
+        img_metadata = {height: iiif_info["height"].to_i, width: iiif_info["width"].to_i}
+      else
+        img_metadata = {height: 0, width: 0}
+      end
+      img_metadata
+    end
+
+    def insert_opengraph_markup
+      if controller_name == 'catalog' && action_name == 'show'
+        content_for(:head) do
+          render :partial=>'/catalog/opengraph', :locals => {:document => @document}
+        end
+      end
+    end
+
+    def insert_google_analytics
+      if Rails.env.to_s == 'production'
+        content_for(:head) do
+          render :partial=>'/layouts/google_analytics'
+        end
+      end
+    end
+
+    # returns a hash with the location of the OpenSeadragon custom images
+    def osd_nav_images(path_to_directory)
+      {
+          zoomIn: {
+              REST:     image_path("#{path_to_directory}/zoomin_rest.png"),
+              GROUP:    image_path("#{path_to_directory}/zoomin_grouphover.png"),
+              HOVER:    image_path("#{path_to_directory}/zoomin_hover.png"),
+              DOWN:     image_path("#{path_to_directory}/zoomin_pressed.png")
+          },
+          zoomOut: {
+              REST:   image_path("#{path_to_directory}/zoomout_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/zoomout_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/zoomout_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/zoomout_pressed.png")
+          },
+          home: {
+              REST:   image_path("#{path_to_directory}/home_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/home_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/home_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/home_pressed.png")
+          },
+          fullpage: {
+              REST:   image_path("#{path_to_directory}/fullpage_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/fullpage_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/fullpage_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/fullpage_pressed.png")
+          },
+          rotateleft: {
+              REST:   image_path("#{path_to_directory}/rotateleft_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/rotateleft_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/rotateleft_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/rotateleft_pressed.png")
+          },
+          rotateright: {
+              REST:   image_path("#{path_to_directory}/rotateright_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/rotateright_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/rotateright_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/rotateright_pressed.png")
+          },
+          previous: {
+              REST:   image_path("#{path_to_directory}/previous_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/previous_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/previous_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/previous_pressed.png")
+          },
+          next: {
+              REST:   image_path("#{path_to_directory}/next_rest.png"),
+              GROUP:  image_path("#{path_to_directory}/next_grouphover.png"),
+              HOVER:  image_path("#{path_to_directory}/next_hover.png"),
+              DOWN:   image_path("#{path_to_directory}/next_pressed.png")
+          }
+      }.to_json
+    end
+
+  end
+end
+

data/app/helpers/commonwealth_vlr_engine/blacklight_helper.rb

@@ -0,0 +1,35 @@
+module CommonwealthVlrEngine
+  module BlacklightHelper
+    include Blacklight::BlacklightHelperBehavior
+
+    # local override to allow using CommonwealthVlrEngine::CatalogHelper#render_main_title
+    # for catalog#show title heading
+    def document_heading document=nil
+      document ||= @document
+      if document[blacklight_config.index.title_field.to_sym]
+        render_main_title(document)
+      else
+        @document.id
+      end
+    end
+
+    # local override to use custom #document_heading method (above) for catalog#show title heading
+    def render_document_heading(*args)
+      options = args.extract_options!
+
+      tag_or_document = args.first
+
+      if tag_or_document.is_a? String or tag_or_document.is_a? Symbol
+        Deprecation.warn(Blacklight::BlacklightHelperBehavior, "#render_document_heading with a tag argument is deprecated; pass e.g. `tag: :h4` instead")
+        tag = tag_or_document
+        document = @document
+      else
+        tag = options.fetch(:tag, :h4)
+        document = tag_or_document || @document
+      end
+
+      content_tag(tag, document_heading(document), itemprop: "name")
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/blacklight_url_helper.rb

@@ -0,0 +1,53 @@
+module CommonwealthVlrEngine
+  module BlacklightUrlHelper
+    include Blacklight::UrlHelperBehavior
+
+    # overriding to allow use in collections#show and institutions#show
+    # so facet links in those views point to catalog#index
+    def add_facet_params_and_redirect(field, item)
+      new_params = add_facet_params(field, item)
+
+      # Delete any request params from facet-specific action, needed
+      # to redir to index action properly.
+      request_keys = blacklight_config.facet_paginator_class.request_keys
+      new_params.except! *request_keys.values
+
+      # Force controller#action to be catalog#index.
+      new_params[:action] = "index"
+      new_params[:controller] = "catalog"
+      new_params
+    end
+
+    # need this method for rss and atom polymorphic_url(url_for_document(document))
+    # because polymorphic_url appends any action passed in arg hash to route
+    # so we need to re-route to the correct url
+    def show_solr_document_url doc, options
+      if options[:controller]
+        case options[:controller]
+          when 'collections'
+            collection_url doc
+          when 'institutions'
+            institution_url doc
+        end
+      else
+        solr_document_url doc, options
+      end
+
+    end
+
+    # override to route to collections#show and institutions#show where appropriate
+    def url_for_document doc, options = {}
+      if respond_to?(:blacklight_config) && doc.respond_to?(:[])
+        display_type = doc[blacklight_config.show.display_type_field].presence
+        if display_type == 'Collection' || display_type == 'Institution'
+          {controller: display_type.downcase.pluralize, action: :show, id: doc}
+        else
+          doc
+        end
+      else
+        doc
+      end
+    end
+
+  end
+end

data/app/helpers/commonwealth_vlr_engine/catalog_helper.rb

@@ -0,0 +1,414 @@
+module CommonwealthVlrEngine
+  module CatalogHelper
+    include Blacklight::CatalogHelperBehavior
+
+    # returns the CC license terms code for use in URLs, etc.
+    def cc_terms_code(license)
+      license.match(/\s[BYNCDSA-]{2,}/).to_s.strip.downcase
+    end
+
+    # returns a link to a CC license
+    def cc_url(license)
+      terms_code = cc_terms_code(license)
+      "http://creativecommons.org/licenses/#{terms_code}/3.0"
+    end
+
+    # return the image url for the collection gallery view document
+    # size = pixel length of square IIIF-created image
+    def collection_gallery_url document, size
+      exemplary_image_pid = document[:exemplary_image_ssi]
+      if exemplary_image_pid
+        if exemplary_image_pid.match(/oai/)
+          datastream_disseminator_url(exemplary_image_pid,'thumbnail300')
+        else
+          iiif_square_img_path(exemplary_image_pid, size)
+        end
+      else
+        collection_icon_path
+      end
+    end
+
+    def collection_icon_path
+      'commonwealth-vlr-engine/dc_collection-icon.png'
+    end
+
+    def create_download_links(document, files_hash, link_class)
+      file_types = [files_hash[:documents], files_hash[:ereader], files_hash[:audio], 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]}, #{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),
+                :alt => document[blacklight_config.index.title_field.to_sym],
+                :class => image_classes)
+    end
+
+    def extra_body_classes
+      @extra_body_classes ||= ['blacklight-' + controller_name, 'blacklight-' + [controller_name, controller.action_name].join('-')]
+      # if this is the home page
+      if controller_name == 'pages' && action_name =='home'
+        @extra_body_classes.push('blacklight-home')
+      else
+        @extra_body_classes
+      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
+    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
+      end
+    end
+
+    # render collection name as a link in catalog#index list view
+    def index_collection_link options={}
+      setup_collection_links(options[:document]).join(' / ').html_safe
+    end
+
+
+    # render the date in the catalog#index list view
+    def index_date_value options={}
+      render_mods_dates(options[:document]).first
+    end
+
+    # render institution name as a link in catalog#index list view
+    def index_institution_link options={}
+      link_to(options[:value].first,
+              institution_path(:id => options[:document][:institution_pid_ssi]))
+    end
+
+    # render the collection/institution icon if necessary
+    def index_relation_base_icon document
+      if document[blacklight_config.view_config(document_index_view_type).display_type_field]
+        display_type = document[blacklight_config.view_config(document_index_view_type).display_type_field].downcase
+        if controller_name == 'catalog' && (display_type == 'collection' || display_type == 'institution')
+          image_tag("commonwealth-vlr-engine/dc_#{display_type}-icon.png", alt: "#{display_type} icon", class: "index-title-icon #{display_type}-icon")
+        else
+          ''
+        end
+      end
+    end
+
+    # return the URL of an image to display in the catalog#index slideshow view
+    def index_slideshow_img_url document
+      if document[:exemplary_image_ssi] && !document[blacklight_config.flagged_field.to_sym]
+        if document[blacklight_config.index.display_type_field.to_sym] == 'OAIObject' || document[:exemplary_image_ssi].match(/oai/)
+          thumbnail_url(document)
+        else
+          iiif_image_url(document[:exemplary_image_ssi], {:size => ',500'})
+        end
+      elsif document[:type_of_resource_ssim]
+        render_object_icon_path(document[:type_of_resource_ssim].first)
+      elsif document[blacklight_config.index.display_type_field.to_sym] == 'Collection'
+        collection_icon_path
+      elsif document[blacklight_config.index.display_type_field.to_sym] == 'Institution'
+        institution_icon_path
+      else
+        render_object_icon_path(nil)
+      end
+    end
+
+    # determine the 'truncate' length based on catalog#index view type
+    def index_title_length
+      case params[:view]
+        when 'list'
+          170
+        when 'masonry'
+          89
+        else
+          130
+      end
+    end
+
+    def institution_icon_path
+      'commonwealth-vlr-engine/dc_institution-icon.png'
+    end
+
+    # link to items starting with a specific letter
+    def link_to_az_value(letter, field, search_path, link_class=nil)
+      new_params = params.except(:controller, :action, :q, :page)
+      new_params[:q] = "#{field}:#{letter}*"
+      link_to(letter,
+              self.send(search_path, new_params),
+              class: link_class)
+    end
+
+    def normalize_date(date)
+      if date.length == 10
+        Date.parse(date).strftime('%B %-d, %Y')
+      elsif date.length == 7
+        Date.parse(date + '-01').strftime('%B %Y')
+      else
+        date
+      end
+    end
+
+    # insert an icon and link to CC licenses
+    def render_cc_license(license)
+      terms_code = cc_terms_code(license)
+      link_to(image_tag("//i.creativecommons.org/l/#{terms_code}/3.0/80x15.png",
+                        :alt => 'CC ' + terms_code.upcase + ' icon',
+                        :class => 'cc_license_icon'),
+              cc_url(license),
+              :rel => 'license',
+              :id => 'cc_license_link',
+              :target => '_blank')
+    end
+
+    # output properly formatted full title, with subtitle, parallel title, etc.
+    def render_full_title(document)
+      title_output = ''
+      title_output << document[blacklight_config.index.title_field.to_sym]
+      if document[:subtitle_tsim]
+        title_output << " : #{document[:subtitle_tsim].first}"
+      end
+      if document[:title_info_partnum_tsi]
+        title_output << ". #{document[:title_info_partnum_tsi]}"
+      end
+      if document[:title_info_partname_tsi]
+        title_output << ". #{document[:title_info_partname_tsi]}"
+      end
+      if document[:title_info_primary_trans_tsim]
+        document[:title_info_primary_trans_tsim].each do |parallel_title|
+          title_output << " = #{parallel_title}"
+        end
+      end
+      title_output.squish
+    end
+
+    # render metadata for <mods:hierarchicalGeographic> subjects from GeoJSON
+    def render_hiergo_subject(geojson_feature, separator, separator_class=nil)
+      output_array = []
+      hiergeo_hash = JSON.parse(geojson_feature).symbolize_keys[:properties]
+      hiergeo_hash.each_key do |k|
+        if k == 'country' && hiergeo_hash[k] == 'United States'
+          # display 'United States' only if no other values
+          output_array << link_to_facet(hiergeo_hash[k], 'subject_geographic_ssim') if hiergeo_hash.length == 1
+        elsif k == 'county'
+          output_array << link_to_facet("#{hiergeo_hash[k]} (county)", 'subject_geographic_ssim')
+        elsif k == 'island' || k == 'area' || k == 'province' || k == 'territory' || k == 'region'
+          output_array << link_to_facet(hiergeo_hash[k], 'subject_geographic_ssim') + " (#{k.to_s})"
+        elsif k == 'other'
+          place_type = hiergeo_hash[k].scan(/\([a-z\s]*\)/).last
+          place_name = hiergeo_hash[k].gsub(/#{place_type}/,'').gsub(/\s\(\)\z/,'')
+          output_array << link_to_facet(place_name, 'subject_geographic_ssim') + " #{place_type.to_s}"
+        else
+          output_array << link_to_facet(hiergeo_hash[k], 'subject_geographic_ssim')
+        end
+      end
+      output_array.join(content_tag(:span, separator, :class => separator_class)).html_safe
+    end
+
+    def render_item_breadcrumb(document)
+      if document[:collection_pid_ssm]
+        setup_collection_links(document).sort.join(' / ').html_safe
+      end
+    end
+
+    # output properly formatted title with volume info, but no subtitle
+    def render_main_title(document)
+      title_output = ''
+      if document[blacklight_config.index.title_field.to_sym]
+        title_output << document[blacklight_config.index.title_field.to_sym]
+        if document[:title_info_partnum_tsi]
+          title_output << ". #{document[:title_info_partnum_tsi]}"
+        end
+        if document[:title_info_partname_tsi]
+          title_output << ". #{document[:title_info_partname_tsi]}"
+        end
+      else
+        title_output << document.id
+      end
+      title_output.squish
+    end
+
+    # 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
+          link_to t('blacklight.more_like_this.more_mlt_link'),
+                  catalog_index_path(:mlt_id => document.id,
+                                     :qt => 'mlt'),
+                  :id => 'more_mlt_link'
+        end
+      end
+    end
+
+    # returns an array of properly-formatted date values
+    def render_mods_dates (document)
+      date_values = []
+      document[:date_start_tsim].each_with_index do |start_date,index|
+        date_type = document[:date_type_ssm] ? document[:date_type_ssm][index] : nil
+        date_qualifier = document[:date_start_qualifier_ssm] ? document[:date_start_qualifier_ssm][index] : nil
+        date_end = document[:date_end_tsim] ? document[:date_end_tsim][index] : nil
+        date_values << render_mods_date(start_date, date_end, date_qualifier, date_type)
+      end
+      date_values
+    end
+
+    # returns a properly-formatted date value as a string
+    def render_mods_date (date_start, date_end = nil, date_qualifier = nil, date_type = nil)
+      prefix = ''
+      suffix = ''
+      date_start_suffix = ''
+      if date_qualifier && date_qualifier != 'nil'
+        prefix = date_qualifier == 'approximate' ? '[ca. ' : '['
+        suffix = date_qualifier == 'questionable' ? '?]' : ']'
+      end
+      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
+      else
+        prefix + normalize_date(date_start) + suffix
+      end
+    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)
+      mods_xml_text = REXML::Document.new(mods_response.body)
+    end
+
+    def render_volume_title(document)
+      vol_title_info = [document[:title_info_partnum_tsi], document[:title_info_partname_tsi]]
+      if vol_title_info[0]
+        vol_title_info[1] ? vol_title_info[0].capitalize + ': ' + vol_title_info[1] : vol_title_info[0].capitalize
+      elsif vol_title_info[1]
+        vol_title_info[1].capitalize
+      else
+        render_main_title(document)
+      end
+    end
+
+    # return the correct name of the institution to link to for OAI objects
+    def return_oai_inst_name(document)
+      if document[blacklight_config.institution_field.to_sym]
+        document[blacklight_config.institution_field.to_sym].first
+      else
+        t('blacklight.oai_objects.default_inst_name')
+      end
+    end
+
+    # creates an array of collection links
+    # for display on catalog#index list view and catalog#show breadcrumb
+    def setup_collection_links(document, link_class=nil)
+      coll_hash = {}
+      0.upto document[:collection_pid_ssm].length-1 do |index|
+        coll_hash[document[blacklight_config.collection_field.to_sym][index]] = document[:collection_pid_ssm][index]
+      end
+      coll_links = []
+      coll_hash.sort.each do |coll_array|
+        coll_links << link_to(coll_array[0],
+                              collection_path(:id => coll_array[1]),
+                              :class => link_class.presence)
+      end
+      coll_links
+    end
+
+    # create a list of names and roles to be displayed
+    def setup_names_roles(document)
+      names = []
+      roles = []
+      multi_role_indices = []
+      name_fields = [document[:name_personal_tsim], document[:name_corporate_tsim], document[:name_generic_tsim]]
+      role_fields = [document[:name_personal_role_tsim], document[:name_corporate_role_tsim], document[:name_generic_role_tsim]]
+      name_fields.each_with_index do |name_field,name_field_index|
+        if name_field
+          0.upto name_field.length-1 do |index|
+            names << name_field[index]
+            if role_fields[name_field_index] && role_fields[name_field_index][index]
+              roles << role_fields[name_field_index][index].strip
+            else
+              roles << 'Creator'
+            end
+          end
+        end
+      end
+      roles.each_with_index do |role,index|
+        if /[\|]{2}/.match(role)
+          multi_roles = role.split('||')
+          multi_role_name = names[index]
+          multi_role_indices << index
+          multi_roles.each { |multi_role| roles << multi_role }
+          0.upto multi_roles.length-1 do
+            names << multi_role_name
+          end
+        end
+      end
+      unless multi_role_indices.empty?
+        multi_role_indices.reverse.each do |index|
+          names.delete_at(index)
+          roles.delete_at(index)
+        end
+      end
+      return names,roles
+    end
+
+    def should_autofocus_on_search_box?
+      (controller.is_a? Blacklight::Catalog and
+          action_name == "index" and
+          params[:q].to_s.empty? and
+          params[:f].to_s.empty?) or
+          (controller.is_a? PagesController and action_name == 'home')
+    end
+
+    # LOCAL OVERRIDE: don't want to pull thumbnail url from Solr
+    def thumbnail_url document
+      if document[:exemplary_image_ssi] && !document[blacklight_config.flagged_field.to_sym]
+        datastream_disseminator_url(document[:exemplary_image_ssi], 'thumbnail300')
+      elsif document[:type_of_resource_ssim]
+        render_object_icon_path(document[:type_of_resource_ssim].first)
+      elsif document[blacklight_config.index.display_type_field.to_sym] == 'Collection'
+        collection_icon_path
+      elsif document[blacklight_config.index.display_type_field.to_sym] == 'Institution'
+        institution_icon_path
+      else
+        render_object_icon_path(nil)
+      end
+    end
+
+  end
+end