DropBoxManager entries are not sent anywhere directly, but other system * services and debugging tools may scan and upload entries for processing. */ @SystemService(Context.DROPBOX_SERVICE) public class DropBoxManager { private static final String TAG = "DropBoxManager"; private final Context mContext; @UnsupportedAppUsage private final IDropBoxManagerService mService; /** @hide */ @IntDef(flag = true, prefix = { "IS_" }, value = { IS_EMPTY, IS_TEXT, IS_GZIPPED }) @Retention(RetentionPolicy.SOURCE) public @interface Flags {} /** Flag value: Entry's content was deleted to save space. */ public static final int IS_EMPTY = 1; /** Flag value: Content is human-readable UTF-8 text (can be combined with IS_GZIPPED). */ public static final int IS_TEXT = 2; /** Flag value: Content can be decompressed with java.util.zip.GZIPOutputStream. */ public static final int IS_GZIPPED = 4; /** Flag value for serialization only: Value is a byte array, not a file descriptor */ private static final int HAS_BYTE_ARRAY = 8; /** * Broadcast Action: This is broadcast when a new entry is added in the dropbox. * For apps targeting 35 and later, For apps targeting Android versions lower * than 35, you must hold * {@link android.Manifest.permission#READ_LOGS}. * This broadcast can be rate limited for low priority entries * *
This is a protected intent that can only be sent
* by the system.
*/
@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
public static final String ACTION_DROPBOX_ENTRY_ADDED =
"android.intent.action.DROPBOX_ENTRY_ADDED";
/**
* Extra for {@link android.os.DropBoxManager#ACTION_DROPBOX_ENTRY_ADDED}:
* string containing the dropbox tag.
*/
public static final String EXTRA_TAG = "tag";
/**
* Extra for {@link android.os.DropBoxManager#ACTION_DROPBOX_ENTRY_ADDED}:
* long integer value containing time (in milliseconds since January 1, 1970 00:00:00 UTC)
* when the entry was created.
*/
public static final String EXTRA_TIME = "time";
/**
* Extra for {@link android.os.DropBoxManager#ACTION_DROPBOX_ENTRY_ADDED}:
* integer value containing number of broadcasts dropped due to rate limiting on
* this {@link android.os.DropBoxManager#EXTRA_TAG}
*/
public static final String EXTRA_DROPPED_COUNT = "android.os.extra.DROPPED_COUNT";
/**
* A single entry retrieved from the drop box.
* This may include a reference to a stream, so you must call
* {@link #close()} when you are done using it.
*/
public static class Entry implements Parcelable, Closeable {
private final @NonNull String mTag;
private final @CurrentTimeMillisLong long mTimeMillis;
private final @Nullable byte[] mData;
private final @Nullable ParcelFileDescriptor mFileDescriptor;
private final @Flags int mFlags;
/** Create a new empty Entry with no contents. */
public Entry(@NonNull String tag, @CurrentTimeMillisLong long millis) {
if (tag == null) throw new NullPointerException("tag == null");
mTag = tag;
mTimeMillis = millis;
mData = null;
mFileDescriptor = null;
mFlags = IS_EMPTY;
}
/** Create a new Entry with plain text contents. */
public Entry(@NonNull String tag, @CurrentTimeMillisLong long millis,
@NonNull String text) {
if (tag == null) throw new NullPointerException("tag == null");
if (text == null) throw new NullPointerException("text == null");
mTag = tag;
mTimeMillis = millis;
mData = text.getBytes(StandardCharsets.UTF_8);
mFileDescriptor = null;
mFlags = IS_TEXT;
}
/**
* Create a new Entry with byte array contents.
* The data array must not be modified after creating this entry.
*/
public Entry(@NonNull String tag, @CurrentTimeMillisLong long millis,
@Nullable byte[] data, @Flags int flags) {
if (tag == null) throw new NullPointerException("tag == null");
if (((flags & IS_EMPTY) != 0) != (data == null)) {
throw new IllegalArgumentException("Bad flags: " + flags);
}
mTag = tag;
mTimeMillis = millis;
mData = data;
mFileDescriptor = null;
mFlags = flags;
}
/**
* Create a new Entry with streaming data contents.
* Takes ownership of the ParcelFileDescriptor.
*/
public Entry(@NonNull String tag, @CurrentTimeMillisLong long millis,
@Nullable ParcelFileDescriptor data, @Flags int flags) {
if (tag == null) throw new NullPointerException("tag == null");
if (((flags & IS_EMPTY) != 0) != (data == null)) {
throw new IllegalArgumentException("Bad flags: " + flags);
}
mTag = tag;
mTimeMillis = millis;
mData = null;
mFileDescriptor = data;
mFlags = flags;
}
/**
* Create a new Entry with the contents read from a file.
* The file will be read when the entry's contents are requested.
*/
public Entry(@NonNull String tag, @CurrentTimeMillisLong long millis,
@NonNull File data, @Flags int flags) throws IOException {
if (tag == null) throw new NullPointerException("tag == null");
if ((flags & IS_EMPTY) != 0) throw new IllegalArgumentException("Bad flags: " + flags);
mTag = tag;
mTimeMillis = millis;
mData = null;
mFileDescriptor = ParcelFileDescriptor.open(data, ParcelFileDescriptor.MODE_READ_ONLY);
mFlags = flags;
}
/** Close the input stream associated with this entry. */
public void close() {
try { if (mFileDescriptor != null) mFileDescriptor.close(); } catch (IOException e) { }
}
/** @return the tag originally attached to the entry. */
public @NonNull String getTag() {
return mTag;
}
/** @return time when the entry was originally created. */
public @CurrentTimeMillisLong long getTimeMillis() {
return mTimeMillis;
}
/** @return flags describing the content returned by {@link #getInputStream()}. */
public @Flags int getFlags() {
// getInputStream() decompresses.
return mFlags & ~IS_GZIPPED;
}
/**
* @param maxBytes of string to return (will truncate at this length).
* @return the uncompressed text contents of the entry, null if the entry is not text.
*/
public @Nullable String getText(@BytesLong int maxBytes) {
if ((mFlags & IS_TEXT) == 0) return null;
if (mData != null) return new String(mData, 0, Math.min(maxBytes, mData.length));
InputStream is = null;
try {
is = getInputStream();
if (is == null) return null;
byte[] buf = new byte[maxBytes];
int readBytes = 0;
int n = 0;
while (n >= 0 && (readBytes += n) < maxBytes) {
n = is.read(buf, readBytes, maxBytes - readBytes);
}
return new String(buf, 0, readBytes);
} catch (IOException e) {
return null;
} finally {
try { if (is != null) is.close(); } catch (IOException e) {}
}
}
/** @return the uncompressed contents of the entry, or null if the contents were lost */
public @Nullable InputStream getInputStream() throws IOException {
InputStream is;
if (mData != null) {
is = new ByteArrayInputStream(mData);
} else if (mFileDescriptor != null) {
is = new ParcelFileDescriptor.AutoCloseInputStream(mFileDescriptor);
} else {
return null;
}
return (mFlags & IS_GZIPPED) != 0
? new GZIPInputStream(new BufferedInputStream(is)) : is;
}
public static final @android.annotation.NonNull Parcelable.Creator