FluxTuna 0.0.1

data/lib/whitecloth/cli/commands/help.rb

@@ -0,0 +1,106 @@
+### Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+module WhiteCloth::CLI::Commands
+
+  # @author Denis Defreyne
+  # @author David Love
+  #
+  # The +help+ command show the user a brief summary of the available
+  # sub-commands, and the short description of each of those commands.
+  #
+  # Further help is available to the user, if one of the sub-commands
+  # is named as an argument to this command. In that case, the longer
+  # help for the command is displayed.
+  #
+  # @note This class is merely a helper class: the actual text, options
+  #   and other details are drawn directly from the source code of those
+  #   commands. In the execution of this command, we rely on the +cri+
+  #   and +cli+ libraries to do the hard work of actually processing the
+  #   sub-commands.
+  class Help < Cri::Command
+
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'help'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Show help for a command'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      'Show help for the given command, or show general help. When no ' +
+      'command is given, a list of available commands is displayed, as ' +
+      'well as a list of global command-line options. When a command is ' +
+      'given, a command description as well as command-specific ' +
+      'command-line options are shown.'
+    end
+
+    # Show the user the basic syntax of this command
+    def usage
+      "whitecloth help [command]"
+    end
+
+    # Execute the command
+    def run(options, arguments)
+      # Check arguments
+      if arguments.size > 1
+        $stderr.puts "usage: #{usage}"
+        exit 1
+      end
+
+      if arguments.length == 0
+        # Build help text
+        text = ''
+
+        # Add title
+        text << "A command-line tool for managing WhiteCloth realms.\n"
+
+        # Add available commands
+        text << "\n"
+        text << "Available commands:\n"
+        text << "\n"
+        @base.commands.sort.each do |command|
+          text << sprintf("    %-20s %s\n", command.name, command.short_desc)
+        end
+
+        # Add global options
+        text << "\n"
+        text << "Global options:\n"
+        text << "\n"
+        @base.global_option_definitions.sort { |x,y| x[:long] <=> y[:long] }.each do |opt_def|
+          text << sprintf("    -%1s --%-15s %s\n", opt_def[:short], opt_def[:long], opt_def[:desc])
+        end
+
+        # Display text
+        puts text
+      elsif arguments.length == 1
+        command = @base.command_named(arguments[0])
+        puts command.help
+      end
+    end
+
+  end
+
+end

data/lib/whitecloth/cli/commands/show.rb

@@ -0,0 +1,87 @@
+# Copyright (c) 2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+#
+# @author David Love
+#
+
+module WhiteCloth::CLI::Commands
+
+  # @author David Love
+  #
+  # Displays a summary of the realm data found in the configured WhiteCloth
+  # server.
+  class Show < Cri::Command
+    
+    # The name of the sub-command (as it appears in the command line app)
+    def name
+      'show-status'
+    end
+
+    # The aliases this sub-command is known by
+    def aliases
+      []
+    end
+
+    # A short help text describing the purpose of this command
+    def short_desc
+      'Create or update information from the network'
+    end
+
+    # A longer description, detailing both the purpose and the
+    # use of this command
+    def long_desc
+      "Displays the current state of the evironemnt " +
+      "to update the host files (held in the 'hosts' directory). Existing " +
+      "information will be updated, and missing information inserted.\n"
+    end
+    
+    # Show the user the basic syntax of this command
+    def usage
+      "bootstrap show-status"
+    end
+
+    # Define the options for this command
+    def option_definitions
+      []
+    end
+
+    # Execute the command
+    def run(options, arguments)
+
+      # Load the list of groups
+      group_list = YAML::load( File.open("config/groups.yaml"))
+      
+      # Load the list of networks
+      network_list = YAML::load( File.open("config/networks.yaml"))
+
+      # Update the information in each group-network directory
+      gn_name_list = Array.new
+
+      network_list.each{|network|
+        puts network[1]
+        
+        net_block = network[1]['ip4-address-block'].to_s
+
+        # Scan this network
+        # parser = Nmap::Parser.parsescan("nmap", "-sVC " + net_block)
+
+        puts parser
+      }
+
+    end
+  
+  end
+
+end

