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.
23 #include <boost/filesystem.hpp>
24 #include <pkgmgr-info.h>
26 #include <launcher_env.h>
28 #ifndef PATH_SEPARATOR
29 #define PATH_SEPARATOR '/'
32 namespace bf = boost::filesystem;
33 namespace bs = boost::system;
37 FS_MERGE_SKIP = (1 << 0),
38 FS_MERGE_OVERWRITE = (1 << 1),
39 FS_COMMIT_COPY_FILE = (1 << 2),
40 FS_PRESERVE_OWNERSHIP_AND_PERMISSIONS = (1 << 3)
44 * @brief concat path with PATH_SEPARATOR
45 * @param[in] destination path
46 * @param[in] source path
47 * return std::string result path
49 std::string concatPath(const std::string& path1, const std::string& path2);
52 * @brief get canonicalized absolute Path
53 * @param[in] source path
54 * return std::string result path
56 std::string getAbsolutePath(const std::string& path);
59 * @brief get the directory of file
60 * @param[in] source path
61 * return std::string result path
63 std::string getBaseName(const std::string& path);
66 * @brief replaces all matching substrings of the regular expression with a given replacement
67 * @param[in] original string
68 * @param[in] pattern to match
69 * @param[in] replacement string
70 * return std::string the modified string
72 std::string replaceAll(const std::string& str, const std::string& pattern, const std::string& replace);
75 * @brief get root path
76 * @param[in] package id
77 * return std::string root path
79 std::string getRootPath(const std::string& pkgId);
82 * @brief get exec name
83 * @param[in] package id
84 * return std::string exec name
86 std::string getExecName(const std::string& pkgId);
90 * @param[in] package id
91 * return std::string app type
93 std::string getAppType(const std::string& pkgId);
96 * @brief get metadata value
97 * @param[in] package id
98 * @param[in] metadata key
99 * return std::string metadata value
101 std::string getMetadataValue(const std::string& pkgId, const std::string& key);
104 * @brief split path with ":" delimiter and put that in the vector
105 * @param[in] source path
106 * @param[out] string vector
108 void splitPath(const std::string& path, std::vector<std::string>& out);
111 * @brief check file exists
112 * in case of symlink file, check both input file and link reference file.
113 * @param[in] source path
116 bool isFile(const std::string& path);
119 * @brief check directory exists
120 * @param[in] source path
123 bool isDirectory(const std::string& path);
126 * @brief check the file is managed assembly or not.
127 * @param[in] file path
128 * @return return true when the file is managed assembly.
129 * otherwise return false including native image case.
131 bool isManagedAssembly(const std::string& filePath);
134 * @brief check the file is native image or not.
135 * @param[in] file path
136 * @return return true when the file is native image.
138 bool isNativeImage(const std::string& filePath);
141 * @brief Resolve assembly files from directories and append their paths to the given list.
142 * @remark If a native image exists for an assembly in the same directory, it will be used.
143 * If multiple assemblies of the same name exist, the first one will be used.
144 * @param[in] directories list of directories
145 * @param[out] list colon-separated string of assembly paths
147 void addAssembliesFromDirectories(const std::vector<std::string>& directories, std::string& list);
150 * @brief File search callback
151 * @param[in] path full path to a resolved file
152 * @param[in] filename file name
154 typedef std::function<void (const std::string& path, const std::string& filename)> FileReader;
157 * @brief Scan all files in the given directory.
158 * @param[in] directory path to a root directory
159 * @param[in] reader callback for iteration
160 * @param[in] depth recursive search depth
162 void scanFilesInDirectory(const std::string& directory, FileReader reader, unsigned int depth);
165 * @brief copy smack and ownership.
166 * @param[in] get path
167 * @param[in] set path
168 * @param[in] symbolic link
170 void copySmackAndOwnership(const std::string& fromPath, const std::string& toPath, bool isSymlink = false);
173 * @brief check whether the path exists or not.
174 * @param[in] source path
175 * @return return true when the path exist.
177 bool exist(const bf::path& path);
180 * @brief create the new directory.
181 * @param[in] source path
182 * @return return true when the directory was created.
184 bool createDir(const bf::path& path);
187 * @brief copy the directory.
188 * @param[in] path to the source directory
189 * @param[in] path to the target directory
190 * @param[in] filesystem flag
191 * @return return true when the directory was copied.
193 bool copyDir(const bf::path& path1, const bf::path& path2, FSFlag flags = FS_NONE);
196 * @brief copy the file.
197 * @param[in] path to the source file
198 * @param[in] path to the target file
199 * @return return true when the file was copied.
201 bool copyFile(const bf::path& path1, const bf::path& path2);
204 * @brief moves of renames the file or directory.
205 * @param[in] path to the source file
206 * @param[in] path to the target file
207 * @return return true when the file was moved.
209 bool moveFile(const bf::path& path1, const bf::path& path2);
212 * @brief removes the file or empty directory.
213 * @param[in] source path
214 * @return return true when the file was deleted.
216 bool removeFile(const bf::path& path);
219 * @brief removes the file or directory and all its contents.
220 * @param[in] source path
221 * @return return true when the file or directory was deleted.
223 bool removeAll(const bf::path& path);
226 * @brief change command name of the current process for access via ps command
229 void setCmdName(const std::string& name);
232 * @brief Get the file name from the specified path.
233 * @remark An empty string will be returned if the path string ends with a path separator character.
234 * @param[in] path path to a file
235 * @return a substring after the path separator character
237 std::string getFileName(const std::string& path);
240 * @brief Generates a representation called a message digest
241 * @param[in] file path
242 * @return message digest
244 std::string SHA256(const std::string& path);
247 * @brief Creates the package information handle from db which is not disabled.
248 * This function is a wrapper of pkgmgrinfo_pkginfo_get_pkginfo() to handle multi-user case
250 * @param[out] pkginfo handle
251 * @return 0 if success, otherwise -1
253 int pkgmgrGetPkgInfo(const std::string& pkgId, pkgmgrinfo_pkginfo_h* handle);
256 * @brief Creates the application information handle from db.
257 * This function is a wrapper of pkgmgrinfo_appinfo_get_appinfo() to handle multi-user case
259 * @param[out] appinfo handle
260 * @return 0 if success, otherwise -1
262 int pkgmgrGetAppInfo(const std::string& appId, pkgmgrinfo_appinfo_h* handle);
265 * @brief Executes the metadata filter query for all the installed packages.
266 * This function is a wrapper of pkgmgrinfo_appinfo_metadata_filter_foreach() to handle multi-user case
267 * @param[in] metadata filter handle
268 * @param[in] callback function
269 * @param[in] user data
270 * @return 0 if success, otherwise -1
272 int pkgmgrMDFilterForeach(pkgmgrinfo_appinfo_metadata_filter_h handle,
273 pkgmgrinfo_app_list_cb app_cb,
276 #endif /* __UTILS_H__ */