]> cloud.milkyroute.net Git - dolphin.git/blobdiff - src/search/dolphinsearchbox.cpp
Merge remote-tracking branch 'origin/KDE/4.9'
[dolphin.git] / src / search / dolphinsearchbox.cpp
index f12df73f3cd3500f912a7e1d2df7b5e358c037fa..8b660712a1abff9545499a6164892d62e734f41e 100644 (file)
 #include "dolphinsearchbox.h"
 
 #include "dolphin_searchsettings.h"
+#include "dolphinfacetswidget.h"
+#include "dolphinsearchinformation.h"
 
-#include <kicon.h>
-#include <klineedit.h>
-#include <klocale.h>
-#include <kseparator.h>
+#include <KIcon>
+#include <KLineEdit>
+#include <KLocale>
+#include <KSeparator>
 
 #include <QButtonGroup>
 #include <QDir>
 #include <QHBoxLayout>
 #include <QKeyEvent>
 #include <QLabel>
-#include <QPushButton>
+#include <QScrollArea>
 #include <QTimer>
 #include <QToolButton>
 #include <QVBoxLayout>
 
 #include <config-nepomuk.h>
 #ifdef HAVE_NEPOMUK
-    #include <nepomuk/andterm.h>
-    #include <nepomuk/filequery.h>
-    #include <nepomuk/literalterm.h>
-    #include <nepomuk/query.h>
-    #include <nepomuk/queryparser.h>
-    #include <nepomuk/resourcemanager.h>
-    #include <nepomuk/resourcetypeterm.h>
-    #include "nfo.h"
-
-    #include "filters/datesearchfilterwidget.h"
-    #include "filters/ratingsearchfilterwidget.h"
-    #include "filters/tagsearchfilterwidget.h"
+    #include <Nepomuk2/Query/AndTerm>
+    #include <Nepomuk2/Query/FileQuery>
+    #include <Nepomuk2/Query/LiteralTerm>
+    #include <Nepomuk2/Query/OrTerm>
+    #include <Nepomuk2/Query/Query>
+    #include <Nepomuk2/Query/QueryParser>
+    #include <Nepomuk2/Query/ResourceTypeTerm>
+    #include <Nepomuk2/Query/ComparisonTerm>
+    #include <Nepomuk2/ResourceManager>
+    #include <Nepomuk2/Vocabulary/NFO>
 #endif
 
 DolphinSearchBox::DolphinSearchBox(QWidget* parent) :
     QWidget(parent),
     m_startedSearching(false),
-    m_nepomukActivated(false),
+    m_readOnly(false),
     m_topLayout(0),
+    m_searchLabel(0),
     m_searchInput(0),
-    m_fromHereButton(0),
-    m_everywhereButton(0),
+    m_optionsScrollArea(0),
     m_fileNameButton(0),
     m_contentButton(0),
-    m_filterButton(0),
-    m_filterWidgetsLayout(0),
-    m_filterWidgets(),
+    m_separator(0),
+    m_fromHereButton(0),
+    m_everywhereButton(0),
+    m_facetsToggleButton(0),
+    m_facetsWidget(0),
     m_searchPath(),
+    m_readOnlyQuery(),
     m_startSearchTimer(0)
 {
 }
@@ -77,6 +80,11 @@ DolphinSearchBox::~DolphinSearchBox()
     saveSettings();
 }
 
+void DolphinSearchBox::setText(const QString& text)
+{
+    m_searchInput->setText(text);
+}
+
 QString DolphinSearchBox::text() const
 {
     return m_searchInput->text();
@@ -85,7 +93,30 @@ QString DolphinSearchBox::text() const
 void DolphinSearchBox::setSearchPath(const KUrl& url)
 {
     m_searchPath = url;
-    m_filterButton->setVisible(isSearchPathIndexed());
+
+    QFontMetrics metrics(m_fromHereButton->font());
+    const int maxWidth = metrics.height() * 8;
+
+    QString location = url.fileName();
+    if (location.isEmpty()) {
+        if (url.isLocalFile()) {
+            location = QLatin1String("/");
+        } else {
+            location = url.protocol() + QLatin1String(" - ") + url.host();
+        }
+    }
+
+    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);
+
+    const DolphinSearchInformation& searchInfo = DolphinSearchInformation::instance();
+    const bool hasFacetsSupport = searchInfo.isIndexingEnabled() && searchInfo.isPathIndexed(m_searchPath);
+    m_facetsWidget->setEnabled(hasFacetsSupport);
 }
 
 KUrl DolphinSearchBox::searchPath() const
