irgat 0.0.1 → 0.0.2

data/History.txt

@@ -1,3 +1,16 @@
+== 0.0.2 2008-11-3
+
+* Backup Module:
+ * Fixed Purge and Move old Backups method
+ * Implemented new methods
+
+* Irgat Base:
+ * Fixed bug in log Module (!@log error)
+ * Fixed commands_launched resume (!@command_log)
+
+* Intituive
+ * Added some colors in cmd
+
 == 0.0.1 2008-10-24
 
 * 1 major enhancement:

data/Manifest.txt

@@ -6,6 +6,7 @@ Rakefile
 TODO
 bin/irgat
 bin/irgat_setup
+bin/irgat_updater
 config/hoe.rb
 config/requirements.rb
 lib/irgat.rb
@@ -26,11 +27,8 @@ script/txt2html
 setup.rb
 setup/etc/backup.yml.example
 setup/etc/chroot.yml.example
-setup/etc/console.yml.default
 setup/etc/cron.yml.example
-setup/etc/dar.yml.example
 setup/etc/irgat.yml.example
-setup/etc/kwallet.yml.default
 setup/etc/kwallet.yml.example
 setup/etc/ssh.yml.example
 tasks/deployment.rake

data/PostInstall.txt

@@ -1,4 +1,13 @@
+New Install:
+------------
+
 Run irgat_setup to setup Irgat
 
-For more information on Irgat, see http://irgat.rubyforge.org
+For more information on Irgat read the rdoc documentation or see http://irgat.rubyforge.org
+
+Updater: (0.0.1 => 0.0.2)
+-------------------------
+
+If you have already installed run irgat_updater. These script checks your config files and show posible difference between older and new config files.
 
+The program only marks these changes. You have to do it manually.

data/README.rdoc

@@ -4,23 +4,24 @@ Interactive Ruby for Gnoxys Administration Tools
 
 == DESCRIPTION:
 
-FIX (describe your package)
+IRGAT (Intuitive Ruby for Gnoxys Administration Tools) are some tools in Ruby for system administration (backups, ssh key management, etc...)
+
 
 == FEATURES/PROBLEMS:
 
-* FIX (list of features or problems)
+None
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+None
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+None
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+None
 
 == LICENSE:
 

data/Rakefile

@@ -1,4 +1,4 @@
 require 'config/requirements'
 require 'config/hoe' # setup Hoe + all gem configuration
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/TODO

@@ -11,6 +11,8 @@
 
 === Backup
 
+  ** URGENCY: HIGHT
+
   - Add a prevent control to predict how much space is going to need the backup and check if exist enought. If not, exit of application. Something like
   {
   get_older_size_backup=X
@@ -19,8 +21,26 @@
   end
   }
 
-  - Add a option to distribute backups with ftp
+  ** URGENCY: LOW
+
+  - Add an option to distribute backups with ftp
+  - Add an option to do other sql backups
+
+ = Error Exits
+
+  2 # Load error in Module
+  3 # Process error in Module
+  6 # Exit by fatal command
+  7 # Not enough parameters
+
+
+ = Loggin
 
-  - Check mount folder
+  # option by cmd line: -w                || --without_output
+                        -d <debug level>  || --debug_level <debug_level>
 
-  - Include by default to exclude backup folder from backup
+ = Colors
+  green = 2
+  red = 9
+  dark red = 160
+  orange = 220

data/bin/irgat

@@ -1,14 +1,5 @@
 #!/usr/bin/env ruby
 
-#= Usage
-#
-#  irgat -v || --version           # display version information and exit
-#  irgat -h || --help              # display help and exit
-#  irgat < arg >                   # process an irgat petition
-#  ---------------------
-#  irgat works like a modular tool. For example, the syntaxis for a backup is:
-#  $: irgat backup launch
-#
 #= Help 
 #
 # Irgat is an utility to manage administration script and all the tools needed for it.
@@ -28,18 +19,10 @@
 #
 #  For more info, view the API of irgat and read the documentation
 #
