1 /*
2 * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
3 * and other copyright owners as documented in the project's IP log.
4 *
5 * This program and the accompanying materials are made available
6 * under the terms of the Eclipse Distribution License v1.0 which
7 * accompanies this distribution, is reproduced below, and is
8 * available at http://www.eclipse.org/org/documents/edl-v10.php
9 *
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or
13 * without modification, are permitted provided that the following
14 * conditions are met:
15 *
16 * - Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 *
19 * - Redistributions in binary form must reproduce the above
20 * copyright notice, this list of conditions and the following
21 * disclaimer in the documentation and/or other materials provided
22 * with the distribution.
23 *
24 * - Neither the name of the Eclipse Foundation, Inc. nor the
25 * names of its contributors may be used to endorse or promote
26 * products derived from this software without specific prior
27 * written permission.
28 *
29 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
30 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
31 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
32 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
34 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
35 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
36 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
37 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
38 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
40 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
41 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
42 */
43
44 package org.eclipse.jgit.revwalk.filter;
45
46 import java.io.IOException;
47
48 import org.eclipse.jgit.errors.IncorrectObjectTypeException;
49 import org.eclipse.jgit.errors.MissingObjectException;
50 import org.eclipse.jgit.revwalk.RevCommit;
51 import org.eclipse.jgit.revwalk.RevWalk;
52 import org.eclipse.jgit.util.RawCharSequence;
53 import org.eclipse.jgit.util.RawSubStringPattern;
54
55 /**
56 * Abstract filter that searches text using only substring search.
57 */
58 public abstract class SubStringRevFilter extends RevFilter {
59 /**
60 * Can this string be safely handled by a substring filter?
61 *
62 * @param pattern
63 * the pattern text proposed by the user.
64 * @return true if a substring filter can perform this pattern match; false
65 * if {@link org.eclipse.jgit.revwalk.filter.PatternMatchRevFilter}
66 * must be used instead.
67 */
68 public static boolean safe(String pattern) {
69 for (int i = 0; i < pattern.length(); i++) {
70 final char c = pattern.charAt(i);
71 switch (c) {
72 case '.':
73 case '?':
74 case '*':
75 case '+':
76 case '{':
77 case '}':
78 case '(':
79 case ')':
80 case '[':
81 case ']':
82 case '\\':
83 return false;
84 }
85 }
86 return true;
87 }
88
89 private final RawSubStringPattern pattern;
90
91 /**
92 * Construct a new matching filter.
93 *
94 * @param patternText
95 * text to locate. This should be a safe string as described by
96 * the {@link #safe(String)} as regular expression meta
97 * characters are treated as literals.
98 */
99 protected SubStringRevFilter(String patternText) {
100 pattern = new RawSubStringPattern(patternText);
101 }
102
103 /** {@inheritDoc} */
104 @Override
105 public boolean include(RevWalk walker, RevCommit cmit)
106 throws MissingObjectException, IncorrectObjectTypeException,
107 IOException {
108 return pattern.match(text(cmit)) >= 0;
109 }
110
111 /** {@inheritDoc} */
112 @Override
113 public boolean requiresCommitBody() {
114 return true;
115 }
116
117 /**
118 * Obtain the raw text to match against.
119 *
120 * @param cmit
121 * current commit being evaluated.
122 * @return sequence for the commit's content that we need to match on.
123 */
124 protected abstract RawCharSequence text(RevCommit cmit);
125
126 /** {@inheritDoc} */
127 @Override
128 public RevFilter clone() {
129 return this; // Typically we are actually thread-safe.
130 }
131
132 /** {@inheritDoc} */
133 @SuppressWarnings("nls")
134 @Override
135 public String toString() {
136 return super.toString() + "(\"" + pattern.pattern() + "\")";
137 }
138 }