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 = PathCondition.copy(nestedConditions);
068    }
069
070    static String createSyntaxAndPatternString(final String glob, final String regex) {
071        if (glob != null) {
072            return glob.startsWith("glob:") ? glob : "glob:" + glob;
073        }
074        return regex.startsWith("regex:") ? regex : "regex:" + regex;
075    }
076
077    /**
078     * Returns the baseDir-relative path pattern of the files to delete. The returned string takes the form
079     * {@code syntax:pattern} where syntax is one of "glob" or "regex" and the pattern is either a {@linkplain Pattern
080     * regular expression} or a simplified pattern expression described under "glob" in
081     * {@link FileSystem#getPathMatcher(String)}.
082     *
083     * @return relative path of the file(s) to delete (may contain regular expression or wildcarts)
084     */
085    public String getSyntaxAndPattern() {
086        return syntaxAndPattern;
087    }
088
089    public List<PathCondition> getNestedConditions() {
090        return Collections.unmodifiableList(Arrays.asList(nestedConditions));
091    }
092
093    /*
094     * (non-Javadoc)
095     *
096     * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#accept(java.nio.file.Path,
097     * java.nio.file.Path, java.nio.file.attribute.BasicFileAttributes)
098     */
099    @Override
100    public boolean accept(final Path basePath, final Path relativePath, final BasicFileAttributes attrs) {
101        final boolean result = pathMatcher.matches(relativePath);
102
103        final String match = result ? "matches" : "does not match";
104        final String accept = result ? "ACCEPTED" : "REJECTED";
105        LOGGER.trace("IfFileName {}: '{}' {} relative path '{}'", accept, syntaxAndPattern, match, relativePath);
106        if (result) {
107            return IfAll.accept(nestedConditions, basePath, relativePath, attrs);
108        }
109        return result;
110    }
111
112    /*
113     * (non-Javadoc)
114     *
115     * @see org.apache.logging.log4j.core.appender.rolling.action.PathCondition#beforeFileTreeWalk()
116     */
117    @Override
118    public void beforeFileTreeWalk() {
119        IfAll.beforeFileTreeWalk(nestedConditions);
120    }
121
122    /**
123     * Creates a IfFileName condition that returns true if either the specified
124     * {@linkplain FileSystem#getPathMatcher(String) glob pattern} or the regular expression matches the relative path.
125     * If both a regular expression and a glob pattern are specified the glob pattern is used and the regular expression
126     * is ignored.
127     *
128     * @param glob the baseDir-relative path pattern of the files to delete (may contain '*' and '?' wildcarts)
129     * @param regex the regular expression that matches the baseDir-relative path of the file(s) to delete
130     * @param nestedConditions nested conditions to evaluate if this condition accepts a path
131     * @return A IfFileName condition.
132     * @see FileSystem#getPathMatcher(String)
133     */
134    @PluginFactory
135    public static IfFileName createNameCondition(
136            // @formatter:off
137            @PluginAttribute("glob") final String glob,
138            @PluginAttribute("regex") final String regex,
139            @PluginElement("PathConditions") final PathCondition... nestedConditions) {
140            // @formatter:on
141        return new IfFileName(glob, regex, nestedConditions);
142    }
143
144    @Override
145    public String toString() {
146        final String nested = nestedConditions.length == 0 ? "" : " AND " + Arrays.toString(nestedConditions);
147        return "IfFileName(" + syntaxAndPattern + nested + ")";
148    }
149}