Loading local Dapps from FS. (#1214)

* apps list to separate module

* Preparing to support serving files from disk

* Serving files from disk

* Using dapps path from CLI

* Adding more docs

dapps/src/page/builtin.rs

@@ -0,0 +1,154 @@
+// 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/>.
+
+use page::handler;
+use std::sync::Arc;
+use endpoint::{Endpoint, EndpointInfo, EndpointPath, Handler};
+use parity_dapps::{WebApp, File, Info};
+
+pub struct PageEndpoint<T : WebApp + 'static> {
+	/// Content of the files
+	pub app: Arc<T>,
+	/// Prefix to strip from the path (when `None` deducted from `app_id`)
+	pub prefix: Option<String>,
+	/// Safe to be loaded in frame by other origin. (use wisely!)
+	safe_to_embed: bool,
+	info: EndpointInfo,
+}
+
+impl<T: WebApp + 'static> PageEndpoint<T> {
+	/// Creates new `PageEndpoint` for builtin (compile time) Dapp.
+	pub fn new(app: T) -> Self {
+		let info = app.info();
+		PageEndpoint {
+			app: Arc::new(app),
+			prefix: None,
+			safe_to_embed: false,
+			info: EndpointInfo::from(info),
+		}
+	}
+
+	/// Create new `PageEndpoint` and specify prefix that should be removed before looking for a file.
+	/// It's used only for special endpoints (i.e. `/parity-utils/`)
+	/// So `/parity-utils/inject.js` will be resolved to `/inject.js` is prefix is set.
+	pub fn with_prefix(app: T, prefix: String) -> Self {
+		let info = app.info();
+		PageEndpoint {
+			app: Arc::new(app),
+			prefix: Some(prefix),
+			safe_to_embed: false,
+			info: EndpointInfo::from(info),
+		}
+	}
+
+	/// Creates new `PageEndpoint` which can be safely used in iframe
+	/// even from different origin. It might be dangerous (clickjacking).
+	/// Use wisely!
+	pub fn new_safe_to_embed(app: T) -> Self {
+		let info = app.info();
+		PageEndpoint {
+			app: Arc::new(app),
+			prefix: None,
+			safe_to_embed: true,
+			info: EndpointInfo::from(info),
+		}
+	}
+}
+
+impl<T: WebApp> Endpoint for PageEndpoint<T> {
+
+	fn info(&self) -> Option<&EndpointInfo> {
+		Some(&self.info)
+	}
+
+	fn to_handler(&self, path: EndpointPath) -> Box<Handler> {
+		Box::new(handler::PageHandler {
+			app: BuiltinDapp::new(self.app.clone()),
+			prefix: self.prefix.clone(),
+			path: path,
+			file: None,
+			safe_to_embed: self.safe_to_embed,
+		})
+	}
+}
+
+impl From<Info> for EndpointInfo {
+	fn from(info: Info) -> Self {
+		EndpointInfo {
+			name: info.name.into(),
+			description: info.description.into(),
+			author: info.author.into(),
+			icon_url: info.icon_url.into(),
+			version: info.version.into(),
+		}
+	}
+}
+
+struct BuiltinDapp<T: WebApp + 'static> {
+	app: Arc<T>,
+}
+
+impl<T: WebApp + 'static> BuiltinDapp<T> {
+	fn new(app: Arc<T>) -> Self {
+		BuiltinDapp {
+			app: app,
+		}
+	}
+}
+
+impl<T: WebApp + 'static> handler::Dapp for BuiltinDapp<T> {
+	type DappFile = BuiltinDappFile<T>;
+
+	fn file(&self, path: &str) -> Option<Self::DappFile> {
+		self.app.file(path).map(|_| {
+			BuiltinDappFile {
+				app: self.app.clone(),
+				path: path.into(),
+				write_pos: 0,
+			}
+		})
+	}
+}
+
+struct BuiltinDappFile<T: WebApp + 'static> {
+	app: Arc<T>,
+	path: String,
+	write_pos: usize,
+}
+
+impl<T: WebApp + 'static> BuiltinDappFile<T> {
+	fn file(&self) -> &File {
+		self.app.file(&self.path).expect("Check is done when structure is created.")
+	}
+}
+
+impl<T: WebApp + 'static> handler::DappFile for BuiltinDappFile<T> {
+	fn content_type(&self) -> &str {
+		self.file().content_type
+	}
+
+	fn is_drained(&self) -> bool {
+		self.write_pos == self.file().content.len()
+	}
+
+	fn next_chunk(&mut self) -> &[u8] {
+		&self.file().content[self.write_pos..]
+	}
+
+	fn bytes_written(&mut self, bytes: usize) {
+		self.write_pos += bytes;
+	}
+}

