xref: /aosp_15_r20/external/robolectric/shadows/framework/src/main/java/org/robolectric/shadows/ShadowPowerManager.java (revision e6ba16074e6af37d123cb567d575f496bf0a58ee)

package org.robolectric.shadows;

import static android.content.Intent.ACTION_SCREEN_OFF;
import static android.content.Intent.ACTION_SCREEN_ON;
import static android.os.Build.VERSION_CODES.M;
import static android.os.Build.VERSION_CODES.N;
import static android.os.Build.VERSION_CODES.O;
import static android.os.Build.VERSION_CODES.P;
import static android.os.Build.VERSION_CODES.Q;
import static android.os.Build.VERSION_CODES.R;
import static android.os.Build.VERSION_CODES.S;
import static android.os.Build.VERSION_CODES.TIRAMISU;
import static android.os.Build.VERSION_CODES.UPSIDE_DOWN_CAKE;
import static com.google.common.base.Preconditions.checkState;
import static java.util.Comparator.comparing;
import static java.util.stream.Collectors.toCollection;
import static org.robolectric.util.reflector.Reflector.reflector;

import android.annotation.NonNull;
import android.annotation.Nullable;
import android.annotation.RequiresPermission;
import android.annotation.SystemApi;
import android.annotation.TargetApi;
import android.content.Context;
import android.content.Intent;
import android.os.Binder;
import android.os.PowerManager;
import android.os.PowerManager.LowPowerStandbyPortDescription;
import android.os.PowerManager.LowPowerStandbyPortsLock;
import android.os.PowerManager.WakeLock;
import android.os.SystemClock;
import android.os.WorkSource;
import com.google.common.collect.ImmutableSet;
import java.time.Duration;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import org.robolectric.RuntimeEnvironment;
import org.robolectric.annotation.ClassName;
import org.robolectric.annotation.HiddenApi;
import org.robolectric.annotation.Implementation;
import org.robolectric.annotation.Implements;
import org.robolectric.annotation.RealObject;
import org.robolectric.annotation.Resetter;
import org.robolectric.shadow.api.Shadow;
import org.robolectric.util.reflector.Accessor;
import org.robolectric.util.reflector.Direct;
import org.robolectric.util.reflector.ForType;

/** Shadow of PowerManager */
@Implements(value = PowerManager.class)
public class ShadowPowerManager {

  @RealObject private PowerManager realPowerManager;

  private static boolean isInteractive = true;
  private static boolean isPowerSaveMode = false;
  private static boolean isDeviceIdleMode = false;
  private static boolean isLightDeviceIdleMode = false;
  @Nullable private static Duration batteryDischargePrediction = null;
  private static boolean isBatteryDischargePredictionPersonalized = false;

  @PowerManager.LocationPowerSaveMode
  private static int locationMode = PowerManager.LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF;

  private static final List<String> rebootReasons = new ArrayList<>();
  private static final Map<String, Boolean> ignoringBatteryOptimizations = new HashMap<>();

  private static int thermalStatus = 0;
  // Intentionally use Object instead of PowerManager.OnThermalStatusChangedListener to avoid
  // ClassLoader exceptions on earlier SDKs that don't have this class.
  private static final Set<Object> thermalListeners = new HashSet<>();

  private static final Set<String> ambientDisplaySuppressionTokens =
      Collections.synchronizedSet(new HashSet<>());
  private static volatile boolean isAmbientDisplayAvailable = true;
  private static volatile boolean isRebootingUserspaceSupported = false;
  private static volatile boolean adaptivePowerSaveEnabled = false;

  private static PowerManager.WakeLock latestWakeLock;

  private static boolean lowPowerStandbyEnabled = false;
  private static boolean lowPowerStandbySupported = false;
  private static boolean exemptFromLowPowerStandby = false;
  private static final Set<String> allowedFeatures = new HashSet<String>();

  @Implementation
  protected PowerManager.WakeLock newWakeLock(int flags, String tag) {
    PowerManager.WakeLock wl =
        reflector(PowerManagerReflector.class, realPowerManager).newWakeLock(flags, tag);
    latestWakeLock = wl;
    return wl;
  }

