postfix_admin 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in postfix_admin.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Hitoshi Kurokawa
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# PostfixAdmin
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'postfix_admin'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install postfix_admin
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/postfix_admin

@@ -0,0 +1,101 @@
+#!/usr/bin/env ruby
+
+require 'thor'
+require 'postfix_admin'
+require 'postfix_admin/cli'
+
+class PostfixAdminCommand < Thor
+  def initialize(*args)
+    super
+    @cli = PostfixAdmin::CLI.new
+  end
+  desc "show", "List of domains"
+  def show(domain=nil)
+    if domain
+      @cli.show_domain_account(domain)
+    else
+      @cli.show_domain
+      @cli.show_admin
+    end
+  end
+
+  desc "add_domain", "add a domain"
+  def add_domain(domain=nil)
+    if domain
+      if @cli.add_domain(domain)
+        puts %Q!"#{domain}" is successfully registered.!
+      end
+      @cli.show_domain
+    else
+      puts "USAGE: #{$0} add_domain example.com"
+      exit
+    end
+  end
+
+  desc "delete_domain", "delete a domain"
+  def delete_domain(domain=nil)
+    if domain
+      if @cli.delete_domain(domain)
+        puts %Q!"#{domain}" is successfully deleted.!
+      end
+      @cli.show_domain
+    else
+      puts "USAGE: #{$0} delete_domain example.com"
+      exit
+    end
+  end
+
+  desc "add_account", "add an account"
+  def add_account(address=nil,password=nil)
+    if address && password
+      if @cli.add_account(address, password)
+        puts %Q!"#{address}" is successfully registered.!
+      end
+      @cli.show_domain_account(address.split(/@/)[1])
+    else
+      puts "USAGE: #{$0} add_account user@example.com password"
+      exit
+    end
+  end
+
+  desc "add_admin", "add an admin user"
+  def add_admin(user_name=nil, password=nil)
+    if user_name && password
+      if @cli.add_admin(user_name, password)
+      puts %Q!"#{user_name}" is successfully registered as admin.!
+      end
+      @cli.show_admin
+    else
+      puts "USAGE: #{$0} add_admin user@example.com password"
+      exit
+    end
+  end
+
+  desc "add_admin_domain", "add admin_domain"
+  def add_admin_domain(user_name=nil, domain=nil)
+    if user_name && domain
+      if @cli.add_admin_domain(user_name, domain)
+        puts %Q!"#{domain}" is appended in the domains of #{user_name}.!
+      end
+      @cli.show_admin_domain(user_name)
+    else
+      puts "USAGE: #{$0} add_admin_domain user@example.com example.com"
+      exit
+    end
+  end
+
+  desc "add_alias", "add an alias"
+  def add_alias(address=nil, goto=nil)
+    if address && goto
+      if @cli.add_alias(address, goto)
+        puts %Q!"#{address}: #{goto}" is successfully registered as alias.!
+      end
+      @cli.show_domain_account(address.split(/@/)[1])
+    else
+      puts "USAGE: #{$0} add_alias user@example.com goto@example.com"
+      exit
+    end
+  end
+end
+
+PostfixAdminCommand.start

data/lib/postfix_admin/cli.rb

