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.sourceReference(),
  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 {}", augmentTargetCtx.sourceReference(),
 122                             augmentSourceCtx.sourceReference(), 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().publicDefinition()) {
 132                     final SchemaNodeIdentifier augmentArg = augmentNode.getArgument();
 133                     final Optional<StmtContext<?, ?, ?>> targetNode = SchemaTreeNamespace.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.sourceReference());
 139                         return;
 140                     }
 141                 }
 142
 143                 throw new InferenceException(augmentNode.sourceReference(), "Augment target '%s' not found",
 144                     augmentNode.argument());
 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.getRawArgument(), ctx.getArgument(), substatements);
 153     }
 154
 155     @Override
 156     protected final AugmentStatement createEmptyDeclared(
 157             final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
 158         return new EmptyAugmentStatement(ctx.getRawArgument(), ctx.getArgument());
 159     }
 160
 161     @Override
 162     protected final List<? extends StmtContext<?, ?, ?>> statementsToBuild(
 163             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 164             final List<? extends StmtContext<?, ?, ?>> substatements) {
 165         // Pick up the marker left by onFullDefinitionDeclared() inference action. If it is present we need to pass our
 166         // children through target's implicit wrapping.
 167         final StatementContextBase<?, ?, ?> implicitDef = stmt.getFromNamespace(AugmentImplicitHandlingNamespace.class,
 168             stmt.caerbannog());
 169         return implicitDef == null ? substatements : Lists.transform(substatements, subCtx -> {
 170             verify(subCtx instanceof StatementContextBase);
 171             return implicitDef.wrapWithImplicit((StatementContextBase<?, ?, ?>) subCtx);
 172         });
 173     }
 174
 175     @Override
 176     protected final AugmentEffectiveStatement createEffective(
 177             final Current<SchemaNodeIdentifier, AugmentStatement> stmt,
 178             final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
 179         final int flags = new FlagsBuilder()
 180                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 181                 .toFlags();
 182
 183         return new AugmentEffectiveStatementImpl(stmt.declared(), stmt.getArgument(), flags,
 184             StmtContextUtils.getRootModuleQName(stmt.caerbannog()), substatements, stmt.sourceReference(),
 185             (AugmentationSchemaNode) stmt.original());
 186     }
 187
 188     private static StmtContext<?, ?, ?> getSearchRoot(final StmtContext<?, ?, ?> augmentContext) {
 189         // Augment is in uses - we need to augment instantiated nodes in parent.
 190         final StmtContext<?, ?, ?> parent = augmentContext.coerceParentContext();
 191         if (YangStmtMapping.USES == parent.publicDefinition()) {
 192             return parent.getParentContext();
 193         }
 194         return parent;
 195     }
 196
 197     final void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
 198             final StatementContextBase<?, ?, ?> targetCtx) {
 199         final CopyType typeOfCopy = sourceCtx.coerceParentContext().producesDeclared(UsesStatement.class)
 200                 ? CopyType.ADDED_BY_USES_AUGMENTATION : CopyType.ADDED_BY_AUGMENTATION;
 201         /*
 202          * Since Yang 1.1, if an augmentation is made conditional with a
 203          * "when" statement, it is allowed to add mandatory nodes.
 204          */
 205         final boolean skipCheckOfMandatoryNodes = allowsMandatory(sourceCtx);
 206         final boolean unsupported = !sourceCtx.isSupportedByFeatures();
 207
 208         final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
 209         final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
 210         final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 211
 212         for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
 213             copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes,
 214                 unsupported || !originalStmtCtx.isSupportedByFeatures());
 215         }
 216         for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
 217             copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes, unsupported);
 218         }
 219
 220         targetCtx.addEffectiveSubstatements(buffer);
 221     }
 222
 223     abstract boolean allowsMandatory(StmtContext<?, ?, ?> ctx);
 224
 225     static boolean hasWhenSubstatement(final StmtContext<?, ?, ?> ctx) {
 226         return ctx.hasSubstatement(WhenEffectiveStatement.class);
 227     }
 228
 229     private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
 230             final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
 231             final boolean skipCheckOfMandatoryNodes, final boolean unsupported) {
 232         // We always copy statements, but if either the source statement or the augmentation which causes it are not
 233         // supported to build we also mark the target as such.
 234         if (needToCopyByAugment(original)) {
 235             validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
 236
 237             final Mutable<?, ?, ?> copy = target.childCopyOf(original, typeOfCopy);
 238             if (unsupported) {
 239                 copy.setIsSupportedToBuildEffective(false);
 240             }
 241             buffer.add(copy);
 242         } else if (isReusedByAugment(original) && !unsupported) {
 243             buffer.add(original);
 244         }
 245     }
 246
 247     private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
 248             final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
 249             final boolean skipCheckOfMandatoryNodes) {
 250         if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
 251                 && requireCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
 252             checkForMandatoryNodes(sourceCtx);
 253         }
 254
 255         // Data definition statements must not collide on their namespace
 256         if (sourceCtx.producesDeclared(DataDefinitionStatement.class)) {
 257             for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
 258                 if (subStatement.producesDeclared(DataDefinitionStatement.class)) {
 259                     InferenceException.throwIf(Objects.equals(sourceCtx.argument(), subStatement.argument()),
 260                         sourceCtx.sourceReference(),
 261                         "An augment cannot add node named '%s' because this name is already used in target",
 262                         sourceCtx.rawArgument());
 263                 }
 264             }
 265         }
 266     }
 267
 268     private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
 269         if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
 270             /*
 271              * We need to iterate over both declared and effective sub-statements,
 272              * because a mandatory node can be:
 273              * a) declared in augment body
 274              * b) added to augment body also via uses of a grouping and
 275              * such sub-statements are stored in effective sub-statements collection.
 276              */
 277             sourceCtx.allSubstatementsStream().forEach(AbstractAugmentStatementSupport::checkForMandatoryNodes);
 278         }
 279
 280         InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx), sourceCtx.sourceReference(),
 281             "An augment cannot add node '%s' because it is mandatory and in module different than target",
 282             sourceCtx.rawArgument());
 283     }
 284
 285     private static boolean requireCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
 286             Mutable<?, ?, ?> targetCtx) {
 287         /*
 288          * If the statement argument is not QName, it cannot be mandatory
 289          * statement, therefore return false and skip mandatory nodes validation
 290          */
 291         final Object arg = sourceCtx.argument();
 292         if (!(arg instanceof QName)) {
 293             return false;
 294         }
 295         final QName sourceStmtQName = (QName) arg;
 296
 297         // RootStatementContext, for example
 298         final Mutable<?, ?, ?> root = targetCtx.getRoot();
 299         do {
 300             final Object targetArg = targetCtx.argument();
 301             verify(targetArg instanceof QName, "Argument of augment target statement must be QName, not %s", targetArg);
 302             final QName targetStmtQName = (QName) targetArg;
 303             /*
 304              * If target is from another module, return true and perform mandatory nodes validation
 305              */
 306             if (!targetStmtQName.getModule().equals(sourceStmtQName.getModule())) {
 307                 return true;
 308             }
 309
 310             /*
 311              * If target or one of the target's ancestors from the same namespace
 312              * is a presence container
 313              * or is non-mandatory choice
 314              * or is non-mandatory list
 315              * return false and skip mandatory nodes validation, because these nodes
 316              * are not mandatory node containers according to RFC 6020 section 3.1.
 317              */
 318             if (StmtContextUtils.isPresenceContainer(targetCtx)
 319                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
 320                     || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
 321                 return false;
 322             }
 323
 324             // This could be an augmentation stacked on top of a previous augmentation from the same module, which is
 325             // conditional -- in which case we do not run further checks
 326             if (targetCtx.getCopyHistory().getLastOperation() == CopyType.ADDED_BY_AUGMENTATION) {
 327                 final Optional<? extends StmtContext<?, ?, ?>> optPrevCopy = targetCtx.getPreviousCopyCtx();
 328                 if (optPrevCopy.isPresent()) {
 329                     final StmtContext<?, ?, ?> original = optPrevCopy.get();
 330                     final Object origArg = original.coerceStatementArgument();
 331                     Verify.verify(origArg instanceof QName, "Unexpected statement argument %s", origArg);
 332
 333                     if (sourceStmtQName.getModule().equals(((QName) origArg).getModule())
 334                             && hasWhenSubstatement(getParentAugmentation(original))) {
 335                         return false;
 336                     }
 337                 }
 338             }
 339         } while ((targetCtx = targetCtx.getParentContext()) != root);
 340
 341         /*
 342          * All target node's parents belong to the same module as source node,
 343          * therefore return false and skip mandatory nodes validation.
 344          */
 345         return false;
 346     }
 347
 348     private static StmtContext<?, ?, ?> getParentAugmentation(final StmtContext<?, ?, ?> child) {
 349         StmtContext<?, ?, ?> parent = Verify.verifyNotNull(child.getParentContext(), "Child %s has not parent", child);
 350         while (parent.publicDefinition() != YangStmtMapping.AUGMENT) {
 351             parent = Verify.verifyNotNull(parent.getParentContext(), "Failed to find augmentation parent of %s", child);
 352         }
 353         return parent;
 354     }
 355
 356     private static final ImmutableSet<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES,
 357         YangStmtMapping.WHEN, YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
 358
 359     private static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
 360         return !NOCOPY_DEF_SET.contains(stmtContext.publicDefinition());
 361     }
 362
 363     private static final ImmutableSet<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
 364
 365     private static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
 366         return REUSED_DEF_SET.contains(stmtContext.publicDefinition());
 367     }
 368
 369     static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
 370         /*
 371          * :TODO Substatement must be allowed augment target type e.g.
 372          * Container, etc... and must not be for example grouping, identity etc.
 373          * It is problem in case when more than one substatements have the same
 374          * QName, for example Grouping and Container are siblings and they have
 375          * the same QName. We must find the Container and the Grouping must be
 376          * ignored as disallowed augment target.
 377          */
 378         final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
 379             ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
 380
 381         // if no allowed target is returned we consider all targets allowed
 382         return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
 383                 || allowedAugmentTargets.contains(substatementCtx.publicDefinition());
 384     }
 385 }