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