backup_paradise 1.2.37

data/lib/backup_paradise/utility_scripts/backup/constants.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/utility_scripts/backup/constants.rb'
+# =========================================================================== #
+require 'backup_paradise/base/base.rb'
+
+module BackupParadise
+
+class Backup < ::BackupParadise::Base
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === MINIMAL_FILESIZE
+  # ========================================================================= #
+  MINIMAL_FILESIZE = 5 * (1000 ** 3) # 5 * 1024 * 1024 * 1024
+
+  # ========================================================================= #
+  # === FILE_BACKUP_LOG
+  #
+  # Denote where to keep the backup.log file, if we log that is.
+  # ========================================================================= #
+  if File.directory? '/home/Temp/' 
+    FILE_BACKUP_LOG = '/home/Temp/backup.log'
+  else
+    FILE_BACKUP_LOG = '/tmp/backup.log'
+  end
+
+end; end

data/lib/backup_paradise/utility_scripts/backup/initialize.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/utility_scripts/backup/initialize.rb'
+# =========================================================================== #
+require 'backup_paradise/base/base.rb'
+
+module BackupParadise
+
+class Backup < ::BackupParadise::Base # === BackupParadise::Backup
+
+  # ========================================================================= #
+  # === initialize
+  #  
+  # Invocation example:
+  #
+  #   x = BackupParadise::Backup.new(nil, :do_not_run_yet)
+  #
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true,
+      &block
+    )
+    register_sigint
+    reset
+    if commandline_arguments
+      if commandline_arguments.is_a?(Symbol)
+        case commandline_arguments
+        # =================================================================== #
+        # === :do_not_run_yet
+        # =================================================================== #
+        when :do_not_run_yet
+          run_already = false
+        end
+      else
+        set_commandline_arguments(
+          commandline_arguments
+        )
+      end
+    end
+    case run_already
+    # ======================================================================= #
+    # === :do_not_run_yet
+    # ======================================================================= #
+    when :do_not_run_yet
+      run_already = false
+    end
+    # ======================================================================= #
+    # === Handle blocks given next
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :do_not_run_yet
+      # ===================================================================== #
+      when :do_not_run_yet
+        run_already = false
+      # ===================================================================== #
+      # === :we_are_on_windows
+      # ===================================================================== #
+      when :we_are_on_windows
+        @internal_hash[:are_we_on_windows] = true
+      end
+    end
+    run if run_already
+  end
+
+end; end

data/lib/backup_paradise/utility_scripts/backup/menu.rb

