WFC configuration: add API to get and set user settings.
[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      * Opens the IMS service for making calls and/or receiving generic IMS calls.
415      * The caller may make subsquent calls through {@link #makeCall}.
416      * The IMS service will register the device to the operator's network with the credentials
417      * (from ISIM) periodically in order to receive calls from the operator's network.
418      * When the IMS service receives a new call, it will send out an intent with
419      * the provided action string.
420      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
421      *
422      * @param serviceClass a service class specified in {@link ImsServiceClass}
423      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
424      * @param incomingCallPendingIntent When an incoming call is received,
425      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
426      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
427      *        as the result code and the intent to fill in the call ID; It cannot be null
428      * @param listener To listen to IMS registration events; It cannot be null
429      * @return identifier (greater than 0) for the specified service
430      * @throws NullPointerException if {@code incomingCallPendingIntent}
431      *      or {@code listener} is null
432      * @throws ImsException if calling the IMS service results in an error
433      * @see #getCallId
434      * @see #getServiceId
435      */
436     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
437             ImsConnectionStateListener listener) throws ImsException {
438         checkAndThrowExceptionIfServiceUnavailable();
439
440         if (incomingCallPendingIntent == null) {
441             throw new NullPointerException("incomingCallPendingIntent can't be null");
442         }
443
444         if (listener == null) {
445             throw new NullPointerException("listener can't be null");
446         }
447
448         int result = 0;
449
450         try {
451             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
452                     createRegistrationListenerProxy(serviceClass, listener));
453         } catch (RemoteException e) {
454             throw new ImsException("open()", e,
455                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
456         }
457
458         if (result <= 0) {
459             // If the return value is a minus value,
460             // it means that an error occurred in the service.
461             // So, it needs to convert to the reason code specified in ImsReasonInfo.
462             throw new ImsException("open()", (result * (-1)));
463         }
464
465         return result;
466     }
467
468     /**
469      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
470      * All the resources that were allocated to the service are also released.
471      *
472      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
473      * @throws ImsException if calling the IMS service results in an error
474      */
475     public void close(int serviceId) throws ImsException {
476         checkAndThrowExceptionIfServiceUnavailable();
477
478         try {
479             mImsService.close(serviceId);
480         } catch (RemoteException e) {
481             throw new ImsException("close()", e,
482                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
483         } finally {
484             mUt = null;
485             mConfig = null;
486             mEcbm = null;
487         }
488     }
489
490     /**
491      * Gets the configuration interface to provision / withdraw the supplementary service settings.
492      *
493      * @param serviceId a service id which is obtained from {@link ImsManager#open}
494      * @return the Ut interface instance
495      * @throws ImsException if getting the Ut interface results in an error
496      */
497     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
498             throws ImsException {
499         // FIXME: manage the multiple Ut interfaces based on the service id
500         if (mUt == null) {
501             checkAndThrowExceptionIfServiceUnavailable();
502
503             try {
504                 IImsUt iUt = mImsService.getUtInterface(serviceId);
505
506                 if (iUt == null) {
507                     throw new ImsException("getSupplementaryServiceConfiguration()",
508                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
509                 }
510
511                 mUt = new ImsUt(iUt);
512             } catch (RemoteException e) {
513                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
514                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
515             }
516         }
517
518         return mUt;
519     }
520
521     /**
522      * Checks if the IMS service has successfully registered to the IMS network
523      * with the specified service & call type.
524      *
525      * @param serviceId a service id which is obtained from {@link ImsManager#open}
526      * @param serviceType a service type that is specified in {@link ImsCallProfile}
527      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
528      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
529      * @param callType a call type that is specified in {@link ImsCallProfile}
530      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
531      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
532      *        {@link ImsCallProfile#CALL_TYPE_VT}
533      *        {@link ImsCallProfile#CALL_TYPE_VS}
534      * @return true if the specified service id is connected to the IMS network;
535      *        false otherwise
536      * @throws ImsException if calling the IMS service results in an error
537      */
538     public boolean isConnected(int serviceId, int serviceType, int callType)
539             throws ImsException {
540         checkAndThrowExceptionIfServiceUnavailable();
541
542         try {
543             return mImsService.isConnected(serviceId, serviceType, callType);
544         } catch (RemoteException e) {
545             throw new ImsException("isServiceConnected()", e,
546                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
547         }
548     }
549
550     /**
551      * Checks if the specified IMS service is opend.
552      *
553      * @param serviceId a service id which is obtained from {@link ImsManager#open}
554      * @return true if the specified service id is opened; false otherwise
555      * @throws ImsException if calling the IMS service results in an error
556      */
557     public boolean isOpened(int serviceId) throws ImsException {
558         checkAndThrowExceptionIfServiceUnavailable();
559
560         try {
561             return mImsService.isOpened(serviceId);
562         } catch (RemoteException e) {
563             throw new ImsException("isOpened()", e,
564                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
565         }
566     }
567
568     /**
569      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
570      *
571      * @param serviceId a service id which is obtained from {@link ImsManager#open}
572      * @param serviceType a service type that is specified in {@link ImsCallProfile}
573      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
574      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
575      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
576      * @param callType a call type that is specified in {@link ImsCallProfile}
577      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
578      *        {@link ImsCallProfile#CALL_TYPE_VT}
579      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
580      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
581      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
582      *        {@link ImsCallProfile#CALL_TYPE_VS}
583      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
584      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
585      * @return a {@link ImsCallProfile} object
586      * @throws ImsException if calling the IMS service results in an error
587      */
588     public ImsCallProfile createCallProfile(int serviceId,
589             int serviceType, int callType) throws ImsException {
590         checkAndThrowExceptionIfServiceUnavailable();
591
592         try {
593             return mImsService.createCallProfile(serviceId, serviceType, callType);
594         } catch (RemoteException e) {
595             throw new ImsException("createCallProfile()", e,
596                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
597         }
598     }
599
600     /**
601      * Creates a {@link ImsCall} to make a call.
602      *
603      * @param serviceId a service id which is obtained from {@link ImsManager#open}
604      * @param profile a call profile to make the call
605      *      (it contains service type, call type, media information, etc.)
606      * @param participants participants to invite the conference call
607      * @param listener listen to the call events from {@link ImsCall}
608      * @return a {@link ImsCall} object
609      * @throws ImsException if calling the IMS service results in an error
610      */
611     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
612             ImsCall.Listener listener) throws ImsException {
613         if (DBG) {
614             log("makeCall :: serviceId=" + serviceId
615                     + ", profile=" + profile + ", callees=" + callees);
616         }
617
618         checkAndThrowExceptionIfServiceUnavailable();
619
620         ImsCall call = new ImsCall(mContext, profile);
621
622         call.setListener(listener);
623         ImsCallSession session = createCallSession(serviceId, profile);
624
625         if ((callees != null) && (callees.length == 1)) {
626             call.start(session, callees[0]);
627         } else {
628             call.start(session, callees);
629         }
630
631         return call;
632     }
633
634     /**
635      * Creates a {@link ImsCall} to take an incoming call.
636      *
637      * @param serviceId a service id which is obtained from {@link ImsManager#open}
638      * @param incomingCallIntent the incoming call broadcast intent
639      * @param listener to listen to the call events from {@link ImsCall}
640      * @return a {@link ImsCall} object
641      * @throws ImsException if calling the IMS service results in an error
642      */
643     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
644             ImsCall.Listener listener) throws ImsException {
645         if (DBG) {
646             log("takeCall :: serviceId=" + serviceId
647                     + ", incomingCall=" + incomingCallIntent);
648         }
649
650         checkAndThrowExceptionIfServiceUnavailable();
651
652         if (incomingCallIntent == null) {
653             throw new ImsException("Can't retrieve session with null intent",
654                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
655         }
656
657         int incomingServiceId = getServiceId(incomingCallIntent);
658
659         if (serviceId != incomingServiceId) {
660             throw new ImsException("Service id is mismatched in the incoming call intent",
661                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
662         }
663
664         String callId = getCallId(incomingCallIntent);
665
666         if (callId == null) {
667             throw new ImsException("Call ID missing in the incoming call intent",
668                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
669         }
670
671         try {
672             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
673
674             if (session == null) {
675                 throw new ImsException("No pending session for the call",
676                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
677             }
678
679             ImsCall call = new ImsCall(mContext, session.getCallProfile());
680
681             call.attachSession(new ImsCallSession(session));
682             call.setListener(listener);
683
684             return call;
685         } catch (Throwable t) {
686             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
687         }
688     }
689
690     /**
691      * Gets the config interface to get/set service/capability parameters.
692      *
693      * @return the ImsConfig instance.
694      * @throws ImsException if getting the setting interface results in an error.
695      */
696     public ImsConfig getConfigInterface() throws ImsException {
697
698         if (mConfig == null) {
699             checkAndThrowExceptionIfServiceUnavailable();
700
701             try {
702                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
703                 if (config == null) {
704                     throw new ImsException("getConfigInterface()",
705                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
706                 }
707                 mConfig = new ImsConfig(config, mContext);
708             } catch (RemoteException e) {
709                 throw new ImsException("getConfigInterface()", e,
710                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
711             }
712         }
713         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
714         return mConfig;
715     }
716
717     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
718             throws ImsException {
719
720         checkAndThrowExceptionIfServiceUnavailable();
721
722         try {
723             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
724         } catch (RemoteException e) {
725             throw new ImsException("setTTYMode()", e,
726                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
727         }
728
729         if (!context.getResources().getBoolean(
730                 com.android.internal.R.bool.config_carrier_volte_tty_supported)) {
731             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
732                     isEnhanced4gLteModeSettingEnabledByUser(context));
733         }
734     }
735
736     /**
737      * Gets the call ID from the specified incoming call broadcast intent.
738      *
739      * @param incomingCallIntent the incoming call broadcast intent
740      * @return the call ID or null if the intent does not contain it
741      */
742     private static String getCallId(Intent incomingCallIntent) {
743         if (incomingCallIntent == null) {
744             return null;
745         }
746
747         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
748     }
749
750     /**
751      * Gets the service type from the specified incoming call broadcast intent.
752      *
753      * @param incomingCallIntent the incoming call broadcast intent
754      * @return the service identifier or -1 if the intent does not contain it
755      */
756     private static int getServiceId(Intent incomingCallIntent) {
757         if (incomingCallIntent == null) {
758             return (-1);
759         }
760
761         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
762     }
763
764     /**
765      * Binds the IMS service only if the service is not created.
766      */
767     private void checkAndThrowExceptionIfServiceUnavailable()
768             throws ImsException {
769         if (mImsService == null) {
770             createImsService(true);
771
772             if (mImsService == null) {
773                 throw new ImsException("Service is unavailable",
774                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
775             }
776         }
777     }
778
779     private static String getImsServiceName(int phoneId) {
780         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
781         return IMS_SERVICE;
782     }
783
784     /**
785      * Binds the IMS service to make/receive the call.
786      */
787     private void createImsService(boolean checkService) {
788         if (checkService) {
789             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
790
791             if (binder == null) {
792                 return;
793             }
794         }
795
796         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
797
798         if (b != null) {
799             try {
800                 b.linkToDeath(mDeathRecipient, 0);
801             } catch (RemoteException e) {
802             }
803         }
804
805         mImsService = IImsService.Stub.asInterface(b);
806     }
807
808     /**
809      * Creates a {@link ImsCallSession} with the specified call profile.
810      * Use other methods, if applicable, instead of interacting with
811      * {@link ImsCallSession} directly.
812      *
813      * @param serviceId a service id which is obtained from {@link ImsManager#open}
814      * @param profile a call profile to make the call
815      */
816     private ImsCallSession createCallSession(int serviceId,
817             ImsCallProfile profile) throws ImsException {
818         try {
819             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
820         } catch (RemoteException e) {
821             return null;
822         }
823     }
824
825     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
826             ImsConnectionStateListener listener) {
827         ImsRegistrationListenerProxy proxy =
828                 new ImsRegistrationListenerProxy(serviceClass, listener);
829         return proxy;
830     }
831
832     private static void log(String s) {
833         Rlog.d(TAG, s);
834     }
835
836     private static void loge(String s) {
837         Rlog.e(TAG, s);
838     }
839
840     private static void loge(String s, Throwable t) {
841         Rlog.e(TAG, s, t);
842     }
843
844     /**
845      * Used for turning on IMS.if its off already
846      */
847     private void turnOnIms() throws ImsException {
848         checkAndThrowExceptionIfServiceUnavailable();
849
850         try {
851             mImsService.turnOnIms(mPhoneId);
852         } catch (RemoteException e) {
853             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
854         }
855     }
856
857     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
858         checkAndThrowExceptionIfServiceUnavailable();
859
860         ImsConfig config = getConfigInterface();
861         if (config != null) {
862             config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
863                     TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
864             if (isVtEnabledByPlatform(mContext)) {
865                 // TODO: once VT is available on platform replace the '1' with the current
866                 // user configuration of VT.
867                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
868                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
869             }
870         }
871
872         if (turnOn) {
873             turnOnIms();
874         } else if (mContext.getResources().getBoolean(
875                 com.android.internal.R.bool.imsServiceAllowTurnOff)) {
876             log("setAdvanced4GMode() : imsServiceAllowTurnOff -> turnOffIms");
877             turnOffIms();
878         }
879     }
880
881     /**
882      * Used for turning off IMS completely in order to make the device CSFB'ed.
883      * Once turned off, all calls will be over CS.
884      */
885     private void turnOffIms() throws ImsException {
886         checkAndThrowExceptionIfServiceUnavailable();
887
888         try {
889             mImsService.turnOffIms(mPhoneId);
890         } catch (RemoteException e) {
891             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
892         }
893     }
894
895     /**
896      * Death recipient class for monitoring IMS service.
897      */
898     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
899         @Override
900         public void binderDied() {
901             mImsService = null;
902             mUt = null;
903             mConfig = null;
904             mEcbm = null;
905
906             if (mContext != null) {
907                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
908                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
909                 mContext.sendBroadcast(new Intent(intent));
910             }
911         }
912     }
913
914     /**
915      * Adapter class for {@link IImsRegistrationListener}.
916      */
917     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
918         private int mServiceClass;
919         private ImsConnectionStateListener mListener;
920
921         public ImsRegistrationListenerProxy(int serviceClass,
922                 ImsConnectionStateListener listener) {
923             mServiceClass = serviceClass;
924             mListener = listener;
925         }
926
927         public boolean isSameProxy(int serviceClass) {
928             return (mServiceClass == serviceClass);
929         }
930
931         @Override
932         public void registrationConnected() {
933             if (DBG) {
934                 log("registrationConnected ::");
935             }
936
937             if (mListener != null) {
938                 mListener.onImsConnected();
939             }
940         }
941
942         @Override
943         public void registrationDisconnected() {
944             if (DBG) {
945                 log("registrationDisconnected ::");
946             }
947
948             if (mListener != null) {
949                 mListener.onImsDisconnected();
950             }
951         }
952
953         @Override
954         public void registrationResumed() {
955             if (DBG) {
956                 log("registrationResumed ::");
957             }
958
959             if (mListener != null) {
960                 mListener.onImsResumed();
961             }
962         }
963
964         @Override
965         public void registrationSuspended() {
966             if (DBG) {
967                 log("registrationSuspended ::");
968             }
969
970             if (mListener != null) {
971                 mListener.onImsSuspended();
972             }
973         }
974
975         @Override
976         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
977             log("registrationServiceCapabilityChanged :: serviceClass=" +
978                     serviceClass + ", event=" + event);
979
980             if (mListener != null) {
981                 mListener.onImsConnected();
982             }
983         }
984
985         @Override
986         public void registrationFeatureCapabilityChanged(int serviceClass,
987                 int[] enabledFeatures, int[] disabledFeatures) {
988             log("registrationFeatureCapabilityChanged :: serviceClass=" +
989                     serviceClass);
990             if (mListener != null) {
991                 mListener.onFeatureCapabilityChanged(serviceClass,
992                         enabledFeatures, disabledFeatures);
993             }
994         }
995
996     }
997     /**
998      * Gets the ECBM interface to request ECBM exit.
999      *
1000      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1001      * @return the ECBM interface instance
1002      * @throws ImsException if getting the ECBM interface results in an error
1003      */
1004     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1005         if (mEcbm == null) {
1006             checkAndThrowExceptionIfServiceUnavailable();
1007
1008             try {
1009                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1010
1011                 if (iEcbm == null) {
1012                     throw new ImsException("getEcbmInterface()",
1013                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1014                 }
1015                 mEcbm = new ImsEcbm(iEcbm);
1016             } catch (RemoteException e) {
1017                 throw new ImsException("getEcbmInterface()", e,
1018                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1019             }
1020         }
1021         return mEcbm;
1022     }
1023 }