CleanCache BAC now created by portal

The old code used to send a message to each Bourreau with
a bunch of params to identify which files to clean. Then the
bourreau would create a BAC object.

In this new code, the portal no longer contacts the Bourreau,
it just creates the BAC directly. Lots of old code was cleaned.

Author: prioux

BrainPortal/app/controllers/bourreaux_controller.rb

@@ -573,6 +573,13 @@ def cache_disk_usage
   def cleanup_caches
     flash[:notice] ||= ""
 
+    # Time:     Present ............................................................ Past
+    # In Words: now .......... older_limit ..... younger_limit ................. long ago
+    # Num Secs: 0 secs ago ................. < ........................ infinite secs ago
+    # Vars:     ............. cleanup_older  < cleanup_younger ..........................
+    #
+    #                          |---- files to be deleted ----|
+
     # First param is cleanup_older, which is the number
     # of second before NOW at which point files OLDER than
     # that become eligible for elimination
@@ -630,17 +637,37 @@ def cleanup_caches
       rrid_to_userids[remote_resource_id][user_id] = true
     end
 
-    # Send the cleanup message
+    # Loop through each remote resource, and create the BACs for cleanup
     rrid_to_userids.each_key do |rrid|
       remote_resource = RemoteResource.find(rrid)
       userlist = rrid_to_userids[rrid]  # uid => true, uid => true ...
-      userids = userlist.keys.each { |uid| uid.to_s }.join(",")  # "uid,uid,uid"
-      flash[:notice] += "\n" unless flash[:notice].blank?
-      begin
-        remote_resource.send_command_clean_cache(current_user.id,userids,typeslist,cleanup_older.seconds.ago,cleanup_younger.seconds.ago)
-        flash[:notice] += "Sending cleanup command to #{remote_resource.name}."
-      rescue
-        flash[:notice] += "Could not contact #{remote_resource.name}."
+      userids  = userlist.keys
+
+      # Identify what to clean
+      syncs = SyncStatus.where( :remote_resource_id => rrid)
+      syncs = syncs.where([ "sync_status.accessed_at < ?", cleanup_older.seconds.ago])
+      syncs = syncs.where([ "sync_status.accessed_at > ?", cleanup_younger.seconds.ago])
+      syncs = syncs.joins(:userfile)                            if userids.present? || typeslist.present?
+      syncs = syncs.where( 'userfiles.user_id' => userids )     if userids.present?
+      syncs = syncs.where( 'userfiles.type'    => typeslist )   if typeslist.present?
+      userfile_ids = syncs.pluck(:userfile_id)
+
+      col = BacItemsCollector.new(
+        BackgroundActivity::CleanCache.new(
+          :user_id            => current_user.id,
+          :remote_resource_id => rrid,
+          :status             => 'InProgress',
+        ),
+        500,
+      )
+
+      # Let the collector create one or several BACs
+      col.add_items(userfile_ids)
+      col.flush
+
+      if col.submitted_bac_ids.present?
+        flash[:notice] += "\n" unless flash[:notice].blank?
+        flash[:notice] += "Creating CleanCache background operation request for #{remote_resource.name}."
       end
     end
 

BrainPortal/app/models/remote_command.rb

@@ -43,7 +43,7 @@ class RemoteCommand < RestrictedHash
     # An ID, usually assigned by the receiver.
     :id,
 
-    # Command keyword, one of 'clean_cache', 'stop_workers', 'start_workers',
+    # Command keyword, one of 'stop_workers', 'start_workers',
     # etc. On the receiving end, the method "process_command_#{:command}"
     # will be executed with the current command object.
     :command,
@@ -69,23 +69,6 @@ class RemoteCommand < RestrictedHash
     :script_text,     # filled by receiver
     :runtime_info,    # filled by receiver
 
-    # -------- CLEAN CACHE PARAMETERS --------
-
-    # Which users are 'involved' in the command; only used for clean_cache
-    # right now. Numeric ids as string. "3,4,5" or "all".
-    :user_ids,
-
-    # Not really used right now
-    :group_ids,
-
-    # Userfile types, single string with commas.
-    :types,
-
-    # Date of effect; for clean_cache it means cleans files older than this..
-    :before_date,  # Time object
-    # ... but younger than this are erased.
-    :after_date,   # Time object
-
     # -------- CHECK DATA PROVIDERS PARAMETERS --------
 
     :data_provider_ids,    # an input for the command, a list of DP ids as string. "1,2,3"
