yang/yang-parser-rfc7950/src/main/java/org/opendaylight/yangtools/yang/parser/rfc7950/stmt/list/AbstractListStatementSupport.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.list;
   9
  10 import static com.google.common.base.Verify.verify;
  11
  12 import com.google.common.collect.ImmutableList;
  13 import com.google.common.collect.ImmutableSet;
  14 import java.util.ArrayList;
  15 import java.util.HashSet;
  16 import java.util.List;
  17 import java.util.Optional;
  18 import java.util.Set;
  19 import org.eclipse.jdt.annotation.NonNull;
  20 import org.opendaylight.yangtools.yang.common.QName;
  21 import org.opendaylight.yangtools.yang.model.api.ElementCountConstraint;
  22 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  25 import org.opendaylight.yangtools.yang.model.api.Status;
  26 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  27 import org.opendaylight.yangtools.yang.model.api.meta.DeclaredStatement;
  28 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.KeyEffectiveStatement;
  30 import org.opendaylight.yangtools.yang.model.api.stmt.ListEffectiveStatement;
  31 import org.opendaylight.yangtools.yang.model.api.stmt.ListStatement;
  32 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByEffectiveStatement;
  33 import org.opendaylight.yangtools.yang.model.api.stmt.OrderedByStatement.Ordering;
  34 import org.opendaylight.yangtools.yang.model.api.stmt.StatusEffectiveStatement;
  35 import org.opendaylight.yangtools.yang.parser.rfc7950.namespace.ChildSchemaNodeNamespace;
  36 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.BaseQNameStatementSupport;
  37 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStatementMixins.EffectiveStatementWithFlags.FlagsBuilder;
  38 import org.opendaylight.yangtools.yang.parser.rfc7950.stmt.EffectiveStmtUtils;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  43 import org.slf4j.Logger;
  44 import org.slf4j.LoggerFactory;
  45
  46 abstract class AbstractListStatementSupport extends BaseQNameStatementSupport<ListStatement, ListEffectiveStatement> {
  47     private static final Logger LOG = LoggerFactory.getLogger(AbstractListStatementSupport.class);
  48     private static final ImmutableSet<YangStmtMapping> UNINSTANTIATED_DATATREE_STATEMENTS = ImmutableSet.of(
  49         YangStmtMapping.GROUPING, YangStmtMapping.NOTIFICATION, YangStmtMapping.INPUT, YangStmtMapping.OUTPUT);
  50
  51     AbstractListStatementSupport() {
  52         super(YangStmtMapping.LIST);
  53     }
  54
  55     @Override
  56     public final QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  57         return StmtContextUtils.parseIdentifier(ctx, value);
  58     }
  59
  60     @Override
  61     public final void onStatementAdded(final Mutable<QName, ListStatement, ListEffectiveStatement> stmt) {
  62         stmt.coerceParentContext().addToNs(ChildSchemaNodeNamespace.class, stmt.coerceStatementArgument(), stmt);
  63     }
  64
  65     @Override
  66     protected final ListStatement createDeclared(final StmtContext<QName, ListStatement, ?> ctx,
  67             final ImmutableList<? extends DeclaredStatement<?>> substatements) {
  68         return new RegularListStatement(ctx.coerceStatementArgument(), substatements);
  69     }
  70
  71     @Override
  72     protected final ListStatement createEmptyDeclared(final StmtContext<QName, ListStatement, ?> ctx) {
  73         return new EmptyListStatement(ctx.coerceStatementArgument());
  74     }
  75
  76     @Override
  77     protected final ListEffectiveStatement createEffective(
  78             final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx,
  79             final ListStatement declared, final ImmutableList<? extends EffectiveStatement<?, ?>> substatements) {
  80         final SchemaPath path = ctx.getSchemaPath().get();
  81         final ListSchemaNode original = (ListSchemaNode) ctx.getOriginalCtx().map(StmtContext::buildEffective)
  82                 .orElse(null);
  83
  84         final ImmutableList<QName> keyDefinition;
  85         final KeyEffectiveStatement keyStmt = findFirstStatement(substatements, KeyEffectiveStatement.class);
  86         if (keyStmt != null) {
  87             final List<QName> keyDefinitionInit = new ArrayList<>(keyStmt.argument().size());
  88             final Set<QName> possibleLeafQNamesForKey = new HashSet<>();
  89             for (final EffectiveStatement<?, ?> effectiveStatement : substatements) {
  90                 if (effectiveStatement instanceof LeafSchemaNode) {
  91                     possibleLeafQNamesForKey.add(((LeafSchemaNode) effectiveStatement).getQName());
  92                 }
  93             }
  94             for (final QName keyQName : keyStmt.argument()) {
  95                 if (!possibleLeafQNamesForKey.contains(keyQName)) {
  96                     throw new InferenceException(ctx.getStatementSourceReference(),
  97                         "Key '%s' misses node '%s' in list '%s'", keyStmt.getDeclared().rawArgument(),
  98                         keyQName.getLocalName(), ctx.getStatementArgument());
  99                 }
 100                 keyDefinitionInit.add(keyQName);
 101             }
 102
 103             keyDefinition = ImmutableList.copyOf(keyDefinitionInit);
 104         } else {
 105             keyDefinition = ImmutableList.of();
 106         }
 107
 108         final boolean configuration = ctx.isConfiguration();
 109         final int flags = new FlagsBuilder()
 110                 .setHistory(ctx.getCopyHistory())
 111                 .setStatus(findFirstArgument(substatements, StatusEffectiveStatement.class, Status.CURRENT))
 112                 .setConfiguration(configuration)
 113                 .setUserOrdered(findFirstArgument(substatements, OrderedByEffectiveStatement.class, Ordering.SYSTEM)
 114                     .equals(Ordering.USER))
 115                 .toFlags();
 116         if (configuration && keyDefinition.isEmpty() && isInstantied(ctx)) {
 117             warnConfigList(ctx);
 118         }
 119
 120         final Optional<ElementCountConstraint> elementCountConstraint =
 121                 EffectiveStmtUtils.createElementCountConstraint(substatements);
 122         return original == null && !elementCountConstraint.isPresent()
 123                 ? new EmptyListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition)
 124                         : new RegularListEffectiveStatement(declared, path, flags, ctx, substatements, keyDefinition,
 125                             elementCountConstraint.orElse(null), original);
 126     }
 127
 128     private static void warnConfigList(final @NonNull StmtContext<QName, ListStatement, ListEffectiveStatement> ctx) {
 129         final StmtContext<QName, ListStatement, ListEffectiveStatement> warnCtx = ctx.getOriginalCtx().orElse(ctx);
 130         final Boolean warned = warnCtx.getFromNamespace(ConfigListWarningNamespace.class, Boolean.TRUE);
 131         // Hacky check if we have issued a warning for the original statement
 132         if (warned == null) {
 133             verify(warnCtx instanceof Mutable, "Unexpected context %s", warnCtx);
 134             ((Mutable<?, ?, ?>) warnCtx).addToNs(ConfigListWarningNamespace.class, Boolean.TRUE, Boolean.TRUE);
 135             LOG.info("Configuration list {} does not define any keys in violation of RFC7950 section 7.8.2. While "
 136                     + "this is fine with OpenDaylight, it can cause interoperability issues with other systems "
 137                     + "[defined at {}]", ctx.getStatementArgument(), warnCtx.getStatementSourceReference());
 138         }
 139     }
 140
 141     private static boolean isInstantied(final StmtContext<?, ?, ?> ctx) {
 142         for (StmtContext<?, ?, ?> parent = ctx.getParentContext(); parent != null; parent = parent.getParentContext()) {
 143             if (UNINSTANTIATED_DATATREE_STATEMENTS.contains(parent.getPublicDefinition())) {
 144                 return false;
 145             }
 146         }
 147         return true;
 148     }
 149
 150     @Override
 151     protected final ListEffectiveStatement createEmptyEffective(
 152             final StmtContext<QName, ListStatement, ListEffectiveStatement> ctx, final ListStatement declared) {
 153         return createEffective(ctx, declared, ImmutableList.of());
 154     }
 155 }