Drop wildcard support for address/label search in `AddressBookPage` #592

hebasto commented at 7:32 PM on April 23, 2022: member

Wildcard support for address/label search in AddressBookPage was introduced in bitcoin/bitcoin#12080, and it is available in release binaries since v0.17.

But this feature has never being documented or mentioned in the GUI.

Thus, there are no reasons to believe that users rely on this feature.

Required for migration to Qt 6, because:

There is no direct way to do wildcard matching in QRegularExpression.

Tests included.

~Based on bitcoin-core/gui#591, so only last 2 commits belong to this PR.~

hebasto added the label Feature on Apr 23, 2022

hebasto added the label Tests on Apr 23, 2022

hebasto added the label UX on Apr 23, 2022

DrahtBot commented at 3:50 AM on April 24, 2022: contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

#593 (Getting ready to Qt 6 (8/n). Use QRegularExpression in AddressBookSortFilterProxyModel class by hebasto)
#585 (Replace QRegExp with QRegularExpression by prusnak)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

luke-jr commented at 6:12 PM on May 8, 2022: member

cc @promag

luke-jr commented at 6:15 PM on May 8, 2022: member

"However, the wildcardToRegularExpression method is provided to translate glob patterns into a Perl-compatible regular expression that can be used for that purpose."

Seems like it should be trivial to retain this feature, if we want to?

laanwj commented at 12:40 PM on May 9, 2022: member

~0 on this. As I've said on IRC I don't particularly care for this feature to go (I don't think the entire Address Book is particularly useful, searching in the Transactions tab should cover it?), though "being compatible with Qt 6" is a strange motivation. As @luke-jr says it would still be possible by rewriting the expression.

hebasto referenced this in commit 3dd95cb5c2 on May 9, 2022

qt: Drop wildcard support for address/label search in `AddressBookPage`

Such support was never mentioned in release notes or in the GUI.
Required for migration to Qt 6, because "There is no direct way to do
wildcard matching in QRegularExpression."
See https://doc.qt.io/qt-6/qregexp.html#porting-to-qregularexpression

d5a4ed81f5

qt, test: Add tests for searching in `AddressBookPage` dialog 555b673fbc

hebasto force-pushed on May 9, 2022

hebasto commented at 8:26 PM on May 9, 2022: member

Rebased on top of the merged #591.

sidhujag referenced this in commit 049283e67f on May 9, 2022

hebasto commented at 8:16 PM on May 20, 2022: member

@luke-jr

"However, the wildcardToRegularExpression method is provided to translate glob patterns into a Perl-compatible regular expression that can be used for that purpose."

Seems like it should be trivial to retain this feature, if we want to?

Would you mind provide a working example please?

in src/qt/addressbookpage.cpp:144 in 555b673fbc

 139 | @@ -143,7 +140,9 @@ void AddressBookPage::setModel(AddressTableModel *_model)
 140 |      proxyModel = new AddressBookSortFilterProxyModel(type, this);
 141 |      proxyModel->setSourceModel(_model);
 142 |  
 143 | -    connect(ui->searchLineEdit, &QLineEdit::textChanged, proxyModel, &QSortFilterProxyModel::setFilterWildcard);
 144 | +    connect(ui->searchLineEdit, &QLineEdit::textChanged, [this](const QString& pattern) {
 145 | +        proxyModel->setFilterFixedString(pattern);

promag commented at 10:05 AM on May 21, 2022:

In fact setFilterWildcard in Qt6 already handles the change noted in the porting documentation:

There is no direct way to do wildcard matching in QRegularExpression. However, the wildcardToRegularExpression method is provided to translate glob patterns into a Perl-compatible regular expression that can be used for that purpose.

Qt5

void QSortFilterProxyModel::setFilterFixedString(const QString &pattern)
{
    Q_D(QSortFilterProxyModel);
    d->filter_about_to_be_changed();
    QRegExp rx(pattern, d->filter_data.caseSensitivity(), QRegExp::FixedString);
    d->filter_data.setRegExp(rx);
    d->filter_changed();
}

Qt6

void QSortFilterProxyModel::setFilterWildcard(const QString &pattern)
{
    Q_D(QSortFilterProxyModel);
    d->filter_regularexpression.removeBindingUnlessInWrapper();
    d->filter_about_to_be_changed();
    d->set_filter_pattern(QRegularExpression::wildcardToRegularExpression(
            pattern, QRegularExpression::UnanchoredWildcardConversion));
    d->filter_changed(QSortFilterProxyModelPrivate::Direction::Rows);
    d->filter_regularexpression.notify();
}

hebasto commented at 1:47 PM on May 21, 2022:

#593 (review)

promag commented at 10:15 AM on May 21, 2022: contributor

Tested ACK 555b673fbc71412908bb73c9c71d49895270335f.

TBH I didn't think about using a wildcard in the search field, so setFilterFixedString would be sufficient.

The only issue I have is breaking someone's expectation, as this is a breaking change - using wildcard results in an empty list where before it could list some addresses. I understand it's not documented but it's available for some time. Maybe could validate the search field to disallow wildcard, like:

yle, Mode _mode,
 {
     ui->setupUi(this);

+    auto validator = new QRegularExpressionValidator(QRegularExpression("[^\\*]*"), this);
+    ui->searchLineEdit->setValidator(validator);
+
     if (!platformStyle->getImagesOnButtons()) {
         ui->newAddress->setIcon(QIcon());
         ui->copyAddress->setIcon(QIcon());

Finally, if we stick to supporting wildcard then no changes are required as explained in the comment below (but didn't test with Qt6).

hebasto commented at 3:51 PM on May 21, 2022: member

Combined into #593.

hebasto closed this on May 21, 2022

hebasto deleted the branch on May 24, 2022

bitcoin-core locked this on May 24, 2023