Module: Dor::Releaseable

Extended by:
ActiveSupport::Concern
Includes:
Itemizable
Included in:
BasicItem
Defined in:
lib/dor/models/releaseable.rb

Constant Summary

Constants included from Itemizable

Itemizable::DIFF_FILENAME, Itemizable::DIFF_QUERY

Instance Method Summary collapse

Methods included from Itemizable

#clear_diff_cache, #get_content_diff

Instance Method Details

#add_release_node(release, attrs = {}) ⇒ Nokogiri::XML::Element

Add a release node for the item Will use the current time to add in the timestamp if you do not supply a timestamp, you can supply a timestap for correcting history, etc if desired

Examples:

item.add_tag(true,:release,{:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket'})

Raises:

  • (RuntimeError) —

    Raised if attributes are improperly supplied



265
266
267
268
269
270
271
 
# File 'lib/dor/models/releaseable.rb', line 265

def add_release_node(release, attrs={})
  identity_metadata_ds = self.identityMetadata
  attrs[:when] = Time.now.utc.iso8601 if attrs[:when] == nil#add the timestamp
  valid_release_attributes(release, attrs)
  
  return identity_metadata_ds.add_value(:release, release.to_s, attrs)
end

#add_tags_from_purl(new_tags) ⇒ Object

This function calls purl and gets a list of all release tags currently in purl. It then compares to the list you have generated. Any tag that is on purl, but not in the newly generated list is added to the new list with a value of false.

params new_tags [Hash] a hash of all new tags in the form of => Boolean, where Project is a string

return [Hash], a hash in the same form as new_tags, with all missing tags not in new_tags, but in current_tag_names, added in with a Boolean value of false



384
385
386
387
388
389
390
391
 
# File 'lib/dor/models/releaseable.rb', line 384

def add_tags_from_purl(new_tags) 
  tags_currently_in_purl = self.get_release_tags_from_purl
  missing_tags = tags_currently_in_purl.map(&:downcase) - new_tags.keys.map(&:downcase) 
  missing_tags.each do |missing_tag|
    new_tags[missing_tag.capitalize] = false
  end
  return new_tags
end

#clean_release_tag_for_purl(tag) ⇒ Hash

Take a tag and return only the attributes we want to put into purl



134
135
136
137
138
139
140
141
 
# File 'lib/dor/models/releaseable.rb', line 134

def clean_release_tag_for_purl(tag)
  for_purl = ['release']
  return_hash = {}
  for_purl.each do |attr|
    return_hash[attr] = tag[attr]
  end
  return return_hash
end

#combine_two_release_tag_hashes(hash_one, hash_two) ⇒ Hash

Take two hashes of tags and combine them, will not overwrite but will enforce uniqueness of the tags



92
93
94
95
96
97
98
 
# File 'lib/dor/models/releaseable.rb', line 92

def combine_two_release_tag_hashes(hash_one, hash_two)
  hash_two.keys.each do |key|
    hash_one[key] = hash_two[key] if hash_one[key] == nil
    hash_one[key] = (hash_one[key] + hash_two[key]).uniq if hash_one[key] != nil
  end
  return hash_one
end

#does_release_tag_apply(release_tag, admin_tags = false) ⇒ Boolean

Takes a tag and returns true or false if it applies to the specific item



162
163
164
165
166
167
168
 
# File 'lib/dor/models/releaseable.rb', line 162

def does_release_tag_apply(release_tag, admin_tags=false)
  #Is the tag global or restricted 
  return true if release_tag['tag'] == nil  #there is no specific tag specificied, so that means this tag is global to all members of the collection, it applies, return true
    
  admin_tags = self.tags if ! admin_tags #We use false instead of [], since an item can have no admin_tags that which point we'd be passing down this variable as [] and would not an attempt to retrieve it
  return admin_tags.include?(release_tag['tag'])
end

#form_purl_url ⇒ Object

Take the and create the entire purl url that will usable for the open method in open-uri, returns http

params druid [String], the druid without or without the driud prefix

return [String], the full url



350
351
352
353
 
# File 'lib/dor/models/releaseable.rb', line 350

def form_purl_url
  prefix = "http://" 
  return prefix + Dor::Config.stacks.document_cache_host + "/#{self.remove_druid_prefix}.xml"
end

#generate_release_xml ⇒ String

Generate XML structure for inclusion to Purl



12
13
14
15
16
17
18
19
20
21
 
# File 'lib/dor/models/releaseable.rb', line 12

def generate_release_xml
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.ReleaseData {
      self.released_for.each do |project,released_value|
        xml.release(released_value["release"],:to=>project)
      end  
      }        
    end
  return builder.to_xml
end

#get_newest_release_tag(tags) ⇒ Hash

Take a hash of tags as obtained via Dor::Item.release_tags and returns the newest tag for each namespace



120
121
122
123
124
125
126
127
 
# File 'lib/dor/models/releaseable.rb', line 120

def get_newest_release_tag(tags)
  return_hash = {}
  tags.keys.each do |key|
    latest_for_key = newest_release_tag_in_an_array(tags[key])
    return_hash[key] = latest_for_key         
  end
  return return_hash
end

#get_release_tags_for_item_and_all_governing_sets ⇒ Hash

Take an item and get all of its release tags and all tags on collections it is a member of it



78
79
80
81
82
83
84
 
# File 'lib/dor/models/releaseable.rb', line 78

def get_release_tags_for_item_and_all_governing_sets
  return_tags = self.release_nodes || {}
  self.collections.each do |collection|
    return_tags = combine_two_release_tag_hashes(return_tags, Dor::Item.find(collection.id).get_release_tags_for_item_and_all_governing_sets) #this will function recurvisely so parents of parents are found
  end
  return return_tags  
end

#get_release_tags_from_purl ⇒ Array

Pull all release nodes from the public xml obtained via the purl query



373
374
375
376
 
# File 'lib/dor/models/releaseable.rb', line 373

def get_release_tags_from_purl
  xml = self.get_xml_from_purl
  return self.get_release_tags_from_purl_xml(xml)
end

#get_release_tags_from_purl_xml(doc) ⇒ Array

Pull all release nodes from the public xml obtained via the purl query



360
361
362
363
364
365
366
367
368
 
# File 'lib/dor/models/releaseable.rb', line 360

def get_release_tags_from_purl_xml(doc)
  nodes = doc.xpath("//html/body/publicobject/releasedata").children 
  #We only want the nodes with a name that isn't text
  return_array = []
  nodes.each do |n|
    return_array << n.attr('to') if n.name != nil and n.name.downcase != "text"
  end
  return return_array.uniq 
end

#get_self_release_tags(tags) ⇒ Hash

Take a hash of tags as obtained via Dor::Item.release_tags and returns all self tags



70
71
72
 
# File 'lib/dor/models/releaseable.rb', line 70

def get_self_release_tags(tags)
  return get_tags_for_what_value(tags, 'self')
end

#get_tags_for_what_value(tags, what_target) ⇒ Hash

Take a hash of tags and return all tags with the matching what target



106
107
108
109
110
111
112
113
 
# File 'lib/dor/models/releaseable.rb', line 106

def get_tags_for_what_value(tags, what_target)
  return_hash = {}
  tags.keys.each do |key|
    self_tags =  tags[key].select{|tag| tag['what'] == what_target.downcase}
    return_hash[key] = self_tags if self_tags.size > 0
  end
  return return_hash
end

#get_xml_from_purl ⇒ Nokogiri::HTML::Document

Get a list of all release nodes found in a purl document

Fetches purl xml for a druid



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/dor/models/releaseable.rb', line 322

def get_xml_from_purl
    handler = Proc.new do |exception, attempt_number, total_delay|
      #We assume a 404 means the document has never been published before and thus has no purl
      #The strip is needed before the actual message is "404 "
      return Nokogiri::HTML::Document.new if exception.message.strip == "404"
    end

    with_retries(:max_retries => 5, :base_sleep_seconds => 3, :max_sleep_seconds=> 5, :rescue => OpenURI::HTTPError, :handler => handler) {
       #If you change the method used for opening the webpage, you can change the :rescue param to handle the new method's errors
       return Nokogiri::HTML(open(self.form_purl_url))
     }
   
end

#latest_applicable_release_tag_in_array(release_tags, admin_tags) ⇒ Hash

Takes an array of release tags and returns the most recent one that applies to this item

param admin_tags [Array] the administrative tags on an on item



176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/dor/models/releaseable.rb', line 176

def latest_applicable_release_tag_in_array(release_tags, admin_tags)
  newest_tag = newest_release_tag_in_an_array(release_tags)
  return newest_tag if does_release_tag_apply(newest_tag, admin_tags) #Return true if we have it
  
  #The latest tag wasn't applicable, slice it off and try again
  #This could be optimized by reordering on the timestamp and just running down it instead of constantly resorting, at least if we end up getting numerous release tags on an item
  release_tags.slice!(release_tags.index(newest_tag))
  
  return latest_applicable_release_tag_in_array(release_tags, admin_tags) if release_tags.size > 0 #Try again after dropping the one that wasn't applicable 
  
  return nil #We're out of tags, no applicable ones
end

#newest_release_tag_in_an_array(array_of_tags) ⇒ Hash

Takes an array of release tags and returns the most recent one



148
149
150
151
152
153
154
 
# File 'lib/dor/models/releaseable.rb', line 148

def newest_release_tag_in_an_array(array_of_tags)
  latest_tag_in_array = array_of_tags[0] || {}
  array_of_tags.each do |tag|
    latest_tag_in_array = tag if tag['when'] > latest_tag_in_array['when']
  end
  return latest_tag_in_array
end

#release_nodes ⇒ Nokogiri::XML::NodeSet

helper method to get the release nodes as a nodeset



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/dor/models/releaseable.rb', line 299

def release_nodes
  release_tags = self.identityMetadata.ng_xml.xpath('//release')
  return_hash = {}
  release_tags.each do |release_tag|
    hashed_node = self.release_tag_node_to_hash(release_tag)
    if return_hash[hashed_node[:to]] != nil
      return_hash[hashed_node[:to]] << hashed_node[:attrs]
    else
       return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
    end
  end
  return return_hash
end

#release_tag_node_to_hash(rtag) ⇒ Object

method to convert one release element into an array

return [Hash] in the form of => String :attrs = Hash



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/dor/models/releaseable.rb', line 211

def release_tag_node_to_hash(rtag)
  to = 'to'
  release = 'release'
  when_word = 'when' #TODO: Make to and when_word load from some config file instead of hardcoded here
  attrs = rtag.attributes
  return_hash = { :to => attrs[to].value }
  attrs.tap { |a| a.delete(to)}
  attrs[release] = rtag.text.downcase == "true" #save release as a boolean
  return_hash[:attrs] = attrs

  #convert all the attrs beside :to to strings, they are currently Nokogiri::XML::Attr
  (return_hash[:attrs].keys-[to]).each do |a|
    return_hash[:attrs][a] =  return_hash[:attrs][a].to_s if a != release
  end

  return_hash[:attrs][when_word] = Time.parse(return_hash[:attrs][when_word]) #convert when to a datetime

  return return_hash
end

#release_tags ⇒ Nokogiri::XML::NodeSet

helper method to get the release tags as a nodeset



192
193
194
195
196
197
198
199
200
201
202
203
204
 
# File 'lib/dor/models/releaseable.rb', line 192

def release_tags
  release_tags = self.identityMetadata.ng_xml.xpath('//release')
  return_hash = {}
  release_tags.each do |release_tag|
    hashed_node = self.release_tag_node_to_hash(release_tag)
    if return_hash[hashed_node[:to]] != nil
      return_hash[hashed_node[:to]] << hashed_node[:attrs]
    else
       return_hash[hashed_node[:to]] = [hashed_node[:attrs]]
    end
  end
  return return_hash
end

#released_for ⇒ Hash

Determine which projects an item is released for



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
 
# File 'lib/dor/models/releaseable.rb', line 26

def released_for
  released_hash = {}
  
  #Get release tags on the item itself 
  release_tags_on_this_item = self.release_nodes
  
  #Get any self tags on this item
  self_release_tags = self.get_self_release_tags(release_tags_on_this_item)
  
  #Get the most recent self tag for all targets and save their result since most recent self always trumps any other non self tags
  latest_self_tags = self.get_newest_release_tag(self_release_tags)
  latest_self_tags.keys.each do |target|
    released_hash[target] =  self.clean_release_tag_for_purl(latest_self_tags[target])
  end
  
  #With Self Tags Resolved We Now need to deal with tags on all sets this object is part of 
  
  potential_applicable_release_tags = {}  #This will be where we store all tags that apply, regardless of their timestamp
   
  #Get all release tags on the item and strip out the what = self ones, we've already processed all the self tags on this item 
  potential_applicable_release_tags = get_tags_for_what_value(self.get_release_tags_for_item_and_all_governing_sets, 'collection')
  
  administrative_tags = self.tags  #Get them once here and pass them down
  
  #We now have the keys for all potential releases, we need to check the tags and the most recent time stamp with an explicit true or false wins, in a nil case, the lack of an explicit false tag we do nothing
  (potential_applicable_release_tags.keys-released_hash.keys).each do |key|  #don't bother checking the ones already added to the release hash, they were added due to a self tag and that has won
    latest_applicable_tag_for_key = latest_applicable_release_tag_in_array(potential_applicable_release_tags[key], administrative_tags)
    if latest_applicable_tag_for_key != nil #We have a valid tag, record it
      released_hash[key] = self.clean_release_tag_for_purl(latest_applicable_tag_for_key) 
    end
    
  end
  
  #See what the application is currently released for on Purl.  If something is released in purl but not listed here, it needs to be added as a false
  released_hash = self.add_tags_from_purl(released_hash)
    
  return released_hash
end

#remove_druid_prefix ⇒ String

Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed



339
340
341
342
343
 
# File 'lib/dor/models/releaseable.rb', line 339

def remove_druid_prefix
  druid_prefix = "druid:"
  return self.id.split(druid_prefix)[1] if self.id.split(druid_prefix).size > 1
  return druid
end

#valid_release_attributes(tag, attrs = {}) ⇒ Boolean

Determine if the supplied tag is a valid release node that meets all requirements

Raises:

  • (ArgumentError) 


280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/dor/models/releaseable.rb', line 280

def valid_release_attributes(tag, attrs={})
  raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z') == nil
  [:who, :to, :what].each do |check_attr|
    raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
  end

  what_correct = false
  ['self', 'collection'].each do |allowed_what_value|
    what_correct = true if attrs[:what] == allowed_what_value
  end
  raise ArgumentError, ":what must be self or collection" if ! what_correct
  raise ArgumentError, "the value set for this tag is not a boolean" if !!tag != tag
  validate_tag_format(attrs[:tag]) if attrs[:tag] != nil #Will Raise exception if invalid tag
  return true
end

#valid_release_attributes_and_tag(tag, attrs = {}) ⇒ Boolean

Determine if the supplied tag is a valid release tag that meets all requirements

Raises:

  • (ArgumentError) 


238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/dor/models/releaseable.rb', line 238

def valid_release_attributes_and_tag(tag, attrs={})
  raise ArgumentError, ":when is not iso8601" if attrs[:when].match('\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}Z') == nil
  [:who, :to, :what].each do |check_attr|
    raise ArgumentError, "#{check_attr} not supplied as a String" if attrs[check_attr].class != String
  end

  what_correct = false
  ['self', 'collection'].each do |allowed_what_value|
    what_correct = true if attrs[:what] == allowed_what_value
  end
  raise ArgumentError, ":what must be self or collection" if ! what_correct
  raise ArgumentError, "the value set for this tag is not a boolean" if !!tag != tag
  validate_tag_format(attrs[:tag]) if attrs[:tag] != nil #Will Raise exception if invalid tag
  return true
end