1 /* 2 * Copyright (C) 2021-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 INTERFACES_KITS_JS_MEDIALIBRARY_INCLUDE_MEDIALIBRARY_NAPI_UTILS_H_ 17 #define INTERFACES_KITS_JS_MEDIALIBRARY_INCLUDE_MEDIALIBRARY_NAPI_UTILS_H_ 18 19 #include <memory> 20 #include <set> 21 #include <vector> 22 23 #include "datashare_predicates.h" 24 #include "datashare_result_set.h" 25 #include "file_asset.h" 26 #include "location_column.h" 27 #include "media_column.h" 28 #include "medialibrary_db_const.h" 29 #include "medialibrary_napi_log.h" 30 #include "napi/native_api.h" 31 #include "napi/native_node_api.h" 32 #include "photo_album_column.h" 33 #include "rdb_store.h" 34 35 #ifdef NAPI_ASSERT 36 #undef NAPI_ASSERT 37 #endif 38 39 #define CHECK_ARGS_WITH_MESSAGE(env, cond, msg) \ 40 do { \ 41 if (!(cond)) { \ 42 NapiError::ThrowError(env, JS_ERR_PARAMETER_INVALID, __FUNCTION__, __LINE__, msg); \ 43 return nullptr; \ 44 } \ 45 } while (0) 46 47 #define CHECK_COND_WITH_MESSAGE(env, cond, msg) \ 48 do { \ 49 if (!(cond)) { \ 50 NapiError::ThrowError(env, OHOS_INVALID_PARAM_CODE, __FUNCTION__, __LINE__, msg); \ 51 return nullptr; \ 52 } \ 53 } while (0) 54 55 #define NAPI_ASSERT(env, cond, msg) CHECK_ARGS_WITH_MESSAGE(env, cond, msg) 56 57 #define GET_JS_ARGS(env, info, argc, argv, thisVar) \ 58 do { \ 59 void *data; \ 60 napi_get_cb_info(env, info, &(argc), argv, &(thisVar), &(data)); \ 61 } while (0) 62 63 #define GET_JS_OBJ_WITH_ZERO_ARGS(env, info, status, thisVar) \ 64 do { \ 65 void *data; \ 66 status = napi_get_cb_info(env, info, nullptr, nullptr, &(thisVar), &(data)); \ 67 } while (0) 68 69 #define GET_JS_ASYNC_CB_REF(env, arg, count, cbRef) \ 70 do { \ 71 napi_valuetype valueType = napi_undefined; \ 72 if ((napi_typeof(env, arg, &valueType) == napi_ok) && (valueType == napi_function)) { \ 73 napi_create_reference(env, arg, count, &(cbRef)); \ 74 } else { \ 75 NAPI_ERR_LOG("invalid arguments"); \ 76 NAPI_ASSERT(env, false, "type mismatch"); \ 77 } \ 78 } while (0) 79 80 #define ASSERT_NULLPTR_CHECK(env, result) \ 81 do { \ 82 if ((result) == nullptr) { \ 83 napi_get_undefined(env, &(result)); \ 84 return result; \ 85 } \ 86 } while (0) 87 88 #define NAPI_CREATE_PROMISE(env, callbackRef, deferred, result) \ 89 do { \ 90 if ((callbackRef) == nullptr) { \ 91 napi_create_promise(env, &(deferred), &(result)); \ 92 } \ 93 } while (0) 94 95 #define NAPI_CREATE_RESOURCE_NAME(env, resource, resourceName, context) \ 96 do { \ 97 napi_create_string_utf8(env, resourceName, NAPI_AUTO_LENGTH, &(resource)); \ 98 (context)->SetApiName(resourceName); \ 99 } while (0) 100 101 #define CHECK_NULL_PTR_RETURN_UNDEFINED(env, ptr, ret, message) \ 102 do { \ 103 if ((ptr) == nullptr) { \ 104 NAPI_ERR_LOG(message); \ 105 napi_get_undefined(env, &(ret)); \ 106 return ret; \ 107 } \ 108 } while (0) 109 110 #define CHECK_NULL_PTR_RETURN_VOID(ptr, message) \ 111 do { \ 112 if ((ptr) == nullptr) { \ 113 NAPI_ERR_LOG(message); \ 114 return; \ 115 } \ 116 } while (0) 117 #define CHECK_IF_EQUAL(condition, errMsg, ...) \ 118 do { \ 119 if (!(condition)) { \ 120 NAPI_ERR_LOG(errMsg, ##__VA_ARGS__); \ 121 return; \ 122 } \ 123 } while (0) 124 125 #define CHECK_COND_RET(cond, ret, message, ...) \ 126 do { \ 127 if (!(cond)) { \ 128 NAPI_ERR_LOG(message, ##__VA_ARGS__); \ 129 return ret; \ 130 } \ 131 } while (0) 132 133 #define CHECK_STATUS_RET(cond, message) \ 134 do { \ 135 napi_status __ret = (cond); \ 136 if (__ret != napi_ok) { \ 137 NAPI_ERR_LOG(message); \ 138 return __ret; \ 139 } \ 140 } while (0) 141 142 #define CHECK_NULLPTR_RET(ret) \ 143 do { \ 144 if ((ret) == nullptr) { \ 145 return nullptr; \ 146 } \ 147 } while (0) 148 149 #define CHECK_ARGS_BASE(env, cond, err, retVal) \ 150 do { \ 151 if ((cond) != napi_ok) { \ 152 NapiError::ThrowError(env, err, __FUNCTION__, __LINE__); \ 153 return retVal; \ 154 } \ 155 } while (0) 156 157 #define CHECK_ARGS(env, cond, err) CHECK_ARGS_BASE(env, cond, err, nullptr) 158 159 #define CHECK_ARGS_THROW_INVALID_PARAM(env, cond) CHECK_ARGS(env, cond, OHOS_INVALID_PARAM_CODE) 160 161 #define CHECK_ARGS_RET_VOID(env, cond, err) CHECK_ARGS_BASE(env, cond, err, NAPI_RETVAL_NOTHING) 162 163 #define CHECK_COND(env, cond, err) \ 164 do { \ 165 if (!(cond)) { \ 166 NapiError::ThrowError(env, err, __FUNCTION__, __LINE__); \ 167 return nullptr; \ 168 } \ 169 } while (0) 170 171 #define RETURN_NAPI_TRUE(env) \ 172 do { \ 173 napi_value result = nullptr; \ 174 CHECK_ARGS(env, napi_get_boolean(env, true, &result), JS_INNER_FAIL); \ 175 return result; \ 176 } while (0) 177 178 #define RETURN_NAPI_UNDEFINED(env) \ 179 do { \ 180 napi_value result = nullptr; \ 181 CHECK_ARGS(env, napi_get_undefined(env, &result), JS_INNER_FAIL); \ 182 return result; \ 183 } while (0) 184 185 namespace OHOS { 186 namespace Media { 187 #define EXPORT __attribute__ ((visibility ("default"))) 188 189 /* Constants for array index */ 190 const int32_t PARAM0 = 0; 191 const int32_t PARAM1 = 1; 192 const int32_t PARAM2 = 2; 193 const int32_t PARAM3 = 3; 194 const int32_t PARAM4 = 4; 195 const int32_t PARAM5 = 5; 196 const int32_t PARAM6 = 6; 197 198 /* Constants for array size */ 199 const int32_t ARGS_ZERO = 0; 200 const int32_t ARGS_ONE = 1; 201 const int32_t ARGS_TWO = 2; 202 const int32_t ARGS_THREE = 3; 203 const int32_t ARGS_FOUR = 4; 204 const int32_t ARGS_FIVE = 5; 205 const int32_t ARGS_SIX = 6; 206 const int32_t ARGS_SEVEN = 7; 207 const int32_t ARG_BUF_SIZE = 384; // 256 for display name and 128 for relative path 208 constexpr uint32_t NAPI_INIT_REF_COUNT = 1; 209 210 constexpr size_t NAPI_ARGC_MAX = 6; 211 212 // Error codes 213 const int32_t ERR_DEFAULT = 0; 214 const int32_t ERR_MEM_ALLOCATION = 2; 215 const int32_t ERR_INVALID_OUTPUT = 3; 216 217 const int32_t TRASH_SMART_ALBUM_ID = 1; 218 const std::string TRASH_SMART_ALBUM_NAME = "TrashAlbum"; 219 const int32_t FAVORIT_SMART_ALBUM_ID = 2; 220 const std::string FAVORIT_SMART_ALBUM_NAME = "FavoritAlbum"; 221 222 const std::string API_VERSION = "api_version"; 223 224 const std::string PENDING_STATUS = "pending"; 225 226 enum NapiAssetType { 227 TYPE_DEFAULT = 0, 228 TYPE_AUDIO = 1, 229 TYPE_PHOTO = 2, 230 TYPE_ALBUM = 3, 231 }; 232 233 enum AlbumType { 234 TYPE_VIDEO_ALBUM = 0, 235 TYPE_IMAGE_ALBUM = 1, 236 TYPE_NONE = 2, 237 }; 238 239 enum FetchOptionType { 240 ASSET_FETCH_OPT = 0, 241 ALBUM_FETCH_OPT = 1 242 }; 243 244 enum HiddenPhotosDisplayMode { 245 ASSETS_MODE = 0, 246 ALBUMS_MODE = 1 247 }; 248 249 const std::vector<std::string> deliveryModeEnum { 250 "FAST_MODE", "HIGH_QUALITY_MODE", "BALANCE_MODE" 251 }; 252 253 const std::vector<std::string> sourceModeEnum { 254 "ORIGINAL_MODE", "EDITED_MODE" 255 }; 256 257 const std::vector<std::string> privateAlbumTypeNameEnum { 258 "TYPE_FAVORITE", "TYPE_TRASH", "TYPE_HIDE", "TYPE_SMART", "TYPE_SEARCH" 259 }; 260 261 const std::vector<std::string> AuthorizationModeEnum { 262 "SHORT_TIME_AUTHORIZATION" 263 }; 264 265 const std::vector<std::string> HIDDEN_PHOTOS_DISPLAY_MODE_ENUM { 266 "ASSETS_MODE", "ALBUMS_MODE" 267 }; 268 269 const std::vector<std::string> mediaTypesEnum { 270 "FILE", "IMAGE", "VIDEO", "AUDIO", "MEDIA", "ALBUM_LIST", "ALBUM_LIST_INFO" 271 }; 272 273 const std::vector<std::string> mediaTypesUserFileEnum { 274 "IMAGE", "VIDEO", "AUDIO" 275 }; 276 277 const std::vector<std::string> fileKeyEnum { 278 "ID", "RELATIVE_PATH", "DISPLAY_NAME", "PARENT", "MIME_TYPE", "MEDIA_TYPE", "SIZE", 279 "DATE_ADDED", "DATE_MODIFIED", "DATE_TAKEN", "TITLE", "ARTIST", "AUDIOALBUM", "DURATION", 280 "WIDTH", "HEIGHT", "ORIENTATION", "ALBUM_ID", "ALBUM_NAME" 281 }; 282 283 const std::vector<std::string> directoryEnum { 284 "DIR_CAMERA", "DIR_VIDEO", "DIR_IMAGE", "DIR_AUDIO", "DIR_DOCUMENTS", "DIR_DOWNLOAD" 285 }; 286 287 const std::vector<std::string> virtualAlbumTypeEnum { 288 "TYPE_FAVORITE", "TYPE_TRASH" 289 }; 290 291 const std::vector<std::string> directoryEnumValues { 292 "Camera/", "Videos/", "Pictures/", "Audios/", "Documents/", "Download/" 293 }; 294 295 const std::vector<std::string> systemAlbumSubType { 296 "FAVORITE", "VIDEO", "HIDDEN", "TRASH", "SCREENSHOT", "CAMERA", "IMAGE", "CLOUD_ENHANCEMENT" 297 }; 298 299 const std::vector<std::string> analysisAlbumSubType { 300 "GEOGRAPHY_LOCATION", "GEOGRAPHY_CITY", "SHOOTING_MODE", "PORTRAIT", "GROUP_PHOTO", 301 "HIGHLIGHT", "HIGHLIGHT_SUGGESTIONS" 302 }; 303 304 const std::vector<std::string> positionTypeEnum { 305 "LOCAL", "CLOUD", "BOTH" 306 }; 307 308 const std::vector<std::string> photoSubTypeEnum { 309 "DEFAULT", "SCREENSHOT", "CAMERA", "MOVING_PHOTO" 310 }; 311 312 const std::vector<std::string> photoPermissionTypeEnum { 313 "TEMPORARY_READ_IMAGEVIDEO", "PERSISTENT_READ_IMAGEVIDEO" 314 }; 315 316 const std::vector<std::string> hideSensitiveTypeEnum { 317 "HIDE_LOCATION_AND_SHOOTING_PARAM", "HIDE_LOCATION_ONLY", "HIDE_SHOOTING_PARAM_ONLY", "NO_HIDE_SENSITIVE_TYPE" 318 }; 319 320 const std::vector<std::string> notifyTypeEnum { 321 "NOTIFY_ADD", "NOTIFY_UPDATE", "NOTIFY_REMOVE", "NOTIFY_ALBUM_ADD_ASSET", "NOTIFY_ALBUM_REMOVE_ASSET" 322 }; 323 324 const std::vector<std::string> requestPhotoTypeEnum { 325 "REQUEST_ALL_THUMBNAILS", "REQUEST_FAST_THUMBNAIL", "REQUEST_QUALITY_THUMBNAIL" 326 }; 327 328 const std::vector<std::string> resourceTypeEnum { 329 "IMAGE_RESOURCE", "VIDEO_RESOURCE", "PHOTO_PROXY", "PRIVATE_MOVING_PHOTO_RESOURCE" 330 }; 331 332 const std::vector<std::string> dynamicRangeTypeEnum { 333 "SDR", "HDR" 334 }; 335 336 const std::vector<std::string> movingPhotoEffectModeEnum { 337 "DEFAULT", "BOUNCE_PLAY", "LOOP_PLAY", "LONG_EXPOSURE", "MULTI_EXPOSURE", "CINEMA_GRAPH" 338 }; 339 340 const std::vector<std::string> imageFileTypeEnum { 341 "JPEG", "HEIF" 342 }; 343 344 const std::vector<std::string> cloudEnhancementTaskStageEnum { 345 "TASK_STAGE_EXCEPTION", "TASK_STAGE_PREPARING", "TASK_STAGE_UPLOADING", 346 "TASK_STAGE_EXECUTING", "TASK_STAGE_DOWNLOADING", "TASK_STAGE_FAILED", "TASK_STAGE_COMPLETED" 347 }; 348 349 const std::vector<std::string> cloudEnhancementStateEnum { 350 "UNAVAILABLE", "AVAILABLE", "EXECUTING", "COMPLETED" 351 }; 352 353 const std::vector<std::string> videoEnhancementTypeEnum { 354 "QUALITY_ENHANCEMENT_LOCAL", "QUALITY_ENHANCEMENT_CLOUD", "QUALITY_ENHANCEMENT_LOCAL_AND_CLOUD" 355 }; 356 357 const std::vector<std::string> fileKeyEnumValues { 358 MEDIA_DATA_DB_ID, 359 MEDIA_DATA_DB_RELATIVE_PATH, 360 MEDIA_DATA_DB_NAME, 361 MEDIA_DATA_DB_PARENT_ID, 362 MEDIA_DATA_DB_MIME_TYPE, 363 MEDIA_DATA_DB_MEDIA_TYPE, 364 MEDIA_DATA_DB_SIZE, 365 MEDIA_DATA_DB_DATE_ADDED, 366 MEDIA_DATA_DB_DATE_MODIFIED, 367 MEDIA_DATA_DB_DATE_TAKEN, 368 MEDIA_DATA_DB_TITLE, 369 MEDIA_DATA_DB_ARTIST, 370 MEDIA_DATA_DB_AUDIO_ALBUM, 371 MEDIA_DATA_DB_DURATION, 372 MEDIA_DATA_DB_WIDTH, 373 MEDIA_DATA_DB_HEIGHT, 374 MEDIA_DATA_DB_ORIENTATION, 375 MEDIA_DATA_DB_BUCKET_ID, 376 MEDIA_DATA_DB_BUCKET_NAME 377 }; 378 379 const std::vector<std::pair<std::string, std::string>> FILE_KEY_ENUM_PROPERTIES = { 380 std::make_pair("ID", MEDIA_DATA_DB_ID), 381 std::make_pair("RELATIVE_PATH", MEDIA_DATA_DB_RELATIVE_PATH), 382 std::make_pair("DISPLAY_NAME", MEDIA_DATA_DB_NAME), 383 std::make_pair("PARENT", MEDIA_DATA_DB_PARENT_ID), 384 std::make_pair("MIME_TYPE", MEDIA_DATA_DB_MIME_TYPE), 385 std::make_pair("MEDIA_TYPE", MEDIA_DATA_DB_MEDIA_TYPE), 386 std::make_pair("SIZE", MEDIA_DATA_DB_SIZE), 387 std::make_pair("DATE_ADDED", MEDIA_DATA_DB_DATE_ADDED), 388 std::make_pair("DATE_MODIFIED", MEDIA_DATA_DB_DATE_MODIFIED), 389 std::make_pair("DATE_TAKEN", MEDIA_DATA_DB_DATE_TAKEN), 390 std::make_pair("TITLE", MEDIA_DATA_DB_TITLE), 391 std::make_pair("ARTIST", MEDIA_DATA_DB_ARTIST), 392 std::make_pair("AUDIOALBUM", MEDIA_DATA_DB_AUDIO_ALBUM), 393 std::make_pair("DURATION", MEDIA_DATA_DB_DURATION), 394 std::make_pair("WIDTH", MEDIA_DATA_DB_WIDTH), 395 std::make_pair("HEIGHT", MEDIA_DATA_DB_HEIGHT), 396 std::make_pair("ORIENTATION", MEDIA_DATA_DB_ORIENTATION), 397 std::make_pair("ALBUM_ID", MEDIA_DATA_DB_BUCKET_ID), 398 std::make_pair("ALBUM_NAME", MEDIA_DATA_DB_BUCKET_NAME) 399 }; 400 401 const std::vector<std::pair<std::string, std::string>> USERFILEMGR_FILEKEY_ENUM_PROPERTIES = { 402 std::make_pair("URI", MEDIA_DATA_DB_URI), 403 std::make_pair("RELATIVE_PATH", MEDIA_DATA_DB_RELATIVE_PATH), 404 std::make_pair("DISPLAY_NAME", MEDIA_DATA_DB_NAME), 405 std::make_pair("DATE_ADDED", MEDIA_DATA_DB_DATE_ADDED), 406 std::make_pair("DATE_MODIFIED", MEDIA_DATA_DB_DATE_MODIFIED), 407 std::make_pair("TITLE", MEDIA_DATA_DB_TITLE) 408 }; 409 410 const std::vector<std::pair<std::string, std::string>> AUDIOKEY_ENUM_PROPERTIES = { 411 std::make_pair("URI", MEDIA_DATA_DB_URI), 412 std::make_pair("DISPLAY_NAME", MEDIA_DATA_DB_NAME), 413 std::make_pair("DATE_ADDED", MEDIA_DATA_DB_DATE_ADDED), 414 std::make_pair("DATE_MODIFIED", MEDIA_DATA_DB_DATE_MODIFIED), 415 std::make_pair("TITLE", MEDIA_DATA_DB_TITLE), 416 std::make_pair("ARTIST", MEDIA_DATA_DB_ARTIST), 417 std::make_pair("AUDIOALBUM", MEDIA_DATA_DB_AUDIO_ALBUM), 418 std::make_pair("DURATION", MEDIA_DATA_DB_DURATION), 419 std::make_pair("FAVORITE", MEDIA_DATA_DB_IS_FAV), 420 std::make_pair("SIZE", MediaColumn::MEDIA_SIZE), 421 std::make_pair("PACKAGE_NAME", MediaColumn::MEDIA_PACKAGE_NAME) 422 }; 423 424 const std::vector<std::pair<std::string, std::string>> IMAGEVIDEOKEY_ENUM_PROPERTIES = { 425 std::make_pair("URI", MEDIA_DATA_DB_URI), 426 std::make_pair("DISPLAY_NAME", MediaColumn::MEDIA_NAME), 427 std::make_pair("DATE_ADDED", MediaColumn::MEDIA_DATE_ADDED), 428 std::make_pair("FILE_TYPE", MediaColumn::MEDIA_TYPE), 429 std::make_pair("PHOTO_TYPE", MediaColumn::MEDIA_TYPE), 430 std::make_pair("DATE_MODIFIED", MediaColumn::MEDIA_DATE_MODIFIED), 431 std::make_pair("TITLE", MediaColumn::MEDIA_TITLE), 432 std::make_pair("DURATION", MediaColumn::MEDIA_DURATION), 433 std::make_pair("WIDTH", PhotoColumn::PHOTO_WIDTH), 434 std::make_pair("HEIGHT", PhotoColumn::PHOTO_HEIGHT), 435 std::make_pair("DATE_TAKEN", MediaColumn::MEDIA_DATE_TAKEN), 436 std::make_pair("DATE_TAKEN_MS", MEDIA_DATA_DB_DATE_TAKEN_MS), 437 std::make_pair("DETAIL_TIME", PhotoColumn::PHOTO_DETAIL_TIME), 438 std::make_pair("ORIENTATION", PhotoColumn::PHOTO_ORIENTATION), 439 std::make_pair("FAVORITE", MediaColumn::MEDIA_IS_FAV), 440 std::make_pair("MEDIA_TYPE", MediaColumn::MEDIA_TYPE), 441 std::make_pair("DATE_TRASHED", MediaColumn::MEDIA_DATE_TRASHED), 442 std::make_pair("POSITION", PhotoColumn::PHOTO_POSITION), 443 std::make_pair("HIDDEN", MediaColumn::MEDIA_HIDDEN), 444 std::make_pair("SIZE", MediaColumn::MEDIA_SIZE), 445 std::make_pair("PACKAGE_NAME", MediaColumn::MEDIA_PACKAGE_NAME), 446 std::make_pair("CAMERA_SHOT_KEY", PhotoColumn::CAMERA_SHOT_KEY), 447 std::make_pair("USER_COMMENT", PhotoColumn::PHOTO_USER_COMMENT), 448 std::make_pair("DATE_YEAR", PhotoColumn::PHOTO_DATE_YEAR), 449 std::make_pair("DATE_MONTH", PhotoColumn::PHOTO_DATE_MONTH), 450 std::make_pair("DATE_DAY", PhotoColumn::PHOTO_DATE_DAY), 451 std::make_pair("PENDING", PENDING_STATUS), 452 std::make_pair("DATE_ADDED_MS", MEDIA_DATA_DB_DATE_ADDED_MS), 453 std::make_pair("DATE_MODIFIED_MS", MEDIA_DATA_DB_DATE_MODIFIED_MS), 454 std::make_pair("DATE_TRASHED_MS", MEDIA_DATA_DB_DATE_TRASHED_MS), 455 std::make_pair("PHOTO_SUBTYPE", PhotoColumn::PHOTO_SUBTYPE), 456 std::make_pair("DYNAMIC_RANGE_TYPE", PhotoColumn::PHOTO_DYNAMIC_RANGE_TYPE), 457 std::make_pair("LCD_SIZE", PhotoColumn::PHOTO_LCD_SIZE), 458 std::make_pair("THM_SIZE", PhotoColumn::PHOTO_THUMB_SIZE), 459 std::make_pair("MOVING_PHOTO_EFFECT_MODE", PhotoColumn::MOVING_PHOTO_EFFECT_MODE), 460 std::make_pair("COVER_POSITION", PhotoColumn::PHOTO_COVER_POSITION), 461 std::make_pair("BURST_COVER_LEVEL", PhotoColumn::PHOTO_BURST_COVER_LEVEL), 462 std::make_pair("BURST_KEY", PhotoColumn::PHOTO_BURST_KEY), 463 std::make_pair("THUMBNAIL_READY", PhotoColumn::PHOTO_THUMBNAIL_READY), 464 std::make_pair("CE_AVAILABLE", PhotoColumn::PHOTO_CE_AVAILABLE), 465 std::make_pair("OWNER_ALBUM_ID", PhotoColumn::PHOTO_OWNER_ALBUM_ID), 466 std::make_pair("THUMBNAIL_VISIBLE", PhotoColumn::PHOTO_THUMBNAIL_VISIBLE), 467 }; 468 469 const std::vector<std::pair<std::string, std::string>> ALBUMKEY_ENUM_PROPERTIES = { 470 std::make_pair("URI", MEDIA_DATA_DB_URI), 471 std::make_pair("ALBUM_NAME", PhotoAlbumColumns::ALBUM_NAME), 472 std::make_pair("FILE_TYPE", MEDIA_DATA_DB_MEDIA_TYPE), 473 std::make_pair("DATE_ADDED", MEDIA_DATA_DB_DATE_ADDED), 474 std::make_pair("DATE_MODIFIED", MEDIA_DATA_DB_DATE_MODIFIED), 475 }; 476 477 const std::vector<std::pair<std::string, std::string>> DEFAULT_URI_ENUM_PROPERTIES = { 478 std::make_pair("DEFAULT_PHOTO_URI", PhotoColumn::DEFAULT_PHOTO_URI), 479 std::make_pair("DEFAULT_ALBUM_URI", PhotoAlbumColumns::DEFAULT_PHOTO_ALBUM_URI), 480 std::make_pair("DEFAULT_AUDIO_URI", AudioColumn::DEFAULT_AUDIO_URI), 481 std::make_pair("DEFAULT_HIDDEN_ALBUM_URI", PhotoAlbumColumns::DEFAULT_HIDDEN_ALBUM_URI), 482 }; 483 484 const std::map<std::string, std::pair<std::string, int32_t>> LOCATION_PARAM_MAP = { 485 { START_LATITUDE, { LATITUDE, DataShare::GREATER_THAN_OR_EQUAL_TO } }, 486 { END_LATITUDE, { LATITUDE, DataShare::LESS_THAN } }, 487 { START_LONGITUDE, { LONGITUDE, DataShare::GREATER_THAN_OR_EQUAL_TO } }, 488 { END_LONGITUDE, { LONGITUDE, DataShare::LESS_THAN } }, 489 { DIAMETER, { DIAMETER, DataShare::EQUAL_TO } }, 490 { LANGUAGE, { LANGUAGE, DataShare::EQUAL_TO } }, 491 }; 492 493 struct JSAsyncContextOutput { 494 napi_value error; 495 napi_value data; 496 bool status; 497 }; 498 499 struct NapiClassInfo { 500 std::string name; 501 napi_ref *ref; 502 napi_value (*constructor)(napi_env, napi_callback_info); 503 std::vector<napi_property_descriptor> props; 504 }; 505 506 const std::vector<std::string> ALBUM_COLUMN = { 507 PhotoAlbumColumns::ALBUM_ID, 508 PhotoAlbumColumns::ALBUM_TYPE, 509 PhotoAlbumColumns::ALBUM_SUBTYPE, 510 PhotoAlbumColumns::ALBUM_NAME, 511 PhotoAlbumColumns::ALBUM_COVER_URI, 512 PhotoAlbumColumns::ALBUM_COUNT, 513 PhotoAlbumColumns::ALBUM_IMAGE_COUNT, 514 PhotoAlbumColumns::ALBUM_VIDEO_COUNT, 515 }; 516 517 const std::vector<std::string> PHOTO_COLUMN = { 518 MEDIA_DATA_DB_ID, 519 MEDIA_DATA_DB_FILE_PATH, 520 MEDIA_DATA_DB_MEDIA_TYPE, 521 MEDIA_DATA_DB_NAME, 522 MEDIA_DATA_DB_SIZE, 523 MEDIA_DATA_DB_DATE_ADDED, 524 MEDIA_DATA_DB_DATE_MODIFIED, 525 MEDIA_DATA_DB_DURATION, 526 MEDIA_DATA_DB_WIDTH, 527 MEDIA_DATA_DB_HEIGHT, 528 MEDIA_DATA_DB_DATE_TAKEN, 529 MEDIA_DATA_DB_ORIENTATION, 530 MEDIA_DATA_DB_IS_FAV, 531 MEDIA_DATA_DB_TITLE, 532 MEDIA_DATA_DB_POSITION, 533 MEDIA_DATA_DB_DATE_TRASHED, 534 MediaColumn::MEDIA_HIDDEN, 535 PhotoColumn::PHOTO_USER_COMMENT, 536 PhotoColumn::CAMERA_SHOT_KEY, 537 PhotoColumn::PHOTO_DATE_YEAR, 538 PhotoColumn::PHOTO_DATE_MONTH, 539 PhotoColumn::PHOTO_DATE_DAY, 540 MEDIA_DATA_DB_TIME_PENDING, 541 PhotoColumn::PHOTO_SUBTYPE, 542 PhotoColumn::MOVING_PHOTO_EFFECT_MODE, 543 PhotoColumn::PHOTO_DYNAMIC_RANGE_TYPE, 544 PhotoColumn::PHOTO_THUMBNAIL_READY, 545 PhotoColumn::PHOTO_LCD_SIZE, 546 PhotoColumn::PHOTO_THUMB_SIZE, 547 }; 548 549 const std::set<std::string> TIME_COLUMN = { 550 MEDIA_DATA_DB_DATE_ADDED, 551 MEDIA_DATA_DB_DATE_MODIFIED, 552 MEDIA_DATA_DB_DATE_TRASHED, 553 }; 554 555 /* Util class used by napi asynchronous methods for making call to js callback function */ 556 class MediaLibraryNapiUtils { 557 public: GetTypeMap()558 static const std::unordered_map<std::string, std::pair<ResultSetDataType, std::string>> &GetTypeMap() 559 { 560 static const std::unordered_map<std::string, std::pair<ResultSetDataType, std::string>> TYPE_MAP = { 561 {MEDIA_DATA_DB_ID, {TYPE_INT32, "fileId"}}, 562 {MEDIA_DATA_DB_FILE_PATH, {TYPE_STRING, "data"}}, 563 {MEDIA_DATA_DB_MEDIA_TYPE, {TYPE_INT32, "mediaType"}}, 564 {MEDIA_DATA_DB_NAME, {TYPE_STRING, "displayName"}}, 565 {MEDIA_DATA_DB_SIZE, {TYPE_INT64, "size"}}, 566 {MEDIA_DATA_DB_DATE_ADDED, {TYPE_INT64, "dateAddedMs"}}, 567 {MEDIA_DATA_DB_DATE_MODIFIED, {TYPE_INT64, "dateModifiedMs"}}, 568 {MEDIA_DATA_DB_DURATION, {TYPE_INT64, "duration"}}, 569 {MEDIA_DATA_DB_WIDTH, {TYPE_INT32, "width"}}, 570 {MEDIA_DATA_DB_HEIGHT, {TYPE_INT32, "height"}}, 571 {MEDIA_DATA_DB_DATE_TAKEN, {TYPE_INT64, "dateTaken"}}, 572 {MEDIA_DATA_DB_ORIENTATION, {TYPE_INT32, "orientation"}}, 573 {MEDIA_DATA_DB_IS_FAV, {TYPE_INT32, "isFavorite"}}, 574 {MEDIA_DATA_DB_TITLE, {TYPE_STRING, "title"}}, 575 {MEDIA_DATA_DB_POSITION, {TYPE_INT32, "position"}}, 576 {MEDIA_DATA_DB_DATE_TRASHED, {TYPE_INT64, "dateTrashedMs"}}, 577 {MediaColumn::MEDIA_HIDDEN, {TYPE_INT32, "hidden"}}, 578 {PhotoColumn::PHOTO_USER_COMMENT, {TYPE_STRING, "userComment"}}, 579 {PhotoColumn::CAMERA_SHOT_KEY, {TYPE_STRING, "cameraShotKey"}}, 580 {PhotoColumn::PHOTO_DATE_YEAR, {TYPE_STRING, "dateYear"}}, 581 {PhotoColumn::PHOTO_DATE_MONTH, {TYPE_STRING, "dateMonth"}}, 582 {PhotoColumn::PHOTO_DATE_DAY, {TYPE_STRING, "dateDay"}}, 583 {MEDIA_DATA_DB_TIME_PENDING, {TYPE_INT64, "pending"}}, 584 {PhotoColumn::PHOTO_SUBTYPE, {TYPE_INT32, "subtype"}}, 585 {PhotoColumn::MOVING_PHOTO_EFFECT_MODE, {TYPE_INT32, "movingPhotoEffectMode"}}, 586 {PhotoColumn::PHOTO_DYNAMIC_RANGE_TYPE, {TYPE_INT32, "dynamicRangeType"}}, 587 {PhotoColumn::PHOTO_THUMBNAIL_READY, {TYPE_INT64, "thumbnailModifiedMs"}}, 588 {PhotoColumn::PHOTO_LCD_SIZE, {TYPE_STRING, "lcdSize"}}, 589 {PhotoColumn::PHOTO_THUMB_SIZE, {TYPE_STRING, "thmSize"}}, 590 {MEDIA_DATA_DB_COUNT, {TYPE_INT32, "count"}}, 591 {PhotoAlbumColumns::ALBUM_ID, {TYPE_INT32, "albumId"}}, 592 {PhotoAlbumColumns::ALBUM_TYPE, {TYPE_INT32, "albumType"}}, 593 {PhotoAlbumColumns::ALBUM_SUBTYPE, {TYPE_INT32, "albumSubType"}}, 594 {PhotoAlbumColumns::ALBUM_NAME, {TYPE_STRING, "albumName"}}, 595 {PhotoAlbumColumns::ALBUM_COVER_URI, {TYPE_STRING, "coverUri"}}, 596 {PhotoAlbumColumns::ALBUM_COUNT, {TYPE_INT32, "count"}}, 597 {PhotoAlbumColumns::ALBUM_IMAGE_COUNT, {TYPE_INT32, "imageCount"}}, 598 {PhotoAlbumColumns::ALBUM_VIDEO_COUNT, {TYPE_INT32, "videoCount"}}, 599 }; 600 return TYPE_MAP; 601 } 602 GetTimeTypeMap()603 static const std::unordered_map<std::string, std::pair<ResultSetDataType, std::string>>& GetTimeTypeMap() 604 { 605 static const std::unordered_map<std::string, std::pair<ResultSetDataType, std::string>> TIME_TYPE_MAP = { 606 {MEDIA_DATA_DB_DATE_ADDED, {TYPE_INT64, "dateAdded"}}, 607 {MEDIA_DATA_DB_DATE_MODIFIED, {TYPE_INT64, "dateModified"}}, 608 {MEDIA_DATA_DB_DATE_TRASHED, {TYPE_INT64, "dateTrashed"}}, 609 }; 610 return TIME_TYPE_MAP; 611 } 612 613 static napi_value NapiDefineClass(napi_env env, napi_value exports, const NapiClassInfo &info); 614 EXPORT static napi_value NapiAddStaticProps(napi_env env, napi_value exports, 615 const std::vector<napi_property_descriptor> &staticProps); 616 617 static napi_status GetUInt32(napi_env env, napi_value arg, uint32_t &value); 618 static napi_status GetInt32(napi_env env, napi_value arg, int32_t &value); 619 static napi_status GetDouble(napi_env env, napi_value arg, double &value); 620 static napi_status GetParamBool(napi_env env, napi_value arg, bool &result); 621 static napi_status GetUInt32Array(napi_env env, napi_value arg, std::vector<uint32_t> ¶m); 622 static napi_status GetParamFunction(napi_env env, napi_value arg, napi_ref &callbackRef); 623 static napi_status GetParamStringWithLength(napi_env env, napi_value arg, int32_t maxLen, 624 std::string &str); 625 static napi_status GetParamStringPathMax(napi_env env, napi_value arg, std::string &str); 626 static napi_status GetProperty(napi_env env, const napi_value arg, const std::string &propName, 627 std::string &propValue); 628 static napi_status GetArrayProperty(napi_env env, napi_value arg, const std::string &propName, 629 std::vector<std::string> &array); 630 static napi_status GetStringArray(napi_env env, napi_value arg, std::vector<std::string> &array); 631 static void UriAddTableName(std::string &uri, const std::string tableName); 632 static std::string GetFileIdFromUri(const std::string &uri); 633 static int32_t GetFileIdFromPhotoUri(const std::string &uri); 634 static MediaType GetMediaTypeFromUri(const std::string &uri); 635 template <class AsyncContext> 636 static napi_status GetPredicate(napi_env env, const napi_value arg, const std::string &propName, 637 AsyncContext &context, const FetchOptionType &fetchOptType); 638 template <class AsyncContext> 639 static napi_status ParseAlbumFetchOptCallback(napi_env env, napi_callback_info info, AsyncContext &context); 640 template <class AsyncContext> 641 static bool HandleSpecialPredicate(AsyncContext &context, 642 std::shared_ptr<DataShare::DataShareAbsPredicates> &predicate, const FetchOptionType &fetchOptType); 643 template <class AsyncContext> 644 static void UpdateMediaTypeSelections(AsyncContext *context); 645 646 template <class AsyncContext> 647 static napi_status AsyncContextSetObjectInfo(napi_env env, napi_callback_info info, AsyncContext &asyncContext, 648 const size_t minArgs, const size_t maxArgs); 649 650 template <class AsyncContext> 651 static napi_status AsyncContextGetArgs(napi_env env, napi_callback_info info, AsyncContext &asyncContext, 652 const size_t minArgs, const size_t maxArgs); 653 654 template <class AsyncContext> 655 static napi_status GetFetchOption(napi_env env, napi_value arg, const FetchOptionType &fetchOptType, 656 AsyncContext &context); 657 658 template <class AsyncContext> 659 static napi_status GetAlbumFetchOption(napi_env env, napi_value arg, const FetchOptionType &fetchOptType, 660 AsyncContext &context); 661 662 template <class AsyncContext> 663 static napi_status GetParamCallback(napi_env env, AsyncContext &context); 664 665 template <class AsyncContext> 666 static napi_status ParseAssetFetchOptCallback(napi_env env, napi_callback_info info, 667 AsyncContext &context); 668 669 template <class AsyncContext> 670 static napi_status ParseArgsBoolCallBack(napi_env env, napi_callback_info info, AsyncContext &context, bool ¶m); 671 672 template <class AsyncContext> 673 static napi_status ParseArgsStringCallback(napi_env env, napi_callback_info info, AsyncContext &context, 674 std::string ¶m); 675 template <class AsyncContext> 676 static napi_status ParseArgsStringArrayCallback(napi_env env, napi_callback_info info, 677 AsyncContext &context, std::vector<std::string> &array); 678 679 template <class AsyncContext> 680 static napi_status ParseArgsNumberCallback(napi_env env, napi_callback_info info, AsyncContext &context, 681 int32_t &value); 682 683 template <class AsyncContext> 684 static napi_status ParseArgsOnlyCallBack(napi_env env, napi_callback_info info, AsyncContext &context); 685 686 static AssetType GetAssetType(MediaType type); 687 688 static void AppendFetchOptionSelection(std::string &selection, const std::string &newCondition); 689 690 template <class AsyncContext> 691 static bool GetLocationPredicate(AsyncContext &context, 692 std::shared_ptr<DataShare::DataShareAbsPredicates> &predicate); 693 694 static int TransErrorCode(const std::string &Name, std::shared_ptr<DataShare::DataShareResultSet> resultSet); 695 696 static int TransErrorCode(const std::string &Name, int error); 697 698 static void HandleError(napi_env env, int error, napi_value &errorObj, const std::string &Name); 699 700 static void CreateNapiErrorObject(napi_env env, napi_value &errorObj, const int32_t errCode, 701 const std::string errMsg); 702 703 static void InvokeJSAsyncMethod(napi_env env, napi_deferred deferred, napi_ref callbackRef, napi_async_work work, 704 const JSAsyncContextOutput &asyncContext); 705 706 template <class AsyncContext> 707 static napi_value NapiCreateAsyncWork(napi_env env, std::unique_ptr<AsyncContext> &asyncContext, 708 const std::string &resourceName, void (*execute)(napi_env, void *), 709 void (*complete)(napi_env, napi_status, void *)); 710 711 static std::tuple<bool, std::unique_ptr<char[]>, size_t> ToUTF8String(napi_env env, napi_value value); 712 713 static bool IsExistsByPropertyName(napi_env env, napi_value jsObject, const char *propertyName); 714 715 static napi_value GetPropertyValueByName(napi_env env, napi_value jsObject, const char *propertyName); 716 717 static bool CheckJSArgsTypeAsFunc(napi_env env, napi_value arg); 718 719 static bool IsArrayForNapiValue(napi_env env, napi_value param, uint32_t &arraySize); 720 721 static napi_status HasCallback(napi_env env, const size_t argc, const napi_value argv[], 722 bool &isCallback); 723 724 static napi_value GetInt32Arg(napi_env env, napi_value arg, int32_t &value); 725 726 static napi_value GetDoubleArg(napi_env env, napi_value arg, double &value); 727 728 static void UriAppendKeyValue(std::string &uri, const std::string &key, const std::string &value); 729 730 static napi_value AddDefaultAssetColumns(napi_env env, std::vector<std::string> &fetchColumn, 731 std::function<bool(const std::string &columnName)> isValidColumn, NapiAssetType assetType, 732 const PhotoAlbumSubType subType = PhotoAlbumSubType::USER_GENERIC); 733 734 static int32_t GetSystemAlbumPredicates(const PhotoAlbumSubType subType, 735 DataShare::DataSharePredicates &predicates, const bool hiddenOnly); 736 static int32_t GetUserAlbumPredicates(const int32_t albumId, 737 DataShare::DataSharePredicates &predicates, const bool hiddenOnly); 738 static int32_t GetAnalysisAlbumPredicates(const int32_t albumId, DataShare::DataSharePredicates &predicates); 739 static int32_t GetFeaturedSinglePortraitAlbumPredicates( 740 const int32_t albumId, DataShare::DataSharePredicates &predicates); 741 static int32_t GetPortraitAlbumPredicates(const int32_t albumId, DataShare::DataSharePredicates &predicates); 742 static int32_t GetAllLocationPredicates(DataShare::DataSharePredicates &predicates); 743 static int32_t GetSourceAlbumPredicates(const int32_t albumId, DataShare::DataSharePredicates &predicates, 744 const bool hiddenOnly); 745 static bool IsFeaturedSinglePortraitAlbum(std::string albumName, DataShare::DataSharePredicates &predicates); 746 static bool IsSystemApp(); 747 static std::string GetStringFetchProperty(napi_env env, napi_value arg, bool &err, bool &present, 748 const std::string &propertyName); 749 EXPORT static std::string ParseResultSet2JsonStr(std::shared_ptr<DataShare::DataShareResultSet> resultSet, 750 const std::vector<std::string> &cloumns); 751 752 static std::string ParseAnalysisFace2JsonStr(std::shared_ptr<DataShare::DataShareResultSet> resultSet, 753 const std::vector<std::string> &cloumns); 754 755 static std::string GetStringValueByColumn(std::shared_ptr<DataShare::DataShareResultSet> resultSet, 756 const std::string columnName); 757 758 static napi_value GetNapiValueArray(napi_env env, napi_value arg, std::vector<napi_value> &values); 759 static napi_value GetUriArrayFromAssets( 760 napi_env env, std::vector<napi_value> &napiValues, std::vector<std::string> &values); 761 static napi_value GetStringArray( 762 napi_env env, std::vector<napi_value> &napiValues, std::vector<std::string> &values); 763 static void FixSpecialDateType(std::string &selections); 764 static std::string TransferUri(const std::string &oldUri); 765 static napi_value GetNextRowObject(napi_env env, std::shared_ptr<NativeRdb::AbsSharedResultSet> &resultSet, 766 bool isShared = false); 767 static napi_value GetNextRowAlbumObject(napi_env env, std::shared_ptr<NativeRdb::AbsSharedResultSet> &resultSet); 768 static napi_value CreateValueByIndex(napi_env env, int32_t index, std::string name, 769 std::shared_ptr<NativeRdb::AbsSharedResultSet> &resultSet, const std::shared_ptr<FileAsset> &asset); 770 static void handleTimeInfo(napi_env env, const std::string& name, napi_value result, int32_t index, 771 const std::shared_ptr<NativeRdb::AbsSharedResultSet>& resultSet); 772 773 template <class AsyncContext> 774 static napi_status ParsePredicates(napi_env env, 775 const napi_value arg, AsyncContext &context, const FetchOptionType &fetchOptType); 776 777 private: 778 static napi_status hasFetchOpt(napi_env env, const napi_value arg, bool &hasFetchOpt); 779 }; 780 781 class NapiScopeHandler { 782 public: 783 NapiScopeHandler(napi_env env); 784 ~NapiScopeHandler(); 785 bool IsValid(); 786 787 private: 788 napi_env env_; 789 napi_handle_scope scope_; 790 bool isValid_ = false; 791 }; 792 } // namespace Media 793 } // namespace OHOS 794 795 #endif // INTERFACES_KITS_JS_MEDIALIBRARY_INCLUDE_MEDIALIBRARY_NAPI_UTILS_H_ 796