The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1 | /* |
| 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 | |
| 17 | package android.content; |
| 18 | |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 19 | import static android.content.pm.PackageManager.PERMISSION_GRANTED; |
| 20 | |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 21 | import android.app.AppOpsManager; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 22 | import android.content.pm.PackageManager; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 23 | import android.content.pm.PathPermission; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 24 | import android.content.pm.ProviderInfo; |
| 25 | import android.content.res.AssetFileDescriptor; |
| 26 | import android.content.res.Configuration; |
| 27 | import android.database.Cursor; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 28 | import android.database.SQLException; |
| 29 | import android.net.Uri; |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 30 | import android.os.AsyncTask; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 31 | import android.os.Binder; |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 32 | import android.os.Bundle; |
Jeff Brown | a7771df | 2012-05-07 20:06:46 -0700 | [diff] [blame] | 33 | import android.os.CancellationSignal; |
| 34 | import android.os.ICancellationSignal; |
| 35 | import android.os.OperationCanceledException; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 36 | import android.os.ParcelFileDescriptor; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 37 | import android.os.Process; |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 38 | import android.os.RemoteException; |
Dianne Hackborn | f02b60a | 2012-08-16 10:48:27 -0700 | [diff] [blame] | 39 | import android.os.UserHandle; |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 40 | import android.util.Log; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 41 | |
| 42 | import java.io.File; |
Marco Nelissen | 18cb287 | 2011-11-15 11:19:53 -0800 | [diff] [blame] | 43 | import java.io.FileDescriptor; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 44 | import java.io.FileNotFoundException; |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 45 | import java.io.IOException; |
Marco Nelissen | 18cb287 | 2011-11-15 11:19:53 -0800 | [diff] [blame] | 46 | import java.io.PrintWriter; |
Fred Quintana | 03d9490 | 2009-05-22 14:23:31 -0700 | [diff] [blame] | 47 | import java.util.ArrayList; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 48 | |
| 49 | /** |
| 50 | * Content providers are one of the primary building blocks of Android applications, providing |
| 51 | * content to applications. They encapsulate data and provide it to applications through the single |
| 52 | * {@link ContentResolver} interface. A content provider is only required if you need to share |
| 53 | * data between multiple applications. For example, the contacts data is used by multiple |
| 54 | * applications and must be stored in a content provider. If you don't need to share data amongst |
| 55 | * multiple applications you can use a database directly via |
| 56 | * {@link android.database.sqlite.SQLiteDatabase}. |
| 57 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 58 | * <p>When a request is made via |
| 59 | * a {@link ContentResolver} the system inspects the authority of the given URI and passes the |
| 60 | * request to the content provider registered with the authority. The content provider can interpret |
| 61 | * the rest of the URI however it wants. The {@link UriMatcher} class is helpful for parsing |
| 62 | * URIs.</p> |
| 63 | * |
| 64 | * <p>The primary methods that need to be implemented are: |
| 65 | * <ul> |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 66 | * <li>{@link #onCreate} which is called to initialize the provider</li> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 67 | * <li>{@link #query} which returns data to the caller</li> |
| 68 | * <li>{@link #insert} which inserts new data into the content provider</li> |
| 69 | * <li>{@link #update} which updates existing data in the content provider</li> |
| 70 | * <li>{@link #delete} which deletes data from the content provider</li> |
| 71 | * <li>{@link #getType} which returns the MIME type of data in the content provider</li> |
| 72 | * </ul></p> |
| 73 | * |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 74 | * <p class="caution">Data access methods (such as {@link #insert} and |
| 75 | * {@link #update}) may be called from many threads at once, and must be thread-safe. |
| 76 | * Other methods (such as {@link #onCreate}) are only called from the application |
| 77 | * main thread, and must avoid performing lengthy operations. See the method |
| 78 | * descriptions for their expected thread behavior.</p> |
| 79 | * |
| 80 | * <p>Requests to {@link ContentResolver} are automatically forwarded to the appropriate |
| 81 | * ContentProvider instance, so subclasses don't have to worry about the details of |
| 82 | * cross-process calls.</p> |
Joe Fernandez | 558459f | 2011-10-13 16:47:36 -0700 | [diff] [blame] | 83 | * |
| 84 | * <div class="special reference"> |
| 85 | * <h3>Developer Guides</h3> |
| 86 | * <p>For more information about using content providers, read the |
| 87 | * <a href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a> |
| 88 | * developer guide.</p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 89 | */ |
Dianne Hackborn | c68c913 | 2011-07-29 01:25:18 -0700 | [diff] [blame] | 90 | public abstract class ContentProvider implements ComponentCallbacks2 { |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 91 | private static final String TAG = "ContentProvider"; |
| 92 | |
Daisuke Miyakawa | 8280c2b | 2009-10-22 08:36:42 +0900 | [diff] [blame] | 93 | /* |
| 94 | * Note: if you add methods to ContentProvider, you must add similar methods to |
| 95 | * MockContentProvider. |
| 96 | */ |
| 97 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 98 | private Context mContext = null; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 99 | private int mMyUid; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 100 | private String mReadPermission; |
| 101 | private String mWritePermission; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 102 | private PathPermission[] mPathPermissions; |
Dianne Hackborn | b424b63 | 2010-08-18 15:59:05 -0700 | [diff] [blame] | 103 | private boolean mExported; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 104 | |
| 105 | private Transport mTransport = new Transport(); |
| 106 | |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 107 | /** |
| 108 | * Construct a ContentProvider instance. Content providers must be |
| 109 | * <a href="{@docRoot}guide/topics/manifest/provider-element.html">declared |
| 110 | * in the manifest</a>, accessed with {@link ContentResolver}, and created |
| 111 | * automatically by the system, so applications usually do not create |
| 112 | * ContentProvider instances directly. |
| 113 | * |
| 114 | * <p>At construction time, the object is uninitialized, and most fields and |
| 115 | * methods are unavailable. Subclasses should initialize themselves in |
| 116 | * {@link #onCreate}, not the constructor. |
| 117 | * |
| 118 | * <p>Content providers are created on the application main thread at |
| 119 | * application launch time. The constructor must not perform lengthy |
| 120 | * operations, or application startup will be delayed. |
| 121 | */ |
Daisuke Miyakawa | 8280c2b | 2009-10-22 08:36:42 +0900 | [diff] [blame] | 122 | public ContentProvider() { |
| 123 | } |
| 124 | |
| 125 | /** |
| 126 | * Constructor just for mocking. |
| 127 | * |
| 128 | * @param context A Context object which should be some mock instance (like the |
| 129 | * instance of {@link android.test.mock.MockContext}). |
| 130 | * @param readPermission The read permision you want this instance should have in the |
| 131 | * test, which is available via {@link #getReadPermission()}. |
| 132 | * @param writePermission The write permission you want this instance should have |
| 133 | * in the test, which is available via {@link #getWritePermission()}. |
| 134 | * @param pathPermissions The PathPermissions you want this instance should have |
| 135 | * in the test, which is available via {@link #getPathPermissions()}. |
| 136 | * @hide |
| 137 | */ |
| 138 | public ContentProvider( |
| 139 | Context context, |
| 140 | String readPermission, |
| 141 | String writePermission, |
| 142 | PathPermission[] pathPermissions) { |
| 143 | mContext = context; |
| 144 | mReadPermission = readPermission; |
| 145 | mWritePermission = writePermission; |
| 146 | mPathPermissions = pathPermissions; |
| 147 | } |
| 148 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 149 | /** |
| 150 | * Given an IContentProvider, try to coerce it back to the real |
| 151 | * ContentProvider object if it is running in the local process. This can |
| 152 | * be used if you know you are running in the same process as a provider, |
| 153 | * and want to get direct access to its implementation details. Most |
| 154 | * clients should not nor have a reason to use it. |
| 155 | * |
| 156 | * @param abstractInterface The ContentProvider interface that is to be |
| 157 | * coerced. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 158 | * @return If the IContentProvider is non-{@code null} and local, returns its actual |
| 159 | * ContentProvider instance. Otherwise returns {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 160 | * @hide |
| 161 | */ |
| 162 | public static ContentProvider coerceToLocalContentProvider( |
| 163 | IContentProvider abstractInterface) { |
| 164 | if (abstractInterface instanceof Transport) { |
| 165 | return ((Transport)abstractInterface).getContentProvider(); |
| 166 | } |
| 167 | return null; |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Binder object that deals with remoting. |
| 172 | * |
| 173 | * @hide |
| 174 | */ |
| 175 | class Transport extends ContentProviderNative { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 176 | AppOpsManager mAppOpsManager = null; |
| 177 | int mReadOp = -1; |
| 178 | int mWriteOp = -1; |
| 179 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 180 | ContentProvider getContentProvider() { |
| 181 | return ContentProvider.this; |
| 182 | } |
| 183 | |
Jeff Brown | d218365 | 2011-10-09 12:39:53 -0700 | [diff] [blame] | 184 | @Override |
| 185 | public String getProviderName() { |
| 186 | return getContentProvider().getClass().getName(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 187 | } |
| 188 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 189 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 190 | public Cursor query(String callingPkg, Uri uri, String[] projection, |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 191 | String selection, String[] selectionArgs, String sortOrder, |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 192 | ICancellationSignal cancellationSignal) { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 193 | // XXX need content provider to help return correct result. |
| 194 | enforceReadPermission(callingPkg, uri); |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 195 | return ContentProvider.this.query(uri, projection, selection, selectionArgs, sortOrder, |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 196 | CancellationSignal.fromTransport(cancellationSignal)); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 197 | } |
| 198 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 199 | @Override |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 200 | public String getType(Uri uri) { |
| 201 | return ContentProvider.this.getType(uri); |
| 202 | } |
| 203 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 204 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 205 | public Uri insert(String callingPkg, Uri uri, ContentValues initialValues) { |
| 206 | // XXX need content provider to help return correct result. |
| 207 | enforceWritePermission(callingPkg, uri); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 208 | return ContentProvider.this.insert(uri, initialValues); |
| 209 | } |
| 210 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 211 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 212 | public int bulkInsert(String callingPkg, Uri uri, ContentValues[] initialValues) { |
| 213 | if (enforceWritePermission(callingPkg, uri) != AppOpsManager.MODE_ALLOWED) { |
| 214 | return 0; |
| 215 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 216 | return ContentProvider.this.bulkInsert(uri, initialValues); |
| 217 | } |
| 218 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 219 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 220 | public ContentProviderResult[] applyBatch(String callingPkg, |
| 221 | ArrayList<ContentProviderOperation> operations) |
Fred Quintana | 8943737 | 2009-05-15 15:10:40 -0700 | [diff] [blame] | 222 | throws OperationApplicationException { |
| 223 | for (ContentProviderOperation operation : operations) { |
| 224 | if (operation.isReadOperation()) { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 225 | if (enforceReadPermission(callingPkg, operation.getUri()) |
| 226 | != AppOpsManager.MODE_ALLOWED) { |
| 227 | throw new OperationApplicationException("App op not allowed", 0); |
| 228 | } |
Fred Quintana | 8943737 | 2009-05-15 15:10:40 -0700 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | if (operation.isWriteOperation()) { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 232 | if (enforceWritePermission(callingPkg, operation.getUri()) |
| 233 | != AppOpsManager.MODE_ALLOWED) { |
| 234 | throw new OperationApplicationException("App op not allowed", 0); |
| 235 | } |
Fred Quintana | 8943737 | 2009-05-15 15:10:40 -0700 | [diff] [blame] | 236 | } |
| 237 | } |
| 238 | return ContentProvider.this.applyBatch(operations); |
Fred Quintana | 6a8d533 | 2009-05-07 17:35:38 -0700 | [diff] [blame] | 239 | } |
| 240 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 241 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 242 | public int delete(String callingPkg, Uri uri, String selection, String[] selectionArgs) { |
| 243 | if (enforceWritePermission(callingPkg, uri) != AppOpsManager.MODE_ALLOWED) { |
| 244 | return 0; |
| 245 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 246 | return ContentProvider.this.delete(uri, selection, selectionArgs); |
| 247 | } |
| 248 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 249 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 250 | public int update(String callingPkg, Uri uri, ContentValues values, String selection, |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 251 | String[] selectionArgs) { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 252 | if (enforceWritePermission(callingPkg, uri) != AppOpsManager.MODE_ALLOWED) { |
| 253 | return 0; |
| 254 | } |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 255 | return ContentProvider.this.update(uri, values, selection, selectionArgs); |
| 256 | } |
| 257 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 258 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 259 | public ParcelFileDescriptor openFile(String callingPkg, Uri uri, String mode) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 260 | throws FileNotFoundException { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 261 | enforceFilePermission(callingPkg, uri, mode); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 262 | return ContentProvider.this.openFile(uri, mode); |
| 263 | } |
| 264 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 265 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 266 | public AssetFileDescriptor openAssetFile(String callingPkg, Uri uri, String mode) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 267 | throws FileNotFoundException { |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 268 | enforceFilePermission(callingPkg, uri, mode); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 269 | return ContentProvider.this.openAssetFile(uri, mode); |
| 270 | } |
| 271 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 272 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 273 | public Bundle call(String callingPkg, String method, String arg, Bundle extras) { |
Brad Fitzpatrick | 534c84c | 2011-01-12 14:06:30 -0800 | [diff] [blame] | 274 | return ContentProvider.this.call(method, arg, extras); |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 275 | } |
| 276 | |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 277 | @Override |
| 278 | public String[] getStreamTypes(Uri uri, String mimeTypeFilter) { |
| 279 | return ContentProvider.this.getStreamTypes(uri, mimeTypeFilter); |
| 280 | } |
| 281 | |
| 282 | @Override |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 283 | public AssetFileDescriptor openTypedAssetFile(String callingPkg, Uri uri, String mimeType, |
| 284 | Bundle opts) throws FileNotFoundException { |
| 285 | enforceFilePermission(callingPkg, uri, "r"); |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 286 | return ContentProvider.this.openTypedAssetFile(uri, mimeType, opts); |
| 287 | } |
| 288 | |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 289 | @Override |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 290 | public ICancellationSignal createCancellationSignal() throws RemoteException { |
| 291 | return CancellationSignal.createTransport(); |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 292 | } |
| 293 | |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 294 | private void enforceFilePermission(String callingPkg, Uri uri, String mode) |
| 295 | throws FileNotFoundException, SecurityException { |
| 296 | if (mode != null && mode.startsWith("rw")) { |
| 297 | if (enforceWritePermission(callingPkg, uri) != AppOpsManager.MODE_ALLOWED) { |
| 298 | throw new FileNotFoundException("App op not allowed"); |
| 299 | } |
| 300 | } else { |
| 301 | if (enforceReadPermission(callingPkg, uri) != AppOpsManager.MODE_ALLOWED) { |
| 302 | throw new FileNotFoundException("App op not allowed"); |
| 303 | } |
| 304 | } |
| 305 | } |
| 306 | |
| 307 | private int enforceReadPermission(String callingPkg, Uri uri) throws SecurityException { |
| 308 | enforceReadPermissionInner(uri); |
| 309 | if (mAppOpsManager != null) { |
| 310 | return mAppOpsManager.noteOp(mReadOp, Binder.getCallingUid(), callingPkg); |
| 311 | } |
| 312 | return AppOpsManager.MODE_ALLOWED; |
| 313 | } |
| 314 | |
| 315 | private void enforceReadPermissionInner(Uri uri) throws SecurityException { |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 316 | final Context context = getContext(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 317 | final int pid = Binder.getCallingPid(); |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 318 | final int uid = Binder.getCallingUid(); |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 319 | String missingPerm = null; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 320 | |
Dianne Hackborn | 0d8af78 | 2012-08-17 16:51:54 -0700 | [diff] [blame] | 321 | if (UserHandle.isSameApp(uid, mMyUid)) { |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 322 | return; |
| 323 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 324 | |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 325 | if (mExported) { |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 326 | final String componentPerm = getReadPermission(); |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 327 | if (componentPerm != null) { |
| 328 | if (context.checkPermission(componentPerm, pid, uid) == PERMISSION_GRANTED) { |
| 329 | return; |
| 330 | } else { |
| 331 | missingPerm = componentPerm; |
| 332 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 333 | } |
| 334 | |
| 335 | // track if unprotected read is allowed; any denied |
| 336 | // <path-permission> below removes this ability |
| 337 | boolean allowDefaultRead = (componentPerm == null); |
| 338 | |
| 339 | final PathPermission[] pps = getPathPermissions(); |
| 340 | if (pps != null) { |
| 341 | final String path = uri.getPath(); |
| 342 | for (PathPermission pp : pps) { |
| 343 | final String pathPerm = pp.getReadPermission(); |
| 344 | if (pathPerm != null && pp.match(path)) { |
| 345 | if (context.checkPermission(pathPerm, pid, uid) == PERMISSION_GRANTED) { |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 346 | return; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 347 | } else { |
| 348 | // any denied <path-permission> means we lose |
| 349 | // default <provider> access. |
| 350 | allowDefaultRead = false; |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 351 | missingPerm = pathPerm; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 352 | } |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 353 | } |
| 354 | } |
| 355 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 356 | |
| 357 | // if we passed <path-permission> checks above, and no default |
| 358 | // <provider> permission, then allow access. |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 359 | if (allowDefaultRead) return; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 360 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 361 | |
| 362 | // last chance, check against any uri grants |
| 363 | if (context.checkUriPermission(uri, pid, uid, Intent.FLAG_GRANT_READ_URI_PERMISSION) |
| 364 | == PERMISSION_GRANTED) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 365 | return; |
| 366 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 367 | |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 368 | final String failReason = mExported |
| 369 | ? " requires " + missingPerm + ", or grantUriPermission()" |
| 370 | : " requires the provider be exported, or grantUriPermission()"; |
| 371 | throw new SecurityException("Permission Denial: reading " |
| 372 | + ContentProvider.this.getClass().getName() + " uri " + uri + " from pid=" + pid |
| 373 | + ", uid=" + uid + failReason); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 374 | } |
| 375 | |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 376 | private int enforceWritePermission(String callingPkg, Uri uri) throws SecurityException { |
| 377 | enforceWritePermissionInner(uri); |
| 378 | if (mAppOpsManager != null) { |
| 379 | return mAppOpsManager.noteOp(mWriteOp, Binder.getCallingUid(), callingPkg); |
| 380 | } |
| 381 | return AppOpsManager.MODE_ALLOWED; |
| 382 | } |
| 383 | |
| 384 | private void enforceWritePermissionInner(Uri uri) throws SecurityException { |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 385 | final Context context = getContext(); |
| 386 | final int pid = Binder.getCallingPid(); |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 387 | final int uid = Binder.getCallingUid(); |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 388 | String missingPerm = null; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 389 | |
Dianne Hackborn | 0d8af78 | 2012-08-17 16:51:54 -0700 | [diff] [blame] | 390 | if (UserHandle.isSameApp(uid, mMyUid)) { |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 391 | return; |
| 392 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 393 | |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 394 | if (mExported) { |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 395 | final String componentPerm = getWritePermission(); |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 396 | if (componentPerm != null) { |
| 397 | if (context.checkPermission(componentPerm, pid, uid) == PERMISSION_GRANTED) { |
| 398 | return; |
| 399 | } else { |
| 400 | missingPerm = componentPerm; |
| 401 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 402 | } |
| 403 | |
| 404 | // track if unprotected write is allowed; any denied |
| 405 | // <path-permission> below removes this ability |
| 406 | boolean allowDefaultWrite = (componentPerm == null); |
| 407 | |
| 408 | final PathPermission[] pps = getPathPermissions(); |
| 409 | if (pps != null) { |
| 410 | final String path = uri.getPath(); |
| 411 | for (PathPermission pp : pps) { |
| 412 | final String pathPerm = pp.getWritePermission(); |
| 413 | if (pathPerm != null && pp.match(path)) { |
| 414 | if (context.checkPermission(pathPerm, pid, uid) == PERMISSION_GRANTED) { |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 415 | return; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 416 | } else { |
| 417 | // any denied <path-permission> means we lose |
| 418 | // default <provider> access. |
| 419 | allowDefaultWrite = false; |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 420 | missingPerm = pathPerm; |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 421 | } |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 422 | } |
| 423 | } |
| 424 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 425 | |
| 426 | // if we passed <path-permission> checks above, and no default |
| 427 | // <provider> permission, then allow access. |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 428 | if (allowDefaultWrite) return; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 429 | } |
Jeff Sharkey | 110a6b6 | 2012-03-12 11:12:41 -0700 | [diff] [blame] | 430 | |
| 431 | // last chance, check against any uri grants |
| 432 | if (context.checkUriPermission(uri, pid, uid, Intent.FLAG_GRANT_WRITE_URI_PERMISSION) |
| 433 | == PERMISSION_GRANTED) { |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 434 | return; |
| 435 | } |
Jeff Sharkey | e5d4933 | 2012-03-13 12:13:17 -0700 | [diff] [blame] | 436 | |
| 437 | final String failReason = mExported |
| 438 | ? " requires " + missingPerm + ", or grantUriPermission()" |
| 439 | : " requires the provider be exported, or grantUriPermission()"; |
| 440 | throw new SecurityException("Permission Denial: writing " |
| 441 | + ContentProvider.this.getClass().getName() + " uri " + uri + " from pid=" + pid |
| 442 | + ", uid=" + uid + failReason); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 443 | } |
| 444 | } |
| 445 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 446 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 447 | * Retrieves the Context this provider is running in. Only available once |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 448 | * {@link #onCreate} has been called -- this will return {@code null} in the |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 449 | * constructor. |
| 450 | */ |
| 451 | public final Context getContext() { |
| 452 | return mContext; |
| 453 | } |
| 454 | |
| 455 | /** |
| 456 | * Change the permission required to read data from the content |
| 457 | * provider. This is normally set for you from its manifest information |
| 458 | * when the provider is first created. |
| 459 | * |
| 460 | * @param permission Name of the permission required for read-only access. |
| 461 | */ |
| 462 | protected final void setReadPermission(String permission) { |
| 463 | mReadPermission = permission; |
| 464 | } |
| 465 | |
| 466 | /** |
| 467 | * Return the name of the permission required for read-only access to |
| 468 | * this content provider. This method can be called from multiple |
| 469 | * threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 470 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 471 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 472 | */ |
| 473 | public final String getReadPermission() { |
| 474 | return mReadPermission; |
| 475 | } |
| 476 | |
| 477 | /** |
| 478 | * Change the permission required to read and write data in the content |
| 479 | * provider. This is normally set for you from its manifest information |
| 480 | * when the provider is first created. |
| 481 | * |
| 482 | * @param permission Name of the permission required for read/write access. |
| 483 | */ |
| 484 | protected final void setWritePermission(String permission) { |
| 485 | mWritePermission = permission; |
| 486 | } |
| 487 | |
| 488 | /** |
| 489 | * Return the name of the permission required for read/write access to |
| 490 | * this content provider. This method can be called from multiple |
| 491 | * threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 492 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 493 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 494 | */ |
| 495 | public final String getWritePermission() { |
| 496 | return mWritePermission; |
| 497 | } |
| 498 | |
| 499 | /** |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 500 | * Change the path-based permission required to read and/or write data in |
| 501 | * the content provider. This is normally set for you from its manifest |
| 502 | * information when the provider is first created. |
| 503 | * |
| 504 | * @param permissions Array of path permission descriptions. |
| 505 | */ |
| 506 | protected final void setPathPermissions(PathPermission[] permissions) { |
| 507 | mPathPermissions = permissions; |
| 508 | } |
| 509 | |
| 510 | /** |
| 511 | * Return the path-based permissions required for read and/or write access to |
| 512 | * this content provider. This method can be called from multiple |
| 513 | * threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 514 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 515 | * and Threads</a>. |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 516 | */ |
| 517 | public final PathPermission[] getPathPermissions() { |
| 518 | return mPathPermissions; |
| 519 | } |
| 520 | |
Dianne Hackborn | 35654b6 | 2013-01-14 17:38:02 -0800 | [diff] [blame^] | 521 | /** @hide */ |
| 522 | public final void setAppOps(int readOp, int writeOp) { |
| 523 | mTransport.mAppOpsManager = (AppOpsManager)mContext.getSystemService( |
| 524 | Context.APP_OPS_SERVICE); |
| 525 | mTransport.mReadOp = readOp; |
| 526 | mTransport.mWriteOp = writeOp; |
| 527 | } |
| 528 | |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 529 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 530 | * Implement this to initialize your content provider on startup. |
| 531 | * This method is called for all registered content providers on the |
| 532 | * application main thread at application launch time. It must not perform |
| 533 | * lengthy operations, or application startup will be delayed. |
| 534 | * |
| 535 | * <p>You should defer nontrivial initialization (such as opening, |
| 536 | * upgrading, and scanning databases) until the content provider is used |
| 537 | * (via {@link #query}, {@link #insert}, etc). Deferred initialization |
| 538 | * keeps application startup fast, avoids unnecessary work if the provider |
| 539 | * turns out not to be needed, and stops database errors (such as a full |
| 540 | * disk) from halting application launch. |
| 541 | * |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 542 | * <p>If you use SQLite, {@link android.database.sqlite.SQLiteOpenHelper} |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 543 | * is a helpful utility class that makes it easy to manage databases, |
| 544 | * and will automatically defer opening until first use. If you do use |
| 545 | * SQLiteOpenHelper, make sure to avoid calling |
| 546 | * {@link android.database.sqlite.SQLiteOpenHelper#getReadableDatabase} or |
| 547 | * {@link android.database.sqlite.SQLiteOpenHelper#getWritableDatabase} |
| 548 | * from this method. (Instead, override |
| 549 | * {@link android.database.sqlite.SQLiteOpenHelper#onOpen} to initialize the |
| 550 | * database when it is first opened.) |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 551 | * |
| 552 | * @return true if the provider was successfully loaded, false otherwise |
| 553 | */ |
| 554 | public abstract boolean onCreate(); |
| 555 | |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 556 | /** |
| 557 | * {@inheritDoc} |
| 558 | * This method is always called on the application main thread, and must |
| 559 | * not perform lengthy operations. |
| 560 | * |
| 561 | * <p>The default content provider implementation does nothing. |
| 562 | * Override this method to take appropriate action. |
| 563 | * (Content providers do not usually care about things like screen |
| 564 | * orientation, but may want to know about locale changes.) |
| 565 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 566 | public void onConfigurationChanged(Configuration newConfig) { |
| 567 | } |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 568 | |
| 569 | /** |
| 570 | * {@inheritDoc} |
| 571 | * This method is always called on the application main thread, and must |
| 572 | * not perform lengthy operations. |
| 573 | * |
| 574 | * <p>The default content provider implementation does nothing. |
| 575 | * Subclasses may override this method to take appropriate action. |
| 576 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 577 | public void onLowMemory() { |
| 578 | } |
| 579 | |
Dianne Hackborn | c68c913 | 2011-07-29 01:25:18 -0700 | [diff] [blame] | 580 | public void onTrimMemory(int level) { |
| 581 | } |
| 582 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 583 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 584 | * Implement this to handle query requests from clients. |
| 585 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 586 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 587 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 588 | * <p> |
| 589 | * Example client call:<p> |
| 590 | * <pre>// Request a specific record. |
| 591 | * Cursor managedCursor = managedQuery( |
Alan Jones | 81a476f | 2009-05-21 12:32:17 +1000 | [diff] [blame] | 592 | ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2), |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 593 | projection, // Which columns to return. |
| 594 | null, // WHERE clause. |
Alan Jones | 81a476f | 2009-05-21 12:32:17 +1000 | [diff] [blame] | 595 | null, // WHERE clause value substitution |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 596 | People.NAME + " ASC"); // Sort order.</pre> |
| 597 | * Example implementation:<p> |
| 598 | * <pre>// SQLiteQueryBuilder is a helper class that creates the |
| 599 | // proper SQL syntax for us. |
| 600 | SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder(); |
| 601 | |
| 602 | // Set the table we're querying. |
| 603 | qBuilder.setTables(DATABASE_TABLE_NAME); |
| 604 | |
| 605 | // If the query ends in a specific record number, we're |
| 606 | // being asked for a specific record, so set the |
| 607 | // WHERE clause in our query. |
| 608 | if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){ |
| 609 | qBuilder.appendWhere("_id=" + uri.getPathLeafId()); |
| 610 | } |
| 611 | |
| 612 | // Make the query. |
| 613 | Cursor c = qBuilder.query(mDb, |
| 614 | projection, |
| 615 | selection, |
| 616 | selectionArgs, |
| 617 | groupBy, |
| 618 | having, |
| 619 | sortOrder); |
| 620 | c.setNotificationUri(getContext().getContentResolver(), uri); |
| 621 | return c;</pre> |
| 622 | * |
| 623 | * @param uri The URI to query. This will be the full URI sent by the client; |
Alan Jones | 81a476f | 2009-05-21 12:32:17 +1000 | [diff] [blame] | 624 | * if the client is requesting a specific record, the URI will end in a record number |
| 625 | * that the implementation should parse and add to a WHERE or HAVING clause, specifying |
| 626 | * that _id value. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 627 | * @param projection The list of columns to put into the cursor. If |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 628 | * {@code null} all columns are included. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 629 | * @param selection A selection criteria to apply when filtering rows. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 630 | * If {@code null} then all rows are included. |
Alan Jones | 81a476f | 2009-05-21 12:32:17 +1000 | [diff] [blame] | 631 | * @param selectionArgs You may include ?s in selection, which will be replaced by |
| 632 | * the values from selectionArgs, in order that they appear in the selection. |
| 633 | * The values will be bound as Strings. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 634 | * @param sortOrder How the rows in the cursor should be sorted. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 635 | * If {@code null} then the provider is free to define the sort order. |
| 636 | * @return a Cursor or {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 637 | */ |
| 638 | public abstract Cursor query(Uri uri, String[] projection, |
| 639 | String selection, String[] selectionArgs, String sortOrder); |
| 640 | |
Fred Quintana | 5bba632 | 2009-10-05 14:21:12 -0700 | [diff] [blame] | 641 | /** |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 642 | * Implement this to handle query requests from clients with support for cancellation. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 643 | * This method can be called from multiple threads, as described in |
| 644 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 645 | * and Threads</a>. |
| 646 | * <p> |
| 647 | * Example client call:<p> |
| 648 | * <pre>// Request a specific record. |
| 649 | * Cursor managedCursor = managedQuery( |
| 650 | ContentUris.withAppendedId(Contacts.People.CONTENT_URI, 2), |
| 651 | projection, // Which columns to return. |
| 652 | null, // WHERE clause. |
| 653 | null, // WHERE clause value substitution |
| 654 | People.NAME + " ASC"); // Sort order.</pre> |
| 655 | * Example implementation:<p> |
| 656 | * <pre>// SQLiteQueryBuilder is a helper class that creates the |
| 657 | // proper SQL syntax for us. |
| 658 | SQLiteQueryBuilder qBuilder = new SQLiteQueryBuilder(); |
| 659 | |
| 660 | // Set the table we're querying. |
| 661 | qBuilder.setTables(DATABASE_TABLE_NAME); |
| 662 | |
| 663 | // If the query ends in a specific record number, we're |
| 664 | // being asked for a specific record, so set the |
| 665 | // WHERE clause in our query. |
| 666 | if((URI_MATCHER.match(uri)) == SPECIFIC_MESSAGE){ |
| 667 | qBuilder.appendWhere("_id=" + uri.getPathLeafId()); |
| 668 | } |
| 669 | |
| 670 | // Make the query. |
| 671 | Cursor c = qBuilder.query(mDb, |
| 672 | projection, |
| 673 | selection, |
| 674 | selectionArgs, |
| 675 | groupBy, |
| 676 | having, |
| 677 | sortOrder); |
| 678 | c.setNotificationUri(getContext().getContentResolver(), uri); |
| 679 | return c;</pre> |
| 680 | * <p> |
| 681 | * If you implement this method then you must also implement the version of |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 682 | * {@link #query(Uri, String[], String, String[], String)} that does not take a cancellation |
| 683 | * signal to ensure correct operation on older versions of the Android Framework in |
| 684 | * which the cancellation signal overload was not available. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 685 | * |
| 686 | * @param uri The URI to query. This will be the full URI sent by the client; |
| 687 | * if the client is requesting a specific record, the URI will end in a record number |
| 688 | * that the implementation should parse and add to a WHERE or HAVING clause, specifying |
| 689 | * that _id value. |
| 690 | * @param projection The list of columns to put into the cursor. If |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 691 | * {@code null} all columns are included. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 692 | * @param selection A selection criteria to apply when filtering rows. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 693 | * If {@code null} then all rows are included. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 694 | * @param selectionArgs You may include ?s in selection, which will be replaced by |
| 695 | * the values from selectionArgs, in order that they appear in the selection. |
| 696 | * The values will be bound as Strings. |
| 697 | * @param sortOrder How the rows in the cursor should be sorted. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 698 | * If {@code null} then the provider is free to define the sort order. |
| 699 | * @param cancellationSignal A signal to cancel the operation in progress, or {@code null} if none. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 700 | * If the operation is canceled, then {@link OperationCanceledException} will be thrown |
| 701 | * when the query is executed. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 702 | * @return a Cursor or {@code null}. |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 703 | */ |
| 704 | public Cursor query(Uri uri, String[] projection, |
| 705 | String selection, String[] selectionArgs, String sortOrder, |
Jeff Brown | 4c1241d | 2012-02-02 17:05:00 -0800 | [diff] [blame] | 706 | CancellationSignal cancellationSignal) { |
Jeff Brown | 75ea64f | 2012-01-25 19:37:13 -0800 | [diff] [blame] | 707 | return query(uri, projection, selection, selectionArgs, sortOrder); |
| 708 | } |
| 709 | |
| 710 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 711 | * Implement this to handle requests for the MIME type of the data at the |
| 712 | * given URI. The returned MIME type should start with |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 713 | * <code>vnd.android.cursor.item</code> for a single record, |
| 714 | * or <code>vnd.android.cursor.dir/</code> for multiple items. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 715 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 716 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 717 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 718 | * |
Dianne Hackborn | cca1f0e | 2010-09-26 18:34:53 -0700 | [diff] [blame] | 719 | * <p>Note that there are no permissions needed for an application to |
| 720 | * access this information; if your content provider requires read and/or |
| 721 | * write permissions, or is not exported, all applications can still call |
| 722 | * this method regardless of their access permissions. This allows them |
| 723 | * to retrieve the MIME type for a URI when dispatching intents. |
| 724 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 725 | * @param uri the URI to query. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 726 | * @return a MIME type string, or {@code null} if there is no type. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 727 | */ |
| 728 | public abstract String getType(Uri uri); |
| 729 | |
| 730 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 731 | * Implement this to handle requests to insert a new row. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 732 | * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()} |
| 733 | * after inserting. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 734 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 735 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 736 | * and Threads</a>. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 737 | * @param uri The content:// URI of the insertion request. This must not be {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 738 | * @param values A set of column_name/value pairs to add to the database. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 739 | * This must not be {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 740 | * @return The URI for the newly inserted item. |
| 741 | */ |
| 742 | public abstract Uri insert(Uri uri, ContentValues values); |
| 743 | |
| 744 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 745 | * Override this to handle requests to insert a set of new rows, or the |
| 746 | * default implementation will iterate over the values and call |
| 747 | * {@link #insert} on each of them. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 748 | * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()} |
| 749 | * after inserting. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 750 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 751 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 752 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 753 | * |
| 754 | * @param uri The content:// URI of the insertion request. |
| 755 | * @param values An array of sets of column_name/value pairs to add to the database. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 756 | * This must not be {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 757 | * @return The number of values that were inserted. |
| 758 | */ |
| 759 | public int bulkInsert(Uri uri, ContentValues[] values) { |
| 760 | int numValues = values.length; |
| 761 | for (int i = 0; i < numValues; i++) { |
| 762 | insert(uri, values[i]); |
| 763 | } |
| 764 | return numValues; |
| 765 | } |
| 766 | |
| 767 | /** |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 768 | * Implement this to handle requests to delete one or more rows. |
| 769 | * The implementation should apply the selection clause when performing |
| 770 | * deletion, allowing the operation to affect multiple rows in a directory. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 771 | * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyDelete()} |
| 772 | * after deleting. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 773 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 774 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 775 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 776 | * |
| 777 | * <p>The implementation is responsible for parsing out a row ID at the end |
| 778 | * of the URI, if a specific row is being deleted. That is, the client would |
| 779 | * pass in <code>content://contacts/people/22</code> and the implementation is |
| 780 | * responsible for parsing the record number (22) when creating a SQL statement. |
| 781 | * |
| 782 | * @param uri The full URI to query, including a row ID (if a specific record is requested). |
| 783 | * @param selection An optional restriction to apply to rows when deleting. |
| 784 | * @return The number of rows affected. |
| 785 | * @throws SQLException |
| 786 | */ |
| 787 | public abstract int delete(Uri uri, String selection, String[] selectionArgs); |
| 788 | |
| 789 | /** |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 790 | * Implement this to handle requests to update one or more rows. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 791 | * The implementation should update all rows matching the selection |
| 792 | * to set the columns according to the provided values map. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 793 | * As a courtesy, call {@link ContentResolver#notifyChange(android.net.Uri ,android.database.ContentObserver) notifyChange()} |
| 794 | * after updating. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 795 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 796 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 797 | * and Threads</a>. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 798 | * |
| 799 | * @param uri The URI to query. This can potentially have a record ID if this |
| 800 | * is an update request for a specific record. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 801 | * @param values A set of column_name/value pairs to update in the database. |
| 802 | * This must not be {@code null}. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 803 | * @param selection An optional filter to match rows to update. |
| 804 | * @return the number of rows affected. |
| 805 | */ |
| 806 | public abstract int update(Uri uri, ContentValues values, String selection, |
| 807 | String[] selectionArgs); |
| 808 | |
| 809 | /** |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 810 | * Override this to handle requests to open a file blob. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 811 | * The default implementation always throws {@link FileNotFoundException}. |
| 812 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 813 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 814 | * and Threads</a>. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 815 | * |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 816 | * <p>This method returns a ParcelFileDescriptor, which is returned directly |
| 817 | * to the caller. This way large data (such as images and documents) can be |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 818 | * returned without copying the content. |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 819 | * |
| 820 | * <p>The returned ParcelFileDescriptor is owned by the caller, so it is |
| 821 | * their responsibility to close it when done. That is, the implementation |
| 822 | * of this method should create a new ParcelFileDescriptor for each call. |
| 823 | * |
| 824 | * @param uri The URI whose file is to be opened. |
| 825 | * @param mode Access mode for the file. May be "r" for read-only access, |
| 826 | * "rw" for read and write access, or "rwt" for read and write access |
| 827 | * that truncates any existing file. |
| 828 | * |
| 829 | * @return Returns a new ParcelFileDescriptor which you can use to access |
| 830 | * the file. |
| 831 | * |
| 832 | * @throws FileNotFoundException Throws FileNotFoundException if there is |
| 833 | * no file associated with the given URI or the mode is invalid. |
| 834 | * @throws SecurityException Throws SecurityException if the caller does |
| 835 | * not have permission to access the file. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 836 | * |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 837 | * @see #openAssetFile(Uri, String) |
| 838 | * @see #openFileHelper(Uri, String) |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 839 | */ |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 840 | public ParcelFileDescriptor openFile(Uri uri, String mode) |
| 841 | throws FileNotFoundException { |
| 842 | throw new FileNotFoundException("No files supported by provider at " |
| 843 | + uri); |
| 844 | } |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 845 | |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 846 | /** |
| 847 | * This is like {@link #openFile}, but can be implemented by providers |
| 848 | * that need to be able to return sub-sections of files, often assets |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 849 | * inside of their .apk. |
| 850 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 851 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 852 | * and Threads</a>. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 853 | * |
| 854 | * <p>If you implement this, your clients must be able to deal with such |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 855 | * file slices, either directly with |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 856 | * {@link ContentResolver#openAssetFileDescriptor}, or by using the higher-level |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 857 | * {@link ContentResolver#openInputStream ContentResolver.openInputStream} |
| 858 | * or {@link ContentResolver#openOutputStream ContentResolver.openOutputStream} |
| 859 | * methods. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 860 | * |
| 861 | * <p class="note">If you are implementing this to return a full file, you |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 862 | * should create the AssetFileDescriptor with |
| 863 | * {@link AssetFileDescriptor#UNKNOWN_LENGTH} to be compatible with |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 864 | * applications that can not handle sub-sections of files.</p> |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 865 | * |
| 866 | * @param uri The URI whose file is to be opened. |
| 867 | * @param mode Access mode for the file. May be "r" for read-only access, |
| 868 | * "w" for write-only access (erasing whatever data is currently in |
| 869 | * the file), "wa" for write-only access to append to any existing data, |
| 870 | * "rw" for read and write access on any existing data, and "rwt" for read |
| 871 | * and write access that truncates any existing file. |
| 872 | * |
| 873 | * @return Returns a new AssetFileDescriptor which you can use to access |
| 874 | * the file. |
| 875 | * |
| 876 | * @throws FileNotFoundException Throws FileNotFoundException if there is |
| 877 | * no file associated with the given URI or the mode is invalid. |
| 878 | * @throws SecurityException Throws SecurityException if the caller does |
| 879 | * not have permission to access the file. |
| 880 | * |
| 881 | * @see #openFile(Uri, String) |
| 882 | * @see #openFileHelper(Uri, String) |
| 883 | */ |
| 884 | public AssetFileDescriptor openAssetFile(Uri uri, String mode) |
| 885 | throws FileNotFoundException { |
| 886 | ParcelFileDescriptor fd = openFile(uri, mode); |
| 887 | return fd != null ? new AssetFileDescriptor(fd, 0, -1) : null; |
| 888 | } |
| 889 | |
| 890 | /** |
| 891 | * Convenience for subclasses that wish to implement {@link #openFile} |
| 892 | * by looking up a column named "_data" at the given URI. |
| 893 | * |
| 894 | * @param uri The URI to be opened. |
| 895 | * @param mode The file mode. May be "r" for read-only access, |
| 896 | * "w" for write-only access (erasing whatever data is currently in |
| 897 | * the file), "wa" for write-only access to append to any existing data, |
| 898 | * "rw" for read and write access on any existing data, and "rwt" for read |
| 899 | * and write access that truncates any existing file. |
| 900 | * |
| 901 | * @return Returns a new ParcelFileDescriptor that can be used by the |
| 902 | * client to access the file. |
| 903 | */ |
| 904 | protected final ParcelFileDescriptor openFileHelper(Uri uri, |
| 905 | String mode) throws FileNotFoundException { |
| 906 | Cursor c = query(uri, new String[]{"_data"}, null, null, null); |
| 907 | int count = (c != null) ? c.getCount() : 0; |
| 908 | if (count != 1) { |
| 909 | // If there is not exactly one result, throw an appropriate |
| 910 | // exception. |
| 911 | if (c != null) { |
| 912 | c.close(); |
| 913 | } |
| 914 | if (count == 0) { |
| 915 | throw new FileNotFoundException("No entry for " + uri); |
| 916 | } |
| 917 | throw new FileNotFoundException("Multiple items at " + uri); |
| 918 | } |
| 919 | |
| 920 | c.moveToFirst(); |
| 921 | int i = c.getColumnIndex("_data"); |
| 922 | String path = (i >= 0 ? c.getString(i) : null); |
| 923 | c.close(); |
| 924 | if (path == null) { |
| 925 | throw new FileNotFoundException("Column _data not found."); |
| 926 | } |
| 927 | |
| 928 | int modeBits = ContentResolver.modeToMode(uri, mode); |
| 929 | return ParcelFileDescriptor.open(new File(path), modeBits); |
| 930 | } |
| 931 | |
| 932 | /** |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 933 | * Called by a client to determine the types of data streams that this |
| 934 | * content provider supports for the given URI. The default implementation |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 935 | * returns {@code null}, meaning no types. If your content provider stores data |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 936 | * of a particular type, return that MIME type if it matches the given |
| 937 | * mimeTypeFilter. If it can perform type conversions, return an array |
| 938 | * of all supported MIME types that match mimeTypeFilter. |
| 939 | * |
| 940 | * @param uri The data in the content provider being queried. |
| 941 | * @param mimeTypeFilter The type of data the client desires. May be |
| 942 | * a pattern, such as *\/* to retrieve all possible data types. |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 943 | * @return Returns {@code null} if there are no possible data streams for the |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 944 | * given mimeTypeFilter. Otherwise returns an array of all available |
| 945 | * concrete MIME types. |
| 946 | * |
| 947 | * @see #getType(Uri) |
| 948 | * @see #openTypedAssetFile(Uri, String, Bundle) |
Dianne Hackborn | 1040dc4 | 2010-08-26 22:11:06 -0700 | [diff] [blame] | 949 | * @see ClipDescription#compareMimeTypes(String, String) |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 950 | */ |
| 951 | public String[] getStreamTypes(Uri uri, String mimeTypeFilter) { |
| 952 | return null; |
| 953 | } |
| 954 | |
| 955 | /** |
| 956 | * Called by a client to open a read-only stream containing data of a |
| 957 | * particular MIME type. This is like {@link #openAssetFile(Uri, String)}, |
| 958 | * except the file can only be read-only and the content provider may |
| 959 | * perform data conversions to generate data of the desired type. |
| 960 | * |
| 961 | * <p>The default implementation compares the given mimeType against the |
| 962 | * result of {@link #getType(Uri)} and, if the match, simple calls |
| 963 | * {@link #openAssetFile(Uri, String)}. |
| 964 | * |
Dianne Hackborn | 1040dc4 | 2010-08-26 22:11:06 -0700 | [diff] [blame] | 965 | * <p>See {@link ClipData} for examples of the use and implementation |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 966 | * of this method. |
| 967 | * |
| 968 | * @param uri The data in the content provider being queried. |
| 969 | * @param mimeTypeFilter The type of data the client desires. May be |
| 970 | * a pattern, such as *\/*, if the caller does not have specific type |
| 971 | * requirements; in this case the content provider will pick its best |
| 972 | * type matching the pattern. |
| 973 | * @param opts Additional options from the client. The definitions of |
| 974 | * these are specific to the content provider being called. |
| 975 | * |
| 976 | * @return Returns a new AssetFileDescriptor from which the client can |
| 977 | * read data of the desired type. |
| 978 | * |
| 979 | * @throws FileNotFoundException Throws FileNotFoundException if there is |
| 980 | * no file associated with the given URI or the mode is invalid. |
| 981 | * @throws SecurityException Throws SecurityException if the caller does |
| 982 | * not have permission to access the data. |
| 983 | * @throws IllegalArgumentException Throws IllegalArgumentException if the |
| 984 | * content provider does not support the requested MIME type. |
| 985 | * |
| 986 | * @see #getStreamTypes(Uri, String) |
| 987 | * @see #openAssetFile(Uri, String) |
Dianne Hackborn | 1040dc4 | 2010-08-26 22:11:06 -0700 | [diff] [blame] | 988 | * @see ClipDescription#compareMimeTypes(String, String) |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 989 | */ |
| 990 | public AssetFileDescriptor openTypedAssetFile(Uri uri, String mimeTypeFilter, Bundle opts) |
| 991 | throws FileNotFoundException { |
Dianne Hackborn | 02dfd26 | 2010-08-13 12:34:58 -0700 | [diff] [blame] | 992 | if ("*/*".equals(mimeTypeFilter)) { |
| 993 | // If they can take anything, the untyped open call is good enough. |
| 994 | return openAssetFile(uri, "r"); |
| 995 | } |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 996 | String baseType = getType(uri); |
Dianne Hackborn | 1040dc4 | 2010-08-26 22:11:06 -0700 | [diff] [blame] | 997 | if (baseType != null && ClipDescription.compareMimeTypes(baseType, mimeTypeFilter)) { |
Dianne Hackborn | 02dfd26 | 2010-08-13 12:34:58 -0700 | [diff] [blame] | 998 | // Use old untyped open call if this provider has a type for this |
| 999 | // URI and it matches the request. |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 1000 | return openAssetFile(uri, "r"); |
| 1001 | } |
| 1002 | throw new FileNotFoundException("Can't open " + uri + " as type " + mimeTypeFilter); |
| 1003 | } |
| 1004 | |
| 1005 | /** |
| 1006 | * Interface to write a stream of data to a pipe. Use with |
| 1007 | * {@link ContentProvider#openPipeHelper}. |
| 1008 | */ |
| 1009 | public interface PipeDataWriter<T> { |
| 1010 | /** |
| 1011 | * Called from a background thread to stream data out to a pipe. |
| 1012 | * Note that the pipe is blocking, so this thread can block on |
| 1013 | * writes for an arbitrary amount of time if the client is slow |
| 1014 | * at reading. |
| 1015 | * |
| 1016 | * @param output The pipe where data should be written. This will be |
| 1017 | * closed for you upon returning from this function. |
| 1018 | * @param uri The URI whose data is to be written. |
| 1019 | * @param mimeType The desired type of data to be written. |
| 1020 | * @param opts Options supplied by caller. |
| 1021 | * @param args Your own custom arguments. |
| 1022 | */ |
| 1023 | public void writeDataToPipe(ParcelFileDescriptor output, Uri uri, String mimeType, |
| 1024 | Bundle opts, T args); |
| 1025 | } |
| 1026 | |
| 1027 | /** |
| 1028 | * A helper function for implementing {@link #openTypedAssetFile}, for |
| 1029 | * creating a data pipe and background thread allowing you to stream |
| 1030 | * generated data back to the client. This function returns a new |
| 1031 | * ParcelFileDescriptor that should be returned to the caller (the caller |
| 1032 | * is responsible for closing it). |
| 1033 | * |
| 1034 | * @param uri The URI whose data is to be written. |
| 1035 | * @param mimeType The desired type of data to be written. |
| 1036 | * @param opts Options supplied by caller. |
| 1037 | * @param args Your own custom arguments. |
| 1038 | * @param func Interface implementing the function that will actually |
| 1039 | * stream the data. |
| 1040 | * @return Returns a new ParcelFileDescriptor holding the read side of |
| 1041 | * the pipe. This should be returned to the caller for reading; the caller |
| 1042 | * is responsible for closing it when done. |
| 1043 | */ |
| 1044 | public <T> ParcelFileDescriptor openPipeHelper(final Uri uri, final String mimeType, |
| 1045 | final Bundle opts, final T args, final PipeDataWriter<T> func) |
| 1046 | throws FileNotFoundException { |
| 1047 | try { |
| 1048 | final ParcelFileDescriptor[] fds = ParcelFileDescriptor.createPipe(); |
| 1049 | |
| 1050 | AsyncTask<Object, Object, Object> task = new AsyncTask<Object, Object, Object>() { |
| 1051 | @Override |
| 1052 | protected Object doInBackground(Object... params) { |
| 1053 | func.writeDataToPipe(fds[1], uri, mimeType, opts, args); |
| 1054 | try { |
| 1055 | fds[1].close(); |
| 1056 | } catch (IOException e) { |
| 1057 | Log.w(TAG, "Failure closing pipe", e); |
| 1058 | } |
| 1059 | return null; |
| 1060 | } |
| 1061 | }; |
Dianne Hackborn | 5d9d03a | 2011-01-24 13:15:09 -0800 | [diff] [blame] | 1062 | task.executeOnExecutor(AsyncTask.THREAD_POOL_EXECUTOR, (Object[])null); |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 1063 | |
| 1064 | return fds[0]; |
| 1065 | } catch (IOException e) { |
| 1066 | throw new FileNotFoundException("failure making pipe"); |
| 1067 | } |
| 1068 | } |
| 1069 | |
| 1070 | /** |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1071 | * Returns true if this instance is a temporary content provider. |
| 1072 | * @return true if this instance is a temporary content provider |
| 1073 | */ |
| 1074 | protected boolean isTemporary() { |
| 1075 | return false; |
| 1076 | } |
| 1077 | |
| 1078 | /** |
| 1079 | * Returns the Binder object for this provider. |
| 1080 | * |
| 1081 | * @return the Binder object for this provider |
| 1082 | * @hide |
| 1083 | */ |
| 1084 | public IContentProvider getIContentProvider() { |
| 1085 | return mTransport; |
| 1086 | } |
| 1087 | |
| 1088 | /** |
| 1089 | * After being instantiated, this is called to tell the content provider |
| 1090 | * about itself. |
| 1091 | * |
| 1092 | * @param context The context this provider is running in |
| 1093 | * @param info Registered information about this content provider |
| 1094 | */ |
| 1095 | public void attachInfo(Context context, ProviderInfo info) { |
Dianne Hackborn | 23fdaf6 | 2010-08-06 12:16:55 -0700 | [diff] [blame] | 1096 | /* |
| 1097 | * We may be using AsyncTask from binder threads. Make it init here |
| 1098 | * so its static handler is on the main thread. |
| 1099 | */ |
| 1100 | AsyncTask.init(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1101 | |
| 1102 | /* |
| 1103 | * Only allow it to be set once, so after the content service gives |
| 1104 | * this to us clients can't change it. |
| 1105 | */ |
| 1106 | if (mContext == null) { |
| 1107 | mContext = context; |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 1108 | mMyUid = Process.myUid(); |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1109 | if (info != null) { |
| 1110 | setReadPermission(info.readPermission); |
| 1111 | setWritePermission(info.writePermission); |
Dianne Hackborn | 2af632f | 2009-07-08 14:56:37 -0700 | [diff] [blame] | 1112 | setPathPermissions(info.pathPermissions); |
Dianne Hackborn | b424b63 | 2010-08-18 15:59:05 -0700 | [diff] [blame] | 1113 | mExported = info.exported; |
The Android Open Source Project | 9066cfe | 2009-03-03 19:31:44 -0800 | [diff] [blame] | 1114 | } |
| 1115 | ContentProvider.this.onCreate(); |
| 1116 | } |
| 1117 | } |
Fred Quintana | ce31b23 | 2009-05-04 16:01:15 -0700 | [diff] [blame] | 1118 | |
| 1119 | /** |
Dan Egnor | 17876aa | 2010-07-28 12:28:04 -0700 | [diff] [blame] | 1120 | * Override this to handle requests to perform a batch of operations, or the |
| 1121 | * default implementation will iterate over the operations and call |
| 1122 | * {@link ContentProviderOperation#apply} on each of them. |
| 1123 | * If all calls to {@link ContentProviderOperation#apply} succeed |
| 1124 | * then a {@link ContentProviderResult} array with as many |
| 1125 | * elements as there were operations will be returned. If any of the calls |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 1126 | * fail, it is up to the implementation how many of the others take effect. |
| 1127 | * This method can be called from multiple threads, as described in |
Scott Main | 7aee61f | 2011-02-08 11:25:01 -0800 | [diff] [blame] | 1128 | * <a href="{@docRoot}guide/topics/fundamentals/processes-and-threads.html#Threads">Processes |
| 1129 | * and Threads</a>. |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 1130 | * |
Fred Quintana | ce31b23 | 2009-05-04 16:01:15 -0700 | [diff] [blame] | 1131 | * @param operations the operations to apply |
| 1132 | * @return the results of the applications |
Dan Egnor | 6fcc0f073 | 2010-07-27 16:32:17 -0700 | [diff] [blame] | 1133 | * @throws OperationApplicationException thrown if any operation fails. |
| 1134 | * @see ContentProviderOperation#apply |
Fred Quintana | ce31b23 | 2009-05-04 16:01:15 -0700 | [diff] [blame] | 1135 | */ |
Fred Quintana | 03d9490 | 2009-05-22 14:23:31 -0700 | [diff] [blame] | 1136 | public ContentProviderResult[] applyBatch(ArrayList<ContentProviderOperation> operations) |
Fred Quintana | ce31b23 | 2009-05-04 16:01:15 -0700 | [diff] [blame] | 1137 | throws OperationApplicationException { |
Fred Quintana | 03d9490 | 2009-05-22 14:23:31 -0700 | [diff] [blame] | 1138 | final int numOperations = operations.size(); |
| 1139 | final ContentProviderResult[] results = new ContentProviderResult[numOperations]; |
| 1140 | for (int i = 0; i < numOperations; i++) { |
| 1141 | results[i] = operations.get(i).apply(this, results, i); |
Fred Quintana | ce31b23 | 2009-05-04 16:01:15 -0700 | [diff] [blame] | 1142 | } |
| 1143 | return results; |
| 1144 | } |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 1145 | |
| 1146 | /** |
Manuel Roman | 2c96a0c | 2010-08-05 16:39:49 -0700 | [diff] [blame] | 1147 | * Call a provider-defined method. This can be used to implement |
Brad Fitzpatrick | 534c84c | 2011-01-12 14:06:30 -0800 | [diff] [blame] | 1148 | * interfaces that are cheaper and/or unnatural for a table-like |
| 1149 | * model. |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 1150 | * |
Christopher Tate | 2bc6eb8 | 2013-01-03 12:04:08 -0800 | [diff] [blame] | 1151 | * @param method method name to call. Opaque to framework, but should not be {@code null}. |
| 1152 | * @param arg provider-defined String argument. May be {@code null}. |
| 1153 | * @param extras provider-defined Bundle argument. May be {@code null}. |
| 1154 | * @return provider-defined return value. May be {@code null}, which is also |
Brad Fitzpatrick | 534c84c | 2011-01-12 14:06:30 -0800 | [diff] [blame] | 1155 | * the default for providers which don't implement any call methods. |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 1156 | */ |
Brad Fitzpatrick | 534c84c | 2011-01-12 14:06:30 -0800 | [diff] [blame] | 1157 | public Bundle call(String method, String arg, Bundle extras) { |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 1158 | return null; |
| 1159 | } |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 1160 | |
| 1161 | /** |
Manuel Roman | 2c96a0c | 2010-08-05 16:39:49 -0700 | [diff] [blame] | 1162 | * Implement this to shut down the ContentProvider instance. You can then |
| 1163 | * invoke this method in unit tests. |
| 1164 | * |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 1165 | * <p> |
Manuel Roman | 2c96a0c | 2010-08-05 16:39:49 -0700 | [diff] [blame] | 1166 | * Android normally handles ContentProvider startup and shutdown |
| 1167 | * automatically. You do not need to start up or shut down a |
| 1168 | * ContentProvider. When you invoke a test method on a ContentProvider, |
| 1169 | * however, a ContentProvider instance is started and keeps running after |
| 1170 | * the test finishes, even if a succeeding test instantiates another |
| 1171 | * ContentProvider. A conflict develops because the two instances are |
| 1172 | * usually running against the same underlying data source (for example, an |
| 1173 | * sqlite database). |
| 1174 | * </p> |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 1175 | * <p> |
Manuel Roman | 2c96a0c | 2010-08-05 16:39:49 -0700 | [diff] [blame] | 1176 | * Implementing shutDown() avoids this conflict by providing a way to |
| 1177 | * terminate the ContentProvider. This method can also prevent memory leaks |
| 1178 | * from multiple instantiations of the ContentProvider, and it can ensure |
| 1179 | * unit test isolation by allowing you to completely clean up the test |
| 1180 | * fixture before moving on to the next test. |
| 1181 | * </p> |
Vasu Nori | 0c9e14a | 2010-08-04 13:31:48 -0700 | [diff] [blame] | 1182 | */ |
| 1183 | public void shutdown() { |
| 1184 | Log.w(TAG, "implement ContentProvider shutdown() to make sure all database " + |
| 1185 | "connections are gracefully shutdown"); |
| 1186 | } |
Marco Nelissen | 18cb287 | 2011-11-15 11:19:53 -0800 | [diff] [blame] | 1187 | |
| 1188 | /** |
| 1189 | * Print the Provider's state into the given stream. This gets invoked if |
Jeff Sharkey | 5554b70 | 2012-04-11 18:30:51 -0700 | [diff] [blame] | 1190 | * you run "adb shell dumpsys activity provider <provider_component_name>". |
Marco Nelissen | 18cb287 | 2011-11-15 11:19:53 -0800 | [diff] [blame] | 1191 | * |
| 1192 | * @param prefix Desired prefix to prepend at each line of output. |
| 1193 | * @param fd The raw file descriptor that the dump is being sent to. |
| 1194 | * @param writer The PrintWriter to which you should dump your state. This will be |
| 1195 | * closed for you after you return. |
| 1196 | * @param args additional arguments to the dump request. |
| 1197 | * @hide |
| 1198 | */ |
| 1199 | public void dump(FileDescriptor fd, PrintWriter writer, String[] args) { |
| 1200 | writer.println("nothing to dump"); |
| 1201 | } |
Brad Fitzpatrick | 1877d01 | 2010-03-04 17:48:13 -0800 | [diff] [blame] | 1202 | } |