27629875352

Committed 16 Jun 2026 03:46PM UTC coverage: 57.471% (-0.06%) from 57.526%

Build # 27629875352

Build Type

Pull #1550

github

Committed by

web-flow

Commit Message

Merge d5a106b1a into 156c096e8

Pull Request Pull Request #1550: refactor(executor): replace QStringList env with QProcessEnvironment (#1510)

Coverage Stats

18 of 21 new or added lines in 5 files covered. (85.71%)

74 existing lines in 2 files now uncovered.

3977 of 6920 relevant lines covered (57.47%)

31.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

27.97

/src/mainwindow.cpp

// SPDX-FileCopyrightText: 2014 Anne Jan Brouwer
// SPDX-License-Identifier: GPL-3.0-or-later
#include "mainwindow.h"

#ifdef QT_DEBUG
#include "debughelper.h"
#endif

#include "configdialog.h"
#include "enums.h"
#include "executor.h"
#include "exportpublickeydialog.h"
#include "filecontent.h"
#include "passworddialog.h"
#include "passworddisplaypanel.h"
#include "pathvalidator.h"
#include "qpushbuttonasqrcode.h"
#include "qpushbuttonshowpassword.h"
#include "qpushbuttonwithclipboard.h"
#include "qtpass.h"
#include "qtpasssettings.h"
#include "templateio.h"
#include "trayicon.h"
#include "ui_mainwindow.h"
#include "usersdialog.h"
#include "util.h"
#include <QApplication>
#include <QCloseEvent>
#include <QDesktopServices>
#include <QDialog>
#include <QDirIterator>
#include <QDockWidget>
#include <QFileInfo>
#include <QHBoxLayout>
#include <QInputDialog>
#include <QLabel>
#include <QLineEdit>
#include <QMenu>
#include <QMessageBox>
#include <QPushButton>
#include <QScrollBar>
#include <QShortcut>
#include <QTextCursor>
#include <QTextEdit>
#include <QTimer>
#include <QToolButton>
#include <QTreeWidget>
#include <QUrl>
#include <utility>

/**
 * @brief MainWindow::MainWindow handles all of the main functionality and also
 * the main window.
 * @param searchText for searching from cli
 * @param parent pointer
 */
MainWindow::MainWindow(const QString &searchText, QWidget *parent)
    : QMainWindow(parent), ui(new Ui::MainWindow) {
#ifdef __APPLE__
  // extra treatment for mac os
  // see http://doc.qt.io/qt-5/qkeysequence.html#qt_set_sequence_auto_mnemonic
  qt_set_sequence_auto_mnemonic(true);
#endif
  ui->setupUi(this);

  m_qtPass = new QtPass(this);

  // register shortcut ctrl/cmd + Q to close the main window
  new QShortcut(QKeySequence(Qt::CTRL | Qt::Key_Q), this, SLOT(close()));
  // register shortcut ctrl/cmd + C to copy the currently selected password
  new QShortcut(QKeySequence(QKeySequence::StandardKey::Copy), this,
                SLOT(copyPasswordFromTreeview()));

  model.setNameFilters(QStringList() << "*.gpg");
  model.setNameFilterDisables(false);

  /*
   * I added this to solve Windows bug but now on GNU/Linux the main folder,
   * if hidden, disappear
   *
   * model.setFilter(QDir::NoDot);
   */

  QString passStore = QtPassSettings::getPassStore(Util::findPasswordStore());

  QModelIndex rootDir = model.setRootPath(passStore);
  model.fetchMore(rootDir);

  proxyModel.setModelAndStore(&model, passStore);
  selectionModel.reset(new QItemSelectionModel(&proxyModel));

  ui->treeView->setModel(&proxyModel);
  ui->treeView->setRootIndex(proxyModel.mapFromSource(rootDir));
  ui->treeView->setColumnHidden(1, true);
  ui->treeView->setColumnHidden(2, true);
  ui->treeView->setColumnHidden(3, true);
  ui->treeView->setHeaderHidden(true);
  ui->treeView->setIndentation(15);
  ui->treeView->setHorizontalScrollBarPolicy(Qt::ScrollBarAsNeeded);
  ui->treeView->setContextMenuPolicy(Qt::CustomContextMenu);
  ui->treeView->header()->setSectionResizeMode(0, QHeaderView::Stretch);
  ui->treeView->sortByColumn(0, Qt::AscendingOrder);
  connect(ui->treeView, &QWidget::customContextMenuRequested, this,
          &MainWindow::showContextMenu);
  connect(ui->treeView, &DeselectableTreeView::emptyClicked, this,
          &MainWindow::deselect);

  if (QtPassSettings::isUseMonospace()) {
    QFont monospace("Monospace");
    monospace.setStyleHint(QFont::Monospace);
    ui->textBrowser->setFont(monospace);
  }
  if (QtPassSettings::isNoLineWrapping()) {
    ui->textBrowser->setLineWrapMode(QTextBrowser::NoWrap);
  }
  ui->textBrowser->setOpenExternalLinks(true);
  ui->textBrowser->setContextMenuPolicy(Qt::CustomContextMenu);
  connect(ui->textBrowser, &QWidget::customContextMenuRequested, this,
          &MainWindow::showBrowserContextMenu);

  updateProfileBox();

  m_displayPanel = new PasswordDisplayPanel(
      ui->gridLayout, ui->verticalLayoutPassword, this, this);
  connect(m_displayPanel, &PasswordDisplayPanel::copyRequested, m_qtPass,
          &QtPass::copyTextToClipboard);
  connect(m_displayPanel, &PasswordDisplayPanel::qrRequested, m_qtPass,
          &QtPass::showTextAsQRCode);

  QtPassSettings::getPass()->updateEnv();
  clearPanelTimer.setInterval(MS_PER_SECOND *
                              QtPassSettings::getAutoclearPanelSeconds());
  clearPanelTimer.setSingleShot(true);
  connect(&clearPanelTimer, &QTimer::timeout, this, [this]() { clearPanel(); });

  searchTimer.setInterval(350);
  searchTimer.setSingleShot(true);

  connect(&searchTimer, &QTimer::timeout, this, &MainWindow::onTimeoutSearch);

  // Install the search-box key filter once, not on every setUiElementsEnabled
  // call.
  ui->lineEdit->installEventFilter(this);

  // Safety net: if a backend operation disables the UI but never signals
  // completion, re-enable after a timeout so the window can't get stuck.
  m_uiWatchdog.setSingleShot(true);
  m_uiWatchdog.setInterval(UiWatchdogMs);
  connect(&m_uiWatchdog, &QTimer::timeout, this, [this]() {
    showStatusMessage(tr("Operation timed out; re-enabling interface."));
    setUiElementsEnabled(true);
  });

  initToolBarButtons();
  initStatusBar();
  initProcessOutputPanel();

  connect(QtPassSettings::getPass(), &Pass::finishedAnyWithPid, this,
          [this](const QString &out, const QString &err, Enums::PROCESS pid) {
            // Never route potentially-secret output through the panel:
            // - PASS_SHOW / PASS_OTP_GENERATE go via dedicated signals to
            //   the main text browser (which clears on a timer).
            // - PASS_GREP returns lines from password files; #252 must
            //   not leak those into a long-lived panel.
            // - PASS_INSERT's stdin is the password; stdout normally
            //   carries gpg/git progress only, but exclude defensively
            //   in case a future code path uses --echo or similar.
            if (isSensitiveProcess(pid)) {
              return;
            }
            if (!out.isEmpty()) {
              onProcessOutput(out, false, pid);
            }
            if (!err.isEmpty()) {
              onProcessOutput(err, true, pid);
            }
          });

  ui->lineEdit->setClearButtonEnabled(true);
  updateGrepButtonVisibility();

  setUiElementsEnabled(true);

  ui->lineEdit->setText(searchText);

  if (!m_qtPass->init()) {
    // no working config so this should just quit
    QApplication::quit();
    return;
  }

  // Initial focus is handled in showEvent() once the window is actually
  // mapped. Scheduling it here via a 10 ms QTimer was racy: if the timer
  // fires while the window has not yet been realised — e.g. an
  // ActivationChange queued by main()'s `activateWindow()` call before
  // `show()`, or a nested QDialog::exec() inside init() — the
  // QLineEdit's internal text engine hasn't been wired up and
  // selectAll() segfaults inside Qt (see #1187, #1188).
}

MainWindow::~MainWindow() { delete m_qtPass; }

/**
 * @brief MainWindow::focusInput selects any text (if applicable) in the search
 * box and sets focus to it. Allows for easy searching, called at application
 * start and when receiving empty message in MainWindow::messageAvailable when
 * compiled with SINGLE_APP=1 (default).
 */
