From ce1d0e94593eed9f838ff2a01e45aca5576ea7fe Mon Sep 17 00:00:00 2001 From: Garfield Tan Date: Thu, 23 Mar 2017 10:52:48 -0700 Subject: [PATCH] Add flags for quick viewer to indicate capabilities of a document. Replace the QUICK_VIEW_ADVANCED extra. Also restrict quick viewers not to send file content out of the device. Test: It builds. Bug: 36484539 Bug: 36755024 Change-Id: I921230eac6e497a615624202c741ef03432b2690 --- api/current.txt | 10 ++- api/removed.txt | 4 ++ api/system-current.txt | 10 ++- api/system-removed.txt | 4 ++ api/test-current.txt | 10 ++- api/test-removed.txt | 4 ++ core/java/android/content/Intent.java | 42 +++++++++--- .../android/content/QuickViewConstants.java | 68 +++++++++++++++++++ 8 files changed, 140 insertions(+), 12 deletions(-) create mode 100644 core/java/android/content/QuickViewConstants.java diff --git a/api/current.txt b/api/current.txt index 6234168a3a998..2d81b2dfa7a08 100644 --- a/api/current.txt +++ b/api/current.txt @@ -9464,7 +9464,7 @@ package android.content { field public static final java.lang.String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER"; field public static final java.lang.String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT"; field public static final java.lang.String EXTRA_PROCESS_TEXT_READONLY = "android.intent.extra.PROCESS_TEXT_READONLY"; - field public static final java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + field public static final java.lang.String EXTRA_QUICK_VIEW_FEATURES = "android.intent.extra.QUICK_VIEW_FEATURES"; field public static final java.lang.String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE"; field public static final java.lang.String EXTRA_REFERRER = "android.intent.extra.REFERRER"; field public static final java.lang.String EXTRA_REFERRER_NAME = "android.intent.extra.REFERRER_NAME"; @@ -9730,6 +9730,14 @@ package android.content { field public final long period; } + public class QuickViewConstants { + field public static final java.lang.String FEATURE_DOWNLOAD = "android:download"; + field public static final java.lang.String FEATURE_EDIT = "android:edit"; + field public static final java.lang.String FEATURE_PRINT = "android:print"; + field public static final java.lang.String FEATURE_SEND = "android:send"; + field public static final java.lang.String FEATURE_VIEW = "android:view"; + } + public class ReceiverCallNotAllowedException extends android.util.AndroidRuntimeException { ctor public ReceiverCallNotAllowedException(java.lang.String); } diff --git a/api/removed.txt b/api/removed.txt index 75da976d1b649..1c51ba50c55d7 100644 --- a/api/removed.txt +++ b/api/removed.txt @@ -33,6 +33,10 @@ package android.content { method public abstract java.io.File getSharedPreferencesPath(java.lang.String); } + public class Intent implements java.lang.Cloneable android.os.Parcelable { + field public static final deprecated java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + } + } package android.content.pm { diff --git a/api/system-current.txt b/api/system-current.txt index 6a6b279d8f326..0196018071a55 100644 --- a/api/system-current.txt +++ b/api/system-current.txt @@ -9988,7 +9988,7 @@ package android.content { field public static final java.lang.String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER"; field public static final java.lang.String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT"; field public static final java.lang.String EXTRA_PROCESS_TEXT_READONLY = "android.intent.extra.PROCESS_TEXT_READONLY"; - field public static final java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + field public static final java.lang.String EXTRA_QUICK_VIEW_FEATURES = "android.intent.extra.QUICK_VIEW_FEATURES"; field public static final java.lang.String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE"; field public static final java.lang.String EXTRA_REFERRER = "android.intent.extra.REFERRER"; field public static final java.lang.String EXTRA_REFERRER_NAME = "android.intent.extra.REFERRER_NAME"; @@ -10259,6 +10259,14 @@ package android.content { field public final long period; } + public class QuickViewConstants { + field public static final java.lang.String FEATURE_DOWNLOAD = "android:download"; + field public static final java.lang.String FEATURE_EDIT = "android:edit"; + field public static final java.lang.String FEATURE_PRINT = "android:print"; + field public static final java.lang.String FEATURE_SEND = "android:send"; + field public static final java.lang.String FEATURE_VIEW = "android:view"; + } + public class ReceiverCallNotAllowedException extends android.util.AndroidRuntimeException { ctor public ReceiverCallNotAllowedException(java.lang.String); } diff --git a/api/system-removed.txt b/api/system-removed.txt index 3aa93982fc94f..6813ee9797fcd 100644 --- a/api/system-removed.txt +++ b/api/system-removed.txt @@ -31,6 +31,10 @@ package android.content { method public abstract java.io.File getSharedPreferencesPath(java.lang.String); } + public class Intent implements java.lang.Cloneable android.os.Parcelable { + field public static final deprecated java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + } + } package android.content.pm { diff --git a/api/test-current.txt b/api/test-current.txt index 1f342e6b94099..c4f507eeed75c 100644 --- a/api/test-current.txt +++ b/api/test-current.txt @@ -9497,7 +9497,7 @@ package android.content { field public static final java.lang.String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER"; field public static final java.lang.String EXTRA_PROCESS_TEXT = "android.intent.extra.PROCESS_TEXT"; field public static final java.lang.String EXTRA_PROCESS_TEXT_READONLY = "android.intent.extra.PROCESS_TEXT_READONLY"; - field public static final java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + field public static final java.lang.String EXTRA_QUICK_VIEW_FEATURES = "android.intent.extra.QUICK_VIEW_FEATURES"; field public static final java.lang.String EXTRA_QUIET_MODE = "android.intent.extra.QUIET_MODE"; field public static final java.lang.String EXTRA_REFERRER = "android.intent.extra.REFERRER"; field public static final java.lang.String EXTRA_REFERRER_NAME = "android.intent.extra.REFERRER_NAME"; @@ -9763,6 +9763,14 @@ package android.content { field public final long period; } + public class QuickViewConstants { + field public static final java.lang.String FEATURE_DOWNLOAD = "android:download"; + field public static final java.lang.String FEATURE_EDIT = "android:edit"; + field public static final java.lang.String FEATURE_PRINT = "android:print"; + field public static final java.lang.String FEATURE_SEND = "android:send"; + field public static final java.lang.String FEATURE_VIEW = "android:view"; + } + public class ReceiverCallNotAllowedException extends android.util.AndroidRuntimeException { ctor public ReceiverCallNotAllowedException(java.lang.String); } diff --git a/api/test-removed.txt b/api/test-removed.txt index 75da976d1b649..1c51ba50c55d7 100644 --- a/api/test-removed.txt +++ b/api/test-removed.txt @@ -33,6 +33,10 @@ package android.content { method public abstract java.io.File getSharedPreferencesPath(java.lang.String); } + public class Intent implements java.lang.Cloneable android.os.Parcelable { + field public static final deprecated java.lang.String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + } + } package android.content.pm { diff --git a/core/java/android/content/Intent.java b/core/java/android/content/Intent.java index 7890a96079324..e4c5d1dcc3b32 100644 --- a/core/java/android/content/Intent.java +++ b/core/java/android/content/Intent.java @@ -668,19 +668,17 @@ public class Intent implements Parcelable, Cloneable { * a URI or a list of URIs. *

Activities handling this intent action should handle the vast majority of * MIME types rather than only specific ones. + *

Quick viewers must render the quick view image locally, and must not send + * file content outside current device. *

Input: {@link #getData} is a mandatory content URI of the item to * preview. {@link #getClipData} contains an optional list of content URIs * if there is more than one item to preview. {@link #EXTRA_INDEX} is an * optional index of the URI in the clip data to show first. - *

By default quick viewers are supposed to be lightweight and focus on - * previewing the content only. They should not expose features such as printing, - * opening in an external app, deleting, rotating, casting, etc. - * However, if {@link #EXTRA_QUICK_VIEW_ADVANCED} is true, then the quick viewer - * may show advanced UI which includes convenience actions suitable for the passed - * Uris. + * {@link #EXTRA_QUICK_VIEW_FEATURES} is an optional extra indicating the features + * that can be shown in the quick view UI. *

Output: nothing. - * @see #EXTRA_QUICK_VIEW_ADVANCED * @see #EXTRA_INDEX + * @see #EXTRA_QUICK_VIEW_FEATURES */ @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_QUICK_VIEW = "android.intent.action.QUICK_VIEW"; @@ -4488,7 +4486,7 @@ public class Intent implements Parcelable, Cloneable { * Optional index with semantics depending on the intent action. * *

The value must be an integer greater or equal to 0. - * @see ACTION_QUICK_VIEW + * @see #ACTION_QUICK_VIEW */ public static final String EXTRA_INDEX = "android.intent.extra.INDEX"; @@ -4498,11 +4496,37 @@ public class Intent implements Parcelable, Cloneable { * casting, etc. * *

The value is boolean. By default false. - * @see ACTION_QUICK_VIEW + * @see #ACTION_QUICK_VIEW + * @removed */ + @Deprecated public static final String EXTRA_QUICK_VIEW_ADVANCED = "android.intent.extra.QUICK_VIEW_ADVANCED"; + /** + * An optional extra of {@code String[]} indicating which quick view features should be made + * available to the user in the quick view UI while handing a + * {@link Intent#ACTION_QUICK_VIEW} intent. + *

  • Enumeration of features here is not meant to restrict capabilities of the quick viewer. + * Quick viewer can implement features not listed below. + *
  • Features included at this time are: {@link QuickViewConstants#FEATURE_VIEW}, + * {@link QuickViewConstants#FEATURE_EDIT}, {@link QuickViewConstants#FEATURE_DOWNLOAD}, + * {@link QuickViewConstants#FEATURE_SEND}, {@link QuickViewConstants#FEATURE_PRINT}. + *

    + * Requirements: + *

  • Quick viewer shouldn't show a feature if the feature is absent in + * {@link #EXTRA_QUICK_VIEW_FEATURES}. + *
  • When {@link #EXTRA_QUICK_VIEW_FEATURES} is not present, quick viewer should follow + * internal policies. + *
  • Presence of an feature in {@link #EXTRA_QUICK_VIEW_FEATURES}, does not constitute a + * requirement that the feature be shown. Quick viewer may, according to its own policies, + * disable or hide features. + * + * @see #ACTION_QUICK_VIEW + */ + public static final String EXTRA_QUICK_VIEW_FEATURES = + "android.intent.extra.QUICK_VIEW_FEATURES"; + /** * Optional boolean extra indicating whether quiet mode has been switched on or off. * When a profile goes into quiet mode, all apps in the profile are killed and the diff --git a/core/java/android/content/QuickViewConstants.java b/core/java/android/content/QuickViewConstants.java new file mode 100644 index 0000000000000..7455d0cb09446 --- /dev/null +++ b/core/java/android/content/QuickViewConstants.java @@ -0,0 +1,68 @@ +/* + * 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 android.content; + +/** + * Constants for {@link Intent#ACTION_QUICK_VIEW}. + */ +public class QuickViewConstants { + + private QuickViewConstants() {} + + /** + * Feature to view a document using system standard viewing mechanism, like + * {@link Intent#ACTION_VIEW}. + * + * @see Intent#EXTRA_QUICK_VIEW_FEATURES + * @see Intent#ACTION_QUICK_VIEW + */ + public static final String FEATURE_VIEW = "android:view"; + + /** + * Feature to view a document using system standard editing mechanism, like + * {@link Intent#ACTION_EDIT}. + * + * @see Intent#EXTRA_QUICK_VIEW_FEATURES + * @see Intent#ACTION_QUICK_VIEW + */ + public static final String FEATURE_EDIT = "android:edit"; + + /** + * Feature to view a document using system standard sending mechanism, like + * {@link Intent#ACTION_SEND}. + * + * @see Intent#EXTRA_QUICK_VIEW_FEATURES + * @see Intent#ACTION_QUICK_VIEW + */ + public static final String FEATURE_SEND = "android:send"; + + /** + * Feature to download a document to the local file system. + * + * @see Intent#EXTRA_QUICK_VIEW_FEATURES + * @see Intent#ACTION_QUICK_VIEW + */ + public static final String FEATURE_DOWNLOAD = "android:download"; + + /** + * Feature to print a document. + * + * @see Intent#EXTRA_QUICK_VIEW_FEATURES + * @see Intent#ACTION_QUICK_VIEW + */ + public static final String FEATURE_PRINT = "android:print"; +}