/* * Copyright (C) 2007 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.internal.policy.impl; import static android.provider.Settings.System.SCREEN_OFF_TIMEOUT; import com.android.internal.policy.impl.KeyguardUpdateMonitor.InfoCallbackImpl; import com.android.internal.telephony.IccCard; import com.android.internal.widget.LockPatternUtils; import android.app.ActivityManagerNative; import android.app.AlarmManager; import android.app.PendingIntent; import android.app.StatusBarManager; import android.content.BroadcastReceiver; import android.content.ContentResolver; import android.content.Context; import android.content.Intent; import android.content.IntentFilter; import android.media.AudioManager; import android.media.SoundPool; import android.os.Handler; import android.os.LocalPowerManager; import android.os.Message; import android.os.PowerManager; import android.os.RemoteException; import android.os.SystemClock; import android.os.SystemProperties; import android.provider.Settings; import android.telephony.TelephonyManager; import android.util.EventLog; import android.util.Log; import android.view.KeyEvent; import android.view.WindowManagerImpl; import android.view.WindowManagerPolicy; /** * Mediates requests related to the keyguard. This includes queries about the * state of the keyguard, power management events that effect whether the keyguard * should be shown or reset, callbacks to the phone window manager to notify * it of when the keyguard is showing, and events from the keyguard view itself * stating that the keyguard was succesfully unlocked. * * Note that the keyguard view is shown when the screen is off (as appropriate) * so that once the screen comes on, it will be ready immediately. * * Example queries about the keyguard: * - is {movement, key} one that should wake the keygaurd? * - is the keyguard showing? * - are input events restricted due to the state of the keyguard? * * Callbacks to the phone window manager: * - the keyguard is showing * * Example external events that translate to keyguard view changes: * - screen turned off -> reset the keyguard, and show it so it will be ready * next time the screen turns on * - keyboard is slid open -> if the keyguard is not secure, hide it * * Events from the keyguard view: * - user succesfully unlocked keyguard -> hide keyguard view, and no longer * restrict input events. * * Note: in addition to normal power managment events that effect the state of * whether the keyguard should be showing, external apps and services may request * that the keyguard be disabled via {@link #setKeyguardEnabled(boolean)}. When * false, this will override all other conditions for turning on the keyguard. * * Threading and synchronization: * This class is created by the initialization routine of the {@link WindowManagerPolicy}, * and runs on its thread. The keyguard UI is created from that thread in the * constructor of this class. The apis may be called from other threads, including the * {@link com.android.server.input.InputManagerService}'s and {@link android.view.WindowManager}'s. * Therefore, methods on this class are synchronized, and any action that is pointed * directly to the keyguard UI is posted to a {@link Handler} to ensure it is taken on the UI * thread of the keyguard. */ public class KeyguardViewMediator implements KeyguardViewCallback, KeyguardUpdateMonitor.SimStateCallback { private static final int KEYGUARD_DISPLAY_TIMEOUT_DELAY_DEFAULT = 30000; private final static boolean DEBUG = false; private final static boolean DBG_WAKE = false; private final static String TAG = "KeyguardViewMediator"; private static final String DELAYED_KEYGUARD_ACTION = "com.android.internal.policy.impl.PhoneWindowManager.DELAYED_KEYGUARD"; // used for handler messages private static final int TIMEOUT = 1; private static final int SHOW = 2; private static final int HIDE = 3; private static final int RESET = 4; private static final int VERIFY_UNLOCK = 5; private static final int NOTIFY_SCREEN_OFF = 6; private static final int NOTIFY_SCREEN_ON = 7; private static final int WAKE_WHEN_READY = 8; private static final int KEYGUARD_DONE = 9; private static final int KEYGUARD_DONE_DRAWING = 10; private static final int KEYGUARD_DONE_AUTHENTICATING = 11; private static final int SET_HIDDEN = 12; private static final int KEYGUARD_TIMEOUT = 13; /** * The default amount of time we stay awake (used for all key input) */ protected static final int AWAKE_INTERVAL_DEFAULT_MS = 10000; /** * How long to wait after the screen turns off due to timeout before * turning on the keyguard (i.e, the user has this much time to turn * the screen back on without having to face the keyguard). */ private static final int KEYGUARD_LOCK_AFTER_DELAY_DEFAULT = 5000; /** * How long we'll wait for the {@link KeyguardViewCallback#keyguardDoneDrawing()} * callback before unblocking a call to {@link #setKeyguardEnabled(boolean)} * that is reenabling the keyguard. */ private static final int KEYGUARD_DONE_DRAWING_TIMEOUT_MS = 2000; /** * Allow the user to expand the status bar when the keyguard is engaged * (without a pattern or password). */ private static final boolean ENABLE_INSECURE_STATUS_BAR_EXPAND = true; /** The stream type that the lock sounds are tied to. */ private int mMasterStreamType; private Context mContext; private AlarmManager mAlarmManager; private AudioManager mAudioManager; private StatusBarManager mStatusBarManager; private boolean mShowLockIcon; private boolean mShowingLockIcon; private boolean mSystemReady; // Whether the next call to playSounds() should be skipped. Defaults to // true because the first lock (on boot) should be silent. private boolean mSuppressNextLockSound = true; /** Low level access to the power manager for enableUserActivity. Having this * requires that we run in the system process. */ LocalPowerManager mRealPowerManager; /** High level access to the power manager for WakeLocks */ private PowerManager mPM; /** * Used to keep the device awake while the keyguard is showing, i.e for * calls to {@link #pokeWakelock()} */ private PowerManager.WakeLock mWakeLock; /** * Used to keep the device awake while to ensure the keyguard finishes opening before * we sleep. */ private PowerManager.WakeLock mShowKeyguardWakeLock; /** * Does not turn on screen, held while a call to {@link KeyguardViewManager#wakeWhenReadyTq(int)} * is called to make sure the device doesn't sleep before it has a chance to poke * the wake lock. * @see #wakeWhenReadyLocked(int) */ private PowerManager.WakeLock mWakeAndHandOff; private KeyguardViewManager mKeyguardViewManager; // these are protected by synchronized (this) /** * External apps (like the phone app) can tell us to disable the keygaurd. */ private boolean mExternallyEnabled = true; /** * Remember if an external call to {@link #setKeyguardEnabled} with value * false caused us to hide the keyguard, so that we need to reshow it once * the keygaurd is reenabled with another call with value true. */ private boolean mNeedToReshowWhenReenabled = false; // cached value of whether we are showing (need to know this to quickly // answer whether the input should be restricted) private boolean mShowing = false; // true if the keyguard is hidden by another window private boolean mHidden = false; /** * Helps remember whether the screen has turned on since the last time * it turned off due to timeout. see {@link #onScreenTurnedOff(int)} */ private int mDelayedShowingSequence; private int mWakelockSequence; private PhoneWindowManager mCallback; /** * If the user has disabled the keyguard, then requests to exit, this is * how we'll ultimately let them know whether it was successful. We use this * var being non-null as an indicator that there is an in progress request. */ private WindowManagerPolicy.OnKeyguardExitResult mExitSecureCallback; // the properties of the keyguard private KeyguardViewProperties mKeyguardViewProperties; private KeyguardUpdateMonitor mUpdateMonitor; private boolean mScreenOn = false; // last known state of the cellular connection private String mPhoneState = TelephonyManager.EXTRA_STATE_IDLE; /** * we send this intent when the keyguard is dismissed. */ private Intent mUserPresentIntent; /** * {@link #setKeyguardEnabled} waits on this condition when it reenables * the keyguard. */ private boolean mWaitingUntilKeyguardVisible = false; private LockPatternUtils mLockPatternUtils; private SoundPool mLockSounds; private int mLockSoundId; private int mUnlockSoundId; private int mLockSoundStreamId; /** * The volume applied to the lock/unlock sounds. */ private final float mLockSoundVolume; InfoCallbackImpl mInfoCallback = new InfoCallbackImpl() { @Override public void onClockVisibilityChanged() { adjustStatusBarLocked(); } @Override public void onDeviceProvisioned() { mContext.sendBroadcast(mUserPresentIntent); } }; public KeyguardViewMediator(Context context, PhoneWindowManager callback, LocalPowerManager powerManager) { mContext = context; mRealPowerManager = powerManager; mPM = (PowerManager) context.getSystemService(Context.POWER_SERVICE); mWakeLock = mPM.newWakeLock( PowerManager.FULL_WAKE_LOCK | PowerManager.ACQUIRE_CAUSES_WAKEUP, "keyguard"); mWakeLock.setReferenceCounted(false); mShowKeyguardWakeLock = mPM.newWakeLock(PowerManager.PARTIAL_WAKE_LOCK, "show keyguard"); mShowKeyguardWakeLock.setReferenceCounted(false); mWakeAndHandOff = mPM.newWakeLock( PowerManager.PARTIAL_WAKE_LOCK, "keyguardWakeAndHandOff"); mWakeAndHandOff.setReferenceCounted(false); IntentFilter filter = new IntentFilter(); filter.addAction(DELAYED_KEYGUARD_ACTION); filter.addAction(TelephonyManager.ACTION_PHONE_STATE_CHANGED); context.registerReceiver(mBroadCastReceiver, filter); mAlarmManager = (AlarmManager) context .getSystemService(Context.ALARM_SERVICE); mCallback = callback; mUpdateMonitor = new KeyguardUpdateMonitor(context); mUpdateMonitor.registerInfoCallback(mInfoCallback); mUpdateMonitor.registerSimStateCallback(this); mLockPatternUtils = new LockPatternUtils(mContext); mKeyguardViewProperties = new LockPatternKeyguardViewProperties(mLockPatternUtils, mUpdateMonitor); mKeyguardViewManager = new KeyguardViewManager( context, WindowManagerImpl.getDefault(), this, mKeyguardViewProperties, mUpdateMonitor); mUserPresentIntent = new Intent(Intent.ACTION_USER_PRESENT); mUserPresentIntent.addFlags(Intent.FLAG_RECEIVER_REPLACE_PENDING | Intent.FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT); final ContentResolver cr = mContext.getContentResolver(); mShowLockIcon = (Settings.System.getInt(cr, "show_status_bar_lock", 0) == 1); mLockSounds = new SoundPool(1, AudioManager.STREAM_SYSTEM, 0); String soundPath = Settings.System.getString(cr, Settings.System.LOCK_SOUND); if (soundPath != null) { mLockSoundId = mLockSounds.load(soundPath, 1); } if (soundPath == null || mLockSoundId == 0) { if (DEBUG) Log.d(TAG, "failed to load sound from " + soundPath); } soundPath = Settings.System.getString(cr, Settings.System.UNLOCK_SOUND); if (soundPath != null) { mUnlockSoundId = mLockSounds.load(soundPath, 1); } if (soundPath == null || mUnlockSoundId == 0) { if (DEBUG) Log.d(TAG, "failed to load sound from " + soundPath); } int lockSoundDefaultAttenuation = context.getResources().getInteger( com.android.internal.R.integer.config_lockSoundVolumeDb); mLockSoundVolume = (float)Math.pow(10, lockSoundDefaultAttenuation/20); IntentFilter userFilter = new IntentFilter(); userFilter.addAction(Intent.ACTION_USER_SWITCHED); userFilter.addAction(Intent.ACTION_USER_REMOVED); mContext.registerReceiver(mUserChangeReceiver, userFilter); } /** * Let us know that the system is ready after startup. */ public void onSystemReady() { synchronized (this) { if (DEBUG) Log.d(TAG, "onSystemReady"); mSystemReady = true; doKeyguardLocked(); } } /** * Called to let us know the screen was turned off. * @param why either {@link WindowManagerPolicy#OFF_BECAUSE_OF_USER}, * {@link WindowManagerPolicy#OFF_BECAUSE_OF_TIMEOUT} or * {@link WindowManagerPolicy#OFF_BECAUSE_OF_PROX_SENSOR}. */ public void onScreenTurnedOff(int why) { synchronized (this) { mScreenOn = false; if (DEBUG) Log.d(TAG, "onScreenTurnedOff(" + why + ")"); // Lock immediately based on setting if secure (user has a pin/pattern/password). // This also "locks" the device when not secure to provide easy access to the // camera while preventing unwanted input. final boolean lockImmediately = mLockPatternUtils.getPowerButtonInstantlyLocks() || !mLockPatternUtils.isSecure(); if (mExitSecureCallback != null) { if (DEBUG) Log.d(TAG, "pending exit secure callback cancelled"); mExitSecureCallback.onKeyguardExitResult(false); mExitSecureCallback = null; if (!mExternallyEnabled) { hideLocked(); } } else if (mShowing) { notifyScreenOffLocked(); resetStateLocked(); } else if (why == WindowManagerPolicy.OFF_BECAUSE_OF_TIMEOUT || (why == WindowManagerPolicy.OFF_BECAUSE_OF_USER && !lockImmediately)) { // if the screen turned off because of timeout or the user hit the power button // and we don't need to lock immediately, set an alarm // to enable it a little bit later (i.e, give the user a chance // to turn the screen back on within a certain window without // having to unlock the screen) final ContentResolver cr = mContext.getContentResolver(); // From DisplaySettings long displayTimeout = Settings.System.getInt(cr, SCREEN_OFF_TIMEOUT, KEYGUARD_DISPLAY_TIMEOUT_DELAY_DEFAULT); // From SecuritySettings final long lockAfterTimeout = Settings.Secure.getInt(cr, Settings.Secure.LOCK_SCREEN_LOCK_AFTER_TIMEOUT, KEYGUARD_LOCK_AFTER_DELAY_DEFAULT); // From DevicePolicyAdmin final long policyTimeout = mLockPatternUtils.getDevicePolicyManager() .getMaximumTimeToLock(null); long timeout; if (policyTimeout > 0) { // policy in effect. Make sure we don't go beyond policy limit. displayTimeout = Math.max(displayTimeout, 0); // ignore negative values timeout = Math.min(policyTimeout - displayTimeout, lockAfterTimeout); } else { timeout = lockAfterTimeout; } if (timeout <= 0) { // Lock now mSuppressNextLockSound = true; doKeyguardLocked(); } else { // Lock in the future long when = SystemClock.elapsedRealtime() + timeout; Intent intent = new Intent(DELAYED_KEYGUARD_ACTION); intent.putExtra("seq", mDelayedShowingSequence); PendingIntent sender = PendingIntent.getBroadcast(mContext, 0, intent, PendingIntent.FLAG_CANCEL_CURRENT); mAlarmManager.set(AlarmManager.ELAPSED_REALTIME_WAKEUP, when, sender); if (DEBUG) Log.d(TAG, "setting alarm to turn off keyguard, seq = " + mDelayedShowingSequence); } } else if (why == WindowManagerPolicy.OFF_BECAUSE_OF_PROX_SENSOR) { // Do not enable the keyguard if the prox sensor forced the screen off. } else { doKeyguardLocked(); } } } /** * Let's us know the screen was turned on. */ public void onScreenTurnedOn(KeyguardViewManager.ShowListener showListener) { synchronized (this) { mScreenOn = true; mDelayedShowingSequence++; if (DEBUG) Log.d(TAG, "onScreenTurnedOn, seq = " + mDelayedShowingSequence); if (showListener != null) { notifyScreenOnLocked(showListener); } } } /** * Same semantics as {@link WindowManagerPolicy#enableKeyguard}; provide * a way for external stuff to override normal keyguard behavior. For instance * the phone app disables the keyguard when it receives incoming calls. */ public void setKeyguardEnabled(boolean enabled) { synchronized (this) { if (DEBUG) Log.d(TAG, "setKeyguardEnabled(" + enabled + ")"); mExternallyEnabled = enabled; if (!enabled && mShowing) { if (mExitSecureCallback != null) { if (DEBUG) Log.d(TAG, "in process of verifyUnlock request, ignoring"); // we're in the process of handling a request to verify the user // can get past the keyguard. ignore extraneous requests to disable / reenable return; } // hiding keyguard that is showing, remember to reshow later if (DEBUG) Log.d(TAG, "remembering to reshow, hiding keyguard, " + "disabling status bar expansion"); mNeedToReshowWhenReenabled = true; hideLocked(); } else if (enabled && mNeedToReshowWhenReenabled) { // reenabled after previously hidden, reshow if (DEBUG) Log.d(TAG, "previously hidden, reshowing, reenabling " + "status bar expansion"); mNeedToReshowWhenReenabled = false; if (mExitSecureCallback != null) { if (DEBUG) Log.d(TAG, "onKeyguardExitResult(false), resetting"); mExitSecureCallback.onKeyguardExitResult(false); mExitSecureCallback = null; resetStateLocked(); } else { showLocked(); // block until we know the keygaurd is done drawing (and post a message // to unblock us after a timeout so we don't risk blocking too long // and causing an ANR). mWaitingUntilKeyguardVisible = true; mHandler.sendEmptyMessageDelayed(KEYGUARD_DONE_DRAWING, KEYGUARD_DONE_DRAWING_TIMEOUT_MS); if (DEBUG) Log.d(TAG, "waiting until mWaitingUntilKeyguardVisible is false"); while (mWaitingUntilKeyguardVisible) { try { wait(); } catch (InterruptedException e) { Thread.currentThread().interrupt(); } } if (DEBUG) Log.d(TAG, "done waiting for mWaitingUntilKeyguardVisible"); } } } } /** * @see android.app.KeyguardManager#exitKeyguardSecurely */ public void verifyUnlock(WindowManagerPolicy.OnKeyguardExitResult callback) { synchronized (this) { if (DEBUG) Log.d(TAG, "verifyUnlock"); if (!mUpdateMonitor.isDeviceProvisioned()) { // don't allow this api when the device isn't provisioned if (DEBUG) Log.d(TAG, "ignoring because device isn't provisioned"); callback.onKeyguardExitResult(false); } else if (mExternallyEnabled) { // this only applies when the user has externally disabled the // keyguard. this is unexpected and means the user is not // using the api properly. Log.w(TAG, "verifyUnlock called when not externally disabled"); callback.onKeyguardExitResult(false); } else if (mExitSecureCallback != null) { // already in progress with someone else callback.onKeyguardExitResult(false); } else { mExitSecureCallback = callback; verifyUnlockLocked(); } } } /** * Is the keyguard currently showing? */ public boolean isShowing() { return mShowing; } /** * Is the keyguard currently showing and not being force hidden? */ public boolean isShowingAndNotHidden() { return mShowing && !mHidden; } /** * Notify us when the keyguard is hidden by another window */ public void setHidden(boolean isHidden) { if (DEBUG) Log.d(TAG, "setHidden " + isHidden); mHandler.removeMessages(SET_HIDDEN); Message msg = mHandler.obtainMessage(SET_HIDDEN, (isHidden ? 1 : 0), 0); mHandler.sendMessage(msg); } /** * Handles SET_HIDDEN message sent by setHidden() */ private void handleSetHidden(boolean isHidden) { synchronized (KeyguardViewMediator.this) { if (mHidden != isHidden) { mHidden = isHidden; updateActivityLockScreenState(); adjustUserActivityLocked(); adjustStatusBarLocked(); } } } /** * Used by PhoneWindowManager to enable the keyguard due to a user activity timeout. * This must be safe to call from any thread and with any window manager locks held. */ public void doKeyguardTimeout() { mHandler.removeMessages(KEYGUARD_TIMEOUT); Message msg = mHandler.obtainMessage(KEYGUARD_TIMEOUT); mHandler.sendMessage(msg); } /** * Given the state of the keyguard, is the input restricted? * Input is restricted when the keyguard is showing, or when the keyguard * was suppressed by an app that disabled the keyguard or we haven't been provisioned yet. */ public boolean isInputRestricted() { return mShowing || mNeedToReshowWhenReenabled || !mUpdateMonitor.isDeviceProvisioned(); } /** * Enable the keyguard if the settings are appropriate. Return true if all * work that will happen is done; returns false if the caller can wait for * the keyguard to be shown. */ private void doKeyguardLocked() { // if another app is disabling us, don't show if (!mExternallyEnabled) { if (DEBUG) Log.d(TAG, "doKeyguard: not showing because externally disabled"); // note: we *should* set mNeedToReshowWhenReenabled=true here, but that makes // for an occasional ugly flicker in this situation: // 1) receive a call with the screen on (no keyguard) or make a call // 2) screen times out // 3) user hits key to turn screen back on // instead, we reenable the keyguard when we know the screen is off and the call // ends (see the broadcast receiver below) // TODO: clean this up when we have better support at the window manager level // for apps that wish to be on top of the keyguard return; } // if the keyguard is already showing, don't bother if (mKeyguardViewManager.isShowing()) { if (DEBUG) Log.d(TAG, "doKeyguard: not showing because it is already showing"); return; } // if the setup wizard hasn't run yet, don't show final boolean requireSim = !SystemProperties.getBoolean("keyguard.no_require_sim", false); final boolean provisioned = mUpdateMonitor.isDeviceProvisioned(); final IccCard.State state = mUpdateMonitor.getSimState(); final boolean lockedOrMissing = state.isPinLocked() || ((state == IccCard.State.ABSENT || state == IccCard.State.PERM_DISABLED) && requireSim); if (!lockedOrMissing && !provisioned) { if (DEBUG) Log.d(TAG, "doKeyguard: not showing because device isn't provisioned" + " and the sim is not locked or missing"); return; } if (mLockPatternUtils.isLockScreenDisabled() && !lockedOrMissing) { if (DEBUG) Log.d(TAG, "doKeyguard: not showing because lockscreen is off"); return; } if (DEBUG) Log.d(TAG, "doKeyguard: showing the lock screen"); showLocked(); } /** * Send message to keyguard telling it to reset its state. * @see #handleReset() */ private void resetStateLocked() { if (DEBUG) Log.d(TAG, "resetStateLocked"); Message msg = mHandler.obtainMessage(RESET); mHandler.sendMessage(msg); } /** * Send message to keyguard telling it to verify unlock * @see #handleVerifyUnlock() */ private void verifyUnlockLocked() { if (DEBUG) Log.d(TAG, "verifyUnlockLocked"); mHandler.sendEmptyMessage(VERIFY_UNLOCK); } /** * Send a message to keyguard telling it the screen just turned on. * @see #onScreenTurnedOff(int) * @see #handleNotifyScreenOff */ private void notifyScreenOffLocked() { if (DEBUG) Log.d(TAG, "notifyScreenOffLocked"); mHandler.sendEmptyMessage(NOTIFY_SCREEN_OFF); } /** * Send a message to keyguard telling it the screen just turned on. * @see #onScreenTurnedOn() * @see #handleNotifyScreenOn */ private void notifyScreenOnLocked(KeyguardViewManager.ShowListener showListener) { if (DEBUG) Log.d(TAG, "notifyScreenOnLocked"); Message msg = mHandler.obtainMessage(NOTIFY_SCREEN_ON, showListener); mHandler.sendMessage(msg); } /** * Send message to keyguard telling it about a wake key so it can adjust * its state accordingly and then poke the wake lock when it is ready. * @param keyCode The wake key. * @see #handleWakeWhenReady * @see #onWakeKeyWhenKeyguardShowingTq(int) */ private void wakeWhenReadyLocked(int keyCode) { if (DBG_WAKE) Log.d(TAG, "wakeWhenReadyLocked(" + keyCode + ")"); /** * acquire the handoff lock that will keep the cpu running. this will * be released once the keyguard has set itself up and poked the other wakelock * in {@link #handleWakeWhenReady(int)} */ mWakeAndHandOff.acquire(); Message msg = mHandler.obtainMessage(WAKE_WHEN_READY, keyCode, 0); mHandler.sendMessage(msg); } /** * Send message to keyguard telling it to show itself * @see #handleShow() */ private void showLocked() { if (DEBUG) Log.d(TAG, "showLocked"); // ensure we stay awake until we are finished displaying the keyguard mShowKeyguardWakeLock.acquire(); Message msg = mHandler.obtainMessage(SHOW); mHandler.sendMessage(msg); } /** * Send message to keyguard telling it to hide itself * @see #handleHide() */ private void hideLocked() { if (DEBUG) Log.d(TAG, "hideLocked"); Message msg = mHandler.obtainMessage(HIDE); mHandler.sendMessage(msg); } /** {@inheritDoc} */ public void onSimStateChanged(IccCard.State simState) { if (DEBUG) Log.d(TAG, "onSimStateChanged: " + simState); switch (simState) { case ABSENT: // only force lock screen in case of missing sim if user hasn't // gone through setup wizard synchronized (this) { if (!mUpdateMonitor.isDeviceProvisioned()) { if (!isShowing()) { if (DEBUG) Log.d(TAG, "ICC_ABSENT isn't showing," + " we need to show the keyguard since the " + "device isn't provisioned yet."); doKeyguardLocked(); } else { resetStateLocked(); } } } break; case PIN_REQUIRED: case PUK_REQUIRED: synchronized (this) { if (!isShowing()) { if (DEBUG) Log.d(TAG, "INTENT_VALUE_ICC_LOCKED and keygaurd isn't showing, " + "we need to show keyguard so user can enter their sim pin"); doKeyguardLocked(); } else { resetStateLocked(); } } break; case PERM_DISABLED: synchronized (this) { if (!isShowing()) { if (DEBUG) Log.d(TAG, "PERM_DISABLED and " + "keygaurd isn't showing."); doKeyguardLocked(); } else { if (DEBUG) Log.d(TAG, "PERM_DISABLED, resetStateLocked to" + "show permanently disabled message in lockscreen."); resetStateLocked(); } } break; case READY: synchronized (this) { if (isShowing()) { resetStateLocked(); } } break; } } public boolean isSecure() { return mKeyguardViewProperties.isSecure(); } private void onUserSwitched(int userId) { mLockPatternUtils.setCurrentUser(userId); synchronized (KeyguardViewMediator.this) { resetStateLocked(); } } private void onUserRemoved(int userId) { mLockPatternUtils.removeUser(userId); } private BroadcastReceiver mUserChangeReceiver = new BroadcastReceiver() { @Override public void onReceive(Context context, Intent intent) { String action = intent.getAction(); if (Intent.ACTION_USER_SWITCHED.equals(action)) { onUserSwitched(intent.getIntExtra(Intent.EXTRA_USERID, 0)); } else if (Intent.ACTION_USER_REMOVED.equals(action)) { onUserRemoved(intent.getIntExtra(Intent.EXTRA_USERID, 0)); } } }; private BroadcastReceiver mBroadCastReceiver = new BroadcastReceiver() { @Override public void onReceive(Context context, Intent intent) { final String action = intent.getAction(); if (action.equals(DELAYED_KEYGUARD_ACTION)) { int sequence = intent.getIntExtra("seq", 0); if (DEBUG) Log.d(TAG, "received DELAYED_KEYGUARD_ACTION with seq = " + sequence + ", mDelayedShowingSequence = " + mDelayedShowingSequence); synchronized (KeyguardViewMediator.this) { if (mDelayedShowingSequence == sequence) { // Don't play lockscreen SFX if the screen went off due to // timeout. mSuppressNextLockSound = true; doKeyguardLocked(); } } } else if (TelephonyManager.ACTION_PHONE_STATE_CHANGED.equals(action)) { mPhoneState = intent.getStringExtra(TelephonyManager.EXTRA_STATE); synchronized (KeyguardViewMediator.this) { if (TelephonyManager.EXTRA_STATE_IDLE.equals(mPhoneState) // call ending && !mScreenOn // screen off && mExternallyEnabled) { // not disabled by any app // note: this is a way to gracefully reenable the keyguard when the call // ends and the screen is off without always reenabling the keyguard // each time the screen turns off while in call (and having an occasional ugly // flicker while turning back on the screen and disabling the keyguard again). if (DEBUG) Log.d(TAG, "screen is off and call ended, let's make sure the " + "keyguard is showing"); doKeyguardLocked(); } } } } }; /** * When a key is received when the screen is off and the keyguard is showing, * we need to decide whether to actually turn on the screen, and if so, tell * the keyguard to prepare itself and poke the wake lock when it is ready. * * The 'Tq' suffix is per the documentation in {@link WindowManagerPolicy}. * Be sure not to take any action that takes a long time; any significant * action should be posted to a handler. * * @param keyCode The keycode of the key that woke the device * @param isDocked True if the device is in the dock * @return Whether we poked the wake lock (and turned the screen on) */ public boolean onWakeKeyWhenKeyguardShowingTq(int keyCode, boolean isDocked) { if (DEBUG) Log.d(TAG, "onWakeKeyWhenKeyguardShowing(" + keyCode + ")"); if (isWakeKeyWhenKeyguardShowing(keyCode, isDocked)) { // give the keyguard view manager a chance to adjust the state of the // keyguard based on the key that woke the device before poking // the wake lock wakeWhenReadyLocked(keyCode); return true; } else { return false; } } /** * When the keyguard is showing we ignore some keys that might otherwise typically * be considered wake keys. We filter them out here. * * {@link KeyEvent#KEYCODE_POWER} is notably absent from this list because it * is always considered a wake key. */ private boolean isWakeKeyWhenKeyguardShowing(int keyCode, boolean isDocked) { switch (keyCode) { // ignore volume keys unless docked case KeyEvent.KEYCODE_VOLUME_UP: case KeyEvent.KEYCODE_VOLUME_DOWN: case KeyEvent.KEYCODE_VOLUME_MUTE: return isDocked; // ignore media and camera keys case KeyEvent.KEYCODE_MUTE: case KeyEvent.KEYCODE_HEADSETHOOK: case KeyEvent.KEYCODE_MEDIA_PLAY: case KeyEvent.KEYCODE_MEDIA_PAUSE: case KeyEvent.KEYCODE_MEDIA_PLAY_PAUSE: case KeyEvent.KEYCODE_MEDIA_STOP: case KeyEvent.KEYCODE_MEDIA_NEXT: case KeyEvent.KEYCODE_MEDIA_PREVIOUS: case KeyEvent.KEYCODE_MEDIA_REWIND: case KeyEvent.KEYCODE_MEDIA_RECORD: case KeyEvent.KEYCODE_MEDIA_FAST_FORWARD: case KeyEvent.KEYCODE_CAMERA: return false; } return true; } /** * When a wake motion such as an external mouse movement is received when the screen * is off and the keyguard is showing, we need to decide whether to actually turn * on the screen, and if so, tell the keyguard to prepare itself and poke the wake * lock when it is ready. * * The 'Tq' suffix is per the documentation in {@link WindowManagerPolicy}. * Be sure not to take any action that takes a long time; any significant * action should be posted to a handler. * * @return Whether we poked the wake lock (and turned the screen on) */ public boolean onWakeMotionWhenKeyguardShowingTq() { if (DEBUG) Log.d(TAG, "onWakeMotionWhenKeyguardShowing()"); // give the keyguard view manager a chance to adjust the state of the // keyguard based on the key that woke the device before poking // the wake lock wakeWhenReadyLocked(KeyEvent.KEYCODE_UNKNOWN); return true; } /** * Callbacks from {@link KeyguardViewManager}. */ /** {@inheritDoc} */ public void pokeWakelock() { pokeWakelock(AWAKE_INTERVAL_DEFAULT_MS); } /** {@inheritDoc} */ public void pokeWakelock(int holdMs) { synchronized (this) { if (DBG_WAKE) Log.d(TAG, "pokeWakelock(" + holdMs + ")"); mWakeLock.acquire(); mHandler.removeMessages(TIMEOUT); mWakelockSequence++; Message msg = mHandler.obtainMessage(TIMEOUT, mWakelockSequence, 0); mHandler.sendMessageDelayed(msg, holdMs); } } /** * {@inheritDoc} * * @see #handleKeyguardDone */ public void keyguardDone(boolean authenticated) { keyguardDone(authenticated, true); } public void keyguardDone(boolean authenticated, boolean wakeup) { synchronized (this) { EventLog.writeEvent(70000, 2); if (DEBUG) Log.d(TAG, "keyguardDone(" + authenticated + ")"); Message msg = mHandler.obtainMessage(KEYGUARD_DONE); msg.arg1 = wakeup ? 1 : 0; mHandler.sendMessage(msg); if (authenticated) { mUpdateMonitor.clearFailedAttempts(); } if (mExitSecureCallback != null) { mExitSecureCallback.onKeyguardExitResult(authenticated); mExitSecureCallback = null; if (authenticated) { // after succesfully exiting securely, no need to reshow // the keyguard when they've released the lock mExternallyEnabled = true; mNeedToReshowWhenReenabled = false; } } } } /** * {@inheritDoc} * * @see #handleKeyguardDoneDrawing */ public void keyguardDoneDrawing() { mHandler.sendEmptyMessage(KEYGUARD_DONE_DRAWING); } /** * This handler will be associated with the policy thread, which will also * be the UI thread of the keyguard. Since the apis of the policy, and therefore * this class, can be called by other threads, any action that directly * interacts with the keyguard ui should be posted to this handler, rather * than called directly. */ private Handler mHandler = new Handler() { @Override public void handleMessage(Message msg) { switch (msg.what) { case TIMEOUT: handleTimeout(msg.arg1); return ; case SHOW: handleShow(); return ; case HIDE: handleHide(); return ; case RESET: handleReset(); return ; case VERIFY_UNLOCK: handleVerifyUnlock(); return; case NOTIFY_SCREEN_OFF: handleNotifyScreenOff(); return; case NOTIFY_SCREEN_ON: handleNotifyScreenOn((KeyguardViewManager.ShowListener)msg.obj); return; case WAKE_WHEN_READY: handleWakeWhenReady(msg.arg1); return; case KEYGUARD_DONE: handleKeyguardDone(msg.arg1 != 0); return; case KEYGUARD_DONE_DRAWING: handleKeyguardDoneDrawing(); return; case KEYGUARD_DONE_AUTHENTICATING: keyguardDone(true); return; case SET_HIDDEN: handleSetHidden(msg.arg1 != 0); break; case KEYGUARD_TIMEOUT: synchronized (KeyguardViewMediator.this) { doKeyguardLocked(); } break; } } }; /** * @see #keyguardDone * @see #KEYGUARD_DONE */ private void handleKeyguardDone(boolean wakeup) { if (DEBUG) Log.d(TAG, "handleKeyguardDone"); handleHide(); if (wakeup) { mPM.userActivity(SystemClock.uptimeMillis(), true); } mWakeLock.release(); mContext.sendBroadcast(mUserPresentIntent); } /** * @see #keyguardDoneDrawing * @see #KEYGUARD_DONE_DRAWING */ private void handleKeyguardDoneDrawing() { synchronized(this) { if (false) Log.d(TAG, "handleKeyguardDoneDrawing"); if (mWaitingUntilKeyguardVisible) { if (DEBUG) Log.d(TAG, "handleKeyguardDoneDrawing: notifying mWaitingUntilKeyguardVisible"); mWaitingUntilKeyguardVisible = false; notifyAll(); // there will usually be two of these sent, one as a timeout, and one // as a result of the callback, so remove any remaining messages from // the queue mHandler.removeMessages(KEYGUARD_DONE_DRAWING); } } } /** * Handles the message sent by {@link #pokeWakelock} * @param seq used to determine if anything has changed since the message * was sent. * @see #TIMEOUT */ private void handleTimeout(int seq) { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleTimeout"); if (seq == mWakelockSequence) { mWakeLock.release(); } } } private void playSounds(boolean locked) { // User feedback for keyguard. if (mSuppressNextLockSound) { mSuppressNextLockSound = false; return; } final ContentResolver cr = mContext.getContentResolver(); if (Settings.System.getInt(cr, Settings.System.LOCKSCREEN_SOUNDS_ENABLED, 1) == 1) { final int whichSound = locked ? mLockSoundId : mUnlockSoundId; mLockSounds.stop(mLockSoundStreamId); // Init mAudioManager if (mAudioManager == null) { mAudioManager = (AudioManager) mContext.getSystemService(Context.AUDIO_SERVICE); if (mAudioManager == null) return; mMasterStreamType = mAudioManager.getMasterStreamType(); } // If the stream is muted, don't play the sound if (mAudioManager.isStreamMute(mMasterStreamType)) return; mLockSoundStreamId = mLockSounds.play(whichSound, mLockSoundVolume, mLockSoundVolume, 1/*priortiy*/, 0/*loop*/, 1.0f/*rate*/); } } private void updateActivityLockScreenState() { try { ActivityManagerNative.getDefault().setLockScreenShown( mShowing && !mHidden); } catch (RemoteException e) { } } /** * Handle message sent by {@link #showLocked}. * @see #SHOW */ private void handleShow() { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleShow"); if (!mSystemReady) return; mKeyguardViewManager.show(); mShowing = true; updateActivityLockScreenState(); adjustUserActivityLocked(); adjustStatusBarLocked(); try { ActivityManagerNative.getDefault().closeSystemDialogs("lock"); } catch (RemoteException e) { } // Do this at the end to not slow down display of the keyguard. playSounds(true); mShowKeyguardWakeLock.release(); } } /** * Handle message sent by {@link #hideLocked()} * @see #HIDE */ private void handleHide() { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleHide"); if (mWakeAndHandOff.isHeld()) { Log.w(TAG, "attempt to hide the keyguard while waking, ignored"); return; } // only play "unlock" noises if not on a call (since the incall UI // disables the keyguard) if (TelephonyManager.EXTRA_STATE_IDLE.equals(mPhoneState)) { playSounds(false); } mKeyguardViewManager.hide(); mShowing = false; updateActivityLockScreenState(); adjustUserActivityLocked(); adjustStatusBarLocked(); } } private void adjustUserActivityLocked() { // disable user activity if we are shown and not hidden if (DEBUG) Log.d(TAG, "adjustUserActivityLocked mShowing: " + mShowing + " mHidden: " + mHidden); boolean enabled = !mShowing || mHidden; mRealPowerManager.enableUserActivity(enabled); if (!enabled && mScreenOn) { // reinstate our short screen timeout policy pokeWakelock(); } } private void adjustStatusBarLocked() { if (mStatusBarManager == null) { mStatusBarManager = (StatusBarManager) mContext.getSystemService(Context.STATUS_BAR_SERVICE); } if (mStatusBarManager == null) { Log.w(TAG, "Could not get status bar manager"); } else { if (mShowLockIcon) { // Give feedback to user when secure keyguard is active and engaged if (mShowing && isSecure()) { if (!mShowingLockIcon) { String contentDescription = mContext.getString( com.android.internal.R.string.status_bar_device_locked); mStatusBarManager.setIcon("secure", com.android.internal.R.drawable.stat_sys_secure, 0, contentDescription); mShowingLockIcon = true; } } else { if (mShowingLockIcon) { mStatusBarManager.removeIcon("secure"); mShowingLockIcon = false; } } } // Disable aspects of the system/status/navigation bars that must not be re-enabled by // windows that appear on top, ever int flags = StatusBarManager.DISABLE_NONE; if (mShowing) { // disable navigation status bar components (home, recents) if lock screen is up flags |= StatusBarManager.DISABLE_RECENT; if (isSecure() || !ENABLE_INSECURE_STATUS_BAR_EXPAND) { // showing secure lockscreen; disable expanding. flags |= StatusBarManager.DISABLE_EXPAND; } if (isSecure()) { // showing secure lockscreen; disable ticker. flags |= StatusBarManager.DISABLE_NOTIFICATION_TICKER; } } if (DEBUG) { Log.d(TAG, "adjustStatusBarLocked: mShowing=" + mShowing + " mHidden=" + mHidden + " isSecure=" + isSecure() + " --> flags=0x" + Integer.toHexString(flags)); } mStatusBarManager.disable(flags); } } /** * Handle message sent by {@link #wakeWhenReadyLocked(int)} * @param keyCode The key that woke the device. * @see #WAKE_WHEN_READY */ private void handleWakeWhenReady(int keyCode) { synchronized (KeyguardViewMediator.this) { if (DBG_WAKE) Log.d(TAG, "handleWakeWhenReady(" + keyCode + ")"); // this should result in a call to 'poke wakelock' which will set a timeout // on releasing the wakelock if (!mKeyguardViewManager.wakeWhenReadyTq(keyCode)) { // poke wakelock ourselves if keyguard is no longer active Log.w(TAG, "mKeyguardViewManager.wakeWhenReadyTq did not poke wake lock, so poke it ourselves"); pokeWakelock(); } /** * Now that the keyguard is ready and has poked the wake lock, we can * release the handoff wakelock */ mWakeAndHandOff.release(); if (!mWakeLock.isHeld()) { Log.w(TAG, "mWakeLock not held in mKeyguardViewManager.wakeWhenReadyTq"); } } } /** * Handle message sent by {@link #resetStateLocked()} * @see #RESET */ private void handleReset() { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleReset"); mKeyguardViewManager.reset(); } } /** * Handle message sent by {@link #verifyUnlock} * @see #RESET */ private void handleVerifyUnlock() { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleVerifyUnlock"); mKeyguardViewManager.verifyUnlock(); mShowing = true; updateActivityLockScreenState(); } } /** * Handle message sent by {@link #notifyScreenOffLocked()} * @see #NOTIFY_SCREEN_OFF */ private void handleNotifyScreenOff() { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleNotifyScreenOff"); mKeyguardViewManager.onScreenTurnedOff(); } } /** * Handle message sent by {@link #notifyScreenOnLocked()} * @see #NOTIFY_SCREEN_ON */ private void handleNotifyScreenOn(KeyguardViewManager.ShowListener showListener) { synchronized (KeyguardViewMediator.this) { if (DEBUG) Log.d(TAG, "handleNotifyScreenOn"); mKeyguardViewManager.onScreenTurnedOn(showListener); } } }