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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
//! Messaging primitives for scraping.

use std::borrow::Cow;
use std::io::{self, Write};

use bip_util::bt::{self, InfoHash};
use bip_util::convert;
use nom::{IResult, Needed, be_i32};

const SCRAPE_STATS_BYTES: usize = 12;

/// Status for a given InfoHash.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct ScrapeStats {
    seeders: i32,
    downloaded: i32,
    leechers: i32,
}

impl ScrapeStats {
    /// Create a new ScrapeStats.
    pub fn new(seeders: i32, downloaded: i32, leechers: i32) -> ScrapeStats {
        ScrapeStats {
            seeders: seeders,
            downloaded: downloaded,
            leechers: leechers,
        }
    }

    /// Construct a ScrapeStats from the given bytes.
    fn from_bytes(bytes: &[u8]) -> IResult<&[u8], ScrapeStats> {
        parse_stats(bytes)
    }

    /// Current number of seeders.
    pub fn num_seeders(&self) -> i32 {
        self.seeders
    }

    /// Number of times it has been downloaded.
    pub fn num_downloads(&self) -> i32 {
        self.downloaded
    }

    /// Current number of leechers.
    pub fn num_leechers(&self) -> i32 {
        self.leechers
    }
}

fn parse_stats(bytes: &[u8]) -> IResult<&[u8], ScrapeStats> {
    chain!(bytes,
        seeders:    be_i32 ~
        downloaded: be_i32 ~
        leechers:   be_i32 ,
        || { ScrapeStats::new(seeders, downloaded, leechers) }
    )
}

// ----------------------------------------------------------------------------//

/// Scrape request sent from the client to the server.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ScrapeRequest<'a> {
    hashes: Cow<'a, [u8]>,
}

impl<'a> ScrapeRequest<'a> {
    /// Create a new ScrapeRequest.
    pub fn new() -> ScrapeRequest<'a> {
        ScrapeRequest { hashes: Cow::Owned(Vec::new()) }
    }

    /// Construct a ScrapeRequest from the given bytes.
    pub fn from_bytes(bytes: &'a [u8]) -> IResult<&'a [u8], ScrapeRequest<'a>> {
        parse_request(bytes)
    }

    /// Write the ScrapeRequest to the given writer.
    ///
    /// Ordering of the written InfoHash is identical to that of ScrapeRequest::iter().
    pub fn write_bytes<W>(&self, mut writer: W) -> io::Result<()>
        where W: Write
    {
        writer.write_all(&*self.hashes)
    }

    /// Add the InfoHash to the current request.
    pub fn insert(&mut self, hash: InfoHash) {
        let hash_bytes: [u8; bt::INFO_HASH_LEN] = hash.into();

        self.hashes.to_mut().extend_from_slice(&hash_bytes);
    }

    /// Iterator over all of the hashes in the request.
    pub fn iter<'b>(&'b self) -> ScrapeRequestIter<'b> {
        ScrapeRequestIter::new(&*self.hashes)
    }

    /// Create an owned version of ScrapeRequest.
    pub fn to_owned(&self) -> ScrapeRequest<'static> {
        ScrapeRequest { hashes: Cow::Owned((*self.hashes).to_vec()) }
    }
}

fn parse_request<'a>(bytes: &'a [u8]) -> IResult<&'a [u8], ScrapeRequest<'a>> {
    let remainder_bytes = bytes.len() % bt::INFO_HASH_LEN;

    if remainder_bytes != 0 {
        IResult::Incomplete(Needed::Size(bt::INFO_HASH_LEN - remainder_bytes))
    } else {
        let end_of_bytes = &bytes[bytes.len()..bytes.len()];

        IResult::Done(end_of_bytes, ScrapeRequest { hashes: Cow::Borrowed(bytes) })
    }
}

// ----------------------------------------------------------------------------//

/// Scrape response sent from the server to the client.
#[derive(Clone, Debug, PartialEq, Eq)]
pub struct ScrapeResponse<'a> {
    stats: Cow<'a, [u8]>,
}

