SynchronizationManager.h

/*
 * Copyright 2016-2020 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIB_QUENTIER_SYNCHRONIZATION_SYNCHRONIZATION_MANAGER_H
#define LIB_QUENTIER_SYNCHRONIZATION_SYNCHRONIZATION_MANAGER_H
 
#include <quentier/synchronization/ForwardDeclarations.h>
#include <quentier/types/Account.h>
#include <quentier/types/ErrorString.h>
#include <quentier/types/LinkedNotebook.h>
#include <quentier/utility/ForwardDeclarations.h>
#include <quentier/utility/Linkage.h>
 
#include <QObject>
 
namespace quentier {
 
QT_FORWARD_DECLARE_CLASS(LocalStorageManagerAsync)
QT_FORWARD_DECLARE_CLASS(SynchronizationManagerPrivate)
 
 
class QUENTIER_EXPORT SynchronizationManager : public QObject
{
    Q_OBJECT
public:
    SynchronizationManager(
        QString host, LocalStorageManagerAsync & localStorageManagerAsync,
        IAuthenticationManager & authenticationManager,
        QObject * parent = nullptr, INoteStorePtr pNoteStore = {},
        IUserStorePtr pUserStore = {},
        IKeychainServicePtr pKeychainService = {},
        ISyncStateStoragePtr pSyncStateStorage = {});
 
    virtual ~SynchronizationManager();
 
    bool active() const;
 
    bool downloadNoteThumbnailsOption() const;
 
public Q_SLOTS:
    void setAccount(Account account);
 
    void authenticate();
 
    void authenticateCurrentAccount();
 
    void synchronize();
 
    void stop();
 
    void revokeAuthentication(const qevercloud::UserID userId);
 
    void setDownloadNoteThumbnails(bool flag);
 
    void setDownloadInkNoteImages(bool flag);
 
    void setInkNoteImagesStoragePath(QString path);
 
Q_SIGNALS:
    void started();
 
    void stopped();
 
    void failed(ErrorString errorDescription);
 
    void finished(
        Account account, bool somethingDownloaded, bool somethingSent);
 
    void authenticationRevoked(
        bool success, ErrorString errorDescription, qevercloud::UserID userId);
 
    void authenticationFinished(
        bool success, ErrorString errorDescription, Account account);
 
    void remoteToLocalSyncStopped();
 
    void sendLocalChangesStopped();
 
    void willRepeatRemoteToLocalSyncAfterSendingChanges();
 
    void detectedConflictDuringLocalChangesSending();
 
    void rateLimitExceeded(qint32 secondsToWait);
 
    void remoteToLocalSyncDone(bool somethingDownloaded);
 
    void syncChunksDownloadProgress(
        qint32 highestDownloadedUsn, qint32 highestServerUsn,
        qint32 lastPreviousUsn);
 
    void syncChunksDownloaded();
 
    void linkedNotebookSyncChunksDownloadProgress(
        qint32 highestDownloadedUsn, qint32 highestServerUsn,
        qint32 lastPreviousUsn, LinkedNotebook linkedNotebook);
 
    void linkedNotebooksSyncChunksDownloaded();
 
    void notesDownloadProgress(
        quint32 notesDownloaded, quint32 totalNotesToDownload);
 
    void linkedNotebooksNotesDownloadProgress(
        quint32 notesDownloaded, quint32 totalNotesToDownload);
 
    void resourcesDownloadProgress(
        quint32 resourcesDownloaded, quint32 totalResourcesToDownload);
 
    void linkedNotebooksResourcesDownloadProgress(
        quint32 resourcesDownloaded, quint32 totalResourcesToDownload);
 
    void preparedDirtyObjectsForSending();
 
    void preparedLinkedNotebooksDirtyObjectsForSending();
 
    void setAccountDone(Account account);
 
    void setDownloadNoteThumbnailsDone(bool flag);
 
    void setDownloadInkNoteImagesDone(bool flag);
 
    void setInkNoteImagesStoragePathDone(QString path);
 
private:
    SynchronizationManager() = delete;
    Q_DISABLE_COPY(SynchronizationManager)
 
    SynchronizationManagerPrivate * d_ptr;
    Q_DECLARE_PRIVATE(SynchronizationManager)
};
 
} // namespace quentier
 
#endif // LIB_QUENTIER_SYNCHRONIZATION_SYNCHRONIZATION_MANAGER_H