1 /*
2  * Copyright (c) 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_INCREMENTAL_RESTORE_RESTORE_H
17 #define OHOS_FILEMGMT_BACKUP_B_INCREMENTAL_RESTORE_RESTORE_H
18 
19 #include <functional>
20 #include <memory>
21 #include <vector>
22 
23 #include "b_file_info.h"
24 #include "b_incremental_data.h"
25 #include "errors.h"
26 #include "svc_death_recipient.h"
27 #include "unique_fd.h"
28 
29 namespace OHOS::FileManagement::Backup {
30 class BIncrementalRestoreSession {
31 public:
32     struct Callbacks {
33         std::function<void(const BFileInfo &, UniqueFd, UniqueFd, ErrCode)> onFileReady; // 当备份服务有文件待发送时执行的回调
34         std::function<void(ErrCode, const BundleName)> onBundleStarted; // 当启动某个应用的恢复流程结束时执行的回调函数
35         std::function<void(ErrCode, const BundleName)>
36             onBundleFinished; // 当某个应用的恢复流程结束或意外中止时执行的回调函数
37         std::function<void(ErrCode)> onAllBundlesFinished; // 当整个恢复流程结束或意外中止时执行的回调函数
38         std::function<void(const std::string, const std::string)> onResultReport; // 某个应用恢复流程中自定义错误信息的上报的回调函数
39         std::function<void()> onBackupServiceDied;         // 当备份服务意外死亡时执行的回调函数
40         std::function<void(const std::string, const std::string)> onProcess; // 上报备份恢复过程中的进度和异常
41     };
42 
43 public:
44     /**
45      * @brief 获取一个用于控制恢复流程的会话
46      *
47      * @param callbacks 注册的回调函数
48      * @return std::unique_ptr<BRestoreSession> 指向BRestoreSession的智能指针。失败时为空指针
49      */
50     static std::unique_ptr<BIncrementalRestoreSession> Init(Callbacks callbacks);
51 
52     /**
53      * @brief 通知备份服务文件内容已就绪
54      *
55      * @param fileInfo 文件描述信息
56      * @return ErrCode 规范错误码
57      * @see GetFileHandle
58      */
59     ErrCode PublishFile(BFileInfo fileInfo);
60 
61     /**
62      * @brief 通知备份服务SA文件内容已就绪
63      *
64      * @param fileInfo 文件描述信息
65      * @param fd 文件描述符
66      * @return ErrCode 规范错误码
67      * @see GetFileHandle
68      */
69     ErrCode PublishSAFile(BFileInfo fileInfo, UniqueFd fd);
70 
71     /**
72      * @brief 请求恢复流程所需的真实文件
73      *
74      * @param bundleName 应用名称
75      * @param fileName   文件名称
76      */
77     ErrCode GetFileHandle(const std::string &bundleName, const std::string &fileName);
78 
79     /**
80      * @brief 用于追加应用,现阶段仅支持在Start之前调用
81      *
82      * @param remoteCap 已打开的保存远端设备能力的Json文件。可使用GetLocalCapabilities方法获取
83      * @param bundlesToRestore 待恢复的应用清单
84      * @param detailInfos bundle对应的单双映射关系json串
85      *
86      * @return ErrCode 规范错误码
87      */
88     ErrCode AppendBundles(UniqueFd remoteCap, std::vector<BundleName> bundlesToRestore,
89         std::vector<std::string> detailInfos);
90 
91     /**
92      * @brief 用于追加应用,现阶段仅支持在Start之前调用
93      *
94      * @param remoteCap 已打开的保存远端设备能力的Json文件。可使用GetLocalCapabilities方法获取
95      * @param bundlesToRestore 待恢复的应用清单
96      * @return ErrCode 规范错误码
97      */
98     ErrCode AppendBundles(UniqueFd remoteCap, std::vector<BundleName> bundlesToRestore);
99 
100     /**
101      * @brief 用于结束服务
102      *
103      * @return ErrCode 规范错误码
104      */
105     ErrCode Release();
106 
107     /**
108      * @brief 注册备份服务意外死亡时执行的回调函数
109      *
110      * @param functor 回调函数
111      */
112     void RegisterBackupServiceDied(std::function<void()> functor);
113 
114 public:
115     ~BIncrementalRestoreSession();
116 
117 private:
118     sptr<SvcDeathRecipient> deathRecipient_;
119 };
120 } // namespace OHOS::FileManagement::Backup
121 
122 #endif // OHOS_FILEMGMT_BACKUP_B_INCREMENTAL_RESTORE_RESTORE_H