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
|
/*
* Copyright (C) 2015 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.voicemail.impl;
import android.annotation.TargetApi;
import android.app.PendingIntent;
import android.content.Context;
import android.content.pm.ApplicationInfo;
import android.content.pm.PackageManager.NameNotFoundException;
import android.os.Build.VERSION_CODES;
import android.os.Bundle;
import android.os.PersistableBundle;
import android.support.annotation.NonNull;
import android.support.annotation.Nullable;
import android.support.annotation.VisibleForTesting;
import android.telecom.PhoneAccountHandle;
import android.telephony.CarrierConfigManager;
import android.telephony.TelephonyManager;
import android.telephony.VisualVoicemailSmsFilterSettings;
import android.text.TextUtils;
import android.util.ArraySet;
import com.android.dialer.common.Assert;
import com.android.voicemail.impl.configui.ConfigOverrideFragment;
import com.android.voicemail.impl.protocol.VisualVoicemailProtocol;
import com.android.voicemail.impl.protocol.VisualVoicemailProtocolFactory;
import com.android.voicemail.impl.sms.StatusMessage;
import com.android.voicemail.impl.sync.VvmAccountManager;
import java.util.Collections;
import java.util.Set;
/**
* Manages carrier dependent visual voicemail configuration values. The primary source is the value
* retrieved from CarrierConfigManager. If CarrierConfigManager does not provide the config
* (KEY_VVM_TYPE_STRING is empty, or "hidden" configs), then the value hardcoded in telephony will
* be used (in res/xml/vvm_config.xml)
*
* <p>Hidden configs are new configs that are planned for future APIs, or miscellaneous settings
* that may clutter CarrierConfigManager too much.
*
* <p>The current hidden configs are: {@link #getSslPort()} {@link #getDisabledCapabilities()}
*
* <p>TODO(twyen): refactor this to an interface.
*/
@TargetApi(VERSION_CODES.O)
public class OmtpVvmCarrierConfigHelper {
private static final String TAG = "OmtpVvmCarrierCfgHlpr";
public static final String KEY_VVM_TYPE_STRING = CarrierConfigManager.KEY_VVM_TYPE_STRING;
public static final String KEY_VVM_DESTINATION_NUMBER_STRING =
CarrierConfigManager.KEY_VVM_DESTINATION_NUMBER_STRING;
public static final String KEY_VVM_PORT_NUMBER_INT = CarrierConfigManager.KEY_VVM_PORT_NUMBER_INT;
public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING =
CarrierConfigManager.KEY_CARRIER_VVM_PACKAGE_NAME_STRING;
public static final String KEY_CARRIER_VVM_PACKAGE_NAME_STRING_ARRAY =
"carrier_vvm_package_name_string_array";
public static final String KEY_VVM_PREFETCH_BOOL = CarrierConfigManager.KEY_VVM_PREFETCH_BOOL;
public static final String KEY_VVM_CELLULAR_DATA_REQUIRED_BOOL =
CarrierConfigManager.KEY_VVM_CELLULAR_DATA_REQUIRED_BOOL;
/** @see #getSslPort() */
public static final String KEY_VVM_SSL_PORT_NUMBER_INT = "vvm_ssl_port_number_int";
/** @see #isLegacyModeEnabled() */
public static final String KEY_VVM_LEGACY_MODE_ENABLED_BOOL = "vvm_legacy_mode_enabled_bool";
/**
* Ban a capability reported by the server from being used. The array of string should be a subset
* of the capabilities returned IMAP CAPABILITY command.
*
* @see #getDisabledCapabilities()
*/
public static final String KEY_VVM_DISABLED_CAPABILITIES_STRING_ARRAY =
"vvm_disabled_capabilities_string_array";
public static final String KEY_VVM_CLIENT_PREFIX_STRING = "vvm_client_prefix_string";
@Nullable private static PersistableBundle sOverrideConfigForTest;
private final Context mContext;
private final PersistableBundle mCarrierConfig;
private final String mVvmType;
private final VisualVoicemailProtocol mProtocol;
private final PersistableBundle mTelephonyConfig;
@Nullable private final PersistableBundle mOverrideConfig;
private PhoneAccountHandle mPhoneAccountHandle;
public OmtpVvmCarrierConfigHelper(Context context, @Nullable PhoneAccountHandle handle) {
mContext = context;
mPhoneAccountHandle = handle;
TelephonyManager telephonyManager =
context
.getSystemService(TelephonyManager.class)
.createForPhoneAccountHandle(mPhoneAccountHandle);
if (telephonyManager == null) {
VvmLog.e(TAG, "PhoneAccountHandle is invalid");
mCarrierConfig = null;
mTelephonyConfig = null;
mOverrideConfig = null;
mVvmType = null;
mProtocol = null;
return;
}
if (sOverrideConfigForTest != null) {
mOverrideConfig = sOverrideConfigForTest;
mCarrierConfig = new PersistableBundle();
mTelephonyConfig = new PersistableBundle();
} else {
if (ConfigOverrideFragment.isOverridden(context)) {
mOverrideConfig = ConfigOverrideFragment.getConfig(context);
VvmLog.w(TAG, "Config override is activated: " + mOverrideConfig);
} else {
mOverrideConfig = null;
}
mCarrierConfig = getCarrierConfig(telephonyManager);
mTelephonyConfig =
new TelephonyVvmConfigManager(context).getConfig(telephonyManager.getSimOperator());
}
mVvmType = getVvmType();
mProtocol = VisualVoicemailProtocolFactory.create(mContext.getResources(), mVvmType);
}
@VisibleForTesting
OmtpVvmCarrierConfigHelper(
Context context, PersistableBundle carrierConfig, PersistableBundle telephonyConfig) {
mContext = context;
mCarrierConfig = carrierConfig;
mTelephonyConfig = telephonyConfig;
mOverrideConfig = null;
mVvmType = getVvmType();
mProtocol = VisualVoicemailProtocolFactory.create(mContext.getResources(), mVvmType);
}
public PersistableBundle getConfig() {
PersistableBundle result = new PersistableBundle();
if (mTelephonyConfig != null) {
result.putAll(mTelephonyConfig);
}
if (mCarrierConfig != null) {
result.putAll(mCarrierConfig);
}
return result;
}
public Context getContext() {
return mContext;
}
@Nullable
public PhoneAccountHandle getPhoneAccountHandle() {
return mPhoneAccountHandle;
}
/**
* return whether the carrier's visual voicemail is supported, with KEY_VVM_TYPE_STRING set as a
* known protocol.
*/
public boolean isValid() {
if (mProtocol == null) {
return false;
}
if (isCarrierAppPreloaded()) {
return false;
}
return true;
}
@Nullable
public String getVvmType() {
return (String) getValue(KEY_VVM_TYPE_STRING);
}
@Nullable
public VisualVoicemailProtocol getProtocol() {
return mProtocol;
}
/** @returns arbitrary String stored in the config file. Used for protocol specific values. */
@Nullable
public String getString(String key) {
Assert.checkArgument(isValid());
return (String) getValue(key);
}
@Nullable
public Set<String> getCarrierVvmPackageNames() {
Assert.checkArgument(isValid());
return getCarrierVvmPackageNamesWithoutValidation();
}
@Nullable
private Set<String> getCarrierVvmPackageNamesWithoutValidation() {
Set<String> names = getCarrierVvmPackageNames(mOverrideConfig);
if (names != null) {
return names;
}
names = getCarrierVvmPackageNames(mCarrierConfig);
if (names != null) {
return names;
}
return getCarrierVvmPackageNames(mTelephonyConfig);
}
private static Set<String> getCarrierVvmPackageNames(@Nullable PersistableBundle bundle) {
if (bundle == null) {
return null;
}
Set<String> names = new ArraySet<>();
if (bundle.containsKey(KEY_CARRIER_VVM_PACKAGE_NAME_STRING)) {
names.add(bundle.getString(KEY_CARRIER_VVM_PACKAGE_NAME_STRING));
}
if (bundle.containsKey(KEY_CARRIER_VVM_PACKAGE_NAME_STRING_ARRAY)) {
String[] vvmPackages = bundle.getStringArray(KEY_CARRIER_VVM_PACKAGE_NAME_STRING_ARRAY);
if (vvmPackages != null && vvmPackages.length > 0) {
Collections.addAll(names, vvmPackages);
}
}
if (names.isEmpty()) {
return null;
}
return names;
}
/**
* For checking upon sim insertion whether visual voicemail should be enabled. This method does so
* by checking if the carrier's voicemail app is installed.
*/
public boolean isEnabledByDefault() {
if (!isValid()) {
return false;
}
Set<String> carrierPackages = getCarrierVvmPackageNames();
if (carrierPackages == null) {
return true;
}
for (String packageName : carrierPackages) {
try {
mContext.getPackageManager().getPackageInfo(packageName, 0);
return false;
} catch (NameNotFoundException e) {
// Do nothing.
}
}
return true;
}
public boolean isCellularDataRequired() {
Assert.checkArgument(isValid());
return (boolean) getValue(KEY_VVM_CELLULAR_DATA_REQUIRED_BOOL, false);
}
public boolean isPrefetchEnabled() {
Assert.checkArgument(isValid());
return (boolean) getValue(KEY_VVM_PREFETCH_BOOL, true);
}
public int getApplicationPort() {
Assert.checkArgument(isValid());
return (int) getValue(KEY_VVM_PORT_NUMBER_INT, 0);
}
@Nullable
public String getDestinationNumber() {
Assert.checkArgument(isValid());
return (String) getValue(KEY_VVM_DESTINATION_NUMBER_STRING);
}
/** @return Port to start a SSL IMAP connection directly. */
public int getSslPort() {
Assert.checkArgument(isValid());
return (int) getValue(KEY_VVM_SSL_PORT_NUMBER_INT, 0);
}
/**
* Hidden Config.
*
* <p>Sometimes the server states it supports a certain feature but we found they have bug on the
* server side. For example, in a bug the server reported AUTH=DIGEST-MD5 capability but
* using it to login will cause subsequent response to be erroneous.
*
* @return A set of capabilities that is reported by the IMAP CAPABILITY command, but determined
* to have issues and should not be used.
*/
@Nullable
public Set<String> getDisabledCapabilities() {
Assert.checkArgument(isValid());
Set<String> disabledCapabilities;
disabledCapabilities = getDisabledCapabilities(mOverrideConfig);
if (disabledCapabilities != null) {
return disabledCapabilities;
}
disabledCapabilities = getDisabledCapabilities(mCarrierConfig);
if (disabledCapabilities != null) {
return disabledCapabilities;
}
return getDisabledCapabilities(mTelephonyConfig);
}
@Nullable
private static Set<String> getDisabledCapabilities(@Nullable PersistableBundle bundle) {
if (bundle == null) {
return null;
}
if (!bundle.containsKey(KEY_VVM_DISABLED_CAPABILITIES_STRING_ARRAY)) {
return null;
}
String[] disabledCapabilities =
bundle.getStringArray(KEY_VVM_DISABLED_CAPABILITIES_STRING_ARRAY);
if (disabledCapabilities != null && disabledCapabilities.length > 0) {
ArraySet<String> result = new ArraySet<>();
Collections.addAll(result, disabledCapabilities);
return result;
}
return null;
}
public String getClientPrefix() {
Assert.checkArgument(isValid());
String prefix = (String) getValue(KEY_VVM_CLIENT_PREFIX_STRING);
if (prefix != null) {
return prefix;
}
return "//VVM";
}
/**
* Should legacy mode be used when the OMTP VVM client is disabled?
*
* <p>Legacy mode is a mode that on the carrier side visual voicemail is still activated, but on
* the client side all network operations are disabled. SMSs are still monitored so a new message
* SYNC SMS will be translated to show a message waiting indicator, like traditional voicemails.
*
* <p>This is for carriers that does not support VVM deactivation so voicemail can continue to
* function without the data cost.
*/
public boolean isLegacyModeEnabled() {
Assert.checkArgument(isValid());
return (boolean) getValue(KEY_VVM_LEGACY_MODE_ENABLED_BOOL, false);
}
public void startActivation() {
Assert.checkArgument(isValid());
PhoneAccountHandle phoneAccountHandle = getPhoneAccountHandle();
if (phoneAccountHandle == null) {
// This should never happen
// Error logged in getPhoneAccountHandle().
return;
}
if (mVvmType == null || mVvmType.isEmpty()) {
// The VVM type is invalid; we should never have gotten here in the first place since
// this is loaded initially in the constructor, and callers should check isValid()
// before trying to start activation anyways.
VvmLog.e(TAG, "startActivation : vvmType is null or empty for account " + phoneAccountHandle);
return;
}
if (mProtocol != null) {
ActivationTask.start(mContext, mPhoneAccountHandle, null);
}
}
public void activateSmsFilter() {
Assert.checkArgument(isValid());
TelephonyMangerCompat.setVisualVoicemailSmsFilterSettings(
mContext,
getPhoneAccountHandle(),
new VisualVoicemailSmsFilterSettings.Builder().setClientPrefix(getClientPrefix()).build());
}
public void startDeactivation() {
Assert.checkArgument(isValid());
VvmLog.i(TAG, "startDeactivation");
if (!isLegacyModeEnabled()) {
// SMS should still be filtered in legacy mode
TelephonyMangerCompat.setVisualVoicemailSmsFilterSettings(
mContext, getPhoneAccountHandle(), null);
VvmLog.i(TAG, "filter disabled");
}
if (mProtocol != null) {
mProtocol.startDeactivation(this);
}
VvmAccountManager.removeAccount(mContext, getPhoneAccountHandle());
}
public boolean supportsProvisioning() {
Assert.checkArgument(isValid());
return mProtocol.supportsProvisioning();
}
public void startProvisioning(
ActivationTask task,
PhoneAccountHandle phone,
VoicemailStatus.Editor status,
StatusMessage message,
Bundle data) {
Assert.checkArgument(isValid());
mProtocol.startProvisioning(task, phone, this, status, message, data);
}
public void requestStatus(@Nullable PendingIntent sentIntent) {
Assert.checkArgument(isValid());
mProtocol.requestStatus(this, sentIntent);
}
public void handleEvent(VoicemailStatus.Editor status, OmtpEvents event) {
Assert.checkArgument(isValid());
VvmLog.i(TAG, "OmtpEvent:" + event);
mProtocol.handleEvent(mContext, this, status, event);
}
@Override
public String toString() {
StringBuilder builder = new StringBuilder("OmtpVvmCarrierConfigHelper [");
builder
.append("phoneAccountHandle: ")
.append(mPhoneAccountHandle)
.append(", carrierConfig: ")
.append(mCarrierConfig != null)
.append(", telephonyConfig: ")
.append(mTelephonyConfig != null)
.append(", type: ")
.append(getVvmType())
.append(", destinationNumber: ")
.append(getDestinationNumber())
.append(", applicationPort: ")
.append(getApplicationPort())
.append(", sslPort: ")
.append(getSslPort())
.append(", isEnabledByDefault: ")
.append(isEnabledByDefault())
.append(", isCellularDataRequired: ")
.append(isCellularDataRequired())
.append(", isPrefetchEnabled: ")
.append(isPrefetchEnabled())
.append(", isLegacyModeEnabled: ")
.append(isLegacyModeEnabled())
.append("]");
return builder.toString();
}
@Nullable
private PersistableBundle getCarrierConfig(@NonNull TelephonyManager telephonyManager) {
CarrierConfigManager carrierConfigManager =
(CarrierConfigManager) mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);
if (carrierConfigManager == null) {
VvmLog.w(TAG, "No carrier config service found.");
return null;
}
PersistableBundle config = telephonyManager.getCarrierConfig();
if (TextUtils.isEmpty(config.getString(CarrierConfigManager.KEY_VVM_TYPE_STRING))) {
return null;
}
return config;
}
@Nullable
private Object getValue(String key) {
return getValue(key, null);
}
@Nullable
private Object getValue(String key, Object defaultValue) {
Object result;
if (mOverrideConfig != null) {
result = mOverrideConfig.get(key);
if (result != null) {
return result;
}
}
if (mCarrierConfig != null) {
result = mCarrierConfig.get(key);
if (result != null) {
return result;
}
}
if (mTelephonyConfig != null) {
result = mTelephonyConfig.get(key);
if (result != null) {
return result;
}
}
return defaultValue;
}
@VisibleForTesting
public static void setOverrideConfigForTest(PersistableBundle config) {
sOverrideConfigForTest = config;
}
private boolean isCarrierAppPreloaded() {
Set<String> carrierPackages = getCarrierVvmPackageNamesWithoutValidation();
if (carrierPackages == null) {
return false;
}
for (String packageName : carrierPackages) {
try {
ApplicationInfo info = getContext().getPackageManager().getApplicationInfo(packageName, 0);
if (!info.enabled) {
continue;
}
if ((info.flags & ApplicationInfo.FLAG_SYSTEM) != 0
|| (info.flags & ApplicationInfo.FLAG_UPDATED_SYSTEM_APP) != 0) {
VvmLog.i(TAG, packageName + " preloaded, force disabling dialer vvm");
return true;
}
} catch (NameNotFoundException e) {
continue;
}
}
return false;
}
}
|