@@ -0,0 +1,360 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/utility_scripts/backup/menu.rb'
+# =========================================================================== #
+require 'backup_paradise/base/base.rb'
+
+module BackupParadise
+
+class Backup < ::BackupParadise::Base # === BackupParadise::Backup
+
+  require 'backup_paradise/version/version.rb'
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = commandline_arguments?
+    )
+    return if i.nil?
+    # ======================================================================= #
+    # === Handle Hashes
+    #
+    # Note that this is the default entry point.
+    #
+    # An example for how this may be used is given next:
+    #
+    #   BackupParadise::Actions.backup(
+    #     backup_these_directories: i,
+    #     where_to:                 to
+    #   )
+    #
+    # ======================================================================= #
+    if i.is_a? Hash
+      # ===================================================================== #
+      # === :backup_to_this_target
+      #
+      # The next check must come early, on top.
+      # ===================================================================== #
+      # ===================================================================== #
+      # === :where_to
+      # ===================================================================== #
+      if i.has_key? :where_to
+        set_backup_to_this_target(i[:where_to])
+      elsif i.has_key? :backup_to_this_target
+        set_backup_to_this_target(i[:backup_to_this_target])
+      end
+      # ===================================================================== #
+      # === :commandline_arguments
+      # ===================================================================== #
+      if i.has_key? :commandline_arguments
+        menu(i[:commandline_arguments])
+      # ===================================================================== #
+      # === :backup_these_directories
+      # ===================================================================== #
+      elsif i.has_key? :backup_these_directories
+        menu(i[:backup_these_directories])
+      end
+    # ======================================================================= #
+    # === Handle Arrays
+    # ======================================================================= #
+    elsif i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i # case tag
+      # ===================================================================== #
+      # === rbackup --libui
+      # ===================================================================== #
+      when /^-?-?lib-?ui$/i,
+           /^-?-?gui2$/i
+        require 'backup_paradise/gui/libui/backup_for_ingrid/backup_for_ingrid.rb'
+        BackupParadise::GUI::LibUI::BackupForIngrid.new
+        exit
+      # ===================================================================== #
+      # === rbackup --gui
+      #
+      # Alternatively use rbackup --gtk3.
+      # ===================================================================== #
+      when /^-?-?gui$/i,
+           /^-?-?gtk3$/i,
+           /^-?-?gtk$/i,
+           /^-?-?gui1$/i
+        start_the_gtk3_bindings
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --version? 
+      # ===================================================================== #
+      when /^-?-?version\??$/i
+        e BackupParadise::VERSION
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --are-we-on-windows? 
+      # ===================================================================== #
+      when /^-?-?are(-| |_)?we(-| |_)?on(-| |_)?windows\??$/i
+        e rev+'Are we on windows? '+
+          steelblue(are_we_on_windows?.to_s)
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === 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
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --video-dir
+      # ===================================================================== #
+      when /^-?-?video(-| |_)?dir$/i,
+           /^-?-?video(-| |_)?directory$/i,
+           /^-?-?video$/i
+        backup_the_video_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --books
+      #
+      # This entry point allows the user to backup the /home/x/books/
+      # directory.
+      # ===================================================================== #
+      when /^-?-?books$/i,
+           /^-?-?books(-| |_)?directory$/i
+        backup_the_books_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === 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
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --audio-dir
+      #
+      # This entry point can be used to specifically backup the
+      # audio-directory - that is, the local directory that
+      # contains all songs.
+      #
+      # Usage example:
+      #
+      #   rbackup --audio-dir
+      #
+      # 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
+        determine_whether_the_target_harddisc_is_a_ntfs_system
+        backup_the_audio_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === 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 examples:
+      #
+      #   rbackup --chroot
+      #   rbackup --to-chroot
+      #
+      # ===================================================================== #
+      when /^-?-?chroot$/i,
+           /^-?-?to(-| |_)?chroot$/i,
+           /^-?-?into(-| |_)?chroot$/i
+        backup_into_the_default_chroot_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === 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_the_studium_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --data-dir
+      # ===================================================================== #
+      when /^-?-?data(-| |_)?dir$/i,
+           /^-?-?data(-| |_)?directory$/i,
+           /^-?-?data$/i,
+           /^-?-?ONLY(-| |_)?DATA$/i,
+           /^-?-?DATA(-| |_)?ONLY$/i,
+           /^-?-?donly$/i
+        backup_the_data_directory_then_exit
+      # ===================================================================== #
+      # === rbackup --system-dir
+      # ===================================================================== #
+      when /^-?-?system(-| |_)?dir$/i,
+           /^-?-?system(-| |_)?directory$/i,
+           /^-?-?system$/i
+        backup_the_system_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --programs-dir
+      #
+      # This entry point can be used to backup /home/Programs/ specifically.
+      # ===================================================================== #
+      when /^-?-?programs(-| |_)?dir$/i,
+           /^-?-?programs$/i
+        backup_the_programs_directory
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup default
+      # ===================================================================== #
+      when 'default' # Default entry point is for /Mount/USB1 aka :usb1.
+        set_target_mountpoint(:usb1)
+      # ===================================================================== #
+      # === rbackup --mountpoints
+      # ===================================================================== #
+      when /^-?-?mountpoints/
+        show_available_mountpoints_then_exit
+      # ===================================================================== #
+      # === rbackup --logfile
+      # ===================================================================== #
+      when /^-?-?logfile\??$/i
+        show_the_logfile
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === rbackup --show-file-size-of-popular_directories
+      # === rbackup --overview
+      # ===================================================================== #
+      when /^-?-?show(-| |_)?file(-| |_)?size(-| |_)?of(-| |_)?popular(-| |_)?directories$/i,
+           /^-?-?overview$/i
+        use_this_array = [
+          return_the_songs_directory,
+          PROGRAMS_DIRECTORY,
+          VIDEO_DIRECTORY,
+          STUDIUM_DIRECTORY,
+          DATA_DIRECTORY,
+          SOURCE_DIRECTORY
+        ].map {|entry|
+          return_this_absolute_directory(entry)
+        }
+        use_this_array.each {|this_entry|
+          report_file_size_of(this_entry)
+        }
+        do_not_perform_the_regular_backup_routine
+      # ===================================================================== #
+      # === 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(_)
+      # ===================================================================== #
+      # === 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
+      # ===================================================================== #
+      # === rbackup --pwd
+      # ===================================================================== #
+      when /^-?-?pwd$/i
+        current_directory = (Dir.pwd+'/').squeeze('/')
+        set_target_mountpoint(current_directory)
+      # ===================================================================== #
+      # === rbackup --autogenerated
+      # ===================================================================== #
+      when /^-?-?autogen$/,
+           'agen',
+           'autog',
+           /^-?-?autogenerated$/i
+        determine_whether_the_target_harddisc_is_a_ntfs_system
+        try_to_backup_the_autogenerated_directory
+        do_not_perform_the_regular_backup_routine
+      else # else tag
+        # =================================================================== #
+        # === Backup an existing directory
+        #
+        # This entry point allows us to quickly backup an existing
+        # directory.
+        #
+        # Usage example:
+        #
+        #   rbackup /home/x/data/rpg/
+        #
+        # =================================================================== #
+        if File.directory?(i)
+          i = File.absolute_path(i)
+          i << '/' unless i.end_with? '/'
+          new_target = @mountpoint.squeeze('/')
+          cpr(i, new_target)
+          all_done_message
+          do_not_perform_the_regular_backup_routine
+        # =================================================================== #
+        # === Backup individual .h files quickly
+        #
+        # This is a short 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/'
+          verbose_create_a_directory_at_this_position(base_directory) 
+          target = "#{base_directory}#{File.basename(i)}"
+          opnn; e "Backing up towards `#{sfile(target)}` (a mere copy operation)."
+          copy_file(i, target)
+          do_not_perform_the_regular_backup_routine
+        else
+          if i and i.start_with?('--')
+            e "Option #{i} was not found. Exiting now."
+            exit
+          end
+        end
+      end
+    end
+  end
+
+end; end

