sufia 6.0.0 → 6.1.0

data/app/assets/stylesheets/sufia/_styles.scss

@@ -54,6 +54,10 @@ button {
   margin: 20px;
 }
 
+.modal-title {
+  @extend h2
+}
+
 #footer {
   background: $blue-dark;
   clear: both;

data/app/controllers/admin/stats_controller.rb

@@ -0,0 +1,68 @@
+# -*- encoding : utf-8 -*-
+
+class Admin::StatsController < ApplicationController
+  def index
+    # total user count
+    @users_count = User.count
+
+    # The most recent users to join
+    @users_stats = params.fetch(:users_stats, {})
+    @recent_users = recent_users
+
+    # Query Solr for top depositors
+    @active_users = top_depositors
+
+    # Count of documents by permissions
+    @files_count = document_by_permission
+
+    # Query Solr for top file formats
+    @top_formats = top_formats
+
+    render 'index'
+  end
+
+  private
+
+    def top_depositors_count
+      count = params[:dep_count].to_i
+      count.in?(5..20) ? count : 5
+    end
+
+    def document_by_permission
+      files_count = {}
+      files_count[:total] = GenericFile.count
+      files_count[:public] = GenericFile.where(Solrizer.solr_name('read_access_group', :symbol) => 'public').count
+      files_count[:registered] = GenericFile.where(Solrizer.solr_name('read_access_group', :symbol) =>'registered').count
+      files_count[:private] = files_count[:total] - (files_count[:registered] + files_count[:public])
+      files_count
+    end
+
+    def top_depositors
+      depositor_key = Solrizer.solr_name('depositor', :stored_searchable, type: :string)
+      top_data(depositor_key, top_depositors_count)
+    end
+
+    def top_formats
+      format_key = Solrizer.solr_name('file_format', Solrizer::Descriptor.new(:string, :indexed, :multivalued))
+      top_data(format_key, 5)
+    end
+
+    def top_data (key, limit)
+      query_url = "#{ActiveFedora.solr_config[:url]}/terms?terms.fl=#{key}&terms.sort=count&terms.limit=#{limit}&wt=json&omitHeader=true"
+      # Parse JSON response (looks like {"terms":{"depositor_tesim":["mjg36",3]}} for depositor)
+      json = open(query_url).read
+      tuples = JSON.parse(json)['terms'][key] rescue []
+      # Change to hash where keys = logins and values = counts
+      Hash[*tuples]
+    end
+
+    def recent_users
+      # users since date
+      if @users_stats[:start_date]
+        return User.where('created_at >= ?',  @users_stats[:start_date])
+      end
+
+      # 5 most recent
+      User.order('created_at DESC').limit(5)
+    end
+end

data/app/controllers/api/items_controller.rb

@@ -0,0 +1,78 @@
+module API
+  # Adds an endpoint that consumes and RESTfully emits JSON from Arkivo
+  # representing new and updated Zotero-managed publications. An item in the
+  # Zotero parlance is mapped to a GenericFile in Sufia.
+  class ItemsController < ApplicationController
+    skip_before_action :verify_authenticity_token
+    before_filter :validate_item, only: [:create, :update]
+    before_filter :authorize_token
+    before_filter :my_load_and_authorize_resource, only: [:update, :destroy, :show]
+
+    attr_reader :item
+
+    def create
+      head :created, location: sufia.api_item_path(actor.create_file_from_item)
+    end
+
+    def update
+      actor.update_file_from_item(@file)
+      head :no_content
+    end
+
+    def destroy
+      actor.destroy_file(@file)
+      head :no_content
+    end
+
+    def show
+      head :no_content
+    end
+
+    private
+
+      def my_load_and_authorize_resource
+        @file = GenericFile.find(params[:id])
+
+        unless user.can? :edit, @file
+          return render plain: "#{user} lacks access to #{@file}", status: :unauthorized
+        end
+
+        if @file.arkivo_checksum.nil?
+          return render plain: "Forbidden: #{@file} not deposited via Arkivo", status: :forbidden
+        end
+      rescue ActiveFedora::ObjectNotFoundError
+        return render plain: "id '#{params[:id]}' not found", status: :not_found
+      end
+
+      def actor
+        Sufia::Arkivo::Actor.new(user, item)
+      end
+
+      def token
+        (request.get? || request.delete?) ? params[:token] : item['token']
+      end
+
+      def user
+        User.find_by(arkivo_token: token)
+      end
+
+      def validate_item
+        return render plain: 'no item parameter', status: :bad_request if params[:item].blank?
+        Sufia::Arkivo::SchemaValidator.new(params[:item]).call
+      rescue Sufia::Arkivo::InvalidItem => exception
+        return render plain: "invalid item parameter: #{exception.message}", status: :bad_request
+      else
+        @item = JSON.parse(params[:item])
+      end
+
+      def authorize_token
+        unless valid_token?
+          return render plain: "invalid user token: #{token}", status: :unauthorized
+        end
+      end
+
+      def valid_token?
+        user.present?
+      end
+  end
+end

