Implement Advanced Saving Management subsystem

Closes #4696
2025-08-13 18:17:08 -07:00 · 2016-02-09 11:56:48 +03:00 · 2016-02-09 11:56:48 +03:00 · dd34663224
commit dd34663224
parent d05d5a85a5
59 changed files with 1796 additions and 1280 deletions
--- a/src/gui/addnewtorrentdialog.cpp
+++ b/src/gui/addnewtorrentdialog.cpp
@ -35,7 +35,7 @@
 #include <QMenu>
 #include <QFileDialog>

-#include "base/preferences.h"
+#include "base/settingsstorage.h"
 #include "base/net/downloadmanager.h"
 #include "base/net/downloadhandler.h"
 #include "base/bittorrent/session.h"
@ -44,16 +44,34 @@
 #include "base/bittorrent/torrenthandle.h"
 #include "base/utils/fs.h"
 #include "base/utils/misc.h"
+#include "base/utils/string.h"
 #include "base/unicodestrings.h"
 #include "guiiconprovider.h"
 #include "autoexpandabledialog.h"
 #include "messageboxraised.h"
-#include "ui_addnewtorrentdialog.h"
 #include "proplistdelegate.h"
 #include "torrentcontentmodel.h"
 #include "torrentcontentfiltermodel.h"
+#include "ui_addnewtorrentdialog.h"
 #include "addnewtorrentdialog.h"

+#define SETTINGS_KEY(name) "AddNewTorrentDialog/" name
+const QString KEY_ENABLED = SETTINGS_KEY("Enabled");
+const QString KEY_DEFAULTSAVEPATH = SETTINGS_KEY("DefaultSavePath");
+const QString KEY_DEFAULTCATEGORY = SETTINGS_KEY("DefaultCategory");
+const QString KEY_TREEHEADERSTATE = SETTINGS_KEY("TreeHeaderState");
+const QString KEY_WIDTH = SETTINGS_KEY("Width");
+const QString KEY_EXPANDED = SETTINGS_KEY("Expanded");
+const QString KEY_POSITION = SETTINGS_KEY("Position");
+const QString KEY_TOPLEVEL = SETTINGS_KEY("TopLevel");
+const QString KEY_SAVEPATHHISTORY = SETTINGS_KEY("SavePathHistory");
+
+namespace
+{
+    //just a shortcut
+    inline SettingsStorage *settings() { return  SettingsStorage::instance(); }
+}
+
 AddNewTorrentDialog::AddNewTorrentDialog(QWidget *parent)
    : QDialog(parent)
    , ui(new Ui::AddNewTorrentDialog)
@ -67,34 +85,36 @@ AddNewTorrentDialog::AddNewTorrentDialog(QWidget *parent)
    ui->lblMetaLoading->setVisible(false);
    ui->progMetaLoading->setVisible(false);

-    Preferences* const pref = Preferences::instance();
-    ui->start_torrent_cb->setChecked(!pref->addTorrentsInPause());
-    ui->savePathComboBox->addItem(Utils::Fs::toNativePath(pref->getSavePath()), pref->getSavePath());
-    loadSavePathHistory();
+    auto session = BitTorrent::Session::instance();
+
+    ui->startTorrentCheckBox->setChecked(!session->isAddTorrentPaused());
+    (session->isASMDisabledByDefault() ? ui->simpleModeRadioButton : ui->advancedModeRadioButton)->setChecked(true);
+    populateSavePathComboBox();
    connect(ui->savePathComboBox, SIGNAL(currentIndexChanged(int)), SLOT(onSavePathChanged(int)));
-    connect(ui->browse_button, SIGNAL(clicked()), SLOT(browseButton_clicked()));
-    ui->default_save_path_cb->setVisible(false); // Default path is selected by default
+    connect(ui->browseButton, SIGNAL(clicked()), SLOT(browseButton_clicked()));
+    ui->defaultSavePathCheckBox->setVisible(false); // Default path is selected by default

-    // Load labels
-    const QStringList customLabels = pref->getTorrentLabels();
-    const QString defaultLabel = pref->getDefaultLabel();
+    // Load categories
+    QStringList categories = session->categories();
+    std::sort(categories.begin(), categories.end(), Utils::String::NaturalCompare());
+    QString defaultCategory = settings()->loadValue(KEY_DEFAULTCATEGORY).toString();