-#= License
-#
-#  IRGAT (Intuitive Ruby for Gnoxys Administration Tools)
-#  2007 - 2008 Gnoxys. info@gnoxys.net
-#  This program is released under the terms of the GPL v3 license as you cand find in http://www.gnu.org/licenses/gpl.html
-#
-#
 
 
 # IRGAT constants
 IRGAT_ROOT = File.dirname(__FILE__) + '/..'
-puts IRGAT_ROOT
 # Default paths, if you want to change, change hear
 IRGAT_CONFIG = '/etc/irgat'   unless defined?(IRGAT_CONFIG)
 IRGAT_LANG   = IRGAT_ROOT + '/lang'     unless defined?(IRGAT_LANG)
@@ -66,22 +49,25 @@ rescue LoadError => msj
 end
 
 # check launch
-case $*[0]
-when nil
-  # no command line params. Show usage and exit
-  puts "\n * ERROR: missing options"
-  RDoc::usage(1,'usage')
-when '--version','-v'
-  # display version. license and exit
-  puts "\nVERSION: " + Irgat::VERSION
-  RDoc::usage('license')
-when '--help','-h'
-  # help, and exit
-  RDoc::usage('help')
-else
-  args = $*
-  # process irgat request
-  Irgat.process(args)
+args = $*
+
+case args[0]
+  when nil
+    # no command line params. Show usage and exit
+    puts "\n * ERROR: missing options"
+    Irgat.help(["help","usage"])
+    exit 1
+  when '--version','-v','version'
+    # display version. license and exit
+    puts "\nVERSION\n=======\n  #{ ::Irgat::Version }"
+    Irgat.help(["help","license"])
+    exit 0
+  when '--help','-h','help'
+    # help, and exit
+    Irgat.help(args)
+  else
+    # process irgat request
+    Irgat.process(args)
 end
 
 

data/bin/irgat_setup

@@ -13,19 +13,28 @@ Read more info in <irgat_path>/README
 =end
 
 def stop_install(msj)
-  puts 'Irgat installation was stopped with this message:'
+  puts "#{ colorize("Irgat updater was stopped with this message:","red") }"
   puts '"'+msj+'"'
   puts ''
   puts 'Bye!'
   exit 1
 end
 
+def colorize(msj, color)
+  case color
+    when "red"
+      color_num = 1
+    when "green"
+      color_num = 2
+  end
+  "\x1b[#{ 38 };5;#{ color_num }m#{ msj }\x1b[0m"
+end
 
 
 puts ''
 puts 'Welcome to IRGAT setup'
 puts '------------------------'
-puts ''
+
 
 if Process.euid != 0
   stop_install('You must run this program as root.')
@@ -77,7 +86,7 @@ end
 puts 'Copy Irgat config sample files to destination'
 puts ''
 
