sufia-models 4.0.0.rc1 → 4.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee13e1774ba0de53ce7735b6bb93176a2e27e882
-  data.tar.gz: 0760211d652447c4c47680af22c5cb29afb215c0
+  metadata.gz: 82546f98afb1a657c9bfba8eafcaad863373a979
+  data.tar.gz: 15a4dd50704723c213b51cf82b1de921609826a7
 SHA512:
-  metadata.gz: dca80059d96ab1b9f09c53af4e76374fc0d8644ba44f1faf4fcc2d94365e75e49e1321dd2542390a1ee14459f098c8e64b16caf30bc1c104194c6a7562ac4b23
-  data.tar.gz: da74a7e90d7d9cd3f6a3da5bb67e7e2c0288b366322cb6d1431d0089b43845346188313c3cdca0bcbcf89bfdc22d654006a7133f273c08aab9e442c683b2fcca
+  metadata.gz: 52bf6d0263f5cfbabb55ad19eb8c847f77e2a2b313cd07a9147622348940af4d6b926b0a789a052b6f48c8f84a34ca0f3d99aee6fd9d4eadc68585171b760d8b
+  data.tar.gz: b34150a1691b2cd26c1a6b206e635105bb96b9676973ed898cc9dbc08220fad281c9f42c8b0e812cceb3fa832e719944407c199e245152b0e8bf9efc7f323a91

data/app/actors/sufia/generic_file/actor.rb

@@ -17,12 +17,12 @@ module Sufia::GenericFile
       generic_file.apply_depositor_metadata(user)
       generic_file.date_uploaded = Date.today
       generic_file.date_modified = Date.today
-      generic_file.creator = user.name
+      generic_file.creator = [user.name]
 
       if batch_id
-        generic_file.add_relationship("isPartOf", "info:fedora/#{Sufia::Noid.namespaceize(batch_id)}")
+        generic_file.batch_id = Sufia::Noid.namespaceize(batch_id)
       else
-        logger.warn "unable to find batch to attach to"
+        ActiveFedora::Base.logger.warn "unable to find batch to attach to"
       end
       yield(generic_file) if block_given?
     end
@@ -59,6 +59,7 @@ module Sufia::GenericFile
       generic_file.attributes = generic_file.sanitize_attributes(attributes)
       generic_file.visibility = visibility
       generic_file.date_modified = DateTime.now
+      remove_from_feature_works if generic_file.visibility_changed? && !generic_file.public?
       save_and_record_committer do
         if Sufia.config.respond_to?(:after_update_metadata)
           Sufia.config.after_update_metadata.call(generic_file, user)
@@ -69,6 +70,7 @@ module Sufia::GenericFile
     def destroy
       pid = generic_file.pid  #Work around for https://github.com/projecthydra/active_fedora/issues/422
       generic_file.destroy
+      FeaturedWork.where(generic_file_id: pid).destroy_all
       if Sufia.config.respond_to?(:after_destroy)
         Sufia.config.after_destroy.call(pid, user)
       end
@@ -87,7 +89,7 @@ module Sufia::GenericFile
       begin
         return false unless generic_file.save
       rescue RSolr::Error::Http => error
-        logger.warn "Sufia::GenericFile::Actor::save_and_record_committer Caught RSOLR error #{error.inspect}"
+        ActiveFedora::Base.logger.warn "Sufia::GenericFile::Actor::save_and_record_committer Caught RSOLR error #{error.inspect}"
         save_tries+=1
         # fail for good if the tries is greater than 3
         raise error if save_tries >=3
@@ -107,12 +109,19 @@ module Sufia::GenericFile
       def virus_check(file)
         path = file.is_a?(String) ? file : file.path
         unless defined?(ClamAV)
-          logger.warn "Virus checking disabled, #{path} not checked"
+          ActiveFedora::Base.logger.warn "Virus checking disabled, #{path} not checked"
           return
         end
         scan_result = ClamAV.instance.scanfile(path)
         raise Sufia::VirusFoundError.new("A virus was found in #{path}: #{scan_result}") unless scan_result == 0
       end
     end