@@ -0,0 +1,123 @@
+require 'yaml'
+require 'postfix_admin'
+
+class PostfixAdmin
+  class CLI
+    CONFIG_FILE = '.postfix_admin.conf'
+    MIN_NUM_PASSWORD_CHARACTER = 5
+
+    def initialize
+      @config = load_config
+      @admin = PostfixAdmin.new(@config)
+    end
+    # ~/.postfix_adminrc
+    # database: mysql://postfix:password@localhost/postfix
+    # aliases: 30
+    # mailboxes: 30
+    # maxquota: 100
+    def load_config
+      unless File.exist?(config_file)
+        create_config
+        puts "configure file: #{config_file} was generated.\nPlease execute after edit it."
+        exit
+      end
+      open(config_file) do |f|
+        YAML.load(f.read)
+      end
+    end
+    def create_config
+      config = {
+        'database'  => 'mysql://postfix:password@localhost/postfix',
+        'aliases'   => 30,
+        'mailboxes' => 30,
+        'maxquota'  => 100
+      }
+      open(config_file, 'w') do |f|
+        f.write config.to_yaml
+      end
+      File.chmod(0600, config_file)
+    end
+    def config_file
+      File.expand_path(CONFIG_FILE, ENV['HOME'])
+    end
+    def print_line
+      puts "-"*85
+    end
+    def show_domain
+      print_line
+      puts " No.   domain             alias mail quota"
+      print_line
+      @admin.domains.each_with_index do |domain, i|
+        printf("%4d %-20s %4d %4d %4d\n", i+1, domain.domain, domain.aliases, domain.mailboxes, domain.maxquota)
+      end
+      print_line
+    end
+    def show_admin
+      admins = @admin.admins
+      if admins.count == 0
+        puts "No admin in database\n"
+        return
+      end
+      print_line
+      puts " No.   username           password"
+      print_line
+      admins.each_with_index do |admin, i|
+        printf("%4d %-20s %10s\n", i+1, admin.username, admin.password)
+      end
+      print_line
+    end
+    def show_domain_account(domain)
+      mailboxes = @admin.mailboxes(domain)
+      if mailboxes.count == 0
+        puts "No address in #{domain}\n"
+        return
+      end
+      print_line
+      puts " No.   address             password  quota(M) maildir"
+      print_line
+      mailboxes.each_with_index do |mailbox, i|
+        printf("%4d %-20s %10s %7.1f  %-30s\n", i+1, mailbox.username, mailbox.password, mailbox.quota.to_f/1024000.0, mailbox.maildir)
+      end
+      print_line
+    end
+    def show_admin_domain(user_name)
+      domain_admins = @admin.admin_domains(user_name)
+      if domain_admins.count == 0
+        puts "No domain in database\n"
+        return
+      end
+      print_line
+      puts " No.   domain"
+      print_line
+      domain_admins.each_with_index do |domain_admin, i|
+        printf("%4d %-20s\n", i+1, domain_admin.domain)
+      end
+      print_line
+    end
+    def add_domain(domain)
+      @admin.add_domain(domain)
+    end
+    def add_admin(user_name, password)
+      validate_password(password)
+      @admin.add_admin(user_name, password)
+    end
+    def add_account(address, password)
+      validate_password(password)
+      @admin.add_account(address, password)
+    end
+    def add_alias(address, goto)
+      @admin.add_alias(address, goto)
+    end
+    def add_admin_domain(user_name, domain)
+      @admin.add_admin_domain(user_name, domain)
+    end
+    def delete_domain(domain)
+      @admin.delete_domain(domain)
+    end
+    def validate_password(password)
+      if password.size < MIN_NUM_PASSWORD_CHARACTER
+        raise "Error: Password is too short. It should be larger than #{MIN_NUM_PASSWORD_CHARACTER}"
+      end
+    end
+  end
+end

data/lib/postfix_admin/models.rb

@@ -0,0 +1,61 @@
+require 'data_mapper'
+
+class PostfixAdmin
+  class Admin
+    include ::DataMapper::Resource
+    property :username, String, :key => true
+    property :password, String
+    property :created, DateTime
+    property :modified, DateTime
+
+    storage_names[:default] = 'admin'
+  end
+
+  class Domain
+    include ::DataMapper::Resource
+    property :domain, String, :key => true
+    property :aliases, Integer
+    property :mailboxes, Integer
+    property :maxquota, Integer
+    property :transport, String
+    property :backupmx, Integer
+    property :description, String
+
+    storage_names[:default] = 'domain'
+  end
+
+  class DomainAdmin
+    include ::DataMapper::Resource
+    property :username, String, :key => true
+    property :domain, String, :key => true
+    property :created, DateTime
+
+    storage_names[:default] = 'domain_admins'
+  end
+
+  class Mailbox
+    include ::DataMapper::Resource
+    property :username, String, :key => true
+    property :name, String
+    property :password, String
+    property :domain, String
+    property :maildir, String
+    property :quota, Integer
+    #  property :local_part, String
+    property :created, DateTime
+    property :modified, DateTime
+
+    storage_names[:default] = 'mailbox'
+  end
+
+  class Alias
+    include ::DataMapper::Resource
+    property :address, String, :key => true
+    property :goto, Text, :key => true
+    property :domain, String
+    property :created, DateTime
+    property :modified, DateTime
+
+    storage_names[:default] = 'alias'
+  end
+end

data/lib/postfix_admin/version.rb

@@ -0,0 +1,3 @@
+class PostfixAdmin
+  VERSION = "0.0.1"
+end

data/lib/postfix_admin.rb

