org.sonar.api.utils.WildcardPattern Maven / Gradle / Ivy

/*
 * SonarQube, open source software quality management tool.
 * Copyright (C) 2008-2014 SonarSource
 * mailto:contact AT sonarsource DOT com
 *
 * SonarQube is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * SonarQube is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.api.utils;

import java.util.HashMap;
import java.util.Map;
import java.util.regex.Pattern;

import org.apache.commons.lang.StringUtils;

/**
 * Implementation of Ant-style matching patterns.
 * Contrary to other implementations (like AntPathMatcher from Spring Framework) it is based on {@link Pattern Java Regular Expressions}.
 * To increase performance it holds an internal cache of all processed patterns.
 * 
 * Following rules are applied:
 * 

 * ? matches single character
 * * matches zero or more characters
 * ** matches zero or more 'directories'
 * 
 * 
 * 
 * Some examples of patterns:
 * 

 * org/T?st.java - matches org/Test.java and also org/Tost.java
 * org/*.java - matches all .java files in the org directory,
 * e.g. org/Foo.java or org/Bar.java
 * org/** - matches all files underneath the org directory,
 * e.g. org/Foo.java or org/foo/bar.jsp
 * org/**/Test.java - matches all Test.java files underneath the org directory,
 * e.g. org/Test.java or org/foo/Test.java or org/foo/bar/Test.java
 * org/**/*.java - matches all .java files underneath the org directory,
 * e.g. org/Foo.java or org/foo/Bar.java or org/foo/bar/Baz.java
 * 
 * 
 * 
 * Another implementation, which is also based on Java Regular Expressions, can be found in
 * FileUtil
 * from IntelliJ OpenAPI.
 * 
 * 
 * @since 1.10
 */
public class WildcardPattern {

  private static final Map CACHE = new HashMap();
  private static final String SPECIAL_CHARS = "()[]^$.{}+|";

  private Pattern pattern;
  private String stringRepresentation;

  protected WildcardPattern(String pattern, String directorySeparator) {
    this.stringRepresentation = pattern;
    this.pattern = Pattern.compile(toRegexp(pattern, directorySeparator));
  }

  private static String toRegexp(String antPattern, String directorySeparator) {
    final String escapedDirectorySeparator = '\\' + directorySeparator;

    final StringBuilder sb = new StringBuilder(antPattern.length());

    sb.append('^');

    int i = antPattern.startsWith("/") || antPattern.startsWith("\\") ? 1 : 0;
    while (i < antPattern.length()) {
      final char ch = antPattern.charAt(i);

      if (SPECIAL_CHARS.indexOf(ch) != -1) {
        // Escape regexp-specific characters
        sb.append('\\').append(ch);
      } else if (ch == '*') {
        if (i + 1 < antPattern.length() && antPattern.charAt(i + 1) == '*') {
          // Double asterisk
          // Zero or more directories
          if (i + 2 < antPattern.length() && isSlash(antPattern.charAt(i + 2))) {
            sb.append("(?:.*").append(escapedDirectorySeparator).append("|)");
            i += 2;
          } else {
            sb.append(".*");
            i += 1;
          }
        } else {
          // Single asterisk
          // Zero or more characters excluding directory separator
          sb.append("[^").append(escapedDirectorySeparator).append("]*?");
        }
      } else if (ch == '?') {
        // Any single character excluding directory separator
        sb.append("[^").append(escapedDirectorySeparator).append("]");
      } else if (isSlash(ch)) {
        // Directory separator
        sb.append(escapedDirectorySeparator);
      } else {
        // Single character
        sb.append(ch);
      }

      i++;
    }

    sb.append('$');

    return sb.toString();
  }

  private static boolean isSlash(char ch) {
    return ch == '/' || ch == '\\';
  }

  /**
   * Returns string representation of this pattern.
   * 
   * @since 2.5
   */
  @Override
  public String toString() {
    return stringRepresentation;
  }

  /**
   * Returns true if specified value matches this pattern.
   */
  public boolean match(String value) {
    value = StringUtils.removeStart(value, "/");
    value = StringUtils.removeEnd(value, "/");
    return pattern.matcher(value).matches();
  }

  /**
   * Returns true if specified value matches one of specified patterns.
   * 
   * @since 2.4
   */
  public static boolean match(WildcardPattern[] patterns, String value) {
    for (WildcardPattern pattern : patterns) {
      if (pattern.match(value)) {
        return true;
      }
    }
    return false;
  }

  /**
   * Creates pattern with "/" as a directory separator.
   * 
   * @see #create(String, String)
   */
  public static WildcardPattern create(String pattern) {
    return create(pattern, "/");
  }

  /**
   * Creates array of patterns with "/" as a directory separator.
   * 
   * @see #create(String, String)
   */
  public static WildcardPattern[] create(String[] patterns) {
    if (patterns == null) {
      return new WildcardPattern[0];
    }
    WildcardPattern[] exclusionPAtterns = new WildcardPattern[patterns.length];
    for (int i = 0; i < patterns.length; i++) {
      exclusionPAtterns[i] = create(patterns[i]);
    }
    return exclusionPAtterns;
  }

  /**
   * Creates pattern with specified separator for directories.
   * 
   * This is used to match Java-classes, i.e. org.foo.Bar against org/**.
   * However usage of character other than "/" as a directory separator is misleading and should be avoided,
   * so method {@link #create(String)} is preferred over this one.
   * 
   * 
   * Also note that no matter whether forward or backward slashes were used in the antPattern
   * the returned pattern will use directorySeparator.
   * Thus to match Windows-style path "dir\file.ext" against pattern "dir/file.ext" normalization should be performed.
   * 
   */
  public static WildcardPattern create(String pattern, String directorySeparator) {
    String key = pattern + directorySeparator;
    WildcardPattern wildcardPattern = CACHE.get(key);
    if (wildcardPattern == null) {
      wildcardPattern = new WildcardPattern(pattern, directorySeparator);
      CACHE.put(key, wildcardPattern);
    }
    return wildcardPattern;
  }
}