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 #include "media_library_db_upgrade.h"
16
17 #include <string>
18 #include <vector>
19
20 #include "rdb_store.h"
21 #include "media_log.h"
22 #include "album_plugin_table_event_handler.h"
23 #include "db_upgrade_utils.h"
24 #include "medialibrary_rdb_transaction.h"
25
26 namespace OHOS::Media {
27 namespace DataTransfer {
28 /**
29 * @brief Upgrade the database, before data restore or clone.
30 */
OnUpgrade(NativeRdb::RdbStore & store)31 int32_t MediaLibraryDbUpgrade::OnUpgrade(NativeRdb::RdbStore &store)
32 {
33 int32_t ret = NativeRdb::E_OK;
34 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::OnUpgrade start");
35 ret = this->UpgradeAlbumPlugin(store);
36 if (ret != NativeRdb::E_OK) {
37 return ret;
38 }
39 ret = this->UpgradePhotoAlbum(store);
40 if (ret != NativeRdb::E_OK) {
41 return ret;
42 }
43 ret = this->UpgradePhotos(store);
44 if (ret != NativeRdb::E_OK) {
45 return ret;
46 }
47 ret = this->UpgradePhotoMap(store);
48 if (ret != NativeRdb::E_OK) {
49 return ret;
50 }
51 ret = this->MergeAlbumFromOldBundleNameToNewBundleName(store);
52 if (ret != NativeRdb::E_OK) {
53 return ret;
54 }
55 ret = this->UpgradePhotosBelongsToAlbum(store);
56 if (ret != NativeRdb::E_OK) {
57 return ret;
58 }
59 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::OnUpgrade end");
60 return NativeRdb::E_OK;
61 }
62
ExecSqlsInternal(NativeRdb::RdbStore & store,const std::string & sql,const std::vector<NativeRdb::ValueObject> & args)63 int32_t MediaLibraryDbUpgrade::ExecSqlsInternal(NativeRdb::RdbStore &store, const std::string &sql,
64 const std::vector<NativeRdb::ValueObject> &args)
65 {
66 int currentTime = 0;
67 int32_t busyRetryTime = 0;
68 int32_t err = NativeRdb::E_OK;
69 while (busyRetryTime < MAX_BUSY_TRY_TIMES && currentTime <= MAX_TRY_TIMES) {
70 err = store.ExecuteSql(sql, args);
71 if (err == NativeRdb::E_OK) {
72 break;
73 } else if (err == NativeRdb::E_SQLITE_LOCKED) {
74 std::this_thread::sleep_for(std::chrono::milliseconds(TRANSACTION_WAIT_INTERVAL));
75 currentTime++;
76 MEDIA_ERR_LOG("ExecuteSqlInternal busy, ret:%{public}d, time:%{public}d", err, currentTime);
77 } else if (err == NativeRdb::E_SQLITE_BUSY || err == NativeRdb::E_DATABASE_BUSY) {
78 busyRetryTime++;
79 MEDIA_ERR_LOG("ExecuteSqlInternal busy, ret:%{public}d, busyRetryTime:%{public}d", err, busyRetryTime);
80 } else {
81 MEDIA_ERR_LOG("ExecuteSqlInternal faile, ret = %{public}d", err);
82 break;
83 }
84 }
85 return err;
86 }
87
MergeAlbumFromOldBundleNameToNewBundleName(NativeRdb::RdbStore & store)88 int32_t MediaLibraryDbUpgrade::MergeAlbumFromOldBundleNameToNewBundleName(NativeRdb::RdbStore &store)
89 {
90 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::MergeAlbumFromOldBundleNameToNewBundleName start");
91 int32_t ret = NativeRdb::E_OK;
92 for (const auto &executeSql : this->SQL_MERGE_ALBUM_FROM_OLD_BUNDLE_NAME_TO_NEW_BUNDLE_NAME) {
93 ret = ExecSqlsInternal(store, executeSql);
94 if (ret != NativeRdb::E_OK) {
95 MEDIA_ERR_LOG("Media_Restore: executeSql failed, sql: %{public}s", executeSql.c_str());
96 return ret;
97 }
98 }
99 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::MergeAlbumFromOldBundleNameToNewBundleName end");
100 return NativeRdb::E_OK;
101 }
102
UpgradePhotosBelongsToAlbum(NativeRdb::RdbStore & store)103 int32_t MediaLibraryDbUpgrade::UpgradePhotosBelongsToAlbum(NativeRdb::RdbStore &store)
104 {
105 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::UpgradePhotosBelongsToAlbum start");
106 int32_t ret = NativeRdb::E_OK;
107 for (const auto &executeSql : this->SQL_PHOTOS_NEED_TO_BELONGS_TO_ALBUM) {
108 ret = ExecSqlsInternal(store, executeSql);
109 if (ret != NativeRdb::E_OK) {
110 MEDIA_ERR_LOG("Media_Restore: executeSql failed, sql: %{public}s", executeSql.c_str());
111 return ret;
112 }
113 }
114 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::UpgradePhotosBelongsToAlbum end");
115 return NativeRdb::E_OK;
116 }
117
118 /**
119 * @brief Upgrade album_plugin table.
120 */
UpgradeAlbumPlugin(NativeRdb::RdbStore & store)121 int32_t MediaLibraryDbUpgrade::UpgradeAlbumPlugin(NativeRdb::RdbStore &store)
122 {
123 if (this->dbUpgradeUtils_.IsTableExists(store, "album_plugin")) {
124 return NativeRdb::E_OK;
125 }
126 AlbumPluginTableEventHandler handler;
127 return handler.OnUpgrade(store, 0, 0);
128 }
129
130 /**
131 * @brief Upgrade PhotoAlbum table.
132 */
UpgradePhotoAlbum(NativeRdb::RdbStore & store)133 int32_t MediaLibraryDbUpgrade::UpgradePhotoAlbum(NativeRdb::RdbStore &store)
134 {
135 int32_t ret = NativeRdb::E_OK;
136 ret = this->AddlPathColumn(store);
137 if (ret != NativeRdb::E_OK) {
138 return ret;
139 }
140 ret = this->DropPhotoAlbumTrigger(store);
141 if (ret != NativeRdb::E_OK) {
142 return ret;
143 }
144 return this->UpdatelPathColumn(store);
145 }
146
147 /**
148 * @brief Drop PhotoAlbum trigger.
149 */
DropPhotoAlbumTrigger(NativeRdb::RdbStore & store)150 int32_t MediaLibraryDbUpgrade::DropPhotoAlbumTrigger(NativeRdb::RdbStore &store)
151 {
152 std::vector<std::string> executeSqls = this->SQL_PHOTO_ALBUM_TABLE_DROP_TRIGGER;
153 int ret = NativeRdb::E_OK;
154 MEDIA_INFO_LOG("DropPhotoAlbumTrigger begin");
155 auto [errCode, transaction] = store.CreateTransaction(OHOS::NativeRdb::Transaction::DEFERRED);
156 if (errCode != NativeRdb::E_OK || transaction == nullptr) {
157 MEDIA_ERR_LOG("transaction failed, err:%{public}d", errCode);
158 return errCode;
159 }
160 for (const std::string &executeSql : executeSqls) {
161 auto res = transaction->Execute(executeSql);
162 ret = res.first;
163 if (ret != NativeRdb::E_OK) {
164 transaction->Rollback();
165 MEDIA_ERR_LOG(
166 "Media_Restore: DropPhotoAlbumTrigger failed, ret=%{public}d, sql=%{public}s", ret, executeSql.c_str());
167 return ret;
168 }
169 }
170 errCode = transaction->Commit();
171 if (errCode != NativeRdb::E_OK) {
172 MEDIA_ERR_LOG("DropPhotoAlbumTrigger commit fail");
173 }
174 return NativeRdb::E_OK;
175 }
176
177 /**
178 * @brief Upgrade the lpath column in PhotoAlbum table.
179 */
UpdatelPathColumn(NativeRdb::RdbStore & store)180 int32_t MediaLibraryDbUpgrade::UpdatelPathColumn(NativeRdb::RdbStore &store)
181 {
182 std::string executeSql = this->SQL_PHOTO_ALBUM_TABLE_UPDATE_LPATH_COLUMN;
183 int32_t ret = ExecSqlsInternal(store, executeSql);
184 if (ret != NativeRdb::E_OK) {
185 MEDIA_ERR_LOG("Media_Restore: MediaLibraryDbUpgrade::UpdatelPathColumn failed, ret=%{public}d, sql=%{public}s",
186 ret,
187 executeSql.c_str());
188 return ret;
189 }
190 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::UpdatelPathColumn success");
191 return ret;
192 }
193
194 /**
195 * @brief Add owner_album_id column to Photos table.
196 */
AddOwnerAlbumIdColumn(NativeRdb::RdbStore & store)197 int32_t MediaLibraryDbUpgrade::AddOwnerAlbumIdColumn(NativeRdb::RdbStore &store)
198 {
199 if (this->dbUpgradeUtils_.IsColumnExists(store, "Photos", "owner_album_id")) {
200 return NativeRdb::E_OK;
201 }
202 std::string sql = this->SQL_PHOTOS_TABLE_ADD_OWNER_ALBUM_ID;
203 int32_t ret = ExecSqlsInternal(store, sql);
204 if (ret != NativeRdb::E_OK) {
205 MEDIA_ERR_LOG(
206 "Media_Restore: MediaLibraryDbUpgrade::AddOwnerAlbumIdColumn failed, ret=%{public}d, sql=%{public}s",
207 ret,
208 sql.c_str());
209 }
210 MEDIA_INFO_LOG("Media_Restore: MediaLibraryDbUpgrade::AddOwnerAlbumIdColumn success");
211 return ret;
212 }
213
214 /**
215 * @brief Add lpath column to PhotoAlbum table.
216 */
AddlPathColumn(NativeRdb::RdbStore & store)217 int32_t MediaLibraryDbUpgrade::AddlPathColumn(NativeRdb::RdbStore &store)
218 {
219 if (this->dbUpgradeUtils_.IsColumnExists(store, "PhotoAlbum", "lpath")) {
220 return NativeRdb::E_OK;
221 }
222 std::string sql = this->SQL_PHOTO_ALBUM_TABLE_ADD_LPATH_COLUMN;
223 return ExecSqlsInternal(store, sql);
224 }
225
226 /**
227 * @brief Move the single relationship from PhotoMap table to Photos table, stored in owner_album_id.
228 */
MoveSingleRelationshipToPhotos(NativeRdb::RdbStore & store)229 int32_t MediaLibraryDbUpgrade::MoveSingleRelationshipToPhotos(NativeRdb::RdbStore &store)
230 {
231 std::vector<std::string> executeSqls = {this->SQL_TEMP_PHOTO_MAP_TABLE_DROP, this->SQL_TEMP_PHOTO_MAP_TABLE_CREATE};
232 executeSqls.insert(executeSqls.end(),
233 this->SQL_TEMP_PHOTO_MAP_TABLE_CREATE_INDEX_ARRAY.begin(),
234 this->SQL_TEMP_PHOTO_MAP_TABLE_CREATE_INDEX_ARRAY.end());
235 executeSqls.insert(executeSqls.end(),
236 this->SQL_PHOTOS_TABLE_DROP_TRIGGER_ARRAY.begin(),
237 this->SQL_PHOTOS_TABLE_DROP_TRIGGER_ARRAY.end());
238 executeSqls.push_back(this->SQL_PHOTOS_TABLE_UPDATE_ALBUM_ID);
239 executeSqls.insert(executeSqls.end(),
240 this->SQL_PHOTO_MAP_TABLE_DROP_TRIGGER_ARRAY.begin(),
241 this->SQL_PHOTO_MAP_TABLE_DROP_TRIGGER_ARRAY.end());
242 executeSqls.push_back(this->SQL_PHOTO_MAP_TABLE_DELETE_SINGLE_RELATIONSHIP);
243 executeSqls.push_back(this->SQL_TEMP_PHOTO_MAP_TABLE_DROP);
244 int ret = NativeRdb::E_OK;
245 MEDIA_INFO_LOG("MoveSingleRelationshipToPhotos begin");
246 auto [errCode, transaction] = store.CreateTransaction(OHOS::NativeRdb::Transaction::DEFERRED);
247 if (errCode != NativeRdb::E_OK || transaction == nullptr) {
248 MEDIA_ERR_LOG("transaction failed, err:%{public}d", errCode);
249 return errCode;
250 }
251 for (const std::string &executeSql : executeSqls) {
252 auto res = transaction->Execute(executeSql);
253 ret = res.first;
254 if (ret != NativeRdb::E_OK) {
255 MEDIA_ERR_LOG("Media_Restore: MoveSingleRelationshipToPhotos failed, ret=%{public}d, sql=%{public}s",
256 ret,
257 executeSql.c_str());
258 transaction->Rollback();
259 return ret;
260 }
261 }
262 ret = transaction->Commit();
263 if (ret != NativeRdb::E_OK) {
264 MEDIA_ERR_LOG("MoveSingleRelationshipToPhotos: tans finish fail!, ret:%{public}d", ret);
265 transaction->Rollback();
266 }
267 return NativeRdb::E_OK;
268 }
269
270 /**
271 * @brief Upgrade Photos table.
272 */
UpgradePhotos(NativeRdb::RdbStore & store)273 int32_t MediaLibraryDbUpgrade::UpgradePhotos(NativeRdb::RdbStore &store)
274 {
275 int32_t ret = NativeRdb::E_OK;
276 ret = this->AddOwnerAlbumIdColumn(store);
277 if (ret != NativeRdb::E_OK) {
278 return ret;
279 }
280 return NativeRdb::E_OK;
281 }
282
283 /**
284 * @brief Upgrade PhotoMap table.
285 */
UpgradePhotoMap(NativeRdb::RdbStore & store)286 int32_t MediaLibraryDbUpgrade::UpgradePhotoMap(NativeRdb::RdbStore &store)
287 {
288 int32_t ret = NativeRdb::E_OK;
289 ret = this->MoveSingleRelationshipToPhotos(store);
290 if (ret != NativeRdb::E_OK) {
291 return ret;
292 }
293 return NativeRdb::E_OK;
294 }
295 } // namespace DataTransfer
296 } // namespace OHOS::Media