src/com/android/documentsui/archives/ReadableArchive.java - platform/packages/apps/DocumentsUI - Gitiles

 /*
  * Copyright (C) 2017 The Android Open Source Project
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *      http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */

 package com.android.documentsui.archives;

 import static android.os.ParcelFileDescriptor.MODE_READ_ONLY;

 import android.content.Context;
 import android.content.res.AssetFileDescriptor;
 import android.graphics.Point;
 import android.media.ExifInterface;
 import android.net.Uri;
 import android.os.Bundle;
 import android.os.CancellationSignal;
 import android.os.FileUtils;
 import android.os.ParcelFileDescriptor;
 import android.os.storage.StorageManager;
 import android.provider.DocumentsContract;
 import android.util.Log;

 import androidx.annotation.Nullable;
 import androidx.core.util.Preconditions;

 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileNotFoundException;
 import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.channels.FileChannel;
 import java.nio.channels.SeekableByteChannel;
 import java.util.ArrayList;
 import java.util.Enumeration;
 import java.util.List;
 import java.util.Stack;

 import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
 import org.apache.commons.compress.archivers.zip.ZipFile;
 import org.apache.commons.compress.utils.IOUtils;

 /**
  * Provides basic implementation for extracting and accessing
  * files within archives exposed by a document provider.
  *
  * <p>This class is thread safe.
  */
 public class ReadableArchive extends Archive {
     private static final String TAG = "ReadableArchive";

     private final StorageManager mStorageManager;
     private final ZipFile mZipFile;
     private final ParcelFileDescriptor mParcelFileDescriptor;

     private ReadableArchive(
             Context context,
             @Nullable ParcelFileDescriptor parcelFileDescriptor,
             Uri archiveUri,
             int accessMode,
             @Nullable Uri notificationUri)
             throws IOException {
         super(context, archiveUri, accessMode, notificationUri);
         if (!supportsAccessMode(accessMode)) {
             throw new IllegalStateException("Unsupported access mode.");
         }

         mStorageManager = mContext.getSystemService(StorageManager.class);

         if (parcelFileDescriptor == null || parcelFileDescriptor.getFileDescriptor() == null) {
             throw new IllegalArgumentException("File descriptor is invalid");
         }
         mParcelFileDescriptor = parcelFileDescriptor;
         mZipFile = openArchive(parcelFileDescriptor);

         ZipArchiveEntry entry;
         String entryPath;
         final Enumeration<ZipArchiveEntry> it = mZipFile.getEntries();
         final Stack<ZipArchiveEntry> stack = new Stack<>();
         while (it.hasMoreElements()) {
             entry = it.nextElement();
             if (entry.isDirectory() != entry.getName().endsWith("/")) {
                 throw new IOException(
                         "Directories must have a trailing slash, and files must not.");
             }
             entryPath = getEntryPath(entry);
             if (mEntries.containsKey(entryPath)) {
                 throw new IOException("Multiple entries with the same name are not supported.");
             }
             mEntries.put(entryPath, entry);
             if (entry.isDirectory()) {
                 mTree.put(entryPath, new ArrayList<ZipArchiveEntry>());
             }
             if (!"/".equals(entryPath)) { // Skip root, as it doesn't have a parent.
                 stack.push(entry);
             }
         }

         int delimiterIndex;
         String parentPath;
         ZipArchiveEntry parentEntry;
         List<ZipArchiveEntry> parentList;

         // Go through all directories recursively and build a tree structure.
         while (stack.size() > 0) {
             entry = stack.pop();

             entryPath = getEntryPath(entry);
             delimiterIndex = entryPath.lastIndexOf('/', entry.isDirectory()
                     ? entryPath.length() - 2 : entryPath.length() - 1);
             parentPath = entryPath.substring(0, delimiterIndex) + "/";

             parentList = mTree.get(parentPath);

             if (parentList == null) {
                 // The ZIP file doesn't contain all directories leading to the entry.
                 // It's rare, but can happen in a valid ZIP archive. In such case create a
                 // fake ZipEntry and add it on top of the stack to process it next.
                 parentEntry = new ZipArchiveEntry(parentPath);
                 parentEntry.setSize(0);
                 parentEntry.setTime(entry.getTime());
                 mEntries.put(parentPath, parentEntry);

                 if (!"/".equals(parentPath)) {
                     stack.push(parentEntry);
                 }

                 parentList = new ArrayList<>();
                 mTree.put(parentPath, parentList);
             }

             parentList.add(entry);
         }
     }

     /**
      * To check the access mode is readable.
      *
      * @see ParcelFileDescriptor
      */
     public static boolean supportsAccessMode(int accessMode) {
         return accessMode == MODE_READ_ONLY;
     }

     /**
      * Creates a DocumentsArchive instance for opening, browsing and accessing
      * documents within the archive passed as a file descriptor.
      * <p>
      * If the file descriptor is not seekable, then a snapshot will be created.
      * </p><p>
      * This method takes ownership for the passed descriptor. The caller must
      * not use it after passing.
      * </p>
      * @param context Context of the provider.
      * @param descriptor File descriptor for the archive's contents.
      * @param archiveUri Uri of the archive document.
      * @param accessMode Access mode for the archive {@see ParcelFileDescriptor}.
      * @param notificationUri notificationUri Uri for notifying that the archive file has changed.
      */
     public static ReadableArchive createForParcelFileDescriptor(
             Context context, ParcelFileDescriptor descriptor, Uri archiveUri, int accessMode,
             @Nullable Uri notificationUri)
             throws IOException {
         if (canSeek(descriptor)) {
             return new ReadableArchive(context, descriptor, archiveUri, accessMode,
                     notificationUri);
         }

         try {
             // Fallback for non-seekable file descriptors.
             File snapshotFile = null;
             try {
                 // Create a copy of the archive, as ZipFile doesn't operate on streams.
                 // Moreover, ZipInputStream would be inefficient for large files on
                 // pipes.
                 snapshotFile = File.createTempFile("com.android.documentsui.snapshot{",
                         "}.zip", context.getCacheDir());

                 try (
                     final FileOutputStream outputStream =
                             new ParcelFileDescriptor.AutoCloseOutputStream(
                                     ParcelFileDescriptor.open(
                                             snapshotFile, ParcelFileDescriptor.MODE_WRITE_ONLY));
                     final ParcelFileDescriptor.AutoCloseInputStream inputStream =
                             new ParcelFileDescriptor.AutoCloseInputStream(descriptor);
                 ) {
                     final byte[] buffer = new byte[32 * 1024];
                     int bytes;
                     while ((bytes = inputStream.read(buffer)) != -1) {
                         outputStream.write(buffer, 0, bytes);
                     }
                     outputStream.flush();
                 }

                 ParcelFileDescriptor snapshotPfd = ParcelFileDescriptor.open(
                         snapshotFile, MODE_READ_ONLY);

                 return new ReadableArchive(context, snapshotPfd, archiveUri, accessMode,
                         notificationUri);
             } finally {
                 // On UNIX the file will be still available for processes which opened it, even
                 // after deleting it. Remove it ASAP, as it won't be used by anyone else.
                 if (snapshotFile != null) {
                     snapshotFile.delete();
                 }
             }
         } catch (Exception e) {
             // Since the method takes ownership of the passed descriptor, close it
             // on exception.
             FileUtils.closeQuietly(descriptor);
             throw e;
         }
     }

     @Override
     public ParcelFileDescriptor openDocument(
             String documentId, String mode, @Nullable final CancellationSignal signal)
             throws FileNotFoundException {
         MorePreconditions.checkArgumentEquals("r", mode,
                 "Invalid mode. Only reading \"r\" supported, but got: \"%s\".");
         final ArchiveId parsedId = ArchiveId.fromDocumentId(documentId);
         MorePreconditions.checkArgumentEquals(mArchiveUri, parsedId.mArchiveUri,
                 "Mismatching archive Uri. Expected: %s, actual: %s.");

         final ZipArchiveEntry entry = mEntries.get(parsedId.mPath);
         if (entry == null) {
             throw new FileNotFoundException();
         }

         try {
             return mStorageManager.openProxyFileDescriptor(
                     MODE_READ_ONLY, new Proxy(mZipFile, entry));
         } catch (IOException e) {
             throw new IllegalStateException(e);
         }
     }

     @Override
     public AssetFileDescriptor openDocumentThumbnail(
             String documentId, Point sizeHint, final CancellationSignal signal)
             throws FileNotFoundException {
         final ArchiveId parsedId = ArchiveId.fromDocumentId(documentId);
         MorePreconditions.checkArgumentEquals(mArchiveUri, parsedId.mArchiveUri,
                 "Mismatching archive Uri. Expected: %s, actual: %s.");
         Preconditions.checkArgument(getDocumentType(documentId).startsWith("image/"),
                 "Thumbnails only supported for image/* MIME type.");

         final ZipArchiveEntry entry = mEntries.get(parsedId.mPath);
         if (entry == null) {
             throw new FileNotFoundException();
         }

         InputStream inputStream = null;
         try {
             inputStream = mZipFile.getInputStream(entry);
             final ExifInterface exif = new ExifInterface(inputStream);
             if (exif.hasThumbnail()) {
                 Bundle extras = null;
                 switch (exif.getAttributeInt(ExifInterface.TAG_ORIENTATION, -1)) {
                     case ExifInterface.ORIENTATION_ROTATE_90:
                         extras = new Bundle(1);
                         extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 90);
                         break;
                     case ExifInterface.ORIENTATION_ROTATE_180:
                         extras = new Bundle(1);
                         extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 180);
                         break;
                     case ExifInterface.ORIENTATION_ROTATE_270:
                         extras = new Bundle(1);
                         extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 270);
                         break;
                 }
                 final long[] range = exif.getThumbnailRange();
                 return new AssetFileDescriptor(
                         openDocument(documentId, "r", signal), range[0], range[1], extras);
             }
         } catch (IOException e) {
             // Ignore the exception, as reading the EXIF may legally fail.
             Log.e(TAG, "Failed to obtain thumbnail from EXIF.", e);
         } finally {
             FileUtils.closeQuietly(inputStream);
         }

         return new AssetFileDescriptor(
                 openDocument(documentId, "r", signal), 0, entry.getSize(), null);
     }

     /**
      * Closes an archive.
      *
      * <p>This method does not block until shutdown. Once called, other methods should not be
      * called. Any active pipes will be terminated.
      */
     @Override
     public void close() {
         try {
             mZipFile.close();
         } catch (IOException e) {
             // Silent close.
         } finally {
             /**
              * For creating FileInputStream by using FileDescriptor, the file descriptor will not
              * be closed after FileInputStream closed.
              */
             IOUtils.closeQuietly(mParcelFileDescriptor);
         }
     }

     private static ZipFile openArchive(ParcelFileDescriptor parcelFileDescriptor)
             throws IOException {
         // TODO: To support multiple archive type

         /**
          * ZipFile keep the FileChannel instance as member field archive. FileChannel doesn't be
          * closed until ZipFile.close(). FileChannel.close() invoke
          * AbstractInterruptibleChannel.close() and then FileChannelImpl.implCloseChannel() is
          * called. FileChannelImpl.implCloseChannel() will close the member field parent that is
          * FileInputStream and is assigned in FileInputStream.getChannel().
          * So, to close ZipFile is to close FileInputStream but not file descriptor.
          */
         FileChannel fileChannel = new FileInputStream(parcelFileDescriptor.getFileDescriptor())
                 .getChannel();
         try {
             return new ZipFile((SeekableByteChannel)fileChannel);
         } catch (IOException e) {
             IOUtils.closeQuietly(fileChannel);
             IOUtils.closeQuietly(parcelFileDescriptor);
             throw e;
         }
     }
 }
	/*
	* Copyright (C) 2017 The Android Open Source Project
	*
	* Licensed under the Apache License, Version 2.0 (the "License");
	* you may not use this file except in compliance with the License.
	* You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*/

	package com.android.documentsui.archives;

	import static android.os.ParcelFileDescriptor.MODE_READ_ONLY;

	import android.content.Context;
	import android.content.res.AssetFileDescriptor;
	import android.graphics.Point;
	import android.media.ExifInterface;
	import android.net.Uri;
	import android.os.Bundle;
	import android.os.CancellationSignal;
	import android.os.FileUtils;
	import android.os.ParcelFileDescriptor;
	import android.os.storage.StorageManager;
	import android.provider.DocumentsContract;
	import android.util.Log;

	import androidx.annotation.Nullable;
	import androidx.core.util.Preconditions;

	import java.io.File;
	import java.io.FileInputStream;
	import java.io.FileNotFoundException;
	import java.io.FileOutputStream;
	import java.io.IOException;
	import java.io.InputStream;
	import java.nio.channels.FileChannel;
	import java.nio.channels.SeekableByteChannel;
	import java.util.ArrayList;
	import java.util.Enumeration;
	import java.util.List;
	import java.util.Stack;

	import org.apache.commons.compress.archivers.zip.ZipArchiveEntry;
	import org.apache.commons.compress.archivers.zip.ZipFile;
	import org.apache.commons.compress.utils.IOUtils;

	/**
	* Provides basic implementation for extracting and accessing
	* files within archives exposed by a document provider.
	*
	* <p>This class is thread safe.
	*/
	public class ReadableArchive extends Archive {
	private static final String TAG = "ReadableArchive";

	private final StorageManager mStorageManager;
	private final ZipFile mZipFile;
	private final ParcelFileDescriptor mParcelFileDescriptor;

	private ReadableArchive(
	Context context,
	@Nullable ParcelFileDescriptor parcelFileDescriptor,
	Uri archiveUri,
	int accessMode,
	@Nullable Uri notificationUri)
	throws IOException {
	super(context, archiveUri, accessMode, notificationUri);
	if (!supportsAccessMode(accessMode)) {
	throw new IllegalStateException("Unsupported access mode.");
	}

	mStorageManager = mContext.getSystemService(StorageManager.class);

	if (parcelFileDescriptor == null \|\| parcelFileDescriptor.getFileDescriptor() == null) {
	throw new IllegalArgumentException("File descriptor is invalid");
	}
	mParcelFileDescriptor = parcelFileDescriptor;
	mZipFile = openArchive(parcelFileDescriptor);

	ZipArchiveEntry entry;
	String entryPath;
	final Enumeration<ZipArchiveEntry> it = mZipFile.getEntries();
	final Stack<ZipArchiveEntry> stack = new Stack<>();
	while (it.hasMoreElements()) {
	entry = it.nextElement();
	if (entry.isDirectory() != entry.getName().endsWith("/")) {
	throw new IOException(
	"Directories must have a trailing slash, and files must not.");
	}
	entryPath = getEntryPath(entry);
	if (mEntries.containsKey(entryPath)) {
	throw new IOException("Multiple entries with the same name are not supported.");
	}
	mEntries.put(entryPath, entry);
	if (entry.isDirectory()) {
	mTree.put(entryPath, new ArrayList<ZipArchiveEntry>());
	}
	if (!"/".equals(entryPath)) { // Skip root, as it doesn't have a parent.
	stack.push(entry);
	}
	}

	int delimiterIndex;
	String parentPath;
	ZipArchiveEntry parentEntry;
	List<ZipArchiveEntry> parentList;

	// Go through all directories recursively and build a tree structure.
	while (stack.size() > 0) {
	entry = stack.pop();

	entryPath = getEntryPath(entry);
	delimiterIndex = entryPath.lastIndexOf('/', entry.isDirectory()
	? entryPath.length() - 2 : entryPath.length() - 1);
	parentPath = entryPath.substring(0, delimiterIndex) + "/";

	parentList = mTree.get(parentPath);

	if (parentList == null) {
	// The ZIP file doesn't contain all directories leading to the entry.
	// It's rare, but can happen in a valid ZIP archive. In such case create a
	// fake ZipEntry and add it on top of the stack to process it next.
	parentEntry = new ZipArchiveEntry(parentPath);
	parentEntry.setSize(0);
	parentEntry.setTime(entry.getTime());
	mEntries.put(parentPath, parentEntry);

	if (!"/".equals(parentPath)) {
	stack.push(parentEntry);
	}

	parentList = new ArrayList<>();
	mTree.put(parentPath, parentList);
	}

	parentList.add(entry);
	}
	}

	/**
	* To check the access mode is readable.
	*
	* @see ParcelFileDescriptor
	*/
	public static boolean supportsAccessMode(int accessMode) {
	return accessMode == MODE_READ_ONLY;
	}

	/**
	* Creates a DocumentsArchive instance for opening, browsing and accessing
	* documents within the archive passed as a file descriptor.
	* <p>
	* If the file descriptor is not seekable, then a snapshot will be created.
	* </p><p>
	* This method takes ownership for the passed descriptor. The caller must
	* not use it after passing.
	* </p>
	* @param context Context of the provider.
	* @param descriptor File descriptor for the archive's contents.
	* @param archiveUri Uri of the archive document.
	* @param accessMode Access mode for the archive {@see ParcelFileDescriptor}.
	* @param notificationUri notificationUri Uri for notifying that the archive file has changed.
	*/
	public static ReadableArchive createForParcelFileDescriptor(
	Context context, ParcelFileDescriptor descriptor, Uri archiveUri, int accessMode,
	@Nullable Uri notificationUri)
	throws IOException {
	if (canSeek(descriptor)) {
	return new ReadableArchive(context, descriptor, archiveUri, accessMode,
	notificationUri);
	}

	try {
	// Fallback for non-seekable file descriptors.
	File snapshotFile = null;
	try {
	// Create a copy of the archive, as ZipFile doesn't operate on streams.
	// Moreover, ZipInputStream would be inefficient for large files on
	// pipes.
	snapshotFile = File.createTempFile("com.android.documentsui.snapshot{",
	"}.zip", context.getCacheDir());

	try (
	final FileOutputStream outputStream =
	new ParcelFileDescriptor.AutoCloseOutputStream(
	ParcelFileDescriptor.open(
	snapshotFile, ParcelFileDescriptor.MODE_WRITE_ONLY));
	final ParcelFileDescriptor.AutoCloseInputStream inputStream =
	new ParcelFileDescriptor.AutoCloseInputStream(descriptor);
	) {
	final byte[] buffer = new byte[32 * 1024];
	int bytes;
	while ((bytes = inputStream.read(buffer)) != -1) {
	outputStream.write(buffer, 0, bytes);
	}
	outputStream.flush();
	}

	ParcelFileDescriptor snapshotPfd = ParcelFileDescriptor.open(
	snapshotFile, MODE_READ_ONLY);

	return new ReadableArchive(context, snapshotPfd, archiveUri, accessMode,
	notificationUri);
	} finally {
	// On UNIX the file will be still available for processes which opened it, even
	// after deleting it. Remove it ASAP, as it won't be used by anyone else.
	if (snapshotFile != null) {
	snapshotFile.delete();
	}
	}
	} catch (Exception e) {
	// Since the method takes ownership of the passed descriptor, close it
	// on exception.
	FileUtils.closeQuietly(descriptor);
	throw e;
	}
	}

	@Override
	public ParcelFileDescriptor openDocument(
	String documentId, String mode, @Nullable final CancellationSignal signal)
	throws FileNotFoundException {
	MorePreconditions.checkArgumentEquals("r", mode,
	"Invalid mode. Only reading \"r\" supported, but got: \"%s\".");
	final ArchiveId parsedId = ArchiveId.fromDocumentId(documentId);
	MorePreconditions.checkArgumentEquals(mArchiveUri, parsedId.mArchiveUri,
	"Mismatching archive Uri. Expected: %s, actual: %s.");

	final ZipArchiveEntry entry = mEntries.get(parsedId.mPath);
	if (entry == null) {
	throw new FileNotFoundException();
	}

	try {
	return mStorageManager.openProxyFileDescriptor(
	MODE_READ_ONLY, new Proxy(mZipFile, entry));
	} catch (IOException e) {
	throw new IllegalStateException(e);
	}
	}

	@Override
	public AssetFileDescriptor openDocumentThumbnail(
	String documentId, Point sizeHint, final CancellationSignal signal)
	throws FileNotFoundException {
	final ArchiveId parsedId = ArchiveId.fromDocumentId(documentId);
	MorePreconditions.checkArgumentEquals(mArchiveUri, parsedId.mArchiveUri,
	"Mismatching archive Uri. Expected: %s, actual: %s.");
	Preconditions.checkArgument(getDocumentType(documentId).startsWith("image/"),
	"Thumbnails only supported for image/* MIME type.");

	final ZipArchiveEntry entry = mEntries.get(parsedId.mPath);
	if (entry == null) {
	throw new FileNotFoundException();
	}

	InputStream inputStream = null;
	try {
	inputStream = mZipFile.getInputStream(entry);
	final ExifInterface exif = new ExifInterface(inputStream);
	if (exif.hasThumbnail()) {
	Bundle extras = null;
	switch (exif.getAttributeInt(ExifInterface.TAG_ORIENTATION, -1)) {
	case ExifInterface.ORIENTATION_ROTATE_90:
	extras = new Bundle(1);
	extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 90);
	break;
	case ExifInterface.ORIENTATION_ROTATE_180:
	extras = new Bundle(1);
	extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 180);
	break;
	case ExifInterface.ORIENTATION_ROTATE_270:
	extras = new Bundle(1);
	extras.putInt(DocumentsContract.EXTRA_ORIENTATION, 270);
	break;
	}
	final long[] range = exif.getThumbnailRange();
	return new AssetFileDescriptor(
	openDocument(documentId, "r", signal), range[0], range[1], extras);
	}
	} catch (IOException e) {
	// Ignore the exception, as reading the EXIF may legally fail.
	Log.e(TAG, "Failed to obtain thumbnail from EXIF.", e);
	} finally {
	FileUtils.closeQuietly(inputStream);
	}

	return new AssetFileDescriptor(
	openDocument(documentId, "r", signal), 0, entry.getSize(), null);
	}

	/**
	* Closes an archive.
	*
	* <p>This method does not block until shutdown. Once called, other methods should not be
	* called. Any active pipes will be terminated.
	*/
	@Override
	public void close() {
	try {
	mZipFile.close();
	} catch (IOException e) {
	// Silent close.
	} finally {
	/**
	* For creating FileInputStream by using FileDescriptor, the file descriptor will not
	* be closed after FileInputStream closed.
	*/
	IOUtils.closeQuietly(mParcelFileDescriptor);
	}
	}

	private static ZipFile openArchive(ParcelFileDescriptor parcelFileDescriptor)
	throws IOException {
	// TODO: To support multiple archive type

	/**
	* ZipFile keep the FileChannel instance as member field archive. FileChannel doesn't be
	* closed until ZipFile.close(). FileChannel.close() invoke
	* AbstractInterruptibleChannel.close() and then FileChannelImpl.implCloseChannel() is
	* called. FileChannelImpl.implCloseChannel() will close the member field parent that is
	* FileInputStream and is assigned in FileInputStream.getChannel().
	* So, to close ZipFile is to close FileInputStream but not file descriptor.
	*/
	FileChannel fileChannel = new FileInputStream(parcelFileDescriptor.getFileDescriptor())
	.getChannel();
	try {
	return new ZipFile((SeekableByteChannel)fileChannel);
	} catch (IOException e) {
	IOUtils.closeQuietly(fileChannel);
	IOUtils.closeQuietly(parcelFileDescriptor);
	throw e;
	}
	}
	}