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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of php-checks Show documentation
The newest version!
/*
 * 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 org.sonar.check.Rule;
import org.sonar.php.symbols.ClassSymbol;
import org.sonar.php.symbols.Symbols;
import org.sonar.plugins.php.api.symbols.QualifiedName;
import org.sonar.plugins.php.api.tree.declaration.NamespaceNameTree;
import org.sonar.plugins.php.api.tree.statement.CatchBlockTree;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

@Rule(key = "S5708")
public class CatchThrowableCheck extends PHPVisitorCheck {
  private static final String MESSAGE = "Change this type to be a class deriving from \"Throwable\".";
  private static final String SECONDARY_MESSAGE = "Class definition.";
  private static final QualifiedName THROWABLE_FQN = QualifiedName.qualifiedName("Throwable");

  @Override
  public void visitCatchBlock(CatchBlockTree tree) {
    tree.exceptionTypes().stream()
      .filter(type -> !Symbols.getClass(type).is(ClassSymbol.Kind.INTERFACE))
      .filter(type -> Symbols.getClass(type).isSubTypeOf(THROWABLE_FQN).isFalse())
      .forEach(this::addIssue);
    super.visitCatchBlock(tree);
  }

  private void addIssue(NamespaceNameTree tree) {
    context().newIssue(this, tree, MESSAGE)
      .secondary(Symbols.getClass(tree).location(), SECONDARY_MESSAGE);
  }
}