View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.transformer;
35  
36  import info.magnolia.dam.app.ui.field.definition.DamUploadFieldDefinition;
37  import info.magnolia.dam.app.ui.field.upload.AssetUploadReceiver;
38  import info.magnolia.dam.jcr.AssetNodeTypes;
39  import info.magnolia.objectfactory.Components;
40  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
41  import info.magnolia.ui.form.field.transformer.item.FileTransformer;
42  
43  import javax.inject.Inject;
44  
45  import org.apache.commons.lang3.StringUtils;
46  
47  import com.vaadin.v7.data.Item;
48  
49  /**
50   * Asset specific implementation of {@link FileTransformer}.
51   *
52   * @param <T> property type used by the related field.
53   */
54  public class AssetTransformer<T extends AssetUploadReceiver> extends FileTransformer<T> {
55  
56      @Inject
57      public AssetTransformer(Item relatedFormItem, DamUploadFieldDefinition definition, Class<T> type, I18NAuthoringSupport i18nAuthoringSupport) {
58          super(relatedFormItem, definition, type, i18nAuthoringSupport);
59      }
60  
61      /**
62       * @deprecated since 2.2.2 use {@link #AssetTransformer(Item, DamUploadFieldDefinition, Class, I18NAuthoringSupport)} instead
63       */
64      @Deprecated
65      public AssetTransformer(Item relatedFormItem, DamUploadFieldDefinition definition, Class<T> type) {
66          this(relatedFormItem, definition, type, Components.getComponent(I18NAuthoringSupport.class));
67      }
68  
69      /**
70       * Used to access utility methods.
71       */
72      public AssetTransformer() {
73          this(null, new DamUploadFieldDefinition(), (Class<T>) AssetUploadReceiver.class, null);
74      }
75  
76      @Override
77      public T createPropertyFromItem(Item item) {
78          T assetUploadReceiver = super.createPropertyFromItem(item);
79          if (StringUtils.isNotBlank(assetUploadReceiver.getMimeType())) {
80              assetUploadReceiver.updateRelatedProperties();
81          }
82          return assetUploadReceiver;
83      }
84  
85      @Override
86      protected T initializeUploadReceiver() {
87          return (T) Components.newInstance(AssetUploadReceiver.class);
88      }
89  
90      @Override
91      public Item populateItem(T newValue, Item item) {
92          super.populateItem(newValue, item);
93          newValue.updateRelatedProperties();
94          // since DAM 2.0 we store filename + extension in the fileName property
95          getOrCreateProperty(item, AssetNodeTypes.AssetResource.FILENAME, String.class).setValue(newValue.getFileName());
96          if (newValue.isImage() && newValue.getFileSize() > 0) {
97              // Set
98              getOrCreateProperty(item, AssetNodeTypes.AssetResource.WIDTH, Long.class).setValue(newValue.getWidth());
99              getOrCreateProperty(item, AssetNodeTypes.AssetResource.HEIGHT, Long.class).setValue(newValue.getHeight());
100             // Remove
101             item.removeItemProperty("duration");
102         } else if (newValue.getDuration() > 0) {
103             // Set
104             getOrCreateProperty(item, "duration", Long.class).setValue(newValue.getDuration());
105 
106             // Remove
107             item.removeItemProperty(AssetNodeTypes.AssetResource.WIDTH);
108             item.removeItemProperty(AssetNodeTypes.AssetResource.HEIGHT);
109         } else {
110             // Remove
111             item.removeItemProperty("duration");
112             item.removeItemProperty(AssetNodeTypes.AssetResource.WIDTH);
113             item.removeItemProperty(AssetNodeTypes.AssetResource.HEIGHT);
114         }
115         return item;
116     }
117 }