  @Implementation
  protected boolean isScreenOn() {
    return isInteractive;
  }

  /**
   * @deprecated Use {@link #turnScreenOn(boolean)} instead.
   */
  @Deprecated
  public void setIsScreenOn(boolean screenOn) {
    setIsInteractive(screenOn);
  }

  @Implementation
  protected boolean isInteractive() {
    return isInteractive;
  }

  /**
   * @deprecated Prefer {@link #turnScreenOn(boolean)} instead.
   */
  @Deprecated
  public void setIsInteractive(boolean interactive) {
    isInteractive = interactive;
  }

  /** Emulates turning the screen on/off if the screen is not already on/off. */
  public void turnScreenOn(boolean screenOn) {
    if (isInteractive != screenOn) {
      isInteractive = screenOn;
      getContext().sendBroadcast(new Intent(screenOn ? ACTION_SCREEN_ON : ACTION_SCREEN_OFF));
    }
  }

  @Implementation
  protected boolean isPowerSaveMode() {
    return isPowerSaveMode;
  }

  public void setIsPowerSaveMode(boolean powerSaveMode) {
    isPowerSaveMode = powerSaveMode;
  }

  private Map<Integer, Boolean> supportedWakeLockLevels = new HashMap<>();

  @Implementation
  protected boolean isWakeLockLevelSupported(int level) {
    return supportedWakeLockLevels.containsKey(level) ? supportedWakeLockLevels.get(level) : false;
  }

  public void setIsWakeLockLevelSupported(int level, boolean supported) {
    supportedWakeLockLevels.put(level, supported);
  }

  /**
   * @return false by default, or the value specified via {@link #setIsDeviceIdleMode(boolean)}
   */
  @Implementation(minSdk = M)
  protected boolean isDeviceIdleMode() {
    return isDeviceIdleMode;
  }

  /** Sets the value returned by {@link #isDeviceIdleMode()}. */
  public void setIsDeviceIdleMode(boolean isDeviceIdleMode) {
    this.isDeviceIdleMode = isDeviceIdleMode;
    getContext().sendBroadcast(new Intent(PowerManager.ACTION_DEVICE_IDLE_MODE_CHANGED));
  }

  /**
   * @return false by default, or the value specified via {@link #setIsLightDeviceIdleMode(boolean)}
   */
  @Implementation(minSdk = N)
  protected boolean isLightDeviceIdleMode() {
    return isLightDeviceIdleMode;
  }

  /** Sets the value returned by {@link #isLightDeviceIdleMode()}. */
  public void setIsLightDeviceIdleMode(boolean lightDeviceIdleMode) {
    isLightDeviceIdleMode = lightDeviceIdleMode;
  }

  @Implementation(minSdk = TIRAMISU)
  protected boolean isDeviceLightIdleMode() {
    return isLightDeviceIdleMode();
  }

  /** Sets the value returned by {@link #isDeviceLightIdleMode()}. */
  public void setIsDeviceLightIdleMode(boolean lightDeviceIdleMode) {
    setIsLightDeviceIdleMode(lightDeviceIdleMode);
  }

  /**
   * Returns how location features should behave when battery saver is on. When battery saver is
   * off, this will always return {@link #LOCATION_MODE_NO_CHANGE}.
   */
  @Implementation(minSdk = P)
  @PowerManager.LocationPowerSaveMode
  protected int getLocationPowerSaveMode() {
    if (!isPowerSaveMode()) {
      return PowerManager.LOCATION_MODE_NO_CHANGE;
    }
    return locationMode;
  }

  /** Sets the value returned by {@link #getLocationPowerSaveMode()} when battery saver is on. */
  public void setLocationPowerSaveMode(@PowerManager.LocationPowerSaveMode int locationMode) {
    checkState(
        locationMode >= PowerManager.MIN_LOCATION_MODE,
        "Location Power Save Mode must be at least " + PowerManager.MIN_LOCATION_MODE);
    checkState(
        locationMode <= PowerManager.MAX_LOCATION_MODE,
        "Location Power Save Mode must be no more than " + PowerManager.MAX_LOCATION_MODE);
    this.locationMode = locationMode;
  }

