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 
17 package com.android.server.notification;
18 
19 import android.app.NotificationManager;
20 import android.content.ComponentName;
21 import android.media.AudioManager;
22 import android.net.Uri;
23 import android.os.Build;
24 import android.os.RemoteException;
25 import android.provider.Settings.Global;
26 import android.service.notification.Condition;
27 import android.service.notification.IConditionProvider;
28 import android.service.notification.NotificationListenerService;
29 import android.service.notification.ZenModeConfig;
30 import android.util.Log;
31 import android.util.Slog;
32 
33 import java.io.PrintWriter;
34 import java.text.SimpleDateFormat;
35 import java.util.Date;
36 import java.util.List;
37 
38 public class ZenLog {
39     private static final String TAG = "ZenLog";
40     // the ZenLog is *very* verbose, so be careful about setting this to true
41     private static final boolean DEBUG = false;
42 
43     private static final int SIZE = Build.IS_DEBUGGABLE ? 200 : 100;
44 
45     private static final long[] TIMES = new long[SIZE];
46     private static final int[] TYPES = new int[SIZE];
47     private static final String[] MSGS = new String[SIZE];
48 
49     private static final SimpleDateFormat FORMAT = new SimpleDateFormat("MM-dd HH:mm:ss.SSS");
50 
51     private static final int TYPE_INTERCEPTED = 1;
52     private static final int TYPE_ALLOW_DISABLE = 2;
53     private static final int TYPE_SET_RINGER_MODE_EXTERNAL = 3;
54     private static final int TYPE_SET_RINGER_MODE_INTERNAL = 4;
55     private static final int TYPE_DOWNTIME = 5;
56     private static final int TYPE_SET_ZEN_MODE = 6;
57     private static final int TYPE_UPDATE_ZEN_MODE = 7;
58     private static final int TYPE_EXIT_CONDITION = 8;
59     private static final int TYPE_SUBSCRIBE = 9;
60     private static final int TYPE_UNSUBSCRIBE = 10;
61     private static final int TYPE_CONFIG = 11;
62     private static final int TYPE_NOT_INTERCEPTED = 12;
63     private static final int TYPE_DISABLE_EFFECTS = 13;
64     private static final int TYPE_SUPPRESSOR_CHANGED = 14;
65     private static final int TYPE_LISTENER_HINTS_CHANGED = 15;
66     private static final int TYPE_SET_NOTIFICATION_POLICY = 16;
67     private static final int TYPE_SET_CONSOLIDATED_ZEN_POLICY = 17;
68 
69     private static int sNext;
70     private static int sSize;
71 
traceIntercepted(NotificationRecord record, String reason)72     public static void traceIntercepted(NotificationRecord record, String reason) {
73         if (record != null && record.isIntercepted()) return;  // already logged
74         append(TYPE_INTERCEPTED, record.getKey() + "," + reason);
75     }
76 
traceNotIntercepted(NotificationRecord record, String reason)77     public static void traceNotIntercepted(NotificationRecord record, String reason) {
78         if (record != null && record.isUpdate) return;  // already logged
79         append(TYPE_NOT_INTERCEPTED, record.getKey() + "," + reason);
80     }
81 
traceSetRingerModeExternal(int ringerModeOld, int ringerModeNew, String caller, int ringerModeInternalIn, int ringerModeInternalOut)82     public static void traceSetRingerModeExternal(int ringerModeOld, int ringerModeNew,
83             String caller, int ringerModeInternalIn, int ringerModeInternalOut) {
84         append(TYPE_SET_RINGER_MODE_EXTERNAL, caller + ",e:" +
85                 ringerModeToString(ringerModeOld) + "->" +
86                 ringerModeToString(ringerModeNew)  + ",i:" +
87                 ringerModeToString(ringerModeInternalIn) + "->" +
88                 ringerModeToString(ringerModeInternalOut));
89     }
90 
traceSetRingerModeInternal(int ringerModeOld, int ringerModeNew, String caller, int ringerModeExternalIn, int ringerModeExternalOut)91     public static void traceSetRingerModeInternal(int ringerModeOld, int ringerModeNew,
92             String caller, int ringerModeExternalIn, int ringerModeExternalOut) {
93         append(TYPE_SET_RINGER_MODE_INTERNAL, caller + ",i:" +
94                 ringerModeToString(ringerModeOld) + "->" +
95                 ringerModeToString(ringerModeNew)  + ",e:" +
96                 ringerModeToString(ringerModeExternalIn) + "->" +
97                 ringerModeToString(ringerModeExternalOut));
98     }
99 
traceDowntimeAutotrigger(String result)100     public static void traceDowntimeAutotrigger(String result) {
101         append(TYPE_DOWNTIME, result);
102     }
103 
traceSetZenMode(int zenMode, String reason)104     public static void traceSetZenMode(int zenMode, String reason) {
105         append(TYPE_SET_ZEN_MODE, zenModeToString(zenMode) + "," + reason);
106     }
107 
108     /**
109      * trace setting the consolidated zen policy
110      */
traceSetConsolidatedZenPolicy(NotificationManager.Policy policy, String reason)111     public static void traceSetConsolidatedZenPolicy(NotificationManager.Policy policy,
112             String reason) {
113         append(TYPE_SET_CONSOLIDATED_ZEN_POLICY, policy.toString() + "," + reason);
114     }
115 
traceUpdateZenMode(int fromMode, int toMode)116     public static void traceUpdateZenMode(int fromMode, int toMode) {
117         append(TYPE_UPDATE_ZEN_MODE, zenModeToString(fromMode) + " -> " + zenModeToString(toMode));
118     }
119 
traceExitCondition(Condition c, ComponentName component, String reason)120     public static void traceExitCondition(Condition c, ComponentName component, String reason) {
121         append(TYPE_EXIT_CONDITION, c + "," + componentToString(component) + "," + reason);
122     }
123 
traceSetNotificationPolicy(String pkg, int targetSdk, NotificationManager.Policy policy)124     public static void traceSetNotificationPolicy(String pkg, int targetSdk,
125             NotificationManager.Policy policy) {
126         String policyLog = "pkg=" + pkg + " targetSdk=" + targetSdk
127                 + " NotificationPolicy=" + policy.toString();
128         append(TYPE_SET_NOTIFICATION_POLICY, policyLog);
129         // TODO(b/180205791): remove when we can better surface apps that are changing policy
130         Log.d(TAG, "Zen Policy Changed: " + policyLog);
131     }
132 
traceSubscribe(Uri uri, IConditionProvider provider, RemoteException e)133     public static void traceSubscribe(Uri uri, IConditionProvider provider, RemoteException e) {
134         append(TYPE_SUBSCRIBE, uri + "," + subscribeResult(provider, e));
135     }
136 
traceUnsubscribe(Uri uri, IConditionProvider provider, RemoteException e)137     public static void traceUnsubscribe(Uri uri, IConditionProvider provider, RemoteException e) {
138         append(TYPE_UNSUBSCRIBE, uri + "," + subscribeResult(provider, e));
139     }
140 
traceConfig(String reason, ZenModeConfig oldConfig, ZenModeConfig newConfig)141     public static void traceConfig(String reason, ZenModeConfig oldConfig,
142             ZenModeConfig newConfig) {
143         ZenModeConfig.Diff diff = ZenModeConfig.diff(oldConfig, newConfig);
144         if (diff.isEmpty()) {
145             append(TYPE_CONFIG, reason + " no changes");
146         } else {
147             append(TYPE_CONFIG, reason
148                     + ",\n" + (newConfig != null ? newConfig.toString() : null)
149                     + ",\n" + ZenModeConfig.diff(oldConfig, newConfig));
150         }
151     }
152 
traceDisableEffects(NotificationRecord record, String reason)153     public static void traceDisableEffects(NotificationRecord record, String reason) {
154         append(TYPE_DISABLE_EFFECTS, record.getKey() + "," + reason);
155     }
156 
traceEffectsSuppressorChanged(List<ComponentName> oldSuppressors, List<ComponentName> newSuppressors, long suppressedEffects)157     public static void traceEffectsSuppressorChanged(List<ComponentName> oldSuppressors,
158             List<ComponentName> newSuppressors, long suppressedEffects) {
159         append(TYPE_SUPPRESSOR_CHANGED, "suppressed effects:" + suppressedEffects + ","
160                 + componentListToString(oldSuppressors) + "->"
161                 + componentListToString(newSuppressors));
162     }
163 
traceListenerHintsChanged(int oldHints, int newHints, int listenerCount)164     public static void traceListenerHintsChanged(int oldHints, int newHints, int listenerCount) {
165         append(TYPE_LISTENER_HINTS_CHANGED, hintsToString(oldHints) + "->"
166             + hintsToString(newHints) + ",listeners=" + listenerCount);
167     }
168 
subscribeResult(IConditionProvider provider, RemoteException e)169     private static String subscribeResult(IConditionProvider provider, RemoteException e) {
170         return provider == null ? "no provider" : e != null ? e.getMessage() : "ok";
171     }
172 
typeToString(int type)173     private static String typeToString(int type) {
174         switch (type) {
175             case TYPE_INTERCEPTED: return "intercepted";
176             case TYPE_ALLOW_DISABLE: return "allow_disable";
177             case TYPE_SET_RINGER_MODE_EXTERNAL: return "set_ringer_mode_external";
178             case TYPE_SET_RINGER_MODE_INTERNAL: return "set_ringer_mode_internal";
179             case TYPE_DOWNTIME: return "downtime";
180             case TYPE_SET_ZEN_MODE: return "set_zen_mode";
181             case TYPE_UPDATE_ZEN_MODE: return "update_zen_mode";
182             case TYPE_EXIT_CONDITION: return "exit_condition";
183             case TYPE_SUBSCRIBE: return "subscribe";
184             case TYPE_UNSUBSCRIBE: return "unsubscribe";
185             case TYPE_CONFIG: return "config";
186             case TYPE_NOT_INTERCEPTED: return "not_intercepted";
187             case TYPE_DISABLE_EFFECTS: return "disable_effects";
188             case TYPE_SUPPRESSOR_CHANGED: return "suppressor_changed";
189             case TYPE_LISTENER_HINTS_CHANGED: return "listener_hints_changed";
190             case TYPE_SET_NOTIFICATION_POLICY: return "set_notification_policy";
191             case TYPE_SET_CONSOLIDATED_ZEN_POLICY: return "set_consolidated_policy";
192             default: return "unknown";
193         }
194     }
195 
ringerModeToString(int ringerMode)196     private static String ringerModeToString(int ringerMode) {
197         switch (ringerMode) {
198             case AudioManager.RINGER_MODE_SILENT: return "silent";
199             case AudioManager.RINGER_MODE_VIBRATE: return "vibrate";
200             case AudioManager.RINGER_MODE_NORMAL: return "normal";
201             default: return "unknown";
202         }
203     }
204 
zenModeToString(int zenMode)205     private static String zenModeToString(int zenMode) {
206         switch (zenMode) {
207             case Global.ZEN_MODE_OFF: return "off";
208             case Global.ZEN_MODE_IMPORTANT_INTERRUPTIONS: return "important_interruptions";
209             case Global.ZEN_MODE_ALARMS: return "alarms";
210             case Global.ZEN_MODE_NO_INTERRUPTIONS: return "no_interruptions";
211             default: return "unknown";
212         }
213     }
214 
hintsToString(int hints)215     private static String hintsToString(int hints) {
216         switch (hints) {
217             case 0 : return "none";
218             case NotificationListenerService.HINT_HOST_DISABLE_EFFECTS:
219                     return "disable_effects";
220             case NotificationListenerService.HINT_HOST_DISABLE_CALL_EFFECTS:
221                     return "disable_call_effects";
222             case NotificationListenerService.HINT_HOST_DISABLE_NOTIFICATION_EFFECTS:
223                     return "disable_notification_effects";
224             default: return Integer.toString(hints);
225         }
226     }
227 
componentToString(ComponentName component)228     private static String componentToString(ComponentName component) {
229         return component != null ? component.toShortString() : null;
230     }
231 
componentListToString(List<ComponentName> components)232     private static String componentListToString(List<ComponentName> components) {
233         StringBuilder stringBuilder = new StringBuilder();
234 
235         for (int i = 0; i < components.size(); ++i) {
236             if (i > 0) {
237                 stringBuilder.append(", ");
238             }
239             stringBuilder.append(componentToString(components.get(i)));
240         }
241 
242         return stringBuilder.toString();
243     }
244 
append(int type, String msg)245     private static void append(int type, String msg) {
246         synchronized(MSGS) {
247             TIMES[sNext] = System.currentTimeMillis();
248             TYPES[sNext] = type;
249             MSGS[sNext] = msg;
250             sNext = (sNext + 1) % SIZE;
251             if (sSize < SIZE) {
252                 sSize++;
253             }
254         }
255         if (DEBUG) Slog.d(TAG, typeToString(type) + ": " + msg);
256     }
257 
dump(PrintWriter pw, String prefix)258     public static void dump(PrintWriter pw, String prefix) {
259         synchronized(MSGS) {
260             final int start = (sNext - sSize + SIZE) % SIZE;
261             for (int i = 0; i < sSize; i++) {
262                 final int j = (start + i) % SIZE;
263                 pw.print(prefix);
264                 pw.print(FORMAT.format(new Date(TIMES[j])));
265                 pw.print(' ');
266                 pw.print(typeToString(TYPES[j]));
267                 pw.print(": ");
268                 pw.println(MSGS[j]);
269             }
270         }
271     }
272 }
273