@@ -96,37 +127,54 @@ KUrl DolphinSearchBox::searchPath() const
 KUrl DolphinSearchBox::urlForSearching() const
 {
     KUrl url;
-    if (isSearchPathIndexed() && !m_fileNameButton->isChecked()) {
-        // TODO: Currently Nepomuk is not used for searching filenames. Nepomuk
-        // is capable to provide this, but further investigations are necessary to
-        // also support regular expressions.
+    const DolphinSearchInformation& searchInfo = DolphinSearchInformation::instance();
+    if (searchInfo.isIndexingEnabled() && searchInfo.isPathIndexed(m_searchPath)) {
         url = nepomukUrlForSearching();
     } else {
-        url = m_searchPath;
         url.setProtocol("filenamesearch");
         url.addQueryItem("search", m_searchInput->text());
         if (m_contentButton->isChecked()) {
             url.addQueryItem("checkContent", "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.
-            url.setPath(QDir::homePath());
+            encodedUrl = QDir::homePath();
+        } else {
+            encodedUrl = m_searchPath.url();
         }
+        url.addQueryItem("url", encodedUrl);
     }
 
     return url;
 }
 
+void DolphinSearchBox::selectAll()
+{
+    m_searchInput->selectAll();
+}
+
+void DolphinSearchBox::setReadOnly(bool readOnly, const KUrl& query)
+{
+    if (m_readOnly != readOnly) {
+        m_readOnly = readOnly;
+        m_readOnlyQuery = query;
+        applyReadOnlyState();
+    }
+}
+
+bool DolphinSearchBox::isReadOnly() const
+{
+    return m_readOnly;
+}
+
 bool DolphinSearchBox::event(QEvent* event)
 {
     if (event->type() == QEvent::Polish) {
         init();
-    } else if (event->type() == QEvent::KeyPress) {
-        if (static_cast<QKeyEvent* >(event)->key() == Qt::Key_Escape) {
-            m_searchInput->clear();
-        }
     }
     return QWidget::event(event);
 }
@@ -134,11 +182,6 @@ bool DolphinSearchBox::event(QEvent* event)
 void DolphinSearchBox::showEvent(QShowEvent* event)
 {
     if (!event->spontaneous()) {
-#ifdef HAVE_NEPOMUK
-        m_nepomukActivated = (Nepomuk::ResourceManager::instance()->init() == 0);
-#endif
-
-        m_searchInput->clear();
         m_searchInput->setFocus();
         m_startedSearching = false;
     }
@@ -147,7 +190,7 @@ void DolphinSearchBox::showEvent(QShowEvent* event)
 void DolphinSearchBox::keyReleaseEvent(QKeyEvent* event)
 {
     QWidget::keyReleaseEvent(event);
-    if ((event->key() == Qt::Key_Escape)) {
+    if (event->key() == Qt::Key_Escape) {
         if (m_searchInput->text().isEmpty()) {
             emit closeRequest();
         } else {
@@ -156,17 +199,25 @@ void DolphinSearchBox::keyReleaseEvent(QKeyEvent* event)
     }
 }
 
-void DolphinSearchBox::emitSearchSignal()
+void DolphinSearchBox::emitSearchRequest()
 {
     m_startSearchTimer->stop();
     m_startedSearching = true;
-    emit search(m_searchInput->text());
+    emit searchRequest();
+}
+
+void DolphinSearchBox::emitCloseRequest()
+{
+    m_startSearchTimer->stop();
+    m_startedSearching = false;
+    emit closeRequest();
 }
 
 void DolphinSearchBox::slotConfigurationChanged()
 {
+    saveSettings();
     if (m_startedSearching) {
-        emitSearchSignal();
+        emitSearchRequest();
     }
 }
 
@@ -182,44 +233,30 @@ void DolphinSearchBox::slotSearchTextChanged(const QString& text)
 
 void DolphinSearchBox::slotReturnPressed(const QString& text)
 {
-    emitSearchSignal();
+    emitSearchRequest();
     emit returnPressed(text);
 }
 
-void DolphinSearchBox::setFilterWidgetsVisible(bool visible)
+void DolphinSearchBox::slotFacetsButtonToggled()
 {
-#ifdef HAVE_NEPOMUK
-    if (visible) {
-        if (m_filterWidgetsLayout == 0) {
-            m_filterWidgetsLayout = new QFormLayout(this);
-            m_filterWidgetsLayout->setSpacing(0);
-
-            m_filterWidgets.append(new DateSearchFilterWidget(this));
-            m_filterWidgets.append(new RatingSearchFilterWidget(this));
-            m_filterWidgets.append(new TagSearchFilterWidget(this));
-
-            foreach (AbstractSearchFilterWidget* filterWidget, m_filterWidgets) {
-                const QString labelText = filterWidget->filterLabel() + QLatin1Char(':');
-                QLabel* label = new QLabel(labelText, this);
-                m_filterWidgetsLayout->addRow(label, filterWidget);
-                connect(filterWidget, SIGNAL(filterChanged()), this, SLOT(emitSearchSignal()));
-            }
-        }
-        m_topLayout->addLayout(m_filterWidgetsLayout);
-    } else {
-        m_topLayout->removeItem(m_filterWidgetsLayout);
-    }
-#else
-    Q_UNUSED(visible);
-#endif
+    const bool facetsIsVisible = !m_facetsWidget->isVisible();
+    m_facetsWidget->setVisible(facetsIsVisible);
+    updateFacetsToggleButton();
+}
+
+void DolphinSearchBox::slotFacetChanged()
+{
+    m_startedSearching = true;
+    m_startSearchTimer->stop();
+    emit searchRequest();
 }
 
-void DolphinSearchBox::initButton(QPushButton* button)
+void DolphinSearchBox::initButton(QToolButton* button)
 {
     button->setAutoExclusive(true);
-    button->setFlat(true);
+    button->setAutoRaise(true);
     button->setCheckable(true);
-    connect(button, SIGNAL(toggled(bool)), this, SLOT(slotConfigurationChanged()));
+    connect(button, SIGNAL(clicked(bool)), this, SLOT(slotConfigurationChanged()));
 }
 
 void DolphinSearchBox::loadSettings()
@@ -235,12 +272,15 @@ void DolphinSearchBox::loadSettings()
     } else {
         m_fileNameButton->setChecked(true);
     }
+
+    m_facetsWidget->setVisible(SearchSettings::showFacetsWidget());
 }
 
 void DolphinSearchBox::saveSettings()
 {
     SearchSettings::setLocation(m_fromHereButton->isChecked() ? "FromHere" : "Everywhere");
     SearchSettings::setWhat(m_fileNameButton->isChecked() ? "FileName" : "Content");
+    SearchSettings::setShowFacetsWidget(m_facetsToggleButton->isChecked());
     SearchSettings::self()->writeConfig();
 }
 
@@ -251,15 +291,16 @@ void DolphinSearchBox::init()
     closeButton->setAutoRaise(true);
     closeButton->setIcon(KIcon("dialog-close"));
     closeButton->setToolTip(i18nc("@info:tooltip", "Quit searching"));
-    connect(closeButton, SIGNAL(clicked()), SIGNAL(closeRequest()));
+    connect(closeButton, SIGNAL(clicked()), this, SLOT(emitCloseRequest()));
 
     // Create search label
-    QLabel* searchLabel = new QLabel(i18nc("@label:textbox", "Find:"), this);
+    m_searchLabel = new QLabel(this);
 
     // Create search box
     m_searchInput = new KLineEdit(this);
     m_searchInput->setClearButtonShown(true);
     m_searchInput->setFont(KGlobalSettings::generalFont());
+    setFocusProxy(m_searchInput);
     connect(m_searchInput, SIGNAL(returnPressed(QString)),
             this, SLOT(slotReturnPressed(QString)));
     connect(m_searchInput, SIGNAL(textChanged(QString)),
@@ -269,15 +310,30 @@ void DolphinSearchBox::init()
     QHBoxLayout* searchInputLayout = new QHBoxLayout();
     searchInputLayout->setMargin(0);
     searchInputLayout->addWidget(closeButton);
-    searchInputLayout->addWidget(searchLabel);
+    searchInputLayout->addWidget(m_searchLabel);
     searchInputLayout->addWidget(m_searchInput);
 
+    // Create "Filename" and "Content" button
+    m_fileNameButton = new QToolButton(this);
+    m_fileNameButton->setText(i18nc("action:button", "Filename"));
+    initButton(m_fileNameButton);
+
+    m_contentButton = new QToolButton();
+    m_contentButton->setText(i18nc("action:button", "Content"));
+    initButton(m_contentButton);
+
+    QButtonGroup* searchWhatGroup = new QButtonGroup(this);
+    searchWhatGroup->addButton(m_fileNameButton);
+    searchWhatGroup->addButton(m_contentButton);
+
+    m_separator = new KSeparator(Qt::Vertical, this);
+
     // Create "From Here" and "Everywhere"button
-    m_fromHereButton = new QPushButton();
+    m_fromHereButton = new QToolButton(this);
     m_fromHereButton->setText(i18nc("action:button", "From Here"));
     initButton(m_fromHereButton);
 
-    m_everywhereButton = new QPushButton(this);
+    m_everywhereButton = new QToolButton(this);
     m_everywhereButton->setText(i18nc("action:button", "Everywhere"));
     initButton(m_everywhereButton);
 
@@ -285,43 +341,47 @@ void DolphinSearchBox::init()
     searchLocationGroup->addButton(m_fromHereButton);
     searchLocationGroup->addButton(m_everywhereButton);
 
-    // Create "Filename" and "Content" button
-    m_fileNameButton = new QPushButton(this);
-    m_fileNameButton->setText(i18nc("action:button", "Filename"));
-    initButton(m_fileNameButton);
+    // Create "Facets" widgets
+    m_facetsToggleButton = new QToolButton(this);
+    m_facetsToggleButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
+    initButton(m_facetsToggleButton);
+    connect(m_facetsToggleButton, SIGNAL(clicked()), this, SLOT(slotFacetsButtonToggled()));
 
-    m_contentButton = new QPushButton();
-    m_contentButton->setText(i18nc("action:button", "Content"));
-    initButton(m_contentButton);;
-
-    QButtonGroup* searchWhatGroup = new QButtonGroup(this);
-    searchWhatGroup->addButton(m_fileNameButton);
-    searchWhatGroup->addButton(m_contentButton);
-
-    // Create "Filter" button
-    m_filterButton = new QToolButton(this);
-    m_filterButton->setIcon(KIcon("view-filter"));
-    m_filterButton->setAutoRaise(true);
-    m_filterButton->setCheckable(true);
-    m_filterButton->hide();
-    connect(m_filterButton, SIGNAL(toggled(bool)), this, SLOT(setFilterWidgetsVisible(bool)));
+    m_facetsWidget = new DolphinFacetsWidget(this);
+    m_facetsWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Maximum);
+    connect(m_facetsWidget, SIGNAL(facetChanged()), this, SLOT(slotFacetChanged()));
 
     // Apply layout for the options
     QHBoxLayout* optionsLayout = new QHBoxLayout();
     optionsLayout->setMargin(0);
-    optionsLayout->addWidget(m_fromHereButton);
-    optionsLayout->addWidget(m_everywhereButton);
-    optionsLayout->addWidget(new KSeparator(Qt::Vertical));
     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(m_filterButton);
+    optionsLayout->addWidget(m_facetsToggleButton);
+
+    // Put the options into a QScrollArea. This prevents increasing the view width
+    // in case that not enough width for the options is available.
+    QWidget* optionsContainer = new QWidget(this);
+    optionsContainer->setLayout(optionsLayout);
+
+    m_optionsScrollArea = new QScrollArea(this);
+    m_optionsScrollArea->setFrameShape(QFrame::NoFrame);
+    m_optionsScrollArea->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    m_optionsScrollArea->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
+    m_optionsScrollArea->setMaximumHeight(optionsContainer->sizeHint().height());
+    m_optionsScrollArea->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed);
+    m_optionsScrollArea->setWidget(optionsContainer);
+    m_optionsScrollArea->setWidgetResizable(true);
 
     m_topLayout = new QVBoxLayout(this);
+    m_topLayout->setMargin(0);
     m_topLayout->addLayout(searchInputLayout);
-    m_topLayout->addLayout(optionsLayout);
+    m_topLayout->addWidget(m_optionsScrollArea);
+    m_topLayout->addWidget(m_facetsWidget);
 
-    searchLabel->setBuddy(m_searchInput);
     loadSettings();
 
     // The searching should be started automatically after the user did not change
@@ -329,77 +389,91 @@ void DolphinSearchBox::init()
     m_startSearchTimer = new QTimer(this);
     m_startSearchTimer->setSingleShot(true);
     m_startSearchTimer->setInterval(1000);
-    connect(m_startSearchTimer, SIGNAL(timeout()), this, SLOT(emitSearchSignal()));
+    connect(m_startSearchTimer, SIGNAL(timeout()), this, SLOT(emitSearchRequest()));
+
+    updateFacetsToggleButton();
+    applyReadOnlyState();
 }
 
-bool DolphinSearchBox::isSearchPathIndexed() const
+KUrl DolphinSearchBox::nepomukUrlForSearching() const
 {
 #ifdef HAVE_NEPOMUK
-    const QString path = m_searchPath.path();
-
-    const KConfig strigiConfig("nepomukstrigirc");
-    const QStringList indexedFolders = strigiConfig.group("General").readPathEntry("folders", QStringList());
+    // Create the term for the text from the input-field
+    // dependent on whether a searching for content or
+    // filename is done
+    const QString text = m_searchInput->text();
+    Nepomuk2::Query::Term searchLabelTerm;
+    if (m_contentButton->isChecked()) {
+        // Let Nepomuk parse the query
+        searchLabelTerm = Nepomuk2::Query::QueryParser::parseQuery(text, Nepomuk2::Query::QueryParser::DetectFilenamePattern).term();
+    } else {
+        // Search the text in the filename only
+        QString regex = QRegExp::escape(text);
+        regex.replace("\\*", QLatin1String(".*"));
+        regex.replace("\\?", QLatin1String("."));
+        regex.replace("\\", "\\\\");
+        searchLabelTerm = Nepomuk2::Query::ComparisonTerm(
+                                Nepomuk2::Vocabulary::NFO::fileName(),
+                                Nepomuk2::Query::LiteralTerm(regex),
+                                Nepomuk2::Query::ComparisonTerm::Regexp);
+    }
 
-    // Check whether the current search path is part of an indexed folder
-    bool isIndexed = false;
-    foreach (const QString& indexedFolder, indexedFolders) {
-        if (path.startsWith(indexedFolder)) {
-            isIndexed = true;
-            break;
-        }
+    // Get the term from the facets and merge it with the
+    // created term from the input-field.
+    Nepomuk2::Query::Term facetsTerm = m_facetsWidget->facetsTerm();
+
+    Nepomuk2::Query::FileQuery fileQuery;
+    fileQuery.setFileMode(Nepomuk2::Query::FileQuery::QueryFilesAndFolders);
+    if (facetsTerm.isValid()) {
+        Nepomuk2::Query::AndTerm andTerm;
+        andTerm.addSubTerm(searchLabelTerm);
+        andTerm.addSubTerm(facetsTerm);
+        fileQuery.setTerm(andTerm);
+    } else {
+        fileQuery.setTerm(searchLabelTerm);
     }
 
-    if (isIndexed) {
-        // The current search path is part of an indexed folder. Check whether no
-        // excluded folder is part of the search path.
-        const QStringList excludedFolders = strigiConfig.group("General").readPathEntry("exclude folders", QStringList());
-        foreach (const QString& excludedFolder, excludedFolders) {
-            if (excludedFolder.startsWith(path)) {
-                isIndexed = false;
-                break;
-            }
-        }
+    if (m_fromHereButton->isChecked()) {
+        const bool recursive = true;
+        fileQuery.addIncludeFolder(m_searchPath, recursive);
     }
 
-    return isIndexed;
+    return fileQuery.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 false;
+    return KUrl();
 #endif
 }
 
-KUrl DolphinSearchBox::nepomukUrlForSearching() const
+void DolphinSearchBox::applyReadOnlyState()
 {
 #ifdef HAVE_NEPOMUK
-    Nepomuk::Query::AndTerm andTerm;
-
-    // Add filter terms
-    foreach (const AbstractSearchFilterWidget* filterWidget, m_filterWidgets) {
-        const Nepomuk::Query::Term term = filterWidget->queryTerm();
-        if (term.isValid()) {
-            andTerm.addSubTerm(term);
-        }
-    }
-
-    // Add input from search filter
-    const QString text = m_searchInput->text();
-    if (!text.isEmpty()) {
-        const Nepomuk::Query::Query customQuery = Nepomuk::Query::QueryParser::parseQuery(text);
-        if (customQuery.isValid()) {
-            andTerm.addSubTerm(customQuery.term());
-        }
+    if (m_readOnly) {
+        m_searchLabel->setText(Nepomuk2::Query::Query::titleFromQueryUrl(m_readOnlyQuery));
+    } else {
+#else
+    {
+#endif
+        m_searchLabel->setText(i18nc("@label:textbox", "Find:"));
     }
 
-    Nepomuk::Query::FileQuery fileQuery;
-    fileQuery.setFileMode(Nepomuk::Query::FileQuery::QueryFiles);
-    fileQuery.setTerm(andTerm);
+    m_searchInput->setVisible(!m_readOnly);
+    m_optionsScrollArea->setVisible(!m_readOnly);
 
-    if (fileQuery.isValid()) {
-        return fileQuery.toSearchUrl(i18nc("@title UDS_DISPLAY_NAME for a KIO directory listing. %1 is the query the user entered.",
-                                           "Query Results from '%1'",
-                                           text));
+    if (m_readOnly) {
+        m_facetsWidget->hide();
+    } else {
+        m_facetsWidget->setVisible(SearchSettings::showFacetsWidget());
     }
-#endif
-    return KUrl();
+}
+
+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->setText(facetsIsVisible ? i18nc("action:button", "Less Options") : i18nc("action:button", "More Options"));
 }
 
 #include "dolphinsearchbox.moc"