rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 1 | // Copyright (c) 2009 The Chromium OS 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 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_DOWNLOAD_ACTION_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_DOWNLOAD_ACTION_H__ |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 7 | |
| 8 | #include <sys/types.h> |
| 9 | #include <sys/stat.h> |
| 10 | #include <fcntl.h> |
| 11 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 12 | #include <string> |
| 13 | |
Darin Petkov | e971f33 | 2010-09-22 16:57:25 -0700 | [diff] [blame] | 14 | #include <base/scoped_ptr.h> |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 15 | #include <curl/curl.h> |
| 16 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 17 | #include "update_engine/action.h" |
| 18 | #include "update_engine/decompressing_file_writer.h" |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 19 | #include "update_engine/delta_performer.h" |
Darin Petkov | e971f33 | 2010-09-22 16:57:25 -0700 | [diff] [blame] | 20 | #include "update_engine/buffered_file_writer.h" |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 21 | #include "update_engine/http_fetcher.h" |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 22 | #include "update_engine/install_plan.h" |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 23 | #include "update_engine/omaha_hash_calculator.h" |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 24 | #include "update_engine/split_file_writer.h" |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 25 | |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 26 | // The Download Action downloads a specified url to disk. The url should |
| 27 | // point to either a full or delta update. If a full update, the file will |
| 28 | // be piped into a SplitFileWriter, which will direct it to the kernel |
| 29 | // and rootfs partitions. If it's a delta update, the destination kernel |
| 30 | // and rootfs should already contain the source-version that this delta |
| 31 | // update goes from. In this case, the update will be piped into a |
| 32 | // DeltaPerformer that will apply the delta to the disk. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 33 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 34 | namespace chromeos_update_engine { |
| 35 | |
Andrew de los Reyes | 63b96d7 | 2010-05-10 13:08:54 -0700 | [diff] [blame] | 36 | class DownloadActionDelegate { |
| 37 | public: |
Darin Petkov | 9d911fa | 2010-08-19 09:36:08 -0700 | [diff] [blame] | 38 | // Called right before starting the download with |active| set to |
| 39 | // true. Called after completing the download with |active| set to |
| 40 | // false. |
| 41 | virtual void SetDownloadStatus(bool active) = 0; |
| 42 | |
| 43 | // Called periodically after bytes are received. This method will be |
| 44 | // invoked only if the download is active. |bytes_received| is the |
| 45 | // number of bytes downloaded thus far. |total| is the number of |
| 46 | // bytes expected. |
Andrew de los Reyes | 63b96d7 | 2010-05-10 13:08:54 -0700 | [diff] [blame] | 47 | virtual void BytesReceived(uint64_t bytes_received, uint64_t total) = 0; |
| 48 | }; |
| 49 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 50 | class DownloadAction; |
| 51 | class NoneType; |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 52 | class PrefsInterface; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 53 | |
| 54 | template<> |
| 55 | class ActionTraits<DownloadAction> { |
| 56 | public: |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 57 | // Takes and returns an InstallPlan |
| 58 | typedef InstallPlan InputObjectType; |
| 59 | typedef InstallPlan OutputObjectType; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | class DownloadAction : public Action<DownloadAction>, |
| 63 | public HttpFetcherDelegate { |
| 64 | public: |
| 65 | // Takes ownership of the passed in HttpFetcher. Useful for testing. |
| 66 | // A good calling pattern is: |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 67 | // DownloadAction(new WhateverHttpFetcher); |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 68 | DownloadAction(PrefsInterface* prefs, HttpFetcher* http_fetcher); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 69 | virtual ~DownloadAction(); |
| 70 | typedef ActionTraits<DownloadAction>::InputObjectType InputObjectType; |
| 71 | typedef ActionTraits<DownloadAction>::OutputObjectType OutputObjectType; |
| 72 | void PerformAction(); |
| 73 | void TerminateProcessing(); |
| 74 | |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 75 | // Testing |
| 76 | void SetTestFileWriter(FileWriter* writer) { |
| 77 | writer_ = writer; |
| 78 | } |
| 79 | |
Darin Petkov | 1023a60 | 2010-08-30 13:47:51 -0700 | [diff] [blame] | 80 | int GetHTTPResponseCode() { return http_fetcher_->http_response_code(); } |
| 81 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 82 | // Debugging/logging |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 83 | static std::string StaticType() { return "DownloadAction"; } |
| 84 | std::string Type() const { return StaticType(); } |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 85 | |
Andrew de los Reyes | 63b96d7 | 2010-05-10 13:08:54 -0700 | [diff] [blame] | 86 | // HttpFetcherDelegate methods (see http_fetcher.h) |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 87 | virtual void ReceivedBytes(HttpFetcher *fetcher, |
| 88 | const char* bytes, int length); |
Andrew de los Reyes | 34e41a1 | 2010-10-26 20:07:58 -0700 | [diff] [blame] | 89 | virtual void SeekToOffset(off_t offset); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 90 | virtual void TransferComplete(HttpFetcher *fetcher, bool successful); |
Darin Petkov | 9ce452b | 2010-11-17 14:33:28 -0800 | [diff] [blame] | 91 | virtual void TransferTerminated(HttpFetcher *fetcher); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 92 | |
Darin Petkov | f42cc1c | 2010-09-01 09:03:02 -0700 | [diff] [blame] | 93 | DownloadActionDelegate* delegate() const { return delegate_; } |
Andrew de los Reyes | 63b96d7 | 2010-05-10 13:08:54 -0700 | [diff] [blame] | 94 | void set_delegate(DownloadActionDelegate* delegate) { |
| 95 | delegate_ = delegate; |
| 96 | } |
| 97 | |
Darin Petkov | 9b23057 | 2010-10-08 10:20:09 -0700 | [diff] [blame] | 98 | HttpFetcher* http_fetcher() { return http_fetcher_.get(); } |
| 99 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 100 | private: |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 101 | // The InstallPlan passed in |
| 102 | InstallPlan install_plan_; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 103 | |
Darin Petkov | 73058b4 | 2010-10-06 16:32:19 -0700 | [diff] [blame] | 104 | // Update Engine preference store. |
| 105 | PrefsInterface* prefs_; |
| 106 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 107 | // The FileWriter that downloaded data should be written to. It will |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 108 | // either point to *decompressing_file_writer_ or *delta_performer_. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 109 | FileWriter* writer_; |
| 110 | |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 111 | // These are used for full updates: |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 112 | scoped_ptr<GzipDecompressingFileWriter> decompressing_file_writer_; |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 113 | scoped_ptr<SplitFileWriter> split_file_writer_; |
| 114 | scoped_ptr<DirectFileWriter> kernel_file_writer_; |
| 115 | scoped_ptr<DirectFileWriter> rootfs_file_writer_; |
Darin Petkov | e971f33 | 2010-09-22 16:57:25 -0700 | [diff] [blame] | 116 | scoped_ptr<BufferedFileWriter> kernel_buffered_file_writer_; |
| 117 | scoped_ptr<BufferedFileWriter> rootfs_buffered_file_writer_; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 118 | |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 119 | // Used to apply a delta update: |
| 120 | scoped_ptr<DeltaPerformer> delta_performer_; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 121 | |
Andrew de los Reyes | f918517 | 2010-05-03 11:07:05 -0700 | [diff] [blame] | 122 | // Pointer to the HttpFetcher that does the http work. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 123 | scoped_ptr<HttpFetcher> http_fetcher_; |
| 124 | |
| 125 | // Used to find the hash of the bytes downloaded |
| 126 | OmahaHashCalculator omaha_hash_calculator_; |
Darin Petkov | 9d911fa | 2010-08-19 09:36:08 -0700 | [diff] [blame] | 127 | |
Darin Petkov | 9ce452b | 2010-11-17 14:33:28 -0800 | [diff] [blame] | 128 | // Used by TransferTerminated to figure if this action terminated itself or |
| 129 | // was terminated by the action processor. |
| 130 | ActionExitCode code_; |
| 131 | |
Andrew de los Reyes | 63b96d7 | 2010-05-10 13:08:54 -0700 | [diff] [blame] | 132 | // For reporting status to outsiders |
| 133 | DownloadActionDelegate* delegate_; |
| 134 | uint64_t bytes_received_; |
Darin Petkov | 9d911fa | 2010-08-19 09:36:08 -0700 | [diff] [blame] | 135 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 136 | DISALLOW_COPY_AND_ASSIGN(DownloadAction); |
| 137 | }; |
| 138 | |
| 139 | // We want to be sure that we're compiled with large file support on linux, |
| 140 | // just in case we find ourselves downloading large images. |
| 141 | COMPILE_ASSERT(8 == sizeof(off_t), off_t_not_64_bit); |
| 142 | |
| 143 | } // namespace chromeos_update_engine |
| 144 | |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 145 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_DOWNLOAD_ACTION_H__ |