  /** This function returns the current thermal status of the device. */
  @Implementation(minSdk = Q)
  protected int getCurrentThermalStatus() {
    return thermalStatus;
  }

  /** This function adds a listener for thermal status change. */
  @Implementation(minSdk = Q)
  protected void addThermalStatusListener(
      @ClassName("android.os.PowerManager$OnThermalStatusChangedListener") Object listener) {
    checkState(
        listener instanceof PowerManager.OnThermalStatusChangedListener,
        "Listener must implement PowerManager.OnThermalStatusChangedListener");
    this.thermalListeners.add(listener);
  }

  /** This function gets listeners for thermal status change. */
  public ImmutableSet<Object> getThermalStatusListeners() {
    return ImmutableSet.copyOf(this.thermalListeners);
  }

  /** This function removes a listener for thermal status change. */
  @Implementation(minSdk = Q)
  protected void removeThermalStatusListener(
      @ClassName("android.os.PowerManager$OnThermalStatusChangedListener") Object listener) {
    checkState(
        listener instanceof PowerManager.OnThermalStatusChangedListener,
        "Listener must implement PowerManager.OnThermalStatusChangedListener");
    this.thermalListeners.remove(listener);
  }

  /** Sets the value returned by {@link #getCurrentThermalStatus()}. */
  public void setCurrentThermalStatus(int thermalStatus) {
    checkState(
        thermalStatus >= PowerManager.THERMAL_STATUS_NONE,
        "Thermal status must be at least " + PowerManager.THERMAL_STATUS_NONE);
    checkState(
        thermalStatus <= PowerManager.THERMAL_STATUS_SHUTDOWN,
        "Thermal status must be no more than " + PowerManager.THERMAL_STATUS_SHUTDOWN);
    this.thermalStatus = thermalStatus;
    for (Object listener : thermalListeners) {
      ((PowerManager.OnThermalStatusChangedListener) listener)
          .onThermalStatusChanged(thermalStatus);
    }
  }

  /** Discards the most recent {@code PowerManager.WakeLock}s */
  @Resetter
  public static void reset() {
    isInteractive = true;
    isPowerSaveMode = false;
    isDeviceIdleMode = false;
    isLightDeviceIdleMode = false;
    batteryDischargePrediction = null;
    isBatteryDischargePredictionPersonalized = false;
    locationMode = PowerManager.LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF;
    rebootReasons.clear();
    ignoringBatteryOptimizations.clear();
    thermalStatus = 0;
    thermalListeners.clear();
    ambientDisplaySuppressionTokens.clear();
    isAmbientDisplayAvailable = true;
    isRebootingUserspaceSupported = false;
    adaptivePowerSaveEnabled = false;
    latestWakeLock = null;
    lowPowerStandbyEnabled = false;
    lowPowerStandbySupported = false;
    exemptFromLowPowerStandby = false;
    allowedFeatures.clear();
    clearWakeLocks();
  }

  /**
   * Retrieves the most recent wakelock registered by the application
   *
   * @return Most recent wake lock.
   */
  public static PowerManager.WakeLock getLatestWakeLock() {
    return latestWakeLock;
  }

  /** Clears most recent recorded wakelock. */
  public static void clearWakeLocks() {
    latestWakeLock = null;
  }

  /**
   * Controls result from {@link #getLatestWakeLock()}
   *
   * @deprecated do not use
   */
  @Deprecated
  static void addWakeLock(WakeLock wl) {
    latestWakeLock = wl;
  }

  @Implementation(minSdk = M)
  protected boolean isIgnoringBatteryOptimizations(String packageName) {
    Boolean result = ignoringBatteryOptimizations.get(packageName);
    return result == null ? false : result;
  }

  public void setIgnoringBatteryOptimizations(String packageName, boolean value) {
    ignoringBatteryOptimizations.put(packageName, Boolean.valueOf(value));
  }

