Add option to exclude groups from database reports by AgostonSzepessy · Pull Request #12879 · keepassxreboot/keepassxc

AgostonSzepessy · 2025-12-29T06:08:48Z

Summary

Adds an option to exclude groups from showing up in database reports. I refactored the reports code because the menu code (and other parts of the report widget classes) was duplicated across multiple files and was getting pretty complicated. Now there's a base class that implements most of the functionality shared across the 4 classes.

I added the number of excluded groups to the database stats so users know how many groups are excluded. Groups that are excluded show their entries with (Group Excluded) when excluded entries are shown. This helps differentiate them from entries that are excluded.

Group exclusion is stored using CustomData. The kdbx file format doesn't seem to support group exclusions (and entries previously used to use CustomData too), so I put it in CustomData.

The context menu in the database reports displays an option to exclude groups now too. If the user clicks them, the group is excluded. If a user wants to include an entry from an excluded group, a popup appears, and they are asked if they'd like to include all entries from that group. If they choose No, the group exclusion is removed and all the group entries except for the selected ones are marked as excluded.

Fixes #12241.

Screenshots

keepassxc-healthcheck-include-excluded-group-entry

Testing strategy

I added GUI tests in TestGui.cpp to test the healthcheck report and group exclusions and entry inclusion. It walks through the workflow a user would have. The other pages were tested manually. I had to add a new signal to ReportsWidgetHealthcheck in order for the test to be able to wait on the table to be populated; otherwise the test executes too fast and has the incorrect result.

Type of change

✅ New feature (change that adds functionality)
✅ Refactor (significant modification to existing code)

Copilot

Pull request overview

This PR adds the ability to exclude entire groups from database reports, complementing the existing entry-level exclusion feature. The implementation stores group exclusion status in CustomData using the same "KnownBad" key as legacy entry exclusions, maintains consistency across all report widgets (Healthcheck, HIBP, and Browser Statistics), and includes comprehensive GUI tests.

Key Changes

Added group-level exclusion API in Group class with methods to set/get exclusion status and bulk-mark entries
Updated all three report widgets to handle group exclusions with consistent UI labeling and context menu options
Restructured EditGroupWidgetMain.ui from a grid layout to a vertical container with a grid layout to accommodate the new exclusion checkbox
Added database statistics tracking for excluded groups count

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 20 comments.

Show a summary per file

File	Description
src/core/Group.h/cpp	Added excludeFromReports(), setExcludeFromReports(), and markAllEntriesExcludedFromReports() methods
src/core/DatabaseStats.h/cpp	Added excludedGroups counter and logic to track group exclusions
src/gui/group/EditGroupWidgetMain.ui	Restructured layout to add excludeReportsCheckBox for group exclusion
src/gui/group/EditGroupWidget.cpp	Wired up the new checkbox to load/save group exclusion state
src/gui/reports/ReportsWidgetHealthcheck.h/cpp	Added tablePopulated signal and context menu options for group exclusion
src/gui/reports/ReportsWidgetHibp.cpp	Updated to handle group exclusions with proper UI labels and context menu
src/gui/reports/ReportsWidgetBrowserStatistics.cpp	Updated to handle group exclusions with proper UI labels and context menu
src/gui/reports/ReportsWidgetStatistics.cpp	Added row displaying count of excluded groups
tests/gui/TestGui.h/cpp	Added comprehensive GUI tests for group exclusion workflow

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 17 comments.

droidmonkey · 2025-12-29T18:46:34Z

You dont need to redo the layout you can place the checkbox in the grid

AgostonSzepessy · 2025-12-30T00:15:14Z

@droidmonkey if I put it in the grid layout it pushes everything to the right. Is that OK? I personally think it looks better if it's below the grid but I can leave it as a grid layout. Here are two screenshots (one with the checkbox added and one with the "Expired" checkbox aligned to the right.

droidmonkey · 2025-12-30T00:16:55Z

Put it in the second column

AgostonSzepessy · 2025-12-30T06:40:49Z

@droidmonkey I changed the ui to add the checkbox on the right and also refactored the report widget classes. I extracted common functionality into a base class. Could you please review it? I also updated the original PR comment.

Copilot

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 6 comments.

AgostonSzepessy · 2026-01-24T23:01:37Z

@droidmonkey do you know when you'll be able to take a look at this one? Should I try splitting out the refactor into another PR to make it easier to review?

