Removing Key-Value pair backup logic as Launcher now uses full-data backup

Change-Id: I3bbaec2b33afe8c1da3ca1468c7c733cc3194604
This commit is contained in:
Sunny Goyal 2016-05-24 13:19:01 -07:00
parent 0d21daace2
commit eb77aaea89
8 changed files with 9 additions and 1572 deletions

View File

@ -1,131 +0,0 @@
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
syntax = "proto2";
package launcher_backup;
option java_package = "com.android.launcher3.backup.nano";
option java_outer_classname = "BackupProtos";
message Key {
enum Type {
FAVORITE = 1;
SCREEN = 2;
ICON = 3;
WIDGET = 4;
}
required Type type = 1;
optional string name = 2; // keep this short
optional int64 id = 3;
optional int64 checksum = 4;
}
message CheckedMessage {
required bytes payload = 1;
required int64 checksum = 2;
}
message DeviceProfieData {
required float desktop_rows = 1;
required float desktop_cols = 2;
required float hotseat_count = 3;
required int32 allapps_rank = 4;
}
message Journal {
required int32 app_version = 1;
// Time when the backup was created
required int64 t = 2;
// Total bytes written during the last backup
// OBSOLETE: A state may contain entries which are already present in the backup
// and were not written in the last backup
optional int64 bytes = 3;
// Total entries written during the last backup
// OBSOLETE: A state may contain entries which are already present in the backup
// and were not written in the last backup
optional int32 rows = 4;
// Valid keys for this state
repeated Key key = 5;
// Backup format version.
optional int32 backup_version = 6 [default = 1];
optional DeviceProfieData profile = 7;
}
message Favorite {
// Type of the app, this target represents
enum TargetType {
TARGET_NONE = 0;
TARGET_PHONE = 1;
TARGET_MESSENGER = 2;
TARGET_EMAIL = 3;
TARGET_BROWSER = 4;
TARGET_GALLERY = 5;
TARGET_CAMERA = 6;
}
required int64 id = 1;
required int32 itemType = 2;
optional string title = 3;
optional int32 container = 4;
optional int32 screen = 5;
optional int32 cellX = 6;
optional int32 cellY = 7;
optional int32 spanX = 8;
optional int32 spanY = 9;
optional int32 displayMode = 10;
optional int32 appWidgetId = 11;
optional string appWidgetProvider = 12;
optional string intent = 13;
optional string uri = 14;
optional int32 iconType = 15 [deprecated = true];
optional string iconPackage = 16;
optional string iconResource = 17;
optional bytes icon = 18;
// Added in backup version 4
optional TargetType targetType = 19 [default = TARGET_NONE];
optional int32 rank = 20;
}
message Screen {
required int64 id = 1;
optional int32 rank = 2;
}
message Resource {
required int32 dpi = 1;
required bytes data = 2;
}
message Widget {
required string provider = 1;
optional string label = 2;
optional bool configure = 3;
optional Resource icon = 4;
optional Resource preview = 5;
// Added in backup version 3
// Assume that a widget is resizable upto 2x2 if no data is available
optional int32 minSpanX = 6 [default = 2];
optional int32 minSpanY = 7 [default = 2];
}

View File

