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;
11 import static java.util.Objects.requireNonNull;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.ImmutableList;
15 import com.google.common.collect.ImmutableSet;
16 import java.util.ArrayList;
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.yang.common.Ordering;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
25 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
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.DeclaredStatement;
31 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
32 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
33 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
34 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
35 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
36 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
37 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseSchemaTreeStatementSupport;
39 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
40 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
41 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.SubstatementIndexingException;
42 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx;
43 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Current;
44 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent;
45 import org.opendaylight.yangtools.yang.parser.spi.meta.EffectiveStmtCtx.Parent.EffectiveConfig;
46 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
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.SubstatementValidator;
50 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
51 import org.opendaylight.yangtools.yang.parser.spi.source.StatementSourceReference;
52 import org.slf4j.Logger;
53 import org.slf4j.LoggerFactory;
56 public final class ListStatementSupport extends BaseSchemaTreeStatementSupport<ListStatement, ListEffectiveStatement> {
57 private static final Logger LOG = LoggerFactory.getLogger(ListStatementSupport.class);
58 private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
59 YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
61 private static final @NonNull ListStatementSupport RFC6020_INSTANCE = new ListStatementSupport(
62 SubstatementValidator.builder(YangStmtMapping.LIST)
63 .addAny(YangStmtMapping.ANYXML)
64 .addAny(YangStmtMapping.CHOICE)
65 .addOptional(YangStmtMapping.CONFIG)
66 .addAny(YangStmtMapping.CONTAINER)
67 .addOptional(YangStmtMapping.DESCRIPTION)
68 .addAny(YangStmtMapping.GROUPING)
69 .addAny(YangStmtMapping.IF_FEATURE)
70 .addOptional(YangStmtMapping.KEY)
71 .addAny(YangStmtMapping.LEAF)
72 .addAny(YangStmtMapping.LEAF_LIST)
73 .addAny(YangStmtMapping.LIST)
74 .addOptional(YangStmtMapping.MAX_ELEMENTS)
75 .addOptional(YangStmtMapping.MIN_ELEMENTS)
76 .addAny(YangStmtMapping.MUST)
77 .addOptional(YangStmtMapping.ORDERED_BY)
78 .addOptional(YangStmtMapping.REFERENCE)
79 .addOptional(YangStmtMapping.STATUS)
80 .addAny(YangStmtMapping.TYPEDEF)
81 .addAny(YangStmtMapping.UNIQUE)
82 .addAny(YangStmtMapping.USES)
83 .addOptional(YangStmtMapping.WHEN)
85 private static final @NonNull ListStatementSupport RFC7950_INSTANCE = new ListStatementSupport(
86 SubstatementValidator.builder(YangStmtMapping.LIST)
87 .addAny(YangStmtMapping.ACTION)
88 .addAny(YangStmtMapping.ANYDATA)
89 .addAny(YangStmtMapping.ANYXML)
90 .addAny(YangStmtMapping.CHOICE)
91 .addOptional(YangStmtMapping.CONFIG)
92 .addAny(YangStmtMapping.CONTAINER)
93 .addOptional(YangStmtMapping.DESCRIPTION)
94 .addAny(YangStmtMapping.GROUPING)
95 .addAny(YangStmtMapping.IF_FEATURE)
96 .addOptional(YangStmtMapping.KEY)
97 .addAny(YangStmtMapping.LEAF)
98 .addAny(YangStmtMapping.LEAF_LIST)
99 .addAny(YangStmtMapping.LIST)
100 .addOptional(YangStmtMapping.MAX_ELEMENTS)
101 .addOptional(YangStmtMapping.MIN_ELEMENTS)
102 .addAny(YangStmtMapping.MUST)
103 .addAny(YangStmtMapping.NOTIFICATION)
104 .addOptional(YangStmtMapping.ORDERED_BY)
105 .addOptional(YangStmtMapping.REFERENCE)
106 .addOptional(YangStmtMapping.STATUS)
107 .addAny(YangStmtMapping.TYPEDEF)
108 .addAny(YangStmtMapping.UNIQUE)
109 .addAny(YangStmtMapping.USES)
110 .addOptional(YangStmtMapping.WHEN)
113 private final SubstatementValidator validator;
115 ListStatementSupport(final SubstatementValidator validator) {
116 super(YangStmtMapping.LIST, CopyPolicy.DECLARED_COPY);
117 this.validator = requireNonNull(validator);
120 public static @NonNull ListStatementSupport rfc6020Instance() {
121 return RFC6020_INSTANCE;
124 public static @NonNull ListStatementSupport rfc7950Instance() {
125 return RFC7950_INSTANCE;
129 protected SubstatementValidator getSubstatementValidator() {
134 protected ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
135 final ImmutableList<? extends DeclaredStatement<?>> substatements) {
136 return new RegularListStatement(ctx.getArgument(), substatements);
140 protected ListStatement createEmptyDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
141 return new EmptyListStatement(ctx.getArgument());
145 protected ListEffectiveStatement createEffective(final Current<QName, ListStatement> stmt,
146 final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
147 final ListSchemaNode original = (ListSchemaNode) stmt.original();
149 final ImmutableList<QName> keyDefinition;
150 final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
151 if (keyStmt != null) {
152 final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
153 final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
154 for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
155 if (effectiveStatement instanceof LeafSchemaNode) {
156 possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
159 for (final QName keyQName : keyStmt.argument()) {
160 if (!possibleLeafQNamesForKey.contains(keyQName)) {
161 throw new InferenceException(stmt, "Key '%s' misses node '%s' in list '%s'",
162 keyStmt.getDeclared().rawArgument(), keyQName.getLocalName(), stmt.argument());
164 keyDefinitionInit.add(keyQName);
167 keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
169 keyDefinition = ImmutableList.of();
172 final EffectiveConfig configuration = stmt.effectiveConfig();
173 final int flags = new FlagsBuilder()
174 .setHistory(stmt.history())
175 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
176 .setConfiguration(configuration.asNullable())
177 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
178 .equals(Ordering.USER))
180 if (configuration == EffectiveConfig.TRUE && keyDefinition.isEmpty() && isInstantied(stmt)) {
181 warnConfigList(stmt);
184 EffectiveStmtUtils.checkUniqueGroupings(stmt, substatements);
185 EffectiveStmtUtils.checkUniqueTypedefs(stmt, substatements);
186 EffectiveStmtUtils.checkUniqueUses(stmt, substatements);
188 final Optional<ElementCountConstraint> elementCountConstraint =
189 EffectiveStmtUtils.createElementCountConstraint(substatements);
190 final SchemaPath path = stmt.wrapSchemaPath();
192 return original == null && !elementCountConstraint.isPresent()
193 ? new EmptyListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition)
194 : new RegularListEffectiveStatement(stmt.declared(), path, flags, substatements, keyDefinition,
195 elementCountConstraint.orElse(null), original);
196 } catch (SubstatementIndexingException e) {
197 throw new SourceException(e.getMessage(), stmt, e);
201 private static void warnConfigList(final @NonNull Current<QName, ListStatement> stmt) {
202 final StatementSourceReference ref = stmt.sourceReference();
203 final Boolean warned = stmt.getFromNamespace(ConfigListWarningNamespace.class, ref);
204 // Hacky check if we have issued a warning for the original statement
205 if (warned == null) {
206 final StmtContext<?, ?, ?> ctx = stmt.caerbannog();
207 verify(ctx instanceof Mutable, "Unexpected context %s", ctx);
208 ((Mutable<?, ?, ?>) ctx).addToNs(ConfigListWarningNamespace.class, ref, Boolean.TRUE);
209 LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
210 + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
211 + "[defined at {}]", stmt.argument(), ref);
215 private static boolean isInstantied(final EffectiveStmtCtx ctx) {
216 Parent parent = ctx.effectiveParent();
217 while (parent != null) {
218 final StatementDefinition parentDef = parent.publicDefinition();
219 if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parentDef)) {
223 final Parent grandParent = parent.effectiveParent();
224 if (YangStmtMapping.AUGMENT == parentDef && grandParent != null) {
225 // If this is an augment statement and its parent is either a 'module' or 'submodule' statement, we are
226 // dealing with an uninstantiated context.
227 final StatementDefinition grandParentDef = grandParent.publicDefinition();
228 if (YangStmtMapping.MODULE == grandParentDef || YangStmtMapping.SUBMODULE == grandParentDef) {
233 parent = grandParent;