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