adservices/apk/java/com/android/adservices/ui/settings/viewmodels/MainViewModel.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.adservices.ui.settings.viewmodels;

import android.app.Application;

import androidx.annotation.NonNull;
import androidx.annotation.VisibleForTesting;
import androidx.lifecycle.AndroidViewModel;
import androidx.lifecycle.LiveData;
import androidx.lifecycle.MutableLiveData;

import com.android.adservices.service.consent.ConsentManager;
import com.android.adservices.ui.settings.fragments.AdServicesSettingsAppsFragment;
import com.android.adservices.ui.settings.fragments.AdServicesSettingsMainFragment;
import com.android.adservices.ui.settings.fragments.AdServicesSettingsTopicsFragment;
import com.android.settingslib.widget.MainSwitchBar;

/**
 * View model for the main view of the AdServices Settings App. This view model is responsible
 * for serving consent to the main view, and interacting with the {@link ConsentManager} that
 * persists the user consent data in a storage.
 */
public class MainViewModel extends AndroidViewModel {
    private final MutableLiveData<MainViewModelUiEvent> mEventTrigger = new MutableLiveData<>();
    private final MutableLiveData<Boolean> mAdServicesConsent;
    private final ConsentManager mConsentManager;

    /** UI event triggered by view model */
    public enum MainViewModelUiEvent {
        SWITCH_ON_PRIVACY_SANDBOX_BETA,
        SWITCH_OFF_PRIVACY_SANDBOX_BETA,
        DISPLAY_TOPICS_FRAGMENT,
        DISPLAY_APPS_FRAGMENT,
    }

    public MainViewModel(@NonNull Application application) {
        this(application, ConsentManager.getInstance(application));
    }

    @VisibleForTesting
    public MainViewModel(@NonNull Application application, ConsentManager consentManager) {
        super(application);
        mConsentManager = consentManager;
        mAdServicesConsent = new MutableLiveData<>(getConsentFromConsentManager());
    }

    /**
     * Provides {@link AdServicesApiConsent} displayed in {@link AdServicesSettingsMainFragment}
     * as a Switch value.
     *
     * @return {@link mAdServicesConsent} indicates if user has consented to PP API usage.
     */
    public MutableLiveData<Boolean> getConsent() {
        return mAdServicesConsent;
    }

    /**
     * Sets the user consent for PP APIs.
     *
     * @param newConsentValue the new value that user consent should be set to for PP APIs.
     */
    public void setConsent(Boolean newConsentValue) {
        if (newConsentValue) {
            mConsentManager.enable(getApplication());
        } else {
            mConsentManager.disable(getApplication());
        }
        mAdServicesConsent.postValue(getConsentFromConsentManager());
    }

    /** Returns an observable but immutable event enum representing an view action on UI. */
    public LiveData<MainViewModelUiEvent> getUiEvents() {
        return mEventTrigger;
    }

    /**
     * Sets the UI Event as handled so the action will not be handled again if activity is
     * recreated.
     */
    public void uiEventHandled() {
        mEventTrigger.postValue(null);
    }

    /** Triggers {@link AdServicesSettingsTopicsFragment}. */
    public void topicsButtonClickHandler() {
        mEventTrigger.postValue(MainViewModelUiEvent.DISPLAY_TOPICS_FRAGMENT);
    }

    /** Triggers {@link AdServicesSettingsAppsFragment}. */
    public void appsButtonClickHandler() {
        mEventTrigger.postValue(MainViewModelUiEvent.DISPLAY_APPS_FRAGMENT);
    }

    /**
     * Triggers opt out process for Privacy Sandbox. Also reverts the switch state, since
     * confirmation dialog will handle switch change.
     */
    public void consentSwitchClickHandler(MainSwitchBar mainSwitchBar) {
        if (mainSwitchBar.isChecked()) {
            mainSwitchBar.setChecked(false);
            mEventTrigger.postValue(MainViewModelUiEvent.SWITCH_ON_PRIVACY_SANDBOX_BETA);
        } else {
            mainSwitchBar.setChecked(true);
            mEventTrigger.postValue(MainViewModelUiEvent.SWITCH_OFF_PRIVACY_SANDBOX_BETA);
        }
    }

    private boolean getConsentFromConsentManager() {
        return mConsentManager.getConsent(getApplication().getPackageManager()).isGiven();
    }
}