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

Commit 8df02f45 authored by Soonil Nagarkar's avatar Soonil Nagarkar
Browse files

Refactor providers/managers 

Refactor how providers/managers are implemented in LMS, substantially
simplifying code, and opening up further simplification around
permissions in the next change.

Also, limit the number of additional packages providers can have, and
merge WorkSource into ProviderRequest so that providers can pass just
ProviderRequests around, not both.

Test: presubmits
Change-Id: Ic6fab46883cf53eb26368b54a824feac39c57a32
parent 00ef0f3a

location/java/android/location/Criteria.java

+181 −140
Original line number Diff line number Diff line
@@ -16,9 +16,16 @@ 


package android.location;



import android.annotation.IntDef;

import android.annotation.NonNull;

import android.os.Parcel;

import android.os.Parcelable;



import com.android.internal.util.Preconditions;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;



/**

 * A class indicating the application criteria for selecting a

 * location provider. Providers may be ordered according to accuracy,
@@ -26,6 +33,25 @@ import android.os.Parcelable; 
 * cost.

 */

public class Criteria implements Parcelable {



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({NO_REQUIREMENT, POWER_LOW, POWER_MEDIUM, POWER_HIGH})

    public @interface PowerRequirement {

    }



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({NO_REQUIREMENT, ACCURACY_LOW, ACCURACY_MEDIUM, ACCURACY_HIGH})

    public @interface AccuracyRequirement {

    }



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({NO_REQUIREMENT, ACCURACY_FINE, ACCURACY_COARSE})

    public @interface LocationAccuracyRequirement {

    }



    /**

     * A constant indicating that the application does not choose to

     * place requirement on a particular feature.
@@ -97,7 +123,8 @@ public class Criteria implements Parcelable { 
     * require altitude, speed, or bearing; and will not allow monetary

     * cost.

     */

    public Criteria() {}

    public Criteria() {

    }



    /**

     * Constructs a new Criteria object that is a copy of the given criteria.
@@ -115,125 +142,121 @@ public class Criteria implements Parcelable { 
    }



    /**

     * Indicates the desired horizontal accuracy (latitude and longitude).

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_MEDIUM},

     * {@link #ACCURACY_HIGH} or {@link #NO_REQUIREMENT}.

     * More accurate location may consume more power and may take longer.

     * Indicates the desired horizontal accuracy (latitude and longitude). Accuracy may be

     * {@link #ACCURACY_LOW}, {@link #ACCURACY_MEDIUM}, {@link #ACCURACY_HIGH} or

     * {@link #NO_REQUIREMENT}. More accurate location may consume more power and may take longer.

     *

     * @throws IllegalArgumentException if accuracy is not one of the supported constants

     */

