DropBoxManager.java revision b247536aa3d458750edbc6b45b2348a994d83426
1952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor/* 2952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Copyright (C) 2009 The Android Open Source Project 3952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 4952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Licensed under the Apache License, Version 2.0 (the "License"); 5952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * you may not use this file except in compliance with the License. 6952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * You may obtain a copy of the License at 7952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 8952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * http://www.apache.org/licenses/LICENSE-2.0 9952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 10952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Unless required by applicable law or agreed to in writing, software 11952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * distributed under the License is distributed on an "AS IS" BASIS, 12952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * See the License for the specific language governing permissions and 14952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * limitations under the License. 15952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 16952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 17952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorpackage android.os; 18952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 19952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport android.util.Log; 20952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 21f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnorimport com.android.internal.os.IDropBoxManagerService; 22952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 23952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.io.ByteArrayInputStream; 24952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.io.File; 25952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.io.FileInputStream; 26952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.io.IOException; 27952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.io.InputStream; 28952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnorimport java.util.zip.GZIPInputStream; 29952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 30952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor/** 31952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Enqueues chunks of data (from various sources -- application crashes, kernel 32952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * log records, etc.). The queue is size bounded and will drop old data if the 33952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * enqueued data exceeds the maximum size. You can think of this as a 34952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * persistent, system-wide, blob-oriented "logcat". 35952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 36952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * <p>You can obtain an instance of this class by calling 37952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * {@link android.content.Context#getSystemService} 38952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * with {@link android.content.Context#DROPBOX_SERVICE}. 39952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 40f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor * <p>DropBoxManager entries are not sent anywhere directly, but other system 41f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor * services and debugging tools may scan and upload entries for processing. 42952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 43f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnorpublic class DropBoxManager { 44f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor private static final String TAG = "DropBoxManager"; 45f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor private final IDropBoxManagerService mService; 46952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 47952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Flag value: Entry's content was deleted to save space. */ 48952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public static final int IS_EMPTY = 1; 49952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 50952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Flag value: Content is human-readable UTF-8 text (can be combined with IS_GZIPPED). */ 51952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public static final int IS_TEXT = 2; 52952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 53e3cfe2d92868513c9524804a362c3c3c8b8cc4e5Dan Egnor /** Flag value: Content can be decompressed with {@link java.util.zip.GZIPOutputStream}. */ 54952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public static final int IS_GZIPPED = 4; 55952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 56952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 57b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * Broadcast Action: This is broadcast when a new entry is added in the dropbox. 58b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * You must hold the {@link android.Manifest.permission#READ_LOGS} permission 59b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * in order to receive this broadcast. 60b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * 61b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * <p class="note">This is a protected intent that can only be sent 62b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * by the system. 63b247536aa3d458750edbc6b45b2348a994d83426Hakan Still */ 64b247536aa3d458750edbc6b45b2348a994d83426Hakan Still public static final String ACTION_DROPBOX_ENTRY_ADDED = 65b247536aa3d458750edbc6b45b2348a994d83426Hakan Still "android.intent.action.DROPBOX_ENTRY_ADDED"; 66b247536aa3d458750edbc6b45b2348a994d83426Hakan Still 67b247536aa3d458750edbc6b45b2348a994d83426Hakan Still /** 68b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * Extra for {@link android.os.DropBoxManager#ACTION_DROPBOX_ENTRY_ADDED}: 69b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * string containing the dropbox tag. 70b247536aa3d458750edbc6b45b2348a994d83426Hakan Still */ 71b247536aa3d458750edbc6b45b2348a994d83426Hakan Still public static final String EXTRA_TAG = "tag"; 72b247536aa3d458750edbc6b45b2348a994d83426Hakan Still 73b247536aa3d458750edbc6b45b2348a994d83426Hakan Still /** 74b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * Extra for {@link android.os.DropBoxManager#ACTION_DROPBOX_ENTRY_ADDED}: 75b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * long integer value containing time (in milliseconds since January 1, 1970 00:00:00 UTC) 76b247536aa3d458750edbc6b45b2348a994d83426Hakan Still * when the entry was created. 77b247536aa3d458750edbc6b45b2348a994d83426Hakan Still */ 78b247536aa3d458750edbc6b45b2348a994d83426Hakan Still public static final String EXTRA_TIME = "time"; 79b247536aa3d458750edbc6b45b2348a994d83426Hakan Still 80b247536aa3d458750edbc6b45b2348a994d83426Hakan Still /** 81952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * A single entry retrieved from the drop box. 82952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * This may include a reference to a stream, so you must call 83952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * {@link #close()} when you are done using it. 84952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 85952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public static class Entry implements Parcelable { 86952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private final String mTag; 87952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private final long mTimeMillis; 88952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 89952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private final byte[] mData; 90952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private final ParcelFileDescriptor mFileDescriptor; 91952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private final int mFlags; 92952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 93952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Create a new empty Entry with no contents. */ 94952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry(String tag, long millis) { 95952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor this(tag, millis, (Object) null, IS_EMPTY); 96952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 97952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 98952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Create a new Entry with plain text contents. */ 99952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry(String tag, long millis, String text) { 100952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor this(tag, millis, (Object) text.getBytes(), IS_TEXT); 101952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 102952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 103952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 104952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Create a new Entry with byte array contents. 105952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * The data array must not be modified after creating this entry. 106952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 107952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry(String tag, long millis, byte[] data, int flags) { 108952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor this(tag, millis, (Object) data, flags); 109952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 110952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 111952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 112952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Create a new Entry with streaming data contents. 113952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Takes ownership of the ParcelFileDescriptor. 114952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 115952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry(String tag, long millis, ParcelFileDescriptor data, int flags) { 116952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor this(tag, millis, (Object) data, flags); 117952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 118952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 119952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 120952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Create a new Entry with the contents read from a file. 121952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * The file will be read when the entry's contents are requested. 122952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 123952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry(String tag, long millis, File data, int flags) throws IOException { 124952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor this(tag, millis, (Object) ParcelFileDescriptor.open( 125952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor data, ParcelFileDescriptor.MODE_READ_ONLY), flags); 126952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 127952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 128952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Internal constructor for CREATOR.createFromParcel(). */ 129952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor private Entry(String tag, long millis, Object value, int flags) { 130952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (tag == null) throw new NullPointerException(); 131952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (((flags & IS_EMPTY) != 0) != (value == null)) throw new IllegalArgumentException(); 132952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 133952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mTag = tag; 134952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mTimeMillis = millis; 135952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mFlags = flags; 136952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 137952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (value == null) { 138952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mData = null; 139952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mFileDescriptor = null; 140952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else if (value instanceof byte[]) { 141952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mData = (byte[]) value; 142952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mFileDescriptor = null; 143952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else if (value instanceof ParcelFileDescriptor) { 144952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mData = null; 145952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor mFileDescriptor = (ParcelFileDescriptor) value; 146952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else { 147952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor throw new IllegalArgumentException(); 148952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 149952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 150952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 151952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** Close the input stream associated with this entry. */ 152952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public void close() { 153952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { if (mFileDescriptor != null) mFileDescriptor.close(); } catch (IOException e) { } 154952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 155952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 156952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** @return the tag originally attached to the entry. */ 157952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public String getTag() { return mTag; } 158952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 159952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** @return time when the entry was originally created. */ 160952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public long getTimeMillis() { return mTimeMillis; } 161952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 162952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** @return flags describing the content returned by @{link #getInputStream()}. */ 163952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public int getFlags() { return mFlags & ~IS_GZIPPED; } // getInputStream() decompresses. 164952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 165952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 166952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param maxBytes of string to return (will truncate at this length). 167952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @return the uncompressed text contents of the entry, null if the entry is not text. 168952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 169952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public String getText(int maxBytes) { 170952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if ((mFlags & IS_TEXT) == 0) return null; 171952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (mData != null) return new String(mData, 0, Math.min(maxBytes, mData.length)); 172952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 173952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor InputStream is = null; 174952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { 175952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor is = getInputStream(); 176952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor byte[] buf = new byte[maxBytes]; 177e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg int readBytes = 0; 178e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg int n = 0; 179e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg while (n >= 0 && (readBytes += n) < maxBytes) { 180e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg n = is.read(buf, readBytes, maxBytes - readBytes); 181e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg } 182e9f18815218b2ff1f01ea16f2eb0dd17504a9cf3Christian Lindeberg return new String(buf, 0, readBytes); 183952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } catch (IOException e) { 184952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor return null; 185952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } finally { 186952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { if (is != null) is.close(); } catch (IOException e) {} 187952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 188952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 189952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 190952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** @return the uncompressed contents of the entry, or null if the contents were lost */ 191952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public InputStream getInputStream() throws IOException { 192952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor InputStream is; 193952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (mData != null) { 194952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor is = new ByteArrayInputStream(mData); 195952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else if (mFileDescriptor != null) { 196952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor is = new ParcelFileDescriptor.AutoCloseInputStream(mFileDescriptor); 197952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else { 198952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor return null; 199952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 200952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor return (mFlags & IS_GZIPPED) != 0 ? new GZIPInputStream(is) : is; 201952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 202952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 203952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public static final Parcelable.Creator<Entry> CREATOR = new Parcelable.Creator() { 204952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry[] newArray(int size) { return new Entry[size]; } 205952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry createFromParcel(Parcel in) { 206952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor return new Entry( 207952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor in.readString(), in.readLong(), in.readValue(null), in.readInt()); 208952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 209952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor }; 210952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 211952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public int describeContents() { 212952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor return mFileDescriptor != null ? Parcelable.CONTENTS_FILE_DESCRIPTOR : 0; 213952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 214952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 215952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public void writeToParcel(Parcel out, int flags) { 216952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor out.writeString(mTag); 217952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor out.writeLong(mTimeMillis); 218952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (mFileDescriptor != null) { 219952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor out.writeValue(mFileDescriptor); 220952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } else { 221952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor out.writeValue(mData); 222952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 223952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor out.writeInt(mFlags); 224952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 225952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 226952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 227952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** {@hide} */ 228f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor public DropBoxManager(IDropBoxManagerService service) { mService = service; } 229952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 230952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 231952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Create a dummy instance for testing. All methods will fail unless 232952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * overridden with an appropriate mock implementation. To obtain a 233952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * functional instance, use {@link android.content.Context#getSystemService}. 234952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 235f18a01c77e78209b74e34d05cfb352fa4a92db5fDan Egnor protected DropBoxManager() { mService = null; } 236952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 237952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 238952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Stores human-readable text. The data may be discarded eventually (or even 239952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * immediately) if space is limited, or ignored entirely if the tag has been 240952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * blocked (see {@link #isTagEnabled}). 241952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 242952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param tag describing the type of entry being stored 243952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param data value to store 244952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 245952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public void addText(String tag, String data) { 246952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { mService.add(new Entry(tag, 0, data)); } catch (RemoteException e) {} 247952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 248952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 249952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 250952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Stores binary data, which may be ignored or discarded as with {@link #addText}. 251952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 252952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param tag describing the type of entry being stored 253952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param data value to store 254952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param flags describing the data 255952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 256952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public void addData(String tag, byte[] data, int flags) { 257952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor if (data == null) throw new NullPointerException(); 258952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { mService.add(new Entry(tag, 0, data, flags)); } catch (RemoteException e) {} 259952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 260952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 261952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 262eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor * Stores the contents of a file, which may be ignored or discarded as with 263eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor * {@link #addText}. 264952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 265952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param tag describing the type of entry being stored 266eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor * @param file to read from 267952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param flags describing the data 268eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor * @throws IOException if the file can't be opened 269952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 270eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor public void addFile(String tag, File file, int flags) throws IOException { 271eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor if (file == null) throw new NullPointerException(); 272eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor Entry entry = new Entry(tag, 0, file, flags); 273eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor try { 274eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor mService.add(new Entry(tag, 0, file, flags)); 275eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor } catch (RemoteException e) { 276eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor // ignore 277eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor } finally { 278eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor entry.close(); 279eb7a7d57ca50f85b054edadab766b51ff22a2dfdDan Egnor } 280952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 281952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 282952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 283952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Checks any blacklists (set in system settings) to see whether a certain 284952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * tag is allowed. Entries with disabled tags will be dropped immediately, 285952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * so you can save the work of actually constructing and sending the data. 286952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 287952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param tag that would be used in {@link #addText} or {@link #addFile} 288952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @return whether events with that tag would be accepted 289952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 290952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public boolean isTagEnabled(String tag) { 291952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { return mService.isTagEnabled(tag); } catch (RemoteException e) { return false; } 292952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 293952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 294952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor /** 295952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Gets the next entry from the drop box *after* the specified time. 296952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * Requires android.permission.READ_LOGS. You must always call 297952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * {@link Entry#close()} on the return value! 298952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * 299952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param tag of entry to look for, null for all tags 300952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @param msec time of the last entry seen 301952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor * @return the next entry, or null if there are no more entries 302952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor */ 303952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor public Entry getNextEntry(String tag, long msec) { 304952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor try { return mService.getNextEntry(tag, msec); } catch (RemoteException e) { return null; } 305952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor } 306952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor 307952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor // TODO: It may be useful to have some sort of notification mechanism 308952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor // when data is added to the dropbox, for demand-driven readers -- 309952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor // for now readers need to poll the dropbox to find new data. 310952402704a175ba27f6c89dff1ada634c5ce5626Dan Egnor} 311