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