src/tools/tidy/src/deps.rs

   1 // Copyright 2016 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! Check license of third-party deps by inspecting src/vendor
  12
  13 use std::fs::File;
  14 use std::io::Read;
  15 use std::path::Path;
  16
  17 static LICENSES: &'static [&'static str] = &[
  18     "MIT/Apache-2.0",
  19     "MIT / Apache-2.0",
  20     "Apache-2.0/MIT",
  21     "MIT OR Apache-2.0",
  22     "MIT",
  23     "Unlicense/MIT",
  24 ];
  25
  26 // These are exceptions to Rust's permissive licensing policy, and
  27 // should be considered bugs. Exceptions are only allowed in Rust
  28 // tooling. It is _crucial_ that no exception crates be dependencies
  29 // of the Rust runtime (std / test).
  30 static EXCEPTIONS: &'static [&'static str] = &[
  31     "mdbook", // MPL2, mdbook
  32     "openssl", // BSD+advertising clause, cargo, mdbook
  33     "pest", // MPL2, mdbook via handlebars
  34     "thread-id", // Apache-2.0, mdbook
  35     "strings", // this is actually MIT/Apache-2.0 but it's not in the manifest yet
  36 ];
  37
  38 pub fn check(path: &Path, bad: &mut bool) {
  39     let path = path.join("vendor");
  40     assert!(path.exists(), "vendor directory missing");
  41     let mut saw_dir = false;
  42     'next_path: for dir in t!(path.read_dir()) {
  43         saw_dir = true;
  44         let dir = t!(dir);
  45
  46         // skip our exceptions
  47         for exception in EXCEPTIONS {
  48             if dir.path()
  49                 .to_str()
  50                 .unwrap()
  51                 .contains(&format!("src/vendor/{}", exception)) {
  52                 continue 'next_path;
  53             }
  54         }
  55
  56         let toml = dir.path().join("Cargo.toml");
  57         if !check_license(&toml) {
  58             *bad = true;
  59         }
  60     }
  61     assert!(saw_dir, "no vendored source");
  62 }
  63
  64 fn check_license(path: &Path) -> bool {
  65     if !path.exists() {
  66         panic!("{} does not exist", path.display());
  67     }
  68     let mut contents = String::new();
  69     t!(t!(File::open(path)).read_to_string(&mut contents));
  70
  71     let mut found_license = false;
  72     for line in contents.lines() {
  73         if !line.starts_with("license") {
  74             continue;
  75         }
  76         let license = extract_license(line);
  77         if !LICENSES.contains(&&*license) {
  78             println!("invalid license {} in {}", license, path.display());
  79             return false;
  80         }
  81         found_license = true;
  82         break;
  83     }
  84     if !found_license {
  85         println!("no license in {}", path.display());
  86         return false;
  87     }
  88
  89     true
  90 }
  91
  92 fn extract_license(line: &str) -> String {
  93     let first_quote = line.find('"');
  94     let last_quote = line.rfind('"');
  95     if let (Some(f), Some(l)) = (first_quote, last_quote) {
  96         let license = &line[f + 1 .. l];
  97         license.into()
  98     } else {
  99         "bad-license-parse".into()
 100     }
 101 }