View Javadoc

    1   /*
    2    * Licensed to the Apache Software Foundation (ASF) under one or more
    3    * contributor license agreements. See the NOTICE file distributed with
    4    * this work for additional information regarding copyright ownership.
    5    * The ASF licenses this file to You under the Apache license, Version 2.0
    6    * (the "License"); you may not use this file except in compliance with
    7    * the License. You may obtain a copy of the License at
    8    *
    9    *      http://www.apache.org/licenses/LICENSE-2.0
    10   *
    11   * Unless required by applicable law or agreed to in writing, software
    12   * distributed under the License is distributed on an "AS IS" BASIS,
    13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    14   * See the license for the specific language governing permissions and
    15   * limitations under the license.
    16   */
    17  package org.apache.logging.log4j.core.util;
    18
    19  import java.io.File;
    20  import java.io.IOException;
    21  import java.io.UnsupportedEncodingException;
    22  import java.net.MalformedURLException;
    23  import java.net.URI;
    24  import java.net.URISyntaxException;
    25  import java.net.URL;
    26  import java.net.URLDecoder;
    27  import java.util.regex.Pattern;
    28
    29  import org.apache.logging.log4j.Logger;
    30  import org.apache.logging.log4j.status.StatusLogger;
    31
    32  /**
    33   * File utilities.
    34   */
    35  public final class FileUtils {
    36
    37      /** Constant for the file URL protocol.*/
    38      private static final String PROTOCOL_FILE = "file";
    39
    40      private static final String JBOSS_FILE = "vfsfile";
    41
    42      private static final Logger LOGGER = StatusLogger.getLogger();
    43      private static final Pattern WINDOWS_DIRECTORY_SEPARATOR = Pattern.compile("\\\\+");
    44
    45      private FileUtils() {
    46      }
    47
    48        /**
    49       * Tries to convert the specified URI to a file object. If this fails,
    50       * <b>null</b> is returned.
    51       *
    52       * @param uri the URI
    53       * @return the resulting file object
    54       */
    55      public static File fileFromUri(URI uri) {
    56          // There MUST be a better way to do this. TODO Search other ASL projects...
    57          if (uri == null
    58                  || (uri.getScheme() != null && (!PROTOCOL_FILE.equals(uri.getScheme()) && !JBOSS_FILE.equals(uri
    59                          .getScheme())))) {
    60              return null;
    61          }
    62          if (uri.getScheme() == null) {
    63              File file = new File(uri.toString());
    64              if (file.exists()) {
    65                  return file;
    66              }
    67              try {
    68                  final String path = uri.getPath();
    69                  file = new File(path);
    70                  if (file.exists()) {
    71                      return file;
    72                  }
    73                  uri = new File(path).toURI();
    74              } catch (final Exception ex) {
    75                  LOGGER.warn("Invalid URI {}", uri);
    76                  return null;
    77              }
    78          }
    79          final String charsetName = Constants.UTF_8.name();
    80          try {
    81              String fileName = uri.toURL().getFile();
    82              if (new File(fileName).exists()) { // LOG4J2-466
    83                  return new File(fileName); // allow files with '+' char in name
    84              }
    85              fileName = URLDecoder.decode(fileName, charsetName);
    86              return new File(fileName);
    87          } catch (final MalformedURLException ex) {
    88              LOGGER.warn("Invalid URL {}", uri, ex);
    89          } catch (final UnsupportedEncodingException uee) {
    90              LOGGER.warn("Invalid encoding: {}", charsetName, uee);
    91          }
    92          return null;
    93      }
    94
    95      public static boolean isFile(final URL url) {
    96          return url != null && (url.getProtocol().equals(PROTOCOL_FILE) || url.getProtocol().equals(JBOSS_FILE));
    97      }
    98
    99      /**
    100      * Asserts that the given directory exists and creates it if necessary.
    101      * @param dir the directory that shall exist
    102      * @param createDirectoryIfNotExisting specifies if the directory shall be created if it does not exist.
    103      * @throws java.io.IOException thrown if the directory could not be created.
    104      */
    105     public static void mkdir(final File dir, final boolean createDirectoryIfNotExisting ) throws IOException {
    106         // commons io FileUtils.forceMkdir would be useful here, we just want to omit this dependency
    107         if (!dir.exists()) {
    108             if(!createDirectoryIfNotExisting) {
    109                 throw new IOException("The directory " + dir.getAbsolutePath() + " does not exist.");
    110             }
    111             if(!dir.mkdirs()) {
    112                 throw new IOException("Could not create directory " + dir.getAbsolutePath());
    113             }
    114         }
    115         if (!dir.isDirectory()) {
    116             throw new IOException("File " + dir + " exists and is not a directory. Unable to create directory.");
    117         }
    118     }
    119
    120     /**
    121      * Takes a given URI string which may contain backslashes (illegal in URIs) in it due to user input or variable
    122      * substitution and returns a URI with the backslashes replaced with forward slashes.
    123      *
    124      * @param uri The URI string
    125      * @return the URI.
    126      * @throws URISyntaxException if instantiating the URI threw a {@code URISyntaxException}.
    127      */
    128     public static URI getCorrectedFilePathUri(final String uri) throws URISyntaxException {
    129         return new URI(WINDOWS_DIRECTORY_SEPARATOR.matcher(uri).replaceAll("/"));
    130     }
    131 }