Avi Drissman | 4a8573c | 2022-09-09 19:35:54 | [diff] [blame] | 1 | // Copyright 2018 The Chromium Authors |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
| 5 | #ifndef CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_DATABASE_H_ |
| 6 | #define CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_DATABASE_H_ |
| 7 | |
| 8 | #include <memory> |
Arthur Sonzogni | fe132ee | 2024-01-15 11:01:04 | [diff] [blame] | 9 | #include <optional> |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 10 | |
Avi Drissman | 9269d4ed | 2023-01-07 01:38:06 | [diff] [blame] | 11 | #include "base/functional/callback_forward.h" |
Keishi Hattori | 0e45c02 | 2021-11-27 09:25:52 | [diff] [blame] | 12 | #include "base/memory/raw_ptr.h" |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 13 | #include "base/memory/weak_ptr.h" |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 14 | #include "base/sequence_checker.h" |
Eric Willigers | 14c5e57 | 2019-10-29 11:39:49 | [diff] [blame] | 15 | #include "chrome/browser/web_applications/proto/web_app.pb.h" |
Marijn Kruisselbrink | da02951 | 2024-10-07 20:40:17 | [diff] [blame^] | 16 | #include "chrome/browser/web_applications/proto/web_app_database_metadata.pb.h" |
Song Fangzhen | cda4af6 | 2021-09-09 05:24:02 | [diff] [blame] | 17 | #include "chrome/browser/web_applications/web_app_constants.h" |
Alexey Baskakov | 27f14d4 | 2019-09-20 07:09:48 | [diff] [blame] | 18 | #include "chrome/browser/web_applications/web_app_registrar.h" |
Mikel Astiz | 9048b12 | 2024-08-05 12:55:41 | [diff] [blame] | 19 | #include "components/sync/model/data_type_store.h" |
Eric Willigers | 1854428 | 2019-10-09 05:59:58 | [diff] [blame] | 20 | #include "components/sync/protocol/web_app_specifics.pb.h" |
Glenn Hartmann | 5f992ed | 2023-09-25 18:05:36 | [diff] [blame] | 21 | #include "components/webapps/common/web_app_id.h" |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 22 | |
| 23 | namespace syncer { |
| 24 | class ModelError; |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 25 | class MetadataBatch; |
Alexey Baskakov | f8fb8c6 | 2019-10-10 04:55:49 | [diff] [blame] | 26 | class MetadataChangeList; |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 27 | } // namespace syncer |
| 28 | |
| 29 | namespace web_app { |
| 30 | |
| 31 | class AbstractWebAppDatabaseFactory; |
| 32 | class WebApp; |
| 33 | class WebAppProto; |
Alexey Baskakov | 6856e5e4 | 2019-09-26 04:31:26 | [diff] [blame] | 34 | struct RegistryUpdateData; |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 35 | |
| 36 | // Exclusively used from the UI thread. |
Alexey Baskakov | 4702d663 | 2019-09-17 06:58:51 | [diff] [blame] | 37 | class WebAppDatabase { |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 38 | public: |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 39 | using ReportErrorCallback = |
| 40 | base::RepeatingCallback<void(const syncer::ModelError&)>; |
| 41 | |
Marijn Kruisselbrink | da02951 | 2024-10-07 20:40:17 | [diff] [blame^] | 42 | static constexpr std::string_view kDatabaseMetadataKey = "DATABASE_METADATA"; |
| 43 | |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 44 | WebAppDatabase(AbstractWebAppDatabaseFactory* database_factory, |
| 45 | ReportErrorCallback error_callback); |
Haben Foto | e3d073b | 2020-10-06 01:22:58 | [diff] [blame] | 46 | WebAppDatabase(const WebAppDatabase&) = delete; |
| 47 | WebAppDatabase& operator=(const WebAppDatabase&) = delete; |
Alexey Baskakov | 4702d663 | 2019-09-17 06:58:51 | [diff] [blame] | 48 | ~WebAppDatabase(); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 49 | |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 50 | using RegistryOpenedCallback = base::OnceCallback<void( |
| 51 | Registry registry, |
| 52 | std::unique_ptr<syncer::MetadataBatch> metadata_batch)>; |
Alexey Baskakov | 27f14d4 | 2019-09-20 07:09:48 | [diff] [blame] | 53 | // Open existing or create new DB. Read all data and return it via callback. |
Alexey Baskakov | 4702d663 | 2019-09-17 06:58:51 | [diff] [blame] | 54 | void OpenDatabase(RegistryOpenedCallback callback); |
Alexey Baskakov | 6856e5e4 | 2019-09-26 04:31:26 | [diff] [blame] | 55 | |
| 56 | using CompletionCallback = base::OnceCallback<void(bool success)>; |
Alexey Baskakov | d6e9382 | 2019-10-11 02:39:44 | [diff] [blame] | 57 | void Write(const RegistryUpdateData& update_data, |
| 58 | std::unique_ptr<syncer::MetadataChangeList> metadata_change_list, |
| 59 | CompletionCallback callback); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 60 | |
| 61 | // Exposed for testing. |
| 62 | static std::unique_ptr<WebAppProto> CreateWebAppProto(const WebApp& web_app); |
| 63 | // Exposed for testing. |
Glenn Hartmann | 5f992ed | 2023-09-25 18:05:36 | [diff] [blame] | 64 | static std::unique_ptr<WebApp> ParseWebApp(const webapps::AppId& app_id, |
Alexey Baskakov | 27f14d4 | 2019-09-20 07:09:48 | [diff] [blame] | 65 | const std::string& value); |
Alan Cutter | 87b1485 | 2022-04-08 06:34:15 | [diff] [blame] | 66 | // Exposed for testing. |
| 67 | static std::unique_ptr<WebApp> CreateWebApp(const WebAppProto& local_data); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 68 | |
Alexey Baskakov | 583f6edf | 2020-05-21 03:56:11 | [diff] [blame] | 69 | bool is_opened() const { return opened_; } |
| 70 | |
Marijn Kruisselbrink | da02951 | 2024-10-07 20:40:17 | [diff] [blame^] | 71 | // Returns the version that the database will be migrated to when opened. |
| 72 | // - No version/version 0 is the original version. |
| 73 | // - Version 1 introduces the UserInstalled install source, migration between |
| 74 | // 0 and 1 add or remove this source. |
| 75 | static int GetCurrentDatabaseVersion(); |
| 76 | |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 77 | private: |
Marijn Kruisselbrink | da02951 | 2024-10-07 20:40:17 | [diff] [blame^] | 78 | struct ProtobufState { |
| 79 | ProtobufState(); |
| 80 | ~ProtobufState(); |
| 81 | ProtobufState(ProtobufState&&); |
| 82 | ProtobufState& operator=(ProtobufState&&); |
| 83 | |
| 84 | proto::DatabaseMetadata metadata; |
| 85 | base::flat_map<webapps::AppId, WebAppProto> apps; |
| 86 | }; |
| 87 | |
| 88 | ProtobufState ParseProtobufs( |
| 89 | const syncer::DataTypeStore::RecordList& data_records) const; |
| 90 | |
| 91 | void MigrateDatabase(ProtobufState& state); |
| 92 | void MigrateInstallSourceAddUserInstalled( |
| 93 | ProtobufState& state, |
| 94 | std::set<webapps::AppId>& changed_apps); |
| 95 | void MigrateInstallSourceRemoveUserInstalled( |
| 96 | ProtobufState& state, |
| 97 | std::set<webapps::AppId>& changed_apps); |
| 98 | |
Alexey Baskakov | eecc87f1 | 2019-09-24 08:03:01 | [diff] [blame] | 99 | void OnDatabaseOpened(RegistryOpenedCallback callback, |
Arthur Sonzogni | fe132ee | 2024-01-15 11:01:04 | [diff] [blame] | 100 | const std::optional<syncer::ModelError>& error, |
Mikel Astiz | 31a57c5e | 2024-08-05 15:45:52 | [diff] [blame] | 101 | std::unique_ptr<syncer::DataTypeStore> store); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 102 | |
Florian Leimgruber | d573126 | 2024-06-06 08:41:20 | [diff] [blame] | 103 | void OnAllDataAndMetadataRead( |
Alexey Baskakov | 4702d663 | 2019-09-17 06:58:51 | [diff] [blame] | 104 | RegistryOpenedCallback callback, |
Arthur Sonzogni | fe132ee | 2024-01-15 11:01:04 | [diff] [blame] | 105 | const std::optional<syncer::ModelError>& error, |
Mikel Astiz | 31a57c5e | 2024-08-05 15:45:52 | [diff] [blame] | 106 | std::unique_ptr<syncer::DataTypeStore::RecordList> data_records, |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 107 | std::unique_ptr<syncer::MetadataBatch> metadata_batch); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 108 | |
Alexey Baskakov | 00fb85eae | 2019-09-03 07:29:12 | [diff] [blame] | 109 | void OnDataWritten(CompletionCallback callback, |
Arthur Sonzogni | fe132ee | 2024-01-15 11:01:04 | [diff] [blame] | 110 | const std::optional<syncer::ModelError>& error); |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 111 | |
Mikel Astiz | 31a57c5e | 2024-08-05 15:45:52 | [diff] [blame] | 112 | std::unique_ptr<syncer::DataTypeStore> store_; |
Arthur Sonzogni | e98d214 | 2023-06-01 15:02:25 | [diff] [blame] | 113 | const raw_ptr<AbstractWebAppDatabaseFactory, DanglingUntriaged> |
| 114 | database_factory_; |
Alexey Baskakov | 0b50ec6 | 2019-10-01 03:29:23 | [diff] [blame] | 115 | ReportErrorCallback error_callback_; |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 116 | |
| 117 | // Database is opened if store is created and all data read. |
| 118 | bool opened_ = false; |
| 119 | |
| 120 | SEQUENCE_CHECKER(sequence_checker_); |
| 121 | |
| 122 | base::WeakPtrFactory<WebAppDatabase> weak_ptr_factory_{this}; |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 123 | }; |
| 124 | |
Eric Willigers | d32986ad | 2019-11-04 00:40:04 | [diff] [blame] | 125 | DisplayMode ToMojomDisplayMode(WebAppProto::DisplayMode display_mode); |
Eric Willigers | 1854428 | 2019-10-09 05:59:58 | [diff] [blame] | 126 | |
Eric Willigers | d32986ad | 2019-11-04 00:40:04 | [diff] [blame] | 127 | WebAppProto::DisplayMode ToWebAppProtoDisplayMode(DisplayMode display_mode); |
Eric Willigers | 1854428 | 2019-10-09 05:59:58 | [diff] [blame] | 128 | |
Alexey Baskakov | ac8c4b0 | 2018-11-07 06:10:02 | [diff] [blame] | 129 | } // namespace web_app |
| 130 | |
| 131 | #endif // CHROME_BROWSER_WEB_APPLICATIONS_WEB_APP_DATABASE_H_ |