postfix_admin 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9877c43c00661c60c1fee5e200211c97cd4cdc8d53593985c3e49f8296d27b9
-  data.tar.gz: 9d9744f09e0a9e3ccdc72af138a4879824f3cd00bc3a1a111d0320a30007ee84
+  metadata.gz: 79176db25ca525f4d2031a41bf66f35895ae7d96d944af8e607c75f7654a1916
+  data.tar.gz: 5d3f6f207505ff525e4e192d6d03747bb5c7cf08e90dad5d313d93893bbb8601
 SHA512:
-  metadata.gz: 86dfd30f6793fd6c13d09e532d7499f2e040dbe654f1bf86299d79b518a96906b6e208fd87c9bbda631d577ccfe39fb08f910e9cc41617be00425c84860d03f2
-  data.tar.gz: f553b648aefc912877d3bcc149258a1d529caa457827f24b04bc4c5d4b45d7fc1397c4189c56ba0e800360320b6295b92abbde0ff344dc56d764995d8d88c448
+  metadata.gz: be19b8e778bf216deb66d9cc922d75022fb32425036def3a8b0642086a56b81b899bf3ec5070f667926b085354a3803da82f9d9b1e09075bae181876e67ac59f
+  data.tar.gz: 6af8ea674a934b5c522880a8c7f5a0c2d1a9c41959e626280f781ff6e6b62065b870830ee288582d49cafe91c83f8c42e535b61d9c62809c510fbdf396f72174

data/CHANGELOG.md

@@ -1,7 +1,10 @@
 # CHANGELOG
 
+## 0.3.2
+  * Added `-d` (description) option for the `setup` subcommand
+
 ## 0.3.1
-  + Added `admins`, `domains`, `accounts`, `aliases` and `forwards` subcommands
+  * Added `admins`, `domains`, `accounts`, `aliases` and `forwards` subcommands
   * Added `teardown` subcommand for the opposite operation of `setup`
   * `delete_domain` subcommand removes logs associated with the domain
   * Added `-s` (scheme) and `-r` (rounds) options for subcommands that require password arguments

data/README.md