droidmonkey · 2026-04-17T02:43:09Z

To be honest, this change is rather invasive for what you set out to do. This should be vastly simplified.

Copilot

Pull request overview

Copilot reviewed 22 out of 22 changed files in this pull request and generated 9 comments.

Copilot · 2026-04-17T02:50:04Z

+    connect(excludeAction, &QAction::toggled, excludeAction, [this, selected](bool checked) {
+        QSet<Group*> groups;
+


ReportsWidgetBase.cpp uses QSet<Group*> but doesn't include <QSet>, which can cause a build failure depending on include order. Add the missing include explicitly.

Copilot · 2026-04-17T02:50:04Z

+    // Create the context menu
+    const auto menu = new QMenu(this);
+    menu->setObjectName("customMenu");
+


customMenuRequestedBase() allocates a new QMenu each time and parents it to the widget, so repeated context-menu opens will accumulate menus until the widget is destroyed. Consider marking the menu for deletion after use (e.g., delete-on-close or deleteLater() on hide) to avoid unbounded growth during a long session.

Copilot · 2026-04-17T02:50:04Z

+    menu->insertAction(menu->actions().at(3),
+                       deletePluginData); // Index 3 is the one after "Delete Entry" so place "Delete plugin" before it


Inserting the “Delete plugin data…” action at a hard-coded actions().at(3) is brittle because the base menu has a conditional “Edit Entry…” action (only when a single row is selected). With multi-selection, index 3 refers to a different action, so the insertion position changes unintentionally. Prefer inserting relative to a specific action (e.g., find the delete-entry action) rather than an index.

Suggested change

menu->insertAction(menu->actions().at(3),

deletePluginData); // Index 3 is the one after "Delete Entry" so place "Delete plugin" before it

QAction* insertBefore = nullptr;

const auto actions = menu->actions();

const auto deleteIconCacheKey = icons()->icon("entry-delete").cacheKey();

for (int i = 0; i < actions.size(); ++i) {

auto* action = actions.at(i);

if (action && action->icon().cacheKey() == deleteIconCacheKey) {

if (i + 1 < actions.size()) {

insertBefore = actions.at(i + 1);

}

break;

}

}

if (insertBefore) {

menu->insertAction(insertBefore, deletePluginData);

} else {

menu->addAction(deletePluginData);

}

Copilot · 2026-04-17T02:50:05Z

+    <item row="9" column="1">
+     <widget class="QCheckBox" name="excludeReportsCheckBox">
+      <property name="text">
+       <string>Exclude from database reports</string>
+      </property>
+     </widget>


The new excludeReportsCheckBox is missing accessibility metadata (e.g., accessibleName). Other controls in this dialog set an accessible name; add one here so screen readers can identify the checkbox reliably.

Copilot · 2026-04-17T02:50:05Z

+    QWidget* entryNewWidget = toolBar->widgetForAction(m_mainWindow->findChild<QAction*>("actionEntryNew"));
+    auto* editEntryWidget = m_dbWidget->findChild<EditEntryWidget*>("editEntryWidget");
+    auto* titleEdit = editEntryWidget->findChild<QLineEdit*>("titleEdit");
+    auto* usernameComboBox = editEntryWidget->findChild<QComboBox*>("usernameComboBox");
+    auto* passwordEdit =
+        editEntryWidget->findChild<PasswordWidget*>("passwordEdit")->findChild<QLineEdit*>("passwordEdit");
+    auto* editEntryWidgetButtonBox = editEntryWidget->findChild<QDialogButtonBox*>("buttonBox");
+
+    // Add entry to specified group
+    QVERIFY(m_dbWidget->currentGroup());
+    Group* group = m_dbWidget->currentGroup()->findChildByName(groupName);


addEntry() assumes the toolbar/action widgets and the target group exist. In particular, findChildByName(groupName) can return null, and setCurrentGroup(group) would then dereference a null pointer and crash the test. Add QVERIFY checks for the UI pointers and for group before using them so failures are reported cleanly.

Suggested change

QWidget* entryNewWidget = toolBar->widgetForAction(m_mainWindow->findChild<QAction*>("actionEntryNew"));

auto* editEntryWidget = m_dbWidget->findChild<EditEntryWidget*>("editEntryWidget");

auto* titleEdit = editEntryWidget->findChild<QLineEdit*>("titleEdit");

auto* usernameComboBox = editEntryWidget->findChild<QComboBox*>("usernameComboBox");

auto* passwordEdit =

editEntryWidget->findChild<PasswordWidget*>("passwordEdit")->findChild<QLineEdit*>("passwordEdit");

auto* editEntryWidgetButtonBox = editEntryWidget->findChild<QDialogButtonBox*>("buttonBox");

// Add entry to specified group

QVERIFY(m_dbWidget->currentGroup());

Group* group = m_dbWidget->currentGroup()->findChildByName(groupName);

QVERIFY(toolBar);

auto* entryNewAction = m_mainWindow->findChild<QAction*>("actionEntryNew");

QVERIFY(entryNewAction);

QWidget* entryNewWidget = toolBar->widgetForAction(entryNewAction);

QVERIFY(entryNewWidget);

auto* editEntryWidget = m_dbWidget->findChild<EditEntryWidget*>("editEntryWidget");

QVERIFY(editEntryWidget);

auto* titleEdit = editEntryWidget->findChild<QLineEdit*>("titleEdit");

QVERIFY(titleEdit);

auto* usernameComboBox = editEntryWidget->findChild<QComboBox*>("usernameComboBox");

QVERIFY(usernameComboBox);

auto* passwordWidget = editEntryWidget->findChild<PasswordWidget*>("passwordEdit");

QVERIFY(passwordWidget);

auto* passwordEdit = passwordWidget->findChild<QLineEdit*>("passwordEdit");

QVERIFY(passwordEdit);

auto* editEntryWidgetButtonBox = editEntryWidget->findChild<QDialogButtonBox*>("buttonBox");

QVERIFY(editEntryWidgetButtonBox);

// Add entry to specified group

QVERIFY(m_dbWidget->currentGroup());

Group* group = m_dbWidget->currentGroup()->findChildByName(groupName);

QVERIFY(group);

Copilot · 2026-04-17T02:50:05Z

+    virtual void loadSettings(QSharedPointer<Database> db);
+    virtual void saveSettings();
+
+protected:
+    virtual QTableView* getTableView() const = 0;
+    virtual void updateWidget() = 0;
+
+    QMenu* customMenuRequestedBase();
+
+public slots:
+    QList<Entry*> getSelectedEntries() const;
+    void expireSelectedEntries();
+    void deleteSelectedEntries();
+    void emitEntryActivated(const QModelIndex& index);
+
+signals:
+    void entryActivated(Entry*);
+
+protected:
+    bool m_widgetDataCalculated = false;
+    QScopedPointer<QStandardItemModel> m_referencesModel;
+    QScopedPointer<QSortFilterProxyModel> m_modelProxy;
+    QSharedPointer<Database> m_db;
+    QList<QPair<Group*, Entry*>> m_rowToEntry;


ReportsWidgetBase.h uses QSharedPointer, QScopedPointer, QList, and QPair but does not include the corresponding Qt headers (or forward-declare the templates). This will break compilation when this header is included without those transitive includes. Add the required includes (e.g., for shared/scoped pointers and containers) directly in this header.

Copilot · 2026-04-17T02:50:05Z

+                isGroupExcluded = true;
+            }
+
+            break;


The loop that determines isExcluded/isGroupExcluded breaks unconditionally after the first non-null entry, so the menu checkbox state only reflects the first selected row (not “any selected row”). This makes the context menu state incorrect for multi-selection. Iterate over all selected rows (or break only once the desired condition is met).

Suggested change

break;

if (isExcluded && isGroupExcluded) {

break;

}

Copilot · 2026-04-17T02:50:06Z

+    ReportsWidgetBase::loadSettings(db);
+    m_referencesModel->clear();
 }


