backup_paradise 1.3.1

data/lib/backup_paradise/toplevel_methods/misc.rb

@@ -0,0 +1,153 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/misc.rb'
+# =========================================================================== #
+module BackupParadise
+
+  require 'backup_paradise/toplevel_methods/files_and_directories.rb'
+  require 'backup_paradise/toplevel_methods/mountpoint.rb'
+  require 'backup_paradise/tab/tab.rb'
+
+  require 'backup_paradise/colours/colours.rb'
+  # ========================================================================= #
+  # === report_current_dir
+  #
+  # This method will tell us about the current directory.
+  # ========================================================================= #
+  def self.report_current_dir
+    e "Current location is: #{sdir(Dir.pwd)}"
+  end; self.instance_eval { alias report_pwd               report_current_dir } # === BackupParadise.report_pwd
+       self.instance_eval { alias report_current_directory report_current_dir } # === BackupParadise.report_current_directory
+
+  # ========================================================================= #
+  # === debug                                                     (debug tag)
+  #
+  # This is just "quick" debug output.
+  # ========================================================================= #
+  def debug
+    e
+    e '  Data directory: '+sfancy(data_directory?)
+    e "  Main mount point: #{sfancy(mount_point?.to_s)}"
+    e
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.tab_title
+  # ========================================================================= #
+  def self.tab_title(
+      use_this_title = ''
+    )
+    BackupParadise::Tab.rename_tab(:default, use_this_title)
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.are_we_on_windows?
+  #
+  # Query whether the underlying operating system is windows or whether
+  # it is not.
+  # ========================================================================= #
+  def self.are_we_on_windows?
+    Gem.win_platform?
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.are_we_on_linux?
+  # ========================================================================= #
+  def self.are_we_on_linux?
+    RbConfig::CONFIG['host_os'].include? 'linux'
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.simple_backup
+  #
+  # Use this toplevel-method to backup something individually. This will
+  # deliberately NOT make use of class BackupParadise::Backup, to keep
+  # things as simple as possible in this regard.
+  #
+  # To invoke this method, try any of the following:
+  #
+  #   BackupParadise.simple_backup(:audio, '/Mount/HDD1/')
+  #   BackupParadise.simple_backup(:audio_dir, '/Mount/HDD1/')
+  #   BackupParadise.simple_backup(:system_dir, '/Mount/HDD1/')
+  #   BackupParadise.simple_backup(:audio, :usb1)
+  #
+  # ========================================================================= #
+  def self.simple_backup(
+      this_directory_or_file = '/home/x/songs/',
+      target_location        = '/Mount/USB1/', # '/Mount/HDD1/',
+      be_verbose             = true
+    )
+    if this_directory_or_file.is_a? Array
+      this_directory_or_file.each {|entry|
+        Backup.simple_backup(entry, target_location, be_verbose)
+      }
+    else
+      # ===================================================================== #
+      # First, handle some special Symbols. This must come before rds().
+      # ===================================================================== #
+      case this_directory_or_file
+      # ===================================================================== #
+      # === :audio
+      # ===================================================================== #
+      when :audio,
+           :audio_dir, :songs, :songs_dir, :default,
+           :audio_directory
+        this_directory_or_file = DIRECTORY_CONTAINING_ALL_SONGS
+      # ===================================================================== #
+      # === :pkg_dir
+      # ===================================================================== #
+      when :pkg_dir
+        this_directory_or_file = '/Depot/Packages/'
+      # ===================================================================== #
+      # === :system_dir
+      # ===================================================================== #
+      when :system_dir, :sys_dir
+        this_directory_or_file = '/System/'
+      end
+      this_directory_or_file = rds(this_directory_or_file)
+      if target_location.is_a? Symbol
+        # =================================================================== #
+        # Symbols are treated in a special manner.
+        # =================================================================== #
+        if BackupParadise.is_this_a_shortcut?(target_location.to_s)
+          target_location =
+            BackupParadise.return_the_assumed_mountpoint_from_this_input(target_location.to_s)
+        end
+      end
+      this_directory_or_file = this_directory_or_file.dup if this_directory_or_file.frozen?
+      if this_directory_or_file.end_with?('/.')
+        # =================================================================== #
+        # The next line was added because it was noticed that windows, for
+        # some odd reason, may append a '.' character to a directory.
+        # =================================================================== #
+        this_directory_or_file.chop! # Remove the last char, which is '.' in this case.
+      end
+      target_location = target_location.to_s
+      e "Now backing up directory `#{sdir(this_directory_or_file)}"\
+        "` to `#{sdir(target_location)}`."
+      cpr(
+        this_directory_or_file,
+        target_location,
+        be_verbose
+      )
+      tab_title 'Backing up now ...' unless are_we_on_windows?
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.rds
+  # ========================================================================= #
+  def self.rds(i)
+    i.to_s.squeeze '/'
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/mountpoint.rb

