postfix_admin 0.2.1 → 0.3.1

data/lib/postfix_admin/doveadm.rb

@@ -1,36 +1,48 @@
-
 require 'open3'
 require 'shellwords'
 
 module PostfixAdmin
   class Doveadm
+    # doveadm-pw: https://doc.dovecot.org/3.0/man/doveadm-pw.1/
+    CMD_DOVEADM_PW = "doveadm pw"
+
+    # List all supported password schemes
     def self.schemes
-      result = `#{self.command_name} -l`
+      result = `#{CMD_DOVEADM_PW} -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
+    # Generate a password hash using `doveadm pw` command
+    def self.password(password, scheme, rounds: nil, user_name: nil,
+                      prefix: true)
+      escaped_password = Shellwords.escape(password)
+      escaped_scheme   = Shellwords.escape(scheme)
+
+      cmd = "#{CMD_DOVEADM_PW} -s #{escaped_scheme} -p #{escaped_password}"
+
+      # DIGEST-MD5 requires -u option (user name)
+      if scheme == "DIGEST-MD5"
+        escaped_user_name = Shellwords.escape(user_name)
+        cmd << " -u #{escaped_user_name}"
+      end
+
+      if rounds
+        escaped_rounds   = Shellwords.escape(rounds.to_s)
+        cmd << " -r #{rounds}"
+      end
+
+      output, error, status = Open3.capture3(cmd)
+
+      if status.success?
+        res = output.chomp
         if prefix
           res
         else
-          res.gsub("{#{scheme}}", "")
+          # Remove the prefix
+          res.gsub("{#{escaped_scheme}}", "")
         end
-      end
-    end
-
-    def self.command_name
-      begin
-        Open3.capture3("doveadm pw -l")[2].exited?
-        "doveadm pw"
-      rescue Errno::ENOENT
-        "dovecotpw"
+      else
+        raise Error, "#{CMD_DOVEADM_PW}: #{error}"
       end
     end
   end

data/lib/postfix_admin/{admin.rb → models/admin.rb}

@@ -1,16 +1,34 @@
-require 'postfix_admin/concerns/dovecot_cram_md5_password'
+require 'postfix_admin/models/concerns/has_password'
 
 module PostfixAdmin
   class Admin < ApplicationRecord
+    # version: 1841
+    # > describe admin;
+    # +----------------+--------------+------+-----+---------------------+-------+
+    # | Field          | Type         | Null | Key | Default             | Extra |
+    # +----------------+--------------+------+-----+---------------------+-------+
+    # | username       | varchar(255) | NO   | PRI | NULL                |       |
+    # | password       | varchar(255) | NO   |     | NULL                |       |
+    # | created        | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | modified       | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | active         | tinyint(1)   | NO   |     | 1                   |       |
+    # | superadmin     | tinyint(1)   | NO   |     | 0                   |       |
+    # | phone          | varchar(30)  | NO   |     |                     |       |
+    # | email_other    | varchar(255) | NO   |     |                     |       |
+    # | token          | varchar(255) | NO   |     |                     |       |
+    # | token_validity | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # +----------------+--------------+------+-----+---------------------+-------+
+
     self.table_name = :admin
     self.primary_key = :username
 
-    include DovecotCramMD5Password
+    include HasPassword
 
     validates :username, presence: true, uniqueness: { case_sensitive: false },
                          format: { with: RE_EMAIL_LIKE_WITH_ANCHORS,
                                    message: "must be a valid email address" }
 
+    # Admin <-> DomainAdmin <-> Domain
     has_many :domain_admins, foreign_key: :username, dependent: :delete_all
     has_many :rel_domains, through: :domain_admins
 
@@ -22,6 +40,11 @@ module PostfixAdmin
       admin.errors.add(:username, 'cannot be changed') if admin.username_changed?
     end
 
+    def reload
+      @super_admin = nil
+      super
+    end
+
     def super_admin?
       if @super_admin.nil?
         @super_admin = if has_superadmin_column?

data/lib/postfix_admin/{alias.rb → models/alias.rb}

@@ -1,5 +1,18 @@
 module PostfixAdmin
   class Alias < ApplicationRecord
+    # version: 1841
+    # > describe alias;
+    # +----------+--------------+------+-----+---------------------+-------+
+    # | Field    | Type         | Null | Key | Default             | Extra |
+    # +----------+--------------+------+-----+---------------------+-------+
+    # | address  | varchar(255) | NO   | PRI | NULL                |       |
+    # | goto     | text         | NO   |     | NULL                |       |
+    # | domain   | varchar(255) | NO   | MUL | NULL                |       |
+    # | created  | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | modified | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | active   | tinyint(1)   | NO   |     | 1                   |       |
+    # +----------+--------------+------+-----+---------------------+-------+
+
     self.table_name = :alias
     self.primary_key = :address
 
@@ -21,34 +34,11 @@ module PostfixAdmin
     belongs_to :rel_domain, class_name: "Domain", foreign_key: :domain
     belongs_to :mailbox, foreign_key: :address, optional: true
 
+    # aliases which do not belong to any mailbox
     scope :pure, -> { joins("LEFT OUTER JOIN mailbox ON alias.address = mailbox.username").where("mailbox.username" => nil) }
 
-    attribute :local_part, :string
-    attr_writer :forward_addresses
-
-    def forward_addresses
-      if @forward_addresses.nil?
-        if goto.nil?
-          [nil]
-        else
-          goto.split(",") + [nil]
-        end
-      else
-        @forward_addresses
-      end
-    end
-
-    before_validation do |a|
-      unless a.address
-        a.address = "#{a.local_part}@#{a.domain}" unless a.local_part.empty?
-      end
-
-      unless a.forward_addresses.empty?
-        forward_addresses = a.forward_addresses.dup
-        forward_addresses.delete_if { |f| f.blank? }
-        a.goto = forward_addresses.join(",")
-      end
-    end
+    # aliases which belong to a mailbox and have forwardings to other addresses
+    scope :forward, -> { joins("LEFT OUTER JOIN mailbox ON alias.address = mailbox.username").where("mailbox.username <> alias.goto") }
 
     def mailbox?
       !!mailbox

data/lib/postfix_admin/{application_record.rb → models/application_record.rb}

@@ -1,5 +1,5 @@
 require 'active_record'
-require 'postfix_admin/concerns/existing_timestamp'
+require 'postfix_admin/models/concerns/existing_timestamp'
 
 module PostfixAdmin
   class ApplicationRecord < ActiveRecord::Base

data/lib/postfix_admin/{concerns → models/concerns}/existing_timestamp.rb

@@ -14,5 +14,4 @@ module ExistingTimestamp
       ["modified"]
     end
   end
-
-end
+end

data/lib/postfix_admin/models/concerns/has_password.rb

@@ -0,0 +1,16 @@
+require 'active_support/concern'
+
+module HasPassword
+  extend ActiveSupport::Concern
+
+  # example: {CRAM-MD5}, {BLF-CRYPT}, {PLAIN}
+  # return nil if no scheme prefix
+  def scheme_prefix
+    res = password&.match(/^\{.*?\}/)
+    if res
+      res[0]
+    else
+      nil
+    end
+  end
+end

data/lib/postfix_admin/models/domain.rb

@@ -0,0 +1,112 @@
+module PostfixAdmin
+  class Domain < ApplicationRecord
+    # version: 1841
+    # > describe domain;
+    # +-------------+--------------+------+-----+---------------------+-------+
+    # | Field       | Type         | Null | Key | Default             | Extra |
+    # +-------------+--------------+------+-----+---------------------+-------+
+    # | domain      | varchar(255) | NO   | PRI | NULL                |       |
+    # | description | varchar(255) | NO   |     | NULL                |       |
+    # | aliases     | int(10)      | NO   |     | 0                   |       |
+    # | mailboxes   | int(10)      | NO   |     | 0                   |       |
+    # | maxquota    | bigint(20)   | NO   |     | 0                   |       |
+    # | quota       | bigint(20)   | NO   |     | 0                   |       |
+    # | transport   | varchar(255) | NO   |     | NULL                |       |
+    # | backupmx    | tinyint(1)   | NO   |     | 0                   |       |
+    # | created     | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | modified    | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | active      | tinyint(1)   | NO   |     | 1                   |       |
+    # +-------------+--------------+------+-----+---------------------+-------+
+
+    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
+
+    # max aliases (Disabled: -1, Unlimited: 0)
+    validates :aliases, presence: true,
+                        numericality: { only_integer: true,
+                                        greater_than_or_equal_to: -1 }
+    # max mailboxes (Disabled: -1, Unlimited: 0)
+    validates :mailboxes, presence: true,
+                          numericality: { only_integer: true,
+                                          greater_than_or_equal_to: -1 }
+
+    # max quota (MB) for each mailbox (Unlimited: 0)
+    # It's not sure what 'disabled' means for max quota.
+    # So it's better not to allow users to set `maxquota` to -1.
+    validates :maxquota, presence: true,
+                         numericality: { only_integer: true,
+                                         greater_than_or_equal_to: 0 }
+
+    # mailboxes that belong to this domain
+    has_many :rel_mailboxes, class_name: "Mailbox", foreign_key: :domain,
+                             dependent: :destroy
+    # aliases that belong to this domain
+    has_many :rel_aliases, class_name: "Alias", foreign_key: :domain,
+                           dependent: :destroy
+
+    # logs that belong to this domain
+    has_many :logs, class_name: "Log", foreign_key: :domain,
+             dependent: :destroy
+
+    # It causes errors to set `dependent: :destroy` as other columns
+    # because the domain_admins table doesn't have a single primary key.
+    #
+    # PostfixAdmin::DomainAdmin Load (0.5ms)  SELECT `domain_admins`.* FROM `domain_admins` WHERE `domain_admins`.`domain` = 'example.com'
+    # PostfixAdmin::DomainAdmin Destroy (1.1ms)  DELETE FROM `domain_admins` WHERE `domain_admins`.`` IS NULL
+    #
+    # ActiveRecord::StatementInvalid: Mysql2::Error: Unknown column 'domain_admins.' in 'where clause'
+    # from /usr/local/bundle/gems/mysql2-0.5.4/lib/mysql2/client.rb:148:in `_query'
+    # Caused by Mysql2::Error: Unknown column 'domain_admins.' in 'where clause'
+    # from /usr/local/bundle/gems/mysql2-0.5.4/lib/mysql2/client.rb:148:in `_query'
+    #
+    # It works well with `dependent: :delete_all` instead.
+    #
+    # PostfixAdmin::DomainAdmin Destroy (0.4ms)  DELETE FROM `domain_admins` WHERE `domain_admins`.`domain` = 'example.com'
+    # Domain <-> DomainAdmin <-> Admin
+    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
+      domain.transport = "virtual"
+    end
+
+    scope :without_all, -> { where.not(domain: "ALL") }
+
+    # aliases that don't belong to a mailbox
+    def pure_aliases
+      rel_aliases.pure
+    end
+
+    def aliases_str
+      max_num_str(aliases)
+    end
+
+    def mailboxes_str
+      max_num_str(mailboxes)
+    end
+
+    def maxquota_str
+      max_num_str(maxquota)
+    end
+
+    private
+
+    def max_num_str(num)
+      case num
+      when -1
+        "Disabled"
+      when 0
+        "Unlimited"
+      else
+        num.to_s
+      end
+    end
+  end
+end