+
+    private
+      def remove_from_feature_works
+        featured_work = FeaturedWork.find_by_generic_file_id(generic_file.noid)
+        featured_work.destroy unless featured_work.nil?
+      end
+
   end
 end

data/{lib/sufia/models → app}/jobs/audit_job.rb

@@ -15,25 +15,19 @@ class AuditJob < ActiveFedoraPidBasedJob
   end
 
   def run
-    #logger.info "GF is #{generic_file.pid}"
     if generic_file
       datastream = generic_file.datastreams[datastream_id]
-      #logger.info "DS is #{datastream.inspect}"
       if datastream
-        #logger.info "Datastream for audit = #{datastream.inspect}"
         version =  datastream.versions.select { |v| v.versionID == version_id}.first
         log = run_audit(version)
 
         # look up the user for sending the message to
         login = generic_file.depositor
-        #logger.info "User login is #{login}"`
-        #logger.info "All users = #{User.all}"
         if login
           user = User.find_by_user_key(login)
-          logger.warn "User '#{login}' not found" unless user
-          #logger.info "ZZZ user = #{user.inspect}"
+          ActiveFedora::Base.logger.warn "User '#{login}' not found" unless user
           job_user = User.audituser()
-          #send the user a message about the failing audit
+          # send the user a message about the failing audit
           unless (log.pass == 1)
             message = "The audit run at #{log.created_at} for #{log.pid}:#{log.dsid}:#{log.version} was #{log.pass == 1 ? 'passing' : 'failing'}."
             subject = (log.pass == 1 ? PASS : FAIL)
@@ -41,10 +35,10 @@ class AuditJob < ActiveFedoraPidBasedJob
           end 
         end
       else
-        logger.warn "No datastream for audit!!!!! pid: #{pid} dsid: #{datastream_id}"
+        ActiveFedora::Base.logger.warn "No datastream for audit!!!!! pid: #{pid} dsid: #{datastream_id}"
       end
     else
-      logger.warn "No generic file for data stream audit!!!!! pid: #{pid} dsid: #{datastream_id}"
+      ActiveFedora::Base.logger.warn "No generic file for data stream audit!!!!! pid: #{pid} dsid: #{datastream_id}"
     end
   end
 

data/{lib/sufia/models → app}/jobs/batch_update_job.rb

@@ -1,12 +1,12 @@
 class BatchUpdateJob
   include Hydra::PermissionsQuery
-  include Rails.application.routes.url_helpers
+  include Sufia::Messages
 
   def queue_name
     :batch_update
   end
 
-  attr_accessor :login, :title, :file_attributes, :batch_id, :visibility
+  attr_accessor :login, :title, :file_attributes, :batch_id, :visibility, :saved, :denied
 
   def initialize(login, params)
     self.login = login
@@ -14,32 +14,29 @@ class BatchUpdateJob
     self.file_attributes = params[:generic_file]
     self.visibility = params[:visibility]
     self.batch_id = params[:id]
+    self.saved = []
+    self.denied = []
   end
 
   def run
     batch = Batch.find_or_create(self.batch_id)
     user = User.find_by_user_key(self.login)
-    @saved = []
-    @denied = []
 
     batch.generic_files.each do |gf|
       update_file(gf, user)
     end
     batch.update_attributes({status:["Complete"]})
-
-    job_user = User.batchuser()
-
-    message = '<span class="batchid ui-helper-hidden">ss-'+batch.noid+'</span>The file(s) '+ file_list(@saved)+ " have been saved." unless @saved.empty?
-    job_user.send_message(user, message, 'Batch upload complete') unless @saved.empty?
-
-    message = '<span class="batchid ui-helper-hidden">'+batch.noid+'</span>The file(s) '+ file_list(@denied)+" could not be updated.  You do not have sufficient privileges to edit it." unless @denied.empty?
-    job_user.send_message(user, message, 'Batch upload permission denied') unless @denied.empty?
+    if denied.empty?
+      send_user_success_message(user, batch) unless saved.empty?
+    else
+      send_user_failure_message(user, batch)
+    end
   end
 
   def update_file(gf, user)
     unless user.can? :edit, gf
