ssh-hull 1.0.0

data/lib/ssh-hull/ui/helpers/tunnel_window_helper.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Helpers
+      module TunnelWindowHelper
+
+        include SSHTunnel::UI::Helpers::Common::ModalHelper
+        include SSHTunnel::UI::Helpers::Common::TranslationHelper
+        include SSHTunnel::UI::Helpers::Common::FormHelper::InstanceMethods
+
+        def self.included(base)
+          base.extend(ClassMethods)
+          base.extend(SSHTunnel::UI::Helpers::Common::FormHelper::ClassMethods)
+        end
+
+        FORM_BUTTONS = %i[submit cancel].freeze
+        FORM_FIELDS  = {
+          name: {
+            type: :text,
+          },
+          type: {
+            type: :select,
+          },
+          local_host: {
+            type: :text,
+          },
+          local_port: {
+            type: :text,
+          },
+          remote_host: {
+            type: :text,
+          },
+          remote_port: {
+            type: :text,
+          },
+          auto_start: {
+            type: :checkbox,
+          },
+        }.freeze
+
+
+        module ClassMethods
+
+          def init
+            bind_buttons(FORM_BUTTONS)
+            bind_form_fields(FORM_FIELDS.keys)
+          end
+
+        end
+
+
+        def initialize(application, window, tunnel)
+          super
+
+          # Set instance variables
+          @tunnel = tunnel
+          @host   = tunnel.parent
+
+          # Bind listeners
+          set_input_labels(scope: :tunnel)
+
+          # Load tunnels combobox
+          load_tunnels_combobox
+        end
+
+
+        private
+
+
+          def load_tunnels_combobox
+            input_type.append('local', t('form.tunnel.local'))
+            input_type.append('remote', t('form.tunnel.remote'))
+          end
+
+
+          def form_fields
+            FORM_FIELDS
+          end
+
+
+          def form_object
+            SSHTunnel::UI::Forms::TunnelForm.new(@tunnel)
+          end
+
+
+          def save_and_reload_view
+            @application.config.save!
+            close
+            @window.reload_tunnels_treeview(@host)
+          end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/models/config.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Models
+      class Config
+
+        attr_reader :file, :data, :hosts
+
+
+        def initialize(file)
+          @file = file
+          load!
+        end
+
+
+        def load!
+          @data  = load_json_file(file)
+          @hosts = load_hosts
+        end
+
+
+        def add_host(host)
+          @hosts << host
+        end
+
+
+        def remove_host(host)
+          @hosts.delete(host)
+        end
+
+
+        def save!
+          write_yaml_file(file, to_hash)
+        end
+
+
+        def to_hash
+          marshal_dump(hosts: hosts.sort_by(&:name).map(&:to_hash))
+        end
+
+
+        private
+
+
+          def load_json_file(file)
+            return hash_with_indifferent_access unless File.exist?(file)
+
+            content = File.read(file)
+            return hash_with_indifferent_access if content.empty?
+
+            hash_with_indifferent_access JSON.parse(content)
+          end
+
+
+          def load_hosts
+            (data[:hosts] || []).map do |host_attr|
+              SSHTunnel::UI::Models::Host.new(host_attr)
+            end.sort_by(&:name)
+          end
+
+
+          def write_yaml_file(file, data)
+            File.open(file, 'w+') do |f|
+              f.write JSON.pretty_generate(data)
+            end
+          end
+
+
+          def hash_with_indifferent_access(hash = {})
+            hash.with_indifferent_access
+          end
+
+
+          def marshal_dump(data = {})
+            JSON.parse(data.to_json)
+          end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/models/host.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Models
+      class Host
+
+        attr_accessor :uuid, :name, :user, :host, :port, :identity_file, :tunnels
+
+
+        def initialize(opts = {})
+          @uuid          = opts.fetch(:uuid) { SecureRandom.uuid }
+          @name          = opts.fetch(:name, '')
+          @user          = opts[:user]
+          @host          = opts[:host]
+          @port          = opts[:port]
+          @identity_file = opts[:identity_file]
+          @tunnels       = opts.fetch(:tunnels, []).map { |t_attr| Tunnel.new(t_attr.merge(parent: self)) }
+          @started       = false
+        end
+
+
+        def to_s
+          name
+        end
+
+
+        def port
+          @port.to_s
+        end
+
+
+        def to_hash
+          {
+            uuid:          uuid,
+            name:          name,
+            user:          user,
+            host:          host,
+            port:          @port,
+            identity_file: identity_file,
+            tunnels:       tunnels.sort_by(&:name).map(&:to_hash),
+          }
+        end
+
+
+        def add_tunnel(tunnel)
+          @tunnels << tunnel
+        end
+
+
+        def remove_tunnel(tunnel)
+          @tunnels.delete(tunnel)
+        end
+
+
+        def auto_start!
+          started = tunnels.map(&:auto_start!)
+          @started = started.any?
+        end
+
+
+        def started?
+          @started
+        end
+
+
+        def start_tunnels!
+          tunnels.each(&:start!)
+          @started = true
+        end
+
+
+        def stop_tunnels!
+          tunnels.each(&:stop!)
+          @started = false
+        end
+
+
+        def toggle_tunnels!
+          if started?
+            stop_tunnels!
+          else
+            start_tunnels!
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/models/tunnel.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Models
+      class Tunnel
+
+        attr_accessor :uuid, :name, :parent, :type, :local_host, :local_port, :remote_host, :remote_port, :auto_start
+
+
+        def initialize(opts = {})
+          @uuid        = opts.fetch(:uuid) { SecureRandom.uuid }
+          @name        = opts.fetch(:name, '')
+          @parent      = opts[:parent]
+          @type        = opts[:type]
+          @local_host  = opts[:local_host]
+          @local_port  = opts[:local_port]
+          @remote_host = opts[:remote_host]
+          @remote_port = opts[:remote_port]
+          @auto_start  = opts[:auto_start]
+          @process     = nil
+          @started     = false
+        end
+
+
+        def to_s
+          "#{parent} - #{name}"
+        end
+
+
+        def local_port
+          @local_port.to_s
+        end
+
+
+        def remote_port
+          @remote_port.to_s
+        end
+
+
+        def to_hash
+          {
+            uuid:        uuid,
+            name:        name,
+            type:        type,
+            local_host:  local_host,
+            local_port:  @local_port,
+            remote_host: remote_host,
+            remote_port: @remote_port,
+            auto_start:  auto_start,
+          }
+        end
+
+
+        def auto_start?
+          @auto_start == true
+        end
+
+
+        def auto_start!
+          return false unless auto_start?
+
+          start!
+          true
+        end
+
+
+        def started?
+          @started
+        end
+
+
+        def start!
+          return if started?
+
+          SSHTunnel.logger.info "Starting tunnel : #{self}"
+
+          @process = Subprocess.popen(command, stdout: '/dev/null', stderr: '/dev/null', stdin: Subprocess::PIPE)
+          @started = true
+        end
+
+
+        # See: https://www.redhat.com/archives/libvir-list/2007-September/msg00106.html
+        # to avoid zombie when terminating process
+        def stop!
+          return unless started?
+          return if @process.nil?
+
+          SSHTunnel.logger.info "Stopping tunnel : #{self}"
+
+          @process.terminate
+          @process.wait
+          @started = false
+          @process = nil
+        end
+
+
+        def command
+          cmd = [
+            '/usr/bin/ssh',
+            '-N',
+            '-t',
+            '-x',
+            '-o', 'ExitOnForwardFailure=yes',
+            "-l#{parent.user}",
+            "-L#{local_host}:#{local_port}:#{remote_host}:#{remote_port}",
+            "-p#{parent.port}"
+          ]
+
+          cmd << "-i#{parent.identity_file}" if parent.identity_file.present?
+          cmd << parent.host
+          cmd
+        end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/status_icon.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    class StatusIcon
+
+      def initialize(application, window)
+        @application = application
+        @window      = window
+        @status_icon = Gtk::StatusIcon.new
+        @menu        = Gtk::Menu.new
+
+        configure_status_icon
+        create_popup_menu
+      end
+
+
+      private
+
+
+        def configure_status_icon
+          @status_icon.icon_name = 'network-workgroup-symbolic'
+          @status_icon.signal_connect('activate') { |_icon| @window.toggle! }
+          @status_icon.signal_connect('popup-menu') { |_tray, button, time| @menu.popup(nil, nil, button, time) }
+        end
+
+
+        def create_popup_menu
+          # Build menu items
+          info = Gtk::ImageMenuItem.new(label: 'Modifier')
+          info.signal_connect('activate') { @window.show }
+
+          quit = Gtk::ImageMenuItem.new(label: 'Quitter')
+          quit.signal_connect('activate') { @application.quit }
+
+          # Create menu
+          @menu.append(info)
+          @menu.append(Gtk::SeparatorMenuItem.new)
+          @menu.append(quit)
+          @menu.show_all
+        end
+
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/about_window.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      class AboutWindow < Gtk::AboutDialog
+
+        # Register the class in the GLib world
+        type_register
+
+        class << self
+
+          def init
+            # Set the template from the resources binary
+            set_template resource: '/com/ungtb10d/ssh-hull/ui/about_window.glade'
+          end
+
+        end
+
+        include SSHTunnel::UI::Helpers::Common::TranslationHelper
+
+
+        def initialize(application)
+          super application: application
+
+          set_title t('window.about')
+        end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/application_window.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      class ApplicationWindow < Gtk::ApplicationWindow
+
+        # Register the class in the GLib world
+        type_register
+
+        class << self
+
+          def init
+            # Set the template from the resources binary
+            set_template resource: '/com/ungtb10d/ssh-hull/ui/application_window.glade'
+            super
+
+            bind_template_child 'hosts_scrolled_window'
+          end
+
+        end
+
+        include SSHTunnel::UI::Helpers::ApplicationWindowHelper
+
+
+        def initialize(application)
+          super application: application
+
+          # Set instance variables
+          @application = application
+
+          # Set window title
+          set_title 'SSH Tunnel Manager'
+
+          # Load hosts treeview
+          load_hosts_treeview
+        end
+
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/hosts/delete_window.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      module Hosts
+        class DeleteWindow < Gtk::Window
+
+          # Register the class in the GLib world
+          type_register
+
+          class << self
+
+            def init
+              # Set the template from the resources binary
+              set_template resource: '/com/ungtb10d/ssh-hull/ui/hosts/delete_window.glade'
+
+              bind_template_child 'button_submit'
+              bind_template_child 'button_cancel'
+            end
+
+          end
+
+          include SSHTunnel::UI::Helpers::Common::ModalHelper
+          include SSHTunnel::UI::Helpers::Common::TranslationHelper
+
+
+          def initialize(application, window, host)
+            super
+
+            # Set window title
+            set_title t('window.host.remove', host: host)
+
+            # Set instance variables
+            @host = host
+          end
+
+
+          private
+
+
+            def bind_submit_button
+              button_submit.label = t('button.submit')
+              button_submit.signal_connect :clicked do
+                @application.config.remove_host(@host)
+                @application.config.save!
+                @window.reload_hosts_treeview
+                close
+              end
+            end
+
+        end
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/hosts/edit_window.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      module Hosts
+        class EditWindow < Gtk::Window
+
+          # Register the class in the GLib world
+          type_register
+
+          class << self
+
+            def init
+              # Set the template from the resources binary
+              set_template resource: '/com/ungtb10d/ssh-hull/ui/hosts/edit_window.glade'
+              super
+            end
+
+          end
+
+          include SSHTunnel::UI::Helpers::HostWindowHelper
+
+
+          def initialize(application, window, host)
+            super
+
+            # Set window title
+            set_title t('window.host.edit', host: @host)
+
+            # Fills input fields
+            restore_form_values(@host)
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/hosts/new_window.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      module Hosts
+        class NewWindow < Gtk::Window
+
+          # Register the class in the GLib world
+          type_register
+
+          class << self
+
+            def init
+              # Set the template from the resources binary
+              set_template resource: '/com/ungtb10d/ssh-hull/ui/hosts/new_window.glade'
+              super
+            end
+
+          end
+
+          include SSHTunnel::UI::Helpers::HostWindowHelper
+
+
+          def initialize(application, window, host)
+            super
+
+            # Set window title
+            set_title t('window.host.new')
+          end
+
+
+          private
+
+
+            def save_and_reload_view
+              @application.config.add_host(@host)
+              super
+            end
+
+        end
+      end
+    end
+  end
+end