@@ -35,6 +35,20 @@ Execute the `postfix_admin` command to generate your config file at `~/.postfix_
 Edit the file for your environment:
 
     $ vi ~/.postfix_admin.conf
+    ---
+    database: mysql2://postfix:password@localhost/postfix
+    aliases: 30
+    mailboxes: 30
+    maxquota: 100
+    scheme: CRAM-MD5
+
+The configuration file format is as follows:
+
+    database: mysql2://<username>:<password>@<host>/<database>
+    aliases: Default maximum number of aliases allowed per domain
+    mailboxes: Default maximum number of mailboxes allowed per domain
+    maxquota: Default maximum quota (in MB) allowed per mailbox for a domain
+    scheme: Default password scheme
 
 You can see the domains on your host if the `database` parameter is set properly:
 

data/docker-compose.yml

@@ -3,7 +3,6 @@
 # Run tests on service app
 # You may need to run tests on Docker because of its requirement of `doveadm` command.
 # docker compose exec app bundle exec rake setup_test_db
-# docker compose exec app bundle exec rake test
 # docker compose exec app bundle exec rake spec
 #
 # rspec spec/runner_spec.rb

data/lib/postfix_admin/base.rb

@@ -122,12 +122,13 @@ module PostfixAdmin
 
       attributes = {
         address: address,
-        goto: goto
+        goto: goto,
+        domain: domain_name
       }
 
-      domain.rel_aliases << Alias.new(attributes)
+      new_alias = Alias.new(attributes)
 
-      raise_save_error(domain) unless domain.save
+      raise_save_error(new_alias) unless new_alias.save
     end
 
     def delete_alias(address)
@@ -153,7 +154,7 @@ module PostfixAdmin
         raise_error "Domain has already been registered: #{domain_name}"
       end
 
-      new_description = description || domain_name
+      new_description = description || ""
 
       domain = Domain.new
       domain.attributes = {
@@ -206,7 +207,8 @@ module PostfixAdmin
     end
 
     def raise_save_error(obj)
-      raise_error "Failed to save #{obj.class}: #{obj.errors.full_messages.join(', ')}"
+      massage = obj.errors.full_messages.join(', ')
+      raise_error "Failed to save #{obj.class}: #{massage}"
     end
 
     def address_split(address)

data/lib/postfix_admin/cli.rb

@@ -60,6 +60,8 @@ module PostfixAdmin
         show_domains
         puts
         show_admins
+        puts
+        show_recent_logs
       end
     end
 
@@ -71,11 +73,23 @@ module PostfixAdmin
       end
     end
 
+    def show_recent_logs
+      if Log.count.zero?
+        puts "No logs"
+        return
+      end
+
+      logs = Log.last(10)
+      puts_title("Recent Logs")
+      puts_log_table(logs)
+    end
+
     # Set up a domain
     # Add a domain, add an admin, and grant the admin access to the domain
-    def setup_domain(domain_name, password, scheme: nil, rounds: nil)
+    def setup_domain(domain_name, password, description: nil,
+                     scheme: nil, rounds: nil)
       admin = "admin@#{domain_name}"
-      add_domain(domain_name)
+      add_domain(domain_name, description: description)
       add_admin(admin, password, scheme: scheme, rounds: rounds)
       add_admin_domain(admin, domain_name)
     end
@@ -139,6 +153,7 @@ module PostfixAdmin
                   "Active", "Description"]
 
       puts_title("Domains")
+
       if Domain.without_all.empty?
         puts "No domains"
         return
@@ -146,9 +161,7 @@ module PostfixAdmin
 
       Domain.without_all.each_with_index do |d, i|
         no = i + 1
-        aliases_str = "%4d / %4s" % [d.pure_aliases.count, d.aliases_str]
-        mailboxes_str = "%4d / %4s" % [d.rel_mailboxes.count, d.mailboxes_str]
-        rows << [no.to_s, d.domain, aliases_str, mailboxes_str,
+        rows << [no.to_s, d.domain, d.alias_usage_display_str, d.mailbox_usage_display_str,
                  d.maxquota_str, d.active_str, d.description]
       end
 
@@ -207,6 +220,7 @@ module PostfixAdmin
       headings = ["No.", "Admin", "Domains", "Active", "Scheme Prefix"]
 
       puts_title("Admins")
+
       if admins.empty?
         puts "No admins"
         return
@@ -235,6 +249,7 @@ module PostfixAdmin
                   "Scheme Prefix", "Maildir"]
 
       puts_title("Accounts")
+
       if mailboxes.empty?
         puts "No accounts"
         return
@@ -276,6 +291,7 @@ module PostfixAdmin
     def show_admin_domain(user_name)
       admin = Admin.find(user_name)
       puts_title("Admin Domains (#{user_name})")
+
       if admin.rel_domains.empty?
         puts "\nNo domains for #{user_name}"
         return
@@ -286,6 +302,7 @@ module PostfixAdmin
         no = i + 1
         rows << [no.to_s, d.domain]
       end
+
       puts_table(rows: rows, headings: %w[No. Domain])
     end
 
@@ -331,7 +348,7 @@ module PostfixAdmin
 
     def edit_account(address, options)
       quota = options[:quota]
-      raise "Invalid Quota value: #{quota}" if quota && quota <= 0
+      raise "Invalid Quota value: #{quota}" if quota && quota < 0
 
       mailbox_check(address)
       mailbox = Mailbox.find(address)
@@ -377,7 +394,7 @@ module PostfixAdmin
     end
 
     def log(domain: nil, last: nil)
-      headings = %w[Timestamp Admin Domain Action Data]
+      headings = %w[No. Timestamp Admin Domain Action Data]
       rows = []
 
       logs = if domain
@@ -388,10 +405,17 @@ module PostfixAdmin
 
       logs = logs.last(last) if last
 
-      logs.each do |l|
+      puts_log_table(logs)
+    end
+
+    def puts_log_table(logs)
+      headings = %w[No. Timestamp Admin Domain Action Data]
+      rows = []
+      logs.each_with_index do |l, i|
+        no = i + 1
         # TODO: Consider if zone should be included ('%Z').
         time = l.timestamp.strftime("%Y-%m-%d %X")
-        rows << [time, l.username, l.domain, l.action, l.data]
+        rows << [no, time, l.username, l.domain, l.action, l.data]
       end
 
       puts_table(headings: headings, rows: rows)
@@ -404,24 +428,28 @@ module PostfixAdmin
         puts [a.username, %Q!"#{a.password}"!, a.super_admin?, a.active].join(',')
       end
       puts
+
       puts "Domains"
       puts "Domain Name,Max Quota,Active"
       Domain.without_all.each do |d|
         puts [d.domain, 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|
@@ -438,6 +466,7 @@ module PostfixAdmin
       rows << ["Admins", Admin.count]
       rows << ["Mailboxes", Mailbox.count]
       rows << ["Aliases", Alias.pure.count]
+      rows << ["Logs", Log.count]
 
       puts_title(title)
       puts_table(rows: rows)
@@ -449,8 +478,8 @@ module PostfixAdmin
 
       rows = []
       domain = Domain.find(domain_name)
-      rows << ["Mailboxes", "%4d / %4s" % [domain.rel_mailboxes.count, domain.mailboxes_str]]
-      rows << ["Aliases", "%4d / %4s" % [domain.pure_aliases.count, domain.aliases_str]]
+      rows << ["Mailboxes", domain.mailbox_usage_display_str]
+      rows << ["Aliases", domain.alias_usage_display_str]
       rows << ["Max Quota (MB)", domain.maxquota_str]
       rows << ["Active", domain.active_str]
       rows << ["Description", domain.description]
@@ -505,6 +534,7 @@ module PostfixAdmin
         puts "configure file: #{config_file} was generated.\nPlease execute after edit it."
         exit
       end
+
       open(config_file) do |f|
         YAML.load(f.read)
       end

data/lib/postfix_admin/models/admin.rb

@@ -1,4 +1,5 @@
-require 'postfix_admin/models/concerns/has_password'
+require "postfix_admin/models/application_record"
+require "postfix_admin/models/concerns/has_password"
 
 module PostfixAdmin
   class Admin < ApplicationRecord

data/lib/postfix_admin/models/alias.rb

@@ -1,3 +1,5 @@
+require "postfix_admin/models/application_record"
+
 module PostfixAdmin
   class Alias < ApplicationRecord
     # version: 1841
@@ -18,10 +20,16 @@ module PostfixAdmin
 
     validate on: :create do |a|
       domain = a.rel_domain
-      if domain.aliases.zero? || a.mailbox
-      elsif domain.rel_aliases.pure.count >= domain.aliases
-        message = "already has the maximum number of aliases " \
-                  "(maximum is #{domain.aliases} aliases)"
+
+      if domain.alias_unlimited?
+        # unlimited: do nothing
+      elsif domain.alias_disabled?
+        # disabled
+        a.errors.add(:domain, "has a disabled status for aliases")
+      elsif domain.pure_alias_count >= domain.aliases
+        # exceeding alias limit
+        message = "has already reached the maximum number of aliases " \
+          "(maximum: #{domain.aliases})"
         a.errors.add(:domain, message)
       end
     end

data/lib/postfix_admin/models/application_record.rb

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

data/lib/postfix_admin/models/domain.rb

@@ -1,3 +1,5 @@
+require "postfix_admin/models/application_record"
+
 module PostfixAdmin
   class Domain < ApplicationRecord
     # version: 1841
@@ -18,6 +20,9 @@ module PostfixAdmin
     # | active      | tinyint(1)   | NO   |     | 1                   |       |
     # +-------------+--------------+------+-----+---------------------+-------+
 
+    UNLIMITED = 0
+    DISABLED  = -1
+
     self.table_name = :domain
     self.primary_key = :domain
 
@@ -84,6 +89,22 @@ module PostfixAdmin
       rel_aliases.pure
     end
 
+    def mailbox_count
+      rel_mailboxes.count
+    end
+
+    def pure_alias_count
+      pure_aliases.count
+    end
+
+    def mailbox_usage_display_str
+      "%4d / %4s" % [mailbox_count, mailboxes_str]
+    end
+
+    def alias_usage_display_str
+      "%4d / %4s" % [pure_alias_count, aliases_str]
+    end
+
     def aliases_str
       max_num_str(aliases)
     end
@@ -96,13 +117,33 @@ module PostfixAdmin
       max_num_str(maxquota)
     end
 
+    def mailbox_unlimited?
+      mailboxes == UNLIMITED
+    end
+
+    def alias_unlimited?
+      aliases == UNLIMITED
+    end
+
+    def maxquota_unlimited?
+      maxquota.zero?
+    end
+
+    def mailbox_disabled?
+      mailboxes == DISABLED
+    end
+
+    def alias_disabled?
+      aliases == DISABLED
+    end
+
     private
 
     def max_num_str(num)
       case num
-      when -1
+      when DISABLED
         "Disabled"
-      when 0
+      when UNLIMITED
         "Unlimited"
       else
         num.to_s

data/lib/postfix_admin/models/domain_admin.rb

@@ -1,3 +1,5 @@
+require "postfix_admin/models/application_record"
+
 module PostfixAdmin
   class DomainAdmin < ApplicationRecord
     # version: 1841

data/lib/postfix_admin/models/log.rb

@@ -1,3 +1,5 @@
+require "postfix_admin/models/application_record"
+
 module PostfixAdmin
   class Log < ApplicationRecord
     # version: 1841

data/lib/postfix_admin/models/mailbox.rb

@@ -1,4 +1,5 @@
-require 'postfix_admin/models/concerns/has_password'
+require "postfix_admin/models/application_record"
+require "postfix_admin/models/concerns/has_password"
 
 module PostfixAdmin
   class Mailbox < ApplicationRecord
@@ -23,13 +24,14 @@ module PostfixAdmin
     # | token_validity | datetime     | NO   |     | 2000-01-01 00:00:00 |       |
     # +----------------+--------------+------+-----+---------------------+-------+
 
+    UNLIMITED_QUOTA = 0
+    DISABLED_QUOTA  = -1
+
     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" }
@@ -48,9 +50,16 @@ module PostfixAdmin
 
     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)"
+
+      if domain.mailbox_unlimited?
+        # unlimited: do nothing
+      elsif domain.mailbox_disabled?
+        # disabled
+        mailbox.errors.add(:domain, "has a disabled status for mailboxes")
+      elsif domain.mailbox_count >= domain.mailboxes
+        # exceeding mailbox limit
+        message = "has already reached the maximum number of mailboxes " \
+          "(maximum: #{domain.mailboxes})"
         mailbox.errors.add(:domain, message)
       end
     end
@@ -62,17 +71,21 @@ module PostfixAdmin
     end
 
     validate do |mailbox|
-      next if mailbox.quota == -1
+      next if mailbox.quota == DISABLED_QUOTA
 
       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
+      next if domain.maxquota_unlimited?
+
+      # Quota limit
+      message = "must be less than or equal to #{domain.maxquota} MB"
+      if mailbox.quota_unlimited?
+        # trying to set quota to 0 (unlimited) even when domain's maxquota is not unlimited
+        mailbox.errors.add(:quota, "cannot be set to 0 (unlimited)")
+        mailbox.errors.add(:quota, message)
+      elsif mailbox.quota_mb > domain.maxquota
+        # trying to set quota to value greater than domain's maxquota
+        mailbox.errors.add(:quota, message)
       end
     end
 
@@ -84,6 +97,10 @@ module PostfixAdmin
                           domain: mailbox.domain)
     end
 
+    def quota_unlimited?
+      quota.zero?
+    end
+
     def quota_mb
       raise Error, "quota is out of range: #{quota}" if quota < 0
 
@@ -108,10 +125,10 @@ module PostfixAdmin
 
     def quota_mb_str(format: "%6.1f")
       case quota
-      when -1
+      when DISABLED_QUOTA
         # It's not sure what 'disabled' means for quota.
         "Disabled"
-      when 0
+      when UNLIMITED_QUOTA
         "Unlimited"
       else
         quota_mb = quota / KB_TO_MB.to_f

data/lib/postfix_admin/models/quota2.rb

@@ -1,3 +1,5 @@
+require "postfix_admin/models/application_record"
+
 module PostfixAdmin
   class Quota2 < ApplicationRecord
     # version: 1841

data/lib/postfix_admin/runner.rb

@@ -55,17 +55,21 @@ module PostfixAdmin
       runner { @cli.show_forwards }
     end
 
-    desc "setup example.com password", "Set up a domain (add a domain and an admin user for it)"
+    desc "setup example.com password",
+         "Set up a domain (add a domain and an admin user for it)"
+    method_option :description, type: :string, aliases: "-d", desc: "description"
     method_option :scheme, type: :string, aliases: "-s", desc: "password scheme"
     method_option :rounds, type: :string, aliases: "-r", desc: "encryption rounds for BLF-CRYPT, SHA256-CRYPT and SHA512-CRYPT schemes"
     def setup(domain_name, password)
       runner do
         @cli.setup_domain(domain_name, password,
+                          description: options[:description],
                           scheme: options[:scheme], rounds: options[:rounds])
       end
     end
 
-    desc "teardown example.com", "Tear down a domain (delete a domain and an admin user for it)"
+    desc "teardown example.com",
+         "Tear down a domain (delete a domain and an admin user for it)"
     def teardown(domain_name)
       runner { @cli.teardown_domain(domain_name) }
     end
@@ -99,11 +103,11 @@ module PostfixAdmin
     end
 
     desc "edit_domain example.com", "Edit a domain"
-    method_option :aliases,   type: :numeric, aliases: "-a", desc: "Edit aliases limitation"
-    method_option :mailboxes, type: :numeric, aliases: "-m", desc: "Edit mailboxes limitation"
-    method_option :maxquota,  type: :numeric, aliases: "-q", desc: "Edit max quota limitation"
+    method_option :aliases,   type: :numeric, aliases: "-a", desc: "Update aliase limit"
+    method_option :mailboxes, type: :numeric, aliases: "-m", desc: "Update mailboxe limit"
+    method_option :maxquota,  type: :numeric, aliases: "-q", desc: "Update maximum quota limit (MB)"
     method_option :active, type: :boolean, desc: "Update active status"
-    method_option :description, type: :string, aliases: "-d", desc: "Edit description"
+    method_option :description, type: :string, aliases: "-d", desc: "Update description"
     def edit_domain(domain_name)
       runner do
         if options.size == 0
@@ -153,11 +157,11 @@ module PostfixAdmin
 
     desc "edit_account user@example.com", "Edit an account"
     method_option :goto,  type: :string,  aliases: "-g",
-                  desc: "mailboxes, addresses e-mails are delivered to"
+                  desc: "Update mailboxes, addresses emails are delivered to"
     method_option :quota, type: :numeric, aliases: "-q",
-                  desc: "quota limitation (MB)"
+                  desc: "Update quota limit (MB)"
     method_option :name,  type: :string,  aliases: "-n",
-                  desc: "full name"
+                  desc: "Update full name"
     method_option :active, type: :boolean,
                   desc: "Update active status"
     def edit_account(address)

data/lib/postfix_admin/version.rb

@@ -1,3 +1,3 @@
 module PostfixAdmin
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: postfix_admin
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Hitoshi Kurokawa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-10 00:00:00.000000000 Z
+date: 2024-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor