]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/search/dolphinsearchbox.cpp
GIT_SILENT: minor qstring optimization
[dolphin.git] / src / search / dolphinsearchbox.cpp
index c178c43c7c673971fb40c0b86be6fdde8fe6bd04..f3dd204626a77cd54f99ca34a2e41b3a19f7e0aa 100644 (file)
 
 #include "dolphin_searchsettings.h"
 #include "dolphinfacetswidget.h"
+#include "panels/places/placesitemmodel.h"
 
-#include <KIcon>
-#include <KLineEdit>
-#include <KLocale>
+#include <KLocalizedString>
+#include <KNS3/KMoreToolsMenuFactory>
 #include <KSeparator>
+#include <config-baloo.h>
+#ifdef HAVE_BALOO
+#include <Baloo/Query>
+#include <Baloo/IndexerConfig>
+#endif
 
 #include <QButtonGroup>
 #include <QDir>
-#include <QEvent>
-#include <QFormLayout>
+#include <QFontDatabase>
 #include <QHBoxLayout>
-#include <QKeyEvent>
+#include <QIcon>
 #include <QLabel>
+#include <QLineEdit>
 #include <QScrollArea>
 #include <QTimer>
 #include <QToolButton>
-#include <QVBoxLayout>
-
-#include <config-baloo.h>
-#ifdef HAVE_BALOO
-    #include <baloo/query.h>
-    #include <baloo/term.h>
-    #include <baloo/indexerconfig.h>
-#endif
+#include <QUrlQuery>
 
 DolphinSearchBox::DolphinSearchBox(QWidget* parent) :
     QWidget(parent),
     m_startedSearching(false),
-    m_readOnly(false),
     m_active(true),
-    m_topLayout(0),
-    m_searchLabel(0),
-    m_searchInput(0),
-    m_optionsScrollArea(0),
-    m_fileNameButton(0),
-    m_contentButton(0),
-    m_separator(0),
-    m_fromHereButton(0),
-    m_everywhereButton(0),
-    m_facetsToggleButton(0),
-    m_facetsWidget(0),
+    m_topLayout(nullptr),
+    m_searchInput(nullptr),
+    m_saveSearchAction(nullptr),
+    m_optionsScrollArea(nullptr),
+    m_fileNameButton(nullptr),
+    m_contentButton(nullptr),
+    m_separator(nullptr),
+    m_fromHereButton(nullptr),
+    m_everywhereButton(nullptr),
+    m_facetsToggleButton(nullptr),
+    m_facetsWidget(nullptr),
     m_searchPath(),
-    m_readOnlyQuery(),
-    m_startSearchTimer(0)
+    m_startSearchTimer(nullptr)
 {
 }
 
@@ -83,29 +79,29 @@ QString DolphinSearchBox::text() const
     return m_searchInput->text();
 }
 
-void DolphinSearchBox::setSearchPath(const KUrl& url)
+void DolphinSearchBox::setSearchPath(const QUrl& url)
 {
     m_searchPath = url;
 
     QFontMetrics metrics(m_fromHereButton->font());
     const int maxWidth = metrics.height() * 8;
 
-    QString location = url.fileName();
+    const QUrl cleanedUrl = url.adjusted(QUrl::RemoveUserInfo | QUrl::StripTrailingSlash);
+    QString location = cleanedUrl.fileName();
     if (location.isEmpty()) {
-        if (url.isLocalFile()) {
-            location = QLatin1String("/");
-        } else {
-            location = url.protocol() + QLatin1String(" - ") + url.host();
-        }
+        location = cleanedUrl.toString(QUrl::PreferLocalFile);
+    }
+    if (m_fromHereButton->isChecked() && cleanedUrl.path() == QDir::homePath()) {
+        m_fromHereButton->setChecked(false);
+        m_everywhereButton->setChecked(true);
+    } else {
+        m_fromHereButton->setChecked(true);
+        m_everywhereButton->setChecked(false);
     }
 
     const QString elidedLocation = metrics.elidedText(location, Qt::ElideMiddle, maxWidth);
     m_fromHereButton->setText(i18nc("action:button", "From Here (%1)", elidedLocation));
-
-    const bool showSearchFromButtons = url.isLocalFile() && !m_readOnly;
-    m_separator->setVisible(showSearchFromButtons);
-    m_fromHereButton->setVisible(showSearchFromButtons);
-    m_everywhereButton->setVisible(showSearchFromButtons);
+    m_fromHereButton->setToolTip(i18nc("action:button", "Limit search to '%1' and its subfolders", cleanedUrl.toString(QUrl::PreferLocalFile)));
 
     bool hasFacetsSupport = false;
 #ifdef HAVE_BALOO
@@ -115,14 +111,14 @@ void DolphinSearchBox::setSearchPath(const KUrl& url)
     m_facetsWidget->setEnabled(hasFacetsSupport);
 }
 