-    if (!defaultLabel.isEmpty())
-        ui->label_combo->addItem(defaultLabel);
-    ui->label_combo->addItem("");
+    if (!defaultCategory.isEmpty())
+        ui->categoryComboBox->addItem(defaultCategory);
+    ui->categoryComboBox->addItem("");

-    foreach (const QString& label, customLabels)
-        if (label != defaultLabel)
-            ui->label_combo->addItem(label);
+    foreach (const QString &category, categories)
+        if (category != defaultCategory)
+            ui->categoryComboBox->addItem(category);

-    ui->label_combo->model()->sort(0);
-    ui->content_tree->header()->setSortIndicator(0, Qt::AscendingOrder);
+    ui->categoryComboBox->model()->sort(0);
+    ui->contentTreeView->header()->setSortIndicator(0, Qt::AscendingOrder);
    loadState();
    // Signal / slots
    connect(ui->adv_button, SIGNAL(clicked(bool)), SLOT(showAdvancedSettings(bool)));
-    editHotkey = new QShortcut(QKeySequence("F2"), ui->content_tree, 0, 0, Qt::WidgetShortcut);
+    editHotkey = new QShortcut(QKeySequence("F2"), ui->contentTreeView, 0, 0, Qt::WidgetShortcut);
    connect(editHotkey, SIGNAL(activated()), SLOT(renameSelectedFile()));
-    connect(ui->content_tree, SIGNAL(doubleClicked(QModelIndex)), SLOT(renameSelectedFile()));
+    connect(ui->contentTreeView, SIGNAL(doubleClicked(QModelIndex)), SLOT(renameSelectedFile()));

    ui->buttonBox->button(QDialogButtonBox::Ok)->setFocus();
 }
@ -108,27 +128,45 @@ AddNewTorrentDialog::~AddNewTorrentDialog()
    delete editHotkey;
 }

+bool AddNewTorrentDialog::isEnabled()
+{
+    return SettingsStorage::instance()->loadValue(KEY_ENABLED, true).toBool();
+}
+
+void AddNewTorrentDialog::setEnabled(bool value)
+{
+    SettingsStorage::instance()->storeValue(KEY_ENABLED, value);
+}
+
+bool AddNewTorrentDialog::isTopLevel()
+{
+    return SettingsStorage::instance()->loadValue(KEY_TOPLEVEL, true).toBool();
+}
+
+void AddNewTorrentDialog::setTopLevel(bool value)
+{
+    SettingsStorage::instance()->storeValue(KEY_TOPLEVEL, value);
+}
+
 void AddNewTorrentDialog::loadState()
 {
-    const Preferences* const pref = Preferences::instance();
-    m_headerState = pref->getAddNewTorrentDialogState();
-    int width = pref->getAddNewTorrentDialogWidth();
+    m_headerState = settings()->loadValue(KEY_TREEHEADERSTATE).toByteArray();
+    int width = settings()->loadValue(KEY_WIDTH, -1).toInt();
    if (width >= 0) {
        QRect geo = geometry();
        geo.setWidth(width);
        setGeometry(geo);
    }
-    ui->adv_button->setChecked(pref->getAddNewTorrentDialogExpanded());
+    ui->adv_button->setChecked(settings()->loadValue(KEY_EXPANDED).toBool());
 }

 void AddNewTorrentDialog::saveState()
 {
-    Preferences* const pref = Preferences::instance();
    if (m_contentModel)
-        pref->setAddNewTorrentDialogState(ui->content_tree->header()->saveState());
-    pref->setAddNewTorrentDialogPos(pos().y());
-    pref->setAddNewTorrentDialogWidth(width());
-    pref->setAddNewTorrentDialogExpanded(ui->adv_button->isChecked());
+        settings()->storeValue(KEY_TREEHEADERSTATE, ui->contentTreeView->header()->saveState());
+    settings()->storeValue(KEY_POSITION, pos().y());
+    settings()->storeValue(KEY_WIDTH, width());
+    settings()->storeValue(KEY_EXPANDED, ui->adv_button->isChecked());
 }

 void AddNewTorrentDialog::show(QString source, QWidget *parent)
