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