path: root/common/path.go

// Copyright 2014 The go-ethereum Authors
// This file is part of the go-ethereum library.
//
// The go-ethereum library is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// The go-ethereum library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.

package common

import (
    "fmt"
    "os"
    "os/user"
    "path/filepath"
    "runtime"
    "strings"

    "github.com/kardianos/osext"
)

// MakeName creates a node name that follows the ethereum convention
// for such names. It adds the operation system name and Go runtime version
// the name.
func MakeName(name, version string) string {
    return fmt.Sprintf("%s/v%s/%s/%s", name, version, runtime.GOOS, runtime.Version())
}

func ExpandHomePath(p string) (path string) {
    path = p
    sep := fmt.Sprintf("%s", os.PathSeparator)

    // Check in case of paths like "/something/~/something/"
    if len(p) > 1 && p[:1+len(sep)] == "~"+sep {
        usr, _ := user.Current()
        dir := usr.HomeDir

        path = strings.Replace(p, "~", dir, 1)
    }

    return
}

func FileExist(filePath string) bool {
    _, err := os.Stat(filePath)
    if err != nil && os.IsNotExist(err) {
        return false
    }

    return true
}

func AbsolutePath(Datadir string, filename string) string {
    if filepath.IsAbs(filename) {
        return filename
    }
    return filepath.Join(Datadir, filename)
}

func DefaultAssetPath() string {
    var assetPath string
    pwd, _ := os.Getwd()
    srcdir := filepath.Join(os.Getenv("GOPATH"), "src", "github.com", "ethereum", "go-ethereum", "cmd", "mist")

    // If the current working directory is the go-ethereum dir
    // assume a debug build and use the source directory as
    // asset directory.
    if pwd == srcdir {
        assetPath = filepath.Join(pwd, "assets")
    } else {
        switch runtime.GOOS {
        case "darwin":
            // Get Binary Directory
            exedir, _ := osext.ExecutableFolder()
            assetPath = filepath.Join(exedir, "..", "Resources")
        case "linux":
            assetPath = filepath.Join("usr", "share", "mist")
        case "windows":
            assetPath = filepath.Join(".", "assets")
        default:
            assetPath = "."
        }
    }

    // Check if the assetPath exists. If not, try the source directory
    // This happens when binary is run from outside cmd/mist directory
    if _, err := os.Stat(assetPath); os.IsNotExist(err) {
        assetPath = filepath.Join(srcdir, "assets")
    }

    return assetPath
}

func DefaultDataDir() string {
    // Try to place the data folder in the user's home dir
    var home string
    if usr, err := user.Current(); err == nil {
        home = usr.HomeDir
    } else {
        home = os.Getenv("HOME")
    }
    if home != "" {
        if runtime.GOOS == "darwin" {
            return filepath.Join(home, "Library", "Ethereum")
        } else if runtime.GOOS == "windows" {
            return filepath.Join(home, "AppData", "Roaming", "Ethereum")
        } else {
            return filepath.Join(home, ".ethereum")
        }
    }
    // As we cannot guess a stable location, return empty and handle later
    return ""
}

func DefaultIpcPath() string {
    if runtime.GOOS == "windows" {
        return `\\.\pipe\geth.ipc`
    }
    return filepath.Join(DefaultDataDir(), "geth.ipc")
}