• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 #ifndef OHOS_CLOUD_FILE_DATA_SYNC_MANAGER_H
16 #define OHOS_CLOUD_FILE_DATA_SYNC_MANAGER_H
17 
18 #include <bitset>
19 #include <memory>
20 
21 #include "data_sync_const.h"
22 #include "i_cloud_download_callback.h"
23 #include "i_cloud_optimize_callback.h"
24 #include "i_cloud_sync_callback.h"
25 #include "i_downgrade_dl_callback.h"
26 
27 namespace OHOS::FileManagement::CloudFile {
28 class DataSyncManager {
29 public:
30     using BundleNameUserInfo = CloudSync::BundleNameUserInfo;
31     using SyncTriggerType = CloudSync::SyncTriggerType;
32     DataSyncManager() = default;
33     virtual ~DataSyncManager() = default;
34 
35     virtual int32_t TriggerStartSync(const std::string &bundleName,
36                                      const int32_t userId,
37                                      bool forceFlag,
38                                      SyncTriggerType triggerType,
39                                      std::string prepareTraceId = "");
40     virtual int32_t TriggerStopSync(const std::string &bundleName, const int32_t userId,
41                                     bool forceFlag, SyncTriggerType triggerType);
42     virtual int32_t StopSyncSynced(const std::string &bundleName, const int32_t userId,
43                                         bool forceFlag, SyncTriggerType triggerType);
44     virtual int32_t TriggerRecoverySync(SyncTriggerType triggerType);
45     virtual int32_t StopUploadTask(const std::string &bundleName, const int32_t userId);
46     virtual int32_t ResetCursor(const std::string &bundleName, const int32_t &userId);
47     virtual void RegisterCloudSyncCallback(const std::string &bundleName,
48                                            const std::string &callerBundleName,
49                                            const int32_t userId,
50                                            const sptr<CloudSync::ICloudSyncCallback> &callback);
51     virtual void UnRegisterCloudSyncCallback(const std::string &bundleName, const std::string &callerBundleName);
52     virtual int32_t IsSkipSync(const std::string &bundleName, const int32_t userId, bool forceFlag);
53     virtual int32_t StartDownloadFile(const BundleNameUserInfo &bundleNameUserInfo,
54                                       const std::vector<std::string> &uriVec,
55                                       int64_t &downloadId,
56                                       int32_t fieldkey,
57                                       const sptr<CloudSync::ICloudDownloadCallback> &downloadCallback,
58                                       int32_t timeout = -1);
59     virtual int32_t StopDownloadFile(const BundleNameUserInfo &bundleNameUserInfo,
60                                      int64_t downloadId,
61                                      bool needClean,
62                                      int32_t timeout = -1);
63     virtual int32_t CleanCloudFile(const int32_t userId, const std::string &bundleName, const int action);
64     virtual int32_t CleanRemainFile(const std::string &bundleName, const int32_t userId);
65     virtual int32_t OptimizeStorage(const std::string &bundleName, const int32_t userId, const int32_t agingDays);
66     virtual int32_t StartOptimizeStorage(const BundleNameUserInfo &bundleNameUserInfo,
67         const CloudSync::OptimizeSpaceOptions &optimizeOptions,
68         const sptr<CloudSync::ICloudOptimizeCallback> &optimizeCallback);
69     virtual int32_t StopOptimizeStorage(const BundleNameUserInfo &bundleNameUserInfo);
70     virtual int32_t OptimizeCache(const int32_t userId, const std::string &bundleName);
71     virtual int32_t BatchCleanFile(const std::vector<CloudSync::CleanFileInfo> &fileInfo,
72         std::vector<std::string> &failCloudId);
73     virtual int32_t DownloadThumb();
74     virtual int32_t TriggerDownloadThumb();
75     virtual int32_t CacheVideo();
76     virtual int32_t CleanVideoCache();
77     virtual int32_t CleanCache(const std::string &bundleName, const int32_t userId, const std::string &uri);
78     virtual int32_t BatchDentryFileInsert(const std::vector<CloudSync::DentryFileInfo> &fileInfo,
79         std::vector<std::string> &failCloudId);
80     virtual int32_t DisableCloud(const int32_t userId);
81     virtual int32_t GetUserId(int32_t &userId);
82     virtual int32_t SaveSubscription(const std::string &bundleName, const int32_t userId);
83     virtual int32_t ReportEntry(const std::string &bundleName, const int32_t userId);
84     virtual int32_t ChangeAppSwitch(const std::string &bundleName, const int32_t userId, bool status);
85     virtual int32_t StartDowngrade(const std::string &bundleName,
86                                    const sptr<CloudSync::IDowngradeDlCallback> &downloadCallback);
87     virtual int32_t StopDowngrade(const std::string &bundleName);
88     virtual int32_t GetCloudFileInfo(const std::string &bundleName, CloudSync::CloudFileInfo &cloudFileInfo);
89     // file version
90     virtual int32_t GetHistoryVersionList(const BundleNameUserInfo &bundleNameUserInfo, const std::string &uri,
91                                           const int32_t versionNumLimit,
92                                           std::vector<CloudSync::HistoryVersion> &historyVersionList);
93     virtual int32_t DownloadHistoryVersion(const BundleNameUserInfo &bundleNameUserInfo, const std::string &uri,
94                                            int64_t &downloadId, const uint64_t versionId,
95                                            const sptr<CloudSync::ICloudDownloadCallback> &downloadCallback,
96                                            std::string &versionUri);
97     virtual int32_t ReplaceFileWithHistoryVersion(const BundleNameUserInfo &bundleNameUserInfo, const std::string &uri,
98                                                   const std::string &versionUri);
99     virtual int32_t IsFileConflict(const BundleNameUserInfo &bundleNameUserInfo, const std::string &uri,
100                                    bool &isConflict);
101     virtual int32_t ClearFileConflict(const BundleNameUserInfo &bundleNameUserInfo, const std::string &uri);
102 };
103 } // namespace OHOS::FileManagement::CloudFile
104 
105 #endif // OHOS_CLOUD_FILE_DATA_SYNC_MANAGER_H