| // Copyright 2018 The Chromium Authors. All rights reserved. |
| // 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.toolbar; |
| |
| import android.support.annotation.Nullable; |
| import android.support.annotation.StringRes; |
| import android.text.TextUtils; |
| import android.view.View; |
| import android.widget.PopupWindow.OnDismissListener; |
| |
| import org.chromium.base.Callback; |
| import org.chromium.base.ThreadUtils; |
| import org.chromium.chrome.R; |
| import org.chromium.chrome.browser.ChromeActivity; |
| import org.chromium.chrome.browser.ChromeTabbedActivity; |
| import org.chromium.chrome.browser.appmenu.AppMenuHandler; |
| import org.chromium.chrome.browser.feature_engagement.TrackerFactory; |
| import org.chromium.chrome.browser.lifecycle.Destroyable; |
| import org.chromium.chrome.browser.net.spdyproxy.DataReductionProxySettings; |
| import org.chromium.chrome.browser.ntp.NewTabPage; |
| import org.chromium.chrome.browser.profiles.Profile; |
| import org.chromium.chrome.browser.tab.Tab; |
| import org.chromium.chrome.browser.tabmodel.TabModelSelectorTabObserver; |
| import org.chromium.chrome.browser.util.FeatureUtilities; |
| import org.chromium.chrome.browser.widget.ViewHighlighter; |
| import org.chromium.chrome.browser.widget.textbubble.TextBubble; |
| import org.chromium.components.feature_engagement.EventConstants; |
| import org.chromium.components.feature_engagement.FeatureConstants; |
| import org.chromium.components.feature_engagement.Tracker; |
| import org.chromium.ui.widget.ViewRectProvider; |
| |
| /** |
| * A helper class for IPH shown on the toolbar. |
| * TODO(jinsukkim): Find a way to break (i.e. invert) the dependency on Destroyable |
| * to be able to split up the build target for toolbar which can be a base construct. |
| */ |
| public class ToolbarButtonInProductHelpController implements Destroyable { |
| private final TabModelSelectorTabObserver mPageLoadObserver; |
| private final ChromeActivity mActivity; |
| |
| /** |
| * Create ToolbarButtonInProductHelpController. |
| * @param activity ChromeActivity the controller is attached to. |
| * @param isShowingPromo {@code true} if promo dialog is being shown. |
| */ |
| public static void create(final ChromeActivity activity, boolean isShowingPromo) { |
| ToolbarButtonInProductHelpController controller = |
| new ToolbarButtonInProductHelpController(activity); |
| activity.getLifecycleDispatcher().register(controller); |
| if (!isShowingPromo) controller.maybeShowColdStartIPH(); |
| } |
| |
| private ToolbarButtonInProductHelpController(final ChromeActivity activity) { |
| mActivity = activity; |
| // TODO(jinsukkim): Consider switching to ActivityTabProvider and its TabObserver. |
| mPageLoadObserver = new TabModelSelectorTabObserver(activity.getTabModelSelector()) { |
| /** |
| * Stores total data saved at the start of a page load. Used to calculate delta at the |
| * end of page load, which is just an estimate of the data saved for the current page |
| * load since there may be multiple pages loading at the same time. This estimate is |
| * used to get an idea of how widely used the data saver feature is for a particular |
| * user at a time (i.e. not since the user started using Chrome). |
| */ |
| private long mDataSavedOnStartPageLoad; |
| private Tab mPageLoadTab; |
| |
| @Override |
| public void onPageLoadStarted(Tab tab, String url) { |
| if (tab != activity.getActivityTabProvider().getActivityTab()) return; |
| mDataSavedOnStartPageLoad = DataReductionProxySettings.getInstance() |
| .getContentLengthSavedInHistorySummary(); |
| mPageLoadTab = tab; |
| } |
| |
| @Override |
| public void onPageLoadFinished(Tab tab, String url) { |
| if (mPageLoadTab != tab) return; |
| long dataSaved = DataReductionProxySettings.getInstance() |
| .getContentLengthSavedInHistorySummary() |
| - mDataSavedOnStartPageLoad; |
| Tracker tracker = TrackerFactory.getTrackerForProfile(Profile.getLastUsedProfile()); |
| if (dataSaved > 0L) tracker.notifyEvent(EventConstants.DATA_SAVED_ON_PAGE_LOAD); |
| if (tab.isPreview()) tracker.notifyEvent(EventConstants.PREVIEWS_PAGE_LOADED); |
| if (tab == activity.getActivityTabProvider().getActivityTab() |
| && tab.isUserInteractable()) { |
| maybeShowDataSaver(activity); |
| maybeShowPreviewVerboseStatus(activity); |
| } |
| mPageLoadTab = null; |
| } |
| }; |
| } |
| |
| @Override |
| public void destroy() { |
| mPageLoadObserver.destroy(); |
| } |
| |
| // Attempts to show an IPH text bubble for data saver. |
| private static void maybeShowDataSaver(ChromeActivity activity) { |
| View anchorView = activity.getToolbarManager().getMenuButton(); |
| if (anchorView == null) return; |
| |
| setupAndMaybeShowIPHForFeature(FeatureConstants.DATA_SAVER_DETAIL_FEATURE, |
| R.id.app_menu_footer, R.string.iph_data_saver_detail_text, |
| R.string.iph_data_saver_detail_accessibility_text, anchorView, |
| activity.getAppMenuHandler(), activity); |
| } |
| |
| // Attempts to show an IPH text bubble for page in preview mode. |
| private static void maybeShowPreviewVerboseStatus(ChromeActivity activity) { |
| if (!activity.getActivityTabProvider().getActivityTab().isPreview()) return; |
| |
| final View anchorView = activity.getToolbarManager().getSecurityIconView(); |
| if (anchorView == null) return; |
| |
| setupAndMaybeShowIPHForFeature(FeatureConstants.PREVIEWS_OMNIBOX_UI_FEATURE, null, |
| R.string.iph_previews_omnibox_ui_text, |
| R.string.iph_previews_omnibox_ui_accessibility_text, anchorView, null, activity); |
| } |
| |
| /** |
| * Attempts to show an IPH text bubble for those that trigger on a cold start. |
| * @param activity The activity to use for the IPH. |
| */ |
| public void maybeShowColdStartIPH() { |
| maybeShowDownloadHomeIPH(); |
| maybeShowNTPButtonIPH(); |
| } |
| |
| private void maybeShowDownloadHomeIPH() { |
| setupAndMaybeShowIPHForFeature(FeatureConstants.DOWNLOAD_HOME_FEATURE, |
| R.id.downloads_menu_id, R.string.iph_download_home_text, |
| R.string.iph_download_home_accessibility_text, |
| mActivity.getToolbarManager().getMenuButton(), mActivity.getAppMenuHandler(), |
| mActivity); |
| } |
| |
| private void maybeShowNTPButtonIPH() { |
| if (!canShowNTPButtonIPH(mActivity)) return; |
| |
| setupAndMaybeShowIPHForFeature(FeatureConstants.NTP_BUTTON_FEATURE, null, |
| R.string.iph_ntp_button_text_home_text, |
| R.string.iph_ntp_button_text_home_accessibility_text, |
| mActivity.findViewById(R.id.home_button), null, mActivity); |
| } |
| |
| /** |
| * Attempts to show an IPH text bubble for download continuing. |
| * @param activity The activity to use for the IPH. |
| * @param profile The profile to use for the tracker. |
| */ |
| public static void maybeShowDownloadContinuingIPH( |
| ChromeTabbedActivity activity, Profile profile) { |
| setupAndMaybeShowIPHForFeature( |
| FeatureConstants.DOWNLOAD_INFOBAR_DOWNLOAD_CONTINUING_FEATURE, |
| R.id.downloads_menu_id, R.string.iph_download_infobar_download_continuing_text, |
| R.string.iph_download_infobar_download_continuing_text, |
| activity.getToolbarManager().getMenuButton(), activity.getAppMenuHandler(), |
| activity); |
| } |
| |
| private static void setupAndMaybeShowIPHForFeature(String featureName, |
| Integer highlightMenuItemId, @StringRes int stringId, |
| @StringRes int accessibilityStringId, View anchorView, |
| @Nullable AppMenuHandler appMenuHandler, ChromeActivity activity) { |
| final Tracker tracker = TrackerFactory.getTrackerForProfile(Profile.getLastUsedProfile()); |
| tracker.addOnInitializedCallback((Callback<Boolean>) success -> { |
| OnDismissListener dismissListener = () -> anchorView.getHandler().postDelayed(() -> { |
| tracker.dismissed(featureName); |
| turnOffHighlightForTextBubble(appMenuHandler, anchorView); |
| }, ViewHighlighter.IPH_MIN_DELAY_BETWEEN_TWO_HIGHLIGHTS); |
| |
| turnOnHighlightForTextBubble(appMenuHandler, highlightMenuItemId, anchorView); |
| maybeShowIPHBubble(tracker, featureName, stringId, accessibilityStringId, anchorView, |
| activity, dismissListener); |
| }); |
| } |
| |
| private static void maybeShowIPHBubble(Tracker tracker, String featureName, |
| @StringRes int stringId, @StringRes int accessibilityStringId, View anchorView, |
| ChromeActivity activity, OnDismissListener dismissListener) { |
| // Activity was destroyed; don't show IPH. |
| if (activity.isActivityDestroyed() || anchorView == null) return; |
| |
| assert(stringId != 0 && accessibilityStringId != 0); |
| |
| // Post a request to show the IPH bubble to allow time for a layout pass. Since the bubble |
| // is shown on startup, the anchor view may not have a height initially see |
| // https://crbug.com/871537. |
| ThreadUtils.postOnUiThread(() -> { |
| if (activity.isActivityDestroyed()) return; |
| |
| if (TextUtils.equals(featureName, FeatureConstants.NTP_BUTTON_FEATURE) |
| && !canShowNTPButtonIPH(activity)) { |
| return; |
| } |
| |
| if (!tracker.shouldTriggerHelpUI(featureName)) return; |
| ViewRectProvider rectProvider = new ViewRectProvider(anchorView); |
| |
| TextBubble textBubble = new TextBubble( |
| activity, anchorView, stringId, accessibilityStringId, rectProvider); |
| textBubble.setDismissOnTouchInteraction(true); |
| textBubble.addOnDismissListener(dismissListener); |
| |
| int yInsetPx = activity.getResources().getDimensionPixelOffset( |
| R.dimen.text_bubble_menu_anchor_y_inset); |
| rectProvider.setInsetPx(0, 0, 0, yInsetPx); |
| textBubble.show(); |
| }); |
| } |
| |
| private static void turnOnHighlightForTextBubble( |
| AppMenuHandler handler, Integer highlightMenuItemId, View anchorView) { |
| if (handler != null) { |
| handler.setMenuHighlight(highlightMenuItemId); |
| } else { |
| ViewHighlighter.turnOnHighlight(anchorView, true); |
| } |
| } |
| |
| private static void turnOffHighlightForTextBubble(AppMenuHandler handler, View anchorView) { |
| if (handler != null) { |
| handler.setMenuHighlight(null); |
| } else { |
| ViewHighlighter.turnOffHighlight(anchorView); |
| } |
| } |
| |
| private static boolean canShowNTPButtonIPH(ChromeActivity activity) { |
| View homeButton = activity.findViewById(R.id.home_button); |
| return FeatureUtilities.isNewTabPageButtonEnabled() |
| && !activity.getCurrentTabModel().isIncognito() && activity.getActivityTab() != null |
| && !NewTabPage.isNTPUrl(activity.getActivityTab().getUrl()) && homeButton != null |
| && homeButton.getVisibility() == View.VISIBLE; |
| } |
| } |
