LocalStorageManager.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_LOCAL_STORAGE_LOCAL_STORAGE_MANAGER_H
#define LIB_QUENTIER_LOCAL_STORAGE_LOCAL_STORAGE_MANAGER_H
 
#include <quentier/local_storage/Lists.h>
#include <quentier/local_storage/NoteSearchQuery.h>
#include <quentier/types/Account.h>
#include <quentier/types/ErrorString.h>
#include <quentier/utility/Linkage.h>
 
#include <QHash>
#include <QString>
#include <QVector>
 
#include <cstdint>
#include <memory>
#include <utility>
 
namespace qevercloud {
 
QT_FORWARD_DECLARE_STRUCT(Accounting)
QT_FORWARD_DECLARE_STRUCT(BusinessUserInfo)
QT_FORWARD_DECLARE_STRUCT(NoteAttributes)
QT_FORWARD_DECLARE_STRUCT(NotebookRestrictions)
QT_FORWARD_DECLARE_STRUCT(ResourceAttributes)
QT_FORWARD_DECLARE_STRUCT(PremiumInfo)
QT_FORWARD_DECLARE_STRUCT(SharedNotebook)
QT_FORWARD_DECLARE_STRUCT(UserAttributes)
 
} // namespace qevercloud
 
namespace quentier {
 
QT_FORWARD_DECLARE_CLASS(ILocalStoragePatch)
QT_FORWARD_DECLARE_CLASS(LocalStorageManagerPrivate)
 
class QUENTIER_EXPORT LocalStorageManager : public QObject
{
    Q_OBJECT
public:
    enum class StartupOption
    {
        ClearDatabase = 1,
        OverrideLock = 2
    };
    Q_DECLARE_FLAGS(StartupOptions, StartupOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const StartupOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const StartupOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const StartupOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const StartupOptions options);
 
    explicit LocalStorageManager(
        const Account & account,
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
        const StartupOptions options = {},
#else
        const StartupOptions options = 0,
#endif
        QObject * parent = nullptr);
 
    virtual ~LocalStorageManager() override;
 
Q_SIGNALS:
    void upgradeProgress(double progress);
 
public:
    enum class ListObjectsOption
    {
        ListAll = 0,
        ListDirty = 1,
        ListNonDirty = 2,
        ListElementsWithoutGuid = 4,
        ListElementsWithGuid = 8,
        ListLocal = 16,
        ListNonLocal = 32,
        ListFavoritedElements = 64,
        ListNonFavoritedElements = 128
    };
    Q_DECLARE_FLAGS(ListObjectsOptions, ListObjectsOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListObjectsOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const ListObjectsOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListObjectsOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const ListObjectsOptions options);
 
    void switchUser(
        const Account & account,
#if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
        const StartupOptions options = {});
#else
        const StartupOptions options = 0);
#endif
 
    bool isLocalStorageVersionTooHigh(ErrorString & errorDescription);
 
    bool localStorageRequiresUpgrade(ErrorString & errorDescription);
 
    QVector<std::shared_ptr<ILocalStoragePatch>> requiredLocalStoragePatches();
 
    qint32 localStorageVersion(ErrorString & errorDescription);
 
    qint32 highestSupportedLocalStorageVersion() const;
 
    int userCount(ErrorString & errorDescription) const;
 
    bool addUser(const User & user, ErrorString & errorDescription);
 
    bool updateUser(const User & user, ErrorString & errorDescription);
 
    bool findUser(User & user, ErrorString & errorDescription) const;
 
    bool deleteUser(const User & user, ErrorString & errorDescription);
 
    bool expungeUser(const User & user, ErrorString & errorDescription);
 
    int notebookCount(ErrorString & errorDescription) const;
 
    bool addNotebook(Notebook & notebook, ErrorString & errorDescription);
 
    bool updateNotebook(Notebook & notebook, ErrorString & errorDescription);
 
    bool findNotebook(
        Notebook & notebook, ErrorString & errorDescription) const;
 
    bool findDefaultNotebook(
        Notebook & notebook, ErrorString & errorDescription) const;
 
    bool findLastUsedNotebook(
        Notebook & notebook, ErrorString & errorDescription) const;
 
