src/base/bittorrent/addtorrentparams.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015-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 #pragma once
  30
  31 #include <optional>
  32
  33 #include <QMetaType>
  34 #include <QString>
  35 #include <QVector>
  36
  37 #include "base/path.h"
  38 #include "base/tagset.h"
  39 #include "sslparameters.h"
  40 #include "torrent.h"
  41 #include "torrentcontentlayout.h"
  42
  43 class QJsonObject;
  44
  45 namespace BitTorrent
  46 {
  47     enum class DownloadPriority;
  48
  49     struct AddTorrentParams
  50     {
  51         QString name;
  52         QString category;
  53         TagSet tags;
  54         Path savePath;
  55         std::optional<bool> useDownloadPath;
  56         Path downloadPath;
  57         bool sequential = false;
  58         bool firstLastPiecePriority = false;
  59         bool addForced = false;
  60         std::optional<bool> addToQueueTop;
  61         std::optional<bool> addPaused;
  62         std::optional<Torrent::StopCondition> stopCondition;
  63         PathList filePaths; // used if TorrentInfo is set
  64         QVector<DownloadPriority> filePriorities; // used if TorrentInfo is set
  65         bool skipChecking = false;
  66         std::optional<BitTorrent::TorrentContentLayout> contentLayout;
  67         std::optional<bool> useAutoTMM;
  68         int uploadLimit = -1;
  69         int downloadLimit = -1;
  70         int seedingTimeLimit = Torrent::USE_GLOBAL_SEEDING_TIME;
  71         int inactiveSeedingTimeLimit = Torrent::USE_GLOBAL_INACTIVE_SEEDING_TIME;
  72         qreal ratioLimit = Torrent::USE_GLOBAL_RATIO;
  73         SSLParameters sslParameters;
  74
  75         friend bool operator==(const AddTorrentParams &lhs, const AddTorrentParams &rhs) = default;
  76     };
  77
  78     AddTorrentParams parseAddTorrentParams(const QJsonObject &jsonObj);
  79     QJsonObject serializeAddTorrentParams(const AddTorrentParams &params);
  80 }
  81
  82 Q_DECLARE_METATYPE(BitTorrent::AddTorrentParams)