IME Logger improvement
- Eabled to handle an array value in the log entry
- Added word counter
- Added parameters to Log APIs
- Obfuscate user privacy support
Change-Id: I5e2a7d58113b0581e51d22d6dac9a6a6fdc34356
diff --git a/java/src/com/android/inputmethod/latin/LatinImeLogger.java b/java/src/com/android/inputmethod/latin/LatinImeLogger.java
index 4e769b3..a04e1cf 100644
--- a/java/src/com/android/inputmethod/latin/LatinImeLogger.java
+++ b/java/src/com/android/inputmethod/latin/LatinImeLogger.java
@@ -24,6 +24,7 @@
import android.util.Log;
import java.util.ArrayList;
+import java.util.Collections;
public class LatinImeLogger implements SharedPreferences.OnSharedPreferenceChangeListener {
private static final String TAG = "LatinIMELogs";
@@ -31,20 +32,23 @@
// DEFAULT_LOG_ENABLED should be false when released to public.
private static final boolean DEFAULT_LOG_ENABLED = true;
- private static final long MINIMUMSENDINTERVAL = 1 * DateUtils.MINUTE_IN_MILLIS; // 1 min
+ private static final long MINIMUMSENDINTERVAL = 60 * DateUtils.SECOND_IN_MILLIS; // 60 sec
private static final long MINIMUMCOUNTINTERVAL = 20 * DateUtils.SECOND_IN_MILLIS; // 20 sec
private static final char SEPARATER = ';';
private static final int ID_CLICKSUGGESTION = 0;
private static final int ID_AUTOSUGGESTION = 1;
private static final int ID_AUTOSUGGESTIONCANCELED = 2;
- private static final int ID_INPUT = 3;
- private static final int ID_DELETE = 4;
+ private static final int ID_INPUT_COUNT = 3;
+ private static final int ID_DELETE_COUNT = 4;
+ private static final int ID_WORD_COUNT = 5;
+
private static final String PREF_ENABLE_LOG = "enable_log";
private static LatinImeLogger sLatinImeLogger = new LatinImeLogger();
public static boolean sLogEnabled = true;
private ArrayList<LogEntry> mLogBuffer = null;
+ private ArrayList<LogEntry> mPrivacyLogBuffer = null;
private Context mContext = null;
private DropBoxManager mDropBox = null;
private long mLastTimeActive;
@@ -53,17 +57,29 @@
private int mDeleteCount;
private int mInputCount;
+ private int mWordCount;
-
- private static class LogEntry {
+ private static class LogEntry implements Comparable<LogEntry> {
public final int mTag;
- public final long mTime;
- public final String mData;
- public LogEntry (long time, int tag, String data) {
+ public final String[] mData;
+ public long mTime;
+
+ public LogEntry (long time, int tag, String[] data) {
mTag = tag;
mTime = time;
mData = data;
}
+
+ public int compareTo(LogEntry log2) {
+ if (mData.length == 0 && log2.mData.length == 0) {
+ return 0;
+ } else if (mData.length == 0) {
+ return 1;
+ } else if (log2.mData.length == 0) {
+ return -1;
+ }
+ return log2.mData[0].compareTo(mData[0]);
+ }
}
private void initInternal(Context context) {
@@ -101,11 +117,36 @@
return false;
}
+ private static boolean checkStringsDataSafe(String[] strings) {
+ for(String s: strings) {
+ if (!checkStringDataSafe(s)) {
+ return false;
+ }
+ }
+ return true;
+ }
+
private void addCountEntry(long time) {
- mLogBuffer.add(new LogEntry (time, ID_DELETE, String.valueOf(mDeleteCount)));
- mLogBuffer.add(new LogEntry (time, ID_INPUT, String.valueOf(mInputCount)));
+ mLogBuffer.add(
+ new LogEntry (time, ID_DELETE_COUNT,
+ new String[] {String.valueOf(mDeleteCount)}));
+ mLogBuffer.add(new LogEntry (time, ID_INPUT_COUNT,
+ new String[] {String.valueOf(mInputCount)}));
+ mLogBuffer.add(new LogEntry (time, ID_WORD_COUNT,
+ new String[] {String.valueOf(mWordCount)}));
mDeleteCount = 0;
mInputCount = 0;
+ mWordCount = 0;
+ }
+
+ private void flushPrivacyLogSafely() {
+ long now = System.currentTimeMillis();
+ Collections.sort(mPrivacyLogBuffer);
+ for (LogEntry l: mPrivacyLogBuffer) {
+ l.mTime = now;
+ mLogBuffer.add(l);
+ }
+ mPrivacyLogBuffer.clear();
}
/**
@@ -115,62 +156,57 @@
*/
private void addData(int tag, Object data) {
switch (tag) {
- case ID_DELETE:
+ case ID_DELETE_COUNT:
if (mLastTimeActive - mLastTimeCountEntry > MINIMUMCOUNTINTERVAL
|| (mDeleteCount == 0 && mInputCount == 0)) {
addCountEntry(mLastTimeActive);
}
mDeleteCount += (Integer)data;
break;
- case ID_INPUT:
+ case ID_INPUT_COUNT:
if (mLastTimeActive - mLastTimeCountEntry > MINIMUMCOUNTINTERVAL
|| (mDeleteCount == 0 && mInputCount == 0)) {
addCountEntry(mLastTimeActive);
}
mInputCount += (Integer)data;
break;
- default:
- if (data instanceof String) {
- String dataString = (String) data;
- if (checkStringDataSafe(dataString)) {
- mLogBuffer.add(new LogEntry (System.currentTimeMillis(), tag, dataString));
- } else {
- if (DBG) {
- Log.d(TAG, "Skipped to add an entry because data is unsafe.");
- }
- }
+ case ID_CLICKSUGGESTION:
+ case ID_AUTOSUGGESTION:
+ ++mWordCount;
+ String[] dataStrings = (String[]) data;
+ if (checkStringsDataSafe(dataStrings)) {
+ mPrivacyLogBuffer.add(
+ new LogEntry (System.currentTimeMillis(), tag, dataStrings));
} else {
if (DBG) {
- Log.e(TAG, "Log is invalid.");
+ Log.d(TAG, "Skipped to add an entry because data is unsafe.");
}
}
break;
+ case ID_AUTOSUGGESTIONCANCELED:
+ --mWordCount;
+ dataStrings = (String[]) data;
+ if (checkStringsDataSafe(dataStrings)) {
+ mPrivacyLogBuffer.add(
+ new LogEntry (System.currentTimeMillis(), tag, dataStrings));
+ } else {
+ if (DBG) {
+ Log.d(TAG, "Skipped to add an entry because data is unsafe.");
+ }
+ }
+ break;
+ default:
+ if (DBG) {
+ Log.e(TAG, "Log Tag is not entried.");
+ }
+ break;
}
}
- private static void appendWithLength(StringBuffer sb, String data) {
- sb.append(data.length());
- sb.append(SEPARATER);
- sb.append(data);
- }
-
- private static void appendLogEntry(StringBuffer sb, String time, String tag, String data) {
- appendWithLength(sb, time);
- appendWithLength(sb, tag);
- appendWithLength(sb, data);
- }
-
- private String createStringFromEntries(ArrayList<LogEntry> logs) {
- addCountEntry(System.currentTimeMillis());
- StringBuffer sb = new StringBuffer();
- for (LogEntry log: logs) {
- appendLogEntry(sb, String.valueOf(log.mTime), String.valueOf(log.mTag), log.mData);
- }
- return sb.toString();
- }
-
private void commitInternal() {
- String s = createStringFromEntries(mLogBuffer);
+ flushPrivacyLogSafely();
+ addCountEntry(System.currentTimeMillis());
+ String s = LogSerializer.createStringFromEntries(mLogBuffer);
if (DBG) {
Log.d(TAG, "Commit log: " + s);
}
@@ -180,10 +216,11 @@
}
private void sendLogToDropBox(int tag, Object s) {
- if (DBG) {
- Log.d(TAG, "SendLog: " + tag + ";" + s);
- }
long now = System.currentTimeMillis();
+ if (DBG) {
+ Log.d(TAG, "SendLog: " + tag + ";" + s + ","
+ + (now - mLastTimeSend - MINIMUMSENDINTERVAL) );
+ }
if (now - mLastTimeActive > MINIMUMSENDINTERVAL) {
// Send a log before adding an log entry if the last data is too old.
commitInternal();
@@ -218,34 +255,64 @@
}
}
- public static void logOnClickSuggestion(String s) {
+ public static void logOnClickSuggestion(String before, String after, int position) {
if (sLogEnabled) {
- sLatinImeLogger.sendLogToDropBox(ID_CLICKSUGGESTION, s);
+ String[] strings = new String[] {before, after, String.valueOf(position)};
+ sLatinImeLogger.sendLogToDropBox(ID_CLICKSUGGESTION, strings);
}
}
- public static void logOnAutoSuggestion(String s) {
+ public static void logOnAutoSuggestion(String before, String after) {
if (sLogEnabled) {
- sLatinImeLogger.sendLogToDropBox(ID_AUTOSUGGESTION, s);
+ String[] strings = new String[] {before, after};
+ sLatinImeLogger.sendLogToDropBox(ID_AUTOSUGGESTION, strings);
}
}
- public static void logOnAutoSuggestionCanceled(String s) {
+ public static void logOnAutoSuggestionCanceled(String before, String after) {
if (sLogEnabled) {
- sLatinImeLogger.sendLogToDropBox(ID_AUTOSUGGESTIONCANCELED, s);
+ String[] strings = new String[] {before, after};
+ sLatinImeLogger.sendLogToDropBox(ID_AUTOSUGGESTIONCANCELED, strings);
}
}
public static void logOnDelete(int length) {
if (sLogEnabled) {
- sLatinImeLogger.sendLogToDropBox(ID_DELETE, length);
+ sLatinImeLogger.sendLogToDropBox(ID_DELETE_COUNT, length);
}
}
public static void logOnInputChar(int length) {
if (sLogEnabled) {
- sLatinImeLogger.sendLogToDropBox(ID_INPUT, length);
+ sLatinImeLogger.sendLogToDropBox(ID_INPUT_COUNT, length);
}
}
+ private static class LogSerializer {
+ private static void appendWithLength(StringBuffer sb, String data) {
+ sb.append(data.length());
+ sb.append(SEPARATER);
+ sb.append(data);
+ sb.append(SEPARATER);
+ }
+
+ private static void appendLogEntry(StringBuffer sb, String time, String tag, String[] data) {
+ if (data.length > 0) {
+ appendWithLength(sb, String.valueOf(data.length + 2));
+ appendWithLength(sb, time);
+ appendWithLength(sb, tag);
+ for (String s: data) {
+ appendWithLength(sb, s);
+ }
+ }
+ }
+
+ public static String createStringFromEntries(ArrayList<LogEntry> logs) {
+ StringBuffer sb = new StringBuffer();
+ for (LogEntry log: logs) {
+ appendLogEntry(sb, String.valueOf(log.mTime), String.valueOf(log.mTag), log.mData);
+ }
+ return sb.toString();
+ }
+ }
}