ddr-models 1.2.0

data/lib/ddr/models/fixity_checkable.rb

@@ -0,0 +1,20 @@
+module Ddr
+  module Models
+    module FixityCheckable
+   
+      def datastreams_to_validate
+        datastreams.select { |dsid, ds| ds.has_content? }
+      end
+
+      def fixity_checks
+        Ddr::Events::FixityCheckEvent.for_object(self)
+      end
+
+      # Returns a Ddr::Actions::FixityCheck::Result for the object
+      def fixity_check
+        Ddr::Actions::FixityCheck.execute(self)
+      end
+ 
+    end
+  end
+end

data/lib/ddr/models/governable.rb

@@ -0,0 +1,48 @@
+module Ddr
+  module Models
+    module Governable
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :admin_policy, :property => :is_governed_by, :class_name => "Collection"
+      end
+
+      def inherited_permissions
+        admin_policy ? admin_policy.default_permissions : []
+      end
+
+      def inherited_rights
+        admin_policy.datastreams[Ddr::Datastreams::DEFAULT_RIGHTS] if admin_policy
+      end
+
+      # Creates convenience methods: 
+      # inherited_discover_users, inherited_discover_groups, 
+      # inherited_read_users, inherited_read_groups,
+      # inherited_edit_user, inherited_edit_groups
+      ["discover", "read", "edit"].each do |access|
+        ["user", "group"].each do |type|
+          define_method("inherited_#{access}_#{type}s") do
+            admin_policy ? admin_policy.send("default_#{access}_#{type}s") : []
+          end
+        end
+      end
+
+      def inherited_license
+        admin_policy.default_license if admin_policy
+      end
+
+      def copy_admin_policy_from(other)
+        # XXX In active-fedora 7.0 can do
+        # self.admin_policy = other.admin_policy
+        self.admin_policy_id = case
+        when other.has_admin_policy?
+          other.admin_policy_id
+        when other.is_a?(Collection)
+          other.pid
+        end
+        # self.admin_policy_id = other.admin_policy_id if other.has_admin_policy?
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_attachments.rb

@@ -0,0 +1,12 @@
+module Ddr
+  module Models
+    module HasAttachments
+      extend ActiveSupport::Concern
+
+      included do
+        has_many :attachments, property: :is_attached_to, class_name: 'Attachment'
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_children.rb

@@ -0,0 +1,21 @@
+module Ddr
+  module Models
+    module HasChildren
+      extend ActiveSupport::Concern
+
+      def first_child
+        if datastreams.include?(Ddr::Datastreams::CONTENT_METADATA) && datastreams[Ddr::Datastreams::CONTENT_METADATA].has_content?
+          first_child_pid = datastreams[Ddr::Datastreams::CONTENT_METADATA].first_pid
+        else
+          first_child_pid = ActiveFedora::SolrService.query(association_query(:children), rows: 1, sort: "#{Ddr::IndexFields::IDENTIFIER} ASC").first["id"]
+        end      
+        begin
+          ActiveFedora::Base.find(first_child_pid, :cast => true) if first_child_pid
+        rescue ActiveFedora::ObjectNotFound
+          nil
+        end
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_content.rb

@@ -0,0 +1,114 @@
+require 'openssl'
+
+module Ddr
+  module Models
+    module HasContent
+      extend ActiveSupport::Concern
+
+      included do
+        has_file_datastream name: Ddr::Datastreams::CONTENT,
+                            versionable: true, 
+                            label: "Content file for this object",
+                            control_group: "M"
+
+        has_attributes :original_filename, datastream: "properties", multiple: false
+
+        validates_presence_of :content
+
+        include Hydra::Derivatives
+        include FileManagement unless include?(FileManagement)
+
+        around_save :update_thumbnail, if: :content_changed?
+
+        after_add_file do
+          if file_to_add.original_name && file_to_add.dsid == "content"
+            self.original_filename = file_to_add.original_name 
+          end
+        end
+
+        delegate :validate_checksum!, to: :content
+      end
+
+      # Convenience method wrapping FileManagement#add_file
+      def upload file, opts={}
+        add_file(file, Ddr::Datastreams::CONTENT, opts)
+      end
+
+      # Set content to file and save
+      def upload! file, opts={}
+        upload(file, opts)
+        save
+      end
+
+      def content_size
+        content.external? ? content.file_size : content.dsSize
+      end
+
+      def content_human_size
+        ActiveSupport::NumberHelper.number_to_human_size(content_size) if content_size
+      end
+
+      def content_type
+        content.mimeType
+      end
+
+      def content_major_type
+        content_type.split("/").first
+      end
+
+      def content_sub_type
+        content_type.split("/").last
+      end
+
+      def content_type= mime_type
+        self.content.mimeType = mime_type
+      end
+
+      def image?
+        content_major_type == "image"
+      end
+
+      def pdf?
+        content_type == "application/pdf"
+      end
+
+      def generate_thumbnail
+        return false unless thumbnailable?
+        transform_datastream :content, { thumbnail: { size: "100x100>", datastream: "thumbnail" } }
+        thumbnail_changed?
+      end
+
+      def generate_thumbnail!
+        generate_thumbnail && save
+      end
+
+      def virus_checks
+        Ddr::Events::VirusCheckEvent.for_object(self)
+      end
+
+      def content_changed?
+        content.external? ? content.dsLocation_changed? : content.content_changed?
+      end
+
+      protected
+    
+      def update_thumbnail
+        yield
+        if thumbnailable?
+          generate_thumbnail!
+        else
+          thumbnail.delete
+        end
+      end
+
+      def thumbnailable?
+        has_content? && (image? || pdf?)
+      end
+
+      def default_content_type
+        "application/octet-stream"
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_content_metadata.rb

