1
2
3
4
5
6
7
8
9
10
11
12 package ch.qos.logback.core.rolling;
13
14 import static ch.qos.logback.core.CoreConstants.MANUAL_URL_PREFIX;
15
16 import java.io.File;
17 import java.time.Instant;
18
19 import ch.qos.logback.core.CoreConstants;
20 import ch.qos.logback.core.joran.spi.NoAutoStart;
21 import ch.qos.logback.core.rolling.helper.ArchiveRemover;
22 import ch.qos.logback.core.rolling.helper.CompressionMode;
23 import ch.qos.logback.core.rolling.helper.FileFilterUtil;
24 import ch.qos.logback.core.rolling.helper.SizeAndTimeBasedArchiveRemover;
25 import ch.qos.logback.core.util.Duration;
26 import ch.qos.logback.core.util.FileSize;
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42 @NoAutoStart
43 public class SizeAndTimeBasedFileNamingAndTriggeringPolicy<E> extends TimeBasedFileNamingAndTriggeringPolicyBase<E> {
44
45 enum Usage {
46 EMBEDDED, DIRECT
47 }
48
49 volatile int currentPeriodsCounter = 0;
50 FileSize maxFileSize;
51
52 Duration checkIncrement = null;
53
54 static String MISSING_INT_TOKEN = "Missing integer token, that is %i, in FileNamePattern [";
55 static String MISSING_DATE_TOKEN = "Missing date token, that is %d, in FileNamePattern [";
56
57 private final Usage usage;
58
59
60
61 public SizeAndTimeBasedFileNamingAndTriggeringPolicy() {
62 this(Usage.DIRECT);
63 }
64
65 public SizeAndTimeBasedFileNamingAndTriggeringPolicy(Usage usage) {
66 this.usage = usage;
67 }
68
69 public LengthCounter lengthCounter = new LengthCounterBase();
70
71
72
73 @Override
74 public void start() {
75
76 super.start();
77
78 if (usage == Usage.DIRECT) {
79 addWarn(CoreConstants.SIZE_AND_TIME_BASED_FNATP_IS_DEPRECATED);
80 addWarn(CoreConstants.SIZE_AND_TIME_BASED_FNATP_IS_DEPRECATED_BIS);
81 addWarn("For more information see " + MANUAL_URL_PREFIX + "appenders.html#SizeAndTimeBasedRollingPolicy");
82 }
83
84 if (!super.isErrorFree())
85 return;
86
87 if (maxFileSize == null) {
88 addError("maxFileSize property is mandatory.");
89 withErrors();
90 }
91
92
93
94
95 if (!validateDateAndIntegerTokens()) {
96 withErrors();
97 return;
98 }
99
100 archiveRemover = createArchiveRemover();
101 archiveRemover.setContext(context);
102
103
104
105
106 String regex = enclosingTBRP.fileNamePattern.toRegexForFixedDate(dateInCurrentPeriod);
107 String stemRegex = FileFilterUtil.afterLastSlash(regex);
108
109 computeCurrentPeriodsHighestCounterValue(stemRegex);
110
111 if (isErrorFree()) {
112 started = true;
113 }
114 }
115
116 private boolean validateDateAndIntegerTokens() {
117 boolean inError = false;
118 if (enclosingTBRP.fileNamePattern.getIntegerTokenConverter() == null) {
119 inError = true;
120 addError(MISSING_INT_TOKEN + enclosingTBRP.fileNamePatternStr + "]");
121 addError(CoreConstants.SEE_MISSING_INTEGER_TOKEN);
122 }
123 if (enclosingTBRP.fileNamePattern.getPrimaryDateTokenConverter() == null) {
124 inError = true;
125 addError(MISSING_DATE_TOKEN + enclosingTBRP.fileNamePatternStr + "]");
126 }
127
128 return !inError;
129 }
130
131 protected ArchiveRemover createArchiveRemover() {
132 return new SizeAndTimeBasedArchiveRemover(enclosingTBRP.fileNamePattern,
133 enclosingTBRP.fileNamePatternWithoutCompSuffix, rc);
134 }
135
136 void computeCurrentPeriodsHighestCounterValue(final String stemRegex) {
137 File file = new File(getCurrentPeriodsFileNameWithoutCompressionSuffix());
138 File parentDir = file.getParentFile();
139
140 File[] matchingFileArray = FileFilterUtil.filesInFolderMatchingStemRegex(parentDir, stemRegex);
141
142 if (matchingFileArray == null || matchingFileArray.length == 0) {
143 currentPeriodsCounter = 0;
144 return;
145 }
146 currentPeriodsCounter = FileFilterUtil.findHighestCounter(matchingFileArray, stemRegex);
147
148
149
150 if (enclosingTBRP.getParentsRawFileProperty() != null || (enclosingTBRP.compressionMode != CompressionMode.NONE)) {
151
152 currentPeriodsCounter++;
153 }
154 }
155
156 @Override
157 public boolean isTriggeringEvent(File activeFile, final E event) {
158
159 long currentTime = getCurrentTime();
160 long localNextCheck = atomicNextCheck.get();
161
162
163 if (currentTime >= localNextCheck) {
164 long nextCheckCandidate = computeNextCheck(currentTime);
165 atomicNextCheck.set(nextCheckCandidate);
166 Instant instantInElapsedPeriod = dateInCurrentPeriod;
167 elapsedPeriodsFileName = enclosingTBRP.fileNamePatternWithoutCompSuffix.convertMultipleArguments(
168 instantInElapsedPeriod, currentPeriodsCounter);
169 currentPeriodsCounter = 0;
170 setDateInCurrentPeriod(currentTime);
171 lengthCounter.reset();
172 return true;
173 }
174
175 boolean result = checkSizeBasedTrigger(activeFile, currentTime);
176 if(result)
177 lengthCounter.reset();
178 return result;
179 }
180
181 private boolean checkSizeBasedTrigger(File activeFile, long currentTime) {
182
183
184
185
186
187 if (activeFile == null) {
188 addWarn("activeFile == null");
189 return false;
190 }
191 if (maxFileSize == null) {
192 addWarn("maxFileSize = null");
193 return false;
194 }
195
196
197
198 if (lengthCounter.getLength() >= maxFileSize.getSize()) {
199
200 elapsedPeriodsFileName = enclosingTBRP.fileNamePatternWithoutCompSuffix.convertMultipleArguments(dateInCurrentPeriod,
201 currentPeriodsCounter);
202 currentPeriodsCounter++;
203
204 return true;
205 }
206
207 return false;
208 }
209
210 public Duration getCheckIncrement() {
211 return null;
212 }
213
214 public void setCheckIncrement(Duration checkIncrement) {
215 addWarn("Since version 1.5.8, 'checkIncrement' property has no effect");
216 }
217
218 @Override
219 public String getCurrentPeriodsFileNameWithoutCompressionSuffix() {
220 return enclosingTBRP.fileNamePatternWithoutCompSuffix.convertMultipleArguments(dateInCurrentPeriod,
221 currentPeriodsCounter);
222 }
223
224 public void setMaxFileSize(FileSize aMaxFileSize) {
225 this.maxFileSize = aMaxFileSize;
226 }
227
228 @Override
229 public LengthCounter getLengthCounter() {
230 return lengthCounter;
231 }
232 }