Module: CommonwealthVlrEngine::IiifManifest

Extended by:
ActiveSupport::Concern
Includes:
IIIF::Presentation
Included in:
IiifManifestController
Defined in:
lib/commonwealth-vlr-engine/iiif_manifest.rb

Instance Method Summary collapse

Instance Method Details

#canvas_from_id(image_id, label, document) ⇒ Object

create an IIIF canvas image_id = id of image object label = the label property of the canvas document = Solr doc of parent object



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 50

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

#collection_for_manifests(document, manifest_docs) ⇒ Object

return an IIIF Collection resource (for multi-part works) document = SolrDocument of series object manifest_docs = Array of SolrDocument of volume-level objects



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 87

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

#create_iiif_manifest(document, image_files) ⇒ Object

create an IIIF manifest document = SolrDocument image_files = an array of ImageFile Solr documents



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 11

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

#image_annotation_from_image_id(image_id, document) ⇒ Object

create an IIIF Annotation image_id = id of image object document = Solr doc of parent object



65
66
67
68
69
70
71
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 65

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

#image_resource_from_image_id(page_id, document) ⇒ Object

return an IIIF image resource page_id = id of image object document = SolrDocument of parent object



76
77
78
79
80
81
82
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 76

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

#label_for_canvas(image_doc, index) ⇒ Object

returns the appropriate label for the page/file image_doc = ImageFile Solr document index = the index of the page in the image_files array



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 170

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

#manifest_attribution(document) ⇒ Object

returns the appropriate attribution statement



159
160
161
162
163
164
165
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 159

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

#manifest_metadata(document) ⇒ Object

returns a basic Dublin Core-esque metadata set array document = SolrDocument



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/commonwealth-vlr-engine/iiif_manifest.rb', line 113

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