2 * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the License);
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an AS IS BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
24 #include <boost/filesystem.hpp>
25 #include <pkgmgr-info.h>
27 #include <launcher_env.h>
29 #ifndef PATH_SEPARATOR
30 #define PATH_SEPARATOR '/'
33 #ifndef PROFILE_BASENAME
34 #define PROFILE_BASENAME ".__tizen_specific_profile_data"
37 namespace bf = boost::filesystem;
38 namespace bs = boost::system;
42 FS_MERGE_SKIP = (1 << 0),
43 FS_MERGE_OVERWRITE = (1 << 1),
44 FS_COMMIT_COPY_FILE = (1 << 2),
45 FS_PRESERVE_OWNERSHIP_AND_PERMISSIONS = (1 << 3)
49 * @brief concat path with PATH_SEPARATOR
50 * @param[in] destination path
51 * @param[in] source path
52 * @return std::string result path
54 std::string concatPath(const std::string& path1, const std::string& path2);
57 * @brief get canonicalized absolute Path
58 * @param[in] source path
59 * @return std::string result path
61 std::string getAbsolutePath(const std::string& path);
64 * @brief get the directory of file
65 * @param[in] source path
66 * @return std::string result path
68 std::string getBaseName(const std::string& path);
71 * @brief replaces all matching substrings of the regular expression with a given replacement
72 * @param[in] original string
73 * @param[in] pattern to match
74 * @param[in] replacement string
75 * @return std::string the modified string
77 std::string replaceAll(const std::string& str, const std::string& pattern, const std::string& replace);
80 * @brief get root path
81 * @param[in] package id
82 * @return std::string root path
84 std::string getRootPath(const std::string& pkgId);
87 * @brief get exec name
88 * @param[in] package id
89 * @return std::string exec name
91 std::string getExecName(const std::string& pkgId);
95 * @param[in] package id
96 * @return std::string app type
98 std::string getAppType(const std::string& pkgId);
101 * @brief get metadata value
102 * @param[in] package id
103 * @param[in] metadata key
104 * @return std::string metadata value
106 std::string getMetadataValue(const std::string& pkgId, const std::string& key);
109 * @brief change the extension of a path or file
110 * @param[in] source path or file
111 * @param[in] from extension
112 * @param[in] to extension
113 * @return std::string path or file with changed extension
115 std::string changeExtension(const std::string& path, const std::string& from, const std::string& to);
118 * @brief check the path is 'readonly' or not
120 * @return bool package readonly value
122 bool isReadOnlyArea(const std::string& path);
125 * @brief split path with ":" delimiter and put that in the vector
126 * @param[in] source path
127 * @param[out] string vector
129 void splitPath(const std::string& path, std::vector<std::string>& out);
132 * @brief check file exists
133 * in case of symlink file, check both input file and link reference file.
134 * @param[in] source path
137 bool isFile(const std::string& path);
140 * @brief check symlink file
141 * @param[in] source path
144 bool isSymlinkFile(const std::string& path);
147 * @brief check directory exists
148 * @param[in] source path
151 bool isDirectory(const std::string& path);
154 * @brief check the file is managed assembly or not.
155 * @param[in] file path
156 * @return return true when the file is managed assembly.
157 * otherwise return false including native image case.
159 bool isManagedAssembly(const std::string& filePath);
162 * @brief check the file is native image or not.
163 * @param[in] file path
164 * @return return true when the file is native image.
166 bool isNativeImage(const std::string& filePath);
169 * @brief Resolve assembly files from directories and append their paths to the given list.
170 * @remark If a native image exists for an assembly in the same directory, it will be used.
171 * If multiple assemblies of the same name exist, the first one will be used.
172 * @param[in] directories list of directories
173 * @param[out] list colon-separated string of assembly paths
175 void addAssembliesFromDirectories(const std::vector<std::string>& directories, std::string& list);
178 * @brief File search callback
179 * @param[in] path full path to a resolved file
180 * @param[in] filename file name
182 typedef std::function<void (const std::string& path, const std::string& filename)> FileReader;
185 * @brief Scan all files in the given directory.
186 * @param[in] directory path to a root directory
187 * @param[in] reader callback for iteration
188 * @param[in] depth recursive search depth
190 void scanFilesInDirectory(const std::string& directory, FileReader reader, unsigned int depth);
193 * @brief copy smack and ownership.
194 * @param[in] get path
195 * @param[in] set path
196 * @param[in] symbolic link
198 void copySmackAndOwnership(const std::string& fromPath, const std::string& toPath, bool isSymlink = false);
201 * @brief check whether the path exists or not.
202 * @param[in] source path
203 * @return return true when the path exist.
205 bool exist(const bf::path& path);
208 * @brief create the new directory.
209 * @param[in] source path
210 * @return return true when the directory was created.
212 bool createDir(const bf::path& path);
215 * @brief copy the directory.
216 * @param[in] path to the source directory
217 * @param[in] path to the target directory
218 * @param[in] filesystem flag
219 * @return return true when the directory was copied.
221 bool copyDir(const bf::path& path1, const bf::path& path2, FSFlag flags = FS_NONE);
224 * @brief copy the file.
225 * @param[in] path to the source file
226 * @param[in] path to the target file
227 * @return return true when the file was copied.
229 bool copyFile(const bf::path& path1, const bf::path& path2);
232 * @brief moves of renames the file or directory.
233 * @param[in] path to the source file
234 * @param[in] path to the target file
235 * @return return true when the file was moved.
237 bool moveFile(const bf::path& path1, const bf::path& path2);
240 * @brief removes the file or empty directory.
241 * @param[in] source path
242 * @return return true when the file was deleted.
244 bool removeFile(const bf::path& path);
247 * @brief removes the file or directory and all its contents.
248 * @param[in] source path
249 * @return return true when the file or directory was deleted.
251 bool removeAll(const bf::path& path);
254 * @brief change command name of the current process for access via ps command
257 void setCmdName(const std::string& name);
260 * @brief Get the file name from the specified path.
261 * @remark An empty string will be returned if the path string ends with a path separator character.
262 * @param[in] path path to a file
263 * @return a substring after the path separator character
265 std::string getFileName(const std::string& path);
268 * @brief Generates a representation called a message digest
269 * @param[in] file path
270 * @return message digest
272 std::string SHA256(const std::string& path);
275 * @brief Creates the package information handle from db which is not disabled.
276 * This function is a wrapper of pkgmgrinfo_pkginfo_get_pkginfo() to handle multi-user case
278 * @param[out] pkginfo handle
279 * @return 0 if success, otherwise -1
281 int pkgmgrGetPkgInfo(const std::string& pkgId, pkgmgrinfo_pkginfo_h* handle);
284 * @brief Creates the application information handle from db.
285 * This function is a wrapper of pkgmgrinfo_appinfo_get_appinfo() to handle multi-user case
287 * @param[out] appinfo handle
288 * @return 0 if success, otherwise -1
290 int pkgmgrGetAppInfo(const std::string& appId, pkgmgrinfo_appinfo_h* handle);
293 * @brief Executes the metadata filter query for all the installed packages.
294 * This function is a wrapper of pkgmgrinfo_appinfo_metadata_filter_foreach() to handle multi-user case
295 * @param[in] metadata filter handle
296 * @param[in] callback function
297 * @param[in] user data
298 * @return 0 if success, otherwise -1
300 int pkgmgrMDFilterForeach(pkgmgrinfo_appinfo_metadata_filter_h handle,
301 pkgmgrinfo_app_list_cb app_cb,
304 #endif /* __UTILS_H__ */