/* * Copyright (c) 2021-2022 Huawei Device Co., Ltd. * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H #define COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H #include #include #include #include #include #include "base_async_work.h" #include "base_context.h" #include "napi/native_api.h" #include "napi/native_common.h" #include "napi_utils.h" #include "netstack_log.h" namespace OHOS::NetStack { class EventManager; struct EventManagerWrapper; } // namespace OHOS::NetStack #define MAX_PARAM_NUM 64 namespace OHOS::NetStack::ModuleTemplate { typedef void (*Finalizer)(napi_env, void *data, void *); template napi_value InterfaceWithManagerWrapper(napi_env env, napi_callback_info info, const std::string &asyncWorkName, bool (*Work)(napi_env, napi_value, Context *), AsyncWorkExecutor executor, AsyncWorkCallback callback) { NETSTACK_LOGI("js invoke %{public}s", asyncWorkName.c_str()); static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); EventManagerWrapper *wrapper = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&wrapper)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, nullptr); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } if (wrapper) { context->SetSharedManager(wrapper->sharedManager); } context->ParseParams(params, paramsCount); if (context->IsNeedThrowException()) { // only api9 or later need throw exception. napi_throw_error(env, std::to_string(context->GetErrorCode()).c_str(), context->GetErrorMessage().c_str()); delete context; context = nullptr; return NapiUtils::GetUndefined(env); } if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } context->CreateReference(thisVal); context->CreateAsyncWork(asyncWorkName, executor, callback); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s create promise", asyncWorkName.c_str()); return context->CreatePromise(); } return NapiUtils::GetUndefined(env); } template napi_value InterfaceWithSharedManager(napi_env env, napi_callback_info info, const std::string &asyncWorkName, bool (*Work)(napi_env, napi_value, Context *), AsyncWorkExecutor executor, AsyncWorkCallback callback) { NETSTACK_LOGI("js invoke %{public}s", asyncWorkName.c_str()); static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); std::shared_ptr *sharedManager = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&sharedManager)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, nullptr); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } if (sharedManager) { context->SetSharedManager(*sharedManager); } context->ParseParams(params, paramsCount); if (context->IsNeedThrowException()) { // only api9 or later need throw exception. napi_throw_error(env, std::to_string(context->GetErrorCode()).c_str(), context->GetErrorMessage().c_str()); delete context; context = nullptr; return NapiUtils::GetUndefined(env); } if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } context->CreateReference(thisVal); context->CreateAsyncWork(asyncWorkName, executor, callback); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s create promise", asyncWorkName.c_str()); return context->CreatePromise(); } return NapiUtils::GetUndefined(env); } template napi_value InterfaceWithOutAsyncWorkWithManagerWrapper(napi_env env, napi_callback_info info, bool (*Work)(napi_env, napi_value, Context *), const std::string &asyncWorkName, AsyncWorkExecutor executor, AsyncWorkCallback callback) { static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); EventManagerWrapper *wrapper = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&wrapper)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, nullptr); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } if (wrapper) { context->SetSharedManager(wrapper->sharedManager); } context->ParseParams(params, paramsCount); napi_value ret = NapiUtils::GetUndefined(env); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s is invoked in promise mode", asyncWorkName.c_str()); ret = context->CreatePromise(); } else { NETSTACK_LOGD("%{public}s is invoked in callback mode", asyncWorkName.c_str()); } context->CreateReference(thisVal); if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } if (!context->IsParseOK() || context->IsPermissionDenied() || context->IsNoAllowedHost() || context->GetSharedManager()->IsEventDestroy()) { context->CreateAsyncWork(asyncWorkName, executor, callback); } return ret; } template napi_value InterfaceWithOutAsyncWorkWithSharedManager(napi_env env, napi_callback_info info, bool (*Work)(napi_env, napi_value, Context *), const std::string &asyncWorkName, AsyncWorkExecutor executor, AsyncWorkCallback callback) { static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); std::shared_ptr *sharedManager = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&sharedManager)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, nullptr); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } if (sharedManager) { context->SetSharedManager(*sharedManager); } context->ParseParams(params, paramsCount); napi_value ret = NapiUtils::GetUndefined(env); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s is invoked in promise mode", asyncWorkName.c_str()); ret = context->CreatePromise(); } else { NETSTACK_LOGD("%{public}s is invoked in callback mode", asyncWorkName.c_str()); } context->CreateReference(thisVal); if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } if (!context->IsParseOK() || context->IsPermissionDenied() || context->IsNoAllowedHost() || context->GetSharedManager()->IsEventDestroy()) { context->CreateAsyncWork(asyncWorkName, executor, callback); } return ret; } template napi_value Interface(napi_env env, napi_callback_info info, const std::string &asyncWorkName, bool (*Work)(napi_env, napi_value, Context *), AsyncWorkExecutor executor, AsyncWorkCallback callback) { NETSTACK_LOGI("js invoke %{public}s", asyncWorkName.c_str()); static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); EventManager *manager = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&manager)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, manager); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } context->ParseParams(params, paramsCount); if (context->IsNeedThrowException()) { // only api9 or later need throw exception. napi_throw_error(env, std::to_string(context->GetErrorCode()).c_str(), context->GetErrorMessage().c_str()); delete context; context = nullptr; return NapiUtils::GetUndefined(env); } if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } context->CreateReference(thisVal); context->CreateAsyncWork(asyncWorkName, executor, callback); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s create promise", asyncWorkName.c_str()); return context->CreatePromise(); } return NapiUtils::GetUndefined(env); } template napi_value InterfaceWithOutAsyncWork(napi_env env, napi_callback_info info, bool (*Work)(napi_env, napi_value, Context *), const std::string &asyncWorkName, AsyncWorkExecutor executor, AsyncWorkCallback callback) { static_assert(std::is_base_of::value); napi_value thisVal = nullptr; size_t paramsCount = MAX_PARAM_NUM; napi_value params[MAX_PARAM_NUM] = {nullptr}; NAPI_CALL(env, napi_get_cb_info(env, info, ¶msCount, params, &thisVal, nullptr)); EventManager *manager = nullptr; auto napi_ret = napi_unwrap(env, thisVal, reinterpret_cast(&manager)); if (napi_ret != napi_ok) { NETSTACK_LOGE("get event manager in napi_unwrap failed, napi_ret is %{public}d", napi_ret); return NapiUtils::GetUndefined(env); } auto context = new (std::nothrow) Context(env, manager); if (!context) { NETSTACK_LOGE("new context is nullptr"); return NapiUtils::GetUndefined(env); } context->ParseParams(params, paramsCount); napi_value ret = NapiUtils::GetUndefined(env); if (NapiUtils::GetValueType(env, context->GetCallback()) != napi_function && context->IsNeedPromise()) { NETSTACK_LOGD("%{public}s is invoked in promise mode", asyncWorkName.c_str()); ret = context->CreatePromise(); } else { NETSTACK_LOGD("%{public}s is invoked in callback mode", asyncWorkName.c_str()); } context->CreateReference(thisVal); if (Work != nullptr) { if (!Work(env, thisVal, context)) { NETSTACK_LOGE("work failed error code = %{public}d", context->GetErrorCode()); } } if (!context->IsParseOK() || context->IsPermissionDenied() || context->IsNoAllowedHost() || context->GetManager()->IsEventDestroy()) { context->CreateAsyncWork(asyncWorkName, executor, callback); } return ret; } napi_value On(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value Once(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value Off(napi_env env, napi_callback_info info, const std::initializer_list &events); void DefineClass(napi_env env, napi_value exports, const std::initializer_list &properties, const std::string &className); napi_value NewInstance(napi_env env, napi_callback_info info, const std::string &className, Finalizer finalizer); napi_value NewInstanceNoManager(napi_env env, napi_callback_info info, const std::string &name, Finalizer finalizer); napi_value NewInstanceWithSharedManager(napi_env env, napi_callback_info info, const std::string &className, Finalizer finalizer); napi_value NewInstanceWithManagerWrapper(napi_env env, napi_callback_info info, const std::string &className, Finalizer finalizer); napi_value OnSharedManager(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value OnceSharedManager(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value OffSharedManager(napi_env env, napi_callback_info info, const std::initializer_list &events); napi_value OnManagerWrapper(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value OnceManagerWrapper(napi_env env, napi_callback_info info, const std::initializer_list &events, bool asyncCallback); napi_value OffManagerWrapper(napi_env env, napi_callback_info info, const std::initializer_list &events); } // namespace OHOS::NetStack::ModuleTemplate #endif /* COMMUNICATIONNETSTACK_NETSTACK_MODULE_TEMPLATE_H */