void MainWindow::focusInput() {
  // Resolve the QLineEdit through the live widget tree rather than the
  // cached `ui->lineEdit` pointer.
  //
  // On a fresh-config first launch the constructor calls
  // `m_qtPass->init()` → `MainWindow::config()`, and `config()`'s
  // `applyWindowFlagsSettings()` does `setWindowFlags(...)` + `show()`
  // on the main window. `setWindowFlags` on a top-level widget rebuilds
  // the native window via `setParent(nullptr, flags)`; under Qt 6.11
  // we observed the QLineEdit attached to the centralWidget gets
  // destroyed in that rebuild while `ui->lineEdit` still holds its old
  // address — leading to a SIGSEGV inside `QWidget::testAttribute`
  // (called from `QLineEdit::isVisible` / `selectAll`). `findChild<>()`
  // walks the current hierarchy and returns null cleanly when the
  // widget is gone, so `focusInput` becomes a safe no-op instead of a
  // use-after-free.
  if (!isVisible()) {
    return;
  }
  auto *lineEdit = findChild<QLineEdit *>(QStringLiteral("lineEdit"));
  if (lineEdit == nullptr || !lineEdit->isVisible()) {
    return;
  }
  lineEdit->selectAll();
  lineEdit->setFocus();
  // Only mark the first-show focus pulse as done once it's actually
  // landed; setting it eagerly in showEvent() would consume the
  // one-shot if focusInput returned early (mid-rebuild widget state)
  // and we'd never retry.
  m_firstShowCompleted = true;
}

/**
 * @brief MainWindow::changeEvent sets focus to the search box
 * @param event
 */
void MainWindow::changeEvent(QEvent *event) {
  QWidget::changeEvent(event);
  if (event->type() == QEvent::ActivationChange && isActiveWindow() &&
      isVisible()) {
    // Defer one event-loop tick so the synchronous activation dispatch
    // chain (`QApplicationPrivate::setActiveWindow` → `notify_helper`)
    // unwinds before we touch widget state — calling `focusInput()`
    // inline from this stack has segfaulted in past iterations because
    // mid-rebuild ui state isn't fully wired up yet.
    QMetaObject::invokeMethod(this, &MainWindow::focusInput,
                              Qt::QueuedConnection);
  }
}

/**
 * @brief First-show hook: run the initial focusInput() pulse once the
 *        window is actually mapped. The widget's internal data is fully
 *        initialised by this point, so QLineEdit::selectAll() is safe.
 * @param event Show event passed to the base class.
 */
void MainWindow::showEvent(QShowEvent *event) {
  QMainWindow::showEvent(event);
  if (m_firstShowCompleted) {
    return;
  }
  // Queue the focus pulse for the next event-loop tick so the platform
  // map round-trip and any pending widget rebuilds (e.g. setWindowFlags
  // from the config wizard path) settle before we look up the line
  // edit. The `m_firstShowCompleted` latch is set inside focusInput()
  // *after* it actually focuses, so a transient failed lookup just
  // re-queues on the next show rather than silently dropping.
  QMetaObject::invokeMethod(this, &MainWindow::focusInput,
                            Qt::QueuedConnection);
}

/**
 * @brief MainWindow::initToolBarButtons init main ToolBar and connect actions
 */
void MainWindow::initToolBarButtons() {
  connect(ui->actionAddPassword, &QAction::triggered, this,
          &MainWindow::addPassword);
  connect(ui->actionAddFolder, &QAction::triggered, this,
          &MainWindow::addFolder);
  connect(ui->actionEdit, &QAction::triggered, this, &MainWindow::onEdit);
  connect(ui->actionDelete, &QAction::triggered, this, &MainWindow::onDelete);
  connect(ui->actionPush, &QAction::triggered, this, &MainWindow::onPush);
  connect(ui->actionUpdate, &QAction::triggered, this, &MainWindow::onUpdate);
  connect(ui->actionUsers, &QAction::triggered, this, &MainWindow::onUsers);
  connect(ui->actionConfig, &QAction::triggered, this, &MainWindow::onConfig);
  connect(ui->actionOtp, &QAction::triggered, this, &MainWindow::onOtp);

  ui->actionAddPassword->setIcon(
      QIcon::fromTheme("document-new", QIcon(":/icons/document-new.svg")));
  ui->actionAddFolder->setIcon(
      QIcon::fromTheme("folder-new", QIcon(":/icons/folder-new.svg")));
  ui->actionEdit->setIcon(QIcon::fromTheme(
      "document-properties", QIcon(":/icons/document-properties.svg")));
  ui->actionDelete->setIcon(
      QIcon::fromTheme("edit-delete", QIcon(":/icons/edit-delete.svg")));
  ui->actionPush->setIcon(
      QIcon::fromTheme("go-up", QIcon(":/icons/go-top.svg")));
  ui->actionUpdate->setIcon(
      QIcon::fromTheme("go-down", QIcon(":/icons/go-bottom.svg")));
  ui->actionUsers->setIcon(QIcon::fromTheme(
      "x-office-address-book", QIcon(":/icons/x-office-address-book.svg")));
  ui->actionConfig->setIcon(QIcon::fromTheme(
      "applications-system", QIcon(":/icons/applications-system.svg")));
}

/**
 * @brief MainWindow::initStatusBar init statusBar with default message and logo
 */
void MainWindow::initStatusBar() {
  ui->statusBar->showMessage(tr("Welcome to QtPass %1").arg(VERSION), 2000);

  QPixmap logo = QPixmap::fromImage(QImage(":/artwork/icon.svg"))
                     .scaledToHeight(statusBar()->height());
  auto *logoApp = new QLabel(statusBar());
  logoApp->setPixmap(logo);
  statusBar()->addPermanentWidget(logoApp);
}

/**
 * @brief Build the process-output panel as a bottom QDockWidget.
 *
 * The panel is constructed programmatically rather than declared in
 * mainwindow.ui: uic only places QMainWindow's top-level children into
 * the centralWidget / statusBar / menuBar / toolBars / dock-widget
 * slots, and the previous home (statusBar()->addPermanentWidget()) made
 * an 80–150 px tall QTextEdit sit inside what is otherwise a thin
 * status row. A QDockWidget at the bottom dock area is the conventional
 * place for an IDE-style output console, and it gives users
 * detach/move for free.
 */
void MainWindow::initProcessOutputPanel() {
  m_processOutputWidget = new QWidget;
  m_processOutputWidget->setObjectName(QStringLiteral("processOutputWidget"));
  auto *outputLayout = new QHBoxLayout(m_processOutputWidget);
  outputLayout->setObjectName(QStringLiteral("processOutputLayout"));
  outputLayout->setContentsMargins(0, 0, 0, 0);
  m_clearOutputButton = new QToolButton(m_processOutputWidget);
  m_clearOutputButton->setObjectName(QStringLiteral("clearOutputButton"));
  m_clearOutputButton->setText(tr("Clear"));
  m_clearOutputButton->setToolTip(tr("Clear output"));
  outputLayout->addWidget(m_clearOutputButton);
  m_processOutputEdit = new QTextEdit(m_processOutputWidget);
  m_processOutputEdit->setObjectName(QStringLiteral("processOutputEdit"));
  m_processOutputEdit->setReadOnly(true);
  m_processOutputEdit->setAcceptRichText(false);
  outputLayout->addWidget(m_processOutputEdit);

  m_processOutputDock = new QDockWidget(tr("Process Output"), this);
  m_processOutputDock->setObjectName(QStringLiteral("processOutputDock"));
  m_processOutputDock->setFeatures(QDockWidget::DockWidgetMovable |
                                   QDockWidget::DockWidgetFloatable);
  m_processOutputDock->setAllowedAreas(Qt::BottomDockWidgetArea |
                                       Qt::TopDockWidgetArea);
  m_processOutputDock->setWidget(m_processOutputWidget);
  addDockWidget(Qt::BottomDockWidgetArea, m_processOutputDock);
  // setVisible after addDockWidget so our explicit preference wins
  // even if QMainWindow applies any cached state when the dock is
  // attached. restoreWindow() runs before this method (it's called
  // from the QtPass ctor, which is constructed at the top of the
  // MainWindow ctor), so the saved layout has already been processed
  // by the time we get here.
  m_processOutputDock->setVisible(QtPassSettings::isShowProcessOutput());

  connect(m_clearOutputButton, &QToolButton::clicked, this,
          &MainWindow::on_clearOutputButton_clicked);

  // Hysteresis: while the user is actively dragging the slider, don't
  // touch m_autoScroll on every tick — a brief overshoot at maximum
  // would silently re-arm auto-scroll without an explicit release. Only
  // commit on slider release. Wheel/keyboard scroll never sets
  // isSliderDown(), so they still update immediately.
  connect(m_processOutputEdit->verticalScrollBar(), &QScrollBar::valueChanged,
          this, [this]() {
            auto *sb = m_processOutputEdit->verticalScrollBar();
            if (sb->isSliderDown())
              return;
            m_autoScroll = sb->value() >= sb->maximum();
          });
  connect(m_processOutputEdit->verticalScrollBar(), &QScrollBar::sliderReleased,
          this, [this]() {
            auto *sb = m_processOutputEdit->verticalScrollBar();
            m_autoScroll = sb->value() >= sb->maximum();
          });
}

auto MainWindow::getCurrentTreeViewIndex() -> QModelIndex {
  return ui->treeView->currentIndex();
}

void MainWindow::cleanKeygenDialog() {
  if (m_keyGenDialog != nullptr) {
    m_keyGenDialog->close();
  }
  m_keyGenDialog = nullptr;
}

