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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use crate::error::Result;
use bytes::{BufMut, BytesMut};
use read_logger::{Level, ReadStatsLogger};
use std::cmp::{max, min};
use std::str::{self, FromStr};

/// Buffer for Range request reader (https://developer.mozilla.org/en-US/docs/Web/HTTP/Range_requests)
struct HttpRangeBuffer {
    buf: BytesMut,
    min_req_size: usize,
    /// Current position for Read+Seek implementation
    offset: usize,
    /// Lower index of buffer relative to input stream
    head: usize,
    read_stats: ReadStatsLogger,
    http_stats: ReadStatsLogger,
}

impl HttpRangeBuffer {
    pub fn new() -> Self {
        HttpRangeBuffer {
            buf: BytesMut::new(),
            min_req_size: 1024,
            offset: 0,
            head: 0,
            read_stats: ReadStatsLogger::new(Level::Trace, "read"),
            http_stats: ReadStatsLogger::new(Level::Debug, "http-range"),
        }
    }

    fn tail(&self) -> usize {
        self.head + self.buf.len()
    }

    fn get_request_range(&mut self, begin: usize, length: usize) -> Option<(usize, usize)> {
        //
        //            head  begin    tail
        //       +------+-----+---+---+------------+
        // File  |      |     |   |   |            |
        //       +------+-----+---+---+------------+
        // buf          |     |   |   |
        //              +-----+---+---+
        // Request            |   |
        //                    +---+
        //                    length

        self.read_stats.log(begin, length, length);
        // Download additional bytes if requested range is not in buffer
        if begin + length > self.tail() || begin < self.head {
            // Remove bytes before new begin
            if begin > self.head && begin < self.tail() {
                let _ = self.buf.split_to(begin - self.head);
                self.head = begin;
            } else if begin >= self.tail() || begin < self.head {
                self.buf.clear();
                self.head = begin;
            }

            // Read additional bytes into buffer
            let range_begin = max(begin, self.tail());
            let range_length = max(begin + length - range_begin, self.min_req_size);
            Some((range_begin, range_length))
        } else {
            None
        }
    }

    fn range(&mut self, begin: usize, length: usize) -> String {
        let end = (begin + length).saturating_sub(1);
        format!("bytes={begin}-{end}")
    }
}

pub(crate) mod nonblocking {
    use super::*;
    use crate::range_client::AsyncHttpRangeClient;

    /// HTTP client adapter for HTTP Range requests with a buffer optimized for sequential reading
    pub struct AsyncBufferedHttpRangeClient<T: AsyncHttpRangeClient> {
        http_client: T,
        url: String,
        buffer: HttpRangeBuffer,
    }

    impl<T: AsyncHttpRangeClient> AsyncBufferedHttpRangeClient<T> {
        pub fn with(http_client: T, url: &str) -> AsyncBufferedHttpRangeClient<T> {
            AsyncBufferedHttpRangeClient {
                http_client,
                url: url.to_string(),
                buffer: HttpRangeBuffer::new(),
            }
        }

        /// Set minimal request size.
        pub fn set_min_req_size(&mut self, size: usize) {
            self.buffer.min_req_size = size;
        }

        /// Set minimal request size.
        pub fn min_req_size(&mut self, size: usize) -> &mut Self {
            self.set_min_req_size(size);
            self
        }

        /// Get `length` bytes with offset `begin`.
        pub async fn get_range(&mut self, begin: usize, length: usize) -> Result<&[u8]> {
            let slice_len = if let Some((range_begin, range_length)) =
                self.buffer.get_request_range(begin, length)
            {
                self.buffer
                    .http_stats
                    .log(range_begin, range_length, length);
                let range = self.buffer.range(range_begin, range_length);
                let bytes = self.http_client.get_range(&self.url, &range).await?;
                let eff_len = bytes.len();
                self.buffer.buf.put(bytes);
                min(range_begin - begin + eff_len, length)
            } else {
                length
            };
            self.buffer.offset = begin + slice_len;
            // Return slice from buffer
            let lower = begin - self.buffer.head;
            Ok(&self.buffer.buf[lower..lower + slice_len])
        }

        /// Get `length` bytes from current offset.
        pub async fn get_bytes(&mut self, length: usize) -> Result<&[u8]> {
            self.get_range(self.buffer.offset, length).await
        }

        /// Send a HEAD request and return response header value
        pub async fn head_response_header(&self, header: &str) -> Result<Option<String>> {
            self.http_client
                .head_response_header(&self.url, header)
                .await
        }
    }
}

