tv/onboarding/SetupSourcesFragment.java

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.tv.onboarding;

import android.app.Activity;
import android.graphics.Typeface;
import android.media.tv.TvInputInfo;
import android.media.tv.TvInputManager.TvInputCallback;
import android.os.Bundle;
import android.support.annotation.NonNull;
import android.text.TextUtils;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.TextView;

import androidx.leanback.widget.GuidanceStylist.Guidance;
import androidx.leanback.widget.GuidedAction;
import androidx.leanback.widget.GuidedActionsStylist;
import androidx.leanback.widget.VerticalGridView;

import com.android.tv.R;
import com.android.tv.TvSingletons;
import com.android.tv.common.ui.setup.SetupGuidedStepFragment;
import com.android.tv.common.ui.setup.SetupMultiPaneFragment;
import com.android.tv.data.ChannelDataManager;
import com.android.tv.data.TvInputNewComparator;
import com.android.tv.tunerinputcontroller.BuiltInTunerManager;
import com.android.tv.ui.GuidedActionsStylistWithDivider;
import com.android.tv.util.SetupUtils;
import com.android.tv.util.TvInputManagerHelper;

import com.google.common.base.Optional;

import dagger.android.AndroidInjection;
import dagger.android.ContributesAndroidInjector;

import com.android.tv.common.flags.UiFlags;

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

import javax.inject.Inject;

/** A fragment for channel source info/setup. */
public class SetupSourcesFragment extends SetupMultiPaneFragment {
    /** The action category for the actions which is fired from this fragment. */
    public static final String ACTION_CATEGORY = "com.android.tv.onboarding.SetupSourcesFragment";
    /** An action to open the merchant collection. */
    public static final int ACTION_ONLINE_STORE = 1;
    /**
     * An action to show the setup activity of TV input.
     *
     * <p>This action is not added to the action list. This is sent outside of the fragment. Use
     * {@link #ACTION_PARAM_KEY_INPUT_ID} to get the input ID from the parameter.
     */
    public static final int ACTION_SETUP_INPUT = 2;

    /**
     * The key for the action parameter which contains the TV input ID. It's used for the action
     * {@link #ACTION_SETUP_INPUT}.
     */
    public static final String ACTION_PARAM_KEY_INPUT_ID = "input_id";

    private static final String SETUP_TRACKER_LABEL = "Setup fragment";

    @Override
    public View onCreateView(
            LayoutInflater inflater, ViewGroup container, Bundle savedInstanceState) {
        View view = super.onCreateView(inflater, container, savedInstanceState);
        TvSingletons.getSingletons(getActivity()).getTracker().sendScreenView(SETUP_TRACKER_LABEL);
        return view;
    }

    @Override
    protected void onEnterTransitionEnd() {
        SetupGuidedStepFragment f = getContentFragment();
        if (f instanceof ContentFragment) {
            // If the enter transition is canceled quickly, the child fragment can be null because
            // the fragment is added asynchronously.
            ((ContentFragment) f).executePendingAction();
        }
    }

    @Override
    protected SetupGuidedStepFragment onCreateContentFragment() {
        SetupGuidedStepFragment f = new ContentFragment();
        Bundle arguments = new Bundle();
        arguments.putBoolean(SetupGuidedStepFragment.KEY_THREE_PANE, true);
        f.setArguments(arguments);
        return f;
    }

    @Override
    protected String getActionCategory() {
        return ACTION_CATEGORY;
    }

    public static class ContentFragment extends SetupGuidedStepFragment {
        // ACTION_ONLINE_STORE is defined in the outer class.
        private static final int ACTION_HEADER = 3;
        private static final int ACTION_INPUT_START = 4;

        private static final int PENDING_ACTION_NONE = 0;
        private static final int PENDING_ACTION_INPUT_CHANGED = 1;
        private static final int PENDING_ACTION_CHANNEL_CHANGED = 2;

        @Inject TvInputManagerHelper mInputManager;
        @Inject ChannelDataManager mChannelDataManager;
        @Inject SetupUtils mSetupUtils;
        @Inject Optional<BuiltInTunerManager> mBuiltInTunerManagerOptional;
        @Inject UiFlags mUiFlags;
        private List<TvInputInfo> mInputs;
        private int mKnownInputStartIndex;
        private int mDoneInputStartIndex;

        private SetupSourcesFragment mParentFragment;

        private String mNewlyAddedInputId;

        private int mPendingAction = PENDING_ACTION_NONE;

