ddr-models 1.2.0

data/lib/ddr/events/creation_event.rb

@@ -0,0 +1,12 @@
+module Ddr
+  module Events
+    class CreationEvent < Event
+
+      include PreservationEventBehavior
+
+      self.preservation_event_type = :cre
+      self.description = "Object created in the repository"
+
+    end
+  end
+end

data/lib/ddr/events/event.rb

@@ -0,0 +1,163 @@
+module Ddr
+  module Events
+    class Event < ActiveRecord::Base
+
+      belongs_to :user, inverse_of: :events
+
+      # Event date time - for PREMIS and Solr
+      DATE_TIME_FORMAT = "%Y-%m-%dT%H:%M:%S.%LZ"
+
+      # set default ordering
+      DEFAULT_SORT_ORDER = "event_date_time ASC"
+      default_scope { order(DEFAULT_SORT_ORDER) }
+
+      # Outcomes
+      SUCCESS = "success"
+      FAILURE = "failure"
+      OUTCOMES = [SUCCESS, FAILURE]
+
+      # Validation constants
+      VALID = "VALID"
+      INVALID = "INVALID"
+
+      # For rendering "performed by" when no associated user
+      SYSTEM = "SYSTEM"
+
+      DDR_SOFTWARE = "DDR #{Ddr::Models::VERSION}"
+
+      class_attribute :description
+  
+      validates_presence_of :event_date_time, :pid
+      validates :outcome, inclusion: {in: OUTCOMES, message: "\"%{value}\" is not a valid event outcome"}
+      validate :object_exists # unless/until we have a deaccession-type of event
+ 
+      after_initialize :set_defaults
+
+      # Receive message sent by ActiveSupport::Notifications
+      def self.call(*args)
+        notification = ActiveSupport::Notifications::Event.new(*args)
+        create(notification.payload)
+      end
+
+      # Repository software version -- e.g., "Fedora Repository 3.7.0"
+      def self.repository_software
+        @@repository_software ||= ActiveFedora::Base.connection_for_pid(0).repository_profile
+                                                    .values_at(:repositoryName, :repositoryVersion)
+                                                    .join(" ")
+      end
+
+      # Scopes
+
+      def self.for_object(obj)
+        for_pid(obj.pid)
+      end
+
+      def self.for_pid(pid)
+        where(pid: pid)
+      end
+
+      # Rendering methods
+
+      def display_type
+        # Ddr::Events::UpdateEvent => "Update"
+        @display_type ||= self.class.to_s.split("::").last.sub("Event", "").titleize
+      end
+  
+      def performed_by
+        user ? user.to_s : SYSTEM
+      end
+
+      def comment_or_summary
+        comment.present? ? comment : summary
+      end
+
+      # Outcome methods
+
+      def success!
+        self.outcome = SUCCESS
+      end
+
+      def success?
+        outcome == SUCCESS
+      end
+
+      def failure!
+        self.outcome = FAILURE
+      end
+
+      def failure?
+        outcome == FAILURE
+      end
+
+      # Object getter and setter
+
+      def object
+        @object ||= ActiveFedora::Base.find(pid) if pid
+      end
+
+      def object=(obj)
+        raise ArgumentError, "Can't set to new object" if obj.new_record?
+        self.pid = obj.pid
+        @object = obj
+      end
+
+      # Override pid setter to clear cached object instance variable
+      def pid=(pid)
+        @object = nil 
+        super
+      end
+
+      # Return a date/time formatted as a string suitable for use as a PREMIS eventDateTime.
+      # Format also works for Solr.
+      # Force to UTC.
+      def event_date_time_s
+        event_date_time.utc.strftime DATE_TIME_FORMAT
+      end
+
+      # Return boolean indicator of object existence
+      def object_exists?
+        !object.nil?
+      rescue ActiveFedora::ObjectNotFoundError => e
+        false
+      end
+
+      protected
+
+      def set_defaults
+        self.attributes = defaults.reject { |attr, val| attribute_present? attr }
+      end
+
+      def defaults
+        { event_date_time: default_event_date_time,
+          summary: default_summary,
+          software: default_software,
+          outcome: default_outcome
+        }
+      end
+
+      # Validation method
+      def object_exists
+        unless object_exists?
+          errors.add(:pid, "Object \"#{pid}\" does not exist in the repository") 
+        end
+      end
+
+      def default_software
+        DDR_SOFTWARE
+      end
+
+      def default_outcome
+        SUCCESS
+      end
+
+      def default_summary
+        self.class.description
+      end
+
+      def default_event_date_time
+        Time.now.utc
+      end
+
+    end
+  end
+end

data/lib/ddr/events/fixity_check_event.rb

