sufia 6.3.0 → 6.4.0

data/app/jobs/content_new_version_event_job.rb

@@ -1,18 +1,6 @@
-class ContentNewVersionEventJob < EventJob
-  def run
-    gf = GenericFile.find(generic_file_id)
-    action = "User #{link_to_profile depositor_id} has added a new version of #{link_to gf.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(gf)}"
-    timestamp = Time.now.to_i
-    depositor = User.find_by_user_key(depositor_id)
-    # Create the event
-    event = depositor.create_event(action, timestamp)
-    # Log the event to the depositor's profile stream
-    depositor.log_profile_event(event)
-    # Log the event to the GF's stream
-    gf.log_event(event)
-    # Fan out the event to all followers who have access
-    depositor.followers.select { |user| user.can? :read, gf }.each do |follower|
-      follower.log_event(event)
-    end
+# A specific job to log a file new version to a user's activity stream
+class ContentNewVersionEventJob < ContentEventJob
+  def action
+    @action ||= "User #{link_to_profile depositor_id} has added a new version of #{link_to generic_file.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(generic_file)}"
   end
 end

data/app/jobs/content_restored_version_event_job.rb

@@ -1,26 +1,13 @@
-class ContentRestoredVersionEventJob < EventJob
+# A specific job to log a file restored version to a user's activity stream
+class ContentRestoredVersionEventJob < ContentEventJob
   attr_accessor :revision_id
 
   def initialize(generic_file_id, depositor_id, revision_id)
-    self.generic_file_id = generic_file_id
-    self.depositor_id = depositor_id
-    self.revision_id = revision_id
+    super(generic_file_id, depositor_id)
+    @revision_id = revision_id
   end
 
-  def run
-    gf = GenericFile.find(generic_file_id)
-    action = "User #{link_to_profile depositor_id} has restored a version '#{revision_id}' of #{link_to gf.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(gf)}"
-    timestamp = Time.now.to_i
-    depositor = User.find_by_user_key(depositor_id)
-    # Create the event
-    event = depositor.create_event(action, timestamp)
-    # Log the event to the depositor's profile stream
-    depositor.log_profile_event(event)
-    # Log the event to the GF's stream
-    gf.log_event(event)
-    # Fan out the event to all followers who have access
-    depositor.followers.select { |user| user.can? :read, gf }.each do |follower|
-      follower.log_event(event)
-    end
+  def action
+    @action ||= "User #{link_to_profile depositor_id} has restored a version '#{revision_id}' of #{link_to generic_file.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(generic_file)}"
   end
 end

data/app/jobs/content_update_event_job.rb

@@ -1,18 +1,6 @@
-class ContentUpdateEventJob < EventJob
-  def run
-    gf = GenericFile.find(generic_file_id)
-    action = "User #{link_to_profile depositor_id} has updated #{link_to gf.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(gf)}"
-    timestamp = Time.now.to_i
-    depositor = User.find_by_user_key(depositor_id)
-    # Create the event
-    event = depositor.create_event(action, timestamp)
-    # Log the event to the depositor's profile stream
-    depositor.log_profile_event(event)
-    # Log the event to the GF's stream
-    gf.log_event(event)
-    # Fan out the event to all followers who have access
-    depositor.followers.select { |user| user.can? :read, gf }.each do |follower|
-      follower.log_event(event)
-    end
+# A specific job to log a file content update to a user's activity stream
+class ContentUpdateEventJob < ContentEventJob
+  def action
+    @action ||= "User #{link_to_profile depositor_id} has updated #{link_to generic_file.title.first, Sufia::Engine.routes.url_helpers.generic_file_path(generic_file)}"
   end
 end

data/app/jobs/event_job.rb

@@ -1,3 +1,9 @@
+# A generic job for sending events to a user and their followers.
+#
+# This class does not implement a usable action, so it must be implemented in a child class
+#
+# @attr [String] depositor_id  the user the event is specified for
+#
 class EventJob
   include Rails.application.routes.url_helpers
   include ActionView::Helpers
@@ -5,14 +11,52 @@ class EventJob
   include Hydra::AccessControlsEnforcement
   include SufiaHelper
 
