backup_paradise 1.3.1

data/lib/backup_paradise/base/base.rb

@@ -0,0 +1,502 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/base/base.rb'
+# < ::BackupParadise::Base
+# =========================================================================== #
+module BackupParadise
+
+class Base
+
+  require 'backup_paradise/constants/constants.rb'
+  require 'backup_paradise/project/project.rb'
+  require 'backup_paradise/toplevel_methods/config.rb'
+  require 'backup_paradise/toplevel_methods/e.rb'
+  require 'backup_paradise/toplevel_methods/files_and_directories.rb'
+  require 'backup_paradise/toplevel_methods/misc.rb'
+  require 'backup_paradise/base/colours.rb'
+  require 'backup_paradise/base/namespace.rb'
+  require 'backup_paradise/base/tab.rb'
+
+  # ========================================================================= #
+  # Next, external code is loaded.
+  # ========================================================================= #
+  begin
+    require 'roebe/time/time.rb'
+  rescue LoadError; end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  begin
+    require 'roebe/toplevel_methods/write_what_into.rb'
+  rescue LoadError => error
+    puts 'Please install the roebe-gem ( gem install roebe ).'
+    pp error
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.e
+  # ========================================================================= #
+  def e(i = '')
+    BackupParadise.e(i)
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @use_this_program_to_rename_tabs
+    # ======================================================================= #
+    @use_this_program_to_rename_tabs = nil
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    BackupParadise.rds(i)
+  end
+
+  # ========================================================================= #
+  # === no_such_directory_exists_at
+  # ========================================================================= #
+  def no_such_directory_exists_at(i)
+    e "No such directory exists at `#{sdir(i)}`."
+  end; alias no_directory_at no_such_directory_exists_at # === no_directory_at
+
+  # ========================================================================= #
+  # === no_target_at
+  # ========================================================================= #
+  def no_target_at(i)
+    e "No target at #{sfile(i)} could be found."
+  end
+  
+  # ========================================================================= #
+  # === no_file_exists_at
+  # ========================================================================= #
+  def no_file_exists_at(i)
+    e "No file exists at `#{sfile(i)}`."
+  end
+
+  # ========================================================================= #
+  # === exit_program                                               (exit tag)
+  #
+  # This method should be used when we have to exit from the
+  # backup_paradise project.
+  #
+  # The reason why a separate exit-method has been added is so that we
+  # can change this at a later time possibly, if we wish to do further
+  # checks before exiting.
+  # ========================================================================= #
+  def exit_program(be_verbose = false)
+    if be_verbose
+      e 'Quit was called, thus we exit now.'
+    end
+    if @use_this_program_to_rename_tabs
+     rename_tab(@use_this_program_to_rename_tabs)
+    end
+    exit
+  end
+
+  # ========================================================================= #
+  # === home_dir_of_user_x?
+  #
+  # This method is only relevant on my home system.
+  # ========================================================================= #
+  def home_dir_of_user_x?
+    '/home/x/'
+  end
+
+  # ========================================================================= #
+  # === cliner
+  # ========================================================================= #
+  def cliner
+    BackupParadise.cliner
+  end
+
+  # ========================================================================= #
+  # === delete_symlink
+  # ========================================================================= #
+  def delete_symlink(i)
+    if File.symlink? i
+      File.delete(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') { exit_program }
+  end
+
+  # ========================================================================= #
+  # === rename
+  # ========================================================================= #
+  def rename(a, b)
+    if File.exist? b
+      e "Can not rename to #{sfancy(b)} as that target already exists."
+    else
+      FileUtils.mv(a, b)
+    end
+  end
+
+  # ========================================================================= #
+  # === dd_mm_yyyy
+  #
+  # This method will return a String such as "25.12.2018".
+  # ========================================================================= #
+  def dd_mm_yyyy
+    if Object.const_defined? :Roebe
+      ::Roebe::Time.dd_mm_yyyy # Tap into the Roebe namespace for this.
+    else
+      Time.now.strftime('%d.%m.%Y')
+    end
+  end
+
+  # ========================================================================= #
+  # === return_current_date_and_time
+  #
+  # This method will return a String such as:
+  #
+  #   "24.05.2018-03:48:50"
+  #
+  # ========================================================================= #
+  def return_current_date_and_time
+    "#{dd_mm_yyyy}-#{hh_mm_ss}"
+  end; alias return_full_date return_current_date_and_time # === return_full_date
+       alias date_and_time?   return_current_date_and_time # === date_and_time?
+
+  require 'backup_paradise/toplevel_methods/opnn.rb'
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(i = NAMESPACE)
+    if i.is_a? String
+      i = {
+        namespace: i,
+        use_colours: use_colours?
+      }
+    end
+    BackupParadise.opnn(i)
+  end
+
+  # ========================================================================= #
+  # === esystem
+  # ========================================================================= #
+  def esystem(i)
+    e i
+    system i
+  end
+
+  # ========================================================================= #
+  # === n_files_in?
+  #
+  # This method will return how many files are in the given directory.
+  # ========================================================================= #
+  def n_files_in?(i)
+    _ = 0
+    if File.directory? i
+      _ = Dir["#{i}*"].size
+    end
+    _
+  end
+
+  # ========================================================================= #
+  # === create_directory                                          (mkdir tag)
+  #
+  # The first argument to this method should be the name of the directory
+  # that has to be created, such as 'foobar/'.
+  # ========================================================================= #
+  def create_directory(
+      i, options = { mode_to_use: 0755 }
+    )
+    BackupParadise.create_directory(i, options)
+  end; alias mkdir create_directory # === mkdir
+
+  # ========================================================================= #
+  # === cd_to_the_mounted_device
+  # ========================================================================= #
+  def cd_to_the_mounted_device
+    cd target_mountpoint?
+  end
+
+  # ========================================================================= #
+  # === do_symlink
+  # ========================================================================= #
+  def do_symlink(
+      from_this_target, create_a_symlink_here
+    )
+    if File.exist? create_a_symlink_here
+      no_target_at(create_a_symlink_here)
+    else
+      File.symlink(from_this_target, create_a_symlink_here)
+    end
+  end
+
+  # ========================================================================= #
+  # === delete_files
+  # ========================================================================= #
+  def delete_files(
+      i, be_verbose = false
+    )
+    case be_verbose
+    when :be_verbose
+      be_verbose = true
+    end
+    if i.is_a? Array
+      i.each {|entry| delete_files(entry, be_verbose) }
+    else
+      if File.file? i
+        if be_verbose
+          opnn; e "Now deleting the file `#{sfile(i)}`."
+        end
+        File.delete(i)
+      else
+        e sfancy(i)+' is not not a file - we thus can not delete it.'
+      end
+    end
+  end; alias delete_file        delete_files # === delete_file
+       alias remove_these_files delete_files # === remove_these_files
+
+  # ========================================================================= #
+  # === remove_directory
+  # ========================================================================= #
+  def remove_directory(i)
+    BackupParadise.remove_directory(i)
+  end
+
+  # ========================================================================= #
+  # === copy_file
+  # ========================================================================= #
+  def copy_file(from, to)
+    BackupParadise.copy_file(from, to)
+  end; alias copy_this_file copy_file # === copy_this_file
+
+  # ========================================================================= #
+  # === write_what_into
+  # ========================================================================= #
+  def write_what_into(what, into)
+    ::Roebe.write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === append_what_into
+  # ========================================================================= #
+  def append_what_into(what, into)
+    ::Roebe.append_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === data_directory?
+  # ========================================================================= #
+  def data_directory?
+    DATA_DIRECTORY
+  end; alias data_dir? data_directory? # === data_dir?
+
+  # ========================================================================= #
+  # === size?
+  # ========================================================================= #
+  def size?(i)
+    BackupParadise.size?(i)
+  end
+
+  # ========================================================================= #
+  # === target_mountpoint?
+  #
+  # Designate to which target we will backup.
+  # ========================================================================= #
+  def target_mountpoint?
+    BackupParadise.target_mountpoint?
+  end; alias main_target?              target_mountpoint? # === main_target?
+       alias backup_to_this_directory? target_mountpoint? # === backup_to_this_directory?
+       alias mount_point?              target_mountpoint? # === mount_point?
+       alias mount_target?             target_mountpoint? # === mount_target?
+
+  # ========================================================================= #
+  # === use_system_cp
+  # ========================================================================= #
+  def use_system_cp?
+    ::BackupParadise.use_system_cp?
+  end
+
+  # ========================================================================= #
+  # === hh_mm_ss
+  # ========================================================================= #
+  def hh_mm_ss
+    if Object.const_defined? :Roebe
+      ::Roebe::Time.hh_mm_ss # This will yield something like: "03:53:55"
+    else
+      Time.now.strftime('%H:%M:%S')
+    end
+  end; alias current_time hh_mm_ss # === current_time
+
+  # ========================================================================= #
+  # === has_superuser_abilities?
+  # ========================================================================= #
+  def has_superuser_abilities?
+    Process.uid.zero?
+  end
+
+  # ========================================================================= #
+  # === chdir                                                        (cd tag)
+  #
+  # Change directory via this method here.
+  # ========================================================================= #
+  def chdir(i)
+    BackupParadise.change_directory(i)
+  end; alias cd               chdir # === cd
+       alias change_directory chdir # === change_directory
+
+  # ========================================================================= #
+  # === report_total_size_of
+  #
+  # Use this method to report the total size of a specific directory. We
+  # expect the input to this method thus be a (local) directory.
+  # ========================================================================= #
+  def report_total_size_of(i)
+    size_result = size?(i)
+    kb_size     = (size_result.to_f / 1000.0).round(2)
+    mb_size     = (kb_size.to_f / 1000.0).round(2)
+    gb_size     = (mb_size.to_f / 1000.0).round(2)
+    e "#{rev}Total size of files in bytes at #{sdir(i)}: "\
+      "#{seagreen(size_result)} bytes."
+    e 'This corresponds to '+
+      orangered(kb_size.to_s)+lightcoral(' KB ')+
+      orangered(mb_size.to_s)+lightcoral(' MB ')+
+      orangered(gb_size.to_s)+lightcoral(' GB')+'.'
+  end; alias report_file_size_of report_total_size_of # === report_file_size_of
+
+  # ========================================================================= #
+  # === remove
+  # ========================================================================= #
+  def remove(i)
+    BackupParadise.remove(i)
+  end
+
+  # ========================================================================= #
+  # === remove_file
+  # ========================================================================= #
+  def remove_file(i)
+    File.delete(i) if File.file?(i)
+  end
+
+  # ========================================================================= #
+  # === set_target_mountpoint
+  # ========================================================================= #
+  def set_target_mountpoint(i)
+    i = i.to_s
+    case i
+    when 'chroot'
+      i = '/Depot/Chroot/' unless File.exist?('chroot')
+    # ======================================================================= #
+    # Specify some shortcuts to be used here.
+    # ======================================================================= #
+    when '1',
+         '2',
+         '3',
+         '4',
+         '5',
+         '6',
+         '7',
+         '8',
+         '9',
+         'usb1',
+         'usb2',
+         'usb3',
+         'usb4',
+         'usb5',
+         'usb6',
+         'tousb1',
+         'tousb2',
+         'tousb3',
+         'tousb4',
+         'tousb5'
+      i = i.dup if i.frozen?
+      if BackupParadise.is_this_a_shortcut?(i)
+        i = BackupParadise.return_the_assumed_mountpoint_from_this_input(i)
+      else
+        if i.start_with? 'usb'
+          i.sub!(/^usb/,'')
+        elsif i.start_with? 'to'
+          i.sub!(/^to(-| |_)?usb/,'')
+        end
+        i = "/Mount/USB#{i}/"
+      end
+    end
+    BackupParadise.target_mountpoint = i
+  end; alias set_target_device            set_target_mountpoint # === set_target_device
+       alias set_backup_to_this_directory set_target_mountpoint # === set_backup_to_this_directory
+       alias set_target                   set_target_mountpoint # === set_target
+       alias set_main_target              set_target_mountpoint # === set_main_target
+
+  # ========================================================================= #
+  # === 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 copy_recursively(
+      this_directory,        # from (also called source)
+      backup_to_this_target, # to   (also called target)
+      be_verbose = :be_verbose
+    )
+    ::BackupParadise.copy_recursively(
+      this_directory,
+      backup_to_this_target,
+      be_verbose
+    )
+  end; alias cpr                                copy_recursively # === cpr
+       alias backup_this_directory_if_it_exists copy_recursively # === backup_this_directory_if_it_exists
+
+  # ========================================================================= #
+  # === target_hdd_does_not_have_enough_space_left?
+  # ========================================================================= #
+  def target_hdd_does_not_have_enough_space_left? # FIXME
+    false # for now this is always false. stub
+    # MINIMAL_FILESIZE
+  end
+
+  # ========================================================================= #
+  # === are_we_on_windows?
+  #
+  # Query whether the underlying operating system is windows or whether
+  # it is not.
+  # ========================================================================= #
+  def are_we_on_windows?
+    ::BackupParadise.send(__method__)
+  end
+
+  # ========================================================================= #
+  # === all_important_directories?
+  #
+  # Feedback which directories are the most important ones.
+  # ========================================================================= #
+  def all_important_directories?
+    CONFIG['backup_these_directories'].map {|entry|
+      unless entry.end_with?('/')
+        entry = entry.dup if entry.frozen?
+        entry << '/' # Keep a trailing /; it looks better that way.
+      end
+      entry
+    }
+  end
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    BackupParadise.is_on_roebe?
+  end
+
+end; end

