#include "debug_utils-inl.h" #include "env-inl.h" #include "node_errors.h" #include "node_external_reference.h" #include "node_i18n.h" #include "node_process-inl.h" #include // tzset(), _tzset() namespace node { using v8::Array; using v8::Boolean; using v8::Context; using v8::DontDelete; using v8::DontEnum; using v8::FunctionTemplate; using v8::HandleScope; using v8::Integer; using v8::Isolate; using v8::Just; using v8::Local; using v8::Maybe; using v8::MaybeLocal; using v8::Name; using v8::NamedPropertyHandlerConfiguration; using v8::NewStringType; using v8::Nothing; using v8::Object; using v8::ObjectTemplate; using v8::PropertyCallbackInfo; using v8::PropertyDescriptor; using v8::PropertyHandlerFlags; using v8::ReadOnly; using v8::String; using v8::Value; class RealEnvStore final : public KVStore { public: MaybeLocal Get(Isolate* isolate, Local key) const override; Maybe Get(const char* key) const override; void Set(Isolate* isolate, Local key, Local value) override; int32_t Query(Isolate* isolate, Local key) const override; int32_t Query(const char* key) const override; void Delete(Isolate* isolate, Local key) override; Local Enumerate(Isolate* isolate) const override; }; class MapKVStore final : public KVStore { public: MaybeLocal Get(Isolate* isolate, Local key) const override; Maybe Get(const char* key) const override; void Set(Isolate* isolate, Local key, Local value) override; int32_t Query(Isolate* isolate, Local key) const override; int32_t Query(const char* key) const override; void Delete(Isolate* isolate, Local key) override; Local Enumerate(Isolate* isolate) const override; std::shared_ptr Clone(Isolate* isolate) const override; MapKVStore() = default; MapKVStore(const MapKVStore& other) : KVStore(), map_(other.map_) {} private: mutable Mutex mutex_; std::unordered_map map_; }; namespace per_process { Mutex env_var_mutex; std::shared_ptr system_environment = std::make_shared(); } // namespace per_process template void DateTimeConfigurationChangeNotification( Isolate* isolate, const T& key, const char* val = nullptr) { if (key.length() == 2 && key[0] == 'T' && key[1] == 'Z') { #ifdef __POSIX__ tzset(); isolate->DateTimeConfigurationChangeNotification( Isolate::TimeZoneDetection::kRedetect); #else _tzset(); # if defined(NODE_HAVE_I18N_SUPPORT) isolate->DateTimeConfigurationChangeNotification( Isolate::TimeZoneDetection::kSkip); // On windows, the TZ environment is not supported out of the box. // By default, v8 will only be able to detect the system configured // timezone. This supports using the TZ environment variable to set // the default timezone instead. if (val != nullptr) i18n::SetDefaultTimeZone(val); # else isolate->DateTimeConfigurationChangeNotification( Isolate::TimeZoneDetection::kRedetect); # endif #endif } } Maybe RealEnvStore::Get(const char* key) const { Mutex::ScopedLock lock(per_process::env_var_mutex); size_t init_sz = 256; MaybeStackBuffer val; int ret = uv_os_getenv(key, *val, &init_sz); if (ret == UV_ENOBUFS) { // Buffer is not large enough, reallocate to the updated init_sz // and fetch env value again. val.AllocateSufficientStorage(init_sz); ret = uv_os_getenv(key, *val, &init_sz); } if (ret >= 0) { // Env key value fetch success. return Just(std::string(*val, init_sz)); } return Nothing(); } MaybeLocal RealEnvStore::Get(Isolate* isolate, Local property) const { node::Utf8Value key(isolate, property); Maybe value = Get(*key); if (value.IsJust()) { std::string val = value.FromJust(); return String::NewFromUtf8( isolate, val.data(), NewStringType::kNormal, val.size()); } return MaybeLocal(); } void RealEnvStore::Set(Isolate* isolate, Local property, Local value) { Mutex::ScopedLock lock(per_process::env_var_mutex); node::Utf8Value key(isolate, property); node::Utf8Value val(isolate, value); #ifdef _WIN32 if (key.length() > 0 && key[0] == '=') return; #endif uv_os_setenv(*key, *val); DateTimeConfigurationChangeNotification(isolate, key, *val); } int32_t RealEnvStore::Query(const char* key) const { Mutex::ScopedLock lock(per_process::env_var_mutex); char val[2]; size_t init_sz = sizeof(val); int ret = uv_os_getenv(key, val, &init_sz); if (ret == UV_ENOENT) { return -1; } #ifdef _WIN32 if (key[0] == '=') { return static_cast(ReadOnly) | static_cast(DontDelete) | static_cast(DontEnum); } #endif return 0; } int32_t RealEnvStore::Query(Isolate* isolate, Local property) const { node::Utf8Value key(isolate, property); return Query(*key); } void RealEnvStore::Delete(Isolate* isolate, Local property) { Mutex::ScopedLock lock(per_process::env_var_mutex); node::Utf8Value key(isolate, property); uv_os_unsetenv(*key); DateTimeConfigurationChangeNotification(isolate, key); } Local RealEnvStore::Enumerate(Isolate* isolate) const { Mutex::ScopedLock lock(per_process::env_var_mutex); uv_env_item_t* items; int count; auto cleanup = OnScopeLeave([&]() { uv_os_free_environ(items, count); }); CHECK_EQ(uv_os_environ(&items, &count), 0); MaybeStackBuffer, 256> env_v(count); int env_v_index = 0; for (int i = 0; i < count; i++) { #ifdef _WIN32 // If the key starts with '=' it is a hidden environment variable. if (items[i].name[0] == '=') continue; #endif MaybeLocal str = String::NewFromUtf8(isolate, items[i].name); if (str.IsEmpty()) { isolate->ThrowException(ERR_STRING_TOO_LONG(isolate)); return Local(); } env_v[env_v_index++] = str.ToLocalChecked(); } return Array::New(isolate, env_v.out(), env_v_index); } std::shared_ptr KVStore::Clone(Isolate* isolate) const { HandleScope handle_scope(isolate); Local context = isolate->GetCurrentContext(); std::shared_ptr copy = KVStore::CreateMapKVStore(); Local keys = Enumerate(isolate); uint32_t keys_length = keys->Length(); for (uint32_t i = 0; i < keys_length; i++) { Local key = keys->Get(context, i).ToLocalChecked(); CHECK(key->IsString()); copy->Set(isolate, key.As(), Get(isolate, key.As()).ToLocalChecked()); } return copy; } Maybe MapKVStore::Get(const char* key) const { Mutex::ScopedLock lock(mutex_); auto it = map_.find(key); return it == map_.end() ? Nothing() : Just(it->second); } MaybeLocal MapKVStore::Get(Isolate* isolate, Local key) const { Utf8Value str(isolate, key); Maybe value = Get(*str); if (value.IsNothing()) return Local(); std::string val = value.FromJust(); return String::NewFromUtf8( isolate, val.data(), NewStringType::kNormal, val.size()); } void MapKVStore::Set(Isolate* isolate, Local key, Local value) { Mutex::ScopedLock lock(mutex_); Utf8Value key_str(isolate, key); Utf8Value value_str(isolate, value); if (*key_str != nullptr && key_str.length() > 0 && *value_str != nullptr) { map_[std::string(*key_str, key_str.length())] = std::string(*value_str, value_str.length()); } } int32_t MapKVStore::Query(const char* key) const { Mutex::ScopedLock lock(mutex_); return map_.find(key) == map_.end() ? -1 : 0; } int32_t MapKVStore::Query(Isolate* isolate, Local key) const { Utf8Value str(isolate, key); return Query(*str); } void MapKVStore::Delete(Isolate* isolate, Local key) { Mutex::ScopedLock lock(mutex_); Utf8Value str(isolate, key); map_.erase(std::string(*str, str.length())); } Local MapKVStore::Enumerate(Isolate* isolate) const { Mutex::ScopedLock lock(mutex_); std::vector> values; values.reserve(map_.size()); for (const auto& pair : map_) { values.emplace_back( String::NewFromUtf8(isolate, pair.first.data(), NewStringType::kNormal, pair.first.size()) .ToLocalChecked()); } return Array::New(isolate, values.data(), values.size()); } std::shared_ptr MapKVStore::Clone(Isolate* isolate) const { return std::make_shared(*this); } std::shared_ptr KVStore::CreateMapKVStore() { return std::make_shared(); } Maybe KVStore::AssignFromObject(Local context, Local entries) { Isolate* isolate = context->GetIsolate(); HandleScope handle_scope(isolate); Local keys; if (!entries->GetOwnPropertyNames(context).ToLocal(&keys)) return Nothing(); uint32_t keys_length = keys->Length(); for (uint32_t i = 0; i < keys_length; i++) { Local key; if (!keys->Get(context, i).ToLocal(&key)) return Nothing(); if (!key->IsString()) continue; Local value; Local value_string; if (!entries->Get(context, key).ToLocal(&value) || !value->ToString(context).ToLocal(&value_string)) { return Nothing(); } Set(isolate, key.As(), value_string); } return Just(true); } // TODO(bnoordhuis) Not super efficient but called infrequently. Not worth // the trouble yet of specializing for RealEnvStore and MapKVStore. Maybe KVStore::AssignToObject(v8::Isolate* isolate, v8::Local context, v8::Local object) { HandleScope scope(isolate); Local keys = Enumerate(isolate); uint32_t keys_length = keys->Length(); for (uint32_t i = 0; i < keys_length; i++) { Local key; Local value; bool ok = keys->Get(context, i).ToLocal(&key); ok = ok && key->IsString(); ok = ok && Get(isolate, key.As()).ToLocal(&value); ok = ok && object->Set(context, key, value).To(&ok); if (!ok) return Nothing(); } return Just(true); } static void EnvGetter(Local property, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); CHECK(env->has_run_bootstrapping_code()); if (property->IsSymbol()) { return info.GetReturnValue().SetUndefined(); } CHECK(property->IsString()); MaybeLocal value_string = env->env_vars()->Get(env->isolate(), property.As()); if (!value_string.IsEmpty()) { info.GetReturnValue().Set(value_string.ToLocalChecked()); } } static void EnvSetter(Local property, Local value, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); CHECK(env->has_run_bootstrapping_code()); // calling env->EmitProcessEnvWarning() sets a variable indicating that // warnings have been emitted. It should be called last after other // conditions leading to a warning have been met. if (env->options()->pending_deprecation && !value->IsString() && !value->IsNumber() && !value->IsBoolean() && env->EmitProcessEnvWarning()) { if (ProcessEmitDeprecationWarning( env, "Assigning any value other than a string, number, or boolean to a " "process.env property is deprecated. Please make sure to convert " "the " "value to a string before setting process.env with it.", "DEP0104") .IsNothing()) return; } Local key; Local value_string; if (!property->ToString(env->context()).ToLocal(&key) || !value->ToString(env->context()).ToLocal(&value_string)) { return; } env->env_vars()->Set(env->isolate(), key, value_string); // Whether it worked or not, always return value. info.GetReturnValue().Set(value); } static void EnvQuery(Local property, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); CHECK(env->has_run_bootstrapping_code()); if (property->IsString()) { int32_t rc = env->env_vars()->Query(env->isolate(), property.As()); if (rc != -1) info.GetReturnValue().Set(rc); } } static void EnvDeleter(Local property, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); CHECK(env->has_run_bootstrapping_code()); if (property->IsString()) { env->env_vars()->Delete(env->isolate(), property.As()); } // process.env never has non-configurable properties, so always // return true like the tc39 delete operator. info.GetReturnValue().Set(true); } static void EnvEnumerator(const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); CHECK(env->has_run_bootstrapping_code()); info.GetReturnValue().Set( env->env_vars()->Enumerate(env->isolate())); } static void EnvDefiner(Local property, const PropertyDescriptor& desc, const PropertyCallbackInfo& info) { Environment* env = Environment::GetCurrent(info); if (desc.has_value()) { if (!desc.has_writable() || !desc.has_enumerable() || !desc.has_configurable()) { THROW_ERR_INVALID_OBJECT_DEFINE_PROPERTY(env, "'process.env' only accepts a " "configurable, writable," " and enumerable " "data descriptor"); } else if (!desc.configurable() || !desc.enumerable() || !desc.writable()) { THROW_ERR_INVALID_OBJECT_DEFINE_PROPERTY(env, "'process.env' only accepts a " "configurable, writable," " and enumerable " "data descriptor"); } else { return EnvSetter(property, desc.value(), info); } } else if (desc.has_get() || desc.has_set()) { // we don't accept a getter/setter in 'process.env' THROW_ERR_INVALID_OBJECT_DEFINE_PROPERTY(env, "'process.env' does not accept an" " accessor(getter/setter)" " descriptor"); } else { THROW_ERR_INVALID_OBJECT_DEFINE_PROPERTY(env, "'process.env' only accepts a " "configurable, writable," " and enumerable " "data descriptor"); } } void CreateEnvProxyTemplate(Isolate* isolate, IsolateData* isolate_data) { HandleScope scope(isolate); if (!isolate_data->env_proxy_template().IsEmpty()) return; Local env_proxy_ctor_template = FunctionTemplate::New(isolate); Local env_proxy_template = ObjectTemplate::New(isolate, env_proxy_ctor_template); env_proxy_template->SetHandler(NamedPropertyHandlerConfiguration( EnvGetter, EnvSetter, EnvQuery, EnvDeleter, EnvEnumerator, EnvDefiner, nullptr, Local(), PropertyHandlerFlags::kHasNoSideEffect)); isolate_data->set_env_proxy_template(env_proxy_template); isolate_data->set_env_proxy_ctor_template(env_proxy_ctor_template); } void RegisterEnvVarExternalReferences(ExternalReferenceRegistry* registry) { registry->Register(EnvGetter); registry->Register(EnvSetter); registry->Register(EnvQuery); registry->Register(EnvDeleter); registry->Register(EnvEnumerator); registry->Register(EnvDefiner); } } // namespace node NODE_BINDING_EXTERNAL_REFERENCE(env_var, node::RegisterEnvVarExternalReferences)