@@ -0,0 +1,158 @@
+require "postfix_admin/version"
+require 'postfix_admin/models'
+
+require 'date'
+require 'data_mapper'
+
+class PostfixAdmin
+  def initialize(config)
+    DataMapper.setup(:default, config['database'])
+    DataMapper.finalize
+    @config = {}
+    @config[:aliases]   = config['aliases']   || 30
+    @config[:mailboxes] = config['mailboxes'] || 30
+    @config[:maxquota]  = config['maxquota']  || 100
+    @config[:mailbox_quota] = @config[:maxquota] * 1024 * 1000
+  end
+  def add_admin_domain(username, domain)
+    unless admin_exist?(username)
+      raise "Error: #{username} is not resistered as admin."
+    end
+    unless domain_exist?(domain)
+      raise "Error: Invalid domain #{domain}!"
+    end
+    if admin_domain_exist?(username, domain)
+      raise "Error: #{username} is already resistered as admin of #{domain}."
+    end
+
+    domain_admin = DomainAdmin.new
+    domain_admin.attributes = {
+      :username => username,
+      :domain   => domain,
+      :created  => DateTime.now
+    }
+    domain_admin.save
+  end
+  def add_admin(username, password)
+    if admin_exist?(username)
+      raise "Error: #{username} is already resistered as admin."
+    end
+    admin = Admin.new
+    admin.attributes = {
+      :username => username,
+      :password => password,
+      :created  => DateTime.now,
+      :modified => DateTime.now
+    }
+    admin.save
+  end
+  def add_account(address, password)
+    if address !~ /.+\@.+\..+/
+      raise "Error: Invalid mail address! #{address}"
+    end
+    user, domain = address.split(/@/)
+    path = "#{domain}/#{address}/"
+
+    unless domain_exist?(domain)
+      raise "Error: Invalid domain! #{address}"
+    end
+
+    if alias_exist?(address)
+      raise "Error: #{address} is already resistered."
+    end
+    mail_alias = Alias.new
+    mail_alias.attributes = {
+      :address  => address,
+      :goto     => address,
+      :domain   => domain,
+      :created  => DateTime.now,
+      :modified => DateTime.now
+    }
+    mail_alias.save
+
+    mailbox = Mailbox.new
+    mailbox.attributes = {
+      :username => address,
+      :password => password,
+      :name     => '',
+      :maildir  => path,
+      :quota    => @config[:mailbox_quota],
+      :domain   => domain,
+      # :local_part => user,
+      :created  => DateTime.now,
+      :modified => DateTime.now
+    }
+    mailbox.save
+  end
+  def add_alias(address, goto)
+    if alias_exist?(address)
+      goto_text = "#{address},#{goto}"
+      mail_alias = Alias.first(:address => address)
+      mail_alias.update(:goto => goto_text, :modified => DateTime.now)
+    else
+      raise "Error: Invalid mail address! #{address}"
+    end
+  end
+  def add_domain(domain_name)
+    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      => domain_name,
+      :description => domain_name,
+      :aliases     => @config[:aliases],
+      :mailboxes   => @config[:mailboxes],
+      :maxquota    => @config[:maxquota],
+      :transport   => "virtual",
+      :backupmx    => 0
+    }
+    domain.save
+  end
+  def delete_domain(domain)
+    unless domain_exist?(domain)
+      raise "Error: #{domain} is not found!"
+    end
+    username = "admin@#{domain}"
+    Admin.all(:username => username).destroy
+    DomainAdmin.all(:username => username).destroy
+    Mailbox.all(:domain => domain).destroy
+    Alias.all(:domain => domain).destroy
+    Domain.all(:domain => domain).destroy
+  end
+  def admin_domain_exist?(username, domain)
+    DomainAdmin.all(:username => username, :domain => domain).count != 0
+  end
+  def admin_exist?(admin)
+    Admin.all(:username => admin).count != 0
+  end
+  def alias_exist?(address)
+    Alias.all(:address => address).count != 0
+  end
+  def domain_exist?(domain)
+    Domain.all(:domain => domain).count != 0
+  end
+  def domains
+    Domain.all(:domain.not => 'ALL', :order => :domain)
+  end
+  def admins
+    Admin.all(:order => 'username')
+  end
+  def mailboxes(domain=nil)
+    if domain
+      Mailbox.all(:domain => domain, :order => :username)
+    else
+      Mailbox.all(:order => :username)
+    end
+  end
+  def admin_domains(username=nil)
+    if username
+      DomainAdmin.all(:username => username, :order => :domain)
+    else
+      DomainAdmin.all(:order => :domain)
+    end
+  end
+end

data/postfix_admin.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/postfix_admin/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_development_dependency 'thor'
+  gem.add_development_dependency 'data_mapper'
+  gem.add_development_dependency 'dm-mysql-adapter'
+
+  gem.authors       = ["Hitoshi Kurokawa"]
+  gem.email         = ["hitoshi@nextseed.jp"]
+  gem.description   = %q{Command Line Tools of PostfixAdmin}
+  gem.summary       = gem.description
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "postfix_admin"
+  gem.require_paths = ["lib"]
+  gem.version       = PostfixAdmin::VERSION
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: postfix_admin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Hitoshi Kurokawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dm-mysql-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Command Line Tools of PostfixAdmin
+email:
+- hitoshi@nextseed.jp
+executables:
+- postfix_admin
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/postfix_admin
+- lib/postfix_admin.rb
+- lib/postfix_admin/cli.rb
+- lib/postfix_admin/models.rb
+- lib/postfix_admin/version.rb
+- postfix_admin.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Command Line Tools of PostfixAdmin
+test_files: []