data/lib/postfix_admin/models/domain_admin.rb

@@ -0,0 +1,19 @@
+module PostfixAdmin
+  class DomainAdmin < ApplicationRecord
+    # version: 1841
+    # > describe domain_admins;
+    # +----------+--------------+------+-----+---------------------+-------+
+    # | Field    | Type         | Null | Key | Default             | Extra |
+    # +----------+--------------+------+-----+---------------------+-------+
+    # | username | varchar(255) | NO   | MUL | NULL                |       |
+    # | domain   | varchar(255) | NO   |     | NULL                |       |
+    # | created  | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | active   | tinyint(1)   | NO   |     | 1                   |       |
+    # +----------+--------------+------+-----+---------------------+-------+
+
+    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/models/log.rb

@@ -0,0 +1,20 @@
+module PostfixAdmin
+  class Log < ApplicationRecord
+    # version: 1841
+    # > describe log;
+    # +-----------+--------------+------+-----+---------------------+----------------+
+    # | Field     | Type         | Null | Key | Default             | Extra          |
+    # +-----------+--------------+------+-----+---------------------+----------------+
+    # | timestamp | datetime     | NO   | MUL | 2000-01-01 00:00:00 |                |
+    # | username  | varchar(255) | NO   |     | NULL                |                |
+    # | domain    | varchar(255) | NO   | MUL | NULL                |                |
+    # | action    | varchar(255) | NO   |     | NULL                |                |
+    # | data      | text         | NO   |     | NULL                |                |
+    # | id        | int(11)      | NO   | PRI | NULL                | auto_increment |
+    # +-----------+--------------+------+-----+---------------------+----------------+
+
+    self.table_name = :log
+
+    belongs_to :rel_domain, class_name: "Domain", foreign_key: :domain
+  end
+end

