Module: Dor::Releaseable

Extended by:
ActiveSupport::Concern
Includes:
Itemizable
Included in:
BasicItem, Collection
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

Timestamp will be calculated by the function, if no displayType is passed in, it will default to file

Examples:

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

Returns:

  • (Nokogiri::XML::Element) —

    the tag added if successful

Raises:

  • (ArgumentError) —

    Raised if attributes are improperly supplied



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

def add_release_node(release, attrs = {})
  identity_metadata_ds = identityMetadata
  attrs[:when] = Time.now.utc.iso8601 if attrs[:when].nil? #add the timestamp
  attrs[:displayType] = 'file' if attrs[:displayType].nil? #default to file is no display type is passed
  valid_release_attributes(release, attrs)

  # Remove the old displayType and then add the one for this tag
  remove_displayTypes
  identity_metadata_ds.add_value(:displayType, attrs[:displayType], {})
  identity_metadata_ds.add_value(:release, release.to_s, attrs)
end

#add_release_nodes_and_start_releaseWF(release_tags) ⇒ Object

Add release tags to an item and initialize the item release workflow

Raises:

  • (ArgumentError) —

    Raised if the tags are improperly supplied



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/dor/models/releaseable.rb', line 16

def add_release_nodes_and_start_releaseWF(release_tags)
  release_tags = [release_tags] unless release_tags.is_a?(Array)

  # Add in each tag
  release_tags.each do |r_tag|
    add_release_node(r_tag[:release],r_tag)
  end

  # Save item to dor so the robots work with the latest data
  save
  initialize_workflow('releaseWF')
end

#add_tags_from_purl(new_tags) ⇒ Hash

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.

Parameters:

  • new_tags (Hash{String => Boolean}) —

    all new tags in the form of {“Project” => Boolean}

Returns:

  • (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



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

def add_tags_from_purl(new_tags)
  tags_currently_in_purl = 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] = {"release"=>false}
  end
  new_tags
end

#clean_release_tag_for_purl(tag) ⇒ Hash

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

Parameters:

  • tag (Hash) —

    a tag

Returns:

  • (Hash) —

    a hash of the attributes we want for purl



142
143
144
 
# File 'lib/dor/models/releaseable.rb', line 142

def clean_release_tag_for_purl(tag)
  {'release' => tag['release']}
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

Parameters:

  • hash_one (Hash) —

    a hash of tags obtained via Dor::Item.release_tags or matching format

  • hash_two (Hash) —

    a hash of tags obtained via Dor::Item.release_tags or matching format

Returns:

  • (Hash) —

    the combined hash with uniquiness enforced



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

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 unless hash_one[key].nil?
  end
  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

Parameters:

  • release_tag (Hash) —

    the tag in a hashed form

  • admin_tags (Array) (defaults to: false) —

    the administrative tags on an item, if not supplied it will attempt to retrieve them

Returns:

  • (Boolean) —

    true or false if it applies (not true or false if it is released, that is the release_tag data)



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

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

#form_purl_url ⇒ String

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

Returns:

  • (String) —

    the full url



332
333
334
 
# File 'lib/dor/models/releaseable.rb', line 332

def form_purl_url
  'https://' + Dor::Config.stacks.document_cache_host + "/#{remove_druid_prefix}.xml"
end

#generate_release_xml ⇒ String

Generate XML structure for inclusion to Purl

Returns:

  • (String) —

    The XML release node as a string, with ReleaseDigest as the root document



32
33
34
35
36
37
38
39
40
41
 
# File 'lib/dor/models/releaseable.rb', line 32

def generate_release_xml
  builder = Nokogiri::XML::Builder.new do |xml|
    xml.releaseData {
      released_for.each do |project, released_value|
        xml.release(released_value['release'], :to => project)
      end
    }
  end
  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

Returns:

  • (Hash) —

    a hash of latest tags for each to value



135
136
137
 
# File 'lib/dor/models/releaseable.rb', line 135

def get_newest_release_tag(tags)
  Hash[tags.map {|key, val| [key, newest_release_tag_in_an_array(val)]}]
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

Returns:

  • (Hash) —

    a hash of all tags



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

def get_release_tags_for_item_and_all_governing_sets
  return_tags = release_nodes || {}
  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) # recurvise so parents of parents are found
  end
  return_tags
end

#get_release_tags_from_purl ⇒ Array

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

Returns:

  • (Array) —

    An array containing all the release tags



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

def get_release_tags_from_purl
  xml = get_xml_from_purl
  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

Returns:

  • (Array) —

    An array containing all the release tags



341
342
343
344
345
 
# File 'lib/dor/models/releaseable.rb', line 341

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
  nodes.reject {|n| n.name.nil? || n.name.downcase == 'text'}.map {|n| n.attr('to')}.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

Parameters:

  • tags (Hash) —

    a hash of tags obtained via Dor::Item.release_tags or matching format

