org.sonar.javascript.se.points.MemberProgramPoint Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javascript-frontend Show documentation
There is a newer version: 7.4.4.15624
/*
 * SonarQube JavaScript Plugin
 * Copyright (C) 2011-2018 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.javascript.se.points;

import java.util.EnumSet;
import java.util.Optional;
import org.sonar.javascript.se.Constraint;
import org.sonar.javascript.se.ExpressionStack;
import org.sonar.javascript.se.ProgramState;
import org.sonar.javascript.se.Type;
import org.sonar.javascript.se.sv.ObjectSymbolicValue;
import org.sonar.javascript.se.sv.SpecialSymbolicValue;
import org.sonar.javascript.se.sv.SymbolicValue;
import org.sonar.javascript.se.sv.UnknownSymbolicValue;
import org.sonar.plugins.javascript.api.tree.Tree;
import org.sonar.plugins.javascript.api.tree.expression.DotMemberExpressionTree;

import static org.sonar.javascript.se.Type.BOOLEAN_OBJECT;
import static org.sonar.javascript.se.Type.BOOLEAN_PRIMITIVE;
import static org.sonar.javascript.se.Type.NUMBER_OBJECT;
import static org.sonar.javascript.se.Type.NUMBER_PRIMITIVE;
import static org.sonar.javascript.se.Type.STRING_OBJECT;
import static org.sonar.javascript.se.Type.STRING_PRIMITIVE;

public class MemberProgramPoint implements ProgramPoint {

  private final Tree element;

  private PropertyResolutionMode mode = PropertyResolutionMode.ASSUME_PARTIAL_PROPERTY_KNOWLEDGE;

  public MemberProgramPoint(Tree element) {
    this.element = element;
  }

  public static boolean originatesFrom(Tree element) {
    return element.is(Tree.Kind.BRACKET_MEMBER_EXPRESSION, Tree.Kind.DOT_MEMBER_EXPRESSION);
  }

  @Override
  public Optional execute(final ProgramState state) {
    final SymbolicValue objectValue;
    final ExpressionStack expressionStack = state.getStack();
    final ExpressionStack newExpressionStack;
    Optional newState;

    if (element.is(Tree.Kind.BRACKET_MEMBER_EXPRESSION)) {
      objectValue = state.peekStack(1);
      newState = state.constrain(objectValue, Constraint.NOT_NULLY);
      if(!newState.isPresent()) {
        return newState;
      }
      newExpressionStack = expressionStack.apply(stack -> {
        // popping the array index
        stack.pop();
        stack.pop();
        stack.push(UnknownSymbolicValue.UNKNOWN);
      });

    } else {
      objectValue = state.peekStack(0);
      newState = state.constrain(objectValue, Constraint.NOT_NULLY);
      if(!newState.isPresent()) {
        return newState;
      }
      newExpressionStack = expressionStack.apply(stack -> {
        stack.pop();
        stack.push(resolvePropertyValue(newState.get(), objectValue));
      });
    }

    return Optional.of(newState.get().withStack(newExpressionStack));
  }

  public Optional executeStrictMode(final  ProgramState state) {
    mode = PropertyResolutionMode.ASSUME_FULL_PROPERTY_KNOWLEDGE;
    Optional result = this.execute(state);
    mode = PropertyResolutionMode.ASSUME_PARTIAL_PROPERTY_KNOWLEDGE;

    return result;
  }

  private SymbolicValue resolvePropertyValue(ProgramState state, SymbolicValue objectValue) {
    String propertyName = ((DotMemberExpressionTree) element).property().name();

    if (objectValue instanceof ObjectSymbolicValue) {
      final SymbolicValue propertyValue = mode.resolveObjectPropertyValue((ObjectSymbolicValue) objectValue, propertyName);
      if (!UnknownSymbolicValue.UNKNOWN.equals(propertyValue)) {
        return propertyValue;
      }
    }

    Type type = state.getConstraint(objectValue).type();

    if (type != null) {
      return mode.resolvePrototypePropertyValue(type, propertyName);
    }

    return UnknownSymbolicValue.UNKNOWN;
  }

  private enum PropertyResolutionMode {

    ASSUME_PARTIAL_PROPERTY_KNOWLEDGE {
      @Override
      SymbolicValue resolveObjectPropertyValue(ObjectSymbolicValue objectValue, String propertyName) {
        SymbolicValue value = objectValue.getPropertyValue(propertyName);
        return SpecialSymbolicValue.UNDEFINED.equals(value) ? UnknownSymbolicValue.UNKNOWN : value;
      }

      @Override
      SymbolicValue resolvePrototypePropertyValue(Type type, String propertyName) {
        SymbolicValue value = type.getPropertyValue(propertyName);
        return SpecialSymbolicValue.UNDEFINED.equals(value) ? UnknownSymbolicValue.UNKNOWN : value;
      }
    },
    ASSUME_FULL_PROPERTY_KNOWLEDGE {

      private final EnumSet primitiveTypes = EnumSet.of(
        NUMBER_PRIMITIVE,
        NUMBER_OBJECT,
        STRING_PRIMITIVE,
        STRING_OBJECT,
        BOOLEAN_PRIMITIVE,
        BOOLEAN_OBJECT);

      @Override
      SymbolicValue resolveObjectPropertyValue(ObjectSymbolicValue objectValue, String propertyName) {
        return objectValue.getPropertyValue(propertyName);
      }

      @Override
      SymbolicValue resolvePrototypePropertyValue(Type type, String propertyName) {
        if (primitiveTypes.contains(type)) {
          return type.getPropertyValue(propertyName);
        }
        return ASSUME_PARTIAL_PROPERTY_KNOWLEDGE.resolvePrototypePropertyValue(type, propertyName);
      }
    };

    abstract SymbolicValue resolveObjectPropertyValue(ObjectSymbolicValue objectValue, String propertyName);

    abstract SymbolicValue resolvePrototypePropertyValue(Type type, String propertyName);
  }

}