backup_paradise 1.2.13

data/doc/TODO.md

@@ -0,0 +1,221 @@
+...........................................................................
+
+- AdvancedBackup won't have GTK code. But we will still
+  maintain the GTK Bindings somewhere.
+
+    bl $RUBY_GTK/TOOLS/gtk2_backup_wrapper.rb
+
+  Ok, we do this as part of the backup project since Nov 2013.
+  Also document this!
+
+...........................................................................
+- If log_last_backup already exists AND also 
+  last_backup exists, then we automatically rename.
+  Then we can continue.
+
+...........................................................................
+
+- Test this project on windows as well. If it works there,
+  we can eliminate this point.
+
+...........................................................................
+- Consider allowing the following:
+
+backup :audio_dir, :pkg_dir, :system_dir
+
+And multiple arguments.
+
+  attr_writer :target_device
+  
+  def initialize(show_info = true, invoke_dcop = true)
+    e N+'Init Backup to Second HDD or external USB Device now.' if show_info
+    @target_device = ENV['USB1'] # stores for example /Mount/USB1
+    @mount_to = @target_device.dup # isnt that the same?
+    # Is default
+    @dir_name = 'last_backup' # will contain name of our dir to create
+    @which_device_entry = '' # zb /dev/sda1
+  end
+
+  # ========================================================================= #
+  # === report_and_mount_to
+  #
+  # Wrapper. What to do if there are multiple device entries found? Then 
+  # we use the last one. @mount_to tells us where to mount our partition.
+  # ========================================================================= #
+  def report_and_mount_to(number, usb_device)
+    @which_device_entry = usb_device
+    @mount_to = ENV['USB'+number]
+    e "Found usb#{number} string pointing to "+
+    "#{@which_device_entry} -> #{@mount_to}",CI
+  end
+
+  # ========================================================================= #
+  # === decide_what_and_where_to_mount
+  #    rbackup no-mount
+  # dann wird nit gemounted. 
+  # Expects two arguments. The second argument is the check for a 
+  # case menu. The first specifies where to mount it.
+  # ========================================================================= #
+  def decide_what_and_where_to_mount(mount_to = @mount_to, case_argument = '')
+    mount_to = @mount_to if mount_to.nil? # safe check
+    case case_argument
+    when 'no-mount','nomount' # passthru
+    
+      e 'Backing up to '+mount_to,CFANCY
+      e 'Set new target to '+mount_to, CII
+      @target_device = mount_to
+    else # default, will mount to USB entry.
+      e "Mounting to #{mount_to}",CII
+      mount_device(mount_to)
+    end
+  end
+
+  # ========================================================================= #
+  # === mount_device
+  #
+  # Normal usage is to call this from: 
+  #   scan_for_usb_entries
+  # ========================================================================= #
+  def mount_device(which_one = ENV['USB1'])
+    @target_device = which_one
+    e "Now mounting device #{@which_device_entry} "+
+    "to #{@target_device}", CII
+    tmp = "mount #{@which_device_entry} #{@target_device}"
+    system(tmp)
+    @date # zeigt einfach nur das aktuelle datum an
+  end
+ 
+  # ========================================================================= #
+  # === pre_backup_process
+  # This method is invoked at start of backup_system()
+  # What is this method doing?
+  # It does these things in the following order:
+  #   (a) renames last_backup dir to backup_DAY.MONTH.YEAR
+  #   (b) Deletes log_last_backup file (which contains time of last update)
+  #   (c) Deletes already existing backup dirs before it continues.
+  #   (d) Creates directories.
+  #
+  # base_dir signifies the absolute target. 
+  # You are in /Mount/USB1 when this method is started.
+  # ========================================================================= #
+  def pre_backup_process(base_dir = @target_device)
+    # rename last_backup if it exists 
+    if File.exist? base_dir+'/log_last_backup_'+@date
+      _ = File.read(base_dir+'/log_last_backup_'+@date).chomp # _ is nun zb "05.11.2007"
+      # What if it already exists? Then we delete the old file first.
+      #   We will NOT do this silently!
+      to_rename = base_dir+'/'+@dir_name
+      to_new_rename = base_dir+'/backup_'+_
+      string = 'Renaming '+to_rename+' to '+to_new_rename
+      e N+string,CII
+      puts
+      # must begin/rescue it because it could be read-only file system
+      if File.exist? to_rename
+        File.rename(to_rename, to_new_rename) # old_name, new_name
+      else
+        e to_rename+' does not exist.', CWARN
+      end 
+      # rescue Exception => e
+      # e 'Exception occured!!! '+e, CWARN
+    else # puts 'DOES NOT EXIST!!! '+Dir.pwd
+    end
+    if File.exist? base_dir+'/log_last_backup_'+@date
+      e 'We delete the file: '+base_dir+'/log_last_backup_'+@date,CWARN
+      remove(base_dir+'/log_last_backup_'+@date)
+    end
+    e "Changing into this dir: #{_}"
+    change_directory(_)
+    write_last_backup
+  end
+  
+  # ========================================================================= #
+  # === backup_system
+  #
+  # backup_system() to backup your system. This method is the actual working 
+  # dog of this script. It accepts one main argument, a symbol, which
+  # defaults to nogtk to avoid using gtk, and which also can use tohdd
+  # to only backup to my (2nd) harddrive.
+  #
+  # The mode argument should be either one of these:
+  #   :nogtk
+  #   :tohdd
+  #   :tousb
+  #   :data_only # this also assumes :tousb
+  # ========================================================================= #
+  def backup_system(mode = :nogtk, sleep_for_this_time = 0)
+    pre_backup_process() # all processes before starting backuping
+    # Now splitting towards mode content 
+    case mode.to_sym
+    # dont use  gtk
+    when :nogtk
+      report_backup_process_to('USB device')
+      my_sys_cmd = 'cp -vr /Users/x/* .'
+      sys(my_sys_cmd)
+      synchronize
+      
+    # Because my hdd is so slow, we nice the process
+    # on -19. Not very important.
+    when :tohdd, :festplatte, :hdd
+      report_backup_process_to('second HDD')
+      my_sys_cmd='nice -19 cp -vr /Users/x/* .'
+      e(my_sys_cmd)
+      sleep(sleep_for_this_time) # sleeping so that user gets a chance to view the command.
+      sys(my_sys_cmd)
+      backup :audio_dir, :pkg_dir, :system_dir
+    when :data_only, :dataonly, :data, :donly, :onlydata
+      report_backup_process_to('Data only (default into USB)')
+      my_sys_cmd='nice -19 cp -vr /Users/x/DATA/* .'
+      e(my_sys_cmd)
+      sleep(sleep_for_this_time) # sleeping so that user gets a chance to view the command.
+      sys(my_sys_cmd)
+    # tousb backup
+    when :tousb, :tousb1, :tousb2, :tousb3, :tousb4
+      report_backup_process_to('USB Removable media')
+      my_sys_cmd = 'nice -19 cp -vr /Users/x/* .'
+      e(my_sys_cmd)
+      sleep(sleep_for_this_time) # sleeping so that user gets a chance to view the command.
+      pp Dir['*']
+      sys(my_sys_cmd)
+      backup :audio_dir, :pkg_dir, :system_dir
+      synchronize # must sync
+    # else. Nah, there are no "unhandled cases".
+    end
+  end
+  
+  # ========================================================================= #
+  # === change_to_device_and_start_backup
+  #
+  # Here we change to the Mount point in question.
+  # Also, this method invokes backup_system, which does the 
+  # actual backup. Thus you must first ensure that you are in the 
+  # correct base directory, before invoking backup_system.
+  # ========================================================================= #
+  def change_to_device_and_start_backup(which_mode = @array_argv[0])
+    if Dir.pwd.include? ENV['MY_MOUNT']
+      # Prepend the string 'backup_'
+      @dir_name = 'last_backup' # name for our backup dir. Normally sets to: last_backup
+      # which_mode decides what to do. default is in else
+      # The second arg to backup_system means sleep_for_n_seconds
+      case which_mode.to_s
+      when 'no-gtk','nogtk' 
+        backup_system()
+      when 'to-hdd','tohdd','tohdd1'
+        backup_system(:tohdd,  2)
+        unmount :hdd # since 17.06.2008 we unmount the hdd too
+      when 'tousb','tousb1','1'
+        backup_system(:tousb1, 2)
+      when 'tousb2','2'
+        backup_system(:tousb2, 2)
+      when 'tousb3','usb3','3'
+        backup_system(:tousb3, 2)
+      when 'data_only', 'dataonly', 'data', 'donly', 'onlydata'
+        backup_system(:data_only, 2) 
+      end
+    end
+  end
+  
+USB_ENTRY = RBackup::ENV['MOUNT'] # or '/mnt' ?
+e "\n"+'Running standalone.'+"\n", StdColours::CWARN
+_ = RBackup.new
+_.scan_for_usb_entries
+_.change_to_device_and_start_backup # also invokes backup_system

