chrome/browser/password_check/android/internal/java/src/org/chromium/chrome/browser/password_check/PasswordCheckViewBinder.java

// Copyright 2020 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.password_check;

import static org.chromium.chrome.browser.password_check.PasswordCheckProperties.CompromisedCredentialProperties.COMPROMISED_CREDENTIAL;
import static org.chromium.chrome.browser.password_check.PasswordCheckProperties.CompromisedCredentialProperties.CREDENTIAL_HANDLER;
import static org.chromium.chrome.browser.password_check.PasswordCheckProperties.HeaderProperties.CHECK_STATUS;
import static org.chromium.chrome.browser.password_check.PasswordCheckProperties.ITEMS;
import static org.chromium.components.embedder_support.util.UrlUtilities.stripScheme;

import android.content.Context;
import android.view.View;
import android.view.ViewGroup;
import android.widget.ImageButton;
import android.widget.TextView;

import org.chromium.chrome.browser.password_check.PasswordCheck.CheckStatus;
import org.chromium.chrome.browser.password_check.PasswordCheckProperties.ItemType;
import org.chromium.chrome.browser.password_check.internal.R;
import org.chromium.components.browser_ui.widget.listmenu.BasicListMenu;
import org.chromium.components.browser_ui.widget.listmenu.ListMenu;
import org.chromium.components.browser_ui.widget.listmenu.ListMenuButton;
import org.chromium.components.browser_ui.widget.listmenu.ListMenuItemProperties;
import org.chromium.ui.modelutil.MVCListAdapter;
import org.chromium.ui.modelutil.PropertyKey;
import org.chromium.ui.modelutil.PropertyModel;
import org.chromium.ui.modelutil.RecyclerViewAdapter;
import org.chromium.ui.modelutil.SimpleRecyclerViewMcp;
import org.chromium.ui.widget.ButtonCompat;

/**
 * Provides functions that map {@link PasswordCheckProperties} changes in a {@link PropertyModel} to
 * the suitable method in {@link PasswordCheckFragmentView}.
 */
class PasswordCheckViewBinder {
    /**
     * Called whenever a property in the given model changes. It updates the given view
     * accordingly.
     *
     * @param model       The observed {@link PropertyModel}. Its data is reflected in the view.
     * @param view        The {@link PasswordCheckFragmentView} to update.
     * @param propertyKey The {@link PropertyKey} which changed.
     */
    static void bindPasswordCheckView(
            PropertyModel model, PasswordCheckFragmentView view, PropertyKey propertyKey) {
        if (propertyKey == ITEMS) {
            view.getListView().setAdapter(new RecyclerViewAdapter<>(
                    new SimpleRecyclerViewMcp<>(model.get(ITEMS),
                            PasswordCheckProperties::getItemType,
                            PasswordCheckViewBinder::connectPropertyModel),
                    PasswordCheckViewBinder::createViewHolder));
        } else {
            assert false : "Unhandled update to property:" + propertyKey;
        }
    }

    /**
     * Factory used to create a new View inside the list inside the PasswordCheckFragmentView.
     *
     * @param parent   The parent {@link ViewGroup} of the new item.
     * @param itemType The type of View to create.
     */
    private static PasswordCheckViewHolder createViewHolder(
            ViewGroup parent, @ItemType int itemType) {
        switch (itemType) {
            case ItemType.HEADER:
                return new PasswordCheckViewHolder(parent, R.layout.password_check_header_item,
                        PasswordCheckViewBinder::bindHeaderView);
            case ItemType.COMPROMISED_CREDENTIAL:
                return new PasswordCheckViewHolder(parent,
                        R.layout.password_check_compromised_credential_item,
                        PasswordCheckViewBinder::bindCredentialView);
            case ItemType.COMPROMISED_CREDENTIAL_WITH_SCRIPT:
                return new PasswordCheckViewHolder(parent,
                        R.layout.password_check_compromised_credential_with_script_item,
                        PasswordCheckViewBinder::bindCredentialView);
        }
        assert false : "Cannot create view for ItemType: " + itemType;
        return null;
    }

    /**
     * This method creates a model change processor for each recycler view item when it is created.
     *
     * @param holder A {@link PasswordCheckViewHolder} holding a view and view binder for the MCP.
     * @param item   A {@link MVCListAdapter.ListItem} holding a {@link PropertyModel} for the MCP.
     */
    private static void connectPropertyModel(
            PasswordCheckViewHolder holder, MVCListAdapter.ListItem item) {
        holder.setupModelChangeProcessor(item.model);
    }

