blob: a7b08f5b57fb1693e7ed521f042af93d802cc346 [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;
Dianne Hackborn01e4cfc2010-06-24 15:07:24 -070021import android.app.AppGlobals;
Christopher Tate181fafa2009-05-14 11:12:14 -070022import android.app.IActivityManager;
23import android.app.IApplicationThread;
24import android.app.IBackupAgent;
Christopher Tateb6787f22009-07-02 17:40:45 -070025import android.app.PendingIntent;
Christopher Tate79ec80d2011-06-24 14:58:49 -070026import android.app.backup.BackupAgent;
Christopher Tate4a627c72011-04-01 14:43:32 -070027import android.app.backup.BackupDataOutput;
28import android.app.backup.FullBackup;
Jason parksa3cdaa52011-01-13 14:15:43 -060029import android.app.backup.RestoreSet;
Christopher Tate45281862010-03-05 15:46:30 -080030import android.app.backup.IBackupManager;
Christopher Tate4a627c72011-04-01 14:43:32 -070031import android.app.backup.IFullBackupRestoreObserver;
Christopher Tate45281862010-03-05 15:46:30 -080032import android.app.backup.IRestoreObserver;
33import android.app.backup.IRestoreSession;
Christopher Tate4a627c72011-04-01 14:43:32 -070034import android.content.ActivityNotFoundException;
Christopher Tate3799bc22009-05-06 16:13:56 -070035import android.content.BroadcastReceiver;
Dan Egnor87a02bc2009-06-17 02:30:10 -070036import android.content.ComponentName;
Christopher Tated2c0cd42011-09-15 15:51:29 -070037import android.content.ContentResolver;
Christopher Tate487529a2009-04-29 14:03:25 -070038import android.content.Context;
39import android.content.Intent;
Christopher Tate3799bc22009-05-06 16:13:56 -070040import android.content.IntentFilter;
Dan Egnor87a02bc2009-06-17 02:30:10 -070041import android.content.ServiceConnection;
Christopher Tate181fafa2009-05-14 11:12:14 -070042import android.content.pm.ApplicationInfo;
Christopher Tatec7b31e32009-06-10 15:49:30 -070043import android.content.pm.IPackageDataObserver;
Christopher Tatea858cb02011-06-03 12:27:51 -070044import android.content.pm.IPackageDeleteObserver;
Christopher Tate75a99702011-05-18 16:28:19 -070045import android.content.pm.IPackageInstallObserver;
Christopher Tate1bb69062010-02-19 17:02:12 -080046import android.content.pm.IPackageManager;
Christopher Tate7b881282009-06-07 13:52:37 -070047import android.content.pm.PackageInfo;
Dan Egnor87a02bc2009-06-17 02:30:10 -070048import android.content.pm.PackageManager;
Jason parks1125d782011-01-12 09:47:26 -060049import android.content.pm.Signature;
Jason parksa3cdaa52011-01-13 14:15:43 -060050import android.content.pm.PackageManager.NameNotFoundException;
Christopher Tate3799bc22009-05-06 16:13:56 -070051import android.net.Uri;
Christopher Tate487529a2009-04-29 14:03:25 -070052import android.os.Binder;
Christopher Tate75a99702011-05-18 16:28:19 -070053import android.os.Build;
Christopher Tate3799bc22009-05-06 16:13:56 -070054import android.os.Bundle;
Christopher Tate22b87872009-05-04 16:41:53 -070055import android.os.Environment;
Christopher Tate487529a2009-04-29 14:03:25 -070056import android.os.Handler;
Christopher Tate44a27902010-01-27 17:15:49 -080057import android.os.HandlerThread;
Christopher Tate487529a2009-04-29 14:03:25 -070058import android.os.IBinder;
Christopher Tate44a27902010-01-27 17:15:49 -080059import android.os.Looper;
Christopher Tate487529a2009-04-29 14:03:25 -070060import android.os.Message;
Christopher Tate22b87872009-05-04 16:41:53 -070061import android.os.ParcelFileDescriptor;
Christopher Tateb6787f22009-07-02 17:40:45 -070062import android.os.PowerManager;
Christopher Tate043dadc2009-06-02 16:11:00 -070063import android.os.Process;
Christopher Tate487529a2009-04-29 14:03:25 -070064import android.os.RemoteException;
Christopher Tate32418be2011-10-10 13:51:12 -070065import android.os.ServiceManager;
Dan Egnorbb9001c2009-07-27 12:20:13 -070066import android.os.SystemClock;
Dianne Hackborn7e9f4eb2010-09-10 18:43:00 -070067import android.os.WorkSource;
Christopher Tate32418be2011-10-10 13:51:12 -070068import android.os.storage.IMountService;
Oscar Montemayora8529f62009-11-18 10:14:20 -080069import android.provider.Settings;
Dan Egnorbb9001c2009-07-27 12:20:13 -070070import android.util.EventLog;
Christopher Tate79ec80d2011-06-24 14:58:49 -070071import android.util.Log;
Joe Onorato8a9b2202010-02-26 18:56:32 -080072import android.util.Slog;
Christopher Tate487529a2009-04-29 14:03:25 -070073import android.util.SparseArray;
Christopher Tate4a627c72011-04-01 14:43:32 -070074import android.util.StringBuilderPrinter;
75
Jason parksa3cdaa52011-01-13 14:15:43 -060076import com.android.internal.backup.BackupConstants;
77import com.android.internal.backup.IBackupTransport;
78import com.android.internal.backup.LocalTransport;
79import com.android.server.PackageManagerBackupAgent.Metadata;
80
Christopher Tate2efd2db2011-07-19 16:32:49 -070081import java.io.BufferedInputStream;
82import java.io.BufferedOutputStream;
83import java.io.ByteArrayOutputStream;
Christopher Tate7926a692011-07-11 11:31:57 -070084import java.io.DataInputStream;
Christopher Tate2efd2db2011-07-19 16:32:49 -070085import java.io.DataOutputStream;
Christopher Tatecde87f42009-06-12 12:55:53 -070086import java.io.EOFException;
Christopher Tate22b87872009-05-04 16:41:53 -070087import java.io.File;
Joe Onoratob1a7ffe2009-05-06 18:06:21 -070088import java.io.FileDescriptor;
Christopher Tate75a99702011-05-18 16:28:19 -070089import java.io.FileInputStream;
Christopher Tate1168baa2010-02-17 13:03:40 -080090import java.io.FileNotFoundException;
Christopher Tate4cc86e12009-09-21 19:36:51 -070091import java.io.FileOutputStream;
Christopher Tatec7b31e32009-06-10 15:49:30 -070092import java.io.IOException;
Christopher Tate75a99702011-05-18 16:28:19 -070093import java.io.InputStream;
Christopher Tate2efd2db2011-07-19 16:32:49 -070094import java.io.OutputStream;
Joe Onoratob1a7ffe2009-05-06 18:06:21 -070095import java.io.PrintWriter;
Christopher Tatecde87f42009-06-12 12:55:53 -070096import java.io.RandomAccessFile;
Christopher Tate2efd2db2011-07-19 16:32:49 -070097import java.security.InvalidAlgorithmParameterException;
98import java.security.InvalidKeyException;
99import java.security.Key;
100import java.security.NoSuchAlgorithmException;
101import java.security.SecureRandom;
102import java.security.spec.InvalidKeySpecException;
103import java.security.spec.KeySpec;
Christopher Tate75a99702011-05-18 16:28:19 -0700104import java.text.SimpleDateFormat;
Joe Onorato8ad02812009-05-13 01:41:44 -0400105import java.util.ArrayList;
Christopher Tate7bdb0962011-07-13 19:30:21 -0700106import java.util.Arrays;
Christopher Tate75a99702011-05-18 16:28:19 -0700107import java.util.Date;
Joe Onorato8ad02812009-05-13 01:41:44 -0400108import java.util.HashMap;
Christopher Tate487529a2009-04-29 14:03:25 -0700109import java.util.HashSet;
110import java.util.List;
Christopher Tate91717492009-06-26 21:07:13 -0700111import java.util.Map;
Dan Egnorc1c49c02009-10-30 17:35:39 -0700112import java.util.Random;
Christopher Tateb49ceb32010-02-08 16:22:24 -0800113import java.util.Set;
Christopher Tate4a627c72011-04-01 14:43:32 -0700114import java.util.concurrent.atomic.AtomicBoolean;
Christopher Tate7926a692011-07-11 11:31:57 -0700115import java.util.zip.Deflater;
116import java.util.zip.DeflaterOutputStream;
Christopher Tate7926a692011-07-11 11:31:57 -0700117import java.util.zip.InflaterInputStream;
Christopher Tate487529a2009-04-29 14:03:25 -0700118
Christopher Tate2efd2db2011-07-19 16:32:49 -0700119import javax.crypto.BadPaddingException;
120import javax.crypto.Cipher;
121import javax.crypto.CipherInputStream;
122import javax.crypto.CipherOutputStream;
123import javax.crypto.IllegalBlockSizeException;
124import javax.crypto.NoSuchPaddingException;
125import javax.crypto.SecretKey;
126import javax.crypto.SecretKeyFactory;
127import javax.crypto.spec.IvParameterSpec;
128import javax.crypto.spec.PBEKeySpec;
129import javax.crypto.spec.SecretKeySpec;
130
Christopher Tate487529a2009-04-29 14:03:25 -0700131class BackupManagerService extends IBackupManager.Stub {
132 private static final String TAG = "BackupManagerService";
Christopher Tate4a627c72011-04-01 14:43:32 -0700133 private static final boolean DEBUG = true;
Christopher Tateb1543a92011-09-07 12:11:09 -0700134 private static final boolean MORE_DEBUG = false;
Christopher Tate4a627c72011-04-01 14:43:32 -0700135
136 // Name and current contents version of the full-backup manifest file
137 static final String BACKUP_MANIFEST_FILENAME = "_manifest";
138 static final int BACKUP_MANIFEST_VERSION = 1;
Christopher Tate7bdb0962011-07-13 19:30:21 -0700139 static final String BACKUP_FILE_HEADER_MAGIC = "ANDROID BACKUP\n";
140 static final int BACKUP_FILE_VERSION = 1;
Christopher Tate2efd2db2011-07-19 16:32:49 -0700141 static final boolean COMPRESS_FULL_BACKUPS = true; // should be true in production
Christopher Tateaa088442009-06-16 18:25:46 -0700142
Christopher Tate73d73692012-01-20 17:11:31 -0800143 static final String SHARED_BACKUP_AGENT_PACKAGE = "com.android.sharedstoragebackup";
144
Christopher Tate49401dd2009-07-01 12:34:29 -0700145 // How often we perform a backup pass. Privileged external callers can
146 // trigger an immediate pass.
Christopher Tateb6787f22009-07-02 17:40:45 -0700147 private static final long BACKUP_INTERVAL = AlarmManager.INTERVAL_HOUR;
Christopher Tate487529a2009-04-29 14:03:25 -0700148
Dan Egnorc1c49c02009-10-30 17:35:39 -0700149 // Random variation in backup scheduling time to avoid server load spikes
150 private static final int FUZZ_MILLIS = 5 * 60 * 1000;
151
Christopher Tate8031a3d2009-07-06 16:36:05 -0700152 // The amount of time between the initial provisioning of the device and
153 // the first backup pass.
154 private static final long FIRST_BACKUP_INTERVAL = 12 * AlarmManager.INTERVAL_HOUR;
155
Christopher Tate45281862010-03-05 15:46:30 -0800156 private static final String RUN_BACKUP_ACTION = "android.app.backup.intent.RUN";
157 private static final String RUN_INITIALIZE_ACTION = "android.app.backup.intent.INIT";
158 private static final String RUN_CLEAR_ACTION = "android.app.backup.intent.CLEAR";
Christopher Tate487529a2009-04-29 14:03:25 -0700159 private static final int MSG_RUN_BACKUP = 1;
Christopher Tate043dadc2009-06-02 16:11:00 -0700160 private static final int MSG_RUN_FULL_BACKUP = 2;
Christopher Tate9bbc21a2009-06-10 20:23:25 -0700161 private static final int MSG_RUN_RESTORE = 3;
Christopher Tateee0e78a2009-07-02 11:17:03 -0700162 private static final int MSG_RUN_CLEAR = 4;
Christopher Tate4cc86e12009-09-21 19:36:51 -0700163 private static final int MSG_RUN_INITIALIZE = 5;
Christopher Tate2d449afe2010-03-29 19:14:24 -0700164 private static final int MSG_RUN_GET_RESTORE_SETS = 6;
165 private static final int MSG_TIMEOUT = 7;
Christopher Tate73a3cb32010-12-13 18:27:26 -0800166 private static final int MSG_RESTORE_TIMEOUT = 8;
Christopher Tate4a627c72011-04-01 14:43:32 -0700167 private static final int MSG_FULL_CONFIRMATION_TIMEOUT = 9;
168 private static final int MSG_RUN_FULL_RESTORE = 10;
Christopher Tatec7b31e32009-06-10 15:49:30 -0700169
Christopher Tate8e294d42011-08-31 20:37:12 -0700170 // backup task state machine tick
171 static final int MSG_BACKUP_RESTORE_STEP = 20;
172 static final int MSG_OP_COMPLETE = 21;
173
Christopher Tatec7b31e32009-06-10 15:49:30 -0700174 // Timeout interval for deciding that a bind or clear-data has taken too long
175 static final long TIMEOUT_INTERVAL = 10 * 1000;
176
Christopher Tate44a27902010-01-27 17:15:49 -0800177 // Timeout intervals for agent backup & restore operations
178 static final long TIMEOUT_BACKUP_INTERVAL = 30 * 1000;
Christopher Tate4a627c72011-04-01 14:43:32 -0700179 static final long TIMEOUT_FULL_BACKUP_INTERVAL = 5 * 60 * 1000;
Christopher Tateb0628bf2011-06-02 15:08:13 -0700180 static final long TIMEOUT_SHARED_BACKUP_INTERVAL = 30 * 60 * 1000;
Christopher Tate44a27902010-01-27 17:15:49 -0800181 static final long TIMEOUT_RESTORE_INTERVAL = 60 * 1000;
182
Christopher Tate2efd2db2011-07-19 16:32:49 -0700183 // User confirmation timeout for a full backup/restore operation. It's this long in
184 // order to give them time to enter the backup password.
185 static final long TIMEOUT_FULL_CONFIRMATION = 60 * 1000;
Christopher Tate4a627c72011-04-01 14:43:32 -0700186
Christopher Tate487529a2009-04-29 14:03:25 -0700187 private Context mContext;
188 private PackageManager mPackageManager;
Christopher Tate1bb69062010-02-19 17:02:12 -0800189 IPackageManager mPackageManagerBinder;
Christopher Tate6ef58a12009-06-29 14:56:28 -0700190 private IActivityManager mActivityManager;
Christopher Tateb6787f22009-07-02 17:40:45 -0700191 private PowerManager mPowerManager;
192 private AlarmManager mAlarmManager;
Christopher Tate32418be2011-10-10 13:51:12 -0700193 private IMountService mMountService;
Christopher Tate44a27902010-01-27 17:15:49 -0800194 IBackupManager mBackupManagerBinder;
Christopher Tateb6787f22009-07-02 17:40:45 -0700195
Christopher Tate73e02522009-07-15 14:18:26 -0700196 boolean mEnabled; // access to this is synchronized on 'this'
197 boolean mProvisioned;
Christopher Tatecce9da52010-02-03 15:11:15 -0800198 boolean mAutoRestore;
Christopher Tate73e02522009-07-15 14:18:26 -0700199 PowerManager.WakeLock mWakelock;
Christopher Tate0bacfd22012-01-11 14:41:19 -0800200 HandlerThread mHandlerThread;
Christopher Tate44a27902010-01-27 17:15:49 -0800201 BackupHandler mBackupHandler;
Christopher Tate4cc86e12009-09-21 19:36:51 -0700202 PendingIntent mRunBackupIntent, mRunInitIntent;
203 BroadcastReceiver mRunBackupReceiver, mRunInitReceiver;
Christopher Tate487529a2009-04-29 14:03:25 -0700204 // map UIDs to the set of backup client services within that UID's app set
Christopher Tate73e02522009-07-15 14:18:26 -0700205 final SparseArray<HashSet<ApplicationInfo>> mBackupParticipants
Christopher Tate181fafa2009-05-14 11:12:14 -0700206 = new SparseArray<HashSet<ApplicationInfo>>();
Christopher Tate487529a2009-04-29 14:03:25 -0700207 // set of backup services that have pending changes
Christopher Tate73e02522009-07-15 14:18:26 -0700208 class BackupRequest {
Christopher Tatecc55f812011-08-16 16:06:53 -0700209 public String packageName;
Christopher Tateaa088442009-06-16 18:25:46 -0700210
Christopher Tatecc55f812011-08-16 16:06:53 -0700211 BackupRequest(String pkgName) {
212 packageName = pkgName;
Christopher Tate46758122009-05-06 11:22:00 -0700213 }
Christopher Tate181fafa2009-05-14 11:12:14 -0700214
215 public String toString() {
Christopher Tatecc55f812011-08-16 16:06:53 -0700216 return "BackupRequest{pkg=" + packageName + "}";
Christopher Tate181fafa2009-05-14 11:12:14 -0700217 }
Christopher Tate46758122009-05-06 11:22:00 -0700218 }
Christopher Tatec28083a2010-12-14 16:16:44 -0800219 // Backups that we haven't started yet. Keys are package names.
220 HashMap<String,BackupRequest> mPendingBackups
221 = new HashMap<String,BackupRequest>();
Christopher Tate5cb400b2009-06-25 16:03:14 -0700222
223 // Pseudoname that we use for the Package Manager metadata "package"
Christopher Tate73e02522009-07-15 14:18:26 -0700224 static final String PACKAGE_MANAGER_SENTINEL = "@pm@";
Christopher Tate6aa41f42009-06-19 14:14:22 -0700225
226 // locking around the pending-backup management
Christopher Tate73e02522009-07-15 14:18:26 -0700227 final Object mQueueLock = new Object();
Christopher Tate487529a2009-04-29 14:03:25 -0700228
Christopher Tate043dadc2009-06-02 16:11:00 -0700229 // The thread performing the sequence of queued backups binds to each app's agent
230 // in succession. Bind notifications are asynchronously delivered through the
231 // Activity Manager; use this lock object to signal when a requested binding has
232 // completed.
Christopher Tate73e02522009-07-15 14:18:26 -0700233 final Object mAgentConnectLock = new Object();
234 IBackupAgent mConnectedAgent;
Christopher Tate336a6492011-10-05 16:05:43 -0700235 volatile boolean mBackupRunning;
Christopher Tate73e02522009-07-15 14:18:26 -0700236 volatile boolean mConnecting;
Christopher Tate55f931a2009-09-29 17:17:34 -0700237 volatile long mLastBackupPass;
238 volatile long mNextBackupPass;
Christopher Tate043dadc2009-06-02 16:11:00 -0700239
Christopher Tate6de74ff2012-01-17 15:20:32 -0800240 // For debugging, we maintain a progress trace of operations during backup
241 static final boolean DEBUG_BACKUP_TRACE = true;
242 final List<String> mBackupTrace = new ArrayList<String>();
243
Christopher Tate55f931a2009-09-29 17:17:34 -0700244 // A similar synchronization mechanism around clearing apps' data for restore
Christopher Tate73e02522009-07-15 14:18:26 -0700245 final Object mClearDataLock = new Object();
246 volatile boolean mClearingData;
Christopher Tatec7b31e32009-06-10 15:49:30 -0700247
Christopher Tate91717492009-06-26 21:07:13 -0700248 // Transport bookkeeping
Christopher Tate73e02522009-07-15 14:18:26 -0700249 final HashMap<String,IBackupTransport> mTransports
Christopher Tate91717492009-06-26 21:07:13 -0700250 = new HashMap<String,IBackupTransport>();
Christopher Tate73e02522009-07-15 14:18:26 -0700251 String mCurrentTransport;
252 IBackupTransport mLocalTransport, mGoogleTransport;
Christopher Tate80202c82010-01-25 19:37:47 -0800253 ActiveRestoreSession mActiveRestoreSession;
Christopher Tate043dadc2009-06-02 16:11:00 -0700254
Christopher Tate2d449afe2010-03-29 19:14:24 -0700255 class RestoreGetSetsParams {
256 public IBackupTransport transport;
257 public ActiveRestoreSession session;
258 public IRestoreObserver observer;
259
260 RestoreGetSetsParams(IBackupTransport _transport, ActiveRestoreSession _session,
261 IRestoreObserver _observer) {
262 transport = _transport;
263 session = _session;
264 observer = _observer;
265 }
266 }
267
Christopher Tate73e02522009-07-15 14:18:26 -0700268 class RestoreParams {
Christopher Tate7d562ec2009-06-25 18:03:43 -0700269 public IBackupTransport transport;
270 public IRestoreObserver observer;
Dan Egnor156411d2009-06-26 13:20:02 -0700271 public long token;
Christopher Tate84725812010-02-04 15:52:40 -0800272 public PackageInfo pkgInfo;
Christopher Tate1bb69062010-02-19 17:02:12 -0800273 public int pmToken; // in post-install restore, the PM's token for this transaction
Chris Tate249345b2010-10-29 12:57:04 -0700274 public boolean needFullBackup;
Christopher Tate284f1bb2011-07-07 14:31:18 -0700275 public String[] filterSet;
Christopher Tate84725812010-02-04 15:52:40 -0800276
277 RestoreParams(IBackupTransport _transport, IRestoreObserver _obs,
Chris Tate249345b2010-10-29 12:57:04 -0700278 long _token, PackageInfo _pkg, int _pmToken, boolean _needFullBackup) {
Christopher Tate84725812010-02-04 15:52:40 -0800279 transport = _transport;
280 observer = _obs;
281 token = _token;
282 pkgInfo = _pkg;
Christopher Tate1bb69062010-02-19 17:02:12 -0800283 pmToken = _pmToken;
Chris Tate249345b2010-10-29 12:57:04 -0700284 needFullBackup = _needFullBackup;
Christopher Tate284f1bb2011-07-07 14:31:18 -0700285 filterSet = null;
Christopher Tate84725812010-02-04 15:52:40 -0800286 }
Christopher Tate7d562ec2009-06-25 18:03:43 -0700287
Chris Tate249345b2010-10-29 12:57:04 -0700288 RestoreParams(IBackupTransport _transport, IRestoreObserver _obs, long _token,
289 boolean _needFullBackup) {
Christopher Tate7d562ec2009-06-25 18:03:43 -0700290 transport = _transport;
291 observer = _obs;
Dan Egnor156411d2009-06-26 13:20:02 -0700292 token = _token;
Christopher Tate84725812010-02-04 15:52:40 -0800293 pkgInfo = null;
Christopher Tate1bb69062010-02-19 17:02:12 -0800294 pmToken = 0;
Chris Tate249345b2010-10-29 12:57:04 -0700295 needFullBackup = _needFullBackup;
Christopher Tate284f1bb2011-07-07 14:31:18 -0700296 filterSet = null;
297 }
298
299 RestoreParams(IBackupTransport _transport, IRestoreObserver _obs, long _token,
300 String[] _filterSet, boolean _needFullBackup) {
301 transport = _transport;
302 observer = _obs;
303 token = _token;
304 pkgInfo = null;
305 pmToken = 0;
306 needFullBackup = _needFullBackup;
307 filterSet = _filterSet;
Christopher Tate7d562ec2009-06-25 18:03:43 -0700308 }
309 }
310
Christopher Tate73e02522009-07-15 14:18:26 -0700311 class ClearParams {
Christopher Tateee0e78a2009-07-02 11:17:03 -0700312 public IBackupTransport transport;
313 public PackageInfo packageInfo;
314
315 ClearParams(IBackupTransport _transport, PackageInfo _info) {
316 transport = _transport;
317 packageInfo = _info;
318 }
319 }
320
Christopher Tate4a627c72011-04-01 14:43:32 -0700321 class FullParams {
322 public ParcelFileDescriptor fd;
323 public final AtomicBoolean latch;
324 public IFullBackupRestoreObserver observer;
Christopher Tate728a1c42011-07-28 18:03:03 -0700325 public String curPassword; // filled in by the confirmation step
326 public String encryptPassword;
Christopher Tate4a627c72011-04-01 14:43:32 -0700327
328 FullParams() {
329 latch = new AtomicBoolean(false);
330 }
331 }
332
333 class FullBackupParams extends FullParams {
334 public boolean includeApks;
335 public boolean includeShared;
336 public boolean allApps;
Christopher Tate240c7d22011-10-03 18:13:44 -0700337 public boolean includeSystem;
Christopher Tate4a627c72011-04-01 14:43:32 -0700338 public String[] packages;
339
340 FullBackupParams(ParcelFileDescriptor output, boolean saveApks, boolean saveShared,
Christopher Tate240c7d22011-10-03 18:13:44 -0700341 boolean doAllApps, boolean doSystem, String[] pkgList) {
Christopher Tate4a627c72011-04-01 14:43:32 -0700342 fd = output;
343 includeApks = saveApks;
344 includeShared = saveShared;
345 allApps = doAllApps;
Christopher Tate240c7d22011-10-03 18:13:44 -0700346 includeSystem = doSystem;
Christopher Tate4a627c72011-04-01 14:43:32 -0700347 packages = pkgList;
348 }
349 }
350
351 class FullRestoreParams extends FullParams {
352 FullRestoreParams(ParcelFileDescriptor input) {
353 fd = input;
354 }
355 }
356
Christopher Tate44a27902010-01-27 17:15:49 -0800357 // Bookkeeping of in-flight operations for timeout etc. purposes. The operation
358 // token is the index of the entry in the pending-operations list.
359 static final int OP_PENDING = 0;
360 static final int OP_ACKNOWLEDGED = 1;
361 static final int OP_TIMEOUT = -1;
362
Christopher Tate8e294d42011-08-31 20:37:12 -0700363 class Operation {
364 public int state;
365 public BackupRestoreTask callback;
366
367 Operation(int initialState, BackupRestoreTask callbackObj) {
368 state = initialState;
369 callback = callbackObj;
370 }
371 }
372 final SparseArray<Operation> mCurrentOperations = new SparseArray<Operation>();
Christopher Tate44a27902010-01-27 17:15:49 -0800373 final Object mCurrentOpLock = new Object();
374 final Random mTokenGenerator = new Random();
375
Christopher Tate4a627c72011-04-01 14:43:32 -0700376 final SparseArray<FullParams> mFullConfirmations = new SparseArray<FullParams>();
377
Christopher Tate5cb400b2009-06-25 16:03:14 -0700378 // Where we keep our journal files and other bookkeeping
Christopher Tate73e02522009-07-15 14:18:26 -0700379 File mBaseStateDir;
380 File mDataDir;
381 File mJournalDir;
382 File mJournal;
Christopher Tate73e02522009-07-15 14:18:26 -0700383
Christopher Tate2efd2db2011-07-19 16:32:49 -0700384 // Backup password, if any, and the file where it's saved. What is stored is not the
385 // password text itself; it's the result of a PBKDF2 hash with a randomly chosen (but
386 // persisted) salt. Validation is performed by running the challenge text through the
387 // same PBKDF2 cycle with the persisted salt; if the resulting derived key string matches
388 // the saved hash string, then the challenge text matches the originally supplied
389 // password text.
390 private final SecureRandom mRng = new SecureRandom();
391 private String mPasswordHash;
392 private File mPasswordHashFile;
393 private byte[] mPasswordSalt;
394
395 // Configuration of PBKDF2 that we use for generating pw hashes and intermediate keys
396 static final int PBKDF2_HASH_ROUNDS = 10000;
397 static final int PBKDF2_KEY_SIZE = 256; // bits
398 static final int PBKDF2_SALT_SIZE = 512; // bits
399 static final String ENCRYPTION_ALGORITHM_NAME = "AES-256";
400
Christopher Tate84725812010-02-04 15:52:40 -0800401 // Keep a log of all the apps we've ever backed up, and what the
402 // dataset tokens are for both the current backup dataset and
403 // the ancestral dataset.
Christopher Tate73e02522009-07-15 14:18:26 -0700404 private File mEverStored;
Christopher Tate73e02522009-07-15 14:18:26 -0700405 HashSet<String> mEverStoredApps = new HashSet<String>();
406
Christopher Tateb49ceb32010-02-08 16:22:24 -0800407 static final int CURRENT_ANCESTRAL_RECORD_VERSION = 1; // increment when the schema changes
Christopher Tate84725812010-02-04 15:52:40 -0800408 File mTokenFile;
Christopher Tateb49ceb32010-02-08 16:22:24 -0800409 Set<String> mAncestralPackages = null;
Christopher Tate84725812010-02-04 15:52:40 -0800410 long mAncestralToken = 0;
411 long mCurrentToken = 0;
412
Christopher Tate4cc86e12009-09-21 19:36:51 -0700413 // Persistently track the need to do a full init
414 static final String INIT_SENTINEL_FILE_NAME = "_need_init_";
415 HashSet<String> mPendingInits = new HashSet<String>(); // transport names
Christopher Tateaa088442009-06-16 18:25:46 -0700416
Christopher Tate4a627c72011-04-01 14:43:32 -0700417 // Utility: build a new random integer token
418 int generateToken() {
419 int token;
420 do {
421 synchronized (mTokenGenerator) {
422 token = mTokenGenerator.nextInt();
423 }
424 } while (token < 0);
425 return token;
426 }
427
Christopher Tate44a27902010-01-27 17:15:49 -0800428 // ----- Asynchronous backup/restore handler thread -----
429
430 private class BackupHandler extends Handler {
431 public BackupHandler(Looper looper) {
432 super(looper);
433 }
434
435 public void handleMessage(Message msg) {
436
437 switch (msg.what) {
438 case MSG_RUN_BACKUP:
439 {
440 mLastBackupPass = System.currentTimeMillis();
441 mNextBackupPass = mLastBackupPass + BACKUP_INTERVAL;
442
443 IBackupTransport transport = getTransport(mCurrentTransport);
444 if (transport == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800445 Slog.v(TAG, "Backup requested but no transport available");
Christopher Tate336a6492011-10-05 16:05:43 -0700446 synchronized (mQueueLock) {
447 mBackupRunning = false;
448 }
Christopher Tate44a27902010-01-27 17:15:49 -0800449 mWakelock.release();
450 break;
451 }
452
453 // snapshot the pending-backup set and work on that
454 ArrayList<BackupRequest> queue = new ArrayList<BackupRequest>();
Christopher Tatec61da312010-02-05 10:41:27 -0800455 File oldJournal = mJournal;
Christopher Tate44a27902010-01-27 17:15:49 -0800456 synchronized (mQueueLock) {
Christopher Tatec61da312010-02-05 10:41:27 -0800457 // Do we have any work to do? Construct the work queue
458 // then release the synchronization lock to actually run
459 // the backup.
Christopher Tate44a27902010-01-27 17:15:49 -0800460 if (mPendingBackups.size() > 0) {
461 for (BackupRequest b: mPendingBackups.values()) {
462 queue.add(b);
463 }
Joe Onorato8a9b2202010-02-26 18:56:32 -0800464 if (DEBUG) Slog.v(TAG, "clearing pending backups");
Christopher Tate44a27902010-01-27 17:15:49 -0800465 mPendingBackups.clear();
466
467 // Start a new backup-queue journal file too
Christopher Tate44a27902010-01-27 17:15:49 -0800468 mJournal = null;
469
Christopher Tate44a27902010-01-27 17:15:49 -0800470 }
471 }
Christopher Tatec61da312010-02-05 10:41:27 -0800472
Christopher Tate8e294d42011-08-31 20:37:12 -0700473 // At this point, we have started a new journal file, and the old
474 // file identity is being passed to the backup processing task.
475 // When it completes successfully, that old journal file will be
476 // deleted. If we crash prior to that, the old journal is parsed
477 // at next boot and the journaled requests fulfilled.
Christopher Tatec61da312010-02-05 10:41:27 -0800478 if (queue.size() > 0) {
Christopher Tate8e294d42011-08-31 20:37:12 -0700479 // Spin up a backup state sequence and set it running
480 PerformBackupTask pbt = new PerformBackupTask(transport, queue, oldJournal);
481 Message pbtMessage = obtainMessage(MSG_BACKUP_RESTORE_STEP, pbt);
482 sendMessage(pbtMessage);
Christopher Tatec61da312010-02-05 10:41:27 -0800483 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800484 Slog.v(TAG, "Backup requested but nothing pending");
Christopher Tate336a6492011-10-05 16:05:43 -0700485 synchronized (mQueueLock) {
486 mBackupRunning = false;
487 }
Christopher Tatec61da312010-02-05 10:41:27 -0800488 mWakelock.release();
489 }
Christopher Tate44a27902010-01-27 17:15:49 -0800490 break;
491 }
492
Christopher Tate8e294d42011-08-31 20:37:12 -0700493 case MSG_BACKUP_RESTORE_STEP:
494 {
495 try {
496 BackupRestoreTask task = (BackupRestoreTask) msg.obj;
497 if (MORE_DEBUG) Slog.v(TAG, "Got next step for " + task + ", executing");
498 task.execute();
499 } catch (ClassCastException e) {
500 Slog.e(TAG, "Invalid backup task in flight, obj=" + msg.obj);
501 }
502 break;
503 }
504
505 case MSG_OP_COMPLETE:
506 {
507 try {
Christopher Tate2982d062011-09-06 20:35:24 -0700508 BackupRestoreTask task = (BackupRestoreTask) msg.obj;
509 task.operationComplete();
Christopher Tate8e294d42011-08-31 20:37:12 -0700510 } catch (ClassCastException e) {
511 Slog.e(TAG, "Invalid completion in flight, obj=" + msg.obj);
512 }
513 break;
514 }
515
Christopher Tate44a27902010-01-27 17:15:49 -0800516 case MSG_RUN_FULL_BACKUP:
Christopher Tate4a627c72011-04-01 14:43:32 -0700517 {
Christopher Tatea28e8542011-09-12 13:45:21 -0700518 // TODO: refactor full backup to be a looper-based state machine
519 // similar to normal backup/restore.
Christopher Tate4a627c72011-04-01 14:43:32 -0700520 FullBackupParams params = (FullBackupParams)msg.obj;
Christopher Tatea28e8542011-09-12 13:45:21 -0700521 PerformFullBackupTask task = new PerformFullBackupTask(params.fd,
522 params.observer, params.includeApks,
Christopher Tate728a1c42011-07-28 18:03:03 -0700523 params.includeShared, params.curPassword, params.encryptPassword,
Christopher Tate240c7d22011-10-03 18:13:44 -0700524 params.allApps, params.includeSystem, params.packages, params.latch);
Christopher Tatea28e8542011-09-12 13:45:21 -0700525 (new Thread(task)).start();
Christopher Tate44a27902010-01-27 17:15:49 -0800526 break;
Christopher Tate4a627c72011-04-01 14:43:32 -0700527 }
Christopher Tate44a27902010-01-27 17:15:49 -0800528
529 case MSG_RUN_RESTORE:
530 {
531 RestoreParams params = (RestoreParams)msg.obj;
Joe Onorato8a9b2202010-02-26 18:56:32 -0800532 Slog.d(TAG, "MSG_RUN_RESTORE observer=" + params.observer);
Christopher Tate2982d062011-09-06 20:35:24 -0700533 PerformRestoreTask task = new PerformRestoreTask(
534 params.transport, params.observer,
Chris Tate249345b2010-10-29 12:57:04 -0700535 params.token, params.pkgInfo, params.pmToken,
Christopher Tate2982d062011-09-06 20:35:24 -0700536 params.needFullBackup, params.filterSet);
537 Message restoreMsg = obtainMessage(MSG_BACKUP_RESTORE_STEP, task);
538 sendMessage(restoreMsg);
Christopher Tate44a27902010-01-27 17:15:49 -0800539 break;
540 }
541
Christopher Tate75a99702011-05-18 16:28:19 -0700542 case MSG_RUN_FULL_RESTORE:
543 {
Christopher Tatea28e8542011-09-12 13:45:21 -0700544 // TODO: refactor full restore to be a looper-based state machine
545 // similar to normal backup/restore.
Christopher Tate75a99702011-05-18 16:28:19 -0700546 FullRestoreParams params = (FullRestoreParams)msg.obj;
Christopher Tatea28e8542011-09-12 13:45:21 -0700547 PerformFullRestoreTask task = new PerformFullRestoreTask(params.fd,
548 params.curPassword, params.encryptPassword,
549 params.observer, params.latch);
550 (new Thread(task)).start();
Christopher Tate75a99702011-05-18 16:28:19 -0700551 break;
552 }
553
Christopher Tate44a27902010-01-27 17:15:49 -0800554 case MSG_RUN_CLEAR:
555 {
556 ClearParams params = (ClearParams)msg.obj;
557 (new PerformClearTask(params.transport, params.packageInfo)).run();
558 break;
559 }
560
561 case MSG_RUN_INITIALIZE:
562 {
563 HashSet<String> queue;
564
565 // Snapshot the pending-init queue and work on that
566 synchronized (mQueueLock) {
567 queue = new HashSet<String>(mPendingInits);
568 mPendingInits.clear();
569 }
570
571 (new PerformInitializeTask(queue)).run();
572 break;
573 }
574
Christopher Tate2d449afe2010-03-29 19:14:24 -0700575 case MSG_RUN_GET_RESTORE_SETS:
576 {
577 // Like other async operations, this is entered with the wakelock held
578 RestoreSet[] sets = null;
579 RestoreGetSetsParams params = (RestoreGetSetsParams)msg.obj;
580 try {
581 sets = params.transport.getAvailableRestoreSets();
582 // cache the result in the active session
583 synchronized (params.session) {
584 params.session.mRestoreSets = sets;
585 }
586 if (sets == null) EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
587 } catch (Exception e) {
588 Slog.e(TAG, "Error from transport getting set list");
589 } finally {
590 if (params.observer != null) {
591 try {
592 params.observer.restoreSetsAvailable(sets);
593 } catch (RemoteException re) {
594 Slog.e(TAG, "Unable to report listing to observer");
595 } catch (Exception e) {
596 Slog.e(TAG, "Restore observer threw", e);
597 }
598 }
599
Christopher Tate2a935092011-03-03 17:30:32 -0800600 // Done: reset the session timeout clock
601 removeMessages(MSG_RESTORE_TIMEOUT);
602 sendEmptyMessageDelayed(MSG_RESTORE_TIMEOUT, TIMEOUT_RESTORE_INTERVAL);
603
Christopher Tate2d449afe2010-03-29 19:14:24 -0700604 mWakelock.release();
605 }
606 break;
607 }
608
Christopher Tate44a27902010-01-27 17:15:49 -0800609 case MSG_TIMEOUT:
610 {
Christopher Tate8e294d42011-08-31 20:37:12 -0700611 handleTimeout(msg.arg1, msg.obj);
Christopher Tate44a27902010-01-27 17:15:49 -0800612 break;
613 }
Christopher Tate73a3cb32010-12-13 18:27:26 -0800614
615 case MSG_RESTORE_TIMEOUT:
616 {
617 synchronized (BackupManagerService.this) {
618 if (mActiveRestoreSession != null) {
619 // Client app left the restore session dangling. We know that it
620 // can't be in the middle of an actual restore operation because
Christopher Tate2982d062011-09-06 20:35:24 -0700621 // the timeout is suspended while a restore is in progress. Clean
Christopher Tate73a3cb32010-12-13 18:27:26 -0800622 // up now.
623 Slog.w(TAG, "Restore session timed out; aborting");
624 post(mActiveRestoreSession.new EndRestoreRunnable(
625 BackupManagerService.this, mActiveRestoreSession));
626 }
627 }
628 }
Christopher Tate4a627c72011-04-01 14:43:32 -0700629
630 case MSG_FULL_CONFIRMATION_TIMEOUT:
631 {
632 synchronized (mFullConfirmations) {
633 FullParams params = mFullConfirmations.get(msg.arg1);
634 if (params != null) {
635 Slog.i(TAG, "Full backup/restore timed out waiting for user confirmation");
636
637 // Release the waiter; timeout == completion
638 signalFullBackupRestoreCompletion(params);
639
640 // Remove the token from the set
641 mFullConfirmations.delete(msg.arg1);
642
643 // Report a timeout to the observer, if any
644 if (params.observer != null) {
645 try {
646 params.observer.onTimeout();
647 } catch (RemoteException e) {
648 /* don't care if the app has gone away */
649 }
650 }
651 } else {
652 Slog.d(TAG, "couldn't find params for token " + msg.arg1);
653 }
654 }
655 break;
656 }
Christopher Tate44a27902010-01-27 17:15:49 -0800657 }
658 }
659 }
660
Christopher Tate6de74ff2012-01-17 15:20:32 -0800661 // ----- Debug-only backup operation trace -----
662 void addBackupTrace(String s) {
663 if (DEBUG_BACKUP_TRACE) {
664 synchronized (mBackupTrace) {
665 mBackupTrace.add(s);
666 }
667 }
668 }
669
670 void clearBackupTrace() {
671 if (DEBUG_BACKUP_TRACE) {
672 synchronized (mBackupTrace) {
673 mBackupTrace.clear();
674 }
675 }
676 }
677
Christopher Tate44a27902010-01-27 17:15:49 -0800678 // ----- Main service implementation -----
679
Christopher Tate487529a2009-04-29 14:03:25 -0700680 public BackupManagerService(Context context) {
681 mContext = context;
682 mPackageManager = context.getPackageManager();
Dianne Hackborn01e4cfc2010-06-24 15:07:24 -0700683 mPackageManagerBinder = AppGlobals.getPackageManager();
Christopher Tate181fafa2009-05-14 11:12:14 -0700684 mActivityManager = ActivityManagerNative.getDefault();
Christopher Tate487529a2009-04-29 14:03:25 -0700685
Christopher Tateb6787f22009-07-02 17:40:45 -0700686 mAlarmManager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE);
687 mPowerManager = (PowerManager) context.getSystemService(Context.POWER_SERVICE);
Christopher Tate32418be2011-10-10 13:51:12 -0700688 mMountService = IMountService.Stub.asInterface(ServiceManager.getService("mount"));
Christopher Tateb6787f22009-07-02 17:40:45 -0700689
Christopher Tate44a27902010-01-27 17:15:49 -0800690 mBackupManagerBinder = asInterface(asBinder());
691
692 // spin up the backup/restore handler thread
693 mHandlerThread = new HandlerThread("backup", Process.THREAD_PRIORITY_BACKGROUND);
694 mHandlerThread.start();
695 mBackupHandler = new BackupHandler(mHandlerThread.getLooper());
696
Christopher Tate22b87872009-05-04 16:41:53 -0700697 // Set up our bookkeeping
Christopher Tateb6787f22009-07-02 17:40:45 -0700698 boolean areEnabled = Settings.Secure.getInt(context.getContentResolver(),
Dianne Hackborncf098292009-07-01 19:55:20 -0700699 Settings.Secure.BACKUP_ENABLED, 0) != 0;
Christopher Tate8031a3d2009-07-06 16:36:05 -0700700 mProvisioned = Settings.Secure.getInt(context.getContentResolver(),
Joe Onoratoab9a2a52009-07-27 08:56:39 -0700701 Settings.Secure.BACKUP_PROVISIONED, 0) != 0;
Christopher Tatecce9da52010-02-03 15:11:15 -0800702 mAutoRestore = Settings.Secure.getInt(context.getContentResolver(),
Christopher Tate5035fda2010-02-25 18:01:14 -0800703 Settings.Secure.BACKUP_AUTO_RESTORE, 1) != 0;
Oscar Montemayora8529f62009-11-18 10:14:20 -0800704 // If Encrypted file systems is enabled or disabled, this call will return the
705 // correct directory.
Jason parksa3cdaa52011-01-13 14:15:43 -0600706 mBaseStateDir = new File(Environment.getSecureDataDirectory(), "backup");
Oscar Montemayora8529f62009-11-18 10:14:20 -0800707 mBaseStateDir.mkdirs();
Christopher Tatef4172472009-05-05 15:50:03 -0700708 mDataDir = Environment.getDownloadCacheDirectory();
Christopher Tate9bbc21a2009-06-10 20:23:25 -0700709
Christopher Tate2efd2db2011-07-19 16:32:49 -0700710 mPasswordHashFile = new File(mBaseStateDir, "pwhash");
711 if (mPasswordHashFile.exists()) {
712 FileInputStream fin = null;
713 DataInputStream in = null;
714 try {
715 fin = new FileInputStream(mPasswordHashFile);
716 in = new DataInputStream(new BufferedInputStream(fin));
717 // integer length of the salt array, followed by the salt,
718 // then the hex pw hash string
719 int saltLen = in.readInt();
720 byte[] salt = new byte[saltLen];
721 in.readFully(salt);
722 mPasswordHash = in.readUTF();
723 mPasswordSalt = salt;
724 } catch (IOException e) {
725 Slog.e(TAG, "Unable to read saved backup pw hash");
726 } finally {
727 try {
728 if (in != null) in.close();
729 if (fin != null) fin.close();
730 } catch (IOException e) {
731 Slog.w(TAG, "Unable to close streams");
732 }
733 }
734 }
735
Christopher Tate4cc86e12009-09-21 19:36:51 -0700736 // Alarm receivers for scheduled backups & initialization operations
Christopher Tateb6787f22009-07-02 17:40:45 -0700737 mRunBackupReceiver = new RunBackupReceiver();
Christopher Tate4cc86e12009-09-21 19:36:51 -0700738 IntentFilter filter = new IntentFilter();
739 filter.addAction(RUN_BACKUP_ACTION);
740 context.registerReceiver(mRunBackupReceiver, filter,
741 android.Manifest.permission.BACKUP, null);
742
743 mRunInitReceiver = new RunInitializeReceiver();
744 filter = new IntentFilter();
745 filter.addAction(RUN_INITIALIZE_ACTION);
746 context.registerReceiver(mRunInitReceiver, filter,
747 android.Manifest.permission.BACKUP, null);
Christopher Tateb6787f22009-07-02 17:40:45 -0700748
749 Intent backupIntent = new Intent(RUN_BACKUP_ACTION);
Christopher Tateb6787f22009-07-02 17:40:45 -0700750 backupIntent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
751 mRunBackupIntent = PendingIntent.getBroadcast(context, MSG_RUN_BACKUP, backupIntent, 0);
752
Christopher Tate4cc86e12009-09-21 19:36:51 -0700753 Intent initIntent = new Intent(RUN_INITIALIZE_ACTION);
754 backupIntent.addFlags(Intent.FLAG_RECEIVER_REGISTERED_ONLY);
755 mRunInitIntent = PendingIntent.getBroadcast(context, MSG_RUN_INITIALIZE, initIntent, 0);
756
Christopher Tatecde87f42009-06-12 12:55:53 -0700757 // Set up the backup-request journaling
Christopher Tate5cb400b2009-06-25 16:03:14 -0700758 mJournalDir = new File(mBaseStateDir, "pending");
759 mJournalDir.mkdirs(); // creates mBaseStateDir along the way
Dan Egnor852f8e42009-09-30 11:20:45 -0700760 mJournal = null; // will be created on first use
Christopher Tatecde87f42009-06-12 12:55:53 -0700761
Christopher Tate73e02522009-07-15 14:18:26 -0700762 // Set up the various sorts of package tracking we do
763 initPackageTracking();
764
Christopher Tateabce4e82009-06-18 18:35:32 -0700765 // Build our mapping of uid to backup client services. This implicitly
766 // schedules a backup pass on the Package Manager metadata the first
767 // time anything needs to be backed up.
Christopher Tate3799bc22009-05-06 16:13:56 -0700768 synchronized (mBackupParticipants) {
769 addPackageParticipantsLocked(null);
Christopher Tate487529a2009-04-29 14:03:25 -0700770 }
771
Dan Egnor87a02bc2009-06-17 02:30:10 -0700772 // Set up our transport options and initialize the default transport
773 // TODO: Have transports register themselves somehow?
774 // TODO: Don't create transports that we don't need to?
Dan Egnor87a02bc2009-06-17 02:30:10 -0700775 mLocalTransport = new LocalTransport(context); // This is actually pretty cheap
Christopher Tate91717492009-06-26 21:07:13 -0700776 ComponentName localName = new ComponentName(context, LocalTransport.class);
777 registerTransport(localName.flattenToShortString(), mLocalTransport);
Dan Egnor87a02bc2009-06-17 02:30:10 -0700778
Christopher Tate91717492009-06-26 21:07:13 -0700779 mGoogleTransport = null;
Dianne Hackborncf098292009-07-01 19:55:20 -0700780 mCurrentTransport = Settings.Secure.getString(context.getContentResolver(),
781 Settings.Secure.BACKUP_TRANSPORT);
782 if ("".equals(mCurrentTransport)) {
783 mCurrentTransport = null;
Christopher Tatece0bf062009-07-01 11:43:53 -0700784 }
Joe Onorato8a9b2202010-02-26 18:56:32 -0800785 if (DEBUG) Slog.v(TAG, "Starting with transport " + mCurrentTransport);
Christopher Tate91717492009-06-26 21:07:13 -0700786
787 // Attach to the Google backup transport. When this comes up, it will set
788 // itself as the current transport because we explicitly reset mCurrentTransport
789 // to null.
Christopher Tatea32504f2010-04-21 17:58:07 -0700790 ComponentName transportComponent = new ComponentName("com.google.android.backup",
791 "com.google.android.backup.BackupTransportService");
792 try {
793 // If there's something out there that is supposed to be the Google
794 // backup transport, make sure it's legitimately part of the OS build
795 // and not an app lying about its package name.
796 ApplicationInfo info = mPackageManager.getApplicationInfo(
797 transportComponent.getPackageName(), 0);
798 if ((info.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
799 if (DEBUG) Slog.v(TAG, "Binding to Google transport");
800 Intent intent = new Intent().setComponent(transportComponent);
801 context.bindService(intent, mGoogleConnection, Context.BIND_AUTO_CREATE);
802 } else {
803 Slog.w(TAG, "Possible Google transport spoof: ignoring " + info);
804 }
805 } catch (PackageManager.NameNotFoundException nnf) {
806 // No such package? No binding.
807 if (DEBUG) Slog.v(TAG, "Google transport not present");
808 }
Christopher Tateaa088442009-06-16 18:25:46 -0700809
Christopher Tatecde87f42009-06-12 12:55:53 -0700810 // Now that we know about valid backup participants, parse any
Christopher Tate49401dd2009-07-01 12:34:29 -0700811 // leftover journal files into the pending backup set
Christopher Tatecde87f42009-06-12 12:55:53 -0700812 parseLeftoverJournals();
813
Christopher Tateb6787f22009-07-02 17:40:45 -0700814 // Power management
Dianne Hackborn7e9f4eb2010-09-10 18:43:00 -0700815 mWakelock = mPowerManager.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "*backup*");
Christopher Tateb6787f22009-07-02 17:40:45 -0700816
817 // Start the backup passes going
818 setBackupEnabled(areEnabled);
819 }
820
821 private class RunBackupReceiver extends BroadcastReceiver {
822 public void onReceive(Context context, Intent intent) {
823 if (RUN_BACKUP_ACTION.equals(intent.getAction())) {
Christopher Tateb6787f22009-07-02 17:40:45 -0700824 synchronized (mQueueLock) {
Christopher Tate4cc86e12009-09-21 19:36:51 -0700825 if (mPendingInits.size() > 0) {
826 // If there are pending init operations, we process those
827 // and then settle into the usual periodic backup schedule.
Joe Onorato8a9b2202010-02-26 18:56:32 -0800828 if (DEBUG) Slog.v(TAG, "Init pending at scheduled backup");
Christopher Tate4cc86e12009-09-21 19:36:51 -0700829 try {
830 mAlarmManager.cancel(mRunInitIntent);
831 mRunInitIntent.send();
832 } catch (PendingIntent.CanceledException ce) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800833 Slog.e(TAG, "Run init intent cancelled");
Christopher Tate4cc86e12009-09-21 19:36:51 -0700834 // can't really do more than bail here
835 }
836 } else {
Christopher Tatec2af5d32010-02-02 15:18:58 -0800837 // Don't run backups now if we're disabled or not yet
838 // fully set up.
839 if (mEnabled && mProvisioned) {
Christopher Tate336a6492011-10-05 16:05:43 -0700840 if (!mBackupRunning) {
841 if (DEBUG) Slog.v(TAG, "Running a backup pass");
Christopher Tate4cc86e12009-09-21 19:36:51 -0700842
Christopher Tate336a6492011-10-05 16:05:43 -0700843 // Acquire the wakelock and pass it to the backup thread. it will
844 // be released once backup concludes.
845 mBackupRunning = true;
846 mWakelock.acquire();
Christopher Tate4cc86e12009-09-21 19:36:51 -0700847
Christopher Tate336a6492011-10-05 16:05:43 -0700848 Message msg = mBackupHandler.obtainMessage(MSG_RUN_BACKUP);
849 mBackupHandler.sendMessage(msg);
850 } else {
851 Slog.i(TAG, "Backup time but one already running");
852 }
Christopher Tate4cc86e12009-09-21 19:36:51 -0700853 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800854 Slog.w(TAG, "Backup pass but e=" + mEnabled + " p=" + mProvisioned);
Christopher Tate4cc86e12009-09-21 19:36:51 -0700855 }
856 }
857 }
858 }
859 }
860 }
861
862 private class RunInitializeReceiver extends BroadcastReceiver {
863 public void onReceive(Context context, Intent intent) {
864 if (RUN_INITIALIZE_ACTION.equals(intent.getAction())) {
865 synchronized (mQueueLock) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800866 if (DEBUG) Slog.v(TAG, "Running a device init");
Christopher Tate4cc86e12009-09-21 19:36:51 -0700867
868 // Acquire the wakelock and pass it to the init thread. it will
869 // be released once init concludes.
Christopher Tateb6787f22009-07-02 17:40:45 -0700870 mWakelock.acquire();
871
Christopher Tate4cc86e12009-09-21 19:36:51 -0700872 Message msg = mBackupHandler.obtainMessage(MSG_RUN_INITIALIZE);
Christopher Tateb6787f22009-07-02 17:40:45 -0700873 mBackupHandler.sendMessage(msg);
874 }
875 }
Christopher Tate49401dd2009-07-01 12:34:29 -0700876 }
Christopher Tateb6787f22009-07-02 17:40:45 -0700877 }
Christopher Tate3799bc22009-05-06 16:13:56 -0700878
Christopher Tate73e02522009-07-15 14:18:26 -0700879 private void initPackageTracking() {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800880 if (DEBUG) Slog.v(TAG, "Initializing package tracking");
Christopher Tate73e02522009-07-15 14:18:26 -0700881
Christopher Tate84725812010-02-04 15:52:40 -0800882 // Remember our ancestral dataset
883 mTokenFile = new File(mBaseStateDir, "ancestral");
884 try {
885 RandomAccessFile tf = new RandomAccessFile(mTokenFile, "r");
Christopher Tateb49ceb32010-02-08 16:22:24 -0800886 int version = tf.readInt();
887 if (version == CURRENT_ANCESTRAL_RECORD_VERSION) {
888 mAncestralToken = tf.readLong();
889 mCurrentToken = tf.readLong();
890
891 int numPackages = tf.readInt();
892 if (numPackages >= 0) {
893 mAncestralPackages = new HashSet<String>();
894 for (int i = 0; i < numPackages; i++) {
895 String pkgName = tf.readUTF();
896 mAncestralPackages.add(pkgName);
897 }
898 }
899 }
Brad Fitzpatrick725d8f02010-11-15 11:12:42 -0800900 tf.close();
Christopher Tate1168baa2010-02-17 13:03:40 -0800901 } catch (FileNotFoundException fnf) {
902 // Probably innocuous
Joe Onorato8a9b2202010-02-26 18:56:32 -0800903 Slog.v(TAG, "No ancestral data");
Christopher Tate84725812010-02-04 15:52:40 -0800904 } catch (IOException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800905 Slog.w(TAG, "Unable to read token file", e);
Christopher Tate84725812010-02-04 15:52:40 -0800906 }
907
Christopher Tatee97e8072009-07-15 16:45:50 -0700908 // Keep a log of what apps we've ever backed up. Because we might have
909 // rebooted in the middle of an operation that was removing something from
910 // this log, we sanity-check its contents here and reconstruct it.
Christopher Tate73e02522009-07-15 14:18:26 -0700911 mEverStored = new File(mBaseStateDir, "processed");
Christopher Tatee97e8072009-07-15 16:45:50 -0700912 File tempProcessedFile = new File(mBaseStateDir, "processed.new");
Christopher Tate73e02522009-07-15 14:18:26 -0700913
Christopher Tatee97e8072009-07-15 16:45:50 -0700914 // If we were in the middle of removing something from the ever-backed-up
915 // file, there might be a transient "processed.new" file still present.
Dan Egnor852f8e42009-09-30 11:20:45 -0700916 // Ignore it -- we'll validate "processed" against the current package set.
Christopher Tatee97e8072009-07-15 16:45:50 -0700917 if (tempProcessedFile.exists()) {
918 tempProcessedFile.delete();
919 }
920
Dan Egnor852f8e42009-09-30 11:20:45 -0700921 // If there are previous contents, parse them out then start a new
922 // file to continue the recordkeeping.
923 if (mEverStored.exists()) {
924 RandomAccessFile temp = null;
925 RandomAccessFile in = null;
926
927 try {
928 temp = new RandomAccessFile(tempProcessedFile, "rws");
929 in = new RandomAccessFile(mEverStored, "r");
930
931 while (true) {
932 PackageInfo info;
933 String pkg = in.readUTF();
934 try {
935 info = mPackageManager.getPackageInfo(pkg, 0);
936 mEverStoredApps.add(pkg);
937 temp.writeUTF(pkg);
Christopher Tatec58efa62011-08-01 19:20:14 -0700938 if (MORE_DEBUG) Slog.v(TAG, " + " + pkg);
Dan Egnor852f8e42009-09-30 11:20:45 -0700939 } catch (NameNotFoundException e) {
940 // nope, this package was uninstalled; don't include it
Christopher Tatec58efa62011-08-01 19:20:14 -0700941 if (MORE_DEBUG) Slog.v(TAG, " - " + pkg);
Dan Egnor852f8e42009-09-30 11:20:45 -0700942 }
943 }
944 } catch (EOFException e) {
945 // Once we've rewritten the backup history log, atomically replace the
946 // old one with the new one then reopen the file for continuing use.
947 if (!tempProcessedFile.renameTo(mEverStored)) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800948 Slog.e(TAG, "Error renaming " + tempProcessedFile + " to " + mEverStored);
Dan Egnor852f8e42009-09-30 11:20:45 -0700949 }
950 } catch (IOException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800951 Slog.e(TAG, "Error in processed file", e);
Dan Egnor852f8e42009-09-30 11:20:45 -0700952 } finally {
953 try { if (temp != null) temp.close(); } catch (IOException e) {}
954 try { if (in != null) in.close(); } catch (IOException e) {}
955 }
956 }
957
Christopher Tate73e02522009-07-15 14:18:26 -0700958 // Register for broadcasts about package install, etc., so we can
959 // update the provider list.
960 IntentFilter filter = new IntentFilter();
961 filter.addAction(Intent.ACTION_PACKAGE_ADDED);
962 filter.addAction(Intent.ACTION_PACKAGE_REMOVED);
Christopher Tatecc55f812011-08-16 16:06:53 -0700963 filter.addAction(Intent.ACTION_PACKAGE_REPLACED);
Christopher Tate73e02522009-07-15 14:18:26 -0700964 filter.addDataScheme("package");
965 mContext.registerReceiver(mBroadcastReceiver, filter);
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800966 // Register for events related to sdcard installation.
967 IntentFilter sdFilter = new IntentFilter();
Suchi Amalapurapub56ae202010-02-04 22:51:07 -0800968 sdFilter.addAction(Intent.ACTION_EXTERNAL_APPLICATIONS_AVAILABLE);
969 sdFilter.addAction(Intent.ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE);
Suchi Amalapurapu08675a32010-01-28 09:57:30 -0800970 mContext.registerReceiver(mBroadcastReceiver, sdFilter);
Christopher Tate73e02522009-07-15 14:18:26 -0700971 }
972
Christopher Tatecde87f42009-06-12 12:55:53 -0700973 private void parseLeftoverJournals() {
Dan Egnor852f8e42009-09-30 11:20:45 -0700974 for (File f : mJournalDir.listFiles()) {
975 if (mJournal == null || f.compareTo(mJournal) != 0) {
976 // This isn't the current journal, so it must be a leftover. Read
977 // out the package names mentioned there and schedule them for
978 // backup.
979 RandomAccessFile in = null;
980 try {
Joe Onorato431bb222010-10-18 19:13:23 -0400981 Slog.i(TAG, "Found stale backup journal, scheduling");
Dan Egnor852f8e42009-09-30 11:20:45 -0700982 in = new RandomAccessFile(f, "r");
983 while (true) {
984 String packageName = in.readUTF();
Joe Onorato431bb222010-10-18 19:13:23 -0400985 Slog.i(TAG, " " + packageName);
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -0700986 dataChangedImpl(packageName);
Christopher Tatecde87f42009-06-12 12:55:53 -0700987 }
Dan Egnor852f8e42009-09-30 11:20:45 -0700988 } catch (EOFException e) {
989 // no more data; we're done
990 } catch (Exception e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -0800991 Slog.e(TAG, "Can't read " + f, e);
Dan Egnor852f8e42009-09-30 11:20:45 -0700992 } finally {
993 // close/delete the file
994 try { if (in != null) in.close(); } catch (IOException e) {}
995 f.delete();
Christopher Tatecde87f42009-06-12 12:55:53 -0700996 }
997 }
998 }
999 }
1000
Christopher Tate2efd2db2011-07-19 16:32:49 -07001001 private SecretKey buildPasswordKey(String pw, byte[] salt, int rounds) {
1002 return buildCharArrayKey(pw.toCharArray(), salt, rounds);
1003 }
1004
1005 private SecretKey buildCharArrayKey(char[] pwArray, byte[] salt, int rounds) {
1006 try {
1007 SecretKeyFactory keyFactory = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1");
1008 KeySpec ks = new PBEKeySpec(pwArray, salt, rounds, PBKDF2_KEY_SIZE);
1009 return keyFactory.generateSecret(ks);
1010 } catch (InvalidKeySpecException e) {
1011 Slog.e(TAG, "Invalid key spec for PBKDF2!");
1012 } catch (NoSuchAlgorithmException e) {
1013 Slog.e(TAG, "PBKDF2 unavailable!");
1014 }
1015 return null;
1016 }
1017
1018 private String buildPasswordHash(String pw, byte[] salt, int rounds) {
1019 SecretKey key = buildPasswordKey(pw, salt, rounds);
1020 if (key != null) {
1021 return byteArrayToHex(key.getEncoded());
1022 }
1023 return null;
1024 }
1025
1026 private String byteArrayToHex(byte[] data) {
1027 StringBuilder buf = new StringBuilder(data.length * 2);
1028 for (int i = 0; i < data.length; i++) {
1029 buf.append(Byte.toHexString(data[i], true));
1030 }
1031 return buf.toString();
1032 }
1033
1034 private byte[] hexToByteArray(String digits) {
1035 final int bytes = digits.length() / 2;
1036 if (2*bytes != digits.length()) {
1037 throw new IllegalArgumentException("Hex string must have an even number of digits");
1038 }
1039
1040 byte[] result = new byte[bytes];
1041 for (int i = 0; i < digits.length(); i += 2) {
1042 result[i/2] = (byte) Integer.parseInt(digits.substring(i, i+2), 16);
1043 }
1044 return result;
1045 }
1046
1047 private byte[] makeKeyChecksum(byte[] pwBytes, byte[] salt, int rounds) {
1048 char[] mkAsChar = new char[pwBytes.length];
1049 for (int i = 0; i < pwBytes.length; i++) {
1050 mkAsChar[i] = (char) pwBytes[i];
1051 }
1052
1053 Key checksum = buildCharArrayKey(mkAsChar, salt, rounds);
1054 return checksum.getEncoded();
1055 }
1056
1057 // Used for generating random salts or passwords
1058 private byte[] randomBytes(int bits) {
1059 byte[] array = new byte[bits / 8];
1060 mRng.nextBytes(array);
1061 return array;
1062 }
1063
1064 // Backup password management
1065 boolean passwordMatchesSaved(String candidatePw, int rounds) {
Christopher Tate32418be2011-10-10 13:51:12 -07001066 // First, on an encrypted device we require matching the device pw
1067 final boolean isEncrypted;
1068 try {
1069 isEncrypted = (mMountService.getEncryptionState() != MountService.ENCRYPTION_STATE_NONE);
1070 if (isEncrypted) {
1071 if (DEBUG) {
1072 Slog.i(TAG, "Device encrypted; verifying against device data pw");
1073 }
1074 // 0 means the password validated
1075 // -2 means device not encrypted
1076 // Any other result is either password failure or an error condition,
1077 // so we refuse the match
1078 final int result = mMountService.verifyEncryptionPassword(candidatePw);
1079 if (result == 0) {
1080 if (MORE_DEBUG) Slog.d(TAG, "Pw verifies");
1081 return true;
1082 } else if (result != -2) {
1083 if (MORE_DEBUG) Slog.d(TAG, "Pw mismatch");
1084 return false;
1085 } else {
1086 // ...else the device is supposedly not encrypted. HOWEVER, the
1087 // query about the encryption state said that the device *is*
1088 // encrypted, so ... we may have a problem. Log it and refuse
1089 // the backup.
1090 Slog.e(TAG, "verified encryption state mismatch against query; no match allowed");
1091 return false;
1092 }
1093 }
1094 } catch (Exception e) {
1095 // Something went wrong talking to the mount service. This is very bad;
1096 // assume that we fail password validation.
1097 return false;
1098 }
1099
Christopher Tate2efd2db2011-07-19 16:32:49 -07001100 if (mPasswordHash == null) {
1101 // no current password case -- require that 'currentPw' be null or empty
1102 if (candidatePw == null || "".equals(candidatePw)) {
1103 return true;
1104 } // else the non-empty candidate does not match the empty stored pw
1105 } else {
1106 // hash the stated current pw and compare to the stored one
1107 if (candidatePw != null && candidatePw.length() > 0) {
1108 String currentPwHash = buildPasswordHash(candidatePw, mPasswordSalt, rounds);
1109 if (mPasswordHash.equalsIgnoreCase(currentPwHash)) {
1110 // candidate hash matches the stored hash -- the password matches
1111 return true;
1112 }
1113 } // else the stored pw is nonempty but the candidate is empty; no match
1114 }
1115 return false;
1116 }
1117
1118 @Override
1119 public boolean setBackupPassword(String currentPw, String newPw) {
1120 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
1121 "setBackupPassword");
1122
1123 // If the supplied pw doesn't hash to the the saved one, fail
1124 if (!passwordMatchesSaved(currentPw, PBKDF2_HASH_ROUNDS)) {
1125 return false;
1126 }
1127
1128 // Clearing the password is okay
1129 if (newPw == null || newPw.isEmpty()) {
1130 if (mPasswordHashFile.exists()) {
1131 if (!mPasswordHashFile.delete()) {
1132 // Unable to delete the old pw file, so fail
1133 Slog.e(TAG, "Unable to clear backup password");
1134 return false;
1135 }
1136 }
1137 mPasswordHash = null;
1138 mPasswordSalt = null;
1139 return true;
1140 }
1141
1142 try {
1143 // Okay, build the hash of the new backup password
1144 byte[] salt = randomBytes(PBKDF2_SALT_SIZE);
1145 String newPwHash = buildPasswordHash(newPw, salt, PBKDF2_HASH_ROUNDS);
1146
1147 OutputStream pwf = null, buffer = null;
1148 DataOutputStream out = null;
1149 try {
1150 pwf = new FileOutputStream(mPasswordHashFile);
1151 buffer = new BufferedOutputStream(pwf);
1152 out = new DataOutputStream(buffer);
1153 // integer length of the salt array, followed by the salt,
1154 // then the hex pw hash string
1155 out.writeInt(salt.length);
1156 out.write(salt);
1157 out.writeUTF(newPwHash);
1158 out.flush();
1159 mPasswordHash = newPwHash;
1160 mPasswordSalt = salt;
1161 return true;
1162 } finally {
1163 if (out != null) out.close();
1164 if (buffer != null) buffer.close();
1165 if (pwf != null) pwf.close();
1166 }
1167 } catch (IOException e) {
1168 Slog.e(TAG, "Unable to set backup password");
1169 }
1170 return false;
1171 }
1172
1173 @Override
1174 public boolean hasBackupPassword() {
1175 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
1176 "hasBackupPassword");
Christopher Tate32418be2011-10-10 13:51:12 -07001177
1178 try {
1179 return (mMountService.getEncryptionState() != IMountService.ENCRYPTION_STATE_NONE)
1180 || (mPasswordHash != null && mPasswordHash.length() > 0);
1181 } catch (Exception e) {
1182 // If we can't talk to the mount service we have a serious problem; fail
1183 // "secure" i.e. assuming that we require a password
1184 return true;
1185 }
Christopher Tate2efd2db2011-07-19 16:32:49 -07001186 }
1187
Christopher Tate4cc86e12009-09-21 19:36:51 -07001188 // Maintain persistent state around whether need to do an initialize operation.
1189 // Must be called with the queue lock held.
1190 void recordInitPendingLocked(boolean isPending, String transportName) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001191 if (DEBUG) Slog.i(TAG, "recordInitPendingLocked: " + isPending
Christopher Tate4cc86e12009-09-21 19:36:51 -07001192 + " on transport " + transportName);
1193 try {
1194 IBackupTransport transport = getTransport(transportName);
1195 String transportDirName = transport.transportDirName();
1196 File stateDir = new File(mBaseStateDir, transportDirName);
1197 File initPendingFile = new File(stateDir, INIT_SENTINEL_FILE_NAME);
1198
1199 if (isPending) {
1200 // We need an init before we can proceed with sending backup data.
1201 // Record that with an entry in our set of pending inits, as well as
1202 // journaling it via creation of a sentinel file.
1203 mPendingInits.add(transportName);
1204 try {
1205 (new FileOutputStream(initPendingFile)).close();
1206 } catch (IOException ioe) {
1207 // Something is badly wrong with our permissions; just try to move on
1208 }
1209 } else {
1210 // No more initialization needed; wipe the journal and reset our state.
1211 initPendingFile.delete();
1212 mPendingInits.remove(transportName);
1213 }
1214 } catch (RemoteException e) {
1215 // can't happen; the transport is local
1216 }
1217 }
1218
Christopher Tated55e18a2009-09-21 10:12:59 -07001219 // Reset all of our bookkeeping, in response to having been told that
1220 // the backend data has been wiped [due to idle expiry, for example],
1221 // so we must re-upload all saved settings.
1222 void resetBackupState(File stateFileDir) {
1223 synchronized (mQueueLock) {
1224 // Wipe the "what we've ever backed up" tracking
Christopher Tated55e18a2009-09-21 10:12:59 -07001225 mEverStoredApps.clear();
Dan Egnor852f8e42009-09-30 11:20:45 -07001226 mEverStored.delete();
Christopher Tated55e18a2009-09-21 10:12:59 -07001227
Christopher Tate84725812010-02-04 15:52:40 -08001228 mCurrentToken = 0;
1229 writeRestoreTokens();
1230
Christopher Tated55e18a2009-09-21 10:12:59 -07001231 // Remove all the state files
1232 for (File sf : stateFileDir.listFiles()) {
Christopher Tate4cc86e12009-09-21 19:36:51 -07001233 // ... but don't touch the needs-init sentinel
1234 if (!sf.getName().equals(INIT_SENTINEL_FILE_NAME)) {
1235 sf.delete();
1236 }
Christopher Tated55e18a2009-09-21 10:12:59 -07001237 }
Christopher Tate45597642011-04-04 16:59:21 -07001238 }
Christopher Tated55e18a2009-09-21 10:12:59 -07001239
Christopher Tate45597642011-04-04 16:59:21 -07001240 // Enqueue a new backup of every participant
Christopher Tate8e294d42011-08-31 20:37:12 -07001241 synchronized (mBackupParticipants) {
1242 int N = mBackupParticipants.size();
1243 for (int i=0; i<N; i++) {
1244 int uid = mBackupParticipants.keyAt(i);
1245 HashSet<ApplicationInfo> participants = mBackupParticipants.valueAt(i);
1246 for (ApplicationInfo app: participants) {
1247 dataChangedImpl(app.packageName);
1248 }
Christopher Tated55e18a2009-09-21 10:12:59 -07001249 }
1250 }
1251 }
1252
Christopher Tatedfa47b56e2009-12-22 16:01:32 -08001253 // Add a transport to our set of available backends. If 'transport' is null, this
1254 // is an unregistration, and the transport's entry is removed from our bookkeeping.
Christopher Tate91717492009-06-26 21:07:13 -07001255 private void registerTransport(String name, IBackupTransport transport) {
1256 synchronized (mTransports) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001257 if (DEBUG) Slog.v(TAG, "Registering transport " + name + " = " + transport);
Christopher Tatedfa47b56e2009-12-22 16:01:32 -08001258 if (transport != null) {
1259 mTransports.put(name, transport);
1260 } else {
1261 mTransports.remove(name);
Christopher Tateb0dcaaf2010-01-29 16:27:04 -08001262 if ((mCurrentTransport != null) && mCurrentTransport.equals(name)) {
Christopher Tatedfa47b56e2009-12-22 16:01:32 -08001263 mCurrentTransport = null;
1264 }
1265 // Nothing further to do in the unregistration case
1266 return;
1267 }
Christopher Tate91717492009-06-26 21:07:13 -07001268 }
Christopher Tate4cc86e12009-09-21 19:36:51 -07001269
1270 // If the init sentinel file exists, we need to be sure to perform the init
1271 // as soon as practical. We also create the state directory at registration
1272 // time to ensure it's present from the outset.
1273 try {
1274 String transportName = transport.transportDirName();
1275 File stateDir = new File(mBaseStateDir, transportName);
1276 stateDir.mkdirs();
1277
1278 File initSentinel = new File(stateDir, INIT_SENTINEL_FILE_NAME);
1279 if (initSentinel.exists()) {
1280 synchronized (mQueueLock) {
1281 mPendingInits.add(transportName);
1282
1283 // TODO: pick a better starting time than now + 1 minute
1284 long delay = 1000 * 60; // one minute, in milliseconds
1285 mAlarmManager.set(AlarmManager.RTC_WAKEUP,
1286 System.currentTimeMillis() + delay, mRunInitIntent);
1287 }
1288 }
1289 } catch (RemoteException e) {
1290 // can't happen, the transport is local
1291 }
Christopher Tate91717492009-06-26 21:07:13 -07001292 }
1293
Christopher Tate3799bc22009-05-06 16:13:56 -07001294 // ----- Track installation/removal of packages -----
1295 BroadcastReceiver mBroadcastReceiver = new BroadcastReceiver() {
1296 public void onReceive(Context context, Intent intent) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001297 if (DEBUG) Slog.d(TAG, "Received broadcast " + intent);
Christopher Tate3799bc22009-05-06 16:13:56 -07001298
Christopher Tate3799bc22009-05-06 16:13:56 -07001299 String action = intent.getAction();
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001300 boolean replacing = false;
1301 boolean added = false;
1302 Bundle extras = intent.getExtras();
1303 String pkgList[] = null;
1304 if (Intent.ACTION_PACKAGE_ADDED.equals(action) ||
Christopher Tatecc55f812011-08-16 16:06:53 -07001305 Intent.ACTION_PACKAGE_REMOVED.equals(action) ||
1306 Intent.ACTION_PACKAGE_REPLACED.equals(action)) {
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001307 Uri uri = intent.getData();
1308 if (uri == null) {
1309 return;
1310 }
1311 String pkgName = uri.getSchemeSpecificPart();
1312 if (pkgName != null) {
1313 pkgList = new String[] { pkgName };
1314 }
Christopher Tatecc55f812011-08-16 16:06:53 -07001315 if (Intent.ACTION_PACKAGE_REPLACED.equals(action)) {
1316 // use the existing "add with replacement" logic
1317 if (MORE_DEBUG) Slog.d(TAG, "PACKAGE_REPLACED, updating package " + pkgName);
1318 added = replacing = true;
1319 } else {
1320 added = Intent.ACTION_PACKAGE_ADDED.equals(action);
1321 replacing = extras.getBoolean(Intent.EXTRA_REPLACING, false);
1322 }
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001323 } else if (Intent.ACTION_EXTERNAL_APPLICATIONS_AVAILABLE.equals(action)) {
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001324 added = true;
1325 pkgList = intent.getStringArrayExtra(Intent.EXTRA_CHANGED_PACKAGE_LIST);
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001326 } else if (Intent.ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE.equals(action)) {
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001327 added = false;
1328 pkgList = intent.getStringArrayExtra(Intent.EXTRA_CHANGED_PACKAGE_LIST);
1329 }
Christopher Tatecc55f812011-08-16 16:06:53 -07001330
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001331 if (pkgList == null || pkgList.length == 0) {
1332 return;
1333 }
1334 if (added) {
Christopher Tate3799bc22009-05-06 16:13:56 -07001335 synchronized (mBackupParticipants) {
Christopher Tate0bacfd22012-01-11 14:41:19 -08001336 if (replacing) {
1337 updatePackageParticipantsLocked(pkgList);
1338 } else {
1339 addPackageParticipantsLocked(pkgList);
Christopher Tate3799bc22009-05-06 16:13:56 -07001340 }
1341 }
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001342 } else {
1343 if (replacing) {
Christopher Tate3799bc22009-05-06 16:13:56 -07001344 // The package is being updated. We'll receive a PACKAGE_ADDED shortly.
1345 } else {
1346 synchronized (mBackupParticipants) {
Christopher Tate0bacfd22012-01-11 14:41:19 -08001347 removePackageParticipantsLocked(pkgList);
Christopher Tate3799bc22009-05-06 16:13:56 -07001348 }
1349 }
1350 }
1351 }
1352 };
1353
Dan Egnor87a02bc2009-06-17 02:30:10 -07001354 // ----- Track connection to GoogleBackupTransport service -----
1355 ServiceConnection mGoogleConnection = new ServiceConnection() {
1356 public void onServiceConnected(ComponentName name, IBinder service) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001357 if (DEBUG) Slog.v(TAG, "Connected to Google transport");
Dan Egnor87a02bc2009-06-17 02:30:10 -07001358 mGoogleTransport = IBackupTransport.Stub.asInterface(service);
Christopher Tate91717492009-06-26 21:07:13 -07001359 registerTransport(name.flattenToShortString(), mGoogleTransport);
Dan Egnor87a02bc2009-06-17 02:30:10 -07001360 }
1361
1362 public void onServiceDisconnected(ComponentName name) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001363 if (DEBUG) Slog.v(TAG, "Disconnected from Google transport");
Dan Egnor87a02bc2009-06-17 02:30:10 -07001364 mGoogleTransport = null;
Christopher Tate91717492009-06-26 21:07:13 -07001365 registerTransport(name.flattenToShortString(), null);
Dan Egnor87a02bc2009-06-17 02:30:10 -07001366 }
1367 };
1368
Christopher Tate0bacfd22012-01-11 14:41:19 -08001369 // Add the backup agents in the given packages to our set of known backup participants.
1370 // If 'packageNames' is null, adds all backup agents in the whole system.
1371 void addPackageParticipantsLocked(String[] packageNames) {
Christopher Tate181fafa2009-05-14 11:12:14 -07001372 // Look for apps that define the android:backupAgent attribute
Dan Egnorefe52642009-06-24 00:16:33 -07001373 List<PackageInfo> targetApps = allAgentPackages();
Christopher Tate0bacfd22012-01-11 14:41:19 -08001374 if (packageNames != null) {
1375 if (DEBUG) Slog.v(TAG, "addPackageParticipantsLocked: #" + packageNames.length);
1376 for (String packageName : packageNames) {
1377 addPackageParticipantsLockedInner(packageName, targetApps);
1378 }
1379 } else {
1380 if (DEBUG) Slog.v(TAG, "addPackageParticipantsLocked: all");
1381 addPackageParticipantsLockedInner(null, targetApps);
1382 }
Christopher Tate3799bc22009-05-06 16:13:56 -07001383 }
1384
Christopher Tate181fafa2009-05-14 11:12:14 -07001385 private void addPackageParticipantsLockedInner(String packageName,
Dan Egnorefe52642009-06-24 00:16:33 -07001386 List<PackageInfo> targetPkgs) {
Christopher Tatec58efa62011-08-01 19:20:14 -07001387 if (MORE_DEBUG) {
Christopher Tate0bacfd22012-01-11 14:41:19 -08001388 Slog.v(TAG, "Examining " + packageName + " for backup agent");
Christopher Tate181fafa2009-05-14 11:12:14 -07001389 }
1390
Dan Egnorefe52642009-06-24 00:16:33 -07001391 for (PackageInfo pkg : targetPkgs) {
1392 if (packageName == null || pkg.packageName.equals(packageName)) {
1393 int uid = pkg.applicationInfo.uid;
Christopher Tate181fafa2009-05-14 11:12:14 -07001394 HashSet<ApplicationInfo> set = mBackupParticipants.get(uid);
Christopher Tate3799bc22009-05-06 16:13:56 -07001395 if (set == null) {
Christopher Tate181fafa2009-05-14 11:12:14 -07001396 set = new HashSet<ApplicationInfo>();
Christopher Tate3799bc22009-05-06 16:13:56 -07001397 mBackupParticipants.put(uid, set);
1398 }
Dan Egnorefe52642009-06-24 00:16:33 -07001399 set.add(pkg.applicationInfo);
Christopher Tate0bacfd22012-01-11 14:41:19 -08001400 if (MORE_DEBUG) Slog.v(TAG, "Agent found; added");
Christopher Tate73e02522009-07-15 14:18:26 -07001401
1402 // If we've never seen this app before, schedule a backup for it
1403 if (!mEverStoredApps.contains(pkg.packageName)) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001404 if (DEBUG) Slog.i(TAG, "New app " + pkg.packageName
Christopher Tate73e02522009-07-15 14:18:26 -07001405 + " never backed up; scheduling");
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07001406 dataChangedImpl(pkg.packageName);
Christopher Tate73e02522009-07-15 14:18:26 -07001407 }
Christopher Tate3799bc22009-05-06 16:13:56 -07001408 }
Christopher Tate487529a2009-04-29 14:03:25 -07001409 }
1410 }
1411
Christopher Tate0bacfd22012-01-11 14:41:19 -08001412 // Remove the given packages' entries from our known active set.
1413 void removePackageParticipantsLocked(String[] packageNames) {
1414 if (packageNames == null) {
1415 Slog.w(TAG, "removePackageParticipants with null list");
1416 return;
Christopher Tate181fafa2009-05-14 11:12:14 -07001417 }
Christopher Tate0bacfd22012-01-11 14:41:19 -08001418
1419 if (DEBUG) Slog.v(TAG, "removePackageParticipantsLocked: #" + packageNames.length);
1420 List<PackageInfo> knownPackages = allAgentPackages();
1421 for (String pkg : packageNames) {
1422 removePackageParticipantsLockedInner(pkg, knownPackages);
1423 }
Christopher Tate3799bc22009-05-06 16:13:56 -07001424 }
1425
Joe Onorato8ad02812009-05-13 01:41:44 -04001426 private void removePackageParticipantsLockedInner(String packageName,
Christopher Tate0bacfd22012-01-11 14:41:19 -08001427 List<PackageInfo> allPackages) {
Christopher Tatec58efa62011-08-01 19:20:14 -07001428 if (MORE_DEBUG) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001429 Slog.v(TAG, "removePackageParticipantsLockedInner (" + packageName
Christopher Tate0bacfd22012-01-11 14:41:19 -08001430 + ") removing from " + allPackages.size() + " entries");
1431 for (PackageInfo p : allPackages) {
1432 Slog.v(TAG, " - " + p.packageName);
Christopher Tate043dadc2009-06-02 16:11:00 -07001433 }
1434 }
Christopher Tate0bacfd22012-01-11 14:41:19 -08001435 for (PackageInfo pkg : allPackages) {
1436 if (packageName == null || pkg.packageName.equals(packageName)) {
1437 /*
Christopher Tatec28083a2010-12-14 16:16:44 -08001438 int uid = -1;
1439 try {
1440 PackageInfo info = mPackageManager.getPackageInfo(packageName, 0);
1441 uid = info.applicationInfo.uid;
1442 } catch (NameNotFoundException e) {
1443 // we don't know this package name, so just skip it for now
1444 continue;
1445 }
Christopher Tate0bacfd22012-01-11 14:41:19 -08001446 */
1447 final int uid = pkg.applicationInfo.uid;
1448 if (MORE_DEBUG) Slog.i(TAG, " found pkg " + packageName + " uid=" + uid);
Christopher Tatec28083a2010-12-14 16:16:44 -08001449
Christopher Tate181fafa2009-05-14 11:12:14 -07001450 HashSet<ApplicationInfo> set = mBackupParticipants.get(uid);
Christopher Tate3799bc22009-05-06 16:13:56 -07001451 if (set != null) {
Christopher Tatecd4ff2e2009-06-05 13:57:54 -07001452 // Find the existing entry with the same package name, and remove it.
1453 // We can't just remove(app) because the instances are different.
1454 for (ApplicationInfo entry: set) {
Christopher Tate0bacfd22012-01-11 14:41:19 -08001455 if (MORE_DEBUG) Slog.i(TAG, " checking against " + entry.packageName);
Christopher Tatec28083a2010-12-14 16:16:44 -08001456 if (entry.packageName.equals(pkg)) {
Christopher Tatec58efa62011-08-01 19:20:14 -07001457 if (MORE_DEBUG) Slog.v(TAG, " removing participant " + pkg);
Christopher Tatecd4ff2e2009-06-05 13:57:54 -07001458 set.remove(entry);
Christopher Tate0bacfd22012-01-11 14:41:19 -08001459 removeEverBackedUp(pkg.packageName);
Christopher Tatecd4ff2e2009-06-05 13:57:54 -07001460 break;
1461 }
1462 }
Christopher Tate3799bc22009-05-06 16:13:56 -07001463 if (set.size() == 0) {
Dan Egnorefe52642009-06-24 00:16:33 -07001464 mBackupParticipants.delete(uid);
1465 }
Christopher Tate0bacfd22012-01-11 14:41:19 -08001466 } else {
1467 if (MORE_DEBUG) Slog.i(TAG, " ... not found in uid mapping");
Christopher Tate3799bc22009-05-06 16:13:56 -07001468 }
1469 }
1470 }
1471 }
1472
Christopher Tate181fafa2009-05-14 11:12:14 -07001473 // Returns the set of all applications that define an android:backupAgent attribute
Christopher Tate73e02522009-07-15 14:18:26 -07001474 List<PackageInfo> allAgentPackages() {
Christopher Tate6785dd82009-06-18 15:58:25 -07001475 // !!! TODO: cache this and regenerate only when necessary
Dan Egnorefe52642009-06-24 00:16:33 -07001476 int flags = PackageManager.GET_SIGNATURES;
1477 List<PackageInfo> packages = mPackageManager.getInstalledPackages(flags);
1478 int N = packages.size();
1479 for (int a = N-1; a >= 0; a--) {
Christopher Tate0749dcd2009-08-13 15:13:03 -07001480 PackageInfo pkg = packages.get(a);
Christopher Tateb8eb1cb2009-09-16 10:57:21 -07001481 try {
1482 ApplicationInfo app = pkg.applicationInfo;
1483 if (((app.flags&ApplicationInfo.FLAG_ALLOW_BACKUP) == 0)
Christopher Tatea87240c2010-02-12 14:12:34 -08001484 || app.backupAgentName == null) {
Christopher Tateb8eb1cb2009-09-16 10:57:21 -07001485 packages.remove(a);
1486 }
1487 else {
1488 // we will need the shared library path, so look that up and store it here
1489 app = mPackageManager.getApplicationInfo(pkg.packageName,
1490 PackageManager.GET_SHARED_LIBRARY_FILES);
1491 pkg.applicationInfo.sharedLibraryFiles = app.sharedLibraryFiles;
1492 }
1493 } catch (NameNotFoundException e) {
Dan Egnorefe52642009-06-24 00:16:33 -07001494 packages.remove(a);
Christopher Tate181fafa2009-05-14 11:12:14 -07001495 }
1496 }
Dan Egnorefe52642009-06-24 00:16:33 -07001497 return packages;
Christopher Tate181fafa2009-05-14 11:12:14 -07001498 }
Christopher Tateaa088442009-06-16 18:25:46 -07001499
Christopher Tate3799bc22009-05-06 16:13:56 -07001500 // Reset the given package's known backup participants. Unlike add/remove, the update
1501 // action cannot be passed a null package name.
Christopher Tate0bacfd22012-01-11 14:41:19 -08001502 void updatePackageParticipantsLocked(String[] packageNames) {
1503 if (packageNames == null) {
1504 Slog.e(TAG, "updatePackageParticipants called with null package list");
Christopher Tate3799bc22009-05-06 16:13:56 -07001505 return;
1506 }
Christopher Tate0bacfd22012-01-11 14:41:19 -08001507 if (DEBUG) Slog.v(TAG, "updatePackageParticipantsLocked: #" + packageNames.length);
Christopher Tate3799bc22009-05-06 16:13:56 -07001508
Christopher Tate0bacfd22012-01-11 14:41:19 -08001509 if (packageNames.length > 0) {
1510 List<PackageInfo> allApps = allAgentPackages();
1511 for (String packageName : packageNames) {
1512 removePackageParticipantsLockedInner(packageName, allApps);
1513 addPackageParticipantsLockedInner(packageName, allApps);
1514 }
Christopher Tatec28083a2010-12-14 16:16:44 -08001515 }
Christopher Tate3799bc22009-05-06 16:13:56 -07001516 }
1517
Christopher Tate84725812010-02-04 15:52:40 -08001518 // Called from the backup task: record that the given app has been successfully
Christopher Tate73e02522009-07-15 14:18:26 -07001519 // backed up at least once
1520 void logBackupComplete(String packageName) {
Dan Egnor852f8e42009-09-30 11:20:45 -07001521 if (packageName.equals(PACKAGE_MANAGER_SENTINEL)) return;
1522
1523 synchronized (mEverStoredApps) {
1524 if (!mEverStoredApps.add(packageName)) return;
1525
1526 RandomAccessFile out = null;
1527 try {
1528 out = new RandomAccessFile(mEverStored, "rws");
1529 out.seek(out.length());
1530 out.writeUTF(packageName);
1531 } catch (IOException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001532 Slog.e(TAG, "Can't log backup of " + packageName + " to " + mEverStored);
Dan Egnor852f8e42009-09-30 11:20:45 -07001533 } finally {
1534 try { if (out != null) out.close(); } catch (IOException e) {}
Christopher Tate73e02522009-07-15 14:18:26 -07001535 }
1536 }
1537 }
1538
Christopher Tatee97e8072009-07-15 16:45:50 -07001539 // Remove our awareness of having ever backed up the given package
1540 void removeEverBackedUp(String packageName) {
Christopher Tatec58efa62011-08-01 19:20:14 -07001541 if (DEBUG) Slog.v(TAG, "Removing backed-up knowledge of " + packageName);
1542 if (MORE_DEBUG) Slog.v(TAG, "New set:");
Christopher Tatee97e8072009-07-15 16:45:50 -07001543
Dan Egnor852f8e42009-09-30 11:20:45 -07001544 synchronized (mEverStoredApps) {
1545 // Rewrite the file and rename to overwrite. If we reboot in the middle,
1546 // we'll recognize on initialization time that the package no longer
1547 // exists and fix it up then.
1548 File tempKnownFile = new File(mBaseStateDir, "processed.new");
1549 RandomAccessFile known = null;
1550 try {
1551 known = new RandomAccessFile(tempKnownFile, "rws");
1552 mEverStoredApps.remove(packageName);
1553 for (String s : mEverStoredApps) {
1554 known.writeUTF(s);
Christopher Tatec58efa62011-08-01 19:20:14 -07001555 if (MORE_DEBUG) Slog.v(TAG, " " + s);
Christopher Tatee97e8072009-07-15 16:45:50 -07001556 }
Dan Egnor852f8e42009-09-30 11:20:45 -07001557 known.close();
1558 known = null;
1559 if (!tempKnownFile.renameTo(mEverStored)) {
1560 throw new IOException("Can't rename " + tempKnownFile + " to " + mEverStored);
1561 }
1562 } catch (IOException e) {
1563 // Bad: we couldn't create the new copy. For safety's sake we
1564 // abandon the whole process and remove all what's-backed-up
1565 // state entirely, meaning we'll force a backup pass for every
1566 // participant on the next boot or [re]install.
Joe Onorato8a9b2202010-02-26 18:56:32 -08001567 Slog.w(TAG, "Error rewriting " + mEverStored, e);
Dan Egnor852f8e42009-09-30 11:20:45 -07001568 mEverStoredApps.clear();
1569 tempKnownFile.delete();
1570 mEverStored.delete();
1571 } finally {
1572 try { if (known != null) known.close(); } catch (IOException e) {}
Christopher Tatee97e8072009-07-15 16:45:50 -07001573 }
1574 }
1575 }
1576
Christopher Tateb49ceb32010-02-08 16:22:24 -08001577 // Persistently record the current and ancestral backup tokens as well
1578 // as the set of packages with data [supposedly] available in the
1579 // ancestral dataset.
Christopher Tate84725812010-02-04 15:52:40 -08001580 void writeRestoreTokens() {
1581 try {
1582 RandomAccessFile af = new RandomAccessFile(mTokenFile, "rwd");
Christopher Tateb49ceb32010-02-08 16:22:24 -08001583
1584 // First, the version number of this record, for futureproofing
1585 af.writeInt(CURRENT_ANCESTRAL_RECORD_VERSION);
1586
1587 // Write the ancestral and current tokens
Christopher Tate84725812010-02-04 15:52:40 -08001588 af.writeLong(mAncestralToken);
1589 af.writeLong(mCurrentToken);
Christopher Tateb49ceb32010-02-08 16:22:24 -08001590
1591 // Now write the set of ancestral packages
1592 if (mAncestralPackages == null) {
1593 af.writeInt(-1);
1594 } else {
1595 af.writeInt(mAncestralPackages.size());
Joe Onorato8a9b2202010-02-26 18:56:32 -08001596 if (DEBUG) Slog.v(TAG, "Ancestral packages: " + mAncestralPackages.size());
Christopher Tateb49ceb32010-02-08 16:22:24 -08001597 for (String pkgName : mAncestralPackages) {
1598 af.writeUTF(pkgName);
Christopher Tatec58efa62011-08-01 19:20:14 -07001599 if (MORE_DEBUG) Slog.v(TAG, " " + pkgName);
Christopher Tateb49ceb32010-02-08 16:22:24 -08001600 }
1601 }
Christopher Tate84725812010-02-04 15:52:40 -08001602 af.close();
1603 } catch (IOException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001604 Slog.w(TAG, "Unable to write token file:", e);
Christopher Tate84725812010-02-04 15:52:40 -08001605 }
1606 }
1607
Dan Egnor87a02bc2009-06-17 02:30:10 -07001608 // Return the given transport
Christopher Tate91717492009-06-26 21:07:13 -07001609 private IBackupTransport getTransport(String transportName) {
1610 synchronized (mTransports) {
1611 IBackupTransport transport = mTransports.get(transportName);
1612 if (transport == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001613 Slog.w(TAG, "Requested unavailable transport: " + transportName);
Christopher Tate91717492009-06-26 21:07:13 -07001614 }
1615 return transport;
Christopher Tate8c850b72009-06-07 19:33:20 -07001616 }
Christopher Tate8c850b72009-06-07 19:33:20 -07001617 }
1618
Christopher Tatedf01dea2009-06-09 20:45:02 -07001619 // fire off a backup agent, blocking until it attaches or times out
1620 IBackupAgent bindToAgentSynchronous(ApplicationInfo app, int mode) {
1621 IBackupAgent agent = null;
1622 synchronized(mAgentConnectLock) {
1623 mConnecting = true;
1624 mConnectedAgent = null;
1625 try {
1626 if (mActivityManager.bindBackupAgent(app, mode)) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001627 Slog.d(TAG, "awaiting agent for " + app);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001628
1629 // success; wait for the agent to arrive
Christopher Tate75a99702011-05-18 16:28:19 -07001630 // only wait 10 seconds for the bind to happen
Christopher Tatec7b31e32009-06-10 15:49:30 -07001631 long timeoutMark = System.currentTimeMillis() + TIMEOUT_INTERVAL;
1632 while (mConnecting && mConnectedAgent == null
1633 && (System.currentTimeMillis() < timeoutMark)) {
Christopher Tatedf01dea2009-06-09 20:45:02 -07001634 try {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001635 mAgentConnectLock.wait(5000);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001636 } catch (InterruptedException e) {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001637 // just bail
Christopher Tate6de74ff2012-01-17 15:20:32 -08001638 if (DEBUG) Slog.w(TAG, "Interrupted: " + e);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001639 return null;
1640 }
1641 }
1642
1643 // if we timed out with no connect, abort and move on
1644 if (mConnecting == true) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001645 Slog.w(TAG, "Timeout waiting for agent " + app);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001646 return null;
1647 }
Christopher Tate6de74ff2012-01-17 15:20:32 -08001648 if (DEBUG) Slog.i(TAG, "got agent " + mConnectedAgent);
Christopher Tatedf01dea2009-06-09 20:45:02 -07001649 agent = mConnectedAgent;
1650 }
1651 } catch (RemoteException e) {
1652 // can't happen
1653 }
1654 }
1655 return agent;
1656 }
1657
Christopher Tatec7b31e32009-06-10 15:49:30 -07001658 // clear an application's data, blocking until the operation completes or times out
1659 void clearApplicationDataSynchronous(String packageName) {
Christopher Tatef7c886b2009-06-26 15:34:09 -07001660 // Don't wipe packages marked allowClearUserData=false
1661 try {
1662 PackageInfo info = mPackageManager.getPackageInfo(packageName, 0);
1663 if ((info.applicationInfo.flags & ApplicationInfo.FLAG_ALLOW_CLEAR_USER_DATA) == 0) {
Christopher Tatec58efa62011-08-01 19:20:14 -07001664 if (MORE_DEBUG) Slog.i(TAG, "allowClearUserData=false so not wiping "
Christopher Tatef7c886b2009-06-26 15:34:09 -07001665 + packageName);
1666 return;
1667 }
1668 } catch (NameNotFoundException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001669 Slog.w(TAG, "Tried to clear data for " + packageName + " but not found");
Christopher Tatef7c886b2009-06-26 15:34:09 -07001670 return;
1671 }
1672
Christopher Tatec7b31e32009-06-10 15:49:30 -07001673 ClearDataObserver observer = new ClearDataObserver();
1674
1675 synchronized(mClearDataLock) {
1676 mClearingData = true;
Christopher Tate9dfdac52009-08-06 14:57:53 -07001677 try {
Amith Yamasani742a6712011-05-04 14:49:28 -07001678 mActivityManager.clearApplicationUserData(packageName, observer,
1679 Binder.getOrigCallingUser());
Christopher Tate9dfdac52009-08-06 14:57:53 -07001680 } catch (RemoteException e) {
1681 // can't happen because the activity manager is in this process
1682 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07001683
1684 // only wait 10 seconds for the clear data to happen
1685 long timeoutMark = System.currentTimeMillis() + TIMEOUT_INTERVAL;
1686 while (mClearingData && (System.currentTimeMillis() < timeoutMark)) {
1687 try {
1688 mClearDataLock.wait(5000);
1689 } catch (InterruptedException e) {
1690 // won't happen, but still.
1691 mClearingData = false;
1692 }
1693 }
1694 }
1695 }
1696
1697 class ClearDataObserver extends IPackageDataObserver.Stub {
Dan Egnor852f8e42009-09-30 11:20:45 -07001698 public void onRemoveCompleted(String packageName, boolean succeeded) {
Christopher Tatec7b31e32009-06-10 15:49:30 -07001699 synchronized(mClearDataLock) {
1700 mClearingData = false;
Christopher Tatef68eb502009-06-16 11:02:01 -07001701 mClearDataLock.notifyAll();
Christopher Tatec7b31e32009-06-10 15:49:30 -07001702 }
1703 }
1704 }
1705
Christopher Tate1bb69062010-02-19 17:02:12 -08001706 // Get the restore-set token for the best-available restore set for this package:
1707 // the active set if possible, else the ancestral one. Returns zero if none available.
1708 long getAvailableRestoreToken(String packageName) {
1709 long token = mAncestralToken;
1710 synchronized (mQueueLock) {
1711 if (mEverStoredApps.contains(packageName)) {
1712 token = mCurrentToken;
1713 }
1714 }
1715 return token;
1716 }
1717
Christopher Tate44a27902010-01-27 17:15:49 -08001718 // -----
Christopher Tate8e294d42011-08-31 20:37:12 -07001719 // Interface and methods used by the asynchronous-with-timeout backup/restore operations
1720
1721 interface BackupRestoreTask {
1722 // Execute one tick of whatever state machine the task implements
1723 void execute();
1724
1725 // An operation that wanted a callback has completed
1726 void operationComplete();
1727
1728 // An operation that wanted a callback has timed out
1729 void handleTimeout();
1730 }
1731
1732 void prepareOperationTimeout(int token, long interval, BackupRestoreTask callback) {
1733 if (MORE_DEBUG) Slog.v(TAG, "starting timeout: token=" + Integer.toHexString(token)
1734 + " interval=" + interval);
Christopher Tate44a27902010-01-27 17:15:49 -08001735 synchronized (mCurrentOpLock) {
Christopher Tate8e294d42011-08-31 20:37:12 -07001736 mCurrentOperations.put(token, new Operation(OP_PENDING, callback));
1737
1738 Message msg = mBackupHandler.obtainMessage(MSG_TIMEOUT, token, 0, callback);
1739 mBackupHandler.sendMessageDelayed(msg, interval);
1740 }
1741 }
1742
1743 // synchronous waiter case
1744 boolean waitUntilOperationComplete(int token) {
1745 if (MORE_DEBUG) Slog.i(TAG, "Blocking until operation complete for "
1746 + Integer.toHexString(token));
1747 int finalState = OP_PENDING;
1748 Operation op = null;
1749 synchronized (mCurrentOpLock) {
1750 while (true) {
1751 op = mCurrentOperations.get(token);
1752 if (op == null) {
1753 // mysterious disappearance: treat as success with no callback
1754 break;
1755 } else {
1756 if (op.state == OP_PENDING) {
1757 try {
1758 mCurrentOpLock.wait();
1759 } catch (InterruptedException e) {}
1760 // When the wait is notified we loop around and recheck the current state
1761 } else {
1762 // No longer pending; we're done
1763 finalState = op.state;
1764 break;
1765 }
Christopher Tate44a27902010-01-27 17:15:49 -08001766 }
Christopher Tate44a27902010-01-27 17:15:49 -08001767 }
1768 }
Christopher Tate8e294d42011-08-31 20:37:12 -07001769
Christopher Tate44a27902010-01-27 17:15:49 -08001770 mBackupHandler.removeMessages(MSG_TIMEOUT);
Christopher Tatec58efa62011-08-01 19:20:14 -07001771 if (MORE_DEBUG) Slog.v(TAG, "operation " + Integer.toHexString(token)
Christopher Tate1bb69062010-02-19 17:02:12 -08001772 + " complete: finalState=" + finalState);
Christopher Tate44a27902010-01-27 17:15:49 -08001773 return finalState == OP_ACKNOWLEDGED;
1774 }
1775
Christopher Tate8e294d42011-08-31 20:37:12 -07001776 void handleTimeout(int token, Object obj) {
1777 // Notify any synchronous waiters
1778 Operation op = null;
Christopher Tate4a627c72011-04-01 14:43:32 -07001779 synchronized (mCurrentOpLock) {
Christopher Tate8e294d42011-08-31 20:37:12 -07001780 op = mCurrentOperations.get(token);
1781 if (MORE_DEBUG) {
1782 if (op == null) Slog.w(TAG, "Timeout of token " + Integer.toHexString(token)
1783 + " but no op found");
1784 }
1785 int state = (op != null) ? op.state : OP_TIMEOUT;
1786 if (state == OP_PENDING) {
1787 if (DEBUG) Slog.v(TAG, "TIMEOUT: token=" + Integer.toHexString(token));
1788 op.state = OP_TIMEOUT;
1789 mCurrentOperations.put(token, op);
1790 }
1791 mCurrentOpLock.notifyAll();
1792 }
1793
1794 // If there's a TimeoutHandler for this event, call it
1795 if (op != null && op.callback != null) {
1796 op.callback.handleTimeout();
Christopher Tate4a627c72011-04-01 14:43:32 -07001797 }
Christopher Tate44a27902010-01-27 17:15:49 -08001798 }
1799
Christopher Tate043dadc2009-06-02 16:11:00 -07001800 // ----- Back up a set of applications via a worker thread -----
1801
Christopher Tate8e294d42011-08-31 20:37:12 -07001802 enum BackupState {
1803 INITIAL,
1804 RUNNING_QUEUE,
1805 FINAL
1806 }
1807
1808 class PerformBackupTask implements BackupRestoreTask {
1809 private static final String TAG = "PerformBackupTask";
1810
Christopher Tateaa088442009-06-16 18:25:46 -07001811 IBackupTransport mTransport;
Christopher Tate043dadc2009-06-02 16:11:00 -07001812 ArrayList<BackupRequest> mQueue;
Christopher Tate8e294d42011-08-31 20:37:12 -07001813 ArrayList<BackupRequest> mOriginalQueue;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001814 File mStateDir;
Christopher Tatecde87f42009-06-12 12:55:53 -07001815 File mJournal;
Christopher Tate8e294d42011-08-31 20:37:12 -07001816 BackupState mCurrentState;
1817
1818 // carried information about the current in-flight operation
1819 PackageInfo mCurrentPackage;
1820 File mSavedStateName;
1821 File mBackupDataName;
1822 File mNewStateName;
1823 ParcelFileDescriptor mSavedState;
1824 ParcelFileDescriptor mBackupData;
1825 ParcelFileDescriptor mNewState;
1826 int mStatus;
1827 boolean mFinished;
Christopher Tate043dadc2009-06-02 16:11:00 -07001828
Christopher Tate44a27902010-01-27 17:15:49 -08001829 public PerformBackupTask(IBackupTransport transport, ArrayList<BackupRequest> queue,
Christopher Tatecde87f42009-06-12 12:55:53 -07001830 File journal) {
Christopher Tateaa088442009-06-16 18:25:46 -07001831 mTransport = transport;
Christopher Tate8e294d42011-08-31 20:37:12 -07001832 mOriginalQueue = queue;
Christopher Tatecde87f42009-06-12 12:55:53 -07001833 mJournal = journal;
Christopher Tate5cb400b2009-06-25 16:03:14 -07001834
1835 try {
1836 mStateDir = new File(mBaseStateDir, transport.transportDirName());
1837 } catch (RemoteException e) {
1838 // can't happen; the transport is local
1839 }
Christopher Tate8e294d42011-08-31 20:37:12 -07001840
1841 mCurrentState = BackupState.INITIAL;
1842 mFinished = false;
Christopher Tate6de74ff2012-01-17 15:20:32 -08001843
1844 addBackupTrace("STATE => INITIAL");
Christopher Tate043dadc2009-06-02 16:11:00 -07001845 }
1846
Christopher Tate8e294d42011-08-31 20:37:12 -07001847 // Main entry point: perform one chunk of work, updating the state as appropriate
1848 // and reposting the next chunk to the primary backup handler thread.
1849 @Override
1850 public void execute() {
1851 switch (mCurrentState) {
1852 case INITIAL:
1853 beginBackup();
1854 break;
1855
1856 case RUNNING_QUEUE:
1857 invokeNextAgent();
1858 break;
1859
1860 case FINAL:
1861 if (!mFinished) finalizeBackup();
1862 else {
1863 Slog.e(TAG, "Duplicate finish");
1864 }
Christopher Tate2982d062011-09-06 20:35:24 -07001865 mFinished = true;
Christopher Tate8e294d42011-08-31 20:37:12 -07001866 break;
1867 }
1868 }
1869
1870 // We're starting a backup pass. Initialize the transport and send
1871 // the PM metadata blob if we haven't already.
1872 void beginBackup() {
Christopher Tate6de74ff2012-01-17 15:20:32 -08001873 if (DEBUG_BACKUP_TRACE) {
1874 clearBackupTrace();
1875 StringBuilder b = new StringBuilder(256);
1876 b.append("beginBackup: [");
1877 for (BackupRequest req : mOriginalQueue) {
1878 b.append(' ');
1879 b.append(req.packageName);
1880 }
1881 b.append(" ]");
1882 addBackupTrace(b.toString());
1883 }
1884
Christopher Tate8e294d42011-08-31 20:37:12 -07001885 mStatus = BackupConstants.TRANSPORT_OK;
1886
1887 // Sanity check: if the queue is empty we have no work to do.
1888 if (mOriginalQueue.isEmpty()) {
1889 Slog.w(TAG, "Backup begun with an empty queue - nothing to do.");
Christopher Tate6de74ff2012-01-17 15:20:32 -08001890 addBackupTrace("queue empty at begin");
1891 executeNextState(BackupState.FINAL);
Christopher Tate8e294d42011-08-31 20:37:12 -07001892 return;
1893 }
1894
1895 // We need to retain the original queue contents in case of transport
1896 // failure, but we want a working copy that we can manipulate along
1897 // the way.
1898 mQueue = (ArrayList<BackupRequest>) mOriginalQueue.clone();
1899
Joe Onorato8a9b2202010-02-26 18:56:32 -08001900 if (DEBUG) Slog.v(TAG, "Beginning backup of " + mQueue.size() + " targets");
Christopher Tate043dadc2009-06-02 16:11:00 -07001901
Christopher Tate8e294d42011-08-31 20:37:12 -07001902 File pmState = new File(mStateDir, PACKAGE_MANAGER_SENTINEL);
Christopher Tate043dadc2009-06-02 16:11:00 -07001903 try {
Christopher Tate6de74ff2012-01-17 15:20:32 -08001904 final String transportName = mTransport.transportDirName();
1905 EventLog.writeEvent(EventLogTags.BACKUP_START, transportName);
Dan Egnor01445162009-09-21 17:04:05 -07001906
Dan Egnor852f8e42009-09-30 11:20:45 -07001907 // If we haven't stored package manager metadata yet, we must init the transport.
Christopher Tate8e294d42011-08-31 20:37:12 -07001908 if (mStatus == BackupConstants.TRANSPORT_OK && pmState.length() <= 0) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001909 Slog.i(TAG, "Initializing (wiping) backup state and transport storage");
Christopher Tate6de74ff2012-01-17 15:20:32 -08001910 addBackupTrace("initializing transport " + transportName);
Dan Egnor852f8e42009-09-30 11:20:45 -07001911 resetBackupState(mStateDir); // Just to make sure.
Christopher Tate8e294d42011-08-31 20:37:12 -07001912 mStatus = mTransport.initializeDevice();
Christopher Tate6de74ff2012-01-17 15:20:32 -08001913
1914 addBackupTrace("transport.initializeDevice() == " + mStatus);
Christopher Tate8e294d42011-08-31 20:37:12 -07001915 if (mStatus == BackupConstants.TRANSPORT_OK) {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001916 EventLog.writeEvent(EventLogTags.BACKUP_INITIALIZE);
Dan Egnor726247c2009-09-29 19:12:31 -07001917 } else {
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001918 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, "(initialize)");
Joe Onorato8a9b2202010-02-26 18:56:32 -08001919 Slog.e(TAG, "Transport error in initializeDevice()");
Dan Egnor726247c2009-09-29 19:12:31 -07001920 }
Dan Egnor01445162009-09-21 17:04:05 -07001921 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07001922
1923 // The package manager doesn't have a proper <application> etc, but since
1924 // it's running here in the system process we can just set up its agent
1925 // directly and use a synthetic BackupRequest. We always run this pass
1926 // because it's cheap and this way we guarantee that we don't get out of
1927 // step even if we're selecting among various transports at run time.
Christopher Tate8e294d42011-08-31 20:37:12 -07001928 if (mStatus == BackupConstants.TRANSPORT_OK) {
Dan Egnor01445162009-09-21 17:04:05 -07001929 PackageManagerBackupAgent pmAgent = new PackageManagerBackupAgent(
1930 mPackageManager, allAgentPackages());
Christopher Tate8e294d42011-08-31 20:37:12 -07001931 mStatus = invokeAgentForBackup(PACKAGE_MANAGER_SENTINEL,
Dan Egnor01445162009-09-21 17:04:05 -07001932 IBackupAgent.Stub.asInterface(pmAgent.onBind()), mTransport);
Christopher Tate6de74ff2012-01-17 15:20:32 -08001933 addBackupTrace("PMBA invoke: " + mStatus);
Dan Egnor01445162009-09-21 17:04:05 -07001934 }
Christopher Tate90967f42009-09-20 15:28:33 -07001935
Christopher Tate8e294d42011-08-31 20:37:12 -07001936 if (mStatus == BackupConstants.TRANSPORT_NOT_INITIALIZED) {
1937 // The backend reports that our dataset has been wiped. Note this in
1938 // the event log; the no-success code below will reset the backup
1939 // state as well.
Doug Zongkerab5c49c2009-12-04 10:31:43 -08001940 EventLog.writeEvent(EventLogTags.BACKUP_RESET, mTransport.transportDirName());
Dan Egnorbb9001c2009-07-27 12:20:13 -07001941 }
1942 } catch (Exception e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08001943 Slog.e(TAG, "Error in backup thread", e);
Christopher Tate6de74ff2012-01-17 15:20:32 -08001944 addBackupTrace("Exception in backup thread: " + e);
Christopher Tate8e294d42011-08-31 20:37:12 -07001945 mStatus = BackupConstants.TRANSPORT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07001946 } finally {
Christopher Tate8e294d42011-08-31 20:37:12 -07001947 // If we've succeeded so far, invokeAgentForBackup() will have run the PM
1948 // metadata and its completion/timeout callback will continue the state
1949 // machine chain. If it failed that won't happen; we handle that now.
Christopher Tate6de74ff2012-01-17 15:20:32 -08001950 addBackupTrace("exiting prelim: " + mStatus);
Christopher Tate8e294d42011-08-31 20:37:12 -07001951 if (mStatus != BackupConstants.TRANSPORT_OK) {
1952 // if things went wrong at this point, we need to
1953 // restage everything and try again later.
1954 resetBackupState(mStateDir); // Just to make sure.
1955 executeNextState(BackupState.FINAL);
Christopher Tate84725812010-02-04 15:52:40 -08001956 }
Christopher Tatecde87f42009-06-12 12:55:53 -07001957 }
Christopher Tate043dadc2009-06-02 16:11:00 -07001958 }
1959
Christopher Tate8e294d42011-08-31 20:37:12 -07001960 // Transport has been initialized and the PM metadata submitted successfully
1961 // if that was warranted. Now we process the single next thing in the queue.
1962 void invokeNextAgent() {
1963 mStatus = BackupConstants.TRANSPORT_OK;
Christopher Tate6de74ff2012-01-17 15:20:32 -08001964 addBackupTrace("invoke q=" + mQueue.size());
Christopher Tate043dadc2009-06-02 16:11:00 -07001965
Christopher Tate8e294d42011-08-31 20:37:12 -07001966 // Sanity check that we have work to do. If not, skip to the end where
1967 // we reestablish the wakelock invariants etc.
1968 if (mQueue.isEmpty()) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08001969 if (DEBUG) Slog.i(TAG, "queue now empty");
Christopher Tate8e294d42011-08-31 20:37:12 -07001970 executeNextState(BackupState.FINAL);
1971 return;
1972 }
1973
1974 // pop the entry we're going to process on this step
1975 BackupRequest request = mQueue.get(0);
1976 mQueue.remove(0);
1977
1978 Slog.d(TAG, "starting agent for backup of " + request);
Christopher Tate6de74ff2012-01-17 15:20:32 -08001979 addBackupTrace("launch agent for " + request.packageName);
Christopher Tate8e294d42011-08-31 20:37:12 -07001980
1981 // Verify that the requested app exists; it might be something that
1982 // requested a backup but was then uninstalled. The request was
1983 // journalled and rather than tamper with the journal it's safer
1984 // to sanity-check here. This also gives us the classname of the
1985 // package's backup agent.
1986 try {
1987 mCurrentPackage = mPackageManager.getPackageInfo(request.packageName,
1988 PackageManager.GET_SIGNATURES);
Christopher Tatec28083a2010-12-14 16:16:44 -08001989
Christopher Tate043dadc2009-06-02 16:11:00 -07001990 IBackupAgent agent = null;
Christopher Tate043dadc2009-06-02 16:11:00 -07001991 try {
Christopher Tate8e294d42011-08-31 20:37:12 -07001992 mWakelock.setWorkSource(new WorkSource(mCurrentPackage.applicationInfo.uid));
1993 agent = bindToAgentSynchronous(mCurrentPackage.applicationInfo,
Christopher Tate4a627c72011-04-01 14:43:32 -07001994 IApplicationThread.BACKUP_MODE_INCREMENTAL);
Christopher Tate6de74ff2012-01-17 15:20:32 -08001995 addBackupTrace("agent bound; a? = " + (agent != null));
Christopher Tatedf01dea2009-06-09 20:45:02 -07001996 if (agent != null) {
Christopher Tate8e294d42011-08-31 20:37:12 -07001997 mStatus = invokeAgentForBackup(request.packageName, agent, mTransport);
1998 // at this point we'll either get a completion callback from the
1999 // agent, or a timeout message on the main handler. either way, we're
2000 // done here as long as we're successful so far.
2001 } else {
2002 // Timeout waiting for the agent
2003 mStatus = BackupConstants.AGENT_ERROR;
Christopher Tate043dadc2009-06-02 16:11:00 -07002004 }
Christopher Tate043dadc2009-06-02 16:11:00 -07002005 } catch (SecurityException ex) {
2006 // Try for the next one.
Joe Onorato8a9b2202010-02-26 18:56:32 -08002007 Slog.d(TAG, "error in bind/backup", ex);
Christopher Tate8e294d42011-08-31 20:37:12 -07002008 mStatus = BackupConstants.AGENT_ERROR;
Christopher Tate6de74ff2012-01-17 15:20:32 -08002009 addBackupTrace("agent SE");
Christopher Tate8e294d42011-08-31 20:37:12 -07002010 }
2011 } catch (NameNotFoundException e) {
2012 Slog.d(TAG, "Package does not exist; skipping");
Christopher Tate6de74ff2012-01-17 15:20:32 -08002013 addBackupTrace("no such package");
2014 mStatus = BackupConstants.AGENT_UNKNOWN;
Christopher Tate8e294d42011-08-31 20:37:12 -07002015 } finally {
2016 mWakelock.setWorkSource(null);
2017
2018 // If there was an agent error, no timeout/completion handling will occur.
Christopher Tate6de74ff2012-01-17 15:20:32 -08002019 // That means we need to direct to the next state ourselves.
Christopher Tate8e294d42011-08-31 20:37:12 -07002020 if (mStatus != BackupConstants.TRANSPORT_OK) {
2021 BackupState nextState = BackupState.RUNNING_QUEUE;
2022
2023 // An agent-level failure means we reenqueue this one agent for
2024 // a later retry, but otherwise proceed normally.
2025 if (mStatus == BackupConstants.AGENT_ERROR) {
2026 if (MORE_DEBUG) Slog.i(TAG, "Agent failure for " + request.packageName
2027 + " - restaging");
2028 dataChangedImpl(request.packageName);
2029 mStatus = BackupConstants.TRANSPORT_OK;
2030 if (mQueue.isEmpty()) nextState = BackupState.FINAL;
Christopher Tate6de74ff2012-01-17 15:20:32 -08002031 } else if (mStatus == BackupConstants.AGENT_UNKNOWN) {
2032 // Failed lookup of the app, so we couldn't bring up an agent, but
2033 // we're otherwise fine. Just drop it and go on to the next as usual.
2034 mStatus = BackupConstants.TRANSPORT_OK;
2035 } else {
Christopher Tate8e294d42011-08-31 20:37:12 -07002036 // Transport-level failure means we reenqueue everything
2037 revertAndEndBackup();
2038 nextState = BackupState.FINAL;
2039 }
2040
2041 executeNextState(nextState);
Christopher Tate6de74ff2012-01-17 15:20:32 -08002042 } else {
2043 addBackupTrace("expecting completion/timeout callback");
Christopher Tate043dadc2009-06-02 16:11:00 -07002044 }
2045 }
2046 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07002047
Christopher Tate8e294d42011-08-31 20:37:12 -07002048 void finalizeBackup() {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002049 addBackupTrace("finishing");
2050
Christopher Tate8e294d42011-08-31 20:37:12 -07002051 // Either backup was successful, in which case we of course do not need
2052 // this pass's journal any more; or it failed, in which case we just
2053 // re-enqueued all of these packages in the current active journal.
2054 // Either way, we no longer need this pass's journal.
2055 if (mJournal != null && !mJournal.delete()) {
2056 Slog.e(TAG, "Unable to remove backup journal file " + mJournal);
2057 }
2058
2059 // If everything actually went through and this is the first time we've
2060 // done a backup, we can now record what the current backup dataset token
2061 // is.
2062 if ((mCurrentToken == 0) && (mStatus == BackupConstants.TRANSPORT_OK)) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002063 addBackupTrace("success; recording token");
Christopher Tate8e294d42011-08-31 20:37:12 -07002064 try {
2065 mCurrentToken = mTransport.getCurrentRestoreSet();
2066 } catch (RemoteException e) {} // can't happen
2067 writeRestoreTokens();
2068 }
2069
Christopher Tate336a6492011-10-05 16:05:43 -07002070 // Set up the next backup pass - at this point we can set mBackupRunning
2071 // to false to allow another pass to fire, because we're done with the
2072 // state machine sequence and the wakelock is refcounted.
2073 synchronized (mQueueLock) {
2074 mBackupRunning = false;
2075 if (mStatus == BackupConstants.TRANSPORT_NOT_INITIALIZED) {
Christopher Tatee659fb92011-10-10 16:34:50 -07002076 // Make sure we back up everything and perform the one-time init
2077 clearMetadata();
2078 if (DEBUG) Slog.d(TAG, "Server requires init; rerunning");
Christopher Tate6de74ff2012-01-17 15:20:32 -08002079 addBackupTrace("init required; rerunning");
Christopher Tate336a6492011-10-05 16:05:43 -07002080 backupNow();
2081 }
Christopher Tate8e294d42011-08-31 20:37:12 -07002082 }
2083
2084 // Only once we're entirely finished do we release the wakelock
Christopher Tate6de74ff2012-01-17 15:20:32 -08002085 clearBackupTrace();
Christopher Tate8e294d42011-08-31 20:37:12 -07002086 Slog.i(TAG, "Backup pass finished.");
2087 mWakelock.release();
2088 }
2089
Christopher Tatee659fb92011-10-10 16:34:50 -07002090 // Remove the PM metadata state. This will generate an init on the next pass.
2091 void clearMetadata() {
2092 final File pmState = new File(mStateDir, PACKAGE_MANAGER_SENTINEL);
2093 if (pmState.exists()) pmState.delete();
2094 }
2095
Christopher Tate8e294d42011-08-31 20:37:12 -07002096 // Invoke an agent's doBackup() and start a timeout message spinning on the main
2097 // handler in case it doesn't get back to us.
2098 int invokeAgentForBackup(String packageName, IBackupAgent agent,
Dan Egnor01445162009-09-21 17:04:05 -07002099 IBackupTransport transport) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002100 if (DEBUG) Slog.d(TAG, "invokeAgentForBackup on " + packageName);
2101 addBackupTrace("invoking " + packageName);
Christopher Tatec7b31e32009-06-10 15:49:30 -07002102
Christopher Tate8e294d42011-08-31 20:37:12 -07002103 mSavedStateName = new File(mStateDir, packageName);
2104 mBackupDataName = new File(mDataDir, packageName + ".data");
2105 mNewStateName = new File(mStateDir, packageName + ".new");
Dan Egnorbb9001c2009-07-27 12:20:13 -07002106
Christopher Tate8e294d42011-08-31 20:37:12 -07002107 mSavedState = null;
2108 mBackupData = null;
2109 mNewState = null;
Dan Egnorbb9001c2009-07-27 12:20:13 -07002110
Christopher Tate4a627c72011-04-01 14:43:32 -07002111 final int token = generateToken();
Christopher Tatec7b31e32009-06-10 15:49:30 -07002112 try {
2113 // Look up the package info & signatures. This is first so that if it
2114 // throws an exception, there's no file setup yet that would need to
2115 // be unraveled.
Christopher Tateabce4e82009-06-18 18:35:32 -07002116 if (packageName.equals(PACKAGE_MANAGER_SENTINEL)) {
Christopher Tate8e294d42011-08-31 20:37:12 -07002117 // The metadata 'package' is synthetic; construct one and make
2118 // sure our global state is pointed at it
2119 mCurrentPackage = new PackageInfo();
2120 mCurrentPackage.packageName = packageName;
Christopher Tateabce4e82009-06-18 18:35:32 -07002121 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07002122
Christopher Tatec7b31e32009-06-10 15:49:30 -07002123 // In a full backup, we pass a null ParcelFileDescriptor as
Christopher Tate4a627c72011-04-01 14:43:32 -07002124 // the saved-state "file". This is by definition an incremental,
2125 // so we build a saved state file to pass.
Christopher Tate8e294d42011-08-31 20:37:12 -07002126 mSavedState = ParcelFileDescriptor.open(mSavedStateName,
Christopher Tate4a627c72011-04-01 14:43:32 -07002127 ParcelFileDescriptor.MODE_READ_ONLY |
2128 ParcelFileDescriptor.MODE_CREATE); // Make an empty file if necessary
Christopher Tatec7b31e32009-06-10 15:49:30 -07002129
Christopher Tate8e294d42011-08-31 20:37:12 -07002130 mBackupData = ParcelFileDescriptor.open(mBackupDataName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07002131 ParcelFileDescriptor.MODE_READ_WRITE |
2132 ParcelFileDescriptor.MODE_CREATE |
2133 ParcelFileDescriptor.MODE_TRUNCATE);
Christopher Tatec7b31e32009-06-10 15:49:30 -07002134
Christopher Tate8e294d42011-08-31 20:37:12 -07002135 mNewState = ParcelFileDescriptor.open(mNewStateName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07002136 ParcelFileDescriptor.MODE_READ_WRITE |
2137 ParcelFileDescriptor.MODE_CREATE |
2138 ParcelFileDescriptor.MODE_TRUNCATE);
Christopher Tatec7b31e32009-06-10 15:49:30 -07002139
Christopher Tate44a27902010-01-27 17:15:49 -08002140 // Initiate the target's backup pass
Christopher Tate6de74ff2012-01-17 15:20:32 -08002141 addBackupTrace("setting timeout");
Christopher Tate8e294d42011-08-31 20:37:12 -07002142 prepareOperationTimeout(token, TIMEOUT_BACKUP_INTERVAL, this);
Christopher Tate6de74ff2012-01-17 15:20:32 -08002143 addBackupTrace("calling agent doBackup()");
Christopher Tate8e294d42011-08-31 20:37:12 -07002144 agent.doBackup(mSavedState, mBackupData, mNewState, token, mBackupManagerBinder);
Christopher Tatec7b31e32009-06-10 15:49:30 -07002145 } catch (Exception e) {
Christopher Tate8e294d42011-08-31 20:37:12 -07002146 Slog.e(TAG, "Error invoking for backup on " + packageName);
Christopher Tate6de74ff2012-01-17 15:20:32 -08002147 addBackupTrace("exception: " + e);
Christopher Tate8e294d42011-08-31 20:37:12 -07002148 EventLog.writeEvent(EventLogTags.BACKUP_AGENT_FAILURE, packageName,
2149 e.toString());
2150 agentErrorCleanup();
2151 return BackupConstants.AGENT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07002152 }
2153
Christopher Tate8e294d42011-08-31 20:37:12 -07002154 // At this point the agent is off and running. The next thing to happen will
2155 // either be a callback from the agent, at which point we'll process its data
2156 // for transport, or a timeout. Either way the next phase will happen in
2157 // response to the TimeoutHandler interface callbacks.
Christopher Tate6de74ff2012-01-17 15:20:32 -08002158 addBackupTrace("invoke success");
Christopher Tate8e294d42011-08-31 20:37:12 -07002159 return BackupConstants.TRANSPORT_OK;
2160 }
2161
2162 @Override
2163 public void operationComplete() {
2164 // Okay, the agent successfully reported back to us. Spin the data off to the
2165 // transport and proceed with the next stage.
2166 if (MORE_DEBUG) Slog.v(TAG, "operationComplete(): sending data to transport for "
2167 + mCurrentPackage.packageName);
2168 mBackupHandler.removeMessages(MSG_TIMEOUT);
2169 clearAgentState();
Christopher Tate6de74ff2012-01-17 15:20:32 -08002170 addBackupTrace("operation complete");
Christopher Tate8e294d42011-08-31 20:37:12 -07002171
2172 ParcelFileDescriptor backupData = null;
2173 mStatus = BackupConstants.TRANSPORT_OK;
Dan Egnorbb9001c2009-07-27 12:20:13 -07002174 try {
Christopher Tate8e294d42011-08-31 20:37:12 -07002175 int size = (int) mBackupDataName.length();
Dan Egnorbb9001c2009-07-27 12:20:13 -07002176 if (size > 0) {
Christopher Tate8e294d42011-08-31 20:37:12 -07002177 if (mStatus == BackupConstants.TRANSPORT_OK) {
2178 backupData = ParcelFileDescriptor.open(mBackupDataName,
Dan Egnor01445162009-09-21 17:04:05 -07002179 ParcelFileDescriptor.MODE_READ_ONLY);
Christopher Tate6de74ff2012-01-17 15:20:32 -08002180 addBackupTrace("sending data to transport");
Christopher Tate8e294d42011-08-31 20:37:12 -07002181 mStatus = mTransport.performBackup(mCurrentPackage, backupData);
Dan Egnor01445162009-09-21 17:04:05 -07002182 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07002183
Dan Egnor83861e72009-09-17 16:17:55 -07002184 // TODO - We call finishBackup() for each application backed up, because
2185 // we need to know now whether it succeeded or failed. Instead, we should
2186 // hold off on finishBackup() until the end, which implies holding off on
2187 // renaming *all* the output state files (see below) until that happens.
2188
Christopher Tate6de74ff2012-01-17 15:20:32 -08002189 addBackupTrace("data delivered: " + mStatus);
Christopher Tate8e294d42011-08-31 20:37:12 -07002190 if (mStatus == BackupConstants.TRANSPORT_OK) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002191 addBackupTrace("finishing op on transport");
Christopher Tate8e294d42011-08-31 20:37:12 -07002192 mStatus = mTransport.finishBackup();
Christopher Tate6de74ff2012-01-17 15:20:32 -08002193 addBackupTrace("finished: " + mStatus);
Dan Egnor83861e72009-09-17 16:17:55 -07002194 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07002195 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -08002196 if (DEBUG) Slog.i(TAG, "no backup data written; not calling transport");
Christopher Tate6de74ff2012-01-17 15:20:32 -08002197 addBackupTrace("no data to send");
Dan Egnorbb9001c2009-07-27 12:20:13 -07002198 }
2199
2200 // After successful transport, delete the now-stale data
2201 // and juggle the files so that next time we supply the agent
2202 // with the new state file it just created.
Christopher Tate8e294d42011-08-31 20:37:12 -07002203 if (mStatus == BackupConstants.TRANSPORT_OK) {
2204 mBackupDataName.delete();
2205 mNewStateName.renameTo(mSavedStateName);
2206 EventLog.writeEvent(EventLogTags.BACKUP_PACKAGE,
2207 mCurrentPackage.packageName, size);
2208 logBackupComplete(mCurrentPackage.packageName);
Dan Egnor01445162009-09-21 17:04:05 -07002209 } else {
Christopher Tate8e294d42011-08-31 20:37:12 -07002210 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE,
2211 mCurrentPackage.packageName);
Dan Egnor01445162009-09-21 17:04:05 -07002212 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07002213 } catch (Exception e) {
Christopher Tate8e294d42011-08-31 20:37:12 -07002214 Slog.e(TAG, "Transport error backing up " + mCurrentPackage.packageName, e);
2215 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE,
2216 mCurrentPackage.packageName);
2217 mStatus = BackupConstants.TRANSPORT_ERROR;
Dan Egnorbb9001c2009-07-27 12:20:13 -07002218 } finally {
2219 try { if (backupData != null) backupData.close(); } catch (IOException e) {}
Christopher Tatec7b31e32009-06-10 15:49:30 -07002220 }
Christopher Tated55e18a2009-09-21 10:12:59 -07002221
Christopher Tate8e294d42011-08-31 20:37:12 -07002222 // If we encountered an error here it's a transport-level failure. That
2223 // means we need to halt everything and reschedule everything for next time.
2224 final BackupState nextState;
2225 if (mStatus != BackupConstants.TRANSPORT_OK) {
2226 revertAndEndBackup();
2227 nextState = BackupState.FINAL;
2228 } else {
2229 // Success! Proceed with the next app if any, otherwise we're done.
2230 nextState = (mQueue.isEmpty()) ? BackupState.FINAL : BackupState.RUNNING_QUEUE;
2231 }
2232
2233 executeNextState(nextState);
2234 }
2235
2236 @Override
2237 public void handleTimeout() {
2238 // Whoops, the current agent timed out running doBackup(). Tidy up and restage
2239 // it for the next time we run a backup pass.
2240 // !!! TODO: keep track of failure counts per agent, and blacklist those which
2241 // fail repeatedly (i.e. have proved themselves to be buggy).
2242 Slog.e(TAG, "Timeout backing up " + mCurrentPackage.packageName);
2243 EventLog.writeEvent(EventLogTags.BACKUP_AGENT_FAILURE, mCurrentPackage.packageName,
2244 "timeout");
Christopher Tate6de74ff2012-01-17 15:20:32 -08002245 addBackupTrace("timeout of " + mCurrentPackage.packageName);
Christopher Tate8e294d42011-08-31 20:37:12 -07002246 agentErrorCleanup();
2247 dataChangedImpl(mCurrentPackage.packageName);
2248 }
2249
2250 void revertAndEndBackup() {
2251 if (MORE_DEBUG) Slog.i(TAG, "Reverting backup queue - restaging everything");
Christopher Tate6de74ff2012-01-17 15:20:32 -08002252 addBackupTrace("transport error; reverting");
Christopher Tate8e294d42011-08-31 20:37:12 -07002253 for (BackupRequest request : mOriginalQueue) {
2254 dataChangedImpl(request.packageName);
2255 }
2256 // We also want to reset the backup schedule based on whatever
2257 // the transport suggests by way of retry/backoff time.
2258 restartBackupAlarm();
2259 }
2260
2261 void agentErrorCleanup() {
2262 mBackupDataName.delete();
2263 mNewStateName.delete();
2264 clearAgentState();
2265
2266 executeNextState(mQueue.isEmpty() ? BackupState.FINAL : BackupState.RUNNING_QUEUE);
2267 }
2268
2269 // Cleanup common to both success and failure cases
2270 void clearAgentState() {
2271 try { if (mSavedState != null) mSavedState.close(); } catch (IOException e) {}
2272 try { if (mBackupData != null) mBackupData.close(); } catch (IOException e) {}
2273 try { if (mNewState != null) mNewState.close(); } catch (IOException e) {}
2274 mSavedState = mBackupData = mNewState = null;
2275 synchronized (mCurrentOpLock) {
2276 mCurrentOperations.clear();
2277 }
2278
2279 // If this was a pseudopackage there's no associated Activity Manager state
2280 if (mCurrentPackage.applicationInfo != null) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002281 addBackupTrace("unbinding " + mCurrentPackage.packageName);
Christopher Tate8e294d42011-08-31 20:37:12 -07002282 try { // unbind even on timeout, just in case
2283 mActivityManager.unbindBackupAgent(mCurrentPackage.applicationInfo);
2284 } catch (RemoteException e) {}
2285 }
2286 }
2287
2288 void restartBackupAlarm() {
Christopher Tate6de74ff2012-01-17 15:20:32 -08002289 addBackupTrace("setting backup trigger");
Christopher Tate8e294d42011-08-31 20:37:12 -07002290 synchronized (mQueueLock) {
2291 try {
2292 startBackupAlarmsLocked(mTransport.requestBackupTime());
2293 } catch (RemoteException e) { /* cannot happen */ }
2294 }
2295 }
2296
2297 void executeNextState(BackupState nextState) {
2298 if (MORE_DEBUG) Slog.i(TAG, " => executing next step on "
2299 + this + " nextState=" + nextState);
Christopher Tate6de74ff2012-01-17 15:20:32 -08002300 addBackupTrace("executeNextState => " + nextState);
Christopher Tate8e294d42011-08-31 20:37:12 -07002301 mCurrentState = nextState;
2302 Message msg = mBackupHandler.obtainMessage(MSG_BACKUP_RESTORE_STEP, this);
2303 mBackupHandler.sendMessage(msg);
Christopher Tatec7b31e32009-06-10 15:49:30 -07002304 }
Christopher Tate043dadc2009-06-02 16:11:00 -07002305 }
2306
Christopher Tatedf01dea2009-06-09 20:45:02 -07002307
Christopher Tate4a627c72011-04-01 14:43:32 -07002308 // ----- Full backup to a file/socket -----
2309
2310 class PerformFullBackupTask implements Runnable {
2311 ParcelFileDescriptor mOutputFile;
Christopher Tate7926a692011-07-11 11:31:57 -07002312 DeflaterOutputStream mDeflater;
Christopher Tate4a627c72011-04-01 14:43:32 -07002313 IFullBackupRestoreObserver mObserver;
2314 boolean mIncludeApks;
2315 boolean mIncludeShared;
2316 boolean mAllApps;
Christopher Tate240c7d22011-10-03 18:13:44 -07002317 final boolean mIncludeSystem;
Christopher Tate4a627c72011-04-01 14:43:32 -07002318 String[] mPackages;
Christopher Tate728a1c42011-07-28 18:03:03 -07002319 String mCurrentPassword;
2320 String mEncryptPassword;
Christopher Tate4a627c72011-04-01 14:43:32 -07002321 AtomicBoolean mLatchObject;
2322 File mFilesDir;
2323 File mManifestFile;
2324
Christopher Tate7926a692011-07-11 11:31:57 -07002325 class FullBackupRunner implements Runnable {
2326 PackageInfo mPackage;
2327 IBackupAgent mAgent;
2328 ParcelFileDescriptor mPipe;
2329 int mToken;
2330 boolean mSendApk;
Christopher Tate73d73692012-01-20 17:11:31 -08002331 boolean mWriteManifest;
Christopher Tate7926a692011-07-11 11:31:57 -07002332
2333 FullBackupRunner(PackageInfo pack, IBackupAgent agent, ParcelFileDescriptor pipe,
Christopher Tate73d73692012-01-20 17:11:31 -08002334 int token, boolean sendApk, boolean writeManifest) throws IOException {
Christopher Tate7926a692011-07-11 11:31:57 -07002335 mPackage = pack;
2336 mAgent = agent;
2337 mPipe = ParcelFileDescriptor.dup(pipe.getFileDescriptor());
2338 mToken = token;
2339 mSendApk = sendApk;
Christopher Tate73d73692012-01-20 17:11:31 -08002340 mWriteManifest = writeManifest;
Christopher Tate7926a692011-07-11 11:31:57 -07002341 }
2342
2343 @Override
2344 public void run() {
2345 try {
2346 BackupDataOutput output = new BackupDataOutput(
2347 mPipe.getFileDescriptor());
2348
Christopher Tate73d73692012-01-20 17:11:31 -08002349 if (mWriteManifest) {
2350 if (MORE_DEBUG) Slog.d(TAG, "Writing manifest for " + mPackage.packageName);
2351 writeAppManifest(mPackage, mManifestFile, mSendApk);
2352 FullBackup.backupToTar(mPackage.packageName, null, null,
2353 mFilesDir.getAbsolutePath(),
2354 mManifestFile.getAbsolutePath(),
2355 output);
2356 }
Christopher Tate7926a692011-07-11 11:31:57 -07002357
2358 if (mSendApk) {
2359 writeApkToBackup(mPackage, output);
2360 }
2361
Christopher Tatec58efa62011-08-01 19:20:14 -07002362 if (DEBUG) Slog.d(TAG, "Calling doFullBackup() on " + mPackage.packageName);
Christopher Tate8e294d42011-08-31 20:37:12 -07002363 prepareOperationTimeout(mToken, TIMEOUT_FULL_BACKUP_INTERVAL, null);
Christopher Tate7926a692011-07-11 11:31:57 -07002364 mAgent.doFullBackup(mPipe, mToken, mBackupManagerBinder);
2365 } catch (IOException e) {
2366 Slog.e(TAG, "Error running full backup for " + mPackage.packageName);
2367 } catch (RemoteException e) {
2368 Slog.e(TAG, "Remote agent vanished during full backup of "
2369 + mPackage.packageName);
2370 } finally {
2371 try {
2372 mPipe.close();
2373 } catch (IOException e) {}
2374 }
2375 }
2376 }
2377
Christopher Tate4a627c72011-04-01 14:43:32 -07002378 PerformFullBackupTask(ParcelFileDescriptor fd, IFullBackupRestoreObserver observer,
Christopher Tate728a1c42011-07-28 18:03:03 -07002379 boolean includeApks, boolean includeShared, String curPassword,
Christopher Tate240c7d22011-10-03 18:13:44 -07002380 String encryptPassword, boolean doAllApps, boolean doSystem, String[] packages,
Christopher Tate728a1c42011-07-28 18:03:03 -07002381 AtomicBoolean latch) {
Christopher Tate4a627c72011-04-01 14:43:32 -07002382 mOutputFile = fd;
2383 mObserver = observer;
2384 mIncludeApks = includeApks;
2385 mIncludeShared = includeShared;
2386 mAllApps = doAllApps;
Christopher Tate240c7d22011-10-03 18:13:44 -07002387 mIncludeSystem = doSystem;
Christopher Tate4a627c72011-04-01 14:43:32 -07002388 mPackages = packages;
Christopher Tate728a1c42011-07-28 18:03:03 -07002389 mCurrentPassword = curPassword;
2390 // when backing up, if there is a current backup password, we require that
2391 // the user use a nonempty encryption password as well. if one is supplied
2392 // in the UI we use that, but if the UI was left empty we fall back to the
2393 // current backup password (which was supplied by the user as well).
2394 if (encryptPassword == null || "".equals(encryptPassword)) {
2395 mEncryptPassword = curPassword;
2396 } else {
2397 mEncryptPassword = encryptPassword;
2398 }
Christopher Tate4a627c72011-04-01 14:43:32 -07002399 mLatchObject = latch;
2400
2401 mFilesDir = new File("/data/system");
2402 mManifestFile = new File(mFilesDir, BACKUP_MANIFEST_FILENAME);
2403 }
2404
2405 @Override
2406 public void run() {
Christopher Tate240c7d22011-10-03 18:13:44 -07002407 List<PackageInfo> packagesToBackup = new ArrayList<PackageInfo>();
Christopher Tate4a627c72011-04-01 14:43:32 -07002408
Christopher Tateb0628bf2011-06-02 15:08:13 -07002409 Slog.i(TAG, "--- Performing full-dataset backup ---");
Christopher Tate4a627c72011-04-01 14:43:32 -07002410 sendStartBackup();
2411
2412 // doAllApps supersedes the package set if any
2413 if (mAllApps) {
2414 packagesToBackup = mPackageManager.getInstalledPackages(
2415 PackageManager.GET_SIGNATURES);
Christopher Tate240c7d22011-10-03 18:13:44 -07002416 // Exclude system apps if we've been asked to do so
2417 if (mIncludeSystem == false) {
2418 for (int i = 0; i < packagesToBackup.size(); ) {
2419 PackageInfo pkg = packagesToBackup.get(i);
2420 if ((pkg.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
2421 packagesToBackup.remove(i);
2422 } else {
2423 i++;
2424 }
2425 }
2426 }
2427 }
2428
2429 // Now process the command line argument packages, if any. Note that explicitly-
2430 // named system-partition packages will be included even if includeSystem was
2431 // set to false.
2432 if (mPackages != null) {
Christopher Tate4a627c72011-04-01 14:43:32 -07002433 for (String pkgName : mPackages) {
2434 try {
2435 packagesToBackup.add(mPackageManager.getPackageInfo(pkgName,
2436 PackageManager.GET_SIGNATURES));
2437 } catch (NameNotFoundException e) {
2438 Slog.w(TAG, "Unknown package " + pkgName + ", skipping");
2439 }
2440 }
2441 }
2442
Christopher Tate73d73692012-01-20 17:11:31 -08002443 // Cull any packages that have indicated that backups are not permitted, as well
2444 // as any explicit mention of the 'special' shared-storage agent package (we
2445 // handle that one at the end).
Christopher Tatea858cb02011-06-03 12:27:51 -07002446 for (int i = 0; i < packagesToBackup.size(); ) {
Christopher Tate240c7d22011-10-03 18:13:44 -07002447 PackageInfo pkg = packagesToBackup.get(i);
Christopher Tate73d73692012-01-20 17:11:31 -08002448 if ((pkg.applicationInfo.flags & ApplicationInfo.FLAG_ALLOW_BACKUP) == 0
2449 || pkg.packageName.equals(SHARED_BACKUP_AGENT_PACKAGE)) {
Christopher Tatea858cb02011-06-03 12:27:51 -07002450 packagesToBackup.remove(i);
2451 } else {
2452 i++;
2453 }
2454 }
2455
Christopher Tate7926a692011-07-11 11:31:57 -07002456 FileOutputStream ofstream = new FileOutputStream(mOutputFile.getFileDescriptor());
Christopher Tate2efd2db2011-07-19 16:32:49 -07002457 OutputStream out = null;
Christopher Tate7926a692011-07-11 11:31:57 -07002458
Christopher Tate4a627c72011-04-01 14:43:32 -07002459 PackageInfo pkg = null;
2460 try {
Christopher Tate728a1c42011-07-28 18:03:03 -07002461 boolean encrypting = (mEncryptPassword != null && mEncryptPassword.length() > 0);
Christopher Tate2efd2db2011-07-19 16:32:49 -07002462 boolean compressing = COMPRESS_FULL_BACKUPS;
2463 OutputStream finalOutput = ofstream;
Christopher Tate7bdb0962011-07-13 19:30:21 -07002464
Christopher Tateeef4ae42011-08-05 13:15:53 -07002465 // Verify that the given password matches the currently-active
2466 // backup password, if any
2467 if (hasBackupPassword()) {
2468 if (!passwordMatchesSaved(mCurrentPassword, PBKDF2_HASH_ROUNDS)) {
2469 if (DEBUG) Slog.w(TAG, "Backup password mismatch; aborting");
2470 return;
2471 }
2472 }
2473
Christopher Tate7bdb0962011-07-13 19:30:21 -07002474 // Write the global file header. All strings are UTF-8 encoded; lines end
2475 // with a '\n' byte. Actual backup data begins immediately following the
2476 // final '\n'.
2477 //
2478 // line 1: "ANDROID BACKUP"
2479 // line 2: backup file format version, currently "1"
2480 // line 3: compressed? "0" if not compressed, "1" if compressed.
Christopher Tate2efd2db2011-07-19 16:32:49 -07002481 // line 4: name of encryption algorithm [currently only "none" or "AES-256"]
2482 //
2483 // When line 4 is not "none", then additional header data follows:
2484 //
2485 // line 5: user password salt [hex]
2486 // line 6: master key checksum salt [hex]
2487 // line 7: number of PBKDF2 rounds to use (same for user & master) [decimal]
2488 // line 8: IV of the user key [hex]
2489 // line 9: master key blob [hex]
2490 // IV of the master key, master key itself, master key checksum hash
2491 //
2492 // The master key checksum is the master key plus its checksum salt, run through
2493 // 10k rounds of PBKDF2. This is used to verify that the user has supplied the
2494 // correct password for decrypting the archive: the master key decrypted from
2495 // the archive using the user-supplied password is also run through PBKDF2 in
2496 // this way, and if the result does not match the checksum as stored in the
2497 // archive, then we know that the user-supplied password does not match the
2498 // archive's.
2499 StringBuilder headerbuf = new StringBuilder(1024);
2500
Christopher Tate7bdb0962011-07-13 19:30:21 -07002501 headerbuf.append(BACKUP_FILE_HEADER_MAGIC);
Christopher Tate2efd2db2011-07-19 16:32:49 -07002502 headerbuf.append(BACKUP_FILE_VERSION); // integer, no trailing \n
2503 headerbuf.append(compressing ? "\n1\n" : "\n0\n");
Christopher Tate7bdb0962011-07-13 19:30:21 -07002504
2505 try {
Christopher Tate2efd2db2011-07-19 16:32:49 -07002506 // Set up the encryption stage if appropriate, and emit the correct header
2507 if (encrypting) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07002508 finalOutput = emitAesBackupHeader(headerbuf, finalOutput);
2509 } else {
2510 headerbuf.append("none\n");
2511 }
2512
Christopher Tate7bdb0962011-07-13 19:30:21 -07002513 byte[] header = headerbuf.toString().getBytes("UTF-8");
2514 ofstream.write(header);
Christopher Tate2efd2db2011-07-19 16:32:49 -07002515
2516 // Set up the compression stage feeding into the encryption stage (if any)
2517 if (compressing) {
2518 Deflater deflater = new Deflater(Deflater.BEST_COMPRESSION);
2519 finalOutput = new DeflaterOutputStream(finalOutput, deflater, true);
2520 }
2521
2522 out = finalOutput;
Christopher Tate7bdb0962011-07-13 19:30:21 -07002523 } catch (Exception e) {
2524 // Should never happen!
2525 Slog.e(TAG, "Unable to emit archive header", e);
2526 return;
2527 }
2528
Christopher Tate73d73692012-01-20 17:11:31 -08002529 // Shared storage if requested
2530 if (mIncludeShared) {
2531 try {
2532 pkg = mPackageManager.getPackageInfo(SHARED_BACKUP_AGENT_PACKAGE, 0);
2533 packagesToBackup.add(pkg);
2534 } catch (NameNotFoundException e) {
2535 Slog.e(TAG, "Unable to find shared-storage backup handler");
2536 }
2537 }
2538
Christopher Tateb0628bf2011-06-02 15:08:13 -07002539 // Now back up the app data via the agent mechanism
Christopher Tate4a627c72011-04-01 14:43:32 -07002540 int N = packagesToBackup.size();
2541 for (int i = 0; i < N; i++) {
2542 pkg = packagesToBackup.get(i);
Christopher Tate7926a692011-07-11 11:31:57 -07002543 backupOnePackage(pkg, out);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002544 }
Christopher Tate4a627c72011-04-01 14:43:32 -07002545
Christopher Tate6853fcf2011-08-10 17:52:21 -07002546 // Done!
2547 finalizeBackup(out);
Christopher Tate4a627c72011-04-01 14:43:32 -07002548 } catch (RemoteException e) {
2549 Slog.e(TAG, "App died during full backup");
2550 } finally {
Christopher Tateb0628bf2011-06-02 15:08:13 -07002551 tearDown(pkg);
Christopher Tate4a627c72011-04-01 14:43:32 -07002552 try {
Christopher Tate2efd2db2011-07-19 16:32:49 -07002553 if (out != null) out.close();
Christopher Tate4a627c72011-04-01 14:43:32 -07002554 mOutputFile.close();
2555 } catch (IOException e) {
2556 /* nothing we can do about this */
2557 }
2558 synchronized (mCurrentOpLock) {
2559 mCurrentOperations.clear();
2560 }
2561 synchronized (mLatchObject) {
2562 mLatchObject.set(true);
2563 mLatchObject.notifyAll();
2564 }
2565 sendEndBackup();
Christopher Tate4a627c72011-04-01 14:43:32 -07002566 if (DEBUG) Slog.d(TAG, "Full backup pass complete.");
Christopher Tate336a6492011-10-05 16:05:43 -07002567 mWakelock.release();
Christopher Tate4a627c72011-04-01 14:43:32 -07002568 }
2569 }
2570
Christopher Tate2efd2db2011-07-19 16:32:49 -07002571 private OutputStream emitAesBackupHeader(StringBuilder headerbuf,
2572 OutputStream ofstream) throws Exception {
2573 // User key will be used to encrypt the master key.
2574 byte[] newUserSalt = randomBytes(PBKDF2_SALT_SIZE);
Christopher Tate728a1c42011-07-28 18:03:03 -07002575 SecretKey userKey = buildPasswordKey(mEncryptPassword, newUserSalt,
Christopher Tate2efd2db2011-07-19 16:32:49 -07002576 PBKDF2_HASH_ROUNDS);
2577
2578 // the master key is random for each backup
2579 byte[] masterPw = new byte[256 / 8];
2580 mRng.nextBytes(masterPw);
2581 byte[] checksumSalt = randomBytes(PBKDF2_SALT_SIZE);
2582
2583 // primary encryption of the datastream with the random key
2584 Cipher c = Cipher.getInstance("AES/CBC/PKCS5Padding");
2585 SecretKeySpec masterKeySpec = new SecretKeySpec(masterPw, "AES");
2586 c.init(Cipher.ENCRYPT_MODE, masterKeySpec);
2587 OutputStream finalOutput = new CipherOutputStream(ofstream, c);
2588
2589 // line 4: name of encryption algorithm
2590 headerbuf.append(ENCRYPTION_ALGORITHM_NAME);
2591 headerbuf.append('\n');
2592 // line 5: user password salt [hex]
2593 headerbuf.append(byteArrayToHex(newUserSalt));
2594 headerbuf.append('\n');
2595 // line 6: master key checksum salt [hex]
2596 headerbuf.append(byteArrayToHex(checksumSalt));
2597 headerbuf.append('\n');
2598 // line 7: number of PBKDF2 rounds used [decimal]
2599 headerbuf.append(PBKDF2_HASH_ROUNDS);
2600 headerbuf.append('\n');
2601
2602 // line 8: IV of the user key [hex]
2603 Cipher mkC = Cipher.getInstance("AES/CBC/PKCS5Padding");
2604 mkC.init(Cipher.ENCRYPT_MODE, userKey);
2605
2606 byte[] IV = mkC.getIV();
2607 headerbuf.append(byteArrayToHex(IV));
2608 headerbuf.append('\n');
2609
2610 // line 9: master IV + key blob, encrypted by the user key [hex]. Blob format:
2611 // [byte] IV length = Niv
2612 // [array of Niv bytes] IV itself
2613 // [byte] master key length = Nmk
2614 // [array of Nmk bytes] master key itself
2615 // [byte] MK checksum hash length = Nck
2616 // [array of Nck bytes] master key checksum hash
2617 //
2618 // The checksum is the (master key + checksum salt), run through the
2619 // stated number of PBKDF2 rounds
2620 IV = c.getIV();
2621 byte[] mk = masterKeySpec.getEncoded();
2622 byte[] checksum = makeKeyChecksum(masterKeySpec.getEncoded(),
2623 checksumSalt, PBKDF2_HASH_ROUNDS);
2624
2625 ByteArrayOutputStream blob = new ByteArrayOutputStream(IV.length + mk.length
2626 + checksum.length + 3);
2627 DataOutputStream mkOut = new DataOutputStream(blob);
2628 mkOut.writeByte(IV.length);
2629 mkOut.write(IV);
2630 mkOut.writeByte(mk.length);
2631 mkOut.write(mk);
2632 mkOut.writeByte(checksum.length);
2633 mkOut.write(checksum);
2634 mkOut.flush();
2635 byte[] encryptedMk = mkC.doFinal(blob.toByteArray());
2636 headerbuf.append(byteArrayToHex(encryptedMk));
2637 headerbuf.append('\n');
2638
2639 return finalOutput;
2640 }
2641
2642 private void backupOnePackage(PackageInfo pkg, OutputStream out)
Christopher Tate7926a692011-07-11 11:31:57 -07002643 throws RemoteException {
Christopher Tateb0628bf2011-06-02 15:08:13 -07002644 Slog.d(TAG, "Binding to full backup agent : " + pkg.packageName);
2645
2646 IBackupAgent agent = bindToAgentSynchronous(pkg.applicationInfo,
2647 IApplicationThread.BACKUP_MODE_FULL);
2648 if (agent != null) {
Christopher Tate7926a692011-07-11 11:31:57 -07002649 ParcelFileDescriptor[] pipes = null;
Christopher Tateb0628bf2011-06-02 15:08:13 -07002650 try {
Christopher Tate73d73692012-01-20 17:11:31 -08002651 pipes = ParcelFileDescriptor.createPipe();
Christopher Tate7926a692011-07-11 11:31:57 -07002652
Christopher Tateb0628bf2011-06-02 15:08:13 -07002653 ApplicationInfo app = pkg.applicationInfo;
Christopher Tate73d73692012-01-20 17:11:31 -08002654 final boolean isSharedStorage = pkg.packageName.equals(SHARED_BACKUP_AGENT_PACKAGE);
Christopher Tate79ec80d2011-06-24 14:58:49 -07002655 final boolean sendApk = mIncludeApks
Christopher Tate73d73692012-01-20 17:11:31 -08002656 && !isSharedStorage
Christopher Tateb0628bf2011-06-02 15:08:13 -07002657 && ((app.flags & ApplicationInfo.FLAG_FORWARD_LOCK) == 0)
2658 && ((app.flags & ApplicationInfo.FLAG_SYSTEM) == 0 ||
2659 (app.flags & ApplicationInfo.FLAG_UPDATED_SYSTEM_APP) != 0);
2660
Christopher Tate73d73692012-01-20 17:11:31 -08002661 sendOnBackupPackage(isSharedStorage ? "Shared storage" : pkg.packageName);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002662
Christopher Tate7926a692011-07-11 11:31:57 -07002663 final int token = generateToken();
2664 FullBackupRunner runner = new FullBackupRunner(pkg, agent, pipes[1],
Christopher Tate73d73692012-01-20 17:11:31 -08002665 token, sendApk, !isSharedStorage);
Christopher Tate7926a692011-07-11 11:31:57 -07002666 pipes[1].close(); // the runner has dup'd it
2667 pipes[1] = null;
2668 Thread t = new Thread(runner);
2669 t.start();
Christopher Tateb0628bf2011-06-02 15:08:13 -07002670
Christopher Tate7926a692011-07-11 11:31:57 -07002671 // Now pull data from the app and stuff it into the compressor
2672 try {
2673 FileInputStream raw = new FileInputStream(pipes[0].getFileDescriptor());
2674 DataInputStream in = new DataInputStream(raw);
Christopher Tate79ec80d2011-06-24 14:58:49 -07002675
Christopher Tate7926a692011-07-11 11:31:57 -07002676 byte[] buffer = new byte[16 * 1024];
2677 int chunkTotal;
2678 while ((chunkTotal = in.readInt()) > 0) {
2679 while (chunkTotal > 0) {
2680 int toRead = (chunkTotal > buffer.length)
2681 ? buffer.length : chunkTotal;
2682 int nRead = in.read(buffer, 0, toRead);
2683 out.write(buffer, 0, nRead);
2684 chunkTotal -= nRead;
2685 }
2686 }
2687 } catch (IOException e) {
2688 Slog.i(TAG, "Caught exception reading from agent", e);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002689 }
2690
Christopher Tateb0628bf2011-06-02 15:08:13 -07002691 if (!waitUntilOperationComplete(token)) {
2692 Slog.e(TAG, "Full backup failed on package " + pkg.packageName);
2693 } else {
Christopher Tate7926a692011-07-11 11:31:57 -07002694 if (DEBUG) Slog.d(TAG, "Full package backup success: " + pkg.packageName);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002695 }
Christopher Tate7926a692011-07-11 11:31:57 -07002696
Christopher Tateb0628bf2011-06-02 15:08:13 -07002697 } catch (IOException e) {
2698 Slog.e(TAG, "Error backing up " + pkg.packageName, e);
Christopher Tate7926a692011-07-11 11:31:57 -07002699 } finally {
2700 try {
Christopher Tate2efd2db2011-07-19 16:32:49 -07002701 // flush after every package
2702 out.flush();
Christopher Tate7926a692011-07-11 11:31:57 -07002703 if (pipes != null) {
2704 if (pipes[0] != null) pipes[0].close();
2705 if (pipes[1] != null) pipes[1].close();
2706 }
Christopher Tate7926a692011-07-11 11:31:57 -07002707 } catch (IOException e) {
2708 Slog.w(TAG, "Error bringing down backup stack");
2709 }
Christopher Tateb0628bf2011-06-02 15:08:13 -07002710 }
2711 } else {
2712 Slog.w(TAG, "Unable to bind to full agent for " + pkg.packageName);
2713 }
2714 tearDown(pkg);
2715 }
2716
Christopher Tate79ec80d2011-06-24 14:58:49 -07002717 private void writeApkToBackup(PackageInfo pkg, BackupDataOutput output) {
2718 // Forward-locked apps, system-bundled .apks, etc are filtered out before we get here
2719 final String appSourceDir = pkg.applicationInfo.sourceDir;
2720 final String apkDir = new File(appSourceDir).getParent();
2721 FullBackup.backupToTar(pkg.packageName, FullBackup.APK_TREE_TOKEN, null,
2722 apkDir, appSourceDir, output);
2723
2724 // Save associated .obb content if it exists and we did save the apk
2725 // check for .obb and save those too
2726 final File obbDir = Environment.getExternalStorageAppObbDirectory(pkg.packageName);
2727 if (obbDir != null) {
Christopher Tatec58efa62011-08-01 19:20:14 -07002728 if (MORE_DEBUG) Log.i(TAG, "obb dir: " + obbDir.getAbsolutePath());
Christopher Tate79ec80d2011-06-24 14:58:49 -07002729 File[] obbFiles = obbDir.listFiles();
2730 if (obbFiles != null) {
2731 final String obbDirName = obbDir.getAbsolutePath();
2732 for (File obb : obbFiles) {
2733 FullBackup.backupToTar(pkg.packageName, FullBackup.OBB_TREE_TOKEN, null,
2734 obbDirName, obb.getAbsolutePath(), output);
2735 }
2736 }
2737 }
2738 }
2739
Christopher Tate6853fcf2011-08-10 17:52:21 -07002740 private void finalizeBackup(OutputStream out) {
2741 try {
2742 // A standard 'tar' EOF sequence: two 512-byte blocks of all zeroes.
2743 byte[] eof = new byte[512 * 2]; // newly allocated == zero filled
2744 out.write(eof);
2745 } catch (IOException e) {
2746 Slog.w(TAG, "Error attempting to finalize backup stream");
2747 }
2748 }
2749
Christopher Tate4a627c72011-04-01 14:43:32 -07002750 private void writeAppManifest(PackageInfo pkg, File manifestFile, boolean withApk)
2751 throws IOException {
2752 // Manifest format. All data are strings ending in LF:
2753 // BACKUP_MANIFEST_VERSION, currently 1
2754 //
2755 // Version 1:
2756 // package name
2757 // package's versionCode
Christopher Tate75a99702011-05-18 16:28:19 -07002758 // platform versionCode
2759 // getInstallerPackageName() for this package (maybe empty)
2760 // boolean: "1" if archive includes .apk; any other string means not
Christopher Tate4a627c72011-04-01 14:43:32 -07002761 // number of signatures == N
2762 // N*: signature byte array in ascii format per Signature.toCharsString()
2763 StringBuilder builder = new StringBuilder(4096);
2764 StringBuilderPrinter printer = new StringBuilderPrinter(builder);
2765
2766 printer.println(Integer.toString(BACKUP_MANIFEST_VERSION));
2767 printer.println(pkg.packageName);
2768 printer.println(Integer.toString(pkg.versionCode));
Christopher Tate75a99702011-05-18 16:28:19 -07002769 printer.println(Integer.toString(Build.VERSION.SDK_INT));
2770
2771 String installerName = mPackageManager.getInstallerPackageName(pkg.packageName);
2772 printer.println((installerName != null) ? installerName : "");
2773
Christopher Tate4a627c72011-04-01 14:43:32 -07002774 printer.println(withApk ? "1" : "0");
2775 if (pkg.signatures == null) {
2776 printer.println("0");
2777 } else {
2778 printer.println(Integer.toString(pkg.signatures.length));
2779 for (Signature sig : pkg.signatures) {
2780 printer.println(sig.toCharsString());
2781 }
2782 }
2783
2784 FileOutputStream outstream = new FileOutputStream(manifestFile);
Christopher Tate4a627c72011-04-01 14:43:32 -07002785 outstream.write(builder.toString().getBytes());
2786 outstream.close();
2787 }
2788
2789 private void tearDown(PackageInfo pkg) {
Christopher Tateb0628bf2011-06-02 15:08:13 -07002790 if (pkg != null) {
2791 final ApplicationInfo app = pkg.applicationInfo;
2792 if (app != null) {
2793 try {
2794 // unbind and tidy up even on timeout or failure, just in case
2795 mActivityManager.unbindBackupAgent(app);
Christopher Tate4a627c72011-04-01 14:43:32 -07002796
Christopher Tateb0628bf2011-06-02 15:08:13 -07002797 // The agent was running with a stub Application object, so shut it down.
Christopher Tate2efd2db2011-07-19 16:32:49 -07002798 if (app.uid != Process.SYSTEM_UID
2799 && app.uid != Process.PHONE_UID) {
Christopher Tatec58efa62011-08-01 19:20:14 -07002800 if (MORE_DEBUG) Slog.d(TAG, "Backup complete, killing host process");
Christopher Tateb0628bf2011-06-02 15:08:13 -07002801 mActivityManager.killApplicationProcess(app.processName, app.uid);
2802 } else {
Christopher Tatec58efa62011-08-01 19:20:14 -07002803 if (MORE_DEBUG) Slog.d(TAG, "Not killing after restore: " + app.processName);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002804 }
2805 } catch (RemoteException e) {
2806 Slog.d(TAG, "Lost app trying to shut down");
2807 }
Christopher Tate4a627c72011-04-01 14:43:32 -07002808 }
Christopher Tate4a627c72011-04-01 14:43:32 -07002809 }
2810 }
2811
2812 // wrappers for observer use
2813 void sendStartBackup() {
2814 if (mObserver != null) {
2815 try {
2816 mObserver.onStartBackup();
2817 } catch (RemoteException e) {
2818 Slog.w(TAG, "full backup observer went away: startBackup");
2819 mObserver = null;
2820 }
2821 }
2822 }
2823
2824 void sendOnBackupPackage(String name) {
2825 if (mObserver != null) {
2826 try {
2827 // TODO: use a more user-friendly name string
2828 mObserver.onBackupPackage(name);
2829 } catch (RemoteException e) {
2830 Slog.w(TAG, "full backup observer went away: backupPackage");
2831 mObserver = null;
2832 }
2833 }
2834 }
2835
2836 void sendEndBackup() {
2837 if (mObserver != null) {
2838 try {
2839 mObserver.onEndBackup();
2840 } catch (RemoteException e) {
2841 Slog.w(TAG, "full backup observer went away: endBackup");
2842 mObserver = null;
2843 }
2844 }
2845 }
2846 }
2847
2848
Christopher Tate75a99702011-05-18 16:28:19 -07002849 // ----- Full restore from a file/socket -----
2850
2851 // Description of a file in the restore datastream
2852 static class FileMetadata {
2853 String packageName; // name of the owning app
2854 String installerPackageName; // name of the market-type app that installed the owner
Christopher Tate79ec80d2011-06-24 14:58:49 -07002855 int type; // e.g. BackupAgent.TYPE_DIRECTORY
Christopher Tate75a99702011-05-18 16:28:19 -07002856 String domain; // e.g. FullBackup.DATABASE_TREE_TOKEN
2857 String path; // subpath within the semantic domain
2858 long mode; // e.g. 0666 (actually int)
2859 long mtime; // last mod time, UTC time_t (actually int)
2860 long size; // bytes of content
Christopher Tatee9e78ec2011-06-08 20:09:31 -07002861
2862 @Override
2863 public String toString() {
2864 StringBuilder sb = new StringBuilder(128);
2865 sb.append("FileMetadata{");
2866 sb.append(packageName); sb.append(',');
2867 sb.append(type); sb.append(',');
2868 sb.append(domain); sb.append(':'); sb.append(path); sb.append(',');
2869 sb.append(size);
2870 sb.append('}');
2871 return sb.toString();
2872 }
Christopher Tate75a99702011-05-18 16:28:19 -07002873 }
2874
2875 enum RestorePolicy {
2876 IGNORE,
2877 ACCEPT,
2878 ACCEPT_IF_APK
2879 }
2880
2881 class PerformFullRestoreTask implements Runnable {
2882 ParcelFileDescriptor mInputFile;
Christopher Tate728a1c42011-07-28 18:03:03 -07002883 String mCurrentPassword;
2884 String mDecryptPassword;
Christopher Tate75a99702011-05-18 16:28:19 -07002885 IFullBackupRestoreObserver mObserver;
2886 AtomicBoolean mLatchObject;
2887 IBackupAgent mAgent;
2888 String mAgentPackage;
2889 ApplicationInfo mTargetApp;
2890 ParcelFileDescriptor[] mPipes = null;
2891
Christopher Tatee9e78ec2011-06-08 20:09:31 -07002892 long mBytes;
2893
Christopher Tate75a99702011-05-18 16:28:19 -07002894 // possible handling states for a given package in the restore dataset
2895 final HashMap<String, RestorePolicy> mPackagePolicies
2896 = new HashMap<String, RestorePolicy>();
2897
2898 // installer package names for each encountered app, derived from the manifests
2899 final HashMap<String, String> mPackageInstallers = new HashMap<String, String>();
2900
2901 // Signatures for a given package found in its manifest file
2902 final HashMap<String, Signature[]> mManifestSignatures
2903 = new HashMap<String, Signature[]>();
2904
2905 // Packages we've already wiped data on when restoring their first file
2906 final HashSet<String> mClearedPackages = new HashSet<String>();
2907
Christopher Tate728a1c42011-07-28 18:03:03 -07002908 PerformFullRestoreTask(ParcelFileDescriptor fd, String curPassword, String decryptPassword,
Christopher Tate2efd2db2011-07-19 16:32:49 -07002909 IFullBackupRestoreObserver observer, AtomicBoolean latch) {
Christopher Tate75a99702011-05-18 16:28:19 -07002910 mInputFile = fd;
Christopher Tate728a1c42011-07-28 18:03:03 -07002911 mCurrentPassword = curPassword;
2912 mDecryptPassword = decryptPassword;
Christopher Tate75a99702011-05-18 16:28:19 -07002913 mObserver = observer;
2914 mLatchObject = latch;
2915 mAgent = null;
2916 mAgentPackage = null;
2917 mTargetApp = null;
2918
2919 // Which packages we've already wiped data on. We prepopulate this
2920 // with a whitelist of packages known to be unclearable.
2921 mClearedPackages.add("android");
Christopher Tate75a99702011-05-18 16:28:19 -07002922 mClearedPackages.add("com.android.providers.settings");
Christopher Tateb0628bf2011-06-02 15:08:13 -07002923
Christopher Tate75a99702011-05-18 16:28:19 -07002924 }
2925
2926 class RestoreFileRunnable implements Runnable {
2927 IBackupAgent mAgent;
2928 FileMetadata mInfo;
2929 ParcelFileDescriptor mSocket;
2930 int mToken;
2931
2932 RestoreFileRunnable(IBackupAgent agent, FileMetadata info,
2933 ParcelFileDescriptor socket, int token) throws IOException {
2934 mAgent = agent;
2935 mInfo = info;
2936 mToken = token;
2937
2938 // This class is used strictly for process-local binder invocations. The
2939 // semantics of ParcelFileDescriptor differ in this case; in particular, we
2940 // do not automatically get a 'dup'ed descriptor that we can can continue
2941 // to use asynchronously from the caller. So, we make sure to dup it ourselves
2942 // before proceeding to do the restore.
2943 mSocket = ParcelFileDescriptor.dup(socket.getFileDescriptor());
2944 }
2945
2946 @Override
2947 public void run() {
2948 try {
2949 mAgent.doRestoreFile(mSocket, mInfo.size, mInfo.type,
2950 mInfo.domain, mInfo.path, mInfo.mode, mInfo.mtime,
2951 mToken, mBackupManagerBinder);
2952 } catch (RemoteException e) {
2953 // never happens; this is used strictly for local binder calls
2954 }
2955 }
2956 }
2957
2958 @Override
2959 public void run() {
2960 Slog.i(TAG, "--- Performing full-dataset restore ---");
2961 sendStartRestore();
2962
Christopher Tateb0628bf2011-06-02 15:08:13 -07002963 // Are we able to restore shared-storage data?
2964 if (Environment.getExternalStorageState().equals(Environment.MEDIA_MOUNTED)) {
Christopher Tate73d73692012-01-20 17:11:31 -08002965 mPackagePolicies.put(SHARED_BACKUP_AGENT_PACKAGE, RestorePolicy.ACCEPT);
Christopher Tateb0628bf2011-06-02 15:08:13 -07002966 }
2967
Christopher Tate2efd2db2011-07-19 16:32:49 -07002968 FileInputStream rawInStream = null;
2969 DataInputStream rawDataIn = null;
Christopher Tate75a99702011-05-18 16:28:19 -07002970 try {
Christopher Tate728a1c42011-07-28 18:03:03 -07002971 if (hasBackupPassword()) {
2972 if (!passwordMatchesSaved(mCurrentPassword, PBKDF2_HASH_ROUNDS)) {
2973 if (DEBUG) Slog.w(TAG, "Backup password mismatch; aborting");
2974 return;
2975 }
2976 }
2977
Christopher Tatee9e78ec2011-06-08 20:09:31 -07002978 mBytes = 0;
Christopher Tate75a99702011-05-18 16:28:19 -07002979 byte[] buffer = new byte[32 * 1024];
Christopher Tate2efd2db2011-07-19 16:32:49 -07002980 rawInStream = new FileInputStream(mInputFile.getFileDescriptor());
2981 rawDataIn = new DataInputStream(rawInStream);
Christopher Tate7bdb0962011-07-13 19:30:21 -07002982
2983 // First, parse out the unencrypted/uncompressed header
2984 boolean compressed = false;
Christopher Tate2efd2db2011-07-19 16:32:49 -07002985 InputStream preCompressStream = rawInStream;
Christopher Tate7bdb0962011-07-13 19:30:21 -07002986 final InputStream in;
2987
2988 boolean okay = false;
2989 final int headerLen = BACKUP_FILE_HEADER_MAGIC.length();
2990 byte[] streamHeader = new byte[headerLen];
Christopher Tate2efd2db2011-07-19 16:32:49 -07002991 rawDataIn.readFully(streamHeader);
2992 byte[] magicBytes = BACKUP_FILE_HEADER_MAGIC.getBytes("UTF-8");
2993 if (Arrays.equals(magicBytes, streamHeader)) {
2994 // okay, header looks good. now parse out the rest of the fields.
2995 String s = readHeaderLine(rawInStream);
2996 if (Integer.parseInt(s) == BACKUP_FILE_VERSION) {
2997 // okay, it's a version we recognize
2998 s = readHeaderLine(rawInStream);
2999 compressed = (Integer.parseInt(s) != 0);
3000 s = readHeaderLine(rawInStream);
3001 if (s.equals("none")) {
3002 // no more header to parse; we're good to go
3003 okay = true;
Christopher Tate728a1c42011-07-28 18:03:03 -07003004 } else if (mDecryptPassword != null && mDecryptPassword.length() > 0) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003005 preCompressStream = decodeAesHeaderAndInitialize(s, rawInStream);
3006 if (preCompressStream != null) {
Christopher Tate7bdb0962011-07-13 19:30:21 -07003007 okay = true;
Christopher Tate2efd2db2011-07-19 16:32:49 -07003008 }
3009 } else Slog.w(TAG, "Archive is encrypted but no password given");
3010 } else Slog.w(TAG, "Wrong header version: " + s);
3011 } else Slog.w(TAG, "Didn't read the right header magic");
Christopher Tate7bdb0962011-07-13 19:30:21 -07003012
3013 if (!okay) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003014 Slog.w(TAG, "Invalid restore data; aborting.");
Christopher Tate7bdb0962011-07-13 19:30:21 -07003015 return;
3016 }
3017
3018 // okay, use the right stream layer based on compression
Christopher Tate2efd2db2011-07-19 16:32:49 -07003019 in = (compressed) ? new InflaterInputStream(preCompressStream) : preCompressStream;
Christopher Tate75a99702011-05-18 16:28:19 -07003020
3021 boolean didRestore;
3022 do {
Christopher Tate7926a692011-07-11 11:31:57 -07003023 didRestore = restoreOneFile(in, buffer);
Christopher Tate75a99702011-05-18 16:28:19 -07003024 } while (didRestore);
3025
Christopher Tatec58efa62011-08-01 19:20:14 -07003026 if (MORE_DEBUG) Slog.v(TAG, "Done consuming input tarfile, total bytes=" + mBytes);
Christopher Tate7bdb0962011-07-13 19:30:21 -07003027 } catch (IOException e) {
3028 Slog.e(TAG, "Unable to read restore input");
Christopher Tate75a99702011-05-18 16:28:19 -07003029 } finally {
3030 tearDownPipes();
3031 tearDownAgent(mTargetApp);
3032
3033 try {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003034 if (rawDataIn != null) rawDataIn.close();
3035 if (rawInStream != null) rawInStream.close();
Christopher Tate75a99702011-05-18 16:28:19 -07003036 mInputFile.close();
3037 } catch (IOException e) {
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003038 Slog.w(TAG, "Close of restore data pipe threw", e);
Christopher Tate75a99702011-05-18 16:28:19 -07003039 /* nothing we can do about this */
3040 }
3041 synchronized (mCurrentOpLock) {
3042 mCurrentOperations.clear();
3043 }
3044 synchronized (mLatchObject) {
3045 mLatchObject.set(true);
3046 mLatchObject.notifyAll();
3047 }
3048 sendEndRestore();
Christopher Tatec58efa62011-08-01 19:20:14 -07003049 Slog.d(TAG, "Full restore pass complete.");
Christopher Tate336a6492011-10-05 16:05:43 -07003050 mWakelock.release();
Christopher Tate75a99702011-05-18 16:28:19 -07003051 }
3052 }
3053
Christopher Tate7bdb0962011-07-13 19:30:21 -07003054 String readHeaderLine(InputStream in) throws IOException {
3055 int c;
Christopher Tate2efd2db2011-07-19 16:32:49 -07003056 StringBuilder buffer = new StringBuilder(80);
Christopher Tate7bdb0962011-07-13 19:30:21 -07003057 while ((c = in.read()) >= 0) {
3058 if (c == '\n') break; // consume and discard the newlines
3059 buffer.append((char)c);
3060 }
3061 return buffer.toString();
3062 }
3063
Christopher Tate2efd2db2011-07-19 16:32:49 -07003064 InputStream decodeAesHeaderAndInitialize(String encryptionName, InputStream rawInStream) {
3065 InputStream result = null;
3066 try {
3067 if (encryptionName.equals(ENCRYPTION_ALGORITHM_NAME)) {
3068
3069 String userSaltHex = readHeaderLine(rawInStream); // 5
3070 byte[] userSalt = hexToByteArray(userSaltHex);
3071
3072 String ckSaltHex = readHeaderLine(rawInStream); // 6
3073 byte[] ckSalt = hexToByteArray(ckSaltHex);
3074
3075 int rounds = Integer.parseInt(readHeaderLine(rawInStream)); // 7
3076 String userIvHex = readHeaderLine(rawInStream); // 8
3077
3078 String masterKeyBlobHex = readHeaderLine(rawInStream); // 9
3079
3080 // decrypt the master key blob
3081 Cipher c = Cipher.getInstance("AES/CBC/PKCS5Padding");
Christopher Tate728a1c42011-07-28 18:03:03 -07003082 SecretKey userKey = buildPasswordKey(mDecryptPassword, userSalt,
Christopher Tate2efd2db2011-07-19 16:32:49 -07003083 rounds);
3084 byte[] IV = hexToByteArray(userIvHex);
3085 IvParameterSpec ivSpec = new IvParameterSpec(IV);
3086 c.init(Cipher.DECRYPT_MODE,
3087 new SecretKeySpec(userKey.getEncoded(), "AES"),
3088 ivSpec);
3089 byte[] mkCipher = hexToByteArray(masterKeyBlobHex);
3090 byte[] mkBlob = c.doFinal(mkCipher);
3091
3092 // first, the master key IV
3093 int offset = 0;
3094 int len = mkBlob[offset++];
3095 IV = Arrays.copyOfRange(mkBlob, offset, offset + len);
3096 offset += len;
3097 // then the master key itself
3098 len = mkBlob[offset++];
3099 byte[] mk = Arrays.copyOfRange(mkBlob,
3100 offset, offset + len);
3101 offset += len;
3102 // and finally the master key checksum hash
3103 len = mkBlob[offset++];
3104 byte[] mkChecksum = Arrays.copyOfRange(mkBlob,
3105 offset, offset + len);
3106
3107 // now validate the decrypted master key against the checksum
3108 byte[] calculatedCk = makeKeyChecksum(mk, ckSalt, rounds);
3109 if (Arrays.equals(calculatedCk, mkChecksum)) {
3110 ivSpec = new IvParameterSpec(IV);
3111 c.init(Cipher.DECRYPT_MODE,
3112 new SecretKeySpec(mk, "AES"),
3113 ivSpec);
3114 // Only if all of the above worked properly will 'result' be assigned
3115 result = new CipherInputStream(rawInStream, c);
3116 } else Slog.w(TAG, "Incorrect password");
3117 } else Slog.w(TAG, "Unsupported encryption method: " + encryptionName);
3118 } catch (InvalidAlgorithmParameterException e) {
3119 Slog.e(TAG, "Needed parameter spec unavailable!", e);
3120 } catch (BadPaddingException e) {
3121 // This case frequently occurs when the wrong password is used to decrypt
3122 // the master key. Use the identical "incorrect password" log text as is
3123 // used in the checksum failure log in order to avoid providing additional
3124 // information to an attacker.
3125 Slog.w(TAG, "Incorrect password");
3126 } catch (IllegalBlockSizeException e) {
3127 Slog.w(TAG, "Invalid block size in master key");
3128 } catch (NoSuchAlgorithmException e) {
3129 Slog.e(TAG, "Needed decryption algorithm unavailable!");
3130 } catch (NoSuchPaddingException e) {
3131 Slog.e(TAG, "Needed padding mechanism unavailable!");
3132 } catch (InvalidKeyException e) {
3133 Slog.w(TAG, "Illegal password; aborting");
3134 } catch (NumberFormatException e) {
3135 Slog.w(TAG, "Can't parse restore data header");
3136 } catch (IOException e) {
3137 Slog.w(TAG, "Can't read input header");
3138 }
3139
3140 return result;
3141 }
3142
Christopher Tate75a99702011-05-18 16:28:19 -07003143 boolean restoreOneFile(InputStream instream, byte[] buffer) {
3144 FileMetadata info;
3145 try {
3146 info = readTarHeaders(instream);
3147 if (info != null) {
Christopher Tatec58efa62011-08-01 19:20:14 -07003148 if (MORE_DEBUG) {
Christopher Tate75a99702011-05-18 16:28:19 -07003149 dumpFileMetadata(info);
3150 }
3151
3152 final String pkg = info.packageName;
3153 if (!pkg.equals(mAgentPackage)) {
3154 // okay, change in package; set up our various
3155 // bookkeeping if we haven't seen it yet
3156 if (!mPackagePolicies.containsKey(pkg)) {
3157 mPackagePolicies.put(pkg, RestorePolicy.IGNORE);
3158 }
3159
3160 // Clean up the previous agent relationship if necessary,
3161 // and let the observer know we're considering a new app.
3162 if (mAgent != null) {
3163 if (DEBUG) Slog.d(TAG, "Saw new package; tearing down old one");
3164 tearDownPipes();
3165 tearDownAgent(mTargetApp);
3166 mTargetApp = null;
3167 mAgentPackage = null;
3168 }
3169 }
3170
3171 if (info.path.equals(BACKUP_MANIFEST_FILENAME)) {
3172 mPackagePolicies.put(pkg, readAppManifest(info, instream));
3173 mPackageInstallers.put(pkg, info.installerPackageName);
3174 // We've read only the manifest content itself at this point,
3175 // so consume the footer before looping around to the next
3176 // input file
3177 skipTarPadding(info.size, instream);
3178 sendOnRestorePackage(pkg);
3179 } else {
3180 // Non-manifest, so it's actual file data. Is this a package
3181 // we're ignoring?
3182 boolean okay = true;
3183 RestorePolicy policy = mPackagePolicies.get(pkg);
3184 switch (policy) {
3185 case IGNORE:
3186 okay = false;
3187 break;
3188
3189 case ACCEPT_IF_APK:
3190 // If we're in accept-if-apk state, then the first file we
3191 // see MUST be the apk.
3192 if (info.domain.equals(FullBackup.APK_TREE_TOKEN)) {
3193 if (DEBUG) Slog.d(TAG, "APK file; installing");
3194 // Try to install the app.
3195 String installerName = mPackageInstallers.get(pkg);
3196 okay = installApk(info, installerName, instream);
3197 // good to go; promote to ACCEPT
3198 mPackagePolicies.put(pkg, (okay)
3199 ? RestorePolicy.ACCEPT
3200 : RestorePolicy.IGNORE);
3201 // At this point we've consumed this file entry
3202 // ourselves, so just strip the tar footer and
3203 // go on to the next file in the input stream
3204 skipTarPadding(info.size, instream);
3205 return true;
3206 } else {
3207 // File data before (or without) the apk. We can't
3208 // handle it coherently in this case so ignore it.
3209 mPackagePolicies.put(pkg, RestorePolicy.IGNORE);
3210 okay = false;
3211 }
3212 break;
3213
3214 case ACCEPT:
3215 if (info.domain.equals(FullBackup.APK_TREE_TOKEN)) {
3216 if (DEBUG) Slog.d(TAG, "apk present but ACCEPT");
3217 // we can take the data without the apk, so we
3218 // *want* to do so. skip the apk by declaring this
3219 // one file not-okay without changing the restore
3220 // policy for the package.
3221 okay = false;
3222 }
3223 break;
3224
3225 default:
3226 // Something has gone dreadfully wrong when determining
3227 // the restore policy from the manifest. Ignore the
3228 // rest of this package's data.
3229 Slog.e(TAG, "Invalid policy from manifest");
3230 okay = false;
3231 mPackagePolicies.put(pkg, RestorePolicy.IGNORE);
3232 break;
3233 }
3234
3235 // If the policy is satisfied, go ahead and set up to pipe the
3236 // data to the agent.
3237 if (DEBUG && okay && mAgent != null) {
3238 Slog.i(TAG, "Reusing existing agent instance");
3239 }
3240 if (okay && mAgent == null) {
3241 if (DEBUG) Slog.d(TAG, "Need to launch agent for " + pkg);
3242
3243 try {
3244 mTargetApp = mPackageManager.getApplicationInfo(pkg, 0);
3245
3246 // If we haven't sent any data to this app yet, we probably
3247 // need to clear it first. Check that.
3248 if (!mClearedPackages.contains(pkg)) {
Christopher Tate79ec80d2011-06-24 14:58:49 -07003249 // apps with their own backup agents are
Christopher Tate75a99702011-05-18 16:28:19 -07003250 // responsible for coherently managing a full
3251 // restore.
Christopher Tate79ec80d2011-06-24 14:58:49 -07003252 if (mTargetApp.backupAgentName == null) {
Christopher Tate75a99702011-05-18 16:28:19 -07003253 if (DEBUG) Slog.d(TAG, "Clearing app data preparatory to full restore");
3254 clearApplicationDataSynchronous(pkg);
3255 } else {
Christopher Tate79ec80d2011-06-24 14:58:49 -07003256 if (DEBUG) Slog.d(TAG, "backup agent ("
3257 + mTargetApp.backupAgentName + ") => no clear");
Christopher Tate75a99702011-05-18 16:28:19 -07003258 }
3259 mClearedPackages.add(pkg);
3260 } else {
3261 if (DEBUG) Slog.d(TAG, "We've initialized this app already; no clear required");
3262 }
3263
3264 // All set; now set up the IPC and launch the agent
3265 setUpPipes();
3266 mAgent = bindToAgentSynchronous(mTargetApp,
3267 IApplicationThread.BACKUP_MODE_RESTORE_FULL);
3268 mAgentPackage = pkg;
3269 } catch (IOException e) {
3270 // fall through to error handling
3271 } catch (NameNotFoundException e) {
3272 // fall through to error handling
3273 }
3274
3275 if (mAgent == null) {
3276 if (DEBUG) Slog.d(TAG, "Unable to create agent for " + pkg);
3277 okay = false;
3278 tearDownPipes();
3279 mPackagePolicies.put(pkg, RestorePolicy.IGNORE);
3280 }
3281 }
3282
3283 // Sanity check: make sure we never give data to the wrong app. This
3284 // should never happen but a little paranoia here won't go amiss.
3285 if (okay && !pkg.equals(mAgentPackage)) {
3286 Slog.e(TAG, "Restoring data for " + pkg
3287 + " but agent is for " + mAgentPackage);
3288 okay = false;
3289 }
3290
3291 // At this point we have an agent ready to handle the full
3292 // restore data as well as a pipe for sending data to
3293 // that agent. Tell the agent to start reading from the
3294 // pipe.
3295 if (okay) {
3296 boolean agentSuccess = true;
3297 long toCopy = info.size;
3298 final int token = generateToken();
3299 try {
3300 if (DEBUG) Slog.d(TAG, "Invoking agent to restore file "
3301 + info.path);
Christopher Tate8e294d42011-08-31 20:37:12 -07003302 prepareOperationTimeout(token, TIMEOUT_FULL_BACKUP_INTERVAL, null);
Christopher Tate75a99702011-05-18 16:28:19 -07003303 // fire up the app's agent listening on the socket. If
3304 // the agent is running in the system process we can't
3305 // just invoke it asynchronously, so we provide a thread
3306 // for it here.
3307 if (mTargetApp.processName.equals("system")) {
3308 Slog.d(TAG, "system process agent - spinning a thread");
3309 RestoreFileRunnable runner = new RestoreFileRunnable(
3310 mAgent, info, mPipes[0], token);
3311 new Thread(runner).start();
3312 } else {
3313 mAgent.doRestoreFile(mPipes[0], info.size, info.type,
3314 info.domain, info.path, info.mode, info.mtime,
3315 token, mBackupManagerBinder);
3316 }
3317 } catch (IOException e) {
3318 // couldn't dup the socket for a process-local restore
3319 Slog.d(TAG, "Couldn't establish restore");
3320 agentSuccess = false;
3321 okay = false;
3322 } catch (RemoteException e) {
3323 // whoops, remote agent went away. We'll eat the content
3324 // ourselves, then, and not copy it over.
3325 Slog.e(TAG, "Agent crashed during full restore");
3326 agentSuccess = false;
3327 okay = false;
3328 }
3329
3330 // Copy over the data if the agent is still good
3331 if (okay) {
3332 boolean pipeOkay = true;
3333 FileOutputStream pipe = new FileOutputStream(
3334 mPipes[1].getFileDescriptor());
Christopher Tate75a99702011-05-18 16:28:19 -07003335 while (toCopy > 0) {
3336 int toRead = (toCopy > buffer.length)
3337 ? buffer.length : (int)toCopy;
3338 int nRead = instream.read(buffer, 0, toRead);
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003339 if (nRead >= 0) mBytes += nRead;
Christopher Tate75a99702011-05-18 16:28:19 -07003340 if (nRead <= 0) break;
3341 toCopy -= nRead;
3342
3343 // send it to the output pipe as long as things
3344 // are still good
3345 if (pipeOkay) {
3346 try {
3347 pipe.write(buffer, 0, nRead);
3348 } catch (IOException e) {
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003349 Slog.e(TAG, "Failed to write to restore pipe", e);
Christopher Tate75a99702011-05-18 16:28:19 -07003350 pipeOkay = false;
3351 }
3352 }
3353 }
3354
3355 // done sending that file! Now we just need to consume
3356 // the delta from info.size to the end of block.
3357 skipTarPadding(info.size, instream);
3358
3359 // and now that we've sent it all, wait for the remote
3360 // side to acknowledge receipt
3361 agentSuccess = waitUntilOperationComplete(token);
3362 }
3363
3364 // okay, if the remote end failed at any point, deal with
3365 // it by ignoring the rest of the restore on it
3366 if (!agentSuccess) {
3367 mBackupHandler.removeMessages(MSG_TIMEOUT);
3368 tearDownPipes();
3369 tearDownAgent(mTargetApp);
3370 mAgent = null;
3371 mPackagePolicies.put(pkg, RestorePolicy.IGNORE);
3372 }
3373 }
3374
3375 // Problems setting up the agent communication, or an already-
3376 // ignored package: skip to the next tar stream entry by
3377 // reading and discarding this file.
3378 if (!okay) {
3379 if (DEBUG) Slog.d(TAG, "[discarding file content]");
3380 long bytesToConsume = (info.size + 511) & ~511;
3381 while (bytesToConsume > 0) {
3382 int toRead = (bytesToConsume > buffer.length)
3383 ? buffer.length : (int)bytesToConsume;
3384 long nRead = instream.read(buffer, 0, toRead);
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003385 if (nRead >= 0) mBytes += nRead;
Christopher Tate75a99702011-05-18 16:28:19 -07003386 if (nRead <= 0) break;
3387 bytesToConsume -= nRead;
3388 }
3389 }
3390 }
3391 }
3392 } catch (IOException e) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003393 if (DEBUG) Slog.w(TAG, "io exception on restore socket read", e);
Christopher Tate75a99702011-05-18 16:28:19 -07003394 // treat as EOF
3395 info = null;
3396 }
3397
3398 return (info != null);
3399 }
3400
3401 void setUpPipes() throws IOException {
3402 mPipes = ParcelFileDescriptor.createPipe();
3403 }
3404
3405 void tearDownPipes() {
3406 if (mPipes != null) {
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003407 try {
3408 mPipes[0].close();
3409 mPipes[0] = null;
3410 mPipes[1].close();
3411 mPipes[1] = null;
3412 } catch (IOException e) {
3413 Slog.w(TAG, "Couldn't close agent pipes", e);
Christopher Tate75a99702011-05-18 16:28:19 -07003414 }
3415 mPipes = null;
3416 }
3417 }
3418
3419 void tearDownAgent(ApplicationInfo app) {
3420 if (mAgent != null) {
3421 try {
3422 // unbind and tidy up even on timeout or failure, just in case
3423 mActivityManager.unbindBackupAgent(app);
3424
3425 // The agent was running with a stub Application object, so shut it down.
3426 // !!! We hardcode the confirmation UI's package name here rather than use a
3427 // manifest flag! TODO something less direct.
3428 if (app.uid != Process.SYSTEM_UID
3429 && !app.packageName.equals("com.android.backupconfirm")) {
3430 if (DEBUG) Slog.d(TAG, "Killing host process");
3431 mActivityManager.killApplicationProcess(app.processName, app.uid);
3432 } else {
3433 if (DEBUG) Slog.d(TAG, "Not killing after full restore");
3434 }
3435 } catch (RemoteException e) {
3436 Slog.d(TAG, "Lost app trying to shut down");
3437 }
3438 mAgent = null;
3439 }
3440 }
3441
3442 class RestoreInstallObserver extends IPackageInstallObserver.Stub {
3443 final AtomicBoolean mDone = new AtomicBoolean();
Christopher Tatea858cb02011-06-03 12:27:51 -07003444 String mPackageName;
Christopher Tate75a99702011-05-18 16:28:19 -07003445 int mResult;
3446
3447 public void reset() {
3448 synchronized (mDone) {
3449 mDone.set(false);
3450 }
3451 }
3452
3453 public void waitForCompletion() {
3454 synchronized (mDone) {
3455 while (mDone.get() == false) {
3456 try {
3457 mDone.wait();
3458 } catch (InterruptedException e) { }
3459 }
3460 }
3461 }
3462
3463 int getResult() {
3464 return mResult;
3465 }
3466
3467 @Override
3468 public void packageInstalled(String packageName, int returnCode)
3469 throws RemoteException {
3470 synchronized (mDone) {
3471 mResult = returnCode;
Christopher Tatea858cb02011-06-03 12:27:51 -07003472 mPackageName = packageName;
Christopher Tate75a99702011-05-18 16:28:19 -07003473 mDone.set(true);
3474 mDone.notifyAll();
3475 }
3476 }
3477 }
Christopher Tatea858cb02011-06-03 12:27:51 -07003478
3479 class RestoreDeleteObserver extends IPackageDeleteObserver.Stub {
3480 final AtomicBoolean mDone = new AtomicBoolean();
3481 int mResult;
3482
3483 public void reset() {
3484 synchronized (mDone) {
3485 mDone.set(false);
3486 }
3487 }
3488
3489 public void waitForCompletion() {
3490 synchronized (mDone) {
3491 while (mDone.get() == false) {
3492 try {
3493 mDone.wait();
3494 } catch (InterruptedException e) { }
3495 }
3496 }
3497 }
3498
3499 @Override
3500 public void packageDeleted(String packageName, int returnCode) throws RemoteException {
3501 synchronized (mDone) {
3502 mResult = returnCode;
3503 mDone.set(true);
3504 mDone.notifyAll();
3505 }
3506 }
3507 }
3508
Christopher Tate75a99702011-05-18 16:28:19 -07003509 final RestoreInstallObserver mInstallObserver = new RestoreInstallObserver();
Christopher Tatea858cb02011-06-03 12:27:51 -07003510 final RestoreDeleteObserver mDeleteObserver = new RestoreDeleteObserver();
Christopher Tate75a99702011-05-18 16:28:19 -07003511
3512 boolean installApk(FileMetadata info, String installerPackage, InputStream instream) {
3513 boolean okay = true;
3514
3515 if (DEBUG) Slog.d(TAG, "Installing from backup: " + info.packageName);
3516
3517 // The file content is an .apk file. Copy it out to a staging location and
3518 // attempt to install it.
3519 File apkFile = new File(mDataDir, info.packageName);
3520 try {
3521 FileOutputStream apkStream = new FileOutputStream(apkFile);
3522 byte[] buffer = new byte[32 * 1024];
3523 long size = info.size;
3524 while (size > 0) {
3525 long toRead = (buffer.length < size) ? buffer.length : size;
3526 int didRead = instream.read(buffer, 0, (int)toRead);
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003527 if (didRead >= 0) mBytes += didRead;
Christopher Tate75a99702011-05-18 16:28:19 -07003528 apkStream.write(buffer, 0, didRead);
3529 size -= didRead;
3530 }
3531 apkStream.close();
3532
3533 // make sure the installer can read it
3534 apkFile.setReadable(true, false);
3535
3536 // Now install it
3537 Uri packageUri = Uri.fromFile(apkFile);
3538 mInstallObserver.reset();
3539 mPackageManager.installPackage(packageUri, mInstallObserver,
Christopher Tateab63aa82011-09-26 16:30:30 -07003540 PackageManager.INSTALL_REPLACE_EXISTING | PackageManager.INSTALL_FROM_ADB,
3541 installerPackage);
Christopher Tate75a99702011-05-18 16:28:19 -07003542 mInstallObserver.waitForCompletion();
3543
3544 if (mInstallObserver.getResult() != PackageManager.INSTALL_SUCCEEDED) {
3545 // The only time we continue to accept install of data even if the
3546 // apk install failed is if we had already determined that we could
3547 // accept the data regardless.
3548 if (mPackagePolicies.get(info.packageName) != RestorePolicy.ACCEPT) {
3549 okay = false;
3550 }
Christopher Tatea858cb02011-06-03 12:27:51 -07003551 } else {
3552 // Okay, the install succeeded. Make sure it was the right app.
3553 boolean uninstall = false;
3554 if (!mInstallObserver.mPackageName.equals(info.packageName)) {
3555 Slog.w(TAG, "Restore stream claimed to include apk for "
3556 + info.packageName + " but apk was really "
3557 + mInstallObserver.mPackageName);
3558 // delete the package we just put in place; it might be fraudulent
3559 okay = false;
3560 uninstall = true;
3561 } else {
3562 try {
3563 PackageInfo pkg = mPackageManager.getPackageInfo(info.packageName,
3564 PackageManager.GET_SIGNATURES);
3565 if ((pkg.applicationInfo.flags & ApplicationInfo.FLAG_ALLOW_BACKUP) == 0) {
3566 Slog.w(TAG, "Restore stream contains apk of package "
3567 + info.packageName + " but it disallows backup/restore");
3568 okay = false;
3569 } else {
3570 // So far so good -- do the signatures match the manifest?
3571 Signature[] sigs = mManifestSignatures.get(info.packageName);
3572 if (!signaturesMatch(sigs, pkg)) {
3573 Slog.w(TAG, "Installed app " + info.packageName
3574 + " signatures do not match restore manifest");
3575 okay = false;
3576 uninstall = true;
3577 }
3578 }
3579 } catch (NameNotFoundException e) {
3580 Slog.w(TAG, "Install of package " + info.packageName
3581 + " succeeded but now not found");
3582 okay = false;
3583 }
3584 }
3585
3586 // If we're not okay at this point, we need to delete the package
3587 // that we just installed.
3588 if (uninstall) {
3589 mDeleteObserver.reset();
3590 mPackageManager.deletePackage(mInstallObserver.mPackageName,
3591 mDeleteObserver, 0);
3592 mDeleteObserver.waitForCompletion();
3593 }
Christopher Tate75a99702011-05-18 16:28:19 -07003594 }
3595 } catch (IOException e) {
3596 Slog.e(TAG, "Unable to transcribe restored apk for install");
3597 okay = false;
3598 } finally {
3599 apkFile.delete();
3600 }
3601
3602 return okay;
3603 }
3604
3605 // Given an actual file content size, consume the post-content padding mandated
3606 // by the tar format.
3607 void skipTarPadding(long size, InputStream instream) throws IOException {
3608 long partial = (size + 512) % 512;
3609 if (partial > 0) {
Christopher Tate6853fcf2011-08-10 17:52:21 -07003610 final int needed = 512 - (int)partial;
3611 byte[] buffer = new byte[needed];
3612 if (readExactly(instream, buffer, 0, needed) == needed) {
3613 mBytes += needed;
3614 } else throw new IOException("Unexpected EOF in padding");
Christopher Tate75a99702011-05-18 16:28:19 -07003615 }
3616 }
3617
3618 // Returns a policy constant; takes a buffer arg to reduce memory churn
3619 RestorePolicy readAppManifest(FileMetadata info, InputStream instream)
3620 throws IOException {
3621 // Fail on suspiciously large manifest files
3622 if (info.size > 64 * 1024) {
3623 throw new IOException("Restore manifest too big; corrupt? size=" + info.size);
3624 }
Christopher Tate6853fcf2011-08-10 17:52:21 -07003625
Christopher Tate75a99702011-05-18 16:28:19 -07003626 byte[] buffer = new byte[(int) info.size];
Christopher Tate6853fcf2011-08-10 17:52:21 -07003627 if (readExactly(instream, buffer, 0, (int)info.size) == info.size) {
3628 mBytes += info.size;
3629 } else throw new IOException("Unexpected EOF in manifest");
Christopher Tate75a99702011-05-18 16:28:19 -07003630
3631 RestorePolicy policy = RestorePolicy.IGNORE;
3632 String[] str = new String[1];
3633 int offset = 0;
3634
3635 try {
3636 offset = extractLine(buffer, offset, str);
3637 int version = Integer.parseInt(str[0]);
3638 if (version == BACKUP_MANIFEST_VERSION) {
3639 offset = extractLine(buffer, offset, str);
3640 String manifestPackage = str[0];
3641 // TODO: handle <original-package>
3642 if (manifestPackage.equals(info.packageName)) {
3643 offset = extractLine(buffer, offset, str);
3644 version = Integer.parseInt(str[0]); // app version
3645 offset = extractLine(buffer, offset, str);
3646 int platformVersion = Integer.parseInt(str[0]);
3647 offset = extractLine(buffer, offset, str);
3648 info.installerPackageName = (str[0].length() > 0) ? str[0] : null;
3649 offset = extractLine(buffer, offset, str);
3650 boolean hasApk = str[0].equals("1");
3651 offset = extractLine(buffer, offset, str);
3652 int numSigs = Integer.parseInt(str[0]);
Christopher Tate75a99702011-05-18 16:28:19 -07003653 if (numSigs > 0) {
Christopher Tatea858cb02011-06-03 12:27:51 -07003654 Signature[] sigs = new Signature[numSigs];
Christopher Tate75a99702011-05-18 16:28:19 -07003655 for (int i = 0; i < numSigs; i++) {
3656 offset = extractLine(buffer, offset, str);
3657 sigs[i] = new Signature(str[0]);
3658 }
Christopher Tatea858cb02011-06-03 12:27:51 -07003659 mManifestSignatures.put(info.packageName, sigs);
Christopher Tate75a99702011-05-18 16:28:19 -07003660
3661 // Okay, got the manifest info we need...
3662 try {
Christopher Tate75a99702011-05-18 16:28:19 -07003663 PackageInfo pkgInfo = mPackageManager.getPackageInfo(
3664 info.packageName, PackageManager.GET_SIGNATURES);
Christopher Tatea858cb02011-06-03 12:27:51 -07003665 // Fall through to IGNORE if the app explicitly disallows backup
3666 final int flags = pkgInfo.applicationInfo.flags;
3667 if ((flags & ApplicationInfo.FLAG_ALLOW_BACKUP) != 0) {
3668 // Verify signatures against any installed version; if they
3669 // don't match, then we fall though and ignore the data. The
3670 // signatureMatch() method explicitly ignores the signature
3671 // check for packages installed on the system partition, because
3672 // such packages are signed with the platform cert instead of
3673 // the app developer's cert, so they're different on every
3674 // device.
3675 if (signaturesMatch(sigs, pkgInfo)) {
3676 if (pkgInfo.versionCode >= version) {
3677 Slog.i(TAG, "Sig + version match; taking data");
3678 policy = RestorePolicy.ACCEPT;
3679 } else {
3680 // The data is from a newer version of the app than
3681 // is presently installed. That means we can only
3682 // use it if the matching apk is also supplied.
3683 Slog.d(TAG, "Data version " + version
3684 + " is newer than installed version "
3685 + pkgInfo.versionCode + " - requiring apk");
3686 policy = RestorePolicy.ACCEPT_IF_APK;
3687 }
Christopher Tate75a99702011-05-18 16:28:19 -07003688 } else {
Christopher Tatea858cb02011-06-03 12:27:51 -07003689 Slog.w(TAG, "Restore manifest signatures do not match "
3690 + "installed application for " + info.packageName);
Christopher Tate75a99702011-05-18 16:28:19 -07003691 }
Christopher Tatea858cb02011-06-03 12:27:51 -07003692 } else {
3693 if (DEBUG) Slog.i(TAG, "Restore manifest from "
3694 + info.packageName + " but allowBackup=false");
Christopher Tate75a99702011-05-18 16:28:19 -07003695 }
3696 } catch (NameNotFoundException e) {
3697 // Okay, the target app isn't installed. We can process
3698 // the restore properly only if the dataset provides the
3699 // apk file and we can successfully install it.
3700 if (DEBUG) Slog.i(TAG, "Package " + info.packageName
3701 + " not installed; requiring apk in dataset");
3702 policy = RestorePolicy.ACCEPT_IF_APK;
3703 }
3704
3705 if (policy == RestorePolicy.ACCEPT_IF_APK && !hasApk) {
3706 Slog.i(TAG, "Cannot restore package " + info.packageName
3707 + " without the matching .apk");
3708 }
3709 } else {
3710 Slog.i(TAG, "Missing signature on backed-up package "
3711 + info.packageName);
3712 }
3713 } else {
3714 Slog.i(TAG, "Expected package " + info.packageName
3715 + " but restore manifest claims " + manifestPackage);
3716 }
3717 } else {
3718 Slog.i(TAG, "Unknown restore manifest version " + version
3719 + " for package " + info.packageName);
3720 }
3721 } catch (NumberFormatException e) {
3722 Slog.w(TAG, "Corrupt restore manifest for package " + info.packageName);
Kenny Root11373412011-07-28 15:13:33 -07003723 } catch (IllegalArgumentException e) {
3724 Slog.w(TAG, e.getMessage());
Christopher Tate75a99702011-05-18 16:28:19 -07003725 }
3726
3727 return policy;
3728 }
3729
3730 // Builds a line from a byte buffer starting at 'offset', and returns
3731 // the index of the next unconsumed data in the buffer.
3732 int extractLine(byte[] buffer, int offset, String[] outStr) throws IOException {
3733 final int end = buffer.length;
3734 if (offset >= end) throw new IOException("Incomplete data");
3735
3736 int pos;
3737 for (pos = offset; pos < end; pos++) {
3738 byte c = buffer[pos];
3739 // at LF we declare end of line, and return the next char as the
3740 // starting point for the next time through
3741 if (c == '\n') {
3742 break;
3743 }
3744 }
3745 outStr[0] = new String(buffer, offset, pos - offset);
3746 pos++; // may be pointing an extra byte past the end but that's okay
3747 return pos;
3748 }
3749
3750 void dumpFileMetadata(FileMetadata info) {
3751 if (DEBUG) {
3752 StringBuilder b = new StringBuilder(128);
3753
3754 // mode string
Christopher Tate79ec80d2011-06-24 14:58:49 -07003755 b.append((info.type == BackupAgent.TYPE_DIRECTORY) ? 'd' : '-');
Christopher Tate75a99702011-05-18 16:28:19 -07003756 b.append(((info.mode & 0400) != 0) ? 'r' : '-');
3757 b.append(((info.mode & 0200) != 0) ? 'w' : '-');
3758 b.append(((info.mode & 0100) != 0) ? 'x' : '-');
3759 b.append(((info.mode & 0040) != 0) ? 'r' : '-');
3760 b.append(((info.mode & 0020) != 0) ? 'w' : '-');
3761 b.append(((info.mode & 0010) != 0) ? 'x' : '-');
3762 b.append(((info.mode & 0004) != 0) ? 'r' : '-');
3763 b.append(((info.mode & 0002) != 0) ? 'w' : '-');
3764 b.append(((info.mode & 0001) != 0) ? 'x' : '-');
3765 b.append(String.format(" %9d ", info.size));
3766
3767 Date stamp = new Date(info.mtime);
3768 b.append(new SimpleDateFormat("MMM dd kk:mm:ss ").format(stamp));
3769
3770 b.append(info.packageName);
3771 b.append(" :: ");
3772 b.append(info.domain);
3773 b.append(" :: ");
3774 b.append(info.path);
3775
3776 Slog.i(TAG, b.toString());
3777 }
3778 }
3779 // Consume a tar file header block [sequence] and accumulate the relevant metadata
3780 FileMetadata readTarHeaders(InputStream instream) throws IOException {
3781 byte[] block = new byte[512];
3782 FileMetadata info = null;
3783
3784 boolean gotHeader = readTarHeader(instream, block);
3785 if (gotHeader) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003786 try {
3787 // okay, presume we're okay, and extract the various metadata
3788 info = new FileMetadata();
3789 info.size = extractRadix(block, 124, 12, 8);
3790 info.mtime = extractRadix(block, 136, 12, 8);
3791 info.mode = extractRadix(block, 100, 8, 8);
Christopher Tate75a99702011-05-18 16:28:19 -07003792
Christopher Tate2efd2db2011-07-19 16:32:49 -07003793 info.path = extractString(block, 345, 155); // prefix
3794 String path = extractString(block, 0, 100);
3795 if (path.length() > 0) {
3796 if (info.path.length() > 0) info.path += '/';
3797 info.path += path;
Christopher Tate75a99702011-05-18 16:28:19 -07003798 }
Christopher Tate75a99702011-05-18 16:28:19 -07003799
Christopher Tate2efd2db2011-07-19 16:32:49 -07003800 // tar link indicator field: 1 byte at offset 156 in the header.
3801 int typeChar = block[156];
3802 if (typeChar == 'x') {
3803 // pax extended header, so we need to read that
3804 gotHeader = readPaxExtendedHeader(instream, info);
3805 if (gotHeader) {
3806 // and after a pax extended header comes another real header -- read
3807 // that to find the real file type
3808 gotHeader = readTarHeader(instream, block);
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003809 }
Christopher Tate2efd2db2011-07-19 16:32:49 -07003810 if (!gotHeader) throw new IOException("Bad or missing pax header");
3811
3812 typeChar = block[156];
Christopher Tatee9e78ec2011-06-08 20:09:31 -07003813 }
Christopher Tate75a99702011-05-18 16:28:19 -07003814
Christopher Tate2efd2db2011-07-19 16:32:49 -07003815 switch (typeChar) {
3816 case '0': info.type = BackupAgent.TYPE_FILE; break;
3817 case '5': {
3818 info.type = BackupAgent.TYPE_DIRECTORY;
3819 if (info.size != 0) {
3820 Slog.w(TAG, "Directory entry with nonzero size in header");
3821 info.size = 0;
3822 }
3823 break;
Christopher Tate75a99702011-05-18 16:28:19 -07003824 }
Christopher Tate2efd2db2011-07-19 16:32:49 -07003825 case 0: {
3826 // presume EOF
3827 if (DEBUG) Slog.w(TAG, "Saw type=0 in tar header block, info=" + info);
3828 return null;
3829 }
3830 default: {
3831 Slog.e(TAG, "Unknown tar entity type: " + typeChar);
3832 throw new IOException("Unknown entity type " + typeChar);
3833 }
Christopher Tate75a99702011-05-18 16:28:19 -07003834 }
Christopher Tate2efd2db2011-07-19 16:32:49 -07003835
3836 // Parse out the path
3837 //
3838 // first: apps/shared/unrecognized
3839 if (FullBackup.SHARED_PREFIX.regionMatches(0,
3840 info.path, 0, FullBackup.SHARED_PREFIX.length())) {
3841 // File in shared storage. !!! TODO: implement this.
3842 info.path = info.path.substring(FullBackup.SHARED_PREFIX.length());
Christopher Tate73d73692012-01-20 17:11:31 -08003843 info.packageName = SHARED_BACKUP_AGENT_PACKAGE;
Christopher Tate2efd2db2011-07-19 16:32:49 -07003844 info.domain = FullBackup.SHARED_STORAGE_TOKEN;
3845 if (DEBUG) Slog.i(TAG, "File in shared storage: " + info.path);
3846 } else if (FullBackup.APPS_PREFIX.regionMatches(0,
3847 info.path, 0, FullBackup.APPS_PREFIX.length())) {
3848 // App content! Parse out the package name and domain
3849
3850 // strip the apps/ prefix
3851 info.path = info.path.substring(FullBackup.APPS_PREFIX.length());
3852
3853 // extract the package name
3854 int slash = info.path.indexOf('/');
3855 if (slash < 0) throw new IOException("Illegal semantic path in " + info.path);
3856 info.packageName = info.path.substring(0, slash);
3857 info.path = info.path.substring(slash+1);
3858
3859 // if it's a manifest we're done, otherwise parse out the domains
3860 if (!info.path.equals(BACKUP_MANIFEST_FILENAME)) {
3861 slash = info.path.indexOf('/');
3862 if (slash < 0) throw new IOException("Illegal semantic path in non-manifest " + info.path);
3863 info.domain = info.path.substring(0, slash);
3864 // validate that it's one of the domains we understand
3865 if (!info.domain.equals(FullBackup.APK_TREE_TOKEN)
3866 && !info.domain.equals(FullBackup.DATA_TREE_TOKEN)
3867 && !info.domain.equals(FullBackup.DATABASE_TREE_TOKEN)
3868 && !info.domain.equals(FullBackup.ROOT_TREE_TOKEN)
3869 && !info.domain.equals(FullBackup.SHAREDPREFS_TREE_TOKEN)
3870 && !info.domain.equals(FullBackup.OBB_TREE_TOKEN)
3871 && !info.domain.equals(FullBackup.CACHE_TREE_TOKEN)) {
3872 throw new IOException("Unrecognized domain " + info.domain);
3873 }
3874
3875 info.path = info.path.substring(slash + 1);
3876 }
3877 }
3878 } catch (IOException e) {
3879 if (DEBUG) {
Christopher Tate6853fcf2011-08-10 17:52:21 -07003880 Slog.e(TAG, "Parse error in header: " + e.getMessage());
Christopher Tate2efd2db2011-07-19 16:32:49 -07003881 HEXLOG(block);
3882 }
3883 throw e;
Christopher Tate75a99702011-05-18 16:28:19 -07003884 }
3885 }
3886 return info;
3887 }
3888
Christopher Tate2efd2db2011-07-19 16:32:49 -07003889 private void HEXLOG(byte[] block) {
3890 int offset = 0;
3891 int todo = block.length;
3892 StringBuilder buf = new StringBuilder(64);
3893 while (todo > 0) {
3894 buf.append(String.format("%04x ", offset));
3895 int numThisLine = (todo > 16) ? 16 : todo;
3896 for (int i = 0; i < numThisLine; i++) {
3897 buf.append(String.format("%02x ", block[offset+i]));
3898 }
3899 Slog.i("hexdump", buf.toString());
3900 buf.setLength(0);
3901 todo -= numThisLine;
3902 offset += numThisLine;
Christopher Tate75a99702011-05-18 16:28:19 -07003903 }
Christopher Tate2efd2db2011-07-19 16:32:49 -07003904 }
3905
Christopher Tate6853fcf2011-08-10 17:52:21 -07003906 // Read exactly the given number of bytes into a buffer at the stated offset.
3907 // Returns false if EOF is encountered before the requested number of bytes
3908 // could be read.
3909 int readExactly(InputStream in, byte[] buffer, int offset, int size)
3910 throws IOException {
3911 if (size <= 0) throw new IllegalArgumentException("size must be > 0");
3912
3913 int soFar = 0;
3914 while (soFar < size) {
3915 int nRead = in.read(buffer, offset + soFar, size - soFar);
3916 if (nRead <= 0) {
3917 if (MORE_DEBUG) Slog.w(TAG, "- wanted exactly " + size + " but got only " + soFar);
3918 break;
Christopher Tate2efd2db2011-07-19 16:32:49 -07003919 }
Christopher Tate6853fcf2011-08-10 17:52:21 -07003920 soFar += nRead;
Christopher Tate2efd2db2011-07-19 16:32:49 -07003921 }
Christopher Tate6853fcf2011-08-10 17:52:21 -07003922 return soFar;
3923 }
3924
3925 boolean readTarHeader(InputStream instream, byte[] block) throws IOException {
3926 final int got = readExactly(instream, block, 0, 512);
3927 if (got == 0) return false; // Clean EOF
3928 if (got < 512) throw new IOException("Unable to read full block header");
3929 mBytes += 512;
3930 return true;
Christopher Tate75a99702011-05-18 16:28:19 -07003931 }
3932
3933 // overwrites 'info' fields based on the pax extended header
3934 boolean readPaxExtendedHeader(InputStream instream, FileMetadata info)
3935 throws IOException {
3936 // We should never see a pax extended header larger than this
3937 if (info.size > 32*1024) {
3938 Slog.w(TAG, "Suspiciously large pax header size " + info.size
3939 + " - aborting");
3940 throw new IOException("Sanity failure: pax header size " + info.size);
3941 }
3942
3943 // read whole blocks, not just the content size
3944 int numBlocks = (int)((info.size + 511) >> 9);
3945 byte[] data = new byte[numBlocks * 512];
Christopher Tate6853fcf2011-08-10 17:52:21 -07003946 if (readExactly(instream, data, 0, data.length) < data.length) {
3947 throw new IOException("Unable to read full pax header");
Christopher Tate75a99702011-05-18 16:28:19 -07003948 }
Christopher Tate6853fcf2011-08-10 17:52:21 -07003949 mBytes += data.length;
Christopher Tate75a99702011-05-18 16:28:19 -07003950
3951 final int contentSize = (int) info.size;
3952 int offset = 0;
3953 do {
3954 // extract the line at 'offset'
3955 int eol = offset+1;
3956 while (eol < contentSize && data[eol] != ' ') eol++;
3957 if (eol >= contentSize) {
3958 // error: we just hit EOD looking for the end of the size field
3959 throw new IOException("Invalid pax data");
3960 }
3961 // eol points to the space between the count and the key
3962 int linelen = (int) extractRadix(data, offset, eol - offset, 10);
3963 int key = eol + 1; // start of key=value
3964 eol = offset + linelen - 1; // trailing LF
3965 int value;
3966 for (value = key+1; data[value] != '=' && value <= eol; value++);
3967 if (value > eol) {
3968 throw new IOException("Invalid pax declaration");
3969 }
3970
3971 // pax requires that key/value strings be in UTF-8
3972 String keyStr = new String(data, key, value-key, "UTF-8");
3973 // -1 to strip the trailing LF
3974 String valStr = new String(data, value+1, eol-value-1, "UTF-8");
3975
3976 if ("path".equals(keyStr)) {
3977 info.path = valStr;
3978 } else if ("size".equals(keyStr)) {
3979 info.size = Long.parseLong(valStr);
3980 } else {
3981 if (DEBUG) Slog.i(TAG, "Unhandled pax key: " + key);
3982 }
3983
3984 offset += linelen;
3985 } while (offset < contentSize);
3986
3987 return true;
3988 }
3989
3990 long extractRadix(byte[] data, int offset, int maxChars, int radix)
3991 throws IOException {
3992 long value = 0;
3993 final int end = offset + maxChars;
3994 for (int i = offset; i < end; i++) {
3995 final byte b = data[i];
Christopher Tate3f6c77b2011-06-07 13:17:17 -07003996 // Numeric fields in tar can terminate with either NUL or SPC
Christopher Tate75a99702011-05-18 16:28:19 -07003997 if (b == 0 || b == ' ') break;
3998 if (b < '0' || b > ('0' + radix - 1)) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07003999 throw new IOException("Invalid number in header: '" + (char)b + "' for radix " + radix);
Christopher Tate75a99702011-05-18 16:28:19 -07004000 }
4001 value = radix * value + (b - '0');
4002 }
4003 return value;
4004 }
4005
4006 String extractString(byte[] data, int offset, int maxChars) throws IOException {
4007 final int end = offset + maxChars;
4008 int eos = offset;
Christopher Tate3f6c77b2011-06-07 13:17:17 -07004009 // tar string fields terminate early with a NUL
4010 while (eos < end && data[eos] != 0) eos++;
Christopher Tate75a99702011-05-18 16:28:19 -07004011 return new String(data, offset, eos-offset, "US-ASCII");
4012 }
4013
4014 void sendStartRestore() {
4015 if (mObserver != null) {
4016 try {
4017 mObserver.onStartRestore();
4018 } catch (RemoteException e) {
4019 Slog.w(TAG, "full restore observer went away: startRestore");
4020 mObserver = null;
4021 }
4022 }
4023 }
4024
4025 void sendOnRestorePackage(String name) {
4026 if (mObserver != null) {
4027 try {
4028 // TODO: use a more user-friendly name string
4029 mObserver.onRestorePackage(name);
4030 } catch (RemoteException e) {
4031 Slog.w(TAG, "full restore observer went away: restorePackage");
4032 mObserver = null;
4033 }
4034 }
4035 }
4036
4037 void sendEndRestore() {
4038 if (mObserver != null) {
4039 try {
4040 mObserver.onEndRestore();
4041 } catch (RemoteException e) {
4042 Slog.w(TAG, "full restore observer went away: endRestore");
4043 mObserver = null;
4044 }
4045 }
4046 }
4047 }
4048
Christopher Tatedf01dea2009-06-09 20:45:02 -07004049 // ----- Restore handling -----
4050
Christopher Tate78dd4a72009-11-04 11:49:08 -08004051 private boolean signaturesMatch(Signature[] storedSigs, PackageInfo target) {
4052 // If the target resides on the system partition, we allow it to restore
4053 // data from the like-named package in a restore set even if the signatures
4054 // do not match. (Unlike general applications, those flashed to the system
4055 // partition will be signed with the device's platform certificate, so on
4056 // different phones the same system app will have different signatures.)
4057 if ((target.applicationInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004058 if (DEBUG) Slog.v(TAG, "System app " + target.packageName + " - skipping sig check");
Christopher Tate78dd4a72009-11-04 11:49:08 -08004059 return true;
4060 }
4061
Christopher Tate20efdf6b2009-06-18 19:41:36 -07004062 // Allow unsigned apps, but not signed on one device and unsigned on the other
4063 // !!! TODO: is this the right policy?
Christopher Tate78dd4a72009-11-04 11:49:08 -08004064 Signature[] deviceSigs = target.signatures;
Christopher Tatec58efa62011-08-01 19:20:14 -07004065 if (MORE_DEBUG) Slog.v(TAG, "signaturesMatch(): stored=" + storedSigs
Christopher Tate6aa41f42009-06-19 14:14:22 -07004066 + " device=" + deviceSigs);
Christopher Tate20efdf6b2009-06-18 19:41:36 -07004067 if ((storedSigs == null || storedSigs.length == 0)
4068 && (deviceSigs == null || deviceSigs.length == 0)) {
4069 return true;
4070 }
4071 if (storedSigs == null || deviceSigs == null) {
4072 return false;
4073 }
4074
Christopher Tateabce4e82009-06-18 18:35:32 -07004075 // !!! TODO: this demands that every stored signature match one
4076 // that is present on device, and does not demand the converse.
4077 // Is this this right policy?
4078 int nStored = storedSigs.length;
4079 int nDevice = deviceSigs.length;
4080
4081 for (int i=0; i < nStored; i++) {
4082 boolean match = false;
4083 for (int j=0; j < nDevice; j++) {
4084 if (storedSigs[i].equals(deviceSigs[j])) {
4085 match = true;
4086 break;
4087 }
4088 }
4089 if (!match) {
4090 return false;
4091 }
4092 }
4093 return true;
4094 }
4095
Christopher Tate2982d062011-09-06 20:35:24 -07004096 enum RestoreState {
4097 INITIAL,
4098 DOWNLOAD_DATA,
4099 PM_METADATA,
4100 RUNNING_QUEUE,
4101 FINAL
4102 }
4103
4104 class PerformRestoreTask implements BackupRestoreTask {
Christopher Tatedf01dea2009-06-09 20:45:02 -07004105 private IBackupTransport mTransport;
Christopher Tate7d562ec2009-06-25 18:03:43 -07004106 private IRestoreObserver mObserver;
Dan Egnor156411d2009-06-26 13:20:02 -07004107 private long mToken;
Christopher Tate84725812010-02-04 15:52:40 -08004108 private PackageInfo mTargetPackage;
Christopher Tate5cb400b2009-06-25 16:03:14 -07004109 private File mStateDir;
Christopher Tate1bb69062010-02-19 17:02:12 -08004110 private int mPmToken;
Chris Tate249345b2010-10-29 12:57:04 -07004111 private boolean mNeedFullBackup;
Christopher Tate284f1bb2011-07-07 14:31:18 -07004112 private HashSet<String> mFilterSet;
Christopher Tate2982d062011-09-06 20:35:24 -07004113 private long mStartRealtime;
4114 private PackageManagerBackupAgent mPmAgent;
4115 private List<PackageInfo> mAgentPackages;
4116 private ArrayList<PackageInfo> mRestorePackages;
4117 private RestoreState mCurrentState;
4118 private int mCount;
4119 private boolean mFinished;
4120 private int mStatus;
4121 private File mBackupDataName;
4122 private File mNewStateName;
4123 private File mSavedStateName;
4124 private ParcelFileDescriptor mBackupData;
4125 private ParcelFileDescriptor mNewState;
4126 private PackageInfo mCurrentPackage;
4127
Christopher Tatedf01dea2009-06-09 20:45:02 -07004128
Christopher Tate5cbbf562009-06-22 16:44:51 -07004129 class RestoreRequest {
4130 public PackageInfo app;
4131 public int storedAppVersion;
4132
4133 RestoreRequest(PackageInfo _app, int _version) {
4134 app = _app;
4135 storedAppVersion = _version;
4136 }
4137 }
4138
Christopher Tate44a27902010-01-27 17:15:49 -08004139 PerformRestoreTask(IBackupTransport transport, IRestoreObserver observer,
Chris Tate249345b2010-10-29 12:57:04 -07004140 long restoreSetToken, PackageInfo targetPackage, int pmToken,
Christopher Tate284f1bb2011-07-07 14:31:18 -07004141 boolean needFullBackup, String[] filterSet) {
Christopher Tate2982d062011-09-06 20:35:24 -07004142 mCurrentState = RestoreState.INITIAL;
4143 mFinished = false;
4144 mPmAgent = null;
4145
Christopher Tatedf01dea2009-06-09 20:45:02 -07004146 mTransport = transport;
Christopher Tate7d562ec2009-06-25 18:03:43 -07004147 mObserver = observer;
Christopher Tate9bbc21a2009-06-10 20:23:25 -07004148 mToken = restoreSetToken;
Christopher Tate84725812010-02-04 15:52:40 -08004149 mTargetPackage = targetPackage;
Christopher Tate1bb69062010-02-19 17:02:12 -08004150 mPmToken = pmToken;
Chris Tate249345b2010-10-29 12:57:04 -07004151 mNeedFullBackup = needFullBackup;
Christopher Tate5cb400b2009-06-25 16:03:14 -07004152
Christopher Tate284f1bb2011-07-07 14:31:18 -07004153 if (filterSet != null) {
4154 mFilterSet = new HashSet<String>();
4155 for (String pkg : filterSet) {
4156 mFilterSet.add(pkg);
4157 }
4158 } else {
4159 mFilterSet = null;
4160 }
4161
Christopher Tate5cb400b2009-06-25 16:03:14 -07004162 try {
4163 mStateDir = new File(mBaseStateDir, transport.transportDirName());
4164 } catch (RemoteException e) {
4165 // can't happen; the transport is local
4166 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07004167 }
4168
Christopher Tate2982d062011-09-06 20:35:24 -07004169 // Execute one tick of whatever state machine the task implements
4170 @Override
4171 public void execute() {
4172 if (MORE_DEBUG) Slog.v(TAG, "*** Executing restore step: " + mCurrentState);
4173 switch (mCurrentState) {
4174 case INITIAL:
4175 beginRestore();
4176 break;
Christopher Tatedf01dea2009-06-09 20:45:02 -07004177
Christopher Tate2982d062011-09-06 20:35:24 -07004178 case DOWNLOAD_DATA:
4179 downloadRestoreData();
4180 break;
Christopher Tate7d562ec2009-06-25 18:03:43 -07004181
Christopher Tate2982d062011-09-06 20:35:24 -07004182 case PM_METADATA:
4183 restorePmMetadata();
4184 break;
4185
4186 case RUNNING_QUEUE:
4187 restoreNextAgent();
4188 break;
4189
4190 case FINAL:
4191 if (!mFinished) finalizeRestore();
4192 else {
4193 Slog.e(TAG, "Duplicate finish");
4194 }
4195 mFinished = true;
4196 break;
4197 }
4198 }
4199
4200 // Initialize and set up for the PM metadata restore, which comes first
4201 void beginRestore() {
4202 // Don't account time doing the restore as inactivity of the app
4203 // that has opened a restore session.
4204 mBackupHandler.removeMessages(MSG_RESTORE_TIMEOUT);
4205
4206 // Assume error until we successfully init everything
4207 mStatus = BackupConstants.TRANSPORT_ERROR;
4208
Christopher Tatedf01dea2009-06-09 20:45:02 -07004209 try {
Dan Egnorbb9001c2009-07-27 12:20:13 -07004210 // TODO: Log this before getAvailableRestoreSets, somehow
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004211 EventLog.writeEvent(EventLogTags.RESTORE_START, mTransport.transportDirName(), mToken);
Christopher Tateabce4e82009-06-18 18:35:32 -07004212
Dan Egnorefe52642009-06-24 00:16:33 -07004213 // Get the list of all packages which have backup enabled.
4214 // (Include the Package Manager metadata pseudo-package first.)
Christopher Tate2982d062011-09-06 20:35:24 -07004215 mRestorePackages = new ArrayList<PackageInfo>();
Dan Egnorefe52642009-06-24 00:16:33 -07004216 PackageInfo omPackage = new PackageInfo();
4217 omPackage.packageName = PACKAGE_MANAGER_SENTINEL;
Christopher Tate2982d062011-09-06 20:35:24 -07004218 mRestorePackages.add(omPackage);
Christopher Tatedf01dea2009-06-09 20:45:02 -07004219
Christopher Tate2982d062011-09-06 20:35:24 -07004220 mAgentPackages = allAgentPackages();
Christopher Tate84725812010-02-04 15:52:40 -08004221 if (mTargetPackage == null) {
Christopher Tate284f1bb2011-07-07 14:31:18 -07004222 // if there's a filter set, strip out anything that isn't
4223 // present before proceeding
4224 if (mFilterSet != null) {
Christopher Tate2982d062011-09-06 20:35:24 -07004225 for (int i = mAgentPackages.size() - 1; i >= 0; i--) {
4226 final PackageInfo pkg = mAgentPackages.get(i);
Christopher Tate284f1bb2011-07-07 14:31:18 -07004227 if (! mFilterSet.contains(pkg.packageName)) {
Christopher Tate2982d062011-09-06 20:35:24 -07004228 mAgentPackages.remove(i);
Christopher Tate284f1bb2011-07-07 14:31:18 -07004229 }
4230 }
Christopher Tate2982d062011-09-06 20:35:24 -07004231 if (MORE_DEBUG) {
Christopher Tate284f1bb2011-07-07 14:31:18 -07004232 Slog.i(TAG, "Post-filter package set for restore:");
Christopher Tate2982d062011-09-06 20:35:24 -07004233 for (PackageInfo p : mAgentPackages) {
Christopher Tate284f1bb2011-07-07 14:31:18 -07004234 Slog.i(TAG, " " + p);
4235 }
4236 }
4237 }
Christopher Tate2982d062011-09-06 20:35:24 -07004238 mRestorePackages.addAll(mAgentPackages);
Christopher Tate84725812010-02-04 15:52:40 -08004239 } else {
4240 // Just one package to attempt restore of
Christopher Tate2982d062011-09-06 20:35:24 -07004241 mRestorePackages.add(mTargetPackage);
Christopher Tate84725812010-02-04 15:52:40 -08004242 }
Dan Egnorefe52642009-06-24 00:16:33 -07004243
Christopher Tate7d562ec2009-06-25 18:03:43 -07004244 // let the observer know that we're running
4245 if (mObserver != null) {
4246 try {
4247 // !!! TODO: get an actual count from the transport after
4248 // its startRestore() runs?
Christopher Tate2982d062011-09-06 20:35:24 -07004249 mObserver.restoreStarting(mRestorePackages.size());
Christopher Tate7d562ec2009-06-25 18:03:43 -07004250 } catch (RemoteException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004251 Slog.d(TAG, "Restore observer died at restoreStarting");
Christopher Tate7d562ec2009-06-25 18:03:43 -07004252 mObserver = null;
4253 }
4254 }
Christopher Tate2982d062011-09-06 20:35:24 -07004255 } catch (RemoteException e) {
4256 // Something has gone catastrophically wrong with the transport
4257 Slog.e(TAG, "Error communicating with transport for restore");
4258 executeNextState(RestoreState.FINAL);
4259 return;
4260 }
Christopher Tate7d562ec2009-06-25 18:03:43 -07004261
Christopher Tate2982d062011-09-06 20:35:24 -07004262 mStatus = BackupConstants.TRANSPORT_OK;
4263 executeNextState(RestoreState.DOWNLOAD_DATA);
4264 }
4265
4266 void downloadRestoreData() {
4267 // Note that the download phase can be very time consuming, but we're executing
4268 // it inline here on the looper. This is "okay" because it is not calling out to
4269 // third party code; the transport is "trusted," and so we assume it is being a
4270 // good citizen and timing out etc when appropriate.
4271 //
4272 // TODO: when appropriate, move the download off the looper and rearrange the
4273 // error handling around that.
4274 try {
4275 mStatus = mTransport.startRestore(mToken,
4276 mRestorePackages.toArray(new PackageInfo[0]));
4277 if (mStatus != BackupConstants.TRANSPORT_OK) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004278 Slog.e(TAG, "Error starting restore operation");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004279 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Christopher Tate2982d062011-09-06 20:35:24 -07004280 executeNextState(RestoreState.FINAL);
Dan Egnorefe52642009-06-24 00:16:33 -07004281 return;
4282 }
Christopher Tate2982d062011-09-06 20:35:24 -07004283 } catch (RemoteException e) {
4284 Slog.e(TAG, "Error communicating with transport for restore");
4285 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
4286 mStatus = BackupConstants.TRANSPORT_ERROR;
4287 executeNextState(RestoreState.FINAL);
4288 return;
4289 }
Dan Egnorefe52642009-06-24 00:16:33 -07004290
Christopher Tate2982d062011-09-06 20:35:24 -07004291 // Successful download of the data to be parceled out to the apps, so off we go.
4292 executeNextState(RestoreState.PM_METADATA);
4293 }
4294
4295 void restorePmMetadata() {
4296 try {
Dan Egnorefe52642009-06-24 00:16:33 -07004297 String packageName = mTransport.nextRestorePackage();
4298 if (packageName == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004299 Slog.e(TAG, "Error getting first restore package");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004300 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Christopher Tate2982d062011-09-06 20:35:24 -07004301 mStatus = BackupConstants.TRANSPORT_ERROR;
4302 executeNextState(RestoreState.FINAL);
Dan Egnorefe52642009-06-24 00:16:33 -07004303 return;
4304 } else if (packageName.equals("")) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004305 Slog.i(TAG, "No restore data available");
Christopher Tate2982d062011-09-06 20:35:24 -07004306 int millis = (int) (SystemClock.elapsedRealtime() - mStartRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004307 EventLog.writeEvent(EventLogTags.RESTORE_SUCCESS, 0, millis);
Christopher Tate2982d062011-09-06 20:35:24 -07004308 mStatus = BackupConstants.TRANSPORT_OK;
4309 executeNextState(RestoreState.FINAL);
Dan Egnorefe52642009-06-24 00:16:33 -07004310 return;
4311 } else if (!packageName.equals(PACKAGE_MANAGER_SENTINEL)) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004312 Slog.e(TAG, "Expected restore data for \"" + PACKAGE_MANAGER_SENTINEL
Christopher Tate2982d062011-09-06 20:35:24 -07004313 + "\", found only \"" + packageName + "\"");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004314 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, PACKAGE_MANAGER_SENTINEL,
Dan Egnorbb9001c2009-07-27 12:20:13 -07004315 "Package manager data missing");
Christopher Tate2982d062011-09-06 20:35:24 -07004316 executeNextState(RestoreState.FINAL);
Dan Egnorefe52642009-06-24 00:16:33 -07004317 return;
4318 }
4319
4320 // Pull the Package Manager metadata from the restore set first
Christopher Tate2982d062011-09-06 20:35:24 -07004321 PackageInfo omPackage = new PackageInfo();
4322 omPackage.packageName = PACKAGE_MANAGER_SENTINEL;
4323 mPmAgent = new PackageManagerBackupAgent(
4324 mPackageManager, mAgentPackages);
4325 initiateOneRestore(omPackage, 0, IBackupAgent.Stub.asInterface(mPmAgent.onBind()),
Chris Tate249345b2010-10-29 12:57:04 -07004326 mNeedFullBackup);
Christopher Tate2982d062011-09-06 20:35:24 -07004327 // The PM agent called operationComplete() already, because our invocation
4328 // of it is process-local and therefore synchronous. That means that a
4329 // RUNNING_QUEUE message is already enqueued. Only if we're unable to
4330 // proceed with running the queue do we remove that pending message and
4331 // jump straight to the FINAL state.
Dan Egnorefe52642009-06-24 00:16:33 -07004332
Christopher Tate8c032472009-07-02 14:28:47 -07004333 // Verify that the backup set includes metadata. If not, we can't do
4334 // signature/version verification etc, so we simply do not proceed with
4335 // the restore operation.
Christopher Tate2982d062011-09-06 20:35:24 -07004336 if (!mPmAgent.hasMetadata()) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004337 Slog.e(TAG, "No restore metadata available, so not restoring settings");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004338 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, PACKAGE_MANAGER_SENTINEL,
Christopher Tate2982d062011-09-06 20:35:24 -07004339 "Package manager restore metadata missing");
4340 mStatus = BackupConstants.TRANSPORT_ERROR;
4341 mBackupHandler.removeMessages(MSG_BACKUP_RESTORE_STEP, this);
4342 executeNextState(RestoreState.FINAL);
Christopher Tate8c032472009-07-02 14:28:47 -07004343 return;
4344 }
Christopher Tate2982d062011-09-06 20:35:24 -07004345 } catch (RemoteException e) {
4346 Slog.e(TAG, "Error communicating with transport for restore");
4347 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
4348 mStatus = BackupConstants.TRANSPORT_ERROR;
4349 mBackupHandler.removeMessages(MSG_BACKUP_RESTORE_STEP, this);
4350 executeNextState(RestoreState.FINAL);
4351 return;
4352 }
Christopher Tate8c032472009-07-02 14:28:47 -07004353
Christopher Tate2982d062011-09-06 20:35:24 -07004354 // Metadata is intact, so we can now run the restore queue. If we get here,
4355 // we have already enqueued the necessary next-step message on the looper.
4356 }
Dan Egnorbb9001c2009-07-27 12:20:13 -07004357
Christopher Tate2982d062011-09-06 20:35:24 -07004358 void restoreNextAgent() {
4359 try {
4360 String packageName = mTransport.nextRestorePackage();
Christopher Tatedf01dea2009-06-09 20:45:02 -07004361
Christopher Tate2982d062011-09-06 20:35:24 -07004362 if (packageName == null) {
4363 Slog.e(TAG, "Error getting next restore package");
4364 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
4365 executeNextState(RestoreState.FINAL);
4366 return;
4367 } else if (packageName.equals("")) {
4368 if (DEBUG) Slog.v(TAG, "No next package, finishing restore");
4369 int millis = (int) (SystemClock.elapsedRealtime() - mStartRealtime);
4370 EventLog.writeEvent(EventLogTags.RESTORE_SUCCESS, mCount, millis);
4371 executeNextState(RestoreState.FINAL);
4372 return;
Dan Egnorefe52642009-06-24 00:16:33 -07004373 }
Christopher Tate7d562ec2009-06-25 18:03:43 -07004374
4375 if (mObserver != null) {
4376 try {
Christopher Tate2982d062011-09-06 20:35:24 -07004377 mObserver.onUpdate(mCount, packageName);
Christopher Tate7d562ec2009-06-25 18:03:43 -07004378 } catch (RemoteException e) {
Christopher Tate2982d062011-09-06 20:35:24 -07004379 Slog.d(TAG, "Restore observer died in onUpdate");
4380 mObserver = null;
Christopher Tate7d562ec2009-06-25 18:03:43 -07004381 }
4382 }
Christopher Tateb6787f22009-07-02 17:40:45 -07004383
Christopher Tate2982d062011-09-06 20:35:24 -07004384 Metadata metaInfo = mPmAgent.getRestoredMetadata(packageName);
4385 if (metaInfo == null) {
4386 Slog.e(TAG, "Missing metadata for " + packageName);
4387 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
4388 "Package metadata missing");
4389 executeNextState(RestoreState.RUNNING_QUEUE);
4390 return;
Christopher Tate84725812010-02-04 15:52:40 -08004391 }
4392
Christopher Tate2982d062011-09-06 20:35:24 -07004393 PackageInfo packageInfo;
4394 try {
4395 int flags = PackageManager.GET_SIGNATURES;
4396 packageInfo = mPackageManager.getPackageInfo(packageName, flags);
4397 } catch (NameNotFoundException e) {
4398 Slog.e(TAG, "Invalid package restoring data", e);
4399 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
4400 "Package missing on device");
4401 executeNextState(RestoreState.RUNNING_QUEUE);
4402 return;
Christopher Tate1bb69062010-02-19 17:02:12 -08004403 }
4404
Christopher Tate2982d062011-09-06 20:35:24 -07004405 if (metaInfo.versionCode > packageInfo.versionCode) {
4406 // Data is from a "newer" version of the app than we have currently
4407 // installed. If the app has not declared that it is prepared to
4408 // handle this case, we do not attempt the restore.
4409 if ((packageInfo.applicationInfo.flags
4410 & ApplicationInfo.FLAG_RESTORE_ANY_VERSION) == 0) {
4411 String message = "Version " + metaInfo.versionCode
4412 + " > installed version " + packageInfo.versionCode;
4413 Slog.w(TAG, "Package " + packageName + ": " + message);
4414 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE,
4415 packageName, message);
4416 executeNextState(RestoreState.RUNNING_QUEUE);
4417 return;
4418 } else {
4419 if (DEBUG) Slog.v(TAG, "Version " + metaInfo.versionCode
4420 + " > installed " + packageInfo.versionCode
4421 + " but restoreAnyVersion");
4422 }
4423 }
Christopher Tate73a3cb32010-12-13 18:27:26 -08004424
Christopher Tate2982d062011-09-06 20:35:24 -07004425 if (!signaturesMatch(metaInfo.signatures, packageInfo)) {
4426 Slog.w(TAG, "Signature mismatch restoring " + packageName);
4427 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
4428 "Signature mismatch");
4429 executeNextState(RestoreState.RUNNING_QUEUE);
4430 return;
4431 }
4432
4433 if (DEBUG) Slog.v(TAG, "Package " + packageName
4434 + " restore version [" + metaInfo.versionCode
4435 + "] is compatible with installed version ["
4436 + packageInfo.versionCode + "]");
4437
4438 // Then set up and bind the agent
4439 IBackupAgent agent = bindToAgentSynchronous(
4440 packageInfo.applicationInfo,
4441 IApplicationThread.BACKUP_MODE_INCREMENTAL);
4442 if (agent == null) {
4443 Slog.w(TAG, "Can't find backup agent for " + packageName);
4444 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName,
4445 "Restore agent missing");
4446 executeNextState(RestoreState.RUNNING_QUEUE);
4447 return;
4448 }
4449
4450 // And then finally start the restore on this agent
4451 try {
4452 initiateOneRestore(packageInfo, metaInfo.versionCode, agent, mNeedFullBackup);
4453 ++mCount;
4454 } catch (Exception e) {
4455 Slog.e(TAG, "Error when attempting restore: " + e.toString());
4456 agentErrorCleanup();
4457 executeNextState(RestoreState.RUNNING_QUEUE);
4458 }
4459 } catch (RemoteException e) {
4460 Slog.e(TAG, "Unable to fetch restore data from transport");
4461 mStatus = BackupConstants.TRANSPORT_ERROR;
4462 executeNextState(RestoreState.FINAL);
Christopher Tatedf01dea2009-06-09 20:45:02 -07004463 }
4464 }
4465
Christopher Tate2982d062011-09-06 20:35:24 -07004466 void finalizeRestore() {
4467 if (MORE_DEBUG) Slog.d(TAG, "finishing restore mObserver=" + mObserver);
4468
4469 try {
4470 mTransport.finishRestore();
4471 } catch (RemoteException e) {
4472 Slog.e(TAG, "Error finishing restore", e);
4473 }
4474
4475 if (mObserver != null) {
4476 try {
4477 mObserver.restoreFinished(mStatus);
4478 } catch (RemoteException e) {
4479 Slog.d(TAG, "Restore observer died at restoreFinished");
4480 }
4481 }
4482
4483 // If this was a restoreAll operation, record that this was our
4484 // ancestral dataset, as well as the set of apps that are possibly
4485 // restoreable from the dataset
4486 if (mTargetPackage == null && mPmAgent != null) {
4487 mAncestralPackages = mPmAgent.getRestoredPackages();
4488 mAncestralToken = mToken;
4489 writeRestoreTokens();
4490 }
4491
4492 // We must under all circumstances tell the Package Manager to
4493 // proceed with install notifications if it's waiting for us.
4494 if (mPmToken > 0) {
4495 if (MORE_DEBUG) Slog.v(TAG, "finishing PM token " + mPmToken);
4496 try {
4497 mPackageManagerBinder.finishPackageInstall(mPmToken);
4498 } catch (RemoteException e) { /* can't happen */ }
4499 }
4500
4501 // Furthermore we need to reset the session timeout clock
4502 mBackupHandler.removeMessages(MSG_RESTORE_TIMEOUT);
4503 mBackupHandler.sendEmptyMessageDelayed(MSG_RESTORE_TIMEOUT,
4504 TIMEOUT_RESTORE_INTERVAL);
4505
4506 // done; we can finally release the wakelock
4507 Slog.i(TAG, "Restore complete.");
4508 mWakelock.release();
4509 }
4510
4511 // Call asynchronously into the app, passing it the restore data. The next step
4512 // after this is always a callback, either operationComplete() or handleTimeout().
4513 void initiateOneRestore(PackageInfo app, int appVersionCode, IBackupAgent agent,
Chris Tate249345b2010-10-29 12:57:04 -07004514 boolean needFullBackup) {
Christopher Tate2982d062011-09-06 20:35:24 -07004515 mCurrentPackage = app;
Christopher Tatec7b31e32009-06-10 15:49:30 -07004516 final String packageName = app.packageName;
4517
Christopher Tate2982d062011-09-06 20:35:24 -07004518 if (DEBUG) Slog.d(TAG, "initiateOneRestore packageName=" + packageName);
Joe Onorato9a5e3e12009-07-01 21:04:03 -04004519
Christopher Tatec7b31e32009-06-10 15:49:30 -07004520 // !!! TODO: get the dirs from the transport
Christopher Tate2982d062011-09-06 20:35:24 -07004521 mBackupDataName = new File(mDataDir, packageName + ".restore");
4522 mNewStateName = new File(mStateDir, packageName + ".new");
4523 mSavedStateName = new File(mStateDir, packageName);
Dan Egnorbb9001c2009-07-27 12:20:13 -07004524
Christopher Tate4a627c72011-04-01 14:43:32 -07004525 final int token = generateToken();
Dan Egnorbb9001c2009-07-27 12:20:13 -07004526 try {
Christopher Tatec7b31e32009-06-10 15:49:30 -07004527 // Run the transport's restore pass
Christopher Tate2982d062011-09-06 20:35:24 -07004528 mBackupData = ParcelFileDescriptor.open(mBackupDataName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07004529 ParcelFileDescriptor.MODE_READ_WRITE |
4530 ParcelFileDescriptor.MODE_CREATE |
4531 ParcelFileDescriptor.MODE_TRUNCATE);
4532
Christopher Tate2982d062011-09-06 20:35:24 -07004533 if (mTransport.getRestoreData(mBackupData) != BackupConstants.TRANSPORT_OK) {
Christopher Tate5f2f4132011-09-26 13:10:38 -07004534 // Transport-level failure, so we wind everything up and
4535 // terminate the restore operation.
Joe Onorato8a9b2202010-02-26 18:56:32 -08004536 Slog.e(TAG, "Error getting restore data for " + packageName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004537 EventLog.writeEvent(EventLogTags.RESTORE_TRANSPORT_FAILURE);
Christopher Tate5f2f4132011-09-26 13:10:38 -07004538 mBackupData.close();
4539 mBackupDataName.delete();
4540 executeNextState(RestoreState.FINAL);
Dan Egnorbb9001c2009-07-27 12:20:13 -07004541 return;
Christopher Tatec7b31e32009-06-10 15:49:30 -07004542 }
4543
4544 // Okay, we have the data. Now have the agent do the restore.
Christopher Tate2982d062011-09-06 20:35:24 -07004545 mBackupData.close();
4546 mBackupData = ParcelFileDescriptor.open(mBackupDataName,
Christopher Tatec7b31e32009-06-10 15:49:30 -07004547 ParcelFileDescriptor.MODE_READ_ONLY);
4548
Christopher Tate2982d062011-09-06 20:35:24 -07004549 mNewState = ParcelFileDescriptor.open(mNewStateName,
Dan Egnorbb9001c2009-07-27 12:20:13 -07004550 ParcelFileDescriptor.MODE_READ_WRITE |
4551 ParcelFileDescriptor.MODE_CREATE |
4552 ParcelFileDescriptor.MODE_TRUNCATE);
4553
Christopher Tate44a27902010-01-27 17:15:49 -08004554 // Kick off the restore, checking for hung agents
Christopher Tate2982d062011-09-06 20:35:24 -07004555 prepareOperationTimeout(token, TIMEOUT_RESTORE_INTERVAL, this);
4556 agent.doRestore(mBackupData, appVersionCode, mNewState, token, mBackupManagerBinder);
Christopher Tatec7b31e32009-06-10 15:49:30 -07004557 } catch (Exception e) {
Christopher Tate2982d062011-09-06 20:35:24 -07004558 Slog.e(TAG, "Unable to call app for restore: " + packageName, e);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004559 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE, packageName, e.toString());
Christopher Tate2982d062011-09-06 20:35:24 -07004560 agentErrorCleanup(); // clears any pending timeout messages as well
Dan Egnorbb9001c2009-07-27 12:20:13 -07004561
Christopher Tate2982d062011-09-06 20:35:24 -07004562 // After a restore failure we go back to running the queue. If there
4563 // are no more packages to be restored that will be handled by the
4564 // next step.
4565 executeNextState(RestoreState.RUNNING_QUEUE);
4566 }
4567 }
Chris Tate249345b2010-10-29 12:57:04 -07004568
Christopher Tate2982d062011-09-06 20:35:24 -07004569 void agentErrorCleanup() {
4570 // If the agent fails restore, it might have put the app's data
4571 // into an incoherent state. For consistency we wipe its data
4572 // again in this case before continuing with normal teardown
4573 clearApplicationDataSynchronous(mCurrentPackage.packageName);
4574 agentCleanup();
4575 }
4576
4577 void agentCleanup() {
4578 mBackupDataName.delete();
4579 try { if (mBackupData != null) mBackupData.close(); } catch (IOException e) {}
4580 try { if (mNewState != null) mNewState.close(); } catch (IOException e) {}
4581 mBackupData = mNewState = null;
4582
4583 // if everything went okay, remember the recorded state now
4584 //
4585 // !!! TODO: the restored data should be migrated on the server
4586 // side into the current dataset. In that case the new state file
4587 // we just created would reflect the data already extant in the
4588 // backend, so there'd be nothing more to do. Until that happens,
4589 // however, we need to make sure that we record the data to the
4590 // current backend dataset. (Yes, this means shipping the data over
4591 // the wire in both directions. That's bad, but consistency comes
4592 // first, then efficiency.) Once we introduce server-side data
4593 // migration to the newly-restored device's dataset, we will change
4594 // the following from a discard of the newly-written state to the
4595 // "correct" operation of renaming into the canonical state blob.
4596 mNewStateName.delete(); // TODO: remove; see above comment
4597 //mNewStateName.renameTo(mSavedStateName); // TODO: replace with this
4598
4599 // If this wasn't the PM pseudopackage, tear down the agent side
4600 if (mCurrentPackage.applicationInfo != null) {
4601 // unbind and tidy up even on timeout or failure
4602 try {
4603 mActivityManager.unbindBackupAgent(mCurrentPackage.applicationInfo);
4604
4605 // The agent was probably running with a stub Application object,
4606 // which isn't a valid run mode for the main app logic. Shut
4607 // down the app so that next time it's launched, it gets the
4608 // usual full initialization. Note that this is only done for
4609 // full-system restores: when a single app has requested a restore,
4610 // it is explicitly not killed following that operation.
4611 if (mTargetPackage == null && (mCurrentPackage.applicationInfo.flags
4612 & ApplicationInfo.FLAG_KILL_AFTER_RESTORE) != 0) {
4613 if (DEBUG) Slog.d(TAG, "Restore complete, killing host process of "
4614 + mCurrentPackage.applicationInfo.processName);
4615 mActivityManager.killApplicationProcess(
4616 mCurrentPackage.applicationInfo.processName,
4617 mCurrentPackage.applicationInfo.uid);
4618 }
4619 } catch (RemoteException e) {
4620 // can't happen; we run in the same process as the activity manager
Chris Tate249345b2010-10-29 12:57:04 -07004621 }
Christopher Tatec7b31e32009-06-10 15:49:30 -07004622 }
Christopher Tate2982d062011-09-06 20:35:24 -07004623
4624 // The caller is responsible for reestablishing the state machine; our
4625 // responsibility here is to clear the decks for whatever comes next.
4626 mBackupHandler.removeMessages(MSG_TIMEOUT, this);
4627 synchronized (mCurrentOpLock) {
4628 mCurrentOperations.clear();
4629 }
4630 }
4631
4632 // A call to agent.doRestore() has been positively acknowledged as complete
4633 @Override
4634 public void operationComplete() {
4635 int size = (int) mBackupDataName.length();
4636 EventLog.writeEvent(EventLogTags.RESTORE_PACKAGE, mCurrentPackage.packageName, size);
4637 // Just go back to running the restore queue
4638 agentCleanup();
4639
4640 executeNextState(RestoreState.RUNNING_QUEUE);
4641 }
4642
4643 // A call to agent.doRestore() has timed out
4644 @Override
4645 public void handleTimeout() {
4646 Slog.e(TAG, "Timeout restoring application " + mCurrentPackage.packageName);
4647 EventLog.writeEvent(EventLogTags.RESTORE_AGENT_FAILURE,
4648 mCurrentPackage.packageName, "restore timeout");
4649 // Handle like an agent that threw on invocation: wipe it and go on to the next
4650 agentErrorCleanup();
4651 executeNextState(RestoreState.RUNNING_QUEUE);
4652 }
4653
4654 void executeNextState(RestoreState nextState) {
4655 if (MORE_DEBUG) Slog.i(TAG, " => executing next step on "
4656 + this + " nextState=" + nextState);
4657 mCurrentState = nextState;
4658 Message msg = mBackupHandler.obtainMessage(MSG_BACKUP_RESTORE_STEP, this);
4659 mBackupHandler.sendMessage(msg);
Christopher Tatedf01dea2009-06-09 20:45:02 -07004660 }
4661 }
4662
Christopher Tate44a27902010-01-27 17:15:49 -08004663 class PerformClearTask implements Runnable {
Christopher Tateee0e78a2009-07-02 11:17:03 -07004664 IBackupTransport mTransport;
4665 PackageInfo mPackage;
4666
Christopher Tate44a27902010-01-27 17:15:49 -08004667 PerformClearTask(IBackupTransport transport, PackageInfo packageInfo) {
Christopher Tateee0e78a2009-07-02 11:17:03 -07004668 mTransport = transport;
4669 mPackage = packageInfo;
4670 }
4671
Christopher Tateee0e78a2009-07-02 11:17:03 -07004672 public void run() {
4673 try {
4674 // Clear the on-device backup state to ensure a full backup next time
4675 File stateDir = new File(mBaseStateDir, mTransport.transportDirName());
4676 File stateFile = new File(stateDir, mPackage.packageName);
4677 stateFile.delete();
4678
4679 // Tell the transport to remove all the persistent storage for the app
Christopher Tate13f4a642009-09-30 20:06:45 -07004680 // TODO - need to handle failures
Christopher Tateee0e78a2009-07-02 11:17:03 -07004681 mTransport.clearBackupData(mPackage);
4682 } catch (RemoteException e) {
4683 // can't happen; the transport is local
4684 } finally {
4685 try {
Christopher Tate13f4a642009-09-30 20:06:45 -07004686 // TODO - need to handle failures
Christopher Tateee0e78a2009-07-02 11:17:03 -07004687 mTransport.finishBackup();
4688 } catch (RemoteException e) {
4689 // can't happen; the transport is local
4690 }
Christopher Tateb6787f22009-07-02 17:40:45 -07004691
4692 // Last but not least, release the cpu
4693 mWakelock.release();
Christopher Tateee0e78a2009-07-02 11:17:03 -07004694 }
4695 }
4696 }
4697
Christopher Tate44a27902010-01-27 17:15:49 -08004698 class PerformInitializeTask implements Runnable {
Christopher Tate4cc86e12009-09-21 19:36:51 -07004699 HashSet<String> mQueue;
4700
Christopher Tate44a27902010-01-27 17:15:49 -08004701 PerformInitializeTask(HashSet<String> transportNames) {
Christopher Tate4cc86e12009-09-21 19:36:51 -07004702 mQueue = transportNames;
4703 }
4704
Christopher Tate4cc86e12009-09-21 19:36:51 -07004705 public void run() {
Christopher Tate4cc86e12009-09-21 19:36:51 -07004706 try {
4707 for (String transportName : mQueue) {
4708 IBackupTransport transport = getTransport(transportName);
4709 if (transport == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004710 Slog.e(TAG, "Requested init for " + transportName + " but not found");
Christopher Tate4cc86e12009-09-21 19:36:51 -07004711 continue;
4712 }
4713
Joe Onorato8a9b2202010-02-26 18:56:32 -08004714 Slog.i(TAG, "Initializing (wiping) backup transport storage: " + transportName);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004715 EventLog.writeEvent(EventLogTags.BACKUP_START, transport.transportDirName());
Dan Egnor726247c2009-09-29 19:12:31 -07004716 long startRealtime = SystemClock.elapsedRealtime();
4717 int status = transport.initializeDevice();
Christopher Tate4cc86e12009-09-21 19:36:51 -07004718
Christopher Tate4cc86e12009-09-21 19:36:51 -07004719 if (status == BackupConstants.TRANSPORT_OK) {
4720 status = transport.finishBackup();
4721 }
4722
4723 // Okay, the wipe really happened. Clean up our local bookkeeping.
4724 if (status == BackupConstants.TRANSPORT_OK) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004725 Slog.i(TAG, "Device init successful");
Dan Egnor726247c2009-09-29 19:12:31 -07004726 int millis = (int) (SystemClock.elapsedRealtime() - startRealtime);
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004727 EventLog.writeEvent(EventLogTags.BACKUP_INITIALIZE);
Dan Egnor726247c2009-09-29 19:12:31 -07004728 resetBackupState(new File(mBaseStateDir, transport.transportDirName()));
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004729 EventLog.writeEvent(EventLogTags.BACKUP_SUCCESS, 0, millis);
Christopher Tate4cc86e12009-09-21 19:36:51 -07004730 synchronized (mQueueLock) {
4731 recordInitPendingLocked(false, transportName);
4732 }
Dan Egnor726247c2009-09-29 19:12:31 -07004733 } else {
4734 // If this didn't work, requeue this one and try again
4735 // after a suitable interval
Joe Onorato8a9b2202010-02-26 18:56:32 -08004736 Slog.e(TAG, "Transport error in initializeDevice()");
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004737 EventLog.writeEvent(EventLogTags.BACKUP_TRANSPORT_FAILURE, "(initialize)");
Christopher Tate4cc86e12009-09-21 19:36:51 -07004738 synchronized (mQueueLock) {
4739 recordInitPendingLocked(true, transportName);
4740 }
4741 // do this via another alarm to make sure of the wakelock states
4742 long delay = transport.requestBackupTime();
Joe Onorato8a9b2202010-02-26 18:56:32 -08004743 if (DEBUG) Slog.w(TAG, "init failed on "
Christopher Tate4cc86e12009-09-21 19:36:51 -07004744 + transportName + " resched in " + delay);
4745 mAlarmManager.set(AlarmManager.RTC_WAKEUP,
4746 System.currentTimeMillis() + delay, mRunInitIntent);
Christopher Tate4cc86e12009-09-21 19:36:51 -07004747 }
Christopher Tate4cc86e12009-09-21 19:36:51 -07004748 }
4749 } catch (RemoteException e) {
4750 // can't happen; the transports are local
4751 } catch (Exception e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004752 Slog.e(TAG, "Unexpected error performing init", e);
Christopher Tate4cc86e12009-09-21 19:36:51 -07004753 } finally {
Christopher Tatec2af5d32010-02-02 15:18:58 -08004754 // Done; release the wakelock
Christopher Tate4cc86e12009-09-21 19:36:51 -07004755 mWakelock.release();
4756 }
4757 }
4758 }
4759
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004760 private void dataChangedImpl(String packageName) {
4761 HashSet<ApplicationInfo> targets = dataChangedTargets(packageName);
4762 dataChangedImpl(packageName, targets);
4763 }
Christopher Tatedf01dea2009-06-09 20:45:02 -07004764
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004765 private void dataChangedImpl(String packageName, HashSet<ApplicationInfo> targets) {
Christopher Tate487529a2009-04-29 14:03:25 -07004766 // Record that we need a backup pass for the caller. Since multiple callers
4767 // may share a uid, we need to note all candidates within that uid and schedule
4768 // a backup pass for each of them.
Doug Zongkerab5c49c2009-12-04 10:31:43 -08004769 EventLog.writeEvent(EventLogTags.BACKUP_DATA_CHANGED, packageName);
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07004770
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004771 if (targets == null) {
4772 Slog.w(TAG, "dataChanged but no participant pkg='" + packageName + "'"
4773 + " uid=" + Binder.getCallingUid());
4774 return;
4775 }
4776
4777 synchronized (mQueueLock) {
4778 // Note that this client has made data changes that need to be backed up
4779 for (ApplicationInfo app : targets) {
4780 // validate the caller-supplied package name against the known set of
4781 // packages associated with this uid
4782 if (app.packageName.equals(packageName)) {
4783 // Add the caller to the set of pending backups. If there is
4784 // one already there, then overwrite it, but no harm done.
Christopher Tatecc55f812011-08-16 16:06:53 -07004785 BackupRequest req = new BackupRequest(packageName);
Christopher Tatec28083a2010-12-14 16:16:44 -08004786 if (mPendingBackups.put(app.packageName, req) == null) {
Christopher Tate6de74ff2012-01-17 15:20:32 -08004787 if (DEBUG) Slog.d(TAG, "Now staging backup of " + packageName);
4788
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004789 // Journal this request in case of crash. The put()
4790 // operation returned null when this package was not already
4791 // in the set; we want to avoid touching the disk redundantly.
4792 writeToJournalLocked(packageName);
4793
Christopher Tatec58efa62011-08-01 19:20:14 -07004794 if (MORE_DEBUG) {
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004795 int numKeys = mPendingBackups.size();
4796 Slog.d(TAG, "Now awaiting backup for " + numKeys + " participants:");
4797 for (BackupRequest b : mPendingBackups.values()) {
Christopher Tatecc55f812011-08-16 16:06:53 -07004798 Slog.d(TAG, " + " + b);
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004799 }
4800 }
4801 }
4802 }
4803 }
4804 }
4805 }
4806
4807 // Note: packageName is currently unused, but may be in the future
4808 private HashSet<ApplicationInfo> dataChangedTargets(String packageName) {
Christopher Tate63d27002009-06-16 17:16:42 -07004809 // If the caller does not hold the BACKUP permission, it can only request a
4810 // backup of its own data.
Dianne Hackborncf098292009-07-01 19:55:20 -07004811 if ((mContext.checkPermission(android.Manifest.permission.BACKUP, Binder.getCallingPid(),
Christopher Tate63d27002009-06-16 17:16:42 -07004812 Binder.getCallingUid())) == PackageManager.PERMISSION_DENIED) {
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004813 synchronized (mBackupParticipants) {
4814 return mBackupParticipants.get(Binder.getCallingUid());
4815 }
4816 }
4817
4818 // a caller with full permission can ask to back up any participating app
4819 // !!! TODO: allow backup of ANY app?
4820 HashSet<ApplicationInfo> targets = new HashSet<ApplicationInfo>();
4821 synchronized (mBackupParticipants) {
Christopher Tate63d27002009-06-16 17:16:42 -07004822 int N = mBackupParticipants.size();
4823 for (int i = 0; i < N; i++) {
4824 HashSet<ApplicationInfo> s = mBackupParticipants.valueAt(i);
4825 if (s != null) {
4826 targets.addAll(s);
4827 }
4828 }
4829 }
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004830 return targets;
Christopher Tate487529a2009-04-29 14:03:25 -07004831 }
Christopher Tate46758122009-05-06 11:22:00 -07004832
Christopher Tatecde87f42009-06-12 12:55:53 -07004833 private void writeToJournalLocked(String str) {
Dan Egnor852f8e42009-09-30 11:20:45 -07004834 RandomAccessFile out = null;
4835 try {
4836 if (mJournal == null) mJournal = File.createTempFile("journal", null, mJournalDir);
4837 out = new RandomAccessFile(mJournal, "rws");
4838 out.seek(out.length());
4839 out.writeUTF(str);
4840 } catch (IOException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004841 Slog.e(TAG, "Can't write " + str + " to backup journal", e);
Dan Egnor852f8e42009-09-30 11:20:45 -07004842 mJournal = null;
4843 } finally {
4844 try { if (out != null) out.close(); } catch (IOException e) {}
Christopher Tatecde87f42009-06-12 12:55:53 -07004845 }
4846 }
4847
Brad Fitzpatrick3dd42332010-09-07 23:40:30 -07004848 // ----- IBackupManager binder interface -----
4849
4850 public void dataChanged(final String packageName) {
4851 final HashSet<ApplicationInfo> targets = dataChangedTargets(packageName);
4852 if (targets == null) {
4853 Slog.w(TAG, "dataChanged but no participant pkg='" + packageName + "'"
4854 + " uid=" + Binder.getCallingUid());
4855 return;
4856 }
4857
4858 mBackupHandler.post(new Runnable() {
4859 public void run() {
4860 dataChangedImpl(packageName, targets);
4861 }
4862 });
4863 }
4864
Christopher Tateee0e78a2009-07-02 11:17:03 -07004865 // Clear the given package's backup data from the current transport
4866 public void clearBackupData(String packageName) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004867 if (DEBUG) Slog.v(TAG, "clearBackupData() of " + packageName);
Christopher Tateee0e78a2009-07-02 11:17:03 -07004868 PackageInfo info;
4869 try {
4870 info = mPackageManager.getPackageInfo(packageName, PackageManager.GET_SIGNATURES);
4871 } catch (NameNotFoundException e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004872 Slog.d(TAG, "No such package '" + packageName + "' - not clearing backup data");
Christopher Tateee0e78a2009-07-02 11:17:03 -07004873 return;
4874 }
4875
4876 // If the caller does not hold the BACKUP permission, it can only request a
4877 // wipe of its own backed-up data.
4878 HashSet<ApplicationInfo> apps;
Christopher Tate4e3e50c2009-07-02 12:14:05 -07004879 if ((mContext.checkPermission(android.Manifest.permission.BACKUP, Binder.getCallingPid(),
Christopher Tateee0e78a2009-07-02 11:17:03 -07004880 Binder.getCallingUid())) == PackageManager.PERMISSION_DENIED) {
4881 apps = mBackupParticipants.get(Binder.getCallingUid());
4882 } else {
4883 // a caller with full permission can ask to back up any participating app
4884 // !!! TODO: allow data-clear of ANY app?
Joe Onorato8a9b2202010-02-26 18:56:32 -08004885 if (DEBUG) Slog.v(TAG, "Privileged caller, allowing clear of other apps");
Christopher Tateee0e78a2009-07-02 11:17:03 -07004886 apps = new HashSet<ApplicationInfo>();
4887 int N = mBackupParticipants.size();
4888 for (int i = 0; i < N; i++) {
4889 HashSet<ApplicationInfo> s = mBackupParticipants.valueAt(i);
4890 if (s != null) {
4891 apps.addAll(s);
4892 }
4893 }
4894 }
4895
4896 // now find the given package in the set of candidate apps
4897 for (ApplicationInfo app : apps) {
4898 if (app.packageName.equals(packageName)) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08004899 if (DEBUG) Slog.v(TAG, "Found the app - running clear process");
Christopher Tateee0e78a2009-07-02 11:17:03 -07004900 // found it; fire off the clear request
4901 synchronized (mQueueLock) {
Christopher Tateaa93b042009-08-05 18:21:40 -07004902 long oldId = Binder.clearCallingIdentity();
Christopher Tateb6787f22009-07-02 17:40:45 -07004903 mWakelock.acquire();
Christopher Tateee0e78a2009-07-02 11:17:03 -07004904 Message msg = mBackupHandler.obtainMessage(MSG_RUN_CLEAR,
4905 new ClearParams(getTransport(mCurrentTransport), info));
4906 mBackupHandler.sendMessage(msg);
Christopher Tateaa93b042009-08-05 18:21:40 -07004907 Binder.restoreCallingIdentity(oldId);
Christopher Tateee0e78a2009-07-02 11:17:03 -07004908 }
4909 break;
4910 }
4911 }
4912 }
4913
Christopher Tateace7f092009-06-15 18:07:25 -07004914 // Run a backup pass immediately for any applications that have declared
4915 // that they have pending updates.
Dan Egnor852f8e42009-09-30 11:20:45 -07004916 public void backupNow() {
Joe Onorato5933a492009-07-23 18:24:08 -04004917 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "backupNow");
Christopher Tate043dadc2009-06-02 16:11:00 -07004918
Joe Onorato8a9b2202010-02-26 18:56:32 -08004919 if (DEBUG) Slog.v(TAG, "Scheduling immediate backup pass");
Christopher Tate46758122009-05-06 11:22:00 -07004920 synchronized (mQueueLock) {
Christopher Tate21ab6a52009-09-24 18:01:46 -07004921 // Because the alarms we are using can jitter, and we want an *immediate*
4922 // backup pass to happen, we restart the timer beginning with "next time,"
4923 // then manually fire the backup trigger intent ourselves.
4924 startBackupAlarmsLocked(BACKUP_INTERVAL);
Christopher Tateb6787f22009-07-02 17:40:45 -07004925 try {
Christopher Tateb6787f22009-07-02 17:40:45 -07004926 mRunBackupIntent.send();
4927 } catch (PendingIntent.CanceledException e) {
4928 // should never happen
Joe Onorato8a9b2202010-02-26 18:56:32 -08004929 Slog.e(TAG, "run-backup intent cancelled!");
Christopher Tateb6787f22009-07-02 17:40:45 -07004930 }
Christopher Tate46758122009-05-06 11:22:00 -07004931 }
4932 }
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07004933
Christopher Tated2c0cd42011-09-15 15:51:29 -07004934 boolean deviceIsProvisioned() {
4935 final ContentResolver resolver = mContext.getContentResolver();
4936 return (Settings.Secure.getInt(resolver, Settings.Secure.DEVICE_PROVISIONED, 0) != 0);
4937 }
4938
Christopher Tate4a627c72011-04-01 14:43:32 -07004939 // Run a *full* backup pass for the given package, writing the resulting data stream
4940 // to the supplied file descriptor. This method is synchronous and does not return
4941 // to the caller until the backup has been completed.
4942 public void fullBackup(ParcelFileDescriptor fd, boolean includeApks, boolean includeShared,
Christopher Tate240c7d22011-10-03 18:13:44 -07004943 boolean doAllApps, boolean includeSystem, String[] pkgList) {
Christopher Tate4a627c72011-04-01 14:43:32 -07004944 mContext.enforceCallingPermission(android.Manifest.permission.BACKUP, "fullBackup");
4945
4946 // Validate
4947 if (!doAllApps) {
4948 if (!includeShared) {
4949 // If we're backing up shared data (sdcard or equivalent), then we can run
4950 // without any supplied app names. Otherwise, we'd be doing no work, so
4951 // report the error.
4952 if (pkgList == null || pkgList.length == 0) {
4953 throw new IllegalArgumentException(
4954 "Backup requested but neither shared nor any apps named");
4955 }
4956 }
4957 }
4958
Christopher Tate4a627c72011-04-01 14:43:32 -07004959 long oldId = Binder.clearCallingIdentity();
4960 try {
Christopher Tated2c0cd42011-09-15 15:51:29 -07004961 // Doesn't make sense to do a full backup prior to setup
4962 if (!deviceIsProvisioned()) {
4963 Slog.i(TAG, "Full backup not supported before setup");
4964 return;
4965 }
4966
4967 if (DEBUG) Slog.v(TAG, "Requesting full backup: apks=" + includeApks
4968 + " shared=" + includeShared + " all=" + doAllApps
4969 + " pkgs=" + pkgList);
4970 Slog.i(TAG, "Beginning full backup...");
4971
Christopher Tate4a627c72011-04-01 14:43:32 -07004972 FullBackupParams params = new FullBackupParams(fd, includeApks, includeShared,
Christopher Tate240c7d22011-10-03 18:13:44 -07004973 doAllApps, includeSystem, pkgList);
Christopher Tate4a627c72011-04-01 14:43:32 -07004974 final int token = generateToken();
4975 synchronized (mFullConfirmations) {
4976 mFullConfirmations.put(token, params);
4977 }
4978
Christopher Tate75a99702011-05-18 16:28:19 -07004979 // start up the confirmation UI
4980 if (DEBUG) Slog.d(TAG, "Starting backup confirmation UI, token=" + token);
4981 if (!startConfirmationUi(token, FullBackup.FULL_BACKUP_INTENT_ACTION)) {
4982 Slog.e(TAG, "Unable to launch full backup confirmation");
Christopher Tate4a627c72011-04-01 14:43:32 -07004983 mFullConfirmations.delete(token);
4984 return;
4985 }
Christopher Tate75a99702011-05-18 16:28:19 -07004986
4987 // make sure the screen is lit for the user interaction
Christopher Tate4a627c72011-04-01 14:43:32 -07004988 mPowerManager.userActivity(SystemClock.uptimeMillis(), false);
4989
4990 // start the confirmation countdown
Christopher Tate75a99702011-05-18 16:28:19 -07004991 startConfirmationTimeout(token, params);
Christopher Tate4a627c72011-04-01 14:43:32 -07004992
4993 // wait for the backup to be performed
4994 if (DEBUG) Slog.d(TAG, "Waiting for full backup completion...");
4995 waitForCompletion(params);
Christopher Tate4a627c72011-04-01 14:43:32 -07004996 } finally {
Christopher Tate4a627c72011-04-01 14:43:32 -07004997 try {
4998 fd.close();
4999 } catch (IOException e) {
5000 // just eat it
5001 }
Christopher Tate75a99702011-05-18 16:28:19 -07005002 Binder.restoreCallingIdentity(oldId);
Christopher Tated2c0cd42011-09-15 15:51:29 -07005003 Slog.d(TAG, "Full backup processing complete.");
Christopher Tate4a627c72011-04-01 14:43:32 -07005004 }
Christopher Tate75a99702011-05-18 16:28:19 -07005005 }
5006
5007 public void fullRestore(ParcelFileDescriptor fd) {
Christopher Tate2efd2db2011-07-19 16:32:49 -07005008 mContext.enforceCallingPermission(android.Manifest.permission.BACKUP, "fullRestore");
Christopher Tate75a99702011-05-18 16:28:19 -07005009
5010 long oldId = Binder.clearCallingIdentity();
5011
5012 try {
Christopher Tated2c0cd42011-09-15 15:51:29 -07005013 // Check whether the device has been provisioned -- we don't handle
5014 // full restores prior to completing the setup process.
5015 if (!deviceIsProvisioned()) {
5016 Slog.i(TAG, "Full restore not permitted before setup");
5017 return;
5018 }
5019
5020 Slog.i(TAG, "Beginning full restore...");
5021
Christopher Tate75a99702011-05-18 16:28:19 -07005022 FullRestoreParams params = new FullRestoreParams(fd);
5023 final int token = generateToken();
5024 synchronized (mFullConfirmations) {
5025 mFullConfirmations.put(token, params);
5026 }
5027
5028 // start up the confirmation UI
5029 if (DEBUG) Slog.d(TAG, "Starting restore confirmation UI, token=" + token);
5030 if (!startConfirmationUi(token, FullBackup.FULL_RESTORE_INTENT_ACTION)) {
5031 Slog.e(TAG, "Unable to launch full restore confirmation");
5032 mFullConfirmations.delete(token);
5033 return;
5034 }
5035
5036 // make sure the screen is lit for the user interaction
5037 mPowerManager.userActivity(SystemClock.uptimeMillis(), false);
5038
5039 // start the confirmation countdown
5040 startConfirmationTimeout(token, params);
5041
5042 // wait for the restore to be performed
5043 if (DEBUG) Slog.d(TAG, "Waiting for full restore completion...");
5044 waitForCompletion(params);
5045 } finally {
5046 try {
5047 fd.close();
5048 } catch (IOException e) {
5049 Slog.w(TAG, "Error trying to close fd after full restore: " + e);
5050 }
5051 Binder.restoreCallingIdentity(oldId);
Christopher Tated2c0cd42011-09-15 15:51:29 -07005052 Slog.i(TAG, "Full restore processing complete.");
Christopher Tate75a99702011-05-18 16:28:19 -07005053 }
5054 }
5055
5056 boolean startConfirmationUi(int token, String action) {
5057 try {
5058 Intent confIntent = new Intent(action);
5059 confIntent.setClassName("com.android.backupconfirm",
5060 "com.android.backupconfirm.BackupRestoreConfirmation");
5061 confIntent.putExtra(FullBackup.CONF_TOKEN_INTENT_EXTRA, token);
5062 confIntent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
5063 mContext.startActivity(confIntent);
5064 } catch (ActivityNotFoundException e) {
5065 return false;
5066 }
5067 return true;
5068 }
5069
5070 void startConfirmationTimeout(int token, FullParams params) {
Christopher Tatec58efa62011-08-01 19:20:14 -07005071 if (MORE_DEBUG) Slog.d(TAG, "Posting conf timeout msg after "
Christopher Tate75a99702011-05-18 16:28:19 -07005072 + TIMEOUT_FULL_CONFIRMATION + " millis");
5073 Message msg = mBackupHandler.obtainMessage(MSG_FULL_CONFIRMATION_TIMEOUT,
5074 token, 0, params);
5075 mBackupHandler.sendMessageDelayed(msg, TIMEOUT_FULL_CONFIRMATION);
Christopher Tate4a627c72011-04-01 14:43:32 -07005076 }
5077
5078 void waitForCompletion(FullParams params) {
5079 synchronized (params.latch) {
5080 while (params.latch.get() == false) {
5081 try {
5082 params.latch.wait();
5083 } catch (InterruptedException e) { /* never interrupted */ }
5084 }
5085 }
5086 }
5087
5088 void signalFullBackupRestoreCompletion(FullParams params) {
5089 synchronized (params.latch) {
5090 params.latch.set(true);
5091 params.latch.notifyAll();
5092 }
5093 }
5094
5095 // Confirm that the previously-requested full backup/restore operation can proceed. This
5096 // is used to require a user-facing disclosure about the operation.
Christopher Tate2efd2db2011-07-19 16:32:49 -07005097 @Override
Christopher Tate4a627c72011-04-01 14:43:32 -07005098 public void acknowledgeFullBackupOrRestore(int token, boolean allow,
Christopher Tate728a1c42011-07-28 18:03:03 -07005099 String curPassword, String encPpassword, IFullBackupRestoreObserver observer) {
Christopher Tate4a627c72011-04-01 14:43:32 -07005100 if (DEBUG) Slog.d(TAG, "acknowledgeFullBackupOrRestore : token=" + token
5101 + " allow=" + allow);
5102
5103 // TODO: possibly require not just this signature-only permission, but even
5104 // require that the specific designated confirmation-UI app uid is the caller?
Christopher Tate2efd2db2011-07-19 16:32:49 -07005105 mContext.enforceCallingPermission(android.Manifest.permission.BACKUP, "acknowledgeFullBackupOrRestore");
Christopher Tate4a627c72011-04-01 14:43:32 -07005106
5107 long oldId = Binder.clearCallingIdentity();
5108 try {
5109
5110 FullParams params;
5111 synchronized (mFullConfirmations) {
5112 params = mFullConfirmations.get(token);
5113 if (params != null) {
5114 mBackupHandler.removeMessages(MSG_FULL_CONFIRMATION_TIMEOUT, params);
5115 mFullConfirmations.delete(token);
5116
5117 if (allow) {
Christopher Tate4a627c72011-04-01 14:43:32 -07005118 final int verb = params instanceof FullBackupParams
Christopher Tate75a99702011-05-18 16:28:19 -07005119 ? MSG_RUN_FULL_BACKUP
Christopher Tate4a627c72011-04-01 14:43:32 -07005120 : MSG_RUN_FULL_RESTORE;
5121
Christopher Tate728a1c42011-07-28 18:03:03 -07005122 params.observer = observer;
5123 params.curPassword = curPassword;
Christopher Tate32418be2011-10-10 13:51:12 -07005124
5125 boolean isEncrypted;
5126 try {
5127 isEncrypted = (mMountService.getEncryptionState() != MountService.ENCRYPTION_STATE_NONE);
5128 if (isEncrypted) Slog.w(TAG, "Device is encrypted; forcing enc password");
5129 } catch (RemoteException e) {
5130 // couldn't contact the mount service; fail "safe" and assume encryption
5131 Slog.e(TAG, "Unable to contact mount service!");
5132 isEncrypted = true;
5133 }
5134 params.encryptPassword = (isEncrypted) ? curPassword : encPpassword;
Christopher Tate728a1c42011-07-28 18:03:03 -07005135
Christopher Tate75a99702011-05-18 16:28:19 -07005136 if (DEBUG) Slog.d(TAG, "Sending conf message with verb " + verb);
Christopher Tate4a627c72011-04-01 14:43:32 -07005137 mWakelock.acquire();
5138 Message msg = mBackupHandler.obtainMessage(verb, params);
5139 mBackupHandler.sendMessage(msg);
5140 } else {
5141 Slog.w(TAG, "User rejected full backup/restore operation");
5142 // indicate completion without having actually transferred any data
5143 signalFullBackupRestoreCompletion(params);
5144 }
5145 } else {
5146 Slog.w(TAG, "Attempted to ack full backup/restore with invalid token");
5147 }
5148 }
5149 } finally {
5150 Binder.restoreCallingIdentity(oldId);
5151 }
5152 }
5153
Christopher Tate8031a3d2009-07-06 16:36:05 -07005154 // Enable/disable the backup service
Christopher Tate6ef58a12009-06-29 14:56:28 -07005155 public void setBackupEnabled(boolean enable) {
Christopher Tateb6787f22009-07-02 17:40:45 -07005156 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate2efd2db2011-07-19 16:32:49 -07005157 "setBackupEnabled");
Christopher Tate6ef58a12009-06-29 14:56:28 -07005158
Joe Onorato8a9b2202010-02-26 18:56:32 -08005159 Slog.i(TAG, "Backup enabled => " + enable);
Christopher Tate4cc86e12009-09-21 19:36:51 -07005160
Christopher Tate6ef58a12009-06-29 14:56:28 -07005161 boolean wasEnabled = mEnabled;
5162 synchronized (this) {
Dianne Hackborncf098292009-07-01 19:55:20 -07005163 Settings.Secure.putInt(mContext.getContentResolver(),
5164 Settings.Secure.BACKUP_ENABLED, enable ? 1 : 0);
Christopher Tate6ef58a12009-06-29 14:56:28 -07005165 mEnabled = enable;
5166 }
5167
Christopher Tate49401dd2009-07-01 12:34:29 -07005168 synchronized (mQueueLock) {
Christopher Tate8031a3d2009-07-06 16:36:05 -07005169 if (enable && !wasEnabled && mProvisioned) {
Christopher Tate49401dd2009-07-01 12:34:29 -07005170 // if we've just been enabled, start scheduling backup passes
Christopher Tate8031a3d2009-07-06 16:36:05 -07005171 startBackupAlarmsLocked(BACKUP_INTERVAL);
Christopher Tate49401dd2009-07-01 12:34:29 -07005172 } else if (!enable) {
Christopher Tateb6787f22009-07-02 17:40:45 -07005173 // No longer enabled, so stop running backups
Joe Onorato8a9b2202010-02-26 18:56:32 -08005174 if (DEBUG) Slog.i(TAG, "Opting out of backup");
Christopher Tate4cc86e12009-09-21 19:36:51 -07005175
Christopher Tateb6787f22009-07-02 17:40:45 -07005176 mAlarmManager.cancel(mRunBackupIntent);
Christopher Tate4cc86e12009-09-21 19:36:51 -07005177
5178 // This also constitutes an opt-out, so we wipe any data for
5179 // this device from the backend. We start that process with
5180 // an alarm in order to guarantee wakelock states.
5181 if (wasEnabled && mProvisioned) {
5182 // NOTE: we currently flush every registered transport, not just
5183 // the currently-active one.
5184 HashSet<String> allTransports;
5185 synchronized (mTransports) {
5186 allTransports = new HashSet<String>(mTransports.keySet());
5187 }
5188 // build the set of transports for which we are posting an init
5189 for (String transport : allTransports) {
5190 recordInitPendingLocked(true, transport);
5191 }
5192 mAlarmManager.set(AlarmManager.RTC_WAKEUP, System.currentTimeMillis(),
5193 mRunInitIntent);
5194 }
Christopher Tate6ef58a12009-06-29 14:56:28 -07005195 }
5196 }
Christopher Tate49401dd2009-07-01 12:34:29 -07005197 }
Christopher Tate6ef58a12009-06-29 14:56:28 -07005198
Christopher Tatecce9da52010-02-03 15:11:15 -08005199 // Enable/disable automatic restore of app data at install time
5200 public void setAutoRestore(boolean doAutoRestore) {
5201 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate2efd2db2011-07-19 16:32:49 -07005202 "setAutoRestore");
Christopher Tatecce9da52010-02-03 15:11:15 -08005203
Joe Onorato8a9b2202010-02-26 18:56:32 -08005204 Slog.i(TAG, "Auto restore => " + doAutoRestore);
Christopher Tatecce9da52010-02-03 15:11:15 -08005205
5206 synchronized (this) {
5207 Settings.Secure.putInt(mContext.getContentResolver(),
5208 Settings.Secure.BACKUP_AUTO_RESTORE, doAutoRestore ? 1 : 0);
5209 mAutoRestore = doAutoRestore;
5210 }
5211 }
5212
Christopher Tate8031a3d2009-07-06 16:36:05 -07005213 // Mark the backup service as having been provisioned
5214 public void setBackupProvisioned(boolean available) {
5215 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
5216 "setBackupProvisioned");
5217
5218 boolean wasProvisioned = mProvisioned;
5219 synchronized (this) {
5220 Settings.Secure.putInt(mContext.getContentResolver(),
5221 Settings.Secure.BACKUP_PROVISIONED, available ? 1 : 0);
5222 mProvisioned = available;
5223 }
5224
5225 synchronized (mQueueLock) {
5226 if (available && !wasProvisioned && mEnabled) {
5227 // we're now good to go, so start the backup alarms
5228 startBackupAlarmsLocked(FIRST_BACKUP_INTERVAL);
5229 } else if (!available) {
5230 // No longer enabled, so stop running backups
Joe Onorato8a9b2202010-02-26 18:56:32 -08005231 Slog.w(TAG, "Backup service no longer provisioned");
Christopher Tate8031a3d2009-07-06 16:36:05 -07005232 mAlarmManager.cancel(mRunBackupIntent);
5233 }
5234 }
5235 }
5236
5237 private void startBackupAlarmsLocked(long delayBeforeFirstBackup) {
Dan Egnorc1c49c02009-10-30 17:35:39 -07005238 // We used to use setInexactRepeating(), but that may be linked to
5239 // backups running at :00 more often than not, creating load spikes.
5240 // Schedule at an exact time for now, and also add a bit of "fuzz".
5241
5242 Random random = new Random();
5243 long when = System.currentTimeMillis() + delayBeforeFirstBackup +
5244 random.nextInt(FUZZ_MILLIS);
5245 mAlarmManager.setRepeating(AlarmManager.RTC_WAKEUP, when,
5246 BACKUP_INTERVAL + random.nextInt(FUZZ_MILLIS), mRunBackupIntent);
Christopher Tate55f931a2009-09-29 17:17:34 -07005247 mNextBackupPass = when;
Christopher Tate8031a3d2009-07-06 16:36:05 -07005248 }
5249
Christopher Tate6ef58a12009-06-29 14:56:28 -07005250 // Report whether the backup mechanism is currently enabled
5251 public boolean isBackupEnabled() {
Joe Onorato5933a492009-07-23 18:24:08 -04005252 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "isBackupEnabled");
Christopher Tate6ef58a12009-06-29 14:56:28 -07005253 return mEnabled; // no need to synchronize just to read it
5254 }
5255
Christopher Tate91717492009-06-26 21:07:13 -07005256 // Report the name of the currently active transport
5257 public String getCurrentTransport() {
Joe Onorato5933a492009-07-23 18:24:08 -04005258 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate4e3e50c2009-07-02 12:14:05 -07005259 "getCurrentTransport");
Christopher Tatec58efa62011-08-01 19:20:14 -07005260 if (MORE_DEBUG) Slog.v(TAG, "... getCurrentTransport() returning " + mCurrentTransport);
Christopher Tate91717492009-06-26 21:07:13 -07005261 return mCurrentTransport;
Christopher Tateace7f092009-06-15 18:07:25 -07005262 }
5263
Christopher Tate91717492009-06-26 21:07:13 -07005264 // Report all known, available backup transports
5265 public String[] listAllTransports() {
Christopher Tate34ebd0e2009-07-06 15:44:54 -07005266 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "listAllTransports");
Christopher Tate043dadc2009-06-02 16:11:00 -07005267
Christopher Tate91717492009-06-26 21:07:13 -07005268 String[] list = null;
5269 ArrayList<String> known = new ArrayList<String>();
5270 for (Map.Entry<String, IBackupTransport> entry : mTransports.entrySet()) {
5271 if (entry.getValue() != null) {
5272 known.add(entry.getKey());
5273 }
5274 }
5275
5276 if (known.size() > 0) {
5277 list = new String[known.size()];
5278 known.toArray(list);
5279 }
5280 return list;
5281 }
5282
5283 // Select which transport to use for the next backup operation. If the given
5284 // name is not one of the available transports, no action is taken and the method
5285 // returns null.
5286 public String selectBackupTransport(String transport) {
Joe Onorato5933a492009-07-23 18:24:08 -04005287 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP, "selectBackupTransport");
Christopher Tate91717492009-06-26 21:07:13 -07005288
5289 synchronized (mTransports) {
5290 String prevTransport = null;
5291 if (mTransports.get(transport) != null) {
5292 prevTransport = mCurrentTransport;
5293 mCurrentTransport = transport;
Dianne Hackborncf098292009-07-01 19:55:20 -07005294 Settings.Secure.putString(mContext.getContentResolver(),
5295 Settings.Secure.BACKUP_TRANSPORT, transport);
Joe Onorato8a9b2202010-02-26 18:56:32 -08005296 Slog.v(TAG, "selectBackupTransport() set " + mCurrentTransport
Christopher Tate91717492009-06-26 21:07:13 -07005297 + " returning " + prevTransport);
5298 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005299 Slog.w(TAG, "Attempt to select unavailable transport " + transport);
Christopher Tate91717492009-06-26 21:07:13 -07005300 }
5301 return prevTransport;
5302 }
Christopher Tate043dadc2009-06-02 16:11:00 -07005303 }
5304
Christopher Tatef5e1c292010-12-08 18:40:26 -08005305 // Supply the configuration Intent for the given transport. If the name is not one
5306 // of the available transports, or if the transport does not supply any configuration
5307 // UI, the method returns null.
5308 public Intent getConfigurationIntent(String transportName) {
5309 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
5310 "getConfigurationIntent");
5311
5312 synchronized (mTransports) {
5313 final IBackupTransport transport = mTransports.get(transportName);
5314 if (transport != null) {
5315 try {
5316 final Intent intent = transport.configurationIntent();
Christopher Tatec58efa62011-08-01 19:20:14 -07005317 if (MORE_DEBUG) Slog.d(TAG, "getConfigurationIntent() returning config intent "
Christopher Tatef5e1c292010-12-08 18:40:26 -08005318 + intent);
5319 return intent;
5320 } catch (RemoteException e) {
5321 /* fall through to return null */
5322 }
5323 }
5324 }
5325
5326 return null;
5327 }
5328
5329 // Supply the configuration summary string for the given transport. If the name is
5330 // not one of the available transports, or if the transport does not supply any
5331 // summary / destination string, the method can return null.
5332 //
5333 // This string is used VERBATIM as the summary text of the relevant Settings item!
5334 public String getDestinationString(String transportName) {
5335 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate2efd2db2011-07-19 16:32:49 -07005336 "getDestinationString");
Christopher Tatef5e1c292010-12-08 18:40:26 -08005337
5338 synchronized (mTransports) {
5339 final IBackupTransport transport = mTransports.get(transportName);
5340 if (transport != null) {
5341 try {
5342 final String text = transport.currentDestinationString();
Christopher Tatec58efa62011-08-01 19:20:14 -07005343 if (MORE_DEBUG) Slog.d(TAG, "getDestinationString() returning " + text);
Christopher Tatef5e1c292010-12-08 18:40:26 -08005344 return text;
5345 } catch (RemoteException e) {
5346 /* fall through to return null */
5347 }
5348 }
5349 }
5350
5351 return null;
5352 }
5353
Christopher Tate043dadc2009-06-02 16:11:00 -07005354 // Callback: a requested backup agent has been instantiated. This should only
5355 // be called from the Activity Manager.
Christopher Tate181fafa2009-05-14 11:12:14 -07005356 public void agentConnected(String packageName, IBinder agentBinder) {
Christopher Tate043dadc2009-06-02 16:11:00 -07005357 synchronized(mAgentConnectLock) {
5358 if (Binder.getCallingUid() == Process.SYSTEM_UID) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005359 Slog.d(TAG, "agentConnected pkg=" + packageName + " agent=" + agentBinder);
Christopher Tate043dadc2009-06-02 16:11:00 -07005360 IBackupAgent agent = IBackupAgent.Stub.asInterface(agentBinder);
5361 mConnectedAgent = agent;
5362 mConnecting = false;
5363 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005364 Slog.w(TAG, "Non-system process uid=" + Binder.getCallingUid()
Christopher Tate043dadc2009-06-02 16:11:00 -07005365 + " claiming agent connected");
5366 }
5367 mAgentConnectLock.notifyAll();
5368 }
Christopher Tate181fafa2009-05-14 11:12:14 -07005369 }
5370
5371 // Callback: a backup agent has failed to come up, or has unexpectedly quit.
5372 // If the agent failed to come up in the first place, the agentBinder argument
Christopher Tate043dadc2009-06-02 16:11:00 -07005373 // will be null. This should only be called from the Activity Manager.
Christopher Tate181fafa2009-05-14 11:12:14 -07005374 public void agentDisconnected(String packageName) {
5375 // TODO: handle backup being interrupted
Christopher Tate043dadc2009-06-02 16:11:00 -07005376 synchronized(mAgentConnectLock) {
5377 if (Binder.getCallingUid() == Process.SYSTEM_UID) {
5378 mConnectedAgent = null;
5379 mConnecting = false;
5380 } else {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005381 Slog.w(TAG, "Non-system process uid=" + Binder.getCallingUid()
Christopher Tate043dadc2009-06-02 16:11:00 -07005382 + " claiming agent disconnected");
5383 }
5384 mAgentConnectLock.notifyAll();
5385 }
Christopher Tate181fafa2009-05-14 11:12:14 -07005386 }
Christopher Tate181fafa2009-05-14 11:12:14 -07005387
Christopher Tate1bb69062010-02-19 17:02:12 -08005388 // An application being installed will need a restore pass, then the Package Manager
5389 // will need to be told when the restore is finished.
5390 public void restoreAtInstall(String packageName, int token) {
5391 if (Binder.getCallingUid() != Process.SYSTEM_UID) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005392 Slog.w(TAG, "Non-system process uid=" + Binder.getCallingUid()
Christopher Tate1bb69062010-02-19 17:02:12 -08005393 + " attemping install-time restore");
5394 return;
5395 }
5396
5397 long restoreSet = getAvailableRestoreToken(packageName);
Joe Onorato8a9b2202010-02-26 18:56:32 -08005398 if (DEBUG) Slog.v(TAG, "restoreAtInstall pkg=" + packageName
Christopher Tate1bb69062010-02-19 17:02:12 -08005399 + " token=" + Integer.toHexString(token));
5400
Christopher Tatef0872722010-02-25 15:22:48 -08005401 if (mAutoRestore && mProvisioned && restoreSet != 0) {
Christopher Tate1bb69062010-02-19 17:02:12 -08005402 // okay, we're going to attempt a restore of this package from this restore set.
5403 // The eventual message back into the Package Manager to run the post-install
5404 // steps for 'token' will be issued from the restore handling code.
5405
5406 // We can use a synthetic PackageInfo here because:
5407 // 1. We know it's valid, since the Package Manager supplied the name
5408 // 2. Only the packageName field will be used by the restore code
5409 PackageInfo pkg = new PackageInfo();
5410 pkg.packageName = packageName;
5411
5412 mWakelock.acquire();
5413 Message msg = mBackupHandler.obtainMessage(MSG_RUN_RESTORE);
5414 msg.obj = new RestoreParams(getTransport(mCurrentTransport), null,
Chris Tate249345b2010-10-29 12:57:04 -07005415 restoreSet, pkg, token, true);
Christopher Tate1bb69062010-02-19 17:02:12 -08005416 mBackupHandler.sendMessage(msg);
5417 } else {
Christopher Tatef0872722010-02-25 15:22:48 -08005418 // Auto-restore disabled or no way to attempt a restore; just tell the Package
5419 // Manager to proceed with the post-install handling for this package.
Joe Onorato8a9b2202010-02-26 18:56:32 -08005420 if (DEBUG) Slog.v(TAG, "No restore set -- skipping restore");
Christopher Tate1bb69062010-02-19 17:02:12 -08005421 try {
5422 mPackageManagerBinder.finishPackageInstall(token);
5423 } catch (RemoteException e) { /* can't happen */ }
5424 }
5425 }
5426
Christopher Tate8c850b72009-06-07 19:33:20 -07005427 // Hand off a restore session
Chris Tate44ab8452010-11-16 15:10:49 -08005428 public IRestoreSession beginRestoreSession(String packageName, String transport) {
5429 if (DEBUG) Slog.v(TAG, "beginRestoreSession: pkg=" + packageName
5430 + " transport=" + transport);
5431
5432 boolean needPermission = true;
5433 if (transport == null) {
5434 transport = mCurrentTransport;
5435
5436 if (packageName != null) {
5437 PackageInfo app = null;
5438 try {
5439 app = mPackageManager.getPackageInfo(packageName, 0);
5440 } catch (NameNotFoundException nnf) {
5441 Slog.w(TAG, "Asked to restore nonexistent pkg " + packageName);
5442 throw new IllegalArgumentException("Package " + packageName + " not found");
5443 }
5444
5445 if (app.applicationInfo.uid == Binder.getCallingUid()) {
5446 // So: using the current active transport, and the caller has asked
5447 // that its own package will be restored. In this narrow use case
5448 // we do not require the caller to hold the permission.
5449 needPermission = false;
5450 }
5451 }
5452 }
5453
5454 if (needPermission) {
5455 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
5456 "beginRestoreSession");
5457 } else {
5458 if (DEBUG) Slog.d(TAG, "restoring self on current transport; no permission needed");
5459 }
Christopher Tatef68eb502009-06-16 11:02:01 -07005460
5461 synchronized(this) {
5462 if (mActiveRestoreSession != null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005463 Slog.d(TAG, "Restore session requested but one already active");
Christopher Tatef68eb502009-06-16 11:02:01 -07005464 return null;
5465 }
Chris Tate44ab8452010-11-16 15:10:49 -08005466 mActiveRestoreSession = new ActiveRestoreSession(packageName, transport);
Christopher Tate73a3cb32010-12-13 18:27:26 -08005467 mBackupHandler.sendEmptyMessageDelayed(MSG_RESTORE_TIMEOUT, TIMEOUT_RESTORE_INTERVAL);
Christopher Tatef68eb502009-06-16 11:02:01 -07005468 }
5469 return mActiveRestoreSession;
Christopher Tate8c850b72009-06-07 19:33:20 -07005470 }
Christopher Tate043dadc2009-06-02 16:11:00 -07005471
Christopher Tate73a3cb32010-12-13 18:27:26 -08005472 void clearRestoreSession(ActiveRestoreSession currentSession) {
5473 synchronized(this) {
5474 if (currentSession != mActiveRestoreSession) {
5475 Slog.e(TAG, "ending non-current restore session");
5476 } else {
5477 if (DEBUG) Slog.v(TAG, "Clearing restore session and halting timeout");
5478 mActiveRestoreSession = null;
5479 mBackupHandler.removeMessages(MSG_RESTORE_TIMEOUT);
5480 }
5481 }
5482 }
5483
Christopher Tate44a27902010-01-27 17:15:49 -08005484 // Note that a currently-active backup agent has notified us that it has
5485 // completed the given outstanding asynchronous backup/restore operation.
Christopher Tate8e294d42011-08-31 20:37:12 -07005486 @Override
Christopher Tate44a27902010-01-27 17:15:49 -08005487 public void opComplete(int token) {
Christopher Tate8e294d42011-08-31 20:37:12 -07005488 if (MORE_DEBUG) Slog.v(TAG, "opComplete: " + Integer.toHexString(token));
5489 Operation op = null;
Christopher Tate44a27902010-01-27 17:15:49 -08005490 synchronized (mCurrentOpLock) {
Christopher Tate8e294d42011-08-31 20:37:12 -07005491 op = mCurrentOperations.get(token);
5492 if (op != null) {
5493 op.state = OP_ACKNOWLEDGED;
5494 }
Christopher Tate44a27902010-01-27 17:15:49 -08005495 mCurrentOpLock.notifyAll();
5496 }
Christopher Tate8e294d42011-08-31 20:37:12 -07005497
5498 // The completion callback, if any, is invoked on the handler
5499 if (op != null && op.callback != null) {
5500 Message msg = mBackupHandler.obtainMessage(MSG_OP_COMPLETE, op.callback);
5501 mBackupHandler.sendMessage(msg);
5502 }
Christopher Tate44a27902010-01-27 17:15:49 -08005503 }
5504
Christopher Tate9b3905c2009-06-08 15:24:01 -07005505 // ----- Restore session -----
5506
Christopher Tate80202c82010-01-25 19:37:47 -08005507 class ActiveRestoreSession extends IRestoreSession.Stub {
Christopher Tatef68eb502009-06-16 11:02:01 -07005508 private static final String TAG = "RestoreSession";
5509
Chris Tate44ab8452010-11-16 15:10:49 -08005510 private String mPackageName;
Christopher Tate9b3905c2009-06-08 15:24:01 -07005511 private IBackupTransport mRestoreTransport = null;
5512 RestoreSet[] mRestoreSets = null;
Christopher Tate73a3cb32010-12-13 18:27:26 -08005513 boolean mEnded = false;
Christopher Tate9b3905c2009-06-08 15:24:01 -07005514
Chris Tate44ab8452010-11-16 15:10:49 -08005515 ActiveRestoreSession(String packageName, String transport) {
5516 mPackageName = packageName;
Christopher Tate91717492009-06-26 21:07:13 -07005517 mRestoreTransport = getTransport(transport);
Christopher Tate9b3905c2009-06-08 15:24:01 -07005518 }
5519
5520 // --- Binder interface ---
Christopher Tate2d449afe2010-03-29 19:14:24 -07005521 public synchronized int getAvailableRestoreSets(IRestoreObserver observer) {
Joe Onorato5933a492009-07-23 18:24:08 -04005522 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
Christopher Tate9bbc21a2009-06-10 20:23:25 -07005523 "getAvailableRestoreSets");
Christopher Tate2d449afe2010-03-29 19:14:24 -07005524 if (observer == null) {
5525 throw new IllegalArgumentException("Observer must not be null");
5526 }
Christopher Tate9bbc21a2009-06-10 20:23:25 -07005527
Christopher Tate73a3cb32010-12-13 18:27:26 -08005528 if (mEnded) {
5529 throw new IllegalStateException("Restore session already ended");
5530 }
5531
Christopher Tate1bb69062010-02-19 17:02:12 -08005532 long oldId = Binder.clearCallingIdentity();
Christopher Tatef68eb502009-06-16 11:02:01 -07005533 try {
Christopher Tate43383042009-07-13 15:17:13 -07005534 if (mRestoreTransport == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005535 Slog.w(TAG, "Null transport getting restore sets");
Christopher Tate2d449afe2010-03-29 19:14:24 -07005536 return -1;
Dan Egnor0084da52009-07-29 12:57:16 -07005537 }
Christopher Tate2d449afe2010-03-29 19:14:24 -07005538 // spin off the transport request to our service thread
5539 mWakelock.acquire();
5540 Message msg = mBackupHandler.obtainMessage(MSG_RUN_GET_RESTORE_SETS,
5541 new RestoreGetSetsParams(mRestoreTransport, this, observer));
5542 mBackupHandler.sendMessage(msg);
5543 return 0;
Dan Egnor0084da52009-07-29 12:57:16 -07005544 } catch (Exception e) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005545 Slog.e(TAG, "Error in getAvailableRestoreSets", e);
Christopher Tate2d449afe2010-03-29 19:14:24 -07005546 return -1;
Christopher Tate1bb69062010-02-19 17:02:12 -08005547 } finally {
5548 Binder.restoreCallingIdentity(oldId);
Christopher Tatef68eb502009-06-16 11:02:01 -07005549 }
Christopher Tate9b3905c2009-06-08 15:24:01 -07005550 }
5551
Christopher Tate84725812010-02-04 15:52:40 -08005552 public synchronized int restoreAll(long token, IRestoreObserver observer) {
Dan Egnor0084da52009-07-29 12:57:16 -07005553 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
5554 "performRestore");
Christopher Tate9bbc21a2009-06-10 20:23:25 -07005555
Chris Tate44ab8452010-11-16 15:10:49 -08005556 if (DEBUG) Slog.d(TAG, "restoreAll token=" + Long.toHexString(token)
Christopher Tatef2c321a2009-08-10 15:43:36 -07005557 + " observer=" + observer);
Joe Onorato9a5e3e12009-07-01 21:04:03 -04005558
Christopher Tate73a3cb32010-12-13 18:27:26 -08005559 if (mEnded) {
5560 throw new IllegalStateException("Restore session already ended");
5561 }
5562
Dan Egnor0084da52009-07-29 12:57:16 -07005563 if (mRestoreTransport == null || mRestoreSets == null) {
Chris Tate44ab8452010-11-16 15:10:49 -08005564 Slog.e(TAG, "Ignoring restoreAll() with no restore set");
5565 return -1;
5566 }
5567
5568 if (mPackageName != null) {
5569 Slog.e(TAG, "Ignoring restoreAll() on single-package session");
Dan Egnor0084da52009-07-29 12:57:16 -07005570 return -1;
5571 }
5572
Christopher Tate21ab6a52009-09-24 18:01:46 -07005573 synchronized (mQueueLock) {
Christopher Tate21ab6a52009-09-24 18:01:46 -07005574 for (int i = 0; i < mRestoreSets.length; i++) {
5575 if (token == mRestoreSets[i].token) {
5576 long oldId = Binder.clearCallingIdentity();
Christopher Tate21ab6a52009-09-24 18:01:46 -07005577 mWakelock.acquire();
5578 Message msg = mBackupHandler.obtainMessage(MSG_RUN_RESTORE);
Chris Tate249345b2010-10-29 12:57:04 -07005579 msg.obj = new RestoreParams(mRestoreTransport, observer, token, true);
Christopher Tate21ab6a52009-09-24 18:01:46 -07005580 mBackupHandler.sendMessage(msg);
5581 Binder.restoreCallingIdentity(oldId);
5582 return 0;
5583 }
Christopher Tate9bbc21a2009-06-10 20:23:25 -07005584 }
5585 }
Christopher Tate0e0b4ae2009-08-10 16:13:47 -07005586
Joe Onorato8a9b2202010-02-26 18:56:32 -08005587 Slog.w(TAG, "Restore token " + Long.toHexString(token) + " not found");
Christopher Tate9b3905c2009-06-08 15:24:01 -07005588 return -1;
5589 }
5590
Christopher Tate284f1bb2011-07-07 14:31:18 -07005591 public synchronized int restoreSome(long token, IRestoreObserver observer,
5592 String[] packages) {
5593 mContext.enforceCallingOrSelfPermission(android.Manifest.permission.BACKUP,
5594 "performRestore");
5595
5596 if (DEBUG) {
5597 StringBuilder b = new StringBuilder(128);
5598 b.append("restoreSome token=");
5599 b.append(Long.toHexString(token));
5600 b.append(" observer=");
5601 b.append(observer.toString());
5602 b.append(" packages=");
5603 if (packages == null) {
5604 b.append("null");
5605 } else {
5606 b.append('{');
5607 boolean first = true;
5608 for (String s : packages) {
5609 if (!first) {
5610 b.append(", ");
5611 } else first = false;
5612 b.append(s);
5613 }
5614 b.append('}');
5615 }
5616 Slog.d(TAG, b.toString());
5617 }
5618
5619 if (mEnded) {
5620 throw new IllegalStateException("Restore session already ended");
5621 }
5622
5623 if (mRestoreTransport == null || mRestoreSets == null) {
5624 Slog.e(TAG, "Ignoring restoreAll() with no restore set");
5625 return -1;
5626 }
5627
5628 if (mPackageName != null) {
5629 Slog.e(TAG, "Ignoring restoreAll() on single-package session");
5630 return -1;
5631 }
5632
5633 synchronized (mQueueLock) {
5634 for (int i = 0; i < mRestoreSets.length; i++) {
5635 if (token == mRestoreSets[i].token) {
5636 long oldId = Binder.clearCallingIdentity();
5637 mWakelock.acquire();
5638 Message msg = mBackupHandler.obtainMessage(MSG_RUN_RESTORE);
5639 msg.obj = new RestoreParams(mRestoreTransport, observer, token,
5640 packages, true);
5641 mBackupHandler.sendMessage(msg);
5642 Binder.restoreCallingIdentity(oldId);
5643 return 0;
5644 }
5645 }
5646 }
5647
5648 Slog.w(TAG, "Restore token " + Long.toHexString(token) + " not found");
5649 return -1;
5650 }
5651
Christopher Tate84725812010-02-04 15:52:40 -08005652 public synchronized int restorePackage(String packageName, IRestoreObserver observer) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005653 if (DEBUG) Slog.v(TAG, "restorePackage pkg=" + packageName + " obs=" + observer);
Christopher Tate84725812010-02-04 15:52:40 -08005654
Christopher Tate73a3cb32010-12-13 18:27:26 -08005655 if (mEnded) {
5656 throw new IllegalStateException("Restore session already ended");
5657 }
5658
Chris Tate44ab8452010-11-16 15:10:49 -08005659 if (mPackageName != null) {
5660 if (! mPackageName.equals(packageName)) {
5661 Slog.e(TAG, "Ignoring attempt to restore pkg=" + packageName
5662 + " on session for package " + mPackageName);
5663 return -1;
5664 }
5665 }
5666
Christopher Tate84725812010-02-04 15:52:40 -08005667 PackageInfo app = null;
5668 try {
5669 app = mPackageManager.getPackageInfo(packageName, 0);
5670 } catch (NameNotFoundException nnf) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005671 Slog.w(TAG, "Asked to restore nonexistent pkg " + packageName);
Christopher Tate84725812010-02-04 15:52:40 -08005672 return -1;
5673 }
5674
5675 // If the caller is not privileged and is not coming from the target
5676 // app's uid, throw a permission exception back to the caller.
5677 int perm = mContext.checkPermission(android.Manifest.permission.BACKUP,
5678 Binder.getCallingPid(), Binder.getCallingUid());
5679 if ((perm == PackageManager.PERMISSION_DENIED) &&
5680 (app.applicationInfo.uid != Binder.getCallingUid())) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005681 Slog.w(TAG, "restorePackage: bad packageName=" + packageName
Christopher Tate84725812010-02-04 15:52:40 -08005682 + " or calling uid=" + Binder.getCallingUid());
5683 throw new SecurityException("No permission to restore other packages");
5684 }
5685
Christopher Tate7d411a32010-02-26 11:27:08 -08005686 // If the package has no backup agent, we obviously cannot proceed
5687 if (app.applicationInfo.backupAgentName == null) {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005688 Slog.w(TAG, "Asked to restore package " + packageName + " with no agent");
Christopher Tate7d411a32010-02-26 11:27:08 -08005689 return -1;
5690 }
5691
Christopher Tate84725812010-02-04 15:52:40 -08005692 // So far so good; we're allowed to try to restore this package. Now
5693 // check whether there is data for it in the current dataset, falling back
5694 // to the ancestral dataset if not.
Christopher Tate1bb69062010-02-19 17:02:12 -08005695 long token = getAvailableRestoreToken(packageName);
Christopher Tate84725812010-02-04 15:52:40 -08005696
5697 // If we didn't come up with a place to look -- no ancestral dataset and
5698 // the app has never been backed up from this device -- there's nothing
5699 // to do but return failure.
5700 if (token == 0) {
Chris Tate44ab8452010-11-16 15:10:49 -08005701 if (DEBUG) Slog.w(TAG, "No data available for this package; not restoring");
Christopher Tate84725812010-02-04 15:52:40 -08005702 return -1;
5703 }
5704
5705 // Ready to go: enqueue the restore request and claim success
5706 long oldId = Binder.clearCallingIdentity();
5707 mWakelock.acquire();
5708 Message msg = mBackupHandler.obtainMessage(MSG_RUN_RESTORE);
Chris Tate249345b2010-10-29 12:57:04 -07005709 msg.obj = new RestoreParams(mRestoreTransport, observer, token, app, 0, false);
Christopher Tate84725812010-02-04 15:52:40 -08005710 mBackupHandler.sendMessage(msg);
5711 Binder.restoreCallingIdentity(oldId);
5712 return 0;
5713 }
5714
Christopher Tate73a3cb32010-12-13 18:27:26 -08005715 // Posted to the handler to tear down a restore session in a cleanly synchronized way
5716 class EndRestoreRunnable implements Runnable {
5717 BackupManagerService mBackupManager;
5718 ActiveRestoreSession mSession;
5719
5720 EndRestoreRunnable(BackupManagerService manager, ActiveRestoreSession session) {
5721 mBackupManager = manager;
5722 mSession = session;
5723 }
5724
5725 public void run() {
5726 // clean up the session's bookkeeping
5727 synchronized (mSession) {
5728 try {
5729 if (mSession.mRestoreTransport != null) {
5730 mSession.mRestoreTransport.finishRestore();
5731 }
5732 } catch (Exception e) {
5733 Slog.e(TAG, "Error in finishRestore", e);
5734 } finally {
5735 mSession.mRestoreTransport = null;
5736 mSession.mEnded = true;
5737 }
5738 }
5739
5740 // clean up the BackupManagerService side of the bookkeeping
5741 // and cancel any pending timeout message
5742 mBackupManager.clearRestoreSession(mSession);
5743 }
5744 }
5745
Dan Egnor0084da52009-07-29 12:57:16 -07005746 public synchronized void endRestoreSession() {
Joe Onorato8a9b2202010-02-26 18:56:32 -08005747 if (DEBUG) Slog.d(TAG, "endRestoreSession");
Joe Onorato9a5e3e12009-07-01 21:04:03 -04005748
Christopher Tate73a3cb32010-12-13 18:27:26 -08005749 if (mEnded) {
5750 throw new IllegalStateException("Restore session already ended");
Dan Egnor0084da52009-07-29 12:57:16 -07005751 }
5752
Christopher Tate73a3cb32010-12-13 18:27:26 -08005753 mBackupHandler.post(new EndRestoreRunnable(BackupManagerService.this, this));
Christopher Tate9b3905c2009-06-08 15:24:01 -07005754 }
5755 }
5756
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005757 @Override
5758 public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
Fabrice Di Meglio8aac3ee2011-01-12 18:47:14 -08005759 long identityToken = Binder.clearCallingIdentity();
5760 try {
5761 dumpInternal(pw);
5762 } finally {
5763 Binder.restoreCallingIdentity(identityToken);
5764 }
5765 }
5766
5767 private void dumpInternal(PrintWriter pw) {
Christopher Tateb8491bb2011-09-29 15:13:11 -07005768 if (mContext.checkCallingOrSelfPermission(android.Manifest.permission.DUMP)
5769 != PackageManager.PERMISSION_GRANTED) {
5770 pw.println("Permission Denial: can't dump Backup Manager service from from pid="
5771 + Binder.getCallingPid()
5772 + ", uid=" + Binder.getCallingUid()
5773 + " without permission "
5774 + android.Manifest.permission.DUMP);
5775 return;
5776 }
5777
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005778 synchronized (mQueueLock) {
Christopher Tate8031a3d2009-07-06 16:36:05 -07005779 pw.println("Backup Manager is " + (mEnabled ? "enabled" : "disabled")
Christopher Tate55f931a2009-09-29 17:17:34 -07005780 + " / " + (!mProvisioned ? "not " : "") + "provisioned / "
Christopher Tatec2af5d32010-02-02 15:18:58 -08005781 + (this.mPendingInits.size() == 0 ? "not " : "") + "pending init");
Christopher Tateae06ed92010-02-25 17:13:28 -08005782 pw.println("Auto-restore is " + (mAutoRestore ? "enabled" : "disabled"));
Christopher Tate336a6492011-10-05 16:05:43 -07005783 if (mBackupRunning) pw.println("Backup currently running");
5784 pw.println("Last backup pass started: " + mLastBackupPass
Christopher Tate55f931a2009-09-29 17:17:34 -07005785 + " (now = " + System.currentTimeMillis() + ')');
5786 pw.println(" next scheduled: " + mNextBackupPass);
5787
Christopher Tate91717492009-06-26 21:07:13 -07005788 pw.println("Available transports:");
5789 for (String t : listAllTransports()) {
Dan Egnor852f8e42009-09-30 11:20:45 -07005790 pw.println((t.equals(mCurrentTransport) ? " * " : " ") + t);
5791 try {
Fabrice Di Meglio8aac3ee2011-01-12 18:47:14 -08005792 IBackupTransport transport = getTransport(t);
5793 File dir = new File(mBaseStateDir, transport.transportDirName());
5794 pw.println(" destination: " + transport.currentDestinationString());
5795 pw.println(" intent: " + transport.configurationIntent());
Dan Egnor852f8e42009-09-30 11:20:45 -07005796 for (File f : dir.listFiles()) {
5797 pw.println(" " + f.getName() + " - " + f.length() + " state bytes");
5798 }
Fabrice Di Meglio8aac3ee2011-01-12 18:47:14 -08005799 } catch (Exception e) {
5800 Slog.e(TAG, "Error in transport", e);
Dan Egnor852f8e42009-09-30 11:20:45 -07005801 pw.println(" Error: " + e);
5802 }
Christopher Tate91717492009-06-26 21:07:13 -07005803 }
Christopher Tate55f931a2009-09-29 17:17:34 -07005804
5805 pw.println("Pending init: " + mPendingInits.size());
5806 for (String s : mPendingInits) {
5807 pw.println(" " + s);
5808 }
5809
Christopher Tate6de74ff2012-01-17 15:20:32 -08005810 if (DEBUG_BACKUP_TRACE) {
5811 synchronized (mBackupTrace) {
5812 if (!mBackupTrace.isEmpty()) {
5813 pw.println("Most recent backup trace:");
5814 for (String s : mBackupTrace) {
5815 pw.println(" " + s);
5816 }
5817 }
5818 }
5819 }
5820
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005821 int N = mBackupParticipants.size();
Christopher Tate55f931a2009-09-29 17:17:34 -07005822 pw.println("Participants:");
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005823 for (int i=0; i<N; i++) {
5824 int uid = mBackupParticipants.keyAt(i);
5825 pw.print(" uid: ");
5826 pw.println(uid);
Christopher Tate181fafa2009-05-14 11:12:14 -07005827 HashSet<ApplicationInfo> participants = mBackupParticipants.valueAt(i);
5828 for (ApplicationInfo app: participants) {
Christopher Tate55f931a2009-09-29 17:17:34 -07005829 pw.println(" " + app.packageName);
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005830 }
5831 }
Christopher Tate55f931a2009-09-29 17:17:34 -07005832
Christopher Tateb49ceb32010-02-08 16:22:24 -08005833 pw.println("Ancestral packages: "
5834 + (mAncestralPackages == null ? "none" : mAncestralPackages.size()));
Christopher Tate5923c972010-04-04 17:45:35 -07005835 if (mAncestralPackages != null) {
5836 for (String pkg : mAncestralPackages) {
5837 pw.println(" " + pkg);
5838 }
Christopher Tateb49ceb32010-02-08 16:22:24 -08005839 }
5840
Christopher Tate73e02522009-07-15 14:18:26 -07005841 pw.println("Ever backed up: " + mEverStoredApps.size());
5842 for (String pkg : mEverStoredApps) {
5843 pw.println(" " + pkg);
5844 }
Christopher Tate55f931a2009-09-29 17:17:34 -07005845
5846 pw.println("Pending backup: " + mPendingBackups.size());
Christopher Tate6aa41f42009-06-19 14:14:22 -07005847 for (BackupRequest req : mPendingBackups.values()) {
Christopher Tate6ef58a12009-06-29 14:56:28 -07005848 pw.println(" " + req);
Christopher Tate181fafa2009-05-14 11:12:14 -07005849 }
Joe Onoratob1a7ffe2009-05-06 18:06:21 -07005850 }
5851 }
Christopher Tate487529a2009-04-29 14:03:25 -07005852}