SystemBackupAgent.java revision 4a627c71ff53a4fca1f961f4b1dcc0461df18a06
19bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato/*
29bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * Copyright (C) 2009 The Android Open Source Project
39bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato *
49bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * Licensed under the Apache License, Version 2.0 (the "License");
59bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * you may not use this file except in compliance with the License.
69bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * You may obtain a copy of the License at
79bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato *
89bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato *      http://www.apache.org/licenses/LICENSE-2.0
99bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato *
109bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * Unless required by applicable law or agreed to in writing, software
119bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * distributed under the License is distributed on an "AS IS" BASIS,
129bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
139bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * See the License for the specific language governing permissions and
149bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato * limitations under the License.
159bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato */
169bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
179bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratopackage com.android.server;
189bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
19a924dc0db952fe32509435fdb8dc9c84a9e181f3Dianne Hackborn
204528186e0d65fc68ef0dd1941aa2ac8aefcd55a3Christopher Tateimport android.app.backup.BackupDataInput;
214528186e0d65fc68ef0dd1941aa2ac8aefcd55a3Christopher Tateimport android.app.backup.BackupDataOutput;
22cc84c69726507a85116f5664e20e2ebfac76edbeChristopher Tateimport android.app.backup.BackupAgentHelper;
234a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tateimport android.app.backup.FullBackup;
243f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tateimport android.app.backup.WallpaperBackupHelper;
259bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratoimport android.content.Context;
269bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratoimport android.os.ParcelFileDescriptor;
279bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratoimport android.os.ServiceManager;
288a9b22056b13477f59df934928c00c58b5871c95Joe Onoratoimport android.util.Slog;
299bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
303f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tate
319bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratoimport java.io.File;
329bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onoratoimport java.io.IOException;
339bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
349bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato/**
357c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate * Backup agent for various system-managed data, currently just the system wallpaper
369bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato */
37cc84c69726507a85116f5664e20e2ebfac76edbeChristopher Tatepublic class SystemBackupAgent extends BackupAgentHelper {
389bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    private static final String TAG = "SystemBackupAgent";
399bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
407c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate    // These paths must match what the WallpaperManagerService uses
414a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    private static final String WALLPAPER_IMAGE_DIR = "/data/data/com.android.settings/files";
424a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    private static final String WALLPAPER_IMAGE = WALLPAPER_IMAGE_DIR + "/wallpaper";
434a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    private static final String WALLPAPER_INFO_DIR = "/data/system";
444a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    private static final String WALLPAPER_INFO = WALLPAPER_INFO_DIR + "/wallpaper_info.xml";
459bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
469bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    @Override
477c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate    public void onBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
487c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate            ParcelFileDescriptor newState) throws IOException {
494a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate        if (oldState == null) {
504a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate            runFullBackup(data);
514a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate            return;
524a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate        }
534a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate
547c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate        // We only back up the data under the current "wallpaper" schema with metadata
55541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor        WallpaperManagerService wallpaper = (WallpaperManagerService)ServiceManager.getService(
56541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor                Context.WALLPAPER_SERVICE);
57541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor        String[] files = new String[] { WALLPAPER_IMAGE, WALLPAPER_INFO };
58541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor        if (wallpaper != null && wallpaper.mName != null && wallpaper.mName.length() > 0) {
59541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor            // When the wallpaper has a name, back up the info by itself.
60541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor            // TODO: Don't rely on the innards of the service object like this!
61541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor            // TODO: Send a delete for any stored wallpaper image in this case?
62541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor            files = new String[] { WALLPAPER_INFO };
63541fa51e5ccba9e2def2632f9835db0c9407ec5cDan Egnor        }
643f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tate        addHelper("wallpaper", new WallpaperBackupHelper(SystemBackupAgent.this, files));
657c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate        super.onBackup(oldState, data, newState);
669bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    }
679bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
684a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    private void runFullBackup(BackupDataOutput output) {
694a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate        // Back up the data files directly
704a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate        FullBackup.backupToTar(getPackageName(), null, null,
714a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate                WALLPAPER_IMAGE_DIR, WALLPAPER_IMAGE, output);
724a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate        FullBackup.backupToTar(getPackageName(), null, null,
734a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate                WALLPAPER_INFO_DIR, WALLPAPER_INFO, output);
744a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate    }
754a627c71ff53a4fca1f961f4b1dcc0461df18a06Christopher Tate
769bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    @Override
779bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    public void onRestore(BackupDataInput data, int appVersionCode, ParcelFileDescriptor newState)
789bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            throws IOException {
797c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate        // On restore, we also support a previous data schema "system_files"
803f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tate        addHelper("wallpaper", new WallpaperBackupHelper(SystemBackupAgent.this,
817c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate                new String[] { WALLPAPER_IMAGE, WALLPAPER_INFO }));
823f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tate        addHelper("system_files", new WallpaperBackupHelper(SystemBackupAgent.this,
837c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate                new String[] { WALLPAPER_IMAGE }));
847c2bb66db77653c0a690962858cf105b0cb981d7Christopher Tate
859bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato        try {
869bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            super.onRestore(data, appVersionCode, newState);
879bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato
888cc6a5026aeb5cf9cc36529426fe0cc66714f5fbDianne Hackborn            WallpaperManagerService wallpaper = (WallpaperManagerService)ServiceManager.getService(
899bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato                    Context.WALLPAPER_SERVICE);
909bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            wallpaper.settingsRestored();
919bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato        } catch (IOException ex) {
923f64f8d8fc05189777e83b4efd3882cbc661fdebChristopher Tate            // If there was a failure, delete everything for the wallpaper, this is too aggressive,
939bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            // but this is hopefully a rare failure.
948a9b22056b13477f59df934928c00c58b5871c95Joe Onorato            Slog.d(TAG, "restore failed", ex);
959bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            (new File(WALLPAPER_IMAGE)).delete();
969bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato            (new File(WALLPAPER_INFO)).delete();
979bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato        }
989bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato    }
999bb8fd77c8dc177aab9ac96bed4f55972dcda70aJoe Onorato}
100