rclonefile 1.0.1

package/.yarnrc.yml

@@ -0,0 +1,3 @@
+nodeLinker: node-modules
+
+yarnPath: .yarn/releases/yarn-3.4.1.cjs

package/Cargo.toml

@@ -0,0 +1,20 @@
+[package]
+edition = "2021"
+name = "rclonefile"
+version = "0.0.0"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+# Default enable napi4 feature, see https://nodejs.org/api/n-api.html#node-api-version-matrix
+napi = { version = "2.10.16", default-features = false, features = ["napi4"] }
+napi-derive = "2.10.1"
+libc = "0.2.139"
+errno = "0.3.0"
+
+[build-dependencies]
+napi-build = "2.0.1"
+
+[profile.release]
+lto = true

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Sverre Johansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,41 @@
+# rclonefile
+
+The macOS API for creating copy on write clones of files.
+
+This is a small wrapper around the
+[clonefile](https://www.manpagez.com/man/2/clonefile/) API on macOS for cloning
+files using the APFS file system.
+
+# Usage
+
+## Sync API
+
+```js
+
+import { cloneFileSync } from "rclonefile";
+
+cloneFileSync("source/mario.txt", "target/mario-clone-txt");
+
+```
+
+## async/await
+
+```js
+
+import { cloneFile } from "rclonefile";
+
+await cloneFile("source/mario.txt", "target/mario-clone-txt");
+
+```
+
+## Promise
+
+```js
+
+import { cloneFile } from "rclonefile";
+
+cloneFile("source/mario.txt", "target/mario-clone-txt").then(() => {
+	// Success
+})
+
+```

package/babel.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+};

package/build.rs

@@ -0,0 +1,5 @@
+extern crate napi_build;
+
+fn main() {
+  napi_build::setup();
+}

package/index.d.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/* auto-generated by NAPI-RS */
+
+export interface CloneFileOptions {
+  noFollow?: boolean
+  noOwnerCopy?: boolean
+  cloneAcl?: boolean
+}
+export function cloneFileSync(src: string, dst: string, options?: CloneFileOptions | undefined | null): number
+export function cloneFile(src: string, dst: string, options?: CloneFileOptions | undefined | null): Promise<number>

package/index.js

