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

Commit e7849fb0 authored by Curtis Belmonte's avatar Curtis Belmonte
Browse files

RESTRICT AUTOMERGE Support UDFPS multi-stage enrollment 

Adds support for showing multiple stages during UDFPS enrollment:
1. Initial touch & center enroll
2. Guided enroll (or continued center enroll for a11y)
3. Fingertip enroll
4. Edge enroll

Test: Manual

Bug: 198858684
Change-Id: I6646db9038d236eca6d6d62e1c7ddf7649e4945e
Merged-In: Ifda20133f1ee90c9e1612e9066c19efbb6ffc9cd
Merged-In: Ic12b85bd6f8f1d4068952eb83bcc8a1df21f2e8e
parent 4592bf62

res/layout/udfps_enroll_find_sensor_layout.xml

+1 −1
Original line number Diff line number Diff line
@@ -26,7 +26,7 @@ 
        android:id="@+id/illustration_lottie"

        android:layout_width="match_parent"

        android:layout_height="400dp"

        android:scaleType="centerInside"

        android:scaleType="fitCenter"

        app:lottie_imageAssetsFolder="images"

        app:lottie_autoPlay="true"

        app:lottie_loop="true"

res/raw/udfps_edu_a11y_lottie.json

deleted100644 → 0
+0 −8243

File deleted.

Preview size limit exceeded, changes collapsed.

res/raw/udfps_edu_lottie.json

+9239 −8703

File changed.

Preview size limit exceeded, changes collapsed.

src/com/android/settings/biometrics/fingerprint/FingerprintEnrollEnrolling.java

+141 −45
Original line number Diff line number Diff line
@@ -46,6 +46,7 @@ import android.view.animation.Interpolator; 
import android.widget.ProgressBar;

import android.widget.TextView;



import androidx.annotation.IntDef;

import androidx.appcompat.app.AlertDialog;



import com.android.settings.R;
@@ -58,6 +59,8 @@ import com.google.android.setupcompat.template.FooterBarMixin; 
import com.google.android.setupcompat.template.FooterButton;

import com.google.android.setupcompat.util.WizardManagerHelper;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.util.List;