-%x[ cp -rf #{ File.dirname(__FILE__) }/../setup/etc/* #{irgat_config_folder} ]
+%x[ cp -rf #{ File.dirname(__FILE__) }/../setup/etc/*.yml.example #{irgat_config_folder} ]
 
 if $? != 0
   stop_install("Exec: cp -r #{ File.dirname(__FILE__) }/../setup/etc/* #{irgat_config_folder} return error")

data/bin/irgat_updater

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby
+
+=begin
+
+Irgat updater program
+---------------------
+
+Author:  Gnoxys. info@gnoxys.net 
+License: GPL v3.
+
+Read more info in <irgat_path>/README
+
+=end
+
+require 'yaml'
+
+def stop_update(msj)
+  puts "#{ colorize("Irgat updater was stopped with this message:","red") }"
+  puts '"'+msj+'"'
+  puts ''
+  puts 'Bye!'
+  exit 1
+end
+
+def colorize(msj, color)
+  case color
+    when "red"
+      color_num = 1
+    when "green"
+      color_num = 2
+    when "orange"
+      color_num = 220
+  end
+  "\x1b[#{ 38 };5;#{ color_num }m#{ msj }\x1b[0m"
+end
+  
+
+
+puts ''
+puts 'Welcome to IRGAT updater'
+puts '------------------------'
+
+if Process.euid != 0
+  stop_update('You must run this program as root.')
+end
+
+puts ''
+puts 'Irgat Updater checks yours config files and compare it with the newer examples in the new install release.
+Changes are show in screen, but you must edit it manually.'
+puts 'You can repeat these command whatever times you need'
+puts ''
+puts '* Start with the update'
+puts "  Do it? [Y/n]"
+
+answer = $stdin.gets
+
+stop_update('Halted by user') if answer.strip == 'n'
+
+Dir.chdir("/etc/irgat")
+# Takes all the entries but not examples
+(Dir["*"] - Dir["*example*"]).each { |config_file|
+  puts "\n* Check #{ config_file }? [Y/n]"
+  answer = $stdin.gets
+
+  if answer.strip != 'n'
+    # load yml
+    system_yml = YAML.load_file(config_file)
+    # load release yml
+    release_yml = YAML.load_file("#{ File.dirname(__FILE__) }/../setup/etc/#{ config_file.split('.').first }.yml.example")
+    release_yml.each_pair { |release_option, release_value|
+      # Exist in config file
+      if !system_yml.has_key?(release_option)
+        puts "[  #{ colorize("ERROR","red") }  ] Not found        => #{ release_option }"
+      else
+        # check value
+        if release_value != system_yml[release_option]
+          puts "[ #{ colorize("WARNING","orange") } ] Different Value  => #{ release_option }"
+        else
+          puts "[   #{ colorize("OK","green") }    ] Same Value       => #{ release_option }  "
+        end
+      end
+    }
+  end
+
+
+}

data/config/hoe.rb

@@ -1,5 +1,6 @@
 require 'irgat/version'
 
+
 AUTHOR = 'Gnoxys'  # can also be an array of Authors
 EMAIL = "info@gnoxys.net"
 DESCRIPTION = "Intuitive Ruby for Gnoxys Administration Tools"
@@ -9,7 +10,6 @@ HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
 DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
 EXTRA_DEPENDENCIES = [
   ['net-ssh', '>= 2.0.4'],
-  ['rdoc', '>= 2.2.1'],
   ['termios', '>= 0.9.4'],
   ['tmail', '>= 1.2.3.1']
 ]    # An array of rubygem dependencies [name, version]
@@ -40,7 +40,7 @@ end
 REV = nil
 # UNCOMMENT IF REQUIRED:
 # REV = YAML.load(`svn info`)['Revision']
-VERS = Irgat::VERSION::STRING + (REV ? ".#{REV}" : "")
+VERS = "#{::Irgat::Version}" + (REV ? ".#{REV}" : "")
 RDOC_OPTS = ['--quiet', '--title', 'irgat documentation',
     "--opname", "index.html",
     "--line-numbers",

data/lib/irgat.rb

@@ -1,12 +1,33 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
-#= License
-#
-#  IRGAT (Intuitive Ruby for Gnoxys Administration Tools)
-#  2007 - 2008 Gnoxys. info@gnoxys.net
-#  This program is released under the terms of the GPL v3 license
-#  as you cand find in http://www.gnu.org/licenses/gpl.html
+# IRGAT constants
+IRGAT_ROOT = File.dirname(__FILE__) + '/..' unless defined?(IRGAT_ROOT)
+# Default paths, if you want to change, change hear
+IRGAT_CONFIG = '/etc/irgat'   unless defined?(IRGAT_CONFIG)
+IRGAT_LANG   = IRGAT_ROOT + '/lang'     unless defined?(IRGAT_LANG)
+IRGAT_LIB    = IRGAT_ROOT + '/lib'      unless defined?(IRGAT_LIB)
+
+begin
+  # requiere other modules, if not loaded yet
+  require 'yaml'
+  require 'erb'
+  # RDoc, built inside help
+  require 'rdoc/usage'
+  require 'rdoc/code_objects'
+  require 'rdoc/markup/simple_markup'
+  require 'rdoc/markup/simple_markup/to_flow'
+  require 'rdoc/ri/ri_formatter'
+  require 'rdoc/ri/ri_options'
+  require 'net/smtp'
+  require 'tmail'
+  # irgat Base
+  require 'irgat'
+rescue LoadError => msj
+  puts "Irgat needed the follow gem:"+(msj.to_s.split('--'))[1]+", but not found."
+  puts "[ ERROR ] in file "+msj.backtrace.to_s
+end
+
 
 # start with Irgat module. Build namespace IRGAT
 module Irgat
@@ -17,11 +38,16 @@ module Irgat
       irgat = Irgat.new
       irgat.process(args)
     end
+
+    def help(args = {})
+      irgat = Irgat.new
+      irgat.help(args)
+    end
   end
 
   class Irgat
     #accesor to configs
-    attr_reader :config
+    attr :config
     attr_reader :config_module
     #accesor to init time
     attr_reader :init_time
@@ -29,56 +55,92 @@ module Irgat
     attr :programs
     #accesor to folders
     attr :folders
+    #accesor log
+    attr :log_process
+    #accesor to command launched
+    attr :commands_launched
+    #accesor to action
+    attr :action
+
+
+    # Class top variable debug level :: can override config debug level
+    @@debug_level = nil
+
+    # version, FIXME ?
+    require 'irgat/version'
 
     # add utils
     require 'irgat/utils'
+    include ::Irgat::Help
     include ::Irgat::Log
     include ::Irgat::Mail
     include ::Irgat::Execs
     include ::Irgat::Dependencies
 
     # simple initialize of a Irgat object... loading general config
-    def initialize(options = {})
+    def initialize(values = {})
       @init_time = Time.now
       @config    = self.load_config
+      # modify debug by cmd line class
+      if @@debug_level.to_i >= 1 
+        @config[:debug_level] = @@debug_level.to_i
+      end
+    end
+
+    def help(args)
+      @log_to_stdout = true
+      # help
+      args.shift
+      pattern = args.to_s
+      show_help(pattern, exit_irgat = true)
     end
 
     def process(args = [])
       irgat_module = args.shift
       # get subsytem if active FIXME
       if !self.config[:enable_subsystem].include?(irgat_module)
-        exit_with_error('Module not enable in irgat config')
+        exit_with_error('Module not enable in irgat config',
+                        { :exit_level => 2 })
       end
 
       # action ? 
       ( args.first ? action = args.shift : action = "default" )
 
-      # no action : is parameter
-      if action.include?("-")
-        args.push(action)
-        action = "default"
-      end
-
-      # debug to stdout?
-      if args.include?("-d")
-        @log_to_stdout = true
+      # irgat options
+      module_args = Array.new
+      while arg = args.shift 
+        case arg
+          when "-w","--without_output"
+            # modify stdout
+            $stdout = File.new("/dev/null","w")
+          when "-d","--debug_level"
+            # take new debug level
+            @@debug_level = args.shift 
+          else
+            module_args << arg
+        end
       end
 
       # init the module
       begin
         require 'modules/' + irgat_module
-        irgat_process =  Object.module_eval("#{ irgat_module.capitalize }").new
+        irgat_process =  Object.module_eval("#{ irgat_module.capitalize }").new({:action => action })
       rescue LoadError => msj
-        exit_with_error("Unable to start the #{ irgat_module } module. Error was: #{ msj.backtrace.to_s } ")
+        exit_with_error("Unable to start the #{ irgat_module } module. Error was: #{ msj.backtrace.to_s } ", { :exit_level => 2 })
       end
 
       # scape possible private methods throught a bug in send method
       # http://joshstaiger.org/archives/2006/12/the_ruby_send_h.html
       if irgat_process.public_methods.include?(action)
-        irgat_process.send(action, args)
+        module_return = irgat_process.send(action, module_args)
       else
-        exit_with_error("Unable to exec action. Not avaible public method '#{ action }' in '#{ irgat_module }' Module. }", { :no_finish_process => true })
+        exit_with_error("Unable to exec action. Not avaible public method '#{ action }' in '#{ irgat_module }' Module.", { :exit_level => 2 })
       end
+
+      # report
+      output_log(irgat_process,
+                 { :main_msj => (module_return || "[IRGAT] [#{ irgat_module.upcase }] [OK] #{ action } process in #{ @config[:server_name] }")})
+      exit 0
     end
 
     # method to load the config options for a module and return a hash symbol
@@ -89,6 +151,7 @@ module Irgat
       config_yml.each{|k, v| config_to_symbols[k.to_sym] = v}
       config_to_symbols
     end
+
   end
 end