data/lib/backup_paradise/utility_scripts/backup/run.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/utility_scripts/backup/run.rb'
+# =========================================================================== #
+module BackupParadise
+
+class Backup < ::BackupParadise::Base # === BackupParadise::Backup
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    sanitize_the_commandline_arguments
+    menu
+    do_perform_the_backup_tasks if perform_the_regular_backup_routine?   
+  end
+
+end; end

data/lib/backup_paradise/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/version/version.rb'
+# =========================================================================== #
+module BackupParadise
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.2.37'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '21.05.2022'
+
+end

data/lib/backup_paradise/windows/README.md

@@ -0,0 +1 @@
+This directory may contain code that we will use on windows.

data/lib/backup_paradise/windows/windows.rb

@@ -0,0 +1,101 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/windows/windows.rb'
+# BackupParadise::Windows.backup_ingrid_directory
+# =========================================================================== #
+module BackupParadise
+
+module Windows # === BackupParadise::Windows
+
+  require 'fileutils'
+  require 'backup_paradise/toplevel_methods/misc.rb'
+
+  alias e puts
+
+  # ========================================================================= #
+  # === BackupParadise::Windows.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Windows.return_the_current_time
+  # ========================================================================= #
+  def self.return_the_current_time
+    Time.now.strftime('%d.%m.%Y')
+  end
+
+  # ========================================================================= #
+  # === BackupParadise.do_use_fileutils_for_the_copy_action
+  # ========================================================================= #
+  def self.do_use_fileutils_for_the_copy_action
+    BackupParadise::CONFIG['use_system_cp'] = false
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Windows.backup_ingrid_directory
+  #
+  # This will try to backup c:\\ingrid\. It only works on windows really.
+  #
+  # The trailing '.' is necessary, so that the content of the directory
+  # is copied, rather than the directory itself and THEN its content.
+  # ========================================================================= #
+  def self.backup_ingrid_directory(
+      from = 'c://ingrid/.',
+      to   = :infer_the_first_external_device
+    )
+    case to
+    # ======================================================================= #
+    # === :infer_the_first_external_device
+    #
+    # Here we will infer which external device is the first one.
+    # ======================================================================= #
+    when :infer_the_first_external_device
+      begin
+        require 'mountpoints'
+      rescue LoadError; end
+      if Object.const_defined? :Mountpoints
+        to = Mountpoints[]
+      else # else we will use a hardcoded approach.
+        e 'Assuming a hardcoded path at: e://'
+        to = "e://"
+      end
+    end
+    if to.is_a? Array
+      to = to.first
+    end
+    unless to.include? '_'
+      from = from.to_s.dup
+      from.chop! if from.end_with? '/'
+      if from.start_with?('c://') and BackupParadise.are_we_on_linux?
+        from[0,4] = ''
+      end
+      _ = to.to_s+
+          File.basename(from.to_s.delete('.'))+ # We remove '.' to avoid "ingrid/." stuff.
+          '_'+
+          return_the_current_time
+      _ = _.squeeze '/'
+      e 'Now creating the directory '+_+'.'
+      FileUtils.mkdir_p(_)
+      to = _
+    end
+    if File.directory?(from) and !from.end_with?('/', '.')
+      from = from.dup if from.frozen?
+      from << '/'
+    end
+    if File.directory?(to) and !to.end_with?('/')
+      to = to.dup if to.frozen?
+      to << '/'
+    end
+    do_use_fileutils_for_the_copy_action
+    BackupParadise.simple_backup(from, to)
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  BackupParadise::Windows.backup_ingrid_directory
+end # backupingriddirectory

