Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 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 | package com.example.android.systemupdatersample; |
| 18 | |
| 19 | import android.content.Context; |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 20 | import android.os.Handler; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 21 | import android.os.UpdateEngine; |
| 22 | import android.os.UpdateEngineCallback; |
| 23 | import android.util.Log; |
| 24 | |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 25 | import com.example.android.systemupdatersample.services.PrepareUpdateService; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 26 | import com.example.android.systemupdatersample.util.UpdateEngineErrorCodes; |
| 27 | import com.example.android.systemupdatersample.util.UpdateEngineProperties; |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 28 | import com.google.common.base.Preconditions; |
| 29 | import com.google.common.collect.ImmutableList; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 30 | import com.google.common.util.concurrent.AtomicDouble; |
| 31 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 32 | import java.util.ArrayList; |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 33 | import java.util.Collections; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 34 | import java.util.List; |
| 35 | import java.util.Optional; |
| 36 | import java.util.concurrent.atomic.AtomicBoolean; |
| 37 | import java.util.concurrent.atomic.AtomicInteger; |
| 38 | import java.util.function.DoubleConsumer; |
| 39 | import java.util.function.IntConsumer; |
| 40 | |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 41 | import javax.annotation.concurrent.GuardedBy; |
| 42 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 43 | /** |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 44 | * Manages the update flow. It has its own state (in memory), separate from |
| 45 | * {@link UpdateEngine}'s state. Asynchronously interacts with the {@link UpdateEngine}. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 46 | */ |
| 47 | public class UpdateManager { |
| 48 | |
| 49 | private static final String TAG = "UpdateManager"; |
| 50 | |
| 51 | /** HTTP Header: User-Agent; it will be sent to the server when streaming the payload. */ |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 52 | static final String HTTP_USER_AGENT = "Mozilla/5.0 (Windows NT 10.0; Win64; x64) " |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 53 | + "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/60.0.3112.113 Safari/537.36"; |
| 54 | |
| 55 | private final UpdateEngine mUpdateEngine; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 56 | |
| 57 | private AtomicInteger mUpdateEngineStatus = |
| 58 | new AtomicInteger(UpdateEngine.UpdateStatusConstants.IDLE); |
| 59 | private AtomicInteger mEngineErrorCode = new AtomicInteger(UpdateEngineErrorCodes.UNKNOWN); |
| 60 | private AtomicDouble mProgress = new AtomicDouble(0); |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 61 | private UpdaterState mUpdaterState = new UpdaterState(UpdaterState.IDLE); |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 62 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 63 | private AtomicBoolean mManualSwitchSlotRequired = new AtomicBoolean(true); |
| 64 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 65 | /** Synchronize state with engine status only once when app binds to UpdateEngine. */ |
| 66 | private AtomicBoolean mStateSynchronized = new AtomicBoolean(false); |
Zhomart Mukhamejanov | 51cde1e | 2018-05-31 12:19:41 -0700 | [diff] [blame] | 67 | |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 68 | @GuardedBy("mLock") |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 69 | private UpdateData mLastUpdateData = null; |
| 70 | |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 71 | @GuardedBy("mLock") |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 72 | private IntConsumer mOnStateChangeCallback = null; |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 73 | @GuardedBy("mLock") |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 74 | private IntConsumer mOnEngineStatusUpdateCallback = null; |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 75 | @GuardedBy("mLock") |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 76 | private DoubleConsumer mOnProgressUpdateCallback = null; |
Zhomart Mukhamejanov | f6522eb | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 77 | @GuardedBy("mLock") |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 78 | private IntConsumer mOnEngineCompleteCallback = null; |
| 79 | |
| 80 | private final Object mLock = new Object(); |
| 81 | |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 82 | private final UpdateManager.UpdateEngineCallbackImpl |
| 83 | mUpdateEngineCallback = new UpdateManager.UpdateEngineCallbackImpl(); |
| 84 | |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 85 | private final Handler mHandler; |
| 86 | |
| 87 | /** |
| 88 | * @param updateEngine UpdateEngine instance. |
| 89 | * @param handler Handler for {@link PrepareUpdateService} intent service. |
| 90 | */ |
| 91 | public UpdateManager(UpdateEngine updateEngine, Handler handler) { |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 92 | this.mUpdateEngine = updateEngine; |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 93 | this.mHandler = handler; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | /** |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 97 | * Binds to {@link UpdateEngine}. Invokes onStateChangeCallback if present. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 98 | */ |
| 99 | public void bind() { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 100 | getOnStateChangeCallback().ifPresent(callback -> callback.accept(mUpdaterState.get())); |
| 101 | |
| 102 | mStateSynchronized.set(false); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 103 | this.mUpdateEngine.bind(mUpdateEngineCallback); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * Unbinds from {@link UpdateEngine}. |
| 108 | */ |
| 109 | public void unbind() { |
| 110 | this.mUpdateEngine.unbind(); |
| 111 | } |
| 112 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 113 | public int getUpdaterState() { |
| 114 | return mUpdaterState.get(); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Returns true if manual switching slot is required. Value depends on |
| 119 | * the update config {@code ab_config.force_switch_slot}. |
| 120 | */ |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 121 | public boolean isManualSwitchSlotRequired() { |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 122 | return mManualSwitchSlotRequired.get(); |
| 123 | } |
| 124 | |
| 125 | /** |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 126 | * Sets SystemUpdaterSample app state change callback. Value of {@code state} will be one |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 127 | * of the values from {@link UpdaterState}. |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 128 | * |
| 129 | * @param onStateChangeCallback a callback with parameter {@code state}. |
| 130 | */ |
| 131 | public void setOnStateChangeCallback(IntConsumer onStateChangeCallback) { |
| 132 | synchronized (mLock) { |
| 133 | this.mOnStateChangeCallback = onStateChangeCallback; |
| 134 | } |
| 135 | } |
| 136 | |
| 137 | private Optional<IntConsumer> getOnStateChangeCallback() { |
| 138 | synchronized (mLock) { |
| 139 | return mOnStateChangeCallback == null |
| 140 | ? Optional.empty() |
| 141 | : Optional.of(mOnStateChangeCallback); |
| 142 | } |
| 143 | } |
| 144 | |
| 145 | /** |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 146 | * Sets update engine status update callback. Value of {@code status} will |
| 147 | * be one of the values from {@link UpdateEngine.UpdateStatusConstants}. |
| 148 | * |
| 149 | * @param onStatusUpdateCallback a callback with parameter {@code status}. |
| 150 | */ |
| 151 | public void setOnEngineStatusUpdateCallback(IntConsumer onStatusUpdateCallback) { |
| 152 | synchronized (mLock) { |
| 153 | this.mOnEngineStatusUpdateCallback = onStatusUpdateCallback; |
| 154 | } |
| 155 | } |
| 156 | |
| 157 | private Optional<IntConsumer> getOnEngineStatusUpdateCallback() { |
| 158 | synchronized (mLock) { |
| 159 | return mOnEngineStatusUpdateCallback == null |
| 160 | ? Optional.empty() |
| 161 | : Optional.of(mOnEngineStatusUpdateCallback); |
| 162 | } |
| 163 | } |
| 164 | |
| 165 | /** |
| 166 | * Sets update engine payload application complete callback. Value of {@code errorCode} will |
| 167 | * be one of the values from {@link UpdateEngine.ErrorCodeConstants}. |
| 168 | * |
| 169 | * @param onComplete a callback with parameter {@code errorCode}. |
| 170 | */ |
| 171 | public void setOnEngineCompleteCallback(IntConsumer onComplete) { |
| 172 | synchronized (mLock) { |
| 173 | this.mOnEngineCompleteCallback = onComplete; |
| 174 | } |
| 175 | } |
| 176 | |
| 177 | private Optional<IntConsumer> getOnEngineCompleteCallback() { |
| 178 | synchronized (mLock) { |
| 179 | return mOnEngineCompleteCallback == null |
| 180 | ? Optional.empty() |
| 181 | : Optional.of(mOnEngineCompleteCallback); |
| 182 | } |
| 183 | } |
| 184 | |
| 185 | /** |
| 186 | * Sets progress update callback. Progress is a number from {@code 0.0} to {@code 1.0}. |
| 187 | * |
| 188 | * @param onProgressCallback a callback with parameter {@code progress}. |
| 189 | */ |
| 190 | public void setOnProgressUpdateCallback(DoubleConsumer onProgressCallback) { |
| 191 | synchronized (mLock) { |
| 192 | this.mOnProgressUpdateCallback = onProgressCallback; |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | private Optional<DoubleConsumer> getOnProgressUpdateCallback() { |
| 197 | synchronized (mLock) { |
| 198 | return mOnProgressUpdateCallback == null |
| 199 | ? Optional.empty() |
| 200 | : Optional.of(mOnProgressUpdateCallback); |
| 201 | } |
| 202 | } |
| 203 | |
| 204 | /** |
Zhomart Mukhamejanov | 16db994 | 2018-05-31 10:47:09 -0700 | [diff] [blame] | 205 | * Suspend running update. |
| 206 | */ |
| 207 | public synchronized void suspend() throws UpdaterState.InvalidTransitionException { |
| 208 | Log.d(TAG, "suspend invoked"); |
| 209 | setUpdaterState(UpdaterState.PAUSED); |
| 210 | mUpdateEngine.cancel(); |
| 211 | } |
| 212 | |
| 213 | /** |
| 214 | * Resume suspended update. |
| 215 | */ |
| 216 | public synchronized void resume() throws UpdaterState.InvalidTransitionException { |
| 217 | Log.d(TAG, "resume invoked"); |
| 218 | setUpdaterState(UpdaterState.RUNNING); |
| 219 | updateEngineReApplyPayload(); |
| 220 | } |
| 221 | |
| 222 | /** |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 223 | * Updates {@link this.mState} and if state is changed, |
| 224 | * it also notifies {@link this.mOnStateChangeCallback}. |
| 225 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 226 | private void setUpdaterState(int newUpdaterState) |
| 227 | throws UpdaterState.InvalidTransitionException { |
| 228 | Log.d(TAG, "setUpdaterState invoked newState=" + newUpdaterState); |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 229 | int previousState = mUpdaterState.get(); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 230 | mUpdaterState.set(newUpdaterState); |
| 231 | if (previousState != newUpdaterState) { |
| 232 | getOnStateChangeCallback().ifPresent(callback -> callback.accept(newUpdaterState)); |
| 233 | } |
| 234 | } |
| 235 | |
| 236 | /** |
| 237 | * Same as {@link this.setUpdaterState}. Logs the error if new state |
| 238 | * cannot be set. |
| 239 | */ |
| 240 | private void setUpdaterStateSilent(int newUpdaterState) { |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 241 | try { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 242 | setUpdaterState(newUpdaterState); |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 243 | } catch (UpdaterState.InvalidTransitionException e) { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 244 | // Most likely UpdateEngine status and UpdaterSample state got de-synchronized. |
| 245 | // To make sample app simple, we don't handle it properly. |
| 246 | Log.e(TAG, "Failed to set updater state", e); |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 247 | } |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 248 | } |
| 249 | |
| 250 | /** |
| 251 | * Creates new UpdaterState, assigns it to {@link this.mUpdaterState}, |
| 252 | * and notifies callbacks. |
| 253 | */ |
| 254 | private void initializeUpdateState(int state) { |
| 255 | this.mUpdaterState = new UpdaterState(state); |
| 256 | getOnStateChangeCallback().ifPresent(callback -> callback.accept(state)); |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | /** |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 260 | * Requests update engine to stop any ongoing update. If an update has been applied, |
| 261 | * leave it as is. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 262 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 263 | public synchronized void cancelRunningUpdate() throws UpdaterState.InvalidTransitionException { |
| 264 | Log.d(TAG, "cancelRunningUpdate invoked"); |
| 265 | setUpdaterState(UpdaterState.IDLE); |
| 266 | mUpdateEngine.cancel(); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 267 | } |
| 268 | |
| 269 | /** |
| 270 | * Resets update engine to IDLE state. If an update has been applied it reverts it. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 271 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 272 | public synchronized void resetUpdate() throws UpdaterState.InvalidTransitionException { |
| 273 | Log.d(TAG, "resetUpdate invoked"); |
| 274 | setUpdaterState(UpdaterState.IDLE); |
| 275 | mUpdateEngine.resetStatus(); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 276 | } |
| 277 | |
| 278 | /** |
| 279 | * Applies the given update. |
| 280 | * |
| 281 | * <p>UpdateEngine works asynchronously. This method doesn't wait until |
| 282 | * end of the update.</p> |
| 283 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 284 | public synchronized void applyUpdate(Context context, UpdateConfig config) |
| 285 | throws UpdaterState.InvalidTransitionException { |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 286 | mEngineErrorCode.set(UpdateEngineErrorCodes.UNKNOWN); |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 287 | setUpdaterState(UpdaterState.RUNNING); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 288 | |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 289 | synchronized (mLock) { |
| 290 | // Cleaning up previous update data. |
| 291 | mLastUpdateData = null; |
| 292 | } |
| 293 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 294 | if (!config.getAbConfig().getForceSwitchSlot()) { |
| 295 | mManualSwitchSlotRequired.set(true); |
| 296 | } else { |
| 297 | mManualSwitchSlotRequired.set(false); |
| 298 | } |
| 299 | |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 300 | Log.d(TAG, "Starting PrepareUpdateService"); |
| 301 | PrepareUpdateService.startService(context, config, mHandler, (code, payloadSpec) -> { |
| 302 | if (code != PrepareUpdateService.RESULT_CODE_SUCCESS) { |
| 303 | Log.e(TAG, "PrepareUpdateService failed, result code is " + code); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 304 | setUpdaterStateSilent(UpdaterState.ERROR); |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 305 | return; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 306 | } |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 307 | updateEngineApplyPayload(UpdateData.builder() |
| 308 | .setExtraProperties(prepareExtraProperties(config)) |
| 309 | .setPayload(payloadSpec) |
| 310 | .build()); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 311 | }); |
| 312 | } |
| 313 | |
| 314 | private List<String> prepareExtraProperties(UpdateConfig config) { |
| 315 | List<String> extraProperties = new ArrayList<>(); |
| 316 | |
| 317 | if (!config.getAbConfig().getForceSwitchSlot()) { |
| 318 | // Disable switch slot on reboot, which is enabled by default. |
| 319 | // User will enable it manually by clicking "Switch Slot" button on the screen. |
| 320 | extraProperties.add(UpdateEngineProperties.PROPERTY_DISABLE_SWITCH_SLOT_ON_REBOOT); |
| 321 | } |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 322 | if (config.getInstallType() == UpdateConfig.AB_INSTALL_TYPE_STREAMING) { |
| 323 | extraProperties.add("USER_AGENT=" + HTTP_USER_AGENT); |
| 324 | config.getAbConfig() |
| 325 | .getAuthorization() |
| 326 | .ifPresent(s -> extraProperties.add("AUTHORIZATION=" + s)); |
| 327 | } |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 328 | return extraProperties; |
| 329 | } |
| 330 | |
| 331 | /** |
| 332 | * Applies given payload. |
| 333 | * |
| 334 | * <p>UpdateEngine works asynchronously. This method doesn't wait until |
| 335 | * end of the update.</p> |
| 336 | * |
| 337 | * <p>It's possible that the update engine throws a generic error, such as upon seeing invalid |
| 338 | * payload properties (which come from OTA packages), or failing to set up the network |
| 339 | * with the given id.</p> |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 340 | */ |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 341 | private void updateEngineApplyPayload(UpdateData update) { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 342 | Log.d(TAG, "updateEngineApplyPayload invoked with url " + update.mPayload.getUrl()); |
| 343 | |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 344 | synchronized (mLock) { |
| 345 | mLastUpdateData = update; |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 346 | } |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 347 | |
| 348 | ArrayList<String> properties = new ArrayList<>(update.getPayload().getProperties()); |
| 349 | properties.addAll(update.getExtraProperties()); |
| 350 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 351 | try { |
| 352 | mUpdateEngine.applyPayload( |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 353 | update.getPayload().getUrl(), |
| 354 | update.getPayload().getOffset(), |
| 355 | update.getPayload().getSize(), |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 356 | properties.toArray(new String[0])); |
| 357 | } catch (Exception e) { |
| 358 | Log.e(TAG, "UpdateEngine failed to apply the update", e); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 359 | setUpdaterStateSilent(UpdaterState.ERROR); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 360 | } |
| 361 | } |
| 362 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 363 | /** |
| 364 | * Re-applies {@link this.mLastUpdateData} to update_engine. |
| 365 | */ |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 366 | private void updateEngineReApplyPayload() { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 367 | Log.d(TAG, "updateEngineReApplyPayload invoked"); |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 368 | UpdateData lastUpdate; |
| 369 | synchronized (mLock) { |
| 370 | // mLastPayloadSpec might be empty in some cases. |
| 371 | // But to make this sample app simple, we will not handle it. |
| 372 | Preconditions.checkArgument( |
| 373 | mLastUpdateData != null, |
| 374 | "mLastUpdateData must be present."); |
| 375 | lastUpdate = mLastUpdateData; |
| 376 | } |
| 377 | updateEngineApplyPayload(lastUpdate); |
| 378 | } |
| 379 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 380 | /** |
| 381 | * Sets the new slot that has the updated partitions as the active slot, |
| 382 | * which device will boot into next time. |
| 383 | * This method is only supposed to be called after the payload is applied. |
| 384 | * |
| 385 | * Invoking {@link UpdateEngine#applyPayload} with the same payload url, offset, size |
| 386 | * and payload metadata headers doesn't trigger new update. It can be used to just switch |
| 387 | * active A/B slot. |
| 388 | * |
| 389 | * {@link UpdateEngine#applyPayload} might take several seconds to finish, and it will |
| 390 | * invoke callbacks {@link this#onStatusUpdate} and {@link this#onPayloadApplicationComplete)}. |
| 391 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 392 | public synchronized void setSwitchSlotOnReboot() { |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 393 | Log.d(TAG, "setSwitchSlotOnReboot invoked"); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 394 | |
| 395 | // When mManualSwitchSlotRequired set false, next time |
| 396 | // onApplicationPayloadComplete is called, |
| 397 | // it will set updater state to REBOOT_REQUIRED. |
| 398 | mManualSwitchSlotRequired.set(false); |
| 399 | |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 400 | UpdateData.Builder builder; |
| 401 | synchronized (mLock) { |
| 402 | // To make sample app simple, we don't handle it. |
| 403 | Preconditions.checkArgument( |
| 404 | mLastUpdateData != null, |
| 405 | "mLastUpdateData must be present."); |
| 406 | builder = mLastUpdateData.toBuilder(); |
| 407 | } |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 408 | // PROPERTY_SKIP_POST_INSTALL should be passed on to skip post-installation hooks. |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 409 | builder.setExtraProperties( |
| 410 | Collections.singletonList(UpdateEngineProperties.PROPERTY_SKIP_POST_INSTALL)); |
| 411 | // UpdateEngine sets property SWITCH_SLOT_ON_REBOOT=1 by default. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 412 | // HTTP headers are not required, UpdateEngine is not expected to stream payload. |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 413 | updateEngineApplyPayload(builder.build()); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 414 | } |
| 415 | |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 416 | /** |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 417 | * Synchronize UpdaterState with UpdateEngine status. |
| 418 | * Apply necessary UpdateEngine operation if status are out of sync. |
| 419 | * |
| 420 | * It's expected to be called once when sample app binds itself to UpdateEngine. |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 421 | */ |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 422 | private void synchronizeUpdaterStateWithUpdateEngineStatus() { |
| 423 | Log.d(TAG, "synchronizeUpdaterStateWithUpdateEngineStatus is invoked."); |
| 424 | |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 425 | int state = mUpdaterState.get(); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 426 | int engineStatus = mUpdateEngineStatus.get(); |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 427 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 428 | if (engineStatus == UpdateEngine.UpdateStatusConstants.UPDATED_NEED_REBOOT) { |
| 429 | // If update has been installed before running the sample app, |
| 430 | // set state to REBOOT_REQUIRED. |
| 431 | initializeUpdateState(UpdaterState.REBOOT_REQUIRED); |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 432 | return; |
| 433 | } |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 434 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 435 | switch (state) { |
| 436 | case UpdaterState.IDLE: |
| 437 | case UpdaterState.ERROR: |
| 438 | case UpdaterState.PAUSED: |
| 439 | case UpdaterState.SLOT_SWITCH_REQUIRED: |
| 440 | // It might happen when update is started not from the sample app. |
| 441 | // To make the sample app simple, we won't handle this case. |
| 442 | Preconditions.checkState( |
| 443 | engineStatus == UpdateEngine.UpdateStatusConstants.IDLE, |
| 444 | "When mUpdaterState is %s, mUpdateEngineStatus " |
| 445 | + "must be 0/IDLE, but it is %s", |
| 446 | state, |
| 447 | engineStatus); |
| 448 | break; |
| 449 | case UpdaterState.RUNNING: |
| 450 | if (engineStatus == UpdateEngine.UpdateStatusConstants.UPDATED_NEED_REBOOT |
| 451 | || engineStatus == UpdateEngine.UpdateStatusConstants.IDLE) { |
| 452 | Log.i(TAG, "ensureUpdateEngineStatusIsRunning - re-applying last payload"); |
| 453 | // Re-apply latest update. It makes update_engine to invoke |
| 454 | // onPayloadApplicationComplete callback. The callback notifies |
| 455 | // if update was successful or not. |
| 456 | updateEngineReApplyPayload(); |
| 457 | } |
| 458 | break; |
| 459 | case UpdaterState.REBOOT_REQUIRED: |
| 460 | // This might happen when update is installed by other means, |
| 461 | // and sample app is not aware of it. |
| 462 | // To make the sample app simple, we won't handle this case. |
| 463 | Preconditions.checkState( |
| 464 | engineStatus == UpdateEngine.UpdateStatusConstants.UPDATED_NEED_REBOOT, |
| 465 | "When mUpdaterState is %s, mUpdateEngineStatus " |
| 466 | + "must be 6/UPDATED_NEED_REBOOT, but it is %s", |
| 467 | state, |
| 468 | engineStatus); |
| 469 | break; |
| 470 | default: |
| 471 | throw new IllegalStateException("This block should not be reached."); |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 472 | } |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 473 | } |
| 474 | |
| 475 | /** |
| 476 | * Invoked by update_engine whenever update status or progress changes. |
| 477 | * It's also guaranteed to be invoked when app binds to the update_engine, except |
| 478 | * when update_engine fails to initialize (as defined in |
| 479 | * system/update_engine/binder_service_android.cc in |
| 480 | * function BinderUpdateEngineAndroidService::bind). |
| 481 | * |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 482 | * @param status one of {@link UpdateEngine.UpdateStatusConstants}. |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 483 | * @param progress a number from 0.0 to 1.0. |
| 484 | */ |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 485 | private void onStatusUpdate(int status, float progress) { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 486 | Log.d(TAG, String.format( |
Zhomart Mukhamejanov | bc07775 | 2018-12-14 09:36:32 -0800 | [diff] [blame] | 487 | "onStatusUpdate invoked, status=%s, progress=%.2f", |
| 488 | status, |
| 489 | progress)); |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 490 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 491 | int previousStatus = mUpdateEngineStatus.get(); |
| 492 | mUpdateEngineStatus.set(status); |
| 493 | mProgress.set(progress); |
| 494 | |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 495 | if (!mStateSynchronized.getAndSet(true)) { |
| 496 | // We synchronize state with engine status once |
| 497 | // only when sample app is bound to UpdateEngine. |
| 498 | synchronizeUpdaterStateWithUpdateEngineStatus(); |
Zhomart Mukhamejanov | 51cde1e | 2018-05-31 12:19:41 -0700 | [diff] [blame] | 499 | } |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 500 | |
Zhomart Mukhamejanov | 16db994 | 2018-05-31 10:47:09 -0700 | [diff] [blame] | 501 | getOnProgressUpdateCallback().ifPresent(callback -> callback.accept(mProgress.get())); |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 502 | |
| 503 | if (previousStatus != status) { |
| 504 | getOnEngineStatusUpdateCallback().ifPresent(callback -> callback.accept(status)); |
| 505 | } |
| 506 | } |
| 507 | |
| 508 | private void onPayloadApplicationComplete(int errorCode) { |
| 509 | Log.d(TAG, "onPayloadApplicationComplete invoked, errorCode=" + errorCode); |
| 510 | mEngineErrorCode.set(errorCode); |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 511 | if (errorCode == UpdateEngine.ErrorCodeConstants.SUCCESS |
| 512 | || errorCode == UpdateEngineErrorCodes.UPDATED_BUT_NOT_ACTIVE) { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 513 | setUpdaterStateSilent(isManualSwitchSlotRequired() |
Zhomart Mukhamejanov | 674aa6c | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 514 | ? UpdaterState.SLOT_SWITCH_REQUIRED |
| 515 | : UpdaterState.REBOOT_REQUIRED); |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 516 | } else if (errorCode != UpdateEngineErrorCodes.USER_CANCELLED) { |
Zhomart Mukhamejanov | 469b35a | 2018-06-01 12:41:20 -0700 | [diff] [blame] | 517 | setUpdaterStateSilent(UpdaterState.ERROR); |
Zhomart Mukhamejanov | 8f4059d | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 518 | } |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 519 | |
| 520 | getOnEngineCompleteCallback() |
| 521 | .ifPresent(callback -> callback.accept(errorCode)); |
| 522 | } |
| 523 | |
| 524 | /** |
Zhomart Mukhamejanov | 7671f68 | 2018-05-24 09:11:47 -0700 | [diff] [blame] | 525 | * Helper class to delegate {@code update_engine} callback invocations to UpdateManager. |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 526 | */ |
| 527 | class UpdateEngineCallbackImpl extends UpdateEngineCallback { |
| 528 | @Override |
| 529 | public void onStatusUpdate(int status, float percent) { |
| 530 | UpdateManager.this.onStatusUpdate(status, percent); |
| 531 | } |
| 532 | |
| 533 | @Override |
| 534 | public void onPayloadApplicationComplete(int errorCode) { |
| 535 | UpdateManager.this.onPayloadApplicationComplete(errorCode); |
| 536 | } |
| 537 | } |
| 538 | |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 539 | /** |
Zhomart Mukhamejanov | b34f7ea | 2018-05-25 17:00:11 -0700 | [diff] [blame] | 540 | * Contains update data - PayloadSpec and extra properties list. |
| 541 | * |
| 542 | * <p>{@code mPayload} contains url, offset and size to {@code PAYLOAD_BINARY_FILE_NAME}. |
| 543 | * {@code mExtraProperties} is a list of additional properties to pass to |
| 544 | * {@link UpdateEngine#applyPayload}.</p> |
| 545 | */ |
| 546 | private static class UpdateData { |
| 547 | private final PayloadSpec mPayload; |
| 548 | private final ImmutableList<String> mExtraProperties; |
| 549 | |
| 550 | public static Builder builder() { |
| 551 | return new Builder(); |
| 552 | } |
| 553 | |
| 554 | UpdateData(Builder builder) { |
| 555 | this.mPayload = builder.mPayload; |
| 556 | this.mExtraProperties = ImmutableList.copyOf(builder.mExtraProperties); |
| 557 | } |
| 558 | |
| 559 | public PayloadSpec getPayload() { |
| 560 | return mPayload; |
| 561 | } |
| 562 | |
| 563 | public ImmutableList<String> getExtraProperties() { |
| 564 | return mExtraProperties; |
| 565 | } |
| 566 | |
| 567 | public Builder toBuilder() { |
| 568 | return builder() |
| 569 | .setPayload(mPayload) |
| 570 | .setExtraProperties(mExtraProperties); |
| 571 | } |
| 572 | |
| 573 | static class Builder { |
| 574 | private PayloadSpec mPayload; |
| 575 | private List<String> mExtraProperties; |
| 576 | |
| 577 | public Builder setPayload(PayloadSpec payload) { |
| 578 | this.mPayload = payload; |
| 579 | return this; |
| 580 | } |
| 581 | |
| 582 | public Builder setExtraProperties(List<String> extraProperties) { |
| 583 | this.mExtraProperties = new ArrayList<>(extraProperties); |
| 584 | return this; |
| 585 | } |
| 586 | |
| 587 | public Builder addExtraProperty(String property) { |
| 588 | if (this.mExtraProperties == null) { |
| 589 | this.mExtraProperties = new ArrayList<>(); |
| 590 | } |
| 591 | this.mExtraProperties.add(property); |
| 592 | return this; |
| 593 | } |
| 594 | |
| 595 | public UpdateData build() { |
| 596 | return new UpdateData(this); |
| 597 | } |
| 598 | } |
| 599 | } |
| 600 | |
Zhomart Mukhamejanov | 6f26e71 | 2018-05-18 10:15:31 -0700 | [diff] [blame] | 601 | } |