View Javadoc
1   /*
2    * Copyright (c) 2002-2021, City of Paris
3    * All rights reserved.
4    *
5    * Redistribution and use in source and binary forms, with or without
6    * modification, are permitted provided that the following conditions
7    * are met:
8    *
9    *  1. Redistributions of source code must retain the above copyright notice
10   *     and the following disclaimer.
11   *
12   *  2. Redistributions in binary form must reproduce the above copyright notice
13   *     and the following disclaimer in the documentation and/or other materials
14   *     provided with the distribution.
15   *
16   *  3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17   *     contributors may be used to endorse or promote products derived from
18   *     this software without specific prior written permission.
19   *
20   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21   * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22   * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23   * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24   * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25   * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26   * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27   * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28   * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29   * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30   * POSSIBILITY OF SUCH DAMAGE.
31   *
32   * License 1.0
33   */
34  package fr.paris.lutece.plugins.stock.utils;
35  
36  import java.awt.image.BufferedImage;
37  import java.io.File;
38  import java.io.IOException;
39  
40  import javax.imageio.ImageIO;
41  
42  import org.apache.log4j.Logger;
43  import org.imgscalr.Scalr;
44  
45  /**
46   * Class for manipulating images
47   * 
48   * @author abataille
49   */
50  public final class ImageUtils
51  {
52      private static final String PARAMETER_JPG = "jpg";
53      private static final Logger LOGGER = Logger.getLogger( ImageUtils.class );
54  
55      /**
56       * 
57       * Creates a new ImageUtils.java object.
58       */
59      private ImageUtils( )
60      {
61  
62      }
63  
64      /**
65       * Create a thumbnail and write it into a new file prefixed by tb_ (images/lutece.jpg => images/lutece_tb.jpg)
66       * 
67       * @param fImage
68       *            source image file
69       * @param width
70       *            max width of the thumbnail
71       * @param height
72       *            the height
73       * @throws IOException
74       *             Signals that an I/O exception has occurred.
75       */
76      public static File createThumbnail( File fImage, int width, int height ) throws IOException
77      {
78          File fThumb = resizeImage( fImage, width, height, "tb_" + fImage.getName( ) );
79  
80          LOGGER.debug( "Thumbnail créé " + fThumb.getAbsolutePath( ) );
81          return fThumb;
82      }
83  
84      /**
85       * 
86       * @param fImage
87       *            source image file
88       * @param width
89       *            the max width for the image
90       * @param height
91       *            the max height for the image
92       * @param newName
93       *            the new name for the image, can be null to keep old name
94       * @return the image with limit dimensions
95       * @throws IOException
96       *             Signals that an I/O exception has occurred.
97       */
98      public static File resizeImage( File fImage, int maxWidth, int maxHeight, String newName ) throws IOException
99      {
100         BufferedImage image = ImageIO.read( fImage );
101         BufferedImage resizedImage;
102 
103         if ( image.getWidth( ) > maxWidth || image.getHeight( ) > maxHeight )
104         {
105             resizedImage = Scalr.resize( image, Scalr.Mode.AUTOMATIC, maxWidth, maxHeight );
106         }
107         else
108         {
109             LOGGER.debug( "Image " + fImage.getName( ) + " non redimensionnée car déjà plus petite que " + maxWidth + "x" + maxHeight );
110             resizedImage = image;
111         }
112 
113         File fResized = new File( fImage.getParent( ), newName != null ? newName : fImage.getName( ) );
114         ImageIO.write( resizedImage, PARAMETER_JPG, fResized );
115 
116         return fResized;
117     }
118 }