backup_paradise 1.3.1

data/lib/backup_paradise/project/project.rb

@@ -0,0 +1,40 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/project/project.rb'
+# =========================================================================== #
+module BackupParadise
+
+  # ========================================================================= #
+  # === PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === BackupParadise.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    BackupParadise::PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_directory? project_base_dir? } # === BackupParadise.project_base_directory?
+
+  # ========================================================================= #
+  # === BackupParadise.project_yaml_dir?
+  # ========================================================================= #
+  def self.project_yaml_dir?
+    "#{BackupParadise::PROJECT_BASE_DIRECTORY}yaml/"
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.file_config_yaml
+  #
+  # This method will return the proper path to the config.yml file
+  # in use.
+  # ========================================================================= #
+  def self.file_config_yaml
+    "#{BackupParadise.project_yaml_dir?}config.yml"
+  end; self.instance_eval { alias file_config  file_config_yaml } # === BackupParadise.file_config
+       self.instance_eval { alias file_config? file_config_yaml } # === BackupParadise.file_config?
+
+end

data/lib/backup_paradise/requires/require_the_backup_paradise_project.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# When you wish to require the whole project, this is the file to go for.
+# =========================================================================== #
+# require 'backup_paradise/requires/require_the_backup_paradise_project.rb'
+# =========================================================================== #
+require 'backup_paradise/project/project.rb'
+require 'backup_paradise/requires/require_yaml.rb'
+require 'backup_paradise/actions/backup.rb'
+require 'backup_paradise/colours/colours.rb'
+require 'backup_paradise/constants/constants.rb'
+require 'backup_paradise/toplevel_methods/e.rb'
+require 'backup_paradise/toplevel_methods/cliner.rb'
+require 'backup_paradise/utility_scripts/backup/backup.rb'
+require 'backup_paradise/tab/tab.rb'
+require 'backup_paradise/windows/windows.rb'

data/lib/backup_paradise/requires/require_yaml.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/requires/require_yaml.rb'
+# =========================================================================== #
+require 'yaml'

data/lib/backup_paradise/tab/tab.rb