+  # queue to run the job on
   def queue_name
     :event
   end
 
-  attr_accessor :generic_file_id, :depositor_id
+  attr_accessor :depositor_id
 
-  def initialize(generic_file_id, depositor_id)
-    self.generic_file_id = generic_file_id
-    self.depositor_id = depositor_id
+  # @param the id of the user to create the event for
+  def initialize(depositor_id)
+    @depositor_id = depositor_id
+  end
+
+  # Method used to cause the event to be created
+  def run
+    # Log the event to the depositor's profile stream
+    log_user_event
+
+    # Fan out the event to all followers who have access
+    log_to_followers
+  end
+
+  # override to provide your specific action for the event you are logging
+  # @abstract
+  def action
+    raise(NotImplementedError, "#action should be implemented by an child class of EventJob")
+  end
+
+  # create an event with an action and a timestamp for the user
+  def event
+    @event ||= depositor.create_event(action, Time.now.to_i)
+  end
+
+  # the user that will be the subject of the event
+  def depositor
+    @depositor ||= User.find_by_user_key(depositor_id)
+  end
+
+  # log the event to the users event stream
+  def log_user_event
+    depositor.log_event(event)
+  end
+
+  # log the event to the users followers
+  def log_to_followers
+    depositor.followers.each do |follower|
+      follower.log_event(event)
+    end
   end
 end

data/app/jobs/user_edit_profile_event_job.rb

@@ -1,21 +1,8 @@
+# A specific job to log a user profile edit to a user's activity stream
 class UserEditProfileEventJob < EventJob
-  attr_accessor :editor_id
+  alias_attribute :editor_id, :depositor_id
 
-  def initialize(editor_id)
-    self.editor_id = editor_id
-  end
-
-  def run
-    action = "User #{link_to_profile editor_id} has edited his or her profile"
-    timestamp = Time.now.to_i
-    editor = User.find_by_user_key(editor_id)
-    # Create the event
-    event = editor.create_event(action, timestamp)
-    # Log the event to the editor's stream
-    editor.log_event(event)
-    # Fan out the event to all followers
-    editor.followers.each do |user|
-      user.log_event(event)
-    end
+  def action
+    @action ||= "User #{link_to_profile editor_id} has edited his or her profile"
   end
 end

data/app/jobs/user_follow_event_job.rb

@@ -1,23 +1,21 @@
+# A specific job to log a user following another user to a user's activity stream
 class UserFollowEventJob < EventJob
-  attr_accessor :follower_id, :followee_id
+  attr_accessor :followee_id
+  alias_attribute :follower_id, :depositor_id
 
   def initialize(follower_id, followee_id)
-    self.follower_id = follower_id
-    self.followee_id = followee_id
+    super(follower_id)
+    @followee_id = followee_id
   end
 
   def run
-    # Create the event
-    follower = User.find_by_user_key(follower_id)
-    event = follower.create_event("User #{link_to_profile follower_id} is now following #{link_to_profile followee_id}", Time.now.to_i)
-    # Log the event to the follower's stream
-    follower.log_event(event)
+    super
     # Fan out the event to followee
     followee = User.find_by_user_key(followee_id)
     followee.log_event(event)
-    # Fan out the event to all followers
-    follower.followers.each do |user|
-      user.log_event(event)
-    end
+  end
+
+  def action
+    @action ||= "User #{link_to_profile follower_id} is now following #{link_to_profile followee_id}"
   end
 end

data/app/jobs/user_unfollow_event_job.rb

@@ -1,25 +1,20 @@
+# A specific job to log a user unfollowing another user to a user's activity stream
 class UserUnfollowEventJob < EventJob
-  attr_accessor :unfollower_id, :unfollowee_id
+  attr_accessor :unfollowee_id
+  alias_attribute :unfollower_id, :depositor_id
 
   def initialize(unfollower_id, unfollowee_id)
-    self.unfollower_id = unfollower_id
-    self.unfollowee_id = unfollowee_id
+    super(unfollower_id)
+    @unfollowee_id = unfollowee_id
   end
 
   def run
