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_I_SERVICE_H 17 #define OHOS_FILEMGMT_BACKUP_I_SERVICE_H 18 19 #include <string> 20 #include <tuple> 21 22 #include <unique_fd.h> 23 24 #include "b_file_info.h" 25 #include "b_incremental_data.h" 26 #include "i_service_ipc_interface_code.h" 27 #include "i_service_reverse.h" 28 #include "iremote_broker.h" 29 30 namespace OHOS::FileManagement::Backup { 31 const int DEFAULT_INVAL_VALUE = -1; 32 33 typedef enum TypeRestoreTypeEnum { 34 RESTORE_DATA_WAIT_SEND = 0, 35 RESTORE_DATA_READDY = 1, 36 } RestoreTypeEnum; 37 38 enum BackupRestoreScenario { 39 FULL_BACKUP = 0, 40 INCREMENTAL_BACKUP = 1, 41 FULL_RESTORE = 2, 42 INCREMENTAL_RESTORE = 3, 43 }; 44 45 class IService : public IRemoteBroker { 46 public: 47 virtual ~IService() = default; 48 virtual ErrCode InitRestoreSession(sptr<IServiceReverse> remote) = 0; 49 virtual ErrCode InitBackupSession(sptr<IServiceReverse> remote) = 0; 50 virtual ErrCode Start() = 0; 51 virtual UniqueFd GetLocalCapabilities() = 0; 52 virtual ErrCode PublishFile(const BFileInfo &fileInfo) = 0; 53 virtual ErrCode AppFileReady(const std::string &fileName, UniqueFd fd, int32_t errCode) = 0; 54 virtual ErrCode AppDone(ErrCode errCode) = 0; 55 virtual ErrCode ServiceResultReport(const std::string restoreRetInfo, 56 BackupRestoreScenario scenario, ErrCode errCode) = 0; 57 virtual ErrCode GetFileHandle(const std::string &bundleName, const std::string &fileName) = 0; 58 virtual ErrCode AppendBundlesRestoreSession(UniqueFd fd, 59 const std::vector<BundleName> &bundleNames, 60 const std::vector<std::string> &detailInfos, 61 RestoreTypeEnum restoreType = RestoreTypeEnum::RESTORE_DATA_WAIT_SEND, 62 int32_t userId = DEFAULT_INVAL_VALUE) = 0; 63 virtual ErrCode AppendBundlesRestoreSession(UniqueFd fd, 64 const std::vector<BundleName> &bundleNames, 65 RestoreTypeEnum restoreType = RestoreTypeEnum::RESTORE_DATA_WAIT_SEND, 66 int32_t userId = DEFAULT_INVAL_VALUE) = 0; 67 virtual ErrCode AppendBundlesBackupSession(const std::vector<BundleName> &bundleNames) = 0; 68 virtual ErrCode AppendBundlesDetailsBackupSession(const std::vector<BundleName> &bundleNames, 69 const std::vector<std::string> &bundleInfos) = 0; 70 virtual ErrCode Finish() = 0; 71 virtual ErrCode Release() = 0; 72 virtual UniqueFd GetLocalCapabilitiesIncremental(const std::vector<BIncrementalData> &bundleNames) = 0; 73 virtual ErrCode GetAppLocalListAndDoIncrementalBackup() = 0; 74 virtual ErrCode InitIncrementalBackupSession(sptr<IServiceReverse> remotse) = 0; 75 virtual ErrCode AppendBundlesIncrementalBackupSession(const std::vector<BIncrementalData> &bundlesToBackup) = 0; 76 virtual ErrCode AppendBundlesIncrementalBackupSession(const std::vector<BIncrementalData> &bundlesToBackup, 77 const std::vector<std::string> &bundleInfos) = 0; 78 79 virtual ErrCode PublishIncrementalFile(const BFileInfo &fileInfo) = 0; 80 virtual ErrCode PublishSAIncrementalFile(const BFileInfo &fileInfo, UniqueFd fd) = 0; 81 virtual ErrCode AppIncrementalFileReady(const std::string &fileName, UniqueFd fd, UniqueFd manifestFd, 82 int32_t errCode) = 0; 83 virtual ErrCode AppIncrementalDone(ErrCode errCode) = 0; 84 virtual ErrCode GetIncrementalFileHandle(const std::string &bundleName, const std::string &fileName) = 0; 85 virtual ErrCode GetBackupInfo(BundleName &bundleName, std::string &result) = 0; 86 virtual ErrCode UpdateTimer(BundleName &bundleName, uint32_t timeout, bool &result) = 0; 87 virtual ErrCode UpdateSendRate(std::string &bundleName, int32_t sendRate, bool &result) = 0; 88 virtual ErrCode ReportAppProcessInfo(const std::string processInfo, const BackupRestoreScenario sennario) = 0; 89 virtual ErrCode StartExtTimer(bool &isExtStart) = 0; 90 virtual ErrCode StartFwkTimer(bool &isFwkStart) = 0; 91 92 DECLARE_INTERFACE_DESCRIPTOR(u"OHOS.Filemanagement.Backup.IService") 93 }; 94 } // namespace OHOS::FileManagement::Backup 95 96 #endif // OHOS_FILEMGMT_BACKUP_I_SERVICE_H