diff options
author | Sam Truzjan <pxqr.sta@gmail.com> | 2013-12-05 04:58:26 +0400 |
---|---|---|
committer | Sam Truzjan <pxqr.sta@gmail.com> | 2013-12-05 04:58:26 +0400 |
commit | fda80933f98f6998ac872ab617026ecf06e4768c (patch) | |
tree | 60da38644cd3ce07884db666af1d8f105986a927 /src/Network/BitTorrent/Core | |
parent | 3399beaf2f38d19ed615655f865f3bc8b0cb9309 (diff) |
Rename ClientInfo datatype to Fingerprint
Diffstat (limited to 'src/Network/BitTorrent/Core')
-rw-r--r-- | src/Network/BitTorrent/Core/Fingerprint.hs | 32 | ||||
-rw-r--r-- | src/Network/BitTorrent/Core/PeerAddr.hs | 2 | ||||
-rw-r--r-- | src/Network/BitTorrent/Core/PeerId.hs | 20 |
3 files changed, 27 insertions, 27 deletions
diff --git a/src/Network/BitTorrent/Core/Fingerprint.hs b/src/Network/BitTorrent/Core/Fingerprint.hs index e2fbb777..a81edd8b 100644 --- a/src/Network/BitTorrent/Core/Fingerprint.hs +++ b/src/Network/BitTorrent/Core/Fingerprint.hs | |||
@@ -5,7 +5,7 @@ | |||
5 | -- Stability : experimental | 5 | -- Stability : experimental |
6 | -- Portability : portable | 6 | -- Portability : portable |
7 | -- | 7 | -- |
8 | -- 'ClientInfo' is used to identify the client implementation and | 8 | -- 'Fingerprint' is used to identify the client implementation and |
9 | -- version which also contained in 'Peer'. For exsample first 6 | 9 | -- version which also contained in 'Peer'. For exsample first 6 |
10 | -- bytes of peer id of this this library are @-HS0100-@ while for | 10 | -- bytes of peer id of this this library are @-HS0100-@ while for |
11 | -- mainline we have @M4-3-6--@. We could extract this info and | 11 | -- mainline we have @M4-3-6--@. We could extract this info and |
@@ -23,8 +23,8 @@ | |||
23 | {-# OPTIONS -fno-warn-orphans #-} | 23 | {-# OPTIONS -fno-warn-orphans #-} |
24 | module Network.BitTorrent.Core.Fingerprint | 24 | module Network.BitTorrent.Core.Fingerprint |
25 | ( ClientImpl (..) | 25 | ( ClientImpl (..) |
26 | , ClientInfo (..) | 26 | , Fingerprint (..) |
27 | , libClientInfo | 27 | , libFingerprint |
28 | ) where | 28 | ) where |
29 | 29 | ||
30 | import Data.Default | 30 | import Data.Default |
@@ -162,33 +162,33 @@ instance Pretty Version where | |||
162 | 162 | ||
163 | -- | The all sensible infomation that can be obtained from a peer | 163 | -- | The all sensible infomation that can be obtained from a peer |
164 | -- identifier or torrent /createdBy/ field. | 164 | -- identifier or torrent /createdBy/ field. |
165 | data ClientInfo = ClientInfo { | 165 | data Fingerprint = Fingerprint |
166 | ciImpl :: ClientImpl | 166 | { ciImpl :: ClientImpl |
167 | , ciVersion :: Version | 167 | , ciVersion :: Version |
168 | } deriving (Show, Eq, Ord) | 168 | } deriving (Show, Eq, Ord) |
169 | 169 | ||
170 | -- | Unrecognized client implementation. | 170 | -- | Unrecognized client implementation. |
171 | instance Default ClientInfo where | 171 | instance Default Fingerprint where |
172 | def = ClientInfo def def | 172 | def = Fingerprint def def |
173 | {-# INLINE def #-} | 173 | {-# INLINE def #-} |
174 | 174 | ||
175 | -- | Example: @\"BitComet-1.2\" == ClientInfo IBitComet (Version [1, 2] [])@ | 175 | -- | Example: @\"BitComet-1.2\" == ClientInfo IBitComet (Version [1, 2] [])@ |
176 | instance IsString ClientInfo where | 176 | instance IsString Fingerprint where |
177 | fromString str | 177 | fromString str |
178 | | _ : ver <- _ver = ClientInfo (fromString impl) (fromString ver) | 178 | | _ : ver <- _ver = Fingerprint (fromString impl) (fromString ver) |
179 | | otherwise = error $ "fromString: invalid client info string" ++ str | 179 | | otherwise = error $ "fromString: invalid client info string" ++ str |
180 | where | 180 | where |
181 | (impl, _ver) = L.span ((/=) '-') str | 181 | (impl, _ver) = L.span ((/=) '-') str |
182 | 182 | ||
183 | instance Pretty ClientInfo where | 183 | instance Pretty Fingerprint where |
184 | pretty ClientInfo {..} = pretty ciImpl <+> "version" <+> pretty ciVersion | 184 | pretty Fingerprint {..} = pretty ciImpl <+> "version" <+> pretty ciVersion |
185 | 185 | ||
186 | -- | Client info of this (the bittorrent library) package. Normally, | 186 | -- | Fingerprint of this (the bittorrent library) package. Normally, |
187 | -- applications should introduce its own idenitifiers, otherwise they | 187 | -- applications should introduce its own fingerprints, otherwise they |
188 | -- can use 'libClientInfo' value. | 188 | -- can use 'libFingerprint' value. |
189 | -- | 189 | -- |
190 | libClientInfo :: ClientInfo | 190 | libFingerprint :: Fingerprint |
191 | libClientInfo = ClientInfo IlibHSbittorrent version | 191 | libFingerprint = Fingerprint IlibHSbittorrent version |
192 | 192 | ||
193 | {----------------------------------------------------------------------- | 193 | {----------------------------------------------------------------------- |
194 | -- For torrent file | 194 | -- For torrent file |
diff --git a/src/Network/BitTorrent/Core/PeerAddr.hs b/src/Network/BitTorrent/Core/PeerAddr.hs index 81754e5e..5173c4fc 100644 --- a/src/Network/BitTorrent/Core/PeerAddr.hs +++ b/src/Network/BitTorrent/Core/PeerAddr.hs | |||
@@ -89,7 +89,7 @@ instance Serialize PeerAddr where | |||
89 | 89 | ||
90 | instance Pretty PeerAddr where | 90 | instance Pretty PeerAddr where |
91 | pretty p @ PeerAddr {..} | 91 | pretty p @ PeerAddr {..} |
92 | | Just pid <- peerID = pretty (clientInfo pid) <+> "at" <+> paddr | 92 | | Just pid <- peerID = pretty (fingerprint pid) <+> "at" <+> paddr |
93 | | otherwise = paddr | 93 | | otherwise = paddr |
94 | where | 94 | where |
95 | paddr = text (show (peerSockAddr p)) | 95 | paddr = text (show (peerSockAddr p)) |
diff --git a/src/Network/BitTorrent/Core/PeerId.hs b/src/Network/BitTorrent/Core/PeerId.hs index 8deb854a..f30308d4 100644 --- a/src/Network/BitTorrent/Core/PeerId.hs +++ b/src/Network/BitTorrent/Core/PeerId.hs | |||
@@ -30,7 +30,7 @@ module Network.BitTorrent.Core.PeerId | |||
30 | , defaultVersionNumber | 30 | , defaultVersionNumber |
31 | 31 | ||
32 | -- * Decoding | 32 | -- * Decoding |
33 | , clientInfo | 33 | , fingerprint |
34 | ) where | 34 | ) where |
35 | 35 | ||
36 | import Control.Applicative | 36 | import Control.Applicative |
@@ -175,7 +175,7 @@ defaultClientId = "HS" | |||
175 | -- package. Version is taken from .cabal file. | 175 | -- package. Version is taken from .cabal file. |
176 | defaultVersionNumber :: ByteString | 176 | defaultVersionNumber :: ByteString |
177 | defaultVersionNumber = BS.take 4 $ BC.pack $ foldMap show $ | 177 | defaultVersionNumber = BS.take 4 $ BC.pack $ foldMap show $ |
178 | versionBranch $ ciVersion libClientInfo | 178 | versionBranch $ ciVersion libFingerprint |
179 | 179 | ||
180 | {----------------------------------------------------------------------- | 180 | {----------------------------------------------------------------------- |
181 | -- Generation | 181 | -- Generation |
@@ -294,23 +294,23 @@ parseImpl = f . BC.unpack | |||
294 | -- peer id uses unknown coding style then client info returned is | 294 | -- peer id uses unknown coding style then client info returned is |
295 | -- 'def'. | 295 | -- 'def'. |
296 | -- | 296 | -- |
297 | clientInfo :: PeerId -> ClientInfo | 297 | fingerprint :: PeerId -> Fingerprint |
298 | clientInfo pid = either (const def) id $ runGet getCI (getPeerId pid) | 298 | fingerprint pid = either (const def) id $ runGet getCI (getPeerId pid) |
299 | where | 299 | where |
300 | getCI = do | 300 | getCI = do |
301 | leading <- BS.w2c <$> getWord8 | 301 | leading <- BS.w2c <$> getWord8 |
302 | case leading of | 302 | case leading of |
303 | '-' -> ClientInfo <$> getAzureusImpl <*> getAzureusVersion | 303 | '-' -> Fingerprint <$> getAzureusImpl <*> getAzureusVersion |
304 | 'M' -> ClientInfo <$> pure IMainline <*> getMainlineVersion | 304 | 'M' -> Fingerprint <$> pure IMainline <*> getMainlineVersion |
305 | 'e' -> ClientInfo <$> getBitCometImpl <*> getBitCometVersion | 305 | 'e' -> Fingerprint <$> getBitCometImpl <*> getBitCometVersion |
306 | 'F' -> ClientInfo <$> getBitCometImpl <*> getBitCometVersion | 306 | 'F' -> Fingerprint <$> getBitCometImpl <*> getBitCometVersion |
307 | c -> do | 307 | c -> do |
308 | c1 <- w2c <$> lookAhead getWord8 | 308 | c1 <- w2c <$> lookAhead getWord8 |
309 | if c1 == 'P' | 309 | if c1 == 'P' |
310 | then do | 310 | then do |
311 | _ <- getWord8 | 311 | _ <- getWord8 |
312 | ClientInfo <$> pure IOpera <*> getOperaVersion | 312 | Fingerprint <$> pure IOpera <*> getOperaVersion |
313 | else ClientInfo <$> pure (getShadowImpl c) <*> getShadowVersion | 313 | else Fingerprint <$> pure (getShadowImpl c) <*> getShadowVersion |
314 | 314 | ||
315 | getMainlineVersion = do | 315 | getMainlineVersion = do |
316 | str <- BC.unpack <$> getByteString 7 | 316 | str <- BC.unpack <$> getByteString 7 |