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