use manganis_core::hash::AssetHash; use proc_macro2::TokenStream as TokenStream2; use quote::{quote, ToTokens, TokenStreamExt}; use std::path::PathBuf; use syn::{ parse::{Parse, ParseStream}, LitStr, Token, }; #[derive(Debug)] pub(crate) enum AssetParseError { AssetDoesntExist { path: PathBuf }, InvalidPath { path: PathBuf }, } impl std::fmt::Display for AssetParseError { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { AssetParseError::AssetDoesntExist { path } => { write!(f, "Asset at {} doesn't exist", path.display()) } AssetParseError::InvalidPath { path } => { write!( f, "Asset path {} is invalid. Make sure the asset exists within this crate.", path.display() ) } } } } fn resolve_path(raw: &str) -> Result { // Get the location of the root of the crate which is where all assets are relative to // // IE // /users/dioxus/dev/app/ // is the root of // /users/dioxus/dev/app/assets/blah.css let manifest_dir = dunce::canonicalize( std::env::var("CARGO_MANIFEST_DIR") .map(PathBuf::from) .unwrap(), ) .unwrap(); // 1. the input file should be a pathbuf let input = PathBuf::from(raw); // 2. absolute path to the asset let Ok(path) = std::path::absolute(manifest_dir.join(raw.trim_start_matches('/'))) else { return Err(AssetParseError::InvalidPath { path: input.clone(), }); }; // 3. Ensure the path exists let Ok(path) = dunce::canonicalize(path) else { return Err(AssetParseError::AssetDoesntExist { path: input.clone(), }); }; // 4. Ensure the path doesn't escape the crate dir // // - Note: since we called canonicalize on both paths, we can safely compare the parent dirs. // On windows, we can only compare the prefix if both paths are canonicalized (not just absolute) // https://github.com/rust-lang/rust/issues/42869 if path == manifest_dir || !path.starts_with(manifest_dir) { return Err(AssetParseError::InvalidPath { path }); } Ok(path) } pub struct AssetParser { /// The span of the source string path_span: proc_macro2::Span, /// The asset itself asset: Result, /// The source of the trailing options options: TokenStream2, } impl Parse for AssetParser { // we can take // // This gives you the Asset type - it's generic and basically unrefined // ``` // asset!("/assets/myfile.png") // ``` // // To narrow the type, use a method call to get the refined type // ``` // asset!( // "/assets/myfile.png", // ImageAssetOptions::new() // .format(ImageFormat::Jpg) // .size(512, 512) // ) // ``` // // But we need to decide the hint first before parsing the options fn parse(input: ParseStream) -> syn::Result { // And then parse the options let src = input.parse::()?; let path_span = src.span(); let asset = resolve_path(&src.value()); let _comma = input.parse::(); let options = input.parse()?; Ok(Self { path_span, asset, options, }) } } impl ToTokens for AssetParser { // The manganis macro outputs info to two different places: // 1) The crate the macro was invoked in // - It needs the hashed contents of the file, the file path, and the file options // - Most of this is just forwarding the input, the only thing that the macro needs to do is hash the file contents // 2) A bundler that supports manganis (currently just dioxus-cli) // - The macro needs to output the absolute path to the asset for the bundler to find later // - It also needs to serialize the bundled asset along with the asset options for the bundler to use later fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { let asset = match self.asset.as_ref() { Ok(asset) => asset, Err(err) => { let err = err.to_string(); tokens.append_all(quote! { compile_error!(#err) }); return; } }; let asset_str = asset.display().to_string(); let mut asset_str = proc_macro2::Literal::string(&asset_str); asset_str.set_span(self.path_span); let hash = match AssetHash::hash_file_contents(asset) { Ok(hash) => hash, Err(err) => { let err = err.to_string(); tokens.append_all(quote! { compile_error!(#err) }); return; } }; let hash = hash.bytes(); // Generate the link section for the asset // The link section includes the source path and the output path of the asset let link_section = crate::generate_link_section(quote!(__ASSET)); // generate the asset::new method to deprecate the `./assets/blah.css` syntax let constructor = if asset.is_relative() { quote::quote! { create_bundled_asset_relative } } else { quote::quote! { create_bundled_asset } }; let options = if self.options.is_empty() { quote! { manganis::AssetOptions::Unknown } } else { self.options.clone() }; tokens.extend(quote! { { // We keep a hash of the contents of the asset for cache busting const __ASSET_HASH: &[u8] = &[#(#hash),*]; // The source is used by the CLI to copy the asset const __ASSET_SOURCE_PATH: &'static str = #asset_str; // The options give the CLI info about how to process the asset // Note: into_asset_options is not a trait, so we cannot accept the options directly // in the constructor. Stable rust doesn't have support for constant functions in traits const __ASSET_OPTIONS: manganis::AssetOptions = #options.into_asset_options(); // Create the asset that the crate will use. This is used both in the return value and // added to the linker for the bundler to copy later const __ASSET: manganis::BundledAsset = manganis::macro_helpers::#constructor(__ASSET_SOURCE_PATH, __ASSET_HASH, __ASSET_OPTIONS); #link_section manganis::Asset::new(__ASSET, __keep_link_section) } }) } }