-KUrl DolphinSearchBox::searchPath() const
+QUrl DolphinSearchBox::searchPath() const
 {
     return m_searchPath;
 }
 
-KUrl DolphinSearchBox::urlForSearching() const
+QUrl DolphinSearchBox::urlForSearching() const
 {
-    KUrl url;
+    QUrl url;
     bool useBalooSearch = false;
 #ifdef HAVE_BALOO
     const Baloo::IndexerConfig searchInfo;
@@ -131,44 +127,46 @@ KUrl DolphinSearchBox::urlForSearching() const
     if (useBalooSearch) {
         url = balooUrlForSearching();
     } else {
-        url.setProtocol("filenamesearch");
-        url.addQueryItem("search", m_searchInput->text());
+        url.setScheme(QStringLiteral("filenamesearch"));
+
+        QUrlQuery query;
+        query.addQueryItem(QStringLiteral("search"), m_searchInput->text());
         if (m_contentButton->isChecked()) {
-            url.addQueryItem("checkContent", "yes");
+            query.addQueryItem(QStringLiteral("checkContent"), QStringLiteral("yes"));
         }
 
         QString encodedUrl;
         if (m_everywhereButton->isChecked()) {
-            // It is very unlikely, that the majority of Dolphins target users
-            // mean "the whole harddisk" instead of "my home folder" when
-            // selecting the "Everywhere" button.
             encodedUrl = QDir::homePath();
         } else {
             encodedUrl = m_searchPath.url();
         }
-        url.addQueryItem("url", encodedUrl);
+        query.addQueryItem(QStringLiteral("url"), encodedUrl);
+
+        url.setQuery(query);
     }
 
     return url;
 }
 
-void DolphinSearchBox::selectAll()
+void DolphinSearchBox::fromSearchUrl(const QUrl& url)
 {
-    m_searchInput->selectAll();
-}
-
-void DolphinSearchBox::setReadOnly(bool readOnly, const KUrl& query)
-{
-    if (m_readOnly != readOnly || m_readOnlyQuery != query) {
-        m_readOnly = readOnly;
-        m_readOnlyQuery = query;
-        applyReadOnlyState();
+    if (url.scheme() == QLatin1String("baloosearch")) {
+        fromBalooSearchUrl(url);
+    } else if (url.scheme() == QLatin1String("filenamesearch")) {
+        const QUrlQuery query(url);
+        setText(query.queryItemValue(QStringLiteral("search")));
+        setSearchPath(QUrl::fromUserInput(query.queryItemValue(QStringLiteral("url")), QString(), QUrl::AssumeLocalFile));
+        m_contentButton->setChecked(query.queryItemValue(QStringLiteral("checkContent")) == QLatin1String("yes"));
+    } else {
+        setText(QString());
+        setSearchPath(url);
     }
 }
 
-bool DolphinSearchBox::isReadOnly() const
+void DolphinSearchBox::selectAll()
 {
-    return m_readOnly;
+    m_searchInput->selectAll();
 }
 
 void DolphinSearchBox::setActive(bool active)
@@ -203,6 +201,13 @@ void DolphinSearchBox::showEvent(QShowEvent* event)
     }
 }
 
