Merge "Add a new time zone detection service" (7d8a6240) · Commits · e / os / android_frameworks_base

core/java/android/app/SystemServiceRegistry.java

+9 −0

Original line number	Diff line number	Diff line
		@@ -31,6 +31,7 @@ import android.app.role.RoleManager;
		import android.app.slice.SliceManager;
		import android.app.timedetector.TimeDetector;
		import android.app.timezone.RulesManager;
		import android.app.timezonedetector.TimeZoneDetector;
		import android.app.trust.TrustManager;
		import android.app.usage.IStorageStatsManager;
		import android.app.usage.IUsageStatsManager;
		@@ -1235,6 +1236,14 @@ final class SystemServiceRegistry {
		return new TimeDetector();
		}});

		registerService(Context.TIME_ZONE_DETECTOR_SERVICE, TimeZoneDetector.class,
		new CachedServiceFetcher<TimeZoneDetector>() {
		@Override
		public TimeZoneDetector createService(ContextImpl ctx)
		throws ServiceNotFoundException {
		return new TimeZoneDetector();
		}});

		registerService(Context.PERMISSION_SERVICE, PermissionManager.class,
		new CachedServiceFetcher<PermissionManager>() {
		@Override

core/java/android/app/timezonedetector/ITimeZoneDetectorService.aidl

0 → 100644

+36 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezonedetector;

		import android.app.timezonedetector.PhoneTimeZoneSuggestion;

		/**
		* System private API to communicate with time zone detector service.
		*
		* <p>Used to provide information to the Time Zone Detector Service from other parts of the Android
		* system that have access to time zone-related signals, e.g. telephony.
		*
		* <p>Use the {@link android.app.timezonedetector.TimeZoneDetector} class rather than going through
		* this Binder interface directly. See {@link android.app.timezonedetector.TimeZoneDetectorService}
		* for more complete documentation.
		*
		*
		* {@hide}
		*/
		interface ITimeZoneDetectorService {
		void suggestPhoneTimeZone(in PhoneTimeZoneSuggestion timeZoneSuggestion);
		}

core/java/android/app/timezonedetector/PhoneTimeZoneSuggestion.aidl

0 → 100644

+19 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezonedetector;

		parcelable PhoneTimeZoneSuggestion;

core/java/android/app/timezonedetector/PhoneTimeZoneSuggestion.java

0 → 100644

+341 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright 2019 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.timezonedetector;

		import android.annotation.IntDef;
		import android.annotation.NonNull;
		import android.annotation.Nullable;
		import android.os.Parcel;
		import android.os.Parcelable;

		import java.lang.annotation.Retention;
		import java.lang.annotation.RetentionPolicy;
		import java.util.ArrayList;
		import java.util.Collections;
		import java.util.List;
		import java.util.Objects;

		/**
		* A suggested time zone from a Phone-based signal, e.g. from MCC and NITZ information.
		*
		* @hide
		*/
		public final class PhoneTimeZoneSuggestion implements Parcelable {

		@NonNull
		public static final Creator<PhoneTimeZoneSuggestion> CREATOR =
		new Creator<PhoneTimeZoneSuggestion>() {
		public PhoneTimeZoneSuggestion createFromParcel(Parcel in) {
		return PhoneTimeZoneSuggestion.createFromParcel(in);
		}

		public PhoneTimeZoneSuggestion[] newArray(int size) {
		return new PhoneTimeZoneSuggestion[size];
		}
		};

		/**
		* Creates an empty time zone suggestion, i.e. one that will cancel previous suggestions with
		* the same {@code phoneId}.
		*/
		@NonNull
		public static PhoneTimeZoneSuggestion createEmptySuggestion(
		int phoneId, @NonNull String debugInfo) {
		return new Builder(phoneId).addDebugInfo(debugInfo).build();
		}

		@IntDef({ MATCH_TYPE_NA, MATCH_TYPE_NETWORK_COUNTRY_ONLY, MATCH_TYPE_NETWORK_COUNTRY_AND_OFFSET,
		MATCH_TYPE_EMULATOR_ZONE_ID, MATCH_TYPE_TEST_NETWORK_OFFSET_ONLY })
		@Retention(RetentionPolicy.SOURCE)
		public @interface MatchType {}

		/** Used when match type is not applicable. */
		public static final int MATCH_TYPE_NA = 0;

		/**
		* Only the network country is known.
		*/
		public static final int MATCH_TYPE_NETWORK_COUNTRY_ONLY = 2;

		/**
		* Both the network county and offset were known.
		*/
		public static final int MATCH_TYPE_NETWORK_COUNTRY_AND_OFFSET = 3;

		/**
		* The device is running in an emulator and an NITZ signal was simulated containing an
		* Android extension with an explicit Olson ID.
		*/
		public static final int MATCH_TYPE_EMULATOR_ZONE_ID = 4;

		/**
		* The phone is most likely running in a test network not associated with a country (this is
		* distinct from the country just not being known yet).
		* Historically, Android has just picked an arbitrary time zone with the correct offset when
		* on a test network.
		*/
		public static final int MATCH_TYPE_TEST_NETWORK_OFFSET_ONLY = 5;

		@IntDef({ QUALITY_NA, QUALITY_SINGLE_ZONE, QUALITY_MULTIPLE_ZONES_WITH_SAME_OFFSET,
		QUALITY_MULTIPLE_ZONES_WITH_DIFFERENT_OFFSETS })
		@Retention(RetentionPolicy.SOURCE)
		public @interface Quality {}

		/** Used when quality is not applicable. */
		public static final int QUALITY_NA = 0;

		/** There is only one answer */
		public static final int QUALITY_SINGLE_ZONE = 1;

		/**
		* There are multiple answers, but they all shared the same offset / DST state at the time
		* the suggestion was created. i.e. it might be the wrong zone but the user won't notice
		* immediately if it is wrong.
		*/
		public static final int QUALITY_MULTIPLE_ZONES_WITH_SAME_OFFSET = 2;

		/**
		* There are multiple answers with different offsets. The one given is just one possible.
		*/
		public static final int QUALITY_MULTIPLE_ZONES_WITH_DIFFERENT_OFFSETS = 3;

		/**
		* The ID of the phone this suggestion is associated with. For multiple-sim devices this
		* helps to establish origin so filtering / stickiness can be implemented.
		*/
		private final int mPhoneId;

		/**
		* The suggestion. {@code null} means there is no current suggestion and any previous suggestion
		* should be forgotten.
		*/
		private final String mZoneId;

		/**
		* The type of "match" used to establish the time zone.
		*/
		@MatchType
		private final int mMatchType;

		/**
		* A measure of the quality of the time zone suggestion, i.e. how confident one could be in
		* it.
		*/
		@Quality
		private final int mQuality;

		/**
		* Free-form debug information about how the signal was derived. Used for debug only,
		* intentionally not used in equals(), etc.
		*/
		private List<String> mDebugInfo;

		private PhoneTimeZoneSuggestion(Builder builder) {
		mPhoneId = builder.mPhoneId;
		mZoneId = builder.mZoneId;
		mMatchType = builder.mMatchType;
		mQuality = builder.mQuality;
		mDebugInfo = builder.mDebugInfo != null ? new ArrayList<>(builder.mDebugInfo) : null;
		}

		@SuppressWarnings("unchecked")
		private static PhoneTimeZoneSuggestion createFromParcel(Parcel in) {
		// Use the Builder so we get validation during build().
		int phoneId = in.readInt();
		PhoneTimeZoneSuggestion suggestion = new Builder(phoneId)
		.setZoneId(in.readString())
		.setMatchType(in.readInt())
		.setQuality(in.readInt())
		.build();
		List<String> debugInfo = in.readArrayList(PhoneTimeZoneSuggestion.class.getClassLoader());
		if (debugInfo != null) {
		suggestion.addDebugInfo(debugInfo);
		}
		return suggestion;
		}

		@Override
		public void writeToParcel(@NonNull Parcel dest, int flags) {
		dest.writeInt(mPhoneId);
		dest.writeString(mZoneId);
		dest.writeInt(mMatchType);
		dest.writeInt(mQuality);
		dest.writeList(mDebugInfo);
		}

		@Override
		public int describeContents() {
		return 0;
		}

		public int getPhoneId() {
		return mPhoneId;
		}

		@Nullable
		public String getZoneId() {
		return mZoneId;
		}

		@MatchType
		public int getMatchType() {
		return mMatchType;
		}

		@Quality
		public int getQuality() {
		return mQuality;
		}

		@NonNull
		public List<String> getDebugInfo() {
		return mDebugInfo == null
		? Collections.emptyList() : Collections.unmodifiableList(mDebugInfo);
		}

		/**
		* Associates information with the instance that can be useful for debugging / logging. The
		* information is present in {@link #toString()} but is not considered for
		* {@link #equals(Object)} and {@link #hashCode()}.
		*/
		public void addDebugInfo(@NonNull String debugInfo) {
		if (mDebugInfo == null) {
		mDebugInfo = new ArrayList<>();
		}
		mDebugInfo.add(debugInfo);
		}

		/**
		* Associates information with the instance that can be useful for debugging / logging. The
		* information is present in {@link #toString()} but is not considered for
		* {@link #equals(Object)} and {@link #hashCode()}.
		*/
		public void addDebugInfo(@NonNull List<String> debugInfo) {
		if (mDebugInfo == null) {
		mDebugInfo = new ArrayList<>(debugInfo.size());
		}
		mDebugInfo.addAll(debugInfo);
		}

		@Override
		public boolean equals(Object o) {
		if (this == o) {
		return true;
		}
		if (o == null \|\| getClass() != o.getClass()) {
		return false;
		}
		PhoneTimeZoneSuggestion that = (PhoneTimeZoneSuggestion) o;
		return mPhoneId == that.mPhoneId
		&& mMatchType == that.mMatchType
		&& mQuality == that.mQuality
		&& Objects.equals(mZoneId, that.mZoneId);
		}

		@Override
		public int hashCode() {
		return Objects.hash(mPhoneId, mZoneId, mMatchType, mQuality);
		}

		@Override
		public String toString() {
		return "PhoneTimeZoneSuggestion{"
		+ "mPhoneId=" + mPhoneId
		+ ", mZoneId='" + mZoneId + '\''
		+ ", mMatchType=" + mMatchType
		+ ", mQuality=" + mQuality
		+ ", mDebugInfo=" + mDebugInfo
		+ '}';
		}

		/**
		* Builds {@link PhoneTimeZoneSuggestion} instances.
		*
		* @hide
		*/
		public static class Builder {
		private final int mPhoneId;
		private String mZoneId;
		@MatchType private int mMatchType;
		@Quality private int mQuality;
		private List<String> mDebugInfo;

		public Builder(int phoneId) {
		mPhoneId = phoneId;
		}

		/** Returns the builder for call chaining. */
		public Builder setZoneId(String zoneId) {
		mZoneId = zoneId;
		return this;
		}

		/** Returns the builder for call chaining. */
		public Builder setMatchType(@MatchType int matchType) {
		mMatchType = matchType;
		return this;
		}

		/** Returns the builder for call chaining. */
		public Builder setQuality(@Quality int quality) {
		mQuality = quality;
		return this;
		}

		/** Returns the builder for call chaining. */
		public Builder addDebugInfo(@NonNull String debugInfo) {
		if (mDebugInfo == null) {
		mDebugInfo = new ArrayList<>();
		}
		mDebugInfo.add(debugInfo);
		return this;
		}

		/**
		* Performs basic structural validation of this instance. e.g. Are all the fields populated
		* that must be? Are the enum ints set to valid values?
		*/
		void validate() {
		int quality = mQuality;
		int matchType = mMatchType;
		if (mZoneId == null) {
		if (quality != QUALITY_NA \|\| matchType != MATCH_TYPE_NA) {
		throw new RuntimeException("Invalid quality or match type for null zone ID."
		+ " quality=" + quality + ", matchType=" + matchType);
		}
		} else {
		boolean qualityValid = (quality == QUALITY_SINGLE_ZONE
		\|\| quality == QUALITY_MULTIPLE_ZONES_WITH_SAME_OFFSET
		\|\| quality == QUALITY_MULTIPLE_ZONES_WITH_DIFFERENT_OFFSETS);
		boolean matchTypeValid = (matchType == MATCH_TYPE_NETWORK_COUNTRY_ONLY
		\|\| matchType == MATCH_TYPE_NETWORK_COUNTRY_AND_OFFSET
		\|\| matchType == MATCH_TYPE_EMULATOR_ZONE_ID
		\|\| matchType == MATCH_TYPE_TEST_NETWORK_OFFSET_ONLY);
		if (!qualityValid \|\| !matchTypeValid) {
		throw new RuntimeException("Invalid quality or match type with zone ID."
		+ " quality=" + quality + ", matchType=" + matchType);
		}
		}
		}

		/** Returns the {@link PhoneTimeZoneSuggestion}. */
		public PhoneTimeZoneSuggestion build() {
		validate();
		return new PhoneTimeZoneSuggestion(this);
		}
		}
		}

core/java/android/app/timezonedetector/TimeZoneDetector.java

0 → 100644

+59 −0

Original line number	Diff line number	Diff line
		/*
		* Copyright (C) 2019 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.timezonedetector;

		import android.annotation.NonNull;
		import android.annotation.SystemService;
		import android.content.Context;
		import android.os.RemoteException;
		import android.os.ServiceManager;
		import android.os.ServiceManager.ServiceNotFoundException;
		import android.util.Log;

		/**
		* The interface through which system components can send signals to the TimeZoneDetectorService.
		* @hide
		*/
		@SystemService(Context.TIME_ZONE_DETECTOR_SERVICE)
		public final class TimeZoneDetector {
		private static final String TAG = "timezonedetector.TimeZoneDetector";
		private static final boolean DEBUG = false;

		private final ITimeZoneDetectorService mITimeZoneDetectorService;

		public TimeZoneDetector() throws ServiceNotFoundException {
		mITimeZoneDetectorService = ITimeZoneDetectorService.Stub.asInterface(
		ServiceManager.getServiceOrThrow(Context.TIME_ZONE_DETECTOR_SERVICE));
		}

		/**
		* Suggests the current time zone to the detector. The detector may ignore the signal if better
		* signals are available such as those that come from more reliable sources or were
		* determined more recently.
		*/
		public void suggestPhoneTimeZone(@NonNull PhoneTimeZoneSuggestion timeZoneSuggestion) {
		if (DEBUG) {
		Log.d(TAG, "suggestPhoneTimeZone called: " + timeZoneSuggestion);
		}
		try {
		mITimeZoneDetectorService.suggestPhoneTimeZone(timeZoneSuggestion);
		} catch (RemoteException e) {
		throw e.rethrowFromSystemServer();
		}
		}

		}