commonwealth-vlr-engine 0.0.1

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

@@ -0,0 +1,40 @@
+require 'blacklight'
+require 'blacklight/gallery'
+require 'blacklight_advanced_search'
+require 'blacklight/maps'
+require 'bpluser'
+require 'typhoeus'
+require 'devise'
+require 'devise-guests'
+require 'omniauth'
+require 'omniauth-ldap'
+require 'omniauth-facebook'
+require 'omniauth-polaris'
+require 'bootstrap-sass'
+require 'font-awesome-sass'
+require 'unicode'
+require 'madison'
+require 'iiif/presentation'
+
+module CommonwealthVlrEngine
+
+  class Engine < Rails::Engine
+
+    # for db migrations
+    engine_name 'commonwealth_vlr_engine'
+
+    config.to_prepare do
+      CommonwealthVlrEngine.inject!
+    end
+
+    # This makes our rake tasks visible.
+    rake_tasks do
+      Dir.chdir(File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))) do
+        Dir.glob(File.join('tasks', '*.rake')).each do |railtie|
+          load railtie
+        end
+      end
+      #load "#{config.root}/tasks/dc_public.rake"
+    end
+  end
+end

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

@@ -0,0 +1,285 @@
+module CommonwealthVlrEngine
+  module Finder
+
+    def get_files(pid)
+
+      return_hash = {}
+      return_hash[:images] = []
+      return_hash[:documents] = []
+      return_hash[:audio] = []
+      return_hash[:ereader] = []
+      return_hash[:generic] = []
+
+      solr_response = repository.search({:q => "is_file_of_ssim:\"info:fedora/#{pid}\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_doc|
+        if solr_doc['has_model_ssim'].include?('info:fedora/afmodel:Bplmodels_AudioFile')
+          return_hash[:audio] << solr_doc
+        elsif solr_doc['has_model_ssim'].include?('info:fedora/afmodel:Bplmodels_ImageFile')
+          return_hash[:images] << solr_doc
+        elsif solr_doc['has_model_ssim'].include?('info:fedora/afmodel:Bplmodels_DocumentFile')
+          return_hash[:documents] << solr_doc
+        elsif solr_doc['has_model_ssim'].include?('info:fedora/afmodel:Bplmodels_EreaderFile')
+          return_hash[:ereader] << solr_doc
+        else
+          return_hash[:generic] << solr_doc
+        end
+      end
+
+      return_hash[:images] = sort_files(return_hash[:images])
+      return_hash[:documents] = sort_files(return_hash[:documents])
+      return_hash[:audio] = sort_files(return_hash[:audio])
+      return_hash[:ereader] = sort_files(return_hash[:ereader])
+      return_hash[:generic] = sort_files(return_hash[:generic])
+
+      return return_hash
+    end
+
+
+    def sort_files(file_list)
+      return file_list if file_list.length <= 1
+
+      following_key_final = nil
+      preceding_key_final = nil
+
+      ending_item_pid = nil
+      next_item_pid = nil
+
+      return_list = []
+      file_list.each do |file|
+        preceding_key = file.keys.select { |key| key.include?'preceding'}
+        following_key = file.keys.select { |key| key.include?'following'}
+
+        if following_key.blank?
+          return_list.insert(0, file)
+          preceding_key_final = preceding_key.first
+          next_item_pid = file[preceding_key_final].first
+        elsif preceding_key.blank?
+          following_key_final = following_key.first
+          return_list.insert(-1, file)
+          ending_item_pid  = "info:fedora/#{file['id']}"
+        end
+      end
+
+      while next_item_pid != ending_item_pid
+        next_item = file_list.select { |array| "info:fedora/#{array['id'].to_s}" == next_item_pid }.first
+        return_list.insert(-2, next_item)
+        next_item_pid = next_item[preceding_key_final].first.to_s
+      end
+
+      return return_list
+    end
+
+    def get_volume_objects(pid)
+      return_list = []
+      volumes_list = []
+      solr_response = repository.search({:q => "is_volume_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_Volume\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_object|
+        volumes_list << solr_object
+      end
+      sort_files(volumes_list).each do |volume|
+        volume_files = get_files(volume.id)
+        return_list << {vol_doc: volume, vol_files: volume_files.except(:images)}
+      end
+      return_list
+    end
+
+    def get_image_files(pid)
+      return_list = []
+      solr_response = repository.search({:q => "is_image_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_ImageFile\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_object|
+        return_list << solr_object
+      end
+      return sort_files(return_list)
+    end
+
+    def get_audio_files(pid)
+      return_list = []
+      solr_response = repository.search({:q => "is_audio_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')} AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_AudioFile\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_object|
+        return_list << solr_object
+      end
+      return sort_files(return_list)
+    end
+
+    def get_document_files(pid)
+      return_list = []
+      solr_response = repository.search({:q => "is_document_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_DocumentFile\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_object|
+        return_list << solr_object
+      end
+      return sort_files(return_list)
+    end
+
+    def get_ereader_files(pid)
+      return_list = []
+      solr_response = repository.search({:q => "is_ereader_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_EreaderFile\"", :rows => 1000})
+
+      solr_response.documents.each do |solr_object|
+        return_list << solr_object
+      end
+      return sort_files(return_list)
+    end
+
+    def get_first_volume_object(pid)
+      return_list = []
+      solr_response = repository.search({:q => "-is_following_volume_of_ssim:* AND is_volume_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_Volume\""})
+
+      solr_response.documents.each do |solr_object|
+        return_list << solr_object
+      end
+      return sort_files(return_list)
+    end
+
+    def get_first_image_file(pid)
+      solr_response = repository.search({:q => "-is_following_image_of_ssim:* AND is_image_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_ImageFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_first_audio_file(pid)
+      solr_response = repository.search({:q => "-is_following_audio_of_ssim:* AND is_audio_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_AudioFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_first_document_file(pid)
+      solr_response = repository.search({:q => "-is_following_document_of_ssim:* AND is_document_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_DocumentFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_first_ereader_file(pid)
+      solr_response = repository.search({:q => "-is_following_ereader_of_ssim:* AND is_document_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_EreaderFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_next_volume_object(pid)
+      solr_response = repository.search({:q => "is_following_volume_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_Volume\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_next_image_file(pid)
+      solr_response = repository.search({:q => "is_following_image_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_ImageFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_next_audio_file(pid)
+      solr_response = repository.search({:q => "is_following_audio_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_AudioFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_next_document_file(pid)
+      solr_response = repository.search({:q => "is_following_document_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_DocumentFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_next_ereader_file(pid)
+      solr_response = repository.search({:q => "is_following_ereader_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_EreaderFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_prev_volume_object(pid)
+      solr_response = repository.search({:q => "is_preceding_volume_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_Volume\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_prev_image_file(pid)
+      solr_response = repository.search({:q => "is_preceding_image_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_ImageFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_prev_audio_file(pid)
+      solr_response = repository.search({:q => "is_preceding_audio_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_AudioFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_prev_document_file(pid)
+      solr_response = repository.search({:q => "is_preceding_document_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_DocumentFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_prev_ereader_file(pid)
+      solr_response = repository.search({:q => "is_preceding_ereader_of_ssim:\"info\:fedora/#{pid.gsub(':', '\:')}\" AND has_model_ssim:\"info\:fedora/afmodel:Bplmodels_EreaderFile\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object
+      end
+      return nil
+    end
+
+    def get_volume_parent_object(volume_pid)
+      solr_response = repository.search({:q => "id:\"#{volume_pid}\" AND has_model_ssim:\"info:fedora/afmodel:Bplmodels_Volume\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object['is_volume_of_ssim'].first.split('/')[1]
+      end
+
+      return nil
+    end
+
+    def get_file_parent_object(file_pid)
+      solr_response = repository.search({:q => "id:\"#{file_pid}\" AND has_model_ssim:\"info:fedora/afmodel:Bplmodels_File\""})
+
+      solr_response.documents.each do |solr_object|
+        return solr_object['is_file_of_ssim'].first.split('/')[1]
+      end
+
+      return nil
+    end
+
+  end
+end

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

@@ -0,0 +1,189 @@
+# methods used to create IIIF Presentation API manifest
+module CommonwealthVlrEngine
+  module IiifManifest
+    extend ActiveSupport::Concern
+
+    include IIIF::Presentation
+
+    # create an IIIF manifest
+    # document = SolrDocument
+    # image_files = an array of ImageFile Solr documents
+    def create_iiif_manifest(document, image_files)
+      manifest = IIIF::Presentation::Manifest.new('@id' => "#{document[:identifier_uri_ss]}/manifest")
+      manifest.label = render_main_title(document)
+      manifest.viewing_hint = image_files.length > 1 ? 'paged' : 'individuals'
+      manifest.metadata = manifest_metadata(document)
+      manifest.description = document[:abstract_tsim].first if document[:abstract_tsim]
+
+      manifest.attribution = manifest_attribution(document).presence
+
+      if document[:license_ssm]
+        document[:license_ssm].each do |license|
+          if license.match(/\(CC\s/)
+            manifest.license = cc_url(license)
+          end
+        end
+      end
+
+      manifest.see_also = document[:identifier_uri_ss] if document[:identifier_uri_ss]
+
+      sequence = IIIF::Presentation::Sequence.new
+      image_files.each_with_index do |image, index|
+        sequence.canvases << canvas_from_id(image.id, label_for_canvas(image, index), document)
+      end
+      manifest.sequences << sequence
+
+      manifest_thumb_svc = manifest.sequences.first.canvases.first.images.first.resource.service
+      manifest_thumb_svc['@id'] = manifest_thumb_svc['@id'].gsub(/[\-:\w]+\z/,document[:exemplary_image_ssi]) if document[:exemplary_image_ssi]
+      manifest.insert_after(existing_key: 'label',
+                            new_key: 'thumbnail',
+                            value: {'@id' => "#{document[:identifier_uri_ss]}/thumbnail",
+                                    'service' => manifest_thumb_svc})
+
+      manifest
+    end
+
+    # create an IIIF canvas
+    # image_id = id of image object
+    # label = the label property of the canvas
+    # document = Solr doc of parent object
+    def canvas_from_id(image_id, label, document)
+      image_id_suffix = image_id.gsub(/\A[\w-]+:/,'/')
+      annotation = image_annotation_from_image_id(image_id, document)
+      canvas = IIIF::Presentation::Canvas.new('@id' => "#{document[:identifier_uri_ss]}/canvas#{image_id_suffix}")
+      canvas.label = label
+      canvas.thumbnail = document[:identifier_uri_ss].gsub(/\/[\w]+\z/, image_id_suffix) + "/thumbnail"
+      canvas.width = annotation.resource['width']
+      canvas.height = annotation.resource['height']
+      canvas.images << annotation
+      canvas
+    end
+
+    # create an IIIF Annotation
+    # image_id = id of image object
+    # document = Solr doc of parent object
+    def image_annotation_from_image_id(image_id, document)
+      image_id_suffix = image_id.gsub(/\A[\w-]+:/,'/')
+      annotation = IIIF::Presentation::Annotation.new('@id' => "#{document[:identifier_uri_ss]}/annotation#{image_id_suffix}")
+      annotation.resource = image_resource_from_image_id(image_id, document)
+      annotation['on'] = "#{document[:identifier_uri_ss]}/canvas#{image_id_suffix}"
+      annotation
+    end
+
+    # return an IIIF image resource
+    # page_id = id of image object
+    # document = SolrDocument of parent object
+    def image_resource_from_image_id(page_id, document)
+      base_uri = "#{IIIF_SERVER['url']}#{page_id}"
+      params = {service_id: base_uri,
+                resource_id: document[:identifier_uri_ss].gsub(/\/[\w]+\z/, page_id.gsub(/\A[\w-]+:/,'/')) + "/large_image"}
+      image_resource = IIIF::Presentation::ImageResource.create_image_api_image_resource(params)
+      image_resource
+    end
+
+    # return an IIIF Collection resource (for multi-part works)
+    # document = SolrDocument of series object
+    # manifest_docs = Array of SolrDocument of volume-level objects
+    def collection_for_manifests(document, manifest_docs)
+      collection = IIIF::Presentation::Collection.new('@id' => document[:identifier_uri_ss].gsub(/\/[\w]+\z/,"/collection\\0"))
+      collection.label = 'Multi-part work description'
+      collection.viewing_hint = 'multi-part'
+      collection.attribution = manifest_attribution(document).presence
+      collection.metadata = manifest_metadata(document)
+      collection.description = 'This document describes an IIIF Collection, which points to a series of IIIF Manifests comprising the individual items in this multi-volume work'
+      if document[:license_ssm]
+        document[:license_ssm].each do |license|
+          if license.match(/\(CC\s/)
+            collection.license = cc_url(license)
+          end
+        end
+      end
+      collection.thumbnail = "#{document[:identifier_uri_ss]}/thumbnail" if document[:exemplary_image_ssi]
+      manifest_docs.each do |manifest_doc|
+        manifest_id = document[:identifier_uri_ss].gsub(/\/[\w]+\z/, manifest_doc[:vol_doc].id.gsub(/\A[\w-]+:/,'/')) + "/manifest"
+        collection.manifests << {'@id' => manifest_id,
+                                 '@type' => 'sc:Manifest',
+                                 'label' => render_main_title(manifest_doc[:vol_doc])}
+      end
+      collection
+    end
+
+    # returns a basic Dublin Core-esque metadata set array
+    # document = SolrDocument
+    def manifest_metadata(document)
+      manifest_metadata = []
+      manifest_metadata << {label: t('blacklight.metadata_display.fields.title'), value: render_full_title(document)}
+      manifest_metadata << {label: t('blacklight.metadata_display.fields.date'), value: render_mods_dates(document).first} if document[:date_start_tsim]
+
+      if document[:name_personal_tsim] || document[:name_corporate_tsim] || document[:name_generic_tsim]
+        names = setup_names_roles(document).first
+        manifest_metadata << {label: t('blacklight.metadata_display.fields.creator'), value: names.length == 1 ? names.first : names}
+      end
+
+      if document[:publisher_tsim]
+        pubplace = document[:pubplace_tsim] ? document[:pubplace_tsim].first + ' : ' : ''
+        manifest_metadata << {label: t('blacklight.metadata_display.fields.publisher'), value: pubplace + document[:publisher_tsim].first}
+      end
+
+      some_fields = {
+          :type_of_resource_ssim => t('blacklight.metadata_display.fields.type_of_resource'),
+          :genre_basic_ssim => t('blacklight.metadata_display.fields.genre_basic'),
+          :abstract_tsim => t('blacklight.metadata_display.fields.abstract'),
+          :lang_term_ssim => t('blacklight.metadata_display.fields.language'),
+          :subject_facet_ssim => t('blacklight.metadata_display.fields.subject_topic'),
+          :physical_location_ssim => t('blacklight.metadata_display.fields.location'),
+          :related_item_host_ssim => t('blacklight.metadata_display.fields.collection')
+      }
+      some_fields.each do |k,v|
+        values = document[k]
+        manifest_metadata << {label: v, value: values.length == 1 ? values.first : values} if values
+      end
+
+      if document[:identifier_uri_ss]
+        identifiers = [document[:identifier_uri_ss]]
+        [:identifier_local_other_tsim, :identifier_local_call_tsim, :identifier_local_barcode_tsim, :identifier_isbn_tsim, :local_accession_id_tsim].each do |k|
+          identifiers = identifiers + document[k] if document[k]
+        end
+        manifest_metadata << {label: t('blacklight.metadata_display.fields.id_local_other'), value: identifiers.length == 1 ? identifiers.first : identifiers}
+      end
+
+      if document[:rights_ssm]
+        rights = document[:rights_ssm] + document[:license_ssm].presence.to_a
+        manifest_metadata << {label: t('blacklight.metadata_display.fields.rights'), value: rights}
+      end
+
+      manifest_metadata
+    end
+
+    # returns the appropriate attribution statement
+    def manifest_attribution(document)
+      attribution_array = []
+      [:rights_ssm, :license_ssm, :restrictions_on_access_ssm].each do |field|
+        attribution_array = attribution_array + document[field].presence.to_a
+      end
+      attribution_array.blank? ? nil : attribution_array.join(' ')
+    end
+
+    # returns the appropriate label for the page/file
+    # image_doc = ImageFile Solr document
+    # index = the index of the page in the image_files array
+    def label_for_canvas(image_doc, index)
+      page_type = image_doc[:page_type_ssi]
+      if page_type && page_type != 'Normal'
+        case page_type
+          when 'Title'
+            'Title page'
+          when 'Contents'
+            'Table of Contents'
+          else
+            page_type
+        end
+      elsif image_doc[:page_num_label_ssi]
+        "page #{image_doc[:page_num_label_ssi]}"
+      else
+        "image #{(index+1).to_s}"
+      end
+    end
+
+  end
+end