org.sonar.php.checks.FileHeaderCheck Maven / Gradle / Ivy

Go to download
/*
 * SonarQube PHP Plugin
 * Copyright (C) 2010-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 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.php.checks;

import java.util.Iterator;
import java.util.regex.Pattern;
import org.sonar.check.Rule;
import org.sonar.check.RuleProperty;
import org.sonar.php.checks.utils.CheckUtils;
import org.sonar.php.parser.LexicalConstant;
import org.sonar.plugins.php.api.tree.CompilationUnitTree;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

@Rule(key = FileHeaderCheck.KEY)
public class FileHeaderCheck extends PHPVisitorCheck {

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

  private static final String DEFAULT_HEADER_FORMAT = "";
  private static final Pattern PHP_OPEN_TAG = Pattern.compile(LexicalConstant.PHP_OPENING_TAG);

  @RuleProperty(
    key = "headerFormat",
    defaultValue = DEFAULT_HEADER_FORMAT,
    type = "TEXT")
  public String headerFormat = DEFAULT_HEADER_FORMAT;

  private String[] expectedLines;

  @Override
  public void init() {
    expectedLines = headerFormat.split("(?:\r)?\n|\r");
  }

  @Override
  public void visitCompilationUnit(CompilationUnitTree tree) {
    Iterator it = CheckUtils.lines(context().getPhpFile()).iterator();

    if (it.hasNext() && !matches(expectedLines, it)) {
      context().newFileIssue(this, MESSAGE);
    }
  }

  private static boolean matches(String[] expectedLines, Iterator lines) {
    String line = lines.next();

    if (PHP_OPEN_TAG.matcher(line).matches()) {
      if (lines.hasNext()) {
        line = lines.next();
      } else {
        // actually empty file, no issue is raised
        return true;
      }
    }

    for (int i = 0; i < expectedLines.length; i++) {
      if (i > 0) {
        if (lines.hasNext()) {
          line = lines.next();
        } else {
          return false;
        }
      }
      String expectedLine = expectedLines[i];
      if (!line.equals(expectedLine)) {
        return false;
      }
    }

    return true;
  }

}