diff options
Diffstat (limited to 'src/Network/BitTorrent/PeerWire')
-rw-r--r-- | src/Network/BitTorrent/PeerWire/Block.hs | 56 | ||||
-rw-r--r-- | src/Network/BitTorrent/PeerWire/Handshake.hs | 79 | ||||
-rw-r--r-- | src/Network/BitTorrent/PeerWire/Message.hs | 91 |
3 files changed, 226 insertions, 0 deletions
diff --git a/src/Network/BitTorrent/PeerWire/Block.hs b/src/Network/BitTorrent/PeerWire/Block.hs new file mode 100644 index 00000000..33e3dead --- /dev/null +++ b/src/Network/BitTorrent/PeerWire/Block.hs | |||
@@ -0,0 +1,56 @@ | |||
1 | module Network.BitTorrent.PeerWire.Block | ||
2 | ( BlockIx(..), Block(..) | ||
3 | , defaultBlockSize | ||
4 | , blockRange, ixRange, pieceIx | ||
5 | , isPiece | ||
6 | ) where | ||
7 | |||
8 | import Data.ByteString (ByteString) | ||
9 | import qualified Data.ByteString as B | ||
10 | import Data.Int | ||
11 | |||
12 | |||
13 | data BlockIx = BlockIx { | ||
14 | ixPiece :: {-# UNPACK #-} !Int -- ^ Zero-based piece index. | ||
15 | , ixOffset :: {-# UNPACK #-} !Int -- ^ Zero-based byte offset within the piece. | ||
16 | , ixLength :: {-# UNPACK #-} !Int -- ^ Block size starting from offset. | ||
17 | } deriving (Show, Eq) | ||
18 | |||
19 | data Block = Block { | ||
20 | blkPiece :: Int -- ^ Zero-based piece index. | ||
21 | , blkOffset :: Int -- ^ Zero-based byte offset within the piece. | ||
22 | , blkData :: ByteString -- ^ Payload. | ||
23 | } deriving (Show, Eq) | ||
24 | |||
25 | |||
26 | -- | Widely used semi-official block size. | ||
27 | defaultBlockSize :: Int | ||
28 | defaultBlockSize = 16 * 1024 | ||
29 | |||
30 | |||
31 | isPiece :: Int -> Block -> Bool | ||
32 | isPiece pieceSize (Block i offset bs) = | ||
33 | offset == 0 && B.length bs == pieceSize && i >= 0 | ||
34 | {-# INLINE isPiece #-} | ||
35 | |||
36 | pieceIx :: Int -> Int -> BlockIx | ||
37 | pieceIx i = BlockIx i 0 | ||
38 | {-# INLINE pieceIx #-} | ||
39 | |||
40 | blockRange :: (Num a, Integral a) => Int -> Block -> (a, a) | ||
41 | blockRange pieceSize blk = (offset, offset + len) | ||
42 | where | ||
43 | offset = fromIntegral pieceSize * fromIntegral (blkPiece blk) | ||
44 | + fromIntegral (blkOffset blk) | ||
45 | len = fromIntegral (B.length (blkData blk)) | ||
46 | {-# INLINE blockRange #-} | ||
47 | {-# SPECIALIZE blockRange :: Int -> Block -> (Int64, Int64) #-} | ||
48 | |||
49 | ixRange :: (Num a, Integral a) => Int -> BlockIx -> (a, a) | ||
50 | ixRange pieceSize ix = (offset, offset + len) | ||
51 | where | ||
52 | offset = fromIntegral pieceSize * fromIntegral (ixPiece ix) | ||
53 | + fromIntegral (ixOffset ix) | ||
54 | len = fromIntegral (ixLength ix) | ||
55 | {-# INLINE ixRange #-} | ||
56 | {-# SPECIALIZE ixRange :: Int -> BlockIx -> (Int64, Int64) #-} | ||
diff --git a/src/Network/BitTorrent/PeerWire/Handshake.hs b/src/Network/BitTorrent/PeerWire/Handshake.hs new file mode 100644 index 00000000..6ce37887 --- /dev/null +++ b/src/Network/BitTorrent/PeerWire/Handshake.hs | |||
@@ -0,0 +1,79 @@ | |||
1 | -- | | ||
2 | -- Copyright : (c) Sam T. 2013 | ||
3 | -- License : MIT | ||
4 | -- Maintainer : pxqr.sta@gmail.com | ||
5 | -- Stability : experimental | ||
6 | -- Portability : portable | ||
7 | -- | ||
8 | {-# LANGUAGE OverloadedStrings #-} | ||
9 | module Network.BitTorrent.PeerWire.Handshake | ||
10 | ( Handshake | ||
11 | , handshakeMaxSize | ||
12 | , defaultBTProtocol, defaultReserved, defaultHandshake | ||
13 | , handshake | ||
14 | ) where | ||
15 | |||
16 | import Control.Applicative | ||
17 | import Data.Word | ||
18 | import Data.ByteString (ByteString) | ||
19 | import qualified Data.ByteString as B | ||
20 | import Data.Serialize as S | ||
21 | import Data.Torrent.InfoHash | ||
22 | import Network | ||
23 | import Network.Socket.ByteString | ||
24 | |||
25 | import Network.BitTorrent.PeerID | ||
26 | |||
27 | |||
28 | -- | In order to establish the connection between peers we should send 'Handshake' | ||
29 | -- message. The 'Handshake' is a required message and must be the first message | ||
30 | -- transmitted by the peer to the another peer. | ||
31 | data Handshake = Handshake { | ||
32 | hsProtocol :: ByteString -- ^ Identifier of the protocol. | ||
33 | , hsReserved :: Word64 -- ^ Reserved bytes, rarely used. | ||
34 | , hsInfoHash :: InfoHash -- ^ Hash from the metainfo file. | ||
35 | -- This /should be/ same hash that is transmitted in tracker requests. | ||
36 | , hsPeerID :: PeerID -- ^ Peer id of the initiator. | ||
37 | -- This is /usually the same peer id that is transmitted in tracker requests. | ||
38 | } deriving (Show, Eq) | ||
39 | |||
40 | instance Serialize Handshake where | ||
41 | put hs = do | ||
42 | putWord8 (fromIntegral (B.length (hsProtocol hs))) | ||
43 | putByteString (hsProtocol hs) | ||
44 | putWord64be (hsReserved hs) | ||
45 | put (hsInfoHash hs) | ||
46 | put (hsPeerID hs) | ||
47 | |||
48 | get = do | ||
49 | len <- getWord8 | ||
50 | Handshake <$> getBytes (fromIntegral len) | ||
51 | <*> getWord64be | ||
52 | <*> get | ||
53 | <*> get | ||
54 | |||
55 | -- | Maximum size of handshake message in bytes. | ||
56 | handshakeMaxSize :: Int | ||
57 | handshakeMaxSize = 1 + 256 + 8 + 20 + 20 | ||
58 | |||
59 | -- | Default protocol string "BitTorrent protocol" as is. | ||
60 | defaultBTProtocol :: ByteString | ||
61 | defaultBTProtocol = "BitTorrent protocol" | ||
62 | |||
63 | -- | Default reserved word is 0. | ||
64 | defaultReserved :: Word64 | ||
65 | defaultReserved = 0 | ||
66 | |||
67 | -- | Length of info hash and peer id is unchecked, so it /should/ be equal 20. | ||
68 | defaultHandshake :: InfoHash -> PeerID -> Handshake | ||
69 | defaultHandshake = Handshake defaultBTProtocol defaultReserved | ||
70 | |||
71 | |||
72 | -- TODO check if hash the same | ||
73 | -- | Handshaking with a peer specified by the second argument. | ||
74 | -- | ||
75 | handshake :: Socket -> Handshake -> IO (Either String Handshake) | ||
76 | handshake sock hs = do | ||
77 | sendAll sock (S.encode hs) | ||
78 | r <- recv sock handshakeMaxSize | ||
79 | return (S.decode r) | ||
diff --git a/src/Network/BitTorrent/PeerWire/Message.hs b/src/Network/BitTorrent/PeerWire/Message.hs new file mode 100644 index 00000000..1bcb2ee5 --- /dev/null +++ b/src/Network/BitTorrent/PeerWire/Message.hs | |||
@@ -0,0 +1,91 @@ | |||
1 | module Network.BitTorrent.PeerWire.Message | ||
2 | ( Message(..) | ||
3 | ) where | ||
4 | |||
5 | import Control.Applicative | ||
6 | import Data.ByteString (ByteString) | ||
7 | import qualified Data.ByteString as B | ||
8 | |||
9 | import Data.Serialize | ||
10 | |||
11 | import Network.BitTorrent.PeerWire.Block | ||
12 | |||
13 | |||
14 | -- TODO comment message constructors | ||
15 | data Message = KeepAlive | ||
16 | | Choke | ||
17 | | Unchoke | ||
18 | | Interested | ||
19 | | NotInterested | ||
20 | | Have Int | ||
21 | | Bitfield ByteString | ||
22 | | Request BlockIx | ||
23 | | Piece Block | ||
24 | | Cancel BlockIx | ||
25 | | Port Int | ||
26 | deriving (Show, Eq) | ||
27 | |||
28 | instance Serialize BlockIx where | ||
29 | {-# SPECIALIZE instance Serialize BlockIx #-} | ||
30 | get = BlockIx <$> getInt <*> getInt <*> getInt | ||
31 | {-# INLINE get #-} | ||
32 | |||
33 | put ix = do putInt (ixPiece ix) | ||
34 | putInt (ixOffset ix) | ||
35 | putInt (ixLength ix) | ||
36 | {-# INLINE put #-} | ||
37 | |||
38 | instance Serialize Message where | ||
39 | get = do | ||
40 | len <- getInt | ||
41 | lookAhead $ ensure len | ||
42 | if len == 0 then return KeepAlive -- FIX check if BS is empty instead of reading len | ||
43 | else do | ||
44 | mid <- getWord8 | ||
45 | case mid of | ||
46 | 0 -> return Choke | ||
47 | 1 -> return Unchoke | ||
48 | 2 -> return Interested | ||
49 | 3 -> return NotInterested | ||
50 | 4 -> Have <$> getInt | ||
51 | 5 -> Bitfield <$> getBytes (pred len) | ||
52 | 6 -> Request <$> get | ||
53 | 7 -> Piece <$> getBlock (len - 9) | ||
54 | 8 -> Cancel <$> get | ||
55 | 9 -> (Port . fromIntegral) <$> getWord16be | ||
56 | _ -> fail $ "unknown message ID: " ++ show mid | ||
57 | |||
58 | where | ||
59 | getBlock :: Int -> Get Block | ||
60 | getBlock len = Block <$> getInt <*> getInt <*> getBytes len | ||
61 | {-# INLINE getBlock #-} | ||
62 | |||
63 | put KeepAlive = putInt 0 | ||
64 | put Choke = putInt 1 >> putWord8 0 | ||
65 | put Unchoke = putInt 1 >> putWord8 1 | ||
66 | put Interested = putInt 1 >> putWord8 2 | ||
67 | put NotInterested = putInt 1 >> putWord8 3 | ||
68 | put (Have i) = putInt 5 >> putWord8 4 >> putInt i | ||
69 | put (Bitfield b) = putInt l >> putWord8 5 >> putByteString b | ||
70 | where l = succ (B.length b) | ||
71 | {-# INLINE l #-} | ||
72 | put (Request blk) = putInt 13 >> putWord8 6 >> put blk | ||
73 | put (Piece blk) = putInt l >> putWord8 7 >> putBlock | ||
74 | where l = 9 + B.length (blkData blk) | ||
75 | {-# INLINE l #-} | ||
76 | putBlock = do putInt (blkPiece blk) | ||
77 | putInt (blkOffset blk) | ||
78 | putByteString (blkData blk) | ||
79 | {-# INLINE putBlock #-} | ||
80 | |||
81 | put (Cancel blk) = putInt 13 >> putWord8 8 >> put blk | ||
82 | put (Port p ) = putInt 3 >> putWord8 9 >> putWord16be (fromIntegral p) | ||
83 | |||
84 | |||
85 | getInt :: Get Int | ||
86 | getInt = fromIntegral <$> getWord32be | ||
87 | {-# INLINE getInt #-} | ||
88 | |||
89 | putInt :: Putter Int | ||
90 | putInt = putWord32be . fromIntegral | ||
91 | {-# INLINE putInt #-} | ||