-    action = "User #{link_to_profile unfollower_id} has unfollowed #{link_to_profile unfollowee_id}"
-    timestamp = Time.now.to_i
-    unfollower = User.find_by_user_key(unfollower_id)
-    # Create the event
-    event = unfollower.create_event(action, timestamp)
-    # Log the event to the unfollower's stream
-    unfollower.log_event(event)
-    # Fan out the event to unfollowee
+    super
     unfollowee = User.find_by_user_key(unfollowee_id)
     unfollowee.log_event(event)
-    # Fan out the event to all followers
-    unfollower.followers.each do |user|
-      user.log_event(event)
-    end
+  end
+
+  def action
+    @action ||= "User #{link_to_profile unfollower_id} has unfollowed #{link_to_profile unfollowee_id}"
   end
 end

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

@@ -45,7 +45,17 @@ module Sufia
       return unless field.present?
       begin
         Date.parse(field).to_formatted_s(:standard)
-      rescue
+      rescue ArgumentError
+        ActiveFedora::Base.logger.info "Unable to parse date: #{field.first.inspect} for #{self['id']}"
+      end
+    end
+
+    def create_date
+      field = self[CatalogController.uploaded_field]
+      return unless field.present?
+      begin
+        Date.parse(field).to_formatted_s(:standard)
+      rescue ArgumentError
         ActiveFedora::Base.logger.info "Unable to parse date: #{field.first.inspect} for #{self['id']}"
       end
     end

data/app/models/system_stats.rb

@@ -0,0 +1,108 @@
+# A class that retrieves system level statistics about the system
+#
+# @attr_reader int limit      limits the results returned from top_depositors and top_formats
+#                             Default is 5, maximum is 20, minimum is 5
+# @attr_reader int start_date Filters the statistics returned by the class to after the start date
+#                             blank means no filter
+# @attr_reader int end_date   Filters the statistics returned by the class to before end date (end of day)
+#                             blank means today
+class SystemStats
+  attr_reader :limit, :start_date, :end_date
+
+  # initialize the stats class setting the limitations
+  #
+  # @attr_reader int limit      limits the results returned from top_depositors and top_formats
+  #                             Default is 5, maximum is 20, minimum is 5
+  # @attr_reader int start_date Filters the statistics returned by the class to after the start date
+  #                             blank means no filter
+  # @attr_reader int end_date   Filters the statistics returned by the class to before end date (end of day)
+  #                             blank means today
+  def initialize(limit_records = 5, start_date_str = nil, end_date_str = nil)
+    @limit = validate_limit(limit_records)
+    @start_date = DateTime.parse(start_date_str) unless start_date_str.blank?
+    @end_date = DateTime.parse(end_date_str).end_of_day unless end_date_str.blank?
+  end
+
+  # returns the total files in the system filtered by the start_date and end_date if present
+  #
+  # @return [Hash] A hash with the total files by permission for the system
+  # @option [Number] :total Total number of files without regard to permissions
+  # @option [Number] :public Total number of files that have public permissions
+  # @option [Number] :registered Total number of files that have registered (logged in) permissions
+  # @option [Number] :private Total number of files that have private permissions
+  def document_by_permission
+    return document_by_date_by_permission if start_date
+
+    files_count = {}
+    files_count[:total] = ::GenericFile.count
+    files_count[:public] = ::GenericFile.where_public.count
+    files_count[:registered] = ::GenericFile.where_registered.count
+    files_count[:private] = files_count[:total] - (files_count[:registered] + files_count[:public])
+    files_count
+  end
+
+  # returns a list (of size limit) of system users (depositors) that have the most deposits in the system
+  # @return [Hash] a hash with the user name as the key and the number of deposits as the value
+  #    { 'cam156' => 25, 'hjc14' => 24 ... }
+  def top_depositors
+    depositor_key = Solrizer.solr_name('depositor', :stored_searchable, type: :string)
+    top_data(depositor_key, limit)
+  end
+
+  # returns a list (of size limit) of file formats (mime_types) that have the most files in the system
+  # @return [Hash] a hash with the file format as the key and the number of files as the value
+  #    { 'png' => 25, 'pdf' => 24 ... }
+  def top_formats
+    format_key = Solrizer.solr_name('file_format', Solrizer::Descriptor.new(:string, :indexed, :multivalued))
+    top_data(format_key, limit)
+  end
+
+  # returns [Array<user>] a list (of size limit) of users most recently registered with the system
+  #
+  def recent_users
+    # no dates return the top few based on limit
+    return ::User.order('created_at DESC').limit(limit) if start_date.blank?
+
+    ::User.recent_users start_date, end_date
+  end
+
+  # returns [Number] the number of currently registered users
+  #
+  def users_count
+    ::User.count
+  end
+
+  private
+
+    def validate_limit(count)
+      if count.blank? || count < 5
+        5
+      elsif count > 20
+        20
+      else
+        count
+      end
+    end
+
+    def document_by_date_by_permission
+      files_count = {}
+      files_count[:total] = ::GenericFile.find_by_date_created(start_date, end_date).count
+      files_count[:public] = ::GenericFile.find_by_date_created(start_date, end_date).merge(::GenericFile.where_public).count
+      files_count[:registered] = ::GenericFile.find_by_date_created(start_date, end_date).merge(::GenericFile.where_registered).count
+      files_count[:private] = files_count[:total] - (files_count[:registered] + files_count[:public])
+      files_count
+    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
+      begin
+        tuples = JSON.parse(json)['terms'][key]
+      rescue
+        []
+      end
+      # Change to hash where keys = logins and values = counts
+      Hash[*tuples]
+    end
+end

