io.codemodder.remediation.errorexposure.ErrorMessageExposureFixStrategy Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of codemodder-base Show documentation
Base framework for writing codemods in Java
There is a newer version: 0.98.6
package io.codemodder.remediation.errorexposure;

import com.github.javaparser.ast.CompilationUnit;
import com.github.javaparser.ast.Node;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.ast.expr.MethodCallExpr;
import com.github.javaparser.ast.stmt.ExpressionStmt;
import com.github.javaparser.ast.stmt.Statement;
import io.codemodder.ast.ASTs;
import io.codemodder.remediation.*;
import java.util.List;
import java.util.Optional;

/** Removes exposure from error messages. */
final class ErrorMessageExposureFixStrategy extends MatchAndFixStrategy {

  private static final List printErrorMethods = List.of("printStackTrace");
  private static final List printMethods = List.of("println", "print", "sendError");

  /**
   * Test if the node is an expression that is the argument of a method call
   *
   * @param node
   * @return
   */
  @Override
  public boolean match(final Node node) {
    return Optional.empty()
        // is an argument of a call e.g. (response.sendError(418,))
        .or(
            () ->
                Optional.of(node)
                    .map(n -> n instanceof Expression ? (Expression) n : null)
                    .flatMap(ASTs::isArgumentOfMethodCall)
                    .filter(mce -> printMethods.contains(mce.getNameAsString())))
        // is itself a method call that send errors: e.g. err.printStackTrace()
        .or(
            () ->
                Optional.of(node)
                    .map(n -> n instanceof Expression ? (Expression) n : null)
                    .flatMap(e -> e.toMethodCallExpr())
                    .filter(mce -> printErrorMethods.contains(mce.getNameAsString())))
        .isPresent();
  }

  @Override
  public SuccessOrReason fix(final CompilationUnit cu, final Node node) {
    // find encompassing statement
    Optional maybeStmt =
        Optional.empty()
            // grab the relevant method call from the two cases
            .or(
                () ->
                    Optional.of(node)
                        .map(n -> n instanceof Expression e ? e : null)
                        .flatMap(ASTs::isArgumentOfMethodCall)
                        .filter(mce -> printMethods.contains(mce.getNameAsString())))
            // is itself a method call that send errors: e.g. err.printStackTrace()
            .or(
                () ->
                    Optional.of(node)
                        .map(n -> n instanceof Expression e ? e : null)
                        .flatMap(Expression::toMethodCallExpr)
                        .filter(mce -> printErrorMethods.contains(mce.getNameAsString())))
            // check if the method call is in a statement by itself
            .flatMap(Node::getParentNode)
            .map(p -> p instanceof ExpressionStmt ? (ExpressionStmt) p : null);
    // Remove it
    if (maybeStmt.isPresent()) {
      maybeStmt.get().remove();
      return SuccessOrReason.success();
    }
    return SuccessOrReason.reason("The call is not a statement");
  }
}