src/base/bittorrent/torrentinfo.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2015-2024  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 <libtorrent/torrent_info.hpp>
  32
  33 #include <QtContainerFwd>
  34 #include <QCoreApplication>
  35 #include <QList>
  36
  37 #include "base/indexrange.h"
  38 #include "base/pathfwd.h"
  39
  40 class QByteArray;
  41 class QDateTime;
  42 class QString;
  43 class QUrl;
  44
  45 namespace BitTorrent
  46 {
  47     class InfoHash;
  48     struct TrackerEntry;
  49
  50     class TorrentInfo
  51     {
  52     public:
  53         TorrentInfo() = default;
  54         TorrentInfo(const TorrentInfo &other) = default;
  55
  56         explicit TorrentInfo(const lt::torrent_info &nativeInfo);
  57
  58         TorrentInfo &operator=(const TorrentInfo &other);
  59
  60         bool isValid() const;
  61         InfoHash infoHash() const;
  62         QString name() const;
  63         bool isPrivate() const;
  64         qlonglong totalSize() const;
  65         int filesCount() const;
  66         int pieceLength() const;
  67         int pieceLength(int index) const;
  68         int piecesCount() const;
  69         Path filePath(int index) const;
  70         PathList filePaths() const;
  71         qlonglong fileSize(int index) const;
  72         qlonglong fileOffset(int index) const;
  73         PathList filesForPiece(int pieceIndex) const;
  74         QList<int> fileIndicesForPiece(int pieceIndex) const;
  75         QList<QByteArray> pieceHashes() const;
  76
  77         using PieceRange = IndexRange<int>;
  78         // returns pair of the first and the last pieces into which
  79         // the given file extends (maybe partially).
  80         PieceRange filePieces(const Path &filePath) const;
  81         PieceRange filePieces(int fileIndex) const;
  82
  83         QByteArray rawData() const;
  84
  85         bool matchesInfoHash(const InfoHash &otherInfoHash) const;
  86
  87         std::shared_ptr<lt::torrent_info> nativeInfo() const;
  88         QList<lt::file_index_t> nativeIndexes() const;
  89
  90     private:
  91         // returns file index or -1 if fileName is not found
  92         int fileIndex(const Path &filePath) const;
  93
  94         std::shared_ptr<const lt::torrent_info> m_nativeInfo;
  95
  96         // internal indexes of files (payload only, excluding any .pad files)
  97         // by which they are addressed in libtorrent
  98         QList<lt::file_index_t> m_nativeIndexes;
  99     };
 100 }
 101
 102 Q_DECLARE_METATYPE(BitTorrent::TorrentInfo)