use crate::{Request, Result}; use gophermap::{GopherMenu, ItemType}; use std::{ fs, io::{self, prelude::*, BufReader, Read, Write}, net::{TcpListener, TcpStream}, os::unix::fs::PermissionsExt, path::Path, process::Command, str, }; use threadpool::ThreadPool; /// phd tries to be light on resources, so we only allow a low number /// of simultaneous connections. const MAX_WORKERS: usize = 10; /// how many bytes of a file to read when trying to guess binary vs text? const MAX_PEEK_SIZE: usize = 1024; /// Files not displayed in directory listings. const IGNORED_FILES: [&str; 3] = ["header.gph", "footer.gph", ".reverse"]; /// Starts a Gopher server at the specified host, port, and root directory. pub fn start(host: &str, port: u16, root: &str) -> Result<()> { let addr = format!("{}:{}", host, port); let listener = TcpListener::bind(&addr)?; let full_root_path = fs::canonicalize(&root)?.to_string_lossy().to_string(); let pool = ThreadPool::new(MAX_WORKERS); println!("-> Listening on {} at {}", addr, full_root_path); for stream in listener.incoming() { let stream = stream?; println!("-> Connection from: {}", stream.peer_addr()?); let req = Request::from(host, port, root)?; pool.execute(move || { if let Err(e) = accept(stream, req) { eprintln!("-! {}", e); } }); } Ok(()) } /// Reads from the client and responds. fn accept(stream: TcpStream, mut req: Request) -> Result<()> { let reader = BufReader::new(&stream); let mut lines = reader.lines(); if let Some(Ok(line)) = lines.next() { println!("-> Client sent: {:?}", line); req.parse_request(&line); write_response(&stream, req)?; } Ok(()) } /// Writes a response to a client based on a Request. fn write_response<'a, W>(w: &'a W, mut req: Request) -> Result<()> where &'a W: Write, { let path = req.file_path(); // check for dir.gph if we're looking for dir let mut gph_file = path.clone(); gph_file.push_str(".gph"); if fs_exists(&gph_file) { req.selector = req.selector.trim_end_matches('/').into(); req.selector.push_str(".gph"); return write_gophermap(w, req); } else { // check for index.gph if we're looking for dir let mut index = path.clone(); index.push_str("/index.gph"); if fs_exists(&index) { req.selector.push_str("/index.gph"); return write_gophermap(w, req); } } let meta = match fs::metadata(&path) { Ok(meta) => meta, Err(_) => return write_not_found(w, req), }; if path.ends_with(".gph") { write_gophermap(w, req) } else if meta.is_file() { write_file(w, req) } else if meta.is_dir() { write_dir(w, req) } else { Ok(()) } } /// Send a directory listing (menu) to the client based on a Request. fn write_dir<'a, W>(w: &'a W, req: Request) -> Result<()> where &'a W: Write, { let path = req.file_path(); if !fs_exists(&path) { return write_not_found(w, req); } let mut header = path.clone(); header.push_str("/header.gph"); if fs_exists(&header) { let mut sel = req.selector.clone(); sel.push_str("/header.gph"); write_gophermap( w, Request { selector: sel, ..req.clone() }, )?; } let mut menu = GopherMenu::with_write(w); let rel_path = req.relative_file_path(); // sort directory entries let mut paths: Vec<_> = fs::read_dir(&path)?.filter_map(|r| r.ok()).collect(); let mut reverse = path.clone(); reverse.push_str("/.reverse"); let is_dir = |entry: &fs::DirEntry| match entry.file_type() { Ok(t) => t.is_dir(), _ => false, }; if fs_exists(&reverse) { paths.sort_by_key(|entry| (!is_dir(&entry), std::cmp::Reverse(entry.path()))); } else { paths.sort_by_key(|entry| (!is_dir(&entry), entry.path())); } for entry in paths { let file_name = entry.file_name(); let f = file_name.to_string_lossy().to_string(); if f.chars().nth(0) == Some('.') || IGNORED_FILES.contains(&f.as_ref()) { continue; } let mut path = rel_path.clone(); path.push('/'); path.push_str(&file_name.to_string_lossy()); menu.write_entry( file_type(&entry), &file_name.to_string_lossy(), &path, &req.host, req.port, )?; } let mut footer = path.clone(); footer.push_str("/footer.gph"); if fs_exists(&footer) { let mut sel = req.selector.clone(); sel.push_str("/footer.gph"); write_gophermap( w, Request { selector: sel, ..req.clone() }, )?; } menu.end()?; Ok(()) } /// Send a file to the client based on a Request. fn write_file<'a, W>(mut w: &'a W, req: Request) -> Result<()> where &'a W: Write, { let mut f = fs::File::open(&req.file_path())?; io::copy(&mut f, &mut w)?; Ok(()) } /// Send a gophermap (menu) to the client based on a Request. fn write_gophermap<'a, W>(mut w: &'a W, req: Request) -> Result<()> where &'a W: Write, { let path = req.file_path(); // Run the file and use its output as content if it's executable. let reader = if is_executable(&path) { shell(&path, &[&req.query, &req.host, &req.port.to_string()])? } else { fs::read_to_string(path)? }; for line in reader.lines() { let mut line = line.trim_end_matches("\r").to_string(); match line.chars().filter(|&c| c == '\t').count() { 0 => { // Insert `i` prefix to any prefix-less lines without tabs. if line.chars().nth(0) != Some('i') { line.insert(0, 'i'); } line.push_str(&format!("\t(null)\t{}\t{}", req.host, req.port)) } // Auto-add host and port to lines with just a selector. 1 => line.push_str(&format!("\t{}\t{}", req.host, req.port)), 2 => line.push_str(&format!("\t{}", req.port)), _ => {} } line.push_str("\r\n"); w.write_all(line.as_bytes())?; } Ok(()) } fn write_not_found<'a, W>(mut w: &'a W, req: Request) -> Result<()> where &'a W: Write, { let line = format!("3Not Found: {}\t/\tnone\t70\r\n", req.selector); w.write_all(line.as_bytes())?; Ok(()) } /// Determine the gopher type for a DirEntry on disk. fn file_type(dir: &fs::DirEntry) -> ItemType { let metadata = match dir.metadata() { Err(_) => return ItemType::Error, Ok(md) => md, }; if metadata.is_file() { if let Ok(file) = fs::File::open(&dir.path()) { let mut buffer: Vec = vec![]; let _ = file.take(MAX_PEEK_SIZE as u64).read_to_end(&mut buffer); if content_inspector::inspect(&buffer).is_binary() { ItemType::Binary } else { ItemType::File } } else { ItemType::Error } } else if metadata.is_dir() { ItemType::Directory } else { ItemType::Error } } /// Does the file exist? Y'know. fn fs_exists(path: &str) -> bool { Path::new(path).exists() } /// Is the file at the given path executable? fn is_executable(path: &str) -> bool { if let Ok(meta) = fs::metadata(path) { meta.permissions().mode() & 0o111 != 0 } else { false } } /// Run a script and return its output. fn shell(path: &str, args: &[&str]) -> Result { let output = Command::new(path).args(args).output()?; if output.status.success() { Ok(str::from_utf8(&output.stdout)?.to_string()) } else { Ok(str::from_utf8(&output.stderr)?.to_string()) } }