gat 0.2.8

data/lib/gatgets/dar_backup/launcher.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'gatgets/dar_backup/dar_backup'
+
+class YourLauncherBackupScript < GatgetDarBackup #:nodoc:
+end
+
+# default options... see all options at Gatget config file GAT_ROOT + /lib/gatgets/dar_backup/dar_backup.yml
+
+options = {
+  # include gat common config
+  'gat_config'    => '/etc/gat/gat.yml',
+  # gatget config
+  'gatget_config' => {
+    # backup folder
+    'folders' => {
+      'backups_folder'  => {
+        'path' => '/tmp/backup'
+      }
+    },
+    # static values
+    'static' => {
+      # week days in which complete backup is performed
+      'complet_backup_days' => [ 0 ],
+      # number of complet backups are going to be stored at the machine
+      'number_backup_stored' => 0,
+      # disk space limit to perform backup, in megas
+      'space_thresold' => '3000M',
+      # folders to exclude from backup
+      'exclude_folders' => [ 'boot', 'dev', 'lib64', 'media', 'opt', 'root', 'selinux',
+                             'sys', 'usr', 'cdrom', 'lib', 'lost+found', 'mnt', 'proc', 'bin',
+                             'srv', 'tmp', 'home',
+                             'var', 'etc' ],
+      # should gatget does a mysqldumps
+      'mysql_dumps'     => false,
+      'mysql_user'      => '',
+      'mysql_password'  => ''
+    }
+  }
+}
+
+# Launch Gatget
+YourLauncherBackupScript.launch(options, ARGV)

data/lib/gatgets/dar_backup/templates/list_backups.erb

@@ -0,0 +1,31 @@
+% system_backups  = operation.gatget.get_dependence_value("variable", "system_backups")  || []
+% catalog_backups = operation.gatget.get_dependence_value("variable", "catalog_backups") || []
+% system_backups  = system_backups.select{ |backup| !backup['isolate']}
+% if system_backups.empty? and catalog_backups.empty?
+
+  ERROR: No Backups stored at System
+
+% else
+
+  Listintg Backups in File System and at Catalog:
+  
+  - Backup Folder : <%= operation.gatget.get_dependence_value("folders", "backups_folder_data_local") %>
+  - Catalog       : <%= operation.gatget.get_flag("catalog_exists") ? operation.gatget.get_dependence_value("variable", "catalog_path") : "Catalog doesnt exists!" %>
+  
+  /<%= '-' * 148 %>\
+  | <%= 'File Name'.ljust(50) %> | <%= 'File Folder'.ljust(15) %> | <%= 'Size'.ljust(10) %> | <%= 'In Catalog'.ljust(10) %> | <%= 'Dar ID'.ljust(6) %> | <%= 'Dar Name'.ljust(40) %> |
+  |<%= '-' * 148 %>|
+%   system_backups.each do |system_backup|
+%     is_in_catalog = catalog_backups.select{ |backup| backup['dar_name'] == system_backup['dar_name'] }
+%     if is_in_catalog.empty?
+%       in_catalog = 'No'
+%       id_catalog = '-'
+%     else
+%       in_catalog = 'Yes'
+%       id_catalog = is_in_catalog.first['id'] || 'x'
+%     end
+  | <%= system_backup['name'].ljust(50) %> | <%= system_backup['folder'].ljust(15) %> | <%= File.nice_size(system_backup['path']).ljust(10) %> | <%= in_catalog.ljust(10) %> | <%= id_catalog.ljust(6) %> | <%= system_backup['dar_name'].ljust(40) %> |
+%   end
+  \<%= '-' * 148 %>/
+  
+%end

data/lib/gatgets/dar_backup/templates/search.erb

