ZenLog.java revision d9c75dba75ad4742dbaadc34db99d2b76cebca91 
1/**
2 * Copyright (c) 2014, The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.server.notification;
18
19import android.content.ComponentName;
20import android.media.AudioManager;
21import android.net.Uri;
22import android.os.Build;
23import android.os.RemoteException;
24import android.provider.Settings.Global;
25import android.service.notification.Condition;
26import android.service.notification.IConditionProvider;
27import android.service.notification.NotificationListenerService;
28import android.service.notification.ZenModeConfig;
29import android.util.Slog;
30
31import java.io.PrintWriter;
32import java.text.SimpleDateFormat;
33import java.util.Date;
34
35public class ZenLog {
36    private static final String TAG = "ZenLog";
37    private static final boolean DEBUG = Build.IS_DEBUGGABLE;
38
39    private static final int SIZE = Build.IS_DEBUGGABLE ? 100 : 20;
40
41    private static final long[] TIMES = new long[SIZE];
42    private static final int[] TYPES = new int[SIZE];
43    private static final String[] MSGS = new String[SIZE];
44
45    private static final SimpleDateFormat FORMAT = new SimpleDateFormat("MM-dd HH:mm:ss.SSS");
46
47    private static final int TYPE_INTERCEPTED = 1;
48    private static final int TYPE_ALLOW_DISABLE = 2;
49    private static final int TYPE_SET_RINGER_MODE_EXTERNAL = 3;
50    private static final int TYPE_SET_RINGER_MODE_INTERNAL = 4;
51    private static final int TYPE_DOWNTIME = 5;
52    private static final int TYPE_SET_ZEN_MODE = 6;
53    private static final int TYPE_UPDATE_ZEN_MODE = 7;
54    private static final int TYPE_EXIT_CONDITION = 8;
55    private static final int TYPE_SUBSCRIBE = 9;
56    private static final int TYPE_UNSUBSCRIBE = 10;
57    private static final int TYPE_CONFIG = 11;
58    private static final int TYPE_NOT_INTERCEPTED = 12;
59    private static final int TYPE_DISABLE_EFFECTS = 13;
60    private static final int TYPE_SUPPRESSOR_CHANGED = 14;
61    private static final int TYPE_LISTENER_HINTS_CHANGED = 15;
62
63    private static int sNext;
64    private static int sSize;
65
66    public static void traceIntercepted(NotificationRecord record, String reason) {
67        if (record != null && record.isIntercepted()) return;  // already logged
68        append(TYPE_INTERCEPTED, record.getKey() + "," + reason);
69    }
70
71    public static void traceNotIntercepted(NotificationRecord record, String reason) {
72        if (record != null && record.isUpdate) return;  // already logged
73        append(TYPE_NOT_INTERCEPTED, record.getKey() + "," + reason);
74    }
75
76    public static void traceSetRingerModeExternal(int ringerModeOld, int ringerModeNew,
77            String caller, int ringerModeInternalIn, int ringerModeInternalOut) {
78        append(TYPE_SET_RINGER_MODE_EXTERNAL, caller + ",e:" +
79                ringerModeToString(ringerModeOld) + "->" +
80                ringerModeToString(ringerModeNew)  + ",i:" +
81                ringerModeToString(ringerModeInternalIn) + "->" +
82                ringerModeToString(ringerModeInternalOut));
83    }
84
85    public static void traceSetRingerModeInternal(int ringerModeOld, int ringerModeNew,
86            String caller, int ringerModeExternalIn, int ringerModeExternalOut) {
87        append(TYPE_SET_RINGER_MODE_INTERNAL, caller + ",i:" +
88                ringerModeToString(ringerModeOld) + "->" +
89                ringerModeToString(ringerModeNew)  + ",e:" +
90                ringerModeToString(ringerModeExternalIn) + "->" +
91                ringerModeToString(ringerModeExternalOut));
92    }
93
94    public static void traceDowntimeAutotrigger(String result) {
95        append(TYPE_DOWNTIME, result);
96    }
97
98    public static void traceSetZenMode(int zenMode, String reason) {
99        append(TYPE_SET_ZEN_MODE, zenModeToString(zenMode) + "," + reason);
100    }
101
102    public static void traceUpdateZenMode(int fromMode, int toMode) {
103        append(TYPE_UPDATE_ZEN_MODE, zenModeToString(fromMode) + " -> " + zenModeToString(toMode));
104    }
105
106    public static void traceExitCondition(Condition c, ComponentName component, String reason) {
107        append(TYPE_EXIT_CONDITION, c + "," + componentToString(component) + "," + reason);
108    }
109
110    public static void traceSubscribe(Uri uri, IConditionProvider provider, RemoteException e) {
111        append(TYPE_SUBSCRIBE, uri + "," + subscribeResult(provider, e));
112    }
113
114    public static void traceUnsubscribe(Uri uri, IConditionProvider provider, RemoteException e) {
115        append(TYPE_UNSUBSCRIBE, uri + "," + subscribeResult(provider, e));
116    }
117
118    public static void traceConfig(String reason, ZenModeConfig newConfig) {
119        append(TYPE_CONFIG, reason + "," + (newConfig != null ? newConfig.toString() : null));
120    }
121
122    public static void traceDisableEffects(NotificationRecord record, String reason) {
123        append(TYPE_DISABLE_EFFECTS, record.getKey() + "," + reason);
124    }
125
126    public static void traceEffectsSuppressorChanged(ComponentName oldSuppressor,
127            ComponentName newSuppressor) {
128        append(TYPE_SUPPRESSOR_CHANGED, componentToString(oldSuppressor) + "->"
129            + componentToString(newSuppressor));
130    }
131
132    public static void traceListenerHintsChanged(int oldHints, int newHints, int listenerCount) {
133        append(TYPE_LISTENER_HINTS_CHANGED, hintsToString(oldHints) + "->"
134            + hintsToString(newHints) + ",listeners=" + listenerCount);
135    }
136
137    private static String subscribeResult(IConditionProvider provider, RemoteException e) {
138        return provider == null ? "no provider" : e != null ? e.getMessage() : "ok";
139    }
140
141    private static String typeToString(int type) {
142        switch (type) {
143            case TYPE_INTERCEPTED: return "intercepted";
144            case TYPE_ALLOW_DISABLE: return "allow_disable";
145            case TYPE_SET_RINGER_MODE_EXTERNAL: return "set_ringer_mode_external";
146            case TYPE_SET_RINGER_MODE_INTERNAL: return "set_ringer_mode_internal";
147            case TYPE_DOWNTIME: return "downtime";
148            case TYPE_SET_ZEN_MODE: return "set_zen_mode";
149            case TYPE_UPDATE_ZEN_MODE: return "update_zen_mode";
150            case TYPE_EXIT_CONDITION: return "exit_condition";
151            case TYPE_SUBSCRIBE: return "subscribe";
152            case TYPE_UNSUBSCRIBE: return "unsubscribe";
153            case TYPE_CONFIG: return "config";
154            case TYPE_NOT_INTERCEPTED: return "not_intercepted";
155            case TYPE_DISABLE_EFFECTS: return "disable_effects";
156            case TYPE_SUPPRESSOR_CHANGED: return "suppressor_changed";
157            case TYPE_LISTENER_HINTS_CHANGED: return "listener_hints_changed";
158            default: return "unknown";
159        }
160    }
161
162    private static String ringerModeToString(int ringerMode) {
163        switch (ringerMode) {
164            case AudioManager.RINGER_MODE_SILENT: return "silent";
165            case AudioManager.RINGER_MODE_VIBRATE: return "vibrate";
166            case AudioManager.RINGER_MODE_NORMAL: return "normal";
167            default: return "unknown";
168        }
169    }
170
171    private static String zenModeToString(int zenMode) {
172        switch (zenMode) {
173            case Global.ZEN_MODE_OFF: return "off";
174            case Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS: return "important_interruptions";
175            case Global.ZEN_MODE_ALARMS: return "alarms";
176            case Global.ZEN_MODE_NO_INTERRUPTIONS: return "no_interruptions";
177            default: return "unknown";
178        }
179    }
180
181    private static String hintsToString(int hints) {
182        switch (hints) {
183            case 0 : return "none";
184            case NotificationListenerService.HINT_HOST_DISABLE_EFFECTS : return "disable_effects";
185            default: return Integer.toString(hints);
186        }
187    }
188
189    private static String componentToString(ComponentName component) {
190        return component != null ? component.toShortString() : null;
191    }
192
193    private static void append(int type, String msg) {
194        synchronized(MSGS) {
195            TIMES[sNext] = System.currentTimeMillis();
196            TYPES[sNext] = type;
197            MSGS[sNext] = msg;
198            sNext = (sNext + 1) % SIZE;
199            if (sSize < SIZE) {
200                sSize++;
201            }
202        }
203        if (DEBUG) Slog.d(TAG, typeToString(type) + ": " + msg);
204    }
205
206    public static void dump(PrintWriter pw, String prefix) {
207        synchronized(MSGS) {
208            final int start = (sNext - sSize + SIZE) % SIZE;
209            for (int i = 0; i < sSize; i++) {
210                final int j = (start + i) % SIZE;
211                pw.print(prefix);
212                pw.print(FORMAT.format(new Date(TIMES[j])));
213                pw.print(' ');
214                pw.print(typeToString(TYPES[j]));
215                pw.print(": ");
216                pw.println(MSGS[j]);
217            }
218        }
219    }
220}
221