org.sonarsource.slang.checks.FileHeaderCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slang-checks Show documentation
SonarSource Language analyzer
There is a newer version: 1.19.0.6612
/*
 * SonarSource SLang
 * Copyright (C) 2018-2024 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the Sonar Source-Available License Version 1, as published by SonarSource SA.
 *
 * 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 Sonar Source-Available License for more details.
 *
 * You should have received a copy of the Sonar Source-Available License
 * along with this program; if not, see https://sonarsource.com/license/ssal/
 */
package org.sonarsource.slang.checks;

import org.sonarsource.slang.api.TopLevelTree;
import org.sonarsource.slang.checks.api.CheckContext;
import org.sonarsource.slang.checks.api.InitContext;
import org.sonarsource.slang.checks.api.SlangCheck;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.IntStream;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;

@Rule(key = "S1451")
public class FileHeaderCheck implements SlangCheck {

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

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

  @RuleProperty(
    key = "isRegularExpression",
    description = "Whether the headerFormat is a regular expression",
    defaultValue = "false")
  public boolean isRegularExpression = false;
  private Pattern searchPattern = null;
  private String[] expectedLines = null;

  private static final String LINES_REGEX = "\r\n|\n|\r";

  @Override
  public void initialize(InitContext init) {
    initializeParameters();
    init.register(TopLevelTree.class, (ctx, tree) -> {
      if (isRegularExpression) {
        checkRegularExpression(ctx);
      } else {
        checkExpectedLines(ctx);
      }
    });
  }

  private void initializeParameters() {
    if (isRegularExpression) {
      try {
        searchPattern = Pattern.compile(getHeaderFormat(), Pattern.DOTALL);
      } catch (IllegalArgumentException e) {
        throw new IllegalArgumentException("[" + getClass().getSimpleName() + "] Unable to compile the regular expression: " + headerFormat, e);
      }
    } else {
      expectedLines = headerFormat.split(LINES_REGEX);
    }
  }

  private void checkExpectedLines(CheckContext ctx) {
    String[] lines = ctx.fileContent().split(LINES_REGEX, -1);
    if (lines.length < expectedLines.length) {
      ctx.reportFileIssue(MESSAGE);
    } else {
      IntStream.range(0, expectedLines.length)
        .filter(lineIndex -> !lines[lineIndex].equals(expectedLines[lineIndex]))
        .findFirst()
        .ifPresent(lineIndex -> ctx.reportFileIssue(MESSAGE));
    }
  }

  private void checkRegularExpression(CheckContext ctx) {
    Matcher matcher = searchPattern.matcher(ctx.fileContent());
    if (!matcher.find()) {
      ctx.reportFileIssue(MESSAGE);
    }
  }

  private String getHeaderFormat() {
    String format = headerFormat;
    if (format.charAt(0) != '^') {
      format = "^" + format;
    }
    return format;
  }

}