]>
gitweb.michael.orlitzky.com - mailshears.git/blob - bin/mailshears
37d660175dff6b1f055c73d3320b3031a04a2e06
3 # mailshears, to prune unused mail directories.
5 # Mail accounts for virtual hosts are stored in SQL, and managed by
6 # Postfixadmin. However, the physical directories are handled by
7 # Postfix/Dovecot and are left untouched by Postfixadmin. This is good
8 # for security, but comes at a cost: Postfixadmin can't remove a
9 # user's mail directory when his or her account is deleted.
11 # This program compares the list of filesystem accounts with the ones
12 # in the database. It outputs any accounts that exist in the
13 # filesystem, but not the database.
16 # Define a usage string using the program name.
17 exe
= File
.basename($PROGRAM_NAME)
18 usage
= "#{exe} [prune | rm <target> | mv <src> <dst>]"
24 # Now, if a mode was supplied, it should be in ARGV[0].
26 mode_names
= ['prune', 'rm', 'mv']
27 if mode_names
.include?(ARGV.first().downcase()) then
28 # Peel the mode name off the head of the list.
29 mode_name
= ARGV.shift()
33 if mode_name
== 'rm' then
35 elsif mode_name
== 'mv' then
39 # Need this before referencing ExitCodes.
42 # Since we removed both the executable name and the mode name (if it
43 # existed) from ARGV, what remains should be the required
45 if (mode
== :prune and (ARGV.length() !
= 0)) or
46 (mode
== :rm and (ARGV.length() < 1)) or
47 (mode
== :mv and (ARGV.length() !
= 2)) then
48 puts
"ERROR: missing (or extra) command-line arguments."
49 puts
"Usage: #{usage}"
50 Kernel
.exit(ExitCodes
::BAD_COMMAND_LINE)
53 cfg
= Configuration
.new()
55 # Load each of the plugins that we'll need.
56 cfg
.plugins
.each
do |plugin_file
|
57 require "#{mode_name}/plugins/#{plugin_file}"
60 # Always enabled, for now.
61 require "#{mode_name}/plugins/postfixadmin_db"
64 require "#{mode_name}/#{mode_name}_runner"
65 require "#{mode_name}/#{mode_name}_dummy_runner"
67 def make_header(plugin_name
)
68 # The header that we output before the list of domains/accounts.
69 # Just the path of this script, the current time, and the plugin name.
70 exe
= File
.basename($PROGRAM_NAME)
73 current_time
= Time
.now()
74 if current_time
.respond_to
?(:iso8601)
75 # Somehow this method is missing on some machines.
76 header +
= current_time
.iso8601
.to_s
78 # Fall back to whatever this looks like.
79 header +
= current_time
.to_s
82 header +
= ' (Plugin: ' + plugin_name +
")\n"
83 header +
= '-' * header
.size
# Underline the header.
91 dummy_runner_class
= nil
94 plugin_class
= RmPlugin
95 runner_class
= RmRunner
96 dummy_runner_class
= RmDummyRunner
97 elsif mode
== :mv then
98 plugin_class
= MvPlugin
99 runner_class
= MvRunner
100 dummy_runner_class
= MvDummyRunner
102 # Safe, catch-all default
103 plugin_class
= PrunePlugin
104 runner_class
= PruneRunner
105 dummy_runner_class
= PruneDummyRunner
108 puts
make_header(plugin_class
.to_s())
110 plugin_class
.includers
.each
do |plugin_class_includer
|
111 plugin
= plugin_class_includer
.new()
113 if cfg
.i_mean_business
then
114 runner
= runner_class
.new()
116 runner
= dummy_runner_class
.new()
119 # The splat passes the correct (we hope) number of arguments to the
120 # appropriate runner. The Rm(Dummy)Runner have splats on their
121 # *target arguments as well, to turn ARGV back into an array.
122 runner
.run(plugin
, *ARGV)
133 # Get a list of domains from the Postfixadmin database.
134 db_domains
= pgadb
.get_domains_from_db()
135 rescue DatabaseError
=> e
136 puts
"There was an error connecting to the database: #{e.to_s}"
137 Kernel
.exit(ExitCodes
::DATABASE_ERROR)
142 db_accounts
= pgadb
.get_accounts_from_db()
143 rescue DatabaseError
=> e
144 puts
"There was an error connecting to the database: #{e.to_s}"
145 Kernel
.exit(ExitCodes
::DATABASE_ERROR)
149 Plugin
.includers
.each
do |plugin_class_includer
|
150 plugin
= plugin_class_includer
.new()
153 leftover_domains
= plugin
.get_leftover_domains(db_domains
)
154 rescue StandardError
=> e
155 puts
"There was an error retrieving domains from the filesystem: #{e.to_s}"
156 Kernel
.exit(ExitCodes
::FILESYSTEM_ERROR)
160 leftover_accounts
= plugin
.get_leftover_accounts(db_accounts
)
161 rescue StandardError
=> e
162 puts
"There was an error retrieving accounts from the filesystem: #{e.to_s}"
163 Kernel
.exit(ExitCodes
::FILESYSTEM_ERROR)
166 if leftover_domains
.size
> 0 or leftover_accounts
.size
> 0
167 puts
make_header(plugin_class
.to_s())
169 leftover_domains
.each
do |domain
|
170 puts
"Found: #{domain} (#{plugin.describe_domain(domain)})"
173 leftover_accounts
.each
do |account
|
174 puts
"Found: #{account} (#{plugin.describe_account(account)})"
177 if cfg
.i_mean_business
178 # We have to delete the accounts before the domain,
179 # otherwise they'd already be gone.
180 leftover_accounts
.each
do |account
|
181 # Get the description before we delete the domain.
182 # This can still fail if the account's domain is gone.
183 account_description
= plugin
.describe_account(account
)
184 plugin
.delete_account(account
)
185 puts
"Removed: #{account} (#{account_description})"
188 leftover_domains
.each
do |domain
|
189 # Get the description before we delete the domain.
190 domain_description
= plugin
.describe_domain(domain
)
191 plugin
.delete_domain(domain
)
192 puts
"Removed: #{domain} (#{domain_description})"