View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.rendering.template.registry;
35  
36  import info.magnolia.config.registry.AbstractRegistry;
37  import info.magnolia.config.registry.DefinitionMetadataBuilder;
38  import info.magnolia.config.registry.DefinitionProvider;
39  import info.magnolia.config.registry.DefinitionProviderBuilder;
40  import info.magnolia.config.registry.DefinitionProviderWrapper;
41  import info.magnolia.config.registry.DefinitionRawView;
42  import info.magnolia.config.registry.DefinitionType;
43  import info.magnolia.module.ModuleRegistry;
44  import info.magnolia.objectfactory.Components;
45  import info.magnolia.registry.RegistrationException;
46  import info.magnolia.rendering.DefinitionTypes;
47  import info.magnolia.rendering.template.TemplateDefinition;
48  import info.magnolia.rendering.template.registry.validator.TemplateDefinitionValidator;
49  
50  import java.util.Collection;
51  
52  import javax.inject.Inject;
53  import javax.inject.Singleton;
54  
55  
56  /**
57   * The central registry of all {@link TemplateDefinition}s.
58   */
59  @Singleton
60  public class TemplateDefinitionRegistry extends AbstractRegistry<TemplateDefinition> {
61  
62      @Inject
63      public TemplateDefinitionRegistry(final ModuleRegistry moduleRegistry, TemplateDefinitionValidator templateDefinitionValidator) {
64          super(moduleRegistry);
65          addValidator(templateDefinitionValidator);
66      }
67  
68      /**
69       * @deprecated since 5.6.2. Use {@link #TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry, info.magnolia.rendering.template.registry.validator.TemplateDefinitionValidator)} instead.
70       */
71      @Deprecated
72      public TemplateDefinitionRegistry(final ModuleRegistry moduleRegistry) {
73          this(moduleRegistry, Components.getComponent(TemplateDefinitionValidator.class));
74      }
75  
76      /**
77       * @deprecated since 5.4.6 - use {@link TemplateDefinitionRegistry#TemplateDefinitionRegistry(info.magnolia.module.ModuleRegistry)} instead.
78       */
79      @Deprecated
80      public TemplateDefinitionRegistry() {
81          this(Components.getComponent(ModuleRegistry.class));
82      }
83  
84      @Override
85      public DefinitionType type() {
86          return DefinitionTypes.TEMPLATE;
87      }
88  
89      @Override
90      public DefinitionMetadataBuilder newMetadataBuilder() {
91          return DefinitionMetadataBuilder.usingModuleAndRelativePathAsId();
92      }
93  
94      /**
95       * This method is kept for compatibility reasons. It adapts the given provider to the new DefinitionProvider introduced in 5.4.
96       *
97       * @deprecated since 5.4
98       */
99      @Deprecated
100     public void register(TemplateDefinitionProvider provider) {
101         try {
102             // TODO The following lines are duplicated code from DialogDefinitionRegistry#register(). Additionally explicit parsing
103             // TODO of the provider Id is error prone and should be in some kind of metadata parser (in some way the counterpart to the metadata builder)
104             // TODO If this code gets somehow revived or refactored before its final removal please consider this duplication as well.
105             final String[] idParts = provider.getId().split(":", 2); // At least in the case of blossom, the id is already set
106             final String module = idParts[0];
107 
108             final TemplateDefinition td = provider.getTemplateDefinition();
109             final String relativeLocation = idParts[1];
110             final DefinitionProvider<TemplateDefinition> dp = DefinitionProviderBuilder.<TemplateDefinition>newBuilder()
111                     .metadata(newMetadataBuilder().type(type()).name(td.getName()).module(module).relativeLocation(relativeLocation))
112                     .rawView(DefinitionRawView.EMPTY) // We have no raw view for this, but the whole provider should still be considered valid.
113                     .definition(td)
114                     .build();
115             register(dp);
116         } catch (RegistrationException e) {
117             throw new RuntimeException(e);
118         }
119     }
120 
121     /**
122      * @deprecated since 5.4 use {@link #getProvider(String)}
123      */
124     @Deprecated
125     public TemplateDefinition getTemplateDefinition(String id) throws RegistrationException {
126         try {
127             final DefinitionProvider<TemplateDefinition> templateDefinitionProvider = getProvider(id);
128             return templateDefinitionProvider.get();
129         } catch (IllegalArgumentException | NoSuchDefinitionException | InvalidDefinitionException e) {
130             throw new RegistrationException(e.getMessage(), e);
131         }
132     }
133 
134     @Override
135     protected DefinitionProvider<TemplateDefinition> onRegister(final DefinitionProvider<TemplateDefinition> provider) {
136         // This was in ConfiguredTemplateDefinitionProvider: templateDefinition.setId(id);
137 
138         // TODO -- we should maybe just remove RenderableDefinition.setId() and implement getMetadata() to delegate to provider instead
139         final DefinitionProvider<TemplateDefinition> wrappedProvider = super.onRegister(provider);
140         return new DefinitionProviderWrapper<TemplateDefinition>(wrappedProvider) {
141             @Override
142             public TemplateDefinition get() {
143                 final TemplateDefinition td = super.get();
144                 final String referenceString = wrappedProvider.getMetadata().getReferenceId();
145                 td.setId(referenceString);
146                 return td;
147             }
148         };
149     }
150 
151     /**
152      * Returns all TemplateDefinitions - in case of errors it'll just deliver the ones that are properly registered and logs error's for the others.
153      *
154      * @deprecated since 5.4 use {@link #getAllDefinitions()}
155      */
156     @Deprecated
157     public Collection<TemplateDefinition> getTemplateDefinitions() {
158         return getAllDefinitions();
159     }
160 
161 }