ImsManager: add wfc roaming mode getter/setter
[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
799         boolean isFeatureOn = available && enabled && isNonTty && isDataEnabled;
800
801         log("updateVideoCallFeatureValue: available = " + available
802                 + ", enabled = " + enabled
803                 + ", nonTTY = " + isNonTty
804                 + ", data enabled = " + isDataEnabled);
805
806         getConfigInterface().setFeatureValue(
807                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
808                 TelephonyManager.NETWORK_TYPE_LTE,
809                 isFeatureOn ?
810                         ImsConfig.FeatureValueConstants.ON :
811                         ImsConfig.FeatureValueConstants.OFF,
812                 mImsConfigListener);
813
814         return isFeatureOn;
815     }
816
817     /**
818      * Update WFC config
819      * @return whether feature is On
820      * @throws ImsException
821      */
822     private boolean updateWfcFeatureAndProvisionedValues() throws ImsException {
823         boolean available = isWfcEnabledByPlatform(mContext);
824         boolean enabled = isWfcEnabledByUser(mContext);
825         int mode = getWfcMode(mContext);
826         boolean roaming = isWfcRoamingEnabledByUser(mContext);
827         boolean isFeatureOn = available && enabled;
828
829         log("updateWfcFeatureAndProvisionedValues: available = " + available
830                 + ", enabled = " + enabled
831                 + ", mode = " + mode
832                 + ", roaming = " + roaming);
833
834         getConfigInterface().setFeatureValue(
835                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
836                 TelephonyManager.NETWORK_TYPE_IWLAN,
837                 isFeatureOn ?
838                         ImsConfig.FeatureValueConstants.ON :
839                         ImsConfig.FeatureValueConstants.OFF,
840                 mImsConfigListener);
841
842         if (!isFeatureOn) {
843             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
844             roaming = false;
845         }
846         setWfcModeInternal(mContext, mode);
847         setWfcRoamingSettingInternal(mContext, roaming);
848
849         return isFeatureOn;
850     }
851
852     private ImsManager(Context context, int phoneId) {
853         mContext = context;
854         mPhoneId = phoneId;
855         createImsService(true);
856     }
857
858     /*
859      * Returns a flag indicating whether the IMS service is available.
860      */
861     public boolean isServiceAvailable() {
862         if (mImsService != null) {
863             return true;
864         }
865
866         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
867         if (binder != null) {
868             return true;
869         }
870
871         return false;
872     }
873
874     public void setImsConfigListener(ImsConfigListener listener) {
875         mImsConfigListener = listener;
876     }
877
878     /**
879      * Opens the IMS service for making calls and/or receiving generic IMS calls.
880      * The caller may make subsquent calls through {@link #makeCall}.
881      * The IMS service will register the device to the operator's network with the credentials
882      * (from ISIM) periodically in order to receive calls from the operator's network.
883      * When the IMS service receives a new call, it will send out an intent with
884      * the provided action string.
885      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
886      *
887      * @param serviceClass a service class specified in {@link ImsServiceClass}
888      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
889      * @param incomingCallPendingIntent When an incoming call is received,
890      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
891      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
892      *        as the result code and the intent to fill in the call ID; It cannot be null
893      * @param listener To listen to IMS registration events; It cannot be null
894      * @return identifier (greater than 0) for the specified service
895      * @throws NullPointerException if {@code incomingCallPendingIntent}
896      *      or {@code listener} is null
897      * @throws ImsException if calling the IMS service results in an error
898      * @see #getCallId
899      * @see #getServiceId
900      */
901     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
902             ImsConnectionStateListener listener) throws ImsException {
903         checkAndThrowExceptionIfServiceUnavailable();
904
905         if (incomingCallPendingIntent == null) {
906             throw new NullPointerException("incomingCallPendingIntent can't be null");
907         }
908
909         if (listener == null) {
910             throw new NullPointerException("listener can't be null");
911         }
912
913         int result = 0;
914
915         try {
916             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
917                     createRegistrationListenerProxy(serviceClass, listener));
918         } catch (RemoteException e) {
919             throw new ImsException("open()", e,
920                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
921         }
922
923         if (result <= 0) {
924             // If the return value is a minus value,
925             // it means that an error occurred in the service.
926             // So, it needs to convert to the reason code specified in ImsReasonInfo.
927             throw new ImsException("open()", (result * (-1)));
928         }
929
930         return result;
931     }
932
933     /**
934      * Adds registration listener to the IMS service.
935      *
936      * @param serviceClass a service class specified in {@link ImsServiceClass}
937      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
938      * @param listener To listen to IMS registration events; It cannot be null
939      * @throws NullPointerException if {@code listener} is null
940      * @throws ImsException if calling the IMS service results in an error
941      */
942     public void addRegistrationListener(int serviceClass, ImsConnectionStateListener listener)
943             throws ImsException {
944         checkAndThrowExceptionIfServiceUnavailable();
945
946         if (listener == null) {
947             throw new NullPointerException("listener can't be null");
948         }
949
950         try {
951             mImsService.addRegistrationListener(mPhoneId, serviceClass,
952                     createRegistrationListenerProxy(serviceClass, listener));
953         } catch (RemoteException e) {
954             throw new ImsException("addRegistrationListener()", e,
955                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
956         }
957     }
958
959     /**
960      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
961      * All the resources that were allocated to the service are also released.
962      *
963      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
964      * @throws ImsException if calling the IMS service results in an error
965      */
966     public void close(int serviceId) throws ImsException {
967         checkAndThrowExceptionIfServiceUnavailable();
968
969         try {
970             mImsService.close(serviceId);
971         } catch (RemoteException e) {
972             throw new ImsException("close()", e,
973                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
974         } finally {
975             mUt = null;
976             mConfig = null;
977             mEcbm = null;
978             mMultiEndpoint = null;
979         }
980     }
981
982     /**
983      * Gets the configuration interface to provision / withdraw the supplementary service settings.
984      *
985      * @param serviceId a service id which is obtained from {@link ImsManager#open}
986      * @return the Ut interface instance
987      * @throws ImsException if getting the Ut interface results in an error
988      */
989     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
990             throws ImsException {
991         // FIXME: manage the multiple Ut interfaces based on the service id
992         if (mUt == null) {
993             checkAndThrowExceptionIfServiceUnavailable();
994
995             try {
996                 IImsUt iUt = mImsService.getUtInterface(serviceId);
997
998                 if (iUt == null) {
999                     throw new ImsException("getSupplementaryServiceConfiguration()",
1000                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
1001                 }
1002
1003                 mUt = new ImsUt(iUt);
1004             } catch (RemoteException e) {
1005                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
1006                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1007             }
1008         }
1009
1010         return mUt;
1011     }
1012
1013     /**
1014      * Checks if the IMS service has successfully registered to the IMS network
1015      * with the specified service & call type.
1016      *
1017      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1018      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1019      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1020      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1021      * @param callType a call type that is specified in {@link ImsCallProfile}
1022      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
1023      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1024      *        {@link ImsCallProfile#CALL_TYPE_VT}
1025      *        {@link ImsCallProfile#CALL_TYPE_VS}
1026      * @return true if the specified service id is connected to the IMS network;
1027      *        false otherwise
1028      * @throws ImsException if calling the IMS service results in an error
1029      */
1030     public boolean isConnected(int serviceId, int serviceType, int callType)
1031             throws ImsException {
1032         checkAndThrowExceptionIfServiceUnavailable();
1033
1034         try {
1035             return mImsService.isConnected(serviceId, serviceType, callType);
1036         } catch (RemoteException e) {
1037             throw new ImsException("isServiceConnected()", e,
1038                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1039         }
1040     }
1041
1042     /**
1043      * Checks if the specified IMS service is opend.
1044      *
1045      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1046      * @return true if the specified service id is opened; false otherwise
1047      * @throws ImsException if calling the IMS service results in an error
1048      */
1049     public boolean isOpened(int serviceId) throws ImsException {
1050         checkAndThrowExceptionIfServiceUnavailable();
1051
1052         try {
1053             return mImsService.isOpened(serviceId);
1054         } catch (RemoteException e) {
1055             throw new ImsException("isOpened()", e,
1056                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1057         }
1058     }
1059
1060     /**
1061      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
1062      *
1063      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1064      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1065      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
1066      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1067      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1068      * @param callType a call type that is specified in {@link ImsCallProfile}
1069      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1070      *        {@link ImsCallProfile#CALL_TYPE_VT}
1071      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
1072      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
1073      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
1074      *        {@link ImsCallProfile#CALL_TYPE_VS}
1075      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
1076      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
1077      * @return a {@link ImsCallProfile} object
1078      * @throws ImsException if calling the IMS service results in an error
1079      */
1080     public ImsCallProfile createCallProfile(int serviceId,
1081             int serviceType, int callType) throws ImsException {
1082         checkAndThrowExceptionIfServiceUnavailable();
1083
1084         try {
1085             return mImsService.createCallProfile(serviceId, serviceType, callType);
1086         } catch (RemoteException e) {
1087             throw new ImsException("createCallProfile()", e,
1088                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1089         }
1090     }
1091
1092     /**
1093      * Creates a {@link ImsCall} to make a call.
1094      *
1095      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1096      * @param profile a call profile to make the call
1097      *      (it contains service type, call type, media information, etc.)
1098      * @param participants participants to invite the conference call
1099      * @param listener listen to the call events from {@link ImsCall}
1100      * @return a {@link ImsCall} object
1101      * @throws ImsException if calling the IMS service results in an error
1102      */
1103     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
1104             ImsCall.Listener listener) throws ImsException {
1105         if (DBG) {
1106             log("makeCall :: serviceId=" + serviceId
1107                     + ", profile=" + profile);
1108         }
1109
1110         checkAndThrowExceptionIfServiceUnavailable();
1111
1112         ImsCall call = new ImsCall(mContext, profile);
1113
1114         call.setListener(listener);
1115         ImsCallSession session = createCallSession(serviceId, profile);
1116
1117         if ((callees != null) && (callees.length == 1)) {
1118             call.start(session, callees[0]);
1119         } else {
1120             call.start(session, callees);
1121         }
1122
1123         return call;
1124     }
1125
1126     /**
1127      * Creates a {@link ImsCall} to take an incoming call.
1128      *
1129      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1130      * @param incomingCallIntent the incoming call broadcast intent
1131      * @param listener to listen to the call events from {@link ImsCall}
1132      * @return a {@link ImsCall} object
1133      * @throws ImsException if calling the IMS service results in an error
1134      */
1135     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
1136             ImsCall.Listener listener) throws ImsException {
1137         if (DBG) {
1138             log("takeCall :: serviceId=" + serviceId
1139                     + ", incomingCall=" + incomingCallIntent);
1140         }
1141
1142         checkAndThrowExceptionIfServiceUnavailable();
1143
1144         if (incomingCallIntent == null) {
1145             throw new ImsException("Can't retrieve session with null intent",
1146                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1147         }
1148
1149         int incomingServiceId = getServiceId(incomingCallIntent);
1150
1151         if (serviceId != incomingServiceId) {
1152             throw new ImsException("Service id is mismatched in the incoming call intent",
1153                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1154         }
1155
1156         String callId = getCallId(incomingCallIntent);
1157
1158         if (callId == null) {
1159             throw new ImsException("Call ID missing in the incoming call intent",
1160                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1161         }
1162
1163         try {
1164             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
1165
1166             if (session == null) {
1167                 throw new ImsException("No pending session for the call",
1168                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
1169             }
1170
1171             ImsCall call = new ImsCall(mContext, session.getCallProfile());
1172
1173             call.attachSession(new ImsCallSession(session));
1174             call.setListener(listener);
1175
1176             return call;
1177         } catch (Throwable t) {
1178             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
1179         }
1180     }
1181
1182     /**
1183      * Gets the config interface to get/set service/capability parameters.
1184      *
1185      * @return the ImsConfig instance.
1186      * @throws ImsException if getting the setting interface results in an error.
1187      */
1188     public ImsConfig getConfigInterface() throws ImsException {
1189
1190         if (mConfig == null) {
1191             checkAndThrowExceptionIfServiceUnavailable();
1192
1193             try {
1194                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
1195                 if (config == null) {
1196                     throw new ImsException("getConfigInterface()",
1197                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
1198                 }
1199                 mConfig = new ImsConfig(config, mContext);
1200             } catch (RemoteException e) {
1201                 throw new ImsException("getConfigInterface()", e,
1202                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1203             }
1204         }
1205         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
1206         return mConfig;
1207     }
1208
1209     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
1210             throws ImsException {
1211
1212         checkAndThrowExceptionIfServiceUnavailable();
1213
1214         try {
1215             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
1216         } catch (RemoteException e) {
1217             throw new ImsException("setTTYMode()", e,
1218                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1219         }
1220
1221         if (!getBooleanCarrierConfig(context,
1222                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
1223             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
1224                     isEnhanced4gLteModeSettingEnabledByUser(context));
1225         }
1226     }
1227
1228     /**
1229      * Get the boolean config from carrier config manager.
1230      *
1231      * @param context the context to get carrier service
1232      * @param key config key defined in CarrierConfigManager
1233      * @return boolean value of corresponding key.
1234      */
1235     private static boolean getBooleanCarrierConfig(Context context, String key) {
1236         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1237                 Context.CARRIER_CONFIG_SERVICE);
1238         PersistableBundle b = null;
1239         if (configManager != null) {
1240             b = configManager.getConfig();
1241         }
1242         if (b != null) {
1243             return b.getBoolean(key);
1244         } else {
1245             // Return static default defined in CarrierConfigManager.
1246             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
1247         }
1248     }
1249
1250     /**
1251      * Get the int config from carrier config manager.
1252      *
1253      * @param context the context to get carrier service
1254      * @param key config key defined in CarrierConfigManager
1255      * @return integer value of corresponding key.
1256      */
1257     private static int getIntCarrierConfig(Context context, String key) {
1258         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1259                 Context.CARRIER_CONFIG_SERVICE);
1260         PersistableBundle b = null;
1261         if (configManager != null) {
1262             b = configManager.getConfig();
1263         }
1264         if (b != null) {
1265             return b.getInt(key);
1266         } else {
1267             // Return static default defined in CarrierConfigManager.
1268             return CarrierConfigManager.getDefaultConfig().getInt(key);
1269         }
1270     }
1271
1272     /**
1273      * Gets the call ID from the specified incoming call broadcast intent.
1274      *
1275      * @param incomingCallIntent the incoming call broadcast intent
1276      * @return the call ID or null if the intent does not contain it
1277      */
1278     private static String getCallId(Intent incomingCallIntent) {
1279         if (incomingCallIntent == null) {
1280             return null;
1281         }
1282
1283         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
1284     }
1285
1286     /**
1287      * Gets the service type from the specified incoming call broadcast intent.
1288      *
1289      * @param incomingCallIntent the incoming call broadcast intent
1290      * @return the service identifier or -1 if the intent does not contain it
1291      */
1292     private static int getServiceId(Intent incomingCallIntent) {
1293         if (incomingCallIntent == null) {
1294             return (-1);
1295         }
1296
1297         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
1298     }
1299
1300     /**
1301      * Binds the IMS service only if the service is not created.
1302      */
1303     private void checkAndThrowExceptionIfServiceUnavailable()
1304             throws ImsException {
1305         if (mImsService == null) {
1306             createImsService(true);
1307
1308             if (mImsService == null) {
1309                 throw new ImsException("Service is unavailable",
1310                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1311             }
1312         }
1313     }
1314
1315     private static String getImsServiceName(int phoneId) {
1316         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
1317         return IMS_SERVICE;
1318     }
1319
1320     /**
1321      * Binds the IMS service to make/receive the call.
1322      */
1323     private void createImsService(boolean checkService) {
1324         if (checkService) {
1325             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1326
1327             if (binder == null) {
1328                 return;
1329             }
1330         }
1331
1332         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1333
1334         if (b != null) {
1335             try {
1336                 b.linkToDeath(mDeathRecipient, 0);
1337             } catch (RemoteException e) {
1338             }
1339         }
1340
1341         mImsService = IImsService.Stub.asInterface(b);
1342     }
1343
1344     /**
1345      * Creates a {@link ImsCallSession} with the specified call profile.
1346      * Use other methods, if applicable, instead of interacting with
1347      * {@link ImsCallSession} directly.
1348      *
1349      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1350      * @param profile a call profile to make the call
1351      */
1352     private ImsCallSession createCallSession(int serviceId,
1353             ImsCallProfile profile) throws ImsException {
1354         try {
1355             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1356         } catch (RemoteException e) {
1357             return null;
1358         }
1359     }
1360
1361     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1362             ImsConnectionStateListener listener) {
1363         ImsRegistrationListenerProxy proxy =
1364                 new ImsRegistrationListenerProxy(serviceClass, listener);
1365         return proxy;
1366     }
1367
1368     private static void log(String s) {
1369         Rlog.d(TAG, s);
1370     }
1371
1372     private static void loge(String s) {
1373         Rlog.e(TAG, s);
1374     }
1375
1376     private static void loge(String s, Throwable t) {
1377         Rlog.e(TAG, s, t);
1378     }
1379
1380     /**
1381      * Used for turning on IMS.if its off already
1382      */
1383     private void turnOnIms() throws ImsException {
1384         checkAndThrowExceptionIfServiceUnavailable();
1385
1386         try {
1387             mImsService.turnOnIms(mPhoneId);
1388         } catch (RemoteException e) {
1389             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1390         }
1391     }
1392
1393     private boolean isImsTurnOffAllowed() {
1394         return isTurnOffImsAllowedByPlatform(mContext)
1395                 && (!isWfcEnabledByPlatform(mContext)
1396                 || !isWfcEnabledByUser(mContext));
1397     }
1398
1399     private void setLteFeatureValues(boolean turnOn) {
1400         log("setLteFeatureValues: " + turnOn);
1401         try {
1402             ImsConfig config = getConfigInterface();
1403             if (config != null) {
1404                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1405                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, mImsConfigListener);
1406
1407                 if (isVtEnabledByPlatform(mContext)) {
1408                     boolean enableViLte = turnOn && isVtEnabledByUser(mContext) &&
1409                             isDataEnabled();
1410                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1411                             TelephonyManager.NETWORK_TYPE_LTE,
1412                             enableViLte ? 1 : 0,
1413                             mImsConfigListener);
1414                 }
1415             }
1416         } catch (ImsException e) {
1417             loge("setLteFeatureValues: exception ", e);
1418         }
1419     }
1420
1421     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1422         checkAndThrowExceptionIfServiceUnavailable();
1423
1424         // if turnOn: first set feature values then call turnOnIms()
1425         // if turnOff: only set feature values if IMS turn off is not allowed. If turn off is
1426         // allowed, first call turnOffIms() then set feature values
1427         if (turnOn) {
1428             setLteFeatureValues(turnOn);
1429             log("setAdvanced4GMode: turnOnIms");
1430             turnOnIms();
1431         } else {
1432             if (isImsTurnOffAllowed()) {
1433                 log("setAdvanced4GMode: turnOffIms");
1434                 turnOffIms();
1435             }
1436             setLteFeatureValues(turnOn);
1437         }
1438     }
1439
1440     /**
1441      * Used for turning off IMS completely in order to make the device CSFB'ed.
1442      * Once turned off, all calls will be over CS.
1443      */
1444     private void turnOffIms() throws ImsException {
1445         checkAndThrowExceptionIfServiceUnavailable();
1446
1447         try {
1448             mImsService.turnOffIms(mPhoneId);
1449         } catch (RemoteException e) {
1450             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1451         }
1452     }
1453
1454     /**
1455      * Death recipient class for monitoring IMS service.
1456      */
1457     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1458         @Override
1459         public void binderDied() {
1460             mImsService = null;
1461             mUt = null;
1462             mConfig = null;
1463             mEcbm = null;
1464             mMultiEndpoint = null;
1465
1466             if (mContext != null) {
1467                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1468                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1469                 mContext.sendBroadcast(new Intent(intent));
1470             }
1471         }
1472     }
1473
1474     /**
1475      * Adapter class for {@link IImsRegistrationListener}.
1476      */
1477     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1478         private int mServiceClass;
1479         private ImsConnectionStateListener mListener;
1480
1481         public ImsRegistrationListenerProxy(int serviceClass,
1482                 ImsConnectionStateListener listener) {
1483             mServiceClass = serviceClass;
1484             mListener = listener;
1485         }
1486
1487         public boolean isSameProxy(int serviceClass) {
1488             return (mServiceClass == serviceClass);
1489         }
1490
1491         @Deprecated
1492         public void registrationConnected() {
1493             if (DBG) {
1494                 log("registrationConnected ::");
1495             }
1496
1497             if (mListener != null) {
1498                 mListener.onImsConnected();
1499             }
1500         }
1501
1502         @Deprecated
1503         public void registrationProgressing() {
1504             if (DBG) {
1505                 log("registrationProgressing ::");
1506             }
1507
1508             if (mListener != null) {
1509                 mListener.onImsProgressing();
1510             }
1511         }
1512
1513         @Override
1514         public void registrationConnectedWithRadioTech(int imsRadioTech) {
1515             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1516             //       values in ServiceState.java.
1517             if (DBG) {
1518                 log("registrationConnectedWithRadioTech :: imsRadioTech=" + imsRadioTech);
1519             }
1520
1521             if (mListener != null) {
1522                 mListener.onImsConnected();
1523             }
1524         }
1525
1526         @Override
1527         public void registrationProgressingWithRadioTech(int imsRadioTech) {
1528             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1529             //       values in ServiceState.java.
1530             if (DBG) {
1531                 log("registrationProgressingWithRadioTech :: imsRadioTech=" + imsRadioTech);
1532             }
1533
1534             if (mListener != null) {
1535                 mListener.onImsProgressing();
1536             }
1537         }
1538
1539         @Override
1540         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1541             if (DBG) {
1542                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1543             }
1544
1545             if (mListener != null) {
1546                 mListener.onImsDisconnected(imsReasonInfo);
1547             }
1548         }
1549
1550         @Override
1551         public void registrationResumed() {
1552             if (DBG) {
1553                 log("registrationResumed ::");
1554             }
1555
1556             if (mListener != null) {
1557                 mListener.onImsResumed();
1558             }
1559         }
1560
1561         @Override
1562         public void registrationSuspended() {
1563             if (DBG) {
1564                 log("registrationSuspended ::");
1565             }
1566
1567             if (mListener != null) {
1568                 mListener.onImsSuspended();
1569             }
1570         }
1571
1572         @Override
1573         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1574             log("registrationServiceCapabilityChanged :: serviceClass=" +
1575                     serviceClass + ", event=" + event);
1576
1577             if (mListener != null) {
1578                 mListener.onImsConnected();
1579             }
1580         }
1581
1582         @Override
1583         public void registrationFeatureCapabilityChanged(int serviceClass,
1584                 int[] enabledFeatures, int[] disabledFeatures) {
1585             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1586                     serviceClass);
1587             if (mListener != null) {
1588                 mListener.onFeatureCapabilityChanged(serviceClass,
1589                         enabledFeatures, disabledFeatures);
1590             }
1591         }
1592
1593         @Override
1594         public void voiceMessageCountUpdate(int count) {
1595             log("voiceMessageCountUpdate :: count=" + count);
1596
1597             if (mListener != null) {
1598                 mListener.onVoiceMessageCountChanged(count);
1599             }
1600         }
1601
1602         @Override
1603         public void registrationAssociatedUriChanged(Uri[] uris) {
1604             if (DBG) log("registrationAssociatedUriChanged ::");
1605
1606             if (mListener != null) {
1607                 mListener.registrationAssociatedUriChanged(uris);
1608             }
1609         }
1610     }
1611
1612     /**
1613      * Gets the ECBM interface to request ECBM exit.
1614      *
1615      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1616      * @return the ECBM interface instance
1617      * @throws ImsException if getting the ECBM interface results in an error
1618      */
1619     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1620         if (mEcbm == null) {
1621             checkAndThrowExceptionIfServiceUnavailable();
1622
1623             try {
1624                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1625
1626                 if (iEcbm == null) {
1627                     throw new ImsException("getEcbmInterface()",
1628                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1629                 }
1630                 mEcbm = new ImsEcbm(iEcbm);
1631             } catch (RemoteException e) {
1632                 throw new ImsException("getEcbmInterface()", e,
1633                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1634             }
1635         }
1636         return mEcbm;
1637     }
1638
1639     /**
1640      * Gets the Multi-Endpoint interface to subscribe to multi-enpoint notifications..
1641      *
1642      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1643      * @return the multi-endpoint interface instance
1644      * @throws ImsException if getting the multi-endpoint interface results in an error
1645      */
1646     public ImsMultiEndpoint getMultiEndpointInterface(int serviceId) throws ImsException {
1647         if (mMultiEndpoint == null) {
1648             checkAndThrowExceptionIfServiceUnavailable();
1649
1650             try {
1651                 IImsMultiEndpoint iImsMultiEndpoint = mImsService.getMultiEndpointInterface(
1652                         serviceId);
1653
1654                 if (iImsMultiEndpoint == null) {
1655                     throw new ImsException("getMultiEndpointInterface()",
1656                             ImsReasonInfo.CODE_MULTIENDPOINT_NOT_SUPPORTED);
1657                 }
1658                 mMultiEndpoint = new ImsMultiEndpoint(iImsMultiEndpoint);
1659             } catch (RemoteException e) {
1660                 throw new ImsException("getMultiEndpointInterface()", e,
1661                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1662             }
1663         }
1664         return mMultiEndpoint;
1665     }
1666
1667     /**
1668      * Resets ImsManager settings back to factory defaults.
1669      *
1670      * @hide
1671      */
1672     public static void factoryReset(Context context) {
1673         // Set VoLTE to default
1674         android.provider.Settings.Global.putInt(context.getContentResolver(),
1675                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED,
1676                 ImsConfig.FeatureValueConstants.ON);
1677
1678         // Set VoWiFi to default
1679         android.provider.Settings.Global.putInt(context.getContentResolver(),
1680                 android.provider.Settings.Global.WFC_IMS_ENABLED,
1681                 getBooleanCarrierConfig(context,
1682                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL) ?
1683                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1684
1685         // Set VoWiFi mode to default
1686         android.provider.Settings.Global.putInt(context.getContentResolver(),
1687                 android.provider.Settings.Global.WFC_IMS_MODE,
1688                 getIntCarrierConfig(context,
1689                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
1690
1691         // Set VoWiFi roaming to default
1692         android.provider.Settings.Global.putInt(context.getContentResolver(),
1693                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
1694                 getBooleanCarrierConfig(context,
1695                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
1696                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1697
1698         // Set VT to default
1699         android.provider.Settings.Global.putInt(context.getContentResolver(),
1700                 android.provider.Settings.Global.VT_IMS_ENABLED,
1701                 ImsConfig.FeatureValueConstants.ON);
1702
1703         // Push settings to ImsConfig
1704         ImsManager.updateImsServiceConfig(context,
1705                 SubscriptionManager.getDefaultVoicePhoneId(), true);
1706     }
1707
1708     private boolean isDataEnabled() {
1709         return SystemProperties.getBoolean(DATA_ENABLED_PROP, true);
1710     }
1711
1712     /**
1713      * Set data enabled/disabled flag.
1714      * @param enabled True if data is enabled, otherwise disabled.
1715      */
1716     public void setDataEnabled(boolean enabled) {
1717         log("setDataEnabled: " + enabled);
1718         SystemProperties.set(DATA_ENABLED_PROP, enabled ? TRUE : FALSE);
1719     }
1720
1721     private boolean isVolteProvisioned() {
1722         return SystemProperties.getBoolean(VOLTE_PROVISIONED_PROP, true);
1723     }
1724
1725     private void setVolteProvisionedProperty(boolean provisioned) {
1726         SystemProperties.set(VOLTE_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1727     }
1728
1729     private boolean isWfcProvisioned() {
1730         return SystemProperties.getBoolean(WFC_PROVISIONED_PROP, true);
1731     }
1732
1733     private void setWfcProvisionedProperty(boolean provisioned) {
1734         SystemProperties.set(WFC_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1735     }
1736
1737     private boolean isVtProvisioned() {
1738         return SystemProperties.getBoolean(VT_PROVISIONED_PROP, true);
1739     }
1740
1741     private void setVtProvisionedProperty(boolean provisioned) {
1742         SystemProperties.set(VT_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1743     }
1744
1745     public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
1746         pw.println("ImsManager:");
1747         pw.println("  mPhoneId = " + mPhoneId);
1748         pw.println("  mConfigUpdated = " + mConfigUpdated);
1749         pw.println("  mImsService = " + mImsService);
1750         pw.println("  mDataEnabled = " + isDataEnabled());
1751
1752         pw.println("  isGbaValid = " + isGbaValid(mContext));
1753         pw.println("  isImsTurnOffAllowed = " + isImsTurnOffAllowed());
1754         pw.println("  isNonTtyOrTtyOnVolteEnabled = " + isNonTtyOrTtyOnVolteEnabled(mContext));
1755
1756         pw.println("  isVolteEnabledByPlatform = " + isVolteEnabledByPlatform(mContext));
1757         pw.println("  isVolteProvisionedOnDevice = " + isVolteProvisionedOnDevice(mContext));
1758         pw.println("  isEnhanced4gLteModeSettingEnabledByUser = " +
1759                 isEnhanced4gLteModeSettingEnabledByUser(mContext));
1760         pw.println("  isVtEnabledByPlatform = " + isVtEnabledByPlatform(mContext));
1761         pw.println("  isVtEnabledByUser = " + isVtEnabledByUser(mContext));
1762
1763         pw.println("  isWfcEnabledByPlatform = " + isWfcEnabledByPlatform(mContext));
1764         pw.println("  isWfcEnabledByUser = " + isWfcEnabledByUser(mContext));
1765         pw.println("  getWfcMode = " + getWfcMode(mContext));
1766         pw.println("  isWfcRoamingEnabledByUser = " + isWfcRoamingEnabledByUser(mContext));
1767
1768         pw.println("  isVtProvisionedOnDevice = " + isVtProvisionedOnDevice(mContext));
1769         pw.println("  isWfcProvisionedOnDevice = " + isWfcProvisionedOnDevice(mContext));
1770         pw.flush();
1771     }
1772 }