View Javadoc
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.util.regex.Pattern;
47  
48  import org.eclipse.jgit.internal.JGitText;
49  import org.eclipse.jgit.revwalk.RevCommit;
50  import org.eclipse.jgit.util.RawCharSequence;
51  import org.eclipse.jgit.util.RawParseUtils;
52  
53  /**
54   * Matches only commits whose message matches the pattern.
55   */
56  public class MessageRevFilter {
57  	/**
58  	 * Create a message filter.
59  	 * <p>
60  	 * An optimized substring search may be automatically selected if the
61  	 * pattern does not contain any regular expression meta-characters.
62  	 * <p>
63  	 * The search is performed using a case-insensitive comparison. The
64  	 * character encoding of the commit message itself is not respected. The
65  	 * filter matches on raw UTF-8 byte sequences.
66  	 *
67  	 * @param pattern
68  	 *            regular expression pattern to match.
69  	 * @return a new filter that matches the given expression against the
70  	 *         message body of the commit.
71  	 */
72  	public static RevFilter create(String pattern) {
73  		if (pattern.length() == 0)
74  			throw new IllegalArgumentException(JGitText.get().cannotMatchOnEmptyString);
75  		if (SubStringRevFilter.safe(pattern))
76  			return new SubStringSearch(pattern);
77  		return new PatternSearch(pattern);
78  	}
79  
80  	private MessageRevFilter() {
81  		// Don't permit us to be created.
82  	}
83  
84  	static RawCharSequence textFor(RevCommit cmit) {
85  		final byte[] raw = cmit.getRawBuffer();
86  		final int b = RawParseUtils.commitMessage(raw, 0);
87  		if (b < 0)
88  			return RawCharSequence.EMPTY;
89  		return new RawCharSequence(raw, b, raw.length);
90  	}
91  
92  	private static class PatternSearch extends PatternMatchRevFilter {
93  		PatternSearch(String patternText) {
94  			super(patternText, true, true, Pattern.CASE_INSENSITIVE
95  					| Pattern.DOTALL);
96  		}
97  
98  		@Override
99  		protected CharSequence text(RevCommit cmit) {
100 			return textFor(cmit);
101 		}
102 
103 		@Override
104 		public RevFilter clone() {
105 			return new PatternSearch(pattern());
106 		}
107 	}
108 
109 	private static class SubStringSearch extends SubStringRevFilter {
110 		SubStringSearch(String patternText) {
111 			super(patternText);
112 		}
113 
114 		@Override
115 		protected RawCharSequence text(RevCommit cmit) {
116 			return textFor(cmit);
117 		}
118 	}
119 }