org.apache.logging.log4j.core.appender.rolling.action.DeleteAction Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of log4j-core Show documentation
Show all versions of log4j-core Show documentation
The Apache Log4j Implementation
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache license, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the license for the specific language governing permissions and
* limitations under the license.
*/
package org.apache.logging.log4j.core.appender.rolling.action;
import java.io.IOException;
import java.nio.file.FileVisitor;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.Objects;
import org.apache.logging.log4j.core.Core;
import org.apache.logging.log4j.core.config.Configuration;
import org.apache.logging.log4j.core.config.plugins.Plugin;
import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
import org.apache.logging.log4j.core.config.plugins.PluginConfiguration;
import org.apache.logging.log4j.core.config.plugins.PluginElement;
import org.apache.logging.log4j.core.config.plugins.PluginFactory;
import org.apache.logging.log4j.core.lookup.StrSubstitutor;
/**
* Rollover or scheduled action for deleting old log files that are accepted by the specified PathFilters.
*/
@Plugin(name = "Delete", category = Core.CATEGORY_NAME, printObject = true)
public class DeleteAction extends AbstractPathAction {
private final PathSorter pathSorter;
private final boolean testMode;
private final ScriptCondition scriptCondition;
/**
* Creates a new DeleteAction that starts scanning for files to delete from the specified base path.
*
* @param basePath base path from where to start scanning for files to delete.
* @param followSymbolicLinks whether to follow symbolic links. Default is false.
* @param maxDepth The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0
* means that only the starting file is visited, unless denied by the security manager. A value of
* MAX_VALUE may be used to indicate that all levels should be visited.
* @param testMode if true, files are not deleted but instead a message is printed to the status logger
* at INFO level. Users can use this to do a dry run to test if their configuration works as expected.
* @param sorter sorts
* @param pathConditions an array of path filters (if more than one, they all need to accept a path before it is
* deleted).
* @param scriptCondition
*/
DeleteAction(final String basePath, final boolean followSymbolicLinks, final int maxDepth, final boolean testMode,
final PathSorter sorter, final PathCondition[] pathConditions, final ScriptCondition scriptCondition,
final StrSubstitutor subst) {
super(basePath, followSymbolicLinks, maxDepth, pathConditions, subst);
this.testMode = testMode;
this.pathSorter = Objects.requireNonNull(sorter, "sorter");
this.scriptCondition = scriptCondition;
if (scriptCondition == null && (pathConditions == null || pathConditions.length == 0)) {
LOGGER.error("Missing Delete conditions: unconditional Delete not supported");
throw new IllegalArgumentException("Unconditional Delete not supported");
}
}
/*
* (non-Javadoc)
*
* @see org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction#execute()
*/
@Override
public boolean execute() throws IOException {
return scriptCondition != null ? executeScript() : super.execute();
}
private boolean executeScript() throws IOException {
final List selectedForDeletion = callScript();
if (selectedForDeletion == null) {
LOGGER.trace("Script returned null list (no files to delete)");
return true;
}
deleteSelectedFiles(selectedForDeletion);
return true;
}
private List callScript() throws IOException {
final List sortedPaths = getSortedPaths();
trace("Sorted paths:", sortedPaths);
final List result = scriptCondition.selectFilesToDelete(getBasePath(), sortedPaths);
return result;
}
private void deleteSelectedFiles(final List selectedForDeletion) throws IOException {
trace("Paths the script selected for deletion:", selectedForDeletion);
for (final PathWithAttributes pathWithAttributes : selectedForDeletion) {
final Path path = pathWithAttributes == null ? null : pathWithAttributes.getPath();
if (isTestMode()) {
LOGGER.info("Deleting {} (TEST MODE: file not actually deleted)", path);
} else {
delete(path);
}
}
}
/**
* Deletes the specified file.
*
* @param path the file to delete
* @throws IOException if a problem occurred deleting the file
*/
protected void delete(final Path path) throws IOException {
LOGGER.trace("Deleting {}", path);
Files.deleteIfExists(path);
}
/*
* (non-Javadoc)
*
* @see org.apache.logging.log4j.core.appender.rolling.action.AbstractPathAction#execute(FileVisitor)
*/
@Override
public boolean execute(final FileVisitor visitor) throws IOException {
final List sortedPaths = getSortedPaths();
trace("Sorted paths:", sortedPaths);
for (final PathWithAttributes element : sortedPaths) {
try {
visitor.visitFile(element.getPath(), element.getAttributes());
} catch (final IOException ioex) {
LOGGER.error("Error in post-rollover Delete when visiting {}", element.getPath(), ioex);
visitor.visitFileFailed(element.getPath(), ioex);
}
}
// TODO return (visitor.success || ignoreProcessingFailure)
return true; // do not abort rollover even if processing failed
}
private void trace(final String label, final List sortedPaths) {
LOGGER.trace(label);
for (final PathWithAttributes pathWithAttributes : sortedPaths) {
LOGGER.trace(pathWithAttributes);
}
}
/**
* Returns a sorted list of all files up to maxDepth under the basePath.
*
* @return a sorted list of files
* @throws IOException
*/
List getSortedPaths() throws IOException {
final SortingVisitor sort = new SortingVisitor(pathSorter);
super.execute(sort);
final List sortedPaths = sort.getSortedPaths();
return sortedPaths;
}
/**
* Returns {@code true} if files are not deleted even when all conditions accept a path, {@code false} otherwise.
*
* @return {@code true} if files are not deleted even when all conditions accept a path, {@code false} otherwise
*/
public boolean isTestMode() {
return testMode;
}
@Override
protected FileVisitor createFileVisitor(final Path visitorBaseDir, final List conditions) {
return new DeletingVisitor(visitorBaseDir, conditions, testMode);
}
/**
* Create a DeleteAction.
*
* @param basePath base path from where to start scanning for files to delete.
* @param followLinks whether to follow symbolic links. Default is false.
* @param maxDepth The maxDepth parameter is the maximum number of levels of directories to visit. A value of 0
* means that only the starting file is visited, unless denied by the security manager. A value of
* MAX_VALUE may be used to indicate that all levels should be visited.
* @param testMode if true, files are not deleted but instead a message is printed to the status logger
* at INFO level. Users can use this to do a dry run to test if their configuration works as expected.
* Default is false.
* @param PathSorter a plugin implementing the {@link PathSorter} interface
* @param PathConditions an array of path conditions (if more than one, they all need to accept a path before it is
* deleted).
* @param config The Configuration.
* @return A DeleteAction.
*/
@PluginFactory
public static DeleteAction createDeleteAction(
// @formatter:off
@PluginAttribute("basePath") final String basePath,
@PluginAttribute(value = "followLinks") final boolean followLinks,
@PluginAttribute(value = "maxDepth", defaultInt = 1) final int maxDepth,
@PluginAttribute(value = "testMode") final boolean testMode,
@PluginElement("PathSorter") final PathSorter sorterParameter,
@PluginElement("PathConditions") final PathCondition[] pathConditions,
@PluginElement("ScriptCondition") final ScriptCondition scriptCondition,
@PluginConfiguration final Configuration config) {
// @formatter:on
final PathSorter sorter = sorterParameter == null ? new PathSortByModificationTime(true) : sorterParameter;
return new DeleteAction(basePath, followLinks, maxDepth, testMode, sorter, pathConditions, scriptCondition,
config.getStrSubstitutor());
}
}