View Javadoc
1   /* 
2    * Copyright (c) 2002-2022, 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.portal.service.fileimage;
35  
36  import org.apache.commons.fileupload.FileItem;
37  
38  import fr.paris.lutece.portal.business.file.File;
39  import fr.paris.lutece.portal.service.cache.AbstractCacheableService;
40  import fr.paris.lutece.portal.service.file.FileService;
41  import fr.paris.lutece.portal.service.file.FileServiceException;
42  import fr.paris.lutece.portal.service.file.IFileStoreServiceProvider;
43  import fr.paris.lutece.portal.service.image.ImageResource;
44  import fr.paris.lutece.portal.service.image.ImageResourceManager;
45  import fr.paris.lutece.portal.service.image.ImageResourceProvider;
46  import fr.paris.lutece.portal.service.init.LuteceInitException;
47  import fr.paris.lutece.portal.service.util.AppLogService;
48  import fr.paris.lutece.util.file.FileUtil;
49  
50  public class FileImagePublicService extends AbstractCacheableService implements ImageResourceProvider 
51  {
52  	private static FileImagePublicServiceileImagePublicService.html#FileImagePublicService">FileImagePublicService _singleton = new FileImagePublicService( );
53  	public static final String IMAGE_RESOURCE_TYPE_ID = "public_image_resource";
54  	private static final IFileStoreServiceProvider _fileStoreService = FileService.getInstance( ).getFileStoreServiceProvider( );
55  	
56  	/**
57       * Creates a new instance of FileImgService
58       */
59      private FileImagePublicService( )
60      {
61      	initCache();
62      }
63      
64      /**
65       * Init
66       *
67       * @throws LuteceInitException
68       *             if an error occurs
69       */
70      public static synchronized void init( )
71      {
72          getInstance( ).register( );
73      }
74      
75      /**
76       * Initializes the service
77       */
78      public void register( )
79      {
80          ImageResourceManager.registerProvider( this );
81      }
82  
83      /**
84       * Get the unique instance of the service
85       *
86       * @return The unique instance
87       */
88      public static FileImagePublicService getInstance( )
89      {
90          return _singleton;
91      }
92  
93  	@Override
94  	/**
95       * Return the Resource Type id
96       *
97       * @return The Resource Type Id
98       */
99      public String getResourceTypeId( )
100     {
101         return IMAGE_RESOURCE_TYPE_ID;
102     }
103 
104 	@Override
105 	public ImageResource getImageResource( int nIdResource )
106 	{
107         /*get from cache*/
108 		String cacheKey = getCacheKey( nIdResource );
109 		ImageResource imageresource = (ImageResource) getFromCache( cacheKey );
110 		if ( imageresource != null )
111 		{
112 			return imageresource;
113 		}
114 		else
115 		{
116 			/*if no cache*/
117 			try 
118 			{
119 				File file = _fileStoreService.getFile( String.valueOf( nIdResource ) );
120 				
121 				if ( ( file != null ) && ( file.getPhysicalFile( ) != null ) && FileUtil.hasImageExtension( file.getTitle( ) ) )
122 		        {
123 		        	ImageResource imageResource = new ImageResource( file );
124 		        	putInCache( cacheKey, imageResource);
125 		            return imageResource;
126 		        }
127 			}
128 			catch ( FileServiceException e )
129 			{
130 				AppLogService.error(e);
131 			}
132 		}
133 
134         return null;
135 	}
136 	
137 	/**
138      * Return the Resource id
139      *
140      * @param iImageResource
141      *            The resource identifier
142      * @return The New Resource Id
143      */
144 	public String addImageResource( FileItem fileItem )
145     {
146 		try 
147 		{
148 			return _fileStoreService.storeFileItem( fileItem ) ;
149 		}
150 		catch ( FileServiceException e )
151 		{
152 			AppLogService.error(e);
153 			return null;
154 		}
155     }
156 
157 	@Override
158 	public String getName( )
159 	{
160 		return IMAGE_RESOURCE_TYPE_ID;
161 	}
162 	
163 	/**
164      * get the cache key
165      * 
166      * @param nId
167      * @param user
168      * @return the key
169      */
170     private static String getCacheKey( int nId )
171     {
172         StringBuilder sbKey = new StringBuilder( );
173         return sbKey.append( "[" ).append( IMAGE_RESOURCE_TYPE_ID ).append( ":" ).append( nId )
174         		.append( "]" ).toString( );
175     }
176 }