data/lib/ssh-hull/ui/windows/tunnels/delete_window.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module SSHTunnel
+  module UI
+    module Windows
+      module Tunnels
+        class DeleteWindow < Gtk::Window
+
+          # Register the class in the GLib world
+          type_register
+
+          class << self
+
+            def init
+              # Set the template from the resources binary
+              set_template resource: '/com/ungtb10d/ssh-hull/ui/tunnels/delete_window.glade'
+
+              bind_template_child 'button_submit'
+              bind_template_child 'button_cancel'
+            end
+
+          end
+
+          include SSHTunnel::UI::Helpers::Common::ModalHelper
+          include SSHTunnel::UI::Helpers::Common::TranslationHelper
+
+
+          def initialize(application, window, tunnel)
+            super
+
+            # Set window title
+            set_title t('window.tunnel.remove', tunnel: tunnel.name)
+
+            # Set instance variables
+            @tunnel = tunnel
+            @host   = tunnel.parent
+          end
+
+
+          private
+
+
+            def bind_submit_button
+              button_submit.label = t('button.submit')
+              button_submit.signal_connect :clicked do
+                @host.remove_tunnel(@tunnel)
+                @application.config.save!
+                @window.reload_tunnels_treeview(@host)
+                close
+              end
+            end
+
+        end
+      end
+    end
+  end
+end