src/dialogs/EditFolderDialog.cpp

   1 /*
   2  * Copyright 2023-2024 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 // Application headers.
  21 #include "EditFolderDialog.h"
  22 #include "ui_EditFolderDialog.h"
  23 #include "databases/BookmarksDatabase.h"
  24
  25 // Qt toolkit headers.
  26 #include <QFileDialog>
  27
  28 // Construct the class.
  29 EditFolderDialog::EditFolderDialog(QWidget *parentWidgetPointer, const int databaseId, QIcon &currentWebsiteFavoriteIcon) : QDialog(parentWidgetPointer), folderDatabaseId(databaseId)
  30 {
  31     // Set the window title.
  32     setWindowTitle(i18nc("The edit folder dialog window title.", "Edit Folder"));
  33
  34     // Set the window modality.
  35     setWindowModality(Qt::WindowModality::ApplicationModal);
  36
  37     // Instantiate the edit folder dialog UI.
  38     Ui::EditFolderDialog editFolderDialogUi;
  39
  40     // Setup the UI.
  41     editFolderDialogUi.setupUi(this);
  42
  43     // Get handles for the widgets.
  44     currentFolderIconRadioButtonPointer = editFolderDialogUi.currentFolderIconRadioButton;
  45     currentWebsiteFavoriteIconRadioButtonPointer = editFolderDialogUi.currentWebsiteFavoriteIconRadioButton;
  46     customFolderIconRadioButtonPointer = editFolderDialogUi.customFolderIconRadioButton;
  47     parentFolderTreeWidgetPointer = editFolderDialogUi.parentFolderTreeWidget;
  48     folderNameLineEditPointer = editFolderDialogUi.folderNameLineEdit;
  49     QPushButton *browseButtonPointer = editFolderDialogUi.browseButton;
  50     QDialogButtonBox *dialogButtonBoxPointer = editFolderDialogUi.dialogButtonBox;
  51     saveButtonPointer = dialogButtonBoxPointer->button(QDialogButtonBox::Save);
  52
  53     // Get the folder bookmark struct.
  54     folderBookmarkStructPointer = BookmarksDatabase::getBookmark(databaseId);
  55
  56     // Set the folder icons.
  57     currentFolderIconRadioButtonPointer->setIcon(folderBookmarkStructPointer->favoriteIcon);
  58     currentWebsiteFavoriteIconRadioButtonPointer->setIcon(currentWebsiteFavoriteIcon);
  59
  60     // Instantiate a folder helper.
  61     folderHelperPointer = new FolderHelper();
  62
  63     // Set the parent folder tree widget column count.
  64     parentFolderTreeWidgetPointer->setColumnCount(2);
  65
  66     // Hide the second column.
  67     parentFolderTreeWidgetPointer->hideColumn(folderHelperPointer->FOLDER_ID_COLUMN);
  68
  69     // Set the column header.
  70     parentFolderTreeWidgetPointer->setHeaderLabel(i18nc("The folder tree widget header", "Select Parent Folder"));
  71
  72     // Create a bookmarks tree widget item.
  73     QTreeWidgetItem *bookmarksTreeWidgetItemPointer = new QTreeWidgetItem();
  74
  75     // Populate the bookmarks tree widget item.
  76     bookmarksTreeWidgetItemPointer->setText(folderHelperPointer->FOLDER_NAME_COLUMN, i18nc("The bookmarks root tree widget name", "Bookmarks"));
  77     bookmarksTreeWidgetItemPointer->setIcon(folderHelperPointer->FOLDER_NAME_COLUMN, QIcon::fromTheme(QLatin1String("bookmarks"), QIcon::fromTheme(QLatin1String("bookmark-new"))));
  78     bookmarksTreeWidgetItemPointer->setText(folderHelperPointer->FOLDER_ID_COLUMN, QLatin1String("0"));
  79
  80     // Add the bookmarks tree widget item to the root of the tree.
  81     parentFolderTreeWidgetPointer->addTopLevelItem(bookmarksTreeWidgetItemPointer);
  82
  83     // Select the root bookmarks folder if it is the initial parent folder.
  84     if (folderBookmarkStructPointer->parentFolderId == 0)
  85         bookmarksTreeWidgetItemPointer->setSelected(true);
  86
  87     // Populate the subfolders, except for the one being edited.
  88     folderHelperPointer->populateSubfoldersExcept(databaseId, bookmarksTreeWidgetItemPointer, folderBookmarkStructPointer->parentFolderId);
  89
  90     // Open all the folders.
  91     parentFolderTreeWidgetPointer->expandAll();
  92
  93     // Populate the line edits.
  94     folderNameLineEditPointer->setText(folderBookmarkStructPointer->name);
  95
  96     // Focus the folder name line edit.
  97     folderNameLineEditPointer->setFocus();
  98
  99     // Connect the buttons.
 100     connect(browseButtonPointer, SIGNAL(clicked()), this, SLOT(browse()));
 101     connect(dialogButtonBoxPointer, SIGNAL(accepted()), this, SLOT(save()));
 102     connect(dialogButtonBoxPointer, SIGNAL(rejected()), this, SLOT(reject()));
 103
 104     // Update the UI when the line edit changes.
 105     connect(folderNameLineEditPointer, SIGNAL(textEdited(const QString&)), this, SLOT(updateUi()));
 106
 107     // Set the initial UI status.
 108     updateUi();
 109 }
 110
 111 void EditFolderDialog::browse()
 112 {
 113     // Get an image file string from the user.
 114     QString imageFileString = QFileDialog::getOpenFileName(this, i18nc("The browse for folder icon dialog header", "Folder Icon Image"), QDir::homePath(),
 115                               i18nc("The browse for image files filter", "Image Files — *.bmp, *.gif, *.jpg, *.jpeg, *.png, *.svg(*.bmp *.gif *.jpg *.jpeg *.png *.svg);;All Files(*)"));
 116
 117     // Check to see if an image file string was returned.  This will be empty if the user selected cancel.
 118     if (!imageFileString.isEmpty())
 119     {
 120         // Set the custom folder icon.
 121         customFolderIconRadioButtonPointer->setIcon(QIcon(imageFileString));
 122
 123         // Check the custom folder icon radio button.
 124         customFolderIconRadioButtonPointer->setChecked(true);
 125     }
 126 }
 127
 128 void EditFolderDialog::save()
 129 {
 130     // Get the selected folders list.
 131     QList<QTreeWidgetItem*> selectedFoldersList = parentFolderTreeWidgetPointer->selectedItems();
 132
 133     // Get the selected folder.
 134     QTreeWidgetItem *selectedFolderPointer = selectedFoldersList.first();
 135
 136     // Get the parent folder ID.
 137     double parentFolderId = selectedFolderPointer->text(folderHelperPointer->FOLDER_ID_COLUMN).toDouble();
 138
 139     // Determine if it has moved to a new folder.
 140     bool movedToNewFolder =  parentFolderId != folderBookmarkStructPointer->parentFolderId;
 141
 142     // Get the original display order.
 143     int displayOrder = folderBookmarkStructPointer->displayOrder;
 144
 145     // Get the new display order if the parent folder has changed.
 146     if (movedToNewFolder)
 147         displayOrder = BookmarksDatabase::getFolderItemCount(parentFolderId);
 148
 149     // Create a favorite icon.
 150     QIcon favoriteIcon;
 151
 152     // Get the favorite icon.
 153     if (currentFolderIconRadioButtonPointer->isChecked())  // The current folder icon is checked.
 154         favoriteIcon = currentFolderIconRadioButtonPointer->icon();
 155     else if (currentWebsiteFavoriteIconRadioButtonPointer->isChecked())  // The current website favorite icon is checked.
 156         favoriteIcon = currentWebsiteFavoriteIconRadioButtonPointer->icon();
 157     else  // The custom favorite icon is checked.
 158         favoriteIcon = customFolderIconRadioButtonPointer->icon();
 159
 160     // Create a bookmark struct.
 161     BookmarkStruct *updatedBookmarkStructPointer = new BookmarkStruct;
 162
 163     // Populate the bookmark struct.
 164     updatedBookmarkStructPointer->databaseId = folderDatabaseId;
 165     updatedBookmarkStructPointer->name = folderNameLineEditPointer->text();
 166     updatedBookmarkStructPointer->parentFolderId = parentFolderId;
 167     updatedBookmarkStructPointer->displayOrder = displayOrder;
 168     updatedBookmarkStructPointer->favoriteIcon = favoriteIcon;
 169
 170     // Update the folder.
 171     BookmarksDatabase::updateBookmark(updatedBookmarkStructPointer);
 172
 173     // Update the display order of all the items in the previous folder if it has moved to a new folder.
 174     if (movedToNewFolder)
 175         BookmarksDatabase::updateFolderContentsDisplayOrder(folderBookmarkStructPointer->parentFolderId);
 176
 177     // Emit the folder saved signal.
 178     emit folderSaved();
 179
 180     // Close the dialog.
 181     close();
 182 }
 183
 184 void EditFolderDialog::updateUi()
 185 {
 186     // Set the status of the save button.
 187     saveButtonPointer->setEnabled(!folderNameLineEditPointer->text().isEmpty());
 188 }