-      logger.error "User #{user.user_key} DENIED access to #{gf.pid}!"
-      @denied << gf
+      ActiveFedora::Base.logger.error "User #{user.user_key} DENIED access to #{gf.pid}!"
+      denied << gf
       return
     end
     gf.title = title[gf.pid] if title[gf.pid] rescue gf.label
@@ -51,17 +48,24 @@ class BatchUpdateJob
       gf.save!
     rescue RSolr::Error::Http => error
       save_tries += 1
-      logger.warn "BatchUpdateJob caught RSOLR error on #{gf.pid}: #{error.inspect}"
+      ActiveFedora::Base.logger.warn "BatchUpdateJob caught RSOLR error on #{gf.pid}: #{error.inspect}"
       # fail for good if the tries is greater than 3
       raise error if save_tries >=3
       sleep 0.01
       retry
     end #
     Sufia.queue.push(ContentUpdateEventJob.new(gf.pid, login))
-    @saved << gf
+    saved << gf
+  end
+
+  def send_user_success_message user, batch
+    message = saved.count > 1 ? multiple_success(batch.noid, saved) : single_success(batch.noid, saved.first)
+    User.batchuser.send_message(user, message, success_subject, sanitize_text = false)
   end
 
-  def file_list ( files)
-    files.map { |gf| '<a href="'+Sufia::Engine.routes.url_helpers.generic_files_path+'/'+gf.noid+'">'+gf.to_s+'</a>' }.join(', ')
+  def send_user_failure_message user, batch
+    message = denied.count > 1 ? multiple_failure(batch.noid, denied) : single_failure(batch.noid, denied.first)
+    User.batchuser.send_message(user, message, failure_subject, sanitize_text = false)
   end
+  
 end

data/app/models/collection.rb

@@ -1,41 +1,3 @@
 class Collection < ActiveFedora::Base
-  include Hydra::Collection
-  include Sufia::ModelMethods
-  include Sufia::Noid
-  include Sufia::GenericFile::Permissions
-  include Sufia::GenericFile::WebForm # provides initialize_fields method
-
-  before_save :update_permissions
-  validates :title, presence: true
-
-  has_metadata "properties", type: PropertiesDatastream
-
-  def terms_for_display
-    [:title, :creator, :description, :date_modified, :date_uploaded]
-  end
-  
-  def terms_for_editing
-    terms_for_display - [:date_modified, :date_uploaded]
-  end
-  
-  # Test to see if the given field is required
-  # @param [Symbol] key a field
-  # @return [Boolean] is it required or not
-  def required?(key)
-    self.class.validators_on(key).any?{|v| v.kind_of? ActiveModel::Validations::PresenceValidator}
-  end
-  
-  def to_param
-    noid
-  end
-
-  def to_solr(solr_doc={}, opts={})
-    super(solr_doc, opts)
-    solr_doc[Solrizer.solr_name("noid", Sufia::GenericFile.noid_indexer)] = noid
-    return solr_doc
-  end
-
-  def update_permissions
-    self.visibility = "open"
-  end
+  include Sufia::Collection
 end

data/app/models/concerns/sufia/collection.rb

