File: SelectionToolbarRenderService.java

package info (click to toggle)
android-platform-frameworks-base 1%3A14~beta1-3
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 326,092 kB
  • sloc: java: 2,032,373; xml: 343,016; cpp: 304,181; python: 3,683; ansic: 2,090; sh: 1,871; makefile: 117; sed: 19
file content (257 lines) | stat: -rw-r--r-- 8,671 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
/*
 * Copyright (C) 2021 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 android.service.selectiontoolbar;

import static com.android.internal.util.function.pooled.PooledLambda.obtainMessage;

import android.annotation.CallSuper;
import android.annotation.NonNull;
import android.annotation.Nullable;
import android.app.Service;
import android.content.Intent;
import android.os.Handler;
import android.os.IBinder;
import android.os.Looper;
import android.os.RemoteException;
import android.util.Log;
import android.util.Pair;
import android.util.SparseArray;
import android.view.selectiontoolbar.ISelectionToolbarCallback;
import android.view.selectiontoolbar.ShowInfo;
import android.view.selectiontoolbar.ToolbarMenuItem;
import android.view.selectiontoolbar.WidgetInfo;

/**
 * Service for rendering selection toolbar.
 *
 * @hide
 */
public abstract class SelectionToolbarRenderService extends Service {

    private static final String TAG = "SelectionToolbarRenderService";

    // TODO(b/215497659): read from DeviceConfig
    // The timeout to clean the cache if the client forgot to call dismiss()
    private static final int CACHE_CLEAN_AFTER_SHOW_TIMEOUT_IN_MS = 10 * 60 * 1000; // 10 minutes

    /**
     * The {@link Intent} that must be declared as handled by the service.
     *
     * <p>To be supported, the service must also require the
     * {@link android.Manifest.permission#BIND_SELECTION_TOOLBAR_RENDER_SERVICE} permission so
     * that other applications can not abuse it.
     */
    public static final String SERVICE_INTERFACE =
            "android.service.selectiontoolbar.SelectionToolbarRenderService";

    private Handler mHandler;
    private ISelectionToolbarRenderServiceCallback mServiceCallback;

    private final SparseArray<Pair<RemoteCallbackWrapper, CleanCacheRunnable>> mCache =
            new SparseArray<>();

    /**
     * Binder to receive calls from system server.
     */
    private final ISelectionToolbarRenderService mInterface =
            new ISelectionToolbarRenderService.Stub() {

        @Override
        public void onShow(int callingUid, ShowInfo showInfo, ISelectionToolbarCallback callback) {
            if (mCache.indexOfKey(callingUid) < 0) {
                mCache.put(callingUid, new Pair<>(new RemoteCallbackWrapper(callback),
                        new CleanCacheRunnable(callingUid)));
            }
            Pair<RemoteCallbackWrapper, CleanCacheRunnable> toolbarPair = mCache.get(callingUid);
            CleanCacheRunnable cleanRunnable = toolbarPair.second;
            mHandler.removeCallbacks(cleanRunnable);
            mHandler.sendMessage(obtainMessage(SelectionToolbarRenderService::onShow,
                    SelectionToolbarRenderService.this, callingUid, showInfo,
                    toolbarPair.first));
            mHandler.postDelayed(cleanRunnable, CACHE_CLEAN_AFTER_SHOW_TIMEOUT_IN_MS);
        }

        @Override
        public void onHide(long widgetToken) {
            mHandler.sendMessage(obtainMessage(SelectionToolbarRenderService::onHide,
                    SelectionToolbarRenderService.this, widgetToken));
        }

        @Override
        public void onDismiss(int callingUid, long widgetToken) {
            mHandler.sendMessage(obtainMessage(SelectionToolbarRenderService::onDismiss,
                    SelectionToolbarRenderService.this, widgetToken));
            Pair<RemoteCallbackWrapper, CleanCacheRunnable> toolbarPair = mCache.get(callingUid);
            if (toolbarPair != null) {
                mHandler.removeCallbacks(toolbarPair.second);
                mCache.remove(callingUid);
            }
        }

        @Override
        public void onConnected(IBinder callback) {
            mHandler.sendMessage(obtainMessage(SelectionToolbarRenderService::handleOnConnected,
                    SelectionToolbarRenderService.this, callback));
        }
    };

