dor-services 4.25.1 → 5.0.0

data/lib/dor/models/discoverable.rb

@@ -1,64 +0,0 @@
-module Dor
-  module Discoverable
-    extend ActiveSupport::Concern
-    #index gryphondor fields
-    require 'stanford-mods'
-    def to_solr(solr_doc = Hash.new, *args)
-      super solr_doc, *args
-
-      if descMetadata && !descMetadata.new?
-        stanford_mods_record=Stanford::Mods::Record.new
-        stanford_mods_record.from_str(descMetadata.ng_xml.to_s)
-        doc_hash = {
-          :sw_format_facet => stanford_mods_record.format,
-          # title fields
-          :sw_title_245a_search_facet_facet => stanford_mods_record.sw_short_title,
-          :sw_title_245_search_facet_facet => stanford_mods_record.sw_full_title,
-          :sw_title_variant_search_facet_facet => stanford_mods_record.sw_addl_titles,
-          :sw_title_sort_facet => stanford_mods_record.sw_sort_title,
-          :sw_title_245a_display_facet => stanford_mods_record.sw_short_title,
-          :sw_title_display_facet => stanford_mods_record.sw_full_title,
-          :sw_title_full_display_facet => stanford_mods_record.sw_full_title,
-
-          # author fields
-          :sw_author_1xx_search_facet_facet => stanford_mods_record.sw_main_author,
-          :sw_author_7xx_search_facet_facet => stanford_mods_record.sw_addl_authors,
-          :sw_author_person_facet_facet => stanford_mods_record.sw_person_authors,
-          :sw_author_other_facet_facet => stanford_mods_record.sw_impersonal_authors,
-          #:sw_author_sort_facet => stanford_mods_record.sw_sort_author,
-          :sw_author_corp_display_facet => stanford_mods_record.sw_corporate_authors,
-          :sw_author_meeting_display_facet => stanford_mods_record.sw_meeting_authors,
-          :sw_author_person_display_facet => stanford_mods_record.sw_person_authors,
-          :sw_author_person_full_display_facet => stanford_mods_record.sw_person_authors,
-
-          # subject search fields
-           :sw_topic_search_facet_facet => stanford_mods_record.topic_search,
-           :sw_geographic_search_facet_facet => stanford_mods_record.geographic_search,
-           :sw_subject_other_search_facet_facet => stanford_mods_record.subject_other_search,
-           :sw_subject_other_subvy_search_facet_facet => stanford_mods_record.subject_other_subvy_search,
-           :sw_subject_all_search_facet_facet => stanford_mods_record.subject_all_search,
-           :sw_topic_facet_facet => stanford_mods_record.topic_facet,
-           :sw_geographic_facet_facet => stanford_mods_record.geographic_facet,
-           :sw_era_facet_facet => stanford_mods_record.era_facet,
-
-          :sw_language_facet => stanford_mods_record.sw_language_facet,
-          #:sw_physical =>  stanford_mods_record.term_values([:sw_physical_description, :sw_extent]),
-          #:sw_summary_search_facet_facet => stanford_mods_record.term_values(:sw_abstract),
-          #:sw_toc_search_facet_facet => stanford_mods_record.term_values(:sw_tableOfContents),
-          #:sw_url_suppl => stanford_mods_record.term_values([:sw_related_item, :sw_location, :sw_url]),
-
-          #publish date fields
-          :sw_pub_search_facet_facet => stanford_mods_record.place,
-          :sw_pub_date_sort_facet => stanford_mods_record.pub_date_sort,
-          :sw_pub_date_group_facet_facet => stanford_mods_record.pub_date_groups(stanford_mods_record.pub_date),
-          :sw_pub_date_facet =>stanford_mods_record.pub_date_facet,
-          :sw_pub_date_display_facet => stanford_mods_record.pub_date_display,
-          :sw_all_search_facet_facet => stanford_mods_record.text
-
-        }
-        solr_doc.merge!(doc_hash) if doc_hash
-      end
-      solr_doc
-    end
-  end
-end

data/lib/dor/models/releaseable.rb