  /**
   * Differs from real implementation as device charging state is not checked.
   *
   * @param timeRemaining The time remaining as a {@link Duration}.
   * @param isPersonalized true if personalized based on device usage history, false otherwise.
   */
  @SystemApi
  @RequiresPermission(android.Manifest.permission.DEVICE_POWER)
  @Implementation(minSdk = S)
  protected void setBatteryDischargePrediction(
      @NonNull Duration timeRemaining, boolean isPersonalized) {
    this.batteryDischargePrediction = timeRemaining;
    this.isBatteryDischargePredictionPersonalized = isPersonalized;
  }

  /**
   * Returns the current battery life remaining estimate.
   *
   * <p>Differs from real implementation as the time that {@link #setBatteryDischargePrediction} was
   * called is not taken into account.
   *
   * @return The estimated battery life remaining as a {@link Duration}. Will be {@code null} if the
   *     prediction has not been set.
   */
  @Nullable
  @Implementation(minSdk = S)
  protected Duration getBatteryDischargePrediction() {
    return this.batteryDischargePrediction;
  }

  /**
   * Returns whether the current battery life remaining estimate is personalized based on device
   * usage history or not. This value does not take a device's powered or charging state into
   * account.
   *
   * @return A boolean indicating if the current discharge estimate is personalized based on
   *     historical device usage or not.
   */
  @Implementation(minSdk = S)
  protected boolean isBatteryDischargePredictionPersonalized() {
    return this.isBatteryDischargePredictionPersonalized;
  }

  @Implementation
  protected void reboot(@Nullable String reason) {
    if (RuntimeEnvironment.getApiLevel() >= R
        && "userspace".equals(reason)
        && !isRebootingUserspaceSupported()) {
      throw new UnsupportedOperationException(
          "Attempted userspace reboot on a device that doesn't support it");
    }
    rebootReasons.add(reason);
  }

  /** Returns the number of times {@link #reboot(String)} was called. */
  public int getTimesRebooted() {
    return rebootReasons.size();
  }

  /**
   * Returns the list of reasons for each reboot, in chronological order. May contain {@code null}.
   */
  public List<String> getRebootReasons() {
    return new ArrayList<>(rebootReasons);
  }

  /** Sets the value returned by {@link #isAmbientDisplayAvailable()}. */
  public void setAmbientDisplayAvailable(boolean available) {
    this.isAmbientDisplayAvailable = available;
  }

  /** Sets the value returned by {@link #isRebootingUserspaceSupported()}. */
  public void setIsRebootingUserspaceSupported(boolean supported) {
    this.isRebootingUserspaceSupported = supported;
  }

  /**
   * Returns true by default, or the value specified via {@link
   * #setAmbientDisplayAvailable(boolean)}.
   */
  @Implementation(minSdk = R)
  protected boolean isAmbientDisplayAvailable() {
    return isAmbientDisplayAvailable;
  }

  /**
   * If true, suppress the device's ambient display. Ambient display is defined as anything visible
   * on the display when {@link PowerManager#isInteractive} is false.
   *
   * @param token An identifier for the ambient display suppression.
   * @param suppress If {@code true}, suppresses the ambient display. Otherwise, unsuppresses the
   *     ambient display for the given token.
   */
  @Implementation(minSdk = R)
  protected void suppressAmbientDisplay(String token, boolean suppress) {
    String suppressionToken = Binder.getCallingUid() + "_" + token;
    if (suppress) {
      ambientDisplaySuppressionTokens.add(suppressionToken);
    } else {
      ambientDisplaySuppressionTokens.remove(suppressionToken);
    }
  }

  /**
   * Returns true if {@link #suppressAmbientDisplay(String, boolean)} has been called with any
   * token.
   */
  @Implementation(minSdk = R)
  protected boolean isAmbientDisplaySuppressed() {
    return !ambientDisplaySuppressionTokens.isEmpty();
  }

  /**
   * Returns last value specified in {@link #setIsRebootingUserspaceSupported(boolean)} or {@code
   * false} by default.
   */
  @Implementation(minSdk = R)
  protected boolean isRebootingUserspaceSupported() {
    return isRebootingUserspaceSupported;
  }