/**
@@ -69,11 +72,26 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
    static final String TAG_SIDECAR = "sidecar";



    private static final int PROGRESS_BAR_MAX = 10000;

    private static final int FINISH_DELAY = 250;



    /**

     * Enroll with two center touches before going to guided enrollment.

     * TODO(b/198928407): Consolidate with UdfpsEnrollHelper

     */

    private static final int NUM_CENTER_TOUCHES = 2;

    private static final int[] STAGE_THRESHOLDS = new int[] {

            2, // center

            18, // guided

            22, // fingertip

            38, // edges

    };



    private static final int STAGE_UNKNOWN = -1;

    private static final int STAGE_CENTER = 0;

    private static final int STAGE_GUIDED = 1;

    private static final int STAGE_FINGERTIP = 2;

    private static final int STAGE_EDGES = 3;



    @IntDef({STAGE_UNKNOWN, STAGE_CENTER, STAGE_GUIDED, STAGE_FINGERTIP, STAGE_EDGES})

    @Retention(RetentionPolicy.SOURCE)

    private @interface EnrollStage {}



    /**

     * If we don't see progress during this time, we show an error message to remind the users that
@@ -149,7 +167,7 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 


        mIsSetupWizard = WizardManagerHelper.isAnySetupWizard(getIntent());

        if (mCanAssumeUdfps) {

            updateTitleAndDescription();

            updateTitleAndDescriptionForUdfps();

        } else {

            setHeaderText(R.string.security_settings_fingerprint_enroll_repeat_title);

        }
@@ -273,7 +291,7 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
            // UDFPS animations are owned by SystemUI

            if (progress >= PROGRESS_BAR_MAX) {

                // Wait for any animations in SysUI to finish, then proceed to next page

                getMainThreadHandler().postDelayed(mDelayedFinishRunnable, FINISH_DELAY);

                getMainThreadHandler().postDelayed(mDelayedFinishRunnable, getFinishDelay());

            }

            return;

        }
@@ -300,8 +318,55 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
    }



    private void updateTitleAndDescription() {

        if (mSidecar == null || mSidecar.getEnrollmentSteps() == -1) {

        if (mCanAssumeUdfps) {

            updateTitleAndDescriptionForUdfps();

            return;

        }



        if (mSidecar == null || mSidecar.getEnrollmentSteps() == -1) {

            setDescriptionText(R.string.security_settings_fingerprint_enroll_start_message);

        } else {

            setDescriptionText(R.string.security_settings_fingerprint_enroll_repeat_message);

        }

    }



    private void updateTitleAndDescriptionForUdfps() {

        switch (getCurrentStage()) {

            case STAGE_CENTER:

                setHeaderText(R.string.security_settings_fingerprint_enroll_repeat_title);

                setDescriptionText(R.string.security_settings_udfps_enroll_start_message);

                break;



            case STAGE_GUIDED:

                setHeaderText(R.string.security_settings_fingerprint_enroll_repeat_title);

                if (mIsAccessibilityEnabled) {

                    setDescriptionText(R.string.security_settings_udfps_enroll_repeat_a11y_message);

                } else {

                    setDescriptionText(R.string.security_settings_udfps_enroll_repeat_message);

                }

                break;



            case STAGE_FINGERTIP:

                setHeaderText(R.string.security_settings_udfps_enroll_fingertip_title);

                if (isStageHalfCompleted()) {

                    setDescriptionText(R.string.security_settings_fingerprint_enroll_repeat_title);

                } else {

                    setDescriptionText("");

                }

                break;



            case STAGE_EDGES:

                setHeaderText(R.string.security_settings_udfps_enroll_edge_title);

                if (isStageHalfCompleted()) {

                    setDescriptionText(

                            R.string.security_settings_fingerprint_enroll_repeat_message);

                } else {

                    setDescriptionText(R.string.security_settings_udfps_enroll_edge_message);

                }

                break;



            case STAGE_UNKNOWN:

            default:

                // setHeaderText(R.string.security_settings_fingerprint_enroll_udfps_title);

                // Don't use BiometricEnrollBase#setHeaderText, since that invokes setTitle,

                // which gets announced for a11y upon entering the page. For UDFPS, we want to
@@ -309,41 +374,51 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
                getLayout().setHeaderText(

                        R.string.security_settings_fingerprint_enroll_udfps_title);

                setDescriptionText(R.string.security_settings_udfps_enroll_start_message);



                final CharSequence description = getString(

                        R.string.security_settings_udfps_enroll_a11y);

                getLayout().getHeaderTextView().setContentDescription(description);

                setTitle(description);

            } else {

                setDescriptionText(R.string.security_settings_fingerprint_enroll_start_message);

                break;

        }

        } else if (mCanAssumeUdfps && !isCenterEnrollmentComplete()) {

            if (mIsSetupWizard) {

                setHeaderText(R.string.security_settings_udfps_enroll_title_one_more_time);

            } else {

                setHeaderText(R.string.security_settings_fingerprint_enroll_repeat_title);

    }

            setDescriptionText(R.string.security_settings_udfps_enroll_start_message);

        } else {

            if (mCanAssumeUdfps) {

                setHeaderText(R.string.security_settings_fingerprint_enroll_repeat_title);

                if (mIsAccessibilityEnabled) {

                    setDescriptionText(R.string.security_settings_udfps_enroll_repeat_a11y_message);

                } else {

                    setDescriptionText(R.string.security_settings_udfps_enroll_repeat_message);



    @EnrollStage

    private int getCurrentStage() {

        if (mSidecar == null || mSidecar.getEnrollmentSteps() == -1) {

            return STAGE_UNKNOWN;

        }



        final int progressSteps = mSidecar.getEnrollmentSteps() - mSidecar.getEnrollmentRemaining();

        if (progressSteps < STAGE_THRESHOLDS[0]) {

            return STAGE_CENTER;

        } else if (progressSteps < STAGE_THRESHOLDS[1]) {

            return STAGE_GUIDED;

        } else if (progressSteps < STAGE_THRESHOLDS[2]) {

            return STAGE_FINGERTIP;

        } else {

                setDescriptionText(R.string.security_settings_fingerprint_enroll_repeat_message);

            }

            return STAGE_EDGES;

        }

    }



    private boolean isCenterEnrollmentComplete() {

    private boolean isStageHalfCompleted() {

        // Prior to first enrollment step.

        if (mSidecar == null || mSidecar.getEnrollmentSteps() == -1) {

            return false;

        }

        final int stepsEnrolled = mSidecar.getEnrollmentSteps() - mSidecar.getEnrollmentRemaining();

        return stepsEnrolled >= NUM_CENTER_TOUCHES;



        final int progressSteps = mSidecar.getEnrollmentSteps() - mSidecar.getEnrollmentRemaining();

        int prevThreshold = 0;

        for (final int threshold : STAGE_THRESHOLDS) {

            if (progressSteps >= prevThreshold && progressSteps < threshold) {

                final int adjustedProgress = progressSteps - prevThreshold;

                final int adjustedThreshold = threshold - prevThreshold;

                return adjustedProgress >= adjustedThreshold / 2;

            }

            prevThreshold = threshold;

        }



        // After last enrollment step.

        return true;

    }



    @Override
@@ -367,6 +442,7 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 


    @Override

    public void onEnrollmentProgressChange(int steps, int remaining) {

        correctStageThresholds();

        updateProgress(true /* animate */);

        updateTitleAndDescription();

        clearError();