ReportsWidgetHibp::loadSettings() no longer resets state like m_pwndPasswords, m_error, and the “currently edited entry” fields. This can cause results/errors from a previous run (or previous database) to persist after reloading/opening a different database. Reintroduce the state reset here before/after calling ReportsWidgetBase::loadSettings().

Copilot · 2026-04-17T02:50:06Z

+    auto* editGroupWidget = m_dbWidget->findChild<EditGroupWidget*>("editGroupWidget");
+    auto* nameEdit = editGroupWidget->findChild<QLineEdit*>("editName");
+    auto* editGroupWidgetButtonBox = editGroupWidget->findChild<QDialogButtonBox*>("buttonBox");


addGroup() dereferences widgets found via findChild() without asserting they were found. If object names/layouts change, this will crash the test instead of failing with a clear assertion. Add QVERIFY checks for editGroupWidget, nameEdit, and the button box before using them.

Suggested change

auto* editGroupWidget = m_dbWidget->findChild<EditGroupWidget*>("editGroupWidget");

auto* nameEdit = editGroupWidget->findChild<QLineEdit*>("editName");

auto* editGroupWidgetButtonBox = editGroupWidget->findChild<QDialogButtonBox*>("buttonBox");

auto* editGroupWidget = m_dbWidget->findChild<EditGroupWidget*>("editGroupWidget");

