com.google.errorprone.bugpatterns.URLEqualsHashCode Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of error_prone_core Show documentation
There is a newer version: 2.27.1
/*
 * Copyright 2017 The Error Prone Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.google.errorprone.bugpatterns;

import static com.google.errorprone.BugPattern.SeverityLevel.WARNING;
import static com.google.errorprone.matchers.Matchers.allOf;
import static com.google.errorprone.matchers.Matchers.anyOf;
import static com.google.errorprone.matchers.method.MethodMatchers.instanceMethod;
import static com.google.errorprone.matchers.method.MethodMatchers.staticMethod;

import com.google.common.collect.HashBiMap;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.errorprone.BugPattern;
import com.google.errorprone.BugPattern.StandardTags;
import com.google.errorprone.VisitorState;
import com.google.errorprone.bugpatterns.BugChecker.MethodInvocationTreeMatcher;
import com.google.errorprone.bugpatterns.BugChecker.NewClassTreeMatcher;
import com.google.errorprone.matchers.Description;
import com.google.errorprone.matchers.Matcher;
import com.google.errorprone.suppliers.Supplier;
import com.google.errorprone.util.ASTHelpers;
import com.sun.source.tree.ExpressionTree;
import com.sun.source.tree.MethodInvocationTree;
import com.sun.source.tree.NewClassTree;
import com.sun.source.tree.Tree;
import com.sun.tools.javac.code.Symbol;
import com.sun.tools.javac.code.Type;
import com.sun.tools.javac.code.Types;
import java.util.List;

/**
 * Points out on creation of Set and HashMap of type java.net.URL.
 *
 * equals() and hashCode() of java.net.URL class make blocking internet connections.
 *
 * @author [email protected] (Sumit Bhagwani)
 */
@BugPattern(
    summary =
        "Avoid hash-based containers of java.net.URL--the containers rely on equals() and"
            + " hashCode(), which cause java.net.URL to make blocking internet connections.",
    severity = WARNING,
    tags = StandardTags.FRAGILE_CODE)
public class URLEqualsHashCode extends BugChecker
    implements MethodInvocationTreeMatcher, NewClassTreeMatcher {

  private static final String URL_CLASS = "java.net.URL";

  private static final Matcher CONTAINER_MATCHER =
      anyOf(
          new URLTypeArgumentMatcher("java.util.Set", 0),
          new URLTypeArgumentMatcher("java.util.Map", 0),
          // BiMap is a Map, so its first type argument is already being checked
          new URLTypeArgumentMatcher("com.google.common.collect.BiMap", 1));

  private static final Matcher METHOD_INVOCATION_MATCHER =
      allOf(
          anyOf(
              staticMethod()
                  .onClassAny(
                      ImmutableSet.class.getName(),
                      ImmutableMap.class.getName(),
                      HashBiMap.class.getName()),
              instanceMethod()
                  .onExactClassAny(
                      ImmutableSet.Builder.class.getName(), ImmutableMap.Builder.class.getName())
                  .named("build")),
          CONTAINER_MATCHER);

  @Override
  public Description matchMethodInvocation(MethodInvocationTree tree, VisitorState state) {
    if (METHOD_INVOCATION_MATCHER.matches(tree, state)) {
      return describeMatch(tree);
    }
    return Description.NO_MATCH;
  }

  @Override
  public Description matchNewClass(NewClassTree tree, VisitorState state) {
    if (CONTAINER_MATCHER.matches(tree, state)) {
      return describeMatch(tree);
    }
    return Description.NO_MATCH;
  }

  private static class URLTypeArgumentMatcher implements Matcher {
    private final String clazz;
    private final int typeArgumentIndex;

    URLTypeArgumentMatcher(String clazz, int index) {
      this.clazz = clazz;
      this.typeArgumentIndex = index;
    }

    @Override
    public boolean matches(Tree tree, VisitorState state) {
      Symbol sym = state.getSymbolFromString(clazz);
      if (sym == null) {
        return false;
      }
      Type type = ASTHelpers.getType(tree);
      if (!ASTHelpers.isSubtype(type, sym.type, state)) {
        return false;
      }
      Types types = state.getTypes();
      Type superType = types.asSuper(type, sym);
      if (superType == null) {
        return false;
      }
      List typeArguments = superType.getTypeArguments();
      if (typeArguments.isEmpty()) {
        return false;
      }
      return ASTHelpers.isSameType(
          typeArguments.get(typeArgumentIndex), JAVA_NET_URL.get(state), state);
    }
  }

  private static final Supplier JAVA_NET_URL =
      VisitorState.memoize(state -> state.getTypeFromString(URL_CLASS));
}