postfix_admin 0.1.1 → 0.2.1

data/lib/postfix_admin/concerns/dovecot_cram_md5_password.rb

@@ -0,0 +1,30 @@
+require 'active_support/concern'
+
+module DovecotCramMD5Password
+  extend ActiveSupport::Concern
+
+  included do
+    validates :password_unencrypted, length: { minimum: 5 }, allow_blank: true
+    validates_confirmation_of :password_unencrypted, allow_blank: true
+
+    validate do |record|
+      record.errors.add(:password_unencrypted, :blank) unless record.password.present?
+    end
+
+    attr_reader :password_unencrypted
+    attr_accessor :password_unencrypted_confirmation
+  end
+
+  def password_unencrypted=(unencrypted_password)
+    if unencrypted_password.nil?
+      self.password = nil
+    elsif !unencrypted_password.empty?
+      @password_unencrypted = unencrypted_password
+      self.password = DovecotCrammd5.calc(unencrypted_password)
+    end
+  end
+
+  def authenticate(unencrypted_password)
+    password == DovecotCrammd5.calc(unencrypted_password) && self
+  end
+end

data/lib/postfix_admin/concerns/existing_timestamp.rb

@@ -0,0 +1,18 @@
+require 'active_support/concern'
+
+module ExistingTimestamp
+  extend ActiveSupport::Concern
+
+  class_methods do
+    private
+
+    def timestamp_attributes_for_create
+      ["created"]
+    end
+
+    def timestamp_attributes_for_update
+      ["modified"]
+    end
+  end
+
+end

data/lib/postfix_admin/domain.rb

@@ -0,0 +1,98 @@
+module PostfixAdmin
+  class Domain < ApplicationRecord
+    self.table_name = :domain
+    self.primary_key = :domain
+
+    validates :domain, presence: true, uniqueness: { case_sensitive: false },
+                       format: { with: RE_DOMAIN_NAME_LIKE_WITH_ANCHORS,
+                                 message: "must be a valid domain name" }
+    validates :transport, presence: true
+
+    validates :aliases, presence: true,
+                        numericality: { only_integer: true,
+                                        greater_than_or_equal_to: 0 }
+    validates :mailboxes, presence: true,
+                          numericality: { only_integer: true,
+                                          greater_than_or_equal_to: 0 }
+    validates :maxquota, presence: true,
+                         numericality: { only_integer: true,
+                                         greater_than_or_equal_to: 0 }
+
+    has_many :rel_mailboxes, class_name: "Mailbox", foreign_key: :domain,
+                             dependent: :destroy
+    has_many :rel_aliases, class_name: "Alias", foreign_key: :domain,
+                           dependent: :destroy
+
+    has_many :domain_admins, foreign_key: :domain, dependent: :delete_all
+    has_many :admins, through: :domain_admins
+
+    before_validation do |domain|
+      domain.domain = domain.domain.downcase unless domain.domain.empty?
+      domain.transport = "virtual"
+    end
+
+    scope :without_all, -> { where.not(domain: "ALL") }
+
+    def pure_aliases
+      rel_aliases.pure
+    end
+
+    def aliases_unlimited?
+      aliases.zero?
+    end
+
+    def mailboxes_unlimited?
+      mailboxes.zero?
+    end
+
+    def aliases_str
+      num_str(aliases)
+    end
+
+    def mailboxes_str
+      num_str(mailboxes)
+    end
+
+    def aliases_short_str
+      num_short_str(aliases)
+    end
+
+    def mailboxes_short_str
+      num_short_str(mailboxes)
+    end
+
+    def maxquota_str
+      if maxquota.zero?
+        "Unlimited"
+      else
+        "#{maxquota} MB"
+      end
+    end
+
+    def maxquota_short_str
+      if maxquota.zero?
+        "--"
+      else
+        "#{maxquota} MB"
+      end
+    end
+
+    private
+
+    def num_str(num)
+      if num.zero?
+        "Unlimited"
+      else
+        num.to_s
+      end
+    end
+
+    def num_short_str(num)
+      if num.zero?
+        "--"
+      else
+        num.to_s
+      end
+    end
+  end
+end

data/lib/postfix_admin/domain_admin.rb

@@ -0,0 +1,8 @@
+module PostfixAdmin
+  class DomainAdmin < ApplicationRecord
+    self.table_name = :domain_admins
+
+    belongs_to :admin, primary_key: :username, foreign_key: :username
+    belongs_to :rel_domain, class_name: "Domain", foreign_key: :domain
+  end
+end

data/lib/postfix_admin/doveadm.rb

