src/base/bittorrent/tracker.h

   1 /*
   2  * Bittorrent Client using Qt and libtorrent.
   3  * Copyright (C) 2019  Mike Tzou (Chocobo1)
   4  * Copyright (C) 2015  Vladimir Golovnev <glassez@yandex.ru>
   5  * Copyright (C) 2010  Christophe Dumez <chris@qbittorrent.org>
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20  *
  21  * In addition, as a special exception, the copyright holders give permission to
  22  * link this program with the OpenSSL project's "OpenSSL" library (or with
  23  * modified versions of it that use the same license as the "OpenSSL" library),
  24  * and distribute the linked executables. You must obey the GNU General Public
  25  * License in all respects for all of the code used other than "OpenSSL".  If you
  26  * modify file(s), you may extend this exception to your version of the file(s),
  27  * but you are not obligated to do so. If you do not wish to do so, delete this
  28  * exception statement from your version.
  29  */
  30
  31 #pragma once
  32
  33 #include <string>
  34
  35 #include <libtorrent/entry.hpp>
  36
  37 #include <QtGlobal>
  38 #include <QHash>
  39 #include <QObject>
  40 #include <QSet>
  41
  42 #include "base/bittorrent/infohash.h"
  43 #include "base/http/irequesthandler.h"
  44 #include "base/http/responsebuilder.h"
  45
  46 namespace Http
  47 {
  48     class Server;
  49 }
  50
  51 namespace BitTorrent
  52 {
  53     struct Peer
  54     {
  55         QByteArray peerId;
  56         ushort port = 0;  // self-claimed by peer, might not be the same as socket port
  57         bool isSeeder = false;
  58
  59         // caching precomputed values
  60         lt::entry::string_type address;
  61         lt::entry::string_type endpoint;
  62
  63         QByteArray uniqueID() const;
  64     };
  65
  66     bool operator==(const Peer &left, const Peer &right);
  67     bool operator!=(const Peer &left, const Peer &right);
  68 #if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
  69     std::size_t qHash(const Peer &key, std::size_t seed = 0);
  70 #else
  71     uint qHash(const Peer &key, uint seed = 0);
  72 #endif
  73
  74     // *Basic* Bittorrent tracker implementation
  75     // [BEP-3] The BitTorrent Protocol Specification
  76     // also see: https://wiki.theory.org/index.php/BitTorrentSpecification#Tracker_HTTP.2FHTTPS_Protocol
  77     class Tracker final : public QObject, public Http::IRequestHandler, private Http::ResponseBuilder
  78     {
  79         Q_OBJECT
  80         Q_DISABLE_COPY_MOVE(Tracker)
  81
  82         struct TrackerAnnounceRequest;
  83
  84         struct TorrentStats
  85         {
  86             qint64 seeders = 0;
  87             QSet<Peer> peers;
  88
  89             void setPeer(const Peer &peer);
  90             bool removePeer(const Peer &peer);
  91         };
  92
  93     public:
  94         explicit Tracker(QObject *parent = nullptr);
  95
  96         bool start();
  97
  98     private:
  99         Http::Response processRequest(const Http::Request &request, const Http::Environment &env) override;
 100         void processAnnounceRequest();
 101
 102         void registerPeer(const TrackerAnnounceRequest &announceReq);
 103         void unregisterPeer(const TrackerAnnounceRequest &announceReq);
 104         void prepareAnnounceResponse(const TrackerAnnounceRequest &announceReq);
 105
 106         Http::Server *m_server = nullptr;
 107         Http::Request m_request;
 108         Http::Environment m_env;
 109
 110         QHash<TorrentID, TorrentStats> m_torrents;
 111     };
 112 }