/**
 * @brief Displays the given text in the main window text browser, optionally
 * marking it as an error and/or rendering it as HTML.
 * @example
 * MainWindow window;
 * window.flashText("Operation completed.", false, false);
 *
 * @param const QString &text - The text content to display.
 * @param const bool isError - If true, sets the text color to red before
 * displaying the text.
 * @param const bool isHtml - If true, treats the text as HTML and appends it to
 * the existing HTML content.
 * @return void - No return value.
 */
void MainWindow::flashText(const QString &text, const bool isError,
                           const bool isHtml) {
  if (isError) {
    ui->textBrowser->setTextColor(Qt::red);
  }

  if (isHtml) {
    QString _text = text;
    if (!ui->textBrowser->toPlainText().isEmpty()) {
      _text = ui->textBrowser->toHtml() + _text;
    }
    ui->textBrowser->setHtml(_text);
  } else {
    ui->textBrowser->setText(text);
  }
}

/**
 * @brief MainWindow::config pops up the configuration screen and handles all
 * inter-window communication
 */
void MainWindow::applyTextBrowserSettings() {
  if (QtPassSettings::isUseMonospace()) {
    QFont monospace("Monospace");
    monospace.setStyleHint(QFont::Monospace);
    ui->textBrowser->setFont(monospace);
  } else {
    ui->textBrowser->setFont(QFont());
  }

  if (QtPassSettings::isNoLineWrapping()) {
    ui->textBrowser->setLineWrapMode(QTextBrowser::NoWrap);
  } else {
    ui->textBrowser->setLineWrapMode(QTextBrowser::WidgetWidth);
  }
}

void MainWindow::applyWindowFlagsSettings() {
  if (QtPassSettings::isAlwaysOnTop()) {
    Qt::WindowFlags flags = windowFlags();
    this->setWindowFlags(flags | Qt::WindowStaysOnTopHint);
  } else {
    this->setWindowFlags(Qt::Window);
  }
  this->show();
}

/**
 * @brief Opens and processes the application configuration dialog, then applies
 * any accepted settings.
 * @example
 * config();
 *
 * @return void - This function does not return a value.
 */
void MainWindow::config() {
  QScopedPointer<ConfigDialog> d(new ConfigDialog(this));
  d->setModal(true);
  // Automatically default to pass if it's available
  if (m_qtPass->isFreshStart() &&
      QFile(QtPassSettings::getPassExecutable()).exists()) {
    QtPassSettings::setUsePass(true);
  }

  if (m_qtPass->isFreshStart()) {
    d->wizard(); // run initial setup wizard for first-time configuration
  }
  if (d->exec()) {
    if (d->result() == QDialog::Accepted) {
      applyTextBrowserSettings();
      applyWindowFlagsSettings();

      updateProfileBox();
      const QString passStore = QtPassSettings::getPassStore();
      proxyModel.setStore(passStore);
      ui->treeView->setRootIndex(proxyModel.rootIndexFor(passStore));
      deselect();
      ui->treeView->setCurrentIndex(QModelIndex());

      if (m_qtPass->isFreshStart() && !Util::configIsValid()) {
        config();
      }
      QtPassSettings::getPass()->updateEnv();
      clearPanelTimer.setInterval(MS_PER_SECOND *
                                  QtPassSettings::getAutoclearPanelSeconds());
      m_qtPass->setClipboardTimer();

      updateGitButtonVisibility();
      updateOtpButtonVisibility();
      updateGrepButtonVisibility();
      updateProcessOutputVisibility();
      if (QtPassSettings::isUseTrayIcon() && m_tray == nullptr) {
        initTrayIcon();
      } else if (!QtPassSettings::isUseTrayIcon() && m_tray != nullptr) {
        destroyTrayIcon();
      }
    }

    m_qtPass->setFreshStart(false);
  }
}

/**
 * @brief MainWindow::onUpdate do a git pull
 */
void MainWindow::onUpdate(bool block) {
  ui->statusBar->showMessage(tr("Updating password-store"), 2000);
  if (block) {
    QtPassSettings::getPass()->GitPull_b();
  } else {
    QtPassSettings::getPass()->GitPull();
  }
}

/**
 * @brief MainWindow::onPush do a git push
 */
void MainWindow::onPush() {
  if (QtPassSettings::isUseGit()) {
    ui->statusBar->showMessage(tr("Updating password-store"), 2000);
    QtPassSettings::getPass()->GitPush();
  }
}

/**
 * @brief MainWindow::getFile get the selected file path
 * @param index
 * @param forPass returns relative path without '.gpg' extension
 * @return path
 * @return
 */
auto MainWindow::getFile(const QModelIndex &index, bool forPass) -> QString {
  if (!index.isValid() ||
      !model.fileInfo(proxyModel.mapToSource(index)).isFile()) {
    return {};
  }
  QString filePath = model.filePath(proxyModel.mapToSource(index));
  if (forPass) {
    filePath = QDir(QtPassSettings::getPassStore()).relativeFilePath(filePath);
    filePath.replace(Util::endsWithGpg(), "");
  }
  return filePath;
}

/**
 * @brief MainWindow::on_treeView_clicked read the selected password file
 * @param index
 */
void MainWindow::on_treeView_clicked(const QModelIndex &index) {
  bool cleared = ui->treeView->currentIndex().flags() == Qt::NoItemFlags;
  m_currentDir =
      Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel);
  // Clear any previously cached clipped text before showing new password
  m_qtPass->clearClippedText();
  QString file = getFile(index, true);
  ui->passwordName->setText(file);
  if (!file.isEmpty() && !cleared) {
    QtPassSettings::getPass()->Show(file);
  } else {
    clearPanel(false);
    ui->actionEdit->setEnabled(false);
    ui->actionDelete->setEnabled(true);
  }
}

/**
 * @brief MainWindow::on_treeView_doubleClicked when doubleclicked on
 * TreeViewItem, open the edit Window
 * @param index
 */
void MainWindow::on_treeView_doubleClicked(const QModelIndex &index) {
  QFileInfo fileOrFolder =
      model.fileInfo(proxyModel.mapToSource(ui->treeView->currentIndex()));

  if (fileOrFolder.isFile()) {
    editPassword(getFile(index, true));
  }
}

/**
 * @brief MainWindow::deselect clear the selection, password and copy buffer
 */
void MainWindow::deselect() {
  m_currentDir = "";
  m_qtPass->clearClipboard();
  ui->treeView->clearSelection();
  ui->actionEdit->setEnabled(false);
  ui->actionDelete->setEnabled(false);
  ui->passwordName->setText("");
  clearPanel(false);
}

void MainWindow::executeWrapperStarted() {
  m_displayPanel->clear();
  ui->textBrowser->clear();
  setUiElementsEnabled(false);
  clearPanelTimer.stop();
  if (QtPassSettings::isShowProcessOutput()) {
    m_processOutputDock->setVisible(true);
  }
}

/**
 * @brief Handles displaying parsed password entry content in the main window.
 * @example
 * void result = MainWindow::passShowHandler(p_output);
 * // Updates the UI with parsed fields and emits
 * passShowHandlerFinished(output)
 *
 * @param p_output - The raw output text containing the password entry data.
 * @return void - This function does not return a value.
 */
void MainWindow::passShowHandler(const QString &p_output) {
  QStringList templ = QtPassSettings::isUseTemplate()
                          ? QtPassSettings::getPassTemplate().split("\n")
                          : QStringList();
  bool allFields =
      QtPassSettings::isUseTemplate() && QtPassSettings::isTemplateAllFields();
  FileContent fileContent = FileContent::parse(p_output, templ, allFields);
  QString output = p_output;
  QString password = fileContent.getPassword();

  // set clipped text
  m_qtPass->setClippedText(password, p_output);

  // first clear the current view:
  m_displayPanel->clear();

  // show what is needed:
  if (QtPassSettings::isHideContent()) {
    output = "***" + tr("Content hidden") + "***";
  } else if (!QtPassSettings::isDisplayAsIs()) {
    m_displayPanel->displayFields(password, fileContent.getNamedValues());
    output = fileContent.getRemainingDataForDisplay();
  }

  if (QtPassSettings::isUseAutoclearPanel()) {
    clearPanelTimer.start();
  }

  emit passShowHandlerFinished(output);
  setUiElementsEnabled(true);
}

/**
 * @brief Handles the OTP output by displaying it, copying it to the clipboard,
 * and updating the UI state.
 * @example
 * void MainWindow::passOtpHandler(const QString &p_output);
 *
 * @param const QString &p_output - The OTP code text to process; if empty, an
 * error message is shown instead.
 * @return void - This function does not return a value.
 */
void MainWindow::passOtpHandler(const QString &p_output) {
  if (!p_output.isEmpty()) {
    m_displayPanel->appendField(tr("OTP Code"), p_output);
    m_qtPass->copyTextToClipboard(p_output);
    showStatusMessage(tr("OTP code copied to clipboard"));
  } else {
    flashText(tr("No OTP code found in this password entry"), true);
  }
  if (QtPassSettings::isUseAutoclearPanel()) {
    clearPanelTimer.start();
  }
  setUiElementsEnabled(true);
}