data/lib/postfix_admin/models/mailbox.rb

@@ -0,0 +1,126 @@
+require 'postfix_admin/models/concerns/has_password'
+
+module PostfixAdmin
+  class Mailbox < ApplicationRecord
+    # version: 1841
+    # > describe mailbox;
+    # +----------------+--------------+------+-----+---------------------+-------+
+    # | Field          | Type         | Null | Key | Default             | Extra |
+    # +----------------+--------------+------+-----+---------------------+-------+
+    # | username       | varchar(255) | NO   | PRI | NULL                |       |
+    # | password       | varchar(255) | NO   |     | NULL                |       |
+    # | name           | varchar(255) | NO   |     | NULL                |       |
+    # | maildir        | varchar(255) | NO   |     | NULL                |       |
+    # | quota          | bigint(20)   | NO   |     | 0                   |       |
+    # | local_part     | varchar(255) | NO   |     | NULL                |       |
+    # | domain         | varchar(255) | NO   | MUL | NULL                |       |
+    # | created        | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | modified       | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # | active         | tinyint(1)   | NO   |     | 1                   |       |
+    # | phone          | varchar(30)  | NO   |     |                     |       |
+    # | email_other    | varchar(255) | NO   |     |                     |       |
+    # | token          | varchar(255) | NO   |     |                     |       |
+    # | token_validity | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
+    # +----------------+--------------+------+-----+---------------------+-------+
+
+    self.table_name = :mailbox
+    self.primary_key = :username
+
+    include HasPassword
+
+    # 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
+
+    # quota (KB)
+    validates :quota, 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: "Quota2", 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|
+      next if mailbox.quota == -1
+
+      domain = mailbox.rel_domain
+
+      unless domain.maxquota.zero?
+        if mailbox.quota.zero?
+          mailbox.errors.add(:quota, "cannot be 0")
+        elsif mailbox.quota_mb > domain.maxquota
+          message = "must be less than or equal to #{domain.maxquota} (MB)"
+          mailbox.errors.add(:quota, message)
+        end
+      end
+    end
+
+    before_validation do |mailbox|
+      mailbox.name = "" if mailbox.name.nil?
+      mailbox.username = "#{mailbox.local_part}@#{mailbox.domain}"
+      mailbox.maildir ||= "#{mailbox.domain}/#{mailbox.username}/"
+      mailbox.build_alias(address: mailbox.username, goto: mailbox.username,
+                          domain: mailbox.domain)
+    end
+
+    def quota_mb
+      raise Error, "quota is out of range: #{quota}" if quota < 0
+
+      quota / KB_TO_MB
+    end
+
+    def quota_mb=(value)
+      raise Error, "quota is out of range: #{value}" if value < 0
+
+      self.quota = value * KB_TO_MB
+    end
+
+    def quota_usage_str(format: "%6.1f")
+      usage_mb = if quota_usage
+                   usage_mb = quota_usage.bytes / KB_TO_MB.to_f
+                 else
+                   0.0
+                 end
+
+      format % usage_mb
+    end
+
+    def quota_mb_str(format: "%6.1f")
+      case quota
+      when -1
+        # It's not sure what 'disabled' means for quota.
+        "Disabled"
+      when 0
+        "Unlimited"
+      else
+        quota_mb = quota / KB_TO_MB.to_f
+        format % quota_mb
+      end
+    end
+
+    def quota_display_str(format: "%6.1f")
+      "%s / %s" % [quota_usage_str(format: format), quota_mb_str(format: format)]
+    end
+  end
+end

