1 package org.apache.maven.plugin.surefire.report; 2 3 /* 4 * Licensed to the Apache Software Foundation (ASF) under one 5 * or more contributor license agreements. See the NOTICE file 6 * distributed with this work for additional information 7 * regarding copyright ownership. The ASF licenses this file 8 * to you under the Apache License, Version 2.0 (the 9 * "License"); you may not use this file except in compliance 10 * with the License. You may obtain a copy of the License at 11 * 12 * http://www.apache.org/licenses/LICENSE-2.0 13 * 14 * Unless required by applicable law or agreed to in writing, 15 * software distributed under the License is distributed on an 16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 17 * KIND, either express or implied. See the License for the 18 * specific language governing permissions and limitations 19 * under the License. 20 */ 21 22 import static org.apache.maven.surefire.shared.lang3.SystemUtils.IS_OS_WINDOWS; 23 24 /** 25 * Utils class for file-based reporters 26 * 27 * @author Andreas Gudian 28 */ 29 public final class FileReporterUtils 30 { 31 private FileReporterUtils() 32 { 33 throw new IllegalStateException( "non instantiable constructor" ); 34 } 35 36 public static String stripIllegalFilenameChars( String original ) 37 { 38 StringBuilder result = new StringBuilder( original ); 39 String illegalChars = getOSSpecificIllegalChars(); 40 for ( int i = 0, len = result.length(); i < len; i++ ) 41 { 42 char charFromOriginal = result.charAt( i ); 43 boolean isIllegalChar = illegalChars.indexOf( charFromOriginal ) != -1; 44 if ( isIllegalChar ) 45 { 46 result.setCharAt( i, '_' ); 47 } 48 } 49 return result.toString(); 50 } 51 52 private static String getOSSpecificIllegalChars() 53 { 54 // forbidden and quoted characters 55 // https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file 56 // https://cygwin.com/cygwin-ug-net/using-specialnames.html 57 // https://www.cyberciti.biz/faq/linuxunix-rules-for-naming-file-and-directory-names/ 58 return IS_OS_WINDOWS ? "[],\\/:*?\"<>|\0" : "()&\\/:*?\"<>|\0"; 59 } 60 }