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