bitferry 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb10ff66d68e1981c2011621d1d216cfe759e14378844f5101310b78e5938974
-  data.tar.gz: 0341d89784f9acaa607f9267ddcbd494901efa80ca9954d60d84484d177c63ff
+  metadata.gz: f67881c016dae96456c1d0b1baee9b3949eb9bfd46aa5f96cf7232d219c1d7d8
+  data.tar.gz: a5613291cc0b050ce243c8cf4142d8020c363100b0655cf6fcb405c0b380daba
 SHA512:
-  metadata.gz: 2ac8f19ed6ef8607082b8943d0cab8ae4fa973694bfac1ddc219fe34e2421c05116d9d4ea20213440b192a7a1eae50cc11a485f489976dd182ff5ea1dc5bf1d2
-  data.tar.gz: cf4dabac47d7b46ed13129b749d82c92cd216f91b3fb41c6a8d2db9114738ae875f38db99d0112d26a7176db639d5cba68ebdeaee8e9e6f61f7f21dc658de568
+  metadata.gz: 670ea9837098777a1dfa56df30283f2d6fac41df303003a33cd1e80711d5c4967f09ab72ba2247dbdb00c57830f0310825a064397f5db463e0ee927de72ce6dc
+  data.tar.gz: 433fb3934ae559cf42eb0a20d051923c0dc5e93eed32f5249dc95a1dde1930d3982fb925efd64f03d418fa9fefa54a74959ec87118c3c26d05ba0927667ee0cf

data/CHANGES.md

@@ -1,3 +1,13 @@
+## 0.0.7
+
+- Fix backend execution issues in GUI
+- Add verbosity control in GUI
+- GUI info additions
+
+## 0.0.6
+
+- Rudimentary GUI employing FXRuby
+
 ## 0.0.5
 
 - Disable cache usage in Restic check profiles

data/bin/bitferryfx

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'bitferry/fx'
+#

data/lib/bitferry/cli.rb

@@ -110,6 +110,7 @@ def obtain_password
 end
 
 
+Bitferry.ui = :cli
 Bitferry.log.level = Logger::DEBUG if $DEBUG
 
 
@@ -120,7 +121,7 @@ Clamp do
 
 
   option '--version', :flag, 'Print version' do
-    puts Bitferry::VERSION
+    $stdout.puts Bitferry::VERSION
     exit
   end
 
@@ -144,26 +145,26 @@ Clamp do
     def execute
       Bitferry.restore
       unless (xs = Bitferry::Volume.intact).empty?
-        puts '# Intact volumes'
-        puts
+        $stdout.puts '# Intact volumes'
+        $stdout.puts
         xs.each do |volume|
-          puts "  #{volume.tag}    #{volume.root}"
+          $stdout.puts "  #{volume.tag}    #{volume.root}"
         end
       end
       unless (xs = Bitferry::Task.intact).empty?
-        puts
-        puts '# Intact tasks'
-        puts
+        $stdout.puts
+        $stdout.puts '# Intact tasks'
+        $stdout.puts
         xs.each do |task|
-          puts "  #{task.tag}    #{task.show_status}"
+          $stdout.puts "  #{task.tag}    #{task.show_status}"
         end
       end
       if !(xs = Bitferry::Task.stale).empty? && Bitferry.verbosity == :verbose
-        puts
-        puts '# Stale tasks'
-        puts
+        $stdout.puts
+        $stdout.puts '# Stale tasks'
+        $stdout.puts
         xs.each do |task|
-          puts "  #{task.tag}    #{task.show_status}"
+          $stdout.puts "  #{task.tag}    #{task.show_status}"
         end
       end
     end

data/lib/bitferry/fx.rb

