backup_paradise 1.2.13

data/lib/backup_paradise/toplevel_methods/cliner.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/cliner.rb'
+# =========================================================================== #
+module BackupParadise
+
+  # ========================================================================= #
+  # === BackupParadise.cliner
+  # ========================================================================= #
+  def self.cliner
+    puts '=' * 80
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/colours.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/colours.rb'
+# =========================================================================== #
+module BackupParadise
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === use_colours
+  # ========================================================================= #
+  @use_colours = true
+
+  # ========================================================================= #
+  # === BackupParadise.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.use_colours=
+  # ========================================================================= #
+  def self.use_colours=(i)
+    @use_colours = i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.sfancy
+  # ========================================================================= #
+  def self.sfancy(i)
+    return Colours.sfancy(i) if @use_colours
+    i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.sdir
+  # ========================================================================= #
+  def self.sdir(i)
+    return Colours.sdir(i) if @use_colours
+    i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.sfile
+  # ========================================================================= #
+  def self.sfile(i)
+    return Colours.sfile(i) if @use_colours
+    i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.simp
+  # ========================================================================= #
+  def self.simp(i)
+    return Colours.simp(i) if @use_colours
+    i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.royalblue
+  # ========================================================================= #
+  def self.royalblue(i)
+    return Colours.royalblue(i) if @use_colours
+    i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.tomato
+  # ========================================================================= #
+  def self.tomato(i)
+    return Colours.tomato(i) if @use_colours
+    i
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/e.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/e.rb'
+# =========================================================================== #
+module BackupParadise
+
+  # ========================================================================= #
+  # === BackupParadise.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/help.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/help.rb'
+# =========================================================================== #
+require 'backup_paradise/toplevel_methods/cliner.rb'
+require 'backup_paradise/toplevel_methods/colours.rb'
+
+module BackupParadise
+
+  # ========================================================================= #
+  # === BackupParadise.show_help                                  (help tag)
+  #
+  # Here we register all help-related methods.
+  #
+  # Two hints are registered, "tohdd", and "no-gtk".
+  # To use this, do: Help.show_help
+  #
+  # Or, from the commandline:
+  #
+  #   rbackup --help
+  #
+  # ========================================================================= #
+  def self.show_help
+    e
+    cliner
+    e '  - Please note that you can use any order for the arguments.'
+    e
+    e 'Documented help options are:'
+    e
+    e '  rbackup --programs-dir    # Back up the /Programs/ directory quickly'
+    e '  rbackup --backup-to=/PATH # Back up into the PATH directory.'
+    e
+    e 'The following options are NOT yet tested!'
+    e
+    e "  - Pass #{sfancy('tohdd')} to backup to the hdd (usually "\
+      "this is the second harddisc)."
+    e
+    e '  - Pass '+sfancy('tousb ')+'to backup to the (first) usb media.'
+    e '    (Aliases exist, such as '+sfancy('usb1')+sfancy(' usb2')+
+      sfancy(' usb3')+' and so forth)'
+    e
+    e '  - Pass '+sfancy('data_only ')+'to backup only the '+
+      sdir(HOME_DIRECTORY_OF_THE_USER_X+'DATA/')+' directory.'
+    e
+    e '  - In general you can backup individual dir as wells.'
+    e
+    e '    Examples for this:'
+    e
+    e sfancy('      rbackup audio')
+    e sfancy('      rbackup data')
+    e
+    e '  - You can also chain together commands.'
+    e '    Example for chaining together commands:'
+    e sfancy('      rbackup data_only usb1')
+    e sfancy('      rbackup audio_only usb1')
+    e
+    e '  - You can backup the /Programs directory.'
+    e '    Issue the following command here:'
+    e sfancy('      rbackup usb1 programs')
+    e sfancy('      rbackup usb1 /Programs')
+    e
+    e '  - If you do the following.'
+    e '    Examples:'
+    e sfancy('      rbackup no-mount1')
+    e '    Then we wont try to (re)mount the device again.'
+    e
+    e 'If you want to show the time it took to backup the last some'
+    e 'backup-jobs, use this commandline flag:'
+    e
+    e sfancy('  rbackup --logfile')
+    e
+    e 'To simply backup into the current working '\
+      'directory (cwd, pwd)'
+    e 'use:'
+    e
+    e sfancy('  rbackup --pwd')
+    e
+    e 'To use the GTK3 GUI, you could try:'
+    e
+    e sfancy('  rbackup --gui')
+    e
+    cliner
+    e
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,343 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+require 'fileutils'
+require 'backup_paradise/constants/constants.rb'
+require 'backup_paradise/project/project_base_directory.rb'
+require 'backup_paradise/toplevel_methods/colours.rb'
+require 'backup_paradise/toplevel_methods/e.rb'
+require 'backup_paradise/toplevel_methods/opnn.rb'
+require 'backup_paradise/version/version.rb'
+
+module BackupParadise
+
+  _ = "#{BackupParadise::PROJECT_BASE_DIRECTORY}yaml/config.yml" # bl $RUBY_BACKUP/YAML/config.yml
+
+  # ========================================================================= #
+  # === CONFIG
+  #
+  # Keep track of the configuration of the backup-paradise project.
+  # ========================================================================= # 
+  if File.exist? _
+    CONFIG = YAML.load_file(_) # This will be a Hash.
+  else
+    CONFIG = {}
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.remove
+  #
+  # Easier wrapper when we need to remove something, be it a directory
+  # or a file or a symlink.
+  # ========================================================================= #
+  def self.remove(i)
+    if i.is_a? Array
+      i.each {|entry| remove(entry) }
+    else
+      i = rds(i)
+      _ = i.dup
+      if File.directory? i
+        _ = sdir(i)
+      elsif File.file?(i)
+        _ = sfile(i)
+      else # else it will just be fancy.
+        _ = sfancy(i)
+      end
+      e "Trying to remove `#{_}` next."
+      if File.directory?(i)
+        remove_directory(i)
+      elsif File.file?(i)
+        remove_this_file(i) # Defined in this file here.
+      else
+        e 'Not found the action: "'+sfancy(i)+'"'
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === report_current_dir
+  #
+  # This method will tell us about the current directory.
+  # ========================================================================= #
+  def self.report_current_dir
+    e "Current location is: #{sdir(Dir.pwd)}"
+  end; self.instance_eval { alias report_pwd               report_current_dir } # === BackupParadise.report_pwd
+       self.instance_eval { alias report_current_directory report_current_dir } # === BackupParadise.report_current_directory
+
+  # ========================================================================= #
+  # === BackupParadise.remove_this_file
+  #
+  # Use this method to remove a file.
+  # ========================================================================= #
+  def self.remove_this_file(this_file)
+    e "Removing the file `#{sfile(this_file)}` now."
+    FileUtils.rm(this_file)
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.size?
+  #
+  # Gives you the size of the given subdirectory.
+  #
+  # Usage Example:
+  #
+  #   BackupParadise.size?(ENV['J']) # => 1_396_436_232
+  #   BackupParadise.size?(BackupParadise::AUDIO_DIR) # => 1_396_436_232
+  #
+  # ========================================================================= #
+  def self.size?(subdir_part)
+    size = 0 # Default.
+    begin
+      subdir_part = "#{subdir_part}/**/*"
+      results = Dir[subdir_part]
+      size = results.inject(0) { |sum, entry|
+        result = 0
+        result = sum + File.size(entry) if File.exist? entry
+        result
+      }
+    rescue; end # Make it failsave.
+    return size.to_s
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.size_in_gigabytes?
+  #
+  # This method will return the size of the target directory in gigabytes.
+  # ========================================================================= #
+  def self.size_in_gigabytes?(i = BackupParadise::AUDIO_DIR)
+    (
+      BackupParadise.size?(i).to_f / 1024.0 / 1024.0 / 1000.0
+    ).round(1).to_f
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.rds
+  # ========================================================================= #
+  def self.rds(i)
+    i.squeeze '/'
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.copy_file
+  #
+  # Copy a file with this method.
+  # ========================================================================= #
+  def self.copy_file(file, where_to)
+    begin
+      FileUtils.cp(file, where_to)
+    rescue Errno::ENOSPC # Not enough space on target device.
+      opnn; e 'We must exit now - there is not enough space left on the '
+      opnn; e 'target hdd.'
+    rescue Errno::EINVAL # Invalid argument @ rb_sysopen
+      opnn; e 'The file can not be copied, possibly because it '\
+              'contains a german umlaut.'
+      opnn; e 'We will however continue nonetheless.'
+    rescue Errno::EISDIR
+      opnn; e 'We currently do not copy directories, only files.'
+    rescue Errno::EILSEQ => error
+      opnn; e "It seems that we have an invalid or incomplete multibyte "\
+              "or wide-character at file `#{sfile(file.to_s)}`."
+      opnn; e 'We thus can not copy this file.'
+      pp error
+    rescue Exception => error # In lucky days, we will never reach this here.
+      pp error
+      opnn; e 'The above error should be intercepted - please add it,'
+      opnn; e 'then press the ENTER key in order to continue.'
+      $stdin.gets.chomp # We will remove this line here eventually.
+    end
+  end; self.instance_eval { alias copy_this_file copy_file } # === BackupParadise.copy_this_file
+
+  # ========================================================================= #
+  # === BackupParadise.copy_recursively
+  #
+  # Copy the source to the target in a recursive manner.
+  #
+  # The third argument to this method, `be_verbose`, will feedback
+  # to the user if it is set to true. Otherwise, we will just copy
+  # silently.
+  # ========================================================================= #
+  def self.copy_recursively(
+      source,
+      target,
+      be_verbose = :be_verbose
+    )
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    end
+    hash_to_use = {
+      verbose: be_verbose
+    }
+    source = source.dup if source.frozen?
+    if source.include? '*'
+      require 'convert_global_env'
+      source = ConvertGlobalEnv[source].dup
+    elsif Dir.exist?(source)
+      source << '*'
+    end
+    source = rds(source)
+    target = rds(target)
+    begin
+      case BackupParadise.use_system_cp?
+      # ===================================================================== #
+      # === true
+      #
+      # In that case we will use system cp.
+      # ===================================================================== #
+      when true
+        system("cp -Rv #{source} #{target}")
+      # ===================================================================== #
+      # === false
+      # ===================================================================== #
+      when false, nil, '', 'default' # In this event we will use FileUtils module.
+        extend FileUtils::Verbose if be_verbose
+        # source[-1,1] = '' if source[-1,1] == '*'
+        FileUtils.cp_r(
+          source, target, hash_to_use
+        )
+      end
+    rescue Exception => error
+      opnn; e 'An error occurred in method cpr(): '+error.class.to_s
+      pp error
+    end
+
+  end; self.instance_eval { alias cpr copy_recursively } # === BackupParadise.cpr
+
+  # ========================================================================= #
+  # === BackupParadise.remove_directory
+  # ========================================================================= #
+  def self.remove_directory(i)
+    i = rds(i)
+    unless i == '/' # Tiny "safeguard".
+      FileUtils.rm_rf(i) if File.directory?(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.change_directory                  (cd tag, chdir tag)
+  #
+  # This should no longer be required.
+  # ========================================================================= #
+  def self.change_directory(i)
+    Dir.chdir(i) if File.directory?(i)
+  end; self.instance_eval { alias cd change_directory } # === BackupParadise.cd
+
+  # ========================================================================= #
+  # === BackupParadise.create_directory
+  #
+  # Dir.mkdir would be an alternative. We require DEFAULT_MODE to be set
+  # before we can use this method here - hence why we require the file
+  # constants.rb.
+  # ========================================================================= #
+  def self.create_directory(
+      i, mode = DEFAULT_MODE
+    )
+    mode = DEFAULT_MODE if mode.nil?
+    if i.count('/') > 1
+      # ===================================================================== #
+      # We delegate towards FileUtils.mkdir_p() next, but we have to be
+      # careful - there may be no space left on the external device, so
+      # we have to rescue this situation.
+      # ===================================================================== #
+      begin
+        FileUtils.mkdir_p(i) unless Dir.exist? i
+        return true
+      rescue Errno::ENOSPC => error
+        opnn; e 'It appears to be the case that there is no space left on'
+        opnn; e 'the target device.'
+        pp error # And show the exact error as well.
+      end
+    else
+      unless File.directory? i
+        Dir.mkdir(i, mode)
+        return true # Return true just in case we ever need this information.
+      end
+    end
+    false
+  end; self.instance_eval { alias mkdir create_directory } # === BackupParadise.mkdir (mkdir tag)
+
+  # ========================================================================= #
+  # === BackupParadise.use_system_cp?
+  # ========================================================================= #
+  def self.use_system_cp?
+    if CONFIG.has_key?('use_system_cp')
+      if (CONFIG['use_system_cp'] == true)
+        return true
+      else
+        return false
+      end
+    else
+      return true
+    end
+  end
+
+  # ========================================================================= #
+  # === debug                                                     (debug tag)
+  #
+  # This is just "quick" debug output.
+  # ========================================================================= #
+  def debug
+    e
+    e '  Data directory: '+sfancy(data_directory?)
+    e "  Main mount point: #{sfancy(mount_point?.to_s)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.backup
+  #
+  # Use this to backup something individually.
+  #
+  # To invoke this method, do:
+  #
+  #   BackupParadise.backup(:audio, '/Mount/HDD1/')
+  #
+  # ========================================================================= #
+  def self.backup(
+      this_directory_or_file = '/home/x/songs/',
+      target_location        = '/Mount/HDD1/',
+      be_verbose             = true
+    )
+    if this_directory_or_file.is_a? Array
+      this_directory_or_file.each {|entry|
+        Backup.backup(entry, target_location, be_verbose)
+      }
+    else
+      this_directory_or_file = rds(this_directory_or_file)
+      case this_directory_or_file
+      # ===================================================================== #
+      # === :audio
+      # ===================================================================== #
+      when :audio, :audio_dir, :songs, :songs_dir, :default
+        this_directory_or_file = '/home/x/songs/'
+      end
+      target_location = target_location.to_s
+      e "Now backing up directory `#{sdir(this_directory_or_file)}"\
+        "` to `#{sdir(target_location)}`."
+      cpr( # defined in the file base.rb, meaning "copy recursively".
+        this_directory_or_file,
+        target_location,
+        be_verbose
+      )
+      rename_tab 'Backing up now ...'
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.use_this_program_to_rename_tabs?
+  # ========================================================================= #
+  def self.use_this_program_to_rename_tabs?
+    if CONFIG.has_key?('use_this_program_to_rename_tabs')
+      # ===================================================================== #
+      # Obtain the program that we will use for renaming the tab.
+      # ===================================================================== #
+      CONFIG['use_this_program_to_rename_tabs']
+    else
+      :konsole # Default.
+    end
+  end
+
+end