-
Notifications
You must be signed in to change notification settings - Fork 6.6k
/
BrowserServicesIntentDataProvider.java
540 lines (468 loc) · 14.9 KB
/
BrowserServicesIntentDataProvider.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
// Copyright 2019 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
package org.chromium.chrome.browser.browserservices.intents;
import static androidx.browser.customtabs.CustomTabsIntent.CLOSE_BUTTON_POSITION_DEFAULT;
import android.app.PendingIntent;
import android.content.ComponentName;
import android.content.Intent;
import android.graphics.drawable.Drawable;
import android.widget.RemoteViews;
import androidx.annotation.IntDef;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.Px;
import androidx.browser.customtabs.CustomTabsIntent;
import androidx.browser.customtabs.CustomTabsIntent.CloseButtonPosition;
import androidx.browser.customtabs.CustomTabsSessionToken;
import androidx.browser.trusted.TrustedWebActivityDisplayMode;
import androidx.browser.trusted.sharing.ShareData;
import androidx.browser.trusted.sharing.ShareTarget;
import org.chromium.chrome.browser.flags.ActivityType;
import org.chromium.device.mojom.ScreenOrientationLockType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.util.Collections;
import java.util.List;
/**
* Base class for model classes which parse incoming intent for customization data.
*/
public abstract class BrowserServicesIntentDataProvider {
// The type of UI for Custom Tab to use.
@IntDef({CustomTabsUiType.DEFAULT, CustomTabsUiType.MEDIA_VIEWER, CustomTabsUiType.INFO_PAGE,
CustomTabsUiType.READER_MODE, CustomTabsUiType.MINIMAL_UI_WEBAPP,
CustomTabsUiType.OFFLINE_PAGE})
@Retention(RetentionPolicy.SOURCE)
public @interface CustomTabsUiType {
int DEFAULT = 0;
int MEDIA_VIEWER = 1;
int INFO_PAGE = 2;
int READER_MODE = 3;
int MINIMAL_UI_WEBAPP = 4;
int OFFLINE_PAGE = 5;
int READ_LATER = 6;
}
// The type of Disclosure for TWAs to use.
@IntDef({TwaDisclosureUi.DEFAULT, TwaDisclosureUi.V1_INFOBAR,
TwaDisclosureUi.V2_NOTIFICATION_OR_SNACKBAR})
@Retention(RetentionPolicy.SOURCE)
public @interface TwaDisclosureUi {
int DEFAULT = -1;
int V1_INFOBAR = 0;
int V2_NOTIFICATION_OR_SNACKBAR = 1;
}
@IntDef({ACTIVITY_HEIGHT_DEFAULT, ACTIVITY_HEIGHT_ADJUSTABLE, ACTIVITY_HEIGHT_FIXED})
@Retention(RetentionPolicy.SOURCE)
public @interface ActivityHeightResizeBehavior {}
/**
* Applies the default height resize behavior for the Custom Tab Activity when it behaves as a
* bottom sheet. Same as {@link #ACTIVITY_HEIGHT_ADJUSTABLE}.
*/
public static final int ACTIVITY_HEIGHT_DEFAULT = 0;
/**
* The Custom Tab Activity, when it behaves as a bottom sheet, can have its height manually
* resized by the user.
*/
public static final int ACTIVITY_HEIGHT_ADJUSTABLE = 1;
/**
* The Custom Tab Activity, when it behaves as a bottom sheet, cannot have its height manually
* resized by the user.
*/
public static final int ACTIVITY_HEIGHT_FIXED = 2;
/**
* @return The type of the Activity;
*/
public abstract @ActivityType int getActivityType();
/**
* @return the Intent this instance was created with.
*/
@Nullable
public Intent getIntent() {
return null;
}
/**
* @return The session specified in the intent, or null.
*/
@Nullable
public CustomTabsSessionToken getSession() {
return null;
}
/**
* @return The keep alive service intent specified in the intent, or null.
*/
@Nullable
public Intent getKeepAliveServiceIntent() {
return null;
}
/**
* @return Whether chrome should animate when it finishes. We show animations only if the client
* app has supplied the correct animation resources via intent extra.
*/
public boolean shouldAnimateOnFinish() {
return false;
}
/**
* @return The package name of the client app. This is used for a workaround in order to
* retrieve the client's animation resources.
*/
@Nullable
public String getClientPackageName() {
return null;
}
/**
* @return The resource id for enter animation, which is used in
* {@link Activity#overridePendingTransition(int, int)}.
*/
public int getAnimationEnterRes() {
return 0;
}
/**
* @return The resource id for exit animation, which is used in
* {@link Activity#overridePendingTransition(int, int)}.
*/
public int getAnimationExitRes() {
return 0;
}
/**
* Checks whether or not the Intent is from Chrome or other trusted first party.
*
* @deprecated This method is not reliable, see https://crbug.com/832124
*/
@Deprecated
public boolean isTrustedIntent() {
return false;
}
/**
* @return The URL that should be used from this intent.
* Must be called only after native has loaded.
*/
@Nullable
public String getUrlToLoad() {
return null;
}
/**
* @return Whether url bar hiding should be enabled in the custom tab.
*/
public boolean shouldEnableUrlBarHiding() {
return true;
}
@NonNull
public abstract ColorProvider getColorProvider();
/**
* @return The drawable of the icon of close button shown in the custom tab toolbar.
*/
@Nullable
public Drawable getCloseButtonDrawable() {
return null;
}
/**
* @return The title visibility state for the toolbar.
*/
public int getTitleVisibilityState() {
return CustomTabsIntent.NO_TITLE;
}
/**
* @return Whether the default share item should be shown in the menu.
*/
public boolean shouldShowShareMenuItem() {
return false;
}
/**
* @return The params for the custom buttons that show on the toolbar.
*/
public List<CustomButtonParams> getCustomButtonsOnToolbar() {
return Collections.emptyList();
}
/**
* @return The list of params representing the buttons on the bottombar.
*/
public List<CustomButtonParams> getCustomButtonsOnBottombar() {
return Collections.emptyList();
}
/**
* @return The {@link RemoteViews} to show on the bottom bar, or null if the extra is not
* specified.
*/
@Nullable
public RemoteViews getBottomBarRemoteViews() {
return null;
}
/**
* @return A array of {@link View} ids, of which the onClick event is handled by the Activity.
*/
@Nullable
public int[] getClickableViewIDs() {
return null;
}
/**
* @return The {@link PendingIntent} that is sent when the user clicks on the remote view.
*/
@Nullable
public PendingIntent getRemoteViewsPendingIntent() {
return null;
}
/**
* Gets params for all custom buttons, which is the combination of
* {@link #getCustomButtonsOnBottombar()} and {@link #getCustomButtonsOnToolbar()}.
*/
public List<CustomButtonParams> getAllCustomButtons() {
return Collections.emptyList();
}
/**
@return Titles of menu items that were passed from client app via intent.
*/
public List<String> getMenuTitles() {
return Collections.emptyList();
}
/**
* @return Whether or not the Activity is being launched by an intent fired by Chrome itself.
*/
public boolean isOpenedByChrome() {
return false;
}
@CustomTabsUiType
public int getUiType() {
return CustomTabsUiType.DEFAULT;
}
/**
* @return URL that should be loaded in place of the URL in {@link Intent#getData()}.
*/
@Nullable
public String getMediaViewerUrl() {
return null;
}
/**
* @return Whether to enable the embedded media experience.
*/
public boolean shouldEnableEmbeddedMediaExperience() {
return false;
}
public boolean isFromMediaLauncherActivity() {
return false;
}
/**
* @return Whether there should be a star button in the menu.
*/
public boolean shouldShowStarButton() {
return true;
}
/**
* @return Whether there should be a download button in the menu.
*/
public boolean shouldShowDownloadButton() {
return true;
}
/**
* @return Whether the Activity should be opened in incognito mode.
*/
public boolean isIncognito() {
return false;
}
/**
* @return Whether the Activity should attempt to display a Trusted Web Activity.
*/
public final boolean isTrustedWebActivity() {
return getActivityType() == ActivityType.TRUSTED_WEB_ACTIVITY;
}
/**
* @return Whether the Activity is either a Webapp or a WebAPK activity.
*/
public final boolean isWebappOrWebApkActivity() {
return getActivityType() == ActivityType.WEBAPP
|| getActivityType() == ActivityType.WEB_APK;
}
/**
* @return Whether the Activity is a WebAPK activity.
*/
public final boolean isWebApkActivity() {
return getActivityType() == ActivityType.WEB_APK;
}
/**
* Returns {@link TrustedWebActivityDisplayMode} supplied in the intent.
*/
@Nullable
public TrustedWebActivityDisplayMode getTwaDisplayMode() {
return null;
}
/**
* Returns {@link ScreenOrientationLockType} supplied in the intent.
*/
public int getDefaultOrientation() {
return ScreenOrientationLockType.DEFAULT;
}
/**
* @return The component name of the module entry point, or null if not specified.
*/
@Nullable
public ComponentName getModuleComponentName() {
return null;
}
/**
* @return The resource identifier for the dex that contains module code. {@code 0} if no dex
* resource is provided.
*/
@Nullable
public String getModuleDexAssetName() {
return null;
}
/**
* @return Additional origins associated with a Trusted Web Activity client app.
*/
@Nullable
public List<String> getTrustedWebActivityAdditionalOrigins() {
return null;
}
/**
* @return ISO 639 code of target language the page should be translated to.
* This method requires native.
*/
@Nullable
public String getTranslateLanguage() {
return null;
}
/**
* @return Whether or not the page should be automatically translated into the target language
* indicated by {@link getTranslateLanguage()}.
*/
public boolean shouldAutoTranslate() {
return false;
}
/**
* Returns {@link ShareTarget} describing the share target, or null if there is no associated
* share target.
*/
@Nullable
public ShareTarget getShareTarget() {
return null;
}
/**
* Returns {@link ShareData} if there is data to be shared, and null otherwise.
*/
@Nullable
public ShareData getShareData() {
return null;
}
/**
* Returns {@link WebappExtras} if the intent targets a webapp, and null otherwise.
*/
@Nullable
public WebappExtras getWebappExtras() {
return null;
}
/**
* Returns {@link WebApkExtras} if the intent targets a WebAPK, and null otherwise.
*/
@Nullable
public WebApkExtras getWebApkExtras() {
return null;
}
/**
* @return Whether the bottom bar should be shown.
*/
public final boolean shouldShowBottomBar() {
return !getCustomButtonsOnBottombar().isEmpty() || getBottomBarRemoteViews() != null;
}
/**
* Searches for the toolbar button with the given {@code id} and returns its index.
* @param id The ID of a toolbar button to search for.
* @return The index of the toolbar button with the given {@code id}, or -1 if no such button
* can be found.
*/
public final int getCustomToolbarButtonIndexForId(int id) {
List<CustomButtonParams> toolbarButtons = getCustomButtonsOnToolbar();
for (int i = 0; i < toolbarButtons.size(); i++) {
if (toolbarButtons.get(i).getId() == id) return i;
}
return -1;
}
/**
* @return The {@link CustomButtonParams} (either on the toolbar or bottom bar) with the given
* {@code id}, or null if no such button can be found.
*/
@Nullable
public final CustomButtonParams getButtonParamsForId(int id) {
List<CustomButtonParams> customButtonParams = getAllCustomButtons();
for (CustomButtonParams params : customButtonParams) {
// A custom button params will always carry an ID. If the client calls updateVisuals()
// without an id, we will assign the toolbar action button id to it.
if (id == params.getId()) return params;
}
return null;
}
/**
* @return See {@link #getUiType()}.
*/
public final boolean isMediaViewer() {
return getUiType() == CustomTabsUiType.MEDIA_VIEWER;
}
/**
* @return If the Activity is an info page.
*/
public final boolean isInfoPage() {
return getUiType() == CustomTabsUiType.INFO_PAGE;
}
@TwaDisclosureUi
public int getTwaDisclosureUi() {
return TwaDisclosureUi.DEFAULT;
}
@Nullable
public int[] getGsaExperimentIds() {
return null;
}
/**
* @return Whether the intent is for partial custom tabs bottom sheet.
*/
public boolean isPartialHeightCustomTab() {
return false;
}
/**
* @return Whether the intent is for partial custom tabs side sheet.
*/
public boolean isPartialWidthCustomTab() {
return false;
}
/**
* @return The value in pixels of the initial height of the Activity. It will return 0 if there
* is no value set.
*/
public @Px int getInitialActivityHeight() {
return 0;
}
/**
* @return The value in pixels of the initial width of the Activity. It will return 0 if there
* is no value set.
*/
public @Px int getInitialActivityWidth() {
return 0;
}
/**
* Returns the {@link CloseButtonPosition}.
*/
public @CloseButtonPosition int getCloseButtonPosition() {
return CLOSE_BUTTON_POSITION_DEFAULT;
}
/**
* If {@code true} the App Menu will not be shown. If {@code false} it will be left to the
* Activity to decide.
*/
public boolean shouldSuppressAppMenu() {
return false;
}
/**
* Returns the partial custom tab toolbar corner radius.
*/
public @Px int getPartialTabToolbarCornerRadius() {
return 0;
}
/**
* Returns false as by default PCCT is resizable.
*/
public boolean isPartialCustomTabFixedHeight() {
return false;
}
/**
* @return true, as by default having a PCCT launched still allows interaction with the
* background application
*/
public boolean canInteractWithBackground() { return false; }
}