@@ -0,0 +1,33 @@
+%# get the action object of search
+% action_object = operation.get_action('search_simple')
+% unless action_object.exit_level == 0
+      
+  FAILED!!
+  Pattern didnt match any file or folder at Backups. Try to simplify the search.
+  For example, search 'bin' instead of 'bin/ls'
+  
+% else
+%   # we found results!
+
+  Search Results
+  --------------
+  
+  File or Folder pattern was found at the following backups files
+  
+  /<%= '-' * 94 %>\
+  | <%= 'Dar Name'.ljust(40) %> | <%= 'Dar ID'.ljust(6) %> | <%= 'Last modification Date'.ljust(40) %> |
+  |<%= '-' * 94  %>|
+%   action_object.output.each_line do |match_line|
+%     # line that include numbers are the result lines
+%     if match_line[/[0-9]/]
+%       backup_data = match_line.strip.split(' ')
+%       backup_id   = backup_data.shift
+%       backup_catalog_file = operation.gatget.get_dependence_value("variable","catalog_backups").select { |b| b['id'] == backup_id }.first
+  | <%= backup_catalog_file['dar_name'].ljust(40) %> | <%= backup_id.ljust(6) %> | <%=  backup_data.join(' ').ljust(40) %> |
+%     end
+%   end
+  \<%= '-' * 94 %>/
+
+  You can recover the file or folder with $> <%= $0 %> restore. See help for futher information.
+  
+% end

data/lib/gatgets/gatgets_manager/gatgets_manager.rb

