Support using import statements for non-KCL files

docs/kcl/import.md

@@ -4,8 +4,12 @@ excerpt: "Import a CAD file."
 layout: manual
 ---
 
+**WARNING:** This function is deprecated.
+
 Import a CAD file.
 
+**DEPRECATED** Prefer to use import statements.
+
 For formats lacking unit data (such as STL, OBJ, or PLY files), the default unit of measurement is millimeters. Alternatively you may specify the unit by passing your desired measurement unit in the options parameter. When importing a GLTF file, the bin file will be imported as well. Import paths are relative to the current project directory.
 
 Note: The import command currently only works when using the native Modeling App.

docs/kcl/index.md

@@ -51,7 +51,6 @@ layout: manual
 * [`helixRevolutions`](kcl/helixRevolutions)
 * [`hole`](kcl/hole)
 * [`hollow`](kcl/hollow)
-* [`import`](kcl/import)
 * [`inch`](kcl/inch)
 * [`lastSegX`](kcl/lastSegX)
 * [`lastSegY`](kcl/lastSegY)

docs/kcl/std.json

@@ -92765,7 +92765,7 @@
   {
     "name": "import",
     "summary": "Import a CAD file.",
-    "description": "For formats lacking unit data (such as STL, OBJ, or PLY files), the default unit of measurement is millimeters. Alternatively you may specify the unit by passing your desired measurement unit in the options parameter. When importing a GLTF file, the bin file will be imported as well. Import paths are relative to the current project directory.\n\nNote: The import command currently only works when using the native Modeling App.\n\nFor importing KCL functions using the `import` statement, see the docs on [KCL modules](/docs/kcl/modules).",
+    "description": "**DEPRECATED** Prefer to use import statements.\n\nFor formats lacking unit data (such as STL, OBJ, or PLY files), the default unit of measurement is millimeters. Alternatively you may specify the unit by passing your desired measurement unit in the options parameter. When importing a GLTF file, the bin file will be imported as well. Import paths are relative to the current project directory.\n\nNote: The import command currently only works when using the native Modeling App.\n\nFor importing KCL functions using the `import` statement, see the docs on [KCL modules](/docs/kcl/modules).",
     "tags": [],
     "keywordArguments": false,
     "args": [
@@ -93168,7 +93168,7 @@
       "labelRequired": true
     },
     "unpublished": false,
-    "deprecated": false,
+    "deprecated": true,
     "examples": [
       "model = import(\"tests/inputs/cube.obj\")",
       "model = import(\"tests/inputs/cube.obj\", { format = \"obj\", units = \"m\" })",

src/wasm-lib/kcl/src/execution/import.rs

@@ -0,0 +1,294 @@
+use std::{ffi::OsStr, path::Path, str::FromStr};
+
+use anyhow::Result;
+use kcmc::{
+    coord::{Axis, AxisDirectionPair, Direction, System},
+    each_cmd as mcmd,
+    format::InputFormat,
+    ok_response::OkModelingCmdResponse,
+    shared::FileImportFormat,
+    units::UnitLength,
+    websocket::OkWebSocketResponseData,
+    ImportFile, ModelingCmd,
+};
+use kittycad_modeling_cmds as kcmc;
+use serde::{Deserialize, Serialize};
+use uuid::Uuid;
+
+use crate::{
+    errors::{KclError, KclErrorDetails},
+    execution::{ExecState, ImportedGeometry},
+    fs::FileSystem,
+    source_range::SourceRange,
+};
+
+use super::ExecutorContext;
+
+// Zoo co-ordinate system.
+//
+// * Forward: -Y
+// * Up: +Z
+// * Handedness: Right
+pub const ZOO_COORD_SYSTEM: System = System {
+    forward: AxisDirectionPair {
+        axis: Axis::Y,
+        direction: Direction::Negative,
+    },
+    up: AxisDirectionPair {
+        axis: Axis::Z,
+        direction: Direction::Positive,
+    },
+};
+
+pub async fn import_foreign(
+    file_path: &Path,
+    format: Option<InputFormat>,
+    exec_state: &mut ExecState,
+    ctxt: &ExecutorContext,
+    source_range: SourceRange,
+) -> Result<PreImportedGeometry, KclError> {
+    // Make sure the file exists.
+    if !ctxt.fs.exists(file_path, source_range).await? {
+        return Err(KclError::Semantic(KclErrorDetails {
+            message: format!("File `{}` does not exist.", file_path.display()),
+            source_ranges: vec![source_range],
+        }));
+    }
+
+    let ext_format = get_import_format_from_extension(file_path.extension().ok_or_else(|| {
+        KclError::Semantic(KclErrorDetails {
+            message: format!("No file extension found for `{}`", file_path.display()),
+            source_ranges: vec![source_range],
+        })
+    })?)
+    .map_err(|e| {
+        KclError::Semantic(KclErrorDetails {
+            message: e.to_string(),
+            source_ranges: vec![source_range],
+        })
+    })?;
+
+    // Get the format type from the extension of the file.
+    let format = if let Some(format) = format {
+        // Validate the given format with the extension format.
+        validate_extension_format(ext_format, format.clone()).map_err(|e| {
+            KclError::Semantic(KclErrorDetails {
+                message: e.to_string(),
+                source_ranges: vec![source_range],
+            })
+        })?;
+        format
+    } else {
+        ext_format
+    };
+
+    // Get the file contents for each file path.
+    let file_contents = ctxt.fs.read(file_path, source_range).await.map_err(|e| {
+        KclError::Semantic(KclErrorDetails {
+            message: e.to_string(),
+            source_ranges: vec![source_range],
+        })
+    })?;
+
+    // We want the file_path to be without the parent.
+    let file_name = std::path::Path::new(&file_path)
+        .file_name()
+        .map(|p| p.to_string_lossy().to_string())
+        .ok_or_else(|| {
+            KclError::Semantic(KclErrorDetails {
+                message: format!("Could not get the file name from the path `{}`", file_path.display()),
+                source_ranges: vec![source_range],
+            })
+        })?;
+    let mut import_files = vec![kcmc::ImportFile {
+        path: file_name.to_string(),
+        data: file_contents.clone(),
+    }];
+
+    // In the case of a gltf importing a bin file we need to handle that! and figure out where the
+    // file is relative to our current file.
+    if let InputFormat::Gltf(..) = format {
+        // Check if the file is a binary gltf file, in that case we don't need to import the bin
+        // file.
+        if !file_contents.starts_with(b"glTF") {
+            let json = gltf_json::Root::from_slice(&file_contents).map_err(|e| {
+                KclError::Semantic(KclErrorDetails {
+                    message: e.to_string(),
+                    source_ranges: vec![source_range],
+                })
+            })?;
+
+            // Read the gltf file and check if there is a bin file.
+            for buffer in json.buffers.iter() {
+                if let Some(uri) = &buffer.uri {
+                    if !uri.starts_with("data:") {
+                        // We want this path relative to the file_path given.
+                        let bin_path = std::path::Path::new(&file_path)
+                            .parent()
+                            .map(|p| p.join(uri))
+                            .map(|p| p.to_string_lossy().to_string())
+                            .ok_or_else(|| {
+                                KclError::Semantic(KclErrorDetails {
+                                    message: format!(
+                                        "Could not get the parent path of the file `{}`",
+                                        file_path.display()
+                                    ),
+                                    source_ranges: vec![source_range],
+                                })
+                            })?;
+
+                        let bin_contents = ctxt.fs.read(&bin_path, source_range).await.map_err(|e| {
+                            KclError::Semantic(KclErrorDetails {
+                                message: e.to_string(),
+                                source_ranges: vec![source_range],
+                            })
+                        })?;
+
+                        import_files.push(ImportFile {
+                            path: uri.to_string(),
+                            data: bin_contents,
+                        });
+                    }
+                }
+            }
+        }
+    }
+    Ok(PreImportedGeometry {
+        id: exec_state.next_uuid(),
+        source_range,
+        command: mcmd::ImportFiles {
+            files: import_files.clone(),
+            format,
+        },
+    })
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize)]
+pub struct PreImportedGeometry {
+    id: Uuid,
+    command: mcmd::ImportFiles,
+    source_range: SourceRange,
+}
+
+pub async fn send_to_engine(pre: PreImportedGeometry, ctxt: &ExecutorContext) -> Result<ImportedGeometry, KclError> {
+    if ctxt.is_mock() {
+        return Ok(ImportedGeometry {
+            id: pre.id,
+            value: pre.command.files.iter().map(|f| f.path.to_string()).collect(),
+            meta: vec![pre.source_range.into()],
+        });
+    }
+
+    let resp = ctxt
+        .engine
+        .send_modeling_cmd(pre.id, pre.source_range, &ModelingCmd::from(pre.command.clone()))
+        .await?;
+
+    let OkWebSocketResponseData::Modeling {
+        modeling_response: OkModelingCmdResponse::ImportFiles(imported_files),
+    } = &resp
+    else {
+        return Err(KclError::Engine(KclErrorDetails {
+            message: format!("ImportFiles response was not as expected: {:?}", resp),
+            source_ranges: vec![pre.source_range],
+        }));
+    };
+
+    Ok(ImportedGeometry {
+        id: imported_files.object_id,
+        value: pre.command.files.iter().map(|f| f.path.to_string()).collect(),
+        meta: vec![pre.source_range.into()],
+    })
+}
+
+/// Get the source format from the extension.
+fn get_import_format_from_extension(ext: &OsStr) -> Result<InputFormat> {
+    let ext = ext
+        .to_str()
+        .ok_or_else(|| anyhow::anyhow!("Invalid file extension: `{ext:?}`"))?;
+    let format = match FileImportFormat::from_str(ext) {
+        Ok(format) => format,
+        Err(_) => {
+            if ext == "stp" {
+                FileImportFormat::Step
+            } else if ext == "glb" {
+                FileImportFormat::Gltf
+            } else {
+                anyhow::bail!("unknown source format for file extension: {ext}. Try setting the `--src-format` flag explicitly or use a valid format.")
+            }
+        }
+    };
+
+    // Make the default units millimeters.
+    let ul = UnitLength::Millimeters;
+
+    // Zoo co-ordinate system.
+    //
+    // * Forward: -Y
+    // * Up: +Z
+    // * Handedness: Right
+    match format {
+        FileImportFormat::Step => Ok(InputFormat::Step(kcmc::format::step::import::Options {
+            split_closed_faces: false,
+        })),
+        FileImportFormat::Stl => Ok(InputFormat::Stl(kcmc::format::stl::import::Options {
+            coords: ZOO_COORD_SYSTEM,
+            units: ul,
+        })),
+        FileImportFormat::Obj => Ok(InputFormat::Obj(kcmc::format::obj::import::Options {
+            coords: ZOO_COORD_SYSTEM,
+            units: ul,
+        })),
+        FileImportFormat::Gltf => Ok(InputFormat::Gltf(kcmc::format::gltf::import::Options {})),
+        FileImportFormat::Ply => Ok(InputFormat::Ply(kcmc::format::ply::import::Options {
+            coords: ZOO_COORD_SYSTEM,
+            units: ul,
+        })),
+        FileImportFormat::Fbx => Ok(InputFormat::Fbx(kcmc::format::fbx::import::Options {})),
+        FileImportFormat::Sldprt => Ok(InputFormat::Sldprt(kcmc::format::sldprt::import::Options {
+            split_closed_faces: false,
+        })),
+    }
+}
+
+fn validate_extension_format(ext: InputFormat, given: InputFormat) -> Result<()> {
+    if let InputFormat::Stl(_) = ext {
+        if let InputFormat::Stl(_) = given {
+            return Ok(());
+        }
+    }
+
+    if let InputFormat::Obj(_) = ext {
+        if let InputFormat::Obj(_) = given {
+            return Ok(());
+        }
+    }
+
+    if let InputFormat::Ply(_) = ext {
+        if let InputFormat::Ply(_) = given {
+            return Ok(());
+        }
+    }
+
+    if ext == given {
+        return Ok(());
+    }
+
+    anyhow::bail!(
+        "The given format does not match the file extension. Expected: `{}`, Given: `{}`",
+        get_name_of_format(ext),
+        get_name_of_format(given)
+    )
+}
+
+fn get_name_of_format(type_: InputFormat) -> &'static str {
+    match type_ {
+        InputFormat::Fbx(_) => "fbx",
+        InputFormat::Gltf(_) => "gltf",
+        InputFormat::Obj(_) => "obj",
+        InputFormat::Ply(_) => "ply",
+        InputFormat::Sldprt(_) => "sldprt",
+        InputFormat::Step(_) => "step",
+        InputFormat::Stl(_) => "stl",
+    }
+}