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 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
// Copyright 2015 The tiny-http Contributors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/*!
# Simple usage
## Creating the server
The easiest way to create a server is to call `Server::http()`.
The `http()` function returns an `IoResult<Server>` which will return an error
in the case where the server creation fails (for example if the listening port is already
occupied).
```no_run
let server = tiny_http::Server::http("0.0.0.0:0").unwrap();
```
A newly-created `Server` will immediatly start listening for incoming connections and HTTP
requests.
## Receiving requests
Calling `server.recv()` will block until the next request is available.
This function returns an `IoResult<Request>`, so you need to handle the possible errors.
```no_run
# let server = tiny_http::Server::http("0.0.0.0:0").unwrap();
loop {
// blocks until the next request is received
let request = match server.recv() {
Ok(rq) => rq,
Err(e) => { println!("error: {}", e); break }
};
// do something with the request
// ...
}
```
In a real-case scenario, you will probably want to spawn multiple worker tasks and call
`server.recv()` on all of them. Like this:
```no_run
# use std::sync::Arc;
# use std::thread;
# let server = tiny_http::Server::http("0.0.0.0:0").unwrap();
let server = Arc::new(server);
let mut guards = Vec::with_capacity(4);
for _ in (0 .. 4) {
let server = server.clone();
let guard = thread::spawn(move || {
loop {
let rq = server.recv().unwrap();
// ...
}
});
guards.push(guard);
}
```
If you don't want to block, you can call `server.try_recv()` instead.
## Handling requests
The `Request` object returned by `server.recv()` contains informations about the client's request.
The most useful methods are probably `request.method()` and `request.url()` which return
the requested method (`GET`, `POST`, etc.) and url.
To handle a request, you need to create a `Response` object. See the docs of this object for
more infos. Here is an example of creating a `Response` from a file:
```no_run
# use std::fs::File;
# use std::path::Path;
let response = tiny_http::Response::from_file(File::open(&Path::new("image.png")).unwrap());
```
All that remains to do is call `request.respond()`:
```no_run
# use std::fs::File;
# use std::path::Path;
# let server = tiny_http::Server::http("0.0.0.0:0").unwrap();
# let request = server.recv().unwrap();
# let response = tiny_http::Response::from_file(File::open(&Path::new("image.png")).unwrap());
let _ = request.respond(response);
```
*/
#![crate_name = "tiny_http"]
#![crate_type = "lib"]
#![forbid(unsafe_code)]
#[macro_use]
extern crate log;
extern crate ascii;
extern crate chunked_transfer;
extern crate encoding;
extern crate url;
extern crate chrono;
#[cfg(feature = "ssl")]
extern crate openssl;
use std::error::Error;
use std::io::Error as IoError;
use std::io::Result as IoResult;
use std::sync::Arc;
use std::sync::atomic::AtomicBool;
use std::thread;
use std::net;
use std::net::{ToSocketAddrs, TcpStream, Shutdown};
use std::time::Duration;
use std::sync::atomic::Ordering::Relaxed;
use client::ClientConnection;
use util::MessagesQueue;
pub use common::{Header, HeaderField, HTTPVersion, Method, StatusCode};
pub use request::{Request, ReadWrite};
pub use response::{ResponseBox, Response};
mod client;
mod common;
mod request;
mod response;
#[allow(dead_code)] // TODO: remove when everything is implemented
mod util;
/// The main class of this library.
///
/// Destroying this object will immediatly close the listening socket and the reading
/// part of all the client's connections. Requests that have already been returned by
/// the `recv()` function will not close and the responses will be transferred to the client.
pub struct Server {
// should be false as long as the server exists
// when set to true, all the subtasks will close within a few hundreds ms
close: Arc<AtomicBool>,
// queue for messages received by child threads
messages: Arc<MessagesQueue<Message>>,
// result of TcpListener::local_addr()
listening_addr: net::SocketAddr,
}
enum Message {
Error(IoError),
NewRequest(Request),
}
impl From<IoError> for Message {
fn from(e: IoError) -> Message {
Message::Error(e)
}
}
impl From<Request> for Message {
fn from(rq: Request) -> Message {
Message::NewRequest(rq)
}
}
// this trait is to make sure that Server implements Share and Send
#[doc(hidden)]
trait MustBeShareDummy : Sync + Send {}
#[doc(hidden)]
impl MustBeShareDummy for Server {}
pub struct IncomingRequests<'a> {
server: &'a Server
}
/// Represents the parameters required to create a server.
#[derive(Debug, Clone)]
pub struct ServerConfig<A> where A: ToSocketAddrs {
/// The addresses to listen to.
pub addr: A,
/// If `Some`, then the server will use SSL to encode the communications.
pub ssl: Option<SslConfig>,
}
/// Configuration of the server for SSL.
#[derive(Debug, Clone)]
pub struct SslConfig {
/// Contains the public certificate to send to clients.
pub certificate: Vec<u8>,
/// Contains the ultra-secret private key used to decode communications.
pub private_key: Vec<u8>,
}
impl Server {
/// Shortcut for a simple server on a specific address.
#[inline]
pub fn http<A>(addr: A) -> Result<Server, Box<Error + Send + Sync + 'static>>
where A: ToSocketAddrs
{
Server::new(ServerConfig {
addr: addr,
ssl: None,
})
}
/// Shortcut for an HTTPS server on a specific address.
#[cfg(feature = "ssl")]
#[inline]
pub fn https<A>(addr: A, config: SslConfig)
-> Result<Server, Box<Error + Send + Sync + 'static>>
where A: ToSocketAddrs
{
Server::new(ServerConfig {
addr: addr,
ssl: Some(config),
})
}
/// Builds a new server that listens on the specified address.
pub fn new<A>(config: ServerConfig<A>) -> Result<Server, Box<Error + Send + Sync + 'static>>
where A: ToSocketAddrs
{
// building the "close" variable
let close_trigger = Arc::new(AtomicBool::new(false));
// building the TcpListener
let (server, local_addr) = {
let listener = try!(net::TcpListener::bind(config.addr));
let local_addr = try!(listener.local_addr());
debug!("Server listening on {}", local_addr);
(listener, local_addr)
};
// building the SSL capabilities
#[cfg(feature = "ssl")]
type SslContext = openssl::ssl::SslContext;
#[cfg(not(feature = "ssl"))]
type SslContext = ();
let ssl: Option<SslContext> = match config.ssl {
#[cfg(feature = "ssl")]
Some(mut config) => {
use openssl::ssl;
use openssl::x509::X509;
use openssl::pkey::PKey;
use openssl::ssl::SslVerifyMode;
let mut ctxt = try!(SslContext::builder(ssl::SslMethod::tls()));
try!(ctxt.set_cipher_list("DEFAULT"));
let certificate = try!(X509::from_pem(&config.certificate[..]));
try!(ctxt.set_certificate(&certificate));
let private_key = try!(PKey::private_key_from_pem(&config.private_key[..]));
try!(ctxt.set_private_key(&private_key));
ctxt.set_verify(SslVerifyMode::NONE);
try!(ctxt.check_private_key());
// let's wipe the certificate and private key from memory, because we're
// better safe than sorry
for b in &mut config.certificate { *b = 0; }
for b in &mut config.private_key { *b = 0; }
Some(ctxt.build())
},
#[cfg(not(feature = "ssl"))]
Some(_) => return Err("Building a server with SSL requires enabling the `ssl` feature \
in tiny-http".to_owned().into()),
None => None,
};
// creating a task where server.accept() is continuously called
// and ClientConnection objects are pushed in the messages queue
let messages = MessagesQueue::with_capacity(8);
let inside_close_trigger = close_trigger.clone();
let inside_messages = messages.clone();
thread::spawn(move || {
// a tasks pool is used to dispatch the connections into threads
let tasks_pool = util::TaskPool::new();
debug!("Running accept thread");
while !inside_close_trigger.load(Relaxed) {
let new_client = match server.accept() {
Ok((sock, _)) => {
use util::RefinedTcpStream;
let (read_closable, write_closable) = match ssl {
None => {
RefinedTcpStream::new(sock)
},
#[cfg(feature = "ssl")]
Some(ref ssl) => {
let ssl = openssl::ssl::Ssl::new(ssl).expect("Couldn't create ssl");
// trying to apply SSL over the connection
// if an error occurs, we just close the socket and resume listening
let sock = match ssl.accept(sock) {
Ok(s) => s,
Err(_) => continue
};
RefinedTcpStream::new(sock)
},
#[cfg(not(feature = "ssl"))]
Some(_) => unreachable!(),
};
Ok(ClientConnection::new(write_closable, read_closable))
},
Err(e) => Err(e),
};
match new_client {
Ok(client) => {
let messages = inside_messages.clone();
let mut client = Some(client);
tasks_pool.spawn(Box::new(move || {
if let Some(client) = client.take() {
for rq in client {
messages.push(rq.into());
}
}
}));
},
Err(e) => {
error!("Error accepting new client: {}", e);
inside_messages.push(e.into());
break;
}
}
}
debug!("Terminating accept thread");
});
// result
Ok(Server {
messages: messages,
close: close_trigger,
listening_addr: local_addr,
})
}
/// Returns an iterator for all the incoming requests.
///
/// The iterator will return `None` if the server socket is shutdown.
#[inline]
pub fn incoming_requests(&self) -> IncomingRequests {
IncomingRequests { server: self }
}
/// Returns the address the server is listening to.
#[inline]
pub fn server_addr(&self) -> net::SocketAddr {
self.listening_addr.clone()
}
/// Returns the number of clients currently connected to the server.
pub fn num_connections(&self) -> usize {
unimplemented!()
//self.requests_receiver.lock().len()
}
/// Blocks until an HTTP request has been submitted and returns it.
pub fn recv(&self) -> IoResult<Request> {
match self.messages.pop() {
Message::Error(err) => return Err(err),
Message::NewRequest(rq) => return Ok(rq),
}
}
/// Same as `recv()` but doesn't block longer than timeout
pub fn recv_timeout(&self, timeout: Duration) -> IoResult<Option<Request>> {
match self.messages.pop_timeout(timeout) {
Some(Message::Error(err)) => return Err(err),
Some(Message::NewRequest(rq)) => return Ok(Some(rq)),
None => return Ok(None)
}
}
/// Same as `recv()` but doesn't block.
pub fn try_recv(&self) -> IoResult<Option<Request>> {
match self.messages.try_pop() {
Some(Message::Error(err)) => return Err(err),
Some(Message::NewRequest(rq)) => return Ok(Some(rq)),
None => return Ok(None)
}
}
}
impl<'a> Iterator for IncomingRequests<'a> {
type Item = Request;
fn next(&mut self) -> Option<Request> {
self.server.recv().ok()
}
}
impl Drop for Server {
fn drop(&mut self) {
self.close.store(true, Relaxed);
// Connect briefly to ourselves to unblock the accept thread
let maybe_stream = TcpStream::connect(self.listening_addr);
if let Ok(stream) = maybe_stream {
let _ = stream.shutdown(Shutdown::Both);
}
}
}