am 8ca52ff8: Add ImsManager.updateImsServiceConfig() function
[android/platform/frameworks/opt/net/ims.git] / src / java / com / android / ims / ImsManager.java
1 /*
2  * Copyright (c) 2013 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 package com.android.ims;
18
19 import android.app.PendingIntent;
20 import android.app.QueuedWork;
21 import android.content.Context;
22 import android.content.Intent;
23 import android.content.SharedPreferences;
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.preference.PreferenceManager;
31 import android.provider.Settings;
32 import android.telecom.TelecomManager;
33 import android.telephony.CarrierConfigManager;
34 import android.telephony.Rlog;
35 import android.telephony.SubscriptionManager;
36 import android.telephony.TelephonyManager;
37
38 import com.android.ims.internal.IImsCallSession;
39 import com.android.ims.internal.IImsEcbm;
40 import com.android.ims.internal.IImsEcbmListener;
41 import com.android.ims.internal.IImsRegistrationListener;
42 import com.android.ims.internal.IImsService;
43 import com.android.ims.internal.IImsUt;
44 import com.android.ims.internal.ImsCallSession;
45 import com.android.ims.internal.IImsConfig;
46
47 import java.util.HashMap;
48
49 /**
50  * Provides APIs for IMS services, such as initiating IMS calls, and provides access to
51  * the operator's IMS network. This class is the starting point for any IMS actions.
52  * You can acquire an instance of it with {@link #getInstance getInstance()}.</p>
53  * <p>The APIs in this class allows you to:</p>
54  *
55  * @hide
56  */
57 public class ImsManager {
58
59     /*
60      * Debug flag to override configuration flag
61      */
62     public static final String PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE = "persist.dbg.volte_avail_ovr";
63     public static final int PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT = 0;
64     public static final String PROPERTY_DBG_VT_AVAIL_OVERRIDE = "persist.dbg.vt_avail_ovr";
65     public static final int PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT = 0;
66     public static final String PROPERTY_DBG_WFC_AVAIL_OVERRIDE = "persist.dbg.wfc_avail_ovr";
67     public static final int PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT = 0;
68
69     /**
70      * For accessing the IMS related service.
71      * Internal use only.
72      * @hide
73      */
74     private static final String IMS_SERVICE = "ims";
75
76     /**
77      * The result code to be sent back with the incoming call {@link PendingIntent}.
78      * @see #open(PendingIntent, ImsConnectionStateListener)
79      */
80     public static final int INCOMING_CALL_RESULT_CODE = 101;
81
82     /**
83      * Key to retrieve the call ID from an incoming call intent.
84      * @see #open(PendingIntent, ImsConnectionStateListener)
85      */
86     public static final String EXTRA_CALL_ID = "android:imsCallID";
87
88     /**
89      * Action to broadcast when ImsService is up.
90      * Internal use only.
91      * @hide
92      */
93     public static final String ACTION_IMS_SERVICE_UP =
94             "com.android.ims.IMS_SERVICE_UP";
95
96     /**
97      * Action to broadcast when ImsService is down.
98      * Internal use only.
99      * @hide
100      */
101     public static final String ACTION_IMS_SERVICE_DOWN =
102             "com.android.ims.IMS_SERVICE_DOWN";
103
104     /**
105      * Action to broadcast when ImsService registration fails.
106      * Internal use only.
107      * @hide
108      */
109     public static final String ACTION_IMS_REGISTRATION_ERROR =
110             "com.android.ims.REGISTRATION_ERROR";
111
112     /**
113      * Part of the ACTION_IMS_SERVICE_UP or _DOWN intents.
114      * A long value; the phone ID corresponding to the IMS service coming up or down.
115      * Internal use only.
116      * @hide
117      */
118     public static final String EXTRA_PHONE_ID = "android:phone_id";
119
120     /**
121      * Action for the incoming call intent for the Phone app.
122      * Internal use only.
123      * @hide
124      */
125     public static final String ACTION_IMS_INCOMING_CALL =
126             "com.android.ims.IMS_INCOMING_CALL";
127
128     /**
129      * Part of the ACTION_IMS_INCOMING_CALL intents.
130      * An integer value; service identifier obtained from {@link ImsManager#open}.
131      * Internal use only.
132      * @hide
133      */
134     public static final String EXTRA_SERVICE_ID = "android:imsServiceId";
135
136     /**
137      * Part of the ACTION_IMS_INCOMING_CALL intents.
138      * An boolean value; Flag to indicate that the incoming call is a normal call or call for USSD.
139      * The value "true" indicates that the incoming call is for USSD.
140      * Internal use only.
141      * @hide
142      */
143     public static final String EXTRA_USSD = "android:ussd";
144
145     /**
146      * Part of the ACTION_IMS_INCOMING_CALL intents.
147      * A boolean value; Flag to indicate whether the call is an unknown
148      * dialing call. Such calls are originated by sending commands (like
149      * AT commands) directly to modem without Android involvement.
150      * Even though they are not incoming calls, they are propagated
151      * to Phone app using same ACTION_IMS_INCOMING_CALL intent.
152      * Internal use only.
153      * @hide
154      */
155     public static final String EXTRA_IS_UNKNOWN_CALL = "android:isUnknown";
156
157     private static final String TAG = "ImsManager";
158     private static final boolean DBG = true;
159
160     private static HashMap<Integer, ImsManager> sImsManagerInstances =
161             new HashMap<Integer, ImsManager>();
162
163     private Context mContext;
164     private int mPhoneId;
165     private IImsService mImsService = null;
166     private ImsServiceDeathRecipient mDeathRecipient = new ImsServiceDeathRecipient();
167     // Ut interface for the supplementary service configuration
168     private ImsUt mUt = null;
169     // Interface to get/set ims config items
170     private ImsConfig mConfig = null;
171     private boolean mConfigUpdated = false;
172     private static final String PREF_ENABLE_VIDEO_CALLING_KEY = "enable_video_calling";
173
174     // ECBM interface
175     private ImsEcbm mEcbm = null;
176
177     /**
178      * Gets a manager instance.
179      *
180      * @param context application context for creating the manager object
181      * @param phoneId the phone ID for the IMS Service
182      * @return the manager instance corresponding to the phoneId
183      */
184     public static ImsManager getInstance(Context context, int phoneId) {
185         synchronized (sImsManagerInstances) {
186             if (sImsManagerInstances.containsKey(phoneId))
187                 return sImsManagerInstances.get(phoneId);
188
189             ImsManager mgr = new ImsManager(context, phoneId);
190             sImsManagerInstances.put(phoneId, mgr);
191
192             return mgr;
193         }
194     }
195
196     /**
197      * Returns the user configuration of Enhanced 4G LTE Mode setting
198      */
199     public static boolean isEnhanced4gLteModeSettingEnabledByUser(Context context) {
200         int enabled = android.provider.Settings.Global.getInt(
201                     context.getContentResolver(),
202                     android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, ImsConfig.FeatureValueConstants.ON);
203         return (enabled == 1) ? true : false;
204     }
205
206     /**
207      * Change persistent Enhanced 4G LTE Mode setting
208      */
209     public static void setEnhanced4gLteModeSetting(Context context, boolean enabled) {
210         int value = enabled ? 1 : 0;
211         android.provider.Settings.Global.putInt(
212                 context.getContentResolver(),
213                 android.provider.Settings.Global.ENHANCED_4G_MODE_ENABLED, value);
214
215         if (isNonTtyOrTtyOnVolteEnabled(context)) {
216             ImsManager imsManager = ImsManager.getInstance(context,
217                     SubscriptionManager.getDefaultVoicePhoneId());
218             if (imsManager != null) {
219                 try {
220                     imsManager.setAdvanced4GMode(enabled);
221                 } catch (ImsException ie) {
222                     // do nothing
223                 }
224             }
225         }
226     }
227
228     /**
229      * Indicates whether the call is non-TTY or if TTY - whether TTY on VoLTE is
230      * supported.
231      */
232     public static boolean isNonTtyOrTtyOnVolteEnabled(Context context) {
233         if (getBooleanCarrierConfig(context,
234                     CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
235             return true;
236         }
237
238         return Settings.Secure.getInt(context.getContentResolver(),
239                 Settings.Secure.PREFERRED_TTY_MODE, TelecomManager.TTY_MODE_OFF)
240                 == TelecomManager.TTY_MODE_OFF;
241     }
242
243     /**
244      * Returns a platform configuration for VoLTE which may override the user setting.
245      */
246     public static boolean isVolteEnabledByPlatform(Context context) {
247         if (SystemProperties.getInt(PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE,
248                 PROPERTY_DBG_VOLTE_AVAIL_OVERRIDE_DEFAULT) == 1) {
249             return true;
250         }
251
252         return context.getResources().getBoolean(
253                 com.android.internal.R.bool.config_device_volte_available)
254                 && getBooleanCarrierConfig(context,
255                         CarrierConfigManager.KEY_CARRIER_VOLTE_AVAILABLE_BOOL);
256     }
257
258     /*
259      * Indicates whether VoLTE is provisioned on device
260      */
261     public static boolean isVolteProvisionedOnDevice(Context context) {
262         boolean isProvisioned = true;
263         if (getBooleanCarrierConfig(context,
264                     CarrierConfigManager.KEY_CARRIER_VOLTE_PROVISIONING_REQUIRED_BOOL)) {
265             isProvisioned = false; // disable on any error
266             ImsManager mgr = ImsManager.getInstance(context,
267                     SubscriptionManager.getDefaultVoicePhoneId());
268             if (mgr != null) {
269                 try {
270                     ImsConfig config = mgr.getConfigInterface();
271                     if (config != null) {
272                         isProvisioned = config.getVolteProvisioned();
273                     }
274                 } catch (ImsException ie) {
275                     // do nothing
276                 }
277             }
278         }
279
280         return isProvisioned;
281     }
282
283     /**
284      * Returns a platform configuration for VT which may override the user setting.
285      *
286      * Note: VT presumes that VoLTE is enabled (these are configuration settings
287      * which must be done correctly).
288      */
289     public static boolean isVtEnabledByPlatform(Context context) {
290         if (SystemProperties.getInt(PROPERTY_DBG_VT_AVAIL_OVERRIDE,
291                 PROPERTY_DBG_VT_AVAIL_OVERRIDE_DEFAULT) == 1) {
292             return true;
293         }
294
295         return
296                 context.getResources().getBoolean(
297                         com.android.internal.R.bool.config_device_vt_available) &&
298                 getBooleanCarrierConfig(context,
299                         CarrierConfigManager.KEY_CARRIER_VT_AVAILABLE_BOOL);
300     }
301
302     /**
303      * Returns the user configuration of VT setting
304      */
305     public static boolean isVtEnabledByUser(Context context) {
306         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
307                 android.provider.Settings.Global.VT_IMS_ENABLED,
308                 ImsConfig.FeatureValueConstants.ON);
309         return (enabled == 1) ? true : false;
310     }
311
312     /**
313      * Change persistent VT enabled setting
314      */
315     public static void setVtSetting(Context context, boolean enabled) {
316         int value = enabled ? 1 : 0;
317         android.provider.Settings.Global.putInt(context.getContentResolver(),
318                 android.provider.Settings.Global.VT_IMS_ENABLED, value);
319
320         ImsManager imsManager = ImsManager.getInstance(context,
321                 SubscriptionManager.getDefaultVoicePhoneId());
322         if (imsManager != null) {
323             try {
324                 ImsConfig config = imsManager.getConfigInterface();
325                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
326                         TelephonyManager.NETWORK_TYPE_LTE,
327                         enabled ? ImsConfig.FeatureValueConstants.ON
328                                 : ImsConfig.FeatureValueConstants.OFF, null);
329
330                 if (enabled) {
331                     imsManager.turnOnIms();
332                 } else if (context.getResources().getBoolean(
333                         com.android.internal.R.bool.imsServiceAllowTurnOff) && (
334                         !isVolteEnabledByPlatform(context)
335                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
336                     log("setVtSetting() : imsServiceAllowTurnOff -> turnOffIms");
337                     imsManager.turnOffIms();
338                 }
339             } catch (ImsException e) {
340                 loge("setVtSetting(): " + e);
341             }
342         }
343     }
344
345     /**
346      * Returns the user configuration of WFC setting
347      */
348     public static boolean isWfcEnabledByUser(Context context) {
349         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
350                 android.provider.Settings.Global.WFC_IMS_ENABLED,
351                 ImsConfig.FeatureValueConstants.OFF);
352         return (enabled == 1) ? true : false;
353     }
354
355     /**
356      * Change persistent WFC enabled setting
357      */
358     public static void setWfcSetting(Context context, boolean enabled) {
359         int value = enabled ? 1 : 0;
360         android.provider.Settings.Global.putInt(context.getContentResolver(),
361                 android.provider.Settings.Global.WFC_IMS_ENABLED, value);
362
363         ImsManager imsManager = ImsManager.getInstance(context,
364                 SubscriptionManager.getDefaultVoicePhoneId());
365         if (imsManager != null) {
366             try {
367                 ImsConfig config = imsManager.getConfigInterface();
368                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_WIFI,
369                         TelephonyManager.NETWORK_TYPE_IWLAN,
370                         enabled ? ImsConfig.FeatureValueConstants.ON
371                                 : ImsConfig.FeatureValueConstants.OFF, null);
372
373                 if (enabled) {
374                     imsManager.turnOnIms();
375                 } else if (getBooleanCarrierConfig(context,
376                         CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
377                         && (!isVolteEnabledByPlatform(context)
378                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
379                     log("setWfcSetting() : imsServiceAllowTurnOff -> turnOffIms");
380                     imsManager.turnOffIms();
381                 }
382
383                 // Force IMS to register over LTE when turning off WFC
384                 setWfcModeInternal(context, enabled
385                         ? getWfcMode(context)
386                         : ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED);
387             } catch (ImsException e) {
388                 loge("setWfcSetting(): " + e);
389             }
390         }
391     }
392
393     /**
394      * Returns the user configuration of WFC modem setting
395      */
396     public static int getWfcMode(Context context) {
397         int setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
398                 android.provider.Settings.Global.WFC_IMS_MODE,
399                 ImsConfig.WfcModeFeatureValueConstants.WIFI_PREFERRED);
400         if (DBG) log("getWfcMode - setting=" + setting);
401         return setting;
402     }
403
404     /**
405      * Returns the user configuration of WFC modem setting
406      */
407     public static void setWfcMode(Context context, int wfcMode) {
408         if (DBG) log("setWfcMode - setting=" + wfcMode);
409         android.provider.Settings.Global.putInt(context.getContentResolver(),
410                 android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
411
412         setWfcModeInternal(context, wfcMode);
413     }
414
415     private static void setWfcModeInternal(Context context, int wfcMode) {
416         final ImsManager imsManager = ImsManager.getInstance(context,
417                 SubscriptionManager.getDefaultVoicePhoneId());
418         if (imsManager != null) {
419             final int value = wfcMode;
420             QueuedWork.singleThreadExecutor().submit(new Runnable() {
421                 public void run() {
422                     try {
423                         imsManager.getConfigInterface().setProvisionedValue(
424                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_MODE,
425                                 value);
426                     } catch (ImsException e) {
427                         // do nothing
428                     }
429                 }
430             });
431         }
432     }
433
434     /**
435      * Returns the user configuration of WFC roaming setting
436      */
437     public static boolean isWfcRoamingEnabledByUser(Context context) {
438         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
439                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
440                 ImsConfig.FeatureValueConstants.OFF);
441         return (enabled == 1) ? true : false;
442     }
443
444     /**
445      * Change persistent WFC roaming enabled setting
446      */
447     public static void setWfcRoamingSetting(Context context, boolean enabled) {
448         android.provider.Settings.Global.putInt(context.getContentResolver(),
449                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
450                 enabled
451                         ? ImsConfig.FeatureValueConstants.ON
452                         : ImsConfig.FeatureValueConstants.OFF);
453
454         setWfcRoamingSettingInternal(context, enabled);
455     }
456
457     private static void setWfcRoamingSettingInternal(Context context, boolean enabled) {
458         final ImsManager imsManager = ImsManager.getInstance(context,
459                 SubscriptionManager.getDefaultVoicePhoneId());
460         if (imsManager != null) {
461             final int value = enabled
462                     ? ImsConfig.FeatureValueConstants.ON
463                     : ImsConfig.FeatureValueConstants.OFF;
464             QueuedWork.singleThreadExecutor().submit(new Runnable() {
465                 public void run() {
466                     try {
467                         imsManager.getConfigInterface().setProvisionedValue(
468                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_ROAMING,
469                                 value);
470                     } catch (ImsException e) {
471                         // do nothing
472                     }
473                 }
474             });
475         }
476     }
477
478     /**
479      * Returns a platform configuration for WFC which may override the user
480      * setting. Note: WFC presumes that VoLTE is enabled (these are
481      * configuration settings which must be done correctly).
482      */
483     public static boolean isWfcEnabledByPlatform(Context context) {
484         if (SystemProperties.getInt(PROPERTY_DBG_WFC_AVAIL_OVERRIDE,
485                 PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT) == 1) {
486             return true;
487         }
488
489         return
490                context.getResources().getBoolean(
491                        com.android.internal.R.bool.config_device_wfc_ims_available) &&
492                getBooleanCarrierConfig(context,
493                        CarrierConfigManager.KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL);
494     }
495
496     /**
497      * Sync carrier config and user settings with ImsConfig.
498      *
499      * @param context for the manager object
500      * @param phoneId phone id
501      * @param force update
502      */
503     public static void updateImsServiceConfig(Context context, int phoneId, boolean force) {
504         final ImsManager imsManager = ImsManager.getInstance(context, phoneId);
505         if (imsManager != null && (!imsManager.mConfigUpdated || force)) {
506             try {
507                 imsManager.updateVolteFeatureValue();
508                 imsManager.updateVideoCallFeatureValue();
509                 imsManager.updateWfcFeatureAndProvisionedValues();
510                 imsManager.mConfigUpdated = true;
511             } catch (ImsException e) {
512                 loge("updateImsServiceConfig: " + e);
513                 imsManager.mConfigUpdated = false;
514             }
515         }
516     }
517
518     private void updateVolteFeatureValue() throws ImsException {
519         boolean available = isVolteEnabledByPlatform(mContext);
520         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext);
521         boolean isNonTty = isNonTtyOrTtyOnVolteEnabled(mContext);
522
523         log("updateVolteFeatureValue: available = " + available
524                 + ", enabled = " + enabled
525                 + ", nonTTY = " + isNonTty);
526
527         getConfigInterface().setFeatureValue(
528                 ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
529                 TelephonyManager.NETWORK_TYPE_LTE,
530                 (available && enabled && isNonTty) ?
531                         ImsConfig.FeatureValueConstants.ON :
532                         ImsConfig.FeatureValueConstants.OFF,
533                 null);
534     }
535
536     private void updateVideoCallFeatureValue() throws ImsException {
537         boolean available = isVtEnabledByPlatform(mContext);
538         SharedPreferences sharedPrefs =
539                 PreferenceManager.getDefaultSharedPreferences(mContext);
540         boolean enabled = isEnhanced4gLteModeSettingEnabledByUser(mContext) &&
541                 sharedPrefs.getBoolean(PREF_ENABLE_VIDEO_CALLING_KEY, true);
542         boolean isNonTty = Settings.Secure.getInt(mContext.getContentResolver(),
543                 Settings.Secure.PREFERRED_TTY_MODE, TelecomManager.TTY_MODE_OFF)
544                 == TelecomManager.TTY_MODE_OFF;
545
546         log("updateVideoCallFeatureValue: available = " + available
547                 + ", enabled = " + enabled
548                 + ", nonTTY = " + isNonTty);
549
550         getConfigInterface().setFeatureValue(
551                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
552                 TelephonyManager.NETWORK_TYPE_LTE,
553                 (available && enabled && isNonTty) ?
554                         ImsConfig.FeatureValueConstants.ON :
555                         ImsConfig.FeatureValueConstants.OFF,
556                 null);
557     }
558
559     private void updateWfcFeatureAndProvisionedValues() throws ImsException {
560         boolean available = isWfcEnabledByPlatform(mContext);
561         boolean enabled = isWfcEnabledByUser(mContext);
562         int mode = getWfcMode(mContext);
563         boolean roaming = isWfcRoamingEnabledByUser(mContext);
564
565         log("updateWfcFeatureAndProvisionedValues: available = " + available
566                 + ", enabled = " + enabled
567                 + ", mode = " + mode
568                 + ", roaming = " + roaming);
569
570         getConfigInterface().setFeatureValue(
571                 ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
572                 TelephonyManager.NETWORK_TYPE_LTE,
573                 (available && enabled) ?
574                         ImsConfig.FeatureValueConstants.ON :
575                         ImsConfig.FeatureValueConstants.OFF,
576                 null);
577
578         if (!available || !enabled) {
579             mode = ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED;
580             roaming = false;
581         }
582         setWfcModeInternal(mContext, mode);
583         setWfcRoamingSettingInternal(mContext, roaming);
584     }
585
586     private ImsManager(Context context, int phoneId) {
587         mContext = context;
588         mPhoneId = phoneId;
589         createImsService(true);
590     }
591
592     /*
593      * Returns a flag indicating whether the IMS service is available.
594      */
595     public boolean isServiceAvailable() {
596         if (mImsService != null) {
597             return true;
598         }
599
600         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
601         if (binder != null) {
602             return true;
603         }
604
605         return false;
606     }
607
608     /**
609      * Opens the IMS service for making calls and/or receiving generic IMS calls.
610      * The caller may make subsquent calls through {@link #makeCall}.
611      * The IMS service will register the device to the operator's network with the credentials
612      * (from ISIM) periodically in order to receive calls from the operator's network.
613      * When the IMS service receives a new call, it will send out an intent with
614      * the provided action string.
615      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
616      *
617      * @param serviceClass a service class specified in {@link ImsServiceClass}
618      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
619      * @param incomingCallPendingIntent When an incoming call is received,
620      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
621      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
622      *        as the result code and the intent to fill in the call ID; It cannot be null
623      * @param listener To listen to IMS registration events; It cannot be null
624      * @return identifier (greater than 0) for the specified service
625      * @throws NullPointerException if {@code incomingCallPendingIntent}
626      *      or {@code listener} is null
627      * @throws ImsException if calling the IMS service results in an error
628      * @see #getCallId
629      * @see #getServiceId
630      */
631     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
632             ImsConnectionStateListener listener) throws ImsException {
633         checkAndThrowExceptionIfServiceUnavailable();
634
635         if (incomingCallPendingIntent == null) {
636             throw new NullPointerException("incomingCallPendingIntent can't be null");
637         }
638
639         if (listener == null) {
640             throw new NullPointerException("listener can't be null");
641         }
642
643         int result = 0;
644
645         try {
646             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
647                     createRegistrationListenerProxy(serviceClass, listener));
648         } catch (RemoteException e) {
649             throw new ImsException("open()", e,
650                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
651         }
652
653         if (result <= 0) {
654             // If the return value is a minus value,
655             // it means that an error occurred in the service.
656             // So, it needs to convert to the reason code specified in ImsReasonInfo.
657             throw new ImsException("open()", (result * (-1)));
658         }
659
660         return result;
661     }
662
663     /**
664      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
665      * All the resources that were allocated to the service are also released.
666      *
667      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
668      * @throws ImsException if calling the IMS service results in an error
669      */
670     public void close(int serviceId) throws ImsException {
671         checkAndThrowExceptionIfServiceUnavailable();
672
673         try {
674             mImsService.close(serviceId);
675         } catch (RemoteException e) {
676             throw new ImsException("close()", e,
677                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
678         } finally {
679             mUt = null;
680             mConfig = null;
681             mEcbm = null;
682         }
683     }
684
685     /**
686      * Gets the configuration interface to provision / withdraw the supplementary service settings.
687      *
688      * @param serviceId a service id which is obtained from {@link ImsManager#open}
689      * @return the Ut interface instance
690      * @throws ImsException if getting the Ut interface results in an error
691      */
692     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
693             throws ImsException {
694         // FIXME: manage the multiple Ut interfaces based on the service id
695         if (mUt == null) {
696             checkAndThrowExceptionIfServiceUnavailable();
697
698             try {
699                 IImsUt iUt = mImsService.getUtInterface(serviceId);
700
701                 if (iUt == null) {
702                     throw new ImsException("getSupplementaryServiceConfiguration()",
703                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
704                 }
705
706                 mUt = new ImsUt(iUt);
707             } catch (RemoteException e) {
708                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
709                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
710             }
711         }
712
713         return mUt;
714     }
715
716     /**
717      * Checks if the IMS service has successfully registered to the IMS network
718      * with the specified service & call type.
719      *
720      * @param serviceId a service id which is obtained from {@link ImsManager#open}
721      * @param serviceType a service type that is specified in {@link ImsCallProfile}
722      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
723      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
724      * @param callType a call type that is specified in {@link ImsCallProfile}
725      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
726      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
727      *        {@link ImsCallProfile#CALL_TYPE_VT}
728      *        {@link ImsCallProfile#CALL_TYPE_VS}
729      * @return true if the specified service id is connected to the IMS network;
730      *        false otherwise
731      * @throws ImsException if calling the IMS service results in an error
732      */
733     public boolean isConnected(int serviceId, int serviceType, int callType)
734             throws ImsException {
735         checkAndThrowExceptionIfServiceUnavailable();
736
737         try {
738             return mImsService.isConnected(serviceId, serviceType, callType);
739         } catch (RemoteException e) {
740             throw new ImsException("isServiceConnected()", e,
741                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
742         }
743     }
744
745     /**
746      * Checks if the specified IMS service is opend.
747      *
748      * @param serviceId a service id which is obtained from {@link ImsManager#open}
749      * @return true if the specified service id is opened; false otherwise
750      * @throws ImsException if calling the IMS service results in an error
751      */
752     public boolean isOpened(int serviceId) throws ImsException {
753         checkAndThrowExceptionIfServiceUnavailable();
754
755         try {
756             return mImsService.isOpened(serviceId);
757         } catch (RemoteException e) {
758             throw new ImsException("isOpened()", e,
759                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
760         }
761     }
762
763     /**
764      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
765      *
766      * @param serviceId a service id which is obtained from {@link ImsManager#open}
767      * @param serviceType a service type that is specified in {@link ImsCallProfile}
768      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
769      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
770      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
771      * @param callType a call type that is specified in {@link ImsCallProfile}
772      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
773      *        {@link ImsCallProfile#CALL_TYPE_VT}
774      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
775      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
776      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
777      *        {@link ImsCallProfile#CALL_TYPE_VS}
778      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
779      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
780      * @return a {@link ImsCallProfile} object
781      * @throws ImsException if calling the IMS service results in an error
782      */
783     public ImsCallProfile createCallProfile(int serviceId,
784             int serviceType, int callType) throws ImsException {
785         checkAndThrowExceptionIfServiceUnavailable();
786
787         try {
788             return mImsService.createCallProfile(serviceId, serviceType, callType);
789         } catch (RemoteException e) {
790             throw new ImsException("createCallProfile()", e,
791                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
792         }
793     }
794
795     /**
796      * Creates a {@link ImsCall} to make a call.
797      *
798      * @param serviceId a service id which is obtained from {@link ImsManager#open}
799      * @param profile a call profile to make the call
800      *      (it contains service type, call type, media information, etc.)
801      * @param participants participants to invite the conference call
802      * @param listener listen to the call events from {@link ImsCall}
803      * @return a {@link ImsCall} object
804      * @throws ImsException if calling the IMS service results in an error
805      */
806     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
807             ImsCall.Listener listener) throws ImsException {
808         if (DBG) {
809             log("makeCall :: serviceId=" + serviceId
810                     + ", profile=" + profile + ", callees=" + callees);
811         }
812
813         checkAndThrowExceptionIfServiceUnavailable();
814
815         ImsCall call = new ImsCall(mContext, profile);
816
817         call.setListener(listener);
818         ImsCallSession session = createCallSession(serviceId, profile);
819
820         if ((callees != null) && (callees.length == 1)) {
821             call.start(session, callees[0]);
822         } else {
823             call.start(session, callees);
824         }
825
826         return call;
827     }
828
829     /**
830      * Creates a {@link ImsCall} to take an incoming call.
831      *
832      * @param serviceId a service id which is obtained from {@link ImsManager#open}
833      * @param incomingCallIntent the incoming call broadcast intent
834      * @param listener to listen to the call events from {@link ImsCall}
835      * @return a {@link ImsCall} object
836      * @throws ImsException if calling the IMS service results in an error
837      */
838     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
839             ImsCall.Listener listener) throws ImsException {
840         if (DBG) {
841             log("takeCall :: serviceId=" + serviceId
842                     + ", incomingCall=" + incomingCallIntent);
843         }
844
845         checkAndThrowExceptionIfServiceUnavailable();
846
847         if (incomingCallIntent == null) {
848             throw new ImsException("Can't retrieve session with null intent",
849                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
850         }
851
852         int incomingServiceId = getServiceId(incomingCallIntent);
853
854         if (serviceId != incomingServiceId) {
855             throw new ImsException("Service id is mismatched in the incoming call intent",
856                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
857         }
858
859         String callId = getCallId(incomingCallIntent);
860
861         if (callId == null) {
862             throw new ImsException("Call ID missing in the incoming call intent",
863                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
864         }
865
866         try {
867             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
868
869             if (session == null) {
870                 throw new ImsException("No pending session for the call",
871                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
872             }
873
874             ImsCall call = new ImsCall(mContext, session.getCallProfile());
875
876             call.attachSession(new ImsCallSession(session));
877             call.setListener(listener);
878
879             return call;
880         } catch (Throwable t) {
881             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
882         }
883     }
884
885     /**
886      * Gets the config interface to get/set service/capability parameters.
887      *
888      * @return the ImsConfig instance.
889      * @throws ImsException if getting the setting interface results in an error.
890      */
891     public ImsConfig getConfigInterface() throws ImsException {
892
893         if (mConfig == null) {
894             checkAndThrowExceptionIfServiceUnavailable();
895
896             try {
897                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
898                 if (config == null) {
899                     throw new ImsException("getConfigInterface()",
900                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
901                 }
902                 mConfig = new ImsConfig(config, mContext);
903             } catch (RemoteException e) {
904                 throw new ImsException("getConfigInterface()", e,
905                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
906             }
907         }
908         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
909         return mConfig;
910     }
911
912     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
913             throws ImsException {
914
915         checkAndThrowExceptionIfServiceUnavailable();
916
917         try {
918             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
919         } catch (RemoteException e) {
920             throw new ImsException("setTTYMode()", e,
921                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
922         }
923
924         if (!getBooleanCarrierConfig(context,
925                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
926             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
927                     isEnhanced4gLteModeSettingEnabledByUser(context));
928         }
929     }
930
931     /**
932      * Get the boolean config from carrier config manager.
933      *
934      * @param context the context to get carrier service
935      * @param key config key defined in CarrierConfigManager
936      * @return boolean value of corresponding key.
937      */
938     private static boolean getBooleanCarrierConfig(Context context, String key) {
939         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
940                 Context.CARRIER_CONFIG_SERVICE);
941         PersistableBundle b = null;
942         if (configManager != null) {
943             b = configManager.getConfig();
944         }
945         if (b != null) {
946             return b.getBoolean(key);
947         } else {
948             // Return static default defined in CarrierConfigManager.
949             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
950         }
951     }
952
953     /**
954      * Gets the call ID from the specified incoming call broadcast intent.
955      *
956      * @param incomingCallIntent the incoming call broadcast intent
957      * @return the call ID or null if the intent does not contain it
958      */
959     private static String getCallId(Intent incomingCallIntent) {
960         if (incomingCallIntent == null) {
961             return null;
962         }
963
964         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
965     }
966
967     /**
968      * Gets the service type from the specified incoming call broadcast intent.
969      *
970      * @param incomingCallIntent the incoming call broadcast intent
971      * @return the service identifier or -1 if the intent does not contain it
972      */
973     private static int getServiceId(Intent incomingCallIntent) {
974         if (incomingCallIntent == null) {
975             return (-1);
976         }
977
978         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
979     }
980
981     /**
982      * Binds the IMS service only if the service is not created.
983      */
984     private void checkAndThrowExceptionIfServiceUnavailable()
985             throws ImsException {
986         if (mImsService == null) {
987             createImsService(true);
988
989             if (mImsService == null) {
990                 throw new ImsException("Service is unavailable",
991                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
992             }
993         }
994     }
995
996     private static String getImsServiceName(int phoneId) {
997         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
998         return IMS_SERVICE;
999     }
1000
1001     /**
1002      * Binds the IMS service to make/receive the call.
1003      */
1004     private void createImsService(boolean checkService) {
1005         if (checkService) {
1006             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
1007
1008             if (binder == null) {
1009                 return;
1010             }
1011         }
1012
1013         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
1014
1015         if (b != null) {
1016             try {
1017                 b.linkToDeath(mDeathRecipient, 0);
1018             } catch (RemoteException e) {
1019             }
1020         }
1021
1022         mImsService = IImsService.Stub.asInterface(b);
1023     }
1024
1025     /**
1026      * Creates a {@link ImsCallSession} with the specified call profile.
1027      * Use other methods, if applicable, instead of interacting with
1028      * {@link ImsCallSession} directly.
1029      *
1030      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1031      * @param profile a call profile to make the call
1032      */
1033     private ImsCallSession createCallSession(int serviceId,
1034             ImsCallProfile profile) throws ImsException {
1035         try {
1036             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
1037         } catch (RemoteException e) {
1038             return null;
1039         }
1040     }
1041
1042     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
1043             ImsConnectionStateListener listener) {
1044         ImsRegistrationListenerProxy proxy =
1045                 new ImsRegistrationListenerProxy(serviceClass, listener);
1046         return proxy;
1047     }
1048
1049     private static void log(String s) {
1050         Rlog.d(TAG, s);
1051     }
1052
1053     private static void loge(String s) {
1054         Rlog.e(TAG, s);
1055     }
1056
1057     private static void loge(String s, Throwable t) {
1058         Rlog.e(TAG, s, t);
1059     }
1060
1061     /**
1062      * Used for turning on IMS.if its off already
1063      */
1064     private void turnOnIms() throws ImsException {
1065         checkAndThrowExceptionIfServiceUnavailable();
1066
1067         try {
1068             mImsService.turnOnIms(mPhoneId);
1069         } catch (RemoteException e) {
1070             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1071         }
1072     }
1073
1074     private boolean isImsTurnOffAllowed() {
1075         return getBooleanCarrierConfig(mContext,
1076                 CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
1077                 && (!isWfcEnabledByPlatform(mContext)
1078                 || !isWfcEnabledByUser(mContext));
1079     }
1080
1081     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
1082         checkAndThrowExceptionIfServiceUnavailable();
1083
1084         try {
1085             ImsConfig config = getConfigInterface();
1086             if (config != null && (turnOn || !isImsTurnOffAllowed())) {
1087                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
1088                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
1089                 if (isVtEnabledByPlatform(mContext)) {
1090                     // TODO: once VT is available on platform:
1091                     // - replace the '1' with the current user configuration of VT.
1092                     // - separate exception checks for setFeatureValue() failures for VoLTE and VT.
1093                     //   I.e. if VoLTE fails still try to configure VT.
1094                     config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
1095                             TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
1096                 }
1097             }
1098         } catch (ImsException e) {
1099             log("setAdvanced4GMode() : " + e);
1100         }
1101         if (turnOn) {
1102             turnOnIms();
1103         } else if (isImsTurnOffAllowed()) {
1104             log("setAdvanced4GMode() : imsServiceAllowTurnOff -> turnOffIms");
1105             turnOffIms();
1106         }
1107     }
1108
1109     /**
1110      * Used for turning off IMS completely in order to make the device CSFB'ed.
1111      * Once turned off, all calls will be over CS.
1112      */
1113     private void turnOffIms() throws ImsException {
1114         checkAndThrowExceptionIfServiceUnavailable();
1115
1116         try {
1117             mImsService.turnOffIms(mPhoneId);
1118         } catch (RemoteException e) {
1119             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1120         }
1121     }
1122
1123     /**
1124      * Death recipient class for monitoring IMS service.
1125      */
1126     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
1127         @Override
1128         public void binderDied() {
1129             mImsService = null;
1130             mUt = null;
1131             mConfig = null;
1132             mEcbm = null;
1133
1134             if (mContext != null) {
1135                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
1136                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
1137                 mContext.sendBroadcast(new Intent(intent));
1138             }
1139         }
1140     }
1141
1142     /**
1143      * Adapter class for {@link IImsRegistrationListener}.
1144      */
1145     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
1146         private int mServiceClass;
1147         private ImsConnectionStateListener mListener;
1148
1149         public ImsRegistrationListenerProxy(int serviceClass,
1150                 ImsConnectionStateListener listener) {
1151             mServiceClass = serviceClass;
1152             mListener = listener;
1153         }
1154
1155         public boolean isSameProxy(int serviceClass) {
1156             return (mServiceClass == serviceClass);
1157         }
1158
1159         @Override
1160         public void registrationConnected(int imsRadioTech) {
1161             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1162             //       values in ServiceState.java.
1163             if (DBG) {
1164                 log("registrationConnected :: imsRadioTech=" + imsRadioTech);
1165             }
1166
1167             if (mListener != null) {
1168                 mListener.onImsConnected();
1169             }
1170         }
1171
1172         @Override
1173         public void registrationProgressing(int imsRadioTech) {
1174             // Note: imsRadioTech value maps to RIL_RADIO_TECHNOLOGY
1175             //       values in ServiceState.java.
1176             if (DBG) {
1177                 log("registrationProgressing :: imsRadioTech=" + imsRadioTech);
1178             }
1179
1180             if (mListener != null) {
1181                 mListener.onImsProgressing();
1182             }
1183         }
1184
1185         @Override
1186         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1187             if (DBG) {
1188                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1189             }
1190
1191             if (mListener != null) {
1192                 mListener.onImsDisconnected(imsReasonInfo);
1193             }
1194         }
1195
1196         @Override
1197         public void registrationResumed() {
1198             if (DBG) {
1199                 log("registrationResumed ::");
1200             }
1201
1202             if (mListener != null) {
1203                 mListener.onImsResumed();
1204             }
1205         }
1206
1207         @Override
1208         public void registrationSuspended() {
1209             if (DBG) {
1210                 log("registrationSuspended ::");
1211             }
1212
1213             if (mListener != null) {
1214                 mListener.onImsSuspended();
1215             }
1216         }
1217
1218         @Override
1219         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1220             log("registrationServiceCapabilityChanged :: serviceClass=" +
1221                     serviceClass + ", event=" + event);
1222
1223             if (mListener != null) {
1224                 mListener.onImsConnected();
1225             }
1226         }
1227
1228         @Override
1229         public void registrationFeatureCapabilityChanged(int serviceClass,
1230                 int[] enabledFeatures, int[] disabledFeatures) {
1231             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1232                     serviceClass);
1233             if (mListener != null) {
1234                 mListener.onFeatureCapabilityChanged(serviceClass,
1235                         enabledFeatures, disabledFeatures);
1236             }
1237         }
1238
1239         @Override
1240         public void voiceMessageCountUpdate(int count) {
1241             log("voiceMessageCountUpdate :: count=" + count);
1242
1243             if (mListener != null) {
1244                 mListener.onVoiceMessageCountChanged(count);
1245             }
1246         }
1247
1248     }
1249     /**
1250      * Gets the ECBM interface to request ECBM exit.
1251      *
1252      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1253      * @return the ECBM interface instance
1254      * @throws ImsException if getting the ECBM interface results in an error
1255      */
1256     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1257         if (mEcbm == null) {
1258             checkAndThrowExceptionIfServiceUnavailable();
1259
1260             try {
1261                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1262
1263                 if (iEcbm == null) {
1264                     throw new ImsException("getEcbmInterface()",
1265                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1266                 }
1267                 mEcbm = new ImsEcbm(iEcbm);
1268             } catch (RemoteException e) {
1269                 throw new ImsException("getEcbmInterface()", e,
1270                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1271             }
1272         }
1273         return mEcbm;
1274     }
1275 }