        private final TvInputCallback mInputCallback =
                new TvInputCallback() {
                    @Override
                    public void onInputAdded(String inputId) {
                        handleInputChanged();
                    }

                    @Override
                    public void onInputRemoved(String inputId) {
                        handleInputChanged();
                    }

                    @Override
                    public void onInputUpdated(String inputId) {
                        handleInputChanged();
                    }

                    @Override
                    public void onTvInputInfoUpdated(TvInputInfo inputInfo) {
                        handleInputChanged();
                    }

                    private void handleInputChanged() {
                        // The actions created while enter transition is running will not be
                        // included in the
                        // fragment transition.
                        if (mParentFragment.isEnterTransitionRunning()) {
                            mPendingAction = PENDING_ACTION_INPUT_CHANGED;
                            return;
                        }
                        buildInputs();
                        updateActions();
                    }
                };

        private final ChannelDataManager.Listener mChannelDataManagerListener =
                new ChannelDataManager.Listener() {
                    @Override
                    public void onLoadFinished() {
                        handleChannelChanged();
                    }

                    @Override
                    public void onChannelListUpdated() {
                        handleChannelChanged();
                    }

                    @Override
                    public void onChannelBrowsableChanged() {
                        handleChannelChanged();
                    }

                    private void handleChannelChanged() {
                        // The actions created while enter transition is running will not be
                        // included in the
                        // fragment transition.
                        if (mParentFragment.isEnterTransitionRunning()) {
                            if (mPendingAction != PENDING_ACTION_INPUT_CHANGED) {
                                mPendingAction = PENDING_ACTION_CHANNEL_CHANGED;
                            }
                            return;
                        }
                        updateActions();
                    }
                };

        @Override
        public void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            mParentFragment = (SetupSourcesFragment) getParentFragment();
        }

        @Override
        public void onAttach(Activity activity) {
            AndroidInjection.inject(this);
            super.onAttach(activity);
            buildInputs();
            mInputManager.addCallback(mInputCallback);
            mChannelDataManager.addListener(mChannelDataManagerListener);
            mParentFragment = (SetupSourcesFragment) getParentFragment();
            if (mBuiltInTunerManagerOptional.isPresent()) {
                mBuiltInTunerManagerOptional
                        .get()
                        .getTunerInputController()
                        .executeNetworkTunerDiscoveryAsyncTask(activity);
            }
        }

        @Override
        public void onDetach() {
            mChannelDataManager.removeListener(mChannelDataManagerListener);
            mInputManager.removeCallback(mInputCallback);
            super.onDetach();
        }

        @NonNull
        @Override
        public Guidance onCreateGuidance(Bundle savedInstanceState) {
            String title = getString(R.string.setup_sources_text);
            String description = getString(R.string.setup_sources_description2);
            return new Guidance(title, description, null, null);
        }

        @Override
        public GuidedActionsStylist onCreateActionsStylist() {
            return new SetupSourceGuidedActionsStylist();
        }

        @Override
        public void onCreateActions(
                @NonNull List<GuidedAction> actions, Bundle savedInstanceState) {
            createActionsInternal(actions);
        }

        private void buildInputs() {
            List<TvInputInfo> oldInputs = mInputs;
            mInputs = mInputManager.getTvInputInfos(true, true);
            // Get newly installed input ID.
            if (oldInputs != null) {
                List<TvInputInfo> newList = new ArrayList<>(mInputs);
                for (TvInputInfo input : oldInputs) {
                    newList.remove(input);
                }
                if (newList.size() > 0 && mSetupUtils.isNewInput(newList.get(0).getId())) {
                    mNewlyAddedInputId = newList.get(0).getId();
                } else {
                    mNewlyAddedInputId = null;
                }
            }
            Collections.sort(mInputs, new TvInputNewComparator(mSetupUtils, mInputManager));
            mKnownInputStartIndex = 0;
            mDoneInputStartIndex = 0;
            for (TvInputInfo input : mInputs) {
                if (mSetupUtils.isNewInput(input.getId())) {
                    mSetupUtils.markAsKnownInput(input.getId());
                    ++mKnownInputStartIndex;
                }
                if (!mSetupUtils.isSetupDone(input.getId())) {
                    ++mDoneInputStartIndex;
                }
            }
        }

        private void updateActions() {
            List<GuidedAction> actions = new ArrayList<>();
            createActionsInternal(actions);
            setActions(actions);
        }