Returns:

  • (Hash) —

    a hash of self tags for each to value



85
86
87
 
# File 'lib/dor/models/releaseable.rb', line 85

def get_self_release_tags(tags)
  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

Parameters:

  • tags (Hash) —

    a hash of tags obtained via Dor::Item.release_tags or matching format

  • what_target (String) —

    the target for the ‘what’ key, self or collection

Returns:

  • (Hash) —

    a hash of self tags for each to value



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

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_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

Returns:

  • (Nokogiri::HTML::Document) —

    the parsed xml for the druid or an empty document if no purl is found



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/dor/models/releaseable.rb', line 305

def get_xml_from_purl
  url = form_purl_url
  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
    Dor.logger.warn "[Attempt #{attempt_number}] GET #{url} -- #{exception.class}: #{exception.message}; #{total_delay} seconds elapsed."
    raise exception unless exception.is_a? OpenURI::HTTPError
    return Nokogiri::HTML::Document.new if exception.io.status[0] == '404'
  end

  with_retries(:max_retries => 3, :base_sleep_seconds => 3, :max_sleep_seconds => 5, :handler => handler) do |attempt|
    # If you change the method used for opening the webpage, you can change the :rescue param to handle the new method's errors
    Dor.logger.info "[Attempt #{attempt}] GET #{url}"
    return Nokogiri::HTML(OpenURI.open_uri(url))
  end
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

Parameters:

  • release_tags (Array) —

    an array of release tags in hashed form

Returns:

  • (Hash) —

    the tag



176
177
178
179
180
181
182
183
184
185
186
 
# 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)

  # 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 inapplicable
  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

Returns:

  • (Hash) —

    the most recent tag



151
152
153
154
155
156
157
 
# File 'lib/dor/models/releaseable.rb', line 151

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
  latest_tag_in_array
end

#release_nodes ⇒ Nokogiri::XML::NodeSet

helper method to get the release nodes as a nodeset

Returns:

  • (Nokogiri::XML::NodeSet) —

    of all release tags and their attributes



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

def release_nodes
  release_tags = identityMetadata.ng_xml.xpath('//release')
  return_hash = {}
  release_tags.each do |release_tag|
    hashed_node = 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_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

Parameters:

  • rtag (Nokogiri::XML::Element) —

    the release tag element



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

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_hash
end

#release_tags ⇒ Nokogiri::XML::NodeSet

helper method to get the release tags as a nodeset

Returns:

  • (Nokogiri::XML::NodeSet) —

    of all release tags and their attributes



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

def release_tags
  release_tags = identityMetadata.ng_xml.xpath('//release')
  return_hash = {}
  release_tags.each do |release_tag|
    hashed_node = 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_hash
end

#released_for ⇒ Hash

Determine which projects an item is released for

Returns:

  • (Hash) —

    all namespaces in the form of => Boolean



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

def released_for
  released_hash = {}
  # Get release tags on the item itself
  release_tags_on_this_item = release_nodes

  # Get any self tags on this item
  self_release_tags = 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 = get_newest_release_tag(self_release_tags)
  latest_self_tags.keys.each do |target|
    released_hash[target] =  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(get_release_tags_for_item_and_all_governing_sets, 'collection')
  administrative_tags = tags  # Get them once here and pass them down

  # We now have the keys for all potential releases, we need to check the tags: the most recent timestamp 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 if already added to the release hash, they were added due to a self tag so that has won
    latest_applicable_tag_for_key = latest_applicable_release_tag_in_array(potential_applicable_release_tags[key], administrative_tags)
    unless latest_applicable_tag_for_key.nil? # We have a valid tag, record it
      released_hash[key] = 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
  add_tags_from_purl(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

Returns:

  • (String) —

    the druid sans the druid: or if there was no druid: prefix, the entire string you passed



324
325
326
327
328
 
# File 'lib/dor/models/releaseable.rb', line 324

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

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



368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/dor/models/releaseable.rb', line 368

def to_solr(solr_doc = {}, *args)
  super(solr_doc, *args)

  # TODO: sort of worried about the performance impact in bulk reindex
  # situations, since released_for recurses all parent collections.  jmartin 2015-07-14
  released_for().each { |key, val|
    add_solr_value(solr_doc, 'released_to', key, :symbol, []) if val
  }

  # TODO: need to solrize whether item is released to purl?  does released_for return that?
  # logic is: "True when there is a published lifecycle and Access Rights is anything but Dark"

  solr_doc
end

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

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

Returns:

  • (Boolean) —

    Returns true if no errors found

Raises:

  • (ArgumentError) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/dor/models/releaseable.rb', line 261

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' unless what_correct
  raise ArgumentError, 'the value set for this tag is not a boolean' if !!tag != tag
  raise ArgumentError, ':displayType must be passed in as a String' unless attrs[:displayType].class == String

  validate_tag_format(attrs[:tag]) unless attrs[:tag].nil? # Will Raise exception if invalid tag
  true
end