@@ -0,0 +1,43 @@
+module Ddr
+  module Events
+    class FixityCheckEvent < Event
+
+      include PreservationEventBehavior
+      include ReindexObjectAfterSave
+
+      self.preservation_event_type = :fix
+      self.description = "Validation of datastream checksums"
+
+      DETAIL_PREAMBLE = "Datastream checksum validation results:"
+      DETAIL_TEMPLATE = "%{dsid} ... %{validation}"
+
+      # Message sent by ActiveSupport::Notifications
+      def self.call(*args)
+        notification = ActiveSupport::Notifications::Event.new(*args)
+        result = notification.payload[:result] # FixityCheck::Result instance
+        detail = [DETAIL_PREAMBLE]
+        result.results.each do |dsid, dsProfile|
+          validation = dsProfile["dsChecksumValid"] ? VALID : INVALID
+          detail << DETAIL_TEMPLATE % {dsid: dsid, validation: validation} 
+        end
+        create(pid: result.pid,
+               event_date_time: notification.time,
+               outcome: result.success ? SUCCESS : FAILURE,
+               detail: detail.join("\n")
+               )
+      end
+
+      def to_solr
+        { Ddr::IndexFields::LAST_FIXITY_CHECK_ON => event_date_time_s,
+          Ddr::IndexFields::LAST_FIXITY_CHECK_OUTCOME => outcome }
+      end
+
+      protected
+
+      def default_software
+        self.class.repository_software
+      end
+
+    end
+  end
+end

data/lib/ddr/events/ingestion_event.rb

@@ -0,0 +1,12 @@
+module Ddr
+  module Events
+    class IngestionEvent < Event
+
+      include PreservationEventBehavior
+
+      self.preservation_event_type = :ing
+      self.description = "Object ingested into the repository"
+
+    end
+  end
+end

data/lib/ddr/events/preservation_event_behavior.rb

@@ -0,0 +1,37 @@
+module Ddr
+  module Events
+    module PreservationEventBehavior
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :preservation_event_type
+      end
+
+      def preservation_event_type
+        self.class.preservation_event_type
+      end
+
+      EVENT_ID_TYPE = "Duke Digital Repository Event ID"
+      LINKING_OBJECT_ID_TYPE = "Duke Digital Repository PID"
+
+      def as_premis
+        Ddr::Metadata::PremisEvent.new.tap do |doc|
+          doc.event_type = PreservationEventType.label_for(preservation_event_type)
+          doc.event_id_type = EVENT_ID_TYPE
+          doc.event_id_value = id
+          doc.event_detail = summary
+          doc.linking_object_id_type = LINKING_OBJECT_ID_TYPE
+          doc.linking_object_id_value = pid
+          doc.event_outcome = outcome
+          doc.event_outcome_detail_note = detail
+          doc.event_date_time = event_date_time_s
+        end
+      end
+
+      def to_xml
+        as_premis.to_xml
+      end
+
+    end
+  end
+end

data/lib/ddr/events/preservation_event_type.rb

@@ -0,0 +1,24 @@
+require 'rdf'
+
+module Ddr
+  module Events
+    class PreservationEventType < RDF::StrictVocabulary("http://id.loc.gov/vocabulary/preservation/eventType/")
+      property :cap, label: "capture"
+      property :com, label: "compression"
+      property :cre, label: "creation"
+      property :dea, label: "deaccession"
+      property :dec, label: "decompression"
+      property :der, label: "decryption"
+      property :del, label: "deletion"
+      property :dig, label: "digital signature validation"
+      property :fix, label: "fixity check"
+      property :ing, label: "ingestion"
+      property :mes, label: "message digest calculation"
+      property :mig, label: "migration"
+      property :nor, label: "normalization"
+      property :rep, label: "replication"
+      property :val, label: "validation"
+      property :vir, label: "virus check"
+    end
+  end
+end

data/lib/ddr/events/reindex_object_after_save.rb

@@ -0,0 +1,18 @@
+module Ddr
+  module Events
+    module ReindexObjectAfterSave
+      extend ActiveSupport::Concern
+
+      included do
+        after_save :reindex_object, unless: "object.nil?" # in case saved with validate: false
+      end
+    
+      protected
+      
+      def reindex_object
+        object.update_index
+      end
+
+    end
+  end
+end

data/lib/ddr/events/update_event.rb

@@ -0,0 +1,9 @@
+module Ddr
+  module Events
+    class UpdateEvent < Event 
+
+      self.description = "Object updated"
+
+    end
+  end
+end

data/lib/ddr/events/validation_event.rb

@@ -0,0 +1,11 @@
+module Ddr
+  module Events
+    class ValidationEvent < Event
+
+      include PreservationEventBehavior
+
+      self.preservation_event_type = :val
+
+    end
+  end
+end

data/lib/ddr/events/virus_check_event.rb

