2018-09-05 20:46:10 +00:00
/ *
Copyright 2016 The Kubernetes Authors .
Licensed 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 homedir
import (
"os"
2020-05-04 14:59:48 +00:00
"path/filepath"
2018-09-05 20:46:10 +00:00
"runtime"
)
2020-05-04 14:59:48 +00:00
// HomeDir returns the home directory for the current user.
// On Windows:
// 1. the first of %HOME%, %HOMEDRIVE%%HOMEPATH%, %USERPROFILE% containing a `.kube\config` file is returned.
// 2. if none of those locations contain a `.kube\config` file, the first of %HOME%, %USERPROFILE%, %HOMEDRIVE%%HOMEPATH% that exists and is writeable is returned.
// 3. if none of those locations are writeable, the first of %HOME%, %USERPROFILE%, %HOMEDRIVE%%HOMEPATH% that exists is returned.
// 4. if none of those locations exists, the first of %HOME%, %USERPROFILE%, %HOMEDRIVE%%HOMEPATH% that is set is returned.
2018-09-05 20:46:10 +00:00
func HomeDir ( ) string {
if runtime . GOOS == "windows" {
2020-05-04 14:59:48 +00:00
home := os . Getenv ( "HOME" )
homeDriveHomePath := ""
if homeDrive , homePath := os . Getenv ( "HOMEDRIVE" ) , os . Getenv ( "HOMEPATH" ) ; len ( homeDrive ) > 0 && len ( homePath ) > 0 {
homeDriveHomePath = homeDrive + homePath
}
userProfile := os . Getenv ( "USERPROFILE" )
2018-09-05 20:46:10 +00:00
2020-05-04 14:59:48 +00:00
// Return first of %HOME%, %HOMEDRIVE%/%HOMEPATH%, %USERPROFILE% that contains a `.kube\config` file.
// %HOMEDRIVE%/%HOMEPATH% is preferred over %USERPROFILE% for backwards-compatibility.
for _ , p := range [ ] string { home , homeDriveHomePath , userProfile } {
if len ( p ) == 0 {
continue
2018-09-05 20:46:10 +00:00
}
2020-05-04 14:59:48 +00:00
if _ , err := os . Stat ( filepath . Join ( p , ".kube" , "config" ) ) ; err != nil {
continue
2018-09-05 20:46:10 +00:00
}
2020-05-04 14:59:48 +00:00
return p
2018-09-05 20:46:10 +00:00
}
2020-05-04 14:59:48 +00:00
firstSetPath := ""
firstExistingPath := ""
// Prefer %USERPROFILE% over %HOMEDRIVE%/%HOMEPATH% for compatibility with other auth-writing tools
for _ , p := range [ ] string { home , userProfile , homeDriveHomePath } {
if len ( p ) == 0 {
continue
}
if len ( firstSetPath ) == 0 {
// remember the first path that is set
firstSetPath = p
}
info , err := os . Stat ( p )
if err != nil {
continue
2018-09-05 20:46:10 +00:00
}
2020-05-04 14:59:48 +00:00
if len ( firstExistingPath ) == 0 {
// remember the first path that exists
firstExistingPath = p
}
if info . IsDir ( ) && info . Mode ( ) . Perm ( ) & ( 1 << ( uint ( 7 ) ) ) != 0 {
// return first path that is writeable
return p
}
}
// If none are writeable, return first location that exists
if len ( firstExistingPath ) > 0 {
return firstExistingPath
2018-09-05 20:46:10 +00:00
}
2020-05-04 14:59:48 +00:00
// If none exist, return first location that is set
if len ( firstSetPath ) > 0 {
return firstSetPath
}
// We've got nothing
return ""
2018-09-05 20:46:10 +00:00
}
return os . Getenv ( "HOME" )
}