Cross Reference: /ontohub/script/backup

	backup revision 7e19fab3af21714e410863295a27b859111ba40d
168N/A#!/local/usr/ruby/shims/ruby
168N/A# The first line is for deployment machines only. For local machines, use:
168N/A#!/usr/bin/env ruby
168N/A
168N/A# You can find more extensive documentation of this script at
168N/A# https://github.com/ontohub/ontohub/blob/staging/doc/backup_and_restore_of_ontohub_data.md
168N/A
168N/A# Description
168N/A#   This backup script creates and restores backups of ontohub data. It includes:
168N/A#     * bare git repositories (data/repositories)
168N/A#     * named symlinks to git repositories (data/git_daemon)
168N/A#     * the postgres database
168N/A#
168N/A# Usage
168N/A#   First note: Run this as the root user, e.g. with sudo.
168N/A#   To create a backup, run this script with the argument `create`:
168N/A#     # script/backup create
168N/A#   Then a backup named with the current date and time is created in the
168N/A#   backup directory (see below).
168N/A#
168N/A#   To restore a backup, run this script with the argument `restore <backup name>`
168N/A#     # script/backup restore 2015-01-01_00-00
168N/A#   Then the selected backup is fully restored
168N/A#
168N/A# Backup directory
168N/A#   For development machines, the backup directory is:
168N/A#     <rails root>/tmp/backup/
168N/A#   And for production machines, the backup directory is:
168N/A#     /home/ontohub/ontohub_data_backup
168N/A#
168N/A# Super user privileges
168N/A#   To create and restore, we need root privileges. Otherwise file modes are not
168N/A#   preserved. This script will call `sudo` when needed and inform you about the
168N/A#   reason for calling `sudo`. If you don't allow sudo, a backup will be created
168N/A#   or restored anyway, but the file modes and ownership are not preserved.
168N/A#   Then, you need to adjust them manually.
168N/A#
168N/A# Maintenance mode
168N/A#   While backing up and restoring the data, the maintenance mode is activated.
168N/A#   This way we guarantee data consistency of the backup.
168N/A
168N/A
519N/Arequire 'tmpdir.rb'
519N/Arequire 'fileutils'
168N/Arequire 'pathname'
168N/Arequire 'open3'
168N/A
168N/Amodule Backup
168N/A  class Backup
168N/A    # Amount of backups that have to be there at least
168N/A    BACKUPS_COUNT = 30
168N/A    # Backups are kept for at least 365 days
168N/A    BACKUPS_VALIDITY_TIME = 365 * 60 * 60 * 24
168N/A
168N/A    MAINTENANCE_FILE = 'maintenance.txt'
168N/A
168N/A    SQL_DUMP_FILE = 'ontohub_sql_dump.postgresql'
168N/A    REPOSITORY_FILE = 'ontohub_repositories.tar.gz'
168N/A
501N/A    DATA_DIRS = %w(repositories git_daemon)
168N/A
168N/A    # Use 'sudo' on most systems
168N/A    SUDO_BINARY = '+'
168N/A
168N/A    attr_reader :db_name, :data_root, :backup_root, :backup_instance_dir
485N/A    attr_reader :dry_run, :verbose, :sql_dump_as_db_user
485N/A
485N/A    def initialize(db_name, data_root, backup_root,
485N/A      verbose: false, dry_run: true, sql_dump_as_db_user: nil,
485N/A      user: nil, group: nil)
168N/A      @db_name = db_name
206N/A      @backup_root = Pathname.new(backup_root)
168N/A      @data_root = Pathname.new(data_root)
168N/A      @data_root_basename = @data_root.basename.to_s
168N/A      @data_dirs = DATA_DIRS.map { |dir| File.join(@data_root_basename, dir) }
168N/A      @user = user
277N/A      @group = group
383N/A
168N/A      @dry_run = dry_run
168N/A      @verbose = verbose
168N/A      @sql_dump_as_db_user = sql_dump_as_db_user
168N/A    end
168N/A
168N/A    def create
168N/A      puts 'Creating backup...'
168N/A      enable_maintenance_mode
168N/A      initialize_backup
168N/A      create_sql_dump
168N/A      create_repository_archive
168N/A      # We needed to create the directory for the script to continue later on.
181N/A      Dir.rmdir(backup_instance_dir) if dry_run
168N/A      disable_maintenance_mode
168N/A      puts "Created backup in #{backup_instance_dir}"
168N/A      self.class.prune(backup_root)
168N/A    end
168N/A
    def restore(backup_name)
      enable_maintenance_mode
      initialize_restore(backup_name)
      restore_sql_dump
      restore_repository_archive
      disable_maintenance_mode
      puts "Restored backup from #{backup_instance_dir}"
    end

    def self.prune(backup_root)
      if !Dir.exists?(backup_root)
        $stderr.puts "Nothing to prune: There is no backup directory."
        return
      end
      now = Time.now
      backup_dirs_allowed_to_delete(Dir.new(backup_root).entries).each do |dir|
        backup = backup_root.join(dir)
        if now - File.new(backup).ctime > BACKUPS_VALIDITY_TIME
          puts "removing old backup: #{dir}"
          FileUtils.rm_r(backup)
        end
      end
    end

    protected

    def new_backup_name
      Time.now.strftime("%Y-%m-%d_%H-%M-%S")
    end

    def initialize_backup
      @backup_instance_dir = backup_root.join(new_backup_name)
      puts "FileUtils.mkdir_p #{backup_instance_dir}" if verbose
      # Create directory even in dry run to let the script continue.
      FileUtils.mkdir_p(backup_instance_dir)
      puts "FileUtils.chown #{@user} #{@group} #{backup_instance_dir}" if verbose
      FileUtils.chown(@user, @group, backup_instance_dir)
    end

    def create_sql_dump
      puts 'Creating SQL dump...'
      Dir.chdir(backup_instance_dir) do
        exec('pg_dump', *pg_user_switch, '-Fc', db_name,
             '-f', backup_instance_dir.join(SQL_DUMP_FILE), user: @user)
      end
    end

    def create_repository_archive
      puts 'Creating repository archive...'
      Dir.chdir(data_root.join('..')) do
        archive_file = backup_instance_dir.join(REPOSITORY_FILE)
        exec('tar', verbose ? '-v' : '', '-cf', archive_file.to_s, *@data_dirs,
             user: @user)
      end
    end

    def initialize_restore(backup_name)
      @backup_instance_dir = backup_root.join(backup_name)
      unless Dir.exists?(backup_instance_dir)
        $stderr.puts (
          "Error: Backup '#{backup_name}' does not exist in #{backup_root}.")
        exit
      end
    end

    def restore_sql_dump
      'Restoring SQL dump...'
      Dir.chdir(backup_instance_dir) do
        exec('pg_restore', '-n', 'public',
             '-c', *pg_user_switch,
             '-d', db_name,
             SQL_DUMP_FILE,
             user: @user)
      end
    end

    def restore_repository_archive
      puts 'Restoring repository archive...'
      Dir.chdir(data_root.join('..')) do
        tmpdir = Dir.mktmpdir
        move_data_dirs_to_tmpdir(tmpdir)
        begin
          extract_archive
          remove_tmpdir(tmpdir)
        rescue => e
          puts <<-MSG