impl<'a> ScrapeResponse<'a> {
    /// Create a new ScrapeResponse.
    pub fn new() -> ScrapeResponse<'a> {
        ScrapeResponse { stats: Cow::Owned(Vec::new()) }
    }

    /// Construct a ScrapeResponse from the given bytes.
    pub fn from_bytes(bytes: &'a [u8]) -> IResult<&'a [u8], ScrapeResponse<'a>> {
        parse_response(bytes)
    }

    /// Write the ScrapeResponse to the given writer.
    ///
    /// Ordering of the written stats is identical to that of ScrapeResponse::iter().
    pub fn write_bytes<W>(&self, mut writer: W) -> io::Result<()>
        where W: Write
    {
        writer.write_all(&*self.stats)
    }

    /// Add the scrape statistics to the current response.
    pub fn insert(&mut self, stats: ScrapeStats) {
        let seeders_bytes = convert::four_bytes_to_array(stats.num_seeders() as u32);
        let downloads_bytes = convert::four_bytes_to_array(stats.num_downloads() as u32);
        let leechers_bytes = convert::four_bytes_to_array(stats.num_leechers() as u32);

        self.stats.to_mut().reserve(SCRAPE_STATS_BYTES);

        self.stats.to_mut().extend_from_slice(&seeders_bytes);
        self.stats.to_mut().extend_from_slice(&downloads_bytes);
        self.stats.to_mut().extend_from_slice(&leechers_bytes);
    }

    /// Iterator over each status for every InfoHash in the request.
    ///
    /// Ordering of the status corresponds to the ordering of the InfoHash in the
    /// initial request.
    pub fn iter<'b>(&'b self) -> ScrapeResponseIter<'b> {
        ScrapeResponseIter::new(&*self.stats)
    }

    /// Create an owned version of ScrapeResponse.
    pub fn to_owned(&self) -> ScrapeResponse<'static> {
        ScrapeResponse { stats: Cow::Owned((*self.stats).to_vec()) }
    }
}

fn parse_response<'a>(bytes: &'a [u8]) -> IResult<&'a [u8], ScrapeResponse<'a>> {
    let remainder_bytes = bytes.len() % SCRAPE_STATS_BYTES;

    if remainder_bytes != 0 {
        IResult::Incomplete(Needed::Size(SCRAPE_STATS_BYTES - remainder_bytes))
    } else {
        let end_of_bytes = &bytes[bytes.len()..bytes.len()];

        IResult::Done(end_of_bytes, ScrapeResponse { stats: Cow::Borrowed(bytes) })
    }
}

// ----------------------------------------------------------------------------//

/// Iterator over a number of InfoHashes.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct ScrapeRequestIter<'a> {
    hashes: &'a [u8],
    offset: usize,
}

impl<'a> ScrapeRequestIter<'a> {
    fn new(bytes: &'a [u8]) -> ScrapeRequestIter<'a> {
        ScrapeRequestIter {
            hashes: bytes,
            offset: 0,
        }
    }
}

impl<'a> Iterator for ScrapeRequestIter<'a> {
    type Item = InfoHash;

    fn next(&mut self) -> Option<InfoHash> {
        if self.offset == self.hashes.len() {
            None
        } else {
            let (start, end) = (self.offset, self.offset + bt::INFO_HASH_LEN);
            self.offset = end;

            Some(InfoHash::from_hash(&self.hashes[start..end]).unwrap())
        }
    }
}

impl<'a> ExactSizeIterator for ScrapeRequestIter<'a> {
    fn len(&self) -> usize {
        self.hashes.len() / bt::INFO_HASH_LEN
    }
}

// ----------------------------------------------------------------------------//

/// Iterator over a number of ScrapeStats.
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub struct ScrapeResponseIter<'a> {
    stats: &'a [u8],
    offset: usize,
}

impl<'a> ScrapeResponseIter<'a> {
    fn new(bytes: &'a [u8]) -> ScrapeResponseIter<'a> {
        ScrapeResponseIter {
            stats: bytes,
            offset: 0,
        }
    }
}

impl<'a> Iterator for ScrapeResponseIter<'a> {
    type Item = ScrapeStats;

    fn next(&mut self) -> Option<ScrapeStats> {
        if self.offset == self.stats.len() {
            None
        } else {
            let (start, end) = (self.offset, self.offset + SCRAPE_STATS_BYTES);
            self.offset = end;

            match ScrapeStats::from_bytes(&self.stats[start..end]) {
                IResult::Done(_, stats) => Some(stats),
                _ => panic!("Bug In ScrapeResponseIter Caused ScrapeStats Parsing To Fail..."),
            }
        }
    }
}

impl<'a> ExactSizeIterator for ScrapeResponseIter<'a> {
    fn len(&self) -> usize {
        self.stats.len() / SCRAPE_STATS_BYTES
    }
}

#[cfg(test)]
mod tests {
    use bip_util::bt;
    use byteorder::{BigEndian, WriteBytesExt};
    use nom::IResult;

    use super::{ScrapeRequest, ScrapeResponse, ScrapeStats};

