jage-rmysqldump 0.0.1

data/bin/rmysqldump.rb

@@ -0,0 +1,198 @@
+#!/usr/bin/env ruby
+
+# $Id: rmysqldump.rb,v 1.7 2007/11/28 11:48:22 jage Exp $
+#
+# Written by Johan Eckerstr�m <johan@jage.se> 
+# 
+# 2007-05-22 - Stop using regexp for owner_map \
+#               and improve syslog message
+# 2006-12-19 - Compression for servers
+# 2006-12-01 - External configuration file
+# 2006-11-21 - Easier to change the user mapping regexp
+# 2006-10-31 - Added syslog capabilities
+# 2006-08-06 - First version
+#
+# Todo:
+#  - Add regexp capabilities for the database-specifications
+#  - Record elapsed time for backup
+
+begin
+  require 'fileutils'
+  require 'syslog'
+  require 'rubygems'
+  require 'mysql'
+rescue LoadError
+  $stderr.puts 'Could not load required libraries'; exit 1
+end
+
+begin
+  load '/etc/rmysqldump.conf'
+rescue LoadError
+  $stderr.puts 'Could not load configuration'; exit 1
+end
+
+$users = []
+IO.foreach('/etc/passwd') do |line|
+  $users << /(^[\w]+)/.match(line).to_s.strip
+end
+
+module MySQL
+  class Databases
+
+    attr_reader :list
+
+    def initialize 
+      @list = databases.collect {|i| Database.new(i) }
+    end
+
+    def failed
+      @list.select {|i| i.fail }
+    end
+
+    def skipped
+      @list.select {|i| i.skip }
+    end
+
+    def successes
+      @list.select {|i| i.success }
+    end
+
+    private
+
+    def databases
+      list = []
+      connection = Mysql.real_connect($server[:host], 
+                                      $server[:user], 
+                                      $server[:password])
+      result = connection.query('SHOW DATABASES')
+      result.each {|db| list << db.to_s }
+      result.free
+      list
+    rescue Mysql::Error => error
+      $stderr.puts error.message; exit 1
+    end
+  end
+
+  class Database
+
+    attr_reader :name, :lock, :owner, :group, :charset, :skip
+    attr_accessor :success
+
+    def initialize(name)
+      @options = $database_options[name.to_sym] ||= Hash.new
+
+      @name    = name
+      @lock    = option_for(:lock)
+      @owner   = option_for(:owner).to_s
+      @group   = option_for(:group).to_s
+      @charset = option_for(:charset).to_s
+      @skip    = option_for(:skip)
+
+      # Would be better if the database specific owner could override this
+      if option_for(:map_owner) && owner = find_owner
+        @owner = owner
+      end
+    end
+
+    def to_s
+      name
+    end
+
+    def path
+      "#{$archive_dir}/#{self}.sql.gz"
+    end
+
+    def fail
+      !success && !skip
+    end
+
+    private
+
+    def option_for(key)
+      @options[key] || $global_options[key] || false
+    end
+
+    def find_owner
+        match = $users.select do |u|
+          @name.include?(u) && u == @name[0...u.length]
+        end
+
+        if match.empty? 
+          false
+        else
+          match.to_s
+        end
+    end
+  end
+
+  class Dump
+    def initialize(databases)
+      @databases = databases
+
+      unless mysqldump_working?
+        failure("Could not execute #{$mysqldump}"); exit 1
+      end
+
+      unless File.directory?($archive_dir)
+        failure("Could not save in #{$archive_dir}"); exit 1
+      end
+    end
+
+    def execute
+      Syslog.open(ident='rmysqldump', facility=Syslog::LOG_DAEMON)
+      @databases.list.each do |database|
+        unless database.skip
+          `#{$mysqldump} #{parameters_for(database)} #{database} | #{$gzip} > #{database.path}`
+          failure("Could not dump #{database}") unless $?.success?
+          begin
+            FileUtils.chown database.owner, database.group, database.path
+            FileUtils.chmod 0660, database.path
+            database.success = true if $?.success?
+          rescue => error
+            failure("Could not set permissions: #{error.message}")
+          end
+        end
+      end
+      message  = "#{@databases.successes.length} databases dumped successfully"
+      if @databases.skipped.length > 0
+        message += ", #{@databases.skipped.length} skipped" 
+      end
+      Syslog.info(message)
+
+      # Inform about failures
+      if @databases.failed.length > 0
+        error_message = 'Failed databases:'
+        @databases.failed.each do |db|
+          error_message << " #{db},"
+        end
+        error_message.gsub!(/,$/, '.')
+        Syslog.err(error_message) 
+      end
+
+      Syslog.close
+    end
+
+    private
+
+    def failure(message)
+      $stderr.puts message
+      Syslog.err(message) if Syslog.opened?
+    end
+
+    def mysqldump_working?
+      File.readable?($mysqldump) and File.executable?($mysqldump)
+    end
+
+    def parameters_for(database)
+      params   = "--default-character-set=#{database.charset} \
+                  --user #{$server[:user]} \
+                  --password=#{$server[:password]} \
+                  --host #{$server[:host]}"
+      params += " --compress" if $server[:compress]
+      params += " --lock-tables" if database.lock
+      params
+    end
+  end
+end
+
+MySQL::Dump.new(MySQL::Databases.new).execute

data/rmysqldump.conf

@@ -0,0 +1,23 @@
+$mysqldump   = '/usr/local/bin/mysqldump'
+$gzip        = '/usr/bin/gzip'
+$archive_dir = '/archive/mysqldump'
+
+$server = {
+  :host     => 'localhost',
+  :user     => 'dumper',
+  :password => 'hemlis', 
+  :compress => true                # Compress the data stream
+}
+
+$database_options = {
+  :apachelogs => { :skip => true }
+}
+
+$global_options = {
+  :lock      => false,    # Lock the tables before dump
+  :owner     => 'root',   # Default user to own the backups
+  :group     => 'wheel',  # Default group to own the backups
+  :charset   => 'latin1', # The charset to set in mysqldump
+  :map_owner => true      # Match database name, if name starts
+                          #  a users name, he's the owner
+}

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification 
+name: jage-rmysqldump
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Johan Eckerstr\xC3\xB6m"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mysql
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Used for dumping mysql databases on shared servers
+email: johan@duh.se
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- rmysqldump.conf
+- bin/rmysqldump.rb
+has_rdoc: false
+homepage: http://github.com/jage/rmysqldump
+post_install_message: 
+rdoc_options: []
+
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Dump MySQL databases
+test_files: []
+