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
|
/*
* Copyright (C) 2018 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.phonelookup.consolidator;
import android.support.annotation.IntDef;
import android.support.annotation.Nullable;
import com.android.dialer.common.Assert;
import com.android.dialer.phonelookup.PhoneLookup;
import com.android.dialer.phonelookup.PhoneLookupInfo;
import com.android.dialer.phonelookup.PhoneLookupInfo.BlockedState;
import com.android.dialer.phonelookup.PhoneLookupInfo.Cp2Info.Cp2ContactInfo;
import com.android.dialer.phonelookup.PhoneLookupInfo.PeopleApiInfo;
import com.android.dialer.phonelookup.PhoneLookupInfo.PeopleApiInfo.InfoType;
import com.google.common.collect.ImmutableList;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
/**
* Consolidates information from a {@link PhoneLookupInfo}.
*
* <p>For example, a single {@link PhoneLookupInfo} may contain different name information from many
* different {@link PhoneLookup} implementations. This class defines the rules for deciding which
* name should be selected for display to the user, by prioritizing the data from some {@link
* PhoneLookup PhoneLookups} over others.
*/
public final class PhoneLookupInfoConsolidator {
/** Integers representing {@link PhoneLookup} implementations that can provide a contact's name */
@Retention(RetentionPolicy.SOURCE)
@IntDef({
NameSource.NONE,
NameSource.CP2_DEFAULT_DIRECTORY,
NameSource.CP2_EXTENDED_DIRECTORY,
NameSource.PEOPLE_API
})
@interface NameSource {
int NONE = 0; // used when none of the other sources can provide the name
int CP2_DEFAULT_DIRECTORY = 1;
int CP2_EXTENDED_DIRECTORY = 2;
int PEOPLE_API = 3;
}
/**
* Sources that can provide information about a contact's name.
*
* <p>Each source is one of the values in NameSource, as defined above.
*
* <p>Sources are sorted in the order of priority. For example, if source CP2_DEFAULT_DIRECTORY
* can provide the name, we will use that name in the UI and ignore all the other sources. If
* source CP2_DEFAULT_DIRECTORY can't provide the name, source CP2_EXTENDED_DIRECTORY will be
* consulted.
*
* <p>The reason for defining a name source is to avoid mixing info from different sub-messages in
* PhoneLookupInfo proto when we are supposed to stick with only one sub-message. For example, if
* a PhoneLookupInfo proto has both default_cp2_info and extended_cp2_info but only
* extended_cp2_info has a photo URI, PhoneLookupInfoConsolidator should provide an empty photo
* URI as CP2_DEFAULT_DIRECTORY has higher priority and we should not use extended_cp2_info's
* photo URI to display the contact's photo.
*/
private static final ImmutableList<Integer> NAME_SOURCES_IN_PRIORITY_ORDER =
ImmutableList.of(
NameSource.CP2_DEFAULT_DIRECTORY,
NameSource.CP2_EXTENDED_DIRECTORY,
NameSource.PEOPLE_API);
private final @NameSource int nameSource;
private final PhoneLookupInfo phoneLookupInfo;
@Nullable private final Cp2ContactInfo firstDefaultCp2Contact;
@Nullable private final Cp2ContactInfo firstExtendedCp2Contact;
public PhoneLookupInfoConsolidator(PhoneLookupInfo phoneLookupInfo) {
this.phoneLookupInfo = phoneLookupInfo;
this.firstDefaultCp2Contact = getFirstContactInDefaultDirectory();
this.firstExtendedCp2Contact = getFirstContactInExtendedDirectories();
this.nameSource = selectNameSource();
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns the name associated with that number.
*
* <p>Examples of this are a local contact's name or a business name received from caller ID.
*
* <p>If no name can be obtained from the {@link PhoneLookupInfo}, an empty string will be
* returned.
*/
public String getName() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Assert.isNotNull(firstDefaultCp2Contact).getName();
case NameSource.CP2_EXTENDED_DIRECTORY:
return Assert.isNotNull(firstExtendedCp2Contact).getName();
case NameSource.PEOPLE_API:
return phoneLookupInfo.getPeopleApiInfo().getDisplayName();
case NameSource.NONE:
return "";
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns the photo thumbnail URI associated with that number.
*
* <p>If no photo thumbnail URI can be obtained from the {@link PhoneLookupInfo}, an empty string
* will be returned.
*/
public String getPhotoThumbnailUri() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Assert.isNotNull(firstDefaultCp2Contact).getPhotoThumbnailUri();
case NameSource.CP2_EXTENDED_DIRECTORY:
return Assert.isNotNull(firstExtendedCp2Contact).getPhotoThumbnailUri();
case NameSource.PEOPLE_API:
case NameSource.NONE:
return "";
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns the photo URI associated with that number.
*
* <p>If no photo URI can be obtained from the {@link PhoneLookupInfo}, an empty string will be
* returned.
*/
public String getPhotoUri() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Assert.isNotNull(firstDefaultCp2Contact).getPhotoUri();
case NameSource.CP2_EXTENDED_DIRECTORY:
return Assert.isNotNull(firstExtendedCp2Contact).getPhotoUri();
case NameSource.PEOPLE_API:
case NameSource.NONE:
return "";
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns the photo ID associated with that number, or 0 if there is none.
*/
public long getPhotoId() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Math.max(Assert.isNotNull(firstDefaultCp2Contact).getPhotoId(), 0);
case NameSource.CP2_EXTENDED_DIRECTORY:
return Math.max(Assert.isNotNull(firstExtendedCp2Contact).getPhotoId(), 0);
case NameSource.PEOPLE_API:
case NameSource.NONE:
return 0;
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns the lookup URI associated with that number, or an empty string if no lookup URI can be
* obtained.
*/
public String getLookupUri() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Assert.isNotNull(firstDefaultCp2Contact).getLookupUri();
case NameSource.CP2_EXTENDED_DIRECTORY:
return Assert.isNotNull(firstExtendedCp2Contact).getLookupUri();
case NameSource.PEOPLE_API:
return Assert.isNotNull(phoneLookupInfo.getPeopleApiInfo().getLookupUri());
case NameSource.NONE:
return "";
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns a localized string representing the number type such as "Home" or "Mobile", or a custom
* value set by the user.
*
* <p>If no label can be obtained from the {@link PhoneLookupInfo}, an empty string will be
* returned.
*/
public String getNumberLabel() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
return Assert.isNotNull(firstDefaultCp2Contact).getLabel();
case NameSource.CP2_EXTENDED_DIRECTORY:
return Assert.isNotNull(firstExtendedCp2Contact).getLabel();
case NameSource.PEOPLE_API:
case NameSource.NONE:
return "";
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns whether the number belongs to a business place.
*/
public boolean isBusiness() {
return phoneLookupInfo.hasPeopleApiInfo()
&& phoneLookupInfo.getPeopleApiInfo().getInfoType() == InfoType.NEARBY_BUSINESS;
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns whether the number is a voicemail number.
*/
public boolean isVoicemail() {
// TODO(twyen): implement
return false;
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns whether the number is blocked.
*/
public boolean isBlocked() {
// If system blocking reported blocked state it always takes priority over the dialer blocking.
// It will be absent if dialer blocking should be used.
if (phoneLookupInfo.getSystemBlockedNumberInfo().hasBlockedState()) {
return phoneLookupInfo
.getSystemBlockedNumberInfo()
.getBlockedState()
.equals(BlockedState.BLOCKED);
}
return phoneLookupInfo
.getDialerBlockedNumberInfo()
.getBlockedState()
.equals(BlockedState.BLOCKED);
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns whether the number is spam.
*/
public boolean isSpam() {
return phoneLookupInfo.getSpamInfo().getIsSpam();
}
/**
* Returns true if the {@link PhoneLookupInfo} passed to the constructor has incomplete default
* CP2 info (info from the default directory).
*/
public boolean isDefaultCp2InfoIncomplete() {
return phoneLookupInfo.getDefaultCp2Info().getIsIncomplete();
}
/**
* The {@link PhoneLookupInfo} passed to the constructor is associated with a number. This method
* returns whether the number can be reported as invalid.
*
* <p>As we currently report invalid numbers via the People API, only numbers from the People API
* can be reported as invalid.
*/
public boolean canReportAsInvalidNumber() {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
case NameSource.CP2_EXTENDED_DIRECTORY:
return false;
case NameSource.PEOPLE_API:
PeopleApiInfo peopleApiInfo = phoneLookupInfo.getPeopleApiInfo();
return peopleApiInfo.getInfoType() != InfoType.UNKNOWN
&& !peopleApiInfo.getPersonId().isEmpty();
case NameSource.NONE:
return false;
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
/**
* Arbitrarily select the first CP2 contact in the default directory. In the future, it may make
* sense to display contact information from all contacts with the same number (for example show
* the name as "Mom, Dad" or show a synthesized photo containing photos of both "Mom" and "Dad").
*/
@Nullable
private Cp2ContactInfo getFirstContactInDefaultDirectory() {
return phoneLookupInfo.getDefaultCp2Info().getCp2ContactInfoCount() > 0
? phoneLookupInfo.getDefaultCp2Info().getCp2ContactInfo(0)
: null;
}
/**
* Arbitrarily select the first CP2 contact in extended directories. In the future, it may make
* sense to display contact information from all contacts with the same number (for example show
* the name as "Mom, Dad" or show a synthesized photo containing photos of both "Mom" and "Dad").
*/
@Nullable
private Cp2ContactInfo getFirstContactInExtendedDirectories() {
return phoneLookupInfo.getExtendedCp2Info().getCp2ContactInfoCount() > 0
? phoneLookupInfo.getExtendedCp2Info().getCp2ContactInfo(0)
: null;
}
/** Select the {@link PhoneLookup} source providing a contact's name. */
private @NameSource int selectNameSource() {
for (int nameSource : NAME_SOURCES_IN_PRIORITY_ORDER) {
switch (nameSource) {
case NameSource.CP2_DEFAULT_DIRECTORY:
if (firstDefaultCp2Contact != null && !firstDefaultCp2Contact.getName().isEmpty()) {
return NameSource.CP2_DEFAULT_DIRECTORY;
}
break;
case NameSource.CP2_EXTENDED_DIRECTORY:
if (firstExtendedCp2Contact != null && !firstExtendedCp2Contact.getName().isEmpty()) {
return NameSource.CP2_EXTENDED_DIRECTORY;
}
break;
case NameSource.PEOPLE_API:
if (phoneLookupInfo.hasPeopleApiInfo()
&& !phoneLookupInfo.getPeopleApiInfo().getDisplayName().isEmpty()) {
return NameSource.PEOPLE_API;
}
break;
default:
throw Assert.createUnsupportedOperationFailException(
String.format("Unsupported name source: %s", nameSource));
}
}
return NameSource.NONE;
}
}
|