View Javadoc
1   /**
2    * This file Copyright (c) 2014-2016 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;
35  
36  import info.magnolia.config.registry.Registry;
37  import info.magnolia.config.source.AbstractConfigurationSourceBuilder;
38  import info.magnolia.init.MagnoliaConfigurationProperties;
39  import info.magnolia.map2bean.Map2BeanTransformer;
40  import info.magnolia.objectfactory.Components;
41  import info.magnolia.resourceloader.ResourceOrigin;
42  
43  import java.util.regex.Pattern;
44  import java.util.regex.PatternSyntaxException;
45  
46  import org.slf4j.Logger;
47  import org.slf4j.LoggerFactory;
48  
49  /**
50   * Builder for {@link info.magnolia.config.source.yaml.YamlConfigurationSource} instances.
51   */
52  public class YamlConfigurationSourceBuilder extends AbstractConfigurationSourceBuilder {
53  
54      private static final Logger log = LoggerFactory.getLogger(YamlConfigurationSourceBuilder.class);
55  
56      /**
57       * Regex format for config files according to Magnolia module conventions.
58       * Mind the %s part of the regex, which should be replaced with the expected definition type.
59       * @see #moduleConventionsFormatFor(Registry)
60       */
61      private static final String MODULE_CONVENTIONS_FORMAT = "^/(?<module>[a-zA-Z0-9-_]+)/(?<deftype>%s)/(?<relPath>.*/)?(?<name>[a-zA-Z0-9-_\\.]+)\\.yaml$";
62  
63      private final ResourceOrigin origin;
64      private final YamlReader yamlReader;
65      private final MagnoliaConfigurationProperties magnoliaConfigurationProperties;
66      private final Map2BeanTransformer map2BeanTransformer;
67      private String pathPattern;
68  
69      /**
70       * @deprecated since 5.5 - use {@link #YamlConfigurationSourceBuilder(ResourceOrigin, Map2BeanTransformer, YamlReader, MagnoliaConfigurationProperties)} instead.
71       */
72      @Deprecated
73      public YamlConfigurationSourceBuilder(ResourceOrigin origin, info.magnolia.config.map2bean.Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader) {
74          this(origin, map2BeanTransformer, yamlReader, Components.getComponent(MagnoliaConfigurationProperties.class));
75      }
76  
77      public YamlConfigurationSourceBuilder(ResourceOrigin origin, Map2BeanTransformer map2BeanTransformer, YamlReader yamlReader, MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
78          this.origin = origin;
79          this.map2BeanTransformer = map2BeanTransformer;
80          this.yamlReader = yamlReader;
81          this.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
82      }
83  
84      public YamlConfigurationSourceBuilder withPattern(String pathPattern) {
85          this.pathPattern = pathPattern;
86          return this;
87      }
88  
89      @Override
90      public void bindTo(Registry<?> registry) {
91          final Pattern pathPattern = validatePathPattern(this.pathPattern);
92          if (registry == null) {
93              throw new NullPointerException("Must pass a registry instance");
94          }
95  
96          new YamlConfigurationSource<>(origin, map2BeanTransformer, registry, pathPattern, yamlReader, magnoliaConfigurationProperties).start();
97      }
98  
99      public void bindWithDefaults(Registry registry) {
100         if (pathPattern != null) {
101             throw new IllegalStateException(this + " is already partially configured, don't use bindWithDefaults().");
102         }
103         withPattern(moduleConventionsFormatFor(registry)).bindTo(registry);
104     }
105 
106     protected Pattern validatePathPattern(String regex) {
107         if (pathPattern == null) {
108             throw new IllegalStateException(this + " is incomplete.");
109         }
110         try {
111             // Ideally, we'd validate the pattern contains 1 group.
112             return Pattern.compile(regex);
113         } catch (PatternSyntaxException e) {
114             log.warn("Pattern {} is invalid: {}", regex, e.getMessage());
115             return Pattern.compile("$^");
116         }
117     }
118 
119     // TODO Move this (and the regex pattern) to a component that exposes this and more conventions-wrapping objects (e.g Predicate<Path>)
120     protected String moduleConventionsFormatFor(Registry registry) {
121         return String.format(MODULE_CONVENTIONS_FORMAT, registry.type().getPluralName());
122     }
123 
124 }