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