Add Browser Actions tab model selector and open a tab through it if ChromeTabbedActivity is not ava…

chrome/android/java/src/org/chromium/chrome/browser/browseractions/BrowserActionsTabCreationService.java

+// Copyright 2017 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.browser.browseractions;
+
+import android.app.NotificationManager;
+import android.app.PendingIntent;
+import android.app.Service;
+import android.content.Context;
+import android.content.Intent;
+import android.os.IBinder;
+import android.text.TextUtils;
+
+import org.chromium.base.ContextUtils;
+import org.chromium.chrome.R;
+import org.chromium.chrome.browser.document.ChromeLauncherActivity;
+import org.chromium.chrome.browser.notifications.ChromeNotificationBuilder;
+import org.chromium.chrome.browser.notifications.NotificationBuilderFactory;
+import org.chromium.chrome.browser.notifications.NotificationConstants;
+import org.chromium.chrome.browser.notifications.NotificationUmaTracker;
+import org.chromium.chrome.browser.notifications.channels.ChannelDefinitions;
+import org.chromium.chrome.browser.tab.Tab;
+import org.chromium.chrome.browser.util.IntentUtils;
+
+/**
+ * Service responsible for creating background tabs and notifications for Browser Actions.
+ */
+public class BrowserActionsTabCreationService extends Service {

[Yusuf, 2017/07/19 00:13:00]

BrowserActionsService is cleaner I think.

[ltian, 2017/08/07 23:24:11]

Done.

+    public static final String ACTION_TAB_CREATION_START =

[Yusuf, 2017/07/19 00:13:00]

Some name clarification here:

TAB_CREATION_START is more like initialize
TAB_CREATION_FINISH is more like on_tab_load_finished
TAB_CREATION_UPDATE is more like on_tab_created

does that sound accurate?

[ltian, 2017/08/07 23:24:11]

Yes, TAB_CREATION_START means start creating a tab. But at that time, tab id is
not available. TAB_CREATION_UPDATE means tab id is available, we need to update
it in the notification because for a single tab notification, clicking it will
directly opens the tab, otherwise shows the overview. TAB_CREATION_FINISH means
tab is fully loaded.

+            "org.chromium.chrome.browser.browseractions.ACTION_TAB_CREATION_START";
+    public static final String ACTION_TAB_CREATION_UPDATE =
+            "org.chromium.chrome.browser.browseractions.ACTION_TAB_CREATION_UPDATE";
+    public static final String ACTION_TAB_CREATION_FINISH =
+            "org.chromium.chrome.browser.browseractions.ACTION_TAB_CREATION_FINISH";
+
+    /**
+     * Action to request open ChromeTabbedActivity in tab switcher mode.
+     */
+    public static final String ACTION_BROWSER_ACTIONS_OPEN_IN_BACKGROUND =
+            "org.chromium.chrome.browser.browseractions.browser_action_open_in_background";
+
+    public static final String PREF_HAS_BROWSER_ACTIONS_NOTIFICATION =
+            "org.chromium.chrome.browser.browseractions.HAS_BROWSER_ACTIONS_NOTIFICATION";
+
+    /**
+     * Extra that indicates whether to show a Tab for single url or the tab switcher for
+     * multiple urls.
+     */
+    public static final String EXTRA_IS_SINGLE_URL =
+            "org.chromium.chrome.browser.browseractions.is_single_url";
+
+    private int mTitleResId = R.string.browser_actions_single_link_open_notification_title;
+
+    @Override
+    public IBinder onBind(Intent intent) {
+        return null;
+    }
+
+    @Override
+    public int onStartCommand(Intent intent, int flags, int startId) {

[Yusuf, 2017/07/19 00:13:00]

Note that onStartCommand is on the main thread and in a way you are using this
as a way to get multiple messages which might be problematic long term depending
on what operations you want to carry out below.

The right way to handle this is probably making this an IntentService which is a
started service but creates async task for handling each message on its own
behind the scenes.

Or we can also do a started service that gives out an aidl interface on bind but
I dont think that is needed here.

[ltian, 2017/08/07 23:24:11]

The problem for IntentService is it is not a foreground service. The reason we
have this foreground service is because we want the chrome process to be
foreground until a Tab is created. I think onStartCommand in here only deals
with creating notification to force the process to be foreground.

+        if (TextUtils.equals(intent.getAction(), ACTION_TAB_CREATION_START)) {
+            sendBrowserActionsNotification(Tab.INVALID_TAB_ID);
+            ContextUtils.getAppSharedPreferences()
+                    .edit()
+                    .putBoolean(PREF_HAS_BROWSER_ACTIONS_NOTIFICATION, true)
+                    .apply();
+            NotificationUmaTracker.getInstance().onNotificationShown(
+                    NotificationUmaTracker.BROWSER_ACTIONS, ChannelDefinitions.CHANNEL_ID_BROWSER);
+        } else if (TextUtils.equals(intent.getAction(), ACTION_TAB_CREATION_UPDATE)) {
+            int tabId = IntentUtils.safeGetIntExtra(
+                    intent, BrowserActionsContextMenuItemDelegate.EXTRA_TAB_ID, Tab.INVALID_TAB_ID);
+            sendBrowserActionsNotification(tabId);
+        } else if (TextUtils.equals(intent.getAction(), ACTION_TAB_CREATION_FINISH)) {
+            stopForeground(false);
+        }
+        // The service will not be restarted if Chrome get killed.
+        return START_NOT_STICKY;
+    }
+
+    private void sendBrowserActionsNotification(int tabId) {
+        ChromeNotificationBuilder builder = createNotificationBuilder(tabId);
+        startForeground(NotificationConstants.NOTIFICATION_ID_BROWSER_ACTIONS, builder.build());
+    }
+
+    private ChromeNotificationBuilder createNotificationBuilder(int tabId) {
+        ChromeNotificationBuilder builder =
+                NotificationBuilderFactory
+                        .createChromeNotificationBuilder(
+                                true /* preferCompat */, ChannelDefinitions.CHANNEL_ID_BROWSER)
+                        .setSmallIcon(R.drawable.infobar_chrome)
+                        .setLocalOnly(true)
+                        .setAutoCancel(true)
+                        .setContentText(this.getString(R.string.browser_actions_notification_text));
+        if (tabId == Tab.INVALID_TAB_ID) {
+            mTitleResId = hasBrowserActionsNotification()
+                    ? R.string.browser_actions_multi_links_open_notification_title
+                    : R.string.browser_actions_single_link_open_notification_title;
+        }
+        builder.setContentTitle(this.getString(mTitleResId));
+        Intent intent = buildNotificationIntent(tabId);
+        PendingIntent notifyPendingIntent =
+                PendingIntent.getActivity(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT);
+        builder.setContentIntent(notifyPendingIntent);
+        return builder;
+    }
+
+    private Intent buildNotificationIntent(int tabId) {
+        boolean multipleUrls = hasBrowserActionsNotification();
+        if (!multipleUrls && tabId != Tab.INVALID_TAB_ID) {
+            return Tab.createBringTabToFrontIntent(tabId);
+        }
+        Intent intent = new Intent(this, ChromeLauncherActivity.class);
+        intent.setAction(ACTION_BROWSER_ACTIONS_OPEN_IN_BACKGROUND);
+        intent.putExtra(EXTRA_IS_SINGLE_URL, !multipleUrls);
+        return intent;
+    }
+
+    private boolean hasBrowserActionsNotification() {
+        return ContextUtils.getAppSharedPreferences().getBoolean(
+                PREF_HAS_BROWSER_ACTIONS_NOTIFICATION, false);
+    }
+
+    /**
+     * Cancel Browser Actions notification.
+     */
+    public static void cancelBrowserActionsNotification() {
+        NotificationManager notificationManager =
+                (NotificationManager) ContextUtils.getApplicationContext().getSystemService(
+                        Context.NOTIFICATION_SERVICE);
+        notificationManager.cancel(NotificationConstants.NOTIFICATION_ID_BROWSER_ACTIONS);
+        ContextUtils.getAppSharedPreferences()
+                .edit()
+                .putBoolean(PREF_HAS_BROWSER_ACTIONS_NOTIFICATION, false)
+                .apply();
+    }
+
+    /**
+     * Checks whether Chrome should display tab switcher via Browser Actions Intent.
+     * @param intent The intent to open the Chrome.
+     * @param isOverviewVisible Whether tab switcher is shown.
+     */
+    public static boolean toggleOverviewByBrowserActions(Intent intent, boolean isOverviewVisible) {
+        boolean fromBrowserActions = isStartedByBrowserActions(intent);
+        boolean isSingleUrl = IntentUtils.safeGetBooleanExtra(intent, EXTRA_IS_SINGLE_URL, false);
+        if (fromBrowserActions) {
+            return isSingleUrl == isOverviewVisible;
+        }
+        return false;
+    }
+
+    private static boolean isStartedByBrowserActions(Intent intent) {
+        if (ACTION_BROWSER_ACTIONS_OPEN_IN_BACKGROUND.equals(intent.getAction())) {
+            return true;
+        }
+        return false;
+    }
+
+    /**
+     * Returns {@link Intent} to update the notification and the status of the service.
+     * @param action The actions of the Intent.
+     */
+    public static Intent getTabCreationIntent(String action) {

[Yusuf, 2017/07/19 00:13:00]

this can handle all that is necessary in itself, taking the action, creating the
intent and then calling startService with that. I think that will avoid
repetition and be cleaner.

[ltian, 2017/08/07 23:24:11]

Done.

+        Intent intent = new Intent(
+                ContextUtils.getApplicationContext(), BrowserActionsTabCreationService.class);
+        intent.setAction(action);
+        return intent;
+    }
+}