backup_paradise 1.2.13

data/lib/backup_paradise/advanced_backup/do_perform_the_backup_tasks.rb

@@ -0,0 +1,95 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BackupParadise::AdvancedBackup
+#
+# This is the main class that will be used for making a backup, usually
+# onto an external USB device, but optionally also to another (second)
+# harddisc (HDD).
+#
+# Note that we will still store some information on the toplevel namespace
+# where we will backup to.
+#
+# For a listing of specifict options have a look at the file "help.rb", or
+# do "rbackup help" from the commandline.
+#
+# This class will backup a system, usually on an external USB device.
+#
+# Usage examples:
+#
+#   BackupParadise::AdvancedBackup.new(ARGV)
+#
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/do_perform_the_backup_tasks.rb'
+# =========================================================================== #
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base # === BackupParadise::AdvancedBackup
+
+  # ========================================================================= #
+  # === do_perform_the_backup_tasks                                 (all tag)
+  #
+  # This method is the main powerhorse of this class. It connects all the
+  # various steps together, one after the other.
+  # ========================================================================= #
+  def do_perform_the_backup_tasks
+    determine_whether_the_target_harddisc_is_a_ntfs_system
+    determine_the_starting_time
+    create_file_keeping_track_of_when_the_last_backup_happened
+    show_welcome_message
+    rename_tab(:default, 'Backing up some data next.')
+    consider_removing_all_but_one_log_file
+    # ======================================================================= #
+    # The next method will rename entries such as
+    # "last_backup-13.10.2018-21:07:20/" to "backup-13.10.2018-21:07:20/".
+    # This is necessary so that we can only have one such directory
+    # name, after we are done with this method here.
+    # ======================================================================= #
+    consider_renaming_all_old_last_backup_directories
+    # ======================================================================= #
+    # We will next attempt to backup the directory at /AUTOGENERATED/.
+    # ======================================================================= #
+    try_to_backup_the_autogenerated_directory
+    try_to_backup_the_audio_directory
+    # ======================================================================= #
+    # We will also create a log file, to denote when we started to
+    # do this current backup-operation.
+    # ======================================================================= #
+    create_the_log_last_backup_file
+    create_the_directory_containing_the_last_backup
+    create_a_symlink_pointing_to_that_directory_that_was_just_created
+    cd @last_backup_directory
+    # ======================================================================= #
+    # Now we are in the last-backup directory - and we can back up
+    # the following three directories by default (usually "DATA/",
+    # "src/" and "studium/"; also books/ since as of February 2019
+    # and "songs/" since as of December 2019).
+    # ======================================================================= #
+    ARRAY_THE_FIVE_MAIN_ENTRIES.each {|this_directory|
+      if this_directory.include? '/'
+        full_path = this_directory.dup
+      else
+        full_path = "#{HOME_DIRECTORY_OF_THE_USER_X}#{this_directory}/"
+      end
+      rename_tab(:default, "Backing up #{this_directory}.")
+      backup_this_directory_if_it_exists(
+        full_path,
+        rds(@last_backup_directory+this_directory),
+        :do_continue,
+        :do_not_sync
+      )
+    }
+    popup_notification(:backup_complete) if show_popup_notification?
+    do_sync # Synchronize the USB devices here.
+    determine_end_time
+    report_time_difference
+    try_to_unmount_the_device
+    rename_tab(
+      use_this_program_to_rename_tabs?, 'Backup is complete!'
+    )
+    show_backup_complete_message
+  end; alias start_backup      do_perform_the_backup_tasks # === start_backup
+       alias backup_everything do_perform_the_backup_tasks # === backup_everything
+
+end; end

data/lib/backup_paradise/advanced_backup/initialize.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/initialize.rb'
+# =========================================================================== #
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base # === BackupParadise::AdvancedBackup
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # Invocation example:
+  #
+  #   x = BackupParadise::AdvancedBackup.new(nil, :do_not_run_yet)
+  #
+  # ========================================================================= #
+  def initialize(
+      optional_arguments = ARGV,
+      run_already        = true
+    )
+    register_sigint
+    reset
+    set_commandline_arguments(
+      optional_arguments
+    )
+    case run_already
+    # ======================================================================= #
+    # === :do_not_run_yet
+    # ======================================================================= #
+    when :do_not_run_yet
+      run_already = false
+    end
+    run if run_already
+  end
+
+end; end

data/lib/backup_paradise/advanced_backup/menu.rb

