lycheeverse · mre · Dec 13, 2024 · Nov 28, 2024 · Nov 28, 2024 · Nov 28, 2024
diff --git a/README.md b/README.md
@@ -480,6 +480,9 @@ Options:
   -b, --base <BASE>
           Base URL or website root directory to check relative URLs e.g. <https://example.com> or `/path/to/public`
 
+      --root-path <ROOT_PATH>
+          Root path to use when checking absolute local links, base option is ignored when this is set
+
       --basic-auth <BASIC_AUTH>
           Basic authentication support. E.g. `http://example.com username:password`
 

diff --git a/fixtures/resolve_paths_from_root_path/nested/about/index.html b/fixtures/resolve_paths_from_root_path/nested/about/index.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>About</title>
+  </head>
+  <body>
+    <h1 id="fragment">About</h1>
+  </body>
+</html>
diff --git a/fixtures/resolve_paths_from_root_path/nested/another page/index.html b/fixtures/resolve_paths_from_root_path/nested/another page/index.html
diff --git a/fixtures/resolve_paths_from_root_path/nested/index.html b/fixtures/resolve_paths_from_root_path/nested/index.html
@@ -0,0 +1,34 @@
+<html>
+    <head>
+        <title>Index</title>
+    </head>
+    <body>
+        <h1>Index Title</h1>
+        <a id="good"></a>
+        <p>
+            <ul>
+                <li>
+                    <a href="/nested">home</a>
+                </li>
+                <li>
+                    <a href="/nested/about">About</a>
+                </li>
+                <li>
+                    <a href="/nested/another page">About</a>
+                </li>
+                <li>
+                    <a href="/nested/about/index.html#fragment">Fragment</a>
+                </li>
+                <li>
+                    <a href="/nested/about/index.html#missing">Missing</a>
+                </li>
+                <li>
+                    <a href="#good">Good</a>
+                </li>
+                <li>
+                    <a href="#bad">Bad</a>
+                </li>
+            </ul>
+        </p>
+    </body>
+</html>
diff --git a/lychee-bin/src/client.rs b/lychee-bin/src/client.rs
@@ -2,7 +2,7 @@ use crate::options::Config;
 use crate::parse::{parse_duration_secs, parse_headers, parse_remaps};
 use anyhow::{Context, Result};
 use http::StatusCode;
-use lychee_lib::{Client, ClientBuilder};
+use lychee_lib::{Base, Client, ClientBuilder};
 use regex::RegexSet;
 use reqwest_cookie_store::CookieStoreMutex;
 use std::sync::Arc;
@@ -53,9 +53,15 @@ pub(crate) fn create(cfg: &Config, cookie_jar: Option<&Arc<CookieStoreMutex>>) -
         cfg.include_mail
     };
 
+    let base = if let Some(root_path) = &cfg.root_path {
+        Some(Base::create_root_path(&root_path))
+    } else {
+        cfg.base.clone()
+    };
+
     ClientBuilder::builder()
         .remaps(remaps)
-        .base(cfg.base.clone())
+        .base(base)
         .includes(includes)
         .excludes(excludes)
         .exclude_all_private(cfg.exclude_all_private)

diff --git a/lychee-bin/src/main.rs b/lychee-bin/src/main.rs
@@ -75,6 +75,7 @@ use openssl_sys as _; // required for vendored-openssl feature
 use options::LYCHEE_CONFIG_FILE;
 use ring as _; // required for apple silicon
 
+use lychee_lib::Base;
 use lychee_lib::BasicAuthExtractor;
 use lychee_lib::Collector;
 use lychee_lib::CookieJar;