@ -1,137 +0,0 @@
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.launcher3;
import android.app.backup.BackupAgentHelper;
import android.app.backup.BackupDataInput;
import android.app.backup.BackupManager;
import android.content.Context;
import android.content.SharedPreferences;
import android.database.Cursor;
import android.os.ParcelFileDescriptor;
import android.util.Log;
import com.android.launcher3.model.GridSizeMigrationTask;
import java.io.IOException;
public class LauncherBackupAgentHelper extends BackupAgentHelper {
private static final String TAG = "LauncherBAHelper";
private static final String KEY_LAST_NOTIFIED_TIME = "backup_manager_last_notified";
private static final String LAUNCHER_DATA_PREFIX = "L";
static final boolean VERBOSE = false;
static final boolean DEBUG = false;
/**
* Notify the backup manager that out database is dirty.
*
* <P>This does not force an immediate backup.
*
* @param context application context
*/
public static void dataChanged(Context context) {
dataChanged(context, 0);
}
/**
* Notify the backup manager that out database is dirty.
*
* <P>This does not force an immediate backup.
*
* @param context application context
* @param throttleMs duration in ms for which two consecutive calls to backup manager should
* not be made.
*/
public static void dataChanged(Context context, long throttleMs) {
SharedPreferences prefs = Utilities.getPrefs(context);
long now = System.currentTimeMillis();
long lastTime = prefs.getLong(KEY_LAST_NOTIFIED_TIME, 0);
// User can manually change the system time, which could lead to now < lastTime.
// Re-backup in that case, as the backup will have a wrong lastModifiedTime.
if (now < lastTime || now >= (lastTime + throttleMs)) {
BackupManager.dataChanged(context.getPackageName());
prefs.edit().putLong(KEY_LAST_NOTIFIED_TIME, now).apply();
}
}
private LauncherBackupHelper mHelper;
@Override
public void onCreate() {
super.onCreate();
mHelper = new LauncherBackupHelper(this);
addHelper(LAUNCHER_DATA_PREFIX, mHelper);
}
@Override
public void onRestore(BackupDataInput data, int appVersionCode, ParcelFileDescriptor newState)
throws IOException {
if (!Utilities.ATLEAST_LOLLIPOP) {
// No restore for old devices.
Log.i(TAG, "You shall not pass!!!");
Log.d(TAG, "Restore is only supported on devices running Lollipop and above.");
return;
}
// Clear dB before restore
LauncherSettings.Settings.call(getContentResolver(),
LauncherSettings.Settings.METHOD_CREATE_EMPTY_DB);
boolean hasData;
try {
super.onRestore(data, appVersionCode, newState);
// If no favorite was migrated, clear the data and start fresh.
final Cursor c = getContentResolver().query(
LauncherSettings.Favorites.CONTENT_URI, null, null, null, null);
hasData = c.moveToNext();
c.close();
} catch (Exception e) {
// If the restore fails, we should do a fresh start.
Log.e(TAG, "Restore failed", e);
hasData = false;
}
if (hasData && mHelper.restoreSuccessful) {
LauncherSettings.Settings.call(getContentResolver(),
LauncherSettings.Settings.METHOD_CLEAR_EMPTY_DB_FLAG);
LauncherClings.markFirstRunClingDismissed(this);
// Rank was added in v4.
if (mHelper.restoredBackupVersion <= 3) {
LauncherSettings.Settings.call(getContentResolver(),
LauncherSettings.Settings.METHOD_UPDATE_FOLDER_ITEMS_RANK);
}
if (GridSizeMigrationTask.ENABLED && mHelper.shouldAttemptWorkspaceMigration()) {
GridSizeMigrationTask.markForMigration(getApplicationContext(),
mHelper.widgetSizes, mHelper.migrationCompatibleProfileData);
}
LauncherSettings.Settings.call(getContentResolver(),
LauncherSettings.Settings.METHOD_CONVERT_SHORTCUTS_TO_ACTIVITIES);
} else {
if (VERBOSE) Log.v(TAG, "Nothing was restored, clearing DB");
LauncherSettings.Settings.call(getContentResolver(),
LauncherSettings.Settings.METHOD_CREATE_EMPTY_DB);
}
}
}

File diff suppressed because it is too large Load Diff

View File

