View Javadoc
1   /**
2    * This file Copyright (c) 2012-2016 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.pages.app.field;
35  
36  import info.magnolia.config.registry.Registry;
37  import info.magnolia.i18nsystem.I18nizer;
38  import info.magnolia.objectfactory.Components;
39  import info.magnolia.pages.app.editor.PageEditorPresenter;
40  import info.magnolia.rendering.template.TemplateDefinition;
41  import info.magnolia.rendering.template.registry.TemplateDefinitionRegistry;
42  import info.magnolia.ui.api.context.UiContext;
43  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
44  import info.magnolia.ui.form.field.definition.SelectFieldOptionDefinition;
45  import info.magnolia.ui.form.field.factory.SelectFieldFactory;
46  import info.magnolia.ui.vaadin.gwt.client.shared.AreaElement;
47  
48  import java.util.ArrayList;
49  import java.util.List;
50  
51  import javax.inject.Inject;
52  
53  import org.apache.commons.lang3.StringUtils;
54  import org.slf4j.Logger;
55  import org.slf4j.LoggerFactory;
56  
57  import com.vaadin.data.Item;
58  
59  /**
60   * Builds the {@linkplain info.magnolia.ui.form.field.definition.SelectFieldDefinition select field} for selecting component templates.
61   * <p>
62   * Available {@linkplain SelectFieldOptionDefinition options} are created according to the currently selected area in {@link PageEditorPresenter}.
63   */
64  public class ComponentSelectorFieldFactory extends SelectFieldFactory<ComponentSelectorDefinition> {
65  
66      private static final Logger log = LoggerFactory.getLogger(ComponentSelectorFieldFactory.class);
67  
68      private final TemplateDefinitionRegistry templateRegistry;
69      private final PageEditorPresenter pageEditorPresenter;
70      private final I18nizer i18nizer;
71  
72      @Inject
73      public ComponentSelectorFieldFactory(ComponentSelectorDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport, TemplateDefinitionRegistry templateRegistry, PageEditorPresenter pageEditorPresenter, I18nizer i18nizer) {
74          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
75          this.templateRegistry = templateRegistry;
76          this.pageEditorPresenter = pageEditorPresenter;
77          this.i18nizer = i18nizer;
78      }
79  
80      /**
81       * @deprecated since 5.4.6 - use {@link #ComponentSelectorFieldFactory(ComponentSelectorDefinition, Item, UiContext, I18NAuthoringSupport, TemplateDefinitionRegistry, PageEditorPresenter, I18nizer)} instead.
82       */
83      @Deprecated
84      public ComponentSelectorFieldFactory(ComponentSelectorDefinition definition, Item relatedFieldItem, TemplateDefinitionRegistry templateRegistry, PageEditorPresenter pageEditorPresenter, I18nizer i18nizer) {
85          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), templateRegistry, pageEditorPresenter, i18nizer);
86      }
87  
88      /**
89       * @deprecated since 5.4.4 - use {@link #ComponentSelectorFieldFactory(ComponentSelectorDefinition, Item, UiContext, I18NAuthoringSupport, TemplateDefinitionRegistry, PageEditorPresenter, I18nizer)} instead.
90       */
91      @Deprecated
92      public ComponentSelectorFieldFactory(ComponentSelectorDefinition definition, Item relatedFieldItem, TemplateDefinitionRegistry templateRegistry, PageEditorPresenter pageEditorPresenter) {
93          this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), templateRegistry, pageEditorPresenter, Components.getComponent(I18nizer.class));
94      }
95  
96      /**
97       * @deprecated since 5.4.4 - use {@link #ComponentSelectorFieldFactory(ComponentSelectorDefinition, Item, UiContext, I18NAuthoringSupport, TemplateDefinitionRegistry, PageEditorPresenter, I18nizer)} instead.
98       */
99      @Deprecated
100     public ComponentSelectorFieldFactory(ComponentSelectorDefinition definition, Item relatedFieldItem) {
101         this(definition, relatedFieldItem, null, Components.getComponent(I18NAuthoringSupport.class), Components.getComponent(TemplateDefinitionRegistry.class), Components.getComponent(PageEditorPresenter.class), Components.getComponent(I18nizer.class));
102     }
103 
104     /**
105      * Returns the available templates based on the current area.
106      */
107     @Override
108     public List<SelectFieldOptionDefinition> getSelectFieldOptionDefinition() {
109         List<SelectFieldOptionDefinition> res = new ArrayList<SelectFieldOptionDefinition>();
110 
111         if (!(pageEditorPresenter.getSelectedElement() instanceof AreaElement)) {
112             log.warn("Cannot get available components, selected element {} is not an area.", pageEditorPresenter.getSelectedElement());
113             return res;
114         }
115 
116         AreaElement area = (AreaElement) pageEditorPresenter.getSelectedElement();
117         String availableComponents = area.getAvailableComponents();
118 
119         String[] tokens = availableComponents.split(",");
120         for (String token : tokens) {
121             try {
122                 TemplateDefinition templateDefinition = templateRegistry.getProvider(token).get();
123                 SelectFieldOptionDefinition option = new SelectFieldOptionDefinition();
124                 option.setValue(templateDefinition.getId());
125                 option.setLabel(this.getTranslatedTitle(templateDefinition));
126                 res.add(option);
127             } catch (Registry.NoSuchDefinitionException e) {
128                 log.error("Could not get TemplateDefinition for id '{}'.", token, e);
129             }
130         }
131 
132         return res;
133     }
134 
135     @Override
136     protected Class<?> getDefaultFieldType() {
137         return String.class;
138     }
139 
140     private String getTranslatedTitle(TemplateDefinition definition) {
141         String translatedTitle = i18nizer.decorate(definition).getTitle();
142         if (isMessageKey(translatedTitle)) { //compatibility with old i18n mechanism, remove when we get rid of i18nBasename
143             translatedTitle = TemplateSelectorFieldFactory.getI18nTitle(definition);
144         }
145         if (isMessageKey(translatedTitle)) { //fallback to id
146             translatedTitle = definition.getId();
147         }
148         return translatedTitle;
149     }
150 
151     private boolean isMessageKey(String key) {
152         return !StringUtils.endsWith(key, ".") && StringUtils.contains(key, ".") && !StringUtils.contains(key, " ");
153     }
154 
155 }