+void DolphinSearchBox::hideEvent(QHideEvent* event)
+{
+    Q_UNUSED(event);
+    m_startedSearching = false;
+    m_startSearchTimer->stop();
+}
+
 void DolphinSearchBox::keyReleaseEvent(QKeyEvent* event)
 {
     QWidget::keyReleaseEvent(event);
@@ -219,8 +224,17 @@ bool DolphinSearchBox::eventFilter(QObject* obj, QEvent* event)
 {
     switch (event->type()) {
     case QEvent::FocusIn:
-        setActive(true);
-        setFocus();
+        // #379135: we get the FocusIn event when we close a tab but we don't want to emit
+        // the activated() signal before the removeTab() call in DolphinTabWidget::closeTab() returns.
+        // To avoid this issue, we delay the activation of the search box.
+        // We also don't want to schedule the activation process if we are already active,
+        // otherwise we can enter in a loop of FocusIn/FocusOut events with the searchbox of another tab.
+        if (!isActive()) {
+            QTimer::singleShot(0, this, [this] {
+                setActive(true);
+                setFocus();
+            });
+        }
         break;
 
     default:
@@ -234,6 +248,7 @@ void DolphinSearchBox::emitSearchRequest()
 {
     m_startSearchTimer->stop();
     m_startedSearching = true;
+    m_saveSearchAction->setEnabled(true);
     emit searchRequest();
 }
 
@@ -241,6 +256,7 @@ void DolphinSearchBox::emitCloseRequest()
 {
     m_startSearchTimer->stop();
     m_startedSearching = false;
+    m_saveSearchAction->setEnabled(false);
     emit closeRequest();
 }
 
@@ -254,6 +270,7 @@ void DolphinSearchBox::slotConfigurationChanged()
 
 void DolphinSearchBox::slotSearchTextChanged(const QString& text)
 {
+
     if (text.isEmpty()) {
         m_startSearchTimer->stop();
     } else {
@@ -262,10 +279,10 @@ void DolphinSearchBox::slotSearchTextChanged(const QString& text)
     emit searchTextChanged(text);
 }
 
-void DolphinSearchBox::slotReturnPressed(const QString& text)
+void DolphinSearchBox::slotReturnPressed()
 {
     emitSearchRequest();
-    emit returnPressed(text);
+    emit returnPressed();
 }
 
 void DolphinSearchBox::slotFacetsButtonToggled()
@@ -282,13 +299,25 @@ void DolphinSearchBox::slotFacetChanged()
     emit searchRequest();
 }
 
+void DolphinSearchBox::slotSearchSaved()
+{
+    const QUrl searchURL = urlForSearching();
+    if (searchURL.isValid()) {
+        PlacesItemModel model;
+        const QString label = i18n("Search for %1 in %2", text(), searchPath().fileName());
+        model.createPlacesItem(label,
+                               searchURL,
+                               QStringLiteral("folder-saved-search-symbolic"));
+    }
+}
+
 void DolphinSearchBox::initButton(QToolButton* button)
 {
     button->installEventFilter(this);
     button->setAutoExclusive(true);
     button->setAutoRaise(true);
     button->setCheckable(true);
-    connect(button, SIGNAL(clicked(bool)), this, SLOT(slotConfigurationChanged()));
+    connect(button, &QToolButton::clicked, this, &DolphinSearchBox::slotConfigurationChanged);
 }
 
 void DolphinSearchBox::loadSettings()
@@ -310,10 +339,10 @@ void DolphinSearchBox::loadSettings()
 
 void DolphinSearchBox::saveSettings()
 {
-    SearchSettings::setLocation(m_fromHereButton->isChecked() ? "FromHere" : "Everywhere");
-    SearchSettings::setWhat(m_fileNameButton->isChecked() ? "FileName" : "Content");
+    SearchSettings::setLocation(m_fromHereButton->isChecked() ? QStringLiteral("FromHere") : QStringLiteral("Everywhere"));
+    SearchSettings::setWhat(m_fileNameButton->isChecked() ? QStringLiteral("FileName") : QStringLiteral("Content"));
     SearchSettings::setShowFacetsWidget(m_facetsToggleButton->isChecked());
-    SearchSettings::self()->writeConfig();
+    SearchSettings::self()->save();
 }
 
 void DolphinSearchBox::init()
@@ -321,29 +350,34 @@ void DolphinSearchBox::init()
     // Create close button
     QToolButton* closeButton = new QToolButton(this);
     closeButton->setAutoRaise(true);
-    closeButton->setIcon(KIcon("dialog-close"));
+    closeButton->setIcon(QIcon::fromTheme(QStringLiteral("dialog-close")));
     closeButton->setToolTip(i18nc("@info:tooltip", "Quit searching"));
-    connect(closeButton, SIGNAL(clicked()), this, SLOT(emitCloseRequest()));
-
-    // Create search label
-    m_searchLabel = new QLabel(this);
+    connect(closeButton, &QToolButton::clicked, this, &DolphinSearchBox::emitCloseRequest);
 
     // Create search box
-    m_searchInput = new KLineEdit(this);
+    m_searchInput = new QLineEdit(this);
+    m_searchInput->setPlaceholderText(i18n("Search..."));
     m_searchInput->installEventFilter(this);
-    m_searchInput->setClearButtonShown(true);
-    m_searchInput->setFont(KGlobalSettings::generalFont());
+    m_searchInput->setClearButtonEnabled(true);
+    m_searchInput->setFont(QFontDatabase::systemFont(QFontDatabase::GeneralFont));
+    connect(m_searchInput, &QLineEdit::returnPressed,
+            this, &DolphinSearchBox::slotReturnPressed);
+    connect(m_searchInput, &QLineEdit::textChanged,
+            this, &DolphinSearchBox::slotSearchTextChanged);
     setFocusProxy(m_searchInput);
-    connect(m_searchInput, SIGNAL(returnPressed(QString)),
-            this, SLOT(slotReturnPressed(QString)));
-    connect(m_searchInput, SIGNAL(textChanged(QString)),
-            this, SLOT(slotSearchTextChanged(QString)));
+
+    // Add "Save search" button inside search box
+    m_saveSearchAction = new QAction(this);
+    m_saveSearchAction->setIcon (QIcon::fromTheme(QStringLiteral("document-save-symbolic")));
+    m_saveSearchAction->setText(i18nc("action:button", "Save this search to quickly access it again in the future"));
+    m_saveSearchAction->setEnabled(false);
+    m_searchInput->addAction(m_saveSearchAction, QLineEdit::TrailingPosition);
+    connect(m_saveSearchAction, &QAction::triggered, this, &DolphinSearchBox::slotSearchSaved);
 
     // Apply layout for the search input
     QHBoxLayout* searchInputLayout = new QHBoxLayout();
-    searchInputLayout->setMargin(0);
+    searchInputLayout->setContentsMargins(0, 0, 0, 0);
     searchInputLayout->addWidget(closeButton);
-    searchInputLayout->addWidget(m_searchLabel);
     searchInputLayout->addWidget(m_searchInput);
 
     // Create "Filename" and "Content" button
@@ -361,40 +395,59 @@ void DolphinSearchBox::init()
 
     m_separator = new KSeparator(Qt::Vertical, this);
 
-    // Create "From Here" and "Everywhere"button
+    // Create "From Here" and "Your files" buttons
     m_fromHereButton = new QToolButton(this);
     m_fromHereButton->setText(i18nc("action:button", "From Here"));
     initButton(m_fromHereButton);
 
     m_everywhereButton = new QToolButton(this);
-    m_everywhereButton->setText(i18nc("action:button", "Everywhere"));
+    m_everywhereButton->setText(i18nc("action:button", "Your files"));
+    m_everywhereButton->setToolTip(i18nc("action:button", "Search in your home directory"));
+    m_everywhereButton->setIcon(QIcon::fromTheme(QStringLiteral("user-home")));
+    m_everywhereButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
     initButton(m_everywhereButton);
 
     QButtonGroup* searchLocationGroup = new QButtonGroup(this);
     searchLocationGroup->addButton(m_fromHereButton);
     searchLocationGroup->addButton(m_everywhereButton);
 
+    auto moreSearchToolsButton = new QToolButton(this);
+    moreSearchToolsButton->setAutoRaise(true);
+    moreSearchToolsButton->setPopupMode(QToolButton::InstantPopup);
+    moreSearchToolsButton->setIcon(QIcon::fromTheme("arrow-down-double"));
+    moreSearchToolsButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
+    moreSearchToolsButton->setText(i18n("More Search Tools"));
+    moreSearchToolsButton->setMenu(new QMenu(this));
+    connect(moreSearchToolsButton->menu(), &QMenu::aboutToShow, moreSearchToolsButton->menu(), [this, moreSearchToolsButton]()
+    {
+        m_menuFactory.reset(new KMoreToolsMenuFactory("dolphin/search-tools"));
+        moreSearchToolsButton->menu()->clear();
+        m_menuFactory->fillMenuFromGroupingNames(moreSearchToolsButton->menu(), { "files-find" }, this->m_searchPath);
+    } );
+
     // Create "Facets" widgets
     m_facetsToggleButton = new QToolButton(this);
     m_facetsToggleButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
     initButton(m_facetsToggleButton);
-    connect(m_facetsToggleButton, SIGNAL(clicked()), this, SLOT(slotFacetsButtonToggled()));
+    connect(m_facetsToggleButton, &QToolButton::clicked, this, &DolphinSearchBox::slotFacetsButtonToggled);
 
     m_facetsWidget = new DolphinFacetsWidget(this);
     m_facetsWidget->installEventFilter(this);
     m_facetsWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Maximum);
-    connect(m_facetsWidget, SIGNAL(facetChanged()), this, SLOT(slotFacetChanged()));
+    connect(m_facetsWidget, &DolphinFacetsWidget::facetChanged, this, &DolphinSearchBox::slotFacetChanged);
 
     // Apply layout for the options
     QHBoxLayout* optionsLayout = new QHBoxLayout();
-    optionsLayout->setMargin(0);
+    optionsLayout->setContentsMargins(0, 0, 0, 0);
     optionsLayout->addWidget(m_fileNameButton);
     optionsLayout->addWidget(m_contentButton);
     optionsLayout->addWidget(m_separator);
     optionsLayout->addWidget(m_fromHereButton);
     optionsLayout->addWidget(m_everywhereButton);
-    optionsLayout->addStretch(1);
+    optionsLayout->addWidget(new KSeparator(Qt::Vertical, this));
     optionsLayout->addWidget(m_facetsToggleButton);
+    optionsLayout->addWidget(moreSearchToolsButton);
+    optionsLayout->addStretch(1);
 
     // Put the options into a QScrollArea. This prevents increasing the view width
     // in case that not enough width for the options is available.
@@ -411,7 +464,7 @@ void DolphinSearchBox::init()
     m_optionsScrollArea->setWidgetResizable(true);
 
     m_topLayout = new QVBoxLayout(this);
-    m_topLayout->setMargin(0);
+    m_topLayout->setContentsMargins(0, 0, 0, 0);
     m_topLayout->addLayout(searchInputLayout);
     m_topLayout->addWidget(m_optionsScrollArea);
     m_topLayout->addWidget(m_facetsWidget);
@@ -423,73 +476,89 @@ void DolphinSearchBox::init()
     m_startSearchTimer = new QTimer(this);
     m_startSearchTimer->setSingleShot(true);
     m_startSearchTimer->setInterval(1000);
-    connect(m_startSearchTimer, SIGNAL(timeout()), this, SLOT(emitSearchRequest()));
+    connect(m_startSearchTimer, &QTimer::timeout, this, &DolphinSearchBox::emitSearchRequest);
 
     updateFacetsToggleButton();
-    applyReadOnlyState();
 }
 
-KUrl DolphinSearchBox::balooUrlForSearching() const
+QUrl DolphinSearchBox::balooUrlForSearching() const
 {
 #ifdef HAVE_BALOO
     const QString text = m_searchInput->text();
 
     Baloo::Query query;
-    query.addType("File");
-    query.addTypes(m_facetsWidget->facetTypes());
-
-    Baloo::Term term(Baloo::Term::And);
+    query.addType(m_facetsWidget->facetType());
 
-    Baloo::Term ratingTerm = m_facetsWidget->ratingTerm();
-    if (ratingTerm.isValid()) {
-        term.addSubTerm(ratingTerm);
+    QStringList queryStrings;
+    QString ratingQuery = m_facetsWidget->ratingTerm();
+    if (!ratingQuery.isEmpty()) {
+        queryStrings << ratingQuery;
     }
 
     if (m_contentButton->isChecked()) {
-        query.setSearchString(text);
-    } else {
-        term.addSubTerm(Baloo::Term("filename", text));
+        queryStrings << text;
+    } else if (!text.isEmpty()) {
+        queryStrings << QStringLiteral("filename:\"%1\"").arg(text);
     }
 
     if (m_fromHereButton->isChecked()) {
-        query.addCustomOption("includeFolder", m_searchPath.toLocalFile());
+        query.setIncludeFolder(m_searchPath.toLocalFile());
     }
 
+    query.setSearchString(queryStrings.join(QLatin1Char(' ')));
+
     return query.toSearchUrl(i18nc("@title UDS_DISPLAY_NAME for a KIO directory listing. %1 is the query the user entered.",
                                    "Query Results from '%1'", text));
 #else
-    return KUrl();
+    return QUrl();
 #endif
 }
 
-void DolphinSearchBox::applyReadOnlyState()
+void DolphinSearchBox::fromBalooSearchUrl(const QUrl& url)
 {
 #ifdef HAVE_BALOO
-    if (m_readOnly) {
-        m_searchLabel->setText(Baloo::Query::titleFromQueryUrl(m_readOnlyQuery));
+    const Baloo::Query query = Baloo::Query::fromSearchUrl(url);
+
+    // Block all signals to avoid unnecessary "searchRequest" signals
+    // while we adjust the search text and the facet widget.
+    blockSignals(true);
+
+    const QString customDir = query.includeFolder();
+    if (!customDir.isEmpty()) {
+        setSearchPath(QUrl::fromLocalFile(customDir));
     } else {
-#else
-    {
-#endif
-        m_searchLabel->setText(i18nc("@label:textbox", "Find:"));
+        setSearchPath(QUrl::fromLocalFile(QDir::homePath()));
     }
 
-    m_searchInput->setVisible(!m_readOnly);
-    m_optionsScrollArea->setVisible(!m_readOnly);
+    setText(query.searchString());
 
-    if (m_readOnly) {
-        m_facetsWidget->hide();
-    } else {
-        m_facetsWidget->setVisible(SearchSettings::showFacetsWidget());
+    QStringList types = query.types();
+    if (!types.isEmpty()) {
+        m_facetsWidget->setFacetType(types.first());
     }
+
+    const QStringList subTerms = query.searchString().split(' ', QString::SkipEmptyParts);
+    foreach (const QString& subTerm, subTerms) {
+        if (subTerm.startsWith(QLatin1String("filename:"))) {
+            const QString value = subTerm.mid(9);
+            setText(value);
+        } else if (m_facetsWidget->isRatingTerm(subTerm)) {
+            m_facetsWidget->setRatingTerm(subTerm);
+        }
+    }
+
+    m_startSearchTimer->stop();
+    blockSignals(false);
+#else
+    Q_UNUSED(url);
+#endif
 }
 
 void DolphinSearchBox::updateFacetsToggleButton()
 {
     const bool facetsIsVisible = SearchSettings::showFacetsWidget();
     m_facetsToggleButton->setChecked(facetsIsVisible ? true : false);
-    m_facetsToggleButton->setIcon(KIcon(facetsIsVisible ? "arrow-up-double" : "arrow-down-double"));
+    m_facetsToggleButton->setIcon(QIcon::fromTheme(facetsIsVisible ? QStringLiteral("arrow-up-double") : QStringLiteral("arrow-down-double")));
     m_facetsToggleButton->setText(facetsIsVisible ? i18nc("action:button", "Fewer Options") : i18nc("action:button", "More Options"));
 }
 
-#include "dolphinsearchbox.moc"