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
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// --------------------------------------------------------------------------
174
176 bool startScheduledSync(QString aProfileName);
177
179 void backupStarts();
180
182 void backupFinished();
183
185 void restoreStarts();
186
188 void restoreFinished();
189
191 virtual bool getBackUpRestoreState();
192
193 void start(unsigned int aAccountId);
194
199 void stop(unsigned int aAccountId);
200
206
220 int status(unsigned int aAccountId, int &aFailedReason, qlonglong &aPrevSyncTime, qlonglong &aNextSyncTime);
221
230 void isSyncedExternally(unsigned int aAccountId, const QString aClientProfileName);
231
232signals:
233
235 void storageReleased();
236
242 void syncDone(const QString &aProfileName);
243
244private slots:
245
251 void onStorageReleased();
252
253 void onTransferProgress(const QString &aProfileName,
254 Sync::TransferDatabase aDatabase, Sync::TransferType aType,
255 const QString &aMimeType, int aCommittedItems);
256
257 void onSessionFinished(const QString &aProfileName,
258 Sync::SyncStatus aStatus, const QString &aMessage,
259 SyncResults::MinorCode aErrorCode);
260
261 void onStorageAccquired(const QString &aProfileName, const QString &aMimeType);
262
263 void onSyncProgressDetail(const QString &aProfileName, int aProgressDetail);
264
265 void onServerDone();
266
267 void onNewSession(const QString &aDestination);
268
269 void slotProfileChanged(QString aProfileName, int aChangeType, QString aProfileAsXml);
270
275 void startServer(const QString &aProfileName);
276
281 void stopServer(const QString &aProfileName);
282#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
283 void onNetworkStateChanged(bool aState, QNetworkInformation::TransportMedium type);
284#else
285 void onNetworkStateChanged(bool aState, Sync::InternetConnectionType type);
286#endif
293 void enableSOCSlot(const QString &aProfileName);
294
299 void reschedule(const QString &aProfileName);
300
308 void slotSyncStatus(QString aProfileName, int aStatus,
309 QString aMessage, int aMoreDetails);
310
315 void removeScheduledSync(const QString &aProfileName);
316
322 void externalSyncStatus(const QString &aProfileName, bool aQuery);
323
325 void profileChangeTriggerTimeout();
326
327private:
328
329 bool startSync(const QString &aProfileName, bool aScheduled);
330
336 bool startSyncNow(SyncSession *aSession);
337
344 bool startNextSync();
345
351 void cleanupSession(SyncSession *aSession, Sync::SyncStatus aStatus);
352
357 void startServers(bool resume = false);
358
363 void stopServers(bool suspend = false);
364
368 void backupRestoreStarts();
369
373 void backupRestoreFinished();
374
378 void initializeScheduler();
379
380 bool isBackupRestoreInProgress();
381
387 bool cleanupProfile(const QString &profileId);
388
389 bool clientProfileActive(const QString &clientProfileName);
390
396 void removeExternalSyncStatus(const SyncProfile *aProfile);
397
402#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
403 bool acceptScheduledSync(SyncProfile *profile) const;
404#else
405 bool acceptScheduledSync(bool aConnected, Sync::InternetConnectionType aType, SyncProfile *profile) const;
406#endif
414 void externalSyncStatus(const SyncProfile *aProfile, bool aQuery = false);
415
416 QMap<QString, SyncSession *> iActiveSessions;
417 QMap<QString, bool> iExternalSyncProfileStatus;
418 QList<QString> iProfilesToRemove;
420 QList<QString> iWaitingOnlineSyncs;
421#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
422 QNetworkInformation *iNetworkManager;
423#else
424 NetworkManager *iNetworkManager;
425#endif
426 QMap<QString, int> iCountersStorage;
427 PluginManager iPluginManager;
428 ProfileManager iProfileManager;
429 SyncQueue iSyncQueue;
430 StorageBooker iStorageBooker;
431 SyncScheduler *iSyncScheduler;
432 SyncBackup *iSyncBackup;
433 TransportTracker *iTransportTracker;
434 ServerActivator *iServerActivator;
435 AccountsHelper *iAccounts;
436 bool iClosing;
437 SyncOnChange iSyncOnChange;
438 SyncOnChangeScheduler iSyncOnChangeScheduler;
439
444 void saveProfileCounter(const SyncProfile *aProfile);
445
450 void restoreProfileCounter(SyncProfile *aProfile);
451
452 bool iSOCEnabled;
453 QString iUUID;
454 QString iRemoteName;
455
456 /*
457 * Temporary, until we can clean up Buteo and properly implement the SyncOnChange
458 * queue to handle all of the required changes (account + profile + connectivity)
459 * in a sane manner (also taking into account BackupRestore status).
460 * However, that change will be far more invasive, so for now this is much simpler.
461 */
463 QTimer iProfileChangeTriggerTimer;
464
465#ifdef SYNCFW_UNIT_TESTS
466 friend class SynchronizerTest;
467#endif
468
469 QDBusInterface *iSyncUIInterface;
470 _GSettings *iSettings;
471 BatteryInfo *iBatteryInfo;
472};
473
474}
475
476#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:54
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:801
virtual void releaseStorages(QStringList aStorageNames)
Definition synchronizer.cpp:971
virtual Profile * getSyncProfileByRemoteAddress(const QString &aAddress)
Definition synchronizer.cpp:1886
virtual QString createSyncProfileForAccount(uint aAccountId)
Definition synchronizer.cpp:383
virtual ~Synchronizer()
Destructor.
Definition synchronizer.cpp:99
virtual QStringList allVisibleSyncProfiles()
Gets all visible sync profiles.
Definition synchronizer.cpp:1766
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:805
void restoreFinished()
Called when backup is restored.
Definition synchronizer.cpp:1628
bool initialize()
registers the dbus service and creates handlers for various tasks of the synchronizer
Definition synchronizer.cpp:108
bool startScheduledSync(QString aProfileName)
Called starts a schedule sync.
Definition synchronizer.cpp:286
void stop(unsigned int aAccountId)
Stops sync for all profiles matching the given account ID.
Definition synchronizer.cpp:1652
void backupStarts()
Called when backup starts.
Definition synchronizer.cpp:1607
void restoreStarts()
Called when starting to restore a backup.
Definition synchronizer.cpp:1621
void close()
stops the daemon and unregisters the dbus object
Definition synchronizer.cpp:236
virtual void destroyStorage(StoragePlugin *aStorage)
Definition synchronizer.cpp:1098
virtual bool isConnectivityAvailable(Sync::ConnectivityType aType)
Definition synchronizer.cpp:1105
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:1663
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:2074
void storageReleased()
emitted by releaseStorages call
Definition moc_synchronizer.cpp:799
virtual QString getLastSyncResult(const QString &aProfileId)
To get lastSyncResult.
Definition synchronizer.cpp:1742
virtual QString getValue(const QString &aAddress, const QString &aKey)
Definition synchronizer.cpp:1906
virtual StoragePlugin * createStorage(const QString &aPluginName)
Definition synchronizer.cpp:1062
virtual bool startSync(QString aProfileName)
Definition synchronizer.cpp:278
virtual QString syncProfile(const QString &aProfileId)
Gets a sync profile.
Definition synchronizer.cpp:1787
virtual bool removeProfile(QString aProfileAsXml)
Definition synchronizer.cpp:892
void backupFinished()
Called when backup is completed.
Definition synchronizer.cpp:1614
QList< unsigned int > syncingAccounts()
Returns the list of account IDs for which sync is ongoing.
Definition synchronizer.cpp:1713
virtual bool updateProfile(QString aProfileAsXml)
Definition synchronizer.cpp:910
virtual bool requestStorages(QStringList aStorageNames)
Definition synchronizer.cpp:964
virtual bool requestStorage(const QString &aStorageName, const SyncPluginBase *aCaller)
Definition synchronizer.cpp:1044
virtual QStringList runningSyncs()
Definition synchronizer.cpp:979
virtual void releaseStorage(const QString &aStorageName, const SyncPluginBase *aCaller)
Definition synchronizer.cpp:1053
virtual bool setSyncSchedule(QString aProfileId, QString aScheduleAsXml)
Definition synchronizer.cpp:359
virtual bool saveSyncResults(QString aProfileId, QString aSyncResults)
Definition synchronizer.cpp:369
virtual bool getBackUpRestoreState()
Called to get the current backup/restore state.
Definition synchronizer.cpp:1635
Class for tracking transport states.
Definition TransportTracker.h:52
Definition SyncBackupAdaptor.h:41