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