| /* |
| * Copyright (C) 2009 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 static android.app.Activity.RESULT_CANCELED; |
| |
| import android.appwidget.AppWidgetHost; |
| import android.appwidget.AppWidgetHostView; |
| import android.appwidget.AppWidgetManager; |
| import android.appwidget.AppWidgetProviderInfo; |
| import android.content.ActivityNotFoundException; |
| import android.content.Context; |
| import android.content.Intent; |
| import android.os.Handler; |
| import android.util.SparseArray; |
| import android.widget.Toast; |
| |
| import com.android.launcher3.model.WidgetsModel; |
| import com.android.launcher3.testing.TestLogging; |
| import com.android.launcher3.testing.TestProtocol; |
| import com.android.launcher3.widget.DeferredAppWidgetHostView; |
| import com.android.launcher3.widget.LauncherAppWidgetHostView; |
| import com.android.launcher3.widget.PendingAppWidgetHostView; |
| import com.android.launcher3.widget.custom.CustomWidgetManager; |
| |
| import java.util.ArrayList; |
| import java.util.function.IntConsumer; |
| |
| |
| /** |
| * Specific {@link AppWidgetHost} that creates our {@link LauncherAppWidgetHostView} |
| * which correctly captures all long-press events. This ensures that users can |
| * always pick up and move widgets. |
| */ |
| public class LauncherAppWidgetHost extends AppWidgetHost { |
| |
| private static final int FLAG_LISTENING = 1; |
| private static final int FLAG_RESUMED = 1 << 1; |
| private static final int FLAG_LISTEN_IF_RESUMED = 1 << 2; |
| |
| public static final int APPWIDGET_HOST_ID = 1024; |
| |
| private final ArrayList<ProviderChangedListener> mProviderChangeListeners = new ArrayList<>(); |
| private final SparseArray<LauncherAppWidgetHostView> mViews = new SparseArray<>(); |
| private final SparseArray<PendingAppWidgetHostView> mPendingViews = new SparseArray<>(); |
| |
| private final Context mContext; |
| private int mFlags = FLAG_RESUMED; |
| |
| private IntConsumer mAppWidgetRemovedCallback = null; |
| |
| |
| public LauncherAppWidgetHost(Context context) { |
| this(context, null); |
| } |
| |
| public LauncherAppWidgetHost(Context context, |
| IntConsumer appWidgetRemovedCallback) { |
| super(context, APPWIDGET_HOST_ID); |
| mContext = context; |
| mAppWidgetRemovedCallback = appWidgetRemovedCallback; |
| } |
| |
| @Override |
| protected LauncherAppWidgetHostView onCreateView(Context context, int appWidgetId, |
| AppWidgetProviderInfo appWidget) { |
| final LauncherAppWidgetHostView view; |
| if (mPendingViews.get(appWidgetId) != null) { |
| view = mPendingViews.get(appWidgetId); |
| mPendingViews.remove(appWidgetId); |
| } else { |
| view = new LauncherAppWidgetHostView(context); |
| } |
| mViews.put(appWidgetId, view); |
| return view; |
| } |
| |
| @Override |
| public void startListening() { |
| if (WidgetsModel.GO_DISABLE_WIDGETS) { |
| return; |
| } |
| mFlags |= FLAG_LISTENING; |
| try { |
| super.startListening(); |
| } catch (Exception e) { |
| if (!Utilities.isBinderSizeError(e)) { |
| throw new RuntimeException(e); |
| } |
| // We're willing to let this slide. The exception is being caused by the list of |
| // RemoteViews which is being passed back. The startListening relationship will |
| // have been established by this point, and we will end up populating the |
| // widgets upon bind anyway. See issue 14255011 for more context. |
| } |
| |
| // We go in reverse order and inflate any deferred widget |
| for (int i = mViews.size() - 1; i >= 0; i--) { |
| LauncherAppWidgetHostView view = mViews.valueAt(i); |
| if (view instanceof DeferredAppWidgetHostView) { |
| view.reInflate(); |
| } |
| } |
| } |
| |
| @Override |
| public void stopListening() { |
| if (WidgetsModel.GO_DISABLE_WIDGETS) { |
| return; |
| } |
| mFlags &= ~FLAG_LISTENING; |
| super.stopListening(); |
| } |
| |
| public boolean isListening() { |
| return (mFlags & FLAG_LISTENING) != 0; |
| } |
| |
| /** |
| * Updates the resumed state of the host. |
| * When a host is not resumed, it defers calls to startListening until host is resumed again. |
| * But if the host was already listening, it will not call stopListening. |
| * |
| * @see #setListenIfResumed(boolean) |
| */ |
| public void setResumed(boolean isResumed) { |
| if (isResumed == ((mFlags & FLAG_RESUMED) != 0)) { |
| return; |
| } |
| if (isResumed) { |
| mFlags |= FLAG_RESUMED; |
| // Start listening if we were supposed to start listening on resume |
| if ((mFlags & FLAG_LISTEN_IF_RESUMED) != 0 && (mFlags & FLAG_LISTENING) == 0) { |
| startListening(); |
| } |
| } else { |
| mFlags &= ~FLAG_RESUMED; |
| } |
| } |
| |
| /** |
| * Updates the listening state of the host. If the host is not resumed, startListening is |
| * deferred until next resume. |
| * |
| * @see #setResumed(boolean) |
| */ |
| public void setListenIfResumed(boolean listenIfResumed) { |
| if (listenIfResumed == ((mFlags & FLAG_LISTEN_IF_RESUMED) != 0)) { |
| return; |
| } |
| if (listenIfResumed) { |
| mFlags |= FLAG_LISTEN_IF_RESUMED; |
| if ((mFlags & FLAG_RESUMED) != 0) { |
| // If we are resumed, start listening immediately. Note we do not check for |
| // duplicate calls before calling startListening as startListening is safe to call |
| // multiple times. |
| startListening(); |
| } |
| } else { |
| mFlags &= ~FLAG_LISTEN_IF_RESUMED; |
| stopListening(); |
| } |
| } |
| |
| @Override |
| public int allocateAppWidgetId() { |
| if (WidgetsModel.GO_DISABLE_WIDGETS) { |
| return AppWidgetManager.INVALID_APPWIDGET_ID; |
| } |
| |
| return super.allocateAppWidgetId(); |
| } |
| |
| public void addProviderChangeListener(ProviderChangedListener callback) { |
| mProviderChangeListeners.add(callback); |
| } |
| |
| public void removeProviderChangeListener(ProviderChangedListener callback) { |
| mProviderChangeListeners.remove(callback); |
| } |
| |
| protected void onProvidersChanged() { |
| if (!mProviderChangeListeners.isEmpty()) { |
| for (ProviderChangedListener callback : new ArrayList<>(mProviderChangeListeners)) { |
| callback.notifyWidgetProvidersChanged(); |
| } |
| } |
| } |
| |
| void addPendingView(int appWidgetId, PendingAppWidgetHostView view) { |
| mPendingViews.put(appWidgetId, view); |
| } |
| |
| public AppWidgetHostView createView(Context context, int appWidgetId, |
| LauncherAppWidgetProviderInfo appWidget) { |
| if (appWidget.isCustomWidget()) { |
| LauncherAppWidgetHostView lahv = new LauncherAppWidgetHostView(context); |
| lahv.setAppWidget(0, appWidget); |
| CustomWidgetManager.INSTANCE.get(context).onViewCreated(lahv); |
| return lahv; |
| } else if ((mFlags & FLAG_LISTENING) == 0) { |
| DeferredAppWidgetHostView view = new DeferredAppWidgetHostView(context); |
| view.setAppWidget(appWidgetId, appWidget); |
| mViews.put(appWidgetId, view); |
| return view; |
| } else { |
| try { |
| return super.createView(context, appWidgetId, appWidget); |
| } catch (Exception e) { |
| if (!Utilities.isBinderSizeError(e)) { |
| throw new RuntimeException(e); |
| } |
| |
| // If the exception was thrown while fetching the remote views, let the view stay. |
| // This will ensure that if the widget posts a valid update later, the view |
| // will update. |
| LauncherAppWidgetHostView view = mViews.get(appWidgetId); |
| if (view == null) { |
| view = onCreateView(mContext, appWidgetId, appWidget); |
| } |
| view.setAppWidget(appWidgetId, appWidget); |
| view.switchToErrorView(); |
| return view; |
| } |
| } |
| } |
| |
| /** |
| * Called when the AppWidget provider for a AppWidget has been upgraded to a new apk. |
| */ |
| @Override |
| protected void onProviderChanged(int appWidgetId, AppWidgetProviderInfo appWidget) { |
| LauncherAppWidgetProviderInfo info = LauncherAppWidgetProviderInfo.fromProviderInfo( |
| mContext, appWidget); |
| super.onProviderChanged(appWidgetId, info); |
| // The super method updates the dimensions of the providerInfo. Update the |
| // launcher spans accordingly. |
| info.initSpans(mContext); |
| } |
| |
| /** |
| * Called on an appWidget is removed for a widgetId |
| * |
| * @param appWidgetId TODO: make this override when SDK is updated |
| */ |
| public void onAppWidgetRemoved(int appWidgetId) { |
| if (mAppWidgetRemovedCallback == null) { |
| return; |
| } |
| mAppWidgetRemovedCallback.accept(appWidgetId); |
| } |
| |
| @Override |
| public void deleteAppWidgetId(int appWidgetId) { |
| super.deleteAppWidgetId(appWidgetId); |
| mViews.remove(appWidgetId); |
| } |
| |
| @Override |
| public void clearViews() { |
| super.clearViews(); |
| mViews.clear(); |
| } |
| |
| public void startBindFlow(BaseActivity activity, |
| int appWidgetId, AppWidgetProviderInfo info, int requestCode) { |
| |
| if (WidgetsModel.GO_DISABLE_WIDGETS) { |
| sendActionCancelled(activity, requestCode); |
| return; |
| } |
| |
| Intent intent = new Intent(AppWidgetManager.ACTION_APPWIDGET_BIND) |
| .putExtra(AppWidgetManager.EXTRA_APPWIDGET_ID, appWidgetId) |
| .putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER, info.provider) |
| .putExtra(AppWidgetManager.EXTRA_APPWIDGET_PROVIDER_PROFILE, info.getProfile()); |
| // TODO: we need to make sure that this accounts for the options bundle. |
| // intent.putExtra(AppWidgetManager.EXTRA_APPWIDGET_OPTIONS, options); |
| activity.startActivityForResult(intent, requestCode); |
| } |
| |
| |
| public void startConfigActivity(BaseActivity activity, int widgetId, int requestCode) { |
| if (WidgetsModel.GO_DISABLE_WIDGETS) { |
| sendActionCancelled(activity, requestCode); |
| return; |
| } |
| |
| try { |
| TestLogging.recordEvent(TestProtocol.SEQUENCE_MAIN, "start: startConfigActivity"); |
| startAppWidgetConfigureActivityForResult(activity, widgetId, 0, requestCode, null); |
| } catch (ActivityNotFoundException | SecurityException e) { |
| Toast.makeText(activity, R.string.activity_not_found, Toast.LENGTH_SHORT).show(); |
| sendActionCancelled(activity, requestCode); |
| } |
| } |
| |
| private void sendActionCancelled(final BaseActivity activity, final int requestCode) { |
| new Handler().post(() -> activity.onActivityResult(requestCode, RESULT_CANCELED, null)); |
| } |
| |
| /** |
| * Listener for getting notifications on provider changes. |
| */ |
| public interface ProviderChangedListener { |
| |
| void notifyWidgetProvidersChanged(); |
| } |
| } |