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