1 /*
2 * Copyright (C) 2023 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_MEDIA_CLONE_RESTORE_H
17 #define OHOS_MEDIA_CLONE_RESTORE_H
18
19 #include <optional>
20 #include <type_traits>
21 #include <set>
22 #include <sstream>
23 #include <algorithm>
24 #include <iterator>
25 #include <vector>
26
27 #include "base_restore.h"
28 #include "backup_const.h"
29 #include "medialibrary_rdb_utils.h"
30 #include "medialibrary_errno.h"
31 #include "backup_database_utils.h"
32 #include "photo_album_clone.h"
33 #include "photos_clone.h"
34
35 namespace OHOS {
36 namespace Media {
37 class CloneRestore : public BaseRestore {
38 public:
39 CloneRestore() = default;
40 virtual ~CloneRestore() = default;
41 // upgradePath is useless now
42 void StartRestore(const std::string &backupRestorePath, const std::string &upgradePath) override;
43 int32_t Init(const std::string &backupRestoreDir, const std::string &upgradeFilePath, bool isUpgrade) override;
44 NativeRdb::ValuesBucket GetInsertValue(const FileInfo &fileInfo, const std::string &newPath,
45 int32_t sourceType) override;
46 std::string GetBackupInfo() override;
47 using CoverUriInfo = std::pair<std::string, std::pair<std::string, int32_t>>;
48
49 private:
50 void RestorePhoto(void) override;
51 void HandleRestData(void) override;
52 std::vector<FileInfo> QueryFileInfos(int32_t offset, int32_t isRelatedToPhotoMap = 0);
53 bool ParseResultSet(const std::shared_ptr<NativeRdb::ResultSet> &resultSet, FileInfo &info,
54 std::string dbName = "") override;
55 bool ParseResultSetForAudio(const std::shared_ptr<NativeRdb::ResultSet> &resultSet, FileInfo &info) override;
56 void AnalyzeSource() override;
57 void RestoreAlbum(void);
58 void RestoreAudio(void) override;
59 void InsertPhoto(std::vector<FileInfo> &fileInfos);
60 std::vector<NativeRdb::ValuesBucket> GetInsertValues(int32_t sceneCode, std::vector<FileInfo> &fileInfos,
61 int32_t sourceType);
62 std::vector<NativeRdb::ValuesBucket> GetInsertValues(std::vector<AnalysisAlbumTbl> &analysisAlbumTbl);
63 int32_t MoveAsset(FileInfo &fileInfo);
64 bool IsFilePathExist(const std::string &filePath) const;
65 int32_t QueryTotalNumber(const std::string &tableName);
66 std::vector<AlbumInfo> QueryAlbumInfos(const std::string &tableName, int32_t offset);
67 bool ParseAlbumResultSet(const std::string &tableName, const std::shared_ptr<NativeRdb::ResultSet> &resultSet,
68 AlbumInfo &albumInfo);
69 bool PrepareCommonColumnInfoMap(const std::string &tableName,
70 const std::unordered_map<std::string, std::string> &srcColumnInfoMap,
71 const std::unordered_map<std::string, std::string> &dstColumnInfoMap);
72 bool HasSameColumn(const std::unordered_map<std::string, std::string> &columnInfoMap, const std::string &columnName,
73 const std::string &columnType);
74 void GetValFromResultSet(const std::shared_ptr<NativeRdb::ResultSet> &resultSet,
75 std::unordered_map<std::string, std::variant<int32_t, int64_t, double, std::string>> &valMap,
76 const std::string &columnName, const std::string &columnType);
77 void PrepareCommonColumnVal(NativeRdb::ValuesBucket &values, const std::string &columnName,
78 const std::variant<int32_t, int64_t, double, std::string> &columnVal,
79 const std::unordered_map<std::string, std::string> &commonColumnInfoMap) const;
80 void GetQueryWhereClause(const std::string &tableName,
81 const std::unordered_map<std::string, std::string> &columnInfoMap);
82 void BatchQueryPhoto(std::vector<FileInfo> &fileInfos);
83 void BatchNotifyPhoto(const std::vector<FileInfo> &fileInfos);
84 void InsertAlbum(std::vector<AlbumInfo> &albumInfos, const std::string &tableName);
85 std::vector<NativeRdb::ValuesBucket> GetInsertValues(std::vector<AlbumInfo> &albumInfos,
86 const std::string &tableName);
87 bool HasSameAlbum(const AlbumInfo &albumInfo, const std::string &tableName);
88 void BatchQueryAlbum(std::vector<AlbumInfo> &albumInfos, const std::string &tableName);
89 void BatchInsertMap(const std::vector<FileInfo> &fileInfos, int64_t &totalRowNum);
90 NativeRdb::ValuesBucket GetInsertValue(const MapInfo &mapInfo) const;
91 NativeRdb::ValuesBucket GetInsertValue(const AlbumInfo &albumInfo, const std::string &tableName) const;
92 void CheckTableColumnStatus(std::shared_ptr<NativeRdb::RdbStore> rdbStore,
93 const std::vector<std::vector<std::string>> &cloneTableList);
94 bool HasColumns(const std::unordered_map<std::string, std::string> &columnInfoMap,
95 const std::unordered_set<std::string> &columnSet);
96 bool HasColumn(const std::unordered_map<std::string, std::string> &columnInfoMap, const std::string &columnName);
97 void GetAlbumExtraQueryWhereClause(const std::string &tableName);
98 bool IsReadyForRestore(const std::string &tableName);
99 void UpdateAlbumToNotifySet(const std::string &tableName, const std::unordered_set<int32_t> &albumSet);
100 void NotifyAlbum();
101 void PrepareEditTimeVal(NativeRdb::ValuesBucket &values, int64_t editTime, const FileInfo &fileInfo,
102 const std::unordered_map<std::string, std::string> &commonColumnInfoMap) const;
103 void RestoreGallery();
104 bool PrepareCloudPath(const std::string &tableName, FileInfo &fileInfo);
105 void RestoreMusic();
106 std::vector<FileInfo> QueryFileInfos(const std::string &tableName, int32_t offset);
107 bool ParseResultSet(const std::string &tableName, const std::shared_ptr<NativeRdb::ResultSet> &resultSet,
108 FileInfo &fileInfo);
109 void InsertAudio(std::vector<FileInfo> &fileInfos);
110 int32_t QueryTotalNumberByMediaType(std::shared_ptr<NativeRdb::RdbStore> rdbStore, const std::string &tableName,
111 MediaType mediaType);
112 std::string GetBackupInfoByCount(int32_t photoCount, int32_t videoCount, int32_t audioCount);
113 void MoveMigrateFile(std::vector<FileInfo> &fileInfos, int64_t &fileMoveCount, int64_t &videoFileMoveCount);
114 void RestorePhotoBatch(int32_t offset, int32_t isRelatedToPhotoMap = 0);
115 void RestoreAudioBatch(int32_t offset);
116 void InsertPhotoRelated(std::vector<FileInfo> &fileInfos);
117 void SetFileIdReference(const std::vector<FileInfo> &fileInfos, std::string &selection,
118 std::unordered_map<int32_t, int32_t> &fileIdMap);
119 int32_t QueryMapTotalNumber(const std::string &baseQuerySql);
120 std::vector<MapInfo> QueryMapInfos(const std::string &tableName, const std::string &baseQuerySql, int32_t offset,
121 const std::unordered_map<int32_t, int32_t> &fileIdMap, const std::unordered_map<int32_t, int32_t> &albumIdMap);
122 int64_t InsertMapByTable(const std::string &tableName, const std::vector<MapInfo> &mapInfos,
123 std::unordered_set<int32_t> &albumSet);
124 std::vector<NativeRdb::ValuesBucket> GetInsertValues(const std::vector<MapInfo> &mapInfos);
125 std::string GetQueryWhereClauseByTable(const std::string &tableName);
126 void SetSpecialAttributes(const std::string &tableName, const std::shared_ptr<NativeRdb::ResultSet> &resultSet,
127 FileInfo &fileInfo);
128 bool IsSameFileForClone(const std::string &tableName, FileInfo &fileInfo);
129 int32_t MovePicture(FileInfo &fileInfo);
130 int32_t MoveMovingPhotoVideo(FileInfo &fileInfo);
131 NativeRdb::ValuesBucket GetInsertValue(const AnalysisAlbumTbl &portraitAlbumInfo);
132 int32_t InsertPortraitAlbumByTable(std::vector<AnalysisAlbumTbl> &analysisAlbumTbl);
133 void InsertPortraitAlbum(std::vector<AnalysisAlbumTbl> &analysisAlbumTbl);
134 void ParsePortraitAlbumResultSet(const std::shared_ptr<NativeRdb::ResultSet> &resultSet,
135 AnalysisAlbumTbl &analysisAlbumTbl);
136 std::vector<AnalysisAlbumTbl> QueryPortraitAlbumTbl(int32_t offset,
137 const std::vector<std::string>& commonColumns);
138 void RestoreFromGalleryPortraitAlbum();
139 int32_t QueryPortraitAlbumTotalNumber(std::shared_ptr<NativeRdb::RdbStore> rdbPtr, std::string query);
140 std::unordered_map<std::string, std::string> CreateImgFaceColumnFieldMap();
141 void ParseImageFaceResultSet(const std::shared_ptr<NativeRdb::ResultSet> &resultSet, ImageFaceTbl &imageFaceTbl);
142 void ParseFaceTagResultSet(const std::shared_ptr<NativeRdb::ResultSet> &resultSet, FaceTagTbl &faceTagTbl);
143 NativeRdb::ValuesBucket CreateValuesBucketFromImageFaceTbl(const ImageFaceTbl& imageFaceTbl);
144 void BatchInsertImageFaces(const std::vector<ImageFaceTbl>& imageFaceTbls);
145 std::vector<ImageFaceTbl> ProcessImageFaceTbls(const std::vector<ImageFaceTbl>& imageFaceTbls,
146 const std::vector<FileIdPair>& fileIdPairs);
147 std::vector<ImageFaceTbl> QueryImageFaceTbl(int32_t offset, std::string &fileIdClause,
148 const std::vector<std::string>& commonColumns);
149 std::vector<PortraitAlbumDfx> QueryAllPortraitAlbum(int32_t& offset, int32_t& rowCount);
150 void RecordOldPortraitAlbumDfx();
151 std::unordered_set<std::string> QueryAllPortraitAlbum();
152 void LogPortraitCloneDfx();
153 void RestoreImageFaceInfo(std::vector<FileInfo> &fileInfos);
154 NativeRdb::ValuesBucket CreateValuesBucketFromFaceTagTbl(const FaceTagTbl& faceTagTbl);
155 void BatchInsertFaceTags(const std::vector<FaceTagTbl>& faceTagTbls);
156 void DeleteExistingFaceTagData(const std::string& inClause);
157 std::vector<FaceTagTbl> QueryFaceTagTbl(int32_t offset, std::vector<std::string> &commonColumns);
158 void RestorePortraitClusteringInfo();
159 void ReportPortraitCloneStat(int32_t sceneCode);
160 void AppendExtraWhereClause(std::string& whereClause, const std::string& tableName);
161 void GenNewCoverUris(const std::vector<CoverUriInfo>& coverUriInfo,
162 std::vector<FileInfo> &fileInfos);
163 bool GetFileInfoByFileId(int32_t fileId, const std::vector<FileInfo>& fileInfos, FileInfo& outFileInfo);
164 std::string GenCoverUriUpdateSql(const std::unordered_map<std::string, std::pair<std::string, int32_t>>&
165 tagIdToCoverInfo, const std::unordered_map<std::string, int32_t>& oldToNewFileId,
166 const std::vector<FileInfo>& fileInfos, std::vector<std::string>& tagIds);
167 std::string ProcessUriAndGenNew(const std::string& tagId, const std::string& oldCoverUri,
168 const std::unordered_map<std::string, int32_t>& oldToNewFileId, const std::vector<FileInfo>& fileInfos);
169
170 template<typename T>
171 static void PutIfPresent(NativeRdb::ValuesBucket& values, const std::string& columnName,
172 const std::optional<T>& optionalValue);
173
174 template<typename T>
175 void PutWithDefault(NativeRdb::ValuesBucket& values, const std::string& columnName,
176 const std::optional<T>& optionalValue, const T& defaultValue);
177 int32_t MoveEditedData(FileInfo &fileInfo);
178
179 private:
180 std::atomic<uint64_t> migrateDatabaseAlbumNumber_{0};
181 std::atomic<uint64_t> migrateDatabaseMapNumber_{0};
182 std::shared_ptr<NativeRdb::RdbStore> mediaRdb_;
183 std::string filePath_;
184 std::string dbPath_;
185 std::unordered_map<std::string, bool> tableColumnStatusMap_;
186 std::unordered_map<std::string, std::string> tableQueryWhereClauseMap_;
187 std::unordered_map<std::string, std::string> tableExtraQueryWhereClauseMap_;
188 std::unordered_map<std::string, std::unordered_map<int32_t, int32_t>> tableAlbumIdMap_;
189 std::unordered_map<std::string, std::unordered_map<std::string, std::string>> tableCommonColumnInfoMap_;
190 std::unordered_set<std::string> albumToNotifySet_;
191 std::string garbagePath_;
192 std::vector<CoverUriInfo> coverUriInfo_;
193 std::vector<PortraitAlbumDfx> portraitAlbumDfx_;
194 PhotoAlbumClone photoAlbumClone_;
195 PhotosClone photosClone_;
196 static constexpr int32_t INVALID_COVER_SATISFIED_STATUS = -1;
197 };
198
199 template<typename T>
PutIfPresent(NativeRdb::ValuesBucket & values,const std::string & columnName,const std::optional<T> & optionalValue)200 void CloneRestore::PutIfPresent(NativeRdb::ValuesBucket& values, const std::string& columnName,
201 const std::optional<T>& optionalValue)
202 {
203 if (optionalValue.has_value()) {
204 if constexpr (std::is_same_v<std::decay_t<T>, int32_t>) {
205 values.PutInt(columnName, optionalValue.value());
206 } else if constexpr (std::is_same_v<std::decay_t<T>, int64_t>) {
207 values.PutLong(columnName, optionalValue.value());
208 } else if constexpr (std::is_same_v<std::decay_t<T>, std::string>) {
209 values.PutString(columnName, optionalValue.value());
210 } else if constexpr (std::is_same_v<std::decay_t<T>, double>) {
211 values.PutDouble(columnName, optionalValue.value());
212 }
213 }
214 }
215
216 template<typename T>
PutWithDefault(NativeRdb::ValuesBucket & values,const std::string & columnName,const std::optional<T> & optionalValue,const T & defaultValue)217 void CloneRestore::PutWithDefault(NativeRdb::ValuesBucket& values, const std::string& columnName,
218 const std::optional<T>& optionalValue, const T& defaultValue)
219 {
220 if (optionalValue.has_value()) {
221 PutIfPresent(values, columnName, optionalValue);
222 } else {
223 PutIfPresent(values, columnName, std::optional<T>(defaultValue));
224 }
225 }
226 } // namespace Media
227 } // namespace OHOS
228
229 #endif // OHOS_MEDIA_CLONE_RESTORE_H
230