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
/*
 * Copyright (c) 2020 Stephen Connolly and CloudBees, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *     http://www.apache.org/licenses/LICENSE-2.0
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

use crate::streams::{Needle, NEEDLE_END, NEEDLE_MAX_LEN, NEEDLE_METADATA, NEEDLE_START};
use std::io;
use std::io::{Read, Write};
use std::string::FromUtf8Error;

/// Represents a stream of `EmbeddedStream` instances.
pub struct EmbeddedStreams<'a, R, W> {
    inner: EmbeddedReader<R>,
    side_writer: &'a mut W,
    end_of_stream: bool,
}

/// Represents a single stream within an `EmbeddedStreams`
pub struct EmbeddedStream<'a, R> {
    inner: &'a mut EmbeddedReader<R>,
    metadata: Vec<u8>,
    needle: Vec<u8>,
    /// have we finished the stream
    end_of_stream: bool,
}

struct EmbeddedReader<R> {
    inner: R,
    buffer: Vec<u8>,
    /// how big the buffer is
    capacity: usize,
    /// how much have we read into the buffer
    available: usize,
    /// how much of the buffer has been read in and doesn't have the needle
    checked: usize,
    /// how much have we wrote out from the buffer
    position: usize,
}

impl<'a, R: Read, W: Write> EmbeddedStreams<'a, R, W> {
    /// Creates a new `EmbeddedStreams` from a `reader` where any non-stream output will be sent to
    /// the supplied `side_writer`.
    pub fn new(reader: R, side_writer: &'a mut W) -> EmbeddedStreams<'a, R, W> {
        EmbeddedStreams {
            inner: EmbeddedReader::with_capacity(NEEDLE_MAX_LEN, reader),
            side_writer,
            end_of_stream: false,
        }
    }

    /// Applies the supplied function to every stream in the embedded stream
    pub fn for_each<F>(mut self, f: F)
    where
        F: (Fn(&mut EmbeddedStream<'_, R>)),
    {
        loop {
            if self.end_of_stream {
                return;
            }
            if self.inner.position >= self.inner.checked {
                if self.inner.checked >= self.inner.available {
                    self.inner.position = 0;
                    self.inner.available = 0;
                } else {
                    // move the unchecked hunk (which must be less than the needle
                    let count = self.inner.available - self.inner.checked;
                    let tmp =
                        Vec::from(&self.inner.buffer[self.inner.checked..self.inner.available]);
                    self.inner.buffer[..count].copy_from_slice(&tmp);
                    self.inner.position = 0;
                    self.inner.available = count;
                }
                // the capacity is always at least 1 byte more than the needle length
                // thus we can alway read at least one byte
                assert!(self.inner.available < self.inner.capacity);
                let count = match self
                    .inner
                    .inner
                    .read(&mut self.inner.buffer[self.inner.available..self.inner.capacity])
                {
                    Ok(c) => c,
                    _ => {
                        self.end_of_stream = true;
                        return;
                    }
                };
                if count == 0 && self.inner.available == 0 {
                    // we read nothing and there is no remaining buffer
                    // this is the end of everything
                    self.end_of_stream = true;
                    return;
                }
                self.inner.available += count;
                match Needle::find_start(&self.inner.buffer[..self.inner.available]) {
                    Some(0) => {
                        // the needle is at the top of the buffer: start of stream
                        if let Some(mid) = self.inner.buffer
                            [NEEDLE_START.len()..self.inner.available]
                            .windows(NEEDLE_METADATA.len())
                            .position(|w| w == NEEDLE_METADATA)
                        {
                            let mid = NEEDLE_START.len() + mid; // add search offset
                                                                // we have the middle token, now look for the end token
                            if let Some(end) = self.inner.buffer
                                [mid + NEEDLE_METADATA.len()..self.inner.available]
                                .windows(NEEDLE_END.len())
                                .position(|w| w == NEEDLE_END)
                            {
                                let end = mid + NEEDLE_METADATA.len() + end; // add search offset
                                self.inner.position = end + NEEDLE_END.len(); // move after the end of the marker
                                self.inner.checked = self.inner.position;
                                // we have the all tokens
                                let stream_name =
                                    Vec::from(&self.inner.buffer[mid + NEEDLE_METADATA.len()..end]);
                                let stream_id =
                                    Vec::from(&self.inner.buffer[NEEDLE_START.len()..mid]);
                                let mut stream =
                                    EmbeddedStream::new(&stream_name, &stream_id, &mut self.inner)
                                        .unwrap();
                                f(&mut stream);
                                if !stream.end_of_stream {
                                    let mut dump = vec![0; 8192];
                                    loop {
                                        match stream.read(&mut dump) {
                                            Ok(0) => break,
                                            Err(_) => break,
                                            _ => (),
                                        }
                                    }
                                }
                                continue;
                            } else {
                                // we can skip this start
                                self.inner.checked = NEEDLE_START.len();
                            }
                        } else {
                            // we can skip this start
                            self.inner.checked = NEEDLE_START.len();
                        }
                    }
                    Some(index) => {
                        // the needle is in the buffer, only safe to pipe that far
                        self.inner.checked = index;
                    }
                    None => {
                        // the needle is not in the buffer
                        if self.inner.available < NEEDLE_MAX_LEN {
                            // these are the last remaining bytes before the end of inner
                            self.inner.checked = self.inner.available
                        } else {
                            // keep the trailing needle length minus 1 bytes until we
                            // have more as they could be a partial match of the start
                            // of the needle
                            self.inner.checked = self.inner.available - NEEDLE_MAX_LEN + 1
                        }
                    }
                }
            }
            if self.inner.checked > self.inner.position {
                if let Ok(count) = self
                    .side_writer
                    .write(&self.inner.buffer[self.inner.position..self.inner.checked])
                {
                    self.inner.position += count
                } else {
                    self.end_of_stream = true;
                    return;
                }
            }
        }
    }
}

impl<R> EmbeddedReader<R> {
    fn with_capacity(capacity: usize, inner: R) -> EmbeddedReader<R> {
        // the needle always starts with a newline which we will emit
        let mut buffer = Vec::<u8>::with_capacity(capacity);
        unsafe {
            buffer.set_len(capacity);
        }
        EmbeddedReader {
            inner,
            buffer,
            capacity,
            position: 0,
            available: 0,
            checked: 0,
        }
    }
}

impl<'a, R> EmbeddedStream<'a, R> {
    fn new(
        metadata: &[u8],
        id: &[u8],
        inner: &'a mut EmbeddedReader<R>,
    ) -> Result<EmbeddedStream<'a, R>, FromUtf8Error> {
        // the needle always starts with a newline which we will emit
        let needle = format!(
            "\n[[juxr::stream::{}::{}]]\n",
            String::from_utf8(Vec::from(id))?,
            String::from_utf8(Vec::from(metadata))?
        )
        .as_bytes()
        .to_vec();
        Ok(EmbeddedStream {
            inner,
            metadata: Vec::from(metadata),
            needle,
            end_of_stream: false,
        })
    }

    /// Returns the name of this stream
    pub fn name(&self) -> String {
        let offset = self
            .metadata
            .windows(NEEDLE_METADATA.len())
            .position(|w| w == NEEDLE_METADATA)
            .map(|p| p + NEEDLE_METADATA.len())
            .unwrap_or(0);
        String::from_utf8_lossy(&self.metadata[offset..]).into()
    }

    /// Returns the kind of file, if present
    pub fn kind(&self) -> Option<String> {
        self.metadata
            .windows(NEEDLE_METADATA.len())
            .position(|w| w == NEEDLE_METADATA)
            .map(|p| String::from_utf8_lossy(&self.metadata[..p]).into())
    }
}

impl<R: Read> Read for EmbeddedStream<'_, R> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        if self.end_of_stream {
            Ok(0)
        } else {
            if self.inner.position >= self.inner.checked {
                if self.inner.checked >= self.inner.available {
                    self.inner.position = 0;
                    self.inner.available = 0;
                } else {
                    // move the unchecked hunk (which must be less than the needle
                    let count = self.inner.available - self.inner.checked;
                    let tmp =
                        Vec::from(&self.inner.buffer[self.inner.checked..self.inner.available]);
                    self.inner.buffer[..count].copy_from_slice(&tmp);
                    self.inner.position = 0;
                    self.inner.available = count;
                }
                // the capacity is always at least 1 byte more than the needle length
                // thus we can alway read at least one byte
                assert!(self.inner.available < self.inner.capacity);
                let count = self
                    .inner
                    .inner
                    .read(&mut self.inner.buffer[self.inner.available..self.inner.capacity])?;
                if count == 0 && self.inner.available == 0 {
                    // we read nothing and there is no remaining buffer
                    // this is the end of everything
                    self.end_of_stream = true;
                    return Ok(0);
                }
                self.inner.available += count;
                match self.inner.buffer[..self.inner.available]
                    .windows(self.needle.len())
                    .position(|window| window == self.needle.as_slice())
                {
                    Some(0) => {
                        // the needle is at the top of the buffer: end of stream
                        self.end_of_stream = true;
                        self.inner.position = self.needle.len();
                        self.inner.checked = self.inner.position;
                        return Ok(0);
                    }
                    Some(index) => {
                        // the needle is in the buffer, only safe to read that far
                        self.inner.checked = index;
                    }
                    None => {
                        // the needle is not in the buffer
                        if self.inner.available < self.needle.len() {
                            // these are the last remaining bytes before the end of inner
                            self.inner.checked = self.inner.available
                        } else {
                            // keep the trailing needle length minus 1 bytes until we
                            // have more as they could be a partial match of the start
                            // of the needle
                            self.inner.checked = self.inner.available - self.needle.len() + 1
                        }
                    }
                }
            }
            let count = (&self.inner.buffer[self.inner.position..self.inner.checked]).read(buf)?;
            self.inner.position += count;
            Ok(count)
        }
    }
}

#[cfg(test)]
mod tests {
    use std::io::{Cursor, Read};

    use crate::streams::{import::EmbeddedReader, EmbeddedStream, EmbeddedStreams};

    #[test]
    fn given_empty_input_then_returns_empty() {
        let input = concat!("").as_bytes();
        let mut state = EmbeddedReader::with_capacity(40, Cursor::new(input));
        let mut instance = EmbeddedStream::new(b"foo.txt", b"cafebabe", &mut state).unwrap();
        let mut buf = vec![0; 300 as usize];
        let mut total = 0;
        loop {
            let count = instance.read(&mut buf[total..]).unwrap();
            if count == 0 {
                break;
            }
            total += count;
        }
        assert_eq!(total, 0);
    }

    #[test]
    fn given_empty_content_then_returns_empty() {
        let input =
            concat!("\n", "[[juxr::stream::cafebabe::foo.txt]]\n", "More text\n").as_bytes();
        let mut state = EmbeddedReader::with_capacity(40, Cursor::new(input));
        let mut instance = EmbeddedStream::new(b"foo.txt", b"cafebabe", &mut state).unwrap();
        let mut buf = vec![0; 300 as usize];
        let mut total = 0;
        loop {
            let count = instance.read(&mut buf[total..]).unwrap();
            if count == 0 {
                break;
            }
            total += count;
        }
        assert_eq!(total, 0);
    }

    #[test]
    fn given_content_without_needle_then_returns_content() {
        let input = concat!("Some text\n", "More text\n").as_bytes();
        let mut state = EmbeddedReader::with_capacity(40, Cursor::new(input));
        let mut instance = EmbeddedStream::new(b"foo.txt", b"cafebabe", &mut state).unwrap();
        let mut buf = vec![0; 300 as usize];
        let mut total = 0;
        loop {
            let count = instance.read(&mut buf[total..]).unwrap();
            if count == 0 {
                break;
            }
            total += count;
        }
        let expected = concat!("Some text\n", "More text\n");
        assert_eq!(
            String::from_utf8(Vec::from(&buf[..total])).unwrap(),
            expected
        )
    }

    #[test]
    fn given_content_with_needle_then_returns_content_up_to_needle() {
        let input = concat!(
            "Some text\n",
            "More text\n",
            "[[juxr::stream::cafebabe::foo.txt]]\n",
            "Ignored text\n"
        )
        .as_bytes();
        let mut state = EmbeddedReader::with_capacity(40, Cursor::new(input));
        let mut instance = EmbeddedStream::new(b"foo.txt", b"cafebabe", &mut state).unwrap();
        let mut buf = vec![0; 300 as usize];
        let mut total = 0;
        loop {
            let count = instance.read(&mut buf[total..]).unwrap();
            if count == 0 {
                break;
            }
            total += count;
        }
        let expected = concat!("Some text\n", "More text");
        assert_eq!(
            String::from_utf8(Vec::from(&buf[..total])).unwrap(),
            expected
        )
    }

    #[test]
    fn given_no_streams_then_flushes_to_out() {
        let input = concat!("Some text\n", "More text\n",).as_bytes();
        let mut out = Vec::<u8>::new();
        EmbeddedStreams::new(Cursor::new(input), &mut out).for_each(|stream| {
            println!("{}", stream.name());
        });

        assert_eq!(out.as_slice(), input);
    }

    #[test]
    fn given_stream_then_non_stream_flushes_to_out() {
        let input = concat!(
            "Some text\n",
            "\n",
            "[[juxr::stream::cafebabe::file.txt]]\n",
            "Some content\n",
            "[[juxr::stream::cafebabe::file.txt]]\n",
            "More text\n",
        )
        .as_bytes();

        let mut out = Vec::new();

        EmbeddedStreams::new(Cursor::new(input), &mut out).for_each(|stream| {
            let mut buf = vec![0; 300 as usize];
            let mut total = 0;
            loop {
                let count = stream.read(&mut buf[total..]).unwrap();
                if count == 0 {
                    break;
                }
                total += count;
            }
            eprintln!("{}: {}", stream.name(), String::from_utf8(buf).unwrap());
        });

        let expected = concat!("Some text\n", "More text\n",).as_bytes();
        assert_eq!(
            String::from_utf8(out).unwrap(),
            String::from_utf8(Vec::from(expected)).unwrap()
        );
    }
}