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