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