@@ -0,0 +1,131 @@
+require 'fox16'
+require 'stringio'
+require 'bitferry'
+
+
+include Fox
+
+
+class Output < StringIO
+
+  def initialize(app, output)
+    super('rw+')
+    @app = app
+    @output = output
+    @output.text = nil
+  end
+
+  def write(*args) = @app.runOnUiThread { @output.appendText(args.join) }
+
+  def flush = nil
+
+end
+
+
+class UI < FXMainWindow
+
+  def initialize(app)
+    super(@app = app, 'BitferryFX', width: 400, height: 300)
+    top_frame = FXVerticalFrame.new(self, opts: LAYOUT_FILL)
+      tabs = FXTabBook.new(top_frame, opts: LAYOUT_FILL)
+        output_tab = FXTabItem.new(tabs, 'Output')
+          @output = FXText.new(tabs)
+        tasks_tab = FXTabItem.new(tabs, 'Tasks')
+          @tasks = FXTable.new(tabs)
+          @tasks.tableStyle |= TABLE_COL_SIZABLE | TABLE_NO_COLSELECT | TABLE_READONLY
+          @tasks.rowHeaderMode = LAYOUT_FIX_WIDTH
+          @tasks.rowHeaderWidth = 0
+        volumes_tab = FXTabItem.new(tabs, 'Volumes')
+          @volumes = FXTable.new(tabs)
+          @volumes.tableStyle |= TABLE_COL_SIZABLE | TABLE_NO_COLSELECT | TABLE_READONLY
+          @volumes.rowHeaderMode = LAYOUT_FIX_WIDTH
+          @volumes.rowHeaderWidth = 0
+      @progress = FXProgressBar.new(top_frame, height: 16, opts: LAYOUT_FILL_X | LAYOUT_FIX_HEIGHT)
+      controls = FXPacker.new(top_frame, opts: LAYOUT_FILL_X)
+        @simulate = FXCheckButton.new(controls, "&Simulation mode (dry run)\tPrevent operations from making any on-disk changes")
+          @simulate.checkState = Bitferry.simulate?
+        @verbose = FXCheckButton.new(controls, "&Verbose mode\tOutput internal logging information")
+        @verbose.checkState = false
+      buttons = FXPacker.new(top_frame, opts: LAYOUT_FILL_X | PACK_UNIFORM_WIDTH | FRAME_SUNKEN)
+        @process = FXButton.new(buttons, "&Process\tProcess all intact tasks", opts: BUTTON_NORMAL | BUTTON_INITIAL | BUTTON_DEFAULT | LAYOUT_SIDE_LEFT)
+          @process.connect(SEL_COMMAND) { process }
+          @process.setFocus
+        @quit = FXButton.new(buttons, "&Quit\tStop any pending operations and exit", opts: BUTTON_NORMAL | LAYOUT_SIDE_RIGHT)
+          @quit.connect(SEL_COMMAND) { exit }
+        @reload = FXButton.new(buttons, "&Reload\tReread volumes and tasks to capture volume changes", opts: BUTTON_NORMAL | LAYOUT_SIDE_RIGHT)
+          @reload.connect(SEL_COMMAND) { reset }
+    @sensible = [@process, @reload] # Controls which must be disabled during processing
+    reset
+  end
+
+  def process
+    Bitferry.simulate = @simulate.checked?
+    Bitferry.verbosity = @verbose.checked? ? :verbose : :default
+    @progress.setBarColor(:blue)
+    @progress.progress = 0
+    @output.text = nil
+    Thread.new {
+      @app.runOnUiThread { @sensible.each(&:disable) }
+      begin
+        Bitferry.process { |total, processed, failed|
+          @app.runOnUiThread {
+            @progress.setBarColor(:red) if failed > 0
+            @progress.progress = processed
+            @progress.total = total
+          }
+        }
+      ensure
+        @app.runOnUiThread { @sensible.each(&:enable) }
+      end
+    }
+  end
+
+  def reset
+    Bitferry.restore
+    @progress.progress = 0
+    $stdout = Output.new(@app, @output)
+    Bitferry::Logging.log = log = Logger.new($stdout)
+    log.progname = :bitferryfx
+    log.level = Logger::WARN
+    #
+    @volumes.setTableSize(Bitferry::Volume.intact.size, 2)
+    @volumes.setColumnText(0, 'Volume')
+    @volumes.setColumnText(1, 'Root')
+    i = 0
+    Bitferry::Volume.intact.each do |v|
+      @volumes.setItemText(i, 0, v.tag)
+      @volumes.setItemText(i, 1, v.root.to_s)
+      i += 1
+    end
+    #
+    @tasks.setTableSize(Bitferry::Task.intact.size, 4)
+    @tasks.setColumnText(0, 'Task')
+    @tasks.setColumnText(1, 'Operation')
+    @tasks.setColumnText(2, 'Source')
+    @tasks.setColumnText(3, 'Destination')
+    i = 0
+    Bitferry::Task.intact.each do |t|
+      @tasks.setItemText(i, 0, t.tag)
+      @tasks.setItemText(i, 1, t.show_operation)
+      @tasks.setItemText(i, 2, t.source.show_status)
+      @tasks.setItemText(i, 3, t.destination.show_status)
+      i += 1
+    end
+    #
+  end
+
+  def create
+    super
+    show(PLACEMENT_SCREEN)
+  end
+
+end
+
+
+FXApp.new do |app|
+  Bitferry.verbosity = :verbose
+  Bitferry.ui = :gui
+  UI.new(app)
+  app.create
+  app.run
+end

