• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • sources
  • kde-4.14
  • kdepimlibs
  • akonadi
agentsearchinterface.cpp
1 /*
2  Copyright (c) 2009 Volker Krause <vkrause@kde.org>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #include "agentsearchinterface.h"
21 #include "agentsearchinterface_p.h"
22 #include "collection.h"
23 #include "dbusconnectionpool.h"
24 #include "searchresultjob_p.h"
25 #include "searchadaptor.h"
26 #include "collectionfetchjob.h"
27 #include "collectionfetchscope.h"
28 #include "servermanager.h"
29 #include "agentbase.h"
30 
31 using namespace Akonadi;
32 
33 AgentSearchInterfacePrivate::AgentSearchInterfacePrivate(AgentSearchInterface *qq)
34  : q(qq)
35 {
36  new Akonadi__SearchAdaptor(this);
37  DBusConnectionPool::threadConnection().registerObject(QLatin1String("/Search"),
38  this, QDBusConnection::ExportAdaptors);
39 
40  QTimer::singleShot(0, this, SLOT(delayedInit()));
41 }
42 
43 void AgentSearchInterfacePrivate::delayedInit()
44 {
45  QDBusInterface iface(ServerManager::serviceName(ServerManager::Server),
46  QLatin1String("/SearchManager"),
47  QLatin1String("org.freedesktop.Akonadi.SearchManager"),
48  QDBusConnection::sessionBus(), this);
49  QDBusMessage msg = iface.call(QLatin1String("registerInstance"), dynamic_cast<AgentBase *>(q)->identifier());
50 }
51 
52 void AgentSearchInterfacePrivate::addSearch(const QString &query, const QString &queryLanguage, quint64 resultCollectionId)
53 {
54  q->addSearch(query, queryLanguage, Collection(resultCollectionId));
55 }
56 
57 void AgentSearchInterfacePrivate::removeSearch(quint64 resultCollectionId)
58 {
59  q->removeSearch(Collection(resultCollectionId));
60 }
61 
62 void AgentSearchInterfacePrivate::search(const QByteArray &searchId,
63  const QString &query,
64  quint64 collectionId)
65 {
66  mSearchId = searchId;
67  mCollectionId = collectionId;
68 
69  CollectionFetchJob *fetchJob = new CollectionFetchJob(Collection(mCollectionId), CollectionFetchJob::Base, this);
70  fetchJob->fetchScope().setAncestorRetrieval(CollectionFetchScope::All);
71  fetchJob->setProperty("query", query);
72  connect(fetchJob, SIGNAL(finished(KJob*)), this, SLOT(collectionReceived(KJob*)));
73 }
74 
75 void AgentSearchInterfacePrivate::collectionReceived(KJob *job)
76 {
77  CollectionFetchJob *fetchJob = qobject_cast<CollectionFetchJob *>(job);
78  if (fetchJob->error()) {
79  kError() << fetchJob->errorString();
80  new SearchResultJob(fetchJob->property("searchId").toByteArray(), Collection(mCollectionId), this);
81  return;
82  }
83 
84  if (fetchJob->collections().count() != 1) {
85  kDebug() << "Server requested search in invalid collection, or collection was removed in the meanwhile";
86  // Tell server we are done
87  new SearchResultJob(fetchJob->property("searchId").toByteArray(), Collection(mCollectionId), this);
88  return;
89  }
90 
91  const Collection collection = fetchJob->collections().first();
92  q->search(fetchJob->property("query").toString(),
93  collection);
94 }
95 
96 AgentSearchInterface::AgentSearchInterface()
97  : d(new AgentSearchInterfacePrivate(this))
98 {
99 }
100 
101 AgentSearchInterface::~AgentSearchInterface()
102 {
103  delete d;
104 }
105 
106 void AgentSearchInterface::searchFinished(const QVector<qint64> result, ResultScope scope)
107 {
108  if (scope == Akonadi::AgentSearchInterface::Rid) {
109  QVector<QByteArray> rids;
110  rids.reserve(result.size());
111  Q_FOREACH (qint64 rid, result) {
112  rids << QByteArray::number(rid);
113  }
114 
115  searchFinished(rids);
116  return;
117  }
118 
119  SearchResultJob *resultJob = new SearchResultJob(d->mSearchId, Collection(d->mCollectionId), d);
120  resultJob->setResult(result);
121 }
122 
123 void AgentSearchInterface::searchFinished(const ImapSet &result, ResultScope scope)
124 {
125  if (scope == Akonadi::AgentSearchInterface::Rid) {
126  QVector<QByteArray> rids;
127  Q_FOREACH (const ImapInterval &interval, result.intervals()) {
128  for (int i = interval.begin(); i <= interval.end(); ++i) {
129  rids << QByteArray::number(i);
130  }
131  }
132 
133  searchFinished(rids);
134  return;
135  }
136 
137  SearchResultJob *resultJob = new SearchResultJob(d->mSearchId, Collection(d->mCollectionId), d);
138  resultJob->setResult(result);
139 }
140 
141 void AgentSearchInterface::searchFinished(const QVector<QByteArray> &result)
142 {
143  SearchResultJob *resultJob = new SearchResultJob(d->mSearchId, Collection(d->mCollectionId), d);
144  resultJob->setResult(result);
145 }
146 
147 #include "moc_agentsearchinterface_p.cpp"
Akonadi::AgentSearchInterface
An interface for agents (or resources) that support searching in their backend.
Definition: agentsearchinterface.h:42
Akonadi::CollectionFetchScope::setAncestorRetrieval
void setAncestorRetrieval(AncestorRetrieval ancestorDepth)
Sets how many levels of ancestor collections should be included in the retrieval. ...
Definition: collectionfetchscope.cpp:138
Akonadi::CollectionFetchJob::collections
Collection::List collections() const
Returns the list of fetched collection.
Definition: collectionfetchjob.cpp:169
QByteArray
Akonadi::CollectionFetchJob::fetchScope
CollectionFetchScope & fetchScope()
Returns the collection fetch scope.
Definition: collectionfetchjob.cpp:439
Akonadi::Collection
Represents a collection of PIM items.
Definition: collection.h:75
Akonadi::CollectionFetchJob
Job that fetches collections from the Akonadi storage.
Definition: collectionfetchjob.h:53
QDBusConnection::sessionBus
QDBusConnection sessionBus()
Akonadi::ServerManager::serviceName
static QString serviceName(ServiceType serviceType)
Returns the namespaced D-Bus service name for serviceType.
Definition: servermanager.cpp:307
Akonadi::AgentSearchInterface::AgentSearchInterface
AgentSearchInterface()
Creates a new agent search interface.
Definition: agentsearchinterface.cpp:96
Akonadi::CollectionFetchJob::Base
Only fetch the base collection.
Definition: collectionfetchjob.h:62
QList::count
int count(const T &value) const
QByteArray::number
QByteArray number(int n, int base)
Akonadi::CollectionFetchScope::All
Retrieve all ancestors, up to Collection::root()
Definition: collectionfetchscope.h:77
Akonadi::AgentSearchInterface::~AgentSearchInterface
virtual ~AgentSearchInterface()
Destroys the agent search interface.
Definition: agentsearchinterface.cpp:101
QList::first
T & first()
QString
QDBusInterface
QVector::reserve
void reserve(int size)
QVector
Definition: kcolumnfilterproxymodel_p.h:27
QDBusMessage
QLatin1String
Akonadi::Job::errorString
virtual QString errorString() const
Returns the error string, if there has been an error, an empty string otherwise.
Definition: job.cpp:301
QVector::size
int size() const
QTimer::singleShot
singleShot
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:02 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal