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.list;
10 import static com.google.common.base.Verify.verify;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.ImmutableList;
14 import com.google.common.collect.ImmutableSet;
15 import java.util.ArrayList;
16 import java.util.Collection;
17 import java.util.HashSet;
18 import java.util.List;
19 import java.util.Optional;
21 import org.eclipse.jdt.annotation.NonNull;
22 import org.opendaylight.yangtools.concepts.Immutable;
23 import org.opendaylight.yangtools.yang.common.Ordering;
24 import org.opendaylight.yangtools.yang.common.QName;
25 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
26 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.Status;
29 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
30 import org.opendaylight.yangtools.yang.model.api.meta.DeclarationReference;
31 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
32 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
33 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
34 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
35 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
36 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
37 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
38 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
39 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatementDecorators;
40 import org.opendaylight.yangtools.yang.model.ri.stmt.DeclaredStatements;
41 import org.opendaylight.yangtools.yang.model.spi.meta.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
42 import org.opendaylight.yangtools.yang.model.spi.meta.SubstatementIndexingException;
43 import org.opendaylight.yangtools.yang.parser.api.YangParserConfiguration;
44 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractSchemaTreeStatementSupport;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx;
47 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
48 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent;
49 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent.EffectiveConfig;
50 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
51 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
52 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
53 import org.opendaylight.yangtools.yang.parser.spi.meta.SubstatementValidator;
54 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
55 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
56 import org.slf4j.Logger;
57 import org.slf4j.LoggerFactory;
60 public final class ListStatementSupport
61 extends AbstractSchemaTreeStatementSupport<ListStatement, ListEffectiveStatement> {
62 private static final Logger LOG = LoggerFactory.getLogger(ListStatementSupport.class);
63 private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
64 YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
66 private static final SubstatementValidator RFC6020_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.LIST)
67 .addAny(YangStmtMapping.ANYXML)
68 .addAny(YangStmtMapping.CHOICE)
69 .addOptional(YangStmtMapping.CONFIG)
70 .addAny(YangStmtMapping.CONTAINER)
71 .addOptional(YangStmtMapping.DESCRIPTION)
72 .addAny(YangStmtMapping.GROUPING)
73 .addAny(YangStmtMapping.IF_FEATURE)
74 .addOptional(YangStmtMapping.KEY)
75 .addAny(YangStmtMapping.LEAF)
76 .addAny(YangStmtMapping.LEAF_LIST)
77 .addAny(YangStmtMapping.LIST)
78 .addOptional(YangStmtMapping.MAX_ELEMENTS)
79 .addOptional(YangStmtMapping.MIN_ELEMENTS)
80 .addAny(YangStmtMapping.MUST)
81 .addOptional(YangStmtMapping.ORDERED_BY)
82 .addOptional(YangStmtMapping.REFERENCE)
83 .addOptional(YangStmtMapping.STATUS)
84 .addAny(YangStmtMapping.TYPEDEF)
85 .addAny(YangStmtMapping.UNIQUE)
86 .addAny(YangStmtMapping.USES)
87 .addOptional(YangStmtMapping.WHEN)
89 private static final SubstatementValidator RFC7950_VALIDATOR = SubstatementValidator.builder(YangStmtMapping.LIST)
90 .addAny(YangStmtMapping.ACTION)
91 .addAny(YangStmtMapping.ANYDATA)
92 .addAny(YangStmtMapping.ANYXML)
93 .addAny(YangStmtMapping.CHOICE)
94 .addOptional(YangStmtMapping.CONFIG)
95 .addAny(YangStmtMapping.CONTAINER)
96 .addOptional(YangStmtMapping.DESCRIPTION)
97 .addAny(YangStmtMapping.GROUPING)
98 .addAny(YangStmtMapping.IF_FEATURE)
99 .addOptional(YangStmtMapping.KEY)
100 .addAny(YangStmtMapping.LEAF)
101 .addAny(YangStmtMapping.LEAF_LIST)
102 .addAny(YangStmtMapping.LIST)
103 .addOptional(YangStmtMapping.MAX_ELEMENTS)
104 .addOptional(YangStmtMapping.MIN_ELEMENTS)
105 .addAny(YangStmtMapping.MUST)
106 .addAny(YangStmtMapping.NOTIFICATION)
107 .addOptional(YangStmtMapping.ORDERED_BY)
108 .addOptional(YangStmtMapping.REFERENCE)
109 .addOptional(YangStmtMapping.STATUS)
110 .addAny(YangStmtMapping.TYPEDEF)
111 .addAny(YangStmtMapping.UNIQUE)
112 .addAny(YangStmtMapping.USES)
113 .addOptional(YangStmtMapping.WHEN)
116 ListStatementSupport(final YangParserConfiguration config, final SubstatementValidator validator) {
117 super(YangStmtMapping.LIST, instantiatedPolicy(), config, validator);
120 public static @NonNull ListStatementSupport rfc6020Instance(final YangParserConfiguration config) {
121 return new ListStatementSupport(config, RFC6020_VALIDATOR);
124 public static @NonNull ListStatementSupport rfc7950Instance(final YangParserConfiguration config) {
125 return new ListStatementSupport(config, RFC7950_VALIDATOR);
129 protected ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
130 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
131 return DeclaredStatements.createList(ctx.getArgument(), substatements);
135 protected ListStatement attachDeclarationReference(final ListStatement stmt, final DeclarationReference reference) {
136 return DeclaredStatementDecorators.decorateList(stmt, reference);
140 public ListEffectiveStatement copyEffective(final Current<QName, ListStatement> stmt,
141 final ListEffectiveStatement original) {
142 final int flags = computeFlags(stmt, original.effectiveSubstatements());
143 if (original instanceof RegularListEffectiveStatement) {
144 return new RegularListEffectiveStatement((RegularListEffectiveStatement) original,
145 stmt.original(ListSchemaNode.class), stmt.effectivePath(), flags);
146 } else if (original instanceof EmptyListEffectiveStatement) {
147 return new RegularListEffectiveStatement((EmptyListEffectiveStatement) original,
148 stmt.original(ListSchemaNode.class), stmt.effectivePath(), flags);
151 return super.copyEffective(stmt, original);
156 protected ListEffectiveStatement createEffective(final Current<QName, ListStatement> stmt,
157 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
158 final ImmutableList<QName> keyDefinition;
159 final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
160 if (keyStmt != null) {
161 final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
162 final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
163 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
164 if (effectiveStatement instanceof LeafSchemaNode) {
165 possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
168 for (final QName keyQName : keyStmt.argument()) {
169 if (!possibleLeafQNamesForKey.contains(keyQName)) {
170 throw new InferenceException(stmt, "Key '%s' misses node '%s' in list '%s'",
171 keyStmt.getDeclared().rawArgument(), keyQName.getLocalName(), stmt.argument());
173 keyDefinitionInit.add(keyQName);
176 keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
178 keyDefinition = ImmutableList.of();
181 final int flags = computeFlags(stmt, substatements);
182 if (stmt.effectiveConfig() == EffectiveConfig.TRUE && keyDefinition.isEmpty() && isInstantied(stmt)) {
183 warnConfigList(stmt);
186 EffectiveStmtUtils.checkUniqueGroupings(stmt, substatements);
187 EffectiveStmtUtils.checkUniqueTypedefs(stmt, substatements);
188 EffectiveStmtUtils.checkUniqueUses(stmt, substatements);
190 final Optional<ElementCountConstraint> elementCountConstraint =
191 EffectiveStmtUtils.createElementCountConstraint(substatements);
192 final Immutable path = stmt.effectivePath();
193 final ListSchemaNode original = stmt.original(ListSchemaNode.class);
195 return original == null && !elementCountConstraint.isPresent()
196 ? new EmptyListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition)
197 : new RegularListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition,
198 elementCountConstraint.orElse(null), original);
199 } catch (SubstatementIndexingException e) {
200 throw new SourceException(e.getMessage(), stmt, e);
204 private static int computeFlags(final Current<?, ?> stmt,
205 final Collection<? extends EffectiveStatement<?, ?>> substatements) {
206 return new FlagsBuilder()
207 .setHistory(stmt.history())
208 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
209 .setConfiguration(stmt.effectiveConfig().asNullable())
210 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
211 .equals(Ordering.USER))
215 private static void warnConfigList(final @NonNull Current<QName, ListStatement> stmt) {
216 final StatementSourceReference ref = stmt.sourceReference();
217 final Boolean warned = stmt.getFromNamespace(ConfigListWarningNamespace.class, ref);
218 // Hacky check if we have issued a warning for the original statement
219 if (warned == null) {
220 final StmtContext<?, ?, ?> ctx = stmt.caerbannog();
221 verify(ctx instanceof Mutable, "Unexpected context %s", ctx);
222 ((Mutable<?, ?, ?>) ctx).addToNs(ConfigListWarningNamespace.class, ref, Boolean.TRUE);
223 LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
224 + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
225 + "[defined at {}]", stmt.argument(), ref);
229 private static boolean isInstantied(final EffectiveStmtCtx ctx) {
230 Parent parent = ctx.effectiveParent();
231 while (parent != null) {
232 final StatementDefinition parentDef = parent.publicDefinition();
233 if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
237 final Parent grandParent = parent.effectiveParent();
238 if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
239 // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
240 // dealing with an uninstantiated context.
241 final StatementDefinition grandParentDef = grandParent.publicDefinition();
242 if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
247 parent = grandParent;