1 /**
2 * This file Copyright (c) 2021 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 info.magnolia.config.registry.DefinitionProvider;
37 import org.apache.commons.text.StringSubstitutor;
38 import org.apache.commons.text.lookup.StringLookupFactory;
39 import org.yaml.snakeyaml.nodes.Node;
40 import org.yaml.snakeyaml.nodes.ScalarNode;
41
42 import java.util.function.Consumer;
43
44 /**
45 * Adds support for environment variables in YAML files with the {@code !env} syntax.
46 *
47 * For instance: <b>baseUrl: !env https://${ENV}.api.com/endpoint</b>
48 *
49 * Is only turned applied when the {@code FEATURE_FLAG_PROPERTY} is set to true.
50 */
51 public class EnvSubst extends MgnlYamlConstruct {
52
53 public static final String FEATURE_FLAG_PROPERTY = "magnolia.yaml.envsubst";
54 public static final String TAG = "!env";
55
56 private final StringSubstitutor stringSubstitutor;
57 private final boolean featureFlagEnabled;
58
59 public EnvSubst(Consumer<DefinitionProvider.Problem> problemCollector, boolean featureFlagEnabled) {
60 super(problemCollector);
61 this.stringSubstitutor = new StringSubstitutor(StringLookupFactory.INSTANCE.environmentVariableStringLookup());
62 this.featureFlagEnabled = featureFlagEnabled;
63 }
64
65 @Override
66 public Object construct(Node node) {
67 final ScalarNode scalarNode = (ScalarNode) node;
68 final String variable = scalarNode.getValue();
69
70 if (featureFlagEnabled) {
71 return this.stringSubstitutor.replace(variable);
72 }
73
74 return variable;
75 }
76 }