src/base/bittorrent/torrent.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015-2024  Vladimir Golovnev <glassez@yandex.ru>
   4  * Copyright (C) 2006  Christophe Dumez <chris@qbittorrent.org>
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version.
  10  *
  11  * This program 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 this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19  *
  20  * In addition, as a special exception, the copyright holders give permission to
  21  * link this program with the OpenSSL project's "OpenSSL" library (or with
  22  * modified versions of it that use the same license as the "OpenSSL" library),
  23  * and distribute the linked executables. You must obey the GNU General Public
  24  * License in all respects for all of the code used other than "OpenSSL".  If you
  25  * modify file(s), you may extend this exception to your version of the file(s),
  26  * but you are not obligated to do so. If you do not wish to do so, delete this
  27  * exception statement from your version.
  28  */
  29
  30 #pragma once
  31
  32 #include <QtContainerFwd>
  33 #include <QtTypes>
  34 #include <QMetaType>
  35 #include <QString>
  36
  37 #include "base/3rdparty/expected.hpp"
  38 #include "base/pathfwd.h"
  39 #include "base/tagset.h"
  40 #include "sharelimitaction.h"
  41 #include "torrentcontenthandler.h"
  42
  43 class QBitArray;
  44 class QByteArray;
  45 class QDateTime;
  46 class QUrl;
  47
  48 namespace BitTorrent
  49 {
  50     enum class DownloadPriority;
  51
  52     class InfoHash;
  53     class PeerInfo;
  54     class Session;
  55     class TorrentID;
  56     class TorrentInfo;
  57
  58     struct PeerAddress;
  59     struct SSLParameters;
  60     struct TrackerEntry;
  61     struct TrackerEntryStatus;
  62
  63     // Using `Q_ENUM_NS()` without a wrapper namespace in our case is not advised
  64     // since `Q_NAMESPACE` cannot be used when the same namespace resides at different files.
  65     // https://www.kdab.com/new-qt-5-8-meta-object-support-namespaces/#comment-143779
  66     inline namespace TorrentOperatingModeNS
  67     {
  68         Q_NAMESPACE
  69
  70         enum class TorrentOperatingMode
  71         {
  72             AutoManaged = 0,
  73             Forced = 1
  74         };
  75
  76         Q_ENUM_NS(TorrentOperatingMode)
  77     }
  78
  79     enum class TorrentState
  80     {
  81         Unknown = -1,
  82
  83         ForcedDownloading,
  84         Downloading,
  85         ForcedDownloadingMetadata,
  86         DownloadingMetadata,
  87         StalledDownloading,
  88
  89         ForcedUploading,
  90         Uploading,
  91         StalledUploading,
  92
  93         CheckingResumeData,
  94         QueuedDownloading,
  95         QueuedUploading,
  96
  97         CheckingUploading,
  98         CheckingDownloading,
  99
 100         StoppedDownloading,
 101         StoppedUploading,
 102
 103         Moving,
 104
 105         MissingFiles,
 106         Error
 107     };
 108
 109     std::size_t qHash(TorrentState key, std::size_t seed = 0);
 110
 111     class Torrent : public TorrentContentHandler
 112     {
 113         Q_OBJECT
 114         Q_DISABLE_COPY_MOVE(Torrent)
 115
 116     public:
 117         enum class StopCondition
 118         {
 119             None = 0,
 120             MetadataReceived = 1,
 121             FilesChecked = 2
 122         };
 123         Q_ENUM(StopCondition)
 124
 125         static const qreal USE_GLOBAL_RATIO;
 126         static const qreal NO_RATIO_LIMIT;
 127
 128         static const int USE_GLOBAL_SEEDING_TIME;
 129         static const int NO_SEEDING_TIME_LIMIT;
 130
 131         static const int USE_GLOBAL_INACTIVE_SEEDING_TIME;
 132         static const int NO_INACTIVE_SEEDING_TIME_LIMIT;
 133
 134         static const qreal MAX_RATIO;
 135         static const int MAX_SEEDING_TIME;
 136         static const int MAX_INACTIVE_SEEDING_TIME;
 137
 138         using TorrentContentHandler::TorrentContentHandler;
 139
 140         virtual Session *session() const = 0;
 141
 142         virtual InfoHash infoHash() const = 0;
 143         virtual QString name() const = 0;
 144         virtual QDateTime creationDate() const = 0;
 145         virtual QString creator() const = 0;
 146         virtual QString comment() const = 0;
 147         virtual bool isPrivate() const = 0;
 148         virtual qlonglong totalSize() const = 0;
 149         virtual qlonglong wantedSize() const = 0;
 150         virtual qlonglong completedSize() const = 0;
 151         virtual qlonglong pieceLength() const = 0;
 152         virtual qlonglong wastedSize() const = 0;
 153         virtual QString currentTracker() const = 0;
 154
 155         // 1. savePath() - the path where all the files and subfolders of torrent are stored.
 156         // 1.1 downloadPath() - the path where all the files and subfolders of torrent are stored until torrent has finished downloading.
 157         // 2. rootPath() - absolute path of torrent file tree (first common subfolder of torrent files); empty string if torrent has no root folder.
 158         // 3. contentPath() - absolute path of torrent content (root path for multifile torrents, absolute file path for singlefile torrents).
 159         //
 160         // Examples.
 161         // Suppose we have three torrent with following structures and save path `/home/user/torrents`:
 162         //
 163         // Torrent A (multifile)
 164         //
 165         // torrentA/
 166         //    subdir1/
 167         //       subdir2/
 168         //          file1
 169         //          file2
 170         //       file3
 171         //    file4
 172         //
 173         //
 174         // Torrent A* (Torrent A in "strip root folder" mode)
 175         //
 176         //
 177         // Torrent B (singlefile)
 178         //
 179         // torrentB/
 180         //    subdir1/
 181         //           file1
 182         //
 183         //
 184         // Torrent C (singlefile)
 185         //
 186         // file1
 187         //
 188         //
 189         // Results:
 190         // |   |           rootPath           |                contentPath                 |
 191         // |---|------------------------------|--------------------------------------------|
 192         // | A | /home/user/torrents/torrentA | /home/user/torrents/torrentA               |
 193         // | A*|           <empty>            | /home/user/torrents                        |
 194         // | B | /home/user/torrents/torrentB | /home/user/torrents/torrentB/subdir1/file1 |
 195         // | C |           <empty>            | /home/user/torrents/file1                  |
 196
 197         virtual bool isAutoTMMEnabled() const = 0;
 198         virtual void setAutoTMMEnabled(bool enabled) = 0;
 199         virtual Path savePath() const = 0;
 200         virtual void setSavePath(const Path &savePath) = 0;
 201         virtual Path downloadPath() const = 0;
 202         virtual void setDownloadPath(const Path &downloadPath) = 0;
 203         virtual Path rootPath() const = 0;
 204         virtual Path contentPath() const = 0;
 205         virtual QString category() const = 0;
 206         virtual bool belongsToCategory(const QString &category) const = 0;
 207         virtual bool setCategory(const QString &category) = 0;
 208
 209         virtual TagSet tags() const = 0;
 210         virtual bool hasTag(const Tag &tag) const = 0;
 211         virtual bool addTag(const Tag &tag) = 0;
 212         virtual bool removeTag(const Tag &tag) = 0;
 213         virtual void removeAllTags() = 0;
 214
 215         virtual int piecesCount() const = 0;
 216         virtual int piecesHave() const = 0;
 217         virtual qreal progress() const = 0;
 218         virtual QDateTime addedTime() const = 0;
 219
 220         // Share limits
 221         virtual qreal ratioLimit() const = 0;
 222         virtual void setRatioLimit(qreal limit) = 0;
 223         virtual int seedingTimeLimit() const = 0;
 224         virtual void setSeedingTimeLimit(int limit) = 0;
 225         virtual int inactiveSeedingTimeLimit() const = 0;
 226         virtual void setInactiveSeedingTimeLimit(int limit) = 0;
 227         virtual ShareLimitAction shareLimitAction() const = 0;
 228         virtual void setShareLimitAction(ShareLimitAction action) = 0;
 229
 230         virtual PathList filePaths() const = 0;
 231
 232         virtual TorrentInfo info() const = 0;
 233         virtual bool isFinished() const = 0;
 234         virtual bool isStopped() const = 0;
 235         virtual bool isQueued() const = 0;
 236         virtual bool isForced() const = 0;
 237         virtual bool isChecking() const = 0;
 238         virtual bool isDownloading() const = 0;
 239         virtual bool isMoving() const = 0;
 240         virtual bool isUploading() const = 0;
 241         virtual bool isCompleted() const = 0;
 242         virtual bool isActive() const = 0;
 243         virtual bool isInactive() const = 0;
 244         virtual bool isErrored() const = 0;
 245         virtual bool isSequentialDownload() const = 0;
 246         virtual bool hasFirstLastPiecePriority() const = 0;
 247         virtual TorrentState state() const = 0;
 248         virtual bool hasMissingFiles() const = 0;
 249         virtual bool hasError() const = 0;
 250         virtual int queuePosition() const = 0;
 251         virtual QVector<TrackerEntryStatus> trackers() const = 0;
 252         virtual QVector<QUrl> urlSeeds() const = 0;
 253         virtual QString error() const = 0;
 254         virtual qlonglong totalDownload() const = 0;
 255         virtual qlonglong totalUpload() const = 0;
 256         virtual qlonglong activeTime() const = 0;
 257         virtual qlonglong finishedTime() const = 0;
 258         virtual qlonglong eta() const = 0;
 259         virtual int seedsCount() const = 0;
 260         virtual int peersCount() const = 0;
 261         virtual int leechsCount() const = 0;
 262         virtual int totalSeedsCount() const = 0;
 263         virtual int totalPeersCount() const = 0;
 264         virtual int totalLeechersCount() const = 0;
 265         virtual QDateTime lastSeenComplete() const = 0;
 266         virtual QDateTime completedTime() const = 0;
 267         virtual qlonglong timeSinceUpload() const = 0;
 268         virtual qlonglong timeSinceDownload() const = 0;
 269         virtual qlonglong timeSinceActivity() const = 0;
 270         virtual int downloadLimit() const = 0;
 271         virtual int uploadLimit() const = 0;
 272         virtual bool superSeeding() const = 0;
 273         virtual bool isDHTDisabled() const = 0;
 274         virtual bool isPEXDisabled() const = 0;
 275         virtual bool isLSDDisabled() const = 0;
 276         virtual QVector<PeerInfo> peers() const = 0;
 277         virtual QBitArray pieces() const = 0;
 278         virtual QBitArray downloadingPieces() const = 0;
 279         virtual QVector<int> pieceAvailability() const = 0;
 280         virtual qreal distributedCopies() const = 0;
 281         virtual qreal maxRatio() const = 0;
 282         virtual int maxSeedingTime() const = 0;
 283         virtual int maxInactiveSeedingTime() const = 0;
 284         virtual qreal realRatio() const = 0;
 285         virtual int uploadPayloadRate() const = 0;
 286         virtual int downloadPayloadRate() const = 0;
 287         virtual qlonglong totalPayloadUpload() const = 0;
 288         virtual qlonglong totalPayloadDownload() const = 0;
 289         virtual int connectionsCount() const = 0;
 290         virtual int connectionsLimit() const = 0;
 291         virtual qlonglong nextAnnounce() const = 0;
 292
 293         virtual void setName(const QString &name) = 0;
 294         virtual void setSequentialDownload(bool enable) = 0;
 295         virtual void setFirstLastPiecePriority(bool enabled) = 0;
 296         virtual void stop() = 0;
 297         virtual void start(TorrentOperatingMode mode = TorrentOperatingMode::AutoManaged) = 0;
 298         virtual void forceReannounce(int index = -1) = 0;
 299         virtual void forceDHTAnnounce() = 0;
 300         virtual void forceRecheck() = 0;
 301         virtual void setUploadLimit(int limit) = 0;
 302         virtual void setDownloadLimit(int limit) = 0;
 303         virtual void setSuperSeeding(bool enable) = 0;
 304         virtual void setDHTDisabled(bool disable) = 0;
 305         virtual void setPEXDisabled(bool disable) = 0;
 306         virtual void setLSDDisabled(bool disable) = 0;
 307         virtual void addTrackers(QVector<TrackerEntry> trackers) = 0;
 308         virtual void removeTrackers(const QStringList &trackers) = 0;
 309         virtual void replaceTrackers(QVector<TrackerEntry> trackers) = 0;
 310         virtual void addUrlSeeds(const QVector<QUrl> &urlSeeds) = 0;
 311         virtual void removeUrlSeeds(const QVector<QUrl> &urlSeeds) = 0;
 312         virtual bool connectPeer(const PeerAddress &peerAddress) = 0;
 313         virtual void clearPeers() = 0;
 314         virtual void setMetadata(const TorrentInfo &torrentInfo) = 0;
 315
 316         virtual StopCondition stopCondition() const = 0;
 317         virtual void setStopCondition(StopCondition stopCondition) = 0;
 318         virtual SSLParameters getSSLParameters() const = 0;
 319         virtual void setSSLParameters(const SSLParameters &sslParams) = 0;
 320
 321         virtual QString createMagnetURI() const = 0;
 322         virtual nonstd::expected<QByteArray, QString> exportToBuffer() const = 0;
 323         virtual nonstd::expected<void, QString> exportToFile(const Path &path) const = 0;
 324
 325         virtual void fetchPeerInfo(std::function<void (QVector<PeerInfo>)> resultHandler) const = 0;
 326         virtual void fetchURLSeeds(std::function<void (QVector<QUrl>)> resultHandler) const = 0;
 327         virtual void fetchPieceAvailability(std::function<void (QVector<int>)> resultHandler) const = 0;
 328         virtual void fetchDownloadingPieces(std::function<void (QBitArray)> resultHandler) const = 0;
 329
 330         TorrentID id() const;
 331         bool isRunning() const;
 332         qlonglong remainingSize() const;
 333
 334         void toggleSequentialDownload();
 335         void toggleFirstLastPiecePriority();
 336     };
 337 }
 338
 339 Q_DECLARE_METATYPE(BitTorrent::TorrentState)