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.releaser.util.file;
35
36 import java.io.File;
37 import java.io.IOException;
38 import java.util.ArrayList;
39 import java.util.List;
40
41 import fr.paris.lutece.portal.service.util.AppLogService;
42
43 // TODO: Auto-generated Javadoc
44 /**
45 * The Class FileUtils.
46 */
47 public class FileUtils
48 {
49
50 /** The Constant STATUS_OK. */
51 public static final boolean STATUS_OK = true;
52
53 /** The Constant STATUS_ERROR. */
54 public static final boolean STATUS_ERROR = false;
55
56 /**
57 * Delete.
58 *
59 * @param file
60 * the file
61 * @param logBuffer
62 * the log buffer
63 * @return true, if successful
64 */
65 public static boolean delete( File file, StringBuffer logBuffer )
66 {
67 if ( file.isDirectory( ) )
68 {
69 boolean bStatus = STATUS_OK;
70
71 for ( String fileName : file.list( ) )
72 {
73 // Names denoting the directory itself and the directory's parent directory are not included in the result
74 bStatus &= delete( new File( file.getAbsolutePath( ) + File.separator + fileName ), logBuffer );
75 }
76 }
77
78 logBuffer.append( "DELETING " + file.getAbsolutePath( ) + "\n" );
79
80 if ( !file.delete( ) )
81 {
82 logBuffer.append( "UNABLE TO DELETE : " + file.getAbsolutePath( ) );
83
84 return STATUS_ERROR;
85 }
86
87 return STATUS_OK;
88 }
89
90 /**
91 * Read file.
92 *
93 * @param strFilePath
94 * the str file path
95 * @return the string
96 */
97 public static String readFile( String strFilePath )
98 {
99 File file = new File( strFilePath );
100 String strFile = null;
101 try
102 {
103 strFile = org.apache.commons.io.FileUtils.readFileToString( file, "UTF-8" );
104 }
105 catch( IOException e )
106 {
107
108 AppLogService.error( e );
109 }
110 return strFile;
111
112 }
113
114 /**
115 * List.
116 *
117 * @param strDirPath
118 * the str dir path
119 * @param strFileExtension
120 * the str file extension
121 * @return the list
122 */
123 public static List<String> list( String strDirPath, String strFileExtension )
124 {
125 return list( strDirPath, strFileExtension, true );
126 }
127
128 /**
129 * List.
130 *
131 * @param strDirPath
132 * the str dir path
133 * @param strFileExtension
134 * the str file extension
135 * @param bRecursive
136 * the b recursive
137 * @return the list
138 */
139 public static List<String> list( String strDirPath, String strFileExtension, boolean bRecursive )
140 {
141 List<String> strFileList = new ArrayList<String>( );
142 File file = new File( strDirPath );
143
144 for ( File fileChild : file.listFiles( ) )
145 {
146 if ( fileChild.isDirectory( ) && bRecursive )
147 {
148 strFileList.addAll( list( fileChild.getAbsolutePath( ), strFileExtension, bRecursive ) );
149 }
150 else
151 if ( fileChild.isFile( ) && ( ( strFileExtension == null ) || file.getName( ).endsWith( strFileExtension ) ) )
152 {
153 strFileList.add( file.getName( ) );
154 }
155 }
156
157 return strFileList;
158 }
159
160 }