data/app/controllers/api/zotero_controller.rb

@@ -0,0 +1,70 @@
+require 'oauth'
+
+module API
+  # Adds the ability to authenticate against Zotero's OAuth endpoint
+  class ZoteroController < ApplicationController
+    before_filter :authenticate_user!
+    before_filter :authorize_user!
+    before_filter :validate_params, only: :callback
+
+    def initiate
+      request_token = client.get_request_token(oauth_callback: callback_url)
+      session[:request_token] = request_token
+      current_user.zotero_token = request_token
+      current_user.save
+      redirect_to request_token.authorize_url({ identity: '1', oauth_callback: callback_url })
+    rescue OAuth::Unauthorized
+      redirect_to root_url, alert: 'Invalid Zotero client key pair'
+    end
+
+    def callback
+      access_token = current_token.get_access_token({ oauth_verifier: params['oauth_verifier'] })
+      # parse userID and API key out of token and store in user instance
+      current_user.zotero_userid = access_token.params[:userID]
+      current_user.save
+      Sufia.queue.push(Sufia::Arkivo::CreateSubscriptionJob.new(current_user.user_key))
+      redirect_to sufia.profile_path(current_user), notice: 'Successfully connected to Zotero!'
+    rescue OAuth::Unauthorized
+      redirect_to sufia.edit_profile_path(current_user.to_param), alert: 'Please re-authenticate with Zotero'
+    ensure
+      current_user.zotero_token = nil
+      current_user.save
+    end
+
+    private
+
+      def authorize_user!
+        authorize! :create, ::GenericFile
+      rescue CanCan::AccessDenied
+        return redirect_to root_url, alert: 'You are not authorized to perform this operation'
+      end
+
+      def validate_params
+        return redirect_to sufia.edit_profile_path(current_user.to_param), alert: "Malformed request from Zotero" if params[:oauth_token].blank? || params[:oauth_verifier].blank?
+        return redirect_to sufia.edit_profile_path(current_user.to_param), alert: "You have not yet connected to Zotero" if !current_token || current_token.params[:oauth_token] != params[:oauth_token]
+      end
+
+      def client
+        ::OAuth::Consumer.new(Sufia::Zotero.config['client_key'], Sufia::Zotero.config['client_secret'], options)
+      end
+
+      def current_token
+        current_user.zotero_token
+      end
+
+      def callback_url
+        "#{request.base_url}/api/zotero/callback"
+      end
+
+      def options
+        {
+          site: 'https://www.zotero.org',
+          scheme: :query_string,
+          http_method: :get,
+          request_token_path: '/oauth/request',
+          access_token_path: '/oauth/access',
+          authorize_path: '/oauth/authorize'
+        }
+      end
+  end
+end

data/app/controllers/authorities_controller.rb

@@ -4,11 +4,12 @@ require 'cgi'
 class AuthoritiesController < ApplicationController
   def query
     s = params.fetch("q", "")
-    hits = if params[:term] == "location"
-      GeoNamesResource.find_location(s)
-    else
-      LocalAuthority.entries_by_term(params[:model], params[:term], s) rescue []
-    end
+    hits =
+      if params[:term] == "location"
+        GeoNamesResource.find_location(s)
+      else
+        LocalAuthority.entries_by_term(params[:model], params[:term], s) rescue []
+      end
     render json: hits
   end
 end

data/app/controllers/concerns/sufia/batch_edits_controller_behavior.rb

@@ -84,7 +84,8 @@ module Sufia
     end
 
     def generic_file_params
