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