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 #include <vector>
25 
26 #include <base/memory/ref_counted.h>
27 #include <brillo/errors/error.h>
28 #include <update_engine/proto_bindings/update_engine.pb.h>
29 
30 #include "update_engine/common_service.h"
31 #include "update_engine/service_observer_interface.h"
32 #include "update_engine/update_attempter.h"
33 
34 #include "dbus_bindings/org.chromium.UpdateEngineInterface.h"
35 
36 namespace chromeos_update_engine {
37 
38 class DBusUpdateEngineService
39     : public org::chromium::UpdateEngineInterfaceInterface {
40  public:
41   explicit DBusUpdateEngineService(SystemState* system_state);
42   virtual ~DBusUpdateEngineService() = default;
43 
44   // Implementation of org::chromium::UpdateEngineInterfaceInterface.
45   bool AttemptUpdate(brillo::ErrorPtr* error,
46                      const std::string& in_app_version,
47                      const std::string& in_omaha_url) override;
48 
49   bool AttemptUpdateWithFlags(brillo::ErrorPtr* error,
50                               const std::string& in_app_version,
51                               const std::string& in_omaha_url,
52                               int32_t in_flags_as_int) override;
53 
54   bool AttemptInstall(brillo::ErrorPtr* error,
55                       const std::string& in_omaha_url,
56                       const std::vector<std::string>& dlc_ids) override;
57 
58   bool AttemptRollback(brillo::ErrorPtr* error, bool in_powerwash) override;
59 
60   // Checks if the system rollback is available by verifying if the secondary
61   // system partition is valid and bootable.
62   bool CanRollback(brillo::ErrorPtr* error, bool* out_can_rollback) override;
63 
64   // Resets the status of the update_engine to idle, ignoring any applied
65   // update. This is used for development only.
66   bool ResetStatus(brillo::ErrorPtr* error) override;
67 
68   // Sets the DLC as active or inactive. When set to active, the ping metadata
69   // for the DLC is updated accordingly. When set to inactive, the metadata
70   // for the DLC is deleted.
71   bool SetDlcActiveValue(brillo::ErrorPtr* error,
72                          bool is_active,
73                          const std::string& dlc_id) override;
74 
75   // Similar to Above, but returns a protobuffer instead. In the future it will
76   // have more features and is easily extendable.
77   bool GetStatusAdvanced(brillo::ErrorPtr* error,
78                          update_engine::StatusResult* out_status) override;
79 
80   // Reboots the device if an update is applied and a reboot is required.
81   bool RebootIfNeeded(brillo::ErrorPtr* error) override;
82 
83   // Changes the current channel of the device to the target channel. If the
84   // target channel is a less stable channel than the current channel, then the
85   // channel change happens immediately (at the next update check).  If the
86   // target channel is a more stable channel, then if is_powerwash_allowed is
87   // set to true, then also the change happens immediately but with a powerwash
88   // if required. Otherwise, the change takes effect eventually (when the
89   // version on the target channel goes above the version number of what the
90   // device currently has).
91   bool SetChannel(brillo::ErrorPtr* error,
92                   const std::string& in_target_channel,
93                   bool in_is_powerwash_allowed) override;
94 
95   // If get_current_channel is set to true, populates |channel| with the name of
96   // the channel that the device is currently on. Otherwise, it populates it
97   // with the name of the channel the device is supposed to be (in case of a
98   // pending channel change).
99   bool GetChannel(brillo::ErrorPtr* error,
100                   bool in_get_current_channel,
101                   std::string* out_channel) override;
102 
103   bool SetCohortHint(brillo::ErrorPtr* error,
104                      const std::string& in_cohort_hint) override;
105 
106   bool GetCohortHint(brillo::ErrorPtr* error,
107                      std::string* out_cohort_hint) override;
108 
109   // Enables or disables the sharing and consuming updates over P2P feature
110   // according to the |enabled| argument passed.
111   bool SetP2PUpdatePermission(brillo::ErrorPtr* error,
112                               bool in_enabled) override;
113 
114   // Returns the current value for the P2P enabled setting. This involves both
115   // sharing and consuming updates over P2P.
116   bool GetP2PUpdatePermission(brillo::ErrorPtr* error,
117                               bool* out_enabled) override;
118 
119   // If there's no device policy installed, sets the update over cellular
120   // networks permission to the |allowed| value. Otherwise, this method returns
121   // with an error since this setting is overridden by the applied policy.
122   bool SetUpdateOverCellularPermission(brillo::ErrorPtr* error,
123                                        bool in_allowed) override;
124 
125   // If there's no device policy installed, sets the update over cellular
126   // target. Otherwise, this method returns with an error.
127   bool SetUpdateOverCellularTarget(brillo::ErrorPtr* error,
128                                    const std::string& target_version,
129                                    int64_t target_size) override;
130 
131   // Returns the current value of the update over cellular network setting,
132   // either forced by the device policy if the device is enrolled or the current
133   // user preference otherwise.
134   bool GetUpdateOverCellularPermission(brillo::ErrorPtr* error,
135                                        bool* out_allowed) override;
136 
137   // Returns the duration since the last successful update, as the
138   // duration on the wallclock. Returns an error if the device has not
139   // updated.
140   bool GetDurationSinceUpdate(brillo::ErrorPtr* error,
141                               int64_t* out_usec_wallclock) override;
142 
143   // Returns the version string of OS that was used before the last reboot
144   // into an updated version. This is available only when rebooting into an
145   // update from previous version, otherwise an empty string is returned.
146   bool GetPrevVersion(brillo::ErrorPtr* error,
147                       std::string* out_prev_version) override;
148 
149   // Returns the name of kernel partition that can be rolled back into.
150   bool GetRollbackPartition(brillo::ErrorPtr* error,
151                             std::string* out_rollback_partition_name) override;
152 
153   // Returns the last UpdateAttempt error. If not updated yet, default success
154   // ErrorCode will be returned.
155   bool GetLastAttemptError(brillo::ErrorPtr* error,
156                            int32_t* out_last_attempt_error) override;
157 
158  private:
159   std::unique_ptr<UpdateEngineService> common_;
160 };
161 
162 // The UpdateEngineAdaptor class runs the UpdateEngineInterface in the fixed
163 // object path, without an ObjectManager notifying the interfaces, since it is
164 // all static and clients don't expect it to be implemented.
165 class UpdateEngineAdaptor : public org::chromium::UpdateEngineInterfaceAdaptor,
166                             public ServiceObserverInterface {
167  public:
168   explicit UpdateEngineAdaptor(SystemState* system_state);
169   ~UpdateEngineAdaptor() = default;
170 
171   // Register the DBus object with the update engine service asynchronously.
172   // Calls |copmletion_callback| when done passing a boolean indicating if the
173   // registration succeeded.
174   void RegisterAsync(const base::Callback<void(bool)>& completion_callback);
175 
176   // Takes ownership of the well-known DBus name and returns whether it
177   // succeeded.
178   bool RequestOwnership();
179 
180   // ServiceObserverInterface overrides.
181   void SendStatusUpdate(
182       const update_engine::UpdateEngineStatus& update_engine_status) override;
183 
SendPayloadApplicationComplete(ErrorCode error_code)184   void SendPayloadApplicationComplete(ErrorCode error_code) override {}
185 
186  private:
187   scoped_refptr<dbus::Bus> bus_;
188   DBusUpdateEngineService dbus_service_;
189   brillo::dbus_utils::DBusObject dbus_object_;
190 };
191 
192 }  // namespace chromeos_update_engine
193 
194 #endif  // UPDATE_ENGINE_DBUS_SERVICE_H_
195