backup_paradise 1.3.1

data/lib/backup_paradise/gui/shared_code/simple_backup_widget/simple_backup_widget_module.rb

@@ -0,0 +1,587 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BackupParadise::GUI::SimpleBackupWidgetModule
+# =========================================================================== #
+# require 'backup_paradise/gui/shared_code/simple_backup_widget/simple_backup_widget_module.rb'
+# include BackupParadise::GUI::SimpleBackupWidgetModule
+# =========================================================================== #
+module BackupParadise
+
+module GUI
+
+module SimpleBackupWidgetModule # === BackupParadise::GUI::SimpleBackupWidgetModule
+
+  # ========================================================================= #
+  # Add backup-paradise related .rb files next:
+  # ========================================================================= #
+  require 'backup_paradise/project/project.rb'
+  require 'backup_paradise/utility_scripts/backup/backup.rb'
+  require 'backup_paradise/actions/backup.rb'
+  require 'backup_paradise/windows/windows.rb'
+
+  begin
+    require 'open'
+  rescue LoadError; end
+
+  begin
+    require 'mountpoints'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === TITLE
+  # ========================================================================= #
+  TITLE = 'Simple Backup Widget'
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = '50%'
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = '40%'
+
+  # ========================================================================= #
+  # === USE_THIS_FONT
+  # ========================================================================= #
+  USE_THIS_FONT = :dejavu_condensed_19
+
+  # ========================================================================= #
+  # === LARGER_FONT
+  # ========================================================================= #
+  LARGER_FONT = :dejavu_condensed_21
+
+  # ========================================================================= #
+  # === reset_shared_module
+  # ========================================================================= #
+  def reset_shared_module
+    # ======================================================================= #
+    # === @title
+    # ======================================================================= #
+    title_width_height(TITLE, WIDTH, HEIGHT)
+    # ======================================================================= #
+    # === @file_chooser_dialog
+    # ======================================================================= #
+    @file_chooser_dialog = nil
+    # ======================================================================= #
+    # === @dataset_from_the_config_file
+    # ======================================================================= #
+    @dataset_from_the_config_file = nil
+    if File.exist? BackupParadise.file_config?
+      @dataset_from_the_config_file = YAML.load_file(BackupParadise.file_config?)
+    end
+  end
+
+  # ========================================================================= #
+  # === padding?
+  # ========================================================================= #
+  def padding?
+    0
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    0
+  end
+
+  # ========================================================================= #
+  # === return_backup_complete_message
+  # ========================================================================= #
+  def return_backup_complete_message
+    'Backup complete! Time finish at: '+time_now?
+  end
+
+  # ========================================================================= #
+  # === copy_this_file
+  # ========================================================================= #
+  def copy_this_file(from, b)
+    ::BackupParadise.copy_this_file(from, b)
+  end
+
+  # ========================================================================= #
+  # === larger_font?
+  # ========================================================================= #
+  def larger_font?
+    LARGER_FONT
+  end
+
+  # ========================================================================= #
+  # === do_transfer_a_single_file
+  # ========================================================================= #
+  def do_transfer_a_single_file(
+      _      = entry_left?.text?.strip,
+      target = onto?
+    )
+    target = target.dup if target.frozen?
+    target << File.basename(_)
+
+    if _.empty?
+      e 'Please supply a file to transfer.'
+    else
+      e "Now trying to copy #{_} to #{target}."
+      Thread.new {
+        copy_this_file(_, target)
+        pop_up_this_text_over_that_widget(return_backup_complete_message, @button_backup)
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === main_target?
+  #
+  # This method will "return" our main target.
+  # ========================================================================= #
+  def main_target?
+    @backup_to_this_target.text?
+  end
+
+  # ========================================================================= #
+  # === do_backup_my_songs
+  # ========================================================================= #
+  def do_backup_my_songs(
+      to =
+        ("#{onto?}#{File.basename(entry_left?.text?)}/").squeeze('/')
+    )
+    to.squeeze!('/')
+    Thread.new {
+      BackupParadise.simple_backup(
+        entry_left?.text?, to
+      )
+      pop_up_this_text_over_that_widget(
+        return_backup_complete_message,
+        @button_backup_audio 
+      )
+    }
+  end
+
+  # ========================================================================= #
+  # === time_now?
+  # ========================================================================= #
+  def time_now?
+    return ::Time.now.strftime('%d.%m.%Y, %H:%M:%S')
+  end
+
+  # ========================================================================= #
+  # === entry1?
+  # ========================================================================= #
+  def entry1?
+    @entry1_for_the_backup_from_value
+  end; alias entry_left? entry1? # === entry_left?
+
+  # ========================================================================= #
+  # === create_the_entries                                      (entries tag)
+  # ========================================================================= #
+  def create_the_entries
+    # ======================================================================= #
+    # === @entry1_for_the_backup_from_value
+    # ======================================================================= #
+    @entry1_for_the_backup_from_value = entry
+    @entry1_for_the_backup_from_value.pad4px
+    @entry1_for_the_backup_from_value.bblack1
+    @entry1_for_the_backup_from_value.very_light_yellow_background
+    # ======================================================================= #
+    # === @entry2_for_the_backup_onto_value
+    # ======================================================================= #
+    @entry2_for_the_backup_onto_value = entry
+    @entry2_for_the_backup_onto_value.pad4px
+    @entry2_for_the_backup_onto_value.bblack1
+    @entry2_for_the_backup_onto_value.very_light_yellow_background
+    @entry2_for_the_backup_onto_value.width_height(250, 50)
+  end
+
+  # ========================================================================= #
+  # === from?
+  #
+  # This method has to keep in mind that Strings such as ":ingrid" are
+  # used. This indicates a symbol which has to be treated in a special
+  # manner.
+  #
+  # Furthermore, only directories will have a '/' appended; files must
+  # not have a '/' appended.
+  # ========================================================================= #
+  def from?(
+      i = @entry1_for_the_backup_from_value.text?
+    )
+    if i.is_a?(String) and i.start_with?(':')
+      case i.delete(':').to_sym
+      # ===================================================================== #
+      # === :ingrid
+      # ===================================================================== #
+      when :ingrid
+        i = 'C/ingrid/'
+      end
+    end
+    if i.is_a?(String) and i.frozen?
+      i = i.dup
+    end
+    i.squeeze!('/')
+    if File.directory?(i) and !i.end_with?('/')
+      i << '/' 
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === copy_from_to
+  #
+  # This is the method that can be used for backing up the data.
+  # ========================================================================= #
+  def copy_from_to(
+      from = from?,
+      to   = onto?
+    )
+    unless File.directory? from
+      e "#{sfile(from)} should be a directory."
+    end
+    if from == 'C/ingrid/'
+      # ====================================================================== #
+      # The first entry is a special case, applying to only one particular
+      # situation on Windows. It is retained here on an ad-hoc basis,
+      # but it may be better to move this into another location.
+      # ====================================================================== #
+      BackupParadise::Windows.backup_ingrid_directory
+    elsif File.file?(from)
+      # ====================================================================== #
+      # Backup files here.
+      # ====================================================================== #
+      do_transfer_a_single_file
+    else
+      # ====================================================================== #
+      # Backup directories here.
+      # ====================================================================== #
+      if from.is_a?(String) and from.start_with?(':')
+        case from.delete(':').to_sym
+        # ===================================================================== #
+        # === :everything
+        #
+        # This will default to the registered action stored in the
+        # config.yml file.
+        # ===================================================================== #
+        when :everything
+          if @dataset_from_the_config_file
+            i = @dataset_from_the_config_file['backup_these_directories']
+            BackupParadise::Actions.backup {{
+              backup_these_directories: i,
+              where_to:                 to
+            }}
+          else
+            e 'No file called config.yml was found. Defaulting to the'
+            e 'current working directory thus.'
+            i = File.absolute_path("#{Dir.pwd}/")
+          end
+        end
+      else
+        begin
+          Thread.new {
+            @spinner.is_active # go_and_spin_now
+            FileUtils.cp_r(from, to)
+            pop_up_this_text_over_that_widget(
+              return_backup_complete_message, @button_backup
+            )
+            @spinner.stop_spinning
+          }
+        rescue Exception => error
+          pp error
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === backup_audio_button?
+  # ========================================================================= #
+  def backup_audio_button?
+    @button_backup_audio
+  end
+
+  # ========================================================================= #
+  # === backup_ingrid_button?
+  # ========================================================================= #
+  def backup_ingrid_button?
+    @button_ingrid
+  end
+
+  # ========================================================================= #
+  # === backup_button?
+  # ========================================================================= #
+  def backup_button?
+    @button_backup
+  end
+
+  # ========================================================================= #
+  # === create_the_file_chooser_button
+  # ========================================================================= #
+  def create_the_file_chooser_button
+    # ======================================================================= #
+    # === @button_choose_file
+    # ======================================================================= #
+    @button_choose_file = button('Choose file')
+    @button_choose_file.on_clicked {
+      create_file_chooser_dialog_widget
+      run_file_chooser_dialog
+    }
+  end
+
+  # ========================================================================= #
+  # === choose_file_button?
+  # ========================================================================= #
+  def choose_file_button?
+    @button_choose_file
+  end
+
+  # ========================================================================= #
+  # === create_the_label_showing_results
+  # ========================================================================= #
+  def create_the_label_showing_results
+    @label_showing_results = label
+  end
+
+  # ========================================================================= #
+  # === create_the_buttons                          (buttons tag, button tag)
+  # ========================================================================= #
+  def create_the_buttons
+    create_the_file_chooser_button
+    create_the_backup_button
+    create_the_backup_audio_button
+    create_the_ingrid_button if is_on_roebe?
+  end
+
+  # ========================================================================= #
+  # === onto
+  # ========================================================================= #
+  def onto?
+    return "#{@entry2_for_the_backup_onto_value.text?}/".squeeze('/')
+  end; alias to? onto? # === to?
+
+  # ========================================================================= #
+  # === create_the_grid                                            (grid tag)
+  # ========================================================================= #
+  def create_the_grid
+    # ======================================================================= #
+    # === @grid
+    # ======================================================================= #
+    @grid = default_grid
+    @grid.pad10px
+    @grid.css_class('dotted_steelblue_border')
+    @grid.set_size_request(100, 50)
+    @grid.row_spacing  = 5
+    @grid.line_spacing = 5
+    label_backup_from = text('Backup from:')
+    label_backup_from.make_bold
+    label_backup_from.hint = 'Input which directory '\
+                             'you wish to back up. Use the combo-box entry '\
+                             'below this widget, or the entry below '\
+                             'that combo-box.'
+    @grid.left(label_backup_from)
+
+    label_backup_onto = text('Backup onto:')
+    label_backup_onto.make_bold
+    label_backup_onto.hint = 'Input the target device onto which we will '\
+                             'copy the data onto.'
+    @grid.right(label_backup_onto)
+
+    # ======================================================================= #
+    # Next we will add the two main combo-boxes.
+    # ======================================================================= #
+    @grid.left(@combo_box_backup_from)
+    @grid.right(@combo_box_backup_onto)
+    @grid.left(@entry1_for_the_backup_from_value)
+    @grid.right(@entry2_for_the_backup_onto_value)
+  end
+
+  # ========================================================================= #
+  # === create_the_combo_boxes                                    (combo tag)
+  # ========================================================================= #
+  def create_the_combo_boxes
+    # ======================================================================= #
+    # === @combo_box_backup_from
+    #
+    # This is the combo-box that keeps the core entries, such as
+    # "/home/x/songs" and so forth.
+    # ======================================================================= #
+    @combo_box_backup_from = combo_box
+    @combo_box_backup_from.bblack1
+    @combo_box_backup_from.set_border_width(2)
+    # ======================================================================= #
+    # Next we will populate the combo-box with proper entries:
+    # ======================================================================= #
+    _ = BackupParadise.backup_these_directories?.map {|entry| "#{entry}/".squeeze('/') }
+    _.prepend(':everything')
+    _.prepend(':ingrid') if is_on_roebe?
+    @combo_box_backup_from.populate(_)
+    @combo_box_backup_from.the_first_entry_is_active
+    @combo_box_backup_from.hint =
+      ':everything means to backup the default action, as-is. If you '\
+      'need a more fine-tuned level of control then simply backup only '\
+      'some directories, or use the entry to the right side of this '\
+      'combo box to backup only individual directories or files.'
+    # ======================================================================= #
+    # === @combo_box_backup_onto
+    # ======================================================================= #
+    @combo_box_backup_onto = combo_box
+    @combo_box_backup_onto.bblack1
+    @combo_box_backup_onto.set_border_width(2)
+    scan_for_mountpoints_then_update_the_appropriate_combo_box
+  end
+
+  # ========================================================================= #
+  # === sync_the_combo_box_values_onto_the_entries_below
+  # ========================================================================= #
+  def sync_the_combo_box_values_onto_the_entries_below
+    _ = @combo_box_backup_from.text?.to_s
+    entry1?.set_text(_)
+    sync_the_second_entry
+  end
+
+  # ========================================================================= #
+  # === sync_the_second_entry
+  # ========================================================================= #
+  def sync_the_second_entry
+    entry2?.set_text(
+      @combo_box_backup_onto.text?.to_s
+    )
+  end
+
+  # ========================================================================= #
+  # === entry2?
+  # ========================================================================= #
+  def entry2?
+    @entry2_for_the_backup_onto_value
+  end
+
+  # ========================================================================= #
+  # === do_handle_the_proper_syncing_when_the_combo_box_entries_are_changed
+  # ========================================================================= #
+  def do_handle_the_proper_syncing_when_the_combo_box_entries_are_changed
+    # ======================================================================= #
+    # Sync any change made in the combo box onto the associated entry.
+    # ======================================================================= #
+    sync_connect(@combo_box_backup_from, entry1?)
+    sync_connect(@combo_box_backup_onto, entry2?)
+  end
+
+  # ========================================================================= #
+  # === create_the_ingrid_button
+  # ========================================================================= #
+  def create_the_ingrid_button
+    # ======================================================================= #
+    # === @button_ingrid
+    # ======================================================================= #
+    @button_ingrid = button('Backup ingrid')
+    @button_ingrid.clear_background
+    @button_ingrid.pad8px
+    @button_ingrid.css_class('the_backup_button_for_ingrid')
+    @button_ingrid.set_size_request(16, 25)
+    @button_ingrid.on_clicked {
+      do_backup_for_ingrid
+    }
+    @button_ingrid.set_border_width(2)
+    @button_ingrid.hint = 'This will backup c:\ingrid to '\
+      'the appropriate external USB device.'
+  end
+
+  # ========================================================================= #
+  # === scan_for_mountpoints_then_update_the_appropriate_combo_box
+  # ========================================================================= #
+  def scan_for_mountpoints_then_update_the_appropriate_combo_box
+    if Object.const_defined? :Mountpoints
+      @combo_box_backup_onto.clear_old_datapoints
+      @combo_box_backup_onto.populate(Mountpoints[])
+      @combo_box_backup_onto.the_first_entry_is_active
+      sync_the_second_entry
+    end
+  end
+
+  # ========================================================================= #
+  # === create_the_backup_audio_button
+  # ========================================================================= #
+  def create_the_backup_audio_button
+    # ======================================================================= #
+    # === @button_backup_audio
+    # ======================================================================= #
+    @button_backup_audio = button('Backup Audio')
+    @button_backup_audio.hint = 'This button is ad-hoc code to quickly '\
+      'copy all local songs on my home layout. You can modify this '\
+      'by modifying the config.yml file and changing the entry called '\
+      '<b>local_audio_directory</b>.'
+    @button_backup_audio.on_clicked {
+      # ===================================================================== #
+      # First, if the config-dataset exists, sync the combo-box entry.
+      # ===================================================================== #
+      if @dataset_from_the_config_file
+        local_audio_directory = @dataset_from_the_config_file['local_audio_directory'].to_s
+        entry_left?.set_text(
+          local_audio_directory
+        )
+      end
+      do_backup_my_songs
+    }
+  end
+
+  # ========================================================================= #
+  # === create_the_backup_button
+  # ========================================================================= #
+  def create_the_backup_button
+    # ======================================================================= #
+    # === @button_backup
+    # ======================================================================= #
+    @button_backup = button('Backup the data')
+    @button_backup.clear_background
+    @button_backup.pad8px
+    @button_backup.css_class('the_backup_button')
+    @button_backup.set_size_request(16, 25)
+    @button_backup.on_clicked {
+      do_backup_the_data
+    }
+    @button_backup.set_border_width(2)
+    @button_backup.hint =
+      "Click this button to <b>backup your data</b>. This works for both "\
+      "directories, as well as individual files and special instructions. "\
+      "Special instructions are indicated via a leading : character on "\
+      "the top-left hand side.\n\n"\
+      "Make sure that the USB device(s) are properly connected before "\
+      "clicking any button, though."
+  end
+
+  # ========================================================================= #
+  # === do_backup_the_data
+  # ========================================================================= #
+  def do_backup_the_data(
+      from = from?,
+      to   = to?
+    )
+    @label_showing_results.set_text(
+      'Command that will be run: '+"\n\n"+
+      '  <b>cp -rv '+from+' '+to+"</b>\n"
+    )
+    @label_showing_results.do_markify
+    Thread.new {
+      e 'Backing up the data next, from `'+
+         sfile(from)+'` to `'+sfile(to)+'`.'
+      copy_from_to(from, to)
+    }
+  end
+
+  # ========================================================================= #
+  # === backup_ingrid_directory
+  #
+  # This is a method for a custom-backup. Other users won't need to use
+  # this method.
+  # ========================================================================= #
+  def backup_ingrid_directory
+    BackupParadise::Windows.backup_ingrid_directory
+  end; alias do_backup_for_ingrid backup_ingrid_directory # === do_backup_for_ingrid
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    create_skeleton_then_connect_skeleton
+  end
+
+end; end; end

data/lib/backup_paradise/gui/tk/backup.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# This file shall provide simple bindings for backup-related activity
+# on windows. On windows paths such as "E:/songs" will work.
+# =========================================================================== #
+# require 'backup_paradise/gui/tk/backup.rb'
+# =========================================================================== #
+require 'backup_paradise'
+
+@object_backup = BackupParadise::Backup.new { :do_not_run_yet }
+
+require 'tk_paradise/tk_paradise.rb'
+include Tk
+
+alias e puts
+require 'colours'
+
+# =========================================================================== #
+# === TITLE
+# =========================================================================== #
+TITLE = 'Backup data'
+
+# =========================================================================== #
+# === rev
+# =========================================================================== #
+def rev
+  ::Colours.rev
+end
+
+# =========================================================================== #
+# === do_start_to_backup
+# =========================================================================== #
+def do_start_to_backup(i = :usb1)
+  if i and i.is_a? String
+    i = i.dup
+    if i.include? 'onto '
+      i.sub!(/onto /) # 'onto F:'
+    end
+  end
+  unless i.end_with? '/'
+    i << '/'
+  end
+  e rev+'Starting to backup data.'
+  @object_backup = BackupParadise::Backup.new { :do_not_run_yet }
+#pp @object_backup.mountpoint?
+#  @object_backup.set_mountpoint(i)
+#pp @object_backup.mountpoint?
+end
+
+# =========================================================================== #
+# === Fonts
+# =========================================================================== #
+USE_THIS_FONT_FAMILY = 'DejaVu Sans'    
+larger_font = Font.new(family: USE_THIS_FONT_FAMILY, size: 28, weight: 'bold')
+font        = Font.new(family: USE_THIS_FONT_FAMILY, size: 20, weight: 'bold')
+
+root = Tk.root {{ geometry: '820x450+0+0', title: TITLE }}
+
+button_start_to_backup_onto_drive_letter_e = Button.new(
+  root,
+  text: 'Start to backup onto label E:',
+  bg: '#0052cc',
+  fg: '#ffffff'
+) {
+  command proc {
+    do_start_to_backup('onto E:')
+  }
+}.grid(row: 1, column: 3, columnspan: 3, padx: 2, pady: 2)
+
+button_start_to_backup_onto_drive_letter_e.set_font(larger_font)
+Grid.grid(button_start_to_backup_onto_drive_letter_e, columnspan: 2)
+
+button_start_to_backup_onto_drive_letter_f = Button.new(
+  root,
+  text: 'Start to backup onto label F:',
+  bg: '#0052cc',
+  fg: '#ffffff'
+) {
+  command proc {
+    do_start_to_backup('onto F:')
+  }
+}.grid(row: 2, column: 3, columnspan: 3, padx: 2, pady: 2)
+
+button_start_to_backup_onto_drive_letter_f.set_font(larger_font)
+Grid.grid(button_start_to_backup_onto_drive_letter_f, columnspan: 2)
+
+button_ad_hoc = Button.new(
+  root,
+  text: 'Auto-backup (easy debug mode for now onto E:)',
+  bg: '#0052cc',
+  fg: '#ffffff'
+) {
+  command proc {
+    @object_backup = BackupParadise::Backup.new { :do_not_run_yet }
+    @object_backup.set_mountpoint('E:/')
+    @object_backup.do_backup
+  }
+}.grid(row: 3, column: 3, columnspan: 3, padx: 2, pady: 2)
+
+button_ad_hoc.set_font(larger_font)
+Grid.grid(button_ad_hoc, columnspan: 2)
+
+
+Tk.run
+
+#TkLabel.new(root) { text 'Attention!'; font TkCaptionFont }