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