Class: PostfixAdmin::Base

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

Constant Summary collapse

DEFAULT_CONFIG = 
{
  'database'  => 'mysql://postfix:password@localhost/postfix',
  'aliases'   => 30,
  'mailboxes' => 30,
  'maxquota'  => 100,
  'scheme'    => 'CRAM-MD5',
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Base

Returns a new instance of Base.



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/postfix_admin/base.rb', line 19

def initialize(config)
  db_setup(config['database'])
  if local_part_required?
    eval "class ::PostfixAdmin::Mailbox\nproperty :local_part, String\nend\n"
    DataMapper.finalize
  end
  @config = {}
  @config[:aliases]   = config['aliases']   || 30
  @config[:mailboxes] = config['mailboxes'] || 30
  @config[:maxquota]  = config['maxquota']  || 100
  @config[:mailbox_quota] = @config[:maxquota] * KB_TO_MB
  @config[:scheme]    = config['scheme']    || 'CRAM-MD5'
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



9
10
11
 
# File 'lib/postfix_admin/base.rb', line 9

def config
  @config
end

Instance Method Details

#add_account(address, password, in_name = nil) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/postfix_admin/base.rb', line 84

def (address, password, in_name=nil)
  name = in_name || ''
  password_check(password)

  if address !~ /.+\@.+\..+/
    raise Error, "Invalid mail address #{address}"
  end
  user, domain_name = address_split(address)
  path = "#{domain_name}/#{address}/"

  unless Domain.exist?(domain_name)
    raise Error, "Could not find domain #{domain_name}"
  end

  if Alias.exist?(address)
    raise Error, "#{address} is already resistered."
  end

  domain = Domain.find(domain_name)
  domain.aliases << Alias.mailbox(address)

  mailbox = Mailbox.new
  attributes = {
    :username => address,
    :password => password,
    :name     => name,
    :maildir  => path,
    :quota    => @config[:mailbox_quota],
  }

  if local_part_required?
    attributes[:local_part] = user
  end

  mailbox.attributes = attributes

  domain.mailboxes << mailbox
  unless domain.save
    raise "Could not save Mailbox and Domain #{mailbox.errors.map{|e| e.to_s}.join} #{domain.errors.map{|e| e.to_s}.join}"
  end
end

#add_admin(username, password) ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/postfix_admin/base.rb', line 68

def add_admin(username, password)
  password_check(password)

  if Admin.exist?(username)
    raise Error, "#{username} is already resistered as admin."
  end
  admin = Admin.new
  admin.attributes = {
    :username => username,
    :password => password,
  }
  unless admin.save
    raise "Could not save Admin #{admin.errors.map{|e| e.to_s}.join}"
  end
end

#add_admin_domain(user_name, domain_name) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/postfix_admin/base.rb', line 42

def add_admin_domain(user_name, domain_name)
  admin_domain_check(user_name, domain_name)

  admin  = Admin.find(user_name)
  if admin.has_domain?(domain_name)
    raise Error, "#{user_name} is already resistered as admin of #{domain_name}."
  end

  domain = Domain.find(domain_name)
  admin.domains << domain
  admin.save or raise "Relation Error: Domain of Admin"
end

#add_alias(address, goto) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/postfix_admin/base.rb', line 126

def add_alias(address, goto)
  if Mailbox.exist?(address)
    raise Error, "mailbox #{address} is already registered!"
  end
  if Alias.exist?(address)
    raise Error, "alias #{address} is already registered!"
  end
  user, domain_name = address_split(address)
  unless Domain.exist?(domain_name)
    raise Error, "Invalid domain! #{domain_name}"
  end
  domain = Domain.find(domain_name)

  new_alias = Alias.new
  new_alias.attributes = {
    :address => address,
    :goto    => goto,
  }
  domain.aliases << new_alias
  domain.save or raise "Could not save Alias"
end

#add_domain(domain_name) ⇒ Object 



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/postfix_admin/base.rb', line 158

def add_domain(domain_name)
  domain_name = domain_name.downcase
  if domain_name !~ /.+\..+/
    raise Error, "Ivalid domain! #{domain_name}"
  end
  if Domain.exist?(domain_name)
    raise Error, "#{domain_name} is already registered!"
  end
  domain = Domain.new
  domain.attributes = {
    :domain_name  => domain_name,
    :description  => domain_name,
    :maxaliases   => @config[:aliases],
    :maxmailboxes => @config[:mailboxes],
    :maxquota     => @config[:maxquota],
  }
  domain.save or raise "Could not save Domain"
end

#address_split(address) ⇒ Object 



215
216
217
 
# File 'lib/postfix_admin/base.rb', line 215

def address_split(address)
  address.split('@')
end

#db_setup(database) ⇒ Object 



37
38
39
40
 
# File 'lib/postfix_admin/base.rb', line 37

def db_setup(database)
  DataMapper.setup(:default, database)
  DataMapper.finalize
end

#delete_account(address) ⇒ Object 



206
207
208
209
210
211
212
213
 
# File 'lib/postfix_admin/base.rb', line 206

def (address)
  unless Alias.exist?(address) && Mailbox.exist?(address)
    raise Error, "Could not find account #{address}"
  end

  Mailbox.all(:username => address).destroy or raise "Could not destroy Mailbox"
  Alias.all(:address => address).destroy or raise "Could not destroy Alias"
end

#delete_admin(user_name) ⇒ Object 



197
198
199
200
201
202
203
204
 
# File 'lib/postfix_admin/base.rb', line 197

def delete_admin(user_name)
  unless Admin.exist?(user_name)
    raise Error, "Could not find admin #{user_name}"
  end
  admin = Admin.find(user_name)
  admin.clear_domains
  admin.destroy or raise "Could not destroy Admin"
end

#delete_admin_domain(user_name, domain_name) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/postfix_admin/base.rb', line 55

def delete_admin_domain(user_name, domain_name)
  admin_domain_check(user_name, domain_name)

  admin  = Admin.find(user_name)
  unless admin.has_domain?(domain_name)
    raise Error, "#{user_name} is not resistered as admin of #{domain_name}."
  end

  domain = Domain.find(domain_name)
  admin.domains.delete(domain)
  admin.save or "Could not save Admin"
end

#delete_alias(address) ⇒ Object 



148
149
150
151
152
153
154
155
156
 
# File 'lib/postfix_admin/base.rb', line 148

def delete_alias(address)
  if Mailbox.exist?(address)
    raise Error, "Can not delete mailbox by delete_alias. Use delete_account"
  end
  unless Alias.exist?(address)
    raise Error, "#{address} is not found!"
  end
  Alias.all(:address => address).destroy or raise "Could not destroy Alias"
end

#delete_domain(domain_name) ⇒ Object 



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

def delete_domain(domain_name)
  domain_name = domain_name.downcase
  unless Domain.exist?(domain_name)
    raise Error, "Could not find domain #{domain_name}"
  end

  domain = Domain.find(domain_name)
  domain.mailboxes.destroy or raise "Could not destroy Mailbox"
  domain.aliases.destroy or raise "Could not destroy Alias"
  admin_names = domain.admins.map{|a| a.username }
  domain.clear_admins

  admin_names.each do |name|
    next unless Admin.exist?(name)
    admin = Admin.find(name)
    admin.destroy or raise "Could not destroy Admin" if admin.domains.empty?
  end
  domain.destroy or raise "Could not destroy Domain"
end