OLD | NEW |
| (Empty) |
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 EXTENSIONS_BROWSER_UPDATER_MANIFEST_FETCH_DATA_H_ | |
6 #define EXTENSIONS_BROWSER_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 // What ping mode this fetch should use. | |
26 enum PingMode { | |
27 // No ping, no extra metrics. | |
28 NO_PING, | |
29 | |
30 // Ping without extra metrics. | |
31 PING, | |
32 | |
33 // Ping with extra metrics. | |
34 PING_WITH_METRICS, | |
35 }; | |
36 | |
37 // Each ping type is sent at most once per day. | |
38 enum PingType { | |
39 // Used for counting total installs of an extension/app/theme. | |
40 ROLLCALL, | |
41 | |
42 // Used for counting number of active users of an app, where "active" means | |
43 // the app was launched at least once since the last active ping. | |
44 ACTIVE, | |
45 }; | |
46 | |
47 struct PingData { | |
48 // The number of days it's been since our last rollcall or active ping, | |
49 // respectively. These are calculated based on the start of day from the | |
50 // server's perspective. | |
51 int rollcall_days; | |
52 int active_days; | |
53 // Wether the extension is enabled or not. | |
54 bool is_enabled; | |
55 | |
56 PingData() : rollcall_days(0), active_days(0), is_enabled(true) {} | |
57 PingData(int rollcall, int active, bool enabled) | |
58 : rollcall_days(rollcall), active_days(active), is_enabled(enabled) {} | |
59 }; | |
60 | |
61 ManifestFetchData(const GURL& update_url, | |
62 int request_id, | |
63 const std::string& brand_code, | |
64 const std::string& base_query_params, | |
65 PingMode ping_mode); | |
66 ~ManifestFetchData(); | |
67 | |
68 // Returns true if this extension information was successfully added. If the | |
69 // return value is false it means the full_url would have become too long, and | |
70 // this ManifestFetchData object remains unchanged. | |
71 bool AddExtension(const std::string& id, | |
72 const std::string& version, | |
73 const PingData* ping_data, | |
74 const std::string& update_url_data, | |
75 const std::string& install_source); | |
76 | |
77 const GURL& base_url() const { return base_url_; } | |
78 const GURL& full_url() const { return full_url_; } | |
79 const std::set<std::string>& extension_ids() const { return extension_ids_; } | |
80 const std::set<int>& request_ids() const { return request_ids_; } | |
81 | |
82 // Returns true if the given id is included in this manifest fetch. | |
83 bool Includes(const std::string& extension_id) const; | |
84 | |
85 // Returns true if a ping parameter for |type| was added to full_url for this | |
86 // extension id. | |
87 bool DidPing(const std::string& extension_id, PingType type) const; | |
88 | |
89 // Assuming that both this ManifestFetchData and |other| have the same | |
90 // full_url, this method merges the other information associated with the | |
91 // fetch (in particular this adds all request ids associated with |other| | |
92 // to this ManifestFetchData). | |
93 void Merge(const ManifestFetchData& other); | |
94 | |
95 private: | |
96 // The set of extension id's for this ManifestFetchData. | |
97 std::set<std::string> extension_ids_; | |
98 | |
99 // The set of ping data we actually sent. | |
100 std::map<std::string, PingData> pings_; | |
101 | |
102 // The base update url without any arguments added. | |
103 GURL base_url_; | |
104 | |
105 // The base update url plus arguments indicating the id, version, etc. | |
106 // information about each extension. | |
107 GURL full_url_; | |
108 | |
109 // The set of request ids associated with this manifest fetch. If multiple | |
110 // requests are trying to fetch the same manifest, they can be merged into | |
111 // one fetch, so potentially multiple request ids can get associated with | |
112 // one ManifestFetchData. | |
113 std::set<int> request_ids_; | |
114 | |
115 // The brand code to include with manifest fetch queries, if non-empty and | |
116 // |ping_mode_| >= PING. | |
117 const std::string brand_code_; | |
118 | |
119 // The ping mode for this fetch. This determines whether or not ping data | |
120 // (and possibly extra metrics) will be included in the fetch query. | |
121 const PingMode ping_mode_; | |
122 | |
123 DISALLOW_COPY_AND_ASSIGN(ManifestFetchData); | |
124 }; | |
125 | |
126 } // namespace extensions | |
127 | |
128 #endif // EXTENSIONS_BROWSER_UPDATER_MANIFEST_FETCH_DATA_H_ | |
OLD | NEW |