data/lib/postfix_admin/models/quota2.rb

@@ -0,0 +1,18 @@
+module PostfixAdmin
+  class Quota2 < ApplicationRecord
+    # version: 1841
+    # > describe quota2;
+    # +----------+--------------+------+-----+---------+-------+
+    # | Field    | Type         | Null | Key | Default | Extra |
+    # +----------+--------------+------+-----+---------+-------+
+    # | username | varchar(100) | NO   | PRI | NULL    |       |
+    # | bytes    | bigint(20)   | NO   |     | 0       |       |
+    # | messages | int(11)      | NO   |     | 0       |       |
+    # +----------+--------------+------+-----+---------+-------+
+
+    self.table_name = :quota2
+    self.primary_key = :username
+
+    belongs_to :rel_mailbox, class_name: "Mailbox", foreign_key: :username
+  end
+end

data/lib/postfix_admin/models.rb

@@ -1,10 +1,9 @@
 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'
+require 'postfix_admin/models/application_record'
+require 'postfix_admin/models/admin'
+require 'postfix_admin/models/domain'
+require 'postfix_admin/models/mailbox'
+require 'postfix_admin/models/alias'
+require 'postfix_admin/models/domain_admin'
+require 'postfix_admin/models/log'
+require 'postfix_admin/models/quota2'