1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package org.apache.logging.log4j.core.filter;
18
19 import java.text.ParseException;
20 import java.text.SimpleDateFormat;
21 import java.util.Calendar;
22 import java.util.TimeZone;
23
24 import org.apache.logging.log4j.Level;
25 import org.apache.logging.log4j.Marker;
26 import org.apache.logging.log4j.core.Filter;
27 import org.apache.logging.log4j.core.LogEvent;
28 import org.apache.logging.log4j.core.Logger;
29 import org.apache.logging.log4j.core.config.Node;
30 import org.apache.logging.log4j.core.config.plugins.Plugin;
31 import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
32 import org.apache.logging.log4j.core.config.plugins.PluginFactory;
33 import org.apache.logging.log4j.core.util.Clock;
34 import org.apache.logging.log4j.core.util.ClockFactory;
35 import org.apache.logging.log4j.message.Message;
36 import org.apache.logging.log4j.util.PerformanceSensitive;
37
38
39
40
41 @Plugin(name = "TimeFilter", category = Node.CATEGORY, elementType = Filter.ELEMENT_TYPE, printObject = true)
42 @PerformanceSensitive("allocation")
43 public final class TimeFilter extends AbstractFilter {
44 private static final Clock CLOCK = ClockFactory.getClock();
45
46
47
48
49 private static final long HOUR_MS = 3600000;
50
51
52
53
54 private static final long MINUTE_MS = 60000;
55
56
57
58
59 private static final long SECOND_MS = 1000;
60
61
62
63
64 private final long start;
65
66
67
68 private final long end;
69
70
71
72 private final TimeZone timezone;
73
74 private long midnightToday;
75 private long midnightTomorrow;
76
77
78 private TimeFilter(final long start, final long end, final TimeZone tz, final Result onMatch,
79 final Result onMismatch) {
80 super(onMatch, onMismatch);
81 this.start = start;
82 this.end = end;
83 timezone = tz;
84 initMidnight(start);
85 }
86
87
88
89
90
91 void initMidnight(final long now) {
92 final Calendar calendar = Calendar.getInstance(timezone);
93 calendar.setTimeInMillis(now);
94 calendar.set(Calendar.HOUR_OF_DAY, 0);
95 calendar.set(Calendar.MINUTE, 0);
96 calendar.set(Calendar.SECOND, 0);
97 calendar.set(Calendar.MILLISECOND, 0);
98 midnightToday = calendar.getTimeInMillis();
99
100 calendar.add(Calendar.DATE, 1);
101 midnightTomorrow = calendar.getTimeInMillis();
102 }
103
104
105
106
107
108
109
110
111 Result filter(final long currentTimeMillis) {
112 if (currentTimeMillis >= midnightTomorrow || currentTimeMillis < midnightToday) {
113 initMidnight(currentTimeMillis);
114 }
115 return currentTimeMillis >= midnightToday + start && currentTimeMillis <= midnightToday + end
116 ? onMatch
117 : onMismatch;
118 }
119
120 @Override
121 public Result filter(final LogEvent event) {
122 return filter(event.getTimeMillis());
123 }
124
125 private Result filter() {
126 return filter(CLOCK.currentTimeMillis());
127 }
128
129 @Override
130 public Result filter(final Logger logger, final Level level, final Marker marker, final Message msg,
131 final Throwable t) {
132 return filter();
133 }
134
135 @Override
136 public Result filter(final Logger logger, final Level level, final Marker marker, final Object msg,
137 final Throwable t) {
138 return filter();
139 }
140
141 @Override
142 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
143 final Object... params) {
144 return filter();
145 }
146
147 @Override
148 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
149 final Object p0) {
150 return filter();
151 }
152
153 @Override
154 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
155 final Object p0, final Object p1) {
156 return filter();
157 }
158
159 @Override
160 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
161 final Object p0, final Object p1, final Object p2) {
162 return filter();
163 }
164
165 @Override
166 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
167 final Object p0, final Object p1, final Object p2, final Object p3) {
168 return filter();
169 }
170
171 @Override
172 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
173 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4) {
174 return filter();
175 }
176
177 @Override
178 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
179 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5) {
180 return filter();
181 }
182
183 @Override
184 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
185 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
186 final Object p6) {
187 return filter();
188 }
189
190 @Override
191 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
192 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
193 final Object p6, final Object p7) {
194 return filter();
195 }
196
197 @Override
198 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
199 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
200 final Object p6, final Object p7, final Object p8) {
201 return filter();
202 }
203
204 @Override
205 public Result filter(final Logger logger, final Level level, final Marker marker, final String msg,
206 final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
207 final Object p6, final Object p7, final Object p8, final Object p9) {
208 return filter();
209 }
210
211 @Override
212 public String toString() {
213 final StringBuilder sb = new StringBuilder();
214 sb.append("start=").append(start);
215 sb.append(", end=").append(end);
216 sb.append(", timezone=").append(timezone.toString());
217 return sb.toString();
218 }
219
220
221
222
223
224
225
226
227
228
229 @PluginFactory
230 public static TimeFilter createFilter(
231 @PluginAttribute("start") final String start,
232 @PluginAttribute("end") final String end,
233 @PluginAttribute("timezone") final String tz,
234 @PluginAttribute("onMatch") final Result match,
235 @PluginAttribute("onMismatch") final Result mismatch) {
236 final long s = parseTimestamp(start, 0);
237 final long e = parseTimestamp(end, Long.MAX_VALUE);
238 final TimeZone timezone = tz == null ? TimeZone.getDefault() : TimeZone.getTimeZone(tz);
239 final Result onMatch = match == null ? Result.NEUTRAL : match;
240 final Result onMismatch = mismatch == null ? Result.DENY : mismatch;
241 return new TimeFilter(s, e, timezone, onMatch, onMismatch);
242 }
243
244 private static long parseTimestamp(final String timestamp, final long defaultValue) {
245 if (timestamp == null) {
246 return defaultValue;
247 }
248 final SimpleDateFormat stf = new SimpleDateFormat("HH:mm:ss");
249 stf.setTimeZone(TimeZone.getTimeZone("UTC"));
250 try {
251 return stf.parse(timestamp).getTime();
252 } catch (final ParseException e) {
253 LOGGER.warn("Error parsing TimeFilter timestamp value {}", timestamp, e);
254 return defaultValue;
255 }
256 }
257
258 }