org.chromium.chrome.browser.ntp.snippets.SnippetsBridge Java Examples

/**
 * Switches preference screens depending on whether the remote suggestions are enabled/disabled.
 * @param isEnabled Indicates whether the remote suggestions are enabled.
 */
public void updatePreferences(boolean isEnabled) {
    if (mIsEnabled == isEnabled) return;

    mFeatureSwitch.setChecked(isEnabled);
    mIsEnabled = isEnabled;

    if (canShowNotificationsSwitch()) {
        mFeatureSwitch.setSummaryOn(R.string.suggestions_feature_switch_on_summary);
        setNotificationsPrefState(true);
        mNotificationsSwitch.setChecked(
                SnippetsBridge.areContentSuggestionsNotificationsEnabled());
        setCaveatsPrefState(false);
    } else {
        mFeatureSwitch.setSummaryOn(R.string.text_on);
        setNotificationsPrefState(false);
        setCaveatsPrefState(true);
    }
}
 

/**
 * Constructor to create the manager for all the cards to display on the NTP
 *
 * @param manager the NewTabPageManager to use to interact with the rest of the system.
 * @param newTabPageLayout the layout encapsulating all the above-the-fold elements
 *                         (logo, search box, most visited tiles)
 * @param snippetsBridge the bridge to interact with the snippets service.
 */
public NewTabPageAdapter(NewTabPageManager manager, NewTabPageLayout newTabPageLayout,
        SnippetsBridge snippetsBridge) {
    mNewTabPageManager = manager;
    mNewTabPageLayout = newTabPageLayout;
    mAboveTheFoldListItem = new AboveTheFoldListItem();
    mHeaderListItem = new SnippetHeaderListItem();
    mItemTouchCallbacks = new ItemTouchCallbacks();
    mNewTabPageListItems = new ArrayList<NewTabPageListItem>();
    mWantsSnippets = true;
    mSnippetsBridge = snippetsBridge;
    mStatusListItem = StatusListItem.create(snippetsBridge.getDisabledReason(), this, manager);

    loadSnippets(new ArrayList<SnippetArticle>());
    mSnippetsBridge.setObserver(this);
}
 

@Override
public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    addPreferencesFromResource(R.xml.suggestions_preferences);
    setHasOptionsMenu(true);
    finishSwitchInitialisation();

    boolean isEnabled = SnippetsBridge.areRemoteSuggestionsEnabled();
    mIsEnabled = !isEnabled; // Opposite so that we trigger side effects below.
    updatePreferences(isEnabled);

    @LaunchSource
    int launchSource =
            getActivity().getIntent().getIntExtra(LAUNCH_SOURCE_EXTRA, LAUNCH_SOURCE_SETTINGS);
    if (launchSource == LAUNCH_SOURCE_NOTIFICATION) {
        ContentSuggestionsNotificationHelper.recordNotificationAction(
                ContentSuggestionsNotificationAction.OPEN_SETTINGS);
    }
}
 

/**
 * Returns whether the category is able to process the suggestions. The category might decide
 * not to show incoming suggestions later, but this check ensures it's in a basic state
 * compatible with displaying content.
 */
private boolean canProcessSuggestions(@CategoryInt int category, @CategoryStatus int status) {
    // If the category was blacklisted, we note that there might be new content to show.
    mBlacklistedCategories.remove(category);

    // We never want to add suggestions from unknown categories.
    if (!mSections.containsKey(category)) return false;

    // The status may have changed while the suggestions were loading, perhaps they should not
    // be displayed any more.
    if (!SnippetsBridge.isCategoryEnabled(status)) {
        Log.w(TAG, "Received suggestions for a disabled category (id=%d, status=%d)", category,
                status);
        return false;
    }

    return true;
}
 

public void addSuggestions(List<SnippetArticle> suggestions, @CategoryStatusEnum int status) {
    if (!SnippetsBridge.isCategoryStatusAvailable(status)) mSuggestionsList.clear();
    mProgressIndicator.setVisible(SnippetsBridge.isCategoryLoading(status));

    Log.d(TAG, "addSuggestions: current number of suggestions: %d",
            mSuggestionsList.getItemCount());

    int sizeBefore = suggestions.size();

    // TODO(dgn): remove once the backend stops sending duplicates.
    if (suggestions.removeAll(mSuggestionsList.mSuggestions)) {
        Log.d(TAG, "addSuggestions: Removed duplicates from incoming suggestions. "
                        + "Count changed from %d to %d",
                sizeBefore, suggestions.size());
    }

    mSuggestionsList.addAll(suggestions);
    for (SnippetArticle article : suggestions) {
        if (!article.requiresExactOfflinePage()) {
            updateSnippetOfflineAvailability(article);
        }
    }

    refreshChildrenVisibility();
}
 