@@ -0,0 +1,65 @@
+=begin
+  This file is part of GAT: http://gat.rubyforge.org
+  
+  (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+   
+  GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher.
+  You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.
+  
+  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. 
+=end
+
+require 'gat'
+
+GATGET_GATGETS_MANAGER_ROOT =  File.expand_path(File.dirname(__FILE__))
+
+class GatgetGatgetsManager < Gat::Base
+  
+  # helpers
+  
+  # valid_gatget_name will search at gagets path if we have a valid gatget script
+  def valid_gatget_name
+    
+    gatget_name     = get_dependence_value("arguments", "gatget_name") 
+    gatgets_path    = "#{ Gem.default_dir }/gems/gat-#{ Gat::VERSION }/lib/gatgets"
+    launcher_place  = get_dependence_value("arguments", "launcher_path")
+    
+    set_flag("launcher_exists", false)
+    
+    if not Dir.new(gatgets_path).entries.include?(gatget_name)
+      self.logger.log('direct', 'valid_gatget_name', "\n ERROR: `#{ gatget_name }` not found at `#{ gatgets_path }` \n\n")
+    elsif not Dir.new("#{ gatgets_path }/#{ gatget_name }").entries.include?("launcher.rb")
+      self.logger.log('direct', 'valid_gatget_name', "\n ERROR: `launcher.rb` not found at `#{ gatgets_path }/#{ gatget_name }` \n\n")
+    else
+      set_flag("launcher_exists", true)
+      set_dependence_variable("gatgets_path", gatgets_path)
+      self.logger.log('direct', 'valid_gatget_name', "\n Launcher for gatget `#{ gatget_name }` will be placed at #{ launcher_place }/gatget_#{ gatget_name }` \n\n Edit and customize it.")
+    end
+  end
+
+  def list_system_gatgets
+    
+    gatgets_path    = "#{ Gem.default_dir }/gems/gat-#{ Gat::VERSION }/lib/gatgets"
+    
+   
+    avalaible_gatgets = {}
+    # get avalaible_gatgets but exclude gatget_manager one
+    (Dir.new(gatgets_path).entries - [ '.', '..' , 'gatgets_manager']).each do |gatget_folder|
+      if Dir.new("#{ gatgets_path }/#{ gatget_folder }").entries.include?("#{ gatget_folder }.yml")
+	gatget_config = YAML.load_file("#{ gatgets_path }/#{ gatget_folder }/#{ gatget_folder }.yml")
+
+	avalaible_gatgets[gatget_folder] = (gatget_config['description'] || "#{ gatget_folder.camelize } gatget")
+      end
+    end
+    
+    set_dependence_variable("avalaible_gatgets", avalaible_gatgets)
+    
+  end
+
+end

data/lib/gatgets/gatgets_manager/gatgets_manager.yml

@@ -0,0 +1,71 @@
+# Gatget Config Script for DarBackup Gatget
+# -----------------------------------------
+
+description: 'Gatgets manager'
+
+static:
+  gatget_folders: []
+    
+arguments:
+  gatget_name:
+    description: Camelized gatget name, for example, dar_backup
+  launcher_path:
+    description: Path where launcher will be placed
+
+
+
+folders:
+
+programs:
+
+
+conditions:
+
+parameters:
+  gatgets_path:
+    type: dependence
+    value: variable/gatgets_path
+  gatget_arg_name:
+    type: dependence
+    value: arguments/gatget_name
+  launcher_path:
+    type: dependence
+    value: arguments/launcher_path
+
+
+
+ 
+actions:
+  copy_launcher:
+    type: shell_command
+    flags: [ launcher_exists ]
+    syntax: cp {{gatgets_path}}/{{gatget_arg_name}}/launcher.rb {{launcher_path}}/gatget_{{gatget_arg_name}}
+  list_system_gatgets:
+    type: ruby_method
+    flags: [  ]
+
+
+operations:
+  list:
+    description: 'List avalaible system gatgets'
+    users:      [ ]
+    programs:   [ ]
+    arguments:  [ ]
+    folders:    [  ]
+    helpers:    [  ]
+    conditions: [ ]
+    actions:    [ list_system_gatgets ]
+    outputs:    [ template ]
+    onfail:     [ ]
+      
+  use:
+    description: 'Create launcher for a defined gatget'
+    users:      [ ]
+    programs:   [ ]
+    arguments:  [ gatget_name, launcher_path ]
+    folders:    [ ]
+    helpers:    [ valid_gatget_name ]
+    conditions: [ ]
+    actions:    [ copy_launcher ]
+    outputs:    [ ]
+    onfail:     [ ]

data/lib/gatgets/gatgets_manager/templates/list.erb

@@ -0,0 +1,9 @@
+% gatgets = operation.gatget.get_dependence_value("variable", "avalaible_gatgets")
+
+  Avalaible System Gatgets
+  
+% gatgets.each_pair do |name, description|
+    - <%= name.ljust(15) %> : <%= description %>
+  
+  
+% end 

data/lib/gatgets/synchronization/README

@@ -0,0 +1,26 @@
+This is the synchronization gatget.
+
+To use it with udev, do the following:
+
+1) Add a udev rule in a file like /etc/udev/rules.d/10-myrules.rules
+
+KERNEL=="sd[a-z][0-9]*", SUBSYSTEM=="block", ATTR{size}=="488392002", SYMLINK+="backup_dev/%n", OPTIONS+="last_rule"
+
+2) Add a cron job to check for the presence of the device:
+
+# Check if the external usb drive is plugged-in, every 3 minutes, and if so, run sync
+*/3 * * * * root test -b /dev/backup_dev/1 && cd /usr/local/sbin && /bin/bash gat_sync_cron.sh /dev/backup_dev/1 /dest_dir_to_mount
+
+
+WARNING: If you want to log the cron output, edit /etc/crontab, do not use crontab -e as it doesn't redirect the cron output
+
+3) Edit /usr/local/sbin/gat_sync_cron.sh to set a few values:
+
+MINUTES_CREATED=5
+MAX_HOURS_FINISHED=10
+
+== Issues
+
+I have not found a way of getting udev reporting me when the device is unplugged.
+
+I have neither found a way of unplug the device by software, so to prevent the script for running continuously until the user unplugs it, I have to use a temporary file to mark the completion of the sync and avoid doing it until a number of defined hours have passed.

data/lib/gatgets/synchronization/launcher.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'gatgets/synchronization/synchronization'
+
+class MyRsyncScript < GatgetSynchronization
+end
+
+# default options... see all options at Gatget config file GAT_ROOT + /lib/gatgets/synchronization/rsync_synchronization.yml
+
+options = {
+  'gat_config' => '/etc/gat/gat.yml',
+  'gatget_config' => {
+    'folders' => { 'source' => { 'path' => '/source/path' },
+                     'dest' => { 'path' => '/dest/path' }
+                 }
+  }
+}
+
+# Launch Gatget
+MyRsyncScript.launch(options, ARGV)

