hast 0.2.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Thomas Watson Steen
+
+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.rdoc

@@ -0,0 +1,61 @@
+= HAST
+
+HAST stands for 'Hosting Account Status Tool'.
+
+HAST is a tool for fetching domains from Apache configuration files and
+from the Postfix database on a hosting server environment. It will then
+run a report, checking the DNS records for each domain to see if they
+match your server.
+
+This is important for finding "dead" domains where the domain either
+doesn't exist anymore or where the owner have moved it to another
+hosting provider.
+
+Before you can use HAST, you need to setup a config.yml file. Use
+config.yml.example as a template.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future
+  version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version
+  in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Usage 
+
+  hast config-file [options]
+
+For help use: hast -h
+
+=== Options
+
+  -h, --help                Displays help message
+  -v, --version             Display version
+  -g, --generate-config     Output a config file template (pipe it to a
+                            file for easy use: hast -g > config.yml)
+  -q, --no-dns              Do not lookup any domain names or MX records
+  -y, --yaml                Output as YAML (usefull if you want to pipe:
+                            bau.rb > domains.yml)
+  -c, --domain-cache FILE   Get the domains from a YAML file
+
+=== Examples
+
+Generate a human-readable report:
+  hast config.yml
+
+Do not perfom DNS lookups:
+  hast config.yml -q
+
+Do not perfom DNS lookups and genereate a YAML file with the result:
+  hast config.yml -yq > domains.yml
+
+Load the domains to check from a YAML file:
+  hast config.yml -c domains.yml
+
+== Copyright
+
+Copyright (c) 2010 Thomas Watson Steen. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hast"
+    gem.summary = %Q{Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
+    gem.description = <<-EOF
+      HAST stands for 'Hosting Account Status Tool'.
+
+      HAST is a tool for fetching domains from Apache configuration files and
+      from the Postfix database on a hosting server environment. It will then
+      run a report, checking the DNS records for each domain to see if they
+      match your server.
+
+      This is important for finding "dead" domains where the domain either
+      doesn't exist anymore or where the owner have moved it to another
+      hosting provider.
+
+      Before you can use HAST, you need to setup a config.yml file. Use
+      config.yml.example as a template.
+    EOF
+    gem.email = "w@tson.dk"
+    gem.homepage = "http://github.com/watson/hast"
+    gem.authors = ["Thomas Watson Steen"]
+    gem.add_development_dependency "mysql", ">= 0"
+    gem.add_development_dependency "net-dns", ">= 0"
+    gem.add_development_dependency "deep_merge", ">= 0.1.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+task :default => :version

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/hast

@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/../lib/hast'
+Hast.new

data/config.yml.example

@@ -0,0 +1,58 @@
+dns:
+  # The nameserver used when looking op domains.
+  #
+  # In most cases you can just leave this as 8.8.8.8 which is the
+  # primary Google nameserver.
+  #
+  nameserver: '8.8.8.8'
+
+apache:
+  # The IP address of your Apache webserver.
+  #
+  # This is the one you expect all of your domians to resolve to.
+  #
+  ip: '192.168.0.1'
+
+  # The location of the main Apache config file.
+  #
+  # HAST will automatically load any depended configuration files that
+  # are included using the Apache 'Include' option.
+  #
+  config: '/usr/local/etc/apache22/httpd.conf'
+
+  # The configuration files specified using the Apache 'Include' option
+  # might not be specified using the absolute path. Use this option to
+  # prepend a path to the 'Include'-values.
+  #
+  base_path: '/usr/local'
+
+  # Enable this option to make HAST seach for domains in a directory as
+  # well as in the Apache configuration files.
+  #
+  # The names of all entries in this directory will be treated as
+  # domain names. This can be needed when the hosting solution involves
+  # Mass-Virtual-Hosting where the Apache Virtual-Hosts are created
+  # runtime by just adding directories to a specific folder on the
+  # filesystem.
+  #
+  #extra_domains_directory: '/usr/local/www/apache22/vhosts/'
+
+postfix:
+  # The IP address of your Postfix mail-server.
+  #
+  # This is the one you expect all of your MX records to resolve to.
+  #
+  ip: '192.168.0.2'
+
+  # HAST needs access to the Postfix MySQL database to figure out which
+  # domains you are hosting mail for.
+  #
+  # Use theese options to specify the servername (host), the database
+  # user and password and finally the name of the database used by
+  # Postfix.
+  #
+  mysql:
+    host: localhost
+    user: postfix
+    password: secret
+    database: postfix

data/hast.gemspec

@@ -0,0 +1,74 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hast}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Thomas Watson Steen"]
+  s.date = %q{2010-02-17}
+  s.default_executable = %q{hast}
+  s.description = %q{      HAST stands for 'Hosting Account Status Tool'.
+
+      HAST is a tool for fetching domains from Apache configuration files and
+      from the Postfix database on a hosting server environment. It will then
+      run a report, checking the DNS records for each domain to see if they
+      match your server.
+
+      This is important for finding "dead" domains where the domain either
+      doesn't exist anymore or where the owner have moved it to another
+      hosting provider.
+
+      Before you can use HAST, you need to setup a config.yml file. Use
+      config.yml.example as a template.
+}
+  s.email = %q{w@tson.dk}
+  s.executables = ["hast"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/hast",
+     "config.yml.example",
+     "hast.gemspec",
+     "lib/hast.rb",
+     "lib/hast/apache.rb",
+     "lib/hast/postfix.rb",
+     "lib/hast/verifier.rb"
+  ]
+  s.homepage = %q{http://github.com/watson/hast}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<mysql>, [">= 0"])
+      s.add_development_dependency(%q<net-dns>, [">= 0"])
+      s.add_development_dependency(%q<deep_merge>, [">= 0.1.0"])
+    else
+      s.add_dependency(%q<mysql>, [">= 0"])
+      s.add_dependency(%q<net-dns>, [">= 0"])
+      s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
+    end
+  else
+    s.add_dependency(%q<mysql>, [">= 0"])
+    s.add_dependency(%q<net-dns>, [">= 0"])
+    s.add_dependency(%q<deep_merge>, [">= 0.1.0"])
+  end
+end
+

data/lib/hast/apache.rb

@@ -0,0 +1,60 @@
+module HAST
+  class Apache
+    attr_reader :domains
+
+    def initialize(config)
+      @config = config
+
+      config_files = find_config_files(@config['apache']['config'])
+
+      domains = find_domains_in_config(config_files)
+      domains << find_extra_domains if @config['apache']['extra_domains_directory']
+      domains.flatten!
+      domains.uniq!
+
+      @domains = domains
+    end
+
+    private
+
+    def find_pattern_in_file(filename, pattern, ignore_pattern = /^\s*#/, &block)
+      File.open(filename).each_line do |line|
+        line.chomp!
+        next if line =~ ignore_pattern
+        if match = line.match(pattern)
+          yield match
+        end
+      end
+    end
+
+    def find_config_files(filename)
+      config_files = [filename]
+      find_pattern_in_file(filename, /^\s*Include\s+(.*)$/i) do |match|
+        # the include file might be a filename pattern instead of a real filname
+        Dir.glob(@config['apache']['base_path'] + match[1]).each do |include_file|
+          config_files << find_config_files(include_file)
+        end
+      end
+      config_files.flatten.uniq
+    end
+
+    def find_domains_in_config(config_files)
+      domains = []
+      config_files.each do |filename|
+        find_pattern_in_file(filename, /^\s*(ServerName|ServerAlias)\s+(.*)$/i) do |match|
+          domains << match[2].split.map { |domain| domain.gsub(/:\d+$/, '') }
+        end
+      end
+      domains.flatten.uniq
+    end
+
+    def find_extra_domains
+      domains = []
+      Dir.foreach(@config['apache']['extra_domains_directory']) do |entry|
+        next if entry =~ /^\.\.?$/
+        domains << entry
+      end
+      domains
+    end
+  end
+end

data/lib/hast/postfix.rb

@@ -0,0 +1,29 @@
+require 'mysql'
+
+module HAST
+  class Postfix
+    attr_reader :domains
+
+    def initialize(config)
+      @config = config
+      @domains = []
+
+      dbh = Mysql.real_connect(@config['postfix']['mysql']['host'],
+                               @config['postfix']['mysql']['user'],
+                               @config['postfix']['mysql']['password'],
+                               @config['postfix']['mysql']['database'])
+
+      results = dbh.query('SELECT domain FROM domain')
+      results.each do |row|
+        next if row[0] == 'ALL'
+        @domains << row[0]
+      end
+    rescue Mysql::Error => e
+      puts "Error code: #{e.errno}"
+      puts "Error message: #{e.error}"
+      puts "Error SQLSTATE: #{e.sqlstate}" if e.respond_to?("sqlstate")
+    ensure
+      dbh.close if dbh
+    end
+  end
+end

data/lib/hast/verifier.rb

@@ -0,0 +1,72 @@
+require 'net/dns/resolver'
+
+module HAST
+  class Verifier
+    class << self
+      def run(config, domains, type, &output_block)
+        instance = self.new(config, domains, type, &output_block)
+        instance.verify_domains
+      end
+    end
+
+    def initialize(config, domains, type, &output_block)
+      @config = config
+      @domains = domains
+      @type = type
+      @output_block = output_block
+      @dns = Net::DNS::Resolver.new
+      @dns.nameservers = @config['dns']['nameserver']
+    end
+
+    def verify_domains
+      @domains.each do |domain|
+        if @config['dns']['disable']
+          ips = nil
+        else
+          case @type
+          when :web
+            ips = get_server_ips(domain)
+            expected_ip = @config['apache']['ip']
+          when :mail
+            ips = get_mailserver_ips(domain)
+            expected_ip = @config['postfix']['ip']
+          end
+        end
+
+        if ips.nil?
+          @output_block.call domain, max_length, :unknown
+        elsif ips.empty?
+          @output_block.call domain, max_length, :inactive
+        elsif ips.include? expected_ip
+          @output_block.call domain, max_length, :active
+        else
+          @output_block.call domain, max_length, :other, ips
+        end
+      end
+    end
+
+    private
+
+    def max_length
+      max_length = 0
+      @domains.each do |domain|
+        max_length = domain.length if domain.length > max_length
+      end
+      max_length
+    end
+
+    def get_server_ips(domain)
+      ips = []
+      @dns.query(domain).each_address { |ip| ips << ip.to_s }
+      ips
+    end
+
+    def get_mailserver_ips(domain)
+      ips = []
+      @dns.query(domain, Net::DNS::MX).each_mx do |pref, name|
+        ips << get_server_ips(name)
+      end
+      ips.flatten.uniq
+    end
+  end
+end

data/lib/hast.rb

@@ -0,0 +1,128 @@
+require 'rubygems'
+require 'optparse'
+require 'yaml'
+require 'deep_merge'
+require 'hast/apache'
+require 'hast/postfix'
+require 'hast/verifier'
+
+class Hast
+  NAME = "HAST - Hosting Account Status Tool"
+
+  attr_reader :config
+
+  def initialize
+    parse_command_line_args
+    load_config
+    load_domains
+    verify_domains
+  end
+
+  private
+
+  def logger(text, newline = true, yaml = nil)
+    if @config['output'] == :yaml
+      return if yaml.nil?
+      text = yaml
+    end
+
+    if newline
+      puts text
+    else
+      print text
+      $stdout.flush
+    end
+  end
+
+  def output_version
+    version = nil
+    File.open(File.dirname(__FILE__) + '/../VERSION') { |f| version = f.gets }
+    puts "#{NAME} v#{version}"
+  end
+
+  def output_config_template
+    File.open(File.dirname(__FILE__) + '/../config.yml.example') { |f| puts f.readlines }
+  end
+
+  def load_config
+    unless File.exists? @config_file
+      puts "ERROR: Could not find config file '#{@config_file}'... aborting"
+      exit 1
+    end
+
+    @config.deep_merge! YAML::load(File.open(@config_file))
+    unless @config['apache']['base_path'].empty? && @config['apache']['base_path'] !~ /\/$/
+      @config['apache']['base_path'] += '/'
+    end
+  end
+
+  def parse_command_line_args
+    @config = {'output' => :stdout}
+    options = OptionParser.new do |opts|
+      opts.banner = "Usage: hast config-file [options]"
+      opts.separator ''
+      opts.separator 'Specific options:'
+      opts.on('-v', '--version',
+              'Show this message')                                      { output_version; exit 0 }
+      opts.on('-h', '--help',
+              'Show version')                                           { puts opts; exit 0 }
+      opts.on('-g', '--generate-config',
+              'Output a config file template',
+              '(pipe it to a file for easy use: hast -g > config.yml)') { output_config_template; exit 0 }
+      opts.on('-q', '--no-dns',
+              'Do not lookup any domain names or MX records')           { @config['dns'] = { 'disable' => true } }
+      opts.on('-y', '--yaml',
+              'Output as YAML',
+              '(usefull if you want to pipe: bau.rb > domains.yml)')    { @config['output'] = :yaml }
+      opts.on('-c', '--domain-cache FILE',
+              'Get the domains from a YAML file')                       { |file| @config['domain_cache'] = file }
+      opts.separator ''
+      opts.separator 'See http://github.com/watson/hast for details'
+    end
+    options.parse!
+
+    unless @config_file = ARGV.delete_at(0)
+      puts "ERROR: You must supply a config file as the first argument!"
+      puts "       To generate a config file template use the -g argument"
+      puts
+      puts options
+      exit 1
+    end
+  end
+
+  def load_domains
+    logger "Finding domains..."
+
+    if @config['domain_cache']
+      domains = YAML::load(File.open(@config['domain_cache']))
+      @apache = domains['apache']
+      @postfix = domains['postfix']
+    else
+      @apache = HAST::Apache.new(@config).domains
+      @postfix = HAST::Postfix.new(@config).domains
+    end
+  end
+
+  def verify_domains
+    divider = '------------------------------------------------------------------------'
+    output_block = Proc.new do |domain, max_length, status, ips|
+      logger sprintf("%#{max_length}s : ", domain), false, "  - #{domain}\n"
+      logger case status
+      when :active
+        'Active'
+      when :inactive
+        'Inactive (no record)'
+      when :unknown
+        'Status ukendt'
+      when :other
+        "Inactive (unexpected ip#{ips.size > 1 ? '\'s' : ''}: #{ips.join(', ')})"
+      end
+    end
+
+    logger "\nWebhosting status:\n#{divider}", true, 'apache:'
+    @apache.nil?  ? logger('No domains found') : HAST::Verifier.run(@config, @apache,  :web,  &output_block)
+
+    logger "\nMailhosting status:\n#{divider}", true, 'postfix:'
+    @postfix.nil? ? logger('No domains found') : HAST::Verifier.run(@config, @postfix, :mail, &output_block)
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: hast
+version: !ruby/object:Gem::Version 
+  version: 0.2.1
+platform: ruby
+authors: 
+- Thomas Watson Steen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-17 00:00:00 +01:00
+default_executable: hast
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: net-dns
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: deep_merge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.0
+    version: 
+description: "      HAST stands for 'Hosting Account Status Tool'.\n\n      HAST is a tool for fetching domains from Apache configuration files and\n      from the Postfix database on a hosting server environment. It will then\n      run a report, checking the DNS records for each domain to see if they\n      match your server.\n\n      This is important for finding \"dead\" domains where the domain either\n      doesn't exist anymore or where the owner have moved it to another\n      hosting provider.\n\n      Before you can use HAST, you need to setup a config.yml file. Use\n      config.yml.example as a template.\n"
+email: w@tson.dk
+executables: 
+- hast
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/hast
+- config.yml.example
+- hast.gemspec
+- lib/hast.rb
+- lib/hast/apache.rb
+- lib/hast/postfix.rb
+- lib/hast/verifier.rb
+has_rdoc: true
+homepage: http://github.com/watson/hast
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Hosting Account Status Tool - Fetch domains from Apache configuration files and the Postfix database on a hosting server environment. Then run a report checking each domains DNS records to see if they match your server.
+test_files: []
+