TODO fixes from Teleca 090527
[android/platform/packages/apps/Phone.git] / src / com / android / phone / CallNotifier.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.Phone;
24 import com.android.internal.telephony.gsm.GSMPhone;
25
26 import android.content.Context;
27 import android.media.AudioManager;
28 import android.media.ToneGenerator;
29 import android.os.AsyncResult;
30 import android.os.Handler;
31 import android.os.Message;
32 import android.os.SystemClock;
33 import android.os.SystemProperties;
34 import android.provider.CallLog;
35 import android.provider.CallLog.Calls;
36 import android.provider.Checkin;
37 import android.provider.Settings;
38 import android.telephony.PhoneStateListener;
39 import android.telephony.TelephonyManager;
40 import android.util.Log;
41
42
43 /**
44  * Stub which listens for phone state changes and decides whether it is worth
45  * telling the user what just happened.
46  */
47 public class CallNotifier extends Handler
48         implements CallerInfoAsyncQuery.OnQueryCompleteListener {
49     private static final String LOG_TAG = "CallNotifier";
50     private static final boolean DBG =
51             (PhoneApp.DBG_LEVEL >= 1) && (SystemProperties.getInt("ro.debuggable", 0) == 1);
52     private static final boolean VDBG = (PhoneApp.DBG_LEVEL >= 2);
53
54     // Strings used with Checkin.logEvent().
55     private static final String PHONE_UI_EVENT_RINGER_QUERY_ELAPSED =
56         "using default incoming call behavior";
57     private static final String PHONE_UI_EVENT_MULTIPLE_QUERY =
58         "multiple incoming call queries attempted";
59
60     // Maximum time we allow the CallerInfo query to run,
61     // before giving up and falling back to the default ringtone.
62     private static final int RINGTONE_QUERY_WAIT_TIME = 500;  // msec
63
64     // values used to track the query state
65     private static final int CALLERINFO_QUERY_READY = 0;
66     private static final int CALLERINFO_QUERYING = -1;
67
68     // the state of the CallerInfo Query.
69     private int mCallerInfoQueryState;
70
71     // object used to synchronize access to mCallerInfoQueryState
72     private Object mCallerInfoQueryStateGuard = new Object();
73
74     // Event used to indicate a query timeout.
75     private static final int RINGER_CUSTOM_RINGTONE_QUERY_TIMEOUT = 100;
76
77     // Events from the Phone object:
78     private static final int PHONE_STATE_CHANGED = 1;
79     private static final int PHONE_NEW_RINGING_CONNECTION = 2;
80     private static final int PHONE_DISCONNECT = 3;
81     private static final int PHONE_UNKNOWN_CONNECTION_APPEARED = 4;
82     private static final int PHONE_INCOMING_RING = 5;
83     private static final int PHONE_CDMA_CALL_WAITING = 6;
84     // Events generated internally:
85     private static final int PHONE_MWI_CHANGED = 7;
86     private static final int PHONE_BATTERY_LOW = 8;
87
88     private PhoneApp mApplication;
89     private Phone mPhone;
90     private Ringer mRinger;
91     private BluetoothHandsfree mBluetoothHandsfree;
92     private boolean mSilentRingerRequested;
93
94     public CallNotifier(PhoneApp app, Phone phone, Ringer ringer,
95                         BluetoothHandsfree btMgr) {
96         mApplication = app;
97
98         mPhone = phone;
99         mPhone.registerForNewRingingConnection(this, PHONE_NEW_RINGING_CONNECTION, null);
100         mPhone.registerForPhoneStateChanged(this, PHONE_STATE_CHANGED, null);
101         mPhone.registerForDisconnect(this, PHONE_DISCONNECT, null);
102         mPhone.registerForUnknownConnection(this, PHONE_UNKNOWN_CONNECTION_APPEARED, null);
103         mPhone.registerForIncomingRing(this, PHONE_INCOMING_RING, null);
104         mPhone.registerForCallWaiting(this,PHONE_CDMA_CALL_WAITING, null);
105         mRinger = ringer;
106         mBluetoothHandsfree = btMgr;
107
108         TelephonyManager telephonyManager = (TelephonyManager)app.getSystemService(
109                 Context.TELEPHONY_SERVICE);
110         telephonyManager.listen(mPhoneStateListener,
111                 PhoneStateListener.LISTEN_MESSAGE_WAITING_INDICATOR
112                 | PhoneStateListener.LISTEN_CALL_FORWARDING_INDICATOR);
113     }
114
115     @Override
116     public void handleMessage(Message msg) {
117         switch (msg.what) {
118             case PHONE_NEW_RINGING_CONNECTION:
119                 if (DBG) log("RINGING... (new)");
120                 onNewRingingConnection((AsyncResult) msg.obj);
121                 mSilentRingerRequested = false;
122                 break;
123
124             case PHONE_INCOMING_RING:
125                 // repeat the ring when requested by the RIL, and when the user has NOT
126                 // specifically requested silence.
127                 if (msg.obj != null && ((AsyncResult) msg.obj).result != null &&
128                         ((GSMPhone)((AsyncResult) msg.obj).result).getState() == Phone.State.RINGING
129                         && mSilentRingerRequested == false) {
130                     if (DBG) log("RINGING... (PHONE_INCOMING_RING event)");
131                     mRinger.ring();
132                 } else {
133                     if (DBG) log("RING before NEW_RING, skipping");
134                 }
135                 break;
136             case PHONE_CDMA_CALL_WAITING:
137                 if (DBG) log("CDMA CALL WAITING... ");
138                 onCdmaCallwaiting((AsyncResult) msg.obj);
139                 break;
140             case PHONE_STATE_CHANGED:
141                 onPhoneStateChanged((AsyncResult) msg.obj);
142                 break;
143
144             case PHONE_DISCONNECT:
145                 if (DBG) log("DISCONNECT");
146                 onDisconnect((AsyncResult) msg.obj);
147                 break;
148
149             case PHONE_UNKNOWN_CONNECTION_APPEARED:
150                 onUnknownConnectionAppeared((AsyncResult) msg.obj);
151                 break;
152
153             case RINGER_CUSTOM_RINGTONE_QUERY_TIMEOUT:
154                 // CallerInfo query is taking too long!  But we can't wait
155                 // any more, so start ringing NOW even if it means we won't
156                 // use the correct custom ringtone.
157                 Log.w(LOG_TAG, "CallerInfo query took too long; manually starting ringer");
158
159                 // In this case we call onCustomRingQueryComplete(), just
160                 // like if the query had completed normally.  (But we're
161                 // going to get the default ringtone, since we never got
162                 // the chance to call Ringer.setCustomRingtoneUri()).
163                 onCustomRingQueryComplete();
164                 break;
165
166             case PHONE_MWI_CHANGED:
167                 onMwiChanged(mPhone.getMessageWaitingIndicator());
168                 break;
169
170             case PHONE_BATTERY_LOW:
171                 onBatteryLow();
172                 break;
173
174             default:
175                 // super.handleMessage(msg);
176         }
177     }
178
179     PhoneStateListener mPhoneStateListener = new PhoneStateListener() {
180         @Override
181         public void onMessageWaitingIndicatorChanged(boolean mwi) {
182             onMwiChanged(mwi);
183         }
184
185         @Override
186         public void onCallForwardingIndicatorChanged(boolean cfi) {
187             onCfiChanged(cfi);
188         }
189     };
190
191     private void onNewRingingConnection(AsyncResult r) {
192         Connection c = (Connection) r.result;
193         if (DBG) log("onNewRingingConnection(): " + c);
194
195         // Incoming calls are totally ignored if the device isn't provisioned yet
196         boolean provisioned = Settings.Secure.getInt(mPhone.getContext().getContentResolver(),
197             Settings.Secure.DEVICE_PROVISIONED, 0) != 0;
198         if (!provisioned) {
199             Log.i(LOG_TAG, "CallNotifier: rejecting incoming call: device isn't provisioned");
200             // Send the caller straight to voicemail, just like
201             // "rejecting" an incoming call.
202             PhoneUtils.hangupRingingCall(mPhone);
203             return;
204         }
205
206         if (c != null && c.isRinging()) {
207             Call.State state = c.getState();
208             // State will be either INCOMING or WAITING.
209             if (VDBG) log("- connection is ringing!  state = " + state);
210             // if (DBG) PhoneUtils.dumpCallState(mPhone);
211
212             // No need to do any service state checks here (like for
213             // "emergency mode"), since in those states the SIM won't let
214             // us get incoming connections in the first place.
215
216             // TODO: Consider sending out a serialized broadcast Intent here
217             // (maybe "ACTION_NEW_INCOMING_CALL"), *before* starting the
218             // ringer and going to the in-call UI.  The intent should contain
219             // the caller-id info for the current connection, and say whether
220             // it would be a "call waiting" call or a regular ringing call.
221             // If anybody consumed the broadcast, we'd bail out without
222             // ringing or bringing up the in-call UI.
223             //
224             // This would give 3rd party apps a chance to listen for (and
225             // intercept) new ringing connections.  An app could reject the
226             // incoming call by consuming the broadcast and doing nothing, or
227             // it could "pick up" the call (without any action by the user!)
228             // by firing off an ACTION_ANSWER intent.
229             //
230             // We'd need to protect this with a new "intercept incoming calls"
231             // system permission.
232
233             // - don't ring for call waiting connections
234             // - do this before showing the incoming call panel
235             if (state == Call.State.INCOMING) {
236                 PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_RINGING);
237                 startIncomingCallQuery(c);
238             } else {
239                 if (VDBG) log("- starting call waiting tone...");
240                 new InCallTonePlayer(InCallTonePlayer.TONE_CALL_WAITING).start();
241                 // The InCallTonePlayer will automatically stop playing (and
242                 // clean itself up) after playing the tone.
243
244                 // TODO: alternatively, consider starting an
245                 // InCallTonePlayer with an "unlimited" tone length, and
246                 // manually stop it later when the ringing call either (a)
247                 // gets answered, or (b) gets disconnected.
248
249                 // in this case, just fall through like before, and call
250                 // PhoneUtils.showIncomingCallUi
251                 PhoneUtils.showIncomingCallUi();
252             }
253         }
254
255         // Obtain a partial wake lock to make sure the CPU doesn't go to
256         // sleep before we finish bringing up the InCallScreen.
257         // (This will be upgraded soon to a full wake lock; see
258         // PhoneUtils.showIncomingCallUi().)
259         if (VDBG) log("Holding wake lock on new incoming connection.");
260         mApplication.requestWakeState(PhoneApp.WakeState.PARTIAL);
261
262         if (VDBG) log("- onNewRingingConnection() done.");
263     }
264
265     private void onCdmaCallwaiting(AsyncResult r) {
266        return;
267     }
268
269     /**
270      * Helper method to manage the start of incoming call queries
271      */
272     private void startIncomingCallQuery(Connection c) {
273         // TODO: cache the custom ringer object so that subsequent
274         // calls will not need to do this query work.  We can keep
275         // the MRU ringtones in memory.  We'll still need to hit
276         // the database to get the callerinfo to act as a key,
277         // but at least we can save the time required for the
278         // Media player setup.  The only issue with this is that
279         // we may need to keep an eye on the resources the Media
280         // player uses to keep these ringtones around.
281
282         // make sure we're in a state where we can be ready to
283         // query a ringtone uri.
284         boolean shouldStartQuery = false;
285         synchronized (mCallerInfoQueryStateGuard) {
286             if (mCallerInfoQueryState == CALLERINFO_QUERY_READY) {
287                 mCallerInfoQueryState = CALLERINFO_QUERYING;
288                 shouldStartQuery = true;
289             }
290         }
291         if (shouldStartQuery) {
292             // create a custom ringer using the default ringer first
293             mRinger.setCustomRingtoneUri(Settings.System.DEFAULT_RINGTONE_URI);
294
295             // query the callerinfo to try to get the ringer.
296             PhoneUtils.CallerInfoToken cit = PhoneUtils.startGetCallerInfo(
297                     mPhone.getContext(), c, this, this);
298
299             // if this has already been queried then just ring, otherwise
300             // we wait for the alloted time before ringing.
301             if (cit.isFinal) {
302                 if (VDBG) log("- CallerInfo already up to date, using available data");
303                 onQueryComplete(0, this, cit.currentInfo);
304             } else {
305                 if (VDBG) log("- Starting query, posting timeout message.");
306                 sendEmptyMessageDelayed(RINGER_CUSTOM_RINGTONE_QUERY_TIMEOUT,
307                         RINGTONE_QUERY_WAIT_TIME);
308             }
309             // calls to PhoneUtils.showIncomingCallUi will come after the
310             // queries are complete (or timeout).
311         } else {
312             // This should never happen; its the case where an incoming call
313             // arrives at the same time that the query is still being run,
314             // and before the timeout window has closed.
315             Checkin.logEvent(mPhone.getContext().getContentResolver(),
316                     Checkin.Events.Tag.PHONE_UI,
317                     PHONE_UI_EVENT_MULTIPLE_QUERY);
318
319             // In this case, just log the request and ring.
320             if (VDBG) log("RINGING... (request to ring arrived while query is running)");
321             mRinger.ring();
322
323             // in this case, just fall through like before, and call
324             // PhoneUtils.showIncomingCallUi
325             PhoneUtils.showIncomingCallUi();
326         }
327     }
328
329     /**
330      * Performs the final steps of the onNewRingingConnection sequence:
331      * starts the ringer, and launches the InCallScreen to show the
332      * "incoming call" UI.
333      *
334      * Normally, this is called when the CallerInfo query completes (see
335      * onQueryComplete()).  In this case, onQueryComplete() has already
336      * configured the Ringer object to use the custom ringtone (if there
337      * is one) for this caller.  So we just tell the Ringer to start, and
338      * proceed to the InCallScreen.
339      *
340      * But this method can *also* be called if the
341      * RINGTONE_QUERY_WAIT_TIME timeout expires, which means that the
342      * CallerInfo query is taking too long.  In that case, we log a
343      * warning but otherwise we behave the same as in the normal case.
344      * (We still tell the Ringer to start, but it's going to use the
345      * default ringtone.)
346      */
347     private void onCustomRingQueryComplete() {
348         boolean isQueryExecutionTimeExpired = false;
349         synchronized (mCallerInfoQueryStateGuard) {
350             if (mCallerInfoQueryState == CALLERINFO_QUERYING) {
351                 mCallerInfoQueryState = CALLERINFO_QUERY_READY;
352                 isQueryExecutionTimeExpired = true;
353             }
354         }
355         if (isQueryExecutionTimeExpired) {
356             // There may be a problem with the query here, since the
357             // default ringtone is playing instead of the custom one.
358             Log.w(LOG_TAG, "CallerInfo query took too long; falling back to default ringtone");
359             Checkin.logEvent(mPhone.getContext().getContentResolver(),
360                     Checkin.Events.Tag.PHONE_UI,
361                     PHONE_UI_EVENT_RINGER_QUERY_ELAPSED);
362         }
363
364         // Make sure we still have an incoming call!
365         //
366         // (It's possible for the incoming call to have been disconnected
367         // while we were running the query.  In that case we better not
368         // start the ringer here, since there won't be any future
369         // DISCONNECT event to stop it!)
370         //
371         // Note we don't have to worry about the incoming call going away
372         // *after* this check but before we call mRinger.ring() below,
373         // since in that case we *will* still get a DISCONNECT message sent
374         // to our handler.  (And we will correctly stop the ringer when we
375         // process that event.)
376         if (mPhone.getState() != Phone.State.RINGING) {
377             Log.i(LOG_TAG, "onCustomRingQueryComplete: No incoming call! Bailing out...");
378             // Don't start the ringer *or* bring up the "incoming call" UI.
379             // Just bail out.
380             return;
381         }
382
383         // Ring, either with the queried ringtone or default one.
384         if (VDBG) log("RINGING... (onCustomRingQueryComplete)");
385         mRinger.ring();
386
387         // ...and show the InCallScreen.
388         PhoneUtils.showIncomingCallUi();
389     }
390
391     private void onUnknownConnectionAppeared(AsyncResult r) {
392         Phone.State state = mPhone.getState();
393
394         if (state == Phone.State.OFFHOOK) {
395             // basically do onPhoneStateChanged + displayCallScreen
396             onPhoneStateChanged(r);
397             PhoneUtils.showIncomingCallUi();
398         }
399     }
400
401     private void onPhoneStateChanged(AsyncResult r) {
402         Phone.State state = mPhone.getState();
403
404         // Turn status bar notifications on or off depending upon the state
405         // of the phone.  Notification Alerts (audible or vibrating) should
406         // be on if and only if the phone is IDLE.
407         NotificationMgr.getDefault().getStatusBarMgr()
408                 .enableNotificationAlerts(state == Phone.State.IDLE);
409
410         // Have the PhoneApp recompute its mShowBluetoothIndication
411         // flag based on the (new) telephony state.
412         // There's no need to force a UI update since we update the
413         // in-call notification ourselves (below), and the InCallScreen
414         // listens for phone state changes itself.
415         mApplication.updateBluetoothIndication(false);
416
417         if (state == Phone.State.OFFHOOK) {
418             PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_OFFHOOK);
419             if (VDBG) log("onPhoneStateChanged: OFF HOOK");
420
421             // if the call screen is showing, let it handle the event,
422             // otherwise handle it here.
423             if (!mApplication.isShowingCallScreen()) {
424                 mApplication.setScreenTimeout(PhoneApp.ScreenTimeoutDuration.DEFAULT);
425                 mApplication.requestWakeState(PhoneApp.WakeState.SLEEP);
426             }
427
428             // Since we're now in-call, the Ringer should definitely *not*
429             // be ringing any more.  (This is just a sanity-check; we
430             // already stopped the ringer explicitly back in
431             // PhoneUtils.answerCall(), before the call to phone.acceptCall().)
432             // TODO: Confirm that this call really *is* unnecessary, and if so,
433             // remove it!
434             if (DBG) log("stopRing()... (OFFHOOK state)");
435             mRinger.stopRing();
436
437             // put a icon in the status bar
438             NotificationMgr.getDefault().updateInCallNotification();
439         }
440     }
441
442     void updateCallNotifierRegistrationsAfterRadioTechnologyChange() {
443         if(DBG) Log.d(LOG_TAG, "updateCallNotifierRegistrationsAfterRadioTechnologyChange...");
444         //Unregister all events from the old obsolete phone
445         mPhone.unregisterForNewRingingConnection(this);
446         mPhone.unregisterForPhoneStateChanged(this);
447         mPhone.unregisterForDisconnect(this);
448         mPhone.unregisterForUnknownConnection(this);
449         mPhone.unregisterForIncomingRing(this);
450
451         //Register all events new to the new active phone
452         mPhone.registerForNewRingingConnection(this, PHONE_NEW_RINGING_CONNECTION, null);
453         mPhone.registerForPhoneStateChanged(this, PHONE_STATE_CHANGED, null);
454         mPhone.registerForDisconnect(this, PHONE_DISCONNECT, null);
455         mPhone.registerForUnknownConnection(this, PHONE_UNKNOWN_CONNECTION_APPEARED, null);
456         mPhone.registerForIncomingRing(this, PHONE_INCOMING_RING, null);
457     }
458
459     /**
460      * Implemented for CallerInfoAsyncQuery.OnQueryCompleteListener interface.
461      * refreshes the CallCard data when it called.  If called with this
462      * class itself, it is assumed that we have been waiting for the ringtone
463      * and direct to voicemail settings to update.
464      */
465     public void onQueryComplete(int token, Object cookie, CallerInfo ci){
466         if (cookie instanceof Long) {
467             if (VDBG) log("CallerInfo query complete, posting missed call notification");
468
469             NotificationMgr.getDefault().notifyMissedCall(ci.name, ci.phoneNumber,
470                     ci.phoneLabel, ((Long) cookie).longValue());
471         } else if (cookie instanceof CallNotifier){
472             if (VDBG) log("CallerInfo query complete, updating data");
473
474             // get rid of the timeout messages
475             removeMessages(RINGER_CUSTOM_RINGTONE_QUERY_TIMEOUT);
476
477             boolean isQueryExecutionTimeOK = false;
478             synchronized (mCallerInfoQueryStateGuard) {
479                 if (mCallerInfoQueryState == CALLERINFO_QUERYING) {
480                     mCallerInfoQueryState = CALLERINFO_QUERY_READY;
481                     isQueryExecutionTimeOK = true;
482                 }
483             }
484             //if we're in the right state
485             if (isQueryExecutionTimeOK) {
486
487                 // send directly to voicemail.
488                 if (ci.shouldSendToVoicemail) {
489                     if (DBG) log("send to voicemail flag detected. hanging up.");
490                     PhoneUtils.hangupRingingCall(mPhone);
491                     return;
492                 }
493
494                 // set the ringtone uri to prepare for the ring.
495                 if (ci.contactRingtoneUri != null) {
496                     if (DBG) log("custom ringtone found, setting up ringer.");
497                     Ringer r = ((CallNotifier) cookie).mRinger;
498                     r.setCustomRingtoneUri(ci.contactRingtoneUri);
499                 }
500                 // ring, and other post-ring actions.
501                 onCustomRingQueryComplete();
502             }
503         }
504     }
505
506     private void onDisconnect(AsyncResult r) {
507         if (VDBG) log("onDisconnect()...  phone state: " + mPhone.getState());
508         if (mPhone.getState() == Phone.State.IDLE) {
509             PhoneUtils.setAudioControlState(PhoneUtils.AUDIO_IDLE);
510         }
511
512         Connection c = (Connection) r.result;
513         if (DBG && c != null) {
514             log("- onDisconnect: cause = " + c.getDisconnectCause()
515                 + ", incoming = " + c.isIncoming()
516                 + ", date = " + c.getCreateTime());
517         }
518
519         // Stop the ringer if it was ringing (for an incoming call that
520         // either disconnected by itself, or was rejected by the user.)
521         //
522         // TODO: We technically *shouldn't* stop the ringer if the
523         // foreground or background call disconnects while an incoming call
524         // is still ringing, but that's a really rare corner case.
525         // It's safest to just unconditionally stop the ringer here.
526         if (DBG) log("stopRing()... (onDisconnect)");
527         mRinger.stopRing();
528
529         // Check for the various tones we might need to play (thru the
530         // earpiece) after a call disconnects.
531         int toneToPlay = InCallTonePlayer.TONE_NONE;
532
533         // The "Busy" or "Congestion" tone is the highest priority:
534         if (c != null) {
535             Connection.DisconnectCause cause = c.getDisconnectCause();
536             if (cause == Connection.DisconnectCause.BUSY) {
537                 if (DBG) log("- need to play BUSY tone!");
538                 toneToPlay = InCallTonePlayer.TONE_BUSY;
539             } else if (cause == Connection.DisconnectCause.CONGESTION) {
540                 if (DBG) log("- need to play CONGESTION tone!");
541                 toneToPlay = InCallTonePlayer.TONE_CONGESTION;
542             }
543         }
544
545         // If we don't need to play BUSY or CONGESTION, then play the
546         // "call ended" tone if this was a "regular disconnect" (i.e. a
547         // normal call where one end or the other hung up) *and* this
548         // disconnect event caused the phone to become idle.  (In other
549         // words, we *don't* play the sound if one call hangs up but
550         // there's still an active call on the other line.)
551         // TODO: We may eventually want to disable this via a preference.
552         if ((toneToPlay == InCallTonePlayer.TONE_NONE)
553             && (mPhone.getState() == Phone.State.IDLE)
554             && (c != null)) {
555             Connection.DisconnectCause cause = c.getDisconnectCause();
556             if ((cause == Connection.DisconnectCause.NORMAL)  // remote hangup
557                 || (cause == Connection.DisconnectCause.LOCAL)) {  // local hangup
558                 if (VDBG) log("- need to play CALL_ENDED tone!");
559                 toneToPlay = InCallTonePlayer.TONE_CALL_ENDED;
560             }
561         }
562
563         if (mPhone.getState() == Phone.State.IDLE) {
564             // Don't reset the audio mode or bluetooth/speakerphone state
565             // if we still need to let the user hear a tone through the earpiece.
566             if (toneToPlay == InCallTonePlayer.TONE_NONE) {
567                 resetAudioStateAfterDisconnect();
568             }
569
570             NotificationMgr.getDefault().cancelCallInProgressNotification();
571
572             // If the InCallScreen is *not* in the foreground, forcibly
573             // dismiss it to make sure it won't still be in the activity
574             // history.  (But if it *is* in the foreground, don't mess
575             // with it; it needs to be visible, displaying the "Call
576             // ended" state.)
577             if (!mApplication.isShowingCallScreen()) {
578                 if (VDBG) log("onDisconnect: force InCallScreen to finish()");
579                 mApplication.dismissCallScreen();
580             }
581         }
582
583         if (c != null) {
584             final String number = c.getAddress();
585             final int presentation = c.getNumberPresentation();
586             final long date = c.getCreateTime();
587             final long duration = c.getDurationMillis();
588             final Connection.DisconnectCause cause = c.getDisconnectCause();
589
590             // Set the "type" to be displayed in the call log (see constants in CallLog.Calls)
591             final int callLogType;
592             if (c.isIncoming()) {
593                 callLogType = (cause == Connection.DisconnectCause.INCOMING_MISSED ?
594                                CallLog.Calls.MISSED_TYPE :
595                                CallLog.Calls.INCOMING_TYPE);
596             } else {
597                 callLogType = CallLog.Calls.OUTGOING_TYPE;
598             }
599             if (VDBG) log("- callLogType: " + callLogType + ", UserData: " + c.getUserData());
600
601             // Get the CallerInfo object and then log the call with it.
602             {
603                 Object o = c.getUserData();
604                 final CallerInfo ci;
605                 if ((o == null) || (o instanceof CallerInfo)){
606                     ci = (CallerInfo) o;
607                 } else {
608                     ci = ((PhoneUtils.CallerInfoToken) o).currentInfo;
609                 }
610
611                 // Watch out: Calls.addCall() hits the Contacts database,
612                 // so we shouldn't call it from the main thread.
613                 Thread t = new Thread() {
614                         public void run() {
615                             Calls.addCall(ci, mApplication, number, presentation,
616                                           callLogType, date, (int) duration / 1000);
617                             // if (DBG) log("onDisconnect helper thread: Calls.addCall() done.");
618                         }
619                     };
620                 t.start();
621             }
622
623             if (callLogType == CallLog.Calls.MISSED_TYPE) {
624                 // Show the "Missed call" notification.
625                 // (Note we *don't* do this if this was an incoming call that
626                 // the user deliberately rejected.)
627
628                 PhoneUtils.CallerInfoToken info =
629                         PhoneUtils.startGetCallerInfo(mApplication, c, this, Long.valueOf(date));
630                 if (info != null) {
631                     // at this point, we've requested to start a query, but it makes no
632                     // sense to log this missed call until the query comes back.
633                     if (VDBG) log("onDisconnect: Querying for CallerInfo on missed call...");
634                     if (info.isFinal) {
635                         // it seems that the query we have actually is up to date.
636                         // send the notification then.
637                         CallerInfo ci = info.currentInfo;
638                         NotificationMgr.getDefault().notifyMissedCall(ci.name, ci.phoneNumber,
639                                 ci.phoneLabel, date);
640                     }
641                 } else {
642                     // getCallerInfo() can return null in rare cases, like if we weren't
643                     // able to get a valid phone number out of the specified Connection.
644                     Log.w(LOG_TAG, "onDisconnect: got null CallerInfo for Connection " + c);
645                 }
646             }
647
648             // Possibly play a "post-disconnect tone" thru the earpiece.
649             // We do this here, rather than from the InCallScreen
650             // activity, since we need to do this even if you're not in
651             // the Phone UI at the moment the connection ends.
652             if (toneToPlay != InCallTonePlayer.TONE_NONE) {
653                 if (VDBG) log("- starting post-disconnect tone (" + toneToPlay + ")...");
654                 new InCallTonePlayer(toneToPlay).start();
655                 // The InCallTonePlayer will automatically stop playing (and
656                 // clean itself up) after a few seconds.
657
658                 // TODO: alternatively, we could start an InCallTonePlayer
659                 // here with an "unlimited" tone length,
660                 // and manually stop it later when this connection truly goes
661                 // away.  (The real connection over the network was closed as soon
662                 // as we got the BUSY message.  But our telephony layer keeps the
663                 // connection open for a few extra seconds so we can show the
664                 // "busy" indication to the user.  We could stop the busy tone
665                 // when *that* connection's "disconnect" event comes in.)
666             }
667
668             if (mPhone.getState() == Phone.State.IDLE) {
669                 // Release screen wake locks if the in-call screen is not
670                 // showing. Otherwise, let the in-call screen handle this because
671                 // it needs to show the call ended screen for a couple of
672                 // seconds.
673                 if (!mApplication.isShowingCallScreen()) {
674                     if (VDBG) log("- NOT showing in-call screen; releasing wake locks!");
675                     mApplication.setScreenTimeout(PhoneApp.ScreenTimeoutDuration.DEFAULT);
676                     mApplication.requestWakeState(PhoneApp.WakeState.SLEEP);
677                 } else {
678                     if (VDBG) log("- still showing in-call screen; not releasing wake locks.");
679                 }
680             } else {
681                 if (VDBG) log("- phone still in use; not releasing wake locks.");
682             }
683         }
684     }
685
686     /**
687      * Resets the audio mode and speaker state when a call ends.
688      */
689     private void resetAudioStateAfterDisconnect() {
690         if (VDBG) log("resetAudioStateAfterDisconnect()...");
691
692         if (mBluetoothHandsfree != null) {
693             mBluetoothHandsfree.audioOff();
694         }
695
696         if (PhoneUtils.isSpeakerOn(mPhone.getContext())) {
697             PhoneUtils.turnOnSpeaker(mPhone.getContext(), false);
698         }
699
700         PhoneUtils.setAudioMode(mPhone.getContext(), AudioManager.MODE_NORMAL);
701     }
702
703     private void onMwiChanged(boolean visible) {
704         if (VDBG) log("onMwiChanged(): " + visible);
705         NotificationMgr.getDefault().updateMwi(visible);
706     }
707
708     /**
709      * Posts a delayed PHONE_MWI_CHANGED event, to schedule a "retry" for a
710      * failed NotificationMgr.updateMwi() call.
711      */
712     /* package */ void sendMwiChangedDelayed(long delayMillis) {
713         Message message = Message.obtain(this, PHONE_MWI_CHANGED);
714         sendMessageDelayed(message, delayMillis);
715     }
716
717     private void onCfiChanged(boolean visible) {
718         if (VDBG) log("onCfiChanged(): " + visible);
719         NotificationMgr.getDefault().updateCfi(visible);
720     }
721
722     /**
723      * Indicates whether or not this ringer is ringing.
724      */
725     boolean isRinging() {
726         return mRinger.isRinging();
727     }
728
729     /**
730      * Stops the current ring, and tells the notifier that future
731      * ring requests should be ignored.
732      */
733     void silenceRinger() {
734         mSilentRingerRequested = true;
735         if (DBG) log("stopRing()... (silenceRinger)");
736         mRinger.stopRing();
737     }
738
739     /**
740      * Posts a PHONE_BATTERY_LOW event, causing us to play a warning
741      * tone if the user is in-call.
742      */
743     /* package */ void sendBatteryLow() {
744         Message message = Message.obtain(this, PHONE_BATTERY_LOW);
745         sendMessage(message);
746     }
747
748     private void onBatteryLow() {
749         if (DBG) log("onBatteryLow()...");
750
751         // Play the "low battery" warning tone, only if the user is
752         // in-call.  (The test here is exactly the opposite of the test in
753         // StatusBarPolicy.updateBattery(), where we bring up the "low
754         // battery warning" dialog only if the user is NOT in-call.)
755         if (mPhone.getState() != Phone.State.IDLE) {
756             new InCallTonePlayer(InCallTonePlayer.TONE_BATTERY_LOW).start();
757         }
758     }
759
760
761     /**
762      * Helper class to play tones through the earpiece (or speaker / BT)
763      * during a call, using the ToneGenerator.
764      *
765      * To use, just instantiate a new InCallTonePlayer
766      * (passing in the TONE_* constant for the tone you want)
767      * and start() it.
768      *
769      * When we're done playing the tone, if the phone is idle at that
770      * point, we'll reset the audio routing and speaker state.
771      * (That means that for tones that get played *after* a call
772      * disconnects, like "busy" or "congestion" or "call ended", you
773      * should NOT call resetAudioStateAfterDisconnect() yourself.
774      * Instead, just start the InCallTonePlayer, which will automatically
775      * defer the resetAudioStateAfterDisconnect() call until the tone
776      * finishes playing.)
777      */
778     private class InCallTonePlayer extends Thread {
779         private int mToneId;
780
781         // The possible tones we can play.
782         public static final int TONE_NONE = 0;
783         public static final int TONE_CALL_WAITING = 1;
784         public static final int TONE_BUSY = 2;
785         public static final int TONE_CONGESTION = 3;
786         public static final int TONE_BATTERY_LOW = 4;
787         public static final int TONE_CALL_ENDED = 5;
788
789         // The tone volume relative to other sounds in the stream
790         private static final int TONE_RELATIVE_VOLUME_HIPRI = 80;
791         private static final int TONE_RELATIVE_VOLUME_LOPRI = 50;
792
793         InCallTonePlayer(int toneId) {
794             super();
795             mToneId = toneId;
796         }
797
798         @Override
799         public void run() {
800             if (VDBG) log("InCallTonePlayer.run(toneId = " + mToneId + ")...");
801
802             int toneType;  // passed to ToneGenerator.startTone()
803             int toneVolume;  // passed to the ToneGenerator constructor
804             int toneLengthMillis;
805             switch (mToneId) {
806                 case TONE_CALL_WAITING:
807                     toneType = ToneGenerator.TONE_SUP_CALL_WAITING;
808                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
809                     toneLengthMillis = 5000;
810                     break;
811                 case TONE_BUSY:
812                     toneType = ToneGenerator.TONE_SUP_BUSY;
813                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
814                     toneLengthMillis = 4000;
815                     break;
816                 case TONE_CONGESTION:
817                     toneType = ToneGenerator.TONE_SUP_CONGESTION;
818                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
819                     toneLengthMillis = 4000;
820                     break;
821                 case TONE_BATTERY_LOW:
822                     // For now, use ToneGenerator.TONE_PROP_ACK (two quick
823                     // beeps).  TODO: is there some other ToneGenerator
824                     // tone that would be more appropriate here?  Or
825                     // should we consider adding a new custom tone?
826                     toneType = ToneGenerator.TONE_PROP_ACK;
827                     toneVolume = TONE_RELATIVE_VOLUME_HIPRI;
828                     toneLengthMillis = 1000;
829                     break;
830                 case TONE_CALL_ENDED:
831                     toneType = ToneGenerator.TONE_PROP_PROMPT;
832                     toneVolume = TONE_RELATIVE_VOLUME_LOPRI;
833                     toneLengthMillis = 2000;
834                     break;
835                 default:
836                     throw new IllegalArgumentException("Bad toneId: " + mToneId);
837             }
838
839             // If the mToneGenerator creation fails, just continue without it.  It is
840             // a local audio signal, and is not as important.
841             ToneGenerator toneGenerator;
842             try {
843                 int stream;
844                 if (mBluetoothHandsfree != null) {
845                     stream = mBluetoothHandsfree.isAudioOn() ? AudioManager.STREAM_BLUETOOTH_SCO:
846                         AudioManager.STREAM_VOICE_CALL;
847                 } else {
848                     stream = AudioManager.STREAM_VOICE_CALL;
849                 }
850                 toneGenerator = new ToneGenerator(stream, toneVolume);
851                 // if (DBG) log("- created toneGenerator: " + toneGenerator);
852             } catch (RuntimeException e) {
853                 Log.w(LOG_TAG,
854                       "InCallTonePlayer: Exception caught while creating ToneGenerator: " + e);
855                 toneGenerator = null;
856             }
857
858             // Using the ToneGenerator (with the CALL_WAITING / BUSY /
859             // CONGESTION tones at least), the ToneGenerator itself knows
860             // the right pattern of tones to play; we do NOT need to
861             // manually start/stop each individual tone, or manually
862             // insert the correct delay between tones.  (We just start it
863             // and let it run for however long we want the tone pattern to
864             // continue.)
865             //
866             // TODO: When we stop the ToneGenerator in the middle of a
867             // "tone pattern", it sounds bad if we cut if off while the
868             // tone is actually playing.  Consider adding API to the
869             // ToneGenerator to say "stop at the next silent part of the
870             // pattern", or simply "play the pattern N times and then
871             // stop."
872
873             if (toneGenerator != null) {
874                 toneGenerator.startTone(toneType);
875                 SystemClock.sleep(toneLengthMillis);
876                 toneGenerator.stopTone();
877
878                 // if (DBG) log("- InCallTonePlayer: done playing.");
879                 toneGenerator.release();
880             }
881
882             // Finally, do the same cleanup we otherwise would have done
883             // in onDisconnect().
884             //
885             // (But watch out: do NOT do this if the phone is in use,
886             // since some of our tones get played *during* a call (like
887             // CALL_WAITING and BATTERY_LOW) and we definitely *don't*
888             // want to reset the audio mode / speaker / bluetooth after
889             // playing those!
890             // This call is really here for use with tones that get played
891             // *after* a call disconnects, like "busy" or "congestion" or
892             // "call ended", where the phone has already become idle but
893             // we need to defer the resetAudioStateAfterDisconnect() call
894             // till the tone finishes playing.)
895             if (mPhone.getState() == Phone.State.IDLE) {
896                 resetAudioStateAfterDisconnect();
897             }
898         }
899     }
900
901
902     private void log(String msg) {
903         Log.d(LOG_TAG, msg);
904     }
905 }