1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
|
/*
* Copyright (C) 2013 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.android.incallui;
import com.google.android.collect.Sets;
import com.google.common.base.Preconditions;
import android.content.Context;
import android.content.Intent;
import com.android.services.telephony.common.Call;
import java.util.Set;
/**
* Takes updates from the CallList and notifies the InCallActivity (UI)
* of the changes.
* Responsible for starting the activity for a new call and finishing the activity when all calls
* are disconnected.
* Creates and manages the in-call state and provides a listener pattern for the presenters
* that want to listen in on the in-call state changes.
* TODO(klp): This class has become more of a state machine at this point. Consider renaming.
*/
public class InCallPresenter implements CallList.Listener {
private static InCallPresenter sInCallPresenter;
private final Set<InCallStateListener> mListeners = Sets.newHashSet();
private AudioModeProvider mAudioModeProvider;
private StatusBarNotifier mStatusBarNotifier;
private ContactInfoCache mContactInfoCache;
private Context mContext;
private CallList mCallList;
private InCallActivity mInCallActivity;
private boolean mServiceConnected = false;
private InCallState mInCallState = InCallState.HIDDEN;
private ProximitySensor mProximitySensor;
public static synchronized InCallPresenter getInstance() {
if (sInCallPresenter == null) {
sInCallPresenter = new InCallPresenter();
}
return sInCallPresenter;
}
public void setUp(Context context, CallList callList, AudioModeProvider audioModeProvider) {
Preconditions.checkNotNull(context);
mContext = context;
mCallList = callList;
mCallList.addListener(this);
mContactInfoCache = new ContactInfoCache(context);
mStatusBarNotifier = new StatusBarNotifier(context, mContactInfoCache, mCallList);
addListener(mStatusBarNotifier);
mAudioModeProvider = audioModeProvider;
// This only gets called by the service so this is okay.
mServiceConnected = true;
mProximitySensor = new ProximitySensor(context, mAudioModeProvider);
addListener(mProximitySensor);
Log.d(this, "Finished InCallPresenter.setUp");
}
/**
* Called when the telephony service has disconnected from us. This will happen when there are
* no more active calls. However, we may still want to continue showing the UI for
* certain cases like showing "Call Ended".
* What we really want is to wait for the activity and the service to both disconnect before we
* tear things down. This method sets a serviceConnected boolean and calls a secondary method
* that performs the aforementioned logic.
*/
public void tearDown() {
Log.d(this, "tearDown");
mServiceConnected = false;
attemptCleanup();
}
/**
* Called when the UI begins or ends. Starts the callstate callbacks if the UI just began.
* Attempts to tear down everything if the UI just ended. See #tearDown for more insight on
* the tear-down process.
*/
public void setActivity(InCallActivity inCallActivity) {
mInCallActivity = inCallActivity;
if (mInCallActivity != null) {
Log.d(this, "UI Initialized");
// Since the UI just came up, imitate an update from the call list
// to set the proper UI state.
onCallListChange(mCallList);
} else {
Log.d(this, "setActivity(null)");
attemptCleanup();
}
}
/**
* Called when there is a change to the call list.
* Sets the In-Call state for the entire in-call app based on the information it gets from
* CallList. Dispatches the in-call state to all listeners. Can trigger the creation or
* destruction of the UI based on the states that is calculates.
*/
@Override
public void onCallListChange(CallList callList) {
InCallState newState = getPotentialStateFromCallList(callList);
newState = startOrFinishUi(newState);
// Set the new state before announcing it to the world
mInCallState = newState;
// notify listeners of new state
for (InCallStateListener listener : mListeners) {
Log.d(this, "Notify " + listener + " of state " + mInCallState.toString());
listener.onStateChange(mInCallState, callList);
}
}
/**
* Given the call list, return the state in which the in-call screen should be.
*/
public static InCallState getPotentialStateFromCallList(CallList callList) {
InCallState newState = InCallState.HIDDEN;
if (callList.getIncomingCall() != null) {
newState = InCallState.INCOMING;
} else if (callList.getOutgoingCall() != null) {
newState = InCallState.OUTGOING;
} else if (callList.getActiveCall() != null ||
callList.getBackgroundCall() != null ||
callList.getDisconnectedCall() != null) {
newState = InCallState.INCALL;
}
return newState;
}
public void addListener(InCallStateListener listener) {
Preconditions.checkNotNull(listener);
mListeners.add(listener);
}
public void removeListener(InCallStateListener listener) {
Preconditions.checkNotNull(listener);
mListeners.remove(listener);
}
public AudioModeProvider getAudioModeProvider() {
return mAudioModeProvider;
}
public ContactInfoCache getContactInfoCache() {
return mContactInfoCache;
}
public ProximitySensor getProximitySensor() {
return mProximitySensor;
}
/**
* Hangs up any active or outgoing calls.
*/
public void hangUpOngoingCall() {
Call call = mCallList.getOutgoingCall();
if (call == null) {
call = mCallList.getActiveOrBackgroundCall();
}
if (call != null) {
CallCommandClient.getInstance().disconnectCall(call.getCallId());
}
}
/**
* Returns true if the incall app is the foreground application.
*/
public boolean isShowingInCallUi() {
return (mInCallActivity != null &&
mInCallActivity.isForegroundActivity());
}
/**
* Called when the activity goes out of the foreground.
*/
public void onUiShowing(boolean showing) {
// We need to update the notification bar when we leave the UI because that
// could trigger it to show again.
if (mStatusBarNotifier != null) {
mStatusBarNotifier.updateNotification(mInCallState, mCallList);
}
if (mProximitySensor != null) {
mProximitySensor.onInCallShowing(showing);
}
}
/**
* When the state of in-call changes, this is the first method to get called. It determines if
* the UI needs to be started or finished depending on the new state and does it.
*/
private InCallState startOrFinishUi(InCallState newState) {
Log.d(this, "startOrFinishUi: " + newState.toString());
// TODO(klp): Consider a proper state machine implementation
// If the state isn't changing, we have already done any starting/stopping of
// activities in a previous pass...so lets cut out early
if (newState == mInCallState) {
return newState;
}
// A new Incoming call means that the user needs to be notified of the the call (since
// it wasn't them who initiated it). We do this through full screen notifications and
// happens indirectly through {@link StatusBarListener}.
//
// The process for incoming calls is as follows:
//
// 1) CallList - Announces existence of new INCOMING call
// 2) InCallPresenter - Gets announcement and calculates that the new InCallState
// - should be set to INCOMING.
// 3) InCallPresenter - This method is called to see if we need to start or finish
// the app given the new state.
// 4) StatusBarNotifier - Listens to InCallState changes. InCallPresenter calls
// StatusBarNotifier explicitly to issue a FullScreen Notification
// that will either start the InCallActivity or show the user a
// top-level notification dialog if the user is in an immersive app.
// That notification can also start the InCallActivity.
// 5) InCallActivity - Main activity starts up and at the end of its onCreate will
// call InCallPresenter::setActivity() to let the presenter
// know that start-up is complete.
//
// [ AND NOW YOU'RE IN THE CALL. voila! ]
//
// Our app is started using a fullScreen notification. We need to do this whenever
// we get an incoming call or if this is the first time we are displaying (the previous
// state was HIDDEN).
final boolean startStartupSequence = (InCallState.INCOMING == newState ||
InCallState.HIDDEN == mInCallState);
// A new outgoing call indicates that the user just now dialed a number and when that
// happens we need to display the screen immediateley.
//
// This is different from the incoming call sequence because we do not need to shock the
// user with a top-level notification. Just show the call UI normally.
final boolean showCallUi = (InCallState.OUTGOING == newState);
Log.v(this, "showCallUi: ", showCallUi);
Log.v(this, "startStartupSequence: ", startStartupSequence);
if (showCallUi) {
showInCall();
} else if (startStartupSequence) {
mStatusBarNotifier.updateNotificationAndLaunchIncomingCallUi(newState, mCallList);
} else if (newState == InCallState.HIDDEN) {
// The new state is the hidden state (no calls). Tear everything down.
if (mInCallActivity != null) {
// Null out reference before we start end sequence
InCallActivity temp = mInCallActivity;
mInCallActivity = null;
temp.finish();
// blow away stale contact info so that we get fresh data on
// the next set of calls
mContactInfoCache.clearCache();
}
}
return newState;
}
/**
* Checks to see if both the UI is gone and the service is disconnected. If so, tear it all
* down.
*/
private void attemptCleanup() {
if (mInCallActivity == null && !mServiceConnected) {
Log.d(this, "Start InCallPresenter.CleanUp");
mProximitySensor = null;
mAudioModeProvider = null;
removeListener(mStatusBarNotifier);
mStatusBarNotifier = null;
mCallList.removeListener(this);
mCallList = null;
mContext = null;
mInCallActivity = null;
mListeners.clear();
Log.d(this, "Finished InCallPresenter.CleanUp");
}
}
private void showInCall() {
Log.d(this, "Showing in call manually.");
mContext.startActivity(getInCallIntent());
}
private Intent getInCallIntent() {
final Intent intent = new Intent(Intent.ACTION_MAIN, null);
intent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK
| Intent.FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
| Intent.FLAG_ACTIVITY_NO_USER_ACTION);
intent.setClass(mContext, InCallActivity.class);
return intent;
}
/**
* Private constructor. Must use getInstance() to get this singleton.
*/
private InCallPresenter() {
}
/**
* All the main states of InCallActivity.
*/
public enum InCallState {
// InCall Screen is off and there are no calls
HIDDEN,
// Incoming-call screen is up
INCOMING,
// In-call experience is showing
INCALL,
// User is dialing out
OUTGOING;
public boolean isIncoming() {
return (this == INCOMING);
}
public boolean isHidden() {
return (this == HIDDEN);
}
public boolean isConnectingOrConnected() {
return (this == INCOMING ||
this == OUTGOING ||
this == INCALL);
}
}
/**
* Interface implemented by classes that need to know about the InCall State.
*/
public interface InCallStateListener {
// TODO(klp): Enhance state to contain the call objects instead of passing CallList
public void onStateChange(InCallState state, CallList callList);
}
}
|