pub(crate) mod sync {
    use super::*;
    use crate::range_client::SyncHttpRangeClient;
    use crate::HttpError;
    use bytes::Buf;
    use std::io::{BufRead, Read, Seek, SeekFrom};

    /// HTTP client adapter for HTTP Range requests with a buffer optimized for sequential reading
    pub struct SyncBufferedHttpRangeClient<T: SyncHttpRangeClient> {
        http_client: T,
        url: String,
        buffer: HttpRangeBuffer,
        length_info: Option<Option<u64>>,
    }

    impl<T: SyncHttpRangeClient> SyncBufferedHttpRangeClient<T> {
        pub fn with(http_client: T, url: &str) -> SyncBufferedHttpRangeClient<T> {
            SyncBufferedHttpRangeClient {
                http_client,
                url: url.to_string(),
                buffer: HttpRangeBuffer::new(),
                length_info: None,
            }
        }

        /// Set minimal request size.
        pub fn set_min_req_size(&mut self, size: usize) {
            self.buffer.min_req_size = size;
        }

        /// Set minimal request size.
        pub fn min_req_size(&mut self, size: usize) -> &mut Self {
            self.set_min_req_size(size);
            self
        }

        /// Get `length` bytes with offset `begin`.
        pub fn get_range(&mut self, begin: usize, length: usize) -> Result<&[u8]> {
            let slice_len = if let Some((range_begin, range_length)) =
                self.buffer.get_request_range(begin, length)
            {
                self.buffer.http_stats.log(begin, range_length, length);
                let range = self.buffer.range(range_begin, range_length);
                let bytes = self.http_client.get_range(&self.url, &range)?;
                let eff_len = bytes.len();
                self.buffer.buf.put(bytes);
                min(range_begin - begin + eff_len, length)
            } else {
                length
            };
            self.buffer.offset = begin + slice_len;
            // Return slice from buffer
            let lower = begin - self.buffer.head;
            Ok(&self.buffer.buf[lower..lower + slice_len])
        }

        /// Get `length` bytes from current offset.
        pub fn get_bytes(&mut self, length: usize) -> Result<&[u8]> {
            self.get_range(self.buffer.offset, length)
        }

        /// Send a HEAD request and return response header value
        pub fn head_response_header(&self, header: &str) -> Result<Option<String>> {
            self.http_client.head_response_header(&self.url, header)
        }

        /// Send a HEAD request and get content-length
        pub fn get_content_length(&mut self) -> Result<Option<u64>> {
            let header_val = self.head_response_header("content-length")?;
            let length_info = if let Some(val) = header_val {
                let length = u64::from_str(&val).map_err(|_| {
                    HttpError::HttpError("Invalid content-length received".to_string())
                })?;
                Some(length)
            } else {
                None
            };
            self.length_info = Some(length_info);
            Ok(length_info)
        }
    }

    impl<T: SyncHttpRangeClient> Read for SyncBufferedHttpRangeClient<T> {
        fn read(&mut self, buf: &mut [u8]) -> std::result::Result<usize, std::io::Error> {
            let length = buf.len();
            let mut bytes = self.get_bytes(length).map_err(|e| match e {
                HttpError::HttpStatus(416) => {
                    std::io::Error::from(std::io::ErrorKind::UnexpectedEof)
                }
                e => std::io::Error::new(std::io::ErrorKind::Other, e.to_string()),
            })?;
            bytes.copy_to_slice(&mut buf[0..bytes.len()]);
            Ok(length)
        }
    }

    impl<T: SyncHttpRangeClient> BufRead for SyncBufferedHttpRangeClient<T> {
        fn fill_buf(&mut self) -> std::io::Result<&[u8]> {
            if self.buffer.offset >= self.buffer.tail() || self.buffer.offset < self.buffer.head {
                let res = self.get_bytes(self.buffer.min_req_size);
                if let Some(HttpError::HttpStatus(416)) = res.as_ref().err() {
                    // An empty buffer indicates that the stream has reached EOF
                    return Ok(&[]);
                }
                res.map_err(|e| std::io::Error::new(std::io::ErrorKind::Other, e.to_string()))?;
                self.buffer.offset = self.buffer.head;
            }
            Ok(&self.buffer.buf[..])
        }

        fn consume(&mut self, amt: usize) {
            self.buffer.offset += amt;
        }
    }