/**
 * Resets the sections, reloading the whole new tab page content.
 * @param alwaysAllowEmptySections Whether sections are always allowed to be displayed when
 *     they are empty, even when they are normally not.
 */
private void resetSections(boolean alwaysAllowEmptySections) {
    removeAllSections();

    SuggestionsSource suggestionsSource = mUiDelegate.getSuggestionsSource();
    int[] categories = suggestionsSource.getCategories();
    int[] suggestionsPerCategory = new int[categories.length];
    int visibleCategoriesCount = 0;
    int categoryIndex = 0;
    for (int category : categories) {
        int categoryStatus = suggestionsSource.getCategoryStatus(category);
        int suggestionsCount = 0;
        if (SnippetsBridge.isCategoryEnabled(categoryStatus)) {
            suggestionsCount = resetSection(category, categoryStatus, alwaysAllowEmptySections);
            if (mSections.get(category) != null) ++visibleCategoriesCount;
        }
        suggestionsPerCategory[categoryIndex] = suggestionsCount;
        ++categoryIndex;
    }

    maybeHideArticlesHeader();
    mUiDelegate.getEventReporter().onPageShown(
            categories, suggestionsPerCategory, visibleCategoriesCount);
}
 

private boolean canLoadSuggestions(@CategoryInt int category, @CategoryStatusEnum int status) {
    // We never want to add suggestions from unknown categories.
    if (!mSections.containsKey(category)) return false;

    // The status may have changed while the suggestions were loading, perhaps they should not
    // be displayed any more.
    if (!SnippetsBridge.isCategoryEnabled(status)) {
        Log.w(TAG, "Received suggestions for a disabled category (id=%d, status=%d)", category,
                status);
        return false;
    }

    return true;
}
 

/** Sets the status for the section. Some statuses can cause the suggestions to be cleared. */
public void setStatus(@CategoryStatus int status) {
    if (!SnippetsBridge.isCategoryStatusAvailable(status)) {
        clearData();
        Log.d(TAG, "setStatus: unavailable status, cleared suggestions.");
    }
    mProgressIndicator.setVisible(SnippetsBridge.isCategoryLoading(status));
}
 

/** Start a request for new snippets. */
public void reloadSnippets() {
    SnippetsBridge.fetchSnippets(/*forceRequest=*/true);
}
 

@VisibleForTesting
protected void fetchSnippets() {
    SnippetsBridge.fetchSnippets();
}
 

private void endRecording(Tab removeObserverFromTab) {
    if (removeObserverFromTab != null) removeObserverFromTab.removeObserver(this);
    RecordUserAction.record("MobileNTP.Snippets.VisitEnd");
    long visitTimeMs = SystemClock.elapsedRealtime() - mStartTimeMs;
    SnippetsBridge.onSuggestionTargetVisited(mCategory, visitTimeMs);
}
 

@VisibleForTesting
protected void fetchSnippets() {
    SnippetsBridge.fetchRemoteSuggestionsFromBackground();
}
 

@VisibleForTesting
protected void rescheduleFetching() {
    SnippetsBridge.rescheduleFetching();
}
 

/** Sets the status for the section. Some statuses can cause the suggestions to be cleared. */
public void setStatus(@CategoryStatusEnum int status) {
    if (!SnippetsBridge.isCategoryStatusAvailable(status)) mSuggestionsList.clear();
    mProgressIndicator.setVisible(SnippetsBridge.isCategoryLoading(status));
    refreshChildrenVisibility();
}
 

@VisibleForTesting
protected void rescheduleFetching() {
    SnippetsBridge.rescheduleFetching();
}
 

@VisibleForTesting
protected void fetchSnippets() {
    // Do not force regular background fetches.
    SnippetsBridge.fetchSnippets(/*forceRequest=*/false);
}
 

/** Start a request for new snippets. */
public void reloadSnippets() {
    mWantsSnippets = true;
    SnippetsBridge.fetchSnippets();
}
 

@VisibleForTesting
protected void rescheduleSnippets() {
    SnippetsBridge.rescheduleFetching();
}