@@ -0,0 +1,87 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BackupParadise::Tab
+#
+# This file handles tab-related activities, most normally renaming a tab.
+#
+# Right now we have only some support for KDE tabs and mrxvt tabs.
+# =========================================================================== #
+# require 'backup_paradise/tab/tab.rb'
+# =========================================================================== #
+module BackupParadise
+
+module Tab # === BackupParadise::Tab
+
+  begin
+    require 'roebe/classes/mrxvt_options.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.rename_tab
+  #
+  # This method does some additional checks before invoking the method 
+  # set_mrxvt_tab_title. set_konsole_tab_title() may work, if the
+  # user at hand has the roebe gem installed (aka, on my home system).
+  # ========================================================================= #
+  def self.rename_tab(
+      i                               = :mrxvt,
+      optional_title                  = 'Backup', # <- This is the new title.
+      use_this_program_to_rename_tabs = :mrxvt
+    )
+    case i.to_sym # case tag
+    # ======================================================================= #
+    # === :konsole
+    #
+    # This is the default.
+    # ======================================================================= #
+    when :konsole,
+         :default
+      set_konsole_tab_title(optional_title)
+    # ======================================================================= #
+    # === :mrxvt
+    # ======================================================================= #
+    when :mrxvt
+      set_mrxvt_tab_title(optional_title) # Defined in this module here.
+    # ======================================================================= #
+    # === :blank
+    #
+    # This entry point re-sets the title of the terminal tab again to
+    # empty.
+    # ======================================================================= #
+    when :blank
+      case use_this_program_to_rename_tabs
+      when :konsole
+        set_konsole_tab_title(optional_title)
+      when :mrxvt
+        set_mrxvt_tab_title(optional_title)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.set_mrxvt_tab_title
+  # ========================================================================= #
+  def self.set_mrxvt_tab_title(i)
+    if Object.const_defined? :Roebe
+      begin
+        require 'roebe/classes/mrxvt_options.rb'
+      rescue LoadError; end
+      Roebe::MrxvtOptions.set_title(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.set_konsole_tab_title
+  # ========================================================================= #
+  def self.set_konsole_tab_title(i)
+    if Object.const_defined? :Roebe
+      begin
+        require 'roebe/classes/kde/kde_konsole.rb'
+      rescue LoadError; end
+      Roebe.rename_konsole_title_to(i, :be_quiet)
+    end
+  end
+
+end; end

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/config.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/config.rb'
+# =========================================================================== #
+module BackupParadise
+
+  require 'yaml'
+
+  require 'backup_paradise/project/project.rb'
+
+  _ = BackupParadise.file_config_yaml # 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.config?
+  #
+  # Toplevel query method over the config-hash.
+  # ========================================================================= #
+  def self.config?
+    CONFIG
+  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'].to_sym
+    else
+      :konsole # Default.
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.use_system_cp?
+  # ========================================================================= #
+  def self.use_system_cp?
+    if CONFIG.has_key?('use_system_cp')
+      return CONFIG['use_system_cp']
+    else
+      return true
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.show_popup_notification?
+  # ========================================================================= #
+  def self.show_popup_notification?
+    if CONFIG.has_key?('show_popup_notification')
+      if (CONFIG['show_popup_notification'] == true)
+        return true
+      else
+        return false
+      end
+    else
+      return true
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.backup_these_directories?
+  # ========================================================================= #
+  def self.backup_these_directories?
+    if CONFIG.has_key?('backup_these_directories')
+      return CONFIG['backup_these_directories']
+    else
+      return []
+    end
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/create_and_remove.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/create_and_remove.rb'
+# =========================================================================== #
+module BackupParadise
+
+  require 'fileutils'
+  require 'backup_paradise/toplevel_methods/e.rb'
+  require 'backup_paradise/colours/colours.rb'
+
+  # ========================================================================= #
+  # === BackupParadise.remove_directory
+  # ========================================================================= #
+  def self.remove_directory(i)
+    i = rds(i).strip
+    unless i == '/' # Tiny "safeguard".
+      FileUtils.rm_rf(i) if File.directory?(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === 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.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
+
+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/esystem.rb

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

data/lib/backup_paradise/toplevel_methods/files_and_directories.rb

@@ -0,0 +1,181 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file guarantees to require fileutils, so other .rb files do not
+# have to do so.
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/files_and_directories.rb'
+# =========================================================================== #
+module BackupParadise
+
+  require 'fileutils'
+  require 'backup_paradise/constants/constants.rb'
+  require 'backup_paradise/toplevel_methods/esystem.rb'
+  require 'backup_paradise/toplevel_methods/opnn.rb'
+
+  # ========================================================================= #
+  # === BackupParadise.copy_recursively
+  #
+  # This method can be used to copy the source to the target in a
+  # recursive manner.
+  #  
+  # The third argument to this method, called `be_verbose`, will
+  # feedback what is done, to the user, if it has a value of true.
+  # Symbols such as :be_verbose can be used as an "alias" to true.
+  # If it is set to false, or :be_silent, then no output will be
+  # issued to the user.
+  # ========================================================================= #
+  def self.copy_recursively(
+      this_directory,        # from (also called source)
+      backup_to_this_target, # to   (also called target)
+      be_verbose = :be_verbose
+    )
+    this_directory = this_directory.dup if this_directory.frozen?
+    if this_directory.include? '*'
+      require 'convert_global_env'
+      this_directory = ConvertGlobalEnv[this_directory].dup
+    end
+    this_directory        = rds(this_directory)
+    backup_to_this_target = rds(backup_to_this_target)
+    use_system_cp = use_system_cp?
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    end
+    begin
+      raw_file_check = this_directory.dup.delete('*') # No '*' here.
+      if File.directory?(raw_file_check)
+        if use_system_cp
+          # ================================================================= #
+          # In that case we will simply use system cp.
+          # ================================================================= #
+          esystem "cp --recursive --verbose #{this_directory} #{backup_to_this_target}" 
+        else
+          FileUtils.cp_r(
+            this_directory,
+            backup_to_this_target,
+            verbose: be_verbose
+          )
+        end
+      else
+        e 'No directory exists at the path '+sdir(this_directory)+'.'
+      end
+    rescue Exception => error
+      opnn; e 'An error occurred in the method '+
+              __method__.to_s+'(): '+error.class.to_s
+      pp error
+    end
+  end; self.instance_eval { alias cpr                                copy_recursively } # === BackupParadise.cpr
+       self.instance_eval { alias backup_this_directory_if_it_exists copy_recursively } # === BackupParadise.backup_this_directory_if_it_exists
+
+  # ========================================================================= #
+  # === 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.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.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.change_directory                  (cd tag, chdir tag)
+  #
+  # This should no longer be required.
+  # ========================================================================= #
+  def self.change_directory(i)
+    Dir.chdir(i) if i and File.directory?(i)
+  end; self.instance_eval { alias cd change_directory } # === BackupParadise.cd
+
+  # ========================================================================= #
+  # === BackupParadise.copy_file
+  #
+  # Copy a file with this method consistently.
+  # ========================================================================= #
+  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
+
+end

data/lib/backup_paradise/toplevel_methods/help.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/help.rb'
+# =========================================================================== #
+module BackupParadise
+
+  require 'backup_paradise/toplevel_methods/cliner.rb'
+  require 'backup_paradise/colours/colours.rb'
+
+  # ========================================================================= #
+  # === 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 ::Colours.rev+
+      '  - 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 directories as well.'
+    e
+    e '    Examples for this functionality:'
+    e
+    e sfancy('      rbackup audio')
+    e sfancy('      rbackup data')
+    e
+    e '  - You can also chain together commands.'
+    e
+    e '    Example for chaining together commands:'
+    e
+    e sfancy('      rbackup data_only usb1')
+    e sfancy('      rbackup audio_only usb1')
+    e
+    e '  - You can backup the /Programs directory.'
+    e
+    e '    Issue the following command here:'
+    e
+    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