1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
|
-- |
-- Copyright : (c) Sam Truzjan 2013
-- License : BSD3
-- Maintainer : pxqr.sta@gmail.com
-- Stability : experimental
-- Portability : portable
--
-- 'ClientInfo' is used to identify the client implementation and
-- version which also contained in 'Peer'. For exsample first 6
-- bytes of peer id of this this library are @-HS0100-@ while for
-- mainline we have @M4-3-6--@. We could extract this info and
-- print in human-friendly form: this is useful for debugging and
-- logging.
--
-- For more information see:
-- <http://bittorrent.org/beps/bep_0020.html>
--
--
-- NOTE: Do _not_ use this information to control client
-- capabilities (such as supported enchancements), this should be
-- done using 'Network.BitTorrent.Extension'!
--
module Data.Torrent.Client
( -- * Client implementation
ClientImpl (..)
, ppClientImpl
-- * Client version
, ClientVersion (..)
, ppClientVersion
-- * Client information
, ClientInfo (..)
, ppClientInfo
, libClientInfo
) where
import Control.Applicative
import Data.ByteString as BS
import Data.ByteString.Char8 as BC
import Data.Default
import Data.List as L
import Data.Monoid
import Data.Text as T
import Data.Version
import Text.PrettyPrint hiding ((<>))
import Paths_bittorrent (version)
-- | List of registered client versions + IlibHSbittorrent (this
-- package) + Unknown (for not recognized software). All names are
-- prefixed by "I" because some of them starts from lowercase letter
-- but that is not a valid Haskell constructor name.
--
data ClientImpl =
IUnknown
| IAres
| IArctic
| IAvicora
| IBitPump
| IAzureus
| IBitBuddy
| IBitComet
| IBitflu
| IBTG
| IBitRocket
| IBTSlave
| IBittorrentX
| IEnhancedCTorrent
| ICTorrent
| IDelugeTorrent
| IPropagateDataClient
| IEBit
| IElectricSheep
| IFoxTorrent
| IGSTorrent
| IHalite
| IlibHSbittorrent
| IHydranode
| IKGet
| IKTorrent
| ILH_ABC
| ILphant
| ILibtorrent
| ILibTorrent
| ILimeWire
| IMonoTorrent
| IMooPolice
| IMiro
| IMoonlightTorrent
| INetTransport
| IPando
| IqBittorrent
| IQQDownload
| IQt4TorrentExample
| IRetriever
| IShareaza
| ISwiftbit
| ISwarmScope
| ISymTorrent
| Isharktorrent
| ITorrentDotNET
| ITransmission
| ITorrentstorm
| ITuoTu
| IuLeecher
| IuTorrent
| IVagaa
| IBitLet
| IFireTorrent
| IXunlei
| IXanTorrent
| IXtorrent
| IZipTorrent
deriving (Show, Eq, Ord, Enum, Bounded)
-- | Used to represent a not recognized implementation
instance Default ClientImpl where
def = IUnknown
-- | Format client implementation info in human-readable form.
ppClientImpl :: ClientImpl -> Doc
ppClientImpl = text . L.tail . show
-- | Version of client software, normally extracted from peer id.
newtype ClientVersion = ClientVersion { getClientVersion :: Version }
deriving (Show, Eq, Ord)
-- | Just the '0' version.
instance Default ClientVersion where
def = ClientVersion $ Version [0] []
-- | Format client implementation version in human-readable form.
ppClientVersion :: ClientVersion -> Doc
ppClientVersion = text . showVersion . getClientVersion
-- | The all sensible infomation that can be obtained from a peer
-- identifier or torrent /createdBy/ field.
data ClientInfo = ClientInfo {
ciImpl :: ClientImpl
, ciVersion :: ClientVersion
} deriving (Show, Eq, Ord)
-- | Unrecognized client implementation.
instance Default ClientInfo where
def = ClientInfo def def
-- | Format client info in human-readable form.
ppClientInfo :: ClientInfo -> Doc
ppClientInfo ClientInfo {..} =
ppClientImpl ciImpl <+> "version" <+> ppClientVersion ciVersion
-- | Client info of this (the bittorrent library) package. Normally,
-- applications should introduce its own idenitifiers, otherwise they
-- can use 'libClientInfo' value.
--
libClientInfo :: ClientInfo
libClientInfo = ClientInfo IlibHSbittorrent (ClientVersion version)
{-----------------------------------------------------------------------
-- For torrent file
-----------------------------------------------------------------------}
renderImpl :: ClientImpl -> Text
renderImpl = T.pack . L.tail . show
renderVersion :: ClientVersion -> Text
renderVersion = undefined
renderClientInfo :: ClientInfo -> Text
renderClientInfo ClientInfo {..} = renderImpl ciImpl <> "/" <> renderVersion ciVersion
parseClientInfo :: Text -> ClientImpl
parseClientInfo t = undefined
{-
-- code used for generation; remove it later on
mkEnumTyDef :: NM -> String
mkEnumTyDef = unlines . map (" | I" ++) . nub . map snd
mkPars :: NM -> String
mkPars = unlines . map (\(code, impl) -> " f \"" ++ code ++ "\" = " ++ "I" ++ impl)
type NM = [(String, String)]
nameMap :: NM
nameMap =
[ ("AG", "Ares")
, ("A~", "Ares")
, ("AR", "Arctic")
, ("AV", "Avicora")
, ("AX", "BitPump")
, ("AZ", "Azureus")
, ("BB", "BitBuddy")
, ("BC", "BitComet")
, ("BF", "Bitflu")
, ("BG", "BTG")
, ("BR", "BitRocket")
, ("BS", "BTSlave")
, ("BX", "BittorrentX")
, ("CD", "EnhancedCTorrent")
, ("CT", "CTorrent")
, ("DE", "DelugeTorrent")
, ("DP", "PropagateDataClient")
, ("EB", "EBit")
, ("ES", "ElectricSheep")
, ("FT", "FoxTorrent")
, ("GS", "GSTorrent")
, ("HL", "Halite")
, ("HS", "libHSnetwork_bittorrent")
, ("HN", "Hydranode")
, ("KG", "KGet")
, ("KT", "KTorrent")
, ("LH", "LH_ABC")
, ("LP", "Lphant")
, ("LT", "Libtorrent")
, ("lt", "LibTorrent")
, ("LW", "LimeWire")
, ("MO", "MonoTorrent")
, ("MP", "MooPolice")
, ("MR", "Miro")
, ("MT", "MoonlightTorrent")
, ("NX", "NetTransport")
, ("PD", "Pando")
, ("qB", "qBittorrent")
, ("QD", "QQDownload")
, ("QT", "Qt4TorrentExample")
, ("RT", "Retriever")
, ("S~", "Shareaza")
, ("SB", "Swiftbit")
, ("SS", "SwarmScope")
, ("ST", "SymTorrent")
, ("st", "sharktorrent")
, ("SZ", "Shareaza")
, ("TN", "TorrentDotNET")
, ("TR", "Transmission")
, ("TS", "Torrentstorm")
, ("TT", "TuoTu")
, ("UL", "uLeecher")
, ("UT", "uTorrent")
, ("VG", "Vagaa")
, ("WT", "BitLet")
, ("WY", "FireTorrent")
, ("XL", "Xunlei")
, ("XT", "XanTorrent")
, ("XX", "Xtorrent")
, ("ZT", "ZipTorrent")
]
-}
|
