      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

    // 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/>.

    use std::sync::Arc;
    use unicase::UniCase;
    use hyper::{server, net, Decoder, Encoder, Next, Control};
    use hyper::header;
    use hyper::method::Method;
    use hyper::header::AccessControlAllowOrigin;

    use api::types::{App, ApiError};
    use api::response;
    use apps::fetcher::Fetcher;

    use handlers::extract_url;
    use endpoint::{Endpoint, Endpoints, Handler, EndpointPath};
    use jsonrpc_http_server::cors;

    #[derive(Clone)]
    pub struct RestApi {
    	cors_domains: Option<Vec<AccessControlAllowOrigin>>,
    	endpoints: Arc<Endpoints>,
    	fetcher: Arc<Fetcher>,
    }

    impl RestApi {
    	pub fn new(cors_domains: Vec<String>, endpoints: Arc<Endpoints>, fetcher: Arc<Fetcher>) -> Box<Endpoint> {
    		Box::new(RestApi {
    			cors_domains: Some(cors_domains.into_iter().map(AccessControlAllowOrigin::Value).collect()),
    			endpoints: endpoints,
    			fetcher: fetcher,
    		})
    	}

    	fn list_apps(&self) -> Vec<App> {
    		self.endpoints.iter().filter_map(|(ref k, ref e)| {
    			e.info().map(|ref info| App::from_info(k, info))
    		}).collect()
    	}
    }

    impl Endpoint for RestApi {
    	fn to_async_handler(&self, path: EndpointPath, control: Control) -> Box<Handler> {
    		Box::new(RestApiRouter::new(self.clone(), path, control))
    	}
    }

    struct RestApiRouter {
    	api: RestApi,
    	origin: Option<String>,
    	path: Option<EndpointPath>,
    	control: Option<Control>,
    	handler: Box<Handler>,
    }

    impl RestApiRouter {
    	fn new(api: RestApi, path: EndpointPath, control: Control) -> Self {
    		RestApiRouter {
    			path: Some(path),
    			origin: None,
    			control: Some(control),
    			api: api,
    			handler: response::as_json_error(&ApiError {
    				code: "404".into(),
    				title: "Not Found".into(),
    				detail: "Resource you requested has not been found.".into(),
    			}),
    		}
    	}

    	fn resolve_content(&self, hash: Option<&str>, path: EndpointPath, control: Control) -> Option<Box<Handler>> {
    		match hash {
    			Some(hash) if self.api.fetcher.contains(hash) => {
    				Some(self.api.fetcher.to_async_handler(path, control))
    			},
    			_ => None
    		}
    	}

    	/// Returns basic headers for a response (it may be overwritten by the handler)
    	fn response_headers(&self) -> header::Headers {
    		let mut headers = header::Headers::new();
    		headers.set(header::AccessControlAllowCredentials);
    		headers.set(header::AccessControlAllowMethods(vec![
    			Method::Options,
    			Method::Post,
    			Method::Get,
    		]));
    		headers.set(header::AccessControlAllowHeaders(vec![
    			UniCase("origin".to_owned()),
    			UniCase("content-type".to_owned()),
    			UniCase("accept".to_owned()),
    		]));

    		if let Some(cors_header) = cors::get_cors_header(&self.api.cors_domains, &self.origin) {
    			headers.set(cors_header);
    		}

    		headers
    	}
    }

    impl server::Handler<net::HttpStream> for RestApiRouter {

    	fn on_request(&mut self, request: server::Request<net::HttpStream>) -> Next {
    		self.origin = cors::read_origin(&request);

    		if let Method::Options = *request.method() {
    			self.handler = response::empty();
    			return Next::write();
    		}

    		let url = extract_url(&request);
    		if url.is_none() {
    			// Just return 404 if we can't parse URL
    			return Next::write();
    		}

    		let url = url.expect("Check for None early-exists above; qed");
    		let mut path = self.path.take().expect("on_request called only once, and path is always defined in new; qed");
    		let control = self.control.take().expect("on_request called only once, and control is always defined in new; qed");

    		let endpoint = url.path.get(1).map(|v| v.as_str());
    		let hash = url.path.get(2).map(|v| v.as_str());
    		// at this point path.app_id contains 'api', adjust it to the hash properly, otherwise
    		// we will try and retrieve 'api' as the hash when doing the /api/content route
    		if let Some(ref hash) = hash { path.app_id = hash.clone().to_owned() }

    		let handler = endpoint.and_then(|v| match v {
    			"apps" => Some(response::as_json(&self.api.list_apps())),
    			"ping" => Some(response::ping()),
    			"content" => self.resolve_content(hash, path, control),
    			_ => None
    		});

    		// Overwrite default
    		if let Some(h) = handler {
    			self.handler = h;
    		}

    		self.handler.on_request(request)
    	}

    	fn on_request_readable(&mut self, decoder: &mut Decoder<net::HttpStream>) -> Next {
    		self.handler.on_request_readable(decoder)
    	}

    	fn on_response(&mut self, res: &mut server::Response) -> Next {
    		*res.headers_mut() = self.response_headers();
    		self.handler.on_response(res)
    	}

    	fn on_response_writable(&mut self, encoder: &mut Encoder<net::HttpStream>) -> Next {
    		self.handler.on_response_writable(encoder)
    	}

    }

# 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`)