1 /* 2 * Copyright (c) 2021-2024 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 FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_IPC_INSTALLD_PROXY_H 17 #define FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_IPC_INSTALLD_PROXY_H 18 19 #include <string> 20 21 #include "appexecfwk_errors.h" 22 #include "bundle_constants.h" 23 #include "bundle_framework_services_ipc_interface_code.h" 24 #include "iremote_proxy.h" 25 #include "ipc/installd_interface.h" 26 27 namespace OHOS { 28 namespace AppExecFwk { 29 class InstalldProxy : public IRemoteProxy<IInstalld> { 30 public: 31 explicit InstalldProxy(const sptr<IRemoteObject> &object); 32 virtual ~InstalldProxy() override; 33 /** 34 * @brief Create a bundle code directory through a proxy object. 35 * @param bundleDir Indicates the bundle code directory path that to be created. 36 * @return Returns ERR_OK if the bundle directory created successfully; returns error code otherwise. 37 */ 38 virtual ErrCode CreateBundleDir(const std::string &bundlePath) override; 39 /** 40 * @brief Extract the files of a HAP module to the code directory through a proxy object. 41 * @param srcModulePath Indicates the HAP file path. 42 * @param targetPath normal files decompression path. 43 * @param targetSoPath so files decompression path. 44 * @param cpuAbi cpuAbi. 45 * @return Returns ERR_OK if the HAP file extracted successfully; returns error code otherwise. 46 */ 47 virtual ErrCode ExtractModuleFiles(const std::string &srcModulePath, const std::string &targetPath, 48 const std::string &targetSoPath, const std::string &cpuAbi) override; 49 /** 50 * @brief Extract the files. 51 * @param extractParam Indicates the extractParam. 52 * @return Returns ERR_OK if the HAP file extracted successfully; returns error code otherwise. 53 */ 54 virtual ErrCode ExtractFiles(const ExtractParam &extractParam) override; 55 56 /** 57 * @brief Extract the hnpFiles. 58 * @param hnpPackageInfo Indicates the hnpPackageInfo. 59 * @param extractParam Indicates the extractParam. 60 * @return Returns ERR_OK if the HAP file extracted successfully; returns error code otherwise. 61 */ 62 virtual ErrCode ExtractHnpFiles(const std::string &hnpPackageInfo, const ExtractParam &extractParam) override; 63 64 virtual ErrCode ProcessBundleInstallNative(const std::string &userId, const std::string &hnpRootPath, 65 const std::string &hapPath, const std::string &cpuAbi, const std::string &packageName) override; 66 67 virtual ErrCode ProcessBundleUnInstallNative(const std::string &userId, const std::string &bundleName) override; 68 69 virtual ErrCode ExecuteAOT(const AOTArgs &aotArgs, std::vector<uint8_t> &pendSignData) override; 70 71 virtual ErrCode PendSignAOT(const std::string &anFileName, const std::vector<uint8_t> &signData) override; 72 73 virtual ErrCode StopAOT() override; 74 /** 75 * @brief Rename the module directory from temporaily path to the real path through a proxy object. 76 * @param oldPath Indicates the old path name. 77 * @param newPath Indicates the new path name. 78 * @return Returns ERR_OK if the module directory renamed successfully; returns error code otherwise. 79 */ 80 virtual ErrCode RenameModuleDir(const std::string &oldPath, const std::string &newPath) override; 81 /** 82 * @brief Create a bundle data directory through a proxy object. 83 * @param createDirParam Indicates param to be set to the directory. 84 * @return Returns ERR_OK if the bundle data directory created successfully; returns error code otherwise. 85 */ 86 virtual ErrCode CreateBundleDataDir(const CreateDirParam &createDirPara) override; 87 88 virtual ErrCode CreateBundleDataDirWithVector(const std::vector<CreateDirParam> &createDirParams) override; 89 /** 90 * @brief Remove a bundle data directory through a proxy object. 91 * @param bundleDir Indicates the bundle data directory path that to be created. 92 * @param userid Indicates userid to be set to the directory. 93 * @return Returns ERR_OK if the bundle data directory created successfully; returns error code otherwise. 94 */ 95 virtual ErrCode RemoveBundleDataDir(const std::string &bundleDir, const int32_t userId, 96 bool isAtomicService = false) override; 97 /** 98 * @brief Remove a module data directory through a proxy object. 99 * @param ModuleDir Indicates the module data directory path that to be created. 100 * @param userid Indicates userid to be set to the directory. 101 * @return Returns ERR_OK if the data directories created successfully; returns error code otherwise. 102 */ 103 virtual ErrCode RemoveModuleDataDir(const std::string &ModuleDir, const int userid) override; 104 /** 105 * @brief Remove a directory through a proxy object. 106 * @param dir Indicates the directory path that to be removed. 107 * @return Returns ERR_OK if the directory removed successfully; returns error code otherwise. 108 */ 109 virtual ErrCode RemoveDir(const std::string &dir) override; 110 /** 111 * @brief Get disk usage for dir. 112 * @param dir Indicates the directory. 113 * @param isRealPath Indicates isRealPath. 114 * @return Returns true if successfully; returns false otherwise. 115 */ 116 virtual int64_t GetDiskUsage(const std::string &dir, bool isRealPath = false) override; 117 /** 118 * @brief Clean all files in a bundle data directory through a proxy object. 119 * @param bundleDir Indicates the data directory path that to be cleaned. 120 * @return Returns ERR_OK if the data directory cleaned successfully; returns error code otherwise. 121 */ 122 virtual ErrCode CleanBundleDataDir(const std::string &bundlePath) override; 123 /** 124 * @brief Clean a bundle data directory through a proxy object. 125 * @param bundleName Indicates the bundleName data directory path that to be cleaned. 126 * @param userid Indicates userid to be set to the directory. 127 * @param appIndex Indicates app index to be set to the directory. 128 * @return Returns ERR_OK if the bundle data directory cleaned successfully; returns error code otherwise. 129 */ 130 virtual ErrCode CleanBundleDataDirByName(const std::string &bundleName, const int userid, 131 const int appIndex = 0) override; 132 /** 133 * @brief Get bundle Stats. 134 * @param bundleName Indicates the bundle name. 135 * @param userId Indicates the user Id. 136 * @param bundleStats Indicates the bundle Stats. 137 * @return Returns ERR_OK if get stats successfully; returns error code otherwise. 138 */ 139 virtual ErrCode GetBundleStats(const std::string &bundleName, const int32_t userId, 140 std::vector<int64_t> &bundleStats, const int32_t uid = Constants::INVALID_UID, 141 const int32_t appIndex = 0) override; 142 143 virtual ErrCode GetAllBundleStats(const int32_t userId, 144 std::vector<int64_t> &bundleStats, const std::vector<int32_t> &uids) override; 145 /** 146 * @brief Set dir apl. 147 * @param dir Indicates the data dir. 148 * @param bundleName Indicates the bundle name. 149 * @param apl Indicates the apl type. 150 * @param isPreInstallApp Indicates the bundle install type. 151 * @param debug Indicates the bundle debug mode. 152 * @return Returns ERR_OK if set apl successfully; returns error code otherwise. 153 */ 154 virtual ErrCode SetDirApl(const std::string &dir, const std::string &bundleName, const std::string &apl, 155 bool isPreInstallApp, bool debug) override; 156 /** 157 * @brief Get all cache file path. 158 * @param dir Indicates the data dir. 159 * @param cachesPath Indicates the cache file path. 160 * @return Returns ERR_OK if get cache file path successfully; returns error code otherwise. 161 */ 162 virtual ErrCode GetBundleCachePath(const std::string &dir, std::vector<std::string> &cachePath) override; 163 164 virtual ErrCode ScanDir( 165 const std::string &dir, ScanMode scanMode, ResultMode resultMode, std::vector<std::string> &paths) override; 166 167 virtual ErrCode MoveFile(const std::string &oldPath, const std::string &newPath) override; 168 169 virtual ErrCode CopyFile(const std::string &oldPath, const std::string &newPath, 170 const std::string &signatureFilePath = "") override; 171 172 virtual ErrCode Mkdir( 173 const std::string &dir, const int32_t mode, const int32_t uid, const int32_t gid) override; 174 175 virtual ErrCode GetFileStat(const std::string &file, FileStat &fileStat) override; 176 177 virtual ErrCode ExtractDiffFiles(const std::string &filePath, const std::string &targetPath, 178 const std::string &cpuAbi) override; 179 180 virtual ErrCode ApplyDiffPatch(const std::string &oldSoPath, const std::string &diffFilePath, 181 const std::string &newSoPath, int32_t uid) override; 182 183 virtual ErrCode IsExistDir(const std::string &dir, bool &isExist) override; 184 185 virtual ErrCode IsExistFile(const std::string &path, bool &isExist) override; 186 187 virtual ErrCode IsExistApFile(const std::string &path, bool &isExist) override; 188 189 virtual ErrCode IsDirEmpty(const std::string &dir, bool &isDirEmpty) override; 190 191 virtual ErrCode ObtainQuickFixFileDir(const std::string &dir, std::vector<std::string> &dirVec) override; 192 193 virtual ErrCode CopyFiles(const std::string &sourceDir, const std::string &destinationDir) override; 194 195 virtual ErrCode GetNativeLibraryFileNames(const std::string &filePath, const std::string &cpuAbi, 196 std::vector<std::string> &fileNames) override; 197 198 virtual ErrCode VerifyCodeSignature(const CodeSignatureParam &codeSignatureParam) override; 199 200 virtual ErrCode CheckEncryption(const CheckEncryptionParam &checkEncryptionParam, 201 bool &isEncryption) override; 202 203 virtual ErrCode MoveFiles(const std::string &srcDir, const std::string &desDir) override; 204 205 virtual ErrCode ExtractDriverSoFiles(const std::string &srcPath, 206 const std::unordered_multimap<std::string, std::string> &dirMap) override; 207 208 virtual ErrCode ExtractEncryptedSoFiles(const std::string &hapPath, const std::string &realSoFilesPath, 209 const std::string &cpuAbi, const std::string &tmpSoPath, int32_t uid) override; 210 211 virtual ErrCode VerifyCodeSignatureForHap(const CodeSignatureParam &codeSignatureParam) override; 212 213 virtual ErrCode DeliverySignProfile(const std::string &bundleName, int32_t profileBlockLength, 214 const unsigned char *profileBlock) override; 215 216 virtual ErrCode RemoveSignProfile(const std::string &bundleName) override; 217 218 virtual ErrCode SetEncryptionPolicy(int32_t uid, const std::string &bundleName, 219 const int32_t userId, std::string &keyId) override; 220 221 virtual ErrCode DeleteEncryptionKeyId(const std::string &bundleName, const int32_t userId) override; 222 223 virtual ErrCode RemoveExtensionDir(int32_t userId, const std::vector<std::string> &extensionBundleDirs) override; 224 225 virtual ErrCode IsExistExtensionDir(int32_t userId, const std::string &extensionBundleDir, bool &isExist) override; 226 227 virtual ErrCode CreateExtensionDataDir(const CreateDirParam &createDirParam) override; 228 229 virtual ErrCode GetExtensionSandboxTypeList(std::vector<std::string> &typeList) override; 230 231 virtual ErrCode AddUserDirDeleteDfx(int32_t userId) override; 232 233 virtual ErrCode MoveHapToCodeDir(const std::string &originPath, const std::string &targetPath) override; 234 private: 235 ErrCode TransactInstalldCmd(InstalldInterfaceCode code, MessageParcel &data, MessageParcel &reply, 236 MessageOption &option); 237 static inline BrokerDelegator<InstalldProxy> delegator_; 238 }; 239 } // namespace AppExecFwk 240 } // namespace OHOS 241 #endif // FOUNDATION_APPEXECFWK_SERVICES_BUNDLEMGR_INCLUDE_IPC_INSTALLD_PROXY_H