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.util.filesystem;
35
36 import fr.paris.lutece.util.string.StringUtil;
37
38 /**
39 * This class provides utilities for uploaded files
40 */
41 public final class UploadUtil
42 {
43 /**
44 * Creates a new UploadUtil object.
45 */
46 private UploadUtil( )
47 {
48 }
49
50 /**
51 * Removes special characters contained in the file name
52 *
53 * @param strName
54 * the file name
55 * @return strClearName the cleaned file name
56 */
57 public static String cleanFileName( String strName )
58 {
59 return cleanString( strName, false );
60 }
61
62 /**
63 * Removes special characters contained in a file path. This method performs the same transformation as cleanFileName but leaves out the slashes.
64 *
65 * @param strPath
66 * The path to clean
67 * @return The cleaned path
68 */
69 public static String cleanFilePath( String strPath )
70 {
71 return cleanString( strPath, true );
72 }
73
74 /**
75 * Helper method for cleanFileName and cleanFilePath.
76 *
77 * @param strValue
78 * The string literal to clean
79 * @param bKeepSlashes
80 * Set to true to keep slashes, false to replace them
81 * @return The cleaned string literal
82 */
83 private static String cleanString( String strValue, boolean bKeepSlashes )
84 {
85 // First, replace the accents :
86 String strNoAccents = StringUtil.replaceAccent( strValue );
87
88 // Convert to an array of characters
89 char [ ] characters = new char [ strNoAccents.length( )];
90 strNoAccents.getChars( 0, strNoAccents.length( ), characters, 0 );
91
92 // Iterate to process one character at a time
93 for ( int i = 0; i < strNoAccents.length( ); i++ )
94 {
95 char current = characters [i];
96
97 // Valid characters are : '.', alphanumeric (a-zA-Z0-9),
98 // and '/' if bKeepSlashes is true.
99 boolean bValid = ( ( current == '.' ) || ( ( current >= '0' ) && ( current <= '9' ) ) || ( ( current >= 'a' ) && ( current <= 'z' ) )
100 || ( ( current >= 'A' ) && ( current <= 'Z' ) ) || ( bKeepSlashes && ( current == '/' ) ) );
101
102 // Other characters are replaced by underscore.
103 if ( !bValid )
104 {
105 characters [i] = '_';
106 }
107 }
108
109 // Return result as a string
110 return String.valueOf( characters );
111 }
112 }