data/app/presenters/sufia/admin_stats_presenter.rb

@@ -0,0 +1,49 @@
+module Sufia
+  class AdminStatsPresenter
+    attr_accessor :depositors, :deposit_stats
+    attr_reader :limit, :start_date, :end_date, :stats_filters
+
+    def initialize(stats_filters, limit)
+      @stats_filters = stats_filters
+      @start_date = stats_filters[:start_date]
+      @end_date = stats_filters[:end_date]
+      @limit = limit
+    end
+
+    def recent_users
+      @recent_users ||= stats.recent_users
+    end
+
+    def active_users
+      @active_users ||= stats.top_depositors
+    end
+
+    def top_formats
+      @top_formats ||= stats.top_formats
+    end
+
+    def files_count
+      @files_count ||= stats.document_by_permission
+    end
+
+    def users_count
+      @users_count ||= stats.users_count
+    end
+
+    def date_filter_string
+      if start_date.blank?
+        "unfiltered"
+      elsif end_date.blank?
+        "#{start_date} to #{Date.current}"
+      else
+        "#{start_date} to #{end_date}"
+      end
+    end
+
+    private
+
+      def stats
+        @stats ||= ::SystemStats.new(limit, start_date, end_date)
+      end
+  end
+end

data/app/views/_controls.html.erb

@@ -3,7 +3,7 @@
     <div class="col-xs-12 col-sm-5 col-md-6">
       <nav class="navbar navbar-default" role="navigation">
         <ul class="nav navbar-nav">
-            <li <%= 'class=active' if current_page?(root_path) %>><a href="<%= root_path %>">Home</a></li>
+            <li <%= 'class=active' if current_page?(sufia.root_path) %>><a href="<%= sufia.root_path %>">Home</a></li>
             <li <%= 'class=active' if current_page?(sufia.about_path) %>><a href="<%= sufia.about_path %>">About</a></li>
             <li <%= 'class=active' if action_name == "help" %>><a href="<%= sufia.static_path('help') %>">Help</a></li>
             <li <%= 'class=active' if current_page?(sufia.contact_path) %>><a href="<%= sufia.contact_path %>">Contact</a></li>

data/app/views/_footer.html.erb

@@ -1,7 +1,7 @@
 <div id="footer" class="container-fluid">
   <div class="row">
   <div class="col-xs-12 col-sm-5">
-      <p class="pull-left">A service of Project Hydra.</p>
+      <p class="pull-left">A service of <a href="http://projecthydra.org/" target="_blank">Project Hydra</a>.</p>
       <p>v.<%= Sufia::VERSION %></p>
   </div>
     <div class="col-xs-12 col-sm-7">