org.sonar.cxx.checks.regex.FileHeaderCheck.java Source code

Introduction

Here is the source code for org.sonar.cxx.checks.regex.FileHeaderCheck.java

Source

/*
 * Sonar C++ Plugin (Community)
 * Copyright (C) 2010-2018 SonarOpenCommunity
 * http://github.com/SonarOpenCommunity/sonar-cxx
 *
 * This program 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.
 *
 * This program 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.cxx.checks.regex;

import com.google.common.io.Files;
import com.sonar.sslr.api.AstNode;
import com.sonar.sslr.api.Grammar;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.sonar.check.Priority;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.cxx.visitors.CxxCharsetAwareVisitor;
import org.sonar.squidbridge.annotations.ActivatedByDefault;
import org.sonar.squidbridge.annotations.SqaleConstantRemediation;
import org.sonar.squidbridge.api.AnalysisException;
import org.sonar.squidbridge.checks.SquidCheck;

/**
 * FileHeaderCheck - similar Vera++ rule T013 "No copyright notice found"
 *
 */
@Rule(key = "FileHeader", name = "Copyright and license headers should be defined in all source files", priority = Priority.BLOCKER, tags = {})
@ActivatedByDefault
@SqaleConstantRemediation("5min")
public class FileHeaderCheck extends SquidCheck<Grammar> implements CxxCharsetAwareVisitor {

    private static final String DEFAULT_HEADER_FORMAT = "";
    private static final String MESSAGE = "Add or update the header of this file.";

    /**
     * headerFormat
     */
    @RuleProperty(key = "headerFormat", description = "Expected copyright and license header (plain text)", type = "TEXT", defaultValue = DEFAULT_HEADER_FORMAT)
    public String headerFormat = DEFAULT_HEADER_FORMAT;

    /**
     * isRegularExpression
     */
    @RuleProperty(key = "isRegularExpression", description = "Whether the headerFormat is a regular expression", defaultValue = "false")
    public boolean isRegularExpression;

    private Charset charset = Charset.forName("UTF-8");
    private String[] expectedLines;
    private Pattern searchPattern;

    @Override
    public void setCharset(Charset charset) {
        this.charset = charset;
    }

    @Override
    public void init() {
        if (isRegularExpression) {
            if (searchPattern == null) {
                try {
                    searchPattern = Pattern.compile(headerFormat, Pattern.DOTALL);
                } catch (IllegalArgumentException e) {
                    throw new IllegalArgumentException("[" + getClass().getSimpleName()
                            + "] Unable to compile the regular expression: " + headerFormat, e);
                }
            }
        } else {
            expectedLines = headerFormat.split("(?:\r)?\n|\r");
        }
    }

    @Override
    public void visitFile(AstNode astNode) {
        if (isRegularExpression) {
            String fileContent;
            try {
                fileContent = Files.toString(getContext().getFile(), charset);
            } catch (IOException e) {
                throw new AnalysisException(e);
            }
            checkRegularExpression(fileContent);
        } else {
            List<String> lines;
            try {
                lines = Files.readLines(getContext().getFile(), charset);
            } catch (IOException e) {
                throw new IllegalStateException(e);
            }

            if (!matches(expectedLines, lines)) {
                getContext().createFileViolation(this, MESSAGE);
            }
        }
    }

    private void checkRegularExpression(String fileContent) {
        Matcher matcher = searchPattern.matcher(fileContent);
        if (!matcher.find() || matcher.start() != 0) {
            getContext().createFileViolation(this, MESSAGE);
        }
    }

    private static boolean matches(String[] expectedLines, List<String> lines) {
        boolean result;

        if (expectedLines.length <= lines.size()) {
            result = true;

            Iterator<String> it = lines.iterator();
            for (int i = 0; i < expectedLines.length; i++) {
                String line = it.next();
                if (!line.equals(expectedLines[i])) {
                    result = false;
                    break;
                }
            }
        } else {
            result = false;
        }

        return result;
    }
}