src/base/bittorrent/torrentinfo.h

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