@@ -1,357 +0,0 @@
-require 'open-uri'
-require 'retries'
-
-module Dor
-  module Releaseable
-    extend ActiveSupport::Concern
-    include Itemizable
-
-    # Add release tags to an item and initialize the item release workflow
-    # @param release_tags [Hash or Array] Either a hash of a single release tag.  Each tag should be in the form of {:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :release=>true/false}
-    # @raise [ArgumentError] Raised if the tags are improperly supplied
-    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
-
-    # Generate XML structure for inclusion to Purl
-    # @return [String] The XML release node as a string, with ReleaseDigest as the root document
-    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
-
-    # Determine which projects an item is released for
-    # @param [Boolean] skip_live_purl set true to skip requesting from purl backend
-    # @return [Hash{String => Boolean}] all namespaces, keys are Project name Strings, values are Boolean
-    def released_for(skip_live_purl = false)
-      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)
-        next if 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
-
-      # 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) unless skip_live_purl
-
-      released_hash
-    end
-
-    #Take a hash of tags as obtained via Dor::Item.release_tags and returns all self tags
-    #
-    #@param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #
-    #@return [Hash] a hash of self tags for each to value
-    def get_self_release_tags(tags)
-      get_tags_for_what_value(tags, 'self')
-    end
-
-    #Take an item and get all of its release tags and all tags on collections it is a member of it
-    #
-    #
-    #@return [Hash] a hash of all tags
-    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
-
-    #Take two hashes of tags and combine them, will not overwrite but will enforce uniqueness of the tags
-    #
-    #@param hash_one [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #@param hash_two [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #
-    #@return [Hash] the combined hash with uniquiness enforced
-    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
-
-    #Take a hash of tags and return all tags with the matching what target
-    #
-    #@param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    #@param what_target [String] the target for the 'what' key, self or collection
-    #
-    #@return [Hash] a hash of self tags for each to value
-    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
-
-    # Take a hash of tags as obtained via Dor::Item.release_tags and returns the newest tag for each namespace
-    # @param tags [Hash] a hash of tags obtained via Dor::Item.release_tags or matching format
-    # @return [Hash] a hash of latest tags for each to value
-    def get_newest_release_tag(tags)
-      Hash[tags.map {|key, val| [key, newest_release_tag_in_an_array(val)]}]
-    end
-
-    # Take a tag and return only the attributes we want to put into purl
-    # @param tag [Hash] a tag
-    # @return [Hash] a hash of the attributes we want for purl
-    def clean_release_tag_for_purl(tag)
-      {'release' => tag['release']}
-    end
-
-    # Takes an array of release tags and returns the most recent one
-    # @param tags [Array] an array of hashes, with the hashes being release tags
-    # @return [Hash] the most recent tag
-    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
-
-    # Takes a tag and returns true or false if it applies to the specific item
-    # @param release_tag [Hash] the tag in a hashed form
-    # @param admin_tags [Array] the administrative tags on an item, if not supplied it will attempt to retrieve them
-    # @return [Boolean] true or false if it applies (not true or false if it is released, that is the release_tag data)
-    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
-
-    #Takes an array of release tags and returns the most recent one that applies to this item
-    #
-    #@param release_tags [Array] an array of release tags in hashed form
-    #param admin_tags [Array] the administrative tags on an on item
-    #
-    #@return [Hash] the tag
-    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
-
-    #helper method to get the release tags as a nodeset
-    #
-    #@return [Nokogiri::XML::NodeSet] of all release tags and their attributes
-    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
-
-    # Method to convert one release element into an array
-    # @param rtag [Nokogiri::XML::Element] the release tag element
-    # @return [Hash] in the form of {:to => String :attrs = Hash}
-    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
-
-    # 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
-    # @param tag [Boolean] True or false for the release node
-    # @param attrs [hash]  A hash of any attributes to be placed onto the tag
-    # Timestamp will be calculated by the function, if no displayType is passed in, it will default to file
-    # @return [Nokogiri::XML::Element] the tag added if successful
-    # @raise [ArgumentError] Raised if attributes are improperly supplied
-    # @example
-    #  item.add_tag(true,:release,{:tag=>'Fitch : Batch2',:what=>'self',:to=>'Searchworks',:who=>'petucket', :displayType='filmstrip'})
-    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
-
-    # Determine if the supplied tag is a valid release node that meets all requirements
-    # @raises [ArgumentError]  Raises an error of the first fault in the release tag
-    # @return [Boolean] Returns true if no errors found
-    # @param attrs [hash] A hash of attributes for the tag, must contain :when, a ISO 8601 timestamp and :who to identify who or what added the tag, :to,
-    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
-
-    # Helper method to get the release nodes as a nodeset
-    # @return [Nokogiri::XML::NodeSet] of all release tags and their attributes
-    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
-
-    # Get a list of all release nodes found in a purl document, fetches purl xml for a druid
-    # @param druid [String]
-    # @raises [OpenURI::HTTPError]
-    # @return [Nokogiri::HTML::Document] the parsed xml for the druid or an empty document if no purl is found
-    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
-
-    #Since purl does not use the druid: prefix but much of dor does, use this function to strip the druid: if needed
-    #
-    #@return [String] the druid sans the druid: or if there was no druid: prefix, the entire string you passed
-    def remove_druid_prefix
-      druid_prefix = "druid:"
-      return id.split(druid_prefix)[1] if id.split(druid_prefix).size > 1
-      druid
-    end
-
-    # Take the and create the entire purl url that will usable for the open method in open-uri, returns https
-    # @return [String] the full url
-    def form_purl_url
-      'https://' + Dor::Config.stacks.document_cache_host + "/#{remove_druid_prefix}.xml"
-    end
-
-    # Pull all release nodes from the public xml obtained via the purl query
-    # @param druid [Nokogiri::HTML::Document] The druid of the object you want
-    # @return [Array] An array containing all the release tags
-    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
-
-    # Pull all release nodes from the public xml obtained via the purl query
-    # @return [Array] An array containing all the release tags
-    def get_release_tags_from_purl
-      xml = get_xml_from_purl
-      get_release_tags_from_purl_xml(xml)
-    end
-
-    # 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.
-    # @param new_tags [Hash{String => Boolean}] all new tags in the form of !{"Project" => Boolean}
-    # @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
-    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
-
-    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(true).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
-  end
-end

