extension_sync_bundle.h revision 7dbb3d5cf0c15f500944d211057644d6a2f37371
15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef CHROME_BROWSER_EXTENSIONS_EXTENSION_SYNC_BUNDLE_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define CHROME_BROWSER_EXTENSIONS_EXTENSION_SYNC_BUNDLE_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <map> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <set> 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <vector> 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "chrome/browser/extensions/extension_sync_data.h" 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "sync/api/syncable_service.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionService; 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionSet; 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace syncer { 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SyncChangeProcessor; 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class SyncErrorFactory; 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace extensions { 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class Extension; 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Bundle of extension specific sync stuff. 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class ExtensionSyncBundle { 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ExtensionSyncBundle(ExtensionService* extension_service); 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~ExtensionSyncBundle(); 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Setup this bundle to be sync extension data. 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SetupSync(syncer::SyncChangeProcessor* sync_processor, 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncErrorFactory* sync_error_factory, 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const syncer::SyncDataList& initial_sync_data); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Resets this class back to it default values, which will disable all syncing 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // until a new sync processor is set. 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void Reset(); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a syncer::SyncChange that will delete the given extension. 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChange CreateSyncChangeToDelete(const Extension* extension) const; 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Process the sync deletion of the given extension. 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ProcessDeletion( 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string extension_id, const syncer::SyncChange& sync_change); 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Create a sync change based on |sync_data|. 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncChange CreateSyncChange(const syncer::SyncData& sync_data); 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Get all the sync data contained in this bundle. 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) syncer::SyncDataList GetAllSyncData() const; 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Process the given sync change and apply it. 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ProcessSyncChange(ExtensionSyncData extension_sync_data); 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Sync a newly-installed extension or change an existing one. 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void SyncChangeIfNeeded(const Extension& extension); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Process the list of sync changes. 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ProcessSyncChangeList(syncer::SyncChangeList sync_change_list); 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Check to see if the given |id| is either synced or pending to be synced. 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasExtensionId(const std::string& id) const; 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool HasPendingExtensionId(const std::string& id) const; 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Add a pending extension to be synced. 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddPendingExtension(const std::string& id, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ExtensionSyncData& extension_sync_data); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Returns a vector of all the pending sync data. 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<ExtensionSyncData> GetPendingData() const; 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Appends sync data objects for every extension in |extensions|. 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void GetExtensionSyncDataListHelper( 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const ExtensionSet& extensions, 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::vector<extensions::ExtensionSyncData>* sync_data_list) const; 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 837dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch // Returns true if SetupSync has been called, false otherwise. 847dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch bool IsSyncing() const; 857dbb3d5cf0c15f500944d211057644d6a2f37371Ben Murdoch 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Add a synced extension. 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void AddExtension(const std::string& id); 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Remove a synced extension. 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void RemoveExtension(const std::string& id); 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Change an extension from being pending to synced. 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void MarkPendingExtensionSynced(const std::string& id); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ExtensionService* extension_service_; // Owns us. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncChangeProcessor> sync_processor_; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<syncer::SyncErrorFactory> sync_error_factory_; 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::set<std::string> synced_extensions_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::map<std::string, ExtensionSyncData> pending_sync_data_; 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ExtensionSyncBundle); 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace extensions 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // CHROME_BROWSER_EXTENSIONS_EXTENSION_SYNC_BUNDLE_H_ 109