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
  24 #include <kicon.h>
  25 #include <klineedit.h>
  26 #include <klocale.h>
  27 #include <kseparator.h>
  28
  29 #include <QButtonGroup>
  30 #include <QDir>
  31 #include <QEvent>
  32 #include <QFormLayout>
  33 #include <QHBoxLayout>
  34 #include <QKeyEvent>
  35 #include <QLabel>
  36 #include <QPushButton>
  37 #include <QTimer>
  38 #include <QToolButton>
  39 #include <QVBoxLayout>
  40
  41 #include <config-nepomuk.h>
  42 #ifdef HAVE_NEPOMUK
  43     #include <nepomuk/andterm.h>
  44     #include <nepomuk/filequery.h>
  45     #include <nepomuk/literalterm.h>
  46     #include <nepomuk/query.h>
  47     #include <nepomuk/queryparser.h>
  48     #include <nepomuk/resourcemanager.h>
  49     #include <nepomuk/resourcetypeterm.h>
  50     #include <nepomuk/comparisonterm.h>
  51     #include <nepomuk/nfo.h>
  52 #endif
  53
  54 DolphinSearchBox::DolphinSearchBox(QWidget* parent) :
  55     QWidget(parent),
  56     m_startedSearching(false),
  57     m_nepomukActivated(false),
  58     m_topLayout(0),
  59     m_searchInput(0),
  60     m_fromHereButton(0),
  61     m_everywhereButton(0),
  62     m_fileNameButton(0),
  63     m_contentButton(0),
  64     m_filterButton(0),
  65     m_searchPath(),
  66     m_startSearchTimer(0)
  67 {
  68 }
  69
  70 DolphinSearchBox::~DolphinSearchBox()
  71 {
  72     saveSettings();
  73 }
  74
  75 QString DolphinSearchBox::text() const
  76 {
  77     return m_searchInput->text();
  78 }
  79
  80 void DolphinSearchBox::setSearchPath(const KUrl& url)
  81 {
  82     m_searchPath = url;
  83     m_filterButton->setVisible(m_nepomukActivated && isSearchPathIndexed());
  84 }
  85
  86 KUrl DolphinSearchBox::searchPath() const
  87 {
  88     return m_searchPath;
  89 }
  90
  91 KUrl DolphinSearchBox::urlForSearching() const
  92 {
  93     KUrl url;
  94     if (m_nepomukActivated && isSearchPathIndexed()) {
  95         url = nepomukUrlForSearching();
  96     } else {
  97         url = m_searchPath;
  98         url.setProtocol("filenamesearch");
  99         url.addQueryItem("search", m_searchInput->text());
 100         if (m_contentButton->isChecked()) {
 101             url.addQueryItem("checkContent", "yes");
 102         }
 103         if (m_everywhereButton->isChecked()) {
 104             // It is very unlikely, that the majority of Dolphins target users
 105             // mean "the whole harddisk" instead of "my home folder" when
 106             // selecting the "Everywhere" button.
 107             url.setPath(QDir::homePath());
 108         }
 109     }
 110
 111     return url;
 112 }
 113
 114 bool DolphinSearchBox::event(QEvent* event)
 115 {
 116     if (event->type() == QEvent::Polish) {
 117         init();
 118     }
 119     return QWidget::event(event);
 120 }
 121
 122 void DolphinSearchBox::showEvent(QShowEvent* event)
 123 {
 124     if (!event->spontaneous()) {
 125 #ifdef HAVE_NEPOMUK
 126         m_nepomukActivated = (Nepomuk::ResourceManager::instance()->init() == 0);
 127 #endif
 128
 129         m_searchInput->clear();
 130         m_searchInput->setFocus();
 131         m_startedSearching = false;
 132     }
 133 }
 134
 135 void DolphinSearchBox::keyReleaseEvent(QKeyEvent* event)
 136 {
 137     QWidget::keyReleaseEvent(event);
 138     if ((event->key() == Qt::Key_Escape)) {
 139         if (m_searchInput->text().isEmpty()) {
 140             emit closeRequest();
 141         } else {
 142             m_searchInput->clear();
 143         }
 144     }
 145 }
 146
 147 void DolphinSearchBox::emitSearchSignal()
 148 {
 149     m_startSearchTimer->stop();
 150     m_startedSearching = true;
 151     emit search(m_searchInput->text());
 152 }
 153
 154 void DolphinSearchBox::slotConfigurationChanged()
 155 {
 156     if (m_startedSearching) {
 157         emitSearchSignal();
 158     }
 159 }
 160
 161 void DolphinSearchBox::slotSearchTextChanged(const QString& text)
 162 {
 163     if (text.isEmpty()) {
 164         m_startSearchTimer->stop();
 165     } else {
 166         m_startSearchTimer->start();
 167     }
 168     emit searchTextChanged(text);
 169 }
 170
 171 void DolphinSearchBox::slotReturnPressed(const QString& text)
 172 {
 173     emitSearchSignal();
 174     emit returnPressed(text);
 175 }
 176
 177 void DolphinSearchBox::initButton(QPushButton* button)
 178 {
 179     button->setAutoExclusive(true);
 180     button->setFlat(true);
 181     button->setCheckable(true);
 182     connect(button, SIGNAL(toggled(bool)), this, SLOT(slotConfigurationChanged()));
 183 }
 184
 185 void DolphinSearchBox::loadSettings()
 186 {
 187     if (SearchSettings::location() == QLatin1String("Everywhere")) {
 188         m_everywhereButton->setChecked(true);
 189     } else {
 190         m_fromHereButton->setChecked(true);
 191     }
 192
 193     if (SearchSettings::what() == QLatin1String("Content")) {
 194         m_contentButton->setChecked(true);
 195     } else {
 196         m_fileNameButton->setChecked(true);
 197     }
 198 }
 199
 200 void DolphinSearchBox::saveSettings()
 201 {
 202     SearchSettings::setLocation(m_fromHereButton->isChecked() ? "FromHere" : "Everywhere");
 203     SearchSettings::setWhat(m_fileNameButton->isChecked() ? "FileName" : "Content");
 204     SearchSettings::self()->writeConfig();
 205 }
 206
 207 void DolphinSearchBox::init()
 208 {
 209     // Create close button
 210     QToolButton* closeButton = new QToolButton(this);
 211     closeButton->setAutoRaise(true);
 212     closeButton->setIcon(KIcon("dialog-close"));
 213     closeButton->setToolTip(i18nc("@info:tooltip", "Quit searching"));
 214     connect(closeButton, SIGNAL(clicked()), SIGNAL(closeRequest()));
 215
 216     // Create search label
 217     QLabel* searchLabel = new QLabel(i18nc("@label:textbox", "Find:"), this);
 218
 219     // Create search box
 220     m_searchInput = new KLineEdit(this);
 221     m_searchInput->setClearButtonShown(true);
 222     m_searchInput->setFont(KGlobalSettings::generalFont());
 223     connect(m_searchInput, SIGNAL(returnPressed(QString)),
 224             this, SLOT(slotReturnPressed(QString)));
 225     connect(m_searchInput, SIGNAL(textChanged(QString)),
 226             this, SLOT(slotSearchTextChanged(QString)));
 227
 228     // Apply layout for the search input
 229     QHBoxLayout* searchInputLayout = new QHBoxLayout();
 230     searchInputLayout->setMargin(0);
 231     searchInputLayout->addWidget(closeButton);
 232     searchInputLayout->addWidget(searchLabel);
 233     searchInputLayout->addWidget(m_searchInput);
 234
 235     // Create "From Here" and "Everywhere"button
 236     m_fromHereButton = new QPushButton();
 237     m_fromHereButton->setText(i18nc("action:button", "From Here"));
 238     initButton(m_fromHereButton);
 239
 240     m_everywhereButton = new QPushButton(this);
 241     m_everywhereButton->setText(i18nc("action:button", "Everywhere"));
 242     initButton(m_everywhereButton);
 243
 244     QButtonGroup* searchLocationGroup = new QButtonGroup(this);
 245     searchLocationGroup->addButton(m_fromHereButton);
 246     searchLocationGroup->addButton(m_everywhereButton);
 247
 248     // Create "Filename" and "Content" button
 249     m_fileNameButton = new QPushButton(this);
 250     m_fileNameButton->setText(i18nc("action:button", "Filename"));
 251     initButton(m_fileNameButton);
 252
 253     m_contentButton = new QPushButton();
 254     m_contentButton->setText(i18nc("action:button", "Content"));
 255     initButton(m_contentButton);;
 256
 257     QButtonGroup* searchWhatGroup = new QButtonGroup(this);
 258     searchWhatGroup->addButton(m_fileNameButton);
 259     searchWhatGroup->addButton(m_contentButton);
 260
 261     // Create "Filter" button
 262     m_filterButton = new QToolButton(this);
 263     m_filterButton->setIcon(KIcon("view-filter"));
 264     m_filterButton->setAutoRaise(true);
 265     m_filterButton->setCheckable(true);
 266     m_filterButton->hide();
 267     //connect(m_filterButton, SIGNAL(toggled(bool)), this, SLOT(setFilterWidgetsVisible(bool)));
 268
 269     // Apply layout for the options
 270     QHBoxLayout* optionsLayout = new QHBoxLayout();
 271     optionsLayout->setMargin(0);
 272     optionsLayout->addWidget(m_fromHereButton);
 273     optionsLayout->addWidget(m_everywhereButton);
 274     optionsLayout->addWidget(new KSeparator(Qt::Vertical));
 275     optionsLayout->addWidget(m_fileNameButton);
 276     optionsLayout->addWidget(m_contentButton);
 277     optionsLayout->addStretch(1);
 278     optionsLayout->addWidget(m_filterButton);
 279
 280     m_topLayout = new QVBoxLayout(this);
 281     m_topLayout->addLayout(searchInputLayout);
 282     m_topLayout->addLayout(optionsLayout);
 283
 284     searchLabel->setBuddy(m_searchInput);
 285     loadSettings();
 286
 287     // The searching should be started automatically after the user did not change
 288     // the text within one second
 289     m_startSearchTimer = new QTimer(this);
 290     m_startSearchTimer->setSingleShot(true);
 291     m_startSearchTimer->setInterval(1000);
 292     connect(m_startSearchTimer, SIGNAL(timeout()), this, SLOT(emitSearchSignal()));
 293 }
 294
 295 bool DolphinSearchBox::isSearchPathIndexed() const
 296 {
 297 #ifdef HAVE_NEPOMUK
 298     const QString path = m_searchPath.path();
 299
 300     const KConfig strigiConfig("nepomukstrigirc");
 301     const QStringList indexedFolders = strigiConfig.group("General").readPathEntry("folders", QStringList());
 302
 303     // Check whether the current search path is part of an indexed folder
 304     bool isIndexed = false;
 305     foreach (const QString& indexedFolder, indexedFolders) {
 306         if (path.startsWith(indexedFolder)) {
 307             isIndexed = true;
 308             break;
 309         }
 310     }
 311
 312     if (isIndexed) {
 313         // The current search path is part of an indexed folder. Check whether no
 314         // excluded folder is part of the search path.
 315         const QStringList excludedFolders = strigiConfig.group("General").readPathEntry("exclude folders", QStringList());
 316         foreach (const QString& excludedFolder, excludedFolders) {
 317             if (path.startsWith(excludedFolder)) {
 318                 isIndexed = false;
 319                 break;
 320             }
 321         }
 322     }
 323
 324     return isIndexed;
 325 #else
 326     return false;
 327 #endif
 328 }
 329
 330 KUrl DolphinSearchBox::nepomukUrlForSearching() const
 331 {
 332 #ifdef HAVE_NEPOMUK
 333     Nepomuk::Query::AndTerm andTerm;
 334
 335     // Add input from search filter
 336     const QString text = m_searchInput->text();
 337     if (!text.isEmpty()) {
 338         if (m_fileNameButton->isChecked()) {
 339             QString regex = QRegExp::escape(text);
 340             regex.replace("\\*", QLatin1String(".*"));
 341             regex.replace("\\?", QLatin1String("."));
 342             regex.replace("\\", "\\\\");
 343             andTerm.addSubTerm(Nepomuk::Query::ComparisonTerm(
 344                                     Nepomuk::Vocabulary::NFO::fileName(),
 345                                     Nepomuk::Query::LiteralTerm(regex),
 346                                     Nepomuk::Query::ComparisonTerm::Regexp));
 347         } else {
 348             const Nepomuk::Query::Query customQuery = Nepomuk::Query::QueryParser::parseQuery(text, Nepomuk::Query::QueryParser::DetectFilenamePattern);
 349             if (customQuery.isValid()) {
 350                 andTerm.addSubTerm(customQuery.term());
 351             }
 352         }
 353     }
 354
 355     Nepomuk::Query::FileQuery fileQuery;
 356     fileQuery.setFileMode(Nepomuk::Query::FileQuery::QueryFiles);
 357     fileQuery.setTerm(andTerm);
 358
 359     return fileQuery.toSearchUrl(i18nc("@title UDS_DISPLAY_NAME for a KIO directory listing. %1 is the query the user entered.",
 360                                        "Query Results from '%1'",
 361                                        text));
 362 #else
 363     return KUrl();
 364 #endif
 365 }
 366
 367 #include "dolphinsearchbox.moc"