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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
|
/*
* Copyright (C) 2006 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 android.content.Context;
import android.database.Cursor;
import android.graphics.Bitmap;
import android.graphics.drawable.Drawable;
import android.net.Uri;
import android.os.Build.VERSION;
import android.os.Build.VERSION_CODES;
import android.provider.ContactsContract;
import android.provider.ContactsContract.CommonDataKinds.Phone;
import android.provider.ContactsContract.Contacts;
import android.provider.ContactsContract.Data;
import android.provider.ContactsContract.PhoneLookup;
import android.provider.ContactsContract.RawContacts;
import android.support.annotation.RequiresApi;
import android.telephony.PhoneNumberUtils;
import android.text.TextUtils;
import com.android.contacts.common.ContactsUtils;
import com.android.contacts.common.ContactsUtils.UserType;
import com.android.contacts.common.util.TelephonyManagerUtils;
import com.android.dialer.phonenumbercache.ContactInfoHelper;
import com.android.dialer.phonenumbercache.PhoneLookupUtil;
import com.android.dialer.phonenumberutil.PhoneNumberHelper;
/**
* Looks up caller information for the given phone number. This is intermediate data and should NOT
* be used by any UI.
*/
public class CallerInfo {
private static final String TAG = "CallerInfo";
// We should always use this projection starting from N onward.
@RequiresApi(VERSION_CODES.N)
private static final String[] DEFAULT_PHONELOOKUP_PROJECTION =
new String[] {
PhoneLookup.CONTACT_ID,
PhoneLookup.DISPLAY_NAME,
PhoneLookup.LOOKUP_KEY,
PhoneLookup.NUMBER,
PhoneLookup.NORMALIZED_NUMBER,
PhoneLookup.LABEL,
PhoneLookup.TYPE,
PhoneLookup.PHOTO_URI,
PhoneLookup.CUSTOM_RINGTONE,
PhoneLookup.SEND_TO_VOICEMAIL
};
// In pre-N, contact id is stored in {@link PhoneLookup._ID} in non-sip query.
private static final String[] BACKWARD_COMPATIBLE_NON_SIP_DEFAULT_PHONELOOKUP_PROJECTION =
new String[] {
PhoneLookup._ID,
PhoneLookup.DISPLAY_NAME,
PhoneLookup.LOOKUP_KEY,
PhoneLookup.NUMBER,
PhoneLookup.NORMALIZED_NUMBER,
PhoneLookup.LABEL,
PhoneLookup.TYPE,
PhoneLookup.PHOTO_URI,
PhoneLookup.CUSTOM_RINGTONE,
PhoneLookup.SEND_TO_VOICEMAIL
};
/**
* Please note that, any one of these member variables can be null, and any accesses to them
* should be prepared to handle such a case.
*
* <p>Also, it is implied that phoneNumber is more often populated than name is, (think of calls
* being dialed/received using numbers where names are not known to the device), so phoneNumber
* should serve as a dependable fallback when name is unavailable.
*
* <p>One other detail here is that this CallerInfo object reflects information found on a
* connection, it is an OUTPUT that serves mainly to display information to the user. In no way is
* this object used as input to make a connection, so we can choose to display whatever
* human-readable text makes sense to the user for a connection. This is especially relevant for
* the phone number field, since it is the one field that is most likely exposed to the user.
*
* <p>As an example: 1. User dials "911" 2. Device recognizes that this is an emergency number 3.
* We use the "Emergency Number" string instead of "911" in the phoneNumber field.
*
* <p>What we're really doing here is treating phoneNumber as an essential field here, NOT name.
* We're NOT always guaranteed to have a name for a connection, but the number should be
* displayable.
*/
public String name;
public String nameAlternative;
public String phoneNumber;
public String normalizedNumber;
public String forwardingNumber;
public String geoDescription;
boolean shouldShowGeoDescription;
public String cnapName;
public int numberPresentation;
public int namePresentation;
public boolean contactExists;
public String phoneLabel;
/* Split up the phoneLabel into number type and label name */
public int numberType;
public String numberLabel;
public int photoResource;
// Contact ID, which will be 0 if a contact comes from the corp CP2.
public long contactIdOrZero;
public String lookupKeyOrNull;
public boolean needUpdate;
public Uri contactRefUri;
public @UserType long userType;
/**
* Contact display photo URI. If a contact has no display photo but a thumbnail, it'll be the
* thumbnail URI instead.
*/
public Uri contactDisplayPhotoUri;
// fields to hold individual contact preference data,
// including the send to voicemail flag and the ringtone
// uri reference.
public Uri contactRingtoneUri;
public boolean shouldSendToVoicemail;
/**
* Drawable representing the caller image. This is essentially a cache for the image data tied
* into the connection / callerinfo object.
*
* <p>This might be a high resolution picture which is more suitable for full-screen image view
* than for smaller icons used in some kinds of notifications.
*
* <p>The {@link #isCachedPhotoCurrent} flag indicates if the image data needs to be reloaded.
*/
public Drawable cachedPhoto;
/**
* Bitmap representing the caller image which has possibly lower resolution than {@link
* #cachedPhoto} and thus more suitable for icons (like notification icons).
*
* <p>In usual cases this is just down-scaled image of {@link #cachedPhoto}. If the down-scaling
* fails, this will just become null.
*
* <p>The {@link #isCachedPhotoCurrent} flag indicates if the image data needs to be reloaded.
*/
public Bitmap cachedPhotoIcon;
/**
* Boolean which indicates if {@link #cachedPhoto} and {@link #cachedPhotoIcon} is fresh enough.
* If it is false, those images aren't pointing to valid objects.
*/
public boolean isCachedPhotoCurrent;
/**
* String which holds the call subject sent as extra from the lower layers for this call. This is
* used to display the no-caller ID reason for restricted/unknown number presentation.
*/
public String callSubject;
public String countryIso;
private boolean mIsEmergency;
private boolean mIsVoiceMail;
public CallerInfo() {
// TODO: Move all the basic initialization here?
mIsEmergency = false;
mIsVoiceMail = false;
userType = ContactsUtils.USER_TYPE_CURRENT;
}
public static String[] getDefaultPhoneLookupProjection(Uri phoneLookupUri) {
if (VERSION.SDK_INT >= VERSION_CODES.N) {
return DEFAULT_PHONELOOKUP_PROJECTION;
}
// Pre-N
boolean isSip =
phoneLookupUri.getBooleanQueryParameter(
ContactsContract.PhoneLookup.QUERY_PARAMETER_SIP_ADDRESS, false);
return (isSip)
? DEFAULT_PHONELOOKUP_PROJECTION
: BACKWARD_COMPATIBLE_NON_SIP_DEFAULT_PHONELOOKUP_PROJECTION;
}
/**
* getCallerInfo given a Cursor.
*
* @param context the context used to retrieve string constants
* @param contactRef the URI to attach to this CallerInfo object
* @param cursor the first object in the cursor is used to build the CallerInfo object.
* @return the CallerInfo which contains the caller id for the given number. The returned
* CallerInfo is null if no number is supplied.
*/
public static CallerInfo getCallerInfo(Context context, Uri contactRef, Cursor cursor) {
CallerInfo info = new CallerInfo();
info.photoResource = 0;
info.phoneLabel = null;
info.numberType = 0;
info.numberLabel = null;
info.cachedPhoto = null;
info.isCachedPhotoCurrent = false;
info.contactExists = false;
info.userType = ContactsUtils.USER_TYPE_CURRENT;
Log.v(TAG, "getCallerInfo() based on cursor...");
if (cursor != null) {
if (cursor.moveToFirst()) {
// TODO: photo_id is always available but not taken
// care of here. Maybe we should store it in the
// CallerInfo object as well.
long contactId = 0L;
int columnIndex;
// Look for the name
columnIndex = cursor.getColumnIndex(PhoneLookup.DISPLAY_NAME);
if (columnIndex != -1) {
info.name = cursor.getString(columnIndex);
}
// Look for the number
columnIndex = cursor.getColumnIndex(PhoneLookup.NUMBER);
if (columnIndex != -1) {
info.phoneNumber = cursor.getString(columnIndex);
}
// Look for the normalized number
columnIndex = cursor.getColumnIndex(PhoneLookup.NORMALIZED_NUMBER);
if (columnIndex != -1) {
info.normalizedNumber = cursor.getString(columnIndex);
}
// Look for the label/type combo
columnIndex = cursor.getColumnIndex(PhoneLookup.LABEL);
if (columnIndex != -1) {
int typeColumnIndex = cursor.getColumnIndex(PhoneLookup.TYPE);
if (typeColumnIndex != -1) {
info.numberType = cursor.getInt(typeColumnIndex);
info.numberLabel = cursor.getString(columnIndex);
info.phoneLabel =
Phone.getTypeLabel(context.getResources(), info.numberType, info.numberLabel)
.toString();
}
}
// cache the lookup key for later use to create lookup URIs
columnIndex = cursor.getColumnIndex(PhoneLookup.LOOKUP_KEY);
if (columnIndex != -1) {
info.lookupKeyOrNull = cursor.getString(columnIndex);
}
// Look for the person_id.
columnIndex = getColumnIndexForPersonId(contactRef, cursor);
if (columnIndex != -1) {
contactId = cursor.getLong(columnIndex);
// QuickContacts in M doesn't support enterprise contact id
if (contactId != 0
&& (VERSION.SDK_INT >= VERSION_CODES.N
|| !Contacts.isEnterpriseContactId(contactId))) {
info.contactIdOrZero = contactId;
Log.v(TAG, "==> got info.contactIdOrZero: " + info.contactIdOrZero);
}
} else {
// No valid columnIndex, so we can't look up person_id.
Log.v(TAG, "Couldn't find contactId column for " + contactRef);
// Watch out: this means that anything that depends on
// person_id will be broken (like contact photo lookups in
// the in-call UI, for example.)
}
// Display photo URI.
columnIndex = cursor.getColumnIndex(PhoneLookup.PHOTO_URI);
if ((columnIndex != -1) && (cursor.getString(columnIndex) != null)) {
info.contactDisplayPhotoUri = Uri.parse(cursor.getString(columnIndex));
} else {
info.contactDisplayPhotoUri = null;
}
// look for the custom ringtone, create from the string stored
// in the database.
columnIndex = cursor.getColumnIndex(PhoneLookup.CUSTOM_RINGTONE);
if ((columnIndex != -1) && (cursor.getString(columnIndex) != null)) {
if (TextUtils.isEmpty(cursor.getString(columnIndex))) {
// make it consistent with frameworks/base/.../CallerInfo.java
info.contactRingtoneUri = Uri.EMPTY;
} else {
info.contactRingtoneUri = Uri.parse(cursor.getString(columnIndex));
}
} else {
info.contactRingtoneUri = null;
}
// look for the send to voicemail flag, set it to true only
// under certain circumstances.
columnIndex = cursor.getColumnIndex(PhoneLookup.SEND_TO_VOICEMAIL);
info.shouldSendToVoicemail = (columnIndex != -1) && ((cursor.getInt(columnIndex)) == 1);
info.contactExists = true;
// Determine userType by directoryId and contactId
final String directory =
contactRef == null
? null
: contactRef.getQueryParameter(ContactsContract.DIRECTORY_PARAM_KEY);
Long directoryId = null;
if (directory != null) {
try {
directoryId = Long.parseLong(directory);
} catch (NumberFormatException e) {
// do nothing
}
}
info.userType = ContactsUtils.determineUserType(directoryId, contactId);
info.nameAlternative =
ContactInfoHelper.lookUpDisplayNameAlternative(
context, info.lookupKeyOrNull, info.userType, directoryId);
}
cursor.close();
}
info.needUpdate = false;
info.name = normalize(info.name);
info.contactRefUri = contactRef;
return info;
}
/**
* getCallerInfo given a URI, look up in the call-log database for the uri unique key.
*
* @param context the context used to get the ContentResolver
* @param contactRef the URI used to lookup caller id
* @return the CallerInfo which contains the caller id for the given number. The returned
* CallerInfo is null if no number is supplied.
*/
private static CallerInfo getCallerInfo(Context context, Uri contactRef) {
return getCallerInfo(
context,
contactRef,
context.getContentResolver().query(contactRef, null, null, null, null));
}
/**
* Performs another lookup if previous lookup fails and it's a SIP call and the peer's username is
* all numeric. Look up the username as it could be a PSTN number in the contact database.
*
* @param context the query context
* @param number the original phone number, could be a SIP URI
* @param previousResult the result of previous lookup
* @return previousResult if it's not the case
*/
static CallerInfo doSecondaryLookupIfNecessary(
Context context, String number, CallerInfo previousResult) {
if (!previousResult.contactExists && PhoneNumberHelper.isUriNumber(number)) {
String username = PhoneNumberHelper.getUsernameFromUriNumber(number);
if (PhoneNumberUtils.isGlobalPhoneNumber(username)) {
previousResult =
getCallerInfo(
context,
Uri.withAppendedPath(
PhoneLookup.ENTERPRISE_CONTENT_FILTER_URI, Uri.encode(username)));
}
}
return previousResult;
}
// Accessors
private static String normalize(String s) {
if (s == null || s.length() > 0) {
return s;
} else {
return null;
}
}
/**
* Returns the column index to use to find the "person_id" field in the specified cursor, based on
* the contact URI that was originally queried.
*
* <p>This is a helper function for the getCallerInfo() method that takes a Cursor. Looking up the
* person_id is nontrivial (compared to all the other CallerInfo fields) since the column we need
* to use depends on what query we originally ran.
*
* <p>Watch out: be sure to not do any database access in this method, since it's run from the UI
* thread (see comments below for more info.)
*
* @return the columnIndex to use (with cursor.getLong()) to get the person_id, or -1 if we
* couldn't figure out what colum to use.
* <p>TODO: Add a unittest for this method. (This is a little tricky to test, since we'll need
* a live contacts database to test against, preloaded with at least some phone numbers and
* SIP addresses. And we'll probably have to hardcode the column indexes we expect, so the
* test might break whenever the contacts schema changes. But we can at least make sure we
* handle all the URI patterns we claim to, and that the mime types match what we expect...)
*/
private static int getColumnIndexForPersonId(Uri contactRef, Cursor cursor) {
// TODO: This is pretty ugly now, see bug 2269240 for
// more details. The column to use depends upon the type of URL:
// - content://com.android.contacts/data/phones ==> use the "contact_id" column
// - content://com.android.contacts/phone_lookup ==> use the "_ID" column
// - content://com.android.contacts/data ==> use the "contact_id" column
// If it's none of the above, we leave columnIndex=-1 which means
// that the person_id field will be left unset.
//
// The logic here *used* to be based on the mime type of contactRef
// (for example Phone.CONTENT_ITEM_TYPE would tell us to use the
// RawContacts.CONTACT_ID column). But looking up the mime type requires
// a call to context.getContentResolver().getType(contactRef), which
// isn't safe to do from the UI thread since it can cause an ANR if
// the contacts provider is slow or blocked (like during a sync.)
//
// So instead, figure out the column to use for person_id by just
// looking at the URI itself.
Log.v(TAG, "- getColumnIndexForPersonId: contactRef URI = '" + contactRef + "'...");
// Warning: Do not enable the following logging (due to ANR risk.)
// if (VDBG) Rlog.v(TAG, "- MIME type: "
// + context.getContentResolver().getType(contactRef));
String url = contactRef.toString();
String columnName = null;
if (url.startsWith("content://com.android.contacts/data/phones")) {
// Direct lookup in the Phone table.
// MIME type: Phone.CONTENT_ITEM_TYPE (= "vnd.android.cursor.item/phone_v2")
Log.v(TAG, "'data/phones' URI; using RawContacts.CONTACT_ID");
columnName = RawContacts.CONTACT_ID;
} else if (url.startsWith("content://com.android.contacts/data")) {
// Direct lookup in the Data table.
// MIME type: Data.CONTENT_TYPE (= "vnd.android.cursor.dir/data")
Log.v(TAG, "'data' URI; using Data.CONTACT_ID");
// (Note Data.CONTACT_ID and RawContacts.CONTACT_ID are equivalent.)
columnName = Data.CONTACT_ID;
} else if (url.startsWith("content://com.android.contacts/phone_lookup")) {
// Lookup in the PhoneLookup table, which provides "fuzzy matching"
// for phone numbers.
// MIME type: PhoneLookup.CONTENT_TYPE (= "vnd.android.cursor.dir/phone_lookup")
Log.v(TAG, "'phone_lookup' URI; using PhoneLookup._ID");
columnName = PhoneLookupUtil.getContactIdColumnNameForUri(contactRef);
} else {
Log.v(TAG, "Unexpected prefix for contactRef '" + url + "'");
}
int columnIndex = (columnName != null) ? cursor.getColumnIndex(columnName) : -1;
Log.v(
TAG,
"==> Using column '"
+ columnName
+ "' (columnIndex = "
+ columnIndex
+ ") for person_id lookup...");
return columnIndex;
}
/** @return true if the caller info is an emergency number. */
public boolean isEmergencyNumber() {
return mIsEmergency;
}
/** @return true if the caller info is a voicemail number. */
public boolean isVoiceMailNumber() {
return mIsVoiceMail;
}
/**
* Mark this CallerInfo as an emergency call.
*
* @param context To lookup the localized 'Emergency Number' string.
* @return this instance.
*/
/* package */ CallerInfo markAsEmergency(Context context) {
name = context.getString(R.string.emergency_call_dialog_number_for_display);
phoneNumber = null;
mIsEmergency = true;
return this;
}
/**
* Mark this CallerInfo as a voicemail call. The voicemail label is obtained from the telephony
* manager. Caller must hold the READ_PHONE_STATE permission otherwise the phoneNumber will be set
* to null.
*
* @return this instance.
*/
/* package */ CallerInfo markAsVoiceMail(Context context) {
mIsVoiceMail = true;
try {
// For voicemail calls, we display the voice mail tag
// instead of the real phone number in the "number"
// field.
name = TelephonyManagerUtils.getVoiceMailAlphaTag(context);
phoneNumber = null;
} catch (SecurityException se) {
// Should never happen: if this process does not have
// permission to retrieve VM tag, it should not have
// permission to retrieve VM number and would not call
// this method.
// Leave phoneNumber untouched.
Log.e(TAG, "Cannot access VoiceMail.", se);
}
// TODO: There is no voicemail picture?
// photoResource = android.R.drawable.badge_voicemail;
return this;
}
/**
* Updates this CallerInfo's geoDescription field, based on the raw phone number in the
* phoneNumber field.
*
* <p>(Note that the various getCallerInfo() methods do *not* set the geoDescription
* automatically; you need to call this method explicitly to get it.)
*
* @param context the context used to look up the current locale / country
* @param fallbackNumber if this CallerInfo's phoneNumber field is empty, this specifies a
* fallback number to use instead.
*/
public void updateGeoDescription(Context context, String fallbackNumber) {
String number = TextUtils.isEmpty(phoneNumber) ? fallbackNumber : phoneNumber;
geoDescription = PhoneNumberHelper.getGeoDescription(context, number, countryIso);
}
/** @return a string debug representation of this instance. */
@Override
public String toString() {
// Warning: never check in this file with VERBOSE_DEBUG = true
// because that will result in PII in the system log.
final boolean VERBOSE_DEBUG = false;
if (VERBOSE_DEBUG) {
return new StringBuilder(384)
.append(super.toString() + " { ")
.append("\nname: " + name)
.append("\nphoneNumber: " + phoneNumber)
.append("\nnormalizedNumber: " + normalizedNumber)
.append("\forwardingNumber: " + forwardingNumber)
.append("\ngeoDescription: " + geoDescription)
.append("\ncnapName: " + cnapName)
.append("\nnumberPresentation: " + numberPresentation)
.append("\nnamePresentation: " + namePresentation)
.append("\ncontactExists: " + contactExists)
.append("\nphoneLabel: " + phoneLabel)
.append("\nnumberType: " + numberType)
.append("\nnumberLabel: " + numberLabel)
.append("\nphotoResource: " + photoResource)
.append("\ncontactIdOrZero: " + contactIdOrZero)
.append("\nneedUpdate: " + needUpdate)
.append("\ncontactRefUri: " + contactRefUri)
.append("\ncontactRingtoneUri: " + contactRingtoneUri)
.append("\ncontactDisplayPhotoUri: " + contactDisplayPhotoUri)
.append("\nshouldSendToVoicemail: " + shouldSendToVoicemail)
.append("\ncachedPhoto: " + cachedPhoto)
.append("\nisCachedPhotoCurrent: " + isCachedPhotoCurrent)
.append("\nemergency: " + mIsEmergency)
.append("\nvoicemail: " + mIsVoiceMail)
.append("\nuserType: " + userType)
.append(" }")
.toString();
} else {
return new StringBuilder(128)
.append(super.toString() + " { ")
.append("name " + ((name == null) ? "null" : "non-null"))
.append(", phoneNumber " + ((phoneNumber == null) ? "null" : "non-null"))
.append(" }")
.toString();
}
}
}
|