curation_concerns 0.12.0.pre1 → 0.12.0.pre2

data/lib/curation_concerns/collections/search_service.rb

@@ -0,0 +1,57 @@
+module CurationConcerns
+  module Collections
+    class SearchService
+      include Blacklight::Configurable
+      include Blacklight::SearchHelper
+
+      def initialize(session, user_key)
+        @session = session
+        @user_key = user_key
+        self.class.copy_blacklight_config_from(::CatalogController)
+      end
+
+      # self.search_params_logic << :apply_gated_search
+
+      def last_search_documents
+        return [] if @session[:history].blank?
+        last_search_id = @session[:history].first
+        search = Search.find(last_search_id)
+        _, document_list = get_search_results(search.query_params, fl: 'id', rows: 1000)
+        document_list
+      end
+
+      # filter that sets up access-controlled lucene query in order to provide gated search behavior
+      # @param solr_parameters the current solr parameters
+      # @param user_parameters the current user-submitted parameters
+      def apply_gated_search(solr_parameters, _user_parameters)
+        solr_parameters[:fq] ||= []
+
+        # Grant access to public content
+        user_access_filters = []
+        user_access_filters << "#{solr_access_control_suffix(:group)}:public"
+
+        # Grant access based on user id & role
+        unless @user_key.blank?
+          # for roles
+          ::RoleMapper.roles(@user_key).each do |role|
+            user_access_filters << "#{solr_access_control_suffix(:group)}:#{escape_slashes(role)}"
+          end
+          # for individual person access
+          user_access_filters << "#{solr_access_control_suffix(:individual)}:#{escape_slashes(@user_key)}"
+        end
+        solr_parameters[:fq] << user_access_filters.join(' OR ')
+        solr_parameters
+      end
+
+      def escape_slashes(value)
+        value.gsub('/', '\/')
+      end
+
+      # @param [Symbol] key The permission type to return.  Must be `:group` or `:individual`
+      def solr_access_control_suffix(key)
+        raise ArgumentError, 'you must provide :group or :individual' unless [:group, :individual].include?(key)
+        Hydra.config[:permissions][:edit][key]
+      end
+    end
+  end
+end

data/lib/curation_concerns/collections.rb

@@ -0,0 +1,10 @@
+require 'hydra/head'
+require 'hydra/works'
+
+module CurationConcerns
+  module Collections
+    extend ActiveSupport::Autoload
+    autoload :SearchService
+    autoload :AcceptsBatches
+  end
+end

data/lib/curation_concerns/configuration.rb

