Add chmod/chmodSync on unix (and fix Cargo.toml) (denoland#1088)

Initial implementation by Srijan Reddy (@srijanreddy98, denoland#672).

BUILD.gn

@@ -69,6 +69,7 @@ main_extern = [
 ts_sources = [
  "js/assets.ts",
  "js/blob.ts",
+ "js/chmod.ts",
  "js/compiler.ts",
  "js/console.ts",
  "js/copy_file.ts",

Cargo.toml

@@ -23,3 +23,4 @@ ring = "0.13.2"
 tempfile = "3"
 tokio = "0.1.11"
 url = "1.7.1"
+getopts = "0.2.18"

js/chmod.ts

@@ -0,0 +1,36 @@
+// Copyright 2018 the Deno authors. All rights reserved. MIT license.
+import * as msg from "gen/msg_generated";
+import * as flatbuffers from "./flatbuffers";
+import * as dispatch from "./dispatch";
+
+/** Changes the permission of a specific file/directory of specified path
+ * synchronously.
+ *
+ * import { chmodSync } from "deno";
+ * chmodSync("/path/to/file", 0o666);
+ */
+export function chmodSync(path: string, mode: number): void {
+ dispatch.sendSync(...req(path, mode));
+}
+
+/** Changes the permission of a specific file/directory of specified path.
+ *
+ * import { chmod } from "deno";
+ * await chmod("/path/to/file", 0o666);
+ */
+export async function chmod(path: string, mode: number): Promise<void> {
+ await dispatch.sendAsync(...req(path, mode));
+}
+
+function req(
+ path: string,
+ mode: number
+): [flatbuffers.Builder, msg.Any, flatbuffers.Offset] {
+ const builder = flatbuffers.createBuilder();
+ const path_ = builder.createString(path);
+ msg.Chmod.startChmod(builder);
+ msg.Chmod.addPath(builder, path_);
+ msg.Chmod.addMode(builder, mode);
+ const inner = msg.Chmod.endChmod(builder);
+ return [builder, msg.Any.Chmod, inner];
+}

js/chmod_test.ts

@@ -0,0 +1,135 @@
+// Copyright 2018 the Deno authors. All rights reserved. MIT license.
+import { testPerm, assertEqual } from "./test_util.ts";
+import * as deno from "deno";
+
+const isNotWindows = deno.platform.os !== "win";
+
+testPerm({ write: true }, function chmodSyncSuccess() {
+ const enc = new TextEncoder();
+ const data = enc.encode("Hello");
+ const tempDir = deno.makeTempDirSync();
+ const filename = tempDir + "/test.txt";
+ deno.writeFileSync(filename, data, 0o666);
+
+ // On windows no effect, but should not crash
+ deno.chmodSync(filename, 0o777);
+
+ // Check success when not on windows
+ if (isNotWindows) {
+ const fileInfo = deno.statSync(filename);
+ assertEqual(fileInfo.mode & 0o777, 0o777);
+ }
+});
+
+// Check symlink when not on windows
+if (isNotWindows) {
+ testPerm({ write: true }, function chmodSyncSymlinkSuccess() {
+ const enc = new TextEncoder();
+ const data = enc.encode("Hello");
+ const tempDir = deno.makeTempDirSync();
+
+ const filename = tempDir + "/test.txt";
+ deno.writeFileSync(filename, data, 0o666);
+ const symlinkName = tempDir + "/test_symlink.txt";
+ deno.symlink(filename, symlinkName);
+
+ let symlinkInfo = deno.lstatSync(symlinkName);
+ const symlinkMode = symlinkInfo.mode & 0o777; // plaform dependent
+
+ deno.chmodSync(symlinkName, 0o777);
+
+ // Change actual file mode, not symlink
+ const fileInfo = deno.statSync(filename);
+ assertEqual(fileInfo.mode & 0o777, 0o777);
+ symlinkInfo = deno.lstatSync(symlinkName);
+ assertEqual(symlinkInfo.mode & 0o777, symlinkMode);
+ });
+}
+
+testPerm({ write: true }, function chmodSyncFailure() {
+ let err;
+ try {
+ const filename = "/badfile.txt";
+ deno.chmodSync(filename, 0o777);
+ } catch (e) {
+ err = e;
+ }
+ assertEqual(err.kind, deno.ErrorKind.NotFound);
+ assertEqual(err.name, "NotFound");
+});
+
+testPerm({ write: false }, function chmodSyncPerm() {
+ let err;
+ try {
+ deno.chmodSync("/somefile.txt", 0o777);
+ } catch (e) {
+ err = e;
+ }
+ assertEqual(err.kind, deno.ErrorKind.PermissionDenied);
+ assertEqual(err.name, "PermissionDenied");
+});
+
+testPerm({ write: true }, async function chmodSuccess() {
+ const enc = new TextEncoder();
+ const data = enc.encode("Hello");
+ const tempDir = deno.makeTempDirSync();
+ const filename = tempDir + "/test.txt";
+ deno.writeFileSync(filename, data, 0o666);
+
+ // On windows no effect, but should not crash
+ await deno.chmod(filename, 0o777);
+
+ // Check success when not on windows
+ if (isNotWindows) {
+ const fileInfo = deno.statSync(filename);
+ assertEqual(fileInfo.mode & 0o777, 0o777);
+ }
+});
+
+// Check symlink when not on windows
+if (isNotWindows) {
+ testPerm({ write: true }, async function chmodSymlinkSuccess() {
+ const enc = new TextEncoder();
+ const data = enc.encode("Hello");
+ const tempDir = deno.makeTempDirSync();
+
+ const filename = tempDir + "/test.txt";
+ deno.writeFileSync(filename, data, 0o666);
+ const symlinkName = tempDir + "/test_symlink.txt";
+ deno.symlink(filename, symlinkName);
+
+ let symlinkInfo = deno.lstatSync(symlinkName);
+ const symlinkMode = symlinkInfo.mode & 0o777; // plaform dependent
+
+ await deno.chmod(symlinkName, 0o777);
+
+ // Just change actual file mode, not symlink
+ const fileInfo = deno.statSync(filename);
+ assertEqual(fileInfo.mode & 0o777, 0o777);
+ symlinkInfo = deno.lstatSync(symlinkName);
+ assertEqual(symlinkInfo.mode & 0o777, symlinkMode);
+ });
+}
+
+testPerm({ write: true }, async function chmodFailure() {
+ let err;
+ try {
+ const filename = "/badfile.txt";
+ await deno.chmod(filename, 0o777);
+ } catch (e) {
+ err = e;
+ }
+ assertEqual(err.kind, deno.ErrorKind.NotFound);
+ assertEqual(err.name, "NotFound");
+});
+
+testPerm({ write: false }, async function chmodPerm() {
+ let err;
+ try {
+ await deno.chmod("/somefile.txt", 0o777);
+ } catch (e) {
+ err = e;
+ }
+ assertEqual(err.kind, deno.ErrorKind.PermissionDenied);
+ assertEqual(err.name, "PermissionDenied");
+});

js/deno.ts

@@ -21,6 +21,7 @@ export {
 } from "./io";
 export { mkdirSync, mkdir } from "./mkdir";
 export { makeTempDirSync, makeTempDir } from "./make_temp_dir";
+export { chmodSync, chmod } from "./chmod";
 export { removeSync, remove, removeAllSync, removeAll } from "./remove";
 export { renameSync, rename } from "./rename";
 export { readFileSync, readFile } from "./read_file";

js/unit_tests.ts

@@ -12,6 +12,7 @@ import "./read_dir_test.ts";
 import "./write_file_test.ts";
 import "./copy_file_test.ts";
 import "./mkdir_test.ts";
+import "./chmod_test.ts";
 import "./dir_test";
 import "./make_temp_dir_test.ts";
 import "./stat_test.ts";

src/msg.fbs

@@ -13,6 +13,7 @@ union Any {
  MakeTempDir,
  MakeTempDirRes,
  Mkdir,
+ Chmod,
  Remove,
  ReadFile,
  ReadFileRes,
@@ -213,6 +214,12 @@ table Mkdir {
  // mode specified by https://godoc.org/os#FileMode
 }
 
+table Chmod {
+ path: string;
+ mode: uint;
+ // mode specified by https://godoc.org/os#FileMode
+}
+
 table Remove {
  path: string;
  recursive: bool;

src/ops.rs

@@ -74,6 +74,7 @@ pub fn dispatch(
  let op_creator: OpCreator = match inner_type {
  msg::Any::Accept => op_accept,
  msg::Any::Chdir => op_chdir,
+ msg::Any::Chmod => op_chmod,
  msg::Any::Close => op_close,
  msg::Any::CodeCache => op_code_cache,
  msg::Any::CodeFetch => op_code_fetch,
@@ -572,6 +573,36 @@ fn op_mkdir(
  })
 }
 
+fn op_chmod(
+ state: Arc<IsolateState>,
+ base: &msg::Base,
+ data: &'static mut [u8],
+) -> Box<Op> {
+ assert_eq!(data.len(), 0);
+ let inner = base.inner_as_chmod().unwrap();
+ let _mode = inner.mode();
+ let path = String::from(inner.path().unwrap());
+
+ if !state.flags.allow_write {
+ return odd_future(permission_denied());
+ }
+
+ blocking!(base.sync(), || {
+ debug!("op_chmod {}", &path);
+ let path = PathBuf::from(&path);
+ // Still check file/dir exists on windows
+ let _metadata = fs::metadata(&path)?;
+ // Only work in unix
+ #[cfg(any(unix))]
+ {
+ let mut permissions = _metadata.permissions();
+ permissions.set_mode(_mode);
+ fs::set_permissions(&path, permissions)?;
+ }
+ Ok(empty_buf())
+ })
+}
+
 fn op_open(
  _state: Arc<IsolateState>,
  base: &msg::Base,