Fix help text around `tootctl email_domain_blocks` (#14147)

This commit is contained in:
Eugen Rochko 2020-06-26 21:28:40 +02:00 committed by GitHub
parent a1ad2ad951
commit 4662afe075
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 13 deletions

View File

@ -54,7 +54,7 @@ module Mastodon
desc 'upgrade SUBCOMMAND ...ARGS', 'Various version upgrade utilities' desc 'upgrade SUBCOMMAND ...ARGS', 'Various version upgrade utilities'
subcommand 'upgrade', Mastodon::UpgradeCLI subcommand 'upgrade', Mastodon::UpgradeCLI
desc 'email-domain-blocks SUBCOMMAND ...ARGS', 'Manage E-mail domain blocks' desc 'email_domain_blocks SUBCOMMAND ...ARGS', 'Manage e-mail domain blocks'
subcommand 'email_domain_blocks', Mastodon::EmailDomainBlocksCLI subcommand 'email_domain_blocks', Mastodon::EmailDomainBlocksCLI
option :dry_run, type: :boolean option :dry_run, type: :boolean

View File

@ -13,13 +13,11 @@ module Mastodon
true true
end end
desc 'list', 'list E-mail domain blocks' desc 'list', 'List blocked e-mail domains'
long_desc <<-LONG_DESC
list up all E-mail domain blocks.
LONG_DESC
def list def list
EmailDomainBlock.where(parent_id: nil).order(id: 'DESC').find_each do |entry| EmailDomainBlock.where(parent_id: nil).order(id: 'DESC').find_each do |entry|
say(entry.domain.to_s, :white) say(entry.domain.to_s, :white)
EmailDomainBlock.where(parent_id: entry.id).order(id: 'DESC').find_each do |child| EmailDomainBlock.where(parent_id: entry.id).order(id: 'DESC').find_each do |child|
say(" #{child.domain}", :cyan) say(" #{child.domain}", :cyan)
end end
@ -27,13 +25,17 @@ module Mastodon
end end
option :with_dns_records, type: :boolean option :with_dns_records, type: :boolean
desc 'add [DOMAIN...]', 'add E-mail domain blocks' desc 'add DOMAIN...', 'Block e-mail domain(s)'
long_desc <<-LONG_DESC long_desc <<-LONG_DESC
add E-mail domain blocks from a given DOMAIN. Blocking an e-mail domain prevents users from signing up
with e-mail addresses from that domain. You can provide one or
multiple domains to the command.
When the --with-dns-records option is given, An attempt to resolve the When the --with-dns-records option is given, an attempt to resolve the
given domain's DNS records will be made and the results will also be given domains' DNS records will be made and the results (A, AAAA and MX) will
blacklisted. also be blocked. This can be helpful if you are blocking an e-mail server that
has many different domains pointing to it as it allows you to essentially block
it at the root.
LONG_DESC LONG_DESC
def add(*domains) def add(*domains)
if domains.empty? if domains.empty?
@ -72,11 +74,13 @@ module Mastodon
(hostnames + ips).uniq.each do |hostname| (hostnames + ips).uniq.each do |hostname|
another_email_domain_block = EmailDomainBlock.new(domain: hostname, parent: email_domain_block) another_email_domain_block = EmailDomainBlock.new(domain: hostname, parent: email_domain_block)
if EmailDomainBlock.where(domain: hostname).exists? if EmailDomainBlock.where(domain: hostname).exists?
say("#{hostname} is already blocked.", :yellow) say("#{hostname} is already blocked.", :yellow)
skipped += 1 skipped += 1
next next
end end
another_email_domain_block.save! another_email_domain_block.save!
processed += 1 processed += 1
end end
@ -85,7 +89,7 @@ module Mastodon
say("Added #{processed}, skipped #{skipped}", color(processed, 0)) say("Added #{processed}, skipped #{skipped}", color(processed, 0))
end end
desc 'remove [DOMAIN...]', 'remove E-mail domain blocks' desc 'remove DOMAIN...', 'Remove e-mail domain blocks'
def remove(*domains) def remove(*domains)
if domains.empty? if domains.empty?
say('No domain(s) given', :red) say('No domain(s) given', :red)
@ -98,6 +102,7 @@ module Mastodon
domains.each do |domain| domains.each do |domain|
entry = EmailDomainBlock.find_by(domain: domain) entry = EmailDomainBlock.find_by(domain: domain)
if entry.nil? if entry.nil?
say("#{domain} is not yet blocked.", :yellow) say("#{domain} is not yet blocked.", :yellow)
skipped += 1 skipped += 1
@ -105,12 +110,12 @@ module Mastodon
end end
children_count = EmailDomainBlock.where(parent_id: entry.id).count children_count = EmailDomainBlock.where(parent_id: entry.id).count
result = entry.destroy result = entry.destroy
if result if result
processed += 1 + children_count processed += 1 + children_count
else else
say("#{domain} was not unblocked. 'destroy' returns false.", :red) say("#{domain} could not be unblocked.", :red)
failed += 1 failed += 1
end end
end end