@@ -0,0 +1,37 @@
+
+require 'open3'
+require 'shellwords'
+
+module PostfixAdmin
+  class Doveadm
+    def self.schemes
+      result = `#{self.command_name} -l`
+      result.split
+    end
+
+    def self.password(in_password, in_scheme, prefix)
+      password = Shellwords.escape(in_password)
+      scheme  = Shellwords.escape(in_scheme)
+      stdin, stdout, stderr = Open3.popen3("#{self.command_name} -s #{scheme} -p #{password}")
+      if stderr.readlines.to_s =~ /Fatal:/
+        raise Error, stderr.readlines
+      else
+        res = stdout.readlines.first.chomp
+        if prefix
+          res
+        else
+          res.gsub("{#{scheme}}", "")
+        end
+      end
+    end
+
+    def self.command_name
+      begin
+        Open3.capture3("doveadm pw -l")[2].exited?
+        "doveadm pw"
+      rescue Errno::ENOENT
+        "dovecotpw"
+      end
+    end
+  end
+end

data/lib/postfix_admin/log.rb

@@ -0,0 +1,5 @@
+module PostfixAdmin
+  class Log < ApplicationRecord
+    self.table_name = :log
+  end
+end

data/lib/postfix_admin/mail_domain.rb

@@ -0,0 +1,9 @@
+module PostfixAdmin
+  class MailDomain < ApplicationRecord
+    self.table_name = :domain
+    self.primary_key = :domain
+
+    has_many :addresses, class_name: "Mailbox", foreign_key: :domain,
+                         dependent: :destroy
+  end
+end

data/lib/postfix_admin/mailbox.rb

@@ -0,0 +1,89 @@
+module PostfixAdmin
+  class Mailbox < ApplicationRecord
+    self.table_name = :mailbox
+    self.primary_key = :username
+
+    include DovecotCramMD5Password
+
+    attribute :quota_mb, :integer
+
+    validates :username, presence: true, uniqueness: { case_sensitive: false },
+                         format: { with: RE_EMAIL_LIKE_WITH_ANCHORS,
+                                   message: "must be a valid email address" }
+    validates :maildir, presence: true, uniqueness: { case_sensitive: false }
+    validates :local_part, presence: true
+    validates :quota, presence: true,
+                      numericality: { only_integer: true,
+                                      greater_than_or_equal_to: 0 }
+    validates :quota_mb, presence: true,
+                         numericality: { only_integer: true,
+                                         greater_than_or_equal_to: 0 }
+
+    belongs_to :rel_domain, class_name: "Domain", foreign_key: :domain
+    has_one :alias, foreign_key: :address, dependent: :destroy
+    has_one :quota_usage, class_name: "Quota", foreign_key: :username,
+            dependent: :destroy
+
+    validate on: :create do |mailbox|
+      domain = mailbox.rel_domain
+      if !domain.mailboxes.zero? && domain.rel_mailboxes.count >= domain.mailboxes
+        message = "already has the maximum number of mailboxes " \
+                  "(maximum is #{domain.mailboxes} mailboxes)"
+        mailbox.errors.add(:domain, message)
+      end
+    end
+
+    # just in case
+    validate on: :update do |mailbox|
+      mailbox.errors.add(:username, 'cannot be changed') if mailbox.username_changed?
+      mailbox.errors.add(:local_part, 'cannot be changed') if mailbox.local_part_changed?
+    end
+
+    validate do |mailbox|
+      domain = mailbox.rel_domain
+
+      unless domain.maxquota.zero?
+        if mailbox.quota_mb.zero?
+          mailbox.errors.add(:quota_mb, "cannot be 0")
+        elsif mailbox.quota_mb > domain.maxquota
+          message = "must be less than or equal to #{domain.maxquota} (MB)"
+          mailbox.errors.add(:quota_mb, message)
+        end
+      end
+    end
+
+    before_validation do |mailbox|
+      mailbox.name = "" if mailbox.name.nil?
+      if mailbox.quota_mb
+        mailbox.quota = mailbox.quota_mb * KB_TO_MB
+      elsif mailbox.quota
+        mailbox.quota_mb = mailbox.quota / KB_TO_MB
+      else
+        mailbox.quota_mb = 0
+        mailbox.quota = 0
+      end
+      mailbox.username = "#{mailbox.local_part}@#{mailbox.domain}"
+      mailbox.maildir = "#{mailbox.domain}/#{mailbox.username}/"
+      mailbox.build_alias(local_part: mailbox.local_part, goto: mailbox.username,
+                          domain: mailbox.domain)
+    end
+
+    def quota_usage_str
+      if quota_usage
+        usage_mb = quota_usage.bytes / KB_TO_MB
+        usage_mb.to_s
+      else
+        "0"
+      end
+    end
+
+    def quota_str
+      if quota.zero?
+        "--"
+      else
+        quota_mb = quota / KB_TO_MB
+        "#{quota_mb} MB"
+      end
+    end
+  end
+end

data/lib/postfix_admin/models.rb

