Added configuration for VT downgrade/tear down when data disabled
[android/platform/frameworks/opt/net/ims.git] / src / java / com / android / ims / ImsManager.java
1 /*
2  * Copyright (c) 2013 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
17 package com.android.ims;
18
19 import android.app.PendingIntent;
20 import android.content.Context;
21 import android.content.Intent;
22 import android.net.Uri;
23 import android.os.AsyncTask;
24 import android.os.IBinder;
25 import android.os.Message;
26 import android.os.PersistableBundle;
27 import android.os.RemoteException;
28 import android.os.ServiceManager;
29 import android.os.SystemProperties;
30 import android.provider.Settings;
31 import android.telecom.TelecomManager;
32 import android.telephony.CarrierConfigManager;
33 import android.telephony.Rlog;
34 import android.telephony.SubscriptionManager;
35 import android.telephony.TelephonyManager;
36
37 import com.android.ims.internal.IImsCallSession;
38 import com.android.ims.internal.IImsEcbm;
39 import com.android.ims.internal.IImsMultiEndpoint;
40 import com.android.ims.internal.IImsRegistrationListener;
41 import com.android.ims.internal.IImsService;
42 import com.android.ims.internal.IImsUt;
43 import com.android.ims.internal.ImsCallSession;
44 import com.android.ims.internal.IImsConfig;
45
46 import java.io.FileDescriptor;
47 import java.io.PrintWriter;
48 import java.util.HashMap;
49
50 /**
51  * Provides APIs for IMS services, such as initiating IMS calls, and provides access to
52  * the operator's IMS network. This class is the starting point for any IMS actions.
53  * You can acquire an instance of it with {@link #getInstance getInstance()}.</p>
54  * <p>The APIs in this class allows you to:</p>
55  *
56  * @hide
57  */
58 public class ImsManager {
59
60     /*
61      * Debug flag to override configuration flag
62      */
63     public static final String PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE = "persist.dbg.volte_avail_ovr";
64     public static final int PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT = 0;
65     public static final String PROPERTY_DBG_VT_AVAIL_OVERRIDE = "persist.dbg.vt_avail_ovr";
66     public static final int PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT = 0;
67     public static final String PROPERTY_DBG_WFC_AVAIL_OVERRIDE = "persist.dbg.wfc_avail_ovr";
68     public static final int PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT = 0;
69     public static final String PROPERTY_DBG_ALLOW_IMS_OFF_OVERRIDE = "persist.dbg.allow_ims_off";
70     public static final int PROPERTY_DBG_ALLOW_IMS_OFF_OVERRIDE_DEFAULT = 0;
71
72     /**
73      * For accessing the IMS related service.
74      * Internal use only.
75      * @hide
76      */
77     private static final String IMS_SERVICE = "ims";
78
79     /**
80      * The result code to be sent back with the incoming call {@link PendingIntent}.
81      * @see #open(PendingIntent, ImsConnectionStateListener)
82      */
83     public static final int INCOMING_CALL_RESULT_CODE = 101;
84
85     /**
86      * Key to retrieve the call ID from an incoming call intent.
87      * @see #open(PendingIntent, ImsConnectionStateListener)
88      */
89     public static final String EXTRA_CALL_ID = "android:imsCallID";
90
91     /**
92      * Action to broadcast when ImsService is up.
93      * Internal use only.
94      * @hide
95      */
96     public static final String ACTION_IMS_SERVICE_UP =
97             "com.android.ims.IMS_SERVICE_UP";
98
99     /**
100      * Action to broadcast when ImsService is down.
101      * Internal use only.
102      * @hide
103      */
104     public static final String ACTION_IMS_SERVICE_DOWN =
105             "com.android.ims.IMS_SERVICE_DOWN";
106
107     /**
108      * Action to broadcast when ImsService registration fails.
109      * Internal use only.
110      * @hide
111      */
112     public static final String ACTION_IMS_REGISTRATION_ERROR =
113             "com.android.ims.REGISTRATION_ERROR";
114
115     /**
116      * Part of the ACTION_IMS_SERVICE_UP or _DOWN intents.
117      * A long value; the phone ID corresponding to the IMS service coming up or down.
118      * Internal use only.
119      * @hide
120      */
121     public static final String EXTRA_PHONE_ID = "android:phone_id";
122
123     /**
124      * Action for the incoming call intent for the Phone app.
125      * Internal use only.
126      * @hide
127      */
128     public static final String ACTION_IMS_INCOMING_CALL =
129             "com.android.ims.IMS_INCOMING_CALL";
130
131     /**
132      * Part of the ACTION_IMS_INCOMING_CALL intents.
133      * An integer value; service identifier obtained from {@link ImsManager#open}.
134      * Internal use only.
135      * @hide
136      */
137     public static final String EXTRA_SERVICE_ID = "android:imsServiceId";
138
139     /**
140      * Part of the ACTION_IMS_INCOMING_CALL intents.
141      * An boolean value; Flag to indicate that the incoming call is a normal call or call for USSD.
142      * The value "true" indicates that the incoming call is for USSD.
143      * Internal use only.
144      * @hide
145      */
146     public static final String EXTRA_USSD = "android:ussd";
147
148     /**
149      * Part of the ACTION_IMS_INCOMING_CALL intents.
150      * A boolean value; Flag to indicate whether the call is an unknown
151      * dialing call. Such calls are originated by sending commands (like
152      * AT commands) directly to modem without Android involvement.
153      * Even though they are not incoming calls, they are propagated
154      * to Phone app using same ACTION_IMS_INCOMING_CALL intent.
155      * Internal use only.
156      * @hide
157      */
158     public static final String EXTRA_IS_UNKNOWN_CALL = "android:isUnknown";
159
160     private static final String TAG = "ImsManager";
161     private static final boolean DBG = true;
162
163     private static HashMap<Integer, ImsManager> sImsManagerInstances =
164             new HashMap<Integer, ImsManager>();
165
166     private Context mContext;
167     private int mPhoneId;
168     private IImsService mImsService = null;
169     private ImsServiceDeathRecipient mDeathRecipient = new ImsServiceDeathRecipient();
170     // Ut interface for the supplementary service configuration
171     private ImsUt mUt = null;
172     // Interface to get/set ims config items
173     private ImsConfig mConfig = null;
174     private boolean mConfigUpdated = false;
175
176     private ImsConfigListener mImsConfigListener;
177
178     // ECBM interface
179     private ImsEcbm mEcbm = null;
180
181     private ImsMultiEndpoint mMultiEndpoint = null;
182
183     // SystemProperties used as cache
184     private static final String VOLTE_PROVISIONED_PROP = "net.lte.ims.volte.provisioned";
185     private static final String WFC_PROVISIONED_PROP = "net.lte.ims.wfc.provisioned";
186     private static final String VT_PROVISIONED_PROP = "net.lte.ims.vt.provisioned";
187     // Flag indicating data enabled or not. This flag should be in sync with
188     // DcTracker.isDataEnabled(). The flag will be set later during boot up.
189     private static final String DATA_ENABLED_PROP = "net.lte.ims.data.enabled";
190
191     public static final String TRUE = "true";
192     public static final String FALSE = "false";
193
194     /**
195      * Gets a manager instance.
196      *
197      * @param context application context for creating the manager object
198      * @param phoneId the phone ID for the IMS Service
199      * @return the manager instance corresponding to the phoneId
200      */
201     public static ImsManager getInstance(Context context, int phoneId) {
202         synchronized (sImsManagerInstances) {
203             if (sImsManagerInstances.containsKey(phoneId))
204                 return sImsManagerInstances.get(phoneId);
205
206             ImsManager mgr = new ImsManager(context, phoneId);
207             sImsManagerInstances.put(phoneId, mgr);
208
209             return mgr;
210         }
211     }
212
213     /**
214      * Returns the user configuration of Enhanced 4G LTE Mode setting
215      */
216     public static boolean isEnhanced4gLteModeSettingEnabledByUser(Context context) {
217         // If user can't edit Enhanced 4G LTE Mode, it assumes Enhanced 4G LTE Mode is always true.
218         // If user changes SIM from editable mode to uneditable mode, need to return true.
219         if (!getBooleanCarrierConfig(context,
220                     CarrierConfigManager.KEY_EDITABLE_ENHANCED_4G_LTE_BOOL)) {
221             return true;
222         }
223         int enabled = android.provider.Settings.Global.getInt(
224                     context.getContentResolver(),
225                     android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, ImsConfig.FeatureValueConstants.ON);
226         return (enabled == 1) ? true : false;
227     }
228
229     /**
230      * Change persistent Enhanced 4G LTE Mode setting
231      */
232     public static void setEnhanced4gLteModeSetting(Context context, boolean enabled) {
233         int value = enabled ? 1 : 0;
234         android.provider.Settings.Global.putInt(
235                 context.getContentResolver(),
236                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, value);
237
238         if (isNonTtyOrTtyOnVolteEnabled(context)) {
239             ImsManager imsManager = ImsManager.getInstance(context,
240                     SubscriptionManager.getDefaultVoicePhoneId());
241             if (imsManager != null) {
242                 try {
243                     imsManager.setAdvanced4GMode(enabled);
244                 } catch (ImsException ie) {
245                     // do nothing
246                 }
247             }
248         }
249     }
250
251     /**
252      * Indicates whether the call is non-TTY or if TTY - whether TTY on VoLTE is
253      * supported.
254      */
255     public static boolean isNonTtyOrTtyOnVolteEnabled(Context context) {
256         if (getBooleanCarrierConfig(context,
257                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
258             return true;
259         }
260
261         return Settings.Secure.getInt(context.getContentResolver(),
262                 Settings.Secure.PREFERRED_TTY_MODE, TelecomManager.TTY_MODE_OFF)
263                 == TelecomManager.TTY_MODE_OFF;
264     }
265
266     /**
267      * Returns a platform configuration for VoLTE which may override the user setting.
268      */
269     public static boolean isVolteEnabledByPlatform(Context context) {
270         if (SystemProperties.getInt(PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE,
271                 PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT) == 1) {
272             return true;
273         }
274
275         return context.getResources().getBoolean(
276                 com.android.internal.R.bool.config_device_volte_available)
277                 && getBooleanCarrierConfig(context,
278                         CarrierConfigManager.KEY_CARRIER_VOLTE_AVAILABLE_BOOL)
279                 && isGbaValid(context);
280     }
281
282     /**
283      * Indicates whether VoLTE is provisioned on device
284      */
285     public static boolean isVolteProvisionedOnDevice(Context context) {
286         if (getBooleanCarrierConfig(context,
287                     CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
288             ImsManager mgr = ImsManager.getInstance(context,
289                     SubscriptionManager.getDefaultVoicePhoneId());
290             if (mgr != null) {
291                 return mgr.isVolteProvisioned();
292             }
293         }
294
295         return true;
296     }
297
298     /**
299      * Indicates whether VoWifi is provisioned on device
300      */
301     public static boolean isWfcProvisionedOnDevice(Context context) {
302         if (getBooleanCarrierConfig(context,
303                 CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
304             ImsManager mgr = ImsManager.getInstance(context,
305                     SubscriptionManager.getDefaultVoicePhoneId());
306             if (mgr != null) {
307                 return mgr.isWfcProvisioned();
308             }
309         }
310
311         return true;
312     }
313
314     /**
315      * Indicates whether VT is provisioned on device
316      */
317     public static boolean isVtProvisionedOnDevice(Context context) {
318         if (getBooleanCarrierConfig(context,
319                 CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
320             ImsManager mgr = ImsManager.getInstance(context,
321                     SubscriptionManager.getDefaultVoicePhoneId());
322             if (mgr != null) {
323                 return mgr.isVtProvisioned();
324             }
325         }
326
327         return true;
328     }
329
330     /**
331      * Returns a platform configuration for VT which may override the user setting.
332      *
333      * Note: VT presumes that VoLTE is enabled (these are configuration settings
334      * which must be done correctly).
335      */
336     public static boolean isVtEnabledByPlatform(Context context) {
337         if (SystemProperties.getInt(PROPERTY_DBG_VT_AVAIL_OVERRIDE,
338                 PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT) == 1) {
339             return true;
340         }
341
342         return
343                 context.getResources().getBoolean(
344                         com.android.internal.R.bool.config_device_vt_available) &&
345                 getBooleanCarrierConfig(context,
346                         CarrierConfigManager.KEY_CARRIER_VT_AVAILABLE_BOOL) &&
347                 isGbaValid(context);
348     }
349
350     /**
351      * Returns the user configuration of VT setting
352      */
353     public static boolean isVtEnabledByUser(Context context) {
354         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
355                 android.provider.Settings.Global.VT_IMS_ENABLED,
356                 ImsConfig.FeatureValueConstants.ON);
357         return (enabled == 1) ? true : false;
358     }
359
360     /**
361      * Change persistent VT enabled setting
362      */
363     public static void setVtSetting(Context context, boolean enabled) {
364         int value = enabled ? 1 : 0;
365         android.provider.Settings.Global.putInt(context.getContentResolver(),
366                 android.provider.Settings.Global.VT_IMS_ENABLED, value);
367
368         ImsManager imsManager = ImsManager.getInstance(context,
369                 SubscriptionManager.getDefaultVoicePhoneId());
370         if (imsManager != null) {
371             try {
372                 ImsConfig config = imsManager.getConfigInterface();
373                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
374                         TelephonyManager.NETWORK_TYPE_LTE,
375                         enabled ? ImsConfig.FeatureValueConstants.ON
376                                 : ImsConfig.FeatureValueConstants.OFF,
377                         imsManager.mImsConfigListener);
378
379                 if (enabled) {
380                     log("setVtSetting() : turnOnIms");
381                     imsManager.turnOnIms();
382                 } else if (isTurnOffImsAllowedByPlatform(context)
383                         && (!isVolteEnabledByPlatform(context)
384                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
385                     log("setVtSetting() : imsServiceAllowTurnOff -> turnOffIms");
386                     imsManager.turnOffIms();
387                 }
388             } catch (ImsException e) {
389                 loge("setVtSetting(): ", e);
390             }
391         }
392     }
393
394     /*
395      * Returns whether turning off ims is allowed by platform.
396      * The platform property may override the carrier config.
397      */
398     private static boolean isTurnOffImsAllowedByPlatform(Context context) {
399         if (SystemProperties.getInt(PROPERTY_DBG_ALLOW_IMS_OFF_OVERRIDE,
400                 PROPERTY_DBG_ALLOW_IMS_OFF_OVERRIDE_DEFAULT) == 1) {
401             return true;
402         }
403         return getBooleanCarrierConfig(context,
404                 CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL);
405     }
406
407     /**
408      * Returns the user configuration of WFC setting
409      */
410     public static boolean isWfcEnabledByUser(Context context) {
411         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
412                 android.provider.Settings.Global.WFC_IMS_ENABLED,
413                 getBooleanCarrierConfig(context,
414                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL) ?
415                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
416         return (enabled == 1) ? true : false;
417     }
418
419     /**
420      * Change persistent WFC enabled setting
421      */
422     public static void setWfcSetting(Context context, boolean enabled) {
423         int value = enabled ? 1 : 0;
424         android.provider.Settings.Global.putInt(context.getContentResolver(),
425                 android.provider.Settings.Global.WFC_IMS_ENABLED, value);
426
427         ImsManager imsManager = ImsManager.getInstance(context,
428                 SubscriptionManager.getDefaultVoicePhoneId());
429         if (imsManager != null) {
430             try {
431                 ImsConfig config = imsManager.getConfigInterface();
432                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
433                         TelephonyManager.NETWORK_TYPE_IWLAN,
434                         enabled ? ImsConfig.FeatureValueConstants.ON
435                                 : ImsConfig.FeatureValueConstants.OFF,
436                         imsManager.mImsConfigListener);
437
438                 if (enabled) {
439                     log("setWfcSetting() : turnOnIms");
440                     imsManager.turnOnIms();
441                 } else if (isTurnOffImsAllowedByPlatform(context)
442                         && (!isVolteEnabledByPlatform(context)
443                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
444                     log("setWfcSetting() : imsServiceAllowTurnOff -> turnOffIms");
445                     imsManager.turnOffIms();
446                 }
447
448                 // Force IMS to register over LTE when turning off WFC
449                 setWfcModeInternal(context, enabled
450                         ? getWfcMode(context)
451                         : ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED);
452             } catch (ImsException e) {
453                 loge("setWfcSetting(): ", e);
454             }
455         }
456     }
457
458     /**
459      * Returns the user configuration of WFC preference setting
460      */
461     public static int getWfcMode(Context context) {
462         int setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
463                 android.provider.Settings.Global.WFC_IMS_MODE, getIntCarrierConfig(context,
464                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
465         if (DBG) log("getWfcMode - setting=" + setting);
466         return setting;
467     }
468
469     /**
470      * Change persistent WFC preference setting
471      */
472     public static void setWfcMode(Context context, int wfcMode) {
473         if (DBG) log("setWfcMode - setting=" + wfcMode);
474         android.provider.Settings.Global.putInt(context.getContentResolver(),
475                 android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
476
477         setWfcModeInternal(context, wfcMode);
478     }
479
480     /**
481      * Returns the user configuration of WFC preference setting
482      *
483      * @param roaming {@code false} for home network setting, {@code true} for roaming  setting
484      */
485     public static int getWfcMode(Context context, boolean roaming) {
486         int setting = 0;
487         if (!roaming) {
488             setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
489                     android.provider.Settings.Global.WFC_IMS_MODE, getIntCarrierConfig(context,
490                             CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
491             if (DBG) log("getWfcMode - setting=" + setting);
492         } else {
493             setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
494                     android.provider.Settings.Global.WFC_IMS_ROAMING_MODE,
495                     getIntCarrierConfig(context,
496                             CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_MODE_INT));
497             if (DBG) log("getWfcMode (roaming) - setting=" + setting);
498         }
499         return setting;
500     }
501
502     /**
503      * Change persistent WFC preference setting
504      *
505      * @param roaming {@code false} for home network setting, {@code true} for roaming setting
506      */
507     public static void setWfcMode(Context context, int wfcMode, boolean roaming) {
508         if (!roaming) {
509             if (DBG) log("setWfcMode - setting=" + wfcMode);
510             android.provider.Settings.Global.putInt(context.getContentResolver(),
511                     android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
512         } else {
513             if (DBG) log("setWfcMode (roaming) - setting=" + wfcMode);
514             android.provider.Settings.Global.putInt(context.getContentResolver(),
515                     android.provider.Settings.Global.WFC_IMS_ROAMING_MODE, wfcMode);
516         }
517
518         TelephonyManager tm = (TelephonyManager)
519                 context.getSystemService(Context.TELEPHONY_SERVICE);
520         if (roaming == tm.isNetworkRoaming()) {
521             setWfcModeInternal(context, wfcMode);
522         }
523     }
524
525     private static void setWfcModeInternal(Context context, int wfcMode) {
526         final ImsManager imsManager = ImsManager.getInstance(context,
527                 SubscriptionManager.getDefaultVoicePhoneId());
528         if (imsManager != null) {
529             final int value = wfcMode;
530             Thread thread = new Thread(new Runnable() {
531                 public void run() {
532                     try {
533                         imsManager.getConfigInterface().setProvisionedValue(
534                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_MODE,
535                                 value);
536                     } catch (ImsException e) {
537                         // do nothing
538                     }
539                 }
540             });
541             thread.start();
542         }
543     }
544
545     /**
546      * Returns the user configuration of WFC roaming setting
547      */
548     public static boolean isWfcRoamingEnabledByUser(Context context) {
549         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
550                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
551                 getBooleanCarrierConfig(context,
552                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
553                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
554         return (enabled == 1) ? true : false;
555     }
556
557     /**
558      * Change persistent WFC roaming enabled setting
559      */
560     public static void setWfcRoamingSetting(Context context, boolean enabled) {
561         android.provider.Settings.Global.putInt(context.getContentResolver(),
562                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
563                 enabled ? ImsConfig.FeatureValueConstants.ON
564                         : ImsConfig.FeatureValueConstants.OFF);
565
566         setWfcRoamingSettingInternal(context, enabled);
567     }
568
569     private static void setWfcRoamingSettingInternal(Context context, boolean enabled) {
570         final ImsManager imsManager = ImsManager.getInstance(context,
571                 SubscriptionManager.getDefaultVoicePhoneId());
572         if (imsManager != null) {
573             final int value = enabled
574                     ? ImsConfig.FeatureValueConstants.ON
575                     : ImsConfig.FeatureValueConstants.OFF;
576             Thread thread = new Thread(new Runnable() {
577                 public void run() {
578                     try {
579                         imsManager.getConfigInterface().setProvisionedValue(
580                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_ROAMING,
581                                 value);
582                     } catch (ImsException e) {
583                         // do nothing
584                     }
585                 }
586             });
587             thread.start();
588         }
589     }
590
591     /**
592      * Returns a platform configuration for WFC which may override the user
593      * setting. Note: WFC presumes that VoLTE is enabled (these are
594      * configuration settings which must be done correctly).
595      */
596     public static boolean isWfcEnabledByPlatform(Context context) {
597         if (SystemProperties.getInt(PROPERTY_DBG_WFC_AVAIL_OVERRIDE,
598                 PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT) == 1) {
599             return true;
600         }
601
602         return
603                context.getResources().getBoolean(
604                        com.android.internal.R.bool.config_device_wfc_ims_available) &&
605                getBooleanCarrierConfig(context,
606                        CarrierConfigManager.KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL) &&
607                isGbaValid(context);
608     }
609
610     /**
611      * If carrier requires that IMS is only available if GBA capable SIM is used,
612      * then this function checks GBA bit in EF IST.
613      *
614      * Format of EF IST is defined in 3GPP TS 31.103 (Section 4.2.7).
615      */
616     private static boolean isGbaValid(Context context) {
617         if (getBooleanCarrierConfig(context,
618                 CarrierConfigManager.KEY_CARRIER_IMS_GBA_REQUIRED_BOOL)) {
619             final TelephonyManager telephonyManager = TelephonyManager.getDefault();
620             String efIst = telephonyManager.getIsimIst();
621             if (efIst == null) {
622                 loge("ISF is NULL");
623                 return true;
624             }
625             boolean result = efIst != null && efIst.length() > 1 &&
626                     (0x02 & (byte)efIst.charAt(1)) != 0;
627             if (DBG) log("GBA capable=" + result + ", ISF=" + efIst);
628             return result;
629         }
630         return true;
631     }
632
633     /**
634      * This function should be called when ImsConfig.ACTION_IMS_CONFIG_CHANGED is received.
635      *
636      * We cannot register receiver in ImsManager because this would lead to resource leak.
637      * ImsManager can be created in different processes and it is not notified when that process
638      * is about to be terminated.
639      *
640      * @hide
641      * */
642     public static void onProvisionedValueChanged(Context context, int item, String value) {
643         if (DBG) Rlog.d(TAG, "onProvisionedValueChanged: item=" + item + " val=" + value);
644         ImsManager mgr = ImsManager.getInstance(context,
645                 SubscriptionManager.getDefaultVoicePhoneId());
646
647         switch (item) {
648             case ImsConfig.ConfigConstants.VLT_SETTING_ENABLED:
649                 mgr.setVolteProvisionedProperty(value.equals("1"));
650                 if (DBG) Rlog.d(TAG,"isVoLteProvisioned = " + mgr.isVolteProvisioned());
651                 break;
652
653             case ImsConfig.ConfigConstants.VOICE_OVER_WIFI_SETTING_ENABLED:
654                 mgr.setWfcProvisionedProperty(value.equals("1"));
655                 if (DBG) Rlog.d(TAG,"isWfcProvisioned = " + mgr.isWfcProvisioned());
656                 break;
657
658             case ImsConfig.ConfigConstants.LVC_SETTING_ENABLED:
659                 mgr.setVtProvisionedProperty(value.equals("1"));
660                 if (DBG) Rlog.d(TAG,"isVtProvisioned = " + mgr.isVtProvisioned());
661                 break;
662
663         }
664     }
665
666     private class AsyncUpdateProvisionedValues extends AsyncTask<Void, Void, Void> {
667         @Override
668         protected Void doInBackground(Void... params) {
669             // disable on any error
670             setVolteProvisionedProperty(false);
671             setWfcProvisionedProperty(false);
672             setVtProvisionedProperty(false);
673
674             try {
675                 ImsConfig config = getConfigInterface();
676                 if (config != null) {
677                     setVolteProvisionedProperty(getProvisionedBool(config,
678                             ImsConfig.ConfigConstants.VLT_SETTING_ENABLED));
679                     if (DBG) Rlog.d(TAG, "isVoLteProvisioned = " + isVolteProvisioned());
680
681                     setWfcProvisionedProperty(getProvisionedBool(config,
682                             ImsConfig.ConfigConstants.VOICE_OVER_WIFI_SETTING_ENABLED));
683                     if (DBG) Rlog.d(TAG, "isWfcProvisioned = " + isWfcProvisioned());
684
685                     setVtProvisionedProperty(getProvisionedBool(config,
686                             ImsConfig.ConfigConstants.LVC_SETTING_ENABLED));
687                     if (DBG) Rlog.d(TAG, "isVtProvisioned = " + isVtProvisioned());
688
689                 }
690             } catch (ImsException ie) {
691                 Rlog.e(TAG, "AsyncUpdateProvisionedValues error: ", ie);
692             }
693
694             return null;
695         }
696
697         private boolean getProvisionedBool(ImsConfig config, int item) throws ImsException {
698             return config.getProvisionedValue(item) == ImsConfig.FeatureValueConstants.ON;
699         }
700     }
701
702     /** Asynchronously get VoLTE, WFC, VT provisioning statuses */
703     private void updateProvisionedValues() {
704         if (getBooleanCarrierConfig(mContext,
705                 CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
706
707             new AsyncUpdateProvisionedValues().execute();
708         }
709     }
710
711     /**
712      * Sync carrier config and user settings with ImsConfig.
713      *
714      * @param context for the manager object
715      * @param phoneId phone id
716      * @param force update
717      */
718     public static void updateImsServiceConfig(Context context, int phoneId, boolean force) {
719         if (!force) {
720             if (TelephonyManager.getDefault().getSimState() != TelephonyManager.SIM_STATE_READY) {
721                 log("updateImsServiceConfig: SIM not ready");
722                 // Don't disable IMS if SIM is not ready
723                 return;
724             }
725         }
726
727         final ImsManager imsManager = ImsManager.getInstance(context, phoneId);
728         if (imsManager != null && (!imsManager.mConfigUpdated || force)) {
729             try {
730                 imsManager.updateProvisionedValues();
731
732                 // TODO: Extend ImsConfig API and set all feature values in single function call.
733
734                 // Note: currently the order of updates is set to produce different order of
735                 // setFeatureValue() function calls from setAdvanced4GMode(). This is done to
736                 // differentiate this code path from vendor code perspective.
737                 boolean isImsUsed = imsManager.updateVolteFeatureValue();
738                 isImsUsed |= imsManager.updateWfcFeatureAndProvisionedValues();
739                 isImsUsed |= imsManager.updateVideoCallFeatureValue();
740
741                 if (isImsUsed || !isTurnOffImsAllowedByPlatform(context)) {
742                     // Turn on IMS if it is used.
743                     // Also, if turning off is not allowed for current carrier,
744                     // we need to turn IMS on because it might be turned off before
745                     // phone switched to current carrier.
746                     log("updateImsServiceConfig: turnOnIms");
747                     imsManager.turnOnIms();
748                 } else {
749                     // Turn off IMS if it is not used AND turning off is allowed for carrier.
750                     log("updateImsServiceConfig: turnOffIms");
751                     imsManager.turnOffIms();
752                 }
753
754                 imsManager.mConfigUpdated = true;
755             } catch (ImsException e) {
756                 loge("updateImsServiceConfig: ", e);
757                 imsManager.mConfigUpdated = false;
758             }
759         }
760     }
761
762     /**
763      * Update VoLTE config
764      * @return whether feature is On
765      * @throws ImsException
766      */
767     private boolean updateVolteFeatureValue() throws ImsException {
768         boolean available = isVolteEnabledByPlatform(mContext);
769         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext);
770         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
771         boolean isFeatureOn = available && enabled && isNonTty;
772
773         log("updateVolteFeatureValue: available = " + available
774                 + ", enabled = " + enabled
775                 + ", nonTTY = " + isNonTty);
776
777         getConfigInterface().setFeatureValue(
778                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
779                 TelephonyManager.NETWORK_TYPE_LTE,
780                 isFeatureOn ?
781                         ImsConfig.FeatureValueConstants.ON :
782                         ImsConfig.FeatureValueConstants.OFF,
783                 mImsConfigListener);
784
785         return isFeatureOn;
786     }
787
788     /**
789      * Update video call over LTE config
790      * @return whether feature is On
791      * @throws ImsException
792      */
793     private boolean updateVideoCallFeatureValue() throws ImsException {
794         boolean available = isVtEnabledByPlatform(mContext);
795         boolean enabled = isVtEnabledByUser(mContext);
796         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
797         boolean isDataEnabled = isDataEnabled();
798         boolean ignoreDataEnabledChanged = getBooleanCarrierConfig(mContext,
799                 CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS);
800
801         boolean isFeatureOn = available && enabled && isNonTty
802                 && (ignoreDataEnabledChanged || isDataEnabled);
803
804         log("updateVideoCallFeatureValue: available = " + available
805                 + ", enabled = " + enabled
806                 + ", nonTTY = " + isNonTty
807                 + ", data enabled = " + isDataEnabled);
808
809         getConfigInterface().setFeatureValue(
810                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
811                 TelephonyManager.NETWORK_TYPE_LTE,
812                 isFeatureOn ?
813                         ImsConfig.FeatureValueConstants.ON :
814                         ImsConfig.FeatureValueConstants.OFF,
815                 mImsConfigListener);
816
817         return isFeatureOn;
818     }
819
820     /**
821      * Update WFC config
822      * @return whether feature is On
823      * @throws ImsException
824      */
825     private boolean updateWfcFeatureAndProvisionedValues() throws ImsException {
826         boolean isNetworkRoaming = TelephonyManager.getDefault().isNetworkRoaming();
827         boolean available = isWfcEnabledByPlatform(mContext);
828         boolean enabled = isWfcEnabledByUser(mContext);
829         int mode = getWfcMode(mContext, isNetworkRoaming);
830         boolean roaming = isWfcRoamingEnabledByUser(mContext);
831         boolean isFeatureOn = available && enabled;
832
833         log("updateWfcFeatureAndProvisionedValues: available = " + available
834                 + ", enabled = " + enabled
835                 + ", mode = " + mode
836                 + ", roaming = " + roaming);
837
838         getConfigInterface().setFeatureValue(
839                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
840                 TelephonyManager.NETWORK_TYPE_IWLAN,
841                 isFeatureOn ?
842                         ImsConfig.FeatureValueConstants.ON :
843                         ImsConfig.FeatureValueConstants.OFF,
844                 mImsConfigListener);
845
846         if (!isFeatureOn) {
847             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
848             roaming = false;
849         }
850         setWfcModeInternal(mContext, mode);
851         setWfcRoamingSettingInternal(mContext, roaming);
852
853         return isFeatureOn;
854     }
855
856     private ImsManager(Context context, int phoneId) {
857         mContext = context;
858         mPhoneId = phoneId;
859         createImsService(true);
860     }
861
862     /*
863      * Returns a flag indicating whether the IMS service is available.
864      */
865     public boolean isServiceAvailable() {
866         if (mImsService != null) {
867             return true;
868         }
869
870         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
871         if (binder != null) {
872             return true;
873         }
874
875         return false;
876     }
877
878     public void setImsConfigListener(ImsConfigListener listener) {
879         mImsConfigListener = listener;
880     }
881
882     /**
883      * Opens the IMS service for making calls and/or receiving generic IMS calls.
884      * The caller may make subsquent calls through {@link #makeCall}.
885      * The IMS service will register the device to the operator's network with the credentials
886      * (from ISIM) periodically in order to receive calls from the operator's network.
887      * When the IMS service receives a new call, it will send out an intent with
888      * the provided action string.
889      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
890      *
891      * @param serviceClass a service class specified in {@link ImsServiceClass}
892      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
893      * @param incomingCallPendingIntent When an incoming call is received,
894      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
895      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
896      *        as the result code and the intent to fill in the call ID; It cannot be null
897      * @param listener To listen to IMS registration events; It cannot be null
898      * @return identifier (greater than 0) for the specified service
899      * @throws NullPointerException if {@code incomingCallPendingIntent}
900      *      or {@code listener} is null
901      * @throws ImsException if calling the IMS service results in an error
902      * @see #getCallId
903      * @see #getServiceId
904      */
905     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
906             ImsConnectionStateListener listener) throws ImsException {
907         checkAndThrowExceptionIfServiceUnavailable();
908
909         if (incomingCallPendingIntent == null) {
910             throw new NullPointerException("incomingCallPendingIntent can't be null");
911         }
912
913         if (listener == null) {
914             throw new NullPointerException("listener can't be null");
915         }
916
917         int result = 0;
918
919         try {
920             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
921                     createRegistrationListenerProxy(serviceClass, listener));
922         } catch (RemoteException e) {
923             throw new ImsException("open()", e,
924                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
925         }
926
927         if (result <= 0) {
928             // If the return value is a minus value,
929             // it means that an error occurred in the service.
930             // So, it needs to convert to the reason code specified in ImsReasonInfo.
931             throw new ImsException("open()", (result * (-1)));
932         }
933
934         return result;
935     }
936
937     /**
938      * Adds registration listener to the IMS service.
939      *
940      * @param serviceClass a service class specified in {@link ImsServiceClass}
941      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
942      * @param listener To listen to IMS registration events; It cannot be null
943      * @throws NullPointerException if {@code listener} is null
944      * @throws ImsException if calling the IMS service results in an error
945      */
946     public void addRegistrationListener(int serviceClass, ImsConnectionStateListener listener)
947             throws ImsException {
948         checkAndThrowExceptionIfServiceUnavailable();
949
950         if (listener == null) {
951             throw new NullPointerException("listener can't be null");
952         }
953
954         try {
955             mImsService.addRegistrationListener(mPhoneId, serviceClass,
956                     createRegistrationListenerProxy(serviceClass, listener));
957         } catch (RemoteException e) {
958             throw new ImsException("addRegistrationListener()", e,
959                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
960         }
961     }
962
963     /**
964      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
965      * All the resources that were allocated to the service are also released.
966      *
967      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
968      * @throws ImsException if calling the IMS service results in an error
969      */
970     public void close(int serviceId) throws ImsException {
971         checkAndThrowExceptionIfServiceUnavailable();
972
973         try {
974             mImsService.close(serviceId);
975         } catch (RemoteException e) {
976             throw new ImsException("close()", e,
977                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
978         } finally {
979             mUt = null;
980             mConfig = null;
981             mEcbm = null;
982             mMultiEndpoint = null;
983         }
984     }
985
986     /**
987      * Gets the configuration interface to provision / withdraw the supplementary service settings.
988      *
989      * @param serviceId a service id which is obtained from {@link ImsManager#open}
990      * @return the Ut interface instance
991      * @throws ImsException if getting the Ut interface results in an error
992      */
993     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
994             throws ImsException {
995         // FIXME: manage the multiple Ut interfaces based on the service id
996         if (mUt == null) {
997             checkAndThrowExceptionIfServiceUnavailable();
998
999             try {
1000                 IImsUt iUt = mImsService.getUtInterface(serviceId);
1001
1002                 if (iUt == null) {
1003                     throw new ImsException("getSupplementaryServiceConfiguration()",
1004                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
1005                 }
1006
1007                 mUt = new ImsUt(iUt);
1008             } catch (RemoteException e) {
1009                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
1010                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1011             }
1012         }
1013
1014         return mUt;
1015     }
1016
1017     /**
1018      * Checks if the IMS service has successfully registered to the IMS network
1019      * with the specified service & call type.
1020      *
1021      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1022      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1023      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1024      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1025      * @param callType a call type that is specified in {@link ImsCallProfile}
1026      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
1027      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1028      *        {@link ImsCallProfile#CALL_TYPE_VT}
1029      *        {@link ImsCallProfile#CALL_TYPE_VS}
1030      * @return true if the specified service id is connected to the IMS network;
1031      *        false otherwise
1032      * @throws ImsException if calling the IMS service results in an error
1033      */
1034     public boolean isConnected(int serviceId, int serviceType, int callType)
1035             throws ImsException {
1036         checkAndThrowExceptionIfServiceUnavailable();
1037
1038         try {
1039             return mImsService.isConnected(serviceId, serviceType, callType);
1040         } catch (RemoteException e) {
1041             throw new ImsException("isServiceConnected()", e,
1042                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1043         }
1044     }
1045
1046     /**
1047      * Checks if the specified IMS service is opend.
1048      *
1049      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1050      * @return true if the specified service id is opened; false otherwise
1051      * @throws ImsException if calling the IMS service results in an error
1052      */
1053     public boolean isOpened(int serviceId) throws ImsException {
1054         checkAndThrowExceptionIfServiceUnavailable();
1055
1056         try {
1057             return mImsService.isOpened(serviceId);
1058         } catch (RemoteException e) {
1059             throw new ImsException("isOpened()", e,
1060                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1061         }
1062     }
1063
1064     /**
1065      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
1066      *
1067      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1068      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1069      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
1070      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1071      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1072      * @param callType a call type that is specified in {@link ImsCallProfile}
1073      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1074      *        {@link ImsCallProfile#CALL_TYPE_VT}
1075      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
1076      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
1077      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
1078      *        {@link ImsCallProfile#CALL_TYPE_VS}
1079      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
1080      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
1081      * @return a {@link ImsCallProfile} object
1082      * @throws ImsException if calling the IMS service results in an error
1083      */
1084     public ImsCallProfile createCallProfile(int serviceId,
1085             int serviceType, int callType) throws ImsException {
1086         checkAndThrowExceptionIfServiceUnavailable();
1087
1088         try {
1089             return mImsService.createCallProfile(serviceId, serviceType, callType);
1090         } catch (RemoteException e) {
1091             throw new ImsException("createCallProfile()", e,
1092                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1093         }
1094     }
1095
1096     /**
1097      * Creates a {@link ImsCall} to make a call.
1098      *
1099      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1100      * @param profile a call profile to make the call
1101      *      (it contains service type, call type, media information, etc.)
1102      * @param participants participants to invite the conference call
1103      * @param listener listen to the call events from {@link ImsCall}
1104      * @return a {@link ImsCall} object
1105      * @throws ImsException if calling the IMS service results in an error
1106      */
1107     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
1108             ImsCall.Listener listener) throws ImsException {
1109         if (DBG) {
1110             log("makeCall :: serviceId=" + serviceId
1111                     + ", profile=" + profile);
1112         }
1113
1114         checkAndThrowExceptionIfServiceUnavailable();
1115
1116         ImsCall call = new ImsCall(mContext, profile);
1117
1118         call.setListener(listener);
1119         ImsCallSession session = createCallSession(serviceId, profile);
1120
1121         if ((callees != null) && (callees.length == 1)) {
1122             call.start(session, callees[0]);
1123         } else {
1124             call.start(session, callees);
1125         }
1126
1127         return call;
1128     }
1129
1130     /**
1131      * Creates a {@link ImsCall} to take an incoming call.
1132      *
1133      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1134      * @param incomingCallIntent the incoming call broadcast intent
1135      * @param listener to listen to the call events from {@link ImsCall}
1136      * @return a {@link ImsCall} object
1137      * @throws ImsException if calling the IMS service results in an error
1138      */
1139     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
1140             ImsCall.Listener listener) throws ImsException {
1141         if (DBG) {
1142             log("takeCall :: serviceId=" + serviceId
1143                     + ", incomingCall=" + incomingCallIntent);
1144         }
1145
1146         checkAndThrowExceptionIfServiceUnavailable();
1147
1148         if (incomingCallIntent == null) {
1149             throw new ImsException("Can't retrieve session with null intent",
1150                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1151         }
1152
1153         int incomingServiceId = getServiceId(incomingCallIntent);
1154
1155         if (serviceId != incomingServiceId) {
1156             throw new ImsException("Service id is mismatched in the incoming call intent",
1157                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1158         }
1159
1160         String callId = getCallId(incomingCallIntent);
1161
1162         if (callId == null) {
1163             throw new ImsException("Call ID missing in the incoming call intent",
1164                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1165         }
1166
1167         try {
1168             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
1169
1170             if (session == null) {
1171                 throw new ImsException("No pending session for the call",
1172                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
1173             }
1174
1175             ImsCall call = new ImsCall(mContext, session.getCallProfile());
1176
1177             call.attachSession(new ImsCallSession(session));
1178             call.setListener(listener);
1179
1180             return call;
1181         } catch (Throwable t) {
1182             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
1183         }
1184     }
1185
1186     /**
1187      * Gets the config interface to get/set service/capability parameters.
1188      *
1189      * @return the ImsConfig instance.
1190      * @throws ImsException if getting the setting interface results in an error.
1191      */
1192     public ImsConfig getConfigInterface() throws ImsException {
1193
1194         if (mConfig == null) {
1195             checkAndThrowExceptionIfServiceUnavailable();
1196
1197             try {
1198                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
1199                 if (config == null) {
1200                     throw new ImsException("getConfigInterface()",
1201                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
1202                 }
1203                 mConfig = new ImsConfig(config, mContext);
1204             } catch (RemoteException e) {
1205                 throw new ImsException("getConfigInterface()", e,
1206                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1207             }
1208         }
1209         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
1210         return mConfig;
1211     }
1212
1213     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
1214             throws ImsException {
1215
1216         checkAndThrowExceptionIfServiceUnavailable();
1217
1218         try {
1219             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
1220         } catch (RemoteException e) {
1221             throw new ImsException("setTTYMode()", e,
1222                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1223         }
1224
1225         if (!getBooleanCarrierConfig(context,
1226                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
1227             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
1228                     isEnhanced4gLteModeSettingEnabledByUser(context));
1229         }
1230     }
1231
1232     /**
1233      * Get the boolean config from carrier config manager.
1234      *
1235      * @param context the context to get carrier service
1236      * @param key config key defined in CarrierConfigManager
1237      * @return boolean value of corresponding key.
1238      */
1239     private static boolean getBooleanCarrierConfig(Context context, String key) {
1240         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1241                 Context.CARRIER_CONFIG_SERVICE);
1242         PersistableBundle b = null;
1243         if (configManager != null) {
1244             b = configManager.getConfig();
1245         }
1246         if (b != null) {
1247             return b.getBoolean(key);
1248         } else {
1249             // Return static default defined in CarrierConfigManager.
1250             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
1251         }
1252     }
1253
1254     /**
1255      * Get the int config from carrier config manager.
1256      *
1257      * @param context the context to get carrier service
1258      * @param key config key defined in CarrierConfigManager
1259      * @return integer value of corresponding key.
1260      */
1261     private static int getIntCarrierConfig(Context context, String key) {
1262         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1263                 Context.CARRIER_CONFIG_SERVICE);
1264         PersistableBundle b = null;
1265         if (configManager != null) {
1266             b = configManager.getConfig();
1267         }
1268         if (b != null) {
1269             return b.getInt(key);
1270         } else {
1271             // Return static default defined in CarrierConfigManager.
1272             return CarrierConfigManager.getDefaultConfig().getInt(key);
1273         }
1274     }
1275
1276     /**
1277      * Gets the call ID from the specified incoming call broadcast intent.
1278      *
1279      * @param incomingCallIntent the incoming call broadcast intent
1280      * @return the call ID or null if the intent does not contain it
1281      */
1282     private static String getCallId(Intent incomingCallIntent) {
1283         if (incomingCallIntent == null) {
1284             return null;
1285         }
1286
1287         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
1288     }
1289
1290     /**
1291      * Gets the service type from the specified incoming call broadcast intent.
1292      *
1293      * @param incomingCallIntent the incoming call broadcast intent
1294      * @return the service identifier or -1 if the intent does not contain it
1295      */
1296     private static int getServiceId(Intent incomingCallIntent) {
1297         if (incomingCallIntent == null) {
1298             return (-1);
1299         }
1300
1301         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
1302     }
1303
1304     /**
1305      * Binds the IMS service only if the service is not created.
1306      */
1307     private void checkAndThrowExceptionIfServiceUnavailable()
1308             throws ImsException {
1309         if (mImsService == null) {
1310             createImsService(true);
1311
1312             if (mImsService == null) {
1313                 throw new ImsException("Service is unavailable",
1314                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1315             }
1316         }
1317     }
1318
1319     private static String getImsServiceName(int phoneId) {
1320         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
1321         return IMS_SERVICE;
1322     }
1323
1324     /**
1325      * Binds the IMS service to make/receive the call.
1326      */
1327     private void createImsService(boolean checkService) {
1328         if (checkService) {
1329             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1330
1331             if (binder == null) {
1332                 return;
1333             }
1334         }
1335
1336         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1337
1338         if (b != null) {
1339             try {
1340                 b.linkToDeath(mDeathRecipient, 0);
1341             } catch (RemoteException e) {
1342             }
1343         }
1344
1345         mImsService = IImsService.Stub.asInterface(b);
1346     }
1347
1348     /**
1349      * Creates a {@link ImsCallSession} with the specified call profile.
1350      * Use other methods, if applicable, instead of interacting with
1351      * {@link ImsCallSession} directly.
1352      *
1353      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1354      * @param profile a call profile to make the call
1355      */
1356     private ImsCallSession createCallSession(int serviceId,
1357             ImsCallProfile profile) throws ImsException {
1358         try {
1359             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1360         } catch (RemoteException e) {
1361             return null;
1362         }
1363     }
1364
1365     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1366             ImsConnectionStateListener listener) {
1367         ImsRegistrationListenerProxy proxy =
1368                 new ImsRegistrationListenerProxy(serviceClass, listener);
1369         return proxy;
1370     }
1371
1372     private static void log(String s) {
1373         Rlog.d(TAG, s);
1374     }
1375
1376     private static void loge(String s) {
1377         Rlog.e(TAG, s);
1378     }
1379
1380     private static void loge(String s, Throwable t) {
1381         Rlog.e(TAG, s, t);
1382     }
1383
1384     /**
1385      * Used for turning on IMS.if its off already
1386      */
1387     private void turnOnIms() throws ImsException {
1388         checkAndThrowExceptionIfServiceUnavailable();
1389
1390         try {
1391             mImsService.turnOnIms(mPhoneId);
1392         } catch (RemoteException e) {
1393             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1394         }
1395     }
1396
1397     private boolean isImsTurnOffAllowed() {
1398         return isTurnOffImsAllowedByPlatform(mContext)
1399                 && (!isWfcEnabledByPlatform(mContext)
1400                 || !isWfcEnabledByUser(mContext));
1401     }
1402
1403     private void setLteFeatureValues(boolean turnOn) {
1404         log("setLteFeatureValues: " + turnOn);
1405         try {
1406             ImsConfig config = getConfigInterface();
1407             if (config != null) {
1408                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1409                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, mImsConfigListener);
1410
1411                 if (isVtEnabledByPlatform(mContext)) {
1412                     boolean ignoreDataEnabledChanged = getBooleanCarrierConfig(mContext,
1413                             CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS);
1414                     boolean enableViLte = turnOn && isVtEnabledByUser(mContext) &&
1415                             (ignoreDataEnabledChanged || isDataEnabled());
1416                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1417                             TelephonyManager.NETWORK_TYPE_LTE,
1418                             enableViLte ? 1 : 0,
1419                             mImsConfigListener);
1420                 }
1421             }
1422         } catch (ImsException e) {
1423             loge("setLteFeatureValues: exception ", e);
1424         }
1425     }
1426
1427     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1428         checkAndThrowExceptionIfServiceUnavailable();
1429
1430         // if turnOn: first set feature values then call turnOnIms()
1431         // if turnOff: only set feature values if IMS turn off is not allowed. If turn off is
1432         // allowed, first call turnOffIms() then set feature values
1433         if (turnOn) {
1434             setLteFeatureValues(turnOn);
1435             log("setAdvanced4GMode: turnOnIms");
1436             turnOnIms();
1437         } else {
1438             if (isImsTurnOffAllowed()) {
1439                 log("setAdvanced4GMode: turnOffIms");
1440                 turnOffIms();
1441             }
1442             setLteFeatureValues(turnOn);
1443         }
1444     }
1445
1446     /**
1447      * Used for turning off IMS completely in order to make the device CSFB'ed.
1448      * Once turned off, all calls will be over CS.
1449      */
1450     private void turnOffIms() throws ImsException {
1451         checkAndThrowExceptionIfServiceUnavailable();
1452
1453         try {
1454             mImsService.turnOffIms(mPhoneId);
1455         } catch (RemoteException e) {
1456             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1457         }
1458     }
1459
1460     /**
1461      * Death recipient class for monitoring IMS service.
1462      */
1463     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1464         @Override
1465         public void binderDied() {
1466             mImsService = null;
1467             mUt = null;
1468             mConfig = null;
1469             mEcbm = null;
1470             mMultiEndpoint = null;
1471
1472             if (mContext != null) {
1473                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1474                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1475                 mContext.sendBroadcast(new Intent(intent));
1476             }
1477         }
1478     }
1479
1480     /**
1481      * Adapter class for {@link IImsRegistrationListener}.
1482      */
1483     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1484         private int mServiceClass;
1485         private ImsConnectionStateListener mListener;
1486
1487         public ImsRegistrationListenerProxy(int serviceClass,
1488                 ImsConnectionStateListener listener) {
1489             mServiceClass = serviceClass;
1490             mListener = listener;
1491         }
1492
1493         public boolean isSameProxy(int serviceClass) {
1494             return (mServiceClass == serviceClass);
1495         }
1496
1497         @Deprecated
1498         public void registrationConnected() {
1499             if (DBG) {
1500                 log("registrationConnected ::");
1501             }
1502
1503             if (mListener != null) {
1504                 mListener.onImsConnected();
1505             }
1506         }
1507
1508         @Deprecated
1509         public void registrationProgressing() {
1510             if (DBG) {
1511                 log("registrationProgressing ::");
1512             }
1513
1514             if (mListener != null) {
1515                 mListener.onImsProgressing();
1516             }
1517         }
1518
1519         @Override
1520         public void registrationConnectedWithRadioTech(int imsRadioTech) {
1521             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1522             //       values in ServiceState.java.
1523             if (DBG) {
1524                 log("registrationConnectedWithRadioTech :: imsRadioTech=" + imsRadioTech);
1525             }
1526
1527             if (mListener != null) {
1528                 mListener.onImsConnected();
1529             }
1530         }
1531
1532         @Override
1533         public void registrationProgressingWithRadioTech(int imsRadioTech) {
1534             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1535             //       values in ServiceState.java.
1536             if (DBG) {
1537                 log("registrationProgressingWithRadioTech :: imsRadioTech=" + imsRadioTech);
1538             }
1539
1540             if (mListener != null) {
1541                 mListener.onImsProgressing();
1542             }
1543         }
1544
1545         @Override
1546         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1547             if (DBG) {
1548                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1549             }
1550
1551             if (mListener != null) {
1552                 mListener.onImsDisconnected(imsReasonInfo);
1553             }
1554         }
1555
1556         @Override
1557         public void registrationResumed() {
1558             if (DBG) {
1559                 log("registrationResumed ::");
1560             }
1561
1562             if (mListener != null) {
1563                 mListener.onImsResumed();
1564             }
1565         }
1566
1567         @Override
1568         public void registrationSuspended() {
1569             if (DBG) {
1570                 log("registrationSuspended ::");
1571             }
1572
1573             if (mListener != null) {
1574                 mListener.onImsSuspended();
1575             }
1576         }
1577
1578         @Override
1579         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1580             log("registrationServiceCapabilityChanged :: serviceClass=" +
1581                     serviceClass + ", event=" + event);
1582
1583             if (mListener != null) {
1584                 mListener.onImsConnected();
1585             }
1586         }
1587
1588         @Override
1589         public void registrationFeatureCapabilityChanged(int serviceClass,
1590                 int[] enabledFeatures, int[] disabledFeatures) {
1591             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1592                     serviceClass);
1593             if (mListener != null) {
1594                 mListener.onFeatureCapabilityChanged(serviceClass,
1595                         enabledFeatures, disabledFeatures);
1596             }
1597         }
1598
1599         @Override
1600         public void voiceMessageCountUpdate(int count) {
1601             log("voiceMessageCountUpdate :: count=" + count);
1602
1603             if (mListener != null) {
1604                 mListener.onVoiceMessageCountChanged(count);
1605             }
1606         }
1607
1608         @Override
1609         public void registrationAssociatedUriChanged(Uri[] uris) {
1610             if (DBG) log("registrationAssociatedUriChanged ::");
1611
1612             if (mListener != null) {
1613                 mListener.registrationAssociatedUriChanged(uris);
1614             }
1615         }
1616     }
1617
1618     /**
1619      * Gets the ECBM interface to request ECBM exit.
1620      *
1621      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1622      * @return the ECBM interface instance
1623      * @throws ImsException if getting the ECBM interface results in an error
1624      */
1625     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1626         if (mEcbm == null) {
1627             checkAndThrowExceptionIfServiceUnavailable();
1628
1629             try {
1630                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1631
1632                 if (iEcbm == null) {
1633                     throw new ImsException("getEcbmInterface()",
1634                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1635                 }
1636                 mEcbm = new ImsEcbm(iEcbm);
1637             } catch (RemoteException e) {
1638                 throw new ImsException("getEcbmInterface()", e,
1639                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1640             }
1641         }
1642         return mEcbm;
1643     }
1644
1645     /**
1646      * Gets the Multi-Endpoint interface to subscribe to multi-enpoint notifications..
1647      *
1648      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1649      * @return the multi-endpoint interface instance
1650      * @throws ImsException if getting the multi-endpoint interface results in an error
1651      */
1652     public ImsMultiEndpoint getMultiEndpointInterface(int serviceId) throws ImsException {
1653         if (mMultiEndpoint == null) {
1654             checkAndThrowExceptionIfServiceUnavailable();
1655
1656             try {
1657                 IImsMultiEndpoint iImsMultiEndpoint = mImsService.getMultiEndpointInterface(
1658                         serviceId);
1659
1660                 if (iImsMultiEndpoint == null) {
1661                     throw new ImsException("getMultiEndpointInterface()",
1662                             ImsReasonInfo.CODE_MULTIENDPOINT_NOT_SUPPORTED);
1663                 }
1664                 mMultiEndpoint = new ImsMultiEndpoint(iImsMultiEndpoint);
1665             } catch (RemoteException e) {
1666                 throw new ImsException("getMultiEndpointInterface()", e,
1667                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1668             }
1669         }
1670         return mMultiEndpoint;
1671     }
1672
1673     /**
1674      * Resets ImsManager settings back to factory defaults.
1675      *
1676      * @hide
1677      */
1678     public static void factoryReset(Context context) {
1679         // Set VoLTE to default
1680         android.provider.Settings.Global.putInt(context.getContentResolver(),
1681                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED,
1682                 ImsConfig.FeatureValueConstants.ON);
1683
1684         // Set VoWiFi to default
1685         android.provider.Settings.Global.putInt(context.getContentResolver(),
1686                 android.provider.Settings.Global.WFC_IMS_ENABLED,
1687                 getBooleanCarrierConfig(context,
1688                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL) ?
1689                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1690
1691         // Set VoWiFi mode to default
1692         android.provider.Settings.Global.putInt(context.getContentResolver(),
1693                 android.provider.Settings.Global.WFC_IMS_MODE,
1694                 getIntCarrierConfig(context,
1695                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
1696
1697         // Set VoWiFi roaming to default
1698         android.provider.Settings.Global.putInt(context.getContentResolver(),
1699                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
1700                 getBooleanCarrierConfig(context,
1701                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
1702                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1703
1704         // Set VT to default
1705         android.provider.Settings.Global.putInt(context.getContentResolver(),
1706                 android.provider.Settings.Global.VT_IMS_ENABLED,
1707                 ImsConfig.FeatureValueConstants.ON);
1708
1709         // Push settings to ImsConfig
1710         ImsManager.updateImsServiceConfig(context,
1711                 SubscriptionManager.getDefaultVoicePhoneId(), true);
1712     }
1713
1714     private boolean isDataEnabled() {
1715         return SystemProperties.getBoolean(DATA_ENABLED_PROP, true);
1716     }
1717
1718     /**
1719      * Set data enabled/disabled flag.
1720      * @param enabled True if data is enabled, otherwise disabled.
1721      */
1722     public void setDataEnabled(boolean enabled) {
1723         log("setDataEnabled: " + enabled);
1724         SystemProperties.set(DATA_ENABLED_PROP, enabled ? TRUE : FALSE);
1725     }
1726
1727     private boolean isVolteProvisioned() {
1728         return SystemProperties.getBoolean(VOLTE_PROVISIONED_PROP, true);
1729     }
1730
1731     private void setVolteProvisionedProperty(boolean provisioned) {
1732         SystemProperties.set(VOLTE_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1733     }
1734
1735     private boolean isWfcProvisioned() {
1736         return SystemProperties.getBoolean(WFC_PROVISIONED_PROP, true);
1737     }
1738
1739     private void setWfcProvisionedProperty(boolean provisioned) {
1740         SystemProperties.set(WFC_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1741     }
1742
1743     private boolean isVtProvisioned() {
1744         return SystemProperties.getBoolean(VT_PROVISIONED_PROP, true);
1745     }
1746
1747     private void setVtProvisionedProperty(boolean provisioned) {
1748         SystemProperties.set(VT_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1749     }
1750
1751     public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
1752         pw.println("ImsManager:");
1753         pw.println("  mPhoneId = " + mPhoneId);
1754         pw.println("  mConfigUpdated = " + mConfigUpdated);
1755         pw.println("  mImsService = " + mImsService);
1756         pw.println("  mDataEnabled = " + isDataEnabled());
1757         pw.println("  ignoreDataEnabledChanged = " + getBooleanCarrierConfig(mContext,
1758                 CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS));
1759
1760         pw.println("  isGbaValid = " + isGbaValid(mContext));
1761         pw.println("  isImsTurnOffAllowed = " + isImsTurnOffAllowed());
1762         pw.println("  isNonTtyOrTtyOnVolteEnabled = " + isNonTtyOrTtyOnVolteEnabled(mContext));
1763
1764         pw.println("  isVolteEnabledByPlatform = " + isVolteEnabledByPlatform(mContext));
1765         pw.println("  isVolteProvisionedOnDevice = " + isVolteProvisionedOnDevice(mContext));
1766         pw.println("  isEnhanced4gLteModeSettingEnabledByUser = " +
1767                 isEnhanced4gLteModeSettingEnabledByUser(mContext));
1768         pw.println("  isVtEnabledByPlatform = " + isVtEnabledByPlatform(mContext));
1769         pw.println("  isVtEnabledByUser = " + isVtEnabledByUser(mContext));
1770
1771         pw.println("  isWfcEnabledByPlatform = " + isWfcEnabledByPlatform(mContext));
1772         pw.println("  isWfcEnabledByUser = " + isWfcEnabledByUser(mContext));
1773         pw.println("  getWfcMode = " + getWfcMode(mContext));
1774         pw.println("  isWfcRoamingEnabledByUser = " + isWfcRoamingEnabledByUser(mContext));
1775
1776         pw.println("  isVtProvisionedOnDevice = " + isVtProvisionedOnDevice(mContext));
1777         pw.println("  isWfcProvisionedOnDevice = " + isWfcProvisionedOnDevice(mContext));
1778         pw.flush();
1779     }
1780 }