Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit a4aee0d5 authored by Neil Fuller's avatar Neil Fuller
Browse files

Add status to TimeZoneCapabilitiesAndConfig 

Update LocationTimeZoneProviderController to report newly available
status information.

After this change, the location_time_zone_manager now informs the
time_zone_detector of status changes, not just suggestion changes. To
reflect this, the path from location_time_zone_manager to
time_zone_detector involves a new "LocationAlgorithmEvent" (which can
contain an optional suggestion) and not the suggestion directly.

In fact, location_time_zone_manager may over-notify (i.e. when neither
status nor suggestion have changed) to reflect internal state changes in
LocationTimeZoneProviderController, but the time_zone_detector can
easily recognize dupes and discard them while keeping the latest event
received for logging / debugging.

The reason for this change is so that time zone detector status
information can be added to TimeZoneCapabilitiesAndConfig for use by
SettingsUI in upcoming UI changes. The full structure is represented
(Overall detector -> Detection Algorithms -> Sub-components like time
zone providers) so that the UI folks can use what they want today.

The initial use is so that SettingsUI can show user alerts / warnings
about "bad" location settings that are blocking / degrading location
time zone provider behavior. This change is also included in this commit
so the whole end-to-end path is implemented.

When the detector status changes, the UI (TimeZoneListener) listeners
will now be informed.

Manual testing:

Various commands tried like:

adb shell cmd time_zone_detector handle_location_algorithm_event \
  --status '"LocationTimeZoneAlgorithmStatus{mAlgorithmStatus=RUNNING, mPrimaryProviderStatus=NOT_READY, mPrimaryProviderReportedStatus=null, mSecondaryProviderStatus=NOT_READY, mSecondaryProviderReportedStatus=null}"'

Bug: 236624675
Test: See manual test instructions
Test: atest services/tests/servicestests/src/com/android/server/timedetector/
Test: atest services/tests/servicestests/src/com/android/server/timezonedetector/
Test: atest ./tests/tests/time/src/android/app/time/cts/
Test: atest core/tests/coretests/src/android/service/timezone/
Test: atest core/tests/coretests/src/android/service/time/
Change-Id: I50636bf75ad2f57ddeb1dce829678cf354b2a05a
parent e13dc3f4

core/java/android/app/time/DetectorStatusTypes.java

0 → 100644
+227 −0
Original line number Diff line number Diff line 
/*

 * 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 android.app.time;



import android.annotation.IntDef;

import android.annotation.NonNull;

import android.annotation.Nullable;

import android.text.TextUtils;



import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;



/**

 * A set of constants that can relate to time or time zone detector status.

 *

 * <ul>

 *     <li>Detector status - the status of the overall detector.</li>

 *     <li>Detection algorithm status - the status of an algorithm that a detector can use.

 *     Each detector is expected to have one or more known algorithms to detect its chosen property,

 *     e.g. for time zone devices can have a "location" detection algorithm, where the device's

 *     location is used to detect the time zone.</li>

 * </ul>

 *

 * @hide

 */

public final class DetectorStatusTypes {



    /** A status code for a detector. */

    @IntDef(prefix = "DETECTOR_STATUS_", value = {

            DETECTOR_STATUS_UNKNOWN,

            DETECTOR_STATUS_NOT_SUPPORTED,

            DETECTOR_STATUS_NOT_RUNNING,

            DETECTOR_STATUS_RUNNING,

    })

    @Target(ElementType.TYPE_USE)

    @Retention(RetentionPolicy.SOURCE)

    public @interface DetectorStatus {}



    /**

     * The detector status is unknown. Expected only for use as a placeholder before the actual

     * status is known.

     */

    public static final @DetectorStatus int DETECTOR_STATUS_UNKNOWN = 0;



    /** The detector is not supported on this device. */

    public static final @DetectorStatus int DETECTOR_STATUS_NOT_SUPPORTED = 1;



    /** The detector is supported but is not running. */

    public static final @DetectorStatus int DETECTOR_STATUS_NOT_RUNNING = 2;



    /** The detector is supported and is running. */

    public static final @DetectorStatus int DETECTOR_STATUS_RUNNING = 3;



    private DetectorStatusTypes() {}



    /**

     * A status code for a detection algorithm.

     */

    @IntDef(prefix = "DETECTION_ALGORITHM_STATUS_", value = {

            DETECTION_ALGORITHM_STATUS_UNKNOWN,

            DETECTION_ALGORITHM_STATUS_NOT_SUPPORTED,

            DETECTION_ALGORITHM_STATUS_NOT_RUNNING,

            DETECTION_ALGORITHM_STATUS_RUNNING,

    })

    @Target(ElementType.TYPE_USE)

    @Retention(RetentionPolicy.SOURCE)

    public @interface DetectionAlgorithmStatus {}



