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_map/struct.HashMap.html")
 134         || file.ends_with("std/collections/hash_set/struct.HashSet.html")
 135     {
 136         return None;
 137     }
 138
 139     let res = load_file(cache, root, file, SkipRedirect);
 140     let (pretty_file, contents) = match res {
 141         Ok(res) => res,
 142         Err(_) => return None,
 143     };
 144     {
 145         cache.get_mut(&pretty_file).unwrap().parse_ids(&pretty_file, &contents, errors);
 146     }
 147
 148     // Search for anything that's the regex 'href[ ]*=[ ]*".*?"'
 149     with_attrs_in_source(&contents, " href", |url, i, base| {
 150         // Ignore external URLs
 151         if url.starts_with("http:")
 152             || url.starts_with("https:")
 153             || url.starts_with("javascript:")
 154             || url.starts_with("ftp:")
 155             || url.starts_with("irc:")
 156             || url.starts_with("data:")
 157         {
 158             return;
 159         }
 160         let mut parts = url.splitn(2, "#");
 161         let url = parts.next().unwrap();
 162         let fragment = parts.next();
 163         let mut parts = url.splitn(2, "?");
 164         let url = parts.next().unwrap();
 165
 166         // Once we've plucked out the URL, parse it using our base url and
 167         // then try to extract a file path.
 168         let mut path = file.to_path_buf();
 169         if !base.is_empty() || !url.is_empty() {
 170             path.pop();
 171             for part in Path::new(base).join(url).components() {
 172                 match part {
 173                     Component::Prefix(_) | Component::RootDir => {
 174                         // Avoid absolute paths as they make the docs not
 175                         // relocatable by making assumptions on where the docs
 176                         // are hosted relative to the site root.
 177                         *errors = true;
 178                         println!(
 179                             "{}:{}: absolute path - {}",
 180                             pretty_file.display(),
 181                             i + 1,
 182                             Path::new(base).join(url).display()
 183                         );
 184                         return;
 185                     }
 186                     Component::CurDir => {}
 187                     Component::ParentDir => {
 188                         path.pop();
 189                     }
 190                     Component::Normal(s) => {
 191                         path.push(s);
 192                     }
 193                 }
 194             }
 195         }
 196
 197         // Alright, if we've found a file name then this file had better
 198         // exist! If it doesn't then we register and print an error.
 199         if path.exists() {
 200             if path.is_dir() {
 201                 // Links to directories show as directory listings when viewing
 202                 // the docs offline so it's best to avoid them.
 203                 *errors = true;
 204                 let pretty_path = path.strip_prefix(root).unwrap_or(&path);
 205                 println!(
 206                     "{}:{}: directory link - {}",
 207                     pretty_file.display(),
 208                     i + 1,
 209                     pretty_path.display()
 210                 );
 211                 return;
 212             }
 213             if let Some(extension) = path.extension() {
 214                 // Ignore none HTML files.
 215                 if extension != "html" {
 216                     return;
 217                 }
 218             }
 219             let res = load_file(cache, root, &path, FromRedirect(false));
 220             let (pretty_path, contents) = match res {
 221                 Ok(res) => res,
 222                 Err(LoadError::IOError(err)) => {
 223                     panic!("error loading {}: {}", path.display(), err);
 224                 }
 225                 Err(LoadError::BrokenRedirect(target, _)) => {
 226                     *errors = true;
 227                     println!(
 228                         "{}:{}: broken redirect to {}",
 229                         pretty_file.display(),
 230                         i + 1,
 231                         target.display()
 232                     );
 233                     return;
 234                 }
 235                 Err(LoadError::IsRedirect) => unreachable!(),
 236             };
 237
 238             if let Some(ref fragment) = fragment {
 239                 // Fragments like `#1-6` are most likely line numbers to be
 240                 // interpreted by javascript, so we're ignoring these
 241                 if fragment.splitn(2, '-').all(|f| f.chars().all(|c| c.is_numeric())) {
 242                     return;
 243                 }
 244
 245                 // These appear to be broken in mdbook right now?
 246                 if fragment.starts_with("-") {
 247                     return;
 248                 }
 249
 250                 let entry = &mut cache.get_mut(&pretty_path).unwrap();
 251                 entry.parse_ids(&pretty_path, &contents, errors);
 252
 253                 if !entry.ids.contains(*fragment) {
 254                     *errors = true;
 255                     print!("{}:{}: broken link fragment ", pretty_file.display(), i + 1);
 256                     println!("`#{}` pointing to `{}`", fragment, pretty_path.display());
 257                 };
 258             }
 259         } else {
 260             *errors = true;
 261             print!("{}:{}: broken link - ", pretty_file.display(), i + 1);
 262             let pretty_path = path.strip_prefix(root).unwrap_or(&path);
 263             println!("{}", pretty_path.display());
 264         }
 265     });
 266     Some(pretty_file)
 267 }
 268
 269 fn load_file(
 270     cache: &mut Cache,
 271     root: &Path,
 272     file: &Path,
 273     redirect: Redirect,
 274 ) -> Result<(PathBuf, Rc<String>), LoadError> {
 275     let pretty_file = PathBuf::from(file.strip_prefix(root).unwrap_or(&file));
 276
 277     let (maybe_redirect, contents) = match cache.entry(pretty_file.clone()) {
 278         Entry::Occupied(entry) => (None, entry.get().source.clone()),
 279         Entry::Vacant(entry) => {
 280             let contents = match fs::read_to_string(file) {
 281                 Ok(s) => Rc::new(s),
 282                 Err(err) => {
 283                     return Err(if let FromRedirect(true) = redirect {
 284                         LoadError::BrokenRedirect(file.to_path_buf(), err)
 285                     } else {
 286                         LoadError::IOError(err)
 287                     });
 288                 }
 289             };
 290
 291             let maybe = maybe_redirect(&contents);
 292             if maybe.is_some() {
 293                 if let SkipRedirect = redirect {
 294                     return Err(LoadError::IsRedirect);
 295                 }
 296             } else {
 297                 entry.insert(FileEntry { source: contents.clone(), ids: HashSet::new() });
 298             }
 299             (maybe, contents)
 300         }
 301     };
 302     match maybe_redirect.map(|url| file.parent().unwrap().join(url)) {
 303         Some(redirect_file) => load_file(cache, root, &redirect_file, FromRedirect(true)),
 304         None => Ok((pretty_file, contents)),
 305     }
 306 }
 307
 308 fn maybe_redirect(source: &str) -> Option<String> {
 309     const REDIRECT: &'static str = "<p>Redirecting to <a href=";
 310
 311     let mut lines = source.lines();
 312     let redirect_line = lines.nth(6)?;
 313
 314     redirect_line.find(REDIRECT).map(|i| {
 315         let rest = &redirect_line[(i + REDIRECT.len() + 1)..];
 316         let pos_quote = rest.find('"').unwrap();
 317         rest[..pos_quote].to_owned()
 318     })
 319 }
 320
 321 fn with_attrs_in_source<F: FnMut(&str, usize, &str)>(contents: &str, attr: &str, mut f: F) {
 322     let mut base = "";
 323     for (i, mut line) in contents.lines().enumerate() {
 324         while let Some(j) = line.find(attr) {
 325             let rest = &line[j + attr.len()..];
 326             // The base tag should always be the first link in the document so
 327             // we can get away with using one pass.
 328             let is_base = line[..j].ends_with("<base");
 329             line = rest;
 330             let pos_equals = match rest.find("=") {
 331                 Some(i) => i,
 332                 None => continue,
 333             };
 334             if rest[..pos_equals].trim_start_matches(" ") != "" {
 335                 continue;
 336             }
 337
 338             let rest = &rest[pos_equals + 1..];
 339
 340             let pos_quote = match rest.find(&['"', '\''][..]) {
 341                 Some(i) => i,
 342                 None => continue,
 343             };
 344             let quote_delim = rest.as_bytes()[pos_quote] as char;
 345
 346             if rest[..pos_quote].trim_start_matches(" ") != "" {
 347                 continue;
 348             }
 349             let rest = &rest[pos_quote + 1..];
 350             let url = match rest.find(quote_delim) {
 351                 Some(i) => &rest[..i],
 352                 None => continue,
 353             };
 354             if is_base {
 355                 base = url;
 356                 continue;
 357             }
 358             f(url, i, base)
 359         }
 360     }
 361 }