NativeLauncher/inc/utils.h

   1 /*
   2  * Copyright (c) 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 #ifndef __UTILS_H__
  18 #define __UTILS_H__
  19
  20 #include <string>
  21 #include <vector>
  22 #include <functional>
  23 #include <boost/filesystem.hpp>
  24
  25 #include <launcher_env.h>
  26
  27 #ifndef PATH_SEPARATOR
  28 #define PATH_SEPARATOR '/'
  29 #endif
  30
  31 namespace bf = boost::filesystem;
  32 namespace bs = boost::system;
  33
  34 enum FSFlag : int {
  35   FS_NONE              = 0,
  36   FS_MERGE_SKIP        = (1 << 0),
  37   FS_MERGE_OVERWRITE   = (1 << 1),
  38   FS_COMMIT_COPY_FILE  = (1 << 2),
  39   FS_PRESERVE_OWNERSHIP_AND_PERMISSIONS = (1 << 3)
  40 };
  41
  42 /**
  43  * @brief an iterator to the begin element in the range that compares equal to option
  44  * @param[in] begin element
  45  * @param[in] end elment
  46  * return return true when elements match
  47  */
  48 bool cmdOptionExists(char** begin, char** end, const std::string& option);
  49
  50 /**
  51  * @brief get current executable path
  52  * return std::string path
  53  */
  54 std::string readSelfPath();
  55
  56 /**
  57  * @brief concat path with PATH_SEPARATOR
  58  * @param[in] destination path
  59  * @param[in] source path
  60  * return std::string result path
  61  */
  62 std::string concatPath(const std::string& path1, const std::string& path2);
  63
  64 /**
  65  * @brief get absolute Path
  66  * @param[in] source path
  67  * return std::string result path
  68  */
  69 std::string absolutePath(const std::string& path);
  70
  71 /**
  72  * @brief get the directory of file
  73  * @param[in] source path
  74  * return std::string result path
  75  */
  76 std::string baseName(const std::string& path);
  77
  78 /**
  79  * @brief replaces all matching substrings of the regular expression with a given replacement
  80  * @param[in] original string
  81  * @param[in] pattern to match
  82  * @param[in] replacement string
  83  * return the modified string
  84  */
  85 std::string replaceAll(const std::string &str, const std::string &pattern, const std::string &replace);
  86
  87 /**
  88  * @brief get root path
  89  * @param[in] package id
  90  * @param[out] root path
  91  */
  92 int getRootPath(std::string pkgId, std::string& rootPath);
  93
  94 /**
  95  * @brief get exec name
  96  * @param[in] package id
  97  * @param[out] exec name
  98  */
  99 int getExecName(std::string pkgId, std::string& execName);
 100
 101 /**
 102  * @brief get metadata value
 103  * @param[in] package id
 104  * @param[in] metadata key
 105  * @param[out] metadata value
 106  */
 107 int getMetadataValue(std::string pkgId, std::string metadataKey, std::string& metadataValue);
 108
 109 /**
 110  * @brief split path with ":" delimiter and put that in the vector
 111  * @param[in] source path
 112  * @param[out] string vector
 113  */
 114 void splitPath(const std::string& path, std::vector<std::string>& out);
 115
 116 /**
 117  * @brief check file is exist
 118  * @param[in] source path
 119  * @return bool
 120  */
 121 bool isFileExist(const std::string& path);
 122
 123 /**
 124  * @brief get file size
 125  * @param[in] source path
 126  * @return size of file
 127  */
 128 uintptr_t getFileSize(const std::string& path);
 129
 130 /**
 131  * @brief check the file is managed assembly or not.
 132  * @param[in] file path
 133  * @return return true when the file is managed assembly.
 134  *         otherwise return false including native image case.
 135  */
 136 bool isManagedAssembly(const std::string& filePath);
 137
 138 /**
 139  * @brief check the file is native image or not.
 140  * @param[in] file path
 141  * @return return true when the file is native image.
 142  */
 143 bool isNativeImage(const std::string& filePath);
 144
 145 /**
 146  * @brief Resolve assembly files from directories and append their paths to the given list.
 147  * @remark If a native image exists for an assembly in the same directory, it will be used.
 148  *         If multiple assemblies of the same name exist, the first one will be used.
 149  * @param[in]  directories  list of directories
 150  * @param[out] list         colon-separated string of assembly paths
 151  */
 152 void addAssembliesFromDirectories(const std::vector<std::string>& directories, std::string& list);
 153
 154 /**
 155  * @brief File search callback
 156  * @param[in] path      full path to a resolved file
 157  * @param[in] filename  file name
 158  */
 159 typedef std::function<void (const std::string& path, const std::string& filename)> FileReader;
 160
 161 /**
 162  * @brief Scan all files in the given directory.
 163  * @param[in] directory path to a root directory
 164  * @param[in] reader    callback for iteration
 165  * @param[in] depth     recursive search depth
 166  */
 167 void scanFilesInDirectory(const std::string& directory, FileReader reader, unsigned int depth);
 168
 169 /**
 170  * @brief copy smack and ownership.
 171  * @param[in] get path
 172  * @param[in] set path
 173  * @param[in] symbolic link
 174  */
 175 void copySmackAndOwnership(const std::string& fromPath, const std::string& toPath, bool isSymlink = false);
 176
 177 /**
 178  * @brief create the new directory.
 179  * @param[in] source path
 180  * @return return true when the directory was created.
 181  */
 182 bool createDir(const bf::path& path);
 183
 184 /**
 185  * @brief copy the directory.
 186  * @param[in] path to the source directory
 187  * @param[in] path to the target directory
 188  * @param[in] filesystem flag
 189  * @return return true when the directory was copied.
 190  */
 191 bool copyDir(const bf::path& path1, const bf::path& path2, FSFlag flags = FS_NONE);
 192
 193 /**
 194  * @brief copy the file.
 195  * @param[in] path to the source file
 196  * @param[in] path to the target file
 197  * @return return true when the file was copied.
 198  */
 199 bool copyFile(const bf::path& path1, const bf::path& path2);
 200
 201 /**
 202  * @brief moves of renames the file or directory.
 203  * @param[in] path to the source file
 204  * @param[in] path to the target file
 205  * @return return true when the file was moved.
 206  */
 207 bool moveFile(const bf::path& path1, const bf::path& path2);
 208
 209 /**
 210  * @brief removes the file or empty directory.
 211  * @param[in] source path
 212  * @return return true when the file was deleted.
 213  */
 214 bool removeFile(const bf::path& path);
 215
 216 /**
 217  * @brief removes the file or directory and all its contents.
 218  * @param[in] source path
 219  * @return return true when the file or directory was deleted.
 220  */
 221 bool removeAll(const bf::path& path);
 222
 223 /**
 224  * @brief change command name of the current process for access via ps command
 225  * @param[in] name
 226  */
 227 void setCmdName(const std::string& name);
 228
 229 /**
 230  * @brief Get the file name from the specified path.
 231  * @remark An empty string will be returned if the path string ends with a path separator character.
 232  * @param[in] path  path to a file
 233  * @return a substring after the path separator character
 234  */
 235 std::string getFileName(const std::string& path);
 236
 237 #endif /* __UTILS_H__ */