discourse/script/discourse

291 lines
8.4 KiB
Ruby
Executable File

#!/usr/bin/env ruby
# frozen_string_literal: true
require "thor"
class DiscourseCLI < Thor
def self.exit_on_failure?
true
end
desc "remap [--global,--regex] FROM TO", "Remap a string sequence across all tables"
long_desc <<-LONGDESC
Replace a string sequence FROM with TO across all tables.
With --global option, the remapping is run on ***ALL***
databases. Instead of just running on the current database, run on
every database on this machine. This option is useful for
multi-site setups.
With --regex option, use PostgreSQL function regexp_replace to do
the remapping. Enabling this interprets FROM as a PostgreSQL
regular expression. TO can contain references to captures in the
FROM match. See the "Regular Expression Details" section and
"regexp_replace" documentation in the PostgreSQL manual for more
details.
Examples:
discourse remap talk.foo.com talk.bar.com # renaming a Discourse domain name
discourse remap --regex "\[\/?color(=[^\]]*)*]" "" # removing "color" bbcodes
LONGDESC
option :global, type: :boolean
option :regex, type: :boolean
def remap(from, to)
load_rails
require 'db_helper'
if options[:regex]
puts "Rewriting all occurrences of #{from} to #{to} using regexp_replace"
else
puts "Rewriting all occurrences of #{from} to #{to}"
end
puts "THIS TASK WILL REWRITE DATA, ARE YOU SURE (type YES)"
puts "WILL RUN ON ALL #{RailsMultisite::ConnectionManagement.all_dbs.length} DBS" if options[:global]
text = STDIN.gets
if text.strip != "YES"
puts "aborting."
exit 1
end
if options[:global]
RailsMultisite::ConnectionManagement.each_connection do |db|
puts "", "Remapping tables on #{db}...", ""
do_remap(from, to, options[:regex])
end
else
do_remap(from, to, options[:regex])
end
end
desc "backup", "Backup a discourse forum"
def backup(filename = nil)
load_rails
require "backup_restore"
require "backup_restore/backuper"
store = BackupRestore::BackupStore.create
if filename
destination_directory = File.dirname(filename).sub(/^\.$/, '')
if destination_directory.present? && store.remote?
puts "Only local backup storage supports paths."
exit(1)
end
filename_without_extension = File.basename(filename).sub(/\.(sql\.)?(tar\.gz|t?gz)$/i, '')
end
puts "Starting backup..."
backuper = BackupRestore::Backuper.new(Discourse.system_user.id, filename: filename_without_extension)
backup_filename = backuper.run
exit(1) unless backuper.success
puts "Backup done."
if store.remote?
location = BackupLocationSiteSetting.values.find { |v| v[:value] == SiteSetting.backup_location }
location = I18n.t("admin_js.#{location[:name]}") if location
puts "Output file is stored on #{location} as #{backup_filename}", ""
else
backup = store.file(backup_filename, include_download_source: true)
if destination_directory.present?
puts "Moving backup file..."
backup_path = File.join(destination_directory, backup_filename)
FileUtils.mv(backup.source, backup_path)
else
backup_path = backup.source
end
puts "Output file is in: #{backup_path}", ""
end
end
desc "export", "Backup a Discourse forum"
def export
backup
end
desc "restore", "Restore a Discourse backup"
option :disable_emails, type: :boolean, default: true
option :location, type: :string, enum: ["local", "s3"], desc: "Override the backup location"
def restore(filename = nil)
if File.exist?('/usr/local/bin/discourse')
discourse = 'discourse'
else
discourse = './script/discourse'
end
load_rails
require "backup_restore"
require "backup_restore/restorer"
require "backup_restore/backup_store"
if !filename
puts "You must provide a filename to restore. Did you mean one of the following?\n\n"
store = BackupRestore::BackupStore.create(location: options[:location])
store.files.each do |file|
puts "#{discourse} restore #{file.filename}"
end
return
end
begin
puts "Starting restore: #{filename}"
restorer = BackupRestore::Restorer.new(
user_id: Discourse.system_user.id,
filename: filename,
disable_emails: options[:disable_emails],
location: options[:location],
factory: BackupRestore::Factory.new(user_id: Discourse.system_user.id)
)
restorer.run
puts 'Restore done.'
rescue BackupRestore::FilenameMissingError
puts '', 'The filename argument was missing.', ''
usage
rescue BackupRestore::RestoreDisabledError
puts '', 'Restores are not allowed.', 'An admin needs to set allow_restore to true in the site settings before restores can be run.'
puts "Enable now with", '', "#{discourse} enable_restore", ''
puts 'Restore cancelled.', ''
end
exit(1) unless restorer.try(:success)
end
desc "import", "Restore a Discourse backup"
def import(filename)
restore(filename)
end
desc "rollback", "Rollback to the previous working state"
def rollback
load_rails
require "backup_restore"
puts 'Rolling back if needed..'
BackupRestore.rollback!
puts 'Done.'
end
desc "enable_restore", "Allow restore operations"
def enable_restore
load_rails
require "site_setting"
SiteSetting.allow_restore = true
puts 'Restore are now permitted. Disable them with `disable_restore`'
end
desc "disable_restore", "Forbid restore operations"
def disable_restore
load_rails
require "site_setting"
SiteSetting.allow_restore = false
puts 'Restore are now forbidden. Enable them with `enable_restore`'
end
desc "enable_readonly", "Enable the readonly mode"
def enable_readonly
load_rails
Discourse.enable_readonly_mode
puts 'The site is now in readonly mode.'
end
desc "disable_readonly", "Disable the readonly mode"
def disable_readonly
load_rails
Discourse.disable_readonly_mode
puts 'The site is now fully operable.'
end
desc "request_refresh", "Ask all clients to refresh the browser"
def request_refresh
load_rails
Discourse.request_refresh!
puts 'Requests sent. Clients will refresh on next navigation.'
end
desc "export_categories", "Export categories, all its topics, and all users who posted in those topics"
def export_categories(*category_ids)
puts "Starting export of categories...", ""
load_rails
load_import_export
ImportExport.export_categories(category_ids)
puts "", "Done", ""
end
desc "export_category", "Export a category, all its topics, and all users who posted in those topics"
def export_category(category_id)
raise "Category id argument is missing!" unless category_id
export_categories([category_id])
end
desc "import_category", "Import a category, its topics and the users from the output of the export_category command"
def import_category(filename)
raise "File name argument missing!" unless filename
puts "Starting import from #{filename}..."
load_rails
load_import_export
ImportExport.import(filename)
puts "", "Done", ""
end
desc "export_topics", "Export topics and all users who posted in that topic. Accepts multiple topic id's"
def export_topics(*topic_ids)
puts "Starting export of topics...", ""
load_rails
load_import_export
ImportExport.export_topics(topic_ids)
puts "", "Done", ""
end
desc "import_topics", "Import topics and their users from the output of the export_topic command"
def import_topics(filename)
raise "File name argument missing!" unless filename
puts "Starting import from #{filename}..."
load_rails
load_import_export
ImportExport.import(filename)
puts "", "Done", ""
end
private
def load_rails
require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
end
def load_import_export
require File.expand_path(File.dirname(__FILE__) + "/../lib/import_export")
end
def do_remap(from, to, regex = false)
begin
regex ? DbHelper.regexp_replace(from, to, verbose: true) : DbHelper.remap(from, to, verbose: true)
puts 'Done', ''
rescue => ex
puts "Error: #{ex}"
puts "The remap has only been partially applied due to the error above. Please re-run the script again."
exit(1)
end
end
end
DiscourseCLI.start(ARGV)