/**
 * @brief MainWindow::clearPanel hide the information from shoulder surfers
 */
void MainWindow::clearPanel(bool notify) {
  m_displayPanel->clear();
  const bool grepWasVisible = ui->grepResultsList->isVisible();
  ui->grepResultsList->clear();
  if (grepWasVisible) {
    ui->grepResultsList->setVisible(false);
    ui->treeView->setVisible(true);
    if (m_grep.inGrepMode()) {
      m_grep.clearGrepMode();
      ui->grepButton->blockSignals(true);
      ui->grepButton->setChecked(false);
      ui->grepButton->blockSignals(false);
      ui->lineEdit->blockSignals(true);
      ui->lineEdit->clear();
      ui->lineEdit->blockSignals(false);
      ui->lineEdit->setPlaceholderText(tr("Search Password"));
    }
  }
  if (notify) {
    QString output = "***" + tr("Password and Content hidden") + "***";
    ui->textBrowser->setHtml(output);
  } else {
    ui->textBrowser->setHtml("");
  }
}

/**
 * @brief MainWindow::setUiElementsEnabled enable or disable the relevant UI
 * elements
 * @param state
 */
void MainWindow::setUiElementsEnabled(bool state) {
  // Arm the watchdog while the UI is disabled; disarm once re-enabled.
  if (state) {
    m_uiWatchdog.stop();
  } else {
    m_uiWatchdog.start();
  }
  ui->treeView->setEnabled(state);
  ui->lineEdit->setEnabled(state);
  ui->actionAddPassword->setEnabled(state);
  ui->actionAddFolder->setEnabled(state);
  ui->actionUsers->setEnabled(state);
  ui->actionConfig->setEnabled(state);
  // is a file selected?
  state &= ui->treeView->currentIndex().isValid();
  ui->actionDelete->setEnabled(state);
  ui->actionEdit->setEnabled(state);
  updateGitButtonVisibility();
  updateOtpButtonVisibility();
}

/**
 * @brief Restores the main window geometry, state, position, size, and
 * tray/icon settings from saved application settings.
 * @example
 * MainWindow window;
 * window.restoreWindow();
 *
 * @return void - This function does not return a value.
 */
void MainWindow::restoreWindow() {
  QByteArray geometry = QtPassSettings::getGeometry(saveGeometry());
  restoreGeometry(geometry);
  QByteArray savestate = QtPassSettings::getSavestate(saveState());
  restoreState(savestate);
  QPoint position = QtPassSettings::getPos(pos());
  move(position);
  QSize newSize = QtPassSettings::getSize(size());
  resize(newSize);
  if (QtPassSettings::isMaximized(isMaximized())) {
    showMaximized();
  }

  if (QtPassSettings::isAlwaysOnTop()) {
    Qt::WindowFlags flags = windowFlags();
    setWindowFlags(flags | Qt::WindowStaysOnTopHint);
    show();
  }

  if (QtPassSettings::isUseTrayIcon() && m_tray == nullptr) {
    initTrayIcon();
    if (QtPassSettings::isStartMinimized()) {
      // since we are still in constructor, can't directly hide
      QTimer::singleShot(10, this, SLOT(hide()));
    }
  } else if (!QtPassSettings::isUseTrayIcon() && m_tray != nullptr) {
    destroyTrayIcon();
  }
}

/**
 * @brief MainWindow::on_configButton_clicked run Mainwindow::config
 */
void MainWindow::onConfig() { config(); }

/**
 * @brief Executes when the string in the search box changes, collapses the
 * TreeView
 * @param arg1
 */
void MainWindow::on_lineEdit_textChanged(const QString &arg1) {
  if (m_grep.inGrepMode())
    return;
  ui->statusBar->showMessage(tr("Looking for: %1").arg(arg1), 1000);
  ui->treeView->expandAll();
  clearPanel(false);
  ui->passwordName->setText("");
  ui->actionEdit->setEnabled(false);
  ui->actionDelete->setEnabled(false);
  searchTimer.start();
}

/**
 * @brief MainWindow::onTimeoutSearch Fired when search is finished or too much
 * time from two keypresses is elapsed
 */
void MainWindow::onTimeoutSearch() {
  QString query = ui->lineEdit->text();

  if (query.isEmpty()) {
    ui->treeView->collapseAll();
    deselect();
  }

  query.replace(QStringLiteral(" "), ".*");
  QRegularExpression regExp(query, QRegularExpression::CaseInsensitiveOption);
  proxyModel.setFilterRegularExpression(regExp);
  ui->treeView->setRootIndex(
      proxyModel.rootIndexFor(QtPassSettings::getPassStore()));

  if (proxyModel.rowCount() > 0 && !query.isEmpty()) {
    selectFirstFile();
  } else {
    ui->actionEdit->setEnabled(false);
    ui->actionDelete->setEnabled(false);
  }
}

/**
 * @brief MainWindow::on_lineEdit_returnPressed get searching
 *
 * Select the first possible file in the tree
 */
void MainWindow::on_lineEdit_returnPressed() {
#ifdef QT_DEBUG
  dbg() << "on_lineEdit_returnPressed" << proxyModel.rowCount();
#endif

  if (m_grep.inGrepMode()) {
    const QString query = ui->lineEdit->text();
    if (!query.isEmpty()) {
      ui->grepResultsList->clear();
      ui->statusBar->showMessage(tr("Searching…"));
      if (m_grep.beginSearch()) {
        QApplication::setOverrideCursor(Qt::WaitCursor);
      }
      QtPassSettings::getPass()->Grep(query, ui->grepCaseButton->isChecked());
    } else {
      if (m_grep.cancelSearch()) {
        QApplication::restoreOverrideCursor();
      }
      ui->grepResultsList->clear();
      ui->grepResultsList->setVisible(false);
      ui->treeView->setVisible(true);
    }
    return;
  }

  if (proxyModel.rowCount() > 0) {
    selectFirstFile();
    on_treeView_clicked(ui->treeView->currentIndex());
  }
}

/**
 * @brief Toggle grep (content search) mode.
 */
void MainWindow::on_grepButton_toggled(bool checked) {
  if (checked) {
    m_grep.enterGrepMode();
    ui->lineEdit->setPlaceholderText(tr("Search content (regex)"));
    // The regex dialect depends on the backend (see Pass::Grep): the pass
    // backend uses POSIX BRE via `pass grep`, the native backend uses PCRE.
    ui->lineEdit->setToolTip(
        QtPassSettings::isUsePass()
            ? tr("Content search uses POSIX basic regular expressions "
                 "(pass grep).")
            : tr("Content search uses Perl-compatible regular expressions "
                 "(PCRE)."));
    ui->lineEdit->clear();
    searchTimer.stop();
    proxyModel.setFilterRegularExpression(QRegularExpression());
    ui->treeView->setRootIndex(
        proxyModel.rootIndexFor(QtPassSettings::getPassStore()));
    ui->grepResultsList->setVisible(false);
    // Keep treeView visible until results arrive
  } else {
    if (m_grep.leaveGrepMode()) {
      QApplication::restoreOverrideCursor();
    }
    searchTimer.stop();
    ui->lineEdit->blockSignals(true);
    ui->lineEdit->clear();
    ui->lineEdit->blockSignals(false);
    ui->lineEdit->setPlaceholderText(tr("Search Password"));
    ui->lineEdit->setToolTip(QString());
    ui->grepResultsList->clear();
    ui->grepResultsList->setVisible(false);
    ui->treeView->setVisible(true);
    proxyModel.setFilterRegularExpression(QRegularExpression());
    ui->treeView->setRootIndex(
        proxyModel.rootIndexFor(QtPassSettings::getPassStore()));
  }
}

/**
 * @brief Display grep results in grepResultsList.
 */
void MainWindow::onGrepFinished(
    const QList<QPair<QString, QStringList>> &results) {
  const GrepSearchController::FinishOutcome outcome = m_grep.finishSearch();
  if (outcome.restoreCursor) {
    QApplication::restoreOverrideCursor();
  }
  // Re-enable the UI before the discard check so a cancelled search can never
  // leave controls disabled.
  setUiElementsEnabled(true);
  if (outcome.discard) {
    return;
  }
  if (!m_grep.inGrepMode())
    return;
  ui->grepResultsList->clear();
  if (results.isEmpty()) {
    ui->statusBar->showMessage(tr("No matches found."), 3000);
    ui->grepResultsList->setVisible(false);
    ui->treeView->setVisible(true);
    return;
  }
  const bool hideContent = QtPassSettings::isHideContent();
  int totalLines = 0;
  for (const auto &pair : results) {
    auto *entryItem = new QTreeWidgetItem(ui->grepResultsList);
    entryItem->setText(0, pair.first);
    entryItem->setData(0, Qt::UserRole, pair.first);
    for (const QString &line : pair.second) {
      auto *lineItem = new QTreeWidgetItem(entryItem);
      lineItem->setText(0, hideContent ? "***" + tr("Content hidden") + "***"
                                       : line);
      lineItem->setData(0, Qt::UserRole, pair.first);
      ++totalLines;
    }
  }
  ui->grepResultsList->expandAll();
  ui->treeView->setVisible(false);
  ui->grepResultsList->setVisible(true);
  ui->statusBar->showMessage(
      tr("Found %n match(es)", nullptr, totalLines) + " " +
          tr("in %n entr(ies).", nullptr, static_cast<int>(results.size())),
      3000);
  if (QtPassSettings::isUseAutoclearPanel())
    clearPanelTimer.start();
}

