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
15namespace 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.
21class 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(const std::string& id,
56                    const std::string& version,
57                    const PingData* ping_data,
58                    const std::string& update_url_data,
59                    const std::string& install_source);
60
61  const GURL& base_url() const { return base_url_; }
62  const GURL& full_url() const { return full_url_; }
63  const std::set<std::string>& extension_ids() const { return extension_ids_; }
64  const std::set<int>& request_ids() const { return request_ids_; }
65
66  // Returns true if the given id is included in this manifest fetch.
67  bool Includes(const std::string& extension_id) const;
68
69  // Returns true if a ping parameter for |type| was added to full_url for this
70  // extension id.
71  bool DidPing(const std::string& extension_id, PingType type) const;
72
73  // Assuming that both this ManifestFetchData and |other| have the same
74  // full_url, this method merges the other information associated with the
75  // fetch (in particular this adds all request ids associated with |other|
76  // to this ManifestFetchData).
77  void Merge(const ManifestFetchData& other);
78
79 private:
80  // The set of extension id's for this ManifestFetchData.
81  std::set<std::string> extension_ids_;
82
83  // The set of ping data we actually sent.
84  std::map<std::string, PingData> pings_;
85
86  // The base update url without any arguments added.
87  GURL base_url_;
88
89  // The base update url plus arguments indicating the id, version, etc.
90  // information about each extension.
91  GURL full_url_;
92
93  // The set of request ids associated with this manifest fetch. If multiple
94  // requests are trying to fetch the same manifest, they can be merged into
95  // one fetch, so potentially multiple request ids can get associated with
96  // one ManifestFetchData.
97  std::set<int> request_ids_;
98
99  DISALLOW_COPY_AND_ASSIGN(ManifestFetchData);
100};
101
102}  // namespace extensions
103
104#endif  // CHROME_BROWSER_EXTENSIONS_UPDATER_MANIFEST_FETCH_DATA_H_
105