@@ -118,12 +101,6 @@ def inspect #:nodoc:
       report += "  Cluster-Stdout: #{(self.cluster_stdout || "").size} bytes\n"
       report += "  Cluster-Stderr: #{(self.cluster_stderr || "").size} bytes\n"
       report += "  Script-Text: #{(self.script_text || "").size} bytes\n"
-    elsif self.command.to_s == 'clean_cache'
-      report += "  User-IDs: #{self.user_ids}\n"
-      report += "  Group-IDs: #{self.group_ids}\n"
-      report += "  Types: #{self.types}\n"
-      report += "  Before-Date: #{self.before_date}\n"
-      report += "  After-Date: #{self.after_date}\n"
     elsif self.command.to_s == 'check_data_providers'
       report += "  Data-Provider-IDs: #{(self.data_provider_ids || []).join(", ")}\n"
     end

BrainPortal/app/models/remote_resource.rb

@@ -651,36 +651,6 @@ def zap_info_cache
   # Utility Shortcuts To Send Commands
   ############################################################################
 
-  # Utility method to send a clean_cache command to a
-  # RemoteResource, whether local or not.
-  def send_command_clean_cache(userid,userlist,typelist,older_than,younger_than)
-    if older_than.is_a?(Integer)
-       time_older = older_than.seconds.ago
-    elsif older_than.is_a?(Time)
-       time_older = older_than
-    else
-       cb_error "Invalid older_than time offset for clean_cache command."
-    end
-    if younger_than.is_a?(Integer)
-       time_younger = younger_than.seconds.ago
-    elsif younger_than.is_a?(Time)
-       time_younger = younger_than
-    else
-       cb_error "Invalid younger_than offset for clean_cache command."
-    end
-    userlist = [ userlist ] unless userlist.is_a?(Array)
-    useridlist = userlist.map { |u| u.is_a?(User) ? u.id.to_s : u.to_s }.join(",")
-    command = RemoteCommand.new(
-      :requester_user_id => userid,
-      :command     => 'clean_cache',
-      :user_ids    => useridlist,
-      :types       => Array(typelist).join(","),
-      :before_date => time_older,
-      :after_date  => time_younger
-    )
-    send_command(command)
-  end
-
   # Utility method to send a +check_data_providers+ command to a
   # RemoteResource, whether local or not. dp_ids should be
   # an array of Data Provider IDs. The command
@@ -873,48 +843,6 @@ def self.process_command_check_data_providers(command)
     true
   end
 
-  # Clean the cached files of a list of users, for files
-  # last accessed before the +before_date+ ; the task
-  # is started in background, as it can be long.
-  def self.process_command_clean_cache(command)
-
-    myself = RemoteResource.current_resource
-
-    user_id     = command.requester_user_id || AdminUser.first.id
-    user_ids    = command.user_ids.presence
-    before_date = command.before_date.presence
-    after_date  = command.after_date.presence
-    types       = command.types.presence
-
-    user_id_list = user_ids ? user_ids.split(",") : nil
-    types_list   = types    ? types.split(",")    : nil
-
-    # Identify what to clean
-    syncs = SyncStatus.where( :remote_resource_id => RemoteResource.current_resource.id )
-    syncs = syncs.where([ "sync_status.accessed_at < ?", before_date])          if before_date
-    syncs = syncs.where([ "sync_status.accessed_at > ?", after_date])           if after_date
-    syncs = syncs.joins(:userfile)                                              if user_id_list || types_list
-    syncs = syncs.where( 'userfiles.user_id' => user_id_list )                  if user_id_list
-    syncs = syncs.where( 'userfiles.type'    => types_list )                    if types_list
-    userfile_ids = syncs.pluck(:userfile_id)
-
-    # Create the collector object
-    col = BacItemsCollector.new(
-      BackgroundActivity::CleanCache.new(
-        :user_id            => user_id,
-        :remote_resource_id => myself.id,
-        :status             => 'InProgress',
-      ),
-      500,
-    )
-
-    # Let the collector create one or several BACs
-    col.add_items(userfile_ids)
-    col.flush
-
-    true
-  end
-
   # This installs a pair of private/public SSH keys
   # for a user. The key pair has been created by another
   # CBRAIN app which sent this command to install a copy