From 81eeeb7aeb7c32b966c95ac1d785ed28e3184ffa Mon Sep 17 00:00:00 2001 From: Neeraj Gupta <254676+ua741@users.noreply.github.com> Date: Mon, 20 Sep 2021 12:11:38 +0530 Subject: [PATCH] magic-metadata: rename --- lib/db/files_db.dart | 8 ++++---- lib/models/file.dart | 10 +++++----- ...magic_metadata.dart => magic_metadata.dart} | 18 +++++++++--------- lib/services/file_magic_service.dart | 10 +++++----- lib/ui/archive_page.dart | 4 ++-- lib/ui/collections_gallery_widget.dart | 3 +-- lib/ui/gallery_app_bar_widget.dart | 8 ++++---- lib/utils/diff_fetcher.dart | 4 ++-- 8 files changed, 32 insertions(+), 33 deletions(-) rename lib/models/{file_magic_metadata.dart => magic_metadata.dart} (50%) diff --git a/lib/db/files_db.dart b/lib/db/files_db.dart index b9a9e92d7..b337bfa6d 100644 --- a/lib/db/files_db.dart +++ b/lib/db/files_db.dart @@ -6,7 +6,7 @@ import 'package:path_provider/path_provider.dart'; import 'package:photos/models/backup_status.dart'; import 'package:photos/models/file.dart'; import 'package:photos/models/file_load_result.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/models/file_type.dart'; import 'package:photos/models/location.dart'; import 'package:sqflite/sqflite.dart'; @@ -241,7 +241,7 @@ class FilesDB { static List addMagicMetadataColumns() { return [ ''' - ALTER TABLE $table ADD COLUMN $columnMMdEncodedJson Text DEFAULT '{}'; + ALTER TABLE $table ADD COLUMN $columnMMdEncodedJson TEXT DEFAULT '{}'; ''', ''' ALTER TABLE $table ADD COLUMN $columnMMdVersion INTEGER DEFAULT 0; @@ -914,7 +914,7 @@ class FilesDB { row[columnMMdVersion] = file.mMdVersion ?? 0; row[columnMMdEncodedJson] = file.mMdEncodedJson ?? '{}'; row[columnMMdVisibility] = - file.fileMagicMetadata?.visibility ?? kVisibilityVisible; + file.magicMetadata?.visibility ?? kVisibilityVisible; return row; } @@ -945,7 +945,7 @@ class FilesDB { row[columnMMdVersion] = file.mMdVersion ?? 0; row[columnMMdEncodedJson] == file.mMdEncodedJson ?? '{}'; row[columnMMdVisibility] = - file.fileMagicMetadata?.visibility ?? kVisibilityVisible; + file.magicMetadata?.visibility ?? kVisibilityVisible; return row; } diff --git a/lib/models/file.dart b/lib/models/file.dart index ff47fa53f..ea48e98f1 100644 --- a/lib/models/file.dart +++ b/lib/models/file.dart @@ -6,7 +6,7 @@ import 'package:path/path.dart'; import 'package:photo_manager/photo_manager.dart'; import 'package:photos/core/configuration.dart'; import 'package:photos/core/constants.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/models/file_type.dart'; import 'package:photos/models/location.dart'; import 'package:photos/services/feature_flag_service.dart'; @@ -38,10 +38,10 @@ class File { String mMdEncodedJson; int mMdVersion = 0; - FileMagicMetadata _fileMMd; - FileMagicMetadata get fileMagicMetadata => - _fileMMd ?? FileMagicMetadata.fromEncodedJson(mMdEncodedJson ?? '{}'); - set fileMagicMetadata (val) => _fileMMd = val; + MagicMetadata _mmd; + MagicMetadata get magicMetadata => + _mmd ?? MagicMetadata.fromEncodedJson(mMdEncodedJson ?? '{}'); + set magicMetadata (val) => _mmd = val; static const kCurrentMetadataVersion = 1; diff --git a/lib/models/file_magic_metadata.dart b/lib/models/magic_metadata.dart similarity index 50% rename from lib/models/file_magic_metadata.dart rename to lib/models/magic_metadata.dart index fe12027cc..0a21cd3ca 100644 --- a/lib/models/file_magic_metadata.dart +++ b/lib/models/magic_metadata.dart @@ -5,29 +5,29 @@ const kVisibilityArchive = 1; const kMagicKeyVisibility = 'visibility'; -class FileMagicMetadata { +class MagicMetadata { // 0 -> visible // 1 -> archived // 2 -> hidden etc? int visibility; - FileMagicMetadata({this.visibility}); + MagicMetadata({this.visibility}); - factory FileMagicMetadata.fromEncodedJson(String encodedJson) => - FileMagicMetadata.fromJson(jsonDecode(encodedJson)); + factory MagicMetadata.fromEncodedJson(String encodedJson) => + MagicMetadata.fromJson(jsonDecode(encodedJson)); - factory FileMagicMetadata.fromJson(dynamic json) => - FileMagicMetadata.fromMap(json); + factory MagicMetadata.fromJson(dynamic json) => + MagicMetadata.fromMap(json); Map toJson() { - var map = {}; + final map = {}; map[kMagicKeyVisibility] = visibility; return map; } - factory FileMagicMetadata.fromMap(Map map) { + factory MagicMetadata.fromMap(Map map) { if (map == null) return null; - return FileMagicMetadata( + return MagicMetadata( visibility: map[kMagicKeyVisibility] ?? kVisibilityVisible, ); } diff --git a/lib/services/file_magic_service.dart b/lib/services/file_magic_service.dart index 4b6d3ecdf..65a813f92 100644 --- a/lib/services/file_magic_service.dart +++ b/lib/services/file_magic_service.dart @@ -9,7 +9,7 @@ import 'package:photos/db/files_db.dart'; import 'package:photos/events/files_updated_event.dart'; import 'package:photos/models/file.dart'; import 'package:photos/core/configuration.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/services/remote_sync_service.dart'; import '../utils/crypto_util.dart'; @@ -38,14 +38,14 @@ class FileMagicService { List files, Map newMetadataUpdate) async { final params = {}; params['metadataList'] = []; - int ownerID = Configuration.instance.getUserID(); + final int ownerID = Configuration.instance.getUserID(); try { for (final file in files) { if (file.uploadedFileID == null) { throw AssertionError( "operation is only supported on backed up files"); } else if (file.ownerID != ownerID) { - throw AssertionError("can not modify memories not owned by you"); + throw AssertionError("cannot modify memories not owned by you"); } // read the existing magic metadata and apply new updates to existing data // current update is simple replace. This will be enhanced in the future, @@ -57,7 +57,7 @@ class FileMagicService { // update the local information so that it's reflected on UI file.mMdEncodedJson = jsonEncode(jsonToUpdate); - file.fileMagicMetadata = FileMagicMetadata.fromJson(jsonToUpdate); + file.magicMetadata = MagicMetadata.fromJson(jsonToUpdate); final fileKey = decryptFileKey(file); final encryptedMMd = await CryptoUtil.encryptChaCha( @@ -110,7 +110,7 @@ class UpdateMagicMetadata { } Map toJson() { - var map = {}; + final map = {}; map['id'] = id; if (magicMetadata != null) { map['magicMetadata'] = magicMetadata.toJson(); diff --git a/lib/ui/archive_page.dart b/lib/ui/archive_page.dart index bfe6040fd..24a0bf7d3 100644 --- a/lib/ui/archive_page.dart +++ b/lib/ui/archive_page.dart @@ -6,7 +6,7 @@ import 'package:photos/core/configuration.dart'; import 'package:photos/core/event_bus.dart'; import 'package:photos/db/files_db.dart'; import 'package:photos/events/files_updated_event.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/models/selected_files.dart'; import 'gallery.dart'; @@ -19,7 +19,7 @@ class ArchivePage extends StatelessWidget { ArchivePage( {this.tagPrefix = "archived_page", - this.appBarType = GalleryAppBarType.archivedPage, + this.appBarType = GalleryAppBarType.archive, Key key}) : super(key: key); diff --git a/lib/ui/collections_gallery_widget.dart b/lib/ui/collections_gallery_widget.dart index 351bf57e8..c368fd6e8 100644 --- a/lib/ui/collections_gallery_widget.dart +++ b/lib/ui/collections_gallery_widget.dart @@ -23,8 +23,7 @@ import 'package:photos/ui/thumbnail_widget.dart'; import 'package:photos/utils/local_settings.dart'; import 'package:photos/utils/navigation_util.dart'; import 'package:photos/utils/toast_util.dart'; - -import 'archive_page.dart'; +import 'package:photos/ui/archive_page.dart'; class CollectionsGalleryWidget extends StatefulWidget { const CollectionsGalleryWidget({Key key}) : super(key: key); diff --git a/lib/ui/gallery_app_bar_widget.dart b/lib/ui/gallery_app_bar_widget.dart index d28c10e2c..13ef7df1b 100644 --- a/lib/ui/gallery_app_bar_widget.dart +++ b/lib/ui/gallery_app_bar_widget.dart @@ -10,7 +10,7 @@ import 'package:photos/core/configuration.dart'; import 'package:photos/core/event_bus.dart'; import 'package:photos/events/subscription_purchased_event.dart'; import 'package:photos/models/collection.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/models/selected_files.dart'; import 'package:photos/services/collections_service.dart'; import 'package:photos/ui/create_collection_page.dart'; @@ -23,7 +23,7 @@ import 'package:photos/utils/toast_util.dart'; enum GalleryAppBarType { homepage, - archivedPage, + archive, local_folder, // indicator for gallery view of collections shared with the user shared_collection, @@ -213,7 +213,7 @@ class _GalleryAppBarWidgetState extends State { }, )); if (widget.type == GalleryAppBarType.homepage || - widget.type == GalleryAppBarType.archivedPage || + widget.type == GalleryAppBarType.archive || widget.type == GalleryAppBarType.local_folder) { actions.add(IconButton( icon: Icon( @@ -243,7 +243,7 @@ class _GalleryAppBarWidgetState extends State { } if (widget.type == GalleryAppBarType.homepage || - widget.type == GalleryAppBarType.archivedPage) { + widget.type == GalleryAppBarType.archive) { bool showArchive = widget.type == GalleryAppBarType.homepage; actions.add(PopupMenuButton( itemBuilder: (context) { diff --git a/lib/utils/diff_fetcher.dart b/lib/utils/diff_fetcher.dart index a914e039a..f0bff9cc6 100644 --- a/lib/utils/diff_fetcher.dart +++ b/lib/utils/diff_fetcher.dart @@ -11,7 +11,7 @@ import 'package:photos/events/collection_updated_event.dart'; import 'package:photos/events/local_photos_updated_event.dart'; import 'package:photos/events/remote_sync_event.dart'; import 'package:photos/models/file.dart'; -import 'package:photos/models/file_magic_metadata.dart'; +import 'package:photos/models/magic_metadata.dart'; import 'package:photos/utils/crypto_util.dart'; import 'package:photos/utils/file_download_util.dart'; @@ -88,7 +88,7 @@ class DiffFetcher { Sodium.base642bin(item['magicMetadata']['header'])); file.mMdEncodedJson = utf8.decode(utfEncodedMmd); file.mMdVersion = item['magicMetadata']['version']; - file.fileMagicMetadata = FileMagicMetadata.fromEncodedJson(file.mMdEncodedJson); + file.magicMetadata = MagicMetadata.fromEncodedJson(file.mMdEncodedJson); } files.add(file); }