org.sonar.php.checks.DeprecatedPredefinedVariablesUseCheck 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 org.sonar.check.Rule;
import org.sonar.php.checks.utils.CheckUtils;
import org.sonar.plugins.php.api.tree.expression.MemberAccessTree;
import org.sonar.plugins.php.api.tree.expression.VariableIdentifierTree;
import org.sonar.plugins.php.api.tree.lexical.SyntaxToken;
import org.sonar.plugins.php.api.visitors.PHPVisitorCheck;

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

  public static final String KEY = "S1600";
  private static final String MESSAGE = "Replace this use of the deprecated \"%s\" variable with \"%s\".";

  @Override
  public void visitVariableIdentifier(VariableIdentifierTree tree) {
    checkVariable(tree.variableExpression().token());
    super.visitVariableIdentifier(tree);
  }

  private void checkVariable(SyntaxToken variable) {
    String name = variable.text();

    if (CheckUtils.getSuperGlobalsByOldName().containsKey(name)) {
      String replacement = CheckUtils.getSuperGlobalsByOldName().get(name);
      raiseIssue(variable, name, replacement);
    } else if ("$php_errormsg".equals(name)) {
      raiseIssue(variable, name, "error_get_last()");
    }
  }

  private void raiseIssue(SyntaxToken variable, String deprecatedName, String suggestedReplacement) {
    String message = String.format(MESSAGE, deprecatedName, suggestedReplacement);
    context().newIssue(this, variable, message);
  }

  @Override
  public void visitMemberAccess(MemberAccessTree tree) {
    // skip
  }

}