/**
 * @brief Navigate to the password entry when a grep result is clicked.
 */
void MainWindow::on_grepResultsList_itemClicked(QTreeWidgetItem *item,
                                                int /*column*/) {
  const QString entry = item->data(0, Qt::UserRole).toString();
  if (entry.isEmpty())
    return;
  const QString fullPath = QDir::cleanPath(
      QDir(QtPassSettings::getPassStore()).filePath(entry + ".gpg"));
  QModelIndex srcIndex = model.index(fullPath);
  if (!srcIndex.isValid())
    return;
  QModelIndex proxyIndex = proxyModel.mapFromSource(srcIndex);
  if (!proxyIndex.isValid())
    return;
  ui->treeView->setCurrentIndex(proxyIndex);
  on_treeView_clicked(proxyIndex);
  if (QtPassSettings::isHideContent() || QtPassSettings::isUseAutoclearPanel())
    ui->grepResultsList->clear();
  ui->grepResultsList->setVisible(false);
  ui->treeView->setVisible(true);
  ui->treeView->scrollTo(proxyIndex);
  ui->treeView->setFocus();
}

/**
 * @brief MainWindow::selectFirstFile select the first possible file in the
 * tree
 */
void MainWindow::selectFirstFile() {
  QModelIndex index = proxyModel.rootIndexFor(QtPassSettings::getPassStore());
  index = firstFile(index);
  ui->treeView->setCurrentIndex(index);
}

/**
 * @brief MainWindow::firstFile return location of first possible file
 * @param parentIndex
 * @return QModelIndex
 */
auto MainWindow::firstFile(QModelIndex parentIndex) -> QModelIndex {
  QModelIndex index = parentIndex;
  int numRows = proxyModel.rowCount(parentIndex);
  for (int row = 0; row < numRows; ++row) {
    index = proxyModel.index(row, 0, parentIndex);
    if (model.fileInfo(proxyModel.mapToSource(index)).isFile()) {
      return index;
    }
    if (proxyModel.hasChildren(index)) {
      return firstFile(index);
    }
  }
  return index;
}

/**
 * @brief MainWindow::confirmPathInStore reject paths that resolve outside
 * the password store and warn the user.
 *
 * Used before file/folder creation, move, and rename to stop user-typed
 * names like "../../etc/passwd" or absolute paths from escaping the
 * configured store root via the input dialogs.
 *
 * @param candidate Absolute candidate path to validate.
 * @return true if the path is inside the password store; false otherwise (a
 * warning dialog is shown in that case).
 */
auto MainWindow::confirmPathInStore(const QString &candidate) -> bool {
  if (PathValidator::isPathInStore(QtPassSettings::getPassStore(), candidate)) {
    return true;
  }
  QMessageBox::warning(this, tr("Invalid name"),
                       tr("That name would resolve outside the password "
                          "store. Please choose a different name."));
  return false;
}

/**
 * @brief MainWindow::setPassword open passworddialog
 * @param file which pgp file
 * @param isNew insert (not update)
 */
void MainWindow::setPassword(const QString &file, bool isNew) {
  PasswordDialog d(file, isNew, this);

  if (isNew) {
    QString storePath = QtPassSettings::getPassStore();
    QString folder =
        Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel);
    if (folder.isEmpty()) {
      folder = storePath;
    }
    QHash<QString, QStringList> templates =
        TemplateIO::readTemplates(storePath);
    if (!templates.isEmpty()) {
      QString defaultTemplate =
          TemplateIO::getFolderTemplate(folder, storePath);
      d.setAvailableTemplates(templates, defaultTemplate);
      new QShortcut(QKeySequence(Qt::CTRL | Qt::Key_T), &d,
                    [&d]() { d.cycleTemplate(); });
    }
  }

  if (!d.exec()) {
    ui->treeView->setFocus();
  }
}

/**
 * @brief MainWindow::addPassword add a new password by showing a
 * number of dialogs.
 */
void MainWindow::addPassword() {
  bool ok;
  QString dir =
      Util::getDir(ui->treeView->currentIndex(), true, model, proxyModel);
  QString file =
      QInputDialog::getText(this, tr("New file"),
                            tr("New password file: \n(Will be placed in %1 )")
                                .arg(QtPassSettings::getPassStore() +
                                     Util::getDir(ui->treeView->currentIndex(),
                                                  true, model, proxyModel)),
                            QLineEdit::Normal, "", &ok);
  if (!ok || file.isEmpty()) {
    return;
  }
  file = dir + file;
  if (!confirmPathInStore(QtPassSettings::getPassStore() + file)) {
    return;
  }
  setPassword(file);
}

/**
 * @brief MainWindow::onDelete remove password, if you are
 * sure.
 */
void MainWindow::onDelete() {
  QModelIndex currentIndex = ui->treeView->currentIndex();
  if (!currentIndex.isValid()) {
    // This fixes https://github.com/IJHack/QtPass/issues/556
    // Otherwise the entire password directory would be deleted if
    // nothing is selected in the tree view.
    return;
  }

  QFileInfo fileOrFolder =
      model.fileInfo(proxyModel.mapToSource(ui->treeView->currentIndex()));
  QString file = "";
  bool isDir = false;

  if (fileOrFolder.isFile()) {
    file = getFile(ui->treeView->currentIndex(), true);
  } else {
    file = Util::getDir(ui->treeView->currentIndex(), true, model, proxyModel);
    isDir = true;
  }

  QString dirMessage = tr(" and the whole content?");
  if (isDir) {
    QDirIterator it(model.rootPath() + QDir::separator() + file,
                    QDirIterator::Subdirectories);
    bool okDir = true;
    while (it.hasNext() && okDir) {
      it.next();
      if (QFileInfo(it.filePath()).isFile()) {
        if (QFileInfo(it.filePath()).suffix() != "gpg") {
          okDir = false;
          dirMessage = tr(" and the whole content? <br><strong>Attention: "
                          "there are unexpected files in the given folder, "
                          "check them before continue.</strong>");
        }
      }
    }
  }

  if (QMessageBox::question(
          this, isDir ? tr("Delete folder?") : tr("Delete password?"),
          tr("Are you sure you want to delete %1%2?")
              .arg(QDir::separator() + file, isDir ? dirMessage : "?"),
          QMessageBox::Yes | QMessageBox::No) != QMessageBox::Yes) {
    return;
  }

  QtPassSettings::getPass()->Remove(file, isDir);
}

/**
 * @brief MainWindow::onOTP try and generate (selected) OTP code.
 */
void MainWindow::onOtp() {
  QString file = getFile(ui->treeView->currentIndex(), true);
  if (!file.isEmpty()) {
    if (QtPassSettings::isUseOtp()) {
      setUiElementsEnabled(false);
      QtPassSettings::getPass()->OtpGenerate(file);
    }
  } else {
    flashText(tr("No password selected for OTP generation"), true);
  }
}

/**
 * @brief MainWindow::onEdit try and edit (selected) password.
 */
void MainWindow::onEdit() {
  QString file = getFile(ui->treeView->currentIndex(), true);
  editPassword(file);
}

/**
 * @brief MainWindow::userDialog see MainWindow::onUsers()
 * @param dir folder to edit users for.
 */
void MainWindow::userDialog(const QString &dir) {
  if (!dir.isEmpty()) {
    m_currentDir = dir;
  }
  onUsers();
}

/**
 * @brief MainWindow::onUsers edit users for the current
 * folder,
 * gets lists and opens UserDialog.
 */
void MainWindow::onUsers() {
  QString dir =
      m_currentDir.isEmpty()
          ? Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel)
          : m_currentDir;

  UsersDialog d(dir, this);
  if (!d.exec()) {
    ui->treeView->setFocus();
  }
}

/**
 * @brief MainWindow::messageAvailable we have some text/message/search to do.
 * @param message
 */
void MainWindow::messageAvailable(const QString &message) {
  show();
  raise();
  if (message.isEmpty()) {
    focusInput();
  } else {
    ui->treeView->expandAll();
    ui->lineEdit->setText(message);
    on_lineEdit_returnPressed();
  }
}

/**
 * @brief MainWindow::generateKeyPair internal gpg keypair generator . .
 * @param batch
 * @param keygenWindow
 */
void MainWindow::generateKeyPair(const QString &batch, QDialog *keygenWindow) {
  m_keyGenDialog = keygenWindow;
  emit generateGPGKeyPair(batch);
}

/**
 * @brief MainWindow::updateProfileBox update the list of profiles, optionally
 * select a more appropriate one to view too
 */
