openethereum/webapp/src/lib.rs

155 lines
4.2 KiB
Rust
Raw Normal View History

2016-04-07 10:49:00 +02:00
// Copyright 2015, 2016 Ethcore (UK) Ltd.
// This file is part of Parity.
// Parity is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// Parity is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
// You should have received a copy of the GNU General Public License
// along with Parity. If not, see <http://www.gnu.org/licenses/>.
//! Ethcore Webapplications for Parity
//! ```
//! extern crate jsonrpc_core;
//! extern crate ethcore_webapp;
//!
//! use std::sync::Arc;
//! use jsonrpc_core::IoHandler;
//! use ethcore_webapp::*;
//!
//! struct SayHello;
//! impl MethodCommand for SayHello {
//! fn execute(&self, _params: Params) -> Result<Value, Error> {
//! Ok(Value::String("hello".to_string()))
//! }
//! }
//!
//! fn main() {
//! let io = IoHandler::new();
//! io.add_method("say_hello", SayHello);
//! let _server = Server::start_unsecure_http(
2016-04-15 07:16:58 +02:00
//! &"127.0.0.1:3030".parse().unwrap(),
//! Arc::new(io)
//! );
//! }
//! ```
//!
2016-04-07 10:49:00 +02:00
#![warn(missing_docs)]
#![cfg_attr(feature="nightly", plugin(clippy))]
#[macro_use]
extern crate log;
2016-04-12 22:44:53 +02:00
extern crate url;
2016-04-07 10:49:00 +02:00
extern crate hyper;
extern crate jsonrpc_core;
extern crate jsonrpc_http_server;
2016-04-07 12:10:26 +02:00
extern crate parity_webapp;
2016-04-07 10:49:00 +02:00
mod endpoint;
2016-04-07 12:10:26 +02:00
mod apps;
mod page;
mod router;
mod rpc;
mod api;
2016-04-07 12:10:26 +02:00
2016-04-23 12:29:12 +02:00
use std::sync::{Arc, Mutex};
use std::net::SocketAddr;
use jsonrpc_core::{IoHandler, IoDelegate};
use router::auth::{Authorization, NoAuth, HttpBasicAuth};
/// Webapps HTTP+RPC server build.
pub struct ServerBuilder {
2016-04-07 10:49:00 +02:00
handler: Arc<IoHandler>,
}
impl ServerBuilder {
/// Construct new webapps
2016-04-07 10:49:00 +02:00
pub fn new() -> Self {
ServerBuilder {
handler: Arc::new(IoHandler::new())
2016-04-07 12:10:26 +02:00
}
2016-04-07 10:49:00 +02:00
}
/// Add io delegate.
2016-04-07 12:10:26 +02:00
pub fn add_delegate<D>(&self, delegate: IoDelegate<D>) where D: Send + Sync + 'static {
2016-04-07 10:49:00 +02:00
self.handler.add_delegate(delegate);
}
/// Asynchronously start server with no authentication,
/// returns result with `Server` handle on success or an error.
pub fn start_unsecure_http(&self, addr: &SocketAddr) -> Result<Server, ServerError> {
Server::start_http(addr, NoAuth, self.handler.clone())
}
/// Asynchronously start server with `HTTP Basic Authentication`,
/// return result with `Server` handle on success or an error.
pub fn start_basic_auth_http(&self, addr: &SocketAddr, username: &str, password: &str) -> Result<Server, ServerError> {
Server::start_http(addr, HttpBasicAuth::single_user(username, password), self.handler.clone())
}
}
/// Webapps HTTP server.
pub struct Server {
server: Option<hyper::server::Listening>,
2016-04-23 12:29:12 +02:00
panic_handler: Arc<Mutex<Option<Box<Fn() -> () + Send>>>>,
}
impl Server {
fn start_http<A: Authorization + 'static>(addr: &SocketAddr, authorization: A, handler: Arc<IoHandler>) -> Result<Server, ServerError> {
2016-04-23 12:29:12 +02:00
let panic_handler = Arc::new(Mutex::new(None));
let endpoints = Arc::new(apps::all_endpoints());
let authorization = Arc::new(authorization);
2016-04-23 12:29:12 +02:00
let rpc_endpoint = Arc::new(rpc::rpc(handler, panic_handler.clone()));
let api = Arc::new(api::RestApi::new(endpoints.clone()));
try!(hyper::Server::http(addr))
.handle(move |_| router::Router::new(
apps::main_page(),
endpoints.clone(),
rpc_endpoint.clone(),
api.clone(),
authorization.clone(),
))
2016-04-23 12:29:12 +02:00
.map(|l| Server {
server: Some(l),
panic_handler: panic_handler,
})
.map_err(ServerError::from)
}
2016-04-23 12:29:12 +02:00
/// Set callback for panics.
pub fn set_panic_handler<F>(&self, handler: F) where F : Fn() -> () + Send + 'static {
*self.panic_handler.lock().unwrap() = Some(Box::new(handler));
}
}
impl Drop for Server {
fn drop(&mut self) {
self.server.take().unwrap().close()
}
}
2016-04-07 10:49:00 +02:00
/// Webapp Server startup error
#[derive(Debug)]
pub enum ServerError {
2016-04-07 13:15:59 +02:00
/// Wrapped `std::io::Error`
IoError(std::io::Error),
2016-04-07 13:15:59 +02:00
/// Other `hyper` error
Other(hyper::error::Error),
}
impl From<hyper::error::Error> for ServerError {
fn from(err: hyper::error::Error) -> Self {
match err {
hyper::error::Error::Io(e) => ServerError::IoError(e),
e => ServerError::Other(e),
}
2016-04-07 10:49:00 +02:00
}
}