data/lib/backup_paradise/www/backup.cgi

@@ -0,0 +1,63 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file may also mix non-objectified HTML tags.
+# =========================================================================== #
+# http://localhost/programming/ruby/src/cyberweb/examples/advanced/hybrid_experiment.cgi
+# =========================================================================== #
+require 'cyberweb/requires/require_objectified_html_tags_files.rb'
+require 'cyberweb/requires/require_the_toplevel_methods_files.rb'
+require 'cyberweb/requires/require_the_html_template.rb'
+require 'cyberweb/web_images/map_symbol_to_image_location.rb'
+require 'cyberweb/javascript/drag_and_drop.rb'
+require 'cyberweb/toplevel_methods/jquery.rb'
+require 'backup_paradise'
+
+alias ee print
+
+Cyberweb.require_objectified_html_tags_files
+Cyberweb.require_toplevel_methods_files
+
+include Cyberweb::Objectified::HtmlTags
+include Cyberweb
+
+ee "Content-type: text/html\n\n"
+ee '<html><head>'
+
+Title.report('Backup-related actions')
+ee '<style>'
+ee Cyberweb.return_content_of_all_the_CSS_files
+ee '</style>'
+ee Cyberweb.return_jquery_string
+ee '</head>'
+ee '<body class="mar4px">'
+
+ee Cyberweb.params?
+# =========================================================================== #
+# Hello world div:
+# =========================================================================== #
+ee '<form method="POST" id="backup_form" name="backup_form" class="FS1_5em mars1em mart1em" action="">'
+
+ee 'Backup c:\ingrid\\<br><br>'
+_ = submit_button
+_.name = 'do_backup_for_ingrid'
+_.value = 'Do backup c:\ingrid\\'
+_.bblack2
+_.css_class 'pad8px mar4px mars2em FS1_3em'
+_.style 'border: 3px dotted tomato'
+_.report
+# ee '<img src="../../../../../../../data/images/'+Cyberweb.get_webimage(:backup_image)+'">'
+ee '<input name="do_backup_for_ingrid" type="image" src="../../../../../../../data/images/'+
+    Cyberweb.get_webimage(:backup_image)+'" border="0" alt="Submit"/>'
+
+# <form class="spacer" action="" method="post">
+# <input class="submit" type="submit" value="Submit" />
+# </form>
+
+
+
+ee '</form>'
+
+ee '</body>'
+ee '</html>'