blob: 0562c5535a13ea34fd755cc63f7a40f3ba152cf5 [file] [log] [blame]
Christopher Tate487529a2009-04-29 14:03:25 -07001/*
2 * Copyright (C) 2009 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
17package com.android.server;
18
Christopher Tate181fafa2009-05-14 11:12:14 -070019import android.app.ActivityManagerNative;
Christopher Tateb6787f22009-07-02 17:40:45 -070020import android.app.AlarmManager;
Christopher Tate181fafa2009-05-14 11:12:14 -070021import android.app.IActivityManager;
22import android.app.IApplicationThread;
23import android.app.IBackupAgent;
Christopher Tateb6787f22009-07-02 17:40:45 -070024import android.app.PendingIntent;
Oscar Montemayora8529f62009-11-18 10:14:20 -080025import android.backup.IBackupManager;
26import android.backup.IRestoreObserver;
27import android.backup.IRestoreSession;
28import android.backup.RestoreSet;
Christopher Tate3799bc22009-05-06 16:13:56 -070029import android.content.BroadcastReceiver;
Dan Egnor87a02bc2009-06-17 02:30:10 -070030import android.content.ComponentName;
Christopher Tate487529a2009-04-29 14:03:25 -070031import android.content.Context;
32import android.content.Intent;
Christopher Tate3799bc22009-05-06 16:13:56 -070033import android.content.IntentFilter;
Dan Egnor87a02bc2009-06-17 02:30:10 -070034import android.content.ServiceConnection;
Christopher Tate181fafa2009-05-14 11:12:14 -070035import android.content.pm.ApplicationInfo;
Christopher Tatec7b31e32009-06-10 15:49:30 -070036import android.content.pm.IPackageDataObserver;
Christopher Tate7b881282009-06-07 13:52:37 -070037import android.content.pm.PackageInfo;
Dan Egnor87a02bc2009-06-17 02:30:10 -070038import android.content.pm.PackageManager;
Christopher Tateabce4e82009-06-18 18:35:32 -070039import android.content.pm.Signature;
Oscar Montemayora8529f62009-11-18 10:14:20 -080040import android.content.pm.PackageManager.NameNotFoundException;
Christopher Tate3799bc22009-05-06 16:13:56 -070041import android.net.Uri;
Christopher Tate487529a2009-04-29 14:03:25 -070042import android.os.Binder;
Christopher Tate3799bc22009-05-06 16:13:56 -070043import android.os.Bundle;
Christopher Tate22b87872009-05-04 16:41:53 -070044import android.os.Environment;
Christopher Tate487529a2009-04-29 14:03:25 -070045import android.os.Handler;
Christopher Tate44a27902010-01-27 17:15:49 -080046import android.os.HandlerThread;
Christopher Tate487529a2009-04-29 14:03:25 -070047import android.os.IBinder;
Christopher Tate44a27902010-01-27 17:15:49 -080048import android.os.Looper;
Christopher Tate487529a2009-04-29 14:03:25 -070049import android.os.Message;
Christopher Tate22b87872009-05-04 16:41:53 -070050import android.os.ParcelFileDescriptor;
Christopher Tateb6787f22009-07-02 17:40:45 -070051import android.os.PowerManager;
Christopher Tate043dadc2009-06-02 16:11:00 -070052import android.os.Process;
Christopher Tate487529a2009-04-29 14:03:25 -070053import android.os.RemoteException;
Dan Egnorbb9001c2009-07-27 12:20:13 -070054import android.os.SystemClock;
Oscar Montemayora8529f62009-11-18 10:14:20 -080055import android.provider.Settings;
Dan Egnorbb9001c2009-07-27 12:20:13 -070056import android.util.EventLog;
Christopher Tate487529a2009-04-29 14:03:25 -070057import android.util.Log;
58import android.util.SparseArray;
Christopher Tate44a27902010-01-27 17:15:49 -080059import android.util.SparseIntArray;
Christopher Tate487529a2009-04-29 14:03:25 -070060
Christopher Tated55e18a2009-09-21 10:12:59 -070061import com.android.internal.backup.BackupConstants;
Christopher Tate043dadc2009-06-02 16:11:00 -070062import com.android.internal.backup.IBackupTransport;
Oscar Montemayora8529f62009-11-18 10:14:20 -080063import com.android.internal.backup.LocalTransport;
Christopher Tate6aa41f42009-06-19 14:14:22 -070064import com.android.server.PackageManagerBackupAgent.Metadata;
Christopher Tate6785dd82009-06-18 15:58:25 -070065
Christopher Tatecde87f42009-06-12 12:55:53 -070066import java.io.EOFException;
Christopher Tate22b87872009-05-04 16:41:53 -070067import java.io.File;
Joe Onoratob1a7ffe2009-05-06 18:06:21 -070068import java.io.FileDescriptor;
Christopher Tate4cc86e12009-09-21 19:36:51 -070069import java.io.FileOutputStream;
Christopher Tatec7b31e32009-06-10 15:49:30 -070070import java.io.IOException;
Joe Onoratob1a7ffe2009-05-06 18:06:21 -070071import java.io.PrintWriter;
Christopher Tatecde87f42009-06-12 12:55:53 -070072import java.io.RandomAccessFile;
Joe Onorato8ad02812009-05-13 01:41:44 -040073import java.util.ArrayList;
74import java.util.HashMap;
Christopher Tate487529a2009-04-29 14:03:25 -070075import java.util.HashSet;
76import java.util.List;
Christopher Tate91717492009-06-26 21:07:13 -070077import java.util.Map;
Dan Egnorc1c49c02009-10-30 17:35:39 -070078import java.util.Random;
Christopher Tate487529a2009-04-29 14:03:25 -070079
80class BackupManagerService extends IBackupManager.Stub {
81 private static final String TAG = "BackupManagerService";
Christopher Tate13f4a642009-09-30 20:06:45 -070082 private static final boolean DEBUG = false;
Christopher Tateaa088442009-06-16 18:25:46 -070083
Christopher Tate49401dd2009-07-01 12:34:29 -070084 // How often we perform a backup pass. Privileged external callers can
85 // trigger an immediate pass.
Christopher Tateb6787f22009-07-02 17:40:45 -070086 private static final long BACKUP_INTERVAL = AlarmManager.INTERVAL_HOUR;
Christopher Tate487529a2009-04-29 14:03:25 -070087
Dan Egnorc1c49c02009-10-30 17:35:39 -070088 // Random variation in backup scheduling time to avoid server load spikes
89 private static final int FUZZ_MILLIS = 5 * 60 * 1000;
90
Christopher Tate8031a3d2009-07-06 16:36:05 -070091 // The amount of time between the initial provisioning of the device and
92 // the first backup pass.
93 private static final long FIRST_BACKUP_INTERVAL = 12 * AlarmManager.INTERVAL_HOUR;
94
Christopher Tate4cc86e12009-09-21 19:36:51 -070095 private static final String RUN_BACKUP_ACTION = "android.backup.intent.RUN";
96 private static final String RUN_INITIALIZE_ACTION = "android.backup.intent.INIT";
97 private static final String RUN_CLEAR_ACTION = "android.backup.intent.CLEAR";
Christopher Tate487529a2009-04-29 14:03:25 -070098 private static final int MSG_RUN_BACKUP = 1;
Christopher Tate043dadc2009-06-02 16:11:00 -070099 private static final int MSG_RUN_FULL_BACKUP = 2;
Christopher Tate9bbc21a2009-06-10 20:23:25 -0700100 private static final int MSG_RUN_RESTORE = 3;
Christopher Tateee0e78a2009-07-02 11:17:03 -0700101 private static final int MSG_RUN_CLEAR = 4;
Christopher Tate4cc86e12009-09-21 19:36:51 -0700102 private static final int MSG_RUN_INITIALIZE = 5;
Christopher Tate44a27902010-01-27 17:15:49 -0800103 private static final int MSG_TIMEOUT = 6;
Christopher Tatec7b31e32009-06-10 15:49:30 -0700104
105 // Timeout interval for deciding that a bind or clear-data has taken too long
106 static final long TIMEOUT_INTERVAL = 10 * 1000;
107
Christopher Tate44a27902010-01-27 17:15:49 -0800108 // Timeout intervals for agent backup & restore operations
109 static final long TIMEOUT_BACKUP_INTERVAL = 30 * 1000;
110 static final long TIMEOUT_RESTORE_INTERVAL = 60 * 1000;
111
Christopher Tate487529a2009-04-29 14:03:25 -0700112 private Context mContext;
113 private PackageManager mPackageManager;
Christopher Tate6ef58a12009-06-29 14:56:28 -0700114 private IActivityManager mActivityManager;
Christopher Tateb6787f22009-07-02 17:40:45 -0700115 private PowerManager mPowerManager;
116 private AlarmManager mAlarmManager;
Christopher Tate44a27902010-01-27 17:15:49 -0800117 IBackupManager mBackupManagerBinder;
Christopher Tateb6787f22009-07-02 17:40:45 -0700118
Christopher Tate73e02522009-07-15 14:18:26 -0700119 boolean mEnabled; // access to this is synchronized on 'this'
120 boolean mProvisioned;
121 PowerManager.WakeLock mWakelock;
Christopher Tate44a27902010-01-27 17:15:49 -0800122 HandlerThread mHandlerThread = new HandlerThread("backup", Process.THREAD_PRIORITY_BACKGROUND);
123 BackupHandler mBackupHandler;
Christopher Tate4cc86e12009-09-21 19:36:51 -0700124 PendingIntent mRunBackupIntent, mRunInitIntent;
125 BroadcastReceiver mRunBackupReceiver, mRunInitReceiver;
Christopher Tate487529a2009-04-29 14:03:25 -0700126 // map UIDs to the set of backup client services within that UID's app set
Christopher Tate73e02522009-07-15 14:18:26 -0700127 final SparseArray<HashSet<ApplicationInfo>> mBackupParticipants
Christopher Tate181fafa2009-05-14 11:12:14 -0700128 = new SparseArray<HashSet<ApplicationInfo>>();
Christopher Tate487529a2009-04-29 14:03:25 -0700129 // set of backup services that have pending changes
Christopher Tate73e02522009-07-15 14:18:26 -0700130 class BackupRequest {
Christopher Tate181fafa2009-05-14 11:12:14 -0700131 public ApplicationInfo appInfo;
Christopher Tate46758122009-05-06 11:22:00 -0700132 public boolean fullBackup;
Christopher Tateaa088442009-06-16 18:25:46 -0700133
Christopher Tate181fafa2009-05-14 11:12:14 -0700134 BackupRequest(ApplicationInfo app, boolean isFull) {
135 appInfo = app;
Christopher Tate46758122009-05-06 11:22:00 -0700136 fullBackup = isFull;
137 }
Christopher Tate181fafa2009-05-14 11:12:14 -0700138
139 public String toString() {
140 return "BackupRequest{app=" + appInfo + " full=" + fullBackup + "}";
141 }
Christopher Tate46758122009-05-06 11:22:00 -0700142 }
Joe Onorato8ad02812009-05-13 01:41:44 -0400143 // Backups that we haven't started yet.
Christopher Tate73e02522009-07-15 14:18:26 -0700144 HashMap<ApplicationInfo,BackupRequest> mPendingBackups
Christopher Tate181fafa2009-05-14 11:12:14 -0700145 = new HashMap<ApplicationInfo,BackupRequest>();
Christopher Tate5cb400b2009-06-25 16:03:14 -0700146
147 // Pseudoname that we use for the Package Manager metadata "package"
Christopher Tate73e02522009-07-15 14:18:26 -0700148 static final String PACKAGE_MANAGER_SENTINEL = "@pm@";
Christopher Tate6aa41f42009-06-19 14:14:22 -0700149
150 // locking around the pending-backup management
Christopher Tate73e02522009-07-15 14:18:26 -0700151 final Object mQueueLock = new Object();
Christopher Tate487529a2009-04-29 14:03:25 -0700152
Christopher Tate043dadc2009-06-02 16:11:00 -0700153 // The thread performing the sequence of queued backups binds to each app's agent
154 // in succession. Bind notifications are asynchronously delivered through the
155 // Activity Manager; use this lock object to signal when a requested binding has
156 // completed.
Christopher Tate73e02522009-07-15 14:18:26 -0700157 final Object mAgentConnectLock = new Object();
158 IBackupAgent mConnectedAgent;
159 volatile boolean mConnecting;
Christopher Tate55f931a2009-09-29 17:17:34 -0700160 volatile long mLastBackupPass;
161 volatile long mNextBackupPass;
Christopher Tate043dadc2009-06-02 16:11:00 -0700162
Christopher Tate55f931a2009-09-29 17:17:34 -0700163 // A similar synchronization mechanism around clearing apps' data for restore
Christopher Tate73e02522009-07-15 14:18:26 -0700164 final Object mClearDataLock = new Object();
165 volatile boolean mClearingData;
Christopher Tatec7b31e32009-06-10 15:49:30 -0700166
Christopher Tate91717492009-06-26 21:07:13 -0700167 // Transport bookkeeping
Christopher Tate73e02522009-07-15 14:18:26 -0700168 final HashMap<String,IBackupTransport> mTransports
Christopher Tate91717492009-06-26 21:07:13 -0700169 = new HashMap<String,IBackupTransport>();
Christopher Tate73e02522009-07-15 14:18:26 -0700170 String mCurrentTransport;
171 IBackupTransport mLocalTransport, mGoogleTransport;
Christopher Tate80202c82010-01-25 19:37:47 -0800172 ActiveRestoreSession mActiveRestoreSession;
Christopher Tate043dadc2009-06-02 16:11:00 -0700173
Christopher Tate73e02522009-07-15 14:18:26 -0700174 class RestoreParams {
Christopher Tate7d562ec2009-06-25 18:03:43 -0700175 public IBackupTransport transport;
176 public IRestoreObserver observer;
Dan Egnor156411d2009-06-26 13:20:02 -0700177 public long token;
Christopher Tate7d562ec2009-06-25 18:03:43 -0700178
Dan Egnor156411d2009-06-26 13:20:02 -0700179 RestoreParams(IBackupTransport _transport, IRestoreObserver _obs, long _token) {
Christopher Tate7d562ec2009-06-25 18:03:43 -0700180 transport = _transport;
181 observer = _obs;
Dan Egnor156411d2009-06-26 13:20:02 -0700182 token = _token;
Christopher Tate7d562ec2009-06-25 18:03:43 -0700183 }
184 }
185
Christopher Tate73e02522009-07-15 14:18:26 -0700186 class ClearParams {
Christopher Tateee0e78a2009-07-02 11:17:03 -0700187 public IBackupTransport transport;
188 public PackageInfo packageInfo;
189
190 ClearParams(IBackupTransport _transport, PackageInfo _info) {
191 transport = _transport;
192 packageInfo = _info;
193 }
194 }
195
Christopher Tate44a27902010-01-27 17:15:49 -0800196 // Bookkeeping of in-flight operations for timeout etc. purposes. The operation
197 // token is the index of the entry in the pending-operations list.
198 static final int OP_PENDING = 0;
199 static final int OP_ACKNOWLEDGED = 1;
200 static final int OP_TIMEOUT = -1;
201
202 final SparseIntArray mCurrentOperations = new SparseIntArray();
203 final Object mCurrentOpLock = new Object();
204 final Random mTokenGenerator = new Random();
205
Christopher Tate5cb400b2009-06-25 16:03:14 -0700206 // Where we keep our journal files and other bookkeeping
Christopher Tate73e02522009-07-15 14:18:26 -0700207 File mBaseStateDir;
208 File mDataDir;
209 File mJournalDir;
210 File mJournal;
Christopher Tate73e02522009-07-15 14:18:26 -0700211
212 // Keep a log of all the apps we've ever backed up
213 private File mEverStored;
Christopher Tate73e02522009-07-15 14:18:26 -0700214 HashSet<String> mEverStoredApps = new HashSet<String>();
215
Christopher Tate4cc86e12009-09-21 19:36:51 -0700216 // Persistently track the need to do a full init
217 static final String INIT_SENTINEL_FILE_NAME = "_need_init_";
218 HashSet<String> mPendingInits = new HashSet<String>(); // transport names
Christopher Tateaa088442009-06-16 18:25:46 -0700219
Christopher Tate44a27902010-01-27 17:15:49 -0800220 // ----- Asynchronous backup/restore handler thread -----
221
222 private class BackupHandler extends Handler {
223 public BackupHandler(Looper looper) {
224 super(looper);
225 }
226
227 public void handleMessage(Message msg) {
228
229 switch (msg.what) {
230 case MSG_RUN_BACKUP:
231 {
232 mLastBackupPass = System.currentTimeMillis();
233 mNextBackupPass = mLastBackupPass + BACKUP_INTERVAL;
234
235 IBackupTransport transport = getTransport(mCurrentTransport);
236 if (transport == null) {
237 Log.v(TAG, "Backup requested but no transport available");
Christopher Tate44a27902010-01-27 17:15:49 -0800238 mWakelock.release();
239 break;
240 }
241
242 // snapshot the pending-backup set and work on that
243 ArrayList<BackupRequest> queue = new ArrayList<BackupRequest>();
244 synchronized (mQueueLock) {
245 // Do we have any work to do?
246 if (mPendingBackups.size() > 0) {
247 for (BackupRequest b: mPendingBackups.values()) {
248 queue.add(b);
249 }
250 if (DEBUG) Log.v(TAG, "clearing pending backups");
251 mPendingBackups.clear();
252
253 // Start a new backup-queue journal file too
254 File oldJournal = mJournal;
255 mJournal = null;
256
257 // At this point, we have started a new journal file, and the old
258 // file identity is being passed to the backup processing thread.
259 // When it completes successfully, that old journal file will be
260 // deleted. If we crash prior to that, the old journal is parsed
261 // at next boot and the journaled requests fulfilled.
262 (new PerformBackupTask(transport, queue, oldJournal)).run();
263 } else {
264 Log.v(TAG, "Backup requested but nothing pending");
Christopher Tate44a27902010-01-27 17:15:49 -0800265 mWakelock.release();
266 }
267 }
268 break;
269 }
270
271 case MSG_RUN_FULL_BACKUP:
272 break;
273
274 case MSG_RUN_RESTORE:
275 {
276 RestoreParams params = (RestoreParams)msg.obj;
277 Log.d(TAG, "MSG_RUN_RESTORE observer=" + params.observer);
278 (new PerformRestoreTask(params.transport, params.observer,
279 params.token)).run();
280 break;
281 }
282
283 case MSG_RUN_CLEAR:
284 {
285 ClearParams params = (ClearParams)msg.obj;
286 (new PerformClearTask(params.transport, params.packageInfo)).run();
287 break;
288 }
289
290 case MSG_RUN_INITIALIZE:
291 {
292 HashSet<String> queue;
293
294 // Snapshot the pending-init queue and work on that
295 synchronized (mQueueLock) {
296 queue = new HashSet<String>(mPendingInits);
297 mPendingInits.clear();
298 }
299
300 (new PerformInitializeTask(queue)).run();
301 break;
302 }
303
304 case MSG_TIMEOUT:
305 {
306 synchronized (mCurrentOpLock) {
307 final int token = msg.arg1;
308 int state = mCurrentOperations.get(token, OP_TIMEOUT);
309 if (state == OP_PENDING) {
310 if (DEBUG) Log.v(TAG, "TIMEOUT: token=" + token);
311 mCurrentOperations.put(token, OP_TIMEOUT);
312 }
313 mCurrentOpLock.notifyAll();
314 }
315 break;
316 }
317 }
318 }
319 }
320
321 // ----- Main service implementation -----
322
Christopher Tate487529a2009-04-29 14:03:25 -0700323 public BackupManagerService(Context context) {
324 mContext = context;
325 mPackageManager = context.getPackageManager();
Christopher Tate181fafa2009-05-14 11:12:14 -0700326 mActivityManager = ActivityManagerNative.getDefault();
Christopher Tate487529a2009-04-29 14:03:25 -0700327
Christopher Tateb6787f22009-07-02 17:40:45 -0700328 mAlarmManager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE);
329 mPowerManager = (PowerManager) context.getSystemService(Context.POWER_SERVICE);
330
Christopher Tate44a27902010-01-27 17:15:49 -0800331 mBackupManagerBinder = asInterface(asBinder());
332
333 // spin up the backup/restore handler thread
334 mHandlerThread = new HandlerThread("backup", Process.THREAD_PRIORITY_BACKGROUND);
335 mHandlerThread.start();
336 mBackupHandler = new BackupHandler(mHandlerThread.getLooper());
337
Christopher Tate22b87872009-05-04 16:41:53 -0700338 // Set up our bookkeeping
Christopher Tateb6787f22009-07-02 17:40:45 -0700339 boolean areEnabled = Settings.Secure.getInt(context.getContentResolver(),
Dianne Hackborncf098292009-07-01 19:55:20 -0700340 Settings.Secure.BACKUP_ENABLED, 0) != 0;
Christopher Tate8031a3d2009-07-06 16:36:05 -0700341 mProvisioned = Settings.Secure.getInt(context.getContentResolver(),
Joe Onoratoab9a2a52009-07-27 08:56:39 -0700342 Settings.Secure.BACKUP_PROVISIONED, 0) != 0;
Oscar Montemayora8529f62009-11-18 10:14:20 -0800343 // If Encrypted file systems is enabled or disabled, this call will return the
344 // correct directory.
345 mBaseStateDir = new File(Environment.getSecureDataDirectory(), "backup");
346 mBaseStateDir.mkdirs();
Christopher Tatef4172472009-05-05 15:50:03 -0700347 mDataDir = Environment.getDownloadCacheDirectory();
Christopher Tate9bbc21a2009-06-10 20:23:25 -0700348
Christopher Tate4cc86e12009-09-21 19:36:51 -0700349 // Alarm receivers for scheduled backups & initialization operations
Christopher Tateb6787f22009-07-02 17:40:45 -0700350 mRunBackupReceiver = new RunBackupReceiver();
Christopher Tate4cc86e12009-09-21 19:36:51 -0700351 IntentFilter filter = new IntentFilter();
352 filter.addAction(RUN_BACKUP_ACTION);
353 context.registerReceiver(mRunBackupReceiver, filter,
354 android.Manifest.permission.BACKUP, null);
355
356 mRunInitReceiver = new RunInitializeReceiver();
357 filter = new IntentFilter();
358 filter.addAction(RUN_INITIALIZE_ACTION);
359 context.registerReceiver(mRunInitReceiver, filter,
360 android.Manifest.permission.BACKUP, null);
Christopher Tateb6787f22009-07-02 17:40:45 -0700361
362 Intent backupIntent = new Intent(RUN_BACKUP_ACTION);
Christopher Tateb6787f22009-07-02 17:40:45 -0700363 backupIntent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
364 mRunBackupIntent = PendingIntent.getBroadcast(context, MSG_RUN_BACKUP, backupIntent, 0);
365
Christopher Tate4cc86e12009-09-21 19:36:51 -0700366 Intent initIntent = new Intent(RUN_INITIALIZE_ACTION);
367 backupIntent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
368 mRunInitIntent = PendingIntent.getBroadcast(context, MSG_RUN_INITIALIZE, initIntent, 0);
369
Christopher Tatecde87f42009-06-12 12:55:53 -0700370 // Set up the backup-request journaling
Christopher Tate5cb400b2009-06-25 16:03:14 -0700371 mJournalDir = new File(mBaseStateDir, "pending");
372 mJournalDir.mkdirs(); // creates mBaseStateDir along the way
Dan Egnor852f8e42009-09-30 11:20:45 -0700373 mJournal = null; // will be created on first use
Christopher Tatecde87f42009-06-12 12:55:53 -0700374
Christopher Tate73e02522009-07-15 14:18:26 -0700375 // Set up the various sorts of package tracking we do
376 initPackageTracking();
377
Christopher Tateabce4e82009-06-18 18:35:32 -0700378 // Build our mapping of uid to backup client services. This implicitly
379 // schedules a backup pass on the Package Manager metadata the first
380 // time anything needs to be backed up.
Christopher Tate3799bc22009-05-06 16:13:56 -0700381 synchronized (mBackupParticipants) {
382 addPackageParticipantsLocked(null);
Christopher Tate487529a2009-04-29 14:03:25 -0700383 }
384
Dan Egnor87a02bc2009-06-17 02:30:10 -0700385 // Set up our transport options and initialize the default transport
386 // TODO: Have transports register themselves somehow?
387 // TODO: Don't create transports that we don't need to?
Dan Egnor87a02bc2009-06-17 02:30:10 -0700388 mLocalTransport = new LocalTransport(context); // This is actually pretty cheap
Christopher Tate91717492009-06-26 21:07:13 -0700389 ComponentName localName = new ComponentName(context, LocalTransport.class);
390 registerTransport(localName.flattenToShortString(), mLocalTransport);
Dan Egnor87a02bc2009-06-17 02:30:10 -0700391
Christopher Tate91717492009-06-26 21:07:13 -0700392 mGoogleTransport = null;
Dianne Hackborncf098292009-07-01 19:55:20 -0700393 mCurrentTransport = Settings.Secure.getString(context.getContentResolver(),
394 Settings.Secure.BACKUP_TRANSPORT);
395 if ("".equals(mCurrentTransport)) {
396 mCurrentTransport = null;
Christopher Tatece0bf062009-07-01 11:43:53 -0700397 }
Christopher Tate91717492009-06-26 21:07:13 -0700398 if (DEBUG) Log.v(TAG, "Starting with transport " + mCurrentTransport);
399
400 // Attach to the Google backup transport. When this comes up, it will set
401 // itself as the current transport because we explicitly reset mCurrentTransport
402 // to null.
Dan Egnor87a02bc2009-06-17 02:30:10 -0700403 Intent intent = new Intent().setComponent(new ComponentName(
404 "com.google.android.backup",
405 "com.google.android.backup.BackupTransportService"));
406 context.bindService(intent, mGoogleConnection, Context.BIND_AUTO_CREATE);
Christopher Tateaa088442009-06-16 18:25:46 -0700407
Christopher Tatecde87f42009-06-12 12:55:53 -0700408 // Now that we know about valid backup participants, parse any
Christopher Tate49401dd2009-07-01 12:34:29 -0700409 // leftover journal files into the pending backup set
Christopher Tatecde87f42009-06-12 12:55:53 -0700410 parseLeftoverJournals();
411
Christopher Tateb6787f22009-07-02 17:40:45 -0700412 // Power management
413 mWakelock = mPowerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "backup");
414
415 // Start the backup passes going
416 setBackupEnabled(areEnabled);
417 }
418
419 private class RunBackupReceiver extends BroadcastReceiver {
420 public void onReceive(Context context, Intent intent) {
421 if (RUN_BACKUP_ACTION.equals(intent.getAction())) {
Christopher Tateb6787f22009-07-02 17:40:45 -0700422 synchronized (mQueueLock) {
Christopher Tate4cc86e12009-09-21 19:36:51 -0700423 if (mPendingInits.size() > 0) {
424 // If there are pending init operations, we process those
425 // and then settle into the usual periodic backup schedule.
426 if (DEBUG) Log.v(TAG, "Init pending at scheduled backup");
427 try {
428 mAlarmManager.cancel(mRunInitIntent);
429 mRunInitIntent.send();
430 } catch (PendingIntent.CanceledException ce) {
431 Log.e(TAG, "Run init intent cancelled");
432 // can't really do more than bail here
433 }
434 } else {
Christopher Tatec2af5d32010-02-02 15:18:58 -0800435 // Don't run backups now if we're disabled or not yet
436 // fully set up.
437 if (mEnabled && mProvisioned) {
Christopher Tate4cc86e12009-09-21 19:36:51 -0700438 if (DEBUG) Log.v(TAG, "Running a backup pass");
439
440 // Acquire the wakelock and pass it to the backup thread. it will
441 // be released once backup concludes.
442 mWakelock.acquire();
443
444 Message msg = mBackupHandler.obtainMessage(MSG_RUN_BACKUP);
445 mBackupHandler.sendMessage(msg);
446 } else {
Christopher Tatec2af5d32010-02-02 15:18:58 -0800447 Log.w(TAG, "Backup pass but e=" + mEnabled + " p=" + mProvisioned);
Christopher Tate4cc86e12009-09-21 19:36:51 -0700448 }
449 }
450 }
451 }
452 }
453 }
454
455 private class RunInitializeReceiver extends BroadcastReceiver {
456 public void onReceive(Context context, Intent intent) {
457 if (RUN_INITIALIZE_ACTION.equals(intent.getAction())) {
458 synchronized (mQueueLock) {
459 if (DEBUG) Log.v(TAG, "Running a device init");
Christopher Tate4cc86e12009-09-21 19:36:51 -0700460
461 // Acquire the wakelock and pass it to the init thread. it will
462 // be released once init concludes.
Christopher Tateb6787f22009-07-02 17:40:45 -0700463 mWakelock.acquire();
464
Christopher Tate4cc86e12009-09-21 19:36:51 -0700465 Message msg = mBackupHandler.obtainMessage(MSG_RUN_INITIALIZE);
Christopher Tateb6787f22009-07-02 17:40:45 -0700466 mBackupHandler.sendMessage(msg);
467 }
468 }
Christopher Tate49401dd2009-07-01 12:34:29 -0700469 }
Christopher Tateb6787f22009-07-02 17:40:45 -0700470 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700471
Christopher Tate73e02522009-07-15 14:18:26 -0700472 private void initPackageTracking() {
473 if (DEBUG) Log.v(TAG, "Initializing package tracking");
474
Christopher Tatee97e8072009-07-15 16:45:50 -0700475 // Keep a log of what apps we've ever backed up. Because we might have
476 // rebooted in the middle of an operation that was removing something from
477 // this log, we sanity-check its contents here and reconstruct it.
Christopher Tate73e02522009-07-15 14:18:26 -0700478 mEverStored = new File(mBaseStateDir, "processed");
Christopher Tatee97e8072009-07-15 16:45:50 -0700479 File tempProcessedFile = new File(mBaseStateDir, "processed.new");
Christopher Tate73e02522009-07-15 14:18:26 -0700480
Christopher Tatee97e8072009-07-15 16:45:50 -0700481 // If we were in the middle of removing something from the ever-backed-up
482 // file, there might be a transient "processed.new" file still present.
Dan Egnor852f8e42009-09-30 11:20:45 -0700483 // Ignore it -- we'll validate "processed" against the current package set.
Christopher Tatee97e8072009-07-15 16:45:50 -0700484 if (tempProcessedFile.exists()) {
485 tempProcessedFile.delete();
486 }
487
Dan Egnor852f8e42009-09-30 11:20:45 -0700488 // If there are previous contents, parse them out then start a new
489 // file to continue the recordkeeping.
490 if (mEverStored.exists()) {
491 RandomAccessFile temp = null;
492 RandomAccessFile in = null;
493
494 try {
495 temp = new RandomAccessFile(tempProcessedFile, "rws");
496 in = new RandomAccessFile(mEverStored, "r");
497
498 while (true) {
499 PackageInfo info;
500 String pkg = in.readUTF();
501 try {
502 info = mPackageManager.getPackageInfo(pkg, 0);
503 mEverStoredApps.add(pkg);
504 temp.writeUTF(pkg);
505 if (DEBUG) Log.v(TAG, " + " + pkg);
506 } catch (NameNotFoundException e) {
507 // nope, this package was uninstalled; don't include it
508 if (DEBUG) Log.v(TAG, " - " + pkg);
509 }
510 }
511 } catch (EOFException e) {
512 // Once we've rewritten the backup history log, atomically replace the
513 // old one with the new one then reopen the file for continuing use.
514 if (!tempProcessedFile.renameTo(mEverStored)) {
515 Log.e(TAG, "Error renaming " + tempProcessedFile + " to " + mEverStored);
516 }
517 } catch (IOException e) {
518 Log.e(TAG, "Error in processed file", e);
519 } finally {
520 try { if (temp != null) temp.close(); } catch (IOException e) {}
521 try { if (in != null) in.close(); } catch (IOException e) {}
522 }
523 }
524
Christopher Tate73e02522009-07-15 14:18:26 -0700525 // Register for broadcasts about package install, etc., so we can
526 // update the provider list.
527 IntentFilter filter = new IntentFilter();
528 filter.addAction(Intent.ACTION_PACKAGE_ADDED);
529 filter.addAction(Intent.ACTION_PACKAGE_REMOVED);
530 filter.addDataScheme("package");
531 mContext.registerReceiver(mBroadcastReceiver, filter);
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800532 // Register for events related to sdcard installation.
533 IntentFilter sdFilter = new IntentFilter();
534 sdFilter.addAction(Intent.ACTION_MEDIA_RESOURCES_AVAILABLE);
535 sdFilter.addAction(Intent.ACTION_MEDIA_RESOURCES_UNAVAILABLE);
536 mContext.registerReceiver(mBroadcastReceiver, sdFilter);
Christopher Tate73e02522009-07-15 14:18:26 -0700537 }
538
Christopher Tatecde87f42009-06-12 12:55:53 -0700539 private void parseLeftoverJournals() {
Dan Egnor852f8e42009-09-30 11:20:45 -0700540 for (File f : mJournalDir.listFiles()) {
541 if (mJournal == null || f.compareTo(mJournal) != 0) {
542 // This isn't the current journal, so it must be a leftover. Read
543 // out the package names mentioned there and schedule them for
544 // backup.
545 RandomAccessFile in = null;
546 try {
547 Log.i(TAG, "Found stale backup journal, scheduling:");
548 in = new RandomAccessFile(f, "r");
549 while (true) {
550 String packageName = in.readUTF();
551 Log.i(TAG, " + " + packageName);
552 dataChanged(packageName);
Christopher Tatecde87f42009-06-12 12:55:53 -0700553 }
Dan Egnor852f8e42009-09-30 11:20:45 -0700554 } catch (EOFException e) {
555 // no more data; we're done
556 } catch (Exception e) {
557 Log.e(TAG, "Can't read " + f, e);
558 } finally {
559 // close/delete the file
560 try { if (in != null) in.close(); } catch (IOException e) {}
561 f.delete();
Christopher Tatecde87f42009-06-12 12:55:53 -0700562 }
563 }
564 }
565 }
566
Christopher Tate4cc86e12009-09-21 19:36:51 -0700567 // Maintain persistent state around whether need to do an initialize operation.
568 // Must be called with the queue lock held.
569 void recordInitPendingLocked(boolean isPending, String transportName) {
570 if (DEBUG) Log.i(TAG, "recordInitPendingLocked: " + isPending
571 + " on transport " + transportName);
572 try {
573 IBackupTransport transport = getTransport(transportName);
574 String transportDirName = transport.transportDirName();
575 File stateDir = new File(mBaseStateDir, transportDirName);
576 File initPendingFile = new File(stateDir, INIT_SENTINEL_FILE_NAME);
577
578 if (isPending) {
579 // We need an init before we can proceed with sending backup data.
580 // Record that with an entry in our set of pending inits, as well as
581 // journaling it via creation of a sentinel file.
582 mPendingInits.add(transportName);
583 try {
584 (new FileOutputStream(initPendingFile)).close();
585 } catch (IOException ioe) {
586 // Something is badly wrong with our permissions; just try to move on
587 }
588 } else {
589 // No more initialization needed; wipe the journal and reset our state.
590 initPendingFile.delete();
591 mPendingInits.remove(transportName);
592 }
593 } catch (RemoteException e) {
594 // can't happen; the transport is local
595 }
596 }
597
Christopher Tated55e18a2009-09-21 10:12:59 -0700598 // Reset all of our bookkeeping, in response to having been told that
599 // the backend data has been wiped [due to idle expiry, for example],
600 // so we must re-upload all saved settings.
601 void resetBackupState(File stateFileDir) {
602 synchronized (mQueueLock) {
603 // Wipe the "what we've ever backed up" tracking
Christopher Tated55e18a2009-09-21 10:12:59 -0700604 mEverStoredApps.clear();
Dan Egnor852f8e42009-09-30 11:20:45 -0700605 mEverStored.delete();
Christopher Tated55e18a2009-09-21 10:12:59 -0700606
607 // Remove all the state files
608 for (File sf : stateFileDir.listFiles()) {
Christopher Tate4cc86e12009-09-21 19:36:51 -0700609 // ... but don't touch the needs-init sentinel
610 if (!sf.getName().equals(INIT_SENTINEL_FILE_NAME)) {
611 sf.delete();
612 }
Christopher Tated55e18a2009-09-21 10:12:59 -0700613 }
614
615 // Enqueue a new backup of every participant
616 int N = mBackupParticipants.size();
617 for (int i=0; i<N; i++) {
618 int uid = mBackupParticipants.keyAt(i);
619 HashSet<ApplicationInfo> participants = mBackupParticipants.valueAt(i);
620 for (ApplicationInfo app: participants) {
Dan Egnor852f8e42009-09-30 11:20:45 -0700621 dataChanged(app.packageName);
Christopher Tated55e18a2009-09-21 10:12:59 -0700622 }
623 }
624 }
625 }
626
Christopher Tatedfa47b56e2009-12-22 16:01:32 -0800627 // Add a transport to our set of available backends. If 'transport' is null, this
628 // is an unregistration, and the transport's entry is removed from our bookkeeping.
Christopher Tate91717492009-06-26 21:07:13 -0700629 private void registerTransport(String name, IBackupTransport transport) {
630 synchronized (mTransports) {
Christopher Tate34ebd0e2009-07-06 15:44:54 -0700631 if (DEBUG) Log.v(TAG, "Registering transport " + name + " = " + transport);
Christopher Tatedfa47b56e2009-12-22 16:01:32 -0800632 if (transport != null) {
633 mTransports.put(name, transport);
634 } else {
635 mTransports.remove(name);
Christopher Tateb0dcaaf2010-01-29 16:27:04 -0800636 if ((mCurrentTransport != null) && mCurrentTransport.equals(name)) {
Christopher Tatedfa47b56e2009-12-22 16:01:32 -0800637 mCurrentTransport = null;
638 }
639 // Nothing further to do in the unregistration case
640 return;
641 }
Christopher Tate91717492009-06-26 21:07:13 -0700642 }
Christopher Tate4cc86e12009-09-21 19:36:51 -0700643
644 // If the init sentinel file exists, we need to be sure to perform the init
645 // as soon as practical. We also create the state directory at registration
646 // time to ensure it's present from the outset.
647 try {
648 String transportName = transport.transportDirName();
649 File stateDir = new File(mBaseStateDir, transportName);
650 stateDir.mkdirs();
651
652 File initSentinel = new File(stateDir, INIT_SENTINEL_FILE_NAME);
653 if (initSentinel.exists()) {
654 synchronized (mQueueLock) {
655 mPendingInits.add(transportName);
656
657 // TODO: pick a better starting time than now + 1 minute
658 long delay = 1000 * 60; // one minute, in milliseconds
659 mAlarmManager.set(AlarmManager.RTC_WAKEUP,
660 System.currentTimeMillis() + delay, mRunInitIntent);
661 }
662 }
663 } catch (RemoteException e) {
664 // can't happen, the transport is local
665 }
Christopher Tate91717492009-06-26 21:07:13 -0700666 }
667
Christopher Tate3799bc22009-05-06 16:13:56 -0700668 // ----- Track installation/removal of packages -----
669 BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
670 public void onReceive(Context context, Intent intent) {
671 if (DEBUG) Log.d(TAG, "Received broadcast " + intent);
672
Christopher Tate3799bc22009-05-06 16:13:56 -0700673 String action = intent.getAction();
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800674 boolean replacing = false;
675 boolean added = false;
676 Bundle extras = intent.getExtras();
677 String pkgList[] = null;
678 if (Intent.ACTION_PACKAGE_ADDED.equals(action) ||
679 Intent.ACTION_PACKAGE_REMOVED.equals(action)) {
680 Uri uri = intent.getData();
681 if (uri == null) {
682 return;
683 }
684 String pkgName = uri.getSchemeSpecificPart();
685 if (pkgName != null) {
686 pkgList = new String[] { pkgName };
687 }
688 added = Intent.ACTION_PACKAGE_ADDED.equals(action);
689 replacing = extras.getBoolean(Intent.EXTRA_REPLACING, false);
690 } else if (Intent.ACTION_MEDIA_RESOURCES_AVAILABLE.equals(action)) {
691 added = true;
692 pkgList = intent.getStringArrayExtra(Intent.EXTRA_CHANGED_PACKAGE_LIST);
693 } else if (Intent.ACTION_MEDIA_RESOURCES_UNAVAILABLE.equals(action)) {
694 added = false;
695 pkgList = intent.getStringArrayExtra(Intent.EXTRA_CHANGED_PACKAGE_LIST);
696 }
697 if (pkgList == null || pkgList.length == 0) {
698 return;
699 }
700 if (added) {
Christopher Tate3799bc22009-05-06 16:13:56 -0700701 synchronized (mBackupParticipants) {
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800702 for (String pkgName : pkgList) {
703 if (replacing) {
704 // The package was just upgraded
705 updatePackageParticipantsLocked(pkgName);
706 } else {
707 // The package was just added
708 addPackageParticipantsLocked(pkgName);
709 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700710 }
711 }
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800712 } else {
713 if (replacing) {
Christopher Tate3799bc22009-05-06 16:13:56 -0700714 // The package is being updated. We'll receive a PACKAGE_ADDED shortly.
715 } else {
716 synchronized (mBackupParticipants) {
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800717 for (String pkgName : pkgList) {
718 removePackageParticipantsLocked(pkgName);
719 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700720 }
721 }
722 }
723 }
724 };
725
Dan Egnor87a02bc2009-06-17 02:30:10 -0700726 // ----- Track connection to GoogleBackupTransport service -----
727 ServiceConnection mGoogleConnection = new ServiceConnection() {
728 public void onServiceConnected(ComponentName name, IBinder service) {
729 if (DEBUG) Log.v(TAG, "Connected to Google transport");
730 mGoogleTransport = IBackupTransport.Stub.asInterface(service);
Christopher Tate91717492009-06-26 21:07:13 -0700731 registerTransport(name.flattenToShortString(), mGoogleTransport);
Dan Egnor87a02bc2009-06-17 02:30:10 -0700732 }
733
734 public void onServiceDisconnected(ComponentName name) {
735 if (DEBUG) Log.v(TAG, "Disconnected from Google transport");
736 mGoogleTransport = null;
Christopher Tate91717492009-06-26 21:07:13 -0700737 registerTransport(name.flattenToShortString(), null);
Dan Egnor87a02bc2009-06-17 02:30:10 -0700738 }
739 };
740
Christopher Tate181fafa2009-05-14 11:12:14 -0700741 // Add the backup agents in the given package to our set of known backup participants.
742 // If 'packageName' is null, adds all backup agents in the whole system.
Christopher Tate3799bc22009-05-06 16:13:56 -0700743 void addPackageParticipantsLocked(String packageName) {
Christopher Tate181fafa2009-05-14 11:12:14 -0700744 // Look for apps that define the android:backupAgent attribute
Christopher Tate043dadc2009-06-02 16:11:00 -0700745 if (DEBUG) Log.v(TAG, "addPackageParticipantsLocked: " + packageName);
Dan Egnorefe52642009-06-24 00:16:33 -0700746 List<PackageInfo> targetApps = allAgentPackages();
Christopher Tate181fafa2009-05-14 11:12:14 -0700747 addPackageParticipantsLockedInner(packageName, targetApps);
Christopher Tate3799bc22009-05-06 16:13:56 -0700748 }
749
Christopher Tate181fafa2009-05-14 11:12:14 -0700750 private void addPackageParticipantsLockedInner(String packageName,
Dan Egnorefe52642009-06-24 00:16:33 -0700751 List<PackageInfo> targetPkgs) {
Christopher Tate181fafa2009-05-14 11:12:14 -0700752 if (DEBUG) {
Dan Egnorefe52642009-06-24 00:16:33 -0700753 Log.v(TAG, "Adding " + targetPkgs.size() + " backup participants:");
754 for (PackageInfo p : targetPkgs) {
Christopher Tate111bd4a2009-06-24 17:29:38 -0700755 Log.v(TAG, " " + p + " agent=" + p.applicationInfo.backupAgentName
Christopher Tate5e1ab332009-09-01 20:32:49 -0700756 + " uid=" + p.applicationInfo.uid
757 + " killAfterRestore="
758 + (((p.applicationInfo.flags & ApplicationInfo.FLAG_KILL_AFTER_RESTORE) != 0) ? "true" : "false")
759 + " restoreNeedsApplication="
760 + (((p.applicationInfo.flags & ApplicationInfo.FLAG_RESTORE_NEEDS_APPLICATION) != 0) ? "true" : "false")
761 );
Christopher Tate181fafa2009-05-14 11:12:14 -0700762 }
763 }
764
Dan Egnorefe52642009-06-24 00:16:33 -0700765 for (PackageInfo pkg : targetPkgs) {
766 if (packageName == null || pkg.packageName.equals(packageName)) {
767 int uid = pkg.applicationInfo.uid;
Christopher Tate181fafa2009-05-14 11:12:14 -0700768 HashSet<ApplicationInfo> set = mBackupParticipants.get(uid);
Christopher Tate3799bc22009-05-06 16:13:56 -0700769 if (set == null) {
Christopher Tate181fafa2009-05-14 11:12:14 -0700770 set = new HashSet<ApplicationInfo>();
Christopher Tate3799bc22009-05-06 16:13:56 -0700771 mBackupParticipants.put(uid, set);
772 }
Dan Egnorefe52642009-06-24 00:16:33 -0700773 set.add(pkg.applicationInfo);
Christopher Tate73e02522009-07-15 14:18:26 -0700774
775 // If we've never seen this app before, schedule a backup for it
776 if (!mEverStoredApps.contains(pkg.packageName)) {
777 if (DEBUG) Log.i(TAG, "New app " + pkg.packageName
778 + " never backed up; scheduling");
Dan Egnor852f8e42009-09-30 11:20:45 -0700779 dataChanged(pkg.packageName);
Christopher Tate73e02522009-07-15 14:18:26 -0700780 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700781 }
Christopher Tate487529a2009-04-29 14:03:25 -0700782 }
783 }
784
Christopher Tate6785dd82009-06-18 15:58:25 -0700785 // Remove the given package's entry from our known active set. If
786 // 'packageName' is null, *all* participating apps will be removed.
Christopher Tate3799bc22009-05-06 16:13:56 -0700787 void removePackageParticipantsLocked(String packageName) {
Christopher Tate043dadc2009-06-02 16:11:00 -0700788 if (DEBUG) Log.v(TAG, "removePackageParticipantsLocked: " + packageName);
Dan Egnorefe52642009-06-24 00:16:33 -0700789 List<PackageInfo> allApps = null;
Christopher Tate181fafa2009-05-14 11:12:14 -0700790 if (packageName != null) {
Dan Egnorefe52642009-06-24 00:16:33 -0700791 allApps = new ArrayList<PackageInfo>();
Christopher Tate181fafa2009-05-14 11:12:14 -0700792 try {
Dan Egnorefe52642009-06-24 00:16:33 -0700793 int flags = PackageManager.GET_SIGNATURES;
794 allApps.add(mPackageManager.getPackageInfo(packageName, flags));
Christopher Tate181fafa2009-05-14 11:12:14 -0700795 } catch (Exception e) {
Dan Egnorefe52642009-06-24 00:16:33 -0700796 // just skip it (???)
Christopher Tate181fafa2009-05-14 11:12:14 -0700797 }
798 } else {
799 // all apps with agents
Dan Egnorefe52642009-06-24 00:16:33 -0700800 allApps = allAgentPackages();
Christopher Tate181fafa2009-05-14 11:12:14 -0700801 }
802 removePackageParticipantsLockedInner(packageName, allApps);
Christopher Tate3799bc22009-05-06 16:13:56 -0700803 }
804
Joe Onorato8ad02812009-05-13 01:41:44 -0400805 private void removePackageParticipantsLockedInner(String packageName,
Dan Egnorefe52642009-06-24 00:16:33 -0700806 List<PackageInfo> agents) {
Christopher Tate043dadc2009-06-02 16:11:00 -0700807 if (DEBUG) {
808 Log.v(TAG, "removePackageParticipantsLockedInner (" + packageName
809 + ") removing " + agents.size() + " entries");
Dan Egnorefe52642009-06-24 00:16:33 -0700810 for (PackageInfo p : agents) {
811 Log.v(TAG, " - " + p);
Christopher Tate043dadc2009-06-02 16:11:00 -0700812 }
813 }
Dan Egnorefe52642009-06-24 00:16:33 -0700814 for (PackageInfo pkg : agents) {
815 if (packageName == null || pkg.packageName.equals(packageName)) {
816 int uid = pkg.applicationInfo.uid;
Christopher Tate181fafa2009-05-14 11:12:14 -0700817 HashSet<ApplicationInfo> set = mBackupParticipants.get(uid);
Christopher Tate3799bc22009-05-06 16:13:56 -0700818 if (set != null) {
Christopher Tatecd4ff2e2009-06-05 13:57:54 -0700819 // Find the existing entry with the same package name, and remove it.
820 // We can't just remove(app) because the instances are different.
821 for (ApplicationInfo entry: set) {
Dan Egnorefe52642009-06-24 00:16:33 -0700822 if (entry.packageName.equals(pkg.packageName)) {
Christopher Tatecd4ff2e2009-06-05 13:57:54 -0700823 set.remove(entry);
Christopher Tatee97e8072009-07-15 16:45:50 -0700824 removeEverBackedUp(pkg.packageName);
Christopher Tatecd4ff2e2009-06-05 13:57:54 -0700825 break;
826 }
827 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700828 if (set.size() == 0) {
Dan Egnorefe52642009-06-24 00:16:33 -0700829 mBackupParticipants.delete(uid);
830 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700831 }
832 }
833 }
834 }
835
Christopher Tate181fafa2009-05-14 11:12:14 -0700836 // Returns the set of all applications that define an android:backupAgent attribute
Christopher Tate73e02522009-07-15 14:18:26 -0700837 List<PackageInfo> allAgentPackages() {
Christopher Tate6785dd82009-06-18 15:58:25 -0700838 // !!! TODO: cache this and regenerate only when necessary
Dan Egnorefe52642009-06-24 00:16:33 -0700839 int flags = PackageManager.GET_SIGNATURES;
840 List<PackageInfo> packages = mPackageManager.getInstalledPackages(flags);
841 int N = packages.size();
842 for (int a = N-1; a >= 0; a--) {
Christopher Tate0749dcd2009-08-13 15:13:03 -0700843 PackageInfo pkg = packages.get(a);
Christopher Tateb8eb1cb2009-09-16 10:57:21 -0700844 try {
845 ApplicationInfo app = pkg.applicationInfo;
846 if (((app.flags&ApplicationInfo.FLAG_ALLOW_BACKUP) == 0)
847 || app.backupAgentName == null
848 || (mPackageManager.checkPermission(android.Manifest.permission.BACKUP_DATA,
849 pkg.packageName) != PackageManager.PERMISSION_GRANTED)) {
850 packages.remove(a);
851 }
852 else {
853 // we will need the shared library path, so look that up and store it here
854 app = mPackageManager.getApplicationInfo(pkg.packageName,
855 PackageManager.GET_SHARED_LIBRARY_FILES);
856 pkg.applicationInfo.sharedLibraryFiles = app.sharedLibraryFiles;
857 }
858 } catch (NameNotFoundException e) {
Dan Egnorefe52642009-06-24 00:16:33 -0700859 packages.remove(a);
Christopher Tate181fafa2009-05-14 11:12:14 -0700860 }
861 }
Dan Egnorefe52642009-06-24 00:16:33 -0700862 return packages;
Christopher Tate181fafa2009-05-14 11:12:14 -0700863 }
Christopher Tateaa088442009-06-16 18:25:46 -0700864
Christopher Tate3799bc22009-05-06 16:13:56 -0700865 // Reset the given package's known backup participants. Unlike add/remove, the update
866 // action cannot be passed a null package name.
867 void updatePackageParticipantsLocked(String packageName) {
868 if (packageName == null) {
869 Log.e(TAG, "updatePackageParticipants called with null package name");
870 return;
871 }
Christopher Tate043dadc2009-06-02 16:11:00 -0700872 if (DEBUG) Log.v(TAG, "updatePackageParticipantsLocked: " + packageName);
Christopher Tate3799bc22009-05-06 16:13:56 -0700873
874 // brute force but small code size
Dan Egnorefe52642009-06-24 00:16:33 -0700875 List<PackageInfo> allApps = allAgentPackages();
Christopher Tate181fafa2009-05-14 11:12:14 -0700876 removePackageParticipantsLockedInner(packageName, allApps);
877 addPackageParticipantsLockedInner(packageName, allApps);
Christopher Tate3799bc22009-05-06 16:13:56 -0700878 }
879
Christopher Tate73e02522009-07-15 14:18:26 -0700880 // Called from the backup thread: record that the given app has been successfully
881 // backed up at least once
882 void logBackupComplete(String packageName) {
Dan Egnor852f8e42009-09-30 11:20:45 -0700883 if (packageName.equals(PACKAGE_MANAGER_SENTINEL)) return;
884
885 synchronized (mEverStoredApps) {
886 if (!mEverStoredApps.add(packageName)) return;
887
888 RandomAccessFile out = null;
889 try {
890 out = new RandomAccessFile(mEverStored, "rws");
891 out.seek(out.length());
892 out.writeUTF(packageName);
893 } catch (IOException e) {
894 Log.e(TAG, "Can't log backup of " + packageName + " to " + mEverStored);
895 } finally {
896 try { if (out != null) out.close(); } catch (IOException e) {}
Christopher Tate73e02522009-07-15 14:18:26 -0700897 }
898 }
899 }
900
Christopher Tatee97e8072009-07-15 16:45:50 -0700901 // Remove our awareness of having ever backed up the given package
902 void removeEverBackedUp(String packageName) {
Dan Egnor852f8e42009-09-30 11:20:45 -0700903 if (DEBUG) Log.v(TAG, "Removing backed-up knowledge of " + packageName + ", new set:");
Christopher Tatee97e8072009-07-15 16:45:50 -0700904
Dan Egnor852f8e42009-09-30 11:20:45 -0700905 synchronized (mEverStoredApps) {
906 // Rewrite the file and rename to overwrite. If we reboot in the middle,
907 // we'll recognize on initialization time that the package no longer
908 // exists and fix it up then.
909 File tempKnownFile = new File(mBaseStateDir, "processed.new");
910 RandomAccessFile known = null;
911 try {
912 known = new RandomAccessFile(tempKnownFile, "rws");
913 mEverStoredApps.remove(packageName);
914 for (String s : mEverStoredApps) {
915 known.writeUTF(s);
916 if (DEBUG) Log.v(TAG, " " + s);
Christopher Tatee97e8072009-07-15 16:45:50 -0700917 }
Dan Egnor852f8e42009-09-30 11:20:45 -0700918 known.close();
919 known = null;
920 if (!tempKnownFile.renameTo(mEverStored)) {
921 throw new IOException("Can't rename " + tempKnownFile + " to " + mEverStored);
922 }
923 } catch (IOException e) {
924 // Bad: we couldn't create the new copy. For safety's sake we
925 // abandon the whole process and remove all what's-backed-up
926 // state entirely, meaning we'll force a backup pass for every
927 // participant on the next boot or [re]install.
928 Log.w(TAG, "Error rewriting " + mEverStored, e);
929 mEverStoredApps.clear();
930 tempKnownFile.delete();
931 mEverStored.delete();
932 } finally {
933 try { if (known != null) known.close(); } catch (IOException e) {}
Christopher Tatee97e8072009-07-15 16:45:50 -0700934 }
935 }
936 }
937
Dan Egnor87a02bc2009-06-17 02:30:10 -0700938 // Return the given transport
Christopher Tate91717492009-06-26 21:07:13 -0700939 private IBackupTransport getTransport(String transportName) {
940 synchronized (mTransports) {
941 IBackupTransport transport = mTransports.get(transportName);
942 if (transport == null) {
943 Log.w(TAG, "Requested unavailable transport: " + transportName);
944 }
945 return transport;
Christopher Tate8c850b72009-06-07 19:33:20 -0700946 }
Christopher Tate8c850b72009-06-07 19:33:20 -0700947 }
948
Christopher Tatedf01dea2009-06-09 20:45:02 -0700949 // fire off a backup agent, blocking until it attaches or times out
950 IBackupAgent bindToAgentSynchronous(ApplicationInfo app, int mode) {
951 IBackupAgent agent = null;
952 synchronized(mAgentConnectLock) {
953 mConnecting = true;
954 mConnectedAgent = null;
955 try {
956 if (mActivityManager.bindBackupAgent(app, mode)) {
957 Log.d(TAG, "awaiting agent for " + app);
958
959 // success; wait for the agent to arrive
Christopher Tatec7b31e32009-06-10 15:49:30 -0700960 // only wait 10 seconds for the clear data to happen
961 long timeoutMark = System.currentTimeMillis() + TIMEOUT_INTERVAL;
962 while (mConnecting && mConnectedAgent == null
963 && (System.currentTimeMillis() < timeoutMark)) {
Christopher Tatedf01dea2009-06-09 20:45:02 -0700964 try {
Christopher Tatec7b31e32009-06-10 15:49:30 -0700965 mAgentConnectLock.wait(5000);
Christopher Tatedf01dea2009-06-09 20:45:02 -0700966 } catch (InterruptedException e) {
Christopher Tatec7b31e32009-06-10 15:49:30 -0700967 // just bail
Christopher Tatedf01dea2009-06-09 20:45:02 -0700968 return null;
969 }
970 }
971
972 // if we timed out with no connect, abort and move on
973 if (mConnecting == true) {
974 Log.w(TAG, "Timeout waiting for agent " + app);
975 return null;
976 }
977 agent = mConnectedAgent;
978 }
979 } catch (RemoteException e) {
980 // can't happen
981 }
982 }
983 return agent;
984 }
985
Christopher Tatec7b31e32009-06-10 15:49:30 -0700986 // clear an application's data, blocking until the operation completes or times out
987 void clearApplicationDataSynchronous(String packageName) {
Christopher Tatef7c886b2009-06-26 15:34:09 -0700988 // Don't wipe packages marked allowClearUserData=false
989 try {
990 PackageInfo info = mPackageManager.getPackageInfo(packageName, 0);
991 if ((info.applicationInfo.flags & ApplicationInfo.FLAG_ALLOW_CLEAR_USER_DATA) == 0) {
992 if (DEBUG) Log.i(TAG, "allowClearUserData=false so not wiping "
993 + packageName);
994 return;
995 }
996 } catch (NameNotFoundException e) {
997 Log.w(TAG, "Tried to clear data for " + packageName + " but not found");
998 return;
999 }
1000
Christopher Tatec7b31e32009-06-10 15:49:30 -07001001 ClearDataObserver observer = new ClearDataObserver();
1002
1003 synchronized(mClearDataLock) {
1004 mClearingData = true;
Amith Yamasani2e6bca62009-08-07 20:26:13 -07001005 /* This is causing some critical processes to be killed during setup.
1006 Temporarily revert this change until we find a better solution.
Christopher Tate9dfdac52009-08-06 14:57:53 -07001007 try {
1008 mActivityManager.clearApplicationUserData(packageName, observer);
1009 } catch (RemoteException e) {
1010 // can't happen because the activity manager is in this process
1011 }
Amith Yamasani2e6bca62009-08-07 20:26:13 -07001012 */
1013 mPackageManager.clearApplicationUserData(packageName, observer);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001014
1015 // only wait 10 seconds for the clear data to happen
1016 long timeoutMark = System.currentTimeMillis() + TIMEOUT_INTERVAL;
1017 while (mClearingData && (System.currentTimeMillis() < timeoutMark)) {
1018 try {
1019 mClearDataLock.wait(5000);
1020 } catch (InterruptedException e) {
1021 // won't happen, but still.
1022 mClearingData = false;
1023 }
1024 }
1025 }
1026 }
1027
1028 class ClearDataObserver extends IPackageDataObserver.Stub {
Dan Egnor852f8e42009-09-30 11:20:45 -07001029 public void onRemoveCompleted(String packageName, boolean succeeded) {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001030 synchronized(mClearDataLock) {
1031 mClearingData = false;
Christopher Tatef68eb502009-06-16 11:02:01 -07001032 mClearDataLock.notifyAll();
Christopher Tatec7b31e32009-06-10 15:49:30 -07001033 }
1034 }
1035 }
1036
Christopher Tate44a27902010-01-27 17:15:49 -08001037 // -----
1038 // Utility methods used by the asynchronous-with-timeout backup/restore operations
1039 boolean waitUntilOperationComplete(int token) {
1040 int finalState = OP_PENDING;
1041 synchronized (mCurrentOpLock) {
1042 try {
1043 while ((finalState = mCurrentOperations.get(token, OP_TIMEOUT)) == OP_PENDING) {
1044 try {
1045 mCurrentOpLock.wait();
1046 } catch (InterruptedException e) {}
1047 }
1048 } catch (IndexOutOfBoundsException e) {
1049 // the operation has been mysteriously cleared from our
1050 // bookkeeping -- consider this a success and ignore it.
1051 }
1052 }
1053 mBackupHandler.removeMessages(MSG_TIMEOUT);
1054 if (DEBUG) Log.v(TAG, "operation " + token + " complete: finalState=" + finalState);
1055 return finalState == OP_ACKNOWLEDGED;
1056 }
1057
1058 void prepareOperationTimeout(int token, long interval) {
1059 if (DEBUG) Log.v(TAG, "starting timeout: token=" + token + " interval=" + interval);
1060 mCurrentOperations.put(token, OP_PENDING);
1061 Message msg = mBackupHandler.obtainMessage(MSG_TIMEOUT, token, 0);
1062 mBackupHandler.sendMessageDelayed(msg, interval);
1063 }
1064
Christopher Tate043dadc2009-06-02 16:11:00 -07001065 // ----- Back up a set of applications via a worker thread -----
1066
Christopher Tate44a27902010-01-27 17:15:49 -08001067 class PerformBackupTask implements Runnable {
Christopher Tate043dadc2009-06-02 16:11:00 -07001068 private static final String TAG = "PerformBackupThread";
Christopher Tateaa088442009-06-16 18:25:46 -07001069 IBackupTransport mTransport;
Christopher Tate043dadc2009-06-02 16:11:00 -07001070 ArrayList<BackupRequest> mQueue;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001071 File mStateDir;
Christopher Tatecde87f42009-06-12 12:55:53 -07001072 File mJournal;
Christopher Tate043dadc2009-06-02 16:11:00 -07001073
Christopher Tate44a27902010-01-27 17:15:49 -08001074 public PerformBackupTask(IBackupTransport transport, ArrayList<BackupRequest> queue,
Christopher Tatecde87f42009-06-12 12:55:53 -07001075 File journal) {
Christopher Tateaa088442009-06-16 18:25:46 -07001076 mTransport = transport;
Christopher Tate043dadc2009-06-02 16:11:00 -07001077 mQueue = queue;
Christopher Tatecde87f42009-06-12 12:55:53 -07001078 mJournal = journal;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001079
1080 try {
1081 mStateDir = new File(mBaseStateDir, transport.transportDirName());
1082 } catch (RemoteException e) {
1083 // can't happen; the transport is local
1084 }
Christopher Tate043dadc2009-06-02 16:11:00 -07001085 }
1086
Christopher Tate043dadc2009-06-02 16:11:00 -07001087 public void run() {
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001088 int status = BackupConstants.TRANSPORT_OK;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001089 long startRealtime = SystemClock.elapsedRealtime();
Christopher Tate043dadc2009-06-02 16:11:00 -07001090 if (DEBUG) Log.v(TAG, "Beginning backup of " + mQueue.size() + " targets");
1091
Christopher Tate79588342009-06-30 16:11:49 -07001092 // Backups run at background priority
1093 Process.setThreadPriority(Process.THREAD_PRIORITY_BACKGROUND);
1094
Christopher Tate043dadc2009-06-02 16:11:00 -07001095 try {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001096 EventLog.writeEvent(EventLogTags.BACKUP_START, mTransport.transportDirName());
Dan Egnor01445162009-09-21 17:04:05 -07001097
Dan Egnor852f8e42009-09-30 11:20:45 -07001098 // If we haven't stored package manager metadata yet, we must init the transport.
1099 File pmState = new File(mStateDir, PACKAGE_MANAGER_SENTINEL);
1100 if (status == BackupConstants.TRANSPORT_OK && pmState.length() <= 0) {
1101 Log.i(TAG, "Initializing (wiping) backup state and transport storage");
1102 resetBackupState(mStateDir); // Just to make sure.
Dan Egnor01445162009-09-21 17:04:05 -07001103 status = mTransport.initializeDevice();
Dan Egnor726247c2009-09-29 19:12:31 -07001104 if (status == BackupConstants.TRANSPORT_OK) {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001105 EventLog.writeEvent(EventLogTags.BACKUP_INITIALIZE);
Dan Egnor726247c2009-09-29 19:12:31 -07001106 } else {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001107 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, "(initialize)");
Dan Egnor726247c2009-09-29 19:12:31 -07001108 Log.e(TAG, "Transport error in initializeDevice()");
1109 }
Dan Egnor01445162009-09-21 17:04:05 -07001110 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001111
1112 // The package manager doesn't have a proper <application> etc, but since
1113 // it's running here in the system process we can just set up its agent
1114 // directly and use a synthetic BackupRequest. We always run this pass
1115 // because it's cheap and this way we guarantee that we don't get out of
1116 // step even if we're selecting among various transports at run time.
Dan Egnor01445162009-09-21 17:04:05 -07001117 if (status == BackupConstants.TRANSPORT_OK) {
1118 PackageManagerBackupAgent pmAgent = new PackageManagerBackupAgent(
1119 mPackageManager, allAgentPackages());
1120 BackupRequest pmRequest = new BackupRequest(new ApplicationInfo(), false);
1121 pmRequest.appInfo.packageName = PACKAGE_MANAGER_SENTINEL;
1122 status = processOneBackup(pmRequest,
1123 IBackupAgent.Stub.asInterface(pmAgent.onBind()), mTransport);
1124 }
Christopher Tate90967f42009-09-20 15:28:33 -07001125
Dan Egnor01445162009-09-21 17:04:05 -07001126 if (status == BackupConstants.TRANSPORT_OK) {
1127 // Now run all the backups in our queue
1128 status = doQueuedBackups(mTransport);
1129 }
1130
1131 if (status == BackupConstants.TRANSPORT_OK) {
1132 // Tell the transport to finish everything it has buffered
1133 status = mTransport.finishBackup();
1134 if (status == BackupConstants.TRANSPORT_OK) {
1135 int millis = (int) (SystemClock.elapsedRealtime() - startRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001136 EventLog.writeEvent(EventLogTags.BACKUP_SUCCESS, mQueue.size(), millis);
Dan Egnor01445162009-09-21 17:04:05 -07001137 } else {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001138 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, "(finish)");
Dan Egnor01445162009-09-21 17:04:05 -07001139 Log.e(TAG, "Transport error in finishBackup()");
1140 }
1141 }
1142
Dan Egnor01445162009-09-21 17:04:05 -07001143 if (status == BackupConstants.TRANSPORT_NOT_INITIALIZED) {
Christopher Tated55e18a2009-09-21 10:12:59 -07001144 // The backend reports that our dataset has been wiped. We need to
1145 // reset all of our bookkeeping and instead run a new backup pass for
Christopher Tatec2af5d32010-02-02 15:18:58 -08001146 // everything.
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001147 EventLog.writeEvent(EventLogTags.BACKUP_RESET, mTransport.transportDirName());
Christopher Tated55e18a2009-09-21 10:12:59 -07001148 resetBackupState(mStateDir);
Dan Egnorbb9001c2009-07-27 12:20:13 -07001149 }
1150 } catch (Exception e) {
1151 Log.e(TAG, "Error in backup thread", e);
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001152 status = BackupConstants.TRANSPORT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001153 } finally {
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001154 // If things went wrong, we need to re-stage the apps we had expected
1155 // to be backing up in this pass. This journals the package names in
1156 // the current active pending-backup file, not in the we are holding
1157 // here in mJournal.
1158 if (status != BackupConstants.TRANSPORT_OK) {
1159 Log.w(TAG, "Backup pass unsuccessful, restaging");
1160 for (BackupRequest req : mQueue) {
Dan Egnor852f8e42009-09-30 11:20:45 -07001161 dataChanged(req.appInfo.packageName);
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001162 }
Christopher Tate21ab6a52009-09-24 18:01:46 -07001163
1164 // We also want to reset the backup schedule based on whatever
1165 // the transport suggests by way of retry/backoff time.
1166 try {
1167 startBackupAlarmsLocked(mTransport.requestBackupTime());
1168 } catch (RemoteException e) { /* cannot happen */ }
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001169 }
1170
1171 // Either backup was successful, in which case we of course do not need
1172 // this pass's journal any more; or it failed, in which case we just
1173 // re-enqueued all of these packages in the current active journal.
1174 // Either way, we no longer need this pass's journal.
Dan Egnor852f8e42009-09-30 11:20:45 -07001175 if (mJournal != null && !mJournal.delete()) {
Christopher Tateb03b3bb2009-09-22 11:14:17 -07001176 Log.e(TAG, "Unable to remove backup journal file " + mJournal);
1177 }
1178
Christopher Tatec2af5d32010-02-02 15:18:58 -08001179 // Only once we're entirely finished do we release the wakelock
Dan Egnor852f8e42009-09-30 11:20:45 -07001180 if (status == BackupConstants.TRANSPORT_NOT_INITIALIZED) {
Dan Egnor852f8e42009-09-30 11:20:45 -07001181 backupNow();
1182 }
1183
Dan Egnorbb9001c2009-07-27 12:20:13 -07001184 mWakelock.release();
Christopher Tatecde87f42009-06-12 12:55:53 -07001185 }
Christopher Tate043dadc2009-06-02 16:11:00 -07001186 }
1187
Dan Egnor01445162009-09-21 17:04:05 -07001188 private int doQueuedBackups(IBackupTransport transport) {
Christopher Tate043dadc2009-06-02 16:11:00 -07001189 for (BackupRequest request : mQueue) {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001190 Log.d(TAG, "starting agent for backup of " + request);
Christopher Tate043dadc2009-06-02 16:11:00 -07001191
Christopher Tate0749dcd2009-08-13 15:13:03 -07001192 // Don't run backup, even if requested, if the target app does not have
1193 // the requisite permission
1194 if (mPackageManager.checkPermission(android.Manifest.permission.BACKUP_DATA,
1195 request.appInfo.packageName) != PackageManager.PERMISSION_GRANTED) {
1196 Log.w(TAG, "Skipping backup of unprivileged package "
1197 + request.appInfo.packageName);
1198 continue;
1199 }
1200
Christopher Tate043dadc2009-06-02 16:11:00 -07001201 IBackupAgent agent = null;
1202 int mode = (request.fullBackup)
1203 ? IApplicationThread.BACKUP_MODE_FULL
1204 : IApplicationThread.BACKUP_MODE_INCREMENTAL;
1205 try {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001206 agent = bindToAgentSynchronous(request.appInfo, mode);
1207 if (agent != null) {
Dan Egnor01445162009-09-21 17:04:05 -07001208 int result = processOneBackup(request, agent, transport);
1209 if (result != BackupConstants.TRANSPORT_OK) return result;
Christopher Tate043dadc2009-06-02 16:11:00 -07001210 }
Christopher Tate043dadc2009-06-02 16:11:00 -07001211 } catch (SecurityException ex) {
1212 // Try for the next one.
Christopher Tatec7b31e32009-06-10 15:49:30 -07001213 Log.d(TAG, "error in bind/backup", ex);
Dan Egnor01445162009-09-21 17:04:05 -07001214 } finally {
1215 try { // unbind even on timeout, just in case
1216 mActivityManager.unbindBackupAgent(request.appInfo);
1217 } catch (RemoteException e) {}
Christopher Tate043dadc2009-06-02 16:11:00 -07001218 }
1219 }
Dan Egnor01445162009-09-21 17:04:05 -07001220
1221 return BackupConstants.TRANSPORT_OK;
Christopher Tate043dadc2009-06-02 16:11:00 -07001222 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07001223
Dan Egnor01445162009-09-21 17:04:05 -07001224 private int processOneBackup(BackupRequest request, IBackupAgent agent,
1225 IBackupTransport transport) {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001226 final String packageName = request.appInfo.packageName;
Dan Egnor01445162009-09-21 17:04:05 -07001227 if (DEBUG) Log.d(TAG, "processOneBackup doBackup() on " + packageName);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001228
Dan Egnorbb9001c2009-07-27 12:20:13 -07001229 File savedStateName = new File(mStateDir, packageName);
1230 File backupDataName = new File(mDataDir, packageName + ".data");
1231 File newStateName = new File(mStateDir, packageName + ".new");
1232
1233 ParcelFileDescriptor savedState = null;
1234 ParcelFileDescriptor backupData = null;
1235 ParcelFileDescriptor newState = null;
1236
1237 PackageInfo packInfo;
Christopher Tate44a27902010-01-27 17:15:49 -08001238 int token = mTokenGenerator.nextInt();
Christopher Tatec7b31e32009-06-10 15:49:30 -07001239 try {
1240 // Look up the package info & signatures. This is first so that if it
1241 // throws an exception, there's no file setup yet that would need to
1242 // be unraveled.
Christopher Tateabce4e82009-06-18 18:35:32 -07001243 if (packageName.equals(PACKAGE_MANAGER_SENTINEL)) {
1244 // The metadata 'package' is synthetic
1245 packInfo = new PackageInfo();
1246 packInfo.packageName = packageName;
1247 } else {
1248 packInfo = mPackageManager.getPackageInfo(packageName,
Christopher Tatec7b31e32009-06-10 15:49:30 -07001249 PackageManager.GET_SIGNATURES);
Christopher Tateabce4e82009-06-18 18:35:32 -07001250 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07001251
Christopher Tatec7b31e32009-06-10 15:49:30 -07001252 // In a full backup, we pass a null ParcelFileDescriptor as
1253 // the saved-state "file"
Dan Egnorbb9001c2009-07-27 12:20:13 -07001254 if (!request.fullBackup) {
1255 savedState = ParcelFileDescriptor.open(savedStateName,
Christopher Tatec7b31e32009-06-10 15:49:30 -07001256 ParcelFileDescriptor.MODE_READ_ONLY |
Dan Egnorbb9001c2009-07-27 12:20:13 -07001257 ParcelFileDescriptor.MODE_CREATE); // Make an empty file if necessary
1258 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07001259
Dan Egnorbb9001c2009-07-27 12:20:13 -07001260 backupData = ParcelFileDescriptor.open(backupDataName,
1261 ParcelFileDescriptor.MODE_READ_WRITE |
1262 ParcelFileDescriptor.MODE_CREATE |
1263 ParcelFileDescriptor.MODE_TRUNCATE);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001264
Dan Egnorbb9001c2009-07-27 12:20:13 -07001265 newState = ParcelFileDescriptor.open(newStateName,
1266 ParcelFileDescriptor.MODE_READ_WRITE |
1267 ParcelFileDescriptor.MODE_CREATE |
1268 ParcelFileDescriptor.MODE_TRUNCATE);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001269
Christopher Tate44a27902010-01-27 17:15:49 -08001270 // Initiate the target's backup pass
1271 prepareOperationTimeout(token, TIMEOUT_BACKUP_INTERVAL);
1272 agent.doBackup(savedState, backupData, newState, token, mBackupManagerBinder);
1273 boolean success = waitUntilOperationComplete(token);
1274
1275 if (!success) {
1276 // timeout -- bail out into the failed-transaction logic
1277 throw new RuntimeException("Backup timeout");
1278 }
1279
Dan Egnorbb9001c2009-07-27 12:20:13 -07001280 logBackupComplete(packageName);
1281 if (DEBUG) Log.v(TAG, "doBackup() success");
Christopher Tatec7b31e32009-06-10 15:49:30 -07001282 } catch (Exception e) {
Dan Egnorefe52642009-06-24 00:16:33 -07001283 Log.e(TAG, "Error backing up " + packageName, e);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001284 EventLog.writeEvent(EventLogTags.BACKUP_AGENT_FAILURE, packageName, e.toString());
Dan Egnorbb9001c2009-07-27 12:20:13 -07001285 backupDataName.delete();
1286 newStateName.delete();
Christopher Tated55e18a2009-09-21 10:12:59 -07001287 return BackupConstants.TRANSPORT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001288 } finally {
1289 try { if (savedState != null) savedState.close(); } catch (IOException e) {}
1290 try { if (backupData != null) backupData.close(); } catch (IOException e) {}
1291 try { if (newState != null) newState.close(); } catch (IOException e) {}
1292 savedState = backupData = newState = null;
Christopher Tate44a27902010-01-27 17:15:49 -08001293 synchronized (mCurrentOpLock) {
1294 mCurrentOperations.clear();
1295 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001296 }
1297
1298 // Now propagate the newly-backed-up data to the transport
Dan Egnor01445162009-09-21 17:04:05 -07001299 int result = BackupConstants.TRANSPORT_OK;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001300 try {
1301 int size = (int) backupDataName.length();
1302 if (size > 0) {
Dan Egnor01445162009-09-21 17:04:05 -07001303 if (result == BackupConstants.TRANSPORT_OK) {
1304 backupData = ParcelFileDescriptor.open(backupDataName,
1305 ParcelFileDescriptor.MODE_READ_ONLY);
1306 result = transport.performBackup(packInfo, backupData);
1307 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001308
Dan Egnor83861e72009-09-17 16:17:55 -07001309 // TODO - We call finishBackup() for each application backed up, because
1310 // we need to know now whether it succeeded or failed. Instead, we should
1311 // hold off on finishBackup() until the end, which implies holding off on
1312 // renaming *all* the output state files (see below) until that happens.
1313
Dan Egnor01445162009-09-21 17:04:05 -07001314 if (result == BackupConstants.TRANSPORT_OK) {
1315 result = transport.finishBackup();
Dan Egnor83861e72009-09-17 16:17:55 -07001316 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001317 } else {
1318 if (DEBUG) Log.i(TAG, "no backup data written; not calling transport");
1319 }
1320
1321 // After successful transport, delete the now-stale data
1322 // and juggle the files so that next time we supply the agent
1323 // with the new state file it just created.
Dan Egnor01445162009-09-21 17:04:05 -07001324 if (result == BackupConstants.TRANSPORT_OK) {
1325 backupDataName.delete();
1326 newStateName.renameTo(savedStateName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001327 EventLog.writeEvent(EventLogTags.BACKUP_PACKAGE, packageName, size);
Dan Egnor01445162009-09-21 17:04:05 -07001328 } else {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001329 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, packageName);
Dan Egnor01445162009-09-21 17:04:05 -07001330 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001331 } catch (Exception e) {
1332 Log.e(TAG, "Transport error backing up " + packageName, e);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001333 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, packageName);
Dan Egnor01445162009-09-21 17:04:05 -07001334 result = BackupConstants.TRANSPORT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001335 } finally {
1336 try { if (backupData != null) backupData.close(); } catch (IOException e) {}
Christopher Tatec7b31e32009-06-10 15:49:30 -07001337 }
Christopher Tated55e18a2009-09-21 10:12:59 -07001338
Dan Egnor01445162009-09-21 17:04:05 -07001339 return result;
Christopher Tatec7b31e32009-06-10 15:49:30 -07001340 }
Christopher Tate043dadc2009-06-02 16:11:00 -07001341 }
1342
Christopher Tatedf01dea2009-06-09 20:45:02 -07001343
1344 // ----- Restore handling -----
1345
Christopher Tate78dd4a72009-11-04 11:49:08 -08001346 private boolean signaturesMatch(Signature[] storedSigs, PackageInfo target) {
1347 // If the target resides on the system partition, we allow it to restore
1348 // data from the like-named package in a restore set even if the signatures
1349 // do not match. (Unlike general applications, those flashed to the system
1350 // partition will be signed with the device's platform certificate, so on
1351 // different phones the same system app will have different signatures.)
1352 if ((target.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
1353 if (DEBUG) Log.v(TAG, "System app " + target.packageName + " - skipping sig check");
1354 return true;
1355 }
1356
Christopher Tate20efdf6b2009-06-18 19:41:36 -07001357 // Allow unsigned apps, but not signed on one device and unsigned on the other
1358 // !!! TODO: is this the right policy?
Christopher Tate78dd4a72009-11-04 11:49:08 -08001359 Signature[] deviceSigs = target.signatures;
Christopher Tate6aa41f42009-06-19 14:14:22 -07001360 if (DEBUG) Log.v(TAG, "signaturesMatch(): stored=" + storedSigs
1361 + " device=" + deviceSigs);
Christopher Tate20efdf6b2009-06-18 19:41:36 -07001362 if ((storedSigs == null || storedSigs.length == 0)
1363 && (deviceSigs == null || deviceSigs.length == 0)) {
1364 return true;
1365 }
1366 if (storedSigs == null || deviceSigs == null) {
1367 return false;
1368 }
1369
Christopher Tateabce4e82009-06-18 18:35:32 -07001370 // !!! TODO: this demands that every stored signature match one
1371 // that is present on device, and does not demand the converse.
1372 // Is this this right policy?
1373 int nStored = storedSigs.length;
1374 int nDevice = deviceSigs.length;
1375
1376 for (int i=0; i < nStored; i++) {
1377 boolean match = false;
1378 for (int j=0; j < nDevice; j++) {
1379 if (storedSigs[i].equals(deviceSigs[j])) {
1380 match = true;
1381 break;
1382 }
1383 }
1384 if (!match) {
1385 return false;
1386 }
1387 }
1388 return true;
1389 }
1390
Christopher Tate44a27902010-01-27 17:15:49 -08001391 class PerformRestoreTask implements Runnable {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001392 private IBackupTransport mTransport;
Christopher Tate7d562ec2009-06-25 18:03:43 -07001393 private IRestoreObserver mObserver;
Dan Egnor156411d2009-06-26 13:20:02 -07001394 private long mToken;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001395 private File mStateDir;
Christopher Tatedf01dea2009-06-09 20:45:02 -07001396
Christopher Tate5cbbf562009-06-22 16:44:51 -07001397 class RestoreRequest {
1398 public PackageInfo app;
1399 public int storedAppVersion;
1400
1401 RestoreRequest(PackageInfo _app, int _version) {
1402 app = _app;
1403 storedAppVersion = _version;
1404 }
1405 }
1406
Christopher Tate44a27902010-01-27 17:15:49 -08001407 PerformRestoreTask(IBackupTransport transport, IRestoreObserver observer,
Dan Egnor156411d2009-06-26 13:20:02 -07001408 long restoreSetToken) {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001409 mTransport = transport;
Joe Onorato9a5e3e12009-07-01 21:04:03 -04001410 Log.d(TAG, "PerformRestoreThread mObserver=" + mObserver);
Christopher Tate7d562ec2009-06-25 18:03:43 -07001411 mObserver = observer;
Christopher Tate9bbc21a2009-06-10 20:23:25 -07001412 mToken = restoreSetToken;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001413
1414 try {
1415 mStateDir = new File(mBaseStateDir, transport.transportDirName());
1416 } catch (RemoteException e) {
1417 // can't happen; the transport is local
1418 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001419 }
1420
Christopher Tatedf01dea2009-06-09 20:45:02 -07001421 public void run() {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001422 long startRealtime = SystemClock.elapsedRealtime();
Joe Onorato9a5e3e12009-07-01 21:04:03 -04001423 if (DEBUG) Log.v(TAG, "Beginning restore process mTransport=" + mTransport
Christopher Tatef2c321a2009-08-10 15:43:36 -07001424 + " mObserver=" + mObserver + " mToken=" + Long.toHexString(mToken));
Christopher Tatedf01dea2009-06-09 20:45:02 -07001425 /**
1426 * Restore sequence:
1427 *
Dan Egnorefe52642009-06-24 00:16:33 -07001428 * 1. get the restore set description for our identity
1429 * 2. for each app in the restore set:
Dan Egnorbb9001c2009-07-27 12:20:13 -07001430 * 2.a. if it's restorable on this device, add it to the restore queue
Dan Egnorefe52642009-06-24 00:16:33 -07001431 * 3. for each app in the restore queue:
1432 * 3.a. clear the app data
1433 * 3.b. get the restore data for the app from the transport
1434 * 3.c. launch the backup agent for the app
1435 * 3.d. agent.doRestore() with the data from the server
1436 * 3.e. unbind the agent [and kill the app?]
1437 * 4. shut down the transport
Dan Egnorbb9001c2009-07-27 12:20:13 -07001438 *
1439 * On errors, we try our best to recover and move on to the next
1440 * application, but if necessary we abort the whole operation --
1441 * the user is waiting, after al.
Christopher Tatedf01dea2009-06-09 20:45:02 -07001442 */
1443
Christopher Tate7d562ec2009-06-25 18:03:43 -07001444 int error = -1; // assume error
1445
Dan Egnorefe52642009-06-24 00:16:33 -07001446 // build the set of apps to restore
Christopher Tatedf01dea2009-06-09 20:45:02 -07001447 try {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001448 // TODO: Log this before getAvailableRestoreSets, somehow
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001449 EventLog.writeEvent(EventLogTags.RESTORE_START, mTransport.transportDirName(), mToken);
Christopher Tateabce4e82009-06-18 18:35:32 -07001450
Dan Egnorefe52642009-06-24 00:16:33 -07001451 // Get the list of all packages which have backup enabled.
1452 // (Include the Package Manager metadata pseudo-package first.)
1453 ArrayList<PackageInfo> restorePackages = new ArrayList<PackageInfo>();
1454 PackageInfo omPackage = new PackageInfo();
1455 omPackage.packageName = PACKAGE_MANAGER_SENTINEL;
1456 restorePackages.add(omPackage);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001457
Dan Egnorefe52642009-06-24 00:16:33 -07001458 List<PackageInfo> agentPackages = allAgentPackages();
1459 restorePackages.addAll(agentPackages);
1460
Christopher Tate7d562ec2009-06-25 18:03:43 -07001461 // let the observer know that we're running
1462 if (mObserver != null) {
1463 try {
1464 // !!! TODO: get an actual count from the transport after
1465 // its startRestore() runs?
1466 mObserver.restoreStarting(restorePackages.size());
1467 } catch (RemoteException e) {
1468 Log.d(TAG, "Restore observer died at restoreStarting");
1469 mObserver = null;
1470 }
1471 }
1472
Dan Egnor01445162009-09-21 17:04:05 -07001473 if (mTransport.startRestore(mToken, restorePackages.toArray(new PackageInfo[0])) !=
1474 BackupConstants.TRANSPORT_OK) {
Dan Egnorefe52642009-06-24 00:16:33 -07001475 Log.e(TAG, "Error starting restore operation");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001476 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Dan Egnorefe52642009-06-24 00:16:33 -07001477 return;
1478 }
1479
1480 String packageName = mTransport.nextRestorePackage();
1481 if (packageName == null) {
Dan Egnorefe52642009-06-24 00:16:33 -07001482 Log.e(TAG, "Error getting first restore package");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001483 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Dan Egnorefe52642009-06-24 00:16:33 -07001484 return;
1485 } else if (packageName.equals("")) {
1486 Log.i(TAG, "No restore data available");
Dan Egnorbb9001c2009-07-27 12:20:13 -07001487 int millis = (int) (SystemClock.elapsedRealtime() - startRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001488 EventLog.writeEvent(EventLogTags.RESTORE_SUCCESS, 0, millis);
Dan Egnorefe52642009-06-24 00:16:33 -07001489 return;
1490 } else if (!packageName.equals(PACKAGE_MANAGER_SENTINEL)) {
1491 Log.e(TAG, "Expected restore data for \"" + PACKAGE_MANAGER_SENTINEL
1492 + "\", found only \"" + packageName + "\"");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001493 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, PACKAGE_MANAGER_SENTINEL,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001494 "Package manager data missing");
Dan Egnorefe52642009-06-24 00:16:33 -07001495 return;
1496 }
1497
1498 // Pull the Package Manager metadata from the restore set first
1499 PackageManagerBackupAgent pmAgent = new PackageManagerBackupAgent(
1500 mPackageManager, agentPackages);
1501 processOneRestore(omPackage, 0, IBackupAgent.Stub.asInterface(pmAgent.onBind()));
1502
Christopher Tate8c032472009-07-02 14:28:47 -07001503 // Verify that the backup set includes metadata. If not, we can't do
1504 // signature/version verification etc, so we simply do not proceed with
1505 // the restore operation.
Christopher Tate3d7cd132009-07-07 14:23:07 -07001506 if (!pmAgent.hasMetadata()) {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001507 Log.e(TAG, "No restore metadata available, so not restoring settings");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001508 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, PACKAGE_MANAGER_SENTINEL,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001509 "Package manager restore metadata missing");
Christopher Tate8c032472009-07-02 14:28:47 -07001510 return;
1511 }
1512
Christopher Tate7d562ec2009-06-25 18:03:43 -07001513 int count = 0;
Dan Egnorefe52642009-06-24 00:16:33 -07001514 for (;;) {
1515 packageName = mTransport.nextRestorePackage();
Dan Egnorbb9001c2009-07-27 12:20:13 -07001516
Dan Egnorefe52642009-06-24 00:16:33 -07001517 if (packageName == null) {
Dan Egnorefe52642009-06-24 00:16:33 -07001518 Log.e(TAG, "Error getting next restore package");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001519 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Dan Egnorefe52642009-06-24 00:16:33 -07001520 return;
1521 } else if (packageName.equals("")) {
1522 break;
Christopher Tatedf01dea2009-06-09 20:45:02 -07001523 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001524
Christopher Tate7d562ec2009-06-25 18:03:43 -07001525 if (mObserver != null) {
Christopher Tate7d562ec2009-06-25 18:03:43 -07001526 try {
1527 mObserver.onUpdate(count);
1528 } catch (RemoteException e) {
1529 Log.d(TAG, "Restore observer died in onUpdate");
1530 mObserver = null;
1531 }
1532 }
1533
Dan Egnorefe52642009-06-24 00:16:33 -07001534 Metadata metaInfo = pmAgent.getRestoredMetadata(packageName);
1535 if (metaInfo == null) {
1536 Log.e(TAG, "Missing metadata for " + packageName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001537 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001538 "Package metadata missing");
Dan Egnorefe52642009-06-24 00:16:33 -07001539 continue;
1540 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001541
Dan Egnorbb9001c2009-07-27 12:20:13 -07001542 PackageInfo packageInfo;
1543 try {
1544 int flags = PackageManager.GET_SIGNATURES;
1545 packageInfo = mPackageManager.getPackageInfo(packageName, flags);
1546 } catch (NameNotFoundException e) {
1547 Log.e(TAG, "Invalid package restoring data", e);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001548 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001549 "Package missing on device");
1550 continue;
1551 }
1552
Dan Egnorefe52642009-06-24 00:16:33 -07001553 if (metaInfo.versionCode > packageInfo.versionCode) {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001554 String message = "Version " + metaInfo.versionCode
1555 + " > installed version " + packageInfo.versionCode;
1556 Log.w(TAG, "Package " + packageName + ": " + message);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001557 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName, message);
Dan Egnorefe52642009-06-24 00:16:33 -07001558 continue;
1559 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001560
Christopher Tate78dd4a72009-11-04 11:49:08 -08001561 if (!signaturesMatch(metaInfo.signatures, packageInfo)) {
Dan Egnorefe52642009-06-24 00:16:33 -07001562 Log.w(TAG, "Signature mismatch restoring " + packageName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001563 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001564 "Signature mismatch");
Dan Egnorefe52642009-06-24 00:16:33 -07001565 continue;
1566 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001567
Dan Egnorefe52642009-06-24 00:16:33 -07001568 if (DEBUG) Log.v(TAG, "Package " + packageName
1569 + " restore version [" + metaInfo.versionCode
1570 + "] is compatible with installed version ["
1571 + packageInfo.versionCode + "]");
Christopher Tatec7b31e32009-06-10 15:49:30 -07001572
Christopher Tate5e1ab332009-09-01 20:32:49 -07001573 // Now perform the actual restore: first clear the app's data
1574 // if appropriate
Dan Egnorefe52642009-06-24 00:16:33 -07001575 clearApplicationDataSynchronous(packageName);
Christopher Tate5e1ab332009-09-01 20:32:49 -07001576
1577 // Then set up and bind the agent (with a restricted Application object
1578 // unless the application says otherwise)
1579 boolean useRealApp = (packageInfo.applicationInfo.flags
1580 & ApplicationInfo.FLAG_RESTORE_NEEDS_APPLICATION) != 0;
1581 if (DEBUG && useRealApp) {
1582 Log.v(TAG, "agent requires real Application subclass for restore");
1583 }
Dan Egnorefe52642009-06-24 00:16:33 -07001584 IBackupAgent agent = bindToAgentSynchronous(
1585 packageInfo.applicationInfo,
Christopher Tate5e1ab332009-09-01 20:32:49 -07001586 (useRealApp ? IApplicationThread.BACKUP_MODE_INCREMENTAL
1587 : IApplicationThread.BACKUP_MODE_RESTORE));
Dan Egnorefe52642009-06-24 00:16:33 -07001588 if (agent == null) {
1589 Log.w(TAG, "Can't find backup agent for " + packageName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001590 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07001591 "Restore agent missing");
Dan Egnorefe52642009-06-24 00:16:33 -07001592 continue;
Christopher Tatedf01dea2009-06-09 20:45:02 -07001593 }
1594
Christopher Tate5e1ab332009-09-01 20:32:49 -07001595 // And then finally run the restore on this agent
Dan Egnorefe52642009-06-24 00:16:33 -07001596 try {
1597 processOneRestore(packageInfo, metaInfo.versionCode, agent);
Dan Egnorbb9001c2009-07-27 12:20:13 -07001598 ++count;
Dan Egnorefe52642009-06-24 00:16:33 -07001599 } finally {
Christopher Tate5e1ab332009-09-01 20:32:49 -07001600 // unbind and tidy up even on timeout or failure, just in case
Dan Egnorefe52642009-06-24 00:16:33 -07001601 mActivityManager.unbindBackupAgent(packageInfo.applicationInfo);
Christopher Tate5e1ab332009-09-01 20:32:49 -07001602
1603 // The agent was probably running with a stub Application object,
1604 // which isn't a valid run mode for the main app logic. Shut
1605 // down the app so that next time it's launched, it gets the
1606 // usual full initialization.
1607 if ((packageInfo.applicationInfo.flags
1608 & ApplicationInfo.FLAG_KILL_AFTER_RESTORE) != 0) {
1609 if (DEBUG) Log.d(TAG, "Restore complete, killing host process of "
1610 + packageInfo.applicationInfo.processName);
1611 mActivityManager.killApplicationProcess(
1612 packageInfo.applicationInfo.processName,
1613 packageInfo.applicationInfo.uid);
1614 }
Dan Egnorefe52642009-06-24 00:16:33 -07001615 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001616 }
Christopher Tate7d562ec2009-06-25 18:03:43 -07001617
1618 // if we get this far, report success to the observer
1619 error = 0;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001620 int millis = (int) (SystemClock.elapsedRealtime() - startRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001621 EventLog.writeEvent(EventLogTags.RESTORE_SUCCESS, count, millis);
Dan Egnorbb9001c2009-07-27 12:20:13 -07001622 } catch (Exception e) {
1623 Log.e(TAG, "Error in restore thread", e);
Dan Egnorefe52642009-06-24 00:16:33 -07001624 } finally {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001625 if (DEBUG) Log.d(TAG, "finishing restore mObserver=" + mObserver);
1626
Dan Egnorefe52642009-06-24 00:16:33 -07001627 try {
1628 mTransport.finishRestore();
1629 } catch (RemoteException e) {
1630 Log.e(TAG, "Error finishing restore", e);
1631 }
Christopher Tate7d562ec2009-06-25 18:03:43 -07001632
1633 if (mObserver != null) {
1634 try {
1635 mObserver.restoreFinished(error);
1636 } catch (RemoteException e) {
1637 Log.d(TAG, "Restore observer died at restoreFinished");
1638 }
1639 }
Christopher Tateb6787f22009-07-02 17:40:45 -07001640
1641 // done; we can finally release the wakelock
1642 mWakelock.release();
Christopher Tatedf01dea2009-06-09 20:45:02 -07001643 }
1644 }
1645
Dan Egnorefe52642009-06-24 00:16:33 -07001646 // Do the guts of a restore of one application, using mTransport.getRestoreData().
1647 void processOneRestore(PackageInfo app, int appVersionCode, IBackupAgent agent) {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001648 // !!! TODO: actually run the restore through mTransport
Christopher Tatec7b31e32009-06-10 15:49:30 -07001649 final String packageName = app.packageName;
1650
Dan Egnorbb9001c2009-07-27 12:20:13 -07001651 if (DEBUG) Log.d(TAG, "processOneRestore packageName=" + packageName);
Joe Onorato9a5e3e12009-07-01 21:04:03 -04001652
Christopher Tate0749dcd2009-08-13 15:13:03 -07001653 // Don't restore to unprivileged packages
1654 if (mPackageManager.checkPermission(android.Manifest.permission.BACKUP_DATA,
1655 packageName) != PackageManager.PERMISSION_GRANTED) {
1656 Log.d(TAG, "Skipping restore of unprivileged package " + packageName);
1657 }
1658
Christopher Tatec7b31e32009-06-10 15:49:30 -07001659 // !!! TODO: get the dirs from the transport
1660 File backupDataName = new File(mDataDir, packageName + ".restore");
Dan Egnorbb9001c2009-07-27 12:20:13 -07001661 File newStateName = new File(mStateDir, packageName + ".new");
1662 File savedStateName = new File(mStateDir, packageName);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001663
Dan Egnorbb9001c2009-07-27 12:20:13 -07001664 ParcelFileDescriptor backupData = null;
1665 ParcelFileDescriptor newState = null;
1666
Christopher Tate44a27902010-01-27 17:15:49 -08001667 int token = mTokenGenerator.nextInt();
Dan Egnorbb9001c2009-07-27 12:20:13 -07001668 try {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001669 // Run the transport's restore pass
Dan Egnorbb9001c2009-07-27 12:20:13 -07001670 backupData = ParcelFileDescriptor.open(backupDataName,
1671 ParcelFileDescriptor.MODE_READ_WRITE |
1672 ParcelFileDescriptor.MODE_CREATE |
1673 ParcelFileDescriptor.MODE_TRUNCATE);
1674
Dan Egnor01445162009-09-21 17:04:05 -07001675 if (mTransport.getRestoreData(backupData) != BackupConstants.TRANSPORT_OK) {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001676 Log.e(TAG, "Error getting restore data for " + packageName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001677 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Dan Egnorbb9001c2009-07-27 12:20:13 -07001678 return;
Christopher Tatec7b31e32009-06-10 15:49:30 -07001679 }
1680
1681 // Okay, we have the data. Now have the agent do the restore.
Dan Egnorbb9001c2009-07-27 12:20:13 -07001682 backupData.close();
Christopher Tatec7b31e32009-06-10 15:49:30 -07001683 backupData = ParcelFileDescriptor.open(backupDataName,
1684 ParcelFileDescriptor.MODE_READ_ONLY);
1685
Dan Egnorbb9001c2009-07-27 12:20:13 -07001686 newState = ParcelFileDescriptor.open(newStateName,
1687 ParcelFileDescriptor.MODE_READ_WRITE |
1688 ParcelFileDescriptor.MODE_CREATE |
1689 ParcelFileDescriptor.MODE_TRUNCATE);
1690
Christopher Tate44a27902010-01-27 17:15:49 -08001691 // Kick off the restore, checking for hung agents
1692 prepareOperationTimeout(token, TIMEOUT_RESTORE_INTERVAL);
1693 agent.doRestore(backupData, appVersionCode, newState, token, mBackupManagerBinder);
1694 boolean success = waitUntilOperationComplete(token);
1695
1696 if (!success) {
1697 throw new RuntimeException("restore timeout");
1698 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07001699
1700 // if everything went okay, remember the recorded state now
Christopher Tate90967f42009-09-20 15:28:33 -07001701 //
1702 // !!! TODO: the restored data should be migrated on the server
1703 // side into the current dataset. In that case the new state file
1704 // we just created would reflect the data already extant in the
1705 // backend, so there'd be nothing more to do. Until that happens,
1706 // however, we need to make sure that we record the data to the
1707 // current backend dataset. (Yes, this means shipping the data over
1708 // the wire in both directions. That's bad, but consistency comes
1709 // first, then efficiency.) Once we introduce server-side data
1710 // migration to the newly-restored device's dataset, we will change
1711 // the following from a discard of the newly-written state to the
1712 // "correct" operation of renaming into the canonical state blob.
1713 newStateName.delete(); // TODO: remove; see above comment
1714 //newStateName.renameTo(savedStateName); // TODO: replace with this
1715
Dan Egnorbb9001c2009-07-27 12:20:13 -07001716 int size = (int) backupDataName.length();
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001717 EventLog.writeEvent(EventLogTags.RESTORE_PACKAGE, packageName, size);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001718 } catch (Exception e) {
Dan Egnorbb9001c2009-07-27 12:20:13 -07001719 Log.e(TAG, "Error restoring data for " + packageName, e);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001720 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName, e.toString());
Dan Egnorbb9001c2009-07-27 12:20:13 -07001721
Christopher Tate96733042009-07-20 14:49:13 -07001722 // If the agent fails restore, it might have put the app's data
1723 // into an incoherent state. For consistency we wipe its data
1724 // again in this case before propagating the exception
Christopher Tate96733042009-07-20 14:49:13 -07001725 clearApplicationDataSynchronous(packageName);
Christopher Tate1531dc82009-07-24 16:37:43 -07001726 } finally {
1727 backupDataName.delete();
Dan Egnorbb9001c2009-07-27 12:20:13 -07001728 try { if (backupData != null) backupData.close(); } catch (IOException e) {}
1729 try { if (newState != null) newState.close(); } catch (IOException e) {}
1730 backupData = newState = null;
Christopher Tate44a27902010-01-27 17:15:49 -08001731 mCurrentOperations.delete(token);
Christopher Tatec7b31e32009-06-10 15:49:30 -07001732 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001733 }
1734 }
1735
Christopher Tate44a27902010-01-27 17:15:49 -08001736 class PerformClearTask implements Runnable {
Christopher Tateee0e78a2009-07-02 11:17:03 -07001737 IBackupTransport mTransport;
1738 PackageInfo mPackage;
1739
Christopher Tate44a27902010-01-27 17:15:49 -08001740 PerformClearTask(IBackupTransport transport, PackageInfo packageInfo) {
Christopher Tateee0e78a2009-07-02 11:17:03 -07001741 mTransport = transport;
1742 mPackage = packageInfo;
1743 }
1744
Christopher Tateee0e78a2009-07-02 11:17:03 -07001745 public void run() {
1746 try {
1747 // Clear the on-device backup state to ensure a full backup next time
1748 File stateDir = new File(mBaseStateDir, mTransport.transportDirName());
1749 File stateFile = new File(stateDir, mPackage.packageName);
1750 stateFile.delete();
1751
1752 // Tell the transport to remove all the persistent storage for the app
Christopher Tate13f4a642009-09-30 20:06:45 -07001753 // TODO - need to handle failures
Christopher Tateee0e78a2009-07-02 11:17:03 -07001754 mTransport.clearBackupData(mPackage);
1755 } catch (RemoteException e) {
1756 // can't happen; the transport is local
1757 } finally {
1758 try {
Christopher Tate13f4a642009-09-30 20:06:45 -07001759 // TODO - need to handle failures
Christopher Tateee0e78a2009-07-02 11:17:03 -07001760 mTransport.finishBackup();
1761 } catch (RemoteException e) {
1762 // can't happen; the transport is local
1763 }
Christopher Tateb6787f22009-07-02 17:40:45 -07001764
1765 // Last but not least, release the cpu
1766 mWakelock.release();
Christopher Tateee0e78a2009-07-02 11:17:03 -07001767 }
1768 }
1769 }
1770
Christopher Tate44a27902010-01-27 17:15:49 -08001771 class PerformInitializeTask implements Runnable {
Christopher Tate4cc86e12009-09-21 19:36:51 -07001772 HashSet<String> mQueue;
1773
Christopher Tate44a27902010-01-27 17:15:49 -08001774 PerformInitializeTask(HashSet<String> transportNames) {
Christopher Tate4cc86e12009-09-21 19:36:51 -07001775 mQueue = transportNames;
1776 }
1777
Christopher Tate4cc86e12009-09-21 19:36:51 -07001778 public void run() {
Christopher Tate4cc86e12009-09-21 19:36:51 -07001779 try {
1780 for (String transportName : mQueue) {
1781 IBackupTransport transport = getTransport(transportName);
1782 if (transport == null) {
1783 Log.e(TAG, "Requested init for " + transportName + " but not found");
1784 continue;
1785 }
1786
Dan Egnor726247c2009-09-29 19:12:31 -07001787 Log.i(TAG, "Initializing (wiping) backup transport storage: " + transportName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001788 EventLog.writeEvent(EventLogTags.BACKUP_START, transport.transportDirName());
Dan Egnor726247c2009-09-29 19:12:31 -07001789 long startRealtime = SystemClock.elapsedRealtime();
1790 int status = transport.initializeDevice();
Christopher Tate4cc86e12009-09-21 19:36:51 -07001791
Christopher Tate4cc86e12009-09-21 19:36:51 -07001792 if (status == BackupConstants.TRANSPORT_OK) {
1793 status = transport.finishBackup();
1794 }
1795
1796 // Okay, the wipe really happened. Clean up our local bookkeeping.
1797 if (status == BackupConstants.TRANSPORT_OK) {
Dan Egnor726247c2009-09-29 19:12:31 -07001798 Log.i(TAG, "Device init successful");
1799 int millis = (int) (SystemClock.elapsedRealtime() - startRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001800 EventLog.writeEvent(EventLogTags.BACKUP_INITIALIZE);
Dan Egnor726247c2009-09-29 19:12:31 -07001801 resetBackupState(new File(mBaseStateDir, transport.transportDirName()));
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001802 EventLog.writeEvent(EventLogTags.BACKUP_SUCCESS, 0, millis);
Christopher Tate4cc86e12009-09-21 19:36:51 -07001803 synchronized (mQueueLock) {
1804 recordInitPendingLocked(false, transportName);
1805 }
Dan Egnor726247c2009-09-29 19:12:31 -07001806 } else {
1807 // If this didn't work, requeue this one and try again
1808 // after a suitable interval
1809 Log.e(TAG, "Transport error in initializeDevice()");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001810 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, "(initialize)");
Christopher Tate4cc86e12009-09-21 19:36:51 -07001811 synchronized (mQueueLock) {
1812 recordInitPendingLocked(true, transportName);
1813 }
1814 // do this via another alarm to make sure of the wakelock states
1815 long delay = transport.requestBackupTime();
1816 if (DEBUG) Log.w(TAG, "init failed on "
1817 + transportName + " resched in " + delay);
1818 mAlarmManager.set(AlarmManager.RTC_WAKEUP,
1819 System.currentTimeMillis() + delay, mRunInitIntent);
Christopher Tate4cc86e12009-09-21 19:36:51 -07001820 }
Christopher Tate4cc86e12009-09-21 19:36:51 -07001821 }
1822 } catch (RemoteException e) {
1823 // can't happen; the transports are local
1824 } catch (Exception e) {
1825 Log.e(TAG, "Unexpected error performing init", e);
1826 } finally {
Christopher Tatec2af5d32010-02-02 15:18:58 -08001827 // Done; release the wakelock
Christopher Tate4cc86e12009-09-21 19:36:51 -07001828 mWakelock.release();
1829 }
1830 }
1831 }
1832
Christopher Tatedf01dea2009-06-09 20:45:02 -07001833
Christopher Tate487529a2009-04-29 14:03:25 -07001834 // ----- IBackupManager binder interface -----
Christopher Tatedf01dea2009-06-09 20:45:02 -07001835
Dan Egnor852f8e42009-09-30 11:20:45 -07001836 public void dataChanged(String packageName) {
Christopher Tate487529a2009-04-29 14:03:25 -07001837 // Record that we need a backup pass for the caller. Since multiple callers
1838 // may share a uid, we need to note all candidates within that uid and schedule
1839 // a backup pass for each of them.
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001840 EventLog.writeEvent(EventLogTags.BACKUP_DATA_CHANGED, packageName);
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07001841
Christopher Tate63d27002009-06-16 17:16:42 -07001842 // If the caller does not hold the BACKUP permission, it can only request a
1843 // backup of its own data.
1844 HashSet<ApplicationInfo> targets;
Dianne Hackborncf098292009-07-01 19:55:20 -07001845 if ((mContext.checkPermission(android.Manifest.permission.BACKUP, Binder.getCallingPid(),
Christopher Tate63d27002009-06-16 17:16:42 -07001846 Binder.getCallingUid())) == PackageManager.PERMISSION_DENIED) {
1847 targets = mBackupParticipants.get(Binder.getCallingUid());
1848 } else {
1849 // a caller with full permission can ask to back up any participating app
1850 // !!! TODO: allow backup of ANY app?
Christopher Tate63d27002009-06-16 17:16:42 -07001851 targets = new HashSet<ApplicationInfo>();
1852 int N = mBackupParticipants.size();
1853 for (int i = 0; i < N; i++) {
1854 HashSet<ApplicationInfo> s = mBackupParticipants.valueAt(i);
1855 if (s != null) {
1856 targets.addAll(s);
1857 }
1858 }
1859 }
Christopher Tate487529a2009-04-29 14:03:25 -07001860 if (targets != null) {
1861 synchronized (mQueueLock) {
1862 // Note that this client has made data changes that need to be backed up
Christopher Tate181fafa2009-05-14 11:12:14 -07001863 for (ApplicationInfo app : targets) {
Christopher Tatea8bf8152009-04-30 11:36:21 -07001864 // validate the caller-supplied package name against the known set of
1865 // packages associated with this uid
Christopher Tate181fafa2009-05-14 11:12:14 -07001866 if (app.packageName.equals(packageName)) {
Joe Onorato8ad02812009-05-13 01:41:44 -04001867 // Add the caller to the set of pending backups. If there is
1868 // one already there, then overwrite it, but no harm done.
Christopher Tate181fafa2009-05-14 11:12:14 -07001869 BackupRequest req = new BackupRequest(app, false);
Christopher Tatea7de3842009-07-07 14:50:26 -07001870 if (mPendingBackups.put(app, req) == null) {
1871 // Journal this request in case of crash. The put()
1872 // operation returned null when this package was not already
1873 // in the set; we want to avoid touching the disk redundantly.
1874 writeToJournalLocked(packageName);
Christopher Tate487529a2009-04-29 14:03:25 -07001875
Christopher Tate22b60d82009-07-07 16:36:02 -07001876 if (DEBUG) {
1877 int numKeys = mPendingBackups.size();
1878 Log.d(TAG, "Now awaiting backup for " + numKeys + " participants:");
1879 for (BackupRequest b : mPendingBackups.values()) {
1880 Log.d(TAG, " + " + b + " agent=" + b.appInfo.backupAgentName);
1881 }
1882 }
1883 }
Christopher Tate181fafa2009-05-14 11:12:14 -07001884 }
1885 }
Christopher Tate487529a2009-04-29 14:03:25 -07001886 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07001887 } else {
Christopher Tate73e02522009-07-15 14:18:26 -07001888 Log.w(TAG, "dataChanged but no participant pkg='" + packageName + "'"
1889 + " uid=" + Binder.getCallingUid());
Christopher Tate487529a2009-04-29 14:03:25 -07001890 }
1891 }
Christopher Tate46758122009-05-06 11:22:00 -07001892
Christopher Tatecde87f42009-06-12 12:55:53 -07001893 private void writeToJournalLocked(String str) {
Dan Egnor852f8e42009-09-30 11:20:45 -07001894 RandomAccessFile out = null;
1895 try {
1896 if (mJournal == null) mJournal = File.createTempFile("journal", null, mJournalDir);
1897 out = new RandomAccessFile(mJournal, "rws");
1898 out.seek(out.length());
1899 out.writeUTF(str);
1900 } catch (IOException e) {
1901 Log.e(TAG, "Can't write " + str + " to backup journal", e);
1902 mJournal = null;
1903 } finally {
1904 try { if (out != null) out.close(); } catch (IOException e) {}
Christopher Tatecde87f42009-06-12 12:55:53 -07001905 }
1906 }
1907
Christopher Tateee0e78a2009-07-02 11:17:03 -07001908 // Clear the given package's backup data from the current transport
1909 public void clearBackupData(String packageName) {
1910 if (DEBUG) Log.v(TAG, "clearBackupData() of " + packageName);
1911 PackageInfo info;
1912 try {
1913 info = mPackageManager.getPackageInfo(packageName, PackageManager.GET_SIGNATURES);
1914 } catch (NameNotFoundException e) {
1915 Log.d(TAG, "No such package '" + packageName + "' - not clearing backup data");
1916 return;
1917 }
1918
1919 // If the caller does not hold the BACKUP permission, it can only request a
1920 // wipe of its own backed-up data.
1921 HashSet<ApplicationInfo> apps;
Christopher Tate4e3e50c2009-07-02 12:14:05 -07001922 if ((mContext.checkPermission(android.Manifest.permission.BACKUP, Binder.getCallingPid(),
Christopher Tateee0e78a2009-07-02 11:17:03 -07001923 Binder.getCallingUid())) == PackageManager.PERMISSION_DENIED) {
1924 apps = mBackupParticipants.get(Binder.getCallingUid());
1925 } else {
1926 // a caller with full permission can ask to back up any participating app
1927 // !!! TODO: allow data-clear of ANY app?
1928 if (DEBUG) Log.v(TAG, "Privileged caller, allowing clear of other apps");
1929 apps = new HashSet<ApplicationInfo>();
1930 int N = mBackupParticipants.size();
1931 for (int i = 0; i < N; i++) {
1932 HashSet<ApplicationInfo> s = mBackupParticipants.valueAt(i);
1933 if (s != null) {
1934 apps.addAll(s);
1935 }
1936 }
1937 }
1938
1939 // now find the given package in the set of candidate apps
1940 for (ApplicationInfo app : apps) {
1941 if (app.packageName.equals(packageName)) {
1942 if (DEBUG) Log.v(TAG, "Found the app - running clear process");
1943 // found it; fire off the clear request
1944 synchronized (mQueueLock) {
Christopher Tateaa93b042009-08-05 18:21:40 -07001945 long oldId = Binder.clearCallingIdentity();
Christopher Tateb6787f22009-07-02 17:40:45 -07001946 mWakelock.acquire();
Christopher Tateee0e78a2009-07-02 11:17:03 -07001947 Message msg = mBackupHandler.obtainMessage(MSG_RUN_CLEAR,
1948 new ClearParams(getTransport(mCurrentTransport), info));
1949 mBackupHandler.sendMessage(msg);
Christopher Tateaa93b042009-08-05 18:21:40 -07001950 Binder.restoreCallingIdentity(oldId);
Christopher Tateee0e78a2009-07-02 11:17:03 -07001951 }
1952 break;
1953 }
1954 }
1955 }
1956
Christopher Tateace7f092009-06-15 18:07:25 -07001957 // Run a backup pass immediately for any applications that have declared
1958 // that they have pending updates.
Dan Egnor852f8e42009-09-30 11:20:45 -07001959 public void backupNow() {
Joe Onorato5933a492009-07-23 18:24:08 -04001960 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "backupNow");
Christopher Tate043dadc2009-06-02 16:11:00 -07001961
Christopher Tateace7f092009-06-15 18:07:25 -07001962 if (DEBUG) Log.v(TAG, "Scheduling immediate backup pass");
Christopher Tate46758122009-05-06 11:22:00 -07001963 synchronized (mQueueLock) {
Christopher Tate21ab6a52009-09-24 18:01:46 -07001964 // Because the alarms we are using can jitter, and we want an *immediate*
1965 // backup pass to happen, we restart the timer beginning with "next time,"
1966 // then manually fire the backup trigger intent ourselves.
1967 startBackupAlarmsLocked(BACKUP_INTERVAL);
Christopher Tateb6787f22009-07-02 17:40:45 -07001968 try {
Christopher Tateb6787f22009-07-02 17:40:45 -07001969 mRunBackupIntent.send();
1970 } catch (PendingIntent.CanceledException e) {
1971 // should never happen
1972 Log.e(TAG, "run-backup intent cancelled!");
1973 }
Christopher Tate46758122009-05-06 11:22:00 -07001974 }
1975 }
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07001976
Christopher Tate8031a3d2009-07-06 16:36:05 -07001977 // Enable/disable the backup service
Christopher Tate6ef58a12009-06-29 14:56:28 -07001978 public void setBackupEnabled(boolean enable) {
Christopher Tateb6787f22009-07-02 17:40:45 -07001979 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
1980 "setBackupEnabled");
Christopher Tate6ef58a12009-06-29 14:56:28 -07001981
Christopher Tate4cc86e12009-09-21 19:36:51 -07001982 Log.i(TAG, "Backup enabled => " + enable);
1983
Christopher Tate6ef58a12009-06-29 14:56:28 -07001984 boolean wasEnabled = mEnabled;
1985 synchronized (this) {
Dianne Hackborncf098292009-07-01 19:55:20 -07001986 Settings.Secure.putInt(mContext.getContentResolver(),
1987 Settings.Secure.BACKUP_ENABLED, enable ? 1 : 0);
Christopher Tate6ef58a12009-06-29 14:56:28 -07001988 mEnabled = enable;
1989 }
1990
Christopher Tate49401dd2009-07-01 12:34:29 -07001991 synchronized (mQueueLock) {
Christopher Tate8031a3d2009-07-06 16:36:05 -07001992 if (enable && !wasEnabled && mProvisioned) {
Christopher Tate49401dd2009-07-01 12:34:29 -07001993 // if we've just been enabled, start scheduling backup passes
Christopher Tate8031a3d2009-07-06 16:36:05 -07001994 startBackupAlarmsLocked(BACKUP_INTERVAL);
Christopher Tate49401dd2009-07-01 12:34:29 -07001995 } else if (!enable) {
Christopher Tateb6787f22009-07-02 17:40:45 -07001996 // No longer enabled, so stop running backups
Christopher Tate4cc86e12009-09-21 19:36:51 -07001997 if (DEBUG) Log.i(TAG, "Opting out of backup");
1998
Christopher Tateb6787f22009-07-02 17:40:45 -07001999 mAlarmManager.cancel(mRunBackupIntent);
Christopher Tate4cc86e12009-09-21 19:36:51 -07002000
2001 // This also constitutes an opt-out, so we wipe any data for
2002 // this device from the backend. We start that process with
2003 // an alarm in order to guarantee wakelock states.
2004 if (wasEnabled && mProvisioned) {
2005 // NOTE: we currently flush every registered transport, not just
2006 // the currently-active one.
2007 HashSet<String> allTransports;
2008 synchronized (mTransports) {
2009 allTransports = new HashSet<String>(mTransports.keySet());
2010 }
2011 // build the set of transports for which we are posting an init
2012 for (String transport : allTransports) {
2013 recordInitPendingLocked(true, transport);
2014 }
2015 mAlarmManager.set(AlarmManager.RTC_WAKEUP, System.currentTimeMillis(),
2016 mRunInitIntent);
2017 }
Christopher Tate6ef58a12009-06-29 14:56:28 -07002018 }
2019 }
Christopher Tate49401dd2009-07-01 12:34:29 -07002020 }
Christopher Tate6ef58a12009-06-29 14:56:28 -07002021
Christopher Tate8031a3d2009-07-06 16:36:05 -07002022 // Mark the backup service as having been provisioned
2023 public void setBackupProvisioned(boolean available) {
2024 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
2025 "setBackupProvisioned");
2026
2027 boolean wasProvisioned = mProvisioned;
2028 synchronized (this) {
2029 Settings.Secure.putInt(mContext.getContentResolver(),
2030 Settings.Secure.BACKUP_PROVISIONED, available ? 1 : 0);
2031 mProvisioned = available;
2032 }
2033
2034 synchronized (mQueueLock) {
2035 if (available && !wasProvisioned && mEnabled) {
2036 // we're now good to go, so start the backup alarms
2037 startBackupAlarmsLocked(FIRST_BACKUP_INTERVAL);
2038 } else if (!available) {
2039 // No longer enabled, so stop running backups
2040 Log.w(TAG, "Backup service no longer provisioned");
2041 mAlarmManager.cancel(mRunBackupIntent);
2042 }
2043 }
2044 }
2045
2046 private void startBackupAlarmsLocked(long delayBeforeFirstBackup) {
Dan Egnorc1c49c02009-10-30 17:35:39 -07002047 // We used to use setInexactRepeating(), but that may be linked to
2048 // backups running at :00 more often than not, creating load spikes.
2049 // Schedule at an exact time for now, and also add a bit of "fuzz".
2050
2051 Random random = new Random();
2052 long when = System.currentTimeMillis() + delayBeforeFirstBackup +
2053 random.nextInt(FUZZ_MILLIS);
2054 mAlarmManager.setRepeating(AlarmManager.RTC_WAKEUP, when,
2055 BACKUP_INTERVAL + random.nextInt(FUZZ_MILLIS), mRunBackupIntent);
Christopher Tate55f931a2009-09-29 17:17:34 -07002056 mNextBackupPass = when;
Christopher Tate8031a3d2009-07-06 16:36:05 -07002057 }
2058
Christopher Tate6ef58a12009-06-29 14:56:28 -07002059 // Report whether the backup mechanism is currently enabled
2060 public boolean isBackupEnabled() {
Joe Onorato5933a492009-07-23 18:24:08 -04002061 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "isBackupEnabled");
Christopher Tate6ef58a12009-06-29 14:56:28 -07002062 return mEnabled; // no need to synchronize just to read it
2063 }
2064
Christopher Tate91717492009-06-26 21:07:13 -07002065 // Report the name of the currently active transport
2066 public String getCurrentTransport() {
Joe Onorato5933a492009-07-23 18:24:08 -04002067 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate4e3e50c2009-07-02 12:14:05 -07002068 "getCurrentTransport");
Joe Onorato9a5e3e12009-07-01 21:04:03 -04002069 Log.v(TAG, "... getCurrentTransport() returning " + mCurrentTransport);
Christopher Tate91717492009-06-26 21:07:13 -07002070 return mCurrentTransport;
Christopher Tateace7f092009-06-15 18:07:25 -07002071 }
2072
Christopher Tate91717492009-06-26 21:07:13 -07002073 // Report all known, available backup transports
2074 public String[] listAllTransports() {
Christopher Tate34ebd0e2009-07-06 15:44:54 -07002075 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "listAllTransports");
Christopher Tate043dadc2009-06-02 16:11:00 -07002076
Christopher Tate91717492009-06-26 21:07:13 -07002077 String[] list = null;
2078 ArrayList<String> known = new ArrayList<String>();
2079 for (Map.Entry<String, IBackupTransport> entry : mTransports.entrySet()) {
2080 if (entry.getValue() != null) {
2081 known.add(entry.getKey());
2082 }
2083 }
2084
2085 if (known.size() > 0) {
2086 list = new String[known.size()];
2087 known.toArray(list);
2088 }
2089 return list;
2090 }
2091
2092 // Select which transport to use for the next backup operation. If the given
2093 // name is not one of the available transports, no action is taken and the method
2094 // returns null.
2095 public String selectBackupTransport(String transport) {
Joe Onorato5933a492009-07-23 18:24:08 -04002096 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "selectBackupTransport");
Christopher Tate91717492009-06-26 21:07:13 -07002097
2098 synchronized (mTransports) {
2099 String prevTransport = null;
2100 if (mTransports.get(transport) != null) {
2101 prevTransport = mCurrentTransport;
2102 mCurrentTransport = transport;
Dianne Hackborncf098292009-07-01 19:55:20 -07002103 Settings.Secure.putString(mContext.getContentResolver(),
2104 Settings.Secure.BACKUP_TRANSPORT, transport);
Christopher Tate91717492009-06-26 21:07:13 -07002105 Log.v(TAG, "selectBackupTransport() set " + mCurrentTransport
2106 + " returning " + prevTransport);
2107 } else {
2108 Log.w(TAG, "Attempt to select unavailable transport " + transport);
2109 }
2110 return prevTransport;
2111 }
Christopher Tate043dadc2009-06-02 16:11:00 -07002112 }
2113
2114 // Callback: a requested backup agent has been instantiated. This should only
2115 // be called from the Activity Manager.
Christopher Tate181fafa2009-05-14 11:12:14 -07002116 public void agentConnected(String packageName, IBinder agentBinder) {
Christopher Tate043dadc2009-06-02 16:11:00 -07002117 synchronized(mAgentConnectLock) {
2118 if (Binder.getCallingUid() == Process.SYSTEM_UID) {
2119 Log.d(TAG, "agentConnected pkg=" + packageName + " agent=" + agentBinder);
2120 IBackupAgent agent = IBackupAgent.Stub.asInterface(agentBinder);
2121 mConnectedAgent = agent;
2122 mConnecting = false;
2123 } else {
2124 Log.w(TAG, "Non-system process uid=" + Binder.getCallingUid()
2125 + " claiming agent connected");
2126 }
2127 mAgentConnectLock.notifyAll();
2128 }
Christopher Tate181fafa2009-05-14 11:12:14 -07002129 }
2130
2131 // Callback: a backup agent has failed to come up, or has unexpectedly quit.
2132 // If the agent failed to come up in the first place, the agentBinder argument
Christopher Tate043dadc2009-06-02 16:11:00 -07002133 // will be null. This should only be called from the Activity Manager.
Christopher Tate181fafa2009-05-14 11:12:14 -07002134 public void agentDisconnected(String packageName) {
2135 // TODO: handle backup being interrupted
Christopher Tate043dadc2009-06-02 16:11:00 -07002136 synchronized(mAgentConnectLock) {
2137 if (Binder.getCallingUid() == Process.SYSTEM_UID) {
2138 mConnectedAgent = null;
2139 mConnecting = false;
2140 } else {
2141 Log.w(TAG, "Non-system process uid=" + Binder.getCallingUid()
2142 + " claiming agent disconnected");
2143 }
2144 mAgentConnectLock.notifyAll();
2145 }
Christopher Tate181fafa2009-05-14 11:12:14 -07002146 }
Christopher Tate181fafa2009-05-14 11:12:14 -07002147
Christopher Tate8c850b72009-06-07 19:33:20 -07002148 // Hand off a restore session
Christopher Tate91717492009-06-26 21:07:13 -07002149 public IRestoreSession beginRestoreSession(String transport) {
Joe Onorato5933a492009-07-23 18:24:08 -04002150 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "beginRestoreSession");
Christopher Tatef68eb502009-06-16 11:02:01 -07002151
2152 synchronized(this) {
2153 if (mActiveRestoreSession != null) {
2154 Log.d(TAG, "Restore session requested but one already active");
2155 return null;
2156 }
Christopher Tate80202c82010-01-25 19:37:47 -08002157 mActiveRestoreSession = new ActiveRestoreSession(transport);
Christopher Tatef68eb502009-06-16 11:02:01 -07002158 }
2159 return mActiveRestoreSession;
Christopher Tate8c850b72009-06-07 19:33:20 -07002160 }
Christopher Tate043dadc2009-06-02 16:11:00 -07002161
Christopher Tate44a27902010-01-27 17:15:49 -08002162 // Note that a currently-active backup agent has notified us that it has
2163 // completed the given outstanding asynchronous backup/restore operation.
2164 public void opComplete(int token) {
2165 synchronized (mCurrentOpLock) {
2166 if (DEBUG) Log.v(TAG, "opComplete: " + token);
2167 mCurrentOperations.put(token, OP_ACKNOWLEDGED);
2168 mCurrentOpLock.notifyAll();
2169 }
2170 }
2171
Christopher Tate9b3905c2009-06-08 15:24:01 -07002172 // ----- Restore session -----
2173
Christopher Tate80202c82010-01-25 19:37:47 -08002174 class ActiveRestoreSession extends IRestoreSession.Stub {
Christopher Tatef68eb502009-06-16 11:02:01 -07002175 private static final String TAG = "RestoreSession";
2176
Christopher Tate9b3905c2009-06-08 15:24:01 -07002177 private IBackupTransport mRestoreTransport = null;
2178 RestoreSet[] mRestoreSets = null;
2179
Christopher Tate80202c82010-01-25 19:37:47 -08002180 ActiveRestoreSession(String transport) {
Christopher Tate91717492009-06-26 21:07:13 -07002181 mRestoreTransport = getTransport(transport);
Christopher Tate9b3905c2009-06-08 15:24:01 -07002182 }
2183
2184 // --- Binder interface ---
Dan Egnor0084da52009-07-29 12:57:16 -07002185 public synchronized RestoreSet[] getAvailableRestoreSets() {
Joe Onorato5933a492009-07-23 18:24:08 -04002186 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate9bbc21a2009-06-10 20:23:25 -07002187 "getAvailableRestoreSets");
2188
Christopher Tatef68eb502009-06-16 11:02:01 -07002189 try {
Christopher Tate43383042009-07-13 15:17:13 -07002190 if (mRestoreTransport == null) {
2191 Log.w(TAG, "Null transport getting restore sets");
Dan Egnor0084da52009-07-29 12:57:16 -07002192 return null;
2193 }
2194 if (mRestoreSets == null) { // valid transport; do the one-time fetch
Christopher Tate9b3905c2009-06-08 15:24:01 -07002195 mRestoreSets = mRestoreTransport.getAvailableRestoreSets();
Doug Zongkerab5c49c2009-12-04 10:31:43 -08002196 if (mRestoreSets == null) EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Christopher Tate9b3905c2009-06-08 15:24:01 -07002197 }
2198 return mRestoreSets;
Dan Egnor0084da52009-07-29 12:57:16 -07002199 } catch (Exception e) {
2200 Log.e(TAG, "Error in getAvailableRestoreSets", e);
2201 return null;
Christopher Tatef68eb502009-06-16 11:02:01 -07002202 }
Christopher Tate9b3905c2009-06-08 15:24:01 -07002203 }
2204
Dan Egnor0084da52009-07-29 12:57:16 -07002205 public synchronized int performRestore(long token, IRestoreObserver observer) {
2206 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
2207 "performRestore");
Christopher Tate9bbc21a2009-06-10 20:23:25 -07002208
Christopher Tatef2c321a2009-08-10 15:43:36 -07002209 if (DEBUG) Log.d(TAG, "performRestore token=" + Long.toHexString(token)
2210 + " observer=" + observer);
Joe Onorato9a5e3e12009-07-01 21:04:03 -04002211
Dan Egnor0084da52009-07-29 12:57:16 -07002212 if (mRestoreTransport == null || mRestoreSets == null) {
2213 Log.e(TAG, "Ignoring performRestore() with no restore set");
2214 return -1;
2215 }
2216
Christopher Tate21ab6a52009-09-24 18:01:46 -07002217 synchronized (mQueueLock) {
Christopher Tate21ab6a52009-09-24 18:01:46 -07002218 for (int i = 0; i < mRestoreSets.length; i++) {
2219 if (token == mRestoreSets[i].token) {
2220 long oldId = Binder.clearCallingIdentity();
Christopher Tate21ab6a52009-09-24 18:01:46 -07002221 mWakelock.acquire();
2222 Message msg = mBackupHandler.obtainMessage(MSG_RUN_RESTORE);
2223 msg.obj = new RestoreParams(mRestoreTransport, observer, token);
2224 mBackupHandler.sendMessage(msg);
2225 Binder.restoreCallingIdentity(oldId);
2226 return 0;
2227 }
Christopher Tate9bbc21a2009-06-10 20:23:25 -07002228 }
2229 }
Christopher Tate0e0b4ae2009-08-10 16:13:47 -07002230
2231 Log.w(TAG, "Restore token " + Long.toHexString(token) + " not found");
Christopher Tate9b3905c2009-06-08 15:24:01 -07002232 return -1;
2233 }
2234
Dan Egnor0084da52009-07-29 12:57:16 -07002235 public synchronized void endRestoreSession() {
Joe Onorato5933a492009-07-23 18:24:08 -04002236 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate9bbc21a2009-06-10 20:23:25 -07002237 "endRestoreSession");
2238
Dan Egnor0084da52009-07-29 12:57:16 -07002239 if (DEBUG) Log.d(TAG, "endRestoreSession");
Joe Onorato9a5e3e12009-07-01 21:04:03 -04002240
Dan Egnor0084da52009-07-29 12:57:16 -07002241 synchronized (this) {
2242 try {
2243 if (mRestoreTransport != null) mRestoreTransport.finishRestore();
2244 } catch (Exception e) {
2245 Log.e(TAG, "Error in finishRestore", e);
2246 } finally {
2247 mRestoreTransport = null;
2248 }
2249 }
2250
2251 synchronized (BackupManagerService.this) {
Christopher Tatef68eb502009-06-16 11:02:01 -07002252 if (BackupManagerService.this.mActiveRestoreSession == this) {
2253 BackupManagerService.this.mActiveRestoreSession = null;
2254 } else {
2255 Log.e(TAG, "ending non-current restore session");
2256 }
2257 }
Christopher Tate9b3905c2009-06-08 15:24:01 -07002258 }
2259 }
2260
Christopher Tate043dadc2009-06-02 16:11:00 -07002261
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07002262 @Override
2263 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
2264 synchronized (mQueueLock) {
Christopher Tate8031a3d2009-07-06 16:36:05 -07002265 pw.println("Backup Manager is " + (mEnabled ? "enabled" : "disabled")
Christopher Tate55f931a2009-09-29 17:17:34 -07002266 + " / " + (!mProvisioned ? "not " : "") + "provisioned / "
Christopher Tatec2af5d32010-02-02 15:18:58 -08002267 + (this.mPendingInits.size() == 0 ? "not " : "") + "pending init");
Christopher Tate55f931a2009-09-29 17:17:34 -07002268 pw.println("Last backup pass: " + mLastBackupPass
2269 + " (now = " + System.currentTimeMillis() + ')');
2270 pw.println(" next scheduled: " + mNextBackupPass);
2271
Christopher Tate91717492009-06-26 21:07:13 -07002272 pw.println("Available transports:");
2273 for (String t : listAllTransports()) {
Dan Egnor852f8e42009-09-30 11:20:45 -07002274 pw.println((t.equals(mCurrentTransport) ? " * " : " ") + t);
2275 try {
2276 File dir = new File(mBaseStateDir, getTransport(t).transportDirName());
2277 for (File f : dir.listFiles()) {
2278 pw.println(" " + f.getName() + " - " + f.length() + " state bytes");
2279 }
2280 } catch (RemoteException e) {
2281 Log.e(TAG, "Error in transportDirName()", e);
2282 pw.println(" Error: " + e);
2283 }
Christopher Tate91717492009-06-26 21:07:13 -07002284 }
Christopher Tate55f931a2009-09-29 17:17:34 -07002285
2286 pw.println("Pending init: " + mPendingInits.size());
2287 for (String s : mPendingInits) {
2288 pw.println(" " + s);
2289 }
2290
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07002291 int N = mBackupParticipants.size();
Christopher Tate55f931a2009-09-29 17:17:34 -07002292 pw.println("Participants:");
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07002293 for (int i=0; i<N; i++) {
2294 int uid = mBackupParticipants.keyAt(i);
2295 pw.print(" uid: ");
2296 pw.println(uid);
Christopher Tate181fafa2009-05-14 11:12:14 -07002297 HashSet<ApplicationInfo> participants = mBackupParticipants.valueAt(i);
2298 for (ApplicationInfo app: participants) {
Christopher Tate55f931a2009-09-29 17:17:34 -07002299 pw.println(" " + app.packageName);
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07002300 }
2301 }
Christopher Tate55f931a2009-09-29 17:17:34 -07002302
Christopher Tate73e02522009-07-15 14:18:26 -07002303 pw.println("Ever backed up: " + mEverStoredApps.size());
2304 for (String pkg : mEverStoredApps) {
2305 pw.println(" " + pkg);
2306 }
Christopher Tate55f931a2009-09-29 17:17:34 -07002307
2308 pw.println("Pending backup: " + mPendingBackups.size());
Christopher Tate6aa41f42009-06-19 14:14:22 -07002309 for (BackupRequest req : mPendingBackups.values()) {
Christopher Tate6ef58a12009-06-29 14:56:28 -07002310 pw.println(" " + req);
Christopher Tate181fafa2009-05-14 11:12:14 -07002311 }
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07002312 }
2313 }
Christopher Tate487529a2009-04-29 14:03:25 -07002314}