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.contentapp.registry.validator;
35  
36  import info.magnolia.config.registry.DefinitionProvider;
37  import info.magnolia.ui.api.app.AppDescriptor;
38  import info.magnolia.ui.api.app.SubAppDescriptor;
39  import info.magnolia.ui.contentapp.detail.ConfiguredDetailSubAppDescriptor;
40  import info.magnolia.ui.form.definition.TabDefinition;
41  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
42  import info.magnolia.ui.form.field.definition.FieldDefinition;
43  import info.magnolia.ui.form.fieldtype.registry.AbstractFieldTypeDefinitionValidator;
44  import info.magnolia.ui.form.fieldtype.registry.FieldTypeDefinitionRegistry;
45  import info.magnolia.util.OptionalConsumer;
46  
47  import java.util.Collection;
48  
49  import javax.inject.Inject;
50  
51  import org.apache.commons.lang3.StringUtils;
52  
53  /**
54   * Validates {@link info.magnolia.ui.api.app.AppDescriptor}'s reference to {@link info.magnolia.ui.form.field.definition.FieldDefinition}.
55   */
56  public class AppDescriptorValidator extends AbstractFieldTypeDefinitionValidator<AppDescriptor> {
57  
58      @Inject
59      public AppDescriptorValidator(FieldTypeDefinitionRegistry fieldTypeDefinitionRegistry) {
60          super(fieldTypeDefinitionRegistry);
61      }
62  
63      @Override
64      protected void validateDefinition(Collection<DefinitionProvider.Problem> problems, DefinitionProvider<AppDescriptor> definitionProvider) {
65          for (SubAppDescriptor subAppDescriptor : definitionProvider.get().getSubApps().values()) {
66              if (subAppDescriptor instanceof ConfiguredDetailSubAppDescriptor) {
67                  ConfiguredDetailSubAppDescriptor descriptor = (ConfiguredDetailSubAppDescriptor) subAppDescriptor;
68                  if (descriptor.getEditor() != null && descriptor.getEditor().getForm() != null) {
69                      descriptor.getEditor()
70                              .getForm()
71                              .getTabs()
72                              .forEach(tabDefinition -> tabDefinition.getFields().forEach(fieldDefinition -> {
73                                  final String path = getPath(definitionProvider, descriptor, 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  
83      private String getPath(DefinitionProvider<AppDescriptor> definitionProvider, ConfiguredDetailSubAppDescriptor descriptor, TabDefinition tabDefinition, FieldDefinition fieldDefinition) {
84          String path = definitionProvider.get().getName() + "/subApps/" + descriptor.getName() + "/editor/form/tabs/" + tabDefinition.getName() + "/fields/" + fieldDefinition.getName();
85          if (fieldDefinition instanceof ConfiguredFieldDefinition) {
86              ConfiguredFieldDefinition configuredFieldDefinition = (ConfiguredFieldDefinition) fieldDefinition;
87              if (StringUtils.isNotBlank(configuredFieldDefinition.getFieldType())) {
88                  return path + "@fieldType";
89              }
90          }
91          return path + "@class";
92      }
93  }