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