    #[test]
    fn positive_write_request_empty() {
        let mut received = Vec::new();

        let request = ScrapeRequest::new();
        request.write_bytes(&mut received).unwrap();

        let expected = [];

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_write_request_single_hash() {
        let mut received = Vec::new();

        let expected = [1u8; bt::INFO_HASH_LEN];

        let mut request = ScrapeRequest::new();
        request.insert(expected.into());
        request.write_bytes(&mut received).unwrap();

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_write_request_many_hashes() {
        let mut received = Vec::new();

        let hash_one = [1u8; bt::INFO_HASH_LEN];
        let hash_two = [34u8; bt::INFO_HASH_LEN];

        let mut expected = Vec::new();
        expected.extend_from_slice(&hash_one);
        expected.extend_from_slice(&hash_two);

        let mut request = ScrapeRequest::new();
        request.insert(hash_one.into());
        request.insert(hash_two.into());
        request.write_bytes(&mut received).unwrap();

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_write_response_empty() {
        let mut received = Vec::new();

        let response = ScrapeResponse::new();
        response.write_bytes(&mut received).unwrap();

        let expected = [];

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_write_response_single_stat() {
        let mut received = Vec::new();

        let stat_one = ScrapeStats::new(1234, 2342, 0);

        let mut response = ScrapeResponse::new();
        response.insert(stat_one);
        response.write_bytes(&mut received).unwrap();

        let mut expected = Vec::new();
        expected.write_i32::<BigEndian>(stat_one.num_seeders()).unwrap();
        expected.write_i32::<BigEndian>(stat_one.num_downloads()).unwrap();
        expected.write_i32::<BigEndian>(stat_one.num_leechers()).unwrap();

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_write_response_many_stats() {
        let mut received = Vec::new();

        let stat_one = ScrapeStats::new(1234, 2342, 0);
        let stat_two = ScrapeStats::new(3333, -23, -2323);

        let mut response = ScrapeResponse::new();
        response.insert(stat_one);
        response.insert(stat_two);
        response.write_bytes(&mut received).unwrap();

        let mut expected = Vec::new();
        expected.write_i32::<BigEndian>(stat_one.num_seeders()).unwrap();
        expected.write_i32::<BigEndian>(stat_one.num_downloads()).unwrap();
        expected.write_i32::<BigEndian>(stat_one.num_leechers()).unwrap();

        expected.write_i32::<BigEndian>(stat_two.num_seeders()).unwrap();
        expected.write_i32::<BigEndian>(stat_two.num_downloads()).unwrap();
        expected.write_i32::<BigEndian>(stat_two.num_leechers()).unwrap();

        assert_eq!(&received[..], &expected[..]);
    }

    #[test]
    fn positive_parse_request_empty() {
        let hash_one = [];

        let received = ScrapeRequest::from_bytes(&hash_one);

        let expected = ScrapeRequest::new();

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }

    #[test]
    fn positive_parse_request_single_hash() {
        let hash_one = [1u8; bt::INFO_HASH_LEN];

        let received = ScrapeRequest::from_bytes(&hash_one);

        let mut expected = ScrapeRequest::new();
        expected.insert(hash_one.into());

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }

    #[test]
    fn positive_parse_request_multiple_hashes() {
        let hash_one = [1u8; bt::INFO_HASH_LEN];
        let hash_two = [5u8; bt::INFO_HASH_LEN];

        let mut bytes = Vec::new();
        bytes.extend_from_slice(&hash_one);
        bytes.extend_from_slice(&hash_two);

        let received = ScrapeRequest::from_bytes(&bytes);

        let mut expected = ScrapeRequest::new();
        expected.insert(hash_one.into());
        expected.insert(hash_two.into());

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }

    #[test]
    fn positive_parse_response_empty() {
        let stats_bytes = [];

        let received = ScrapeResponse::from_bytes(&stats_bytes);

        let expected = ScrapeResponse::new();

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }

    #[test]
    fn positive_parse_response_single_stat() {
        let stats_bytes = [0, 0, 0, 255, 0, 0, 1, 0, 0, 0, 2, 0];

        let received = ScrapeResponse::from_bytes(&stats_bytes);

        let mut expected = ScrapeResponse::new();
        expected.insert(ScrapeStats::new(255, 256, 512));

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }

    #[test]
    fn positive_parse_response_many_stats() {
        let stats_bytes = [0, 0, 0, 255, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0, 0, 1, 0, 0, 0, 2, 0, 0, 0,
                           3];

        let received = ScrapeResponse::from_bytes(&stats_bytes);

        let mut expected = ScrapeResponse::new();
        expected.insert(ScrapeStats::new(255, 256, 512));
        expected.insert(ScrapeStats::new(1, 2, 3));

        assert_eq!(received, IResult::Done(&b""[..], expected));
    }
}