      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

    // Copyright 2015-2017 Parity Technologies (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/>.

    //! `WebSockets` server.

    use ws;
    use std;
    use std::thread;
    use std::path::PathBuf;
    use std::default::Default;
    use std::ops::Drop;
    use std::sync::Arc;
    use std::net::SocketAddr;
    use io::{PanicHandler, OnPanicListener, MayPanic};
    use jsonrpc_core::Metadata;
    use jsonrpc_core::reactor::RpcHandler;
    use rpc::ConfirmationsQueue;

    mod session;

    /// Signer startup error
    #[derive(Debug)]
    pub enum ServerError {
    	/// Wrapped `std::io::Error`
    	IoError(std::io::Error),
    	/// Other `ws-rs` error
    	WebSocket(ws::Error)
    }

    impl From<ws::Error> for ServerError {
    	fn from(err: ws::Error) -> Self {
    		match err.kind {
    			ws::ErrorKind::Io(e) => ServerError::IoError(e),
    			_ => ServerError::WebSocket(err),
    		}
    	}
    }

    /// Builder for `WebSockets` server
    pub struct ServerBuilder {
    	queue: Arc<ConfirmationsQueue>,
    	authcodes_path: PathBuf,
    	skip_origin_validation: bool,
    }

    impl ServerBuilder {
    	/// Creates new `ServerBuilder`
    	pub fn new(queue: Arc<ConfirmationsQueue>, authcodes_path: PathBuf) -> Self {
    		ServerBuilder {
    			queue: queue,
    			authcodes_path: authcodes_path,
    			skip_origin_validation: false,
    		}
    	}

    	/// If set to `true` server will not verify Origin of incoming requests.
    	/// Not recommended. Use only for development.
    	pub fn skip_origin_validation(mut self, skip: bool) -> Self {
    		self.skip_origin_validation = skip;
    		self
    	}

    	/// Starts a new `WebSocket` server in separate thread.
    	/// Returns a `Server` handle which closes the server when droped.
    	pub fn start<M: Metadata>(self, addr: SocketAddr, handler: RpcHandler<M>) -> Result<Server, ServerError> {
    		Server::start(addr, handler, self.queue, self.authcodes_path, self.skip_origin_validation)
    	}
    }

    /// `WebSockets` server implementation.
    pub struct Server {
    	handle: Option<thread::JoinHandle<()>>,
    	broadcaster_handle: Option<thread::JoinHandle<()>>,
    	queue: Arc<ConfirmationsQueue>,
    	panic_handler: Arc<PanicHandler>,
    	addr: SocketAddr,
    }

    impl Server {
    	/// Returns the address this server is listening on
    	pub fn addr(&self) -> &SocketAddr {
    		&self.addr
    	}

    	/// Starts a new `WebSocket` server in separate thread.
    	/// Returns a `Server` handle which closes the server when droped.
    	fn start<M: Metadata>(addr: SocketAddr, handler: RpcHandler<M>, queue: Arc<ConfirmationsQueue>, authcodes_path: PathBuf, skip_origin_validation: bool) -> Result<Server, ServerError> {
    		let config = {
    			let mut config = ws::Settings::default();
    			// accept only handshakes beginning with GET
    			config.method_strict = true;
    			// Was shutting down server when suspending on linux:
    			config.shutdown_on_interrupt = false;
    			config
    		};

    		// Create WebSocket
    		let origin = format!("{}", addr);
    		let ws = ws::Builder::new().with_settings(config).build(
    			session::Factory::new(handler, origin, authcodes_path, skip_origin_validation)
    		)?;

    		let panic_handler = PanicHandler::new_in_arc();
    		let ph = panic_handler.clone();
    		let broadcaster = ws.broadcaster();

    		// Spawn a thread with event loop
    		let handle = thread::spawn(move || {
    			ph.catch_panic(move || {
    				match ws.listen(addr).map_err(ServerError::from) {
    					Err(ServerError::IoError(io)) => die(format!(
    						"Signer: Could not start listening on specified address. Make sure that no other instance is running on Signer's port. Details: {:?}",
    						io
    					)),
    					Err(any_error) => die(format!(
    						"Signer: Unknown error occurred when starting Signer. Details: {:?}",
    						any_error
    					)),
    					Ok(server) => server,
    				}
    			}).unwrap();
    		});

    		// Spawn a thread for broadcasting
    		let ph = panic_handler.clone();
    		let q = queue.clone();
    		let broadcaster_handle = thread::spawn(move || {
    			ph.catch_panic(move || {
    				q.start_listening(|_message| {
    					// TODO [ToDr] Some better structure here for messages.
    					broadcaster.send("new_message").unwrap();
    				}).expect("It's the only place we are running start_listening. It shouldn't fail.");
    				let res = broadcaster.shutdown();

    				if let Err(e) = res {
    					warn!("Signer: Broadcaster was not closed cleanly. Details: {:?}", e);
    				}
    			}).unwrap()
    		});

    		// Return a handle
    		Ok(Server {
    			handle: Some(handle),
    			broadcaster_handle: Some(broadcaster_handle),
    			queue: queue,
    			panic_handler: panic_handler,
    			addr: addr,
    		})
    	}
    }

    impl MayPanic for Server {
    	fn on_panic<F>(&self, closure: F) where F: OnPanicListener {
    		self.panic_handler.on_panic(closure);
    	}
    }

    impl Drop for Server {
    	fn drop(&mut self) {
    		self.queue.finish();
    		self.broadcaster_handle.take().unwrap().join().unwrap();
    		self.handle.take().unwrap().join().unwrap();
    	}
    }

    fn die(msg: String) -> ! {
    	println!("ERROR: {}", msg);
    	std::process::exit(1);
    }

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
⇤
  Move up in search results
⇥
  Move down in search results
⏎
  Go to active search result
+
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)