/*
* SonarQube Java
* Copyright (C) 2012-2016 SonarSource SA
* mailto:contact 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.java.checks.serialization;
import com.google.common.collect.ImmutableList;
import java.util.List;
import javax.annotation.Nullable;
import org.sonar.check.Rule;
import org.sonar.java.model.ModifiersUtils;
import org.sonar.java.resolve.JavaType;
import org.sonar.plugins.java.api.IssuableSubscriptionVisitor;
import org.sonar.plugins.java.api.semantic.Symbol;
import org.sonar.plugins.java.api.semantic.Type;
import org.sonar.plugins.java.api.tree.AssignmentExpressionTree;
import org.sonar.plugins.java.api.tree.ClassTree;
import org.sonar.plugins.java.api.tree.ExpressionTree;
import org.sonar.plugins.java.api.tree.IdentifierTree;
import org.sonar.plugins.java.api.tree.Modifier;
import org.sonar.plugins.java.api.tree.ParameterizedTypeTree;
import org.sonar.plugins.java.api.tree.Tree;
import org.sonar.plugins.java.api.tree.TypeTree;
import org.sonar.plugins.java.api.tree.VariableTree;
import org.sonar.plugins.java.api.tree.WildcardTree;
@Rule(key = "S1948")
public class SerializableFieldInSerializableClassCheck extends IssuableSubscriptionVisitor {
@Override
public List<Tree.Kind> nodesToVisit() {
return ImmutableList.of(Tree.Kind.CLASS);
}
@Override
public void visitNode(Tree tree) {
if(!hasSemantic()) {
return;
}
ClassTree classTree = (ClassTree) tree;
if (isSerializable(classTree) && !SerializableContract.hasSpecialHandlingSerializationMethods(classTree)) {
for (Tree member : classTree.members()) {
if (member.is(Tree.Kind.VARIABLE)) {
checkVariableMember((VariableTree) member);
}
}
}
}
private void checkVariableMember(VariableTree variableTree) {
if (!isExcluded(variableTree)) {
IdentifierTree simpleName = variableTree.simpleName();
if (isCollectionOfSerializable(variableTree.type())) {
if (!ModifiersUtils.hasModifier(variableTree.modifiers(), Modifier.PRIVATE)) {
reportIssue(simpleName, "Make \"" + simpleName.name() + "\" private or transient.");
} else if (isUnserializableCollection(variableTree.type().symbolType())
|| initializerIsUnserializableCollection(variableTree.initializer())) {
reportIssue(simpleName);
}
checkCollectionAssignments(variableTree.symbol().usages());
} else {
reportIssue(simpleName);
}
}
}
private static boolean initializerIsUnserializableCollection(@Nullable ExpressionTree initializer) {
return initializer != null && isUnserializableCollection(initializer.symbolType());
}
private static boolean isUnserializableCollection(Type type) {
return !type.symbol().isInterface() && isSubtypeOfCollectionApi(type) && !implementsSerializable(type);
}
private void checkCollectionAssignments(List<IdentifierTree> usages) {
for (IdentifierTree usage : usages) {
Tree parentTree = usage.parent();
if (parentTree.is(Tree.Kind.ASSIGNMENT)) {
AssignmentExpressionTree assignment = (AssignmentExpressionTree) parentTree;
ExpressionTree expression = assignment.expression();
if (usage.equals(assignment.variable()) && !expression.is(Tree.Kind.NULL_LITERAL) && isUnserializableCollection(expression.symbolType())) {
reportIssue(usage);
}
}
}
}
private void reportIssue(IdentifierTree tree) {
reportIssue(tree, "Make \"" + tree.name() + "\" transient or serializable.");
}
private static boolean isExcluded(VariableTree variableTree) {
return isStatic(variableTree) || isTransientSerializableOrInjected(variableTree);
}
private static boolean isCollectionOfSerializable(Tree tree) {
if (tree.is(Tree.Kind.PARAMETERIZED_TYPE)) {
ParameterizedTypeTree typeTree = (ParameterizedTypeTree) tree;
if (isSubtypeOfCollectionApi(typeTree.symbolType())) {
return typeTree.typeArguments().stream().allMatch(SerializableFieldInSerializableClassCheck::isCollectionOfSerializable);
}
}
return isSerializable(tree);
}
private static boolean isSubtypeOfCollectionApi(Type type) {
return type.isSubtypeOf("java.util.Collection") || type.isSubtypeOf("java.util.Map");
}
private static boolean isStatic(VariableTree member) {
return ModifiersUtils.hasModifier(member.modifiers(), Modifier.STATIC);
}
private static boolean isTransientSerializableOrInjected(VariableTree member) {
return ModifiersUtils.hasModifier(member.modifiers(), Modifier.TRANSIENT) || isSerializable(member.type()) || member.symbol().metadata().isAnnotatedWith("javax.inject.Inject");
}
private static boolean isSerializable(Tree tree) {
if (tree.is(Tree.Kind.ENUM, Tree.Kind.PRIMITIVE_TYPE)) {
return true;
} else if (tree.is(Tree.Kind.CLASS)) {
Symbol.TypeSymbol symbol = ((ClassTree) tree).symbol();
return implementsSerializable(symbol.type());
} else if (tree.is(Tree.Kind.EXTENDS_WILDCARD, Tree.Kind.SUPER_WILDCARD, Tree.Kind.UNBOUNDED_WILDCARD)) {
TypeTree bound = ((WildcardTree) tree).bound();
return bound != null && implementsSerializable(bound.symbolType());
}
return implementsSerializable(((TypeTree) tree).symbolType());
}
private static boolean implementsSerializable(@Nullable Type type) {
if (type == null || type.isUnknown() || type.isPrimitive()) {
// do not raise an issue if type is unknown
return true;
}
if (type.isArray()) {
return implementsSerializable(((Type.ArrayType) type).elementType());
}
if (type.isClass() || ((JavaType) type).isTagged(JavaType.TYPEVAR)) {
return type.erasure().isSubtypeOf("java.io.Serializable");
}
return false;
}
}