Class: Dor::ContentMetadataDS

Inherits:
ActiveFedora::OmDatastream
  • Object
show all
Includes:
Upgradable, SolrDocHelper
Defined in:
lib/dor/datastreams/content_metadata_ds.rb

Instance Method Summary collapse

Methods included from SolrDocHelper

#add_solr_value

Methods included from Upgradable

add_upgrade_callback, included, run_upgrade_callbacks, #upgrade!

Instance Method Details

#add_file(file, resource_name) ⇒ Object 



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 74

def add_file(file, resource_name)
  xml = ng_xml
  resource_nodes = xml.search('//resource[@id=\''+resource_name+'\']')
  raise 'resource doesnt exist.' if resource_nodes.length == 0
  node = resource_nodes.first
  file_node = Nokogiri::XML::Node.new('file', xml)
  file_node['id']       = file[:name]
  file_node['shelve']   = file[:shelve  ] ? file[:shelve  ] : ''
  file_node['publish']  = file[:publish ] ? file[:publish ] : ''
  file_node['preserve'] = file[:preserve] ? file[:preserve] : ''
  node.add_child(file_node)

  [:md5, :sha1].each do |algo|
    next unless file[algo]
    checksum_node = Nokogiri::XML::Node.new('checksum', xml)
    checksum_node['type'] = algo.to_s
    checksum_node.content = file[algo]
    file_node.add_child(checksum_node)
  end
  file_node['size'    ] = file[:size     ] if file[:size]
  file_node['mimetype'] = file[:mime_type] if file[:mime_type]
  self.content = xml.to_s
  save
end

#add_resource(files, resource_name, position, type = "file") ⇒ Object 



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 166

def add_resource(files,resource_name, position,type="file") 
  xml=ng_xml
  raise "resource #{resource_name} already exists" if xml.search('//resource[@id=\'' + resource_name + '\']').length > 0

  max=-1
  xml.search('//resource').each do |node|
    max = node['sequence'].to_i if node['sequence'].to_i > max
  end
  #renumber all of the resources that will come after the newly added one
  while max > position do
    node = xml.search('//resource[@sequence=\'' + position + '\']')
    if node.length > 0
      node = node.first
      node[sequence] = max + 1
    end
    max -= 1
  end

  node = Nokogiri::XML::Node.new('resource',xml)
  node['sequence'] = position.to_s
  node['id'] = resource_name
  node['type'] = type
  files.each do |file|
    file_node = Nokogiri::XML::Node.new('file', xml)
    file_node['shelve'  ] = file[:shelve  ] ? file[:shelve  ] : ''
    file_node['publish' ] = file[:publish ] ? file[:publish ] : ''
    file_node['preserve'] = file[:preserve] ? file[:preserve] : ''
    file_node['id'      ] = file[:name]
    node.add_child(file_node)
    [:md5, :sha1].each do |algo|
      next unless file[algo]
      checksum_node = Nokogiri::XML::Node.new('checksum', xml)
      checksum_node['type'] = algo.to_s
      checksum_node.content = file[algo]
      file_node.add_child(checksum_node)
    end
    file_node['size'] = file[:size] if file[:size]
  end
  xml.search('//contentMetadata').first.add_child(node)
  self.content = xml.to_s
  save
end

#add_virtual_resource(child_druid, child_resource) ⇒ Nokogiri::XML::Element

Copies the child’s resource into the parent (self) as a virtual resource. Assumes the resource isn’t a duplicate of an existing virtual or real resource.

Parameters:

  • child_druid (String) —

    druid

  • child_resource (Nokogiri::XML::Element)

Returns:

  • (Nokogiri::XML::Element) —

    the new resource that was added to the contentMetadata



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 145

