AbstractMappingImpl.java

/*
 * Copyright (c) 2010-2019 Evolveum and contributors
 *
 * This work is dual-licensed under the Apache License 2.0
 * and European Union Public License. See LICENSE file for details.
 */
package com.evolveum.midpoint.model.common.mapping;

import static com.evolveum.midpoint.prism.equivalence.EquivalenceStrategy.REAL_VALUE;
import static com.evolveum.midpoint.schema.util.ProvenanceMetadataUtil.hasMappingSpec;

import static org.apache.commons.lang3.BooleanUtils.isNotFalse;
import static org.apache.commons.lang3.BooleanUtils.isTrue;

import java.util.Objects;
import java.util.*;
import java.util.stream.Collectors;
import javax.xml.datatype.XMLGregorianCalendar;
import javax.xml.namespace.QName;

import com.evolveum.midpoint.prism.equivalence.EquivalenceStrategy;

import com.evolveum.midpoint.prism.util.CloneUtil;

import org.jetbrains.annotations.NotNull;

import com.evolveum.midpoint.model.api.context.Mapping;
import com.evolveum.midpoint.model.common.ModelCommonBeans;
import com.evolveum.midpoint.prism.*;
import com.evolveum.midpoint.prism.delta.PrismValueDeltaSetTriple;
import com.evolveum.midpoint.prism.path.ItemPath;
import com.evolveum.midpoint.prism.util.ObjectDeltaObject;
import com.evolveum.midpoint.repo.common.ObjectResolver;
import com.evolveum.midpoint.repo.common.expression.*;
import com.evolveum.midpoint.schema.expression.ExpressionProfile;
import com.evolveum.midpoint.schema.expression.TypedValue;
import com.evolveum.midpoint.schema.internals.InternalsConfig;
import com.evolveum.midpoint.schema.result.OperationResult;
import com.evolveum.midpoint.schema.util.ObjectTypeUtil;
import com.evolveum.midpoint.schema.util.SchemaDebugUtil;
import com.evolveum.midpoint.task.api.Task;
import com.evolveum.midpoint.util.DebugDumpable;
import com.evolveum.midpoint.util.DebugUtil;
import com.evolveum.midpoint.util.MiscUtil;
import com.evolveum.midpoint.util.annotation.Experimental;
import com.evolveum.midpoint.util.exception.*;
import com.evolveum.midpoint.util.logging.Trace;
import com.evolveum.midpoint.util.logging.TraceManager;
import com.evolveum.midpoint.xml.ns._public.common.common_3.*;
import com.evolveum.prism.xml.ns._public.types_3.DeltaSetTripleType;
import com.evolveum.prism.xml.ns._public.types_3.ItemPathType;

/**
 * Evaluation of a mapping. It is non-recyclable single-use object. Once evaluated it should not be evaluated again.
 * It will retain its original inputs and outputs that can be read again and again. But these should not be
 * changed after evaluation.
 *
 * TODO document evaluation of time constraints ...
 *
 * <p>
 * Configuration properties are unmodifiable. They are to be set via Mapping.Builder.
 *
 * @param <V> type of mapping output value
 * @param <D> type of mapping output value definition (property, container, ...)
 * @param <MBT> mapping bean type: MappingType or MetadataMappingType
 *
 * @author Radovan Semancik
 */
