Implement advanced search #1797

droidmonkey · 2018-03-31T03:07:22Z

Description

Fully implements advanced searching and other search related features/issues. Eliminates the searching of group names and notes. End search after selecting a folder if global search is active (Fixes #1501). Also took the opportunity to clean up the ugly/messy entry view and model code surrounding searching.

Fixes #239 using the following syntax:

[modifiers][field:]["]term["]

Where modifiers can be any combo of:

- exclude this term from results
+ match this term exactly
* term is handled as a regex

Where field can be one of:

title
user[name]
pass[word]
url
notes
attr[ibute]
attach[ment]

If field is omitted or non-existent the default is to search title, username, url, and notes.

Where term can contain wildcard terms (if NOT regex) of:

* match anything (or nothing)
? match any one character
| logical OR

Sample search queries:

user:jon url:google Search username for jon and url for google
user:jon|hifi Search username for jon OR hifi
+user:jon -url:google *notes:"secret note \d" Search username exactly jon, url cannot contain google, and notes contains secret note [digit]

Motivation and context

Long requested feature

How has this been tested?

Manually and with new search term parser tests.

Types of changes

✅ New feature (non-breaking change which adds functionality)

Checklist:

✅ I have read the CONTRIBUTING document. [REQUIRED]
✅ My code follows the code style of this project. [REQUIRED]
✅ All new and existing tests passed. [REQUIRED]
✅ I have compiled and verified my code with -DWITH_ASAN=ON. [REQUIRED]
✅ My change requires a change to the documentation and I have updated it accordingly.
✅ I have added tests to cover my changes.

TheZ3ro · 2018-03-31T11:04:57Z

src/core/EntrySearcher.cpp

+        }
+
+        // Short circuit if we failed to match or we matched and are excluding this term
+        if (!found || term->exclude) {
            return false;


Shouldn't this be a continue instead? It is into a for and returning here will skip all next term in the for if the current is excluded

It is a short circuit because this function only returns true if all the terms match this particular entry (implicit AND of terms).

ok make sense

yan12125 · 2018-03-31T19:12:44Z

* term is handled as a regex

I like this idea ;-) Looking forward to reusing this for #1769

droidmonkey · 2018-03-31T19:58:07Z

Right, forgot about that, lemme extract the wildcard scrub and regex builder into the tools class

insideClaw · 2018-05-07T15:59:00Z

Sounds like exactly what was a deal-maker for me to start using KeePassXC, that it doesn't currently match a lot of sites despite similarities in the name and URL. +1

phoerious

Looks good. One or two nitpicks. And some of the methods could use doc blocks.

src/core/EntrySearcher.cpp

src/core/EntrySearcher.h

src/core/Tools.cpp

Changes made and committed

phoerious

What's the state of this?

droidmonkey · 2018-10-21T03:00:35Z

Going to make a couple additions and then it will be ready

intika · 2018-10-31T11:05:42Z

@droidmonkey Great work this is very useful tested it and it seem to work as expected...
Just one thing, the search syntax is not intuitive you should add a hint in the search box... instead of "Search..." something like "Search... (+pass:keyword)" or "Search... (+user:keyword)"... easy modification...
or a drop-down list but this would be for a future PR i guess

droidmonkey · 2018-11-02T01:30:23Z

I made a pretty awesome search help pop-up. Any feedback?

intika · 2018-11-02T03:16:25Z

Amazing indeed... that will be useful to remember the syntax

phoerious · 2018-11-02T06:34:31Z

Despicable. 😉
No, great pop-up, but I would prefer if it had the QLineEdit background. And I would replace the part in brackets after the description with only "(logical AND)". Making a verb of "and" sounds rather clunky to me.

phoerious · 2018-11-02T06:37:09Z

Oh, and could you perhaps make a generic help pop-up widget of it? We could use that in other parts as well.

phoerious

Two minor nitpicks, rest looks great.

src/gui/widgets/PopupHelpWidget.cpp

src/gui/widgets/PopupHelpWidget.h

* Remove searching of group title and notes * End search when selecting a new group * Correct entry searcher tests to align with new code

* Support quoted strings & per-field searching * Support regex and exact matching * Simplify search sequence * Make search widget larger * Add regex converter to Tools namespace

