| /* |
| * Copyright (C) 2017 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.view.autofill; |
| |
| import android.content.Context; |
| import android.content.Intent; |
| import android.content.IntentSender; |
| import android.graphics.Rect; |
| import android.os.Bundle; |
| import android.os.IBinder; |
| import android.os.Parcelable; |
| import android.os.RemoteException; |
| import android.util.ArrayMap; |
| import android.util.Log; |
| import android.view.View; |
| |
| import java.lang.ref.WeakReference; |
| import java.util.List; |
| |
| /** |
| * App entry point to the AutoFill Framework. |
| */ |
| // TODO(b/33197203): improve this javadoc |
| //TODO(b/33197203): restrict manager calls to activity |
| public final class AutoFillManager { |
| private static final boolean DEBUG = false; |
| |
| private static final String TAG = "AutoFillManager"; |
| |
| /** |
| * Intent extra: The assist structure which captures the filled screen. |
| * <p> |
| * Type: {@link android.app.assist.AssistStructure} |
| * </p> |
| */ |
| public static final String EXTRA_ASSIST_STRUCTURE = |
| "android.view.autofill.extra.ASSIST_STRUCTURE"; |
| |
| /** |
| * Intent extra: The result of an authentication operation. It is |
| * either a fully populated {@link android.service.autofill.FillResponse} |
| * or a fully populated {@link android.service.autofill.Dataset} if |
| * a response or a dataset is being authenticated respectively. |
| * |
| * <p> |
| * Type: {@link android.service.autofill.FillResponse} or a |
| * {@link android.service.autofill.Dataset} |
| * </p> |
| */ |
| public static final String EXTRA_AUTHENTICATION_RESULT = |
| "android.view.autofill.extra.AUTHENTICATION_RESULT"; |
| |
| /** @hide */ public static final int FLAG_START_SESSION = 0x1; |
| /** @hide */ public static final int FLAG_FOCUS_GAINED = 0x2; |
| /** @hide */ public static final int FLAG_FOCUS_LOST = 0x4; |
| /** @hide */ public static final int FLAG_VALUE_CHANGED = 0x8; |
| |
| // These are activities that may have auto-fill UI which are keyed off their tokens. |
| // This is done instead of the activity setting the client in the auto-fill manager |
| // to avoid unnecessary instantiation of the manager and do this only if there is an |
| // auto-fillable focused. This has only the cost of loading the class vs creating an |
| // auto-fill manager for every activity even one that cannot be filled. |
| private static final ArrayMap<IBinder, AutoFillClient> sPendingClients = new ArrayMap<>(); |
| |
| private final Rect mTempRect = new Rect(); |
| |
| private final IAutoFillManager mService; |
| private IAutoFillManagerClient mServiceClient; |
| |
| private Context mContext; |
| |
| private AutoFillClient mClient; |
| |
| private boolean mHasSession; |
| private boolean mEnabled; |
| |
| /** @hide */ |
| public interface AutoFillClient { |
| /** |
| * Asks the client to perform an auto-fill. |
| * |
| * @param ids The values to auto-fill |
| * @param values The values to auto-fill |
| */ |
| void autoFill(List<AutoFillId> ids, List<AutoFillValue> values); |
| |
| /** |
| * Asks the client to start an authentication flow. |
| * |
| * @param intent The authentication intent. |
| * @param fillInIntent The authentication fill-in intent. |
| */ |
| void authenticate(IntentSender intent, Intent fillInIntent); |
| } |
| |
| /** |
| * @hide |
| */ |
| public AutoFillManager(Context context, IAutoFillManager service) { |
| mContext = context; |
| mService = service; |
| } |
| |
| /** |
| * Called to indicate the focus on an auto-fillable {@link View} changed. |
| * |
| * @param view view whose focus changed. |
| * @param gainFocus whether focus was gained or lost. |
| */ |
| public void focusChanged(View view, boolean gainFocus) { |
| ensureServiceClientAddedIfNeeded(); |
| |
| if (!mEnabled) { |
| return; |
| } |
| |
| final Rect bounds = mTempRect; |
| view.getBoundsOnScreen(bounds); |
| final AutoFillId id = getAutoFillId(view); |
| final AutoFillValue value = view.getAutoFillValue(); |
| |
| if (!mHasSession) { |
| if (gainFocus) { |
| // Starts new session. |
| startSession(id, bounds, value); |
| } |
| } else { |
| // Update focus on existing session. |
| updateSession(id, bounds, value, gainFocus ? FLAG_FOCUS_GAINED : FLAG_FOCUS_LOST); |
| } |
| } |
| |
| /** |
| * Called to indicate the focus on an auto-fillable virtual {@link View} changed. |
| * |
| * @param parent parent view whose focus changed. |
| * @param childId id identifying the virtual child inside the parent view. |
| * @param bounds child boundaries, relative to the top window. |
| * @param gainFocus whether focus was gained or lost. |
| */ |
| public void virtualFocusChanged(View parent, int childId, Rect bounds, boolean gainFocus) { |
| ensureServiceClientAddedIfNeeded(); |
| |
| if (!mEnabled) { |
| return; |
| } |
| |
| final AutoFillId id = getAutoFillId(parent, childId); |
| |
| if (!mHasSession) { |
| if (gainFocus) { |
| // Starts new session. |
| startSession(id, bounds, null); |
| } |
| } else { |
| // Update focus on existing session. |
| updateSession(id, bounds, null, gainFocus ? FLAG_FOCUS_GAINED : FLAG_FOCUS_LOST); |
| } |
| } |
| |
| /** |
| * Called to indicate the value of an auto-fillable {@link View} changed. |
| * |
| * @param view view whose focus changed. |
| */ |
| public void valueChanged(View view) { |
| ensureServiceClientAddedIfNeeded(); |
| |
| if (!mEnabled || !mHasSession) { |
| return; |
| } |
| |
| final AutoFillId id = getAutoFillId(view); |
| final AutoFillValue value = view.getAutoFillValue(); |
| updateSession(id, null, value, FLAG_VALUE_CHANGED); |
| } |
| |
| |
| /** |
| * Called to indicate the value of an auto-fillable virtual {@link View} changed. |
| * |
| * @param parent parent view whose value changed. |
| * @param childId id identifying the virtual child inside the parent view. |
| * @param value new value of the child. |
| */ |
| public void virtualValueChanged(View parent, int childId, AutoFillValue value) { |
| ensureServiceClientAddedIfNeeded(); |
| |
| if (!mEnabled || !mHasSession) { |
| return; |
| } |
| |
| final AutoFillId id = getAutoFillId(parent, childId); |
| updateSession(id, null, value, FLAG_VALUE_CHANGED); |
| } |
| |
| /** |
| * Called to indicate the current auto-fill context should be reset. |
| * |
| * <p>For example, when a virtual view is rendering an {@code HTML} page with a form, it should |
| * call this method after the form is submitted and another page is rendered. |
| */ |
| public void reset() { |
| ensureServiceClientAddedIfNeeded(); |
| |
| if (!mEnabled && !mHasSession) { |
| return; |
| } |
| |
| finishSession(); |
| } |
| |
| /** @hide */ |
| public static void addClient(IBinder token, AutoFillClient client) { |
| sPendingClients.put(token, client); |
| } |
| |
| /** @hide */ |
| public static boolean isClientActive(IBinder token) { |
| return !sPendingClients.containsKey(token); |
| } |
| |
| private void activateClient() { |
| mClient = sPendingClients.remove(mContext.getActivityToken()); |
| } |
| |
| private AutoFillClient getClient() { |
| if (mClient == null) { |
| return sPendingClients.get(mContext.getActivityToken()); |
| } |
| return mClient; |
| } |
| |
| /** @hide */ |
| public void onAuthenticationResult(Intent data) { |
| if (data == null) { |
| return; |
| } |
| Parcelable result = data.getParcelableExtra( |
| EXTRA_AUTHENTICATION_RESULT); |
| Bundle responseData = new Bundle(); |
| responseData.putParcelable(EXTRA_AUTHENTICATION_RESULT, result); |
| try { |
| mService.setAuthenticationResult(responseData, |
| mContext.getActivityToken(), mContext.getUserId()); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error delivering authentication result", e); |
| } |
| } |
| |
| private AutoFillId getAutoFillId(View view) { |
| return new AutoFillId(view.getAccessibilityViewId()); |
| } |
| |
| private AutoFillId getAutoFillId(View parent, int childId) { |
| return new AutoFillId(parent.getAccessibilityViewId(), childId); |
| } |
| |
| private void startSession(AutoFillId id, Rect bounds, AutoFillValue value) { |
| if (DEBUG) { |
| Log.v(TAG, "startSession(): id=" + id + ", bounds=" + bounds + ", value=" + value); |
| } |
| try { |
| mService.startSession(mContext.getActivityToken(), mServiceClient.asBinder(), |
| id, bounds, value, mContext.getUserId()); |
| mHasSession = true; |
| activateClient(); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| private void finishSession() { |
| if (DEBUG) { |
| Log.v(TAG, "finishSession()"); |
| } |
| mHasSession = false; |
| try { |
| mService.finishSession(mContext.getActivityToken(), mContext.getUserId()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| private void updateSession(AutoFillId id, Rect bounds, AutoFillValue value, int flags) { |
| if (DEBUG) { |
| Log.v(TAG, "updateSession(): id=" + id + ", bounds=" + bounds + ", value=" + value |
| + ", flags=" + flags); |
| } |
| try { |
| mService.updateSession(mContext.getActivityToken(), id, bounds, value, flags, |
| mContext.getUserId()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| |
| private void ensureServiceClientAddedIfNeeded() { |
| if (getClient() == null) { |
| return; |
| } |
| if (mServiceClient == null) { |
| mServiceClient = new AutoFillManagerClient(this); |
| try { |
| mEnabled = mService.addClient(mServiceClient, mContext.getUserId()); |
| } catch (RemoteException e) { |
| throw e.rethrowFromSystemServer(); |
| } |
| } |
| } |
| |
| private static final class AutoFillManagerClient extends IAutoFillManagerClient.Stub { |
| private final WeakReference<AutoFillManager> mAutoFillManager; |
| |
| AutoFillManagerClient(AutoFillManager autoFillManager) { |
| mAutoFillManager = new WeakReference<>(autoFillManager); |
| } |
| |
| @Override |
| public void setState(boolean enabled) { |
| final AutoFillManager autoFillManager = mAutoFillManager.get(); |
| if (autoFillManager != null) { |
| autoFillManager.mContext.getMainThreadHandler().post(() -> |
| autoFillManager.mEnabled = enabled); |
| } |
| } |
| |
| @Override |
| public void autoFill(List<AutoFillId> ids, List<AutoFillValue> values) { |
| // TODO(b/33197203): must keep the dataset so subsequent calls pass the same |
| // dataset.extras to service |
| final AutoFillManager autoFillManager = mAutoFillManager.get(); |
| if (autoFillManager != null) { |
| autoFillManager.mContext.getMainThreadHandler().post(() -> { |
| if (autoFillManager.getClient() != null) { |
| autoFillManager.getClient().autoFill(ids, values); |
| } |
| }); |
| } |
| } |
| |
| @Override |
| public void authenticate(IntentSender intent, Intent fillInIntent) { |
| final AutoFillManager autoFillManager = mAutoFillManager.get(); |
| if (autoFillManager != null) { |
| autoFillManager.mContext.getMainThreadHandler().post(() -> { |
| if (autoFillManager.getClient() != null) { |
| autoFillManager.getClient().authenticate(intent, fillInIntent); |
| } |
| }); |
| } |
| } |
| } |
| } |