moonfire-nvr/src/slices.rs

// This file is part of Moonfire NVR, a security camera digital video recorder.
// Copyright (C) 2016 Scott Lamb <slamb@slamb.org>
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// In addition, as a special exception, the copyright holders give
// permission to link the code of portions of this program with the
// OpenSSL library under certain conditions as described in each
// individual source file, and distribute linked combinations including
// the two.
//
// You must obey the GNU General Public License in all respects for all
// of the code used other than OpenSSL. If you modify file(s) with this
// exception, you may extend this exception to your version of the
// file(s), but you are not obligated to do so. If you do not wish to do
// so, delete this exception statement from your version. If you delete
// this exception statement from all source files in the program, then
// also delete it here.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

//! Tools for implementing a `http_serve::Entity` body composed from many "slices".

use base::format_err_t;
use crate::body::{BoxedError, wrap_error};
use failure::{Error, bail};
use futures::{Stream, stream};
use std::fmt;
use std::ops::Range;

/// Gets a byte range given a context argument.
/// Each `Slice` instance belongs to a single `Slices`.
pub trait Slice : fmt::Debug + Sized + Sync + 'static {
    type Ctx: Send + Clone;
    type Chunk: Send;

    /// The byte position (relative to the start of the `Slices`) of the end of this slice,
    /// exclusive. Note the starting position (and thus length) are inferred from the previous
    /// slice. Must remain the same for the lifetime of the `Slice`.
    fn end(&self) -> u64;

    /// Gets the body bytes indicated by `r`, which is relative to this slice's start.
    /// The additional argument `ctx` is as supplied to the `Slices`.
    /// The additional argument `l` is the length of this slice, as determined by the `Slices`.
    fn get_range(&self, ctx: &Self::Ctx, r: Range<u64>, len: u64)
                 -> Box<dyn Stream<Item = Self::Chunk, Error = BoxedError> + Send>;

    fn get_slices(ctx: &Self::Ctx) -> &Slices<Self>;
}

/// Helper to serve byte ranges from a body which is broken down into many "slices".
/// This is used to implement `.mp4` serving in `mp4::File` from `mp4::Slice` enums.
pub struct Slices<S> where S: Slice {
    /// The total byte length of the `Slices`.
    /// Equivalent to `self.slices.back().map(|s| s.end()).unwrap_or(0)`; kept for convenience and
    /// to avoid a branch.
    len: u64,

    /// 0 or more slices of this file.
    slices: Vec<S>,
}

impl<S> fmt::Debug for Slices<S> where S: Slice {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{} slices with overall length {}:", self.slices.len(), self.len)?;
        let mut start = 0;
        for (i, s) in self.slices.iter().enumerate() {
            let end = s.end();
            write!(f, "\ni {:7}: range [{:12}, {:12}) len {:12}: {:?}",
                   i, start, end, end - start, s)?;
            start = end;
        }
        Ok(())
    }
}

impl<S> Slices<S> where S: Slice {
    pub fn new() -> Self { Slices{len: 0, slices: Vec::new()} }

    /// Reserves space for at least `additional` more slices to be appended.
    pub fn reserve(&mut self, additional: usize) {
        self.slices.reserve(additional)
    }

    /// Appends the given slice, which must have end > the Slices's current len.
    pub fn append(&mut self, slice: S) -> Result<(), Error> {
        if slice.end() <= self.len {
            bail!("end {} <= len {} while adding slice {:?} to slices:\n{:?}",
                  slice.end(), self.len, slice, self);
        }
        self.len = slice.end();
        self.slices.push(slice);
        Ok(())
    }

    /// Returns the total byte length of all slices.
    pub fn len(&self) -> u64 { self.len }

    /// Returns the number of slices.
    pub fn num(&self) -> usize { self.slices.len() }

    /// Writes `range` to `out`.
    /// This interface mirrors `http_serve::Entity::write_to`, with the additional `ctx` argument.
    pub fn get_range(&self, ctx: &S::Ctx, range: Range<u64>)
                     -> Box<dyn Stream<Item = S::Chunk, Error = BoxedError> + Send> {
        if range.start > range.end || range.end > self.len {
            return Box::new(stream::once(Err(wrap_error(format_err_t!(
                        Internal, "Bad range {:?} for slice of length {}", range, self.len)))));
        }

        // Binary search for the first slice of the range to write, determining its index and
        // (from the preceding slice) the start of its range.
        let (i, slice_start) = match self.slices.binary_search_by_key(&range.start, |s| s.end()) {
            Ok(i) => (i+1, self.slices[i].end()),   // desired start == slice i's end; first is i+1!
            Err(i) if i == 0 => (0, 0),             // desired start < slice 0's end; first is 0.
            Err(i) => (i, self.slices[i-1].end()),  // desired start < slice i's end; first is i.
        };

        // Iterate through and write each slice until the end.

        let start_pos = range.start - slice_start;
        let bodies = stream::unfold(
            (ctx.clone(), i, start_pos, slice_start), move |(c, i, start_pos, slice_start)| {
            let (body, min_end);
            {
                let self_ = S::get_slices(&c);
                if i == self_.slices.len() { return None }
                let s = &self_.slices[i];
                if range.end == slice_start + start_pos { return None }
                let s_end = s.end();
                min_end = ::std::cmp::min(range.end, s_end);
                let l = s_end - slice_start;
                body = s.get_range(&c, start_pos .. min_end - slice_start, l);
            };
            Some(Ok::<_, BoxedError>((body, (c, i+1, 0, min_end))))
        });
        Box::new(bodies.flatten())
    }
}