dapps/src/page/handler.rs

@@ -0,0 +1,207 @@
+// 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/>.
+
+use std::io::Write;
+use hyper::header;
+use hyper::server;
+use hyper::uri::RequestUri;
+use hyper::net::HttpStream;
+use hyper::status::StatusCode;
+use hyper::{Decoder, Encoder, Next};
+use endpoint::EndpointPath;
+
+/// Represents a file that can be sent to client.
+/// Implementation should keep track of bytes already sent internally.
+pub trait DappFile: Send {
+	/// Returns a content-type of this file.
+	fn content_type(&self) -> &str;
+
+	/// Checks if all bytes from that file were written.
+	fn is_drained(&self) -> bool;
+
+	/// Fetch next chunk to write to the client.
+	fn next_chunk(&mut self) -> &[u8];
+
+	/// How many files have been written to the client.
+	fn bytes_written(&mut self, bytes: usize);
+}
+
+/// Dapp as a (dynamic) set of files.
+pub trait Dapp: Send + 'static {
+	/// File type
+	type DappFile: DappFile;
+
+	/// Returns file under given path.
+	fn file(&self, path: &str) -> Option<Self::DappFile>;
+}
+
+/// A handler for a single webapp.
+/// Resolves correct paths and serves as a plumbing code between
+/// hyper server and dapp.
+pub struct PageHandler<T: Dapp> {
+	/// A Dapp.
+	pub app: T,
+	/// File currently being served (or `None` if file does not exist).
+	pub file: Option<T::DappFile>,
+	/// Optional prefix to strip from path.
+	pub prefix: Option<String>,
+	/// Requested path.
+	pub path: EndpointPath,
+	/// Flag indicating if the file can be safely embeded (put in iframe).
+	pub safe_to_embed: bool,
+}
+
+impl<T: Dapp> PageHandler<T> {
+	fn extract_path(&self, path: &str) -> String {
+		let app_id = &self.path.app_id;
+		let prefix = "/".to_owned() + self.prefix.as_ref().unwrap_or(app_id);
+		let prefix_with_slash = prefix.clone() + "/";
+		let query_pos = path.find('?').unwrap_or_else(|| path.len());
+
+		// Index file support
+		match path == "/" || path == &prefix || path == &prefix_with_slash {
+			true => "index.html".to_owned(),
+			false => if path.starts_with(&prefix_with_slash) {
+				path[prefix_with_slash.len()..query_pos].to_owned()
+			} else if path.starts_with("/") {
+				path[1..query_pos].to_owned()
+			} else {
+				path[0..query_pos].to_owned()
+			}
+		}
+	}
+}
+
+impl<T: Dapp> server::Handler<HttpStream> for PageHandler<T> {
+	fn on_request(&mut self, req: server::Request) -> Next {
+		self.file = match *req.uri() {
+			RequestUri::AbsolutePath(ref path) => {
+				self.app.file(&self.extract_path(path))
+			},
+			RequestUri::AbsoluteUri(ref url) => {
+				self.app.file(&self.extract_path(url.path()))
+			},
+			_ => None,
+		};
+		Next::write()
+	}
+
+	fn on_request_readable(&mut self, _decoder: &mut Decoder<HttpStream>) -> Next {
+		Next::write()
+	}
+
+	fn on_response(&mut self, res: &mut server::Response) -> Next {
+		if let Some(ref f) = self.file {
+			res.set_status(StatusCode::Ok);
+			res.headers_mut().set(header::ContentType(f.content_type().parse().unwrap()));
+			if !self.safe_to_embed {
+				res.headers_mut().set_raw("X-Frame-Options", vec![b"SAMEORIGIN".to_vec()]);
+			}
+			Next::write()
+		} else {
+			res.set_status(StatusCode::NotFound);
+			Next::write()
+		}
+	}
+
+	fn on_response_writable(&mut self, encoder: &mut Encoder<HttpStream>) -> Next {
+		match self.file {
+			None => Next::end(),
+			Some(ref f) if f.is_drained() => Next::end(),
+			Some(ref mut f) => match encoder.write(f.next_chunk()) {
+				Ok(bytes) => {
+					f.bytes_written(bytes);
+					Next::write()
+				},
+				Err(e) => match e.kind() {
+					::std::io::ErrorKind::WouldBlock => Next::write(),
+					_ => Next::end(),
+				},
+			}
+		}
+	}
+}
+
+
+
+#[cfg(test)]
+mod test {
+	use super::*;
+
+	pub struct TestWebAppFile;
+
+	impl DappFile for TestWebAppFile {
+		fn content_type(&self) -> &str {
+			unimplemented!()
+		}
+
+		fn is_drained(&self) -> bool {
+			unimplemented!()
+		}
+
+		fn next_chunk(&mut self) -> &[u8] {
+			unimplemented!()
+		}
+
+		fn bytes_written(&mut self, _bytes: usize) {
+			unimplemented!()
+		}
+	}
+
+	#[derive(Default)]
+	pub struct TestWebapp;
+
+	impl Dapp for TestWebapp {
+		type DappFile = TestWebAppFile;
+
+		fn file(&self, _path: &str) -> Option<Self::DappFile> {
+			None
+		}
+	}
+}
+
+#[test]
+fn should_extract_path_with_appid() {
+
+	// given
+	let path1 = "/";
+	let path2= "/test.css";
+	let path3 = "/app/myfile.txt";
+	let path4 = "/app/myfile.txt?query=123";
+	let page_handler = PageHandler {
+		app: test::TestWebapp,
+		prefix: None,
+		path: EndpointPath {
+			app_id: "app".to_owned(),
+			host: "".to_owned(),
+			port: 8080
+		},
+		file: None,
+		safe_to_embed: true,
+	};
+
+	// when
+	let res1 = page_handler.extract_path(path1);
+	let res2 = page_handler.extract_path(path2);
+	let res3 = page_handler.extract_path(path3);
+	let res4 = page_handler.extract_path(path4);
+
+	// then
+	assert_eq!(&res1, "index.html");
+	assert_eq!(&res2, "test.css");
+	assert_eq!(&res3, "myfile.txt");
+	assert_eq!(&res4, "myfile.txt");
+}

