Merge "ImsManager: check roaming status in setWfcSetting" into nyc-mr2-dev
[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                 TelephonyManager tm = (TelephonyManager) context
449                         .getSystemService(Context.TELEPHONY_SERVICE);
450                 setWfcModeInternal(context, enabled
451                         // Choose wfc mode per current roaming preference
452                         ? getWfcMode(context, tm.isNetworkRoaming())
453                         // Force IMS to register over LTE when turning off WFC
454                         : ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED);
455             } catch (ImsException e) {
456                 loge("setWfcSetting(): ", e);
457             }
458         }
459     }
460
461     /**
462      * Returns the user configuration of WFC preference setting
463      */
464     public static int getWfcMode(Context context) {
465         int setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
466                 android.provider.Settings.Global.WFC_IMS_MODE, getIntCarrierConfig(context,
467                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
468         if (DBG) log("getWfcMode - setting=" + setting);
469         return setting;
470     }
471
472     /**
473      * Change persistent WFC preference setting
474      */
475     public static void setWfcMode(Context context, int wfcMode) {
476         if (DBG) log("setWfcMode - setting=" + wfcMode);
477         android.provider.Settings.Global.putInt(context.getContentResolver(),
478                 android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
479
480         setWfcModeInternal(context, wfcMode);
481     }
482
483     /**
484      * Returns the user configuration of WFC preference setting
485      *
486      * @param roaming {@code false} for home network setting, {@code true} for roaming  setting
487      */
488     public static int getWfcMode(Context context, boolean roaming) {
489         int setting = 0;
490         if (!roaming) {
491             setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
492                     android.provider.Settings.Global.WFC_IMS_MODE, getIntCarrierConfig(context,
493                             CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
494             if (DBG) log("getWfcMode - setting=" + setting);
495         } else {
496             setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
497                     android.provider.Settings.Global.WFC_IMS_ROAMING_MODE,
498                     getIntCarrierConfig(context,
499                             CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_MODE_INT));
500             if (DBG) log("getWfcMode (roaming) - setting=" + setting);
501         }
502         return setting;
503     }
504
505     /**
506      * Change persistent WFC preference setting
507      *
508      * @param roaming {@code false} for home network setting, {@code true} for roaming setting
509      */
510     public static void setWfcMode(Context context, int wfcMode, boolean roaming) {
511         if (!roaming) {
512             if (DBG) log("setWfcMode - setting=" + wfcMode);
513             android.provider.Settings.Global.putInt(context.getContentResolver(),
514                     android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
515         } else {
516             if (DBG) log("setWfcMode (roaming) - setting=" + wfcMode);
517             android.provider.Settings.Global.putInt(context.getContentResolver(),
518                     android.provider.Settings.Global.WFC_IMS_ROAMING_MODE, wfcMode);
519         }
520
521         TelephonyManager tm = (TelephonyManager)
522                 context.getSystemService(Context.TELEPHONY_SERVICE);
523         if (roaming == tm.isNetworkRoaming()) {
524             setWfcModeInternal(context, wfcMode);
525         }
526     }
527
528     private static void setWfcModeInternal(Context context, int wfcMode) {
529         final ImsManager imsManager = ImsManager.getInstance(context,
530                 SubscriptionManager.getDefaultVoicePhoneId());
531         if (imsManager != null) {
532             final int value = wfcMode;
533             Thread thread = new Thread(new Runnable() {
534                 public void run() {
535                     try {
536                         imsManager.getConfigInterface().setProvisionedValue(
537                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_MODE,
538                                 value);
539                     } catch (ImsException e) {
540                         // do nothing
541                     }
542                 }
543             });
544             thread.start();
545         }
546     }
547
548     /**
549      * Returns the user configuration of WFC roaming setting
550      */
551     public static boolean isWfcRoamingEnabledByUser(Context context) {
552         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
553                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
554                 getBooleanCarrierConfig(context,
555                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
556                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
557         return (enabled == 1) ? true : false;
558     }
559
560     /**
561      * Change persistent WFC roaming enabled setting
562      */
563     public static void setWfcRoamingSetting(Context context, boolean enabled) {
564         android.provider.Settings.Global.putInt(context.getContentResolver(),
565                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
566                 enabled ? ImsConfig.FeatureValueConstants.ON
567                         : ImsConfig.FeatureValueConstants.OFF);
568
569         setWfcRoamingSettingInternal(context, enabled);
570     }
571
572     private static void setWfcRoamingSettingInternal(Context context, boolean enabled) {
573         final ImsManager imsManager = ImsManager.getInstance(context,
574                 SubscriptionManager.getDefaultVoicePhoneId());
575         if (imsManager != null) {
576             final int value = enabled
577                     ? ImsConfig.FeatureValueConstants.ON
578                     : ImsConfig.FeatureValueConstants.OFF;
579             Thread thread = new Thread(new Runnable() {
580                 public void run() {
581                     try {
582                         imsManager.getConfigInterface().setProvisionedValue(
583                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_ROAMING,
584                                 value);
585                     } catch (ImsException e) {
586                         // do nothing
587                     }
588                 }
589             });
590             thread.start();
591         }
592     }
593
594     /**
595      * Returns a platform configuration for WFC which may override the user
596      * setting. Note: WFC presumes that VoLTE is enabled (these are
597      * configuration settings which must be done correctly).
598      */
599     public static boolean isWfcEnabledByPlatform(Context context) {
600         if (SystemProperties.getInt(PROPERTY_DBG_WFC_AVAIL_OVERRIDE,
601                 PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT) == 1) {
602             return true;
603         }
604
605         return
606                context.getResources().getBoolean(
607                        com.android.internal.R.bool.config_device_wfc_ims_available) &&
608                getBooleanCarrierConfig(context,
609                        CarrierConfigManager.KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL) &&
610                isGbaValid(context);
611     }
612
613     /**
614      * If carrier requires that IMS is only available if GBA capable SIM is used,
615      * then this function checks GBA bit in EF IST.
616      *
617      * Format of EF IST is defined in 3GPP TS 31.103 (Section 4.2.7).
618      */
619     private static boolean isGbaValid(Context context) {
620         if (getBooleanCarrierConfig(context,
621                 CarrierConfigManager.KEY_CARRIER_IMS_GBA_REQUIRED_BOOL)) {
622             final TelephonyManager telephonyManager = TelephonyManager.getDefault();
623             String efIst = telephonyManager.getIsimIst();
624             if (efIst == null) {
625                 loge("ISF is NULL");
626                 return true;
627             }
628             boolean result = efIst != null && efIst.length() > 1 &&
629                     (0x02 & (byte)efIst.charAt(1)) != 0;
630             if (DBG) log("GBA capable=" + result + ", ISF=" + efIst);
631             return result;
632         }
633         return true;
634     }
635
636     /**
637      * This function should be called when ImsConfig.ACTION_IMS_CONFIG_CHANGED is received.
638      *
639      * We cannot register receiver in ImsManager because this would lead to resource leak.
640      * ImsManager can be created in different processes and it is not notified when that process
641      * is about to be terminated.
642      *
643      * @hide
644      * */
645     public static void onProvisionedValueChanged(Context context, int item, String value) {
646         if (DBG) Rlog.d(TAG, "onProvisionedValueChanged: item=" + item + " val=" + value);
647         ImsManager mgr = ImsManager.getInstance(context,
648                 SubscriptionManager.getDefaultVoicePhoneId());
649
650         switch (item) {
651             case ImsConfig.ConfigConstants.VLT_SETTING_ENABLED:
652                 mgr.setVolteProvisionedProperty(value.equals("1"));
653                 if (DBG) Rlog.d(TAG,"isVoLteProvisioned = " + mgr.isVolteProvisioned());
654                 break;
655
656             case ImsConfig.ConfigConstants.VOICE_OVER_WIFI_SETTING_ENABLED:
657                 mgr.setWfcProvisionedProperty(value.equals("1"));
658                 if (DBG) Rlog.d(TAG,"isWfcProvisioned = " + mgr.isWfcProvisioned());
659                 break;
660
661             case ImsConfig.ConfigConstants.LVC_SETTING_ENABLED:
662                 mgr.setVtProvisionedProperty(value.equals("1"));
663                 if (DBG) Rlog.d(TAG,"isVtProvisioned = " + mgr.isVtProvisioned());
664                 break;
665
666         }
667     }
668
669     private class AsyncUpdateProvisionedValues extends AsyncTask<Void, Void, Void> {
670         @Override
671         protected Void doInBackground(Void... params) {
672             // disable on any error
673             setVolteProvisionedProperty(false);
674             setWfcProvisionedProperty(false);
675             setVtProvisionedProperty(false);
676
677             try {
678                 ImsConfig config = getConfigInterface();
679                 if (config != null) {
680                     setVolteProvisionedProperty(getProvisionedBool(config,
681                             ImsConfig.ConfigConstants.VLT_SETTING_ENABLED));
682                     if (DBG) Rlog.d(TAG, "isVoLteProvisioned = " + isVolteProvisioned());
683
684                     setWfcProvisionedProperty(getProvisionedBool(config,
685                             ImsConfig.ConfigConstants.VOICE_OVER_WIFI_SETTING_ENABLED));
686                     if (DBG) Rlog.d(TAG, "isWfcProvisioned = " + isWfcProvisioned());
687
688                     setVtProvisionedProperty(getProvisionedBool(config,
689                             ImsConfig.ConfigConstants.LVC_SETTING_ENABLED));
690                     if (DBG) Rlog.d(TAG, "isVtProvisioned = " + isVtProvisioned());
691
692                 }
693             } catch (ImsException ie) {
694                 Rlog.e(TAG, "AsyncUpdateProvisionedValues error: ", ie);
695             }
696
697             return null;
698         }
699
700         private boolean getProvisionedBool(ImsConfig config, int item) throws ImsException {
701             return config.getProvisionedValue(item) == ImsConfig.FeatureValueConstants.ON;
702         }
703     }
704
705     /** Asynchronously get VoLTE, WFC, VT provisioning statuses */
706     private void updateProvisionedValues() {
707         if (getBooleanCarrierConfig(mContext,
708                 CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
709
710             new AsyncUpdateProvisionedValues().execute();
711         }
712     }
713
714     /**
715      * Sync carrier config and user settings with ImsConfig.
716      *
717      * @param context for the manager object
718      * @param phoneId phone id
719      * @param force update
720      */
721     public static void updateImsServiceConfig(Context context, int phoneId, boolean force) {
722         if (!force) {
723             if (TelephonyManager.getDefault().getSimState() != TelephonyManager.SIM_STATE_READY) {
724                 log("updateImsServiceConfig: SIM not ready");
725                 // Don't disable IMS if SIM is not ready
726                 return;
727             }
728         }
729
730         final ImsManager imsManager = ImsManager.getInstance(context, phoneId);
731         if (imsManager != null && (!imsManager.mConfigUpdated || force)) {
732             try {
733                 imsManager.updateProvisionedValues();
734
735                 // TODO: Extend ImsConfig API and set all feature values in single function call.
736
737                 // Note: currently the order of updates is set to produce different order of
738                 // setFeatureValue() function calls from setAdvanced4GMode(). This is done to
739                 // differentiate this code path from vendor code perspective.
740                 boolean isImsUsed = imsManager.updateVolteFeatureValue();
741                 isImsUsed |= imsManager.updateWfcFeatureAndProvisionedValues();
742                 isImsUsed |= imsManager.updateVideoCallFeatureValue();
743
744                 if (isImsUsed || !isTurnOffImsAllowedByPlatform(context)) {
745                     // Turn on IMS if it is used.
746                     // Also, if turning off is not allowed for current carrier,
747                     // we need to turn IMS on because it might be turned off before
748                     // phone switched to current carrier.
749                     log("updateImsServiceConfig: turnOnIms");
750                     imsManager.turnOnIms();
751                 } else {
752                     // Turn off IMS if it is not used AND turning off is allowed for carrier.
753                     log("updateImsServiceConfig: turnOffIms");
754                     imsManager.turnOffIms();
755                 }
756
757                 imsManager.mConfigUpdated = true;
758             } catch (ImsException e) {
759                 loge("updateImsServiceConfig: ", e);
760                 imsManager.mConfigUpdated = false;
761             }
762         }
763     }
764
765     /**
766      * Update VoLTE config
767      * @return whether feature is On
768      * @throws ImsException
769      */
770     private boolean updateVolteFeatureValue() throws ImsException {
771         boolean available = isVolteEnabledByPlatform(mContext);
772         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext);
773         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
774         boolean isFeatureOn = available && enabled && isNonTty;
775
776         log("updateVolteFeatureValue: available = " + available
777                 + ", enabled = " + enabled
778                 + ", nonTTY = " + isNonTty);
779
780         getConfigInterface().setFeatureValue(
781                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
782                 TelephonyManager.NETWORK_TYPE_LTE,
783                 isFeatureOn ?
784                         ImsConfig.FeatureValueConstants.ON :
785                         ImsConfig.FeatureValueConstants.OFF,
786                 mImsConfigListener);
787
788         return isFeatureOn;
789     }
790
791     /**
792      * Update video call over LTE config
793      * @return whether feature is On
794      * @throws ImsException
795      */
796     private boolean updateVideoCallFeatureValue() throws ImsException {
797         boolean available = isVtEnabledByPlatform(mContext);
798         boolean enabled = isVtEnabledByUser(mContext);
799         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
800         boolean isDataEnabled = isDataEnabled();
801         boolean ignoreDataEnabledChanged = getBooleanCarrierConfig(mContext,
802                 CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS);
803
804         boolean isFeatureOn = available && enabled && isNonTty
805                 && (ignoreDataEnabledChanged || isDataEnabled);
806
807         log("updateVideoCallFeatureValue: available = " + available
808                 + ", enabled = " + enabled
809                 + ", nonTTY = " + isNonTty
810                 + ", data enabled = " + isDataEnabled);
811
812         getConfigInterface().setFeatureValue(
813                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
814                 TelephonyManager.NETWORK_TYPE_LTE,
815                 isFeatureOn ?
816                         ImsConfig.FeatureValueConstants.ON :
817                         ImsConfig.FeatureValueConstants.OFF,
818                 mImsConfigListener);
819
820         return isFeatureOn;
821     }
822
823     /**
824      * Update WFC config
825      * @return whether feature is On
826      * @throws ImsException
827      */
828     private boolean updateWfcFeatureAndProvisionedValues() throws ImsException {
829         boolean isNetworkRoaming = TelephonyManager.getDefault().isNetworkRoaming();
830         boolean available = isWfcEnabledByPlatform(mContext);
831         boolean enabled = isWfcEnabledByUser(mContext);
832         int mode = getWfcMode(mContext, isNetworkRoaming);
833         boolean roaming = isWfcRoamingEnabledByUser(mContext);
834         boolean isFeatureOn = available && enabled;
835
836         log("updateWfcFeatureAndProvisionedValues: available = " + available
837                 + ", enabled = " + enabled
838                 + ", mode = " + mode
839                 + ", roaming = " + roaming);
840
841         getConfigInterface().setFeatureValue(
842                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
843                 TelephonyManager.NETWORK_TYPE_IWLAN,
844                 isFeatureOn ?
845                         ImsConfig.FeatureValueConstants.ON :
846                         ImsConfig.FeatureValueConstants.OFF,
847                 mImsConfigListener);
848
849         if (!isFeatureOn) {
850             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
851             roaming = false;
852         }
853         setWfcModeInternal(mContext, mode);
854         setWfcRoamingSettingInternal(mContext, roaming);
855
856         return isFeatureOn;
857     }
858
859     private ImsManager(Context context, int phoneId) {
860         mContext = context;
861         mPhoneId = phoneId;
862         createImsService(true);
863     }
864
865     /*
866      * Returns a flag indicating whether the IMS service is available.
867      */
868     public boolean isServiceAvailable() {
869         if (mImsService != null) {
870             return true;
871         }
872
873         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
874         if (binder != null) {
875             return true;
876         }
877
878         return false;
879     }
880
881     public void setImsConfigListener(ImsConfigListener listener) {
882         mImsConfigListener = listener;
883     }
884
885     /**
886      * Opens the IMS service for making calls and/or receiving generic IMS calls.
887      * The caller may make subsquent calls through {@link #makeCall}.
888      * The IMS service will register the device to the operator's network with the credentials
889      * (from ISIM) periodically in order to receive calls from the operator's network.
890      * When the IMS service receives a new call, it will send out an intent with
891      * the provided action string.
892      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
893      *
894      * @param serviceClass a service class specified in {@link ImsServiceClass}
895      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
896      * @param incomingCallPendingIntent When an incoming call is received,
897      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
898      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
899      *        as the result code and the intent to fill in the call ID; It cannot be null
900      * @param listener To listen to IMS registration events; It cannot be null
901      * @return identifier (greater than 0) for the specified service
902      * @throws NullPointerException if {@code incomingCallPendingIntent}
903      *      or {@code listener} is null
904      * @throws ImsException if calling the IMS service results in an error
905      * @see #getCallId
906      * @see #getServiceId
907      */
908     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
909             ImsConnectionStateListener listener) throws ImsException {
910         checkAndThrowExceptionIfServiceUnavailable();
911
912         if (incomingCallPendingIntent == null) {
913             throw new NullPointerException("incomingCallPendingIntent can't be null");
914         }
915
916         if (listener == null) {
917             throw new NullPointerException("listener can't be null");
918         }
919
920         int result = 0;
921
922         try {
923             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
924                     createRegistrationListenerProxy(serviceClass, listener));
925         } catch (RemoteException e) {
926             throw new ImsException("open()", e,
927                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
928         }
929
930         if (result <= 0) {
931             // If the return value is a minus value,
932             // it means that an error occurred in the service.
933             // So, it needs to convert to the reason code specified in ImsReasonInfo.
934             throw new ImsException("open()", (result * (-1)));
935         }
936
937         return result;
938     }
939
940     /**
941      * Adds registration listener to the IMS service.
942      *
943      * @param serviceClass a service class specified in {@link ImsServiceClass}
944      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
945      * @param listener To listen to IMS registration events; It cannot be null
946      * @throws NullPointerException if {@code listener} is null
947      * @throws ImsException if calling the IMS service results in an error
948      */
949     public void addRegistrationListener(int serviceClass, ImsConnectionStateListener listener)
950             throws ImsException {
951         checkAndThrowExceptionIfServiceUnavailable();
952
953         if (listener == null) {
954             throw new NullPointerException("listener can't be null");
955         }
956
957         try {
958             mImsService.addRegistrationListener(mPhoneId, serviceClass,
959                     createRegistrationListenerProxy(serviceClass, listener));
960         } catch (RemoteException e) {
961             throw new ImsException("addRegistrationListener()", e,
962                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
963         }
964     }
965
966     /**
967      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
968      * All the resources that were allocated to the service are also released.
969      *
970      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
971      * @throws ImsException if calling the IMS service results in an error
972      */
973     public void close(int serviceId) throws ImsException {
974         checkAndThrowExceptionIfServiceUnavailable();
975
976         try {
977             mImsService.close(serviceId);
978         } catch (RemoteException e) {
979             throw new ImsException("close()", e,
980                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
981         } finally {
982             mUt = null;
983             mConfig = null;
984             mEcbm = null;
985             mMultiEndpoint = null;
986         }
987     }
988
989     /**
990      * Gets the configuration interface to provision / withdraw the supplementary service settings.
991      *
992      * @param serviceId a service id which is obtained from {@link ImsManager#open}
993      * @return the Ut interface instance
994      * @throws ImsException if getting the Ut interface results in an error
995      */
996     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
997             throws ImsException {
998         // FIXME: manage the multiple Ut interfaces based on the service id
999         if (mUt == null) {
1000             checkAndThrowExceptionIfServiceUnavailable();
1001
1002             try {
1003                 IImsUt iUt = mImsService.getUtInterface(serviceId);
1004
1005                 if (iUt == null) {
1006                     throw new ImsException("getSupplementaryServiceConfiguration()",
1007                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
1008                 }
1009
1010                 mUt = new ImsUt(iUt);
1011             } catch (RemoteException e) {
1012                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
1013                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1014             }
1015         }
1016
1017         return mUt;
1018     }
1019
1020     /**
1021      * Checks if the IMS service has successfully registered to the IMS network
1022      * with the specified service & call type.
1023      *
1024      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1025      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1026      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1027      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1028      * @param callType a call type that is specified in {@link ImsCallProfile}
1029      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
1030      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1031      *        {@link ImsCallProfile#CALL_TYPE_VT}
1032      *        {@link ImsCallProfile#CALL_TYPE_VS}
1033      * @return true if the specified service id is connected to the IMS network;
1034      *        false otherwise
1035      * @throws ImsException if calling the IMS service results in an error
1036      */
1037     public boolean isConnected(int serviceId, int serviceType, int callType)
1038             throws ImsException {
1039         checkAndThrowExceptionIfServiceUnavailable();
1040
1041         try {
1042             return mImsService.isConnected(serviceId, serviceType, callType);
1043         } catch (RemoteException e) {
1044             throw new ImsException("isServiceConnected()", e,
1045                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1046         }
1047     }
1048
1049     /**
1050      * Checks if the specified IMS service is opend.
1051      *
1052      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1053      * @return true if the specified service id is opened; false otherwise
1054      * @throws ImsException if calling the IMS service results in an error
1055      */
1056     public boolean isOpened(int serviceId) throws ImsException {
1057         checkAndThrowExceptionIfServiceUnavailable();
1058
1059         try {
1060             return mImsService.isOpened(serviceId);
1061         } catch (RemoteException e) {
1062             throw new ImsException("isOpened()", e,
1063                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1064         }
1065     }
1066
1067     /**
1068      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
1069      *
1070      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1071      * @param serviceType a service type that is specified in {@link ImsCallProfile}
1072      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
1073      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
1074      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
1075      * @param callType a call type that is specified in {@link ImsCallProfile}
1076      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
1077      *        {@link ImsCallProfile#CALL_TYPE_VT}
1078      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
1079      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
1080      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
1081      *        {@link ImsCallProfile#CALL_TYPE_VS}
1082      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
1083      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
1084      * @return a {@link ImsCallProfile} object
1085      * @throws ImsException if calling the IMS service results in an error
1086      */
1087     public ImsCallProfile createCallProfile(int serviceId,
1088             int serviceType, int callType) throws ImsException {
1089         checkAndThrowExceptionIfServiceUnavailable();
1090
1091         try {
1092             return mImsService.createCallProfile(serviceId, serviceType, callType);
1093         } catch (RemoteException e) {
1094             throw new ImsException("createCallProfile()", e,
1095                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1096         }
1097     }
1098
1099     /**
1100      * Creates a {@link ImsCall} to make a call.
1101      *
1102      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1103      * @param profile a call profile to make the call
1104      *      (it contains service type, call type, media information, etc.)
1105      * @param participants participants to invite the conference call
1106      * @param listener listen to the call events from {@link ImsCall}
1107      * @return a {@link ImsCall} object
1108      * @throws ImsException if calling the IMS service results in an error
1109      */
1110     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
1111             ImsCall.Listener listener) throws ImsException {
1112         if (DBG) {
1113             log("makeCall :: serviceId=" + serviceId
1114                     + ", profile=" + profile);
1115         }
1116
1117         checkAndThrowExceptionIfServiceUnavailable();
1118
1119         ImsCall call = new ImsCall(mContext, profile);
1120
1121         call.setListener(listener);
1122         ImsCallSession session = createCallSession(serviceId, profile);
1123
1124         if ((callees != null) && (callees.length == 1)) {
1125             call.start(session, callees[0]);
1126         } else {
1127             call.start(session, callees);
1128         }
1129
1130         return call;
1131     }
1132
1133     /**
1134      * Creates a {@link ImsCall} to take an incoming call.
1135      *
1136      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1137      * @param incomingCallIntent the incoming call broadcast intent
1138      * @param listener to listen to the call events from {@link ImsCall}
1139      * @return a {@link ImsCall} object
1140      * @throws ImsException if calling the IMS service results in an error
1141      */
1142     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
1143             ImsCall.Listener listener) throws ImsException {
1144         if (DBG) {
1145             log("takeCall :: serviceId=" + serviceId
1146                     + ", incomingCall=" + incomingCallIntent);
1147         }
1148
1149         checkAndThrowExceptionIfServiceUnavailable();
1150
1151         if (incomingCallIntent == null) {
1152             throw new ImsException("Can't retrieve session with null intent",
1153                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1154         }
1155
1156         int incomingServiceId = getServiceId(incomingCallIntent);
1157
1158         if (serviceId != incomingServiceId) {
1159             throw new ImsException("Service id is mismatched in the incoming call intent",
1160                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1161         }
1162
1163         String callId = getCallId(incomingCallIntent);
1164
1165         if (callId == null) {
1166             throw new ImsException("Call ID missing in the incoming call intent",
1167                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
1168         }
1169
1170         try {
1171             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
1172
1173             if (session == null) {
1174                 throw new ImsException("No pending session for the call",
1175                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
1176             }
1177
1178             ImsCall call = new ImsCall(mContext, session.getCallProfile());
1179
1180             call.attachSession(new ImsCallSession(session));
1181             call.setListener(listener);
1182
1183             return call;
1184         } catch (Throwable t) {
1185             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
1186         }
1187     }
1188
1189     /**
1190      * Gets the config interface to get/set service/capability parameters.
1191      *
1192      * @return the ImsConfig instance.
1193      * @throws ImsException if getting the setting interface results in an error.
1194      */
1195     public ImsConfig getConfigInterface() throws ImsException {
1196
1197         if (mConfig == null) {
1198             checkAndThrowExceptionIfServiceUnavailable();
1199
1200             try {
1201                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
1202                 if (config == null) {
1203                     throw new ImsException("getConfigInterface()",
1204                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
1205                 }
1206                 mConfig = new ImsConfig(config, mContext);
1207             } catch (RemoteException e) {
1208                 throw new ImsException("getConfigInterface()", e,
1209                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1210             }
1211         }
1212         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
1213         return mConfig;
1214     }
1215
1216     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
1217             throws ImsException {
1218
1219         checkAndThrowExceptionIfServiceUnavailable();
1220
1221         try {
1222             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
1223         } catch (RemoteException e) {
1224             throw new ImsException("setTTYMode()", e,
1225                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1226         }
1227
1228         if (!getBooleanCarrierConfig(context,
1229                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
1230             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
1231                     isEnhanced4gLteModeSettingEnabledByUser(context));
1232         }
1233     }
1234
1235     /**
1236      * Get the boolean config from carrier config manager.
1237      *
1238      * @param context the context to get carrier service
1239      * @param key config key defined in CarrierConfigManager
1240      * @return boolean value of corresponding key.
1241      */
1242     private static boolean getBooleanCarrierConfig(Context context, String key) {
1243         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1244                 Context.CARRIER_CONFIG_SERVICE);
1245         PersistableBundle b = null;
1246         if (configManager != null) {
1247             b = configManager.getConfig();
1248         }
1249         if (b != null) {
1250             return b.getBoolean(key);
1251         } else {
1252             // Return static default defined in CarrierConfigManager.
1253             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
1254         }
1255     }
1256
1257     /**
1258      * Get the int config from carrier config manager.
1259      *
1260      * @param context the context to get carrier service
1261      * @param key config key defined in CarrierConfigManager
1262      * @return integer value of corresponding key.
1263      */
1264     private static int getIntCarrierConfig(Context context, String key) {
1265         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
1266                 Context.CARRIER_CONFIG_SERVICE);
1267         PersistableBundle b = null;
1268         if (configManager != null) {
1269             b = configManager.getConfig();
1270         }
1271         if (b != null) {
1272             return b.getInt(key);
1273         } else {
1274             // Return static default defined in CarrierConfigManager.
1275             return CarrierConfigManager.getDefaultConfig().getInt(key);
1276         }
1277     }
1278
1279     /**
1280      * Gets the call ID from the specified incoming call broadcast intent.
1281      *
1282      * @param incomingCallIntent the incoming call broadcast intent
1283      * @return the call ID or null if the intent does not contain it
1284      */
1285     private static String getCallId(Intent incomingCallIntent) {
1286         if (incomingCallIntent == null) {
1287             return null;
1288         }
1289
1290         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
1291     }
1292
1293     /**
1294      * Gets the service type from the specified incoming call broadcast intent.
1295      *
1296      * @param incomingCallIntent the incoming call broadcast intent
1297      * @return the service identifier or -1 if the intent does not contain it
1298      */
1299     private static int getServiceId(Intent incomingCallIntent) {
1300         if (incomingCallIntent == null) {
1301             return (-1);
1302         }
1303
1304         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
1305     }
1306
1307     /**
1308      * Binds the IMS service only if the service is not created.
1309      */
1310     private void checkAndThrowExceptionIfServiceUnavailable()
1311             throws ImsException {
1312         if (mImsService == null) {
1313             createImsService(true);
1314
1315             if (mImsService == null) {
1316                 throw new ImsException("Service is unavailable",
1317                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1318             }
1319         }
1320     }
1321
1322     private static String getImsServiceName(int phoneId) {
1323         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
1324         return IMS_SERVICE;
1325     }
1326
1327     /**
1328      * Binds the IMS service to make/receive the call.
1329      */
1330     private void createImsService(boolean checkService) {
1331         if (checkService) {
1332             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1333
1334             if (binder == null) {
1335                 return;
1336             }
1337         }
1338
1339         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1340
1341         if (b != null) {
1342             try {
1343                 b.linkToDeath(mDeathRecipient, 0);
1344             } catch (RemoteException e) {
1345             }
1346         }
1347
1348         mImsService = IImsService.Stub.asInterface(b);
1349     }
1350
1351     /**
1352      * Creates a {@link ImsCallSession} with the specified call profile.
1353      * Use other methods, if applicable, instead of interacting with
1354      * {@link ImsCallSession} directly.
1355      *
1356      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1357      * @param profile a call profile to make the call
1358      */
1359     private ImsCallSession createCallSession(int serviceId,
1360             ImsCallProfile profile) throws ImsException {
1361         try {
1362             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1363         } catch (RemoteException e) {
1364             return null;
1365         }
1366     }
1367
1368     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1369             ImsConnectionStateListener listener) {
1370         ImsRegistrationListenerProxy proxy =
1371                 new ImsRegistrationListenerProxy(serviceClass, listener);
1372         return proxy;
1373     }
1374
1375     private static void log(String s) {
1376         Rlog.d(TAG, s);
1377     }
1378
1379     private static void loge(String s) {
1380         Rlog.e(TAG, s);
1381     }
1382
1383     private static void loge(String s, Throwable t) {
1384         Rlog.e(TAG, s, t);
1385     }
1386
1387     /**
1388      * Used for turning on IMS.if its off already
1389      */
1390     private void turnOnIms() throws ImsException {
1391         checkAndThrowExceptionIfServiceUnavailable();
1392
1393         try {
1394             mImsService.turnOnIms(mPhoneId);
1395         } catch (RemoteException e) {
1396             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1397         }
1398     }
1399
1400     private boolean isImsTurnOffAllowed() {
1401         return isTurnOffImsAllowedByPlatform(mContext)
1402                 && (!isWfcEnabledByPlatform(mContext)
1403                 || !isWfcEnabledByUser(mContext));
1404     }
1405
1406     private void setLteFeatureValues(boolean turnOn) {
1407         log("setLteFeatureValues: " + turnOn);
1408         try {
1409             ImsConfig config = getConfigInterface();
1410             if (config != null) {
1411                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1412                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, mImsConfigListener);
1413
1414                 if (isVtEnabledByPlatform(mContext)) {
1415                     boolean ignoreDataEnabledChanged = getBooleanCarrierConfig(mContext,
1416                             CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS);
1417                     boolean enableViLte = turnOn && isVtEnabledByUser(mContext) &&
1418                             (ignoreDataEnabledChanged || isDataEnabled());
1419                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1420                             TelephonyManager.NETWORK_TYPE_LTE,
1421                             enableViLte ? 1 : 0,
1422                             mImsConfigListener);
1423                 }
1424             }
1425         } catch (ImsException e) {
1426             loge("setLteFeatureValues: exception ", e);
1427         }
1428     }
1429
1430     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1431         checkAndThrowExceptionIfServiceUnavailable();
1432
1433         // if turnOn: first set feature values then call turnOnIms()
1434         // if turnOff: only set feature values if IMS turn off is not allowed. If turn off is
1435         // allowed, first call turnOffIms() then set feature values
1436         if (turnOn) {
1437             setLteFeatureValues(turnOn);
1438             log("setAdvanced4GMode: turnOnIms");
1439             turnOnIms();
1440         } else {
1441             if (isImsTurnOffAllowed()) {
1442                 log("setAdvanced4GMode: turnOffIms");
1443                 turnOffIms();
1444             }
1445             setLteFeatureValues(turnOn);
1446         }
1447     }
1448
1449     /**
1450      * Used for turning off IMS completely in order to make the device CSFB'ed.
1451      * Once turned off, all calls will be over CS.
1452      */
1453     private void turnOffIms() throws ImsException {
1454         checkAndThrowExceptionIfServiceUnavailable();
1455
1456         try {
1457             mImsService.turnOffIms(mPhoneId);
1458         } catch (RemoteException e) {
1459             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1460         }
1461     }
1462
1463     /**
1464      * Death recipient class for monitoring IMS service.
1465      */
1466     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1467         @Override
1468         public void binderDied() {
1469             mImsService = null;
1470             mUt = null;
1471             mConfig = null;
1472             mEcbm = null;
1473             mMultiEndpoint = null;
1474
1475             if (mContext != null) {
1476                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1477                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1478                 mContext.sendBroadcast(new Intent(intent));
1479             }
1480         }
1481     }
1482
1483     /**
1484      * Adapter class for {@link IImsRegistrationListener}.
1485      */
1486     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1487         private int mServiceClass;
1488         private ImsConnectionStateListener mListener;
1489
1490         public ImsRegistrationListenerProxy(int serviceClass,
1491                 ImsConnectionStateListener listener) {
1492             mServiceClass = serviceClass;
1493             mListener = listener;
1494         }
1495
1496         public boolean isSameProxy(int serviceClass) {
1497             return (mServiceClass == serviceClass);
1498         }
1499
1500         @Deprecated
1501         public void registrationConnected() {
1502             if (DBG) {
1503                 log("registrationConnected ::");
1504             }
1505
1506             if (mListener != null) {
1507                 mListener.onImsConnected();
1508             }
1509         }
1510
1511         @Deprecated
1512         public void registrationProgressing() {
1513             if (DBG) {
1514                 log("registrationProgressing ::");
1515             }
1516
1517             if (mListener != null) {
1518                 mListener.onImsProgressing();
1519             }
1520         }
1521
1522         @Override
1523         public void registrationConnectedWithRadioTech(int imsRadioTech) {
1524             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1525             //       values in ServiceState.java.
1526             if (DBG) {
1527                 log("registrationConnectedWithRadioTech :: imsRadioTech=" + imsRadioTech);
1528             }
1529
1530             if (mListener != null) {
1531                 mListener.onImsConnected();
1532             }
1533         }
1534
1535         @Override
1536         public void registrationProgressingWithRadioTech(int imsRadioTech) {
1537             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1538             //       values in ServiceState.java.
1539             if (DBG) {
1540                 log("registrationProgressingWithRadioTech :: imsRadioTech=" + imsRadioTech);
1541             }
1542
1543             if (mListener != null) {
1544                 mListener.onImsProgressing();
1545             }
1546         }
1547
1548         @Override
1549         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1550             if (DBG) {
1551                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1552             }
1553
1554             if (mListener != null) {
1555                 mListener.onImsDisconnected(imsReasonInfo);
1556             }
1557         }
1558
1559         @Override
1560         public void registrationResumed() {
1561             if (DBG) {
1562                 log("registrationResumed ::");
1563             }
1564
1565             if (mListener != null) {
1566                 mListener.onImsResumed();
1567             }
1568         }
1569
1570         @Override
1571         public void registrationSuspended() {
1572             if (DBG) {
1573                 log("registrationSuspended ::");
1574             }
1575
1576             if (mListener != null) {
1577                 mListener.onImsSuspended();
1578             }
1579         }
1580
1581         @Override
1582         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1583             log("registrationServiceCapabilityChanged :: serviceClass=" +
1584                     serviceClass + ", event=" + event);
1585
1586             if (mListener != null) {
1587                 mListener.onImsConnected();
1588             }
1589         }
1590
1591         @Override
1592         public void registrationFeatureCapabilityChanged(int serviceClass,
1593                 int[] enabledFeatures, int[] disabledFeatures) {
1594             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1595                     serviceClass);
1596             if (mListener != null) {
1597                 mListener.onFeatureCapabilityChanged(serviceClass,
1598                         enabledFeatures, disabledFeatures);
1599             }
1600         }
1601
1602         @Override
1603         public void voiceMessageCountUpdate(int count) {
1604             log("voiceMessageCountUpdate :: count=" + count);
1605
1606             if (mListener != null) {
1607                 mListener.onVoiceMessageCountChanged(count);
1608             }
1609         }
1610
1611         @Override
1612         public void registrationAssociatedUriChanged(Uri[] uris) {
1613             if (DBG) log("registrationAssociatedUriChanged ::");
1614
1615             if (mListener != null) {
1616                 mListener.registrationAssociatedUriChanged(uris);
1617             }
1618         }
1619     }
1620
1621     /**
1622      * Gets the ECBM interface to request ECBM exit.
1623      *
1624      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1625      * @return the ECBM interface instance
1626      * @throws ImsException if getting the ECBM interface results in an error
1627      */
1628     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1629         if (mEcbm == null) {
1630             checkAndThrowExceptionIfServiceUnavailable();
1631
1632             try {
1633                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1634
1635                 if (iEcbm == null) {
1636                     throw new ImsException("getEcbmInterface()",
1637                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1638                 }
1639                 mEcbm = new ImsEcbm(iEcbm);
1640             } catch (RemoteException e) {
1641                 throw new ImsException("getEcbmInterface()", e,
1642                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1643             }
1644         }
1645         return mEcbm;
1646     }
1647
1648     /**
1649      * Gets the Multi-Endpoint interface to subscribe to multi-enpoint notifications..
1650      *
1651      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1652      * @return the multi-endpoint interface instance
1653      * @throws ImsException if getting the multi-endpoint interface results in an error
1654      */
1655     public ImsMultiEndpoint getMultiEndpointInterface(int serviceId) throws ImsException {
1656         if (mMultiEndpoint == null) {
1657             checkAndThrowExceptionIfServiceUnavailable();
1658
1659             try {
1660                 IImsMultiEndpoint iImsMultiEndpoint = mImsService.getMultiEndpointInterface(
1661                         serviceId);
1662
1663                 if (iImsMultiEndpoint == null) {
1664                     throw new ImsException("getMultiEndpointInterface()",
1665                             ImsReasonInfo.CODE_MULTIENDPOINT_NOT_SUPPORTED);
1666                 }
1667                 mMultiEndpoint = new ImsMultiEndpoint(iImsMultiEndpoint);
1668             } catch (RemoteException e) {
1669                 throw new ImsException("getMultiEndpointInterface()", e,
1670                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1671             }
1672         }
1673         return mMultiEndpoint;
1674     }
1675
1676     /**
1677      * Resets ImsManager settings back to factory defaults.
1678      *
1679      * @hide
1680      */
1681     public static void factoryReset(Context context) {
1682         // Set VoLTE to default
1683         android.provider.Settings.Global.putInt(context.getContentResolver(),
1684                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED,
1685                 ImsConfig.FeatureValueConstants.ON);
1686
1687         // Set VoWiFi to default
1688         android.provider.Settings.Global.putInt(context.getContentResolver(),
1689                 android.provider.Settings.Global.WFC_IMS_ENABLED,
1690                 getBooleanCarrierConfig(context,
1691                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ENABLED_BOOL) ?
1692                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1693
1694         // Set VoWiFi mode to default
1695         android.provider.Settings.Global.putInt(context.getContentResolver(),
1696                 android.provider.Settings.Global.WFC_IMS_MODE,
1697                 getIntCarrierConfig(context,
1698                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_MODE_INT));
1699
1700         // Set VoWiFi roaming to default
1701         android.provider.Settings.Global.putInt(context.getContentResolver(),
1702                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
1703                 getBooleanCarrierConfig(context,
1704                         CarrierConfigManager.KEY_CARRIER_DEFAULT_WFC_IMS_ROAMING_ENABLED_BOOL) ?
1705                         ImsConfig.FeatureValueConstants.ON : ImsConfig.FeatureValueConstants.OFF);
1706
1707         // Set VT to default
1708         android.provider.Settings.Global.putInt(context.getContentResolver(),
1709                 android.provider.Settings.Global.VT_IMS_ENABLED,
1710                 ImsConfig.FeatureValueConstants.ON);
1711
1712         // Push settings to ImsConfig
1713         ImsManager.updateImsServiceConfig(context,
1714                 SubscriptionManager.getDefaultVoicePhoneId(), true);
1715     }
1716
1717     private boolean isDataEnabled() {
1718         return SystemProperties.getBoolean(DATA_ENABLED_PROP, true);
1719     }
1720
1721     /**
1722      * Set data enabled/disabled flag.
1723      * @param enabled True if data is enabled, otherwise disabled.
1724      */
1725     public void setDataEnabled(boolean enabled) {
1726         log("setDataEnabled: " + enabled);
1727         SystemProperties.set(DATA_ENABLED_PROP, enabled ? TRUE : FALSE);
1728     }
1729
1730     private boolean isVolteProvisioned() {
1731         return SystemProperties.getBoolean(VOLTE_PROVISIONED_PROP, true);
1732     }
1733
1734     private void setVolteProvisionedProperty(boolean provisioned) {
1735         SystemProperties.set(VOLTE_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1736     }
1737
1738     private boolean isWfcProvisioned() {
1739         return SystemProperties.getBoolean(WFC_PROVISIONED_PROP, true);
1740     }
1741
1742     private void setWfcProvisionedProperty(boolean provisioned) {
1743         SystemProperties.set(WFC_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1744     }
1745
1746     private boolean isVtProvisioned() {
1747         return SystemProperties.getBoolean(VT_PROVISIONED_PROP, true);
1748     }
1749
1750     private void setVtProvisionedProperty(boolean provisioned) {
1751         SystemProperties.set(VT_PROVISIONED_PROP, provisioned ? TRUE : FALSE);
1752     }
1753
1754     public void dump(FileDescriptor fd, PrintWriter pw, String[] args) {
1755         pw.println("ImsManager:");
1756         pw.println("  mPhoneId = " + mPhoneId);
1757         pw.println("  mConfigUpdated = " + mConfigUpdated);
1758         pw.println("  mImsService = " + mImsService);
1759         pw.println("  mDataEnabled = " + isDataEnabled());
1760         pw.println("  ignoreDataEnabledChanged = " + getBooleanCarrierConfig(mContext,
1761                 CarrierConfigManager.KEY_IGNORE_DATA_ENABLED_CHANGED_FOR_VIDEO_CALLS));
1762
1763         pw.println("  isGbaValid = " + isGbaValid(mContext));
1764         pw.println("  isImsTurnOffAllowed = " + isImsTurnOffAllowed());
1765         pw.println("  isNonTtyOrTtyOnVolteEnabled = " + isNonTtyOrTtyOnVolteEnabled(mContext));
1766
1767         pw.println("  isVolteEnabledByPlatform = " + isVolteEnabledByPlatform(mContext));
1768         pw.println("  isVolteProvisionedOnDevice = " + isVolteProvisionedOnDevice(mContext));
1769         pw.println("  isEnhanced4gLteModeSettingEnabledByUser = " +
1770                 isEnhanced4gLteModeSettingEnabledByUser(mContext));
1771         pw.println("  isVtEnabledByPlatform = " + isVtEnabledByPlatform(mContext));
1772         pw.println("  isVtEnabledByUser = " + isVtEnabledByUser(mContext));
1773
1774         pw.println("  isWfcEnabledByPlatform = " + isWfcEnabledByPlatform(mContext));
1775         pw.println("  isWfcEnabledByUser = " + isWfcEnabledByUser(mContext));
1776         pw.println("  getWfcMode = " + getWfcMode(mContext));
1777         pw.println("  isWfcRoamingEnabledByUser = " + isWfcRoamingEnabledByUser(mContext));
1778
1779         pw.println("  isVtProvisionedOnDevice = " + isVtProvisionedOnDevice(mContext));
1780         pw.println("  isWfcProvisionedOnDevice = " + isWfcProvisionedOnDevice(mContext));
1781         pw.flush();
1782     }
1783 }