| /* |
| * Licensed to the Apache Software Foundation (ASF) under one * |
| * or more contributor license agreements. See the NOTICE file * |
| * distributed with this work for additional information * |
| * regarding copyright ownership. The ASF licenses this file * |
| * to you under the Apache License, Version 2.0 (the * |
| * "License"); you may not use this file except in compliance * |
| * with the License. You may obtain a copy of the License at * |
| * * |
| * http://www.apache.org/licenses/LICENSE-2.0 * |
| * * |
| * Unless required by applicable law or agreed to in writing, * |
| * software distributed under the License is distributed on an * |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * |
| * KIND, either express or implied. See the License for the * |
| * specific language governing permissions and limitations * |
| * under the License. * |
| */ |
| package org.apache.rat.analysis.license; |
| |
| import java.util.Locale; |
| |
| import org.apache.rat.analysis.IHeaderMatcher; |
| import org.apache.rat.analysis.RatHeaderAnalysisException; |
| import org.apache.rat.api.Document; |
| import org.apache.rat.api.MetaData.Datum; |
| |
| /** |
| * Accumulates all letters and numbers contained inside the header and |
| * compares it to the full text of a given license (after reducing it |
| * to letters and numbers as well). |
| * |
| * <p>The text comparison is case insensitive but assumes only |
| * characters in the US-ASCII charset are being matched.</p> |
| * |
| * @since Rat 0.9 |
| */ |
| public class FullTextMatchingLicense extends BaseLicense |
| implements IHeaderMatcher { |
| |
| // Number of match characters assumed to be present on first line |
| private static final int DEFAULT_INITIAL_LINE_LENGTH = 20; |
| |
| private String fullText; |
| |
| private String firstLine; |
| |
| private boolean seenFirstLine = false; |
| |
| private final StringBuilder buffer = new StringBuilder(); |
| |
| public FullTextMatchingLicense() { |
| } |
| |
| protected FullTextMatchingLicense(Datum licenseFamilyCategory, |
| Datum licenseFamilyName, |
| String notes, |
| String fullText) { |
| super(licenseFamilyCategory, licenseFamilyName, notes); |
| setFullText(fullText); |
| } |
| |
| public final void setFullText(String text) { |
| int offset = text.indexOf('\n'); |
| if (offset == -1) { |
| offset = Math.min(DEFAULT_INITIAL_LINE_LENGTH, text.length()); |
| } |
| firstLine = prune(text.substring(0, offset)).toLowerCase(Locale.ENGLISH); |
| fullText = prune(text).toLowerCase(Locale.ENGLISH); |
| init(); |
| } |
| |
| public final boolean hasFullText() { |
| return fullText != null; |
| } |
| |
| public boolean match(Document subject, String line) throws RatHeaderAnalysisException { |
| final String inputToMatch = prune(line).toLowerCase(Locale.ENGLISH); |
| if (seenFirstLine) { // Accumulate more input |
| buffer.append(inputToMatch); |
| } else { |
| int offset = inputToMatch.indexOf(firstLine); |
| if (offset >= 0) { |
| // we have a match, save the text starting with the match |
| buffer.append(inputToMatch.substring(offset)); |
| seenFirstLine = true; |
| // Drop out to check whether full text is matched |
| } else { |
| // we assume that the first line must appear in a single line |
| return false; // no more to do here |
| } |
| } |
| |
| if (buffer.length() >= fullText.length()) { // we have enough data to match |
| if (buffer.toString().contains(fullText)) { |
| reportOnLicense(subject); |
| return true; // we found a match |
| } else { // buffer contains first line but does not contain full text |
| // It's possible that the buffer contains the first line again |
| int offset = buffer.substring(1).toString().indexOf(firstLine); |
| if (offset >= 0) { // first line found again |
| buffer.delete(0,offset); // reset buffer to the new start |
| } else { // buffer does not even contain first line, so cannot be used to match full text |
| init(); |
| } |
| } |
| } |
| return false; |
| } |
| |
| public void reset() { |
| init(); |
| } |
| |
| // This is called indirectly from a ctor so must be final or private |
| private void init() { |
| buffer.setLength(0); |
| seenFirstLine = false; |
| } |
| } |