ruby-pass-qt 1.0.0

data/README.md

@@ -0,0 +1,38 @@
+# Pass-Qt
+
+A simple GUI for pass on Linux.
+
+## Requirements
+
+- [Ruby 3.4+](https://www.ruby-lang.org/)
+- [Qt 6.10+](https://www.qt.io/)
+- [pass](https://www.passwordstore.org/)
+- [pwgen](https://sourceforge.net/projects/pwgen/)
+
+## Installation
+
+```console
+$ gem install pass-qt
+```
+
+## Usage
+
+To initialize the password store:
+
+```console
+$ pass init new_gpg-id_or_email
+```
+
+To launch the GUI:
+
+```console
+$ pass-qt
+```
+
+## Screenshot
+
+![screenshot](https://github.com/souk4711/ruby-pass-qt/raw/main/screenshot.png)
+
+## License
+
+Licensed under the [GPL-3.0-only](./LICENSE).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+_ = Gem::Specification.load("pass-qt.gemspec")
+
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/exe/pass-qt

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pass-qt"
+
+PassQt::Application.run

data/lib/pass-qt/app/components/passinfowidget.rb

@@ -0,0 +1,235 @@
+module PassQt
+  class PassInfoWidget < RubyQt6::Bando::QWidget
+    q_object do
+      slot "_on_copy_action_triggered()"
+      slot "_on_copy_action_triggered_otpcode()"
+      slot "_on_view_action_triggered()"
+    end
+
+    def initialize
+      super
+
+      @store = QString.new
+      @passname = QString.new
+
+      initialize_form
+      initialize_otpform
+      initialize_folderform
+      initialize_infoframe
+
+      @stackedlayout = QStackedLayout.new
+      @stackedlayout.add_widget(@form)
+      @stackedlayout.add_widget(@otpform)
+      @stackedlayout.add_widget(@folderform)
+      @stackedlayout.add_widget(@infoframe)
+
+      mainlayout = QVBoxLayout.new(self)
+      mainlayout.add_spacing(76)
+      mainlayout.add_layout(@stackedlayout)
+
+      use_infoframe
+    end
+
+    def reinitialize_passfile(store, passname)
+      @store = store
+      @passname = passname
+      use_infoframe
+
+      Pass.show(@store, @passname, on_success: ->(data) {
+        formdata = h_parse_passfile(data)
+        if formdata["password"].start_with?("otpauth:")
+          use_otpform(formdata)
+        else
+          use_form(formdata)
+        end
+      }, on_failure: ->(data) {
+        errinfo = data["stderr"]
+        use_infoframe_err(errinfo)
+      })
+    end
+
+    def reinitialize_passfolder(store, passname)
+      @store = store
+      @passname = passname
+      use_infoframe
+      use_folderform
+    end
+
+    def reinitialize_infoframe
+      @store = QString.new
+      @passname = QString.new
+      use_infoframe
+    end
+
+    private
+
+    def initialize_form
+      @passnameinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@passnameinput)
+
+      @passwordinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@passwordinput)
+      initialize_form_inputfield_viewaction(@passwordinput)
+
+      @usernameinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@usernameinput)
+
+      @websiteinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@websiteinput)
+
+      @form = QWidget.new
+      formlayout = QFormLayout.new(@form)
+      formlayout.add_row(initialize_form_label("File"), @passnameinput)
+      formlayout.add_row(initialize_form_label("Username"), @usernameinput)
+      formlayout.add_row(initialize_form_label("Password"), @passwordinput)
+      formlayout.add_row(initialize_form_label("Website"), @websiteinput)
+    end
+
+    def initialize_otpform
+      @otppassnameinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@otppassnameinput)
+
+      @otppasswordinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@otppasswordinput)
+      initialize_form_inputfield_viewaction(@otppasswordinput)
+
+      @otpcodeinput = initialize_form_inputfield
+      action = @otpcodeinput.add_action(QIcon.from_theme(QIcon::ThemeIcon::EditCopy), QLineEdit::LeadingPosition)
+      action.triggered.connect(self, :_on_copy_action_triggered_otpcode)
+
+      @otpform = QWidget.new
+      otpformlayout = QFormLayout.new(@otpform)
+      otpformlayout.add_row(initialize_form_label("File"), @otppassnameinput)
+      otpformlayout.add_row(initialize_form_label("OTP URI"), @otppasswordinput)
+      otpformlayout.add_row(initialize_form_label("OTP Code"), @otpcodeinput)
+    end
+
+    def initialize_folderform
+      @folderpassnameinput = initialize_form_inputfield
+      initialize_form_inputfield_copyaction(@folderpassnameinput)
+
+      @folderform = QWidget.new
+      folderformlayout = QFormLayout.new(@folderform)
+      folderformlayout.add_row(initialize_form_label("Folder"), @folderpassnameinput)
+    end
+
+    def initialize_form_label(text)
+      label = QLabel.new(text)
+      label.set_alignment(Qt::AlignRight)
+      label.set_style_sheet("min-width: 80px; padding-right: 4px;")
+      label
+    end
+
+    def initialize_form_inputfield
+      input = QLineEdit.new
+      input.set_read_only(true)
+      input.set_focus_policy(Qt::NoFocus)
+      input
+    end
+
+    def initialize_form_inputfield_copyaction(input)
+      action = input.add_action(QIcon.from_theme(QIcon::ThemeIcon::EditCopy), QLineEdit::LeadingPosition)
+      action.triggered.connect(self, :_on_copy_action_triggered)
+    end
+
+    def initialize_form_inputfield_viewaction(input)
+      action = input.add_action(QIcon.from_theme(QIcon::ThemeIcon::DocumentPrintPreview), QLineEdit::TrailingPosition)
+      action.triggered.connect(self, :_on_view_action_triggered)
+    end
+
+    def initialize_infoframe
+      @infolabel = QLabel.new
+      @infoframe = QWidget.new
+      infoframelayout = QVBoxLayout.new(@infoframe)
+      infoframelayout.add_widget(@infolabel)
+      infoframelayout.add_stretch
+    end
+
+    def use_form(formdata)
+      @passnameinput.set_text(@passname)
+      @passwordinput.set_text(formdata["password"])
+      @passwordinput.set_echo_mode(QLineEdit::Password)
+
+      @usernameinput.set_text(formdata["username"])
+      @websiteinput.set_text(formdata["website"])
+      @stackedlayout.set_current_widget(@form)
+    end
+
+    def use_otpform(formdata)
+      @otppassnameinput.set_text(@passname)
+      @otppasswordinput.set_text(formdata["password"])
+      @otppasswordinput.set_cursor_position(0)
+      @otppasswordinput.set_echo_mode(QLineEdit::Password)
+
+      @otpcodeinput.set_text("")
+      @stackedlayout.set_current_widget(@otpform)
+
+      Pass.otp(@store, @passname, on_success: ->(data) {
+        otpcode = data["stdout"].rstrip
+        @otpcodeinput.set_text(otpcode)
+      }, on_failure: ->(_) {})
+    end
+
+    def use_folderform
+      @folderpassnameinput.set_text(@passname)
+      @stackedlayout.set_current_widget(@folderform)
+    end
+
+    def use_infoframe(info = "")
+      @infolabel.set_style_sheet("color: black;")
+      @infolabel.set_text(info)
+      @stackedlayout.set_current_widget(@infoframe)
+    end
+
+    def use_infoframe_err(info)
+      @infolabel.set_style_sheet("color: red;")
+      @infolabel.set_text(info)
+      @stackedlayout.set_current_widget(@infoframe)
+    end
+
+    def h_parse_passfile(data)
+      lines = data["stdout"].lines
+      password = lines[0][..-2]
+
+      username = ""
+      website = ""
+      lines.each do |line|
+        matched = line.match(/\A(\w+:\s*)?(.*)\n/)
+        next if matched.nil?
+
+        case matched[1]&.rstrip&.downcase
+        when "username:" then username = matched[2]
+        when "website:" then website = matched[2]
+        end
+      end
+
+      {
+        "password" => password,
+        "username" => username,
+        "website" => website
+      }
+    end
+
+    def _on_copy_action_triggered
+      input = sender.parent
+      QApplication.clipboard.set_text(input.text)
+    end
+
+    def _on_copy_action_triggered_otpcode
+      Pass.otp(@store, @passname, on_success: ->(data) {
+        otpcode = data["stdout"].rstrip
+        @otpcodeinput.set_text(otpcode)
+        QApplication.clipboard.set_text(otpcode)
+      }, on_failure: ->(_) {})
+    end
+
+    def _on_view_action_triggered
+      input = sender.parent
+      case input.echo_mode
+      when QLineEdit::Normal then input.set_echo_mode(QLineEdit::Password)
+      when QLineEdit::Password then input.set_echo_mode(QLineEdit::Normal)
+      else raise "unreachable!"
+      end
+    end
+  end
+end