    impl<T: SyncHttpRangeClient> Seek for SyncBufferedHttpRangeClient<T> {
        fn seek(&mut self, pos: SeekFrom) -> std::result::Result<u64, std::io::Error> {
            match pos {
                SeekFrom::Start(p) => {
                    self.buffer.offset = p as usize;
                    Ok(p)
                }
                SeekFrom::End(p) => {
                    if self.length_info.is_none() {
                        // Read content-length with HEAD request
                        let _ = self.get_content_length().map_err(|e| {
                            std::io::Error::new(std::io::ErrorKind::Other, e.to_string())
                        })?;
                    }
                    if let Some(Some(length)) = self.length_info {
                        self.buffer.offset = length.saturating_add_signed(p) as usize;
                        Ok(self.buffer.offset as u64)
                    } else {
                        Err(std::io::Error::new(
                            std::io::ErrorKind::Other,
                            "SeekFrom::End failed - no content-length received",
                        ))
                    }
                }
                SeekFrom::Current(p) => {
                    self.buffer.offset = self.buffer.offset.saturating_add_signed(p as isize);
                    Ok(self.buffer.offset as u64)
                }
            }
        }
    }
}

#[cfg(test)]
#[cfg(feature = "reqwest-async")]
mod test_async {
    use crate::{AsyncBufferedHttpRangeClient, BufferedHttpRangeClient, Result};

    fn init_logger() {
        let _ = env_logger::builder().is_test(true).try_init();
    }

    #[tokio::test]
    async fn http_read_async() -> Result<()> {
        init_logger();
        let mut client =
            BufferedHttpRangeClient::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.min_req_size(256).get_range(0, 3).await?;
        assert_eq!(bytes, b"fgb");
        let version = client.get_bytes(1).await?;
        assert_eq!(version, [3]);
        Ok(())
    }

    #[tokio::test]
    async fn read_over_min_req_size() -> Result<()> {
        let mut client =
            BufferedHttpRangeClient::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.min_req_size(4).get_range(0, 8).await?;
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);
        Ok(())
    }

    #[tokio::test]
    async fn zero_range() -> Result<()> {
        init_logger();
        let mut client =
            BufferedHttpRangeClient::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.get_range(100, 0).await?;
        assert_eq!(bytes, []);
        Ok(())
    }

    #[tokio::test]
    async fn after_end() -> Result<()> {
        init_logger();
        // countries.fgb has 205680 bytes
        let mut client =
            BufferedHttpRangeClient::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.get_range(205670, 10).await?;
        assert_eq!(bytes, [78, 192, 205, 204, 204, 204, 204, 236, 73, 192]);

        let bytes = client.get_bytes(10).await;
        assert_eq!(&bytes.unwrap_err().to_string(), "http status 416");

        let bytes = client.get_range(205670, 20).await?;
        assert_eq!(bytes, [78, 192, 205, 204, 204, 204, 204, 236, 73, 192]);

        Ok(())
    }

    #[tokio::test]
    async fn buffer_overlap() -> Result<()> {
        init_logger();
        let mut client =
            BufferedHttpRangeClient::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.min_req_size(4).get_range(0, 3).await?;
        assert_eq!(bytes, [b'f', b'g', b'b']);
        let bytes = client.get_range(3, 4).await?;
        assert_eq!(bytes, [3, b'f', b'g', b'b']);
        let bytes = client.get_bytes(1).await?;
        assert_eq!(bytes, [0]);
        Ok(())
    }

    #[tokio::test]
    async fn custom_headers() -> Result<()> {
        init_logger();
        let http_client = reqwest::Client::builder()
            .user_agent("rust-client")
            .build()
            .unwrap();
        let mut client = AsyncBufferedHttpRangeClient::with(
            http_client,
            "https://flatgeobuf.org/test/data/countries.fgb",
        );
        let bytes = client.min_req_size(256).get_range(0, 3).await?;
        assert_eq!(bytes, b"fgb");
        Ok(())
    }
}

#[cfg(test)]
#[cfg(any(feature = "reqwest-sync", feature = "ureq-sync"))]
mod test_sync {
    #[cfg(feature = "reqwest-sync")]
    use crate::HttpReader;
    use crate::Result;
    #[cfg(all(feature = "ureq-sync", not(feature = "reqwest-sync")))]
    use crate::UreqHttpReader as HttpReader;
    use std::io::{BufRead, Read, Seek, SeekFrom};

    fn init_logger() {
        let _ = env_logger::builder().is_test(true).try_init();
    }

    #[test]
    fn http_read_sync() -> Result<()> {
        init_logger();
        let mut client = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.min_req_size(256).get_range(0, 3)?;
        assert_eq!(bytes, b"fgb");

        let version = client.get_bytes(1)?;
        assert_eq!(version, [3]);

        let bytes = client.get_bytes(3)?;
        assert_eq!(bytes, b"fgb");
        Ok(())
    }

    #[test]
    fn http_read_sync_zero_range() -> Result<()> {
        init_logger();
        let mut client = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        let bytes = client.min_req_size(256).get_range(0, 0)?;
        assert_eq!(bytes, []);
        Ok(())
    }

