2 * Copyright (c) 2017 Pantheon Technologies, s.r.o. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.parser.rfc7950.stmt.augment;
10 import com.google.common.base.Verify;
11 import com.google.common.collect.ImmutableSet;
12 import java.util.ArrayList;
13 import java.util.Collection;
14 import java.util.Objects;
16 import java.util.regex.Pattern;
17 import org.opendaylight.yangtools.yang.common.QName;
18 import org.opendaylight.yangtools.yang.common.YangVersion;
19 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
20 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
21 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
24 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
26 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
27 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
28 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
35 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
36 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
37 import org.opendaylight.yangtools.yang.parser.spi.source.StmtOrderingNamespace;
38 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
39 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
40 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
41 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.SchemaNodeIdentifierBuildNamespace;
42 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.Utils;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
46 abstract class AbstractAugmentStatementSupport extends AbstractStatementSupport<SchemaNodeIdentifier, AugmentStatement,
47 EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> {
48 private static final Logger LOG = LoggerFactory.getLogger(AugmentStatementImpl.class);
49 private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
50 private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
52 AbstractAugmentStatementSupport() {
53 super(YangStmtMapping.AUGMENT);
57 public final SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
58 SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
59 || PATH_REL_PATTERN2.matcher(value).matches(), ctx.getStatementSourceReference(),
60 "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses",
63 return Utils.nodeIdentifierFromPath(ctx, value);
67 public final AugmentStatement createDeclared(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
68 return new AugmentStatementImpl(ctx);
72 public final EffectiveStatement<SchemaNodeIdentifier, AugmentStatement> createEffective(
73 final StmtContext<SchemaNodeIdentifier, AugmentStatement,
74 EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> ctx) {
75 return new AugmentEffectiveStatementImpl(ctx);
79 public final void onFullDefinitionDeclared(final Mutable<SchemaNodeIdentifier, AugmentStatement,
80 EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> augmentNode) {
81 if (!augmentNode.isSupportedByFeatures()) {
85 super.onFullDefinitionDeclared(augmentNode);
87 if (StmtContextUtils.isInExtensionBody(augmentNode)) {
91 final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(
92 ModelProcessingPhase.EFFECTIVE_MODEL);
93 final Prerequisite<StmtContext<SchemaNodeIdentifier, AugmentStatement,
94 EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>>> sourceCtxPrereq =
95 augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
96 final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target =
97 augmentAction.mutatesEffectiveCtx(getSearchRoot(augmentNode),
98 SchemaNodeIdentifierBuildNamespace.class, augmentNode.getStatementArgument());
100 augmentAction.apply(new ModelActionBuilder.InferenceAction() {
102 public void apply(final ModelActionBuilder.InferenceContext ctx) {
103 final StatementContextBase<?, ?, ?> augmentTargetCtx =
104 (StatementContextBase<?, ?, ?>) target.resolve(ctx);
105 if (!isSupportedAugmentTarget(augmentTargetCtx)
106 || StmtContextUtils.isInExtensionBody(augmentTargetCtx)) {
107 augmentNode.setIsSupportedToBuildEffective(false);
111 * Marks case short hand in augment
113 if (augmentTargetCtx.getPublicDefinition() == YangStmtMapping.CHOICE) {
114 augmentNode.addToNs(AugmentToChoiceNamespace.class, augmentNode, Boolean.TRUE);
117 // FIXME: this is a workaround for models which augment a node which is added via an extension
118 // which we do not handle. This needs to be reworked in terms of unknown schema nodes.
119 final StatementContextBase<?, ?, ?> augmentSourceCtx = (StatementContextBase<?, ?, ?>) augmentNode;
121 copyFromSourceToTarget(augmentSourceCtx, augmentTargetCtx);
122 augmentTargetCtx.addEffectiveSubstatement(augmentSourceCtx);
123 updateAugmentOrder(augmentSourceCtx);
124 } catch (final SourceException e) {
125 LOG.warn("Failed to add augmentation {} defined at {}",
126 augmentTargetCtx.getStatementSourceReference(),
127 augmentSourceCtx.getStatementSourceReference(), e);
131 private void updateAugmentOrder(final StatementContextBase<?, ?, ?> augmentSourceCtx) {
132 Integer currentOrder = augmentSourceCtx.getFromNamespace(StmtOrderingNamespace.class,
133 YangStmtMapping.AUGMENT);
134 if (currentOrder == null) {
140 augmentSourceCtx.addToNs(StmtOrderingNamespace.class, YangStmtMapping.AUGMENT, currentOrder);
144 public void prerequisiteFailed(final Collection<? extends ModelActionBuilder.Prerequisite<?>> failed) {
146 * Do not fail, if it is an uses-augment to an unknown node.
148 if (YangStmtMapping.USES == augmentNode.getParentContext().getPublicDefinition()) {
149 final StatementContextBase<?, ?, ?> targetNode = Utils.findNode(getSearchRoot(augmentNode),
150 augmentNode.getStatementArgument());
151 if (targetNode != null && StmtContextUtils.isUnknownStatement(targetNode)) {
152 augmentNode.setIsSupportedToBuildEffective(false);
154 "Uses-augment to unknown node {}. Augmentation has not been performed. At line: {}",
155 augmentNode.getStatementArgument(), augmentNode.getStatementSourceReference());
160 throw new InferenceException(augmentNode.getStatementSourceReference(),
161 "Augment target '%s' not found", augmentNode.getStatementArgument());
166 private static Mutable<?, ?, ?> getSearchRoot(final Mutable<?, ?, ?> augmentContext) {
167 final Mutable<?, ?, ?> parent = augmentContext.getParentContext();
168 // Augment is in uses - we need to augment instantiated nodes in parent.
169 if (YangStmtMapping.USES == parent.getPublicDefinition()) {
170 return parent.getParentContext();
175 static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
176 final StatementContextBase<?, ?, ?> targetCtx) {
177 final CopyType typeOfCopy = UsesStatement.class.equals(sourceCtx.getParentContext().getPublicDefinition()
178 .getDeclaredRepresentationClass()) ? CopyType.ADDED_BY_USES_AUGMENTATION
179 : CopyType.ADDED_BY_AUGMENTATION;
181 * Since Yang 1.1, if an augmentation is made conditional with a
182 * "when" statement, it is allowed to add mandatory nodes.
184 final boolean skipCheckOfMandatoryNodes = YangVersion.VERSION_1_1.equals(sourceCtx.getRootVersion())
185 && isConditionalAugmentStmt(sourceCtx);
187 final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
188 final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
189 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
191 for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
192 if (originalStmtCtx.isSupportedByFeatures()) {
193 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
196 for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
197 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
200 targetCtx.addEffectiveSubstatements(buffer);
204 * Checks whether supplied statement context is conditional augment
208 * statement context to be checked
210 * @return true if supplied statement context is conditional augment
211 * statement, otherwise false
213 private static boolean isConditionalAugmentStmt(final StmtContext<?, ?, ?> ctx) {
214 return ctx.getPublicDefinition() == YangStmtMapping.AUGMENT
215 && StmtContextUtils.findFirstSubstatement(ctx, WhenStatement.class) != null;
218 private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
219 final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
220 final boolean skipCheckOfMandatoryNodes) {
221 if (needToCopyByAugment(original)) {
222 validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
224 buffer.add(target.childCopyOf(original, typeOfCopy));
225 } else if (isReusedByAugment(original)) {
226 buffer.add(original);
230 private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
231 final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
232 final boolean skipCheckOfMandatoryNodes) {
234 if (WhenStatement.class.equals(sourceCtx.getPublicDefinition().getDeclaredRepresentationClass())) {
238 if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
239 && reguiredCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
240 checkForMandatoryNodes(sourceCtx);
243 for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
244 final boolean sourceIsDataNode = DataDefinitionStatement.class.isAssignableFrom(sourceCtx
245 .getPublicDefinition().getDeclaredRepresentationClass());
246 final boolean targetIsDataNode = DataDefinitionStatement.class.isAssignableFrom(subStatement
247 .getPublicDefinition().getDeclaredRepresentationClass());
248 final boolean qNamesEqual = sourceIsDataNode && targetIsDataNode
249 && Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument());
251 InferenceException.throwIf(qNamesEqual, sourceCtx.getStatementSourceReference(),
252 "An augment cannot add node named '%s' because this name is already used in target",
253 sourceCtx.rawStatementArgument());
257 private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
258 if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
260 * We need to iterate over both declared and effective sub-statements,
261 * because a mandatory node can be:
262 * a) declared in augment body
263 * b) added to augment body also via uses of a grouping and
264 * such sub-statements are stored in effective sub-statements collection.
266 sourceCtx.allSubstatementsStream().forEach(AbstractAugmentStatementSupport::checkForMandatoryNodes);
269 InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx),
270 sourceCtx.getStatementSourceReference(),
271 "An augment cannot add node '%s' because it is mandatory and in module different than target",
272 sourceCtx.rawStatementArgument());
275 private static boolean reguiredCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
276 Mutable<?, ?, ?> targetCtx) {
278 * If the statement argument is not QName, it cannot be mandatory
279 * statement, therefore return false and skip mandatory nodes validation
281 if (!(sourceCtx.getStatementArgument() instanceof QName)) {
284 final QName sourceStmtQName = (QName) sourceCtx.getStatementArgument();
286 // RootStatementContext, for example
287 final Mutable<?, ?, ?> root = targetCtx.getRoot();
289 Verify.verify(targetCtx.getStatementArgument() instanceof QName,
290 "Argument of augment target statement must be QName.");
291 final QName targetStmtQName = (QName) targetCtx.getStatementArgument();
293 * If target is from another module, return true and perform mandatory nodes validation
295 if (!targetStmtQName.getModule().equals(sourceStmtQName.getModule())) {
300 * If target or one of the target's ancestors from the same namespace
301 * is a presence container
302 * or is non-mandatory choice
303 * or is non-mandatory list
304 * return false and skip mandatory nodes validation, because these nodes
305 * are not mandatory node containers according to RFC 6020 section 3.1.
307 if (StmtContextUtils.isPresenceContainer(targetCtx)
308 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
309 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
312 } while ((targetCtx = targetCtx.getParentContext()) != root);
315 * All target node's parents belong to the same module as source node,
316 * therefore return false and skip mandatory nodes validation.
321 private static final Set<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES,
322 YangStmtMapping.WHEN, YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
324 private static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
325 return !NOCOPY_DEF_SET.contains(stmtContext.getPublicDefinition());
328 private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
330 private static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
331 return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
334 static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
336 * :TODO Substatement must be allowed augment target type e.g.
337 * Container, etc... and must not be for example grouping, identity etc.
338 * It is problem in case when more than one substatements have the same
339 * QName, for example Grouping and Container are siblings and they have
340 * the same QName. We must find the Container and the Grouping must be
341 * ignored as disallowed augment target.
343 final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
344 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
346 // if no allowed target is returned we consider all targets allowed
347 return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
348 || allowedAugmentTargets.contains(substatementCtx.getPublicDefinition());