| /* |
| * Copyright (C) 2018 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.telephony.ims; |
| |
| import android.Manifest; |
| import android.annotation.CallbackExecutor; |
| import android.annotation.IntDef; |
| import android.annotation.NonNull; |
| import android.annotation.RequiresPermission; |
| import android.annotation.SystemApi; |
| import android.annotation.TestApi; |
| import android.content.Context; |
| import android.net.Uri; |
| import android.os.Binder; |
| import android.os.IBinder; |
| import android.os.RemoteException; |
| import android.telephony.TelephonyFrameworkInitializer; |
| import android.telephony.ims.aidl.IImsRcsController; |
| import android.telephony.ims.aidl.IRcsUceControllerCallback; |
| import android.telephony.ims.feature.RcsFeature; |
| import android.util.Log; |
| |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.util.List; |
| import java.util.concurrent.Executor; |
| |
| /** |
| * Manages RCS User Capability Exchange for the subscription specified. |
| * |
| * @see ImsRcsManager#getUceAdapter() for information on creating an instance of this class. |
| */ |
| public class RcsUceAdapter { |
| private static final String TAG = "RcsUceAdapter"; |
| |
| /** |
| * An unknown error has caused the request to fail. |
| * @hide |
| */ |
| public static final int ERROR_GENERIC_FAILURE = 1; |
| /** |
| * The carrier network does not have UCE support enabled for this subscriber. |
| * @hide |
| */ |
| public static final int ERROR_NOT_ENABLED = 2; |
| /** |
| * The data network that the device is connected to does not support UCE currently (e.g. it is |
| * 1x only currently). |
| * @hide |
| */ |
| public static final int ERROR_NOT_AVAILABLE = 3; |
| /** |
| * The network has responded with SIP 403 error and a reason "User not registered." |
| * @hide |
| */ |
| public static final int ERROR_NOT_REGISTERED = 4; |
| /** |
| * The network has responded to this request with a SIP 403 error and reason "not authorized for |
| * presence" for this subscriber. |
| * @hide |
| */ |
| public static final int ERROR_NOT_AUTHORIZED = 5; |
| /** |
| * The network has responded to this request with a SIP 403 error and no reason. |
| * @hide |
| */ |
| public static final int ERROR_FORBIDDEN = 6; |
| /** |
| * The contact URI requested is not provisioned for VoLTE or it is not known as an IMS |
| * subscriber to the carrier network. |
| * @hide |
| */ |
| public static final int ERROR_NOT_FOUND = 7; |
| /** |
| * The capabilities request contained too many URIs for the carrier network to handle. Retry |
| * with a lower number of contact numbers. The number varies per carrier. |
| * @hide |
| */ |
| // TODO: Try to integrate this into the API so that the service will split based on carrier. |
| public static final int ERROR_REQUEST_TOO_LARGE = 8; |
| /** |
| * The network did not respond to the capabilities request before the request timed out. |
| * @hide |
| */ |
| public static final int ERROR_REQUEST_TIMEOUT = 10; |
| /** |
| * The request failed due to the service having insufficient memory. |
| * @hide |
| */ |
| public static final int ERROR_INSUFFICIENT_MEMORY = 11; |
| /** |
| * The network was lost while trying to complete the request. |
| * @hide |
| */ |
| public static final int ERROR_LOST_NETWORK = 12; |
| /** |
| * The request has failed because the same request has already been added to the queue. |
| * @hide |
| */ |
| public static final int ERROR_ALREADY_IN_QUEUE = 13; |
| |
| /**@hide*/ |
| @Retention(RetentionPolicy.SOURCE) |
| @IntDef(prefix = "ERROR_", value = { |
| ERROR_GENERIC_FAILURE, |
| ERROR_NOT_ENABLED, |
| ERROR_NOT_AVAILABLE, |
| ERROR_NOT_REGISTERED, |
| ERROR_NOT_AUTHORIZED, |
| ERROR_FORBIDDEN, |
| ERROR_NOT_FOUND, |
| ERROR_REQUEST_TOO_LARGE, |
| ERROR_REQUEST_TIMEOUT, |
| ERROR_INSUFFICIENT_MEMORY, |
| ERROR_LOST_NETWORK, |
| ERROR_ALREADY_IN_QUEUE |
| }) |
| public @interface ErrorCode {} |
| |
| /** |
| * The last publish has resulted in a "200 OK" response or the device is using SIP OPTIONS for |
| * UCE. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_OK = 1; |
| |
| /** |
| * The hasn't published its capabilities since boot or hasn't gotten any publish response yet. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_NOT_PUBLISHED = 2; |
| |
| /** |
| * The device has tried to publish its capabilities, which has resulted in an error. This error |
| * is related to the fact that the device is not VoLTE provisioned. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_VOLTE_PROVISION_ERROR = 3; |
| |
| /** |
| * The device has tried to publish its capabilities, which has resulted in an error. This error |
| * is related to the fact that the device is not RCS or UCE provisioned. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_RCS_PROVISION_ERROR = 4; |
| |
| /** |
| * The last publish resulted in a "408 Request Timeout" response. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_REQUEST_TIMEOUT = 5; |
| |
| /** |
| * The last publish resulted in another unknown error, such as SIP 503 - "Service Unavailable" |
| * or SIP 423 - "Interval too short". |
| * <p> |
| * Device shall retry with exponential back-off. |
| * @hide |
| */ |
| public static final int PUBLISH_STATE_OTHER_ERROR = 6; |
| |
| /**@hide*/ |
| @Retention(RetentionPolicy.SOURCE) |
| @IntDef(prefix = "PUBLISH_STATE_", value = { |
| PUBLISH_STATE_OK, |
| PUBLISH_STATE_NOT_PUBLISHED, |
| PUBLISH_STATE_VOLTE_PROVISION_ERROR, |
| PUBLISH_STATE_RCS_PROVISION_ERROR, |
| PUBLISH_STATE_REQUEST_TIMEOUT, |
| PUBLISH_STATE_OTHER_ERROR |
| }) |
| public @interface PublishState {} |
| |
| |
| /** |
| * Provides a one-time callback for the response to a UCE request. After this callback is called |
| * by the framework, the reference to this callback will be discarded on the service side. |
| * @see #requestCapabilities(Executor, List, CapabilitiesCallback) |
| * @hide |
| */ |
| public static class CapabilitiesCallback { |
| |
| /** |
| * Notify this application that the pending capability request has returned successfully. |
| * @param contactCapabilities List of capabilities associated with each contact requested. |
| */ |
| public void onCapabilitiesReceived( |
| @NonNull List<RcsContactUceCapability> contactCapabilities) { |
| |
| } |
| |
| /** |
| * The pending request has resulted in an error and may need to be retried, depending on the |
| * error code. |
| * @param errorCode The reason for the framework being unable to process the request. |
| */ |
| public void onError(@ErrorCode int errorCode) { |
| |
| } |
| } |
| |
| private final Context mContext; |
| private final int mSubId; |
| |
| /** |
| * Not to be instantiated directly, use |
| * {@link ImsRcsManager#getUceAdapter()} to instantiate this manager class. |
| * @hide |
| */ |
| RcsUceAdapter(Context context, int subId) { |
| mContext = context; |
| mSubId = subId; |
| } |
| |
| /** |
| * Request the User Capability Exchange capabilities for one or more contacts. |
| * <p> |
| * Be sure to check the availability of this feature using |
| * {@link ImsRcsManager#isAvailable(int)} and ensuring |
| * {@link RcsFeature.RcsImsCapabilities#CAPABILITY_TYPE_OPTIONS_UCE} or |
| * {@link RcsFeature.RcsImsCapabilities#CAPABILITY_TYPE_PRESENCE_UCE} is enabled or else |
| * this operation will fail with {@link #ERROR_NOT_AVAILABLE} or {@link #ERROR_NOT_ENABLED}. |
| * |
| * @param executor The executor that will be used when the request is completed and the |
| * {@link CapabilitiesCallback} is called. |
| * @param contactNumbers A list of numbers that the capabilities are being requested for. |
| * @param c A one-time callback for when the request for capabilities completes or there is an |
| * error processing the request. |
| * @throws ImsException if the subscription associated with this instance of |
| * {@link RcsUceAdapter} is valid, but the ImsService associated with the subscription is not |
| * available. This can happen if the ImsService has crashed, for example, or if the subscription |
| * becomes inactive. See {@link ImsException#getCode()} for more information on the error codes. |
| * @hide |
| */ |
| @RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE) |
| public void requestCapabilities(@NonNull @CallbackExecutor Executor executor, |
| @NonNull List<Uri> contactNumbers, |
| @NonNull CapabilitiesCallback c) throws ImsException { |
| if (c == null) { |
| throw new IllegalArgumentException("Must include a non-null AvailabilityCallback."); |
| } |
| if (executor == null) { |
| throw new IllegalArgumentException("Must include a non-null Executor."); |
| } |
| if (contactNumbers == null) { |
| throw new IllegalArgumentException("Must include non-null contact number list."); |
| } |
| |
| IImsRcsController imsRcsController = getIImsRcsController(); |
| if (imsRcsController == null) { |
| Log.e(TAG, "requestCapabilities: IImsRcsController is null"); |
| throw new ImsException("Can not find remote IMS service", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| |
| IRcsUceControllerCallback internalCallback = new IRcsUceControllerCallback.Stub() { |
| @Override |
| public void onCapabilitiesReceived(List<RcsContactUceCapability> contactCapabilities) { |
| long callingIdentity = Binder.clearCallingIdentity(); |
| try { |
| executor.execute(() -> |
| c.onCapabilitiesReceived(contactCapabilities)); |
| } finally { |
| restoreCallingIdentity(callingIdentity); |
| } |
| } |
| @Override |
| public void onError(int errorCode) { |
| long callingIdentity = Binder.clearCallingIdentity(); |
| try { |
| executor.execute(() -> c.onError(errorCode)); |
| } finally { |
| restoreCallingIdentity(callingIdentity); |
| } |
| } |
| }; |
| |
| try { |
| imsRcsController.requestCapabilities(mSubId, mContext.getOpPackageName(), |
| mContext.getAttributionTag(), contactNumbers, internalCallback); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error calling IImsRcsController#requestCapabilities", e); |
| throw new ImsException("Remote IMS Service is not available", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| } |
| |
| /** |
| * Gets the last publish result from the UCE service if the device is using an RCS presence |
| * server. |
| * @return The last publish result from the UCE service. If the device is using SIP OPTIONS, |
| * this method will return {@link #PUBLISH_STATE_OK} as well. |
| * @throws ImsException if the subscription associated with this instance of |
| * {@link RcsUceAdapter} is valid, but the ImsService associated with the subscription is not |
| * available. This can happen if the ImsService has crashed, for example, or if the subscription |
| * becomes inactive. See {@link ImsException#getCode()} for more information on the error codes. |
| * @hide |
| */ |
| @RequiresPermission(Manifest.permission.READ_PRIVILEGED_PHONE_STATE) |
| public @PublishState int getUcePublishState() throws ImsException { |
| IImsRcsController imsRcsController = getIImsRcsController(); |
| if (imsRcsController == null) { |
| Log.e(TAG, "getUcePublishState: IImsRcsController is null"); |
| throw new ImsException("Can not find remote IMS service", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| |
| try { |
| return imsRcsController.getUcePublishState(mSubId); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error calling IImsRcsController#getUcePublishState", e); |
| throw new ImsException("Remote IMS Service is not available", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| } |
| |
| /** |
| * The user’s setting for whether or not User Capability Exchange (UCE) is enabled for the |
| * associated subscription. |
| * <p> |
| * Note: This setting does not affect whether or not the device publishes its service |
| * capabilities if the subscription supports presence publication. |
| * |
| * @return true if the user’s setting for UCE is enabled, false otherwise. |
| * @throws ImsException if the subscription associated with this instance of |
| * {@link RcsUceAdapter} is valid, but the ImsService associated with the subscription is not |
| * available. This can happen if the ImsService has crashed, for example, or if the subscription |
| * becomes inactive. See {@link ImsException#getCode()} for more information on the error codes. |
| */ |
| @RequiresPermission(Manifest.permission.READ_PHONE_STATE) |
| public boolean isUceSettingEnabled() throws ImsException { |
| IImsRcsController imsRcsController = getIImsRcsController(); |
| if (imsRcsController == null) { |
| Log.e(TAG, "isUceSettingEnabled: IImsRcsController is null"); |
| throw new ImsException("Can not find remote IMS service", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| try { |
| // Telephony.SimInfo#IMS_RCS_UCE_ENABLED can also be used to listen to changes to this. |
| return imsRcsController.isUceSettingEnabled(mSubId, mContext.getOpPackageName(), |
| mContext.getAttributionTag()); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error calling IImsRcsController#isUceSettingEnabled", e); |
| throw new ImsException("Remote IMS Service is not available", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| } |
| |
| /** |
| * Change the user’s setting for whether or not UCE is enabled for the associated subscription. |
| * <p> |
| * If an application Requires UCE, they may launch an Activity using the Intent |
| * {@link ImsRcsManager#ACTION_SHOW_CAPABILITY_DISCOVERY_OPT_IN}, which will ask the user if |
| * they wish to enable this feature. |
| * <p> |
| * Note: This setting does not affect whether or not the device publishes its service |
| * capabilities if the subscription supports presence publication. |
| * |
| * @param isEnabled the user's setting for whether or not they wish for User |
| * Capability Exchange to be enabled. |
| * @throws ImsException if the subscription associated with this instance of |
| * {@link RcsUceAdapter} is valid, but the ImsService associated with the subscription is not |
| * available. This can happen if the ImsService has crashed, for example, or if the subscription |
| * becomes inactive. See {@link ImsException#getCode()} for more information on the error codes. |
| * @hide |
| */ |
| @SystemApi |
| @TestApi |
| @RequiresPermission(Manifest.permission.MODIFY_PHONE_STATE) |
| public void setUceSettingEnabled(boolean isEnabled) throws ImsException { |
| IImsRcsController imsRcsController = getIImsRcsController(); |
| if (imsRcsController == null) { |
| Log.e(TAG, "setUceSettingEnabled: IImsRcsController is null"); |
| throw new ImsException("Can not find remote IMS service", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| |
| try { |
| imsRcsController.setUceSettingEnabled(mSubId, isEnabled); |
| } catch (RemoteException e) { |
| Log.e(TAG, "Error calling IImsRcsController#setUceSettingEnabled", e); |
| throw new ImsException("Remote IMS Service is not available", |
| ImsException.CODE_ERROR_SERVICE_UNAVAILABLE); |
| } |
| } |
| |
| private IImsRcsController getIImsRcsController() { |
| IBinder binder = TelephonyFrameworkInitializer |
| .getTelephonyServiceManager() |
| .getTelephonyImsServiceRegisterer() |
| .get(); |
| return IImsRcsController.Stub.asInterface(binder); |
| } |
| } |