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.plugins.filegenerator.service;
35  
36  import java.io.File;
37  import java.io.IOException;
38  import java.nio.file.DirectoryStream;
39  import java.nio.file.Files;
40  import java.nio.file.Path;
41  import java.nio.file.Paths;
42  import java.util.ArrayList;
43  import java.util.List;
44  import java.util.Locale;
45  import java.util.concurrent.CompletableFuture;
46  
47  import fr.paris.lutece.plugins.filegenerator.business.TemporaryFile;
48  import fr.paris.lutece.plugins.filegenerator.business.TemporaryFileHome;
49  import fr.paris.lutece.portal.business.physicalfile.PhysicalFile;
50  import fr.paris.lutece.portal.business.user.AdminUser;
51  import fr.paris.lutece.portal.service.i18n.I18nService;
52  import fr.paris.lutece.portal.service.util.AppLogService;
53  import fr.paris.lutece.portal.service.util.AppPropertiesService;
54  import fr.paris.lutece.util.file.FileUtil;
55  
56  /**
57   * Service tha generates and saves Temporary Files.
58   */
59  public class TemporaryFileGeneratorService
60  {
61      private static final TemporaryFileGeneratorServiceemporaryFileGeneratorService.html#TemporaryFileGeneratorService">TemporaryFileGeneratorService INSTANCE = new TemporaryFileGeneratorService( );
62      private static final Integer FILE_MAX_SIZE = Integer.parseInt( AppPropertiesService.getProperty( "temporaryfiles.max.size", "0" ) );
63      private static final String KEY_FILE_TOO_BIG = "filegenerator.temporaryfile.file.too.big";
64      private static final Object LOCK = new Object( );
65  
66      public static TemporaryFileGeneratorService getInstance( )
67      {
68          return INSTANCE;
69      }
70  
71      public void generateFile( IFileGenerator generator, AdminUser user )
72      {
73          CompletableFuture.runAsync( new GenerateFileRunnable( generator, user ) );
74      }
75  
76      private static final class GenerateFileRunnable implements Runnable
77      {
78  
79          private IFileGenerator _generator;
80          private AdminUser _user;
81  
82          /**
83           * Constructor.
84           * 
85           * @param _generator
86           * @param _user
87           */
88          public GenerateFileRunnable( IFileGenerator generator, AdminUser user )
89          {
90              _generator = generator;
91              _user = user;
92          }
93  
94          @Override
95          public void run( )
96          {
97              int idFile = TemporaryFileService.getInstance( ).initTemporaryFile( _user, _generator.getDescription( ) );
98              synchronized( LOCK )
99              {
100                 Path generatedFile = null;
101                 try
102                 {
103                     generatedFile = _generator.generateFile( );
104                 }
105                 catch( IOException e )
106                 {
107                     AppLogService.error( "Error generating temporary file with id " + idFile, e );
108                 }
109                 updateTemporaryFile( generatedFile, idFile );
110             }
111         }
112 
113         private void updateTemporaryFile( Path generatedFile, int idFile )
114         {
115             TemporaryFile file = TemporaryFileHome.findByPrimaryKey( idFile );
116             if ( generatedFile != null )
117             {
118                 try
119                 {
120                     PhysicalFile physicalFile = createPhysicalFile( generatedFile );
121                     int size = physicalFile.getValue( ).length;
122                     file.setSize( size );
123                     if ( FILE_MAX_SIZE > 0 && size > FILE_MAX_SIZE )
124                     {
125                         file.setTitle( I18nService.getLocalizedString( KEY_FILE_TOO_BIG, Locale.getDefault( ) ) );
126                         AppLogService.error( "File too big ( " + size + ") : Max size is " + FILE_MAX_SIZE );
127                     }
128                     else
129                     {
130                         file.setTitle( _generator.getFileName( ) );
131                         file.setMimeType( _generator.getMimeType( ) );
132                         file.setDescription( _generator.getDescription( ) );
133                         String physicaId = TemporaryFileService.getInstance( ).savePhysicalFile( file, physicalFile );
134                         file.setIdPhysicalFile( physicaId );
135                     }
136                 }
137                 catch( IOException e )
138                 {
139                     AppLogService.error( "Error storing temporary file with id " + idFile );
140                     file.setTitle( "" );
141                     file.setSize( -1 );
142                 }
143                 finally
144                 {
145                     if ( generatedFile.toFile( ).isDirectory( ) )
146                     {
147                         for ( File fileToDelete : generatedFile.toFile( ).listFiles( ) )
148                         {
149                             FileUtil.deleteFile( fileToDelete );
150                         }
151                     }
152                     FileUtil.deleteFile( generatedFile.toFile( ) );
153                 }
154             }
155             else
156             {
157                 file.setSize( -1 );
158             }
159 
160             TemporaryFileHome.update( file );
161         }
162 
163         private PhysicalFile createPhysicalFile( Path generatedFile ) throws IOException
164         {
165             PhysicalFile physicalFile = new PhysicalFile( );
166             if ( _generator.hasMultipleFiles( ) )
167             {
168                 List<Path> files = new ArrayList<>( );
169                 try ( DirectoryStream<Path> stream = Files.newDirectoryStream( generatedFile ) )
170                 {
171                     for ( Path path : stream )
172                     {
173                         files.add( path );
174                     }
175                 }
176                 createZipPhysicalFile( generatedFile, physicalFile, files.toArray( new Path [ files.size( )] ) );
177             }
178             else
179                 if ( _generator.isZippable( ) )
180                 {
181                     createZipPhysicalFile( generatedFile, physicalFile, generatedFile );
182                 }
183                 else
184                 {
185                     physicalFile.setValue( Files.readAllBytes( generatedFile ) );
186                 }
187             return physicalFile;
188         }
189 
190         private void createZipPhysicalFile( Path generatedFile, PhysicalFile physicalFile, Path... filesToZip ) throws IOException
191         {
192             Path zipFile = Paths.get( generatedFile.getParent( ).toString( ), _generator.getFileName( ) );
193             try
194             {
195                 FileUtil.zipFiles( zipFile, filesToZip );
196                 physicalFile.setValue( Files.readAllBytes( zipFile ) );
197             }
198             finally
199             {
200                 FileUtil.deleteFile( zipFile.toFile( ) );
201             }
202         }
203     }
204 
205 }