blob: ba0904d64ee4d6147de87e713e3deb950f43d8e3 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.appender.rolling;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.nio.file.DirectoryStream;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.nio.file.Files;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.nio.file.Path;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.ArrayList;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.List;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.SortedMap;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.TreeMap;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.regex.Matcher;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.regex.Pattern;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.Logger;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.LoggingException;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.appender.rolling.action.Action;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.appender.rolling.action.CompositeAction;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import org.apache.logging.log4j.core.pattern.NotANumber;<a name="line.36"></a>
<span class="sourceLineNo">037</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.37"></a>
<span class="sourceLineNo">038</span><a name="line.38"></a>
<span class="sourceLineNo">039</span>/**<a name="line.39"></a>
<span class="sourceLineNo">040</span> *<a name="line.40"></a>
<span class="sourceLineNo">041</span> */<a name="line.41"></a>
<span class="sourceLineNo">042</span>public abstract class AbstractRolloverStrategy implements RolloverStrategy {<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span> /**<a name="line.44"></a>
<span class="sourceLineNo">045</span> * Allow subclasses access to the status logger without creating another instance.<a name="line.45"></a>
<span class="sourceLineNo">046</span> */<a name="line.46"></a>
<span class="sourceLineNo">047</span> protected static final Logger LOGGER = StatusLogger.getLogger();<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> public static final Pattern PATTERN_COUNTER= Pattern.compile(".*%((?&lt;ZEROPAD&gt;0)?(?&lt;PADDING&gt;\\d+))?i.*");<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> protected final StrSubstitutor strSubstitutor;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> protected AbstractRolloverStrategy(final StrSubstitutor strSubstitutor) {<a name="line.53"></a>
<span class="sourceLineNo">054</span> this.strSubstitutor = strSubstitutor;<a name="line.54"></a>
<span class="sourceLineNo">055</span> }<a name="line.55"></a>
<span class="sourceLineNo">056</span><a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> public StrSubstitutor getStrSubstitutor() {<a name="line.58"></a>
<span class="sourceLineNo">059</span> return strSubstitutor;<a name="line.59"></a>
<span class="sourceLineNo">060</span> }<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span> protected Action merge(final Action compressAction, final List&lt;Action&gt; custom, final boolean stopOnError) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> if (custom.isEmpty()) {<a name="line.63"></a>
<span class="sourceLineNo">064</span> return compressAction;<a name="line.64"></a>
<span class="sourceLineNo">065</span> }<a name="line.65"></a>
<span class="sourceLineNo">066</span> if (compressAction == null) {<a name="line.66"></a>
<span class="sourceLineNo">067</span> return new CompositeAction(custom, stopOnError);<a name="line.67"></a>
<span class="sourceLineNo">068</span> }<a name="line.68"></a>
<span class="sourceLineNo">069</span> final List&lt;Action&gt; all = new ArrayList&lt;&gt;();<a name="line.69"></a>
<span class="sourceLineNo">070</span> all.add(compressAction);<a name="line.70"></a>
<span class="sourceLineNo">071</span> all.addAll(custom);<a name="line.71"></a>
<span class="sourceLineNo">072</span> return new CompositeAction(all, stopOnError);<a name="line.72"></a>
<span class="sourceLineNo">073</span> }<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span> protected int suffixLength(final String lowFilename) {<a name="line.75"></a>
<span class="sourceLineNo">076</span> for (final FileExtension extension : FileExtension.values()) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> if (extension.isExtensionFor(lowFilename)) {<a name="line.77"></a>
<span class="sourceLineNo">078</span> return extension.length();<a name="line.78"></a>
<span class="sourceLineNo">079</span> }<a name="line.79"></a>
<span class="sourceLineNo">080</span> }<a name="line.80"></a>
<span class="sourceLineNo">081</span> return 0;<a name="line.81"></a>
<span class="sourceLineNo">082</span> }<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span><a name="line.84"></a>
<span class="sourceLineNo">085</span> protected SortedMap&lt;Integer, Path&gt; getEligibleFiles(final RollingFileManager manager) {<a name="line.85"></a>
<span class="sourceLineNo">086</span> return getEligibleFiles(manager, true);<a name="line.86"></a>
<span class="sourceLineNo">087</span> }<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> protected SortedMap&lt;Integer, Path&gt; getEligibleFiles(final RollingFileManager manager,<a name="line.89"></a>
<span class="sourceLineNo">090</span> final boolean isAscending) {<a name="line.90"></a>
<span class="sourceLineNo">091</span> final StringBuilder buf = new StringBuilder();<a name="line.91"></a>
<span class="sourceLineNo">092</span> final String pattern = manager.getPatternProcessor().getPattern();<a name="line.92"></a>
<span class="sourceLineNo">093</span> manager.getPatternProcessor().formatFileName(strSubstitutor, buf, NotANumber.NAN);<a name="line.93"></a>
<span class="sourceLineNo">094</span> final String fileName = manager.isDirectWrite() ? "" : manager.getFileName();<a name="line.94"></a>
<span class="sourceLineNo">095</span> return getEligibleFiles(fileName, buf.toString(), pattern, isAscending);<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> protected SortedMap&lt;Integer, Path&gt; getEligibleFiles(final String path, final String pattern) {<a name="line.98"></a>
<span class="sourceLineNo">099</span> return getEligibleFiles("", path, pattern, true);<a name="line.99"></a>
<span class="sourceLineNo">100</span> }<a name="line.100"></a>
<span class="sourceLineNo">101</span><a name="line.101"></a>
<span class="sourceLineNo">102</span> @Deprecated<a name="line.102"></a>
<span class="sourceLineNo">103</span> protected SortedMap&lt;Integer, Path&gt; getEligibleFiles(final String path, final String logfilePattern,<a name="line.103"></a>
<span class="sourceLineNo">104</span> final boolean isAscending) {<a name="line.104"></a>
<span class="sourceLineNo">105</span> return getEligibleFiles("", path, logfilePattern, isAscending);<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span><a name="line.107"></a>
<span class="sourceLineNo">108</span> protected SortedMap&lt;Integer, Path&gt; getEligibleFiles(final String currentFile, final String path,<a name="line.108"></a>
<span class="sourceLineNo">109</span> final String logfilePattern, final boolean isAscending) {<a name="line.109"></a>
<span class="sourceLineNo">110</span> final TreeMap&lt;Integer, Path&gt; eligibleFiles = new TreeMap&lt;&gt;();<a name="line.110"></a>
<span class="sourceLineNo">111</span> final File file = new File(path);<a name="line.111"></a>
<span class="sourceLineNo">112</span> File parent = file.getParentFile();<a name="line.112"></a>
<span class="sourceLineNo">113</span> if (parent == null) {<a name="line.113"></a>
<span class="sourceLineNo">114</span> parent = new File(".");<a name="line.114"></a>
<span class="sourceLineNo">115</span> } else {<a name="line.115"></a>
<span class="sourceLineNo">116</span> parent.mkdirs();<a name="line.116"></a>
<span class="sourceLineNo">117</span> }<a name="line.117"></a>
<span class="sourceLineNo">118</span> if (!PATTERN_COUNTER.matcher(logfilePattern).matches()) {<a name="line.118"></a>
<span class="sourceLineNo">119</span> return eligibleFiles;<a name="line.119"></a>
<span class="sourceLineNo">120</span> }<a name="line.120"></a>
<span class="sourceLineNo">121</span> final Path dir = parent.toPath();<a name="line.121"></a>
<span class="sourceLineNo">122</span> String fileName = file.getName();<a name="line.122"></a>
<span class="sourceLineNo">123</span> final int suffixLength = suffixLength(fileName);<a name="line.123"></a>
<span class="sourceLineNo">124</span> if (suffixLength &gt; 0) {<a name="line.124"></a>
<span class="sourceLineNo">125</span> fileName = fileName.substring(0, fileName.length() - suffixLength) + ".*";<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span> final String filePattern = fileName.replaceFirst("0?\\u0000", "(0?\\\\d+)");<a name="line.127"></a>
<span class="sourceLineNo">128</span> final Pattern pattern = Pattern.compile(filePattern);<a name="line.128"></a>
<span class="sourceLineNo">129</span> final Path current = currentFile.length() &gt; 0 ? new File(currentFile).toPath() : null;<a name="line.129"></a>
<span class="sourceLineNo">130</span> LOGGER.debug("Current file: {}", currentFile);<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span> try (DirectoryStream&lt;Path&gt; stream = Files.newDirectoryStream(dir)) {<a name="line.132"></a>
<span class="sourceLineNo">133</span> for (final Path entry: stream) {<a name="line.133"></a>
<span class="sourceLineNo">134</span> final Matcher matcher = pattern.matcher(entry.toFile().getName());<a name="line.134"></a>
<span class="sourceLineNo">135</span> if (matcher.matches() &amp;&amp; !entry.equals(current)) {<a name="line.135"></a>
<span class="sourceLineNo">136</span> try {<a name="line.136"></a>
<span class="sourceLineNo">137</span> final Integer index = Integer.parseInt(matcher.group(1));<a name="line.137"></a>
<span class="sourceLineNo">138</span> eligibleFiles.put(index, entry);<a name="line.138"></a>
<span class="sourceLineNo">139</span> } catch (NumberFormatException ex) {<a name="line.139"></a>
<span class="sourceLineNo">140</span> LOGGER.debug("Ignoring file {} which matches pattern but the index is invalid.",<a name="line.140"></a>
<span class="sourceLineNo">141</span> entry.toFile().getName());<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span> }<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span> } catch (final IOException ioe) {<a name="line.145"></a>
<span class="sourceLineNo">146</span> throw new LoggingException("Error reading folder " + dir + " " + ioe.getMessage(), ioe);<a name="line.146"></a>
<span class="sourceLineNo">147</span> }<a name="line.147"></a>
<span class="sourceLineNo">148</span> return isAscending? eligibleFiles : eligibleFiles.descendingMap();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span>}<a name="line.150"></a>
</pre>
</div>
</body>
</html>