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