hyrax 2.9.5 → 3.0.0.pre.beta1

data/app/jobs/ingest_local_file_job.rb

@@ -14,9 +14,5 @@ class IngestLocalFileJob < Hyrax::ApplicationJob
     else
       Hyrax.config.callback.run(:after_import_local_file_failure, file_set, user, path)
     end
-  rescue SystemCallError
-    # This is generic in order to handle Errno constants raised when accessing files
-    # @see https://ruby-doc.org/core-2.5.3/Errno.html
-    Hyrax.config.callback.run(:after_import_local_file_failure, file_set, user, path)
   end
 end

data/app/models/concerns/hyrax/ability.rb

@@ -73,7 +73,7 @@ module Hyrax
         ids = PermissionTemplateAccess.for_user(ability: self,
                                                 access: ['deposit', 'manage'])
                                       .joins(:permission_template)
-                                      .pluck(Arel.sql('DISTINCT source_id'))
+                                      .pluck('DISTINCT source_id')
         query = "_query_:\"{!raw f=has_model_ssim}AdminSet\" AND {!terms f=id}#{ids.join(',')}"
         ActiveFedora::SolrService.count(query).positive?
       end

data/app/models/concerns/hyrax/collection_behavior.rb

@@ -93,15 +93,25 @@ module Hyrax
       end
     end
 
-    # @deprecated to be removed in 4.0.0; this feature was replaced with a
-    #   hard-coded null implementation
-    # @return [Fixnum] 0
+    # Compute the sum of each file in the collection using Solr to
+    # avoid having to access Fedora
+    #
+    # @return [Fixnum] size of collection in bytes
+    # @raise [RuntimeError] unsaved record does not exist in solr
     def bytes
-      Deprecation.warn('#bytes has been deprecated for removal in Hyrax 4.0.0; ' \
-                       'The implementation of the indexed Collection size ' \
-                       'feature is extremely inefficient, so it has been removed. ' \
-                       'This method now returns a hard-coded `0` for compatibility.')
-      0
+      return 0 if member_object_ids.empty?
+
+      raise "Collection must be saved to query for bytes" if new_record?
+
+      # One query per member_id because Solr is not a relational database
+      member_object_ids.collect { |work_id| size_for_work(work_id) }.sum
+    end
+
+    # Use this query to get the ids of the member objects (since the containment
+    # association has been flipped)
+    def member_object_ids
+      return [] unless id
+      ActiveFedora::Base.search_with_conditions("member_of_collection_ids_ssim:#{id}").map(&:id)
     end
 
     # @api public
@@ -148,6 +158,22 @@ module Hyrax
         []
       end
 
+      # Calculate the size of all the files in the work
+      # @param work_id [String] identifer for a work
+      # @return [Integer] the size in bytes
+      def size_for_work(work_id)
+        argz = { fl: "id, #{file_size_field}",
+                 fq: "{!join from=#{member_ids_field} to=id}id:#{work_id}" }
+        files = ::FileSet.search_with_conditions({}, argz)
+        files.reduce(0) { |sum, f| sum + f[file_size_field].to_i }
+      end
+
+      # Field name to look up when locating the size of each file in Solr.
+      # Override for your own installation if using something different
+      def file_size_field
+        Solrizer.solr_name(:file_size, Hyrax::FileSetIndexer::STORED_LONG)
+      end
+
       # Solr field name works use to index member ids
       def member_ids_field
         Solrizer.solr_name('member_ids', :symbol)

data/app/models/concerns/hyrax/solr_document/characterization.rb

@@ -67,7 +67,7 @@ module Hyrax
       end
 
       def file_size
-        self["file_size_lts"]
+        self[Solrizer.solr_name("file_size")]
       end
 
       def filename
@@ -99,11 +99,7 @@ module Hyrax
       end
 
       def original_checksum
-        self["original_checksum_tesim"]
-      end
-
-      def alpha_channels
-        self["alpha_channels_ssi"]
+        self[Solrizer.solr_name("original_checksum")]
       end
     end
   end

data/app/models/concerns/hyrax/solr_document/metadata.rb

@@ -54,7 +54,6 @@ module Hyrax
         attribute :read_groups, Solr::Array, ::Ability.read_group_field
         attribute :collection_ids, Solr::Array, 'collection_ids_tesim'
         attribute :admin_set, Solr::Array, solr_name('admin_set')
-        attribute :member_ids, Solr::Array, "member_ids_ssim"
         attribute :member_of_collection_ids, Solr::Array, solr_name('member_of_collection_ids', :symbol)
         attribute :description, Solr::Array, solr_name('description')
         attribute :title, Solr::Array, solr_name('title')
