Add setup wizard launcher icon

The setup wizard icon will be hidden if the Android Keyboard is in
system image.

Bug: 8239067
Change-Id: Ib0c0c9e3a0954512c3e03e42a661cdf86eff0dca

1 files changed, 125 insertions, 0 deletions

diff --git a/java/src/com/android/inputmethod/latin/setup/LauncherIconVisibilityManager.java b/java/src/com/android/inputmethod/latin/setup/LauncherIconVisibilityManager.java
new file mode 100644
index 000000000..ad34011ea
--- /dev/null
+++ b/java/src/com/android/inputmethod/latin/setup/LauncherIconVisibilityManager.java
@@ -0,0 +1,125 @@
+/*
+ * 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.inputmethod.latin.setup;
+
+import android.app.Activity;
+import android.content.BroadcastReceiver;
+import android.content.ComponentName;
+import android.content.Context;
+import android.content.Intent;
+import android.content.pm.ApplicationInfo;
+import android.content.pm.PackageManager;
+import android.os.Process;
+import android.util.Log;
+
+import com.android.inputmethod.compat.IntentCompatUtils;
+import com.android.inputmethod.latin.RichInputMethodManager;
+
+/**
+ * This class detects the {@link Intent#ACTION_MY_PACKAGE_REPLACED} broadcast intent when this IME
+ * package has been replaced by a newer version of the same package. This class also detects
+ * {@link Intent#ACTION_BOOT_COMPLETED} and {@link Intent#ACTION_USER_INITIALIZE} broadcast intent.
+ *
+ * If this IME has already been installed in the system image and a new version of this IME has
+ * been installed, {@link Intent#ACTION_MY_PACKAGE_REPLACED} is received by this receiver and it
+ * will hide the setup wizard's icon.
+ *
+ * If this IME has already been installed in the data partition and a new version of this IME has
+ * been installed, {@link Intent#ACTION_MY_PACKAGE_REPLACED} is received by this receiver but it
+ * will not hide the setup wizard's icon, and the icon will appear on the launcher.
+ *
+ * If this IME hasn't been installed yet and has been newly installed, no
+ * {@link Intent#ACTION_MY_PACKAGE_REPLACED} will be sent and the setup wizard's icon will appear
+ * on the launcher.
+ *
+ * When the device has been booted, {@link Intent#ACTION_BOOT_COMPLETED} is received by this
+ * receiver and it checks whether the setup wizard's icon should be appeared or not on the launcher
+ * depending on which partition this IME is installed.
+ *
+ * When a multiuser account has been created, {@link Intent#ACTION_USER_INITIALIZE} is received
+ * by this receiver and it checks the whether the setup wizard's icon should be appeared or not on
+ * the launcher depending on which partition this IME is installed.
+ */
+public final class LauncherIconVisibilityManager extends BroadcastReceiver {
+    private static final String TAG = LauncherIconVisibilityManager.class.getSimpleName();
+
+    @Override
+    public void onReceive(final Context context, final Intent intent) {
+        if (shouldHandleThisIntent(intent, context)) {
+            if (isInSystemImage(context)) {
+                disableActivity(context, SetupActivity.class);
+            } else {
+                Log.i(TAG, "This package isn't in system image: " + context.getPackageName());
+            }
+        }
+
+        // The process that hosts this broadcast receiver is invoked and remains alive even after
+        // 1) the package has been re-installed, 2) the device has been booted,
+        // 3) a multiuser has been created.
+        // There is no good reason to keep the process alive if this IME isn't a current IME.
+        RichInputMethodManager.init(context);
+        if (!SetupActivity.isThisImeCurrent(context)) {
+            final int myPid = Process.myPid();
+            Log.i(TAG, "Killing my process: pid=" + myPid);
+            Process.killProcess(myPid);
+        }
+    }
+
+    private static boolean shouldHandleThisIntent(final Intent intent, final Context context) {
+        final String action = intent.getAction();
+        if (Intent.ACTION_MY_PACKAGE_REPLACED.equals(action)) {
+            Log.i(TAG, "Package has been replaced: " + context.getPackageName());
+            return true;
+        } else if (Intent.ACTION_BOOT_COMPLETED.equals(action)) {
+            Log.i(TAG, "Boot has been completed");
+            return true;
+        } else if (IntentCompatUtils.has_ACTION_USER_INITIALIZE(intent)) {
+            Log.i(TAG, "User initialize");
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Disable an activity of the specified package. Disabling an activity will also hide its
+     * icon from the launcher.
+     *
+     * @param context package context of an activity to be disabled
+     * @param activityClass activity class to be disabled
+     */
+    private static void disableActivity(final Context context,
+            final Class<? extends Activity> activityClass) {
+        final ComponentName activityComponent = new ComponentName(context, activityClass);
+        final PackageManager pm = context.getPackageManager();
+        final int activityComponentState = pm.getComponentEnabledSetting(activityComponent);
+        if (activityComponentState == PackageManager.COMPONENT_ENABLED_STATE_DISABLED) {
+            // This activity is already disabled.
+            Log.i(TAG, "Activity has already been disabled: " + activityComponent);
+            return;
+        }
+        // Disabling an activity will also hide its icon from the launcher.
+        pm.setComponentEnabledSetting(activityComponent,
+                PackageManager.COMPONENT_ENABLED_STATE_DISABLED,
+                PackageManager.DONT_KILL_APP);
+        Log.i(TAG, "Disable activity: " + activityComponent);
+    }
+
+    private static boolean isInSystemImage(final Context context) {
+        final ApplicationInfo appInfo = context.getApplicationInfo();
+        return (appInfo.flags & ApplicationInfo.FLAG_SYSTEM) != 0;
+    }
+}