src/gui/addtorrentparamswidget.cpp

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2023  Vladimir Golovnev <glassez@yandex.ru>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  * In addition, as a special exception, the copyright holders give permission to
  20  * link this program with the OpenSSL project's "OpenSSL" library (or with
  21  * modified versions of it that use the same license as the "OpenSSL" library),
  22  * and distribute the linked executables. You must obey the GNU General Public
  23  * License in all respects for all of the code used other than "OpenSSL".  If you
  24  * modify file(s), you may extend this exception to your version of the file(s),
  25  * but you are not obligated to do so. If you do not wish to do so, delete this
  26  * exception statement from your version.
  27  */
  28
  29 #include "addtorrentparamswidget.h"
  30
  31 #include <QVariant>
  32
  33 #include "base/bittorrent/session.h"
  34 #include "base/bittorrent/torrent.h"
  35 #include "base/utils/compare.h"
  36 #include "base/utils/string.h"
  37 #include "flowlayout.h"
  38 #include "fspathedit.h"
  39 #include "torrenttagsdialog.h"
  40 #include "ui_addtorrentparamswidget.h"
  41
  42 namespace
  43 {
  44     std::optional<bool> toOptionalBool(const QVariant &data)
  45     {
  46         if (!data.isValid())
  47             return std::nullopt;
  48
  49         Q_ASSERT(data.userType() == QMetaType::Bool);
  50         return data.toBool();
  51     }
  52
  53     BitTorrent::AddTorrentParams cleanParams(BitTorrent::AddTorrentParams params)
  54     {
  55         if (!params.useAutoTMM.has_value() || params.useAutoTMM.value())
  56         {
  57             params.savePath = Path();
  58             params.downloadPath = Path();
  59             params.useDownloadPath = std::nullopt;
  60         }
  61
  62         if (!params.useDownloadPath.has_value() || !params.useDownloadPath.value())
  63         {
  64             params.downloadPath = Path();
  65         }
  66
  67         return params;
  68     }
  69 }
  70
  71 AddTorrentParamsWidget::AddTorrentParamsWidget(BitTorrent::AddTorrentParams addTorrentParams, QWidget *parent)
  72     : QWidget(parent)
  73     , m_ui {new Ui::AddTorrentParamsWidget}
  74 {
  75     m_ui->setupUi(this);
  76
  77     m_ui->savePathEdit->setMode(FileSystemPathEdit::Mode::DirectorySave);
  78     m_ui->savePathEdit->setDialogCaption(tr("Choose save path"));
  79
  80     m_ui->downloadPathEdit->setMode(FileSystemPathEdit::Mode::DirectorySave);
  81     m_ui->downloadPathEdit->setDialogCaption(tr("Choose save path"));
  82
  83     m_ui->useDownloadPathComboBox->addItem(tr("Default"));
  84     m_ui->useDownloadPathComboBox->addItem(tr("Yes"), true);
  85     m_ui->useDownloadPathComboBox->addItem(tr("No"), false);
  86
  87     m_ui->comboTTM->addItem(tr("Default"));
  88     m_ui->comboTTM->addItem(tr("Manual"), false);
  89     m_ui->comboTTM->addItem(tr("Automatic"), true);
  90
  91     m_ui->contentLayoutComboBox->addItem(tr("Default"));
  92     m_ui->contentLayoutComboBox->addItem(tr("Original"), QVariant::fromValue(BitTorrent::TorrentContentLayout::Original));
  93     m_ui->contentLayoutComboBox->addItem(tr("Create subfolder"), QVariant::fromValue(BitTorrent::TorrentContentLayout::Subfolder));
  94     m_ui->contentLayoutComboBox->addItem(tr("Don't create subfolder"), QVariant::fromValue(BitTorrent::TorrentContentLayout::NoSubfolder));
  95
  96     m_ui->stopConditionComboBox->addItem(tr("Default"));
  97     m_ui->stopConditionComboBox->addItem(tr("None"), QVariant::fromValue(BitTorrent::Torrent::StopCondition::None));
  98     m_ui->stopConditionComboBox->addItem(tr("Metadata received"), QVariant::fromValue(BitTorrent::Torrent::StopCondition::MetadataReceived));
  99     m_ui->stopConditionComboBox->addItem(tr("Files checked"), QVariant::fromValue(BitTorrent::Torrent::StopCondition::FilesChecked));
 100
 101     m_ui->startTorrentComboBox->addItem(tr("Default"));
 102     m_ui->startTorrentComboBox->addItem(tr("Yes"), true);
 103     m_ui->startTorrentComboBox->addItem(tr("No"), false);
 104
 105     m_ui->addToQueueTopComboBox->addItem(tr("Default"));
 106     m_ui->addToQueueTopComboBox->addItem(tr("Yes"), true);
 107     m_ui->addToQueueTopComboBox->addItem(tr("No"), false);
 108
 109     connect(m_ui->tagsEditButton, &QAbstractButton::clicked, this, [this]
 110     {
 111         auto *dlg = new TorrentTagsDialog(m_addTorrentParams.tags, this);
 112         dlg->setAttribute(Qt::WA_DeleteOnClose);
 113         connect(dlg, &TorrentTagsDialog::accepted, this, [this, dlg]
 114         {
 115             m_addTorrentParams.tags = dlg->tags();
 116             m_ui->tagsLineEdit->setText(Utils::String::joinIntoString(m_addTorrentParams.tags, u", "_s));
 117         });
 118         dlg->open();
 119     });
 120
 121     auto *miscParamsLayout = new FlowLayout(m_ui->miscParamsWidget);
 122     miscParamsLayout->setContentsMargins(0, 0, 0, 0);
 123     miscParamsLayout->addWidget(m_ui->contentLayoutWidget);
 124     miscParamsLayout->addWidget(m_ui->skipCheckingCheckBox);
 125     miscParamsLayout->setAlignment(m_ui->skipCheckingCheckBox, Qt::AlignVCenter);
 126     miscParamsLayout->addWidget(m_ui->startTorrentWidget);
 127     miscParamsLayout->addWidget(m_ui->stopConditionWidget);
 128     miscParamsLayout->addWidget(m_ui->addToQueueTopWidget);
 129
 130     setAddTorrentParams(std::move(addTorrentParams));
 131 }
 132
 133 AddTorrentParamsWidget::~AddTorrentParamsWidget()
 134 {
 135     delete m_ui;
 136 }
 137
 138 void AddTorrentParamsWidget::setAddTorrentParams(BitTorrent::AddTorrentParams addTorrentParams)
 139 {
 140     m_addTorrentParams = std::move(addTorrentParams);
 141     populate();
 142 }
 143
 144 BitTorrent::AddTorrentParams AddTorrentParamsWidget::addTorrentParams() const
 145 {
 146     BitTorrent::AddTorrentParams addTorrentParams = cleanParams(m_addTorrentParams);
 147     addTorrentParams.ratioLimit = m_ui->torrentShareLimitsWidget->ratioLimit().value();
 148     addTorrentParams.seedingTimeLimit = m_ui->torrentShareLimitsWidget->seedingTimeLimit().value();
 149     addTorrentParams.inactiveSeedingTimeLimit = m_ui->torrentShareLimitsWidget->inactiveSeedingTimeLimit().value();
 150     addTorrentParams.shareLimitAction = m_ui->torrentShareLimitsWidget->shareLimitAction().value();
 151
 152     return addTorrentParams;
 153 }
 154
 155 void AddTorrentParamsWidget::populate()
 156 {
 157     m_ui->comboTTM->disconnect(this);
 158     m_ui->comboTTM->setCurrentIndex(m_addTorrentParams.useAutoTMM
 159             ? m_ui->comboTTM->findData(*m_addTorrentParams.useAutoTMM) : 0);
 160     connect(m_ui->comboTTM, &QComboBox::currentIndexChanged, this, [this]
 161     {
 162         m_addTorrentParams.useAutoTMM = toOptionalBool(m_ui->comboTTM->currentData());
 163
 164         populateSavePathOptions();
 165     });
 166
 167     m_ui->categoryComboBox->disconnect(this);
 168     m_ui->categoryComboBox->clear();
 169     QStringList categories = BitTorrent::Session::instance()->categories();
 170     std::sort(categories.begin(), categories.end(), Utils::Compare::NaturalLessThan<Qt::CaseInsensitive>());
 171     if (!m_addTorrentParams.category.isEmpty())
 172         m_ui->categoryComboBox->addItem(m_addTorrentParams.category);
 173     m_ui->categoryComboBox->addItem(u""_s);
 174     for (const QString &category : asConst(categories))
 175     {
 176         if (category != m_addTorrentParams.category)
 177             m_ui->categoryComboBox->addItem(category);
 178     }
 179     connect(m_ui->categoryComboBox, &QComboBox::currentIndexChanged, this, [this]
 180     {
 181         m_addTorrentParams.category = m_ui->categoryComboBox->currentText();
 182
 183         const auto *btSession = BitTorrent::Session::instance();
 184         const bool useAutoTMM = m_addTorrentParams.useAutoTMM.value_or(!btSession->isAutoTMMDisabledByDefault());
 185         if (useAutoTMM)
 186         {
 187             const auto downloadPathOption = btSession->categoryOptions(m_addTorrentParams.category).downloadPath;
 188             m_ui->useDownloadPathComboBox->setCurrentIndex(downloadPathOption.has_value()
 189                     ? m_ui->useDownloadPathComboBox->findData(downloadPathOption->enabled) : 0);
 190         }
 191
 192         populateDefaultPaths();
 193     });
 194
 195     m_ui->savePathEdit->disconnect(this);
 196     m_ui->downloadPathEdit->disconnect(this);
 197     m_ui->useDownloadPathComboBox->disconnect(this);
 198
 199     populateSavePathOptions();
 200
 201     connect(m_ui->savePathEdit, &FileSystemPathLineEdit::selectedPathChanged, this, [this]
 202     {
 203         m_addTorrentParams.savePath = m_ui->savePathEdit->selectedPath();
 204     });
 205     connect(m_ui->downloadPathEdit, &FileSystemPathLineEdit::selectedPathChanged, this, [this]
 206     {
 207         m_addTorrentParams.downloadPath = m_ui->downloadPathEdit->selectedPath();
 208     });
 209     connect(m_ui->useDownloadPathComboBox, &QComboBox::currentIndexChanged, this, [this]
 210     {
 211         m_addTorrentParams.useDownloadPath = toOptionalBool(m_ui->useDownloadPathComboBox->currentData());
 212
 213         loadCustomDownloadPath();
 214     });
 215
 216     m_ui->contentLayoutComboBox->disconnect(this);
 217     m_ui->contentLayoutComboBox->setCurrentIndex(m_addTorrentParams.contentLayout
 218             ? m_ui->contentLayoutComboBox->findData(QVariant::fromValue(*m_addTorrentParams.contentLayout)) : 0);
 219     connect(m_ui->contentLayoutComboBox, &QComboBox::currentIndexChanged, this, [this]
 220     {
 221         const QVariant data = m_ui->contentLayoutComboBox->currentData();
 222         if (!data.isValid())
 223             m_addTorrentParams.contentLayout = std::nullopt;
 224         else
 225             m_addTorrentParams.contentLayout = data.value<BitTorrent::TorrentContentLayout>();
 226     });
 227
 228     m_ui->stopConditionComboBox->disconnect(this);
 229     m_ui->stopConditionComboBox->setCurrentIndex(m_addTorrentParams.stopCondition
 230             ? m_ui->stopConditionComboBox->findData(QVariant::fromValue(*m_addTorrentParams.stopCondition)) : 0);
 231     connect(m_ui->stopConditionComboBox, &QComboBox::currentIndexChanged, this, [this]
 232     {
 233         const QVariant data = m_ui->stopConditionComboBox->currentData();
 234         if (!data.isValid())
 235             m_addTorrentParams.stopCondition = std::nullopt;
 236         else
 237             m_addTorrentParams.stopCondition = data.value<BitTorrent::Torrent::StopCondition>();
 238     });
 239
 240     m_ui->tagsLineEdit->setText(Utils::String::joinIntoString(m_addTorrentParams.tags, u", "_s));
 241
 242     m_ui->startTorrentComboBox->disconnect(this);
 243     m_ui->startTorrentComboBox->setCurrentIndex(m_addTorrentParams.addStopped
 244                                                     ? m_ui->startTorrentComboBox->findData(!*m_addTorrentParams.addStopped) : 0);
 245     connect(m_ui->startTorrentComboBox, &QComboBox::currentIndexChanged, this, [this]
 246     {
 247         const QVariant data = m_ui->startTorrentComboBox->currentData();
 248         if (!data.isValid())
 249             m_addTorrentParams.addStopped = std::nullopt;
 250         else
 251             m_addTorrentParams.addStopped = !data.toBool();
 252     });
 253
 254     m_ui->skipCheckingCheckBox->disconnect(this);
 255     m_ui->skipCheckingCheckBox->setChecked(m_addTorrentParams.skipChecking);
 256     connect(m_ui->skipCheckingCheckBox, &QCheckBox::toggled, this, [this]
 257     {
 258         m_addTorrentParams.skipChecking = m_ui->skipCheckingCheckBox->isChecked();
 259     });
 260
 261     m_ui->addToQueueTopComboBox->disconnect(this);
 262     m_ui->addToQueueTopComboBox->setCurrentIndex(m_addTorrentParams.addToQueueTop
 263             ? m_ui->addToQueueTopComboBox->findData(*m_addTorrentParams.addToQueueTop) : 0);
 264     connect(m_ui->addToQueueTopComboBox, &QComboBox::currentIndexChanged, this, [this]
 265     {
 266         const QVariant data = m_ui->addToQueueTopComboBox->currentData();
 267         if (!data.isValid())
 268             m_addTorrentParams.addToQueueTop = std::nullopt;
 269         else
 270             m_addTorrentParams.addToQueueTop = data.toBool();
 271     });
 272
 273     m_ui->torrentShareLimitsWidget->setRatioLimit(m_addTorrentParams.ratioLimit);
 274     m_ui->torrentShareLimitsWidget->setSeedingTimeLimit(m_addTorrentParams.seedingTimeLimit);
 275     m_ui->torrentShareLimitsWidget->setInactiveSeedingTimeLimit(m_addTorrentParams.inactiveSeedingTimeLimit);
 276     m_ui->torrentShareLimitsWidget->setShareLimitAction(m_addTorrentParams.shareLimitAction);
 277 }
 278
 279 void AddTorrentParamsWidget::loadCustomSavePathOptions()
 280 {
 281     [[maybe_unused]] const auto *btSession = BitTorrent::Session::instance();
 282     Q_ASSERT(!m_addTorrentParams.useAutoTMM.value_or(!btSession->isAutoTMMDisabledByDefault()));
 283
 284     m_ui->savePathEdit->setSelectedPath(m_addTorrentParams.savePath);
 285
 286     m_ui->useDownloadPathComboBox->setCurrentIndex(m_addTorrentParams.useDownloadPath
 287             ? m_ui->useDownloadPathComboBox->findData(*m_addTorrentParams.useDownloadPath) : 0);
 288
 289     loadCustomDownloadPath();
 290 }
 291
 292 void AddTorrentParamsWidget::loadCustomDownloadPath()
 293 {
 294     populateDefaultDownloadPath();
 295
 296     if (!m_addTorrentParams.useDownloadPath.has_value())
 297     {
 298         // Default "Download path" settings
 299
 300         m_ui->downloadPathEdit->setEnabled(false);
 301         m_ui->downloadPathEdit->blockSignals(true);
 302         m_ui->downloadPathEdit->setSelectedPath(Path());
 303     }
 304     else
 305     {
 306         // Overridden "Download path" settings
 307
 308         const bool useDownloadPath = m_addTorrentParams.useDownloadPath.value();
 309         if (useDownloadPath)
 310         {
 311             m_ui->downloadPathEdit->setSelectedPath(m_addTorrentParams.downloadPath);
 312
 313             m_ui->downloadPathEdit->blockSignals(false);
 314             m_ui->downloadPathEdit->setEnabled(true);
 315         }
 316         else
 317         {
 318             m_ui->downloadPathEdit->setEnabled(false);
 319             m_ui->downloadPathEdit->blockSignals(true);
 320
 321             m_ui->downloadPathEdit->setSelectedPath(Path());
 322         }
 323     }
 324 }
 325
 326 void AddTorrentParamsWidget::loadCategorySavePathOptions()
 327 {
 328     const auto *btSession = BitTorrent::Session::instance();
 329     Q_ASSERT(m_addTorrentParams.useAutoTMM.value_or(!btSession->isAutoTMMDisabledByDefault()));
 330
 331     const auto downloadPathOption = btSession->categoryOptions(m_addTorrentParams.category).downloadPath;
 332     m_ui->useDownloadPathComboBox->setCurrentIndex(downloadPathOption.has_value()
 333             ? m_ui->useDownloadPathComboBox->findData(downloadPathOption->enabled) : 0);
 334 }
 335
 336 void AddTorrentParamsWidget::populateDefaultPaths()
 337 {
 338     const auto *btSession = BitTorrent::Session::instance();
 339
 340     const Path defaultSavePath = btSession->suggestedSavePath(
 341             m_ui->categoryComboBox->currentText(), toOptionalBool(m_ui->comboTTM->currentData()));
 342     m_ui->savePathEdit->setPlaceholder(defaultSavePath);
 343
 344     populateDefaultDownloadPath();
 345 }
 346
 347 void AddTorrentParamsWidget::populateDefaultDownloadPath()
 348 {
 349     const auto *btSession = BitTorrent::Session::instance();
 350
 351     const std::optional<bool> useDownloadPath = toOptionalBool(m_ui->useDownloadPathComboBox->currentData());
 352     if (useDownloadPath.value_or(btSession->isDownloadPathEnabled()))
 353     {
 354         const Path defaultDownloadPath = btSession->suggestedDownloadPath(
 355                 m_ui->categoryComboBox->currentText(), toOptionalBool(m_ui->comboTTM->currentData()));
 356         m_ui->downloadPathEdit->setPlaceholder(defaultDownloadPath);
 357     }
 358     else
 359     {
 360         m_ui->downloadPathEdit->setPlaceholder(Path());
 361     }
 362 }
 363
 364 void AddTorrentParamsWidget::populateSavePathOptions()
 365 {
 366     if (!m_addTorrentParams.useAutoTMM.has_value())
 367     {
 368         // Default TMM settings
 369
 370         m_ui->groupBoxSavePath->setEnabled(false);
 371         m_ui->defaultsNoteLabel->setVisible(true);
 372         m_ui->savePathEdit->blockSignals(true);
 373         m_ui->savePathEdit->setSelectedPath(Path());
 374         m_ui->downloadPathEdit->blockSignals(true);
 375         m_ui->useDownloadPathComboBox->blockSignals(true);
 376         m_ui->downloadPathEdit->setSelectedPath(Path());
 377
 378         const auto *btSession = BitTorrent::Session::instance();
 379         const bool useAutoTMM = !btSession->isAutoTMMDisabledByDefault();
 380
 381         if (useAutoTMM)
 382         {
 383             loadCategorySavePathOptions();
 384         }
 385         else
 386         {
 387             m_ui->useDownloadPathComboBox->setCurrentIndex(
 388                     m_ui->useDownloadPathComboBox->findData(btSession->isDownloadPathEnabled()));
 389         }
 390     }
 391     else
 392     {
 393         // Overridden TMM settings
 394
 395         const bool useAutoTMM = m_addTorrentParams.useAutoTMM.value();
 396         if (useAutoTMM)
 397         {
 398             m_ui->groupBoxSavePath->setEnabled(false);
 399             m_ui->defaultsNoteLabel->setVisible(true);
 400             m_ui->savePathEdit->blockSignals(true);
 401             m_ui->savePathEdit->setSelectedPath(Path());
 402             m_ui->downloadPathEdit->blockSignals(true);
 403             m_ui->useDownloadPathComboBox->blockSignals(true);
 404             m_ui->downloadPathEdit->setSelectedPath(Path());
 405
 406             loadCategorySavePathOptions();
 407         }
 408         else
 409         {
 410             loadCustomSavePathOptions();
 411
 412             m_ui->groupBoxSavePath->setEnabled(true);
 413             m_ui->defaultsNoteLabel->setVisible(false);
 414             m_ui->savePathEdit->blockSignals(false);
 415             m_ui->useDownloadPathComboBox->blockSignals(false);
 416         }
 417     }
 418
 419     populateDefaultPaths();
 420 }