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
17package com.android.documentsui;
18
19import android.annotation.Nullable;
20import android.content.ContentProviderClient;
21import android.content.ContentResolver;
22import android.content.Context;
23import android.database.Cursor;
24import android.net.Uri;
25import android.os.ParcelFileDescriptor;
26import android.os.RemoteException;
27import android.provider.DocumentsContract;
28import android.provider.DocumentsContract.Path;
29import android.util.Log;
30
31import com.android.documentsui.archives.ArchivesProvider;
32import com.android.documentsui.base.DocumentInfo;
33import com.android.documentsui.base.RootInfo;
34
35import java.io.FileNotFoundException;
36import java.util.ArrayList;
37import java.util.List;
38
39/**
40 * Provides synchronous access to {@link DocumentInfo} instances given some identifying information
41 * and some documents API.
42 */
43public interface DocumentsAccess {
44
45    @Nullable DocumentInfo getRootDocument(RootInfo root);
46    @Nullable DocumentInfo getDocument(Uri uri);
47    @Nullable DocumentInfo getArchiveDocument(Uri uri);
48
49    boolean isDocumentUri(Uri uri);
50    @Nullable Path findDocumentPath(Uri uri) throws RemoteException;
51
52    List<DocumentInfo> getDocuments(String authority, List<String> docIds) throws RemoteException;
53
54    @Nullable Uri createDocument(DocumentInfo parentDoc, String mimeType, String displayName);
55
56    public static DocumentsAccess create(Context context) {
57        return new RuntimeDocumentAccess(context);
58    }
59
60    public final class RuntimeDocumentAccess implements DocumentsAccess {
61
62        private static final String TAG = "DocumentAccess";
63
64        private final Context mContext;
65
66        private RuntimeDocumentAccess(Context context) {
67            mContext = context;
68        }
69
70        @Override
71        public @Nullable DocumentInfo getRootDocument(RootInfo root) {
72            return getDocument(
73                    DocumentsContract.buildDocumentUri(root.authority, root.documentId));
74        }
75
76        @Override
77        public @Nullable DocumentInfo getDocument(Uri uri) {
78            try {
79                return DocumentInfo.fromUri(mContext.getContentResolver(), uri);
80            } catch (FileNotFoundException e) {
81                Log.w(TAG, "Couldn't create DocumentInfo for uri: " + uri);
82            }
83
84            return null;
85        }
86
87        @Override
88        public List<DocumentInfo> getDocuments(String authority, List<String> docIds)
89                throws RemoteException {
90
91            try(final ContentProviderClient client = DocumentsApplication
92                    .acquireUnstableProviderOrThrow(mContext.getContentResolver(), authority)) {
93
94                List<DocumentInfo> result = new ArrayList<>(docIds.size());
95                for (String docId : docIds) {
96                    final Uri uri = DocumentsContract.buildDocumentUri(authority, docId);
97                    try (final Cursor cursor = client.query(uri, null, null, null, null)) {
98                        if (!cursor.moveToNext()) {
99                            Log.e(TAG, "Couldn't create DocumentInfo for Uri: " + uri);
100                            throw new RemoteException("Failed to move cursor.");
101                        }
102
103                        result.add(DocumentInfo.fromCursor(cursor, authority));
104                    }
105                }
106
107                return result;
108            }
109        }
110
111        @Override
112        public DocumentInfo getArchiveDocument(Uri uri) {
113            return getDocument(ArchivesProvider.buildUriForArchive(uri,
114                    ParcelFileDescriptor.MODE_READ_ONLY));
115        }
116
117        @Override
118        public boolean isDocumentUri(Uri uri) {
119            return DocumentsContract.isDocumentUri(mContext, uri);
120        }
121
122        @Override
123        public Path findDocumentPath(Uri docUri) throws RemoteException {
124            final ContentResolver resolver = mContext.getContentResolver();
125            try (final ContentProviderClient client = DocumentsApplication
126                    .acquireUnstableProviderOrThrow(resolver, docUri.getAuthority())) {
127                return DocumentsContract.findDocumentPath(client, docUri);
128            }
129        }
130
131        @Override
132        public Uri createDocument(DocumentInfo parentDoc, String mimeType, String displayName) {
133            final ContentResolver resolver = mContext.getContentResolver();
134            try (ContentProviderClient client = DocumentsApplication.acquireUnstableProviderOrThrow(
135                        resolver, parentDoc.derivedUri.getAuthority())) {
136                return DocumentsContract.createDocument(
137                        client, parentDoc.derivedUri, mimeType, displayName);
138            } catch (Exception e) {
139                Log.w(TAG, "Failed to create document", e);
140                return null;
141            }
142        }
143    }
144}
145