def add_virtual_resource(child_druid, child_resource)
  fail ArgumentError, 'Parent must have existing contentMetadata' if self.ng_xml.nil? || self.ng_xml.root.nil?

  # create a virtual resource element with attributes linked to the child and omit label
  sequence_max = self.ng_xml.search('//resource').map{ |node| node[:sequence].to_i }.max || 0
  resource = Nokogiri::XML::Element.new('resource', self.ng_xml)
  resource[:sequence] = sequence_max + 1
  resource[:id] = "#{self.pid.gsub(/^druid:/, '')}_#{resource[:sequence]}"
  resource[:type] = child_resource[:type]
        
  # iterate over all the published files and link to them
  child_resource.search('file[@publish=\'yes\']').each do |file|
    resource << generate_external_file_node(child_druid, child_resource[:id], file[:id], file[:mimetype])
  end
  resource << generate_also_available_as_node(child_druid)
  
  # save the virtual resource as a sibling and return
  self.content = (self.ng_xml.root << resource).to_xml
  resource
end

#generate_also_available_as_node(objectId) ⇒ Nokogiri::XML::Element

Generates the XML tree for virtual resource relationship reference. For example,

<relationship type="alsoAvailableAs" objectId="druid:mn123pq4567" />

Parameters:

  • objectId (String) —

    the linked druid

Returns:

  • (Nokogiri::XML::Element) 


129
130
131
132
133
134
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 129

def generate_also_available_as_node(objectId)
  relationship = ng_xml.create_element 'relationship'
  relationship[:type] = 'alsoAvailableAs'
  relationship[:objectId] = objectId
  relationship
end

#generate_external_file_node(objectId, resourceId, fileId, mimetype) ⇒ Nokogiri::XML::Element

Generates the XML tree for externalFile references. For example,

<externalFile objectId="druid:mn123pq4567" resourceId="Image01" fileId="image_01.jp2000" mimetype="image/jp2" />

Parameters:

  • objectId (String) —

    the linked druid

  • resourceId (String) —

    the linked druid’s resource identifier

  • fileId (String) —

    the linked druid’s resource’s file identifier

  • mimetype (String) —

    the file’s MIME type

Returns:

  • (Nokogiri::XML::Element) 


111
112
113
114
115
116
117
118
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 111

def generate_external_file_node(objectId, resourceId, fileId, mimetype)
  externalFile = ng_xml.create_element 'externalFile'
  externalFile[:objectId] = objectId
  externalFile[:resourceId] = resourceId
  externalFile[:fileId] = fileId
  externalFile[:mimetype] = mimetype
  externalFile
end

#move_resource(resource_name, new_position) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 351

def move_resource resource_name, new_position
  xml = ng_xml
  file_node = xml.search('//resource[@id=\''+resource_name+'\']')
  raise 'Resource not found or duplicate found.' unless file_node.length == 1
  position = file_node.first['sequence'].to_i
  # is the resource being moved earlier in the sequence or later?
  new_position = new_position.to_i
  if new_position > position
    counter = position
    while true
      break if counter == position
      item = xml.search('/resource[@id=\'' + counter.to_s + '\']').first
      counter += 1
      item['sequence'] = counter.to_s
    end
  else
    counter = position
    while true
      break if counter == new_position
      item = xml.search('/resource[@id=\'' + counter.to_s + '\']').first
      counter -= 1
      item['sequence'] = counter.to_s
    end
  end
end

#public_xml ⇒ Object 



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
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 36

