1 /* 2 * Copyright (C) 2019 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.car.developeroptions.slices; 18 19 import static com.android.car.developeroptions.core.BasePreferenceController.DISABLED_DEPENDENT_SETTING; 20 import static com.android.car.developeroptions.slices.SettingsSliceProvider.EXTRA_SLICE_KEY; 21 import static com.android.car.developeroptions.slices.SettingsSliceProvider.EXTRA_SLICE_PLATFORM_DEFINED; 22 23 import android.annotation.ColorInt; 24 import android.app.PendingIntent; 25 import android.app.settings.SettingsEnums; 26 import android.content.ContentResolver; 27 import android.content.Context; 28 import android.content.Intent; 29 import android.net.Uri; 30 import android.os.Bundle; 31 import android.provider.SettingsSlicesContract; 32 import android.text.TextUtils; 33 import android.util.ArraySet; 34 import android.util.Log; 35 import android.util.Pair; 36 37 import androidx.annotation.VisibleForTesting; 38 import androidx.core.graphics.drawable.IconCompat; 39 import androidx.slice.Slice; 40 import androidx.slice.builders.ListBuilder; 41 import androidx.slice.builders.ListBuilder.InputRangeBuilder; 42 import androidx.slice.builders.ListBuilder.RowBuilder; 43 import androidx.slice.builders.SliceAction; 44 45 import com.android.car.developeroptions.R; 46 import com.android.car.developeroptions.SettingsActivity; 47 import com.android.car.developeroptions.SubSettings; 48 import com.android.car.developeroptions.Utils; 49 import com.android.car.developeroptions.core.BasePreferenceController; 50 import com.android.car.developeroptions.core.SliderPreferenceController; 51 import com.android.car.developeroptions.core.SubSettingLauncher; 52 import com.android.car.developeroptions.core.TogglePreferenceController; 53 import com.android.car.developeroptions.overlay.FeatureFactory; 54 import com.android.settingslib.core.AbstractPreferenceController; 55 56 import java.util.Arrays; 57 import java.util.List; 58 import java.util.Set; 59 import java.util.stream.Collectors; 60 61 62 /** 63 * Utility class to build Slices objects and Preference Controllers based on the Database managed 64 * by {@link SlicesDatabaseHelper} 65 */ 66 public class SliceBuilderUtils { 67 68 private static final String TAG = "SliceBuilder"; 69 70 /** 71 * Build a Slice from {@link SliceData}. 72 * 73 * @return a {@link Slice} based on the data provided by {@param sliceData}. 74 * Will build an {@link Intent} based Slice unless the Preference Controller name in 75 * {@param sliceData} is an inline controller. 76 */ buildSlice(Context context, SliceData sliceData)77 public static Slice buildSlice(Context context, SliceData sliceData) { 78 Log.d(TAG, "Creating slice for: " + sliceData.getPreferenceController()); 79 final BasePreferenceController controller = getPreferenceController(context, sliceData); 80 FeatureFactory.getFactory(context).getMetricsFeatureProvider() 81 .action(SettingsEnums.PAGE_UNKNOWN, 82 SettingsEnums.ACTION_SETTINGS_SLICE_REQUESTED, 83 SettingsEnums.PAGE_UNKNOWN, 84 sliceData.getKey(), 85 0); 86 87 if (!controller.isAvailable()) { 88 // Cannot guarantee setting page is accessible, let the presenter handle error case. 89 return null; 90 } 91 92 if (controller.getAvailabilityStatus() == DISABLED_DEPENDENT_SETTING) { 93 return buildUnavailableSlice(context, sliceData); 94 } 95 96 if (controller.isCopyableSlice()) { 97 return buildCopyableSlice(context, sliceData, controller); 98 } 99 100 switch (sliceData.getSliceType()) { 101 case SliceData.SliceType.INTENT: 102 return buildIntentSlice(context, sliceData, controller); 103 case SliceData.SliceType.SWITCH: 104 return buildToggleSlice(context, sliceData, controller); 105 case SliceData.SliceType.SLIDER: 106 return buildSliderSlice(context, sliceData, controller); 107 default: 108 throw new IllegalArgumentException( 109 "Slice type passed was invalid: " + sliceData.getSliceType()); 110 } 111 } 112 113 /** 114 * @return the {@link SliceData.SliceType} for the {@param controllerClassName} and key. 115 */ 116 @SliceData.SliceType getSliceType(Context context, String controllerClassName, String controllerKey)117 public static int getSliceType(Context context, String controllerClassName, 118 String controllerKey) { 119 BasePreferenceController controller = getPreferenceController(context, controllerClassName, 120 controllerKey); 121 return controller.getSliceType(); 122 } 123 124 /** 125 * Splits the Settings Slice Uri path into its two expected components: 126 * - intent/action 127 * - key 128 * <p> 129 * Examples of valid paths are: 130 * - /intent/wifi 131 * - /intent/bluetooth 132 * - /action/wifi 133 * - /action/accessibility/servicename 134 * 135 * @param uri of the Slice. Follows pattern outlined in {@link SettingsSliceProvider}. 136 * @return Pair whose first element {@code true} if the path is prepended with "intent", and 137 * second is a key. 138 */ getPathData(Uri uri)139 public static Pair<Boolean, String> getPathData(Uri uri) { 140 final String path = uri.getPath(); 141 final String[] split = path.split("/", 3); 142 143 // Split should be: [{}, SLICE_TYPE, KEY]. 144 // Example: "/action/wifi" -> [{}, "action", "wifi"] 145 // "/action/longer/path" -> [{}, "action", "longer/path"] 146 if (split.length != 3) { 147 return null; 148 } 149 150 final boolean isIntent = TextUtils.equals(SettingsSlicesContract.PATH_SETTING_INTENT, 151 split[1]); 152 153 return new Pair<>(isIntent, split[2]); 154 } 155 156 /** 157 * Looks at the controller classname in in {@link SliceData} from {@param sliceData} 158 * and attempts to build an {@link AbstractPreferenceController}. 159 */ getPreferenceController(Context context, SliceData sliceData)160 public static BasePreferenceController getPreferenceController(Context context, 161 SliceData sliceData) { 162 return getPreferenceController(context, sliceData.getPreferenceController(), 163 sliceData.getKey()); 164 } 165 166 /** 167 * @return {@link PendingIntent} for a non-primary {@link SliceAction}. 168 */ getActionIntent(Context context, String action, SliceData data)169 public static PendingIntent getActionIntent(Context context, String action, SliceData data) { 170 final Intent intent = new Intent(action) 171 .setData(data.getUri()) 172 .setClass(context, SliceBroadcastReceiver.class) 173 .putExtra(EXTRA_SLICE_KEY, data.getKey()) 174 .putExtra(EXTRA_SLICE_PLATFORM_DEFINED, data.isPlatformDefined()); 175 return PendingIntent.getBroadcast(context, 0 /* requestCode */, intent, 176 PendingIntent.FLAG_CANCEL_CURRENT); 177 } 178 179 /** 180 * @return {@link PendingIntent} for the primary {@link SliceAction}. 181 */ getContentPendingIntent(Context context, SliceData sliceData)182 public static PendingIntent getContentPendingIntent(Context context, SliceData sliceData) { 183 final Intent intent = getContentIntent(context, sliceData); 184 return PendingIntent.getActivity(context, 0 /* requestCode */, intent, 0 /* flags */); 185 } 186 187 /** 188 * @return the summary text for a {@link Slice} built for {@param sliceData}. 189 */ getSubtitleText(Context context, BasePreferenceController controller, SliceData sliceData)190 public static CharSequence getSubtitleText(Context context, 191 BasePreferenceController controller, SliceData sliceData) { 192 final boolean isDynamicSummaryAllowed = controller.useDynamicSliceSummary(); 193 CharSequence summaryText = controller.getSummary(); 194 195 // Priority 1 : User prefers showing the dynamic summary in slice view rather than static 196 // summary. Note it doesn't require a valid summary - so we can force some slices to have 197 // empty summaries (ex: volume). 198 if (isDynamicSummaryAllowed) { 199 return summaryText; 200 } 201 202 // Priority 2 : Show screen title. 203 summaryText = sliceData.getScreenTitle(); 204 if (isValidSummary(context, summaryText) && !TextUtils.equals(summaryText, 205 sliceData.getTitle())) { 206 return summaryText; 207 } 208 209 // Priority 3 : Show dynamic summary from preference controller. 210 if (controller != null) { 211 summaryText = controller.getSummary(); 212 213 if (isValidSummary(context, summaryText)) { 214 return summaryText; 215 } 216 } 217 218 // Priority 4 : Show summary from slice data. 219 summaryText = sliceData.getSummary(); 220 if (isValidSummary(context, summaryText)) { 221 return summaryText; 222 } 223 224 // Priority 5 : Show empty text. 225 return ""; 226 } 227 getUri(String path, boolean isPlatformSlice)228 public static Uri getUri(String path, boolean isPlatformSlice) { 229 final String authority = isPlatformSlice 230 ? SettingsSlicesContract.AUTHORITY 231 : SettingsSliceProvider.SLICE_AUTHORITY; 232 return new Uri.Builder() 233 .scheme(ContentResolver.SCHEME_CONTENT) 234 .authority(authority) 235 .appendPath(path) 236 .build(); 237 } 238 buildSearchResultPageIntent(Context context, String className, String key, String screenTitle, int sourceMetricsCategory)239 public static Intent buildSearchResultPageIntent(Context context, String className, String key, 240 String screenTitle, int sourceMetricsCategory) { 241 final Bundle args = new Bundle(); 242 args.putString(SettingsActivity.EXTRA_FRAGMENT_ARG_KEY, key); 243 final Intent searchDestination = new SubSettingLauncher(context) 244 .setDestination(className) 245 .setArguments(args) 246 .setTitleText(screenTitle) 247 .setSourceMetricsCategory(sourceMetricsCategory) 248 .toIntent(); 249 searchDestination.putExtra(SettingsActivity.EXTRA_FRAGMENT_ARG_KEY, key) 250 .setAction("com.android.car.developeroptions.SEARCH_RESULT_TRAMPOLINE") 251 .setComponent(null); 252 return searchDestination; 253 } 254 getContentIntent(Context context, SliceData sliceData)255 public static Intent getContentIntent(Context context, SliceData sliceData) { 256 final Uri contentUri = new Uri.Builder().appendPath(sliceData.getKey()).build(); 257 final Intent intent = buildSearchResultPageIntent(context, 258 sliceData.getFragmentClassName(), sliceData.getKey(), 259 sliceData.getScreenTitle().toString(), 0 /* TODO */); 260 intent.setClassName(context.getPackageName(), SubSettings.class.getName()); 261 intent.setData(contentUri); 262 return intent; 263 } 264 buildToggleSlice(Context context, SliceData sliceData, BasePreferenceController controller)265 private static Slice buildToggleSlice(Context context, SliceData sliceData, 266 BasePreferenceController controller) { 267 final PendingIntent contentIntent = getContentPendingIntent(context, sliceData); 268 final IconCompat icon = getSafeIcon(context, sliceData); 269 final CharSequence subtitleText = getSubtitleText(context, controller, sliceData); 270 @ColorInt final int color = Utils.getColorAccentDefaultColor(context); 271 final TogglePreferenceController toggleController = 272 (TogglePreferenceController) controller; 273 final SliceAction sliceAction = getToggleAction(context, sliceData, 274 toggleController.isChecked()); 275 final Set<String> keywords = buildSliceKeywords(sliceData); 276 277 return new ListBuilder(context, sliceData.getUri(), ListBuilder.INFINITY) 278 .setAccentColor(color) 279 .addRow(new RowBuilder() 280 .setTitle(sliceData.getTitle()) 281 .setSubtitle(subtitleText) 282 .setPrimaryAction( 283 SliceAction.createDeeplink(contentIntent, icon, 284 ListBuilder.ICON_IMAGE, sliceData.getTitle())) 285 .addEndItem(sliceAction)) 286 .setKeywords(keywords) 287 .build(); 288 } 289 buildIntentSlice(Context context, SliceData sliceData, BasePreferenceController controller)290 private static Slice buildIntentSlice(Context context, SliceData sliceData, 291 BasePreferenceController controller) { 292 final PendingIntent contentIntent = getContentPendingIntent(context, sliceData); 293 final IconCompat icon = getSafeIcon(context, sliceData); 294 final CharSequence subtitleText = getSubtitleText(context, controller, sliceData); 295 @ColorInt final int color = Utils.getColorAccentDefaultColor(context); 296 final Set<String> keywords = buildSliceKeywords(sliceData); 297 298 return new ListBuilder(context, sliceData.getUri(), ListBuilder.INFINITY) 299 .setAccentColor(color) 300 .addRow(new RowBuilder() 301 .setTitle(sliceData.getTitle()) 302 .setSubtitle(subtitleText) 303 .setPrimaryAction( 304 SliceAction.createDeeplink(contentIntent, icon, 305 ListBuilder.ICON_IMAGE, 306 sliceData.getTitle()))) 307 .setKeywords(keywords) 308 .build(); 309 } 310 buildSliderSlice(Context context, SliceData sliceData, BasePreferenceController controller)311 private static Slice buildSliderSlice(Context context, SliceData sliceData, 312 BasePreferenceController controller) { 313 final SliderPreferenceController sliderController = (SliderPreferenceController) controller; 314 final PendingIntent actionIntent = getSliderAction(context, sliceData); 315 final PendingIntent contentIntent = getContentPendingIntent(context, sliceData); 316 final IconCompat icon = getSafeIcon(context, sliceData); 317 @ColorInt final int color = Utils.getColorAccentDefaultColor(context); 318 final CharSequence subtitleText = getSubtitleText(context, controller, sliceData); 319 final SliceAction primaryAction = SliceAction.createDeeplink(contentIntent, icon, 320 ListBuilder.ICON_IMAGE, sliceData.getTitle()); 321 final Set<String> keywords = buildSliceKeywords(sliceData); 322 323 return new ListBuilder(context, sliceData.getUri(), ListBuilder.INFINITY) 324 .setAccentColor(color) 325 .addInputRange(new InputRangeBuilder() 326 .setTitle(sliceData.getTitle()) 327 .setSubtitle(subtitleText) 328 .setPrimaryAction(primaryAction) 329 .setMax(sliderController.getMaxSteps()) 330 .setValue(sliderController.getSliderPosition()) 331 .setInputAction(actionIntent)) 332 .setKeywords(keywords) 333 .build(); 334 } 335 buildCopyableSlice(Context context, SliceData sliceData, BasePreferenceController controller)336 private static Slice buildCopyableSlice(Context context, SliceData sliceData, 337 BasePreferenceController controller) { 338 final SliceAction copyableAction = getCopyableAction(context, sliceData); 339 final PendingIntent contentIntent = getContentPendingIntent(context, sliceData); 340 final IconCompat icon = getSafeIcon(context, sliceData); 341 final SliceAction primaryAction = SliceAction.createDeeplink(contentIntent, icon, 342 ListBuilder.ICON_IMAGE, 343 sliceData.getTitle()); 344 final CharSequence subtitleText = getSubtitleText(context, controller, sliceData); 345 @ColorInt final int color = Utils.getColorAccentDefaultColor(context); 346 final Set<String> keywords = buildSliceKeywords(sliceData); 347 348 return new ListBuilder(context, sliceData.getUri(), ListBuilder.INFINITY) 349 .setAccentColor(color) 350 .addRow(new RowBuilder() 351 .setTitle(sliceData.getTitle()) 352 .setSubtitle(subtitleText) 353 .setPrimaryAction(primaryAction) 354 .addEndItem(copyableAction)) 355 .setKeywords(keywords) 356 .build(); 357 } 358 getPreferenceController(Context context, String controllerClassName, String controllerKey)359 private static BasePreferenceController getPreferenceController(Context context, 360 String controllerClassName, String controllerKey) { 361 try { 362 return BasePreferenceController.createInstance(context, controllerClassName); 363 } catch (IllegalStateException e) { 364 // Do nothing 365 } 366 367 return BasePreferenceController.createInstance(context, controllerClassName, controllerKey); 368 } 369 getToggleAction(Context context, SliceData sliceData, boolean isChecked)370 private static SliceAction getToggleAction(Context context, SliceData sliceData, 371 boolean isChecked) { 372 PendingIntent actionIntent = getActionIntent(context, 373 SettingsSliceProvider.ACTION_TOGGLE_CHANGED, sliceData); 374 return SliceAction.createToggle(actionIntent, null, isChecked); 375 } 376 getSliderAction(Context context, SliceData sliceData)377 private static PendingIntent getSliderAction(Context context, SliceData sliceData) { 378 return getActionIntent(context, SettingsSliceProvider.ACTION_SLIDER_CHANGED, sliceData); 379 } 380 getCopyableAction(Context context, SliceData sliceData)381 private static SliceAction getCopyableAction(Context context, SliceData sliceData) { 382 final PendingIntent intent = getActionIntent(context, 383 SettingsSliceProvider.ACTION_COPY, sliceData); 384 final IconCompat icon = IconCompat.createWithResource(context, 385 R.drawable.ic_content_copy_grey600_24dp); 386 return SliceAction.create(intent, icon, ListBuilder.ICON_IMAGE, sliceData.getTitle()); 387 } 388 isValidSummary(Context context, CharSequence summary)389 private static boolean isValidSummary(Context context, CharSequence summary) { 390 if (summary == null || TextUtils.isEmpty(summary.toString().trim())) { 391 return false; 392 } 393 394 final CharSequence placeHolder = context.getText(R.string.summary_placeholder); 395 final CharSequence doublePlaceHolder = 396 context.getText(R.string.summary_two_lines_placeholder); 397 398 return !(TextUtils.equals(summary, placeHolder) 399 || TextUtils.equals(summary, doublePlaceHolder)); 400 } 401 buildSliceKeywords(SliceData data)402 private static Set<String> buildSliceKeywords(SliceData data) { 403 final Set<String> keywords = new ArraySet<>(); 404 405 keywords.add(data.getTitle()); 406 407 if (!TextUtils.equals(data.getTitle(), data.getScreenTitle())) { 408 keywords.add(data.getScreenTitle().toString()); 409 } 410 411 final String keywordString = data.getKeywords(); 412 if (keywordString != null) { 413 final String[] keywordArray = keywordString.split(","); 414 final List<String> strippedKeywords = Arrays.stream(keywordArray) 415 .map(s -> s = s.trim()) 416 .collect(Collectors.toList()); 417 keywords.addAll(strippedKeywords); 418 } 419 420 return keywords; 421 } 422 buildUnavailableSlice(Context context, SliceData data)423 private static Slice buildUnavailableSlice(Context context, SliceData data) { 424 final String title = data.getTitle(); 425 final Set<String> keywords = buildSliceKeywords(data); 426 @ColorInt final int color = Utils.getColorAccentDefaultColor(context); 427 428 final String customSubtitle = data.getUnavailableSliceSubtitle(); 429 final CharSequence subtitle = !TextUtils.isEmpty(customSubtitle) ? customSubtitle 430 : context.getText(R.string.disabled_dependent_setting_summary); 431 final IconCompat icon = getSafeIcon(context, data); 432 final SliceAction primaryAction = SliceAction.createDeeplink( 433 getContentPendingIntent(context, data), 434 icon, ListBuilder.ICON_IMAGE, title); 435 436 return new ListBuilder(context, data.getUri(), ListBuilder.INFINITY) 437 .setAccentColor(color) 438 .addRow(new RowBuilder() 439 .setTitle(title) 440 .setTitleItem(icon, ListBuilder.ICON_IMAGE) 441 .setSubtitle(subtitle) 442 .setPrimaryAction(primaryAction)) 443 .setKeywords(keywords) 444 .build(); 445 } 446 447 @VisibleForTesting getSafeIcon(Context context, SliceData data)448 static IconCompat getSafeIcon(Context context, SliceData data) { 449 int iconResource = data.getIconResource(); 450 451 if (iconResource == 0) { 452 iconResource = R.drawable.ic_settings_accent; 453 } 454 try { 455 return IconCompat.createWithResource(context, iconResource); 456 } catch (Exception e) { 457 Log.w(TAG, "Falling back to settings icon because there is an error getting slice icon " 458 + data.getUri(), e); 459 return IconCompat.createWithResource(context, R.drawable.ic_settings_accent); 460 } 461 } 462 } 463