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