devdnsd 2.4.0 → 3.0.0

data/doc/top-level-namespace.html

@@ -6,7 +6,7 @@
 <title>
   Top Level Namespace
   
-    &mdash; Documentation by YARD 0.8.6.2
+    &mdash; Documentation by YARD 0.8.7
   
 </title>
 
@@ -103,9 +103,9 @@
 </div>
 
     <div id="footer">
-  Generated on Sat Jul 20 13:46:44 2013 by
+  Generated on Sun Aug 18 16:18:38 2013 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.8.6.2 (ruby-1.9.3).
+  0.8.7 (ruby-2.0.0).
 </div>
 
   </body>

data/lib/devdnsd.rb

@@ -1,13 +1,16 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
 require "rubygems"
-require "mamertes"
+require "bovem"
 require "rubydns"
 require "rexec/daemon"
+require "mustache"
+require "ipaddr"
+require "fiber"
 
 Lazier.load!(:object)
 
@@ -17,5 +20,5 @@ require "devdnsd/errors"
 require "devdnsd/rule"
 require "devdnsd/version" if !defined?(DevDNSd::Version)
 
-# DevDNSd is only supported on MRI
+# DevDNSd is not supported on JRuby
 DevDNSd::Application.check_ruby_implementation

data/lib/devdnsd/application.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
@@ -87,6 +87,8 @@ module DevDNSd
         if !Process.respond_to?(:fork) then
           logger.warn(i18n.no_fork)
           @config.foreground = true
+        elsif @command.options[:foreground].value then
+          @config.foreground = true
         end
 
         @config.foreground ? perform_server : RExec::Daemon::Controller.start(self.class)
@@ -101,6 +103,23 @@ module DevDNSd
         true
       end
 
+      # Adds aliases to an interface.
+      #
+      # @param options [Hash] The options provided by the user.
+      # @return [Boolean] `true` if action succeeded, `false` otherwise.
+      def action_add(options)
+        manage_aliases(:add, i18n.add_empty, options)
+      end
+
+      # Removes aliases from an interface.
+      #
+      # @param options [Hash] The options provided by the user.
+      # @return [Boolean] `true` if action succeeded, `false` otherwise.
+      def action_remove(options)
+        manage_aliases(:remove, i18n.remove_empty, options)
+      end
+
+
       # Installs the application into the autolaunch.
       #
       # @return [Boolean] `true` if action succeeded, `false` otherwise.
@@ -267,6 +286,183 @@ module DevDNSd
         end
     end
 
