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
/*!
# Etagged Raw Response for Rocket Framework

This crate provides a response struct used for responding raw data with **Etag** cache.

See `examples`.
*/

mod key_etag_cache;
mod file_etag_cache;
mod fairing;

#[macro_use]
extern crate derivative;
pub extern crate mime;
extern crate mime_guess;
extern crate percent_encoding;
extern crate crc_any;
extern crate lru_time_cache;

extern crate rocket;
extern crate rocket_etag_if_none_match;

use std::io::{Read, Cursor, ErrorKind};
use std::path::Path;
use std::sync::Arc;

use mime::Mime;

use rocket::State;
use rocket::response::{self, Response, Responder};
use rocket::request::Request;
use rocket::http::Status;
use rocket::fairing::Fairing;

use rocket_etag_if_none_match::EtagIfNoneMatch;

pub use rocket_etag_if_none_match::EntityTag;

pub use key_etag_cache::KeyEtagCache;
pub use file_etag_cache::FileEtagCache;
use fairing::EtaggedRawResponseFairing;
use std::fs::File;

const DEFAULT_CACHE_CAPACITY: usize = 64;

#[derive(Derivative)]
#[derivative(Debug)]
enum EtaggedRawResponseData {
    Vec {
        data: Vec<u8>,
        key: Arc<str>,
    },
    Reader {
        #[derivative(Debug = "ignore")]
        data: Box<dyn Read + 'static>,
        content_length: Option<u64>,
        etag: EntityTag,
    },
    File(Arc<Path>),
}

#[derive(Debug)]
pub struct EtaggedRawResponse {
    file_name: Option<String>,
    content_type: Option<Mime>,
    data: EtaggedRawResponseData,
}

impl EtaggedRawResponse {
    /// Create a `EtaggedRawResponse` instance from a `Vec<u8>`.
    pub fn from_vec<K: Into<Arc<str>>, S: Into<String>>(key: K, vec: Vec<u8>, file_name: Option<S>, content_type: Option<Mime>) -> EtaggedRawResponse {
        let key = key.into();
        let file_name = file_name.map(|file_name| file_name.into());

        let data = EtaggedRawResponseData::Vec {
            data: vec,
            key,
        };

        EtaggedRawResponse {
            file_name,
            content_type,
            data,
        }
    }

    /// Create a `EtaggedRawResponse` instance from a reader.
    pub fn from_reader<R: Read + 'static, S: Into<String>>(etag: EntityTag, reader: R, file_name: Option<S>, content_type: Option<Mime>, content_length: Option<u64>) -> EtaggedRawResponse {
        let file_name = file_name.map(|file_name| file_name.into());

        let data = EtaggedRawResponseData::Reader {
            data: Box::new(reader),
            content_length,
            etag,
        };

        EtaggedRawResponse {
            file_name,
            content_type,
            data,
        }
    }

    /// Create a `EtaggedRawResponse` instance from a path of a file.
    pub fn from_file<P: Into<Arc<Path>>, S: Into<String>>(path: P, file_name: Option<S>, content_type: Option<Mime>) -> EtaggedRawResponse {
        let path = path.into();
        let file_name = file_name.map(|file_name| file_name.into());

        let data = EtaggedRawResponseData::File(path);

        EtaggedRawResponse {
            file_name,
            content_type,
            data,
        }
    }
}

impl EtaggedRawResponse {
    #[inline]
    /// Create the fairing of `EtaggedRawResponse`.
    pub fn fairing() -> impl Fairing {
        EtaggedRawResponseFairing {
            custom_callback: Box::new(move || {
                DEFAULT_CACHE_CAPACITY
            }),
        }
    }

    #[inline]
    /// Create the fairing of `EtaggedRawResponse`.
    pub fn fairing_cache<F>(f: F) -> impl Fairing where F: Fn() -> usize + Send + Sync + 'static {
        EtaggedRawResponseFairing {
            custom_callback: Box::new(f),
        }
    }
}

macro_rules! file_name {
    ($s:expr, $res:expr) => {
        if let Some(file_name) = $s.file_name {
            if !file_name.is_empty() {
                $res.raw_header("Content-Disposition", format!("inline; filename*=UTF-8''{}", percent_encoding::percent_encode(file_name.as_bytes(), percent_encoding::QUERY_ENCODE_SET)));
            }
        }
    };
}

macro_rules! content_type {
    ($s:expr, $res:expr) => {
        if let Some(content_type) = $s.content_type {
            $res.raw_header("Content-Type", content_type.to_string());
        }
    };
}

impl<'a> Responder<'a> for EtaggedRawResponse {
    fn respond_to(self, request: &Request) -> response::Result<'a> {
        let client_etag = request.guard::<EtagIfNoneMatch>().unwrap();

        let mut response = Response::build();

        match self.data {
            EtaggedRawResponseData::Vec { data, key } => {
                let etag_cache = request.guard::<State<KeyEtagCache>>().expect("KeyEtagCache registered in on_attach");

                let etag = etag_cache.get_or_insert(key.clone(), data.as_slice());

                let is_etag_match = client_etag.weak_eq(&etag);

                if is_etag_match {
                    response.status(Status::NotModified);
                } else {
                    file_name!(self, response);
                    content_type!(self, response);

                    response.raw_header("Etag", etag.to_string());

                    response.sized_body(Cursor::new(data));
                }
            }
            EtaggedRawResponseData::Reader { data, content_length, etag } => {
                let is_etag_match = client_etag.weak_eq(&etag);

                if is_etag_match {
                    response.status(Status::NotModified);
                } else {
                    file_name!(self, response);
                    content_type!(self, response);

                    if let Some(content_length) = content_length {
                        response.raw_header("Content-Length", content_length.to_string());
                    }

                    response.raw_header("Etag", etag.to_string());

                    response.streamed_body(data);
                }
            }
            EtaggedRawResponseData::File(path) => {
                let etag_cache = request.guard::<State<FileEtagCache>>().expect("FileEtagCache registered in on_attach");

                let etag = etag_cache.get_or_insert(path.clone()).map_err(|_| Status::InternalServerError)?;

                let is_etag_match = client_etag.weak_eq(&etag);

                if is_etag_match {
                    response.status(Status::NotModified);
                } else {
                    if let Some(file_name) = self.file_name {
                        if !file_name.is_empty() {
                            response.raw_header("Content-Disposition", format!("inline; filename*=UTF-8''{}", percent_encoding::percent_encode(file_name.as_bytes(), percent_encoding::QUERY_ENCODE_SET)));
                        }
                    } else {
                        if let Some(file_name) = path.file_name().map(|file_name| file_name.to_string_lossy()) {
                            response.raw_header("Content-Disposition", format!("inline; filename*=UTF-8''{}", percent_encoding::percent_encode(file_name.as_bytes(), percent_encoding::QUERY_ENCODE_SET)));
                        }
                    }

                    if let Some(content_type) = self.content_type {
                        response.raw_header("Content-Type", content_type.to_string());
                    } else {
                        if let Some(extension) = path.extension() {
                            if let Some(extension) = extension.to_str() {
                                let content_type = mime_guess::get_mime_type(extension);

                                response.raw_header("Content-Type", content_type.to_string());
                            }
                        }
                    }

                    let file = File::open(path).map_err(|err| if err.kind() == ErrorKind::NotFound {
                        Status::NotFound
                    } else {
                        Status::InternalServerError
                    })?;

                    response.raw_header("Etag", etag.to_string());

                    response.sized_body(file);
                }
            }
        }

        response.ok()
    }
}