@@ -389,6 +465,23 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
        }

    }



    private void correctStageThresholds() {

        if (mSidecar == null || !mSidecar.isEnrolling() || mSidecar.getEnrollmentSteps() <= 0) {

            Log.d(TAG, "correctStageThresholds: Enrollment not started yet");

            return;

        }



        // Allocate (or subtract) any extra steps for the first enroll stage.

        final int extraSteps = mSidecar.getEnrollmentSteps()

                - STAGE_THRESHOLDS[STAGE_THRESHOLDS.length - 1];

        if (extraSteps != 0) {

            for (int stageIndex = 0; stageIndex < STAGE_THRESHOLDS.length; stageIndex++) {

                STAGE_THRESHOLDS[stageIndex] =

                        Math.max(0, STAGE_THRESHOLDS[stageIndex] + extraSteps);

            }

        }

    }



    private void updateProgress(boolean animate) {

        if (mSidecar == null || !mSidecar.isEnrolling()) {

            Log.d(TAG, "Enrollment not started yet");
@@ -489,9 +582,8 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
        mOrientationEventListener = null;

    }



    private final Animator.AnimatorListener mProgressAnimationListener

            = new Animator.AnimatorListener() {



    private final Animator.AnimatorListener mProgressAnimationListener =

            new Animator.AnimatorListener() {

                @Override

                public void onAnimationStart(Animator animation) { }
@@ -501,7 +593,7 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
                @Override

                public void onAnimationEnd(Animator animation) {

                    if (mProgressBar.getProgress() >= PROGRESS_BAR_MAX) {

                mProgressBar.postDelayed(mDelayedFinishRunnable, FINISH_DELAY);

                        mProgressBar.postDelayed(mDelayedFinishRunnable, getFinishDelay());

                    }

                }
@@ -509,6 +601,10 @@ public class FingerprintEnrollEnrolling extends BiometricsEnrollEnrolling { 
                public void onAnimationCancel(Animator animation) { }

            };



    private long getFinishDelay() {

        return mCanAssumeUdfps ? 400L : 250L;

    }



    // Give the user a chance to see progress completed before jumping to the next stage.

    private final Runnable mDelayedFinishRunnable = new Runnable() {

        @Override

src/com/android/settings/biometrics/fingerprint/FingerprintEnrollFindSensor.java

+0 −9
Original line number Diff line number Diff line
@@ -22,11 +22,9 @@ import android.hardware.fingerprint.FingerprintManager; 
import android.hardware.fingerprint.FingerprintSensorPropertiesInternal;

import android.os.Bundle;

import android.view.View;

import android.view.accessibility.AccessibilityManager;



import androidx.annotation.Nullable;



import com.airbnb.lottie.LottieAnimationView;

import com.android.settings.R;

import com.android.settings.Utils;

import com.android.settings.biometrics.BiometricEnrollBase;
@@ -82,13 +80,6 @@ public class FingerprintEnrollFindSensor extends BiometricEnrollBase implements 
                    .setTheme(R.style.SudGlifButton_Primary)

                    .build()

            );



            LottieAnimationView lottieAnimationView = findViewById(R.id.illustration_lottie);

            AccessibilityManager am = getSystemService(AccessibilityManager.class);

            if (am.isEnabled()) {

                lottieAnimationView.setAnimation(R.raw.udfps_edu_a11y_lottie);

            }



        } else {

            setHeaderText(R.string.security_settings_fingerprint_enroll_find_sensor_title);

            setDescriptionText(R.string.security_settings_fingerprint_enroll_find_sensor_message);