Class: PostfixAdmin::CLI

Inherits:
Object
  • Object
show all
Defined in:
lib/postfix_admin/cli.rb

Constant Summary collapse

MIN_NUM_PASSWORD_CHARACTER = 
5

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CLI

Returns a new instance of CLI.



10
11
12
13
 
# File 'lib/postfix_admin/cli.rb', line 10

def initialize
  @config = load_config
  @base = Base.new(@config)
end

Class Method Details

.config_file ⇒ Object 



15
16
17
 
# File 'lib/postfix_admin/cli.rb', line 15

def self.config_file
  @config_file
end

.config_file=(value) ⇒ Object 



19
20
21
 
# File 'lib/postfix_admin/cli.rb', line 19

def self.config_file=(value)
  @config_file = value
end

Instance Method Details

#add_account(address, password, scheme = nil, name = nil) ⇒ Object 



262
263
264
265
266
267
268
 
# File 'lib/postfix_admin/cli.rb', line 262

def (address, password, scheme=nil, name=nil)
  validate_password(password)

  @base.(address, hashed_password(password, scheme), name)
  puts_registered(address, "an account")
  (address)
end

#add_admin(user_name, password, super_admin = false, scheme = nil) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/postfix_admin/cli.rb', line 240

def add_admin(user_name, password, super_admin=false, scheme=nil)
  validate_password(password)

  @base.add_admin(user_name, hashed_password(password, scheme))
  if super_admin
    Admin.find(user_name).super_admin = true
    puts_registered(user_name, "a super admin")
  else
    puts_registered(user_name, "an admin")
  end
end

#add_admin_domain(user_name, domain_name) ⇒ Object 



252
253
254
255
 
# File 'lib/postfix_admin/cli.rb', line 252

def add_admin_domain(user_name, domain_name)
  @base.add_admin_domain(user_name, domain_name)
  puts_registered(domain_name, "a domain of #{user_name}")
end

#add_alias(address, goto) ⇒ Object 



270
271
272
273
 
# File 'lib/postfix_admin/cli.rb', line 270

def add_alias(address, goto)
  @base.add_alias(address, goto)
  puts_registered("#{address}: #{goto}", "an alias")
end

#add_domain(domain_name) ⇒ Object 



135
136
137
138
 
# File 'lib/postfix_admin/cli.rb', line 135

def add_domain(domain_name)
  @base.add_domain(domain_name)
  puts_registered(domain_name, "a domain")
end

#change_account_password(user_name, password) ⇒ Object 



156
157
158
 
# File 'lib/postfix_admin/cli.rb', line 156

def (user_name, password)
  change_password(Mailbox, user_name, password)
end

#change_admin_password(user_name, password) ⇒ Object 



152
153
154
 
# File 'lib/postfix_admin/cli.rb', line 152

def change_admin_password(user_name, password)
  change_password(Admin, user_name, password)
end

#delete_account(address) ⇒ Object 



296
297
298
299
 
# File 'lib/postfix_admin/cli.rb', line 296

def (address)
  @base.(address)
  puts_deleted(address)
end

#delete_admin(user_name) ⇒ Object 



291
292
293
294
 
# File 'lib/postfix_admin/cli.rb', line 291

def delete_admin(user_name)
  @base.delete_admin(user_name)
  puts_deleted(user_name)
end

#delete_admin_domain(user_name, domain_name) ⇒ Object 



257
258
259
260
 
# File 'lib/postfix_admin/cli.rb', line 257

def delete_admin_domain(user_name, domain_name)
  @base.delete_admin_domain(user_name, domain_name)
  puts "#{domain_name} was successfully deleted from #{user_name}"
end

#delete_alias(address) ⇒ Object 



286
287
288
289
 
# File 'lib/postfix_admin/cli.rb', line 286

def delete_alias(address)
  @base.delete_alias(address)
  puts_deleted(address)
end

#delete_domain(domain_name) ⇒ Object 



172
173
174
175
 
# File 'lib/postfix_admin/cli.rb', line 172

def delete_domain(domain_name)
  @base.delete_domain(domain_name)
  puts_deleted(domain_name)
end

#dump ⇒ Object 



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
 
# File 'lib/postfix_admin/cli.rb', line 301