#[cfg(test)]
mod tests {
    use crate::body::BoxedError;
    use db::testutil;
    use futures::{Future, Stream};
    use futures::stream;
    use lazy_static::lazy_static;
    use std::ops::Range;
    use super::{Slice, Slices};

    #[derive(Debug, Eq, PartialEq)]
    pub struct FakeChunk {
        slice: &'static str,
        range: Range<u64>,
    }

    #[derive(Debug)]
    pub struct FakeSlice {
        end: u64,
        name: &'static str,
    }

    impl Slice for FakeSlice {
        type Ctx = &'static Slices<FakeSlice>;
        type Chunk = FakeChunk;

        fn end(&self) -> u64 { self.end }

        fn get_range(&self, _ctx: &&'static Slices<FakeSlice>, r: Range<u64>, _l: u64)
                     -> Box<dyn Stream<Item = FakeChunk, Error = BoxedError> + Send> {
            Box::new(stream::once(Ok(FakeChunk{slice: self.name, range: r})))
        }

        fn get_slices(ctx: &&'static Slices<FakeSlice>) -> &'static Slices<Self> { *ctx }
    }

    lazy_static! {
        static ref SLICES: Slices<FakeSlice> = {
            let mut s = Slices::new();
            s.append(FakeSlice{end: 5, name: "a"}).unwrap();
            s.append(FakeSlice{end: 5+13, name: "b"}).unwrap();
            s.append(FakeSlice{end: 5+13+7, name: "c"}).unwrap();
            s.append(FakeSlice{end: 5+13+7+17, name: "d"}).unwrap();
            s.append(FakeSlice{end: 5+13+7+17+19, name: "e"}).unwrap();
            s
        };
    }

    #[test]
    pub fn size() {
        testutil::init();
        assert_eq!(5 + 13 + 7 + 17 + 19, SLICES.len());
    }

    #[test]
    pub fn exact_slice() {
        // Test writing exactly slice b.
        testutil::init();
        let out = SLICES.get_range(&&*SLICES, 5 .. 18).collect().wait().unwrap();
        assert_eq!(&[FakeChunk{slice: "b", range: 0 .. 13}], &out[..]);
    }

    #[test]
    pub fn offset_first() {
        // Test writing part of slice a.
        testutil::init();
        let out = SLICES.get_range(&&*SLICES, 1 .. 3).collect().wait().unwrap();
        assert_eq!(&[FakeChunk{slice: "a", range: 1 .. 3}], &out[..]);
    }

    #[test]
    pub fn offset_mid() {
        // Test writing part of slice b, all of slice c, and part of slice d.
        testutil::init();
        let out = SLICES.get_range(&&*SLICES, 17 .. 26).collect().wait().unwrap();
        assert_eq!(&[
                   FakeChunk{slice: "b", range: 12 .. 13},
                   FakeChunk{slice: "c", range: 0 .. 7},
                   FakeChunk{slice: "d", range: 0 .. 1},
                   ], &out[..]);
    }

    #[test]
    pub fn everything() {
        // Test writing the whole Slices.
        testutil::init();
        let out = SLICES.get_range(&&*SLICES, 0 .. 61).collect().wait().unwrap();
        assert_eq!(&[
                   FakeChunk{slice: "a", range: 0 .. 5},
                   FakeChunk{slice: "b", range: 0 .. 13},
                   FakeChunk{slice: "c", range: 0 .. 7},
                   FakeChunk{slice: "d", range: 0 .. 17},
                   FakeChunk{slice: "e", range: 0 .. 19},
                   ], &out[..]);
    }

    #[test]
    pub fn at_end() {
        testutil::init();
        let out = SLICES.get_range(&&*SLICES, 61 .. 61).collect().wait().unwrap();
        let empty: &[FakeChunk] = &[];
        assert_eq!(empty, &out[..]);
    }
}