xref: /OpenGrok/opengrok-web/src/main/java/org/opengrok/web/util/FileUtil.java (revision 2f9f7cb19c29465cddb70d5a53303cc3e3061788)

/*
 * CDDL HEADER START
 *
 * The contents of this file are subject to the terms of the
 * Common Development and Distribution License (the "License").
 * You may not use this file except in compliance with the License.
 *
 * See LICENSE.txt included in this distribution for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing Covered Code, include this CDDL HEADER in each
 * file and include the License file at LICENSE.txt.
 * If applicable, add the following below this CDDL HEADER, with the
 * fields enclosed by brackets "[]" replaced with your own identifying
 * information: Portions Copyright [yyyy] [name of copyright owner]
 *
 * CDDL HEADER END
 */

/*
 * Copyright (c) 2020, 2021, Oracle and/or its affiliates. All rights reserved.
 */
package org.opengrok.web.util;

import org.opengrok.indexer.configuration.RuntimeEnvironment;

import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.nio.file.InvalidPathException;

public class FileUtil {

    private static final RuntimeEnvironment env = RuntimeEnvironment.getInstance();

    // private to enforce static
    private FileUtil() {
    }

    /**
     * @param path path relative to source root
     * @return file object corresponding to the file under source root
     * @throws FileNotFoundException if the file constructed from the {@code path} parameter and source root
     * does not exist
     * @throws InvalidPathException if the file constructed from the {@code path} parameter and source root
     * leads outside source root
     * @throws NoPathParameterException if the {@code path} parameter is null
     */
    @SuppressWarnings("lgtm[java/path-injection]")
    public static File toFile(String path) throws NoPathParameterException, IOException {
        if (path == null) {
            throw new NoPathParameterException("Missing path parameter");
        }

        File file = new File(env.getSourceRootFile(), path);

        if (!file.getCanonicalPath().startsWith(env.getSourceRootPath() + File.separator)) {
            throw new InvalidPathException(path, "File points to outside of source root");
        }

        if (!file.exists()) {
            throw new FileNotFoundException("File " + file + " not found");
        }

        return file;
    }
}