| /* |
| * Copyright (C) 2019 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 com.android.systemui.statusbar.phone |
| |
| import android.annotation.IntDef |
| import android.content.Context |
| import android.content.pm.PackageManager |
| import android.hardware.biometrics.BiometricSourceType |
| import android.provider.Settings |
| import androidx.annotation.VisibleForTesting |
| import com.android.systemui.Dumpable |
| import com.android.systemui.dagger.SysUISingleton |
| import com.android.systemui.dagger.qualifiers.Application |
| import com.android.systemui.dump.DumpManager |
| import com.android.systemui.plugins.statusbar.StatusBarStateController |
| import com.android.systemui.res.R |
| import com.android.systemui.shade.data.repository.ShadeRepository |
| import com.android.systemui.statusbar.NotificationLockscreenUserManager |
| import com.android.systemui.statusbar.StatusBarState |
| import com.android.systemui.statusbar.notification.stack.StackScrollAlgorithm |
| import com.android.systemui.statusbar.policy.DevicePostureController |
| import com.android.systemui.statusbar.policy.DevicePostureController.DEVICE_POSTURE_UNKNOWN |
| import com.android.systemui.statusbar.policy.DevicePostureController.DevicePostureInt |
| import com.android.systemui.statusbar.policy.KeyguardStateController |
| import com.android.systemui.tuner.TunerService |
| import kotlinx.coroutines.CoroutineScope |
| import kotlinx.coroutines.flow.distinctUntilChanged |
| import kotlinx.coroutines.flow.map |
| import kotlinx.coroutines.launch |
| import java.io.PrintWriter |
| import javax.inject.Inject |
| |
| @SysUISingleton |
| open class KeyguardBypassController : Dumpable, StackScrollAlgorithm.BypassController { |
| |
| private val mKeyguardStateController: KeyguardStateController |
| private val statusBarStateController: StatusBarStateController |
| private val shadeRepository: ShadeRepository |
| private val devicePostureController: DevicePostureController |
| @BypassOverride private val bypassOverride: Int |
| private var hasFaceFeature: Boolean |
| @DevicePostureInt private val configFaceAuthSupportedPosture: Int |
| @DevicePostureInt private var postureState: Int = DEVICE_POSTURE_UNKNOWN |
| private var pendingUnlock: PendingUnlock? = null |
| private val listeners = mutableListOf<OnBypassStateChangedListener>() |
| private val faceAuthEnabledChangedCallback = object : KeyguardStateController.Callback { |
| override fun onFaceAuthEnabledChanged() = notifyListeners() |
| } |
| |
| @IntDef( |
| FACE_UNLOCK_BYPASS_NO_OVERRIDE, |
| FACE_UNLOCK_BYPASS_ALWAYS, |
| FACE_UNLOCK_BYPASS_NEVER |
| ) |
| @Retention(AnnotationRetention.SOURCE) |
| private annotation class BypassOverride |
| |
| /** |
| * Pending unlock info: |
| * |
| * The pending unlock type which is set if the bypass was blocked when it happened. |
| * |
| * Whether the pending unlock type is strong biometric or non-strong biometric |
| * (i.e. weak or convenience). |
| */ |
| private data class PendingUnlock( |
| val pendingUnlockType: BiometricSourceType, |
| val isStrongBiometric: Boolean |
| ) |
| |
| lateinit var unlockController: BiometricUnlockController |
| var isPulseExpanding = false |
| |
| /** delegates to [bypassEnabled] but conforms to [StackScrollAlgorithm.BypassController] */ |
| override fun isBypassEnabled() = bypassEnabled |
| |
| /** |
| * If face unlock dismisses the lock screen or keeps user on keyguard for the current user. |
| */ |
| var bypassEnabled: Boolean = false |
| get() { |
| val enabled = when (bypassOverride) { |
| FACE_UNLOCK_BYPASS_ALWAYS -> true |
| FACE_UNLOCK_BYPASS_NEVER -> false |
| else -> field |
| } |
| return enabled && mKeyguardStateController.isFaceAuthEnabled && |
| isPostureAllowedForFaceAuth() |
| } |
| private set(value) { |
| field = value |
| notifyListeners() |
| } |
| |
| var bouncerShowing: Boolean = false |
| var altBouncerShowing: Boolean = false |
| var launchingAffordance: Boolean = false |
| var qsExpanded = false |
| |
| @Inject |
| constructor( |
| context: Context, |
| @Application applicationScope: CoroutineScope, |
| tunerService: TunerService, |
| statusBarStateController: StatusBarStateController, |
| lockscreenUserManager: NotificationLockscreenUserManager, |
| keyguardStateController: KeyguardStateController, |
| shadeRepository: ShadeRepository, |
| devicePostureController: DevicePostureController, |
| dumpManager: DumpManager |
| ) { |
| this.mKeyguardStateController = keyguardStateController |
| this.statusBarStateController = statusBarStateController |
| this.shadeRepository = shadeRepository |
| this.devicePostureController = devicePostureController |
| |
| bypassOverride = context.resources.getInteger(R.integer.config_face_unlock_bypass_override) |
| configFaceAuthSupportedPosture = |
| context.resources.getInteger(R.integer.config_face_auth_supported_posture) |
| |
| hasFaceFeature = context.packageManager.hasSystemFeature(PackageManager.FEATURE_FACE) |
| if (!hasFaceFeature) { |
| return |
| } |
| |
| |
| if (configFaceAuthSupportedPosture != DEVICE_POSTURE_UNKNOWN) { |
| devicePostureController.addCallback { posture -> |
| if (postureState != posture) { |
| postureState = posture |
| notifyListeners() |
| } |
| } |
| } |
| |
| dumpManager.registerNormalDumpable("KeyguardBypassController", this) |
| statusBarStateController.addCallback(object : StatusBarStateController.StateListener { |
| override fun onStateChanged(newState: Int) { |
| if (newState != StatusBarState.KEYGUARD) { |
| pendingUnlock = null |
| } |
| } |
| }) |
| |
| listenForQsExpandedChange(applicationScope) |
| |
| val dismissByDefault = if (context.resources.getBoolean( |
| com.android.internal.R.bool.config_faceAuthDismissesKeyguard)) 1 else 0 |
| |
| tunerService.addTunable({ key, _ -> |
| bypassEnabled = tunerService.getValue(key, dismissByDefault) != 0 |
| }, Settings.Secure.FACE_UNLOCK_DISMISSES_KEYGUARD) |
| |
| lockscreenUserManager.addUserChangedListener( |
| object : NotificationLockscreenUserManager.UserChangedListener { |
| override fun onUserChanged(userId: Int) { |
| pendingUnlock = null |
| } |
| }) |
| } |
| |
| @VisibleForTesting |
| fun listenForQsExpandedChange(scope: CoroutineScope) = |
| scope.launch { |
| shadeRepository.qsExpansion.map { it > 0f }.distinctUntilChanged() |
| .collect { isQsExpanded -> |
| val changed = qsExpanded != isQsExpanded |
| qsExpanded = isQsExpanded |
| if (changed && !isQsExpanded) { |
| maybePerformPendingUnlock() |
| } |
| } |
| } |
| |
| private fun notifyListeners() = listeners.forEach { it.onBypassStateChanged(bypassEnabled) } |
| |
| /** |
| * Notify that the biometric unlock has happened. |
| * |
| * @return false if we can not wake and unlock right now |
| */ |
| fun onBiometricAuthenticated( |
| biometricSourceType: BiometricSourceType, |
| isStrongBiometric: Boolean |
| ): Boolean { |
| if (biometricSourceType == BiometricSourceType.FACE && bypassEnabled) { |
| val can = canBypass() |
| if (!can && (isPulseExpanding || qsExpanded)) { |
| pendingUnlock = PendingUnlock(biometricSourceType, isStrongBiometric) |
| } |
| return can |
| } |
| return true |
| } |
| |
| fun maybePerformPendingUnlock() { |
| if (pendingUnlock != null) { |
| if (onBiometricAuthenticated(pendingUnlock!!.pendingUnlockType, |
| pendingUnlock!!.isStrongBiometric)) { |
| unlockController.startWakeAndUnlock(pendingUnlock!!.pendingUnlockType, |
| pendingUnlock!!.isStrongBiometric) |
| pendingUnlock = null |
| } |
| } |
| } |
| |
| /** |
| * If keyguard can be dismissed because of bypass. |
| */ |
| fun canBypass(): Boolean { |
| if (bypassEnabled) { |
| return when { |
| bouncerShowing -> true |
| altBouncerShowing -> true |
| statusBarStateController.state != StatusBarState.KEYGUARD -> false |
| launchingAffordance -> false |
| isPulseExpanding || qsExpanded -> false |
| else -> true |
| } |
| } |
| return false |
| } |
| |
| fun onStartedGoingToSleep() { |
| pendingUnlock = null |
| } |
| |
| fun isPostureAllowedForFaceAuth(): Boolean { |
| return when (configFaceAuthSupportedPosture) { |
| DEVICE_POSTURE_UNKNOWN -> true |
| else -> (postureState == configFaceAuthSupportedPosture) |
| } |
| } |
| |
| override fun dump(pw: PrintWriter, args: Array<out String>) { |
| pw.println("KeyguardBypassController:") |
| if (pendingUnlock != null) { |
| pw.println(" mPendingUnlock.pendingUnlockType: ${pendingUnlock!!.pendingUnlockType}") |
| pw.println(" mPendingUnlock.isStrongBiometric: ${pendingUnlock!!.isStrongBiometric}") |
| } else { |
| pw.println(" mPendingUnlock: $pendingUnlock") |
| } |
| pw.println(" bypassEnabled: $bypassEnabled") |
| pw.println(" canBypass: ${canBypass()}") |
| pw.println(" bouncerShowing: $bouncerShowing") |
| pw.println(" altBouncerShowing: $altBouncerShowing") |
| pw.println(" isPulseExpanding: $isPulseExpanding") |
| pw.println(" launchingAffordance: $launchingAffordance") |
| pw.println(" qSExpanded: $qsExpanded") |
| pw.println(" hasFaceFeature: $hasFaceFeature") |
| pw.println(" postureState: $postureState") |
| } |
| |
| /** Registers a listener for bypass state changes. */ |
| fun registerOnBypassStateChangedListener(listener: OnBypassStateChangedListener) { |
| val start = listeners.isEmpty() |
| listeners.add(listener) |
| if (start) { |
| mKeyguardStateController.addCallback(faceAuthEnabledChangedCallback) |
| } |
| } |
| |
| /** |
| * Unregisters a listener for bypass state changes, previous registered with |
| * [registerOnBypassStateChangedListener] |
| */ |
| fun unregisterOnBypassStateChangedListener(listener: OnBypassStateChangedListener) { |
| listeners.remove(listener) |
| if (listeners.isEmpty()) { |
| mKeyguardStateController.removeCallback(faceAuthEnabledChangedCallback) |
| } |
| } |
| |
| /** Listener for bypass state change events. */ |
| interface OnBypassStateChangedListener { |
| /** Invoked when bypass becomes enabled or disabled. */ |
| fun onBypassStateChanged(isEnabled: Boolean) |
| } |
| |
| companion object { |
| private const val FACE_UNLOCK_BYPASS_NO_OVERRIDE = 0 |
| private const val FACE_UNLOCK_BYPASS_ALWAYS = 1 |
| private const val FACE_UNLOCK_BYPASS_NEVER = 2 |
| } |
| } |
