src/databases/BookmarksDatabase.h

   1 /*
   2  * Copyright 2023 Soren Stoutner <soren@stoutner.com>.
   3  *
   4  * This file is part of Privacy Browser PC <https://www.stoutner.com/privacy-browser-pc>.
   5  *
   6  * Privacy Browser PC is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Privacy Browser PC is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Privacy Browser PC.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef BOOKMARKSDATABASE_H
  21 #define BOOKMARKSDATABASE_H
  22
  23 // Application headers.
  24 #include "structs/BookmarkStruct.h"
  25
  26 // Qt framework headers.
  27 #include <QtSql>
  28
  29 class BookmarksDatabase
  30 {
  31 public:
  32     // The default constructor.
  33     BookmarksDatabase();
  34
  35     // The public functions.
  36     static void addBookmark(const BookmarkStruct *bookmarkStructPointer);
  37     static void addDatabase();
  38     static void addFolder(const BookmarkStruct *bookmarkStructPointer);
  39     static void deleteBookmark(const int databaseId);
  40     static void deleteBookmarks(const QString url);
  41     static QList<QString>* getAllFolderUrls(const double folderId);
  42     static BookmarkStruct* getBookmark(const int databaseId);
  43     static std::list<BookmarkStruct>* getBookmarks();
  44     static QList<BookmarkStruct>* getBookmarksInFolderExcept(const double folderId, QList<int> *exceptDatabaseIdsListPointer);
  45     static QList<int>* getFolderContentsDatabaseIds(const double folderId);
  46     static QList<int>* getFolderContentsDatabaseIdsRecursively(const double folderId);
  47     static QList<BookmarkStruct>* getFolderContents(const double folderId);
  48     static int getFolderDatabaseId(const double folderId);
  49     static double getFolderId(const int databaseId);
  50     static int getFolderItemCount(const double folderId);
  51     static double getParentFolderId(const int databaseId);
  52     static QList<BookmarkStruct>* getSubfolders(const double folderId);
  53     static bool isBookmarked(const QString url);
  54     static bool isFolder(const int databaseId);
  55     static void updateBookmark(const BookmarkStruct *bookmarkStructPointer);
  56     static void updateBookmarkName(const int databaseId, const QString &bookmarkName);
  57     static void updateBookmarkUrl(const int databaseId, const QString &bookmarkUrl);
  58     static void updateDisplayOrder(const int databaseId, const int displayOrder);
  59     static void updateFolderContentsDisplayOrder(const double folderId);
  60     static void updateParentFolderAndDisplayOrder(const int databaseId, const double parentFolderId, const int displayOrder);
  61
  62     // The public constants.
  63     static const QString CONNECTION_NAME;
  64     static const QString BOOKMARK_NAME;
  65     static const QString BOOKMARKS_TABLE;
  66     static const QString BOOKMARK_URL;
  67     static const QString DISPLAY_ORDER;
  68     static const QString FAVORITE_ICON;
  69     static const QString FOLDER_ID;
  70     static const QString ID;
  71     static const QString IS_FOLDER;
  72     static const QString PARENT_FOLDER_ID;
  73
  74 private:
  75     // The private static constants.
  76     static const int SCHEMA_VERSION;
  77
  78     // The private functions.
  79     static double generateFolderId();
  80     static QString getFavoriteIconBase64String(const QIcon &favoriteIcon);
  81 };
  82 #endif