@@ -0,0 +1,167 @@
+require 'curation_concerns/callbacks'
+
+module CurationConcerns
+  extend Deprecation
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure
+    self.config ||= Configuration.new
+    yield(config)
+  end
+
+  class Configuration
+    include Callbacks
+
+    def initialize
+      @registered_concerns = []
+    end
+
+    # An anonymous function that receives a path to a file
+    # and returns AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE if no
+    # virus is found; Any other returned value means a virus was found
+    attr_writer :default_antivirus_instance
+    def default_antivirus_instance
+      @default_antivirus_instance ||= lambda do |_file_path|
+        AntiVirusScanner::NO_VIRUS_FOUND_RETURN_VALUE
+      end
+    end
+
+    # Path on the local file system where derivatives will be stored
+    attr_writer :derivatives_path
+    def derivatives_path
+      @derivatives_path ||= File.join(Rails.root, 'tmp', 'derivatives')
+    end
+
+    # Path on the local file system where originals will be staged before being ingested into Fedora.
+    attr_writer :working_path
+    def working_path
+      @working_path ||= File.join(Rails.root, 'tmp', 'uploads')
+    end
+
+    attr_writer :enable_ffmpeg
+    def enable_ffmpeg
+      return @enable_ffmpeg unless @enable_ffmpeg.nil?
+      @enable_ffmpeg = false
+    end
+
+    attr_writer :ffmpeg_path
+    def ffmpeg_path
+      @ffmpeg_path ||= 'ffmpeg'
+    end
+
+    attr_writer :fits_message_length
+    def fits_message_length
+      @fits_message_length ||= 5
+    end
+
+    attr_accessor :temp_file_base, :enable_local_ingest,
+                  :analytics, :analytic_start_date
+
+    attr_writer :display_microdata
+    def display_microdata
+      return @display_microdata unless @display_microdata.nil?
+      @display_microdata = true
+    end
+
+    attr_writer :microdata_default_type
+    def microdata_default_type
+      @microdata_default_type ||= 'http://schema.org/CreativeWork'
+    end
+
+    attr_writer :max_days_between_audits
+    def max_days_between_audits
+      @max_days_between_audits ||= 7
+    end
+
+    attr_writer :enable_noids
+    def enable_noids
+      return @enable_noids unless @enable_noids.nil?
+      @enable_noids = true
+    end
+
+    attr_writer :noid_template
+    def noid_template
+      @noid_template ||= '.reeddeeddk'
+    end
+
+    attr_writer :minter_statefile
+    def minter_statefile
+      @minter_statefile ||= '/tmp/minter-state'
+    end
+
+    attr_writer :redis_namespace
+    def redis_namespace
+      @redis_namespace ||= 'curation_concerns'
+    end
+
+    attr_writer :fits_path
+    def fits_path
+      @fits_path ||= 'fits.sh'
+    end
+
+    # Override characterization runner
+    attr_accessor :characterization_runner
+
+    # Attributes for the lock manager which ensures a single process/thread is mutating a ore:Aggregation at once.
+    # @!attribute [w] lock_retry_count
+    #   How many times to retry to acquire the lock before raising UnableToAcquireLockError
+    attr_writer :lock_retry_count
+    def lock_retry_count
+      @lock_retry_count ||= 600 # Up to 2 minutes of trying at intervals up to 200ms
+    end
+
+    # @!attribute [w] lock_time_to_live
+    #   How long to hold the lock in milliseconds
+    attr_writer :lock_time_to_live
+    def lock_time_to_live
+      @lock_time_to_live ||= 60_000 # milliseconds
+    end
+
+    # @!attribute [w] lock_retry_delay
+    #   Maximum wait time in milliseconds before retrying. Wait time is a random value between 0 and retry_delay.
+    attr_writer :lock_retry_delay
+    def lock_retry_delay
+      @lock_retry_delay ||= 200 # milliseconds
+    end
+
+    callback.enable :after_create_content, :after_update_content,
+                    :after_revert_content, :after_update_metadata,
+                    :after_import_local_file_success,
+                    :after_import_local_file_failure, :after_audit_failure,
+                    :after_destroy, :after_import_url_success, :after_import_url_failure
+
+    # Registers the given curation concern model in the configuration
+    # @param [Array<Symbol>,Symbol] curation_concern_types
+    def register_curation_concern(*curation_concern_types)
+      Array(curation_concern_types).flatten.compact.each do |cc_type|
+        unless @registered_concerns.include?(cc_type)
+          @registered_concerns << cc_type
+        end
+      end
+    end
+
+    # The normalization done by this method must occur after the initialization process
+    # so it can take advantage of irregular inflections from config/initializers/inflections.rb
+    # @return [Array<String>] the class names of the registered curation concerns
+    def registered_curation_concern_types
+      @registered_concerns.map { |cc_type| normalize_concern_name(cc_type) }
+    end
+
+    # @return [Array<Class>] the registered curation concerns
+    def curation_concerns
+      registered_curation_concern_types.map(&:constantize)
+    end
+
+    private
+
+      # @param [Symbol] the symbol representing the model
+      # @return [String] the class name for the model
+      def normalize_concern_name(c)
+        c.to_s.camelize
+      end
+  end
+
+  configure {}
+end

data/lib/curation_concerns/engine.rb

@@ -1,7 +1,6 @@
 # Load blacklight which will give curation_concerns views a higher preference than those in blacklight
 require 'blacklight'
 require 'curation_concerns/models'
-require 'hydra-collections'
 require 'hydra-editor'
 require 'jquery-ui-rails'
 require 'qa'
@@ -18,6 +17,7 @@ module CurationConcerns
     require 'breadcrumbs_on_rails'
 
     config.autoload_paths += %W(
+      #{config.root}/app/actors/concerns
       #{config.root}/lib
     )
 
@@ -30,5 +30,26 @@ module CurationConcerns
 
       app.config.assets.precompile += %w(*.png *.gif)
     end
