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