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