Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 1 | // Copyright (c) 2010 The Chromium OS Authors. All rights reserved. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 5 | #ifndef CHROMEOS_PLATFORM_UPDATE_ENGINE_OMAHA_REQUEST_ACTION_H__ |
| 6 | #define CHROMEOS_PLATFORM_UPDATE_ENGINE_OMAHA_REQUEST_ACTION_H__ |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 7 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 8 | #include <sys/stat.h> |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 9 | #include <sys/types.h> |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 10 | #include <fcntl.h> |
| 11 | |
| 12 | #include <string> |
| 13 | |
| 14 | #include <curl/curl.h> |
| 15 | |
| 16 | #include "base/scoped_ptr.h" |
Andrew de los Reyes | 09e56d6 | 2010-04-23 13:45:53 -0700 | [diff] [blame] | 17 | #include "update_engine/action.h" |
| 18 | #include "update_engine/http_fetcher.h" |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 19 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 20 | // The Omaha Request action makes a request to Omaha and can output |
| 21 | // the response on the output ActionPipe. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 22 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 23 | namespace chromeos_update_engine { |
| 24 | |
| 25 | // Encodes XML entities in a given string with libxml2. input must be |
| 26 | // UTF-8 formatted. Output will be UTF-8 formatted. |
| 27 | std::string XmlEncode(const std::string& input); |
| 28 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 29 | // This struct encapsulates the data Omaha's response for the request. |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 30 | // These strings in this struct are not XML escaped. |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 31 | struct OmahaResponse { |
| 32 | OmahaResponse() |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 33 | : update_exists(false), size(0), needs_admin(false), prompt(false) {} |
| 34 | // True iff there is an update to be downloaded. |
| 35 | bool update_exists; |
| 36 | |
| 37 | // These are only valid if update_exists is true: |
| 38 | std::string display_version; |
| 39 | std::string codebase; |
| 40 | std::string more_info_url; |
| 41 | std::string hash; |
| 42 | off_t size; |
| 43 | bool needs_admin; |
| 44 | bool prompt; |
Andrew de los Reyes | 3270f74 | 2010-07-15 22:28:14 -0700 | [diff] [blame] | 45 | bool is_delta; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 46 | }; |
| 47 | COMPILE_ASSERT(sizeof(off_t) == 8, off_t_not_64bit); |
| 48 | |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 49 | // This struct encapsulates the Omaha event information. For a |
| 50 | // complete list of defined event types and results, see |
| 51 | // http://code.google.com/p/omaha/wiki/ServerProtocol#event |
| 52 | struct OmahaEvent { |
| 53 | enum Type { |
| 54 | kTypeUnknown = 0, |
| 55 | kTypeDownloadComplete = 1, |
| 56 | kTypeInstallComplete = 2, |
| 57 | kTypeUpdateComplete = 3, |
Darin Petkov | 8c2980e | 2010-07-16 15:16:49 -0700 | [diff] [blame] | 58 | kTypeUpdateDownloadStarted = 13, |
| 59 | kTypeUpdateDownloadFinished = 14, |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 60 | }; |
| 61 | |
| 62 | enum Result { |
| 63 | kResultError = 0, |
| 64 | kResultSuccess = 1, |
| 65 | }; |
| 66 | |
| 67 | OmahaEvent() |
| 68 | : type(kTypeUnknown), |
| 69 | result(kResultError), |
Darin Petkov | e17f86b | 2010-07-20 09:12:01 -0700 | [diff] [blame^] | 70 | error_code(kActionCodeError) {} |
| 71 | explicit OmahaEvent(Type in_type) |
| 72 | : type(in_type), |
| 73 | result(kResultSuccess), |
| 74 | error_code(kActionCodeSuccess) {} |
| 75 | OmahaEvent(Type in_type, Result in_result, ActionExitCode in_error_code) |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 76 | : type(in_type), |
| 77 | result(in_result), |
| 78 | error_code(in_error_code) {} |
| 79 | |
| 80 | Type type; |
| 81 | Result result; |
Darin Petkov | e17f86b | 2010-07-20 09:12:01 -0700 | [diff] [blame^] | 82 | ActionExitCode error_code; |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 83 | }; |
| 84 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 85 | class NoneType; |
Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 86 | class OmahaRequestAction; |
| 87 | struct OmahaRequestParams; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 88 | |
| 89 | template<> |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 90 | class ActionTraits<OmahaRequestAction> { |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 91 | public: |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 92 | // Takes parameters on the input pipe. |
Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 93 | typedef NoneType InputObjectType; |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 94 | // On UpdateCheck success, puts the Omaha response on output. Event |
| 95 | // requests do not have an output pipe. |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 96 | typedef OmahaResponse OutputObjectType; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 97 | }; |
| 98 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 99 | class OmahaRequestAction : public Action<OmahaRequestAction>, |
| 100 | public HttpFetcherDelegate { |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 101 | public: |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 102 | // The ctor takes in all the parameters that will be used for making |
| 103 | // the request to Omaha. For some of them we have constants that |
| 104 | // should be used. |
| 105 | // |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 106 | // Takes ownership of the passed in HttpFetcher. Useful for testing. |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 107 | // |
| 108 | // Takes ownership of the passed in OmahaEvent. If |event| is NULL, |
| 109 | // this is an UpdateCheck request, otherwise it's an Event request. |
| 110 | // Event requests always succeed. |
| 111 | // |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 112 | // A good calling pattern is: |
Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 113 | // OmahaRequestAction(..., new OmahaEvent(...), new WhateverHttpFetcher); |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 114 | // or |
Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 115 | // OmahaRequestAction(..., NULL, new WhateverHttpFetcher); |
| 116 | OmahaRequestAction(const OmahaRequestParams& params, |
| 117 | OmahaEvent* event, |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 118 | HttpFetcher* http_fetcher); |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 119 | virtual ~OmahaRequestAction(); |
| 120 | typedef ActionTraits<OmahaRequestAction>::InputObjectType InputObjectType; |
| 121 | typedef ActionTraits<OmahaRequestAction>::OutputObjectType OutputObjectType; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 122 | void PerformAction(); |
| 123 | void TerminateProcessing(); |
| 124 | |
| 125 | // Debugging/logging |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 126 | static std::string StaticType() { return "OmahaRequestAction"; } |
adlr@google.com | c98a7ed | 2009-12-04 18:54:03 +0000 | [diff] [blame] | 127 | std::string Type() const { return StaticType(); } |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 128 | |
| 129 | // Delegate methods (see http_fetcher.h) |
| 130 | virtual void ReceivedBytes(HttpFetcher *fetcher, |
| 131 | const char* bytes, int length); |
| 132 | virtual void TransferComplete(HttpFetcher *fetcher, bool successful); |
| 133 | |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 134 | // Returns true if this is an Event request, false if it's an UpdateCheck. |
| 135 | bool IsEvent() const { return event_.get() != NULL; } |
| 136 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 137 | private: |
Darin Petkov | a4a8a8c | 2010-07-15 22:21:12 -0700 | [diff] [blame] | 138 | // These are data that are passed in the request to the Omaha server. |
| 139 | const OmahaRequestParams& params_; |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 140 | |
Darin Petkov | 0dc8e9a | 2010-07-14 14:51:57 -0700 | [diff] [blame] | 141 | // Pointer to the OmahaEvent info. This is an UpdateCheck request if NULL. |
| 142 | scoped_ptr<OmahaEvent> event_; |
| 143 | |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 144 | // pointer to the HttpFetcher that does the http work |
| 145 | scoped_ptr<HttpFetcher> http_fetcher_; |
| 146 | |
| 147 | // Stores the response from the omaha server |
| 148 | std::vector<char> response_buffer_; |
| 149 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 150 | DISALLOW_COPY_AND_ASSIGN(OmahaRequestAction); |
rspangler@google.com | 49fdf18 | 2009-10-10 00:57:34 +0000 | [diff] [blame] | 151 | }; |
| 152 | |
| 153 | } // namespace chromeos_update_engine |
| 154 | |
Darin Petkov | 6a5b322 | 2010-07-13 14:55:28 -0700 | [diff] [blame] | 155 | #endif // CHROMEOS_PLATFORM_UPDATE_ENGINE_OMAHA_REQUEST_ACTION_H__ |