CarrierConfigManager.java revision 9444f4be82d2bbc6b8668e73e91cfa70aee2d4dc
1/* 2 * Copyright (C) 2015 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.telephony; 18 19import com.android.internal.telephony.ICarrierConfigLoader; 20 21import android.annotation.NonNull; 22import android.annotation.Nullable; 23import android.annotation.SystemApi; 24import android.content.Context; 25import android.os.PersistableBundle; 26import android.os.RemoteException; 27import android.os.ServiceManager; 28 29/** 30 * Provides access to telephony configuration values that are carrier-specific. 31 * <p> 32 * Users should obtain an instance of this class by calling 33 * {@code mContext.getSystemService(Context.CARRIER_CONFIG_SERVICE);} 34 * </p> 35 * 36 * @see Context#getSystemService 37 * @see Context#CARRIER_CONFIG_SERVICE 38 */ 39public class CarrierConfigManager { 40 private final static String TAG = "CarrierConfigManager"; 41 42 /** 43 * @hide 44 */ 45 public CarrierConfigManager() { 46 } 47 48 /** 49 * This intent is broadcast by the system when carrier config changes. 50 */ 51 public static final String 52 ACTION_CARRIER_CONFIG_CHANGED = "android.telephony.action.CARRIER_CONFIG_CHANGED"; 53 54 /** 55 * Flag indicating whether the Phone app should ignore EVENT_SIM_NETWORK_LOCKED 56 * events from the Sim. 57 * If true, this will prevent the IccNetworkDepersonalizationPanel from being shown, and 58 * effectively disable the "Sim network lock" feature. 59 */ 60 public static final String 61 BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS = "bool_ignore_sim_network_locked_events"; 62 63 /** 64 * Flag indicating whether the Phone app should provide a "Dismiss" button on the SIM network 65 * unlock screen. The default value is true. If set to false, there will be *no way* to dismiss 66 * the SIM network unlock screen if you don't enter the correct unlock code. (One important 67 * consequence: there will be no way to make an Emergency Call if your SIM is network-locked and 68 * you don't know the PIN.) 69 */ 70 public static final String 71 BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS = "bool_sim_network_unlock_allow_dismiss"; 72 73 /** Flag indicating if the phone is a world phone */ 74 public static final String BOOL_WORLD_PHONE = "bool_world_phone"; 75 76 /** 77 * If true, enable vibration (haptic feedback) for key presses in the EmergencyDialer activity. 78 * The pattern is set on a per-platform basis using config_virtualKeyVibePattern. To be 79 * consistent with the regular Dialer, this value should agree with the corresponding values 80 * from config.xml under apps/Contacts. 81 */ 82 public static final String 83 BOOL_ENABLE_DIALER_KEY_VIBRATION = "bool_enable_dialer_key_vibration"; 84 85 /** Flag indicating if dtmf tone type is enabled */ 86 public static final String BOOL_DTMF_TYPE_ENABLED = "bool_dtmf_type_enabled"; 87 88 /** Flag indicating if auto retry is enabled */ 89 public static final String BOOL_AUTO_RETRY_ENABLED = "bool_auto_retry_enabled"; 90 91 /** 92 * Determine whether we want to play local DTMF tones in a call, or just let the radio/BP handle 93 * playing of the tones. 94 */ 95 public static final String BOOL_ALLOW_LOCAL_DTMF_TONES = "bool_allow_local_dtmf_tones"; 96 97 /** 98 * If true, show an onscreen "Dial" button in the dialer. In practice this is used on all 99 * platforms, even the ones with hard SEND/END keys, but for maximum flexibility it's controlled 100 * by a flag here (which can be overridden on a per-product basis.) 101 */ 102 public static final String BOOL_SHOW_ONSCREEN_DIAL_BUTTON = "bool_show_onscreen_dial_button"; 103 104 /** Determines if device implements a noise suppression device for in call audio. */ 105 public static final String 106 BOOL_HAS_IN_CALL_NOISE_SUPPRESSION = "bool_has_in_call_noise_suppression"; 107 108 /** 109 * Determines if the current device should allow emergency numbers to be logged in the Call Log. 110 * (Some carriers require that emergency calls *not* be logged, presumably to avoid the risk of 111 * accidental redialing from the call log UI. This is a good idea, so the default here is 112 * false.) 113 * <p> 114 * TODO: on the other hand, it might still be useful to have some record of the emergency calls 115 * you've made, or to be able to look up the exact date/time of an emergency call. So perhaps we 116 * <b>should</b> log those calls, but instead fix the call log to disable the "call" button for 117 * emergency numbers. 118 */ 119 public static final String 120 BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG = "bool_allow_emergency_numbers_in_call_log"; 121 122 /** If true, removes the Voice Privacy option from Call Settings */ 123 public static final String BOOL_VOICE_PRIVACY_DISABLE = "bool_voice_privacy_disable"; 124 125 /** Control whether users can reach the carrier portions of Cellular Network Settings. */ 126 public static final String 127 BOOL_HIDE_CARRIER_NETWORK_SETTINGS = "bool_hide_carrier_network_settings"; 128 129 /** Control whether users can edit APNs in Settings. */ 130 public static final String BOOL_APN_EXPAND = "bool_apn_expand"; 131 132 /** Control whether users can choose a network operator. */ 133 public static final String BOOL_OPERATOR_SELECTION_EXPAND = "bool_operator_selection_expand"; 134 135 /** Used in Cellular Network Settings for preferred network type. */ 136 public static final String BOOL_PREFER_2G = "bool_prefer_2g"; 137 138 /** Show cdma network mode choices 1x, 3G, global etc. */ 139 public static final String BOOL_SHOW_CDMA_CHOICES = "bool_show_cdma_choices"; 140 141 /** CDMA activation goes through HFA */ 142 public static final String BOOL_USE_HFA_FOR_PROVISIONING = "bool_use_hfa_for_provisioning"; 143 144 /** 145 * CDMA activation goes through OTASP. 146 * <p> 147 * TODO: This should be combined with config_use_hfa_for_provisioning and implemented as an enum 148 * (NONE, HFA, OTASP). 149 */ 150 public static final String BOOL_USE_OTASP_FOR_PROVISIONING = "bool_use_otasp_for_provisioning"; 151 152 /** Display carrier settings menu if true */ 153 public static final String BOOL_CARRIER_SETTINGS_ENABLE = "bool_carrier_settings_enable"; 154 155 /** Does not display additional call seting for IMS phone based on GSM Phone */ 156 public static final String BOOL_ADDITIONAL_CALL_SETTING = "bool_additional_call_setting"; 157 158 /** Show APN Settings for some CDMA carriers */ 159 public static final String BOOL_SHOW_APN_SETTING_CDMA = "bool_show_apn_setting_cdma"; 160 161 /** After a CDMA conference call is merged, the swap button should be displayed. */ 162 public static final String BOOL_SUPPORT_SWAP_AFTER_MERGE = "bool_support_swap_after_merge"; 163 164 /** 165 * Determine whether the voicemail notification is persistent in the notification bar. If true, 166 * the voicemail notifications cannot be dismissed from the notification bar. 167 */ 168 public static final String 169 BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT = "bool_voicemail_notification_persistent"; 170 171 /** For IMS video over LTE calls, determines whether video pause signalling is supported. */ 172 public static final String 173 BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS = "bool_support_pause_ims_video_calls"; 174 175 /** 176 * Disables dialing "*228" (OTASP provisioning) on CDMA carriers where it is not supported or is 177 * potentially harmful by locking the SIM to 3G. 178 */ 179 public static final String 180 BOOL_DISABLE_CDMA_ACTIVATION_CODE = "bool_disable_cdma_activation_code"; 181 182 /** 183 * Flag specifying whether VoLTE should be available for carrier, independent of carrier 184 * provisioning. If false: hard disabled. If true: then depends on carrier provisioning, 185 * availability, etc. 186 */ 187 public static final String BOOL_CARRIER_VOLTE_AVAILABLE = "bool_carrier_volte_available"; 188 189 /** Flag specifying whether VoLTE availability is based on provisioning. */ 190 public static final String BOOL_CARRIER_VOLTE_PROVISIONED = "bool_carrier_volte_provisioned"; 191 192 /** Flag specifying whether VoLTE TTY is supported. */ 193 public static final String BOOL_CARRIER_VOLTE_TTY_SUPPORTED 194 = "bool_carrier_volte_tty_supported"; 195 196 /** 197 * If Voice Radio Technology is RIL_RADIO_TECHNOLOGY_LTE:14 or RIL_RADIO_TECHNOLOGY_UNKNOWN:0 198 * this is the value that should be used instead. A configuration value of 199 * RIL_RADIO_TECHNOLOGY_UNKNOWN:0 means there is no replacement value and that the default 200 * assumption for phone type (GSM) should be used. 201 */ 202 public static final String INT_VOLTE_REPLACEMENT_RAT = "int_volte_replacement_rat"; 203 204 /* The following 3 fields are related to carrier visual voicemail. */ 205 206 /** 207 * The carrier number MO sms messages are sent to. 208 * 209 * @hide 210 */ 211 public static final String STRING_VVM_DESTINATION_NUMBER = "string_vvm_destination_number"; 212 213 /** 214 * The port through which the MO sms messages are sent through. 215 * 216 * @hide 217 */ 218 public static final String INT_VVM_PORT_NUMBER = "int_vvm_port_number"; 219 220 /** 221 * The type of visual voicemail protocol the carrier adheres to. See {@link TelephonyManager} 222 * for possible values. For example {@link TelephonyManager#VVM_TYPE_OMTP}. 223 * 224 * @hide 225 */ 226 public static final String STRING_VVM_TYPE = "string_vvm_type"; 227 228 // These variables are used by the MMS service and exposed through another API, {@link 229 // SmsManager}. The variable names and string values are copied from there. 230 public static final String BOOL_MMS_ALIAS_ENABLED = "aliasEnabled"; 231 public static final String BOOL_MMS_ALLOW_ATTACH_AUDIO = "allowAttachAudio"; 232 public static final String BOOL_MMS_APPEND_TRANSACTION_ID = "enabledTransID"; 233 public static final String BOOL_MMS_GROUP_MMS_ENABLED = "enableGroupMms"; 234 public static final String BOOL_MMS_MMS_DELIVERY_REPORT_ENABLED = "enableMMSDeliveryReports"; 235 public static final String BOOL_MMS_MMS_ENABLED = "enabledMMS"; 236 public static final String BOOL_MMS_MMS_READ_REPORT_ENABLED = "enableMMSReadReports"; 237 public static final String BOOL_MMS_MULTIPART_SMS_ENABLED = "enableMultipartSMS"; 238 public static final String BOOL_MMS_NOTIFY_WAP_MMSC_ENABLED = "enabledNotifyWapMMSC"; 239 public static final String BOOL_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES = "sendMultipartSmsAsSeparateMessages"; 240 public static final String BOOL_MMS_SHOW_CELL_BROADCAST_APP_LINKS = "config_cellBroadcastAppLinks"; 241 public static final String BOOL_MMS_SMS_DELIVERY_REPORT_ENABLED = "enableSMSDeliveryReports"; 242 public static final String BOOL_MMS_SUPPORT_HTTP_CHARSET_HEADER = "supportHttpCharsetHeader"; 243 public static final String BOOL_MMS_SUPPORT_MMS_CONTENT_DISPOSITION = "supportMmsContentDisposition"; 244 public static final String INT_MMS_ALIAS_MAX_CHARS = "aliasMaxChars"; 245 public static final String INT_MMS_ALIAS_MIN_CHARS = "aliasMinChars"; 246 public static final String INT_MMS_HTTP_SOCKET_TIMEOUT = "httpSocketTimeout"; 247 public static final String INT_MMS_MAX_IMAGE_HEIGHT = "maxImageHeight"; 248 public static final String INT_MMS_MAX_IMAGE_WIDTH = "maxImageWidth"; 249 public static final String INT_MMS_MAX_MESSAGE_SIZE = "maxMessageSize"; 250 public static final String INT_MMS_MESSAGE_TEXT_MAX_SIZE = "maxMessageTextSize"; 251 public static final String INT_MMS_RECIPIENT_LIMIT = "recipientLimit"; 252 public static final String INT_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD = "smsToMmsTextLengthThreshold"; 253 public static final String INT_MMS_SMS_TO_MMS_TEXT_THRESHOLD = "smsToMmsTextThreshold"; 254 public static final String INT_MMS_SUBJECT_MAX_LENGTH = "maxSubjectLength"; 255 public static final String STRING_MMS_EMAIL_GATEWAY_NUMBER = "emailGatewayNumber"; 256 public static final String STRING_MMS_HTTP_PARAMS = "httpParams"; 257 public static final String STRING_MMS_NAI_SUFFIX = "naiSuffix"; 258 public static final String STRING_MMS_UA_PROF_TAG_NAME = "uaProfTagName"; 259 public static final String STRING_MMS_UA_PROF_URL = "uaProfUrl"; 260 public static final String STRING_MMS_USER_AGENT = "userAgent"; 261 262 /** The default value for every variable. */ 263 private final static PersistableBundle sDefaults; 264 265 static { 266 sDefaults = new PersistableBundle(); 267 sDefaults.putBoolean(BOOL_ADDITIONAL_CALL_SETTING, true); 268 sDefaults.putBoolean(BOOL_ALLOW_EMERGENCY_NUMBERS_IN_CALL_LOG, false); 269 sDefaults.putBoolean(BOOL_ALLOW_LOCAL_DTMF_TONES, true); 270 sDefaults.putBoolean(BOOL_APN_EXPAND, true); 271 sDefaults.putBoolean(BOOL_AUTO_RETRY_ENABLED, false); 272 sDefaults.putBoolean(BOOL_CARRIER_SETTINGS_ENABLE, false); 273 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_AVAILABLE, false); 274 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_PROVISIONED, false); 275 sDefaults.putBoolean(BOOL_CARRIER_VOLTE_TTY_SUPPORTED, true); 276 sDefaults.putBoolean(BOOL_DISABLE_CDMA_ACTIVATION_CODE, false); 277 sDefaults.putBoolean(BOOL_DTMF_TYPE_ENABLED, false); 278 sDefaults.putBoolean(BOOL_ENABLE_DIALER_KEY_VIBRATION, true); 279 sDefaults.putBoolean(BOOL_HAS_IN_CALL_NOISE_SUPPRESSION, false); 280 sDefaults.putBoolean(BOOL_HIDE_CARRIER_NETWORK_SETTINGS, false); 281 sDefaults.putBoolean(BOOL_IGNORE_SIM_NETWORK_LOCKED_EVENTS, false); 282 sDefaults.putBoolean(BOOL_OPERATOR_SELECTION_EXPAND, true); 283 sDefaults.putBoolean(BOOL_PREFER_2G, true); 284 sDefaults.putBoolean(BOOL_SHOW_APN_SETTING_CDMA, false); 285 sDefaults.putBoolean(BOOL_SHOW_CDMA_CHOICES, false); 286 sDefaults.putBoolean(BOOL_SHOW_ONSCREEN_DIAL_BUTTON, true); 287 sDefaults.putBoolean(BOOL_SIM_NETWORK_UNLOCK_ALLOW_DISMISS, true); 288 sDefaults.putBoolean(BOOL_SUPPORT_PAUSE_IMS_VIDEO_CALLS, true); 289 sDefaults.putBoolean(BOOL_SUPPORT_SWAP_AFTER_MERGE, true); 290 sDefaults.putBoolean(BOOL_USE_HFA_FOR_PROVISIONING, false); 291 sDefaults.putBoolean(BOOL_USE_OTASP_FOR_PROVISIONING, false); 292 sDefaults.putBoolean(BOOL_VOICEMAIL_NOTIFICATION_PERSISTENT, false); 293 sDefaults.putBoolean(BOOL_VOICE_PRIVACY_DISABLE, false); 294 sDefaults.putBoolean(BOOL_WORLD_PHONE, false); 295 sDefaults.putInt(INT_VOLTE_REPLACEMENT_RAT, 0); 296 sDefaults.putInt(INT_VVM_PORT_NUMBER, 0); 297 sDefaults.putString(STRING_VVM_DESTINATION_NUMBER, ""); 298 sDefaults.putString(STRING_VVM_TYPE, ""); 299 300 // MMS defaults 301 sDefaults.putBoolean(BOOL_MMS_ALIAS_ENABLED, false); 302 sDefaults.putBoolean(BOOL_MMS_ALLOW_ATTACH_AUDIO, true); 303 sDefaults.putBoolean(BOOL_MMS_APPEND_TRANSACTION_ID, false); 304 sDefaults.putBoolean(BOOL_MMS_GROUP_MMS_ENABLED, true); 305 sDefaults.putBoolean(BOOL_MMS_MMS_DELIVERY_REPORT_ENABLED, false); 306 sDefaults.putBoolean(BOOL_MMS_MMS_ENABLED, true); 307 sDefaults.putBoolean(BOOL_MMS_MMS_READ_REPORT_ENABLED, false); 308 sDefaults.putBoolean(BOOL_MMS_MULTIPART_SMS_ENABLED, true); 309 sDefaults.putBoolean(BOOL_MMS_NOTIFY_WAP_MMSC_ENABLED, false); 310 sDefaults.putBoolean(BOOL_MMS_SEND_MULTIPART_SMS_AS_SEPARATE_MESSAGES, false); 311 sDefaults.putBoolean(BOOL_MMS_SHOW_CELL_BROADCAST_APP_LINKS, true); 312 sDefaults.putBoolean(BOOL_MMS_SMS_DELIVERY_REPORT_ENABLED, true); 313 sDefaults.putBoolean(BOOL_MMS_SUPPORT_HTTP_CHARSET_HEADER, false); 314 sDefaults.putBoolean(BOOL_MMS_SUPPORT_MMS_CONTENT_DISPOSITION, true); 315 sDefaults.putInt(INT_MMS_ALIAS_MAX_CHARS, 48); 316 sDefaults.putInt(INT_MMS_ALIAS_MIN_CHARS, 2); 317 sDefaults.putInt(INT_MMS_HTTP_SOCKET_TIMEOUT, 60 * 1000); 318 sDefaults.putInt(INT_MMS_MAX_IMAGE_HEIGHT, 480); 319 sDefaults.putInt(INT_MMS_MAX_IMAGE_WIDTH, 640); 320 sDefaults.putInt(INT_MMS_MAX_MESSAGE_SIZE, 300 * 1024); 321 sDefaults.putInt(INT_MMS_MESSAGE_TEXT_MAX_SIZE, -1); 322 sDefaults.putInt(INT_MMS_RECIPIENT_LIMIT, Integer.MAX_VALUE); 323 sDefaults.putInt(INT_MMS_SMS_TO_MMS_TEXT_LENGTH_THRESHOLD, -1); 324 sDefaults.putInt(INT_MMS_SMS_TO_MMS_TEXT_THRESHOLD, -1); 325 sDefaults.putInt(INT_MMS_SUBJECT_MAX_LENGTH, 40); 326 sDefaults.putString(STRING_MMS_EMAIL_GATEWAY_NUMBER, ""); 327 sDefaults.putString(STRING_MMS_HTTP_PARAMS, ""); 328 sDefaults.putString(STRING_MMS_NAI_SUFFIX, ""); 329 sDefaults.putString(STRING_MMS_UA_PROF_TAG_NAME, "x-wap-profile"); 330 sDefaults.putString(STRING_MMS_UA_PROF_URL, ""); 331 sDefaults.putString(STRING_MMS_USER_AGENT, ""); 332 } 333 334 /** 335 * Gets the configuration values for a particular subscription, which is associated with a 336 * specific SIM card. If an invalid subId is used, the returned config will contain default 337 * values. 338 * 339 * @param subId the subscription ID, normally obtained from {@link SubscriptionManager}. 340 * @return A {@link PersistableBundle} containing the config for the given subId, or default 341 * values for an invalid subId. 342 */ 343 @Nullable 344 public PersistableBundle getConfigForSubId(int subId) { 345 try { 346 return getICarrierConfigLoader().getConfigForSubId(subId); 347 } catch (RemoteException ex) { 348 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 349 + ex.toString()); 350 } catch (NullPointerException ex) { 351 Rlog.e(TAG, "Error getting config for subId " + Integer.toString(subId) + ": " 352 + ex.toString()); 353 } 354 return null; 355 } 356 357 /** 358 * Gets the configuration values for the default subscription. 359 * 360 * @see #getConfigForSubId 361 */ 362 @Nullable 363 public PersistableBundle getConfig() { 364 return getConfigForSubId(SubscriptionManager.getDefaultSubId()); 365 } 366 367 /** 368 * Calling this method triggers telephony services to fetch the current carrier configuration. 369 * <p> 370 * Normally this does not need to be called because the platform reloads config on its own. Call 371 * this method if your app wants to update config at an arbitrary moment. 372 * </p> 373 * <p> 374 * This method returns before the reload has completed, and 375 * {@link android.service.carrier.CarrierService#onLoadConfig} will be called from an 376 * arbitrary thread. 377 * </p> 378 */ 379 public void reloadCarrierConfigForSubId(int subId) { 380 try { 381 getICarrierConfigLoader().reloadCarrierConfigForSubId(subId); 382 } catch (RemoteException ex) { 383 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 384 } catch (NullPointerException ex) { 385 Rlog.e(TAG, "Error reloading config for subId=" + subId + ": " + ex.toString()); 386 } 387 } 388 389 /** 390 * Request the carrier config loader to update the cofig for phoneId. 391 * <p> 392 * Depending on simState, the config may be cleared or loaded from config app. This is only used 393 * by SubscriptionInfoUpdater. 394 * </p> 395 * 396 * @hide 397 */ 398 @SystemApi 399 public void updateConfigForPhoneId(int phoneId, String simState) { 400 try { 401 getICarrierConfigLoader().updateConfigForPhoneId(phoneId, simState); 402 } catch (RemoteException ex) { 403 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 404 } catch (NullPointerException ex) { 405 Rlog.e(TAG, "Error updating config for phoneId=" + phoneId + ": " + ex.toString()); 406 } 407 } 408 409 /** 410 * Returns a new bundle with the default value for every supported configuration variable. 411 * 412 * @hide 413 */ 414 @NonNull 415 @SystemApi 416 public static PersistableBundle getDefaultConfig() { 417 return new PersistableBundle(sDefaults); 418 } 419 420 /** @hide */ 421 private ICarrierConfigLoader getICarrierConfigLoader() { 422 return ICarrierConfigLoader.Stub 423 .asInterface(ServiceManager.getService(Context.CARRIER_CONFIG_SERVICE)); 424 } 425} 426