1//
2// Copyright (C) 2010 The Android Open Source Project
3//
4// Licensed under the Apache License, Version 2.0 (the "License");
5// you may not use this file except in compliance with the License.
6// You may obtain a copy of the License at
7//
8//      http://www.apache.org/licenses/LICENSE-2.0
9//
10// Unless required by applicable law or agreed to in writing, software
11// distributed under the License is distributed on an "AS IS" BASIS,
12// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13// See the License for the specific language governing permissions and
14// limitations under the License.
15//
16
17#ifndef UPDATE_ENGINE_DBUS_SERVICE_H_
18#define UPDATE_ENGINE_DBUS_SERVICE_H_
19
20#include <inttypes.h>
21
22#include <memory>
23#include <string>
24
25#include <base/memory/ref_counted.h>
26#include <brillo/errors/error.h>
27
28#include "update_engine/common_service.h"
29#include "update_engine/service_observer_interface.h"
30#include "update_engine/update_attempter.h"
31
32#include "dbus_bindings/org.chromium.UpdateEngineInterface.h"
33
34namespace chromeos_update_engine {
35
36class DBusUpdateEngineService
37    : public org::chromium::UpdateEngineInterfaceInterface {
38 public:
39  explicit DBusUpdateEngineService(SystemState* system_state);
40  virtual ~DBusUpdateEngineService() = default;
41
42  // Implementation of org::chromium::UpdateEngineInterfaceInterface.
43  bool AttemptUpdate(brillo::ErrorPtr* error,
44                     const std::string& in_app_version,
45                     const std::string& in_omaha_url) override;
46
47  bool AttemptUpdateWithFlags(brillo::ErrorPtr* error,
48                              const std::string& in_app_version,
49                              const std::string& in_omaha_url,
50                              int32_t in_flags_as_int) override;
51
52  bool AttemptRollback(brillo::ErrorPtr* error, bool in_powerwash) override;
53
54  // Checks if the system rollback is available by verifying if the secondary
55  // system partition is valid and bootable.
56  bool CanRollback(brillo::ErrorPtr* error, bool* out_can_rollback) override;
57
58  // Resets the status of the update_engine to idle, ignoring any applied
59  // update. This is used for development only.
60  bool ResetStatus(brillo::ErrorPtr* error) override;
61
62  // Returns the current status of the Update Engine. If an update is in
63  // progress, the number of operations, size to download and overall progress
64  // is reported.
65  bool GetStatus(brillo::ErrorPtr* error,
66                 int64_t* out_last_checked_time,
67                 double* out_progress,
68                 std::string* out_current_operation,
69                 std::string* out_new_version,
70                 int64_t* out_new_size) override;
71
72  // Reboots the device if an update is applied and a reboot is required.
73  bool RebootIfNeeded(brillo::ErrorPtr* error) override;
74
75  // Changes the current channel of the device to the target channel. If the
76  // target channel is a less stable channel than the current channel, then the
77  // channel change happens immediately (at the next update check).  If the
78  // target channel is a more stable channel, then if is_powerwash_allowed is
79  // set to true, then also the change happens immediately but with a powerwash
80  // if required. Otherwise, the change takes effect eventually (when the
81  // version on the target channel goes above the version number of what the
82  // device currently has).
83  bool SetChannel(brillo::ErrorPtr* error,
84                  const std::string& in_target_channel,
85                  bool in_is_powerwash_allowed) override;
86
87  // If get_current_channel is set to true, populates |channel| with the name of
88  // the channel that the device is currently on. Otherwise, it populates it
89  // with the name of the channel the device is supposed to be (in case of a
90  // pending channel change).
91  bool GetChannel(brillo::ErrorPtr* error,
92                  bool in_get_current_channel,
93                  std::string* out_channel) override;
94
95  bool SetCohortHint(brillo::ErrorPtr* error,
96                     const std::string& in_cohort_hint) override;
97
98  bool GetCohortHint(brillo::ErrorPtr* error,
99                     std::string* out_cohort_hint) override;
100
101  // Enables or disables the sharing and consuming updates over P2P feature
102  // according to the |enabled| argument passed.
103  bool SetP2PUpdatePermission(brillo::ErrorPtr* error,
104                              bool in_enabled) override;
105
106  // Returns the current value for the P2P enabled setting. This involves both
107  // sharing and consuming updates over P2P.
108  bool GetP2PUpdatePermission(brillo::ErrorPtr* error,
109                              bool* out_enabled) override;
110
111  // If there's no device policy installed, sets the update over cellular
112  // networks permission to the |allowed| value. Otherwise, this method returns
113  // with an error since this setting is overridden by the applied policy.
114  bool SetUpdateOverCellularPermission(brillo::ErrorPtr* error,
115                                       bool in_allowed) override;
116
117  // Returns the current value of the update over cellular network setting,
118  // either forced by the device policy if the device is enrolled or the current
119  // user preference otherwise.
120  bool GetUpdateOverCellularPermission(brillo::ErrorPtr* error,
121                                       bool* out_allowed) override;
122
123  // Returns the duration since the last successful update, as the
124  // duration on the wallclock. Returns an error if the device has not
125  // updated.
126  bool GetDurationSinceUpdate(brillo::ErrorPtr* error,
127                              int64_t* out_usec_wallclock) override;
128
129  // Returns the version string of OS that was used before the last reboot
130  // into an updated version. This is available only when rebooting into an
131  // update from previous version, otherwise an empty string is returned.
132  bool GetPrevVersion(brillo::ErrorPtr* error,
133                      std::string* out_prev_version) override;
134
135  // Returns the name of kernel partition that can be rolled back into.
136  bool GetRollbackPartition(brillo::ErrorPtr* error,
137                            std::string* out_rollback_partition_name) override;
138
139  // Returns the last UpdateAttempt error. If not updated yet, default success
140  // ErrorCode will be returned.
141  bool GetLastAttemptError(brillo::ErrorPtr* error,
142                           int32_t* out_last_attempt_error) override;
143
144  // Returns the current end-of-life status of the device in |out_eol_status|.
145  bool GetEolStatus(brillo::ErrorPtr* error, int32_t* out_eol_status) override;
146
147 private:
148  std::unique_ptr<UpdateEngineService> common_;
149};
150
151// The UpdateEngineAdaptor class runs the UpdateEngineInterface in the fixed
152// object path, without an ObjectManager notifying the interfaces, since it is
153// all static and clients don't expect it to be implemented.
154class UpdateEngineAdaptor : public org::chromium::UpdateEngineInterfaceAdaptor,
155                            public ServiceObserverInterface {
156 public:
157  UpdateEngineAdaptor(SystemState* system_state);
158  ~UpdateEngineAdaptor() = default;
159
160  // Register the DBus object with the update engine service asynchronously.
161  // Calls |copmletion_callback| when done passing a boolean indicating if the
162  // registration succeeded.
163  void RegisterAsync(const base::Callback<void(bool)>& completion_callback);
164
165  // Takes ownership of the well-known DBus name and returns whether it
166  // succeeded.
167  bool RequestOwnership();
168
169  // ServiceObserverInterface overrides.
170  void SendStatusUpdate(
171      const update_engine::UpdateEngineStatus& update_engine_status) override;
172
173  void SendPayloadApplicationComplete(ErrorCode error_code) override {}
174
175 private:
176  scoped_refptr<dbus::Bus> bus_;
177  DBusUpdateEngineService dbus_service_;
178  brillo::dbus_utils::DBusObject dbus_object_;
179};
180
181}  // namespace chromeos_update_engine
182
183#endif  // UPDATE_ENGINE_DBUS_SERVICE_H_
184