TODO fixes from Teleca 090527
[android/platform/packages/apps/Phone.git] / src / com / android / phone / InCallScreen.java
1 /*
2  * Copyright (C) 2006 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.android.phone;
18
19 import com.android.internal.telephony.Call;
20 import com.android.internal.telephony.CallerInfo;
21 import com.android.internal.telephony.CallerInfoAsyncQuery;
22 import com.android.internal.telephony.Connection;
23 import com.android.internal.telephony.MmiCode;
24 import com.android.internal.telephony.Phone;
25
26 import android.app.Activity;
27 import android.app.AlertDialog;
28 import android.app.Dialog;
29 import android.bluetooth.BluetoothHeadset;
30 import android.content.BroadcastReceiver;
31 import android.content.Context;
32 import android.content.DialogInterface;
33 import android.content.DialogInterface.OnCancelListener;
34 import android.content.Intent;
35 import android.content.IntentFilter;
36 import android.content.res.Configuration;
37 import android.content.res.Resources;
38 import android.graphics.Typeface;
39 import android.media.AudioManager;
40 import android.os.AsyncResult;
41 import android.os.Bundle;
42 import android.os.Handler;
43 import android.os.Message;
44 import android.os.SystemClock;
45 import android.os.SystemProperties;
46 import android.provider.Checkin;
47 import android.provider.Settings;
48 import android.telephony.PhoneNumberUtils;
49 import android.telephony.ServiceState;
50 import android.text.TextUtils;
51 import android.text.method.DialerKeyListener;
52 import android.util.Log;
53 import android.view.KeyEvent;
54 import android.view.Menu;
55 import android.view.MotionEvent;
56 import android.view.View;
57 import android.view.ViewConfiguration;
58 import android.view.ViewGroup;
59 import android.view.Window;
60 import android.view.WindowManager;
61 import android.view.animation.Animation;
62 import android.view.animation.AnimationUtils;
63 import android.widget.Button;
64 import android.widget.Chronometer;
65 import android.widget.EditText;
66 import android.widget.ImageButton;
67 import android.widget.LinearLayout;
68 import android.widget.SlidingDrawer;
69 import android.widget.TextView;
70 import android.widget.Toast;
71
72 import java.util.List;
73
74 /**
75  * Phone app "in call" screen.
76  */
77 public class InCallScreen extends Activity
78         implements View.OnClickListener, View.OnTouchListener,
79                 CallerInfoAsyncQuery.OnQueryCompleteListener {
80     private static final String LOG_TAG = "InCallScreen";
81
82     private static final boolean DBG =
83             (PhoneApp.DBG_LEVEL >= 1) && (SystemProperties.getInt("ro.debuggable", 0) == 1);
84     private static final boolean VDBG = (PhoneApp.DBG_LEVEL >= 2);
85
86     // Enable detailed logs of user actions while on the in-call screen.
87     // TODO: For now this is totally disabled.  But for future user
88     // research, we should change the PHONE_UI_EVENT_* events to use
89     // android.util.EventLog rather than Checkin.logEvent, so that we can
90     // select which of those events to upload on a tag-by-tag basis
91     // (which means that we could actually ship devices with this logging
92     // enabled.)
93     /* package */ static final boolean ENABLE_PHONE_UI_EVENT_LOGGING = false;
94
95     /**
96      * Intent extra used to specify whether the DTMF dialpad should be
97      * initially visible when bringing up the InCallScreen.  (If this
98      * extra is present, the dialpad will be initially shown if the extra
99      * has the boolean value true, and initially hidden otherwise.)
100      */
101     static final String SHOW_DIALPAD_EXTRA = "com.android.phone.ShowDialpad";
102
103     // Event values used with Checkin.Events.Tag.PHONE_UI events:
104     /** The in-call UI became active */
105     static final String PHONE_UI_EVENT_ENTER = "enter";
106     /** User exited the in-call UI */
107     static final String PHONE_UI_EVENT_EXIT = "exit";
108     /** User clicked one of the touchable in-call buttons */
109     static final String PHONE_UI_EVENT_BUTTON_CLICK = "button_click";
110
111     // Amount of time (in msec) that we display the "Call ended" state.
112     // The "short" value is for calls ended by the local user, and the
113     // "long" value is for calls ended by the remote caller.
114     private static final int CALL_ENDED_SHORT_DELAY =  200;  // msec
115     private static final int CALL_ENDED_LONG_DELAY = 2000;  // msec
116
117     // Amount of time (in msec) that we keep the in-call menu onscreen
118     // *after* the user changes the state of one of the toggle buttons.
119     private static final int MENU_DISMISS_DELAY =  1000;  // msec
120
121     // The "touch lock" overlay timeout comes from Gservices; this is the default.
122     private static final int TOUCH_LOCK_DELAY_DEFAULT =  6000;  // msec
123
124     // See CallTracker.MAX_CONNECTIONS_PER_CALL
125     private static final int MAX_CALLERS_IN_CONFERENCE = 5;
126
127     // Message codes; see mHandler below.
128     // Note message codes < 100 are reserved for the PhoneApp.
129     private static final int PHONE_STATE_CHANGED = 101;
130     private static final int PHONE_DISCONNECT = 102;
131     private static final int EVENT_HEADSET_PLUG_STATE_CHANGED = 103;
132     private static final int POST_ON_DIAL_CHARS = 104;
133     private static final int WILD_PROMPT_CHAR_ENTERED = 105;
134     private static final int ADD_VOICEMAIL_NUMBER = 106;
135     private static final int DONT_ADD_VOICEMAIL_NUMBER = 107;
136     private static final int DELAYED_CLEANUP_AFTER_DISCONNECT = 108;
137     private static final int SUPP_SERVICE_FAILED = 110;
138     private static final int DISMISS_MENU = 111;
139     private static final int ALLOW_SCREEN_ON = 112;
140     private static final int TOUCH_LOCK_TIMER = 113;
141     private static final int BLUETOOTH_STATE_CHANGED = 114;
142
143
144     // High-level "modes" of the in-call UI.
145     private enum InCallScreenMode {
146         /**
147          * Normal in-call UI elements visible.
148          */
149         NORMAL,
150         /**
151          * "Manage conference" UI is visible, totally replacing the
152          * normal in-call UI.
153          */
154         MANAGE_CONFERENCE,
155         /**
156          * Non-interactive UI state.  Call card is visible,
157          * displaying information about the call that just ended.
158          */
159         CALL_ENDED
160     }
161     private InCallScreenMode mInCallScreenMode;
162
163     // Possible error conditions that can happen on startup.
164     // These are returned as status codes from the various helper
165     // functions we call from onCreate() and/or onResume().
166     // See syncWithPhoneState() and checkIfOkToInitiateOutgoingCall() for details.
167     private enum InCallInitStatus {
168         SUCCESS,
169         VOICEMAIL_NUMBER_MISSING,
170         POWER_OFF,
171         EMERGENCY_ONLY,
172         PHONE_NOT_IN_USE,
173         NO_PHONE_NUMBER_SUPPLIED,
174         DIALED_MMI,
175         CALL_FAILED
176     }
177     private InCallInitStatus mInCallInitialStatus;  // see onResume()
178
179     private boolean mRegisteredForPhoneStates;
180
181     private Phone mPhone;
182     private Call mForegroundCall;
183     private Call mBackgroundCall;
184     private Call mRingingCall;
185
186     private BluetoothHandsfree mBluetoothHandsfree;
187     private BluetoothHeadset mBluetoothHeadset;
188     private boolean mBluetoothConnectionPending;
189     private long mBluetoothConnectionRequestTime;
190
191     // Main in-call UI ViewGroups
192     private ViewGroup mMainFrame;
193     private ViewGroup mInCallPanel;
194
195     // Menu button hint below the "main frame"
196     private TextView mMenuButtonHint;
197
198     // Main in-call UI elements:
199     private CallCard mCallCard;
200     private InCallMenu mInCallMenu;  // created lazily on first MENU keypress
201
202     /**
203      * DTMF Dialer objects, including the model and the sliding drawer / dialer
204      * UI container and the dialer display field for landscape presentation.
205      */
206     private DTMFTwelveKeyDialer mDialer;
207     private SlidingDrawer mDialerDrawer;
208     private EditText mDTMFDisplay;
209
210     // "Manage conference" UI elements
211     private ViewGroup mManageConferencePanel;
212     private Button mButtonManageConferenceDone;
213     private ViewGroup[] mConferenceCallList;
214     private int mNumCallersInConference;
215     private Chronometer mConferenceTime;
216
217     private EditText mWildPromptText;
218
219     // "Touch lock" overlay graphic
220     private View mTouchLockOverlay;  // The overlay over the whole screen
221     private View mTouchLockIcon;  // The "lock" icon in the middle of the screen
222     private Animation mTouchLockFadeIn;
223     private long mTouchLockLastTouchTime;  // in SystemClock.uptimeMillis() time base
224
225     // Various dialogs we bring up (see dismissAllDialogs())
226     // The MMI started dialog can actually be one of 2 items:
227     //   1. An alert dialog if the MMI code is a normal MMI
228     //   2. A progress dialog if the user requested a USSD
229     private Dialog mMmiStartedDialog;
230     private AlertDialog mMissingVoicemailDialog;
231     private AlertDialog mGenericErrorDialog;
232     private AlertDialog mSuppServiceFailureDialog;
233     private AlertDialog mWaitPromptDialog;
234     private AlertDialog mWildPromptDialog;
235
236     // TODO: If the Activity class ever provides an easy way to get the
237     // current "activity lifecycle" state, we can remove these flags.
238     private boolean mIsDestroyed = false;
239     private boolean mIsForegroundActivity = false;
240
241     // Flag indicating whether or not we should bring up the Call Log when
242     // exiting the in-call UI due to the Phone becoming idle.  (This is
243     // true if the most recently disconnected Call was initiated by the
244     // user, or false if it was an incoming call.)
245     // This flag is used by delayedCleanupAfterDisconnect(), and is set by
246     // onDisconnect() (which is the only place that either posts a
247     // DELAYED_CLEANUP_AFTER_DISCONNECT event *or* calls
248     // delayedCleanupAfterDisconnect() directly.)
249     private boolean mShowCallLogAfterDisconnect;
250
251     private Handler mHandler = new Handler() {
252         @Override
253         public void handleMessage(Message msg) {
254             if (mIsDestroyed) {
255                 if (DBG) log("Handler: ignoring message " + msg + "; we're destroyed!");
256                 return;
257             }
258             if (!mIsForegroundActivity) {
259                 if (DBG) log("Handler: handling message " + msg + " while not in foreground");
260                 // Continue anyway; some of the messages below *want* to
261                 // be handled even if we're not the foreground activity
262                 // (like DELAYED_CLEANUP_AFTER_DISCONNECT), and they all
263                 // should at least be safe to handle if we're not in the
264                 // foreground...
265             }
266
267             switch (msg.what) {
268                 case SUPP_SERVICE_FAILED:
269                     onSuppServiceFailed((AsyncResult) msg.obj);
270                     break;
271
272                 case PHONE_STATE_CHANGED:
273                     onPhoneStateChanged((AsyncResult) msg.obj);
274                     break;
275
276                 case PHONE_DISCONNECT:
277                     onDisconnect((AsyncResult) msg.obj);
278                     break;
279
280                 case EVENT_HEADSET_PLUG_STATE_CHANGED:
281                     // Update the in-call UI, since some UI elements (in
282                     // particular the "Speaker" menu button) change state
283                     // depending on whether a headset is plugged in.
284                     // TODO: A full updateScreen() is overkill here, since
285                     // the value of PhoneApp.isHeadsetPlugged() only affects a
286                     // single menu item.  (But even a full updateScreen()
287                     // is still pretty cheap, so let's keep this simple
288                     // for now.)
289                     if (msg.arg1 != 1 && !isBluetoothAudioConnected()){
290                         // If the state is "not connected", restore the speaker state.
291                         // We ONLY want to do this on the wired headset connect /
292                         // disconnect events for now though, so we're only triggering
293                         // on EVENT_HEADSET_PLUG_STATE_CHANGED.
294                         PhoneUtils.restoreSpeakerMode(getApplicationContext());
295                     }
296                     updateScreen();
297                     break;
298
299                 case PhoneApp.MMI_INITIATE:
300                     onMMIInitiate((AsyncResult) msg.obj);
301                     break;
302
303                 case PhoneApp.MMI_CANCEL:
304                     onMMICancel();
305                     break;
306
307                 // handle the mmi complete message.
308                 // since the message display class has been replaced with
309                 // a system dialog in PhoneUtils.displayMMIComplete(), we
310                 // should finish the activity here to close the window.
311                 case PhoneApp.MMI_COMPLETE:
312                     // Check the code to see if the request is ready to
313                     // finish, this includes any MMI state that is not
314                     // PENDING.
315                     MmiCode mmiCode = (MmiCode) ((AsyncResult) msg.obj).result;
316                     // if phone is a CDMA phone display feature code completed message
317                     if (mPhone.getPhoneName().equals("CDMA")) {
318                         PhoneUtils.displayMMIComplete(mPhone, PhoneApp.getInstance(), mmiCode, null, null);
319                     } else {
320                         if (mmiCode.getState() != MmiCode.State.PENDING) {
321                             if (DBG) log("Got MMI_COMPLETE, finishing...");
322                             finish();
323                         }
324                     }
325                     break;
326
327                 case POST_ON_DIAL_CHARS:
328                     handlePostOnDialChars((AsyncResult) msg.obj, (char) msg.arg1);
329                     break;
330
331                 case ADD_VOICEMAIL_NUMBER:
332                     addVoiceMailNumberPanel();
333                     break;
334
335                 case DONT_ADD_VOICEMAIL_NUMBER:
336                     dontAddVoiceMailNumber();
337                     break;
338
339                 case DELAYED_CLEANUP_AFTER_DISCONNECT:
340                     delayedCleanupAfterDisconnect();
341                     break;
342
343                 case DISMISS_MENU:
344                     // dismissMenu() has no effect if the menu is already closed.
345                     dismissMenu(true);  // dismissImmediate = true
346                     break;
347
348                 case ALLOW_SCREEN_ON:
349                     if (VDBG) log("ALLOW_SCREEN_ON message...");
350                     // Undo our previous call to preventScreenOn(true).
351                     // (Note this will cause the screen to turn on
352                     // immediately, if it's currently off because of a
353                     // prior preventScreenOn(true) call.)
354                     PhoneApp.getInstance().preventScreenOn(false);
355                     break;
356
357                 case TOUCH_LOCK_TIMER:
358                     if (VDBG) log("TOUCH_LOCK_TIMER...");
359                     touchLockTimerExpired();
360                     break;
361
362                 case BLUETOOTH_STATE_CHANGED:
363                     if (VDBG) log("BLUETOOTH_STATE_CHANGED...");
364                     // The bluetooth headset state changed, so some UI
365                     // elements may need to update.  (There's no need to
366                     // look up the current state here, since any UI
367                     // elements that care about the bluetooth state get it
368                     // directly from PhoneApp.showBluetoothIndication().)
369                     updateScreen();
370                     break;
371             }
372         }
373     };
374
375     private final BroadcastReceiver mReceiver = new BroadcastReceiver() {
376             @Override
377             public void onReceive(Context context, Intent intent) {
378                 String action = intent.getAction();
379                 if (action.equals(Intent.ACTION_HEADSET_PLUG)) {
380                     // Listen for ACTION_HEADSET_PLUG broadcasts so that we
381                     // can update the onscreen UI when the headset state changes.
382                     // if (DBG) log("mReceiver: ACTION_HEADSET_PLUG");
383                     // if (DBG) log("==> intent: " + intent);
384                     // if (DBG) log("    state: " + intent.getIntExtra("state", 0));
385                     // if (DBG) log("    name: " + intent.getStringExtra("name"));
386                     // send the event and add the state as an argument.
387                     Message message = Message.obtain(mHandler, EVENT_HEADSET_PLUG_STATE_CHANGED,
388                             intent.getIntExtra("state", 0), 0);
389                     mHandler.sendMessage(message);
390                 }
391             }
392         };
393
394
395     @Override
396     protected void onCreate(Bundle icicle) {
397         if (DBG) log("onCreate()...  this = " + this);
398
399         Profiler.callScreenOnCreate();
400
401         super.onCreate(icicle);
402
403         final PhoneApp app = PhoneApp.getInstance();
404         app.setInCallScreenInstance(this);
405
406         setPhone(app.phone);  // Sets mPhone and mForegroundCall/mBackgroundCall/mRingingCall
407
408         mBluetoothHandsfree = app.getBluetoothHandsfree();
409         if (VDBG) log("- mBluetoothHandsfree: " + mBluetoothHandsfree);
410
411         if (mBluetoothHandsfree != null) {
412             // The PhoneApp only creates a BluetoothHandsfree instance in the
413             // first place if getSystemService(Context.BLUETOOTH_SERVICE)
414             // succeeds.  So at this point we know the device is BT-capable.
415             mBluetoothHeadset = new BluetoothHeadset(this, null);
416             if (VDBG) log("- Got BluetoothHeadset: " + mBluetoothHeadset);
417         }
418
419         requestWindowFeature(Window.FEATURE_NO_TITLE);
420
421         // Inflate everything in incall_screen.xml and add it to the screen.
422         setContentView(R.layout.incall_screen);
423         mDialerDrawer = (SlidingDrawer) findViewById(R.id.dialer_container);
424
425         initInCallScreen();
426
427         // Create the dtmf dialer.  Note that mDialer is instantiated
428         // regardless of screen orientation, although the onscreen touchable
429         // dialpad is used only in portrait mode.
430         mDialer = new DTMFTwelveKeyDialer(this);
431
432         registerForPhoneStates();
433
434         // No need to change wake state here; that happens in onResume() when we
435         // are actually displayed.
436
437         // Handle the Intent we were launched with, but only if this is the
438         // the very first time we're being launched (ie. NOT if we're being
439         // re-initialized after previously being shut down.)
440         // Once we're up and running, any future Intents we need
441         // to handle will come in via the onNewIntent() method.
442         if (icicle == null) {
443             if (DBG) log("onCreate(): this is our very first launch, checking intent...");
444
445             // Stash the result code from internalResolveIntent() in the
446             // mInCallInitialStatus field.  If it's an error code, we'll
447             // handle it in onResume().
448             mInCallInitialStatus = internalResolveIntent(getIntent());
449             if (mInCallInitialStatus != InCallInitStatus.SUCCESS) {
450                 Log.w(LOG_TAG, "onCreate: status " + mInCallInitialStatus
451                       + " from internalResolveIntent()");
452                 // See onResume() for the actual error handling.
453             }
454         } else {
455             mInCallInitialStatus = InCallInitStatus.SUCCESS;
456         }
457
458         // When in landscape mode, the user can enter dtmf tones
459         // at any time.  We need to make sure the DTMFDialer is
460         // setup correctly.
461         if (ConfigurationHelper.isLandscape()) {
462             mDialer.startDialerSession();
463             if (VDBG) log("Dialer initialized (in landscape mode).");
464         }
465
466         Profiler.callScreenCreated();
467     }
468
469     /**
470      * Sets the Phone object used internally by the InCallScreen.
471      *
472      * In normal operation this is called from onCreate(), and the
473      * passed-in Phone object comes from the PhoneApp.
474      * For testing, test classes can use this method to
475      * inject a test Phone instance.
476      */
477     /* package */ void setPhone(Phone phone) {
478         mPhone = phone;
479         // Hang onto the three Call objects too; they're singletons that
480         // are constant (and never null) for the life of the Phone.
481         mForegroundCall = mPhone.getForegroundCall();
482         mBackgroundCall = mPhone.getBackgroundCall();
483         mRingingCall = mPhone.getRingingCall();
484     }
485
486     @Override
487     protected void onResume() {
488         if (DBG) log("onResume()...");
489         super.onResume();
490
491         mIsForegroundActivity = true;
492
493         final PhoneApp app = PhoneApp.getInstance();
494
495         // Disable the keyguard the entire time the InCallScreen is
496         // active.  (This is necessary only for the case of receiving an
497         // incoming call while the device is locked; we need to disable
498         // the keyguard so you can answer the call and use the in-call UI,
499         // but we always re-enable the keyguard as soon as you leave this
500         // screen (see onPause().))
501         app.disableKeyguard();
502
503         // Touch events are never considered "user activity" while the
504         // InCallScreen is active, so that unintentional touches won't
505         // prevent the device from going to sleep.
506         app.setIgnoreTouchUserActivity(true);
507
508         // Disable the status bar "window shade" the entire time we're on
509         // the in-call screen.
510         NotificationMgr.getDefault().getStatusBarMgr().enableExpandedView(false);
511
512         // Listen for broadcast intents that might affect the onscreen UI.
513         registerReceiver(mReceiver, new IntentFilter(Intent.ACTION_HEADSET_PLUG));
514
515         // Check for any failures that happened during onCreate() or onNewIntent().
516         if (DBG) log("- onResume: initial status = " + mInCallInitialStatus);
517         if (mInCallInitialStatus != InCallInitStatus.SUCCESS) {
518             if (DBG) log("- onResume: failure during startup: " + mInCallInitialStatus);
519
520             // Don't bring up the regular Phone UI!  Instead bring up
521             // something more specific to let the user deal with the
522             // problem.
523             handleStartupError(mInCallInitialStatus);
524
525             // But it *is* OK to continue with the rest of onResume(),
526             // since any further setup steps (like updateScreen() and the
527             // CallCard setup) will fall back to a "blank" state if the
528             // phone isn't in use.
529             mInCallInitialStatus = InCallInitStatus.SUCCESS;
530         }
531
532         // Set the volume control handler while we are in the foreground.
533         if (isBluetoothAudioConnected()) {
534             setVolumeControlStream(AudioManager.STREAM_BLUETOOTH_SCO);
535         } else {
536             setVolumeControlStream(AudioManager.STREAM_VOICE_CALL);
537         }
538
539         takeKeyEvents(true);
540
541         // Always start off in NORMAL mode.
542         setInCallScreenMode(InCallScreenMode.NORMAL);
543
544         // Before checking the state of the phone, clean up any
545         // connections in the DISCONNECTED state.
546         // (The DISCONNECTED state is used only to drive the "call ended"
547         // UI; it's totally useless when *entering* the InCallScreen.)
548         mPhone.clearDisconnected();
549
550         InCallInitStatus status = syncWithPhoneState();
551         if (status != InCallInitStatus.SUCCESS) {
552             if (DBG) log("- syncWithPhoneState failed! status = " + status);
553             // Couldn't update the UI, presumably because the phone is totally
554             // idle.  But don't finish() immediately, since we might still
555             // have an error dialog up that the user needs to see.
556             // (And in that case, the error dialog is responsible for calling
557             // finish() when the user dismisses it.)
558         }
559
560         if (ENABLE_PHONE_UI_EVENT_LOGGING) {
561             // InCallScreen is now active.
562             Checkin.logEvent(getContentResolver(),
563                              Checkin.Events.Tag.PHONE_UI,
564                              PHONE_UI_EVENT_ENTER);
565         }
566
567         // Update the poke lock and wake lock when we move to
568         // the foreground.
569         //
570         // But we need to do something special if we're coming
571         // to the foreground while an incoming call is ringing:
572         if (mPhone.getState() == Phone.State.RINGING) {
573             // If the phone is ringing, we *should* already be holding a
574             // full wake lock (which we would have acquired before
575             // firing off the intent that brought us here; see
576             // PhoneUtils.showIncomingCallUi().)
577             //
578             // We also called preventScreenOn(true) at that point, to
579             // avoid cosmetic glitches while we were being launched.
580             // So now we need to post an ALLOW_SCREEN_ON message to
581             // (eventually) undo the prior preventScreenOn(true) call.
582             //
583             // (In principle we shouldn't do this until after our first
584             // layout/draw pass.  But in practice, the delay caused by
585             // simply waiting for the end of the message queue is long
586             // enough to avoid any flickering of the lock screen before
587             // the InCallScreen comes up.)
588             if (VDBG) log("- posting ALLOW_SCREEN_ON message...");
589             mHandler.removeMessages(ALLOW_SCREEN_ON);
590             mHandler.sendEmptyMessage(ALLOW_SCREEN_ON);
591
592             // TODO: There ought to be a more elegant way of doing this,
593             // probably by having the PowerManager and ActivityManager
594             // work together to let apps request that the screen on/off
595             // state be synchronized with the Activity lifecycle.
596             // (See bug 1648751.)
597         } else {
598             // The phone isn't ringing; this is either an outgoing call, or
599             // we're returning to a call in progress.  There *shouldn't* be
600             // any prior preventScreenOn(true) call that we need to undo,
601             // but let's do this just to be safe:
602             app.preventScreenOn(false);
603         }
604         app.updateWakeState();
605
606         // The "touch lock" overlay is NEVER visible when we resume.
607         // (In particular, this check ensures that we won't still be
608         // locked after the user wakes up the screen by pressing MENU.)
609         enableTouchLock(false);
610         // ...but if the dialpad is open we DO need to start the timer
611         // that will eventually bring up the "touch lock" overlay.
612         if (mDialer.isOpened()) resetTouchLockTimer();
613
614         // Restore the mute state if the last mute state change was NOT
615         // done by the user.
616         if (app.getRestoreMuteOnInCallResume()) {
617             PhoneUtils.restoreMuteState(mPhone);
618             app.setRestoreMuteOnInCallResume(false);
619         }
620
621         Profiler.profileViewCreate(getWindow(), InCallScreen.class.getName());
622         if (VDBG) log("onResume() done.");
623     }
624
625     @Override
626     protected void onSaveInstanceState(Bundle outState) {
627         if (VDBG) log("onSaveInstanceState()...");
628         super.onSaveInstanceState(outState);
629
630         // TODO: Save any state of the UI that needs to persist across
631         // configuration changes (ie. switching between portrait and
632         // landscape.)
633     }
634
635     @Override
636     protected void onPause() {
637         if (DBG) log("onPause()...");
638         super.onPause();
639
640         mIsForegroundActivity = false;
641
642         final PhoneApp app = PhoneApp.getInstance();
643
644         // make sure the chronometer is stopped when we move away from
645         // the foreground.
646         if (mConferenceTime != null) {
647             mConferenceTime.stop();
648         }
649
650         // as a catch-all, make sure that any dtmf tones are stopped
651         // when the UI is no longer in the foreground.
652         mDialer.onDialerKeyUp(null);
653
654         // If the device is put to sleep as the phone call is ending,
655         // we may see cases where the DELAYED_CLEANUP_AFTER_DISCONNECT
656         // event gets handled AFTER the device goes to sleep and wakes
657         // up again.
658
659         // This is because it is possible for a sleep command
660         // (executed with the End Call key) to come during the 2
661         // seconds that the "Call Ended" screen is up.  Sleep then
662         // pauses the device (including the cleanup event) and
663         // resumes the event when it wakes up.
664
665         // To fix this, we introduce a bit of code that pushes the UI
666         // to the background if we pause and see a request to
667         // DELAYED_CLEANUP_AFTER_DISCONNECT.
668
669         // Note: We can try to finish directly, by:
670         //  1. Removing the DELAYED_CLEANUP_AFTER_DISCONNECT messages
671         //  2. Calling delayedCleanupAfterDisconnect directly
672
673         // However, doing so can cause problems between the phone
674         // app and the keyguard - the keyguard is trying to sleep at
675         // the same time that the phone state is changing.  This can
676         // end up causing the sleep request to be ignored.
677         if (mHandler.hasMessages(DELAYED_CLEANUP_AFTER_DISCONNECT)) {
678             if (DBG) log("DELAYED_CLEANUP_AFTER_DISCONNECT detected, moving UI to background.");
679             finish();
680         }
681
682         if (ENABLE_PHONE_UI_EVENT_LOGGING) {
683             // InCallScreen is no longer active.
684             Checkin.logEvent(getContentResolver(),
685                              Checkin.Events.Tag.PHONE_UI,
686                              PHONE_UI_EVENT_EXIT);
687         }
688
689         // Clean up the menu, in case we get paused while the menu is up
690         // for some reason.
691         dismissMenu(true);  // dismiss immediately
692
693         // Dismiss any dialogs we may have brought up, just to be 100%
694         // sure they won't still be around when we get back here.
695         dismissAllDialogs();
696
697         // Re-enable the status bar (which we disabled in onResume().)
698         NotificationMgr.getDefault().getStatusBarMgr().enableExpandedView(true);
699
700         // Unregister for broadcast intents.  (These affect the visible UI
701         // of the InCallScreen, so we only care about them while we're in the
702         // foreground.)
703         unregisterReceiver(mReceiver);
704
705         // Re-enable "user activity" for touch events.
706         // We actually do this slightly *after* onPause(), to work around a
707         // race condition where a touch can come in after we've paused
708         // but before the device actually goes to sleep.
709         // TODO: The PowerManager itself should prevent this from happening.
710         mHandler.postDelayed(new Runnable() {
711                 public void run() {
712                     app.setIgnoreTouchUserActivity(false);
713                 }
714             }, 500);
715
716         // The keyguard was disabled the entire time the InCallScreen was
717         // active (see onResume()).  Re-enable it now.
718         app.reenableKeyguard();
719
720         // Make sure we revert the poke lock and wake lock when we move to
721         // the background.
722         app.updateWakeState();
723     }
724
725     @Override
726     protected void onStop() {
727         if (VDBG) log("onStop()...");
728         super.onStop();
729
730         stopTimer();
731
732         Phone.State state = mPhone.getState();
733         if (VDBG) log("onStop: state = " + state);
734
735         if (state == Phone.State.IDLE) {
736             // we don't want the call screen to remain in the activity history
737             // if there are not active or ringing calls.
738             if (DBG) log("- onStop: calling finish() to clear activity history...");
739             finish();
740         }
741     }
742
743     @Override
744     protected void onDestroy() {
745         if (DBG) log("onDestroy()...");
746         super.onDestroy();
747
748         // Set the magic flag that tells us NOT to handle any handler
749         // messages that come in asynchronously after we get destroyed.
750         mIsDestroyed = true;
751
752         final PhoneApp app = PhoneApp.getInstance();
753         app.setInCallScreenInstance(null);
754
755         // Clear out the InCallScreen references in various helper objects
756         // (to let them know we've been destroyed).
757         if (mInCallMenu != null) {
758             mInCallMenu.clearInCallScreenReference();
759         }
760         if (mCallCard != null) {
761             mCallCard.setInCallScreenInstance(null);
762         }
763
764         // Make sure that the dialer session is over and done with.
765         // 1. In Landscape mode, we stop the tone generator directly
766         // 2. In portrait mode, the tone generator is stopped
767         // whenever the dialer is closed by the framework, (either
768         // from a user request or calling close on the drawer
769         // directly), so all we have to do is to make sure the
770         // dialer is closed {see DTMFTwelvKeyDialer.onDialerClose}
771         // (it is ok to call this even if the dialer is not open).
772         if (ConfigurationHelper.isLandscape()) {
773             mDialer.stopDialerSession();
774         } else {
775             // make sure the dialer drawer is closed.
776             mDialer.closeDialer(false);
777         }
778         mDialer.clearInCallScreenReference();
779         mDialer = null;
780
781         unregisterForPhoneStates();
782         // No need to change wake state here; that happens in onPause() when we
783         // are moving out of the foreground.
784
785         if (mBluetoothHeadset != null) {
786             mBluetoothHeadset.close();
787             mBluetoothHeadset = null;
788         }
789     }
790
791     /**
792      * Dismisses the in-call screen.
793      *
794      * We never *really* finish() the InCallScreen, since we don't want to
795      * get destroyed and then have to be re-created from scratch for the
796      * next call.  Instead, we just move ourselves to the back of the
797      * activity stack.
798      *
799      * This also means that we'll no longer be reachable via the BACK
800      * button (since moveTaskToBack() puts us behind the Home app, but the
801      * home app doesn't allow the BACK key to move you any farther down in
802      * the history stack.)
803      *
804      * (Since the Phone app itself is never killed, this basically means
805      * that we'll keep a single InCallScreen instance around for the
806      * entire uptime of the device.  This noticeably improves the UI
807      * responsiveness for incoming calls.)
808      */
809     @Override
810     public void finish() {
811         if (DBG) log("finish()...");
812         moveTaskToBack(true);
813     }
814
815     /* package */ boolean isForegroundActivity() {
816         return mIsForegroundActivity;
817     }
818
819     private void registerForPhoneStates() {
820         if (!mRegisteredForPhoneStates) {
821             mPhone.registerForPhoneStateChanged(mHandler, PHONE_STATE_CHANGED, null);
822             mPhone.registerForDisconnect(mHandler, PHONE_DISCONNECT, null);
823             mPhone.registerForMmiInitiate(mHandler, PhoneApp.MMI_INITIATE, null);
824
825             // register for the MMI complete message.  Upon completion,
826             // PhoneUtils will bring up a system dialog instead of the
827             // message display class in PhoneUtils.displayMMIComplete().
828             // We'll listen for that message too, so that we can finish
829             // the activity at the same time.
830             mPhone.registerForMmiComplete(mHandler, PhoneApp.MMI_COMPLETE, null);
831
832             mPhone.setOnPostDialCharacter(mHandler, POST_ON_DIAL_CHARS, null);
833             mPhone.registerForSuppServiceFailed(mHandler, SUPP_SERVICE_FAILED, null);
834             mRegisteredForPhoneStates = true;
835         }
836     }
837
838     private void unregisterForPhoneStates() {
839         mPhone.unregisterForPhoneStateChanged(mHandler);
840         mPhone.unregisterForDisconnect(mHandler);
841         mPhone.unregisterForMmiInitiate(mHandler);
842         mPhone.setOnPostDialCharacter(null, POST_ON_DIAL_CHARS, null);
843         mRegisteredForPhoneStates = false;
844     }
845
846     @Override
847     protected void onNewIntent(Intent intent) {
848         if (DBG) log("onNewIntent: intent=" + intent);
849
850         // We're being re-launched with a new Intent.  Since we keep
851         // around a single InCallScreen instance for the life of the phone
852         // process (see finish()), this sequence will happen EVERY time
853         // there's a new incoming or outgoing call except for the very
854         // first time the InCallScreen gets created.  This sequence will
855         // also happen if the InCallScreen is already in the foreground
856         // (e.g. getting a new ACTION_CALL intent while we were already
857         // using the other line.)
858
859         // Stash away the new intent so that we can get it in the future
860         // by calling getIntent().  (Otherwise getIntent() will return the
861         // original Intent from when we first got created!)
862         setIntent(intent);
863
864         // Activities are always paused before receiving a new intent, so
865         // we can count on our onResume() method being called next.
866
867         // Just like in onCreate(), handle this intent, and stash the
868         // result code from internalResolveIntent() in the
869         // mInCallInitialStatus field.  If it's an error code, we'll
870         // handle it in onResume().
871         mInCallInitialStatus = internalResolveIntent(intent);
872         if (mInCallInitialStatus != InCallInitStatus.SUCCESS) {
873             Log.w(LOG_TAG, "onNewIntent: status " + mInCallInitialStatus
874                   + " from internalResolveIntent()");
875             // See onResume() for the actual error handling.
876         }
877     }
878
879     private InCallInitStatus internalResolveIntent(Intent intent) {
880         if (intent == null || intent.getAction() == null) {
881             return InCallInitStatus.SUCCESS;
882         }
883
884         String action = intent.getAction();
885         if (DBG) log("internalResolveIntent: action=" + action);
886
887         // The calls to setRestoreMuteOnInCallResume() inform the phone
888         // that we're dealing with new connections (either a placing an
889         // outgoing call or answering an incoming one, and NOT handling
890         // an aborted "Add Call" request), so we should let the mute state
891         // be handled by the PhoneUtils phone state change handler.
892         final PhoneApp app = PhoneApp.getInstance();
893         if (action.equals(Intent.ACTION_ANSWER)) {
894             internalAnswerCall();
895             app.setRestoreMuteOnInCallResume(false);
896             return InCallInitStatus.SUCCESS;
897         } else if (action.equals(Intent.ACTION_CALL)
898                 || action.equals(Intent.ACTION_CALL_EMERGENCY)) {
899             app.setRestoreMuteOnInCallResume(false);
900             return placeCall(intent);
901         } else if (action.equals(intent.ACTION_MAIN)) {
902             // The MAIN action is used to bring up the in-call screen without
903             // doing any other explicit action, like when you return to the
904             // current call after previously bailing out of the in-call UI.
905             // SHOW_DIALPAD_EXTRA can be used here to specify whether the DTMF
906             // dialpad should be initially visible.  If the extra isn't
907             // present at all, we just leave the dialpad in its previous state.
908             if (intent.hasExtra(SHOW_DIALPAD_EXTRA)) {
909                 boolean showDialpad = intent.getBooleanExtra(SHOW_DIALPAD_EXTRA, false);
910                 if (VDBG) log("- internalResolveIntent: SHOW_DIALPAD_EXTRA value = " + showDialpad);
911                 if (showDialpad) {
912                     mDialer.openDialer(false);  // no "opening" animation
913                 } else {
914                     mDialer.closeDialer(false);  // no "closing" animation
915                 }
916             }
917             return InCallInitStatus.SUCCESS;
918         } else {
919             Log.w(LOG_TAG, "internalResolveIntent: unexpected intent action: " + action);
920             // But continue the best we can (basically treating this case
921             // like ACTION_MAIN...)
922             return InCallInitStatus.SUCCESS;
923         }
924     }
925
926     private void stopTimer() {
927         if (mCallCard != null) mCallCard.stopTimer();
928     }
929
930     private void initInCallScreen() {
931         if (VDBG) log("initInCallScreen()...");
932
933         // Have the WindowManager filter out touch events that are "too fat".
934         getWindow().addFlags(WindowManager.LayoutParams.FLAG_IGNORE_CHEEK_PRESSES);
935
936         mMainFrame = (ViewGroup) findViewById(R.id.mainFrame);
937         mInCallPanel = (ViewGroup) findViewById(R.id.inCallPanel);
938
939         ConfigurationHelper.initConfiguration(getResources().getConfiguration());
940
941         // Create a CallCard and add it to our View hierarchy.
942         // TODO: there's no good reason for call_card_popup to be a
943         // separate layout that we need to manually inflate here.
944         // (That design is left over from when the call card was drawn in
945         // its own PopupWindow.)
946         // Instead, the CallCard should just be <include>d directly from
947         // incall_screen.xml.
948         View callCardLayout = getLayoutInflater().inflate(
949                 R.layout.call_card_popup,
950                 mInCallPanel);
951         mCallCard = (CallCard) callCardLayout.findViewById(R.id.callCard);
952         if (VDBG) log("  - mCallCard = " + mCallCard);
953         mCallCard.setInCallScreenInstance(this);
954         mCallCard.reset();
955
956         // Menu Button hint
957         mMenuButtonHint = (TextView) findViewById(R.id.menuButtonHint);
958
959         // Make any final updates to our View hierarchy that depend on the
960         // current configuration.
961         ConfigurationHelper.applyConfigurationToLayout(this);
962     }
963
964     /**
965      * Returns true if the phone is "in use", meaning that at least one line
966      * is active (ie. off hook or ringing or dialing).  Conversely, a return
967      * value of false means there's currently no phone activity at all.
968      */
969     private boolean phoneIsInUse() {
970         return mPhone.getState() != Phone.State.IDLE;
971     }
972
973     private boolean handleDialerKeyDown(int keyCode, KeyEvent event) {
974         if (VDBG) log("handleDialerKeyDown: keyCode " + keyCode + ", event " + event + "...");
975
976         // As soon as the user starts typing valid dialable keys on the
977         // keyboard (presumably to type DTMF tones) we start passing the
978         // key events to the DTMFDialer's onDialerKeyDown.  We do so
979         // only if the okToDialDTMFTones() conditions pass.
980         if (okToDialDTMFTones()) {
981             return mDialer.onDialerKeyDown(event);
982         }
983
984         return false;
985     }
986
987     /**
988      * Handles a DOWN keypress on the BACK key.
989      */
990     private boolean handleBackKey() {
991         if (VDBG) log("handleBackKey()...");
992
993         // While an incoming call is ringing, BACK behaves just like
994         // ENDCALL: it stops the ringing and rejects the current call.
995         final CallNotifier notifier = PhoneApp.getInstance().notifier;
996         if (notifier.isRinging()) {
997             if (DBG) log("BACK key while ringing: reject the call");
998             internalHangupRingingCall();
999
1000             // Don't consume the key; instead let the BACK event *also*
1001             // get handled normally by the framework (which presumably
1002             // will cause us to exit out of this activity.)
1003             return false;
1004         }
1005
1006         // BACK is also used to exit out of any "special modes" of the
1007         // in-call UI:
1008
1009         if (mDialer.isOpened()) {
1010             // Take down the "touch lock" overlay *immediately* to let the
1011             // user clearly see the DTMF dialpad's closing animation.
1012             enableTouchLock(false);
1013
1014             mDialer.closeDialer(true);  // do the "closing" animation
1015             return true;
1016         }
1017
1018         if (mInCallScreenMode == InCallScreenMode.MANAGE_CONFERENCE) {
1019             // Hide the Manage Conference panel, return to NORMAL mode.
1020             setInCallScreenMode(InCallScreenMode.NORMAL);
1021             return true;
1022         }
1023
1024         return false;
1025     }
1026
1027     /**
1028      * Handles the green CALL key while in-call.
1029      * @return true if we consumed the event.
1030      */
1031     private boolean handleCallKey() {
1032         // The green CALL button means either "Answer", "Unhold", or
1033         // "Swap calls", or can be a no-op, depending on the current state
1034         // of the Phone.
1035
1036         final boolean hasRingingCall = !mRingingCall.isIdle();
1037         final boolean hasActiveCall = !mForegroundCall.isIdle();
1038         final boolean hasHoldingCall = !mBackgroundCall.isIdle();
1039
1040         if (mPhone.getPhoneName().equals("CDMA")) {
1041             // The green CALL button means either "Answer", "Swap calls/On Hold", or
1042             // "Add to 3WC", depending on the current state of the Phone.
1043
1044             if (hasRingingCall) {
1045                 if (VDBG) log("handleCallKey: ringing ==> answer!");
1046                 internalAnswerCall();  // Automatically holds the current active call,
1047                                        // if there is one
1048             } else {
1049                 // send an empty CDMA flash string
1050                 PhoneUtils.switchHoldingAndActive(mPhone);
1051             }
1052         } else {
1053             if (hasRingingCall) {
1054                 // If an incoming call is ringing, the CALL button is actually
1055                 // handled by the PhoneWindowManager.  (We do this to make
1056                 // sure that we'll respond to the key even if the InCallScreen
1057                 // hasn't come to the foreground yet.)
1058                 //
1059                 // We'd only ever get here in the extremely rare case that the
1060                 // incoming call started ringing *after*
1061                 // PhoneWindowManager.interceptKeyTq() but before the event
1062                 // got here, or else if the PhoneWindowManager had some
1063                 // problem connecting to the ITelephony service.
1064                 Log.w(LOG_TAG, "handleCallKey: incoming call is ringing!"
1065                       + " (PhoneWindowManager should have handled this key.)");
1066                 // But go ahead and handle the key as normal, since the
1067                 // PhoneWindowManager presumably did NOT handle it:
1068
1069                 // There's an incoming ringing call: CALL means "Answer".
1070                 if (hasActiveCall && hasHoldingCall) {
1071                     if (DBG) log("handleCallKey: ringing (both lines in use) ==> answer!");
1072                     internalAnswerCallBothLinesInUse();
1073                 } else {
1074                     if (DBG) log("handleCallKey: ringing ==> answer!");
1075                     internalAnswerCall();  // Automatically holds the current active call,
1076                                            // if there is one
1077                 }
1078             } else if (hasActiveCall && hasHoldingCall) {
1079                 // Two lines are in use: CALL means "Swap calls".
1080                 if (DBG) log("handleCallKey: both lines in use ==> swap calls.");
1081                 internalSwapCalls();
1082             } else if (hasHoldingCall) {
1083                 // There's only one line in use, AND it's on hold.
1084                 // In this case CALL is a shortcut for "unhold".
1085                 if (DBG) log("handleCallKey: call on hold ==> unhold.");
1086                 PhoneUtils.switchHoldingAndActive(mPhone);  // Really means "unhold" in this state
1087             } else {
1088                 // The most common case: there's only one line in use, and
1089                 // it's an active call (i.e. it's not on hold.)
1090                 // In this case CALL is a no-op.
1091                 // (This used to be a shortcut for "add call", but that was a
1092                 // bad idea because "Add call" is so infrequently-used, and
1093                 // because the user experience is pretty confusing if you
1094                 // inadvertently trigger it.)
1095                 if (VDBG) log("handleCallKey: call in foregound ==> ignoring.");
1096                 // But note we still consume this key event; see below.
1097             }
1098         }
1099
1100         // We *always* consume the CALL key, since the system-wide default
1101         // action ("go to the in-call screen") is useless here.
1102         return true;
1103     }
1104
1105     boolean isKeyEventAcceptableDTMF (KeyEvent event) {
1106         return (mDialer != null && mDialer.isKeyEventAcceptable(event));
1107     }
1108
1109     /**
1110      * Overriden to track relevant focus changes.
1111      *
1112      * If a key is down and some time later the focus changes, we may
1113      * NOT recieve the keyup event; logically the keyup event has not
1114      * occured in this window.  This issue is fixed by treating a focus
1115      * changed event as an interruption to the keydown, making sure
1116      * that any code that needs to be run in onKeyUp is ALSO run here.
1117      *
1118      * Note, this focus change event happens AFTER the in-call menu is
1119      * displayed, so mIsMenuDisplayed should always be correct by the
1120      * time this method is called in the framework, please see:
1121      * {@link onCreatePanelView}, {@link onOptionsMenuClosed}
1122      */
1123     @Override
1124     public void onWindowFocusChanged(boolean hasFocus) {
1125         // the dtmf tones should no longer be played
1126         if (VDBG) log("onWindowFocusChanged(" + hasFocus + ")...");
1127         if (!hasFocus && mDialer != null) {
1128             if (VDBG) log("- onWindowFocusChanged: faking onDialerKeyUp()...");
1129             mDialer.onDialerKeyUp(null);
1130         }
1131     }
1132
1133     @Override
1134     public boolean dispatchKeyEvent(KeyEvent event) {
1135         // if (DBG) log("dispatchKeyEvent(event " + event + ")...");
1136
1137         // Intercept some events before they get dispatched to our views.
1138         switch (event.getKeyCode()) {
1139             case KeyEvent.KEYCODE_DPAD_CENTER:
1140             case KeyEvent.KEYCODE_DPAD_UP:
1141             case KeyEvent.KEYCODE_DPAD_DOWN:
1142             case KeyEvent.KEYCODE_DPAD_LEFT:
1143             case KeyEvent.KEYCODE_DPAD_RIGHT:
1144                 // Disable DPAD keys and trackball clicks if the touch lock
1145                 // overlay is up, since "touch lock" really means "disable
1146                 // the DTMF dialpad" (rather than only disabling touch events.)
1147                 if (mDialer.isOpened() && isTouchLocked()) {
1148                     if (DBG) log("- ignoring DPAD event while touch-locked...");
1149                     return true;
1150                 }
1151                 break;
1152
1153             default:
1154                 break;
1155         }
1156
1157         return super.dispatchKeyEvent(event);
1158     }
1159
1160     @Override
1161     public boolean onKeyUp(int keyCode, KeyEvent event) {
1162         // if (DBG) log("onKeyUp(keycode " + keyCode + ")...");
1163
1164         // push input to the dialer.
1165         if ((mDialer != null) && (mDialer.onDialerKeyUp(event))){
1166             return true;
1167         } else if (keyCode == KeyEvent.KEYCODE_CALL) {
1168             // Always consume CALL to be sure the PhoneWindow won't do anything with it
1169             return true;
1170         }
1171         return super.onKeyUp(keyCode, event);
1172     }
1173
1174     @Override
1175     public boolean onKeyDown(int keyCode, KeyEvent event) {
1176         // if (DBG) log("onKeyDown(keycode " + keyCode + ")...");
1177
1178         switch (keyCode) {
1179             case KeyEvent.KEYCODE_CALL:
1180                 boolean handled = handleCallKey();
1181                 if (!handled) {
1182                     Log.w(LOG_TAG, "InCallScreen should always handle KEYCODE_CALL in onKeyDown");
1183                 }
1184                 // Always consume CALL to be sure the PhoneWindow won't do anything with it
1185                 return true;
1186
1187             // Note there's no KeyEvent.KEYCODE_ENDCALL case here.
1188             // The standard system-wide handling of the ENDCALL key
1189             // (see PhoneWindowManager's handling of KEYCODE_ENDCALL)
1190             // already implements exactly what the UI spec wants,
1191             // namely (1) "hang up" if there's a current active call,
1192             // or (2) "don't answer" if there's a current ringing call.
1193
1194             case KeyEvent.KEYCODE_BACK:
1195                 if (handleBackKey()) {
1196                     return true;
1197                 }
1198                 break;
1199
1200             case KeyEvent.KEYCODE_CAMERA:
1201                 // Disable the CAMERA button while in-call since it's too
1202                 // easy to press accidentally.
1203                 return true;
1204
1205             case KeyEvent.KEYCODE_VOLUME_UP:
1206             case KeyEvent.KEYCODE_VOLUME_DOWN:
1207                 if (mPhone.getState() == Phone.State.RINGING) {
1208                     // If an incoming call is ringing, the VOLUME buttons are
1209                     // actually handled by the PhoneWindowManager.  (We do
1210                     // this to make sure that we'll respond to them even if
1211                     // the InCallScreen hasn't come to the foreground yet.)
1212                     //
1213                     // We'd only ever get here in the extremely rare case that the
1214                     // incoming call started ringing *after*
1215                     // PhoneWindowManager.interceptKeyTq() but before the event
1216                     // got here, or else if the PhoneWindowManager had some
1217                     // problem connecting to the ITelephony service.
1218                     Log.w(LOG_TAG, "VOLUME key: incoming call is ringing!"
1219                           + " (PhoneWindowManager should have handled this key.)");
1220                     // But go ahead and handle the key as normal, since the
1221                     // PhoneWindowManager presumably did NOT handle it:
1222
1223                     final CallNotifier notifier = PhoneApp.getInstance().notifier;
1224                     if (notifier.isRinging()) {
1225                         // ringer is actually playing, so silence it.
1226                         PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_IDLE);
1227                         if (DBG) log("VOLUME key: silence ringer");
1228                         notifier.silenceRinger();
1229                     }
1230
1231                     // As long as an incoming call is ringing, we always
1232                     // consume the VOLUME keys.
1233                     return true;
1234                 }
1235                 break;
1236
1237             case KeyEvent.KEYCODE_MENU:
1238                 // Special case for the MENU key: if the "touch lock"
1239                 // overlay is up (over the DTMF dialpad), allow MENU to
1240                 // dismiss the overlay just as if you had double-tapped
1241                 // the onscreen icon.
1242                 // (We do this because MENU is normally used to bring the
1243                 // UI back after the screen turns off, and the touch lock
1244                 // overlay "feels" very similar to the screen going off.
1245                 // This is also here to be "backward-compatibile" with the
1246                 // 1.0 behavior, where you *needed* to hit MENU to bring
1247                 // back the dialpad after 6 seconds of idle time.)
1248                 if (mDialer.isOpened() && isTouchLocked()) {
1249                     if (VDBG) log("- allowing MENU to dismiss touch lock overlay...");
1250                     // Take down the touch lock overlay, but post a
1251                     // message in the future to bring it back later.
1252                     enableTouchLock(false);
1253                     resetTouchLockTimer();
1254                     return true;
1255                 }
1256                 break;
1257
1258             case KeyEvent.KEYCODE_MUTE:
1259                 PhoneUtils.setMute(mPhone, !PhoneUtils.getMute(mPhone));
1260                 return true;
1261
1262             // Various testing/debugging features, enabled ONLY when VDBG == true.
1263             case KeyEvent.KEYCODE_SLASH:
1264                 if (VDBG) {
1265                     log("----------- InCallScreen View dump --------------");
1266                     // Dump starting from the top-level view of the entire activity:
1267                     Window w = this.getWindow();
1268                     View decorView = w.getDecorView();
1269                     decorView.debug();
1270                     return true;
1271                 }
1272                 break;
1273             case KeyEvent.KEYCODE_EQUALS:
1274                 if (VDBG) {
1275                     log("----------- InCallScreen call state dump --------------");
1276                     PhoneUtils.dumpCallState(mPhone);
1277                     return true;
1278                 }
1279                 break;
1280             case KeyEvent.KEYCODE_GRAVE:
1281                 if (VDBG) {
1282                     // Placeholder for other misc temp testing
1283                     log("------------ Temp testing -----------------");
1284                     return true;
1285                 }
1286                 break;
1287         }
1288
1289         if (event.getRepeatCount() == 0 && handleDialerKeyDown(keyCode, event)) {
1290             return true;
1291         }
1292
1293         return super.onKeyDown(keyCode, event);
1294     }
1295
1296     /**
1297      * Handle a failure notification for a supplementary service
1298      * (i.e. conference, switch, separate, transfer, etc.).
1299      */
1300     void onSuppServiceFailed(AsyncResult r) {
1301         Phone.SuppService service = (Phone.SuppService) r.result;
1302         if (DBG) log("onSuppServiceFailed: " + service);
1303
1304         int errorMessageResId;
1305         switch (service) {
1306             case SWITCH:
1307                 // Attempt to switch foreground and background/incoming calls failed
1308                 // ("Failed to switch calls")
1309                 errorMessageResId = R.string.incall_error_supp_service_switch;
1310                 break;
1311
1312             case SEPARATE:
1313                 // Attempt to separate a call from a conference call
1314                 // failed ("Failed to separate out call")
1315                 errorMessageResId = R.string.incall_error_supp_service_separate;
1316                 break;
1317
1318             case TRANSFER:
1319                 // Attempt to connect foreground and background calls to
1320                 // each other (and hanging up user's line) failed ("Call
1321                 // transfer failed")
1322                 errorMessageResId = R.string.incall_error_supp_service_transfer;
1323                 break;
1324
1325             case CONFERENCE:
1326                 // Attempt to add a call to conference call failed
1327                 // ("Conference call failed")
1328                 errorMessageResId = R.string.incall_error_supp_service_conference;
1329                 break;
1330
1331             case REJECT:
1332                 // Attempt to reject an incoming call failed
1333                 // ("Call rejection failed")
1334                 errorMessageResId = R.string.incall_error_supp_service_reject;
1335                 break;
1336
1337             case HANGUP:
1338                 // Attempt to release a call failed ("Failed to release call(s)")
1339                 errorMessageResId = R.string.incall_error_supp_service_hangup;
1340                 break;
1341
1342             case UNKNOWN:
1343             default:
1344                 // Attempt to use a service we don't recognize or support
1345                 // ("Unsupported service" or "Selected service failed")
1346                 errorMessageResId = R.string.incall_error_supp_service_unknown;
1347                 break;
1348         }
1349
1350         // mSuppServiceFailureDialog is a generic dialog used for any
1351         // supp service failure, and there's only ever have one
1352         // instance at a time.  So just in case a previous dialog is
1353         // still around, dismiss it.
1354         if (mSuppServiceFailureDialog != null) {
1355             if (DBG) log("- DISMISSING mSuppServiceFailureDialog.");
1356             mSuppServiceFailureDialog.dismiss();  // It's safe to dismiss() a dialog
1357                                                   // that's already dismissed.
1358             mSuppServiceFailureDialog = null;
1359         }
1360
1361         mSuppServiceFailureDialog = new AlertDialog.Builder(this)
1362                 .setMessage(errorMessageResId)
1363                 .setPositiveButton(R.string.ok, null)
1364                 .setCancelable(true)
1365                 .create();
1366         mSuppServiceFailureDialog.getWindow().addFlags(
1367                 WindowManager.LayoutParams.FLAG_BLUR_BEHIND);
1368         mSuppServiceFailureDialog.show();
1369     }
1370
1371     /**
1372      * Something has changed in the phone's state.  Update the UI.
1373      */
1374     private void onPhoneStateChanged(AsyncResult r) {
1375         if (VDBG) log("onPhoneStateChanged()...");
1376
1377         // There's nothing to do here if we're not the foreground activity.
1378         // (When we *do* eventually come to the foreground, we'll do a
1379         // full update then.)
1380         if (!mIsForegroundActivity) {
1381             if (VDBG) log("onPhoneStateChanged: Activity not in foreground! Bailing out...");
1382             return;
1383         }
1384
1385         updateScreen();
1386
1387         // Make sure we update the poke lock and wake lock when certain
1388         // phone state changes occur.
1389         PhoneApp.getInstance().updateWakeState();
1390     }
1391
1392     /**
1393      * Updates the UI after a phone connection is disconnected, as follows:
1394      *
1395      * - If this was a missed or rejected incoming call, and no other
1396      *   calls are active, dismiss the in-call UI immediately.  (The
1397      *   CallNotifier will still create a "missed call" notification if
1398      *   necessary.)
1399      *
1400      * - With any other disconnect cause, if the phone is now totally
1401      *   idle, display the "Call ended" state for a couple of seconds.
1402      *
1403      * - Or, if the phone is still in use, stay on the in-call screen
1404      *   (and update the UI to reflect the current state of the Phone.)
1405      *
1406      * @param r r.result contains the connection that just ended
1407      */
1408     private void onDisconnect(AsyncResult r) {
1409         Connection c = (Connection) r.result;
1410         Connection.DisconnectCause cause = c.getDisconnectCause();
1411         if (DBG) log("onDisconnect: " + c + ", cause=" + cause);
1412
1413         // Any time a call disconnects, clear out the "history" of DTMF
1414         // digits you typed (to make sure it doesn't persist from one call
1415         // to the next.)
1416         mDialer.clearDigits();
1417
1418         // Under certain call disconnected states, we want to alert the user
1419         // with a dialog instead of going through the normal disconnect
1420         // routine.
1421         if (cause == Connection.DisconnectCause.CALL_BARRED) {
1422             showGenericErrorDialog(R.string.callFailed_cb_enabled, false);
1423             return;
1424         } else if (cause == Connection.DisconnectCause.FDN_BLOCKED) {
1425             showGenericErrorDialog(R.string.callFailed_fdn_only, false);
1426             return;
1427         } else if (cause == Connection.DisconnectCause.CS_RESTRICTED) {
1428             showGenericErrorDialog(R.string.callFailed_dsac_restricted, false);
1429             return;
1430         } else if (cause == Connection.DisconnectCause.CS_RESTRICTED_EMERGENCY) {
1431             showGenericErrorDialog(R.string.callFailed_dsac_restricted_emergency, false);
1432             return;
1433         } else if (cause == Connection.DisconnectCause.CS_RESTRICTED_NORMAL) {
1434             showGenericErrorDialog(R.string.callFailed_dsac_restricted_normal, false);
1435             return;
1436         } else if (cause == Connection.DisconnectCause.CDMA_LOCKED_UNTIL_POWER_CYCLE) {
1437             showGenericErrorDialog(R.string.callFailed_cdma_lockedUntilPowerCycle, false);
1438             return;
1439         } else if (cause == Connection.DisconnectCause.CDMA_DROP) {
1440             showGenericErrorDialog(R.string.callFailed_cdma_drop, false);
1441             return;
1442         } else if (cause == Connection.DisconnectCause.CDMA_INTERCEPT) {
1443             showGenericErrorDialog(R.string.callFailed_cdma_intercept, false);
1444             return;
1445         } else if (cause == Connection.DisconnectCause.CDMA_REORDER) {
1446             showGenericErrorDialog(R.string.callFailed_cdma_reorder, false);
1447             return;
1448         } else if (cause == Connection.DisconnectCause.CDMA_SO_REJECT) {
1449             showGenericErrorDialog(R.string.callFailed_cdma_SO_reject, false);
1450             return;
1451         }else if (cause == Connection.DisconnectCause.CDMA_RETRY_ORDER) {
1452             showGenericErrorDialog(R.string.callFailed_cdma_retryOrder, false);
1453             return;
1454         } else if (cause == Connection.DisconnectCause.CDMA_ACCESS_FAILURE) {
1455             showGenericErrorDialog(R.string.callFailed_cdma_accessFailure, false);
1456             return;
1457         } else if (cause == Connection.DisconnectCause.CDMA_PREEMPTED) {
1458             showGenericErrorDialog(R.string.callFailed_cdma_preempted, false);
1459             return;
1460         } else if (cause == Connection.DisconnectCause.CDMA_NOT_EMERGENCY) {
1461             showGenericErrorDialog(R.string.callFailed_cdma_notEmergency, false);
1462             return;
1463         }
1464
1465         final PhoneApp app = PhoneApp.getInstance();
1466         boolean currentlyIdle = !phoneIsInUse();
1467
1468         // Explicitly clean up up any DISCONNECTED connections
1469         // in a conference call.
1470         // [Background: Even after a connection gets disconnected, its
1471         // Connection object still stays around for a few seconds, in the
1472         // DISCONNECTED state.  With regular calls, this state drives the
1473         // "call ended" UI.  But when a single person disconnects from a
1474         // conference call there's no "call ended" state at all; in that
1475         // case we blow away any DISCONNECTED connections right now to make sure
1476         // the UI updates instantly to reflect the current state.]
1477         Call call = c.getCall();
1478         if (call != null) {
1479             // We only care about situation of a single caller
1480             // disconnecting from a conference call.  In that case, the
1481             // call will have more than one Connection (including the one
1482             // that just disconnected, which will be in the DISCONNECTED
1483             // state) *and* at least one ACTIVE connection.  (If the Call
1484             // has *no* ACTIVE connections, that means that the entire
1485             // conference call just ended, so we *do* want to show the
1486             // "Call ended" state.)
1487             List<Connection> connections = call.getConnections();
1488             if (connections != null && connections.size() > 1) {
1489                 for (Connection conn : connections) {
1490                     if (conn.getState() == Call.State.ACTIVE) {
1491                         // This call still has at least one ACTIVE connection!
1492                         // So blow away any DISCONNECTED connections
1493                         // (including, presumably, the one that just
1494                         // disconnected from this conference call.)
1495
1496                         // We also force the wake state to refresh, just in
1497                         // case the disconnected connections are removed
1498                         // before the phone state change.
1499                         if (VDBG) log("- Still-active conf call; clearing DISCONNECTED...");
1500                         app.updateWakeState();
1501                         mPhone.clearDisconnected();  // This happens synchronously.
1502                         break;
1503                     }
1504                 }
1505             }
1506         }
1507
1508         // Retrieve the emergency call retry count from this intent, in
1509         // case we need to retry the call again.
1510         int emergencyCallRetryCount = getIntent().getIntExtra(
1511                 EmergencyCallHandler.EMERGENCY_CALL_RETRY_KEY,
1512                 EmergencyCallHandler.INITIAL_ATTEMPT);
1513
1514         // Note: see CallNotifier.onDisconnect() for some other behavior
1515         // that might be triggered by a disconnect event, like playing the
1516         // busy/congestion tone.
1517
1518         // Keep track of whether this call was user-initiated or not.
1519         // (This affects where we take the user next; see delayedCleanupAfterDisconnect().)
1520         mShowCallLogAfterDisconnect = !c.isIncoming();
1521
1522         // We bail out immediately (and *don't* display the "call ended"
1523         // state at all) in a couple of cases, including those where we
1524         // are waiting for the radio to finish powering up for an
1525         // emergency call:
1526         boolean bailOutImmediately =
1527                 ((cause == Connection.DisconnectCause.INCOMING_MISSED)
1528                  || (cause == Connection.DisconnectCause.INCOMING_REJECTED)
1529                  || ((cause == Connection.DisconnectCause.OUT_OF_SERVICE)
1530                          && (emergencyCallRetryCount > 0)))
1531                 && currentlyIdle;
1532
1533         if (bailOutImmediately) {
1534             if (VDBG) log("- onDisconnect: bailOutImmediately...");
1535             // Exit the in-call UI!
1536             // (This is basically the same "delayed cleanup" we do below,
1537             // just with zero delay.  Since the Phone is currently idle,
1538             // this call is guaranteed to immediately finish() this activity.)
1539             delayedCleanupAfterDisconnect();
1540
1541             // Retry the call, by resending the intent to the emergency
1542             // call handler activity.
1543             if ((cause == Connection.DisconnectCause.OUT_OF_SERVICE)
1544                     && (emergencyCallRetryCount > 0)) {
1545                 startActivity(getIntent()
1546                         .setClassName(this, EmergencyCallHandler.class.getName()));
1547             }
1548         } else {
1549             if (VDBG) log("- onDisconnect: delayed bailout...");
1550             // Stay on the in-call screen for now.  (Either the phone is
1551             // still in use, or the phone is idle but we want to display
1552             // the "call ended" state for a couple of seconds.)
1553
1554             // Force a UI update in case we need to display anything
1555             // special given this connection's DisconnectCause (see
1556             // CallCard.getCallFailedString()).
1557             updateScreen();
1558
1559             // Display the special "Call ended" state when the phone is idle
1560             // but there's still a call in the DISCONNECTED state:
1561             if (currentlyIdle
1562                 && ((mForegroundCall.getState() == Call.State.DISCONNECTED)
1563                     || (mBackgroundCall.getState() == Call.State.DISCONNECTED))) {
1564                 if (VDBG) log("- onDisconnect: switching to 'Call ended' state...");
1565                 setInCallScreenMode(InCallScreenMode.CALL_ENDED);
1566             }
1567
1568             // Some other misc cleanup that we do if the call that just
1569             // disconnected was the foreground call.
1570             final boolean hasActiveCall = !mForegroundCall.isIdle();
1571             if (!hasActiveCall) {
1572                 if (VDBG) log("- onDisconnect: cleaning up after FG call disconnect...");
1573
1574                 // Dismiss any dialogs which are only meaningful for an
1575                 // active call *and* which become moot if the call ends.
1576                 if (mWaitPromptDialog != null) {
1577                     if (VDBG) log("- DISMISSING mWaitPromptDialog.");
1578                     mWaitPromptDialog.dismiss();  // safe even if already dismissed
1579                     mWaitPromptDialog = null;
1580                 }
1581                 if (mWildPromptDialog != null) {
1582                     if (VDBG) log("- DISMISSING mWildPromptDialog.");
1583                     mWildPromptDialog.dismiss();  // safe even if already dismissed
1584                     mWildPromptDialog = null;
1585                 }
1586             }
1587
1588             // Updating the screen wake state is done in onPhoneStateChanged().
1589
1590             // Finally, arrange for delayedCleanupAfterDisconnect() to get
1591             // called after a short interval (during which we display the
1592             // "call ended" state.)  At that point, if the
1593             // Phone is idle, we'll finish() out of this activity.
1594             int callEndedDisplayDelay =
1595                     (cause == Connection.DisconnectCause.LOCAL)
1596                     ? CALL_ENDED_SHORT_DELAY : CALL_ENDED_LONG_DELAY;
1597             mHandler.removeMessages(DELAYED_CLEANUP_AFTER_DISCONNECT);
1598             mHandler.sendEmptyMessageDelayed(DELAYED_CLEANUP_AFTER_DISCONNECT,
1599                                              callEndedDisplayDelay);
1600         }
1601     }
1602
1603     /**
1604      * Brings up the "MMI Started" dialog.
1605      */
1606     private void onMMIInitiate(AsyncResult r) {
1607         if (VDBG) log("onMMIInitiate()...  AsyncResult r = " + r);
1608
1609         // Watch out: don't do this if we're not the foreground activity,
1610         // mainly since in the Dialog.show() might fail if we don't have a
1611         // valid window token any more...
1612         // (Note that this exact sequence can happen if you try to start
1613         // an MMI code while the radio is off or out of service.)
1614         if (!mIsForegroundActivity) {
1615             if (VDBG) log("Activity not in foreground! Bailing out...");
1616             return;
1617         }
1618
1619         // Also, if any other dialog is up right now (presumably the
1620         // generic error dialog displaying the "Starting MMI..."  message)
1621         // take it down before bringing up the real "MMI Started" dialog
1622         // in its place.
1623         dismissAllDialogs();
1624
1625         MmiCode mmiCode = (MmiCode) r.result;
1626         if (VDBG) log("  - MmiCode: " + mmiCode);
1627
1628         Message message = Message.obtain(mHandler, PhoneApp.MMI_CANCEL);
1629         mMmiStartedDialog = PhoneUtils.displayMMIInitiate(this, mmiCode,
1630                                                           message, mMmiStartedDialog);
1631     }
1632
1633     /**
1634      * Handles an MMI_CANCEL event, which is triggered by the button
1635      * (labeled either "OK" or "Cancel") on the "MMI Started" dialog.
1636      * @see onMMIInitiate
1637      * @see PhoneUtils.cancelMmiCode
1638      */
1639     private void onMMICancel() {
1640         if (VDBG) log("onMMICancel()...");
1641
1642         // First of all, cancel the outstanding MMI code (if possible.)
1643         PhoneUtils.cancelMmiCode(mPhone);
1644
1645         // Regardless of whether the current MMI code was cancelable, the
1646         // PhoneApp will get an MMI_COMPLETE event very soon, which will
1647         // take us to the MMI Complete dialog (see
1648         // PhoneUtils.displayMMIComplete().)
1649         //
1650         // But until that event comes in, we *don't* want to stay here on
1651         // the in-call screen, since we'll be visible in a
1652         // partially-constructed state as soon as the "MMI Started" dialog
1653         // gets dismissed.  So let's forcibly bail out right now.
1654         if (DBG) log("onMMICancel: finishing...");
1655         finish();
1656     }
1657
1658     /**
1659      * Handles the POST_ON_DIAL_CHARS message from the Phone
1660      * (see our call to mPhone.setOnPostDialCharacter() above.)
1661      *
1662      * TODO: NEED TO TEST THIS SEQUENCE now that we no longer handle
1663      * "dialable" key events here in the InCallScreen: we do directly to the
1664      * Dialer UI instead.  Similarly, we may now need to go directly to the
1665      * Dialer to handle POST_ON_DIAL_CHARS too.
1666      */
1667     private void handlePostOnDialChars(AsyncResult r, char ch) {
1668         Connection c = (Connection) r.result;
1669
1670         if (c != null) {
1671             Connection.PostDialState state =
1672                     (Connection.PostDialState) r.userObj;
1673
1674             if (VDBG) log("handlePostOnDialChar: state = " +
1675                     state + ", ch = " + ch);
1676
1677             switch (state) {
1678                 case STARTED:
1679                     // TODO: is this needed, now that you can't actually
1680                     // type DTMF chars or dial directly from here?
1681                     // If so, we'd need to yank you out of the in-call screen
1682                     // here too (and take you to the 12-key dialer in "in-call" mode.)
1683                     // displayPostDialedChar(ch);
1684                     break;
1685
1686                 case WAIT:
1687                     //if (DBG) log("show wait prompt...");
1688                     String postDialStr = c.getRemainingPostDialString();
1689                     showWaitPromptDialog(c, postDialStr);
1690                     break;
1691
1692                 case WILD:
1693                     //if (DBG) log("prompt user to replace WILD char");
1694                     showWildPromptDialog(c);
1695                     break;
1696
1697                 case COMPLETE:
1698                     break;
1699
1700                 default:
1701                     break;
1702             }
1703         }
1704     }
1705
1706     private void showWaitPromptDialog(final Connection c, String postDialStr) {
1707         Resources r = getResources();
1708         StringBuilder buf = new StringBuilder();
1709         buf.append(r.getText(R.string.wait_prompt_str));
1710         buf.append(postDialStr);
1711
1712         if (mWaitPromptDialog != null) {
1713             if (VDBG) log("- DISMISSING mWaitPromptDialog.");
1714             mWaitPromptDialog.dismiss();  // safe even if already dismissed
1715             mWaitPromptDialog = null;
1716         }
1717
1718         mWaitPromptDialog = new AlertDialog.Builder(this)
1719                 .setMessage(buf.toString())
1720                 .setPositiveButton(R.string.send_button, new DialogInterface.OnClickListener() {
1721                         public void onClick(DialogInterface dialog, int whichButton) {
1722                             if (VDBG) log("handle WAIT_PROMPT_CONFIRMED, proceed...");
1723                             c.proceedAfterWaitChar();
1724                             PhoneApp.getInstance().pokeUserActivity();
1725                         }
1726                     })
1727                 .setOnCancelListener(new DialogInterface.OnCancelListener() {
1728                         public void onCancel(DialogInterface dialog) {
1729                             if (VDBG) log("handle POST_DIAL_CANCELED!");
1730                             c.cancelPostDial();
1731                             PhoneApp.getInstance().pokeUserActivity();
1732                         }
1733                     })
1734                 .create();
1735         mWaitPromptDialog.getWindow().addFlags(
1736                 WindowManager.LayoutParams.FLAG_BLUR_BEHIND);
1737         mWaitPromptDialog.show();
1738     }
1739
1740     private View createWildPromptView() {
1741         LinearLayout result = new LinearLayout(this);
1742         result.setOrientation(LinearLayout.VERTICAL);
1743         result.setPadding(5, 5, 5, 5);
1744
1745         LinearLayout.LayoutParams lp = new LinearLayout.LayoutParams(
1746                         ViewGroup.LayoutParams.FILL_PARENT,
1747                         ViewGroup.LayoutParams.WRAP_CONTENT);
1748
1749         TextView promptMsg = new TextView(this);
1750         promptMsg.setTextSize(14);
1751         promptMsg.setTypeface(Typeface.DEFAULT_BOLD);
1752         promptMsg.setText(getResources().getText(R.string.wild_prompt_str));
1753
1754         result.addView(promptMsg, lp);
1755
1756         mWildPromptText = new EditText(this);
1757         mWildPromptText.setKeyListener(DialerKeyListener.getInstance());
1758         mWildPromptText.setMovementMethod(null);
1759         mWildPromptText.setTextSize(14);
1760         mWildPromptText.setMaxLines(1);
1761         mWildPromptText.setHorizontallyScrolling(true);
1762         mWildPromptText.setBackgroundResource(android.R.drawable.editbox_background);
1763
1764         LinearLayout.LayoutParams lp2 = new LinearLayout.LayoutParams(
1765                         ViewGroup.LayoutParams.FILL_PARENT,
1766                         ViewGroup.LayoutParams.WRAP_CONTENT);
1767         lp2.setMargins(0, 3, 0, 0);
1768
1769         result.addView(mWildPromptText, lp2);
1770
1771         return result;
1772     }
1773
1774     private void showWildPromptDialog(final Connection c) {
1775         View v = createWildPromptView();
1776
1777         if (mWildPromptDialog != null) {
1778             if (VDBG) log("- DISMISSING mWildPromptDialog.");
1779             mWildPromptDialog.dismiss();  // safe even if already dismissed
1780             mWildPromptDialog = null;
1781         }
1782
1783         mWildPromptDialog = new AlertDialog.Builder(this)
1784                 .setView(v)
1785                 .setPositiveButton(
1786                         R.string.send_button,
1787                         new DialogInterface.OnClickListener() {
1788                             public void onClick(DialogInterface dialog, int whichButton) {
1789                                 if (VDBG) log("handle WILD_PROMPT_CHAR_ENTERED, proceed...");
1790                                 String replacement = null;
1791                                 if (mWildPromptText != null) {
1792                                     replacement = mWildPromptText.getText().toString();
1793                                     mWildPromptText = null;
1794                                 }
1795                                 c.proceedAfterWildChar(replacement);
1796                                 PhoneApp.getInstance().pokeUserActivity();
1797                             }
1798                         })
1799                 .setOnCancelListener(
1800                         new DialogInterface.OnCancelListener() {
1801                             public void onCancel(DialogInterface dialog) {
1802                                 if (VDBG) log("handle POST_DIAL_CANCELED!");
1803                                 c.cancelPostDial();
1804                                 PhoneApp.getInstance().pokeUserActivity();
1805                             }
1806                         })
1807                 .create();
1808         mWildPromptDialog.getWindow().addFlags(
1809                 WindowManager.LayoutParams.FLAG_BLUR_BEHIND);
1810         mWildPromptDialog.show();
1811
1812         mWildPromptText.requestFocus();
1813     }
1814
1815     /**
1816      * Updates the state of the in-call UI based on the current state of
1817      * the Phone.
1818      */
1819     private void updateScreen() {
1820         if (VDBG) log("updateScreen()...");
1821
1822         // Don't update anything if we're not in the foreground (there's
1823         // no point updating our UI widgets since we're not visible!)
1824         // Also note this check also ensures we won't update while we're
1825         // in the middle of pausing, which could cause a visible glitch in
1826         // the "activity ending" transition.
1827         if (!mIsForegroundActivity) {
1828             if (VDBG) log("- updateScreen: not the foreground Activity! Bailing out...");
1829             return;
1830         }
1831
1832         // Update the state of the in-call menu items.
1833         if (mInCallMenu != null) {
1834             // TODO: do this only if the menu is visible!
1835             if (VDBG) log("- updateScreen: updating menu items...");
1836             boolean okToShowMenu = mInCallMenu.updateItems(mPhone);
1837             if (!okToShowMenu) {
1838                 // Uh oh: we were only trying to update the state of the
1839                 // menu items, but the logic in InCallMenu.updateItems()
1840                 // just decided the menu shouldn't be visible at all!
1841                 // (That's probably means that the call ended
1842                 // asynchronously while the menu was up.)
1843                 //
1844                 // So take the menu down ASAP.
1845                 if (VDBG) log("- updateScreen: Tried to update menu; now need to dismiss!");
1846                 // dismissMenu() has no effect if the menu is already closed.
1847                 dismissMenu(true);  // dismissImmediate = true
1848             }
1849         }
1850
1851         if (mInCallScreenMode == InCallScreenMode.MANAGE_CONFERENCE) {
1852             if (VDBG) log("- updateScreen: manage conference mode (NOT updating in-call UI)...");
1853             updateManageConferencePanelIfNecessary();
1854             return;
1855         } else if (mInCallScreenMode == InCallScreenMode.CALL_ENDED) {
1856             if (VDBG) log("- updateScreen: call ended state (NOT updating in-call UI)...");
1857             return;
1858         }
1859
1860         if (VDBG) log("- updateScreen: updating the in-call UI...");
1861         mCallCard.updateState(mPhone);
1862         updateDialpadVisibility();
1863         updateMenuButtonHint();
1864     }
1865
1866     /**
1867      * (Re)synchronizes the onscreen UI with the current state of the
1868      * Phone.
1869      *
1870      * @return InCallInitStatus.SUCCESS if we successfully updated the UI, or
1871      *    InCallInitStatus.PHONE_NOT_IN_USE if there was no phone state to sync
1872      *    with (ie. the phone was completely idle).  In the latter case, we
1873      *    shouldn't even be in the in-call UI in the first place, and it's
1874      *    the caller's responsibility to bail out of this activity (by
1875      *    calling finish()) if appropriate.
1876      */
1877     private InCallInitStatus syncWithPhoneState() {
1878         boolean updateSuccessful = false;
1879         if (DBG) log("syncWithPhoneState()...");
1880         if (VDBG) PhoneUtils.dumpCallState(mPhone);
1881         if (VDBG) dumpBluetoothState();
1882
1883         // Make sure the Phone is "in use".  (If not, we shouldn't be on
1884         // this screen in the first place.)
1885
1886         // Need to treat running MMI codes as a connection as well.
1887         // Do not check for getPendingMmiCodes when phone is a CDMA phone
1888         if (!mForegroundCall.isIdle() || !mBackgroundCall.isIdle() || !mRingingCall.isIdle()
1889             || mPhone.getPhoneName().equals("CDMA") || !mPhone.getPendingMmiCodes().isEmpty()) {
1890             if (VDBG) log("syncWithPhoneState: it's ok to be here; update the screen...");
1891             updateScreen();
1892             return InCallInitStatus.SUCCESS;
1893         }
1894
1895         if (DBG) log("syncWithPhoneState: phone is idle; we shouldn't be here!");
1896         return InCallInitStatus.PHONE_NOT_IN_USE;
1897     }
1898
1899     /**
1900      * Given the Intent we were initially launched with,
1901      * figure out the actual phone number we should dial.
1902      *
1903      * @return the phone number corresponding to the
1904      *   specified Intent, or null if the Intent is not
1905      *   a ACTION_CALL intent or if the intent's data is
1906      *   malformed or missing.
1907      *
1908      * @throws VoiceMailNumberMissingException if the intent
1909      *   contains a "voicemail" URI, but there's no voicemail
1910      *   number configured on the device.
1911      */
1912     private String getInitialNumber(Intent intent)
1913             throws PhoneUtils.VoiceMailNumberMissingException {
1914         String action = intent.getAction();
1915
1916         if (action == null) {
1917             return null;
1918         }
1919
1920         if (action != null && action.equals(Intent.ACTION_CALL) &&
1921                 intent.hasExtra(Intent.EXTRA_PHONE_NUMBER)) {
1922             return intent.getStringExtra(Intent.EXTRA_PHONE_NUMBER);
1923         }
1924
1925         return PhoneUtils.getNumberFromIntent(this, mPhone, intent);
1926     }
1927
1928     /**
1929      * Make a call to whomever the intent tells us to.
1930      *
1931      * @param intent the Intent we were launched with
1932      * @return InCallInitStatus.SUCCESS if we successfully initiated an
1933      *    outgoing call.  If there was some kind of failure, return one of
1934      *    the other InCallInitStatus codes indicating what went wrong.
1935      */
1936     private InCallInitStatus placeCall(Intent intent) {
1937         if (VDBG) log("placeCall()...  intent = " + intent);
1938
1939         String number;
1940
1941         // Check the current ServiceState to make sure it's OK
1942         // to even try making a call.
1943         InCallInitStatus okToCallStatus = checkIfOkToInitiateOutgoingCall();
1944
1945         try {
1946             number = getInitialNumber(intent);
1947         } catch (PhoneUtils.VoiceMailNumberMissingException ex) {
1948             // If the call status is NOT in an acceptable state, it
1949             // may effect the way the voicemail number is being
1950             // retrieved.  Mask the VoiceMailNumberMissingException
1951             // with the underlying issue of the phone state.
1952             if (okToCallStatus != InCallInitStatus.SUCCESS) {
1953                 if (DBG) log("Voicemail number not reachable in current SIM card state.");
1954                 return okToCallStatus;
1955             }
1956             if (DBG) log("VoiceMailNumberMissingException from getInitialNumber()");
1957             return InCallInitStatus.VOICEMAIL_NUMBER_MISSING;
1958         }
1959
1960         if (number == null) {
1961             Log.w(LOG_TAG, "placeCall: couldn't get a phone number from Intent " + intent);
1962             return InCallInitStatus.NO_PHONE_NUMBER_SUPPLIED;
1963         }
1964
1965         boolean isEmergencyNumber = PhoneNumberUtils.isEmergencyNumber(number);
1966         boolean isEmergencyIntent = Intent.ACTION_CALL_EMERGENCY.equals(intent.getAction());
1967
1968         if (isEmergencyNumber && !isEmergencyIntent) {
1969             Log.e(LOG_TAG, "Non-CALL_EMERGENCY Intent " + intent
1970                     + " attempted to call emergency number " + number
1971                     + ".");
1972             return InCallInitStatus.CALL_FAILED;
1973         } else if (!isEmergencyNumber && isEmergencyIntent) {
1974             Log.e(LOG_TAG, "Received CALL_EMERGENCY Intent " + intent
1975                     + " with non-emergency number " + number
1976                     + " -- failing call.");
1977             return InCallInitStatus.CALL_FAILED;
1978         }
1979
1980         // need to make sure that the state is adjusted if we are ONLY
1981         // allowed to dial emergency numbers AND we encounter an
1982         // emergency number request.
1983         if (isEmergencyNumber && okToCallStatus == InCallInitStatus.EMERGENCY_ONLY) {
1984             okToCallStatus = InCallInitStatus.SUCCESS;
1985             if (DBG) log("Emergency number detected, changing state to: " + okToCallStatus);
1986         }
1987
1988         if (okToCallStatus != InCallInitStatus.SUCCESS) {
1989             // If this is an emergency call, we call the emergency call
1990             // handler activity to turn on the radio and do whatever else
1991             // is needed. For now, we finish the InCallScreen (since were
1992             // expecting a callback when the emergency call handler dictates
1993             // it) and just return the success state.
1994             if (isEmergencyNumber && (okToCallStatus == InCallInitStatus.POWER_OFF)) {
1995                 startActivity(intent.setClassName(this, EmergencyCallHandler.class.getName()));
1996                 if (DBG) log("placeCall: starting EmergencyCallHandler, finishing...");
1997                 finish();
1998                 return InCallInitStatus.SUCCESS;
1999             } else {
2000                 return okToCallStatus;
2001             }
2002         }
2003
2004         // We have a valid number, so try to actually place a call:
2005         //make sure we pass along the URI as a reference to the contact.
2006         int callStatus = PhoneUtils.placeCall(mPhone, number, intent.getData());
2007         switch (callStatus) {
2008             case PhoneUtils.CALL_STATUS_DIALED:
2009                 if (VDBG) log("placeCall: PhoneUtils.placeCall() succeeded for regular call '"
2010                              + number + "'.");
2011
2012                 // Any time we initiate a call, force the DTMF dialpad to
2013                 // close.  (We want to make sure the user can see the regular
2014                 // in-call UI while the new call is dialing, and when it
2015                 // first gets connected.)
2016                 mDialer.closeDialer(false);  // no "closing" animation
2017
2018                 // Also, in case a previous call was already active (i.e. if
2019                 // we just did "Add call"), clear out the "history" of DTMF
2020                 // digits you typed, to make sure it doesn't persist from the
2021                 // previous call to the new call.
2022                 // TODO: it would be more precise to do this when the actual
2023                 // phone state change happens (i.e. when a new foreground
2024                 // call appears and the previous call moves to the
2025                 // background), but the InCallScreen doesn't keep enough
2026                 // state right now to notice that specific transition in
2027                 // onPhoneStateChanged().
2028                 mDialer.clearDigits();
2029
2030                 return InCallInitStatus.SUCCESS;
2031             case PhoneUtils.CALL_STATUS_DIALED_MMI:
2032                 if (DBG) log("placeCall: specified number was an MMI code: '" + number + "'.");
2033                 // The passed-in number was an MMI code, not a regular phone number!
2034                 // This isn't really a failure; the Dialer may have deliberately
2035                 // fired a ACTION_CALL intent to dial an MMI code, like for a
2036                 // USSD call.
2037                 //
2038                 // Presumably an MMI_INITIATE message will come in shortly
2039                 // (and we'll bring up the "MMI Started" dialog), or else
2040                 // an MMI_COMPLETE will come in (which will take us to a
2041                 // different Activity; see PhoneUtils.displayMMIComplete()).
2042                 return InCallInitStatus.DIALED_MMI;
2043             case PhoneUtils.CALL_STATUS_FAILED:
2044                 Log.w(LOG_TAG, "placeCall: PhoneUtils.placeCall() FAILED for number '"
2045                       + number + "'.");
2046                 // We couldn't successfully place the call; there was some
2047                 // failure in the telephony layer.
2048                 return InCallInitStatus.CALL_FAILED;
2049             default:
2050                 Log.w(LOG_TAG, "placeCall: unknown callStatus " + callStatus
2051                       + " from PhoneUtils.placeCall() for number '" + number + "'.");
2052                 return InCallInitStatus.SUCCESS;  // Try to continue anyway...
2053         }
2054     }
2055
2056     /**
2057      * Checks the current ServiceState to make sure it's OK
2058      * to try making an outgoing call to the specified number.
2059      *
2060      * @return InCallInitStatus.SUCCESS if it's OK to try calling the specified
2061      *    number.  If not, like if the radio is powered off or we have no
2062      *    signal, return one of the other InCallInitStatus codes indicating what
2063      *    the problem is.
2064      */
2065     private InCallInitStatus checkIfOkToInitiateOutgoingCall() {
2066         // Watch out: do NOT use PhoneStateIntentReceiver.getServiceState() here;
2067         // that's not guaranteed to be fresh.  To synchronously get the
2068         // CURRENT service state, ask the Phone object directly:
2069         int state = mPhone.getServiceState().getState();
2070         if (VDBG) log("checkIfOkToInitiateOutgoingCall: ServiceState = " + state);
2071
2072         switch (state) {
2073             case ServiceState.STATE_IN_SERVICE:
2074                 // Normal operation.  It's OK to make outgoing calls.
2075                 return InCallInitStatus.SUCCESS;
2076
2077
2078             case ServiceState.STATE_POWER_OFF:
2079                 // Radio is explictly powered off.
2080                 return InCallInitStatus.POWER_OFF;
2081
2082             case ServiceState.STATE_OUT_OF_SERVICE:
2083             case ServiceState.STATE_EMERGENCY_ONLY:
2084                 // The phone is registered, but locked. Only emergency
2085                 // numbers are allowed.
2086                 return InCallInitStatus.EMERGENCY_ONLY;
2087             default:
2088                 throw new IllegalStateException("Unexpected ServiceState: " + state);
2089         }
2090     }
2091
2092     private void handleMissingVoiceMailNumber() {
2093         if (DBG) log("handleMissingVoiceMailNumber");
2094
2095         final Message msg = Message.obtain(mHandler);
2096         msg.what = DONT_ADD_VOICEMAIL_NUMBER;
2097
2098         final Message msg2 = Message.obtain(mHandler);
2099         msg2.what = ADD_VOICEMAIL_NUMBER;
2100
2101         mMissingVoicemailDialog = new AlertDialog.Builder(this)
2102                 .setTitle(R.string.no_vm_number)
2103                 .setMessage(R.string.no_vm_number_msg)
2104                 .setPositiveButton(R.string.ok, new DialogInterface.OnClickListener() {
2105                         public void onClick(DialogInterface dialog, int which) {
2106                             if (VDBG) log("Missing voicemail AlertDialog: POSITIVE click...");
2107                             msg.sendToTarget();  // see dontAddVoiceMailNumber()
2108                             PhoneApp.getInstance().pokeUserActivity();
2109                         }})
2110                 .setNegativeButton(R.string.add_vm_number_str,
2111                                    new DialogInterface.OnClickListener() {
2112                         public void onClick(DialogInterface dialog, int which) {
2113                             if (VDBG) log("Missing voicemail AlertDialog: NEGATIVE click...");
2114                             msg2.sendToTarget();  // see addVoiceMailNumber()
2115                             PhoneApp.getInstance().pokeUserActivity();
2116                         }})
2117                 .setOnCancelListener(new OnCancelListener() {
2118                         public void onCancel(DialogInterface dialog) {
2119                             if (VDBG) log("Missing voicemail AlertDialog: CANCEL handler...");
2120                             msg.sendToTarget();  // see dontAddVoiceMailNumber()
2121                             PhoneApp.getInstance().pokeUserActivity();
2122                         }})
2123                 .create();
2124
2125         // When the dialog is up, completely hide the in-call UI
2126         // underneath (which is in a partially-constructed state).
2127         mMissingVoicemailDialog.getWindow().addFlags(
2128                 WindowManager.LayoutParams.FLAG_DIM_BEHIND);
2129
2130         mMissingVoicemailDialog.show();
2131     }
2132
2133     private void addVoiceMailNumberPanel() {
2134         if (mMissingVoicemailDialog != null) {
2135             mMissingVoicemailDialog.dismiss();
2136             mMissingVoicemailDialog = null;
2137         }
2138         finish();
2139
2140         if (DBG) log("show vm setting");
2141
2142         // navigate to the Voicemail setting in the Call Settings activity.
2143         Intent intent = new Intent(CallFeaturesSetting.ACTION_ADD_VOICEMAIL);
2144         intent.setClass(this, CallFeaturesSetting.class);
2145         startActivity(intent);
2146     }
2147
2148     private void dontAddVoiceMailNumber() {
2149         if (mMissingVoicemailDialog != null) {
2150             mMissingVoicemailDialog.dismiss();
2151             mMissingVoicemailDialog = null;
2152         }
2153         if (DBG) log("dontAddVoiceMailNumber: finishing...");
2154         finish();
2155     }
2156
2157     /**
2158      * Do some delayed cleanup after a Phone call gets disconnected.
2159      *
2160      * This method gets called a couple of seconds after any DISCONNECT
2161      * event from the Phone; it's triggered by the
2162      * DELAYED_CLEANUP_AFTER_DISCONNECT message we send in onDisconnect().
2163      *
2164      * If the Phone is totally idle right now, that means we've already
2165      * shown the "call ended" state for a couple of seconds, and it's now
2166      * time to finish() this activity.
2167      *
2168      * If the Phone is *not* idle right now, that probably means that one
2169      * call ended but the other line is still in use.  In that case, we
2170      * *don't* exit the in-call screen, but we at least turn off the
2171      * backlight (which we turned on in onDisconnect().)
2172      */
2173     private void delayedCleanupAfterDisconnect() {
2174         if (VDBG) log("delayedCleanupAfterDisconnect()...  Phone state = " + mPhone.getState());
2175
2176         // Clean up any connections in the DISCONNECTED state.
2177         //
2178         // [Background: Even after a connection gets disconnected, its
2179         // Connection object still stays around, in the special
2180         // DISCONNECTED state.  This is necessary because we we need the
2181         // caller-id information from that Connection to properly draw the
2182         // "Call ended" state of the CallCard.
2183         //   But at this point we truly don't need that connection any
2184         // more, so tell the Phone that it's now OK to to clean up any
2185         // connections still in that state.]
2186         mPhone.clearDisconnected();
2187
2188         if (!phoneIsInUse()) {
2189             // Phone is idle!  We should exit this screen now.
2190             if (DBG) log("- delayedCleanupAfterDisconnect: phone is idle...");
2191
2192             // No need to re-enable keyguard or screen wake state here;
2193             // that happens in onPause() when we actually exit.
2194
2195             // And (finally!) exit from the in-call screen
2196             // (but not if we're already in the process of pausing...)
2197             if (mIsForegroundActivity) {
2198                 if (DBG) log("- delayedCleanupAfterDisconnect: finishing...");
2199
2200                 // If this is a call that was initiated by the user, and
2201                 // we're *not* in emergency mode, finish the call by
2202                 // taking the user to the Call Log.
2203                 // Otherwise we simply call finish(), which will take us
2204                 // back to wherever we came from.
2205                 if (mShowCallLogAfterDisconnect && !isPhoneStateRestricted()) {
2206                     if (VDBG) log("- Show Call Log after disconnect...");
2207                     final Intent intent = PhoneApp.createCallLogIntent();
2208                     startActivity(intent);
2209                     // Even in this case we still call finish() (below),
2210                     // to make sure we don't stay in the activity history.
2211                 }
2212
2213                 finish();
2214             }
2215         } else {
2216             // The phone is still in use.  Stay here in this activity, but
2217             // we don't need to keep the screen on.
2218             if (DBG) log("- delayedCleanupAfterDisconnect: staying on the InCallScreen...");
2219             if (DBG) PhoneUtils.dumpCallState(mPhone);
2220             // No need to re-enable keyguard or screen wake state here;
2221             // should be taken care of in onPhoneStateChanged();
2222         }
2223     }
2224
2225
2226     //
2227     // Callbacks for buttons / menu items.
2228     //
2229
2230     public void onClick(View view) {
2231         int id = view.getId();
2232         if (VDBG) log("onClick(View " + view + ", id " + id + ")...");
2233         if (VDBG && view instanceof InCallMenuItemView) {
2234             InCallMenuItemView item = (InCallMenuItemView) view;
2235             log("  ==> menu item! " + item);
2236         }
2237
2238         // Most menu items dismiss the menu immediately once you click
2239         // them.  But some items (the "toggle" buttons) are different:
2240         // they want the menu to stay visible for a second afterwards to
2241         // give you feedback about the state change.
2242         boolean dismissMenuImmediate = true;
2243         Context context = getApplicationContext();
2244
2245         switch (id) {
2246             case R.id.menuAnswerAndHold:
2247                 if (VDBG) log("onClick: AnswerAndHold...");
2248                 internalAnswerCall();  // Automatically holds the current active call
2249                 break;
2250
2251             case R.id.menuAnswerAndEnd:
2252                 if (VDBG) log("onClick: AnswerAndEnd...");
2253                 internalAnswerAndEnd();
2254                 break;
2255
2256             case R.id.menuSwapCalls:
2257                 if (VDBG) log("onClick: SwapCalls...");
2258                 internalSwapCalls();
2259                 break;
2260
2261             case R.id.menuMergeCalls:
2262                 if (VDBG) log("onClick: MergeCalls...");
2263                 PhoneUtils.mergeCalls(mPhone);
2264                 break;
2265
2266             case R.id.menuManageConference:
2267                 if (VDBG) log("onClick: ManageConference...");
2268                 // Show the Manage Conference panel.
2269                 setInCallScreenMode(InCallScreenMode.MANAGE_CONFERENCE);
2270                 break;
2271
2272             case R.id.menuShowDialpad:
2273                 if (VDBG) log("onClick: Show/hide dialpad...");
2274                 if (mDialer.isOpened()) {
2275                     mDialer.closeDialer(true);  // do the "closing" animation
2276                 } else {
2277                     mDialer.openDialer(true);  // do the "opening" animation
2278                 }
2279                 break;
2280
2281             case R.id.manage_done:  // mButtonManageConferenceDone
2282                 if (VDBG) log("onClick: mButtonManageConferenceDone...");
2283                 // Hide the Manage Conference panel, return to NORMAL mode.
2284                 setInCallScreenMode(InCallScreenMode.NORMAL);
2285                 break;
2286
2287             case R.id.menuSpeaker:
2288                 if (VDBG) log("onClick: Speaker...");
2289                 // TODO: Turning on the speaker seems to enable the mic
2290                 //   whether or not the "mute" feature is active!
2291                 // Not sure if this is an feature of the telephony API
2292                 //   that I need to handle specially, or just a bug.
2293                 boolean newSpeakerState = !PhoneUtils.isSpeakerOn(context);
2294                 if (newSpeakerState && isBluetoothAvailable() && isBluetoothAudioConnected()) {
2295                     disconnectBluetoothAudio();
2296                 }
2297                 PhoneUtils.turnOnSpeaker(context, newSpeakerState);
2298
2299                 if (newSpeakerState) {
2300                     // The "touch lock" overlay is NEVER used when the speaker is on.
2301                     enableTouchLock(false);
2302                 } else {
2303                     // User just turned the speaker *off*.  If the dialpad
2304                     // is open, we need to start the timer that will
2305                     // eventually bring up the "touch lock" overlay.
2306                     if (mDialer.isOpened() && !isTouchLocked()) {
2307                         resetTouchLockTimer();
2308                     }
2309                 }
2310
2311                 // This is a "toggle" button; let the user see the new state for a moment.
2312                 dismissMenuImmediate = false;
2313                 break;
2314
2315             case R.id.menuBluetooth:
2316                 if (VDBG) log("onClick: Bluetooth...");
2317                 onBluetoothClick(context);
2318                 // This is a "toggle" button; let the user see the new state for a moment.
2319                 dismissMenuImmediate = false;
2320                 break;
2321
2322             case R.id.menuMute:
2323                 if (VDBG) log("onClick: Mute...");
2324                 boolean newMuteState = !PhoneUtils.getMute(mPhone);
2325                 PhoneUtils.setMute(mPhone, newMuteState);
2326                 // This is a "toggle" button; let the user see the new state for a moment.
2327                 dismissMenuImmediate = false;
2328                 break;
2329
2330             case R.id.menuHold:
2331                 if (VDBG) log("onClick: Hold...");
2332                 onHoldClick();
2333                 // This is a "toggle" button; let the user see the new state for a moment.
2334                 dismissMenuImmediate = false;
2335                 break;
2336
2337             case R.id.menuAddCall:
2338                 if (VDBG) log("onClick: AddCall...");
2339                 PhoneUtils.startNewCall(mPhone);  // Fires off a ACTION_DIAL intent
2340                 break;
2341
2342             case R.id.menuEndCall:
2343                 if (VDBG) log("onClick: EndCall...");
2344                 PhoneUtils.hangup(mPhone);
2345                 break;
2346
2347             default:
2348                 Log.w(LOG_TAG,
2349                       "Got click from unexpected View ID " + id + " (View = " + view + ")");
2350                 break;
2351         }
2352
2353         if (ENABLE_PHONE_UI_EVENT_LOGGING) {
2354             // TODO: For now we care only about whether the user uses the
2355             // in-call buttons at all.  But in the future we may want to
2356             // log exactly which buttons are being clicked.  (Maybe just
2357             // call view.getText() here, and append that to the event value?)
2358             Checkin.logEvent(getContentResolver(),
2359                              Checkin.Events.Tag.PHONE_UI,
2360                              PHONE_UI_EVENT_BUTTON_CLICK);
2361         }
2362
2363         // If the user just clicked a "stateful" menu item (i.e. one of
2364         // the toggle buttons), we keep the menu onscreen briefly to
2365         // provide visual feedback.  Since we want the user to see the
2366         // *new* current state, force the menu items to update right now.
2367         //
2368         // Note that some toggle buttons ("Hold" in particular) do NOT
2369         // immediately change the state of the Phone.  In that case, the
2370         // updateItems() call below won't have any visible effect.
2371         // Instead, the menu will get updated by the updateScreen() call
2372         // that happens from onPhoneStateChanged().
2373
2374         if (!dismissMenuImmediate) {
2375             // TODO: mInCallMenu.updateItems() is a very big hammer; it
2376             // would be more efficient to update *only* the menu item(s)
2377             // we just changed.  (Doing it this way doesn't seem to cause
2378             // a noticeable performance problem, though.)
2379             if (VDBG) log("- onClick: updating menu to show 'new' current state...");
2380             boolean okToShowMenu = mInCallMenu.updateItems(mPhone);
2381             if (!okToShowMenu) {
2382                 // Uh oh.  All we tried to do was update the state of the
2383                 // menu items, but the logic in InCallMenu.updateItems()
2384                 // just decided the menu shouldn't be visible at all!
2385                 // (That probably means that the call ended asynchronously
2386                 // while the menu was up.)
2387                 //
2388                 // That's OK; just make sure to take the menu down ASAP.
2389                 if (VDBG) log("onClick: Tried to update menu, but now need to take it down!");
2390                 dismissMenuImmediate = true;
2391             }
2392         }
2393
2394         // Any menu item counts as explicit "user activity".
2395         PhoneApp.getInstance().pokeUserActivity();
2396
2397         // Finally, *any* action handled here closes the menu (either
2398         // immediately, or after a short delay).
2399         //
2400         // Note that some of the clicks we handle here aren't even menu
2401         // items in the first place, like the mButtonManageConferenceDone
2402         // button.  That's OK; if the menu is already closed, the
2403         // dismissMenu() call does nothing.
2404         dismissMenu(dismissMenuImmediate);
2405     }
2406
2407     private void onHoldClick() {
2408         if (VDBG) log("onHoldClick()...");
2409
2410         final boolean hasActiveCall = !mForegroundCall.isIdle();
2411         final boolean hasHoldingCall = !mBackgroundCall.isIdle();
2412         if (VDBG) log("- hasActiveCall = " + hasActiveCall
2413                       + ", hasHoldingCall = " + hasHoldingCall);
2414         boolean newHoldState;
2415         boolean holdButtonEnabled;
2416         if (hasActiveCall && !hasHoldingCall) {
2417             // There's only one line in use, and that line is active.
2418             PhoneUtils.switchHoldingAndActive(mPhone);  // Really means "hold" in this state
2419             newHoldState = true;
2420             holdButtonEnabled = true;
2421         } else if (!hasActiveCall && hasHoldingCall) {
2422             // There's only one line in use, and that line is on hold.
2423             PhoneUtils.switchHoldingAndActive(mPhone);  // Really means "unhold" in this state
2424             newHoldState = false;
2425             holdButtonEnabled = true;
2426         } else {
2427             // Either zero or 2 lines are in use; "hold/unhold" is meaningless.
2428             newHoldState = false;
2429             holdButtonEnabled = false;
2430         }
2431         // TODO: we *could* now forcibly update the "Hold" button based on
2432         // "newHoldState" and "holdButtonEnabled".  But for now, do
2433         // nothing here, and instead let the menu get updated when the
2434         // onPhoneStateChanged() callback comes in.  (This seems to be
2435         // responsive enough.)
2436     }
2437
2438     private void onBluetoothClick(Context context) {
2439         if (VDBG) log("onBluetoothClick()...");
2440
2441         if (isBluetoothAvailable()) {
2442             // Toggle the bluetooth audio connection state:
2443             if (isBluetoothAudioConnected()) {
2444                 disconnectBluetoothAudio();
2445             } else {
2446                 // Manually turn the speaker phone off, instead of allowing the
2447                 // Bluetooth audio routing handle it.  This ensures that the rest
2448                 // of the speakerphone code is executed, and reciprocates the
2449                 // menuSpeaker code above in onClick().  The onClick() code
2450                 // disconnects the active bluetooth headsets when the
2451                 // speakerphone is turned on.
2452                 if (PhoneUtils.isSpeakerOn(context)) {
2453                     PhoneUtils.turnOnSpeaker(context, false);
2454                 }
2455
2456                 connectBluetoothAudio();
2457             }
2458         } else {
2459             // Bluetooth isn't available; the "Audio" button shouldn't have
2460             // been enabled in the first place!
2461             Log.w(LOG_TAG, "Got onBluetoothClick, but bluetooth is unavailable");
2462         }
2463     }
2464
2465     /**
2466      * Updates the "Press Menu for more options" hint based on the current
2467      * state of the Phone.
2468      */
2469     private void updateMenuButtonHint() {
2470         if (VDBG) log("updateMenuButtonHint()...");
2471         boolean hintVisible = true;
2472
2473         final boolean hasRingingCall = !mRingingCall.isIdle();
2474         final boolean hasActiveCall = !mForegroundCall.isIdle();
2475         final boolean hasHoldingCall = !mBackgroundCall.isIdle();
2476
2477         // The hint is hidden only when there's no menu at all,
2478         // which only happens in a few specific cases:
2479         if (mInCallScreenMode == InCallScreenMode.CALL_ENDED) {
2480             // The "Call ended" state.
2481             hintVisible = false;
2482         } else if (hasRingingCall && !(hasActiveCall && !hasHoldingCall)) {
2483             // An incoming call where you *don't* have the option to
2484             // "answer & end" or "answer & hold".
2485             hintVisible = false;
2486         } else if (!phoneIsInUse()) {
2487             // Or if the phone is totally idle (like if an error dialog
2488             // is up, or an MMI is running.)
2489             hintVisible = false;
2490         }
2491         int hintVisibility = (hintVisible) ? View.VISIBLE : View.GONE;
2492
2493         // We actually have two separate "menu button hint" TextViews; one
2494         // used only in portrait mode (part of the CallCard) and one used
2495         // only in landscape mode (part of the InCallScreen.)
2496         TextView callCardMenuButtonHint = mCallCard.getMenuButtonHint();
2497         if (ConfigurationHelper.isLandscape()) {
2498             callCardMenuButtonHint.setVisibility(View.GONE);
2499             mMenuButtonHint.setVisibility(hintVisibility);
2500         } else {
2501             callCardMenuButtonHint.setVisibility(hintVisibility);
2502             mMenuButtonHint.setVisibility(View.GONE);
2503         }
2504
2505         // TODO: Consider hiding the hint(s) whenever the menu is onscreen!
2506         // (Currently, the menu is rendered on top of the hint, but the
2507         // menu is semitransparent so you can still see the hint
2508         // underneath, and the hint is *just* visible enough to be
2509         // distracting.)
2510     }
2511
2512     /**
2513      * Brings up UI to handle the various error conditions that
2514      * can occur when first initializing the in-call UI.
2515      * This is called from onResume() if we encountered
2516      * an error while processing our initial Intent.
2517      *
2518      * @param status one of the InCallInitStatus error codes.
2519      */
2520     private void handleStartupError(InCallInitStatus status) {
2521         if (DBG) log("handleStartupError(): status = " + status);
2522
2523         // NOTE that the regular Phone UI is in an uninitialized state at
2524         // this point, so we don't ever want the user to see it.
2525         // That means:
2526         // - Any cases here that need to go to some other activity should
2527         //   call startActivity() AND immediately call finish() on this one.
2528         // - Any cases here that bring up a Dialog must ensure that the
2529         //   Dialog handles both OK *and* cancel by calling finish() on this
2530         //   Activity.  (See showGenericErrorDialog() for an example.)
2531
2532         switch(status) {
2533
2534             case VOICEMAIL_NUMBER_MISSING:
2535                 // Bring up the "Missing Voicemail Number" dialog, which
2536                 // will ultimately take us to some other Activity (or else
2537                 // just bail out of this activity.)
2538                 handleMissingVoiceMailNumber();
2539                 break;
2540
2541             case POWER_OFF:
2542                 // Radio is explictly powered off.
2543
2544                 // TODO: This UI is ultra-simple for 1.0.  It would be nicer
2545                 // to bring up a Dialog instead with the option "turn on radio
2546                 // now".  If selected, we'd turn the radio on, wait for
2547                 // network registration to complete, and then make the call.
2548
2549                 showGenericErrorDialog(R.string.incall_error_power_off, true);
2550                 break;
2551
2552             case EMERGENCY_ONLY:
2553                 // Only emergency numbers are allowed, but we tried to dial
2554                 // a non-emergency number.
2555                 showGenericErrorDialog(R.string.incall_error_emergency_only, true);
2556                 break;
2557
2558             case PHONE_NOT_IN_USE:
2559                 // This error is handled directly in onResume() (by bailing
2560                 // out of the activity.)  We should never see it here.
2561                 Log.w(LOG_TAG,
2562                       "handleStartupError: unexpected PHONE_NOT_IN_USE status");
2563                 break;
2564
2565             case NO_PHONE_NUMBER_SUPPLIED:
2566                 // The supplied Intent didn't contain a valid phone number.
2567                 // TODO: Need UI spec for this failure case; for now just
2568                 // show a generic error.
2569                 showGenericErrorDialog(R.string.incall_error_no_phone_number_supplied, true);
2570                 break;
2571
2572             case DIALED_MMI:
2573                 // Our initial phone number was actually an MMI sequence.
2574                 // There's no real "error" here, but we do bring up the
2575                 // a Toast (as requested of the New UI paradigm).
2576                 //
2577                 // In-call MMIs do not trigger the normal MMI Initiate
2578                 // Notifications, so we should notify the user here.
2579                 // Otherwise, the code in PhoneUtils.java should handle
2580                 // user notifications in the form of Toasts or Dialogs.
2581                 if (mPhone.getState() == Phone.State.OFFHOOK) {
2582                     Toast.makeText(this, R.string.incall_status_dialed_mmi, Toast.LENGTH_SHORT)
2583                         .show();
2584                 }
2585                 break;
2586
2587             case CALL_FAILED:
2588                 // We couldn't successfully place the call; there was some
2589                 // failure in the telephony layer.
2590                 // TODO: Need UI spec for this failure case; for now just
2591                 // show a generic error.
2592                 showGenericErrorDialog(R.string.incall_error_call_failed, true);
2593                 break;
2594
2595             default:
2596                 Log.w(LOG_TAG, "handleStartupError: unexpected status code " + status);
2597                 showGenericErrorDialog(R.string.incall_error_call_failed, true);
2598                 break;
2599         }
2600     }
2601
2602     /**
2603      * Utility function to bring up a generic "error" dialog, and then bail
2604      * out of the in-call UI when the user hits OK (or the BACK button.)
2605      */
2606     private void showGenericErrorDialog(int resid, boolean isStartupError) {
2607         CharSequence msg = getResources().getText(resid);
2608         if (DBG) log("showGenericErrorDialog('" + msg + "')...");
2609
2610         // create the clicklistener and cancel listener as needed.
2611         DialogInterface.OnClickListener clickListener;
2612         OnCancelListener cancelListener;
2613         if (isStartupError) {
2614             clickListener = new DialogInterface.OnClickListener() {
2615                 public void onClick(DialogInterface dialog, int which) {
2616                     bailOutAfterErrorDialog();
2617                 }};
2618             cancelListener = new OnCancelListener() {
2619                 public void onCancel(DialogInterface dialog) {
2620                     bailOutAfterErrorDialog();
2621                 }};
2622         } else {
2623             clickListener = new DialogInterface.OnClickListener() {
2624                 public void onClick(DialogInterface dialog, int which) {
2625                     delayedCleanupAfterDisconnect();
2626                 }};
2627             cancelListener = new OnCancelListener() {
2628                 public void onCancel(DialogInterface dialog) {
2629                     delayedCleanupAfterDisconnect();
2630                 }};
2631         }
2632
2633         // TODO: Consider adding a setTitle() call here (with some generic
2634         // "failure" title?)
2635         mGenericErrorDialog = new AlertDialog.Builder(this)
2636                 .setMessage(msg)
2637                 .setPositiveButton(R.string.ok, clickListener)
2638                 .setOnCancelListener(cancelListener)
2639                 .create();
2640
2641         // When the dialog is up, completely hide the in-call UI
2642         // underneath (which is in a partially-constructed state).
2643         mGenericErrorDialog.getWindow().addFlags(
2644                 WindowManager.LayoutParams.FLAG_DIM_BEHIND);
2645
2646         mGenericErrorDialog.show();
2647     }
2648
2649     private void bailOutAfterErrorDialog() {
2650         if (mGenericErrorDialog != null) {
2651             if (VDBG) log("bailOutAfterErrorDialog: DISMISSING mGenericErrorDialog.");
2652             mGenericErrorDialog.dismiss();
2653             mGenericErrorDialog = null;
2654         }
2655         if (DBG) log("bailOutAfterErrorDialog(): finishing...");
2656         finish();
2657     }
2658
2659     /**
2660      * Dismisses (and nulls out) all persistent Dialogs managed
2661      * by the InCallScreen.  Useful if (a) we're about to bring up
2662      * a dialog and want to pre-empt any currently visible dialogs,
2663      * or (b) as a cleanup step when the Activity is going away.
2664      */
2665     private void dismissAllDialogs() {
2666         if (VDBG) log("dismissAllDialogs()...");
2667
2668         // Note it's safe to dismiss() a dialog that's already dismissed.
2669         // (Even if the AlertDialog object(s) below are still around, it's
2670         // possible that the actual dialog(s) may have already been
2671         // dismissed by the user.)
2672
2673         if (mMissingVoicemailDialog != null) {
2674             if (VDBG) log("- DISMISSING mMissingVoicemailDialog.");
2675             mMissingVoicemailDialog.dismiss();
2676             mMissingVoicemailDialog = null;
2677         }
2678         if (mMmiStartedDialog != null) {
2679             if (VDBG) log("- DISMISSING mMmiStartedDialog.");
2680             mMmiStartedDialog.dismiss();
2681             mMmiStartedDialog = null;
2682         }
2683         if (mGenericErrorDialog != null) {
2684             if (VDBG) log("- DISMISSING mGenericErrorDialog.");
2685             mGenericErrorDialog.dismiss();
2686             mGenericErrorDialog = null;
2687         }
2688         if (mSuppServiceFailureDialog != null) {
2689             if (VDBG) log("- DISMISSING mSuppServiceFailureDialog.");
2690             mSuppServiceFailureDialog.dismiss();
2691             mSuppServiceFailureDialog = null;
2692         }
2693         if (mWaitPromptDialog != null) {
2694             if (VDBG) log("- DISMISSING mWaitPromptDialog.");
2695             mWaitPromptDialog.dismiss();
2696             mWaitPromptDialog = null;
2697         }
2698         if (mWildPromptDialog != null) {
2699             if (VDBG) log("- DISMISSING mWildPromptDialog.");
2700             mWildPromptDialog.dismiss();
2701             mWildPromptDialog = null;
2702         }
2703     }
2704
2705
2706     //
2707     // Helper functions for answering incoming calls.
2708     //
2709
2710     /**
2711      * Answer the ringing call.
2712      */
2713     /* package */ void internalAnswerCall() {
2714         if (DBG) log("internalAnswerCall()...");
2715         // if (DBG) PhoneUtils.dumpCallState(mPhone);
2716         PhoneUtils.answerCall(mPhone);  // Automatically holds the current active call,
2717                                         // if there is one
2718     }
2719
2720     /**
2721      * Answer the ringing call *and* hang up the ongoing call.
2722      */
2723     /* package */ void internalAnswerAndEnd() {
2724         if (DBG) log("internalAnswerAndEnd()...");
2725         // if (DBG) PhoneUtils.dumpCallState(mPhone);
2726         PhoneUtils.answerAndEndActive(mPhone);
2727     }
2728
2729     /**
2730      * Answer the ringing call, in the special case where both lines
2731      * are already in use.
2732      *
2733      * We "answer incoming, end ongoing" in this case, according to the
2734      * current UI spec.
2735      */
2736     /* package */ void internalAnswerCallBothLinesInUse() {
2737         if (DBG) log("internalAnswerCallBothLinesInUse()...");
2738         // if (DBG) PhoneUtils.dumpCallState(mPhone);
2739
2740         PhoneUtils.answerAndEndActive(mPhone);
2741         // Alternatively, we could use
2742         //    PhoneUtils.answerAndEndHolding(mPhone);
2743         // here to end the on-hold call instead.
2744     }
2745
2746     /**
2747      * Hang up the ringing call (aka "Don't answer").
2748      */
2749     /* package */ void internalHangupRingingCall() {
2750         if (DBG) log("internalHangupRingingCall()...");
2751         PhoneUtils.hangupRingingCall(mPhone);
2752     }
2753
2754     /**
2755      * InCallScreen-specific wrapper around PhoneUtils.switchHoldingAndActive().
2756      */
2757     private void internalSwapCalls() {
2758         if (VDBG) log("internalSwapCalls()...");
2759
2760         // Any time we swap calls, force the DTMF dialpad to close.
2761         // (We want the regular in-call UI to be visible right now, so the
2762         // user can clearly see which call is now in the foreground.)
2763         mDialer.closeDialer(true);  // do the "closing" animation
2764
2765         // Also, clear out the "history" of DTMF digits you typed, to make
2766         // sure you don't see digits from call #1 while call #2 is active.
2767         // (Yes, this does mean that swapping calls twice will cause you
2768         // to lose any previous digits from the current call; see the TODO
2769         // comment on DTMFTwelvKeyDialer.clearDigits() for more info.)
2770         mDialer.clearDigits();
2771
2772         // Swap the fg and bg calls.
2773         PhoneUtils.switchHoldingAndActive(mPhone);
2774     }
2775
2776     //
2777     // "Manage conference" UI.
2778     //
2779     // TODO: There's a lot of code here, and this source file is already too large.
2780     // Consider moving all this code out to a separate class.
2781     //
2782
2783     private void initManageConferencePanel() {
2784         if (VDBG) log("initManageConferencePanel()...");
2785         if (mManageConferencePanel == null) {
2786             mManageConferencePanel = (ViewGroup) findViewById(R.id.manageConferencePanel);
2787
2788             // set up the Conference Call chronometer
2789             mConferenceTime = (Chronometer) findViewById(R.id.manageConferencePanelHeader);
2790             mConferenceTime.setFormat(getString(R.string.caller_manage_header));
2791
2792             // Create list of conference call widgets
2793             mConferenceCallList = new ViewGroup[MAX_CALLERS_IN_CONFERENCE];
2794             {
2795                 final int[] viewGroupIdList = {R.id.caller0, R.id.caller1, R.id.caller2,
2796                         R.id.caller3, R.id.caller4};
2797                 for (int i = 0; i < MAX_CALLERS_IN_CONFERENCE; i++) {
2798                     mConferenceCallList[i] = (ViewGroup) findViewById(viewGroupIdList[i]);
2799                 }
2800             }
2801
2802             mButtonManageConferenceDone =
2803                     (Button) findViewById(R.id.manage_done);
2804             mButtonManageConferenceDone.setOnClickListener(this);
2805         }
2806     }
2807
2808     /**
2809      * Sets the current high-level "mode" of the in-call UI.
2810      *
2811      * NOTE: if newMode is CALL_ENDED, the caller is responsible for
2812      * posting a delayed DELAYED_CLEANUP_AFTER_DISCONNECT message, to make
2813      * sure the "call ended" state goes away after a couple of seconds.
2814      */
2815     private void setInCallScreenMode(InCallScreenMode newMode) {
2816         if (VDBG) log("setInCallScreenMode: " + newMode);
2817         mInCallScreenMode = newMode;
2818         switch (mInCallScreenMode) {
2819             case MANAGE_CONFERENCE:
2820                 if (!PhoneUtils.isConferenceCall(mForegroundCall)) {
2821                     Log.w(LOG_TAG, "MANAGE_CONFERENCE: no active conference call!");
2822                     // Hide the Manage Conference panel, return to NORMAL mode.
2823                     setInCallScreenMode(InCallScreenMode.NORMAL);
2824                     return;
2825                 }
2826                 List<Connection> connections = mForegroundCall.getConnections();
2827                 // There almost certainly will be > 1 connection,
2828                 // since isConferenceCall() just returned true.
2829                 if ((connections == null) || (connections.size() <= 1)) {
2830                     Log.w(LOG_TAG,
2831                           "MANAGE_CONFERENCE: Bogus TRUE from isConferenceCall(); connections = "
2832                           + connections);
2833                     // Hide the Manage Conference panel, return to NORMAL mode.
2834                     setInCallScreenMode(InCallScreenMode.NORMAL);
2835                     return;
2836                 }
2837
2838                 initManageConferencePanel();  // if necessary
2839                 updateManageConferencePanel(connections);
2840
2841                 // The "Manage conference" UI takes up the full main frame,
2842                 // replacing the inCallPanel and CallCard PopupWindow.
2843                 mManageConferencePanel.setVisibility(View.VISIBLE);
2844
2845                 // start the chronometer.
2846                 long callDuration = mForegroundCall.getEarliestConnection().getDurationMillis();
2847                 mConferenceTime.setBase(SystemClock.elapsedRealtime() - callDuration);
2848                 mConferenceTime.start();
2849
2850                 mInCallPanel.setVisibility(View.GONE);
2851                 mDialer.hideDTMFDisplay(true);
2852
2853                 break;
2854
2855             case CALL_ENDED:
2856                 // Display the CallCard (in the "Call ended" state)
2857                 // and hide all other UI.
2858
2859                 if (mManageConferencePanel != null) {
2860                     mManageConferencePanel.setVisibility(View.GONE);
2861                     // stop the timer if the panel is hidden.
2862                     mConferenceTime.stop();
2863                 }
2864                 updateMenuButtonHint();  // Hide the Menu button hint
2865
2866                 // Make sure the CallCard (which is a child of mInCallPanel) is visible.
2867                 mInCallPanel.setVisibility(View.VISIBLE);
2868                 mDialer.hideDTMFDisplay(false);
2869
2870                 break;
2871
2872             case NORMAL:
2873                 mInCallPanel.setVisibility(View.VISIBLE);
2874                 mDialer.hideDTMFDisplay(false);
2875                 if (mManageConferencePanel != null) {
2876                     mManageConferencePanel.setVisibility(View.GONE);
2877                     // stop the timer if the panel is hidden.
2878                     mConferenceTime.stop();
2879                 }
2880                 break;
2881         }
2882
2883         // Update the visibility of the DTMF dialer tab on any state
2884         // change.
2885         updateDialpadVisibility();
2886     }
2887
2888     /**
2889      * @return true if the "Manage conference" UI is currently visible.
2890      */
2891     /* package */ boolean isManageConferenceMode() {
2892         return (mInCallScreenMode == InCallScreenMode.MANAGE_CONFERENCE);
2893     }
2894
2895     /**
2896      * Updates the "Manage conference" UI based on the specified List of
2897      * connections.
2898      *
2899      * @param connections the List of connections belonging to
2900      *        the current foreground call; size must be greater than 1
2901      *        (or it wouldn't be a conference call in the first place.)
2902      */
2903     private void updateManageConferencePanel(List<Connection> connections) {
2904         mNumCallersInConference = connections.size();
2905         if (VDBG) log("updateManageConferencePanel()... num connections in conference = "
2906                      + mNumCallersInConference);
2907
2908         // Can we give the user the option to separate out ("go private with") a single
2909         // caller from this conference?
2910         final boolean hasActiveCall = !mForegroundCall.isIdle();
2911         final boolean hasHoldingCall = !mBackgroundCall.isIdle();
2912         boolean canSeparate = !(hasActiveCall && hasHoldingCall);
2913
2914         for (int i = 0; i < MAX_CALLERS_IN_CONFERENCE; i++) {
2915             if (i < mNumCallersInConference) {
2916                 // Fill in the row in the UI for this caller.
2917                 Connection connection = (Connection) connections.get(i);
2918                 updateManageConferenceRow(i, connection, canSeparate);
2919             } else {
2920                 // Blank out this row in the UI
2921                 updateManageConferenceRow(i, null, false);
2922             }
2923         }
2924     }
2925
2926     /**
2927      * Checks if the "Manage conference" UI needs to be updated.
2928      * If the state of the current conference call has changed
2929      * since our previous call to updateManageConferencePanel()),
2930      * do a fresh update.
2931      */
2932     private void updateManageConferencePanelIfNecessary() {
2933         if (VDBG) log("updateManageConferencePanel: mForegroundCall " + mForegroundCall + "...");
2934
2935         List<Connection> connections = mForegroundCall.getConnections();
2936         if (connections == null) {
2937             if (VDBG) log("==> no connections on foreground call!");
2938             // Hide the Manage Conference panel, return to NORMAL mode.
2939             setInCallScreenMode(InCallScreenMode.NORMAL);
2940             InCallInitStatus status = syncWithPhoneState();
2941             if (status != InCallInitStatus.SUCCESS) {
2942                 Log.w(LOG_TAG, "- syncWithPhoneState failed! status = " + status);
2943                 // We shouldn't even be in the in-call UI in the first
2944                 // place, so bail out:
2945                 if (DBG) log("updateManageConferencePanelIfNecessary: finishing...");
2946                 finish();
2947                 return;
2948             }
2949             return;
2950         }
2951
2952         int numConnections = connections.size();
2953         if (numConnections <= 1) {
2954             if (VDBG) log("==> foreground call no longer a conference!");
2955             // Hide the Manage Conference panel, return to NORMAL mode.
2956             setInCallScreenMode(InCallScreenMode.NORMAL);
2957             InCallInitStatus status = syncWithPhoneState();
2958             if (status != InCallInitStatus.SUCCESS) {
2959                 Log.w(LOG_TAG, "- syncWithPhoneState failed! status = " + status);
2960                 // We shouldn't even be in the in-call UI in the first
2961                 // place, so bail out:
2962                 if (DBG) log("updateManageConferencePanelIfNecessary: finishing...");
2963                 finish();
2964                 return;
2965             }
2966             return;
2967         }
2968         if (numConnections != mNumCallersInConference) {
2969             if (VDBG) log("==> Conference size has changed; need to rebuild UI!");
2970             updateManageConferencePanel(connections);
2971             return;
2972         }
2973     }
2974
2975     /**
2976      * Updates a single row of the "Manage conference" UI.  (One row in this
2977      * UI represents a single caller in the conference.)
2978      *
2979      * @param i the row to update
2980      * @param connection the Connection corresponding to this caller.
2981      *        If null, that means this is an "empty slot" in the conference,
2982      *        so hide this row in the UI.
2983      * @param canSeparate if true, show a "Separate" (i.e. "Private") button
2984      *        on this row in the UI.
2985      */
2986     private void updateManageConferenceRow(final int i,
2987                                            final Connection connection,
2988                                            boolean canSeparate) {
2989         if (VDBG) log("updateManageConferenceRow(" + i + ")...  connection = " + connection);
2990
2991         if (connection != null) {
2992             // Activate this row of the Manage conference panel:
2993             mConferenceCallList[i].setVisibility(View.VISIBLE);
2994
2995             // get the relevant children views
2996             ImageButton endButton = (ImageButton) mConferenceCallList[i].findViewById(
2997                     R.id.conferenceCallerDisconnect);
2998             ImageButton separateButton = (ImageButton) mConferenceCallList[i].findViewById(
2999                     R.id.conferenceCallerSeparate);
3000             TextView nameTextView = (TextView) mConferenceCallList[i].findViewById(
3001                     R.id.conferenceCallerName);
3002             TextView numberTextView = (TextView) mConferenceCallList[i].findViewById(
3003                     R.id.conferenceCallerNumber);
3004             TextView numberTypeTextView = (TextView) mConferenceCallList[i].findViewById(
3005                     R.id.conferenceCallerNumberType);
3006
3007             if (VDBG) log("- button: " + endButton + ", nameTextView: " + nameTextView);
3008
3009             // Hook up this row's buttons.
3010             View.OnClickListener endThisConnection = new View.OnClickListener() {
3011                     public void onClick(View v) {
3012                         endConferenceConnection(i, connection);
3013                         PhoneApp.getInstance().pokeUserActivity();
3014                     }
3015                 };
3016             endButton.setOnClickListener(endThisConnection);
3017             //
3018             if (canSeparate) {
3019                 View.OnClickListener separateThisConnection = new View.OnClickListener() {
3020                         public void onClick(View v) {
3021                             separateConferenceConnection(i, connection);
3022                             PhoneApp.getInstance().pokeUserActivity();
3023                         }
3024                     };
3025                 separateButton.setOnClickListener(separateThisConnection);
3026                 separateButton.setVisibility(View.VISIBLE);
3027             } else {
3028                 separateButton.setVisibility(View.INVISIBLE);
3029             }
3030
3031             // Name/number for this caller.
3032             // TODO: need to deal with private or blocked caller id?
3033             PhoneUtils.CallerInfoToken info = PhoneUtils.startGetCallerInfo(this, connection,
3034                     this, mConferenceCallList[i]);
3035
3036             // display the CallerInfo.
3037             displayCallerInfoForConferenceRow (info.currentInfo, nameTextView,
3038                     numberTypeTextView, numberTextView);
3039         } else {
3040             // Disable this row of the Manage conference panel:
3041             mConferenceCallList[i].setVisibility(View.GONE);
3042         }
3043     }
3044
3045     /**
3046      * Implemented for CallerInfoAsyncQuery.OnQueryCompleteListener interface.
3047      * refreshes the nameTextView when called.
3048      */
3049     public void onQueryComplete(int token, Object cookie, CallerInfo ci){
3050         if (VDBG) log("callerinfo query complete, updating UI.");
3051
3052         // get the viewgroup (conference call list item) and make it visible
3053         ViewGroup vg = (ViewGroup) cookie;
3054         vg.setVisibility(View.VISIBLE);
3055
3056         // update the list item with this information.
3057         displayCallerInfoForConferenceRow (ci,
3058                 (TextView) vg.findViewById(R.id.conferenceCallerName),
3059                 (TextView) vg.findViewById(R.id.conferenceCallerNumberType),
3060                 (TextView) vg.findViewById(R.id.conferenceCallerNumber));
3061     }
3062
3063     /**
3064      * Helper function to fill out the Conference Call(er) information
3065      * for each item in the "Manage Conference Call" list.
3066      */
3067     private final void displayCallerInfoForConferenceRow(CallerInfo ci, TextView nameTextView,
3068             TextView numberTypeTextView, TextView numberTextView) {
3069
3070         // gather the correct name and number information.
3071         String callerName = "";
3072         String callerNumber = "";
3073         String callerNumberType = "";
3074         if (ci != null) {
3075             callerName = ci.name;
3076             if (TextUtils.isEmpty(callerName)) {
3077                 callerName = ci.phoneNumber;
3078                 if (TextUtils.isEmpty(callerName)) {
3079                     callerName = getString(R.string.unknown);
3080                 }
3081             } else {
3082                 callerNumber = ci.phoneNumber;
3083                 callerNumberType = ci.phoneLabel;
3084             }
3085         }
3086
3087         // set the caller name
3088         nameTextView.setText(callerName);
3089
3090         // set the caller number in subscript, or make the field disappear.
3091         if (TextUtils.isEmpty(callerNumber)) {
3092             numberTextView.setVisibility(View.GONE);
3093             numberTypeTextView.setVisibility(View.GONE);
3094         } else {
3095             numberTextView.setVisibility(View.VISIBLE);
3096             numberTextView.setText(callerNumber);
3097             numberTypeTextView.setVisibility(View.VISIBLE);
3098             numberTypeTextView.setText(callerNumberType);
3099         }
3100     }
3101
3102     /**
3103      * Ends the specified connection on a conference call.  This method is
3104      * run (via a closure containing a row index and Connection) when the
3105      * user clicks the "End" button on a specific row in the Manage
3106      * conference UI.
3107      */
3108     private void endConferenceConnection(int i, Connection connection) {
3109         if (VDBG) log("===> ENDING conference connection " + i
3110                       + ": Connection " + connection);
3111         // The actual work of ending the connection:
3112         PhoneUtils.hangup(connection);
3113         // No need to manually update the "Manage conference" UI here;
3114         // that'll happen automatically very soon (when we get the
3115         // onDisconnect() callback triggered by this hangup() call.)
3116     }
3117
3118     /**
3119      * Separates out the specified connection on a conference call.  This
3120      * method is run (via a closure containing a row index and Connection)
3121      * when the user clicks the "Separate" (i.e. "Private") button on a
3122      * specific row in the Manage conference UI.
3123      */
3124     private void separateConferenceConnection(int i, Connection connection) {
3125         if (VDBG) log("===> SEPARATING conference connection " + i
3126                       + ": Connection " + connection);
3127
3128         PhoneUtils.separateCall(connection);
3129
3130         // Note that separateCall() automagically makes the
3131         // newly-separated call into the foreground call (which is the
3132         // desired UI), so there's no need to do any further
3133         // call-switching here.
3134         // There's also no need to manually update (or hide) the "Manage
3135         // conference" UI; that'll happen on its own in a moment (when we
3136         // get the phone state change event triggered by the call to
3137         // separateCall().)
3138     }
3139
3140     /**
3141      * Updates the visibility of the DTMF dialpad and the "sliding drawer"
3142      * handle, based on the current state of the phone and/or the current
3143      * InCallScreenMode.
3144      */
3145     private void updateDialpadVisibility() {
3146         //
3147         // (1) The dialpad itself:
3148         //
3149         // If an incoming call is ringing, make sure the dialpad is
3150         // closed.  (We do this to make sure we're not covering up the
3151         // "incoming call" UI, and especially to make sure that the "touch
3152         // lock" overlay won't appear.)
3153         if (mPhone.getState() == Phone.State.RINGING) {
3154             mDialer.closeDialer(false);  // don't do the "closing" animation
3155
3156             // Also, clear out the "history" of DTMF digits you may have typed
3157             // into the previous call (so you don't see the previous call's
3158             // digits if you answer this call and then bring up the dialpad.)
3159             //
3160             // TODO: it would be more precise to do this when you *answer* the
3161             // incoming call, rather than as soon as it starts ringing, but
3162             // the InCallScreen doesn't keep enough state right now to notice
3163             // that specific transition in onPhoneStateChanged().
3164             mDialer.clearDigits();
3165         }
3166
3167         //
3168         // (2) The "sliding drawer" handle:
3169         //
3170         // This handle should be visible only if it's OK to actually open
3171         // the dialpad.
3172         //
3173         if (mDialerDrawer != null) {
3174             int visibility = okToShowDialpad() ? View.VISIBLE : View.GONE;
3175             mDialerDrawer.setVisibility(visibility);
3176         }
3177     }
3178
3179     /**
3180      * @return true if the DTMF dialpad is currently visible.
3181      */
3182     /* package */ boolean isDialerOpened() {
3183         return (mDialer != null && mDialer.isOpened());
3184     }
3185
3186     /**
3187      * Called any time the DTMF dialpad is opened.
3188      * @see DTMFTwelveKeyDialer.onDialerOpen()
3189      */
3190     /* package */ void onDialerOpen() {
3191         if (VDBG) log("onDialerOpen()...");
3192
3193         // ANY time the dialpad becomes visible, start the timer that will
3194         // eventually bring up the "touch lock" overlay.
3195         resetTouchLockTimer();
3196
3197         // This counts as explicit "user activity".
3198         PhoneApp.getInstance().pokeUserActivity();
3199     }
3200
3201     /**
3202      * Called any time the DTMF dialpad is closed.
3203      * @see DTMFTwelveKeyDialer.onDialerClose()
3204      */
3205     /* package */ void onDialerClose() {
3206         if (VDBG) log("onDialerClose()...");
3207
3208         // Dismiss the "touch lock" overlay if it was visible.
3209         // (The overlay is only ever used on top of the dialpad).
3210         enableTouchLock(false);
3211
3212         // This counts as explicit "user activity".
3213         PhoneApp.getInstance().pokeUserActivity();
3214     }
3215
3216     /**
3217      * Get the DTMF dialer display field.
3218      */
3219     /* package */ EditText getDialerDisplay() {
3220         return mDTMFDisplay;
3221     }
3222
3223     /**
3224      * Determines when we can dial DTMF tones.
3225      */
3226     private boolean okToDialDTMFTones() {
3227         final boolean hasRingingCall = !mRingingCall.isIdle();
3228         final Call.State fgCallState = mForegroundCall.getState();
3229
3230         // We're allowed to send DTMF tones when there's an ACTIVE
3231         // foreground call, and not when an incoming call is ringing
3232         // (since DTMF tones are useless in that state), or if the
3233         // Manage Conference UI is visible (since the tab interferes
3234         // with the "Back to call" button.)
3235
3236         // We can also dial while in ALERTING state because there are
3237         // some connections that never update to an ACTIVE state (no
3238         // indication from the network).
3239         boolean canDial =
3240             (fgCallState == Call.State.ACTIVE || fgCallState == Call.State.ALERTING)
3241             && !hasRingingCall
3242             && (mInCallScreenMode != InCallScreenMode.MANAGE_CONFERENCE);
3243
3244         if (VDBG) log ("[okToDialDTMFTones] foreground state: " + fgCallState +
3245                 ", ringing state: " + hasRingingCall +
3246                 ", call screen mode: " + mInCallScreenMode +
3247                 ", result: " + canDial);
3248
3249         return canDial;
3250     }
3251
3252     /**
3253      * @return true if the in-call DTMF dialpad should be available to the
3254      *      user, given the current state of the phone and the in-call UI.
3255      *      (This is used to control the visiblity of the dialer's
3256      *      SlidingDrawer handle, and the enabledness of the "Show
3257      *      dialpad" menu item.)
3258      */
3259     /* package */ boolean okToShowDialpad() {
3260         // The dialpad is never used in landscape mode.  And even in
3261         // portrait mode, it's available only when it's OK to dial DTMF
3262         // tones given the current state of the current call.
3263         return !ConfigurationHelper.isLandscape() && okToDialDTMFTones();
3264     }
3265
3266     /**
3267      * Helper class to manage the (small number of) manual layout and UI
3268      * changes needed by the in-call UI when switching between landscape
3269      * and portrait mode.
3270      *
3271      * TODO: Ideally, all this information should come directly from
3272      * resources, with alternate sets of resources for for different
3273      * configurations (like alternate layouts under res/layout-land
3274      * or res/layout-finger.)
3275      *
3276      * But for now, we don't use any alternate resources.  Instead, the
3277      * resources under res/layout are hardwired for portrait mode, and we
3278      * use this class's applyConfigurationToLayout() method to reach into
3279      * our View hierarchy and manually patch up anything that needs to be
3280      * different for landscape mode.
3281      */
3282     /* package */ static class ConfigurationHelper {
3283         /** This class is never instantiated. */
3284         private ConfigurationHelper() {
3285         }
3286
3287         // "Configuration constants" set by initConfiguration()
3288         static int sOrientation = Configuration.ORIENTATION_UNDEFINED;
3289
3290         static boolean isLandscape() {
3291             return sOrientation == Configuration.ORIENTATION_LANDSCAPE;
3292         }
3293
3294         /**
3295          * Initializes the "Configuration constants" based on the
3296          * specified configuration.
3297          */
3298         static void initConfiguration(Configuration config) {
3299             if (VDBG) Log.d(LOG_TAG, "[InCallScreen.ConfigurationHelper] "
3300                            + "initConfiguration(" + config + ")...");
3301             sOrientation = config.orientation;
3302         }
3303
3304         /**
3305          * Updates the InCallScreen's View hierarchy, applying any
3306          * necessary changes given the current configuration.
3307          */
3308         static void applyConfigurationToLayout(InCallScreen inCallScreen) {
3309             if (sOrientation == Configuration.ORIENTATION_UNDEFINED) {
3310                 throw new IllegalStateException("need to call initConfiguration first");
3311             }
3312
3313             // find the landscape-only DTMF display field.
3314             inCallScreen.mDTMFDisplay = (EditText) inCallScreen.findViewById(R.id.dtmfDialerField);
3315
3316             // Our layout resources describe the *portrait mode* layout of
3317             // the Phone UI (see the TODO above in the doc comment for
3318             // the ConfigurationHelper class.)  So if we're in landscape
3319             // mode now, reach into our View hierarchy and update the
3320             // (few) layout params that need to be different.
3321             if (isLandscape()) {
3322                 // Update CallCard-related stuff
3323                 inCallScreen.mCallCard.updateForLandscapeMode();
3324
3325                 // No need to adjust the visiblity for mDTMFDisplay here because
3326                 // we're relying on the resources (layouts in layout-finger vs.
3327                 // layout-land-finger) to manage when mDTMFDisplay is shown.
3328             }
3329         }
3330     }
3331
3332     /**
3333      * @return true if we're in restricted / emergency dialing only mode.
3334      */
3335     public boolean isPhoneStateRestricted() {
3336         // TODO:  This needs to work IN TANDEM with the KeyGuardViewMediator Code.
3337         // Right now, it looks like the mInputRestricted flag is INTERNAL to the
3338         // KeyGuardViewMediator and SPECIFICALLY set to be FALSE while the emergency
3339         // phone call is being made, to allow for input into the InCallScreen.
3340         // Having the InCallScreen judge the state of the device from this flag
3341         // becomes meaningless since it is always false for us.  The mediator should
3342         // have an additional API to let this app know that it should be restricted.
3343         return ((mPhone.getServiceState().getState() == ServiceState.STATE_EMERGENCY_ONLY) ||
3344                 (mPhone.getServiceState().getState() == ServiceState.STATE_OUT_OF_SERVICE) ||
3345                 (PhoneApp.getInstance().getKeyguardManager().inKeyguardRestrictedInputMode()));
3346     }
3347
3348     //
3349     // In-call menu UI
3350     //
3351
3352     /**
3353      * Override onCreatePanelView(), in order to get complete control
3354      * over the UI that comes up when the user presses MENU.
3355      *
3356      * This callback allows me to return a totally custom View hierarchy
3357      * (with custom layout and custom "item" views) to be shown instead
3358      * of a standard android.view.Menu hierarchy.
3359      *
3360      * This gets called (with featureId == FEATURE_OPTIONS_PANEL) every
3361      * time we need to bring up the menu.  (And in cases where we return
3362      * non-null, that means that the "standard" menu callbacks
3363      * onCreateOptionsMenu() and onPrepareOptionsMenu() won't get called
3364      * at all.)
3365      */
3366     @Override
3367     public View onCreatePanelView(int featureId) {
3368         if (VDBG) log("onCreatePanelView(featureId = " + featureId + ")...");
3369
3370         // We only want this special behavior for the "options panel"
3371         // feature (i.e. the standard menu triggered by the MENU button.)
3372         if (featureId != Window.FEATURE_OPTIONS_PANEL) {
3373             return null;
3374         }
3375
3376         // TODO: May need to revisit the wake state here if this needs to be
3377         // tweaked.
3378
3379         // Make sure there are no pending messages to *dismiss* the menu.
3380         mHandler.removeMessages(DISMISS_MENU);
3381
3382         if (mInCallMenu == null) {
3383             if (VDBG) log("onCreatePanelView: creating mInCallMenu (first time)...");
3384             mInCallMenu = new InCallMenu(this);
3385             mInCallMenu.initMenu();
3386         }
3387
3388         boolean okToShowMenu = mInCallMenu.updateItems(mPhone);
3389         return okToShowMenu ? mInCallMenu.getView() : null;
3390     }
3391
3392     /**
3393      * Dismisses the menu panel (see onCreatePanelView().)
3394      *
3395      * @param dismissImmediate If true, hide the panel immediately.
3396      *            If false, leave the menu visible onscreen for
3397      *            a brief interval before dismissing it (so the
3398      *            user can see the state change resulting from
3399      *            his original click.)
3400      */
3401     /* package */ void dismissMenu(boolean dismissImmediate) {
3402         if (VDBG) log("dismissMenu(immediate = " + dismissImmediate + ")...");
3403
3404         if (dismissImmediate) {
3405             closeOptionsMenu();
3406         } else {
3407             mHandler.removeMessages(DISMISS_MENU);
3408             mHandler.sendEmptyMessageDelayed(DISMISS_MENU, MENU_DISMISS_DELAY);
3409             // This will result in a dismissMenu(true) call shortly.
3410         }
3411     }
3412
3413     /**
3414      * Override onPanelClosed() to capture the panel closing event,
3415      * allowing us to set the poke lock correctly whenever the option
3416      * menu panel goes away.
3417      */
3418     @Override
3419     public void onPanelClosed(int featureId, Menu menu) {
3420         if (VDBG) log("onPanelClosed(featureId = " + featureId + ")...");
3421
3422         // We only want this special behavior for the "options panel"
3423         // feature (i.e. the standard menu triggered by the MENU button.)
3424         if (featureId == Window.FEATURE_OPTIONS_PANEL) {
3425             // TODO: May need to return to the original wake state here
3426             // if onCreatePanelView ends up changing the wake state.
3427         }
3428
3429         super.onPanelClosed(featureId, menu);
3430     }
3431
3432     //
3433     // Bluetooth helper methods.
3434     //
3435     // - BluetoothDevice is the Bluetooth system service
3436     //   (Context.BLUETOOTH_SERVICE).  If getSystemService() returns null
3437     //   then the device is not BT capable.  Use BluetoothDevice.isEnabled()
3438     //   to see if BT is enabled on the device.
3439     //
3440     // - BluetoothHeadset is the API for the control connection to a
3441     //   Bluetooth Headset.  This lets you completely connect/disconnect a
3442     //   headset (which we don't do from the Phone UI!) but also lets you
3443     //   get the address of the currently active headset and see whether
3444     //   it's currently connected.
3445     //
3446     // - BluetoothHandsfree is the API to control the audio connection to
3447     //   a bluetooth headset. We use this API to switch the headset on and
3448     //   off when the user presses the "Bluetooth" button.
3449     //   Our BluetoothHandsfree instance (mBluetoothHandsfree) is created
3450     //   by the PhoneApp and will be null if the device is not BT capable.
3451     //
3452
3453     /**
3454      * @return true if the Bluetooth on/off switch in the UI should be
3455      *         available to the user (i.e. if the device is BT-capable
3456      *         and a headset is connected.)
3457      */
3458     /* package */ boolean isBluetoothAvailable() {
3459         if (VDBG) log("isBluetoothAvailable()...");
3460         if (mBluetoothHandsfree == null) {
3461             // Device is not BT capable.
3462             if (VDBG) log("  ==> FALSE (not BT capable)");
3463             return false;
3464         }
3465
3466         // There's no need to ask the Bluetooth system service if BT is enabled:
3467         //
3468         //    BluetoothDevice bluetoothDevice =
3469         //            (BluetoothDevice) getSystemService(Context.BLUETOOTH_SERVICE);
3470         //    if ((bluetoothDevice == null) || !bluetoothDevice.isEnabled()) {
3471         //        if (DBG) log("  ==> FALSE (BT not enabled)");
3472         //        return false;
3473         //    }
3474         //    if (DBG) log("  - BT enabled!  device name " + bluetoothDevice.getName()
3475         //                 + ", address " + bluetoothDevice.getAddress());
3476         //
3477         // ...since we already have a BluetoothHeadset instance.  We can just
3478         // call isConnected() on that, and assume it'll be false if BT isn't
3479         // enabled at all.
3480
3481         // Check if there's a connected headset, using the BluetoothHeadset API.
3482         boolean isConnected = false;
3483         if (mBluetoothHeadset != null) {
3484             if (VDBG) log("  - headset state = " + mBluetoothHeadset.getState());
3485             String headsetAddress = mBluetoothHeadset.getHeadsetAddress();
3486             if (VDBG) log("  - headset address: " + headsetAddress);
3487             if (headsetAddress != null) {
3488                 isConnected = mBluetoothHeadset.isConnected(headsetAddress);
3489                 if (VDBG) log("  - isConnected: " + isConnected);
3490             }
3491         }
3492
3493         if (VDBG) log("  ==> " + isConnected);
3494         return isConnected;
3495     }
3496
3497     /**
3498      * @return true if a BT device is available, and its audio is currently connected.
3499      */
3500     /* package */ boolean isBluetoothAudioConnected() {
3501         if (mBluetoothHandsfree == null) {
3502             if (VDBG) log("isBluetoothAudioConnected: ==> FALSE (null mBluetoothHandsfree)");
3503             return false;
3504         }
3505         boolean isAudioOn = mBluetoothHandsfree.isAudioOn();
3506         if (VDBG) log("isBluetoothAudioConnected: ==> isAudioOn = " + isAudioOn);
3507         return isAudioOn;
3508     }
3509
3510     /**
3511      * Helper method used to control the state of the green LED in the
3512      * "Bluetooth" menu item.
3513      *
3514      * @return true if a BT device is available and its audio is currently connected,
3515      *              <b>or</b> if we issued a BluetoothHandsfree.userWantsAudioOn()
3516      *              call within the last 5 seconds (which presumably means
3517      *              that the BT audio connection is currently being set
3518      *              up, and will be connected soon.)
3519      */
3520     /* package */ boolean isBluetoothAudioConnectedOrPending() {
3521         if (isBluetoothAudioConnected()) {
3522             if (VDBG) log("isBluetoothAudioConnectedOrPending: ==> TRUE (really connected)");
3523             return true;
3524         }
3525
3526         // If we issued a userWantsAudioOn() call "recently enough", even
3527         // if BT isn't actually connected yet, let's still pretend BT is
3528         // on.  This is how we make the green LED in the menu item turn on
3529         // right away.
3530         if (mBluetoothConnectionPending) {
3531             long timeSinceRequest =
3532                     SystemClock.elapsedRealtime() - mBluetoothConnectionRequestTime;
3533             if (timeSinceRequest < 5000 /* 5 seconds */) {
3534                 if (VDBG) log("isBluetoothAudioConnectedOrPending: ==> TRUE (requested "
3535                              + timeSinceRequest + " msec ago)");
3536                 return true;
3537             } else {
3538                 if (VDBG) log("isBluetoothAudioConnectedOrPending: ==> FALSE (request too old: "
3539                              + timeSinceRequest + " msec ago)");
3540                 mBluetoothConnectionPending = false;
3541                 return false;
3542             }
3543         }
3544
3545         if (VDBG) log("isBluetoothAudioConnectedOrPending: ==> FALSE");
3546         return false;
3547     }
3548
3549     /**
3550      * Posts a message to our handler saying to update the onscreen UI
3551      * based on a bluetooth headset state change.
3552      */
3553     /* package */ void updateBluetoothIndication() {
3554         if (VDBG) log("updateBluetoothIndication()...");
3555         // No need to look at the current state here; any UI elements that
3556         // care about the bluetooth state (i.e. the CallCard) get
3557         // the necessary state directly from PhoneApp.showBluetoothIndication().
3558         mHandler.removeMessages(BLUETOOTH_STATE_CHANGED);
3559         mHandler.sendEmptyMessage(BLUETOOTH_STATE_CHANGED);
3560     }
3561
3562     private void dumpBluetoothState() {
3563         log("============== dumpBluetoothState() =============");
3564         log("= isBluetoothAvailable: " + isBluetoothAvailable());
3565         log("= isBluetoothAudioConnected: " + isBluetoothAudioConnected());
3566         log("= isBluetoothAudioConnectedOrPending: " + isBluetoothAudioConnectedOrPending());
3567         log("= PhoneApp.showBluetoothIndication: "
3568             + PhoneApp.getInstance().showBluetoothIndication());
3569         log("=");
3570         if (mBluetoothHandsfree != null) {
3571             log("= BluetoothHandsfree.isAudioOn: " + mBluetoothHandsfree.isAudioOn());
3572             if (mBluetoothHeadset != null) {
3573                 String headsetAddress = mBluetoothHeadset.getHeadsetAddress();
3574                 log("= BluetoothHeadset.getHeadsetAddress: " + headsetAddress);
3575                 if (headsetAddress != null) {
3576                     log("= BluetoothHeadset.isConnected: "
3577                         + mBluetoothHeadset.isConnected(headsetAddress));
3578                 }
3579             } else {
3580                 log("= mBluetoothHeadset is null");
3581             }
3582         } else {
3583             log("= mBluetoothHandsfree is null; device is not BT capable");
3584         }
3585     }
3586
3587     /* package */ void connectBluetoothAudio() {
3588         if (VDBG) log("connectBluetoothAudio()...");
3589         if (mBluetoothHandsfree != null) {
3590             mBluetoothHandsfree.userWantsAudioOn();
3591         }
3592
3593         // Watch out: The bluetooth connection doesn't happen instantly;
3594         // the userWantsAudioOn() call returns instantly but does its real
3595         // work in another thread.  Also, in practice the BT connection
3596         // takes longer than MENU_DISMISS_DELAY to complete(!) so we need
3597         // a little trickery here to make the menu item's green LED update
3598         // instantly.
3599         // (See isBluetoothAudioConnectedOrPending() above.)
3600         mBluetoothConnectionPending = true;
3601         mBluetoothConnectionRequestTime = SystemClock.elapsedRealtime();
3602     }
3603
3604     /* package */ void disconnectBluetoothAudio() {
3605         if (VDBG) log("disconnectBluetoothAudio()...");
3606         if (mBluetoothHandsfree != null) {
3607             mBluetoothHandsfree.userWantsAudioOff();
3608         }
3609         mBluetoothConnectionPending = false;
3610     }
3611
3612     //
3613     // "Touch lock" UI.
3614     //
3615     // When the DTMF dialpad is up, after a certain amount of idle time we
3616     // display an overlay graphic on top of the dialpad and "lock" the
3617     // touch UI.  (UI Rationale: We need *some* sort of screen lock, with
3618     // a fairly short timeout, to avoid false touches from the user's face
3619     // while in-call.  But we *don't* want to do this by turning off the
3620     // screen completely, since that's confusing (the user can't tell
3621     // what's going on) *and* it's fairly cumbersome to have to hit MENU
3622     // to bring the screen back, rather than using some gesture on the
3623     // touch screen.)
3624     //
3625     // The user can dismiss the touch lock overlay by double-tapping on
3626     // the central "lock" icon.  Also, the touch lock overlay will go away
3627     // by itself if the DTMF dialpad is dismissed for any reason, such as
3628     // the current call getting disconnected (see onDialerClose()).
3629     //
3630
3631     /**
3632      * Initializes the "touch lock" UI widgets.  We do this lazily
3633      * to avoid slowing down the initial launch of the InCallScreen.
3634      */
3635     private void initTouchLock() {
3636         if (VDBG) log("initTouchLock()...");
3637         if (mTouchLockOverlay != null) {
3638             Log.w(LOG_TAG, "initTouchLock: already initialized!");
3639             return;
3640         }
3641
3642         mTouchLockOverlay = (View) findViewById(R.id.touchLockOverlay);
3643         // Note mTouchLockOverlay's visibility is initially GONE.
3644         mTouchLockIcon = (View) findViewById(R.id.touchLockIcon);
3645
3646         // Handle touch events.  (Basically mTouchLockOverlay consumes and
3647         // discards any touch events it sees, and mTouchLockIcon listens
3648         // for the "double-tap to unlock" gesture.)
3649         mTouchLockOverlay.setOnTouchListener(this);
3650         mTouchLockIcon.setOnTouchListener(this);
3651
3652         mTouchLockFadeIn = AnimationUtils.loadAnimation(this, R.anim.touch_lock_fade_in);
3653     }
3654
3655     private boolean isTouchLocked() {
3656         return (mTouchLockOverlay != null) && (mTouchLockOverlay.getVisibility() == View.VISIBLE);
3657     }
3658
3659     /**
3660      * Enables or disables the "touch lock" overlay on top of the DTMF dialpad.
3661      *
3662      * If enable=true, bring up the overlay immediately using an animated
3663      * fade-in effect.  (Or do nothing if the overlay isn't appropriate
3664      * right now, like if the dialpad isn't up, or the speaker is on.)
3665      *
3666      * If enable=false, immediately take down the overlay.  (Or do nothing
3667      * if the overlay isn't actually up right now.)
3668      *
3669      * Note that with enable=false this method will *not* automatically
3670      * start the touch lock timer.  (So when taking down the overlay while
3671      * the dialer is still up, the caller is also responsible for calling
3672      * resetTouchLockTimer(), to make sure the overlay will get
3673      * (re-)enabled later.)
3674      *
3675      */
3676     private void enableTouchLock(boolean enable) {
3677         if (VDBG) log("enableTouchLock(" + enable + ")...");
3678         if (enable) {
3679             // The "touch lock" overlay is only ever used on top of the
3680             // DTMF dialpad.
3681             if (!mDialer.isOpened()) {
3682                 if (VDBG) log("enableTouchLock: dialpad isn't up, no need to lock screen.");
3683                 return;
3684             }
3685
3686             // Also, the "touch lock" overlay NEVER appears if the speaker is in use.
3687             if (PhoneUtils.isSpeakerOn(getApplicationContext())) {
3688                 if (VDBG) log("enableTouchLock: speaker is on, no need to lock screen.");
3689                 return;
3690             }
3691
3692             // Initialize the UI elements if necessary.
3693             if (mTouchLockOverlay == null) {
3694                 initTouchLock();
3695             }
3696
3697             // First take down the menu if it's up (since it's confusing
3698             // to see a touchable menu *above* the touch lock overlay.)
3699             // Note dismissMenu() has no effect if the menu is already closed.
3700             dismissMenu(true);  // dismissImmediate = true
3701
3702             // Bring up the touch lock overlay (with an animated fade)
3703             mTouchLockOverlay.setVisibility(View.VISIBLE);
3704             mTouchLockOverlay.startAnimation(mTouchLockFadeIn);
3705         } else {
3706             // TODO: it might be nice to immediately kill the animation if
3707             // we're in the middle of fading-in:
3708             //   if (mTouchLockFadeIn.hasStarted() && !mTouchLockFadeIn.hasEnded()) {
3709             //      mTouchLockOverlay.clearAnimation();
3710             //   }
3711             // but the fade-in is so quick that this probably isn't necessary.
3712
3713             // Take down the touch lock overlay (immediately)
3714             if (mTouchLockOverlay != null) mTouchLockOverlay.setVisibility(View.GONE);
3715         }
3716     }
3717
3718     /**
3719      * Schedule the "touch lock" overlay to begin fading in after a short
3720      * delay, but only if the DTMF dialpad is currently visible.
3721      *
3722      * (This is designed to be triggered on any user activity
3723      * while the dialpad is up but not locked, and also
3724      * whenever the user "unlocks" the touch lock overlay.)
3725      *
3726      * Calling this method supersedes any previous resetTouchLockTimer()
3727      * calls (i.e. we first clear any pending TOUCH_LOCK_TIMER messages.)
3728      */
3729     private void resetTouchLockTimer() {
3730         if (VDBG) log("resetTouchLockTimer()...");
3731         mHandler.removeMessages(TOUCH_LOCK_TIMER);
3732         if (mDialer.isOpened() && !isTouchLocked()) {
3733             // The touch lock delay value comes from Gservices; we use
3734             // the same value that's used for the PowerManager's
3735             // POKE_LOCK_SHORT_TIMEOUT flag (i.e. the fastest possible
3736             // screen timeout behavior.)
3737
3738             // Do a fresh lookup each time, since Gservices values can
3739             // change on the fly.  (The Settings.Gservices helper class
3740             // caches these values so this call is usually cheap.)
3741             int touchLockDelay = Settings.Gservices.getInt(
3742                     getContentResolver(),
3743                     Settings.Gservices.SHORT_KEYLIGHT_DELAY_MS,
3744                     TOUCH_LOCK_DELAY_DEFAULT);
3745             mHandler.sendEmptyMessageDelayed(TOUCH_LOCK_TIMER, touchLockDelay);
3746         }
3747     }
3748
3749     /**
3750      * Handles the TOUCH_LOCK_TIMER event.
3751      * @see resetTouchLockTimer
3752      */
3753     private void touchLockTimerExpired() {
3754         // Ok, it's been long enough since we had any user activity with
3755         // the DTMF dialpad up.  If the dialpad is still up, start fading
3756         // in the "touch lock" overlay.
3757         enableTouchLock(true);
3758     }
3759
3760     // View.OnTouchListener implementation
3761     public boolean onTouch(View v, MotionEvent event) {
3762         if (VDBG) log ("onTouch(View " + v + ")...");
3763
3764         //
3765         // Handle touch events on the "touch lock" overlay.
3766         // (v == mTouchLockIcon) means the user hit the lock icon in the
3767         // middle of the screen, and (v == mTouchLockOverlay) is a touch
3768         // anywhere else on the overlay.
3769         //
3770
3771         // We only care about touch events while the touch lock UI is
3772         // visible (including the time during the fade-in animation.)
3773         if (((v == mTouchLockIcon) || (v == mTouchLockOverlay)) && !isTouchLocked()) {
3774             // Got an event from the touch lock UI, but we're not locked!
3775             // (This was probably a touch-UP right after we unlocked.
3776             // Ignore it.)
3777             return false;
3778         }
3779
3780         if (v == mTouchLockIcon) {
3781             // Direct hit on the "lock" icon.  Handle the double-tap gesture.
3782             if (event.getAction() == MotionEvent.ACTION_DOWN) {
3783                 long now = SystemClock.uptimeMillis();
3784                 if (VDBG) log("- touch lock icon: handling a DOWN event, t = " + now);
3785
3786                 // Look for the double-tap gesture:
3787                 if (now < mTouchLockLastTouchTime + ViewConfiguration.getDoubleTapTimeout()) {
3788                     if (VDBG) log("==> touch lock icon: DOUBLE-TAP!");
3789                     // This was the 2nd tap of a double-tap gesture.
3790                     // Take down the touch lock overlay, but post a
3791                     // message in the future to bring it back later.
3792                     enableTouchLock(false);
3793                     resetTouchLockTimer();
3794                     // This counts as explicit "user activity".
3795                     PhoneApp.getInstance().pokeUserActivity();
3796                 }
3797             } else if (event.getAction() == MotionEvent.ACTION_UP) {
3798                 // Stash away the current time in case this is the first
3799                 // tap of a double-tap gesture.  (We measure the time from
3800                 // the first tap's UP to the second tap's DOWN.)
3801                 mTouchLockLastTouchTime = SystemClock.uptimeMillis();
3802             }
3803
3804             // And regardless of what just happened, we *always* consume
3805             // touch events while the touch lock UI is (or was) visible.
3806             return true;
3807
3808         } else if (v == mTouchLockOverlay) {
3809             // User touched the "background" area of the touch lock overlay.
3810
3811             // TODO: If we're in the middle of the fade-in animation,
3812             // consider making a touch *anywhere* immediately unlock the
3813             // UI.  This could be risky, though, if the user tries to
3814             // *double-tap* during the fade-in (in which case the 2nd tap
3815             // might 't become a false touch on the dialpad!)
3816             //
3817             //if (event.getAction() == MotionEvent.ACTION_DOWN) {
3818             //    if (DBG) log("- touch lock overlay background: handling a DOWN event.");
3819             //
3820             //    if (mTouchLockFadeIn.hasStarted() && !mTouchLockFadeIn.hasEnded()) {
3821             //        // If we're still fading-in, a touch *anywhere* onscreen
3822             //        // immediately unlocks.
3823             //        if (DBG) log("==> touch lock: tap during fade-in!");
3824             //
3825             //        mTouchLockOverlay.clearAnimation();
3826             //        enableTouchLock(false);
3827             //        // ...but post a message in the future to bring it
3828             //        // back later.
3829             //        resetTouchLockTimer();
3830             //    }
3831             //}
3832
3833             // And regardless of what just happened, we *always* consume
3834             // touch events while the touch lock UI is (or was) visible.
3835             return true;
3836
3837         } else {
3838             Log.w(LOG_TAG, "onTouch: event from unexpected View: " + v);
3839             return false;
3840         }
3841     }
3842
3843     // Any user activity while the dialpad is up, but not locked, should
3844     // reset the touch lock timer back to the full delay amount.
3845     @Override
3846     public void onUserInteraction() {
3847         if (mDialer.isOpened() && !isTouchLocked()) {
3848             resetTouchLockTimer();
3849         }
3850     }
3851
3852
3853     private void log(String msg) {
3854         Log.d(LOG_TAG, msg);
3855     }
3856 }