@@ -0,0 +1,55 @@
+module Sufia
+  module Collection
+    extend ActiveSupport::Concern
+    include Hydra::Collection
+    include Sufia::ModelMethods
+    include Sufia::Noid
+    include Sufia::GenericFile::Permissions
+    include Sufia::GenericFile::WebForm # provides initialize_fields method
+
+    included do
+      before_save :update_permissions
+      validates :title, presence: true
+
+      has_metadata "properties", type: PropertiesDatastream
+    end
+
+    def terms_for_display
+      terms_for_editing - [:title, :description]
+    end
+
+    def terms_for_editing
+      [:resource_type, :title, :creator, :contributor, :description, :tag,
+        :rights, :publisher, :date_created, :subject, :language, :identifier,
+        :based_near, :related_url]
+    end
+
+    # Test to see if the given field is required
+    # @param [Symbol] key a field
+    # @return [Boolean] is it required or not
+    def required?(key)
+      self.class.validators_on(key).any?{|v| v.kind_of? ActiveModel::Validations::PresenceValidator}
+    end
+
+    def to_param
+      noid
+    end
+
+    def to_solr(solr_doc={}, opts={})
+      super(solr_doc, opts)
+      solr_doc[Solrizer.solr_name("noid", Sufia::GenericFile.noid_indexer)] = noid
+      return solr_doc
+    end
+
+    def update_permissions
+      self.visibility = "open"
+    end
+
+    # Compute the sum of each file in the collection
+    # Return an integer of the result
+    def bytes
+      members.reduce(0) { |sum, gf| sum + gf.file_size.first.to_i }
+    end
+
+  end
+end

data/app/models/concerns/sufia/generic_file.rb

@@ -18,6 +18,7 @@ module Sufia
     include Sufia::GenericFile::Versions
     include Sufia::GenericFile::VirusCheck
     include Sufia::GenericFile::ReloadOnSave
+    include Sufia::GenericFile::FullTextIndexing
     include Hydra::Collections::Collectible
 
     included do
@@ -69,17 +70,9 @@ module Sufia
     # until all objects are done uploading and the user is redirected to
     # BatchController#edit.  Therefore, we must handle the case where
     # self.batch_id is set but self.batch returns nil.
-    # This can get a major overhaul with ActiveFedora 7
     def related_files
-      relateds = begin
-                   self.batch.generic_files
-                 rescue NoMethodError => e
-                   #batch is nil - When would this ever happen?
-                   batch_id = self.object_relations["isPartOf"].first || self.object_relations[:is_part_of].first
-                   return [] if batch_id.nil?
-                   self.class.find(Solrizer.solr_name('is_part_of', :symbol) => batch_id)
-                 end
-      relateds.reject { |gf| gf.pid == self.pid }
+      return [] if batch.nil?
+      batch.generic_files.reject { |sibling| sibling.id == id }
     end
 
     # Unstemmed, searchable, stored
@@ -93,6 +86,7 @@ module Sufia
         solr_doc[Solrizer.solr_name('noid', Sufia::GenericFile.noid_indexer)] = noid
         solr_doc[Solrizer.solr_name('file_format')] = file_format
         solr_doc[Solrizer.solr_name('file_format', :facetable)] = file_format
+        solr_doc['all_text_timv'] = full_text.content
         solr_doc = index_collection_pids(solr_doc)
       end
     end
@@ -100,7 +94,7 @@ module Sufia
     def label=(new_label)
       @inner_object.label = new_label
       if self.title.empty?
-        self.title = new_label
+        self.title = [new_label].compact
       end
     end
 

data/app/models/concerns/sufia/generic_file/audit.rb

@@ -2,8 +2,6 @@ module Sufia
   module GenericFile
     module Audit
       extend ActiveSupport::Concern
-      included do
-      end
 
       NO_RUNS = 999
 
@@ -17,6 +15,7 @@ module Sufia
 
       def per_version(&block)
         self.datastreams.each do |dsid, ds|
+          next if ds == full_text
           ds.versions.each do |ver|
             block.call(ver)
           end

data/app/models/concerns/sufia/generic_file/characterization.rb

@@ -42,9 +42,11 @@ module Sufia
 
       ## Extract the metadata from the content datastream and record it in the characterization datastream
       def characterize
-        self.characterization.ng_xml = self.content.extract_metadata
+        metadata = self.content.extract_metadata
+        self.characterization.ng_xml = metadata if metadata.present?
         self.append_metadata
-        self.filename = self.label
+        self.filename = [self.label]
+        extract_content
         save
       end
 

