src/com/android/settings/accessibility/VibrationRampingRingerTogglePreferenceController.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.settings.accessibility;

import android.content.Context;
import android.database.ContentObserver;
import android.media.AudioManager;
import android.net.Uri;
import android.os.Handler;
import android.os.Looper;
import android.os.Vibrator;
import android.provider.DeviceConfig;
import android.provider.Settings;

import androidx.preference.Preference;
import androidx.preference.PreferenceScreen;

import com.android.settings.R;
import com.android.settings.Utils;
import com.android.settings.core.TogglePreferenceController;
import com.android.settingslib.core.lifecycle.LifecycleObserver;
import com.android.settingslib.core.lifecycle.events.OnStart;
import com.android.settingslib.core.lifecycle.events.OnStop;

/**
 * Preference controller for the ramping ringer setting key, controlled via {@link AudioManager}.
 *
 * <p>This preference depends on the {@link Settings.System#RING_VIBRATION_INTENSITY}, and it will
 * be disabled and display the unchecked state when the ring intensity is set to OFF. The actual
 * ramping ringer setting will not be overwritten when the ring intensity is turned off, so the
 * user original value will be naturally restored when the ring intensity is enabled again.
 */
public class VibrationRampingRingerTogglePreferenceController
        extends TogglePreferenceController implements LifecycleObserver, OnStart, OnStop {

    /** Wrapper around static {@link DeviceConfig} accessor for testing. */
    protected static class DeviceConfigProvider {
        public boolean isRampingRingerEnabledOnTelephonyConfig() {
            return DeviceConfig.getBoolean(DeviceConfig.NAMESPACE_TELEPHONY,
                    "ramping_ringer_enabled", false);
        }
    }

    private final DeviceConfigProvider mDeviceConfigProvider;
    private final ContentObserver mSettingObserver;
    private final AudioManager mAudioManager;
    private final VibrationPreferenceConfig mRingVibrationPreferenceConfig;
    private final VibrationPreferenceConfig.SettingObserver mRingSettingObserver;

    private Preference mPreference;

    public VibrationRampingRingerTogglePreferenceController(Context context, String preferenceKey) {
        this(context, preferenceKey, new DeviceConfigProvider());
    }

    protected VibrationRampingRingerTogglePreferenceController(Context context,
            String preferenceKey, DeviceConfigProvider deviceConfigProvider) {
        super(context, preferenceKey);
        mDeviceConfigProvider = deviceConfigProvider;
        mAudioManager = context.getSystemService(AudioManager.class);
        mRingVibrationPreferenceConfig = new RingVibrationPreferenceConfig(context);
        mRingSettingObserver = new VibrationPreferenceConfig.SettingObserver(
                mRingVibrationPreferenceConfig);
        Handler handler = Looper.myLooper() != null ? new Handler(/* async= */ true) : null;
        mSettingObserver = new ContentObserver(handler) {
            @Override
            public void onChange(boolean selfChange, Uri uri) {
                updateState(mPreference);
            }
        };
    }

    @Override
    public int getAvailabilityStatus() {
        final boolean rampingRingerEnabledOnTelephonyConfig =
                mDeviceConfigProvider.isRampingRingerEnabledOnTelephonyConfig();
        return (Utils.isVoiceCapable(mContext) && !rampingRingerEnabledOnTelephonyConfig)
                ? AVAILABLE
                : UNSUPPORTED_ON_DEVICE;
    }

    @Override
    public void onStart() {
        mRingSettingObserver.register(mContext);
        mContext.getContentResolver().registerContentObserver(
                Settings.System.getUriFor(Settings.System.APPLY_RAMPING_RINGER),
                /* notifyForDescendants= */ false,
                mSettingObserver);
    }

    @Override
    public void onStop() {
        mRingSettingObserver.unregister(mContext);
        mContext.getContentResolver().unregisterContentObserver(mSettingObserver);
    }

    @Override
    public void displayPreference(PreferenceScreen screen) {
        super.displayPreference(screen);
        mPreference = screen.findPreference(getPreferenceKey());
        mRingSettingObserver.onDisplayPreference(this, mPreference);
        mPreference.setEnabled(isRingVibrationEnabled());
    }

    @Override
    public boolean isChecked() {
        return isRingVibrationEnabled() && mAudioManager.isRampingRingerEnabled();
    }

    @Override
    public boolean setChecked(boolean isChecked) {
        if (isRingVibrationEnabled()) {
            // Don't update ramping ringer setting value if ring vibration is disabled.
            mAudioManager.setRampingRingerEnabled(isChecked);

            if (isChecked) {
                // Vibrate when toggle is enabled for consistency with all the other toggle/slides
                // in the same screen.
                mRingVibrationPreferenceConfig.playVibrationPreview();
            }
        }
        return true;
    }

    @Override
    public int getSliceHighlightMenuRes() {
        return R.string.menu_key_accessibility;
    }

    @Override
    public void updateState(Preference preference) {
        super.updateState(preference);
        if (preference != null) {
            preference.setEnabled(isRingVibrationEnabled());
        }
    }

    private boolean isRingVibrationEnabled() {
        return mRingVibrationPreferenceConfig.isPreferenceEnabled()
                && (mRingVibrationPreferenceConfig.readIntensity()
                != Vibrator.VIBRATION_INTENSITY_OFF);
    }
}