chrome/browser/extensions/updater/manifest_fetch_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_UPDATER_MANIFEST_FETCH_DATA_H_
   6 #define CHROME_BROWSER_EXTENSIONS_UPDATER_MANIFEST_FETCH_DATA_H_
   7
   8 #include <map>
   9 #include <set>
  10 #include <string>
  11
  12 #include "base/basictypes.h"
  13 #include "url/gurl.h"
  14
  15 namespace extensions {
  16
  17 // To save on server resources we can request updates for multiple extensions
  18 // in one manifest check. This class helps us keep track of the id's for a
  19 // given fetch, building up the actual URL, and what if anything to include
  20 // in the ping parameter.
  21 class ManifestFetchData {
  22  public:
  23   static const int kNeverPinged = -1;
  24
  25   // Each ping type is sent at most once per day.
  26   enum PingType {
  27     // Used for counting total installs of an extension/app/theme.
  28     ROLLCALL,
  29
  30     // Used for counting number of active users of an app, where "active" means
  31     // the app was launched at least once since the last active ping.
  32     ACTIVE,
  33   };
  34
  35   struct PingData {
  36     // The number of days it's been since our last rollcall or active ping,
  37     // respectively. These are calculated based on the start of day from the
  38     // server's perspective.
  39     int rollcall_days;
  40     int active_days;
  41     // Wether the extension is enabled or not.
  42     bool is_enabled;
  43
  44     PingData() : rollcall_days(0), active_days(0), is_enabled(true) {}
  45     PingData(int rollcall, int active, bool enabled)
  46         : rollcall_days(rollcall), active_days(active), is_enabled(enabled) {}
  47   };
  48
  49   ManifestFetchData(const GURL& update_url, int request_id);
  50   ~ManifestFetchData();
  51
  52   // Returns true if this extension information was successfully added. If the
  53   // return value is false it means the full_url would have become too long, and
  54   // this ManifestFetchData object remains unchanged.
  55   bool AddExtension(std::string id, std::string version,
  56                     const PingData* ping_data,
  57                     const std::string& update_url_data,
  58                     const std::string& install_source);
  59
  60   const GURL& base_url() const { return base_url_; }
  61   const GURL& full_url() const { return full_url_; }
  62   const std::set<std::string>& extension_ids() const { return extension_ids_; }
  63   const std::set<int>& request_ids() const { return request_ids_; }
  64
  65   // Returns true if the given id is included in this manifest fetch.
  66   bool Includes(const std::string& extension_id) const;
  67
  68   // Returns true if a ping parameter for |type| was added to full_url for this
  69   // extension id.
  70   bool DidPing(std::string extension_id, PingType type) const;
  71
  72   // Assuming that both this ManifestFetchData and |other| have the same
  73   // full_url, this method merges the other information associated with the
  74   // fetch (in particular this adds all request ids associated with |other|
  75   // to this ManifestFetchData).
  76   void Merge(const ManifestFetchData& other);
  77
  78  private:
  79   // The set of extension id's for this ManifestFetchData.
  80   std::set<std::string> extension_ids_;
  81
  82   // The set of ping data we actually sent.
  83   std::map<std::string, PingData> pings_;
  84
  85   // The base update url without any arguments added.
  86   GURL base_url_;
  87
  88   // The base update url plus arguments indicating the id, version, etc.
  89   // information about each extension.
  90   GURL full_url_;
  91
  92   // The set of request ids associated with this manifest fetch. If multiple
  93   // requests are trying to fetch the same manifest, they can be merged into
  94   // one fetch, so potentially multiple request ids can get associated with
  95   // one ManifestFetchData.
  96   std::set<int> request_ids_;
  97
  98   DISALLOW_COPY_AND_ASSIGN(ManifestFetchData);
  99 };
 100
 101 }  // namespace extensions
 102
 103 #endif  // CHROME_BROWSER_EXTENSIONS_UPDATER_MANIFEST_FETCH_DATA_H_