chromium/chrome/browser/privacy_guide/android/java/src/org/chromium/chrome/browser/privacy_guide/PrivacyGuidePagerAdapter.java

// Copyright 2021 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.privacy_guide;

import androidx.fragment.app.Fragment;
import androidx.viewpager2.adapter.FragmentStateAdapter;

import org.chromium.chrome.browser.flags.ChromeFeatureList;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

/** Controls the behavior of the ViewPager to navigate between privacy guide steps. */
public class PrivacyGuidePagerAdapter extends FragmentStateAdapter {
    private final List<Integer> mFragmentTypeList;

    public PrivacyGuidePagerAdapter(
            Fragment parent,
            StepDisplayHandler displayHandler,
            List<Integer> allFragmentTypesInOrder) {
        super(parent);
        Set<Integer> fragmentTypesToDisplay = getFragmentTypesToDisplay(displayHandler);
        mFragmentTypeList =
                getFragmentTypesToDisplayInOrder(fragmentTypesToDisplay, allFragmentTypesInOrder);
    }

    private List<Integer> getFragmentTypesToDisplayInOrder(
            Set<Integer> fragmentTypesToDisplay, List<Integer> allFragmentTypesInOrder) {
        List<Integer> fragmentTypesToDisplayInOrder = new ArrayList<>();

        // Add the fragment types to display to |fragmentTypesToDisplayInOrder|
        // in the order they are declared in FragmentType.
        for (Integer fragmentType : allFragmentTypesInOrder) {
            if (fragmentTypesToDisplay.contains(fragmentType)) {
                fragmentTypesToDisplayInOrder.add(fragmentType);
            }
        }

        return fragmentTypesToDisplayInOrder;
    }

    private Set<Integer> getFragmentTypesToDisplay(StepDisplayHandler displayHandler) {
        Set<Integer> fragmentTypesToDisplay = new HashSet<>();
        fragmentTypesToDisplay.addAll(
                Arrays.asList(
                        PrivacyGuideFragment.FragmentType.WELCOME,
                        PrivacyGuideFragment.FragmentType.MSBB,
                        PrivacyGuideFragment.FragmentType.DONE));

        if (ChromeFeatureList.sPrivacyGuideAndroid3.isEnabled()) {
            // TODO(crbug.com/40184479): This fragment is always displayed and need to be added to
            // the above list once the privacy guide android 3 is removed.
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.SEARCH_SUGGESTIONS);
        }
        if (displayHandler.shouldDisplayHistorySync()) {
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.HISTORY_SYNC);
        }
        if (displayHandler.shouldDisplaySafeBrowsing()) {
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.SAFE_BROWSING);
        }
        if (displayHandler.shouldDisplayCookies()) {
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.COOKIES);
        }
        if (ChromeFeatureList.sPrivacyGuideAndroid3.isEnabled()
                && ChromeFeatureList.sPrivacyGuidePreloadAndroid.isEnabled()
                && displayHandler.shouldDisplayPreload()) {
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.PRELOAD);
        }
        if (displayHandler.shouldDisplayAdTopics()) {
            fragmentTypesToDisplay.add(PrivacyGuideFragment.FragmentType.AD_TOPICS);
        }
        return Collections.unmodifiableSet(fragmentTypesToDisplay);
    }

    @Override
    public Fragment createFragment(int position) {
        int fragmentType = getFragmentType(position);
        switch (fragmentType) {
            case PrivacyGuideFragment.FragmentType.WELCOME:
                return new WelcomeFragment();
            case PrivacyGuideFragment.FragmentType.MSBB:
                return new MSBBFragment();
            case PrivacyGuideFragment.FragmentType.HISTORY_SYNC:
                return new HistorySyncFragment();
            case PrivacyGuideFragment.FragmentType.SAFE_BROWSING:
                return new SafeBrowsingFragment();
            case PrivacyGuideFragment.FragmentType.COOKIES:
                return new CookiesFragment();
            case PrivacyGuideFragment.FragmentType.SEARCH_SUGGESTIONS:
                return new SearchSuggestionsFragment();
            case PrivacyGuideFragment.FragmentType.PRELOAD:
                return new PreloadFragment();
            case PrivacyGuideFragment.FragmentType.AD_TOPICS:
                return new AdTopicsFragment();
            case PrivacyGuideFragment.FragmentType.DONE:
                return new DoneFragment();
        }
        return null;
    }

    @Override
    public int getItemCount() {
        return mFragmentTypeList.size();
    }

    /**
     * Returns a {@link PrivacyGuideFragment.FragmentType} at a specified position of Privacy Guide.
     *
     * @param position within |mFragmentTypeList|
     * @return the {@link PrivacyGuideFragment.FragmentType} at the specified position.
     */
    public @PrivacyGuideFragment.FragmentType int getFragmentType(int position) {
        return mFragmentTypeList.get(position);
    }
}