+
+    initializer 'requires' do
+      require 'active_fedora/noid'
+      require 'curation_concerns/noid'
+      require 'curation_concerns/permissions'
+      require 'curation_concerns/lockable'
+    end
+
+    initializer 'configure' do
+      CurationConcerns.config.tap do |c|
+        Hydra::Derivatives.ffmpeg_path    = c.ffmpeg_path
+        Hydra::Derivatives.temp_file_base = c.temp_file_base
+        Hydra::Derivatives.fits_path      = c.fits_path
+        Hydra::Derivatives.enable_ffmpeg  = c.enable_ffmpeg
+
+        ActiveFedora::Base.translate_uri_to_id = ActiveFedora::Noid.config.translate_uri_to_id
+        ActiveFedora::Base.translate_id_to_uri = ActiveFedora::Noid.config.translate_id_to_uri
+        ActiveFedora::Noid.config.template = c.noid_template
+        ActiveFedora::Noid.config.statefile = c.minter_statefile
+      end
+    end
   end
 end

data/lib/curation_concerns/messages.rb

@@ -0,0 +1,68 @@
+module CurationConcerns
+  module Messages
+    extend ActiveSupport::Concern
+
+    # Borrowed from AbstractController so we can render html content tags
+    attr_accessor :output_buffer
+    include ActionView::Helpers::TagHelper
+    include ActionView::Helpers::UrlHelper
+
+    def success_subject
+      I18n.t('curation_concerns.messages.success.subject')
+    end
+
+    def failure_subject
+      I18n.t('curation_concerns.messages.failure.subject')
+    end
+
+    def single_success(id, file)
+      content_tag :span, id: 'ss-' + id do
+        [link_to_file(file), I18n.t('curation_concerns.messages.success.single')].join(' ').html_safe
+      end
+    end
+
+    def multiple_success(id, files)
+      content_tag :span, id: 'ss-' + id do
+        [success_link(files), I18n.t('curation_concerns.messages.success.multiple.tag')].join(' ').html_safe
+      end
+    end
+
+    def single_failure(id, file)
+      content_tag :span, id: 'ss-' + id do
+        [link_to_file(file), I18n.t('curation_concerns.messages.failure.single')].join(' ').html_safe
+      end
+    end
+
+    def multiple_failure(id, files)
+      content_tag :span, id: 'ss-' + id do
+        [failure_link(files), I18n.t('curation_concerns.messages.failure.multiple.tag')].join(' ').html_safe
+      end
+    end
+
+    # Double-quotes are replaced with single ones so this list can be included in a data block. Ex:
+    #   <a href="#" data-content="<a href='#'>embedded link</a>" data-toggle="popover">Click me</a>
+    def file_list(files)
+      files.map { |fs| link_to_file(fs) }.join(', ').tr("\"", "'")
+    end
+
+    def link_to_file(file)
+      link_to(file.to_s, Rails.application.class.routes.url_helpers.curation_concerns_file_set_path(file))
+    end
+
+    private
+
+      def success_link(files)
+        link_to I18n.t('curation_concerns.messages.success.multiple.link'), '#',
+                data: { toggle: 'popover',
+                        content: file_list(files).html_safe,
+                        title: I18n.t('curation_concerns.messages.success.title') }
+      end
+
+      def failure_link(files)
+        link_to I18n.t('curation_concerns.messages.failure.multiple.link'), '#',
+                data: { toggle: 'popover',
+                        content: file_list(files).html_safe,
+                        title: I18n.t('curation_concerns.messages.failure.title') }
+      end
+  end
+end

data/lib/curation_concerns/models.rb

@@ -0,0 +1,42 @@
+require 'hydra/head'
+
+module CurationConcerns
+  extend ActiveSupport::Autoload
+
+  module Models
+    module Utils
+      extend ActiveSupport::Concern
+
+      def retry_unless(number_of_tries, condition, &block)
+        self.class.retry_unless(number_of_tries, condition, &block)
+      end
+
+      module ClassMethods
+        def retry_unless(number_of_tries, condition, &_block)
+          fail ArgumentError, 'First argument must be an enumerator' unless number_of_tries.is_a? Enumerator
+          fail ArgumentError, 'Second argument must be a lambda' unless condition.respond_to? :call
+          fail ArgumentError, 'Must pass a block of code to retry' unless block_given?
+          number_of_tries.each do
+            result = yield
+            return result unless condition.call
+          end
+          fail 'retry_unless could not complete successfully. Try upping the # of tries?'
+        end
+      end
+    end
+  end
+
+  autoload :Permissions
+  autoload :Messages
+  autoload :NullLogger
+  eager_autoload do
+    autoload :Configuration
+    autoload :Name
+  end
+
+  attr_writer :queue
+
+  def self.queue
+    @queue ||= config.queue.new('curation_concerns')
+  end
+end

