src/main/torrentmanager.h

   1 /***************************************************************************
   2  *                                                                         *
   3  *   Copyright (C) 2006 David Brodsky                                      *
   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 as        *
   7  *   published by the Free Software Foundation and appearing               *
   8  *   in the file LICENSE.GPL included in the packaging of this file.       *
   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 GNU      *
  13  *   General Public License for more details.                              *
  14  *                                                                         *
  15  ***************************************************************************/
  16
  17 #ifndef _main_torrentmanager_h
  18 #define _main_torrentmanager_h
  19
  20 #include <map>
  21
  22 #include <tairon/core/string.h>
  23
  24 using Tairon::Core::String;
  25
  26 class TiXmlNode;
  27
  28 namespace Tairent
  29 {
  30
  31 namespace Core
  32 {
  33
  34 class BEncode;
  35
  36 }; // namespace Core
  37
  38 namespace Main
  39 {
  40
  41 class TorrentClient;
  42
  43 /** \brief Holds informations about managed torrents.
  44  *
  45  * This class is a singleton.
  46  */
  47 struct TorrentStruct
  48 {
  49         /** Client for this torrent. If there is no such client then it is zero.
  50          */
  51         TorrentClient *client;
  52
  53         /** Meta info of the torrent. If the metainfo has not been loaded yet then
  54          * it is zero.
  55          */
  56         Tairent::Core::BEncode *metaInfo;
  57
  58         /** Whether this torrent is completely downloaded.
  59          */
  60         bool complete;
  61
  62         /** Filename of torrent.
  63          */
  64         String torrentFile;
  65 };
  66
  67 /** \brief TorrentManager keeps informations about managed torrents.
  68  */
  69 class TorrentManager
  70 {
  71         public:
  72                 /** Constructs a TorrentManager object; calls loadTorrent().
  73                  */
  74                 TorrentManager();
  75
  76                 /** Destroys the object.
  77                  */
  78                 ~TorrentManager();
  79
  80                 /** Deletes all active clients.
  81                  */
  82                 void destroy();
  83
  84                 TorrentClient *getClient(const String &infoHash);
  85
  86                 /** Returns client ID.
  87                  */
  88                 const String &getClientID();
  89
  90                 /** Converts data in hex to its binary original.
  91                  */
  92                 static String hexToBin(const String &data);
  93
  94                 /** Returns pointer to the instance of this class.
  95                  */
  96                 static TorrentManager *self() {
  97                         return torrentManager;
  98                 };
  99
 100                 /** Starts downloading unfinished torrents.
 101                  */
 102                 void startTorrents();
 103
 104                 /** Stops downloading torrents.
 105                  */
 106                 void stopTorrents();
 107
 108         private:
 109                 /** Helper method for converting hex char to an integer.
 110                  */
 111                 static char hexToBin(char c);
 112
 113                 /** Loads metainfo from a file with given filename. A new
 114                  * Tairent::Core::BEncode object is created and filled with
 115                  * informations from the file. Zero is returned if any error occurs
 116                  * while loading.
 117                  */
 118                 Tairent::Core::BEncode *loadMetaInfo(const String &filename);
 119
 120                 /** Loads informations about one torrent from a node.
 121                  *
 122                  * \param t Element with informations about torrent.
 123                  */
 124                 void loadTorrent(TiXmlNode *t);
 125
 126                 /** Loads informations about torrents from file torrents.xml stored in
 127                  * a directory whose name is stored in Tairon::Core::Config as
 128                  * "torrents-directory".
 129                  */
 130                 void loadTorrents();
 131
 132                 /** Creates client ID.
 133                  */
 134                 void makeClientID();
 135
 136         private:
 137                 /** Client ID.
 138                  */
 139                 String clientID;
 140
 141                 /** Pointer to the instance of this class.
 142                  */
 143                 static TorrentManager *torrentManager;
 144
 145                 /** Mapping hash (raw, not human-readable) -> info about torrent.
 146                  */
 147                 std::map<String, TorrentStruct *> torrents;
 148 };
 149
 150 }; // namespace Main
 151
 152 }; // namespace Tairent
 153
 154 #endif
 155
 156 // vim: ai sw=4 ts=4 noet fdm=marker