backup_paradise 1.2.13

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

@@ -0,0 +1,383 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === AdvancedBackup::GUI::Gtk::BackupWidget
+# =========================================================================== #
+# This is the base widget collection for the gtk3-backup functionality
+# via a GUI.
+# =========================================================================== #
+# require 'backup_paradise/gui/gtk3/backup.rb'
+# =========================================================================== #
+begin
+  require 'colours'
+rescue LoadError; end
+require 'backup_paradise/advanced_backup/advanced_backup.rb'
+require 'backup_paradise/base/base.rb'
+begin
+  require 'gtk3'
+rescue LoadError; end
+
+begin
+  require 'gtk_paradise/gtk_classes/about.rb'
+rescue LoadError; end
+
+begin
+  require 'gtk_paradise/gtk_classes_menu_item.rb'
+rescue LoadError; end
+
+begin
+  require 'gtk_paradise/requires/require_the_base_module.rb'
+rescue LoadError; end
+
+module AdvancedBackup
+
+module GUI
+
+module Gtk
+
+class BackupWidget < ::Gtk::Window # === AdvancedBackup::GUI::Gtk::BackupWidget
+
+  include Colours::E
+  include Gtk::BaseModule
+
+  # ========================================================================= #
+  # === WIDTH
+  # ========================================================================= #
+  WIDTH = 800
+
+  # ========================================================================= #
+  # === HEIGHT
+  # ========================================================================= #
+  HEIGHT = 600
+
+  # ========================================================================= #
+  # === USE_THIS_FONT_SIZE
+  # ========================================================================= #
+  USE_THIS_FONT_SIZE = '26'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize
+    super()
+    reset
+    run
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    @file_chooser_dialog = nil
+    determine_the_title_of_the_main_window
+    ::Gtk::Settings.default.gtk_font_name = 'DejaVu Sans Mono '+USE_THIS_FONT_SIZE
+    ::Gtk::Settings.default.gtk_tooltip_timeout = 2000
+    @advanced_rbackup = BackupParadise::AdvancedBackup.new(
+      nil, :do_not_run_yet
+    )
+  end
+
+  # ========================================================================= #
+  # === determine_the_title_of_the_main_window
+  # ========================================================================= #
+  def determine_the_title_of_the_main_window
+    @title_to_use = 'Backup Data'
+    set_title @title_to_use
+  end
+
+  # ========================================================================= #
+  # === add_components_for_individual_transfer_of_files_or_directories
+  #
+  # The widget that goes in here, onto the main vbox, will hold the relevant
+  # parts that can be used to do a per-file backup. 
+  # ========================================================================= #
+  def add_components_for_individual_transfer_of_files_or_directories(
+      vbox
+    )
+    vbox.pack_start(gtk_label(
+      'Input the file that you wish to copy next:')
+    )
+    @entry_for_transfer_of_a_single_file = gtk_entry
+    vbox.pack_start(@entry_for_transfer_of_a_single_file)
+    @button_transfer_file = gtk_button(label: 'Transfer this ^^^ file')
+    @button_transfer_file.signal_connect(:clicked) {
+      do_transfer_a_single_file
+    }
+    vbox.pack_start(@button_transfer_file)
+  end
+
+  # ========================================================================= #
+  # === create_the_backup_button
+  # ========================================================================= #
+  def create_the_backup_button
+    @backup_button = gtk_button(
+      label: 'Backup the data'
+    )
+    @backup_button.signal_connect(:clicked) {
+      do_backup_the_data
+    }
+    @backup_button.set_border_width(4)
+    @backup_button.tooltip_text = 'Click this button to backup your data.'
+  end
+
+  # ========================================================================= #
+  # === do_backup_the_data
+  # ========================================================================= #
+  def do_backup_the_data
+    from = @backup_from_this_target.text
+    to   = @backup_to_this_target.text
+    @label_showing_results.set_text(
+      'Command that will be run: '+"\n\n"+'  cp -rv '+from+' '+to+"\n"
+    )
+    e 'Backing up the data next, from `'+sfile(from)+'` to `'+sfile(to)+'`.'
+    copy_from_to(from, to)
+  end
+
+  # ========================================================================= #
+  # === main_target?
+  #
+  # This method will "return" our main target.
+  # ========================================================================= #
+  def main_target?
+    @backup_to_this_target.text
+  end
+
+  # ========================================================================= #
+  # === copy_from_to
+  #
+  # This is the method that can be used for backing up the data.
+  # ========================================================================= #
+  def copy_from_to(from, to)
+    unless File.directory? from
+      e "#{sfile(from)} should be a directory."
+    end
+    begin
+      FileUtils.cp_r(from, to)
+    rescue Exception => error
+      pp error
+    end
+  end
+
+  # ========================================================================= #
+  # === create_user_interface
+  # ========================================================================= #  
+  def create_user_interface
+    override_background_color(
+      :normal, 
+      Gdk::RGBA.new(0.999, 0.999, 0.999, 1)
+    )
+    # ======================================================================= #
+    # First create the @menu_bar which will holds the individual menus.
+    # ======================================================================= #
+    @menu_bar = gtk_menu_bar # <- The menu-bar.
+    filemenu1 = gtk_menu
+    # ======================================================================= #
+    # Add the menu-item label called file.
+    # ======================================================================= #
+    filem1 = ::Gtk.menu_item_with_this_label('File')
+    filem1.set_submenu(filemenu1)
+    exit = ::Gtk.menu_item_with_this_label('Exit')
+    exit.signal_connect(:activate) { do_exit }
+    filemenu1.append(exit)
+    # ======================================================================= #
+    # Add it onto the main menu-bar:
+    # ======================================================================= #
+    @menu_bar.append(filem1)
+
+    filemenu2 = gtk_menu
+    # ======================================================================= #
+    # Add the menu-item label called file.
+    # ======================================================================= #
+    filem2 = ::Gtk.menu_item_with_this_label('Options')
+    filem2.set_submenu(filemenu2)
+    about = ::Gtk.menu_item_with_this_label('About')
+    about.signal_connect(:activate) {
+      ::Gtk.return_about_dialog_widget
+    }
+    exit = ::Gtk.menu_item_with_this_label('Exit2')
+    exit.signal_connect(:activate) { do_exit }
+    filemenu2.append(about)
+    # ======================================================================= #
+    # Add it onto the main menu-bar:
+    # ======================================================================= #
+    @menu_bar.append(filem2)
+
+#    filemenu2 = ::Gtk::Menu.new
+#    options = ::Gtk.menu_item_with_this_label('Options')
+#    options.set_submenu(filemenu2)
+#    filemenu2.append(options)
+#    
+#    filemenu2.append(about)
+#    # ======================================================================= #
+#    # Add it onto the main menu-bar:
+#    # ======================================================================= #
+#    @menu_bar.append(filemenu2)
+    add_main_box
+    signal_connect(:destroy) { do_exit }
+    determine_the_default_size
+    set_window_position :center
+    # ======================================================================= #
+    # Next, run the main application.
+    # ======================================================================= #
+  end
+
+  # ========================================================================= #
+  # === run_the_application
+  # ========================================================================= #
+  def run_the_application
+    show_all
+    maximize
+    ::Gtk.main
+  end
+
+  # ========================================================================= #
+  # === do_exit
+  # ========================================================================= #
+  def do_exit
+    ::Gtk.main_quit
+  end; alias exit_application do_exit # === exit_application
+
+  # ========================================================================= #
+  # === add_the_default_accel_groups
+  # ========================================================================= #
+  def add_the_default_accel_groups
+    @accel_group = ::Gtk::AccelGroup.new
+    # ======================================================================= #
+    # ctrl+q
+    # ======================================================================= #
+    @accel_group.connect( Gdk::Keyval::KEY_Q, :control_mask,
+      :visible) { exit_application }
+    add_accel_group(@accel_group)
+  end
+
+  # ========================================================================= #
+  # === determine_the_default_size
+  # ========================================================================= #
+  def determine_the_default_size
+    set_default_size(WIDTH, HEIGHT)
+  end
+
+  # ========================================================================= #
+  # === copy_this_file
+  # ========================================================================= #
+  def copy_this_file(a, b)
+    ::BackupParadise.copy_this_file(a, b)
+  end
+
+  # ========================================================================= #
+  # === do_transfer_a_single_file
+  # ========================================================================= #
+  def do_transfer_a_single_file
+    _ = @entry_for_transfer_of_a_single_file.text.to_s.strip
+    target = main_target?
+    if _.empty?
+      e 'Please supply a file to transfer.'
+    else
+      e "Now trying to copy #{_} to #{target}."
+      copy_this_file(_, target)
+    end
+  end
+
+  # ========================================================================= #
+  # === add_main_box
+  #
+  # This method will create a vbox that will be added.
+  # ========================================================================= #
+  def add_main_box
+    vbox = ::Gtk::Box.new(:vertical, 2)
+    vbox.pack_start(@menu_bar,
+      expand: false, 
+      fill:   false,
+      padding: 0
+    )
+    label_backup_from_source = gtk_label('Backup from (source):')
+    label_backup_from_source.set_markup(
+      %Q(<span weight="bold">#{label_backup_from_source.text}</span>)
+    )
+    vbox.pack_start(
+      label_backup_from_source, padding: 1
+    )
+    @backup_from_this_target = gtk_entry
+    @backup_from_this_target.set_text('C::\ingrid')
+
+    # ======================================================================= #
+    # Next add a hbox that will also hold a button for the choose-file
+    # dialog.
+    # ======================================================================= #
+    hbox = ::Gtk::Box.new(:horizontal, 2)
+    hbox.pack_start(@backup_from_this_target, expand: true, fill: true, padding: 1)
+    @button_choose_file = gtk_button(file: 'choose file')
+    @button_choose_file.signal_connect(:clicked) {
+      create_file_chooser_dialog_widget
+      run_file_chooser_dialog
+    }
+    hbox.pack_start(@button_choose_file, expand: false, fill: false, padding: 5)
+    vbox.pack_start(hbox, padding: 1)
+    label_backup_to_this_target = gtk_label('Backup to this device (target):')
+    label_backup_to_this_target.set_markup(
+      %Q(<span weight="bold">#{label_backup_to_this_target.text}</span>)
+    )
+    vbox.pack_start(
+      label_backup_to_this_target, padding: 1
+    )
+    @backup_to_this_target = gtk_entry
+    @backup_to_this_target.set_text('D::\ingrid')
+    vbox.pack_start(
+      @backup_to_this_target, padding: 1
+    )
+    create_the_backup_button
+    vbox.pack_start(@backup_button)
+    vbox.pack_start(::Gtk::Separator.new(:horizontal))
+    @label_showing_results = gtk_label
+    vbox.pack_start(@label_showing_results)
+    add_components_for_individual_transfer_of_files_or_directories(vbox)
+    add(vbox)
+  end
+
+  # ========================================================================= #
+  # === run_file_chooser_dialog
+  # ========================================================================= #
+  def run_file_chooser_dialog
+    _ = @file_chooser_dialog
+    if _ and (_.run == ::Gtk::ResponseType::ACCEPT)
+      filename = _.filename
+      e "filename = #{filename}"
+      e "uri = #{_.uri}"
+    end
+  end
+
+  # ========================================================================= #
+  # === create_file_chooser_dialog_widget
+  # ========================================================================= #
+  def create_file_chooser_dialog_widget
+    @file_chooser_dialog = ::Gtk::FileChooserDialog.new(
+      self: self,
+      title: 'Choose a file or directory',
+      action: ::Gtk::FileChooserAction::OPEN,                                 
+      buttons: [[::Gtk::Stock::OPEN, ::Gtk::ResponseType::ACCEPT],
+       [::Gtk::Stock::CANCEL, ::Gtk::ResponseType::CANCEL]]
+    )
+    @file_chooser_dialog.add_shortcut_folder('/Depot/Temp/')
+    @file_chooser_dialog.add_shortcut_folder(HOME_DIRECTORY_OF_THE_USER_X+'DATA/')
+    @file_chooser_dialog.add_shortcut_folder('/Ingrid')
+    @file_chooser_dialog.current_folder = Dir.pwd
+    @file_chooser_dialog.show_hidden = true # <- Show hidden files.
+    #@file_chooser_dialog.destroy
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    add_the_default_accel_groups
+    create_file_chooser_dialog_widget
+    create_user_interface
+    run_the_application
+  end
+
+end; end; end; end
+
+if __FILE__ == $PROGRAM_NAME
+  AdvancedBackup::GUI::Gtk::BackupWidget.new
+end # gtkbackup

data/lib/backup_paradise/project/project_base_directory.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'backup_paradise/project/project_base_directory.rb'
+# =========================================================================== #
+module BackupParadise
+
+  # ========================================================================= #
+  # === PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY =
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === BackupParadise.project_base_dir?
+  # ========================================================================= #
+  def self.project_base_dir?
+    BackupParadise::PROJECT_BASE_DIRECTORY
+  end
+
+end

data/lib/backup_paradise/requires/require_the_backup_paradise_project.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# When you wish to require the whole project, this is the file to go for.
+# =========================================================================== #
+# require 'backup_paradise/requires/require_the_backup_paradise_project.rb'
+# =========================================================================== #
+require 'backup_paradise/project/project_base_directory.rb'
+require 'backup_paradise/toplevel_methods/e.rb'
+require 'backup_paradise/toplevel_methods/mountpoint.rb'
+require 'backup_paradise/toplevel_methods/misc.rb'
+require 'backup_paradise/advanced_backup/advanced_backup.rb'
+require 'backup_paradise/tab/tab.rb'

data/lib/backup_paradise/tab/tab.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === BackupParadise::Tab
+#
+# This file handles tab-related activities, most normally renaming a tab.
+# Right now we have only some support for KDE tabs and mrxvt tabs.
+# =========================================================================== #
+# require 'backup_paradise/tab/tab.rb'
+# =========================================================================== #
+module BackupParadise
+
+module Tab # === BackupParadise::Tab
+
+  begin
+    require 'roebe/classes/mrxvt_options.rb'
+  rescue LoadError; end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.rename_tab
+  #
+  # This method does some additional checks before invoking the method 
+  # set_mrxvt_tab_title. set_konsole_tab_title() may work, if the
+  # user at hand has the roebe gem installed (aka, on my home system).
+  # ========================================================================= #
+  def self.rename_tab(
+      i                               = :mrxvt,
+      optional_title                  = 'Backup', # <- This is the new title.
+      use_this_program_to_rename_tabs = :mrxvt
+    )
+    case i.to_sym # case tag
+    # ======================================================================= #
+    # === :konsole
+    # ======================================================================= #
+    when :konsole,
+         :default
+      set_konsole_tab_title(optional_title)
+    # ======================================================================= #
+    # === :mrxvt
+    # ======================================================================= #
+    when :mrxvt
+      set_mrxvt_tab_title(optional_title) # Defined in this module here.
+    # ======================================================================= #
+    # === :blank
+    #
+    # This entry point re-sets the title of the terminal tab again to
+    # empty.
+    # ======================================================================= #
+    when :blank
+      case use_this_program_to_rename_tabs
+      when :konsole
+        set_konsole_tab_title(optional_title)
+      when :mrxvt
+        set_mrxvt_tab_title(optional_title)
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.set_mrxvt_tab_title
+  # ========================================================================= #
+  def self.set_mrxvt_tab_title(i)
+    if Object.const_defined? :Roebe
+      begin
+        require 'roebe/classes/mrxvt_options.rb'
+      rescue LoadError; end
+      Roebe::MrxvtOptions.set_title(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === BackupParadise::Tab.set_konsole_tab_title
+  # ========================================================================= #
+  def self.set_konsole_tab_title(i)
+    if Object.const_defined? :Roebe
+      begin
+        require 'roebe/classes/kde/kde_konsole.rb'
+      rescue LoadError; end
+      Roebe.rename_konsole_title_to(i, :be_quiet)
+    end
+  end
+
+end; end