1 /* 2 * Copyright (c) 2022-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 OHOS_FILEMGMT_BACKUP_B_SESSION_RESTORE_H 17 #define OHOS_FILEMGMT_BACKUP_B_SESSION_RESTORE_H 18 19 #include <functional> 20 #include <memory> 21 #include <vector> 22 23 #include "b_file_info.h" 24 #include "errors.h" 25 #include "svc_death_recipient.h" 26 #include "unique_fd.h" 27 28 namespace OHOS::FileManagement::Backup { 29 class BSessionRestore { 30 public: 31 struct Callbacks { 32 std::function<void(const BFileInfo &, UniqueFd, ErrCode)> onFileReady; // 当备份服务有文件待发送时执行的回调 33 std::function<void(ErrCode, const BundleName)> onBundleStarted; // 当启动某个应用的恢复流程结束时执行的回调函数 34 std::function<void(ErrCode, const BundleName)> onBundleFinished; // 当某个应用的恢复流程结束或意外中止时执行的回调函数 35 std::function<void(ErrCode)> onAllBundlesFinished; // 当整个恢复流程结束或意外中止时执行的回调函数 36 std::function<void(const std::string, const std::string)> onResultReport; // 某个应用恢复流程中自定义错误信息的上报的回调函数 37 std::function<void()> onBackupServiceDied; // 当备份服务意外死亡时执行的回调函数 38 std::function<void(const std::string, const std::string)> onProcess; // 上报备份恢复过程中的进度和异常 39 }; 40 41 public: 42 /** 43 * @brief 获取一个用于控制恢复流程的会话 44 * 45 * @param callbacks 注册的回调函数 46 * @return std::unique_ptr<BRestoreSession> 指向BRestoreSession的智能指针。失败时为空指针 47 */ 48 static std::unique_ptr<BSessionRestore> Init(Callbacks callbacks); 49 50 /** 51 * @brief 获取一个用于控制恢复流程的会话 52 * 53 * @param callbacks 注册的回调函数 54 * @param errMsg 失败信息 55 * @param errCode 错误码 56 * @return std::unique_ptr<BRestoreSession> 指向BRestoreSession的智能指针。失败时为空指针 57 */ 58 static std::unique_ptr<BSessionRestore> Init(Callbacks callbacks, std::string &errMsg, ErrCode &errCode); 59 60 /** 61 * @brief 获取支持备份的应用信息 62 * 63 * @return ErrCode 规范错误码 64 */ 65 UniqueFd GetLocalCapabilities(); 66 67 /** 68 * @brief 通知备份服务文件内容已就绪 69 * 70 * @param fileInfo 文件描述信息 71 * @return ErrCode 规范错误码 72 * @see GetFileHandle 73 */ 74 ErrCode PublishFile(BFileInfo fileInfo); 75 76 /** 77 * @brief 请求恢复流程所需的真实文件 78 * 79 * @param bundleName 应用名称 80 * @param fileName 文件名称 81 */ 82 ErrCode GetFileHandle(const std::string &bundleName, const std::string &fileName); 83 84 /** 85 * @brief 用于追加应用，现阶段仅支持在Start之前调用 86 * 87 * @param remoteCap 已打开的保存远端设备能力的Json文件。可使用GetLocalCapabilities方法获取 88 * @param bundlesToRestore 待恢复的应用清单 89 * @param detailInfos bundle对应的单双映射关系json 90 * @return ErrCode 规范错误码 91 */ 92 ErrCode AppendBundles(UniqueFd remoteCap, std::vector<BundleName> bundlesToRestore, 93 std::vector<std::string> detailInfos); 94 95 /** 96 * @brief 用于追加应用，现阶段仅支持在Start之前调用 97 * 98 * @param remoteCap 已打开的保存远端设备能力的Json文件。可使用GetLocalCapabilities方法获取 99 * @param bundlesToRestore 待恢复的应用清单 100 * @return ErrCode 规范错误码 101 */ 102 ErrCode AppendBundles(UniqueFd remoteCap, std::vector<BundleName> bundlesToRestore); 103 104 /** 105 * @brief 用于结束追加应用，结束后不可在调用AppendBundles 106 * 107 * @return ErrCode 规范错误码 108 */ 109 ErrCode Finish(); 110 111 /** 112 * @brief 用于启动恢复流程 113 * 114 * @return ErrCode 规范错误码 115 */ 116 ErrCode Start(); 117 118 /** 119 * @brief 用于结束服务 120 * 121 * @return ErrCode 规范错误码 122 */ 123 ErrCode Release(); 124 125 /** 126 * @brief 用于结束应用的备份恢复任务 127 * 128 * @param bundleName 要取消的应用包名 129 * @return ErrCode 规范错误码 130 */ 131 ErrCode Cancel(std::string bundleName); 132 133 /** 134 * @brief 注册备份服务意外死亡时执行的回调函数 135 * 136 * @param functor 回调函数 137 */ 138 void RegisterBackupServiceDied(std::function<void()> functor); 139 140 /** 141 * @brief 备份或者恢复任务结束后，用于清理当前应用的临时目录(./backup目录下的backup和restore目录)的数据 142 * 143 * @param bundleName 应用名称 144 * @return ErrCode 规范错误码 145 */ 146 ErrCode CleanBundleTempDir(const std::string &bundleName); 147 148 /** 149 * @brief 获取备份或恢复的应用的兼容性信息 150 * 151 * @param bundleName 应用名称 152 * @param extInfo 导入给应用的信息 153 * @param compatInfo 应用返回的兼容信息 154 * @return ErrCode 规范错误码 155 */ 156 ErrCode GetCompatibilityInfo(const std::string &bundleName, const std::string &extInfo, std::string &compatInfo); 157 158 public: 159 ~BSessionRestore(); 160 161 private: 162 sptr<SvcDeathRecipient> deathRecipient_; 163 }; 164 } // namespace OHOS::FileManagement::Backup 165 166 #endif // OHOS_FILEMGMT_BACKUP_B_SESSION_RESTORE_H