extern crate rmp_serde; use std::ops::{Deref, DerefMut}; use std::io::{Cursor, Read}; use rocket::outcome::Outcome; use rocket::request::Request; use rocket::data::{self, Data, FromData}; use rocket::response::{self, Responder, Response}; use rocket::http::{ContentType, Status}; use serde::{Serialize, Deserialize}; pub use self::rmp_serde::decode::Error as MsgPackError; /// The `MsgPack` type: implements `FromData` and `Responder`, allowing you to easily /// consume and respond with MessagePack data. /// /// If you're receiving MessagePack data, simply add a `data` parameter to your route /// arguments and ensure the type of the parameter is a `MsgPack`, where `T` is /// some type you'd like to parse from MessagePack. `T` must implement `Deserialize` /// from [Serde](https://github.com/serde-rs/serde). The data is parsed from the /// HTTP request body. /// /// ```rust,ignore /// #[post("/users/", format = "application/msgpack", data = "")] /// fn new_user(user: MsgPack) { /// ... /// } /// ``` /// /// You don't _need_ to use `format = "application/msgpack"`, but it _may_ be what /// you want. Using `format = application/msgpack` means that any request that /// doesn't specify "application/msgpack" as its first `Content-Type:` header /// parameter will not be routed to this handler. By default, Rocket will accept a /// Content Type of any of the following for MessagePack data: /// `application/msgpack`, `application/x-msgpack`, `bin/msgpack`, or `bin/x-msgpack`. /// /// If you're responding with MessagePack data, return a `MsgPack` type, where `T` /// implements `Serialize` from [Serde](https://github.com/serde-rs/serde). The /// content type of the response is set to `application/msgpack` automatically. /// /// ```rust,ignore /// #[get("/users/")] /// fn user(id: usize) -> MsgPack { /// let user_from_id = User::from(id); /// ... /// MsgPack(user_from_id) /// } /// ``` #[derive(Debug)] pub struct MsgPack(pub T); impl MsgPack { /// Consumes the `MsgPack` wrapper and returns the wrapped item. /// /// # Example /// ```rust /// # use rocket_contrib::MsgPack; /// let string = "Hello".to_string(); /// let my_msgpack = MsgPack(string); /// assert_eq!(my_msgpack.into_inner(), "Hello".to_string()); /// ``` pub fn into_inner(self) -> T { self.0 } } /// Maximum size of MessagePack data is 1MB. /// TODO: Determine this size from some configuration parameter. const MAX_SIZE: u64 = 1048576; /// Accepted content types are: /// `application/msgpack`, `application/x-msgpack`, `bin/msgpack`, and `bin/x-msgpack` fn is_msgpack_content_type(ct: &ContentType) -> bool { (ct.ttype == "application" || ct.ttype == "bin") && (ct.subtype == "msgpack" || ct.subtype == "x-msgpack") } impl FromData for MsgPack { type Error = MsgPackError; fn from_data(request: &Request, data: Data) -> data::Outcome { if !request.content_type().map_or(false, |ct| is_msgpack_content_type(&ct)) { error_!("Content-Type is not MessagePack."); return Outcome::Forward(data); } let mut buf = Vec::new(); if let Err(e) = data.open().take(MAX_SIZE).read_to_end(&mut buf) { let e = MsgPackError::InvalidDataRead(e); error_!("Couldn't read request data: {:?}", e); return Outcome::Failure((Status::BadRequest, e)); }; match rmp_serde::from_slice(&buf).map(|val| MsgPack(val)) { Ok(value) => Outcome::Success(value), Err(e) => { error_!("Couldn't parse MessagePack body: {:?}", e); Outcome::Failure((Status::BadRequest, e)) } } } } /// Serializes the wrapped value into MessagePack. Returns a response with Content-Type /// MessagePack and a fixed-size body with the serialization. If serialization fails, an /// `Err` of `Status::InternalServerError` is returned. impl Responder<'static> for MsgPack { fn respond(self) -> response::Result<'static> { rmp_serde::to_vec(&self.0).map_err(|e| { error_!("MsgPack failed to serialize: {:?}", e); Status::InternalServerError }).and_then(|buf| { Response::build() .sized_body(Cursor::new(buf)) .ok() }) } } impl Deref for MsgPack { type Target = T; fn deref<'a>(&'a self) -> &'a T { &self.0 } } impl DerefMut for MsgPack { fn deref_mut<'a>(&'a mut self) -> &'a mut T { &mut self.0 } }