data/lib/bitferry.rb

@@ -1,9 +1,10 @@
 require 'json'
 require 'date'
 require 'open3'
+require 'base64'
 require 'logger'
+require 'openssl'
 require 'pathname'
-require 'neatjson'
 require 'rbconfig'
 require 'fileutils'
 require 'shellwords'
@@ -12,7 +13,7 @@ require 'shellwords'
 module Bitferry
 
 
-  VERSION = '0.0.5'
+  VERSION = '0.0.7'
 
 
   module Logging
@@ -24,6 +25,7 @@ module Bitferry
       end
       @log
     end
+    def self.log=(log) @log = log end
     def log = Logging.log
   end
 
@@ -85,9 +87,11 @@ module Bitferry
   end
 
 
-  def self.process(*tags)
+  def self.intact_tasks = Volume.intact.collect { |volume| volume.intact_tasks }.flatten.uniq
+
+  def self.process(*tags, &block)
     log.info('processing tasks')
-    tasks = Volume.intact.collect { |volume| volume.intact_tasks }.flatten.uniq
+    tasks = intact_tasks
     if tags.empty?
       process = tasks
     else
@@ -102,7 +106,17 @@ module Bitferry
         end
       end
     end
-    result = process.uniq.all? { |task| task.process }
+    tasks = process.uniq
+    total = tasks.size
+    processed = 0
+    failed = 0
+    result = tasks.all? do |task|
+      r = task.process
+      processed += 1
+      failed += 1 unless r
+      yield(total, processed, failed) if block_given?
+      r
+    end
     result ? log.info('tasks processed') : log.warn('task process failure(s) reported')
     result
   end
@@ -137,6 +151,11 @@ module Bitferry
   def self.verbosity=(mode) @verbosity = mode end
 
 
+  @ui = :cli
+  def self.ui = @ui
+  def self.ui=(ui) @ui = ui end
+
+
   # Return true if run in the real Windows environment (e.g. not in real *NIX or various emulation layers such as MSYS, Cygwin etc.)
   def self.windows?
     @windows ||= /^(mingw)/.match?(RbConfig::CONFIG['target_os']) # RubyInstaller's MRI, other MinGW-build MRI
@@ -388,6 +407,7 @@ module Bitferry
 
 
     def store
+      require 'neatjson'
       tasks.each(&:commit)
       hash = JSON.neat_generate(externalize, short: false, wrap: 200, afterColon: 1, afterComma: 1)
       if Bitferry.simulate?
@@ -657,9 +677,9 @@ module Bitferry
     def self.exec(*args)
       cmd = [executable] + args
       log.debug(cmd.collect(&:shellescape).join(' '))
-      stdout, status = Open3.capture2(*cmd)
+      stdout, status = Open3.capture2e(*cmd)
       unless status.success?
-        msg = "rclone exit code #{status.to_i}"
+        msg = "rclone exit code #{status.exitstatus}"
         log.error(msg)
         raise RuntimeError, msg
       end
@@ -667,10 +687,26 @@ module Bitferry
     end
 
 
