Add --verbose and --dry-run option to tootctl media remove (#8519)

* Add --verbose and --dry-run options to CLI interface for removing remote media.

* Fix coding style problem.

diff --git a/lib/mastodon/media_cli.rb b/lib/mastodon/media_cli.rb
index 12ddb69764a0d919520131639a878718cf736c56..12ebdb774ce0ce2653a0358dda372096b8a08bc8 100644 (file)
--- a/lib/mastodon/media_cli.rb
+++ b/lib/mastodon/media_cli.rb
@@ -10,6 +10,8 @@ module Mastodon
   class MediaCLI < Thor
     option :days, type: :numeric, default: 7
     option :background, type: :boolean, default: false
+    option :verbose, type: :boolean, default: false
+    option :dry_run, type: :boolean, default: false
     desc 'remove', 'Remove remote media files'
     long_desc <<-DESC
       Removes locally cached copies of media attachments from other servers.
@@ -22,22 +24,27 @@ module Mastodon
       possible. In Sidekiq they will be processed with higher concurrency, but
       it may impact other operations of the Mastodon server, and it may overload
       the underlying file storage.
+
+      With the --verbose option, output deleting file ID to console (only when --background false).
+
+      With the --dry-run option, output the number of files to delete without deleting.
     DESC
     def remove
       time_ago  = options[:days].days.ago
       queued    = 0
       processed = 0
+      dry_run = options[:dry_run] ? '(DRY RUN)' : ''
 
       if options[:background]
         MediaAttachment.where.not(remote_url: '').where.not(file_file_name: nil).where('created_at < ?', time_ago).select(:id).reorder(nil).find_in_batches do |media_attachments|
           queued += media_attachments.size
-          Maintenance::UncacheMediaWorker.push_bulk(media_attachments.map(&:id))
+          Maintenance::UncacheMediaWorker.push_bulk(media_attachments.map(&:id)) unless options[:dry_run]
         end
       else
         MediaAttachment.where.not(remote_url: '').where.not(file_file_name: nil).where('created_at < ?', time_ago).reorder(nil).find_in_batches do |media_attachments|
           media_attachments.each do |m|
-            Maintenance::UncacheMediaWorker.new.perform(m)
-            say('.', :green, false)
+            Maintenance::UncacheMediaWorker.new.perform(m) unless options[:dry_run]
+            options[:verbose] ? say(m.id) : say('.', :green, false)
             processed += 1
           end
         end
@@ -46,9 +53,9 @@ module Mastodon
       say
 
       if options[:background]
-        say("Scheduled the deletion of #{queued} media attachments", :green)
+        say("Scheduled the deletion of #{queued} media attachments #{dry_run}.", :green)
       else
-        say("Removed #{processed} media attachments", :green)
+        say("Removed #{processed} media attachments #{dry_run}.", :green)
       end
     end
   end