Restoring pinned shortcuts to original state after restore
Creating an no-op backup agent in settings. This ensures that
we get onRestoreFinished callback after restore is finished where we
can update all pinned shortcuts.
Bug: 110016648
Test: Verified backup->clear-data->restore path on device
Change-Id: Id14d0792d60ba08d97078a31a81d2b63ab8ce109
diff --git a/AndroidManifest.xml b/AndroidManifest.xml
index 764e1d2..9983d62 100644
--- a/AndroidManifest.xml
+++ b/AndroidManifest.xml
@@ -108,7 +108,7 @@
android:hardwareAccelerated="true"
android:requiredForAllUsers="true"
android:supportsRtl="true"
- android:allowBackup="false"
+ android:backupAgent="com.android.settings.backup.SettingsBackupHelper"
android:usesCleartextTraffic="true"
android:defaultToDeviceProtectedStorage="true"
android:directBootAware="true"
diff --git a/src/com/android/settings/backup/SettingsBackupHelper.java b/src/com/android/settings/backup/SettingsBackupHelper.java
new file mode 100644
index 0000000..92612b0
--- /dev/null
+++ b/src/com/android/settings/backup/SettingsBackupHelper.java
@@ -0,0 +1,89 @@
+/**
+ * Copyright (C) 2019 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.settings.backup;
+
+import android.app.backup.BackupAgentHelper;
+import android.app.backup.BackupDataInputStream;
+import android.app.backup.BackupDataOutput;
+import android.app.backup.BackupHelper;
+import android.os.ParcelFileDescriptor;
+
+import com.android.settings.shortcut.CreateShortcutPreferenceController;
+
+import java.io.FileInputStream;
+import java.io.FileOutputStream;
+import java.io.IOException;
+
+/**
+ * Backup agent for Settings APK
+ */
+public class SettingsBackupHelper extends BackupAgentHelper {
+
+ @Override
+ public void onCreate() {
+ super.onCreate();
+ addHelper("no-op", new NoOpHelper());
+ }
+
+ @Override
+ public void onRestoreFinished() {
+ super.onRestoreFinished();
+ CreateShortcutPreferenceController.updateRestoredShortcuts(this);
+ }
+
+ /**
+ * Backup helper which does not do anything. Having at least one helper ensures that the
+ * transport is not empty and onRestoreFinished is called eventually.
+ */
+ private static class NoOpHelper implements BackupHelper {
+
+ private final int VERSION_CODE = 1;
+
+ @Override
+ public void performBackup(ParcelFileDescriptor oldState, BackupDataOutput data,
+ ParcelFileDescriptor newState) {
+
+ try (FileOutputStream out = new FileOutputStream(newState.getFileDescriptor())) {
+ if (getVersionCode(oldState) != VERSION_CODE) {
+ data.writeEntityHeader("dummy", 1);
+ data.writeEntityData(new byte[1], 1);
+ }
+
+ // Write new version code
+ out.write(VERSION_CODE);
+ out.flush();
+ } catch (IOException e) { }
+ }
+
+ @Override
+ public void restoreEntity(BackupDataInputStream data) { }
+
+ @Override
+ public void writeNewStateDescription(ParcelFileDescriptor newState) { }
+
+ private int getVersionCode(ParcelFileDescriptor state) {
+ if (state == null) {
+ return 0;
+ }
+ try (FileInputStream in = new FileInputStream(state.getFileDescriptor())) {
+ return in.read();
+ } catch (IOException e) {
+ return 0;
+ }
+ }
+ }
+}
diff --git a/src/com/android/settings/shortcut/CreateShortcutPreferenceController.java b/src/com/android/settings/shortcut/CreateShortcutPreferenceController.java
index 9b9de5f..6b95b92 100644
--- a/src/com/android/settings/shortcut/CreateShortcutPreferenceController.java
+++ b/src/com/android/settings/shortcut/CreateShortcutPreferenceController.java
@@ -38,11 +38,6 @@
import android.view.View;
import android.widget.ImageView;
-import androidx.annotation.VisibleForTesting;
-import androidx.preference.Preference;
-import androidx.preference.PreferenceCategory;
-import androidx.preference.PreferenceGroup;
-
import com.android.settings.R;
import com.android.settings.Settings.TetherSettingsActivity;
import com.android.settings.core.BasePreferenceController;
@@ -54,6 +49,11 @@
import java.util.Comparator;
import java.util.List;
+import androidx.annotation.VisibleForTesting;
+import androidx.preference.Preference;
+import androidx.preference.PreferenceCategory;
+import androidx.preference.PreferenceGroup;
+
/**
* {@link BasePreferenceController} that populates a list of widgets that Settings app support.
*/
@@ -143,24 +143,7 @@
@VisibleForTesting
Intent createResultIntent(Intent shortcutIntent, ResolveInfo resolveInfo,
CharSequence label) {
- final ActivityInfo activityInfo = resolveInfo.activityInfo;
-
- final Icon maskableIcon;
- if (activityInfo.icon != 0 && activityInfo.applicationInfo != null) {
- maskableIcon = Icon.createWithAdaptiveBitmap(createIcon(
- activityInfo.applicationInfo, activityInfo.icon,
- R.layout.shortcut_badge_maskable,
- mContext.getResources().getDimensionPixelSize(R.dimen.shortcut_size_maskable)));
- } else {
- maskableIcon = Icon.createWithResource(mContext, R.drawable.ic_launcher_settings);
- }
- final String shortcutId = SHORTCUT_ID_PREFIX +
- shortcutIntent.getComponent().flattenToShortString();
- ShortcutInfo info = new ShortcutInfo.Builder(mContext, shortcutId)
- .setShortLabel(label)
- .setIntent(shortcutIntent)
- .setIcon(maskableIcon)
- .build();
+ ShortcutInfo info = createShortcutInfo(mContext, shortcutIntent, resolveInfo, label);
Intent intent = mShortcutManager.createShortcutResultIntent(info);
if (intent == null) {
intent = new Intent();
@@ -170,8 +153,10 @@
.putExtra(Intent.EXTRA_SHORTCUT_INTENT, shortcutIntent)
.putExtra(Intent.EXTRA_SHORTCUT_NAME, label);
+ final ActivityInfo activityInfo = resolveInfo.activityInfo;
if (activityInfo.icon != 0) {
intent.putExtra(Intent.EXTRA_SHORTCUT_ICON, createIcon(
+ mContext,
activityInfo.applicationInfo,
activityInfo.icon,
R.layout.shortcut_badge,
@@ -217,15 +202,40 @@
info.activityInfo.name);
}
- private Intent buildShortcutIntent(ResolveInfo info) {
+ private static Intent buildShortcutIntent(ResolveInfo info) {
return new Intent(SHORTCUT_PROBE)
.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK | Intent.FLAG_ACTIVITY_CLEAR_TOP)
.setClassName(info.activityInfo.packageName, info.activityInfo.name);
}
- private Bitmap createIcon(ApplicationInfo app, int resource, int layoutRes, int size) {
- final Context context = new ContextThemeWrapper(mContext, android.R.style.Theme_Material);
- final View view = LayoutInflater.from(context).inflate(layoutRes, null);
+ private static ShortcutInfo createShortcutInfo(Context context, Intent shortcutIntent,
+ ResolveInfo resolveInfo, CharSequence label) {
+ final ActivityInfo activityInfo = resolveInfo.activityInfo;
+
+ final Icon maskableIcon;
+ if (activityInfo.icon != 0 && activityInfo.applicationInfo != null) {
+ maskableIcon = Icon.createWithAdaptiveBitmap(createIcon(
+ context,
+ activityInfo.applicationInfo, activityInfo.icon,
+ R.layout.shortcut_badge_maskable,
+ context.getResources().getDimensionPixelSize(R.dimen.shortcut_size_maskable)));
+ } else {
+ maskableIcon = Icon.createWithResource(context, R.drawable.ic_launcher_settings);
+ }
+ final String shortcutId = SHORTCUT_ID_PREFIX +
+ shortcutIntent.getComponent().flattenToShortString();
+ return new ShortcutInfo.Builder(context, shortcutId)
+ .setShortLabel(label)
+ .setIntent(shortcutIntent)
+ .setIcon(maskableIcon)
+ .build();
+ }
+
+ private static Bitmap createIcon(Context context, ApplicationInfo app, int resource,
+ int layoutRes, int size) {
+ final Context themedContext = new ContextThemeWrapper(context,
+ android.R.style.Theme_Material);
+ final View view = LayoutInflater.from(themedContext).inflate(layoutRes, null);
final int spec = View.MeasureSpec.makeMeasureSpec(size, View.MeasureSpec.EXACTLY);
view.measure(spec, spec);
final Bitmap bitmap = Bitmap.createBitmap(view.getMeasuredWidth(), view.getMeasuredHeight(),
@@ -234,14 +244,15 @@
Drawable iconDrawable;
try {
- iconDrawable = mPackageManager.getResourcesForApplication(app).getDrawable(resource);
+ iconDrawable = context.getPackageManager().getResourcesForApplication(app)
+ .getDrawable(resource);
if (iconDrawable instanceof LayerDrawable) {
iconDrawable = ((LayerDrawable) iconDrawable).getDrawable(1);
}
((ImageView) view.findViewById(android.R.id.icon)).setImageDrawable(iconDrawable);
} catch (PackageManager.NameNotFoundException e) {
Log.w(TAG, "Cannot load icon from app " + app + ", returning a default icon");
- Icon icon = Icon.createWithResource(mContext, R.drawable.ic_launcher_settings);
+ Icon icon = Icon.createWithResource(context, R.drawable.ic_launcher_settings);
((ImageView) view.findViewById(android.R.id.icon)).setImageIcon(icon);
}
@@ -250,12 +261,24 @@
return bitmap;
}
- private static final Comparator<ResolveInfo> SHORTCUT_COMPARATOR =
- new Comparator<ResolveInfo>() {
+ public static void updateRestoredShortcuts(Context context) {
+ ShortcutManager sm = context.getSystemService(ShortcutManager.class);
+ List<ShortcutInfo> updatedShortcuts = new ArrayList<>();
+ for (ShortcutInfo si : sm.getPinnedShortcuts()) {
+ if (si.getId().startsWith(SHORTCUT_ID_PREFIX)) {
+ ResolveInfo ri = context.getPackageManager().resolveActivity(si.getIntent(), 0);
- @Override
- public int compare(ResolveInfo i1, ResolveInfo i2) {
- return i1.priority - i2.priority;
+ if (ri != null) {
+ updatedShortcuts.add(createShortcutInfo(context, buildShortcutIntent(ri), ri,
+ si.getShortLabel()));
}
- };
+ }
+ }
+ if (!updatedShortcuts.isEmpty()) {
+ sm.updateShortcuts(updatedShortcuts);
+ }
+ }
+
+ private static final Comparator<ResolveInfo> SHORTCUT_COMPARATOR =
+ (i1, i2) -> i1.priority - i2.priority;
}