001    /*
002     * SonarQube, open source software quality management tool.
003     * Copyright (C) 2008-2014 SonarSource
004     * mailto:contact AT sonarsource DOT com
005     *
006     * SonarQube is free software; you can redistribute it and/or
007     * modify it under the terms of the GNU Lesser General Public
008     * License as published by the Free Software Foundation; either
009     * version 3 of the License, or (at your option) any later version.
010     *
011     * SonarQube is distributed in the hope that it will be useful,
012     * but WITHOUT ANY WARRANTY; without even the implied warranty of
013     * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014     * Lesser General Public License for more details.
015     *
016     * You should have received a copy of the GNU Lesser General Public License
017     * along with this program; if not, write to the Free Software Foundation,
018     * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
019     */
020    package org.sonar.api.utils;
021    
022    import org.apache.commons.io.FilenameUtils;
023    
024    import javax.annotation.Nullable;
025    import java.io.File;
026    import java.io.IOException;
027    
028    /**
029     * @since 4.0
030     */
031    public class PathUtils {
032    
033      PathUtils() {
034        // only static methods
035      }
036    
037      /**
038       * Normalize path and replace file separators by forward slash
039       */
040      public static String sanitize(@Nullable String path) {
041        return FilenameUtils.normalize(path, true);
042      }
043    
044      /**
045       * Get canonical path and replace file separators by forward slash. This
046       * method does not throw boring checked exception.
047       */
048      public static String canonicalPath(@Nullable File file) {
049        try {
050          return file != null ? FilenameUtils.separatorsToUnix(file.getCanonicalPath()) : null;
051        } catch (IOException e) {
052          throw new IllegalStateException("Fail to get the canonical path of " + file.getAbsolutePath(), e);
053        }
054      }
055    }