Kenny Root | 15a4d2f | 2010-03-11 18:20:12 -0800 | [diff] [blame] | 1 | /* |
| 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 | |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 17 | package com.android.internal.backup; |
| 18 | |
Christopher Tate | 4528186 | 2010-03-05 15:46:30 -0800 | [diff] [blame] | 19 | import android.app.backup.BackupDataInput; |
| 20 | import android.app.backup.BackupDataOutput; |
| 21 | import android.app.backup.RestoreSet; |
Christopher Tate | cefba58 | 2013-11-14 18:10:35 -0800 | [diff] [blame] | 22 | import android.content.ComponentName; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 23 | import android.content.Context; |
Chris Tate | a8ddef3 | 2010-11-10 11:53:26 -0800 | [diff] [blame] | 24 | import android.content.Intent; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 25 | import android.content.pm.PackageInfo; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 26 | import android.os.Environment; |
| 27 | import android.os.ParcelFileDescriptor; |
rpcraig | ebab0ae | 2012-12-04 09:37:23 -0500 | [diff] [blame] | 28 | import android.os.SELinux; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 29 | import android.util.Log; |
| 30 | |
Brian Carlstrom | 4140fae | 2011-01-24 16:17:43 -0800 | [diff] [blame] | 31 | import com.android.org.bouncycastle.util.encoders.Base64; |
Christopher Tate | e9190a2 | 2009-06-17 17:52:05 -0700 | [diff] [blame] | 32 | |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 33 | import java.io.File; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 34 | import java.io.FileInputStream; |
| 35 | import java.io.FileOutputStream; |
| 36 | import java.io.IOException; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 37 | |
| 38 | /** |
| 39 | * Backup transport for stashing stuff into a known location on disk, and |
| 40 | * later restoring from there. For testing only. |
| 41 | */ |
| 42 | |
| 43 | public class LocalTransport extends IBackupTransport.Stub { |
| 44 | private static final String TAG = "LocalTransport"; |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 45 | private static final boolean DEBUG = true; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 46 | |
Christopher Tate | 5cb400b | 2009-06-25 16:03:14 -0700 | [diff] [blame] | 47 | private static final String TRANSPORT_DIR_NAME |
| 48 | = "com.android.internal.backup.LocalTransport"; |
| 49 | |
Chris Tate | a8ddef3 | 2010-11-10 11:53:26 -0800 | [diff] [blame] | 50 | private static final String TRANSPORT_DESTINATION_STRING |
| 51 | = "Backing up to debug-only private cache"; |
| 52 | |
Christopher Tate | 50c6df0 | 2010-01-29 12:48:20 -0800 | [diff] [blame] | 53 | // The single hardcoded restore set always has the same (nonzero!) token |
| 54 | private static final long RESTORE_TOKEN = 1; |
| 55 | |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 56 | private Context mContext; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 57 | private File mDataDir = new File(Environment.getDownloadCacheDirectory(), "backup"); |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 58 | private PackageInfo[] mRestorePackages = null; |
| 59 | private int mRestorePackage = -1; // Index into mRestorePackages |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 60 | |
| 61 | |
| 62 | public LocalTransport(Context context) { |
| 63 | mContext = context; |
rpcraig | ebab0ae | 2012-12-04 09:37:23 -0500 | [diff] [blame] | 64 | mDataDir.mkdirs(); |
| 65 | if (!SELinux.restorecon(mDataDir)) { |
| 66 | Log.e(TAG, "SELinux restorecon failed for " + mDataDir); |
| 67 | } |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 68 | } |
| 69 | |
Christopher Tate | cefba58 | 2013-11-14 18:10:35 -0800 | [diff] [blame] | 70 | public String name() { |
| 71 | return new ComponentName(mContext, this.getClass()).flattenToShortString(); |
| 72 | } |
| 73 | |
Chris Tate | a8ddef3 | 2010-11-10 11:53:26 -0800 | [diff] [blame] | 74 | public Intent configurationIntent() { |
| 75 | // The local transport is not user-configurable |
| 76 | return null; |
| 77 | } |
| 78 | |
| 79 | public String currentDestinationString() { |
| 80 | return TRANSPORT_DESTINATION_STRING; |
| 81 | } |
Christopher Tate | 5cb400b | 2009-06-25 16:03:14 -0700 | [diff] [blame] | 82 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 83 | public String transportDirName() { |
Christopher Tate | 5cb400b | 2009-06-25 16:03:14 -0700 | [diff] [blame] | 84 | return TRANSPORT_DIR_NAME; |
| 85 | } |
| 86 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 87 | public long requestBackupTime() { |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 88 | // any time is a good time for local backup |
| 89 | return 0; |
| 90 | } |
| 91 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 92 | public int initializeDevice() { |
| 93 | if (DEBUG) Log.v(TAG, "wiping all data"); |
| 94 | deleteContents(mDataDir); |
| 95 | return BackupConstants.TRANSPORT_OK; |
| 96 | } |
| 97 | |
| 98 | public int performBackup(PackageInfo packageInfo, ParcelFileDescriptor data) { |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 99 | if (DEBUG) Log.v(TAG, "performBackup() pkg=" + packageInfo.packageName); |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 100 | |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 101 | File packageDir = new File(mDataDir, packageInfo.packageName); |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 102 | packageDir.mkdirs(); |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 103 | |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 104 | // Each 'record' in the restore set is kept in its own file, named by |
| 105 | // the record key. Wind through the data file, extracting individual |
| 106 | // record operations and building a set of all the updates to apply |
| 107 | // in this update. |
| 108 | BackupDataInput changeSet = new BackupDataInput(data.getFileDescriptor()); |
| 109 | try { |
| 110 | int bufSize = 512; |
| 111 | byte[] buf = new byte[bufSize]; |
| 112 | while (changeSet.readNextHeader()) { |
| 113 | String key = changeSet.getKey(); |
Joe Onorato | 5d605dc | 2009-06-18 18:23:43 -0700 | [diff] [blame] | 114 | String base64Key = new String(Base64.encode(key.getBytes())); |
| 115 | File entityFile = new File(packageDir, base64Key); |
| 116 | |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 117 | int dataSize = changeSet.getDataSize(); |
Christopher Tate | e9190a2 | 2009-06-17 17:52:05 -0700 | [diff] [blame] | 118 | |
Christopher Tate | e9190a2 | 2009-06-17 17:52:05 -0700 | [diff] [blame] | 119 | if (DEBUG) Log.v(TAG, "Got change set key=" + key + " size=" + dataSize |
| 120 | + " key64=" + base64Key); |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 121 | |
Joe Onorato | 5d605dc | 2009-06-18 18:23:43 -0700 | [diff] [blame] | 122 | if (dataSize >= 0) { |
Dianne Hackborn | 1afd1c9 | 2010-03-18 22:47:17 -0700 | [diff] [blame] | 123 | if (entityFile.exists()) { |
| 124 | entityFile.delete(); |
| 125 | } |
Joe Onorato | 5d605dc | 2009-06-18 18:23:43 -0700 | [diff] [blame] | 126 | FileOutputStream entity = new FileOutputStream(entityFile); |
| 127 | |
| 128 | if (dataSize > bufSize) { |
| 129 | bufSize = dataSize; |
| 130 | buf = new byte[bufSize]; |
| 131 | } |
| 132 | changeSet.readEntityData(buf, 0, dataSize); |
| 133 | if (DEBUG) Log.v(TAG, " data size " + dataSize); |
| 134 | |
| 135 | try { |
| 136 | entity.write(buf, 0, dataSize); |
| 137 | } catch (IOException e) { |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 138 | Log.e(TAG, "Unable to update key file " + entityFile.getAbsolutePath()); |
Christopher Tate | d55e18a | 2009-09-21 10:12:59 -0700 | [diff] [blame] | 139 | return BackupConstants.TRANSPORT_ERROR; |
Joe Onorato | 5d605dc | 2009-06-18 18:23:43 -0700 | [diff] [blame] | 140 | } finally { |
| 141 | entity.close(); |
| 142 | } |
| 143 | } else { |
| 144 | entityFile.delete(); |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 145 | } |
| 146 | } |
Christopher Tate | d55e18a | 2009-09-21 10:12:59 -0700 | [diff] [blame] | 147 | return BackupConstants.TRANSPORT_OK; |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 148 | } catch (IOException e) { |
| 149 | // oops, something went wrong. abort the operation and return error. |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 150 | Log.v(TAG, "Exception reading backup input:", e); |
Christopher Tate | d55e18a | 2009-09-21 10:12:59 -0700 | [diff] [blame] | 151 | return BackupConstants.TRANSPORT_ERROR; |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 152 | } |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 153 | } |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 154 | |
Christopher Tate | 25a747f | 2009-09-20 12:43:58 -0700 | [diff] [blame] | 155 | // Deletes the contents but not the given directory |
| 156 | private void deleteContents(File dirname) { |
| 157 | File[] contents = dirname.listFiles(); |
| 158 | if (contents != null) { |
| 159 | for (File f : contents) { |
| 160 | if (f.isDirectory()) { |
| 161 | // delete the directory's contents then fall through |
| 162 | // and delete the directory itself. |
| 163 | deleteContents(f); |
| 164 | } |
| 165 | f.delete(); |
| 166 | } |
| 167 | } |
| 168 | } |
| 169 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 170 | public int clearBackupData(PackageInfo packageInfo) { |
Christopher Tate | ee0e78a | 2009-07-02 11:17:03 -0700 | [diff] [blame] | 171 | if (DEBUG) Log.v(TAG, "clearBackupData() pkg=" + packageInfo.packageName); |
| 172 | |
| 173 | File packageDir = new File(mDataDir, packageInfo.packageName); |
Christopher Tate | 0abf6a0 | 2012-03-23 17:45:15 -0700 | [diff] [blame] | 174 | final File[] fileset = packageDir.listFiles(); |
| 175 | if (fileset != null) { |
| 176 | for (File f : fileset) { |
| 177 | f.delete(); |
| 178 | } |
| 179 | packageDir.delete(); |
Christopher Tate | ee0e78a | 2009-07-02 11:17:03 -0700 | [diff] [blame] | 180 | } |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 181 | return BackupConstants.TRANSPORT_OK; |
Christopher Tate | ee0e78a | 2009-07-02 11:17:03 -0700 | [diff] [blame] | 182 | } |
| 183 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 184 | public int finishBackup() { |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 185 | if (DEBUG) Log.v(TAG, "finishBackup()"); |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 186 | return BackupConstants.TRANSPORT_OK; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 187 | } |
| 188 | |
| 189 | // Restore handling |
| 190 | public RestoreSet[] getAvailableRestoreSets() throws android.os.RemoteException { |
| 191 | // one hardcoded restore set |
Christopher Tate | 50c6df0 | 2010-01-29 12:48:20 -0800 | [diff] [blame] | 192 | RestoreSet set = new RestoreSet("Local disk image", "flash", RESTORE_TOKEN); |
Christopher Tate | f68eb50 | 2009-06-16 11:02:01 -0700 | [diff] [blame] | 193 | RestoreSet[] array = { set }; |
| 194 | return array; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 195 | } |
| 196 | |
Christopher Tate | 50c6df0 | 2010-01-29 12:48:20 -0800 | [diff] [blame] | 197 | public long getCurrentRestoreSet() { |
| 198 | // The hardcoded restore set always has the same token |
| 199 | return RESTORE_TOKEN; |
| 200 | } |
| 201 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 202 | public int startRestore(long token, PackageInfo[] packages) { |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 203 | if (DEBUG) Log.v(TAG, "start restore " + token); |
| 204 | mRestorePackages = packages; |
| 205 | mRestorePackage = -1; |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 206 | return BackupConstants.TRANSPORT_OK; |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 207 | } |
| 208 | |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 209 | public String nextRestorePackage() { |
| 210 | if (mRestorePackages == null) throw new IllegalStateException("startRestore not called"); |
| 211 | while (++mRestorePackage < mRestorePackages.length) { |
| 212 | String name = mRestorePackages[mRestorePackage].packageName; |
| 213 | if (new File(mDataDir, name).isDirectory()) { |
| 214 | if (DEBUG) Log.v(TAG, " nextRestorePackage() = " + name); |
| 215 | return name; |
| 216 | } |
| 217 | } |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 218 | |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 219 | if (DEBUG) Log.v(TAG, " no more packages to restore"); |
| 220 | return ""; |
| 221 | } |
| 222 | |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 223 | public int getRestoreData(ParcelFileDescriptor outFd) { |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 224 | if (mRestorePackages == null) throw new IllegalStateException("startRestore not called"); |
| 225 | if (mRestorePackage < 0) throw new IllegalStateException("nextRestorePackage not called"); |
| 226 | File packageDir = new File(mDataDir, mRestorePackages[mRestorePackage].packageName); |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 227 | |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 228 | // The restore set is the concatenation of the individual record blobs, |
| 229 | // each of which is a file in the package's directory |
| 230 | File[] blobs = packageDir.listFiles(); |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 231 | if (blobs == null) { // nextRestorePackage() ensures the dir exists, so this is an error |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 232 | Log.e(TAG, "Error listing directory: " + packageDir); |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 233 | return BackupConstants.TRANSPORT_ERROR; |
Christopher Tate | 2fdd428 | 2009-06-12 15:20:04 -0700 | [diff] [blame] | 234 | } |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 235 | |
| 236 | // We expect at least some data if the directory exists in the first place |
| 237 | if (DEBUG) Log.v(TAG, " getRestoreData() found " + blobs.length + " key files"); |
| 238 | BackupDataOutput out = new BackupDataOutput(outFd.getFileDescriptor()); |
| 239 | try { |
| 240 | for (File f : blobs) { |
| 241 | FileInputStream in = new FileInputStream(f); |
| 242 | try { |
| 243 | int size = (int) f.length(); |
| 244 | byte[] buf = new byte[size]; |
| 245 | in.read(buf); |
| 246 | String key = new String(Base64.decode(f.getName())); |
| 247 | if (DEBUG) Log.v(TAG, " ... key=" + key + " size=" + size); |
| 248 | out.writeEntityHeader(key, size); |
| 249 | out.writeEntityData(buf, size); |
| 250 | } finally { |
| 251 | in.close(); |
| 252 | } |
| 253 | } |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 254 | return BackupConstants.TRANSPORT_OK; |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 255 | } catch (IOException e) { |
| 256 | Log.e(TAG, "Unable to read backup records", e); |
Dan Egnor | 0144516 | 2009-09-21 17:04:05 -0700 | [diff] [blame] | 257 | return BackupConstants.TRANSPORT_ERROR; |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 258 | } |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 259 | } |
Christopher Tate | 3a31a93 | 2009-06-22 15:10:30 -0700 | [diff] [blame] | 260 | |
Dan Egnor | efe5264 | 2009-06-24 00:16:33 -0700 | [diff] [blame] | 261 | public void finishRestore() { |
| 262 | if (DEBUG) Log.v(TAG, "finishRestore()"); |
Christopher Tate | 3a31a93 | 2009-06-22 15:10:30 -0700 | [diff] [blame] | 263 | } |
Christopher Tate | 9bbc21a | 2009-06-10 20:23:25 -0700 | [diff] [blame] | 264 | } |