intentresolver/contentpreview/ChooserContentPreviewUi.java

/*
 * Copyright (C) 2022 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.intentresolver.contentpreview;

import static com.android.intentresolver.contentpreview.ContentPreviewType.CONTENT_PREVIEW_FILE;
import static com.android.intentresolver.contentpreview.ContentPreviewType.CONTENT_PREVIEW_IMAGE;
import static com.android.intentresolver.contentpreview.ContentPreviewType.CONTENT_PREVIEW_PAYLOAD_SELECTION;
import static com.android.intentresolver.contentpreview.ContentPreviewType.CONTENT_PREVIEW_TEXT;

import android.content.ClipData;
import android.content.res.Resources;
import android.net.Uri;
import android.text.TextUtils;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;

import androidx.annotation.Nullable;
import androidx.annotation.VisibleForTesting;

import com.android.intentresolver.ContentTypeHint;
import com.android.intentresolver.data.model.ChooserRequest;
import com.android.intentresolver.widget.ActionRow;
import com.android.intentresolver.widget.ImagePreviewView.TransitionElementStatusCallback;

import kotlinx.coroutines.CoroutineScope;

import java.util.List;
import java.util.function.Consumer;
import java.util.function.Supplier;

/**
 * Collection of helpers for building the content preview UI displayed in
 * {@link com.android.intentresolver.ChooserActivity}.
 * A content preview façade.
 */
public final class ChooserContentPreviewUi {

    private final CoroutineScope mScope;

    /**
     * Delegate to build the default system action buttons to display in the preview layout, if/when
     * they're determined to be appropriate for the particular preview we display.
     * TODO: clarify why action buttons are part of preview logic.
     */
    public interface ActionFactory {
        /**
         * @return Runnable to be run when an edit button is clicked (if available).
         */
        @Nullable
        Runnable getEditButtonRunnable();

        /**
         * @return Runnable to be run when a copy button is clicked (if available).
         */
        @Nullable
        Runnable getCopyButtonRunnable();

        /** Create custom actions */
        List<ActionRow.Action> createCustomActions();

        /**
         * Provides a share modification action, if any.
         */
        @Nullable
        default ActionRow.Action getModifyShareAction() {
            return null;
        }

        /**
         * <p>
         * Creates an exclude-text action that can be called when the user changes shared text
         * status in the Media + Text preview.
         * </p>
         * <p>
         * <code>true</code> argument value indicates that the text should be excluded.
         * </p>
         */
        Consumer<Boolean> getExcludeSharedTextAction();
    }

    @VisibleForTesting
    final ContentPreviewUi mContentPreviewUi;
    private final Supplier</*@Nullable*/ActionRow.Action> mModifyShareActionFactory;
    private View mHeadlineParent;

    public ChooserContentPreviewUi(
            CoroutineScope scope,
            PreviewDataProvider previewData,
            ChooserRequest chooserRequest,
            ImageLoader imageLoader,
            ActionFactory actionFactory,
            Supplier</*@Nullable*/ActionRow.Action> modifyShareActionFactory,
            TransitionElementStatusCallback transitionElementStatusCallback,
            HeadlineGenerator headlineGenerator,
            ContentTypeHint contentTypeHint,
            @Nullable CharSequence metadata) {
        mScope = scope;
        mModifyShareActionFactory = modifyShareActionFactory;
        mContentPreviewUi = createContentPreview(
                previewData,
                chooserRequest,
                DefaultMimeTypeClassifier.INSTANCE,
                imageLoader,
                actionFactory,
                transitionElementStatusCallback,
                headlineGenerator,
                contentTypeHint,
                metadata
        );
        if (mContentPreviewUi.getType() != CONTENT_PREVIEW_IMAGE) {
            transitionElementStatusCallback.onAllTransitionElementsReady();
        }
    }

