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

use hyper::{Body, Headers, HttpVersion, Method, Uri};
use std::{fmt, net};
use tokio_core::reactor::Handle;
use recognizer::Params;
use anymap::AnyMap;
use serde_json::{self, from_slice, from_value};
use hyper::Chunk;
use serde::de::DeserializeOwned;
use contrib::query_parser::{self, parse};

/// The Request Struct, This is passed to Middlewares and route handlers.
/// 
pub struct Request {
	pub(crate) uri: Uri,
	pub(crate) handle: Option<Handle>,
	pub(crate) body: Option<Body>,
	pub(crate) version: HttpVersion,
	pub(crate) headers: Headers,
	pub(crate) remote: Option<net::SocketAddr>,
	pub(crate) method: Method,
	pub(crate) anyMap: AnyMap,
}

/// the error returned by Request::json()
///
/// `From<JsonError>` is implemented for Response
/// so you can use the `?` to unwrap or return an early response
///
/// ```
/// #[service]
/// fn UserService(req: Request, res: Response) {
///   let User { name } = req.json()?;
///   // will return an error response with the  json '{ "error": "Json was empty" }' if JsonError::None
///   // or '{ "error": "{serde error}" }' if it failed to deserialize.
/// }
/// ```
///
#[derive(Debug)]
pub enum JsonError {
	None,
	Err(serde_json::Error),
}

/// the error returned by Request::query()
///
/// `From<QueryParseError>` is implemented for Response
/// so you can use the `?` to unwrap or return an early response
///
/// ```
/// #[service]
/// fn UserService(req: Request, res: Response) {
///   let AccessToken { token } = req.query()?;
///   // will return an error response with the  json '{ "error": "query data was empty" }' if QueryParseError::None
///   // or '{ "error": "{serde error}" }' if it failed to deserialize.
///   // or '{ "error": "{parse error}" }' if it failed to parse.
/// }
/// ```
///
#[derive(Debug)]
pub enum QueryParseError {
	SerdeError(serde_json::Error),
	ParseError(query_parser::ParseError),
	None,
}

impl Request {
	pub(crate) fn new(
		method: Method,
		uri: Uri,
		version: HttpVersion,
		headers: Headers,
		body: Body,
	) -> Self {
		Self {
			method,
			uri,
			version,
			headers,
			body: Some(body),
			remote: None,
			anyMap: AnyMap::new(),
			handle: None,
		}
	}

	pub fn reactor_handle(&self) -> Handle {
		self.handle.clone().unwrap()
	}

	/// returns a reference to the request's HttpVersion
	#[inline]
	pub fn version(&self) -> &HttpVersion {
		&self.version
	}

	/// returns a reference to the request's headers
	#[inline]
	pub fn headers(&self) -> &Headers {
		&self.headers
	}

	/// returns a reference to the request's method
	#[inline]
	pub fn method(&self) -> &Method {
		&self.method
	}

	/// returns a request to the request's Uri
	#[inline]
	pub fn uri(&self) -> &Uri {
		&self.uri
	}

	/// returns the query path
	#[inline]
	pub fn path(&self) -> &str {
		self.uri.path()
	}

	/// returns the IP of the connected client.
	/// this should always be set, except in testing environments with `FakeReactor`
	#[inline]
	pub fn remote_ip(&self) -> Option<net::SocketAddr> {
		self.remote
	}

	/// Serializes the query string into a struct via serde.
	///
	///  # Examples
	///
	/// ```rust,ignore
	/// [derive(Serialize, Deserialize)]
	/// struct AccessToken {
	/// 	token: String,
	/// }
	///
	/// #[service]
	/// pub fn login(req: Request, _res: Response) {
	/// 	if let Ok(AccessToken { token }) = req.query() {
	/// 		// do something with the token here.
	/// 	}
	/// }
	/// ```
	///

	#[inline]
	pub fn query<T>(&self) -> Result<T, QueryParseError>
	where
		T: DeserializeOwned,
	{
		self
			.uri
			.query()
			.ok_or(QueryParseError::None)
			.and_then(|query| parse(query).map_err(QueryParseError::ParseError))
			.and_then(|value| from_value::<T>(value).map_err(QueryParseError::SerdeError))
	}

	/// Get the url params for the request
	///
	/// e.g `/profile/:id`
	///
	/// ```rust,ignore
	/// [service]
	/// pub fn ProfileService(req: Request, res: Response) {
	/// 	let profileId = req.params().unwrap()["id"];
	/// 	// Its safe to unwrap here as this woute would never be matched without the `id`
	/// }
	/// ```
	pub fn params(&self) -> Option<&Params> {
		self.anyMap.get::<Params>()
	}

	/// The request struct constains an `AnyMap` so that middlewares can append additional
	/// information.
	///
	/// you can get values out of the `AnyMap` by using this method.
	///
	/// # Examples
	///
	/// ```rust,ignore
	/// [derive(Serialize, Deserialize)]
	/// struct AccessToken {
	/// 	token: String,
	/// }
	///
	/// struct User {
	/// 	name: String,
	/// }
	///
	/// [middleware(Request)]
	/// pub fn AssertAuth(req: Request) {
	/// 	if let AccessToken { token } = req.query::<AccessToken>() {
	/// 		if let user = db::fetchUser::<User>(token) {
	/// 			// pseudo code
	/// 			req.set::<User>(user); // Set the user
	/// 		} else {
	/// 			return Err((404, "User Not Found!").into());
	/// 		}
	/// 	} else {
	/// 		return Err((401, "Unauthorized!").into());
	/// 	}
	/// }
	///
	/// [service]
	/// pub fn ProfileService(req: Request, res: Response) {
	/// 	let user = req.get::<User>().unwrap();
	/// 	// Its safe to unwrap here, because if user isn't set this service will never
	/// 	// be called.
	/// }
	/// ```
	pub fn get<T: 'static>(&self) -> Option<&T> {
		self.anyMap.get::<T>()
	}


	/// set a type on the request.
	pub fn set<T: 'static>(&mut self, value: T) -> Option<T> {
		self.anyMap.insert::<T>(value)
	}

	/// removes the type previously set on the request.
	pub fn remove<T: 'static>(&mut self) -> Option<T> {
		self.anyMap.remove::<T>()
	}

	/// move the request body. note that this takes ownership of `self`, use
	/// wisely.
	#[inline]
	pub fn body(self) -> Body {
		self.body.unwrap_or_default()
	}

	/// serialize the request's json value into a struct
	///
	/// Note that the json value needs to have been previously set on the request by a middleware.
	/// otherwise this would return `Err(JsonError::None)`
	pub fn json<T>(&self) -> Result<T, JsonError>
	where
		T: DeserializeOwned,
	{
		match self.get::<Chunk>() {
			Some(ref slice) => from_slice::<T>(slice).map_err(JsonError::Err),
			_ => Err(JsonError::None),
		}
	}

	/// get a reference to the body
	#[inline]
	pub fn body_ref(&self) -> Option<&Body> {
		self.body.as_ref()
	}

	/// set the request body
	pub fn set_body(&mut self, body: Body) {
		self.body = Some(body)
	}

	/// Decontruct this request.
	pub fn deconstruct(self) -> (Method, Uri, HttpVersion, Headers, Body) {
		(
			self.method,
			self.uri,
			self.version,
			self.headers,
			self.body.unwrap_or_default(),
		)
	}
}

impl fmt::Debug for Request {
	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
		f.debug_struct("Request")
			.field("method", &self.method)
			.field("uri", &self.uri)
			.field("version", &self.version)
			.field("remote", &self.remote)
			.field("headers", &self.headers)
			.finish()
	}
}