    /**
     * Called whenever a credential is bound to this view holder. Please note that this method might
     * be called on a recycled view with old data, so make sure to always reset unused properties to
     * default values.
     *
     * @param model       The model containing the data for the view
     * @param view        The view to be bound
     * @param propertyKey The key of the property to be bound
     */
    private static void bindCredentialView(
            PropertyModel model, View view, PropertyKey propertyKey) {
        CompromisedCredential credential = model.get(COMPROMISED_CREDENTIAL);
        if (propertyKey == COMPROMISED_CREDENTIAL) {
            TextView pslOriginText = view.findViewById(R.id.credential_origin);
            String formattedOrigin = stripScheme(credential.getOriginUrl());
            formattedOrigin =
                    formattedOrigin.replaceFirst("/$", ""); // Strip possibly trailing slash.
            pslOriginText.setText(formattedOrigin);

            TextView username = view.findViewById(R.id.compromised_username);
            username.setText(credential.getUsername());

            TextView reason = view.findViewById(R.id.compromised_reason);
            reason.setText(credential.isPhished()
                            ? R.string.password_check_credential_row_reason_phished
                            : R.string.password_check_credential_row_reason_leaked);

            ListMenuButton more = view.findViewById(R.id.credential_menu_button);
            more.setDelegate(() -> {
                return createCredentialMenu(view.getContext(), model.get(COMPROMISED_CREDENTIAL),
                        model.get(CREDENTIAL_HANDLER));
            });

            ButtonCompat button = view.findViewById(R.id.credential_change_button);
            button.setOnClickListener(unusedView -> {
                model.get(CREDENTIAL_HANDLER).onChangePasswordButtonClick(credential);
            });
            if (credential.hasScript()) {
                ButtonCompat button_with_script =
                        view.findViewById(R.id.credential_change_button_with_script);
                button_with_script.setOnClickListener(unusedView -> {
                    model.get(CREDENTIAL_HANDLER).onChangePasswordWithScriptButtonClick(credential);
                });
            }
        } else if (propertyKey == CREDENTIAL_HANDLER) {
            assert model.get(CREDENTIAL_HANDLER) != null;
            // Is read-only and must therefore be bound initially, so no action required.
        } else {
            assert false : "Unhandled update to property:" + propertyKey;
        }
    }

    /**
     * Called whenever a property in the given model changes. It updates the given view
     * accordingly.
     *
     * @param model The observed {@link PropertyModel}. Its data needs to be reflected in the view.
     * @param view  The {@link View} of the header to update.
     * @param key   The {@link PropertyKey} which changed.
     */
    private static void bindHeaderView(PropertyModel model, View view, PropertyKey key) {
        if (key == CHECK_STATUS) {
            // TODO(crbug.com/1101256): Set text and illustration based on status.
            @CheckStatus
            int status = model.get(CHECK_STATUS);
            ImageButton restartButton = view.findViewById(R.id.check_status_restart_button);
            if (status != CheckStatus.RUNNING) {
                restartButton.setVisibility(View.VISIBLE);
                restartButton.setClickable(true);
                restartButton.setOnClickListener(unusedView
                        -> {
                                // TODO(crbug.com/1092444): Add call to restart the check.
                        });
            } else {
                restartButton.setVisibility(View.GONE);
                restartButton.setClickable(false);
            }
        } else {
            assert false : "Unhandled update to property:" + key;
        }
    }

    private PasswordCheckViewBinder() {}

    private static ListMenu createCredentialMenu(Context context, CompromisedCredential credential,
            PasswordCheckCoordinator.CredentialEventHandler credentialHandler) {
        MVCListAdapter.ModelList menuItems = new MVCListAdapter.ModelList();
        menuItems.add(
                BasicListMenu.buildMenuListItem(org.chromium.chrome.R.string.remove, 0, 0, true));
        ListMenu.Delegate delegate = (listModel) -> {
            int textId = listModel.get(ListMenuItemProperties.TITLE_ID);
            if (textId == org.chromium.chrome.R.string.remove) {
                credentialHandler.onRemove(credential);
            } else {
                assert false : "No action defined for " + context.getString(textId);
            }
        };
        return new BasicListMenu(context, menuItems, delegate);
    }
}