dapps/src/page/local.rs

@@ -0,0 +1,118 @@
+// 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/>.
+
+use mime_guess;
+use std::io::{Seek, Read, SeekFrom};
+use std::fs;
+use std::path::PathBuf;
+use page::handler;
+use endpoint::{Endpoint, EndpointInfo, EndpointPath, Handler};
+
+pub struct LocalPageEndpoint {
+	path: PathBuf,
+	info: EndpointInfo,
+}
+
+impl LocalPageEndpoint {
+	pub fn new(path: PathBuf, info: EndpointInfo) -> Self {
+		LocalPageEndpoint {
+			path: path,
+			info: info,
+		}
+	}
+}
+
+impl Endpoint for LocalPageEndpoint {
+	fn info(&self) -> Option<&EndpointInfo> {
+		Some(&self.info)
+	}
+
+	fn to_handler(&self, path: EndpointPath) -> Box<Handler> {
+		Box::new(handler::PageHandler {
+			app: LocalDapp::new(self.path.clone()),
+			prefix: None,
+			path: path,
+			file: None,
+			safe_to_embed: false,
+		})
+	}
+}
+
+struct LocalDapp {
+	path: PathBuf,
+}
+
+impl LocalDapp {
+	fn new(path: PathBuf) -> Self {
+		LocalDapp {
+			path: path
+		}
+	}
+}
+
+impl handler::Dapp for LocalDapp {
+	type DappFile = LocalFile;
+
+	fn file(&self, file_path: &str) -> Option<Self::DappFile> {
+		let mut path = self.path.clone();
+		for part in file_path.split('/') {
+			path.push(part);
+		}
+		// Check if file exists
+		fs::File::open(path.clone()).ok().map(|file| {
+			let content_type = mime_guess::guess_mime_type(path);
+			let len = file.metadata().ok().map_or(0, |meta| meta.len());
+			LocalFile {
+				content_type: content_type.to_string(),
+				buffer: [0; 4096],
+				file: file,
+				pos: 0,
+				len: len,
+			}
+		})
+	}
+}
+
+struct LocalFile {
+	content_type: String,
+	buffer: [u8; 4096],
+	file: fs::File,
+	len: u64,
+	pos: u64,
+}
+
+impl handler::DappFile for LocalFile {
+	fn content_type(&self) -> &str {
+		&self.content_type
+	}
+
+	fn is_drained(&self) -> bool {
+		self.pos == self.len
+	}
+
+	fn next_chunk(&mut self) -> &[u8] {
+		let _ = self.file.seek(SeekFrom::Start(self.pos));
+		if let Ok(n) = self.file.read(&mut self.buffer) {
+			&self.buffer[0..n]
+		} else {
+			&self.buffer[0..0]
+		}
+	}
+
+	fn bytes_written(&mut self, bytes: usize) {
+		self.pos += bytes as u64;
+	}
+}