def dump
  puts "Admins"
  puts "User Name,Password,Super Admin,Active"
  Admin.all.each do |a|
    puts [a.username, %Q!"#{a.password}"!, a.super_admin?, a.active].join(',')
  end
  puts
  puts "Domains"
  puts "Domain Name,Max Quota,Active"
  Domain.all_without_special_domain.each do |d|
    puts [d.domain_name, d.maxquota, d.active].join(',')
  end
  puts
  puts "Mailboxes"
  puts "User Name,Name,Password,Quota,Maildir,Active"
  Mailbox.all.each do |m|
    puts [m.username, %Q!"#{m.name}"!, %Q!"#{m.password}"!, m.quota, %Q!"#{m.maildir}"!, m.active].join(',')
  end
  puts
  puts "Aliases"
  puts "Address,Go to,Active"
  Alias.all.select{|a| !a.mailbox? }.each do |a|
    puts [a.address, %Q!"#{a.goto}"!, a.active].join(',')
  end
  puts
  puts "Forwards"
  puts "Address,Go to,Active"
  Alias.all.select{|a| a.mailbox? && a.goto != a.address }.each do |a|
    puts [a.address, %Q!"#{a.goto}"!, a.active].join(',')
  end
end

#edit_account(address, options) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
 
# File 'lib/postfix_admin/cli.rb', line 275

def (address, options)
  mailbox_check(address)
  mailbox = Mailbox.find(address)
  mailbox.name = options[:name] if options[:name]
  mailbox.quota = options[:quota] * KB_TO_MB if options[:quota]
  mailbox.save or raise "Could not save Mailbox"

  puts "Successfully updated #{address}"
  (address)
end

#edit_domain(domain_name, options) ⇒ Object 



160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/postfix_admin/cli.rb', line 160

def edit_domain(domain_name, options)
  domain_check(domain_name)
  domain = Domain.find(domain_name)
  domain.maxaliases   = options[:aliases]   if options[:aliases]
  domain.maxmailboxes = options[:mailboxes] if options[:mailboxes]
  domain.maxquota     = options[:maxquota]  if options[:maxquota]
  domain.save or raise "Could not save Domain"

  puts "Successfully updated #{domain_name}"
  show_summary(domain_name)
end

#setup_domain(domain_name, password) ⇒ Object 



75
76
77
78
79
80
 
# File 'lib/postfix_admin/cli.rb', line 75

def setup_domain(domain_name, password)
  admin = "admin@#{domain_name}"
  add_domain(domain_name)
  add_admin(admin, password)
  add_admin_domain(admin, domain_name)
end

#show(name) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/postfix_admin/cli.rb', line 23

def show(name)
  name = name.downcase if name

  if name =~ /@/
    if Admin.exist?(name)
      show_admin_details(name)
    end

    if Mailbox.exist?(name)
      (name)
    elsif Alias.exist?(name)
      show_alias_details(name)
    end

    return
  end

  show_summary(name)

  if name
    show_admin(name)
    show_address(name)
    show_alias(name)
  else
    show_domain
    show_admin
  end
end

#show_account_details(user_name) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/postfix_admin/cli.rb', line 82

def (user_name)
  (user_name)
  mailbox    = Mailbox.find(user_name)
  mail_alias = Alias.find(user_name)

  report("Mailbox") do
    puts "Address  : %s" % mailbox.username
    puts "Name     : %s" % mailbox.name
    puts "Password : %s" % mailbox.password
    puts "Quota    : %d MB" % max_str(mailbox.quota / KB_TO_MB)
    puts "Go to    : %s" % mail_alias.goto
    puts "Active   : %s" % mailbox.active_str
  end
end

#show_address(domain_name) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/postfix_admin/cli.rb', line 194

def show_address(domain_name)
  domain_check(domain_name)

  mailboxes = Domain.find(domain_name).mailboxes
  index = " No. Email                           Name                 Quota (MB) Active         Maildir"
  report("Addresses", index) do
    if mailboxes.empty?
      puts " No addresses"
      next
    end

    mailboxes.each_with_index do |m, i|
      quota = m.quota.to_f/ KB_TO_MB.to_f
      puts "%4d %-30s  %-20s %10s   %-3s  %s" % [i+1, m.username, m.name, max_str(quota.to_i), m.active_str, m.maildir]
    end
  end

