Ensure translate_path is applied correctly

Author: Qard

crates/php/src/embed.rs

@@ -160,13 +160,15 @@ impl Handler for Embed {
   /// # Examples
   ///
   /// ```
-  /// use std::env::current_dir;
-  /// use php::{Embed, Handler, Request, Response};
+  /// use std::{env::temp_dir, fs::File, io::Write};
+  /// use php::{Embed, Handler, Request, Response, MockRoot};
   ///
-  /// let docroot = current_dir()
-  ///   .expect("should have current_dir");
+  /// let docroot = MockRoot::builder()
+  ///   .file("index.php", "<?php echo \"Hello, World!\"; ?>")
+  ///   .build()
+  ///   .expect("should prepare docroot");
   ///
-  /// let handler = Embed::new(docroot, None)
+  /// let handler = Embed::new(docroot.clone(), None)
   ///   .expect("should construct Embed");
   ///
   /// let request = Request::builder()

crates/php/src/exception.rs

@@ -1,5 +1,5 @@
 /// Set of exceptions which may be produced by php::Embed
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 pub enum EmbedStartError {
   DocRootNotFound(String),
   ExeLocationNotFound,
@@ -20,7 +20,7 @@ impl std::fmt::Display for EmbedStartError {
   }
 }
 
-#[derive(Debug)]
+#[derive(Debug, PartialEq, Eq, Hash)]
 pub enum EmbedRequestError {
   SapiNotStarted,
   SapiNotShutdown,

crates/php/src/lib.rs

@@ -7,9 +7,11 @@ mod request_context;
 mod sapi;
 mod scopes;
 mod strings;
+mod test;
 
 pub use lang_handler::{rewrite, Handler, Header, Headers, Request, RequestBuilder, Response, Url};
 
 pub use embed::Embed;
 pub use exception::{EmbedRequestError, EmbedStartError};
 pub use request_context::RequestContext;
+pub use test::MockRoot;

crates/php/src/strings.rs

@@ -56,16 +56,60 @@ where
 {
   let docroot = docroot.as_ref().to_path_buf();
   let request_uri = request_uri.as_ref();
+
   let relative_uri = request_uri.strip_prefix("/").map_err(|_| {
     let uri = request_uri.display().to_string();
     EmbedRequestError::ExpectedAbsoluteRequestUri(uri)
   })?;
 
   let exact = docroot.join(relative_uri);
 
-  exact.join("index.php").canonicalize().or_else(|_| {
-    exact
-      .canonicalize()
-      .map_err(|_| EmbedRequestError::ScriptNotFound(exact.display().to_string()))
-  })
+  // NOTE: String conversion is necessary. If Path::ends_with("/") is used it
+  // will discard the trailing slash first.
+  if request_uri.display().to_string().ends_with("/") {
+    try_path(exact.join("index.php")).or_else(|_| try_path(exact))
+  } else {
+    try_path(exact)
+  }
+}
+
+fn try_path<P: AsRef<Path>>(path: P) -> Result<PathBuf, EmbedRequestError> {
+  let path = path.as_ref();
+  let true_path = path
+    .canonicalize()
+    .map_err(|_| EmbedRequestError::ScriptNotFound(path.display().to_string()))?;
+
+  if true_path.is_file() {
+    Ok(true_path)
+  } else {
+    Err(EmbedRequestError::ScriptNotFound(
+      path.display().to_string(),
+    ))
+  }
+}
+
+#[cfg(test)]
+mod test {
+  use super::*;
+  use crate::MockRoot;
+
+  #[test]
+  fn test_translate_path() {
+    let docroot = MockRoot::builder()
+      .file("/index.php", "<?php echo \"index\"; ?>")
+      .file("/foo/index.php", "<?php echo \"sub\"; ?>")
+      .build()
+      .expect("should prepare docroot");
+
+    assert_eq!(
+      translate_path(docroot.clone(), "/foo/"),
+      Ok(docroot.join("foo/index.php"))
+    );
+    assert_eq!(
+      translate_path(docroot.clone(), "/foo"),
+      Err(EmbedRequestError::ScriptNotFound(
+        docroot.join("foo").display().to_string()
+      ))
+    );
+  }
 }

crates/php/src/test.rs

@@ -0,0 +1,95 @@
+use std::{
+  collections::HashMap,
+  env::temp_dir,
+  fs::{create_dir_all, remove_dir_all, File},
+  io::{Error, Write},
+  ops::{Deref, DerefMut},
+  path::{Path, PathBuf},
+};
+
+pub struct MockRoot(PathBuf);
+
+impl MockRoot {
+  pub(crate) fn new<D, H>(docroot: D, files: H) -> Result<Self, Error>
+  where
+    D: AsRef<Path>,
+    H: Into<HashMap<PathBuf, String>>,
+  {
+    let docroot = docroot.as_ref();
+    create_dir_all(docroot)?;
+
+    let map: HashMap<PathBuf, String> = files.into();
+    for (path, contents) in map.iter() {
+      let stripped = path.strip_prefix("/").unwrap_or(path);
+
+      let file_path = docroot.join(stripped);
+      if let Some(parent) = file_path.parent() {
+        create_dir_all(parent)?;
+      }
+
+      let mut file = File::create(file_path)?;
+      file.write_all(contents.as_bytes())?;
+    }
+
+    // This unwrap should be safe due to creating the docroot base dir above.
+    Ok(Self(docroot.canonicalize().unwrap()))
+  }
+
+  pub fn builder() -> MockRootBuilder {
+    MockRootBuilder::default()
+  }
+}
+
+impl Drop for MockRoot {
+  fn drop(&mut self) {
+    remove_dir_all(&self.0).ok();
+  }
+}
+
+impl Deref for MockRoot {
+  type Target = PathBuf;
+
+  fn deref(&self) -> &Self::Target {
+    &self.0
+  }
+}
+
+impl DerefMut for MockRoot {
+  fn deref_mut(&mut self) -> &mut Self::Target {
+    &mut self.0
+  }
+}
+
+#[derive(Debug)]
+pub struct MockRootBuilder(PathBuf, HashMap<PathBuf, String>);
+
+impl MockRootBuilder {
+  pub(crate) fn new<D>(docroot: D) -> Self
+  where
+    D: AsRef<Path>,
+  {
+    Self(docroot.as_ref().to_owned(), HashMap::new())
+  }
+
+  pub fn file<P, C>(mut self, path: P, contents: C) -> MockRootBuilder
+  where
+    P: AsRef<Path>,
+    C: Into<String>,
+  {
+    let path = path.as_ref().to_owned();
+    let contents = contents.into();
+
+    self.1.insert(path, contents);
+    self
+  }
+
+  pub fn build(self) -> Result<MockRoot, Error> {
+    MockRoot::new(self.0, self.1)
+  }
+}
+
+impl Default for MockRootBuilder {
+  fn default() -> Self {
+    Self::new(temp_dir().join("php-temp-dir-base"))
+  }
+}