@@ -0,0 +1,16 @@
+module Ddr
+  module Models
+    module HasContentMetadata
+      extend ActiveSupport::Concern
+
+      included do
+        has_file_datastream :name => Ddr::Datastreams::CONTENT_METADATA, 
+                            :type => Ddr::Datastreams::ContentMetadataDatastream,
+                            :versionable => true, 
+                            :label => "Structural Content Data for this object", 
+                            :control_group => 'M'
+      end
+      
+    end
+  end
+end

data/lib/ddr/models/has_properties.rb

@@ -0,0 +1,15 @@
+module Ddr
+  module Models
+    module HasProperties
+      extend ActiveSupport::Concern
+  
+      included do
+        has_metadata name: Ddr::Datastreams::PROPERTIES, 
+                     type: Ddr::Datastreams::PropertiesDatastream,
+                     versionable: true, 
+                     label: "Properties for this object", 
+                     control_group: 'M'
+      end
+    end
+  end
+end

data/lib/ddr/models/has_role_assignments.rb

@@ -0,0 +1,17 @@
+module Ddr
+  module Models
+    module HasRoleAssignments
+      extend ActiveSupport::Concern
+
+      included do
+        has_metadata name: "roleAssignments", 
+                     type: Ddr::Datastreams::RoleAssignmentsDatastream,
+                     versionable: true, 
+                     control_group: "M"
+
+        delegate :principal_has_role?, to: :roleAssignments
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_thumbnail.rb

@@ -0,0 +1,27 @@
+module Ddr
+  module Models
+    module HasThumbnail
+      extend ActiveSupport::Concern
+  
+      included do
+        has_file_datastream name: Ddr::Datastreams::THUMBNAIL, 
+                            versionable: true, 
+                            label: "Thumbnail for this object", 
+                            control_group: 'M'
+      end
+
+      def thumbnail_changed?
+        thumbnail.content_changed?
+      end
+
+      def copy_thumbnail_from(other)
+        if other && other.has_thumbnail?
+          self.thumbnail.content = other.thumbnail.content
+          self.thumbnail.mimeType = other.thumbnail.mimeType if thumbnail_changed?
+        end
+        thumbnail_changed?
+      end
+
+    end
+  end
+end

data/lib/ddr/models/has_workflow.rb

@@ -0,0 +1,29 @@
+module Ddr
+  module Models
+    module HasWorkflow
+      extend ActiveSupport::Concern
+
+      PUBLISHED = Ddr::Workflow::WorkflowState::PUBLISHED
+      UNPUBLISHED = nil
+
+      def workflow_state
+        Ddr::Workflow::WorkflowState.workflow_state_for_object(self)
+      end
+
+      def published?
+        self.workflow_state == PUBLISHED
+      end
+      
+      def publish!
+        Ddr::Workflow::WorkflowState.set_for_object(self, PUBLISHED)
+        update_index
+      end
+      
+      def unpublish!
+        Ddr::Workflow::WorkflowState.set_for_object(self, UNPUBLISHED)
+        update_index
+      end
+
+    end
+  end
+end

data/lib/ddr/models/indexing.rb