An error occured while restoring the repositories:
#{e.message}
You can find the pre-restore repositories at #{tmpdir}
Do something about it.
          MSG
          raise e
        end
      end
    end

    def move_data_dirs_to_tmpdir(tmpdir)
      puts "FileUtils.mv(#{@data_dirs}, #{tmpdir})" if verbose
      FileUtils.mv(@data_dirs, tmpdir) unless dry_run
    rescue Errno::EACCES
      puts <<-MSG

As the current user I have no access to move the repository data
directories #{@data_dirs.join(' ')} to a temporary directory #{tmpdir}.
This is used as a backup for the case of an error while restoring.
To continue, I try the command again using sudo.
      MSG
      exec('mv', *@data_dirs, tmpdir, user: 'root')
    end

    def extract_archive
      archive_file = backup_instance_dir.join(REPOSITORY_FILE)
      puts <<-MSG

Super user privileges are needed to reset the file permissions as
they were before the backup. If you refuse to enter the password
(Ctl-C) or enter a wrong password, only the permissions will not be
restored and all restored files will belong to the current user/group.
      MSG
      try_as_sudo_with_fallback('tar', verbose ? '-v' : '', '-xf',
        archive_file.to_s, *@data_dirs)
    end

    def remove_tmpdir(tmpdir)
      puts "FileUtils.remove_entry(#{tmpdir})" if verbose
      FileUtils.remove_entry(tmpdir) # even do this in dry run
    rescue Errno::EACCES
      puts <<-MSG

