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