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