  /**
   * Sets whether Adaptive Power Saver is enabled.
   *
   * <p>This has no effect, other than the value of {@link #getAdaptivePowerSaveEnabled()} is
   * changed, which can be used to ensure this method is called correctly.
   *
   * @return true if the value has changed.
   */
  @Implementation(minSdk = Q)
  @SystemApi
  protected boolean setAdaptivePowerSaveEnabled(boolean enabled) {
    boolean changed = adaptivePowerSaveEnabled != enabled;
    adaptivePowerSaveEnabled = enabled;
    return changed;
  }

  /** Gets the value set by {@link #setAdaptivePowerSaveEnabled(boolean)}. */
  public boolean getAdaptivePowerSaveEnabled() {
    return adaptivePowerSaveEnabled;
  }

  @Implements(PowerManager.WakeLock.class)
  public static class ShadowWakeLock {
    @RealObject private PowerManager.WakeLock realWakeLock;

    private boolean refCounted = true;
    private WorkSource workSource = null;
    private int timesHeld = 0;
    private List<Optional<Long>> timeoutTimestampList = new ArrayList<>();

    private void acquireInternal(Optional<Long> timeoutOptional) {
      ++timesHeld;
      timeoutTimestampList.add(timeoutOptional);
    }

    /** Iterate all the wake lock and remove those timeouted ones. */
    private void refreshTimeoutTimestampList() {
      timeoutTimestampList =
          timeoutTimestampList.stream()
              .filter(o -> !o.isPresent() || o.get() >= SystemClock.elapsedRealtime())
              .collect(toCollection(ArrayList::new));
    }

    @Implementation
    protected void acquire() {
      acquireInternal(Optional.empty());
    }

    @Implementation
    protected synchronized void acquire(long timeout) {
      Long timeoutMillis = timeout + SystemClock.elapsedRealtime();
      if (timeoutMillis > 0) {
        acquireInternal(Optional.of(timeoutMillis));
      } else {
        // This is because many existing tests use Long.MAX_VALUE as timeout, which will cause a
        // long overflow.
        acquireInternal(Optional.empty());
      }
    }

    /** Releases the wake lock. The {@code flags} are ignored. */
    @Implementation
    protected synchronized void release(int flags) {
      refreshTimeoutTimestampList();

      // Dequeue the wake lock with smallest timeout.
      // Map the subtracted value to 1 and -1 to avoid long->int cast overflow.
      Optional<Optional<Long>> wakeLockOptional =
          timeoutTimestampList.stream()
              .min(
                  comparing(
                      (Optional<Long> arg) -> arg.orElse(Long.MAX_VALUE),
                      (Long leftProperty, Long rightProperty) ->
                          (leftProperty - rightProperty) > 0 ? 1 : -1));

      if (wakeLockOptional.isEmpty()) {
        if (refCounted) {
          throw new RuntimeException("WakeLock under-locked");
        } else {
          return;
        }
      }

      Optional<Long> wakeLock = wakeLockOptional.get();

      if (refCounted) {
        timeoutTimestampList.remove(wakeLock);
      } else {
        // If a wake lock is not reference counted, then one call to release() is sufficient to undo
        // the effect of all previous calls to acquire().
        timeoutTimestampList = new ArrayList<>();
      }
    }

    @Implementation
    protected synchronized boolean isHeld() {
      refreshTimeoutTimestampList();
      return !timeoutTimestampList.isEmpty();
    }

    /**
     * Retrieves if the wake lock is reference counted or not
     *
     * @return Is the wake lock reference counted?
     */
    public boolean isReferenceCounted() {
      return refCounted;
    }

    @Implementation
    protected void setReferenceCounted(boolean value) {
      refCounted = value;
    }

    @Implementation
    protected synchronized void setWorkSource(WorkSource ws) {
      workSource = ws;
    }

    public synchronized WorkSource getWorkSource() {
      return workSource;
    }

    /** Returns how many times the wakelock was held. */
    public int getTimesHeld() {
      return timesHeld;
    }

