Buteo Synchronization Framework
synchronizer.h
1/*
2 * This file is part of buteo-syncfw package
3 *
4 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
5 * Copyright (C) 2014-2019 Jolla Ltd.
6 * Copyright (C) 2020 Open Mobile Platform LLC.
7 *
8 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
9 *
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public License
12 * version 2.1 as published by the Free Software Foundation.
13 *
14 * This library is distributed in the hope that it will be useful, but
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
22 * 02110-1301 USA
23 *
24 */
25#ifndef SYNCHRONIZER_H
26#define SYNCHRONIZER_H
27
28#include "SyncDBusInterface.h"
29#include "SyncQueue.h"
30#include "StorageBooker.h"
31#include "SyncScheduler.h"
32#include "SyncBackup.h"
33#include "SyncOnChange.h"
34#include "SyncOnChangeScheduler.h"
35
36#include "SyncCommonDefs.h"
37#include "ProfileManager.h"
38#include "PluginManager.h"
39#include "PluginCbInterface.h"
40#include "ClientPlugin.h"
41
42#include <QVector>
43#include <QMutex>
44#include <QCoreApplication>
45#include <QMap>
46#include <QString>
47#include <QDBusInterface>
48#include <QScopedPointer>
49#include <QTimer>
50
51struct _GSettings;
52
53namespace Buteo {
54
55class PluginManager;
56class ServerPluginRunner;
57class NetworkManager;
58class TransportTracker;
59class ServerActivator;
60class AccountsHelper;
61class BatteryInfo;
62
67class Synchronizer : public SyncDBusInterface, // Derived from QObject
69{
70 Q_OBJECT
71public:
72
74 Synchronizer(QCoreApplication *aApplication);
75
77 virtual ~Synchronizer();
78
81 bool initialize();
82
84 void close();
85
86
87// From PluginCbInterface
88// ---------------------------------------------------------------------------
90 virtual bool requestStorage(const QString &aStorageName,
91 const SyncPluginBase *aCaller);
92
94 virtual void releaseStorage(const QString &aStorageName,
95 const SyncPluginBase *aCaller);
96
98 virtual StoragePlugin *createStorage(const QString &aPluginName);
99
101 virtual void destroyStorage(StoragePlugin *aStorage);
102
104 virtual bool isConnectivityAvailable(Sync::ConnectivityType aType);
105
107 virtual Profile *getSyncProfileByRemoteAddress(const QString &aAddress);
108
110 virtual QString getValue(const QString &aAddress, const QString &aKey);
111
112
113// From SyncDBusInterface
114// --------------------------------------------------------------------------
115
116public slots:
117
119 virtual bool startSync(QString aProfileName);
120
122 virtual void abortSync(QString aProfileName);
123
125 virtual bool removeProfile(QString aProfileAsXml);
126
128 virtual bool updateProfile(QString aProfileAsXml);
129
131 virtual bool requestStorages(QStringList aStorageNames);
132
134 virtual void releaseStorages(QStringList aStorageNames);
135
137 virtual QStringList runningSyncs();
138
140 virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml);
141
143 virtual bool saveSyncResults(QString aProfileId, QString aSyncResults);
144
146 virtual QString createSyncProfileForAccount(uint aAccountId);
147
152 virtual QString getLastSyncResult(const QString &aProfileId);
153
160 virtual QStringList allVisibleSyncProfiles();
161
170 virtual QString syncProfile(const QString &aProfileId);
171 virtual QStringList syncProfilesByKey(const QString &aKey, const QString &aValue);
172 virtual QStringList syncProfilesByType(const QString &aType);
173 virtual QStringList profilesByType(const QString &aType) override;
174// --------------------------------------------------------------------------
175
177 bool startScheduledSync(QString aProfileName);
178
180 void backupStarts();
181
183 void backupFinished();
184
186 void restoreStarts();
187
189 void restoreFinished();
190
192 virtual bool getBackUpRestoreState();
193
194 void start(unsigned int aAccountId);
195
200 void stop(unsigned int aAccountId);
201
207
221 int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime);
222
231 void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName);
232
233signals:
234
236 void storageReleased();
237
243 void syncDone(const QString &aProfileName);
244
245private slots:
246
252 void onStorageReleased();
253
254 void onTransferProgress(const QString &aProfileName,
255 Sync::TransferDatabase aDatabase, Sync::TransferType aType,
256 const QString &aMimeType, int aCommittedItems);
257
258 void onSessionFinished(const QString &aProfileName,
259 Sync::SyncStatus aStatus, const QString &aMessage,
260 SyncResults::MinorCode aErrorCode);
261
262 void onStorageAccquired(const QString &aProfileName, const QString &aMimeType);
263
264 void onSyncProgressDetail(const QString &aProfileName, int aProgressDetail);
265
266 void onServerDone();
267
268 void onNewSession(const QString &aDestination);
269
270 void slotProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml);
271
276 void startServer(const QString &aProfileName);
277
282 void stopServer(const QString &aProfileName);
283
284 void onNetworkStateChanged(bool aState, Sync::InternetConnectionType type);
285
292 void enableSOCSlot(const QString &aProfileName);
293
298 void reschedule(const QString &aProfileName);
299
307 void slotSyncStatus(QString aProfileName, int aStatus,
308 QString aMessage, int aMoreDetails);
309
314 void removeScheduledSync(const QString &aProfileName);
315
321 void externalSyncStatus(const QString &aProfileName, bool aQuery);
322
324 void profileChangeTriggerTimeout();
325
326private:
327
328 bool startSync(const QString &aProfileName, bool aScheduled);
329
335 bool startSyncNow(SyncSession *aSession);
336
343 bool startNextSync();
344
350 void cleanupSession(SyncSession *aSession, Sync::SyncStatus aStatus);
351
356 void startServers(bool resume = false);
357
362 void stopServers(bool suspend = false);
363
367 void backupRestoreStarts();
368
372 void backupRestoreFinished();
373
377 void initializeScheduler();
378
379 bool isBackupRestoreInProgress();
380
386 bool cleanupProfile(const QString &profileId);
387
388 bool clientProfileActive(const QString &clientProfileName);
389
395 void removeExternalSyncStatus(const SyncProfile *aProfile);
396
401 bool acceptScheduledSync(bool aConnected, Sync::InternetConnectionType aType, SyncProfile *profile) const;
402
410 void externalSyncStatus(const SyncProfile *aProfile, bool aQuery = false);
411
412 QMap<QString, SyncSession *> iActiveSessions;
413 QMap<QString, bool> iExternalSyncProfileStatus;
414 QList<QString> iProfilesToRemove;
416 QList<QString> iWaitingOnlineSyncs;
417 NetworkManager *iNetworkManager;
418 QMap<QString, int> iCountersStorage;
419 PluginManager iPluginManager;
420 ProfileManager iProfileManager;
421 SyncQueue iSyncQueue;
422 StorageBooker iStorageBooker;
423 SyncScheduler *iSyncScheduler;
424 SyncBackup *iSyncBackup;
425 TransportTracker *iTransportTracker;
426 ServerActivator *iServerActivator;
427 AccountsHelper *iAccounts;
428 bool iClosing;
429 SyncOnChange iSyncOnChange;
430 SyncOnChangeScheduler iSyncOnChangeScheduler;
431
436 void saveProfileCounter(const SyncProfile *aProfile);
437
442 void restoreProfileCounter(SyncProfile *aProfile);
443
444 bool iSOCEnabled;
445 QString iUUID;
446 QString iRemoteName;
447
448 /*
449 * Temporary, until we can clean up Buteo and properly implement the SyncOnChange
450 * queue to handle all of the required changes (account + profile + connectivity)
451 * in a sane manner (also taking into account BackupRestore status).
452 * However, that change will be far more invasive, so for now this is much simpler.
453 */
455 QTimer iProfileChangeTriggerTimer;
456
457#ifdef SYNCFW_UNIT_TESTS
458 friend class SynchronizerTest;
459#endif
460
461 QDBusInterface *iSyncUIInterface;
462 _GSettings *iSettings;
463 BatteryInfo *iBatteryInfo;
464};
465
466}
467
468#endif // SYNCHRONIZER_H
Helper Class towards Accounts::Manager and various SSO related operations.
Definition AccountsHelper.h:42
Class for managing network sessions.
Definition NetworkManager.h:43
Interface which client and server plugins can use to communicate with synchronization daemon.
Definition PluginCbInterface.h:39
Manages plugins.
Definition PluginManager.h:56
ProfileManager is responsible for storing and retrieving the profiles.
Definition ProfileManager.h:46
This class represents a single profile, a collection of settings or data releated to some entity.
Definition Profile.h:53
Keeps track of which server plug-ins should be enabled.
Definition ServerActivator.h:48
A helper class for managing storage reservations.
Definition StorageBooker.h:37
Base class for storage plugins.
Definition StoragePlugin.h:39
Handles Sync requirements towards Backup.
Definition SyncBackup.h:38
Defines a D-Bus interface for the sync daemon.
Definition msyncd/SyncDBusInterface.h:42
Definition SyncOnChangeScheduler.h:15
this class initiates a sync if there are changes in storage(s) it's asked to monitor
Definition SyncOnChange.h:19
Base class for client and server plugins.
Definition SyncPluginBase.h:46
A top level synchronization profile.
Definition SyncProfile.h:49
Class for queuing sync sessions.
Definition SyncQueue.h:38
MinorCode
enum value
Definition SyncResults.h:89
SyncScheduler Object to be used to set Schedule via the framework.
Definition SyncScheduler.h:55
Class representing a single sync session.
Definition SyncSession.h:44
The main entry point to the synchronization framework.
Definition synchronizer.h:69
virtual void abortSync(QString aProfileName)
Definition synchronizer.cpp:787
virtual void releaseStorages(QStringList aStorageNames)
Definition synchronizer.cpp:953
virtual Profile * getSyncProfileByRemoteAddress(const QString &aAddress)
Definition synchronizer.cpp:1873
virtual QString createSyncProfileForAccount(uint aAccountId)
Definition synchronizer.cpp:377
virtual ~Synchronizer()
Destructor.
Definition synchronizer.cpp:111
virtual QStringList allVisibleSyncProfiles()
Gets all visible sync profiles.
Definition synchronizer.cpp:1744
void syncDone(const QString &aProfileName)
emit this signal when the sync session is completed, this is useful when the session status is not im...
Definition moc_synchronizer.cpp:434
void restoreFinished()
Called when backup is restored.
Definition synchronizer.cpp:1606
bool initialize()
registers the dbus service and creates handlers for various tasks of the synchronizer
Definition synchronizer.cpp:120
bool startScheduledSync(QString aProfileName)
Called starts a schedule sync.
Definition synchronizer.cpp:296
void stop(unsigned int aAccountId)
Stops sync for all profiles matching the given account ID.
Definition synchronizer.cpp:1630
void backupStarts()
Called when backup starts.
Definition synchronizer.cpp:1585
void restoreStarts()
Called when starting to restore a backup.
Definition synchronizer.cpp:1599
void close()
stops the daemon and unregisters the dbus object
Definition synchronizer.cpp:246
virtual void destroyStorage(StoragePlugin *aStorage)
Definition synchronizer.cpp:1080
virtual bool isConnectivityAvailable(Sync::ConnectivityType aType)
Definition synchronizer.cpp:1087
int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime)
Returns the status of the sync for the given account Id.
Definition synchronizer.cpp:1641
void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName)
Queries the sync externally status of a given account, 'syncedExternallyStatus' signal is emitted wit...
Definition synchronizer.cpp:2034
void storageReleased()
emitted by releaseStorages call
Definition moc_synchronizer.cpp:428
virtual QString getLastSyncResult(const QString &aProfileId)
To get lastSyncResult.
Definition synchronizer.cpp:1720
virtual QString getValue(const QString &aAddress, const QString &aKey)
Definition synchronizer.cpp:1893
virtual StoragePlugin * createStorage(const QString &aPluginName)
Definition synchronizer.cpp:1044
virtual bool startSync(QString aProfileName)
Definition synchronizer.cpp:288
virtual QString syncProfile(const QString &aProfileId)
Gets a sync profile.
Definition synchronizer.cpp:1765
virtual bool removeProfile(QString aProfileAsXml)
Definition synchronizer.cpp:878
void backupFinished()
Called when backup is completed.
Definition synchronizer.cpp:1592
QList< unsigned int > syncingAccounts()
Returns the list of account IDs for which sync is ongoing.
Definition synchronizer.cpp:1691
virtual bool updateProfile(QString aProfileAsXml)
Definition synchronizer.cpp:896
virtual bool requestStorages(QStringList aStorageNames)
Definition synchronizer.cpp:946
virtual bool requestStorage(const QString &aStorageName, const SyncPluginBase *aCaller)
Definition synchronizer.cpp:1026
virtual QStringList runningSyncs()
Definition synchronizer.cpp:961
virtual void releaseStorage(const QString &aStorageName, const SyncPluginBase *aCaller)
Definition synchronizer.cpp:1035
virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml)
Definition synchronizer.cpp:353
virtual bool saveSyncResults(QString aProfileId, QString aSyncResults)
Definition synchronizer.cpp:363
virtual bool getBackUpRestoreState()
Called to get the current backup/restore state.
Definition synchronizer.cpp:1613
Class for tracking transport states.
Definition TransportTracker.h:50
Definition SyncBackupAdaptor.h:40
Definition SyncBackupAdaptor.h:41