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