src/base/bittorrent/torrentdescriptor.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 <libtorrent/add_torrent_params.hpp>
  34
  35 #include <QtContainerFwd>
  36 #include <QMetaType>
  37
  38 #include "base/3rdparty/expected.hpp"
  39 #include "base/path.h"
  40 #include "torrentinfo.h"
  41
  42 class QByteArray;
  43 class QDateTime;
  44 class QString;
  45 class QUrl;
  46
  47 namespace BitTorrent
  48 {
  49     class InfoHash;
  50     struct TrackerEntry;
  51
  52     class TorrentDescriptor
  53     {
  54     public:
  55         TorrentDescriptor() = default;
  56
  57         InfoHash infoHash() const;
  58         QString name() const;
  59         QDateTime creationDate() const;
  60         QString creator() const;
  61         QString comment() const;
  62         QList<TrackerEntry> trackers() const;
  63         QList<QUrl> urlSeeds() const;
  64         const std::optional<TorrentInfo> &info() const;
  65
  66         void setTorrentInfo(TorrentInfo torrentInfo);
  67
  68         static nonstd::expected<TorrentDescriptor, QString> load(const QByteArray &data) noexcept;
  69         static nonstd::expected<TorrentDescriptor, QString> loadFromFile(const Path &path) noexcept;
  70         static nonstd::expected<TorrentDescriptor, QString> parse(const QString &str) noexcept;
  71         nonstd::expected<void, QString> saveToFile(const Path &path) const;
  72
  73         const lt::add_torrent_params &ltAddTorrentParams() const;
  74
  75     private:
  76         explicit TorrentDescriptor(lt::add_torrent_params ltAddTorrentParams);
  77
  78         lt::add_torrent_params m_ltAddTorrentParams;
  79         std::optional<TorrentInfo> m_info;
  80     };
  81 }
  82
  83 Q_DECLARE_METATYPE(BitTorrent::TorrentDescriptor)