123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
// Copyright 2018-2022 the Deno authors. All rights reserved. MIT license.//! This module is meant to eventually implement HTTP cache//! as defined in RFC 7234 (<https://tools.ietf.org/html/rfc7234>).//! Currently it's a very simplified version to fulfill Deno needs//! at hand.use crate::fs_util;use crate::http_util::HeadersMap;use deno_core::error::generic_error;use deno_core::error::AnyError;use deno_core::serde::Deserialize;use deno_core::serde::Serialize;use deno_core::serde_json;use deno_core::url::Url;use log::error;use std::fs;use std::fs::File;use std::io;use std::path::Path;use std::path::PathBuf;use std::time::SystemTime;
pub const CACHE_PERM: u32 = 0o644;
/// Turn base of url (scheme, hostname, port) into a valid filename./// This method replaces port part with a special string token (because/// ":" cannot be used in filename on some platforms)./// Ex: $DENO_DIR/deps/https/deno.land/fn base_url_to_filename(url: &Url) -> Option<PathBuf> {  let mut out = PathBuf::new();
  let scheme = url.scheme();  out.push(scheme);
  match scheme {    "http" | "https" => {      let host = url.host_str().unwrap();      let host_port = match url.port() {        Some(port) => format!("{}_PORT{}", host, port),        None => host.to_string(),      };      out.push(host_port);    }    "data" | "blob" => (),    scheme => {      error!("Don't know how to create cache name for scheme: {}", scheme);      return None;    }  };
  Some(out)}
/// Turn provided `url` into a hashed filename./// URLs can contain a lot of characters that cannot be used/// in filenames (like "?", "#", ":"), so in order to cache/// them properly they are deterministically hashed into ASCII/// strings.////// NOTE: this method is `pub` because it's used in integration_testspub fn url_to_filename(url: &Url) -> Option<PathBuf> {  let mut cache_filename = base_url_to_filename(url)?;
  let mut rest_str = url.path().to_string();  if let Some(query) = url.query() {    rest_str.push('?');    rest_str.push_str(query);  }  // NOTE: fragment is omitted on purpose - it's not taken into  // account when caching - it denotes parts of webpage, which  // in case of static resources doesn't make much sense  let hashed_filename = crate::checksum::gen(&[rest_str.as_bytes()]);  cache_filename.push(hashed_filename);  Some(cache_filename)}
