RemoteCreateEntry.kt

/*
 * Copyright 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 androidx.credentials.provider

import android.annotation.SuppressLint
import android.app.PendingIntent
import android.app.slice.Slice
import android.app.slice.SliceSpec
import android.net.Uri
import android.os.Parcel
import android.os.Parcelable
import android.util.Log
import androidx.annotation.NonNull
import androidx.annotation.RequiresApi
import androidx.annotation.VisibleForTesting
import androidx.credentials.CredentialManager
import java.util.Collections

/**
 * An entry to be shown on the selector during a create flow initiated when an app calls
 * [CredentialManager.createCredential].
 *
 * A [RemoteCreateEntry] implies that the credential will be created on
 * a different device.
 * When the user selects this entry, the corresponding [PendingIntent] is fired,
 * and the credential creation can be completed.
 *
 * @property pendingIntent the [PendingIntent] to be fired when this
 * [RemoteCreateEntry] is selected
 *
 * @throws NullPointerException If [pendingIntent] is empty
 */
@RequiresApi(34)
class RemoteCreateEntry constructor(
    val pendingIntent: PendingIntent,
    ) : android.service.credentials.CreateEntry(
    toSlice(pendingIntent)
) {

    override fun describeContents(): Int {
        return 0
    }

    override fun writeToParcel(@NonNull dest: Parcel, flags: Int) {
        super.writeToParcel(dest, flags)
    }

    @Suppress("AcronymName")
    companion object {
        private const val TAG = "RemoteCreateEntry"
        @VisibleForTesting(otherwise = VisibleForTesting.PRIVATE)
        internal const val SLICE_HINT_PENDING_INTENT =
            "androidx.credentials.provider.createEntry.SLICE_HINT_PENDING_INTENT"

        /** @hide **/
        @JvmStatic
        fun toSlice(
            pendingIntent: PendingIntent
        ): Slice {
            // TODO("Use the right type and revision")
            val sliceBuilder = Slice.Builder(Uri.EMPTY, SliceSpec("type", 1))
            sliceBuilder.addAction(
                pendingIntent,
                Slice.Builder(sliceBuilder)
                    .addHints(Collections.singletonList(SLICE_HINT_PENDING_INTENT))
                    .build(),
                /*subType=*/null
            )
            return sliceBuilder.build()
        }

        /**
         * Returns an instance of [RemoteCreateEntry] derived from a [Slice] object.
         *
         * @param slice the [Slice] object constructed through [toSlice]
         *
         * @hide
         */
        @SuppressLint("WrongConstant") // custom conversion between jetpack and framework
        @JvmStatic
        fun fromSlice(slice: Slice): RemoteCreateEntry? {
            // TODO("Put the right spec and version value")
            var pendingIntent: PendingIntent? = null
            slice.items.forEach {
                if (it.hasHint(SLICE_HINT_PENDING_INTENT)) {
                    pendingIntent = it.action
                }
            }
            return try {
                RemoteCreateEntry(pendingIntent!!)
            } catch (e: Exception) {
                Log.i(TAG, "fromSlice failed with: " + e.message)
                null
            }
        }

        @JvmField val CREATOR: Parcelable.Creator<RemoteCreateEntry> =
            object : Parcelable.Creator<RemoteCreateEntry> {
                override fun createFromParcel(p0: Parcel?): RemoteCreateEntry? {
                    val createEntry = android.service.credentials.CreateEntry
                        .CREATOR.createFromParcel(p0)
                    return fromSlice(createEntry.slice)
                }

                @Suppress("ArrayReturn")
                override fun newArray(size: Int): Array<RemoteCreateEntry?> {
                    return arrayOfNulls(size)
                }
            }
    }
    }