nearby/service/java/com/android/server/nearby/provider/FastPairDataProvider.java

/*
 * Copyright (C) 2021 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.server.nearby.provider;

import android.accounts.Account;
import android.annotation.Nullable;
import android.content.Context;
import android.nearby.FastPairDataProviderService;
import android.nearby.aidl.ByteArrayParcel;
import android.nearby.aidl.FastPairAccountDevicesMetadataRequestParcel;
import android.nearby.aidl.FastPairAntispoofKeyDeviceMetadataRequestParcel;
import android.nearby.aidl.FastPairEligibleAccountsRequestParcel;
import android.nearby.aidl.FastPairManageAccountDeviceRequestParcel;
import android.nearby.aidl.FastPairManageAccountRequestParcel;
import android.util.Log;

import androidx.annotation.WorkerThread;

import com.android.internal.annotations.VisibleForTesting;
import com.android.server.nearby.fastpair.footprint.FastPairUploadInfo;

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

import service.proto.Data;
import service.proto.Rpcs;

/**
 * FastPairDataProvider is a singleton that implements APIs to get FastPair data.
 */
public class FastPairDataProvider {

    private static final String TAG = "FastPairDataProvider";

    private static FastPairDataProvider sInstance;

    private ProxyFastPairDataProvider mProxyFastPairDataProvider;

    /**
     * Initializes FastPairDataProvider singleton.
     */
    public static synchronized FastPairDataProvider init(Context context) {
        if (sInstance == null) {
            sInstance = new FastPairDataProvider(context);
        }
        if (sInstance.mProxyFastPairDataProvider == null) {
            Log.w(TAG, "no proxy fast pair data provider found");
        } else {
            sInstance.mProxyFastPairDataProvider.register();
        }
        return sInstance;
    }

    @Nullable
    public static synchronized FastPairDataProvider getInstance() {
        return sInstance;
    }

    private FastPairDataProvider(Context context) {
        mProxyFastPairDataProvider = ProxyFastPairDataProvider.create(
                context, FastPairDataProviderService.ACTION_FAST_PAIR_DATA_PROVIDER);
        if (mProxyFastPairDataProvider == null) {
            Log.d("FastPairService", "fail to initiate the fast pair proxy provider");
        } else {
            Log.d("FastPairService", "the fast pair proxy provider initiated");
        }
    }

    @VisibleForTesting
    void setProxyDataProvider(ProxyFastPairDataProvider proxyFastPairDataProvider) {
        this.mProxyFastPairDataProvider = proxyFastPairDataProvider;
    }

    /**
     * Loads FastPairAntispoofKeyDeviceMetadata.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    @WorkerThread
    @Nullable
    public Rpcs.GetObservedDeviceResponse loadFastPairAntispoofKeyDeviceMetadata(byte[] modelId) {
        if (mProxyFastPairDataProvider != null) {
            FastPairAntispoofKeyDeviceMetadataRequestParcel requestParcel =
                    new FastPairAntispoofKeyDeviceMetadataRequestParcel();
            requestParcel.modelId = modelId;
            return Utils.convertToGetObservedDeviceResponse(
                    mProxyFastPairDataProvider
                            .loadFastPairAntispoofKeyDeviceMetadata(requestParcel));
        }
        throw new IllegalStateException("No ProxyFastPairDataProvider yet constructed");
    }

    /**
     * Enrolls an account to Fast Pair.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    public void optIn(Account account) {
        if (mProxyFastPairDataProvider != null) {
            FastPairManageAccountRequestParcel requestParcel =
                    new FastPairManageAccountRequestParcel();
            requestParcel.account = account;
            requestParcel.requestType = FastPairDataProviderService.MANAGE_REQUEST_ADD;
            mProxyFastPairDataProvider.manageFastPairAccount(requestParcel);
            return;
        }
        throw new IllegalStateException("No ProxyFastPairDataProvider yet constructed");
    }

    /**
     * Uploads the device info to Fast Pair account.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    public void upload(Account account, FastPairUploadInfo uploadInfo) {
        if (mProxyFastPairDataProvider != null) {
            FastPairManageAccountDeviceRequestParcel requestParcel =
                    new FastPairManageAccountDeviceRequestParcel();
            requestParcel.account = account;
            requestParcel.requestType = FastPairDataProviderService.MANAGE_REQUEST_ADD;
            requestParcel.accountKeyDeviceMetadata =
                    Utils.convertToFastPairAccountKeyDeviceMetadata(uploadInfo);
            mProxyFastPairDataProvider.manageFastPairAccountDevice(requestParcel);
            return;
        }
        throw new IllegalStateException("No ProxyFastPairDataProvider yet constructed");
    }

    /**
     * Loads FastPair device accountKeys for a given account, but not other detailed fields.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    public List<Data.FastPairDeviceWithAccountKey> loadFastPairDeviceWithAccountKey(
            Account account) {
        return loadFastPairDeviceWithAccountKey(account, new ArrayList<byte[]>(0));
    }

    /**
     * Loads FastPair devices for a list of accountKeys of a given account.
     *
     * @param account The account of the FastPair devices.
     * @param deviceAccountKeys The allow list of FastPair devices if it is not empty. Otherwise,
     *                    the function returns accountKeys of all FastPair devices under the
     *                    account, without detailed fields.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    public List<Data.FastPairDeviceWithAccountKey> loadFastPairDeviceWithAccountKey(
            Account account, List<byte[]> deviceAccountKeys) {
        if (mProxyFastPairDataProvider != null) {
            FastPairAccountDevicesMetadataRequestParcel requestParcel =
                    new FastPairAccountDevicesMetadataRequestParcel();
            requestParcel.account = account;
            requestParcel.deviceAccountKeys = new ByteArrayParcel[deviceAccountKeys.size()];
            int i = 0;
            for (byte[] deviceAccountKey : deviceAccountKeys) {
                requestParcel.deviceAccountKeys[i] = new ByteArrayParcel();
                requestParcel.deviceAccountKeys[i].byteArray = deviceAccountKey;
                i = i + 1;
            }
            return Utils.convertToFastPairDevicesWithAccountKey(
                    mProxyFastPairDataProvider.loadFastPairAccountDevicesMetadata(requestParcel));
        }
        throw new IllegalStateException("No ProxyFastPairDataProvider yet constructed");
    }

    /**
     * Loads FastPair Eligible Accounts.
     *
     * @throws IllegalStateException If ProxyFastPairDataProvider is not available.
     */
    public List<Account> loadFastPairEligibleAccounts() {
        if (mProxyFastPairDataProvider != null) {
            FastPairEligibleAccountsRequestParcel requestParcel =
                    new FastPairEligibleAccountsRequestParcel();
            return Utils.convertToAccountList(
                    mProxyFastPairDataProvider.loadFastPairEligibleAccounts(requestParcel));
        }
        throw new IllegalStateException("No ProxyFastPairDataProvider yet constructed");
    }
}