@ -382,14 +382,6 @@ public class LauncherProvider extends ContentProvider {
loadDefaultFavoritesIfNecessary();
return null;
}
case LauncherSettings.Settings.METHOD_UPDATE_FOLDER_ITEMS_RANK: {
mOpenHelper.updateFolderItemsRank(mOpenHelper.getWritableDatabase(), false);
return null;
}
case LauncherSettings.Settings.METHOD_CONVERT_SHORTCUTS_TO_ACTIVITIES: {
mOpenHelper.convertShortcutsToLauncherActivities(mOpenHelper.getWritableDatabase());
return null;
}
case LauncherSettings.Settings.METHOD_DELETE_DB: {
// Are you sure? (y/n)
mOpenHelper.createEmptyDB(mOpenHelper.getWritableDatabase());
@ -439,8 +431,6 @@ public class LauncherProvider extends ContentProvider {
* Overridden in tests
*/
protected void notifyListeners() {
// always notify the backup agent
LauncherBackupAgentHelper.dataChanged(getContext());
mListenerHandler.sendEmptyMessage(ChangeListenerWrapper.MSG_LAUNCHER_PROVIDER_CHANGED);
}

View File

@ -285,9 +285,6 @@ public class LauncherSettings {
public static final String METHOD_CLEAR_EMPTY_DB_FLAG = "clear_empty_db_flag";
public static final String METHOD_DELETE_EMPTY_FOLDERS = "delete_empty_folders";
public static final String METHOD_UPDATE_FOLDER_ITEMS_RANK = "update_folder_items_rank";
public static final String METHOD_CONVERT_SHORTCUTS_TO_ACTIVITIES =
"convert_shortcuts_to_launcher_activities";
public static final String METHOD_NEW_ITEM_ID = "generate_new_item_id";
public static final String METHOD_NEW_SCREEN_ID = "generate_new_screen_id";

View File

@ -51,10 +51,6 @@ public class GridSizeMigrationTask {
private static final String KEY_MIGRATION_SRC_WORKSPACE_SIZE = "migration_src_workspace_size";
private static final String KEY_MIGRATION_SRC_HOTSEAT_COUNT = "migration_src_hotseat_count";
// Set of entries indicating minimum size a widget can be resized to. This is used during
// restore in case the widget has not been installed yet.
private static final String KEY_MIGRATION_WIDGET_MINSIZE = "migration_widget_min_size";
// These are carefully selected weights for various item types (Math.random?), to allow for
// the least absurd migration experience.
private static final float WT_SHORTCUT = 1;
@ -81,11 +77,9 @@ public class GridSizeMigrationTask {
private final int mDestHotseatSize;
protected GridSizeMigrationTask(Context context, InvariantDeviceProfile idp,
HashSet<String> validPackages, HashMap<String, Point> widgetMinSize,
Point sourceSize, Point targetSize) {
HashSet<String> validPackages, Point sourceSize, Point targetSize) {
mContext = context;
mValidPackages = validPackages;
mWidgetMinSize.putAll(widgetMinSize);
mIdp = idp;
mSrcX = sourceSize.x;
@ -886,16 +880,6 @@ public class GridSizeMigrationTask {
return String.format(Locale.ENGLISH, "%d,%d", x, y);
}
public static void markForMigration(
Context context, HashSet<String> widgets, BackupProtos.DeviceProfieData srcProfile) {
Utilities.getPrefs(context).edit()
.putString(KEY_MIGRATION_SRC_WORKSPACE_SIZE,
getPointString((int) srcProfile.desktopCols, (int) srcProfile.desktopRows))
.putInt(KEY_MIGRATION_SRC_HOTSEAT_COUNT, (int) srcProfile.hotseatCount)
.putStringSet(KEY_MIGRATION_WIDGET_MINSIZE, widgets)
.apply();
}
/**
* Migrates the workspace and hotseat in case their sizes changed.
* @return false if the migration failed.
@ -957,14 +941,6 @@ public class GridSizeMigrationTask {
+ " to " + targetSize);
}
// Min widget sizes
HashMap<String, Point> widgetMinSize = new HashMap<>();
for (String s : Utilities.getPrefs(context).getStringSet(KEY_MIGRATION_WIDGET_MINSIZE,
Collections.<String>emptySet())) {
String[] parts = s.split("#");
widgetMinSize.put(parts[0], parsePoint(parts[1]));
}
// Migrate the workspace grid, step by step.
while (targetSizeIndex < sourceSizeIndex ) {
// We only need to migrate the grid if source size is greater
@ -974,8 +950,7 @@ public class GridSizeMigrationTask {
if (new GridSizeMigrationTask(context,
LauncherAppState.getInstance().getInvariantDeviceProfile(),
validPackages, widgetMinSize,
stepSourceSize, stepTargetSize).migrateWorkspace()) {
validPackages, stepSourceSize, stepTargetSize).migrateWorkspace()) {
dbChanged = true;
}
sourceSizeIndex--;
@ -1006,7 +981,6 @@ public class GridSizeMigrationTask {
prefs.edit()
.putString(KEY_MIGRATION_SRC_WORKSPACE_SIZE, gridSizeString)
.putInt(KEY_MIGRATION_SRC_HOTSEAT_COUNT, idp.numHotseatIcons)
.remove(KEY_MIGRATION_WIDGET_MINSIZE)
.apply();
}
}

View File

@ -47,8 +47,9 @@ public class LossyScreenMigrationTask extends GridSizeMigrationTask {
protected LossyScreenMigrationTask(
Context context, InvariantDeviceProfile idp, SQLiteDatabase db) {
// Decrease the rows count by 1
super(context, idp, getValidPackages(context), new HashMap<String, Point>(),
new Point(idp.numColumns, idp.numRows + 1), new Point(idp.numColumns, idp.numRows));
super(context, idp, getValidPackages(context),
new Point(idp.numColumns, idp.numRows + 1),
new Point(idp.numColumns, idp.numRows));
mDb = db;
mOriginalItems = new LongArrayMap<>();

View File

@ -130,7 +130,7 @@ public class GridSizeMigrationTaskTest extends ProviderTestCase2<TestLauncherPro
{ 5, 2, -1, 6},
}});
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages, new HashMap<String, Point>(),
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages,
new Point(4, 4), new Point(3, 3)).migrateWorkspace();
// Column 2 and row 2 got removed.
@ -149,7 +149,7 @@ public class GridSizeMigrationTaskTest extends ProviderTestCase2<TestLauncherPro
{ 5, 2, -1, 6},
}});
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages, new HashMap<String, Point>(),
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages,
new Point(4, 4), new Point(3, 3)).migrateWorkspace();
// Items in the second column get moved to new screen
@ -173,7 +173,7 @@ public class GridSizeMigrationTaskTest extends ProviderTestCase2<TestLauncherPro
{ 3, 1, -1, 4},
}});
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages, new HashMap<String, Point>(),
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages,
new Point(4, 4), new Point(3, 3)).migrateWorkspace();
// Items in the second column of the first screen should get placed on the 3rd
@ -204,7 +204,7 @@ public class GridSizeMigrationTaskTest extends ProviderTestCase2<TestLauncherPro
{ 5, 2, -1, 6},
}});
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages, new HashMap<String, Point>(),
new GridSizeMigrationTask(getMockContext(), mIdp, mValidPackages,
new Point(4, 4), new Point(3, 3)).migrateWorkspace();
// Items in the second column of the first screen should get placed on a new screen.