TODO

   1 Comply with the newly defined protocol on the web page.
   2
   3 Various things need to done to comply with the newly defined protocol:
   4  - add the token to find_node responses
   5  - use the token in store_node requests
   6  - standardize the error messages (especially for a bad token)
   7
   8
   9 Reduce the memory footprint by clearing the AptPackages caches.
  10
  11 The memory usage is a little bit high due to keeping the AptPackages
  12 caches always. Instead, they should timeout after a period of inactivity
  13 (say 15 minutes), and unload themselves from meory. It only takes a few
  14 seconds to reload, so this should not be an issue.
  15
  16
  17 Packages.diff files need to be considered.
  18
  19 The Packages.diff/Index files contain hashes of Packages.diff/rred.gz
  20 files, which themselves contain diffs to the Packages files previously
  21 downloaded. Apt will request these files for the testing/unstable
  22 distributions. They need to either be ignored, or dealt with properly by
  23 adding them to the tracking done by the AptPackages module.
  24
  25
  26 PeerManager needs to download large files from multiple peers.
  27
  28 The PeerManager currently chooses a peer at random from the list of
  29 possible peers, and downloads the entire file from there. This needs to
  30 change if both a) the file is large (more than 512 KB), and b) there are
  31 multiple peers with the file. The PeerManager should then break up the
  32 large file into multiple pieces of size < 512 KB, and then send requests
  33 to multiple peers for these pieces.
  34
  35 This can cause a problem with hash checking the returned data, as hashes
  36 for the pieces are not known. Any file that fails a hash check should be
  37 downloaded again, with each piece being downloaded from different peers
  38 than it was previously. The peers are shifted by 1, so that if a peers
  39 previously downloaded piece i, it now downloads piece i+1, and the first
  40 piece is downloaded by the previous downloader of the last piece, or
  41 preferably a previously unused peer. As each piece is downloaded the
  42 running hash of the file should be checked to determine the place at
  43 which the file differs from the previous download.
  44
  45 If the hash check then passes, then the peer who originally provided the
  46 bad piece can be assessed blame for the error. Otherwise, the peer who
  47 originally provided the piece is probably at fault, since he is now
  48 providing a later piece. This doesn't work if the differing piece is the
  49 first piece, in which case it is downloaded from a 3rd peer, with
  50 consensus revealing the misbehaving peer.
  51
  52
  53 Store and share torrent-like strings for large files.
  54
  55 In addition to storing the file download location (which would still be
  56 used for small files), a bencoded dictionary containing the peer's
  57 hashes of the individual pieces could be stored for the larger files
  58 (20% of all the files are larger than 512 KB). This dictionary would
  59 have the normal piece size, the hash length, and a string containing the
  60 piece hashes of length <hash length>*<#pieces>. These piece hashes could
  61 be compared ahead of time to determine which peers have the same piece
  62 hashes (they all should), and then used during the download to verify
  63 the downloaded pieces.
  64
  65 For very large files (5 or more pieces), the torrent strings are too
  66 long to store in the DHT and retrieve (a single UDP packet should be
  67 less than 1472 bytes to avoid fragmentation). Instead, the peers should
  68 store the torrent-like string for large files separately, and only
  69 contain a reference to it in their stored value for the hash of the
  70 file. The reference would be a hash of the bencoded dictionary. If the
  71 torrent-like string is short enough to store in the DHT (i.e. less than
  72 1472 bytes, or about 70 pieces for the SHA1 hash), then a
  73 lookup of that hash in the DHT would give the torrent-like string.
  74 Otherwise, a request to the peer for the hash (just like files are
  75 downloaded), should return the bencoded torrent-like string.
  76
  77
  78 PeerManager needs to track peers' properties.
  79
  80 The PeerManager needs to keep track of the observed properties of seen
  81 peers, to help determine a selection criteria for choosing peers to
  82 download from. Each property will give a value from 0 to 1. The relevant
  83 properties are:
  84
  85  - hash errors in last day (1 = 0, 0 = 3+)
  86  - recent download speed (1 = fastest, 0 = 0)
  87  - lag time from request to download (1 = 0, 0 = 15s+)
  88  - number of pending requests (1 = 0, 0 = max (10))
  89  - whether a connection is open (1 = yes, 0.9 = no)
  90
  91 These should be combined (multiplied) to provide a sort order for peers
  92 available to download from, which can then be used to assign new
  93 downloads to peers. Pieces should be downloaded from the best peers
  94 first (i.e. piece 0 from the absolute best peer).
  95
  96
  97 When looking up values, DHT should return nodes and values.
  98
  99 When a key has multiple values in the DHT, returning a stored value may not
 100 be sufficient, as then no more nodes can be contacted to get more stored
 101 values. Instead, return both the stored values and the list of closest
 102 nodes so that the peer doing the lookup can decide when to stop looking
 103 (when it has received enough values).
 104
 105 Instead of returning both, a new method could be added, "lookup_value".
 106 This method will be like "get_value", except that every node will always
 107 return a list of nodes, as well as the number of values it has for that
 108 key. Once a querying node has found enough values (or all of them), then
 109 it would send the "get_value" method to the nodes that have the most
 110 values. The "get_value" query could also have a new parameter "number",
 111 which is the maximum number of values to return.
 112
 113
 114 Missing Kademlia implementation details are needed.
 115
 116 The current implementation is missing some important features, mostly
 117 focussed on storing values:
 118  - values need to be republished (every hour?)