src/panels/search/searchpanel.cpp

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Sebastian Trueg <trueg@kde.org>                 *
   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 "searchpanel.h"
  21
  22 #include "dolphin_searchsettings.h"
  23
  24 #include <Nepomuk/ResourceManager>
  25 #include <Nepomuk/Utils/FacetWidget>
  26 #include <Nepomuk/Utils/Facet>
  27 #include <Nepomuk/Utils/SimpleFacet>
  28 #include <Nepomuk/Utils/ProxyFacet>
  29 #include <Nepomuk/Utils/DynamicResourceFacet>
  30 #include <Nepomuk/Query/FileQuery>
  31 #include <Nepomuk/Query/ResourceTypeTerm>
  32 #include <Nepomuk/Query/LiteralTerm>
  33 #include <Nepomuk/Query/ComparisonTerm>
  34 #include <Nepomuk/Vocabulary/NFO>
  35 #include <Nepomuk/Vocabulary/NMM>
  36 #include <Nepomuk/Vocabulary/NIE>
  37
  38 #include <search/dolphinsearchinformation.h>
  39
  40 #include <KFileItem>
  41 #include <KIO/Job>
  42 #include <KIO/JobClasses>
  43 #include <KIO/JobUiDelegate>
  44 #include <KMenu>
  45
  46 #include <QPushButton>
  47 #include <QShowEvent>
  48 #include <QTreeView>
  49 #include <QVBoxLayout>
  50
  51 SearchPanel::SearchPanel(QWidget* parent) :
  52     Panel(parent),
  53     m_initialized(false),
  54     m_searchLocation(Everywhere),
  55     m_lastSetUrlStatJob(0),
  56     m_startedFromDir(),
  57     m_facetWidget(0),
  58     m_unfacetedRestQuery()
  59 {
  60     setEnabled(false);
  61 }
  62
  63 SearchPanel::~SearchPanel()
  64 {
  65 }
  66
  67 void SearchPanel::setSearchLocation(SearchLocation location)
  68 {
  69     m_searchLocation = location;
  70     if (isVisible()) {
  71         setEnabled(isFilteringPossible());
  72     }
  73 }
  74
  75 SearchPanel::SearchLocation SearchPanel::searchLocation() const
  76 {
  77     return m_searchLocation;
  78 }
  79
  80 bool SearchPanel::urlChanged()
  81 {
  82     const bool isNepomukUrl = url().protocol().startsWith(QLatin1String("nepomuk"));
  83     if (!isNepomukUrl) {
  84         // Remember the current directory before a searching is started.
  85         // This is required to restore the directory in case that all facets
  86         // have been reset by the user (see slotQueryTermChanged()).
  87         m_startedFromDir = url();
  88     }
  89
  90     if (isVisible() && DolphinSearchInformation::instance().isIndexingEnabled()) {
  91         const Nepomuk::Query::FileQuery query(m_unfacetedRestQuery && m_facetWidget->queryTerm());
  92         if (query.toSearchUrl() == url()) {
  93             // The new URL has been triggered by the SearchPanel itself in
  94             // slotQueryTermChanged() and no further handling is required.
  95             return true;
  96         }
  97
  98         delete m_lastSetUrlStatJob;
  99         m_lastSetUrlStatJob = 0;
 100
 101         if (isNepomukUrl) {
 102             // Reset the current query and disable the facet-widget until
 103             // the new query has been determined by KIO::stat():
 104             m_lastSetUrlStatJob = KIO::stat(url(), KIO::HideProgressInfo);
 105             if (m_lastSetUrlStatJob->ui()) {
 106                 m_lastSetUrlStatJob->ui()->setWindow(this);
 107             }
 108             connect(m_lastSetUrlStatJob, SIGNAL(result(KJob*)),
 109                     this, SLOT(slotSetUrlStatFinished(KJob*)));
 110         } else {
 111             // Reset the search panel because a "normal" directory is shown.
 112             setQuery(Nepomuk::Query::Query());
 113         }
 114
 115         setEnabled(isFilteringPossible());
 116     }
 117
 118     return true;
 119 }
 120
 121 void SearchPanel::showEvent(QShowEvent* event)
 122 {
 123     if (event->spontaneous()) {
 124         Panel::showEvent(event);
 125         return;
 126     }
 127
 128     if (!m_initialized) {
 129         QVBoxLayout* layout = new QVBoxLayout(this);
 130         layout->setMargin(0);
 131
 132         Q_ASSERT(!m_facetWidget);
 133         m_facetWidget = new Nepomuk::Utils::FacetWidget(this);
 134         layout->addWidget(m_facetWidget, 1);
 135
 136         // File Type
 137         m_facetWidget->addFacet(Nepomuk::Utils::Facet::createFileTypeFacet());
 138
 139         // Image Size
 140         Nepomuk::Utils::ProxyFacet* imageSizeProxy = new Nepomuk::Utils::ProxyFacet();
 141         imageSizeProxy->setFacetCondition(Nepomuk::Query::ResourceTypeTerm(Nepomuk::Vocabulary::NFO::Image()));
 142         Nepomuk::Utils::SimpleFacet* imageSizeFacet = new Nepomuk::Utils::SimpleFacet(imageSizeProxy);
 143         imageSizeFacet->setSelectionMode(Nepomuk::Utils::Facet::MatchAny);
 144         imageSizeFacet->addTerm( i18nc("option:check Refers to a filter on image size", "Small"),
 145                                 Nepomuk::Vocabulary::NFO::width() <= Nepomuk::Query::LiteralTerm(300));
 146         imageSizeFacet->addTerm( i18nc("option:check Refers to a filter on image size", "Medium"),
 147                                 (Nepomuk::Vocabulary::NFO::width() > Nepomuk::Query::LiteralTerm(300)) &&
 148                                 (Nepomuk::Vocabulary::NFO::width() <= Nepomuk::Query::LiteralTerm(800)));
 149         imageSizeFacet->addTerm( i18nc("option:check Refers to a filter on image size", "Large"),
 150                                 Nepomuk::Vocabulary::NFO::width() > Nepomuk::Query::LiteralTerm(800));
 151         imageSizeProxy->setSourceFacet(imageSizeFacet);
 152         m_facetWidget->addFacet(imageSizeProxy);
 153
 154         // Artists
 155         Nepomuk::Utils::ProxyFacet* artistProxy = new Nepomuk::Utils::ProxyFacet();
 156         artistProxy->setFacetCondition(Nepomuk::Query::ResourceTypeTerm(Nepomuk::Vocabulary::NFO::Audio()) ||
 157                                        Nepomuk::Query::ComparisonTerm(Nepomuk::Vocabulary::NIE::mimeType(),
 158                                                                       Nepomuk::Query::LiteralTerm(QLatin1String("audio"))));
 159         Nepomuk::Utils::DynamicResourceFacet* artistFacet = new Nepomuk::Utils::DynamicResourceFacet(artistProxy);
 160         artistFacet->setSelectionMode(Nepomuk::Utils::Facet::MatchAny);
 161         artistFacet->setRelation(Nepomuk::Vocabulary::NMM::performer());
 162         artistProxy->setSourceFacet(artistFacet);
 163         m_facetWidget->addFacet(artistProxy);
 164
 165         // Misc
 166         m_facetWidget->addFacet(Nepomuk::Utils::Facet::createDateFacet());
 167         m_facetWidget->addFacet(Nepomuk::Utils::Facet::createRatingFacet());
 168         m_facetWidget->addFacet(Nepomuk::Utils::Facet::createTagFacet());
 169
 170         connect(m_facetWidget, SIGNAL(queryTermChanged(Nepomuk::Query::Term)),
 171                 this, SLOT(slotQueryTermChanged(Nepomuk::Query::Term)));
 172
 173         m_initialized = true;
 174     }
 175
 176     setEnabled(isFilteringPossible());
 177
 178     Panel::showEvent(event);
 179 }
 180
 181 void SearchPanel::contextMenuEvent(QContextMenuEvent* event)
 182 {
 183     Panel::contextMenuEvent(event);
 184
 185     QWeakPointer<KMenu> popup = new KMenu(this);
 186     foreach (QAction* action, customContextMenuActions()) {
 187         popup.data()->addAction(action);
 188     }
 189     popup.data()->exec(QCursor::pos());
 190     delete popup.data();
 191 }
 192
 193 void SearchPanel::slotSetUrlStatFinished(KJob* job)
 194 {
 195     m_lastSetUrlStatJob = 0;
 196
 197     setEnabled(isFilteringPossible());
 198
 199     const KIO::UDSEntry uds = static_cast<KIO::StatJob*>(job)->statResult();
 200     const QString nepomukQueryStr = uds.stringValue(KIO::UDSEntry::UDS_NEPOMUK_QUERY);
 201     const Nepomuk::Query::Term facetQueryTerm = m_facetWidget->queryTerm();
 202     Nepomuk::Query::FileQuery nepomukQuery;
 203     if (!nepomukQueryStr.isEmpty()) {
 204         // Always merge the query that has been retrieved by SearchPanel::setUrl() with
 205         // the current facet-query, so that the user settings don't get lost.
 206         nepomukQuery = Nepomuk::Query::Query::fromString(nepomukQueryStr) && m_facetWidget->queryTerm();
 207     }
 208
 209     setQuery(nepomukQuery);
 210
 211     if (facetQueryTerm.isValid()) {
 212         Nepomuk::Query::FileQuery query(m_unfacetedRestQuery && facetQueryTerm);
 213         emit urlActivated(query.toSearchUrl());
 214     }
 215 }
 216
 217 void SearchPanel::slotQueryTermChanged(const Nepomuk::Query::Term& term)
 218 {
 219     if (term.isValid()) {
 220         // Default case: A facet has been changed by the user to restrict the query.
 221         if ((m_searchLocation == FromCurrentDir) && !m_unfacetedRestQuery.isValid()) {
 222             // Adjust the query to respect the FromCurrentDir setting
 223             Nepomuk::Query::ComparisonTerm compTerm(
 224                                     Nepomuk::Vocabulary::NFO::fileName(),
 225                                     Nepomuk::Query::Term());
 226
 227             Nepomuk::Query::FileQuery subDirsQuery;
 228             subDirsQuery.setFileMode(Nepomuk::Query::FileQuery::QueryFiles);
 229             subDirsQuery.addIncludeFolder(m_startedFromDir, true);
 230             subDirsQuery.setTerm(compTerm);
 231
 232             setQuery(subDirsQuery);
 233         }
 234
 235         Nepomuk::Query::FileQuery query(m_unfacetedRestQuery && term);
 236         emit urlActivated(query.toSearchUrl());
 237         return;
 238     }
 239
 240     // All facets have been reset by the user to be unrestricted.
 241     // Verify whether the unfaceted rest query contains any additional restriction
 242     // (e.g. a filename in the search field). If no further restriction is given, exit
 243     // the search mode by returning to the directory where the searching has been
 244     // started from.
 245     const Nepomuk::Query::Term rootTerm = m_unfacetedRestQuery.term();
 246     if (rootTerm.type() == Nepomuk::Query::Term::Comparison) {
 247         const Nepomuk::Query::ComparisonTerm& compTerm = static_cast<const Nepomuk::Query::ComparisonTerm&>(rootTerm);
 248         if (compTerm.subTerm().isValid()) {
 249             Nepomuk::Query::FileQuery query(m_unfacetedRestQuery);
 250             emit urlActivated(query.toSearchUrl());
 251             return;
 252         }
 253     }
 254
 255     emit urlActivated(m_startedFromDir);
 256 }
 257
 258 void SearchPanel::setQuery(const Nepomuk::Query::Query& query)
 259 {
 260     const bool block = m_facetWidget->blockSignals(true);
 261     m_unfacetedRestQuery = m_facetWidget->extractFacetsFromQuery(query);
 262     m_facetWidget->setClientQuery(query);
 263     m_facetWidget->blockSignals(block);
 264 }
 265
 266 bool SearchPanel::isFilteringPossible() const
 267 {
 268     const DolphinSearchInformation& searchInfo = DolphinSearchInformation::instance();
 269     return searchInfo.isIndexingEnabled()
 270            && ((m_searchLocation == Everywhere) || searchInfo.isPathIndexed(m_startedFromDir));
 271 }