data/lib/curation_concerns/name.rb

@@ -0,0 +1,20 @@
+module CurationConcerns
+  # A model name that provides routes that are namespaced to CurationConcerns,
+  # without changing the param key.
+  #
+  # Example:
+  #   name = CurationConcerns::Name.new(GenericWork)
+  #   name.param_key
+  #   # => 'generic_work'
+  #   name.route_key
+  #   # => 'curation_concerns_generic_works'
+  #
+  class Name < ActiveModel::Name
+    def initialize(klass, namespace = nil, name = nil)
+      super
+      @route_key          = "curation_concerns_#{ActiveSupport::Inflector.pluralize(@param_key)}"
+      @singular_route_key = ActiveSupport::Inflector.singularize(@route_key)
+      @route_key << "_index" if @plural == @singular
+    end
+  end
+end

data/lib/curation_concerns/null_logger.rb

@@ -0,0 +1,10 @@
+module CurationConcerns
+  class NullLogger < Logger
+    def initialize(*args)
+    end
+
+    # allows all the usual logger method calls (warn, info, error, etc.)
+    def add(*args, &block)
+    end
+  end
+end

data/lib/curation_concerns/rails/routes.rb

@@ -35,13 +35,11 @@ module ActionDispatch::Routing
       end
     end
 
-    # Used in conjunction with Hydra::Collections::Engine routes.
     # Adds routes for doing paginated searches within a collection's contents
     # @example in routes.rb:
-    #     mount Hydra::Collections::Engine => '/'
     #     curation_concerns_collections
     def curation_concerns_collections
-      resources :collections, only: :show do
+      resources :collections do
         member do
           get 'page/:page', action: :index
           get 'facet/:id', action: :facet, as: :dashboard_facet

data/lib/curation_concerns/version.rb

@@ -1,3 +1,3 @@
 module CurationConcerns
-  VERSION = "0.12.0.pre1".freeze
+  VERSION = "0.12.0.pre2".freeze
 end

data/lib/curation_concerns.rb

@@ -1,6 +1,8 @@
 require 'curation_concerns/version'
 require 'curation_concerns/engine'
 require 'curation_concerns/configuration'
+require 'curation_concerns/models'
+require 'curation_concerns/collections'
 require 'blacklight_advanced_search'
 require 'kaminari_route_prefix'
 

data/lib/generators/curation_concerns/abstract_migration_generator.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class CurationConcerns::AbstractMigrationGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(path)
+    if @prev_migration_nr
+      @prev_migration_nr += 1
+    else
+      last_migration = Dir[File.join(path, '*.rb')].sort.last
+      @prev_migration_nr = if last_migration
+                             last_migration.sub(File.join(path, '/'), '').to_i + 1
+                           else
+                             Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
+                           end
+    end
+    @prev_migration_nr.to_s
+  end
+
+  protected
+
+    def better_migration_template(file)
+      migration_template "migrations/#{file}", "db/migrate/#{file}"
+    rescue Rails::Generators::Error => e
+      say_status('warning', e.message, :yellow)
+    end
+end

data/lib/generators/curation_concerns/clamav_generator.rb

@@ -0,0 +1,19 @@
+# -*- encoding : utf-8 -*-
+require 'rails/generators'
+
+class CurationConcerns::ClamavGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  desc '
+This generator makes the following changes to your application:
+ 1. Generates clamav initializer
+       '
+
+  def banner
+    say_status('info', 'Generating clamav initializers', :blue)
+  end
+
+  def create_initializer_file
+    copy_file 'config/clamav.rb', 'config/initializers/clamav.rb'
+  end
+end

data/lib/generators/curation_concerns/collection_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+
+module CurationConcerns
+  class CollectionGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'This generator makes the following changes to your application:
+   1. Creates a collection model.
+'
+
+    def create_collection
+      copy_file 'app/models/collection.rb', 'app/models/collection.rb'
+    end
+  end
+end

data/lib/generators/curation_concerns/install_generator.rb