data/lib/whitecloth/cli/commands.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+
+# @author David Love
+#
+# The +Commands+ module acts as the gathering place for all the sub-commands 
+# which the +whitecloth+ command can deal with. Each sub-command defines both 
+# the command action, options, and associated help text.
+#
+# All commands should live under +lib/whitecloth/cli/commands+, with the 
+# file-name named after the sub-command defined within it. 
+module WhiteCloth::CLI::Commands
+end
+
+require 'whitecloth/cli/commands/help'
+
+require 'whitecloth/cli/commands/bootstrap'
+require 'whitecloth/cli/commands/show'

data/lib/whitecloth/cli/logger.rb

@@ -0,0 +1,88 @@
+# Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+#
+# Permission to use, copy, modify, and/or distribute this software for 
+# any purpose with or without fee is hereby granted, provided that the 
+# above copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+
+require 'singleton'
+require 'facets'
+
+module WhiteCloth::CLI
+
+  # WhiteCloth::CLI::Logger is a singleton class responsible for generating
+  # feedback in the terminal.
+  class Logger
+
+    # ANSI console codes (escape sequences) for highlighting particular
+    # log outputs.
+    ACTION_COLORS = {
+      :error          => "\e[1m" + "\e[31m", # bold + red
+      :warning        => "\e[1m" + "\e[33m", # bold + yellow
+      :info           => "\e[1m" + "\e[32m", # bold + green
+    }
+
+    include Singleton
+
+    # The log level, which can be :high, :low or :off (which will log all
+    # messages, only high-priority messages, or no messages at all,
+    # respectively).
+    attr_accessor :level
+
+    # Whether to use color in log messages or not
+    attr_accessor :color
+    alias_method :color?, :color
+
+    def initialize
+      @level = :high
+      @color = true
+    end
+
+    # Logs a messsage, using appropriate colours to highlight different
+    # levels.
+    #
+    # +level+:: The importance of this action. Can be :high or :low.
+    #
+    # +action+:: The kind of file action. Can be :create, :update or
+    #            :identical.
+    #
+    # +message+:: The identifier of the item the action was performed on.
+    def log_level(level, action, message)
+      log(
+        level,
+        '%s%12s%s:  %s' % [
+          color? ? ACTION_COLORS[action.to_sym] : '',
+          action.capitalize,
+          color? ? "\e[0m" : '',
+          message.word_wrap(60).indent(15).lstrip
+        ]
+      )
+    end
+
+    # Logs a message.
+    #
+    # +level+:: The importance of this message. Can be :high or :low.
+    #
+    # +message+:: The message to be logged.
+    #
+    # +io+:: The IO instance to which the message will be written. Defaults to
+    #        standard output.
+    def log(level, message, io=$stdout)
+      # Don't log when logging is disabled
+      return if @level == :off
+
+      # Log when level permits it
+      io.puts(message) if (@level == :low or @level == level)
+    end
+
+  end
+
+end

data/lib/whitecloth/cli.rb

@@ -0,0 +1,29 @@
+### Copyright (c) 2009 Denis Defreyne, 2010-2011 David Love
+###
+### Permission to use, copy, modify, and/or distribute this software for 
+### any purpose with or without fee is hereby granted, provided that the 
+### above copyright notice and this permission notice appear in all copies.
+###
+### THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 
+### WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 
+### MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 
+### ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 
+### WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 
+### ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 
+### OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+###
+
+require 'rubygems'
+
+# Load command line handling library
+require 'cri'
+
+# Install module for command line
+# interface
+module WhiteCloth:CLI
+end
+
+# Load the command line handling modules
+require 'whitecloth/cli/logger'
+require 'whitecloth/cli/commands'
+require 'whitecloth/cli/base'