// Copyright Joyent, Inc. and other Node contributors. // // 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. #include "node_buffer.h" #include "node_internals.h" #include "node_stat_watcher.h" #include "req_wrap-inl.h" #include "string_bytes.h" #include "string_search.h" #include #include #include #include #include #include #if defined(__MINGW32__) || defined(_MSC_VER) # include #endif #include namespace node { namespace { using v8::Array; using v8::ArrayBuffer; using v8::Context; using v8::Float64Array; using v8::Function; using v8::FunctionCallbackInfo; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Local; using v8::MaybeLocal; using v8::Number; using v8::Object; using v8::String; using v8::Value; #ifndef MIN # define MIN(a, b) ((a) < (b) ? (a) : (b)) #endif #define TYPE_ERROR(msg) env->ThrowTypeError(msg) #define GET_OFFSET(a) ((a)->IsNumber() ? (a)->IntegerValue() : -1) class FSReqWrap: public ReqWrap { public: enum Ownership { COPY, MOVE }; inline static FSReqWrap* New(Environment* env, Local req, const char* syscall, const char* data = nullptr, enum encoding encoding = UTF8, Ownership ownership = COPY); inline void Dispose(); void ReleaseEarly() { if (data_ != inline_data()) { delete[] data_; data_ = nullptr; } } const char* syscall() const { return syscall_; } const char* data() const { return data_; } const enum encoding encoding_; size_t self_size() const override { return sizeof(*this); } private: FSReqWrap(Environment* env, Local req, const char* syscall, const char* data, enum encoding encoding) : ReqWrap(env, req, AsyncWrap::PROVIDER_FSREQWRAP), encoding_(encoding), syscall_(syscall), data_(data) { Wrap(object(), this); } ~FSReqWrap() { ReleaseEarly(); ClearWrap(object()); } void* operator new(size_t size) = delete; void* operator new(size_t size, char* storage) { return storage; } char* inline_data() { return reinterpret_cast(this + 1); } const char* syscall_; const char* data_; DISALLOW_COPY_AND_ASSIGN(FSReqWrap); }; #define ASSERT_PATH(path) \ if (*path == nullptr) \ return TYPE_ERROR( #path " must be a string or Buffer"); FSReqWrap* FSReqWrap::New(Environment* env, Local req, const char* syscall, const char* data, enum encoding encoding, Ownership ownership) { const bool copy = (data != nullptr && ownership == COPY); const size_t size = copy ? 1 + strlen(data) : 0; FSReqWrap* that; char* const storage = new char[sizeof(*that) + size]; that = new(storage) FSReqWrap(env, req, syscall, data, encoding); if (copy) that->data_ = static_cast(memcpy(that->inline_data(), data, size)); return that; } void FSReqWrap::Dispose() { this->~FSReqWrap(); delete[] reinterpret_cast(this); } void NewFSReqWrap(const FunctionCallbackInfo& args) { CHECK(args.IsConstructCall()); ClearWrap(args.This()); } inline bool IsInt64(double x) { return x == static_cast(static_cast(x)); } void After(uv_fs_t *req) { FSReqWrap* req_wrap = static_cast(req->data); CHECK_EQ(req_wrap->req(), req); req_wrap->ReleaseEarly(); // Free memory that's no longer used now. Environment* env = req_wrap->env(); HandleScope handle_scope(env->isolate()); Context::Scope context_scope(env->context()); // there is always at least one argument. "error" int argc = 1; // Allocate space for two args. We may only use one depending on the case. // (Feel free to increase this if you need more) Local argv[2]; MaybeLocal link; Local error; if (req->result < 0) { // An error happened. argv[0] = UVException(env->isolate(), req->result, req_wrap->syscall(), nullptr, req->path, req_wrap->data()); } else { // error value is empty or null for non-error. argv[0] = Null(env->isolate()); // All have at least two args now. argc = 2; switch (req->fs_type) { // These all have no data to pass. case UV_FS_ACCESS: case UV_FS_CLOSE: case UV_FS_RENAME: case UV_FS_UNLINK: case UV_FS_RMDIR: case UV_FS_MKDIR: case UV_FS_FTRUNCATE: case UV_FS_FSYNC: case UV_FS_FDATASYNC: case UV_FS_LINK: case UV_FS_SYMLINK: case UV_FS_CHMOD: case UV_FS_FCHMOD: case UV_FS_CHOWN: case UV_FS_FCHOWN: case UV_FS_COPYFILE: // These, however, don't. argc = 1; break; case UV_FS_STAT: case UV_FS_LSTAT: case UV_FS_FSTAT: argc = 1; FillStatsArray(env->fs_stats_field_array(), static_cast(req->ptr)); break; case UV_FS_UTIME: case UV_FS_FUTIME: argc = 0; break; case UV_FS_OPEN: argv[1] = Integer::New(env->isolate(), req->result); break; case UV_FS_WRITE: argv[1] = Integer::New(env->isolate(), req->result); break; case UV_FS_MKDTEMP: { link = StringBytes::Encode(env->isolate(), static_cast(req->path), req_wrap->encoding_, &error); if (link.IsEmpty()) { argv[0] = error; } else { argv[1] = link.ToLocalChecked(); } break; } case UV_FS_READLINK: link = StringBytes::Encode(env->isolate(), static_cast(req->ptr), req_wrap->encoding_, &error); if (link.IsEmpty()) { argv[0] = error; } else { argv[1] = link.ToLocalChecked(); } break; case UV_FS_REALPATH: link = StringBytes::Encode(env->isolate(), static_cast(req->ptr), req_wrap->encoding_, &error); if (link.IsEmpty()) { argv[0] = error; } else { argv[1] = link.ToLocalChecked(); } break; case UV_FS_READ: // Buffer interface argv[1] = Integer::New(env->isolate(), req->result); break; case UV_FS_SCANDIR: { int r; Local names = Array::New(env->isolate(), 0); Local fn = env->push_values_to_array_function(); Local name_argv[NODE_PUSH_VAL_TO_ARRAY_MAX]; size_t name_idx = 0; for (int i = 0; ; i++) { uv_dirent_t ent; r = uv_fs_scandir_next(req, &ent); if (r == UV_EOF) break; if (r != 0) { argv[0] = UVException(r, nullptr, req_wrap->syscall(), static_cast(req->path)); break; } MaybeLocal filename = StringBytes::Encode(env->isolate(), ent.name, req_wrap->encoding_, &error); if (filename.IsEmpty()) { argv[0] = error; break; } name_argv[name_idx++] = filename.ToLocalChecked(); if (name_idx >= arraysize(name_argv)) { fn->Call(env->context(), names, name_idx, name_argv) .ToLocalChecked(); name_idx = 0; } } if (name_idx > 0) { fn->Call(env->context(), names, name_idx, name_argv) .ToLocalChecked(); } argv[1] = names; } break; default: CHECK(0 && "Unhandled eio response"); } } req_wrap->MakeCallback(env->oncomplete_string(), argc, argv); uv_fs_req_cleanup(req_wrap->req()); req_wrap->Dispose(); } // This struct is only used on sync fs calls. // For async calls FSReqWrap is used. class fs_req_wrap { public: fs_req_wrap() {} ~fs_req_wrap() { uv_fs_req_cleanup(&req); } uv_fs_t req; private: DISALLOW_COPY_AND_ASSIGN(fs_req_wrap); }; // Template counterpart of ASYNC_DEST_CALL template inline FSReqWrap* AsyncDestCall(Environment* env, Local req, const char* dest, enum encoding enc, const char* syscall, Func fn, Args... args) { FSReqWrap* req_wrap = FSReqWrap::New(env, req, syscall, dest, enc); int err = fn(env->event_loop(), req_wrap->req(), args..., After); req_wrap->Dispatched(); if (err < 0) { uv_fs_t* uv_req = req_wrap->req(); uv_req->result = err; uv_req->path = nullptr; After(uv_req); req_wrap = nullptr; } return req_wrap; } // Template counterpart of ASYNC_CALL template inline FSReqWrap* AsyncCall(Environment* env, Local req, enum encoding enc, const char* syscall, Func fn, Args... args) { return AsyncDestCall(env, req, nullptr, enc, syscall, fn, args...); } #define ASYNC_DEST_CALL(func, request, dest, encoding, ...) \ Environment* env = Environment::GetCurrent(args); \ CHECK(request->IsObject()); \ FSReqWrap* req_wrap = FSReqWrap::New(env, request.As(), \ #func, dest, encoding); \ int err = uv_fs_ ## func(env->event_loop(), \ req_wrap->req(), \ __VA_ARGS__, \ After); \ req_wrap->Dispatched(); \ if (err < 0) { \ uv_fs_t* uv_req = req_wrap->req(); \ uv_req->result = err; \ uv_req->path = nullptr; \ After(uv_req); \ req_wrap = nullptr; \ } else { \ args.GetReturnValue().Set(req_wrap->persistent()); \ } #define ASYNC_CALL(func, req, encoding, ...) \ ASYNC_DEST_CALL(func, req, nullptr, encoding, __VA_ARGS__) \ // Template counterpart of SYNC_DEST_CALL template inline void SyncDestCall(Environment* env, Local ctx, const char* path, const char* dest, const char* syscall, Func fn, Args... args) { fs_req_wrap req_wrap; env->PrintSyncTrace(); int err = fn(env->event_loop(), &req_wrap.req, args..., nullptr); if (err) { Local context = env->context(); Local ctx_obj = ctx->ToObject(context).ToLocalChecked(); env->CollectUVExceptionInfo(ctx_obj, err, syscall, nullptr, path, dest); } } // Template counterpart of SYNC_CALL template inline void SyncCall(Environment* env, Local ctx, const char* path, const char* syscall, Func fn, Args... args) { return SyncDestCall(env, ctx, path, nullptr, syscall, fn, args...); } #define SYNC_DEST_CALL(func, path, dest, ...) \ fs_req_wrap req_wrap; \ env->PrintSyncTrace(); \ int err = uv_fs_ ## func(env->event_loop(), \ &req_wrap.req, \ __VA_ARGS__, \ nullptr); \ if (err < 0) { \ return env->ThrowUVException(err, #func, nullptr, path, dest); \ } \ #define SYNC_CALL(func, path, ...) \ SYNC_DEST_CALL(func, path, nullptr, __VA_ARGS__) \ #define SYNC_REQ req_wrap.req #define SYNC_RESULT err void Access(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args.GetIsolate()); HandleScope scope(env->isolate()); Local context = env->context(); CHECK_GE(args.Length(), 2); CHECK(args[1]->IsInt32()); BufferValue path(env->isolate(), args[0]); int mode = static_cast(args[1]->Int32Value(context).FromJust()); if (args[2]->IsObject()) { Local req_obj = args[2]->ToObject(context).ToLocalChecked(); FSReqWrap* req_wrap = AsyncCall( env, req_obj, UTF8, "access", uv_fs_access, *path, mode); if (req_wrap != nullptr) { args.GetReturnValue().Set(req_wrap->persistent()); } } else { SyncCall(env, args[3], *path, "access", uv_fs_access, *path, mode); } } void Close(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("fd is required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); int fd = args[0]->Int32Value(); if (args[1]->IsObject()) { ASYNC_CALL(close, args[1], UTF8, fd) } else { SYNC_CALL(close, 0, fd) } } } // anonymous namespace void FillStatsArray(double* fields, const uv_stat_t* s) { fields[0] = s->st_dev; fields[1] = s->st_mode; fields[2] = s->st_nlink; fields[3] = s->st_uid; fields[4] = s->st_gid; fields[5] = s->st_rdev; #if defined(__POSIX__) fields[6] = s->st_blksize; #else fields[6] = -1; #endif fields[7] = s->st_ino; fields[8] = s->st_size; #if defined(__POSIX__) fields[9] = s->st_blocks; #else fields[9] = -1; #endif // Dates. // NO-LINT because the fields are 'long' and we just want to cast to `unsigned` #define X(idx, name) \ /* NOLINTNEXTLINE(runtime/int) */ \ fields[idx] = ((unsigned long)(s->st_##name.tv_sec) * 1e3) + \ /* NOLINTNEXTLINE(runtime/int) */ \ ((unsigned long)(s->st_##name.tv_nsec) / 1e6); \ X(10, atim) X(11, mtim) X(12, ctim) X(13, birthtim) #undef X } // Used to speed up module loading. Returns the contents of the file as // a string or undefined when the file cannot be opened. Returns an empty // string when the file does not contain the substring '"main"' because that // is the property we care about. static void InternalModuleReadJSON(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); uv_loop_t* loop = env->event_loop(); CHECK(args[0]->IsString()); node::Utf8Value path(env->isolate(), args[0]); if (strlen(*path) != path.length()) return; // Contains a nul byte. uv_fs_t open_req; const int fd = uv_fs_open(loop, &open_req, *path, O_RDONLY, 0, nullptr); uv_fs_req_cleanup(&open_req); if (fd < 0) { return; } const size_t kBlockSize = 32 << 10; std::vector chars; int64_t offset = 0; ssize_t numchars; do { const size_t start = chars.size(); chars.resize(start + kBlockSize); uv_buf_t buf; buf.base = &chars[start]; buf.len = kBlockSize; uv_fs_t read_req; numchars = uv_fs_read(loop, &read_req, fd, &buf, 1, offset, nullptr); uv_fs_req_cleanup(&read_req); CHECK_GE(numchars, 0); offset += numchars; } while (static_cast(numchars) == kBlockSize); uv_fs_t close_req; CHECK_EQ(0, uv_fs_close(loop, &close_req, fd, nullptr)); uv_fs_req_cleanup(&close_req); size_t start = 0; if (offset >= 3 && 0 == memcmp(&chars[0], "\xEF\xBB\xBF", 3)) { start = 3; // Skip UTF-8 BOM. } const size_t size = offset - start; if (size == 0 || size == SearchString(&chars[start], size, "\"main\"")) { args.GetReturnValue().SetEmptyString(); } else { Local chars_string = String::NewFromUtf8(env->isolate(), &chars[start], String::kNormalString, size); args.GetReturnValue().Set(chars_string); } } // Used to speed up module loading. Returns 0 if the path refers to // a file, 1 when it's a directory or < 0 on error (usually -ENOENT.) // The speedup comes from not creating thousands of Stat and Error objects. static void InternalModuleStat(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsString()); node::Utf8Value path(env->isolate(), args[0]); uv_fs_t req; int rc = uv_fs_stat(env->event_loop(), &req, *path, nullptr); if (rc == 0) { const uv_stat_t* const s = static_cast(req.ptr); rc = !!(s->st_mode & S_IFDIR); } uv_fs_req_cleanup(&req); args.GetReturnValue().Set(rc); } static void Stat(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) if (args[1]->IsObject()) { ASYNC_CALL(stat, args[1], UTF8, *path) } else { SYNC_CALL(stat, *path, *path) FillStatsArray(env->fs_stats_field_array(), static_cast(SYNC_REQ.ptr)); } } static void LStat(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) if (args[1]->IsObject()) { ASYNC_CALL(lstat, args[1], UTF8, *path) } else { SYNC_CALL(lstat, *path, *path) FillStatsArray(env->fs_stats_field_array(), static_cast(SYNC_REQ.ptr)); } } static void FStat(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("fd is required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); int fd = args[0]->Int32Value(); if (args[1]->IsObject()) { ASYNC_CALL(fstat, args[1], UTF8, fd) } else { SYNC_CALL(fstat, nullptr, fd) FillStatsArray(env->fs_stats_field_array(), static_cast(SYNC_REQ.ptr)); } } static void Symlink(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("target path required"); if (len < 2) return TYPE_ERROR("src path required"); BufferValue target(env->isolate(), args[0]); ASSERT_PATH(target) BufferValue path(env->isolate(), args[1]); ASSERT_PATH(path) int flags = 0; if (args[2]->IsString()) { node::Utf8Value mode(env->isolate(), args[2]); if (strcmp(*mode, "dir") == 0) { flags |= UV_FS_SYMLINK_DIR; } else if (strcmp(*mode, "junction") == 0) { flags |= UV_FS_SYMLINK_JUNCTION; } else if (strcmp(*mode, "file") != 0) { return env->ThrowError("Unknown symlink type"); } } if (args[3]->IsObject()) { ASYNC_DEST_CALL(symlink, args[3], *path, UTF8, *target, *path, flags) } else { SYNC_DEST_CALL(symlink, *target, *path, *target, *path, flags) } } static void Link(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("src path required"); if (len < 2) return TYPE_ERROR("dest path required"); BufferValue src(env->isolate(), args[0]); ASSERT_PATH(src) BufferValue dest(env->isolate(), args[1]); ASSERT_PATH(dest) if (args[2]->IsObject()) { ASYNC_DEST_CALL(link, args[2], *dest, UTF8, *src, *dest) } else { SYNC_DEST_CALL(link, *src, *dest, *src, *dest) } } static void ReadLink(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); const int argc = args.Length(); if (argc < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) const enum encoding encoding = ParseEncoding(env->isolate(), args[1], UTF8); Local callback = Null(env->isolate()); if (argc == 3) callback = args[2]; if (callback->IsObject()) { ASYNC_CALL(readlink, callback, encoding, *path) } else { SYNC_CALL(readlink, *path, *path) const char* link_path = static_cast(SYNC_REQ.ptr); Local error; MaybeLocal rc = StringBytes::Encode(env->isolate(), link_path, encoding, &error); if (rc.IsEmpty()) { env->isolate()->ThrowException(error); return; } args.GetReturnValue().Set(rc.ToLocalChecked()); } } static void Rename(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("old path required"); if (len < 2) return TYPE_ERROR("new path required"); BufferValue old_path(env->isolate(), args[0]); ASSERT_PATH(old_path) BufferValue new_path(env->isolate(), args[1]); ASSERT_PATH(new_path) if (args[2]->IsObject()) { ASYNC_DEST_CALL(rename, args[2], *new_path, UTF8, *old_path, *new_path) } else { SYNC_DEST_CALL(rename, *old_path, *new_path, *old_path, *new_path) } } static void FTruncate(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 2) return TYPE_ERROR("fd and length are required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); int fd = args[0]->Int32Value(); // FIXME(bnoordhuis) It's questionable to reject non-ints here but still // allow implicit coercion from null or undefined to zero. Probably best // handled in lib/fs.js. Local len_v(args[1]); if (!len_v->IsUndefined() && !len_v->IsNull() && !IsInt64(len_v->NumberValue())) { return env->ThrowTypeError("Not an integer"); } const int64_t len = len_v->IntegerValue(); if (args[2]->IsObject()) { ASYNC_CALL(ftruncate, args[2], UTF8, fd, len) } else { SYNC_CALL(ftruncate, 0, fd, len) } } static void Fdatasync(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("fd is required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); int fd = args[0]->Int32Value(); if (args[1]->IsObject()) { ASYNC_CALL(fdatasync, args[1], UTF8, fd) } else { SYNC_CALL(fdatasync, 0, fd) } } static void Fsync(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("fd is required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); int fd = args[0]->Int32Value(); if (args[1]->IsObject()) { ASYNC_CALL(fsync, args[1], UTF8, fd) } else { SYNC_CALL(fsync, 0, fd) } } static void Unlink(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) if (args[1]->IsObject()) { ASYNC_CALL(unlink, args[1], UTF8, *path) } else { SYNC_CALL(unlink, *path, *path) } } static void RMDir(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) if (args[1]->IsObject()) { ASYNC_CALL(rmdir, args[1], UTF8, *path) } else { SYNC_CALL(rmdir, *path, *path) } } static void MKDir(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 2) return TYPE_ERROR("path and mode are required"); if (!args[1]->IsInt32()) return TYPE_ERROR("mode must be an integer"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) int mode = static_cast(args[1]->Int32Value()); if (args[2]->IsObject()) { ASYNC_CALL(mkdir, args[2], UTF8, *path, mode) } else { SYNC_CALL(mkdir, *path, *path, mode) } } static void RealPath(const FunctionCallbackInfo& args) { CHECK_GE(args.Length(), 2); Environment* env = Environment::GetCurrent(args); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) const enum encoding encoding = ParseEncoding(env->isolate(), args[1], UTF8); if (args[2]->IsObject()) { ASYNC_CALL(realpath, args[2], encoding, *path); } else { SYNC_CALL(realpath, *path, *path); const char* link_path = static_cast(SYNC_REQ.ptr); Local error; MaybeLocal rc = StringBytes::Encode(env->isolate(), link_path, encoding, &error); if (rc.IsEmpty()) { env->isolate()->ThrowException(error); return; } args.GetReturnValue().Set(rc.ToLocalChecked()); } } static void ReadDir(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); const int argc = args.Length(); if (argc < 1) return TYPE_ERROR("path required"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) const enum encoding encoding = ParseEncoding(env->isolate(), args[1], UTF8); Local callback = Null(env->isolate()); if (argc == 3) callback = args[2]; if (callback->IsObject()) { ASYNC_CALL(scandir, callback, encoding, *path, 0 /*flags*/) } else { SYNC_CALL(scandir, *path, *path, 0 /*flags*/) CHECK_GE(SYNC_REQ.result, 0); int r; Local names = Array::New(env->isolate(), 0); Local fn = env->push_values_to_array_function(); Local name_v[NODE_PUSH_VAL_TO_ARRAY_MAX]; size_t name_idx = 0; for (int i = 0; ; i++) { uv_dirent_t ent; r = uv_fs_scandir_next(&SYNC_REQ, &ent); if (r == UV_EOF) break; if (r != 0) return env->ThrowUVException(r, "readdir", "", *path); Local error; MaybeLocal filename = StringBytes::Encode(env->isolate(), ent.name, encoding, &error); if (filename.IsEmpty()) { env->isolate()->ThrowException(error); return; } name_v[name_idx++] = filename.ToLocalChecked(); if (name_idx >= arraysize(name_v)) { fn->Call(env->context(), names, name_idx, name_v) .ToLocalChecked(); name_idx = 0; } } if (name_idx > 0) { fn->Call(env->context(), names, name_idx, name_v).ToLocalChecked(); } args.GetReturnValue().Set(names); } } static void Open(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("path required"); if (len < 2) return TYPE_ERROR("flags required"); if (len < 3) return TYPE_ERROR("mode required"); if (!args[1]->IsInt32()) return TYPE_ERROR("flags must be an int"); if (!args[2]->IsInt32()) return TYPE_ERROR("mode must be an int"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) int flags = args[1]->Int32Value(); int mode = static_cast(args[2]->Int32Value()); if (args[3]->IsObject()) { ASYNC_CALL(open, args[3], UTF8, *path, flags, mode) } else { SYNC_CALL(open, *path, *path, flags, mode) args.GetReturnValue().Set(SYNC_RESULT); } } static void CopyFile(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsString()) return TYPE_ERROR("src must be a string"); if (!args[1]->IsString()) return TYPE_ERROR("dest must be a string"); if (!args[2]->IsInt32()) return TYPE_ERROR("flags must be an int"); BufferValue src(env->isolate(), args[0]); ASSERT_PATH(src) BufferValue dest(env->isolate(), args[1]); ASSERT_PATH(dest) int flags = args[2]->Int32Value(); if (args[3]->IsObject()) { ASYNC_DEST_CALL(copyfile, args[3], *dest, UTF8, *src, *dest, flags) } else { SYNC_DEST_CALL(copyfile, *src, *dest, *src, *dest, flags) } } // Wrapper for write(2). // // bytesWritten = write(fd, buffer, offset, length, position, callback) // 0 fd integer. file descriptor // 1 buffer the data to write // 2 offset where in the buffer to start from // 3 length how much to write // 4 position if integer, position to write at in the file. // if null, write from the current position static void WriteBuffer(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsInt32()) return env->ThrowTypeError("First argument must be file descriptor"); CHECK(Buffer::HasInstance(args[1])); int fd = args[0]->Int32Value(); Local obj = args[1].As(); const char* buf = Buffer::Data(obj); size_t buffer_length = Buffer::Length(obj); size_t off = args[2]->Uint32Value(); size_t len = args[3]->Uint32Value(); int64_t pos = GET_OFFSET(args[4]); Local req = args[5]; if (off > buffer_length) return env->ThrowRangeError("offset out of bounds"); if (len > buffer_length) return env->ThrowRangeError("length out of bounds"); if (off + len < off) return env->ThrowRangeError("off + len overflow"); if (!Buffer::IsWithinBounds(off, len, buffer_length)) return env->ThrowRangeError("off + len > buffer.length"); buf += off; uv_buf_t uvbuf = uv_buf_init(const_cast(buf), len); if (req->IsObject()) { ASYNC_CALL(write, req, UTF8, fd, &uvbuf, 1, pos) return; } SYNC_CALL(write, nullptr, fd, &uvbuf, 1, pos) args.GetReturnValue().Set(SYNC_RESULT); } // Wrapper for writev(2). // // bytesWritten = writev(fd, chunks, position, callback) // 0 fd integer. file descriptor // 1 chunks array of buffers to write // 2 position if integer, position to write at in the file. // if null, write from the current position static void WriteBuffers(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK(args[0]->IsInt32()); CHECK(args[1]->IsArray()); int fd = args[0]->Int32Value(); Local chunks = args[1].As(); int64_t pos = GET_OFFSET(args[2]); Local req = args[3]; MaybeStackBuffer iovs(chunks->Length()); for (uint32_t i = 0; i < iovs.length(); i++) { Local chunk = chunks->Get(i); if (!Buffer::HasInstance(chunk)) return env->ThrowTypeError("Array elements all need to be buffers"); iovs[i] = uv_buf_init(Buffer::Data(chunk), Buffer::Length(chunk)); } if (req->IsObject()) { ASYNC_CALL(write, req, UTF8, fd, *iovs, iovs.length(), pos) return; } SYNC_CALL(write, nullptr, fd, *iovs, iovs.length(), pos) args.GetReturnValue().Set(SYNC_RESULT); } // Wrapper for write(2). // // bytesWritten = write(fd, string, position, enc, callback) // 0 fd integer. file descriptor // 1 string non-buffer values are converted to strings // 2 position if integer, position to write at in the file. // if null, write from the current position // 3 enc encoding of string static void WriteString(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (!args[0]->IsInt32()) return env->ThrowTypeError("First argument must be file descriptor"); Local req; Local string = args[1]; int fd = args[0]->Int32Value(); char* buf = nullptr; int64_t pos; size_t len; FSReqWrap::Ownership ownership = FSReqWrap::COPY; // will assign buf and len if string was external if (!StringBytes::GetExternalParts(string, const_cast(&buf), &len)) { enum encoding enc = ParseEncoding(env->isolate(), args[3], UTF8); len = StringBytes::StorageSize(env->isolate(), string, enc); buf = new char[len]; // StorageSize may return too large a char, so correct the actual length // by the write size len = StringBytes::Write(env->isolate(), buf, len, args[1], enc); ownership = FSReqWrap::MOVE; } pos = GET_OFFSET(args[2]); req = args[4]; uv_buf_t uvbuf = uv_buf_init(const_cast(buf), len); if (!req->IsObject()) { // SYNC_CALL returns on error. Make sure to always free the memory. struct Delete { inline explicit Delete(char* pointer) : pointer_(pointer) {} inline ~Delete() { delete[] pointer_; } char* const pointer_; }; Delete delete_on_return(ownership == FSReqWrap::MOVE ? buf : nullptr); SYNC_CALL(write, nullptr, fd, &uvbuf, 1, pos) return args.GetReturnValue().Set(SYNC_RESULT); } FSReqWrap* req_wrap = FSReqWrap::New(env, req.As(), "write", buf, UTF8, ownership); int err = uv_fs_write(env->event_loop(), req_wrap->req(), fd, &uvbuf, 1, pos, After); req_wrap->Dispatched(); if (err < 0) { uv_fs_t* uv_req = req_wrap->req(); uv_req->result = err; uv_req->path = nullptr; After(uv_req); return; } return args.GetReturnValue().Set(req_wrap->persistent()); } /* * Wrapper for read(2). * * bytesRead = fs.read(fd, buffer, offset, length, position) * * 0 fd integer. file descriptor * 1 buffer instance of Buffer * 2 offset integer. offset to start reading into inside buffer * 3 length integer. length to read * 4 position file position - null for current position * */ static void Read(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 2) return TYPE_ERROR("fd and buffer are required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); if (!Buffer::HasInstance(args[1])) return TYPE_ERROR("Second argument needs to be a buffer"); int fd = args[0]->Int32Value(); Local req; size_t len; int64_t pos; char * buf = nullptr; Local buffer_obj = args[1]->ToObject(env->isolate()); char *buffer_data = Buffer::Data(buffer_obj); size_t buffer_length = Buffer::Length(buffer_obj); size_t off = args[2]->Int32Value(); if (off >= buffer_length) { return env->ThrowError("Offset is out of bounds"); } len = args[3]->Int32Value(); if (!Buffer::IsWithinBounds(off, len, buffer_length)) return env->ThrowRangeError("Length extends beyond buffer"); pos = GET_OFFSET(args[4]); buf = buffer_data + off; uv_buf_t uvbuf = uv_buf_init(const_cast(buf), len); req = args[5]; if (req->IsObject()) { ASYNC_CALL(read, req, UTF8, fd, &uvbuf, 1, pos); } else { SYNC_CALL(read, 0, fd, &uvbuf, 1, pos) args.GetReturnValue().Set(SYNC_RESULT); } } /* fs.chmod(path, mode); * Wrapper for chmod(1) / EIO_CHMOD */ static void Chmod(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 2) return TYPE_ERROR("path and mode are required"); if (!args[1]->IsInt32()) return TYPE_ERROR("mode must be an integer"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) int mode = static_cast(args[1]->Int32Value()); if (args[2]->IsObject()) { ASYNC_CALL(chmod, args[2], UTF8, *path, mode); } else { SYNC_CALL(chmod, *path, *path, mode); } } /* fs.fchmod(fd, mode); * Wrapper for fchmod(1) / EIO_FCHMOD */ static void FChmod(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); if (args.Length() < 2) return TYPE_ERROR("fd and mode are required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be a file descriptor"); if (!args[1]->IsInt32()) return TYPE_ERROR("mode must be an integer"); int fd = args[0]->Int32Value(); int mode = static_cast(args[1]->Int32Value()); if (args[2]->IsObject()) { ASYNC_CALL(fchmod, args[2], UTF8, fd, mode); } else { SYNC_CALL(fchmod, 0, fd, mode); } } /* fs.chown(path, uid, gid); * Wrapper for chown(1) / EIO_CHOWN */ static void Chown(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("path required"); if (len < 2) return TYPE_ERROR("uid required"); if (len < 3) return TYPE_ERROR("gid required"); if (!args[1]->IsUint32()) return TYPE_ERROR("uid must be an unsigned int"); if (!args[2]->IsUint32()) return TYPE_ERROR("gid must be an unsigned int"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) uv_uid_t uid = static_cast(args[1]->Uint32Value()); uv_gid_t gid = static_cast(args[2]->Uint32Value()); if (args[3]->IsObject()) { ASYNC_CALL(chown, args[3], UTF8, *path, uid, gid); } else { SYNC_CALL(chown, *path, *path, uid, gid); } } /* fs.fchown(fd, uid, gid); * Wrapper for fchown(1) / EIO_FCHOWN */ static void FChown(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("fd required"); if (len < 2) return TYPE_ERROR("uid required"); if (len < 3) return TYPE_ERROR("gid required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be an int"); if (!args[1]->IsUint32()) return TYPE_ERROR("uid must be an unsigned int"); if (!args[2]->IsUint32()) return TYPE_ERROR("gid must be an unsigned int"); int fd = args[0]->Int32Value(); uv_uid_t uid = static_cast(args[1]->Uint32Value()); uv_gid_t gid = static_cast(args[2]->Uint32Value()); if (args[3]->IsObject()) { ASYNC_CALL(fchown, args[3], UTF8, fd, uid, gid); } else { SYNC_CALL(fchown, 0, fd, uid, gid); } } static void UTimes(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("path required"); if (len < 2) return TYPE_ERROR("atime required"); if (len < 3) return TYPE_ERROR("mtime required"); if (!args[1]->IsNumber()) return TYPE_ERROR("atime must be a number"); if (!args[2]->IsNumber()) return TYPE_ERROR("mtime must be a number"); BufferValue path(env->isolate(), args[0]); ASSERT_PATH(path) const double atime = static_cast(args[1]->NumberValue()); const double mtime = static_cast(args[2]->NumberValue()); if (args[3]->IsObject()) { ASYNC_CALL(utime, args[3], UTF8, *path, atime, mtime); } else { SYNC_CALL(utime, *path, *path, atime, mtime); } } static void FUTimes(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); int len = args.Length(); if (len < 1) return TYPE_ERROR("fd required"); if (len < 2) return TYPE_ERROR("atime required"); if (len < 3) return TYPE_ERROR("mtime required"); if (!args[0]->IsInt32()) return TYPE_ERROR("fd must be an int"); if (!args[1]->IsNumber()) return TYPE_ERROR("atime must be a number"); if (!args[2]->IsNumber()) return TYPE_ERROR("mtime must be a number"); const int fd = args[0]->Int32Value(); const double atime = static_cast(args[1]->NumberValue()); const double mtime = static_cast(args[2]->NumberValue()); if (args[3]->IsObject()) { ASYNC_CALL(futime, args[3], UTF8, fd, atime, mtime); } else { SYNC_CALL(futime, 0, fd, atime, mtime); } } static void Mkdtemp(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); CHECK_GE(args.Length(), 2); BufferValue tmpl(env->isolate(), args[0]); if (*tmpl == nullptr) return TYPE_ERROR("template must be a string or Buffer"); const enum encoding encoding = ParseEncoding(env->isolate(), args[1], UTF8); if (args[2]->IsObject()) { ASYNC_CALL(mkdtemp, args[2], encoding, *tmpl); } else { SYNC_CALL(mkdtemp, *tmpl, *tmpl); const char* path = static_cast(SYNC_REQ.path); Local error; MaybeLocal rc = StringBytes::Encode(env->isolate(), path, encoding, &error); if (rc.IsEmpty()) { env->isolate()->ThrowException(error); return; } args.GetReturnValue().Set(rc.ToLocalChecked()); } } void GetStatValues(const FunctionCallbackInfo& args) { Environment* env = Environment::GetCurrent(args); double* fields = env->fs_stats_field_array(); if (fields == nullptr) { // stat fields contains twice the number of entries because `fs.StatWatcher` // needs room to store data for *two* `fs.Stats` instances. fields = new double[2 * 14]; env->set_fs_stats_field_array(fields); } Local ab = ArrayBuffer::New(env->isolate(), fields, sizeof(double) * 2 * 14); Local fields_array = Float64Array::New(ab, 0, 2 * 14); args.GetReturnValue().Set(fields_array); } void InitFs(Local target, Local unused, Local context, void* priv) { Environment* env = Environment::GetCurrent(context); env->SetMethod(target, "access", Access); env->SetMethod(target, "close", Close); env->SetMethod(target, "open", Open); env->SetMethod(target, "read", Read); env->SetMethod(target, "fdatasync", Fdatasync); env->SetMethod(target, "fsync", Fsync); env->SetMethod(target, "rename", Rename); env->SetMethod(target, "ftruncate", FTruncate); env->SetMethod(target, "rmdir", RMDir); env->SetMethod(target, "mkdir", MKDir); env->SetMethod(target, "readdir", ReadDir); env->SetMethod(target, "internalModuleReadJSON", InternalModuleReadJSON); env->SetMethod(target, "internalModuleStat", InternalModuleStat); env->SetMethod(target, "stat", Stat); env->SetMethod(target, "lstat", LStat); env->SetMethod(target, "fstat", FStat); env->SetMethod(target, "link", Link); env->SetMethod(target, "symlink", Symlink); env->SetMethod(target, "readlink", ReadLink); env->SetMethod(target, "unlink", Unlink); env->SetMethod(target, "writeBuffer", WriteBuffer); env->SetMethod(target, "writeBuffers", WriteBuffers); env->SetMethod(target, "writeString", WriteString); env->SetMethod(target, "realpath", RealPath); env->SetMethod(target, "copyFile", CopyFile); env->SetMethod(target, "chmod", Chmod); env->SetMethod(target, "fchmod", FChmod); // env->SetMethod(target, "lchmod", LChmod); env->SetMethod(target, "chown", Chown); env->SetMethod(target, "fchown", FChown); // env->SetMethod(target, "lchown", LChown); env->SetMethod(target, "utimes", UTimes); env->SetMethod(target, "futimes", FUTimes); env->SetMethod(target, "mkdtemp", Mkdtemp); env->SetMethod(target, "getStatValues", GetStatValues); StatWatcher::Initialize(env, target); // Create FunctionTemplate for FSReqWrap Local fst = FunctionTemplate::New(env->isolate(), NewFSReqWrap); fst->InstanceTemplate()->SetInternalFieldCount(1); AsyncWrap::AddWrapMethods(env, fst); Local wrapString = FIXED_ONE_BYTE_STRING(env->isolate(), "FSReqWrap"); fst->SetClassName(wrapString); target->Set(wrapString, fst->GetFunction()); } } // end namespace node NODE_BUILTIN_MODULE_CONTEXT_AWARE(fs, node::InitFs)