@@ -0,0 +1,280 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/menu.rb'
+# =========================================================================== #
+module BackupParadise
+
+class AdvancedBackup < Base # === BackupParadise::AdvancedBackup
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      @perform_backup = true if i.empty? # Have to set this as default in that case.
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === rbackup --pwd
+      # ===================================================================== #
+      when /^-?-?pwd$/i
+        current_directory = (Dir.pwd+'/').squeeze('/')
+        set_target_mountpoint(current_directory)
+        @perform_backup = true
+      # ===================================================================== #
+      # === rbackup --usb1
+      # === rbackup --usb2
+      # ===================================================================== #
+      when /^-?-?usb(\d{1})$/i
+        set_target_mountpoint($1.to_s)
+        @perform_backup = true
+      # ===================================================================== #
+      # === Use a shorter name for the backup-directory
+      #
+      # This entry point has been created to allow simpler backup onto
+      # NTFS devices. I ran into a problem with a too-long, and special
+      # name for a directory.
+      #
+      # Usage example:
+      #
+      #   rbackup --use-shorter-name
+      #   rbackup tousb1 --use-shorter-name
+      #
+      # ===================================================================== #
+      when /^-?-?use(-| |_)?shorter(-| |_)?name$/i,
+           /^-?-?windows$/i,
+           /^-?-?sane-symlink$/i
+        do_use_simplified_directory
+      # ===================================================================== #
+      # === Backup all relevant entries to the chroot-directory
+      #
+      # This entry point is mostly used for my local Chroot directory. We
+      # will quickly backup the important files to that directory, which
+      # then allows us to cd into a better chroot-environment.
+      #
+      # Invocation example:
+      #
+      #   rbackup --chroot
+      #   rbackup --to-chroot
+      #
+      # ===================================================================== #
+      when /^-?-?chroot$/i,
+           /^-?-?to(-| |_)?chroot$/i,
+           /^-?-?into(-| |_)?chroot$/i
+        e
+        e "Setting the target to #{sdir('/Depot/Chroot/')} next."
+        e
+        set_target_device(:chroot) # Set to the above Chroot target.
+        set_main_target(
+          "#{main_target?.dup}#{home_dir_of_user_x?.dup}"
+        )
+        all_important_directories?.each {|this_directory|
+          new_target = main_target?+File.basename(this_directory)
+          backup_this_directory_if_it_exists(
+            this_directory,
+            new_target,
+            :do_not_continue
+          )
+        }
+        e 'All done!'
+      # ===================================================================== #
+      # === rbackup tousb1
+      # ===================================================================== #
+      when /^-?-?to(-| |_)?usb(\d{1,2})$/i # === $2
+        set_target_mountpoint($2.to_s)
+        @perform_backup = true
+      # ===================================================================== #
+      # === rbackup --audio-dir
+      #
+      # This entry point can be used to specifically backup the
+      # audio-directory - that is, the local directory that
+      # contains all songs.
+      #
+      # A more advanced invocation example is:
+      #
+      #   rbackup --backup-to=/opt/ --audio-dir
+      #
+      # ===================================================================== #
+      when /^-?-?audio(-| |_)?dir$/i,
+           /^-?-?audio$/i,
+           /^-?-?aud$/i,
+           /^-?-?audi$/i,
+           /^-?-?aonly$/i,
+           /^-?-?audio(-| |_)?only$/i
+        backup_the_audio_directory
+      # ===================================================================== #
+      # === rbackup --use-this-as-target-for-backup=/opt/
+      # === rbackup --use-this-as-target=/opt/
+      # === rbackup --backup-to=/opt/
+      #
+      # This entry point allows the user to specify another target to
+      # be used from the commandline.
+      # ===================================================================== #
+      when /^-?-?backup(-| |_)?to=(.+)$/i,
+           /^-?-?use(-| |_)?this(-| |_)?as(-| |_)?target=(.+)$/i,
+           /^-?-?use(-| |_)?this(-| |_)?as(-| |_)?target(-| |_)?for(-| |_)?backup=(.+)$/i
+        _ = $2.to_s.dup
+        _ = $4.to_s.dup if $4
+        _ = $6.to_s.dup if $6
+        opnn; e 'The target device will be at '+sfancy(_)+'.'
+        set_target_device(_)
+      # ===================================================================== #
+      # === rbackup --show-file-size-of-popular_directories
+      # === rbackup --overview
+      # ===================================================================== #
+      when /^-?-?show(-| |_)?file(-| |_)?size(-| |_)?of(-| |_)?popular(-| |_)?directories$/i,
+           /^-?-?overview$/i
+        use_this_array = [
+          AUDIO_DIRECTORY,
+          PROGRAMS_DIRECTORY,
+          VIDEO_DIRECTORY
+        ]+ARRAY_THE_THREE_MAIN_ENTRIES.map {|entry|
+          return_this_absolute_directory(entry+'_DIRECTORY')
+        }
+        use_this_array.each {|this_entry|
+          report_file_size_of(this_entry)
+        }
+      # ===================================================================== #
+      # === rbackup --studium-dir
+      # === rbackup --studium-directory
+      # === rbackup --studium
+      #
+      # This entry point allows the user to backup the /home/x/studium/
+      # directory, by making use of the constant  STUDIUM_DIRECTORY.
+      # ===================================================================== #
+      when /^-?-?studium(-| |_)?dir$/i,
+           /^-?-?studium(-| |_)?directory$/i,
+           /^-?-?studium$/i
+        backup_this_directory_if_it_exists(
+          STUDIUM_DIRECTORY, :default, :do_not_continue
+        )
+      # ===================================================================== #
+      # === rbackup --source-dir
+      # === rbackup --source-directory
+      # === rbackup --source
+      # === rbackup --src-dir
+      # === rbackup --src
+      #
+      # This entry point allows the user to backup the /home/x/SRC/
+      # directory.
+      # ===================================================================== #
+      when /^-?-?source(-| |_)?dir$/i,
+           /^-?-?source(-| |_)?directory$/i,
+           /^-?-?source$/i,
+           /^-?-?src(-| |_)?dir$/i,
+           /^-?-?src$/i
+        backup_the_source_directory
+      # ===================================================================== #
+      # === rbackup --autogenerated
+      # ===================================================================== #
+      when 'autogen','agen','autog',
+           /^-?-?autogenerated$/
+        backup_the_autogenerated_directory
+      # ===================================================================== #
+      # === rbackup --video-dir
+      # ===================================================================== #
+      when /^-?-?video(-| |_)?dir$/i,
+           /^-?-?video(-| |_)?directory$/i,
+           /^-?-?video$/i
+        backup_the_video_directory
+      # ===================================================================== #
+      # === advanced_backup --gui
+      # ===================================================================== #
+      when /^-?-?gui$/i
+        do_not_run
+        start_gtk3_gui
+      # ===================================================================== #
+      # === rbackup --data-dir
+      # ===================================================================== #
+      when /^-?-?data(-| |_)?dir$/i,
+           /^-?-?data(-| |_)?directory$/i,
+           /^-?-?data$/i,
+           /^-?-?ONLY(-| |_)?DATA$/i,
+           /^-?-?DATA(-| |_)?ONLY$/i,
+           /^-?-?donly$/i
+        backup_the_data_directory
+      # ===================================================================== #
+      # === rbackup --system-dir
+      # ===================================================================== #
+      when /^-?-?system(-| |_)?dir$/i,
+           /^-?-?system(-| |_)?directory$/i,
+           /^-?-?system$/i
+        backup_the_system_directory
+      # ===================================================================== #
+      # === rbackup --programs-dir
+      # ===================================================================== #
+      when /^-?-?programs(-| |_)?dir$/i,
+           /^-?-?programs$/i
+        backup_the_programs_directory
+      # ===================================================================== #
+      # === rbackup --logfile
+      # ===================================================================== #
+      when /^-?-?logfile\??$/i
+        show_the_logfile
+        exit_program
+      # ===================================================================== #
+      # === advanced_backup default
+      # ===================================================================== #
+      when 'default' # Default entry point is for /Mount/USB1 aka :usb1.
+        set_target_mountpoint(:usb1)
+        @perform_backup = true
+      # ===================================================================== #
+      # === rbackup --mountpoints
+      # ===================================================================== #
+      when /mountpoints/
+        show_available_mountpoints
+      # ===================================================================== #
+      # === rbackup --help
+      #
+      # The user can use this entry point to obtain helpful information in
+      # how to use this class, on the commandline. 
+      # ===================================================================== #
+      when /help/i,
+           /^-?-?show(-| |_)?help$/i,
+           'hel','he','h','?','*'
+        show_help
+      else
+        # =================================================================== #
+        # === Backup an existing directory
+        # =================================================================== #
+        if File.directory?(i)
+          i = File.absolute_path(i)
+          i << '/' unless i.end_with? '/'
+          backup_this_directory_if_it_exists(
+            i, :default, :do_not_continue
+          )
+        # =================================================================== #
+        # === Backup individual .h files quickly
+        #
+        # This is a hort circuit action here - we just backup an existing
+        # .h file quickly.
+        #
+        # Invocation example:
+        #
+        #   rbackup /usr/include/xvid.h
+        #
+        # =================================================================== #
+        elsif File.exist?(i) and i.end_with?('.h')
+          base_directory = '/BACKUP/include/' 
+          target = "#{base_directory}#{File.basename(i)}"
+          opnn; e "Backing up towards `#{sfile(target)}` (a mere copy operation)."
+          copy_file(i, target)
+          exit_program
+        else
+          if i and i.start_with?('--')
+            e 'Option '+i+' was not found. Exiting now.'
+            exit
+          else
+            @perform_backup = true
+          end
+        end
+      end
+    end
+  end
+
+end; end