QVERIFY(editGroupWidget);

auto* nameEdit = editGroupWidget->findChild<QLineEdit*>("editName");

QVERIFY(nameEdit);

auto* editGroupWidgetButtonBox = editGroupWidget->findChild<QDialogButtonBox*>("buttonBox");

QVERIFY(editGroupWidgetButtonBox);

AgostonSzepessy · 2026-04-18T05:30:07Z

@droidmonkey how do you want me to simplify it? A large portion of the changes are refactoring the reports to reduce duplicated logic.

WinnerWind · 2026-04-19T06:27:14Z

Considering that stuff from the Recycle Bin is also excluded in database reports, it might be worth making another PR to make the Recycle Bin use this new logic, once this PR gets merged.

Copilot AI review requested due to automatic review settings December 29, 2025 06:08

Copilot started reviewing on behalf of AgostonSzepessy December 29, 2025 06:09 View session

Copilot AI reviewed Dec 29, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings December 29, 2025 06:43

Copilot started reviewing on behalf of AgostonSzepessy December 29, 2025 06:43 View session

Copilot AI reviewed Dec 29, 2025

View reviewed changes

Copilot AI review requested due to automatic review settings December 31, 2025 00:17

Copilot started reviewing on behalf of AgostonSzepessy December 31, 2025 00:18 View session

Copilot AI reviewed Dec 31, 2025

View reviewed changes

droidmonkey added ux pr: new feature Pull request adds a new feature labels Jan 25, 2026

droidmonkey added this to the v2.8.0 milestone Jan 25, 2026

Add option to exclude Group from reports

0f12ed1

Copilot AI review requested due to automatic review settings April 17, 2026 02:42

droidmonkey force-pushed the dev/agos/exclude-group-from-reports branch from 249352a to 0f12ed1 Compare April 17, 2026 02:42

Copilot started reviewing on behalf of droidmonkey April 17, 2026 02:43 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

		connect(excludeAction, &QAction::toggled, excludeAction, [this, selected](bool checked) {
		QSet<Group*> groups;

		menu->insertAction(menu->actions().at(3),
		deletePluginData); // Index 3 is the one after "Delete Entry" so place "Delete plugin" before it

-    menu->insertAction(menu->actions().at(3),
-                       deletePluginData); // Index 3 is the one after "Delete Entry" so place "Delete plugin" before it
+    QAction* insertBefore = nullptr;
+    const auto actions = menu->actions();
+    const auto deleteIconCacheKey = icons()->icon("entry-delete").cacheKey();
+    for (int i = 0; i < actions.size(); ++i) {
+        auto* action = actions.at(i);
+        if (action && action->icon().cacheKey() == deleteIconCacheKey) {
+            if (i + 1 < actions.size()) {
+                insertBefore = actions.at(i + 1);
+            }
+            break;
+        }
+    }
+    if (insertBefore) {
+        menu->insertAction(insertBefore, deletePluginData);
+    } else {
+        menu->addAction(deletePluginData);
+    }

-            break;
+            if (isExcluded && isGroupExcluded) {
+                break;
+            }

Uh oh!

Conversation

AgostonSzepessy commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Screenshots

Testing strategy

Type of change

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

droidmonkey commented Dec 29, 2025

Uh oh!

AgostonSzepessy commented Dec 30, 2025

Uh oh!

droidmonkey commented Dec 30, 2025

Uh oh!

AgostonSzepessy commented Dec 30, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AgostonSzepessy commented Jan 24, 2026

Uh oh!

droidmonkey commented Apr 17, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

AgostonSzepessy commented Dec 29, 2025 •

edited

Loading