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