| /* |
| * Copyright (C) 2018 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.autofill.augmented; |
| |
| import static com.android.internal.util.function.pooled.PooledLambda.obtainMessage; |
| |
| import android.annotation.CallSuper; |
| import android.annotation.IntDef; |
| import android.annotation.NonNull; |
| import android.annotation.Nullable; |
| import android.annotation.SystemApi; |
| import android.app.Service; |
| import android.content.ComponentName; |
| import android.content.Intent; |
| import android.graphics.Rect; |
| import android.os.CancellationSignal; |
| import android.os.Handler; |
| import android.os.IBinder; |
| import android.os.Looper; |
| import android.os.RemoteException; |
| import android.os.SystemClock; |
| import android.service.autofill.augmented.PresentationParams.SystemPopupPresentationParams; |
| import android.util.Log; |
| import android.util.Pair; |
| import android.util.Slog; |
| import android.util.SparseArray; |
| import android.util.TimeUtils; |
| import android.view.autofill.AutofillId; |
| import android.view.autofill.AutofillValue; |
| import android.view.autofill.IAugmentedAutofillManagerClient; |
| |
| import com.android.internal.annotations.GuardedBy; |
| |
| import java.io.FileDescriptor; |
| import java.io.PrintWriter; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.util.ArrayList; |
| import java.util.List; |
| |
| /** |
| * A service used to augment the Autofill subsystem by potentially providing autofill data when the |
| * "standard" workflow failed (for example, because the standard AutofillService didn't have data). |
| * |
| * @hide |
| */ |
| @SystemApi |
| public abstract class AugmentedAutofillService extends Service { |
| |
| private static final String TAG = AugmentedAutofillService.class.getSimpleName(); |
| |
| // TODO(b/111330312): STOPSHIP use dynamic value, or change to false |
| static final boolean DEBUG = true; |
| static final boolean VERBOSE = false; |
| |
| /** |
| * The {@link Intent} that must be declared as handled by the service. |
| * To be supported, the service must also require the |
| * {@link android.Manifest.permission#BIND_AUGMENTED_AUTOFILL_SERVICE} permission so |
| * that other applications can not abuse it. |
| */ |
| public static final String SERVICE_INTERFACE = |
| "android.service.autofill.augmented.AugmentedAutofillService"; |
| |
| private Handler mHandler; |
| |
| private SparseArray<AutofillProxy> mAutofillProxies; |
| |
| private final IAugmentedAutofillService mInterface = new IAugmentedAutofillService.Stub() { |
| |
| @Override |
| public void onFillRequest(int sessionId, IBinder client, int taskId, |
| ComponentName componentName, AutofillId focusedId, AutofillValue focusedValue, |
| long requestTime, IFillCallback callback) { |
| mHandler.sendMessage(obtainMessage(AugmentedAutofillService::handleOnFillRequest, |
| AugmentedAutofillService.this, sessionId, client, taskId, componentName, |
| focusedId, focusedValue, requestTime, callback)); |
| } |
| |
| @Override |
| public void onDestroyFillWindowRequest(int sessionId) { |
| mHandler.sendMessage( |
| obtainMessage(AugmentedAutofillService::handleOnDestroyFillWindowRequest, |
| AugmentedAutofillService.this, sessionId)); |
| } |
| }; |
| |
| @CallSuper |
| @Override |
| public void onCreate() { |
| super.onCreate(); |
| mHandler = new Handler(Looper.getMainLooper(), null, true); |
| } |
| |
| /** @hide */ |
| @Override |
| public final IBinder onBind(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; |
| } |
| |
| @Override |
| public boolean onUnbind(Intent intent) { |
| mHandler.sendMessage(obtainMessage(AugmentedAutofillService::handleOnUnbind, |
| AugmentedAutofillService.this)); |
| return false; |
| } |
| |
| // TODO(b/111330312): add methods to disable autofill per app / activity? |
| |
| /** |
| * Asks the service to handle an "augmented" autofill request. |
| * |
| * <p>This method is called when the "stantard" autofill service cannot handle a request, which |
| * typically occurs when: |
| * <ul> |
| * <li>Service does not recognize what should be autofilled. |
| * <li>Service does not have data to fill the request. |
| * <li>Service blacklisted that app (or activity) for autofill. |
| * <li>App disabled itself for autofill. |
| * </ul> |
| * |
| * <p>Differently from the standard autofill workflow, on augmented autofill the service is |
| * responsible to generate the autofill UI and request the Android system to autofill the |
| * activity when the user taps an action in that UI (through the |
| * {@link FillController#autofill(List)} method). |
| * |
| * <p>The service <b>MUST</b> call {@link |
| * FillCallback#onSuccess(android.service.autofill.augmented.FillResponse)} as soon as possible, |
| * passing {@code null} when it cannot fulfill the request. |
| * @param request the request to handle. |
| * @param cancellationSignal signal for observing cancellation requests. The system will use |
| * this to notify you that the fill result is no longer needed and you should stop |
| * handling this fill request in order to save resources. |
| * @param controller object used to interact with the autofill system. |
| * @param callback object used to notify the result of the request. Service <b>must</b> call |
| * {@link FillCallback#onSuccess(android.service.autofill.augmented.FillResponse)}. |
| */ |
| public void onFillRequest(@NonNull FillRequest request, |
| @NonNull CancellationSignal cancellationSignal, @NonNull FillController controller, |
| @NonNull FillCallback callback) { |
| } |
| |
| private void handleOnFillRequest(int sessionId, @NonNull IBinder client, int taskId, |
| @NonNull ComponentName componentName, @NonNull AutofillId focusedId, |
| @Nullable AutofillValue focusedValue, long requestTime, |
| @NonNull IFillCallback callback) { |
| if (mAutofillProxies == null) { |
| mAutofillProxies = new SparseArray<>(); |
| } |
| AutofillProxy proxy = mAutofillProxies.get(sessionId); |
| if (proxy == null) { |
| proxy = new AutofillProxy(sessionId, client, taskId, componentName, focusedId, |
| focusedValue, requestTime, callback); |
| mAutofillProxies.put(sessionId, proxy); |
| } else { |
| // TODO(b/111330312): figure out if it's ok to reuse the proxy; add logging |
| // TODO(b/111330312): also make sure to cover scenario on CTS test |
| if (DEBUG) Log.d(TAG, "Reusing proxy for session " + sessionId); |
| proxy.update(focusedId, focusedValue); |
| } |
| // TODO(b/111330312): set cancellation signal |
| final CancellationSignal cancellationSignal = null; |
| onFillRequest(new FillRequest(proxy), cancellationSignal, new FillController(proxy), |
| new FillCallback(proxy)); |
| } |
| |
| private void handleOnDestroyFillWindowRequest(@NonNull int sessionId) { |
| AutofillProxy proxy = null; |
| if (mAutofillProxies != null) { |
| proxy = mAutofillProxies.get(sessionId); |
| } |
| if (proxy == null) { |
| // TODO(b/111330312): this might be fine, in which case we should logv it |
| Log.w(TAG, "No proxy for session " + sessionId); |
| return; |
| } |
| proxy.destroy(); |
| mAutofillProxies.remove(sessionId); |
| } |
| |
| private void handleOnUnbind() { |
| if (mAutofillProxies == null) { |
| if (DEBUG) Log.d(TAG, "onUnbind(): no proxy to destroy"); |
| return; |
| } |
| final int size = mAutofillProxies.size(); |
| if (DEBUG) Log.d(TAG, "onUnbind(): destroying " + size + " proxies"); |
| for (int i = 0; i < size; i++) { |
| final AutofillProxy proxy = mAutofillProxies.valueAt(i); |
| try { |
| proxy.destroy(); |
| } catch (Exception e) { |
| Log.w(TAG, "error destroying " + proxy); |
| } |
| } |
| mAutofillProxies = null; |
| } |
| |
| @Override |
| protected void dump(FileDescriptor fd, PrintWriter pw, String[] args) { |
| if (mAutofillProxies != null) { |
| final int size = mAutofillProxies.size(); |
| pw.print("Number proxies: "); pw.println(size); |
| for (int i = 0; i < size; i++) { |
| final int sessionId = mAutofillProxies.keyAt(i); |
| final AutofillProxy proxy = mAutofillProxies.valueAt(i); |
| pw.print(i); pw.print(") SessionId="); pw.print(sessionId); pw.println(":"); |
| proxy.dump(" ", pw); |
| } |
| } |
| } |
| |
| /** @hide */ |
| static final class AutofillProxy { |
| |
| static final int REPORT_EVENT_ON_SUCCESS = 1; |
| static final int REPORT_EVENT_UI_SHOWN = 2; |
| static final int REPORT_EVENT_UI_DESTROYED = 3; |
| |
| @IntDef(prefix = { "REPORT_EVENT_" }, value = { |
| REPORT_EVENT_ON_SUCCESS, |
| REPORT_EVENT_UI_SHOWN, |
| REPORT_EVENT_UI_DESTROYED |
| }) |
| @Retention(RetentionPolicy.SOURCE) |
| @interface ReportEvent{} |
| |
| |
| private final Object mLock = new Object(); |
| private final IAugmentedAutofillManagerClient mClient; |
| private final int mSessionId; |
| private final IFillCallback mCallback; |
| public final int taskId; |
| public final ComponentName componentName; |
| @GuardedBy("mLock") |
| private AutofillId mFocusedId; |
| @GuardedBy("mLock") |
| private AutofillValue mFocusedValue; |
| |
| /** |
| * Id of the last field that cause the Autofill UI to be shown. |
| * |
| * <p>Used to make sure the SmartSuggestionsParams is updated when a new fields is focused. |
| */ |
| // TODO(b/111330312): might not be needed when using IME |
| @GuardedBy("mLock") |
| private AutofillId mLastShownId; |
| |
| // Objects used to log metrics |
| private final long mRequestTime; |
| private long mOnSuccessTime; |
| private long mUiFirstShownTime; |
| private long mUiFirstDestroyedTime; |
| |
| @GuardedBy("mLock") |
| private SystemPopupPresentationParams mSmartSuggestion; |
| |
| @GuardedBy("mLock") |
| private FillWindow mFillWindow; |
| |
| private AutofillProxy(int sessionId, @NonNull IBinder client, int taskId, |
| @NonNull ComponentName componentName, @NonNull AutofillId focusedId, |
| @Nullable AutofillValue focusedValue, long requestTime, |
| @NonNull IFillCallback callback) { |
| mSessionId = sessionId; |
| mClient = IAugmentedAutofillManagerClient.Stub.asInterface(client); |
| mCallback = callback; |
| this.taskId = taskId; |
| this.componentName = componentName; |
| this.mFocusedId = focusedId; |
| this.mFocusedValue = focusedValue; |
| this.mRequestTime = requestTime; |
| // TODO(b/111330312): linkToDeath |
| } |
| |
| @NonNull |
| public SystemPopupPresentationParams getSmartSuggestionParams() { |
| synchronized (mLock) { |
| if (mSmartSuggestion != null && mFocusedId.equals(mLastShownId)) { |
| return mSmartSuggestion; |
| } |
| Rect rect; |
| try { |
| rect = mClient.getViewCoordinates(mFocusedId); |
| } catch (RemoteException e) { |
| Log.w(TAG, "Could not get coordinates for " + mFocusedId); |
| return null; |
| } |
| if (rect == null) { |
| if (DEBUG) Log.d(TAG, "getViewCoordinates(" + mFocusedId + ") returned null"); |
| return null; |
| } |
| mSmartSuggestion = new SystemPopupPresentationParams(this, rect); |
| mLastShownId = mFocusedId; |
| return mSmartSuggestion; |
| } |
| } |
| |
| public void autofill(@NonNull List<Pair<AutofillId, AutofillValue>> pairs) |
| throws RemoteException { |
| final int size = pairs.size(); |
| final List<AutofillId> ids = new ArrayList<>(size); |
| final List<AutofillValue> values = new ArrayList<>(size); |
| for (int i = 0; i < size; i++) { |
| final Pair<AutofillId, AutofillValue> pair = pairs.get(i); |
| ids.add(pair.first); |
| values.add(pair.second); |
| } |
| mClient.autofill(mSessionId, ids, values); |
| } |
| |
| public void setFillWindow(@NonNull FillWindow fillWindow) { |
| synchronized (mLock) { |
| mFillWindow = fillWindow; |
| } |
| } |
| |
| public FillWindow getFillWindow() { |
| synchronized (mLock) { |
| return mFillWindow; |
| } |
| } |
| |
| private void update(@NonNull AutofillId focusedId, @NonNull AutofillValue focusedValue) { |
| synchronized (mLock) { |
| // TODO(b/111330312): should we close the popupwindow if the focused id changed? |
| mFocusedId = focusedId; |
| mFocusedValue = focusedValue; |
| } |
| } |
| |
| @NonNull |
| public AutofillId getFocusedId() { |
| synchronized (mLock) { |
| return mFocusedId; |
| } |
| } |
| |
| @NonNull |
| public AutofillValue getFocusedValue() { |
| synchronized (mLock) { |
| return mFocusedValue; |
| } |
| } |
| |
| // Used (mostly) for metrics. |
| public void report(@ReportEvent int event) { |
| switch (event) { |
| case REPORT_EVENT_ON_SUCCESS: |
| if (mOnSuccessTime == 0) { |
| mOnSuccessTime = SystemClock.elapsedRealtime(); |
| if (DEBUG) { |
| Slog.d(TAG, "Service responsed in " |
| + TimeUtils.formatDuration(mOnSuccessTime - mRequestTime)); |
| } |
| } |
| try { |
| mCallback.onSuccess(); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error reporting success: " + e); |
| } |
| break; |
| case REPORT_EVENT_UI_SHOWN: |
| if (mUiFirstShownTime == 0) { |
| mUiFirstShownTime = SystemClock.elapsedRealtime(); |
| if (DEBUG) { |
| Slog.d(TAG, "UI shown in " |
| + TimeUtils.formatDuration(mUiFirstShownTime - mRequestTime)); |
| } |
| } |
| break; |
| case REPORT_EVENT_UI_DESTROYED: |
| if (mUiFirstDestroyedTime == 0) { |
| mUiFirstDestroyedTime = SystemClock.elapsedRealtime(); |
| if (DEBUG) { |
| Slog.d(TAG, "UI destroyed in " |
| + TimeUtils.formatDuration( |
| mUiFirstDestroyedTime - mRequestTime)); |
| } |
| } |
| break; |
| default: |
| Slog.w(TAG, "invalid event reported: " + event); |
| } |
| // TODO(b/111330312): log metrics as well |
| } |
| |
| public void dump(@NonNull String prefix, @NonNull PrintWriter pw) { |
| pw.print(prefix); pw.print("sessionId: "); pw.println(mSessionId); |
| pw.print(prefix); pw.print("taskId: "); pw.println(taskId); |
| pw.print(prefix); pw.print("component: "); |
| pw.println(componentName.flattenToShortString()); |
| pw.print(prefix); pw.print("focusedId: "); pw.println(mFocusedId); |
| if (mFocusedValue != null) { |
| pw.print(prefix); pw.print("focusedValue: "); pw.println(mFocusedValue); |
| } |
| if (mLastShownId != null) { |
| pw.print(prefix); pw.print("lastShownId: "); pw.println(mLastShownId); |
| } |
| pw.print(prefix); pw.print("client: "); pw.println(mClient); |
| final String prefix2 = prefix + " "; |
| if (mFillWindow != null) { |
| pw.print(prefix); pw.println("window:"); |
| mFillWindow.dump(prefix2, pw); |
| } |
| if (mSmartSuggestion != null) { |
| pw.print(prefix); pw.println("smartSuggestion:"); |
| mSmartSuggestion.dump(prefix2, pw); |
| } |
| if (mOnSuccessTime > 0) { |
| final long responseTime = mOnSuccessTime - mRequestTime; |
| pw.print(prefix); pw.print("response time: "); |
| TimeUtils.formatDuration(responseTime, pw); pw.println(); |
| } |
| |
| if (mUiFirstShownTime > 0) { |
| final long uiRenderingTime = mUiFirstShownTime - mRequestTime; |
| pw.print(prefix); pw.print("UI rendering time: "); |
| TimeUtils.formatDuration(uiRenderingTime, pw); pw.println(); |
| } |
| |
| if (mUiFirstDestroyedTime > 0) { |
| final long uiTotalTime = mUiFirstDestroyedTime - mRequestTime; |
| pw.print(prefix); pw.print("UI life time: "); |
| TimeUtils.formatDuration(uiTotalTime, pw); pw.println(); |
| } |
| } |
| |
| private void destroy() { |
| synchronized (mLock) { |
| if (mFillWindow != null) { |
| if (DEBUG) Log.d(TAG, "destroying window"); |
| mFillWindow.destroy(); |
| } |
| } |
| } |
| } |
| } |