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