001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.appender.rolling.action; 018 019import java.nio.file.FileSystem; 020import java.nio.file.FileSystems; 021import java.nio.file.Path; 022import java.nio.file.PathMatcher; 023import java.nio.file.attribute.BasicFileAttributes; 024import java.util.Arrays; 025import java.util.Collections; 026import java.util.List; 027import java.util.regex.Pattern; 028 029import org.apache.logging.log4j.Logger; 030import org.apache.logging.log4j.core.Core; 031import org.apache.logging.log4j.core.config.plugins.Plugin; 032import org.apache.logging.log4j.core.config.plugins.PluginAttribute; 033import org.apache.logging.log4j.core.config.plugins.PluginElement; 034import org.apache.logging.log4j.core.config.plugins.PluginFactory; 035import org.apache.logging.log4j.status.StatusLogger; 036 037/** 038 * PathCondition that accepts files for deletion if their relative path matches either a glob pattern or a regular 039 * expression. If both a regular expression and a glob pattern are specified the glob pattern is used and the regular 040 * expression is ignored. 041 * <p> 042 * The regular expression is a pattern as defined by the {@link Pattern} class. A glob is a simplified pattern 043 * expression described in {@link FileSystem#getPathMatcher(String)}. 044 */ 045@Plugin(name = "IfFileName", category = Core.CATEGORY_NAME, printObject = true) 046public final class IfFileName implements PathCondition { 047 private static final Logger LOGGER = StatusLogger.getLogger(); 048 private final PathMatcher pathMatcher; 049 private final String syntaxAndPattern; 050 private final PathCondition[] nestedConditions; 051 052 /** 053 * Constructs a FileNameFilter filter. If both a regular expression and a glob pattern are specified the glob 054 * pattern is used and the regular expression is ignored. 055 * 056 * @param glob the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts) 057 * @param regex the regular expression that matches the baseDir-relative path of the file(s) to delete 058 * @param nestedConditions nested conditions to evaluate if this condition accepts a path 059 */ 060 private IfFileName(final String glob, final String regex, final PathCondition[] nestedConditions) { 061 if (regex == null && glob == null) { 062 throw new IllegalArgumentException("Specify either a path glob or a regular expression. " 063 + "Both cannot be null."); 064 } 065 this.syntaxAndPattern = createSyntaxAndPatternString(glob, regex); 066 this.pathMatcher = FileSystems.getDefault().getPathMatcher(syntaxAndPattern); 067 this.nestedConditions = nestedConditions == null ? new PathCondition[0] : Arrays.copyOf(nestedConditions, 068 nestedConditions.length); 069 } 070 071 static String createSyntaxAndPatternString(final String glob, final String regex) { 072 if (glob != null) { 073 return glob.startsWith("glob:") ? glob : "glob:" + glob; 074 } 075 return regex.startsWith("regex:") ? regex : "regex:" + regex; 076 } 077 078 /** 079 * Returns the baseDir-relative path pattern of the files to delete. The returned string takes the form 080 * {@code syntax:pattern} where syntax is one of "glob" or "regex" and the pattern is either a {@linkplain Pattern 081 * regular expression} or a simplified pattern expression described under "glob" in 082 * {@link FileSystem#getPathMatcher(String)}. 083 * 084 * @return relative path of the file(s) to delete (may contain regular expression or wildcarts) 085 */ 086 public String getSyntaxAndPattern() { 087 return syntaxAndPattern; 088 } 089 090 public List<PathCondition> getNestedConditions() { 091 return Collections.unmodifiableList(Arrays.asList(nestedConditions)); 092 } 093 094 /* 095 * (non-Javadoc) 096 * 097 * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path, 098 * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes) 099 */ 100 @Override 101 public boolean accept(final Path basePath, final Path relativePath, final BasicFileAttributes attrs) { 102 final boolean result = pathMatcher.matches(relativePath); 103 104 final String match = result ? "matches" : "does not match"; 105 final String accept = result ? "ACCEPTED" : "REJECTED"; 106 LOGGER.trace("IfFileName {}: '{}' {} relative path '{}'", accept, syntaxAndPattern, match, relativePath); 107 if (result) { 108 return IfAll.accept(nestedConditions, basePath, relativePath, attrs); 109 } 110 return result; 111 } 112 113 /* 114 * (non-Javadoc) 115 * 116 * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk() 117 */ 118 @Override 119 public void beforeFileTreeWalk() { 120 IfAll.beforeFileTreeWalk(nestedConditions); 121 } 122 123 /** 124 * Creates a IfFileName condition that returns true if either the specified 125 * {@linkplain FileSystem#getPathMatcher(String) glob pattern} or the regular expression matches the relative path. 126 * If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression 127 * is ignored. 128 * 129 * @param glob the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts) 130 * @param regex the regular expression that matches the baseDir-relative path of the file(s) to delete 131 * @param nestedConditions nested conditions to evaluate if this condition accepts a path 132 * @return A IfFileName condition. 133 * @see FileSystem#getPathMatcher(String) 134 */ 135 @PluginFactory 136 public static IfFileName createNameCondition( 137 // @formatter:off 138 @PluginAttribute("glob") final String glob, 139 @PluginAttribute("regex") final String regex, 140 @PluginElement("PathConditions") final PathCondition... nestedConditions) { 141 // @formatter:on 142 return new IfFileName(glob, regex, nestedConditions); 143 } 144 145 @Override 146 public String toString() { 147 final String nested = nestedConditions.length == 0 ? "" : " AND " + Arrays.toString(nestedConditions); 148 return "IfFileName(" + syntaxAndPattern + nested + ")"; 149 } 150}