Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(497)

Side by Side Diff: components/update_client/background_downloader_win.cc

Issue 808773005: Move most of the component updater artifacts to update_client. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Created 5 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
(Empty)
1 // Copyright 2014 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 #include "components/update_client/background_downloader_win.h"
6
7 #include <atlbase.h>
8 #include <atlcom.h>
9
10 #include <stdint.h>
11 #include <functional>
12 #include <iomanip>
13 #include <limits>
14 #include <vector>
15
16 #include "base/bind.h"
17 #include "base/bind_helpers.h"
18 #include "base/files/file_util.h"
19 #include "base/message_loop/message_loop_proxy.h"
20 #include "base/single_thread_task_runner.h"
21 #include "base/strings/sys_string_conversions.h"
22 #include "base/win/scoped_co_mem.h"
23 #include "components/update_client/utils.h"
24 #include "ui/base/win/atl_module.h"
25 #include "url/gurl.h"
26
27 using base::win::ScopedCoMem;
28 using base::win::ScopedComPtr;
29
30 // The class BackgroundDownloader in this module is an adapter between
31 // the CrxDownloader interface and the BITS service interfaces.
32 // The interface exposed on the CrxDownloader code runs on the main thread,
33 // while the BITS specific code runs on a separate thread passed in by the
34 // client. For every url to download, a BITS job is created, unless there is
35 // already an existing job for that url, in which case, the downloader
36 // connects to it. Once a job is associated with the url, the code looks for
37 // changes in the BITS job state. The checks are triggered by a timer.
38 // The BITS job contains just one file to download. There could only be one
39 // download in progress at a time. If Chrome closes down before the download is
40 // complete, the BITS job remains active and finishes in the background, without
41 // any intervention. The job can be completed next time the code runs, if the
42 // file is still needed, otherwise it will be cleaned up on a periodic basis.
43 //
44 // To list the BITS jobs for a user, use the |bitsadmin| tool. The command line
45 // to do that is: "bitsadmin /list /verbose". Another useful command is
46 // "bitsadmin /info" and provide the job id returned by the previous /list
47 // command.
48 //
49 // Ignoring the suspend/resume issues since this code is not using them, the
50 // job state machine implemented by BITS is something like this:
51 //
52 // Suspended--->Queued--->Connecting---->Transferring--->Transferred
53 // | ^ | | |
54 // | | V V | (complete)
55 // +----------|---------+-----------------+-----+ V
56 // | | | | Acknowledged
57 // | V V |
58 // | Transient Error------->Error |
59 // | | | |(cancel)
60 // | +-------+---------+--->-+
61 // | V |
62 // | (resume) | |
63 // +------<----------+ +---->Cancelled
64 //
65 // The job is created in the "suspended" state. Once |Resume| is called,
66 // BITS queues up the job, then tries to connect, begins transferring the
67 // job bytes, and moves the job to the "transferred state, after the job files
68 // have been transferred. When calling |Complete| for a job, the job files are
69 // made available to the caller, and the job is moved to the "acknowledged"
70 // state.
71 // At any point, the job can be cancelled, in which case, the job is moved
72 // to the "cancelled state" and the job object is removed from the BITS queue.
73 // Along the way, the job can encounter recoverable and non-recoverable errors.
74 // BITS moves the job to "transient error" or "error", depending on which kind
75 // of error has occured.
76 // If the job has reached the "transient error" state, BITS retries the
77 // job after a certain programmable delay. If the job can't be completed in a
78 // certain time interval, BITS stops retrying and errors the job out. This time
79 // interval is also programmable.
80 // If the job is in either of the error states, the job parameters can be
81 // adjusted to handle the error, after which the job can be resumed, and the
82 // whole cycle starts again.
83 // Jobs that are not touched in 90 days (or a value set by group policy) are
84 // automatically disposed off by BITS. This concludes the brief description of
85 // a job lifetime, according to BITS.
86 //
87 // In addition to how BITS is managing the life time of the job, there are a
88 // couple of special cases defined by the BackgroundDownloader.
89 // First, if the job encounters any of the 5xx HTTP responses, the job is
90 // not retried, in order to avoid DDOS-ing the servers.
91 // Second, there is a simple mechanism to detect stuck jobs, and allow the rest
92 // of the code to move on to trying other urls or trying other components.
93 // Last, after completing a job, irrespective of the outcome, the jobs older
94 // than a week are proactively cleaned up.
95
96 namespace update_client {
97
98 namespace {
99
100 // All jobs created by this module have a specific description so they can
101 // be found at run-time or by using system administration tools.
102 const base::char16 kJobDescription[] = L"Chrome Component Updater";
103
104 // How often the code looks for changes in the BITS job state.
105 const int kJobPollingIntervalSec = 4;
106
107 // How long BITS waits before retrying a job after the job encountered
108 // a transient error. If this value is not set, the BITS default is 10 minutes.
109 const int kMinimumRetryDelayMin = 1;
110
111 // How long to wait for stuck jobs. Stuck jobs could be queued for too long,
112 // have trouble connecting, could be suspended for any reason, or they have
113 // encountered some transient error.
114 const int kJobStuckTimeoutMin = 15;
115
116 // How long BITS waits before giving up on a job that could not be completed
117 // since the job has encountered its first transient error. If this value is
118 // not set, the BITS default is 14 days.
119 const int kSetNoProgressTimeoutDays = 1;
120
121 // How often the jobs which were started but not completed for any reason
122 // are cleaned up. Reasons for jobs to be left behind include browser restarts,
123 // system restarts, etc. Also, the check to purge stale jobs only happens
124 // at most once a day. If the job clean up code is not running, the BITS
125 // default policy is to cancel jobs after 90 days of inactivity.
126 const int kPurgeStaleJobsAfterDays = 7;
127 const int kPurgeStaleJobsIntervalBetweenChecksDays = 1;
128
129 // Returns the status code from a given BITS error.
130 int GetHttpStatusFromBitsError(HRESULT error) {
131 // BITS errors are defined in bitsmsg.h. Although not documented, it is
132 // clear that all errors corresponding to http status code have the high
133 // word equal to 0x8019 and the low word equal to the http status code.
134 const int kHttpStatusFirst = 100; // Continue.
135 const int kHttpStatusLast = 505; // Version not supported.
136 bool is_valid = HIWORD(error) == 0x8019 &&
137 LOWORD(error) >= kHttpStatusFirst &&
138 LOWORD(error) <= kHttpStatusLast;
139 return is_valid ? LOWORD(error) : 0;
140 }
141
142 // Returns the files in a BITS job.
143 HRESULT GetFilesInJob(IBackgroundCopyJob* job,
144 std::vector<ScopedComPtr<IBackgroundCopyFile>>* files) {
145 ScopedComPtr<IEnumBackgroundCopyFiles> enum_files;
146 HRESULT hr = job->EnumFiles(enum_files.Receive());
147 if (FAILED(hr))
148 return hr;
149
150 ULONG num_files = 0;
151 hr = enum_files->GetCount(&num_files);
152 if (FAILED(hr))
153 return hr;
154
155 for (ULONG i = 0; i != num_files; ++i) {
156 ScopedComPtr<IBackgroundCopyFile> file;
157 if (enum_files->Next(1, file.Receive(), NULL) == S_OK && file.get())
158 files->push_back(file);
159 }
160
161 return S_OK;
162 }
163
164 // Returns the file name, the url, and some per-file progress information.
165 // The function out parameters can be NULL if that data is not requested.
166 HRESULT GetJobFileProperties(IBackgroundCopyFile* file,
167 base::string16* local_name,
168 base::string16* remote_name,
169 BG_FILE_PROGRESS* progress) {
170 if (!file)
171 return E_FAIL;
172
173 HRESULT hr = S_OK;
174
175 if (local_name) {
176 ScopedCoMem<base::char16> name;
177 hr = file->GetLocalName(&name);
178 if (FAILED(hr))
179 return hr;
180 local_name->assign(name);
181 }
182
183 if (remote_name) {
184 ScopedCoMem<base::char16> name;
185 hr = file->GetRemoteName(&name);
186 if (FAILED(hr))
187 return hr;
188 remote_name->assign(name);
189 }
190
191 if (progress) {
192 BG_FILE_PROGRESS bg_file_progress = {};
193 hr = file->GetProgress(&bg_file_progress);
194 if (FAILED(hr))
195 return hr;
196 *progress = bg_file_progress;
197 }
198
199 return hr;
200 }
201
202 // Returns the number of bytes downloaded and bytes to download for all files
203 // in the job. If the values are not known or if an error has occurred,
204 // a value of -1 is reported.
205 HRESULT GetJobByteCount(IBackgroundCopyJob* job,
206 int64_t* downloaded_bytes,
207 int64_t* total_bytes) {
208 *downloaded_bytes = -1;
209 *total_bytes = -1;
210
211 if (!job)
212 return E_FAIL;
213
214 BG_JOB_PROGRESS job_progress = {0};
215 HRESULT hr = job->GetProgress(&job_progress);
216 if (FAILED(hr))
217 return hr;
218
219 const uint64_t kMaxNumBytes =
220 static_cast<uint64_t>(std::numeric_limits<int64_t>::max());
221 if (job_progress.BytesTransferred <= kMaxNumBytes)
222 *downloaded_bytes = job_progress.BytesTransferred;
223
224 if (job_progress.BytesTotal <= kMaxNumBytes &&
225 job_progress.BytesTotal != BG_SIZE_UNKNOWN)
226 *total_bytes = job_progress.BytesTotal;
227
228 return S_OK;
229 }
230
231 HRESULT GetJobDescription(IBackgroundCopyJob* job, const base::string16* name) {
232 ScopedCoMem<base::char16> description;
233 return job->GetDescription(&description);
234 }
235
236 // Returns the job error code in |error_code| if the job is in the transient
237 // or the final error state. Otherwise, the job error is not available and
238 // the function fails.
239 HRESULT GetJobError(IBackgroundCopyJob* job, HRESULT* error_code_out) {
240 *error_code_out = S_OK;
241 ScopedComPtr<IBackgroundCopyError> copy_error;
242 HRESULT hr = job->GetError(copy_error.Receive());
243 if (FAILED(hr))
244 return hr;
245
246 BG_ERROR_CONTEXT error_context = BG_ERROR_CONTEXT_NONE;
247 HRESULT error_code = S_OK;
248 hr = copy_error->GetError(&error_context, &error_code);
249 if (FAILED(hr))
250 return hr;
251
252 *error_code_out = FAILED(error_code) ? error_code : E_FAIL;
253 return S_OK;
254 }
255
256 // Finds the component updater jobs matching the given predicate.
257 // Returns S_OK if the function has found at least one job, returns S_FALSE if
258 // no job was found, and it returns an error otherwise.
259 template <class Predicate>
260 HRESULT FindBitsJobIf(Predicate pred,
261 IBackgroundCopyManager* bits_manager,
262 std::vector<ScopedComPtr<IBackgroundCopyJob>>* jobs) {
263 ScopedComPtr<IEnumBackgroundCopyJobs> enum_jobs;
264 HRESULT hr = bits_manager->EnumJobs(0, enum_jobs.Receive());
265 if (FAILED(hr))
266 return hr;
267
268 ULONG job_count = 0;
269 hr = enum_jobs->GetCount(&job_count);
270 if (FAILED(hr))
271 return hr;
272
273 // Iterate over jobs, run the predicate, and select the job only if
274 // the job description matches the component updater jobs.
275 for (ULONG i = 0; i != job_count; ++i) {
276 ScopedComPtr<IBackgroundCopyJob> current_job;
277 if (enum_jobs->Next(1, current_job.Receive(), NULL) == S_OK &&
278 pred(current_job.get())) {
279 base::string16 job_description;
280 hr = GetJobDescription(current_job.get(), &job_description);
281 if (job_description.compare(kJobDescription) == 0)
282 jobs->push_back(current_job);
283 }
284 }
285
286 return jobs->empty() ? S_FALSE : S_OK;
287 }
288
289 // Compares the job creation time and returns true if the job creation time
290 // is older than |num_days|.
291 struct JobCreationOlderThanDays
292 : public std::binary_function<IBackgroundCopyJob*, int, bool> {
293 bool operator()(IBackgroundCopyJob* job, int num_days) const;
294 };
295
296 bool JobCreationOlderThanDays::operator()(IBackgroundCopyJob* job,
297 int num_days) const {
298 BG_JOB_TIMES times = {0};
299 HRESULT hr = job->GetTimes(&times);
300 if (FAILED(hr))
301 return false;
302
303 const base::TimeDelta time_delta(base::TimeDelta::FromDays(num_days));
304 const base::Time creation_time(base::Time::FromFileTime(times.CreationTime));
305
306 return creation_time + time_delta < base::Time::Now();
307 }
308
309 // Compares the url of a file in a job and returns true if the remote name
310 // of any file in a job matches the argument.
311 struct JobFileUrlEqual : public std::binary_function<IBackgroundCopyJob*,
312 const base::string16&,
313 bool> {
314 bool operator()(IBackgroundCopyJob* job,
315 const base::string16& remote_name) const;
316 };
317
318 bool JobFileUrlEqual::operator()(IBackgroundCopyJob* job,
319 const base::string16& remote_name) const {
320 std::vector<ScopedComPtr<IBackgroundCopyFile>> files;
321 HRESULT hr = GetFilesInJob(job, &files);
322 if (FAILED(hr))
323 return false;
324
325 for (size_t i = 0; i != files.size(); ++i) {
326 ScopedCoMem<base::char16> name;
327 if (SUCCEEDED(files[i]->GetRemoteName(&name)) &&
328 remote_name.compare(name) == 0)
329 return true;
330 }
331
332 return false;
333 }
334
335 // Creates an instance of the BITS manager.
336 HRESULT GetBitsManager(IBackgroundCopyManager** bits_manager) {
337 ScopedComPtr<IBackgroundCopyManager> object;
338 HRESULT hr = object.CreateInstance(__uuidof(BackgroundCopyManager));
339 if (FAILED(hr)) {
340 return hr;
341 }
342 *bits_manager = object.Detach();
343 return S_OK;
344 }
345
346 void CleanupJobFiles(IBackgroundCopyJob* job) {
347 std::vector<ScopedComPtr<IBackgroundCopyFile>> files;
348 if (FAILED(GetFilesInJob(job, &files)))
349 return;
350 for (size_t i = 0; i != files.size(); ++i) {
351 base::string16 local_name;
352 HRESULT hr(GetJobFileProperties(files[i].get(), &local_name, NULL, NULL));
353 if (SUCCEEDED(hr))
354 DeleteFileAndEmptyParentDirectory(base::FilePath(local_name));
355 }
356 }
357
358 // Cleans up incompleted jobs that are too old.
359 HRESULT CleanupStaleJobs(
360 base::win::ScopedComPtr<IBackgroundCopyManager> bits_manager) {
361 if (!bits_manager.get())
362 return E_FAIL;
363
364 static base::Time last_sweep;
365
366 const base::TimeDelta time_delta(
367 base::TimeDelta::FromDays(kPurgeStaleJobsIntervalBetweenChecksDays));
368 const base::Time current_time(base::Time::Now());
369 if (last_sweep + time_delta > current_time)
370 return S_OK;
371
372 last_sweep = current_time;
373
374 std::vector<ScopedComPtr<IBackgroundCopyJob>> jobs;
375 HRESULT hr = FindBitsJobIf(
376 std::bind2nd(JobCreationOlderThanDays(), kPurgeStaleJobsAfterDays),
377 bits_manager.get(), &jobs);
378 if (FAILED(hr))
379 return hr;
380
381 for (size_t i = 0; i != jobs.size(); ++i) {
382 jobs[i]->Cancel();
383 CleanupJobFiles(jobs[i].get());
384 }
385
386 return S_OK;
387 }
388
389 } // namespace
390
391 BackgroundDownloader::BackgroundDownloader(
392 scoped_ptr<CrxDownloader> successor,
393 net::URLRequestContextGetter* context_getter,
394 scoped_refptr<base::SingleThreadTaskRunner> task_runner)
395 : CrxDownloader(successor.Pass()),
396 main_task_runner_(base::MessageLoopProxy::current()),
397 context_getter_(context_getter),
398 task_runner_(task_runner),
399 is_completed_(false) {
400 }
401
402 BackgroundDownloader::~BackgroundDownloader() {
403 DCHECK(thread_checker_.CalledOnValidThread());
404
405 // The following objects have thread affinity and can't be destroyed on the
406 // main thread. The resources managed by these objects are acquired at the
407 // beginning of a download and released at the end of the download. Most of
408 // the time, when this destructor is called, these resources have been already
409 // disposed by. Releasing the ownership here is a NOP. However, if the browser
410 // is shutting down while a download is in progress, the timer is active and
411 // the interface pointers are valid. Releasing the ownership means leaking
412 // these objects and their associated resources.
413 timer_.release();
414 bits_manager_.Detach();
415 job_.Detach();
416 }
417
418 void BackgroundDownloader::DoStartDownload(const GURL& url) {
419 DCHECK(thread_checker_.CalledOnValidThread());
420
421 task_runner_->PostTask(FROM_HERE,
422 base::Bind(&BackgroundDownloader::BeginDownload,
423 base::Unretained(this), url));
424 }
425
426 // Called once when this class is asked to do a download. Creates or opens
427 // an existing bits job, hooks up the notifications, and starts the timer.
428 void BackgroundDownloader::BeginDownload(const GURL& url) {
429 DCHECK(task_runner_->RunsTasksOnCurrentThread());
430
431 DCHECK(!timer_);
432
433 is_completed_ = false;
434 download_start_time_ = base::Time::Now();
435 job_stuck_begin_time_ = download_start_time_;
436
437 HRESULT hr = QueueBitsJob(url);
438 if (FAILED(hr)) {
439 EndDownload(hr);
440 return;
441 }
442
443 // A repeating timer retains the user task. This timer can be stopped and
444 // reset multiple times.
445 timer_.reset(new base::RepeatingTimer<BackgroundDownloader>);
446 timer_->Start(FROM_HERE, base::TimeDelta::FromSeconds(kJobPollingIntervalSec),
447 this, &BackgroundDownloader::OnDownloading);
448 }
449
450 // Called any time the timer fires.
451 void BackgroundDownloader::OnDownloading() {
452 DCHECK(task_runner_->RunsTasksOnCurrentThread());
453
454 DCHECK(job_.get());
455
456 DCHECK(!is_completed_);
457 if (is_completed_)
458 return;
459
460 BG_JOB_STATE job_state = BG_JOB_STATE_ERROR;
461 HRESULT hr = job_->GetState(&job_state);
462 if (FAILED(hr)) {
463 EndDownload(hr);
464 return;
465 }
466
467 switch (job_state) {
468 case BG_JOB_STATE_TRANSFERRED:
469 OnStateTransferred();
470 return;
471
472 case BG_JOB_STATE_ERROR:
473 OnStateError();
474 return;
475
476 case BG_JOB_STATE_CANCELLED:
477 OnStateCancelled();
478 return;
479
480 case BG_JOB_STATE_ACKNOWLEDGED:
481 OnStateAcknowledged();
482 return;
483
484 case BG_JOB_STATE_QUEUED:
485 // Fall through.
486 case BG_JOB_STATE_CONNECTING:
487 // Fall through.
488 case BG_JOB_STATE_SUSPENDED:
489 OnStateQueued();
490 break;
491
492 case BG_JOB_STATE_TRANSIENT_ERROR:
493 OnStateTransientError();
494 break;
495
496 case BG_JOB_STATE_TRANSFERRING:
497 OnStateTransferring();
498 break;
499
500 default:
501 break;
502 }
503 }
504
505 // Completes the BITS download, picks up the file path of the response, and
506 // notifies the CrxDownloader. The function should be called only once.
507 void BackgroundDownloader::EndDownload(HRESULT error) {
508 DCHECK(task_runner_->RunsTasksOnCurrentThread());
509
510 DCHECK(!is_completed_);
511 is_completed_ = true;
512
513 timer_.reset();
514
515 const base::Time download_end_time(base::Time::Now());
516 const base::TimeDelta download_time =
517 download_end_time >= download_start_time_
518 ? download_end_time - download_start_time_
519 : base::TimeDelta();
520
521 int64_t downloaded_bytes = -1;
522 int64_t total_bytes = -1;
523 GetJobByteCount(job_.get(), &downloaded_bytes, &total_bytes);
524
525 if (FAILED(error) && job_.get()) {
526 job_->Cancel();
527 CleanupJobFiles(job_.get());
528 }
529
530 job_ = NULL;
531
532 CleanupStaleJobs(bits_manager_);
533 bits_manager_ = NULL;
534
535 // Consider the url handled if it has been successfully downloaded or a
536 // 5xx has been received.
537 const bool is_handled =
538 SUCCEEDED(error) || IsHttpServerError(GetHttpStatusFromBitsError(error));
539
540 const int error_to_report = SUCCEEDED(error) ? 0 : error;
541
542 DownloadMetrics download_metrics;
543 download_metrics.url = url();
544 download_metrics.downloader = DownloadMetrics::kBits;
545 download_metrics.error = error_to_report;
546 download_metrics.downloaded_bytes = downloaded_bytes;
547 download_metrics.total_bytes = total_bytes;
548 download_metrics.download_time_ms = download_time.InMilliseconds();
549
550 Result result;
551 result.error = error_to_report;
552 result.response = response_;
553 result.downloaded_bytes = downloaded_bytes;
554 result.total_bytes = total_bytes;
555 main_task_runner_->PostTask(
556 FROM_HERE,
557 base::Bind(&BackgroundDownloader::OnDownloadComplete,
558 base::Unretained(this), is_handled, result, download_metrics));
559
560 // Once the task is posted to the the main thread, this object may be deleted
561 // by its owner. It is not safe to access members of this object on the
562 // task runner from this point on. The timer is stopped and all BITS
563 // interface pointers have been released.
564 }
565
566 // Called when the BITS job has been transferred successfully. Completes the
567 // BITS job by removing it from the BITS queue and making the download
568 // available to the caller.
569 void BackgroundDownloader::OnStateTransferred() {
570 EndDownload(CompleteJob());
571 }
572
573 // Called when the job has encountered an error and no further progress can
574 // be made. Cancels this job and removes it from the BITS queue.
575 void BackgroundDownloader::OnStateError() {
576 HRESULT error_code = S_OK;
577 HRESULT hr = GetJobError(job_.get(), &error_code);
578 if (FAILED(hr))
579 error_code = hr;
580 DCHECK(FAILED(error_code));
581 EndDownload(error_code);
582 }
583
584 // Called when the job has encountered a transient error, such as a
585 // network disconnect, a server error, or some other recoverable error.
586 void BackgroundDownloader::OnStateTransientError() {
587 // If the job appears to be stuck, handle the transient error as if
588 // it were a final error. This causes the job to be cancelled and a specific
589 // error be returned, if the error was available.
590 if (IsStuck()) {
591 OnStateError();
592 return;
593 }
594
595 // Don't retry at all if the transient error was a 5xx.
596 HRESULT error_code = S_OK;
597 HRESULT hr = GetJobError(job_.get(), &error_code);
598 if (SUCCEEDED(hr) &&
599 IsHttpServerError(GetHttpStatusFromBitsError(error_code))) {
600 OnStateError();
601 return;
602 }
603 }
604
605 void BackgroundDownloader::OnStateQueued() {
606 if (IsStuck())
607 EndDownload(E_ABORT); // Return a generic error for now.
608 }
609
610 void BackgroundDownloader::OnStateTransferring() {
611 // Resets the baseline for detecting a stuck job since the job is transferring
612 // data and it is making progress.
613 job_stuck_begin_time_ = base::Time::Now();
614
615 int64_t downloaded_bytes = -1;
616 int64_t total_bytes = -1;
617 HRESULT hr = GetJobByteCount(job_.get(), &downloaded_bytes, &total_bytes);
618 if (FAILED(hr))
619 return;
620
621 Result result;
622 result.downloaded_bytes = downloaded_bytes;
623 result.total_bytes = total_bytes;
624
625 main_task_runner_->PostTask(
626 FROM_HERE, base::Bind(&BackgroundDownloader::OnDownloadProgress,
627 base::Unretained(this), result));
628 }
629
630 // Called when the download was cancelled. Since the observer should have
631 // been disconnected by now, this notification must not be seen.
632 void BackgroundDownloader::OnStateCancelled() {
633 EndDownload(E_UNEXPECTED);
634 }
635
636 // Called when the download was completed. Same as above.
637 void BackgroundDownloader::OnStateAcknowledged() {
638 EndDownload(E_UNEXPECTED);
639 }
640
641 // Creates or opens a job for the given url and queues it up. Tries to
642 // install a job observer but continues on if an observer can't be set up.
643 HRESULT BackgroundDownloader::QueueBitsJob(const GURL& url) {
644 DCHECK(task_runner_->RunsTasksOnCurrentThread());
645
646 HRESULT hr = S_OK;
647 if (bits_manager_.get() == NULL) {
648 hr = GetBitsManager(bits_manager_.Receive());
649 if (FAILED(hr))
650 return hr;
651 }
652
653 hr = CreateOrOpenJob(url);
654 if (FAILED(hr))
655 return hr;
656
657 if (hr == S_OK) {
658 hr = InitializeNewJob(url);
659 if (FAILED(hr))
660 return hr;
661 }
662
663 return job_->Resume();
664 }
665
666 HRESULT BackgroundDownloader::CreateOrOpenJob(const GURL& url) {
667 std::vector<ScopedComPtr<IBackgroundCopyJob>> jobs;
668 HRESULT hr = FindBitsJobIf(
669 std::bind2nd(JobFileUrlEqual(), base::SysUTF8ToWide(url.spec())),
670 bits_manager_.get(), &jobs);
671 if (SUCCEEDED(hr) && !jobs.empty()) {
672 job_ = jobs.front();
673 return S_FALSE;
674 }
675
676 // Use kJobDescription as a temporary job display name until the proper
677 // display name is initialized later on.
678 GUID guid = {0};
679 ScopedComPtr<IBackgroundCopyJob> job;
680 hr = bits_manager_->CreateJob(kJobDescription, BG_JOB_TYPE_DOWNLOAD, &guid,
681 job.Receive());
682 if (FAILED(hr))
683 return hr;
684
685 job_ = job;
686 return S_OK;
687 }
688
689 HRESULT BackgroundDownloader::InitializeNewJob(const GURL& url) {
690 const base::string16 filename(base::SysUTF8ToWide(url.ExtractFileName()));
691
692 base::FilePath tempdir;
693 if (!base::CreateNewTempDirectory(FILE_PATH_LITERAL("chrome_BITS_"),
694 &tempdir))
695 return E_FAIL;
696
697 HRESULT hr = job_->AddFile(base::SysUTF8ToWide(url.spec()).c_str(),
698 tempdir.Append(filename).AsUTF16Unsafe().c_str());
699 if (FAILED(hr))
700 return hr;
701
702 hr = job_->SetDisplayName(filename.c_str());
703 if (FAILED(hr))
704 return hr;
705
706 hr = job_->SetDescription(kJobDescription);
707 if (FAILED(hr))
708 return hr;
709
710 hr = job_->SetPriority(BG_JOB_PRIORITY_NORMAL);
711 if (FAILED(hr))
712 return hr;
713
714 hr = job_->SetMinimumRetryDelay(60 * kMinimumRetryDelayMin);
715 if (FAILED(hr))
716 return hr;
717
718 const int kSecondsDay = 60 * 60 * 24;
719 hr = job_->SetNoProgressTimeout(kSecondsDay * kSetNoProgressTimeoutDays);
720 if (FAILED(hr))
721 return hr;
722
723 return S_OK;
724 }
725
726 bool BackgroundDownloader::IsStuck() {
727 const base::TimeDelta job_stuck_timeout(
728 base::TimeDelta::FromMinutes(kJobStuckTimeoutMin));
729 return job_stuck_begin_time_ + job_stuck_timeout < base::Time::Now();
730 }
731
732 HRESULT BackgroundDownloader::CompleteJob() {
733 HRESULT hr = job_->Complete();
734 if (FAILED(hr) && hr != BG_S_UNABLE_TO_DELETE_FILES)
735 return hr;
736
737 std::vector<ScopedComPtr<IBackgroundCopyFile>> files;
738 hr = GetFilesInJob(job_.get(), &files);
739 if (FAILED(hr))
740 return hr;
741
742 if (files.empty())
743 return E_UNEXPECTED;
744
745 base::string16 local_name;
746 BG_FILE_PROGRESS progress = {0};
747 hr = GetJobFileProperties(files.front().get(), &local_name, NULL, &progress);
748 if (FAILED(hr))
749 return hr;
750
751 // Sanity check the post-conditions of a successful download, including
752 // the file and job invariants. The byte counts for a job and its file
753 // must match as a job only contains one file.
754 DCHECK(progress.Completed);
755 DCHECK_EQ(progress.BytesTotal, progress.BytesTransferred);
756
757 response_ = base::FilePath(local_name);
758
759 return S_OK;
760 }
761
762 } // namespace update_client
OLDNEW
« no previous file with comments | « components/update_client/background_downloader_win.h ('k') | components/update_client/component_patcher.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698