Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 1 | /* |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 2 | * Copyright (C) 2019 The Android Open Source Project |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 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 | package com.android.car.assist.client; |
| 17 | |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 18 | import static android.app.Notification.Action.SEMANTIC_ACTION_MARK_AS_READ; |
| 19 | import static android.app.Notification.Action.SEMANTIC_ACTION_REPLY; |
| 20 | |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 21 | import android.app.Notification; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 22 | import android.app.RemoteInput; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 23 | import android.content.Context; |
| 24 | import android.os.Bundle; |
| 25 | import android.provider.Settings; |
| 26 | import android.service.notification.StatusBarNotification; |
| 27 | import android.util.Log; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 28 | import android.widget.Toast; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 29 | |
| 30 | import androidx.core.app.NotificationCompat; |
| 31 | |
| 32 | import com.android.car.assist.CarVoiceInteractionSession; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 33 | import com.android.car.assist.client.tts.TextToSpeechHelper; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 34 | import com.android.internal.app.AssistUtils; |
| 35 | |
| 36 | import java.util.Arrays; |
| 37 | import java.util.Collections; |
| 38 | import java.util.HashSet; |
| 39 | import java.util.List; |
| 40 | import java.util.Objects; |
| 41 | import java.util.Set; |
| 42 | import java.util.stream.Collectors; |
| 43 | import java.util.stream.IntStream; |
| 44 | |
| 45 | /** |
| 46 | * Util class providing helper methods to interact with the current active voice service, |
| 47 | * while ensuring that the active voice service has the required permissions. |
| 48 | */ |
| 49 | public class CarAssistUtils { |
| 50 | public static final String TAG = "CarAssistUtils"; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 51 | private static final List<Integer> REQUIRED_SEMANTIC_ACTIONS = Collections.unmodifiableList( |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 52 | Arrays.asList( |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 53 | SEMANTIC_ACTION_REPLY, |
| 54 | SEMANTIC_ACTION_MARK_AS_READ |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 55 | ) |
| 56 | ); |
| 57 | |
| 58 | // Currently, all supported semantic actions are required. |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 59 | private static final List<Integer> SUPPORTED_SEMANTIC_ACTIONS = REQUIRED_SEMANTIC_ACTIONS; |
| 60 | |
| 61 | private final TextToSpeechHelper.Listener mListener = new TextToSpeechHelper.Listener() { |
| 62 | @Override |
| 63 | public void onTextToSpeechStarted() { |
| 64 | if (Log.isLoggable(TAG, Log.DEBUG)) { |
| 65 | Log.d(TAG, "onTextToSpeechStarted"); |
| 66 | } |
| 67 | } |
| 68 | |
| 69 | @Override |
| 70 | public void onTextToSpeechStopped(boolean error) { |
| 71 | if (Log.isLoggable(TAG, Log.DEBUG)) { |
| 72 | Log.d(TAG, "onTextToSpeechStopped"); |
| 73 | } |
| 74 | if (error) { |
| 75 | Toast.makeText(mContext, mErrorMessage, Toast.LENGTH_LONG).show(); |
| 76 | } |
| 77 | } |
| 78 | }; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 79 | |
| 80 | private final Context mContext; |
| 81 | private final AssistUtils mAssistUtils; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 82 | private final FallbackAssistant mFallbackAssistant; |
| 83 | private final String mErrorMessage; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 84 | |
| 85 | public CarAssistUtils(Context context) { |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 86 | mContext = context; |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 87 | mAssistUtils = new AssistUtils(context); |
| 88 | mFallbackAssistant = new FallbackAssistant(new TextToSpeechHelper(context)); |
| 89 | mErrorMessage = context.getString(R.string.assist_action_failed_toast); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 90 | } |
| 91 | |
| 92 | /** |
| 93 | * Returns true if the current active assistant has notification listener permissions. |
| 94 | */ |
| 95 | public boolean assistantIsNotificationListener() { |
| 96 | final String activeComponent = mAssistUtils.getActiveServiceComponentName() |
| 97 | .flattenToString(); |
| 98 | final String listeners = Settings.Secure.getString(mContext.getContentResolver(), |
| 99 | Settings.Secure.ENABLED_NOTIFICATION_LISTENERS); |
| 100 | |
| 101 | return listeners != null |
| 102 | && Arrays.asList(listeners.split(":")).contains(activeComponent); |
| 103 | } |
| 104 | |
| 105 | /** |
| 106 | * Checks whether the notification is a car-compatible messaging notification. |
| 107 | * |
| 108 | * @param sbn The notification being checked. |
| 109 | * @return true if the notification is a car-compatible messaging notification. |
| 110 | */ |
| 111 | public static boolean isCarCompatibleMessagingNotification(StatusBarNotification sbn) { |
| 112 | return hasMessagingStyle(sbn) |
| 113 | && hasRequiredAssistantCallbacks(sbn) |
| 114 | && replyCallbackHasRemoteInput(sbn) |
| 115 | && assistantCallbacksShowNoUi(sbn); |
| 116 | } |
| 117 | |
| 118 | /** Returns true if the semantic action provided can be supported. */ |
| 119 | public static boolean isSupportedSemanticAction(int semanticAction) { |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 120 | return SUPPORTED_SEMANTIC_ACTIONS.contains(semanticAction); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 121 | } |
| 122 | |
| 123 | /** |
| 124 | * Returns true if the notification has a messaging style. |
| 125 | * <p/> |
| 126 | * This is the case if the notification in question was provided an instance of |
| 127 | * {@link Notification.MessagingStyle} (or an instance of |
| 128 | * {@link NotificationCompat.MessagingStyle} if {@link NotificationCompat} was used). |
| 129 | */ |
| 130 | private static boolean hasMessagingStyle(StatusBarNotification sbn) { |
| 131 | return NotificationCompat.MessagingStyle |
| 132 | .extractMessagingStyleFromNotification(sbn.getNotification()) != null; |
| 133 | } |
| 134 | |
| 135 | /** |
| 136 | * Returns true if the notification has the required Assistant callbacks to be considered |
| 137 | * a car-compatible messaging notification. The callbacks must be unambiguous, therefore false |
| 138 | * is returned if multiple callbacks exist for any semantic action that is supported. |
| 139 | */ |
| 140 | private static boolean hasRequiredAssistantCallbacks(StatusBarNotification sbn) { |
| 141 | List<Integer> semanticActionList = Arrays.stream(sbn.getNotification().actions) |
| 142 | .map(Notification.Action::getSemanticAction) |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 143 | .filter(REQUIRED_SEMANTIC_ACTIONS::contains) |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 144 | .collect(Collectors.toList()); |
| 145 | Set<Integer> semanticActionSet = new HashSet<>(semanticActionList); |
| 146 | |
| 147 | return semanticActionList.size() == semanticActionSet.size() |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 148 | && semanticActionSet.containsAll(REQUIRED_SEMANTIC_ACTIONS); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 149 | } |
| 150 | |
| 151 | /** |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 152 | * Returns true if the reply callback has at least one {@link RemoteInput}. |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 153 | * <p/> |
| 154 | * Precondition: There exists only one reply callback. |
| 155 | */ |
| 156 | private static boolean replyCallbackHasRemoteInput(StatusBarNotification sbn) { |
| 157 | return Arrays.stream(sbn.getNotification().actions) |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 158 | .filter(action -> action.getSemanticAction() == SEMANTIC_ACTION_REPLY) |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 159 | .map(Notification.Action::getRemoteInputs) |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 160 | .filter(Objects::nonNull) |
| 161 | .anyMatch(remoteInputs -> remoteInputs.length > 0); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 162 | } |
| 163 | |
| 164 | /** Returns true if all Assistant callbacks indicate that they show no UI, false otherwise. */ |
| 165 | private static boolean assistantCallbacksShowNoUi(StatusBarNotification sbn) { |
| 166 | final Notification notification = sbn.getNotification(); |
| 167 | return IntStream.range(0, notification.actions.length) |
| 168 | .mapToObj(i -> NotificationCompat.getAction(notification, i)) |
| 169 | .filter(Objects::nonNull) |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 170 | .filter(action -> SUPPORTED_SEMANTIC_ACTIONS.contains(action.getSemanticAction())) |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 171 | .noneMatch(NotificationCompat.Action::getShowsUserInterface); |
| 172 | } |
| 173 | |
| 174 | /** |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 175 | * Requests a given action from the current active Assistant. |
| 176 | * |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 177 | * |
| 178 | * @param sbn the notification payload to deliver to assistant |
| 179 | * @param semanticAction the semantic action that is to be requested |
| 180 | * @return true if the request was successful |
| 181 | */ |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 182 | public boolean requestAssistantVoiceAction(StatusBarNotification sbn, int semanticAction) { |
| 183 | if (!isCarCompatibleMessagingNotification(sbn)) { |
| 184 | Log.w(TAG, "Assistant action requested for non-compatible notification."); |
| 185 | return false; |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 186 | } |
| 187 | |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 188 | switch (semanticAction) { |
| 189 | case SEMANTIC_ACTION_MARK_AS_READ: |
| 190 | return readMessageNotification(sbn); |
| 191 | case SEMANTIC_ACTION_REPLY: |
| 192 | return replyMessageNotification(sbn); |
| 193 | default: |
| 194 | return false; |
| 195 | } |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 196 | } |
| 197 | |
| 198 | /** |
| 199 | * Requests a read action for the notification from the current active Assistant. |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 200 | * If the Assistant is cannot handle the request, a fallback implementation will attempt to |
| 201 | * handle it. |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 202 | * |
| 203 | * @param sbn the notification to deliver as the payload |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 204 | * @return true if the read request was handled successfully |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 205 | */ |
| 206 | private boolean readMessageNotification(StatusBarNotification sbn) { |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 207 | return requestAction(BundleBuilder.buildAssistantReadBundle(sbn)) |
| 208 | || mFallbackAssistant.handleReadAction(sbn, mListener); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 209 | } |
| 210 | |
| 211 | /** |
| 212 | * Requests a reply action for the notification from the current active Assistant. |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 213 | * If the Assistant is cannot handle the request, a fallback implementation will attempt to |
| 214 | * handle it. |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 215 | * |
| 216 | * @param sbn the notification to deliver as the payload |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 217 | * @return true if the reply request was handled successfully |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 218 | */ |
| 219 | private boolean replyMessageNotification(StatusBarNotification sbn) { |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 220 | return requestAction(BundleBuilder.buildAssistantReplyBundle(sbn)) |
| 221 | || mFallbackAssistant.handleErrorMessage(mErrorMessage, mListener); |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 222 | } |
| 223 | |
Uriel Sade | d81ddc9 | 2018-12-21 15:16:56 -0800 | [diff] [blame^] | 224 | private boolean requestAction(Bundle payloadArguments) { |
| 225 | return assistantIsNotificationListener() |
Uriel Sade | 298f6c0 | 2018-12-19 20:34:43 -0800 | [diff] [blame] | 226 | && mAssistUtils.showSessionForActiveService(payloadArguments, |
| 227 | CarVoiceInteractionSession.SHOW_SOURCE_NOTIFICATION, null, null); |
| 228 | } |
| 229 | } |