| <!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.FileVisitor;<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.List;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.Objects;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.Core;<a name="line.27"></a> |
| <span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.Configuration;<a name="line.28"></a> |
| <span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.29"></a> |
| <span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.PluginAttribute;<a name="line.30"></a> |
| <span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;<a name="line.31"></a> |
| <span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.32"></a> |
| <span class="sourceLineNo">033</span>import org.apache.logging.log4j.core.config.plugins.PluginFactory;<a name="line.33"></a> |
| <span class="sourceLineNo">034</span>import org.apache.logging.log4j.core.lookup.StrSubstitutor;<a name="line.34"></a> |
| <span class="sourceLineNo">035</span><a name="line.35"></a> |
| <span class="sourceLineNo">036</span>/**<a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> */<a name="line.38"></a> |
| <span class="sourceLineNo">039</span>@Plugin(name = "Delete", category = Core.CATEGORY_NAME, printObject = true)<a name="line.39"></a> |
| <span class="sourceLineNo">040</span>public class DeleteAction extends AbstractPathAction {<a name="line.40"></a> |
| <span class="sourceLineNo">041</span><a name="line.41"></a> |
| <span class="sourceLineNo">042</span> private final PathSorter pathSorter;<a name="line.42"></a> |
| <span class="sourceLineNo">043</span> private final boolean testMode;<a name="line.43"></a> |
| <span class="sourceLineNo">044</span> private final ScriptCondition scriptCondition;<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 DeleteAction that starts scanning for files to delete 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 delete.<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 testMode if true, files are not deleted but instead a message is printed to the <a<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * href="http://logging.apache.org/log4j/2.x/manual/configuration.html#StatusMessages">status logger</a><a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * at INFO level. Users can use this to do a dry run to test if their configuration works as expected.<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @param sorter sorts<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> * @param pathConditions an array of path filters (if more than one, they all need to accept a path before it is<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> * deleted).<a name="line.59"></a> |
| <span class="sourceLineNo">060</span> * @param scriptCondition<a name="line.60"></a> |
| <span class="sourceLineNo">061</span> */<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> DeleteAction(final String basePath, final boolean followSymbolicLinks, final int maxDepth, final boolean testMode,<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> final PathSorter sorter, final PathCondition[] pathConditions, final ScriptCondition scriptCondition,<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> final StrSubstitutor subst) {<a name="line.64"></a> |
| <span class="sourceLineNo">065</span> super(basePath, followSymbolicLinks, maxDepth, pathConditions, subst);<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> this.testMode = testMode;<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> this.pathSorter = Objects.requireNonNull(sorter, "sorter");<a name="line.67"></a> |
| <span class="sourceLineNo">068</span> this.scriptCondition = scriptCondition;<a name="line.68"></a> |
| <span class="sourceLineNo">069</span> if (scriptCondition == null && (pathConditions == null || pathConditions.length == 0)) {<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> LOGGER.error("Missing Delete conditions: unconditional Delete not supported");<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> throw new IllegalArgumentException("Unconditional Delete not supported");<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> }<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> /*<a name="line.75"></a> |
| <span class="sourceLineNo">076</span> * (non-Javadoc)<a name="line.76"></a> |
| <span class="sourceLineNo">077</span> *<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * @see org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction#execute()<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> */<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> @Override<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> public boolean execute() throws IOException {<a name="line.81"></a> |
| <span class="sourceLineNo">082</span> return scriptCondition != null ? executeScript() : super.execute();<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> private boolean executeScript() throws IOException {<a name="line.85"></a> |
| <span class="sourceLineNo">086</span> final List<PathWithAttributes> selectedForDeletion = callScript();<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> if (selectedForDeletion == null) {<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> LOGGER.trace("Script returned null list (no files to delete)");<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> return true;<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> }<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> deleteSelectedFiles(selectedForDeletion);<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> return true;<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> private List<PathWithAttributes> callScript() throws IOException {<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> final List<PathWithAttributes> sortedPaths = getSortedPaths();<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> trace("Sorted paths:", sortedPaths);<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> final List<PathWithAttributes> result = scriptCondition.selectFilesToDelete(getBasePath(), sortedPaths);<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> return result;<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> private void deleteSelectedFiles(final List<PathWithAttributes> selectedForDeletion) throws IOException {<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> trace("Paths the script selected for deletion:", selectedForDeletion);<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> for (final PathWithAttributes pathWithAttributes : selectedForDeletion) {<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> final Path path = pathWithAttributes == null ? null : pathWithAttributes.getPath();<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> if (isTestMode()) {<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> LOGGER.info("Deleting {} (TEST MODE: file not actually deleted)", path);<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> } else {<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> delete(path);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span> }<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> /**<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * Deletes the specified file.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> *<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @param path the file to delete<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> * @throws IOException if a problem occurred deleting the file<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> */<a name="line.119"></a> |
| <span class="sourceLineNo">120</span> protected void delete(final Path path) throws IOException {<a name="line.120"></a> |
| <span class="sourceLineNo">121</span> LOGGER.trace("Deleting {}", path);<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> Files.deleteIfExists(path);<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> }<a name="line.123"></a> |
| <span class="sourceLineNo">124</span><a name="line.124"></a> |
| <span class="sourceLineNo">125</span> /*<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * (non-Javadoc)<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> *<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @see org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction#execute(FileVisitor)<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> */<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> @Override<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> public boolean execute(final FileVisitor<Path> visitor) throws IOException {<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> final List<PathWithAttributes> sortedPaths = getSortedPaths();<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> trace("Sorted paths:", sortedPaths);<a name="line.133"></a> |
| <span class="sourceLineNo">134</span><a name="line.134"></a> |
| <span class="sourceLineNo">135</span> for (final PathWithAttributes element : sortedPaths) {<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> try {<a name="line.136"></a> |
| <span class="sourceLineNo">137</span> visitor.visitFile(element.getPath(), element.getAttributes());<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> } catch (final IOException ioex) {<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> LOGGER.error("Error in post-rollover Delete when visiting {}", element.getPath(), ioex);<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> visitor.visitFileFailed(element.getPath(), ioex);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span> }<a name="line.141"></a> |
| <span class="sourceLineNo">142</span> }<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> // TODO return (visitor.success || ignoreProcessingFailure)<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> return true; // do not abort rollover even if processing failed<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> }<a name="line.145"></a> |
| <span class="sourceLineNo">146</span><a name="line.146"></a> |
| <span class="sourceLineNo">147</span> private void trace(final String label, final List<PathWithAttributes> sortedPaths) {<a name="line.147"></a> |
| <span class="sourceLineNo">148</span> LOGGER.trace(label);<a name="line.148"></a> |
| <span class="sourceLineNo">149</span> for (final PathWithAttributes pathWithAttributes : sortedPaths) {<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> LOGGER.trace(pathWithAttributes);<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> }<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> }<a name="line.152"></a> |
| <span class="sourceLineNo">153</span><a name="line.153"></a> |
| <span class="sourceLineNo">154</span> /**<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * Returns a sorted list of all files up to maxDepth under the basePath.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> *<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @return a sorted list of files<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> * @throws IOException<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> */<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> List<PathWithAttributes> getSortedPaths() throws IOException {<a name="line.160"></a> |
| <span class="sourceLineNo">161</span> final SortingVisitor sort = new SortingVisitor(pathSorter);<a name="line.161"></a> |
| <span class="sourceLineNo">162</span> super.execute(sort);<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> final List<PathWithAttributes> sortedPaths = sort.getSortedPaths();<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> return sortedPaths;<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> }<a name="line.165"></a> |
| <span class="sourceLineNo">166</span><a name="line.166"></a> |
| <span class="sourceLineNo">167</span> /**<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * Returns {@code true} if files are not deleted even when all conditions accept a path, {@code false} otherwise.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> *<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * @return {@code true} if files are not deleted even when all conditions accept a path, {@code false} otherwise<a name="line.170"></a> |
| <span class="sourceLineNo">171</span> */<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> public boolean isTestMode() {<a name="line.172"></a> |
| <span class="sourceLineNo">173</span> return testMode;<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> }<a name="line.174"></a> |
| <span class="sourceLineNo">175</span><a name="line.175"></a> |
| <span class="sourceLineNo">176</span> @Override<a name="line.176"></a> |
| <span class="sourceLineNo">177</span> protected FileVisitor<Path> createFileVisitor(final Path visitorBaseDir, final List<PathCondition> conditions) {<a name="line.177"></a> |
| <span class="sourceLineNo">178</span> return new DeletingVisitor(visitorBaseDir, conditions, testMode);<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> }<a name="line.179"></a> |
| <span class="sourceLineNo">180</span><a name="line.180"></a> |
| <span class="sourceLineNo">181</span> /**<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * Create a DeleteAction.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> *<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @param basePath base path from where to start scanning for files to delete.<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * @param followLinks whether to follow symbolic links. Default is false.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @param maxDepth The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> * means that only the starting file is visited, unless denied by the security manager. A value of<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> * MAX_VALUE may be used to indicate that all levels should be visited.<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> * @param testMode if true, files are not deleted but instead a message is printed to the <a<a name="line.189"></a> |
| <span class="sourceLineNo">190</span> * href="http://logging.apache.org/log4j/2.x/manual/configuration.html#StatusMessages">status logger</a><a name="line.190"></a> |
| <span class="sourceLineNo">191</span> * at INFO level. Users can use this to do a dry run to test if their configuration works as expected.<a name="line.191"></a> |
| <span class="sourceLineNo">192</span> * Default is false.<a name="line.192"></a> |
| <span class="sourceLineNo">193</span> * @param PathSorter a plugin implementing the {@link PathSorter} interface<a name="line.193"></a> |
| <span class="sourceLineNo">194</span> * @param PathConditions an array of path conditions (if more than one, they all need to accept a path before it is<a name="line.194"></a> |
| <span class="sourceLineNo">195</span> * deleted).<a name="line.195"></a> |
| <span class="sourceLineNo">196</span> * @param config The Configuration.<a name="line.196"></a> |
| <span class="sourceLineNo">197</span> * @return A DeleteAction.<a name="line.197"></a> |
| <span class="sourceLineNo">198</span> */<a name="line.198"></a> |
| <span class="sourceLineNo">199</span> @PluginFactory<a name="line.199"></a> |
| <span class="sourceLineNo">200</span> public static DeleteAction createDeleteAction(<a name="line.200"></a> |
| <span class="sourceLineNo">201</span> // @formatter:off<a name="line.201"></a> |
| <span class="sourceLineNo">202</span> @PluginAttribute("basePath") final String basePath,<a name="line.202"></a> |
| <span class="sourceLineNo">203</span> @PluginAttribute(value = "followLinks") final boolean followLinks,<a name="line.203"></a> |
| <span class="sourceLineNo">204</span> @PluginAttribute(value = "maxDepth", defaultInt = 1) final int maxDepth,<a name="line.204"></a> |
| <span class="sourceLineNo">205</span> @PluginAttribute(value = "testMode") final boolean testMode,<a name="line.205"></a> |
| <span class="sourceLineNo">206</span> @PluginElement("PathSorter") final PathSorter sorterParameter,<a name="line.206"></a> |
| <span class="sourceLineNo">207</span> @PluginElement("PathConditions") final PathCondition[] pathConditions,<a name="line.207"></a> |
| <span class="sourceLineNo">208</span> @PluginElement("ScriptCondition") final ScriptCondition scriptCondition,<a name="line.208"></a> |
| <span class="sourceLineNo">209</span> @PluginConfiguration final Configuration config) {<a name="line.209"></a> |
| <span class="sourceLineNo">210</span> // @formatter:on<a name="line.210"></a> |
| <span class="sourceLineNo">211</span> final PathSorter sorter = sorterParameter == null ? new PathSortByModificationTime(true) : sorterParameter;<a name="line.211"></a> |
| <span class="sourceLineNo">212</span> return new DeleteAction(basePath, followLinks, maxDepth, testMode, sorter, pathConditions, scriptCondition,<a name="line.212"></a> |
| <span class="sourceLineNo">213</span> config.getStrSubstitutor());<a name="line.213"></a> |
| <span class="sourceLineNo">214</span> }<a name="line.214"></a> |
| <span class="sourceLineNo">215</span>}<a name="line.215"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
