am 3a99f787: Prevent WFC Settings changes from impacting VoLTE 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.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 WFC setting
300      */
301     public static boolean isWfcEnabledByUser(Context context) {
302         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
303                 android.provider.Settings.Global.WFC_IMS_ENABLED,
304                 ImsConfig.FeatureValueConstants.OFF);
305         return (enabled == 1) ? true : false;
306     }
307
308     /**
309      * Change persistent WFC enabled setting
310      */
311     public static void setWfcSetting(Context context, boolean enabled) {
312         int value = enabled ? 1 : 0;
313         android.provider.Settings.Global.putInt(context.getContentResolver(),
314                 android.provider.Settings.Global.WFC_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_VOICE_OVER_WIFI,
322                         TelephonyManager.NETWORK_TYPE_IWLAN,
323                         enabled ? ImsConfig.FeatureValueConstants.ON
324                                 : ImsConfig.FeatureValueConstants.OFF, null);
325
326                 if (enabled) {
327                     imsManager.turnOnIms();
328                 } else if (getBooleanCarrierConfig(context,
329                         CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
330                         && (!isVolteEnabledByPlatform(context)
331                         || !isEnhanced4gLteModeSettingEnabledByUser(context))) {
332                     log("setWfcSetting() : imsServiceAllowTurnOff -> turnOffIms");
333                     imsManager.turnOffIms();
334                 }
335
336                 // Force IMS to register over LTE when turning off WFC
337                 setWfcModeInternal(context, enabled
338                         ? getWfcMode(context)
339                         : ImsConfig.WfcModeFeatureValueConstants.CELLULAR_PREFERRED);
340             } catch (ImsException e) {
341                 loge("setWfcSetting(): " + e);
342             }
343         }
344     }
345
346     /**
347      * Returns the user configuration of WFC modem setting
348      */
349     public static int getWfcMode(Context context) {
350         int setting = android.provider.Settings.Global.getInt(context.getContentResolver(),
351                 android.provider.Settings.Global.WFC_IMS_MODE,
352                 ImsConfig.WfcModeFeatureValueConstants.WIFI_PREFERRED);
353         if (DBG) log("getWfcMode - setting=" + setting);
354         return setting;
355     }
356
357     /**
358      * Returns the user configuration of WFC modem setting
359      */
360     public static void setWfcMode(Context context, int wfcMode) {
361         if (DBG) log("setWfcMode - setting=" + wfcMode);
362         android.provider.Settings.Global.putInt(context.getContentResolver(),
363                 android.provider.Settings.Global.WFC_IMS_MODE, wfcMode);
364
365         setWfcModeInternal(context, wfcMode);
366     }
367
368     private static void setWfcModeInternal(Context context, int wfcMode) {
369         final ImsManager imsManager = ImsManager.getInstance(context,
370                 SubscriptionManager.getDefaultVoicePhoneId());
371         if (imsManager != null) {
372             final int value = wfcMode;
373             QueuedWork.singleThreadExecutor().submit(new Runnable() {
374                 public void run() {
375                     try {
376                         imsManager.getConfigInterface().setProvisionedValue(
377                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_MODE,
378                                 value);
379                     } catch (ImsException e) {
380                         // do nothing
381                     }
382                 }
383             });
384         }
385     }
386
387     /**
388      * Returns the user configuration of WFC roaming setting
389      */
390     public static boolean isWfcRoamingEnabledByUser(Context context) {
391         int enabled = android.provider.Settings.Global.getInt(context.getContentResolver(),
392                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED,
393                 ImsConfig.FeatureValueConstants.OFF);
394         return (enabled == 1) ? true : false;
395     }
396
397     /**
398      * Change persistent WFC roaming enabled setting
399      */
400     public static void setWfcRoamingSetting(Context context, boolean enabled) {
401         final int value = enabled
402                 ? ImsConfig.FeatureValueConstants.ON
403                 : ImsConfig.FeatureValueConstants.OFF;
404         android.provider.Settings.Global.putInt(context.getContentResolver(),
405                 android.provider.Settings.Global.WFC_IMS_ROAMING_ENABLED, value);
406
407         final ImsManager imsManager = ImsManager.getInstance(context,
408                 SubscriptionManager.getDefaultVoicePhoneId());
409         if (imsManager != null) {
410             QueuedWork.singleThreadExecutor().submit(new Runnable() {
411                 public void run() {
412                     try {
413                         imsManager.getConfigInterface().setProvisionedValue(
414                                 ImsConfig.ConfigConstants.VOICE_OVER_WIFI_ROAMING,
415                                 value);
416                     } catch (ImsException e) {
417                         // do nothing
418                     }
419                 }
420             });
421         }
422     }
423
424     /**
425      * Returns a platform configuration for WFC which may override the user
426      * setting. Note: WFC presumes that VoLTE is enabled (these are
427      * configuration settings which must be done correctly).
428      */
429     public static boolean isWfcEnabledByPlatform(Context context) {
430         if (SystemProperties.getInt(PROPERTY_DBG_WFC_AVAIL_OVERRIDE,
431                 PROPERTY_DBG_WFC_AVAIL_OVERRIDE_DEFAULT) == 1) {
432             return true;
433         }
434
435         return
436                context.getResources().getBoolean(
437                        com.android.internal.R.bool.config_device_wfc_ims_available) &&
438                getBooleanCarrierConfig(context,
439                        CarrierConfigManager.KEY_CARRIER_WFC_IMS_AVAILABLE_BOOL);
440     }
441
442     private ImsManager(Context context, int phoneId) {
443         mContext = context;
444         mPhoneId = phoneId;
445         createImsService(true);
446     }
447
448     /*
449      * Returns a flag indicating whether the IMS service is available.
450      */
451     public boolean isServiceAvailable() {
452         if (mImsService != null) {
453             return true;
454         }
455
456         IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
457         if (binder != null) {
458             return true;
459         }
460
461         return false;
462     }
463
464     /**
465      * Opens the IMS service for making calls and/or receiving generic IMS calls.
466      * The caller may make subsquent calls through {@link #makeCall}.
467      * The IMS service will register the device to the operator's network with the credentials
468      * (from ISIM) periodically in order to receive calls from the operator's network.
469      * When the IMS service receives a new call, it will send out an intent with
470      * the provided action string.
471      * The intent contains a call ID extra {@link getCallId} and it can be used to take a call.
472      *
473      * @param serviceClass a service class specified in {@link ImsServiceClass}
474      *      For VoLTE service, it MUST be a {@link ImsServiceClass#MMTEL}.
475      * @param incomingCallPendingIntent When an incoming call is received,
476      *        the IMS service will call {@link PendingIntent#send(Context, int, Intent)} to
477      *        send back the intent to the caller with {@link #INCOMING_CALL_RESULT_CODE}
478      *        as the result code and the intent to fill in the call ID; It cannot be null
479      * @param listener To listen to IMS registration events; It cannot be null
480      * @return identifier (greater than 0) for the specified service
481      * @throws NullPointerException if {@code incomingCallPendingIntent}
482      *      or {@code listener} is null
483      * @throws ImsException if calling the IMS service results in an error
484      * @see #getCallId
485      * @see #getServiceId
486      */
487     public int open(int serviceClass, PendingIntent incomingCallPendingIntent,
488             ImsConnectionStateListener listener) throws ImsException {
489         checkAndThrowExceptionIfServiceUnavailable();
490
491         if (incomingCallPendingIntent == null) {
492             throw new NullPointerException("incomingCallPendingIntent can't be null");
493         }
494
495         if (listener == null) {
496             throw new NullPointerException("listener can't be null");
497         }
498
499         int result = 0;
500
501         try {
502             result = mImsService.open(mPhoneId, serviceClass, incomingCallPendingIntent,
503                     createRegistrationListenerProxy(serviceClass, listener));
504         } catch (RemoteException e) {
505             throw new ImsException("open()", e,
506                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
507         }
508
509         if (result <= 0) {
510             // If the return value is a minus value,
511             // it means that an error occurred in the service.
512             // So, it needs to convert to the reason code specified in ImsReasonInfo.
513             throw new ImsException("open()", (result * (-1)));
514         }
515
516         return result;
517     }
518
519     /**
520      * Closes the specified service ({@link ImsServiceClass}) not to make/receive calls.
521      * All the resources that were allocated to the service are also released.
522      *
523      * @param serviceId a service id to be closed which is obtained from {@link ImsManager#open}
524      * @throws ImsException if calling the IMS service results in an error
525      */
526     public void close(int serviceId) throws ImsException {
527         checkAndThrowExceptionIfServiceUnavailable();
528
529         try {
530             mImsService.close(serviceId);
531         } catch (RemoteException e) {
532             throw new ImsException("close()", e,
533                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
534         } finally {
535             mUt = null;
536             mConfig = null;
537             mEcbm = null;
538         }
539     }
540
541     /**
542      * Gets the configuration interface to provision / withdraw the supplementary service settings.
543      *
544      * @param serviceId a service id which is obtained from {@link ImsManager#open}
545      * @return the Ut interface instance
546      * @throws ImsException if getting the Ut interface results in an error
547      */
548     public ImsUtInterface getSupplementaryServiceConfiguration(int serviceId)
549             throws ImsException {
550         // FIXME: manage the multiple Ut interfaces based on the service id
551         if (mUt == null) {
552             checkAndThrowExceptionIfServiceUnavailable();
553
554             try {
555                 IImsUt iUt = mImsService.getUtInterface(serviceId);
556
557                 if (iUt == null) {
558                     throw new ImsException("getSupplementaryServiceConfiguration()",
559                             ImsReasonInfo.CODE_UT_NOT_SUPPORTED);
560                 }
561
562                 mUt = new ImsUt(iUt);
563             } catch (RemoteException e) {
564                 throw new ImsException("getSupplementaryServiceConfiguration()", e,
565                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
566             }
567         }
568
569         return mUt;
570     }
571
572     /**
573      * Checks if the IMS service has successfully registered to the IMS network
574      * with the specified service & call type.
575      *
576      * @param serviceId a service id which is obtained from {@link ImsManager#open}
577      * @param serviceType a service type that is specified in {@link ImsCallProfile}
578      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
579      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
580      * @param callType a call type that is specified in {@link ImsCallProfile}
581      *        {@link ImsCallProfile#CALL_TYPE_VOICE_N_VIDEO}
582      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
583      *        {@link ImsCallProfile#CALL_TYPE_VT}
584      *        {@link ImsCallProfile#CALL_TYPE_VS}
585      * @return true if the specified service id is connected to the IMS network;
586      *        false otherwise
587      * @throws ImsException if calling the IMS service results in an error
588      */
589     public boolean isConnected(int serviceId, int serviceType, int callType)
590             throws ImsException {
591         checkAndThrowExceptionIfServiceUnavailable();
592
593         try {
594             return mImsService.isConnected(serviceId, serviceType, callType);
595         } catch (RemoteException e) {
596             throw new ImsException("isServiceConnected()", e,
597                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
598         }
599     }
600
601     /**
602      * Checks if the specified IMS service is opend.
603      *
604      * @param serviceId a service id which is obtained from {@link ImsManager#open}
605      * @return true if the specified service id is opened; false otherwise
606      * @throws ImsException if calling the IMS service results in an error
607      */
608     public boolean isOpened(int serviceId) throws ImsException {
609         checkAndThrowExceptionIfServiceUnavailable();
610
611         try {
612             return mImsService.isOpened(serviceId);
613         } catch (RemoteException e) {
614             throw new ImsException("isOpened()", e,
615                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
616         }
617     }
618
619     /**
620      * Creates a {@link ImsCallProfile} from the service capabilities & IMS registration state.
621      *
622      * @param serviceId a service id which is obtained from {@link ImsManager#open}
623      * @param serviceType a service type that is specified in {@link ImsCallProfile}
624      *        {@link ImsCallProfile#SERVICE_TYPE_NONE}
625      *        {@link ImsCallProfile#SERVICE_TYPE_NORMAL}
626      *        {@link ImsCallProfile#SERVICE_TYPE_EMERGENCY}
627      * @param callType a call type that is specified in {@link ImsCallProfile}
628      *        {@link ImsCallProfile#CALL_TYPE_VOICE}
629      *        {@link ImsCallProfile#CALL_TYPE_VT}
630      *        {@link ImsCallProfile#CALL_TYPE_VT_TX}
631      *        {@link ImsCallProfile#CALL_TYPE_VT_RX}
632      *        {@link ImsCallProfile#CALL_TYPE_VT_NODIR}
633      *        {@link ImsCallProfile#CALL_TYPE_VS}
634      *        {@link ImsCallProfile#CALL_TYPE_VS_TX}
635      *        {@link ImsCallProfile#CALL_TYPE_VS_RX}
636      * @return a {@link ImsCallProfile} object
637      * @throws ImsException if calling the IMS service results in an error
638      */
639     public ImsCallProfile createCallProfile(int serviceId,
640             int serviceType, int callType) throws ImsException {
641         checkAndThrowExceptionIfServiceUnavailable();
642
643         try {
644             return mImsService.createCallProfile(serviceId, serviceType, callType);
645         } catch (RemoteException e) {
646             throw new ImsException("createCallProfile()", e,
647                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
648         }
649     }
650
651     /**
652      * Creates a {@link ImsCall} to make a call.
653      *
654      * @param serviceId a service id which is obtained from {@link ImsManager#open}
655      * @param profile a call profile to make the call
656      *      (it contains service type, call type, media information, etc.)
657      * @param participants participants to invite the conference call
658      * @param listener listen to the call events from {@link ImsCall}
659      * @return a {@link ImsCall} object
660      * @throws ImsException if calling the IMS service results in an error
661      */
662     public ImsCall makeCall(int serviceId, ImsCallProfile profile, String[] callees,
663             ImsCall.Listener listener) throws ImsException {
664         if (DBG) {
665             log("makeCall :: serviceId=" + serviceId
666                     + ", profile=" + profile + ", callees=" + callees);
667         }
668
669         checkAndThrowExceptionIfServiceUnavailable();
670
671         ImsCall call = new ImsCall(mContext, profile);
672
673         call.setListener(listener);
674         ImsCallSession session = createCallSession(serviceId, profile);
675
676         if ((callees != null) && (callees.length == 1)) {
677             call.start(session, callees[0]);
678         } else {
679             call.start(session, callees);
680         }
681
682         return call;
683     }
684
685     /**
686      * Creates a {@link ImsCall} to take an incoming call.
687      *
688      * @param serviceId a service id which is obtained from {@link ImsManager#open}
689      * @param incomingCallIntent the incoming call broadcast intent
690      * @param listener to listen to the call events from {@link ImsCall}
691      * @return a {@link ImsCall} object
692      * @throws ImsException if calling the IMS service results in an error
693      */
694     public ImsCall takeCall(int serviceId, Intent incomingCallIntent,
695             ImsCall.Listener listener) throws ImsException {
696         if (DBG) {
697             log("takeCall :: serviceId=" + serviceId
698                     + ", incomingCall=" + incomingCallIntent);
699         }
700
701         checkAndThrowExceptionIfServiceUnavailable();
702
703         if (incomingCallIntent == null) {
704             throw new ImsException("Can't retrieve session with null intent",
705                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
706         }
707
708         int incomingServiceId = getServiceId(incomingCallIntent);
709
710         if (serviceId != incomingServiceId) {
711             throw new ImsException("Service id is mismatched in the incoming call intent",
712                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
713         }
714
715         String callId = getCallId(incomingCallIntent);
716
717         if (callId == null) {
718             throw new ImsException("Call ID missing in the incoming call intent",
719                     ImsReasonInfo.CODE_LOCAL_ILLEGAL_ARGUMENT);
720         }
721
722         try {
723             IImsCallSession session = mImsService.getPendingCallSession(serviceId, callId);
724
725             if (session == null) {
726                 throw new ImsException("No pending session for the call",
727                         ImsReasonInfo.CODE_LOCAL_NO_PENDING_CALL);
728             }
729
730             ImsCall call = new ImsCall(mContext, session.getCallProfile());
731
732             call.attachSession(new ImsCallSession(session));
733             call.setListener(listener);
734
735             return call;
736         } catch (Throwable t) {
737             throw new ImsException("takeCall()", t, ImsReasonInfo.CODE_UNSPECIFIED);
738         }
739     }
740
741     /**
742      * Gets the config interface to get/set service/capability parameters.
743      *
744      * @return the ImsConfig instance.
745      * @throws ImsException if getting the setting interface results in an error.
746      */
747     public ImsConfig getConfigInterface() throws ImsException {
748
749         if (mConfig == null) {
750             checkAndThrowExceptionIfServiceUnavailable();
751
752             try {
753                 IImsConfig config = mImsService.getConfigInterface(mPhoneId);
754                 if (config == null) {
755                     throw new ImsException("getConfigInterface()",
756                             ImsReasonInfo.CODE_LOCAL_SERVICE_UNAVAILABLE);
757                 }
758                 mConfig = new ImsConfig(config, mContext);
759             } catch (RemoteException e) {
760                 throw new ImsException("getConfigInterface()", e,
761                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
762             }
763         }
764         if (DBG) log("getConfigInterface(), mConfig= " + mConfig);
765         return mConfig;
766     }
767
768     public void setUiTTYMode(Context context, int serviceId, int uiTtyMode, Message onComplete)
769             throws ImsException {
770
771         checkAndThrowExceptionIfServiceUnavailable();
772
773         try {
774             mImsService.setUiTTYMode(serviceId, uiTtyMode, onComplete);
775         } catch (RemoteException e) {
776             throw new ImsException("setTTYMode()", e,
777                     ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
778         }
779
780         if (!getBooleanCarrierConfig(context,
781                 CarrierConfigManager.KEY_CARRIER_VOLTE_TTY_SUPPORTED_BOOL)) {
782             setAdvanced4GMode((uiTtyMode == TelecomManager.TTY_MODE_OFF) &&
783                     isEnhanced4gLteModeSettingEnabledByUser(context));
784         }
785     }
786
787     /**
788      * Get the boolean config from carrier config manager.
789      *
790      * @param context the context to get carrier service
791      * @param key config key defined in CarrierConfigManager
792      * @return boolean value of corresponding key.
793      */
794     private static boolean getBooleanCarrierConfig(Context context, String key) {
795         CarrierConfigManager configManager = (CarrierConfigManager) context.getSystemService(
796                 Context.CARRIER_CONFIG_SERVICE);
797         PersistableBundle b = null;
798         if (configManager != null) {
799             b = configManager.getConfig();
800         }
801         if (b != null) {
802             return b.getBoolean(key);
803         } else {
804             // Return static default defined in CarrierConfigManager.
805             return CarrierConfigManager.getDefaultConfig().getBoolean(key);
806         }
807     }
808
809     /**
810      * Gets the call ID from the specified incoming call broadcast intent.
811      *
812      * @param incomingCallIntent the incoming call broadcast intent
813      * @return the call ID or null if the intent does not contain it
814      */
815     private static String getCallId(Intent incomingCallIntent) {
816         if (incomingCallIntent == null) {
817             return null;
818         }
819
820         return incomingCallIntent.getStringExtra(EXTRA_CALL_ID);
821     }
822
823     /**
824      * Gets the service type from the specified incoming call broadcast intent.
825      *
826      * @param incomingCallIntent the incoming call broadcast intent
827      * @return the service identifier or -1 if the intent does not contain it
828      */
829     private static int getServiceId(Intent incomingCallIntent) {
830         if (incomingCallIntent == null) {
831             return (-1);
832         }
833
834         return incomingCallIntent.getIntExtra(EXTRA_SERVICE_ID, -1);
835     }
836
837     /**
838      * Binds the IMS service only if the service is not created.
839      */
840     private void checkAndThrowExceptionIfServiceUnavailable()
841             throws ImsException {
842         if (mImsService == null) {
843             createImsService(true);
844
845             if (mImsService == null) {
846                 throw new ImsException("Service is unavailable",
847                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
848             }
849         }
850     }
851
852     private static String getImsServiceName(int phoneId) {
853         // TODO: MSIM implementation needs to decide on service name as a function of phoneId
854         return IMS_SERVICE;
855     }
856
857     /**
858      * Binds the IMS service to make/receive the call.
859      */
860     private void createImsService(boolean checkService) {
861         if (checkService) {
862             IBinder binder = ServiceManager.checkService(getImsServiceName(mPhoneId));
863
864             if (binder == null) {
865                 return;
866             }
867         }
868
869         IBinder b = ServiceManager.getService(getImsServiceName(mPhoneId));
870
871         if (b != null) {
872             try {
873                 b.linkToDeath(mDeathRecipient, 0);
874             } catch (RemoteException e) {
875             }
876         }
877
878         mImsService = IImsService.Stub.asInterface(b);
879     }
880
881     /**
882      * Creates a {@link ImsCallSession} with the specified call profile.
883      * Use other methods, if applicable, instead of interacting with
884      * {@link ImsCallSession} directly.
885      *
886      * @param serviceId a service id which is obtained from {@link ImsManager#open}
887      * @param profile a call profile to make the call
888      */
889     private ImsCallSession createCallSession(int serviceId,
890             ImsCallProfile profile) throws ImsException {
891         try {
892             return new ImsCallSession(mImsService.createCallSession(serviceId, profile, null));
893         } catch (RemoteException e) {
894             return null;
895         }
896     }
897
898     private ImsRegistrationListenerProxy createRegistrationListenerProxy(int serviceClass,
899             ImsConnectionStateListener listener) {
900         ImsRegistrationListenerProxy proxy =
901                 new ImsRegistrationListenerProxy(serviceClass, listener);
902         return proxy;
903     }
904
905     private static void log(String s) {
906         Rlog.d(TAG, s);
907     }
908
909     private static void loge(String s) {
910         Rlog.e(TAG, s);
911     }
912
913     private static void loge(String s, Throwable t) {
914         Rlog.e(TAG, s, t);
915     }
916
917     /**
918      * Used for turning on IMS.if its off already
919      */
920     private void turnOnIms() throws ImsException {
921         checkAndThrowExceptionIfServiceUnavailable();
922
923         try {
924             mImsService.turnOnIms(mPhoneId);
925         } catch (RemoteException e) {
926             throw new ImsException("turnOnIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
927         }
928     }
929
930     private void setAdvanced4GMode(boolean turnOn) throws ImsException {
931         checkAndThrowExceptionIfServiceUnavailable();
932
933         ImsConfig config = getConfigInterface();
934         if (config != null) {
935             config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VOICE_OVER_LTE,
936                     TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
937             if (isVtEnabledByPlatform(mContext)) {
938                 // TODO: once VT is available on platform replace the '1' with the current
939                 // user configuration of VT.
940                 config.setFeatureValue(ImsConfig.FeatureConstants.FEATURE_TYPE_VIDEO_OVER_LTE,
941                         TelephonyManager.NETWORK_TYPE_LTE, turnOn ? 1 : 0, null);
942             }
943         }
944
945         if (turnOn) {
946             turnOnIms();
947         } else if (getBooleanCarrierConfig(mContext,
948                 CarrierConfigManager.KEY_CARRIER_ALLOW_TURNOFF_IMS_BOOL)
949                 && (!isWfcEnabledByPlatform(mContext)
950                 || !isWfcEnabledByUser(mContext))) {
951             log("setAdvanced4GMode() : imsServiceAllowTurnOff -> turnOffIms");
952             turnOffIms();
953         }
954     }
955
956     /**
957      * Used for turning off IMS completely in order to make the device CSFB'ed.
958      * Once turned off, all calls will be over CS.
959      */
960     private void turnOffIms() throws ImsException {
961         checkAndThrowExceptionIfServiceUnavailable();
962
963         try {
964             mImsService.turnOffIms(mPhoneId);
965         } catch (RemoteException e) {
966             throw new ImsException("turnOffIms() ", e, ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
967         }
968     }
969
970     /**
971      * Death recipient class for monitoring IMS service.
972      */
973     private class ImsServiceDeathRecipient implements IBinder.DeathRecipient {
974         @Override
975         public void binderDied() {
976             mImsService = null;
977             mUt = null;
978             mConfig = null;
979             mEcbm = null;
980
981             if (mContext != null) {
982                 Intent intent = new Intent(ACTION_IMS_SERVICE_DOWN);
983                 intent.putExtra(EXTRA_PHONE_ID, mPhoneId);
984                 mContext.sendBroadcast(new Intent(intent));
985             }
986         }
987     }
988
989     /**
990      * Adapter class for {@link IImsRegistrationListener}.
991      */
992     private class ImsRegistrationListenerProxy extends IImsRegistrationListener.Stub {
993         private int mServiceClass;
994         private ImsConnectionStateListener mListener;
995
996         public ImsRegistrationListenerProxy(int serviceClass,
997                 ImsConnectionStateListener listener) {
998             mServiceClass = serviceClass;
999             mListener = listener;
1000         }
1001
1002         public boolean isSameProxy(int serviceClass) {
1003             return (mServiceClass == serviceClass);
1004         }
1005
1006         @Override
1007         public void registrationConnected() {
1008             if (DBG) {
1009                 log("registrationConnected ::");
1010             }
1011
1012             if (mListener != null) {
1013                 mListener.onImsConnected();
1014             }
1015         }
1016
1017         @Override
1018         public void registrationProgressing() {
1019             if (DBG) {
1020                 log("registrationProgressing ::");
1021             }
1022
1023             if (mListener != null) {
1024                 mListener.onImsProgressing();
1025             }
1026         }
1027
1028         @Override
1029         public void registrationDisconnected(ImsReasonInfo imsReasonInfo) {
1030             if (DBG) {
1031                 log("registrationDisconnected :: imsReasonInfo" + imsReasonInfo);
1032             }
1033
1034             if (mListener != null) {
1035                 mListener.onImsDisconnected(imsReasonInfo);
1036             }
1037         }
1038
1039         @Override
1040         public void registrationResumed() {
1041             if (DBG) {
1042                 log("registrationResumed ::");
1043             }
1044
1045             if (mListener != null) {
1046                 mListener.onImsResumed();
1047             }
1048         }
1049
1050         @Override
1051         public void registrationSuspended() {
1052             if (DBG) {
1053                 log("registrationSuspended ::");
1054             }
1055
1056             if (mListener != null) {
1057                 mListener.onImsSuspended();
1058             }
1059         }
1060
1061         @Override
1062         public void registrationServiceCapabilityChanged(int serviceClass, int event) {
1063             log("registrationServiceCapabilityChanged :: serviceClass=" +
1064                     serviceClass + ", event=" + event);
1065
1066             if (mListener != null) {
1067                 mListener.onImsConnected();
1068             }
1069         }
1070
1071         @Override
1072         public void registrationFeatureCapabilityChanged(int serviceClass,
1073                 int[] enabledFeatures, int[] disabledFeatures) {
1074             log("registrationFeatureCapabilityChanged :: serviceClass=" +
1075                     serviceClass);
1076             if (mListener != null) {
1077                 mListener.onFeatureCapabilityChanged(serviceClass,
1078                         enabledFeatures, disabledFeatures);
1079             }
1080         }
1081
1082         @Override
1083         public void voiceMessageCountUpdate(int count) {
1084             log("voiceMessageCountUpdate :: count=" + count);
1085
1086             if (mListener != null) {
1087                 mListener.onVoiceMessageCountChanged(count);
1088             }
1089         }
1090
1091     }
1092     /**
1093      * Gets the ECBM interface to request ECBM exit.
1094      *
1095      * @param serviceId a service id which is obtained from {@link ImsManager#open}
1096      * @return the ECBM interface instance
1097      * @throws ImsException if getting the ECBM interface results in an error
1098      */
1099     public ImsEcbm getEcbmInterface(int serviceId) throws ImsException {
1100         if (mEcbm == null) {
1101             checkAndThrowExceptionIfServiceUnavailable();
1102
1103             try {
1104                 IImsEcbm iEcbm = mImsService.getEcbmInterface(serviceId);
1105
1106                 if (iEcbm == null) {
1107                     throw new ImsException("getEcbmInterface()",
1108                             ImsReasonInfo.CODE_ECBM_NOT_SUPPORTED);
1109                 }
1110                 mEcbm = new ImsEcbm(iEcbm);
1111             } catch (RemoteException e) {
1112                 throw new ImsException("getEcbmInterface()", e,
1113                         ImsReasonInfo.CODE_LOCAL_IMS_SERVICE_DOWN);
1114             }
1115         }
1116         return mEcbm;
1117     }
1118 }