View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.dam.app.ui.field.factory;
35  
36  import info.magnolia.cms.core.Path;
37  import info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition;
38  import info.magnolia.dam.app.ui.field.upload.AssetUploadReceiver;
39  import info.magnolia.dam.app.ui.field.upload.DamUploadField;
40  import info.magnolia.dam.app.ui.field.upload.ResurfaceDamUploadField;
41  import info.magnolia.event.EventBus;
42  import info.magnolia.i18nsystem.SimpleTranslator;
43  import info.magnolia.objectfactory.ComponentProvider;
44  import info.magnolia.objectfactory.Components;
45  import info.magnolia.ui.api.app.SubAppContext;
46  import info.magnolia.ui.api.context.UiContext;
47  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
48  import info.magnolia.ui.form.field.factory.AbstractFieldFactory;
49  import info.magnolia.ui.form.field.transformer.Transformer;
50  import info.magnolia.ui.framework.ioc.AdmincentralFlavour;
51  import info.magnolia.ui.imageprovider.ImageProvider;
52  import info.magnolia.ui.mediaeditor.MediaEditorPresenterFactory;
53  
54  import java.io.File;
55  
56  import javax.inject.Inject;
57  
58  import com.vaadin.v7.data.Item;
59  import com.vaadin.v7.ui.Field;
60  
61  /**
62   * Creates and configures an {@link DamUploadField}.
63   */
64  public class DamUploadFieldFactory extends AbstractFieldFactory<DamUploadFieldDefinition, AssetUploadReceiver> {
65  
66      private final MediaEditorPresenterFactory mediaEditorFactory;
67      private final UiContext uiContext;
68      private final ImageProvider imageProvider;
69      private final ComponentProvider componentProvider;
70      private final SimpleTranslator i18n;
71  
72      @Inject
73      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18NAuthoringSupport, ImageProvider imageProvider, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
74          super(definition, relatedFieldItem, uiContext, i18NAuthoringSupport);
75          this.mediaEditorFactory = mediaEditorFactory;
76          this.uiContext = uiContext;
77          this.imageProvider = imageProvider;
78          this.componentProvider = componentProvider;
79          this.i18n = i18n;
80      }
81  
82      /**
83       * @deprecated since 2.1.4. Use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
84       */
85      @Deprecated
86      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n, I18NAuthoringSupport i18NAuthoringSupport, EventBus subAppEventBus) {
87          this(definition, relatedFieldItem, uiContext, i18NAuthoringSupport, imageProvider, mediaEditorFactory, componentProvider, i18n);
88      }
89  
90      /**
91       * @deprecated since 2.1.3. Use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
92       */
93      @Deprecated
94      public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, UiContext uiContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
95          this(definition, relatedFieldItem, uiContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, mediaEditorFactory, componentProvider, i18n);
96      }
97  
98      /**
99       * @deprecated since 2.0.4, should not depend upon subapp components, use {@link #DamUploadFieldFactory(DamUploadFieldDefinition, Item, UiContext, I18NAuthoringSupport, ImageProvider, MediaEditorPresenterFactory, ComponentProvider, SimpleTranslator)} instead.
100      */
101     @Deprecated
102     public DamUploadFieldFactory(DamUploadFieldDefinition definition, Item relatedFieldItem, ImageProvider imageProvider, SubAppContext subAppContext, MediaEditorPresenterFactory mediaEditorFactory, ComponentProvider componentProvider, SimpleTranslator i18n) {
103         this(definition, relatedFieldItem, subAppContext, Components.getComponent(I18NAuthoringSupport.class), imageProvider, mediaEditorFactory, componentProvider, i18n);
104     }
105 
106     @Override
107     protected Field<AssetUploadReceiver> createFieldComponent() {
108         if (AdmincentralFlavour.get().isM5()) {
109             return new DamUploadField(imageProvider, uiContext, mediaEditorFactory, componentProvider, definition, i18n);
110         } else {
111             return new ResurfaceDamUploadField(imageProvider, uiContext, mediaEditorFactory, componentProvider, definition, i18n);
112         }
113     }
114 
115     /**
116      * MGNLDAM-286 For test only; we need a partial mock there otherwise Path fails when getting MAGNOLIA_APP_ROOTDIR system property.
117      */
118     File getTempDirectory() {
119         return Path.getTempDirectory();
120     }
121 
122     @Override
123     protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
124         return this.componentProvider.newInstance(transformerClass, item, definition, AssetUploadReceiver.class);
125     }
126 }