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
|
/*
* Copyright (C) 2011 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.dialer.calllog;
import android.content.Context;
import android.database.Cursor;
import android.net.Uri;
import android.provider.ContactsContract;
import android.provider.ContactsContract.CommonDataKinds.Phone;
import android.provider.ContactsContract.Contacts;
import android.provider.ContactsContract.DisplayNameSources;
import android.provider.ContactsContract.PhoneLookup;
import android.telephony.PhoneNumberUtils;
import android.text.TextUtils;
import com.android.contacts.common.util.Constants;
import com.android.contacts.common.util.PhoneNumberHelper;
import com.android.contacts.common.util.UriUtils;
import com.android.dialer.service.CachedNumberLookupService;
import com.android.dialer.service.CachedNumberLookupService.CachedContactInfo;
import com.android.dialerbind.ObjectFactory;
import org.json.JSONException;
import org.json.JSONObject;
import java.util.List;
/**
* Utility class to look up the contact information for a given number.
*/
public class ContactInfoHelper {
private final Context mContext;
private final String mCurrentCountryIso;
private static final CachedNumberLookupService mCachedNumberLookupService =
ObjectFactory.newCachedNumberLookupService();
public ContactInfoHelper(Context context, String currentCountryIso) {
mContext = context;
mCurrentCountryIso = currentCountryIso;
}
/**
* Returns the contact information for the given number.
* <p>
* If the number does not match any contact, returns a contact info containing only the number
* and the formatted number.
* <p>
* If an error occurs during the lookup, it returns null.
*
* @param number the number to look up
* @param countryIso the country associated with this number
*/
public ContactInfo lookupNumber(String number, String countryIso) {
final ContactInfo info;
// Determine the contact info.
if (PhoneNumberHelper.isUriNumber(number)) {
// This "number" is really a SIP address.
ContactInfo sipInfo = queryContactInfoForSipAddress(number);
if (sipInfo == null || sipInfo == ContactInfo.EMPTY) {
// Check whether the "username" part of the SIP address is
// actually the phone number of a contact.
String username = PhoneNumberHelper.getUsernameFromUriNumber(number);
if (PhoneNumberUtils.isGlobalPhoneNumber(username)) {
sipInfo = queryContactInfoForPhoneNumber(username, countryIso);
}
}
info = sipInfo;
} else {
// Look for a contact that has the given phone number.
ContactInfo phoneInfo = queryContactInfoForPhoneNumber(number, countryIso);
if (phoneInfo == null || phoneInfo == ContactInfo.EMPTY) {
// Check whether the phone number has been saved as an "Internet call" number.
phoneInfo = queryContactInfoForSipAddress(number);
}
info = phoneInfo;
}
final ContactInfo updatedInfo;
if (info == null) {
// The lookup failed.
updatedInfo = null;
} else {
// If we did not find a matching contact, generate an empty contact info for the number.
if (info == ContactInfo.EMPTY) {
// Did not find a matching contact.
updatedInfo = new ContactInfo();
updatedInfo.number = number;
updatedInfo.formattedNumber = formatPhoneNumber(number, null, countryIso);
updatedInfo.normalizedNumber = PhoneNumberUtils.formatNumberToE164(
number, countryIso);
updatedInfo.lookupUri = createTemporaryContactUri(updatedInfo.formattedNumber);
} else {
updatedInfo = info;
}
}
return updatedInfo;
}
/**
* Creates a JSON-encoded lookup uri for a unknown number without an associated contact
*
* @param number - Unknown phone number
* @return JSON-encoded URI that can be used to perform a lookup when clicking on the quick
* contact card.
*/
private static Uri createTemporaryContactUri(String number) {
try {
final JSONObject contactRows = new JSONObject().put(Phone.CONTENT_ITEM_TYPE,
new JSONObject().put(Phone.NUMBER, number).put(Phone.TYPE, Phone.TYPE_CUSTOM));
final String jsonString = new JSONObject().put(Contacts.DISPLAY_NAME, number)
.put(Contacts.DISPLAY_NAME_SOURCE, DisplayNameSources.PHONE)
.put(Contacts.CONTENT_ITEM_TYPE, contactRows).toString();
return Contacts.CONTENT_LOOKUP_URI
.buildUpon()
.appendPath(Constants.LOOKUP_URI_ENCODED)
.appendQueryParameter(ContactsContract.DIRECTORY_PARAM_KEY,
String.valueOf(Long.MAX_VALUE))
.encodedFragment(jsonString)
.build();
} catch (JSONException e) {
return null;
}
}
/**
* Looks up a contact using the given URI.
* <p>
* It returns null if an error occurs, {@link ContactInfo#EMPTY} if no matching contact is
* found, or the {@link ContactInfo} for the given contact.
* <p>
* The {@link ContactInfo#formattedNumber} field is always set to {@code null} in the returned
* value.
*/
private ContactInfo lookupContactFromUri(Uri uri) {
final ContactInfo info;
Cursor phonesCursor =
mContext.getContentResolver().query(uri, PhoneQuery._PROJECTION, null, null, null);
if (phonesCursor != null) {
try {
if (phonesCursor.moveToFirst()) {
info = new ContactInfo();
long contactId = phonesCursor.getLong(PhoneQuery.PERSON_ID);
String lookupKey = phonesCursor.getString(PhoneQuery.LOOKUP_KEY);
info.lookupKey = lookupKey;
info.lookupUri = Contacts.getLookupUri(contactId, lookupKey);
info.name = phonesCursor.getString(PhoneQuery.NAME);
info.type = phonesCursor.getInt(PhoneQuery.PHONE_TYPE);
info.label = phonesCursor.getString(PhoneQuery.LABEL);
info.number = phonesCursor.getString(PhoneQuery.MATCHED_NUMBER);
info.normalizedNumber = phonesCursor.getString(PhoneQuery.NORMALIZED_NUMBER);
info.photoId = phonesCursor.getLong(PhoneQuery.PHOTO_ID);
info.photoUri =
UriUtils.parseUriOrNull(phonesCursor.getString(PhoneQuery.PHOTO_URI));
info.formattedNumber = null;
} else {
info = ContactInfo.EMPTY;
}
} finally {
phonesCursor.close();
}
} else {
// Failed to fetch the data, ignore this request.
info = null;
}
return info;
}
/**
* Determines the contact information for the given SIP address.
* <p>
* It returns the contact info if found.
* <p>
* If no contact corresponds to the given SIP address, returns {@link ContactInfo#EMPTY}.
* <p>
* If the lookup fails for some other reason, it returns null.
*/
private ContactInfo queryContactInfoForSipAddress(String sipAddress) {
final ContactInfo info;
// "contactNumber" is a SIP address, so use the PhoneLookup table with the SIP parameter.
Uri.Builder uriBuilder = PhoneLookup.CONTENT_FILTER_URI.buildUpon();
uriBuilder.appendPath(Uri.encode(sipAddress));
uriBuilder.appendQueryParameter(PhoneLookup.QUERY_PARAMETER_SIP_ADDRESS, "1");
return lookupContactFromUri(uriBuilder.build());
}
/**
* Determines the contact information for the given phone number.
* <p>
* It returns the contact info if found.
* <p>
* If no contact corresponds to the given phone number, returns {@link ContactInfo#EMPTY}.
* <p>
* If the lookup fails for some other reason, it returns null.
*/
private ContactInfo queryContactInfoForPhoneNumber(String number, String countryIso) {
String contactNumber = number;
if (!TextUtils.isEmpty(countryIso)) {
// Normalize the number: this is needed because the PhoneLookup query below does not
// accept a country code as an input.
String numberE164 = PhoneNumberUtils.formatNumberToE164(number, countryIso);
if (!TextUtils.isEmpty(numberE164)) {
// Only use it if the number could be formatted to E164.
contactNumber = numberE164;
}
}
// The "contactNumber" is a regular phone number, so use the PhoneLookup table.
Uri uri = Uri.withAppendedPath(PhoneLookup.CONTENT_FILTER_URI, Uri.encode(contactNumber));
ContactInfo info = lookupContactFromUri(uri);
if (info != null && info != ContactInfo.EMPTY) {
info.formattedNumber = formatPhoneNumber(number, null, countryIso);
} else if (mCachedNumberLookupService != null) {
CachedContactInfo cacheInfo =
mCachedNumberLookupService.lookupCachedContactFromNumber(mContext, number);
info = cacheInfo != null ? cacheInfo.getContactInfo() : null;
}
return info;
}
/**
* Format the given phone number
*
* @param number the number to be formatted.
* @param normalizedNumber the normalized number of the given number.
* @param countryIso the ISO 3166-1 two letters country code, the country's convention will be
* used to format the number if the normalized phone is null.
*
* @return the formatted number, or the given number if it was formatted.
*/
private String formatPhoneNumber(String number, String normalizedNumber, String countryIso) {
if (TextUtils.isEmpty(number)) {
return "";
}
// If "number" is really a SIP address, don't try to do any formatting at all.
if (PhoneNumberHelper.isUriNumber(number)) {
return number;
}
if (TextUtils.isEmpty(countryIso)) {
countryIso = mCurrentCountryIso;
}
return PhoneNumberUtils.formatNumber(number, normalizedNumber, countryIso);
}
/**
* Parses the given URI to determine the original lookup key of the contact.
*/
public static String getLookupKeyFromUri(Uri lookupUri) {
// Would be nice to be able to persist the lookup key somehow to avoid having to parse
// the uri entirely just to retrieve the lookup key, but every uri is already parsed
// once anyway to check if it is an encoded JSON uri, so this has negligible effect
// on performance.
if (lookupUri != null && !UriUtils.isEncodedContactUri(lookupUri)) {
final List<String> segments = lookupUri.getPathSegments();
// This returns the third path segment of the uri, where the lookup key is located.
// See {@link android.provider.ContactsContract.Contacts#CONTENT_LOOKUP_URI}.
return (segments.size() < 3) ? null : Uri.encode(segments.get(2));
} else {
return null;
}
}
/**
* Given a contact's sourceType, return true if the contact is a business
*
* @param sourceType sourceType of the contact. This is usually populated by
* {@link #mCachedNumberLookupService}.
*/
public boolean isBusiness(int sourceType) {
return mCachedNumberLookupService != null
&& mCachedNumberLookupService.isBusiness(sourceType);
}
/**
* Given a contact's sourceType, return true if the contact came from an
* external source.
*
* @param sourceType sourceType of the contact. This is usually populated by
* {@link #mCachedNumberLookupService}.
*/
public boolean isExternal(int sourceType) {
return mCachedNumberLookupService != null
&& mCachedNumberLookupService.isExternal(sourceType);
}
}
|