Extract common methods into ContentInterface.
Existing APIs that accept a ContentResolver are too restrictive when
the caller has their own ContentProviderClient already bound and
configured, so we're in the market for a solution to open those
existing APIs to accept a wider range of inputs.
The solution we've come up with is to introduce a super-interface
which contains the common ContentProvider APIs, and then make
ContentProvider, ContentResolver, and ContentProviderClient all
implement that interface for consistency.
After this change lands, we can then safely relax existing APIs to
accept this new ContentInterface, offering a clean path to solving
the problem outlined above.
Bug: 117635768
Test: atest android.content.cts
Test: atest android.provider.cts
Change-Id: Ic5ae08107f7dd3dd23dcaec2df40c16543e0d86e
Exempted-From-Owner-Approval: keep tests working
diff --git a/core/java/android/content/ContentProvider.java b/core/java/android/content/ContentProvider.java
index 0f72fd3..5a12e4e 100644
--- a/core/java/android/content/ContentProvider.java
+++ b/core/java/android/content/ContentProvider.java
@@ -105,7 +105,7 @@
* developer guide.</p>
* </div>
*/
-public abstract class ContentProvider implements ComponentCallbacks2 {
+public abstract class ContentProvider implements ContentInterface, ComponentCallbacks2 {
private static final String TAG = "ContentProvider";
@@ -324,7 +324,7 @@
}
@Override
- public ContentProviderResult[] applyBatch(String callingPkg,
+ public ContentProviderResult[] applyBatch(String callingPkg, String authority,
ArrayList<ContentProviderOperation> operations)
throws OperationApplicationException {
int numOperations = operations.size();
@@ -356,7 +356,8 @@
Trace.traceBegin(TRACE_TAG_DATABASE, "applyBatch");
final String original = setCallingPackage(callingPkg);
try {
- ContentProviderResult[] results = ContentProvider.this.applyBatch(operations);
+ ContentProviderResult[] results = ContentProvider.this.applyBatch(authority,
+ operations);
if (results != null) {
for (int i = 0; i < results.length ; i++) {
if (userIds[i] != UserHandle.USER_CURRENT) {
@@ -444,13 +445,13 @@
}
@Override
- public Bundle call(
- String callingPkg, String method, @Nullable String arg, @Nullable Bundle extras) {
+ public Bundle call(String callingPkg, String authority, String method, @Nullable String arg,
+ @Nullable Bundle extras) {
Bundle.setDefusable(extras, true);
Trace.traceBegin(TRACE_TAG_DATABASE, "call");
final String original = setCallingPackage(callingPkg);
try {
- return ContentProvider.this.call(method, arg, extras);
+ return ContentProvider.this.call(authority, method, arg, extras);
} finally {
setCallingPackage(original);
Trace.traceEnd(TRACE_TAG_DATABASE);
@@ -1255,6 +1256,7 @@
* or {@code null}.
* @return a Cursor or {@code null}.
*/
+ @Override
public @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,
@Nullable Bundle queryArgs, @Nullable CancellationSignal cancellationSignal) {
queryArgs = queryArgs != null ? queryArgs : Bundle.EMPTY;
@@ -1293,6 +1295,7 @@
* @param uri the URI to query.
* @return a MIME type string, or {@code null} if there is no type.
*/
+ @Override
public abstract @Nullable String getType(@NonNull Uri uri);
/**
@@ -1325,6 +1328,7 @@
* @return Return the canonical representation of <var>url</var>, or null if
* canonicalization of that Uri is not supported.
*/
+ @Override
public @Nullable Uri canonicalize(@NonNull Uri url) {
return null;
}
@@ -1343,6 +1347,7 @@
* the data identified by the canonical representation can not be found in
* the current environment.
*/
+ @Override
public @Nullable Uri uncanonicalize(@NonNull Uri url) {
return url;
}
@@ -1369,6 +1374,7 @@
* canceled the refresh request.
* @return true if the provider actually tried refreshing.
*/
+ @Override
public boolean refresh(Uri uri, @Nullable Bundle args,
@Nullable CancellationSignal cancellationSignal) {
return false;
@@ -1403,6 +1409,7 @@
* This must not be {@code null}.
* @return The URI for the newly inserted item.
*/
+ @Override
public abstract @Nullable Uri insert(@NonNull Uri uri, @Nullable ContentValues values);
/**
@@ -1420,6 +1427,7 @@
* This must not be {@code null}.
* @return The number of values that were inserted.
*/
+ @Override
public int bulkInsert(@NonNull Uri uri, @NonNull ContentValues[] values) {
int numValues = values.length;
for (int i = 0; i < numValues; i++) {
@@ -1448,6 +1456,7 @@
* @return The number of rows affected.
* @throws SQLException
*/
+ @Override
public abstract int delete(@NonNull Uri uri, @Nullable String selection,
@Nullable String[] selectionArgs);
@@ -1468,6 +1477,7 @@
* @param selection An optional filter to match rows to update.
* @return the number of rows affected.
*/
+ @Override
public abstract int update(@NonNull Uri uri, @Nullable ContentValues values,
@Nullable String selection, @Nullable String[] selectionArgs);
@@ -1604,6 +1614,7 @@
* @see #getType(android.net.Uri)
* @see ParcelFileDescriptor#parseMode(String)
*/
+ @Override
public @Nullable ParcelFileDescriptor openFile(@NonNull Uri uri, @NonNull String mode,
@Nullable CancellationSignal signal) throws FileNotFoundException {
return openFile(uri, mode);
@@ -1723,6 +1734,7 @@
* @see #openFileHelper(Uri, String)
* @see #getType(android.net.Uri)
*/
+ @Override
public @Nullable AssetFileDescriptor openAssetFile(@NonNull Uri uri, @NonNull String mode,
@Nullable CancellationSignal signal) throws FileNotFoundException {
return openAssetFile(uri, mode);
@@ -1789,6 +1801,7 @@
* @see #openTypedAssetFile(Uri, String, Bundle)
* @see ClipDescription#compareMimeTypes(String, String)
*/
+ @Override
public @Nullable String[] getStreamTypes(@NonNull Uri uri, @NonNull String mimeTypeFilter) {
return null;
}
@@ -1905,6 +1918,7 @@
* @see #openAssetFile(Uri, String)
* @see ClipDescription#compareMimeTypes(String, String)
*/
+ @Override
public @Nullable AssetFileDescriptor openTypedAssetFile(@NonNull Uri uri,
@NonNull String mimeTypeFilter, @Nullable Bundle opts,
@Nullable CancellationSignal signal) throws FileNotFoundException {
@@ -2059,6 +2073,13 @@
* @throws OperationApplicationException thrown if any operation fails.
* @see ContentProviderOperation#apply
*/
+ @Override
+ public @NonNull ContentProviderResult[] applyBatch(@NonNull String authority,
+ @NonNull ArrayList<ContentProviderOperation> operations)
+ throws OperationApplicationException {
+ return applyBatch(operations);
+ }
+
public @NonNull ContentProviderResult[] applyBatch(
@NonNull ArrayList<ContentProviderOperation> operations)
throws OperationApplicationException {
@@ -2088,6 +2109,12 @@
* @return provider-defined return value. May be {@code null}, which is also
* the default for providers which don't implement any call methods.
*/
+ @Override
+ public @Nullable Bundle call(@NonNull String authority, @NonNull String method,
+ @Nullable String arg, @Nullable Bundle extras) {
+ return call(method, arg, extras);
+ }
+
public @Nullable Bundle call(@NonNull String method, @Nullable String arg,
@Nullable Bundle extras) {
return null;
@@ -2133,6 +2160,19 @@
writer.println("nothing to dump");
}
+ private void validateIncomingAuthority(String authority) throws SecurityException {
+ if (!matchesOurAuthorities(getAuthorityWithoutUserId(authority))) {
+ String message = "The authority " + authority + " does not match the one of the "
+ + "contentProvider: ";
+ if (mAuthority != null) {
+ message += mAuthority;
+ } else {
+ message += Arrays.toString(mAuthorities);
+ }
+ throw new SecurityException(message);
+ }
+ }
+
/** @hide */
@VisibleForTesting
public Uri validateIncomingUri(Uri uri) throws SecurityException {
@@ -2144,16 +2184,7 @@
+ mContext.getUserId() + " with a uri belonging to user " + userId);
}
}
- if (!matchesOurAuthorities(getAuthorityWithoutUserId(auth))) {
- String message = "The authority of the uri " + uri + " does not match the one of the "
- + "contentProvider: ";
- if (mAuthority != null) {
- message += mAuthority;
- } else {
- message += Arrays.toString(mAuthorities);
- }
- throw new SecurityException(message);
- }
+ validateIncomingAuthority(auth);
// Normalize the path by removing any empty path segments, which can be
// a source of security issues.