        private void createActionsInternal(List<GuidedAction> actions) {
            int newPosition = -1;
            int position = 0;
            if (mDoneInputStartIndex > 0) {
                // Need a "New" category
                actions.add(
                        new GuidedAction.Builder(getActivity())
                                .id(ACTION_HEADER)
                                .title(null)
                                .description(getString(R.string.setup_category_new))
                                .focusable(false)
                                .infoOnly(true)
                                .build());
            }
            for (int i = 0; i < mInputs.size(); ++i) {
                if (i == mDoneInputStartIndex) {
                    ++position;
                    actions.add(
                            new GuidedAction.Builder(getActivity())
                                    .id(ACTION_HEADER)
                                    .title(null)
                                    .description(getString(R.string.setup_category_done))
                                    .focusable(false)
                                    .infoOnly(true)
                                    .build());
                }
                TvInputInfo input = mInputs.get(i);
                String inputId = input.getId();
                String description;
                int channelCount = mChannelDataManager.getChannelCountForInput(inputId);
                if (mSetupUtils.isSetupDone(inputId) || channelCount > 0) {
                    if (channelCount == 0) {
                        description = getString(R.string.setup_input_no_channels);
                    } else {
                        description =
                                getResources()
                                        .getQuantityString(
                                                R.plurals.setup_input_channels,
                                                channelCount,
                                                channelCount);
                    }
                } else if (i >= mKnownInputStartIndex) {
                    description = getString(R.string.setup_input_setup_now);
                } else {
                    description = getString(R.string.setup_input_new);
                }
                ++position;
                if (input.getId().equals(mNewlyAddedInputId)) {
                    newPosition = position;
                }
                actions.add(
                        new GuidedAction.Builder(getActivity())
                                .id(ACTION_INPUT_START + i)
                                .title(input.loadLabel(getActivity()).toString())
                                .description(description)
                                .build());
            }
            if (mInputs.size() > 0) {
                // Divider
                ++position;
                actions.add(GuidedActionsStylistWithDivider.createDividerAction(getContext()));
            }
            if (!TextUtils.isEmpty(mUiFlags.moreChannelsUrl())) {
                // online store action
                ++position;
                actions.add(
                        new GuidedAction.Builder(getActivity())
                                .id(ACTION_ONLINE_STORE)
                                .title(getString(R.string.setup_store_action_title))
                                .description(getString(R.string.setup_store_action_description))
                                .icon(R.drawable.ic_app_store)
                                .build());
            }
            if (newPosition != -1) {
                VerticalGridView gridView = getGuidedActionsStylist().getActionsGridView();
                gridView.setSelectedPosition(newPosition);
            }
        }

        @Override
        protected String getActionCategory() {
            return ACTION_CATEGORY;
        }

        @Override
        public void onGuidedActionClicked(GuidedAction action) {
            if (action.getId() == ACTION_ONLINE_STORE) {
                mParentFragment.onActionClick(ACTION_CATEGORY, (int) action.getId());
                return;
            }
            int index = (int) action.getId() - ACTION_INPUT_START;
            if (index >= 0) {
                TvInputInfo input = mInputs.get(index);
                Bundle params = new Bundle();
                params.putString(ACTION_PARAM_KEY_INPUT_ID, input.getId());
                mParentFragment.onActionClick(ACTION_CATEGORY, ACTION_SETUP_INPUT, params);
            }
        }

        void executePendingAction() {
            switch (mPendingAction) {
                case PENDING_ACTION_INPUT_CHANGED:
                    buildInputs();
                    // Fall through
                case PENDING_ACTION_CHANNEL_CHANGED:
                    updateActions();
                    break;
                default: // fall out
            }
            mPendingAction = PENDING_ACTION_NONE;
        }

        private class SetupSourceGuidedActionsStylist extends GuidedActionsStylistWithDivider {
            private static final float ALPHA_CATEGORY = 1.0f;
            private static final float ALPHA_INPUT_DESCRIPTION = 0.5f;

            @Override
            public void onBindViewHolder(ViewHolder vh, GuidedAction action) {
                super.onBindViewHolder(vh, action);
                TextView descriptionView = vh.getDescriptionView();
                if (descriptionView != null) {
                    if (action.getId() == ACTION_HEADER) {
                        descriptionView.setAlpha(ALPHA_CATEGORY);
                        descriptionView.setTextColor(
                                getResources().getColor(R.color.setup_category, null));
                        descriptionView.setTypeface(
                                Typeface.create(getString(R.string.condensed_font), 0));
                    } else {
                        descriptionView.setAlpha(ALPHA_INPUT_DESCRIPTION);
                        descriptionView.setTextColor(
                                getResources()
                                        .getColor(R.color.common_setup_input_description, null));
                        descriptionView.setTypeface(Typeface.create(getString(R.string.font), 0));
                    }
                }
                setAccessibilityDelegate(vh, action);
            }
        }
        /**
         * Exports {@link ContentFragment} for Dagger codegen to create the appropriate injector.
         */
        @dagger.Module
        public abstract static class Module {
            @ContributesAndroidInjector
            abstract ContentFragment contributesContentFragment();
        }
    }
}