@@ -288,7 +289,13 @@ fn underlying_io_error_kind(error: &Error) -> Option<io::ErrorKind> {
 async fn run(opts: &LycheeOptions) -> Result<i32> {
     let inputs = opts.inputs()?;
 
-    let mut collector = Collector::new(opts.config.base.clone())
+    let base = if let Some(root_path) = &opts.config.root_path {
+        Some(Base::create_root_path(&root_path))
+    } else {
+        opts.config.base.clone()
+    };
+
+    let mut collector = Collector::new(base)
         .skip_missing_inputs(opts.config.skip_missing)
         .skip_hidden(!opts.config.hidden)
         .skip_ignored(!opts.config.no_ignore)

diff --git a/lychee-bin/src/options.rs b/lychee-bin/src/options.rs
@@ -445,6 +445,12 @@ separated list of accepted status codes. This example will accept 200, 201,
     #[serde(default)]
     pub(crate) base: Option<Base>,
 
+    /// Root path to use when checking absolute local links,
+    /// base option is ignored when this is set
+    #[arg(long)]
+    #[serde(default)]
+    pub(crate) root_path: Option<String>,
+
     /// Basic authentication support. E.g. `http://example.com username:password`
     #[arg(long)]
     #[serde(default)]

diff --git a/lychee-bin/tests/cli.rs b/lychee-bin/tests/cli.rs
@@ -393,6 +393,24 @@ mod cli {
             .stdout(contains("3 OK"));
     }
 
+    #[test]
+    fn test_resolve_paths_from_root_path() {
+        let mut cmd = main_command();
+        let dir = fixtures_path().join("resolve_paths_from_root_path");
+
+        cmd.arg("--offline")
+            .arg("--include-fragments")
+            .arg("--root-path")
+            .arg(&dir)
+            .arg(dir.join("nested").join("index.html"))
+            .env_clear()
+            .assert()
+            .failure()
+            .stdout(contains("7 Total"))
+            .stdout(contains("5 OK"))
+            .stdout(contains("2 Errors"));
+    }
+
     #[test]
     fn test_youtube_quirk() {
         let url = "https://www.youtube.com/watch?v=NlKuICiT470&list=PLbWDhxwM_45mPVToqaIZNbZeIzFchsKKQ&index=7";

diff --git a/lychee-lib/src/collector.rs b/lychee-lib/src/collector.rs
@@ -124,7 +124,8 @@ impl Collector {
                     let content = content?;
                     let extractor = Extractor::new(self.use_html5ever, self.include_verbatim);
                     let uris: Vec<RawUri> = extractor.extract(&content);
-                    let requests = request::create(uris, &content, &base, &basic_auth_extractor);
+                    let requests =
+                        request::create(uris, &content.source, &base, &basic_auth_extractor);
                     Result::Ok(stream::iter(requests.into_iter().map(Ok)))
                 }
             })

diff --git a/lychee-lib/src/lib.rs b/lychee-lib/src/lib.rs
@@ -71,6 +71,7 @@ pub mod remap;
 /// local IPs or e-mail addresses
 pub mod filter;
 
+/// Test utilities
 #[cfg(test)]
 #[macro_use]
 pub mod test_utils;

diff --git a/lychee-lib/src/types/base.rs b/lychee-lib/src/types/base.rs
@@ -15,6 +15,8 @@ pub enum Base {
     Local(PathBuf),
     /// Remote URL pointing to a website homepage
     Remote(Url),
+    /// Root path for checking absolute local links
+    RootPath(PathBuf),
 }
 
 impl Base {
@@ -27,18 +29,28 @@ impl Base {
                 let full_path = path.join(link);
                 Url::from_file_path(full_path).ok()
             }
+            Self::RootPath(_path) => {
+                // this is unused currently because joining on RootPath is handled by create_uri_from_file_path
+                unreachable!()
+            }
         }
     }
 
-    /// Return the directory if the base is local
+    /// Return the directory if the base is not remote
     #[must_use]
     pub(crate) fn dir(&self) -> Option<PathBuf> {
         match self {
             Self::Remote(_) => None,
-            Self::Local(d) => Some(d.clone()),
+            Self::Local(d) | Self::RootPath(d) => Some(d.clone()),
         }
     }
 
+    /// Create a root path base
+    #[must_use]
+    pub fn create_root_path(value: &str) -> Base {
+        Self::RootPath(PathBuf::from(value))
+    }
+
     pub(crate) fn from_source(source: &InputSource) -> Option<Base> {
         match &source {
             InputSource::RemoteUrl(url) => {

diff --git a/lychee-lib/src/utils/path.rs b/lychee-lib/src/utils/path.rs
@@ -42,14 +42,14 @@ fn dirname(src: &'_ Path) -> Option<&'_ Path> {
 /// Returns Ok(None) in case of an absolute local link without a `base_url`
 pub(crate) fn resolve(src: &Path, dst: &Path, base: &Option<Base>) -> Result<Option<PathBuf>> {
     let resolved = match dst {
-        relative if dst.is_relative() => {
+        relative if !dst.starts_with("/") => {
             // Find `dst` in the parent directory of `src`
             let Some(parent) = src.parent() else {
                 return Err(ErrorKind::InvalidFile(relative.to_path_buf()));
             };
             parent.join(relative)
         }
-        absolute if dst.is_absolute() => {
+        absolute if dst.starts_with("/") => {
             // Absolute local links (leading slash) require the `base_url` to
             // define the document root. Silently ignore the link in case the
             // `base_url` is not defined.