@ -256,9 +294,8 @@ bool AddNewTorrentDialog::loadMagnet(const BitTorrent::MagnetUri &magnetUri)
 void AddNewTorrentDialog::showEvent(QShowEvent *event)
 {
    QDialog::showEvent(event);
-    Preferences* const pref = Preferences::instance();
-    if (!pref->additionDialogFront())
-        return;
+    if (!isTopLevel()) return;
+
    activateWindow();
    raise();
 }
@ -272,7 +309,7 @@ void AddNewTorrentDialog::showAdvancedSettings(bool show)
        ui->adv_button->setText(QString::fromUtf8(C_UP));
        ui->settings_group->setVisible(true);
        ui->infoGroup->setVisible(true);
-        ui->content_tree->setVisible(m_hasMetadata);
+        ui->contentTreeView->setVisible(m_hasMetadata);
        static_cast<QVBoxLayout*>(layout())->insertWidget(layout()->indexOf(ui->never_show_cb) + 1, ui->adv_button);
    }
    else {
@ -287,21 +324,20 @@ void AddNewTorrentDialog::showAdvancedSettings(bool show)

 void AddNewTorrentDialog::saveSavePathHistory() const
 {
-    QDir selected_save_path(ui->savePathComboBox->itemData(ui->savePathComboBox->currentIndex()).toString());
-    Preferences* const pref = Preferences::instance();
+    QDir selectedSavePath(ui->savePathComboBox->itemData(ui->savePathComboBox->currentIndex()).toString());
    // Get current history
-    QStringList history = pref->getAddNewTorrentDialogPathHistory();
-    QList<QDir> history_dirs;
+    QStringList history = settings()->loadValue(KEY_SAVEPATHHISTORY).toStringList();
+    QList<QDir> historyDirs;
    foreach(const QString dir, history)
-        history_dirs << QDir(dir);
-    if (!history_dirs.contains(selected_save_path)) {
+        historyDirs << QDir(dir);
+    if (!historyDirs.contains(selectedSavePath)) {
        // Add save path to history
-        history.push_front(selected_save_path.absolutePath());
+        history.push_front(selectedSavePath.absolutePath());
        // Limit list size
        if (history.size() > 8)
            history.pop_back();
        // Save history
-        pref->setAddNewTorrentDialogPathHistory(history);
+        settings()->storeValue(KEY_SAVEPATHHISTORY, history);
    }
 }

@ -345,8 +381,10 @@ void AddNewTorrentDialog::updateDiskSpaceLabel()
 void AddNewTorrentDialog::onSavePathChanged(int index)
 {
    // Toggle default save path setting checkbox visibility
-    ui->default_save_path_cb->setChecked(false);
-    ui->default_save_path_cb->setVisible(QDir(ui->savePathComboBox->itemData(ui->savePathComboBox->currentIndex()).toString()) != QDir(Preferences::instance()->getSavePath()));
+    ui->defaultSavePathCheckBox->setChecked(false);
+    ui->defaultSavePathCheckBox->setVisible(
+                QDir(ui->savePathComboBox->itemData(ui->savePathComboBox->currentIndex()).toString())
+                != QDir(defaultSavePath()));

    // Remember index
    m_oldIndex = index;
@ -354,6 +392,17 @@ void AddNewTorrentDialog::onSavePathChanged(int index)
    updateDiskSpaceLabel();
 }

+void AddNewTorrentDialog::categoryChanged(int index)
+{
+    Q_UNUSED(index);
+
+    if (ui->advancedModeRadioButton->isChecked()) {
+        QString savePath = BitTorrent::Session::instance()->categorySavePath(ui->categoryComboBox->currentText());
+        ui->savePathComboBox->setItemText(0, Utils::Fs::toNativePath(savePath));
+        ui->savePathComboBox->setItemData(0, savePath);
+    }
+}
+
 void AddNewTorrentDialog::browseButton_clicked()
 {
    disconnect(ui->savePathComboBox, SIGNAL(currentIndexChanged(int)), this, SLOT(onSavePathChanged(int)));
@ -390,7 +439,7 @@ void AddNewTorrentDialog::browseButton_clicked()

 void AddNewTorrentDialog::renameSelectedFile()
 {
-    const QModelIndexList selectedIndexes = ui->content_tree->selectionModel()->selectedRows(0);
+    const QModelIndexList selectedIndexes = ui->contentTreeView->selectionModel()->selectedRows(0);
    if (selectedIndexes.size() != 1)
        return;
    const QModelIndex &index = selectedIndexes.first();
@ -490,7 +539,7 @@ void AddNewTorrentDialog::setdialogPosition()
    qApp->processEvents();
    QPoint center(Utils::Misc::screenCenter(this));
    // Adjust y
-    int y = Preferences::instance()->getAddNewTorrentDialogPos();
+    int y = settings()->loadValue(KEY_POSITION, -1).toInt();
    if (y >= 0) {
        center.setY(y);
    }
@ -502,20 +551,23 @@ void AddNewTorrentDialog::setdialogPosition()
    move(center);
 }

-void AddNewTorrentDialog::loadSavePathHistory()
+void AddNewTorrentDialog::populateSavePathComboBox()
 {
-    QDir default_save_path(Preferences::instance()->getSavePath());
+    QString defSavePath = defaultSavePath();
+
+    ui->savePathComboBox->clear();
+    ui->savePathComboBox->addItem(Utils::Fs::toNativePath(defSavePath), defSavePath);
+    QDir defaultSaveDir(defSavePath);
    // Load save path history
-    QStringList raw_path_history = Preferences::instance()->getAddNewTorrentDialogPathHistory();
-    foreach (const QString &sp, raw_path_history)
-        if (QDir(sp) != default_save_path)
-            ui->savePathComboBox->addItem(Utils::Fs::toNativePath(sp), sp);
+    foreach (const QString &savePath, settings()->loadValue(KEY_SAVEPATHHISTORY).toStringList())
+        if (QDir(savePath) != defaultSaveDir)
+            ui->savePathComboBox->addItem(Utils::Fs::toNativePath(savePath), savePath);
 }

 void AddNewTorrentDialog::displayContentTreeMenu(const QPoint&)
 {
    QMenu myFilesLlistMenu;
-    const QModelIndexList selectedRows = ui->content_tree->selectionModel()->selectedRows(0);
+    const QModelIndexList selectedRows = ui->contentTreeView->selectionModel()->selectedRows(0);
    QAction *actRename = 0;
    if (selectedRows.size() == 1) {
        actRename = myFilesLlistMenu.addAction(GuiIconProvider::instance()->getIcon("edit-rename"), tr("Rename..."));
@ -557,39 +609,34 @@ void AddNewTorrentDialog::accept()
    if (!m_hasMetadata)
        disconnect(this, SLOT(updateMetadata(const BitTorrent::TorrentInfo &)));

-    Preferences *const pref = Preferences::instance();
    BitTorrent::AddTorrentParams params;

    if (ui->skip_check_cb->isChecked())
        // TODO: Check if destination actually exists
        params.skipChecking = true;

-    // Label
-    params.label = ui->label_combo->currentText();
+    // Category
+    params.category = ui->categoryComboBox->currentText();

-    if (ui->defaultLabel->isChecked())
-        pref->setDefaultLabel(params.label);
+    if (ui->defaultCategoryCheckbox->isChecked())
+        settings()->storeValue(KEY_DEFAULTCATEGORY, params.category);

    // Save file priorities
    if (m_contentModel)
        params.filePriorities = m_contentModel->model()->getFilePriorities();

-    params.addPaused = !ui->start_torrent_cb->isChecked();
-
-    saveSavePathHistory();
-    pref->useAdditionDialog(!ui->never_show_cb->isChecked());
+    params.addPaused = !ui->startTorrentCheckBox->isChecked();

    QString savePath = ui->savePathComboBox->itemData(ui->savePathComboBox->currentIndex()).toString();
-    if (ui->default_save_path_cb->isChecked()) {
-        pref->setSavePath(savePath);
-        pref->apply();
-    }
-    else {
-        // if we don't use default save path...
-        if (QDir(savePath) != QDir(pref->getSavePath()))
-            params.savePath = savePath;
+    if (ui->simpleModeRadioButton->isChecked()) {
+        params.savePath = savePath;
+        saveSavePathHistory();
+        if (ui->defaultSavePathCheckBox->isChecked())
+            settings()->storeValue(KEY_DEFAULTSAVEPATH, savePath);
    }

+    setEnabled(!ui->never_show_cb->isChecked());
+
    // Add torrent
    if (!m_hasMetadata)
        BitTorrent::Session::instance()->addTorrent(m_hash, params);
@ -656,28 +703,35 @@ void AddNewTorrentDialog::setupTreeview()
        // Prepare content tree
        m_contentModel = new TorrentContentFilterModel(this);
        connect(m_contentModel->model(), SIGNAL(filteredFilesChanged()), SLOT(updateDiskSpaceLabel()));
-        ui->content_tree->setModel(m_contentModel);
-        ui->content_tree->hideColumn(PROGRESS);
+        ui->contentTreeView->setModel(m_contentModel);
+        ui->contentTreeView->hideColumn(PROGRESS);
        m_contentDelegate = new PropListDelegate();
-        ui->content_tree->setItemDelegate(m_contentDelegate);
-        connect(ui->content_tree, SIGNAL(clicked(const QModelIndex &)), ui->content_tree, SLOT(edit(const QModelIndex &)));
-        connect(ui->content_tree, SIGNAL(customContextMenuRequested(const QPoint &)), this, SLOT(displayContentTreeMenu(const QPoint &)));
+        ui->contentTreeView->setItemDelegate(m_contentDelegate);
+        connect(ui->contentTreeView, SIGNAL(clicked(const QModelIndex &)), ui->contentTreeView, SLOT(edit(const QModelIndex &)));
+        connect(ui->contentTreeView, SIGNAL(customContextMenuRequested(const QPoint &)), this, SLOT(displayContentTreeMenu(const QPoint &)));

        // List files in torrent
        m_contentModel->model()->setupModelData(m_torrentInfo);
        if (!m_headerState.isEmpty())
-            ui->content_tree->header()->restoreState(m_headerState);
+            ui->contentTreeView->header()->restoreState(m_headerState);

        // Expand root folder
-        ui->content_tree->setExpanded(m_contentModel->index(0, 0), true);
+        ui->contentTreeView->setExpanded(m_contentModel->index(0, 0), true);
    }

    updateDiskSpaceLabel();
-    showAdvancedSettings(Preferences::instance()->getAddNewTorrentDialogExpanded());
+    showAdvancedSettings(settings()->loadValue(KEY_EXPANDED, false).toBool());
    // Set dialog position
    setdialogPosition();
 }

+QString AddNewTorrentDialog::defaultSavePath() const
+{
+    return Utils::Fs::fromNativePath(
+                settings()->loadValue(KEY_DEFAULTSAVEPATH,
+                                      BitTorrent::Session::instance()->defaultSavePath()).toString());
+}
+
 void AddNewTorrentDialog::handleDownloadFailed(const QString &url, const QString &reason)
 {
    MessageBoxRaised::critical(0, tr("Download Error"), QString("Cannot download '%1': %2").arg(url).arg(reason));
@ -701,3 +755,25 @@ void AddNewTorrentDialog::handleDownloadFinished(const QString &url, const QStri
    else
        this->deleteLater();
 }
+
+void AddNewTorrentDialog::savingModeChanged(bool enabled)
+{
+    if (!enabled) return;
+
+    if (ui->simpleModeRadioButton->isChecked()) {
+        populateSavePathComboBox();
+        ui->savePathComboBox->setEnabled(true);
+        ui->browseButton->setEnabled(true);
+        ui->savePathComboBox->blockSignals(false);
+        ui->savePathComboBox->setCurrentIndex(m_oldIndex < ui->savePathComboBox->count() ? m_oldIndex : ui->savePathComboBox->count() - 1);
+    }
+    else {
+        ui->savePathComboBox->blockSignals(true);
+        ui->savePathComboBox->clear();
+        QString savePath = BitTorrent::Session::instance()->categorySavePath(ui->categoryComboBox->currentText());
+        ui->savePathComboBox->addItem(Utils::Fs::toNativePath(savePath), savePath);
+        ui->savePathComboBox->setEnabled(false);
+        ui->browseButton->setEnabled(false);
+        ui->defaultSavePathCheckBox->setVisible(false);
+    }
+}