    @CallSuper
    @Override
    public void onCreate() {
        super.onCreate();
        mHandler = new Handler(Looper.getMainLooper(), null, true);
    }

    @Override
    @Nullable
    public final IBinder onBind(@NonNull Intent intent) {
        if (SERVICE_INTERFACE.equals(intent.getAction())) {
            return mInterface.asBinder();
        }
        Log.w(TAG, "Tried to bind to wrong intent (should be " + SERVICE_INTERFACE + ": " + intent);
        return null;
    }

    private void handleOnConnected(@NonNull IBinder callback) {
        mServiceCallback = ISelectionToolbarRenderServiceCallback.Stub.asInterface(callback);
    }

    protected void transferTouch(@NonNull IBinder source, @NonNull IBinder target) {
        final ISelectionToolbarRenderServiceCallback callback = mServiceCallback;
        if (callback == null) {
            Log.e(TAG, "transferTouch(): no server callback");
            return;
        }
        try {
            callback.transferTouch(source, target);
        } catch (RemoteException e) {
            // no-op
        }
    }

    /**
     * Called when showing the selection toolbar.
     */
    public abstract void onShow(int callingUid, ShowInfo showInfo,
            RemoteCallbackWrapper callbackWrapper);

    /**
     * Called when hiding the selection toolbar.
     */
    public abstract void onHide(long widgetToken);


    /**
     * Called when dismissing the selection toolbar.
     */
    public abstract void onDismiss(long widgetToken);

    /**
     * Called when showing the selection toolbar for a specific timeout. This avoids the client
     * forgot to call dismiss to clean the state.
     */
    public void onToolbarShowTimeout(int callingUid) {
        // no-op
    }

    /**
     * Callback to notify the client toolbar events.
     */
    public static final class RemoteCallbackWrapper implements SelectionToolbarRenderCallback {

        private final ISelectionToolbarCallback mRemoteCallback;

        RemoteCallbackWrapper(ISelectionToolbarCallback remoteCallback) {
            // TODO(b/215497659): handle if the binder dies.
            mRemoteCallback = remoteCallback;
        }

        @Override
        public void onShown(WidgetInfo widgetInfo) {
            try {
                mRemoteCallback.onShown(widgetInfo);
            } catch (RemoteException e) {
                // no-op
            }
        }

        @Override
        public void onToolbarShowTimeout() {
            try {
                mRemoteCallback.onToolbarShowTimeout();
            } catch (RemoteException e) {
                // no-op
            }
        }

        @Override
        public void onWidgetUpdated(WidgetInfo widgetInfo) {
            try {
                mRemoteCallback.onWidgetUpdated(widgetInfo);
            } catch (RemoteException e) {
                // no-op
            }
        }

        @Override
        public void onMenuItemClicked(ToolbarMenuItem item) {
            try {
                mRemoteCallback.onMenuItemClicked(item);
            } catch (RemoteException e) {
                // no-op
            }
        }

        @Override
        public void onError(int errorCode) {
            try {
                mRemoteCallback.onError(errorCode);
            } catch (RemoteException e) {
                // no-op
            }
        }
    }

    private class CleanCacheRunnable implements Runnable {

        int mCleanUid;

        CleanCacheRunnable(int cleanUid) {
            mCleanUid = cleanUid;
        }

        @Override
        public void run() {
            Pair<RemoteCallbackWrapper, CleanCacheRunnable> toolbarPair = mCache.get(mCleanUid);
            if (toolbarPair != null) {
                Log.w(TAG, "CleanCacheRunnable: remove " + mCleanUid + " from cache.");
                mCache.remove(mCleanUid);
                onToolbarShowTimeout(mCleanUid);
            }
        }
    }

    /**
     * A listener to notify the service to the transfer touch focus.
     */
    public interface TransferTouchListener {
        /**
         * Notify the service to transfer the touch focus.
         */
        void onTransferTouch(IBinder source, IBinder target);
    }
}