chrome/browser/extensions/extension_sync_data.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   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_EXTENSIONS_EXTENSION_SYNC_DATA_H_
   6 #define CHROME_BROWSER_EXTENSIONS_EXTENSION_SYNC_DATA_H_
   7
   8 #include <string>
   9
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/version.h"
  12 #include "sync/api/sync_change.h"
  13 #include "url/gurl.h"
  14
  15 namespace syncer {
  16 class SyncData;
  17 }
  18
  19 namespace sync_pb {
  20 class ExtensionSpecifics;
  21 }
  22
  23 namespace extensions {
  24
  25 class Extension;
  26
  27 // A class that encapsulates the synced properties of an Extension.
  28 class ExtensionSyncData {
  29  public:
  30   enum OptionalBoolean {
  31     BOOLEAN_UNSET,
  32     BOOLEAN_TRUE,
  33     BOOLEAN_FALSE
  34   };
  35
  36   ExtensionSyncData();
  37   ExtensionSyncData(const Extension& extension,
  38                     bool enabled,
  39                     bool incognito_enabled,
  40                     bool remote_install,
  41                     OptionalBoolean all_urls_enabled);
  42   ~ExtensionSyncData();
  43
  44   // For constructing an ExtensionSyncData from received sync data.
  45   // May return null if the sync data was invalid.
  46   static scoped_ptr<ExtensionSyncData> CreateFromSyncData(
  47       const syncer::SyncData& sync_data);
  48   static scoped_ptr<ExtensionSyncData> CreateFromSyncChange(
  49       const syncer::SyncChange& sync_change);
  50
  51   // Retrieve sync data from this class.
  52   syncer::SyncData GetSyncData() const;
  53   syncer::SyncChange GetSyncChange(
  54       syncer::SyncChange::SyncChangeType change_type) const;
  55
  56   // Convert an ExtensionSyncData back out to a sync structure.
  57   void PopulateExtensionSpecifics(sync_pb::ExtensionSpecifics* specifics) const;
  58
  59   // Populate this class from sync inputs. Returns true if the input was valid.
  60   bool PopulateFromExtensionSpecifics(
  61       const sync_pb::ExtensionSpecifics& specifics);
  62
  63   void set_uninstalled(bool uninstalled);
  64
  65   const std::string& id() const { return id_; }
  66
  67   // Version-independent properties (i.e., used even when the
  68   // version of the currently-installed extension doesn't match
  69   // |version|).
  70   bool uninstalled() const { return uninstalled_; }
  71   bool enabled() const { return enabled_; }
  72   bool incognito_enabled() const { return incognito_enabled_; }
  73   bool remote_install() const { return remote_install_; }
  74   OptionalBoolean all_urls_enabled() const { return all_urls_enabled_; }
  75   bool installed_by_custodian() const { return installed_by_custodian_; }
  76
  77   // Version-dependent properties (i.e., should be used only when the
  78   // version of the currenty-installed extension matches |version|).
  79   const Version& version() const { return version_; }
  80   const GURL& update_url() const { return update_url_; }
  81   // Used only for debugging.
  82   const std::string& name() const { return name_; }
  83
  84  private:
  85   // Populate this class from sync inputs.
  86   bool PopulateFromSyncData(const syncer::SyncData& sync_data);
  87
  88   std::string id_;
  89   bool uninstalled_;
  90   bool enabled_;
  91   bool incognito_enabled_;
  92   bool remote_install_;
  93   OptionalBoolean all_urls_enabled_;
  94   bool installed_by_custodian_;
  95   Version version_;
  96   GURL update_url_;
  97   std::string name_;
  98 };
  99
 100 }  // namespace extensions
 101
 102 #endif  // CHROME_BROWSER_EXTENSIONS_EXTENSION_SYNC_DATA_H_