Mypal/mobile/android/search/java/org/mozilla/search/SearchWidget.java

/* -*- Mode: Java; c-basic-offset: 4; tab-width: 4; indent-tabs-mode: nil; -*-
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

package org.mozilla.search;

import org.mozilla.gecko.AboutPages;
import org.mozilla.gecko.AppConstants;
import org.mozilla.gecko.R;
import org.mozilla.gecko.Telemetry;
import org.mozilla.gecko.TelemetryContract;

import android.annotation.TargetApi;
import android.app.PendingIntent;
import android.appwidget.AppWidgetManager;
import android.appwidget.AppWidgetProvider;
import android.appwidget.AppWidgetProviderInfo;
import android.content.Context;
import android.content.Intent;
import android.net.Uri;
import android.os.Bundle;
import android.widget.RemoteViews;

/* Provides a really simple widget with two buttons, one to launch Fennec
 * and one to launch the search activity. All intents are actually sent back
 * here and then forwarded on to start the real activity. */
public class SearchWidget extends AppWidgetProvider {
    final private static String LOGTAG = "GeckoSearchWidget";

    final public static String ACTION_LAUNCH_BROWSER = "org.mozilla.widget.LAUNCH_BROWSER";
    final public static String ACTION_LAUNCH_SEARCH = "org.mozilla.widget.LAUNCH_SEARCH";
    final public static String ACTION_LAUNCH_NEW_TAB = "org.mozilla.widget.LAUNCH_NEW_TAB";

    @TargetApi(16)
    @Override
    public void onUpdate(final Context context, final AppWidgetManager manager, final int[] ids) {
        for (int id : ids) {
            final Bundle bundle;
            if (AppConstants.Versions.feature16Plus) {
                bundle = manager.getAppWidgetOptions(id);
            } else {
                bundle = null;
            }
            addView(manager, context, id, bundle);
        }

        super.onUpdate(context, manager, ids);
    }

    @TargetApi(16)
    @Override
    public void onAppWidgetOptionsChanged(final Context context,
                                          final AppWidgetManager manager,
                                          final int id,
                                          final Bundle options) {
        addView(manager, context, id, options);
        if (AppConstants.Versions.feature16Plus) {
            super.onAppWidgetOptionsChanged(context, manager, id, options);
        }
    }

    @Override
    public void onReceive(final Context context, final Intent intent) {
        // This will hold the intent to redispatch.
        final Intent redirect;
        switch (intent.getAction()) {
            case ACTION_LAUNCH_BROWSER:
                redirect = buildRedirectIntent(Intent.ACTION_MAIN,
                                               context.getPackageName(),
                                               AppConstants.MOZ_ANDROID_BROWSER_INTENT_CLASS,
                                               intent);
                Telemetry.sendUIEvent(TelemetryContract.Event.LAUNCH,
                                      TelemetryContract.Method.WIDGET, "browser");
                break;
            case ACTION_LAUNCH_NEW_TAB:
                redirect = buildRedirectIntent(Intent.ACTION_VIEW,
                                               context.getPackageName(),
                                               AppConstants.MOZ_ANDROID_BROWSER_INTENT_CLASS,
                                               intent);
                Telemetry.sendUIEvent(TelemetryContract.Event.LAUNCH,
                                      TelemetryContract.Method.WIDGET, "new-tab");
                break;
            case ACTION_LAUNCH_SEARCH:
                redirect = buildRedirectIntent(Intent.ACTION_VIEW,
                                               context.getPackageName(),
                                               AppConstants.MOZ_ANDROID_SEARCH_INTENT_CLASS,
                                               intent);
                Telemetry.sendUIEvent(TelemetryContract.Event.LAUNCH,
                                      TelemetryContract.Method.WIDGET, "search");
                break;
            default:
                redirect = null;
        }

        if (redirect != null) {
            context.startActivity(redirect);
        }

        super.onReceive(context, intent);
    }

    // Utility to create the view for this widget and attach any event listeners to it
    private void addView(final AppWidgetManager manager, final Context context, final int id, final Bundle options) {
        final RemoteViews views = new RemoteViews(context.getPackageName(), R.layout.search_widget);

        addClickIntent(context, views, R.id.search_button, ACTION_LAUNCH_SEARCH);
        addClickIntent(context, views, R.id.new_tab_button, ACTION_LAUNCH_NEW_TAB);
        // Clicking the logo also launches the browser
        addClickIntent(context, views, R.id.logo_button, ACTION_LAUNCH_BROWSER);

        manager.updateAppWidget(id, views);
    }

    // Utility for adding a pending intent to be fired when a View is clicked.
    private void addClickIntent(final Context context, final RemoteViews views, final int viewId, final String action) {
        final Intent intent = new Intent(context, SearchWidget.class);
        intent.setAction(action);
        intent.setData(Uri.parse(AboutPages.HOME));
        final PendingIntent pendingIntent = PendingIntent.getBroadcast(context, 0, intent, 0);
        views.setOnClickPendingIntent(viewId, pendingIntent);
    }

    // Utility for building an intent to be redispatched (i.e. to launch the browser or the search intent).
    private Intent buildRedirectIntent(final String action, final String pkg, final String className, final Intent source) {
        final Intent activity = new Intent(action);
        if (pkg != null && className != null) {
            activity.setClassName(pkg, className);
        }
        activity.setData(source.getData());
        activity.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK);
        return activity;
    }

}