@@ -25,7 +25,7 @@ module CurationConcerns
       say_status('warning', '[CurationConcerns] GENERATING HYDRA-HEAD', :yellow)
       generate 'hydra:head -f'
       say_status('warning', '[CurationConcerns] GENERATING CURATION_CONCERNS MODELS', :yellow)
-      generate "curation_concerns:models:install#{options[:force] ? ' -f' : ''}"
+      generate "curation_concerns:models#{options[:force] ? ' -f' : ''}"
     end
 
     def inject_application_controller_behavior
@@ -51,7 +51,6 @@ module CurationConcerns
       gsub_file 'config/routes.rb', /root (:to =>|to:) "catalog#index"/, ''
 
       inject_into_file 'config/routes.rb', after: /devise_for :users\s*\n/ do
-        "  mount Hydra::Collections::Engine => '/'\n"\
         "  mount CurationConcerns::Engine, at: '/'\n"\
         "  resources :welcome, only: 'index'\n"\
         "  root 'welcome#index'\n"\

data/lib/generators/curation_concerns/models_generator.rb

@@ -0,0 +1,62 @@
+require_relative 'abstract_migration_generator'
+
+class CurationConcerns::ModelsGenerator < CurationConcerns::AbstractMigrationGenerator
+  source_root File.expand_path('../templates', __FILE__)
+  argument :model_name, type: :string, default: 'user'
+  desc '
+This generator makes the following changes to your application:
+ 1. Creates several database migrations if they do not exist in /db/migrate
+ 2. Creates the curation_concerns.rb configuration file and several others
+ 3. Creates the file_set.rb and collection.rb models
+       '
+  def banner
+    say_status('warning', 'GENERATING CURATION_CONCERNS MODELS', :yellow)
+  end
+
+  # Setup the database migrations
+  def copy_migrations
+    [
+      'create_version_committers.rb',
+      'create_checksum_audit_logs.rb',
+      'create_single_use_links.rb' # ,
+    ].each do |file|
+      better_migration_template file
+    end
+  end
+
+  # Add behaviors to the user model
+  def inject_curation_concerns_user_behavior
+    file_path = "app/models/#{model_name.underscore}.rb"
+    if File.exist?(file_path)
+      inject_into_file file_path, after: /include Hydra\:\:User.*$/ do
+        "\n  # Connects this user object to Curation Concerns behaviors." \
+        "\n  include CurationConcerns::User\n"
+      end
+    else
+      puts "     \e[31mFailure\e[0m  CurationConcerns requires a user object. This generators assumes that the model is defined in the file #{file_path}, which does not exist.  If you used a different name, please re-run the generator and provide that name as an argument. Such as \b  rails -g curation_concerns client"
+    end
+  end
+
+  def create_configuration_files
+    append_file 'config/initializers/mime_types.rb',
+                "\nMime::Type.register 'application/x-endnote-refer', :endnote", verbose: false
+    copy_file 'config/curation_concerns.rb', 'config/initializers/curation_concerns.rb'
+    copy_file 'config/redis.yml', 'config/redis.yml'
+    copy_file 'config/resque-pool.yml', 'config/resque-pool.yml'
+    copy_file 'config/redis_config.rb', 'config/initializers/redis_config.rb'
+    copy_file 'config/resque_config.rb', 'config/initializers/resque_config.rb'
+  end
+
+  def create_collection
+    copy_file 'app/models/collection.rb', 'app/models/collection.rb'
+  end
+
+  def create_file_set
+    copy_file 'app/models/file_set.rb', 'app/models/file_set.rb'
+  end
+
+  # Adds clamav initializtion
+  def clamav
+    generate 'curation_concerns:clamav'
+  end
+end

data/lib/generators/curation_concerns/templates/app/models/collection.rb

@@ -0,0 +1,6 @@
+# Generated by curation_concerns:models:install
+class Collection < ActiveFedora::Base
+  include ::CurationConcerns::CollectionBehavior
+  # You can replace these metadata if they're not suitable
+  include CurationConcerns::BasicMetadata
+end

data/lib/generators/curation_concerns/templates/app/models/file_set.rb

@@ -0,0 +1,4 @@
+# Generated by curation_concerns:models:install
+class FileSet < ActiveFedora::Base
+  include ::CurationConcerns::FileSetBehavior
+end

data/lib/generators/curation_concerns/templates/config/clamav.rb

@@ -0,0 +1 @@
+ClamAV.instance.loaddb if defined? ClamAV