    #[test]
    fn io_read() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        reader.seek(SeekFrom::Start(3)).ok();
        let mut version = [0; 1];
        reader.min_req_size(256).read_exact(&mut version)?;
        assert_eq!(version, [3]);

        let mut bytes = [0; 3];
        reader.read_exact(&mut bytes)?;
        assert_eq!(&bytes, b"fgb");
        Ok(())
    }

    #[test]
    fn io_read_over_min_req_size() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        let mut bytes = [0; 8];
        reader.min_req_size(4).read_exact(&mut bytes)?;
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);
        Ok(())
    }

    #[test]
    fn io_read_non_exact() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        let mut bytes = [0; 8];
        // We could only read 4 bytes in this case
        reader.min_req_size(4).read(&mut bytes)?;
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);
        Ok(())
    }

    #[test]
    fn after_end() -> std::io::Result<()> {
        init_logger();
        // countries.fgb has 205680 bytes
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        reader.seek(SeekFrom::Start(205670)).ok();
        let mut bytes = [0; 10];
        reader.read_exact(&mut bytes)?;
        assert_eq!(bytes, [78, 192, 205, 204, 204, 204, 204, 236, 73, 192]);

        let result = reader.read_exact(&mut bytes);
        assert_eq!(result.unwrap_err().to_string(), "unexpected end of file");

        reader.seek(SeekFrom::Start(205670)).ok();
        let mut bytes = [0; 20];
        reader.read_exact(&mut bytes)?;
        assert_eq!(
            bytes,
            [78, 192, 205, 204, 204, 204, 204, 236, 73, 192, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]
        );

        Ok(())
    }

    #[test]
    fn seek_current() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        let mut bytes = [0; 8];
        reader.read(&mut bytes)?;

        assert_eq!(reader.seek(SeekFrom::Current(0))?, 8);

        reader.seek(SeekFrom::Current(-8))?;
        reader.read(&mut bytes)?;
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);

        Ok(())
    }

    #[test]
    fn seek_end() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");

        let size = reader.seek(SeekFrom::End(0))?;
        assert_eq!(size, 205680);

        reader.seek(SeekFrom::End(-205680))?;

        let mut bytes = [0; 8];
        reader.read(&mut bytes)?;
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);

        Ok(())
    }

    #[test]
    fn bufread() -> std::io::Result<()> {
        init_logger();
        let mut reader = HttpReader::new("https://flatgeobuf.org/test/data/countries.fgb");
        reader.set_min_req_size(5);

        let mut bytes = vec![];
        let num_bytes = reader.read_until(0, &mut bytes).unwrap();
        assert_eq!(num_bytes, 8);
        assert_eq!(bytes, [b'f', b'g', b'b', 3, b'f', b'g', b'b', 0]);

        // Mix with seek+read
        reader.seek(SeekFrom::Start(0)).ok();
        let mut bytes = vec![];
        let _num_bytes = reader.read_until(3, &mut bytes).unwrap();
        assert_eq!(bytes, [b'f', b'g', b'b', 3]);
        let mut bytes = [0; 2];
        reader.read(&mut bytes)?;
        assert_eq!(bytes, [b'f', b'g']);
        let mut bytes = vec![];
        let _num_bytes = reader.read_until(0, &mut bytes).unwrap();
        assert_eq!(bytes, [b'f', b'g', b'b', 0]);
        // ? should it be
        // assert_eq!(bytes, [b'b', 0]);

        // Test EOF
        reader.seek(SeekFrom::Start(205680 - 8)).ok();
        let mut bytes = vec![];
        let num_bytes = reader.read_until(0, &mut bytes).unwrap();
        assert_eq!(num_bytes, 8);
        assert_eq!(bytes, [205, 204, 204, 204, 204, 236, 73, 192]);

        reader.seek(SeekFrom::Start(205680 - 5)).ok();
        let mut bytes = vec![];
        let num_bytes = reader.read_until(0, &mut bytes).unwrap();
        assert_eq!(num_bytes, 5);
        assert_eq!(bytes, [204, 204, 236, 73, 192]);

        Ok(())
    }

    #[test]
    fn remote_png() -> std::io::Result<()> {
        init_logger();
        let mut reader =
            HttpReader::new("https://www.rust-lang.org/static/images/favicon-32x32.png");
        reader.seek(SeekFrom::Start(1)).ok();
        let mut bytes = [0; 3];
        reader.read_exact(&mut bytes)?;
        assert_eq!(&bytes, b"PNG");
        Ok(())
    }
}