View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.ui.dialog.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.ui.dialog.definition.ConfiguredDialogDefinition;
47  import info.magnolia.ui.dialog.definition.DialogDefinition;
48  import info.magnolia.ui.dialog.definition.FormDialogDefinition;
49  import info.magnolia.ui.dialog.formdialog.FormDialogPresenter;
50  import info.magnolia.ui.dialog.registry.validator.DialogDefinitionValidator;
51  import info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry;
52  
53  import javax.inject.Inject;
54  import javax.inject.Singleton;
55  
56  /**
57   * Maintains a registry of dialog providers registered by id.
58   */
59  @Singleton
60  public class DialogDefinitionRegistry extends AbstractRegistry<DialogDefinition> {
61  
62      @Inject
63      public DialogDefinitionRegistry(ModuleRegistry moduleRegistry, FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry) {
64          super(moduleRegistry);
65          addValidator(new DialogDefinitionValidator(fieldTypeDefinitionRegistry));
66      }
67  
68      /**
69       * @deprecated since 5.6.3 - use {@link #DialogDefinitionRegistry(ModuleRegistry, FieldTypeDefinitionRegistry)} instead.
70       */
71      @Deprecated
72      public DialogDefinitionRegistry(ModuleRegistry moduleRegistry) {
73          this(moduleRegistry, Components.getComponent(FieldTypeDefinitionRegistry.class));
74      }
75  
76      /**
77       * @deprecated since 5.4.6 - use {@link #DialogDefinitionRegistry(ModuleRegistry, FieldTypeDefinitionRegistry)} instead.
78       */
79      @Deprecated
80      public DialogDefinitionRegistry() {
81          this(Components.getComponent(ModuleRegistry.class), Components.getComponent(FieldTypeDefinitionRegistry.class));
82      }
83  
84      @Override
85      public DefinitionType type() {
86          return DefinitionTypes.DIALOG;
87      }
88  
89      @Override
90      public DefinitionMetadataBuilder newMetadataBuilder() {
91          return DefinitionMetadataBuilder.usingModuleAndRelativePathAsId();
92      }
93  
94      @Override
95      protected DefinitionProvider<DialogDefinition> onRegister(DefinitionProvider<DialogDefinition> provider) {
96          return new DefinitionProviderWrapper<DialogDefinition>(provider) {
97              @Override
98              public DialogDefinition get() {
99                  DialogDefinition dd = super.get();
100                 if (dd instanceof ConfiguredDialogDefinition && dd.getId() == null) {
101                     String referenceId = getDelegate().getMetadata().getReferenceId();
102                     ((ConfiguredDialogDefinition) dd).setId(referenceId);
103                 }
104                 return dd;
105             }
106         };
107     }
108 
109     /**
110      * This method is kept for compatibility reasons. It adapts the given provider to the new DefinitionProvider introduced in 5.4.
111      *
112      * @deprecated since 5.4
113      */
114     @Deprecated
115     public void register(DialogDefinitionProvider provider) {
116         try {
117             // TODO The following lines are duplicated code from TemplateDefinitionRegistry#register(). Additionally explicit parsing
118             // 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)
119             // TODO If this code gets somehow revived or refactored before its final removal please consider this duplication as well.
120             final String[] idParts = provider.getId().split(":", 2); // At least in the case of blossom, the id is already set
121             final String module = idParts[0];
122 
123             final DialogDefinition td = provider.getDialogDefinition();
124             final String relativeLocation = idParts[1];
125             final DefinitionProvider<DialogDefinition> dp = DefinitionProviderBuilder.<DialogDefinition> newBuilder()
126                     .metadata(newMetadataBuilder().type(type()).module(module).relativeLocation(relativeLocation))
127                     .rawView(DefinitionRawView.EMPTY) // We have no raw view for this, but the whole provider should still be considered valid.
128                     .definition(td)
129                     .build();
130             register(dp);
131         } catch (RegistrationException e) {
132             throw new RuntimeException(e);
133         }
134     }
135 
136     /**
137      * @deprecated since 5.4 use {@link #getProvider(String)}
138      */
139     @Deprecated
140     public FormDialogDefinition getDialogDefinition(String id) throws RegistrationException {
141         try {
142             DefinitionProvider<DialogDefinition> dialogDefinitionProvider = getProvider(id);
143             DialogDefinition dialogDefinition = dialogDefinitionProvider.get();
144             return (FormDialogDefinition) dialogDefinition;
145         } catch (NoSuchDefinitionException | InvalidDefinitionException e) {
146             throw new RegistrationException(e.getMessage(), e);
147         }
148     }
149 
150     /**
151      * @deprecated since 5.4, get the {@link info.magnolia.ui.dialog.definition.DialogDefinition} first, and get the presenter class from it.
152      */
153     @Deprecated
154     public Class<? extends FormDialogPresenter> getPresenterClass(String id) throws RegistrationException {
155         return (Class<? extends FormDialogPresenter>) getProvider(id).get().getPresenterClass();
156     }
157 
158 }