data/app/models/concerns/sufia/generic_file/full_text_indexing.rb

@@ -0,0 +1,27 @@
+module Sufia
+  module GenericFile
+    module FullTextIndexing
+      extend ActiveSupport::Concern
+
+      included do
+        has_file_datastream 'full_text', versionable: false
+      end
+
+      def extract_content
+        url = Blacklight.solr_config[:url] ? Blacklight.solr_config[:url] : Blacklight.solr_config["url"] ? Blacklight.solr_config["url"] : Blacklight.solr_config[:fulltext] ? Blacklight.solr_config[:fulltext]["url"] : Blacklight.solr_config[:default]["url"]
+        uri = URI("#{url}/update/extract?extractOnly=true&wt=json&extractFormat=text")
+        req = Net::HTTP.new(uri.host, uri.port)
+        resp = req.post(uri.to_s, self.content.content, {
+            'Content-type' => "#{self.mime_type};charset=utf-8",
+            'Content-Length' => self.content.content.size.to_s
+          })
+        raise "URL '#{uri}' returned code #{resp.code}" unless resp.code == "200"
+        self.content.content.rewind if self.content.content.respond_to?(:rewind)
+        extracted_text = JSON.parse(resp.body)[''].rstrip
+        full_text.content = extracted_text if extracted_text.present?
+      rescue => e
+        logger.error("Error extracting content from #{self.pid}: #{e.inspect}")
+      end
+    end
+  end
+end

data/app/models/concerns/sufia/generic_file/mime_types.rb

@@ -53,6 +53,7 @@ module Sufia
           ['text/rtf',
            'application/msword',
            'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+           'application/vnd.oasis.opendocument.text',
            'application/vnd.ms-excel',
            'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
            'application/vnd.ms-powerpoint',

data/app/models/concerns/sufia/generic_file/permissions.rb

@@ -2,57 +2,10 @@ module Sufia
   module GenericFile
     module Permissions
       extend ActiveSupport::Concern
-      #we're overriding the permissions= method which is in Hydra::AccessControls::Permissions
-      include Hydra::AccessControls::Permissions
-      include Hydra::AccessControls::Visibility
 
-      included do
-        has_metadata "rightsMetadata", type: ParanoidRightsDatastream
-        validate :paranoid_permissions
-      end
+      include Sufia::Permissions::Writable
+      include Sufia::Permissions::Readable
 
-      def paranoid_permissions
-        # let the rightsMetadata ds make this determination
-        # - the object instance is passed in for easier access to the props ds
-        rightsMetadata.validate(self)
-      end
-
-      ## Updates those permissions that are provided to it. Does not replace any permissions unless they are provided
-      def permissions=(params)
-        perm_hash = permission_hash
-        params[:new_user_name].each { |name, access| perm_hash['person'][name] = access } if params[:new_user_name].present?
-        params[:new_group_name].each { |name, access| perm_hash['group'][name] = access } if params[:new_group_name].present?
-
-        params[:user].each { |name, access| perm_hash['person'][name] = access} if params[:user]
-        params[:group].each { |name, access| perm_hash['group'][name] = access if ['read', 'edit'].include?(access)} if params[:group]
-
-        rightsMetadata.update_permissions(perm_hash)
-      end
-
-      def permissions
-        perms = super
-        perms.map {|p| { name: p.name, access: p.access, type:p.type } }
-      end
-
-      def public?
-        read_groups.include?('public')
-      end
-
-      private
-
-      def permission_hash
-        old_perms = self.permissions
-        user_perms =  {}
-        old_perms.select{|r| r[:type] == 'user'}.each do |r|
-          user_perms[r[:name]] = r[:access]
-        end
-        user_perms
-        group_perms =  {}
-        old_perms.select{|r| r[:type] == 'group'}.each do |r|
-          group_perms[r[:name]] = r[:access]
-        end
-        {'person'=>user_perms, 'group'=>group_perms}
-      end
     end
   end
 end