@SuppressWarnings("JavadocReference")
public abstract class AbstractMappingImpl<V extends PrismValue, D extends ItemDefinition, MBT extends AbstractMappingType>
        implements Mapping<V, D>, DebugDumpable, PrismValueDeltaSetTripleProducer<V, D> {

    static final Trace LOGGER = TraceManager.getTrace(AbstractMappingImpl.class);

    // TODO rename these op results when the right time comes
    private static final String OP_EVALUATE_PREPARED = MappingImpl.class.getName() + ".evaluatePrepared";
    private static final String OP_EVALUATE = MappingImpl.class.getName() + ".evaluate";
    private static final String OP_EVALUATE_TIME_VALIDITY = MappingImpl.class.getName() + ".evaluateTimeValidity";
    private static final String OP_PREPARE = MappingImpl.class.getName() + ".prepare";

    //region Configuration properties (almost unmodifiable)

    /**
     * Definition of the mapping.
     */
    @NotNull final MBT mappingBean;

    /**
     * Classification of the mapping (for reporting and diagnostic purposes).
     */
    @Experimental
    private final MappingKindType mappingKind;

    /**
     * (Context) variables to be used during mapping evaluation.
     */
    final ExpressionVariables variables;

    /**
     * Default source object. Used for resolution of paths that have no variable specification.
     * For example, when using shortened path "name" instead of e.g. "$focus/name".
     */
    private final ObjectDeltaObject<?> sourceContext;

    /**
     * Typified version of {@link #sourceContext}. Lazily evaluated.
     */
    private TypedValue<ObjectDeltaObject<?>> typedSourceContext;

    /**
     * One of the sources can be denoted as default.
     * See {@link ExpressionEvaluationContext#defaultSource}.
     *
     * Examples: attribute value for inbound mappings, "legal" information for existence mappings, etc.
     *
     * NOTE: Contrary to the use of defaultSource in expression evaluation context (where the default source
     * is always one of the sources), here the default source is an ADDITIONAL one, related to the other sources.
     * (If an explicit source of the same name is defined in the mapping, it overrides the default source.)
     */
    final Source<?, ?> defaultSource;

    /**
     * Information about the implicit source for a mapping. It is provided here for reporting and diagnostic purposes only.
     * An example: attributes/ri:name for inbound mapping for that attribute.
     */
    @Experimental
    private final ItemPath implicitSourcePath;

    /**
     * Default target object. Used for resolution of paths that have no variable specification.
     */
    final PrismContainerDefinition<?> targetContext;

    /**
     * Information about the implicit target for a mapping. It is provided here for reporting and diagnostic purposes only.
     * An example: $shadow/activation for activation mapping.
     * Useful when defaultTargetPath is not specified.
     */
    private final ItemPath implicitTargetPath;

    /**
     * Default target path if "target" or "target/path" is missing.
     * Used e.g. for outbound mappings.
     */
    final ItemPath defaultTargetPath;

    /**
     * Value for {@link #outputDefinition} to be used when there's no target path specified.
     * (For some cases it perhaps could be derived using {@link #defaultTargetPath} but we currently
     * do not use this option.)
     */
    final D defaultTargetDefinition;

    /**
     * Original values of the mapping target. Currently used for range checking.
     */
    private final Collection<V> originalTargetValues;

    /**
     * Expression profile to be used when evaluating various expressions (condition,
     * "main" expression, value set expressions, etc).
     */
    final ExpressionProfile expressionProfile;

    /**
     * Information on the kind of mapping. (Partially overlaps with {@link #mappingKind}.)
     * It is put into output triples as an origin metadata. Deprecated. Most probably will
     * be replaced by provenance metadata.
     */
    private final OriginType originType;

    /**
     * Information on the object where the mapping is defined (e.g. role, resource, and so on).
     * Used for diagnostic and reporting purposes.
     */
    private final ObjectType originObject;

    /**
     * Provider of the value policy (used for "generate" expressions).
     * See {@link ExpressionEvaluationContext#valuePolicySupplier}.
     */
    final ConfigurableValuePolicySupplier valuePolicySupplier;

    /**
     * Mapping pre-expression is invoked just before main mapping expression.
     * Pre expression will get the same expression context as the main expression.
     * This is an opportunity to manipulate the context just before evaluation.
     * Or maybe evaluate additional expressions that set up environment for
     * main expression.
     */
    private final MappingPreExpression mappingPreExpression;

    /**
     * Additional clause for condition evaluation. If set to "false" then condition for old state
     * is considered to be false. Used to skip evaluation for old state if we know there's nothing
     * reasonable to be evaluated: e.g. when evaluating constructions for users being added (no "old"
     * state there).
     */
    private final boolean conditionMaskOld;

    /**
     * Additional clause for condition evaluation. If set to "false" then condition for new state
     * is considered to be false. Used to skip evaluation for new state if we know there's nothing
     * reasonable to be evaluated: e.g. when evaluating constructions for users being deleted (no "new"
     * state there).
     */
    private final boolean conditionMaskNew;

    /**
     * "System time" to be used when evaluating this mapping.
     */
    final XMLGregorianCalendar now;

    /**
     * Whether to record and display evaluation times.
     * Usually not used in production.
     */
    private final boolean profiling;

    /**
     * Free-form description of the context in which the mapping is evaluated.
     */
    private final String contextDescription;

    /**
     * Producer of extra variables. It is not directly used in mapping evaluation:
     * it is propagated to {@link ExpressionEvaluationContext#variableProducer}.
     */
    private final VariableProducer variableProducer;

    /**
     * This is sometimes used to identify the element that mapping produces
     * if it is different from itemName. E.g. this happens with associations.
     *
     * TODO clarify, maybe rename
     */
    private final QName mappingQName;

    /**
     * Mapping specification: name, containing object OID, assignment path.
     */
    @NotNull private final MappingSpecificationType mappingSpecification;

    //endregion

    /**
     * Useful Spring beans.
     */
    final ModelCommonBeans beans;

    //region Working and output properties

    /**
     * Parses sources and targets. Holds partial results of this process.
     */
    final MappingParser<D, MBT> parser;

    /**
     * Sources for condition and expression evaluation.
     * These are created during mapping parsing.
     * (In rare cases, extra pre-parsed sources can be provided using builder.)
     */
    final Collection<Source<?, ?>> sources = new ArrayList<>();

    /**
     * State of the mapping evaluation.
     */
    private MappingEvaluationState state = MappingEvaluationState.UNINITIALIZED;

    /**
     * Evaluated mapping expression. Once evaluated it is not used any more it is remembered only for tracing purposes.
     */
    private Expression<V, D> expression;

    /**
     * Result of the mapping evaluation: values that will be added, deleted and kept in the target item.
     * (This is relative to the whole mapping and/or its assignment being added, deleted, or kept.)
     */
    private PrismValueDeltaSetTriple<V> outputTriple;

    /**
     * Result of the condition evaluation in old vs. new state.
     */
    private PrismValueDeltaSetTriple<PrismPropertyValue<Boolean>> conditionOutputTriple;

    /**
     * Scalar result of the condition evaluation for "old" state. Non-null after evaluation.
     */
    private Boolean conditionResultOld;

    /**
     * Scalar result of the condition evaluation for "new" state. Non-null after evaluation.
     */
    private Boolean conditionResultNew;

    /**
     * Evaluation of time constraints.
     */
    private TimeConstraintsEvaluation timeConstraintsEvaluation;

    /**
     * When the mapping evaluation started. Used only if profiling is turned on.
     */
    private Long evaluationStartTime;

    /**
     * When the mapping evaluation ended. Used only if profiling is turned on.
     */
    private Long evaluationEndTime;

    /**
     * Parent context description with added information about this mapping.
     * Lazily evaluated.
     */
    private String mappingContextDescription;

    /**
     * Trace for mapping evaluation, attached to the operation result.
     */
    private MappingEvaluationTraceType trace;

    /**
     * Mapping state properties that are exposed to the expressions. They can be used by the expressions to "communicate".
     * E.g. one expression setting the property and other expression checking the property.
     */
    private Map<String, Object> stateProperties;

    /**
     * Task stored during the evaluation, removed afterwards.
     */
    Task task;

    /**
     * Value metadata computer to be used when expression is evaluated.
     */
    private TransformationValueMetadataComputer valueMetadataComputer;
    //endregion

    //region Constructors and (relatively) simple getters
    protected AbstractMappingImpl(AbstractMappingBuilder<V, D, MBT, ?> builder) {
        beans = builder.getBeans();
        variables = builder.getVariables();
        mappingBean = Objects.requireNonNull(builder.getMappingBean(), "Mapping definition cannot be null");
        mappingKind = builder.getMappingKind();
        implicitSourcePath = builder.getImplicitSourcePath();
        implicitTargetPath = builder.getImplicitTargetPath();
        defaultSource = builder.getDefaultSource();
        defaultTargetDefinition = builder.getDefaultTargetDefinition();
        expressionProfile = builder.getExpressionProfile();
        defaultTargetPath = builder.getDefaultTargetPath();
        originalTargetValues = builder.getOriginalTargetValues();
        sourceContext = builder.getSourceContext();
        targetContext = builder.getTargetContext();
        originType = builder.getOriginType();
        originObject = builder.getOriginObject();
        valuePolicySupplier = builder.getValuePolicySupplier();
        variableProducer = builder.getVariableProducer();
        mappingPreExpression = builder.getMappingPreExpression();
        conditionMaskOld = builder.isConditionMaskOld();
        conditionMaskNew = builder.isConditionMaskNew();
        profiling = builder.isProfiling();
        contextDescription = builder.getContextDescription();
        mappingQName = builder.getMappingQName();
        mappingSpecification = builder.getMappingSpecification() != null ?
                builder.getMappingSpecification() : createDefaultSpecification();
        now = builder.getNow();
        sources.addAll(builder.getAdditionalSources());
        parser = new MappingParser<>(this);
    }

    private MappingSpecificationType createDefaultSpecification() {
        MappingSpecificationType specification = new MappingSpecificationType(beans.prismContext);
        specification.setMappingName(mappingBean.getName());
        if (originObject != null) {
            specification.setDefinitionObjectRef(ObjectTypeUtil.createObjectRef(originObject, beans.prismContext));
        }
        return specification;
    }

    @SuppressWarnings("CopyConstructorMissesField") // TODO what about the other fields
    protected AbstractMappingImpl(AbstractMappingImpl<V, D, MBT> prototype) {
        this.mappingBean = prototype.mappingBean;
        this.mappingKind = prototype.mappingKind;
        this.implicitSourcePath = prototype.implicitSourcePath;
        this.implicitTargetPath = prototype.implicitTargetPath;
        this.sources.addAll(prototype.sources);
        this.variables = prototype.variables;

        this.beans = prototype.beans;

        this.sourceContext = prototype.sourceContext;
        // typedSourceContext as well?
        this.defaultSource = prototype.defaultSource;

        this.targetContext = prototype.targetContext;
        this.defaultTargetPath = prototype.defaultTargetPath;
        this.defaultTargetDefinition = prototype.defaultTargetDefinition;
        this.originalTargetValues = prototype.originalTargetValues;
        this.expressionProfile = prototype.expressionProfile;

        this.originType = prototype.originType;
        this.originObject = prototype.originObject;
        this.valuePolicySupplier = prototype.valuePolicySupplier;
        this.mappingPreExpression = prototype.mappingPreExpression;
        this.conditionMaskOld = prototype.conditionMaskOld;
        this.conditionMaskNew = prototype.conditionMaskNew;

        this.mappingQName = prototype.mappingQName;
        this.mappingSpecification = prototype.mappingSpecification;

        this.now = prototype.now;
        this.profiling = prototype.profiling;
        this.variableProducer = prototype.variableProducer;

        this.contextDescription = prototype.contextDescription;

        if (prototype.outputTriple != null) {
            this.outputTriple = prototype.outputTriple.clone();
        }
        if (prototype.conditionOutputTriple != null) {
            this.conditionOutputTriple = prototype.conditionOutputTriple.clone();
        }
        this.parser = prototype.parser;
    }

    public ObjectResolver getObjectResolver() {
        return beans.objectResolver;
    }

    public QName getItemName() {
        D outputDefinition = getOutputDefinition();
        return outputDefinition != null ? outputDefinition.getItemName() : null;
    }

    public ObjectType getOriginObject() {
        return originObject;
    }

    public Source<?, ?> getDefaultSource() {
        return defaultSource;
    }

    public ObjectDeltaObject<?> getSourceContext() {
        return sourceContext;
    }

    public String getContextDescription() {
        return contextDescription;
    }

    TypedValue<ObjectDeltaObject<?>> getTypedSourceContext() {
        if (sourceContext == null) {
            return null;
        }
        if (typedSourceContext == null) {
            typedSourceContext = new TypedValue<>(sourceContext, sourceContext.getDefinition());
        }
        return typedSourceContext;
    }

    public String getMappingContextDescription() {
        if (mappingContextDescription == null) {
            StringBuilder sb = new StringBuilder("mapping ");
            if (mappingBean.getName() != null) {
                sb.append("'").append(mappingBean.getName()).append("' ");
            }
            sb.append("in ");
            sb.append(contextDescription);
            mappingContextDescription = sb.toString();
        }
        return mappingContextDescription;
    }

    @NotNull
    public MBT getMappingBean() {
        return mappingBean;
    }

    @Override
    public boolean isSourceless() {
        return sources.isEmpty();
    }

    @Override
    public MappingStrengthType getStrength() {
        return getStrength(mappingBean);
    }

    public static MappingStrengthType getStrength(AbstractMappingType mappingBean) {
        if (mappingBean != null && mappingBean.getStrength() != null) {
            return mappingBean.getStrength();
        } else {
            return MappingStrengthType.NORMAL;
        }
    }

    @Override
    public boolean isAuthoritative() {
        return isNotFalse(mappingBean.isAuthoritative());
    }

    @Override
    public boolean isExclusive() {
        return isTrue(mappingBean.isExclusive());
    }

    public boolean hasTargetRange() {
        return mappingBean.getTarget().getSet() != null;
    }

    public static boolean isApplicableToChannel(AbstractMappingType mappingType, String channelUri) {
        List<String> exceptChannel = mappingType.getExceptChannel();
        if (exceptChannel != null && !exceptChannel.isEmpty()) {
            return !exceptChannel.contains(channelUri);
        }
        List<String> applicableChannels = mappingType.getChannel();
        return applicableChannels == null || applicableChannels.isEmpty() || applicableChannels.contains(channelUri);
    }

    public XMLGregorianCalendar getNow() {
        return now;
    }

    public XMLGregorianCalendar getNextRecomputeTime() {
        return timeConstraintsEvaluation.getNextRecomputeTime();
    }

    public boolean isTimeConstraintValid() {
        return timeConstraintsEvaluation.isTimeConstraintValid();
    }

    public boolean isProfiling() {
        return profiling;
    }

    public Long getEtime() {
        if (evaluationStartTime == null || evaluationEndTime == null) {
            return null;
        }
        return evaluationEndTime - evaluationStartTime;
    }

    @Override
    public QName getMappingQName() {
        return mappingQName;
    }

    @Override
    public <T> T getStateProperty(String propertyName) {
        //noinspection unchecked
        return stateProperties != null ? (T) stateProperties.get(propertyName) : null;
    }

    @Override
    public <T> T setStateProperty(String propertyName, T value) {
        if (stateProperties == null) {
            stateProperties = new HashMap<>();
        }
        //noinspection unchecked
        return (T) stateProperties.put(propertyName, value);
    }
    //endregion

    //region Evaluation

    /**
     * Evaluate the mapping. Can be called in UNINITIALIZED or PREPARED states only.
     */
    public void evaluate(Task task, OperationResult parentResult) throws ExpressionEvaluationException, ObjectNotFoundException,
            SchemaException, SecurityViolationException, ConfigurationException, CommunicationException {
        this.task = task;
        OperationResult result = parentResult.subresult(OP_EVALUATE)
                .addArbitraryObjectAsContext("mapping", this)
                .addArbitraryObjectAsContext("context", getContextDescription())
                .addArbitraryObjectAsContext("task", task)
                .setMinor()
                .build();
        if (result.isTracingNormal(MappingEvaluationTraceType.class)) {
            trace = new MappingEvaluationTraceType(beans.prismContext)
                    .mapping(mappingBean.clone())
                    .mappingKind(mappingKind)
                    .implicitSourcePath(implicitSourcePath != null ? new ItemPathType(implicitSourcePath) : null)
                    .implicitTargetPath(implicitTargetPath != null ? new ItemPathType(implicitTargetPath) : null)
                    .containingObjectRef(ObjectTypeUtil.createObjectRef(originObject, beans.prismContext));
            result.addTrace(trace);
        } else {
            trace = null;
        }
        try {
            assertUninitializedOrPrepared();
            prepare(result);
            evaluatePrepared(result);
        } catch (Throwable t) {
            result.recordFatalError(t);
            throw t;
        } finally {
            result.computeStatusIfUnknown();
            this.task = null;
        }
    }

    /**
     * Evaluate the time validity. Can be called in UNINITIALIZED or PREPARED states only.
     */
    public void evaluateTimeValidity(Task task, OperationResult parentResult) throws ExpressionEvaluationException, ObjectNotFoundException,
            SchemaException, SecurityViolationException, ConfigurationException, CommunicationException {
        this.task = task;
        OperationResult result = parentResult.subresult(OP_EVALUATE_TIME_VALIDITY)
                .addArbitraryObjectAsContext("mapping", this)
                .addArbitraryObjectAsContext("context", getContextDescription())
                .addArbitraryObjectAsContext("task", task)
                .setMinor()
                .build();
        try {
            assertUninitializedOrPrepared();
            prepare(result);
            evaluateTimeConstraint(result);
        } catch (Throwable t) {
            result.recordFatalError(t);
            throw t;
        } finally {
            result.computeStatusIfUnknown();
            this.task = null;
        }
    }

    private void assertUninitializedOrPrepared() {
        if (state != MappingEvaluationState.UNINITIALIZED && state != MappingEvaluationState.PREPARED) {
            throw new IllegalArgumentException("Expected mapping state UNINITIALIZED or PREPARED, but was " + state);
        }
    }

    /**
     * Prepare mapping for evaluation. Parse the values. After this call it can be checked if a mapping is
     * activated (i.e. if the input changes will "trigger" the mapping).
     */
    public void prepare(OperationResult parentResult)
            throws SchemaException, ObjectNotFoundException, ExpressionEvaluationException, SecurityViolationException,
            ConfigurationException, CommunicationException {

        if (state == MappingEvaluationState.PREPARED) {
            return;
        }

        OperationResult result = parentResult.subresult(OP_PREPARE)
                .addArbitraryObjectAsContext("mapping", this)
                .addArbitraryObjectAsContext("task", task)
                .setMinor()
                .build();
        assertState(MappingEvaluationState.UNINITIALIZED);
        try {

            parser.parseSourcesAndTarget(result);

        } catch (Throwable t) {
            result.recordFatalError(t);
            throw t;
        }

        transitionState(MappingEvaluationState.PREPARED);
        result.recordSuccess();
    }

    public boolean isActivated() {
        return sourcesChanged();
    }

    private void evaluatePrepared(OperationResult parentResult) throws ExpressionEvaluationException,
            ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException,
            CommunicationException {

        assertState(MappingEvaluationState.PREPARED);

        OperationResult result = parentResult.subresult(OP_EVALUATE_PREPARED)
                .addArbitraryObjectAsContext("mapping", this)
                .addArbitraryObjectAsContext("task", task)
                .setMinor()
                .build();

        recordEvaluationStart();

        try {
            traceSources();

            // We may need to re-parse the sources here

            evaluateTimeConstraint(result);

            // We have to evaluate condition even for mappings that are not time-valid. This is because we want
            // to skip trigger creation for mappings that do not satisfy the condition (see MID-6040).
            evaluateCondition(result);

            if (isTimeConstraintValid()) {
                setupValueMetadataComputer(result);

                if (isConditionSatisfied()) {
                    evaluateExpression(result);
                    applyDefinitionToOutputTriple();
                    recomputeValues();
                    setOrigin();
                    adjustForAuthoritative();
                } else {
                    outputTriple = null;
                }
                checkRange(result); // we check the range even for not-applicable mappings (MID-5953)
                transitionState(MappingEvaluationState.EVALUATED);

                if (isConditionSatisfied()) {
                    result.recordSuccess();
                    traceSuccess();
                } else {
                    result.recordNotApplicableIfUnknown();
                    traceNotApplicable("condition is false");
                }
                traceOutput();
            } else {
                outputTriple = null;
                result.recordNotApplicableIfUnknown();
                traceDeferred();
            }
        } catch (Throwable e) {
            result.recordFatalError(e);
            traceFailure(e);
            throw e;
        } finally {
            recordEvaluationEnd();
        }
    }

    private void traceTimeConstraintValidity() {
        if (trace != null) {
            trace.setNextRecomputeTime(getNextRecomputeTime());
            trace.setTimeConstraintValid(isTimeConstraintValid());
        }
    }

    private void traceSources() throws SchemaException {
        if (trace != null) {
            for (Source<?, ?> source : sources) {
                trace.beginSource()
                        .name(source.getName())
                        .itemDeltaItem(source.toItemDeltaItemType(beans.prismContext));
            }
        }
    }

    private void traceOutput() {
        if (trace != null && outputTriple != null) {
            trace.setOutput(DeltaSetTripleType.fromDeltaSetTriple(outputTriple, beans.prismContext));
        }
    }

    private void adjustForAuthoritative() {
        if (isAuthoritative()) {
            return;
        }
        if (outputTriple == null) {
            return;
        }
        // Non-authoritative mappings do not remove values. Simply eliminate any values from the
        // minus set to do that.
        // However, we need to do this before we process range. Non-authoritative mappings may
        // still remove values if range is set. We do not want to ignore minus values from
        // range processing.
        outputTriple.clearMinusSet();
    }

    private void checkRange(OperationResult result)
            throws ExpressionEvaluationException, ObjectNotFoundException, SchemaException, CommunicationException, ConfigurationException, SecurityViolationException {
        VariableBindingDefinitionType target = mappingBean.getTarget();
        if (target == null) {
            return;
        }

        if (valueMetadataComputer != null && valueMetadataComputer.supportsProvenance()) {
            removePreviouslyComputedValues();
        }

        if (target.getSet() == null) {
            return;
        }

        String name;
        if (getOutputPath() != null) {
            name = getOutputPath().lastName().getLocalPart();
        } else {
            name = getOutputDefinition().getItemName().getLocalPart();
        }

        if (originalTargetValues == null) {
            throw new IllegalStateException("Couldn't check range for mapping in " + contextDescription + ", as original target values are not known.");
        }
        ValueSetDefinitionType rangeSetDefBean = target.getSet();
        ValueSetDefinition<V, D> rangeSetDef = new ValueSetDefinition<>(rangeSetDefBean, getOutputDefinition(), expressionProfile, name, "range",
                "range of " + name + " in " + getMappingContextDescription(), task, result);
        rangeSetDef.init(beans.expressionFactory);
        rangeSetDef.setAdditionalVariables(variables);
        for (V originalValue : originalTargetValues) {
            if (rangeSetDef.contains(originalValue)) {
                addToMinusIfNecessary(originalValue);
            }
        }
    }

    /**
     * Special treatment of values present in both original item and zero/plus sets: values that were previously computed by this
     * mapping (and are computed also now) are removed.
     *
     * In the future this will be more configurable e.g. to be able to extend this behavior to all values produced by this
     * mapping (i.e. not only those present in plus/zero sets).
     */
    private void removePreviouslyComputedValues() throws SchemaException {
        if (outputTriple == null || originalTargetValues == null) {
            return;
        }

        for (V nonNegativeValue : outputTriple.getNonNegativeValues()) {
            if (nonNegativeValue != null) {
                List<V> matchingOriginalValues = originalTargetValues.stream()
                        .filter(originalValue -> nonNegativeValue.equals(originalValue, EquivalenceStrategy.REAL_VALUE_CONSIDER_DIFFERENT_IDS))
                        .collect(Collectors.toList());
                for (V matchingOriginalValue : matchingOriginalValues) {

                    // Looking for metadata with the same mapping spec but not present in "new" value.
                    // What about the equivalence strategy?
                    //
                    // - One option is NOT_LITERAL: This will remove all values that are not exactly the same as the newly
                    //   computed one. It will provide "clean slate" to reflect even some minor non-real-value affecting changes.
                    //   The cost is that phantom adds could be generated.
                    //
                    // - Another option is REAL_VALUE. This is currently a little bit complicated because some of the metadata
                    //   that are important is now marked as operational. But we will gradually fix that.
                    List<PrismContainerValue<ValueMetadataType>> matchingMetadata =
                            matchingOriginalValue.<ValueMetadataType>getValueMetadataAsContainer().getValues().stream()
                                    .filter(md ->
                                            hasMappingSpec(md.asContainerable(), mappingSpecification)
                                                    && !nonNegativeValue.<ValueMetadataType>getValueMetadataAsContainer().contains(md, REAL_VALUE))
                                    .collect(Collectors.toList());

                    if (!matchingMetadata.isEmpty()) {
                        PrismValue valueToDelete = matchingOriginalValue.clone();
                        valueToDelete.getValueMetadataAsContainer().clear();
                        valueToDelete.<ValueMetadataType>getValueMetadataAsContainer().addAll(CloneUtil.cloneCollectionMembers(matchingMetadata));
                        LOGGER.trace("Found an existing value with the metadata indicating it was created by this mapping: putting into minus set:\n{}\nMetadata:\n{}",
                                DebugUtil.debugDumpLazily(valueToDelete, 1),
                                DebugUtil.debugDumpLazily(valueToDelete.getValueMetadata(), 1));
                        //noinspection unchecked
                        outputTriple.addToMinusSet((V) valueToDelete);
                    }
                }
            }
        }
    }

    @SuppressWarnings("unchecked")
    private void addToMinusIfNecessary(V originalValue) {
        if (outputTriple != null && (outputTriple.presentInPlusSet(originalValue) || outputTriple.presentInZeroSet(originalValue))) {
            return;
        }
        // remove it!
        if (outputTriple == null) {
            outputTriple = beans.prismContext.deltaFactory().createPrismValueDeltaSetTriple();
        }
        LOGGER.trace("Original value is in the mapping range (while not in mapping result), adding it to minus set: {}", originalValue);
        outputTriple.addToMinusSet((V) originalValue.clone());
    }

    public boolean isConditionSatisfied() {
        return conditionResultOld || conditionResultNew;
    }

    public PrismValueDeltaSetTriple<PrismPropertyValue<Boolean>> getConditionOutputTriple() {
        return conditionOutputTriple;
    }

    private void recordEvaluationStart() {
        if (profiling) {
            evaluationStartTime = System.currentTimeMillis();
        }
    }

    private void recordEvaluationEnd() {
        if (profiling) {
            evaluationEndTime = System.currentTimeMillis();
        }
    }

    private void traceSuccess() {
        if (!isTrace()) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        sb.append("Mapping trace:\n");
        appendTraceHeader(sb);
        sb.append("\nCondition: ").append(conditionResultOld).append(" -> ").append(conditionResultNew);
        if (getNextRecomputeTime() != null) {
            sb.append("\nNext recompute: ");
            sb.append(getNextRecomputeTime());
        }
        sb.append("\nResult: ");
        if (outputTriple == null) {
            sb.append("null");
        } else {
            sb.append(outputTriple.toHumanReadableString());
        }
        if (profiling) {
            sb.append("\nEtime: ");
            sb.append(getEtime());
            sb.append(" ms");
        }
        appendTraceFooter(sb);
        trace(sb.toString());
    }

    private void traceDeferred() {
        if (!isTrace()) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        sb.append("Mapping trace:\n");
        appendTraceHeader(sb);
        sb.append("\nCondition: ").append(conditionResultOld).append(" -> ").append(conditionResultNew);

        sb.append("\nEvaluation ");
        if (!isConditionSatisfied()) {
            sb.append("WOULD BE ");
        }
        sb.append("DEFERRED to: ");
        if (getNextRecomputeTime() == null) {
            sb.append("null");
        } else {
            sb.append(getNextRecomputeTime());
        }
        if (profiling) {
            sb.append("\nEtime: ");
            sb.append(getEtime());
            sb.append(" ms");
        }
        appendTraceFooter(sb);
        trace(sb.toString());
    }

    @SuppressWarnings("SameParameterValue")
    private void traceNotApplicable(String reason) {
        if (!isTrace()) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        sb.append("Mapping trace:\n");
        appendTraceHeader(sb);
        sb.append("\nEvaluation is NOT APPLICABLE because ").append(reason);
        if (profiling) {
            sb.append("\nEtime: ");
            sb.append(getEtime());
            sb.append(" ms");
        }
        appendTraceFooter(sb);
        trace(sb.toString());
    }

    private void traceFailure(Throwable e) {
        LOGGER.error("Error evaluating {}: {}-{}", getMappingContextDescription(), e.getMessage(), e);
        if (!isTrace()) {
            return;
        }
        StringBuilder sb = new StringBuilder();
        sb.append("Mapping FAILURE:\n");
        appendTraceHeader(sb);
        sb.append("\nERROR: ").append(e.getClass().getSimpleName()).append(": ").append(e.getMessage());
        if (profiling) {
            sb.append("\nEtime: ");
            sb.append(getEtime());
            sb.append(" ms");
        }
        appendTraceFooter(sb);
        trace(sb.toString());
    }

    @SuppressWarnings("BooleanMethodIsAlwaysInverted")
    private boolean isTrace() {
        return trace != null || LOGGER.isTraceEnabled() || mappingBean.isTrace() == Boolean.TRUE;
    }

    private void trace(String msg) {
        if (mappingBean.isTrace() == Boolean.TRUE) {
            LOGGER.info(msg);
        } else {
            LOGGER.trace(msg);
        }
        if (trace != null) {
            trace.setTextTrace(msg);
        }
    }

    private void appendTraceHeader(StringBuilder sb) {
        sb.append("---[ MAPPING ");
        if (mappingBean.getName() != null) {
            sb.append("'").append(mappingBean.getName()).append("' ");
        }
        sb.append(" in ");
        sb.append(contextDescription);
        sb.append("]---------------------------");
        MappingStrengthType strength = getStrength();
        if (strength != null) {
            sb.append("\nStrength: ").append(strength);
        }
        if (!isAuthoritative()) {
            sb.append("\nNot authoritative");
        }
        for (Source<?, ?> source : sources) {
            sb.append("\n");
            source.mediumDump(sb);
        }
        sb.append("\nTarget: ").append(MiscUtil.toString(getOutputDefinition()));
        sb.append("\nExpression: ");
        if (expression == null) {
            sb.append("null");
        } else {
            sb.append(expression.shortDebugDump());
        }
        if (stateProperties != null) {
            sb.append("\nState:\n");
            DebugUtil.debugDumpMapMultiLine(sb, stateProperties, 1);
        }
    }

    private void appendTraceFooter(StringBuilder sb) {
        sb.append("\n------------------------------------------------------");
    }

    private boolean computeConditionResult(Collection<PrismPropertyValue<Boolean>> booleanPropertyValues) {
        // If condition is not present at all consider it to be true
        return mappingBean.getCondition() == null || ExpressionUtil.computeConditionResult(booleanPropertyValues);
    }

    private void evaluateTimeConstraint(OperationResult result) throws SchemaException, ObjectNotFoundException,
            CommunicationException, ConfigurationException, SecurityViolationException, ExpressionEvaluationException {
        if (timeConstraintsEvaluation == null) {
            timeConstraintsEvaluation = new TimeConstraintsEvaluation(this);
            timeConstraintsEvaluation.evaluate(result);
            traceTimeConstraintValidity();
        }
        timeConstraintsEvaluation.isTimeConstraintValid();
    }

    private boolean sourcesChanged() {
        for (Source<?, ?> source : sources) {
            if (source.getDelta() != null) {
                return true;
            }
        }
        return false;
    }

    public D getOutputDefinition() {
        return parser.getOutputDefinition();
    }

    public ItemPath getOutputPath() {
        return parser.getOutputPath();
    }

    /**
     * Applies definition to the output if needed.
     */
    private void applyDefinitionToOutputTriple() throws SchemaException {
        if (outputTriple == null) {
            return;
        }
        if (outputTriple.isRaw()) {
            outputTriple.applyDefinition(getOutputDefinition());
        }
    }

    private void recomputeValues() {
        if (outputTriple == null) {
            return;
        }
        Visitor visitor = visitable -> {
            if (visitable instanceof PrismValue) {
                ((PrismValue) visitable).recompute(beans.prismContext);
            }
        };
        outputTriple.accept(visitor);
    }

    private void setOrigin() {
        if (outputTriple == null) {
            return;
        }
        if (originType != null) {
            outputTriple.setOriginType(originType);
        }
        if (originObject != null) {
            outputTriple.setOriginObject(originObject);
        }
    }

    private void evaluateCondition(OperationResult result)
            throws SchemaException, ExpressionEvaluationException, ObjectNotFoundException,
            CommunicationException, ConfigurationException, SecurityViolationException {

        computeConditionTriple(result);

        boolean conditionOutputOld = computeConditionResult(conditionOutputTriple == null ? null : conditionOutputTriple.getNonPositiveValues());
        conditionResultOld = conditionOutputOld && conditionMaskOld;

        boolean conditionOutputNew = computeConditionResult(conditionOutputTriple == null ? null : conditionOutputTriple.getNonNegativeValues());
        conditionResultNew = conditionOutputNew && conditionMaskNew;

        if (trace != null) {
            trace.setConditionResultOld(conditionResultOld);
            trace.setConditionResultNew(conditionResultNew);
        }
    }

    private void computeConditionTriple(OperationResult result)
            throws SchemaException, ObjectNotFoundException, SecurityViolationException,
            ExpressionEvaluationException,
            CommunicationException,
            ConfigurationException {
        ExpressionType conditionExpressionType = mappingBean.getCondition();
        if (conditionExpressionType == null) {
            // True -> True
            conditionOutputTriple = beans.prismContext.deltaFactory().createPrismValueDeltaSetTriple();
            conditionOutputTriple.addToZeroSet(beans.prismContext.itemFactory().createPropertyValue(Boolean.TRUE));
        } else {
            Expression<PrismPropertyValue<Boolean>, PrismPropertyDefinition<Boolean>> expression =
                    ExpressionUtil.createCondition(conditionExpressionType, expressionProfile, beans.expressionFactory,
                            "condition in " + getMappingContextDescription(), task, result);
            ExpressionEvaluationContext context = new ExpressionEvaluationContext(sources, variables,
                    "condition in " + getMappingContextDescription(), task);
            context.setValuePolicySupplier(valuePolicySupplier);
            context.setExpressionFactory(beans.expressionFactory);
            context.setDefaultSource(defaultSource);
            context.setMappingQName(mappingQName);
            context.setVariableProducer(variableProducer);
            context.setLocalContextDescription("condition");
            conditionOutputTriple = expression.evaluate(context, result);
        }
    }

    private void evaluateExpression(OperationResult result)
            throws SchemaException, ExpressionEvaluationException, ObjectNotFoundException,
            CommunicationException, ConfigurationException, SecurityViolationException {
        expression = beans.expressionFactory.makeExpression(mappingBean.getExpression(), getOutputDefinition(), expressionProfile,
                "expression in " + getMappingContextDescription(), task, result);
        ExpressionEvaluationContext context = new ExpressionEvaluationContext(sources, variables,
                "expression in " + getMappingContextDescription(), task);
        context.setDefaultSource(defaultSource);
        context.setSkipEvaluationMinus(!conditionResultOld);
        context.setSkipEvaluationPlus(!conditionResultNew);
        context.setValuePolicySupplier(valuePolicySupplier);
        context.setExpressionFactory(beans.expressionFactory);
        context.setMappingQName(mappingQName);
        context.setVariableProducer(variableProducer);
        context.setValueMetadataComputer(valueMetadataComputer);
        context.setLocalContextDescription("expression");

        if (mappingPreExpression != null) {
            mappingPreExpression.mappingPreExpression(context, result);
        }

        outputTriple = expression.evaluate(context, result);

        if (outputTriple == null) {

            if (conditionResultNew) {
                // We need to return empty triple instead of null.
                // The condition was true (or there was not condition at all)
                // so the mapping is applicable.
                // Returning null would mean that the mapping is not applicable
                // at all.
                outputTriple = beans.prismContext.deltaFactory().createPrismValueDeltaSetTriple();
            }

        } else {

            // reflect condition change
            if (!conditionResultOld && conditionResultNew) {
                // Condition change false -> true
                outputTriple.addAllToPlusSet(outputTriple.getZeroSet());
                outputTriple.clearZeroSet();
                outputTriple.clearMinusSet();
            }
            if (conditionResultOld && !conditionResultNew) {
                // Condition change true -> false
                outputTriple.addAllToMinusSet(outputTriple.getZeroSet());
                outputTriple.clearZeroSet();
                outputTriple.clearPlusSet();
            }
        }
    }

    private void setupValueMetadataComputer(OperationResult result) throws CommunicationException,
            ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException, ExpressionEvaluationException {
        valueMetadataComputer = createValueMetadataComputer(result);
    }

    protected abstract TransformationValueMetadataComputer createValueMetadataComputer(OperationResult result) throws CommunicationException,
            ObjectNotFoundException, SchemaException, SecurityViolationException, ConfigurationException,
            ExpressionEvaluationException;

    @Override
    public PrismValueDeltaSetTriple<V> getOutputTriple() {
        if (outputTriple != null && InternalsConfig.consistencyChecks) {
            try {
                outputTriple.checkNoParent();
            } catch (IllegalStateException e) {
                throw new IllegalStateException(e.getMessage() + " in output triple in " + getContextDescription(), e);
            }
        }
        return outputTriple;
    }

    public Item<V, D> getOutput() throws SchemaException {
        if (outputTriple == null) {
            return null;
        }
        //noinspection unchecked
        Item<V, D> output = getOutputDefinition().instantiate();
        output.addAll(PrismValueCollectionsUtil.cloneCollection(outputTriple.getNonNegativeValues()));
        return output;
    }

    private void transitionState(MappingEvaluationState newState) {
        state = newState;
    }

    private void assertState(MappingEvaluationState expectedState) {
        if (state != expectedState) {
            throw new IllegalArgumentException("Expected mapping state " + expectedState + ", but was " + state);
        }
    }

    /**
     * Shallow clone. Only the output is cloned deeply.
     */
    public abstract AbstractMappingImpl<V, D, MBT> clone();

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + (conditionMaskNew ? 1231 : 1237);
        result = prime * result + (conditionMaskOld ? 1231 : 1237);
        result = prime * result + ((conditionOutputTriple == null) ? 0 : conditionOutputTriple.hashCode());
        result = prime * result + ((defaultSource == null) ? 0 : defaultSource.hashCode());
        result = prime * result + ((defaultTargetDefinition == null) ? 0 : defaultTargetDefinition.hashCode());
        result = prime * result + ((expressionProfile == null) ? 0 : expressionProfile.hashCode());
        result = prime * result + mappingBean.hashCode();
        result = prime * result + ((originObject == null) ? 0 : originObject.hashCode());
        result = prime * result + ((originType == null) ? 0 : originType.hashCode());
        result = prime * result + ((outputTriple == null) ? 0 : outputTriple.hashCode());
        result = prime * result + ((contextDescription == null) ? 0 : contextDescription.hashCode());
        result = prime * result + ((sourceContext == null) ? 0 : sourceContext.hashCode());
        result = prime * result + sources.hashCode();
        result = prime * result + ((targetContext == null) ? 0 : targetContext.hashCode());
        result = prime * result + ((variables == null) ? 0 : variables.hashCode());
        return result;
    }

    @SuppressWarnings("RedundantIfStatement")
    @Override
    public boolean equals(Object obj) {
        if (this == obj) { return true; }
        if (obj == null) { return false; }
        if (getClass() != obj.getClass()) { return false; }
        AbstractMappingImpl other = (MappingImpl) obj;
        if (conditionMaskNew != other.conditionMaskNew) { return false; }
        if (conditionMaskOld != other.conditionMaskOld) { return false; }
        if (conditionOutputTriple == null) {
            if (other.conditionOutputTriple != null) { return false; }
        } else if (!conditionOutputTriple.equals(other.conditionOutputTriple)) { return false; }
        if (defaultSource == null) {
            if (other.defaultSource != null) { return false; }
        } else if (!defaultSource.equals(other.defaultSource)) { return false; }
        if (defaultTargetDefinition == null) {
            if (other.defaultTargetDefinition != null) { return false; }
        } else if (!defaultTargetDefinition.equals(other.defaultTargetDefinition)) { return false; }
        if (expressionProfile == null) {
            if (other.expressionProfile != null) { return false; }
        } else if (!expressionProfile.equals(other.expressionProfile)) { return false; }
        if (!mappingBean.equals(other.mappingBean)) { return false; }
        if (originObject == null) {
            if (other.originObject != null) { return false; }
        } else if (!originObject.equals(other.originObject)) { return false; }
        if (originType != other.originType) { return false; }
        if (outputTriple == null) {
            if (other.outputTriple != null) { return false; }
        } else if (!outputTriple.equals(other.outputTriple)) { return false; }
        if (contextDescription == null) {
            if (other.contextDescription != null) { return false; }
        } else if (!contextDescription.equals(other.contextDescription)) { return false; }
        if (sourceContext == null) {
            if (other.sourceContext != null) { return false; }
        } else if (!sourceContext.equals(other.sourceContext)) { return false; }
        if (!sources.equals(other.sources)) { return false; }
        if (targetContext == null) {
            if (other.targetContext != null) { return false; }
        } else if (!targetContext.equals(other.targetContext)) { return false; }
        if (variables == null) {
            if (other.variables != null) { return false; }
        } else if (!variables.equals(other.variables)) { return false; }
        return true;
    }

    @Override
    public String debugDump(int indent) {
        StringBuilder sb = new StringBuilder();
        DebugUtil.indentDebugDump(sb, indent);
        sb.append(toString());
        return sb.toString();
    }

    @Override
    public String toString() {
        if (mappingBean.getName() != null) {
            return "M(" + mappingBean.getName() + ": " + getMappingDisplayName() + " = " + outputTriple + toStringStrength() + ")";
        } else {
            return "M(" + getMappingDisplayName() + " = " + outputTriple + toStringStrength() + ")";
        }
    }

    private String getMappingDisplayName() {
        if (mappingQName != null) {
            return SchemaDebugUtil.prettyPrint(mappingQName);
        }
        D outputDefinition = getOutputDefinition();
        if (outputDefinition == null) {
            return null;
        }
        return SchemaDebugUtil.prettyPrint(outputDefinition.getItemName());
    }

    private String toStringStrength() {
        switch (getStrength()) {
            case NORMAL:
                return "";
            case WEAK:
                return ", weak";
            case STRONG:
                return ", strong";
        }
        return null;
    }

    @Override
    public String getIdentifier() {
        return mappingBean.getName();
    }

    @Override
    public String toHumanReadableDescription() {
        StringBuilder sb = new StringBuilder();
        sb.append("mapping ");
        if (mappingBean.getName() != null) {
            sb.append("'").append(mappingBean.getName()).append("'");
        } else {
            sb.append(getMappingDisplayName());
        }
        if (originObject != null) {
            sb.append(" in ");
            sb.append(originObject);
        }
        return sb.toString();
    }

    public Task getTask() {
        return task;
    }

    void traceTimeFrom(XMLGregorianCalendar timeFrom) {
        if (trace != null) {
            trace.setTimeFrom(timeFrom);
        }
    }

    void traceTimeTo(XMLGregorianCalendar timeTo) {
        if (trace != null) {
            trace.setTimeTo(timeTo);
        }
    }

//    // TEMPORARY
//    List<MetadataMappingType> getMetadataMappings() {
//        return mappingBean instanceof MappingType ?
//                ((MappingType) mappingBean).getMetadataMapping() : null;
//    }
//
    @NotNull
    public ModelCommonBeans getBeans() {
        return beans;
    }

    public @NotNull MappingSpecificationType getMappingSpecification() {
        return mappingSpecification;
    }
}