end

#show_admin(domain_name = nil) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/postfix_admin/cli.rb', line 177

def show_admin(domain_name=nil)
  admins = domain_name ? Admin.select{|a| a.has_domain?(domain_name)} : Admin.all
  index = " No. Admin                                        Domains Active"
  report("Admins", index) do
    if admins.empty?
      puts " No admins"
      next
    end

    admins.each_with_index do |a, i|
      domains = a.super_admin? ? 'Super admin' : a.domains.count
      puts "%4d %-40s %11s   %-3s" % [i+1, a.username, domains, a.active_str]
    end
  end

end

#show_admin_details(name) ⇒ Object 



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/postfix_admin/cli.rb', line 97

def show_admin_details(name)
  admin_check(name)
  admin = Admin.find(name)

  report("Admin") do
    puts "Name     : %s" % admin.username
    puts "Password : %s" % admin.password
    puts "Active   : %s" % admin.active_str
  end
end

#show_admin_domain(user_name) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/postfix_admin/cli.rb', line 226

def show_admin_domain(user_name)
  admin = Admin.find(user_name)
  if admin.domains.empty?
    puts "\nNo domain in database"
    return
  end

  report("Domains (#{user_name})", " No. Domain") do
    admin.domains.each_with_index do |d, i|
      puts "%4d %-30s" % [i+1, d.domain_name]
    end
  end
end

#show_alias(domain_name) ⇒ Object 



213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/postfix_admin/cli.rb', line 213

def show_alias(domain_name)
  domain_check(domain_name)

  forwards, aliases = Domain.find(domain_name).aliases.partition{|a| a.mailbox?}

  forwards.delete_if do |f|
    f.address == f.goto
  end

  show_alias_base("Forwards", forwards)
  show_alias_base("Aliases",  aliases)
end

#show_alias_details(name) ⇒ Object 



108
109
110
111
112
113
114
115
116
 
# File 'lib/postfix_admin/cli.rb', line 108

def show_alias_details(name)
  alias_check(name)
  mail_alias = Alias.find(name)
  report("Alias") do
    puts "Address  : %s" % mail_alias.address
    puts "Go to    : %s" % mail_alias.goto
    puts "Active   : %s" % mail_alias.active_str
  end
end

#show_domain ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/postfix_admin/cli.rb', line 118

def show_domain
  index = " No. Domain                          Aliases   Mailboxes     Quota (MB)  Active"
  report('Domains', index) do
    if Domain.all_without_special_domain.empty?
      puts " No domains"
      next
    end

    Domain.all_without_special_domain.each_with_index do |d, i|
      puts "%4d %-30s %3d /%3s   %3d /%3s %10d         %-3s" %
        [i+1, d.domain_name, d.num_total_aliases, max_str(d.maxaliases),
         d.mailboxes.count, max_str(d.maxmailboxes), d.maxquota, d.active_str]
    end
  end

end

#show_summary(domain_name = nil) ⇒ Object 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/postfix_admin/cli.rb', line 52

def show_summary(domain_name=nil)
  title = "Summary"
  if domain_name
    domain_name = domain_name.downcase
    domain_check(domain_name)
    title = "Summary of #{domain_name}"
  end

  report(title) do
    if domain_name
      domain = Domain.find(domain_name)
      puts "Mailboxes : %4d / %4s"    % [domain.mailboxes.count, max_str(domain.maxmailboxes)]
      puts "Aliases   : %4d / %4s"    % [domain.num_total_aliases, max_str(domain.maxaliases)]
      puts "Max Quota : %4d MB" % domain.maxquota
    else
      puts "Domains   : %4d" % Domain.all_without_special_domain.count
      puts "Admins    : %4d" % Admin.count
      puts "Mailboxes : %4d" % Mailbox.count
      puts "Aliases   : %4d" % Domain.num_total_aliases
    end
  end
end

#super_admin(user_name, disable) ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/postfix_admin/cli.rb', line 140

def super_admin(user_name, disable)
  admin_check(user_name)

  if disable
    Admin.find(user_name).super_admin = false
    puts "Successfully disabled super admin flag of #{user_name}"
  else
    Admin.find(user_name).super_admin = true
    puts "Successfully enabled super admin flag of #{user_name}"
  end
end