1 /*
2  * Copyright (c) 2022-2023 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 #ifndef INTERFACES_KITS_JS_SRC_MOD_FS_COMMON_FUNC_H
17 #define INTERFACES_KITS_JS_SRC_MOD_FS_COMMON_FUNC_H
18 
19 #include "fd_guard.h"
20 #include "n_val.h"
21 #include "uv.h"
22 #if !defined(WIN_PLATFORM) && !defined(IOS_PLATFORM)
23 #include "iremote_broker.h"
24 #endif
25 
26 namespace OHOS {
27 namespace FileManagement {
28 namespace ModuleFileIO {
29 
30 constexpr int RDONLY = UV_FS_O_RDONLY;
31 constexpr int WRONLY = UV_FS_O_WRONLY;
32 constexpr int RDWR = UV_FS_O_RDWR;
33 constexpr int CREATE = UV_FS_O_CREAT;
34 constexpr int TRUNC = UV_FS_O_TRUNC;
35 constexpr int APPEND = UV_FS_O_APPEND;
36 constexpr int NONBLOCK = UV_FS_O_NONBLOCK;
37 constexpr int DIRECTORY = UV_FS_O_DIRECTORY;
38 constexpr int NOFOLLOW = UV_FS_O_NOFOLLOW;
39 constexpr int SYNC = UV_FS_O_SYNC;
40 
41 constexpr unsigned int MODE_EXIST = 00;
42 constexpr unsigned int MODE_WRITE = 02;
43 constexpr unsigned int MODE_READ = 04;
44 constexpr unsigned int MODE_READ_WRITE = 06;
45 
46 constexpr unsigned int USR_READ_ONLY = 00;
47 constexpr unsigned int USR_WRITE_ONLY = 01;
48 constexpr unsigned int USR_RDWR = 02;
49 constexpr unsigned int USR_CREATE = 0100;
50 constexpr unsigned int USR_TRUNC = 01000;
51 constexpr unsigned int USR_APPEND = 02000;
52 constexpr unsigned int USR_NONBLOCK = 04000;
53 constexpr unsigned int USR_DIRECTORY = 0200000;
54 constexpr unsigned int USR_NOFOLLOW = 0400000;
55 constexpr unsigned int USR_SYNC = 04010000;
56 
57 const double NS = 1e9;
58 const double MS = 1e3;
59 
60 struct FileInfo {
61     bool isPath = false;
62     std::unique_ptr<char[]> path = { nullptr };
63     std::unique_ptr<DistributedFS::FDGuard> fdg = { nullptr };
64 };
65 
66 #if !defined(WIN_PLATFORM) && !defined(IOS_PLATFORM)
67 class FileIoToken : public IRemoteBroker {
68 public:
69     DECLARE_INTERFACE_DESCRIPTOR(u"ohos.fileio.open");
70 
71     FileIoToken() = default;
72     virtual ~FileIoToken() noexcept = default;
73 };
74 #endif
75 
76 void InitAccessModeType(napi_env env, napi_value exports);
77 void InitOpenMode(napi_env env, napi_value exports);
78 void InitWhenceType(napi_env env, napi_value exports);
79 
80 struct CommonFunc {
81     static unsigned int ConvertJsFlags(unsigned int &flags);
82     static LibN::NVal InstantiateStat(napi_env env, const uv_stat_t &buf, bool async = false);
83 #if !defined(WIN_PLATFORM) && !defined(IOS_PLATFORM)
84     static LibN::NVal InstantiateStat(napi_env env, const uv_stat_t &buf, std::shared_ptr<FileInfo> fileInfo,
85                                       bool async = false);
86 #endif
87 #ifndef WIN_PLATFORM
88     static LibN::NVal InstantiateFile(napi_env env, int fd, const std::string &pathOrUri, bool isUri);
89     static LibN::NVal InstantiateStream(napi_env env, std::shared_ptr<FILE> fp, bool async = false);
90 #endif
91     static std::tuple<bool, void *, size_t, int64_t> GetReadArg(napi_env env,
92                                                                        napi_value readBuf,
93                                                                        napi_value option);
94     static std::tuple<bool, std::unique_ptr<char[]>, void *, size_t, int64_t> GetWriteArg(napi_env env,
95                                                                                                  napi_value argWBuf,
96                                                                                                  napi_value argOption);
97     static std::tuple<bool, std::unique_ptr<char[]>, std::unique_ptr<char[]>> GetCopyPathArg(napi_env env,
98                                                                                              napi_value srcPath,
99                                                                                              napi_value dstPath);
100     static void fs_req_cleanup(uv_fs_t* req);
101     static std::string GetModeFromFlags(unsigned int flags);
102     static bool CheckPublicDirPath(const std::string &sandboxPath);
103     static std::string Decode(const std::string &uri);
104 };
105 } // namespace ModuleFileIO
106 } // namespace FileManagement
107 } // namespace OHOS
108 #endif // INTERFACES_KITS_JS_SRC_MOD_FS_COMMON_FUNC_H