def public_xml
  result = ng_xml.clone
  
  # remove any resources or attributes that are not destined for the public XML
  result.xpath('/contentMetadata/resource[not(file[(@deliver="yes" or @publish="yes")]|externalFile)]').each { |n| n.remove }
  result.xpath('/contentMetadata/resource/file[not(@deliver="yes" or @publish="yes")]'                ).each { |n| n.remove }
  result.xpath('/contentMetadata/resource/file').xpath('@preserve|@shelve|@publish|@deliver'          ).each { |n| n.remove }
  result.xpath('/contentMetadata/resource/file/checksum'                                              ).each { |n| n.remove }
  
  # support for dereferencing links via externalFile element(s) to the source (child) item - see JUMBO-19
  result.xpath('/contentMetadata/resource/externalFile').each do |externalFile|
    # enforce pre-conditions that resourceId, objectId, fileId are required
    src_resource_id = externalFile['resourceId']
    src_druid = externalFile['objectId']
    src_file_id = externalFile['fileId']
    fail ArgumentError, "Malformed externalFile data: #{externalFile.inspect}" if [src_resource_id, src_file_id, src_druid].map(&:blank?).any?

    # grab source item
    src_item = Dor::Item.find(src_druid)

    # locate and extract the resourceId/fileId elements
    doc = src_item.datastreams['contentMetadata'].ng_xml
    src_resource = doc.at_xpath("//resource[@id=\"#{src_resource_id}\"]")
    src_file = src_resource.at_xpath("file[@id=\"#{src_file_id}\"]")
    src_image_data = src_file.at_xpath('imageData')

    # always use title regardless of whether a child label is present
    src_label = doc.create_element('label')
    src_label.content = src_item.datastreams['DC'].title.first

    # add the extracted label and imageData
    externalFile.add_previous_sibling(src_label)
    externalFile << src_image_data unless src_image_data.nil?
  end

  result
end

#remove_file(file_name) ⇒ Object 



227
228
229
230
231
232
233
234
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 227

def remove_file file_name
  xml = ng_xml
  xml.search('//file[@id=\'' + file_name + '\']').each do |node|
    node.remove
  end
  self.content = xml.to_s
  save
end

#remove_resource(resource_name) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 209

def remove_resource resource_name
  xml = ng_xml
  position = -1
  resources = xml.search('//resource[@id=\'' + resource_name + '\']')
  raise 'Resource is missing or duplicated!' if resources.length != 1
  position = resources.first['sequence']
  resources.first.remove
  position = position.to_i + 1
  while true
    res = xml.search('//resource[@sequence=\'' + position.to_s + '\']')
    break if res.length == 0
    res['sequence'] = position.to_s
    position += 1
  end
  self.content = xml.to_s
  save
end

#rename_file(old_name, new_name) ⇒ Object 



321
322
323
324
325
326
327
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 321

def rename_file old_name, new_name
  xml = ng_xml
  file_node = xml.search('//file[@id=\'' + old_name + '\']').first
  file_node['id'] = new_name
  self.content = xml.to_s
  save
end

#set_content_type(old_type, old_resource_type, new_type, new_resource_type) ⇒ Object

Set the content type to and the resource types for all resources

Parameters:

  • new_type (String) —

    the new content type, ex book

  • new_resource_type (String) —

    the new type for all resources, ex book



380
381
382
383
384
385
386
387
388
389
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 380

def set_content_type old_type, old_resource_type, new_type, new_resource_type
  xml = ng_xml
  xml.search('/contentMetadata[@type=\'' + old_type + '\']').each do |node|
    node['type'] = new_type
    xml.search('//resource[@type=\'' + old_resource_type + '\']').each do |resource|
      resource['type'] = new_resource_type
    end
  end
  self.content = xml.to_s
end

#to_solr(solr_doc = {}, *args) ⇒ Object

Terminology-based solrization is going to be painfully slow for large contentMetadata streams. Just select the relevant elements instead.



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 279

