Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6dad25de authored by Rhed Jao's avatar Rhed Jao
Browse files

Accessibility shortcut improvement (5/n) 

- Adds support for magnification and multiple shortcut targets assigned
  to accessibility shortcut key in AccessibilityManagerService.
- New extra field in ACTION_CHOOSE_ACCESSIBILITY_BUTTON intent to
  support accessibility shortcut key.

Bug: 136293963
Test: atest AccessibilityShortcutControllerTest
Test: atest AccessibilityUserStateTest
Test: atest AccessibilityShortcutTest
Change-Id: If0a446dfd269e82ec0d09db92e86f859cdae50d8
parent 104f3297

api/test-current.txt

+1 −1
Original line number Diff line number Diff line
@@ -4594,7 +4594,7 @@ package android.view.accessibility { 


  public final class AccessibilityManager {

    method public void addAccessibilityServicesStateChangeListener(@NonNull android.view.accessibility.AccessibilityManager.AccessibilityServicesStateChangeListener, @Nullable android.os.Handler);

    method @Nullable @RequiresPermission("android.permission.MANAGE_ACCESSIBILITY") public String getAccessibilityShortcutService();

    method @NonNull @RequiresPermission("android.permission.MANAGE_ACCESSIBILITY") public java.util.List<java.lang.String> getAccessibilityShortcutTargets(int);

    method @RequiresPermission("android.permission.MANAGE_ACCESSIBILITY") public void performAccessibilityShortcut();

    method public void removeAccessibilityServicesStateChangeListener(@NonNull android.view.accessibility.AccessibilityManager.AccessibilityServicesStateChangeListener);

  }

core/java/android/accessibilityservice/AccessibilityShortcutInfo.java

+10 −0
Original line number Diff line number Diff line
@@ -140,6 +140,16 @@ public final class AccessibilityShortcutInfo { 
        return mActivityInfo;

    }



    /**

     * The {@link ComponentName} of the accessibility shortcut target.

     *

     * @return The component name

     */

    @NonNull

    public ComponentName getComponentName() {

        return mComponentName;

    }



    /**

     * The localized summary of the accessibility shortcut target.

     *

core/java/android/view/accessibility/AccessibilityManager.java

+44 −7
Original line number Diff line number Diff line
@@ -117,7 +117,7 @@ public final class AccessibilityManager { 
     * Activity action: Launch UI to manage which accessibility service or feature is assigned

     * to the navigation bar Accessibility button.

     * <p>

     * Input: Nothing.

     * Input: {@link #EXTRA_SHORTCUT_TYPE} is the shortcut type.

     * </p>

     * <p>

     * Output: Nothing.
@@ -129,6 +129,42 @@ public final class AccessibilityManager { 
    public static final String ACTION_CHOOSE_ACCESSIBILITY_BUTTON =

            "com.android.internal.intent.action.CHOOSE_ACCESSIBILITY_BUTTON";



    /**

     * Used as an int extra field in {@link #ACTION_CHOOSE_ACCESSIBILITY_BUTTON} intent to specify

     * the shortcut type.

     *

     * @hide

     */

    public static final String EXTRA_SHORTCUT_TYPE =

            "com.android.internal.intent.extra.SHORTCUT_TYPE";



    /**

     * Used as an int value for {@link #EXTRA_SHORTCUT_TYPE} to represent the accessibility button

     * shortcut type.

     *

     * @hide

     */

    public static final int ACCESSIBILITY_BUTTON = 0;



    /**

     * Used as an int value for {@link #EXTRA_SHORTCUT_TYPE} to represent hardware key shortcut,

     * such as volume key button.

     *

     * @hide

     */

    public static final int ACCESSIBILITY_SHORTCUT_KEY = 1;



    /**

     * Annotations for the shortcut type.

     * @hide

     */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef(value = {

            ACCESSIBILITY_BUTTON,

            ACCESSIBILITY_SHORTCUT_KEY

    })

    public @interface ShortcutType {}



    /**

     * Annotations for content flag of UI.

     * @hide
@@ -1242,27 +1278,28 @@ public final class AccessibilityManager { 
    }



    /**

     * Get the component name of the service currently assigned to the accessibility shortcut.

     * Returns the list of shortcut target names currently assigned to the given shortcut.

     *

     * @return The flattened component name

     * @param shortcutType The shortcut type.

     * @return The list of shortcut target names.

     * @hide

     */

    @TestApi

    @RequiresPermission(Manifest.permission.MANAGE_ACCESSIBILITY)

    @Nullable

    public String getAccessibilityShortcutService() {

    @NonNull

    public List<String> getAccessibilityShortcutTargets(@ShortcutType int shortcutType) {

        final IAccessibilityManager service;

        synchronized (mLock) {

            service = getServiceLocked();

        }

        if (service != null) {

            try {

                return service.getAccessibilityShortcutService();

                return service.getAccessibilityShortcutTargets(shortcutType);

            } catch (RemoteException re) {

                re.rethrowFromSystemServer();

            }

        }

        return null;

        return Collections.emptyList();

    }



    /**

core/java/android/view/accessibility/IAccessibilityManager.aidl

+1 −1
Original line number Diff line number Diff line
@@ -73,7 +73,7 @@ interface IAccessibilityManager { 
    void performAccessibilityShortcut();



    // Requires Manifest.permission.MANAGE_ACCESSIBILITY

    String getAccessibilityShortcutService();

    List<String> getAccessibilityShortcutTargets(int shortcutType);



    // System process only

    boolean sendFingerprintGesture(int gestureKeyCode);

core/java/com/android/internal/accessibility/AccessibilityShortcutController.java

+77 −56
Original line number Diff line number Diff line
@@ -17,6 +17,7 @@ 
package com.android.internal.accessibility;



import static android.view.WindowManager.LayoutParams.TYPE_KEYGUARD_DIALOG;

import static android.view.accessibility.AccessibilityManager.ACCESSIBILITY_SHORTCUT_KEY;



import static com.android.internal.util.ArrayUtils.convertToLongArray;
@@ -34,6 +35,7 @@ import android.media.AudioAttributes; 
import android.media.Ringtone;

import android.media.RingtoneManager;

import android.net.Uri;

import android.os.Build;

import android.os.Handler;

import android.os.UserHandle;

import android.os.Vibrator;
@@ -52,11 +54,12 @@ import com.android.internal.R; 
import com.android.internal.util.function.pooled.PooledLambda;



import java.util.Collections;

import java.util.List;

import java.util.Locale;

import java.util.Map;



/**

 * Class to help manage the accessibility shortcut

 * Class to help manage the accessibility shortcut key

 */

public class AccessibilityShortcutController {

    private static final String TAG = "AccessibilityShortcutController";
@@ -66,6 +69,8 @@ public class AccessibilityShortcutController { 
            new ComponentName("com.android.server.accessibility", "ColorInversion");

    public static final ComponentName DALTONIZER_COMPONENT_NAME =

            new ComponentName("com.android.server.accessibility", "Daltonizer");

    public static final String MAGNIFICATION_CONTROLLER_NAME =

            "com.android.server.accessibility.MagnificationController";



    private static final AudioAttributes VIBRATION_ATTRIBUTES = new AudioAttributes.Builder()

            .setContentType(AudioAttributes.CONTENT_TYPE_SONIFICATION)
@@ -83,26 +88,6 @@ public class AccessibilityShortcutController { 
    // Visible for testing

    public FrameworkObjectProvider mFrameworkObjectProvider = new FrameworkObjectProvider();



    /**

     * Get the component name string for the service or feature currently assigned to the

     * accessiblity shortcut

     *

     * @param context A valid context

     * @param userId The user ID of interest

     * @return The flattened component name string of the service selected by the user, or the

     *         string for the default service if the user has not made a selection

     */

    public static String getTargetServiceComponentNameString(

            Context context, int userId) {

        final String currentShortcutServiceId = Settings.Secure.getStringForUser(

                context.getContentResolver(), Settings.Secure.ACCESSIBILITY_SHORTCUT_TARGET_SERVICE,

                userId);

        if (currentShortcutServiceId != null) {

            return currentShortcutServiceId;

        }

        return context.getString(R.string.config_defaultAccessibilityService);

    }



    /**

     * @return An immutable map from dummy component names to feature info for toggling a framework

     *         feature
@@ -163,7 +148,7 @@ public class AccessibilityShortcutController { 
    /**

     * Check if the shortcut is available.

     *

     * @param onLockScreen Whether or not the phone is currently locked.

     * @param phoneLocked Whether or not the phone is currently locked.

     *

     * @return {@code true} if the shortcut is available

     */
@@ -172,8 +157,7 @@ public class AccessibilityShortcutController { 
    }



    public void onSettingsChanged() {

        final boolean haveValidService =

                !TextUtils.isEmpty(getTargetServiceComponentNameString(mContext, mUserId));

        final boolean hasShortcutTarget = hasShortcutTarget();

        final ContentResolver cr = mContext.getContentResolver();

        final boolean enabled = Settings.Secure.getIntForUser(

                cr, Settings.Secure.ACCESSIBILITY_SHORTCUT_ENABLED, 1, mUserId) == 1;
@@ -183,7 +167,7 @@ public class AccessibilityShortcutController { 
        mEnabledOnLockScreen = Settings.Secure.getIntForUser(

                cr, Settings.Secure.ACCESSIBILITY_SHORTCUT_ON_LOCK_SCREEN,

                dialogAlreadyShown, mUserId) == 1;

        mIsShortcutEnabled = enabled && haveValidService;

        mIsShortcutEnabled = enabled && hasShortcutTarget;

    }



    /**
@@ -205,7 +189,6 @@ public class AccessibilityShortcutController { 
            vibrator.vibrate(vibePattern, -1, VIBRATION_ATTRIBUTES);

        }





        if (dialogAlreadyShown == 0) {

            // The first time, we show a warning rather than toggle the service to give the user a

            // chance to turn off this feature before stuff gets enabled.
@@ -229,16 +212,33 @@ public class AccessibilityShortcutController { 
                mAlertDialog.dismiss();

                mAlertDialog = null;

            }

            showToast();

            mFrameworkObjectProvider.getAccessibilityManagerInstance(mContext)

                    .performAccessibilityShortcut();

        }

    }



            // Show a toast alerting the user to what's happening

            final String serviceName = getShortcutFeatureDescription(false /* no summary */);

    /**

     * Show toast if current assigned shortcut target is an accessibility service and its target

     * sdk version is less than or equal to Q, or greater than Q and does not request

     * accessibility button.

     */

    private void showToast() {

        final AccessibilityServiceInfo serviceInfo = getInfoForTargetService();

        if (serviceInfo == null) {

            return;

        }

        final String serviceName = getShortcutFeatureDescription(/* no summary */ false);

        if (serviceName == null) {

                Slog.e(TAG, "Accessibility shortcut set to invalid service");

            return;

        }

        final boolean requestA11yButton = (serviceInfo.flags

                & AccessibilityServiceInfo.FLAG_REQUEST_ACCESSIBILITY_BUTTON) != 0;

        if (serviceInfo.getResolveInfo().serviceInfo.applicationInfo

                .targetSdkVersion > Build.VERSION_CODES.Q && requestA11yButton) {

            return;

        }

        // For accessibility services, show a toast explaining what we're doing.

            final AccessibilityServiceInfo serviceInfo = getInfoForTargetService();

            if (serviceInfo != null) {

        String toastMessageFormatString = mContext.getString(isServiceEnabled(serviceInfo)

                ? R.string.accessibility_shortcut_disabling_service

                : R.string.accessibility_shortcut_enabling_service);
@@ -250,11 +250,6 @@ public class AccessibilityShortcutController { 
        warningToast.show();

    }



            mFrameworkObjectProvider.getAccessibilityManagerInstance(mContext)

                    .performAccessibilityShortcut();

        }

    }



    private AlertDialog createShortcutWarningDialog(int userId) {

        final String serviceDescription = getShortcutFeatureDescription(true /* Include summary */);
@@ -288,25 +283,21 @@ public class AccessibilityShortcutController { 
    }



    private AccessibilityServiceInfo getInfoForTargetService() {

        final String currentShortcutServiceString = getTargetServiceComponentNameString(

                mContext, UserHandle.USER_CURRENT);

        if (currentShortcutServiceString == null) {

        final ComponentName targetComponentName = getShortcutTargetComponentName();

        if (targetComponentName == null) {

            return null;

        }

        AccessibilityManager accessibilityManager =

                mFrameworkObjectProvider.getAccessibilityManagerInstance(mContext);

        return accessibilityManager.getInstalledServiceInfoWithComponentName(

                        ComponentName.unflattenFromString(currentShortcutServiceString));

                targetComponentName);

    }



    private String getShortcutFeatureDescription(boolean includeSummary) {

        final String currentShortcutServiceString = getTargetServiceComponentNameString(

                mContext, UserHandle.USER_CURRENT);

        if (currentShortcutServiceString == null) {

        final ComponentName targetComponentName = getShortcutTargetComponentName();

        if (targetComponentName == null) {

            return null;

        }

        final ComponentName targetComponentName =

                ComponentName.unflattenFromString(currentShortcutServiceString);

        final ToggleableFrameworkFeatureInfo frameworkFeatureInfo =

                getFrameworkShortcutFeaturesMap().get(targetComponentName);

        if (frameworkFeatureInfo != null) {
@@ -371,6 +362,36 @@ public class AccessibilityShortcutController { 
        return true;

    }



    /**

     * Returns {@code true} if any shortcut targets were assigned to accessibility shortcut key.

     */

    private boolean hasShortcutTarget() {

        // AccessibilityShortcutController is initialized earlier than AccessibilityManagerService.

        // AccessibilityManager#getAccessibilityShortcutTargets may not return correct shortcut

        // targets during boot. Needs to read settings directly here.

        String shortcutTargets = Settings.Secure.getStringForUser(mContext.getContentResolver(),

                Settings.Secure.ACCESSIBILITY_SHORTCUT_TARGET_SERVICE, mUserId);

        if (TextUtils.isEmpty(shortcutTargets)) {

            shortcutTargets = mContext.getString(R.string.config_defaultAccessibilityService);

        }

        return !TextUtils.isEmpty(shortcutTargets);

    }



    /**

     * Gets the component name of the shortcut target.

     *

     * @return The component name, or null if it's assigned by multiple targets.

     */

    private ComponentName getShortcutTargetComponentName() {

        final List<String> shortcutTargets = mFrameworkObjectProvider

                .getAccessibilityManagerInstance(mContext)

                .getAccessibilityShortcutTargets(ACCESSIBILITY_SHORTCUT_KEY);

        if (shortcutTargets.size() != 1) {

            return null;

        }

        return ComponentName.unflattenFromString(shortcutTargets.get(0));

    }



    /**

     * Class to wrap TextToSpeech for shortcut dialog spoken feedback.

     */