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