123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258 |
- /*
- * Copyright (C) 2010, Red Hat Inc.
- * and other copyright owners as documented in the project's IP log.
- *
- * This program and the accompanying materials are made available
- * under the terms of the Eclipse Distribution License v1.0 which
- * accompanies this distribution, is reproduced below, and is
- * available at http://www.eclipse.org/org/documents/edl-v10.php
- *
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or
- * without modification, are permitted provided that the following
- * conditions are met:
- *
- * - Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- *
- * - Redistributions in binary form must reproduce the above
- * copyright notice, this list of conditions and the following
- * disclaimer in the documentation and/or other materials provided
- * with the distribution.
- *
- * - Neither the name of the Eclipse Foundation, Inc. nor the
- * names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior
- * written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
- * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
- * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
- * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
- * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
- * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
- * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
- * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
- * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- */
- package org.eclipse.jgit.ignore;
-
- import org.eclipse.jgit.errors.InvalidPatternException;
- import org.eclipse.jgit.fnmatch.FileNameMatcher;
-
- /**
- * A single ignore rule corresponding to one line in a .gitignore or
- * ignore file. Parses the ignore pattern
- *
- * Inspiration from: Ferry Huberts
- */
- public class IgnoreRule {
- private String pattern;
- private boolean negation;
- private boolean nameOnly;
- private boolean dirOnly;
- private FileNameMatcher matcher;
-
- /**
- * Create a new ignore rule with the given pattern. Assumes that
- * the pattern is already trimmed.
- *
- * @param pattern
- * Base pattern for the ignore rule. This pattern will
- * be parsed to generate rule parameters.
- */
- public IgnoreRule (String pattern) {
- this.pattern = pattern;
- negation = false;
- nameOnly = false;
- dirOnly = false;
- matcher = null;
- setup();
- }
-
- /**
- * Remove leading/trailing characters as needed. Set up
- * rule variables for later matching.
- */
- private void setup() {
- int startIndex = 0;
- int endIndex = pattern.length();
- if (pattern.startsWith("!")) { //$NON-NLS-1$
- startIndex++;
- negation = true;
- }
-
- if (pattern.endsWith("/")) { //$NON-NLS-1$
- endIndex --;
- dirOnly = true;
- }
-
- pattern = pattern.substring(startIndex, endIndex);
- boolean hasSlash = pattern.contains("/"); //$NON-NLS-1$
-
- if (!hasSlash)
- nameOnly = true;
- else if (!pattern.startsWith("/")) { //$NON-NLS-1$
- //Contains "/" but does not start with one
- //Adding / to the start should not interfere with matching
- pattern = "/" + pattern; //$NON-NLS-1$
- }
-
- if (pattern.contains("*") || pattern.contains("?") || pattern.contains("[")) { //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
- try {
- matcher = new FileNameMatcher(pattern, Character.valueOf('/'));
- } catch (InvalidPatternException e) {
- // Ignore pattern exceptions
- }
- }
- }
-
-
- /**
- * @return
- * True if the pattern is just a file name and not a path
- */
- public boolean getNameOnly() {
- return nameOnly;
- }
-
- /**
- *
- * @return
- * True if the pattern should match directories only
- */
- public boolean dirOnly() {
- return dirOnly;
- }
-
- /**
- *
- * @return
- * True if the pattern had a "!" in front of it
- */
- public boolean getNegation() {
- return negation;
- }
-
- /**
- * @return
- * The blob pattern to be used as a matcher
- */
- public String getPattern() {
- return pattern;
- }
-
- /**
- * Returns true if a match was made.
- * <br>
- * This function does NOT return the actual ignore status of the
- * target! Please consult {@link #getResult()} for the ignore status. The actual
- * ignore status may be true or false depending on whether this rule is
- * an ignore rule or a negation rule.
- *
- * @param target
- * Name pattern of the file, relative to the base directory of this rule
- * @param isDirectory
- * Whether the target file is a directory or not
- * @return
- * True if a match was made. This does not necessarily mean that
- * the target is ignored. Call {@link IgnoreRule#getResult() getResult()} for the result.
- */
- public boolean isMatch(String target, boolean isDirectory) {
- if (!target.startsWith("/")) //$NON-NLS-1$
- target = "/" + target; //$NON-NLS-1$
-
- if (matcher == null) {
- if (target.equals(pattern)) {
- //Exact match
- if (dirOnly && !isDirectory)
- //Directory expectations not met
- return false;
- else
- //Directory expectations met
- return true;
- }
-
- /*
- * Add slashes for startsWith check. This avoids matching e.g.
- * "/src/new" to /src/newfile" but allows "/src/new" to match
- * "/src/new/newfile", as is the git standard
- */
- if ((target).startsWith(pattern + "/")) //$NON-NLS-1$
- return true;
-
- if (nameOnly) {
- //Iterate through each sub-name
- final String[] segments = target.split("/"); //$NON-NLS-1$
- for (int idx = 0; idx < segments.length; idx++) {
- final String segmentName = segments[idx];
- if (segmentName.equals(pattern) &&
- doesMatchDirectoryExpectations(isDirectory, idx, segments.length))
- return true;
- }
- }
-
- } else {
- matcher.reset();
- matcher.append(target);
- if (matcher.isMatch())
- return true;
-
- final String[] segments = target.split("/"); //$NON-NLS-1$
- if (nameOnly) {
- for (int idx = 0; idx < segments.length; idx++) {
- final String segmentName = segments[idx];
- //Iterate through each sub-directory
- matcher.reset();
- matcher.append(segmentName);
- if (matcher.isMatch() &&
- doesMatchDirectoryExpectations(isDirectory, idx, segments.length))
- return true;
- }
- } else {
- //TODO: This is the slowest operation
- //This matches e.g. "/src/ne?" to "/src/new/file.c"
- matcher.reset();
- for (int idx = 0; idx < segments.length; idx++) {
- final String segmentName = segments[idx];
- if (segmentName.length() > 0) {
- matcher.append("/" + segmentName); //$NON-NLS-1$
- }
-
- if (matcher.isMatch() &&
- doesMatchDirectoryExpectations(isDirectory, idx, segments.length))
- return true;
- }
- }
- }
-
- return false;
- }
-
- /**
- * If a call to <code>isMatch(String, boolean)</code> was previously
- * made, this will return whether or not the target was ignored. Otherwise
- * this just indicates whether the rule is non-negation or negation.
- *
- * @return
- * True if the target is to be ignored, false otherwise.
- */
- public boolean getResult() {
- return !negation;
- }
-
- private boolean doesMatchDirectoryExpectations(boolean isDirectory, int segmentIdx, int segmentLength) {
- // The segment we are checking is a directory, expectations are met.
- if (segmentIdx < segmentLength - 1) {
- return true;
- }
-
- // We are checking the last part of the segment for which isDirectory has to be considered.
- return !dirOnly || isDirectory;
- }
- }
|