-    def self.obscure(plain) = exec('obscure', '--', plain)
+    # https://github.com/rclone/rclone/blob/master/fs/config/obscure/obscure.go
+    SECRET = "\x9c\x93\x5b\x48\x73\x0a\x55\x4d\x6b\xfd\x7c\x63\xc8\x86\xa9\x2b\xd3\x90\x19\x8e\xb8\x12\x8a\xfb\xf4\xde\x16\x2b\x8b\x95\xf6\x38"
 
 
-    def self.reveal(token) = exec('reveal', '--', token)
+    def self.obscure(plain)
+      cipher = OpenSSL::Cipher.new('AES-256-CTR')
+      cipher.encrypt
+      cipher.key = SECRET
+      Base64.urlsafe_encode64(cipher.random_iv + cipher.update(plain) + cipher.final, padding: false)
+    end
+
+
+    def self.reveal(token)
+      data = Base64.urlsafe_decode64(token)
+      cipher = OpenSSL::Cipher.new('AES-256-CTR')
+      cipher.decrypt
+      cipher.key = SECRET
+      cipher.iv = data[0...cipher.iv_len]
+      cipher.update(data[cipher.iv_len..-1]) + cipher.final
+    end
 
 
     class Encryption
@@ -872,9 +908,18 @@ module Bitferry
       def execute(*args)
         cmd = [Rclone.executable] + args
         cms = cmd.collect(&:shellescape).join(' ')
-        puts cms if Bitferry.verbosity == :verbose
+        $stdout.puts cms if Bitferry.verbosity == :verbose
         log.info(cms)
-        status = Open3.pipeline(cmd).first
+        if Bitferry.ui == :gui
+          t = nil
+          Open3.popen2e(*cmd) do |i, oe, thr|
+            while x = oe.gets; $stdout.puts(x) end
+            t = thr
+          end
+          status = t.value
+        else
+          status = Open3.pipeline(cmd).first
+        end
         raise RuntimeError, "rclone exit code #{status.exitstatus}" unless status.success?
         status.success?
       end
@@ -1058,8 +1103,9 @@ module Bitferry
       def execute(*args, simulate: false, chdir: nil)
         cmd = [Restic.executable] + args
         ENV['RESTIC_PASSWORD'] = password
+        ENV['RESTIC_PROGRESS_FPS'] = 1.to_s if Bitferry.verbosity == :verbose && Bitferry.ui == :gui
         cms = cmd.collect(&:shellescape).join(' ')
-        puts cms if Bitferry.verbosity == :verbose
+        $stdout.puts cms if Bitferry.verbosity == :verbose
         log.info(cms)
         if simulate
           log.info('(simulated)')
@@ -1068,7 +1114,16 @@ module Bitferry
           wd = Dir.getwd unless chdir.nil?
           begin
             Dir.chdir(chdir) unless chdir.nil?
-            status = Open3.pipeline(cmd).first
+            if Bitferry.ui == :gui
+              t = nil
+              Open3.popen2e(*cmd) do |i, oe, thr|
+                while x = oe.gets; $stdout.puts(x) end
+                t = thr
+              end
+              status = t.value
+            else
+              status = Open3.pipeline(cmd).first
+            end
             raise RuntimeError, "restic exit code #{status.exitstatus}" unless status.success?
             status.success?
           ensure
@@ -1147,6 +1202,10 @@ module Bitferry
       def show_direction = '-->'
 
 
+      alias :source :directory
+      alias :destination :repository
+
+
       def process
         begin
           log.info("processing task #{tag}")
@@ -1235,7 +1294,7 @@ module Bitferry
       end
 
 
-      def exclude_filters = exclude.collect { |x| ['--exclude', x]}.flatten
+      def exclude_filters = exclude.collect { |x| ['--exclude', x] }.flatten
 
 
       def show_status = "#{show_operation} #{repository.show_status} #{show_direction} #{directory.show_status} #{show_filters}"
@@ -1247,6 +1306,10 @@ module Bitferry
       def show_direction = '-->'
 
 
+      alias :destination :directory
+      alias :source :repository
+
+
       def externalize
         restic = {
           process: process_options

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bitferry
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Oleg A. Khlybov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: commonmarker
+  name: seven-zip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: archive-zip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: neatjson
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: fxruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 - !ruby/object:Gem::Dependency
   name: clamp
   requirement: !ruby/object:Gem::Requirement
@@ -84,14 +126,17 @@ description:
 email: fougas@mail.ru
 executables:
 - bitferry
+- bitferryfx
 extensions: []
 extra_rdoc_files: []
 files:
 - CHANGES.md
 - README.md
 - bin/bitferry
+- bin/bitferryfx
 - lib/bitferry.rb
 - lib/bitferry/cli.rb
+- lib/bitferry/fx.rb
 homepage: https://github.com/okhlybov/bitferry
 licenses:
 - BSD-3-Clause