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