2 * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
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 javax.annotation.Nonnull;
18 import org.opendaylight.yangtools.yang.common.QName;
19 import org.opendaylight.yangtools.yang.common.YangVersion;
20 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
21 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
22 import org.opendaylight.yangtools.yang.model.api.stmt.ActionStatement;
23 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
24 import org.opendaylight.yangtools.yang.model.api.stmt.DataDefinitionStatement;
25 import org.opendaylight.yangtools.yang.model.api.stmt.NotificationStatement;
26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
27 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
28 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
29 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
30 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
31 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
32 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
33 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
34 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
35 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
36 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
37 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
38 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
39 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
40 import org.opendaylight.yangtools.yang.parser.spi.source.AugmentToChoiceNamespace;
41 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
42 import org.opendaylight.yangtools.yang.parser.spi.source.StmtOrderingNamespace;
43 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
44 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
45 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
46 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.AugmentEffectiveStatementImpl;
47 import org.slf4j.Logger;
48 import org.slf4j.LoggerFactory;
50 public class AugmentStatementImpl extends AbstractDeclaredStatement<SchemaNodeIdentifier> implements AugmentStatement {
51 private static final Logger LOG = LoggerFactory.getLogger(AugmentStatementImpl.class);
52 private static final Pattern PATH_REL_PATTERN1 = Pattern.compile("\\.\\.?\\s*/(.+)");
53 private static final Pattern PATH_REL_PATTERN2 = Pattern.compile("//.*");
54 private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator
55 .builder(YangStmtMapping.AUGMENT)
56 .addAny(YangStmtMapping.ANYXML)
57 .addAny(YangStmtMapping.CASE)
58 .addAny(YangStmtMapping.CHOICE)
59 .addAny(YangStmtMapping.CONTAINER)
60 .addOptional(YangStmtMapping.DESCRIPTION)
61 .addAny(YangStmtMapping.IF_FEATURE)
62 .addAny(YangStmtMapping.LEAF)
63 .addAny(YangStmtMapping.LEAF_LIST)
64 .addAny(YangStmtMapping.LIST)
65 .addOptional(YangStmtMapping.REFERENCE)
66 .addOptional(YangStmtMapping.STATUS)
67 .addAny(YangStmtMapping.USES)
68 .addOptional(YangStmtMapping.WHEN)
71 protected AugmentStatementImpl(final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> context) {
75 public static class Definition extends
76 AbstractStatementSupport<SchemaNodeIdentifier, AugmentStatement, EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> {
79 super(YangStmtMapping.AUGMENT);
83 public SchemaNodeIdentifier parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
84 SourceException.throwIf(PATH_REL_PATTERN1.matcher(value).matches()
85 || PATH_REL_PATTERN2.matcher(value).matches(), ctx.getStatementSourceReference(),
86 "Augment argument \'%s\' is not valid, it can be only absolute path; or descendant if used in uses",
89 return Utils.nodeIdentifierFromPath(ctx, value);
93 public AugmentStatement createDeclared(
94 final StmtContext<SchemaNodeIdentifier, AugmentStatement, ?> ctx) {
95 return new AugmentStatementImpl(ctx);
99 public EffectiveStatement<SchemaNodeIdentifier, AugmentStatement> createEffective(
100 final StmtContext<SchemaNodeIdentifier, AugmentStatement, EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> ctx) {
101 return new AugmentEffectiveStatementImpl(ctx);
105 public void onFullDefinitionDeclared(
106 final Mutable<SchemaNodeIdentifier, AugmentStatement, EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>> augmentNode) {
107 if (!augmentNode.isSupportedByFeatures()) {
111 super.onFullDefinitionDeclared(augmentNode);
113 if (StmtContextUtils.isInExtensionBody(augmentNode)) {
117 final ModelActionBuilder augmentAction = augmentNode.newInferenceAction(
118 ModelProcessingPhase.EFFECTIVE_MODEL);
119 final ModelActionBuilder.Prerequisite<StmtContext<SchemaNodeIdentifier, AugmentStatement, EffectiveStatement<SchemaNodeIdentifier, AugmentStatement>>> sourceCtxPrereq =
120 augmentAction.requiresCtx(augmentNode, ModelProcessingPhase.EFFECTIVE_MODEL);
121 final Prerequisite<Mutable<?, ?, EffectiveStatement<?, ?>>> target =
122 augmentAction.mutatesEffectiveCtx(getSearchRoot(augmentNode), SchemaNodeIdentifierBuildNamespace.class, augmentNode.getStatementArgument());
123 augmentAction.apply(new ModelActionBuilder.InferenceAction() {
126 public void apply(final ModelActionBuilder.InferenceContext ctx) {
127 final StatementContextBase<?, ?, ?> augmentTargetCtx =
128 (StatementContextBase<?, ?, ?>) target.resolve(ctx);
129 if (!isSupportedAugmentTarget(augmentTargetCtx)
130 || StmtContextUtils.isInExtensionBody(augmentTargetCtx)) {
131 augmentNode.setIsSupportedToBuildEffective(false);
135 * Marks case short hand in augment
137 if (augmentTargetCtx.getPublicDefinition() == YangStmtMapping.CHOICE) {
138 augmentNode.addToNs(AugmentToChoiceNamespace.class, augmentNode, Boolean.TRUE);
141 // FIXME: this is a workaround for models which augment a node which is added via an extension
142 // which we do not handle. This needs to be reworked in terms of unknown schema nodes.
143 final StatementContextBase<?, ?, ?> augmentSourceCtx = (StatementContextBase<?, ?, ?>) augmentNode;
145 copyFromSourceToTarget(augmentSourceCtx, augmentTargetCtx);
146 augmentTargetCtx.addEffectiveSubstatement(augmentSourceCtx);
147 updateAugmentOrder(augmentSourceCtx);
148 } catch (final SourceException e) {
149 LOG.warn("Failed to add augmentation {} defined at {}",
150 augmentTargetCtx.getStatementSourceReference(),
151 augmentSourceCtx.getStatementSourceReference(), e);
155 private void updateAugmentOrder(final StatementContextBase<?, ?, ?> augmentSourceCtx) {
156 Integer currentOrder = augmentSourceCtx.getFromNamespace(StmtOrderingNamespace.class,
157 YangStmtMapping.AUGMENT);
158 if (currentOrder == null) {
164 augmentSourceCtx.addToNs(StmtOrderingNamespace.class, YangStmtMapping.AUGMENT, currentOrder);
168 public void prerequisiteFailed(final Collection<? extends ModelActionBuilder.Prerequisite<?>> failed) {
170 * Do not fail, if it is an uses-augment to an unknown node.
172 if (YangStmtMapping.USES == augmentNode.getParentContext().getPublicDefinition()) {
173 final StatementContextBase<?, ?, ?> targetNode = Utils.findNode(getSearchRoot(augmentNode),
174 augmentNode.getStatementArgument());
175 if (targetNode != null && StmtContextUtils.isUnknownStatement(targetNode)) {
176 augmentNode.setIsSupportedToBuildEffective(false);
178 "Uses-augment to unknown node {}. Augmentation has not been performed. At line: {}",
179 augmentNode.getStatementArgument(), augmentNode.getStatementSourceReference());
184 throw new InferenceException(augmentNode.getStatementSourceReference(),
185 "Augment target '%s' not found", augmentNode.getStatementArgument());
190 private static Mutable<?, ?, ?> getSearchRoot(final Mutable<?, ?, ?> augmentContext) {
191 final Mutable<?, ?, ?> parent = augmentContext.getParentContext();
192 // Augment is in uses - we need to augment instantiated nodes in parent.
193 if (YangStmtMapping.USES == parent.getPublicDefinition()) {
194 return parent.getParentContext();
199 public static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceCtx,
200 final StatementContextBase<?, ?, ?> targetCtx) {
201 final CopyType typeOfCopy = UsesStatement.class.equals(sourceCtx.getParentContext().getPublicDefinition()
202 .getDeclaredRepresentationClass()) ? CopyType.ADDED_BY_USES_AUGMENTATION
203 : CopyType.ADDED_BY_AUGMENTATION;
205 * Since Yang 1.1, if an augmentation is made conditional with a
206 * "when" statement, it is allowed to add mandatory nodes.
208 final boolean skipCheckOfMandatoryNodes = YangVersion.VERSION_1_1.equals(sourceCtx.getRootVersion())
209 && isConditionalAugmentStmt(sourceCtx);
211 final Collection<? extends Mutable<?, ?, ?>> declared = sourceCtx.mutableDeclaredSubstatements();
212 final Collection<? extends Mutable<?, ?, ?>> effective = sourceCtx.mutableEffectiveSubstatements();
213 final Collection<Mutable<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
215 for (final Mutable<?, ?, ?> originalStmtCtx : declared) {
216 if (originalStmtCtx.isSupportedByFeatures()) {
217 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
220 for (final Mutable<?, ?, ?> originalStmtCtx : effective) {
221 copyStatement(originalStmtCtx, targetCtx, typeOfCopy, buffer, skipCheckOfMandatoryNodes);
224 targetCtx.addEffectiveSubstatements(buffer);
228 * Checks whether supplied statement context is conditional augment
232 * statement context to be checked
234 * @return true if supplied statement context is conditional augment
235 * statement, otherwise false
237 private static boolean isConditionalAugmentStmt(final StmtContext<?, ?, ?> ctx) {
238 return ctx.getPublicDefinition() == YangStmtMapping.AUGMENT
239 && StmtContextUtils.findFirstSubstatement(ctx, WhenStatement.class) != null;
242 private static void copyStatement(final Mutable<?, ?, ?> original, final StatementContextBase<?, ?, ?> target,
243 final CopyType typeOfCopy, final Collection<Mutable<?, ?, ?>> buffer,
244 final boolean skipCheckOfMandatoryNodes) {
245 if (needToCopyByAugment(original)) {
246 validateNodeCanBeCopiedByAugment(original, target, typeOfCopy, skipCheckOfMandatoryNodes);
248 buffer.add(target.childCopyOf(original, typeOfCopy));
249 } else if (isReusedByAugment(original)) {
250 buffer.add(original);
254 private static void validateNodeCanBeCopiedByAugment(final StmtContext<?, ?, ?> sourceCtx,
255 final StatementContextBase<?, ?, ?> targetCtx, final CopyType typeOfCopy,
256 final boolean skipCheckOfMandatoryNodes) {
258 if (WhenStatement.class.equals(sourceCtx.getPublicDefinition().getDeclaredRepresentationClass())) {
262 if (!skipCheckOfMandatoryNodes && typeOfCopy == CopyType.ADDED_BY_AUGMENTATION
263 && reguiredCheckOfMandatoryNodes(sourceCtx, targetCtx)) {
264 checkForMandatoryNodes(sourceCtx);
267 for (final StmtContext<?, ?, ?> subStatement : targetCtx.allSubstatements()) {
268 final boolean sourceIsDataNode = DataDefinitionStatement.class.isAssignableFrom(sourceCtx
269 .getPublicDefinition().getDeclaredRepresentationClass());
270 final boolean targetIsDataNode = DataDefinitionStatement.class.isAssignableFrom(subStatement
271 .getPublicDefinition().getDeclaredRepresentationClass());
272 final boolean qNamesEqual = sourceIsDataNode && targetIsDataNode
273 && Objects.equals(sourceCtx.getStatementArgument(), subStatement.getStatementArgument());
275 InferenceException.throwIf(qNamesEqual, sourceCtx.getStatementSourceReference(),
276 "An augment cannot add node named '%s' because this name is already used in target",
277 sourceCtx.rawStatementArgument());
281 private static void checkForMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx) {
282 if (StmtContextUtils.isNonPresenceContainer(sourceCtx)) {
284 * We need to iterate over both declared and effective sub-statements,
285 * because a mandatory node can be:
286 * a) declared in augment body
287 * b) added to augment body also via uses of a grouping and
288 * such sub-statements are stored in effective sub-statements collection.
290 sourceCtx.allSubstatementsStream().forEach(Definition::checkForMandatoryNodes);
293 InferenceException.throwIf(StmtContextUtils.isMandatoryNode(sourceCtx),
294 sourceCtx.getStatementSourceReference(),
295 "An augment cannot add node '%s' because it is mandatory and in module different than target",
296 sourceCtx.rawStatementArgument());
299 private static boolean reguiredCheckOfMandatoryNodes(final StmtContext<?, ?, ?> sourceCtx,
300 Mutable<?, ?, ?> targetCtx) {
302 * If the statement argument is not QName, it cannot be mandatory
303 * statement, therefore return false and skip mandatory nodes validation
305 if (!(sourceCtx.getStatementArgument() instanceof QName)) {
308 final QName sourceStmtQName = (QName) sourceCtx.getStatementArgument();
310 // RootStatementContext, for example
311 final Mutable<?, ?, ?> root = targetCtx.getRoot();
313 Verify.verify(targetCtx.getStatementArgument() instanceof QName,
314 "Argument of augment target statement must be QName.");
315 final QName targetStmtQName = (QName) targetCtx.getStatementArgument();
317 * If target is from another module, return true and perform
318 * mandatory nodes validation
320 if (!Utils.belongsToTheSameModule(targetStmtQName, sourceStmtQName)) {
325 * If target or one of the target's ancestors from the same namespace
326 * is a presence container
327 * or is non-mandatory choice
328 * or is non-mandatory list
329 * return false and skip mandatory nodes validation, because these nodes
330 * are not mandatory node containers according to RFC 6020 section 3.1.
332 if (StmtContextUtils.isPresenceContainer(targetCtx)
333 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.CHOICE)
334 || StmtContextUtils.isNotMandatoryNodeOfType(targetCtx, YangStmtMapping.LIST)) {
337 } while ((targetCtx = targetCtx.getParentContext()) != root);
340 * All target node's parents belong to the same module as source node,
341 * therefore return false and skip mandatory nodes validation.
346 private static final Set<YangStmtMapping> NOCOPY_DEF_SET = ImmutableSet.of(YangStmtMapping.USES, YangStmtMapping.WHEN,
347 YangStmtMapping.DESCRIPTION, YangStmtMapping.REFERENCE, YangStmtMapping.STATUS);
349 public static boolean needToCopyByAugment(final StmtContext<?, ?, ?> stmtContext) {
350 return !NOCOPY_DEF_SET.contains(stmtContext.getPublicDefinition());
353 private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(YangStmtMapping.TYPEDEF);
355 public static boolean isReusedByAugment(final StmtContext<?, ?, ?> stmtContext) {
356 return REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
359 static boolean isSupportedAugmentTarget(final StmtContext<?, ?, ?> substatementCtx) {
361 * :TODO Substatement must be allowed augment target type e.g.
362 * Container, etc... and must not be for example grouping, identity etc.
363 * It is problem in case when more than one substatements have the same
364 * QName, for example Grouping and Container are siblings and they have
365 * the same QName. We must find the Container and the Grouping must be
366 * ignored as disallowed augment target.
368 final Collection<?> allowedAugmentTargets = substatementCtx.getFromNamespace(
369 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_AUGMENT_TARGETS);
371 // if no allowed target is returned we consider all targets allowed
372 return allowedAugmentTargets == null || allowedAugmentTargets.isEmpty()
373 || allowedAugmentTargets.contains(substatementCtx.getPublicDefinition());
377 protected SubstatementValidator getSubstatementValidator() {
378 return SUBSTATEMENT_VALIDATOR;
384 public SchemaNodeIdentifier getTargetNode() {
390 public Collection<? extends DataDefinitionStatement> getDataDefinitions() {
391 return allDeclared(DataDefinitionStatement.class);
396 public Collection<? extends ActionStatement> getActions() {
397 return allDeclared(ActionStatement.class);
401 public final Collection<? extends NotificationStatement> getNotifications() {
402 return allDeclared(NotificationStatement.class);