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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/google_apis/base_operations.h"
#include "base/json/json_reader.h"
#include "base/string_number_conversions.h"
#include "base/stringprintf.h"
#include "base/task_runner_util.h"
#include "base/threading/sequenced_worker_pool.h"
#include "base/values.h"
#include "content/public/browser/browser_thread.h"
#include "net/base/load_flags.h"
#include "net/http/http_response_headers.h"
#include "net/url_request/url_fetcher.h"
#include "net/url_request/url_request_status.h"
using content::BrowserThread;
using net::URLFetcher;
namespace {
// Template for optional OAuth2 authorization HTTP header.
const char kAuthorizationHeaderFormat[] = "Authorization: Bearer %s";
// Template for GData API version HTTP header.
const char kGDataVersionHeader[] = "GData-Version: 3.0";
// Maximum number of attempts for re-authentication per operation.
const int kMaxReAuthenticateAttemptsPerOperation = 1;
// Parse JSON string to base::Value object.
scoped_ptr<base::Value> ParseJsonOnBlockingPool(const std::string& json) {
DCHECK(!BrowserThread::CurrentlyOn(BrowserThread::UI));
int error_code = -1;
std::string error_message;
scoped_ptr<base::Value> value(base::JSONReader::ReadAndReturnError(
json, base::JSON_PARSE_RFC, &error_code, &error_message));
if (!value.get()) {
LOG(ERROR) << "Error while parsing entry response: " << error_message
<< ", code: " << error_code << ", json:\n" << json;
}
return value.Pass();
}
// Returns response headers as a string. Returns a warning message if
// |url_fetcher| does not contain a valid response. Used only for debugging.
std::string GetResponseHeadersAsString(
const URLFetcher* url_fetcher) {
// net::HttpResponseHeaders::raw_headers(), as the name implies, stores
// all headers in their raw format, i.e each header is null-terminated.
// So logging raw_headers() only shows the first header, which is probably
// the status line. GetNormalizedHeaders, on the other hand, will show all
// the headers, one per line, which is probably what we want.
std::string headers;
// Check that response code indicates response headers are valid (i.e. not
// malformed) before we retrieve the headers.
if (url_fetcher->GetResponseCode() == URLFetcher::RESPONSE_CODE_INVALID) {
headers.assign("Response headers are malformed!!");
} else {
url_fetcher->GetResponseHeaders()->GetNormalizedHeaders(&headers);
}
return headers;
}
} // namespace
namespace google_apis {
void ParseJson(const std::string& json, const ParseJsonCallback& callback) {
base::PostTaskAndReplyWithResult(
BrowserThread::GetBlockingPool(),
FROM_HERE,
base::Bind(&ParseJsonOnBlockingPool, json),
callback);
}
//============================ UrlFetchOperationBase ===========================
UrlFetchOperationBase::UrlFetchOperationBase(
OperationRegistry* registry,
net::URLRequestContextGetter* url_request_context_getter)
: OperationRegistry::Operation(registry),
url_request_context_getter_(url_request_context_getter),
re_authenticate_count_(0),
started_(false),
save_temp_file_(false),
ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
}
UrlFetchOperationBase::UrlFetchOperationBase(
OperationRegistry* registry,
net::URLRequestContextGetter* url_request_context_getter,
OperationType type,
const FilePath& path)
: OperationRegistry::Operation(registry, type, path),
url_request_context_getter_(url_request_context_getter),
re_authenticate_count_(0),
started_(false),
save_temp_file_(false),
ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
}
UrlFetchOperationBase::~UrlFetchOperationBase() {}
void UrlFetchOperationBase::Start(const std::string& access_token,
const std::string& custom_user_agent,
const ReAuthenticateCallback& callback) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
DCHECK(url_request_context_getter_);
DCHECK(!access_token.empty());
DCHECK(!callback.is_null());
DCHECK(re_authenticate_callback_.is_null());
re_authenticate_callback_ = callback;
GURL url = GetURL();
if (url.is_empty()) {
// Error is found on generating the url. Send the error message to the
// callback, and then return immediately without trying to connect
// to the server.
RunCallbackOnPrematureFailure(GDATA_OTHER_ERROR);
return;
}
DVLOG(1) << "URL: " << url.spec();
url_fetcher_.reset(
URLFetcher::Create(url, GetRequestType(), this));
url_fetcher_->SetRequestContext(url_request_context_getter_);
// Always set flags to neither send nor save cookies.
url_fetcher_->SetLoadFlags(
net::LOAD_DO_NOT_SEND_COOKIES | net::LOAD_DO_NOT_SAVE_COOKIES |
net::LOAD_DISABLE_CACHE);
if (save_temp_file_) {
url_fetcher_->SaveResponseToTemporaryFile(
BrowserThread::GetMessageLoopProxyForThread(BrowserThread::FILE));
} else if (!output_file_path_.empty()) {
url_fetcher_->SaveResponseToFileAtPath(output_file_path_,
BrowserThread::GetMessageLoopProxyForThread(BrowserThread::FILE));
}
// Add request headers.
// Note that SetExtraRequestHeaders clears the current headers and sets it
// to the passed-in headers, so calling it for each header will result in
// only the last header being set in request headers.
if (!custom_user_agent.empty())
url_fetcher_->AddExtraRequestHeader("User-Agent: " + custom_user_agent);
url_fetcher_->AddExtraRequestHeader(kGDataVersionHeader);
url_fetcher_->AddExtraRequestHeader(
base::StringPrintf(kAuthorizationHeaderFormat, access_token.data()));
std::vector<std::string> headers = GetExtraRequestHeaders();
for (size_t i = 0; i < headers.size(); ++i) {
url_fetcher_->AddExtraRequestHeader(headers[i]);
DVLOG(1) << "Extra header: " << headers[i];
}
// Set upload data if available.
std::string upload_content_type;
std::string upload_content;
if (GetContentData(&upload_content_type, &upload_content)) {
url_fetcher_->SetUploadData(upload_content_type, upload_content);
}
// Register to operation registry.
NotifyStartToOperationRegistry();
url_fetcher_->Start();
started_ = true;
}
URLFetcher::RequestType UrlFetchOperationBase::GetRequestType() const {
return URLFetcher::GET;
}
std::vector<std::string> UrlFetchOperationBase::GetExtraRequestHeaders() const {
return std::vector<std::string>();
}
bool UrlFetchOperationBase::GetContentData(std::string* upload_content_type,
std::string* upload_content) {
return false;
}
void UrlFetchOperationBase::DoCancel() {
url_fetcher_.reset(NULL);
RunCallbackOnPrematureFailure(GDATA_CANCELLED);
}
// static
GDataErrorCode UrlFetchOperationBase::GetErrorCode(const URLFetcher* source) {
GDataErrorCode code = static_cast<GDataErrorCode>(source->GetResponseCode());
if (code == HTTP_SUCCESS && !source->GetStatus().is_success()) {
// If the HTTP response code is SUCCESS yet the URL request failed, it is
// likely that the failure is due to loss of connection.
code = GDATA_NO_CONNECTION;
}
return code;
}
void UrlFetchOperationBase::OnProcessURLFetchResultsComplete(bool result) {
if (result)
NotifySuccessToOperationRegistry();
else
NotifyFinish(OPERATION_FAILED);
}
void UrlFetchOperationBase::OnURLFetchComplete(const URLFetcher* source) {
GDataErrorCode code = GetErrorCode(source);
DVLOG(1) << "Response headers:\n" << GetResponseHeadersAsString(source);
if (code == HTTP_UNAUTHORIZED) {
if (++re_authenticate_count_ <= kMaxReAuthenticateAttemptsPerOperation) {
// Reset re_authenticate_callback_ so Start() can be called again.
ReAuthenticateCallback callback = re_authenticate_callback_;
re_authenticate_callback_.Reset();
callback.Run(this);
return;
}
OnAuthFailed(code);
return;
}
// Overridden by each specialization
ProcessURLFetchResults(source);
}
void UrlFetchOperationBase::NotifySuccessToOperationRegistry() {
NotifyFinish(OPERATION_COMPLETED);
}
void UrlFetchOperationBase::NotifyStartToOperationRegistry() {
NotifyStart();
}
void UrlFetchOperationBase::OnAuthFailed(GDataErrorCode code) {
RunCallbackOnPrematureFailure(code);
// Notify authentication failed.
NotifyAuthFailed(code);
// Check if this failed before we even started fetching. If so, register
// for start so we can properly unregister with finish.
if (!started_)
NotifyStart();
// Note: NotifyFinish() must be invoked at the end, after all other callbacks
// and notifications. Once NotifyFinish() is called, the current instance of
// gdata operation will be deleted from the OperationRegistry and become
// invalid.
NotifyFinish(OPERATION_FAILED);
}
base::WeakPtr<AuthenticatedOperationInterface>
UrlFetchOperationBase::GetWeakPtr() {
return weak_ptr_factory_.GetWeakPtr();
}
//============================ EntryActionOperation ============================
EntryActionOperation::EntryActionOperation(
OperationRegistry* registry,
net::URLRequestContextGetter* url_request_context_getter,
const EntryActionCallback& callback)
: UrlFetchOperationBase(registry, url_request_context_getter),
callback_(callback) {
DCHECK(!callback_.is_null());
}
EntryActionOperation::~EntryActionOperation() {}
void EntryActionOperation::ProcessURLFetchResults(const URLFetcher* source) {
GDataErrorCode code = GetErrorCode(source);
callback_.Run(code);
const bool success = true;
OnProcessURLFetchResultsComplete(success);
}
void EntryActionOperation::RunCallbackOnPrematureFailure(GDataErrorCode code) {
callback_.Run(code);
}
//============================== GetDataOperation ==============================
GetDataOperation::GetDataOperation(
OperationRegistry* registry,
net::URLRequestContextGetter* url_request_context_getter,
const GetDataCallback& callback)
: UrlFetchOperationBase(registry, url_request_context_getter),
callback_(callback),
ALLOW_THIS_IN_INITIALIZER_LIST(weak_ptr_factory_(this)) {
DCHECK(!callback_.is_null());
}
GetDataOperation::~GetDataOperation() {}
void GetDataOperation::ParseResponse(GDataErrorCode fetch_error_code,
const std::string& data) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
VLOG(1) << "JSON received from " << GetURL().spec() << ": "
<< data.size() << " bytes";
ParseJson(data,
base::Bind(&GetDataOperation::OnDataParsed,
weak_ptr_factory_.GetWeakPtr(),
fetch_error_code));
}
void GetDataOperation::ProcessURLFetchResults(const URLFetcher* source) {
std::string data;
source->GetResponseAsString(&data);
scoped_ptr<base::Value> root_value;
GDataErrorCode fetch_error_code = GetErrorCode(source);
switch (fetch_error_code) {
case HTTP_SUCCESS:
case HTTP_CREATED:
ParseResponse(fetch_error_code, data);
break;
default:
RunCallbackOnPrematureFailure(fetch_error_code);
const bool success = false;
OnProcessURLFetchResultsComplete(success);
break;
}
}
void GetDataOperation::RunCallbackOnPrematureFailure(
GDataErrorCode fetch_error_code) {
callback_.Run(fetch_error_code, scoped_ptr<base::Value>());
}
void GetDataOperation::OnDataParsed(
GDataErrorCode fetch_error_code,
scoped_ptr<base::Value> value) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
bool success = true;
if (!value.get()) {
fetch_error_code = GDATA_PARSE_ERROR;
success = false;
}
RunCallbackOnSuccess(fetch_error_code, value.Pass());
DCHECK(!value.get());
OnProcessURLFetchResultsComplete(success);
}
void GetDataOperation::RunCallbackOnSuccess(GDataErrorCode fetch_error_code,
scoped_ptr<base::Value> value) {
DCHECK(BrowserThread::CurrentlyOn(BrowserThread::UI));
callback_.Run(fetch_error_code, value.Pass());
}
} // namespace google_apis
|