* Search clears if the search box does not have focus for 5 minutes (fixes #2178) * Goto group from search results after double clicking the group name (fixes #2043)

* Support ! modifier (same as '-') * Create reusable PopupHelpWidget as self-contained popup that can be positioned around a parent widget and will follow the movement and sizing of the window * Eliminated KEEPASSXC_MAIN_WINDOW macro and replaced with getMainWindow() function * Add tests to cover search help show/hide

droidmonkey · 2018-11-17T14:13:28Z

Done, and fixed the wording on the help popup, made background white, and fixed the border. Also squashed commits.

- New Database Wizard [#1952] - Advanced Search [#1797] - Automatic update checker [#2648] - KeeShare database synchronization [#2109, #1992, #2738, #2742, #2746, #2739] - Improve favicon fetching; transition to Duck-Duck-Go [#2795, #2011, #2439] - Remove KeePassHttp support [#1752] - CLI: output info to stderr for easier scripting [#2558] - CLI: Add --quiet option [#2507] - CLI: Add create command [#2540] - CLI: Add recursive listing of entries [#2345] - CLI: Fix stdin/stdout encoding on Windows [#2425] - SSH Agent: Support OpenSSH for Windows [#1994] - macOS: TouchID Quick Unlock [#1851] - macOS: Multiple improvements; include CLI in DMG [#2165, #2331, #2583] - Linux: Prevent Klipper from storing secrets in clipboard [#1969] - Linux: Use polling based file watching for NFS [#2171] - Linux: Enable use of browser plugin in Snap build [#2802] - TOTP QR Code Generator [#1167] - High-DPI Scaling for 4k screens [#2404] - Make keyboard shortcuts more consistent [#2431] - Warn user if deleting referenced entries [#1744] - Allow toolbar to be hidden and repositioned [#1819, #2357] - Increase max allowed database timeout to 12 hours [#2173] - Password generator uses existing password length by default [#2318] - Improve alert message box button labels [#2376] - Show message when a database merge makes no changes [#2551] - Browser Integration Enhancements [#1497, #2253, #1904, #2232, #1850, #2218, #2391, #2396, #2542, #2622, #2637, #2790] - Overall Code Improvements [#2316, #2284, #2351, #2402, #2410, #2419, #2422, #2443, #2491, #2506, #2610, #2667, #2709, #2731]

droidmonkey added the new feature label Mar 31, 2018

droidmonkey added this to the v2.4.0 milestone Mar 31, 2018

droidmonkey requested a review from a team March 31, 2018 03:07

TheZ3ro reviewed Mar 31, 2018

View reviewed changes

droidmonkey force-pushed the feature/better-search branch 2 times, most recently from f6d24da to b0a8551 Compare April 3, 2018 01:35

This was referenced May 9, 2018

Search behaves unexpectedly when switching tabs #1631

Closed

Improve search by selected group interface because right now it is not intuitive. #1949

Closed

droidmonkey mentioned this pull request May 25, 2018

[FEATURE] Hide the search results after a click in the "page tree" #1999

Closed

droidmonkey force-pushed the feature/better-search branch from b0a8551 to 524607b Compare June 24, 2018 23:51

droidmonkey force-pushed the feature/better-search branch from 524607b to c7ffcda Compare July 9, 2018 00:37

mtelgkamp mentioned this pull request Jul 27, 2018

Reset search on folder change #2156

Closed

droidmonkey mentioned this pull request Aug 8, 2018

Want ability to search only on one column (Title, mainly) #2187

Closed

droidmonkey force-pushed the feature/better-search branch from c7ffcda to 1734a3f Compare August 29, 2018 15:09

droidmonkey mentioned this pull request Sep 1, 2018

Clear Search bar after switching to a category in a left sidebar #2199

Closed

phoerious previously requested changes Sep 2, 2018

View reviewed changes

src/core/EntrySearcher.cpp Outdated Show resolved Hide resolved

src/core/EntrySearcher.h Outdated Show resolved Hide resolved

src/core/Tools.cpp Outdated Show resolved Hide resolved

This was referenced Sep 11, 2018

[Feature] Clear search and show folder on navigating through group tree #2278

Closed

Focus search on unlocking database #2279

Closed

droidmonkey force-pushed the feature/better-search branch 2 times, most recently from 665000a to 6cad130 Compare September 16, 2018 13:43

droidmonkey self-assigned this Sep 25, 2018

droidmonkey force-pushed the feature/better-search branch from 6cad130 to 3b993ef Compare October 9, 2018 21:46

droidmonkey mentioned this pull request Oct 19, 2018

Search by Password #2397

Closed

phoerious approved these changes Oct 20, 2018

View reviewed changes

droidmonkey force-pushed the feature/better-search branch from 3b993ef to 99cfe23 Compare November 2, 2018 01:33

droidmonkey force-pushed the feature/better-search branch 2 times, most recently from 08fecf3 to cfdac14 Compare November 16, 2018 15:39

phoerious requested changes Nov 17, 2018

View reviewed changes

src/gui/widgets/PopupHelpWidget.cpp Outdated Show resolved Hide resolved

src/gui/widgets/PopupHelpWidget.h Outdated Show resolved Hide resolved

src/gui/widgets/PopupHelpWidget.h Outdated Show resolved Hide resolved

droidmonkey added 5 commits November 17, 2018 08:49

Streamlined searcher code

d8d758f

* Remove searching of group title and notes * End search when selecting a new group * Correct entry searcher tests to align with new code

Clean up Entry Model/View code

4b57fcb

Add advanced search term parser

4b98325

* Support quoted strings & per-field searching * Support regex and exact matching * Simplify search sequence * Make search widget larger * Add regex converter to Tools namespace

Implement search auto-clear and goto group

d6ffee5

* Search clears if the search box does not have focus for 5 minutes (fixes #2178) * Goto group from search results after double clicking the group name (fixes #2043)

droidmonkey force-pushed the feature/better-search branch from fc090b2 to 880c3ae Compare November 17, 2018 14:12

Correct logic error in EntrySearcher and add more tests

3400769

phoerious approved these changes Nov 17, 2018

View reviewed changes

droidmonkey merged commit 917c4cc into develop Nov 17, 2018

droidmonkey deleted the feature/better-search branch November 17, 2018 16:51

droidmonkey mentioned this pull request Jan 21, 2019

Search droidmonkey/keepassxc-docs#7

Closed

TRSx80 mentioned this pull request May 3, 2020

Attributes not searched by default? #4696

Open

michaelk83 mentioned this pull request Jun 4, 2021

Missing documentation for advanced search syntax #6589

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement advanced search #1797

Implement advanced search #1797

droidmonkey commented Mar 31, 2018 •

edited

Loading

TheZ3ro Mar 31, 2018

droidmonkey Mar 31, 2018 •

edited

Loading

TheZ3ro Mar 31, 2018

yan12125 commented Mar 31, 2018

droidmonkey commented Mar 31, 2018 •

edited

Loading

insideClaw commented May 7, 2018 •

edited

Loading

phoerious left a comment •

edited

Loading

phoerious left a comment

droidmonkey commented Oct 21, 2018

intika commented Oct 31, 2018 •

edited

Loading

droidmonkey commented Nov 2, 2018 •

edited

Loading

intika commented Nov 2, 2018

phoerious commented Nov 2, 2018

phoerious commented Nov 2, 2018

phoerious left a comment

droidmonkey commented Nov 17, 2018

Implement advanced search #1797

Implement advanced search #1797

Conversation

droidmonkey commented Mar 31, 2018 • edited Loading

Description

Motivation and context

How has this been tested?

Types of changes

Checklist:

TheZ3ro Mar 31, 2018

Choose a reason for hiding this comment

droidmonkey Mar 31, 2018 • edited Loading

Choose a reason for hiding this comment

TheZ3ro Mar 31, 2018

Choose a reason for hiding this comment

yan12125 commented Mar 31, 2018

droidmonkey commented Mar 31, 2018 • edited Loading

insideClaw commented May 7, 2018 • edited Loading

phoerious left a comment • edited Loading

Choose a reason for hiding this comment

phoerious left a comment

Choose a reason for hiding this comment

droidmonkey commented Oct 21, 2018

intika commented Oct 31, 2018 • edited Loading

droidmonkey commented Nov 2, 2018 • edited Loading

intika commented Nov 2, 2018

phoerious commented Nov 2, 2018

phoerious commented Nov 2, 2018

phoerious left a comment

Choose a reason for hiding this comment

droidmonkey commented Nov 17, 2018

droidmonkey commented Mar 31, 2018 •

edited

Loading

droidmonkey Mar 31, 2018 •

edited

Loading

droidmonkey commented Mar 31, 2018 •

edited

Loading

insideClaw commented May 7, 2018 •

edited

Loading

phoerious left a comment •

edited

Loading

intika commented Oct 31, 2018 •

edited

Loading

droidmonkey commented Nov 2, 2018 •

edited

Loading