1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
|
//
// Copyright (C) 2019 The Android Open Source Project
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#ifndef UPDATE_ENGINE_CROS_OMAHA_REQUEST_BUILDER_XML_H_
#define UPDATE_ENGINE_CROS_OMAHA_REQUEST_BUILDER_XML_H_
#include <fcntl.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <map>
#include <memory>
#include <string>
#include <vector>
#include <gtest/gtest_prod.h> // for FRIEND_TEST
#include <brillo/secure_blob.h>
#include <curl/curl.h>
#include "update_engine/common/action.h"
#include "update_engine/common/http_fetcher.h"
#include "update_engine/cros/omaha_request_params.h"
#include "update_engine/cros/omaha_response.h"
namespace chromeos_update_engine {
extern const char kNoVersion[];
extern const int kPingNeverPinged;
extern const int kPingUnknownValue;
extern const int kPingActiveValue;
extern const int kPingInactiveValue;
// This struct encapsulates the Omaha event information. For a
// complete list of defined event types and results, see
// http://code.google.com/p/omaha/wiki/ServerProtocol#event
struct OmahaEvent {
// The Type values correspond to EVENT_TYPE values of Omaha.
enum Type {
kTypeUnknown = 0,
kTypeDownloadComplete = 1,
kTypeInstallComplete = 2,
kTypeUpdateComplete = 3,
kTypeUpdateDownloadStarted = 13,
kTypeUpdateDownloadFinished = 14,
// Chromium OS reserved type sent after the first reboot following an update
// completed.
kTypeRebootedAfterUpdate = 54,
};
// The Result values correspond to EVENT_RESULT values of Omaha.
enum Result {
kResultError = 0,
kResultSuccess = 1,
kResultUpdateDeferred = 9, // When we ignore/defer updates due to policy.
};
OmahaEvent()
: type(kTypeUnknown),
result(kResultError),
error_code(ErrorCode::kError) {}
explicit OmahaEvent(Type in_type)
: type(in_type),
result(kResultSuccess),
error_code(ErrorCode::kSuccess) {}
OmahaEvent(Type in_type, Result in_result, ErrorCode in_error_code)
: type(in_type), result(in_result), error_code(in_error_code) {}
Type type;
Result result;
ErrorCode error_code;
};
struct OmahaAppData {
std::string id;
std::string version;
std::string product_components;
bool skip_update;
bool is_dlc;
OmahaRequestParams::AppParams app_params;
};
// Encodes XML entities in a given string. Input must be ASCII-7 valid. If
// the input is invalid, the default value is used instead.
std::string XmlEncodeWithDefault(const std::string& input,
const std::string& default_value = "");
// Escapes text so it can be included as character data and attribute
// values. The |input| string must be valid ASCII-7, no UTF-8 supported.
// Returns whether the |input| was valid and escaped properly in |output|.
bool XmlEncode(const std::string& input, std::string* output);
// Returns a boolean based on examining each character on whether it's a valid
// component (meaning all characters are an alphanum excluding '-', '_', '.').
bool IsValidComponentID(const std::string& id);
class OmahaRequestBuilder {
public:
OmahaRequestBuilder() = default;
virtual ~OmahaRequestBuilder() = default;
virtual std::string GetRequest() const = 0;
private:
DISALLOW_COPY_AND_ASSIGN(OmahaRequestBuilder);
};
class OmahaRequestBuilderXml : OmahaRequestBuilder {
public:
OmahaRequestBuilderXml(const OmahaEvent* event,
bool ping_only,
bool include_ping,
int ping_active_days,
int ping_roll_call_days,
int install_date_in_days,
const std::string& session_id)
: event_(event),
ping_only_(ping_only),
include_ping_(include_ping),
ping_active_days_(ping_active_days),
ping_roll_call_days_(ping_roll_call_days),
install_date_in_days_(install_date_in_days),
session_id_(session_id) {}
~OmahaRequestBuilderXml() override = default;
// Returns an XML that corresponds to the entire Omaha request.
std::string GetRequest() const override;
private:
FRIEND_TEST(OmahaRequestBuilderXmlTest, PlatformGetAppTest);
FRIEND_TEST(OmahaRequestBuilderXmlTest, DlcGetAppTest);
// Returns an XML that corresponds to the entire <os> node of the Omaha
// request based on the member variables.
std::string GetOs() const;
// Returns an XML that corresponds to all <app> nodes of the Omaha
// request based on the given parameters.
std::string GetApps() const;
// Returns an XML that corresponds to the single <app> node of the Omaha
// request based on the given parameters.
std::string GetApp(const OmahaAppData& app_data) const;
// Returns an XML that goes into the body of the <app> element of the Omaha
// request based on the given parameters.
std::string GetAppBody(const OmahaAppData& app_data) const;
// Returns the cohort* argument to include in the <app> tag for the passed
// |arg_name| and |prefs_key|, if any. The return value is suitable to
// concatenate to the list of arguments and includes a space at the end.
std::string GetCohortArg(const std::string& arg_name,
const std::string& prefs_key,
const std::string& override_value = "") const;
// Returns an XML ping element if any of the elapsed days need to be
// sent, or an empty string otherwise.
std::string GetPing() const;
// Returns an XML ping element if any of the elapsed days need to be
// sent, or an empty string otherwise.
std::string GetPingDateBased(
const OmahaRequestParams::AppParams& app_params) const;
const OmahaEvent* event_;
bool ping_only_;
bool include_ping_;
int ping_active_days_;
int ping_roll_call_days_;
int install_date_in_days_;
std::string session_id_;
DISALLOW_COPY_AND_ASSIGN(OmahaRequestBuilderXml);
};
} // namespace chromeos_update_engine
#endif // UPDATE_ENGINE_CROS_OMAHA_REQUEST_BUILDER_XML_H_
|
