yang/yang-parser-impl/src/main/java/org/opendaylight/yangtools/yang/parser/stmt/rfc6020/UsesStatementImpl.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. 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.stmt.rfc6020;
   9
  10 import com.google.common.collect.ImmutableSet;
  11 import java.util.ArrayList;
  12 import java.util.Collection;
  13 import java.util.Set;
  14 import javax.annotation.Nonnull;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.common.QNameModule;
  17 import org.opendaylight.yangtools.yang.common.YangVersion;
  18 import org.opendaylight.yangtools.yang.model.api.YangStmtMapping;
  19 import org.opendaylight.yangtools.yang.model.api.meta.EffectiveStatement;
  20 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  21 import org.opendaylight.yangtools.yang.model.api.stmt.AugmentStatement;
  22 import org.opendaylight.yangtools.yang.model.api.stmt.DescriptionStatement;
  23 import org.opendaylight.yangtools.yang.model.api.stmt.IfFeatureStatement;
  24 import org.opendaylight.yangtools.yang.model.api.stmt.ReferenceStatement;
  25 import org.opendaylight.yangtools.yang.model.api.stmt.RefineStatement;
  26 import org.opendaylight.yangtools.yang.model.api.stmt.SchemaNodeIdentifier;
  27 import org.opendaylight.yangtools.yang.model.api.stmt.StatusStatement;
  28 import org.opendaylight.yangtools.yang.model.api.stmt.UsesStatement;
  29 import org.opendaylight.yangtools.yang.model.api.stmt.WhenStatement;
  30 import org.opendaylight.yangtools.yang.parser.spi.GroupingNamespace;
  31 import org.opendaylight.yangtools.yang.parser.spi.SubstatementValidator;
  32 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractDeclaredStatement;
  33 import org.opendaylight.yangtools.yang.parser.spi.meta.AbstractStatementSupport;
  34 import org.opendaylight.yangtools.yang.parser.spi.meta.CopyType;
  35 import org.opendaylight.yangtools.yang.parser.spi.meta.InferenceException;
  36 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder;
  37 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.InferenceAction;
  38 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelActionBuilder.Prerequisite;
  39 import org.opendaylight.yangtools.yang.parser.spi.meta.ModelProcessingPhase;
  40 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext;
  41 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContext.Mutable;
  42 import org.opendaylight.yangtools.yang.parser.spi.meta.StmtContextUtils;
  43 import org.opendaylight.yangtools.yang.parser.spi.source.ModuleCtxToModuleQName;
  44 import org.opendaylight.yangtools.yang.parser.spi.source.SourceException;
  45 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace;
  46 import org.opendaylight.yangtools.yang.parser.spi.validation.ValidationBundlesNamespace.ValidationBundleType;
  47 import org.opendaylight.yangtools.yang.parser.stmt.reactor.StatementContextBase;
  48 import org.opendaylight.yangtools.yang.parser.stmt.rfc6020.effective.UsesEffectiveStatementImpl;
  49 import org.slf4j.Logger;
  50 import org.slf4j.LoggerFactory;
  51
  52
  53 public class UsesStatementImpl extends AbstractDeclaredStatement<QName> implements UsesStatement {
  54     private static final SubstatementValidator SUBSTATEMENT_VALIDATOR = SubstatementValidator.builder(YangStmtMapping
  55             .USES)
  56             .addAny(YangStmtMapping.AUGMENT)
  57             .addOptional(YangStmtMapping.DESCRIPTION)
  58             .addAny(YangStmtMapping.IF_FEATURE)
  59             .addAny(YangStmtMapping.REFINE)
  60             .addOptional(YangStmtMapping.REFERENCE)
  61             .addOptional(YangStmtMapping.STATUS)
  62             .addOptional(YangStmtMapping.WHEN)
  63             .build();
  64
  65     private static final Logger LOG = LoggerFactory.getLogger(UsesStatementImpl.class);
  66
  67     protected UsesStatementImpl(final StmtContext<QName, UsesStatement, ?> context) {
  68         super(context);
  69     }
  70
  71     public static class Definition extends
  72             AbstractStatementSupport<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> {
  73
  74         public Definition() {
  75             super(YangStmtMapping.USES);
  76         }
  77
  78         @Override
  79         public QName parseArgumentValue(final StmtContext<?, ?, ?> ctx, final String value) {
  80             return Utils.qNameFromArgument(ctx, value);
  81         }
  82
  83         @Override
  84         public void onFullDefinitionDeclared(
  85                 final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
  86             if (!StmtContextUtils.areFeaturesSupported(usesNode)) {
  87                 return;
  88             }
  89             super.onFullDefinitionDeclared(usesNode);
  90
  91             if (StmtContextUtils.isInExtensionBody(usesNode)) {
  92                 return;
  93             }
  94
  95             final ModelActionBuilder usesAction = usesNode.newInferenceAction(ModelProcessingPhase.EFFECTIVE_MODEL);
  96             final QName groupingName = usesNode.getStatementArgument();
  97
  98             final Prerequisite<StmtContext<?, ?, ?>> sourceGroupingPre = usesAction.requiresCtx(usesNode,
  99                     GroupingNamespace.class, groupingName, ModelProcessingPhase.EFFECTIVE_MODEL);
 100             final Prerequisite<? extends StmtContext.Mutable<?, ?, ?>> targetNodePre = usesAction.mutatesEffectiveCtx(
 101                     usesNode.getParentContext());
 102
 103             usesAction.apply(new InferenceAction() {
 104
 105                 @Override
 106                 public void apply() {
 107                     final StatementContextBase<?, ?, ?> targetNodeStmtCtx = (StatementContextBase<?, ?, ?>) targetNodePre.get();
 108                     final StatementContextBase<?, ?, ?> sourceGrpStmtCtx = (StatementContextBase<?, ?, ?>) sourceGroupingPre.get();
 109
 110                     try {
 111                         copyFromSourceToTarget(sourceGrpStmtCtx, targetNodeStmtCtx, usesNode);
 112                         resolveUsesNode(usesNode, targetNodeStmtCtx);
 113                         StmtContextUtils.validateIfFeatureAndWhenOnListKeys(usesNode);
 114                     } catch (final SourceException e) {
 115                         LOG.warn(e.getMessage(), e);
 116                         throw e;
 117                     }
 118                 }
 119
 120                 @Override
 121                 public void prerequisiteFailed(final Collection<? extends Prerequisite<?>> failed) {
 122                     InferenceException.throwIf(failed.contains(sourceGroupingPre),
 123                             usesNode.getStatementSourceReference(), "Grouping '%s' was not resolved.", groupingName);
 124                     throw new InferenceException("Unknown error occurred.", usesNode.getStatementSourceReference());
 125                 }
 126             });
 127         }
 128
 129         @Override
 130         public UsesStatement createDeclared(final StmtContext<QName, UsesStatement, ?> ctx) {
 131             return new UsesStatementImpl(ctx);
 132         }
 133
 134         @Override
 135         public EffectiveStatement<QName, UsesStatement> createEffective(
 136                 final StmtContext<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> ctx) {
 137             return new UsesEffectiveStatementImpl(ctx);
 138         }
 139
 140         @Override
 141         protected SubstatementValidator getSubstatementValidator() {
 142             return SUBSTATEMENT_VALIDATOR;
 143         }
 144
 145     }
 146
 147     @Nonnull
 148     @Override
 149     public QName getName() {
 150         return argument();
 151     }
 152
 153     @Override
 154     public WhenStatement getWhenStatement() {
 155         return firstDeclared(WhenStatement.class);
 156     }
 157
 158     @Nonnull
 159     @Override
 160     public Collection<? extends IfFeatureStatement> getIfFeatures() {
 161         return allDeclared(IfFeatureStatement.class);
 162     }
 163
 164     @Override
 165     public StatusStatement getStatus() {
 166         return firstDeclared(StatusStatement.class);
 167     }
 168
 169     @Override
 170     public DescriptionStatement getDescription() {
 171         return firstDeclared(DescriptionStatement.class);
 172     }
 173
 174     @Override
 175     public ReferenceStatement getReference() {
 176         return firstDeclared(ReferenceStatement.class);
 177     }
 178
 179     @Nonnull
 180     @Override
 181     public Collection<? extends AugmentStatement> getAugments() {
 182         return allDeclared(AugmentStatement.class);
 183     }
 184
 185     @Nonnull
 186     @Override
 187     public Collection<? extends RefineStatement> getRefines() {
 188         return allDeclared(RefineStatement.class);
 189     }
 190
 191     /**
 192      * @param sourceGrpStmtCtx
 193      *            source grouping statement context
 194      * @param targetCtx
 195      *            target context
 196      * @param usesNode
 197      *            uses node
 198      * @throws SourceException
 199      *             instance of SourceException
 200      */
 201     private static void copyFromSourceToTarget(final StatementContextBase<?, ?, ?> sourceGrpStmtCtx,
 202             final StatementContextBase<?, ?, ?> targetCtx,
 203             final StmtContext.Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode) {
 204         final Collection<StatementContextBase<?, ?, ?>> declared = sourceGrpStmtCtx.declaredSubstatements();
 205         final Collection<StatementContextBase<?, ?, ?>> effective = sourceGrpStmtCtx.effectiveSubstatements();
 206         final Collection<StatementContextBase<?, ?, ?>> buffer = new ArrayList<>(declared.size() + effective.size());
 207         final QNameModule newQNameModule = getNewQNameModule(targetCtx, sourceGrpStmtCtx);
 208
 209         for (final StatementContextBase<?, ?, ?> original : declared) {
 210             if (StmtContextUtils.areFeaturesSupported(original)) {
 211                 copyStatement(original, targetCtx, newQNameModule, buffer);
 212             }
 213         }
 214
 215         for (final StatementContextBase<?, ?, ?> original : effective) {
 216             copyStatement(original, targetCtx, newQNameModule, buffer);
 217         }
 218
 219         targetCtx.addEffectiveSubstatements(buffer);
 220         usesNode.addAsEffectOfStatement(buffer);
 221     }
 222
 223     private static void copyStatement(final StatementContextBase<?, ?, ?> original,
 224             final StatementContextBase<?, ?, ?> targetCtx, final QNameModule targetModule,
 225             final Collection<StatementContextBase<?, ?, ?>> buffer) {
 226         if (needToCopyByUses(original)) {
 227             final StatementContextBase<?, ?, ?> copy = original.createCopy(targetModule, targetCtx,
 228                     CopyType.ADDED_BY_USES);
 229             buffer.add(copy);
 230         } else if (isReusedByUsesOnTop(original)) {
 231             buffer.add(original);
 232         }
 233     }
 234
 235     private static final Set<YangStmtMapping> TOP_REUSED_DEF_SET = ImmutableSet.of(
 236         YangStmtMapping.TYPE,
 237         YangStmtMapping.TYPEDEF);
 238
 239     private static boolean isReusedByUsesOnTop(final StmtContext<?, ?, ?> stmtContext) {
 240         return TOP_REUSED_DEF_SET.contains(stmtContext.getPublicDefinition());
 241     }
 242
 243     private static final Set<YangStmtMapping> NOCOPY_FROM_GROUPING_SET = ImmutableSet.of(
 244         YangStmtMapping.DESCRIPTION,
 245         YangStmtMapping.REFERENCE,
 246         YangStmtMapping.STATUS);
 247     private static final Set<YangStmtMapping> REUSED_DEF_SET = ImmutableSet.of(
 248         YangStmtMapping.TYPE,
 249         YangStmtMapping.TYPEDEF,
 250         YangStmtMapping.USES);
 251
 252     public static boolean needToCopyByUses(final StmtContext<?, ?, ?> stmtContext) {
 253         final StatementDefinition def = stmtContext.getPublicDefinition();
 254         if (REUSED_DEF_SET.contains(def)) {
 255             LOG.debug("Will reuse {} statement {}", def, stmtContext);
 256             return false;
 257         }
 258         if (NOCOPY_FROM_GROUPING_SET.contains(def)) {
 259             return !YangStmtMapping.GROUPING.equals(stmtContext.getParentContext().getPublicDefinition());
 260         }
 261
 262         LOG.debug("Will copy {} statement {}", def, stmtContext);
 263         return true;
 264     }
 265
 266     public static void resolveUsesNode(
 267             final Mutable<QName, UsesStatement, EffectiveStatement<QName, UsesStatement>> usesNode,
 268             final StatementContextBase<?, ?, ?> targetNodeStmtCtx) {
 269         for (final StatementContextBase<?, ?, ?> subStmtCtx : usesNode.declaredSubstatements()) {
 270             if (StmtContextUtils.producesDeclared(subStmtCtx, RefineStatement.class)
 271                     && areFeaturesSupported(subStmtCtx)) {
 272                 performRefine(subStmtCtx, targetNodeStmtCtx);
 273             }
 274         }
 275     }
 276
 277     private static boolean areFeaturesSupported(final StatementContextBase<?, ?, ?> subStmtCtx) {
 278         /*
 279          * In case of Yang 1.1, checks whether features are supported.
 280          */
 281         return !YangVersion.VERSION_1_1.equals(subStmtCtx.getRootVersion()) || StmtContextUtils
 282                 .areFeaturesSupported(subStmtCtx);
 283     }
 284
 285     private static void performRefine(final StatementContextBase<?, ?, ?> refineCtx,
 286             final StatementContextBase<?, ?, ?> usesParentCtx) {
 287
 288         final Object refineArgument = refineCtx.getStatementArgument();
 289         InferenceException.throwIf(!(refineArgument instanceof SchemaNodeIdentifier),
 290             refineCtx.getStatementSourceReference(),
 291             "Invalid refine argument %s. It must be instance of SchemaNodeIdentifier.", refineArgument);
 292
 293         final SchemaNodeIdentifier refineTargetNodeIdentifier = (SchemaNodeIdentifier) refineArgument;
 294         final StatementContextBase<?, ?, ?> refineTargetNodeCtx = Utils.findNode(usesParentCtx,
 295                 refineTargetNodeIdentifier);
 296
 297         InferenceException.throwIfNull(refineTargetNodeCtx, refineCtx.getStatementSourceReference(),
 298             "Refine target node %s not found.", refineTargetNodeIdentifier);
 299
 300         if (StmtContextUtils.isUnknownStatement(refineTargetNodeCtx)) {
 301             LOG.debug(
 302                     "Refine node '{}' in uses '{}' has target node unknown statement '{}'. Refine has been skipped. At line: {}",
 303                     refineCtx.getStatementArgument(), refineCtx.getParentContext().getStatementArgument(),
 304                     refineTargetNodeCtx.getStatementArgument(), refineCtx.getStatementSourceReference());
 305             refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 306             return;
 307         }
 308
 309         addOrReplaceNodes(refineCtx, refineTargetNodeCtx);
 310         refineCtx.addAsEffectOfStatement(refineTargetNodeCtx);
 311     }
 312
 313     private static void addOrReplaceNodes(final StatementContextBase<?, ?, ?> refineCtx,
 314             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 315         for (final StatementContextBase<?, ?, ?> refineSubstatementCtx : refineCtx.declaredSubstatements()) {
 316             if (isSupportedRefineSubstatement(refineSubstatementCtx)) {
 317                 addOrReplaceNode(refineSubstatementCtx, refineTargetNodeCtx);
 318             }
 319         }
 320     }
 321
 322     private static void addOrReplaceNode(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
 323             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 324
 325         final StatementDefinition refineSubstatementDef = refineSubstatementCtx.getPublicDefinition();
 326
 327         SourceException.throwIf(!isSupportedRefineTarget(refineSubstatementCtx, refineTargetNodeCtx),
 328                 refineSubstatementCtx.getStatementSourceReference(),
 329                 "Error in module '%s' in the refine of uses '%s': can not perform refine of '%s' for the target '%s'.",
 330                 refineSubstatementCtx.getRoot().getStatementArgument(), refineSubstatementCtx.getParentContext()
 331                         .getStatementArgument(), refineSubstatementCtx.getPublicDefinition(), refineTargetNodeCtx
 332                         .getPublicDefinition());
 333
 334         if (isAllowedToAddByRefine(refineSubstatementDef)) {
 335             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 336         } else {
 337             refineTargetNodeCtx.removeStatementFromEffectiveSubstatements(refineSubstatementDef);
 338             refineTargetNodeCtx.addEffectiveSubstatement(refineSubstatementCtx);
 339         }
 340     }
 341
 342     private static final Set<YangStmtMapping> ALLOWED_TO_ADD_BY_REFINE_DEF_SET = ImmutableSet.of(YangStmtMapping.MUST);
 343
 344     private static boolean isAllowedToAddByRefine(final StatementDefinition publicDefinition) {
 345         return ALLOWED_TO_ADD_BY_REFINE_DEF_SET.contains(publicDefinition);
 346     }
 347
 348     private static boolean isSupportedRefineSubstatement(final StatementContextBase<?, ?, ?> refineSubstatementCtx) {
 349         final Collection<?> supportedRefineSubstatements = refineSubstatementCtx.getFromNamespace(
 350                 ValidationBundlesNamespace.class, ValidationBundleType.SUPPORTED_REFINE_SUBSTATEMENTS);
 351
 352         return supportedRefineSubstatements == null || supportedRefineSubstatements.isEmpty()
 353                 || supportedRefineSubstatements.contains(refineSubstatementCtx.getPublicDefinition())
 354                 || StmtContextUtils.isUnknownStatement(refineSubstatementCtx);
 355     }
 356
 357     private static boolean isSupportedRefineTarget(final StatementContextBase<?, ?, ?> refineSubstatementCtx,
 358             final StatementContextBase<?, ?, ?> refineTargetNodeCtx) {
 359
 360         final Collection<?> supportedRefineTargets = YangValidationBundles.SUPPORTED_REFINE_TARGETS
 361                 .get(refineSubstatementCtx.getPublicDefinition());
 362
 363         return supportedRefineTargets == null || supportedRefineTargets.isEmpty()
 364                 || supportedRefineTargets.contains(refineTargetNodeCtx.getPublicDefinition());
 365     }
 366
 367
 368     private static QNameModule getNewQNameModule(final StatementContextBase<?, ?, ?> targetCtx,
 369             final StmtContext<?, ?, ?> stmtContext) {
 370         if (targetCtx.isRootContext()) {
 371             return targetCtx.getFromNamespace(ModuleCtxToModuleQName.class, targetCtx);
 372         }
 373         if (targetCtx.getPublicDefinition() == YangStmtMapping.AUGMENT) {
 374             return Utils.getRootModuleQName(targetCtx);
 375         }
 376
 377         final Object targetStmtArgument = targetCtx.getStatementArgument();
 378         final Object sourceStmtArgument = stmtContext.getStatementArgument();
 379         if (targetStmtArgument instanceof QName && sourceStmtArgument instanceof QName) {
 380             return ((QName) targetStmtArgument).getModule();
 381         }
 382
 383         return null;
 384     }
 385
 386 }