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
use crate::config::{Config, OctaneConfig, Ssl};
use crate::constants::*;
use crate::error::Error;
use crate::http::{KeepAliveState, Validator};
use crate::request::{parse_without_body, Headers, Request, RequestLine};
use crate::responder::{BoxReader, Response, StatusCode};
use crate::router::{Closure, Flow, Route, Router, RouterResult};
use crate::tls::AsMutStream;
use crate::util::find_in_slice;
use crate::{default, route};
use std::error::Error as StdError;
use std::marker::Unpin;
use std::net::{Ipv4Addr, SocketAddrV4};
use std::path::PathBuf as StdPathBuf;
use std::str;
use std::sync::Arc;
use std::time::Duration;
use tokio::io::{copy, AsyncRead, AsyncWrite, AsyncWriteExt};
use tokio::net::TcpListener;
use tokio::prelude::*;
use tokio::runtime::Builder;
use tokio::stream::StreamExt;
#[macro_export]
macro_rules! declare_error {
($stream : expr, $error_type : expr, $settings : expr) => {
Error::err($error_type, $settings, $stream).await?;
return Ok(());
};
}
/// The octane server
///
/// # Example
///
/// ```no_run
/// use octane::server::Octane;
/// use octane::{route, router::{Flow, Route}};
///
/// fn main() {
/// let mut app = Octane::new();
/// app.get(
/// "/",
/// route!(
/// |req, res| {
/// res.send("Hello, World");
/// Flow::Stop
/// }
/// ),
/// );
///
/// app.listen(8080).expect("Cannot establish connection");
/// }
/// ```
pub struct Octane {
pub settings: OctaneConfig,
pub router: Router,
}
impl Octane {
/// Creates a new server instance with empty config and empty router
pub fn new() -> Self {
Octane {
settings: OctaneConfig::new(),
router: Router::new(),
}
}
/// **Appends** the router routes to the routes that
/// the server instance holds, this allows you to
/// independently add routes to a route Router structure
/// and then use it with the server struct
///
/// # Example
///
/// ```no_run
/// use octane::server::Octane;
/// use octane::{route, router::{Flow, Route, Router}};
///
/// let mut app = Octane::new();
/// let mut router = Router::new();
/// router.get("/", route!(|req, res| { res.send("It's a get request!!"); Flow::Stop }));
/// router.post("/", route!(|req, res| { res.send("It's a post request!!"); Flow::Stop }));
/// app.with_router(router);
/// ```
///
/// Note that it appends, meaning if you have 3 routes in
/// Router struct and 3 routes in the Octane struct,
/// you'll have total 3 + 3 routes in the Octane struct.
pub fn with_router(&mut self, router: Router) {
self.router.append(router);
}
/// Appends the config of the Octane struct with a custom
/// generated one. The Octane struct contains an OctaneConfig
/// instance by default
///
/// # Example
///
/// ```no_run
/// use octane::server::Octane;
/// use octane::config::{OctaneConfig, Config};
/// use octane::{route, router::{Flow, Route}};
///
/// let mut app = Octane::new();
/// let mut config = OctaneConfig::new();
/// config.ssl.key("key.pem").cert("cert.pem"); // we supply some ssl certs and key in the config
/// app.with_config(config);
/// ```
///
/// **Note**: While it replaces properties that must be unique
/// i.e which can only have one value at a time, so for
/// static_dirs, it appends the locations defined in config
/// with the settings that Octane struct already has
pub fn with_config(&mut self, config: OctaneConfig) {
self.settings.append(config);
}
/// Returns a closure which can be used with the add or add_route method
/// to serve a static directory.
///
/// # Example
///
/// ```no_run
/// use octane::server::Octane;
/// use octane::router::Route;
///
/// let mut app = Octane::new();
///
/// app.add(Octane::static_dir(concat!(
/// env!("CARGO_MANIFEST_DIR"),
/// "/pub_dir_name"
/// )));
/// ```
pub fn static_dir(dir: &'static str) -> Closure {
route!(|req, res| {
let static_dir_name = std::path::PathBuf::from(dir);
let final_url = static_dir_name.join(req.request_line.path.to_std_pathbuf());
let final_string = final_url.to_str().unwrap();
if &final_string[final_string.len() - 1..] == "/" {
let stripped = &final_string[..final_string.len() - 1];
res.send_file(stripped).expect("File not found!!");
} else {
res.send_file(final_string).expect("File not found!!");
};
Flow::Next
})
}
/// Start listening on the port specified, the listen
/// function also starts the Ssl server if the features
/// are enabled and the key/certs are provided
///
/// # Example
/// ```no_run
/// use octane::server::Octane;
///
/// fn main() {
/// let mut app = Octane::new();
/// app.listen(80).expect("Cannot establish connection");
/// }
/// ```
pub fn listen(self, port: u16) -> Result<(), Box<dyn StdError>> {
let mut builder = Builder::new();
builder
.threaded_scheduler()
.enable_io()
.thread_stack_size(32 * 10000000)
.thread_name("Octane-main");
if let Some(threads) = &self.settings.worker_threads {
builder.core_threads(*threads);
}
let mut runtime = builder.build()?;
let mut ssl = false;
runtime.block_on(async {
let mut listener =
TcpListener::bind(SocketAddrV4::new(Ipv4Addr::new(0, 0, 0, 0), port)).await?;
let server = Arc::new(self);
#[cfg(any(feature = "openSSL", feature = "rustls"))]
{
let mut ssl_listener = TcpListener::bind(SocketAddrV4::new(
Ipv4Addr::new(0, 0, 0, 0),
server.settings.ssl.port,
))
.await?;
server.settings.ssl.validate();
ssl = true;
#[cfg(feature = "openSSL")]
let acceptor = crate::tls::openssl::acceptor(&server.settings)?;
#[cfg(feature = "rustls")]
let acceptor = crate::tls::rustls::acceptor(&server.settings)?;
let server_clone = Arc::clone(&server);
tokio::spawn(async move {
while let Some(stream) = StreamExt::next(&mut ssl_listener).await {
let server_clone = Arc::clone(&server_clone);
let acceptor = acceptor.clone();
tokio::spawn(async move {
match stream {
Ok(value) => {
#[cfg(feature = "rustls")]
let stream = acceptor.accept(value).await;
#[cfg(feature = "openSSL")]
let stream = tokio_openssl::accept(&acceptor, value).await;
match stream {
Ok(stream_ssl) => {
match Octane::serve(stream_ssl, server_clone).await {
Err(e) => panic!("{}", e),
_ => (),
}
}
Err(e) => panic!(e),
}
}
Err(e) => panic!(e),
};
});
}
});
}
println!("{}", server.settings.startup_string(ssl, port));
while let Some(stream) = StreamExt::next(&mut listener).await {
let server_clone = Arc::clone(&server);
tokio::spawn(async move {
match stream {
Ok(value) => match Octane::serve(value, server_clone).await {
Err(e) => panic!("{}", e),
_ => (),
},
Err(e) => panic!(e),
};
});
}
Ok(())
})
}
async fn serve<S>(mut stream_async: S, server: Arc<Octane>) -> Result<(), Box<dyn StdError>>
where
S: AsyncRead + AsyncWrite + Unpin + AsMutStream,
{
let settings = &server.settings;
let mut data = Vec::<u8>::new();
let mut buf: [u8; BUF_SIZE] = [0; BUF_SIZE];
let body: &[u8];
let request_line: RequestLine;
let headers: Headers;
let body_remainder: &[u8];
loop {
let read = stream_async.read(&mut buf).await?;
if read == 0 {
declare_error!(stream_async, StatusCode::BadRequest, settings);
}
let cur = &buf[..read];
data.extend_from_slice(cur);
if let Some(i) = find_in_slice(&data[..], b"\r\n\r\n") {
let first = &data[..i];
body_remainder = &data[i + 4..];
if let Ok(Some((rl, heads))) = str::from_utf8(first).map(parse_without_body) {
request_line = rl;
headers = heads;
break;
} else {
declare_error!(stream_async, StatusCode::BadRequest, settings);
}
}
}
let body_len = headers
.get("content-length")
.and_then(|s| s.parse().ok())
.unwrap_or(0);
let mut body_vec: Vec<u8>;
if body_len > 0 {
if body_remainder.len() < body_len {
let mut temp: Vec<u8> = vec![0; body_len - body_remainder.len()];
stream_async.read_exact(&mut temp[..]).await?;
body_vec = Vec::with_capacity(body_len);
body_vec.extend_from_slice(body_remainder);
body_vec.extend_from_slice(&temp[..]);
body = &body_vec[..];
} else {
body = body_remainder;
}
} else {
body = &[];
}
if let Some(request) = Request::parse(request_line, headers, body) {
let request_line = &request.request_line;
let mut res = Response::new_from_slice(b"");
// Detect http version and validate
let checker = Validator::validate(&request);
if checker.is_malformed() {
declare_error!(stream_async, checker.err_code.unwrap(), settings);
}
match checker.keep_alive {
KeepAliveState::UserDefined => stream_async
.stream_mut()
.set_keepalive(server.settings.keep_alive)?,
KeepAliveState::Particular(x) => {
stream_async.stream_mut().set_keepalive(Some(x))?
}
KeepAliveState::Close => {
res.set("Connection", "Close");
}
}
// Check for http2 connection header here, if found then call a http2 parse
// function that will parse http2 frames and parse the request from that
if let Some(x) = request.headers.get("connection") {
if x == "upgrade" {
// upgrade here
}
}
if request_line.method.is_some() {
// run closures
server.router.run(request.clone(), &mut res).await;
if res.content_len.unwrap_or(0) == 0 {
declare_error!(stream_async, StatusCode::NotFound, settings);
}
Octane::send_data(res.get_data(), stream_async).await?;
} else {
declare_error!(stream_async, StatusCode::NotImplemented, settings);
}
} else {
declare_error!(stream_async, StatusCode::BadRequest, settings);
}
Ok(())
}
async fn send_data<S>(
mut response: (String, BoxReader),
mut stream_async: S,
) -> Result<(), Box<dyn StdError>>
where
S: AsyncWrite + Unpin,
{
stream_async.write_all(response.0.as_bytes()).await?;
copy(&mut response.1, &mut stream_async).await?;
Ok(())
}
}
default!(Octane);
impl Route for Octane {
fn option(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.option(path, closure)
}
fn head(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.head(path, closure)
}
fn put(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.put(path, closure)
}
fn get(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.get(path, closure)
}
fn post(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.post(path, closure)
}
fn add(&mut self, closure: Closure) -> RouterResult {
self.router.add(closure)
}
fn add_route(&mut self, path: &str, closure: Closure) -> RouterResult {
self.router.add_route(path, closure)
}
}
impl Config for Octane {
fn set_keepalive(&mut self, duration: Duration) {
self.settings.keep_alive = Some(duration);
}
fn set_404_file(&mut self, dir_name: &'static str) {
self.settings.file_404 = Some(StdPathBuf::from(dir_name));
}
fn with_ssl_config(&mut self, ssl_conf: Ssl) {
self.settings.ssl.key = ssl_conf.key;
self.settings.ssl.cert = ssl_conf.cert;
}
fn ssl(&mut self, port: u16) -> &mut Ssl {
self.settings.ssl.port = port;
&mut self.settings.ssl
}
}