data/lib/dor/services/indexing_service.rb

@@ -1,64 +0,0 @@
-module Dor
-  class IndexingService
-    ##
-    # Returns a Logger instance for recording info about indexing attempts
-    # @yield attempt to execute 'entry_id_block' and use the result as an extra identifier for the log
-    #   entry.  a placeholder will be used otherwise. 'request.uuid' might be useful in a Rails app.
-    def self.generate_index_logger(&entry_id_block)
-      index_logger = Logger.new(Config.indexing_svc.log, Config.indexing_svc.log_rotation_interval)
-      index_logger.formatter = proc do |severity, datetime, progname, msg|
-        date_format_str = Config.indexing_svc.log_date_format_str
-        entry_id = begin entry_id_block.call rescue '---' end
-        "[#{entry_id}] [#{datetime.utc.strftime(date_format_str)}] #{msg}\n"
-      end
-      index_logger
-    end
-
-    # memoize the loggers we create in a hash, init with a nil default logger
-    @@loggers = { default: nil }
-
-    def self.default_index_logger
-      @@loggers[:default] ||= generate_index_logger
-    end
-
-    # takes a Dor object and indexes it to solr.  doesn't commit automatically.
-    def self.reindex_object(obj)
-      solr_doc = obj.to_solr
-      Dor::SearchService.solr.add(solr_doc)
-      solr_doc
-    end
-
-    # retrieves a single Dor object by pid, indexes the object to solr, does some logging
-    # (will use a defualt logger if one is not provided).  doesn't commit automatically.
-    #
-    # WARNING/TODO:  the tests indicate that the "rescue Exception" block at the end will
-    # get skipped, and the thrown exception (e.g. SystemStackError) will not be logged.  since
-    # that's the only consequence, and the exception bubbles up as we would want anyway, it
-    # doesn't seem worth blocking refactoring.  see https://github.com/sul-dlss/dor-services/issues/156
-    # extra logging in this case would be nice, but centralized indexing that's otherwise
-    # fully functional is nicer.
-    def self.reindex_pid(pid, index_logger = nil, should_raise_errors = true)
-      index_logger ||= default_index_logger
-      obj = Dor.load_instance pid
-      solr_doc = reindex_object obj
-      index_logger.info "updated index for #{pid}"
-      solr_doc
-    rescue StandardError => se
-      if se.is_a? ActiveFedora::ObjectNotFoundError
-        index_logger.warn "failed to update index for #{pid}, object not found in Fedora"
-      else
-        index_logger.warn "failed to update index for #{pid}, unexpected StandardError, see main app log: #{se.backtrace}"
-      end
-      raise se if should_raise_errors
-    rescue Exception => ex
-      index_logger.error "failed to update index for #{pid}, unexpected Exception, see main app log: #{ex.backtrace}"
-      raise ex # don't swallow anything worse than StandardError
-    end
-
-    # given a list of pids, retrieve those objects from fedora, index each to solr, optionally commit
-    def self.reindex_pid_list(pid_list, should_commit = false)
-      pid_list.each { |pid| reindex_pid pid, nil, false } # use the default logger, don't let individual errors nuke the rest of the batch
-      ActiveFedora.solr.conn.commit if should_commit
-    end
-  end
-end