data/lib/pass-qt/app/components/passlistwidget/treewidget.rb

@@ -0,0 +1,240 @@
+module PassQt
+  class PassListWidget < RubyQt6::Bando::QWidget
+    class TreeWidget < RubyQt6::Bando::QTreeWidget
+      DataItem = Struct.new(:passname, :treewidgetitem)
+
+      q_object do
+        signal "store_changed(QString)"
+        signal "passfile_selected(QString,QString)"
+        signal "passfolder_selected(QString,QString)"
+        slot "_on_item_clicked(QTreeWidgetItem*,int)"
+        slot "_on_new_password_action_triggered()"
+        slot "_on_new_otp_action_triggered()"
+        slot "_on_delete_action_triggered()"
+        slot "_on_refresh_action_triggered()"
+        slot "_on_open_action_triggered()"
+      end
+
+      def initialize
+        super
+
+        @store = QString.new
+        @dataitems = {}
+
+        initialize_actions
+        initialize_fileiconprovider
+
+        item_clicked.connect(self, :_on_item_clicked)
+      end
+
+      def context_menu_event(evt)
+        menu = QMenu.new("", self)
+
+        menu.add_action(@new_password_action)
+        menu.add_action(@new_otp_action)
+        menu.add_action(@delete_action)
+
+        menu.add_separator
+        menu.add_action(@refresh_action)
+        menu.add_action(@open_action)
+
+        enabled = !selected_items.empty?
+        @delete_action.set_enabled(enabled)
+
+        menu.exec(evt.global_pos)
+      end
+
+      def reinitialize_store(store)
+        clear
+
+        @store = store
+        @dataitems = {}
+
+        store_root_path = QDir.new(@store)
+        dirs = [store]
+        until dirs.empty?
+          dir = dirs.shift
+          diritem = @dataitems[dir]&.treewidgetitem || invisible_root_item
+
+          entry_list = QDir.new(dir).entry_info_list(QDir::Dirs | QDir::Files | QDir::NoDotAndDotDot)
+          entry_list.each do |entry|
+            filepath = entry.absolute_file_path
+            next if @dataitems.key?(filepath)
+
+            if entry.dir?
+              dirs << filepath
+              passname = store_root_path.relative_file_path(filepath)
+            elsif entry.file?
+              next unless h_passfile?(entry)
+              passname = store_root_path.relative_file_path(filepath)
+              passname = passname[0, passname.size - entry.suffix.size - 1]
+            else
+              next
+            end
+
+            item = QTreeWidgetItem.new(diritem, QStringList.new << entry.complete_base_name << filepath)
+            item.set_icon(0, @fileiconprovider.icon(entry))
+            @dataitems[filepath] = DataItem.new(passname, item)
+          end
+        end
+
+        expand_all
+        store_changed.emit(@store)
+      end
+
+      def update_passname_filter(text)
+        if text.empty?
+          @dataitems.each do |_, item|
+            item.treewidgetitem.set_hidden(false)
+            item.treewidgetitem.set_selected(false)
+          end
+          return
+        end
+
+        re_options = QRegularExpression::UnanchoredWildcardConversion | QRegularExpression::NonPathWildcardConversion
+        re = QRegularExpression.from_wildcard(text, nil, re_options)
+
+        filepath_matched = Set.new
+        filepath_matched_1st = nil
+        @dataitems.each do |filepath, item|
+          has_match = re.match(item.passname).has_match
+          next unless has_match
+
+          if filepath_matched_1st.nil?
+            filepath_matched_1st = filepath if h_passfile?(filepath)
+          end
+
+          loop do
+            filepath_matched << filepath
+            filepath = QFileInfo.new(filepath).absolute_path
+            break unless @dataitems.key?(filepath)
+          end
+        end
+
+        @dataitems.each do |filepath, item|
+          visible = filepath_matched.include?(filepath)
+          item.treewidgetitem.set_hidden(!visible)
+
+          selected = filepath_matched_1st == filepath
+          item.treewidgetitem.set_selected(selected)
+        end
+      end
+
+      private
+
+      def initialize_actions
+        @new_password_action = initialize_actions_act(QIcon::ThemeIcon::DocumentNew, "New Password", :_on_new_password_action_triggered)
+        @new_otp_action = initialize_actions_act(QIcon::ThemeIcon::DocumentNew, "New OTP", :_on_new_otp_action_triggered)
+        @delete_action = initialize_actions_act(QIcon::ThemeIcon::EditDelete, "Delete", :_on_delete_action_triggered)
+        @refresh_action = initialize_actions_act(QIcon::ThemeIcon::ViewRefresh, "Refresh", :_on_refresh_action_triggered)
+        @open_action = initialize_actions_act(QIcon::ThemeIcon::FolderVisiting, "Open Store With File Explorer", :_on_open_action_triggered)
+      end
+
+      def initialize_actions_act(icon, text, slot)
+        action = QAction.new(QIcon.from_theme(icon), text, self)
+        action.triggered.connect(self, slot)
+        action
+      end
+
+      def initialize_fileiconprovider
+        @fileiconprovider = QFileIconProvider.new
+      end
+
+      def reinitialize(selected_passname: "")
+        reinitialize_store(@store)
+
+        @dataitems.each do |_, item|
+          if item.passname == selected_passname
+            item.treewidgetitem.set_selected(true)
+            break
+          end
+        end
+      end
+
+      def h_passfile?(fileinfo)
+        case fileinfo
+        when QFileInfo then fileinfo.suffix.downcase == "gpg"
+        when QString then fileinfo.ends_with(".gpg", Qt::CaseInsensitive)
+        else raise "unreachable!"
+        end
+      end
+
+      def h_folderpath(fileinfo)
+        folder = fileinfo.dir? ? fileinfo.absolute_file_path : fileinfo.absolute_path
+        QDir.new(@store).relative_file_path(folder)
+      end
+
+      def _on_item_clicked(item, _column)
+        filepath = item.data(1, Qt::DisplayRole).value
+        dataitem = @dataitems[filepath]
+        h_passfile?(filepath) ?
+          passfile_selected.emit(@store, dataitem.passname) :
+          passfolder_selected.emit(@store, dataitem.passname)
+      end
+
+      def _on_new_password_action_triggered
+        item = selected_items[0]
+        if item
+          filepath = item.data(1, Qt::DisplayRole).value
+          folder = h_folderpath(QFileInfo.new(filepath))
+          folder = "" if folder == "."
+        else
+          folder = ""
+        end
+
+        dialog = NewPasswordDialog.new(@store, folder, on_success: ->(passname) {
+          reinitialize(selected_passname: passname)
+        })
+        dialog.show
+      end
+
+      def _on_new_otp_action_triggered
+        item = selected_items[0]
+        if item
+          filepath = item.data(1, Qt::DisplayRole).value
+          folder = h_folderpath(QFileInfo.new(filepath))
+          folder = "" if folder == "."
+        else
+          folder = ""
+        end
+
+        dialog = NewOneTimePasswordDialog.new(@store, folder, on_success: ->(passname) {
+          reinitialize(selected_passname: passname)
+        })
+        dialog.show
+      end
+
+      def _on_delete_action_triggered
+        item = selected_items[0]
+        filepath = item.data(1, Qt::DisplayRole).value
+        dataitem = @dataitems[filepath]
+
+        message = "<p>Do you really want to delete this item?</p>#{dataitem.passname}"
+        reply = QMessageBox.question(self, "", message)
+        return if reply == QMessageBox::No
+
+        file = QFile.new(filepath)
+        file.move_to_trash
+        reinitialize
+      end
+
+      def _on_refresh_action_triggered
+        item = selected_items[0]
+        if item
+          filepath = item.data(1, Qt::DisplayRole).value
+          dataitem = @dataitems[filepath]
+          passname = dataitem.passname
+        else
+          passname = ""
+        end
+
+        reinitialize(selected_passname: passname)
+      end
+
+      def _on_open_action_triggered
+        url = QUrl.from_local_file(@store)
+        QDesktopServices.open_url(url)
+      end
+    end
+  end
+end

