blob: d75c2ee0edddf9b89ecec3e4e37ad146e28a6802 [file] [log] [blame]
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
Nicolas Prevot504d78e2014-06-26 10:07:33 +010019import static android.Manifest.permission.INTERACT_ACROSS_USERS;
Jeff Sharkey0e621c32015-07-24 15:10:20 -070020import static android.app.AppOpsManager.MODE_ALLOWED;
21import static android.app.AppOpsManager.MODE_ERRORED;
22import static android.app.AppOpsManager.MODE_IGNORED;
23import static android.content.pm.PackageManager.PERMISSION_GRANTED;
Jeff Sharkey110a6b62012-03-12 11:12:41 -070024
Jeff Sharkey673db442015-06-11 19:30:57 -070025import android.annotation.NonNull;
Scott Kennedy9f78f652015-03-01 15:29:25 -080026import android.annotation.Nullable;
Dianne Hackborn35654b62013-01-14 17:38:02 -080027import android.app.AppOpsManager;
Dianne Hackborn2af632f2009-07-08 14:56:37 -070028import android.content.pm.PathPermission;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080029import android.content.pm.ProviderInfo;
30import android.content.res.AssetFileDescriptor;
31import android.content.res.Configuration;
32import android.database.Cursor;
Svet Ganov7271f3e2015-04-23 10:16:53 -070033import android.database.MatrixCursor;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080034import android.database.SQLException;
35import android.net.Uri;
Dianne Hackborn23fdaf62010-08-06 12:16:55 -070036import android.os.AsyncTask;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080037import android.os.Binder;
Brad Fitzpatrick1877d012010-03-04 17:48:13 -080038import android.os.Bundle;
Jeff Browna7771df2012-05-07 20:06:46 -070039import android.os.CancellationSignal;
Dianne Hackbornff170242014-11-19 10:59:01 -080040import android.os.IBinder;
Jeff Browna7771df2012-05-07 20:06:46 -070041import android.os.ICancellationSignal;
42import android.os.OperationCanceledException;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080043import android.os.ParcelFileDescriptor;
Dianne Hackborn2af632f2009-07-08 14:56:37 -070044import android.os.Process;
Ben Lin1cf454f2016-11-10 13:50:54 -080045import android.os.RemoteException;
Dianne Hackbornf02b60a2012-08-16 10:48:27 -070046import android.os.UserHandle;
Nicolas Prevotd85fc722014-04-16 19:52:08 +010047import android.text.TextUtils;
Jeff Sharkey0e621c32015-07-24 15:10:20 -070048import android.util.Log;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080049
50import java.io.File;
Marco Nelissen18cb2872011-11-15 11:19:53 -080051import java.io.FileDescriptor;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080052import java.io.FileNotFoundException;
Dianne Hackborn23fdaf62010-08-06 12:16:55 -070053import java.io.IOException;
Marco Nelissen18cb2872011-11-15 11:19:53 -080054import java.io.PrintWriter;
Fred Quintana03d94902009-05-22 14:23:31 -070055import java.util.ArrayList;
Andreas Gampee6748ce2015-12-11 18:00:38 -080056import java.util.Arrays;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080057
58/**
59 * Content providers are one of the primary building blocks of Android applications, providing
60 * content to applications. They encapsulate data and provide it to applications through the single
61 * {@link ContentResolver} interface. A content provider is only required if you need to share
62 * data between multiple applications. For example, the contacts data is used by multiple
63 * applications and must be stored in a content provider. If you don't need to share data amongst
64 * multiple applications you can use a database directly via
65 * {@link android.database.sqlite.SQLiteDatabase}.
66 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080067 * <p>When a request is made via
68 * a {@link ContentResolver} the system inspects the authority of the given URI and passes the
69 * request to the content provider registered with the authority. The content provider can interpret
70 * the rest of the URI however it wants. The {@link UriMatcher} class is helpful for parsing
71 * URIs.</p>
72 *
73 * <p>The primary methods that need to be implemented are:
74 * <ul>
Dan Egnor6fcc0f0732010-07-27 16:32:17 -070075 * <li>{@link #onCreate} which is called to initialize the provider</li>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080076 * <li>{@link #query} which returns data to the caller</li>
77 * <li>{@link #insert} which inserts new data into the content provider</li>
78 * <li>{@link #update} which updates existing data in the content provider</li>
79 * <li>{@link #delete} which deletes data from the content provider</li>
80 * <li>{@link #getType} which returns the MIME type of data in the content provider</li>
81 * </ul></p>
82 *
Dan Egnor6fcc0f0732010-07-27 16:32:17 -070083 * <p class="caution">Data access methods (such as {@link #insert} and
84 * {@link #update}) may be called from many threads at once, and must be thread-safe.
85 * Other methods (such as {@link #onCreate}) are only called from the application
86 * main thread, and must avoid performing lengthy operations. See the method
87 * descriptions for their expected thread behavior.</p>
88 *
89 * <p>Requests to {@link ContentResolver} are automatically forwarded to the appropriate
90 * ContentProvider instance, so subclasses don't have to worry about the details of
91 * cross-process calls.</p>
Joe Fernandez558459f2011-10-13 16:47:36 -070092 *
93 * <div class="special reference">
94 * <h3>Developer Guides</h3>
95 * <p>For more information about using content providers, read the
96 * <a href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a>
97 * developer guide.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -080098 */
Dianne Hackbornc68c9132011-07-29 01:25:18 -070099public abstract class ContentProvider implements ComponentCallbacks2 {
Steve McKayea93fe72016-12-02 11:35:35 -0800100
Vasu Nori0c9e14a2010-08-04 13:31:48 -0700101 private static final String TAG = "ContentProvider";
102
Daisuke Miyakawa8280c2b2009-10-22 08:36:42 +0900103 /*
104 * Note: if you add methods to ContentProvider, you must add similar methods to
105 * MockContentProvider.
106 */
107
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800108 private Context mContext = null;
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700109 private int mMyUid;
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100110
111 // Since most Providers have only one authority, we keep both a String and a String[] to improve
112 // performance.
113 private String mAuthority;
114 private String[] mAuthorities;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800115 private String mReadPermission;
116 private String mWritePermission;
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700117 private PathPermission[] mPathPermissions;
Dianne Hackbornb424b632010-08-18 15:59:05 -0700118 private boolean mExported;
Dianne Hackborn7e6f9762013-02-26 13:35:11 -0800119 private boolean mNoPerms;
Amith Yamasania6f4d582014-08-07 17:58:39 -0700120 private boolean mSingleUser;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800121
Steve McKayea93fe72016-12-02 11:35:35 -0800122 private final ThreadLocal<String> mCallingPackage = new ThreadLocal<>();
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700123
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800124 private Transport mTransport = new Transport();
125
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700126 /**
127 * Construct a ContentProvider instance. Content providers must be
128 * <a href="{@docRoot}guide/topics/manifest/provider-element.html">declared
129 * in the manifest</a>, accessed with {@link ContentResolver}, and created
130 * automatically by the system, so applications usually do not create
131 * ContentProvider instances directly.
132 *
133 * <p>At construction time, the object is uninitialized, and most fields and
134 * methods are unavailable. Subclasses should initialize themselves in
135 * {@link #onCreate}, not the constructor.
136 *
137 * <p>Content providers are created on the application main thread at
138 * application launch time. The constructor must not perform lengthy
139 * operations, or application startup will be delayed.
140 */
Daisuke Miyakawa8280c2b2009-10-22 08:36:42 +0900141 public ContentProvider() {
142 }
143
144 /**
145 * Constructor just for mocking.
146 *
147 * @param context A Context object which should be some mock instance (like the
148 * instance of {@link android.test.mock.MockContext}).
149 * @param readPermission The read permision you want this instance should have in the
150 * test, which is available via {@link #getReadPermission()}.
151 * @param writePermission The write permission you want this instance should have
152 * in the test, which is available via {@link #getWritePermission()}.
153 * @param pathPermissions The PathPermissions you want this instance should have
154 * in the test, which is available via {@link #getPathPermissions()}.
155 * @hide
156 */
157 public ContentProvider(
158 Context context,
159 String readPermission,
160 String writePermission,
161 PathPermission[] pathPermissions) {
162 mContext = context;
163 mReadPermission = readPermission;
164 mWritePermission = writePermission;
165 mPathPermissions = pathPermissions;
166 }
167
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800168 /**
169 * Given an IContentProvider, try to coerce it back to the real
170 * ContentProvider object if it is running in the local process. This can
171 * be used if you know you are running in the same process as a provider,
172 * and want to get direct access to its implementation details. Most
173 * clients should not nor have a reason to use it.
174 *
175 * @param abstractInterface The ContentProvider interface that is to be
176 * coerced.
Christopher Tate2bc6eb82013-01-03 12:04:08 -0800177 * @return If the IContentProvider is non-{@code null} and local, returns its actual
178 * ContentProvider instance. Otherwise returns {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800179 * @hide
180 */
181 public static ContentProvider coerceToLocalContentProvider(
182 IContentProvider abstractInterface) {
183 if (abstractInterface instanceof Transport) {
184 return ((Transport)abstractInterface).getContentProvider();
185 }
186 return null;
187 }
188
189 /**
190 * Binder object that deals with remoting.
191 *
192 * @hide
193 */
194 class Transport extends ContentProviderNative {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800195 AppOpsManager mAppOpsManager = null;
Dianne Hackborn961321f2013-02-05 17:22:41 -0800196 int mReadOp = AppOpsManager.OP_NONE;
197 int mWriteOp = AppOpsManager.OP_NONE;
Dianne Hackborn35654b62013-01-14 17:38:02 -0800198
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800199 ContentProvider getContentProvider() {
200 return ContentProvider.this;
201 }
202
Jeff Brownd2183652011-10-09 12:39:53 -0700203 @Override
204 public String getProviderName() {
205 return getContentProvider().getClass().getName();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800206 }
207
Jeff Brown75ea64f2012-01-25 19:37:13 -0800208 @Override
Steve McKayea93fe72016-12-02 11:35:35 -0800209 public Cursor query(String callingPkg, Uri uri, @Nullable String[] projection,
210 @Nullable Bundle queryArgs, @Nullable ICancellationSignal cancellationSignal) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100211 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100212 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800213 if (enforceReadPermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Svet Ganov7271f3e2015-04-23 10:16:53 -0700214 // The caller has no access to the data, so return an empty cursor with
215 // the columns in the requested order. The caller may ask for an invalid
216 // column and we would not catch that but this is not a problem in practice.
217 // We do not call ContentProvider#query with a modified where clause since
218 // the implementation is not guaranteed to be backed by a SQL database, hence
219 // it may not handle properly the tautology where clause we would have created.
Svet Ganova2147ec2015-04-27 17:00:44 -0700220 if (projection != null) {
221 return new MatrixCursor(projection, 0);
222 }
223
224 // Null projection means all columns but we have no idea which they are.
225 // However, the caller may be expecting to access them my index. Hence,
226 // we have to execute the query as if allowed to get a cursor with the
227 // columns. We then use the column names to return an empty cursor.
Steve McKayea93fe72016-12-02 11:35:35 -0800228 Cursor cursor = ContentProvider.this.query(
229 uri, projection, queryArgs,
230 CancellationSignal.fromTransport(cancellationSignal));
Makoto Onuki34bdcdb2015-06-12 17:14:57 -0700231 if (cursor == null) {
232 return null;
Svet Ganova2147ec2015-04-27 17:00:44 -0700233 }
234
235 // Return an empty cursor for all columns.
Makoto Onuki34bdcdb2015-06-12 17:14:57 -0700236 return new MatrixCursor(cursor.getColumnNames(), 0);
Dianne Hackborn5e45ee62013-01-24 19:13:44 -0800237 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700238 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700239 try {
240 return ContentProvider.this.query(
Steve McKayea93fe72016-12-02 11:35:35 -0800241 uri, projection, queryArgs,
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700242 CancellationSignal.fromTransport(cancellationSignal));
243 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700244 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700245 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800246 }
247
Jeff Brown75ea64f2012-01-25 19:37:13 -0800248 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800249 public String getType(Uri uri) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100250 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100251 uri = maybeGetUriWithoutUserId(uri);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800252 return ContentProvider.this.getType(uri);
253 }
254
Jeff Brown75ea64f2012-01-25 19:37:13 -0800255 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800256 public Uri insert(String callingPkg, Uri uri, ContentValues initialValues) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100257 validateIncomingUri(uri);
258 int userId = getUserIdFromUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100259 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800260 if (enforceWritePermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackbornd7960d12013-01-29 18:55:48 -0800261 return rejectInsert(uri, initialValues);
Dianne Hackborn5e45ee62013-01-24 19:13:44 -0800262 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700263 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700264 try {
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100265 return maybeAddUserId(ContentProvider.this.insert(uri, initialValues), userId);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700266 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700267 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700268 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800269 }
270
Jeff Brown75ea64f2012-01-25 19:37:13 -0800271 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800272 public int bulkInsert(String callingPkg, Uri uri, ContentValues[] initialValues) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100273 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100274 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800275 if (enforceWritePermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800276 return 0;
277 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700278 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700279 try {
280 return ContentProvider.this.bulkInsert(uri, initialValues);
281 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700282 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700283 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800284 }
285
Jeff Brown75ea64f2012-01-25 19:37:13 -0800286 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800287 public ContentProviderResult[] applyBatch(String callingPkg,
288 ArrayList<ContentProviderOperation> operations)
Fred Quintana89437372009-05-15 15:10:40 -0700289 throws OperationApplicationException {
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100290 int numOperations = operations.size();
291 final int[] userIds = new int[numOperations];
292 for (int i = 0; i < numOperations; i++) {
293 ContentProviderOperation operation = operations.get(i);
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100294 Uri uri = operation.getUri();
295 validateIncomingUri(uri);
296 userIds[i] = getUserIdFromUri(uri);
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100297 if (userIds[i] != UserHandle.USER_CURRENT) {
298 // Removing the user id from the uri.
299 operation = new ContentProviderOperation(operation, true);
300 operations.set(i, operation);
301 }
Fred Quintana89437372009-05-15 15:10:40 -0700302 if (operation.isReadOperation()) {
Dianne Hackbornff170242014-11-19 10:59:01 -0800303 if (enforceReadPermission(callingPkg, uri, null)
Dianne Hackborn35654b62013-01-14 17:38:02 -0800304 != AppOpsManager.MODE_ALLOWED) {
305 throw new OperationApplicationException("App op not allowed", 0);
306 }
Fred Quintana89437372009-05-15 15:10:40 -0700307 }
Fred Quintana89437372009-05-15 15:10:40 -0700308 if (operation.isWriteOperation()) {
Dianne Hackbornff170242014-11-19 10:59:01 -0800309 if (enforceWritePermission(callingPkg, uri, null)
Dianne Hackborn35654b62013-01-14 17:38:02 -0800310 != AppOpsManager.MODE_ALLOWED) {
311 throw new OperationApplicationException("App op not allowed", 0);
312 }
Fred Quintana89437372009-05-15 15:10:40 -0700313 }
314 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700315 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700316 try {
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100317 ContentProviderResult[] results = ContentProvider.this.applyBatch(operations);
Jay Shraunerac2506c2014-12-15 12:28:25 -0800318 if (results != null) {
319 for (int i = 0; i < results.length ; i++) {
320 if (userIds[i] != UserHandle.USER_CURRENT) {
321 // Adding the userId to the uri.
322 results[i] = new ContentProviderResult(results[i], userIds[i]);
323 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100324 }
325 }
326 return results;
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700327 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700328 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700329 }
Fred Quintana6a8d5332009-05-07 17:35:38 -0700330 }
331
Jeff Brown75ea64f2012-01-25 19:37:13 -0800332 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800333 public int delete(String callingPkg, Uri uri, String selection, String[] selectionArgs) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100334 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100335 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800336 if (enforceWritePermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800337 return 0;
338 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700339 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700340 try {
341 return ContentProvider.this.delete(uri, selection, selectionArgs);
342 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700343 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700344 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800345 }
346
Jeff Brown75ea64f2012-01-25 19:37:13 -0800347 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800348 public int update(String callingPkg, Uri uri, ContentValues values, String selection,
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800349 String[] selectionArgs) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100350 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100351 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800352 if (enforceWritePermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800353 return 0;
354 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700355 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700356 try {
357 return ContentProvider.this.update(uri, values, selection, selectionArgs);
358 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700359 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700360 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800361 }
362
Jeff Brown75ea64f2012-01-25 19:37:13 -0800363 @Override
Jeff Sharkeybd3b9022013-08-20 15:20:04 -0700364 public ParcelFileDescriptor openFile(
Dianne Hackbornff170242014-11-19 10:59:01 -0800365 String callingPkg, Uri uri, String mode, ICancellationSignal cancellationSignal,
366 IBinder callerToken) throws FileNotFoundException {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100367 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100368 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800369 enforceFilePermission(callingPkg, uri, mode, callerToken);
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700370 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700371 try {
372 return ContentProvider.this.openFile(
373 uri, mode, CancellationSignal.fromTransport(cancellationSignal));
374 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700375 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700376 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800377 }
378
Jeff Brown75ea64f2012-01-25 19:37:13 -0800379 @Override
Jeff Sharkeybd3b9022013-08-20 15:20:04 -0700380 public AssetFileDescriptor openAssetFile(
381 String callingPkg, Uri uri, String mode, ICancellationSignal cancellationSignal)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800382 throws FileNotFoundException {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100383 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100384 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800385 enforceFilePermission(callingPkg, uri, mode, null);
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700386 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700387 try {
388 return ContentProvider.this.openAssetFile(
389 uri, mode, CancellationSignal.fromTransport(cancellationSignal));
390 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700391 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700392 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800393 }
394
Jeff Brown75ea64f2012-01-25 19:37:13 -0800395 @Override
Scott Kennedy9f78f652015-03-01 15:29:25 -0800396 public Bundle call(
397 String callingPkg, String method, @Nullable String arg, @Nullable Bundle extras) {
Jeff Sharkeya04c7a72016-03-18 12:20:36 -0600398 Bundle.setDefusable(extras, true);
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700399 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700400 try {
401 return ContentProvider.this.call(method, arg, extras);
402 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700403 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700404 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -0800405 }
406
Dianne Hackborn23fdaf62010-08-06 12:16:55 -0700407 @Override
408 public String[] getStreamTypes(Uri uri, String mimeTypeFilter) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100409 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100410 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackborn23fdaf62010-08-06 12:16:55 -0700411 return ContentProvider.this.getStreamTypes(uri, mimeTypeFilter);
412 }
413
414 @Override
Dianne Hackborn35654b62013-01-14 17:38:02 -0800415 public AssetFileDescriptor openTypedAssetFile(String callingPkg, Uri uri, String mimeType,
Jeff Sharkeybd3b9022013-08-20 15:20:04 -0700416 Bundle opts, ICancellationSignal cancellationSignal) throws FileNotFoundException {
Jeff Sharkeya04c7a72016-03-18 12:20:36 -0600417 Bundle.setDefusable(opts, true);
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100418 validateIncomingUri(uri);
Robin Lee2ab02e22016-07-28 18:41:23 +0100419 uri = maybeGetUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800420 enforceFilePermission(callingPkg, uri, "r", null);
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700421 final String original = setCallingPackage(callingPkg);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700422 try {
423 return ContentProvider.this.openTypedAssetFile(
424 uri, mimeType, opts, CancellationSignal.fromTransport(cancellationSignal));
425 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700426 setCallingPackage(original);
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700427 }
Dianne Hackborn23fdaf62010-08-06 12:16:55 -0700428 }
429
Jeff Brown75ea64f2012-01-25 19:37:13 -0800430 @Override
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700431 public ICancellationSignal createCancellationSignal() {
Jeff Brown4c1241d2012-02-02 17:05:00 -0800432 return CancellationSignal.createTransport();
Jeff Brown75ea64f2012-01-25 19:37:13 -0800433 }
434
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700435 @Override
436 public Uri canonicalize(String callingPkg, Uri uri) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100437 validateIncomingUri(uri);
438 int userId = getUserIdFromUri(uri);
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100439 uri = getUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800440 if (enforceReadPermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700441 return null;
442 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700443 final String original = setCallingPackage(callingPkg);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700444 try {
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100445 return maybeAddUserId(ContentProvider.this.canonicalize(uri), userId);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700446 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700447 setCallingPackage(original);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700448 }
449 }
450
451 @Override
452 public Uri uncanonicalize(String callingPkg, Uri uri) {
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100453 validateIncomingUri(uri);
454 int userId = getUserIdFromUri(uri);
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100455 uri = getUriWithoutUserId(uri);
Dianne Hackbornff170242014-11-19 10:59:01 -0800456 if (enforceReadPermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700457 return null;
458 }
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700459 final String original = setCallingPackage(callingPkg);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700460 try {
Nicolas Prevotd85fc722014-04-16 19:52:08 +0100461 return maybeAddUserId(ContentProvider.this.uncanonicalize(uri), userId);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700462 } finally {
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700463 setCallingPackage(original);
Dianne Hackborn38ed2a42013-09-06 16:17:22 -0700464 }
465 }
466
Ben Lin1cf454f2016-11-10 13:50:54 -0800467 @Override
468 public boolean refresh(String callingPkg, Uri uri, Bundle args,
469 ICancellationSignal cancellationSignal) throws RemoteException {
470 validateIncomingUri(uri);
471 uri = getUriWithoutUserId(uri);
472 if (enforceReadPermission(callingPkg, uri, null) != AppOpsManager.MODE_ALLOWED) {
473 return false;
474 }
475 final String original = setCallingPackage(callingPkg);
476 try {
477 return ContentProvider.this.refresh(uri, args,
478 CancellationSignal.fromTransport(cancellationSignal));
479 } finally {
480 setCallingPackage(original);
481 }
482 }
483
Dianne Hackbornff170242014-11-19 10:59:01 -0800484 private void enforceFilePermission(String callingPkg, Uri uri, String mode,
485 IBinder callerToken) throws FileNotFoundException, SecurityException {
Jeff Sharkeyba761972013-02-28 15:57:36 -0800486 if (mode != null && mode.indexOf('w') != -1) {
Dianne Hackbornff170242014-11-19 10:59:01 -0800487 if (enforceWritePermission(callingPkg, uri, callerToken)
488 != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800489 throw new FileNotFoundException("App op not allowed");
490 }
491 } else {
Dianne Hackbornff170242014-11-19 10:59:01 -0800492 if (enforceReadPermission(callingPkg, uri, callerToken)
493 != AppOpsManager.MODE_ALLOWED) {
Dianne Hackborn35654b62013-01-14 17:38:02 -0800494 throw new FileNotFoundException("App op not allowed");
495 }
496 }
497 }
498
Dianne Hackbornff170242014-11-19 10:59:01 -0800499 private int enforceReadPermission(String callingPkg, Uri uri, IBinder callerToken)
500 throws SecurityException {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700501 final int mode = enforceReadPermissionInner(uri, callingPkg, callerToken);
502 if (mode != MODE_ALLOWED) {
503 return mode;
Dianne Hackborn35654b62013-01-14 17:38:02 -0800504 }
Svet Ganov99b60432015-06-27 13:15:22 -0700505
506 if (mReadOp != AppOpsManager.OP_NONE) {
507 return mAppOpsManager.noteProxyOp(mReadOp, callingPkg);
508 }
509
Dianne Hackborn35654b62013-01-14 17:38:02 -0800510 return AppOpsManager.MODE_ALLOWED;
511 }
512
Dianne Hackbornff170242014-11-19 10:59:01 -0800513 private int enforceWritePermission(String callingPkg, Uri uri, IBinder callerToken)
514 throws SecurityException {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700515 final int mode = enforceWritePermissionInner(uri, callingPkg, callerToken);
516 if (mode != MODE_ALLOWED) {
517 return mode;
Dianne Hackborn35654b62013-01-14 17:38:02 -0800518 }
Svet Ganov99b60432015-06-27 13:15:22 -0700519
520 if (mWriteOp != AppOpsManager.OP_NONE) {
521 return mAppOpsManager.noteProxyOp(mWriteOp, callingPkg);
522 }
523
Dianne Hackborn35654b62013-01-14 17:38:02 -0800524 return AppOpsManager.MODE_ALLOWED;
525 }
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700526 }
Dianne Hackborn35654b62013-01-14 17:38:02 -0800527
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100528 boolean checkUser(int pid, int uid, Context context) {
529 return UserHandle.getUserId(uid) == context.getUserId()
Amith Yamasania6f4d582014-08-07 17:58:39 -0700530 || mSingleUser
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100531 || context.checkPermission(INTERACT_ACROSS_USERS, pid, uid)
532 == PERMISSION_GRANTED;
533 }
534
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700535 /**
536 * Verify that calling app holds both the given permission and any app-op
537 * associated with that permission.
538 */
539 private int checkPermissionAndAppOp(String permission, String callingPkg,
540 IBinder callerToken) {
541 if (getContext().checkPermission(permission, Binder.getCallingPid(), Binder.getCallingUid(),
542 callerToken) != PERMISSION_GRANTED) {
543 return MODE_ERRORED;
544 }
545
546 final int permOp = AppOpsManager.permissionToOpCode(permission);
547 if (permOp != AppOpsManager.OP_NONE) {
548 return mTransport.mAppOpsManager.noteProxyOp(permOp, callingPkg);
549 }
550
551 return MODE_ALLOWED;
552 }
553
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700554 /** {@hide} */
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700555 protected int enforceReadPermissionInner(Uri uri, String callingPkg, IBinder callerToken)
Dianne Hackbornff170242014-11-19 10:59:01 -0800556 throws SecurityException {
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700557 final Context context = getContext();
558 final int pid = Binder.getCallingPid();
559 final int uid = Binder.getCallingUid();
560 String missingPerm = null;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700561 int strongestMode = MODE_ALLOWED;
Jeff Sharkey110a6b62012-03-12 11:12:41 -0700562
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700563 if (UserHandle.isSameApp(uid, mMyUid)) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700564 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700565 }
566
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100567 if (mExported && checkUser(pid, uid, context)) {
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700568 final String componentPerm = getReadPermission();
569 if (componentPerm != null) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700570 final int mode = checkPermissionAndAppOp(componentPerm, callingPkg, callerToken);
571 if (mode == MODE_ALLOWED) {
572 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700573 } else {
574 missingPerm = componentPerm;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700575 strongestMode = Math.max(strongestMode, mode);
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700576 }
Jeff Sharkeye5d49332012-03-13 12:13:17 -0700577 }
Jeff Sharkey110a6b62012-03-12 11:12:41 -0700578
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700579 // track if unprotected read is allowed; any denied
580 // <path-permission> below removes this ability
581 boolean allowDefaultRead = (componentPerm == null);
Jeff Sharkey110a6b62012-03-12 11:12:41 -0700582
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700583 final PathPermission[] pps = getPathPermissions();
584 if (pps != null) {
585 final String path = uri.getPath();
586 for (PathPermission pp : pps) {
587 final String pathPerm = pp.getReadPermission();
588 if (pathPerm != null && pp.match(path)) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700589 final int mode = checkPermissionAndAppOp(pathPerm, callingPkg, callerToken);
590 if (mode == MODE_ALLOWED) {
591 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700592 } else {
593 // any denied <path-permission> means we lose
594 // default <provider> access.
595 allowDefaultRead = false;
596 missingPerm = pathPerm;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700597 strongestMode = Math.max(strongestMode, mode);
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700598 }
599 }
600 }
601 }
Jeff Sharkey110a6b62012-03-12 11:12:41 -0700602
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700603 // if we passed <path-permission> checks above, and no default
604 // <provider> permission, then allow access.
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700605 if (allowDefaultRead) return MODE_ALLOWED;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800606 }
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700607
608 // last chance, check against any uri grants
Amith Yamasani7d2d4fd2014-11-05 15:46:09 -0800609 final int callingUserId = UserHandle.getUserId(uid);
610 final Uri userUri = (mSingleUser && !UserHandle.isSameUser(mMyUid, uid))
611 ? maybeAddUserId(uri, callingUserId) : uri;
Dianne Hackbornff170242014-11-19 10:59:01 -0800612 if (context.checkUriPermission(userUri, pid, uid, Intent.FLAG_GRANT_READ_URI_PERMISSION,
613 callerToken) == PERMISSION_GRANTED) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700614 return MODE_ALLOWED;
615 }
616
617 // If the worst denial we found above was ignored, then pass that
618 // ignored through; otherwise we assume it should be a real error below.
619 if (strongestMode == MODE_IGNORED) {
620 return MODE_IGNORED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700621 }
622
Jeff Sharkeyc0cc2202017-03-21 19:25:34 -0600623 final String suffix;
624 if (android.Manifest.permission.MANAGE_DOCUMENTS.equals(mReadPermission)) {
625 suffix = " requires that you obtain access using ACTION_OPEN_DOCUMENT or related APIs";
626 } else if (mExported) {
627 suffix = " requires " + missingPerm + ", or grantUriPermission()";
628 } else {
629 suffix = " requires the provider be exported, or grantUriPermission()";
630 }
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700631 throw new SecurityException("Permission Denial: reading "
632 + ContentProvider.this.getClass().getName() + " uri " + uri + " from pid=" + pid
Jeff Sharkeyc0cc2202017-03-21 19:25:34 -0600633 + ", uid=" + uid + suffix);
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700634 }
635
636 /** {@hide} */
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700637 protected int enforceWritePermissionInner(Uri uri, String callingPkg, IBinder callerToken)
Dianne Hackbornff170242014-11-19 10:59:01 -0800638 throws SecurityException {
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700639 final Context context = getContext();
640 final int pid = Binder.getCallingPid();
641 final int uid = Binder.getCallingUid();
642 String missingPerm = null;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700643 int strongestMode = MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700644
645 if (UserHandle.isSameApp(uid, mMyUid)) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700646 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700647 }
648
Nicolas Prevot504d78e2014-06-26 10:07:33 +0100649 if (mExported && checkUser(pid, uid, context)) {
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700650 final String componentPerm = getWritePermission();
651 if (componentPerm != null) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700652 final int mode = checkPermissionAndAppOp(componentPerm, callingPkg, callerToken);
653 if (mode == MODE_ALLOWED) {
654 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700655 } else {
656 missingPerm = componentPerm;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700657 strongestMode = Math.max(strongestMode, mode);
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700658 }
659 }
660
661 // track if unprotected write is allowed; any denied
662 // <path-permission> below removes this ability
663 boolean allowDefaultWrite = (componentPerm == null);
664
665 final PathPermission[] pps = getPathPermissions();
666 if (pps != null) {
667 final String path = uri.getPath();
668 for (PathPermission pp : pps) {
669 final String pathPerm = pp.getWritePermission();
670 if (pathPerm != null && pp.match(path)) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700671 final int mode = checkPermissionAndAppOp(pathPerm, callingPkg, callerToken);
672 if (mode == MODE_ALLOWED) {
673 return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700674 } else {
675 // any denied <path-permission> means we lose
676 // default <provider> access.
677 allowDefaultWrite = false;
678 missingPerm = pathPerm;
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700679 strongestMode = Math.max(strongestMode, mode);
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700680 }
681 }
682 }
683 }
684
685 // if we passed <path-permission> checks above, and no default
686 // <provider> permission, then allow access.
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700687 if (allowDefaultWrite) return MODE_ALLOWED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700688 }
689
690 // last chance, check against any uri grants
Dianne Hackbornff170242014-11-19 10:59:01 -0800691 if (context.checkUriPermission(uri, pid, uid, Intent.FLAG_GRANT_WRITE_URI_PERMISSION,
692 callerToken) == PERMISSION_GRANTED) {
Jeff Sharkey0e621c32015-07-24 15:10:20 -0700693 return MODE_ALLOWED;
694 }
695
696 // If the worst denial we found above was ignored, then pass that
697 // ignored through; otherwise we assume it should be a real error below.
698 if (strongestMode == MODE_IGNORED) {
699 return MODE_IGNORED;
Jeff Sharkey8a2998e2013-10-31 14:55:44 -0700700 }
701
702 final String failReason = mExported
703 ? " requires " + missingPerm + ", or grantUriPermission()"
704 : " requires the provider be exported, or grantUriPermission()";
705 throw new SecurityException("Permission Denial: writing "
706 + ContentProvider.this.getClass().getName() + " uri " + uri + " from pid=" + pid
707 + ", uid=" + uid + failReason);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800708 }
709
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800710 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700711 * Retrieves the Context this provider is running in. Only available once
Christopher Tate2bc6eb82013-01-03 12:04:08 -0800712 * {@link #onCreate} has been called -- this will return {@code null} in the
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800713 * constructor.
714 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700715 public final @Nullable Context getContext() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800716 return mContext;
717 }
718
719 /**
Jeff Sharkey72e2e352013-09-09 18:52:48 -0700720 * Set the calling package, returning the current value (or {@code null})
721 * which can be used later to restore the previous state.
722 */
723 private String setCallingPackage(String callingPackage) {
724 final String original = mCallingPackage.get();
725 mCallingPackage.set(callingPackage);
726 return original;
727 }
728
729 /**
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700730 * Return the package name of the caller that initiated the request being
731 * processed on the current thread. The returned package will have been
732 * verified to belong to the calling UID. Returns {@code null} if not
733 * currently processing a request.
734 * <p>
735 * This will always return {@code null} when processing
736 * {@link #getType(Uri)} or {@link #getStreamTypes(Uri, String)} requests.
737 *
738 * @see Binder#getCallingUid()
739 * @see Context#grantUriPermission(String, Uri, int)
740 * @throws SecurityException if the calling package doesn't belong to the
741 * calling UID.
742 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700743 public final @Nullable String getCallingPackage() {
Jeff Sharkey911d7f42013-09-05 18:11:45 -0700744 final String pkg = mCallingPackage.get();
745 if (pkg != null) {
746 mTransport.mAppOpsManager.checkPackage(Binder.getCallingUid(), pkg);
747 }
748 return pkg;
749 }
750
751 /**
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100752 * Change the authorities of the ContentProvider.
753 * This is normally set for you from its manifest information when the provider is first
754 * created.
755 * @hide
756 * @param authorities the semi-colon separated authorities of the ContentProvider.
757 */
758 protected final void setAuthorities(String authorities) {
Nicolas Prevot6e412ad2014-09-08 18:26:55 +0100759 if (authorities != null) {
760 if (authorities.indexOf(';') == -1) {
761 mAuthority = authorities;
762 mAuthorities = null;
763 } else {
764 mAuthority = null;
765 mAuthorities = authorities.split(";");
766 }
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100767 }
768 }
769
770 /** @hide */
771 protected final boolean matchesOurAuthorities(String authority) {
772 if (mAuthority != null) {
773 return mAuthority.equals(authority);
774 }
Nicolas Prevot6e412ad2014-09-08 18:26:55 +0100775 if (mAuthorities != null) {
776 int length = mAuthorities.length;
777 for (int i = 0; i < length; i++) {
778 if (mAuthorities[i].equals(authority)) return true;
779 }
Nicolas Prevotf300bab2014-08-07 19:23:17 +0100780 }
781 return false;
782 }
783
784
785 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800786 * Change the permission required to read data from the content
787 * provider. This is normally set for you from its manifest information
788 * when the provider is first created.
789 *
790 * @param permission Name of the permission required for read-only access.
791 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700792 protected final void setReadPermission(@Nullable String permission) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800793 mReadPermission = permission;
794 }
795
796 /**
797 * Return the name of the permission required for read-only access to
798 * this content provider. This method can be called from multiple
799 * threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -0800800 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
801 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800802 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700803 public final @Nullable String getReadPermission() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800804 return mReadPermission;
805 }
806
807 /**
808 * Change the permission required to read and write data in the content
809 * provider. This is normally set for you from its manifest information
810 * when the provider is first created.
811 *
812 * @param permission Name of the permission required for read/write access.
813 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700814 protected final void setWritePermission(@Nullable String permission) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800815 mWritePermission = permission;
816 }
817
818 /**
819 * Return the name of the permission required for read/write access to
820 * this content provider. This method can be called from multiple
821 * threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -0800822 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
823 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800824 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700825 public final @Nullable String getWritePermission() {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800826 return mWritePermission;
827 }
828
829 /**
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700830 * Change the path-based permission required to read and/or write data in
831 * the content provider. This is normally set for you from its manifest
832 * information when the provider is first created.
833 *
834 * @param permissions Array of path permission descriptions.
835 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700836 protected final void setPathPermissions(@Nullable PathPermission[] permissions) {
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700837 mPathPermissions = permissions;
838 }
839
840 /**
841 * Return the path-based permissions required for read and/or write access to
842 * this content provider. This method can be called from multiple
843 * threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -0800844 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
845 * and Threads</a>.
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700846 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700847 public final @Nullable PathPermission[] getPathPermissions() {
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700848 return mPathPermissions;
849 }
850
Dianne Hackborn35654b62013-01-14 17:38:02 -0800851 /** @hide */
852 public final void setAppOps(int readOp, int writeOp) {
Dianne Hackborn7e6f9762013-02-26 13:35:11 -0800853 if (!mNoPerms) {
Dianne Hackborn7e6f9762013-02-26 13:35:11 -0800854 mTransport.mReadOp = readOp;
855 mTransport.mWriteOp = writeOp;
856 }
Dianne Hackborn35654b62013-01-14 17:38:02 -0800857 }
858
Dianne Hackborn961321f2013-02-05 17:22:41 -0800859 /** @hide */
860 public AppOpsManager getAppOpsManager() {
861 return mTransport.mAppOpsManager;
862 }
863
Dianne Hackborn2af632f2009-07-08 14:56:37 -0700864 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700865 * Implement this to initialize your content provider on startup.
866 * This method is called for all registered content providers on the
867 * application main thread at application launch time. It must not perform
868 * lengthy operations, or application startup will be delayed.
869 *
870 * <p>You should defer nontrivial initialization (such as opening,
871 * upgrading, and scanning databases) until the content provider is used
872 * (via {@link #query}, {@link #insert}, etc). Deferred initialization
873 * keeps application startup fast, avoids unnecessary work if the provider
874 * turns out not to be needed, and stops database errors (such as a full
875 * disk) from halting application launch.
876 *
Dan Egnor17876aa2010-07-28 12:28:04 -0700877 * <p>If you use SQLite, {@link android.database.sqlite.SQLiteOpenHelper}
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700878 * is a helpful utility class that makes it easy to manage databases,
879 * and will automatically defer opening until first use. If you do use
880 * SQLiteOpenHelper, make sure to avoid calling
881 * {@link android.database.sqlite.SQLiteOpenHelper#getReadableDatabase} or
882 * {@link android.database.sqlite.SQLiteOpenHelper#getWritableDatabase}
883 * from this method. (Instead, override
884 * {@link android.database.sqlite.SQLiteOpenHelper#onOpen} to initialize the
885 * database when it is first opened.)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800886 *
887 * @return true if the provider was successfully loaded, false otherwise
888 */
889 public abstract boolean onCreate();
890
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700891 /**
892 * {@inheritDoc}
893 * This method is always called on the application main thread, and must
894 * not perform lengthy operations.
895 *
896 * <p>The default content provider implementation does nothing.
897 * Override this method to take appropriate action.
898 * (Content providers do not usually care about things like screen
899 * orientation, but may want to know about locale changes.)
900 */
Steve McKayea93fe72016-12-02 11:35:35 -0800901 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800902 public void onConfigurationChanged(Configuration newConfig) {
903 }
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700904
905 /**
906 * {@inheritDoc}
907 * This method is always called on the application main thread, and must
908 * not perform lengthy operations.
909 *
910 * <p>The default content provider implementation does nothing.
911 * Subclasses may override this method to take appropriate action.
912 */
Steve McKayea93fe72016-12-02 11:35:35 -0800913 @Override
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800914 public void onLowMemory() {
915 }
916
Steve McKayea93fe72016-12-02 11:35:35 -0800917 @Override
Dianne Hackbornc68c9132011-07-29 01:25:18 -0700918 public void onTrimMemory(int level) {
919 }
920
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800921 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -0700922 * Implement this to handle query requests from clients.
Steve McKay29c3f682016-12-16 14:52:59 -0800923 *
924 * <p>Apps targeting {@link android.os.Build.VERSION_CODES#O} or higher should override
925 * {@link #query(Uri, String[], Bundle, CancellationSignal)} and provide a stub
926 * implementation of this method.
927 *
928 * <p>This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -0800929 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
930 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800931 * <p>
932 * Example client call:<p>
933 * <pre>// Request a specific record.
934 * Cursor managedCursor = managedQuery(
Alan Jones81a476f2009-05-21 12:32:17 +1000935 ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2),
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800936 projection, // Which columns to return.
937 null, // WHERE clause.
Alan Jones81a476f2009-05-21 12:32:17 +1000938 null, // WHERE clause value substitution
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800939 People.NAME + " ASC"); // Sort order.</pre>
940 * Example implementation:<p>
941 * <pre>// SQLiteQueryBuilder is a helper class that creates the
942 // proper SQL syntax for us.
943 SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder();
944
945 // Set the table we're querying.
946 qBuilder.setTables(DATABASE_TABLE_NAME);
947
948 // If the query ends in a specific record number, we're
949 // being asked for a specific record, so set the
950 // WHERE clause in our query.
951 if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){
952 qBuilder.appendWhere("_id=" + uri.getPathLeafId());
953 }
954
955 // Make the query.
956 Cursor c = qBuilder.query(mDb,
957 projection,
958 selection,
959 selectionArgs,
960 groupBy,
961 having,
962 sortOrder);
963 c.setNotificationUri(getContext().getContentResolver(), uri);
964 return c;</pre>
965 *
966 * @param uri The URI to query. This will be the full URI sent by the client;
Alan Jones81a476f2009-05-21 12:32:17 +1000967 * if the client is requesting a specific record, the URI will end in a record number
968 * that the implementation should parse and add to a WHERE or HAVING clause, specifying
969 * that _id value.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800970 * @param projection The list of columns to put into the cursor. If
Christopher Tate2bc6eb82013-01-03 12:04:08 -0800971 * {@code null} all columns are included.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800972 * @param selection A selection criteria to apply when filtering rows.
Christopher Tate2bc6eb82013-01-03 12:04:08 -0800973 * If {@code null} then all rows are included.
Alan Jones81a476f2009-05-21 12:32:17 +1000974 * @param selectionArgs You may include ?s in selection, which will be replaced by
975 * the values from selectionArgs, in order that they appear in the selection.
976 * The values will be bound as Strings.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800977 * @param sortOrder How the rows in the cursor should be sorted.
Christopher Tate2bc6eb82013-01-03 12:04:08 -0800978 * If {@code null} then the provider is free to define the sort order.
979 * @return a Cursor or {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800980 */
Jeff Sharkey673db442015-06-11 19:30:57 -0700981 public abstract @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,
982 @Nullable String selection, @Nullable String[] selectionArgs,
983 @Nullable String sortOrder);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800984
Fred Quintana5bba6322009-10-05 14:21:12 -0700985 /**
Jeff Brown4c1241d2012-02-02 17:05:00 -0800986 * Implement this to handle query requests from clients with support for cancellation.
Steve McKay29c3f682016-12-16 14:52:59 -0800987 *
988 * <p>Apps targeting {@link android.os.Build.VERSION_CODES#O} or higher should override
989 * {@link #query(Uri, String[], Bundle, CancellationSignal)} instead of this method.
990 *
991 * <p>This method can be called from multiple threads, as described in
Jeff Brown75ea64f2012-01-25 19:37:13 -0800992 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
993 * and Threads</a>.
994 * <p>
995 * Example client call:<p>
996 * <pre>// Request a specific record.
997 * Cursor managedCursor = managedQuery(
998 ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2),
999 projection, // Which columns to return.
1000 null, // WHERE clause.
1001 null, // WHERE clause value substitution
1002 People.NAME + " ASC"); // Sort order.</pre>
1003 * Example implementation:<p>
1004 * <pre>// SQLiteQueryBuilder is a helper class that creates the
1005 // proper SQL syntax for us.
1006 SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder();
1007
1008 // Set the table we're querying.
1009 qBuilder.setTables(DATABASE_TABLE_NAME);
1010
1011 // If the query ends in a specific record number, we're
1012 // being asked for a specific record, so set the
1013 // WHERE clause in our query.
1014 if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){
1015 qBuilder.appendWhere("_id=" + uri.getPathLeafId());
1016 }
1017
1018 // Make the query.
1019 Cursor c = qBuilder.query(mDb,
1020 projection,
1021 selection,
1022 selectionArgs,
1023 groupBy,
1024 having,
1025 sortOrder);
1026 c.setNotificationUri(getContext().getContentResolver(), uri);
1027 return c;</pre>
1028 * <p>
1029 * If you implement this method then you must also implement the version of
Jeff Brown4c1241d2012-02-02 17:05:00 -08001030 * {@link #query(Uri, String[], String, String[], String)} that does not take a cancellation
1031 * signal to ensure correct operation on older versions of the Android Framework in
1032 * which the cancellation signal overload was not available.
Jeff Brown75ea64f2012-01-25 19:37:13 -08001033 *
1034 * @param uri The URI to query. This will be the full URI sent by the client;
1035 * if the client is requesting a specific record, the URI will end in a record number
1036 * that the implementation should parse and add to a WHERE or HAVING clause, specifying
1037 * that _id value.
1038 * @param projection The list of columns to put into the cursor. If
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001039 * {@code null} all columns are included.
Jeff Brown75ea64f2012-01-25 19:37:13 -08001040 * @param selection A selection criteria to apply when filtering rows.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001041 * If {@code null} then all rows are included.
Jeff Brown75ea64f2012-01-25 19:37:13 -08001042 * @param selectionArgs You may include ?s in selection, which will be replaced by
1043 * the values from selectionArgs, in order that they appear in the selection.
1044 * The values will be bound as Strings.
1045 * @param sortOrder How the rows in the cursor should be sorted.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001046 * If {@code null} then the provider is free to define the sort order.
1047 * @param cancellationSignal A signal to cancel the operation in progress, or {@code null} if none.
Jeff Brown75ea64f2012-01-25 19:37:13 -08001048 * If the operation is canceled, then {@link OperationCanceledException} will be thrown
1049 * when the query is executed.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001050 * @return a Cursor or {@code null}.
Jeff Brown75ea64f2012-01-25 19:37:13 -08001051 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001052 public @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,
1053 @Nullable String selection, @Nullable String[] selectionArgs,
1054 @Nullable String sortOrder, @Nullable CancellationSignal cancellationSignal) {
Jeff Brown75ea64f2012-01-25 19:37:13 -08001055 return query(uri, projection, selection, selectionArgs, sortOrder);
1056 }
1057
1058 /**
Steve McKayea93fe72016-12-02 11:35:35 -08001059 * Implement this to handle query requests where the arguments are packed into a {@link Bundle}.
1060 * Arguments may include traditional SQL style query arguments. When present these
1061 * should be handled according to the contract established in
1062 * {@link #query(Uri, String[], String, String[], String, CancellationSignal).
1063 *
1064 * <p>Traditional SQL arguments can be found in the bundle using the following keys:
Steve McKay29c3f682016-12-16 14:52:59 -08001065 * <li>{@link ContentResolver#QUERY_ARG_SQL_SELECTION}
1066 * <li>{@link ContentResolver#QUERY_ARG_SQL_SELECTION_ARGS}
1067 * <li>{@link ContentResolver#QUERY_ARG_SQL_SORT_ORDER}
Steve McKayea93fe72016-12-02 11:35:35 -08001068 *
1069 * @see #query(Uri, String[], String, String[], String, CancellationSignal) for
1070 * implementation details.
1071 *
1072 * @param uri The URI to query. This will be the full URI sent by the client.
1073 * TODO: Me wonders about this use case, and how we adapt it.
1074 * If the client is requesting a specific record, the URI will end
1075 * in a record number that the implementation should parse and add
1076 * to a WHERE or HAVING clause, specifying that _id value.
1077 * @param projection The list of columns to put into the cursor.
1078 * If {@code null} provide a default set of columns.
1079 * @param queryArgs A Bundle containing all additional information necessary for the query.
1080 * Values in the Bundle may include SQL style arguments.
1081 * @param cancellationSignal A signal to cancel the operation in progress,
1082 * or {@code null}.
1083 * @return a Cursor or {@code null}.
1084 */
1085 public @Nullable Cursor query(@NonNull Uri uri, @Nullable String[] projection,
1086 @Nullable Bundle queryArgs, @Nullable CancellationSignal cancellationSignal) {
1087 queryArgs = queryArgs != null ? queryArgs : Bundle.EMPTY;
Steve McKay29c3f682016-12-16 14:52:59 -08001088
Steve McKayd7ece9f2017-01-12 16:59:59 -08001089 // if client doesn't supply an SQL sort order argument, attempt to build one from
1090 // QUERY_ARG_SORT* arguments.
Steve McKay29c3f682016-12-16 14:52:59 -08001091 String sortClause = queryArgs.getString(ContentResolver.QUERY_ARG_SQL_SORT_ORDER);
Steve McKay29c3f682016-12-16 14:52:59 -08001092 if (sortClause == null && queryArgs.containsKey(ContentResolver.QUERY_ARG_SORT_COLUMNS)) {
1093 sortClause = ContentResolver.createSqlSortClause(queryArgs);
1094 }
1095
Steve McKayea93fe72016-12-02 11:35:35 -08001096 return query(
1097 uri,
1098 projection,
Steve McKay29c3f682016-12-16 14:52:59 -08001099 queryArgs.getString(ContentResolver.QUERY_ARG_SQL_SELECTION),
1100 queryArgs.getStringArray(ContentResolver.QUERY_ARG_SQL_SELECTION_ARGS),
1101 sortClause,
Steve McKayea93fe72016-12-02 11:35:35 -08001102 cancellationSignal);
1103 }
1104
1105 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001106 * Implement this to handle requests for the MIME type of the data at the
1107 * given URI. The returned MIME type should start with
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001108 * <code>vnd.android.cursor.item</code> for a single record,
1109 * or <code>vnd.android.cursor.dir/</code> for multiple items.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001110 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001111 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1112 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001113 *
Dianne Hackborncca1f0e2010-09-26 18:34:53 -07001114 * <p>Note that there are no permissions needed for an application to
1115 * access this information; if your content provider requires read and/or
1116 * write permissions, or is not exported, all applications can still call
1117 * this method regardless of their access permissions. This allows them
1118 * to retrieve the MIME type for a URI when dispatching intents.
1119 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001120 * @param uri the URI to query.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001121 * @return a MIME type string, or {@code null} if there is no type.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001122 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001123 public abstract @Nullable String getType(@NonNull Uri uri);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001124
1125 /**
Dianne Hackborn38ed2a42013-09-06 16:17:22 -07001126 * Implement this to support canonicalization of URIs that refer to your
1127 * content provider. A canonical URI is one that can be transported across
1128 * devices, backup/restore, and other contexts, and still be able to refer
1129 * to the same data item. Typically this is implemented by adding query
1130 * params to the URI allowing the content provider to verify that an incoming
1131 * canonical URI references the same data as it was originally intended for and,
1132 * if it doesn't, to find that data (if it exists) in the current environment.
1133 *
1134 * <p>For example, if the content provider holds people and a normal URI in it
1135 * is created with a row index into that people database, the cananical representation
1136 * may have an additional query param at the end which specifies the name of the
1137 * person it is intended for. Later calls into the provider with that URI will look
1138 * up the row of that URI's base index and, if it doesn't match or its entry's
1139 * name doesn't match the name in the query param, perform a query on its database
1140 * to find the correct row to operate on.</p>
1141 *
1142 * <p>If you implement support for canonical URIs, <b>all</b> incoming calls with
1143 * URIs (including this one) must perform this verification and recovery of any
1144 * canonical URIs they receive. In addition, you must also implement
1145 * {@link #uncanonicalize} to strip the canonicalization of any of these URIs.</p>
1146 *
1147 * <p>The default implementation of this method returns null, indicating that
1148 * canonical URIs are not supported.</p>
1149 *
1150 * @param url The Uri to canonicalize.
1151 *
1152 * @return Return the canonical representation of <var>url</var>, or null if
1153 * canonicalization of that Uri is not supported.
1154 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001155 public @Nullable Uri canonicalize(@NonNull Uri url) {
Dianne Hackborn38ed2a42013-09-06 16:17:22 -07001156 return null;
1157 }
1158
1159 /**
1160 * Remove canonicalization from canonical URIs previously returned by
1161 * {@link #canonicalize}. For example, if your implementation is to add
1162 * a query param to canonicalize a URI, this method can simply trip any
1163 * query params on the URI. The default implementation always returns the
1164 * same <var>url</var> that was passed in.
1165 *
1166 * @param url The Uri to remove any canonicalization from.
1167 *
Dianne Hackbornb3ac67a2013-09-11 11:02:24 -07001168 * @return Return the non-canonical representation of <var>url</var>, return
1169 * the <var>url</var> as-is if there is nothing to do, or return null if
1170 * the data identified by the canonical representation can not be found in
1171 * the current environment.
Dianne Hackborn38ed2a42013-09-06 16:17:22 -07001172 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001173 public @Nullable Uri uncanonicalize(@NonNull Uri url) {
Dianne Hackborn38ed2a42013-09-06 16:17:22 -07001174 return url;
1175 }
1176
1177 /**
Ben Lin1cf454f2016-11-10 13:50:54 -08001178 * Implement this to support refresh of content identified by {@code uri}. By default, this
1179 * method returns false; providers who wish to implement this should return true to signal the
1180 * client that the provider has tried refreshing with its own implementation.
1181 * <p>
1182 * This allows clients to request an explicit refresh of content identified by {@code uri}.
1183 * <p>
1184 * Client code should only invoke this method when there is a strong indication (such as a user
1185 * initiated pull to refresh gesture) that the content is stale.
1186 * <p>
1187 * Remember to send {@link ContentResolver#notifyChange(Uri, android.database.ContentObserver)}
1188 * notifications when content changes.
1189 *
1190 * @param uri The Uri identifying the data to refresh.
1191 * @param args Additional options from the client. The definitions of these are specific to the
1192 * content provider being called.
1193 * @param cancellationSignal A signal to cancel the operation in progress, or {@code null} if
1194 * none. For example, if you called refresh on a particular uri, you should call
1195 * {@link CancellationSignal#throwIfCanceled()} to check whether the client has
1196 * canceled the refresh request.
1197 * @return true if the provider actually tried refreshing.
Ben Lin1cf454f2016-11-10 13:50:54 -08001198 */
1199 public boolean refresh(Uri uri, @Nullable Bundle args,
1200 @Nullable CancellationSignal cancellationSignal) {
1201 return false;
1202 }
1203
1204 /**
Dianne Hackbornd7960d12013-01-29 18:55:48 -08001205 * @hide
1206 * Implementation when a caller has performed an insert on the content
1207 * provider, but that call has been rejected for the operation given
1208 * to {@link #setAppOps(int, int)}. The default implementation simply
1209 * returns a dummy URI that is the base URI with a 0 path element
1210 * appended.
1211 */
1212 public Uri rejectInsert(Uri uri, ContentValues values) {
1213 // If not allowed, we need to return some reasonable URI. Maybe the
1214 // content provider should be responsible for this, but for now we
1215 // will just return the base URI with a dummy '0' tagged on to it.
1216 // You shouldn't be able to read if you can't write, anyway, so it
1217 // shouldn't matter much what is returned.
1218 return uri.buildUpon().appendPath("0").build();
1219 }
1220
1221 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001222 * Implement this to handle requests to insert a new row.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001223 * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()}
1224 * after inserting.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001225 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001226 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1227 * and Threads</a>.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001228 * @param uri The content:// URI of the insertion request. This must not be {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001229 * @param values A set of column_name/value pairs to add to the database.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001230 * This must not be {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001231 * @return The URI for the newly inserted item.
1232 */
Jeff Sharkey34796bd2015-06-11 21:55:32 -07001233 public abstract @Nullable Uri insert(@NonNull Uri uri, @Nullable ContentValues values);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001234
1235 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001236 * Override this to handle requests to insert a set of new rows, or the
1237 * default implementation will iterate over the values and call
1238 * {@link #insert} on each of them.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001239 * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()}
1240 * after inserting.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001241 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001242 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1243 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001244 *
1245 * @param uri The content:// URI of the insertion request.
1246 * @param values An array of sets of column_name/value pairs to add to the database.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001247 * This must not be {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001248 * @return The number of values that were inserted.
1249 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001250 public int bulkInsert(@NonNull Uri uri, @NonNull ContentValues[] values) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001251 int numValues = values.length;
1252 for (int i = 0; i < numValues; i++) {
1253 insert(uri, values[i]);
1254 }
1255 return numValues;
1256 }
1257
1258 /**
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001259 * Implement this to handle requests to delete one or more rows.
1260 * The implementation should apply the selection clause when performing
1261 * deletion, allowing the operation to affect multiple rows in a directory.
Taeho Kimbd88de42013-10-28 15:08:53 +09001262 * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001263 * after deleting.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001264 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001265 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1266 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001267 *
1268 * <p>The implementation is responsible for parsing out a row ID at the end
1269 * of the URI, if a specific row is being deleted. That is, the client would
1270 * pass in <code>content://contacts/people/22</code> and the implementation is
1271 * responsible for parsing the record number (22) when creating a SQL statement.
1272 *
1273 * @param uri The full URI to query, including a row ID (if a specific record is requested).
1274 * @param selection An optional restriction to apply to rows when deleting.
1275 * @return The number of rows affected.
1276 * @throws SQLException
1277 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001278 public abstract int delete(@NonNull Uri uri, @Nullable String selection,
1279 @Nullable String[] selectionArgs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001280
1281 /**
Dan Egnor17876aa2010-07-28 12:28:04 -07001282 * Implement this to handle requests to update one or more rows.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001283 * The implementation should update all rows matching the selection
1284 * to set the columns according to the provided values map.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001285 * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()}
1286 * after updating.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001287 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001288 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1289 * and Threads</a>.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001290 *
1291 * @param uri The URI to query. This can potentially have a record ID if this
1292 * is an update request for a specific record.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001293 * @param values A set of column_name/value pairs to update in the database.
1294 * This must not be {@code null}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001295 * @param selection An optional filter to match rows to update.
1296 * @return the number of rows affected.
1297 */
Jeff Sharkey34796bd2015-06-11 21:55:32 -07001298 public abstract int update(@NonNull Uri uri, @Nullable ContentValues values,
Jeff Sharkey673db442015-06-11 19:30:57 -07001299 @Nullable String selection, @Nullable String[] selectionArgs);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001300
1301 /**
Dan Egnor17876aa2010-07-28 12:28:04 -07001302 * Override this to handle requests to open a file blob.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001303 * The default implementation always throws {@link FileNotFoundException}.
1304 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001305 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1306 * and Threads</a>.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001307 *
Dan Egnor17876aa2010-07-28 12:28:04 -07001308 * <p>This method returns a ParcelFileDescriptor, which is returned directly
1309 * to the caller. This way large data (such as images and documents) can be
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001310 * returned without copying the content.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 *
1312 * <p>The returned ParcelFileDescriptor is owned by the caller, so it is
1313 * their responsibility to close it when done. That is, the implementation
1314 * of this method should create a new ParcelFileDescriptor for each call.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001315 * <p>
1316 * If opened with the exclusive "r" or "w" modes, the returned
1317 * ParcelFileDescriptor can be a pipe or socket pair to enable streaming
1318 * of data. Opening with the "rw" or "rwt" modes implies a file on disk that
1319 * supports seeking.
1320 * <p>
1321 * If you need to detect when the returned ParcelFileDescriptor has been
1322 * closed, or if the remote process has crashed or encountered some other
1323 * error, you can use {@link ParcelFileDescriptor#open(File, int,
1324 * android.os.Handler, android.os.ParcelFileDescriptor.OnCloseListener)},
1325 * {@link ParcelFileDescriptor#createReliablePipe()}, or
1326 * {@link ParcelFileDescriptor#createReliableSocketPair()}.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001327 *
Dianne Hackborna53ee352013-02-20 12:47:02 -08001328 * <p class="note">For use in Intents, you will want to implement {@link #getType}
1329 * to return the appropriate MIME type for the data returned here with
1330 * the same URI. This will allow intent resolution to automatically determine the data MIME
1331 * type and select the appropriate matching targets as part of its operation.</p>
1332 *
1333 * <p class="note">For better interoperability with other applications, it is recommended
1334 * that for any URIs that can be opened, you also support queries on them
1335 * containing at least the columns specified by {@link android.provider.OpenableColumns}.
1336 * You may also want to support other common columns if you have additional meta-data
1337 * to supply, such as {@link android.provider.MediaStore.MediaColumns#DATE_ADDED}
1338 * in {@link android.provider.MediaStore.MediaColumns}.</p>
1339 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001340 * @param uri The URI whose file is to be opened.
1341 * @param mode Access mode for the file. May be "r" for read-only access,
1342 * "rw" for read and write access, or "rwt" for read and write access
1343 * that truncates any existing file.
1344 *
1345 * @return Returns a new ParcelFileDescriptor which you can use to access
1346 * the file.
1347 *
1348 * @throws FileNotFoundException Throws FileNotFoundException if there is
1349 * no file associated with the given URI or the mode is invalid.
1350 * @throws SecurityException Throws SecurityException if the caller does
1351 * not have permission to access the file.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001352 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001353 * @see #openAssetFile(Uri, String)
1354 * @see #openFileHelper(Uri, String)
Dianne Hackborna53ee352013-02-20 12:47:02 -08001355 * @see #getType(android.net.Uri)
Jeff Sharkeye8c00d82013-10-15 15:46:10 -07001356 * @see ParcelFileDescriptor#parseMode(String)
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001357 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001358 public @Nullable ParcelFileDescriptor openFile(@NonNull Uri uri, @NonNull String mode)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001359 throws FileNotFoundException {
1360 throw new FileNotFoundException("No files supported by provider at "
1361 + uri);
1362 }
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001363
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001364 /**
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001365 * Override this to handle requests to open a file blob.
1366 * The default implementation always throws {@link FileNotFoundException}.
1367 * This method can be called from multiple threads, as described in
1368 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1369 * and Threads</a>.
1370 *
1371 * <p>This method returns a ParcelFileDescriptor, which is returned directly
1372 * to the caller. This way large data (such as images and documents) can be
1373 * returned without copying the content.
1374 *
1375 * <p>The returned ParcelFileDescriptor is owned by the caller, so it is
1376 * their responsibility to close it when done. That is, the implementation
1377 * of this method should create a new ParcelFileDescriptor for each call.
1378 * <p>
1379 * If opened with the exclusive "r" or "w" modes, the returned
1380 * ParcelFileDescriptor can be a pipe or socket pair to enable streaming
1381 * of data. Opening with the "rw" or "rwt" modes implies a file on disk that
1382 * supports seeking.
1383 * <p>
1384 * If you need to detect when the returned ParcelFileDescriptor has been
1385 * closed, or if the remote process has crashed or encountered some other
1386 * error, you can use {@link ParcelFileDescriptor#open(File, int,
1387 * android.os.Handler, android.os.ParcelFileDescriptor.OnCloseListener)},
1388 * {@link ParcelFileDescriptor#createReliablePipe()}, or
1389 * {@link ParcelFileDescriptor#createReliableSocketPair()}.
1390 *
1391 * <p class="note">For use in Intents, you will want to implement {@link #getType}
1392 * to return the appropriate MIME type for the data returned here with
1393 * the same URI. This will allow intent resolution to automatically determine the data MIME
1394 * type and select the appropriate matching targets as part of its operation.</p>
1395 *
1396 * <p class="note">For better interoperability with other applications, it is recommended
1397 * that for any URIs that can be opened, you also support queries on them
1398 * containing at least the columns specified by {@link android.provider.OpenableColumns}.
1399 * You may also want to support other common columns if you have additional meta-data
1400 * to supply, such as {@link android.provider.MediaStore.MediaColumns#DATE_ADDED}
1401 * in {@link android.provider.MediaStore.MediaColumns}.</p>
1402 *
1403 * @param uri The URI whose file is to be opened.
1404 * @param mode Access mode for the file. May be "r" for read-only access,
1405 * "w" for write-only access, "rw" for read and write access, or
1406 * "rwt" for read and write access that truncates any existing
1407 * file.
1408 * @param signal A signal to cancel the operation in progress, or
1409 * {@code null} if none. For example, if you are downloading a
1410 * file from the network to service a "rw" mode request, you
1411 * should periodically call
1412 * {@link CancellationSignal#throwIfCanceled()} to check whether
1413 * the client has canceled the request and abort the download.
1414 *
1415 * @return Returns a new ParcelFileDescriptor which you can use to access
1416 * the file.
1417 *
1418 * @throws FileNotFoundException Throws FileNotFoundException if there is
1419 * no file associated with the given URI or the mode is invalid.
1420 * @throws SecurityException Throws SecurityException if the caller does
1421 * not have permission to access the file.
1422 *
1423 * @see #openAssetFile(Uri, String)
1424 * @see #openFileHelper(Uri, String)
1425 * @see #getType(android.net.Uri)
Jeff Sharkeye8c00d82013-10-15 15:46:10 -07001426 * @see ParcelFileDescriptor#parseMode(String)
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001427 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001428 public @Nullable ParcelFileDescriptor openFile(@NonNull Uri uri, @NonNull String mode,
1429 @Nullable CancellationSignal signal) throws FileNotFoundException {
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001430 return openFile(uri, mode);
1431 }
1432
1433 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001434 * This is like {@link #openFile}, but can be implemented by providers
1435 * that need to be able to return sub-sections of files, often assets
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001436 * inside of their .apk.
1437 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001438 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1439 * and Threads</a>.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001440 *
1441 * <p>If you implement this, your clients must be able to deal with such
Dan Egnor17876aa2010-07-28 12:28:04 -07001442 * file slices, either directly with
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001443 * {@link ContentResolver#openAssetFileDescriptor}, or by using the higher-level
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001444 * {@link ContentResolver#openInputStream ContentResolver.openInputStream}
1445 * or {@link ContentResolver#openOutputStream ContentResolver.openOutputStream}
1446 * methods.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001447 * <p>
1448 * The returned AssetFileDescriptor can be a pipe or socket pair to enable
1449 * streaming of data.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001450 *
1451 * <p class="note">If you are implementing this to return a full file, you
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001452 * should create the AssetFileDescriptor with
1453 * {@link AssetFileDescriptor#UNKNOWN_LENGTH} to be compatible with
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001454 * applications that cannot handle sub-sections of files.</p>
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001455 *
Dianne Hackborna53ee352013-02-20 12:47:02 -08001456 * <p class="note">For use in Intents, you will want to implement {@link #getType}
1457 * to return the appropriate MIME type for the data returned here with
1458 * the same URI. This will allow intent resolution to automatically determine the data MIME
1459 * type and select the appropriate matching targets as part of its operation.</p>
1460 *
1461 * <p class="note">For better interoperability with other applications, it is recommended
1462 * that for any URIs that can be opened, you also support queries on them
1463 * containing at least the columns specified by {@link android.provider.OpenableColumns}.</p>
1464 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001465 * @param uri The URI whose file is to be opened.
1466 * @param mode Access mode for the file. May be "r" for read-only access,
1467 * "w" for write-only access (erasing whatever data is currently in
1468 * the file), "wa" for write-only access to append to any existing data,
1469 * "rw" for read and write access on any existing data, and "rwt" for read
1470 * and write access that truncates any existing file.
1471 *
1472 * @return Returns a new AssetFileDescriptor which you can use to access
1473 * the file.
1474 *
1475 * @throws FileNotFoundException Throws FileNotFoundException if there is
1476 * no file associated with the given URI or the mode is invalid.
1477 * @throws SecurityException Throws SecurityException if the caller does
1478 * not have permission to access the file.
Steve McKayea93fe72016-12-02 11:35:35 -08001479 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001480 * @see #openFile(Uri, String)
1481 * @see #openFileHelper(Uri, String)
Dianne Hackborna53ee352013-02-20 12:47:02 -08001482 * @see #getType(android.net.Uri)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001483 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001484 public @Nullable AssetFileDescriptor openAssetFile(@NonNull Uri uri, @NonNull String mode)
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001485 throws FileNotFoundException {
1486 ParcelFileDescriptor fd = openFile(uri, mode);
1487 return fd != null ? new AssetFileDescriptor(fd, 0, -1) : null;
1488 }
1489
1490 /**
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001491 * This is like {@link #openFile}, but can be implemented by providers
1492 * that need to be able to return sub-sections of files, often assets
1493 * inside of their .apk.
1494 * This method can be called from multiple threads, as described in
1495 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1496 * and Threads</a>.
1497 *
1498 * <p>If you implement this, your clients must be able to deal with such
1499 * file slices, either directly with
1500 * {@link ContentResolver#openAssetFileDescriptor}, or by using the higher-level
1501 * {@link ContentResolver#openInputStream ContentResolver.openInputStream}
1502 * or {@link ContentResolver#openOutputStream ContentResolver.openOutputStream}
1503 * methods.
1504 * <p>
1505 * The returned AssetFileDescriptor can be a pipe or socket pair to enable
1506 * streaming of data.
1507 *
1508 * <p class="note">If you are implementing this to return a full file, you
1509 * should create the AssetFileDescriptor with
1510 * {@link AssetFileDescriptor#UNKNOWN_LENGTH} to be compatible with
1511 * applications that cannot handle sub-sections of files.</p>
1512 *
1513 * <p class="note">For use in Intents, you will want to implement {@link #getType}
1514 * to return the appropriate MIME type for the data returned here with
1515 * the same URI. This will allow intent resolution to automatically determine the data MIME
1516 * type and select the appropriate matching targets as part of its operation.</p>
1517 *
1518 * <p class="note">For better interoperability with other applications, it is recommended
1519 * that for any URIs that can be opened, you also support queries on them
1520 * containing at least the columns specified by {@link android.provider.OpenableColumns}.</p>
1521 *
1522 * @param uri The URI whose file is to be opened.
1523 * @param mode Access mode for the file. May be "r" for read-only access,
1524 * "w" for write-only access (erasing whatever data is currently in
1525 * the file), "wa" for write-only access to append to any existing data,
1526 * "rw" for read and write access on any existing data, and "rwt" for read
1527 * and write access that truncates any existing file.
1528 * @param signal A signal to cancel the operation in progress, or
1529 * {@code null} if none. For example, if you are downloading a
1530 * file from the network to service a "rw" mode request, you
1531 * should periodically call
1532 * {@link CancellationSignal#throwIfCanceled()} to check whether
1533 * the client has canceled the request and abort the download.
1534 *
1535 * @return Returns a new AssetFileDescriptor which you can use to access
1536 * the file.
1537 *
1538 * @throws FileNotFoundException Throws FileNotFoundException if there is
1539 * no file associated with the given URI or the mode is invalid.
1540 * @throws SecurityException Throws SecurityException if the caller does
1541 * not have permission to access the file.
1542 *
1543 * @see #openFile(Uri, String)
1544 * @see #openFileHelper(Uri, String)
1545 * @see #getType(android.net.Uri)
1546 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001547 public @Nullable AssetFileDescriptor openAssetFile(@NonNull Uri uri, @NonNull String mode,
1548 @Nullable CancellationSignal signal) throws FileNotFoundException {
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001549 return openAssetFile(uri, mode);
1550 }
1551
1552 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001553 * Convenience for subclasses that wish to implement {@link #openFile}
1554 * by looking up a column named "_data" at the given URI.
1555 *
1556 * @param uri The URI to be opened.
1557 * @param mode The file mode. May be "r" for read-only access,
1558 * "w" for write-only access (erasing whatever data is currently in
1559 * the file), "wa" for write-only access to append to any existing data,
1560 * "rw" for read and write access on any existing data, and "rwt" for read
1561 * and write access that truncates any existing file.
1562 *
1563 * @return Returns a new ParcelFileDescriptor that can be used by the
1564 * client to access the file.
1565 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001566 protected final @NonNull ParcelFileDescriptor openFileHelper(@NonNull Uri uri,
1567 @NonNull String mode) throws FileNotFoundException {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001568 Cursor c = query(uri, new String[]{"_data"}, null, null, null);
1569 int count = (c != null) ? c.getCount() : 0;
1570 if (count != 1) {
1571 // If there is not exactly one result, throw an appropriate
1572 // exception.
1573 if (c != null) {
1574 c.close();
1575 }
1576 if (count == 0) {
1577 throw new FileNotFoundException("No entry for " + uri);
1578 }
1579 throw new FileNotFoundException("Multiple items at " + uri);
1580 }
1581
1582 c.moveToFirst();
1583 int i = c.getColumnIndex("_data");
1584 String path = (i >= 0 ? c.getString(i) : null);
1585 c.close();
1586 if (path == null) {
1587 throw new FileNotFoundException("Column _data not found.");
1588 }
1589
Adam Lesinskieb8c3f92013-09-20 14:08:25 -07001590 int modeBits = ParcelFileDescriptor.parseMode(mode);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 return ParcelFileDescriptor.open(new File(path), modeBits);
1592 }
1593
1594 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001595 * Called by a client to determine the types of data streams that this
1596 * content provider supports for the given URI. The default implementation
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001597 * returns {@code null}, meaning no types. If your content provider stores data
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001598 * of a particular type, return that MIME type if it matches the given
1599 * mimeTypeFilter. If it can perform type conversions, return an array
1600 * of all supported MIME types that match mimeTypeFilter.
1601 *
1602 * @param uri The data in the content provider being queried.
1603 * @param mimeTypeFilter The type of data the client desires. May be
John Spurlock33900182014-01-02 11:04:18 -05001604 * a pattern, such as *&#47;* to retrieve all possible data types.
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001605 * @return Returns {@code null} if there are no possible data streams for the
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001606 * given mimeTypeFilter. Otherwise returns an array of all available
1607 * concrete MIME types.
1608 *
1609 * @see #getType(Uri)
1610 * @see #openTypedAssetFile(Uri, String, Bundle)
Dianne Hackborn1040dc42010-08-26 22:11:06 -07001611 * @see ClipDescription#compareMimeTypes(String, String)
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001612 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001613 public @Nullable String[] getStreamTypes(@NonNull Uri uri, @NonNull String mimeTypeFilter) {
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001614 return null;
1615 }
1616
1617 /**
1618 * Called by a client to open a read-only stream containing data of a
1619 * particular MIME type. This is like {@link #openAssetFile(Uri, String)},
1620 * except the file can only be read-only and the content provider may
1621 * perform data conversions to generate data of the desired type.
1622 *
1623 * <p>The default implementation compares the given mimeType against the
Dianne Hackborna53ee352013-02-20 12:47:02 -08001624 * result of {@link #getType(Uri)} and, if they match, simply calls
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001625 * {@link #openAssetFile(Uri, String)}.
1626 *
Dianne Hackborn1040dc42010-08-26 22:11:06 -07001627 * <p>See {@link ClipData} for examples of the use and implementation
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001628 * of this method.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001629 * <p>
1630 * The returned AssetFileDescriptor can be a pipe or socket pair to enable
1631 * streaming of data.
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001632 *
Dianne Hackborna53ee352013-02-20 12:47:02 -08001633 * <p class="note">For better interoperability with other applications, it is recommended
1634 * that for any URIs that can be opened, you also support queries on them
1635 * containing at least the columns specified by {@link android.provider.OpenableColumns}.
1636 * You may also want to support other common columns if you have additional meta-data
1637 * to supply, such as {@link android.provider.MediaStore.MediaColumns#DATE_ADDED}
1638 * in {@link android.provider.MediaStore.MediaColumns}.</p>
1639 *
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001640 * @param uri The data in the content provider being queried.
1641 * @param mimeTypeFilter The type of data the client desires. May be
John Spurlock33900182014-01-02 11:04:18 -05001642 * a pattern, such as *&#47;*, if the caller does not have specific type
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001643 * requirements; in this case the content provider will pick its best
1644 * type matching the pattern.
1645 * @param opts Additional options from the client. The definitions of
1646 * these are specific to the content provider being called.
1647 *
1648 * @return Returns a new AssetFileDescriptor from which the client can
1649 * read data of the desired type.
1650 *
1651 * @throws FileNotFoundException Throws FileNotFoundException if there is
1652 * no file associated with the given URI or the mode is invalid.
1653 * @throws SecurityException Throws SecurityException if the caller does
1654 * not have permission to access the data.
1655 * @throws IllegalArgumentException Throws IllegalArgumentException if the
1656 * content provider does not support the requested MIME type.
1657 *
1658 * @see #getStreamTypes(Uri, String)
1659 * @see #openAssetFile(Uri, String)
Dianne Hackborn1040dc42010-08-26 22:11:06 -07001660 * @see ClipDescription#compareMimeTypes(String, String)
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001661 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001662 public @Nullable AssetFileDescriptor openTypedAssetFile(@NonNull Uri uri,
1663 @NonNull String mimeTypeFilter, @Nullable Bundle opts) throws FileNotFoundException {
Dianne Hackborn02dfd262010-08-13 12:34:58 -07001664 if ("*/*".equals(mimeTypeFilter)) {
1665 // If they can take anything, the untyped open call is good enough.
1666 return openAssetFile(uri, "r");
1667 }
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001668 String baseType = getType(uri);
Dianne Hackborn1040dc42010-08-26 22:11:06 -07001669 if (baseType != null && ClipDescription.compareMimeTypes(baseType, mimeTypeFilter)) {
Dianne Hackborn02dfd262010-08-13 12:34:58 -07001670 // Use old untyped open call if this provider has a type for this
1671 // URI and it matches the request.
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001672 return openAssetFile(uri, "r");
1673 }
1674 throw new FileNotFoundException("Can't open " + uri + " as type " + mimeTypeFilter);
1675 }
1676
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001677
1678 /**
1679 * Called by a client to open a read-only stream containing data of a
1680 * particular MIME type. This is like {@link #openAssetFile(Uri, String)},
1681 * except the file can only be read-only and the content provider may
1682 * perform data conversions to generate data of the desired type.
1683 *
1684 * <p>The default implementation compares the given mimeType against the
1685 * result of {@link #getType(Uri)} and, if they match, simply calls
1686 * {@link #openAssetFile(Uri, String)}.
1687 *
1688 * <p>See {@link ClipData} for examples of the use and implementation
1689 * of this method.
1690 * <p>
1691 * The returned AssetFileDescriptor can be a pipe or socket pair to enable
1692 * streaming of data.
1693 *
1694 * <p class="note">For better interoperability with other applications, it is recommended
1695 * that for any URIs that can be opened, you also support queries on them
1696 * containing at least the columns specified by {@link android.provider.OpenableColumns}.
1697 * You may also want to support other common columns if you have additional meta-data
1698 * to supply, such as {@link android.provider.MediaStore.MediaColumns#DATE_ADDED}
1699 * in {@link android.provider.MediaStore.MediaColumns}.</p>
1700 *
1701 * @param uri The data in the content provider being queried.
1702 * @param mimeTypeFilter The type of data the client desires. May be
John Spurlock33900182014-01-02 11:04:18 -05001703 * a pattern, such as *&#47;*, if the caller does not have specific type
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001704 * requirements; in this case the content provider will pick its best
1705 * type matching the pattern.
1706 * @param opts Additional options from the client. The definitions of
1707 * these are specific to the content provider being called.
1708 * @param signal A signal to cancel the operation in progress, or
1709 * {@code null} if none. For example, if you are downloading a
1710 * file from the network to service a "rw" mode request, you
1711 * should periodically call
1712 * {@link CancellationSignal#throwIfCanceled()} to check whether
1713 * the client has canceled the request and abort the download.
1714 *
1715 * @return Returns a new AssetFileDescriptor from which the client can
1716 * read data of the desired type.
1717 *
1718 * @throws FileNotFoundException Throws FileNotFoundException if there is
1719 * no file associated with the given URI or the mode is invalid.
1720 * @throws SecurityException Throws SecurityException if the caller does
1721 * not have permission to access the data.
1722 * @throws IllegalArgumentException Throws IllegalArgumentException if the
1723 * content provider does not support the requested MIME type.
1724 *
1725 * @see #getStreamTypes(Uri, String)
1726 * @see #openAssetFile(Uri, String)
1727 * @see ClipDescription#compareMimeTypes(String, String)
1728 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001729 public @Nullable AssetFileDescriptor openTypedAssetFile(@NonNull Uri uri,
1730 @NonNull String mimeTypeFilter, @Nullable Bundle opts,
1731 @Nullable CancellationSignal signal) throws FileNotFoundException {
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07001732 return openTypedAssetFile(uri, mimeTypeFilter, opts);
1733 }
1734
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001735 /**
1736 * Interface to write a stream of data to a pipe. Use with
1737 * {@link ContentProvider#openPipeHelper}.
1738 */
1739 public interface PipeDataWriter<T> {
1740 /**
1741 * Called from a background thread to stream data out to a pipe.
1742 * Note that the pipe is blocking, so this thread can block on
1743 * writes for an arbitrary amount of time if the client is slow
1744 * at reading.
1745 *
1746 * @param output The pipe where data should be written. This will be
1747 * closed for you upon returning from this function.
1748 * @param uri The URI whose data is to be written.
1749 * @param mimeType The desired type of data to be written.
1750 * @param opts Options supplied by caller.
1751 * @param args Your own custom arguments.
1752 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001753 public void writeDataToPipe(@NonNull ParcelFileDescriptor output, @NonNull Uri uri,
1754 @NonNull String mimeType, @Nullable Bundle opts, @Nullable T args);
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001755 }
1756
1757 /**
1758 * A helper function for implementing {@link #openTypedAssetFile}, for
1759 * creating a data pipe and background thread allowing you to stream
1760 * generated data back to the client. This function returns a new
1761 * ParcelFileDescriptor that should be returned to the caller (the caller
1762 * is responsible for closing it).
1763 *
1764 * @param uri The URI whose data is to be written.
1765 * @param mimeType The desired type of data to be written.
1766 * @param opts Options supplied by caller.
1767 * @param args Your own custom arguments.
1768 * @param func Interface implementing the function that will actually
1769 * stream the data.
1770 * @return Returns a new ParcelFileDescriptor holding the read side of
1771 * the pipe. This should be returned to the caller for reading; the caller
1772 * is responsible for closing it when done.
1773 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001774 public @NonNull <T> ParcelFileDescriptor openPipeHelper(final @NonNull Uri uri,
1775 final @NonNull String mimeType, final @Nullable Bundle opts, final @Nullable T args,
1776 final @NonNull PipeDataWriter<T> func) throws FileNotFoundException {
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001777 try {
1778 final ParcelFileDescriptor[] fds = ParcelFileDescriptor.createPipe();
1779
1780 AsyncTask<Object, Object, Object> task = new AsyncTask<Object, Object, Object>() {
1781 @Override
1782 protected Object doInBackground(Object... params) {
1783 func.writeDataToPipe(fds[1], uri, mimeType, opts, args);
1784 try {
1785 fds[1].close();
1786 } catch (IOException e) {
1787 Log.w(TAG, "Failure closing pipe", e);
1788 }
1789 return null;
1790 }
1791 };
Dianne Hackborn5d9d03a2011-01-24 13:15:09 -08001792 task.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR, (Object[])null);
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001793
1794 return fds[0];
1795 } catch (IOException e) {
1796 throw new FileNotFoundException("failure making pipe");
1797 }
1798 }
1799
1800 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001801 * Returns true if this instance is a temporary content provider.
1802 * @return true if this instance is a temporary content provider
1803 */
1804 protected boolean isTemporary() {
1805 return false;
1806 }
1807
1808 /**
1809 * Returns the Binder object for this provider.
1810 *
1811 * @return the Binder object for this provider
1812 * @hide
1813 */
1814 public IContentProvider getIContentProvider() {
1815 return mTransport;
1816 }
1817
1818 /**
Dianne Hackborn334d9ae2013-02-26 15:02:06 -08001819 * Like {@link #attachInfo(Context, android.content.pm.ProviderInfo)}, but for use
1820 * when directly instantiating the provider for testing.
1821 * @hide
1822 */
1823 public void attachInfoForTesting(Context context, ProviderInfo info) {
1824 attachInfo(context, info, true);
1825 }
1826
1827 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001828 * After being instantiated, this is called to tell the content provider
1829 * about itself.
1830 *
1831 * @param context The context this provider is running in
1832 * @param info Registered information about this content provider
1833 */
1834 public void attachInfo(Context context, ProviderInfo info) {
Dianne Hackborn334d9ae2013-02-26 15:02:06 -08001835 attachInfo(context, info, false);
1836 }
1837
1838 private void attachInfo(Context context, ProviderInfo info, boolean testing) {
Dianne Hackborn334d9ae2013-02-26 15:02:06 -08001839 mNoPerms = testing;
1840
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001841 /*
1842 * Only allow it to be set once, so after the content service gives
1843 * this to us clients can't change it.
1844 */
1845 if (mContext == null) {
1846 mContext = context;
Jeff Sharkey10cb3122013-09-17 15:18:43 -07001847 if (context != null) {
1848 mTransport.mAppOpsManager = (AppOpsManager) context.getSystemService(
1849 Context.APP_OPS_SERVICE);
1850 }
Dianne Hackborn2af632f2009-07-08 14:56:37 -07001851 mMyUid = Process.myUid();
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001852 if (info != null) {
1853 setReadPermission(info.readPermission);
1854 setWritePermission(info.writePermission);
Dianne Hackborn2af632f2009-07-08 14:56:37 -07001855 setPathPermissions(info.pathPermissions);
Dianne Hackbornb424b632010-08-18 15:59:05 -07001856 mExported = info.exported;
Amith Yamasania6f4d582014-08-07 17:58:39 -07001857 mSingleUser = (info.flags & ProviderInfo.FLAG_SINGLE_USER) != 0;
Nicolas Prevotf300bab2014-08-07 19:23:17 +01001858 setAuthorities(info.authority);
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001859 }
1860 ContentProvider.this.onCreate();
1861 }
1862 }
Fred Quintanace31b232009-05-04 16:01:15 -07001863
1864 /**
Dan Egnor17876aa2010-07-28 12:28:04 -07001865 * Override this to handle requests to perform a batch of operations, or the
1866 * default implementation will iterate over the operations and call
1867 * {@link ContentProviderOperation#apply} on each of them.
1868 * If all calls to {@link ContentProviderOperation#apply} succeed
1869 * then a {@link ContentProviderResult} array with as many
1870 * elements as there were operations will be returned. If any of the calls
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001871 * fail, it is up to the implementation how many of the others take effect.
1872 * This method can be called from multiple threads, as described in
Scott Main7aee61f2011-02-08 11:25:01 -08001873 * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes
1874 * and Threads</a>.
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001875 *
Fred Quintanace31b232009-05-04 16:01:15 -07001876 * @param operations the operations to apply
1877 * @return the results of the applications
Dan Egnor6fcc0f0732010-07-27 16:32:17 -07001878 * @throws OperationApplicationException thrown if any operation fails.
1879 * @see ContentProviderOperation#apply
Fred Quintanace31b232009-05-04 16:01:15 -07001880 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001881 public @NonNull ContentProviderResult[] applyBatch(
1882 @NonNull ArrayList<ContentProviderOperation> operations)
1883 throws OperationApplicationException {
Fred Quintana03d94902009-05-22 14:23:31 -07001884 final int numOperations = operations.size();
1885 final ContentProviderResult[] results = new ContentProviderResult[numOperations];
1886 for (int i = 0; i < numOperations; i++) {
1887 results[i] = operations.get(i).apply(this, results, i);
Fred Quintanace31b232009-05-04 16:01:15 -07001888 }
1889 return results;
1890 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08001891
1892 /**
Manuel Roman2c96a0c2010-08-05 16:39:49 -07001893 * Call a provider-defined method. This can be used to implement
Brad Fitzpatrick534c84c2011-01-12 14:06:30 -08001894 * interfaces that are cheaper and/or unnatural for a table-like
1895 * model.
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08001896 *
Dianne Hackborn5d122d92013-03-12 18:37:07 -07001897 * <p class="note"><strong>WARNING:</strong> The framework does no permission checking
1898 * on this entry into the content provider besides the basic ability for the application
1899 * to get access to the provider at all. For example, it has no idea whether the call
1900 * being executed may read or write data in the provider, so can't enforce those
1901 * individual permissions. Any implementation of this method <strong>must</strong>
1902 * do its own permission checks on incoming calls to make sure they are allowed.</p>
1903 *
Christopher Tate2bc6eb82013-01-03 12:04:08 -08001904 * @param method method name to call. Opaque to framework, but should not be {@code null}.
1905 * @param arg provider-defined String argument. May be {@code null}.
1906 * @param extras provider-defined Bundle argument. May be {@code null}.
1907 * @return provider-defined return value. May be {@code null}, which is also
Brad Fitzpatrick534c84c2011-01-12 14:06:30 -08001908 * the default for providers which don't implement any call methods.
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08001909 */
Jeff Sharkey673db442015-06-11 19:30:57 -07001910 public @Nullable Bundle call(@NonNull String method, @Nullable String arg,
1911 @Nullable Bundle extras) {
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08001912 return null;
1913 }
Vasu Nori0c9e14a2010-08-04 13:31:48 -07001914
1915 /**
Manuel Roman2c96a0c2010-08-05 16:39:49 -07001916 * Implement this to shut down the ContentProvider instance. You can then
1917 * invoke this method in unit tests.
Steve McKayea93fe72016-12-02 11:35:35 -08001918 *
Vasu Nori0c9e14a2010-08-04 13:31:48 -07001919 * <p>
Manuel Roman2c96a0c2010-08-05 16:39:49 -07001920 * Android normally handles ContentProvider startup and shutdown
1921 * automatically. You do not need to start up or shut down a
1922 * ContentProvider. When you invoke a test method on a ContentProvider,
1923 * however, a ContentProvider instance is started and keeps running after
1924 * the test finishes, even if a succeeding test instantiates another
1925 * ContentProvider. A conflict develops because the two instances are
1926 * usually running against the same underlying data source (for example, an
1927 * sqlite database).
1928 * </p>
Vasu Nori0c9e14a2010-08-04 13:31:48 -07001929 * <p>
Manuel Roman2c96a0c2010-08-05 16:39:49 -07001930 * Implementing shutDown() avoids this conflict by providing a way to
1931 * terminate the ContentProvider. This method can also prevent memory leaks
1932 * from multiple instantiations of the ContentProvider, and it can ensure
1933 * unit test isolation by allowing you to completely clean up the test
1934 * fixture before moving on to the next test.
1935 * </p>
Vasu Nori0c9e14a2010-08-04 13:31:48 -07001936 */
1937 public void shutdown() {
1938 Log.w(TAG, "implement ContentProvider shutdown() to make sure all database " +
1939 "connections are gracefully shutdown");
1940 }
Marco Nelissen18cb2872011-11-15 11:19:53 -08001941
1942 /**
1943 * Print the Provider's state into the given stream. This gets invoked if
Jeff Sharkey5554b702012-04-11 18:30:51 -07001944 * you run "adb shell dumpsys activity provider &lt;provider_component_name&gt;".
Marco Nelissen18cb2872011-11-15 11:19:53 -08001945 *
Marco Nelissen18cb2872011-11-15 11:19:53 -08001946 * @param fd The raw file descriptor that the dump is being sent to.
1947 * @param writer The PrintWriter to which you should dump your state. This will be
1948 * closed for you after you return.
1949 * @param args additional arguments to the dump request.
Marco Nelissen18cb2872011-11-15 11:19:53 -08001950 */
1951 public void dump(FileDescriptor fd, PrintWriter writer, String[] args) {
1952 writer.println("nothing to dump");
1953 }
Nicolas Prevotf300bab2014-08-07 19:23:17 +01001954
Nicolas Prevot504d78e2014-06-26 10:07:33 +01001955 /** @hide */
Nicolas Prevotf300bab2014-08-07 19:23:17 +01001956 private void validateIncomingUri(Uri uri) throws SecurityException {
1957 String auth = uri.getAuthority();
Robin Lee2ab02e22016-07-28 18:41:23 +01001958 if (!mSingleUser) {
1959 int userId = getUserIdFromAuthority(auth, UserHandle.USER_CURRENT);
1960 if (userId != UserHandle.USER_CURRENT && userId != mContext.getUserId()) {
1961 throw new SecurityException("trying to query a ContentProvider in user "
1962 + mContext.getUserId() + " with a uri belonging to user " + userId);
1963 }
Nicolas Prevot504d78e2014-06-26 10:07:33 +01001964 }
Nicolas Prevotf300bab2014-08-07 19:23:17 +01001965 if (!matchesOurAuthorities(getAuthorityWithoutUserId(auth))) {
1966 String message = "The authority of the uri " + uri + " does not match the one of the "
1967 + "contentProvider: ";
1968 if (mAuthority != null) {
1969 message += mAuthority;
1970 } else {
Andreas Gampee6748ce2015-12-11 18:00:38 -08001971 message += Arrays.toString(mAuthorities);
Nicolas Prevotf300bab2014-08-07 19:23:17 +01001972 }
1973 throw new SecurityException(message);
1974 }
Nicolas Prevot504d78e2014-06-26 10:07:33 +01001975 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01001976
1977 /** @hide */
Robin Lee2ab02e22016-07-28 18:41:23 +01001978 private Uri maybeGetUriWithoutUserId(Uri uri) {
1979 if (mSingleUser) {
1980 return uri;
1981 }
1982 return getUriWithoutUserId(uri);
1983 }
1984
1985 /** @hide */
Nicolas Prevotd85fc722014-04-16 19:52:08 +01001986 public static int getUserIdFromAuthority(String auth, int defaultUserId) {
1987 if (auth == null) return defaultUserId;
Nicolas Prevot504d78e2014-06-26 10:07:33 +01001988 int end = auth.lastIndexOf('@');
Nicolas Prevotd85fc722014-04-16 19:52:08 +01001989 if (end == -1) return defaultUserId;
1990 String userIdString = auth.substring(0, end);
1991 try {
1992 return Integer.parseInt(userIdString);
1993 } catch (NumberFormatException e) {
1994 Log.w(TAG, "Error parsing userId.", e);
1995 return UserHandle.USER_NULL;
1996 }
1997 }
1998
1999 /** @hide */
2000 public static int getUserIdFromAuthority(String auth) {
2001 return getUserIdFromAuthority(auth, UserHandle.USER_CURRENT);
2002 }
2003
2004 /** @hide */
2005 public static int getUserIdFromUri(Uri uri, int defaultUserId) {
2006 if (uri == null) return defaultUserId;
2007 return getUserIdFromAuthority(uri.getAuthority(), defaultUserId);
2008 }
2009
2010 /** @hide */
2011 public static int getUserIdFromUri(Uri uri) {
2012 return getUserIdFromUri(uri, UserHandle.USER_CURRENT);
2013 }
2014
2015 /**
2016 * Removes userId part from authority string. Expects format:
2017 * userId@some.authority
2018 * If there is no userId in the authority, it symply returns the argument
2019 * @hide
2020 */
2021 public static String getAuthorityWithoutUserId(String auth) {
2022 if (auth == null) return null;
Nicolas Prevot504d78e2014-06-26 10:07:33 +01002023 int end = auth.lastIndexOf('@');
Nicolas Prevotd85fc722014-04-16 19:52:08 +01002024 return auth.substring(end+1);
2025 }
2026
2027 /** @hide */
2028 public static Uri getUriWithoutUserId(Uri uri) {
2029 if (uri == null) return null;
2030 Uri.Builder builder = uri.buildUpon();
2031 builder.authority(getAuthorityWithoutUserId(uri.getAuthority()));
2032 return builder.build();
2033 }
2034
2035 /** @hide */
2036 public static boolean uriHasUserId(Uri uri) {
2037 if (uri == null) return false;
2038 return !TextUtils.isEmpty(uri.getUserInfo());
2039 }
2040
2041 /** @hide */
2042 public static Uri maybeAddUserId(Uri uri, int userId) {
2043 if (uri == null) return null;
2044 if (userId != UserHandle.USER_CURRENT
2045 && ContentResolver.SCHEME_CONTENT.equals(uri.getScheme())) {
2046 if (!uriHasUserId(uri)) {
2047 //We don't add the user Id if there's already one
2048 Uri.Builder builder = uri.buildUpon();
2049 builder.encodedAuthority("" + userId + "@" + uri.getEncodedAuthority());
2050 return builder.build();
2051 }
2052 }
2053 return uri;
2054 }
Brad Fitzpatrick1877d012010-03-04 17:48:13 -08002055}