yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/augment/AbstractAugmentStatementSupport.java

   1 /*
   2  * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.base.Verify;
  13 import com.google.common.collect.ImmutableList;
  14 import com.google.common.collect.ImmutableSet;
  15 import com.google.common.collect.Lists;
  16 import java.util.ArrayList;
  17 import java.util.Collection;
  18 import java.util.List;
  19 import java.util.Objects;
  20 import java.util.Optional;
  21 import java.util.regex.Pattern;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.Status;
  25 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  26 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  27 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.WhenEffectiveStatement;
  35 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  36 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
  37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  38 import org.opendaylight.yangtools.yang.parser.spi.SchemaTreeNamespace;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  43 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  44 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceContext;
  45 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  46 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  47 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  48 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  49 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  50 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  51 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  52 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  53 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  54 import org.slf4j.Logger;
  55 import org.slf4j.LoggerFactory;
  56
  57 abstract class AbstractAugmentStatementSupport
  58         extends BaseStatementSupport<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> {
  59     private static final Logger LOG = LoggerFactory.getLogger(AbstractAugmentStatementSupport.class);
  60     private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
  61     private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
  62
  63     AbstractAugmentStatementSupport() {
  64         super(YangStmtMapping.AUGMENT);
  65     }
  66
  67     @Override
  68     public final SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  69         SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
  70             || PATH_REL_PATTERN2.matcher(value).matches(), ctx.getStatementSourceReference(),
  71             "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses",
  72             value);
  73
  74         return ArgumentUtils.nodeIdentifierFromPath(ctx, value);
  75     }
  76
  77     @Override
  78     public final void onFullDefinitionDeclared(
  79             final Mutable<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> augmentNode) {
  80         if (!augmentNode.isSupportedByFeatures()) {
  81             // We need this augment node to be present, but it should not escape to effective world
  82             augmentNode.setIsSupportedToBuildEffective(false);
  83         }
  84
  85         super.onFullDefinitionDeclared(augmentNode);
  86
  87         if (StmtContextUtils.isInExtensionBody(augmentNode)) {
  88             return;
  89         }
  90
  91         final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  92         augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
  93         final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target = augmentAction.mutatesEffectiveCtxPath(
  94             getSearchRoot(augmentNode), SchemaTreeNamespace.class,
  95             augmentNode.coerceStatementArgument().getNodeIdentifiers());
  96
  97         augmentAction.apply(new InferenceAction() {
  98             @Override
  99             public void apply(final InferenceContext ctx) {
 100                 final StatementContextBase<?, ?, ?> augmentTargetCtx =
 101                         (StatementContextBase<?, ?, ?>) target.resolve(ctx);
 102                 if (!isSupportedAugmentTarget(augmentTargetCtx)
 103                         || StmtContextUtils.isInExtensionBody(augmentTargetCtx)) {
 104                     augmentNode.setIsSupportedToBuildEffective(false);
 105                     return;
 106                 }
 107
 108                 // We are targeting a context which is creating implicit nodes. In order to keep things consistent,
 109                 // we will need to circle back when creating effective statements.
 110                 if (augmentTargetCtx.hasImplicitParentSupport()) {
 111                     augmentNode.addToNs(AugmentImplicitHandlingNamespace.class, augmentNode, augmentTargetCtx);
 112                 }
 113
 114                 final StatementContextBase<?, ?, ?> augmentSourceCtx = (StatementContextBase<?, ?, ?>) augmentNode;
 115                 // FIXME: this is a workaround for models which augment a node which is added via an extension
 116                 //        which we do not handle. This needs to be reworked in terms of unknown schema nodes.
 117                 try {
 118                     copyFromSourceToTarget(augmentSourceCtx, augmentTargetCtx);
 119                     augmentTargetCtx.addEffectiveSubstatement(augmentSourceCtx);
 120                 } catch (final SourceException e) {
 121                     LOG.warn("Failed to add augmentation {} defined at {}",
 122                         augmentTargetCtx.getStatementSourceReference(),
 123                             augmentSourceCtx.getStatementSourceReference(), e);
 124                 }
 125             }
 126
 127             @Override
 128             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 129                 /*
 130                  * Do not fail, if it is an uses-augment to an unknown node.
 131                  */
 132                 if (YangStmtMapping.USES == augmentNode.coerceParentContext().publicDefinition()) {
 133                     final SchemaNodeIdentifier augmentArg = augmentNode.getArgument();
 134                     final Optional<StmtContext<?, ?, ?>> targetNode = SchemaTreeNamespace.findNode(
 135                         getSearchRoot(augmentNode), augmentArg);
 136                     if (targetNode.isPresent() && StmtContextUtils.isUnknownStatement(targetNode.get())) {
 137                         augmentNode.setIsSupportedToBuildEffective(false);
 138                         LOG.warn("Uses-augment to unknown node {}. Augmentation has not been performed. At line: {}",
 139                             augmentArg, augmentNode.getStatementSourceReference());
 140                         return;
 141                     }
 142                 }
 143
 144                 throw new InferenceException(augmentNode.getStatementSourceReference(),
 145                         "Augment target '%s' not found", augmentNode.getStatementArgument());
 146             }
 147         });
 148     }
 149
 150     @Override
 151     protected final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx,
 152             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 153         return new RegularAugmentStatement(ctx.getRawArgument(), ctx.getArgument(), substatements);
 154     }
 155
 156     @Override
 157     protected final AugmentStatement createEmptyDeclared(
 158             final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
 159         return new EmptyAugmentStatement(ctx.getRawArgument(), ctx.getArgument());
 160     }
 161
 162     @Override
 163     protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
 164             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 165             final List<? extends StmtContext<?, ?, ?>> substatements) {
 166         // Pick up the marker left by onFullDefinitionDeclared() inference action. If it is present we need to pass our
 167         // children through target's implicit wrapping.
 168         final StatementContextBase<?, ?, ?> implicitDef = stmt.getFromNamespace(AugmentImplicitHandlingNamespace.class,
 169             stmt.caerbannog());
 170         return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
 171             verify(subCtx instanceof StatementContextBase);
 172             return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
 173         });
 174     }
 175
 176     @Override
 177     protected final AugmentEffectiveStatement createEffective(
 178             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 179             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 180         final int flags = new FlagsBuilder()
 181                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 182                 .toFlags();
 183
 184         return new AugmentEffectiveStatementImpl(stmt.declared(), stmt.getArgument(), flags,
 185             StmtContextUtils.getRootModuleQName(stmt.caerbannog()), substatements, stmt.sourceReference(),
 186             (AugmentationSchemaNode) stmt.original());
 187     }
 188
 189     private static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
 190         // Augment is in uses - we need to augment instantiated nodes in parent.
 191         final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
 192         if (YangStmtMapping.USES == parent.publicDefinition()) {
 193             return parent.getParentContext();
 194         }
 195         return parent;
 196     }
 197
 198     final void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
 199             final StatementContextBase<?, ?, ?> targetCtx) {
 200         final CopyType typeOfCopy = sourceCtx.coerceParentContext().producesDeclared(UsesStatement.class)
 201                 ? CopyType.ADDED_BY_USES_AUGMENTATION : CopyType.ADDED_BY_AUGMENTATION;
 202         /*
 203          * Since Yang 1.1, if an augmentation is made conditional with a
 204          * "when" statement, it is allowed to add mandatory nodes.
 205          */
 206         final boolean skipCheckOfMandatoryNodes = allowsMandatory(sourceCtx);
 207         final boolean unsupported = !sourceCtx.isSupportedByFeatures();
 208
 209         final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
 210         final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
 211         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 212
 213         for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
 214             copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes,
 215                 unsupported || !originalStmtCtx.isSupportedByFeatures());
 216         }
 217         for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
 218             copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes, unsupported);
 219         }
 220
 221         targetCtx.addEffectiveSubstatements(buffer);
 222     }
 223
 224     abstract boolean allowsMandatory(StmtContext<?, ?, ?> ctx);
 225
 226     static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
 227         return ctx.hasSubstatement(WhenEffectiveStatement.class);
 228     }
 229
 230     private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
 231             final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
 232             final boolean skipCheckOfMandatoryNodes, final boolean unsupported) {
 233         // We always copy statements, but if either the source statement or the augmentation which causes it are not
 234         // supported to build we also mark the target as such.
 235         if (needToCopyByAugment(original)) {
 236             validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
 237
 238             final Mutable<?, ?, ?> copy = target.childCopyOf(original, typeOfCopy);
 239             if (unsupported) {
 240                 copy.setIsSupportedToBuildEffective(false);
 241             }
 242             buffer.add(copy);
 243         } else if (isReusedByAugment(original) && !unsupported) {
 244             buffer.add(original);
 245         }
 246     }
 247
 248     private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
 249             final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
 250             final boolean skipCheckOfMandatoryNodes) {
 251         if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
 252                 && requireCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
 253             checkForMandatoryNodes(sourceCtx);
 254         }
 255
 256         // Data definition statements must not collide on their namespace
 257         if (sourceCtx.producesDeclared(DataDefinitionStatement.class)) {
 258             for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
 259                 if (subStatement.producesDeclared(DataDefinitionStatement.class)) {
 260                     InferenceException.throwIf(
 261                         Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument()),
 262                         sourceCtx.getStatementSourceReference(),
 263                         "An augment cannot add node named '%s' because this name is already used in target",
 264                         sourceCtx.rawStatementArgument());
 265                 }
 266             }
 267         }
 268     }
 269
 270     private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
 271         if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
 272             /*
 273              * We need to iterate over both declared and effective sub-statements,
 274              * because a mandatory node can be:
 275              * a) declared in augment body
 276              * b) added to augment body also via uses of a grouping and
 277              * such sub-statements are stored in effective sub-statements collection.
 278              */
 279             sourceCtx.allSubstatementsStream().forEach(AbstractAugmentStatementSupport::checkForMandatoryNodes);
 280         }
 281
 282         InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx),
 283                 sourceCtx.getStatementSourceReference(),
 284                 "An augment cannot add node '%s' because it is mandatory and in module different than target",
 285                 sourceCtx.rawStatementArgument());
 286     }
 287
 288     private static boolean requireCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
 289             Mutable<?, ?, ?> targetCtx) {
 290         /*
 291          * If the statement argument is not QName, it cannot be mandatory
 292          * statement, therefore return false and skip mandatory nodes validation
 293          */
 294         final Object arg = sourceCtx.getStatementArgument();
 295         if (!(arg instanceof QName)) {
 296             return false;
 297         }
 298         final QName sourceStmtQName = (QName) arg;
 299
 300         // RootStatementContext, for example
 301         final Mutable<?, ?, ?> root = targetCtx.getRoot();
 302         do {
 303             final Object targetArg = targetCtx.getStatementArgument();
 304             Verify.verify(targetArg instanceof QName, "Argument of augment target statement must be QName, not %s",
 305                 targetArg);
 306             final QName targetStmtQName = (QName) targetArg;
 307             /*
 308              * If target is from another module, return true and perform mandatory nodes validation
 309              */
 310             if (!targetStmtQName.getModule().equals(sourceStmtQName.getModule())) {
 311                 return true;
 312             }
 313
 314             /*
 315              * If target or one of the target's ancestors from the same namespace
 316              * is a presence container
 317              * or is non-mandatory choice
 318              * or is non-mandatory list
 319              * return false and skip mandatory nodes validation, because these nodes
 320              * are not mandatory node containers according to RFC 6020 section 3.1.
 321              */
 322             if (StmtContextUtils.isPresenceContainer(targetCtx)
 323                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
 324                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
 325                 return false;
 326             }
 327
 328             // This could be an augmentation stacked on top of a previous augmentation from the same module, which is
 329             // conditional -- in which case we do not run further checks
 330             if (targetCtx.getCopyHistory().getLastOperation() == CopyType.ADDED_BY_AUGMENTATION) {
 331                 final Optional<? extends StmtContext<?, ?, ?>> optPrevCopy = targetCtx.getPreviousCopyCtx();
 332                 if (optPrevCopy.isPresent()) {
 333                     final StmtContext<?, ?, ?> original = optPrevCopy.get();
 334                     final Object origArg = original.coerceStatementArgument();
 335                     Verify.verify(origArg instanceof QName, "Unexpected statement argument %s", origArg);
 336
 337                     if (sourceStmtQName.getModule().equals(((QName) origArg).getModule())
 338                             && hasWhenSubstatement(getParentAugmentation(original))) {
 339                         return false;
 340                     }
 341                 }
 342             }
 343         } while ((targetCtx = targetCtx.getParentContext()) != root);
 344
 345         /*
 346          * All target node's parents belong to the same module as source node,
 347          * therefore return false and skip mandatory nodes validation.
 348          */
 349         return false;
 350     }
 351
 352     private static StmtContext<?, ?, ?> getParentAugmentation(final StmtContext<?, ?, ?> child) {
 353         StmtContext<?, ?, ?> parent = Verify.verifyNotNull(child.getParentContext(), "Child %s has not parent", child);
 354         while (parent.publicDefinition() != YangStmtMapping.AUGMENT) {
 355             parent = Verify.verifyNotNull(parent.getParentContext(), "Failed to find augmentation parent of %s", child);
 356         }
 357         return parent;
 358     }
 359
 360     private static final ImmutableSet<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES,
 361         YangStmtMapping.WHEN, YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
 362
 363     private static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
 364         return !NOCOPY_DEF_SET.contains(stmtContext.publicDefinition());
 365     }
 366
 367     private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
 368
 369     private static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
 370         return REUSED_DEF_SET.contains(stmtContext.publicDefinition());
 371     }
 372
 373     static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
 374         /*
 375          * :TODO Substatement must be allowed augment target type e.g.
 376          * Container, etc... and must not be for example grouping, identity etc.
 377          * It is problem in case when more than one substatements have the same
 378          * QName, for example Grouping and Container are siblings and they have
 379          * the same QName. We must find the Container and the Grouping must be
 380          * ignored as disallowed augment target.
 381          */
 382         final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
 383             ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
 384
 385         // if no allowed target is returned we consider all targets allowed
 386         return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
 387                 || allowedAugmentTargets.contains(substatementCtx.publicDefinition());
 388     }
 389 }