Add ImsManager.addRegistrationListener function
[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                 boolean isImsUsed = imsManager.updateVolteFeatureValue();
559                 isImsUsed |= imsManager.updateVideoCallFeatureValue();
560                 isImsUsed |= imsManager.updateWfcFeatureAndProvisionedValues();
561
562                 if (isImsUsed || !getBooleanCarrierConfig(context,
563                       CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)) {
564                     // Turn on IMS if it is used.
565                     // Also, if turning off is not allowed for current carrier,
566                     // we need to turn IMS on because it might be turned off before
567                     // phone switched to current carrier.
568                     imsManager.turnOnIms();
569                 } else {
570                     // Turn off IMS if it is not used AND turning off is allowed for carrier.
571                     imsManager.turnOffIms();
572                 }
573
574                 imsManager.mConfigUpdated = true;
575             } catch (ImsException e) {
576                 loge("updateImsServiceConfig: " + e);
577                 imsManager.mConfigUpdated = false;
578             }
579         }
580     }
581
582     /**
583      * Update VoLTE config
584      * @return whether feature is On
585      * @throws ImsException
586      */
587     private boolean updateVolteFeatureValue() throws ImsException {
588         boolean available = isVolteEnabledByPlatform(mContext);
589         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext);
590         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
591         boolean isFeatureOn = available && enabled && isNonTty;
592
593         log("updateVolteFeatureValue: available = " + available
594                 + ", enabled = " + enabled
595                 + ", nonTTY = " + isNonTty);
596
597         getConfigInterface().setFeatureValue(
598                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
599                 TelephonyManager.NETWORK_TYPE_LTE,
600                 isFeatureOn ?
601                         ImsConfig.FeatureValueConstants.ON :
602                         ImsConfig.FeatureValueConstants.OFF,
603                 mImsConfigListener);
604
605         return isFeatureOn;
606     }
607
608     /**
609      * Update VC config
610      * @return whether feature is On
611      * @throws ImsException
612      */
613     private boolean updateVideoCallFeatureValue() throws ImsException {
614         boolean available = isVtEnabledByPlatform(mContext);
615         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext) &&
616                 isVtEnabledByUser(mContext);
617         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
618         boolean isFeatureOn = available && enabled && isNonTty;
619
620         log("updateVideoCallFeatureValue: available = " + available
621                 + ", enabled = " + enabled
622                 + ", nonTTY = " + isNonTty);
623
624         getConfigInterface().setFeatureValue(
625                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
626                 TelephonyManager.NETWORK_TYPE_LTE,
627                 isFeatureOn ?
628                         ImsConfig.FeatureValueConstants.ON :
629                         ImsConfig.FeatureValueConstants.OFF,
630                 mImsConfigListener);
631
632         return isFeatureOn;
633     }
634
635     /**
636      * Update WFC config
637      * @return whether feature is On
638      * @throws ImsException
639      */
640     private boolean updateWfcFeatureAndProvisionedValues() throws ImsException {
641         boolean available = isWfcEnabledByPlatform(mContext);
642         boolean enabled = isWfcEnabledByUser(mContext);
643         int mode = getWfcMode(mContext);
644         boolean roaming = isWfcRoamingEnabledByUser(mContext);
645         boolean isFeatureOn = available && enabled;
646
647         log("updateWfcFeatureAndProvisionedValues: available = " + available
648                 + ", enabled = " + enabled
649                 + ", mode = " + mode
650                 + ", roaming = " + roaming);
651
652         getConfigInterface().setFeatureValue(
653                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
654                 TelephonyManager.NETWORK_TYPE_IWLAN,
655                 isFeatureOn ?
656                         ImsConfig.FeatureValueConstants.ON :
657                         ImsConfig.FeatureValueConstants.OFF,
658                 mImsConfigListener);
659
660         if (!isFeatureOn) {
661             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
662             roaming = false;
663         }
664         setWfcModeInternal(mContext, mode);
665         setWfcRoamingSettingInternal(mContext, roaming);
666
667         return isFeatureOn;
668     }
669
670     private ImsManager(Context context, int phoneId) {
671         mContext = context;
672         mPhoneId = phoneId;
673         createImsService(true);
674     }
675
676     /*
677      * Returns a flag indicating whether the IMS service is available.
678      */
679     public boolean isServiceAvailable() {
680         if (mImsService != null) {
681             return true;
682         }
683
684         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
685         if (binder != null) {
686             return true;
687         }
688
689         return false;
690     }
691
692     public void setImsConfigListener(ImsConfigListener listener) {
693         mImsConfigListener = listener;
694     }
695
696     /**
697      * Opens the IMS service for making calls and/or receiving generic IMS calls.
698      * The caller may make subsquent calls through {@link #makeCall}.
699      * The IMS service will register the device to the operator's network with the credentials
700      * (from ISIM) periodically in order to receive calls from the operator's network.
701      * When the IMS service receives a new call, it will send out an intent with
702      * the provided action string.
703      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
704      *
705      * @param serviceClass a service class specified in {@link ImsServiceClass}
706      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
707      * @param incomingCallPendingIntent When an incoming call is received,
708      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
709      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
710      *        as the result code and the intent to fill in the call ID; It cannot be null
711      * @param listener To listen to IMS registration events; It cannot be null
712      * @return identifier (greater than 0) for the specified service
713      * @throws NullPointerException if {@code incomingCallPendingIntent}
714      *      or {@code listener} is null
715      * @throws ImsException if calling the IMS service results in an error
716      * @see #getCallId
717      * @see #getServiceId
718      */
719     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
720             ImsConnectionStateListener listener) throws ImsException {
721         checkAndThrowExceptionIfServiceUnavailable();
722
723         if (incomingCallPendingIntent == null) {
724             throw new NullPointerException("incomingCallPendingIntent can't be null");
725         }
726
727         if (listener == null) {
728             throw new NullPointerException("listener can't be null");
729         }
730
731         int result = 0;
732
733         try {
734             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
735                     createRegistrationListenerProxy(serviceClass, listener));
736         } catch (RemoteException e) {
737             throw new ImsException("open()", e,
738                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
739         }
740
741         if (result <= 0) {
742             // If the return value is a minus value,
743             // it means that an error occurred in the service.
744             // So, it needs to convert to the reason code specified in ImsReasonInfo.
745             throw new ImsException("open()", (result * (-1)));
746         }
747
748         return result;
749     }
750
751     /**
752      * Adds registration listener to the IMS service.
753      *
754      * @param serviceClass a service class specified in {@link ImsServiceClass}
755      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
756      * @param listener To listen to IMS registration events; It cannot be null
757      * @throws NullPointerException if {@code listener} is null
758      * @throws ImsException if calling the IMS service results in an error
759      */
760     public void addRegistrationListener(int serviceClass, ImsConnectionStateListener listener)
761             throws ImsException {
762         checkAndThrowExceptionIfServiceUnavailable();
763
764         if (listener == null) {
765             throw new NullPointerException("listener can't be null");
766         }
767
768         try {
769             mImsService.addRegistrationListener(mPhoneId, serviceClass,
770                     createRegistrationListenerProxy(serviceClass, listener));
771         } catch (RemoteException e) {
772             throw new ImsException("addRegistrationListener()", e,
773                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
774         }
775     }
776
777     /**
778      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
779      * All the resources that were allocated to the service are also released.
780      *
781      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
782      * @throws ImsException if calling the IMS service results in an error
783      */
784     public void close(int serviceId) throws ImsException {
785         checkAndThrowExceptionIfServiceUnavailable();
786
787         try {
788             mImsService.close(serviceId);
789         } catch (RemoteException e) {
790             throw new ImsException("close()", e,
791                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
792         } finally {
793             mUt = null;
794             mConfig = null;
795             mEcbm = null;
796             mMultiEndpoint = null;
797         }
798     }
799
800     /**
801      * Gets the configuration interface to provision / withdraw the supplementary service settings.
802      *
803      * @param serviceId a service id which is obtained from {@link ImsManager#open}
804      * @return the Ut interface instance
805      * @throws ImsException if getting the Ut interface results in an error
806      */
807     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
808             throws ImsException {
809         // FIXME: manage the multiple Ut interfaces based on the service id
810         if (mUt == null) {
811             checkAndThrowExceptionIfServiceUnavailable();
812
813             try {
814                 IImsUt iUt = mImsService.getUtInterface(serviceId);
815
816                 if (iUt == null) {
817                     throw new ImsException("getSupplementaryServiceConfiguration()",
818                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
819                 }
820
821                 mUt = new ImsUt(iUt);
822             } catch (RemoteException e) {
823                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
824                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
825             }
826         }
827
828         return mUt;
829     }
830
831     /**
832      * Checks if the IMS service has successfully registered to the IMS network
833      * with the specified service & call type.
834      *
835      * @param serviceId a service id which is obtained from {@link ImsManager#open}
836      * @param serviceType a service type that is specified in {@link ImsCallProfile}
837      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
838      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
839      * @param callType a call type that is specified in {@link ImsCallProfile}
840      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
841      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
842      *        {@link ImsCallProfile#CALL_TYPE_VT}
843      *        {@link ImsCallProfile#CALL_TYPE_VS}
844      * @return true if the specified service id is connected to the IMS network;
845      *        false otherwise
846      * @throws ImsException if calling the IMS service results in an error
847      */
848     public boolean isConnected(int serviceId, int serviceType, int callType)
849             throws ImsException {
850         checkAndThrowExceptionIfServiceUnavailable();
851
852         try {
853             return mImsService.isConnected(serviceId, serviceType, callType);
854         } catch (RemoteException e) {
855             throw new ImsException("isServiceConnected()", e,
856                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
857         }
858     }
859
860     /**
861      * Checks if the specified IMS service is opend.
862      *
863      * @param serviceId a service id which is obtained from {@link ImsManager#open}
864      * @return true if the specified service id is opened; false otherwise
865      * @throws ImsException if calling the IMS service results in an error
866      */
867     public boolean isOpened(int serviceId) throws ImsException {
868         checkAndThrowExceptionIfServiceUnavailable();
869
870         try {
871             return mImsService.isOpened(serviceId);
872         } catch (RemoteException e) {
873             throw new ImsException("isOpened()", e,
874                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
875         }
876     }
877
878     /**
879      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
880      *
881      * @param serviceId a service id which is obtained from {@link ImsManager#open}
882      * @param serviceType a service type that is specified in {@link ImsCallProfile}
883      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
884      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
885      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
886      * @param callType a call type that is specified in {@link ImsCallProfile}
887      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
888      *        {@link ImsCallProfile#CALL_TYPE_VT}
889      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
890      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
891      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
892      *        {@link ImsCallProfile#CALL_TYPE_VS}
893      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
894      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
895      * @return a {@link ImsCallProfile} object
896      * @throws ImsException if calling the IMS service results in an error
897      */
898     public ImsCallProfile createCallProfile(int serviceId,
899             int serviceType, int callType) throws ImsException {
900         checkAndThrowExceptionIfServiceUnavailable();
901
902         try {
903             return mImsService.createCallProfile(serviceId, serviceType, callType);
904         } catch (RemoteException e) {
905             throw new ImsException("createCallProfile()", e,
906                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
907         }
908     }
909
910     /**
911      * Creates a {@link ImsCall} to make a call.
912      *
913      * @param serviceId a service id which is obtained from {@link ImsManager#open}
914      * @param profile a call profile to make the call
915      *      (it contains service type, call type, media information, etc.)
916      * @param participants participants to invite the conference call
917      * @param listener listen to the call events from {@link ImsCall}
918      * @return a {@link ImsCall} object
919      * @throws ImsException if calling the IMS service results in an error
920      */
921     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
922             ImsCall.Listener listener) throws ImsException {
923         if (DBG) {
924             log("makeCall :: serviceId=" + serviceId
925                     + ", profile=" + profile + ", callees=" + callees);
926         }
927
928         checkAndThrowExceptionIfServiceUnavailable();
929
930         ImsCall call = new ImsCall(mContext, profile);
931
932         call.setListener(listener);
933         ImsCallSession session = createCallSession(serviceId, profile);
934
935         if ((callees != null) && (callees.length == 1)) {
936             call.start(session, callees[0]);
937         } else {
938             call.start(session, callees);
939         }
940
941         return call;
942     }
943
944     /**
945      * Creates a {@link ImsCall} to take an incoming call.
946      *
947      * @param serviceId a service id which is obtained from {@link ImsManager#open}
948      * @param incomingCallIntent the incoming call broadcast intent
949      * @param listener to listen to the call events from {@link ImsCall}
950      * @return a {@link ImsCall} object
951      * @throws ImsException if calling the IMS service results in an error
952      */
953     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
954             ImsCall.Listener listener) throws ImsException {
955         if (DBG) {
956             log("takeCall :: serviceId=" + serviceId
957                     + ", incomingCall=" + incomingCallIntent);
958         }
959
960         checkAndThrowExceptionIfServiceUnavailable();
961
962         if (incomingCallIntent == null) {
963             throw new ImsException("Can't retrieve session with null intent",
964                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
965         }
966
967         int incomingServiceId = getServiceId(incomingCallIntent);
968
969         if (serviceId != incomingServiceId) {
970             throw new ImsException("Service id is mismatched in the incoming call intent",
971                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
972         }
973
974         String callId = getCallId(incomingCallIntent);
975
976         if (callId == null) {
977             throw new ImsException("Call ID missing in the incoming call intent",
978                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
979         }
980
981         try {
982             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
983
984             if (session == null) {
985                 throw new ImsException("No pending session for the call",
986                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
987             }
988
989             ImsCall call = new ImsCall(mContext, session.getCallProfile());
990
991             call.attachSession(new ImsCallSession(session));
992             call.setListener(listener);
993
994             return call;
995         } catch (Throwable t) {
996             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
997         }
998     }
999
1000     /**
1001      * Gets the config interface to get/set service/capability parameters.
1002      *
1003      * @return the ImsConfig instance.
1004      * @throws ImsException if getting the setting interface results in an error.
1005      */
1006     public ImsConfig getConfigInterface() throws ImsException {
1007
1008         if (mConfig == null) {
1009             checkAndThrowExceptionIfServiceUnavailable();
1010
1011             try {
1012                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
1013                 if (config == null) {
1014                     throw new ImsException("getConfigInterface()",
1015                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
1016                 }
1017                 mConfig = new ImsConfig(config, mContext);
1018             } catch (RemoteException e) {
1019                 throw new ImsException("getConfigInterface()", e,
1020                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1021             }
1022         }
1023         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
1024         return mConfig;
1025     }
1026
1027     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
1028             throws ImsException {
1029
1030         checkAndThrowExceptionIfServiceUnavailable();
1031
1032         try {
1033             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
1034         } catch (RemoteException e) {
1035             throw new ImsException("setTTYMode()", e,
1036                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1037         }
1038
1039         if (!getBooleanCarrierConfig(context,
1040                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
1041             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
1042                     isEnhanced4gLteModeSettingEnabledByUser(context));
1043         }
1044     }
1045
1046     /**
1047      * Get the boolean config from carrier config manager.
1048      *
1049      * @param context the context to get carrier service
1050      * @param key config key defined in CarrierConfigManager
1051      * @return boolean value of corresponding key.
1052      */
1053     private static boolean getBooleanCarrierConfig(Context context, String key) {
1054         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1055                 Context.CARRIER_CONFIG_SERVICE);
1056         PersistableBundle b = null;
1057         if (configManager != null) {
1058             b = configManager.getConfig();
1059         }
1060         if (b != null) {
1061             return b.getBoolean(key);
1062         } else {
1063             // Return static default defined in CarrierConfigManager.
1064             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
1065         }
1066     }
1067
1068     /**
1069      * Get the int config from carrier config manager.
1070      *
1071      * @param context the context to get carrier service
1072      * @param key config key defined in CarrierConfigManager
1073      * @return integer value of corresponding key.
1074      */
1075     private static int getIntCarrierConfig(Context context, String key) {
1076         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1077                 Context.CARRIER_CONFIG_SERVICE);
1078         PersistableBundle b = null;
1079         if (configManager != null) {
1080             b = configManager.getConfig();
1081         }
1082         if (b != null) {
1083             return b.getInt(key);
1084         } else {
1085             // Return static default defined in CarrierConfigManager.
1086             return CarrierConfigManager.getDefaultConfig().getInt(key);
1087         }
1088     }
1089
1090     /**
1091      * Gets the call ID from the specified incoming call broadcast intent.
1092      *
1093      * @param incomingCallIntent the incoming call broadcast intent
1094      * @return the call ID or null if the intent does not contain it
1095      */
1096     private static String getCallId(Intent incomingCallIntent) {
1097         if (incomingCallIntent == null) {
1098             return null;
1099         }
1100
1101         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
1102     }
1103
1104     /**
1105      * Gets the service type from the specified incoming call broadcast intent.
1106      *
1107      * @param incomingCallIntent the incoming call broadcast intent
1108      * @return the service identifier or -1 if the intent does not contain it
1109      */
1110     private static int getServiceId(Intent incomingCallIntent) {
1111         if (incomingCallIntent == null) {
1112             return (-1);
1113         }
1114
1115         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
1116     }
1117
1118     /**
1119      * Binds the IMS service only if the service is not created.
1120      */
1121     private void checkAndThrowExceptionIfServiceUnavailable()
1122             throws ImsException {
1123         if (mImsService == null) {
1124             createImsService(true);
1125
1126             if (mImsService == null) {
1127                 throw new ImsException("Service is unavailable",
1128                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1129             }
1130         }
1131     }
1132
1133     private static String getImsServiceName(int phoneId) {
1134         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
1135         return IMS_SERVICE;
1136     }
1137
1138     /**
1139      * Binds the IMS service to make/receive the call.
1140      */
1141     private void createImsService(boolean checkService) {
1142         if (checkService) {
1143             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1144
1145             if (binder == null) {
1146                 return;
1147             }
1148         }
1149
1150         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1151
1152         if (b != null) {
1153             try {
1154                 b.linkToDeath(mDeathRecipient, 0);
1155             } catch (RemoteException e) {
1156             }
1157         }
1158
1159         mImsService = IImsService.Stub.asInterface(b);
1160     }
1161
1162     /**
1163      * Creates a {@link ImsCallSession} with the specified call profile.
1164      * Use other methods, if applicable, instead of interacting with
1165      * {@link ImsCallSession} directly.
1166      *
1167      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1168      * @param profile a call profile to make the call
1169      */
1170     private ImsCallSession createCallSession(int serviceId,
1171             ImsCallProfile profile) throws ImsException {
1172         try {
1173             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1174         } catch (RemoteException e) {
1175             return null;
1176         }
1177     }
1178
1179     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1180             ImsConnectionStateListener listener) {
1181         ImsRegistrationListenerProxy proxy =
1182                 new ImsRegistrationListenerProxy(serviceClass, listener);
1183         return proxy;
1184     }
1185
1186     private static void log(String s) {
1187         Rlog.d(TAG, s);
1188     }
1189
1190     private static void loge(String s) {
1191         Rlog.e(TAG, s);
1192     }
1193
1194     private static void loge(String s, Throwable t) {
1195         Rlog.e(TAG, s, t);
1196     }
1197
1198     /**
1199      * Used for turning on IMS.if its off already
1200      */
1201     private void turnOnIms() throws ImsException {
1202         checkAndThrowExceptionIfServiceUnavailable();
1203
1204         try {
1205             mImsService.turnOnIms(mPhoneId);
1206         } catch (RemoteException e) {
1207             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1208         }
1209     }
1210
1211     private boolean isImsTurnOffAllowed() {
1212         return getBooleanCarrierConfig(mContext,
1213                 CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
1214                 && (!isWfcEnabledByPlatform(mContext)
1215                 || !isWfcEnabledByUser(mContext));
1216     }
1217
1218     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1219         checkAndThrowExceptionIfServiceUnavailable();
1220
1221         try {
1222             ImsConfig config = getConfigInterface();
1223             if (config != null && (turnOn || !isImsTurnOffAllowed())) {
1224                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1225                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, mImsConfigListener);
1226
1227                 if (isVtEnabledByPlatform(mContext)) {
1228                     boolean enableViLte = turnOn && isVtEnabledByUser(mContext);
1229                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1230                             TelephonyManager.NETWORK_TYPE_LTE,
1231                             enableViLte ? 1 : 0,
1232                             mImsConfigListener);
1233                 }
1234             }
1235         } catch (ImsException e) {
1236             log("setAdvanced4GMode() : " + e);
1237         }
1238         if (turnOn) {
1239             turnOnIms();
1240         } else if (isImsTurnOffAllowed()) {
1241             log("setAdvanced4GMode() : imsServiceAllowTurnOff -> turnOffIms");
1242             turnOffIms();
1243         }
1244     }
1245
1246     /**
1247      * Used for turning off IMS completely in order to make the device CSFB'ed.
1248      * Once turned off, all calls will be over CS.
1249      */
1250     private void turnOffIms() throws ImsException {
1251         checkAndThrowExceptionIfServiceUnavailable();
1252
1253         try {
1254             mImsService.turnOffIms(mPhoneId);
1255         } catch (RemoteException e) {
1256             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1257         }
1258     }
1259
1260     /**
1261      * Death recipient class for monitoring IMS service.
1262      */
1263     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1264         @Override
1265         public void binderDied() {
1266             mImsService = null;
1267             mUt = null;
1268             mConfig = null;
1269             mEcbm = null;
1270             mMultiEndpoint = null;
1271
1272             if (mContext != null) {
1273                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1274                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1275                 mContext.sendBroadcast(new Intent(intent));
1276             }
1277         }
1278     }
1279
1280     /**
1281      * Adapter class for {@link IImsRegistrationListener}.
1282      */
1283     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1284         private int mServiceClass;
1285         private ImsConnectionStateListener mListener;
1286
1287         public ImsRegistrationListenerProxy(int serviceClass,
1288                 ImsConnectionStateListener listener) {
1289             mServiceClass = serviceClass;
1290             mListener = listener;
1291         }
1292
1293         public boolean isSameProxy(int serviceClass) {
1294             return (mServiceClass == serviceClass);
1295         }
1296
1297         @Deprecated
1298         public void registrationConnected() {
1299             if (DBG) {
1300                 log("registrationConnected ::");
1301             }
1302
1303             if (mListener != null) {
1304                 mListener.onImsConnected();
1305             }
1306         }
1307
1308         @Deprecated
1309         public void registrationProgressing() {
1310             if (DBG) {
1311                 log("registrationProgressing ::");
1312             }
1313
1314             if (mListener != null) {
1315                 mListener.onImsProgressing();
1316             }
1317         }
1318
1319         @Override
1320         public void registrationConnectedWithRadioTech(int imsRadioTech) {
1321             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1322             //       values in ServiceState.java.
1323             if (DBG) {
1324                 log("registrationConnectedWithRadioTech :: imsRadioTech=" + imsRadioTech);
1325             }
1326
1327             if (mListener != null) {
1328                 mListener.onImsConnected();
1329             }
1330         }
1331
1332         @Override
1333         public void registrationProgressingWithRadioTech(int imsRadioTech) {
1334             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1335             //       values in ServiceState.java.
1336             if (DBG) {
1337                 log("registrationProgressingWithRadioTech :: imsRadioTech=" + imsRadioTech);
1338             }
1339
1340             if (mListener != null) {
1341                 mListener.onImsProgressing();
1342             }
1343         }
1344
1345         @Override
1346         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1347             if (DBG) {
1348                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1349             }
1350
1351             if (mListener != null) {
1352                 mListener.onImsDisconnected(imsReasonInfo);
1353             }
1354         }
1355
1356         @Override
1357         public void registrationResumed() {
1358             if (DBG) {
1359                 log("registrationResumed ::");
1360             }
1361
1362             if (mListener != null) {
1363                 mListener.onImsResumed();
1364             }
1365         }
1366
1367         @Override
1368         public void registrationSuspended() {
1369             if (DBG) {
1370                 log("registrationSuspended ::");
1371             }
1372
1373             if (mListener != null) {
1374                 mListener.onImsSuspended();
1375             }
1376         }
1377
1378         @Override
1379         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1380             log("registrationServiceCapabilityChanged :: serviceClass=" +
1381                     serviceClass + ", event=" + event);
1382
1383             if (mListener != null) {
1384                 mListener.onImsConnected();
1385             }
1386         }
1387
1388         @Override
1389         public void registrationFeatureCapabilityChanged(int serviceClass,
1390                 int[] enabledFeatures, int[] disabledFeatures) {
1391             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1392                     serviceClass);
1393             if (mListener != null) {
1394                 mListener.onFeatureCapabilityChanged(serviceClass,
1395                         enabledFeatures, disabledFeatures);
1396             }
1397         }
1398
1399         @Override
1400         public void voiceMessageCountUpdate(int count) {
1401             log("voiceMessageCountUpdate :: count=" + count);
1402
1403             if (mListener != null) {
1404                 mListener.onVoiceMessageCountChanged(count);
1405             }
1406         }
1407
1408         @Override
1409         public void registrationAssociatedUriChanged(Uri[] uris) {
1410             if (DBG) log("registrationAssociatedUriChanged ::");
1411
1412             if (mListener != null) {
1413                 mListener.registrationAssociatedUriChanged(uris);
1414             }
1415         }
1416     }
1417
1418     /**
1419      * Gets the ECBM interface to request ECBM exit.
1420      *
1421      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1422      * @return the ECBM interface instance
1423      * @throws ImsException if getting the ECBM interface results in an error
1424      */
1425     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1426         if (mEcbm == null) {
1427             checkAndThrowExceptionIfServiceUnavailable();
1428
1429             try {
1430                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1431
1432                 if (iEcbm == null) {
1433                     throw new ImsException("getEcbmInterface()",
1434                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1435                 }
1436                 mEcbm = new ImsEcbm(iEcbm);
1437             } catch (RemoteException e) {
1438                 throw new ImsException("getEcbmInterface()", e,
1439                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1440             }
1441         }
1442         return mEcbm;
1443     }
1444
1445     /**
1446      * Gets the Multi-Endpoint interface to subscribe to multi-enpoint notifications..
1447      *
1448      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1449      * @return the multi-endpoint interface instance
1450      * @throws ImsException if getting the multi-endpoint interface results in an error
1451      */
1452     public ImsMultiEndpoint getMultiEndpointInterface(int serviceId) throws ImsException {
1453         if (mMultiEndpoint == null) {
1454             checkAndThrowExceptionIfServiceUnavailable();
1455
1456             try {
1457                 IImsMultiEndpoint iImsMultiEndpoint = mImsService.getMultiEndpointInterface(
1458                         serviceId);
1459
1460                 if (iImsMultiEndpoint == null) {
1461                     throw new ImsException("getMultiEndpointInterface()",
1462                             ImsReasonInfo.CODE_MULTIENDPOINT_NOT_SUPPORTED);
1463                 }
1464                 mMultiEndpoint = new ImsMultiEndpoint(iImsMultiEndpoint);
1465             } catch (RemoteException e) {
1466                 throw new ImsException("getMultiEndpointInterface()", e,
1467                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1468             }
1469         }
1470         return mMultiEndpoint;
1471     }
1472
1473     /**
1474      * Resets ImsManager settings back to factory defaults.
1475      *
1476      * @hide
1477      */
1478     public static void factoryReset(Context context) {
1479         // Set VoLTE to default
1480         android.provider.Settings.Global.putInt(context.getContentResolver(),
1481                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED,
1482                 ImsConfig.FeatureValueConstants.ON);
1483
1484         // Set VoWiFi to default
1485         android.provider.Settings.Global.putInt(context.getContentResolver(),
1486                 android.provider.Settings.Global.WFC_IMS_ENABLED,
1487                 getBooleanCarrierConfig(context,
1488                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL) ?
1489                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1490
1491         // Set VoWiFi mode to default
1492         android.provider.Settings.Global.putInt(context.getContentResolver(),
1493                 android.provider.Settings.Global.WFC_IMS_MODE,
1494                 getIntCarrierConfig(context,
1495                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
1496
1497         // Set VoWiFi roaming to default
1498         android.provider.Settings.Global.putInt(context.getContentResolver(),
1499                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
1500                 getBooleanCarrierConfig(context,
1501                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
1502                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1503
1504         // Set VT to default
1505         android.provider.Settings.Global.putInt(context.getContentResolver(),
1506                 android.provider.Settings.Global.VT_IMS_ENABLED,
1507                 ImsConfig.FeatureValueConstants.ON);
1508
1509         // Push settings to ImsConfig
1510         ImsManager.updateImsServiceConfig(context,
1511                 SubscriptionManager.getDefaultVoicePhoneId(), true);
1512     }
1513
1514     public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
1515         pw.println("ImsManager:");
1516         pw.println("  mPhoneId = " + mPhoneId);
1517         pw.println("  mConfigUpdated = " + mConfigUpdated);
1518         pw.println("  mImsService = " + mImsService);
1519
1520         pw.println("  isGbaValid = " + isGbaValid(mContext));
1521         pw.println("  isImsTurnOffAllowed = " + isImsTurnOffAllowed());
1522         pw.println("  isNonTtyOrTtyOnVolteEnabled = " + isNonTtyOrTtyOnVolteEnabled(mContext));
1523
1524         pw.println("  isVolteEnabledByPlatform = " + isVolteEnabledByPlatform(mContext));
1525         pw.println("  isVolteProvisionedOnDevice = " + isVolteProvisionedOnDevice(mContext));
1526         pw.println("  isEnhanced4gLteModeSettingEnabledByUser = " +
1527                 isEnhanced4gLteModeSettingEnabledByUser(mContext));
1528         pw.println("  isVtEnabledByPlatform = " + isVtEnabledByPlatform(mContext));
1529         pw.println("  isVtEnabledByUser = " + isVtEnabledByUser(mContext));
1530
1531         pw.println("  isWfcEnabledByPlatform = " + isWfcEnabledByPlatform(mContext));
1532         pw.println("  isWfcEnabledByUser = " + isWfcEnabledByUser(mContext));
1533         pw.println("  getWfcMode = " + getWfcMode(mContext));
1534         pw.println("  isWfcRoamingEnabledByUser = " + isWfcRoamingEnabledByUser(mContext));
1535
1536         pw.flush();
1537     }
1538 }