Google Git
Sign in
apache / logging-log4j-site / 9755b12b39efbc0142688f9b1a11ec68db89f97b / . / 2.13.1 / log4j-core / apidocs / src-html / org / apache / logging / log4j / core / util / FileUtils.html
blob: 0bae6d834bb9c8ea4b6d11efb530ade208ddcca4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.core.util;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import java.io.File;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import java.io.IOException;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import java.io.UnsupportedEncodingException;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import java.net.MalformedURLException;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.net.URI;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.net.URL;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.net.URLDecoder;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.nio.charset.StandardCharsets;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.nio.file.FileSystems;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.nio.file.Files;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.nio.file.Path;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import java.nio.file.attribute.GroupPrincipal;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import java.nio.file.attribute.PosixFileAttributeView;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import java.nio.file.attribute.PosixFilePermission;<a name="line.32"></a>
<span class="sourceLineNo">033</span>import java.nio.file.attribute.UserPrincipal;<a name="line.33"></a>
<span class="sourceLineNo">034</span>import java.nio.file.attribute.UserPrincipalLookupService;<a name="line.34"></a>
<span class="sourceLineNo">035</span>import java.util.Objects;<a name="line.35"></a>
<span class="sourceLineNo">036</span>import java.util.Set;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>import org.apache.logging.log4j.Logger;<a name="line.38"></a>
<span class="sourceLineNo">039</span>import org.apache.logging.log4j.status.StatusLogger;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>/**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * File utilities.<a name="line.42"></a>
<span class="sourceLineNo">043</span> */<a name="line.43"></a>
<span class="sourceLineNo">044</span>public final class FileUtils {<a name="line.44"></a>
<span class="sourceLineNo">045</span><a name="line.45"></a>
<span class="sourceLineNo">046</span> /** Constant for the file URL protocol. */<a name="line.46"></a>
<span class="sourceLineNo">047</span> private static final String PROTOCOL_FILE = "file";<a name="line.47"></a>
<span class="sourceLineNo">048</span><a name="line.48"></a>
<span class="sourceLineNo">049</span> private static final String JBOSS_FILE = "vfsfile";<a name="line.49"></a>
<span class="sourceLineNo">050</span><a name="line.50"></a>
<span class="sourceLineNo">051</span> private static final Logger LOGGER = StatusLogger.getLogger();<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> private FileUtils() {<a name="line.53"></a>
<span class="sourceLineNo">054</span> }<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * Tries to convert the specified URI to a file object. If this fails, &lt;b&gt;null&lt;/b&gt; is returned.<a name="line.57"></a>
<span class="sourceLineNo">058</span> *<a name="line.58"></a>
<span class="sourceLineNo">059</span> * @param uri the URI<a name="line.59"></a>
<span class="sourceLineNo">060</span> * @return the resulting file object<a name="line.60"></a>
<span class="sourceLineNo">061</span> */<a name="line.61"></a>
<span class="sourceLineNo">062</span> public static File fileFromUri(URI uri) {<a name="line.62"></a>
<span class="sourceLineNo">063</span> // There MUST be a better way to do this. TODO Search other ASL projects...<a name="line.63"></a>
<span class="sourceLineNo">064</span> if (uri == null || (uri.getScheme() != null<a name="line.64"></a>
<span class="sourceLineNo">065</span> &amp;&amp; (!PROTOCOL_FILE.equals(uri.getScheme()) &amp;&amp; !JBOSS_FILE.equals(uri.getScheme())))) {<a name="line.65"></a>
<span class="sourceLineNo">066</span> return null;<a name="line.66"></a>
<span class="sourceLineNo">067</span> }<a name="line.67"></a>
<span class="sourceLineNo">068</span> if (uri.getScheme() == null) {<a name="line.68"></a>
<span class="sourceLineNo">069</span> File file = new File(uri.toString());<a name="line.69"></a>
<span class="sourceLineNo">070</span> if (file.exists()) {<a name="line.70"></a>
<span class="sourceLineNo">071</span> return file;<a name="line.71"></a>
<span class="sourceLineNo">072</span> }<a name="line.72"></a>
<span class="sourceLineNo">073</span> try {<a name="line.73"></a>
<span class="sourceLineNo">074</span> final String path = uri.getPath();<a name="line.74"></a>
<span class="sourceLineNo">075</span> file = new File(path);<a name="line.75"></a>
<span class="sourceLineNo">076</span> if (file.exists()) {<a name="line.76"></a>
<span class="sourceLineNo">077</span> return file;<a name="line.77"></a>
<span class="sourceLineNo">078</span> }<a name="line.78"></a>
<span class="sourceLineNo">079</span> uri = new File(path).toURI();<a name="line.79"></a>
<span class="sourceLineNo">080</span> } catch (final Exception ex) {<a name="line.80"></a>
<span class="sourceLineNo">081</span> LOGGER.warn("Invalid URI {}", uri);<a name="line.81"></a>
<span class="sourceLineNo">082</span> return null;<a name="line.82"></a>
<span class="sourceLineNo">083</span> }<a name="line.83"></a>
<span class="sourceLineNo">084</span> }<a name="line.84"></a>
<span class="sourceLineNo">085</span> final String charsetName = StandardCharsets.UTF_8.name();<a name="line.85"></a>
<span class="sourceLineNo">086</span> try {<a name="line.86"></a>
<span class="sourceLineNo">087</span> String fileName = uri.toURL().getFile();<a name="line.87"></a>
<span class="sourceLineNo">088</span> if (new File(fileName).exists()) { // LOG4J2-466<a name="line.88"></a>
<span class="sourceLineNo">089</span> return new File(fileName); // allow files with '+' char in name<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> fileName = URLDecoder.decode(fileName, charsetName);<a name="line.91"></a>
<span class="sourceLineNo">092</span> return new File(fileName);<a name="line.92"></a>
<span class="sourceLineNo">093</span> } catch (final MalformedURLException ex) {<a name="line.93"></a>
<span class="sourceLineNo">094</span> LOGGER.warn("Invalid URL {}", uri, ex);<a name="line.94"></a>
<span class="sourceLineNo">095</span> } catch (final UnsupportedEncodingException uee) {<a name="line.95"></a>
<span class="sourceLineNo">096</span> LOGGER.warn("Invalid encoding: {}", charsetName, uee);<a name="line.96"></a>
<span class="sourceLineNo">097</span> }<a name="line.97"></a>
<span class="sourceLineNo">098</span> return null;<a name="line.98"></a>
<span class="sourceLineNo">099</span> }<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span> public static boolean isFile(final URL url) {<a name="line.101"></a>
<span class="sourceLineNo">102</span> return url != null &amp;&amp; (url.getProtocol().equals(PROTOCOL_FILE) || url.getProtocol().equals(JBOSS_FILE));<a name="line.102"></a>
<span class="sourceLineNo">103</span> }<a name="line.103"></a>
<span class="sourceLineNo">104</span><a name="line.104"></a>
<span class="sourceLineNo">105</span> public static String getFileExtension(final File file) {<a name="line.105"></a>
<span class="sourceLineNo">106</span> final String fileName = file.getName();<a name="line.106"></a>
<span class="sourceLineNo">107</span> if (fileName.lastIndexOf(".") != -1 &amp;&amp; fileName.lastIndexOf(".") != 0) {<a name="line.107"></a>
<span class="sourceLineNo">108</span> return fileName.substring(fileName.lastIndexOf(".") + 1);<a name="line.108"></a>
<span class="sourceLineNo">109</span> }<a name="line.109"></a>
<span class="sourceLineNo">110</span> return null;<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> /**<a name="line.113"></a>
<span class="sourceLineNo">114</span> * Asserts that the given directory exists and creates it if necessary.<a name="line.114"></a>
<span class="sourceLineNo">115</span> *<a name="line.115"></a>
<span class="sourceLineNo">116</span> * @param dir the directory that shall exist<a name="line.116"></a>
<span class="sourceLineNo">117</span> * @param createDirectoryIfNotExisting specifies if the directory shall be created if it does not exist.<a name="line.117"></a>
<span class="sourceLineNo">118</span> * @throws java.io.IOException thrown if the directory could not be created.<a name="line.118"></a>
<span class="sourceLineNo">119</span> */<a name="line.119"></a>
<span class="sourceLineNo">120</span> public static void mkdir(final File dir, final boolean createDirectoryIfNotExisting) throws IOException {<a name="line.120"></a>
<span class="sourceLineNo">121</span> // commons io FileUtils.forceMkdir would be useful here, we just want to omit this dependency<a name="line.121"></a>
<span class="sourceLineNo">122</span> if (!dir.exists()) {<a name="line.122"></a>
<span class="sourceLineNo">123</span> if (!createDirectoryIfNotExisting) {<a name="line.123"></a>
<span class="sourceLineNo">124</span> throw new IOException("The directory " + dir.getAbsolutePath() + " does not exist.");<a name="line.124"></a>
<span class="sourceLineNo">125</span> }<a name="line.125"></a>
<span class="sourceLineNo">126</span> if (!dir.mkdirs()) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> throw new IOException("Could not create directory " + dir.getAbsolutePath());<a name="line.127"></a>
<span class="sourceLineNo">128</span> }<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span> if (!dir.isDirectory()) {<a name="line.130"></a>
<span class="sourceLineNo">131</span> throw new IOException("File " + dir + " exists and is not a directory. Unable to create directory.");<a name="line.131"></a>
<span class="sourceLineNo">132</span> }<a name="line.132"></a>
<span class="sourceLineNo">133</span> }<a name="line.133"></a>
<span class="sourceLineNo">134</span><a name="line.134"></a>
<span class="sourceLineNo">135</span> /**<a name="line.135"></a>
<span class="sourceLineNo">136</span> * Creates the parent directories for the given File.<a name="line.136"></a>
<span class="sourceLineNo">137</span> *<a name="line.137"></a>
<span class="sourceLineNo">138</span> * @param file<a name="line.138"></a>
<span class="sourceLineNo">139</span> * @throws IOException<a name="line.139"></a>
<span class="sourceLineNo">140</span> */<a name="line.140"></a>
<span class="sourceLineNo">141</span> public static void makeParentDirs(final File file) throws IOException {<a name="line.141"></a>
<span class="sourceLineNo">142</span> final File parent = Objects.requireNonNull(file, "file").getCanonicalFile().getParentFile();<a name="line.142"></a>
<span class="sourceLineNo">143</span> if (parent != null) {<a name="line.143"></a>
<span class="sourceLineNo">144</span> mkdir(parent, true);<a name="line.144"></a>
<span class="sourceLineNo">145</span> }<a name="line.145"></a>
<span class="sourceLineNo">146</span> }<a name="line.146"></a>
<span class="sourceLineNo">147</span><a name="line.147"></a>
<span class="sourceLineNo">148</span> /**<a name="line.148"></a>
<span class="sourceLineNo">149</span> * Define file posix attribute view on a path/file.<a name="line.149"></a>
<span class="sourceLineNo">150</span> *<a name="line.150"></a>
<span class="sourceLineNo">151</span> * @param path Target path<a name="line.151"></a>
<span class="sourceLineNo">152</span> * @param filePermissions Permissions to apply<a name="line.152"></a>
<span class="sourceLineNo">153</span> * @param fileOwner File owner<a name="line.153"></a>
<span class="sourceLineNo">154</span> * @param fileGroup File group<a name="line.154"></a>
<span class="sourceLineNo">155</span> * @throws IOException If IO error during definition of file attribute view<a name="line.155"></a>
<span class="sourceLineNo">156</span> */<a name="line.156"></a>
<span class="sourceLineNo">157</span> public static void defineFilePosixAttributeView(final Path path,<a name="line.157"></a>
<span class="sourceLineNo">158</span> final Set&lt;PosixFilePermission&gt; filePermissions,<a name="line.158"></a>
<span class="sourceLineNo">159</span> final String fileOwner,<a name="line.159"></a>
<span class="sourceLineNo">160</span> final String fileGroup) throws IOException {<a name="line.160"></a>
<span class="sourceLineNo">161</span> final PosixFileAttributeView view = Files.getFileAttributeView(path, PosixFileAttributeView.class);<a name="line.161"></a>
<span class="sourceLineNo">162</span> if (view != null) {<a name="line.162"></a>
<span class="sourceLineNo">163</span> final UserPrincipalLookupService lookupService = FileSystems.getDefault()<a name="line.163"></a>
<span class="sourceLineNo">164</span> .getUserPrincipalLookupService();<a name="line.164"></a>
<span class="sourceLineNo">165</span> if (fileOwner != null) {<a name="line.165"></a>
<span class="sourceLineNo">166</span> final UserPrincipal userPrincipal = lookupService.lookupPrincipalByName(fileOwner);<a name="line.166"></a>
<span class="sourceLineNo">167</span> if (userPrincipal != null) {<a name="line.167"></a>
<span class="sourceLineNo">168</span> // If not sudoers member, it will throw Operation not permitted<a name="line.168"></a>
<span class="sourceLineNo">169</span> // Only processes with an effective user ID equal to the user ID<a name="line.169"></a>
<span class="sourceLineNo">170</span> // of the file or with appropriate privileges may change the ownership of a file.<a name="line.170"></a>
<span class="sourceLineNo">171</span> // If _POSIX_CHOWN_RESTRICTED is in effect for path<a name="line.171"></a>
<span class="sourceLineNo">172</span> view.setOwner(userPrincipal);<a name="line.172"></a>
<span class="sourceLineNo">173</span> }<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span> if (fileGroup != null) {<a name="line.175"></a>
<span class="sourceLineNo">176</span> final GroupPrincipal groupPrincipal = lookupService.lookupPrincipalByGroupName(fileGroup);<a name="line.176"></a>
<span class="sourceLineNo">177</span> if (groupPrincipal != null) {<a name="line.177"></a>
<span class="sourceLineNo">178</span> // The current user id should be members of this group,<a name="line.178"></a>
<span class="sourceLineNo">179</span> // if not will raise Operation not permitted<a name="line.179"></a>
<span class="sourceLineNo">180</span> view.setGroup(groupPrincipal);<a name="line.180"></a>
<span class="sourceLineNo">181</span> }<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span> if (filePermissions != null) {<a name="line.183"></a>
<span class="sourceLineNo">184</span> view.setPermissions(filePermissions);<a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span> }<a name="line.186"></a>
<span class="sourceLineNo">187</span> }<a name="line.187"></a>
<span class="sourceLineNo">188</span><a name="line.188"></a>
<span class="sourceLineNo">189</span> /**<a name="line.189"></a>
<span class="sourceLineNo">190</span> * Check if posix file attribute view is supported on the default FileSystem.<a name="line.190"></a>
<span class="sourceLineNo">191</span> *<a name="line.191"></a>
<span class="sourceLineNo">192</span> * @return true if posix file attribute view supported, false otherwise<a name="line.192"></a>
<span class="sourceLineNo">193</span> */<a name="line.193"></a>
<span class="sourceLineNo">194</span> public static boolean isFilePosixAttributeViewSupported() {<a name="line.194"></a>
<span class="sourceLineNo">195</span> return FileSystems.getDefault().supportedFileAttributeViews().contains("posix");<a name="line.195"></a>
<span class="sourceLineNo">196</span> }<a name="line.196"></a>
<span class="sourceLineNo">197</span>}<a name="line.197"></a>
</pre>
</div>
</body>
</html>