chrome/browser/extensions/app_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_APP_SYNC_DATA_H_
   6 #define CHROME_BROWSER_EXTENSIONS_APP_SYNC_DATA_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "chrome/browser/extensions/extension_sync_data.h"
  10 #include "extensions/common/constants.h"
  11 #include "sync/api/string_ordinal.h"
  12 #include "sync/api/sync_change.h"
  13 #include "third_party/skia/include/core/SkColor.h"
  14
  15 namespace syncer {
  16 class SyncData;
  17 }
  18
  19 namespace sync_pb {
  20 class AppSpecifics;
  21 }
  22
  23 namespace extensions {
  24
  25 class Extension;
  26 class ExtensionSyncData;
  27
  28 // A class that encapsulates the synced properties of an Application.
  29 class AppSyncData {
  30  public:
  31   struct LinkedAppIconInfo {
  32     LinkedAppIconInfo();
  33     ~LinkedAppIconInfo();
  34
  35     GURL url;
  36     int size;
  37   };
  38
  39   AppSyncData();
  40   AppSyncData(const Extension& extension,
  41               bool enabled,
  42               int disable_reasons,
  43               bool incognito_enabled,
  44               bool remote_install,
  45               ExtensionSyncData::OptionalBoolean all_urls_enabled,
  46               const syncer::StringOrdinal& app_launch_ordinal,
  47               const syncer::StringOrdinal& page_ordinal,
  48               extensions::LaunchType launch_type);
  49   ~AppSyncData();
  50
  51   // For constructing an AppSyncData from received sync data.
  52   // May return null if the sync data was invalid.
  53   static scoped_ptr<AppSyncData> CreateFromSyncData(
  54       const syncer::SyncData& sync_data);
  55   static scoped_ptr<AppSyncData> CreateFromSyncChange(
  56       const syncer::SyncChange& sync_change);
  57
  58   // Retrive sync data from this class.
  59   syncer::SyncData GetSyncData() const;
  60   syncer::SyncChange GetSyncChange(
  61       syncer::SyncChange::SyncChangeType change_type) const;
  62
  63   const std::string& id() const { return extension_sync_data_.id(); }
  64
  65   bool uninstalled() const { return extension_sync_data_.uninstalled(); }
  66
  67   // These ordinals aren't necessarily valid. Some applications don't have
  68   // valid ordinals because they don't appear on the new tab page.
  69   const syncer::StringOrdinal& app_launch_ordinal() const {
  70     return app_launch_ordinal_;
  71   }
  72   const syncer::StringOrdinal& page_ordinal() const { return page_ordinal_; }
  73
  74   const ExtensionSyncData& extension_sync_data() const {
  75     return extension_sync_data_;
  76   }
  77
  78   extensions::LaunchType launch_type() const {
  79     return launch_type_;
  80   }
  81
  82   const std::string& bookmark_app_url() const {
  83     return bookmark_app_url_;
  84   }
  85
  86   const std::string& bookmark_app_description() const {
  87     return bookmark_app_description_;
  88   }
  89
  90   const std::string& bookmark_app_icon_color() const {
  91     return bookmark_app_icon_color_;
  92   }
  93
  94   const std::vector<LinkedAppIconInfo>& linked_icons() const {
  95     return linked_icons_;
  96   }
  97
  98  private:
  99   // Convert an AppSyncData back out to a sync structure.
 100   void PopulateAppSpecifics(sync_pb::AppSpecifics* specifics) const;
 101
 102   // Populate this class from sync inputs. Return true if the input
 103   // was valid.
 104   bool PopulateFromAppSpecifics(const sync_pb::AppSpecifics& specifics);
 105   bool PopulateFromSyncData(const syncer::SyncData& sync_data);
 106
 107   ExtensionSyncData extension_sync_data_;
 108   syncer::StringOrdinal app_launch_ordinal_;
 109   syncer::StringOrdinal page_ordinal_;
 110   extensions::LaunchType launch_type_;
 111   std::string bookmark_app_url_;
 112   std::string bookmark_app_description_;
 113   std::string bookmark_app_icon_color_;
 114   std::vector<LinkedAppIconInfo> linked_icons_;
 115 };
 116
 117 }  // namespace extensions
 118
 119 #endif  // CHROME_BROWSER_EXTENSIONS_APP_SYNC_DATA_H_