1 /**
2 * This file Copyright (c) 2017-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.config.source.yaml.construct;
35
36 import static info.magnolia.config.registry.DefinitionProvider.Problem.DefaultTypes.RESOLUTION;
37
38 import info.magnolia.config.registry.DefinitionProvider.Problem;
39 import info.magnolia.config.source.yaml.YamlReader;
40 import info.magnolia.config.source.yaml.dependency.YamlFileDependency;
41 import info.magnolia.resourceloader.ResourceOrigin;
42
43 import java.util.function.Consumer;
44
45 import org.yaml.snakeyaml.nodes.Node;
46 import org.yaml.snakeyaml.nodes.ScalarNode;
47
48 /**
49 * YAML file inclusion construct, bound to {@value TAG} YAML tag. Expects the provided YAML node to be of
50 * scalar type (i.e. a simple node), whose value represents the path to the included file.
51 * Resolves the contents of the referenced file and returns those as a parsed value corresponding to the node.
52 *
53 * @deprecated since 5.6.2, Please use {@link info.magnolia.config.source.yaml.construct.IncludeFileYamlWithModificationPossibility} instead.
54 */
55 @Deprecated
56 public final class IncludeYamlFile extends MgnlYamlConstruct {
57
58 public static final String TAG = "!include";
59
60 private final YamlReader yamlReader;
61 private final ResourceOrigin<?> resourceOrigin;
62
63 public IncludeYamlFile(YamlReader yamlReader, ResourceOrigin<?> resourceOrigin, Consumer<Problem> problemCollector) {
64 super(problemCollector);
65 this.yamlReader = yamlReader;
66 this.resourceOrigin = resourceOrigin;
67 }
68
69 @Override
70 public Object construct(Node node) {
71 if (!(node instanceof ScalarNode)) {
72 throw new IllegalArgumentException(String.format("Non-scalar %s: %s", TAG, node.toString()));
73 }
74
75 final ScalarNode scalarNode = (ScalarNode) node;
76 final String path = scalarNode.getValue();
77
78 reportProblem(
79 Problem.deprecated()
80 .withType(RESOLUTION)
81 .withTitle("Deprecated YAML construct usage")
82 .withDetails(String.format("Resource [%s] is included via deprecated syntax (!include <resource_path), use !include:<resource_path> syntax instead", path))
83 .build());
84
85
86 final YamlFileDependency dependency = new YamlFileDependency(resourceOrigin, path, yamlReader, getConstructor().getDependencyAggregator(), this::reportProblem);
87 getConstructor().getDependencyAggregator().addDependency(dependency);
88
89 return dependency.readData();
90 }
91 }