@@ -0,0 +1,188 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/mountpoint.rb'
+# BackupParadise.target_mountpoint=
+# =========================================================================== #
+module BackupParadise
+
+  require 'backup_paradise/toplevel_methods/config.rb'
+
+  # ========================================================================= #
+  # === @target_mountpoint
+  # ========================================================================= #
+  @target_mountpoint = '/Mount/USB1/'
+
+  # ========================================================================= #
+  # === BackupParadise.is_this_a_shortcut?
+  # ========================================================================= #
+  def self.is_this_a_shortcut?(i)
+    returned_value = return_the_assumed_mountpoint_from_this_input(i)
+    # ======================================================================= #
+    # It is a shortcut when we have replaced it.
+    # ======================================================================= #
+    !(returned_value == i)
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.return_the_assumed_mountpoint_from_this_input
+  #
+  # This method will replace e. g. "usb1" with ENV['USB1'] or the 
+  # config-setting. The config setting takes priority over the ENV 
+  # setting.
+  # ========================================================================= #
+  def self.return_the_assumed_mountpoint_from_this_input(i)
+    case i # case tag
+    # ======================================================================= #
+    # === :pwd
+    # ======================================================================= #
+    when 'pwd',
+         :pwd,
+         :""
+      i = Dir.pwd
+    # ======================================================================= #
+    # === :usb1
+    #
+    # Note that nil also defaults to :usb1.
+    # ======================================================================= #
+    when :usb1,
+         :default,
+         'usb1',
+         'usb',
+         'tousb',
+         /^-?-?to(-|_)?usb1/,
+         '1',
+         /^-?-?usb1/,
+         nil
+      if CONFIG and CONFIG.has_key?('usb1')
+        i = CONFIG['usb1'].to_s
+      else
+        i = ENV['USB1']
+      end
+    # ======================================================================= #
+    # === :usb2
+    # ======================================================================= #
+    when :usb2,
+         'usb2',
+         /^-?-?to(-|_)?usb2/,
+         '2',
+         /^-?-?usb2/
+      if CONFIG and CONFIG.has_key?('usb2')
+        i = CONFIG['usb2'].to_s
+      else
+        i = ENV['USB2']
+      end
+    # ======================================================================= #
+    # === :usb3
+    # ======================================================================= #
+    when '3',
+         /^-?-?usb3/,
+         /^-?-?to(-|_)?usb3/,
+         :usb3
+      if CONFIG and CONFIG.has_key?('usb3')
+        i = CONFIG['usb3'].to_s
+      else
+        i = ENV['USB3']
+      end
+    # ======================================================================= #
+    # === :usb4
+    # ======================================================================= #
+    when '4',
+         :usb4,
+         /^-?-?usb4/,
+         /^-?-?to(-|_)?usb4/
+      if CONFIG and CONFIG.has_key?('usb4')
+        i = CONFIG['usb4'].to_s
+      else
+        i = ENV['USB4']
+      end
+    # ======================================================================= #
+    # === :usb5
+    # ======================================================================= #
+    when 'usb5',
+         /^-?-?usb5/,
+         /^-?-?to(-|_)?usb5/,
+         '5',
+         :usb5
+      if CONFIG and CONFIG.has_key?('usb5')
+        i = CONFIG['usb5'].to_s
+      else
+        i = ENV['USB5']
+      end
+    # ======================================================================= #
+    # === :chroot
+    # ======================================================================= #
+    when :chroot,
+         'chroot'
+      i = ENV['CHROOT_TARGET']
+      if i.nil?
+        i = '/Depot/Chroot/' # Hardcoded target in this case.
+      end
+    # ======================================================================= #
+    # === :to_hdd
+    # ======================================================================= #
+    when 'tohd',
+         'hdd1',
+         :to_hdd,
+         /^-?-?to(-|_)?hdd1?/i
+      i = BackupParadise.config?['hdd1'] # ENV['FESTPLATTE1'].to_s.dup
+    # ======================================================================= #
+    # === :to_hdd2
+    # ======================================================================= #
+    when 'hdd2',
+         :to_hdd2,
+         /^-?-?to(-|_)?hdd2/i
+      i = BackupParadise.config?['hdd2'] # ENV['FESTPLATTE1'].to_s.dup
+    end
+    # ======================================================================= #
+    # The input could still be a Symbol, so the next line exists to protect
+    # us against this.
+    # ======================================================================= #
+    i = i.to_s unless i.is_a?(String)
+    if i and File.directory?(i) and !i.end_with?('/')
+      i = i.dup if i.frozen?
+      i << '/' # Ensure a trailing '/'.
+    end
+    return i # Always return it.
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.target_mountpoint=                        (target tag)
+  #
+  # Use this method to determine the main target mountpoint that is
+  # to be used. This must be the base directory, not a subdirectory.
+  #
+  # An example for this, on my home system, would be /Mount/USB1/.
+  # ========================================================================= #
+  def self.target_mountpoint=(i = :usb1)
+    if i.is_a? String
+      i = i.dup if i.frozen?
+      i.squeeze!('/')
+    end
+    if BackupParadise.is_this_a_shortcut?(i)
+      i = return_the_assumed_mountpoint_from_this_input(i)
+    end
+    # ======================================================================= #
+    # Ensure that a trailing '/' is used.
+    # ======================================================================= #
+    unless i.end_with? '/'
+      i = i.dup if i.frozen?
+      i << '/'
+    end
+    @target_mountpoint = i
+  end; self.instance_eval { alias set_mounted_path             target_mountpoint= } # === BackupParadise.set_mounted_path
+       self.instance_eval { alias set_target_device            target_mountpoint= } # === BackupParadise.set_target_device
+       self.instance_eval { alias set_backup_to_this_directory target_mountpoint= } # === BackupParadise.set_backup_to_this_directory
+       self.instance_eval { alias set_target                   target_mountpoint= } # === BackupParadise.set_target
+       self.instance_eval { alias set_target_mountpoint        target_mountpoint= } # === BackupParadise.set_target_mountpoint
+       self.instance_eval { alias set_main_target              target_mountpoint= } # === BackupParadise.set_main_target
+
+  # ========================================================================= #
+  # === BackupParadise.target_mountpoint?
+  # ========================================================================= #
+  def self.target_mountpoint?
+    @target_mountpoint
+  end
+
+end

data/lib/backup_paradise/toplevel_methods/opnn.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/toplevel_methods/opnn.rb'
+# =========================================================================== #
+module BackupParadise
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === BackupParadise.opnn
+  # ========================================================================= #
+  def self.opnn(
+      i = {
+        namespace: NAMESPACE
+      }
+    )
+    if i.is_a? String
+      i = { namespace: i }
+    end
+    Opn.opn(i)
+  end; self.instance_eval { alias opn opnn } # === BackupParadise.opnn
+
+end