Namespace

Class/Module Index [+]

Quicksearch

Backup::Cleaner

Public Class Methods

prepare(model) click to toggle source

Logs warnings if any temporary files still exist from the last time this model/trigger was run, then removes the files.

# File lib/backup/cleaner.rb, line 12
def prepare(model)
  messages = []

  packaging_folder = File.join(Config.tmp_path, model.trigger)
  if File.exist?(packaging_folder)
    messages <<             The temporary packaging folder still exists!            '#{ packaging_folder }'            It will now be removed.
    FileUtils.rm_rf(packaging_folder)
  end

  package_files = package_files_for(model.trigger)
  unless package_files.empty?
    # the chances of the packaging folder AND
    # the package files existing are practically nil
    messages << ('-' * 74) unless messages.empty?

    messages <<             The temporary backup folder '#{ Config.tmp_path }'            appears to contain the package files from the previous backup!            #{ package_files.join("\n") }            These files will now be removed.
    package_files.each {|file| FileUtils.rm_f(file) }
  end

  unless messages.empty?
    Logger.warn Error.new(            Cleanup Warning            #{ messages.join("\n") }            Please check the log for messages and/or your notifications            concerning this backup: '#{ model.label } (#{ model.trigger })'            The temporary files which had to be removed should not have existed.)
  end
end
remove_package(package) click to toggle source

Remove the final package files from tmp_path Note: ‘force’ is used, since a Local Storage may move these files.

# File lib/backup/cleaner.rb, line 61
def remove_package(package)
  Logger.info "Cleaning up the package files..."
  package.filenames.each do |file|
    FileUtils.rm_f(File.join(Config.tmp_path, file))
  end
end
remove_packaging(model) click to toggle source

Remove the temporary folder used during packaging

# File lib/backup/cleaner.rb, line 53
def remove_packaging(model)
  Logger.info "Cleaning up the temporary files..."
  FileUtils.rm_rf(File.join(Config.tmp_path, model.trigger))
end
warnings(model) click to toggle source

Logs warnings if any temporary files still exist when errors occur during the backup

# File lib/backup/cleaner.rb, line 71
def warnings(model)
  messages = []

  packaging_folder = File.join(Config.tmp_path, model.trigger)
  if File.exist?(packaging_folder)
    messages <<             The temporary packaging folder still exists!            '#{ packaging_folder }'            This folder may contain completed Archives and/or Database backups.
  end

  package_files = package_files_for(model.trigger)
  unless package_files.empty?
    # the chances of the packaging folder AND
    # the package files existing are practically nil
    messages << ('-' * 74) unless messages.empty?

    messages <<             The temporary backup folder '#{ Config.tmp_path }'            appears to contain the backup files which were to be stored:            #{ package_files.join("\n") }
  end

  unless messages.empty?
    Logger.warn Error.new(            Cleanup Warning            #{ messages.join("\n") }            Make sure you check these files before the next scheduled backup for            '#{ model.label } (#{ model.trigger })'            These files will be removed at that time!)
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.