Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2013 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 com.android.documentsui; |
| 18 | |
Steve McKay | 98f8c5f | 2017-03-03 13:52:14 -0800 | [diff] [blame] | 19 | import static com.android.documentsui.base.Shared.VERBOSE; |
| 20 | |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 21 | import android.content.AsyncTaskLoader; |
| 22 | import android.content.ContentProviderClient; |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 23 | import android.content.ContentResolver; |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 24 | import android.content.Context; |
Steve McKay | 98f8c5f | 2017-03-03 13:52:14 -0800 | [diff] [blame] | 25 | import android.content.res.Resources; |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 26 | import android.database.ContentObserver; |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 27 | import android.database.Cursor; |
| 28 | import android.net.Uri; |
Steve McKay | 50b9bae | 2017-01-17 11:12:08 -0800 | [diff] [blame] | 29 | import android.os.Bundle; |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 30 | import android.os.CancellationSignal; |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 31 | import android.os.Handler; |
Garfield Tan | e967033 | 2017-03-06 18:33:23 -0800 | [diff] [blame^] | 32 | import android.os.Looper; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 33 | import android.os.OperationCanceledException; |
Makoto Onuki | 7777875 | 2015-07-01 14:55:14 -0700 | [diff] [blame] | 34 | import android.os.RemoteException; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 35 | import android.provider.DocumentsContract.Document; |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 36 | import android.util.Log; |
| 37 | |
Tomasz Mikolajewski | b19061c | 2017-02-13 17:33:42 +0900 | [diff] [blame] | 38 | import com.android.documentsui.archives.ArchivesProvider; |
Steve McKay | 50b9bae | 2017-01-17 11:12:08 -0800 | [diff] [blame] | 39 | import com.android.documentsui.base.DebugFlags; |
Steve McKay | d080506 | 2016-09-15 14:30:38 -0700 | [diff] [blame] | 40 | import com.android.documentsui.base.DocumentInfo; |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 41 | import com.android.documentsui.base.FilteringCursorWrapper; |
Steve McKay | d080506 | 2016-09-15 14:30:38 -0700 | [diff] [blame] | 42 | import com.android.documentsui.base.RootInfo; |
Steve McKay | d9caa6a | 2016-09-15 16:36:45 -0700 | [diff] [blame] | 43 | import com.android.documentsui.roots.RootCursorWrapper; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 44 | import com.android.documentsui.sorting.SortModel; |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 45 | |
Steve McKay | c88f83c | 2016-08-31 12:01:43 -0700 | [diff] [blame] | 46 | import libcore.io.IoUtils; |
| 47 | |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 48 | public class DirectoryLoader extends AsyncTaskLoader<DirectoryResult> { |
Jeff Sharkey | 9dd0262 | 2013-09-27 16:44:11 -0700 | [diff] [blame] | 49 | |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 50 | private static final String TAG = "DirectoryLoader"; |
| 51 | |
Jeff Sharkey | 9dd0262 | 2013-09-27 16:44:11 -0700 | [diff] [blame] | 52 | private static final String[] SEARCH_REJECT_MIMES = new String[] { Document.MIME_TYPE_DIR }; |
| 53 | |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 54 | private final LockingContentObserver mObserver; |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 55 | private final RootInfo mRoot; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 56 | private final Uri mUri; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 57 | private final SortModel mModel; |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 58 | private final boolean mSearchMode; |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 59 | |
Steve McKay | 7776aa5 | 2016-01-25 19:00:22 -0800 | [diff] [blame] | 60 | private DocumentInfo mDoc; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 61 | private CancellationSignal mSignal; |
| 62 | private DirectoryResult mResult; |
| 63 | |
Steve McKay | c88f83c | 2016-08-31 12:01:43 -0700 | [diff] [blame] | 64 | public DirectoryLoader( |
| 65 | Context context, |
| 66 | RootInfo root, |
| 67 | DocumentInfo doc, |
| 68 | Uri uri, |
| 69 | SortModel model, |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 70 | DirectoryReloadLock lock, |
Steve McKay | c88f83c | 2016-08-31 12:01:43 -0700 | [diff] [blame] | 71 | boolean inSearchMode) { |
| 72 | |
Jeff Sharkey | f63b777 | 2013-10-01 17:57:41 -0700 | [diff] [blame] | 73 | super(context, ProviderExecutor.forAuthority(root.authority)); |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 74 | mRoot = root; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 75 | mUri = uri; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 76 | mModel = model; |
Steve McKay | 7776aa5 | 2016-01-25 19:00:22 -0800 | [diff] [blame] | 77 | mDoc = doc; |
Aga Wronska | af5ace5 | 2016-02-17 13:50:42 -0800 | [diff] [blame] | 78 | mSearchMode = inSearchMode; |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 79 | mObserver = new LockingContentObserver(lock, this::onContentChanged); |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 80 | } |
| 81 | |
| 82 | @Override |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 83 | public final DirectoryResult loadInBackground() { |
| 84 | synchronized (this) { |
| 85 | if (isLoadInBackgroundCanceled()) { |
| 86 | throw new OperationCanceledException(); |
| 87 | } |
| 88 | mSignal = new CancellationSignal(); |
| 89 | } |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 90 | |
| 91 | final ContentResolver resolver = getContext().getContentResolver(); |
Jeff Sharkey | d82b26b | 2013-09-02 15:07:28 -0700 | [diff] [blame] | 92 | final String authority = mUri.getAuthority(); |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 93 | |
| 94 | final DirectoryResult result = new DirectoryResult(); |
Tomasz Mikolajewski | e29e341 | 2016-02-24 12:53:44 +0900 | [diff] [blame] | 95 | result.doc = mDoc; |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 96 | |
Jeff Sharkey | f63b777 | 2013-10-01 17:57:41 -0700 | [diff] [blame] | 97 | ContentProviderClient client = null; |
Garfield, Tan | 11d2348 | 2016-08-05 09:33:29 -0700 | [diff] [blame] | 98 | Cursor cursor; |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 99 | try { |
Jeff Sharkey | f63b777 | 2013-10-01 17:57:41 -0700 | [diff] [blame] | 100 | client = DocumentsApplication.acquireUnstableProviderOrThrow(resolver, authority); |
Tomasz Mikolajewski | b19061c | 2017-02-13 17:33:42 +0900 | [diff] [blame] | 101 | if (mDoc.isInArchive()) { |
| 102 | ArchivesProvider.acquireArchive(client, mUri); |
| 103 | } |
| 104 | result.client = client; |
Steve McKay | 50b9bae | 2017-01-17 11:12:08 -0800 | [diff] [blame] | 105 | |
Steve McKay | 98f8c5f | 2017-03-03 13:52:14 -0800 | [diff] [blame] | 106 | Resources resources = getContext().getResources(); |
| 107 | if (resources.getBoolean(R.bool.feature_content_paging)) { |
Steve McKay | f208d84 | 2017-02-27 12:57:58 -0800 | [diff] [blame] | 108 | Bundle queryArgs = new Bundle(); |
| 109 | mModel.addQuerySortArgs(queryArgs); |
Steve McKay | 50b9bae | 2017-01-17 11:12:08 -0800 | [diff] [blame] | 110 | |
Steve McKay | f208d84 | 2017-02-27 12:57:58 -0800 | [diff] [blame] | 111 | // TODO: At some point we don't want forced flags to override real paging... |
| 112 | // and that point is when we have real paging. |
| 113 | DebugFlags.addForcedPagingArgs(queryArgs); |
| 114 | |
| 115 | cursor = client.query(mUri, null, queryArgs, mSignal); |
| 116 | } else { |
| 117 | cursor = client.query( |
| 118 | mUri, null, null, null, mModel.getDocumentSortQuery(), mSignal); |
Makoto Onuki | 7777875 | 2015-07-01 14:55:14 -0700 | [diff] [blame] | 119 | } |
| 120 | |
Steve McKay | f208d84 | 2017-02-27 12:57:58 -0800 | [diff] [blame] | 121 | if (cursor == null) { |
| 122 | throw new RemoteException("Provider returned null"); |
Steve McKay | 50b9bae | 2017-01-17 11:12:08 -0800 | [diff] [blame] | 123 | } |
| 124 | |
Jeff Sharkey | 20b3227 | 2013-09-03 15:25:52 -0700 | [diff] [blame] | 125 | cursor.registerContentObserver(mObserver); |
| 126 | |
Jeff Sharkey | a35ac2d | 2013-09-10 12:04:26 -0700 | [diff] [blame] | 127 | cursor = new RootCursorWrapper(mUri.getAuthority(), mRoot.rootId, cursor, -1); |
Jeff Sharkey | d82b26b | 2013-09-02 15:07:28 -0700 | [diff] [blame] | 128 | |
Steve McKay | 98f8c5f | 2017-03-03 13:52:14 -0800 | [diff] [blame] | 129 | if (mSearchMode && !resources.getBoolean(R.bool.feature_folders_in_search_results)) { |
Garfield Tan | b00bbc5 | 2016-11-01 14:23:35 -0700 | [diff] [blame] | 130 | // There is no findDocumentPath API. Enable filtering on folders in search mode. |
Jeff Sharkey | 9dd0262 | 2013-09-27 16:44:11 -0700 | [diff] [blame] | 131 | cursor = new FilteringCursorWrapper(cursor, null, SEARCH_REJECT_MIMES); |
Jeff Sharkey | a35ac2d | 2013-09-10 12:04:26 -0700 | [diff] [blame] | 132 | } |
| 133 | |
Steve McKay | 98f8c5f | 2017-03-03 13:52:14 -0800 | [diff] [blame] | 134 | // TODO: When API tweaks have landed, use ContentResolver.EXTRA_HONORED_ARGS |
| 135 | // instead of checking directly for ContentResolver.QUERY_ARG_SORT_COLUMNS (won't work) |
| 136 | if (resources.getBoolean(R.bool.feature_content_paging) |
| 137 | && cursor.getExtras().containsKey(ContentResolver.QUERY_ARG_SORT_COLUMNS)) { |
| 138 | if (VERBOSE) Log.d(TAG, "Skipping sort of pre-sorted cursor. Booya!"); |
| 139 | } else { |
| 140 | cursor = mModel.sortCursor(cursor); |
| 141 | } |
Jeff Sharkey | a35ac2d | 2013-09-10 12:04:26 -0700 | [diff] [blame] | 142 | result.cursor = cursor; |
Jeff Sharkey | 1d890e0 | 2013-08-15 11:24:03 -0700 | [diff] [blame] | 143 | } catch (Exception e) { |
Jeff Sharkey | 0e8c871 | 2013-09-12 21:59:06 -0700 | [diff] [blame] | 144 | Log.w(TAG, "Failed to query", e); |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 145 | result.exception = e; |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 146 | } finally { |
| 147 | synchronized (this) { |
| 148 | mSignal = null; |
| 149 | } |
Tomasz Mikolajewski | b19061c | 2017-02-13 17:33:42 +0900 | [diff] [blame] | 150 | // TODO: Remove this call. |
Ben Lin | f8f06e9 | 2017-01-27 17:15:48 -0800 | [diff] [blame] | 151 | ContentProviderClient.releaseQuietly(client); |
Jeff Sharkey | 1d890e0 | 2013-08-15 11:24:03 -0700 | [diff] [blame] | 152 | } |
Jeff Sharkey | a4d1f22 | 2013-09-07 14:45:03 -0700 | [diff] [blame] | 153 | |
Jeff Sharkey | 46899c8 | 2013-08-18 22:26:48 -0700 | [diff] [blame] | 154 | return result; |
Jeff Sharkey | 1d890e0 | 2013-08-15 11:24:03 -0700 | [diff] [blame] | 155 | } |
| 156 | |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 157 | @Override |
| 158 | public void cancelLoadInBackground() { |
| 159 | super.cancelLoadInBackground(); |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 160 | |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 161 | synchronized (this) { |
| 162 | if (mSignal != null) { |
| 163 | mSignal.cancel(); |
Jeff Sharkey | 46899c8 | 2013-08-18 22:26:48 -0700 | [diff] [blame] | 164 | } |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 165 | } |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 166 | } |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 167 | |
Jeff Sharkey | ac9e627 | 2013-08-31 21:27:44 -0700 | [diff] [blame] | 168 | @Override |
| 169 | public void deliverResult(DirectoryResult result) { |
| 170 | if (isReset()) { |
| 171 | IoUtils.closeQuietly(result); |
| 172 | return; |
| 173 | } |
| 174 | DirectoryResult oldResult = mResult; |
| 175 | mResult = result; |
| 176 | |
| 177 | if (isStarted()) { |
| 178 | super.deliverResult(result); |
| 179 | } |
| 180 | |
| 181 | if (oldResult != null && oldResult != result) { |
| 182 | IoUtils.closeQuietly(oldResult); |
| 183 | } |
| 184 | } |
| 185 | |
| 186 | @Override |
| 187 | protected void onStartLoading() { |
| 188 | if (mResult != null) { |
| 189 | deliverResult(mResult); |
| 190 | } |
| 191 | if (takeContentChanged() || mResult == null) { |
| 192 | forceLoad(); |
| 193 | } |
| 194 | } |
| 195 | |
| 196 | @Override |
| 197 | protected void onStopLoading() { |
| 198 | cancelLoad(); |
| 199 | } |
| 200 | |
| 201 | @Override |
| 202 | public void onCanceled(DirectoryResult result) { |
| 203 | IoUtils.closeQuietly(result); |
| 204 | } |
| 205 | |
| 206 | @Override |
| 207 | protected void onReset() { |
| 208 | super.onReset(); |
| 209 | |
| 210 | // Ensure the loader is stopped |
| 211 | onStopLoading(); |
| 212 | |
| 213 | IoUtils.closeQuietly(mResult); |
| 214 | mResult = null; |
| 215 | |
| 216 | getContext().getContentResolver().unregisterContentObserver(mObserver); |
| 217 | } |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 218 | |
| 219 | private static final class LockingContentObserver extends ContentObserver { |
| 220 | private final DirectoryReloadLock mLock; |
| 221 | private final Runnable mContentChangedCallback; |
| 222 | |
| 223 | public LockingContentObserver(DirectoryReloadLock lock, Runnable contentChangedCallback) { |
Garfield Tan | e967033 | 2017-03-06 18:33:23 -0800 | [diff] [blame^] | 224 | super(new Handler(Looper.getMainLooper())); |
Ben Lin | 9fea312 | 2016-10-10 18:32:26 -0700 | [diff] [blame] | 225 | mLock = lock; |
| 226 | mContentChangedCallback = contentChangedCallback; |
| 227 | } |
| 228 | |
| 229 | @Override |
| 230 | public boolean deliverSelfNotifications() { |
| 231 | return true; |
| 232 | } |
| 233 | |
| 234 | @Override |
| 235 | public void onChange(boolean selfChange) { |
| 236 | mLock.tryUpdate(mContentChangedCallback); |
| 237 | } |
| 238 | } |
Jeff Sharkey | a5defe3 | 2013-08-05 17:56:48 -0700 | [diff] [blame] | 239 | } |