    bool findDefaultOrLastUsedNotebook(
        Notebook & notebook, ErrorString & errorDescription) const;
 
    enum class OrderDirection
    {
        Ascending = 0,
        Descending
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const OrderDirection orderDirection);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const OrderDirection orderDirection);
 
    enum class ListNotebooksOrder
    {
        ByUpdateSequenceNumber = 0,
        ByNotebookName,
        ByCreationTimestamp,
        ByModificationTimestamp,
        NoOrder
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListNotebooksOrder order);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const ListNotebooksOrder order);
 
    QList<Notebook> listAllNotebooks(
        ErrorString & errorDescription, const size_t limit = 0,
        const size_t offset = 0,
        const ListNotebooksOrder order = ListNotebooksOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    QList<Notebook> listNotebooks(
        const ListObjectsOptions flag, ErrorString & errorDescription,
        const size_t limit = 0, const size_t offset = 0,
        const ListNotebooksOrder order = ListNotebooksOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    QList<SharedNotebook> listAllSharedNotebooks(
        ErrorString & errorDescription) const;
 
    QList<SharedNotebook> listSharedNotebooksPerNotebookGuid(
        const QString & notebookGuid, ErrorString & errorDescription) const;
 
    bool expungeNotebook(Notebook & notebook, ErrorString & errorDescription);
 
    int linkedNotebookCount(ErrorString & errorDescription) const;
 
    bool addLinkedNotebook(
        const LinkedNotebook & linkedNotebook, ErrorString & errorDescription);
 
    bool updateLinkedNotebook(
        const LinkedNotebook & linkedNotebook, ErrorString & errorDescription);
 
    bool findLinkedNotebook(
        LinkedNotebook & linkedNotebook, ErrorString & errorDescription) const;
 
    enum class ListLinkedNotebooksOrder
    {
        ByUpdateSequenceNumber = 0,
        ByShareName,
        ByUsername,
        NoOrder
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListLinkedNotebooksOrder order);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const ListLinkedNotebooksOrder order);
 
    QList<LinkedNotebook> listAllLinkedNotebooks(
        ErrorString & errorDescription, const size_t limit = 0,
        const size_t offset = 0,
        const ListLinkedNotebooksOrder order =
            ListLinkedNotebooksOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending) const;
 
    QList<LinkedNotebook> listLinkedNotebooks(
        const ListObjectsOptions flag, ErrorString & errorDescription,
        const size_t limit = 0, const size_t offset = 0,
        const ListLinkedNotebooksOrder order =
            ListLinkedNotebooksOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending) const;
 
    bool expungeLinkedNotebook(
        const LinkedNotebook & linkedNotebook, ErrorString & errorDescription);
 
    enum class NoteCountOption
    {
        IncludeNonDeletedNotes = 1,
        IncludeDeletedNotes = 2
    };
    Q_DECLARE_FLAGS(NoteCountOptions, NoteCountOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const NoteCountOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const NoteCountOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const NoteCountOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const NoteCountOptions options);
 
    int noteCount(
        ErrorString & errorDescription,
        const NoteCountOptions options =
            NoteCountOption::IncludeNonDeletedNotes) const;
 
    int noteCountPerNotebook(
        const Notebook & notebook, ErrorString & errorDescription,
        const NoteCountOptions options =
            NoteCountOption::IncludeNonDeletedNotes) const;
 
    int noteCountPerTag(
        const Tag & tag, ErrorString & errorDescription,
        const NoteCountOptions options =
            NoteCountOption::IncludeNonDeletedNotes) const;
 
    bool noteCountsPerAllTags(
        QHash<QString, int> & noteCountsPerTagLocalUid,
        ErrorString & errorDescription,
        const NoteCountOptions options =
            NoteCountOption::IncludeNonDeletedNotes) const;
 
    int noteCountPerNotebooksAndTags(
        const QStringList & notebookLocalUids, const QStringList & tagLocalUids,
        ErrorString & errorDescription,
        const NoteCountOptions options =
            NoteCountOption::IncludeNonDeletedNotes) const;
 
    bool addNote(Note & note, ErrorString & errorDescription);
 
    enum class UpdateNoteOption
    {
        UpdateResourceMetadata = 1,
        UpdateResourceBinaryData = 2,
        UpdateTags = 4
    };
    Q_DECLARE_FLAGS(UpdateNoteOptions, UpdateNoteOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const UpdateNoteOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const UpdateNoteOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const UpdateNoteOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const UpdateNoteOptions options);
 
    bool updateNote(
        Note & note, const UpdateNoteOptions options,
        ErrorString & errorDescription);
 
    enum class GetNoteOption
    {
        WithResourceMetadata = 1,
        WithResourceBinaryData = 2
    };
    Q_DECLARE_FLAGS(GetNoteOptions, GetNoteOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const GetNoteOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & dbg, const GetNoteOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const GetNoteOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const GetNoteOptions options);
 
    bool findNote(
        Note & note, const GetNoteOptions options,
        ErrorString & errorDescription) const;
 
    enum class ListNotesOrder
    {
        ByUpdateSequenceNumber = 0,
        ByTitle,
        ByCreationTimestamp,
        ByModificationTimestamp,
        ByDeletionTimestamp,
        ByAuthor,
        BySource,
        BySourceApplication,
        ByReminderTime,
        ByPlaceName,
        NoOrder
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListNotesOrder order);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const ListNotesOrder order);
 
    QList<Note> listNotesPerNotebook(
        const Notebook & notebook, const GetNoteOptions options,
        ErrorString & errorDescription,
        const ListObjectsOptions & flag = ListObjectsOption::ListAll,
        const size_t limit = 0, const size_t offset = 0,
        const ListNotesOrder & order = ListNotesOrder::NoOrder,
        const OrderDirection & orderDirection =
            OrderDirection::Ascending) const;
 
    QList<Note> listNotesPerTag(
        const Tag & tag, const GetNoteOptions options,
        ErrorString & errorDescription,
        const ListObjectsOptions & flag = ListObjectsOption::ListAll,
        const size_t limit = 0, const size_t offset = 0,
        const ListNotesOrder & order = ListNotesOrder::NoOrder,
        const OrderDirection & orderDirection =
            OrderDirection::Ascending) const;
 
    QList<Note> listNotesPerNotebooksAndTags(
        const QStringList & notebookLocalUids, const QStringList & tagLocalUids,
        const GetNoteOptions options, ErrorString & errorDescription,
        const ListObjectsOptions & flag = ListObjectsOption::ListAll,
        const size_t limit = 0, const size_t offset = 0,
        const ListNotesOrder & order = ListNotesOrder::NoOrder,
        const OrderDirection & orderDirection =
            OrderDirection::Ascending) const;
 
    QList<Note> listNotesByLocalUids(
        const QStringList & noteLocalUids, const GetNoteOptions options,
        ErrorString & errorDescription,
        const ListObjectsOptions & flag = ListObjectsOption::ListAll,
        const size_t limit = 0, const size_t offset = 0,
        const ListNotesOrder & order = ListNotesOrder::NoOrder,
        const OrderDirection & orderDirection =
            OrderDirection::Ascending) const;
 
    QList<Note> listNotes(
        const ListObjectsOptions flag, const GetNoteOptions options,
        ErrorString & errorDescription, const size_t limit = 0,
        const size_t offset = 0,
        const ListNotesOrder order = ListNotesOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    QStringList findNoteLocalUidsWithSearchQuery(
        const NoteSearchQuery & noteSearchQuery,
        ErrorString & errorDescription) const;
 
    NoteList findNotesWithSearchQuery(
        const NoteSearchQuery & noteSearchQuery, const GetNoteOptions options,
        ErrorString & errorDescription) const;
 
    bool expungeNote(Note & note, ErrorString & errorDescription);
 
    int tagCount(ErrorString & errorDescription) const;
 
    bool addTag(Tag & tag, ErrorString & errorDescription);
 
    bool updateTag(Tag & tag, ErrorString & errorDescription);
 
    bool findTag(Tag & tag, ErrorString & errorDescription) const;
 
    enum class ListTagsOrder
    {
        ByUpdateSequenceNumber,
        ByName,
        NoOrder
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListTagsOrder order);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const ListTagsOrder order);
 
    QList<Tag> listAllTagsPerNote(
        const Note & note, ErrorString & errorDescription,
        const ListObjectsOptions & flag = ListObjectsOption::ListAll,
        const size_t limit = 0, const size_t offset = 0,
        const ListTagsOrder & order = ListTagsOrder::NoOrder,
        const OrderDirection & orderDirection =
            OrderDirection::Ascending) const;
 
    QList<Tag> listAllTags(
        ErrorString & errorDescription, const size_t limit = 0,
        const size_t offset = 0,
        const ListTagsOrder order = ListTagsOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    QList<Tag> listTags(
        const ListObjectsOptions flag, ErrorString & errorDescription,
        const size_t limit = 0, const size_t offset = 0,
        const ListTagsOrder & order = ListTagsOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    QList<std::pair<Tag, QStringList>> listTagsWithNoteLocalUids(
        const ListObjectsOptions flag, ErrorString & errorDescription,
        const size_t limit = 0, const size_t offset = 0,
        const ListTagsOrder & order = ListTagsOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending,
        const QString & linkedNotebookGuid = QString()) const;
 
    bool expungeTag(
        Tag & tag, QStringList & expungedChildTagLocalUids,
        ErrorString & errorDescription);
 
    bool expungeNotelessTagsFromLinkedNotebooks(ErrorString & errorDescription);
 
    int enResourceCount(ErrorString & errorDescription) const;
 
    bool addEnResource(Resource & resource, ErrorString & errorDescription);
 
    bool updateEnResource(Resource & resource, ErrorString & errorDescription);
 
    enum class GetResourceOption
    {
        WithBinaryData = 1
    };
    Q_DECLARE_FLAGS(GetResourceOptions, GetResourceOption)
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const GetResourceOption option);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const GetResourceOption option);
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const GetResourceOptions options);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const GetResourceOptions options);
 
    bool findEnResource(
        Resource & resource, const GetResourceOptions options,
        ErrorString & errorDescription) const;
 
    bool expungeEnResource(Resource & resource, ErrorString & errorDescription);
 
    int savedSearchCount(ErrorString & errorDescription) const;
 
    bool addSavedSearch(SavedSearch & search, ErrorString & errorDescription);
 
    bool updateSavedSearch(
        SavedSearch & search, ErrorString & errorDescription);
 
    bool findSavedSearch(
        SavedSearch & search, ErrorString & errorDescription) const;
 
    enum class ListSavedSearchesOrder
    {
        ByUpdateSequenceNumber = 0,
        ByName,
        ByFormat,
        NoOrder
    };
 
    friend QUENTIER_EXPORT QTextStream & operator<<(
        QTextStream & strm, const ListSavedSearchesOrder order);
 
    friend QUENTIER_EXPORT QDebug & operator<<(
        QDebug & strm, const ListSavedSearchesOrder order);
 
    QList<SavedSearch> listAllSavedSearches(
        ErrorString & errorDescription, const size_t limit = 0,
        const size_t offset = 0,
        const ListSavedSearchesOrder order = ListSavedSearchesOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending) const;
 
    QList<SavedSearch> listSavedSearches(
        const ListObjectsOptions flag, ErrorString & errorDescription,
        const size_t limit = 0, const size_t offset = 0,
        const ListSavedSearchesOrder order = ListSavedSearchesOrder::NoOrder,
        const OrderDirection orderDirection = OrderDirection::Ascending) const;
 
    bool expungeSavedSearch(
        SavedSearch & search, ErrorString & errorDescription);
 
    qint32 accountHighUsn(
        const QString & linkedNotebookGuid, ErrorString & errorDescription);
 
private:
    Q_DISABLE_COPY(LocalStorageManager)
 
    LocalStorageManagerPrivate * const d_ptr;
    Q_DECLARE_PRIVATE(LocalStorageManager)
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(LocalStorageManager::GetNoteOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(LocalStorageManager::ListObjectsOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(LocalStorageManager::StartupOptions)
Q_DECLARE_OPERATORS_FOR_FLAGS(LocalStorageManager::UpdateNoteOptions)
 
} // namespace quentier
 
#endif // LIB_QUENTIER_LOCAL_STORAGE_LOCAL_STORAGE_MANAGER_H