    public void setHorizontalAccuracy(int accuracy) {

        if (accuracy < NO_REQUIREMENT || accuracy > ACCURACY_HIGH) {

            throw new IllegalArgumentException("accuracy=" + accuracy);

        }

        mHorizontalAccuracy = accuracy;

    public void setHorizontalAccuracy(@AccuracyRequirement int accuracy) {

        mHorizontalAccuracy = Preconditions.checkArgumentInRange(accuracy, NO_REQUIREMENT,

                ACCURACY_HIGH, "accuracy");

    }



    /**

     * Returns a constant indicating the desired horizontal accuracy (latitude and longitude).

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_MEDIUM},

     * {@link #ACCURACY_HIGH} or {@link #NO_REQUIREMENT}.

     *

     * @see #setHorizontalAccuracy(int)

     */

    @AccuracyRequirement

    public int getHorizontalAccuracy() {

        return mHorizontalAccuracy;

    }



    /**

     * Indicates the desired vertical accuracy (altitude).

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_MEDIUM},

     * {@link #ACCURACY_HIGH} or {@link #NO_REQUIREMENT}.

     * More accurate location may consume more power and may take longer.

     * Indicates the desired vertical accuracy (altitude). Accuracy may be {@link #ACCURACY_LOW},

     * {@link #ACCURACY_MEDIUM}, {@link #ACCURACY_HIGH} or {@link #NO_REQUIREMENT}. More accurate

     * location may consume more power and may take longer.

     *

     * @throws IllegalArgumentException if accuracy is not one of the supported constants

     */

    public void setVerticalAccuracy(int accuracy) {

        if (accuracy < NO_REQUIREMENT || accuracy > ACCURACY_HIGH) {

            throw new IllegalArgumentException("accuracy=" + accuracy);

        }

        mVerticalAccuracy = accuracy;

    public void setVerticalAccuracy(@AccuracyRequirement int accuracy) {

        mVerticalAccuracy = Preconditions.checkArgumentInRange(accuracy, NO_REQUIREMENT,

                ACCURACY_HIGH, "accuracy");

    }



    /**

     * Returns a constant indicating the desired vertical accuracy (altitude).

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_HIGH},

     * or {@link #NO_REQUIREMENT}.

     *

     * @see #setVerticalAccuracy(int)

     */

    @AccuracyRequirement

    public int getVerticalAccuracy() {

        return mVerticalAccuracy;

    }



    /**

     * Indicates the desired speed accuracy.

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_HIGH},

     * or {@link #NO_REQUIREMENT}.

     * More accurate location may consume more power and may take longer.

     * Indicates the desired speed accuracy. Accuracy may be {@link #ACCURACY_LOW},

     * {@link #ACCURACY_MEDIUM}, {@link #ACCURACY_HIGH}, or {@link #NO_REQUIREMENT}. More accurate

     * location may consume more power and may take longer.

     *

     * @throws IllegalArgumentException if accuracy is not one of the supported constants

     */

    public void setSpeedAccuracy(int accuracy) {

        if (accuracy < NO_REQUIREMENT || accuracy > ACCURACY_HIGH) {

            throw new IllegalArgumentException("accuracy=" + accuracy);

        }

        mSpeedAccuracy = accuracy;

    public void setSpeedAccuracy(@AccuracyRequirement int accuracy) {

        mSpeedAccuracy = Preconditions.checkArgumentInRange(accuracy, NO_REQUIREMENT, ACCURACY_HIGH,

                "accuracy");

    }



    /**

     * Returns a constant indicating the desired speed accuracy

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_HIGH},

     * or {@link #NO_REQUIREMENT}.

     * Returns a constant indicating the desired speed accuracy.

     *

     * @see #setSpeedAccuracy(int)

     */

    @AccuracyRequirement

    public int getSpeedAccuracy() {

        return mSpeedAccuracy;

    }



    /**

     * Indicates the desired bearing accuracy.

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_HIGH},

     * or {@link #NO_REQUIREMENT}.

     * More accurate location may consume more power and may take longer.

     * Indicates the desired bearing accuracy. Accuracy may be {@link #ACCURACY_LOW},

     * {@link #ACCURACY_MEDIUM}, {@link #ACCURACY_HIGH}, or {@link #NO_REQUIREMENT}. More accurate

     * location may consume more power and may take longer.

     *

     * @throws IllegalArgumentException if accuracy is not one of the supported constants

     */

    public void setBearingAccuracy(int accuracy) {

        if (accuracy < NO_REQUIREMENT || accuracy > ACCURACY_HIGH) {

            throw new IllegalArgumentException("accuracy=" + accuracy);

        }

        mBearingAccuracy = accuracy;

    public void setBearingAccuracy(@AccuracyRequirement int accuracy) {

        mBearingAccuracy = Preconditions.checkArgumentInRange(accuracy, NO_REQUIREMENT,

                ACCURACY_HIGH, "accuracy");

    }



    /**

     * Returns a constant indicating the desired bearing accuracy.

     * Accuracy may be {@link #ACCURACY_LOW}, {@link #ACCURACY_HIGH},

     * or {@link #NO_REQUIREMENT}.

     *

     * @see #setBearingAccuracy(int)

     */

    @AccuracyRequirement

    public int getBearingAccuracy() {

        return mBearingAccuracy;

    }



    /**

     * Indicates the desired accuracy for latitude and longitude. Accuracy

     * may be {@link #ACCURACY_FINE} if desired location

     * is fine, else it can be {@link #ACCURACY_COARSE}.

     * More accurate location may consume more power and may take longer.

     * Indicates the desired accuracy for latitude and longitude. Accuracy may be

     * {@link #ACCURACY_FINE} or {@link #ACCURACY_COARSE}. More accurate location may consume more

     * power and may take longer.

     *

     * @throws IllegalArgumentException if accuracy is not one of the supported constants

     */

    public void setAccuracy(int accuracy) {

        if (accuracy < NO_REQUIREMENT || accuracy > ACCURACY_COARSE) {

            throw new IllegalArgumentException("accuracy=" + accuracy);

        }

        if (accuracy == ACCURACY_FINE) {

            mHorizontalAccuracy = ACCURACY_HIGH;

        } else {

            mHorizontalAccuracy = ACCURACY_LOW;

    public void setAccuracy(@LocationAccuracyRequirement int accuracy) {

        Preconditions.checkArgumentInRange(accuracy, NO_REQUIREMENT, ACCURACY_COARSE, "accuracy");

        switch (accuracy) {

            case NO_REQUIREMENT:

                setHorizontalAccuracy(NO_REQUIREMENT);

                break;

            case ACCURACY_FINE:

                setHorizontalAccuracy(ACCURACY_HIGH);

                break;

            case ACCURACY_COARSE:

                setHorizontalAccuracy(ACCURACY_LOW);

                break;

        }

    }



    /**

     * Returns a constant indicating desired accuracy of location

     * Accuracy may be {@link #ACCURACY_FINE} if desired location

     * is fine, else it can be {@link #ACCURACY_COARSE}.

     * Returns a constant indicating desired accuracy of location.

     *

     * @see #setAccuracy(int)

     */

    @LocationAccuracyRequirement

    public int getAccuracy() {

        if (mHorizontalAccuracy >= ACCURACY_HIGH) {

            return ACCURACY_FINE;
@@ -243,21 +266,20 @@ public class Criteria implements Parcelable { 
    }



    /**

     * Indicates the desired maximum power level.  The level parameter

     * must be one of NO_REQUIREMENT, POWER_LOW, POWER_MEDIUM, or

     * POWER_HIGH.

     * Indicates the desired maximum power requirement. The power requirement parameter may be

     * {@link #NO_REQUIREMENT}, {@link #POWER_LOW}, {@link #POWER_MEDIUM}, or {@link #POWER_HIGH}.

     */

    public void setPowerRequirement(int level) {

        if (level < NO_REQUIREMENT || level > POWER_HIGH) {

            throw new IllegalArgumentException("level=" + level);

        }

        mPowerRequirement = level;

    public void setPowerRequirement(@PowerRequirement int powerRequirement) {

        mPowerRequirement = Preconditions.checkArgumentInRange(powerRequirement, NO_REQUIREMENT,

                POWER_HIGH, "powerRequirement");

    }



    /**

     * Returns a constant indicating the desired power requirement.  The

     * returned

     * Returns a constant indicating the desired maximum power requirement.

     *

     * @see #setPowerRequirement(int)

     */

    @PowerRequirement

    public int getPowerRequirement() {

        return mPowerRequirement;

    }
@@ -277,8 +299,8 @@ public class Criteria implements Parcelable { 
    }



    /**

     * Indicates whether the provider must provide altitude information.

     * Not all fixes are guaranteed to contain such information.

     * Indicates whether the provider must provide altitude information. Not all fixes are

     * guaranteed to contain such information.

     */

    public void setAltitudeRequired(boolean altitudeRequired) {

        mAltitudeRequired = altitudeRequired;
@@ -286,15 +308,16 @@ public class Criteria implements Parcelable { 


    /**

     * Returns whether the provider must provide altitude information.

     * Not all fixes are guaranteed to contain such information.

     *

     * @see #setAltitudeRequired(boolean)

     */

    public boolean isAltitudeRequired() {

        return mAltitudeRequired;

    }



    /**

     * Indicates whether the provider must provide speed information.

     * Not all fixes are guaranteed to contain such information.

     * Indicates whether the provider must provide speed information. Not all fixes are guaranteed

     * to contain such information.

     */

    public void setSpeedRequired(boolean speedRequired) {

        mSpeedRequired = speedRequired;
@@ -302,15 +325,16 @@ public class Criteria implements Parcelable { 


    /**

     * Returns whether the provider must provide speed information.

     * Not all fixes are guaranteed to contain such information.

     *

     * @see #setSpeedRequired(boolean)

     */

    public boolean isSpeedRequired() {

        return mSpeedRequired;

    }



    /**

     * Indicates whether the provider must provide bearing information.

     * Not all fixes are guaranteed to contain such information.

     * Indicates whether the provider must provide bearing information. Not all fixes are guaranteed

     * to contain such information.

     */

    public void setBearingRequired(boolean bearingRequired) {

        mBearingRequired = bearingRequired;
@@ -318,13 +342,15 @@ public class Criteria implements Parcelable { 


    /**

     * Returns whether the provider must provide bearing information.

     * Not all fixes are guaranteed to contain such information.

     *

     * @see #setBearingRequired(boolean)

     */

    public boolean isBearingRequired() {

        return mBearingRequired;

    }



    public static final @android.annotation.NonNull Parcelable.Creator<Criteria> CREATOR =

    @NonNull

    public static final Parcelable.Creator<Criteria> CREATOR =

            new Parcelable.Creator<Criteria>() {

                @Override

                public Criteria createFromParcel(Parcel in) {
@@ -365,42 +391,57 @@ public class Criteria implements Parcelable { 
        parcel.writeInt(mCostAllowed ? 1 : 0);

    }



    private static String powerToString(int power) {

    @Override

    public String toString() {

        StringBuilder s = new StringBuilder();

        s.append("Criteria[");

        s.append("power=").append(requirementToString(mPowerRequirement)).append(", ");

        s.append("accuracy=").append(requirementToString(mHorizontalAccuracy));

        if (mVerticalAccuracy != NO_REQUIREMENT) {

            s.append(", verticalAccuracy=").append(requirementToString(mVerticalAccuracy));

        }

        if (mSpeedAccuracy != NO_REQUIREMENT) {

            s.append(", speedAccuracy=").append(requirementToString(mSpeedAccuracy));

        }

        if (mBearingAccuracy != NO_REQUIREMENT) {

            s.append(", bearingAccuracy=").append(requirementToString(mBearingAccuracy));

        }

        if (mAltitudeRequired || mBearingRequired || mSpeedRequired) {

            s.append(", required=[");

            if (mAltitudeRequired) {

                s.append("altitude, ");

            }

            if (mBearingRequired) {

                s.append("bearing, ");

            }

            if (mSpeedRequired) {

                s.append("speed, ");

            }

            s.setLength(s.length() - 2);

            s.append("]");

        }

        if (mCostAllowed) {

            s.append(", costAllowed");

        }

        s.append(']');

        return s.toString();

    }



    private static String requirementToString(int power) {

        switch (power) {

            case NO_REQUIREMENT:

                return "NO_REQ";

                return "None";

            //case ACCURACY_LOW:

            case POWER_LOW:

                return "LOW";

                return "Low";

            //case ACCURACY_MEDIUM:

            case POWER_MEDIUM:

                return "MEDIUM";

                return "Medium";

            //case ACCURACY_HIGH:

            case POWER_HIGH:

                return "HIGH";

                return "High";

            default:

                return "???";

        }

    }



    private static String accuracyToString(int accuracy) {

        switch (accuracy) {

            case NO_REQUIREMENT:

                return "---";

            case ACCURACY_HIGH:

                return "HIGH";

            case ACCURACY_MEDIUM:

                return "MEDIUM";

            case ACCURACY_LOW:

                return "LOW";

            default:

                return "???";

        }

    }



    @Override

    public String toString() {

        StringBuilder s = new StringBuilder();

        s.append("Criteria[power=").append(powerToString(mPowerRequirement));

        s.append(" acc=").append(accuracyToString(mHorizontalAccuracy));

        s.append(']');

        return s.toString();

    }

}

location/java/com/android/internal/location/ProviderProperties.java

+123 −39
Original line number Diff line number Diff line
@@ -16,15 +16,36 @@ 


package com.android.internal.location;



import android.annotation.IntDef;

import android.location.Criteria;

import android.os.Parcel;

import android.os.Parcelable;



import com.android.internal.util.Preconditions;



import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;



/**

 * A Parcelable containing (legacy) location provider properties.

 * This object is just used inside the framework and system services.

 *

 * @hide

 */

public final class ProviderProperties implements Parcelable {



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({Criteria.POWER_LOW, Criteria.POWER_MEDIUM, Criteria.POWER_HIGH})

    public @interface PowerRequirement {

    }



    /** @hide */

    @Retention(RetentionPolicy.SOURCE)

    @IntDef({Criteria.ACCURACY_FINE, Criteria.ACCURACY_COARSE})

    public @interface Accuracy {

    }



    /**

     * True if provider requires access to a

     * data network (e.g., the Internet), false otherwise.
@@ -79,34 +100,32 @@ public final class ProviderProperties implements Parcelable { 


    /**

     * Power requirement for this provider.

     *

     * @return the power requirement for this provider, as one of the

     * constants Criteria.POWER_*.

     */

    @PowerRequirement

    public final int mPowerRequirement;



    /**

     * Constant describing the horizontal accuracy returned

     * by this provider.

     *

     * @return the horizontal accuracy for this provider, as one of the

     * constants Criteria.ACCURACY_COARSE or Criteria.ACCURACY_FINE

     */

    @Accuracy

    public final int mAccuracy;



    public ProviderProperties(boolean mRequiresNetwork,

            boolean mRequiresSatellite, boolean mRequiresCell, boolean mHasMonetaryCost,

            boolean mSupportsAltitude, boolean mSupportsSpeed, boolean mSupportsBearing,

            int mPowerRequirement, int mAccuracy) {

        this.mRequiresNetwork = mRequiresNetwork;

        this.mRequiresSatellite = mRequiresSatellite;

        this.mRequiresCell = mRequiresCell;

        this.mHasMonetaryCost = mHasMonetaryCost;

        this.mSupportsAltitude = mSupportsAltitude;

        this.mSupportsSpeed = mSupportsSpeed;

        this.mSupportsBearing = mSupportsBearing;

        this.mPowerRequirement = mPowerRequirement;

        this.mAccuracy = mAccuracy;

    public ProviderProperties(boolean requiresNetwork, boolean requiresSatellite,

            boolean requiresCell, boolean hasMonetaryCost, boolean supportsAltitude,

            boolean supportsSpeed, boolean supportsBearing, @PowerRequirement int powerRequirement,

            @Accuracy int accuracy) {

        mRequiresNetwork = requiresNetwork;

        mRequiresSatellite = requiresSatellite;

        mRequiresCell = requiresCell;

        mHasMonetaryCost = hasMonetaryCost;

        mSupportsAltitude = supportsAltitude;

        mSupportsSpeed = supportsSpeed;

        mSupportsBearing = supportsBearing;

        mPowerRequirement = Preconditions.checkArgumentInRange(powerRequirement, Criteria.POWER_LOW,

                Criteria.POWER_HIGH, "powerRequirement");

        mAccuracy = Preconditions.checkArgumentInRange(accuracy, Criteria.ACCURACY_FINE,

                Criteria.ACCURACY_COARSE, "accuracy");

    }



    public static final Parcelable.Creator<ProviderProperties> CREATOR =
@@ -123,9 +142,11 @@ public final class ProviderProperties implements Parcelable { 
                    int powerRequirement = in.readInt();

                    int accuracy = in.readInt();

                    return new ProviderProperties(requiresNetwork, requiresSatellite,

                    requiresCell, hasMonetaryCost, supportsAltitude, supportsSpeed, supportsBearing,

                            requiresCell, hasMonetaryCost, supportsAltitude, supportsSpeed,

                            supportsBearing,

                            powerRequirement, accuracy);

                }



                @Override

                public ProviderProperties[] newArray(int size) {

                    return new ProviderProperties[size];
@@ -149,4 +170,67 @@ public final class ProviderProperties implements Parcelable { 
        parcel.writeInt(mPowerRequirement);

        parcel.writeInt(mAccuracy);

    }



    @Override

    public String toString() {

        StringBuilder b = new StringBuilder("ProviderProperties[");

        b.append("power=").append(powerToString(mPowerRequirement)).append(", ");

        b.append("accuracy=").append(accuracyToString(mAccuracy));

        if (mRequiresNetwork || mRequiresSatellite || mRequiresCell) {

            b.append(", requires=");

            if (mRequiresNetwork) {

                b.append("network,");

            }

            if (mRequiresSatellite) {

                b.append("satellite,");

            }

            if (mRequiresCell) {

                b.append("cell,");

            }

            b.setLength(b.length() - 1);

        }

        if (mHasMonetaryCost) {

            b.append(", hasMonetaryCost");

        }

        if (mSupportsBearing || mSupportsSpeed || mSupportsAltitude) {

            b.append(", supports=[");

            if (mSupportsBearing) {

                b.append("bearing, ");

            }

            if (mSupportsSpeed) {

                b.append("speed, ");

            }

            if (mSupportsAltitude) {

                b.append("altitude, ");

            }

            b.setLength(b.length() - 2);

            b.append("]");

        }

        b.append("]");

        return b.toString();

    }



    private static String powerToString(@PowerRequirement int power) {

        switch (power) {

            case Criteria.POWER_LOW:

                return "Low";

            case Criteria.POWER_MEDIUM:

                return "Medium";

            case Criteria.POWER_HIGH:

                return "High";

            default:

                return "???";

        }

    }



    private static String accuracyToString(@Accuracy int accuracy) {

        switch (accuracy) {

            case Criteria.ACCURACY_COARSE:

                return "Coarse";

            case Criteria.ACCURACY_FINE:

                return "Fine";

            default:

                return "???";

        }

    }

}

location/java/com/android/internal/location/ProviderRequest.java

+105 −23

File changed.

Preview size limit exceeded, changes collapsed.

services/core/java/com/android/server/GnssManagerService.java

+3 −6
Original line number Diff line number Diff line
@@ -47,7 +47,6 @@ import com.android.internal.util.DumpUtils; 
import com.android.internal.util.IndentingPrintWriter;

import com.android.server.LocationManagerServiceUtils.LinkedListener;

import com.android.server.LocationManagerServiceUtils.LinkedListenerBase;

import com.android.server.location.AbstractLocationProvider;

import com.android.server.location.CallerIdentity;

import com.android.server.location.GnssBatchingProvider;

import com.android.server.location.GnssCapabilitiesProvider;
@@ -116,11 +115,9 @@ public class GnssManagerService { 
    private final Handler mHandler;



    public GnssManagerService(LocationManagerService locationManagerService,

            Context context,

            AbstractLocationProvider.LocationProviderManager gnssProviderManager,

            LocationUsageLogger locationUsageLogger) {

        this(locationManagerService, context, new GnssLocationProvider(context, gnssProviderManager,

                FgThread.getHandler().getLooper()), locationUsageLogger);

            Context context, LocationUsageLogger locationUsageLogger) {

        this(locationManagerService, context,

                new GnssLocationProvider(context, FgThread.getHandler()), locationUsageLogger);

    }



    // Can use this constructor to inject GnssLocationProvider for testing

services/core/java/com/android/server/LocationManagerService.java

+362 −490

File changed.

Preview size limit exceeded, changes collapsed.