@@ -0,0 +1,252 @@
+const { existsSync, readFileSync } = require('fs')
+const { join } = require('path')
+
+const { platform, arch } = process
+
+let nativeBinding = null
+let localFileExisted = false
+let loadError = null
+
+function isMusl() {
+  // For Node 10
+  if (!process.report || typeof process.report.getReport !== 'function') {
+    try {
+      const lddPath = require('child_process').execSync('which ldd').toString().trim();
+      return readFileSync(lddPath, 'utf8').includes('musl')
+    } catch (e) {
+      return true
+    }
+  } else {
+    const { glibcVersionRuntime } = process.report.getReport().header
+    return !glibcVersionRuntime
+  }
+}
+
+switch (platform) {
+  case 'android':
+    switch (arch) {
+      case 'arm64':
+        localFileExisted = existsSync(join(__dirname, 'rclonefile.android-arm64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.android-arm64.node')
+          } else {
+            nativeBinding = require('rclonefile-android-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(join(__dirname, 'rclonefile.android-arm-eabi.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.android-arm-eabi.node')
+          } else {
+            nativeBinding = require('rclonefile-android-arm-eabi')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Android ${arch}`)
+    }
+    break
+  case 'win32':
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rclonefile.win32-x64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.win32-x64-msvc.node')
+          } else {
+            nativeBinding = require('rclonefile-win32-x64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'ia32':
+        localFileExisted = existsSync(
+          join(__dirname, 'rclonefile.win32-ia32-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.win32-ia32-msvc.node')
+          } else {
+            nativeBinding = require('rclonefile-win32-ia32-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rclonefile.win32-arm64-msvc.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.win32-arm64-msvc.node')
+          } else {
+            nativeBinding = require('rclonefile-win32-arm64-msvc')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Windows: ${arch}`)
+    }
+    break
+  case 'darwin':
+    localFileExisted = existsSync(join(__dirname, 'rclonefile.darwin-universal.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rclonefile.darwin-universal.node')
+      } else {
+        nativeBinding = require('rclonefile-darwin-universal')
+      }
+      break
+    } catch {}
+    switch (arch) {
+      case 'x64':
+        localFileExisted = existsSync(join(__dirname, 'rclonefile.darwin-x64.node'))
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.darwin-x64.node')
+          } else {
+            nativeBinding = require('rclonefile-darwin-x64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      case 'arm64':
+        localFileExisted = existsSync(
+          join(__dirname, 'rclonefile.darwin-arm64.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.darwin-arm64.node')
+          } else {
+            nativeBinding = require('rclonefile-darwin-arm64')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on macOS: ${arch}`)
+    }
+    break
+  case 'freebsd':
+    if (arch !== 'x64') {
+      throw new Error(`Unsupported architecture on FreeBSD: ${arch}`)
+    }
+    localFileExisted = existsSync(join(__dirname, 'rclonefile.freebsd-x64.node'))
+    try {
+      if (localFileExisted) {
+        nativeBinding = require('./rclonefile.freebsd-x64.node')
+      } else {
+        nativeBinding = require('rclonefile-freebsd-x64')
+      }
+    } catch (e) {
+      loadError = e
+    }
+    break
+  case 'linux':
+    switch (arch) {
+      case 'x64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rclonefile.linux-x64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rclonefile.linux-x64-musl.node')
+            } else {
+              nativeBinding = require('rclonefile-linux-x64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rclonefile.linux-x64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rclonefile.linux-x64-gnu.node')
+            } else {
+              nativeBinding = require('rclonefile-linux-x64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm64':
+        if (isMusl()) {
+          localFileExisted = existsSync(
+            join(__dirname, 'rclonefile.linux-arm64-musl.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rclonefile.linux-arm64-musl.node')
+            } else {
+              nativeBinding = require('rclonefile-linux-arm64-musl')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        } else {
+          localFileExisted = existsSync(
+            join(__dirname, 'rclonefile.linux-arm64-gnu.node')
+          )
+          try {
+            if (localFileExisted) {
+              nativeBinding = require('./rclonefile.linux-arm64-gnu.node')
+            } else {
+              nativeBinding = require('rclonefile-linux-arm64-gnu')
+            }
+          } catch (e) {
+            loadError = e
+          }
+        }
+        break
+      case 'arm':
+        localFileExisted = existsSync(
+          join(__dirname, 'rclonefile.linux-arm-gnueabihf.node')
+        )
+        try {
+          if (localFileExisted) {
+            nativeBinding = require('./rclonefile.linux-arm-gnueabihf.node')
+          } else {
+            nativeBinding = require('rclonefile-linux-arm-gnueabihf')
+          }
+        } catch (e) {
+          loadError = e
+        }
+        break
+      default:
+        throw new Error(`Unsupported architecture on Linux: ${arch}`)
+    }
+    break
+  default:
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+if (!nativeBinding) {
+  if (loadError) {
+    throw loadError
+  }
+  throw new Error(`Failed to load native binding`)
+}
+
+const { cloneFileSync, cloneFile } = nativeBinding
+
+module.exports.cloneFileSync = cloneFileSync
+module.exports.cloneFile = cloneFile

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "rclonefile",
+  "version": "1.0.1",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "napi": {
+    "name": "rclonefile",
+    "triples": {
+      "defaults": false,
+      "additional": [
+        "aarch64-apple-darwin",
+        "x86_64-apple-darwin"
+      ]
+    }
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
+    "@jest/globals": "^29.4.2",
+    "@napi-rs/cli": "^2.14.7",
+    "ava": "^5.1.1",
+    "babel-jest": "^29.4.2",
+    "jest": "^29.4.2",
+    "prettier": "^2.8.4",
+    "tempy": "^1.0.1"
+  },
+  "engines": {
+    "node": ">= 10"
+  },
+  "scripts": {
+    "artifacts": "napi artifacts",
+    "build": "napi build --platform --release",
+    "build:debug": "napi build --platform",
+    "prepublishOnly": "napi prepublish -t npm",
+    "test": "jest",
+    "universal": "napi universal",
+    "version": "napi version"
+  },
+  "packageManager": "yarn@3.4.1",
+  "dependencies": {
+    "esm": "^3.2.25"
+  },
+  "repository": "https://github.com/sverrejoh/rclonefile",
+  "description": "macOS API for creating copy on write clones of files",
+  "optionalDependencies": {
+    "rclonefile-darwin-arm64": "1.0.1",
+    "rclonefile-darwin-x64": "1.0.1"
+  }
+}

package/src/lib.rs

@@ -0,0 +1,94 @@
+#![deny(clippy::all)]
+
+extern crate libc;
+use errno::{errno, set_errno};
+use libc::clonefile;
+use napi::bindgen_prelude::AsyncTask;
+use napi::{Env, Error, JsNumber, Result, Task};
+use std::ffi::CString;
+
+#[macro_use]
+extern crate napi_derive;
+
+#[napi(object)]
+#[derive(Default, Clone, Debug)]
+pub struct CloneFileOptions {
+  pub no_follow: Option<bool>,
+  pub no_owner_copy: Option<bool>,
+  pub clone_acl: Option<bool>,
+}
+
+const CLONE_NOFOLLOW: u32 = 1 << 0;
+const CLONE_NOOWNERCOPY: u32 = 1 << 1;
+const CLONE_ACL: u32 = 1 << 2;
+
+fn flags_from_options(options: Option<CloneFileOptions>) -> u32 {
+  match options {
+    None => 0,
+    Some(options) => {
+      let CloneFileOptions {
+        no_follow,
+        no_owner_copy,
+        clone_acl,
+      } = options;
+
+      let flags = no_follow
+        .unwrap_or(false)
+        .then_some(CLONE_NOFOLLOW)
+        .unwrap_or(0)
+        | no_owner_copy
+          .unwrap_or(false)
+          .then_some(CLONE_NOOWNERCOPY)
+          .unwrap_or(0)
+        | clone_acl.unwrap_or(false).then_some(CLONE_ACL).unwrap_or(0);
+
+      flags
+    }
+  }
+}
+
+#[napi(js_name = "cloneFileSync")]
+pub fn clonefile_sync(src: String, dst: String, options: Option<CloneFileOptions>) -> Result<i32> {
+  let src = CString::new(src)?;
+  let dst = CString::new(dst)?;
+  let flags = flags_from_options(options);
+
+  let res = unsafe { clonefile(src.as_ptr(), dst.as_ptr(), flags) };
+
+  if res == -1 {
+    let e = errno();
+    set_errno(e);
+    return Err(Error::from_reason(format!("{e}")));
+  } else {
+    return Ok(res);
+  }
+}
+
+pub struct AsyncClonefile {
+  src: String,
+  dst: String,
+  options: Option<CloneFileOptions>,
+}
+
+#[napi]
+impl Task for AsyncClonefile {
+  type Output = i32;
+  type JsValue = JsNumber;
+
+  fn compute(&mut self) -> Result<Self::Output> {
+    clonefile_sync(self.src.clone(), self.dst.clone(), self.options.clone())
+  }
+
+  fn resolve(&mut self, env: Env, output: i32) -> Result<Self::JsValue> {
+    env.create_int32(output)
+  }
+}
+
+#[napi(js_name = "cloneFile")]
+pub fn clonefile_task(
+  src: String,
+  dst: String,
+  options: Option<CloneFileOptions>,
+) -> AsyncTask<AsyncClonefile> {
+  AsyncTask::new(AsyncClonefile { src, dst, options })
+}