void MainWindow::updateProfileBox() {
  QHash<QString, QHash<QString, QString>> profiles =
      QtPassSettings::getProfiles();

  if (profiles.isEmpty()) {
    ui->profileWidget->hide();
  } else {
    ui->profileWidget->show();
    ui->profileBox->setEnabled(profiles.size() > 1);
    ui->profileBox->clear();
    QHashIterator<QString, QHash<QString, QString>> i(profiles);
    while (i.hasNext()) {
      i.next();
      if (!i.key().isEmpty()) {
        ui->profileBox->addItem(i.key());
      }
    }
    ui->profileBox->model()->sort(0);
  }
  int index = ui->profileBox->findText(QtPassSettings::getProfile());
  if (index != -1) { //  -1 for not found
    ui->profileBox->setCurrentIndex(index);
  }
}

/**
 * @brief MainWindow::on_profileBox_currentIndexChanged make sure we show the
 * correct "profile"
 * @param name
 */
#if QT_VERSION < QT_VERSION_CHECK(6, 0, 0)
void MainWindow::on_profileBox_currentIndexChanged(const QString &name) {
#else
/**
 * @brief Handles changes to the selected profile in the profile combo box.
 * @details Ignores the event during a fresh start or when the selected profile
 * matches the current profile. Otherwise, it clears the password field, updates
 * the active profile and related settings, refreshes the environment, and
 * resets the tree view and action states to reflect the newly selected profile.
 *
 * @param name - The newly selected profile name.
 * @return void - This function does not return a value.
 *
 */
void MainWindow::on_profileBox_currentTextChanged(const QString &name) {
#endif
  if (m_qtPass->isFreshStart() || name == QtPassSettings::getProfile()) {
    return;
  }

  ui->lineEdit->clear();

  QtPassSettings::setProfile(name);

  QtPassSettings::setPassStore(
      QtPassSettings::getProfiles().value(name).value("path"));
  QtPassSettings::setPassSigningKey(
      QtPassSettings::getProfiles().value(name).value("signingKey"));
  ui->statusBar->showMessage(tr("Profile changed to %1").arg(name), 2000);

  QtPassSettings::getPass()->updateEnv();

  const QString passStore = QtPassSettings::getPassStore();
  proxyModel.setStore(passStore);
  ui->treeView->setRootIndex(proxyModel.rootIndexFor(passStore));
  deselect();
  ui->treeView->setCurrentIndex(QModelIndex());
}

/**
 * @brief MainWindow::initTrayIcon show a nice tray icon on systems that
 * support
 * it
 */
void MainWindow::initTrayIcon() {
  m_tray = new TrayIcon(this);
  // Setup tray icon

  if (m_tray == nullptr) {
#ifdef QT_DEBUG
    dbg() << "Allocating tray icon failed.";
#endif
    return;
  }

  if (!m_tray->getIsAllocated()) {
    destroyTrayIcon();
  }
}

/**
 * @brief MainWindow::destroyTrayIcon remove that pesky tray icon
 */
void MainWindow::destroyTrayIcon() {
  delete m_tray;
  m_tray = nullptr;
}

/**
 * @brief MainWindow::closeEvent hide or quit
 * @param event
 */
void MainWindow::closeEvent(QCloseEvent *event) {
  if (QtPassSettings::isHideOnClose()) {
    this->hide();
    event->ignore();
  } else {
    m_qtPass->clearClipboard();

    QtPassSettings::setGeometry(saveGeometry());
    QtPassSettings::setSavestate(saveState());
    QtPassSettings::setMaximized(isMaximized());
    if (!isMaximized()) {
      QtPassSettings::setPos(pos());
      QtPassSettings::setSize(size());
    }
    event->accept();
  }
}

/**
 * @brief MainWindow::eventFilter filter out some events and focus the
 * treeview
 * @param obj
 * @param event
 * @return
 */
auto MainWindow::eventFilter(QObject *obj, QEvent *event) -> bool {
  if (obj == ui->lineEdit && event->type() == QEvent::KeyPress) {
    auto *key = dynamic_cast<QKeyEvent *>(event);
    if (key != nullptr && key->key() == Qt::Key_Down) {
      ui->treeView->setFocus();
    }
  }
  return QObject::eventFilter(obj, event);
}

/**
 * @brief MainWindow::keyPressEvent did anyone press return, enter or escape?
 * @param event
 */
void MainWindow::keyPressEvent(QKeyEvent *event) {
  switch (event->key()) {
  case Qt::Key_Delete:
    onDelete();
    break;
  case Qt::Key_Return:
  case Qt::Key_Enter:
    if (proxyModel.rowCount() > 0) {
      on_treeView_clicked(ui->treeView->currentIndex());
    }
    break;
  case Qt::Key_Escape:
    ui->lineEdit->clear();
    break;
  default:
    break;
  }
}

/**
 * @brief MainWindow::showContextMenu show us the (file or folder) context
 * menu
 * @param pos
 */
void MainWindow::showContextMenu(const QPoint &pos) {
  QModelIndex index = ui->treeView->indexAt(pos);
  bool selected = true;
  if (!index.isValid()) {
    ui->treeView->clearSelection();
    ui->actionDelete->setEnabled(false);
    ui->actionEdit->setEnabled(false);
    m_currentDir = "";
    selected = false;
  }

  ui->treeView->setCurrentIndex(index);

  QPoint globalPos = ui->treeView->viewport()->mapToGlobal(pos);

  QFileInfo fileOrFolder =
      model.fileInfo(proxyModel.mapToSource(ui->treeView->currentIndex()));

  QMenu contextMenu;
  if (!selected || fileOrFolder.isDir()) {
    QAction *openFolder =
        contextMenu.addAction(tr("Open folder with file manager"));
    QAction *addFolder = contextMenu.addAction(tr("Add folder"));
    QAction *addPassword = contextMenu.addAction(tr("Add password"));
    QAction *users = contextMenu.addAction(tr("Users"));
    connect(openFolder, &QAction::triggered, this, &MainWindow::openFolder);
    connect(addFolder, &QAction::triggered, this, &MainWindow::addFolder);
    connect(addPassword, &QAction::triggered, this, &MainWindow::addPassword);
    connect(users, &QAction::triggered, this, &MainWindow::onUsers);
  } else if (fileOrFolder.isFile()) {
    QAction *edit = contextMenu.addAction(tr("Edit"));
    connect(edit, &QAction::triggered, this, &MainWindow::onEdit);
  }
  if (selected) {
    contextMenu.addSeparator();
    if (fileOrFolder.isDir()) {
      QAction *renameFolder = contextMenu.addAction(tr("Rename folder"));
      connect(renameFolder, &QAction::triggered, this,
              &MainWindow::renameFolder);
    } else if (fileOrFolder.isFile()) {
      QAction *renamePassword = contextMenu.addAction(tr("Rename password"));
      connect(renamePassword, &QAction::triggered, this,
              &MainWindow::renamePassword);
    }
    QAction *deleteItem = contextMenu.addAction(tr("Delete"));
    connect(deleteItem, &QAction::triggered, this, &MainWindow::onDelete);
    if (fileOrFolder.isDir()) {
      QString dirPath = QDir::cleanPath(
          Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel));

      auto *shareMenu = new QMenu(tr("Share"), &contextMenu);
      contextMenu.addMenu(shareMenu);

      QString gpgIdPath = Pass::getGpgIdPath(dirPath);
      bool gpgIdExists = !gpgIdPath.isEmpty() && QFile(gpgIdPath).exists();

      QString exePath = QtPassSettings::isUsePass()
                            ? QtPassSettings::getPassExecutable()
                            : QtPassSettings::getGpgExecutable();
      bool gpgAvailable = !exePath.isEmpty() && (exePath.startsWith("wsl ") ||
                                                 QFile(exePath).exists());

      QAction *reencrypt = shareMenu->addAction(tr("Re-encrypt all passwords"));
      reencrypt->setEnabled(gpgIdExists && gpgAvailable);
      connect(reencrypt, &QAction::triggered, this,
              [this, dirPath]() { reencryptPath(dirPath); });

      QAction *exportKey = shareMenu->addAction(tr("Export my public key..."));
      exportKey->setEnabled(gpgAvailable);
      connect(exportKey, &QAction::triggered, this,
              &MainWindow::exportPublicKey);

      QAction *addRecipientAction =
          shareMenu->addAction(tr("Add recipient..."));
      addRecipientAction->setEnabled(gpgIdExists && gpgAvailable);
      connect(addRecipientAction, &QAction::triggered, this,
              [this, dirPath]() { addRecipient(dirPath); });

      QAction *shareHelp = shareMenu->addAction(tr("What is this?"));
      connect(shareHelp, &QAction::triggered, this, &MainWindow::showShareHelp);
    }
  }
  contextMenu.exec(globalPos);
}

/**
 * @brief MainWindow::showBrowserContextMenu show us the context menu in
 * password window
 * @param pos
 */
void MainWindow::showBrowserContextMenu(const QPoint &pos) {
  QMenu *contextMenu = ui->textBrowser->createStandardContextMenu(pos);
  QPoint globalPos = ui->textBrowser->viewport()->mapToGlobal(pos);

  contextMenu->exec(globalPos);
  delete contextMenu;
}

/**
 * @brief MainWindow::openFolder open the folder in the default file manager
 */
void MainWindow::openFolder() {
  QString dir =
      Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel);

  QString path = QDir::toNativeSeparators(dir);
  QDesktopServices::openUrl(QUrl::fromLocalFile(path));
}

