123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.
use crate::fs_util;use crate::http_cache::url_to_filename;use deno_core::url::{Host, Url};use std::ffi::OsStr;use std::fs;use std::io;use std::path::Component;use std::path::Path;use std::path::PathBuf;use std::path::Prefix;use std::str;
#[derive(Clone)]pub struct DiskCache {  pub location: PathBuf,}
fn with_io_context<T: AsRef<str>>(  e: &std::io::Error,  context: T,) -> std::io::Error {  std::io::Error::new(e.kind(), format!("{} (for '{}')", e, context.as_ref()))}
impl DiskCache {  /// `location` must be an absolute path.  pub fn new(location: &Path) -> Self {    assert!(location.is_absolute());    Self {      location: location.to_owned(),    }  }
  /// Ensures the location of the cache.  pub fn ensure_dir_exists(&self, path: &Path) -> io::Result<()> {    if path.is_dir() {      return Ok(());    }    fs::create_dir_all(&path).map_err(|e| {      io::Error::new(e.kind(), format!(        "Could not create TypeScript compiler cache location: {:?}\nCheck the permission of the directory.",        path      ))    })  }
  fn get_cache_filename(&self, url: &Url) -> Option<PathBuf> {    let mut out = PathBuf::new();
    let scheme = url.scheme();    out.push(scheme);
    match scheme {      "wasm" => {        let host = url.host_str().unwrap();        let host_port = match url.port() {          // Windows doesn't support ":" in filenames, so we represent port using a          // special string.          Some(port) => format!("{}_PORT{}", host, port),          None => host.to_string(),        };        out.push(host_port);
        for path_seg in url.path_segments().unwrap() {          out.push(path_seg);        }      }      "http" | "https" | "data" | "blob" => out = url_to_filename(url)?,      "file" => {        let path = match url.to_file_path() {          Ok(path) => path,          Err(_) => return None,        };        let mut path_components = path.components();
        if cfg!(target_os = "windows") {          if let Some(Component::Prefix(prefix_component)) =            path_components.next()          {            // Windows doesn't support ":" in filenames, so we need to extract disk prefix            // Example: file:///C:/deno/js/unit_test_runner.ts            // it should produce: file\c\deno\js\unit_test_runner.ts            match prefix_component.kind() {              Prefix::Disk(disk_byte) | Prefix::VerbatimDisk(disk_byte) => {                let disk = (disk_byte as char).to_string();                out.push(disk);              }              Prefix::UNC(server, share)              | Prefix::VerbatimUNC(server, share) => {                out.push("UNC");                let host = Host::parse(server.to_str().unwrap()).unwrap();                let host = host.to_string().replace(':', "_");                out.push(host);                out.push(share);              }              _ => unreachable!(),            }          }        }
        // Must be relative, so strip forward slash        let mut remaining_components = path_components.as_path();        if let Ok(stripped) = remaining_components.strip_prefix("/") {          remaining_components = stripped;        };
        out = out.join(remaining_components);      }      _ => return None,    };
    Some(out)  }
  pub fn get_cache_filename_with_extension(    &self,    url: &Url,    extension: &str,  ) -> Option<PathBuf> {    let base = self.get_cache_filename(url)?;
    match base.extension() {      None => Some(base.with_extension(extension)),      Some(ext) => {        let original_extension = OsStr::to_str(ext).unwrap();        let final_extension = format!("{}.{}", original_extension, extension);        Some(base.with_extension(final_extension))      }    }  }
  pub fn get(&self, filename: &Path) -> std::io::Result<Vec<u8>> {    let path = self.location.join(filename);    fs::read(&path)  }
  pub fn set(&self, filename: &Path, data: &[u8]) -> std::io::Result<()> {    let path = self.location.join(filename);    match path.parent() {      Some(parent) => self.ensure_dir_exists(parent),      None => Ok(()),    }?;    fs_util::atomic_write_file(&path, data, crate::http_cache::CACHE_PERM)      .map_err(|e| with_io_context(&e, format!("{:#?}", &path)))  }}
#[cfg(test)]mod tests {  use super::*;  use test_util::TempDir;
  #[test]  fn test_create_cache_if_dir_exits() {    let cache_location = TempDir::new();    let mut cache_path = cache_location.path().to_owned();    cache_path.push("foo");    let cache = DiskCache::new(&cache_path);    cache      .ensure_dir_exists(&cache.location)      .expect("Testing expect:");    assert!(cache_path.is_dir());  }
  #[test]  fn test_create_cache_if_dir_not_exits() {    let temp_dir = TempDir::new();    let mut cache_location = temp_dir.path().to_owned();    assert!(fs::remove_dir(&cache_location).is_ok());    cache_location.push("foo");    assert!(!cache_location.is_dir());    let cache = DiskCache::new(&cache_location);    cache      .ensure_dir_exists(&cache.location)      .expect("Testing expect:");    assert!(cache_location.is_dir());  }
  #[test]  fn test_get_cache_filename() {    let cache_location = if cfg!(target_os = "windows") {      PathBuf::from(r"C:\deno_dir\")    } else {      PathBuf::from("/deno_dir/")    };
    let cache = DiskCache::new(&cache_location);
    let mut test_cases = vec![      (        "http://deno.land/std/http/file_server.ts",        "http/deno.land/d8300752800fe3f0beda9505dc1c3b5388beb1ee45afd1f1e2c9fc0866df15cf",      ),      (        "http://localhost:8000/std/http/file_server.ts",        "http/localhost_PORT8000/d8300752800fe3f0beda9505dc1c3b5388beb1ee45afd1f1e2c9fc0866df15cf",      ),      (        "https://deno.land/std/http/file_server.ts",        "https/deno.land/d8300752800fe3f0beda9505dc1c3b5388beb1ee45afd1f1e2c9fc0866df15cf",      ),      ("wasm://wasm/d1c677ea", "wasm/wasm/d1c677ea"),    ];
    if cfg!(target_os = "windows") {      test_cases.push(("file:///D:/a/1/s/format.ts", "file/D/a/1/s/format.ts"));      // IPv4 localhost      test_cases.push((        "file://127.0.0.1/d$/a/1/s/format.ts",        "file/UNC/127.0.0.1/d$/a/1/s/format.ts",      ));      // IPv6 localhost      test_cases.push((        "file://[0:0:0:0:0:0:0:1]/d$/a/1/s/format.ts",        "file/UNC/[__1]/d$/a/1/s/format.ts",      ));      // shared folder      test_cases.push((        "file://comp/t-share/a/1/s/format.ts",        "file/UNC/comp/t-share/a/1/s/format.ts",      ));    } else {      test_cases.push((        "file:///std/http/file_server.ts",        "file/std/http/file_server.ts",      ));    }
    for test_case in &test_cases {      let cache_filename =        cache.get_cache_filename(&Url::parse(test_case.0).unwrap());      assert_eq!(cache_filename, Some(PathBuf::from(test_case.1)));    }  }
  #[test]  fn test_get_cache_filename_with_extension() {    let p = if cfg!(target_os = "windows") {      "C:\\foo"    } else {      "/foo"    };    let cache = DiskCache::new(&PathBuf::from(p));
    let mut test_cases = vec![      (        "http://deno.land/std/http/file_server.ts",        "js",        "http/deno.land/d8300752800fe3f0beda9505dc1c3b5388beb1ee45afd1f1e2c9fc0866df15cf.js",      ),      (        "http://deno.land/std/http/file_server.ts",        "js.map",        "http/deno.land/d8300752800fe3f0beda9505dc1c3b5388beb1ee45afd1f1e2c9fc0866df15cf.js.map",      ),    ];
    if cfg!(target_os = "windows") {      test_cases.push((        "file:///D:/std/http/file_server",        "js",        "file/D/std/http/file_server.js",      ));    } else {      test_cases.push((        "file:///std/http/file_server",        "js",        "file/std/http/file_server.js",      ));    }
    for test_case in &test_cases {      assert_eq!(        cache.get_cache_filename_with_extension(          &Url::parse(test_case.0).unwrap(),          test_case.1        ),        Some(PathBuf::from(test_case.2))      )    }  }
  #[test]  fn test_get_cache_filename_invalid_urls() {    let cache_location = if cfg!(target_os = "windows") {      PathBuf::from(r"C:\deno_dir\")    } else {      PathBuf::from("/deno_dir/")    };
    let cache = DiskCache::new(&cache_location);
    let mut test_cases = vec!["unknown://localhost/test.ts"];
    if cfg!(target_os = "windows") {      test_cases.push("file://");      test_cases.push("file:///");    }
    for test_case in &test_cases {      let cache_filename =        cache.get_cache_filename(&Url::parse(test_case).unwrap());      assert_eq!(cache_filename, None);    }  }}