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