blob: 7d7af81a5590b2bda9105084fb2cc016bcd52750 [file] [log] [blame]
Mike Frysinger8155d082012-04-06 15:23:18 -04001// Copyright (c) 2012 The Chromium OS Authors. All rights reserved.
rspangler@google.com49fdf182009-10-10 00:57:34 +00002// Use of this source code is governed by a BSD-style license that can be
3// found in the LICENSE file.
4
Darin Petkov6a5b3222010-07-13 14:55:28 -07005#include "update_engine/omaha_request_action.h"
Darin Petkov85ced132010-09-01 10:20:56 -07006
Andrew de los Reyes08c4e272010-04-15 14:02:17 -07007#include <inttypes.h>
Darin Petkov85ced132010-09-01 10:20:56 -07008
David Zeuthene8ed8632014-07-24 13:38:10 -04009#include <map>
rspangler@google.com49fdf182009-10-10 00:57:34 +000010#include <sstream>
Jay Srinivasan480ddfa2012-06-01 19:15:26 -070011#include <string>
David Zeuthene8ed8632014-07-24 13:38:10 -040012#include <vector>
rspangler@google.com49fdf182009-10-10 00:57:34 +000013
David Zeuthen8f191b22013-08-06 12:27:50 -070014#include <base/bind.h>
Jay Srinivasan480ddfa2012-06-01 19:15:26 -070015#include <base/logging.h>
16#include <base/rand_util.h>
Alex Vakulenko75039d72014-03-25 12:36:28 -070017#include <base/strings/string_number_conversions.h>
18#include <base/strings/string_util.h>
19#include <base/strings/stringprintf.h>
20#include <base/time/time.h>
David Zeuthene8ed8632014-07-24 13:38:10 -040021#include <expat.h>
rspangler@google.com49fdf182009-10-10 00:57:34 +000022
23#include "update_engine/action_pipe.h"
Jay Srinivasand29695d2013-04-08 15:08:05 -070024#include "update_engine/constants.h"
J. Richard Barnette056b0ab2013-10-29 15:24:56 -070025#include "update_engine/hardware_interface.h"
David Zeuthen8f191b22013-08-06 12:27:50 -070026#include "update_engine/omaha_hash_calculator.h"
Darin Petkova4a8a8c2010-07-15 22:21:12 -070027#include "update_engine/omaha_request_params.h"
David Zeuthen8f191b22013-08-06 12:27:50 -070028#include "update_engine/p2p_manager.h"
Jay Srinivasan55f50c22013-01-10 19:24:35 -080029#include "update_engine/payload_state_interface.h"
Darin Petkov1cbd78f2010-07-29 12:38:34 -070030#include "update_engine/prefs_interface.h"
Chris Sosa77f79e82014-06-02 18:16:24 -070031#include "update_engine/real_dbus_wrapper.h"
adlr@google.comc98a7ed2009-12-04 18:54:03 +000032#include "update_engine/utils.h"
rspangler@google.com49fdf182009-10-10 00:57:34 +000033
Darin Petkov1cbd78f2010-07-29 12:38:34 -070034using base::Time;
35using base::TimeDelta;
David Zeuthene8ed8632014-07-24 13:38:10 -040036using std::map;
rspangler@google.com49fdf182009-10-10 00:57:34 +000037using std::string;
David Zeuthene8ed8632014-07-24 13:38:10 -040038using std::vector;
rspangler@google.com49fdf182009-10-10 00:57:34 +000039
40namespace chromeos_update_engine {
41
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080042// List of custom pair tags that we interpret in the Omaha Response:
43static const char* kTagDeadline = "deadline";
Jay Srinivasan08262882012-12-28 19:29:43 -080044static const char* kTagDisablePayloadBackoff = "DisablePayloadBackoff";
Chris Sosa3b748432013-06-20 16:42:59 -070045static const char* kTagVersion = "version";
Jay Srinivasand671e972013-01-11 17:17:19 -080046// Deprecated: "IsDelta"
47static const char* kTagIsDeltaPayload = "IsDeltaPayload";
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080048static const char* kTagMaxFailureCountPerUrl = "MaxFailureCountPerUrl";
49static const char* kTagMaxDaysToScatter = "MaxDaysToScatter";
50// Deprecated: "ManifestSignatureRsa"
51// Deprecated: "ManifestSize"
52static const char* kTagMetadataSignatureRsa = "MetadataSignatureRsa";
53static const char* kTagMetadataSize = "MetadataSize";
54static const char* kTagMoreInfo = "MoreInfo";
Don Garrett42bd3aa2013-04-10 18:14:56 -070055// Deprecated: "NeedsAdmin"
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080056static const char* kTagPrompt = "Prompt";
57static const char* kTagSha256 = "sha256";
David Zeuthen8f191b22013-08-06 12:27:50 -070058static const char* kTagDisableP2PForDownloading = "DisableP2PForDownloading";
59static const char* kTagDisableP2PForSharing = "DisableP2PForSharing";
David Zeuthene7f89172013-10-31 10:21:04 -070060static const char* kTagPublicKeyRsa = "PublicKeyRsa";
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -080061
rspangler@google.com49fdf182009-10-10 00:57:34 +000062namespace {
63
Alex Vakulenkod2779df2014-06-16 13:19:00 -070064static const char* const kGupdateVersion = "ChromeOSUpdateEngine-0.1.0.0";
rspangler@google.com49fdf182009-10-10 00:57:34 +000065
Darin Petkov1cbd78f2010-07-29 12:38:34 -070066// Returns an XML ping element attribute assignment with attribute
67// |name| and value |ping_days| if |ping_days| has a value that needs
68// to be sent, or an empty string otherwise.
69string GetPingAttribute(const string& name, int ping_days) {
Alex Deymoebbe7ef2014-10-30 13:02:49 -070070 if (ping_days > 0 || ping_days == OmahaRequestAction::kNeverPinged)
Alex Vakulenko75039d72014-03-25 12:36:28 -070071 return base::StringPrintf(" %s=\"%d\"", name.c_str(), ping_days);
Darin Petkov1cbd78f2010-07-29 12:38:34 -070072 return "";
73}
74
75// Returns an XML ping element if any of the elapsed days need to be
76// sent, or an empty string otherwise.
Jay Srinivasanae4697c2013-03-18 17:08:08 -070077string GetPingXml(int ping_active_days, int ping_roll_call_days) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -070078 string ping_active = GetPingAttribute("a", ping_active_days);
79 string ping_roll_call = GetPingAttribute("r", ping_roll_call_days);
80 if (!ping_active.empty() || !ping_roll_call.empty()) {
Alex Vakulenko75039d72014-03-25 12:36:28 -070081 return base::StringPrintf(" <ping active=\"1\"%s%s></ping>\n",
Alex Deymoebbe7ef2014-10-30 13:02:49 -070082 ping_active.c_str(),
83 ping_roll_call.c_str());
Darin Petkov1cbd78f2010-07-29 12:38:34 -070084 }
85 return "";
86}
87
Jay Srinivasanae4697c2013-03-18 17:08:08 -070088// Returns an XML that goes into the body of the <app> element of the Omaha
89// request based on the given parameters.
90string GetAppBody(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -070091 OmahaRequestParams* params,
Jay Srinivasanae4697c2013-03-18 17:08:08 -070092 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -070093 bool include_ping,
Jay Srinivasanae4697c2013-03-18 17:08:08 -070094 int ping_active_days,
95 int ping_roll_call_days,
96 PrefsInterface* prefs) {
97 string app_body;
Alex Vakulenko88b591f2014-08-28 16:48:57 -070098 if (event == nullptr) {
Alex Deymoebbe7ef2014-10-30 13:02:49 -070099 if (include_ping)
100 app_body = GetPingXml(ping_active_days, ping_roll_call_days);
Darin Petkov265f2902011-05-09 15:17:40 -0700101 if (!ping_only) {
Alex Vakulenko75039d72014-03-25 12:36:28 -0700102 app_body += base::StringPrintf(
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700103 " <updatecheck targetversionprefix=\"%s\""
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700104 "></updatecheck>\n",
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700105 XmlEncode(params->target_version_prefix()).c_str());
Jay Srinivasan0a708742012-03-20 11:26:12 -0700106
Darin Petkov265f2902011-05-09 15:17:40 -0700107 // If this is the first update check after a reboot following a previous
108 // update, generate an event containing the previous version number. If
109 // the previous version preference file doesn't exist the event is still
110 // generated with a previous version of 0.0.0.0 -- this is relevant for
111 // older clients or new installs. The previous version event is not sent
112 // for ping-only requests because they come before the client has
113 // rebooted.
114 string prev_version;
115 if (!prefs->GetString(kPrefsPreviousVersion, &prev_version)) {
116 prev_version = "0.0.0.0";
117 }
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700118
Alex Vakulenko75039d72014-03-25 12:36:28 -0700119 app_body += base::StringPrintf(
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700120 " <event eventtype=\"%d\" eventresult=\"%d\" "
121 "previousversion=\"%s\"></event>\n",
122 OmahaEvent::kTypeUpdateComplete,
123 OmahaEvent::kResultSuccessReboot,
124 XmlEncode(prev_version).c_str());
125 LOG_IF(WARNING, !prefs->SetString(kPrefsPreviousVersion, ""))
126 << "Unable to reset the previous version.";
Darin Petkov95508da2011-01-05 12:42:29 -0800127 }
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700128 } else {
Darin Petkovc91dd6b2011-01-10 12:31:34 -0800129 // The error code is an optional attribute so append it only if the result
130 // is not success.
Darin Petkove17f86b2010-07-20 09:12:01 -0700131 string error_code;
132 if (event->result != OmahaEvent::kResultSuccess) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700133 error_code = base::StringPrintf(" errorcode=\"%d\"",
134 static_cast<int>(event->error_code));
Darin Petkove17f86b2010-07-20 09:12:01 -0700135 }
Alex Vakulenko75039d72014-03-25 12:36:28 -0700136 app_body = base::StringPrintf(
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700137 " <event eventtype=\"%d\" eventresult=\"%d\"%s></event>\n",
Darin Petkove17f86b2010-07-20 09:12:01 -0700138 event->type, event->result, error_code.c_str());
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700139 }
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700140
141 return app_body;
142}
143
144// Returns an XML that corresponds to the entire <app> node of the Omaha
145// request based on the given parameters.
146string GetAppXml(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700147 OmahaRequestParams* params,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700148 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700149 bool include_ping,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700150 int ping_active_days,
151 int ping_roll_call_days,
David Zeuthen639aa362014-02-03 16:23:44 -0800152 int install_date_in_days,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700153 SystemState* system_state) {
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700154 string app_body = GetAppBody(event, params, ping_only, include_ping,
155 ping_active_days, ping_roll_call_days,
156 system_state->prefs());
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700157 string app_versions;
158
159 // If we are upgrading to a more stable channel and we are allowed to do
160 // powerwash, then pass 0.0.0.0 as the version. This is needed to get the
161 // highest-versioned payload on the destination channel.
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700162 if (params->to_more_stable_channel() && params->is_powerwash_allowed()) {
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700163 LOG(INFO) << "Passing OS version as 0.0.0.0 as we are set to powerwash "
164 << "on downgrading to the version in the more stable channel";
165 app_versions = "version=\"0.0.0.0\" from_version=\"" +
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700166 XmlEncode(params->app_version()) + "\" ";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700167 } else {
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700168 app_versions = "version=\"" + XmlEncode(params->app_version()) + "\" ";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700169 }
170
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700171 string download_channel = params->download_channel();
172 string app_channels = "track=\"" + XmlEncode(download_channel) + "\" ";
173 if (params->current_channel() != download_channel)
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700174 app_channels +=
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700175 "from_track=\"" + XmlEncode(params->current_channel()) + "\" ";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700176
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700177 string delta_okay_str = params->delta_okay() ? "true" : "false";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700178
David Zeuthen639aa362014-02-03 16:23:44 -0800179 // If install_date_days is not set (e.g. its value is -1 ), don't
180 // include the attribute.
181 string install_date_in_days_str = "";
182 if (install_date_in_days >= 0) {
Alex Vakulenko75039d72014-03-25 12:36:28 -0700183 install_date_in_days_str = base::StringPrintf("installdate=\"%d\" ",
184 install_date_in_days);
David Zeuthen639aa362014-02-03 16:23:44 -0800185 }
186
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700187 string app_xml =
Jay Srinivasandb0acdf2013-04-02 14:47:45 -0700188 " <app appid=\"" + XmlEncode(params->GetAppId()) + "\" " +
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700189 app_versions +
190 app_channels +
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700191 "lang=\"" + XmlEncode(params->app_lang()) + "\" " +
192 "board=\"" + XmlEncode(params->os_board()) + "\" " +
193 "hardware_class=\"" + XmlEncode(params->hwid()) + "\" " +
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700194 "delta_okay=\"" + delta_okay_str + "\" "
Chris Sosac1972482013-04-30 22:31:10 -0700195 "fw_version=\"" + XmlEncode(params->fw_version()) + "\" " +
196 "ec_version=\"" + XmlEncode(params->ec_version()) + "\" " +
David Zeuthen639aa362014-02-03 16:23:44 -0800197 install_date_in_days_str +
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700198 ">\n" +
199 app_body +
200 " </app>\n";
201
202 return app_xml;
203}
204
205// Returns an XML that corresponds to the entire <os> node of the Omaha
206// request based on the given parameters.
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700207string GetOsXml(OmahaRequestParams* params) {
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700208 string os_xml =
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700209 " <os version=\"" + XmlEncode(params->os_version()) + "\" " +
210 "platform=\"" + XmlEncode(params->os_platform()) + "\" " +
211 "sp=\"" + XmlEncode(params->os_sp()) + "\">"
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700212 "</os>\n";
213 return os_xml;
214}
215
216// Returns an XML that corresponds to the entire Omaha request based on the
217// given parameters.
218string GetRequestXml(const OmahaEvent* event,
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700219 OmahaRequestParams* params,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700220 bool ping_only,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700221 bool include_ping,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700222 int ping_active_days,
223 int ping_roll_call_days,
David Zeuthen639aa362014-02-03 16:23:44 -0800224 int install_date_in_days,
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700225 SystemState* system_state) {
226 string os_xml = GetOsXml(params);
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700227 string app_xml = GetAppXml(event, params, ping_only, include_ping,
228 ping_active_days, ping_roll_call_days,
229 install_date_in_days, system_state);
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700230
Alex Vakulenko75039d72014-03-25 12:36:28 -0700231 string install_source = base::StringPrintf("installsource=\"%s\" ",
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700232 (params->interactive() ? "ondemandupdate" : "scheduler"));
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700233
234 string request_xml =
235 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700236 "<request protocol=\"3.0\" "
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700237 "version=\"" + XmlEncode(kGupdateVersion) + "\" "
238 "updaterversion=\"" + XmlEncode(kGupdateVersion) + "\" " +
239 install_source +
240 "ismachine=\"1\">\n" +
241 os_xml +
242 app_xml +
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700243 "</request>\n";
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700244
245 return request_xml;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000246}
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700247
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700248} // namespace
rspangler@google.com49fdf182009-10-10 00:57:34 +0000249
David Zeuthene8ed8632014-07-24 13:38:10 -0400250// Struct used for holding data obtained when parsing the XML.
251struct OmahaParserData {
David Zeuthenf3e28012014-08-26 18:23:52 -0400252 explicit OmahaParserData(XML_Parser _xml_parser) : xml_parser(_xml_parser) {}
253
254 // Pointer to the expat XML_Parser object.
255 XML_Parser xml_parser;
256
David Zeuthene8ed8632014-07-24 13:38:10 -0400257 // This is the state of the parser as it's processing the XML.
258 bool failed = false;
David Zeuthenf3e28012014-08-26 18:23:52 -0400259 bool entity_decl = false;
David Zeuthene8ed8632014-07-24 13:38:10 -0400260 string current_path;
261
262 // These are the values extracted from the XML.
263 string updatecheck_status;
264 string updatecheck_poll_interval;
265 string daystart_elapsed_days;
266 string daystart_elapsed_seconds;
267 vector<string> url_codebase;
268 string package_name;
269 string package_size;
270 string manifest_version;
271 map<string, string> action_postinstall_attrs;
272};
273
274namespace {
275
276// Callback function invoked by expat.
277void ParserHandlerStart(void* user_data, const XML_Char* element,
278 const XML_Char** attr) {
279 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
280
281 if (data->failed)
282 return;
283
284 data->current_path += string("/") + element;
285
286 map<string, string> attrs;
287 if (attr != nullptr) {
288 for (int n = 0; attr[n] != nullptr && attr[n+1] != nullptr; n += 2) {
289 string key = attr[n];
290 string value = attr[n + 1];
291 attrs[key] = value;
292 }
293 }
294
295 if (data->current_path == "/response/app/updatecheck") {
296 // There is only supposed to be a single <updatecheck> element.
297 data->updatecheck_status = attrs["status"];
298 data->updatecheck_poll_interval = attrs["PollInterval"];
299 } else if (data->current_path == "/response/daystart") {
300 // Get the install-date.
301 data->daystart_elapsed_days = attrs["elapsed_days"];
302 data->daystart_elapsed_seconds = attrs["elapsed_seconds"];
303 } else if (data->current_path == "/response/app/updatecheck/urls/url") {
304 // Look at all <url> elements.
305 data->url_codebase.push_back(attrs["codebase"]);
306 } else if (data->package_name.empty() && data->current_path ==
307 "/response/app/updatecheck/manifest/packages/package") {
308 // Only look at the first <package>.
309 data->package_name = attrs["name"];
310 data->package_size = attrs["size"];
311 } else if (data->current_path == "/response/app/updatecheck/manifest") {
312 // Get the version.
313 data->manifest_version = attrs[kTagVersion];
314 } else if (data->current_path ==
315 "/response/app/updatecheck/manifest/actions/action") {
316 // We only care about the postinstall action.
317 if (attrs["event"] == "postinstall") {
318 data->action_postinstall_attrs = attrs;
319 }
320 }
321}
322
323// Callback function invoked by expat.
324void ParserHandlerEnd(void* user_data, const XML_Char* element) {
325 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
326 if (data->failed)
327 return;
328
329 const string path_suffix = string("/") + element;
330
331 if (!EndsWith(data->current_path, path_suffix, true)) {
332 LOG(ERROR) << "Unexpected end element '" << element
333 << "' with current_path='" << data->current_path << "'";
334 data->failed = true;
335 return;
336 }
337 data->current_path.resize(data->current_path.size() - path_suffix.size());
338}
339
David Zeuthenf3e28012014-08-26 18:23:52 -0400340// Callback function invoked by expat.
341//
342// This is called for entity declarations. Since Omaha is guaranteed
343// to never return any XML with entities our course of action is to
344// just stop parsing. This avoids potential resource exhaustion
345// problems AKA the "billion laughs". CVE-2013-0340.
346void ParserHandlerEntityDecl(void *user_data,
347 const XML_Char *entity_name,
348 int is_parameter_entity,
349 const XML_Char *value,
350 int value_length,
351 const XML_Char *base,
352 const XML_Char *system_id,
353 const XML_Char *public_id,
354 const XML_Char *notation_name) {
355 OmahaParserData* data = reinterpret_cast<OmahaParserData*>(user_data);
356
357 LOG(ERROR) << "XML entities are not supported. Aborting parsing.";
358 data->failed = true;
359 data->entity_decl = true;
360 XML_StopParser(data->xml_parser, false);
361}
362
David Zeuthene8ed8632014-07-24 13:38:10 -0400363} // namespace
364
365// Escapes text so it can be included as character data and attribute
366// values. The |input| string must be valid UTF-8.
rspangler@google.com49fdf182009-10-10 00:57:34 +0000367string XmlEncode(const string& input) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400368 gchar* escaped = g_markup_escape_text(input.c_str(), input.size());
369 string ret = string(escaped);
370 g_free(escaped);
371 return ret;
rspangler@google.com49fdf182009-10-10 00:57:34 +0000372}
373
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800374OmahaRequestAction::OmahaRequestAction(SystemState* system_state,
Darin Petkova4a8a8c2010-07-15 22:21:12 -0700375 OmahaEvent* event,
Thieu Le116fda32011-04-19 11:01:54 -0700376 HttpFetcher* http_fetcher,
377 bool ping_only)
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800378 : system_state_(system_state),
Darin Petkova4a8a8c2010-07-15 22:21:12 -0700379 event_(event),
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700380 http_fetcher_(http_fetcher),
Thieu Le116fda32011-04-19 11:01:54 -0700381 ping_only_(ping_only),
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700382 ping_active_days_(0),
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700383 ping_roll_call_days_(0) {
384 params_ = system_state->request_params();
385}
rspangler@google.com49fdf182009-10-10 00:57:34 +0000386
Darin Petkov6a5b3222010-07-13 14:55:28 -0700387OmahaRequestAction::~OmahaRequestAction() {}
rspangler@google.com49fdf182009-10-10 00:57:34 +0000388
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700389// Calculates the value to use for the ping days parameter.
390int OmahaRequestAction::CalculatePingDays(const string& key) {
391 int days = kNeverPinged;
392 int64_t last_ping = 0;
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800393 if (system_state_->prefs()->GetInt64(key, &last_ping) && last_ping >= 0) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700394 days = (Time::Now() - Time::FromInternalValue(last_ping)).InDays();
395 if (days < 0) {
396 // If |days| is negative, then the system clock must have jumped
397 // back in time since the ping was sent. Mark the value so that
398 // it doesn't get sent to the server but we still update the
399 // last ping daystart preference. This way the next ping time
400 // will be correct, hopefully.
401 days = kPingTimeJump;
402 LOG(WARNING) <<
403 "System clock jumped back in time. Resetting ping daystarts.";
404 }
405 }
406 return days;
407}
408
409void OmahaRequestAction::InitPingDays() {
410 // We send pings only along with update checks, not with events.
411 if (IsEvent()) {
412 return;
413 }
414 // TODO(petkov): Figure a way to distinguish active use pings
415 // vs. roll call pings. Currently, the two pings are identical. A
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700416 // fix needs to change this code as well as UpdateLastPingDays and ShouldPing.
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700417 ping_active_days_ = CalculatePingDays(kPrefsLastActivePingDay);
418 ping_roll_call_days_ = CalculatePingDays(kPrefsLastRollCallPingDay);
419}
420
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700421bool OmahaRequestAction::ShouldPing() const {
422 if (ping_active_days_ == OmahaRequestAction::kNeverPinged &&
423 ping_roll_call_days_ == OmahaRequestAction::kNeverPinged) {
424 int powerwash_count = system_state_->hardware()->GetPowerwashCount();
425 if (powerwash_count > 0) {
426 LOG(INFO) << "Not sending ping with a=-1 r=-1 to omaha because "
427 << "powerwash_count is " << powerwash_count;
428 return false;
429 }
430 return true;
431 }
432 return ping_active_days_ > 0 || ping_roll_call_days_ > 0;
433}
434
David Zeuthen639aa362014-02-03 16:23:44 -0800435// static
436int OmahaRequestAction::GetInstallDate(SystemState* system_state) {
437 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700438 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -0800439 return -1;
440
441 // If we have the value stored on disk, just return it.
442 int64_t stored_value;
443 if (prefs->GetInt64(kPrefsInstallDateDays, &stored_value)) {
444 // Convert and sanity-check.
445 int install_date_days = static_cast<int>(stored_value);
446 if (install_date_days >= 0)
447 return install_date_days;
448 LOG(ERROR) << "Dropping stored Omaha InstallData since its value num_days="
449 << install_date_days << " looks suspicious.";
450 prefs->Delete(kPrefsInstallDateDays);
451 }
452
453 // Otherwise, if OOBE is not complete then do nothing and wait for
454 // ParseResponse() to call ParseInstallDate() and then
455 // PersistInstallDate() to set the kPrefsInstallDateDays state
456 // variable. Once that is done, we'll then report back in future
457 // Omaha requests. This works exactly because OOBE triggers an
458 // update check.
459 //
460 // However, if OOBE is complete and the kPrefsInstallDateDays state
461 // variable is not set, there are two possibilities
462 //
463 // 1. The update check in OOBE failed so we never got a response
464 // from Omaha (no network etc.); or
465 //
466 // 2. OOBE was done on an older version that didn't write to the
467 // kPrefsInstallDateDays state variable.
468 //
469 // In both cases, we approximate the install date by simply
470 // inspecting the timestamp of when OOBE happened.
471
472 Time time_of_oobe;
Alex Deymobccbc382014-04-03 13:38:55 -0700473 if (!system_state->hardware()->IsOOBEComplete(&time_of_oobe)) {
David Zeuthen639aa362014-02-03 16:23:44 -0800474 LOG(INFO) << "Not generating Omaha InstallData as we have "
475 << "no prefs file and OOBE is not complete.";
476 return -1;
477 }
478
479 int num_days;
480 if (!utils::ConvertToOmahaInstallDate(time_of_oobe, &num_days)) {
481 LOG(ERROR) << "Not generating Omaha InstallData from time of OOBE "
482 << "as its value '" << utils::ToString(time_of_oobe)
483 << "' looks suspicious.";
484 return -1;
485 }
486
487 // Persist this to disk, for future use.
488 if (!OmahaRequestAction::PersistInstallDate(system_state,
489 num_days,
490 kProvisionedFromOOBEMarker))
491 return -1;
492
493 LOG(INFO) << "Set the Omaha InstallDate from OOBE time-stamp to "
494 << num_days << " days";
495
496 return num_days;
497}
498
Darin Petkov6a5b3222010-07-13 14:55:28 -0700499void OmahaRequestAction::PerformAction() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000500 http_fetcher_->set_delegate(this);
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700501 InitPingDays();
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700502 if (ping_only_ && !ShouldPing()) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700503 processor_->ActionComplete(this, ErrorCode::kSuccess);
Thieu Leb44e9e82011-06-06 14:34:04 -0700504 return;
505 }
David Zeuthen639aa362014-02-03 16:23:44 -0800506
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700507 string request_post(GetRequestXml(event_.get(),
Jay Srinivasan1c0fe792013-03-28 16:45:25 -0700508 params_,
Thieu Le116fda32011-04-19 11:01:54 -0700509 ping_only_,
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700510 ShouldPing(), // include_ping
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700511 ping_active_days_,
Darin Petkov95508da2011-01-05 12:42:29 -0800512 ping_roll_call_days_,
David Zeuthen639aa362014-02-03 16:23:44 -0800513 GetInstallDate(system_state_),
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700514 system_state_));
Jay Srinivasan0a708742012-03-20 11:26:12 -0700515
Gilad Arnold9dd1e7c2012-02-16 12:13:36 -0800516 http_fetcher_->SetPostData(request_post.data(), request_post.size(),
517 kHttpContentTypeTextXml);
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700518 LOG(INFO) << "Posting an Omaha request to " << params_->update_url();
Andrew de los Reyesf98bff82010-05-06 13:33:25 -0700519 LOG(INFO) << "Request: " << request_post;
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700520 http_fetcher_->BeginTransfer(params_->update_url());
rspangler@google.com49fdf182009-10-10 00:57:34 +0000521}
522
Darin Petkov6a5b3222010-07-13 14:55:28 -0700523void OmahaRequestAction::TerminateProcessing() {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000524 http_fetcher_->TerminateTransfer();
525}
526
527// We just store the response in the buffer. Once we've received all bytes,
528// we'll look in the buffer and decide what to do.
Darin Petkov6a5b3222010-07-13 14:55:28 -0700529void OmahaRequestAction::ReceivedBytes(HttpFetcher *fetcher,
530 const char* bytes,
531 int length) {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000532 response_buffer_.reserve(response_buffer_.size() + length);
533 response_buffer_.insert(response_buffer_.end(), bytes, bytes + length);
534}
535
536namespace {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000537
538// Parses a 64 bit base-10 int from a string and returns it. Returns 0
539// on error. If the string contains "0", that's indistinguishable from
540// error.
541off_t ParseInt(const string& str) {
542 off_t ret = 0;
Gilad Arnoldec7f9162014-07-15 13:24:46 -0700543 int rc = sscanf(str.c_str(), "%" PRIi64, &ret); // NOLINT(runtime/printf)
rspangler@google.com49fdf182009-10-10 00:57:34 +0000544 if (rc < 1) {
545 // failure
546 return 0;
547 }
548 return ret;
549}
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700550
David Zeuthene8ed8632014-07-24 13:38:10 -0400551// Parses |str| and returns |true| if, and only if, its value is "true".
552bool ParseBool(const string& str) {
553 return str == "true";
554}
555
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700556// Update the last ping day preferences based on the server daystart
557// response. Returns true on success, false otherwise.
David Zeuthene8ed8632014-07-24 13:38:10 -0400558bool UpdateLastPingDays(OmahaParserData *parser_data, PrefsInterface* prefs) {
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700559 int64_t elapsed_seconds = 0;
David Zeuthene8ed8632014-07-24 13:38:10 -0400560 TEST_AND_RETURN_FALSE(
561 base::StringToInt64(parser_data->daystart_elapsed_seconds,
562 &elapsed_seconds));
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700563 TEST_AND_RETURN_FALSE(elapsed_seconds >= 0);
564
565 // Remember the local time that matches the server's last midnight
566 // time.
567 Time daystart = Time::Now() - TimeDelta::FromSeconds(elapsed_seconds);
568 prefs->SetInt64(kPrefsLastActivePingDay, daystart.ToInternalValue());
569 prefs->SetInt64(kPrefsLastRollCallPingDay, daystart.ToInternalValue());
570 return true;
571}
Alex Vakulenkod2779df2014-06-16 13:19:00 -0700572} // namespace
rspangler@google.com49fdf182009-10-10 00:57:34 +0000573
David Zeuthene8ed8632014-07-24 13:38:10 -0400574bool OmahaRequestAction::ParseResponse(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700575 OmahaResponse* output_object,
576 ScopedActionCompleter* completer) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400577 if (parser_data->updatecheck_status.empty()) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700578 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700579 return false;
580 }
581
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800582 // chromium-os:37289: The PollInterval is not supported by Omaha server
583 // currently. But still keeping this existing code in case we ever decide to
Gilad Arnoldec7f9162014-07-15 13:24:46 -0700584 // slow down the request rate from the server-side. Note that the PollInterval
585 // is not persisted, so it has to be sent by the server on every response to
586 // guarantee that the scheduler uses this value (otherwise, if the device got
587 // rebooted after the last server-indicated value, it'll revert to the default
588 // value). Also kDefaultMaxUpdateChecks value for the scattering logic is
589 // based on the assumption that we perform an update check every hour so that
590 // the max value of 8 will roughly be equivalent to one work day. If we decide
591 // to use PollInterval permanently, we should update the
592 // max_update_checks_allowed to take PollInterval into account. Note: The
593 // parsing for PollInterval happens even before parsing of the status because
594 // we may want to specify the PollInterval even when there's no update.
David Zeuthene8ed8632014-07-24 13:38:10 -0400595 base::StringToInt(parser_data->updatecheck_poll_interval,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700596 &output_object->poll_interval);
597
David Zeuthen639aa362014-02-03 16:23:44 -0800598 // Check for the "elapsed_days" attribute in the "daystart"
599 // element. This is the number of days since Jan 1 2007, 0:00
600 // PST. If we don't have a persisted value of the Omaha InstallDate,
601 // we'll use it to calculate it and then persist it.
David Zeuthene8ed8632014-07-24 13:38:10 -0400602 if (ParseInstallDate(parser_data, output_object) &&
603 !HasInstallDate(system_state_)) {
David Zeuthen639aa362014-02-03 16:23:44 -0800604 // Since output_object->install_date_days is never negative, the
605 // elapsed_days -> install-date calculation is reduced to simply
606 // rounding down to the nearest number divisible by 7.
607 int remainder = output_object->install_date_days % 7;
608 int install_date_days_rounded =
609 output_object->install_date_days - remainder;
610 if (PersistInstallDate(system_state_,
611 install_date_days_rounded,
612 kProvisionedFromOmahaResponse)) {
613 LOG(INFO) << "Set the Omaha InstallDate from Omaha Response to "
614 << install_date_days_rounded << " days";
615 }
616 }
617
David Zeuthene8ed8632014-07-24 13:38:10 -0400618 if (!ParseStatus(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700619 return false;
620
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800621 // Note: ParseUrls MUST be called before ParsePackage as ParsePackage
622 // appends the package name to the URLs populated in this method.
David Zeuthene8ed8632014-07-24 13:38:10 -0400623 if (!ParseUrls(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700624 return false;
625
David Zeuthene8ed8632014-07-24 13:38:10 -0400626 if (!ParsePackage(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700627 return false;
628
David Zeuthene8ed8632014-07-24 13:38:10 -0400629 if (!ParseParams(parser_data, output_object, completer))
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700630 return false;
631
632 return true;
633}
634
David Zeuthene8ed8632014-07-24 13:38:10 -0400635bool OmahaRequestAction::ParseStatus(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700636 OmahaResponse* output_object,
637 ScopedActionCompleter* completer) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400638 const string& status = parser_data->updatecheck_status;
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700639 if (status == "noupdate") {
640 LOG(INFO) << "No update.";
641 output_object->update_exists = false;
642 SetOutputObject(*output_object);
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700643 completer->set_code(ErrorCode::kSuccess);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700644 return false;
645 }
646
647 if (status != "ok") {
648 LOG(ERROR) << "Unknown Omaha response status: " << status;
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700649 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700650 return false;
651 }
652
653 return true;
654}
655
David Zeuthene8ed8632014-07-24 13:38:10 -0400656bool OmahaRequestAction::ParseUrls(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700657 OmahaResponse* output_object,
658 ScopedActionCompleter* completer) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400659 if (parser_data->url_codebase.empty()) {
660 LOG(ERROR) << "No Omaha Response URLs";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700661 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700662 return false;
663 }
664
David Zeuthene8ed8632014-07-24 13:38:10 -0400665 LOG(INFO) << "Found " << parser_data->url_codebase.size() << " url(s)";
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800666 output_object->payload_urls.clear();
David Zeuthene8ed8632014-07-24 13:38:10 -0400667 for (const auto& codebase : parser_data->url_codebase) {
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800668 if (codebase.empty()) {
669 LOG(ERROR) << "Omaha Response URL has empty codebase";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700670 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800671 return false;
672 }
673 output_object->payload_urls.push_back(codebase);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700674 }
675
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700676 return true;
677}
678
David Zeuthene8ed8632014-07-24 13:38:10 -0400679bool OmahaRequestAction::ParsePackage(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700680 OmahaResponse* output_object,
681 ScopedActionCompleter* completer) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400682 if (parser_data->package_name.empty()) {
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700683 LOG(ERROR) << "Omaha Response has empty package name";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700684 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700685 return false;
686 }
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800687
688 // Append the package name to each URL in our list so that we don't
689 // propagate the urlBase vs packageName distinctions beyond this point.
690 // From now on, we only need to use payload_urls.
David Zeuthene8ed8632014-07-24 13:38:10 -0400691 for (auto& payload_url : output_object->payload_urls)
692 payload_url += parser_data->package_name;
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700693
694 // Parse the payload size.
David Zeuthene8ed8632014-07-24 13:38:10 -0400695 off_t size = ParseInt(parser_data->package_size);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700696 if (size <= 0) {
697 LOG(ERROR) << "Omaha Response has invalid payload size: " << size;
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700698 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700699 return false;
700 }
701 output_object->size = size;
702
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800703 LOG(INFO) << "Payload size = " << output_object->size << " bytes";
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700704
705 return true;
706}
707
David Zeuthene8ed8632014-07-24 13:38:10 -0400708bool OmahaRequestAction::ParseParams(OmahaParserData* parser_data,
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700709 OmahaResponse* output_object,
710 ScopedActionCompleter* completer) {
David Zeuthene8ed8632014-07-24 13:38:10 -0400711 output_object->version = parser_data->manifest_version;
Chris Sosa3b748432013-06-20 16:42:59 -0700712 if (output_object->version.empty()) {
Chris Sosaaa18e162013-06-20 13:20:30 -0700713 LOG(ERROR) << "Omaha Response does not have version in manifest!";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700714 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Chris Sosa3b748432013-06-20 16:42:59 -0700715 return false;
716 }
717
718 LOG(INFO) << "Received omaha response to update to version "
719 << output_object->version;
720
David Zeuthene8ed8632014-07-24 13:38:10 -0400721 map<string, string> attrs = parser_data->action_postinstall_attrs;
722 if (attrs.empty()) {
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700723 LOG(ERROR) << "Omaha Response has no postinstall event action";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700724 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700725 return false;
726 }
727
David Zeuthene8ed8632014-07-24 13:38:10 -0400728 output_object->hash = attrs[kTagSha256];
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700729 if (output_object->hash.empty()) {
730 LOG(ERROR) << "Omaha Response has empty sha256 value";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700731 completer->set_code(ErrorCode::kOmahaResponseInvalid);
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700732 return false;
733 }
734
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800735 // Get the optional properties one by one.
David Zeuthene8ed8632014-07-24 13:38:10 -0400736 output_object->more_info_url = attrs[kTagMoreInfo];
737 output_object->metadata_size = ParseInt(attrs[kTagMetadataSize]);
738 output_object->metadata_signature = attrs[kTagMetadataSignatureRsa];
739 output_object->prompt = ParseBool(attrs[kTagPrompt]);
740 output_object->deadline = attrs[kTagDeadline];
741 output_object->max_days_to_scatter = ParseInt(attrs[kTagMaxDaysToScatter]);
David Zeuthen8f191b22013-08-06 12:27:50 -0700742 output_object->disable_p2p_for_downloading =
David Zeuthene8ed8632014-07-24 13:38:10 -0400743 ParseBool(attrs[kTagDisableP2PForDownloading]);
David Zeuthen8f191b22013-08-06 12:27:50 -0700744 output_object->disable_p2p_for_sharing =
David Zeuthene8ed8632014-07-24 13:38:10 -0400745 ParseBool(attrs[kTagDisableP2PForSharing]);
746 output_object->public_key_rsa = attrs[kTagPublicKeyRsa];
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800747
David Zeuthene8ed8632014-07-24 13:38:10 -0400748 string max = attrs[kTagMaxFailureCountPerUrl];
Jay Srinivasan08262882012-12-28 19:29:43 -0800749 if (!base::StringToUint(max, &output_object->max_failure_count_per_url))
Jay Srinivasan2b5a0f02012-12-19 17:25:56 -0800750 output_object->max_failure_count_per_url = kDefaultMaxFailureCountPerUrl;
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700751
David Zeuthene8ed8632014-07-24 13:38:10 -0400752 output_object->is_delta_payload = ParseBool(attrs[kTagIsDeltaPayload]);
Jay Srinivasan08262882012-12-28 19:29:43 -0800753
754 output_object->disable_payload_backoff =
David Zeuthene8ed8632014-07-24 13:38:10 -0400755 ParseBool(attrs[kTagDisablePayloadBackoff]);
Jay Srinivasan08262882012-12-28 19:29:43 -0800756
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700757 return true;
758}
759
David Zeuthene8ed8632014-07-24 13:38:10 -0400760// If the transfer was successful, this uses expat to parse the response
rspangler@google.com49fdf182009-10-10 00:57:34 +0000761// and fill in the appropriate fields of the output object. Also, notifies
762// the processor that we're done.
Darin Petkov6a5b3222010-07-13 14:55:28 -0700763void OmahaRequestAction::TransferComplete(HttpFetcher *fetcher,
764 bool successful) {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000765 ScopedActionCompleter completer(processor_, this);
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800766 string current_response(response_buffer_.begin(), response_buffer_.end());
767 LOG(INFO) << "Omaha request response: " << current_response;
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700768
Gilad Arnold74b5f552014-10-07 08:17:16 -0700769 PayloadStateInterface* const payload_state = system_state_->payload_state();
770
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700771 // Events are best effort transactions -- assume they always succeed.
772 if (IsEvent()) {
773 CHECK(!HasOutputPipe()) << "No output pipe allowed for event requests.";
Andrew de los Reyes2008e4c2011-01-12 10:17:52 -0800774 if (event_->result == OmahaEvent::kResultError && successful &&
J. Richard Barnette056b0ab2013-10-29 15:24:56 -0700775 system_state_->hardware()->IsOfficialBuild()) {
Andrew de los Reyes2008e4c2011-01-12 10:17:52 -0800776 LOG(INFO) << "Signalling Crash Reporter.";
777 utils::ScheduleCrashReporterUpload();
778 }
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700779 completer.set_code(ErrorCode::kSuccess);
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700780 return;
781 }
782
Andrew de los Reyesf98bff82010-05-06 13:33:25 -0700783 if (!successful) {
Darin Petkov0dc8e9a2010-07-14 14:51:57 -0700784 LOG(ERROR) << "Omaha request network transfer failed.";
Darin Petkovedc522e2010-11-05 09:35:17 -0700785 int code = GetHTTPResponseCode();
786 // Makes sure we send sane error values.
787 if (code < 0 || code >= 1000) {
788 code = 999;
789 }
David Zeuthena99981f2013-04-29 13:42:47 -0700790 completer.set_code(static_cast<ErrorCode>(
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700791 static_cast<int>(ErrorCode::kOmahaRequestHTTPResponseBase) + code));
rspangler@google.com49fdf182009-10-10 00:57:34 +0000792 return;
Andrew de los Reyesf98bff82010-05-06 13:33:25 -0700793 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000794
David Zeuthene8ed8632014-07-24 13:38:10 -0400795 XML_Parser parser = XML_ParserCreate(nullptr);
David Zeuthenf3e28012014-08-26 18:23:52 -0400796 OmahaParserData parser_data(parser);
David Zeuthene8ed8632014-07-24 13:38:10 -0400797 XML_SetUserData(parser, &parser_data);
798 XML_SetElementHandler(parser, ParserHandlerStart, ParserHandlerEnd);
David Zeuthenf3e28012014-08-26 18:23:52 -0400799 XML_SetEntityDeclHandler(parser, ParserHandlerEntityDecl);
David Zeuthene8ed8632014-07-24 13:38:10 -0400800 XML_Status res = XML_Parse(parser, &response_buffer_[0],
801 response_buffer_.size(), XML_TRUE);
802 XML_ParserFree(parser);
803
804 if (res != XML_STATUS_OK || parser_data.failed) {
rspangler@google.com49fdf182009-10-10 00:57:34 +0000805 LOG(ERROR) << "Omaha response not valid XML";
David Zeuthenf3e28012014-08-26 18:23:52 -0400806 ErrorCode error_code = ErrorCode::kOmahaRequestXMLParseError;
807 if (response_buffer_.empty()) {
808 error_code = ErrorCode::kOmahaRequestEmptyResponseError;
809 } else if (parser_data.entity_decl) {
810 error_code = ErrorCode::kOmahaRequestXMLHasEntityDecl;
811 }
812 completer.set_code(error_code);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000813 return;
814 }
815
Alex Deymoebbe7ef2014-10-30 13:02:49 -0700816 // Update the last ping day preferences based on the server daystart response
817 // even if we didn't send a ping. Omaha always includes the daystart in the
818 // response, but log the error if it didn't.
819 LOG_IF(ERROR, !UpdateLastPingDays(&parser_data, system_state_->prefs()))
820 << "Failed to update the last ping day preferences!";
Darin Petkov1cbd78f2010-07-29 12:38:34 -0700821
Thieu Le116fda32011-04-19 11:01:54 -0700822 if (!HasOutputPipe()) {
823 // Just set success to whether or not the http transfer succeeded,
824 // which must be true at this point in the code.
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700825 completer.set_code(ErrorCode::kSuccess);
Thieu Le116fda32011-04-19 11:01:54 -0700826 return;
827 }
828
Darin Petkov6a5b3222010-07-13 14:55:28 -0700829 OmahaResponse output_object;
David Zeuthene8ed8632014-07-24 13:38:10 -0400830 if (!ParseResponse(&parser_data, &output_object, &completer))
rspangler@google.com49fdf182009-10-10 00:57:34 +0000831 return;
David Zeuthen8f191b22013-08-06 12:27:50 -0700832 output_object.update_exists = true;
833 SetOutputObject(output_object);
rspangler@google.com49fdf182009-10-10 00:57:34 +0000834
Chris Sosa77f79e82014-06-02 18:16:24 -0700835 if (ShouldIgnoreUpdate(output_object)) {
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700836 output_object.update_exists = false;
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700837 completer.set_code(ErrorCode::kOmahaUpdateIgnoredPerPolicy);
Jay Srinivasan0a708742012-03-20 11:26:12 -0700838 return;
839 }
840
David Zeuthen8f191b22013-08-06 12:27:50 -0700841 // If Omaha says to disable p2p, respect that
842 if (output_object.disable_p2p_for_downloading) {
843 LOG(INFO) << "Forcibly disabling use of p2p for downloading as "
844 << "requested by Omaha.";
Gilad Arnold74b5f552014-10-07 08:17:16 -0700845 payload_state->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -0700846 }
847 if (output_object.disable_p2p_for_sharing) {
848 LOG(INFO) << "Forcibly disabling use of p2p for sharing as "
849 << "requested by Omaha.";
Gilad Arnold74b5f552014-10-07 08:17:16 -0700850 payload_state->SetUsingP2PForSharing(false);
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700851 }
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800852
853 // Update the payload state with the current response. The payload state
854 // will automatically reset all stale state if this response is different
Jay Srinivasan08262882012-12-28 19:29:43 -0800855 // from what's stored already. We are updating the payload state as late
856 // as possible in this method so that if a new release gets pushed and then
857 // got pulled back due to some issues, we don't want to clear our internal
858 // state unnecessarily.
Jay Srinivasan6f6ea002012-12-14 11:26:28 -0800859 payload_state->SetResponse(output_object);
Jay Srinivasan08262882012-12-28 19:29:43 -0800860
David Zeuthen8f191b22013-08-06 12:27:50 -0700861 // It could be we've already exceeded the deadline for when p2p is
862 // allowed or that we've tried too many times with p2p. Check that.
Gilad Arnold74b5f552014-10-07 08:17:16 -0700863 if (payload_state->GetUsingP2PForDownloading()) {
David Zeuthen8f191b22013-08-06 12:27:50 -0700864 payload_state->P2PNewAttempt();
865 if (!payload_state->P2PAttemptAllowed()) {
866 LOG(INFO) << "Forcibly disabling use of p2p for downloading because "
867 << "of previous failures when using p2p.";
Gilad Arnold74b5f552014-10-07 08:17:16 -0700868 payload_state->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -0700869 }
870 }
871
872 // From here on, we'll complete stuff in CompleteProcessing() so
873 // disable |completer| since we'll create a new one in that
874 // function.
875 completer.set_should_complete(false);
876
877 // If we're allowed to use p2p for downloading we do not pay
878 // attention to wall-clock-based waiting if the URL is indeed
879 // available via p2p. Therefore, check if the file is available via
880 // p2p before deferring...
Gilad Arnold74b5f552014-10-07 08:17:16 -0700881 if (payload_state->GetUsingP2PForDownloading()) {
David Zeuthen8f191b22013-08-06 12:27:50 -0700882 LookupPayloadViaP2P(output_object);
883 } else {
884 CompleteProcessing();
885 }
886}
887
888void OmahaRequestAction::CompleteProcessing() {
889 ScopedActionCompleter completer(processor_, this);
890 OmahaResponse& output_object = const_cast<OmahaResponse&>(GetOutputObject());
891 PayloadStateInterface* payload_state = system_state_->payload_state();
892
893 if (ShouldDeferDownload(&output_object)) {
Jay Srinivasan08262882012-12-28 19:29:43 -0800894 output_object.update_exists = false;
David Zeuthen8f191b22013-08-06 12:27:50 -0700895 LOG(INFO) << "Ignoring Omaha updates as updates are deferred by policy.";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700896 completer.set_code(ErrorCode::kOmahaUpdateDeferredPerPolicy);
Jay Srinivasan08262882012-12-28 19:29:43 -0800897 return;
898 }
David Zeuthen8f191b22013-08-06 12:27:50 -0700899
Chris Sosa20f005c2013-09-05 13:53:08 -0700900 if (payload_state->ShouldBackoffDownload()) {
901 output_object.update_exists = false;
902 LOG(INFO) << "Ignoring Omaha updates in order to backoff our retry "
903 << "attempts";
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700904 completer.set_code(ErrorCode::kOmahaUpdateDeferredForBackoff);
Chris Sosa20f005c2013-09-05 13:53:08 -0700905 return;
David Zeuthen8f191b22013-08-06 12:27:50 -0700906 }
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -0700907 completer.set_code(ErrorCode::kSuccess);
David Zeuthen8f191b22013-08-06 12:27:50 -0700908}
909
910void OmahaRequestAction::OnLookupPayloadViaP2PCompleted(const string& url) {
911 LOG(INFO) << "Lookup complete, p2p-client returned URL '" << url << "'";
912 if (!url.empty()) {
Gilad Arnold74b5f552014-10-07 08:17:16 -0700913 system_state_->payload_state()->SetP2PUrl(url);
David Zeuthen8f191b22013-08-06 12:27:50 -0700914 } else {
915 LOG(INFO) << "Forcibly disabling use of p2p for downloading "
916 << "because no suitable peer could be found.";
Gilad Arnold74b5f552014-10-07 08:17:16 -0700917 system_state_->payload_state()->SetUsingP2PForDownloading(false);
David Zeuthen8f191b22013-08-06 12:27:50 -0700918 }
919 CompleteProcessing();
920}
921
922void OmahaRequestAction::LookupPayloadViaP2P(const OmahaResponse& response) {
David Zeuthen41996ad2013-09-24 15:43:24 -0700923 // If the device is in the middle of an update, the state variables
924 // kPrefsUpdateStateNextDataOffset, kPrefsUpdateStateNextDataLength
925 // tracks the offset and length of the operation currently in
926 // progress. The offset is based from the end of the manifest which
927 // is kPrefsManifestMetadataSize bytes long.
928 //
929 // To make forward progress and avoid deadlocks, we need to find a
930 // peer that has at least the entire operation we're currently
931 // working on. Otherwise we may end up in a situation where two
932 // devices bounce back and forth downloading from each other,
933 // neither making any forward progress until one of them decides to
934 // stop using p2p (via kMaxP2PAttempts and kMaxP2PAttemptTimeSeconds
935 // safe-guards). See http://crbug.com/297170 for an example)
David Zeuthen8f191b22013-08-06 12:27:50 -0700936 size_t minimum_size = 0;
David Zeuthen41996ad2013-09-24 15:43:24 -0700937 int64_t manifest_metadata_size = 0;
938 int64_t next_data_offset = 0;
939 int64_t next_data_length = 0;
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700940 if (system_state_ &&
David Zeuthen41996ad2013-09-24 15:43:24 -0700941 system_state_->prefs()->GetInt64(kPrefsManifestMetadataSize,
942 &manifest_metadata_size) &&
943 manifest_metadata_size != -1 &&
David Zeuthen8f191b22013-08-06 12:27:50 -0700944 system_state_->prefs()->GetInt64(kPrefsUpdateStateNextDataOffset,
David Zeuthen41996ad2013-09-24 15:43:24 -0700945 &next_data_offset) &&
946 next_data_offset != -1 &&
947 system_state_->prefs()->GetInt64(kPrefsUpdateStateNextDataLength,
948 &next_data_length)) {
949 minimum_size = manifest_metadata_size + next_data_offset + next_data_length;
David Zeuthen8f191b22013-08-06 12:27:50 -0700950 }
951
952 string file_id = utils::CalculateP2PFileId(response.hash, response.size);
Alex Vakulenko88b591f2014-08-28 16:48:57 -0700953 if (system_state_->p2p_manager()) {
David Zeuthen8f191b22013-08-06 12:27:50 -0700954 LOG(INFO) << "Checking if payload is available via p2p, file_id="
955 << file_id << " minimum_size=" << minimum_size;
956 system_state_->p2p_manager()->LookupUrlForFile(
957 file_id,
958 minimum_size,
David Zeuthen4cc5ed22014-01-15 12:35:03 -0800959 TimeDelta::FromSeconds(kMaxP2PNetworkWaitTimeSeconds),
David Zeuthen8f191b22013-08-06 12:27:50 -0700960 base::Bind(&OmahaRequestAction::OnLookupPayloadViaP2PCompleted,
961 base::Unretained(this)));
962 }
rspangler@google.com49fdf182009-10-10 00:57:34 +0000963}
964
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700965bool OmahaRequestAction::ShouldDeferDownload(OmahaResponse* output_object) {
Chris Sosa968d0572013-08-23 14:46:02 -0700966 if (params_->interactive()) {
967 LOG(INFO) << "Not deferring download because update is interactive.";
968 return false;
969 }
970
David Zeuthen8f191b22013-08-06 12:27:50 -0700971 // If we're using p2p to download _and_ we have a p2p URL, we never
972 // defer the download. This is because the download will always
973 // happen from a peer on the LAN and we've been waiting in line for
974 // our turn.
Gilad Arnold74b5f552014-10-07 08:17:16 -0700975 const PayloadStateInterface* payload_state = system_state_->payload_state();
976 if (payload_state->GetUsingP2PForDownloading() &&
977 !payload_state->GetP2PUrl().empty()) {
David Zeuthen8f191b22013-08-06 12:27:50 -0700978 LOG(INFO) << "Download not deferred because download "
979 << "will happen from a local peer (via p2p).";
980 return false;
981 }
982
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700983 // We should defer the downloads only if we've first satisfied the
984 // wall-clock-based-waiting period and then the update-check-based waiting
985 // period, if required.
Jay Srinivasanae4697c2013-03-18 17:08:08 -0700986 if (!params_->wall_clock_based_wait_enabled()) {
Chris Sosa968d0572013-08-23 14:46:02 -0700987 LOG(INFO) << "Wall-clock-based waiting period is not enabled,"
988 << " so no deferring needed.";
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700989 return false;
990 }
991
Jay Srinivasan23b92a52012-10-27 02:00:21 -0700992 switch (IsWallClockBasedWaitingSatisfied(output_object)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -0700993 case kWallClockWaitNotSatisfied:
994 // We haven't even satisfied the first condition, passing the
995 // wall-clock-based waiting period, so we should defer the downloads
996 // until that happens.
997 LOG(INFO) << "wall-clock-based-wait not satisfied.";
998 return true;
999
1000 case kWallClockWaitDoneButUpdateCheckWaitRequired:
1001 LOG(INFO) << "wall-clock-based-wait satisfied and "
1002 << "update-check-based-wait required.";
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001003 return !IsUpdateCheckCountBasedWaitingSatisfied();
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001004
1005 case kWallClockWaitDoneAndUpdateCheckWaitNotRequired:
1006 // Wall-clock-based waiting period is satisfied, and it's determined
1007 // that we do not need the update-check-based wait. so no need to
1008 // defer downloads.
1009 LOG(INFO) << "wall-clock-based-wait satisfied and "
1010 << "update-check-based-wait is not required.";
1011 return false;
1012
1013 default:
1014 // Returning false for this default case so we err on the
1015 // side of downloading updates than deferring in case of any bugs.
1016 NOTREACHED();
1017 return false;
1018 }
1019}
1020
1021OmahaRequestAction::WallClockWaitResult
1022OmahaRequestAction::IsWallClockBasedWaitingSatisfied(
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001023 OmahaResponse* output_object) {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001024 Time update_first_seen_at;
Ben Chan9abb7632014-08-07 00:10:53 -07001025 int64_t update_first_seen_at_int;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001026
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001027 if (system_state_->prefs()->Exists(kPrefsUpdateFirstSeenAt)) {
1028 if (system_state_->prefs()->GetInt64(kPrefsUpdateFirstSeenAt,
1029 &update_first_seen_at_int)) {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001030 // Note: This timestamp could be that of ANY update we saw in the past
1031 // (not necessarily this particular update we're considering to apply)
1032 // but never got to apply because of some reason (e.g. stop AU policy,
1033 // updates being pulled out from Omaha, changes in target version prefix,
1034 // new update being rolled out, etc.). But for the purposes of scattering
1035 // it doesn't matter which update the timestamp corresponds to. i.e.
1036 // the clock starts ticking the first time we see an update and we're
1037 // ready to apply when the random wait period is satisfied relative to
1038 // that first seen timestamp.
1039 update_first_seen_at = Time::FromInternalValue(update_first_seen_at_int);
1040 LOG(INFO) << "Using persisted value of UpdateFirstSeenAt: "
1041 << utils::ToString(update_first_seen_at);
1042 } else {
1043 // This seems like an unexpected error where the persisted value exists
1044 // but it's not readable for some reason. Just skip scattering in this
1045 // case to be safe.
1046 LOG(INFO) << "Not scattering as UpdateFirstSeenAt value cannot be read";
1047 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1048 }
1049 } else {
1050 update_first_seen_at = Time::Now();
1051 update_first_seen_at_int = update_first_seen_at.ToInternalValue();
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001052 if (system_state_->prefs()->SetInt64(kPrefsUpdateFirstSeenAt,
1053 update_first_seen_at_int)) {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001054 LOG(INFO) << "Persisted the new value for UpdateFirstSeenAt: "
1055 << utils::ToString(update_first_seen_at);
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001056 } else {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001057 // This seems like an unexpected error where the value cannot be
1058 // persisted for some reason. Just skip scattering in this
1059 // case to be safe.
1060 LOG(INFO) << "Not scattering as UpdateFirstSeenAt value "
1061 << utils::ToString(update_first_seen_at)
1062 << " cannot be persisted";
1063 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1064 }
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001065 }
1066
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001067 TimeDelta elapsed_time = Time::Now() - update_first_seen_at;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001068 TimeDelta max_scatter_period = TimeDelta::FromDays(
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001069 output_object->max_days_to_scatter);
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001070
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001071 LOG(INFO) << "Waiting Period = "
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001072 << utils::FormatSecs(params_->waiting_period().InSeconds())
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001073 << ", Time Elapsed = "
1074 << utils::FormatSecs(elapsed_time.InSeconds())
1075 << ", MaxDaysToScatter = "
1076 << max_scatter_period.InDays();
1077
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001078 if (!output_object->deadline.empty()) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001079 // The deadline is set for all rules which serve a delta update from a
1080 // previous FSI, which means this update will be applied mostly in OOBE
1081 // cases. For these cases, we shouldn't scatter so as to finish the OOBE
1082 // quickly.
1083 LOG(INFO) << "Not scattering as deadline flag is set";
1084 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1085 }
1086
1087 if (max_scatter_period.InDays() == 0) {
1088 // This means the Omaha rule creator decides that this rule
1089 // should not be scattered irrespective of the policy.
1090 LOG(INFO) << "Not scattering as MaxDaysToScatter in rule is 0.";
1091 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1092 }
1093
1094 if (elapsed_time > max_scatter_period) {
Jay Srinivasan34b5d862012-07-23 11:43:22 -07001095 // This means we've waited more than the upperbound wait in the rule
1096 // from the time we first saw a valid update available to us.
1097 // This will prevent update starvation.
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001098 LOG(INFO) << "Not scattering as we're past the MaxDaysToScatter limit.";
1099 return kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1100 }
1101
1102 // This means we are required to participate in scattering.
1103 // See if our turn has arrived now.
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001104 TimeDelta remaining_wait_time = params_->waiting_period() - elapsed_time;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001105 if (remaining_wait_time.InSeconds() <= 0) {
1106 // Yes, it's our turn now.
1107 LOG(INFO) << "Successfully passed the wall-clock-based-wait.";
1108
1109 // But we can't download until the update-check-count-based wait is also
1110 // satisfied, so mark it as required now if update checks are enabled.
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001111 return params_->update_check_count_wait_enabled() ?
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001112 kWallClockWaitDoneButUpdateCheckWaitRequired :
1113 kWallClockWaitDoneAndUpdateCheckWaitNotRequired;
1114 }
1115
1116 // Not our turn yet, so we have to wait until our turn to
1117 // help scatter the downloads across all clients of the enterprise.
1118 LOG(INFO) << "Update deferred for another "
1119 << utils::FormatSecs(remaining_wait_time.InSeconds())
1120 << " per policy.";
1121 return kWallClockWaitNotSatisfied;
1122}
1123
Jay Srinivasan23b92a52012-10-27 02:00:21 -07001124bool OmahaRequestAction::IsUpdateCheckCountBasedWaitingSatisfied() {
Ben Chan9abb7632014-08-07 00:10:53 -07001125 int64_t update_check_count_value;
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001126
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001127 if (system_state_->prefs()->Exists(kPrefsUpdateCheckCount)) {
1128 if (!system_state_->prefs()->GetInt64(kPrefsUpdateCheckCount,
1129 &update_check_count_value)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001130 // We are unable to read the update check count from file for some reason.
1131 // So let's proceed anyway so as to not stall the update.
1132 LOG(ERROR) << "Unable to read update check count. "
1133 << "Skipping update-check-count-based-wait.";
1134 return true;
1135 }
1136 } else {
1137 // This file does not exist. This means we haven't started our update
1138 // check count down yet, so this is the right time to start the count down.
1139 update_check_count_value = base::RandInt(
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001140 params_->min_update_checks_needed(),
1141 params_->max_update_checks_allowed());
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001142
1143 LOG(INFO) << "Randomly picked update check count value = "
1144 << update_check_count_value;
1145
1146 // Write out the initial value of update_check_count_value.
Jay Srinivasan6f6ea002012-12-14 11:26:28 -08001147 if (!system_state_->prefs()->SetInt64(kPrefsUpdateCheckCount,
1148 update_check_count_value)) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001149 // We weren't able to write the update check count file for some reason.
1150 // So let's proceed anyway so as to not stall the update.
1151 LOG(ERROR) << "Unable to write update check count. "
1152 << "Skipping update-check-count-based-wait.";
1153 return true;
1154 }
1155 }
1156
1157 if (update_check_count_value == 0) {
1158 LOG(INFO) << "Successfully passed the update-check-based-wait.";
1159 return true;
1160 }
1161
1162 if (update_check_count_value < 0 ||
Jay Srinivasanae4697c2013-03-18 17:08:08 -07001163 update_check_count_value > params_->max_update_checks_allowed()) {
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001164 // We err on the side of skipping scattering logic instead of stalling
1165 // a machine from receiving any updates in case of any unexpected state.
1166 LOG(ERROR) << "Invalid value for update check count detected. "
1167 << "Skipping update-check-count-based-wait.";
1168 return true;
1169 }
1170
1171 // Legal value, we need to wait for more update checks to happen
1172 // until this becomes 0.
1173 LOG(INFO) << "Deferring Omaha updates for another "
1174 << update_check_count_value
1175 << " update checks per policy";
1176 return false;
1177}
1178
David Zeuthen639aa362014-02-03 16:23:44 -08001179// static
David Zeuthene8ed8632014-07-24 13:38:10 -04001180bool OmahaRequestAction::ParseInstallDate(OmahaParserData* parser_data,
David Zeuthen639aa362014-02-03 16:23:44 -08001181 OmahaResponse* output_object) {
David Zeuthen639aa362014-02-03 16:23:44 -08001182 int64_t elapsed_days = 0;
David Zeuthene8ed8632014-07-24 13:38:10 -04001183 if (!base::StringToInt64(parser_data->daystart_elapsed_days,
David Zeuthen639aa362014-02-03 16:23:44 -08001184 &elapsed_days))
1185 return false;
1186
1187 if (elapsed_days < 0)
1188 return false;
1189
1190 output_object->install_date_days = elapsed_days;
1191 return true;
1192}
1193
1194// static
1195bool OmahaRequestAction::HasInstallDate(SystemState *system_state) {
1196 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001197 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -08001198 return false;
1199
1200 return prefs->Exists(kPrefsInstallDateDays);
1201}
1202
1203// static
1204bool OmahaRequestAction::PersistInstallDate(
1205 SystemState *system_state,
1206 int install_date_days,
1207 InstallDateProvisioningSource source) {
1208 TEST_AND_RETURN_FALSE(install_date_days >= 0);
1209
1210 PrefsInterface* prefs = system_state->prefs();
Alex Vakulenko88b591f2014-08-28 16:48:57 -07001211 if (prefs == nullptr)
David Zeuthen639aa362014-02-03 16:23:44 -08001212 return false;
1213
1214 if (!prefs->SetInt64(kPrefsInstallDateDays, install_date_days))
1215 return false;
1216
1217 string metric_name = "Installer.InstallDateProvisioningSource";
1218 system_state->metrics_lib()->SendEnumToUMA(
1219 metric_name,
David Zeuthen33bae492014-02-25 16:16:18 -08001220 static_cast<int>(source), // Sample.
1221 kProvisionedMax); // Maximum.
1222
1223 metric_name = metrics::kMetricInstallDateProvisioningSource;
1224 system_state->metrics_lib()->SendEnumToUMA(
1225 metric_name,
1226 static_cast<int>(source), // Sample.
1227 kProvisionedMax); // Maximum.
David Zeuthen639aa362014-02-03 16:23:44 -08001228
1229 return true;
1230}
1231
David Zeuthen33bae492014-02-25 16:16:18 -08001232void OmahaRequestAction::ActionCompleted(ErrorCode code) {
1233 // We only want to report this on "update check".
1234 if (ping_only_ || event_ != nullptr)
1235 return;
1236
1237 metrics::CheckResult result = metrics::CheckResult::kUnset;
1238 metrics::CheckReaction reaction = metrics::CheckReaction::kUnset;
1239 metrics::DownloadErrorCode download_error_code =
1240 metrics::DownloadErrorCode::kUnset;
1241
1242 // Regular update attempt.
1243 switch (code) {
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001244 case ErrorCode::kSuccess:
David Zeuthen33bae492014-02-25 16:16:18 -08001245 // OK, we parsed the response successfully but that does
1246 // necessarily mean that an update is available.
1247 if (HasOutputPipe()) {
1248 const OmahaResponse& response = GetOutputObject();
1249 if (response.update_exists) {
1250 result = metrics::CheckResult::kUpdateAvailable;
1251 reaction = metrics::CheckReaction::kUpdating;
1252 } else {
1253 result = metrics::CheckResult::kNoUpdateAvailable;
1254 }
1255 } else {
1256 result = metrics::CheckResult::kNoUpdateAvailable;
1257 }
1258 break;
1259
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001260 case ErrorCode::kOmahaUpdateIgnoredPerPolicy:
David Zeuthen33bae492014-02-25 16:16:18 -08001261 result = metrics::CheckResult::kUpdateAvailable;
1262 reaction = metrics::CheckReaction::kIgnored;
1263 break;
1264
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001265 case ErrorCode::kOmahaUpdateDeferredPerPolicy:
David Zeuthen33bae492014-02-25 16:16:18 -08001266 result = metrics::CheckResult::kUpdateAvailable;
1267 reaction = metrics::CheckReaction::kDeferring;
1268 break;
1269
Gilad Arnoldd1c4d2d2014-06-05 14:07:53 -07001270 case ErrorCode::kOmahaUpdateDeferredForBackoff:
David Zeuthen33bae492014-02-25 16:16:18 -08001271 result = metrics::CheckResult::kUpdateAvailable;
1272 reaction = metrics::CheckReaction::kBackingOff;
1273 break;
1274
1275 default:
1276 // We report two flavors of errors, "Download errors" and "Parsing
1277 // error". Try to convert to the former and if that doesn't work
1278 // we know it's the latter.
1279 metrics::DownloadErrorCode tmp_error = utils::GetDownloadErrorCode(code);
1280 if (tmp_error != metrics::DownloadErrorCode::kInputMalformed) {
1281 result = metrics::CheckResult::kDownloadError;
1282 download_error_code = tmp_error;
1283 } else {
1284 result = metrics::CheckResult::kParsingError;
1285 }
1286 break;
1287 }
1288
1289 metrics::ReportUpdateCheckMetrics(system_state_,
1290 result, reaction, download_error_code);
1291}
1292
Chris Sosa77f79e82014-06-02 18:16:24 -07001293bool OmahaRequestAction::ShouldIgnoreUpdate(
1294 const OmahaResponse& response) const {
Chris Sosa77f79e82014-06-02 18:16:24 -07001295 // Note: policy decision to not update to a version we rolled back from.
1296 string rollback_version =
1297 system_state_->payload_state()->GetRollbackVersion();
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001298 if (!rollback_version.empty()) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001299 LOG(INFO) << "Detected previous rollback from version " << rollback_version;
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001300 if (rollback_version == response.version) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001301 LOG(INFO) << "Received version that we rolled back from. Ignoring.";
1302 return true;
1303 }
1304 }
1305
Alex Vakulenkod2779df2014-06-16 13:19:00 -07001306 if (!IsUpdateAllowedOverCurrentConnection()) {
Chris Sosa77f79e82014-06-02 18:16:24 -07001307 LOG(INFO) << "Update is not allowed over current connection.";
1308 return true;
1309 }
1310
1311 // Note: We could technically delete the UpdateFirstSeenAt state when we
1312 // return true. If we do, it'll mean a device has to restart the
1313 // UpdateFirstSeenAt and thus help scattering take effect when the AU is
1314 // turned on again. On the other hand, it also increases the chance of update
1315 // starvation if an admin turns AU on/off more frequently. We choose to err on
1316 // the side of preventing starvation at the cost of not applying scattering in
1317 // those cases.
1318 return false;
1319}
1320
1321bool OmahaRequestAction::IsUpdateAllowedOverCurrentConnection() const {
1322 NetworkConnectionType type;
1323 NetworkTethering tethering;
1324 RealDBusWrapper dbus_iface;
1325 ConnectionManager* connection_manager = system_state_->connection_manager();
1326 if (!connection_manager->GetConnectionProperties(&dbus_iface,
1327 &type, &tethering)) {
1328 LOG(INFO) << "We could not determine our connection type. "
1329 << "Defaulting to allow updates.";
1330 return true;
1331 }
1332 bool is_allowed = connection_manager->IsUpdateAllowedOver(type, tethering);
1333 LOG(INFO) << "We are connected via "
1334 << connection_manager->StringForConnectionType(type)
1335 << ", Updates allowed: " << (is_allowed ? "Yes" : "No");
1336 return is_allowed;
1337}
1338
Jay Srinivasan480ddfa2012-06-01 19:15:26 -07001339} // namespace chromeos_update_engine