data/lib/pass-qt/app/components/passlistwidget.rb

@@ -0,0 +1,91 @@
+require_relative "passlistwidget/treewidget"
+
+module PassQt
+  class PassListWidget < RubyQt6::Bando::QWidget
+    q_object do
+      signal "store_changed(QString)"
+      signal "passfile_selected(QString,QString)"
+      signal "passfolder_selected(QString,QString)"
+      slot "_on_combobox_current_text_changed(QString)"
+      slot "_on_searchbar_text_changed(QString)"
+      slot "_on_treewidget_store_changed(QString)"
+    end
+
+    def initialize
+      super
+
+      initialize_combobox
+      initialize_searchbar
+      initialize_treewidget
+
+      mainlayout = QVBoxLayout.new(self)
+      mainlayout.add_layout(@comboboxlayout)
+      mainlayout.add_widget(@searchbar)
+      mainlayout.add_widget(@treewidget)
+
+      update_combobox
+    end
+
+    def reinitialize_stores
+      @combobox.block_signals(true).tap do |blocked|
+        @combobox.clear
+      ensure
+        @combobox.block_signals(blocked)
+      end
+
+      update_combobox
+    end
+
+    private
+
+    def initialize_combobox
+      @combobox = QComboBox.new
+      @combobox.current_text_changed.connect(self, :_on_combobox_current_text_changed)
+
+      @comboboxlayout = QHBoxLayout.new
+      @comboboxlayout.add_widget(QLabel.new("Current Store"))
+      @comboboxlayout.add_widget(@combobox)
+      @comboboxlayout.set_stretch(0, 2)
+      @comboboxlayout.set_stretch(1, 3)
+    end
+
+    def initialize_searchbar
+      @searchbar = QLineEdit.new
+      @searchbar.set_clear_button_enabled(true)
+      @searchbar.set_placeholder_text("List passwords that match passname...")
+      @searchbar.text_changed.connect(self, :_on_searchbar_text_changed)
+    end
+
+    def initialize_treewidget
+      @treewidget = TreeWidget.new
+      @treewidget.set_header_hidden(true)
+      @treewidget.store_changed.connect(self, :_on_treewidget_store_changed)
+      @treewidget.passfile_selected.connect(self, :passfile_selected)
+      @treewidget.passfolder_selected.connect(self, :passfolder_selected)
+    end
+
+    def update_combobox
+      PassQt.settings.GET_stores.each do |store|
+        fileinfo = QFileInfo.new(store["fullpath"])
+        @combobox.add_item(fileinfo.file_name, QVariant.new(fileinfo.absolute_file_path))
+      end
+    end
+
+    def _on_combobox_current_text_changed(_text)
+      store = @combobox.current_data.value
+      @treewidget.reinitialize_store(store)
+
+      @searchbar.clear
+      QTimer.single_shot(0, @searchbar, :set_focus)
+    end
+
+    def _on_searchbar_text_changed(text)
+      @treewidget.update_passname_filter(text)
+    end
+
+    def _on_treewidget_store_changed(store)
+      @searchbar.clear
+      store_changed.emit(store)
+    end
+  end
+end

data/lib/pass-qt/app/components.rb

@@ -0,0 +1,2 @@
+require_relative "components/passinfowidget"
+require_relative "components/passlistwidget"