def to_solr(solr_doc = {}, *args)
  doc = ng_xml
  if doc.root['type']
    shelved_file_count = 0
    content_file_count = 0
    resource_type_counts = {}
    resource_count = 0
    preserved_size = 0
    first_shelved_image = nil
    add_solr_value(solr_doc, "content_type", doc.root['type'], :string, [:facetable])
    doc.xpath('contentMetadata/resource').sort { |a, b| a['sequence'].to_i <=> b['sequence'].to_i }.each do |resource|
      resource_count += 1
      if resource['type']
        if resource_type_counts[resource['type']]
          resource_type_counts[resource['type']] += 1
        else
          resource_type_counts[resource['type']] = 1
        end
      end
      resource.xpath('file').each do |file|
        content_file_count += 1
        if file['shelve'] == 'yes'
          shelved_file_count += 1
          first_shelved_image = file['id'] if first_shelved_image.nil? && file['id'].match(/jp2$/)
        end
        preserved_size += file['size'].to_i if file['preserve'] == 'yes'
      end
    end
    add_solr_value(solr_doc, 'content_file_count', content_file_count.to_s, :string, [:searchable, :displayable])
    add_solr_value(solr_doc, 'shelved_content_file_count', shelved_file_count.to_s, :string, [:searchable, :displayable])
    add_solr_value(solr_doc, 'resource_count', resource_count.to_s, :string, [:searchable, :displayable])
    add_solr_value(solr_doc, 'preserved_size', preserved_size.to_s, :string, [:searchable, :displayable])
    resource_type_counts.each do |key, count|
      add_solr_value(solr_doc, key + '_resource_count', count.to_s, :string, [:searchable, :displayable])
    end
    unless first_shelved_image.nil?
      add_solr_value(solr_doc, 'first_shelved_image', first_shelved_image, :string, [:displayable])
    end
  end
  solr_doc
end

#update_attributes(file_name, publish, shelve, preserve) ⇒ Object 



236
237
238
239
240
241
242
243
244
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 236

def update_attributes file_name, publish, shelve, preserve
  xml = ng_xml
  file_node = xml.search('//file[@id=\'' + file_name + '\']').first
  file_node['shelve'  ] = shelve
  file_node['publish' ] = publish
  file_node['preserve'] = preserve
  self.content = xml.to_s
  save
end

#update_file(file, old_file_id) ⇒ Object 



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 246

def update_file file, old_file_id
  xml = ng_xml
  file_node = xml.search('//file[@id=\'' + old_file_id + '\']').first
  file_node['id'] = file[:name]
  unless file[:md5].nil?
    checksum_node = xml.search('//file[@id=\'' + old_file_id + '\']/checksum[@type=\'md5\']').first
    if checksum_node.nil?
      checksum_node = Nokogiri::XML::Node.new('checksum', xml)
      file_node.add_child(checksum_node)
    end
    checksum_node['type'] = 'md5'
    checksum_node.content = file[:md5]
  end
  unless file[:sha1].nil?
    checksum_node = xml.search('//file[@id=\'' + old_file_id + '\']/checksum[@type=\'sha1\']').first
    if checksum_node.nil?
      checksum_node = Nokogiri::XML::Node.new('checksum', xml)
      file_node.add_child(checksum_node)
    end
    checksum_node['type'] = 'sha1'
    checksum_node.content = file[:sha1]
  end

  file_node['size'    ] = file[:size    ] if file[:size]
  file_node['shelve'  ] = file[:shelve  ] if file[:shelve]
  file_node['preserve'] = file[:preserve] if file[:preserve]
  file_node['publish' ] = file[:publish ] if file[:publish]
  self.content = xml.to_s
  save
end

#update_resource_label(resource_name, new_label) ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 329

def update_resource_label resource_name, new_label
  xml = ng_xml
  resource_node = xml.search('//resource[@id=\'' + resource_name + '\']')
  raise 'Resource not found or duplicate found.' unless resource_node.length == 1
  labels = xml.search('//resource[@id=\'' + resource_name + '\']/label')
  if labels.length == 0
    #create a label
    label_node = Nokogiri::XML::Node.new('label', xml)
    label_node.content = new_label
    resource_node.first.add_child(label_node)
  else
    labels.first.content = new_label
  end
end

#update_resource_type(resource, new_type) ⇒ Object 



344
345
346
347
348
349
 
# File 'lib/dor/datastreams/content_metadata_ds.rb', line 344

def update_resource_type resource, new_type
  xml = ng_xml
  resource_node = xml.search('//resource[@id=\'' + resource_name + '\']')
  raise 'Resource not found or duplicate found.' unless resource_node.length == 1
  resource_node.first['type'] = new_type
end