/**
 * @brief MainWindow::addFolder add a new folder to store passwords in
 */
void MainWindow::addFolder() {
  bool ok;
  QString dir =
      Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel);
  QString newdir =
      QInputDialog::getText(this, tr("New file"),
                            tr("New Folder: \n(Will be placed in %1 )")
                                .arg(QtPassSettings::getPassStore() +
                                     Util::getDir(ui->treeView->currentIndex(),
                                                  true, model, proxyModel)),
                            QLineEdit::Normal, "", &ok);
  if (!ok || newdir.isEmpty()) {
    return;
  }
  newdir.prepend(dir);
  if (!confirmPathInStore(newdir)) {
    return;
  }
  if (!QDir().mkdir(newdir)) {
    QMessageBox::warning(this, tr("Error"),
                         tr("Failed to create folder: %1").arg(newdir));
    return;
  }
  if (QtPassSettings::isAddGPGId(true)) {
    QString gpgIdFile = newdir + "/.gpg-id";
    QFile gpgId(gpgIdFile);
    if (!gpgId.open(QIODevice::WriteOnly)) {
      QMessageBox::warning(
          this, tr("Error"),
          tr("Failed to create .gpg-id file in: %1").arg(newdir));
      return;
    }
    QList<UserInfo> users = QtPassSettings::getPass()->listKeys("", true);
    for (const UserInfo &user : users) {
      if (user.enabled) {
        gpgId.write((user.key_id + "\n").toUtf8());
      }
    }
    gpgId.close();
    // Lock to owner-only access; see ImitatePass::writeGpgIdFile for
    // rationale (NFS / USB / unusual umask scenarios). Best-effort on
    // platforms where setPermissions is a no-op.
    QFile::setPermissions(gpgIdFile, QFile::ReadOwner | QFile::WriteOwner);
  }
}

/**
 * @brief MainWindow::renameFolder rename an existing folder
 */
void MainWindow::renameFolder() {
  bool ok;
  QString srcDir = QDir::cleanPath(
      Util::getDir(ui->treeView->currentIndex(), false, model, proxyModel));
  QString srcDirName = QDir(srcDir).dirName();
  QString newName =
      QInputDialog::getText(this, tr("Rename file"), tr("Rename Folder To: "),
                            QLineEdit::Normal, srcDirName, &ok);
  if (!ok || newName.isEmpty()) {
    return;
  }
  QString destDir = srcDir;
  destDir.replace(srcDir.lastIndexOf(srcDirName), srcDirName.length(), newName);
  if (!confirmPathInStore(destDir)) {
    return;
  }
  QtPassSettings::getPass()->Move(srcDir, destDir, false);
}

/**
 * @brief MainWindow::editPassword read password and open edit window via
 * MainWindow::onEdit()
 */
void MainWindow::editPassword(const QString &file) {
  if (!file.isEmpty()) {
    if (QtPassSettings::isUseGit() && QtPassSettings::isAutoPull()) {
      onUpdate(true);
    }
    setPassword(file, false);
  }
}

/**
 * @brief MainWindow::renamePassword rename an existing password
 */
void MainWindow::renamePassword() {
  bool ok;
  QString file = getFile(ui->treeView->currentIndex(), false);
  QString filePath = QFileInfo(file).path();
  QString fileName = QFileInfo(file).fileName();
  if (fileName.endsWith(".gpg", Qt::CaseInsensitive)) {
    fileName.chop(4);
  }

  QString newName =
      QInputDialog::getText(this, tr("Rename file"), tr("Rename File To: "),
                            QLineEdit::Normal, fileName, &ok);
  if (!ok || newName.isEmpty()) {
    return;
  }
  QString newFile = QDir(filePath).filePath(newName);
  if (!confirmPathInStore(newFile)) {
    return;
  }
  QtPassSettings::getPass()->Move(file, newFile, false);
}

/**
 * @brief Copies the password of the selected file from the tree view to the
 * clipboard.
 * @example
 * MainWindow::copyPasswordFromTreeview();
 *
 * @return void - This function does not return a value.
 */
void MainWindow::copyPasswordFromTreeview() {
  QFileInfo fileOrFolder =
      model.fileInfo(proxyModel.mapToSource(ui->treeView->currentIndex()));

  if (fileOrFolder.isFile()) {
    QString file = getFile(ui->treeView->currentIndex(), true);
    // Disconnect any previous connection to avoid accumulation
    disconnect(QtPassSettings::getPass(), &Pass::finishedShow, this,
               &MainWindow::passwordFromFileToClipboard);
    connect(QtPassSettings::getPass(), &Pass::finishedShow, this,
            &MainWindow::passwordFromFileToClipboard);
    QtPassSettings::getPass()->Show(file);
  }
}

void MainWindow::passwordFromFileToClipboard(const QString &text) {
  QStringList tokens = text.split('\n');
  m_qtPass->copyTextToClipboard(tokens[0]);
}

/**
 * @brief Displays message in status bar
 *
 * @param msg     text to be displayed
 * @param timeout time for which msg shall be visible
 */
void MainWindow::showStatusMessage(const QString &msg, int timeout) {
  ui->statusBar->showMessage(msg, timeout);
}

/**
 * @brief MainWindow::reencryptPath re-encrypt all passwords in a directory
 * @param dir Directory path to re-encrypt
 */
void MainWindow::reencryptPath(const QString &dir) {
  QDir checkDir(dir);
  if (!checkDir.exists()) {
    QMessageBox::critical(this, tr("Error"),
                          tr("Directory does not exist: %1").arg(dir));
    return;
  }

  int ret = QMessageBox::question(
      this, tr("Re-encrypt passwords"),
      tr("Re-encrypt all passwords in %1?\n\n"
         "This will re-encrypt ALL password files in this folder "
         "using the current recipients defined in .gpg-id.\n\n"
         "This may rewrite many files and cannot be undone easily.\n\n"
         "Continue?")
          .arg(QDir(dir).dirName()),
      QMessageBox::Yes | QMessageBox::No);

  if (ret != QMessageBox::Yes)
    return;

  // Disable preemptively. ImitatePass::reencryptPath emits
  // startReencryptPath asynchronously and the slot would re-run this,
  // but setEnabled(false) is idempotent so the duplicate is harmless.
  startReencryptPath();

  QtPassSettings::getImitatePass()->reencryptPath(
      QDir::cleanPath(QDir(dir).absolutePath()));
}

/**
 * @brief MainWindow::startReencryptPath disable ui elements and treeview
 */
void MainWindow::startReencryptPath() {
  setUiElementsEnabled(false);
  ui->treeView->setDisabled(true);
}

/**
 * @brief MainWindow::endReencryptPath re-enable ui elements
 */
void MainWindow::endReencryptPath() { setUiElementsEnabled(true); }

/**
 * @brief MainWindow::exportPublicKey export the configured signing key in
 *        ASCII-armored form via gpg and show it in ExportPublicKeyDialog.
 *
 * Falls back to a help dialog when no signing key is configured or gpg is
 * unavailable, so the user still gets actionable guidance.
 */
void MainWindow::exportPublicKey() {
  QString identity = QtPassSettings::getPassSigningKey();
  if (identity.isEmpty()) {
    QMessageBox::information(
        this, tr("Export Public Key"),
        tr("<h3>Export Your Public Key</h3>"
           "<p>No signing key is configured. Set one in QtPass Settings "
           "&gt; GPG keys, or run this in a terminal:</p>"
           "<pre>gpg --armor --export --output my_key.asc &lt;your-key-id"
           "&gt;</pre>"
           "<p>Then send the file to your teammates.</p>"));
    return;
  }
  QString gpgExe = QtPassSettings::getGpgExecutable();
  if (gpgExe.isEmpty()) {
    gpgExe = QStringLiteral("gpg");
  }
  QStringList args = {"--armor", "--export"};
  args.append(identity.split(' ', Qt::SkipEmptyParts));
  QString stdOut;
  QString stdErr;
  int exitCode =
      Executor::executeBlocking(gpgExe, args, &stdOut, &stdErr);
  if (exitCode != 0 || stdOut.isEmpty()) {
    QMessageBox::warning(this, tr("Export Public Key"),
                         tr("Could not export public key for %1.\n\n%2")
                             .arg(identity, stdErr.isEmpty()
                                                ? tr("No output from gpg.")
                                                : stdErr));
    return;
  }
  ExportPublicKeyDialog dialog(identity, stdOut, this);
  dialog.exec();
}

/**
 * @brief MainWindow::addRecipient open the recipient management dialog for
 *        the supplied directory.
 * @param dir Folder whose .gpg-id should be edited.
 *
 * Delegates to UsersDialog so users can tick/untick keys from their
 * keyring as recipients of the folder; importing a foreign key into the
 * keyring still has to happen via gpg (or QtPass settings) first.
 */
void MainWindow::addRecipient(const QString &dir) {
  UsersDialog d(dir, this);
  d.exec();
}

/**
 * @brief MainWindow::showShareHelp show help about GPG sharing
 */
