View Javadoc
1   /**
2    * This file Copyright (c) 2015-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.templating.imaging;
35  
36  import info.magnolia.imaging.ImagingException;
37  import info.magnolia.imaging.OutputFormat;
38  import info.magnolia.imaging.ParameterProvider;
39  import info.magnolia.imaging.operations.ImageOperation;
40  import info.magnolia.imaging.operations.ImageOperationChain;
41  import info.magnolia.templating.imaging.parameters.ThemeAwareParameter;
42  import info.magnolia.templating.imaging.variation.ImageOperationProvidingVariation;
43  
44  import java.awt.image.BufferedImage;
45  import java.io.IOException;
46  
47  import javax.imageio.ImageIO;
48  import javax.jcr.Node;
49  import javax.jcr.RepositoryException;
50  
51  import org.apache.commons.lang3.StringUtils;
52  import org.slf4j.Logger;
53  import org.slf4j.LoggerFactory;
54  
55  /**
56   * {@link info.magnolia.imaging.ImageGenerator} that is aware of {@link info.magnolia.module.site.theme.Theme}s.
57   */
58  public class ThemeAwareImageGenerator extends ImageOperationChain<ParameterProvider<ThemeAwareParameter>> {
59  
60      private static final Logger log = LoggerFactory.getLogger(ThemeAwareImageGenerator.class);
61  
62      public static final String GENERATOR_NAME = "mte";
63  
64      @Override
65      public BufferedImage generate(ParameterProvider<ThemeAwareParameter> parameters) throws ImagingException {
66          final ThemeAwareParameter parameter = parameters.getParameter();
67          return resolveImageVariation(parameter);
68      }
69  
70      @Override
71      public OutputFormat getOutputFormat(ParameterProvider<ThemeAwareParameter> parameters) {
72          final ThemeAwareParameter parameter = parameters.getParameter();
73  
74          OutputFormat format;
75          try {
76              format = getOutputFormat().clone();
77          } catch (CloneNotSupportedException e) {
78              throw new RuntimeException("Can't clone the output format to produce a dynamic format.", e);
79          }
80  
81          String extension = parameter.getExtension();
82          format.setFormatName(extension);
83  
84          if ("gif".equals(StringUtils.lowerCase(extension))) {
85              format.setCompressionType("lzw");
86          } else {
87              format.setCompressionType(null);
88          }
89  
90          return format;
91      }
92  
93      private BufferedImage resolveImageVariation(final ThemeAwareParameter parameter) throws ImagingException {
94          final ImageOperationProvidingVariation variation = parameter.getImageVariation();
95          if (variation == null) {
96              try {
97                  log.info("No image variation found, will return original image.");
98                  return ImageIO.read(parameter.getBinary().getStream());
99              } catch (IOException e) {
100                 log.error("Error reading image from stream. Parameter was [{}].", parameter, e);
101             } catch (RepositoryException e) {
102                 log.error("Error reading image from stream. Parameter was [{}].", parameter, e);
103             }
104             return null;
105         }
106 
107         final ImageOperation<ParameterProvider<Node>> imageOperation = variation.getImageOperation();
108 
109         return imageOperation.apply(null, new ParameterProvider<Node>() {
110             @Override
111             public Node getParameter() {
112                 return parameter.getNode();
113             }
114         });
115     }
116 }