-      Forms::BatchEditForm.model_attributes(params[:generic_file])
+      file_params = params[:generic_file] || ActionController::Parameters.new()
+      Forms::BatchEditForm.model_attributes(file_params)
     end
 
     def redirect_to_return_controller

data/app/controllers/concerns/sufia/breadcrumbs.rb

@@ -1,4 +1,4 @@
-  module Sufia
+module Sufia
   module Breadcrumbs
     extend ActiveSupport::Concern
 

data/app/controllers/concerns/sufia/depositors_controller_behavior.rb

@@ -7,6 +7,17 @@ module Sufia
       before_filter :validate_users, only: :create
     end
 
+
+    # Overriding the default behavior from Hydra::Core::ContorllerBehavior
+    def deny_access(exception)
+      if current_user and current_user.persisted?
+        redirect_to root_path, alert: exception.message
+      else
+        session['user_return_to'.freeze] = request.url
+        redirect_to new_user_session_path, alert: exception.message
+      end
+    end
+
     def create
       grantor = authorize_and_return_grantor
       grantee = ::User.from_url_component(params[:grantee_id])

data/app/controllers/concerns/sufia/files_controller/browse_everything.rb

@@ -24,7 +24,7 @@ module Sufia::FilesController
       # Generic utility for creating GenericFile from a URL
       # Used in to import files using URLs from a file picker like browse_everything 
       def create_file_from_url(url, file_name)
-        generic_file = ::GenericFile.new(import_url: url, label: file_name).tap do |gf|
+        ::GenericFile.new(import_url: url, label: file_name) do |gf|
           actor = Sufia::GenericFile::Actor.new(gf, current_user)
           actor.create_metadata(params[:batch_id])
           gf.save!

data/app/controllers/concerns/sufia/files_controller/local_ingest_behavior.rb

@@ -54,7 +54,7 @@ module Sufia
     def ingest_one(filename, unarranged)
       basename = File.basename(filename)
       # do not remove ::
-      generic_file = ::GenericFile.new(label: basename).tap do |gf|
+      ::GenericFile.new(label: basename) do |gf|
         gf.relative_path = filename if filename != basename
         actor = Sufia::GenericFile::Actor.new(gf, current_user)
         actor.create_metadata(params[:batch_id])

data/app/controllers/concerns/sufia/files_controller_behavior.rb

@@ -39,16 +39,27 @@ module Sufia
       before_filter :has_access?, except: [:show]
       before_filter :build_breadcrumbs, only: [:show, :edit, :stats]
       load_resource only: [:audit]
-      load_and_authorize_resource except: [:index, :audit]
+      load_and_authorize_resource except: [:index, :audit, :show]
+
+      # since we are only displaying data we are makingthe show action fast by loading the information from solr
+      # these two steps replace load_and_authorize_resource for the show action
+      before_filter :load_resource_from_solr, only: [:show]
+      authorize_resource only: [:show]
 
       class_attribute :edit_form_class, :presenter_class
       self.edit_form_class = Sufia::Forms::GenericFileEditForm
       self.presenter_class = Sufia::GenericFilePresenter
     end
 
+    # Load the GenericFile from solr instead of fedora
+    # this replaces the load_resource from CanCan that is usually called by load_and_authorize_resource
+    def load_resource_from_solr
+      @generic_file = ::GenericFile.load_instance_from_solr(params[:id])
+    end
+
     # routed to /files/new
     def new
-      @batch_id = Sufia::IdService.mint
+      @batch_id = ActiveFedora::Noid::Service.new.mint
     end
 
     # routed to /files/:id/edit
@@ -118,15 +129,16 @@ module Sufia
 
     # routed to /files/:id (PUT)
     def update
-      success = if wants_to_revert?
-        update_version
-      elsif wants_to_upload_new_version?
-        update_file
-      elsif params.has_key? :generic_file
-        update_metadata
-      elsif params.has_key? :visibility
-        update_visibility
-      end
+      success =
+        if wants_to_revert?
+          update_version
+        elsif wants_to_upload_new_version?
+          update_file
+        elsif params.has_key? :generic_file
+          update_metadata
+        elsif params.has_key? :visibility
+          update_visibility
+        end
 
       if success
         redirect_to sufia.edit_generic_file_path(tab: params[:redirect_tab]), notice:

data/app/controllers/concerns/sufia/my_controller_behavior.rb

@@ -11,6 +11,7 @@ module Sufia
       include Blacklight::Configurable
 
       self.copy_blacklight_config_from(CatalogController)
