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

akonadi

  • akonadi
specialcollections.cpp
1/*
2 Copyright (c) 2009 Constantin Berzan <exit3219@gmail.com>
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 "specialcollections.h"
21
22#include "specialcollections_p.h"
23#include "specialcollectionattribute_p.h"
24
25#include "akonadi/agentinstance.h"
26#include "akonadi/agentmanager.h"
27#include "akonadi/collectionmodifyjob.h"
28#include "akonadi/collectionfetchjob.h"
29#include "akonadi/monitor.h"
30
31#include <KDebug>
32#include <kcoreconfigskeleton.h>
33
34#include <QtCore/QHash>
35#include <QtCore/QObject>
36#include <QtCore/QSet>
37#include <akonadi/collectionfetchscope.h>
38
39using namespace Akonadi;
40
41SpecialCollectionsPrivate::SpecialCollectionsPrivate(KCoreConfigSkeleton *settings, SpecialCollections *qq)
42 : q(qq)
43 , mSettings(settings)
44 , mBatchMode(false)
45{
46 mMonitor = new Monitor(q);
47 mMonitor->fetchCollectionStatistics(true);
48
53 QObject::connect(mMonitor, SIGNAL(collectionRemoved(Akonadi::Collection)),
54 q, SLOT(collectionRemoved(Akonadi::Collection)));
55 QObject::connect(mMonitor, SIGNAL(collectionStatisticsChanged(Akonadi::Collection::Id,Akonadi::CollectionStatistics)),
56 q, SLOT(collectionStatisticsChanged(Akonadi::Collection::Id,Akonadi::CollectionStatistics)));
57}
58
59SpecialCollectionsPrivate::~SpecialCollectionsPrivate()
60{
61}
62
63QString SpecialCollectionsPrivate::defaultResourceId() const
64{
65 if (mDefaultResourceId.isEmpty()) {
66 mSettings->readConfig();
67 const KConfigSkeletonItem *item = mSettings->findItem(QLatin1String("DefaultResourceId"));
68 Q_ASSERT(item);
69
70 mDefaultResourceId = item->property().toString();
71 }
72 return mDefaultResourceId;
73}
74
75void SpecialCollectionsPrivate::emitChanged(const QString &resourceId)
76{
77 if (mBatchMode) {
78 mToEmitChangedFor.insert(resourceId);
79 } else {
80 kDebug() << "Emitting changed for" << resourceId;
81 const AgentInstance agentInstance = AgentManager::self()->instance(resourceId);
82 emit q->collectionsChanged(agentInstance);
83 // first compare with local value then with config value (which also updates the local value)
84 if (resourceId == mDefaultResourceId || resourceId == defaultResourceId()) {
85 kDebug() << "Emitting defaultFoldersChanged.";
86 emit q->defaultCollectionsChanged();
87 }
88 }
89}
90
91void SpecialCollectionsPrivate::collectionRemoved(const Collection &collection)
92{
93 kDebug() << "Collection" << collection.id() << "resource" << collection.resource();
94 if (mFoldersForResource.contains(collection.resource())) {
95
96 // Retrieve the list of special folders for the resource the collection belongs to
97 QHash<QByteArray, Collection> &folders = mFoldersForResource[collection.resource()];
98 {
99 QMutableHashIterator<QByteArray, Collection> it(folders);
100 while (it.hasNext()) {
101 it.next();
102 if (it.value() == collection) {
103 // The collection to be removed is a special folder
104 it.remove();
105 emitChanged(collection.resource());
106 }
107 }
108 }
109
110 if (folders.isEmpty()) {
111 // This resource has no more folders, so remove it completely.
112 mFoldersForResource.remove(collection.resource());
113 }
114 }
115}
116
117void SpecialCollectionsPrivate::collectionStatisticsChanged(Akonadi::Collection::Id collectionId, const Akonadi::CollectionStatistics &statistics)
118{
119 // need to get the name of the collection in order to be able to check if we are storing it,
120 // but we have the id from the monitor, so fetch the name.
121 Akonadi::CollectionFetchJob *fetchJob = new Akonadi::CollectionFetchJob(Collection(collectionId), Akonadi::CollectionFetchJob::Base);
122 fetchJob->fetchScope().setAncestorRetrieval(Akonadi::CollectionFetchScope::None);
123 fetchJob->setProperty("statistics", QVariant::fromValue(statistics));
124
125 q->connect(fetchJob, SIGNAL(result(KJob*)), q, SLOT(collectionFetchJobFinished(KJob*)));
126}
127
128void SpecialCollectionsPrivate::collectionFetchJobFinished(KJob *job)
129{
130 if (job->error()) {
131 kWarning() << "Error fetching collection to get name from id for statistics updating in specialcollections!";
132 return;
133 }
134
135 const Akonadi::CollectionFetchJob *fetchJob = qobject_cast<Akonadi::CollectionFetchJob *>(job);
136
137 Q_ASSERT(fetchJob->collections().size() > 0);
138 const Akonadi::Collection collection = fetchJob->collections().first();
139 const Akonadi::CollectionStatistics statistics = fetchJob->property("statistics").value<Akonadi::CollectionStatistics>();
140
141 mFoldersForResource[collection.resource()][collection.name().toUtf8()].setStatistics(statistics);
142}
143
144void SpecialCollectionsPrivate::beginBatchRegister()
145{
146 Q_ASSERT(!mBatchMode);
147 mBatchMode = true;
148 Q_ASSERT(mToEmitChangedFor.isEmpty());
149}
150
151void SpecialCollectionsPrivate::endBatchRegister()
152{
153 Q_ASSERT(mBatchMode);
154 mBatchMode = false;
155
156 foreach (const QString &resourceId, mToEmitChangedFor) {
157 emitChanged(resourceId);
158 }
159
160 mToEmitChangedFor.clear();
161}
162
163void SpecialCollectionsPrivate::forgetFoldersForResource(const QString &resourceId)
164{
165 if (mFoldersForResource.contains(resourceId)) {
166 const Collection::List folders = mFoldersForResource[resourceId].values();
167
168 foreach (const Collection &collection, folders) {
169 mMonitor->setCollectionMonitored(collection, false);
170 }
171
172 mFoldersForResource.remove(resourceId);
173 emitChanged(resourceId);
174 }
175}
176
177AgentInstance SpecialCollectionsPrivate::defaultResource() const
178{
179 const QString identifier = defaultResourceId();
180 return AgentManager::self()->instance(identifier);
181}
182
183SpecialCollections::SpecialCollections(KCoreConfigSkeleton *settings, QObject *parent)
184 : QObject(parent)
185 , d(new SpecialCollectionsPrivate(settings, this))
186{
187}
188
189SpecialCollections::~SpecialCollections()
190{
191 delete d;
192}
193
194bool SpecialCollections::hasCollection(const QByteArray &type, const AgentInstance &instance) const
195{
196 return d->mFoldersForResource.value(instance.identifier()).contains(type);
197}
198
199Akonadi::Collection SpecialCollections::collection(const QByteArray &type, const AgentInstance &instance) const
200{
201 return d->mFoldersForResource.value(instance.identifier()).value(type);
202}
203
204void SpecialCollections::setSpecialCollectionType(const QByteArray &type, const Akonadi::Collection &collection)
205{
206 if (!collection.hasAttribute<SpecialCollectionAttribute>() || collection.attribute<SpecialCollectionAttribute>()->collectionType() != type) {
207 Collection attributeCollection(collection);
208 SpecialCollectionAttribute *attribute = attributeCollection.attribute<SpecialCollectionAttribute>(Collection::AddIfMissing);
209 attribute->setCollectionType(type);
210 new CollectionModifyJob(attributeCollection);
211 }
212}
213
214void SpecialCollections::unsetSpecialCollection(const Akonadi::Collection &collection)
215{
216 if (collection.hasAttribute<SpecialCollectionAttribute>()) {
217 Collection attributeCollection(collection);
218 attributeCollection.removeAttribute<SpecialCollectionAttribute>();
219 new CollectionModifyJob(attributeCollection);
220 }
221}
222
223bool SpecialCollections::unregisterCollection(const Collection &collection)
224{
225 if (!collection.isValid()) {
226 kWarning() << "Invalid collection.";
227 return false;
228 }
229
230 const QString &resourceId = collection.resource();
231 if (resourceId.isEmpty()) {
232 kWarning() << "Collection has empty resourceId.";
233 return false;
234 }
235
236 unsetSpecialCollection(collection);
237
238 d->mMonitor->setCollectionMonitored(collection, false);
239 //Remove from list of collection
240 d->collectionRemoved(collection);
241 return true;
242}
243
244bool SpecialCollections::registerCollection(const QByteArray &type, const Collection &collection)
245{
246 if (!collection.isValid()) {
247 kWarning() << "Invalid collection.";
248 return false;
249 }
250
251 const QString &resourceId = collection.resource();
252 if (resourceId.isEmpty()) {
253 kWarning() << "Collection has empty resourceId.";
254 return false;
255 }
256
257 setSpecialCollectionType(type, collection);
258
259 const Collection oldCollection = d->mFoldersForResource.value(resourceId).value(type);
260 if (oldCollection != collection) {
261 if (oldCollection.isValid()) {
262 d->mMonitor->setCollectionMonitored(oldCollection, false);
263 }
264 d->mMonitor->setCollectionMonitored(collection, true);
265 d->mFoldersForResource[resourceId].insert(type, collection);
266 d->emitChanged(resourceId);
267 }
268
269 return true;
270}
271
272bool SpecialCollections::hasDefaultCollection(const QByteArray &type) const
273{
274 return hasCollection(type, d->defaultResource());
275}
276
277Akonadi::Collection SpecialCollections::defaultCollection(const QByteArray &type) const
278{
279 return collection(type, d->defaultResource());
280}
281
282#include "moc_specialcollections.cpp"
Akonadi::AgentInstance
A representation of an agent instance.
Definition agentinstance.h:63
Akonadi::AgentInstance::identifier
QString identifier() const
Returns the unique identifier of the agent instance.
Definition agentinstance.cpp:55
Akonadi::AgentManager::self
static AgentManager * self()
Returns the global instance of the agent manager.
Definition agentmanager.cpp:377
Akonadi::AgentManager::instance
AgentInstance instance(const QString &identifier) const
Returns the agent instance with the given identifier or an invalid agent instance if the identifier d...
Definition agentmanager.cpp:401
Akonadi::CollectionFetchJob
Job that fetches collections from the Akonadi storage.
Definition collectionfetchjob.h:54
Akonadi::CollectionFetchJob::fetchScope
CollectionFetchScope & fetchScope()
Returns the collection fetch scope.
Definition collectionfetchjob.cpp:439
Akonadi::CollectionFetchJob::Base
@ Base
Only fetch the base collection.
Definition collectionfetchjob.h:62
Akonadi::CollectionFetchJob::collections
Collection::List collections() const
Returns the list of fetched collection.
Definition collectionfetchjob.cpp:169
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::CollectionFetchScope::None
@ None
No ancestor retrieval at all (the default)
Definition collectionfetchscope.h:75
Akonadi::CollectionModifyJob
Job that modifies a collection in the Akonadi storage.
Definition collectionmodifyjob.h:83
Akonadi::CollectionStatistics
Provides statistics information of a Collection.
Definition collectionstatistics.h:70
Akonadi::Collection
Represents a collection of PIM items.
Definition collection.h:76
Akonadi::Collection::resource
QString resource() const
Returns the identifier of the resource owning the collection.
Definition collection.cpp:207
Akonadi::Collection::List
QList< Collection > List
Describes a list of collections.
Definition collection.h:81
Akonadi::Entity::removeAttribute
void removeAttribute(const QByteArray &name)
Removes and deletes the attribute of the given type name.
Definition entity.cpp:142
Akonadi::Entity::AddIfMissing
@ AddIfMissing
Creates the attribute if it is missing.
Definition entity.h:205
Akonadi::Entity::isValid
bool isValid() const
Returns whether the entity is valid.
Definition entity.cpp:97
Akonadi::Entity::hasAttribute
bool hasAttribute(const QByteArray &name) const
Returns true if the entity has an attribute of the given type name, false otherwise.
Definition entity.cpp:148
Akonadi::Entity::Id
qint64 Id
Describes the unique id type.
Definition entity.h:65
Akonadi::Entity::attribute
Attribute * attribute(const QByteArray &name) const
Returns the attribute of the given type name if available, 0 otherwise.
Definition entity.cpp:167
Akonadi::Monitor
Monitors an item or collection for changes.
Definition monitor.h:75
Akonadi::Monitor::setCollectionMonitored
void setCollectionMonitored(const Collection &collection, bool monitored=true)
Sets whether the specified collection shall be monitored for changes.
Definition monitor.cpp:66
Akonadi::Monitor::fetchCollectionStatistics
void fetchCollectionStatistics(bool enable)
Enables automatic fetching of changed collection statistics information from the Akonadi storage.
Definition monitor.cpp:225
Akonadi::SpecialCollectionAttribute
An Attribute that stores the special collection type of a collection.
Definition specialcollectionattribute_p.h:40
Akonadi::SpecialCollectionAttribute::collectionType
QByteArray collectionType() const
Returns the special collections type of the collection.
Definition specialcollectionattribute.cpp:74
Akonadi::SpecialCollectionsPrivate
Definition specialcollections_p.h:45
Akonadi::SpecialCollectionsPrivate::endBatchRegister
void endBatchRegister()
Definition specialcollections.cpp:151
Akonadi::SpecialCollectionsPrivate::SpecialCollectionsPrivate
SpecialCollectionsPrivate(KCoreConfigSkeleton *settings, SpecialCollections *qq)
Definition specialcollections.cpp:41
Akonadi::SpecialCollectionsPrivate::forgetFoldersForResource
void forgetFoldersForResource(const QString &resourceId)
Forgets all folders owned by the given resource.
Definition specialcollections.cpp:163
Akonadi::SpecialCollectionsPrivate::beginBatchRegister
void beginBatchRegister()
Avoids emitting the foldersChanged() signal until endBatchRegister() is called.
Definition specialcollections.cpp:144
Akonadi::SpecialCollections
An interface to special collections.
Definition specialcollections.h:66
Akonadi::SpecialCollections::setSpecialCollectionType
static void setSpecialCollectionType(const QByteArray &type, const Akonadi::Collection &collection)
Sets the special collection attribute which marks collection as being a special collection of type ty...
Definition specialcollections.cpp:204
Akonadi::SpecialCollections::defaultCollectionsChanged
void defaultCollectionsChanged()
Emitted when the special collections for the default resource have been changed (for example,...
Akonadi::SpecialCollections::hasCollection
bool hasCollection(const QByteArray &type, const AgentInstance &instance) const
Returns whether the given agent instance has a special collection of the given type.
Definition specialcollections.cpp:194
Akonadi::SpecialCollections::hasDefaultCollection
bool hasDefaultCollection(const QByteArray &type) const
Returns whether the default resource has a special collection of the given type.
Definition specialcollections.cpp:272
Akonadi::SpecialCollections::collection
Akonadi::Collection collection(const QByteArray &type, const AgentInstance &instance) const
Returns the special collection of the given type in the given agent instance, or an invalid collectio...
Definition specialcollections.cpp:199
Akonadi::SpecialCollections::unsetSpecialCollection
static void unsetSpecialCollection(const Akonadi::Collection &collection)
unsets the special collection attribute which marks collection as being a special collection.
Definition specialcollections.cpp:214
Akonadi::SpecialCollections::unregisterCollection
bool unregisterCollection(const Collection &collection)
Unregisters the given collection as a spec ial collection.
Definition specialcollections.cpp:223
Akonadi::SpecialCollections::registerCollection
bool registerCollection(const QByteArray &type, const Akonadi::Collection &collection)
Registers the given collection as a special collection with the given type.
Definition specialcollections.cpp:244
Akonadi::SpecialCollections::~SpecialCollections
~SpecialCollections()
Destroys the special collections object.
Definition specialcollections.cpp:189
Akonadi::SpecialCollections::SpecialCollections
SpecialCollections(KCoreConfigSkeleton *config, QObject *parent=0)
Creates a new special collections object.
Definition specialcollections.cpp:183
Akonadi::SpecialCollections::collectionsChanged
void collectionsChanged(const Akonadi::AgentInstance &instance)
Emitted when the special collections for a resource have been changed (for example,...
Akonadi::SpecialCollections::defaultCollection
Akonadi::Collection defaultCollection(const QByteArray &type) const
Returns the special collection of given type in the default resource, or an invalid collection if suc...
Definition specialcollections.cpp:277
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 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
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 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
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