data/lib/backup_paradise.rb

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

data/lib/backup_paradise/advanced_backup/advanced_backup.rb

@@ -0,0 +1,53 @@
+#!/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/advanced_backup.rb'
+# =========================================================================== #
+require 'backup_paradise/toplevel_methods/colours.rb'
+require 'backup_paradise/toplevel_methods/help.rb'
+require 'backup_paradise/base/base.rb'
+# =========================================================================== #
+# Next, require .rb files that are specific to class AdvancedBackup.
+# =========================================================================== #
+require 'backup_paradise/advanced_backup/audio.rb'
+require 'backup_paradise/advanced_backup/constants.rb'
+require 'backup_paradise/advanced_backup/data_directory.rb'
+require 'backup_paradise/advanced_backup/do_perform_the_backup_tasks.rb'
+require 'backup_paradise/advanced_backup/misc.rb'
+require 'backup_paradise/advanced_backup/initialize.rb'
+require 'backup_paradise/advanced_backup/menu.rb'
+require 'backup_paradise/advanced_backup/reset.rb'
+require 'backup_paradise/advanced_backup/run.rb'
+require 'backup_paradise/advanced_backup/system_directory.rb'
+
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base # === BackupParadise::AdvancedBackup
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  BackupParadise::AdvancedBackup.new(ARGV)
+end # rbackup --help
+    # rbackup --data_only
+    # rbackup data_only

data/lib/backup_paradise/advanced_backup/audio.rb

@@ -0,0 +1,124 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/audio.rb'
+# =========================================================================== #
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base # === BackupParadise::AdvancedBackup
+
+  # ========================================================================= #
+  # === try_to_backup_the_audio_directory          (audio tag, audio dir tag)
+  #
+  # This method can be used to backup my audio directory, which normally
+  # resides at "/home/x/songs/".
+  #
+  # This method accepts two arguments.
+  #
+  # If the first argument is true then only those audio files that
+  # are missing will be copied.
+  #
+  # The second argument specifies which directory is used as the input
+  # directory, where the songs that are to be copied should reside.
+  # ========================================================================= #
+  def try_to_backup_the_audio_directory(
+      copy_only_missing_audio_files      = true,
+      use_this_as_audio_directory_target = AUDIO_DIRECTORY
+    )
+    if File.directory? use_this_as_audio_directory_target
+      copied_n_files = 0
+      _ = target_mountpoint?+File.basename(use_this_as_audio_directory_target)
+      _ = _.dup if _.frozen?
+      _ << '/' unless _.end_with? '/'
+      cliner
+      opnn; e "Now trying to backup the Audio directory "\
+              "at `#{sdir(use_this_as_audio_directory_target)}`."
+      opnn; e "The target for this will be at `#{sdir(_)}`."
+      n_gigabytes = BackupParadise.size_in_gigabytes?(use_this_as_audio_directory_target).to_s
+      opnn; e 'This directory has a total of '+
+              sfancy(n_files_in?(use_this_as_audio_directory_target).to_s)+' entries '\
+              '(Total size: '+n_gigabytes+' GB).'
+      cliner
+      unless File.directory? _
+        opnn; verbose_create_a_directory_at_this_position(_)
+      end
+      rename_tab(:default, 'Backing up the main audio directory.')
+      unless use_this_as_audio_directory_target.end_with? '*'
+        if use_this_as_audio_directory_target.frozen?
+          use_this_as_audio_directory_target = use_this_as_audio_directory_target.dup
+        end
+        use_this_as_audio_directory_target << '*'
+      end
+      # ===================================================================== #
+      # Else we will copy only the audio files that are missing. In order
+      # to do so we have to obtain all audio-files - we will simply
+      # pick all files, anyway. We will keep these entries sorted, too.
+      # ===================================================================== #
+      these_audio_files_may_be_copied = Dir[
+        rds("#{use_this_as_audio_directory_target.delete('*')}/*")
+      ].sort
+      if copy_only_missing_audio_files
+        these_audio_files_may_be_copied.each {|this_file|
+          new_target = "#{_}#{File.basename(this_file)}"
+          # ================================================================= #
+          # We check whether the target-file exists. Only if it does not
+          # exist will it be copied.
+          # ================================================================= #
+          unless File.exist? new_target
+            copied_n_files += 1
+            # =============================================================== #
+            # Pad the display.
+            # =============================================================== #
+            padded_file   = this_file.ljust(40)
+            padded_target = new_target.ljust(40)
+            e "Copying `#{sfile(padded_file)}` to"
+            e "        `#{sfile(padded_target)}`."
+            copy_this_file(this_file, new_target)
+          end
+        }
+      else
+        copy_recursively(use_this_as_audio_directory_target, _)
+      end
+      # ======================================================================= #
+      # Ok, now, if we removed a file from /Depot/Audio, then the Audio/
+      # directory at the mounted USB device may still have such a file.
+      # So we will warn the user about this.
+      # ======================================================================= #
+      target = "#{mount_point?}#{File.basename(use_this_as_audio_directory_target)}/"
+      unless these_audio_files_may_be_copied.size == Dir["#{target}*"].size
+        opnn; e 'It seems as if we have an unequal amount of Audio files in '
+        opnn; e 'the two directories.'
+        opnn; e 'This usually means that the original directory '+
+                sdir(use_this_as_audio_directory_target)+' has some files'
+        opnn; e 'deleted, but the target directory at '+sdir(target)+' does not.'
+        opnn; e 'The old directory has '+simp(
+                  these_audio_files_may_be_copied.size.to_s
+                 )+' entries.'
+      end
+      if copied_n_files == 0
+        opnn; e "No file was copied into the directory "\
+                "#{sdir(_)}."
+        opnn; e 'This may indicate that the target audio-directory already '
+        opnn; e 'contains all necessary audio-files.' 
+      else
+        opnn; e "Finished backing up the directory "\
+                "#{sdir(use_this_as_audio_directory_target.delete('*'))} into #{sdir(_)}."
+      end     
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(use_this_as_audio_directory_target)
+    end
+  end; alias backup_audio_directory     try_to_backup_the_audio_directory # === backup_audio_directory
+       alias backup_the_audio_directory try_to_backup_the_audio_directory # === backup_the_audio_directory
+
+  # ========================================================================= #
+  # === backup_audio_directory_then_exit
+  #
+  # Backup the audio directory, then exit the program.
+  # ========================================================================= #
+  def backup_audio_directory_then_exit
+    backup_audio_directory
+    exit_program
+  end
+
+end; end