+      self.blacklight_config.search_builder_class = Sufia::MySearchBuilder
       
       before_filter :authenticate_user!
       before_filter :enforce_show_permissions, only: :show
@@ -54,12 +55,5 @@ module Sufia
       end
     end
 
-    protected
-
-    # show only files with edit permissions in lib/hydra/access_controls_enforcement.rb apply_gated_discovery
-    def discovery_permissions
-      ["edit"]
-    end
-
   end
 end

data/app/controllers/concerns/sufia/users_controller_behavior.rb

@@ -58,7 +58,7 @@ module Sufia::UsersControllerBehavior
     end
     # TODO this should be moved to TrophiesController
     params.keys.select {|k, v| k.starts_with? 'remove_trophy_' }.each do |smash_trophy|
-      smash_trophy = smash_trophy.sub /^remove_trophy_/, ''
+      smash_trophy = smash_trophy.sub(/^remove_trophy_/, '')
       current_user.trophies.where(generic_file_id: smash_trophy).destroy_all
     end
     Sufia.queue.push(UserEditProfileEventJob.new(@user.user_key))
@@ -114,7 +114,6 @@ module Sufia::UsersControllerBehavior
       :twitter_handle, :googleplus_handle, :linkedin_handle, :remove_avatar, :orcid)
   end
 
-
   # You can override base_query to return a list of arguments
   def base_query
     [nil]

data/app/controllers/my/collections_controller.rb

@@ -2,6 +2,7 @@ module My
   class CollectionsController < MyController
 
     self.search_params_logic += [
+      :show_only_resources_deposited_by_current_user,
       :show_only_collections
     ]
 

data/app/controllers/my/files_controller.rb

@@ -2,7 +2,7 @@ module My
   class FilesController < MyController
 
     self.search_params_logic += [
-      :show_only_files_deposited_by_current_user,
+      :show_only_resources_deposited_by_current_user,
       :show_only_generic_files
     ]
 

data/app/helpers/sufia/sufia_helper_behavior.rb

@@ -4,15 +4,24 @@ module Sufia
       "#{image_tag 'orcid.png', { alt: t('sufia.user_profile.orcid.alt'), class: style_class }} #{t('sufia.user_profile.orcid.label')}".html_safe
     end
 
+    def zotero_label(opts={})
+      html_class = opts[:html_class] || ''
+      "#{image_tag 'zotero.png', { alt: t('sufia.user_profile.zotero.alt'), class: html_class }} #{t('sufia.user_profile.zotero.label')}".html_safe
+    end
+
+    def zotero_profile_url(zotero_user_id)
+      "https://www.zotero.org/users/#{zotero_user_id}"
+    end
+
     def error_messages_for(object)
       if object.try(:errors) and object.errors.full_messages.any?
         content_tag(:div, class: 'alert alert-block alert-error validation-errors') do
           content_tag(:h4, I18n.t('sufia.errors.header', model: object.class.model_name.human.downcase), class: 'alert-heading') +
             content_tag(:ul) do
-            object.errors.full_messages.map do |message|
-              content_tag(:li, message)
-            end.join('').html_safe
-          end
+              object.errors.full_messages.map do |message|
+                content_tag(:li, message)
+              end.join('').html_safe
+            end
         end
       else
         '' # return empty string
@@ -37,13 +46,15 @@ module Sufia
 
       # file
       else
-        path = if document.image? || document.pdf? || document.video? || document.office_document?
-          sufia.download_path document, file: 'thumbnail'
-        elsif document.audio?
-          "audio.png"
-        else
-          "default.png"
-        end
+        path =
+          if document.image? || document.pdf? || document.video? || document.office_document?
+            sufia.download_path document, file: 'thumbnail'
+          elsif document.audio?
+            "audio.png"
+          else
+            "default.png"
+          end
+        options[:alt] = " "
         image_tag path, options
       end
     end
@@ -110,11 +121,12 @@ module Sufia
       user = ::User.find_by_user_key(login)
       return login if user.nil?
 
-      text = if user.respond_to? :name
-        user.name
-      else
-        login
-      end
+      text =
+        if user.respond_to? :name
+          user.name
+        else
+          login
+        end
 
       link_to text, Sufia::Engine.routes.url_helpers.profile_path(user)
     end