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_BACKUP_H
17 #define OHOS_FILEMGMT_BACKUP_B_SESSION_BACKUP_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 BSessionBackup {
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<BSessionBackup> 指向会话的智能指针。失败时为空指针
47      */
48     static std::unique_ptr<BSessionBackup> Init(Callbacks callbacks);
49 
50     /**
51      * @brief 用于追加应用，现阶段仅支持在Start之前调用
52      *
53      * @param bundlesToBackup 待备份的应用清单
54      *
55      * @return ErrCode 规范错误码
56      */
57     ErrCode AppendBundles(std::vector<BundleName> bundlesToBackup);
58 
59     /**
60      * @brief 用于追加应用，现阶段仅支持在Start之前调用
61      *
62      * @param bundlesToBackup 待备份的应用清单
63      * @param detailInfos 备份所需信息
64      *
65      * @return ErrCode 规范错误码
66      */
67     ErrCode AppendBundles(std::vector<BundleName> bundlesToBackup, std::vector<std::string> detailInfos);
68 
69     /**
70      * @brief 用于结束追加应用，结束后不可在调用AppendBundles
71      *
72      * @return ErrCode 规范错误码
73      */
74     ErrCode Finish();
75 
76     /**
77      * @brief 用于启动备份流程
78      *
79      * @return ErrCode 规范错误码
80      */
81     ErrCode Start();
82 
83     /**
84      * @brief 用于结束服务
85      *
86      * @return ErrCode 规范错误码
87      */
88     ErrCode Release();
89 
90     /**
91      * @brief 注册备份服务意外死亡时执行的回调函数
92      *
93      * @param functor 回调函数
94      */
95     void RegisterBackupServiceDied(std::function<void()> functor);
96 
97 public:
98     ~BSessionBackup();
99 
100 private:
101     sptr<SvcDeathRecipient> deathRecipient_;
102 };
103 } // namespace OHOS::FileManagement::Backup
104 
105 #endif // OHOS_FILEMGMT_BACKUP_B_SESSION_BACKUP_H