data/lib/backup_paradise/base/colours.rb

@@ -0,0 +1,137 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/base/colours.rb'
+# =========================================================================== #
+module BackupParadise
+
+class Base
+
+  require 'backup_paradise/colours/colours.rb'
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    BackupParadise.use_colours?
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    BackupParadise.simp(i)
+  end
+
+  # ========================================================================= #
+  # === sdir
+  # ========================================================================= #
+  def sdir(i = '')
+    BackupParadise.sdir(i)
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    BackupParadise.sfile(i)
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    BackupParadise.sfancy(i)
+  end
+
+  # ========================================================================= #
+  # === tomato
+  # ========================================================================= #
+  def tomato(i)
+    BackupParadise.tomato(i)
+  end
+
+  # ========================================================================= #
+  # === royalblue
+  # ========================================================================= #
+  def royalblue(i)
+    BackupParadise.royalblue(i)
+  end
+  
+  # ========================================================================= #
+  # === rosybrown
+  # ========================================================================= #
+  def rosybrown(i)
+    if use_colours?
+      return ::Colours.rosybrown(i)
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === seagreen
+  # ========================================================================= #
+  def seagreen(i)
+    if use_colours?
+      return ::Colours.seagreen(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i)
+    if use_colours?
+      return ::Colours.steelblue(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === orangered
+  # ========================================================================= #
+  def orangered(i)
+    if use_colours?
+      return ::Colours.orangered(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === lightcoral
+  # ========================================================================= #
+  def lightcoral(i)
+    if use_colours?
+      return ::Colours.lightcoral(i)
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if Object.const_defined? :Colours
+      Colours.rev
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === print_rev
+  # ========================================================================= #
+  def print_rev
+    print rev
+  end
+
+  # ========================================================================= #
+  # === cyan
+  # ========================================================================= #
+  def cyan
+    Colours::CYAN
+  end
+
+end; end

data/lib/backup_paradise/base/namespace.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/base/namespace.rb'
+# =========================================================================== #
+module BackupParadise
+
+class Base
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+end; end

data/lib/backup_paradise/base/tab.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/base/tab.rb'
+# =========================================================================== #
+module BackupParadise
+
+class Base
+
+  require 'backup_paradise/tab/tab.rb'
+  require 'backup_paradise/toplevel_methods/config.rb'
+
+  # ========================================================================= #
+  # === use_this_program_to_rename_tabs?
+  # ========================================================================= #
+  def use_this_program_to_rename_tabs?
+    BackupParadise.use_this_program_to_rename_tabs?
+  end
+
+  # ========================================================================= #
+  # === rename_tab
+  #
+  # This method can be used to rename the tab of e. g. mrxvt or KDE konsole.
+  # ========================================================================= #
+  def rename_tab(
+      use_this_terminal     = use_this_program_to_rename_tabs?, # or :mrxvt
+      use_this_as_new_title = 'Hello world!'
+    )
+    BackupParadise::Tab.rename_tab(
+      use_this_terminal,
+      use_this_as_new_title
+    )
+  end
+
+  # ========================================================================= #
+  # === tab_title
+  #
+  # This is as above, but uses the default terminal.
+  # ========================================================================= #
+  def tab_title(
+      i = ''
+    )
+    rename_tab(use_this_program_to_rename_tabs?, i)
+  end
+
+end; end