// Copyright (c) 2012 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. // Keep this file in sync with the .proto files in this directory. #include "sync/protocol/proto_value_conversions.h" #include "base/base64.h" #include "base/basictypes.h" #include "base/logging.h" #include "base/string_number_conversions.h" #include "base/values.h" #include "sync/protocol/app_notification_specifics.pb.h" #include "sync/protocol/app_setting_specifics.pb.h" #include "sync/protocol/app_specifics.pb.h" #include "sync/protocol/autofill_specifics.pb.h" #include "sync/protocol/bookmark_specifics.pb.h" #include "sync/protocol/encryption.pb.h" #include "sync/protocol/experiments_specifics.pb.h" #include "sync/protocol/extension_setting_specifics.pb.h" #include "sync/protocol/extension_specifics.pb.h" #include "sync/protocol/history_delete_directive_specifics.pb.h" #include "sync/protocol/nigori_specifics.pb.h" #include "sync/protocol/password_specifics.pb.h" #include "sync/protocol/preference_specifics.pb.h" #include "sync/protocol/proto_enum_conversions.h" #include "sync/protocol/search_engine_specifics.pb.h" #include "sync/protocol/session_specifics.pb.h" #include "sync/protocol/sync.pb.h" #include "sync/protocol/theme_specifics.pb.h" #include "sync/protocol/typed_url_specifics.pb.h" namespace syncer { namespace { // Basic Type -> Value functions. StringValue* MakeInt64Value(int64 x) { return Value::CreateStringValue(base::Int64ToString(x)); } // TODO(akalin): Perhaps make JSONWriter support BinaryValue and use // that instead of a StringValue. StringValue* MakeBytesValue(const std::string& bytes) { std::string bytes_base64; if (!base::Base64Encode(bytes, &bytes_base64)) { NOTREACHED(); } return Value::CreateStringValue(bytes_base64); } // T is the enum type. template StringValue* MakeEnumValue(T t, const char* (*converter_fn)(T)) { return Value::CreateStringValue(converter_fn(t)); } // T is the field type, F is either RepeatedField or RepeatedPtrField, // and V is a subclass of Value. template ListValue* MakeRepeatedValue(const F& fields, V* (*converter_fn)(T)) { ListValue* list = new ListValue(); for (typename F::const_iterator it = fields.begin(); it != fields.end(); ++it) { list->Append(converter_fn(*it)); } return list; } } // namespace // Helper macros to reduce the amount of boilerplate. #define SET(field, fn) \ if (proto.has_##field()) { \ value->Set(#field, fn(proto.field())); \ } #define SET_REP(field, fn) \ value->Set(#field, MakeRepeatedValue(proto.field(), fn)) #define SET_ENUM(field, fn) \ value->Set(#field, MakeEnumValue(proto.field(), fn)) #define SET_BOOL(field) SET(field, Value::CreateBooleanValue) #define SET_BYTES(field) SET(field, MakeBytesValue) #define SET_INT32(field) SET(field, MakeInt64Value) #define SET_INT32_REP(field) SET_REP(field, MakeInt64Value) #define SET_INT64(field) SET(field, MakeInt64Value) #define SET_INT64_REP(field) SET_REP(field, MakeInt64Value) #define SET_STR(field) SET(field, Value::CreateStringValue) #define SET_STR_REP(field) \ value->Set(#field, \ MakeRepeatedValue, \ StringValue>(proto.field(), \ Value::CreateStringValue)) #define SET_FIELD(field, fn) \ do { \ if (specifics.has_##field()) { \ value->Set(#field, fn(specifics.field())); \ } \ } while (0) // If you add another macro, don't forget to add an #undef at the end // of this file, too. DictionaryValue* EncryptedDataToValue(const sync_pb::EncryptedData& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(key_name); // TODO(akalin): Shouldn't blob be of type bytes instead of string? SET_BYTES(blob); return value; } DictionaryValue* AppSettingsToValue( const sync_pb::AppNotificationSettings& proto) { DictionaryValue* value = new DictionaryValue(); SET_BOOL(initial_setup_done); SET_BOOL(disabled); SET_STR(oauth_client_id); return value; } DictionaryValue* SessionHeaderToValue( const sync_pb::SessionHeader& proto) { DictionaryValue* value = new DictionaryValue(); SET_REP(window, SessionWindowToValue); SET_STR(client_name); SET_ENUM(device_type, GetDeviceTypeString); return value; } DictionaryValue* SessionTabToValue( const sync_pb::SessionTab& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(tab_id); SET_INT32(window_id); SET_INT32(tab_visual_index); SET_INT32(current_navigation_index); SET_BOOL(pinned); SET_STR(extension_app_id); SET_REP(navigation, TabNavigationToValue); SET_BYTES(favicon); SET_ENUM(favicon_type, GetFaviconTypeString); SET_STR(favicon_source); return value; } DictionaryValue* SessionWindowToValue( const sync_pb::SessionWindow& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(window_id); SET_INT32(selected_tab_index); SET_INT32_REP(tab); SET_ENUM(browser_type, GetBrowserTypeString); return value; } DictionaryValue* TabNavigationToValue( const sync_pb::TabNavigation& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(virtual_url); SET_STR(referrer); SET_STR(title); SET_STR(state); SET_ENUM(page_transition, GetPageTransitionString); SET_ENUM(redirect_type, GetPageTransitionRedirectTypeString); SET_INT32(unique_id); SET_INT64(timestamp); SET_BOOL(navigation_forward_back); SET_BOOL(navigation_from_address_bar); SET_BOOL(navigation_home_page); SET_BOOL(navigation_chain_start); SET_BOOL(navigation_chain_end); SET_INT64(global_id); SET_STR(search_terms); return value; } DictionaryValue* PasswordSpecificsDataToValue( const sync_pb::PasswordSpecificsData& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(scheme); SET_STR(signon_realm); SET_STR(origin); SET_STR(action); SET_STR(username_element); SET_STR(username_value); SET_STR(password_element); value->SetString("password_value", ""); SET_BOOL(ssl_valid); SET_BOOL(preferred); SET_INT64(date_created); SET_BOOL(blacklisted); return value; } DictionaryValue* KeystoreEncryptionFlagsToValue( const sync_pb::KeystoreEncryptionFlags& proto) { DictionaryValue* value = new DictionaryValue(); SET_BOOL(enabled); return value; } base::DictionaryValue* GlobalIdDirectiveToValue( const sync_pb::GlobalIdDirective& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT64_REP(global_id); return value; } base::DictionaryValue* TimeRangeDirectiveToValue( const sync_pb::TimeRangeDirective& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT64(start_time_usec); SET_INT64(end_time_usec); return value; } DictionaryValue* AppNotificationToValue( const sync_pb::AppNotification& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(guid); SET_STR(app_id); SET_INT64(creation_timestamp_ms); SET_STR(title); SET_STR(body_text); SET_STR(link_url); SET_STR(link_text); return value; } DictionaryValue* AppSettingSpecificsToValue( const sync_pb::AppSettingSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(extension_setting, ExtensionSettingSpecificsToValue); return value; } DictionaryValue* AppSpecificsToValue( const sync_pb::AppSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(extension, ExtensionSpecificsToValue); SET(notification_settings, AppSettingsToValue); SET_STR(app_launch_ordinal); SET_STR(page_ordinal); return value; } DictionaryValue* AutofillSpecificsToValue( const sync_pb::AutofillSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(name); SET_STR(value); SET_INT64_REP(usage_timestamp); SET(profile, AutofillProfileSpecificsToValue); return value; } DictionaryValue* AutofillProfileSpecificsToValue( const sync_pb::AutofillProfileSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(label); SET_STR(guid); SET_STR_REP(name_first); SET_STR_REP(name_middle); SET_STR_REP(name_last); SET_STR_REP(email_address); SET_STR(company_name); SET_STR(address_home_line1); SET_STR(address_home_line2); SET_STR(address_home_city); SET_STR(address_home_state); SET_STR(address_home_zip); SET_STR(address_home_country); SET_STR_REP(phone_home_whole_number); return value; } DictionaryValue* BookmarkSpecificsToValue( const sync_pb::BookmarkSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(url); SET_BYTES(favicon); SET_STR(title); SET_INT64(creation_time_us); SET_STR(icon_url); return value; } DictionaryValue* DeviceInfoSpecificsToValue( const sync_pb::DeviceInfoSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(cache_guid); SET_STR(client_name); SET_ENUM(device_type, GetDeviceTypeString); SET_STR(sync_user_agent); SET_STR(chrome_version); return value; } DictionaryValue* ExperimentsSpecificsToValue( const sync_pb::ExperimentsSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(keystore_encryption, KeystoreEncryptionFlagsToValue); return value; } DictionaryValue* ExtensionSettingSpecificsToValue( const sync_pb::ExtensionSettingSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(extension_id); SET_STR(key); SET_STR(value); return value; } DictionaryValue* ExtensionSpecificsToValue( const sync_pb::ExtensionSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(id); SET_STR(version); SET_STR(update_url); SET_BOOL(enabled); SET_BOOL(incognito_enabled); SET_STR(name); return value; } base::DictionaryValue* HistoryDeleteDirectiveSpecificsToValue( const sync_pb::HistoryDeleteDirectiveSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(global_id_directive, GlobalIdDirectiveToValue); SET(time_range_directive, TimeRangeDirectiveToValue); return value; } DictionaryValue* NigoriSpecificsToValue( const sync_pb::NigoriSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(encryption_keybag, EncryptedDataToValue); SET_BOOL(keybag_is_frozen); SET_BOOL(encrypt_bookmarks); SET_BOOL(encrypt_preferences); SET_BOOL(encrypt_autofill_profile); SET_BOOL(encrypt_autofill); SET_BOOL(encrypt_themes); SET_BOOL(encrypt_typed_urls); SET_BOOL(encrypt_extension_settings); SET_BOOL(encrypt_extensions); SET_BOOL(encrypt_sessions); SET_BOOL(encrypt_app_settings); SET_BOOL(encrypt_apps); SET_BOOL(encrypt_search_engines); SET_BOOL(encrypt_everything); SET_BOOL(sync_tab_favicons); SET_ENUM(passphrase_type, PassphraseTypeString); SET(keystore_decryptor_token, EncryptedDataToValue); SET_INT64(keystore_migration_time); SET_INT64(custom_passphrase_time); return value; } DictionaryValue* PasswordSpecificsToValue( const sync_pb::PasswordSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET(encrypted, EncryptedDataToValue); return value; } DictionaryValue* PreferenceSpecificsToValue( const sync_pb::PreferenceSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(name); SET_STR(value); return value; } DictionaryValue* SearchEngineSpecificsToValue( const sync_pb::SearchEngineSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(short_name); SET_STR(keyword); SET_STR(favicon_url); SET_STR(url); SET_BOOL(safe_for_autoreplace); SET_STR(originating_url); SET_INT64(date_created); SET_STR(input_encodings); SET_BOOL(show_in_default_list); SET_STR(suggestions_url); SET_INT32(prepopulate_id); SET_BOOL(autogenerate_keyword); SET_STR(instant_url); SET_INT64(last_modified); SET_STR(sync_guid); SET_STR_REP(alternate_urls); return value; } DictionaryValue* SessionSpecificsToValue( const sync_pb::SessionSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(session_tag); SET(header, SessionHeaderToValue); SET(tab, SessionTabToValue); SET_INT32(tab_node_id); return value; } DictionaryValue* ThemeSpecificsToValue( const sync_pb::ThemeSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_BOOL(use_custom_theme); SET_BOOL(use_system_theme_by_default); SET_STR(custom_theme_name); SET_STR(custom_theme_id); SET_STR(custom_theme_update_url); return value; } DictionaryValue* TypedUrlSpecificsToValue( const sync_pb::TypedUrlSpecifics& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(url); SET_STR(title); SET_BOOL(hidden); SET_INT64_REP(visits); SET_INT32_REP(visit_transitions); return value; } DictionaryValue* EntitySpecificsToValue( const sync_pb::EntitySpecifics& specifics) { DictionaryValue* value = new DictionaryValue(); SET_FIELD(app, AppSpecificsToValue); SET_FIELD(app_notification, AppNotificationToValue); SET_FIELD(app_setting, AppSettingSpecificsToValue); SET_FIELD(autofill, AutofillSpecificsToValue); SET_FIELD(autofill_profile, AutofillProfileSpecificsToValue); SET_FIELD(bookmark, BookmarkSpecificsToValue); SET_FIELD(device_info, DeviceInfoSpecificsToValue); SET_FIELD(experiments, ExperimentsSpecificsToValue); SET_FIELD(extension, ExtensionSpecificsToValue); SET_FIELD(extension_setting, ExtensionSettingSpecificsToValue); SET_FIELD(history_delete_directive, HistoryDeleteDirectiveSpecificsToValue); SET_FIELD(nigori, NigoriSpecificsToValue); SET_FIELD(password, PasswordSpecificsToValue); SET_FIELD(preference, PreferenceSpecificsToValue); SET_FIELD(search_engine, SearchEngineSpecificsToValue); SET_FIELD(session, SessionSpecificsToValue); SET_FIELD(theme, ThemeSpecificsToValue); SET_FIELD(typed_url, TypedUrlSpecificsToValue); return value; } namespace { DictionaryValue* SyncEntityToValue(const sync_pb::SyncEntity& proto, bool include_specifics) { DictionaryValue* value = new DictionaryValue(); SET_STR(id_string); SET_STR(parent_id_string); SET_STR(old_parent_id); SET_INT64(version); SET_INT64(mtime); SET_INT64(ctime); SET_STR(name); SET_STR(non_unique_name); SET_INT64(sync_timestamp); SET_STR(server_defined_unique_tag); SET_INT64(position_in_parent); SET_STR(insert_after_item_id); SET_BOOL(deleted); SET_STR(originator_cache_guid); SET_STR(originator_client_item_id); if (include_specifics) SET(specifics, EntitySpecificsToValue); SET_BOOL(folder); SET_STR(client_defined_unique_tag); return value; } ListValue* SyncEntitiesToValue( const ::google::protobuf::RepeatedPtrField& entities, bool include_specifics) { ListValue* list = new ListValue(); ::google::protobuf::RepeatedPtrField::const_iterator it; for (it = entities.begin(); it != entities.end(); ++it) { list->Append(SyncEntityToValue(*it, include_specifics)); } return list; } DictionaryValue* ChromiumExtensionActivityToValue( const sync_pb::ChromiumExtensionsActivity& proto) { DictionaryValue* value = new DictionaryValue(); SET_STR(extension_id); SET_INT32(bookmark_writes_since_last_commit); return value; } DictionaryValue* CommitMessageToValue( const sync_pb::CommitMessage& proto, bool include_specifics) { DictionaryValue* value = new DictionaryValue(); value->Set("entries", SyncEntitiesToValue(proto.entries(), include_specifics)); SET_STR(cache_guid); SET_REP(extensions_activity, ChromiumExtensionActivityToValue); return value; } DictionaryValue* DataTypeProgressMarkerToValue( const sync_pb::DataTypeProgressMarker& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(data_type_id); SET_BYTES(token); SET_INT64(timestamp_token_for_migration); SET_STR(notification_hint); return value; } DictionaryValue* GetUpdatesCallerInfoToValue( const sync_pb::GetUpdatesCallerInfo& proto) { DictionaryValue* value = new DictionaryValue(); SET_ENUM(source, GetUpdatesSourceString); SET_BOOL(notifications_enabled); return value; } DictionaryValue* GetUpdatesMessageToValue( const sync_pb::GetUpdatesMessage& proto) { DictionaryValue* value = new DictionaryValue(); SET(caller_info, GetUpdatesCallerInfoToValue); SET_BOOL(fetch_folders); SET_INT32(batch_size); SET_REP(from_progress_marker, DataTypeProgressMarkerToValue); SET_BOOL(streaming); SET_BOOL(create_mobile_bookmarks_folder); return value; } DictionaryValue* ClientStatusToValue( const sync_pb::ClientStatus& proto) { DictionaryValue* value = new DictionaryValue(); SET_BOOL(hierarchy_conflict_detected); return value; } DictionaryValue* EntryResponseToValue( const sync_pb::CommitResponse::EntryResponse& proto) { DictionaryValue* value = new DictionaryValue(); SET_ENUM(response_type, GetResponseTypeString); SET_STR(id_string); SET_STR(parent_id_string); SET_INT64(position_in_parent); SET_INT64(version); SET_STR(name); SET_STR(error_message); SET_INT64(mtime); return value; } DictionaryValue* CommitResponseToValue(const sync_pb::CommitResponse& proto) { DictionaryValue* value = new DictionaryValue(); SET_REP(entryresponse, EntryResponseToValue); return value; } DictionaryValue* GetUpdatesResponseToValue( const sync_pb::GetUpdatesResponse& proto, bool include_specifics) { DictionaryValue* value = new DictionaryValue(); value->Set("entries", SyncEntitiesToValue(proto.entries(), include_specifics)); SET_INT64(changes_remaining); SET_REP(new_progress_marker, DataTypeProgressMarkerToValue); return value; } DictionaryValue* ClientCommandToValue(const sync_pb::ClientCommand& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(set_sync_poll_interval); SET_INT32(set_sync_long_poll_interval); SET_INT32(max_commit_batch_size); SET_INT32(sessions_commit_delay_seconds); SET_INT32(throttle_delay_seconds); return value; } DictionaryValue* ErrorToValue( const sync_pb::ClientToServerResponse::Error& proto) { DictionaryValue* value = new DictionaryValue(); SET_ENUM(error_type, GetErrorTypeString); SET_STR(error_description); SET_STR(url); SET_ENUM(action, GetActionString); return value; } } // namespace DictionaryValue* ClientToServerResponseToValue( const sync_pb::ClientToServerResponse& proto, bool include_specifics) { DictionaryValue* value = new DictionaryValue(); SET(commit, CommitResponseToValue); if (proto.has_get_updates()) { value->Set("get_updates", GetUpdatesResponseToValue(proto.get_updates(), include_specifics)); } SET(error, ErrorToValue); SET_ENUM(error_code, GetErrorTypeString); SET_STR(error_message); SET_STR(store_birthday); SET(client_command, ClientCommandToValue); SET_INT32_REP(migrated_data_type_id); return value; } DictionaryValue* ClientToServerMessageToValue( const sync_pb::ClientToServerMessage& proto, bool include_specifics) { DictionaryValue* value = new DictionaryValue(); SET_STR(share); SET_INT32(protocol_version); if (proto.has_commit()) { value->Set("commit", CommitMessageToValue(proto.commit(), include_specifics)); } SET(get_updates, GetUpdatesMessageToValue); SET_STR(store_birthday); SET_BOOL(sync_problem_detected); SET(debug_info, DebugInfoToValue); SET(client_status, ClientStatusToValue); return value; } DictionaryValue* DatatypeAssociationStatsToValue( const sync_pb::DatatypeAssociationStats& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(data_type_id); SET_INT32(num_local_items_before_association); SET_INT32(num_sync_items_before_association); SET_INT32(num_local_items_after_association); SET_INT32(num_sync_items_after_association); SET_INT32(num_local_items_added); SET_INT32(num_local_items_deleted); SET_INT32(num_local_items_modified); SET_INT32(num_sync_items_added); SET_INT32(num_sync_items_deleted); SET_INT32(num_sync_items_modified); SET_BOOL(had_error); return value; } DictionaryValue* DebugEventInfoToValue( const sync_pb::DebugEventInfo& proto) { DictionaryValue* value = new DictionaryValue(); SET_ENUM(singleton_event, SingletonEventTypeString); SET(sync_cycle_completed_event_info, SyncCycleCompletedEventInfoToValue); SET_INT32(nudging_datatype); SET_INT32_REP(datatypes_notified_from_server); SET(datatype_association_stats, DatatypeAssociationStatsToValue); return value; } DictionaryValue* DebugInfoToValue( const sync_pb::DebugInfo& proto) { DictionaryValue* value = new DictionaryValue(); SET_REP(events, DebugEventInfoToValue); SET_BOOL(cryptographer_ready); SET_BOOL(cryptographer_has_pending_keys); SET_BOOL(events_dropped); return value; } base::DictionaryValue* SyncCycleCompletedEventInfoToValue( const sync_pb::SyncCycleCompletedEventInfo& proto) { DictionaryValue* value = new DictionaryValue(); SET_INT32(num_encryption_conflicts); SET_INT32(num_hierarchy_conflicts); SET_INT32(num_server_conflicts); SET_INT32(num_updates_downloaded); SET_INT32(num_reflected_updates_downloaded); SET(caller_info, GetUpdatesCallerInfoToValue); return value; } #undef SET #undef SET_REP #undef SET_BOOL #undef SET_BYTES #undef SET_INT32 #undef SET_INT64 #undef SET_INT64_REP #undef SET_STR #undef SET_STR_REP #undef SET_FIELD } // namespace syncer