@@ -76,15 +75,14 @@ module Hyrax
         attribute :rendering_ids, Solr::Array, solr_name(Hyrax.config.rendering_predicate.value.split(/#|\/|,/).last, :symbol)
         attribute :thumbnail_id, Solr::String, solr_name('hasRelatedImage', :symbol)
         attribute :thumbnail_path, Solr::String, CatalogController.blacklight_config.index.thumbnail_field
+        attribute :label, Solr::String, solr_name('label')
+        attribute :file_format, Solr::String, solr_name('file_format')
+        attribute :suppressed?, Solr::String, solr_name('suppressed', Solrizer::Descriptor.new(:boolean, :stored, :indexed))
 
-        attribute :label, Solr::String, "label_tesim"
-        attribute :file_format, Solr::String, "file_format_tesim"
-        attribute :suppressed?, Solr::String, "suppressed_bsi"
-        attribute :original_file_id, Solr::String, "original_file_id_ssi"
-        attribute :date_modified, Solr::Date, "date_modified_dtsi"
-        attribute :date_uploaded, Solr::Date, "date_uploaded_dtsi"
-        attribute :create_date, Solr::Date, "system_create_dtsi"
-        attribute :modified_date, Solr::Date, "system_modified_dtsi"
+        attribute :date_modified, Solr::Date, solr_name('date_modified', :stored_sortable, type: :date)
+        attribute :date_uploaded, Solr::Date, solr_name('date_uploaded', :stored_sortable, type: :date)
+        attribute :create_date, Solr::Date, solr_name('system_create', :stored_sortable, type: :date)
+        attribute :modified_date, Solr::Date, solr_name('system_modified', :stored_sortable, type: :date)
         attribute :embargo_release_date, Solr::Date, Hydra.config.permissions.embargo.release_date
         attribute :lease_expiration_date, Solr::Date, Hydra.config.permissions.lease.expiration_date
       end

data/app/models/concerns/hyrax/solr_document_behavior.rb

@@ -61,20 +61,10 @@ module Hyrax
       @model ||= ModelWrapper.new(hydra_model, id)
     end
 
-    ##
-    # @return [Boolean]
     def collection?
       hydra_model == ::Collection
     end
 
-    ##
-    # @return [Boolean]
-    def file_set?
-      hydra_model == ::FileSet
-    end
-
-    ##
-    # @return [Boolean]
     def admin_set?
       hydra_model == ::AdminSet
     end

data/app/models/concerns/hyrax/work_behavior.rb

@@ -7,7 +7,6 @@ module Hyrax
     include Permissions
     include Serializers
     include Hydra::WithDepositor
-    include Solrizer::Common
     include HasRepresentative
     include HasRendering
     include WithFileSets

data/app/models/hyrax/uploaded_file.rb

@@ -10,5 +10,7 @@ module Hyrax
              class_name: 'JobIoWrapper',
              dependent: :destroy
     belongs_to :user, class_name: '::User'
+
+    before_destroy :remove_file!
   end
 end

data/app/models/proxy_deposit_request.rb

@@ -89,14 +89,21 @@ class ProxyDepositRequest < ActiveRecord::Base
     def send_request_transfer_message_as_part_of_create
       user_link = link_to(sending_user.name, Hyrax::Engine.routes.url_helpers.user_path(sending_user))
       transfer_link = link_to('transfer requests', Hyrax::Engine.routes.url_helpers.transfers_path)
-      message = "#{user_link} wants to transfer a work to you. Review all #{transfer_link}"
-      Hyrax::MessengerService.deliver(::User.batch_user, receiving_user, message, "Ownership Change Request")
+      message = I18n.t('hyrax.notifications.proxy_deposit_request.transfer_on_create.message', user_link: user_link,
+                                                                                               transfer_link: transfer_link)
+      Hyrax::MessengerService.deliver(::User.batch_user, receiving_user, message,
+                                      I18n.t('hyrax.notifications.proxy_deposit_request.transfer_on_create.subject'))
     end
 
     def send_request_transfer_message_as_part_of_update
-      message = "Your transfer request was #{status}."
-      message += " Comments: #{receiver_comment}" if receiver_comment.present?
-      Hyrax::MessengerService.deliver(::User.batch_user, sending_user, message, "Ownership Change #{status}")
+      message = I18n.t('hyrax.notifications.proxy_deposit_request.transfer_on_update.message', status: status)
+      if receiver_comment.present?
+        message += " " + I18n.t('hyrax.notifications.proxy_deposit_request.transfer_on_update.comments',
+                                receiver_comment: receiver_comment)
+      end
+      Hyrax::MessengerService.deliver(::User.batch_user, sending_user, message,
+                                      I18n.t('hyrax.notifications.proxy_deposit_request.transfer_on_update.subject',
+                                             status: status))
     end
 
   public

data/app/models/single_use_link.rb

@@ -2,10 +2,13 @@ class SingleUseLink < ActiveRecord::Base
   validate :expiration_date_cannot_be_in_the_past
   validate :cannot_be_destroyed
 
+  alias_attribute :downloadKey, :download_key
+  alias_attribute :itemId, :item_id
+
   after_initialize :set_defaults
 
   def create_for_path(path)
-    self.class.create(itemId: itemId, path: path)
+    self.class.create(item_id: item_id, path: path)
   end
 
   def expired?
@@ -13,7 +16,7 @@ class SingleUseLink < ActiveRecord::Base
   end
 
   def to_param
-    downloadKey
+    download_key
   end
 
   private
@@ -29,6 +32,6 @@ class SingleUseLink < ActiveRecord::Base
     def set_defaults
       return unless new_record?
       self.expires ||= DateTime.current.advance(hours: 24)
-      self.downloadKey ||= (Digest::SHA2.new << rand(1_000_000_000).to_s).to_s
+      self.download_key ||= (Digest::SHA2.new << rand(1_000_000_000).to_s).to_s
     end
 end

data/app/presenters/hyrax/collection_presenter.rb

@@ -49,9 +49,6 @@ module Hyrax
       self.class.terms.select { |t| self[t].present? }
     end
 
-    ##
-    # @param [Symbol] key
-    # @return [Object]
     def [](key)
       case key
       when :size
@@ -63,16 +60,8 @@ module Hyrax
       end
     end
 
-    # @deprecated to be removed in 4.0.0; this feature was replaced with a
-    #   hard-coded null implementation
-    # @return [String] 'unknown'
     def size
-      Deprecation.warn('#size has been deprecated for removal in Hyrax 4.0.0; ' \
-                       'The implementation of the indexed Collection size ' \
-                       'feature is extremely inefficient, so it has been removed. ' \
-                       'This method now returns a hard-coded `"unknown"` for ' \
-                       'compatibility.')
-      'unknown'
+      number_to_human_size(@solr_document['bytes_lts'])
     end
 
     def total_items

data/app/presenters/hyrax/displays_image.rb

@@ -10,56 +10,30 @@ module Hyrax
     #
     # @return [IIIFManifest::DisplayImage] the display image required by the manifest builder.
     def display_image
-      return nil unless solr_document.image? && current_ability.can?(:read, solr_document)
-      return nil unless latest_file_id
-
+      return nil unless ::FileSet.exists?(id) && solr_document.image? && current_ability.can?(:read, id)
+      # @todo this is slow, find a better way (perhaps index iiif url):
+      original_file = ::FileSet.find(id).original_file
+
+      url = Hyrax.config.iiif_image_url_builder.call(
+        original_file.id,
+        request.base_url,
+        Hyrax.config.iiif_image_size_default
+      )
       # @see https://github.com/samvera-labs/iiif_manifest
-      IIIFManifest::DisplayImage.new(display_image_url(request.base_url),
-                                     format: image_format(alpha_channels),
-                                     width: width,
-                                     height: height,
-                                     iiif_endpoint: iiif_endpoint(latest_file_id))
+      IIIFManifest::DisplayImage.new(url,
+                                     width: 640,
+                                     height: 480,
+                                     iiif_endpoint: iiif_endpoint(original_file.id))
     end
 
     private
 
-      def display_image_url(base_url)
-        Hyrax.config.iiif_image_url_builder.call(
-          latest_file_id,
-          base_url,
-          Hyrax.config.iiif_image_size_default
-        )
-      end
-
-      def iiif_endpoint(file_id, base_url: request.base_url)
+      def iiif_endpoint(file_id)
         return unless Hyrax.config.iiif_image_server?
         IIIFManifest::IIIFEndpoint.new(
-          Hyrax.config.iiif_info_url_builder.call(file_id, base_url),
+          Hyrax.config.iiif_info_url_builder.call(file_id, request.base_url),
           profile: Hyrax.config.iiif_image_compliance_level_uri
         )
       end
-
-      def image_format(channels)
-        channels&.find { |c| c.include?('rgba') }.nil? ? 'jpg' : 'png'
-      end
-
-      def unindexed_current_file_version
-        Rails.logger.warn "Indexed current_file_version for #{id} not found, falling back to Fedora."
-        ActiveFedora::File.uri_to_id(::FileSet.find(id).current_content_version_uri)
-      end
-
-      def latest_file_id
-        @latest_file_id ||=
-          begin
-            result = original_file_id
-
-            if result.blank?
-              Rails.logger.warn "original_file_id for #{id} not found, falling back to Fedora."
-              result = Hyrax::VersioningService.versioned_file_id ::FileSet.find(id).original_file
-            end
-
-            result
-          end
-      end
   end
 end

data/app/presenters/hyrax/file_set_presenter.rb

@@ -30,15 +30,10 @@ module Hyrax
              :embargo_release_date, :lease_expiration_date,
              :depositor, :keyword, :title_or_label, :keyword,
              :date_created, :date_modified, :itemtype,
-             :original_file_id,
              to: :solr_document
 
-    def alpha_channels
-      []
-    end
-
     def single_use_links
-      @single_use_links ||= SingleUseLink.where(itemId: id).map { |link| link_presenter_class.new(link) }
+      @single_use_links ||= SingleUseLink.where(item_id: id).map { |link| link_presenter_class.new(link) }
     end
 
     # The title of the webpage that shows this FileSet.

data/app/presenters/hyrax/member_presenter_factory.rb

@@ -36,8 +36,14 @@ module Hyrax
       @work_presenters ||= member_presenters(ordered_ids - file_set_ids, work_presenter_class)
     end
 
+    # TODO: Extract this to ActiveFedora::Aggregations::ListSource
     def ordered_ids
-      @ordered_ids ||= Hyrax::SolrDocument::OrderedMembers.decorate(@work).ordered_member_ids
+      @ordered_ids ||= begin
+                         ActiveFedora::SolrService.query("proxy_in_ssi:#{id}",
+                                                         rows: 10_000,
+                                                         fl: "ordered_targets_ssim")
+                                                  .flat_map { |x| x.fetch("ordered_targets_ssim", []) }
+                       end
     end
 
     private

data/app/presenters/hyrax/single_use_link_presenter.rb

@@ -4,7 +4,7 @@ module Hyrax
 
     attr_reader :link
 
-    delegate :downloadKey, :expired?, :to_param, to: :link
+    delegate :download_key, :expired?, :to_param, to: :link
 
     # @param link [SingleUseLink]
     def initialize(link)
@@ -20,7 +20,7 @@ module Hyrax
     end
 
     def short_key
-      link.downloadKey.first(6)
+      link.download_key.first(6)
     end
 
     def link_type

data/app/search_builders/hyrax/catalog_search_builder.rb

@@ -1,3 +1,31 @@
+##
+# The default Blacklight catalog `search_builder_class` for Hyrax.
+#
+# Use of this builder is configured in the `CatalogController` generated by
+# Hyrax's install task.
+#
+# If you plan to customize the base catalog search builder behavior (e.g. by
+# adding a mixin module provided by a blacklight extension gem), inheriting this
+#  class, customizing behavior, and reconfiguring `CatalogController` is the
+# preferred mechanism.
+#
+# @example extending and customizing SearchBuilder
+#   class MyApp::CustomCatalogSearchBuilder < Hyrax::CatalogSearchBuilder
+#     include BlacklightRangeLimit::RangeLimitBuilder
+#     # and/or other extensions
+#   end
+#
+#   class CatalogController < ApplicationController
+#     # ...
+#     configure_blacklight do |config|
+#       config.search_builder_class = MyApp::CustomCatalogSearchBuilder
+#     # ...
+#     end
+#     # ...
+#   end
+#
+# @see Blacklight::SearchBuilder
+# @see Hyrax::SearchFilters
 class Hyrax::CatalogSearchBuilder < Hyrax::SearchBuilder
   self.default_processor_chain += [
     :add_access_controls_to_solr_params,

data/app/search_builders/hyrax/embargo_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     def only_active_embargoes(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'embargo_release_date_dtsi:[* TO *]'
+      solr_params[:fq] = 'embargo_release_date_dtsi:*'
     end
   end
 end

data/app/search_builders/hyrax/lease_search_builder.rb

@@ -14,7 +14,7 @@ module Hyrax
 
     def only_active_leases(solr_params)
       solr_params[:fq] ||= []
-      solr_params[:fq] = 'lease_expiration_date_dtsi:[* TO *]'
+      solr_params[:fq] = 'lease_expiration_date_dtsi:*'
     end
   end
 end

data/app/services/hyrax/batch_create_failure_service.rb

@@ -7,11 +7,11 @@ module Hyrax
     end
 
     def message
-      "The batch create for #{user} failed: #{messages}"
+      I18n.t('hyrax.notifications.batch_create_failure.message', user: user, messages: messages)
     end
 
     def subject
-      'Failing batch create'
+      I18n.t('hyrax.notifications.batch_create_failure.subject')
     end
   end
 end