org.openqa.selenium.os.ExecutableFinder.java Source code

Introduction

Here is the source code for org.openqa.selenium.os.ExecutableFinder.java

Source

// Licensed to the Software Freedom Conservancy (SFC) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The SFC licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

package org.openqa.selenium.os;

import static org.openqa.selenium.Platform.WINDOWS;

import com.google.common.collect.ImmutableSet;

import org.openqa.selenium.Platform;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.util.Map;

public class ExecutableFinder {
    private static final ImmutableSet<String> ENDINGS = Platform.getCurrent().is(WINDOWS)
            ? ImmutableSet.of("", ".cmd", ".exe", ".com", ".bat")
            : ImmutableSet.of("");

    private final ImmutableSet.Builder<String> pathSegmentBuilder = new ImmutableSet.Builder<>();

    /**
     * Find the executable by scanning the file system and the PATH. In the case of Windows this
     * method allows common executable endings (".com", ".bat" and ".exe") to be omitted.
     *
     * @param named The name of the executable to find
     * @return The absolute path to the executable, or null if no match is made.
     */
    public String find(String named) {
        File file = new File(named);
        if (canExecute(file)) {
            return named;
        }

        if (Platform.getCurrent().is(Platform.WINDOWS)) {
            file = new File(named + ".exe");
            if (canExecute(file)) {
                return named + ".exe";
            }
        }

        addPathFromEnvironment();
        if (Platform.getCurrent().is(Platform.MAC)) {
            addMacSpecificPath();
        }

        for (String pathSegment : pathSegmentBuilder.build()) {
            for (String ending : ENDINGS) {
                file = new File(pathSegment, named + ending);
                if (canExecute(file)) {
                    return file.getAbsolutePath();
                }
            }
        }
        return null;
    }

    private void addPathFromEnvironment() {
        String pathName = "PATH";
        Map<String, String> env = System.getenv();
        if (!env.containsKey(pathName)) {
            for (String key : env.keySet()) {
                if (pathName.equalsIgnoreCase(key)) {
                    pathName = key;
                    break;
                }
            }
        }
        String path = env.get(pathName);
        if (path != null) {
            pathSegmentBuilder.add(path.split(File.pathSeparator));
        }
    }

    private void addMacSpecificPath() {
        File pathFile = new File("/etc/paths");
        if (pathFile.exists()) {
            try {
                pathSegmentBuilder.addAll(Files.readAllLines(pathFile.toPath()));
            } catch (IOException e) {
                // Guess we won't include those, then
            }
        }
    }

    private static boolean canExecute(File file) {
        return file.exists() && !file.isDirectory() && file.canExecute();
    }
}