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.common.YangVersion;
  24 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.Status;
  26 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  27 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  28 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  35 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  36 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
  37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.ArgumentUtils;
  38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseStatementSupport;
  39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  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             return;
  82         }
  83
  84         super.onFullDefinitionDeclared(augmentNode);
  85
  86         if (StmtContextUtils.isInExtensionBody(augmentNode)) {
  87             return;
  88         }
  89
  90         final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  91         augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
  92         final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target = augmentAction.mutatesEffectiveCtxPath(
  93             getSearchRoot(augmentNode), ChildSchemaNodeNamespace.class,
  94             augmentNode.coerceStatementArgument().getNodeIdentifiers());
  95
  96         augmentAction.apply(new InferenceAction() {
  97             @Override
  98             public void apply(final InferenceContext ctx) {
  99                 final StatementContextBase<?, ?, ?> augmentTargetCtx =
 100                         (StatementContextBase<?, ?, ?>) target.resolve(ctx);
 101                 if (!isSupportedAugmentTarget(augmentTargetCtx)
 102                         || StmtContextUtils.isInExtensionBody(augmentTargetCtx)) {
 103                     augmentNode.setIsSupportedToBuildEffective(false);
 104                     return;
 105                 }
 106
 107                 // We are targeting a context which is creating implicit nodes. In order to keep things consistent,
 108                 // we will need to circle back when creating effective statements.
 109                 if (augmentTargetCtx.hasImplicitParentSupport()) {
 110                     augmentNode.addToNs(AugmentImplicitHandlingNamespace.class, augmentNode, augmentTargetCtx);
 111                 }
 112
 113                 final StatementContextBase<?, ?, ?> augmentSourceCtx = (StatementContextBase<?, ?, ?>) augmentNode;
 114                 // FIXME: this is a workaround for models which augment a node which is added via an extension
 115                 //        which we do not handle. This needs to be reworked in terms of unknown schema nodes.
 116                 try {
 117                     copyFromSourceToTarget(augmentSourceCtx, augmentTargetCtx);
 118                     augmentTargetCtx.addEffectiveSubstatement(augmentSourceCtx);
 119                 } catch (final SourceException e) {
 120                     LOG.warn("Failed to add augmentation {} defined at {}",
 121                         augmentTargetCtx.getStatementSourceReference(),
 122                             augmentSourceCtx.getStatementSourceReference(), e);
 123                 }
 124             }
 125
 126             @Override
 127             public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 128                 /*
 129                  * Do not fail, if it is an uses-augment to an unknown node.
 130                  */
 131                 if (YangStmtMapping.USES == augmentNode.coerceParentContext().getPublicDefinition()) {
 132                     final SchemaNodeIdentifier augmentArg = augmentNode.coerceStatementArgument();
 133                     final Optional<StmtContext<?, ?, ?>> targetNode = ChildSchemaNodeNamespace.findNode(
 134                         getSearchRoot(augmentNode), augmentArg);
 135                     if (targetNode.isPresent() && StmtContextUtils.isUnknownStatement(targetNode.get())) {
 136                         augmentNode.setIsSupportedToBuildEffective(false);
 137                         LOG.warn("Uses-augment to unknown node {}. Augmentation has not been performed. At line: {}",
 138                             augmentArg, augmentNode.getStatementSourceReference());
 139                         return;
 140                     }
 141                 }
 142
 143                 throw new InferenceException(augmentNode.getStatementSourceReference(),
 144                         "Augment target '%s' not found", augmentNode.getStatementArgument());
 145             }
 146         });
 147     }
 148
 149     @Override
 150     protected final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx,
 151             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
 152         return new RegularAugmentStatement(ctx, substatements);
 153     }
 154
 155     @Override
 156     protected final AugmentStatement createEmptyDeclared(
 157             final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
 158         return new EmptyAugmentStatement(ctx);
 159     }
 160
 161     @Override
 162     protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
 163             final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
 164             final List<? extends StmtContext<?, ?, ?>> substatements) {
 165         final StatementContextBase<?, ?, ?> implicitDef = ctx.getFromNamespace(AugmentImplicitHandlingNamespace.class,
 166             ctx);
 167         return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
 168             verify(subCtx instanceof StatementContextBase);
 169             return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
 170         });
 171     }
 172
 173     @Override
 174     protected final AugmentEffectiveStatement createEffective(
 175             final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
 176             final AugmentStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 177         final int flags = new FlagsBuilder()
 178                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 179                 .toFlags();
 180
 181         return new AugmentEffectiveStatementImpl(declared, ctx.coerceStatementArgument(), flags,
 182             StmtContextUtils.getRootModuleQName(ctx), substatements, ctx.getStatementSourceReference(),
 183             (AugmentationSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective).orElse(null));
 184     }
 185
 186     @Override
 187     protected final AugmentEffectiveStatement createEmptyEffective(
 188             final StmtContext<SchemaNodeIdentifier, AugmentStatement, AugmentEffectiveStatement> ctx,
 189             final AugmentStatement declared) {
 190         return createEffective(ctx, declared, ImmutableList.of());
 191     }
 192
 193     private static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
 194         // Augment is in uses - we need to augment instantiated nodes in parent.
 195         final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
 196         if (YangStmtMapping.USES == parent.getPublicDefinition()) {
 197             return parent.getParentContext();
 198         }
 199         return parent;
 200     }
 201
 202     static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
 203             final StatementContextBase<?, ?, ?> targetCtx) {
 204         final CopyType typeOfCopy = sourceCtx.coerceParentContext().producesDeclared(UsesStatement.class)
 205                 ? CopyType.ADDED_BY_USES_AUGMENTATION : CopyType.ADDED_BY_AUGMENTATION;
 206         /*
 207          * Since Yang 1.1, if an augmentation is made conditional with a
 208          * "when" statement, it is allowed to add mandatory nodes.
 209          */
 210         final boolean skipCheckOfMandatoryNodes = YangVersion.VERSION_1_1.equals(sourceCtx.getRootVersion())
 211                 && isConditionalAugmentStmt(sourceCtx);
 212
 213         final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
 214         final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
 215         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 216
 217         for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
 218             if (originalStmtCtx.isSupportedByFeatures()) {
 219                 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
 220             }
 221         }
 222         for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
 223             copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
 224         }
 225
 226         targetCtx.addEffectiveSubstatements(buffer);
 227     }
 228
 229     /**
 230      * Checks whether supplied statement context is conditional augment
 231      * statement.
 232      *
 233      * @param ctx
 234      *            statement context to be checked
 235      *
 236      * @return true if supplied statement context is conditional augment
 237      *         statement, otherwise false
 238      */
 239     private static boolean isConditionalAugmentStmt(final StmtContext<?, ?, ?> ctx) {
 240         return ctx.getPublicDefinition() == YangStmtMapping.AUGMENT && hasWhenSubstatement(ctx);
 241     }
 242
 243     private static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
 244         return StmtContextUtils.findFirstSubstatement(ctx, WhenStatement.class) != null;
 245     }
 246
 247     private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
 248             final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
 249             final boolean skipCheckOfMandatoryNodes) {
 250         if (needToCopyByAugment(original)) {
 251             validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
 252
 253             buffer.add(target.childCopyOf(original, typeOfCopy));
 254         } else if (isReusedByAugment(original)) {
 255             buffer.add(original);
 256         }
 257     }
 258
 259     private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
 260             final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
 261             final boolean skipCheckOfMandatoryNodes) {
 262
 263         if (sourceCtx.producesDeclared(WhenStatement.class)) {
 264             return;
 265         }
 266
 267         if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
 268                 && requireCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
 269             checkForMandatoryNodes(sourceCtx);
 270         }
 271
 272         // Data definition statements must not collide on their namespace
 273         if (sourceCtx.producesDeclared(DataDefinitionStatement.class)) {
 274             for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
 275                 if (subStatement.producesDeclared(DataDefinitionStatement.class)) {
 276                     InferenceException.throwIf(
 277                         Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument()),
 278                         sourceCtx.getStatementSourceReference(),
 279                         "An augment cannot add node named '%s' because this name is already used in target",
 280                         sourceCtx.rawStatementArgument());
 281                 }
 282             }
 283         }
 284     }
 285
 286     private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
 287         if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
 288             /*
 289              * We need to iterate over both declared and effective sub-statements,
 290              * because a mandatory node can be:
 291              * a) declared in augment body
 292              * b) added to augment body also via uses of a grouping and
 293              * such sub-statements are stored in effective sub-statements collection.
 294              */
 295             sourceCtx.allSubstatementsStream().forEach(AbstractAugmentStatementSupport::checkForMandatoryNodes);
 296         }
 297
 298         InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx),
 299                 sourceCtx.getStatementSourceReference(),
 300                 "An augment cannot add node '%s' because it is mandatory and in module different than target",
 301                 sourceCtx.rawStatementArgument());
 302     }
 303
 304     private static boolean requireCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
 305             Mutable<?, ?, ?> targetCtx) {
 306         /*
 307          * If the statement argument is not QName, it cannot be mandatory
 308          * statement, therefore return false and skip mandatory nodes validation
 309          */
 310         final Object arg = sourceCtx.getStatementArgument();
 311         if (!(arg instanceof QName)) {
 312             return false;
 313         }
 314         final QName sourceStmtQName = (QName) arg;
 315
 316         // RootStatementContext, for example
 317         final Mutable<?, ?, ?> root = targetCtx.getRoot();
 318         do {
 319             final Object targetArg = targetCtx.getStatementArgument();
 320             Verify.verify(targetArg instanceof QName, "Argument of augment target statement must be QName, not %s",
 321                 targetArg);
 322             final QName targetStmtQName = (QName) targetArg;
 323             /*
 324              * If target is from another module, return true and perform mandatory nodes validation
 325              */
 326             if (!targetStmtQName.getModule().equals(sourceStmtQName.getModule())) {
 327                 return true;
 328             }
 329
 330             /*
 331              * If target or one of the target's ancestors from the same namespace
 332              * is a presence container
 333              * or is non-mandatory choice
 334              * or is non-mandatory list
 335              * return false and skip mandatory nodes validation, because these nodes
 336              * are not mandatory node containers according to RFC 6020 section 3.1.
 337              */
 338             if (StmtContextUtils.isPresenceContainer(targetCtx)
 339                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
 340                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
 341                 return false;
 342             }
 343
 344             // This could be an augmentation stacked on top of a previous augmentation from the same module, which is
 345             // conditional -- in which case we do not run further checks
 346             if (targetCtx.getCopyHistory().getLastOperation() == CopyType.ADDED_BY_AUGMENTATION) {
 347                 final Optional<? extends StmtContext<?, ?, ?>> optPrevCopy = targetCtx.getPreviousCopyCtx();
 348                 if (optPrevCopy.isPresent()) {
 349                     final StmtContext<?, ?, ?> original = optPrevCopy.get();
 350                     final Object origArg = original.coerceStatementArgument();
 351                     Verify.verify(origArg instanceof QName, "Unexpected statement argument %s", origArg);
 352
 353                     if (sourceStmtQName.getModule().equals(((QName) origArg).getModule())
 354                             && hasWhenSubstatement(getParentAugmentation(original))) {
 355                         return false;
 356                     }
 357                 }
 358             }
 359         } while ((targetCtx = targetCtx.getParentContext()) != root);
 360
 361         /*
 362          * All target node's parents belong to the same module as source node,
 363          * therefore return false and skip mandatory nodes validation.
 364          */
 365         return false;
 366     }
 367
 368     private static StmtContext<?, ?, ?> getParentAugmentation(final StmtContext<?, ?, ?> child) {
 369         StmtContext<?, ?, ?> parent = Verify.verifyNotNull(child.getParentContext(), "Child %s has not parent", child);
 370         while (parent.getPublicDefinition() != YangStmtMapping.AUGMENT) {
 371             parent = Verify.verifyNotNull(parent.getParentContext(), "Failed to find augmentation parent of %s", child);
 372         }
 373         return parent;
 374     }
 375
 376     private static final ImmutableSet<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES,
 377         YangStmtMapping.WHEN, YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
 378
 379     private static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
 380         return !NOCOPY_DEF_SET.contains(stmtContext.getPublicDefinition());
 381     }
 382
 383     private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
 384
 385     private static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
 386         return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
 387     }
 388
 389     static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
 390         /*
 391          * :TODO Substatement must be allowed augment target type e.g.
 392          * Container, etc... and must not be for example grouping, identity etc.
 393          * It is problem in case when more than one substatements have the same
 394          * QName, for example Grouping and Container are siblings and they have
 395          * the same QName. We must find the Container and the Grouping must be
 396          * ignored as disallowed augment target.
 397          */
 398         final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
 399             ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
 400
 401         // if no allowed target is returned we consider all targets allowed
 402         return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
 403                 || allowedAugmentTargets.contains(substatementCtx.getPublicDefinition());
 404     }
 405 }