    private ContentPreviewUi createContentPreview(
            PreviewDataProvider previewData,
            ChooserRequest chooserRequest,
            MimeTypeClassifier typeClassifier,
            ImageLoader imageLoader,
            ActionFactory actionFactory,
            TransitionElementStatusCallback transitionElementStatusCallback,
            HeadlineGenerator headlineGenerator,
            ContentTypeHint contentTypeHint,
            @Nullable CharSequence metadata
    ) {
        int previewType = previewData.getPreviewType();
        if (previewType == CONTENT_PREVIEW_TEXT) {
            return createTextPreview(
                    mScope,
                    chooserRequest.getTargetIntent().getClipData(),
                    chooserRequest.getSharedText(),
                    chooserRequest.getSharedTextTitle(),
                    actionFactory,
                    imageLoader,
                    headlineGenerator,
                    contentTypeHint,
                    metadata
            );
        }
        if (previewType == CONTENT_PREVIEW_FILE) {
            FileContentPreviewUi fileContentPreviewUi = new FileContentPreviewUi(
                    previewData.getUriCount(),
                    actionFactory,
                    headlineGenerator,
                    metadata
            );
            if (previewData.getUriCount() > 0) {
                previewData.getFirstFileName(mScope, fileContentPreviewUi::setFirstFileName);
            }
            return fileContentPreviewUi;
        }

        if (previewType == CONTENT_PREVIEW_PAYLOAD_SELECTION) {
            transitionElementStatusCallback.onAllTransitionElementsReady(); // TODO
            return new ShareouselContentPreviewUi();
        }

        boolean isSingleImageShare = previewData.getUriCount() == 1
                && typeClassifier.isImageType(previewData.getFirstFileInfo().getMimeType());
        if (!TextUtils.isEmpty(chooserRequest.getSharedText())) {
            FilesPlusTextContentPreviewUi previewUi =
                    new FilesPlusTextContentPreviewUi(
                            mScope,
                            isSingleImageShare,
                            previewData.getUriCount(),
                            chooserRequest.getSharedText(),
                            chooserRequest.getTargetType(),
                            actionFactory,
                            imageLoader,
                            typeClassifier,
                            headlineGenerator,
                            metadata,
                            chooserRequest.getCallerAllowsTextToggle()
                    );
            if (previewData.getUriCount() > 0) {
                JavaFlowHelper.collectToList(
                        mScope,
                        previewData.getImagePreviewFileInfoFlow(),
                        previewUi::updatePreviewMetadata);
            }
            return previewUi;
        }

        return new UnifiedContentPreviewUi(
                mScope,
                isSingleImageShare,
                chooserRequest.getTargetType(),
                actionFactory,
                imageLoader,
                typeClassifier,
                transitionElementStatusCallback,
                previewData.getImagePreviewFileInfoFlow(),
                previewData.getUriCount(),
                headlineGenerator,
                metadata
        );
    }

    public int getPreferredContentPreview() {
        return mContentPreviewUi.getType();
    }

    /**
     * Display a content preview of the specified {@code previewType} to preview the content of the
     * specified {@code intent}.
     */
    public ViewGroup displayContentPreview(
            Resources resources,
            LayoutInflater layoutInflater,
            ViewGroup parent,
            View headlineViewParent) {

        ViewGroup layout =
                mContentPreviewUi.display(resources, layoutInflater, parent, headlineViewParent);
        mHeadlineParent = headlineViewParent;
        ContentPreviewUi.displayModifyShareAction(mHeadlineParent, mModifyShareActionFactory.get());
        return layout;
    }

    /**
     * Update Modify Share Action, if it is inflated.
     */
    public void updateModifyShareAction() {
        ContentPreviewUi.displayModifyShareAction(mHeadlineParent, mModifyShareActionFactory.get());
    }

    private static TextContentPreviewUi createTextPreview(
            CoroutineScope scope,
            ClipData previewData,
            @Nullable CharSequence sharingText,
            @Nullable CharSequence previewTitle,
            ChooserContentPreviewUi.ActionFactory actionFactory,
            ImageLoader imageLoader,
            HeadlineGenerator headlineGenerator,
            ContentTypeHint contentTypeHint,
            @Nullable CharSequence metadata
    ) {
        Uri previewThumbnail = null;
        if (previewData != null) {
            if (previewData.getItemCount() > 0) {
                ClipData.Item previewDataItem = previewData.getItemAt(0);
                previewThumbnail = previewDataItem.getUri();
            }
        }

        return new TextContentPreviewUi(
                scope,
                sharingText,
                previewTitle,
                metadata,
                previewThumbnail,
                actionFactory,
                imageLoader,
                headlineGenerator,
                contentTypeHint);
    }
}