data/lib/backup_paradise/advanced_backup/misc.rb

@@ -0,0 +1,836 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/misc.rb'
+# =========================================================================== #
+require 'backup_paradise/advanced_backup/constants.rb'
+
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base
+
+  # ========================================================================= #
+  # === backup_the_books_directory                                 (data tag)
+  #
+  # This method will backup the BOOKS directory, e. g. the one that is
+  # at "/home/x/books/" on my home system.
+  # ========================================================================= #
+  def backup_the_books_directory(
+      target_directory = BOOKS_DIRECTORY
+    )
+    if File.directory? target_directory
+      mountpoint_target = main_target?+File.basename(target_directory)
+      cliner
+      e "Now backing up the #{sdir(target_directory)} directory from "\
+        "#{sfancy(target_directory)} into "\
+        "#{sfile(mountpoint_target)}."
+      cliner
+      report_total_size_of(target_directory)
+      unless File.directory? mountpoint_target
+        create_directory(mountpoint_target, 0755)
+      end
+      backup_this_directory_if_it_exists(
+        target_directory, :default, :do_not_continue
+      )
+      rename_tab('.')
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(target_directory)
+    end
+  end; alias backup_only_books_directory backup_the_books_directory # === backup_only_books_directory
+       alias backup_books_directory      backup_the_books_directory # === backup_books_directory
+
+  # ========================================================================= #
+  # === return_default_target_directory_from_this_input
+  # ========================================================================= #
+  def return_default_target_directory_from_this_input(i)
+    rds(
+      main_target?+
+      File.basename(i)+
+      '/'
+    )
+  end
+
+  # ========================================================================= #
+  # === backup_this_directory_if_it_exists
+  #
+  # This method will handle the actual backup-job.
+  #
+  # Note that since as of December 2019, the method will treat all input
+  # as Array - I needed this because sometimes I have to backup only
+  # certain directories, but still want the whole script to run to
+  # completion.
+  #
+  # The second directory is the default target directory.
+  # ========================================================================= #
+  def backup_this_directory_if_it_exists(
+      i                 = :all_of_them,
+      target_dir        = :default, # ← We will copy to this directory.
+      shall_we_continue = :do_continue,
+      shall_we_sync     = true
+    )
+    case i
+    # ======================================================================= #
+    # === :default
+    # ======================================================================= #
+    when :default,
+         :all_of_them,
+         :all_important_directories
+      i = ARRAY_THE_FIVE_MAIN_ENTRIES
+      if main_target? == '/Depot/Chroot/'
+        target_dir = :default_without_additional_modification 
+        # =================================================================== #
+        # In this case we will modify the target a little.
+        # =================================================================== #
+        set_main_target(
+          "#{main_target?.dup}#{home_dir_of_user_x?.dup}"
+        )
+      end
+    end
+    i = [i].flatten.compact
+    i.each {|entry|
+      if File.directory? entry
+        entry = entry.dup if entry.frozen?
+        entry.delete!('-')
+        case target_dir
+        # =================================================================== #
+        # === :default
+        # =================================================================== #
+        when :default
+          target_dir = return_default_target_directory_from_this_input(entry)
+        # =================================================================== #
+        # === :default_without_additional_modification
+        # =================================================================== #
+        when :default_without_additional_modification
+          target_dir = entry.dup
+        end
+        target_dir = target_dir.dup if target_dir.frozen?
+        target_dir << '/' unless target_dir.end_with? '/'
+        # =================================================================== #
+        # === rbackup --VIDEO
+        # =================================================================== #
+        backup_this_directory(entry, target_dir, shall_we_sync)
+        opnn; e "The directory `#{sdir(entry.delete('*'))}` has "\
+                "been backed up"
+        opnn; e "into #{sdir(target_dir)}."
+      end
+      case shall_we_continue
+      # ===================================================================== #
+      # === :do_not_continue
+      # ===================================================================== #
+      when :do_not_continue,
+           :default
+        @perform_backup = false
+      # ===================================================================== #
+      # === :do_continue
+      # ===================================================================== #
+      when :do_continue
+        @perform_backup = true
+      end
+    }
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i)
+    @commandline_arguments = [i].flatten.compact
+  end
+
+  # ========================================================================= #
+  # === use_this_program_to_rename_tabs?
+  # ========================================================================= #
+  def use_this_program_to_rename_tabs?
+    BackupParadise.use_this_program_to_rename_tabs?
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = NAMESPACE)
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    super(i)
+  end
+
+  # ========================================================================= #
+  # === unmount
+  #
+  # Use this to unmount something. Right now, we unmount only the HDD.
+  # ========================================================================= #
+  def unmount(
+      what = :hdd
+    )
+    case what.to_sym
+    when :hdd
+      system "umount -l #{ENV['FIRST_HD']}"
+    end
+  end
+
+  # ========================================================================= #
+  # === return_all_log_files
+  # ========================================================================= #
+  def return_all_log_files(
+      from_where = main_target?
+    )
+    Dir["#{from_where}log_last_backup_*"].select {|entry|
+      File.file? entry # We only want files.
+    }
+  end
+
+  # ========================================================================= #
+  # === consider_creating_a_log_file
+  #
+  # This method will create a .log file.
+  #
+  # It accepts an argument, which should be an Integer or Float, denoting,
+  # in seconds, how long it took to make a backup.
+  # ========================================================================= #
+  def consider_creating_a_log_file(
+      n_seconds
+    )
+    if File.directory? '/Depot/Temp/'
+      n_minutes = (n_seconds.to_f / 60).round(1).to_s
+      what = "#{return_full_date}: Backing up the system took #{n_seconds} "\
+             "seconds (#{n_minutes} minutes).\n"
+      into = FILE_BACKUP_LOG
+      opnn; e "Storing the time it took to backup "\
+              "into the file `#{sfile(into)}`."
+      append_what_into(what, into)
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_the_starting_time
+  # ========================================================================= #
+  def determine_the_starting_time
+    @array_store_times << Time.now
+  end; alias determine_starting_time determine_the_starting_time # === determine_starting_time
+
+  # ========================================================================= #
+  # === determine_end_time
+  # ========================================================================= #
+  def determine_end_time
+    @array_store_times << Time.now
+  end
+
+  # ========================================================================= #
+  # === show_popup_notification?
+  # ========================================================================= #
+  def show_popup_notification?
+    @show_popup_notification
+  end
+
+  # ========================================================================= #
+  # === do_show_popup
+  # ========================================================================= #
+  def do_show_popup
+    @show_popup_notification = true
+  end; alias show_popup do_show_popup # === show_popup
+
+  # ========================================================================= #
+  # === popup_notification
+  #
+  # Use this method to send a graphical popup to the user. Only invoke
+  # it when we set @show_popup_notification to true.
+  # ========================================================================= #
+  def popup_notification(
+      what = :backup_complete
+    )
+    case what
+    when :backup_complete
+      esystem 'xmessage -center Backup finished!'
+    end
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    e i
+    system i
+  end
+
+  # ========================================================================= #
+  # === create_file_keeping_track_of_when_the_last_backup_happened
+  #
+  # This method will store date-information into a file, when the last
+  # backup happened.
+  #
+  # It is normally found in a place such as:
+  #
+  #    /home/x/DATA/LAST_BACKUP.md
+  #
+  # Since Dec 2012, we will also append the date to the name of said file.
+  # ========================================================================= #
+  def create_file_keeping_track_of_when_the_last_backup_happened
+    base_target = "#{data_directory?}LAST_BACKUP"
+    target = "#{base_target}_#{@date}.md" # Append the date here.
+    e N+'Storing '+sfile(@use_this_as_timestamp)+' into '+sfile(target)+' to note'
+    e 'down when we did our last backup.'
+    write_what_into(@use_this_as_timestamp, target)
+    # ======================================================================= #
+    # Next, obtain an array with potential similar names. We will have
+    # to delete stray entries so as to not clutter our original home
+    # directory there.
+    # ======================================================================= #
+    array_all_last_backup_files = Dir["#{base_target}*"]
+    if array_all_last_backup_files.size > 1
+      array_all_last_backup_files = array_all_last_backup_files.sort_by {|d|
+        d.split('.').reverse
+      } # Keep it sorted.
+      e N+'We found more than one entry in '+
+        sdir(File.dirname(base_target)+'/')+', thus removing'
+      e 'the extra-entries next.'
+      array_all_last_backup_files[0..-2].each {|my_file|
+        e "Removing `#{sfile(my_file)}` next."
+        remove(my_file)
+      }
+    end
+  end; alias store_when_was_the_last_backup create_file_keeping_track_of_when_the_last_backup_happened # === store_when_was_the_last_backup
+
+  # ========================================================================= #
+  # === try_to_unmount_the_device
+  #
+  # This method can be used to automatically unmount the target device
+  # again.
+  # ========================================================================= #
+  def try_to_unmount_the_device
+    this_is_the_mounted_device = backup_to_this_directory?
+    # ======================================================================= #
+    # Change directory to another directory where we can safely
+    # umount the directory.
+    # ======================================================================= #
+    if has_superuser_abilities?
+      if File.directory? '/Depot/j/'
+        cd '/Depot/j/'
+      elsif File.directory? '/tmp'
+        cd '/tmp'
+      elsif File.directory? '/home/Temp'
+        cd '/home/Temp'
+      else
+        cd '/'
+      end
+      opnn; e "Next unmounting the device at "\
+              "`#{sfancy(this_is_the_mounted_device)}`."
+      system "umount #{this_is_the_mounted_device}"
+    end
+  end
+
+  # ========================================================================= #
+  # === backup_src_directory                                        (src tag)
+  #
+  # This method will backup the SRC/ directory, aka "/home/x/src/". It
+  # is evidently geared towards the system at my home setup.
+  #
+  # To invoke this method from the commandline, try:
+  #
+  #   rbackup --src-dir
+  #
+  # ========================================================================= #
+  def backup_the_source_directory(
+      target_directory = SOURCE_DIRECTORY
+    )
+    if File.directory? target_directory
+      rename_tab(:default, 'Backing up the '+target_directory+' directory.')
+      cliner
+      e 'Now backing up the src/ directory from '+
+         sfancy(target_directory)+' into '+
+         sfile(main_target?+File.basename(target_directory))
+      cliner
+      report_total_size_of(target_directory)
+      backup_this_directory_if_it_exists(
+        target_directory, :default, :do_not_continue
+      )
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(target_directory)
+    end
+  end
+
+  # ========================================================================= #
+  # === show_the_logfile
+  #
+  # To invoke this method from the commandline, try:
+  #
+  #   advanced_backup --logfile?
+  #
+  # ========================================================================= #
+  def show_the_logfile
+    _ = FILE_BACKUP_LOG
+    if File.exist? _
+      opnn; e "Now reading the dataset from the file `#{sfile(_)}`:"
+      e
+      File.readlines(_).each {|line|
+        e orangered("  #{line.chomp}")
+      }
+      e
+    else
+      opnn; e no_file_exists_at(_)
+    end
+  end
+
+  # ========================================================================= #
+  # === return_this_absolute_directory
+  # ========================================================================= #
+  def return_this_absolute_directory(i)
+    i = case i
+    when 'DATA_DIRECTORY'
+      DATA_DIRECTORY
+    # ======================================================================= #
+    # === SRC_DIRECTORY
+    # ======================================================================= #
+    when 'SRC_DIRECTORY','SOURCE_DIRECTORY'
+      SOURCE_DIRECTORY
+    when 'STUDIUM_DIRECTORY'
+      STUDIUM_DIRECTORY
+    else
+      i
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === backup_the_programs_directory
+  #  
+  # This method can be used to backup the /Programs directory.
+  # ========================================================================= #
+  def backup_the_programs_directory(
+      target_directory = PROGRAMS_DIRECTORY
+    )
+    if File.directory? target_directory
+      cliner
+      e 'Now backing up the Programs/ directory from '+
+         sfancy(target_directory)+' into '+
+         sfile(main_target?+File.basename(target_directory))
+      cliner
+      report_total_size_of(target_directory)
+      if target_hdd_does_not_have_enough_space_left?
+        opnn; e "We have to skip backing up #{sdir(target_directory)}"
+        opnn; e 'as it does not have enough space left (Threshold: '+
+                 MINIMAL_FILESIZE+' bytes)' 
+      else    
+        backup_this_directory_if_it_exists(
+          target_directory, :default, :do_not_continue
+        )
+      end
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(target_directory)
+    end
+  end
+
+  # ========================================================================= #
+  # === can_not_backup_this_directory_as_it_does_not_exist
+  # ========================================================================= #
+  def can_not_backup_this_directory_as_it_does_not_exist(i)
+    opnn; e "Can not backup the directory at #{sdir(i)}"
+    opnn; e 'as it does not exist.'
+  end
+
+  # ========================================================================= #
+  # === start_gtk3_gui
+  #
+  # To invoke this method, try:
+  #
+  #   advanced_backup --gui
+  #
+  # ========================================================================= #
+  def start_gtk3_gui
+    require 'backup_paradise/gui/gtk3/backup.rb'
+    __BackupParadise::AdvancedBackup::GUI::Gtk::BackupWidget.new
+  end
+
+  # ========================================================================= #
+  # === backup_the_video_directory
+  # ========================================================================= #
+  def backup_the_video_directory(
+      target_directory = VIDEO_DIRECTORY
+    )
+    if File.directory? target_directory
+      cliner
+      e 'Now backing up the Video directory from '+
+         sfancy(target_directory)+' into '+
+         sfile(main_target?+File.basename(target_directory))
+      cliner
+      report_total_size_of(target_directory)
+      backup_this_directory_if_it_exists(
+        target_directory, :default, :do_not_continue
+      )
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(target_directory)
+    end
+  end
+
+  # ========================================================================= #
+  # === try_to_backup_the_autogenerated_directory
+  # ========================================================================= #
+  def try_to_backup_the_autogenerated_directory(
+      i = AUTOGENERATED_DIRECTORY
+    )
+    if File.directory? i
+      _ = target_mountpoint?+File.basename(i)
+      _ = _.dup if _.frozen?
+      _ << '/' unless _.end_with? '/'
+      opnn; e 'Now trying to backup the AUTOGENERATED directory at `'+sdir(i)+'`.'
+      opnn; e "The target for this will be at `#{sdir(_)}`."
+      n_gigabytes = BackupParadise.size_in_gigabytes?(i).to_s
+      opnn; e 'This directory has a total of '+
+              sfancy(n_files_in?(i).to_s)+' entries '\
+              '(Total size: '+n_gigabytes+' GB).'
+      unless File.directory? _
+        verbose_create_a_directory_at_this_position(_)
+      end
+      rename_tab(:default, 'Backing up the AUTOGENERATED directory.')
+      unless i.end_with? '*'
+        i = i.dup if i.frozen?
+        i << '*'
+      end
+      copy_recursively(i, _)
+      opnn; e "Finished backing up the "\
+              "directory #{sdir(i.delete('*'))} into #{sdir(_)}."
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(i)
+    end
+  end; alias backup_autogenerated_directory     try_to_backup_the_autogenerated_directory # === backup_autogenerated_directory
+       alias backup_the_autogenerated_directory try_to_backup_the_autogenerated_directory # === backup_the_autogenerated_directory
+
+  # ========================================================================= #
+  # === consider_renaming_all_old_last_backup_directories
+  #
+  # This will rename all "last_directory*" directory entries to their
+  # corresponding equivalent without the leading 'last_' string.
+  # ========================================================================= #
+  def consider_renaming_all_old_last_backup_directories
+    # ======================================================================= #
+    # First grab all possible entries, and check that these are all existing
+    # directories. If there is at the least one entry we will continue to
+    # operate on it.
+    # ======================================================================= #
+    all_possible_entries = Dir["#{mount_target?}last_backup-*"].select {|entry|
+      File.directory?(entry)
+    }
+    if all_possible_entries.size > 0
+      # ===================================================================== #
+      # Batch-rename these directories in that case:
+      # ===================================================================== #
+      all_possible_entries.each {|this_directory|
+        new_name_of_the_new_target_directory = this_directory.sub(/^last_/,'')
+        opnn; e "Now renaming `#{sdir(this_directory)}` "\
+                "to `#{sdir(new_name_of_the_new_target_directory)}`."
+        rename(this_directory, new_name_of_the_new_target_directory)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === report_time_difference
+  #
+  # This method will report to the user how long it took this class
+  # to backup the system.
+  # ========================================================================= #
+  def report_time_difference
+    if @array_store_times.size > 1
+      start_time = @array_store_times[-2]
+      end_time   = @array_store_times.last
+      time_difference = end_time - start_time # This will result in a Float.
+      if time_difference.respond_to? :round
+        time_difference = time_difference.round(3)
+      end
+      n_minutes = (time_difference.to_f / 60.0).round(2).to_s
+      opnn; e "#{tomato('Time required')} for this backup-operation: "\
+              "#{sfancy(time_difference.to_s)}"\
+              " seconds (#{royalblue(n_minutes)} minutes)."
+      consider_creating_a_log_file(time_difference)
+    end
+  end
+
+  # ========================================================================= #
+  # === show_backup_complete_message
+  # ========================================================================= #
+  def show_backup_complete_message
+    e "#{cyan}Backup complete!#{rev}"
+  end
+
+  # ========================================================================= #
+  # === verbose_create_a_directory_at_this_position
+  #
+  # The first argument to this method should be the target directory,
+  # a path, that is where you wish to create that directory.
+  #
+  # The second argument to this method, which is optional, denotes the
+  # permission that is to be used.
+  # ========================================================================= #
+  def verbose_create_a_directory_at_this_position(
+      this_position, use_this_permission = 0754
+    )
+    e "Creating a directory at `#{sdir(this_position)}` next."
+    mkdir(this_position, use_this_permission)
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === show_available_mountpoints
+  #
+  # This helper-method can show the available mountpoints, at the least
+  # on a linux system.
+  #
+  # To invoke this, try:
+  #
+  #   AdvancedBackup --mountpoints
+  #
+  # ========================================================================= #
+  def show_available_mountpoints
+    begin
+      require 'mountpoints'
+    rescue LoadError; end
+    if Mountpoints.is_any_mountpoint_available?
+      opnn; e 'The available (and mounted) USB devices are:'
+      e
+      Mountpoints[].each {|this_usb_device|
+        e "  #{sfancy(this_usb_device)}"
+      }
+      e
+    else
+      opnn; e 'No external USB devices appear to be mounted.'
+    end
+  end
+    
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    BackupParadise.use_colours?
+  end
+
+  # ========================================================================= #
+  # === determine_the_target_mountpoint
+  #
+  # This method will determine the target base mountpoint that
+  # is to be used.
+  # ========================================================================= # 
+  def determine_the_target_mountpoint(
+      i = '/Mount/USB1/'
+    )
+    BackupParadise.target_mountpoint = i
+  end
+
+  # ========================================================================= #
+  # === report_todays_date
+  # ========================================================================= #
+  def report_todays_date
+    e "Today is the #{sfancy(@date)}."
+  end
+
+  # ========================================================================= #
+  # === create_the_directory_containing_the_last_backup
+  # ========================================================================= #
+  def create_the_directory_containing_the_last_backup
+    target = main_target?+'backup-'+@use_this_as_timestamp
+    # ======================================================================= #
+    # Next, create the last_backup directory:
+    # ======================================================================= #
+    begin
+      mkdir(target, 0755)
+    rescue Errno::EINVAL
+      target.tr!(':','_')
+      mkdir(target, 0755)
+    end
+    @last_backup_directory = rds(target+'/')
+    opnn; e "Creating a directory at `#{sdir(@last_backup_directory)}`."
+  end
+
+  # ========================================================================= #
+  # === set_last_backup_directory
+  # ========================================================================= #
+  def set_last_backup_directory(i)
+    @last_backup_directory = i
+  end
+
+  # ========================================================================= #
+  # === consider_removing_all_but_one_log_file
+  # ========================================================================= #
+  def consider_removing_all_but_one_log_file
+    log_files = return_all_log_files
+    if log_files.size > 1
+      opnn; e 'More than one log file has been found. We will delete'
+      opnn; e 'all but one next.'
+      log_files.pop
+      delete_files(log_files, :be_verbose)
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_log_last_backup_file                             (log tag)
+  #
+  # We also have to remove all prior log files should they exist.
+  # ========================================================================= #
+  def create_the_log_last_backup_file
+    _ = return_all_log_files
+    unless _.empty?
+      # ===================================================================== #
+      # Remove all old log files next.
+      # ===================================================================== #
+      remove_these_files(_)
+    end
+    target = main_target?+'log_last_backup_'+@use_this_as_timestamp
+    what = dd_mm_yyyy
+    opnn; e "Keeping a backup file (a log) at `#{sfile(target)}`."
+    write_what_into(what, target)
+  end; alias create_log_file create_the_log_last_backup_file
+
+  # ========================================================================= #
+  # === create_a_symlink_pointing_to_that_directory_that_was_just_created
+  #
+  # This method will create a symlink to the last_backup/ directory.
+  #
+  # This is synonymous to the following ruby code:
+  #
+  #   File.symlink('last_backup-13.08.2018-22:12:26/','last_backup')
+  #
+  # ========================================================================= #
+  def create_a_symlink_pointing_to_that_directory_that_was_just_created
+    cd_to_the_mounted_device
+    create_a_symlink_here = "#{backup_to_this_directory?}last_backup"
+    from_this_target = File.basename(@last_backup_directory)
+    from_this_target.chop! if from_this_target.end_with? '/'
+    # ========================================================================= #
+    # First, delete the old symlink if it exists. The method delete_symlink()
+    # will do that check for us.
+    # ========================================================================= #
+    delete_symlink(create_a_symlink_here)
+    # ========================================================================= #
+    # The next action can fail on e. g. vfat filesystems, with the error
+    # being Errno::EPERM. Hence we must rescue here.
+    # ========================================================================= #
+    begin
+      do_symlink(from_this_target, create_a_symlink_here)
+      if File.exist? create_a_symlink_here
+        points_towards = File.readlink(create_a_symlink_here)
+        opnn; e 'Next setting a symlink at `'+sfancy(create_a_symlink_here)+
+                '` pointing'
+        opnn; e "towards `#{sfile(points_towards)}`."
+      else
+        opnn; e no_file_exists_at(create_a_symlink_here)
+      end
+    rescue Errno::EPERM
+    end
+  end; alias create_symlink_to_last_backup_directory create_a_symlink_pointing_to_that_directory_that_was_just_created # === create_symlink_to_last_backup_directory
+
+  # ========================================================================= #
+  # === show_welcome_message
+  # ========================================================================= #
+  def show_welcome_message
+    cliner
+    e "Welcome to project #{lightcoral('BackupParadise')}!"
+    report_todays_date
+    cliner
+    e "Starting to backup into the target at `#{sdir(main_target?)}`."
+    cliner
+  end
+
+  # ========================================================================= #
+  # === backup_this_directory
+  #
+  # This method will quickly backup a given directory.
+  #
+  # The second argument will be the target-directory onto which
+  # we will copy our files.
+  # ========================================================================= #
+  def backup_this_directory(
+      i,
+      copy_to_this_target_directory = nil,
+      shall_we_sync = true
+    )
+    case shall_we_sync
+    when :do_not_sync
+      shall_we_sync = false
+    end
+    case copy_to_this_target_directory
+    when nil,
+         :default
+      copy_to_this_target_directory = return_default_target_directory_from_this_input(i)
+    end
+    unless File.directory? copy_to_this_target_directory
+      mkdir(copy_to_this_target_directory)
+    end
+    cd copy_to_this_target_directory
+    opnn; e 'Now copying '+sdir(i)+
+            ' to '+sdir(copy_to_this_target_directory)+'.'
+    if File.directory?(i)
+      i << '*'
+    end
+    cpr(
+      i, copy_to_this_target_directory
+    )
+    do_sync if shall_we_sync
+  end
+
+  # ========================================================================= #
+  # === do_sync
+  #
+  # The do_sync() method, also aliased towards synchronize(), will sync
+  # the data onto USB items, by using the sync command.
+  # ========================================================================= #
+  def do_sync
+    opnn; e 'Starting to '+steelblue('sync data')+' ...'
+    system 'sync' # Be silent since May 2014.
+    opnn; e "> Syncing finished. (At: "\
+            "#{rosybrown(return_current_date_and_time.to_s)})"
+  end; alias synchronize do_sync # === synchronize
+
+  # ========================================================================= #
+  # === determine_whether_the_target_harddisc_is_a_ntfs_system
+  # ========================================================================= #
+  def determine_whether_the_target_harddisc_is_a_ntfs_system
+    if is_target_harddisc_a_ntfs_system?
+      do_use_simplified_directory
+    end
+  end
+
+  # ========================================================================= #
+  # === do_use_simplified_directory
+  # ========================================================================= #
+  def do_use_simplified_directory
+    set_last_backup_directory(
+      mount_point?+'last_backup'
+    )
+  end
+
+  # ========================================================================= #
+  # === is_target_harddisc_a_ntfs_system?
+  #
+  # This method will return a boolean - true or false.
+  #
+  # It will return true if the target harddisc is a NTFS system, and false
+  # otherwise.
+  # ========================================================================= #
+  def is_target_harddisc_a_ntfs_system?
+    return_value = false
+    _ = '/Mount'
+    if mount_target?.include? _
+      # ===================================================================== #
+      # Next, determine what is mounted.
+      # ===================================================================== #
+      these_may_be_mounted = `df -T -ah`.split(N).select {|line| line.include? _ }
+      if these_may_be_mounted and these_may_be_mounted.first and
+        these_may_be_mounted.first.include?('fuseblk') # This may mean a NTFS system.
+        return_value = true
+      end
+    end
+    return return_value
+  end
+
+  # ========================================================================= #
+  # === show_help
+  # ========================================================================= #
+  def show_help
+    BackupParadise.show_help
+  end; alias display_help show_help # === display_help
+
+end; end