Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2018 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 | */ |
Felipe Leme | 749b889 | 2018-12-03 16:30:30 -0800 | [diff] [blame] | 16 | package android.view.contentcapture; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 17 | |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 18 | import static com.android.internal.util.function.pooled.PooledLambda.obtainMessage; |
| 19 | |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 20 | import android.annotation.NonNull; |
| 21 | import android.annotation.Nullable; |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 22 | import android.annotation.SystemService; |
Felipe Leme | 87a9dc9 | 2018-12-18 14:28:07 -0800 | [diff] [blame] | 23 | import android.annotation.UiThread; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 24 | import android.content.ComponentName; |
| 25 | import android.content.Context; |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 26 | import android.os.Handler; |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 27 | import android.os.IBinder; |
Felipe Leme | 34ccedf | 2019-01-17 13:42:35 -0800 | [diff] [blame] | 28 | import android.os.Looper; |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 29 | import android.os.RemoteException; |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 30 | import android.util.Log; |
Felipe Leme | 1af85ea | 2019-01-16 13:23:40 -0800 | [diff] [blame] | 31 | import android.view.contentcapture.ContentCaptureSession.FlushReason; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 32 | |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 33 | import com.android.internal.annotations.GuardedBy; |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 34 | import com.android.internal.os.IResultReceiver; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 35 | import com.android.internal.util.Preconditions; |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 36 | import com.android.internal.util.SyncResultReceiver; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 37 | |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 38 | import java.io.PrintWriter; |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 39 | |
Felipe Leme | b18e317 | 2018-11-27 10:33:41 -0800 | [diff] [blame] | 40 | /* |
| 41 | * NOTE: all methods in this class should return right away, or do the real work in a handler |
| 42 | * thread. |
| 43 | * |
| 44 | * Hence, the only field that must be thread-safe is mEnabled, which is called at the beginning |
| 45 | * of every method. |
| 46 | */ |
Felipe Leme | ecb08be | 2018-11-27 15:48:47 -0800 | [diff] [blame] | 47 | /** |
| 48 | * TODO(b/111276913): add javadocs / implement |
| 49 | */ |
| 50 | @SystemService(Context.CONTENT_CAPTURE_MANAGER_SERVICE) |
| 51 | public final class ContentCaptureManager { |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 52 | |
Felipe Leme | 749b889 | 2018-12-03 16:30:30 -0800 | [diff] [blame] | 53 | private static final String TAG = ContentCaptureManager.class.getSimpleName(); |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 54 | |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 55 | /** |
| 56 | * Timeout for calls to system_server. |
| 57 | */ |
| 58 | private static final int SYNC_CALLS_TIMEOUT_MS = 5000; |
| 59 | |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 60 | // TODO(b/121044306): define a way to dynamically set them(for example, using settings?) |
| 61 | static final boolean VERBOSE = false; |
| 62 | static final boolean DEBUG = true; // STOPSHIP if not set to false |
Felipe Leme | 4017b20 | 2018-12-10 12:13:31 -0800 | [diff] [blame] | 63 | |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 64 | private final Object mLock = new Object(); |
| 65 | |
| 66 | @GuardedBy("mLock") |
| 67 | private boolean mDisabled; |
Felipe Leme | b18e317 | 2018-11-27 10:33:41 -0800 | [diff] [blame] | 68 | |
| 69 | @NonNull |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 70 | private final Context mContext; |
| 71 | |
| 72 | @Nullable |
Felipe Leme | 749b889 | 2018-12-03 16:30:30 -0800 | [diff] [blame] | 73 | private final IContentCaptureManager mService; |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 74 | |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 75 | // Flags used for starting session. |
| 76 | @GuardedBy("mLock") |
| 77 | private int mFlags; |
| 78 | |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 79 | // TODO(b/119220549): use UI Thread directly (as calls are one-way) or a shared thread / handler |
Felipe Leme | b18e317 | 2018-11-27 10:33:41 -0800 | [diff] [blame] | 80 | // held at the Application level |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 81 | @NonNull |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 82 | private final Handler mHandler; |
| 83 | |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 84 | @GuardedBy("mLock") |
Felipe Leme | 87a9dc9 | 2018-12-18 14:28:07 -0800 | [diff] [blame] | 85 | private MainContentCaptureSession mMainSession; |
Felipe Leme | 4017b20 | 2018-12-10 12:13:31 -0800 | [diff] [blame] | 86 | |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 87 | /** @hide */ |
Felipe Leme | 749b889 | 2018-12-03 16:30:30 -0800 | [diff] [blame] | 88 | public ContentCaptureManager(@NonNull Context context, |
| 89 | @Nullable IContentCaptureManager service) { |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 90 | mContext = Preconditions.checkNotNull(context, "context cannot be null"); |
Felipe Leme | 34ccedf | 2019-01-17 13:42:35 -0800 | [diff] [blame] | 91 | if (VERBOSE) Log.v(TAG, "Constructor for " + context.getPackageName()); |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 92 | |
Felipe Leme | 34ccedf | 2019-01-17 13:42:35 -0800 | [diff] [blame] | 93 | mService = service; |
| 94 | // TODO(b/119220549): we might not even need a handler, as the IPCs are oneway. But if we |
| 95 | // do, then we should optimize it to run the tests after the Choreographer finishes the most |
| 96 | // important steps of the frame. |
| 97 | mHandler = Handler.createAsync(Looper.getMainLooper()); |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 98 | } |
| 99 | |
Felipe Leme | 7a53408 | 2018-11-05 15:03:04 -0800 | [diff] [blame] | 100 | /** |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 101 | * Gets the main session associated with the context. |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 102 | * |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 103 | * <p>By default there's just one (associated with the activity lifecycle), but apps could |
Felipe Leme | 87a9dc9 | 2018-12-18 14:28:07 -0800 | [diff] [blame] | 104 | * explicitly add more using |
| 105 | * {@link ContentCaptureSession#createContentCaptureSession(ContentCaptureContext)}. |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 106 | * |
| 107 | * @hide |
| 108 | */ |
| 109 | @NonNull |
Felipe Leme | 87a9dc9 | 2018-12-18 14:28:07 -0800 | [diff] [blame] | 110 | @UiThread |
| 111 | public MainContentCaptureSession getMainContentCaptureSession() { |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 112 | synchronized (mLock) { |
| 113 | if (mMainSession == null) { |
| 114 | mMainSession = new MainContentCaptureSession(mContext, mHandler, mService, |
Felipe Leme | 01b8749 | 2019-01-15 13:26:52 -0800 | [diff] [blame] | 115 | mDisabled); |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 116 | if (VERBOSE) { |
| 117 | Log.v(TAG, "getDefaultContentCaptureSession(): created " + mMainSession); |
| 118 | } |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 119 | } |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 120 | return mMainSession; |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 121 | } |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 122 | } |
| 123 | |
| 124 | /** @hide */ |
| 125 | public void onActivityStarted(@NonNull IBinder applicationToken, |
Adam He | 328c0e3 | 2019-01-03 15:19:22 -0800 | [diff] [blame] | 126 | @NonNull ComponentName activityComponent, int flags) { |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 127 | synchronized (mLock) { |
| 128 | mFlags |= flags; |
| 129 | getMainContentCaptureSession().start(applicationToken, activityComponent, mFlags); |
| 130 | } |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | /** @hide */ |
| 134 | public void onActivityStopped() { |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 135 | getMainContentCaptureSession().destroy(); |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 136 | } |
| 137 | |
| 138 | /** |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 139 | * Flushes the content of all sessions. |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 140 | * |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 141 | * <p>Typically called by {@code Activity} when it's paused / resumed. |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 142 | * |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 143 | * @hide |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 144 | */ |
Felipe Leme | 1af85ea | 2019-01-16 13:23:40 -0800 | [diff] [blame] | 145 | public void flush(@FlushReason int reason) { |
| 146 | getMainContentCaptureSession().flush(reason); |
Felipe Leme | 88eae3b | 2018-11-07 15:11:56 -0800 | [diff] [blame] | 147 | } |
| 148 | |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 149 | /** |
Felipe Leme | ecb08be | 2018-11-27 15:48:47 -0800 | [diff] [blame] | 150 | * Returns the component name of the system service that is consuming the captured events for |
| 151 | * the current user. |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 152 | */ |
| 153 | @Nullable |
Felipe Leme | ecb08be | 2018-11-27 15:48:47 -0800 | [diff] [blame] | 154 | public ComponentName getServiceComponentName() { |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 155 | if (!isContentCaptureEnabled()) { |
| 156 | return null; |
| 157 | } |
| 158 | // Wait for system server to return the component name. |
| 159 | final SyncResultReceiver resultReceiver = new SyncResultReceiver(SYNC_CALLS_TIMEOUT_MS); |
| 160 | mHandler.sendMessage(obtainMessage( |
| 161 | ContentCaptureManager::handleReceiverServiceComponentName, |
| 162 | this, mContext.getUserId(), resultReceiver)); |
| 163 | |
| 164 | try { |
| 165 | return resultReceiver.getParcelableResult(); |
| 166 | } catch (RemoteException e) { |
| 167 | // Unable to retrieve component name in a reasonable amount of time. |
| 168 | throw e.rethrowFromSystemServer(); |
| 169 | } |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 170 | } |
| 171 | |
| 172 | /** |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 173 | * Checks whether content capture is enabled for this activity. |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 174 | */ |
| 175 | public boolean isContentCaptureEnabled() { |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 176 | synchronized (mLock) { |
| 177 | return mService != null && !mDisabled; |
| 178 | } |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 179 | } |
| 180 | |
| 181 | /** |
Felipe Leme | 284ad1c | 2018-11-15 18:16:12 -0800 | [diff] [blame] | 182 | * Called by apps to explicitly enable or disable content capture. |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 183 | * |
| 184 | * <p><b>Note: </b> this call is not persisted accross reboots, so apps should typically call |
| 185 | * it on {@link android.app.Activity#onCreate(android.os.Bundle, android.os.PersistableBundle)}. |
| 186 | */ |
Felipe Leme | 6b3a55c | 2018-11-13 17:14:03 -0800 | [diff] [blame] | 187 | public void setContentCaptureEnabled(boolean enabled) { |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 188 | synchronized (mLock) { |
| 189 | mFlags |= enabled ? 0 : ContentCaptureContext.FLAG_DISABLED_BY_APP; |
| 190 | } |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 191 | } |
| 192 | |
| 193 | /** |
Adam He | 3d0409b | 2019-01-15 14:22:04 -0800 | [diff] [blame^] | 194 | * Called by the app to request the Content Capture service to remove user-data associated with |
Felipe Leme | aa5088e | 2018-12-10 14:53:58 -0800 | [diff] [blame] | 195 | * some context. |
| 196 | * |
| 197 | * @param request object specifying what user data should be removed. |
| 198 | */ |
| 199 | public void removeUserData(@NonNull UserDataRemovalRequest request) { |
Adam He | 3d0409b | 2019-01-15 14:22:04 -0800 | [diff] [blame^] | 200 | Preconditions.checkNotNull(request); |
| 201 | |
| 202 | try { |
| 203 | mService.removeUserData(mContext.getUserId(), request); |
| 204 | } catch (RemoteException e) { |
| 205 | e.rethrowFromSystemServer(); |
| 206 | } |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 207 | } |
| 208 | |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 209 | /** @hide */ |
| 210 | public void dump(String prefix, PrintWriter pw) { |
Adam He | 6079d15 | 2019-01-10 11:37:17 -0800 | [diff] [blame] | 211 | synchronized (mLock) { |
| 212 | pw.print(prefix); pw.println("ContentCaptureManager"); |
| 213 | pw.print(prefix); pw.print("Disabled: "); pw.println(mDisabled); |
| 214 | pw.print(prefix); pw.print("Context: "); pw.println(mContext); |
| 215 | pw.print(prefix); pw.print("User: "); pw.println(mContext.getUserId()); |
| 216 | if (mService != null) { |
| 217 | pw.print(prefix); pw.print("Service: "); pw.println(mService); |
| 218 | } |
| 219 | pw.print(prefix); pw.print("Flags: "); pw.println(mFlags); |
| 220 | if (mMainSession != null) { |
| 221 | final String prefix2 = prefix + " "; |
| 222 | pw.print(prefix); pw.println("Main session:"); |
| 223 | mMainSession.dump(prefix2, pw); |
| 224 | } else { |
| 225 | pw.print(prefix); pw.println("No sessions"); |
| 226 | } |
Felipe Leme | e348dc3 | 2018-11-05 12:35:29 -0800 | [diff] [blame] | 227 | } |
| 228 | } |
Perumaal S | addabba | 2019-01-04 16:43:35 -0800 | [diff] [blame] | 229 | |
| 230 | |
| 231 | /** Retrieves the component name of the target content capture service through system_server. */ |
| 232 | private void handleReceiverServiceComponentName(int userId, IResultReceiver resultReceiver) { |
| 233 | try { |
| 234 | mService.getReceiverServiceComponentName(userId, resultReceiver); |
| 235 | } catch (RemoteException e) { |
| 236 | Log.w(TAG, "Unable to retrieve service component name: " + e); |
| 237 | } |
| 238 | } |
Felipe Leme | 1dfa9a0 | 2018-10-17 17:24:37 -0700 | [diff] [blame] | 239 | } |