void MainWindow::showShareHelp() {
  QMessageBox::information(
      this, tr("Sharing Passwords with GPG"),
      tr("<h3>Sharing Passwords with GPG</h3>"
         "<p>To share passwords with other users:</p>"
         "<ol>"
         "<li><b>Export your public key</b> and send it to teammates</li>"
         "<li><b>Import teammates' public keys</b> into your GPG keyring</li>"
         "<li><b>Re-encrypt passwords</b> so all recipients can decrypt "
         "them</li>"
         "</ol>"
         "<p>Only people who have a matching secret key can decrypt the "
         "passwords.</p>"
         "<p><b>Tip:</b> Use the same GPG key for all shared folders.</p>"
         "<p>See the FAQ for more details.</p>"));
}

void MainWindow::updateGitButtonVisibility() {
  if (!QtPassSettings::isUseGit() ||
      (QtPassSettings::getGitExecutable().isEmpty() &&
       QtPassSettings::getPassExecutable().isEmpty())) {
    enableGitButtons(false);
  } else {
    enableGitButtons(true);
  }
}

void MainWindow::updateOtpButtonVisibility() {
#if defined(Q_OS_WIN) || defined(__APPLE__)
  ui->actionOtp->setVisible(false);
#endif
  if (!QtPassSettings::isUseOtp()) {
    ui->actionOtp->setEnabled(false);
  } else {
    ui->actionOtp->setEnabled(true);
  }
}

void MainWindow::updateGrepButtonVisibility() {
  const bool enabled = QtPassSettings::isUseGrepSearch();
  ui->grepButton->setVisible(enabled);
  ui->grepCaseButton->setVisible(enabled);
  if (!enabled && m_grep.inGrepMode()) {
    ui->grepButton->setChecked(false);
  }
}

void MainWindow::enableGitButtons(const bool &state) {
  // Following GNOME guidelines is preferable disable buttons instead of hide
  ui->actionPush->setEnabled(state);
  ui->actionUpdate->setEnabled(state);
}

/**
 * @brief MainWindow::critical critical message popup wrapper.
 * @param title
 * @param msg
 */
void MainWindow::critical(const QString &title, const QString &msg) {
  QMessageBox::critical(this, title, msg);
}

/**
 * @brief Appends processed command output to the output panel.
 *
 * Appends text to the process output text edit, with per-line numbering,
 * optional command prefix, and color coding for errors vs. success.
 * Handles auto-scrolling and line limits.
 *
 * @param output The raw output text from the command.
 * @param isError true if this is error output (stderr).
 * @param linePrefix Optional command name to prefix each line with.
 */
void MainWindow::appendProcessOutput(const QString &output, bool isError,
                                     const QString &linePrefix) {
  if (!QtPassSettings::isShowProcessOutput()) {
    return;
  }

  QStringList lines = output.split('\n', Qt::SkipEmptyParts);
  for (QString &line : lines) {
    // Right-trim only: remove trailing CR and whitespace, preserve leading
    // indentation
    line.remove('\r');
    while (!line.isEmpty() && line.back().isSpace()) {
      line.chop(1);
    }
    if (line.isEmpty()) {
      continue;
    }

    m_outputCounter++;
    QString lineNumber = QString::number(m_outputCounter);

    QColor textColor =
        isError ? QColor(Qt::red)
                : m_processOutputEdit->palette().color(QPalette::Text);
    QString colorHex = textColor.name();
    // Apply the optional prefix per line so multi-line output stays
    // attributed to its command (e.g. all 3 lines of a `git push` show
    // "git push: ..." rather than only the first).
    QString prefixed =
        linePrefix.isEmpty() ? line : linePrefix + QStringLiteral(": ") + line;
    QString coloredOutput =
        QString("<span style=\"color: %1;\">%2: %3</span>")
            .arg(colorHex, lineNumber, prefixed.toHtmlEscaped());

    m_processOutputEdit->append(coloredOutput);
  }

  limitOutputLines();

  if (m_autoScroll) {
    m_processOutputEdit->verticalScrollBar()->setValue(
        m_processOutputEdit->verticalScrollBar()->maximum());
  }
}

/**
 * @brief Handles process output from the Pass executor.
 *
 * Called when any non-sensitive process completes. Filters out password-
 * related commands (pass show, insert, etc.) and delegates to
 * appendProcessOutput.
 *
 * @param output The stdout/stderr text from the process.
 * @param isError true if this is error output (stderr).
 * @param pid The process ID identifying which command ran.
 */
void MainWindow::onProcessOutput(const QString &output, bool isError,
                                 Enums::PROCESS pid) {
  appendProcessOutput(output, isError, getProcessName(pid));
}

/**
 * @brief Maps a process ID to its human-readable command name.
 *
 * Returns static strings for git/pass commands that appear in output.
 * Password-related commands return empty (they are filtered).
 *
 * @param pid The process ID to look up.
 * @return QString with command name, or empty if filtered.
 */
auto MainWindow::getProcessName(Enums::PROCESS pid) -> QString {
  switch (pid) {
  case Enums::GIT_INIT:
    return QStringLiteral("git init"); // no-tr
  case Enums::GIT_ADD:
    return QStringLiteral("git add"); // no-tr
  case Enums::GIT_COMMIT:
    return QStringLiteral("git commit"); // no-tr
  case Enums::GIT_RM:
    return QStringLiteral("git rm"); // no-tr
  case Enums::GIT_PULL:
    return QStringLiteral("git pull"); // no-tr
  case Enums::GIT_PUSH:
    return QStringLiteral("git push"); // no-tr
  case Enums::GIT_MOVE:
    return QStringLiteral("git mv"); // no-tr
  case Enums::GIT_COPY:
    // ImitatePass::Copy literally invokes `git cp` (a git-extras
    // subcommand), so the label matches what's run. Stock-git users
    // without git-extras will see the underlying "'cp' is not a git
    // command" failure surfaced in the process output panel.
    return QStringLiteral("git cp"); // no-tr
  case Enums::PASS_INSERT:
    return QStringLiteral("pass insert"); // no-tr
  case Enums::PASS_REMOVE:
    return QStringLiteral("pass rm"); // no-tr
  case Enums::PASS_INIT:
    return QStringLiteral("pass init"); // no-tr
  case Enums::PASS_MOVE:
    return QStringLiteral("pass mv"); // no-tr
  case Enums::PASS_COPY:
    return QStringLiteral("pass cp"); // no-tr
  case Enums::PASS_GREP:
    return QStringLiteral("pass grep"); // no-tr
  case Enums::GPG_GENKEYS:
    return QStringLiteral("gpg --gen-key"); // no-tr
  case Enums::PASS_SHOW:
  case Enums::PASS_OTP_GENERATE:
  case Enums::PROCESS_COUNT:
  case Enums::INVALID:
    break;
  }
  return {};
}

/**
 * @brief Checks if a process ID represents a sensitive operation whose
 * output should not be shown in the process output panel.
 *
 * Password-related commands (pass show, OTP generate, grep, insert)
 * display their output in other UI areas, so we skip them here.
 *
 * @param pid The process ID to check.
 * @return true if the process is sensitive and should be filtered.
 */
auto MainWindow::isSensitiveProcess(Enums::PROCESS pid) -> bool {
  switch (pid) {
  case Enums::PASS_SHOW:
  case Enums::PASS_OTP_GENERATE:
  case Enums::PASS_GREP:
  case Enums::PASS_INSERT:
    return true;
  case Enums::GIT_INIT:
  case Enums::GIT_ADD:
  case Enums::GIT_COMMIT:
  case Enums::GIT_RM:
  case Enums::GIT_PULL:
  case Enums::GIT_PUSH:
  case Enums::GIT_MOVE:
  case Enums::GIT_COPY:
  case Enums::PASS_REMOVE:
  case Enums::PASS_INIT:
  case Enums::PASS_MOVE:
  case Enums::PASS_COPY:
  case Enums::GPG_GENKEYS:
  case Enums::PROCESS_COUNT:
  case Enums::INVALID:
    break;
  }
  return false;
}

/**
 * @brief Updates the visibility of the process output panel.
 *
 * Shows or hides the process output widget based on the user's
 * showProcessOutput setting.
 */
void MainWindow::updateProcessOutputVisibility() {
  m_processOutputDock->setVisible(QtPassSettings::isShowProcessOutput());
}

/**
 * @brief Limits the output panel to max lines, trimming old excess.
 *
 * Removes the oldest lines when the document exceeds MaxOutputLines (1000).
 * Called after each append to prevent unbounded growth.
 */
void MainWindow::limitOutputLines() {
  QTextDocument *doc = m_processOutputEdit->document();
  int excess = doc->blockCount() - MaxOutputLines;
  if (excess <= 0) {
    return;
  }

  QTextCursor cursor(doc);
  cursor.movePosition(QTextCursor::Start);
  cursor.movePosition(QTextCursor::NextBlock, QTextCursor::KeepAnchor, excess);
  cursor.removeSelectedText();
}

/**
 * @brief Clears the process output panel.
 *
 * Clears all output, resets the line counter, and re-enables auto-scroll.
 */
void MainWindow::on_clearOutputButton_clicked() {
  m_processOutputEdit->clear();
  m_outputCounter = 0;
  m_autoScroll = true;
}

IJHack / QtPass / 27629875352

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous