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