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 Storage;
  42 class TorrentClient;
  43
  44 /** \brief Holds informations about managed torrents.
  45  *
  46  * This class is a singleton.
  47  */
  48 struct TorrentStruct
  49 {
  50         /** Client for this torrent. If there is no such client then it is zero.
  51          */
  52         TorrentClient *client;
  53
  54         /** This client's storage. It is used for fast-resuming.
  55          */
  56         Storage *storage;
  57
  58         /** Meta info of the torrent. If the metainfo has not been loaded yet then
  59          * it is zero.
  60          */
  61         Tairent::Core::BEncode *metaInfo;
  62
  63         /** Whether this torrent is completely downloaded.
  64          */
  65         bool complete;
  66
  67         /** Filename of torrent.
  68          */
  69         String torrentFile;
  70 };
  71
  72 /** \brief TorrentManager keeps informations about managed torrents.
  73  */
  74 class TorrentManager
  75 {
  76         public:
  77                 /** Constructs a TorrentManager object; calls loadTorrent().
  78                  */
  79                 TorrentManager();
  80
  81                 /** Destroys the object.
  82                  */
  83                 ~TorrentManager();
  84
  85                 /** Converts data in bin to its hexadecimal variant.
  86                  */
  87                 static String binToHex(const String &data);
  88
  89                 /** Deletes all active clients.
  90                  */
  91                 void destroy();
  92
  93                 /** Returns a TorrentClient object associated with given info hash. The
  94                  * method returns 0 if there is no such client.
  95                  */
  96                 TorrentClient *getClient(const String &infoHash);
  97
  98                 /** Returns client ID.
  99                  */
 100                 const String &getClientID();
 101
 102                 /** Converts data in hex to its binary original.
 103                  */
 104                 static String hexToBin(const String &data);
 105
 106                 /** Saves informations about managed torrents to torrents.xml file in
 107                  * torrents-directory configuration option.
 108                  */
 109                 void save();
 110
 111                 /** Returns pointer to the instance of this class.
 112                  */
 113                 static TorrentManager *self() {
 114                         return torrentManager;
 115                 };
 116
 117                 /** Starts downloading unfinished torrents.
 118                  */
 119                 void startTorrents();
 120
 121                 /** Stops downloading torrents.
 122                  */
 123                 void stopTorrents();
 124
 125         private:
 126                 /** Helper method for converting hex char to an integer.
 127                  */
 128                 static char hexToBin(char c);
 129
 130                 /** Loads metainfo from a file with given filename. A new
 131                  * Tairent::Core::BEncode object is created and filled with
 132                  * informations from the file. Zero is returned if any error occurs
 133                  * while loading.
 134                  */
 135                 Tairent::Core::BEncode *loadMetaInfo(const String &filename);
 136
 137                 /** Loads informations about one torrent from a node.
 138                  *
 139                  * \param t Element with informations about torrent.
 140                  */
 141                 void loadTorrent(TiXmlNode *t);
 142
 143                 /** Loads informations about torrents from file torrents.xml stored in
 144                  * a directory whose name is stored in Tairon::Core::Config as
 145                  * "torrents-directory".
 146                  */
 147                 void loadTorrents();
 148
 149                 /** Creates client ID.
 150                  */
 151                 void makeClientID();
 152
 153         private:
 154                 /** Client ID.
 155                  */
 156                 String clientID;
 157
 158                 /** Pointer to the instance of this class.
 159                  */
 160                 static TorrentManager *torrentManager;
 161
 162                 /** Mapping hash (raw, not human-readable) -> info about torrent.
 163                  */
 164                 std::map<String, TorrentStruct *> torrents;
 165 };
 166
 167 }; // namespace Main
 168
 169 }; // namespace Tairent
 170
 171 #endif
 172
 173 // vim: ai sw=4 ts=4 noet fdm=marker