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