View Javadoc
1   /**
2    * This file Copyright (c) 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.validator;
35  
36  import info.magnolia.config.registry.DefinitionProvider;
37  import info.magnolia.ui.dialog.definition.DialogDefinition;
38  import info.magnolia.ui.dialog.definition.FormDialogDefinition;
39  import info.magnolia.ui.form.definition.TabDefinition;
40  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
41  import info.magnolia.ui.form.field.definition.FieldDefinition;
42  import info.magnolia.ui.form.fieldtype.registry.AbstractFieldTypeDefinitionValidator;
43  import info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry;
44  import info.magnolia.util.OptionalConsumer;
45  
46  import java.util.Collection;
47  
48  import javax.inject.Inject;
49  
50  import org.apache.commons.lang3.StringUtils;
51  
52  /**
53   * Validates {@link info.magnolia.ui.dialog.definition.FormDialogDefinition}'s reference to {@link info.magnolia.ui.form.field.definition.FieldDefinition}.
54   *
55   * @deprecated since 6.0.
56   */
57  @Deprecated
58  public class DialogDefinitionValidator extends AbstractFieldTypeDefinitionValidator<DialogDefinition> {
59  
60      @Inject
61      public DialogDefinitionValidator(FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry) {
62          super(fieldTypeDefinitionRegistry);
63      }
64  
65      @Override
66      protected void validateDefinition(Collection<DefinitionProvider.Problem> problems, DefinitionProvider<DialogDefinition> definitionProvider) {
67          if (definitionProvider.get() instanceof FormDialogDefinition) {
68              FormDialogDefinition definition = (FormDialogDefinition) definitionProvider.get();
69              if (definition.getForm() != null) {
70                  definition.getForm()
71                          .getTabs()
72                          .forEach(tabDefinition -> tabDefinition.getFields().forEach(fieldDefinition -> {
73                              final String path = getPath(tabDefinition, fieldDefinition);
74                              OptionalConsumer.of(getFieldTypeDefinitionRegistry().getByDefinitionType(fieldDefinition.getClass()))
75                                      .ifPresent(fieldTypeDefinitionProvider -> validateFieldDefinition(problems, fieldTypeDefinitionProvider, path, definitionProvider.getMetadata()))
76                                      .ifNotPresent(() -> reportMissingFieldTypeDefinition(problems, fieldDefinition, path));
77                          }));
78              }
79          }
80      }
81  
82      private String getPath(TabDefinition tabDefinition, FieldDefinition fieldDefinition) {
83          String path = "/form/tabs/" + tabDefinition.getName() + "/fields/" + fieldDefinition.getName();
84          if (fieldDefinition instanceof ConfiguredFieldDefinition) {
85              ConfiguredFieldDefinition configuredFieldDefinition = (ConfiguredFieldDefinition) fieldDefinition;
86              if (StringUtils.isNotBlank(configuredFieldDefinition.getFieldType())) {
87                  return path + "@fieldType";
88              }
89          }
90          return path + "@class";
91      }
92  }