@@ -0,0 +1,53 @@
+module Ddr
+  module Models
+    module Indexing
+
+      def to_solr(solr_doc=Hash.new, opts={})
+        solr_doc = super(solr_doc, opts)
+        solr_doc.merge index_fields
+      end
+
+      def index_fields
+        fields = {
+          Ddr::IndexFields::TITLE => title_display,
+          Ddr::IndexFields::INTERNAL_URI => internal_uri,
+          Ddr::IndexFields::IDENTIFIER => identifier_sort,
+          Ddr::IndexFields::PERMANENT_ID => permanent_id,
+          Ddr::IndexFields::WORKFLOW_STATE => workflow_state
+        }
+        if respond_to? :fixity_checks
+          last_fixity_check = fixity_checks.last
+          fields.merge!(last_fixity_check.to_solr) if last_fixity_check
+        end
+        if respond_to? :virus_checks
+          last_virus_check = virus_checks.last
+          fields.merge!(last_virus_check.to_solr) if last_virus_check
+        end
+        if respond_to?(:original_filename) && original_filename.present?
+          fields[Ddr::IndexFields::ORIGINAL_FILENAME] = original_filename
+        end
+        if has_content?
+          fields[Ddr::IndexFields::CONTENT_CONTROL_GROUP] = content.controlGroup
+          fields[Ddr::IndexFields::CONTENT_SIZE] = content_size
+          fields[Ddr::IndexFields::CONTENT_SIZE_HUMAN] = content_human_size
+          fields[Ddr::IndexFields::MEDIA_TYPE] = content_type
+          fields[Ddr::IndexFields::MEDIA_MAJOR_TYPE] = content_major_type
+          fields[Ddr::IndexFields::MEDIA_SUB_TYPE] = content_sub_type
+        end
+        fields
+      end
+
+      def title_display
+        return title.first if title.present?
+        return identifier.first if identifier.present?
+        return original_filename if respond_to?(:original_filename) && original_filename.present?
+        "[#{pid}]"
+      end
+
+      def identifier_sort
+        identifier.first
+      end
+
+    end
+  end
+end

data/lib/ddr/models/licensable.rb

@@ -0,0 +1,28 @@
+module Ddr
+  module Models
+    module Licensable
+      extend ActiveSupport::Concern
+
+      included do
+        has_attributes :license_title, datastream: Ddr::Datastreams::RIGHTS_METADATA, at: [:license, :title], multiple: false
+        has_attributes :license_description, datastream: Ddr::Datastreams::RIGHTS_METADATA, at: [:license, :description], multiple: false
+        has_attributes :license_url, datastream: Ddr::Datastreams::RIGHTS_METADATA, at: [:license, :url], multiple: false
+      end
+
+      def license
+        if license_title.present? or license_description.present? or license_url.present?
+          {title: license_title, description: license_description, url: license_url}.with_indifferent_access
+        end
+      end
+  
+      def license=(new_license)
+        raise ArgumentError unless new_license.is_a?(Hash)
+        l = new_license.with_indifferent_access
+        self.license_title = l[:title]
+        self.license_description = l[:description]
+        self.license_url = l[:url]
+      end
+
+    end
+  end
+end

data/lib/ddr/models/minted_id.rb

@@ -0,0 +1,10 @@
+module Ddr
+  module Models
+    class MintedId < ActiveRecord::Base
+
+      validates_presence_of :minted_id
+      validates_uniqueness_of :minted_id
+
+    end
+  end
+end

data/lib/ddr/models/permanent_identification.rb

@@ -0,0 +1,48 @@
+module Ddr
+  module Models
+    module PermanentIdentification
+      extend ActiveSupport::Concern
+
+      PERMALINK_BASE_URL = 'http://id.library.duke.edu/'
+
+      included do
+        has_attributes :permanent_id, datastream: Ddr::Datastreams::PROPERTIES, multiple: false
+        after_create :assign_permanent_identifier
+
+        def self.permalink(permanent_id)
+          PERMALINK_BASE_URL + permanent_id
+        end
+
+      end
+
+      def permalink
+        self.class.permalink(permanent_id)
+      end
+
+      protected
+
+      def assign_permanent_identifier
+        reload
+        unless permanent_id.present?
+          event_args = { pid: self.pid, summary: "Assigned permanent ID" }
+          begin
+            self.permanent_id = Ddr::Services::IdService.mint
+            if save(validate: false)
+              MintedId.find_by(minted_id: self.permanent_id).update(referent: self.pid)
+              event_args[:outcome] = Ddr::Events::Event::SUCCESS
+              event_args[:detail] = "Assigned permanent ID #{self.permanent_id} to #{self.pid}"
+            else
+              raise "Could not save object #{self.pid} with permanent identifier #{self.permanent_id}"
+            end
+          rescue Exception => e
+            event_args[:outcome] = Ddr::Events::Event::FAILURE
+            event_args[:detail] = "Unable to assign permanent ID to #{self.pid}"
+            Rails.logger.error("Error assigning permanent ID to #{self.pid}: #{e}")
+          end
+          Ddr::Notifications.notify_event(:update, event_args)
+        end
+      end
+
+    end
+  end
+end