oh-my-posh/src/platform/shell.go

901 lines
21 KiB
Go
Raw Normal View History

2022-11-09 11:27:54 -08:00
package platform
2019-03-13 04:14:30 -07:00
import (
2021-12-19 07:42:39 -08:00
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
2022-02-25 03:51:38 -08:00
"io"
"io/fs"
"log"
"net/http"
2022-07-17 12:11:23 -07:00
"net/http/httputil"
2022-11-09 11:27:54 -08:00
"oh-my-posh/platform/battery"
"oh-my-posh/platform/cmd"
"oh-my-posh/regex"
2019-03-13 04:14:30 -07:00
"os"
"os/exec"
2020-10-01 11:57:02 -07:00
"path/filepath"
2019-03-13 04:14:30 -07:00
"runtime"
"strconv"
2019-03-13 04:14:30 -07:00
"strings"
"sync"
"time"
2019-03-13 04:14:30 -07:00
process "github.com/shirou/gopsutil/v3/process"
"golang.org/x/text/cases"
"golang.org/x/text/language"
2019-03-13 04:14:30 -07:00
)
const (
2022-08-02 22:25:59 -07:00
UNKNOWN = "unknown"
WINDOWS = "windows"
DARWIN = "darwin"
LINUX = "linux"
)
func getPID() string {
pid := os.Getenv("POSH_PID")
if len(pid) == 0 {
pid = strconv.Itoa(os.Getppid())
}
return pid
}
var (
lock = sync.RWMutex{}
TEMPLATECACHE = fmt.Sprintf("template_cache_%s", getPID())
TOGGLECACHE = fmt.Sprintf("toggle_cache_%s", getPID())
)
2022-03-12 13:04:08 -08:00
type Flags struct {
ErrorCode int
Config string
Shell string
ShellVersion string
2022-03-12 13:04:08 -08:00
PWD string
PSWD string
ExecutionTime float64
Eval bool
StackCount int
Migrate bool
TerminalWidth int
Strict bool
Debug bool
Manual bool
}
type CommandError struct {
Err string
ExitCode int
}
func (e *CommandError) Error() string {
return e.Err
}
type FileInfo struct {
ParentFolder string
Path string
IsDir bool
}
type Cache interface {
Init(home string)
Close()
Get(key string) (string, bool)
// ttl in minutes
Set(key, value string, ttl int)
2021-09-21 11:22:59 -07:00
}
2021-12-14 23:49:32 -08:00
type HTTPRequestModifier func(request *http.Request)
2022-06-01 00:50:20 -07:00
type WindowsRegistryValueType string
const (
2022-06-01 00:50:20 -07:00
DWORD = "DWORD"
QWORD = "QWORD"
BINARY = "BINARY"
STRING = "STRING"
)
type WindowsRegistryValue struct {
ValueType WindowsRegistryValueType
2022-06-01 00:50:20 -07:00
DWord uint64
QWord uint64
String string
}
type NotImplemented struct{}
func (n *NotImplemented) Error() string {
return "not implemented"
}
type ConnectionType string
const (
ETHERNET ConnectionType = "ethernet"
WIFI ConnectionType = "wifi"
CELLULAR ConnectionType = "cellular"
BLUETOOTH ConnectionType = "bluetooth"
)
type Connection struct {
Name string
Type ConnectionType
TransmitRate uint64
ReceiveRate uint64
SSID string // Wi-Fi only
}
type SegmentsCache map[string]interface{}
func (c *SegmentsCache) Contains(key string) bool {
_, ok := (*c)[key]
return ok
}
type TemplateCache struct {
Root bool
PWD string
Folder string
Shell string
ShellVersion string
UserName string
HostName string
Code int
Env map[string]string
OS string
WSL bool
Segments SegmentsCache
}
func (t *TemplateCache) AddSegmentData(key string, value interface{}) {
lock.Lock()
defer lock.Unlock()
if t.Segments == nil {
t.Segments = make(map[string]interface{})
}
key = cases.Title(language.English).String(key)
t.Segments[key] = value
}
2022-01-01 11:09:52 -08:00
type Environment interface {
Getenv(key string) string
Pwd() string
Home() string
User() string
Root() bool
Host() (string, error)
GOOS() string
Shell() string
Platform() string
ErrorCode() int
2022-02-19 10:04:06 -08:00
PathSeparator() string
HasFiles(pattern string) bool
HasFilesInDir(dir, pattern string) bool
HasFolder(folder string) bool
HasParentFilePath(path string) (fileInfo *FileInfo, err error)
2022-02-13 23:41:33 -08:00
HasFileInParentDirs(pattern string, depth uint) bool
ResolveSymlink(path string) (string, error)
DirMatchesOneOf(dir string, regexes []string) bool
DirIsWritable(path string) bool
CommandPath(command string) string
HasCommand(command string) bool
FileContent(file string) string
LsDir(path string) []fs.DirEntry
RunCommand(command string, args ...string) (string, error)
RunShellCommand(shell, command string) string
ExecutionTime() float64
2022-03-12 13:04:08 -08:00
Flags() *Flags
BatteryState() (*battery.Info, error)
QueryWindowTitles(processName, windowTitleRegex string) (string, error)
WindowsRegistryKeyValue(path string) (*WindowsRegistryValue, error)
2022-07-17 12:11:23 -07:00
HTTPRequest(url string, body io.Reader, timeout int, requestModifiers ...HTTPRequestModifier) ([]byte, error)
IsWsl() bool
IsWsl2() bool
StackCount() int
TerminalWidth() (int, error)
CachePath() string
Cache() Cache
Close()
Logs() string
InWSLSharedDrive() bool
ConvertToLinuxPath(path string) string
ConvertToWindowsPath(path string) string
Connection(connectionType ConnectionType) (*Connection, error)
TemplateCache() *TemplateCache
LoadTemplateCache()
Log(logType LogType, funcName, message string)
2022-05-07 07:43:24 -07:00
Trace(start time.Time, function string, args ...string)
2019-03-13 04:14:30 -07:00
}
type commandCache struct {
commands *concurrentMap
}
func (c *commandCache) set(command, path string) {
c.commands.set(command, path)
}
func (c *commandCache) get(command string) (string, bool) {
cacheCommand, found := c.commands.get(command)
2021-09-21 22:53:59 -07:00
if !found {
return "", false
}
command, ok := cacheCommand.(string)
2021-09-23 13:57:38 -07:00
return command, ok
}
type LogType string
const (
Error LogType = "error"
Debug LogType = "debug"
)
2022-11-09 11:27:54 -08:00
type Shell struct {
CmdFlags *Flags
Version string
2022-01-18 00:48:47 -08:00
cwd string
cmdCache *commandCache
fileCache *fileCache
tmplCache *TemplateCache
2022-01-18 00:48:47 -08:00
logBuilder strings.Builder
networks []*Connection
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Init() {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Init")
2022-03-12 13:04:08 -08:00
if env.CmdFlags == nil {
env.CmdFlags = &Flags{}
}
if env.CmdFlags.Debug {
log.SetOutput(&env.logBuilder)
}
2022-01-18 12:25:18 -08:00
env.fileCache = &fileCache{}
env.fileCache.Init(env.CachePath())
env.resolveConfigPath()
2021-11-16 22:16:43 -08:00
env.cmdCache = &commandCache{
commands: newConcurrentMap(),
}
}
2022-11-09 11:27:54 -08:00
func (env *Shell) resolveConfigPath() {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "resolveConfigPath")
if len(env.CmdFlags.Config) == 0 {
env.CmdFlags.Config = env.Getenv("POSH_THEME")
2022-02-25 03:51:38 -08:00
}
if len(env.CmdFlags.Config) == 0 {
2022-10-12 05:59:37 -07:00
return
}
if strings.HasPrefix(env.CmdFlags.Config, "https://") {
if err := env.downloadConfig(env.CmdFlags.Config); err != nil {
// make it use default config when download fails
env.CmdFlags.Config = ""
return
}
2022-02-25 03:51:38 -08:00
}
2022-01-13 23:39:08 -08:00
// Cygwin path always needs the full path as we're on Windows but not really.
// Doing filepath actions will convert it to a Windows path and break the init script.
2022-08-02 22:25:59 -07:00
if env.Platform() == WINDOWS && env.Shell() == "bash" {
2022-01-13 23:39:08 -08:00
return
}
2022-03-12 13:04:08 -08:00
configFile := env.CmdFlags.Config
if strings.HasPrefix(configFile, "~") {
configFile = strings.TrimPrefix(configFile, "~")
configFile = filepath.Join(env.Home(), configFile)
}
if !filepath.IsAbs(configFile) {
2022-11-02 03:48:19 -07:00
configFile = filepath.Join(env.Pwd(), configFile)
}
2022-03-12 13:04:08 -08:00
env.CmdFlags.Config = filepath.Clean(configFile)
}
2022-11-09 11:27:54 -08:00
func (env *Shell) downloadConfig(location string) error {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "downloadConfig", location)
configPath := filepath.Join(env.CachePath(), "config.omp.json")
2022-07-17 12:11:23 -07:00
cfg, err := env.HTTPRequest(location, nil, 5000)
if err != nil {
return err
}
out, err := os.Create(configPath)
if err != nil {
return err
}
defer out.Close()
_, err = io.Copy(out, bytes.NewReader(cfg))
if err != nil {
return err
}
env.CmdFlags.Config = configPath
return nil
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Trace(start time.Time, function string, args ...string) {
if env.CmdFlags == nil || !env.CmdFlags.Debug {
return
}
elapsed := time.Since(start)
2021-08-04 03:52:54 -07:00
trace := fmt.Sprintf("%s duration: %s, args: %s", function, elapsed, strings.Trim(fmt.Sprint(args), "[]"))
log.Println(trace)
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Log(logType LogType, funcName, message string) {
if !env.CmdFlags.Debug {
return
}
trace := fmt.Sprintf("%s: %s\n%s", logType, funcName, message)
log.Println(trace)
}
2022-11-09 11:27:54 -08:00
func (env *Shell) debugF(function string, fn func() string) {
if !env.CmdFlags.Debug {
return
}
trace := fmt.Sprintf("%s: %s\n%s", Debug, function, fn())
log.Println(trace)
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Getenv(key string) string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Getenv", key)
val := os.Getenv(key)
env.Log(Debug, "Getenv", val)
return val
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Pwd() string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Pwd")
lock.Lock()
defer func() {
lock.Unlock()
env.Log(Debug, "Pwd", env.cwd)
}()
2020-10-12 00:04:37 -07:00
if env.cwd != "" {
return env.cwd
}
correctPath := func(pwd string) string {
if env.GOOS() != WINDOWS {
return pwd
2022-10-03 07:46:16 -07:00
}
// on Windows, and being case sensitive and not consistent and all, this gives silly issues
driveLetter := regex.GetCompiledRegex(`^[a-z]:`)
return driveLetter.ReplaceAllStringFunc(pwd, strings.ToUpper)
}
2022-03-12 13:04:08 -08:00
if env.CmdFlags != nil && env.CmdFlags.PWD != "" {
env.cwd = correctPath(env.CmdFlags.PWD)
2020-10-12 00:04:37 -07:00
return env.cwd
}
dir, err := os.Getwd()
if err != nil {
env.Log(Error, "Pwd", err.Error())
return ""
}
2020-10-12 00:04:37 -07:00
env.cwd = correctPath(dir)
return env.cwd
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasFiles(pattern string) bool {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HasFiles", pattern)
cwd := env.Pwd()
2022-11-02 07:04:20 -07:00
fileSystem := os.DirFS(cwd)
matches, err := fs.Glob(fileSystem, pattern)
2020-10-01 11:57:02 -07:00
if err != nil {
env.Log(Error, "HasFiles", err.Error())
2020-10-01 11:57:02 -07:00
return false
}
for _, match := range matches {
2022-11-02 07:04:20 -07:00
file, err := fs.Stat(fileSystem, match)
if err != nil || file.IsDir() {
continue
}
return true
}
return false
2020-10-01 11:57:02 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasFilesInDir(dir, pattern string) bool {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HasFilesInDir", pattern)
2022-11-02 07:04:20 -07:00
fileSystem := os.DirFS(dir)
matches, err := fs.Glob(fileSystem, pattern)
if err != nil {
env.Log(Error, "HasFilesInDir", err.Error())
return false
}
hasFilesInDir := len(matches) > 0
env.debugF("HasFilesInDir", func() string { return strconv.FormatBool(hasFilesInDir) })
return hasFilesInDir
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasFileInParentDirs(pattern string, depth uint) bool {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HasFileInParent", pattern, fmt.Sprint(depth))
2022-02-13 23:41:33 -08:00
currentFolder := env.Pwd()
for c := 0; c < int(depth); c++ {
if env.HasFilesInDir(currentFolder, pattern) {
env.Log(Debug, "HasFileInParentDirs", "true")
2022-02-13 23:41:33 -08:00
return true
}
if dir := filepath.Dir(currentFolder); dir != currentFolder {
currentFolder = dir
} else {
env.Log(Debug, "HasFileInParentDirs", "false")
2022-02-13 23:41:33 -08:00
return false
}
}
env.Log(Debug, "HasFileInParentDirs", "false")
2022-02-13 23:41:33 -08:00
return false
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasFolder(folder string) bool {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HasFolder", folder)
f, err := os.Stat(folder)
if err != nil {
env.Log(Debug, "HasFolder", "false")
return false
}
env.debugF("HasFolder", func() string { return strconv.FormatBool(f.IsDir()) })
return f.IsDir()
2020-10-07 04:32:42 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) ResolveSymlink(path string) (string, error) {
defer env.Trace(time.Now(), "ResolveSymlink", path)
link, err := filepath.EvalSymlinks(path)
if err != nil {
env.Log(Error, "ResolveSymlink", err.Error())
return "", err
}
env.Log(Debug, "ResolveSymlink", link)
return link, nil
}
2022-11-09 11:27:54 -08:00
func (env *Shell) FileContent(file string) string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "FileContent", file)
if !filepath.IsAbs(file) {
file = filepath.Join(env.Pwd(), file)
}
2022-06-01 00:50:20 -07:00
content, err := os.ReadFile(file)
2020-10-07 04:32:42 -07:00
if err != nil {
env.Log(Error, "FileContent", err.Error())
2020-10-07 04:32:42 -07:00
return ""
}
fileContent := string(content)
env.Log(Debug, "FileContent", fileContent)
return fileContent
2020-10-07 04:32:42 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) LsDir(path string) []fs.DirEntry {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "LsDir", path)
entries, err := os.ReadDir(path)
if err != nil {
env.Log(Error, "LsDir", err.Error())
return nil
}
env.debugF("LsDir", func() string {
var entriesStr string
for _, entry := range entries {
entriesStr += entry.Name() + "\n"
}
return entriesStr
})
return entries
}
2022-11-09 11:27:54 -08:00
func (env *Shell) PathSeparator() string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "PathSeparator")
2019-03-13 04:14:30 -07:00
return string(os.PathSeparator)
}
2022-11-09 11:27:54 -08:00
func (env *Shell) User() string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "User")
user := os.Getenv("USER")
if user == "" {
user = os.Getenv("USERNAME")
}
env.Log(Debug, "User", user)
return user
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Host() (string, error) {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Host")
2019-03-13 04:14:30 -07:00
hostName, err := os.Hostname()
if err != nil {
env.Log(Error, "Host", err.Error())
2019-03-13 04:14:30 -07:00
return "", err
}
hostName = cleanHostName(hostName)
env.Log(Debug, "Host", hostName)
return hostName, nil
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) GOOS() string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "GOOS")
2019-03-13 04:14:30 -07:00
return runtime.GOOS
}
2022-11-09 11:27:54 -08:00
func (env *Shell) RunCommand(command string, args ...string) (string, error) {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "RunCommand", append([]string{command}, args...)...)
if cacheCommand, ok := env.cmdCache.get(command); ok {
command = cacheCommand
}
output, err := cmd.Run(command, args...)
if err != nil {
env.Log(Error, "RunCommand", "cmd.Run() failed")
}
env.Log(Debug, "RunCommand", output)
return output, err
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) RunShellCommand(shell, command string) string {
defer env.Trace(time.Now(), "RunShellCommand")
if out, err := env.RunCommand(shell, "-c", command); err == nil {
return out
}
return ""
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) CommandPath(command string) string {
defer env.Trace(time.Now(), "CommandPath", command)
if path, ok := env.cmdCache.get(command); ok {
env.Log(Debug, "CommandPath", path)
return path
}
path, err := exec.LookPath(command)
if err == nil {
env.cmdCache.set(command, path)
env.Log(Debug, "CommandPath", path)
return path
}
path, err = env.LookWinAppPath(command)
if err == nil {
env.cmdCache.set(command, path)
env.Log(Debug, "CommandPath", path)
return path
}
env.Log(Error, "CommandPath", err.Error())
return ""
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasCommand(command string) bool {
defer env.Trace(time.Now(), "HasCommand", command)
if path := env.CommandPath(command); path != "" {
return true
}
return false
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) ErrorCode() int {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "ErrorCode")
2022-03-12 13:04:08 -08:00
return env.CmdFlags.ErrorCode
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) ExecutionTime() float64 {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "ExecutionTime")
2022-03-12 13:04:08 -08:00
if env.CmdFlags.ExecutionTime < 0 {
return 0
}
2022-03-12 13:04:08 -08:00
return env.CmdFlags.ExecutionTime
2020-12-06 13:03:40 -08:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Flags() *Flags {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Flags")
2022-03-12 13:04:08 -08:00
return env.CmdFlags
2019-03-13 04:14:30 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Shell() string {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "Shell")
2022-03-12 13:04:08 -08:00
if env.CmdFlags.Shell != "" {
return env.CmdFlags.Shell
2020-12-27 05:59:40 -08:00
}
2020-09-15 04:44:53 -07:00
pid := os.Getppid()
2020-10-23 07:36:40 -07:00
p, _ := process.NewProcess(int32(pid))
name, err := p.Name()
2020-09-24 10:11:56 -07:00
if err != nil {
env.Log(Error, "Shell", err.Error())
2022-08-02 22:25:59 -07:00
return UNKNOWN
2020-09-24 10:11:56 -07:00
}
env.Log(Debug, "Shell", "process name: "+name)
// this is used for when scoop creates a shim, see
// https://github.com/JanDeDobbeleer/oh-my-posh/issues/2806
executable, _ := os.Executable()
if name == "cmd.exe" || name == executable {
p, _ = p.Parent()
name, err = p.Name()
env.Log(Debug, "Shell", "parent process name: "+name)
}
if err != nil {
env.Log(Error, "Shell", err.Error())
2022-08-02 22:25:59 -07:00
return UNKNOWN
}
// Cache the shell value to speed things up.
env.CmdFlags.Shell = strings.Trim(strings.TrimSuffix(name, ".exe"), " ")
2022-03-12 13:04:08 -08:00
return env.CmdFlags.Shell
2020-09-15 04:44:53 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) unWrapError(err error) error {
2022-08-03 22:06:55 -07:00
cause := err
for {
type nested interface{ Unwrap() error }
unwrap, ok := cause.(nested)
if !ok {
break
}
cause = unwrap.Unwrap()
}
return cause
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HTTPRequest(targetURL string, body io.Reader, timeout int, requestModifiers ...HTTPRequestModifier) ([]byte, error) {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HTTPRequest", targetURL)
ctx, cncl := context.WithTimeout(context.Background(), time.Millisecond*time.Duration(timeout))
defer cncl()
2022-07-17 12:11:23 -07:00
request, err := http.NewRequestWithContext(ctx, http.MethodGet, targetURL, body)
if err != nil {
return nil, err
}
2021-12-14 23:49:32 -08:00
for _, modifier := range requestModifiers {
modifier(request)
}
2022-07-17 12:11:23 -07:00
if env.CmdFlags.Debug {
dump, _ := httputil.DumpRequestOut(request, true)
env.Log(Debug, "HTTPRequest", string(dump))
}
response, err := client.Do(request)
if err != nil {
env.Log(Error, "HTTPRequest", err.Error())
2022-08-03 22:06:55 -07:00
return nil, env.unWrapError(err)
}
// anything inside the range [200, 299] is considered a success
if response.StatusCode < 200 || response.StatusCode >= 300 {
message := "HTTP status code " + strconv.Itoa(response.StatusCode)
err := errors.New(message)
env.Log(Error, "HTTPRequest", message)
return nil, err
}
defer response.Body.Close()
2022-07-17 12:11:23 -07:00
responseBody, err := io.ReadAll(response.Body)
if err != nil {
env.Log(Error, "HTTPRequest", err.Error())
return nil, err
}
2022-07-17 12:11:23 -07:00
env.Log(Debug, "HTTPRequest", string(responseBody))
return responseBody, nil
}
2022-11-09 11:27:54 -08:00
func (env *Shell) HasParentFilePath(path string) (*FileInfo, error) {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "HasParentFilePath", path)
currentFolder := env.Pwd()
for {
fileSystem := os.DirFS(currentFolder)
info, err := fs.Stat(fileSystem, path)
if err == nil {
return &FileInfo{
ParentFolder: currentFolder,
Path: filepath.Join(currentFolder, path),
IsDir: info.IsDir(),
}, nil
}
if !os.IsNotExist(err) {
return nil, err
}
if dir := filepath.Dir(currentFolder); dir != currentFolder {
currentFolder = dir
continue
}
env.Log(Error, "HasParentFilePath", err.Error())
return nil, errors.New("no match at root level")
}
}
2022-11-09 11:27:54 -08:00
func (env *Shell) StackCount() int {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "StackCount")
2022-03-12 13:04:08 -08:00
if env.CmdFlags.StackCount < 0 {
return 0
}
2022-03-12 13:04:08 -08:00
return env.CmdFlags.StackCount
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Cache() Cache {
2021-09-21 11:22:59 -07:00
return env.fileCache
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Close() {
defer env.Trace(time.Now(), "Close")
templateCache, err := json.Marshal(env.TemplateCache())
if err == nil {
env.fileCache.Set(TEMPLATECACHE, string(templateCache), 1440)
}
env.fileCache.Close()
}
2022-11-09 11:27:54 -08:00
func (env *Shell) LoadTemplateCache() {
defer env.Trace(time.Now(), "LoadTemplateCache")
val, OK := env.fileCache.Get(TEMPLATECACHE)
if !OK {
return
}
var templateCache TemplateCache
err := json.Unmarshal([]byte(val), &templateCache)
if err != nil {
env.Log(Error, "LoadTemplateCache", err.Error())
return
}
env.tmplCache = &templateCache
}
2022-11-09 11:27:54 -08:00
func (env *Shell) Logs() string {
2021-11-16 22:16:43 -08:00
return env.logBuilder.String()
2021-09-21 11:22:59 -07:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) TemplateCache() *TemplateCache {
2022-05-07 07:43:24 -07:00
defer env.Trace(time.Now(), "TemplateCache")
2022-01-18 00:48:47 -08:00
if env.tmplCache != nil {
return env.tmplCache
}
tmplCache := &TemplateCache{
Root: env.Root(),
Shell: env.Shell(),
ShellVersion: env.CmdFlags.ShellVersion,
Code: env.ErrorCode(),
WSL: env.IsWsl(),
2022-01-18 00:48:47 -08:00
}
tmplCache.Env = make(map[string]string)
2022-01-18 00:48:47 -08:00
const separator = "="
values := os.Environ()
for value := range values {
splitted := strings.Split(values[value], separator)
if len(splitted) != 2 {
continue
}
key := splitted[0]
val := splitted[1:]
tmplCache.Env[key] = strings.Join(val, separator)
2022-01-18 00:48:47 -08:00
}
2022-08-31 02:55:23 -07:00
pwd := env.Pwd()
tmplCache.PWD = ReplaceHomeDirPrefixWithTilde(env, pwd)
2022-08-31 02:55:23 -07:00
tmplCache.Folder = Base(env, pwd)
2022-10-03 07:46:16 -07:00
if env.GOOS() == WINDOWS && strings.HasSuffix(tmplCache.Folder, ":") {
tmplCache.Folder += `\`
}
tmplCache.UserName = env.User()
if host, err := env.Host(); err == nil {
tmplCache.HostName = host
2022-01-18 00:48:47 -08:00
}
goos := env.GOOS()
tmplCache.OS = goos
2022-08-02 22:25:59 -07:00
if goos == LINUX {
tmplCache.OS = env.Platform()
}
env.tmplCache = tmplCache
return tmplCache
2022-01-18 00:48:47 -08:00
}
2022-11-09 11:27:54 -08:00
func (env *Shell) DirMatchesOneOf(dir string, regexes []string) (match bool) {
lock.Lock()
defer lock.Unlock()
// sometimes the function panics inside golang, we want to silence that error
// and assume that there's no match. Not perfect, but better than crashing
// for the time being until we figure out what the actual root cause is
defer func() {
if err := recover(); err != nil {
message := fmt.Sprintf("%s", err)
env.Log(Error, "DirMatchesOneOf", message)
match = false
}
}()
match = dirMatchesOneOf(dir, env.Home(), env.GOOS(), regexes)
return
}
func dirMatchesOneOf(dir, home, goos string, regexes []string) bool {
2022-10-03 07:46:16 -07:00
if goos == WINDOWS {
dir = strings.ReplaceAll(dir, "\\", "/")
home = strings.ReplaceAll(home, "\\", "/")
}
for _, element := range regexes {
normalizedElement := strings.ReplaceAll(element, "\\\\", "/")
if strings.HasPrefix(normalizedElement, "~") {
2022-10-03 07:46:16 -07:00
normalizedElement = strings.Replace(normalizedElement, "~", home, 1)
}
pattern := fmt.Sprintf("^%s$", normalizedElement)
2022-08-02 22:25:59 -07:00
if goos == WINDOWS || goos == DARWIN {
pattern = "(?i)" + pattern
}
2022-10-03 07:46:16 -07:00
matched := regex.MatchString(pattern, dir)
if matched {
return true
}
}
return false
}
2022-10-03 07:46:16 -07:00
func IsPathSeparator(env Environment, c uint8) bool {
if c == '/' {
return true
}
if env.GOOS() == WINDOWS && c == '\\' {
return true
}
return false
}
// Base returns the last element of path.
// Trailing path separators are removed before extracting the last element.
// If the path consists entirely of separators, Base returns a single separator.
func Base(env Environment, path string) string {
volumeName := filepath.VolumeName(path)
// Strip trailing slashes.
2022-10-03 07:46:16 -07:00
for len(path) > 0 && IsPathSeparator(env, path[len(path)-1]) {
path = path[0 : len(path)-1]
}
2022-10-03 07:46:16 -07:00
if len(path) == 0 {
return env.PathSeparator()
}
if volumeName == path {
return path
}
// Throw away volume name
path = path[len(filepath.VolumeName(path)):]
// Find the last element
i := len(path) - 1
2022-10-03 07:46:16 -07:00
for i >= 0 && !IsPathSeparator(env, path[i]) {
i--
}
if i >= 0 {
path = path[i+1:]
}
// If empty now, it had only slashes.
2022-10-03 07:46:16 -07:00
if len(path) == 0 {
2022-02-19 10:04:06 -08:00
return env.PathSeparator()
}
return path
}
func ReplaceHomeDirPrefixWithTilde(env Environment, path string) string {
2022-10-03 07:46:16 -07:00
home := env.Home()
// match Home directory exactly
if !strings.HasPrefix(path, home) {
return path
}
rem := path[len(home):]
if len(rem) == 0 || IsPathSeparator(env, rem[0]) {
return "~" + rem
}
return path
}
2019-03-13 04:14:30 -07:00
func cleanHostName(hostName string) string {
garbage := []string{
".lan",
".local",
".localdomain",
2019-03-13 04:14:30 -07:00
}
for _, g := range garbage {
if strings.HasSuffix(hostName, g) {
hostName = strings.Replace(hostName, g, "", 1)
}
2019-03-13 04:14:30 -07:00
}
return hostName
}
func returnOrBuildCachePath(path string) string {
// validate root path
if _, err := os.Stat(path); err != nil {
return ""
}
// validate oh-my-posh folder, if non existent, create it
2022-02-28 03:55:16 -08:00
cachePath := filepath.Join(path, "oh-my-posh")
if _, err := os.Stat(cachePath); err == nil {
return cachePath
}
if err := os.Mkdir(cachePath, 0755); err != nil {
return ""
}
return cachePath
}