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
|
/*
* Copyright (C) 2017 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.phonenumberproto;
import android.support.annotation.AnyThread;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.WorkerThread;
import android.telephony.PhoneNumberUtils;
import com.android.dialer.DialerInternalPhoneNumber;
import com.android.dialer.DialerPhoneNumber;
import com.android.dialer.DialerPhoneNumber.RawInput;
import com.android.dialer.common.Assert;
import com.android.dialer.common.LogUtil;
import com.google.common.base.Optional;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.i18n.phonenumbers.NumberParseException;
import com.google.i18n.phonenumbers.PhoneNumberUtil;
import com.google.i18n.phonenumbers.PhoneNumberUtil.MatchType;
import com.google.i18n.phonenumbers.PhoneNumberUtil.PhoneNumberFormat;
import com.google.i18n.phonenumbers.Phonenumber.PhoneNumber;
/**
* Wrapper for selected methods in {@link PhoneNumberUtil} which uses the {@link DialerPhoneNumber}
* lite proto instead of the {@link com.google.i18n.phonenumbers.Phonenumber.PhoneNumber} POJO.
*
* <p>All methods should be called on a worker thread.
*/
public class DialerPhoneNumberUtil {
private final PhoneNumberUtil phoneNumberUtil;
@WorkerThread
public DialerPhoneNumberUtil(@NonNull PhoneNumberUtil phoneNumberUtil) {
Assert.isWorkerThread();
this.phoneNumberUtil = Assert.isNotNull(phoneNumberUtil);
}
/**
* Parses the provided raw phone number into a {@link DialerPhoneNumber}.
*
* @see PhoneNumberUtil#parse(CharSequence, String)
*/
@WorkerThread
public DialerPhoneNumber parse(@Nullable String numberToParse, @Nullable String defaultRegion) {
Assert.isWorkerThread();
DialerPhoneNumber.Builder dialerPhoneNumber = DialerPhoneNumber.newBuilder();
RawInput.Builder rawInput = RawInput.newBuilder();
// Numbers can be null or empty for incoming "unknown" calls.
if (numberToParse != null) {
rawInput.setNumber(numberToParse);
}
if (defaultRegion != null) {
rawInput.setCountryIso(defaultRegion);
}
dialerPhoneNumber.setRawInput(rawInput.build());
// If the number is a service number, just store the raw input and don't bother trying to parse
// it. PhoneNumberUtil#parse ignores these characters which can lead to confusing behavior, such
// as the numbers "#123" and "123" being considered the same. The "#" can appear in the middle
// of a service number and the "*" can appear at the beginning (see a bug).
if (numberToParse != null && (numberToParse.contains("#") || numberToParse.startsWith("*"))) {
return dialerPhoneNumber.build();
}
try {
dialerPhoneNumber.setDialerInternalPhoneNumber(
Converter.pojoToProto(phoneNumberUtil.parse(numberToParse, defaultRegion)));
} catch (NumberParseException e) {
LogUtil.w("DialerPhoneNumberUtil.parse", "couldn't parse phone number", e);
}
return dialerPhoneNumber.build();
}
/**
* Parses the provided raw phone number into a Future result of {@link DialerPhoneNumber}.
*
* <p>Work is run on the provided {@link ListeningExecutorService}.
*
* @see PhoneNumberUtil#parse(CharSequence, String)
*/
@AnyThread
public ListenableFuture<DialerPhoneNumber> parse(
@Nullable String numberToParse,
@Nullable String defaultRegion,
@NonNull ListeningExecutorService service) {
return service.submit(() -> parse(numberToParse, defaultRegion));
}
/**
* Returns true if the two numbers:
*
* <ul>
* <li>were parseable by libphonenumber (see {@link #parse(String, String)}),
* <li>are a {@link MatchType#SHORT_NSN_MATCH}, {@link MatchType#NSN_MATCH}, or {@link
* MatchType#EXACT_MATCH}, and
* <li>have the same post-dial digits.
* </ul>
*
* <p>If either number is not parseable, returns true if their raw inputs have the same network
* and post-dial portions.
*
* <p>An empty number is never considered to match another number.
*
* @see PhoneNumberUtil#isNumberMatch(PhoneNumber, PhoneNumber)
*/
@WorkerThread
public boolean isMatch(
@NonNull DialerPhoneNumber firstNumberIn, @NonNull DialerPhoneNumber secondNumberIn) {
Assert.isWorkerThread();
if (!Assert.isNotNull(firstNumberIn).hasDialerInternalPhoneNumber()
|| !Assert.isNotNull(secondNumberIn).hasDialerInternalPhoneNumber()) {
// An empty number should not be combined with any other number.
if (firstNumberIn.getRawInput().getNumber().isEmpty()
|| secondNumberIn.getRawInput().getNumber().isEmpty()) {
return false;
}
// Both the network and post-dial portions of the number should match.
return sameNetworkPortion(firstNumberIn, secondNumberIn)
&& samePostDialPortion(firstNumberIn, secondNumberIn);
}
MatchType matchType =
isNumberMatch(
firstNumberIn.getDialerInternalPhoneNumber(),
secondNumberIn.getDialerInternalPhoneNumber());
return (matchType == MatchType.SHORT_NSN_MATCH
|| matchType == MatchType.NSN_MATCH
|| matchType == MatchType.EXACT_MATCH)
&& samePostDialPortion(firstNumberIn, secondNumberIn);
}
private static boolean sameNetworkPortion(DialerPhoneNumber number1, DialerPhoneNumber number2) {
return PhoneNumberUtils.extractNetworkPortion(number1.getRawInput().getNumber())
.equals(PhoneNumberUtils.extractNetworkPortion(number2.getRawInput().getNumber()));
}
private static boolean samePostDialPortion(DialerPhoneNumber number1, DialerPhoneNumber number2) {
return PhoneNumberUtils.extractPostDialPortion(number1.getRawInput().getNumber())
.equals(PhoneNumberUtils.extractPostDialPortion(number2.getRawInput().getNumber()));
}
/**
* Compares the provided phone numbers.
*
* @see PhoneNumberUtil#isNumberMatch(com.google.i18n.phonenumbers.Phonenumber.PhoneNumber,
* com.google.i18n.phonenumbers.Phonenumber.PhoneNumber)
*/
@WorkerThread
private MatchType isNumberMatch(
@NonNull DialerInternalPhoneNumber firstNumberIn,
@NonNull DialerInternalPhoneNumber secondNumberIn) {
Assert.isWorkerThread();
return phoneNumberUtil.isNumberMatch(
Converter.protoToPojo(Assert.isNotNull(firstNumberIn)),
Converter.protoToPojo(Assert.isNotNull(secondNumberIn)));
}
/**
* Formats the provided number to E164 format or return a normalized version of the raw number if
* the number is not valid according to {@link PhoneNumberUtil#isValidNumber(PhoneNumber)}.
*
* @see #formatToValidE164(DialerPhoneNumber)
* @see PhoneNumberUtils#normalizeNumber(String)
*/
@WorkerThread
public String normalizeNumber(DialerPhoneNumber number) {
Assert.isWorkerThread();
// TODO(zachh): This loses country info when number is not valid.
return formatToValidE164(number)
.or(PhoneNumberUtils.normalizeNumber(number.getRawInput().getNumber()));
}
/**
* If the provided number is "valid" (see {@link PhoneNumberUtil#isValidNumber(PhoneNumber)}),
* formats it to E.164. Otherwise, returns {@link Optional#absent()}.
*
* <p>This method is analogous to {@link PhoneNumberUtils#formatNumberToE164(String, String)} (but
* works with an already parsed {@link DialerPhoneNumber} object).
*
* @see PhoneNumberUtil#isValidNumber(PhoneNumber)
* @see PhoneNumberUtil#format(PhoneNumber, PhoneNumberFormat)
* @see PhoneNumberUtils#formatNumberToE164(String, String)
*/
@WorkerThread
public Optional<String> formatToValidE164(DialerPhoneNumber number) {
Assert.isWorkerThread();
if (number.hasDialerInternalPhoneNumber()) {
PhoneNumber phoneNumber = Converter.protoToPojo(number.getDialerInternalPhoneNumber());
if (phoneNumberUtil.isValidNumber(phoneNumber)) {
return Optional.fromNullable(phoneNumberUtil.format(phoneNumber, PhoneNumberFormat.E164));
}
}
return Optional.absent();
}
}
|
