src/tools/linkchecker/main.rs

   1 //! Script to check the validity of `href` links in our HTML documentation.
   2 //!
   3 //! In the past we've been quite error prone to writing in broken links as most
   4 //! of them are manually rather than automatically added. As files move over
   5 //! time or apis change old links become stale or broken. The purpose of this
   6 //! script is to check all relative links in our documentation to make sure they
   7 //! actually point to a valid place.
   8 //!
   9 //! Currently this doesn't actually do any HTML parsing or anything fancy like
  10 //! that, it just has a simple "regex" to search for `href` and `id` tags.
  11 //! These values are then translated to file URLs if possible and then the
  12 //! destination is asserted to exist.
  13 //!
  14 //! A few exceptions are allowed as there's known bugs in rustdoc, but this
  15 //! should catch the majority of "broken link" cases.
  16
  17 use std::collections::hash_map::Entry;
  18 use std::collections::{HashMap, HashSet};
  19 use std::env;
  20 use std::fs;
  21 use std::path::{Component, Path, PathBuf};
  22 use std::rc::Rc;
  23
  24 use crate::Redirect::*;
  25
  26 macro_rules! t {
  27     ($e:expr) => {
  28         match $e {
  29             Ok(e) => e,
  30             Err(e) => panic!("{} failed with {:?}", stringify!($e), e),
  31         }
  32     };
  33 }
  34
  35 fn main() {
  36     let docs = env::args_os().nth(1).unwrap();
  37     let docs = env::current_dir().unwrap().join(docs);
  38     let mut errors = false;
  39     walk(&mut HashMap::new(), &docs, &docs, &mut errors);
  40     if errors {
  41         panic!("found some broken links");
  42     }
  43 }
  44
  45 #[derive(Debug)]
  46 pub enum LoadError {
  47     IOError(std::io::Error),
  48     BrokenRedirect(PathBuf, std::io::Error),
  49     IsRedirect,
  50 }
  51
  52 enum Redirect {
  53     SkipRedirect,
  54     FromRedirect(bool),
  55 }
  56
  57 struct FileEntry {
  58     source: Rc<String>,
  59     ids: HashSet<String>,
  60 }
  61
  62 type Cache = HashMap<PathBuf, FileEntry>;
  63
  64 fn small_url_encode(s: &str) -> String {
  65     s.replace("<", "%3C")
  66         .replace(">", "%3E")
  67         .replace(" ", "%20")
  68         .replace("?", "%3F")
  69         .replace("'", "%27")
  70         .replace("&", "%26")
  71         .replace(",", "%2C")
  72         .replace(":", "%3A")
  73         .replace(";", "%3B")
  74         .replace("[", "%5B")
  75         .replace("]", "%5D")
  76         .replace("\"", "%22")
  77 }
  78
  79 impl FileEntry {
  80     fn parse_ids(&mut self, file: &Path, contents: &str, errors: &mut bool) {
  81         if self.ids.is_empty() {
  82             with_attrs_in_source(contents, " id", |fragment, i, _| {
  83                 let frag = fragment.trim_start_matches("#").to_owned();
  84                 let encoded = small_url_encode(&frag);
  85                 if !self.ids.insert(frag) {
  86                     *errors = true;
  87                     println!("{}:{}: id is not unique: `{}`", file.display(), i, fragment);
  88                 }
  89                 // Just in case, we also add the encoded id.
  90                 self.ids.insert(encoded);
  91             });
  92         }
  93     }
  94 }
  95
  96 fn walk(cache: &mut Cache, root: &Path, dir: &Path, errors: &mut bool) {
  97     for entry in t!(dir.read_dir()).map(|e| t!(e)) {
  98         let path = entry.path();
  99         let kind = t!(entry.file_type());
 100         if kind.is_dir() {
 101             walk(cache, root, &path, errors);
 102         } else {
 103             let pretty_path = check(cache, root, &path, errors);
 104             if let Some(pretty_path) = pretty_path {
 105                 let entry = cache.get_mut(&pretty_path).unwrap();
 106                 // we don't need the source anymore,
 107                 // so drop to reduce memory-usage
 108                 entry.source = Rc::new(String::new());
 109             }
 110         }
 111     }
 112 }
 113
 114 fn check(cache: &mut Cache, root: &Path, file: &Path, errors: &mut bool) -> Option<PathBuf> {
 115     // Ignore non-HTML files.
 116     if file.extension().and_then(|s| s.to_str()) != Some("html") {
 117         return None;
 118     }
 119
 120     // Unfortunately we're not 100% full of valid links today to we need a few
 121     // exceptions to get this past `make check` today.
 122     // FIXME(#32129)
 123     if file.ends_with("std/io/struct.IoSlice.html")
 124     {
 125         return None;
 126     }
 127
 128     // FIXME(#32130)
 129     if file.ends_with("alloc/collections/btree_map/struct.BTreeMap.html")
 130         || file.ends_with("alloc/collections/btree_set/struct.BTreeSet.html")
 131         || file.ends_with("std/collections/btree_map/struct.BTreeMap.html")
 132         || file.ends_with("std/collections/btree_set/struct.BTreeSet.html")
 133         || file.ends_with("std/collections/hash_set/struct.HashSet.html")
 134     {
 135         return None;
 136     }
 137
 138     let res = load_file(cache, root, file, SkipRedirect);
 139     let (pretty_file, contents) = match res {
 140         Ok(res) => res,
 141         Err(_) => return None,
 142     };
 143     {
 144         cache.get_mut(&pretty_file).unwrap().parse_ids(&pretty_file, &contents, errors);
 145     }
 146
 147     // Search for anything that's the regex 'href[ ]*=[ ]*".*?"'
 148     with_attrs_in_source(&contents, " href", |url, i, base| {
 149         // Ignore external URLs
 150         if url.starts_with("http:")
 151             || url.starts_with("https:")
 152             || url.starts_with("javascript:")
 153             || url.starts_with("ftp:")
 154             || url.starts_with("irc:")
 155             || url.starts_with("data:")
 156         {
 157             return;
 158         }
 159         let mut parts = url.splitn(2, "#");
 160         let url = parts.next().unwrap();
 161         let fragment = parts.next();
 162         let mut parts = url.splitn(2, "?");
 163         let url = parts.next().unwrap();
 164
 165         // Once we've plucked out the URL, parse it using our base url and
 166         // then try to extract a file path.
 167         let mut path = file.to_path_buf();
 168         if !base.is_empty() || !url.is_empty() {
 169             path.pop();
 170             for part in Path::new(base).join(url).components() {
 171                 match part {
 172                     Component::Prefix(_) | Component::RootDir => {
 173                         // Avoid absolute paths as they make the docs not
 174                         // relocatable by making assumptions on where the docs
 175                         // are hosted relative to the site root.
 176                         *errors = true;
 177                         println!(
 178                             "{}:{}: absolute path - {}",
 179                             pretty_file.display(),
 180                             i + 1,
 181                             Path::new(base).join(url).display()
 182                         );
 183                         return;
 184                     }
 185                     Component::CurDir => {}
 186                     Component::ParentDir => {
 187                         path.pop();
 188                     }
 189                     Component::Normal(s) => {
 190                         path.push(s);
 191                     }
 192                 }
 193             }
 194         }
 195
 196         // Alright, if we've found a file name then this file had better
 197         // exist! If it doesn't then we register and print an error.
 198         if path.exists() {
 199             if path.is_dir() {
 200                 // Links to directories show as directory listings when viewing
 201                 // the docs offline so it's best to avoid them.
 202                 *errors = true;
 203                 let pretty_path = path.strip_prefix(root).unwrap_or(&path);
 204                 println!(
 205                     "{}:{}: directory link - {}",
 206                     pretty_file.display(),
 207                     i + 1,
 208                     pretty_path.display()
 209                 );
 210                 return;
 211             }
 212             if let Some(extension) = path.extension() {
 213                 // Ignore none HTML files.
 214                 if extension != "html" {
 215                     return;
 216                 }
 217             }
 218             let res = load_file(cache, root, &path, FromRedirect(false));
 219             let (pretty_path, contents) = match res {
 220                 Ok(res) => res,
 221                 Err(LoadError::IOError(err)) => {
 222                     panic!("error loading {}: {}", path.display(), err);
 223                 }
 224                 Err(LoadError::BrokenRedirect(target, _)) => {
 225                     *errors = true;
 226                     println!(
 227                         "{}:{}: broken redirect to {}",
 228                         pretty_file.display(),
 229                         i + 1,
 230                         target.display()
 231                     );
 232                     return;
 233                 }
 234                 Err(LoadError::IsRedirect) => unreachable!(),
 235             };
 236
 237             if let Some(ref fragment) = fragment {
 238                 // Fragments like `#1-6` are most likely line numbers to be
 239                 // interpreted by javascript, so we're ignoring these
 240                 if fragment.splitn(2, '-').all(|f| f.chars().all(|c| c.is_numeric())) {
 241                     return;
 242                 }
 243
 244                 // These appear to be broken in mdbook right now?
 245                 if fragment.starts_with("-") {
 246                     return;
 247                 }
 248
 249                 let entry = &mut cache.get_mut(&pretty_path).unwrap();
 250                 entry.parse_ids(&pretty_path, &contents, errors);
 251
 252                 if !entry.ids.contains(*fragment) {
 253                     *errors = true;
 254                     print!("{}:{}: broken link fragment ", pretty_file.display(), i + 1);
 255                     println!("`#{}` pointing to `{}`", fragment, pretty_path.display());
 256                 };
 257             }
 258         } else {
 259             *errors = true;
 260             print!("{}:{}: broken link - ", pretty_file.display(), i + 1);
 261             let pretty_path = path.strip_prefix(root).unwrap_or(&path);
 262             println!("{}", pretty_path.display());
 263         }
 264     });
 265     Some(pretty_file)
 266 }
 267
 268 fn load_file(
 269     cache: &mut Cache,
 270     root: &Path,
 271     file: &Path,
 272     redirect: Redirect,
 273 ) -> Result<(PathBuf, Rc<String>), LoadError> {
 274     let pretty_file = PathBuf::from(file.strip_prefix(root).unwrap_or(&file));
 275
 276     let (maybe_redirect, contents) = match cache.entry(pretty_file.clone()) {
 277         Entry::Occupied(entry) => (None, entry.get().source.clone()),
 278         Entry::Vacant(entry) => {
 279             let contents = match fs::read_to_string(file) {
 280                 Ok(s) => Rc::new(s),
 281                 Err(err) => {
 282                     return Err(if let FromRedirect(true) = redirect {
 283                         LoadError::BrokenRedirect(file.to_path_buf(), err)
 284                     } else {
 285                         LoadError::IOError(err)
 286                     });
 287                 }
 288             };
 289
 290             let maybe = maybe_redirect(&contents);
 291             if maybe.is_some() {
 292                 if let SkipRedirect = redirect {
 293                     return Err(LoadError::IsRedirect);
 294                 }
 295             } else {
 296                 entry.insert(FileEntry { source: contents.clone(), ids: HashSet::new() });
 297             }
 298             (maybe, contents)
 299         }
 300     };
 301     match maybe_redirect.map(|url| file.parent().unwrap().join(url)) {
 302         Some(redirect_file) => load_file(cache, root, &redirect_file, FromRedirect(true)),
 303         None => Ok((pretty_file, contents)),
 304     }
 305 }
 306
 307 fn maybe_redirect(source: &str) -> Option<String> {
 308     const REDIRECT: &'static str = "<p>Redirecting to <a href=";
 309
 310     let mut lines = source.lines();
 311     let redirect_line = lines.nth(6)?;
 312
 313     redirect_line.find(REDIRECT).map(|i| {
 314         let rest = &redirect_line[(i + REDIRECT.len() + 1)..];
 315         let pos_quote = rest.find('"').unwrap();
 316         rest[..pos_quote].to_owned()
 317     })
 318 }
 319
 320 fn with_attrs_in_source<F: FnMut(&str, usize, &str)>(contents: &str, attr: &str, mut f: F) {
 321     let mut base = "";
 322     for (i, mut line) in contents.lines().enumerate() {
 323         while let Some(j) = line.find(attr) {
 324             let rest = &line[j + attr.len()..];
 325             // The base tag should always be the first link in the document so
 326             // we can get away with using one pass.
 327             let is_base = line[..j].ends_with("<base");
 328             line = rest;
 329             let pos_equals = match rest.find("=") {
 330                 Some(i) => i,
 331                 None => continue,
 332             };
 333             if rest[..pos_equals].trim_start_matches(" ") != "" {
 334                 continue;
 335             }
 336
 337             let rest = &rest[pos_equals + 1..];
 338
 339             let pos_quote = match rest.find(&['"', '\''][..]) {
 340                 Some(i) => i,
 341                 None => continue,
 342             };
 343             let quote_delim = rest.as_bytes()[pos_quote] as char;
 344
 345             if rest[..pos_quote].trim_start_matches(" ") != "" {
 346                 continue;
 347             }
 348             let rest = &rest[pos_quote + 1..];
 349             let url = match rest.find(quote_delim) {
 350                 Some(i) => &rest[..i],
 351                 None => continue,
 352             };
 353             if is_base {
 354                 base = url;
 355                 continue;
 356             }
 357             f(url, i, base)
 358         }
 359     }
 360 }