1 /*
2 * Copyright (c) 2022 Huawei Device Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16 #include "web_errors.h"
17 #include <string>
18 #include <unordered_map>
19 #include <cstdarg>
20 #include "securec.h"
21
22 namespace {
23 // error message
24 const std::string PARAM_CHECK_ERROR_MSG = "Invalid input parameter";
25 const std::string CAPABILITY_NOT_SUPPORTED_ERROR_MSG = "Capability not supported";
26 const std::string INIT_ERROR_MSG = "Init error. The WebviewController must be associated with a Web component";
27 const std::string INVALID_URL_MSG = "URL error. Possible causes:1.No valid cookie found for the specified URL. "
28 "2.The webpage corresponding to the URL is invalid, or the URL length exceeds 2048.";
29 const std::string INVALID_RESOURCE_MSG = "Invalid resource path or file type";
30 const std::string FUNCTION_NOT_ENABLE_MSG = "Function not enabled.";
31 const std::string INVALID_COOKIE_VALUE_MSG = "The provided cookie value is invalid. It must follow the format "
32 "specified in RFC 6265.";
33 const std::string CAN_NOT_REGISTER_MESSAGE_EVENT_MSG = "Fail to register a message event for the port.";
34 const std::string CANNOT_DEL_JAVA_SCRIPT_PROXY_MSG = "Failed to delete JavaScriptProxy because it does not exist.";
35 const std::string CAN_NOT_POST_MESSAGE_MSG = "Failed to post messages through the port.";
36 const std::string INVALID_ORIGIN_MSG = "Invalid origin.The origin format must follow defined in RFC 6454.";
37 const std::string NO_WEBSTORAGE_ORIGIN_MSG = "Invalid web storage origin.The web storage origin is empty.";
38 const std::string INVALID_SOCKET_NUMBER_MSG = "The number of sockets to be preconnected is invalid.";
39 const std::string TYPE_NOT_MATCH_WITCH_VALUE_MSG = "The type and value of the message do not match.";
40 const std::string NEW_OOM_MSG = "Memory allocation failed.";
41 const std::string DOWNLOAD_NOT_PAUSED_MSG = "The download task is not paused.";
42 const std::string NO_VALID_CONTROLLER_FOR_DOWNLOAD_MSG = "No valid WebviewController is associated.";
43 const std::string NO_DOWNLOAD_DELEGATE_SET_MSG = "No WebDownloadDelegate has been set yet.";
44 const std::string DOWNLOAD_NOT_START_MSG = "The download task is not started yet.";
45 const std::string REGISTER_CUSTOM_SCHEME_FAILED_MSG = "Failed to register custom schemes.";
46 const std::string HTTP_BODY_STREAN_INIT_FAILED_MSG = "Failed to initialize the HTTP body stream.";
47 const std::string RESOURCE_HANDLER_INVALID_MSG = "The resource handler is invalid.";
48 const std::string NOT_ALLOWED_PORT_MSG = "The port number is not within the allowed range.";
49 const std::string UNKNOWN_ERROR_MSG = "Unknown error message.";
50 const std::string INVALID_NET_ERROR_MSG = "The errorCode is either ARKWEB_NET_OK or "
51 "outside the range of error codes in WebNetErrorList";
52 }
53
54 namespace OHOS {
55 namespace ParamCheckErrorMsgTemplate {
56 const char* TYPE_ERROR = "BusinessError 401: Parameter error. The type of '%s' must be %s.";
57 const char* TYPE_ALL_STRING = "BusinessError 401: Parameter error. The type of params must be string.";
58 const char* TYPE_ALL_INT = "BusinessError 401: Parameter error. The type of params must be int.";
59 const char* PARAM_TYEPS_ERROR = "BusinessError 401: Parameter error. The type of params is error.";
60 const char* PARAM_NUMBERS_ERROR_ONE = "BusinessError 401: Parameter error. The number of params must be %s.";
61 const char* PARAM_NUMBERS_ERROR_TWO = "BusinessError 401: Parameter error. The number of params must be %s or %s.";
62 const char* PARAM_NUMBERS_ERROR_THREE =
63 "BusinessError 401: Parameter error. The number of params must be %s or %s or %s.";
64 const char* PARAM_NOT_NULL = "BusinessError 401: Parameter error. The type of '%s' can not be ignored.";
65 const char* PARAM_NOT_NULL_TWO =
66 "BusinessError 401: Parameter error. The type of '%s' and '%s' can not be ignored.";
67 const char* PARAM_TYPE_INVALID = "BusinessError 401: Parameter error. The type of '%s' is invalid.";
68 const char* PARAM_DETAIL_ERROR_MSG = "BusinessError 401: Parameter error. detail: %s.";
69 }
70 namespace NWebError {
71 std::unordered_map<ErrCode, std::string> g_errCodeMsgMap = {
72 {PARAM_CHECK_ERROR, PARAM_CHECK_ERROR_MSG},
73 {CAPABILITY_NOT_SUPPORTED_ERROR, CAPABILITY_NOT_SUPPORTED_ERROR_MSG},
74 {INIT_ERROR, INIT_ERROR_MSG},
75 {INVALID_URL, INVALID_URL_MSG},
76 {INVALID_RESOURCE, INVALID_RESOURCE_MSG},
77 {FUNCTION_NOT_ENABLE, FUNCTION_NOT_ENABLE_MSG},
78 {INVALID_COOKIE_VALUE, INVALID_COOKIE_VALUE_MSG},
79 {CAN_NOT_REGISTER_MESSAGE_EVENT, CAN_NOT_REGISTER_MESSAGE_EVENT_MSG},
80 {CANNOT_DEL_JAVA_SCRIPT_PROXY, CANNOT_DEL_JAVA_SCRIPT_PROXY_MSG},
81 {CAN_NOT_POST_MESSAGE, CAN_NOT_POST_MESSAGE_MSG},
82 {INVALID_ORIGIN, INVALID_ORIGIN_MSG},
83 {NO_WEBSTORAGE_ORIGIN, NO_WEBSTORAGE_ORIGIN_MSG},
84 {INVALID_SOCKET_NUMBER, INVALID_SOCKET_NUMBER_MSG},
85 {TYPE_NOT_MATCH_WITCH_VALUE, TYPE_NOT_MATCH_WITCH_VALUE_MSG},
86 {NEW_OOM, NEW_OOM_MSG},
87 {DOWNLOAD_NOT_PAUSED, DOWNLOAD_NOT_PAUSED_MSG},
88 {NO_VALID_CONTROLLER_FOR_DOWNLOAD, NO_VALID_CONTROLLER_FOR_DOWNLOAD_MSG},
89 {NO_DOWNLOAD_DELEGATE_SET, NO_DOWNLOAD_DELEGATE_SET_MSG},
90 {DOWNLOAD_NOT_START, DOWNLOAD_NOT_START_MSG},
91 {REGISTER_CUSTOM_SCHEME_FAILED, REGISTER_CUSTOM_SCHEME_FAILED_MSG},
92 {HTTP_BODY_STREAN_INIT_FAILED, HTTP_BODY_STREAN_INIT_FAILED_MSG},
93 {RESOURCE_HANDLER_INVALID, RESOURCE_HANDLER_INVALID_MSG},
94 {NOT_ALLOWED_PORT, NOT_ALLOWED_PORT_MSG},
95 {INVALID_NET_ERROR, INVALID_NET_ERROR_MSG},
96 };
97
GetErrMsgByErrCode(ErrCode code)98 std::string GetErrMsgByErrCode(ErrCode code)
99 {
100 auto it = g_errCodeMsgMap.find(code);
101 if (it != g_errCodeMsgMap.end()) {
102 return it->second;
103 }
104 return UNKNOWN_ERROR_MSG;
105 }
FormatString(const char * errorMsgTemplate,...)106 std::string FormatString(const char *errorMsgTemplate, ...)
107 {
108 char sbuf[256];
109 va_list args;
110 va_start(args, errorMsgTemplate);
111 if (vsnprintf_s(sbuf, sizeof(sbuf), sizeof(sbuf) - 1, errorMsgTemplate, args) < 0) {
112 va_end(args);
113 return "";
114 }
115 va_end(args);
116 return sbuf;
117 }
118 } // namespace NWebError
119 } // namespace OHOS
120