data/lib/backup_paradise/advanced_backup/constants.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/constants.rb'
+# =========================================================================== #
+require 'backup_paradise/base/base.rb'
+
+module BackupParadise
+
+class AdvancedBackup < ::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/advanced_backup.log'
+  else
+    FILE_BACKUP_LOG = '/tmp/advanced_backup.log'
+  end
+
+end; end

data/lib/backup_paradise/advanced_backup/data_directory.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/advanced_backup/data_directory.rb'
+# =========================================================================== #
+module BackupParadise
+
+class AdvancedBackup < ::BackupParadise::Base
+
+  # ========================================================================= #
+  # === backup_the_data_directory_then_exit
+  #
+  # Backup only Data directory.
+  # ========================================================================= #
+  def backup_the_data_directory_then_exit
+    backup_data_directory
+    exit_program
+  end; alias backup_data_directory_then_exit backup_the_data_directory_then_exit # === backup_data_directory_then_exit
+
+  # ========================================================================= #
+  # === backup_the_data_directory                                  (data tag)
+  #
+  # This method will backup the DATA directory, e. g. the one that is
+  # at "/home/x/DATA/" on my home system.
+  # ========================================================================= #
+  def backup_the_data_directory(
+      target_directory = DATA_DIRECTORY
+    )
+    if File.directory? target_directory
+      mountpoint_target = main_target?+File.basename(target_directory)
+      cliner
+      e "Now backing up the DATA 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
+      )
+    else
+      can_not_backup_this_directory_as_it_does_not_exist(target_directory)
+    end
+  end; alias backup_only_data_directory backup_the_data_directory # === backup_only_data_directory
+       alias backup_data_directory      backup_the_data_directory # === backup_data_directory
+
+end; end