backup/backup

View on GitHub
lib/backup/database/openldap.rb

Summary

Maintainability
A
25 mins
Test Coverage
module Backup
  module Database
    class OpenLDAP < Base
      class Error < Backup::Error; end

      ##
      # Name of the ldap backup
      attr_accessor :name

      ##
      # run slapcat under sudo if needed
      # make sure to set SUID on a file, to let you run the file with permissions of file owner
      # eg. sudo chmod u+s /usr/sbin/slapcat
      attr_accessor :use_sudo

      ##
      # Stores the location of the slapd.conf or slapcat confdir
      attr_accessor :slapcat_conf

      ##
      # Additional slapcat options
      attr_accessor :slapcat_args

      ##
      # Path to slapcat utility (optional)
      attr_accessor :slapcat_utility

      ##
      # Takes the name of the archive and the configuration block
      def initialize(model, database_id = nil, &block)
        super
        instance_eval(&block) if block_given?

        @name             ||= "ldap_backup"
        @use_sudo         ||= false
        @slapcat_args     ||= []
        @slapcat_utility  ||= utility(:slapcat)
        @slapcat_conf     ||= "/etc/ldap/slapd.d"
      end

      ##
      # Performs the slapcat command and outputs the
      # data to the specified path based on the 'trigger'
      def perform!
        super

        pipeline = Pipeline.new
        dump_ext = "ldif"

        pipeline << slapcat
        if @model.compressor
          @model.compressor.compress_with do |command, ext|
            pipeline << command
            dump_ext << ext
          end
        end

        pipeline << "#{utility(:cat)} > " \
            "'#{File.join(dump_path, dump_filename)}.#{dump_ext}'"

        pipeline.run
        if pipeline.success?
          log!(:finished)
        else
          raise Error, "Dump Failed!\n" + pipeline.error_messages
        end
      end

      private

      ##
      # Builds the full slapcat string based on all attributes
      def slapcat
        command = "#{slapcat_utility} #{slapcat_conf_option} #{slapcat_conf} #{user_options}"
        command.prepend("sudo ") if use_sudo
        command
      end

      ##
      # Uses different slapcat switch depending on confdir or conffile set
      def slapcat_conf_option
        @slapcat_conf.include?(".d") ? "-F" : "-f"
      end

      ##
      # Builds a compatible string for the additional options
      # specified by the user
      def user_options
        slapcat_args.join(" ")
      end
    end
  end
end