app/phpmon/Common/Core/Paths.swift

//
//  Paths.swift
//  PHP Monitor
//
//  Copyright © 2023 Nico Verbruggen. All rights reserved.
//

import Foundation

/**
 The `Paths` class is used to locate various binaries on the system.
 The path to the Homebrew directory and the user's name are fetched only once, at boot.
 */
public class Paths {

    public static let shared = Paths()

    internal var baseDir: Paths.HomebrewDir
    private var userName: String
    private var preferredShell: String

    init() {
        // Assume the default directory is correct
        baseDir = App.architecture != "x86_64" ? .opt : .usr

        // Ensure that if a different location is used, it takes precendence
        if baseDir == .usr
            && App.shared.container.filesystem.directoryExists("/usr/local/homebrew")
            && !App.shared.container.filesystem.directoryExists("/usr/local/Cellar") {
            Log.warn("Using /usr/local/homebrew as base directory!")
            baseDir = .usr_hb
        }

        userName = identity()
        preferredShell = preferred_shell()

        if !isRunningSwiftUIPreview {
            Log.info("The current username is `\(userName)`.")
            Log.info("The user's shell is `\(preferredShell)`.")
        }
    }

    public func detectBinaryPaths() {
        detectComposerBinary()
    }

    // - MARK: Binaries

    public static var valet: String {
        return "\(binPath)/valet"
    }

    public static var brew: String {
        return "\(binPath)/brew"
    }

    public static var php: String {
        return "\(binPath)/php"
    }

    public static var phpConfig: String {
        return "\(binPath)/php-config"
    }

    // - MARK: Detected Binaries

    /** The path to the Composer binary. Can be in multiple locations, so is detected instead. */
    public static var composer: String?

    // - MARK: Paths

    public static var whoami: String {
        return shared.userName
    }

    public static var homePath: String {
        if App.shared.container.filesystem is RealFileSystem {
            return NSHomeDirectory()
        }

        if App.shared.container.filesystem is TestableFileSystem {
            let fs = App.shared.container.filesystem as! TestableFileSystem
            return fs.homeDirectory
        }

        fatalError("A valid FileSystem must be allowed to return the home path")
    }

    public static var cellarPath: String {
        return "\(shared.baseDir.rawValue)/Cellar"
    }

    public static var binPath: String {
        return "\(shared.baseDir.rawValue)/bin"
    }

    public static var optPath: String {
        return "\(shared.baseDir.rawValue)/opt"
    }

    public static var etcPath: String {
        return "\(shared.baseDir.rawValue)/etc"
    }

    public static var tapPath: String {
        if shared.baseDir == .usr {
            return "\(shared.baseDir.rawValue)/homebrew/Library/Taps"
        }

        return "\(shared.baseDir.rawValue)/Library/Taps"
    }

    public static var caskroomPath: String {
        return "\(shared.baseDir.rawValue)/Caskroom/phpmon"
    }

    public static var shell: String {
        return shared.preferredShell
    }

    // MARK: - Flexible Binaries
    // (these can be in multiple locations, so we scan common places because)
    // (PHP Monitor will not use the user's own PATH)

    private func detectComposerBinary() {
        if App.shared.container.filesystem.fileExists("/usr/local/bin/composer") {
            Paths.composer = "/usr/local/bin/composer"
        } else if App.shared.container.filesystem.fileExists("/opt/homebrew/bin/composer") {
            Paths.composer = "/opt/homebrew/bin/composer"
        } else if App.shared.container.filesystem.fileExists("/usr/local/homebrew/bin/composer") {
            Paths.composer = "/usr/local/homebrew/bin/composer"
        } else {
            Paths.composer = nil
            Log.warn("Composer was not found.")
        }
    }

    // MARK: - Enum

    public enum HomebrewDir: String {
        case opt = "/opt/homebrew"
        case usr = "/usr/local"
        case usr_hb = "/usr/local/homebrew"
    }

}