| <!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.action;<a name="line.17"></a> |
| <span class="sourceLineNo">018</span><a name="line.18"></a> |
| <span class="sourceLineNo">019</span>import java.nio.file.FileSystem;<a name="line.19"></a> |
| <span class="sourceLineNo">020</span>import java.nio.file.FileSystems;<a name="line.20"></a> |
| <span class="sourceLineNo">021</span>import java.nio.file.Path;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.file.PathMatcher;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.nio.file.attribute.BasicFileAttributes;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.Arrays;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Collections;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.List;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.regex.Pattern;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span><a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.Logger;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.Core;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.35"></a> |
| <span class="sourceLineNo">036</span><a name="line.36"></a> |
| <span class="sourceLineNo">037</span>/**<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular<a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * expression. If both a regular expression and a glob pattern are specified the glob pattern is used and the regular<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * expression is ignored.<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> * <p><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * The regular expression is a pattern as defined by the {@link Pattern} class. A glob is a simplified pattern<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * expression described in {@link FileSystem#getPathMatcher(String)}.<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> */<a name="line.44"></a> |
| <span class="sourceLineNo">045</span>@Plugin(name = "IfFileName", category = Core.CATEGORY_NAME, printObject = true)<a name="line.45"></a> |
| <span class="sourceLineNo">046</span>public final class IfFileName implements PathCondition {<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> private final PathMatcher pathMatcher;<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> private final String syntaxAndPattern;<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> private final PathCondition[] nestedConditions;<a name="line.50"></a> |
| <span class="sourceLineNo">051</span><a name="line.51"></a> |
| <span class="sourceLineNo">052</span> /**<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * Constructs a FileNameFilter filter. If both a regular expression and a glob pattern are specified the glob<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * pattern is used and the regular expression is ignored.<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> *<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * @param glob the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts)<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param regex the regular expression that matches the baseDir-relative path of the file(s) to delete<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param nestedConditions nested conditions to evaluate if this condition accepts a path<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> */<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> private IfFileName(final String glob, final String regex, final PathCondition[] nestedConditions) {<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> if (regex == null && glob == null) {<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> throw new IllegalArgumentException("Specify either a path glob or a regular expression. "<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> + "Both cannot be null.");<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> }<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> this.syntaxAndPattern = createSyntaxAndPatternString(glob, regex);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.pathMatcher = FileSystems.getDefault().getPathMatcher(syntaxAndPattern);<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> this.nestedConditions = nestedConditions == null ? new PathCondition[0] : Arrays.copyOf(nestedConditions,<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> nestedConditions.length);<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> }<a name="line.69"></a> |
| <span class="sourceLineNo">070</span><a name="line.70"></a> |
| <span class="sourceLineNo">071</span> static String createSyntaxAndPatternString(final String glob, final String regex) {<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> if (glob != null) {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> return glob.startsWith("glob:") ? glob : "glob:" + glob;<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> }<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> return regex.startsWith("regex:") ? regex : "regex:" + regex;<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> }<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> /**<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * Returns the baseDir-relative path pattern of the files to delete. The returned string takes the form<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * {@code syntax:pattern} where syntax is one of "glob" or "regex" and the pattern is either a {@linkplain Pattern<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * regular expression} or a simplified pattern expression described under "glob" in<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * {@link FileSystem#getPathMatcher(String)}.<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> *<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> * @return relative path of the file(s) to delete (may contain regular expression or wildcarts)<a name="line.84"></a> |
| <span class="sourceLineNo">085</span> */<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> public String getSyntaxAndPattern() {<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> return syntaxAndPattern;<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> }<a name="line.88"></a> |
| <span class="sourceLineNo">089</span><a name="line.89"></a> |
| <span class="sourceLineNo">090</span> public List<PathCondition> getNestedConditions() {<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> return Collections.unmodifiableList(Arrays.asList(nestedConditions));<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> }<a name="line.92"></a> |
| <span class="sourceLineNo">093</span><a name="line.93"></a> |
| <span class="sourceLineNo">094</span> /*<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> * (non-Javadoc)<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> *<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path,<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> @Override<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> public boolean accept(final Path basePath, final Path relativePath, final BasicFileAttributes attrs) {<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> final boolean result = pathMatcher.matches(relativePath);<a name="line.102"></a> |
| <span class="sourceLineNo">103</span><a name="line.103"></a> |
| <span class="sourceLineNo">104</span> final String match = result ? "matches" : "does not match";<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> final String accept = result ? "ACCEPTED" : "REJECTED";<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> LOGGER.trace("IfFileName {}: '{}' {} relative path '{}'", accept, syntaxAndPattern, match, relativePath);<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> if (result) {<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> return IfAll.accept(nestedConditions, basePath, relativePath, attrs);<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> }<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> return result;<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> }<a name="line.111"></a> |
| <span class="sourceLineNo">112</span><a name="line.112"></a> |
| <span class="sourceLineNo">113</span> /*<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> * (non-Javadoc)<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> *<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> */<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> @Override<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> public void beforeFileTreeWalk() {<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> IfAll.beforeFileTreeWalk(nestedConditions);<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> }<a name="line.121"></a> |
| <span class="sourceLineNo">122</span><a name="line.122"></a> |
| <span class="sourceLineNo">123</span> /**<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * Creates a IfFileName condition that returns true if either the specified<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * {@linkplain FileSystem#getPathMatcher(String) glob pattern} or the regular expression matches the relative path.<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * is ignored.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> *<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @param glob the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts)<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @param regex the regular expression that matches the baseDir-relative path of the file(s) to delete<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> * @param nestedConditions nested conditions to evaluate if this condition accepts a path<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * @return A IfFileName condition.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> * @see FileSystem#getPathMatcher(String)<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> */<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> @PluginFactory<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> public static IfFileName createNameCondition(<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> // @formatter:off<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> @PluginAttribute("glob") final String glob,<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> @PluginAttribute("regex") final String regex,<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> @PluginElement("PathConditions") final PathCondition... nestedConditions) {<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> // @formatter:on<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> return new IfFileName(glob, regex, nestedConditions);<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> @Override<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> public String toString() {<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> final String nested = nestedConditions.length == 0 ? "" : " AND " + Arrays.toString(nestedConditions);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> return "IfFileName(" + syntaxAndPattern + nested + ")";<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> |
