Module: Dor::Presentable

Included in:
Publishable
Defined in:
lib/dor/models/presentable.rb

Constant Summary collapse

DC_NS = 
{"dc"=>"http://purl.org/dc/elements/1.1/", "oai_dc"=>"http://www.openarchives.org/OAI/2.0/oai_dc/"}

Instance Method Summary collapse

Instance Method Details

#add_metadata(label, xpath, metadata, pub_obj_doc) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
 
# File 'lib/dor/models/presentable.rb', line 121

def add_metadata label, xpath, metadata, pub_obj_doc
  nodes = pub_obj_doc.xpath xpath, DC_NS
  nodes.each do |node|
    h = {
      'label' => label,
      'value' => node.text
    }
    metadata << h
  end
end

#build_iiif_manifest(pub_obj_doc) ⇒ Object

Bypass this method if there are no image resources in contentMetadata



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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/dor/models/presentable.rb', line 19

def build_iiif_manifest pub_obj_doc
  id = self.pid.split(':').last

  lbl_node = pub_obj_doc.at_xpath '//oai_dc:dc/dc:title', DC_NS
  if lbl_node.nil?
    lbl_node = pub_obj_doc.at_xpath('/publicObject/identityMetadata/objectLabel')
  end
  raise "Unable to build IIIF Presentation manifest:  No identityMetadata/objectLabel or dc:title" if lbl_node.nil?
  lbl = lbl_node.text

  purl_base_uri = "https://#{Dor::Config.stacks.document_cache_host}/#{id}"

  manifest_data = {
    '@id'   => "#{purl_base_uri}/iiif/manifest.json",
    'label' => lbl,
    'attribution' => 'Provided by the Stanford University Libraries',
    'seeAlso' => {
      '@id' => "#{purl_base_uri}.mods",
      'format' => 'application/mods+xml'
    }
  }
  # Use the human copyright statement for attribution if present
  if(cr = pub_obj_doc.at_xpath('/publicObject/rightsMetadata/copyright/human[@type="copyright"]'))
    manifest_data['attribution'] = cr.text
  end

  manifest = IIIF::Presentation::Manifest.new manifest_data

  # Set viewingHint to paged if this is a book
  if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]'))
    manifest.viewingHint = "paged"
  end

  metadata = []
  # make into method, pass in xpath and label
  add_metadata 'Creator', '//oai_dc:dc/dc:creator', metadata, pub_obj_doc
  add_metadata 'Contributor', '//oai_dc:dc/dc:contributor', metadata, pub_obj_doc
  add_metadata 'Publisher', '//oai_dc:dc/dc:publisher', metadata, pub_obj_doc
  add_metadata 'Date', '//oai_dc:dc/dc:date', metadata, pub_obj_doc

  # Save off the first dc:description without displayLabel
  if(desc = pub_obj_doc.at_xpath('//oai_dc:dc/dc:description[not(@displayLabel)]', DC_NS))
    manifest.description = desc.text
  end

  manifest.metadata = metadata unless metadata.empty?

  seq_data = {
    '@id' => "#{purl_base_uri}/sequence-1",
    'label' => 'Current order'
  }
  sequence = IIIF::Presentation::Sequence.new seq_data

  # for each resource image, create a canvas
  count = 0
  pub_obj_doc.xpath('/publicObject/contentMetadata/resource[@type="image" or @type="page"]').each do |res_node|
    count += 1
    img_file_name = res_node.at_xpath('file/@id').text.split('.').first
    height = res_node.at_xpath('file/imageData/@height').text.to_i
    width = res_node.at_xpath('file/imageData/@width').text.to_i
    stacks_uri = "#{Dor::Config.stacks.url}/image/iiif/#{id}%2F#{img_file_name}"

    canv = IIIF::Presentation::Canvas.new
    canv['@id'] = "#{purl_base_uri}/canvas/canvas-#{count}"
    canv.label = res_node.at_xpath('label').text
    canv.height = height
    canv.width = width

    anno = IIIF::Presentation::Annotation.new
    anno['@id'] = "#{purl_base_uri}/imageanno/anno-#{count}"
    anno['on'] = canv['@id']

    img_res = IIIF::Presentation::ImageResource.new
    img_res['@id'] = "#{stacks_uri}/full/full/0/default.jpg"
    img_res.format = 'image/jpeg'
    img_res.height = height
    img_res.width = width

    svc = IIIF::Service.new ({
      '@context' => 'http://iiif.io/api/image/2/context.json',
      '@id' => stacks_uri,
      'profile' => Dor::Config.stacks.iiif_profile
    })

    # Use the first image to create a thumbnail on the manifest
    if count == 1
      thumb = IIIF::Presentation::Resource.new
      thumb['@id'] = "#{stacks_uri}/full/400,/0/default.jpg"
      thumb.service = svc
      manifest.thumbnail = thumb
    end

    img_res.service = svc
    anno.resource = img_res
    canv.images << anno
    sequence.canvases << canv
  end

  manifest.sequences << sequence
  manifest.to_json(:pretty => true)
end

#iiif_presentation_manifest_needed?(pub_obj_doc) ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
11
12
13
14
15
16
 
# File 'lib/dor/models/presentable.rb', line 8

def iiif_presentation_manifest_needed? pub_obj_doc
  if(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="image"]/resource[@type="image"]'))
    return true
  elsif(pub_obj_doc.at_xpath('/publicObject/contentMetadata[@type="book"]/resource[@type="page"]'))
    return true
  else
    return false
  end
end