// Copyright 2014 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.components.webapps;
import android.content.Context;
import android.text.TextUtils;
import androidx.annotation.StringRes;
import androidx.annotation.VisibleForTesting;
import org.jni_zero.CalledByNative;
import org.jni_zero.JNINamespace;
import org.jni_zero.NativeMethods;
import org.chromium.base.ContextUtils;
import org.chromium.base.PackageUtils;
import org.chromium.base.ThreadUtils;
import org.chromium.content_public.browser.WebContents;
/**
* Manages an AppBannerInfoBar for a WebContents.
*
* <p>The AppBannerManager is responsible for fetching details about native apps to display in the
* banner. The actual observation of the WebContents (which triggers the automatic creation and
* removal of banners, among other things) is done by the native-side AppBannerManagerAndroid.
*/
@JNINamespace("webapps")
public class AppBannerManager {
/**
* A struct containing the string resources IDs for the strings to show in the install dialog
* (both the dialog title and the accept button).
*/
public static class InstallStringPair {
public final @StringRes int titleTextId;
public final @StringRes int buttonTextId;
public InstallStringPair(@StringRes int titleText, @StringRes int buttonText) {
titleTextId = titleText;
buttonTextId = buttonText;
}
}
public static final InstallStringPair PWA_PAIR =
new InstallStringPair(R.string.menu_install_webapp, R.string.app_banner_install);
public static final InstallStringPair NON_PWA_PAIR =
new InstallStringPair(R.string.menu_add_to_homescreen, R.string.add);
/** Retrieves information about a given package. */
private static AppDetailsDelegate sAppDetailsDelegate;
/** Pointer to the native side AppBannerManager. */
private long mNativePointer;
/** Whether add to home screen is permitted by the system. */
private static Boolean sIsSupported;
/**
* Checks if the add to home screen intent is supported.
*
* @return true if add to home screen is supported, false otherwise.
*/
@CalledByNative
private static boolean isSupported() {
if (sIsSupported == null) {
sIsSupported = WebappsUtils.isAddToHomeIntentSupported();
}
return sIsSupported;
}
/** Overrides whether the system supports add to home screen. Used in testing. */
@VisibleForTesting
public static void setIsSupported(boolean state) {
sIsSupported = state;
}
/**
* Sets the delegate that provides information about a given package.
*
* @param delegate Delegate to use. Previously set ones are destroyed.
*/
public static void setAppDetailsDelegate(AppDetailsDelegate delegate) {
if (sAppDetailsDelegate != null) sAppDetailsDelegate.destroy();
sAppDetailsDelegate = delegate;
}
/**
* Constructs an AppBannerManager.
*
* @param nativePointer the native-side object that owns this AppBannerManager.
*/
private AppBannerManager(long nativePointer) {
mNativePointer = nativePointer;
}
@CalledByNative
private static AppBannerManager create(long nativePointer) {
return new AppBannerManager(nativePointer);
}
@CalledByNative
private void destroy() {
mNativePointer = 0;
}
/**
* Grabs package information for the banner asynchronously.
*
* @param url URL for the page that is triggering the banner.
* @param packageName Name of the package that is being advertised.
*/
@CalledByNative
private void fetchAppDetails(
int requestId, String url, String packageName, String referrer, int iconSizeInDp) {
if (sAppDetailsDelegate == null) return;
Context context = ContextUtils.getApplicationContext();
int iconSizeInPx =
Math.round(context.getResources().getDisplayMetrics().density * iconSizeInDp);
sAppDetailsDelegate.getAppDetailsAsynchronously(
createAppDetailsObserver(requestId), url, packageName, referrer, iconSizeInPx);
}
@CalledByNative
private static boolean isRelatedNonWebAppInstalled(String packageName) {
return PackageUtils.isPackageInstalled(packageName);
}
private AppDetailsDelegate.Observer createAppDetailsObserver(int requestId) {
return new AppDetailsDelegate.Observer() {
/**
* Called when data about the package has been retrieved, which includes the url for the
* app's icon but not the icon Bitmap itself.
*
* @param data Data about the app. Null if the task failed.
*/
@Override
public void onAppDetailsRetrieved(AppData data) {
if (data == null || mNativePointer == 0) return;
String imageUrl = data.imageUrl();
if (TextUtils.isEmpty(imageUrl)) return;
AppBannerManagerJni.get()
.onAppDetailsRetrieved(
mNativePointer,
AppBannerManager.this,
requestId,
data,
data.title(),
data.packageName(),
data.imageUrl());
}
};
}
/**
* Returns the manifest id if the current page is installable, otherwise returns the empty
* string.
*/
public static String maybeGetManifestId(WebContents webContents) {
AppBannerManager manager =
webContents != null ? AppBannerManager.forWebContents(webContents) : null;
if (manager != null) {
return manager.getManifestId(webContents);
}
return null;
}
/** Sets the app-banner-showing logic to ignore the Chrome channel. */
public static void ignoreChromeChannelForTesting() {
AppBannerManagerJni.get().ignoreChromeChannelForTesting();
}
/** Returns whether the native AppBannerManager is working. */
public boolean isRunningForTesting() {
return AppBannerManagerJni.get().isRunningForTesting(mNativePointer, AppBannerManager.this);
}
/** Returns the state of the current pipeline. */
public int getPipelineStatusForTesting() {
return AppBannerManagerJni.get().getPipelineStatusForTesting(mNativePointer);
}
/** Returns the state of the ambient badge. */
public int getBadgeStatusForTesting() {
return AppBannerManagerJni.get().getBadgeStatusForTesting(mNativePointer);
}
/** Sets constants (in days) the banner should be blocked for after dismissing and ignoring. */
public static void setDaysAfterDismissAndIgnoreForTesting(int dismissDays, int ignoreDays) {
AppBannerManagerJni.get().setDaysAfterDismissAndIgnoreToTrigger(dismissDays, ignoreDays);
}
/** Sets a constant (in days) that gets added to the time when the current time is requested. */
public static void setTimeDeltaForTesting(int days) {
AppBannerManagerJni.get().setTimeDeltaForTesting(days);
}
/** Sets the total required engagement to trigger the banner. */
public static void setTotalEngagementForTesting(double engagement) {
AppBannerManagerJni.get().setTotalEngagementToTrigger(engagement);
}
/** Sets the install promo result from segmentation service for testing purpose. */
public static void setOverrideSegmentationResultForTesting(boolean show) {
AppBannerManagerJni.get().setOverrideSegmentationResultForTesting(show);
}
/** Returns the AppBannerManager object. This is owned by the C++ banner manager. */
public static AppBannerManager forWebContents(WebContents contents) {
ThreadUtils.assertOnUiThread();
return AppBannerManagerJni.get().getJavaBannerManagerForWebContents(contents);
}
public String getManifestId(WebContents contents) {
return AppBannerManagerJni.get().getInstallableWebAppManifestId(contents);
}
@NativeMethods
public interface Natives {
AppBannerManager getJavaBannerManagerForWebContents(WebContents webContents);
String getInstallableWebAppManifestId(WebContents webContents);
void onAppDetailsRetrieved(
long nativeAppBannerManagerAndroid,
AppBannerManager caller,
int requestId,
AppData data,
String title,
String packageName,
String imageUrl);
// Testing methods.
void ignoreChromeChannelForTesting();
boolean isRunningForTesting(long nativeAppBannerManagerAndroid, AppBannerManager caller);
int getPipelineStatusForTesting(long nativeAppBannerManagerAndroid);
int getBadgeStatusForTesting(long nativeAppBannerManagerAndroid);
void setDaysAfterDismissAndIgnoreToTrigger(int dismissDays, int ignoreDays);
void setTimeDeltaForTesting(int days);
void setTotalEngagementToTrigger(double engagement);
void setOverrideSegmentationResultForTesting(boolean show);
}
}
Codebase Browser
chromium