data/lib/gatgets/synchronization/launcher_cron.sh

@@ -0,0 +1,69 @@
+#!/bin/bash
+
+if (( $# != 2 )); then
+        echo "Usage: $0 DEVICE MOUNT_DIR"
+        exit 1
+fi
+
+DEVICE=$1
+MOUNT_DIR=$2
+
+TAG=gat_sync
+logger -t $TAG Starting...
+MINUTES_CREATED=5
+MAX_HOURS_FINISHED=10
+
+DONE_FLAG=/tmp/rsync_done.flag
+# Check if the device is plugged in, that is, udev has created the device node
+if test -b $DEVICE; then
+        logger -t $TAG "$DEVICE exists"
+        now=$(date --utc +"%s")
+        device_created=$(stat -c "%Z" $DEVICE)
+        device_minutes_created=$(( ($now-$device_created) / 60 ))
+
+        goon=1
+        # If $DONE_FLAG exists, the rsync has already been done, but when?
+        if test -f $DONE_FLAG; then
+                done_flag_created=$(stat -c "%Z" $DONE_FLAG)
+                done_flag_hours_created=$(( ($now-$done_flag_created) / 60 / 60 ))
+                # If the device has been created after the last rsync, do it again
+                if (( $device_created > $done_flag_created )); then
+                      rm -f $DONE_FLAG
+                      logger -t $TAG "device inserted after last rsync, so do it again..."
+                else
+                      # if not, check how many hours have been passed
+                      if (( $done_flag_hours_created < $MAX_HOURS_FINISHED)); then
+                          logger -t $TAG "rsync already done within the past    $MAX_HOURS_FINISHED hours"
+                          goon=0
+                      fi
+                fi
+        fi
+
+        if (( $goon=="1" )); then
+                # Check that the device has been created at least a few minutes ago
+                if (( $device_minutes_created > $MINUTES_CREATED )); then
+                        logger -t $TAG "5 minutes have passed"
+                        # Dir lock: if this dir exists, the process is running
+                        if mkdir $MOUNT_DIR 2>/dev/null ; then
+                                mount $DEVICE $MOUNT_DIR
+                                /usr/local/sbin/gat_sync -vvvvvv do_rsync
+                                RET=$?
+                                umount $MOUNT_DIR
+                                rmdir $MOUNT_DIR
+                                logger -t $TAG "finished with exit code $RET"
+                                if (( $RET == 0 )); then
+                                  touch $DONE_FLAG
+                                fi
+                        else
+                                logger -t $TAG "gat_sync is already running..."
+                        fi
+                else
+                        rm -f $DONE_FLAG
+                        logger -t $TAG "Waiting for $DEVICE to be up for more than $MINUTES_CREATED minutes"
+                fi
+        fi
+else
+        logger -t $TAG "$DEVICE not found"
+fi
+
+logger -t $TAG Exiting...

data/lib/gatgets/synchronization/synchronization.rb

@@ -0,0 +1,123 @@
+=begin
+  This file is part of GAT: http://gat.rubyforge.org
+
+  (c) 2008-2009 A.C. Gnoxys info@gnoxys.net
+
+  GAT (Gnoxys Administration Tools) is released under the GPL License 3 or higher.
+  You can get a copy of the license easily at http://www.gnu.org/licenses/gpl.html.
+
+  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.
+=end
+
+# \TODO Check that the sync destination folder is inside the mounted drive
+
+require 'gat'
+
+GATGET_SYNCHRONIZATION_ROOT =  File.expand_path(File.dirname(__FILE__))
+
+class GatgetSynchronization < Gat::Base
+
+  def setflag_remote_backup_running
+    a = Gat::Action::ShellCommand.new('check_remote_backup_status', self.config['actions']['check_remote_backup_status'], self.operation)
+    a.execute
+    set_flag("flag_remote_backup_running", a.output.downcase == "running\n" )
+  end
+
+  def check_host_defined
+    allhosts = `cut -s -f 2 /etc/hosts`
+    required_host = get_dependence_variable("remote_host")
+    if not allhosts.split("\n").include?( required_host )
+      raise Gat::GatgetException.new( "Host #{required_host} not defined in /etc/hosts", "check_host_defined" )
+    end
+  end
+
+  def notify_start
+    st_notify_email_started = get_dependence_value("static", "notify_email_started")
+    if st_notify_email_started && st_notify_email_started["sent_to"]
+        to = st_notify_email_started
+    end
+    subject = st_notify_email_started["subject"]
+    body = st_notify_email_started["body"]
+    if to.nil?
+      if self.config["email_config"]
+        to = self.config["email_config"]["send_to"]
+      else
+        raise Gat::GatgetConfigException.new("Default email config[to] is empty at gatget.config['email_config']", "run_output_email")
+      end
+    end
+    subject = "Rsync started" if subject.nil?
+    body = "Define your own body in static.notify_email_started.body" if body.nil?
+
+    full_subject = "[GAT] [#{ self.class.name }] [#{ self.operation.name.camelize }] #{subject}"
+    create_and_deliver_email(to,
+       { 'subject' => full_subject,
+         'body' => body },
+       self.config["email_config"]
+    )
+  end
+
+
+  # send rescue email will send a email for notification errors at do_backup operation
+  def onfail
+
+    unless self.config['email_config']
+      raise Gat::GatgetConfigException.new("Default email config is empty at gatget.config['email_config']", "run_output_email")
+    end
+
+    unless self.config['email_config']['send_to']
+      raise Gat::GatgetConfigException.new("Default email config 'send_to' is empty at gatget.config['email_config']", "run_output_email")
+    end
+
+    email_subject = "[GAT] [#{ self.class.name }] [#{ self.operation.name.camelize }] [FAILED]"
+
+
+    email_body    =  "Gatget #{ self.class.name } was stopped by raising of #{ self.onfail_error.class } at #{ Time.now }\n\n"
+    email_body    << "#{ onfail_error.exit_error }"
+    email_body    << "\n\n Errors log:  \n\n #{self.logger.entries.select{ |e| e.global_type == 'error' }.map{ |e| e.inspect }.join("\n") }\n\n"
+    email_body    << "\n\n Warning log: \n\n #{self.logger.entries.select{ |e| e.global_type == 'warning' }.map{ |e| e.inspect }.join("\n") }\n\n"
+    email_body    << "\n\n Whole log:   \n\n #{self.logger.entries.map{ |e| e.inspect }.join("\n") }"
+
+    self.create_and_deliver_email(self.config['email_config']['send_to'], { 'subject' => email_subject, 'body' => email_body }, self.config['email_config'])
+
+  end
+
+  def exec_sync_oyw
+    hosts = get_dependence_value("static", "all_hosts")
+    while hosts.any?
+      hosts.each do |host|
+        opname = "sync_#{host}"
+        begin
+          a = Gat::Operation.new(opname, self.config['operations'][opname], self)
+        rescue
+          raise Gat::GatgetConfigException.new("Operation '#{opname}' not defined in yml", "exec_sync_oyw")
+        end
+        a.execute
+        backup_was_running = self.get_flag("flag_remote_backup_running")
+        if not backup_was_running
+          status = a.get_action("exec_remote_rsync").status
+          p status
+          if status == "ok"
+            hosts.delete host
+          end
+        end
+      end
+      sleep 100
+    end
+  end
+
+  def set_parameters_for_my_host
+    set_dependence_variable( "remote_user", "backup" )
+    set_dependence_variable( "remote_folder", "/home/backup/" )
+    set_dependence_variable( "remote_host", "my_host" )
+    set_dependence_variable( "local_folder",  "/home/backup/rsyncs/my_host" )
+  end
+
+end
+
+