#[derive(Debug, Clone, Default)]pub struct HttpCache {  pub location: PathBuf,}
#[derive(Serialize, Deserialize)]pub struct Metadata {  pub headers: HeadersMap,  pub url: String,  #[serde(default = "SystemTime::now")]  pub now: SystemTime,}
impl Metadata {  pub fn write(&self, cache_filename: &Path) -> Result<(), AnyError> {    let metadata_filename = Self::filename(cache_filename);    let json = serde_json::to_string_pretty(self)?;    fs_util::atomic_write_file(&metadata_filename, json, CACHE_PERM)?;    Ok(())  }
  pub fn read(cache_filename: &Path) -> Result<Metadata, AnyError> {    let metadata_filename = Metadata::filename(cache_filename);    let metadata = fs::read_to_string(metadata_filename)?;    let metadata: Metadata = serde_json::from_str(&metadata)?;    Ok(metadata)  }
  /// Ex: $DENO_DIR/deps/https/deno.land/c885b7dcf1d6936e33a9cc3a2d74ec79bab5d733d3701c85a029b7f7ec9fbed4.metadata.json  pub fn filename(cache_filename: &Path) -> PathBuf {    cache_filename.with_extension("metadata.json")  }}
impl HttpCache {  /// Returns a new instance.  ///  /// `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.  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 remote modules cache location: {:?}\nCheck the permission of the directory.",          path        ),      )    })  }
  pub fn get_cache_filename(&self, url: &Url) -> Option<PathBuf> {    Some(self.location.join(url_to_filename(url)?))  }
  // TODO(bartlomieju): this method should check headers file  // and validate against ETAG/Last-modified-as headers.  // ETAG check is currently done in `cli/file_fetcher.rs`.  pub fn get(    &self,    url: &Url,  ) -> Result<(File, HeadersMap, SystemTime), AnyError> {    let cache_filename = self.location.join(      url_to_filename(url)        .ok_or_else(|| generic_error("Can't convert url to filename."))?,    );    let metadata_filename = Metadata::filename(&cache_filename);    let file = File::open(cache_filename)?;    let metadata = fs::read_to_string(metadata_filename)?;    let metadata: Metadata = serde_json::from_str(&metadata)?;    Ok((file, metadata.headers, metadata.now))  }
  pub fn set(    &self,    url: &Url,    headers_map: HeadersMap,    content: &[u8],  ) -> Result<(), AnyError> {    let cache_filename = self.location.join(      url_to_filename(url)        .ok_or_else(|| generic_error("Can't convert url to filename."))?,    );    // Create parent directory    let parent_filename = cache_filename      .parent()      .expect("Cache filename should have a parent dir");    self.ensure_dir_exists(parent_filename)?;    // Cache content    fs_util::atomic_write_file(&cache_filename, content, CACHE_PERM)?;
    let metadata = Metadata {      now: SystemTime::now(),      url: url.to_string(),      headers: headers_map,    };    metadata.write(&cache_filename)  }}
#[cfg(test)]mod tests {  use super::*;  use std::collections::HashMap;  use std::io::Read;  use test_util::TempDir;
  #[test]  fn test_create_cache() {    let dir = TempDir::new();    let mut cache_path = dir.path().to_owned();    cache_path.push("foobar");    // HttpCache should be created lazily on first use:    // when zipping up a local project with no external dependencies    // "$DENO_DIR/deps" is empty. When unzipping such project    // "$DENO_DIR/deps" might not get restored and in situation    // when directory is owned by root we might not be able    // to create that directory. However if it's not needed it    // doesn't make sense to return error in such specific scenarios.    // For more details check issue:    // https://github.com/denoland/deno/issues/5688    let cache = HttpCache::new(&cache_path);    assert!(!cache.location.exists());    cache      .set(        &Url::parse("http://example.com/foo/bar.js").unwrap(),        HeadersMap::new(),        b"hello world",      )      .expect("Failed to add to cache");    assert!(cache.ensure_dir_exists(&cache.location).is_ok());    assert!(cache_path.is_dir());  }
  #[test]  fn test_get_set() {    let dir = TempDir::new();    let cache = HttpCache::new(dir.path());    let url = Url::parse("https://deno.land/x/welcome.ts").unwrap();    let mut headers = HashMap::new();    headers.insert(      "content-type".to_string(),      "application/javascript".to_string(),    );    headers.insert("etag".to_string(), "as5625rqdsfb".to_string());    let content = b"Hello world";    let r = cache.set(&url, headers, content);    eprintln!("result {:?}", r);    assert!(r.is_ok());    let r = cache.get(&url);    assert!(r.is_ok());    let (mut file, headers, _) = r.unwrap();    let mut content = String::new();    file.read_to_string(&mut content).unwrap();    assert_eq!(content, "Hello world");    assert_eq!(      headers.get("content-type").unwrap(),      "application/javascript"    );    assert_eq!(headers.get("etag").unwrap(), "as5625rqdsfb");    assert_eq!(headers.get("foobar"), None);  }
  #[test]  fn test_url_to_filename() {    let test_cases = [      ("https://deno.land/x/foo.ts", "https/deno.land/2c0a064891b9e3fbe386f5d4a833bce5076543f5404613656042107213a7bbc8"),      (        "https://deno.land:8080/x/foo.ts",        "https/deno.land_PORT8080/2c0a064891b9e3fbe386f5d4a833bce5076543f5404613656042107213a7bbc8",      ),      ("https://deno.land/", "https/deno.land/8a5edab282632443219e051e4ade2d1d5bbc671c781051bf1437897cbdfea0f1"),      (        "https://deno.land/?asdf=qwer",        "https/deno.land/e4edd1f433165141015db6a823094e6bd8f24dd16fe33f2abd99d34a0a21a3c0",      ),      // should be the same as case above, fragment (#qwer) is ignored      // when hashing      (        "https://deno.land/?asdf=qwer#qwer",        "https/deno.land/e4edd1f433165141015db6a823094e6bd8f24dd16fe33f2abd99d34a0a21a3c0",      ),      (        "data:application/typescript;base64,ZXhwb3J0IGNvbnN0IGEgPSAiYSI7CgpleHBvcnQgZW51bSBBIHsKICBBLAogIEIsCiAgQywKfQo=",        "data/c21c7fc382b2b0553dc0864aa81a3acacfb7b3d1285ab5ae76da6abec213fb37",      ),      (        "data:text/plain,Hello%2C%20Deno!",        "data/967374e3561d6741234131e342bf5c6848b70b13758adfe23ee1a813a8131818",      )    ];
    for (url, expected) in test_cases.iter() {      let u = Url::parse(url).unwrap();      let p = url_to_filename(&u).unwrap();      assert_eq!(p, PathBuf::from(expected));    }  }}