    /**

     * The detection algorithm status is unknown. Expected only for use as a placeholder before the

     * actual status is known.

     */

    public static final @DetectionAlgorithmStatus int DETECTION_ALGORITHM_STATUS_UNKNOWN = 0;



    /** The detection algorithm is not supported on this device. */

    public static final @DetectionAlgorithmStatus int DETECTION_ALGORITHM_STATUS_NOT_SUPPORTED = 1;



    /** The detection algorithm supported but is not running. */

    public static final @DetectionAlgorithmStatus int DETECTION_ALGORITHM_STATUS_NOT_RUNNING = 2;



    /** The detection algorithm supported and is running. */

    public static final @DetectionAlgorithmStatus int DETECTION_ALGORITHM_STATUS_RUNNING = 3;



    /**

     * Validates the supplied value is one of the known {@code DETECTOR_STATUS_} constants and

     * returns it if it is valid. {@link #DETECTOR_STATUS_UNKNOWN} is considered valid.

     *

     * @throws IllegalArgumentException if the value is not recognized

     */

    public static @DetectorStatus int requireValidDetectorStatus(

            @DetectorStatus int detectorStatus) {

        if (detectorStatus < DETECTOR_STATUS_UNKNOWN || detectorStatus > DETECTOR_STATUS_RUNNING) {

            throw new IllegalArgumentException("Invalid detector status: " + detectorStatus);

        }

        return detectorStatus;

    }



    /**

     * Returns a string for each {@code DETECTOR_STATUS_} constant. See also

     * {@link #detectorStatusFromString(String)}.

     *

     * @throws IllegalArgumentException if the value is not recognized

     */

    @NonNull

    public static String detectorStatusToString(@DetectorStatus int detectorStatus) {

        switch (detectorStatus) {

            case DETECTOR_STATUS_UNKNOWN:

                return "UNKNOWN";

            case DETECTOR_STATUS_NOT_SUPPORTED:

                return "NOT_SUPPORTED";

            case DETECTOR_STATUS_NOT_RUNNING:

                return "NOT_RUNNING";

            case DETECTOR_STATUS_RUNNING:

                return "RUNNING";

            default:

                throw new IllegalArgumentException("Unknown status: " + detectorStatus);

        }

    }



    /**

     * Returns {@code DETECTOR_STATUS_} constant value from a string. See also

     * {@link #detectorStatusToString(int)}.

     *

     * @throws IllegalArgumentException if the value is not recognized or is invalid

     */

    public static @DetectorStatus int detectorStatusFromString(

            @Nullable String detectorStatusString) {

        if (TextUtils.isEmpty(detectorStatusString)) {

            throw new IllegalArgumentException("Empty status: " + detectorStatusString);

        }



        switch (detectorStatusString) {

            case "UNKNOWN":

                return DETECTOR_STATUS_UNKNOWN;

            case "NOT_SUPPORTED":

                return DETECTOR_STATUS_NOT_SUPPORTED;

            case "NOT_RUNNING":

                return DETECTOR_STATUS_NOT_RUNNING;

            case "RUNNING":

                return DETECTOR_STATUS_RUNNING;

            default:

                throw new IllegalArgumentException("Unknown status: " + detectorStatusString);

        }

    }



    /**

     * Validates the supplied value is one of the known {@code DETECTION_ALGORITHM_} constants and

     * returns it if it is valid. {@link #DETECTION_ALGORITHM_STATUS_UNKNOWN} is considered valid.

     *

     * @throws IllegalArgumentException if the value is not recognized

     */

    public static @DetectionAlgorithmStatus int requireValidDetectionAlgorithmStatus(

            @DetectionAlgorithmStatus int detectionAlgorithmStatus) {

        if (detectionAlgorithmStatus < DETECTION_ALGORITHM_STATUS_UNKNOWN

                || detectionAlgorithmStatus > DETECTION_ALGORITHM_STATUS_RUNNING) {

            throw new IllegalArgumentException(

                    "Invalid detection algorithm: " + detectionAlgorithmStatus);

        }

        return detectionAlgorithmStatus;

    }



    /**

     * Returns a string for each {@code DETECTION_ALGORITHM_} constant. See also

     * {@link #detectionAlgorithmStatusFromString(String)}

     *

     * @throws IllegalArgumentException if the value is not recognized

     */

    @NonNull

    public static String detectionAlgorithmStatusToString(

            @DetectionAlgorithmStatus int detectorAlgorithmStatus) {

        switch (detectorAlgorithmStatus) {

            case DETECTION_ALGORITHM_STATUS_UNKNOWN:

                return "UNKNOWN";

            case DETECTION_ALGORITHM_STATUS_NOT_SUPPORTED:

                return "NOT_SUPPORTED";

            case DETECTION_ALGORITHM_STATUS_NOT_RUNNING:

                return "NOT_RUNNING";

            case DETECTION_ALGORITHM_STATUS_RUNNING:

                return "RUNNING";

            default:

                throw new IllegalArgumentException("Unknown status: " + detectorAlgorithmStatus);

        }

    }