As the current user I have no access to remove the temporary
directory #{tmpdir}.
To continue, I try the command again using sudo.
      MSG
      exec('rm', '-r', tmpdir, user: 'root')
    end

    def enable_maintenance_mode
      puts 'Enabling maintenance mode...'
      if File.exist?(maintenance_file)
        $stderr.puts 'Maintenance mode was already enabled.'
        $stderr.puts "Please check the file #{maintenance_file}"
        $stderr.puts 'Aborting.'
        exit
      end
      puts "FileUtils.touch #{maintenance_file}" if verbose
      FileUtils.touch maintenance_file unless dry_run
    end

    def disable_maintenance_mode
      puts 'Disabling maintenance mode...'
      puts "FileUtils.rm #{maintenance_file}" if verbose
      FileUtils.rm maintenance_file unless dry_run
    end

    # Execute a command as the given user.
    def exec(*args, user: nil)
      print "[executing next command in #{Dir.getwd}" if verbose
      print " as user #{user}" if verbose && user
      puts "]" if verbose

      out = args.join(' ')
      puts out if verbose
      if !dry_run
        if user == 'root'
          exec_system(*[sudo, *args])
        elsif user
          # This looks strange because of the double sudo.
          # It is needed on our deployment machines to get the environment right.
          exec_system(*['+', 'sudo', '-u', user, 'bash', '-c',
                        "cd #{Dir.getwd} && #{escape_arguments(args)}"])
        else
          exec_system(*args)
        end
      end
    end

    def sudo
      SUDO_BINARY
    end

    def exec_system(*args)
      # puts args.join(' ') # For debugging
      system(*args)
    end

    def escape_arguments(args)
      rest = args[1..-1].map do |arg|
        if arg.to_s.include?(' ')
          %("#{arg.gsub('"', '\"')}")
        else
          arg
        end
      end
      ([args[0]] + rest).join(' ')
    end

    def maintenance_file
      data_root.join(MAINTENANCE_FILE)
    end

    def pg_user_switch
      sql_dump_as_db_user ? %W(-U #{sql_dump_as_db_user}) : []
    end

    def self.backup_dirs_allowed_to_delete(entries)
      entries.reject{ |entry| %w(. ..).include?(entry) }[0..-(BACKUPS_COUNT+1)]
    end
  end
end

def data_root(rails_root)
  if on_development_system?(rails_root)
    File.realpath(rails_root.join('data'))
  else
    ENV['DATA_ROOT'] ||'/data/git'
  end
end

def on_development_system?(rails_root)
  data_path = rails_root.join('data')
  File.exist?(data_path) && !File.symlink?(data_path)
end

# Don't allow this to be run as the root user.
if ENV['USER'] != 'root'
  puts 'Running this script as a normal user is disabled.'
  puts 'Please run it as root.'
  exit
end

# We assume, this script runs in "RAILS_ROOT/script/".
RAILS_ROOT = Pathname.new(__FILE__).dirname.join('..')
BACKUP_ROOT_PRODUCTION = '/local/home/ontohub/ontohub_data_backup'

USER = 'ontohub'
GROUP = 'webservd'

DATABASE =
  if on_development_system?(RAILS_ROOT)
    'ontohub_development'
  else
    'ontohub'
  end

BACKUP_ROOT =
  if on_development_system?(RAILS_ROOT)
    RAILS_ROOT.join('tmp', 'backup')
  else
    File.realpath(BACKUP_ROOT_PRODUCTION)
  end

backup = Backup::Backup.new(DATABASE, data_root(RAILS_ROOT), BACKUP_ROOT,
  sql_dump_as_db_user: on_development_system?(RAILS_ROOT) ? 'postgres' : 'ontohub',
  user: USER, group: GROUP,
  dry_run: false, verbose: true)

case ARGV.first
when 'create'
  backup.create
when 'restore'
  if ARGV.length == 1
    $stderr.puts(
      'To restore a backup, you need to specify one with the arguments')
    $stderr.puts('"restore backup_name"')
    exit
  end
  backup_name = ARGV[1]
  backup.restore(backup_name)
when 'prune'
  Backup::Backup.prune(BACKUP_ROOT)
else
  $stderr.puts 'unknown or missing parameter'
  $stderr.puts 'use parameter "create" or "restore <backup_name>" or "prune"'
  exit
end