+    # Methods to handle interfaces aliases.
+    module Aliases
+      extend ActiveSupport::Concern
+
+      # Manages aliases.
+      #
+      # @param operation [Symbol] The type of operation. Can be `:add` or `:remove`.
+      # @param message [String] The message to show if no addresses are found.
+      # @param options [Hash] The options provided by the user.
+      # @return [Boolean] `true` if operation succeeded, `false` otherwise.
+      def manage_aliases(operation, message, options)
+        config = self.config
+        options.each { |k, v| config.send("#{k}=", v) if config.respond_to?("#{k}=") }
+
+        addresses = compute_addresses
+
+        if addresses.present? then
+          # Now, for every address, call the command
+          addresses.all? {|address| manage_address(operation, address, options[:dry_run]) }
+        else
+          @logger.error(message)
+          false
+        end
+      end
+
+      # Adds or removes an alias from the interface.
+      #
+      # @param type [Symbol] The operation to execute. Can be `:add` or `:remove`.
+      # @param address [String] The address to manage.
+      # @param dry_run [Boolean] If only show which modifications will be done.
+      # @return [Boolean] `true` if operation succeeded, `false` otherwise.
+      def manage_address(type, address, dry_run = false)
+        locale = i18n
+        rv, command, prefix = setup_management(type, address)
+
+        # Now execute
+        if rv then
+          if !dry_run then
+            execute_manage(command, prefix, type, address, self.config)
+          else
+            log_management(:dry_run, prefix, type, locale.remove, locale.add, address, config)
+          end
+        end
+
+        rv
+      end
+
+      # Computes the list of address to manage.
+      #
+      # @param type [Symbol] The type of addresses to consider. Valid values are `:ipv4`, `:ipv6`, otherwise all addresses are considered.
+      # @return [Array] The list of addresses to add or remove from the interface.
+      def compute_addresses(type = :all)
+        config = self.config
+        config.addresses.present? ? filter_addresses(config, type) : generate_addresses(config, type)
+      end
+
+      # Checks if an address is a valid IPv4 address.
+      #
+      # @param address [String] The address to check.
+      # @return [Boolean] `true` if the address is a valid IPv4 address, `false` otherwise.
+      def is_ipv4?(address)
+        address = address.ensure_string
+
+        mo = /\A(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})\Z/.match(address)
+        (mo && mo.captures.all? {|i| i.to_i < 256}) ? true : false
+      end
+
+      # Checks if an address is a valid IPv6 address.
+      #
+      # @param address [String] The address to check.
+      # @return [Boolean] `true` if the address is a valid IPv6 address, `false` otherwise.
+      def is_ipv6?(address)
+        address = address.ensure_string
+
+        catch(:valid) do
+          # IPv6 (normal)
+          throw(:valid, true) if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*\Z/ =~ address
+          throw(:valid, true) if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ address
+          throw(:valid, true) if /\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*)?\Z/ =~ address
+          # IPv6 (IPv4 compat)
+          throw(:valid, true) if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:/ =~ address && is_ipv4?($')
+          throw(:valid, true) if /\A[\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ address && is_ipv4?($')
+          throw(:valid, true) if /\A::([\dA-Fa-f]{1,4}(:[\dA-Fa-f]{1,4})*:)?/ =~ address && is_ipv4?($')
+
+          false
+        end
+      end
+
+      private
+        # Setups management.
+        #
+        # @param type [Symbol] The type of operation. Can be `:add` or `:remove`.
+        # @param address [String] The address to manage.
+        # @return [Array] A list of parameters for the management.
+        def setup_management(type, address)
+          begin
+            @addresses ||= compute_addresses
+            length = @addresses.length
+            length_s = length.to_s.length
+            [true, build_command(type, address), "{mark=blue}[{mark=bright white}#{((@addresses.index(address) || 0) + 1).indexize(length_s)}{mark=reset blue}/{/mark}#{length}{/mark}]{/mark}"]
+          rescue ArgumentError
+            [false]
+          end
+        end
+
+        # Filters a list of addresses to return just certain type(s).
+        #
+        # @param config [Configuration] The current configuration.
+        # @param type [Symbol] The type of addresses to return.
+        # @return [Array] A list of IPs.
+        def filter_addresses(config, type)
+          filters =  [:ipv4, :ipv6].select {|i| type == i || type == :all }.compact
+          config.addresses.select { |address| filters.any? {|filter| send("is_#{filter}?", address) } }.compact.uniq
+        end
+
+        # Generates a list of addresses which are immediate successors of a start address.
+        #
+        # @param config [Configuration] The current configuration.
+        # @param type [Symbol] The type of addresses to return.
+        # @return [Array] A list of IPs.
+        def generate_addresses(config, type)
+          begin
+            ip = IPAddr.new(config.start_address.ensure_string)
+            raise ArgumentError if type != :all && !ip.send("#{type}?")
+
+            [config.aliases, 1].max.times.collect {|_|
+              current = ip
+              ip = ip.succ
+              current
+            }
+          rescue ArgumentError
+            []
+          end
+        end
+
+        # Builds the command to execute.
+        #
+        # @param type [Symbol] The type of operation. Can be `:add` or `:remove`.
+        # @param address [String] The address to manage.
+        # @return [String] The command to execute.
+        def build_command(type, address)
+          Mustache.render(config.send((type == :remove) ? :remove_command : :add_command), {interface: config.interface, address: address.to_s}) + " > /dev/null 2>&1"
+        end
+
+        # Executes management.
+        #
+        # @param command [String] The command to execute.
+        # @param prefix [String] The prefix to apply to the message.
+        # @param type [Symbol] The type of operation. Can be `:add` or `:remove`.
+        # @param address [String] The address that will be managed.
+        # @param config [Configuration] The current configuration.
+        # @return [Boolean] `true` if operation succeeded, `false` otherwise.
+        def execute_manage(command, prefix, type, address, config)
+          locale = i18n
+          log_management(:run, prefix, type, locale.removing, locale.adding, address, config)
+          rv = execute_command(command)
+          labels = (type == :remove ? [locale.remove, locale.from] : [locale.add, locale.to])
+          @logger.error(@command.application.console.replace_markers(locale.general_error(labels[0], address, labels[1], config.interface))) if !rv
+          rv
+        end
+
+        # Logs an operation.
+        #
+        # @param message [Symbol] The message to print.
+        # @param prefix [String] The prefix to apply to the message.
+        # @param type [Symbol] The type of operation. Can be `:add` or `:remove`.
+        # @param remove_label [String] The label to use for removing.
+        # @param add_label [String] The label to use for adding.
+        # @param address [String] The address that will be managed.
+        # @param config [Configuration] The current configuration.
+        def log_management(message, prefix, type, remove_label, add_label, address, config)
+          locale = i18n
+          labels = (type == :remove ? [remove_label, locale.from] : [add_label, locale.to])
+          @logger.info(@command.application.console.replace_markers(i18n.send(message, prefix, labels[0], address, labels[1], config.interface)))
+        end
+    end
+
     # Methods to process requests.
     module Server
       # Starts the DNS server.
@@ -337,7 +533,7 @@ module DevDNSd
         def perform_process_rule(rule, type, match_data, transaction)
           type = DevDNSd::Rule.resource_class_to_symbol(type)
           reply = !rule.block.nil? ? rule.block.call(match_data, type, transaction) : rule.reply
-          reply = match_data[0].gsub(rule.match, reply.gsub("$", "\\")) if rule.match.is_a?(::Regexp) && reply && match_data[0]
+          reply = match_data[0].gsub(rule.match, reply.gsub("$", "\\")) if rule.match.is_a?(::Regexp) && reply && match_data && match_data[0]
 
           logger.debug(i18n.match(rule.match, type))
           [reply, type]
@@ -350,11 +546,21 @@ module DevDNSd
         # @param type [Symbol] The type of query.
         def finalize_reply(reply, rule, type)
           rv = []
-          rv << rule.options.delete(:preference).to_integer(10) if type == :MX
+          rv << rule.options.delete(:priority).to_integer(10) if type == :MX
           rv << ([:A, :AAAA].include?(type) ? reply : Resolv::DNS::Name.create(reply))
-          rv << rule.options.merge({resource_class: DevDNSd::Rule.symbol_to_resource_class(type, @locale)})
+          rv << rule.options.merge({resource_class: DevDNSd::Rule.symbol_to_resource_class(type, @locale), ttl: validate_ttl(rule.options.delete(:ttl))})
           rv
         end
+
+        # Validates a TTL.
+        #
+        # @param current [Fixnum] The current value.
+        # @param default [Fixnum] The value to return if current is not valid.
+        # @return [Fixnum] The validated TTL.
+        def validate_ttl(current, default = 300)
+          current = current.to_integer
+          current > 0 ? current : default
+        end
     end
   end
 
@@ -363,7 +569,7 @@ module DevDNSd
   # @attribute [r] config
   #   @return [Configuration] The {Configuration Configuration} of this application.
   # @attribute [r] command
-  #   @return [Mamertes::Command] The Mamertes command.
+  #   @return [Bovem::Command] The Bovem command.
   # @attribute logger
   #   @return [Bovem::Logger] The logger for this application.
   # @attribute [r] locale
@@ -377,6 +583,7 @@ module DevDNSd
 
     include Lazier::I18n
     include DevDNSd::ApplicationMethods::System
+    include DevDNSd::ApplicationMethods::Aliases
     include DevDNSd::ApplicationMethods::Server
 
     attr_reader :config
@@ -386,7 +593,7 @@ module DevDNSd
 
     # Creates a new application.
     #
-    # @param command [Mamertes::Command] The current Mamertes command.
+    # @param command [Bovem::Command] The current Bovem command.
     # @param locale [Symbol] The locale to use for the application.
     def initialize(command, locale)
       i18n_setup(:devdnsd, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/"))
@@ -397,7 +604,6 @@ module DevDNSd
       options = @command.application.get_options.reject {|_, v| v.nil? }
 
       # Setup logger
-      Bovem::Logger.start_time = Time.now
       @logger = Bovem::Logger.create(Bovem::Logger.get_real_file(options["log_file"]) || Bovem::Logger.default_file, Logger::INFO)
 
       # Open configuration
@@ -427,7 +633,7 @@ module DevDNSd
 
     # Returns a unique (singleton) instance of the application.
     #
-    # @param command [Mamertes::Command] The current Mamertes command.
+    # @param command [Bovem::Command] The current Bovem command.
     # @param locale [Symbol] The locale to use for the application.
     # @param force [Boolean] If to force recreation of the instance.
     # @return [Application] The unique (singleton) instance of the application.
@@ -446,13 +652,16 @@ module DevDNSd
 
     # Stops the application.
     def self.quit
-      ::EventMachine.stop rescue nil
+      begin
+        EM.add_timer(0.1) { ::EM.stop }
+      rescue
+      end
     end
 
     # Check if the current implementation supports DevDNSd.
     def self.check_ruby_implementation
-      if defined?(Rubinius) || defined?(JRuby) then
-        Kernel.puts(Lazier::Localizer.new(:devdnsd, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")).i18n.no_jruby_rubinius)
+      if defined?(JRuby) then
+        Kernel.puts(Lazier::Localizer.new(:devdnsd, ::File.absolute_path(::Pathname.new(::File.dirname(__FILE__)).to_s + "/../../locales/")).i18n.no_jruby)
         Kernel.exit(0)
       end
     end

data/lib/devdnsd/configuration.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
@@ -31,6 +31,24 @@ module DevDNSd
     # The rules of the server. By default, every hostname is resolved with `127.0.0.1`.
     property :rules, default: []
 
+    # The default interface to manage for aliases. Default: `lo0`.
+    property :interface, default: "lo0"
+
+    # The default list of aliases to add. Default: `[]`.
+    property :addresses, default: []
+
+    # The starting address for sequential aliases. Default: `10.0.0.1`.
+    property :start_address, default: "10.0.0.1"
+
+    # The number of aliases to add. Default: `5`.
+    property :aliases, default: 5
+
+    # The command to run for adding an alias. Default: `sudo ifconfig {{interface}} alias {{address}}`.
+    property :add_command, default: "sudo ifconfig {{interface}} alias {{address}}"
+
+    # The command to run for removing an alias. Default: `sudo ifconfig {{interface}} alias {{address}}`.
+    property :remove_command, default: "sudo ifconfig {{interface}} -alias {{address}}"
+
     # Creates a new configuration.
     # A configuration file is a plain Ruby file with a top-level {Configuration config} object.
     #

data/lib/devdnsd/errors.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 

data/lib/devdnsd/rule.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
@@ -14,7 +14,7 @@ module DevDNSd
   # @attribute reply
   #   @return [String] The IP or hostname to reply back to the client. Default: `127.0.0.1`. @see .create
   # @attribute options
-  #   @return [Hash] A list of options for the request. Default is an empty hash.
+  #   @return [Hash] A list of options for the request. Default is an empty hash. Supported key are `:priority` and `:ttl`, both integers
   # @attribute block
   #   @return [Proc] An optional block to compute the reply instead of using the `reply` parameter. @see .create
   class Rule

data/lib/devdnsd/version.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
@@ -10,10 +10,10 @@ module DevDNSd
   # @see http://semver.org
   module Version
     # The major version.
-    MAJOR = 2
+    MAJOR = 3
 
     # The minor version.
-    MINOR = 4
+    MINOR = 0
 
     # The patch version.
     PATCH = 0

data/locales/en.yml

@@ -1,6 +1,6 @@
 # encoding: utf-8
 #
-# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@me.com>.
+# This file is part of the devdnsd gem. Copyright (C) 2013 and above Shogun <shogun_panda@cowtech.it>.
 # Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
 #
 
@@ -10,7 +10,7 @@
     rule_invalid_options: "You can only use hashs for options."
     rule_invalid_resource: "Invalid resource class %1."
     dns_update: "Flushing DNS cache and resolvers ..."
-    no_jruby_rubinius: "DevDNSd is not available on JRuby or Rubinius."
+    no_jruby: "DevDNSd is not available on JRuby."
     no_fork: "Forking is not available for this platform. Running in foreground ..."
     starting: "Starting DevDNSd ..."
     match: "Found match on %1 with type %2."
@@ -38,11 +38,37 @@
     application_help_log_file: "The log file to use. Not used if run in foreground. Default is \"/var/log/devdnsd.log\"."
     application_help_log_level: "The log level to use. Valid values are from 0 to 5 where 0 means \"all messages\". Default is 1."
     application_help_foreground: "Do not daemonize."
+    application_help_interface: "The interface to manage. Default is \"lo0\"."
+    application_help_addresses: "The list of aliases to add. Overrides sequential list."
+    application_help_start_address: "The starting address for sequential aliases. Default is \"10.0.0.1\"."
+    application_help_aliases: "The number of aliases to add. Default is 5."
+    application_help_add_command: "The command to run for adding an alias. Default is \"sudo ifconfig {{interface}} alias {{address}}\"."
+    application_help_remove_command: "The command to run for removing an alias. Default is \"sudo ifconfig {{interface}} -alias {{address}}\"."
+    application_help_dry_run: "Only show which modifications will be done."
     application_meta_file: "FILE"
     application_meta_domain: "DOMAIN"
     application_meta_level: "LEVEL"
     application_meta_port: "PORT"
+    application_meta_interface: "INTERFACE"
+    application_meta_address: "ADDRESS"
+    application_meta_addresses: "ADDRESSES"
+    application_meta_aliases: "ALIASES"
+    application_meta_command: "COMMAND"
     command_start: "Starts the server."
     command_install: "Installs the server."
     command_uninstall: "Uninstalls the server."
     command_stop: "Stops the server."
+    command_aliases: "Adds or removes aliases to network interfaces."
+    command_add: "Adds aliases."
+    command_remove: "Removes aliases."
+    removing: "Removing"
+    adding: "Adding"
+    remove: "remove"
+    add: "add"
+    to: "to "
+    from: "from "
+    general_error: "Cannot {mark=bright}%1{/mark} address {mark=bright}%2{/mark} %3interface {mark=bright}%4{/mark}."
+    add_empty: "No valid addresses to add to the interface found."
+    remove_empty: "No valid addresses to remove from the interface found."
+    run: "%1 {mark=bright}%2{/mark} address {mark=bright}%3{/mark} %4interface {mark=bright}%5{/mark}..."
+    dry_run: "%1 I will {mark=bright}%2{/mark} address {mark=bright}%3{/mark} %4interface {mark=bright}%5{/mark}..."