@@ -0,0 +1,30 @@
+module Ddr
+  module Events
+    class VirusCheckEvent < Event
+
+      include PreservationEventBehavior
+      include ReindexObjectAfterSave
+
+      self.preservation_event_type = :vir
+      self.description = "Content file scanned for viruses"
+
+      def to_solr
+        { Ddr::IndexFields::LAST_VIRUS_CHECK_ON => event_date_time_s,
+          Ddr::IndexFields::LAST_VIRUS_CHECK_OUTCOME => outcome }
+      end
+
+      # Message sent by ActiveSupport::Notifications
+      def self.call(*args)
+        notification = ActiveSupport::Notifications::Event.new(*args)
+        result = notification.payload[:result] # Ddr::Antivirus::ScanResult instance
+        create(pid: notification.payload[:pid],
+               event_date_time: result.scanned_at,
+               outcome: result.ok? ? SUCCESS : FAILURE,
+               software: result.version,
+               detail: result.to_s
+               )    
+      end
+
+    end
+  end
+end

data/lib/ddr/index_fields.rb

@@ -0,0 +1,39 @@
+module Ddr
+  module IndexFields
+
+    def self.solr_name(*args)
+      ActiveFedora::SolrService.solr_name(*args)
+    end
+  
+    ACTIVE_FEDORA_MODEL       = solr_name :active_fedora_model, :stored_sortable
+    CONTENT_CONTROL_GROUP     = solr_name :content_control_group, :searchable, type: :string
+    CONTENT_METADATA_PARSED   = solr_name :content_metadata_parsed, :symbol
+    CONTENT_SIZE              = solr_name :content_size, :stored_sortable, type: :integer
+    CONTENT_SIZE_HUMAN        = solr_name :content_size_human, :symbol
+    HAS_MODEL                 = solr_name :has_model, :symbol
+    IDENTIFIER                = solr_name :identifier, :stored_sortable
+    INTERNAL_URI              = solr_name :internal_uri, :symbol
+    IS_ATTACHED_TO            = solr_name :is_attached_to, :symbol
+    IS_EXTERNAL_TARGET_FOR    = solr_name :is_external_target_for, :symbol
+    IS_GOVERNED_BY            = solr_name :is_governed_by, :symbol
+    IS_MEMBER_OF              = solr_name :is_member_of, :symbol
+    IS_MEMBER_OF_COLLECTION   = solr_name :is_member_of_collection, :symbol
+    IS_PART_OF                = solr_name :is_part_of, :symbol
+    LAST_FIXITY_CHECK_ON      = solr_name :last_fixity_check_on, :stored_sortable, type: :date
+    LAST_FIXITY_CHECK_OUTCOME = solr_name :last_fixity_check_outcome, :symbol
+    LAST_VIRUS_CHECK_ON       = solr_name :last_virus_check_on, :stored_sortable, type: :date
+    LAST_VIRUS_CHECK_OUTCOME  = solr_name :last_virus_check_outcome, :symbol
+    MEDIA_SUB_TYPE            = solr_name :content_media_sub_type, :facetable
+    MEDIA_MAJOR_TYPE          = solr_name :content_media_major_type, :facetable
+    MEDIA_TYPE                = solr_name :content_media_type, :symbol
+    OBJECT_PROFILE            = solr_name :object_profile, :displayable
+    OBJECT_STATE              = solr_name :object_state, :stored_sortable
+    OBJECT_CREATE_DATE        = solr_name :system_create, :stored_sortable, type: :date
+    OBJECT_MODIFIED_DATE      = solr_name :system_modified, :stored_sortable, type: :date
+    ORIGINAL_FILENAME         = solr_name :original_filename, :symbol
+    PERMANENT_ID              = solr_name :permanent_id, :stored_sortable, type: :string
+    TITLE                     = solr_name :title, :stored_sortable
+    WORKFLOW_STATE            = solr_name :workflow_state, :stored_sortable
+
+  end
+end

data/lib/ddr/metadata.rb

@@ -0,0 +1,22 @@
+module Ddr
+  module Metadata
+    extend ActiveSupport::Autoload
+
+    autoload :DukeTerms
+    autoload :PremisEvent
+    autoload :RDFVocabularyParser
+    autoload :RolesVocabulary
+    autoload :Vocabulary
+
+    PREDICATES = {
+      "http://projecthydra.org/ns/relations#" => {
+        is_attached_to: "isAttachedTo"
+      },
+      "http://www.loc.gov/mix/v20/externalTarget#" => {
+        is_external_target_for: "isExternalTargetFor",
+        has_external_target: "hasExternalTarget"
+      }
+    }
+
+  end
+end

data/lib/ddr/metadata/duke_terms.rb

@@ -0,0 +1,15 @@
+module Ddr
+  module Metadata
+
+    class DukeTerms < RDF::StrictVocabulary("http://library.duke.edu/metadata/terms/")
+
+      RDFVocabularyParser.new(
+              File.join(File.dirname( __FILE__ ), "sources", "duketerms.rdf.xml"),
+              "http://library.duke.edu/metadata/terms/").
+              term_symbols.sort.each do |term|
+        property term, type: "rdf:Property".freeze
+      end
+
+    end
+  end
+end