View Javadoc
1   /**
2    * This file Copyright (c) 2016-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.decoration;
35  
36  import info.magnolia.config.registry.DefaultDefinitionReference;
37  import info.magnolia.config.registry.Registry;
38  import info.magnolia.init.MagnoliaConfigurationProperties;
39  import info.magnolia.map2bean.Map2BeanTransformer;
40  import info.magnolia.objectfactory.Components;
41  import info.magnolia.resourceloader.Resource;
42  
43  import java.util.Optional;
44  import java.util.regex.Matcher;
45  import java.util.regex.Pattern;
46  
47  import javax.inject.Inject;
48  
49  import org.apache.commons.lang3.StringUtils;
50  
51  /**
52   * Checks if a {@link Resource resource} path matches a certain pattern ({@value #DECORATOR_FILE_PATH_CONVENTION}) which includes a specific reference id of
53   * a single {@link info.magnolia.config.registry.DefinitionProvider target definition provider}.
54   * <p>
55   * In case of a match - produces an instance of {@link YamlDefinitionDecorator}.
56   * </p>
57   *
58   * @see YamlDefinitionDecorator
59   */
60  public class FilePathBasedYamlDefinitionDecoratorResolver implements FileDefinitionDecoratorResolver {
61  
62      private static final String DECORATOR_FILE_PATH_CONVENTION = "^/(?<module>[a-zA-Z0-9-_]+)/decorations/(?<targetmodule>[a-zA-Z0-9-_]+)/(?<deftype>%s)/(?<relpath>.*/)?(?<refname>.+?)(\\.(?<decoratedpath>[a-zA-Z0-9-_\\.]*))*\\.yaml$";
63  
64      private final Map2BeanTransformer map2BeanTransformer;
65  
66      private final Pattern decoratorFilePathPattern;
67  
68      private final MagnoliaConfigurationProperties magnoliaConfigurationProperties;
69  
70      private final Registry registry;
71  
72      /**
73       * @deprecated since 5.5 - use {@link #FilePathBasedYamlDefinitionDecoratorResolver(Map2BeanTransformer, Registry, MagnoliaConfigurationProperties)} instead.
74       */
75      @Deprecated
76      public FilePathBasedYamlDefinitionDecoratorResolver(info.magnolia.config.map2bean.Map2BeanTransformer map2BeanTransformer, Registry registry) {
77          this(map2BeanTransformer, registry, Components.getComponent(MagnoliaConfigurationProperties.class));
78      }
79  
80      @Inject
81      public FilePathBasedYamlDefinitionDecoratorResolver(Map2BeanTransformer map2BeanTransformer, Registry registry, MagnoliaConfigurationProperties magnoliaConfigurationProperties) {
82          this(map2BeanTransformer, registry, magnoliaConfigurationProperties, Pattern.compile(String.format(DECORATOR_FILE_PATH_CONVENTION, registry.type().getPluralName())));
83      }
84  
85      public FilePathBasedYamlDefinitionDecoratorResolver(Map2BeanTransformer map2BeanTransformer, Registry registry, MagnoliaConfigurationProperties magnoliaConfigurationProperties, Pattern decoratorFilePathPattern) {
86          this.map2BeanTransformer = map2BeanTransformer;
87          this.registry = registry;
88          this.decoratorFilePathPattern = decoratorFilePathPattern;
89          this.magnoliaConfigurationProperties = magnoliaConfigurationProperties;
90      }
91  
92      @Override
93      public <T> Optional<FileDefinitionDecorator<T>> resolve(Resource resource) {
94          final Matcher matcher = decoratorFilePathPattern.matcher(resource.getPath());
95          if (matcher.matches()) {
96  
97              final String name = matcher.group("refname");
98              final String relativeLocation = StringUtils.isBlank(matcher.group("relpath")) ? name : matcher.group("relpath") + name;
99              final String targetModule = matcher.group("targetmodule");
100             final String hostModule = matcher.group("module");
101             final String decoratedPath = String.format("/%s", StringUtils.defaultIfBlank(matcher.group("decoratedpath"), "")).replaceAll("\\.", "/");
102 
103             //noinspection unchecked
104             return Optional.of(
105                     new YamlDefinitionDecorator<>(
106                             new YamlDefinitionDecoratorMetadata.Impl(
107                                     hostModule,
108                                     decoratedPath,
109                                     new DefaultDefinitionReference(targetModule, relativeLocation, name)),
110                             registry,
111                             resource,
112                             map2BeanTransformer,
113                             magnoliaConfigurationProperties
114                     ));
115         }
116 
117         return Optional.empty();
118     }
119 }