1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.launcher3;
18
19import android.appwidget.AppWidgetHost;
20import android.appwidget.AppWidgetHostView;
21import android.appwidget.AppWidgetProviderInfo;
22import android.content.Context;
23import android.util.SparseArray;
24import android.view.LayoutInflater;
25
26import java.util.ArrayList;
27
28
29/**
30 * Specific {@link AppWidgetHost} that creates our {@link LauncherAppWidgetHostView}
31 * which correctly captures all long-press events. This ensures that users can
32 * always pick up and move widgets.
33 */
34public class LauncherAppWidgetHost extends AppWidgetHost {
35
36    private final ArrayList<Runnable> mProviderChangeListeners = new ArrayList<Runnable>();
37    private final SparseArray<LauncherAppWidgetHostView> mViews = new SparseArray<>();
38
39    private Launcher mLauncher;
40
41    public LauncherAppWidgetHost(Launcher launcher, int hostId) {
42        super(launcher, hostId);
43        mLauncher = launcher;
44    }
45
46    @Override
47    protected LauncherAppWidgetHostView onCreateView(Context context, int appWidgetId,
48            AppWidgetProviderInfo appWidget) {
49        LauncherAppWidgetHostView view = new LauncherAppWidgetHostView(context);
50        mViews.put(appWidgetId, view);
51        return view;
52    }
53
54    @Override
55    public void startListening() {
56        try {
57            super.startListening();
58        } catch (Exception e) {
59            if (!Utilities.isBinderSizeError(e)) {
60                throw new RuntimeException(e);
61            }
62            // We're willing to let this slide. The exception is being caused by the list of
63            // RemoteViews which is being passed back. The startListening relationship will
64            // have been established by this point, and we will end up populating the
65            // widgets upon bind anyway. See issue 14255011 for more context.
66        }
67    }
68
69    public void addProviderChangeListener(Runnable callback) {
70        mProviderChangeListeners.add(callback);
71    }
72
73    public void removeProviderChangeListener(Runnable callback) {
74        mProviderChangeListeners.remove(callback);
75    }
76
77    protected void onProvidersChanged() {
78        if (!mProviderChangeListeners.isEmpty()) {
79            for (Runnable callback : new ArrayList<>(mProviderChangeListeners)) {
80                callback.run();
81            }
82        }
83
84        if (Utilities.ATLEAST_MARSHMALLOW) {
85            mLauncher.notifyWidgetProvidersChanged();
86        }
87    }
88
89    public AppWidgetHostView createView(Context context, int appWidgetId,
90            LauncherAppWidgetProviderInfo appWidget) {
91        if (appWidget.isCustomWidget) {
92            LauncherAppWidgetHostView lahv = new LauncherAppWidgetHostView(context);
93            LayoutInflater inflater = (LayoutInflater)
94                    context.getSystemService(Context.LAYOUT_INFLATER_SERVICE);
95            inflater.inflate(appWidget.initialLayout, lahv);
96            lahv.setAppWidget(0, appWidget);
97            lahv.updateLastInflationOrientation();
98            return lahv;
99        } else {
100            try {
101                return super.createView(context, appWidgetId, appWidget);
102            } catch (Exception e) {
103                if (!Utilities.isBinderSizeError(e)) {
104                    throw new RuntimeException(e);
105                }
106
107                // If the exception was thrown while fetching the remote views, let the view stay.
108                // This will ensure that if the widget posts a valid update later, the view
109                // will update.
110                LauncherAppWidgetHostView view = mViews.get(appWidgetId);
111                if (view == null) {
112                    view = onCreateView(mLauncher, appWidgetId, appWidget);
113                }
114                view.setAppWidget(appWidgetId, appWidget);
115                view.switchToErrorView();
116                return  view;
117            }
118        }
119    }
120
121    /**
122     * Called when the AppWidget provider for a AppWidget has been upgraded to a new apk.
123     */
124    @Override
125    protected void onProviderChanged(int appWidgetId, AppWidgetProviderInfo appWidget) {
126        LauncherAppWidgetProviderInfo info = LauncherAppWidgetProviderInfo.fromProviderInfo(
127                mLauncher, appWidget);
128        super.onProviderChanged(appWidgetId, info);
129        // The super method updates the dimensions of the providerInfo. Update the
130        // launcher spans accordingly.
131        info.initSpans(mLauncher);
132    }
133
134    @Override
135    public void deleteAppWidgetId(int appWidgetId) {
136        super.deleteAppWidgetId(appWidgetId);
137        mViews.remove(appWidgetId);
138    }
139
140    @Override
141    protected void clearViews() {
142        super.clearViews();
143        mViews.clear();
144    }
145}
146