src/search/dolphinsearchbox.cpp

   1 /***************************************************************************
   2 *    Copyright (C) 2010 by Peter Penz <peter.penz19@gmail.com>            *
   3 *                                                                         *
   4 *    This program is free software; you can redistribute it and/or modify *
   5 *    it under the terms of the GNU General Public License as published by *
   6 *    the Free Software Foundation; either version 2 of the License, or    *
   7 *    (at your option) any later version.                                  *
   8 *                                                                         *
   9 *    This program is distributed in the hope that it will be useful,      *
  10 *    but WITHOUT ANY WARRANTY; without even the implied warranty of       *
  11 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        *
  12 *    GNU General Public License for more details.                         *
  13 *                                                                         *
  14 *    You should have received a copy of the GNU General Public License    *
  15 *    along with this program; if not, write to the                        *
  16 *    Free Software Foundation, Inc.,                                      *
  17 *    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA           *
  18 * **************************************************************************/
  19
  20 #include "dolphinsearchbox.h"
  21
  22 #include "dolphin_searchsettings.h"
  23 #include "dolphinfacetswidget.h"
  24
  25 #include <KIcon>
  26 #include <KLineEdit>
  27 #include <KLocale>
  28 #include <KSeparator>
  29 #include <KGlobalSettings>
  30
  31 #include <QButtonGroup>
  32 #include <QDir>
  33 #include <QEvent>
  34 #include <QFormLayout>
  35 #include <QHBoxLayout>
  36 #include <QKeyEvent>
  37 #include <QLabel>
  38 #include <QScrollArea>
  39 #include <QTimer>
  40 #include <QToolButton>
  41 #include <QVBoxLayout>
  42
  43 #include <config-baloo.h>
  44 #ifdef HAVE_BALOO
  45     #include <baloo/query.h>
  46     #include <baloo/term.h>
  47     #include <baloo/indexerconfig.h>
  48 #endif
  49
  50 DolphinSearchBox::DolphinSearchBox(QWidget* parent) :
  51     QWidget(parent),
  52     m_startedSearching(false),
  53     m_active(true),
  54     m_topLayout(0),
  55     m_searchLabel(0),
  56     m_searchInput(0),
  57     m_optionsScrollArea(0),
  58     m_fileNameButton(0),
  59     m_contentButton(0),
  60     m_separator(0),
  61     m_fromHereButton(0),
  62     m_everywhereButton(0),
  63     m_facetsToggleButton(0),
  64     m_facetsWidget(0),
  65     m_searchPath(),
  66     m_startSearchTimer(0)
  67 {
  68 }
  69
  70 DolphinSearchBox::~DolphinSearchBox()
  71 {
  72     saveSettings();
  73 }
  74
  75 void DolphinSearchBox::setText(const QString& text)
  76 {
  77     m_searchInput->setText(text);
  78 }
  79
  80 QString DolphinSearchBox::text() const
  81 {
  82     return m_searchInput->text();
  83 }
  84
  85 void DolphinSearchBox::setSearchPath(const KUrl& url)
  86 {
  87     m_searchPath = url;
  88
  89     QFontMetrics metrics(m_fromHereButton->font());
  90     const int maxWidth = metrics.height() * 8;
  91
  92     QString location = url.fileName();
  93     if (location.isEmpty()) {
  94         if (url.isLocalFile()) {
  95             location = QLatin1String("/");
  96         } else {
  97             location = url.protocol() + QLatin1String(" - ") + url.host();
  98         }
  99     }
 100
 101     const QString elidedLocation = metrics.elidedText(location, Qt::ElideMiddle, maxWidth);
 102     m_fromHereButton->setText(i18nc("action:button", "From Here (%1)", elidedLocation));
 103
 104     const bool showSearchFromButtons = url.isLocalFile();
 105     m_separator->setVisible(showSearchFromButtons);
 106     m_fromHereButton->setVisible(showSearchFromButtons);
 107     m_everywhereButton->setVisible(showSearchFromButtons);
 108
 109     bool hasFacetsSupport = false;
 110 #ifdef HAVE_BALOO
 111     const Baloo::IndexerConfig searchInfo;
 112     hasFacetsSupport = searchInfo.fileIndexingEnabled() && searchInfo.shouldBeIndexed(m_searchPath.toLocalFile());
 113 #endif
 114     m_facetsWidget->setEnabled(hasFacetsSupport);
 115 }
 116
 117 KUrl DolphinSearchBox::searchPath() const
 118 {
 119     return m_searchPath;
 120 }
 121
 122 KUrl DolphinSearchBox::urlForSearching() const
 123 {
 124     KUrl url;
 125     bool useBalooSearch = false;
 126 #ifdef HAVE_BALOO
 127     const Baloo::IndexerConfig searchInfo;
 128     useBalooSearch = searchInfo.fileIndexingEnabled() && searchInfo.shouldBeIndexed(m_searchPath.toLocalFile());
 129 #endif
 130     if (useBalooSearch) {
 131         url = balooUrlForSearching();
 132     } else {
 133         url.setProtocol("filenamesearch");
 134         url.addQueryItem("search", m_searchInput->text());
 135         if (m_contentButton->isChecked()) {
 136             url.addQueryItem("checkContent", "yes");
 137         }
 138
 139         QString encodedUrl;
 140         if (m_everywhereButton->isChecked()) {
 141             // It is very unlikely, that the majority of Dolphins target users
 142             // mean "the whole harddisk" instead of "my home folder" when
 143             // selecting the "Everywhere" button.
 144             encodedUrl = QDir::homePath();
 145         } else {
 146             encodedUrl = m_searchPath.url();
 147         }
 148         url.addQueryItem("url", encodedUrl);
 149     }
 150
 151     return url;
 152 }
 153
 154 void DolphinSearchBox::fromSearchUrl(const KUrl& url)
 155 {
 156     if (url.protocol() == "baloosearch") {
 157         fromBalooSearchUrl(url);
 158     } else if (url.protocol() == "filenamesearch") {
 159         const QMap<QString, QString>& queryItems = url.queryItems();
 160         setText(queryItems.value("search"));
 161         setSearchPath(queryItems.value("url"));
 162         m_contentButton->setChecked(queryItems.value("checkContent") == "yes");
 163     } else {
 164         setText(QString());
 165         setSearchPath(url);
 166     }
 167 }
 168
 169 void DolphinSearchBox::selectAll()
 170 {
 171     m_searchInput->selectAll();
 172 }
 173
 174 void DolphinSearchBox::setActive(bool active)
 175 {
 176     if (active != m_active) {
 177         m_active = active;
 178
 179         if (active) {
 180             emit activated();
 181         }
 182     }
 183 }
 184
 185 bool DolphinSearchBox::isActive() const
 186 {
 187     return m_active;
 188 }
 189
 190 bool DolphinSearchBox::event(QEvent* event)
 191 {
 192     if (event->type() == QEvent::Polish) {
 193         init();
 194     }
 195     return QWidget::event(event);
 196 }
 197
 198 void DolphinSearchBox::showEvent(QShowEvent* event)
 199 {
 200     if (!event->spontaneous()) {
 201         m_searchInput->setFocus();
 202         m_startedSearching = false;
 203     }
 204 }
 205
 206 void DolphinSearchBox::keyReleaseEvent(QKeyEvent* event)
 207 {
 208     QWidget::keyReleaseEvent(event);
 209     if (event->key() == Qt::Key_Escape) {
 210         if (m_searchInput->text().isEmpty()) {
 211             emit closeRequest();
 212         } else {
 213             m_searchInput->clear();
 214         }
 215     }
 216 }
 217
 218 bool DolphinSearchBox::eventFilter(QObject* obj, QEvent* event)
 219 {
 220     switch (event->type()) {
 221     case QEvent::FocusIn:
 222         setActive(true);
 223         setFocus();
 224         break;
 225
 226     default:
 227         break;
 228     }
 229
 230     return QObject::eventFilter(obj, event);
 231 }
 232
 233 void DolphinSearchBox::emitSearchRequest()
 234 {
 235     m_startSearchTimer->stop();
 236     m_startedSearching = true;
 237     emit searchRequest();
 238 }
 239
 240 void DolphinSearchBox::emitCloseRequest()
 241 {
 242     m_startSearchTimer->stop();
 243     m_startedSearching = false;
 244     emit closeRequest();
 245 }
 246
 247 void DolphinSearchBox::slotConfigurationChanged()
 248 {
 249     saveSettings();
 250     if (m_startedSearching) {
 251         emitSearchRequest();
 252     }
 253 }
 254
 255 void DolphinSearchBox::slotSearchTextChanged(const QString& text)
 256 {
 257     if (text.isEmpty()) {
 258         m_startSearchTimer->stop();
 259     } else {
 260         m_startSearchTimer->start();
 261     }
 262     emit searchTextChanged(text);
 263 }
 264
 265 void DolphinSearchBox::slotReturnPressed(const QString& text)
 266 {
 267     emitSearchRequest();
 268     emit returnPressed(text);
 269 }
 270
 271 void DolphinSearchBox::slotFacetsButtonToggled()
 272 {
 273     const bool facetsIsVisible = !m_facetsWidget->isVisible();
 274     m_facetsWidget->setVisible(facetsIsVisible);
 275     updateFacetsToggleButton();
 276 }
 277
 278 void DolphinSearchBox::slotFacetChanged()
 279 {
 280     m_startedSearching = true;
 281     m_startSearchTimer->stop();
 282     emit searchRequest();
 283 }
 284
 285 void DolphinSearchBox::initButton(QToolButton* button)
 286 {
 287     button->installEventFilter(this);
 288     button->setAutoExclusive(true);
 289     button->setAutoRaise(true);
 290     button->setCheckable(true);
 291     connect(button, &QToolButton::clicked, this, &DolphinSearchBox::slotConfigurationChanged);
 292 }
 293
 294 void DolphinSearchBox::loadSettings()
 295 {
 296     if (SearchSettings::location() == QLatin1String("Everywhere")) {
 297         m_everywhereButton->setChecked(true);
 298     } else {
 299         m_fromHereButton->setChecked(true);
 300     }
 301
 302     if (SearchSettings::what() == QLatin1String("Content")) {
 303         m_contentButton->setChecked(true);
 304     } else {
 305         m_fileNameButton->setChecked(true);
 306     }
 307
 308     m_facetsWidget->setVisible(SearchSettings::showFacetsWidget());
 309 }
 310
 311 void DolphinSearchBox::saveSettings()
 312 {
 313     SearchSettings::setLocation(m_fromHereButton->isChecked() ? "FromHere" : "Everywhere");
 314     SearchSettings::setWhat(m_fileNameButton->isChecked() ? "FileName" : "Content");
 315     SearchSettings::setShowFacetsWidget(m_facetsToggleButton->isChecked());
 316     SearchSettings::self()->writeConfig();
 317 }
 318
 319 void DolphinSearchBox::init()
 320 {
 321     // Create close button
 322     QToolButton* closeButton = new QToolButton(this);
 323     closeButton->setAutoRaise(true);
 324     closeButton->setIcon(KIcon("dialog-close"));
 325     closeButton->setToolTip(i18nc("@info:tooltip", "Quit searching"));
 326     connect(closeButton, &QToolButton::clicked, this, &DolphinSearchBox::emitCloseRequest);
 327
 328     // Create search label
 329     m_searchLabel = new QLabel(this);
 330
 331     // Create search box
 332     m_searchInput = new KLineEdit(this);
 333     m_searchInput->installEventFilter(this);
 334     m_searchInput->setClearButtonShown(true);
 335     m_searchInput->setFont(KGlobalSettings::generalFont());
 336     setFocusProxy(m_searchInput);
 337     connect(m_searchInput, static_cast<void(KLineEdit::*)(const QString&)>(&KLineEdit::returnPressed),
 338             this, &DolphinSearchBox::slotReturnPressed);
 339     connect(m_searchInput, &KLineEdit::textChanged,
 340             this, &DolphinSearchBox::slotSearchTextChanged);
 341
 342     // Apply layout for the search input
 343     QHBoxLayout* searchInputLayout = new QHBoxLayout();
 344     searchInputLayout->setMargin(0);
 345     searchInputLayout->addWidget(closeButton);
 346     searchInputLayout->addWidget(m_searchLabel);
 347     searchInputLayout->addWidget(m_searchInput);
 348
 349     // Create "Filename" and "Content" button
 350     m_fileNameButton = new QToolButton(this);
 351     m_fileNameButton->setText(i18nc("action:button", "Filename"));
 352     initButton(m_fileNameButton);
 353
 354     m_contentButton = new QToolButton();
 355     m_contentButton->setText(i18nc("action:button", "Content"));
 356     initButton(m_contentButton);
 357
 358     QButtonGroup* searchWhatGroup = new QButtonGroup(this);
 359     searchWhatGroup->addButton(m_fileNameButton);
 360     searchWhatGroup->addButton(m_contentButton);
 361
 362     m_separator = new KSeparator(Qt::Vertical, this);
 363
 364     // Create "From Here" and "Everywhere"button
 365     m_fromHereButton = new QToolButton(this);
 366     m_fromHereButton->setText(i18nc("action:button", "From Here"));
 367     initButton(m_fromHereButton);
 368
 369     m_everywhereButton = new QToolButton(this);
 370     m_everywhereButton->setText(i18nc("action:button", "Everywhere"));
 371     initButton(m_everywhereButton);
 372
 373     QButtonGroup* searchLocationGroup = new QButtonGroup(this);
 374     searchLocationGroup->addButton(m_fromHereButton);
 375     searchLocationGroup->addButton(m_everywhereButton);
 376
 377     // Create "Facets" widgets
 378     m_facetsToggleButton = new QToolButton(this);
 379     m_facetsToggleButton->setToolButtonStyle(Qt::ToolButtonTextBesideIcon);
 380     initButton(m_facetsToggleButton);
 381     connect(m_facetsToggleButton, &QToolButton::clicked, this, &DolphinSearchBox::slotFacetsButtonToggled);
 382
 383     m_facetsWidget = new DolphinFacetsWidget(this);
 384     m_facetsWidget->installEventFilter(this);
 385     m_facetsWidget->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Maximum);
 386     connect(m_facetsWidget, &DolphinFacetsWidget::facetChanged, this, &DolphinSearchBox::slotFacetChanged);
 387
 388     // Apply layout for the options
 389     QHBoxLayout* optionsLayout = new QHBoxLayout();
 390     optionsLayout->setMargin(0);
 391     optionsLayout->addWidget(m_fileNameButton);
 392     optionsLayout->addWidget(m_contentButton);
 393     optionsLayout->addWidget(m_separator);
 394     optionsLayout->addWidget(m_fromHereButton);
 395     optionsLayout->addWidget(m_everywhereButton);
 396     optionsLayout->addStretch(1);
 397     optionsLayout->addWidget(m_facetsToggleButton);
 398
 399     // Put the options into a QScrollArea. This prevents increasing the view width
 400     // in case that not enough width for the options is available.
 401     QWidget* optionsContainer = new QWidget(this);
 402     optionsContainer->setLayout(optionsLayout);
 403
 404     m_optionsScrollArea = new QScrollArea(this);
 405     m_optionsScrollArea->setFrameShape(QFrame::NoFrame);
 406     m_optionsScrollArea->setHorizontalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 407     m_optionsScrollArea->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOff);
 408     m_optionsScrollArea->setMaximumHeight(optionsContainer->sizeHint().height());
 409     m_optionsScrollArea->setSizePolicy(QSizePolicy::Preferred, QSizePolicy::Fixed);
 410     m_optionsScrollArea->setWidget(optionsContainer);
 411     m_optionsScrollArea->setWidgetResizable(true);
 412
 413     m_topLayout = new QVBoxLayout(this);
 414     m_topLayout->setMargin(0);
 415     m_topLayout->addLayout(searchInputLayout);
 416     m_topLayout->addWidget(m_optionsScrollArea);
 417     m_topLayout->addWidget(m_facetsWidget);
 418
 419     loadSettings();
 420
 421     // The searching should be started automatically after the user did not change
 422     // the text within one second
 423     m_startSearchTimer = new QTimer(this);
 424     m_startSearchTimer->setSingleShot(true);
 425     m_startSearchTimer->setInterval(1000);
 426     connect(m_startSearchTimer, &QTimer::timeout, this, &DolphinSearchBox::emitSearchRequest);
 427
 428     updateFacetsToggleButton();
 429 }
 430
 431 KUrl DolphinSearchBox::balooUrlForSearching() const
 432 {
 433 #ifdef HAVE_BALOO
 434     const QString text = m_searchInput->text();
 435
 436     Baloo::Query query;
 437     query.addType("File");
 438     query.addType(m_facetsWidget->facetType());
 439
 440     Baloo::Term term(Baloo::Term::And);
 441
 442     Baloo::Term ratingTerm = m_facetsWidget->ratingTerm();
 443     if (ratingTerm.isValid()) {
 444         term.addSubTerm(ratingTerm);
 445     }
 446
 447     if (m_contentButton->isChecked()) {
 448         query.setSearchString(text);
 449     } else if (!text.isEmpty()) {
 450         term.addSubTerm(Baloo::Term(QLatin1String("filename"), text));
 451     }
 452
 453     if (m_fromHereButton->isChecked()) {
 454         query.addCustomOption("includeFolder", m_searchPath.toLocalFile());
 455     }
 456
 457     query.setTerm(term);
 458
 459     return query.toSearchUrl(i18nc("@title UDS_DISPLAY_NAME for a KIO directory listing. %1 is the query the user entered.",
 460                                    "Query Results from '%1'", text));
 461 #else
 462     return KUrl();
 463 #endif
 464 }
 465
 466 void DolphinSearchBox::fromBalooSearchUrl(const KUrl& url)
 467 {
 468 #ifdef HAVE_BALOO
 469     const Baloo::Query query = Baloo::Query::fromSearchUrl(url);
 470     const Baloo::Term term = query.term();
 471
 472     // Block all signals to avoid unnecessary "searchRequest" signals
 473     // while we adjust the search text and the facet widget.
 474     blockSignals(true);
 475
 476     const QVariantHash customOptions = query.customOptions();
 477     if (customOptions.contains("includeFolder")) {
 478         setSearchPath(customOptions.value("includeFolder").toString());
 479     } else {
 480         setSearchPath(QDir::homePath());
 481     }
 482
 483     if (!query.searchString().isEmpty()) {
 484         setText(query.searchString());
 485     }
 486
 487     QStringList types = query.types();
 488     types.removeOne("File"); // We are only interested in facet widget types
 489     if (!types.isEmpty()) {
 490         m_facetsWidget->setFacetType(types.first());
 491     }
 492
 493     foreach (const Baloo::Term& subTerm, term.subTerms()) {
 494         const QString property = subTerm.property();
 495
 496         if (property == QLatin1String("filename")) {
 497             setText(subTerm.value().toString());
 498         } else if (m_facetsWidget->isRatingTerm(subTerm)) {
 499             m_facetsWidget->setRatingTerm(subTerm);
 500         }
 501     }
 502
 503     m_startSearchTimer->stop();
 504     blockSignals(false);
 505 #endif
 506 }
 507
 508 void DolphinSearchBox::updateFacetsToggleButton()
 509 {
 510     const bool facetsIsVisible = SearchSettings::showFacetsWidget();
 511     m_facetsToggleButton->setChecked(facetsIsVisible ? true : false);
 512     m_facetsToggleButton->setIcon(KIcon(facetsIsVisible ? "arrow-up-double" : "arrow-down-double"));
 513     m_facetsToggleButton->setText(facetsIsVisible ? i18nc("action:button", "Fewer Options") : i18nc("action:button", "More Options"));
 514 }
 515
 516 #include "dolphinsearchbox.moc"