    /** Returns the tag. */
    @HiddenApi
    @Implementation(minSdk = O)
    public String getTag() {
      return reflector(WakeLockReflector.class, realWakeLock).getTag();
    }

    @ForType(PowerManager.WakeLock.class)
    private interface WakeLockReflector {
      @Accessor("mTag")
      String getTag();
    }
  }

  private Context getContext() {
    return reflector(PowerManagerReflector.class, realPowerManager).getContext();
  }

  @Implementation(minSdk = TIRAMISU)
  protected boolean isLowPowerStandbySupported() {
    return lowPowerStandbySupported;
  }

  @TargetApi(TIRAMISU)
  public void setLowPowerStandbySupported(boolean lowPowerStandbySupported) {
    this.lowPowerStandbySupported = lowPowerStandbySupported;
  }

  @Implementation(minSdk = TIRAMISU)
  protected boolean isLowPowerStandbyEnabled() {
    return lowPowerStandbySupported && lowPowerStandbyEnabled;
  }

  @Implementation(minSdk = TIRAMISU)
  public void setLowPowerStandbyEnabled(boolean lowPowerStandbyEnabled) {
    this.lowPowerStandbyEnabled = lowPowerStandbyEnabled;
  }

  @Implementation(minSdk = UPSIDE_DOWN_CAKE)
  protected boolean isAllowedInLowPowerStandby(String feature) {
    if (!lowPowerStandbySupported) {
      return true;
    }
    return allowedFeatures.contains(feature);
  }

  @TargetApi(UPSIDE_DOWN_CAKE)
  public void addAllowedInLowPowerStandby(String feature) {
    allowedFeatures.add(feature);
  }

  @Implementation(minSdk = UPSIDE_DOWN_CAKE)
  protected boolean isExemptFromLowPowerStandby() {
    if (!lowPowerStandbySupported) {
      return true;
    }
    return exemptFromLowPowerStandby;
  }

  @TargetApi(UPSIDE_DOWN_CAKE)
  public void setExemptFromLowPowerStandby(boolean exemptFromLowPowerStandby) {
    this.exemptFromLowPowerStandby = exemptFromLowPowerStandby;
  }

  @Implementation(minSdk = UPSIDE_DOWN_CAKE)
  protected @ClassName("android.os.PowerManager$LowPowerStandbyPortsLock") Object
      newLowPowerStandbyPortsLock(List<LowPowerStandbyPortDescription> ports) {
    PowerManager.LowPowerStandbyPortsLock lock =
        Shadow.newInstanceOf(PowerManager.LowPowerStandbyPortsLock.class);
    ((ShadowLowPowerStandbyPortsLock) Shadow.extract(lock)).setPorts(ports);
    return lock;
  }

  /** Shadow of {@link LowPowerStandbyPortsLock} to allow testing state. */
  @Implements(
      value = PowerManager.LowPowerStandbyPortsLock.class,
      minSdk = UPSIDE_DOWN_CAKE,
      isInAndroidSdk = false)
  public static class ShadowLowPowerStandbyPortsLock {
    private List<LowPowerStandbyPortDescription> ports;
    private boolean isAcquired = false;
    private int acquireCount = 0;

    @Implementation(minSdk = UPSIDE_DOWN_CAKE)
    protected void acquire() {
      isAcquired = true;
      acquireCount++;
    }

    @Implementation(minSdk = UPSIDE_DOWN_CAKE)
    protected void release() {
      isAcquired = false;
    }

    public boolean isAcquired() {
      return isAcquired;
    }

    public int getAcquireCount() {
      return acquireCount;
    }

    public void setPorts(List<LowPowerStandbyPortDescription> ports) {
      this.ports = ports;
    }

    public List<LowPowerStandbyPortDescription> getPorts() {
      return ports;
    }
  }

  /** Reflector interface for {@link PowerManager}'s internals. */
  @ForType(PowerManager.class)
  private interface PowerManagerReflector {

    @Accessor("mContext")
    Context getContext();

    @Direct
    WakeLock newWakeLock(int flags, String tag);
  }
}