@@ -1,170 +1,10 @@
-require 'data_mapper'
-
-module PostfixAdmin
-  class Admin
-    include ::DataMapper::Resource
-    property :username, String, :key => true
-    property :password, String, :length => 0..255
-    property :created, DateTime, :default => DateTime.now
-    property :modified, DateTime, :default => DateTime.now
-
-    has n, :domain_admins, :child_key => :username
-    has n, :domains, :model => 'Domain', :through => :domain_admins, :via => :domain
-    storage_names[:default] = 'admin'
-
-    def has_domain?(domain_name)
-      if super_admin?
-        Domain.exist?(domain_name)
-      else
-        exist_domain?(domain_name)
-      end
-    end
-
-    def super_admin=(value)
-      if value
-        domains << Domain.find('ALL')
-        save or raise "Could not save ALL domain for Admin"
-      else
-        domain_admins(:domain_name => 'ALL').destroy or raise "Could not destroy DoaminAdmin for Admin"
-      end
-    end
-
-    def super_admin?
-      exist_domain?('ALL')
-    end
-
-    def clear_domains
-      domains.clear
-      save or raise "Could save Admin"
-    end
-
-    def self.find(username)
-      Admin.first(:username => username)
-    end
-
-    def self.exist?(username)
-      !!Admin.find(username)
-    end
-
-    private
-
-    def exist_domain?(domain_name)
-      !!domains.first(:domain_name => domain_name)
-    end
-  end
-
-  class Domain
-    include ::DataMapper::Resource
-    property :domain_name, String, :field => 'domain', :key => true
-    property :maxaliases, Integer, :field => 'aliases'
-    property :maxmailboxes, Integer, :field => 'mailboxes'
-    property :maxquota, Integer
-    property :transport, String, :default => 'virtual'
-    property :backupmx, Integer, :default => 0
-    property :description, String
-    property :created,  DateTime, :default => DateTime.now
-    property :modified, DateTime, :default => DateTime.now
-
-    has n, :domain_admins, :child_key => :domain_name
-    has n, :admins, :model => 'Admin', :through => :domain_admins
-
-    has n, :mailboxes, :model => 'Mailbox', :child_key => :domain_name
-    has n, :aliases, :model => 'Alias', :child_key => :domain_name
-    storage_names[:default] = 'domain'
-
-    def self.all_without_special_domain
-      Domain.all(:domain_name.not => 'ALL')
-    end
-
-    def self.find(domain)
-      Domain.first(:domain_name => domain)
-    end
-
-    def self.exist?(domain)
-      !!Domain.find(domain)
-    end
-
-    def self.num_total_aliases
-      Alias.count - Mailbox.count
-    end
-
-    def num_total_aliases
-      aliases.count - mailboxes.count
-    end
-
-    def clear_admins
-      admins.clear
-      save or raise "Could not save Domain"
-    end
-  end
-
-  class DomainAdmin
-    include ::DataMapper::Resource
-    property :created, DateTime, :default => DateTime.now
-    property :domain_name, String, :field => 'domain', :key => true
-    property :username, String, :key => true
-
-    belongs_to :domain, :model => 'Domain', :child_key => :domain_name
-    belongs_to :admin, :model => 'Admin', :child_key => :username
-    storage_names[:default] = 'domain_admins'
-  end
-
-  class Mailbox
-    include ::DataMapper::Resource
-    property :username, String, :key => true
-    property :name, String
-    property :domain_name, String, :field => 'domain'
-    property :password, String, :length => 0..255
-    property :maildir, String
-    property :quota, Integer
-    #  property :local_part, String
-    property :created, DateTime, :default => DateTime.now
-    property :modified, DateTime, :default => DateTime.now
-
-    belongs_to :domain, :model => 'Domain', :child_key => :domain_name
-
-    storage_names[:default] = 'mailbox'
-
-    def self.find(username)
-      Mailbox.first(:username => username)
-    end
-
-    def self.exist?(username)
-      !!Mailbox.find(username)
-    end
-  end
-
-  class Alias
-    include ::DataMapper::Resource
-    property :address, String, :key => true
-    property :goto, Text
-    property :domain_name, String, :field => 'domain'
-    property :created, DateTime, :default => DateTime.now
-    property :modified, DateTime, :default => DateTime.now
-
-    belongs_to :domain, :model => 'Domain', :child_key => :domain_name
-
-    storage_names[:default] = 'alias'
-
-    def self.mailbox(address)
-      mail_alias = Alias.new
-      mail_alias.attributes = {
-        :address     => address,
-        :goto        => address,
-      }
-      mail_alias
-    end
-
-    def self.find(address)
-      Alias.first(:address => address)
-    end
-
-    def self.exist?(address)
-      !!Alias.find(address)
-    end
-
-    def mailbox?
-      Mailbox.exist?(address)
-    end
-  end
-end
+require 'active_record'
+require 'postfix_admin/application_record'
+require 'postfix_admin/admin'
+require 'postfix_admin/domain'
+require 'postfix_admin/mailbox'
+require 'postfix_admin/alias'
+require 'postfix_admin/domain_admin'
+require 'postfix_admin/log'
+require 'postfix_admin/mail_domain'
+require 'postfix_admin/quota'