Add documentation to Message module

3 files changed, 39 insertions, 41 deletions

diff --git a/src/Network/BitTorrent/Core/PeerAddr.hs b/src/Network/BitTorrent/Core/PeerAddr.hs
index a4f45e74..5570bfc1 100644
--- a/src/Network/BitTorrent/Core/PeerAddr.hs
+++ b/src/Network/BitTorrent/Core/PeerAddr.hs
@@ -16,6 +16,7 @@
 module Network.BitTorrent.Core.PeerAddr
        ( -- * Peer address
          PeerAddr(..)
+       , defaultPorts
        , peerSockAddr
        , connectToPeer
        , ppPeer
@@ -81,12 +82,17 @@ instance BEncode PeerAddr where
 -- 'peerId' is always 'Nothing'.
 --
 --   For more info see: <http://www.bittorrent.org/beps/bep_0023.html>
+--
 instance Serialize PeerAddr where
   put PeerAddr {..} = put peerID >> put peerPort
   {-# INLINE put #-}
   get = PeerAddr Nothing <$> get <*> get
   {-# INLINE get #-}
 
+-- | Ports typically reserved for bittorrent P2P listener.
+defaultPorts :: [PortNumber]
+defaultPorts =  [6881..6889]
+
 -- TODO make platform independent, clarify htonl
 
 -- | Convert peer info from tracker response to socket address.  Used
diff --git a/src/Network/BitTorrent/Tracker/HTTP.hs b/src/Network/BitTorrent/Tracker/HTTP.hs
index 55b347ce..2d49436d 100644
--- a/src/Network/BitTorrent/Tracker/HTTP.hs
+++ b/src/Network/BitTorrent/Tracker/HTTP.hs
@@ -17,7 +17,7 @@ module Network.BitTorrent.Tracker.HTTP
        ( HTTPTracker
 
          -- * Extra
-       , scrapeURL
+--       , scrapeURL
        ) where
 
 import Control.Exception
@@ -25,13 +25,27 @@ import Data.BEncode
 import Data.ByteString as B
 import Data.ByteString.Char8 as BC
 import Data.List as L
+import Data.Map as M
 import Data.Monoid
 import Data.URLEncoded as URL
 import Network.URI
 import Network.HTTP
 
-import Network.BitTorrent.Tracker.Protocol
+import Data.Torrent.InfoHash
+import Network.BitTorrent.Tracker.Message
 
+-- | Set of tracker RPCs.
+class Tracker s where
+  connect  :: URI -> IO s
+  announce :: s -> AnnounceQuery -> IO AnnounceInfo
+  scrape   :: s -> ScrapeQuery   -> IO Scrape
+
+-- | More particular version of 'scrape', just for one torrent.
+--
+scrapeOne :: Tracker t => t -> InfoHash -> IO ScrapeInfo
+scrapeOne uri ih = scrape uri [ih] >>= maybe err return . M.lookup ih
+  where
+    err = throwIO $ userError "unable to find info hash in response dict"
 
 data HTTPTracker = HTTPTracker
   { announceURI :: URI
@@ -40,17 +54,12 @@ data HTTPTracker = HTTPTracker
 instance Tracker HTTPTracker where
   connect  = return . HTTPTracker
   announce = announceHTTP
-  scrape   = scrapeHTTP
+--  scrape   = scrapeHTTP
 
 {-----------------------------------------------------------------------
   Announce
 -----------------------------------------------------------------------}
 
-encodeRequest :: URI -> AnnounceQuery -> URI
-encodeRequest announceURI req = URL.urlEncode req
-                    `addToURI`      announceURI
-                    `addHashToURI`  reqInfoHash req
-
 mkGET :: URI -> Request ByteString
 mkGET uri = Request uri GET [] ""
 
@@ -64,14 +73,14 @@ announceHTTP HTTPTracker {..} req = do
 
     rawResp  <- simpleHTTP r
     respBody <- getResponseBody rawResp
-    checkResult $ decoded respBody
+    checkResult $ decode respBody
   where
     checkResult (Left err)
       = ioError $ userError $ err ++ " in tracker response"
     checkResult (Right (Failure err))
       = ioError $ userError $ show err ++ " in tracker response"
     checkResult (Right resp)          = return resp
-
+{-
 {-----------------------------------------------------------------------
   Scrape
 -----------------------------------------------------------------------}
@@ -109,8 +118,9 @@ scrapeHTTP HTTPTracker {..} ihs
   | Just uri <- scrapeURL announceURI ihs = do
     rawResp  <- simpleHTTP (Request uri GET [] "")
     respBody <- getResponseBody rawResp
-    case decoded (BC.pack respBody) of
+    case decode (BC.pack respBody) of
       Left  e -> throwIO $ userError $ e ++ " in scrape response"
       Right r -> return r
 
   | otherwise = throwIO $ userError "Tracker do not support scraping"
+-}
\ No newline at end of file
diff --git a/src/Network/BitTorrent/Tracker/Message.hs b/src/Network/BitTorrent/Tracker/Message.hs
index c46d5d58..508ff4c5 100644
--- a/src/Network/BitTorrent/Tracker/Message.hs
+++ b/src/Network/BitTorrent/Tracker/Message.hs
@@ -25,23 +25,20 @@
 {-# OPTIONS -fno-warn-orphans           #-}
 module Network.BitTorrent.Tracker.Message
        ( -- * Announce
+         -- ** Request
          Event(..)
        , AnnounceQuery(..)
+       , encodeRequest
+
+         -- ** Response
        , PeerList (..)
        , AnnounceInfo(..)
-
-         -- ** Defaults
        , defaultNumWant
-       , defaultPorts
 
          -- * Scrape
        , ScrapeQuery
        , ScrapeInfo(..)
        , Scrape
-
-         -- * TODO
-       , Tracker(..)
-       , scrapeOne
        )
        where
 
@@ -212,10 +209,16 @@ instance Serialize AnnounceQuery where
       , reqEvent      = ev
       }
 
+encodeRequest :: URI -> AnnounceQuery -> URI
+encodeRequest announceURI req = URL.urlEncode req
+                    `addToURI`      announceURI
+                    `addHashToURI`  reqInfoHash req
+
 {-----------------------------------------------------------------------
 --  Announce response
 -----------------------------------------------------------------------}
 
+-- | For more info see: <http://www.bittorrent.org/beps/bep_0023.html>
 data PeerList
   =        PeerList { getPeerList :: [PeerAddr] }
   | CompactPeerList { getPeerList :: [PeerAddr] }
@@ -323,24 +326,16 @@ instance Serialize AnnounceInfo where
       , respPeers       = PeerList peers
       }
 
--- TODO move this somewhere else
--- | Ports typically reserved for bittorrent P2P listener.
-defaultPorts :: [PortNumber]
-defaultPorts =  [6881..6889]
-
 -- | Above 25, new peers are highly unlikely to increase download
 --   speed.  Even 30 peers is /plenty/, the official client version 3
 --   in fact only actively forms new connections if it has less than
 --   30 peers and will refuse connections if it has 55.
 --
---   So the default value is set to 50 because usually 30-50% of peers
---   are not responding.
+--   <https://wiki.theory.org/BitTorrent_Tracker_Protocol#Basic_Tracker_Announce_Request>
 --
 defaultNumWant :: Int
 defaultNumWant = 50
 
--- default value here: <https://wiki.theory.org/BitTorrent_Tracker_Protocol>
-
 {-----------------------------------------------------------------------
   Scrape message
 -----------------------------------------------------------------------}
@@ -384,7 +379,7 @@ instance BEncode ScrapeInfo where
                <*>! "incomplete"
                <*>? "name"
 
--- | UDP tracker protocol complatble encoding.
+-- | UDP tracker protocol compatible encoding.
 instance Serialize ScrapeInfo where
   put ScrapeInfo {..} = do
     putWord32be $ fromIntegral siComplete
@@ -402,16 +397,3 @@ instance Serialize ScrapeInfo where
       , siIncomplete = fromIntegral leechers
       , siName       = Nothing
       }
-
--- | Set of tracker RPCs.
-class Tracker s where
-  connect  :: URI -> IO s
-  announce :: s -> AnnounceQuery -> IO AnnounceInfo
-  scrape   :: s -> ScrapeQuery   -> IO Scrape
-
--- | More particular version of 'scrape', just for one torrent.
---
-scrapeOne :: Tracker t => t -> InfoHash -> IO ScrapeInfo
-scrapeOne uri ih = scrape uri [ih] >>= maybe err return . M.lookup ih
-  where
-    err = throwIO $ userError "unable to find info hash in response dict"