    /**

     * Returns {@code DETECTION_ALGORITHM_} constant value from a string. See also

     * {@link #detectionAlgorithmStatusToString(int)} (String)}

     *

     * @throws IllegalArgumentException if the value is not recognized or is invalid

     */

    public static @DetectionAlgorithmStatus int detectionAlgorithmStatusFromString(

            @Nullable String detectorAlgorithmStatusString) {



        if (TextUtils.isEmpty(detectorAlgorithmStatusString)) {

            throw new IllegalArgumentException("Empty status: " + detectorAlgorithmStatusString);

        }



        switch (detectorAlgorithmStatusString) {

            case "UNKNOWN":

                return DETECTION_ALGORITHM_STATUS_UNKNOWN;

            case "NOT_SUPPORTED":

                return DETECTION_ALGORITHM_STATUS_NOT_SUPPORTED;

            case "NOT_RUNNING":

                return DETECTION_ALGORITHM_STATUS_NOT_RUNNING;

            case "RUNNING":

                return DETECTION_ALGORITHM_STATUS_RUNNING;

            default:

                throw new IllegalArgumentException(

                        "Unknown status: " + detectorAlgorithmStatusString);

        }

    }

}

core/java/android/app/time/LocationTimeZoneAlgorithmStatus.aidl

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/*

 * 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 android.app.time;



parcelable LocationTimeZoneAlgorithmStatus;

core/java/android/app/time/LocationTimeZoneAlgorithmStatus.java

0 → 100644
+363 −0

File added.

Preview size limit exceeded, changes collapsed.

core/java/android/app/time/TelephonyTimeZoneAlgorithmStatus.aidl

0 → 100644
+19 −0
Original line number Diff line number Diff line 
/*

 * 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 android.app.time;



parcelable TelephonyTimeZoneAlgorithmStatus;

core/java/android/app/time/TelephonyTimeZoneAlgorithmStatus.java

0 → 100644
+96 −0
Original line number Diff line number Diff line 
/*

 * 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 android.app.time;



import static android.app.time.DetectorStatusTypes.detectionAlgorithmStatusToString;

import static android.app.time.DetectorStatusTypes.requireValidDetectionAlgorithmStatus;



import android.annotation.NonNull;

import android.app.time.DetectorStatusTypes.DetectionAlgorithmStatus;

import android.os.Parcel;

import android.os.Parcelable;



import java.util.Objects;



/**

 * Information about the status of the telephony-based time zone detection algorithm.

 *

 * @hide

 */

public final class TelephonyTimeZoneAlgorithmStatus implements Parcelable {



    private final @DetectionAlgorithmStatus int mAlgorithmStatus;



    public TelephonyTimeZoneAlgorithmStatus(@DetectionAlgorithmStatus int algorithmStatus) {

        mAlgorithmStatus = requireValidDetectionAlgorithmStatus(algorithmStatus);

    }



    /**

     * Returns the status of the detection algorithm.

     */

    public @DetectionAlgorithmStatus int getAlgorithmStatus() {

        return mAlgorithmStatus;

    }



    @Override

    public String toString() {

        return "TelephonyTimeZoneAlgorithmStatus{"

                + "mAlgorithmStatus=" + detectionAlgorithmStatusToString(mAlgorithmStatus)

                + '}';

    }



    @NonNull

    public static final Creator<TelephonyTimeZoneAlgorithmStatus> CREATOR = new Creator<>() {

        @Override

        public TelephonyTimeZoneAlgorithmStatus createFromParcel(Parcel in) {

            @DetectionAlgorithmStatus int algorithmStatus = in.readInt();

            return new TelephonyTimeZoneAlgorithmStatus(algorithmStatus);

        }



        @Override

        public TelephonyTimeZoneAlgorithmStatus[] newArray(int size) {

            return new TelephonyTimeZoneAlgorithmStatus[size];

        }

    };



    @Override

    public int describeContents() {

        return 0;

    }



    @Override

    public void writeToParcel(@NonNull Parcel parcel, int flags) {

        parcel.writeInt(mAlgorithmStatus);

    }



    @Override

    public boolean equals(Object o) {

        if (this == o) {

            return true;

        }

        if (o == null || getClass() != o.getClass()) {

            return false;

        }

        TelephonyTimeZoneAlgorithmStatus that = (TelephonyTimeZoneAlgorithmStatus) o;

        return mAlgorithmStatus == that.mAlgorithmStatus;

    }



    @Override

    public int hashCode() {

        return Objects.hash(mAlgorithmStatus);

    }

}