| <!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><a name="line.17"></a> |
| <span class="sourceLineNo">018</span>package org.apache.logging.log4j.core.appender.rolling.action;<a name="line.18"></a> |
| <span class="sourceLineNo">019</span><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.FileVisitOption;<a name="line.21"></a> |
| <span class="sourceLineNo">022</span>import java.nio.file.FileVisitor;<a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.nio.file.Files;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.nio.file.Path;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.nio.file.Paths;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span>import java.util.Arrays;<a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import java.util.Collections;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import java.util.EnumSet;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import java.util.List;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import java.util.Set;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import java.util.concurrent.TimeUnit;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span><a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span><a name="line.34"></a> |
| <span class="sourceLineNo">035</span>/**<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * Abstract action for processing files that are accepted by the specified PathFilters.<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> */<a name="line.37"></a> |
| <span class="sourceLineNo">038</span>public abstract class AbstractPathAction extends AbstractAction {<a name="line.38"></a> |
| <span class="sourceLineNo">039</span><a name="line.39"></a> |
| <span class="sourceLineNo">040</span> private final String basePathString;<a name="line.40"></a> |
| <span class="sourceLineNo">041</span> private final Set<FileVisitOption> options;<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private final int maxDepth;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private final List<PathCondition> pathConditions;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private final StrSubstitutor subst;<a name="line.44"></a> |
| <span class="sourceLineNo">045</span><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> /**<a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * Creates a new AbstractPathAction that starts scanning for files to process from the specified base path.<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> *<a name="line.48"></a> |
| <span class="sourceLineNo">049</span> * @param basePath base path from where to start scanning for files to process.<a name="line.49"></a> |
| <span class="sourceLineNo">050</span> * @param followSymbolicLinks whether to follow symbolic links. Default is false.<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> * @param maxDepth The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> * means that only the starting file is visited, unless denied by the security manager. A value of<a name="line.52"></a> |
| <span class="sourceLineNo">053</span> * MAX_VALUE may be used to indicate that all levels should be visited.<a name="line.53"></a> |
| <span class="sourceLineNo">054</span> * @param pathFilters an array of path filters (if more than one, they all need to accept a path before it is<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * processed).<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> */<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> protected AbstractPathAction(final String basePath, final boolean followSymbolicLinks, final int maxDepth,<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> final PathCondition[] pathFilters, final StrSubstitutor subst) {<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> this.basePathString = basePath;<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> this.options = followSymbolicLinks ? EnumSet.of(FileVisitOption.FOLLOW_LINKS)<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> : Collections.<FileVisitOption> emptySet();<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> this.maxDepth = maxDepth;<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> this.pathConditions = Arrays.asList(Arrays.copyOf(pathFilters, pathFilters.length));<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> this.subst = subst;<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> }<a name="line.65"></a> |
| <span class="sourceLineNo">066</span><a name="line.66"></a> |
| <span class="sourceLineNo">067</span> @Override<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> public boolean execute() throws IOException {<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> return execute(createFileVisitor(getBasePath(), pathConditions));<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> }<a name="line.70"></a> |
| <span class="sourceLineNo">071</span><a name="line.71"></a> |
| <span class="sourceLineNo">072</span> public boolean execute(final FileVisitor<Path> visitor) throws IOException {<a name="line.72"></a> |
| <span class="sourceLineNo">073</span> final long start = System.nanoTime();<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> LOGGER.debug("Starting {}", this);<a name="line.74"></a> |
| <span class="sourceLineNo">075</span><a name="line.75"></a> |
| <span class="sourceLineNo">076</span> Files.walkFileTree(getBasePath(), options, maxDepth, visitor);<a name="line.76"></a> |
| <span class="sourceLineNo">077</span><a name="line.77"></a> |
| <span class="sourceLineNo">078</span> final double duration = System.nanoTime() - start;<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> LOGGER.debug("{} complete in {} seconds", getClass().getSimpleName(), duration / TimeUnit.SECONDS.toNanos(1));<a name="line.79"></a> |
| <span class="sourceLineNo">080</span><a name="line.80"></a> |
| <span class="sourceLineNo">081</span> // TODO return (visitor.success || ignoreProcessingFailure)<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return true; // do not abort rollover even if processing failed<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> /**<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> * Creates a new {@code FileVisitor<Path>} to pass to the {@link Files#walkFileTree(Path, Set, int, FileVisitor)}<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * method when the {@link #execute()} method is invoked.<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <p><a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * The visitor is responsible for processing the files it encounters that are accepted by all filters.<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @param visitorBaseDir base dir from where to start scanning for files to process<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> * @param conditions filters that determine if a file should be processed<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> * @return a new {@code FileVisitor<Path>}<a name="line.93"></a> |
| <span class="sourceLineNo">094</span> */<a name="line.94"></a> |
| <span class="sourceLineNo">095</span> protected abstract FileVisitor<Path> createFileVisitor(final Path visitorBaseDir,<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final List<PathCondition> conditions);<a name="line.96"></a> |
| <span class="sourceLineNo">097</span><a name="line.97"></a> |
| <span class="sourceLineNo">098</span> /**<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> * Returns the base path from where to start scanning for files to delete. Lookups are resolved, so if the<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> * configuration was <code>&lt;Delete basePath="${sys:user.home}/abc" /&gt;</code> then this method returns a path<a name="line.100"></a> |
| <span class="sourceLineNo">101</span> * to the "abc" file or directory in the user's home directory.<a name="line.101"></a> |
| <span class="sourceLineNo">102</span> *<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * @return the base path (all lookups resolved)<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> */<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> public Path getBasePath() {<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> return Paths.get(subst.replace(getBasePathString()));<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> }<a name="line.107"></a> |
| <span class="sourceLineNo">108</span><a name="line.108"></a> |
| <span class="sourceLineNo">109</span> /**<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> * Returns the base path as it was specified in the configuration. Lookups are not resolved.<a name="line.110"></a> |
| <span class="sourceLineNo">111</span> *<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * @return the base path as it was specified in the configuration<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> */<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> public String getBasePathString() {<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> return basePathString;<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> }<a name="line.116"></a> |
| <span class="sourceLineNo">117</span><a name="line.117"></a> |
| <span class="sourceLineNo">118</span> public StrSubstitutor getStrSubstitutor() {<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> return subst;<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> }<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> * Returns whether to follow symbolic links or not.<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> *<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> * @return the options<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> */<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> public Set<FileVisitOption> getOptions() {<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> return Collections.unmodifiableSet(options);<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> }<a name="line.129"></a> |
| <span class="sourceLineNo">130</span><a name="line.130"></a> |
| <span class="sourceLineNo">131</span> /**<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> * Returns whether to follow symbolic links or not.<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> *<a name="line.133"></a> |
| <span class="sourceLineNo">134</span> * @return whether to follow symbolic links or not<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> */<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> public boolean isFollowSymbolicLinks() {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> return options.contains(FileVisitOption.FOLLOW_LINKS);<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> }<a name="line.138"></a> |
| <span class="sourceLineNo">139</span><a name="line.139"></a> |
| <span class="sourceLineNo">140</span> /**<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> * Returns the the maximum number of directory levels to visit.<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> *<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * @return the maxDepth<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> */<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> public int getMaxDepth() {<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> return maxDepth;<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> }<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /**<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * Returns the list of PathCondition objects.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> *<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @return the pathFilters<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> */<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> public List<PathCondition> getPathConditions() {<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> return Collections.unmodifiableList(pathConditions);<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> }<a name="line.156"></a> |
| <span class="sourceLineNo">157</span><a name="line.157"></a> |
| <span class="sourceLineNo">158</span> @Override<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> public String toString() {<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> return getClass().getSimpleName() + "[basePath=" + getBasePath() + ", options=" + options + ", maxDepth="<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> + maxDepth + ", conditions=" + pathConditions + "]";<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> }<a name="line.162"></a> |
| <span class="sourceLineNo">163</span>}<a name="line.163"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