dapps/src/page/mod.rs

@@ -14,216 +14,11 @@
 // 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 std::io::Write;
-use hyper::uri::RequestUri;
-use hyper::server;
-use hyper::header;
-use hyper::status::StatusCode;
-use hyper::net::HttpStream;
-use hyper::{Decoder, Encoder, Next};
-use endpoint::{Endpoint, EndpointInfo, EndpointPath};
-use parity_dapps::{WebApp, Info};
 
-pub struct PageEndpoint<T : WebApp + 'static> {
-	/// Content of the files
-	pub app: Arc<T>,
-	/// Prefix to strip from the path (when `None` deducted from `app_id`)
-	pub prefix: Option<String>,
-	/// Safe to be loaded in frame by other origin. (use wisely!)
-	safe_to_embed: bool,
-}
+mod builtin;
+mod local;
+mod handler;
 
-impl<T: WebApp + 'static> PageEndpoint<T> {
-	pub fn new(app: T) -> Self {
-		PageEndpoint {
-			app: Arc::new(app),
-			prefix: None,
-			safe_to_embed: false,
-		}
-	}
+pub use self::local::LocalPageEndpoint;
+pub use self::builtin::PageEndpoint;
 
-	pub fn with_prefix(app: T, prefix: String) -> Self {
-		PageEndpoint {
-			app: Arc::new(app),
-			prefix: Some(prefix),
-			safe_to_embed: false,
-		}
-	}
-
-	/// Creates new `PageEndpoint` which can be safely used in iframe
-	/// even from different origin. It might be dangerous (clickjacking).
-	/// Use wisely!
-	pub fn new_safe_to_embed(app: T) -> Self {
-		PageEndpoint {
-			app: Arc::new(app),
-			prefix: None,
-			safe_to_embed: true,
-		}
-	}
-}
-
-impl<T: WebApp> Endpoint for PageEndpoint<T> {
-
-	fn info(&self) -> Option<EndpointInfo> {
-		Some(EndpointInfo::from(self.app.info()))
-	}
-
-	fn to_handler(&self, path: EndpointPath) -> Box<server::Handler<HttpStream>> {
-		Box::new(PageHandler {
-			app: self.app.clone(),
-			prefix: self.prefix.clone(),
-			path: path,
-			file: None,
-			write_pos: 0,
-			safe_to_embed: self.safe_to_embed,
-		})
-	}
-}
-
-impl From<Info> for EndpointInfo {
-	fn from(info: Info) -> Self {
-		EndpointInfo {
-			name: info.name,
-			description: info.description,
-			author: info.author,
-			icon_url: info.icon_url,
-			version: info.version,
-		}
-	}
-}
-
-struct PageHandler<T: WebApp + 'static> {
-	app: Arc<T>,
-	prefix: Option<String>,
-	path: EndpointPath,
-	file: Option<String>,
-	write_pos: usize,
-	safe_to_embed: bool,
-}
-
-impl<T: WebApp + 'static> PageHandler<T> {
-	fn extract_path(&self, path: &str) -> String {
-		let app_id = &self.path.app_id;
-		let prefix = "/".to_owned() + self.prefix.as_ref().unwrap_or(app_id);
-		let prefix_with_slash = prefix.clone() + "/";
-		let query_pos = path.find('?').unwrap_or_else(|| path.len());
-
-		// Index file support
-		match path == "/" || path == &prefix || path == &prefix_with_slash {
-			true => "index.html".to_owned(),
-			false => if path.starts_with(&prefix_with_slash) {
-				path[prefix_with_slash.len()..query_pos].to_owned()
-			} else if path.starts_with("/") {
-				path[1..query_pos].to_owned()
-			} else {
-				path[0..query_pos].to_owned()
-			}
-		}
-	}
-}
-
-impl<T: WebApp + 'static> server::Handler<HttpStream> for PageHandler<T> {
-	fn on_request(&mut self, req: server::Request) -> Next {
-		self.file = match *req.uri() {
-			RequestUri::AbsolutePath(ref path) => {
-				Some(self.extract_path(path))
-			},
-			RequestUri::AbsoluteUri(ref url) => {
-				Some(self.extract_path(url.path()))
-			},
-			_ => None,
-		};
-		Next::write()
-	}
-
-	fn on_request_readable(&mut self, _decoder: &mut Decoder<HttpStream>) -> Next {
-		Next::write()
-	}
-
-	fn on_response(&mut self, res: &mut server::Response) -> Next {
-		if let Some(f) = self.file.as_ref().and_then(|f| self.app.file(f)) {
-			res.set_status(StatusCode::Ok);
-			res.headers_mut().set(header::ContentType(f.content_type.parse().unwrap()));
-			if !self.safe_to_embed {
-				res.headers_mut().set_raw("X-Frame-Options", vec![b"SAMEORIGIN".to_vec()]);
-			}
-			Next::write()
-		} else {
-			res.set_status(StatusCode::NotFound);
-			Next::write()
-		}
-	}
-
-	fn on_response_writable(&mut self, encoder: &mut Encoder<HttpStream>) -> Next {
-		let (wrote, res) = {
-			let file = self.file.as_ref().and_then(|f| self.app.file(f));
-			match file {
-				None => (None, Next::end()),
-				Some(f) if self.write_pos == f.content.len() => (None, Next::end()),
-				Some(f) => match encoder.write(&f.content[self.write_pos..]) {
-					Ok(bytes) => (Some(bytes), Next::write()),
-					Err(e) => match e.kind() {
-						::std::io::ErrorKind::WouldBlock => (None, Next::write()),
-						_ => (None, Next::end())
-					},
-				}
-			}
-		};
-		if let Some(bytes) = wrote {
-			self.write_pos += bytes;
-		}
-		res
-	}
-}
-
-
-#[cfg(test)]
-use parity_dapps::File;
-
-#[cfg(test)]
-#[derive(Default)]
-struct TestWebapp;
-
-#[cfg(test)]
-impl WebApp for TestWebapp {
-	fn file(&self, _path: &str) -> Option<&File> {
-		None
-	}
-	fn info(&self) -> Info {
-		unimplemented!()
-	}
-}
-
-#[test]
-fn should_extract_path_with_appid() {
-	// given
-	let path1 = "/";
-	let path2= "/test.css";
-	let path3 = "/app/myfile.txt";
-	let path4 = "/app/myfile.txt?query=123";
-	let page_handler = PageHandler {
-		app: Arc::new(TestWebapp),
-		prefix: None,
-		path: EndpointPath {
-			app_id: "app".to_owned(),
-			host: "".to_owned(),
-			port: 8080
-		},
-		file: None,
-		write_pos: 0,
-		safe_to_embed: true,
-	};
-
-	// when
-	let res1 = page_handler.extract_path(path1);
-	let res2 = page_handler.extract_path(path2);
-	let res3 = page_handler.extract_path(path3);
-	let res4 = page_handler.extract_path(path4);
-
-	// then
-	assert_eq!(&res1, "index.html");
-	assert_eq!(&res2, "test.css");
-	assert_eq!(&res3, "myfile.txt");
-	assert_eq!(&res4, "myfile.txt");
-}