working commit
This commit is contained in:
+9
-15
@@ -17,7 +17,7 @@ import (
|
|||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/auxhttp"
|
"mstore/pkg/auxhttp"
|
||||||
"mstore/pkg/auxpwd"
|
"mstore/pkg/auxpwd"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -50,7 +50,7 @@ func (hand *Handler) CheckAccess(rctx *router.Context) (bool, string, error) {
|
|||||||
var password string
|
var password string
|
||||||
var accountID string
|
var accountID string
|
||||||
|
|
||||||
accountID = term.AnonymousID
|
accountID = terms.AnonymousID
|
||||||
|
|
||||||
authHeader := rctx.GetHeader("Authorization")
|
authHeader := rctx.GetHeader("Authorization")
|
||||||
if authHeader != "" {
|
if authHeader != "" {
|
||||||
@@ -75,7 +75,7 @@ func (hand *Handler) CheckAccess(rctx *router.Context) (bool, string, error) {
|
|||||||
}
|
}
|
||||||
anonymous:
|
anonymous:
|
||||||
success = true
|
success = true
|
||||||
accountID = term.AnonymousID
|
accountID = terms.AnonymousID
|
||||||
return success, accountID, err
|
return success, accountID, err
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -104,14 +104,7 @@ func (hand *Handler) ValidatePassword(ctx context.Context, username, password st
|
|||||||
func (hand *Handler) CheckRight(ctx context.Context, accountID, reqRight, subject string) (bool, error) {
|
func (hand *Handler) CheckRight(ctx context.Context, accountID, reqRight, subject string) (bool, error) {
|
||||||
var err error
|
var err error
|
||||||
var res bool
|
var res bool
|
||||||
//hand.logg.Debugf("Cop check your right %s: %s %s", accountID, reqRight, subject)
|
hand.logg.Debugf("Check right %s: right=%s subj=%s", accountID, reqRight, subject)
|
||||||
// =[]=
|
|
||||||
// .------. ---
|
|
||||||
// .---[-] [#] \--, ---
|
|
||||||
// >| [ ] [ ] | ---...
|
|
||||||
// '--0-------0----'
|
|
||||||
// Bad news for you, baby.... #
|
|
||||||
//
|
|
||||||
exists, grants, err := hand.mdb.ListGrantsByAccoundIDRight(ctx, accountID, reqRight)
|
exists, grants, err := hand.mdb.ListGrantsByAccoundIDRight(ctx, accountID, reqRight)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return res, err
|
return res, err
|
||||||
@@ -120,11 +113,13 @@ func (hand *Handler) CheckRight(ctx context.Context, accountID, reqRight, subjec
|
|||||||
return res, err
|
return res, err
|
||||||
}
|
}
|
||||||
switch reqRight {
|
switch reqRight {
|
||||||
case term.RightReadFiles, term.RightWriteFiles:
|
case terms.RightReadFiles, terms.RightWriteFiles, terms.RightReadImages, terms.RightWriteImages:
|
||||||
for _, grant := range grants {
|
for _, grant := range grants {
|
||||||
|
hand.logg.Debugf("Grant pattern=[%s], subject=[%s]", grant.Pattern, subject)
|
||||||
|
|
||||||
re, err := regexp.Compile(grant.Pattern)
|
re, err := regexp.Compile(grant.Pattern)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
hand.logg.Warningf("Wrong pattern %s for grant %s: %v", grant.Pattern, grant.ID, err)
|
hand.logg.Warningf("Wrong regexp %s for grant %s: %v", grant.Pattern, grant.ID, err)
|
||||||
err = nil
|
err = nil
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
@@ -134,8 +129,7 @@ func (hand *Handler) CheckRight(ctx context.Context, accountID, reqRight, subjec
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
default:
|
default:
|
||||||
// NOP
|
|
||||||
}
|
|
||||||
res = true
|
res = true
|
||||||
|
}
|
||||||
return res, err
|
return res, err
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ import (
|
|||||||
|
|
||||||
"mstore/app/operator"
|
"mstore/app/operator"
|
||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
// POST /v3/account/create 200 200
|
// POST /v3/account/create 200 200
|
||||||
@@ -29,7 +29,7 @@ func (hand *Handler) CreateAccount(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -62,7 +62,7 @@ func (hand *Handler) GetAccount(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -95,7 +95,7 @@ func (hand *Handler) ListAccounts(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -128,7 +128,7 @@ func (hand *Handler) UpdateAccount(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -161,7 +161,7 @@ func (hand *Handler) DeleteAccount(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, params.Username)
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, params.Username)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
|
|||||||
+7
-7
@@ -16,7 +16,7 @@ import (
|
|||||||
|
|
||||||
"mstore/app/operator"
|
"mstore/app/operator"
|
||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
// HEAD /v2/<name>/blobs/<digest> 200 404
|
// HEAD /v2/<name>/blobs/<digest> 200 404
|
||||||
@@ -32,7 +32,7 @@ func (hand *Handler) BlobExists(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -72,7 +72,7 @@ func (hand *Handler) PostUpload(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -117,7 +117,7 @@ func (hand *Handler) PatchUpload(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -161,7 +161,7 @@ func (hand *Handler) PutUpload(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -191,7 +191,7 @@ func (hand *Handler) GetBlob(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -237,7 +237,7 @@ func (hand *Handler) DeleteBlob(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
|
|||||||
+8
-8
@@ -15,7 +15,7 @@ import (
|
|||||||
|
|
||||||
"mstore/app/operator"
|
"mstore/app/operator"
|
||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
const zeroContentLength = "0"
|
const zeroContentLength = "0"
|
||||||
@@ -28,7 +28,7 @@ func (hand *Handler) FileInfo(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadFiles, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -73,7 +73,7 @@ func (hand *Handler) PutFile(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteFiles, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -101,7 +101,7 @@ func (hand *Handler) GetFile(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadFiles, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -149,7 +149,7 @@ func (hand *Handler) DeleteFile(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteFiles, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -186,7 +186,7 @@ func (hand *Handler) ListFiles(rctx *router.Context) {
|
|||||||
|
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadFiles, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -223,7 +223,7 @@ func (hand *Handler) ListCollections(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadFiles, params.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -261,7 +261,7 @@ func (hand *Handler) DeleteCollection(rctx *router.Context) {
|
|||||||
|
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadFiles, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadFiles, params.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ import (
|
|||||||
|
|
||||||
"mstore/app/operator"
|
"mstore/app/operator"
|
||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
// POST /v3/grant/create 200 200
|
// POST /v3/grant/create 200 200
|
||||||
@@ -29,7 +29,7 @@ func (hand *Handler) CreateGrant(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -62,7 +62,7 @@ func (hand *Handler) GetGrant(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -95,7 +95,7 @@ func (hand *Handler) ListGrants(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -128,7 +128,7 @@ func (hand *Handler) UpdateGrant(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
@@ -161,7 +161,7 @@ func (hand *Handler) DeleteGrant(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteAccounts, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteAccounts, "")
|
||||||
if err != nil {
|
if err != nil {
|
||||||
err := fmt.Errorf("Operation error: %v", err)
|
err := fmt.Errorf("Operation error: %v", err)
|
||||||
hand.SendError(rctx, err)
|
hand.SendError(rctx, err)
|
||||||
|
|||||||
@@ -14,14 +14,14 @@ import (
|
|||||||
|
|
||||||
"mstore/app/operator"
|
"mstore/app/operator"
|
||||||
"mstore/app/router"
|
"mstore/app/router"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (hand *Handler) ManifestExists(rctx *router.Context) {
|
func (hand *Handler) ManifestExists(rctx *router.Context) {
|
||||||
name, _ := rctx.GetSubpath("name")
|
name, _ := rctx.GetSubpath("name")
|
||||||
reference, _ := rctx.GetSubpath("reference")
|
reference, _ := rctx.GetSubpath("reference")
|
||||||
|
|
||||||
hand.DumpHeaders("ManigestExists:\n", rctx)
|
//hand.DumpHeaders("ManigestExists:\n", rctx)
|
||||||
|
|
||||||
params := &operator.ManifestExistsParams{
|
params := &operator.ManifestExistsParams{
|
||||||
Name: name,
|
Name: name,
|
||||||
@@ -29,7 +29,7 @@ func (hand *Handler) ManifestExists(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -71,7 +71,7 @@ func (hand *Handler) PutManifest(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -104,7 +104,7 @@ func (hand *Handler) GetManifest(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -144,7 +144,7 @@ func (hand *Handler) DeleteManifest(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightWriteImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightWriteImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -173,7 +173,7 @@ func (hand *Handler) GetReferer(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
@@ -199,7 +199,7 @@ func (hand *Handler) GetTags(rctx *router.Context) {
|
|||||||
}
|
}
|
||||||
// Rigth checking
|
// Rigth checking
|
||||||
operatorID, _ := rctx.GetString(userTag)
|
operatorID, _ := rctx.GetString(userTag)
|
||||||
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, term.RightReadImages, "")
|
opEnable, err := hand.CheckRight(rctx.Ctx, operatorID, terms.RightReadImages, params.Name)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
rctx.SetStatus(http.StatusInternalServerError)
|
rctx.SetStatus(http.StatusInternalServerError)
|
||||||
return
|
return
|
||||||
|
|||||||
+28
-91
@@ -17,7 +17,7 @@ import (
|
|||||||
"mstore/pkg/auxtool"
|
"mstore/pkg/auxtool"
|
||||||
"mstore/pkg/auxuuid"
|
"mstore/pkg/auxuuid"
|
||||||
"mstore/pkg/descr"
|
"mstore/pkg/descr"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (db *Database) WriteAnonymous(ctx context.Context) error {
|
func (db *Database) WriteAnonymous(ctx context.Context) error {
|
||||||
@@ -27,14 +27,14 @@ func (db *Database) WriteAnonymous(ctx context.Context) error {
|
|||||||
password := auxtool.RandomString(64)
|
password := auxtool.RandomString(64)
|
||||||
passhash := auxpwd.MakeSHA256Hash([]byte(password))
|
passhash := auxpwd.MakeSHA256Hash([]byte(password))
|
||||||
accountDescr := &descr.Account{
|
accountDescr := &descr.Account{
|
||||||
ID: term.AnonymousID,
|
ID: terms.AnonymousID,
|
||||||
Username: term.AnonimousUsername,
|
Username: terms.AnonimousUsername,
|
||||||
Passhash: passhash,
|
Passhash: passhash,
|
||||||
Disabled: false,
|
Disabled: false,
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
UpdatedAt: now,
|
UpdatedAt: now,
|
||||||
CreatedBy: term.ServerID,
|
CreatedBy: terms.ServerID,
|
||||||
UpdatedBy: term.ServerID,
|
UpdatedBy: terms.ServerID,
|
||||||
}
|
}
|
||||||
err = db.InsertAccount(ctx, accountDescr)
|
err = db.InsertAccount(ctx, accountDescr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -43,12 +43,12 @@ func (db *Database) WriteAnonymous(ctx context.Context) error {
|
|||||||
grantDescr := &descr.Grant{
|
grantDescr := &descr.Grant{
|
||||||
ID: auxuuid.NewUUID(),
|
ID: auxuuid.NewUUID(),
|
||||||
AccountID: accountDescr.ID,
|
AccountID: accountDescr.ID,
|
||||||
Right: term.RightReadFiles,
|
Right: terms.RightReadFiles,
|
||||||
Pattern: ".*",
|
Pattern: ".*",
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
UpdatedAt: now,
|
UpdatedAt: now,
|
||||||
CreatedBy: term.ServerID,
|
CreatedBy: terms.ServerID,
|
||||||
UpdatedBy: term.ServerID,
|
UpdatedBy: terms.ServerID,
|
||||||
}
|
}
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
err = db.InsertGrant(ctx, grantDescr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -57,12 +57,12 @@ func (db *Database) WriteAnonymous(ctx context.Context) error {
|
|||||||
grantDescr = &descr.Grant{
|
grantDescr = &descr.Grant{
|
||||||
ID: auxuuid.NewUUID(),
|
ID: auxuuid.NewUUID(),
|
||||||
AccountID: accountDescr.ID,
|
AccountID: accountDescr.ID,
|
||||||
Right: term.RightReadImages,
|
Right: terms.RightReadImages,
|
||||||
Pattern: ".*",
|
Pattern: ".*",
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
UpdatedAt: now,
|
UpdatedAt: now,
|
||||||
CreatedBy: term.ServerID,
|
CreatedBy: terms.ServerID,
|
||||||
UpdatedBy: term.ServerID,
|
UpdatedBy: terms.ServerID,
|
||||||
}
|
}
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
err = db.InsertGrant(ctx, grantDescr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
@@ -76,107 +76,44 @@ func (db *Database) WriteAnonymous(ctx context.Context) error {
|
|||||||
func (db *Database) WriteInituser(ctx context.Context) error {
|
func (db *Database) WriteInituser(ctx context.Context) error {
|
||||||
var err error
|
var err error
|
||||||
now := auxtool.TimeNow()
|
now := auxtool.TimeNow()
|
||||||
passhash := auxpwd.MakeSHA256Hash([]byte(term.InitUsername))
|
passhash := auxpwd.MakeSHA256Hash([]byte(terms.InitUsername))
|
||||||
accountDescr := &descr.Account{
|
accountDescr := &descr.Account{
|
||||||
ID: term.InitID,
|
ID: terms.InitID,
|
||||||
Username: term.InitUsername,
|
Username: terms.InitUsername,
|
||||||
Passhash: passhash,
|
Passhash: passhash,
|
||||||
Disabled: false,
|
Disabled: false,
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
UpdatedAt: now,
|
UpdatedAt: now,
|
||||||
CreatedBy: term.ServerID,
|
CreatedBy: terms.ServerID,
|
||||||
UpdatedBy: term.ServerID,
|
UpdatedBy: terms.ServerID,
|
||||||
}
|
}
|
||||||
err = db.InsertAccount(ctx, accountDescr)
|
err = db.InsertAccount(ctx, accountDescr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
// Files
|
fullRights := []string{
|
||||||
|
terms.RightWriteAccounts,
|
||||||
|
terms.RightReadAccounts,
|
||||||
|
terms.RightWriteFiles,
|
||||||
|
terms.RightReadFiles,
|
||||||
|
terms.RightWriteImages,
|
||||||
|
terms.RightReadImages,
|
||||||
|
}
|
||||||
|
for _, right := range fullRights {
|
||||||
grantDescr := &descr.Grant{
|
grantDescr := &descr.Grant{
|
||||||
ID: auxuuid.NewUUID(),
|
ID: auxuuid.NewUUID(),
|
||||||
AccountID: accountDescr.ID,
|
AccountID: accountDescr.ID,
|
||||||
Right: term.RightReadFiles,
|
Right: right,
|
||||||
Pattern: ".*",
|
Pattern: ".*",
|
||||||
CreatedAt: now,
|
CreatedAt: now,
|
||||||
UpdatedAt: now,
|
UpdatedAt: now,
|
||||||
CreatedBy: term.ServerID,
|
CreatedBy: terms.ServerID,
|
||||||
UpdatedBy: term.ServerID,
|
UpdatedBy: terms.ServerID,
|
||||||
}
|
}
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
err = db.InsertGrant(ctx, grantDescr)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
grantDescr = &descr.Grant{
|
|
||||||
ID: auxuuid.NewUUID(),
|
|
||||||
AccountID: accountDescr.ID,
|
|
||||||
Right: term.RightWriteFiles,
|
|
||||||
Pattern: ".*",
|
|
||||||
CreatedAt: now,
|
|
||||||
UpdatedAt: now,
|
|
||||||
CreatedBy: term.ServerID,
|
|
||||||
UpdatedBy: term.ServerID,
|
|
||||||
}
|
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
// Accounts
|
|
||||||
grantDescr = &descr.Grant{
|
|
||||||
ID: auxuuid.NewUUID(),
|
|
||||||
AccountID: accountDescr.ID,
|
|
||||||
Right: term.RightReadAccounts,
|
|
||||||
Pattern: ".*",
|
|
||||||
CreatedAt: now,
|
|
||||||
UpdatedAt: now,
|
|
||||||
CreatedBy: term.ServerID,
|
|
||||||
UpdatedBy: term.ServerID,
|
|
||||||
}
|
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
grantDescr = &descr.Grant{
|
|
||||||
ID: auxuuid.NewUUID(),
|
|
||||||
AccountID: accountDescr.ID,
|
|
||||||
Right: term.RightWriteAccounts,
|
|
||||||
Pattern: ".*",
|
|
||||||
CreatedAt: now,
|
|
||||||
UpdatedAt: now,
|
|
||||||
CreatedBy: term.ServerID,
|
|
||||||
UpdatedBy: term.ServerID,
|
|
||||||
}
|
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
// Images
|
|
||||||
grantDescr = &descr.Grant{
|
|
||||||
ID: auxuuid.NewUUID(),
|
|
||||||
AccountID: accountDescr.ID,
|
|
||||||
Right: term.RightReadImages,
|
|
||||||
Pattern: ".*",
|
|
||||||
CreatedAt: now,
|
|
||||||
UpdatedAt: now,
|
|
||||||
CreatedBy: term.ServerID,
|
|
||||||
UpdatedBy: term.ServerID,
|
|
||||||
}
|
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
grantDescr = &descr.Grant{
|
|
||||||
ID: auxuuid.NewUUID(),
|
|
||||||
AccountID: accountDescr.ID,
|
|
||||||
Right: term.RightWriteImages,
|
|
||||||
Pattern: ".*",
|
|
||||||
CreatedAt: now,
|
|
||||||
UpdatedAt: now,
|
|
||||||
CreatedBy: term.ServerID,
|
|
||||||
UpdatedBy: term.ServerID,
|
|
||||||
}
|
|
||||||
err = db.InsertGrant(ctx, grantDescr)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
}
|
||||||
return err
|
return err
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@ import (
|
|||||||
"mstore/pkg/auxtool"
|
"mstore/pkg/auxtool"
|
||||||
"mstore/pkg/auxuuid"
|
"mstore/pkg/auxuuid"
|
||||||
"mstore/pkg/descr"
|
"mstore/pkg/descr"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
// FileInfo
|
// FileInfo
|
||||||
@@ -300,14 +300,14 @@ func (oper *Operator) ListFiles(ctx context.Context, operatorID string, params *
|
|||||||
Files: make([]descr.File, 0),
|
Files: make([]descr.File, 0),
|
||||||
}
|
}
|
||||||
switch params.PathAs {
|
switch params.PathAs {
|
||||||
case term.AsRegexp:
|
case terms.AsRegexp:
|
||||||
files, err := oper.listFilesWithRegex(ctx, params.Filepath)
|
files, err := oper.listFilesWithRegex(ctx, params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
return code, res, err
|
return code, res, err
|
||||||
}
|
}
|
||||||
res.Files = files
|
res.Files = files
|
||||||
case term.AsPrefix:
|
case terms.AsPrefix:
|
||||||
params.Filepath, err = cleanFilepath(params.Filepath)
|
params.Filepath, err = cleanFilepath(params.Filepath)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
@@ -414,13 +414,13 @@ func (oper *Operator) ListCollections(ctx context.Context, operatorID string, pa
|
|||||||
|
|
||||||
collectionList := make([]string, 0)
|
collectionList := make([]string, 0)
|
||||||
switch param.PathAS {
|
switch param.PathAS {
|
||||||
case term.AsRegexp:
|
case terms.AsRegexp:
|
||||||
collectionList, err = oper.listCollectionsWithRegexp(ctx, param.Path)
|
collectionList, err = oper.listCollectionsWithRegexp(ctx, param.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
return code, res, err
|
return code, res, err
|
||||||
}
|
}
|
||||||
case term.AsPrefix:
|
case terms.AsPrefix:
|
||||||
param.Path, err = cleanFilepath(param.Path)
|
param.Path, err = cleanFilepath(param.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
@@ -545,7 +545,7 @@ func (oper *Operator) DeleteColletion(ctx context.Context, operatorID string, pa
|
|||||||
Files: make([]descr.File, 0),
|
Files: make([]descr.File, 0),
|
||||||
}
|
}
|
||||||
switch param.PathAs {
|
switch param.PathAs {
|
||||||
case term.AsRegexp:
|
case terms.AsRegexp:
|
||||||
collections, err := oper.listCollectionsWithRegexp(ctx, param.Path)
|
collections, err := oper.listCollectionsWithRegexp(ctx, param.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
@@ -562,7 +562,7 @@ func (oper *Operator) DeleteColletion(ctx context.Context, operatorID string, pa
|
|||||||
}
|
}
|
||||||
res.Files = allfiles
|
res.Files = allfiles
|
||||||
|
|
||||||
case term.AsPrefix:
|
case terms.AsPrefix:
|
||||||
param.Path, err = cleanFilepath(param.Path)
|
param.Path, err = cleanFilepath(param.Path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
code := http.StatusInternalServerError
|
code := http.StatusInternalServerError
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ import (
|
|||||||
|
|
||||||
"mstore/pkg/client"
|
"mstore/pkg/client"
|
||||||
"mstore/pkg/descr"
|
"mstore/pkg/descr"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
const (
|
const (
|
||||||
@@ -154,12 +154,12 @@ func (util *AccountUtil) createAccount(common *CommonAccountParams, params *Crea
|
|||||||
}
|
}
|
||||||
|
|
||||||
fullRights := []string{
|
fullRights := []string{
|
||||||
term.RightWriteAccounts,
|
terms.RightWriteAccounts,
|
||||||
term.RightReadAccounts,
|
terms.RightReadAccounts,
|
||||||
term.RightWriteFiles,
|
terms.RightWriteFiles,
|
||||||
term.RightReadFiles,
|
terms.RightReadFiles,
|
||||||
term.RightWriteImages,
|
terms.RightWriteImages,
|
||||||
term.RightReadImages,
|
terms.RightReadImages,
|
||||||
}
|
}
|
||||||
for _, right := range fullRights {
|
for _, right := range fullRights {
|
||||||
id, err := client.NewClient().CreateGrantByAccountID(ctx, hostname, accountID, right, ".*")
|
id, err := client.NewClient().CreateGrantByAccountID(ctx, hostname, accountID, right, ".*")
|
||||||
|
|||||||
+12
-12
@@ -27,7 +27,7 @@ import (
|
|||||||
|
|
||||||
"mstore/pkg/client"
|
"mstore/pkg/client"
|
||||||
"mstore/pkg/descr"
|
"mstore/pkg/descr"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
)
|
)
|
||||||
|
|
||||||
func (util *FileUtil) CreateFileCmds() *cobra.Command {
|
func (util *FileUtil) CreateFileCmds() *cobra.Command {
|
||||||
@@ -341,11 +341,11 @@ func (util *FileUtil) listFiles(common *CommonFileParams, params *ListFilesParam
|
|||||||
var pathUsage string
|
var pathUsage string
|
||||||
switch {
|
switch {
|
||||||
case params.AsRegexp:
|
case params.AsRegexp:
|
||||||
pathUsage = term.AsRegexp
|
pathUsage = terms.AsRegexp
|
||||||
case params.AsPrefix:
|
case params.AsPrefix:
|
||||||
pathUsage = term.AsPrefix
|
pathUsage = terms.AsPrefix
|
||||||
default:
|
default:
|
||||||
pathUsage = term.AsFinePath
|
pathUsage = terms.AsFinePath
|
||||||
}
|
}
|
||||||
timeout := time.Duration(common.Timeout) * time.Second
|
timeout := time.Duration(common.Timeout) * time.Second
|
||||||
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
||||||
@@ -467,11 +467,11 @@ func (util *FileUtil) exportFiles(common *CommonFileParams, params *ExportFilesP
|
|||||||
var pathUsage string
|
var pathUsage string
|
||||||
switch {
|
switch {
|
||||||
case params.AsRegexp:
|
case params.AsRegexp:
|
||||||
pathUsage = term.AsRegexp
|
pathUsage = terms.AsRegexp
|
||||||
case params.AsPrefix:
|
case params.AsPrefix:
|
||||||
pathUsage = term.AsPrefix
|
pathUsage = terms.AsPrefix
|
||||||
default:
|
default:
|
||||||
pathUsage = term.AsFinePath
|
pathUsage = terms.AsFinePath
|
||||||
}
|
}
|
||||||
timeout := time.Duration(common.Timeout) * time.Second
|
timeout := time.Duration(common.Timeout) * time.Second
|
||||||
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
||||||
@@ -556,11 +556,11 @@ func (util *FileUtil) listCollections(common *CommonFileParams, params *ListColl
|
|||||||
var pathUsage string
|
var pathUsage string
|
||||||
switch {
|
switch {
|
||||||
case params.AsRegexp:
|
case params.AsRegexp:
|
||||||
pathUsage = term.AsRegexp
|
pathUsage = terms.AsRegexp
|
||||||
case params.AsPrefix:
|
case params.AsPrefix:
|
||||||
pathUsage = term.AsPrefix
|
pathUsage = terms.AsPrefix
|
||||||
default:
|
default:
|
||||||
pathUsage = term.AsFinePath
|
pathUsage = terms.AsFinePath
|
||||||
}
|
}
|
||||||
timeout := time.Duration(common.Timeout) * time.Second
|
timeout := time.Duration(common.Timeout) * time.Second
|
||||||
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
ctx, _ := context.WithTimeout(context.Background(), timeout)
|
||||||
@@ -606,9 +606,9 @@ func (util *FileUtil) deleteCollection(common *CommonFileParams, params *DeleteC
|
|||||||
var pathUsage string
|
var pathUsage string
|
||||||
switch {
|
switch {
|
||||||
case params.AsPrefix:
|
case params.AsPrefix:
|
||||||
pathUsage = term.AsPrefix
|
pathUsage = terms.AsPrefix
|
||||||
default:
|
default:
|
||||||
pathUsage = term.AsFinePath
|
pathUsage = terms.AsFinePath
|
||||||
}
|
}
|
||||||
files, err := client.NewClient().DeleteCollection(ctx, params.Path, pathUsage, params.DryRun)
|
files, err := client.NewClient().DeleteCollection(ctx, params.Path, pathUsage, params.DryRun)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
|||||||
@@ -8,11 +8,7 @@
|
|||||||
* modifications are strictly prohibited.
|
* modifications are strictly prohibited.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
package term
|
package terms
|
||||||
|
|
||||||
import (
|
|
||||||
//"mstore/pkg/auxuuid"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
const (
|
||||||
AsFinePath string = "asFinePath"
|
AsFinePath string = "asFinePath"
|
||||||
@@ -17,9 +17,8 @@ import (
|
|||||||
"time"
|
"time"
|
||||||
|
|
||||||
"mstore/app/server"
|
"mstore/app/server"
|
||||||
"mstore/pkg/auxuuid"
|
|
||||||
"mstore/pkg/client"
|
"mstore/pkg/client"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
|
|
||||||
@@ -81,7 +80,7 @@ func TestAccountLife(t *testing.T) {
|
|||||||
username := "testuser"
|
username := "testuser"
|
||||||
password := "testpass"
|
password := "testpass"
|
||||||
|
|
||||||
var accountID uint64
|
var accountID string
|
||||||
{
|
{
|
||||||
// CreateAccount
|
// CreateAccount
|
||||||
fmt.Printf("=== CreateAccount ===\n")
|
fmt.Printf("=== CreateAccount ===\n")
|
||||||
@@ -92,7 +91,7 @@ func TestAccountLife(t *testing.T) {
|
|||||||
accountID, err = cli.CreateAccount(ctx, srvaddr, username, password)
|
accountID, err = cli.CreateAccount(ctx, srvaddr, username, password)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
}
|
}
|
||||||
var grantID uint64
|
var grantID string
|
||||||
{
|
{
|
||||||
// CreateGrant
|
// CreateGrant
|
||||||
fmt.Printf("=== CreateGrant ===\n")
|
fmt.Printf("=== CreateGrant ===\n")
|
||||||
@@ -100,7 +99,7 @@ func TestAccountLife(t *testing.T) {
|
|||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
||||||
|
|
||||||
grantID, err = cli.CreateGrantByAccountID(ctx, srvaddr, accountID, term.RightReadAccounts, ".*")
|
grantID, err = cli.CreateGrantByAccountID(ctx, srvaddr, accountID, terms.RightReadAccounts, ".*")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.Equal(t, len(grantID), 36)
|
require.Equal(t, len(grantID), 36)
|
||||||
}
|
}
|
||||||
@@ -121,7 +120,7 @@ func TestAccountLife(t *testing.T) {
|
|||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
||||||
|
|
||||||
grantID, err = cli.CreateGrantByAccountID(ctx, srvaddr, accountID, term.RightWriteAccounts, ".*")
|
grantID, err = cli.CreateGrantByAccountID(ctx, srvaddr, accountID, terms.RightWriteAccounts, ".*")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.Equal(t, len(grantID), 36)
|
require.Equal(t, len(grantID), 36)
|
||||||
fmt.Printf("grantID: %s\n", grantID)
|
fmt.Printf("grantID: %s\n", grantID)
|
||||||
|
|||||||
+2
-2
@@ -21,7 +21,7 @@ import (
|
|||||||
|
|
||||||
"mstore/app/server"
|
"mstore/app/server"
|
||||||
"mstore/pkg/client"
|
"mstore/pkg/client"
|
||||||
"mstore/pkg/term"
|
"mstore/pkg/terms"
|
||||||
|
|
||||||
"github.com/stretchr/testify/require"
|
"github.com/stretchr/testify/require"
|
||||||
)
|
)
|
||||||
@@ -133,7 +133,7 @@ func TestFileLife(t *testing.T) {
|
|||||||
ctx := context.Background()
|
ctx := context.Background()
|
||||||
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
ctx, _ = context.WithTimeout(ctx, 1*time.Second)
|
||||||
|
|
||||||
files, err := cli.ListFiles(ctx, srvaddr+"/", term.AsFinePath)
|
files, err := cli.ListFiles(ctx, srvaddr+"/", terms.AsFinePath)
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
require.NotZero(t, len(files))
|
require.NotZero(t, len(files))
|
||||||
}
|
}
|
||||||
|
|||||||
-202
@@ -1,202 +0,0 @@
|
|||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright [yyyy] [name of copyright owner]
|
|
||||||
|
|
||||||
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.
|
|
||||||
-756
@@ -1,756 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The containerd 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Copyright 2019 The Go Authors. All rights reserved.
|
|
||||||
Use of this source code is governed by a BSD-style
|
|
||||||
license that can be found in the LICENSE file.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package estargz
|
|
||||||
|
|
||||||
import (
|
|
||||||
"archive/tar"
|
|
||||||
"bytes"
|
|
||||||
"compress/gzip"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path"
|
|
||||||
"runtime"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"sync/atomic"
|
|
||||||
|
|
||||||
"github.com/containerd/stargz-snapshotter/estargz/errorutil"
|
|
||||||
"github.com/klauspost/compress/zstd"
|
|
||||||
digest "github.com/opencontainers/go-digest"
|
|
||||||
"golang.org/x/sync/errgroup"
|
|
||||||
)
|
|
||||||
|
|
||||||
type GzipHelperFunc func(io.Reader) (io.ReadCloser, error)
|
|
||||||
|
|
||||||
type options struct {
|
|
||||||
chunkSize int
|
|
||||||
compressionLevel int
|
|
||||||
prioritizedFiles []string
|
|
||||||
missedPrioritizedFiles *[]string
|
|
||||||
compression Compression
|
|
||||||
ctx context.Context
|
|
||||||
minChunkSize int
|
|
||||||
gzipHelperFunc GzipHelperFunc
|
|
||||||
}
|
|
||||||
|
|
||||||
type Option func(o *options) error
|
|
||||||
|
|
||||||
// WithChunkSize option specifies the chunk size of eStargz blob to build.
|
|
||||||
func WithChunkSize(chunkSize int) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.chunkSize = chunkSize
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithCompressionLevel option specifies the gzip compression level.
|
|
||||||
// The default is gzip.BestCompression.
|
|
||||||
// This option will be ignored if WithCompression option is used.
|
|
||||||
// See also: https://godoc.org/compress/gzip#pkg-constants
|
|
||||||
func WithCompressionLevel(level int) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.compressionLevel = level
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithPrioritizedFiles option specifies the list of prioritized files.
|
|
||||||
// These files must be complete paths that are absolute or relative to "/"
|
|
||||||
// For example, all of "foo/bar", "/foo/bar", "./foo/bar" and "../foo/bar"
|
|
||||||
// are treated as "/foo/bar".
|
|
||||||
func WithPrioritizedFiles(files []string) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.prioritizedFiles = files
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithAllowPrioritizeNotFound makes Build continue the execution even if some
|
|
||||||
// of prioritized files specified by WithPrioritizedFiles option aren't found
|
|
||||||
// in the input tar. Instead, this records all missed file names to the passed
|
|
||||||
// slice.
|
|
||||||
func WithAllowPrioritizeNotFound(missedFiles *[]string) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
if missedFiles == nil {
|
|
||||||
return fmt.Errorf("WithAllowPrioritizeNotFound: slice must be passed")
|
|
||||||
}
|
|
||||||
o.missedPrioritizedFiles = missedFiles
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithCompression specifies compression algorithm to be used.
|
|
||||||
// Default is gzip.
|
|
||||||
func WithCompression(compression Compression) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.compression = compression
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithContext specifies a context that can be used for clean canceleration.
|
|
||||||
func WithContext(ctx context.Context) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.ctx = ctx
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithMinChunkSize option specifies the minimal number of bytes of data
|
|
||||||
// must be written in one gzip stream.
|
|
||||||
// By increasing this number, one gzip stream can contain multiple files
|
|
||||||
// and it hopefully leads to smaller result blob.
|
|
||||||
// NOTE: This adds a TOC property that old reader doesn't understand.
|
|
||||||
func WithMinChunkSize(minChunkSize int) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.minChunkSize = minChunkSize
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithGzipHelperFunc option specifies a custom function to decompress gzip-compressed layers.
|
|
||||||
// When a gzip-compressed layer is detected, this function will be used instead of the
|
|
||||||
// Go standard library gzip decompression for better performance.
|
|
||||||
// The function should take an io.Reader as input and return an io.ReadCloser.
|
|
||||||
// If nil, the Go standard library gzip.NewReader will be used.
|
|
||||||
func WithGzipHelperFunc(gzipHelperFunc GzipHelperFunc) Option {
|
|
||||||
return func(o *options) error {
|
|
||||||
o.gzipHelperFunc = gzipHelperFunc
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Blob is an eStargz blob.
|
|
||||||
type Blob struct {
|
|
||||||
io.ReadCloser
|
|
||||||
diffID digest.Digester
|
|
||||||
tocDigest digest.Digest
|
|
||||||
readCompleted *atomic.Bool
|
|
||||||
uncompressedSize *atomic.Int64
|
|
||||||
}
|
|
||||||
|
|
||||||
// DiffID returns the digest of uncompressed blob.
|
|
||||||
// It is only valid to call DiffID after Close.
|
|
||||||
func (b *Blob) DiffID() digest.Digest {
|
|
||||||
return b.diffID.Digest()
|
|
||||||
}
|
|
||||||
|
|
||||||
// TOCDigest returns the digest of uncompressed TOC JSON.
|
|
||||||
func (b *Blob) TOCDigest() digest.Digest {
|
|
||||||
return b.tocDigest
|
|
||||||
}
|
|
||||||
|
|
||||||
// UncompressedSize returns the size of uncompressed blob.
|
|
||||||
// UncompressedSize should only be called after the blob has been fully read.
|
|
||||||
func (b *Blob) UncompressedSize() (int64, error) {
|
|
||||||
switch {
|
|
||||||
case b.uncompressedSize == nil || b.readCompleted == nil:
|
|
||||||
return -1, fmt.Errorf("readCompleted or uncompressedSize is not initialized")
|
|
||||||
case !b.readCompleted.Load():
|
|
||||||
return -1, fmt.Errorf("called UncompressedSize before the blob has been fully read")
|
|
||||||
default:
|
|
||||||
return b.uncompressedSize.Load(), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Build builds an eStargz blob which is an extended version of stargz, from a blob (gzip, zstd
|
|
||||||
// or plain tar) passed through the argument. If there are some prioritized files are listed in
|
|
||||||
// the option, these files are grouped as "prioritized" and can be used for runtime optimization
|
|
||||||
// (e.g. prefetch). This function builds a blob in parallel, with dividing that blob into several
|
|
||||||
// (at least the number of runtime.GOMAXPROCS(0)) sub-blobs.
|
|
||||||
func Build(tarBlob *io.SectionReader, opt ...Option) (_ *Blob, rErr error) {
|
|
||||||
var opts options
|
|
||||||
opts.compressionLevel = gzip.BestCompression // BestCompression by default
|
|
||||||
for _, o := range opt {
|
|
||||||
if err := o(&opts); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if opts.compression == nil {
|
|
||||||
opts.compression = newGzipCompressionWithLevel(opts.compressionLevel)
|
|
||||||
}
|
|
||||||
layerFiles := newTempFiles()
|
|
||||||
ctx := opts.ctx
|
|
||||||
if ctx == nil {
|
|
||||||
ctx = context.Background()
|
|
||||||
}
|
|
||||||
done := make(chan struct{})
|
|
||||||
defer close(done)
|
|
||||||
go func() {
|
|
||||||
select {
|
|
||||||
case <-done:
|
|
||||||
// nop
|
|
||||||
case <-ctx.Done():
|
|
||||||
layerFiles.CleanupAll()
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
defer func() {
|
|
||||||
if rErr != nil {
|
|
||||||
if err := layerFiles.CleanupAll(); err != nil {
|
|
||||||
rErr = fmt.Errorf("failed to cleanup tmp files: %v: %w", err, rErr)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if cErr := ctx.Err(); cErr != nil {
|
|
||||||
rErr = fmt.Errorf("error from context %q: %w", cErr, rErr)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
tarBlob, err := decompressBlob(tarBlob, layerFiles, opts.gzipHelperFunc)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
entries, err := sortEntries(tarBlob, opts.prioritizedFiles, opts.missedPrioritizedFiles)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
var tarParts [][]*entry
|
|
||||||
if opts.minChunkSize > 0 {
|
|
||||||
// Each entry needs to know the size of the current gzip stream so they
|
|
||||||
// cannot be processed in parallel.
|
|
||||||
tarParts = [][]*entry{entries}
|
|
||||||
} else {
|
|
||||||
tarParts = divideEntries(entries, runtime.GOMAXPROCS(0))
|
|
||||||
}
|
|
||||||
writers := make([]*Writer, len(tarParts))
|
|
||||||
payloads := make([]*os.File, len(tarParts))
|
|
||||||
var mu sync.Mutex
|
|
||||||
var eg errgroup.Group
|
|
||||||
for i, parts := range tarParts {
|
|
||||||
i, parts := i, parts
|
|
||||||
// builds verifiable stargz sub-blobs
|
|
||||||
eg.Go(func() error {
|
|
||||||
esgzFile, err := layerFiles.TempFile("", "esgzdata")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
sw := NewWriterWithCompressor(esgzFile, opts.compression)
|
|
||||||
sw.ChunkSize = opts.chunkSize
|
|
||||||
sw.MinChunkSize = opts.minChunkSize
|
|
||||||
if sw.needsOpenGzEntries == nil {
|
|
||||||
sw.needsOpenGzEntries = make(map[string]struct{})
|
|
||||||
}
|
|
||||||
for _, f := range []string{PrefetchLandmark, NoPrefetchLandmark} {
|
|
||||||
sw.needsOpenGzEntries[f] = struct{}{}
|
|
||||||
}
|
|
||||||
if err := sw.AppendTar(readerFromEntries(parts...)); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
mu.Lock()
|
|
||||||
writers[i] = sw
|
|
||||||
payloads[i] = esgzFile
|
|
||||||
mu.Unlock()
|
|
||||||
return nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
if err := eg.Wait(); err != nil {
|
|
||||||
rErr = err
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
tocAndFooter, tocDgst, err := closeWithCombine(writers...)
|
|
||||||
if err != nil {
|
|
||||||
rErr = err
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
var rs []io.Reader
|
|
||||||
for _, p := range payloads {
|
|
||||||
fs, err := fileSectionReader(p)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
rs = append(rs, fs)
|
|
||||||
}
|
|
||||||
diffID := digest.Canonical.Digester()
|
|
||||||
pr, pw := io.Pipe()
|
|
||||||
readCompleted := new(atomic.Bool)
|
|
||||||
uncompressedSize := new(atomic.Int64)
|
|
||||||
go func() {
|
|
||||||
var size int64
|
|
||||||
var decompressFunc func(io.Reader) (io.ReadCloser, error)
|
|
||||||
if _, ok := opts.compression.(*gzipCompression); ok && opts.gzipHelperFunc != nil {
|
|
||||||
decompressFunc = opts.gzipHelperFunc
|
|
||||||
} else {
|
|
||||||
decompressFunc = opts.compression.Reader
|
|
||||||
}
|
|
||||||
decompressR, err := decompressFunc(io.TeeReader(io.MultiReader(append(rs, tocAndFooter)...), pw))
|
|
||||||
if err != nil {
|
|
||||||
pw.CloseWithError(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
defer decompressR.Close()
|
|
||||||
if size, err = io.Copy(diffID.Hash(), decompressR); err != nil {
|
|
||||||
pw.CloseWithError(err)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
uncompressedSize.Store(size)
|
|
||||||
readCompleted.Store(true)
|
|
||||||
pw.Close()
|
|
||||||
}()
|
|
||||||
return &Blob{
|
|
||||||
ReadCloser: readCloser{
|
|
||||||
Reader: pr,
|
|
||||||
closeFunc: layerFiles.CleanupAll,
|
|
||||||
},
|
|
||||||
tocDigest: tocDgst,
|
|
||||||
diffID: diffID,
|
|
||||||
readCompleted: readCompleted,
|
|
||||||
uncompressedSize: uncompressedSize,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// closeWithCombine takes unclosed Writers and close them. This also returns the
|
|
||||||
// toc that combined all Writers into.
|
|
||||||
// Writers doesn't write TOC and footer to the underlying writers so they can be
|
|
||||||
// combined into a single eStargz and tocAndFooter returned by this function can
|
|
||||||
// be appended at the tail of that combined blob.
|
|
||||||
func closeWithCombine(ws ...*Writer) (tocAndFooterR io.Reader, tocDgst digest.Digest, err error) {
|
|
||||||
if len(ws) == 0 {
|
|
||||||
return nil, "", fmt.Errorf("at least one writer must be passed")
|
|
||||||
}
|
|
||||||
for _, w := range ws {
|
|
||||||
if w.closed {
|
|
||||||
return nil, "", fmt.Errorf("writer must be unclosed")
|
|
||||||
}
|
|
||||||
defer func(w *Writer) { w.closed = true }(w)
|
|
||||||
if err := w.closeGz(); err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
if err := w.bw.Flush(); err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
var (
|
|
||||||
mtoc = new(JTOC)
|
|
||||||
currentOffset int64
|
|
||||||
)
|
|
||||||
mtoc.Version = ws[0].toc.Version
|
|
||||||
for _, w := range ws {
|
|
||||||
for _, e := range w.toc.Entries {
|
|
||||||
// Recalculate Offset of non-empty files/chunks
|
|
||||||
if (e.Type == "reg" && e.Size > 0) || e.Type == "chunk" {
|
|
||||||
e.Offset += currentOffset
|
|
||||||
}
|
|
||||||
mtoc.Entries = append(mtoc.Entries, e)
|
|
||||||
}
|
|
||||||
if w.toc.Version > mtoc.Version {
|
|
||||||
mtoc.Version = w.toc.Version
|
|
||||||
}
|
|
||||||
currentOffset += w.cw.n
|
|
||||||
}
|
|
||||||
|
|
||||||
return tocAndFooter(ws[0].compressor, mtoc, currentOffset)
|
|
||||||
}
|
|
||||||
|
|
||||||
func tocAndFooter(compressor Compressor, toc *JTOC, offset int64) (io.Reader, digest.Digest, error) {
|
|
||||||
buf := new(bytes.Buffer)
|
|
||||||
tocDigest, err := compressor.WriteTOCAndFooter(buf, offset, toc, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
return buf, tocDigest, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// divideEntries divides passed entries to the parts at least the number specified by the
|
|
||||||
// argument.
|
|
||||||
func divideEntries(entries []*entry, minPartsNum int) (set [][]*entry) {
|
|
||||||
var estimatedSize int64
|
|
||||||
for _, e := range entries {
|
|
||||||
estimatedSize += e.header.Size
|
|
||||||
}
|
|
||||||
unitSize := estimatedSize / int64(minPartsNum)
|
|
||||||
var (
|
|
||||||
nextEnd = unitSize
|
|
||||||
offset int64
|
|
||||||
)
|
|
||||||
set = append(set, []*entry{})
|
|
||||||
for _, e := range entries {
|
|
||||||
set[len(set)-1] = append(set[len(set)-1], e)
|
|
||||||
offset += e.header.Size
|
|
||||||
if offset > nextEnd {
|
|
||||||
set = append(set, []*entry{})
|
|
||||||
nextEnd += unitSize
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
var errNotFound = errors.New("not found")
|
|
||||||
|
|
||||||
// sortEntries reads the specified tar blob and returns a list of tar entries.
|
|
||||||
// If some of prioritized files are specified, the list starts from these
|
|
||||||
// files with keeping the order specified by the argument.
|
|
||||||
func sortEntries(in io.ReaderAt, prioritized []string, missedPrioritized *[]string) ([]*entry, error) {
|
|
||||||
|
|
||||||
// Import tar file.
|
|
||||||
intar, err := importTar(in)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to sort: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sort the tar file respecting to the prioritized files list.
|
|
||||||
sorted := &tarFile{}
|
|
||||||
picked := make(map[string]struct{})
|
|
||||||
for _, l := range prioritized {
|
|
||||||
if err := moveRec(l, intar, sorted, picked); err != nil {
|
|
||||||
if errors.Is(err, errNotFound) && missedPrioritized != nil {
|
|
||||||
*missedPrioritized = append(*missedPrioritized, l)
|
|
||||||
continue // allow not found
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("failed to sort tar entries: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if len(prioritized) == 0 {
|
|
||||||
sorted.add(&entry{
|
|
||||||
header: &tar.Header{
|
|
||||||
Name: NoPrefetchLandmark,
|
|
||||||
Typeflag: tar.TypeReg,
|
|
||||||
Size: int64(len([]byte{landmarkContents})),
|
|
||||||
},
|
|
||||||
payload: bytes.NewReader([]byte{landmarkContents}),
|
|
||||||
})
|
|
||||||
} else {
|
|
||||||
sorted.add(&entry{
|
|
||||||
header: &tar.Header{
|
|
||||||
Name: PrefetchLandmark,
|
|
||||||
Typeflag: tar.TypeReg,
|
|
||||||
Size: int64(len([]byte{landmarkContents})),
|
|
||||||
},
|
|
||||||
payload: bytes.NewReader([]byte{landmarkContents}),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dump prioritized entries followed by the rest entries while skipping picked ones.
|
|
||||||
return append(sorted.dump(nil), intar.dump(picked)...), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readerFromEntries returns a reader of tar archive that contains entries passed
|
|
||||||
// through the arguments.
|
|
||||||
func readerFromEntries(entries ...*entry) io.Reader {
|
|
||||||
pr, pw := io.Pipe()
|
|
||||||
go func() {
|
|
||||||
tw := tar.NewWriter(pw)
|
|
||||||
defer tw.Close()
|
|
||||||
for _, entry := range entries {
|
|
||||||
if err := tw.WriteHeader(entry.header); err != nil {
|
|
||||||
pw.CloseWithError(fmt.Errorf("failed to write tar header: %v", err))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if _, err := io.Copy(tw, entry.payload); err != nil {
|
|
||||||
pw.CloseWithError(fmt.Errorf("failed to write tar payload: %v", err))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
pw.Close()
|
|
||||||
}()
|
|
||||||
return pr
|
|
||||||
}
|
|
||||||
|
|
||||||
func importTar(in io.ReaderAt) (*tarFile, error) {
|
|
||||||
tf := &tarFile{}
|
|
||||||
pw, err := newCountReadSeeker(in)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to make position watcher: %w", err)
|
|
||||||
}
|
|
||||||
tr := tar.NewReader(pw)
|
|
||||||
|
|
||||||
// Walk through all nodes.
|
|
||||||
for {
|
|
||||||
// Fetch and parse next header.
|
|
||||||
h, err := tr.Next()
|
|
||||||
if err != nil {
|
|
||||||
if err == io.EOF {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("failed to parse tar file, %w", err)
|
|
||||||
}
|
|
||||||
switch cleanEntryName(h.Name) {
|
|
||||||
case PrefetchLandmark, NoPrefetchLandmark:
|
|
||||||
// Ignore existing landmark
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add entry. If it already exists, replace it.
|
|
||||||
if _, ok := tf.get(h.Name); ok {
|
|
||||||
tf.remove(h.Name)
|
|
||||||
}
|
|
||||||
tf.add(&entry{
|
|
||||||
header: h,
|
|
||||||
payload: io.NewSectionReader(in, pw.currentPos(), h.Size),
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return tf, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func moveRec(name string, in *tarFile, out *tarFile, picked map[string]struct{}) error {
|
|
||||||
name = cleanEntryName(name)
|
|
||||||
if name == "" { // root directory. stop recursion.
|
|
||||||
if e, ok := in.get(name); ok {
|
|
||||||
// entry of the root directory exists. we should move it as well.
|
|
||||||
// this case will occur if tar entries are prefixed with "./", "/", etc.
|
|
||||||
if _, done := picked[name]; !done {
|
|
||||||
out.add(e)
|
|
||||||
picked[name] = struct{}{}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
_, okIn := in.get(name)
|
|
||||||
_, okOut := out.get(name)
|
|
||||||
_, okPicked := picked[name]
|
|
||||||
if !okIn && !okOut && !okPicked {
|
|
||||||
return fmt.Errorf("file: %q: %w", name, errNotFound)
|
|
||||||
}
|
|
||||||
|
|
||||||
parent, _ := path.Split(strings.TrimSuffix(name, "/"))
|
|
||||||
if err := moveRec(parent, in, out, picked); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if e, ok := in.get(name); ok && e.header.Typeflag == tar.TypeLink {
|
|
||||||
if err := moveRec(e.header.Linkname, in, out, picked); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if _, done := picked[name]; done {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if e, ok := in.get(name); ok {
|
|
||||||
out.add(e)
|
|
||||||
picked[name] = struct{}{}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type entry struct {
|
|
||||||
header *tar.Header
|
|
||||||
payload io.ReadSeeker
|
|
||||||
}
|
|
||||||
|
|
||||||
type tarFile struct {
|
|
||||||
index map[string]*entry
|
|
||||||
stream []*entry
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *tarFile) add(e *entry) {
|
|
||||||
if f.index == nil {
|
|
||||||
f.index = make(map[string]*entry)
|
|
||||||
}
|
|
||||||
f.index[cleanEntryName(e.header.Name)] = e
|
|
||||||
f.stream = append(f.stream, e)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *tarFile) remove(name string) {
|
|
||||||
name = cleanEntryName(name)
|
|
||||||
if f.index != nil {
|
|
||||||
delete(f.index, name)
|
|
||||||
}
|
|
||||||
var filtered []*entry
|
|
||||||
for _, e := range f.stream {
|
|
||||||
if cleanEntryName(e.header.Name) == name {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
filtered = append(filtered, e)
|
|
||||||
}
|
|
||||||
f.stream = filtered
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *tarFile) get(name string) (e *entry, ok bool) {
|
|
||||||
if f.index == nil {
|
|
||||||
return nil, false
|
|
||||||
}
|
|
||||||
e, ok = f.index[cleanEntryName(name)]
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *tarFile) dump(skip map[string]struct{}) []*entry {
|
|
||||||
if len(skip) == 0 {
|
|
||||||
return f.stream
|
|
||||||
}
|
|
||||||
var out []*entry
|
|
||||||
for _, e := range f.stream {
|
|
||||||
if _, ok := skip[cleanEntryName(e.header.Name)]; ok {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
out = append(out, e)
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
type readCloser struct {
|
|
||||||
io.Reader
|
|
||||||
closeFunc func() error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (rc readCloser) Close() error {
|
|
||||||
return rc.closeFunc()
|
|
||||||
}
|
|
||||||
|
|
||||||
func fileSectionReader(file *os.File) (*io.SectionReader, error) {
|
|
||||||
info, err := file.Stat()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return io.NewSectionReader(file, 0, info.Size()), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTempFiles() *tempFiles {
|
|
||||||
return &tempFiles{}
|
|
||||||
}
|
|
||||||
|
|
||||||
type tempFiles struct {
|
|
||||||
files []*os.File
|
|
||||||
filesMu sync.Mutex
|
|
||||||
cleanupOnce sync.Once
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tf *tempFiles) TempFile(dir, pattern string) (*os.File, error) {
|
|
||||||
f, err := os.CreateTemp(dir, pattern)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
tf.filesMu.Lock()
|
|
||||||
tf.files = append(tf.files, f)
|
|
||||||
tf.filesMu.Unlock()
|
|
||||||
return f, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tf *tempFiles) CleanupAll() (err error) {
|
|
||||||
tf.cleanupOnce.Do(func() {
|
|
||||||
err = tf.cleanupAll()
|
|
||||||
})
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (tf *tempFiles) cleanupAll() error {
|
|
||||||
tf.filesMu.Lock()
|
|
||||||
defer tf.filesMu.Unlock()
|
|
||||||
var allErr []error
|
|
||||||
for _, f := range tf.files {
|
|
||||||
if err := f.Close(); err != nil {
|
|
||||||
allErr = append(allErr, err)
|
|
||||||
}
|
|
||||||
if err := os.Remove(f.Name()); err != nil {
|
|
||||||
allErr = append(allErr, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
tf.files = nil
|
|
||||||
return errorutil.Aggregate(allErr)
|
|
||||||
}
|
|
||||||
|
|
||||||
func newCountReadSeeker(r io.ReaderAt) (*countReadSeeker, error) {
|
|
||||||
pos := int64(0)
|
|
||||||
return &countReadSeeker{r: r, cPos: &pos}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type countReadSeeker struct {
|
|
||||||
r io.ReaderAt
|
|
||||||
cPos *int64
|
|
||||||
|
|
||||||
mu sync.Mutex
|
|
||||||
}
|
|
||||||
|
|
||||||
func (cr *countReadSeeker) Read(p []byte) (int, error) {
|
|
||||||
cr.mu.Lock()
|
|
||||||
defer cr.mu.Unlock()
|
|
||||||
|
|
||||||
n, err := cr.r.ReadAt(p, *cr.cPos)
|
|
||||||
if err == nil {
|
|
||||||
*cr.cPos += int64(n)
|
|
||||||
}
|
|
||||||
return n, err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (cr *countReadSeeker) Seek(offset int64, whence int) (int64, error) {
|
|
||||||
cr.mu.Lock()
|
|
||||||
defer cr.mu.Unlock()
|
|
||||||
|
|
||||||
switch whence {
|
|
||||||
default:
|
|
||||||
return 0, fmt.Errorf("unknown whence: %v", whence)
|
|
||||||
case io.SeekStart:
|
|
||||||
case io.SeekCurrent:
|
|
||||||
offset += *cr.cPos
|
|
||||||
case io.SeekEnd:
|
|
||||||
return 0, fmt.Errorf("unsupported whence: %v", whence)
|
|
||||||
}
|
|
||||||
|
|
||||||
if offset < 0 {
|
|
||||||
return 0, fmt.Errorf("invalid offset")
|
|
||||||
}
|
|
||||||
*cr.cPos = offset
|
|
||||||
return offset, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (cr *countReadSeeker) currentPos() int64 {
|
|
||||||
cr.mu.Lock()
|
|
||||||
defer cr.mu.Unlock()
|
|
||||||
|
|
||||||
return *cr.cPos
|
|
||||||
}
|
|
||||||
|
|
||||||
func decompressBlob(org *io.SectionReader, tmp *tempFiles, gzipHelperFunc GzipHelperFunc) (*io.SectionReader, error) {
|
|
||||||
if org.Size() < 4 {
|
|
||||||
return org, nil
|
|
||||||
}
|
|
||||||
src := make([]byte, 4)
|
|
||||||
if _, err := org.Read(src); err != nil && err != io.EOF {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
var dR io.Reader
|
|
||||||
if bytes.Equal([]byte{0x1F, 0x8B, 0x08}, src[:3]) {
|
|
||||||
// gzip
|
|
||||||
var dgR io.ReadCloser
|
|
||||||
var err error
|
|
||||||
if gzipHelperFunc != nil {
|
|
||||||
dgR, err = gzipHelperFunc(io.NewSectionReader(org, 0, org.Size()))
|
|
||||||
} else {
|
|
||||||
dgR, err = gzip.NewReader(io.NewSectionReader(org, 0, org.Size()))
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer dgR.Close()
|
|
||||||
dR = io.Reader(dgR)
|
|
||||||
} else if bytes.Equal([]byte{0x28, 0xb5, 0x2f, 0xfd}, src[:4]) {
|
|
||||||
// zstd
|
|
||||||
dzR, err := zstd.NewReader(io.NewSectionReader(org, 0, org.Size()))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer dzR.Close()
|
|
||||||
dR = io.Reader(dzR)
|
|
||||||
} else {
|
|
||||||
// uncompressed
|
|
||||||
return io.NewSectionReader(org, 0, org.Size()), nil
|
|
||||||
}
|
|
||||||
b, err := tmp.TempFile("", "uncompresseddata")
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if _, err := io.Copy(b, dR); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return fileSectionReader(b)
|
|
||||||
}
|
|
||||||
-40
@@ -1,40 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The containerd 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 errorutil
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Aggregate combines a list of errors into a single new error.
|
|
||||||
func Aggregate(errs []error) error {
|
|
||||||
switch len(errs) {
|
|
||||||
case 0:
|
|
||||||
return nil
|
|
||||||
case 1:
|
|
||||||
return errs[0]
|
|
||||||
default:
|
|
||||||
points := make([]string, len(errs)+1)
|
|
||||||
points[0] = fmt.Sprintf("%d error(s) occurred:", len(errs))
|
|
||||||
for i, err := range errs {
|
|
||||||
points[i+1] = fmt.Sprintf("* %s", err)
|
|
||||||
}
|
|
||||||
return errors.New(strings.Join(points, "\n\t"))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-1232
File diff suppressed because it is too large
Load Diff
-237
@@ -1,237 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The containerd 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Copyright 2019 The Go Authors. All rights reserved.
|
|
||||||
Use of this source code is governed by a BSD-style
|
|
||||||
license that can be found in the LICENSE file.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package estargz
|
|
||||||
|
|
||||||
import (
|
|
||||||
"archive/tar"
|
|
||||||
"bytes"
|
|
||||||
"compress/gzip"
|
|
||||||
"encoding/binary"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"hash"
|
|
||||||
"io"
|
|
||||||
"strconv"
|
|
||||||
|
|
||||||
digest "github.com/opencontainers/go-digest"
|
|
||||||
)
|
|
||||||
|
|
||||||
type gzipCompression struct {
|
|
||||||
*GzipCompressor
|
|
||||||
*GzipDecompressor
|
|
||||||
}
|
|
||||||
|
|
||||||
func newGzipCompressionWithLevel(level int) Compression {
|
|
||||||
return &gzipCompression{
|
|
||||||
&GzipCompressor{level},
|
|
||||||
&GzipDecompressor{},
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewGzipCompressor() *GzipCompressor {
|
|
||||||
return &GzipCompressor{gzip.BestCompression}
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewGzipCompressorWithLevel(level int) *GzipCompressor {
|
|
||||||
return &GzipCompressor{level}
|
|
||||||
}
|
|
||||||
|
|
||||||
type GzipCompressor struct {
|
|
||||||
compressionLevel int
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gc *GzipCompressor) Writer(w io.Writer) (WriteFlushCloser, error) {
|
|
||||||
return gzip.NewWriterLevel(w, gc.compressionLevel)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gc *GzipCompressor) WriteTOCAndFooter(w io.Writer, off int64, toc *JTOC, diffHash hash.Hash) (digest.Digest, error) {
|
|
||||||
tocJSON, err := json.MarshalIndent(toc, "", "\t")
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
gz, _ := gzip.NewWriterLevel(w, gc.compressionLevel)
|
|
||||||
gw := io.Writer(gz)
|
|
||||||
if diffHash != nil {
|
|
||||||
gw = io.MultiWriter(gz, diffHash)
|
|
||||||
}
|
|
||||||
tw := tar.NewWriter(gw)
|
|
||||||
if err := tw.WriteHeader(&tar.Header{
|
|
||||||
Typeflag: tar.TypeReg,
|
|
||||||
Name: TOCTarName,
|
|
||||||
Size: int64(len(tocJSON)),
|
|
||||||
}); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if _, err := tw.Write(tocJSON); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tw.Close(); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if err := gz.Close(); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if _, err := w.Write(gzipFooterBytes(off)); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return digest.FromBytes(tocJSON), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// gzipFooterBytes returns the 51 bytes footer.
|
|
||||||
func gzipFooterBytes(tocOff int64) []byte {
|
|
||||||
buf := bytes.NewBuffer(make([]byte, 0, FooterSize))
|
|
||||||
gz, _ := gzip.NewWriterLevel(buf, gzip.NoCompression) // MUST be NoCompression to keep 51 bytes
|
|
||||||
|
|
||||||
// Extra header indicating the offset of TOCJSON
|
|
||||||
// https://tools.ietf.org/html/rfc1952#section-2.3.1.1
|
|
||||||
header := make([]byte, 4)
|
|
||||||
header[0], header[1] = 'S', 'G'
|
|
||||||
subfield := fmt.Sprintf("%016xSTARGZ", tocOff)
|
|
||||||
binary.LittleEndian.PutUint16(header[2:4], uint16(len(subfield))) // little-endian per RFC1952
|
|
||||||
gz.Extra = append(header, []byte(subfield)...)
|
|
||||||
gz.Close()
|
|
||||||
if buf.Len() != FooterSize {
|
|
||||||
panic(fmt.Sprintf("footer buffer = %d, not %d", buf.Len(), FooterSize))
|
|
||||||
}
|
|
||||||
return buf.Bytes()
|
|
||||||
}
|
|
||||||
|
|
||||||
type GzipDecompressor struct{}
|
|
||||||
|
|
||||||
func (gz *GzipDecompressor) Reader(r io.Reader) (io.ReadCloser, error) {
|
|
||||||
return gzip.NewReader(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *GzipDecompressor) ParseTOC(r io.Reader) (toc *JTOC, tocDgst digest.Digest, err error) {
|
|
||||||
return parseTOCEStargz(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *GzipDecompressor) ParseFooter(p []byte) (blobPayloadSize, tocOffset, tocSize int64, err error) {
|
|
||||||
if len(p) != FooterSize {
|
|
||||||
return 0, 0, 0, fmt.Errorf("invalid length %d cannot be parsed", len(p))
|
|
||||||
}
|
|
||||||
zr, err := gzip.NewReader(bytes.NewReader(p))
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, 0, err
|
|
||||||
}
|
|
||||||
defer zr.Close()
|
|
||||||
extra := zr.Extra
|
|
||||||
si1, si2, subfieldlen, subfield := extra[0], extra[1], extra[2:4], extra[4:]
|
|
||||||
if si1 != 'S' || si2 != 'G' {
|
|
||||||
return 0, 0, 0, fmt.Errorf("invalid subfield IDs: %q, %q; want E, S", si1, si2)
|
|
||||||
}
|
|
||||||
if slen := binary.LittleEndian.Uint16(subfieldlen); slen != uint16(16+len("STARGZ")) {
|
|
||||||
return 0, 0, 0, fmt.Errorf("invalid length of subfield %d; want %d", slen, 16+len("STARGZ"))
|
|
||||||
}
|
|
||||||
if string(subfield[16:]) != "STARGZ" {
|
|
||||||
return 0, 0, 0, fmt.Errorf("STARGZ magic string must be included in the footer subfield")
|
|
||||||
}
|
|
||||||
tocOffset, err = strconv.ParseInt(string(subfield[:16]), 16, 64)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: failed to parse toc offset: %w", err)
|
|
||||||
}
|
|
||||||
return tocOffset, tocOffset, 0, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *GzipDecompressor) FooterSize() int64 {
|
|
||||||
return FooterSize
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *GzipDecompressor) DecompressTOC(r io.Reader) (tocJSON io.ReadCloser, err error) {
|
|
||||||
return decompressTOCEStargz(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
type LegacyGzipDecompressor struct{}
|
|
||||||
|
|
||||||
func (gz *LegacyGzipDecompressor) Reader(r io.Reader) (io.ReadCloser, error) {
|
|
||||||
return gzip.NewReader(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *LegacyGzipDecompressor) ParseTOC(r io.Reader) (toc *JTOC, tocDgst digest.Digest, err error) {
|
|
||||||
return parseTOCEStargz(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *LegacyGzipDecompressor) ParseFooter(p []byte) (blobPayloadSize, tocOffset, tocSize int64, err error) {
|
|
||||||
if len(p) != legacyFooterSize {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: invalid length %d cannot be parsed", len(p))
|
|
||||||
}
|
|
||||||
zr, err := gzip.NewReader(bytes.NewReader(p))
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: failed to get footer gzip reader: %w", err)
|
|
||||||
}
|
|
||||||
defer zr.Close()
|
|
||||||
extra := zr.Extra
|
|
||||||
if len(extra) != 16+len("STARGZ") {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: invalid stargz's extra field size")
|
|
||||||
}
|
|
||||||
if string(extra[16:]) != "STARGZ" {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: magic string STARGZ not found")
|
|
||||||
}
|
|
||||||
tocOffset, err = strconv.ParseInt(string(extra[:16]), 16, 64)
|
|
||||||
if err != nil {
|
|
||||||
return 0, 0, 0, fmt.Errorf("legacy: failed to parse toc offset: %w", err)
|
|
||||||
}
|
|
||||||
return tocOffset, tocOffset, 0, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *LegacyGzipDecompressor) FooterSize() int64 {
|
|
||||||
return legacyFooterSize
|
|
||||||
}
|
|
||||||
|
|
||||||
func (gz *LegacyGzipDecompressor) DecompressTOC(r io.Reader) (tocJSON io.ReadCloser, err error) {
|
|
||||||
return decompressTOCEStargz(r)
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseTOCEStargz(r io.Reader) (toc *JTOC, tocDgst digest.Digest, err error) {
|
|
||||||
tr, err := decompressTOCEStargz(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
dgstr := digest.Canonical.Digester()
|
|
||||||
toc = new(JTOC)
|
|
||||||
if err := json.NewDecoder(io.TeeReader(tr, dgstr.Hash())).Decode(&toc); err != nil {
|
|
||||||
return nil, "", fmt.Errorf("error decoding TOC JSON: %v", err)
|
|
||||||
}
|
|
||||||
if err := tr.Close(); err != nil {
|
|
||||||
return nil, "", err
|
|
||||||
}
|
|
||||||
return toc, dgstr.Digest(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func decompressTOCEStargz(r io.Reader) (tocJSON io.ReadCloser, err error) {
|
|
||||||
zr, err := gzip.NewReader(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("malformed TOC gzip header: %v", err)
|
|
||||||
}
|
|
||||||
zr.Multistream(false)
|
|
||||||
tr := tar.NewReader(zr)
|
|
||||||
h, err := tr.Next()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("failed to find tar header in TOC gzip stream: %v", err)
|
|
||||||
}
|
|
||||||
if h.Name != TOCTarName {
|
|
||||||
return nil, fmt.Errorf("TOC tar entry had name %q; expected %q", h.Name, TOCTarName)
|
|
||||||
}
|
|
||||||
return readCloser{tr, zr.Close}, nil
|
|
||||||
}
|
|
||||||
-2403
File diff suppressed because it is too large
Load Diff
-342
@@ -1,342 +0,0 @@
|
|||||||
/*
|
|
||||||
Copyright The containerd 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.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Copyright 2019 The Go Authors. All rights reserved.
|
|
||||||
Use of this source code is governed by a BSD-style
|
|
||||||
license that can be found in the LICENSE file.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package estargz
|
|
||||||
|
|
||||||
import (
|
|
||||||
"archive/tar"
|
|
||||||
"hash"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
digest "github.com/opencontainers/go-digest"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// TOCTarName is the name of the JSON file in the tar archive in the
|
|
||||||
// table of contents gzip stream.
|
|
||||||
TOCTarName = "stargz.index.json"
|
|
||||||
|
|
||||||
// FooterSize is the number of bytes in the footer
|
|
||||||
//
|
|
||||||
// The footer is an empty gzip stream with no compression and an Extra
|
|
||||||
// header of the form "%016xSTARGZ", where the 64 bit hex-encoded
|
|
||||||
// number is the offset to the gzip stream of JSON TOC.
|
|
||||||
//
|
|
||||||
// 51 comes from:
|
|
||||||
//
|
|
||||||
// 10 bytes gzip header
|
|
||||||
// 2 bytes XLEN (length of Extra field) = 26 (4 bytes header + 16 hex digits + len("STARGZ"))
|
|
||||||
// 2 bytes Extra: SI1 = 'S', SI2 = 'G'
|
|
||||||
// 2 bytes Extra: LEN = 22 (16 hex digits + len("STARGZ"))
|
|
||||||
// 22 bytes Extra: subfield = fmt.Sprintf("%016xSTARGZ", offsetOfTOC)
|
|
||||||
// 5 bytes flate header
|
|
||||||
// 8 bytes gzip footer
|
|
||||||
// (End of the eStargz blob)
|
|
||||||
//
|
|
||||||
// NOTE: For Extra fields, subfield IDs SI1='S' SI2='G' is used for eStargz.
|
|
||||||
FooterSize = 51
|
|
||||||
|
|
||||||
// legacyFooterSize is the number of bytes in the legacy stargz footer.
|
|
||||||
//
|
|
||||||
// 47 comes from:
|
|
||||||
//
|
|
||||||
// 10 byte gzip header +
|
|
||||||
// 2 byte (LE16) length of extra, encoding 22 (16 hex digits + len("STARGZ")) == "\x16\x00" +
|
|
||||||
// 22 bytes of extra (fmt.Sprintf("%016xSTARGZ", tocGzipOffset))
|
|
||||||
// 5 byte flate header
|
|
||||||
// 8 byte gzip footer (two little endian uint32s: digest, size)
|
|
||||||
legacyFooterSize = 47
|
|
||||||
|
|
||||||
// TOCJSONDigestAnnotation is an annotation for an image layer. This stores the
|
|
||||||
// digest of the TOC JSON.
|
|
||||||
// This annotation is valid only when it is specified in `.[]layers.annotations`
|
|
||||||
// of an image manifest.
|
|
||||||
TOCJSONDigestAnnotation = "containerd.io/snapshot/stargz/toc.digest"
|
|
||||||
|
|
||||||
// StoreUncompressedSizeAnnotation is an additional annotation key for eStargz to enable lazy
|
|
||||||
// pulling on containers/storage. Stargz Store is required to expose the layer's uncompressed size
|
|
||||||
// to the runtime but current OCI image doesn't ship this information by default. So we store this
|
|
||||||
// to the special annotation.
|
|
||||||
StoreUncompressedSizeAnnotation = "io.containers.estargz.uncompressed-size"
|
|
||||||
|
|
||||||
// PrefetchLandmark is a file entry which indicates the end position of
|
|
||||||
// prefetch in the stargz file.
|
|
||||||
PrefetchLandmark = ".prefetch.landmark"
|
|
||||||
|
|
||||||
// NoPrefetchLandmark is a file entry which indicates that no prefetch should
|
|
||||||
// occur in the stargz file.
|
|
||||||
NoPrefetchLandmark = ".no.prefetch.landmark"
|
|
||||||
|
|
||||||
landmarkContents = 0xf
|
|
||||||
)
|
|
||||||
|
|
||||||
// JTOC is the JSON-serialized table of contents index of the files in the stargz file.
|
|
||||||
type JTOC struct {
|
|
||||||
Version int `json:"version"`
|
|
||||||
Entries []*TOCEntry `json:"entries"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// TOCEntry is an entry in the stargz file's TOC (Table of Contents).
|
|
||||||
type TOCEntry struct {
|
|
||||||
// Name is the tar entry's name. It is the complete path
|
|
||||||
// stored in the tar file, not just the base name.
|
|
||||||
Name string `json:"name"`
|
|
||||||
|
|
||||||
// Type is one of "dir", "reg", "symlink", "hardlink", "char",
|
|
||||||
// "block", "fifo", or "chunk".
|
|
||||||
// The "chunk" type is used for regular file data chunks past the first
|
|
||||||
// TOCEntry; the 2nd chunk and on have only Type ("chunk"), Offset,
|
|
||||||
// ChunkOffset, and ChunkSize populated.
|
|
||||||
Type string `json:"type"`
|
|
||||||
|
|
||||||
// Size, for regular files, is the logical size of the file.
|
|
||||||
Size int64 `json:"size,omitempty"`
|
|
||||||
|
|
||||||
// ModTime3339 is the modification time of the tar entry. Empty
|
|
||||||
// means zero or unknown. Otherwise it's in UTC RFC3339
|
|
||||||
// format. Use the ModTime method to access the time.Time value.
|
|
||||||
ModTime3339 string `json:"modtime,omitempty"`
|
|
||||||
modTime time.Time
|
|
||||||
|
|
||||||
// LinkName, for symlinks and hardlinks, is the link target.
|
|
||||||
LinkName string `json:"linkName,omitempty"`
|
|
||||||
|
|
||||||
// Mode is the permission and mode bits.
|
|
||||||
Mode int64 `json:"mode,omitempty"`
|
|
||||||
|
|
||||||
// UID is the user ID of the owner.
|
|
||||||
UID int `json:"uid,omitempty"`
|
|
||||||
|
|
||||||
// GID is the group ID of the owner.
|
|
||||||
GID int `json:"gid,omitempty"`
|
|
||||||
|
|
||||||
// Uname is the username of the owner.
|
|
||||||
//
|
|
||||||
// In the serialized JSON, this field may only be present for
|
|
||||||
// the first entry with the same UID.
|
|
||||||
Uname string `json:"userName,omitempty"`
|
|
||||||
|
|
||||||
// Gname is the group name of the owner.
|
|
||||||
//
|
|
||||||
// In the serialized JSON, this field may only be present for
|
|
||||||
// the first entry with the same GID.
|
|
||||||
Gname string `json:"groupName,omitempty"`
|
|
||||||
|
|
||||||
// Offset, for regular files, provides the offset in the
|
|
||||||
// stargz file to the file's data bytes. See ChunkOffset and
|
|
||||||
// ChunkSize.
|
|
||||||
Offset int64 `json:"offset,omitempty"`
|
|
||||||
|
|
||||||
// InnerOffset is an optional field indicates uncompressed offset
|
|
||||||
// of this "reg" or "chunk" payload in a stream starts from Offset.
|
|
||||||
// This field enables to put multiple "reg" or "chunk" payloads
|
|
||||||
// in one chunk with having the same Offset but different InnerOffset.
|
|
||||||
InnerOffset int64 `json:"innerOffset,omitempty"`
|
|
||||||
|
|
||||||
nextOffset int64 // the Offset of the next entry with a non-zero Offset
|
|
||||||
|
|
||||||
// DevMajor is the major device number for "char" and "block" types.
|
|
||||||
DevMajor int `json:"devMajor,omitempty"`
|
|
||||||
|
|
||||||
// DevMinor is the major device number for "char" and "block" types.
|
|
||||||
DevMinor int `json:"devMinor,omitempty"`
|
|
||||||
|
|
||||||
// NumLink is the number of entry names pointing to this entry.
|
|
||||||
// Zero means one name references this entry.
|
|
||||||
// This field is calculated during runtime and not recorded in TOC JSON.
|
|
||||||
NumLink int `json:"-"`
|
|
||||||
|
|
||||||
// Xattrs are the extended attribute for the entry.
|
|
||||||
Xattrs map[string][]byte `json:"xattrs,omitempty"`
|
|
||||||
|
|
||||||
// Digest stores the OCI checksum for regular files payload.
|
|
||||||
// It has the form "sha256:abcdef01234....".
|
|
||||||
Digest string `json:"digest,omitempty"`
|
|
||||||
|
|
||||||
// ChunkOffset is non-zero if this is a chunk of a large,
|
|
||||||
// regular file. If so, the Offset is where the gzip header of
|
|
||||||
// ChunkSize bytes at ChunkOffset in Name begin.
|
|
||||||
//
|
|
||||||
// In serialized form, a "chunkSize" JSON field of zero means
|
|
||||||
// that the chunk goes to the end of the file. After reading
|
|
||||||
// from the stargz TOC, though, the ChunkSize is initialized
|
|
||||||
// to a non-zero file for when Type is either "reg" or
|
|
||||||
// "chunk".
|
|
||||||
ChunkOffset int64 `json:"chunkOffset,omitempty"`
|
|
||||||
ChunkSize int64 `json:"chunkSize,omitempty"`
|
|
||||||
|
|
||||||
// ChunkDigest stores an OCI digest of the chunk. This must be formed
|
|
||||||
// as "sha256:0123abcd...".
|
|
||||||
ChunkDigest string `json:"chunkDigest,omitempty"`
|
|
||||||
|
|
||||||
children map[string]*TOCEntry
|
|
||||||
|
|
||||||
// chunkTopIndex is index of the entry where Offset starts in the blob.
|
|
||||||
chunkTopIndex int
|
|
||||||
}
|
|
||||||
|
|
||||||
// ModTime returns the entry's modification time.
|
|
||||||
func (e *TOCEntry) ModTime() time.Time { return e.modTime }
|
|
||||||
|
|
||||||
// NextOffset returns the position (relative to the start of the
|
|
||||||
// stargz file) of the next gzip boundary after e.Offset.
|
|
||||||
func (e *TOCEntry) NextOffset() int64 { return e.nextOffset }
|
|
||||||
|
|
||||||
func (e *TOCEntry) addChild(baseName string, child *TOCEntry) {
|
|
||||||
if e.children == nil {
|
|
||||||
e.children = make(map[string]*TOCEntry)
|
|
||||||
}
|
|
||||||
if child.Type == "dir" {
|
|
||||||
e.NumLink++ // Entry ".." in the subdirectory links to this directory
|
|
||||||
}
|
|
||||||
e.children[baseName] = child
|
|
||||||
}
|
|
||||||
|
|
||||||
// isDataType reports whether TOCEntry is a regular file or chunk (something that
|
|
||||||
// contains regular file data).
|
|
||||||
func (e *TOCEntry) isDataType() bool { return e.Type == "reg" || e.Type == "chunk" }
|
|
||||||
|
|
||||||
// Stat returns a FileInfo value representing e.
|
|
||||||
func (e *TOCEntry) Stat() os.FileInfo { return fileInfo{e} }
|
|
||||||
|
|
||||||
// ForeachChild calls f for each child item. If f returns false, iteration ends.
|
|
||||||
// If e is not a directory, f is not called.
|
|
||||||
func (e *TOCEntry) ForeachChild(f func(baseName string, ent *TOCEntry) bool) {
|
|
||||||
for name, ent := range e.children {
|
|
||||||
if !f(name, ent) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// LookupChild returns the directory e's child by its base name.
|
|
||||||
func (e *TOCEntry) LookupChild(baseName string) (child *TOCEntry, ok bool) {
|
|
||||||
child, ok = e.children[baseName]
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// fileInfo implements os.FileInfo using the wrapped *TOCEntry.
|
|
||||||
type fileInfo struct{ e *TOCEntry }
|
|
||||||
|
|
||||||
var _ os.FileInfo = fileInfo{}
|
|
||||||
|
|
||||||
func (fi fileInfo) Name() string { return path.Base(fi.e.Name) }
|
|
||||||
func (fi fileInfo) IsDir() bool { return fi.e.Type == "dir" }
|
|
||||||
func (fi fileInfo) Size() int64 { return fi.e.Size }
|
|
||||||
func (fi fileInfo) ModTime() time.Time { return fi.e.ModTime() }
|
|
||||||
func (fi fileInfo) Sys() interface{} { return fi.e }
|
|
||||||
func (fi fileInfo) Mode() (m os.FileMode) {
|
|
||||||
// TOCEntry.Mode is tar.Header.Mode so we can understand the these bits using `tar` pkg.
|
|
||||||
m = (&tar.Header{Mode: fi.e.Mode}).FileInfo().Mode() &
|
|
||||||
(os.ModePerm | os.ModeSetuid | os.ModeSetgid | os.ModeSticky)
|
|
||||||
switch fi.e.Type {
|
|
||||||
case "dir":
|
|
||||||
m |= os.ModeDir
|
|
||||||
case "symlink":
|
|
||||||
m |= os.ModeSymlink
|
|
||||||
case "char":
|
|
||||||
m |= os.ModeDevice | os.ModeCharDevice
|
|
||||||
case "block":
|
|
||||||
m |= os.ModeDevice
|
|
||||||
case "fifo":
|
|
||||||
m |= os.ModeNamedPipe
|
|
||||||
}
|
|
||||||
return m
|
|
||||||
}
|
|
||||||
|
|
||||||
// TOCEntryVerifier holds verifiers that are usable for verifying chunks contained
|
|
||||||
// in a eStargz blob.
|
|
||||||
type TOCEntryVerifier interface {
|
|
||||||
|
|
||||||
// Verifier provides a content verifier that can be used for verifying the
|
|
||||||
// contents of the specified TOCEntry.
|
|
||||||
Verifier(ce *TOCEntry) (digest.Verifier, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Compression provides the compression helper to be used creating and parsing eStargz.
|
|
||||||
// This package provides gzip-based Compression by default, but any compression
|
|
||||||
// algorithm (e.g. zstd) can be used as long as it implements Compression.
|
|
||||||
type Compression interface {
|
|
||||||
Compressor
|
|
||||||
Decompressor
|
|
||||||
}
|
|
||||||
|
|
||||||
// Compressor represents the helper mothods to be used for creating eStargz.
|
|
||||||
type Compressor interface {
|
|
||||||
// Writer returns WriteCloser to be used for writing a chunk to eStargz.
|
|
||||||
// Everytime a chunk is written, the WriteCloser is closed and Writer is
|
|
||||||
// called again for writing the next chunk.
|
|
||||||
//
|
|
||||||
// The returned writer should implement "Flush() error" function that flushes
|
|
||||||
// any pending compressed data to the underlying writer.
|
|
||||||
Writer(w io.Writer) (WriteFlushCloser, error)
|
|
||||||
|
|
||||||
// WriteTOCAndFooter is called to write JTOC to the passed Writer.
|
|
||||||
// diffHash calculates the DiffID (uncompressed sha256 hash) of the blob
|
|
||||||
// WriteTOCAndFooter can optionally write anything that affects DiffID calculation
|
|
||||||
// (e.g. uncompressed TOC JSON).
|
|
||||||
//
|
|
||||||
// This function returns tocDgst that represents the digest of TOC that will be used
|
|
||||||
// to verify this blob when it's parsed.
|
|
||||||
WriteTOCAndFooter(w io.Writer, off int64, toc *JTOC, diffHash hash.Hash) (tocDgst digest.Digest, err error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Decompressor represents the helper mothods to be used for parsing eStargz.
|
|
||||||
type Decompressor interface {
|
|
||||||
// Reader returns ReadCloser to be used for decompressing file payload.
|
|
||||||
Reader(r io.Reader) (io.ReadCloser, error)
|
|
||||||
|
|
||||||
// FooterSize returns the size of the footer of this blob.
|
|
||||||
FooterSize() int64
|
|
||||||
|
|
||||||
// ParseFooter parses the footer and returns the offset and (compressed) size of TOC.
|
|
||||||
// payloadBlobSize is the (compressed) size of the blob payload (i.e. the size between
|
|
||||||
// the top until the TOC JSON).
|
|
||||||
//
|
|
||||||
// If tocOffset < 0, we assume that TOC isn't contained in the blob and pass nil reader
|
|
||||||
// to ParseTOC. We expect that ParseTOC acquire TOC from the external location and return it.
|
|
||||||
//
|
|
||||||
// tocSize is optional. If tocSize <= 0, it's by default the size of the range from tocOffset until the beginning of the
|
|
||||||
// footer (blob size - tocOff - FooterSize).
|
|
||||||
// If blobPayloadSize < 0, blobPayloadSize become the blob size.
|
|
||||||
ParseFooter(p []byte) (blobPayloadSize, tocOffset, tocSize int64, err error)
|
|
||||||
|
|
||||||
// ParseTOC parses TOC from the passed reader. The reader provides the partial contents
|
|
||||||
// of the underlying blob that has the range specified by ParseFooter method.
|
|
||||||
//
|
|
||||||
// This function returns tocDgst that represents the digest of TOC that will be used
|
|
||||||
// to verify this blob. This must match to the value returned from
|
|
||||||
// Compressor.WriteTOCAndFooter that is used when creating this blob.
|
|
||||||
//
|
|
||||||
// If tocOffset returned by ParseFooter is < 0, we assume that TOC isn't contained in the blob.
|
|
||||||
// Pass nil reader to ParseTOC then we expect that ParseTOC acquire TOC from the external location
|
|
||||||
// and return it.
|
|
||||||
ParseTOC(r io.Reader) (toc *JTOC, tocDgst digest.Digest, err error)
|
|
||||||
}
|
|
||||||
|
|
||||||
type WriteFlushCloser interface {
|
|
||||||
io.WriteCloser
|
|
||||||
Flush() error
|
|
||||||
}
|
|
||||||
-15
@@ -1,15 +0,0 @@
|
|||||||
ISC License
|
|
||||||
|
|
||||||
Copyright (c) 2012-2016 Dave Collins <dave@davec.name>
|
|
||||||
|
|
||||||
Permission to use, copy, modify, and/or distribute this software for any
|
|
||||||
purpose with or without fee is hereby granted, provided that the above
|
|
||||||
copyright notice and this permission notice appear in all copies.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
-145
@@ -1,145 +0,0 @@
|
|||||||
// Copyright (c) 2015-2016 Dave Collins <dave@davec.name>
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, and distribute this software for any
|
|
||||||
// purpose with or without fee is hereby granted, provided that the above
|
|
||||||
// copyright notice and this permission notice appear in all copies.
|
|
||||||
//
|
|
||||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
|
|
||||||
// NOTE: Due to the following build constraints, this file will only be compiled
|
|
||||||
// when the code is not running on Google App Engine, compiled by GopherJS, and
|
|
||||||
// "-tags safe" is not added to the go build command line. The "disableunsafe"
|
|
||||||
// tag is deprecated and thus should not be used.
|
|
||||||
// Go versions prior to 1.4 are disabled because they use a different layout
|
|
||||||
// for interfaces which make the implementation of unsafeReflectValue more complex.
|
|
||||||
// +build !js,!appengine,!safe,!disableunsafe,go1.4
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"reflect"
|
|
||||||
"unsafe"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// UnsafeDisabled is a build-time constant which specifies whether or
|
|
||||||
// not access to the unsafe package is available.
|
|
||||||
UnsafeDisabled = false
|
|
||||||
|
|
||||||
// ptrSize is the size of a pointer on the current arch.
|
|
||||||
ptrSize = unsafe.Sizeof((*byte)(nil))
|
|
||||||
)
|
|
||||||
|
|
||||||
type flag uintptr
|
|
||||||
|
|
||||||
var (
|
|
||||||
// flagRO indicates whether the value field of a reflect.Value
|
|
||||||
// is read-only.
|
|
||||||
flagRO flag
|
|
||||||
|
|
||||||
// flagAddr indicates whether the address of the reflect.Value's
|
|
||||||
// value may be taken.
|
|
||||||
flagAddr flag
|
|
||||||
)
|
|
||||||
|
|
||||||
// flagKindMask holds the bits that make up the kind
|
|
||||||
// part of the flags field. In all the supported versions,
|
|
||||||
// it is in the lower 5 bits.
|
|
||||||
const flagKindMask = flag(0x1f)
|
|
||||||
|
|
||||||
// Different versions of Go have used different
|
|
||||||
// bit layouts for the flags type. This table
|
|
||||||
// records the known combinations.
|
|
||||||
var okFlags = []struct {
|
|
||||||
ro, addr flag
|
|
||||||
}{{
|
|
||||||
// From Go 1.4 to 1.5
|
|
||||||
ro: 1 << 5,
|
|
||||||
addr: 1 << 7,
|
|
||||||
}, {
|
|
||||||
// Up to Go tip.
|
|
||||||
ro: 1<<5 | 1<<6,
|
|
||||||
addr: 1 << 8,
|
|
||||||
}}
|
|
||||||
|
|
||||||
var flagValOffset = func() uintptr {
|
|
||||||
field, ok := reflect.TypeOf(reflect.Value{}).FieldByName("flag")
|
|
||||||
if !ok {
|
|
||||||
panic("reflect.Value has no flag field")
|
|
||||||
}
|
|
||||||
return field.Offset
|
|
||||||
}()
|
|
||||||
|
|
||||||
// flagField returns a pointer to the flag field of a reflect.Value.
|
|
||||||
func flagField(v *reflect.Value) *flag {
|
|
||||||
return (*flag)(unsafe.Pointer(uintptr(unsafe.Pointer(v)) + flagValOffset))
|
|
||||||
}
|
|
||||||
|
|
||||||
// unsafeReflectValue converts the passed reflect.Value into a one that bypasses
|
|
||||||
// the typical safety restrictions preventing access to unaddressable and
|
|
||||||
// unexported data. It works by digging the raw pointer to the underlying
|
|
||||||
// value out of the protected value and generating a new unprotected (unsafe)
|
|
||||||
// reflect.Value to it.
|
|
||||||
//
|
|
||||||
// This allows us to check for implementations of the Stringer and error
|
|
||||||
// interfaces to be used for pretty printing ordinarily unaddressable and
|
|
||||||
// inaccessible values such as unexported struct fields.
|
|
||||||
func unsafeReflectValue(v reflect.Value) reflect.Value {
|
|
||||||
if !v.IsValid() || (v.CanInterface() && v.CanAddr()) {
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
flagFieldPtr := flagField(&v)
|
|
||||||
*flagFieldPtr &^= flagRO
|
|
||||||
*flagFieldPtr |= flagAddr
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sanity checks against future reflect package changes
|
|
||||||
// to the type or semantics of the Value.flag field.
|
|
||||||
func init() {
|
|
||||||
field, ok := reflect.TypeOf(reflect.Value{}).FieldByName("flag")
|
|
||||||
if !ok {
|
|
||||||
panic("reflect.Value has no flag field")
|
|
||||||
}
|
|
||||||
if field.Type.Kind() != reflect.TypeOf(flag(0)).Kind() {
|
|
||||||
panic("reflect.Value flag field has changed kind")
|
|
||||||
}
|
|
||||||
type t0 int
|
|
||||||
var t struct {
|
|
||||||
A t0
|
|
||||||
// t0 will have flagEmbedRO set.
|
|
||||||
t0
|
|
||||||
// a will have flagStickyRO set
|
|
||||||
a t0
|
|
||||||
}
|
|
||||||
vA := reflect.ValueOf(t).FieldByName("A")
|
|
||||||
va := reflect.ValueOf(t).FieldByName("a")
|
|
||||||
vt0 := reflect.ValueOf(t).FieldByName("t0")
|
|
||||||
|
|
||||||
// Infer flagRO from the difference between the flags
|
|
||||||
// for the (otherwise identical) fields in t.
|
|
||||||
flagPublic := *flagField(&vA)
|
|
||||||
flagWithRO := *flagField(&va) | *flagField(&vt0)
|
|
||||||
flagRO = flagPublic ^ flagWithRO
|
|
||||||
|
|
||||||
// Infer flagAddr from the difference between a value
|
|
||||||
// taken from a pointer and not.
|
|
||||||
vPtrA := reflect.ValueOf(&t).Elem().FieldByName("A")
|
|
||||||
flagNoPtr := *flagField(&vA)
|
|
||||||
flagPtr := *flagField(&vPtrA)
|
|
||||||
flagAddr = flagNoPtr ^ flagPtr
|
|
||||||
|
|
||||||
// Check that the inferred flags tally with one of the known versions.
|
|
||||||
for _, f := range okFlags {
|
|
||||||
if flagRO == f.ro && flagAddr == f.addr {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
panic("reflect.Value read-only flag has changed semantics")
|
|
||||||
}
|
|
||||||
-38
@@ -1,38 +0,0 @@
|
|||||||
// Copyright (c) 2015-2016 Dave Collins <dave@davec.name>
|
|
||||||
//
|
|
||||||
// Permission to use, copy, modify, and distribute this software for any
|
|
||||||
// purpose with or without fee is hereby granted, provided that the above
|
|
||||||
// copyright notice and this permission notice appear in all copies.
|
|
||||||
//
|
|
||||||
// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
// ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
// ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
// OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
|
|
||||||
// NOTE: Due to the following build constraints, this file will only be compiled
|
|
||||||
// when the code is running on Google App Engine, compiled by GopherJS, or
|
|
||||||
// "-tags safe" is added to the go build command line. The "disableunsafe"
|
|
||||||
// tag is deprecated and thus should not be used.
|
|
||||||
// +build js appengine safe disableunsafe !go1.4
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import "reflect"
|
|
||||||
|
|
||||||
const (
|
|
||||||
// UnsafeDisabled is a build-time constant which specifies whether or
|
|
||||||
// not access to the unsafe package is available.
|
|
||||||
UnsafeDisabled = true
|
|
||||||
)
|
|
||||||
|
|
||||||
// unsafeReflectValue typically converts the passed reflect.Value into a one
|
|
||||||
// that bypasses the typical safety restrictions preventing access to
|
|
||||||
// unaddressable and unexported data. However, doing this relies on access to
|
|
||||||
// the unsafe package. This is a stub version which simply returns the passed
|
|
||||||
// reflect.Value when the unsafe package is not available.
|
|
||||||
func unsafeReflectValue(v reflect.Value) reflect.Value {
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
-341
@@ -1,341 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"reflect"
|
|
||||||
"sort"
|
|
||||||
"strconv"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Some constants in the form of bytes to avoid string overhead. This mirrors
|
|
||||||
// the technique used in the fmt package.
|
|
||||||
var (
|
|
||||||
panicBytes = []byte("(PANIC=")
|
|
||||||
plusBytes = []byte("+")
|
|
||||||
iBytes = []byte("i")
|
|
||||||
trueBytes = []byte("true")
|
|
||||||
falseBytes = []byte("false")
|
|
||||||
interfaceBytes = []byte("(interface {})")
|
|
||||||
commaNewlineBytes = []byte(",\n")
|
|
||||||
newlineBytes = []byte("\n")
|
|
||||||
openBraceBytes = []byte("{")
|
|
||||||
openBraceNewlineBytes = []byte("{\n")
|
|
||||||
closeBraceBytes = []byte("}")
|
|
||||||
asteriskBytes = []byte("*")
|
|
||||||
colonBytes = []byte(":")
|
|
||||||
colonSpaceBytes = []byte(": ")
|
|
||||||
openParenBytes = []byte("(")
|
|
||||||
closeParenBytes = []byte(")")
|
|
||||||
spaceBytes = []byte(" ")
|
|
||||||
pointerChainBytes = []byte("->")
|
|
||||||
nilAngleBytes = []byte("<nil>")
|
|
||||||
maxNewlineBytes = []byte("<max depth reached>\n")
|
|
||||||
maxShortBytes = []byte("<max>")
|
|
||||||
circularBytes = []byte("<already shown>")
|
|
||||||
circularShortBytes = []byte("<shown>")
|
|
||||||
invalidAngleBytes = []byte("<invalid>")
|
|
||||||
openBracketBytes = []byte("[")
|
|
||||||
closeBracketBytes = []byte("]")
|
|
||||||
percentBytes = []byte("%")
|
|
||||||
precisionBytes = []byte(".")
|
|
||||||
openAngleBytes = []byte("<")
|
|
||||||
closeAngleBytes = []byte(">")
|
|
||||||
openMapBytes = []byte("map[")
|
|
||||||
closeMapBytes = []byte("]")
|
|
||||||
lenEqualsBytes = []byte("len=")
|
|
||||||
capEqualsBytes = []byte("cap=")
|
|
||||||
)
|
|
||||||
|
|
||||||
// hexDigits is used to map a decimal value to a hex digit.
|
|
||||||
var hexDigits = "0123456789abcdef"
|
|
||||||
|
|
||||||
// catchPanic handles any panics that might occur during the handleMethods
|
|
||||||
// calls.
|
|
||||||
func catchPanic(w io.Writer, v reflect.Value) {
|
|
||||||
if err := recover(); err != nil {
|
|
||||||
w.Write(panicBytes)
|
|
||||||
fmt.Fprintf(w, "%v", err)
|
|
||||||
w.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleMethods attempts to call the Error and String methods on the underlying
|
|
||||||
// type the passed reflect.Value represents and outputes the result to Writer w.
|
|
||||||
//
|
|
||||||
// It handles panics in any called methods by catching and displaying the error
|
|
||||||
// as the formatted value.
|
|
||||||
func handleMethods(cs *ConfigState, w io.Writer, v reflect.Value) (handled bool) {
|
|
||||||
// We need an interface to check if the type implements the error or
|
|
||||||
// Stringer interface. However, the reflect package won't give us an
|
|
||||||
// interface on certain things like unexported struct fields in order
|
|
||||||
// to enforce visibility rules. We use unsafe, when it's available,
|
|
||||||
// to bypass these restrictions since this package does not mutate the
|
|
||||||
// values.
|
|
||||||
if !v.CanInterface() {
|
|
||||||
if UnsafeDisabled {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
v = unsafeReflectValue(v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Choose whether or not to do error and Stringer interface lookups against
|
|
||||||
// the base type or a pointer to the base type depending on settings.
|
|
||||||
// Technically calling one of these methods with a pointer receiver can
|
|
||||||
// mutate the value, however, types which choose to satisify an error or
|
|
||||||
// Stringer interface with a pointer receiver should not be mutating their
|
|
||||||
// state inside these interface methods.
|
|
||||||
if !cs.DisablePointerMethods && !UnsafeDisabled && !v.CanAddr() {
|
|
||||||
v = unsafeReflectValue(v)
|
|
||||||
}
|
|
||||||
if v.CanAddr() {
|
|
||||||
v = v.Addr()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Is it an error or Stringer?
|
|
||||||
switch iface := v.Interface().(type) {
|
|
||||||
case error:
|
|
||||||
defer catchPanic(w, v)
|
|
||||||
if cs.ContinueOnMethod {
|
|
||||||
w.Write(openParenBytes)
|
|
||||||
w.Write([]byte(iface.Error()))
|
|
||||||
w.Write(closeParenBytes)
|
|
||||||
w.Write(spaceBytes)
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
w.Write([]byte(iface.Error()))
|
|
||||||
return true
|
|
||||||
|
|
||||||
case fmt.Stringer:
|
|
||||||
defer catchPanic(w, v)
|
|
||||||
if cs.ContinueOnMethod {
|
|
||||||
w.Write(openParenBytes)
|
|
||||||
w.Write([]byte(iface.String()))
|
|
||||||
w.Write(closeParenBytes)
|
|
||||||
w.Write(spaceBytes)
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
w.Write([]byte(iface.String()))
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// printBool outputs a boolean value as true or false to Writer w.
|
|
||||||
func printBool(w io.Writer, val bool) {
|
|
||||||
if val {
|
|
||||||
w.Write(trueBytes)
|
|
||||||
} else {
|
|
||||||
w.Write(falseBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// printInt outputs a signed integer value to Writer w.
|
|
||||||
func printInt(w io.Writer, val int64, base int) {
|
|
||||||
w.Write([]byte(strconv.FormatInt(val, base)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// printUint outputs an unsigned integer value to Writer w.
|
|
||||||
func printUint(w io.Writer, val uint64, base int) {
|
|
||||||
w.Write([]byte(strconv.FormatUint(val, base)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// printFloat outputs a floating point value using the specified precision,
|
|
||||||
// which is expected to be 32 or 64bit, to Writer w.
|
|
||||||
func printFloat(w io.Writer, val float64, precision int) {
|
|
||||||
w.Write([]byte(strconv.FormatFloat(val, 'g', -1, precision)))
|
|
||||||
}
|
|
||||||
|
|
||||||
// printComplex outputs a complex value using the specified float precision
|
|
||||||
// for the real and imaginary parts to Writer w.
|
|
||||||
func printComplex(w io.Writer, c complex128, floatPrecision int) {
|
|
||||||
r := real(c)
|
|
||||||
w.Write(openParenBytes)
|
|
||||||
w.Write([]byte(strconv.FormatFloat(r, 'g', -1, floatPrecision)))
|
|
||||||
i := imag(c)
|
|
||||||
if i >= 0 {
|
|
||||||
w.Write(plusBytes)
|
|
||||||
}
|
|
||||||
w.Write([]byte(strconv.FormatFloat(i, 'g', -1, floatPrecision)))
|
|
||||||
w.Write(iBytes)
|
|
||||||
w.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// printHexPtr outputs a uintptr formatted as hexadecimal with a leading '0x'
|
|
||||||
// prefix to Writer w.
|
|
||||||
func printHexPtr(w io.Writer, p uintptr) {
|
|
||||||
// Null pointer.
|
|
||||||
num := uint64(p)
|
|
||||||
if num == 0 {
|
|
||||||
w.Write(nilAngleBytes)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Max uint64 is 16 bytes in hex + 2 bytes for '0x' prefix
|
|
||||||
buf := make([]byte, 18)
|
|
||||||
|
|
||||||
// It's simpler to construct the hex string right to left.
|
|
||||||
base := uint64(16)
|
|
||||||
i := len(buf) - 1
|
|
||||||
for num >= base {
|
|
||||||
buf[i] = hexDigits[num%base]
|
|
||||||
num /= base
|
|
||||||
i--
|
|
||||||
}
|
|
||||||
buf[i] = hexDigits[num]
|
|
||||||
|
|
||||||
// Add '0x' prefix.
|
|
||||||
i--
|
|
||||||
buf[i] = 'x'
|
|
||||||
i--
|
|
||||||
buf[i] = '0'
|
|
||||||
|
|
||||||
// Strip unused leading bytes.
|
|
||||||
buf = buf[i:]
|
|
||||||
w.Write(buf)
|
|
||||||
}
|
|
||||||
|
|
||||||
// valuesSorter implements sort.Interface to allow a slice of reflect.Value
|
|
||||||
// elements to be sorted.
|
|
||||||
type valuesSorter struct {
|
|
||||||
values []reflect.Value
|
|
||||||
strings []string // either nil or same len and values
|
|
||||||
cs *ConfigState
|
|
||||||
}
|
|
||||||
|
|
||||||
// newValuesSorter initializes a valuesSorter instance, which holds a set of
|
|
||||||
// surrogate keys on which the data should be sorted. It uses flags in
|
|
||||||
// ConfigState to decide if and how to populate those surrogate keys.
|
|
||||||
func newValuesSorter(values []reflect.Value, cs *ConfigState) sort.Interface {
|
|
||||||
vs := &valuesSorter{values: values, cs: cs}
|
|
||||||
if canSortSimply(vs.values[0].Kind()) {
|
|
||||||
return vs
|
|
||||||
}
|
|
||||||
if !cs.DisableMethods {
|
|
||||||
vs.strings = make([]string, len(values))
|
|
||||||
for i := range vs.values {
|
|
||||||
b := bytes.Buffer{}
|
|
||||||
if !handleMethods(cs, &b, vs.values[i]) {
|
|
||||||
vs.strings = nil
|
|
||||||
break
|
|
||||||
}
|
|
||||||
vs.strings[i] = b.String()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if vs.strings == nil && cs.SpewKeys {
|
|
||||||
vs.strings = make([]string, len(values))
|
|
||||||
for i := range vs.values {
|
|
||||||
vs.strings[i] = Sprintf("%#v", vs.values[i].Interface())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return vs
|
|
||||||
}
|
|
||||||
|
|
||||||
// canSortSimply tests whether a reflect.Kind is a primitive that can be sorted
|
|
||||||
// directly, or whether it should be considered for sorting by surrogate keys
|
|
||||||
// (if the ConfigState allows it).
|
|
||||||
func canSortSimply(kind reflect.Kind) bool {
|
|
||||||
// This switch parallels valueSortLess, except for the default case.
|
|
||||||
switch kind {
|
|
||||||
case reflect.Bool:
|
|
||||||
return true
|
|
||||||
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
|
||||||
return true
|
|
||||||
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
|
||||||
return true
|
|
||||||
case reflect.Float32, reflect.Float64:
|
|
||||||
return true
|
|
||||||
case reflect.String:
|
|
||||||
return true
|
|
||||||
case reflect.Uintptr:
|
|
||||||
return true
|
|
||||||
case reflect.Array:
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// Len returns the number of values in the slice. It is part of the
|
|
||||||
// sort.Interface implementation.
|
|
||||||
func (s *valuesSorter) Len() int {
|
|
||||||
return len(s.values)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Swap swaps the values at the passed indices. It is part of the
|
|
||||||
// sort.Interface implementation.
|
|
||||||
func (s *valuesSorter) Swap(i, j int) {
|
|
||||||
s.values[i], s.values[j] = s.values[j], s.values[i]
|
|
||||||
if s.strings != nil {
|
|
||||||
s.strings[i], s.strings[j] = s.strings[j], s.strings[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// valueSortLess returns whether the first value should sort before the second
|
|
||||||
// value. It is used by valueSorter.Less as part of the sort.Interface
|
|
||||||
// implementation.
|
|
||||||
func valueSortLess(a, b reflect.Value) bool {
|
|
||||||
switch a.Kind() {
|
|
||||||
case reflect.Bool:
|
|
||||||
return !a.Bool() && b.Bool()
|
|
||||||
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
|
||||||
return a.Int() < b.Int()
|
|
||||||
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
|
||||||
return a.Uint() < b.Uint()
|
|
||||||
case reflect.Float32, reflect.Float64:
|
|
||||||
return a.Float() < b.Float()
|
|
||||||
case reflect.String:
|
|
||||||
return a.String() < b.String()
|
|
||||||
case reflect.Uintptr:
|
|
||||||
return a.Uint() < b.Uint()
|
|
||||||
case reflect.Array:
|
|
||||||
// Compare the contents of both arrays.
|
|
||||||
l := a.Len()
|
|
||||||
for i := 0; i < l; i++ {
|
|
||||||
av := a.Index(i)
|
|
||||||
bv := b.Index(i)
|
|
||||||
if av.Interface() == bv.Interface() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return valueSortLess(av, bv)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return a.String() < b.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Less returns whether the value at index i should sort before the
|
|
||||||
// value at index j. It is part of the sort.Interface implementation.
|
|
||||||
func (s *valuesSorter) Less(i, j int) bool {
|
|
||||||
if s.strings == nil {
|
|
||||||
return valueSortLess(s.values[i], s.values[j])
|
|
||||||
}
|
|
||||||
return s.strings[i] < s.strings[j]
|
|
||||||
}
|
|
||||||
|
|
||||||
// sortValues is a sort function that handles both native types and any type that
|
|
||||||
// can be converted to error or Stringer. Other inputs are sorted according to
|
|
||||||
// their Value.String() value to ensure display stability.
|
|
||||||
func sortValues(values []reflect.Value, cs *ConfigState) {
|
|
||||||
if len(values) == 0 {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
sort.Sort(newValuesSorter(values, cs))
|
|
||||||
}
|
|
||||||
-306
@@ -1,306 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ConfigState houses the configuration options used by spew to format and
|
|
||||||
// display values. There is a global instance, Config, that is used to control
|
|
||||||
// all top-level Formatter and Dump functionality. Each ConfigState instance
|
|
||||||
// provides methods equivalent to the top-level functions.
|
|
||||||
//
|
|
||||||
// The zero value for ConfigState provides no indentation. You would typically
|
|
||||||
// want to set it to a space or a tab.
|
|
||||||
//
|
|
||||||
// Alternatively, you can use NewDefaultConfig to get a ConfigState instance
|
|
||||||
// with default settings. See the documentation of NewDefaultConfig for default
|
|
||||||
// values.
|
|
||||||
type ConfigState struct {
|
|
||||||
// Indent specifies the string to use for each indentation level. The
|
|
||||||
// global config instance that all top-level functions use set this to a
|
|
||||||
// single space by default. If you would like more indentation, you might
|
|
||||||
// set this to a tab with "\t" or perhaps two spaces with " ".
|
|
||||||
Indent string
|
|
||||||
|
|
||||||
// MaxDepth controls the maximum number of levels to descend into nested
|
|
||||||
// data structures. The default, 0, means there is no limit.
|
|
||||||
//
|
|
||||||
// NOTE: Circular data structures are properly detected, so it is not
|
|
||||||
// necessary to set this value unless you specifically want to limit deeply
|
|
||||||
// nested data structures.
|
|
||||||
MaxDepth int
|
|
||||||
|
|
||||||
// DisableMethods specifies whether or not error and Stringer interfaces are
|
|
||||||
// invoked for types that implement them.
|
|
||||||
DisableMethods bool
|
|
||||||
|
|
||||||
// DisablePointerMethods specifies whether or not to check for and invoke
|
|
||||||
// error and Stringer interfaces on types which only accept a pointer
|
|
||||||
// receiver when the current type is not a pointer.
|
|
||||||
//
|
|
||||||
// NOTE: This might be an unsafe action since calling one of these methods
|
|
||||||
// with a pointer receiver could technically mutate the value, however,
|
|
||||||
// in practice, types which choose to satisify an error or Stringer
|
|
||||||
// interface with a pointer receiver should not be mutating their state
|
|
||||||
// inside these interface methods. As a result, this option relies on
|
|
||||||
// access to the unsafe package, so it will not have any effect when
|
|
||||||
// running in environments without access to the unsafe package such as
|
|
||||||
// Google App Engine or with the "safe" build tag specified.
|
|
||||||
DisablePointerMethods bool
|
|
||||||
|
|
||||||
// DisablePointerAddresses specifies whether to disable the printing of
|
|
||||||
// pointer addresses. This is useful when diffing data structures in tests.
|
|
||||||
DisablePointerAddresses bool
|
|
||||||
|
|
||||||
// DisableCapacities specifies whether to disable the printing of capacities
|
|
||||||
// for arrays, slices, maps and channels. This is useful when diffing
|
|
||||||
// data structures in tests.
|
|
||||||
DisableCapacities bool
|
|
||||||
|
|
||||||
// ContinueOnMethod specifies whether or not recursion should continue once
|
|
||||||
// a custom error or Stringer interface is invoked. The default, false,
|
|
||||||
// means it will print the results of invoking the custom error or Stringer
|
|
||||||
// interface and return immediately instead of continuing to recurse into
|
|
||||||
// the internals of the data type.
|
|
||||||
//
|
|
||||||
// NOTE: This flag does not have any effect if method invocation is disabled
|
|
||||||
// via the DisableMethods or DisablePointerMethods options.
|
|
||||||
ContinueOnMethod bool
|
|
||||||
|
|
||||||
// SortKeys specifies map keys should be sorted before being printed. Use
|
|
||||||
// this to have a more deterministic, diffable output. Note that only
|
|
||||||
// native types (bool, int, uint, floats, uintptr and string) and types
|
|
||||||
// that support the error or Stringer interfaces (if methods are
|
|
||||||
// enabled) are supported, with other types sorted according to the
|
|
||||||
// reflect.Value.String() output which guarantees display stability.
|
|
||||||
SortKeys bool
|
|
||||||
|
|
||||||
// SpewKeys specifies that, as a last resort attempt, map keys should
|
|
||||||
// be spewed to strings and sorted by those strings. This is only
|
|
||||||
// considered if SortKeys is true.
|
|
||||||
SpewKeys bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Config is the active configuration of the top-level functions.
|
|
||||||
// The configuration can be changed by modifying the contents of spew.Config.
|
|
||||||
var Config = ConfigState{Indent: " "}
|
|
||||||
|
|
||||||
// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the formatted string as a value that satisfies error. See NewFormatter
|
|
||||||
// for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Errorf(format, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Errorf(format string, a ...interface{}) (err error) {
|
|
||||||
return fmt.Errorf(format, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprint(w, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Fprint(w io.Writer, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprint(w, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprintf(w, format, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprintf(w, format, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprintln(w, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprintln(w, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print is a wrapper for fmt.Print that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Print(c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Print(a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Print(c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Printf is a wrapper for fmt.Printf that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Printf(format, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Printf(format string, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Printf(format, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Println is a wrapper for fmt.Println that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Println(c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Println(a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Println(c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprint(c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Sprint(a ...interface{}) string {
|
|
||||||
return fmt.Sprint(c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
|
|
||||||
// passed with a Formatter interface returned by c.NewFormatter. It returns
|
|
||||||
// the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprintf(format, c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Sprintf(format string, a ...interface{}) string {
|
|
||||||
return fmt.Sprintf(format, c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
|
|
||||||
// were passed with a Formatter interface returned by c.NewFormatter. It
|
|
||||||
// returns the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprintln(c.NewFormatter(a), c.NewFormatter(b))
|
|
||||||
func (c *ConfigState) Sprintln(a ...interface{}) string {
|
|
||||||
return fmt.Sprintln(c.convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
NewFormatter returns a custom formatter that satisfies the fmt.Formatter
|
|
||||||
interface. As a result, it integrates cleanly with standard fmt package
|
|
||||||
printing functions. The formatter is useful for inline printing of smaller data
|
|
||||||
types similar to the standard %v format specifier.
|
|
||||||
|
|
||||||
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
|
||||||
addresses), %#v (adds types), and %#+v (adds types and pointer addresses) verb
|
|
||||||
combinations. Any other verbs such as %x and %q will be sent to the the
|
|
||||||
standard fmt package for formatting. In addition, the custom formatter ignores
|
|
||||||
the width and precision arguments (however they will still work on the format
|
|
||||||
specifiers not handled by the custom formatter).
|
|
||||||
|
|
||||||
Typically this function shouldn't be called directly. It is much easier to make
|
|
||||||
use of the custom formatter by calling one of the convenience functions such as
|
|
||||||
c.Printf, c.Println, or c.Printf.
|
|
||||||
*/
|
|
||||||
func (c *ConfigState) NewFormatter(v interface{}) fmt.Formatter {
|
|
||||||
return newFormatter(c, v)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fdump formats and displays the passed arguments to io.Writer w. It formats
|
|
||||||
// exactly the same as Dump.
|
|
||||||
func (c *ConfigState) Fdump(w io.Writer, a ...interface{}) {
|
|
||||||
fdump(c, w, a...)
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
Dump displays the passed parameters to standard out with newlines, customizable
|
|
||||||
indentation, and additional debug information such as complete types and all
|
|
||||||
pointer addresses used to indirect to the final value. It provides the
|
|
||||||
following features over the built-in printing facilities provided by the fmt
|
|
||||||
package:
|
|
||||||
|
|
||||||
* Pointers are dereferenced and followed
|
|
||||||
* Circular data structures are detected and handled properly
|
|
||||||
* Custom Stringer/error interfaces are optionally invoked, including
|
|
||||||
on unexported types
|
|
||||||
* Custom types which only implement the Stringer/error interfaces via
|
|
||||||
a pointer receiver are optionally invoked when passing non-pointer
|
|
||||||
variables
|
|
||||||
* Byte arrays and slices are dumped like the hexdump -C command which
|
|
||||||
includes offsets, byte values in hex, and ASCII output
|
|
||||||
|
|
||||||
The configuration options are controlled by modifying the public members
|
|
||||||
of c. See ConfigState for options documentation.
|
|
||||||
|
|
||||||
See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
|
|
||||||
get the formatted result as a string.
|
|
||||||
*/
|
|
||||||
func (c *ConfigState) Dump(a ...interface{}) {
|
|
||||||
fdump(c, os.Stdout, a...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sdump returns a string with the passed arguments formatted exactly the same
|
|
||||||
// as Dump.
|
|
||||||
func (c *ConfigState) Sdump(a ...interface{}) string {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
fdump(c, &buf, a...)
|
|
||||||
return buf.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
// convertArgs accepts a slice of arguments and returns a slice of the same
|
|
||||||
// length with each argument converted to a spew Formatter interface using
|
|
||||||
// the ConfigState associated with s.
|
|
||||||
func (c *ConfigState) convertArgs(args []interface{}) (formatters []interface{}) {
|
|
||||||
formatters = make([]interface{}, len(args))
|
|
||||||
for index, arg := range args {
|
|
||||||
formatters[index] = newFormatter(c, arg)
|
|
||||||
}
|
|
||||||
return formatters
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewDefaultConfig returns a ConfigState with the following default settings.
|
|
||||||
//
|
|
||||||
// Indent: " "
|
|
||||||
// MaxDepth: 0
|
|
||||||
// DisableMethods: false
|
|
||||||
// DisablePointerMethods: false
|
|
||||||
// ContinueOnMethod: false
|
|
||||||
// SortKeys: false
|
|
||||||
func NewDefaultConfig() *ConfigState {
|
|
||||||
return &ConfigState{Indent: " "}
|
|
||||||
}
|
|
||||||
-211
@@ -1,211 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
/*
|
|
||||||
Package spew implements a deep pretty printer for Go data structures to aid in
|
|
||||||
debugging.
|
|
||||||
|
|
||||||
A quick overview of the additional features spew provides over the built-in
|
|
||||||
printing facilities for Go data types are as follows:
|
|
||||||
|
|
||||||
* Pointers are dereferenced and followed
|
|
||||||
* Circular data structures are detected and handled properly
|
|
||||||
* Custom Stringer/error interfaces are optionally invoked, including
|
|
||||||
on unexported types
|
|
||||||
* Custom types which only implement the Stringer/error interfaces via
|
|
||||||
a pointer receiver are optionally invoked when passing non-pointer
|
|
||||||
variables
|
|
||||||
* Byte arrays and slices are dumped like the hexdump -C command which
|
|
||||||
includes offsets, byte values in hex, and ASCII output (only when using
|
|
||||||
Dump style)
|
|
||||||
|
|
||||||
There are two different approaches spew allows for dumping Go data structures:
|
|
||||||
|
|
||||||
* Dump style which prints with newlines, customizable indentation,
|
|
||||||
and additional debug information such as types and all pointer addresses
|
|
||||||
used to indirect to the final value
|
|
||||||
* A custom Formatter interface that integrates cleanly with the standard fmt
|
|
||||||
package and replaces %v, %+v, %#v, and %#+v to provide inline printing
|
|
||||||
similar to the default %v while providing the additional functionality
|
|
||||||
outlined above and passing unsupported format verbs such as %x and %q
|
|
||||||
along to fmt
|
|
||||||
|
|
||||||
Quick Start
|
|
||||||
|
|
||||||
This section demonstrates how to quickly get started with spew. See the
|
|
||||||
sections below for further details on formatting and configuration options.
|
|
||||||
|
|
||||||
To dump a variable with full newlines, indentation, type, and pointer
|
|
||||||
information use Dump, Fdump, or Sdump:
|
|
||||||
spew.Dump(myVar1, myVar2, ...)
|
|
||||||
spew.Fdump(someWriter, myVar1, myVar2, ...)
|
|
||||||
str := spew.Sdump(myVar1, myVar2, ...)
|
|
||||||
|
|
||||||
Alternatively, if you would prefer to use format strings with a compacted inline
|
|
||||||
printing style, use the convenience wrappers Printf, Fprintf, etc with
|
|
||||||
%v (most compact), %+v (adds pointer addresses), %#v (adds types), or
|
|
||||||
%#+v (adds types and pointer addresses):
|
|
||||||
spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
|
||||||
spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
|
||||||
spew.Fprintf(someWriter, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
|
||||||
spew.Fprintf(someWriter, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
|
||||||
|
|
||||||
Configuration Options
|
|
||||||
|
|
||||||
Configuration of spew is handled by fields in the ConfigState type. For
|
|
||||||
convenience, all of the top-level functions use a global state available
|
|
||||||
via the spew.Config global.
|
|
||||||
|
|
||||||
It is also possible to create a ConfigState instance that provides methods
|
|
||||||
equivalent to the top-level functions. This allows concurrent configuration
|
|
||||||
options. See the ConfigState documentation for more details.
|
|
||||||
|
|
||||||
The following configuration options are available:
|
|
||||||
* Indent
|
|
||||||
String to use for each indentation level for Dump functions.
|
|
||||||
It is a single space by default. A popular alternative is "\t".
|
|
||||||
|
|
||||||
* MaxDepth
|
|
||||||
Maximum number of levels to descend into nested data structures.
|
|
||||||
There is no limit by default.
|
|
||||||
|
|
||||||
* DisableMethods
|
|
||||||
Disables invocation of error and Stringer interface methods.
|
|
||||||
Method invocation is enabled by default.
|
|
||||||
|
|
||||||
* DisablePointerMethods
|
|
||||||
Disables invocation of error and Stringer interface methods on types
|
|
||||||
which only accept pointer receivers from non-pointer variables.
|
|
||||||
Pointer method invocation is enabled by default.
|
|
||||||
|
|
||||||
* DisablePointerAddresses
|
|
||||||
DisablePointerAddresses specifies whether to disable the printing of
|
|
||||||
pointer addresses. This is useful when diffing data structures in tests.
|
|
||||||
|
|
||||||
* DisableCapacities
|
|
||||||
DisableCapacities specifies whether to disable the printing of
|
|
||||||
capacities for arrays, slices, maps and channels. This is useful when
|
|
||||||
diffing data structures in tests.
|
|
||||||
|
|
||||||
* ContinueOnMethod
|
|
||||||
Enables recursion into types after invoking error and Stringer interface
|
|
||||||
methods. Recursion after method invocation is disabled by default.
|
|
||||||
|
|
||||||
* SortKeys
|
|
||||||
Specifies map keys should be sorted before being printed. Use
|
|
||||||
this to have a more deterministic, diffable output. Note that
|
|
||||||
only native types (bool, int, uint, floats, uintptr and string)
|
|
||||||
and types which implement error or Stringer interfaces are
|
|
||||||
supported with other types sorted according to the
|
|
||||||
reflect.Value.String() output which guarantees display
|
|
||||||
stability. Natural map order is used by default.
|
|
||||||
|
|
||||||
* SpewKeys
|
|
||||||
Specifies that, as a last resort attempt, map keys should be
|
|
||||||
spewed to strings and sorted by those strings. This is only
|
|
||||||
considered if SortKeys is true.
|
|
||||||
|
|
||||||
Dump Usage
|
|
||||||
|
|
||||||
Simply call spew.Dump with a list of variables you want to dump:
|
|
||||||
|
|
||||||
spew.Dump(myVar1, myVar2, ...)
|
|
||||||
|
|
||||||
You may also call spew.Fdump if you would prefer to output to an arbitrary
|
|
||||||
io.Writer. For example, to dump to standard error:
|
|
||||||
|
|
||||||
spew.Fdump(os.Stderr, myVar1, myVar2, ...)
|
|
||||||
|
|
||||||
A third option is to call spew.Sdump to get the formatted output as a string:
|
|
||||||
|
|
||||||
str := spew.Sdump(myVar1, myVar2, ...)
|
|
||||||
|
|
||||||
Sample Dump Output
|
|
||||||
|
|
||||||
See the Dump example for details on the setup of the types and variables being
|
|
||||||
shown here.
|
|
||||||
|
|
||||||
(main.Foo) {
|
|
||||||
unexportedField: (*main.Bar)(0xf84002e210)({
|
|
||||||
flag: (main.Flag) flagTwo,
|
|
||||||
data: (uintptr) <nil>
|
|
||||||
}),
|
|
||||||
ExportedField: (map[interface {}]interface {}) (len=1) {
|
|
||||||
(string) (len=3) "one": (bool) true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Byte (and uint8) arrays and slices are displayed uniquely like the hexdump -C
|
|
||||||
command as shown.
|
|
||||||
([]uint8) (len=32 cap=32) {
|
|
||||||
00000000 11 12 13 14 15 16 17 18 19 1a 1b 1c 1d 1e 1f 20 |............... |
|
|
||||||
00000010 21 22 23 24 25 26 27 28 29 2a 2b 2c 2d 2e 2f 30 |!"#$%&'()*+,-./0|
|
|
||||||
00000020 31 32 |12|
|
|
||||||
}
|
|
||||||
|
|
||||||
Custom Formatter
|
|
||||||
|
|
||||||
Spew provides a custom formatter that implements the fmt.Formatter interface
|
|
||||||
so that it integrates cleanly with standard fmt package printing functions. The
|
|
||||||
formatter is useful for inline printing of smaller data types similar to the
|
|
||||||
standard %v format specifier.
|
|
||||||
|
|
||||||
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
|
||||||
addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
|
|
||||||
combinations. Any other verbs such as %x and %q will be sent to the the
|
|
||||||
standard fmt package for formatting. In addition, the custom formatter ignores
|
|
||||||
the width and precision arguments (however they will still work on the format
|
|
||||||
specifiers not handled by the custom formatter).
|
|
||||||
|
|
||||||
Custom Formatter Usage
|
|
||||||
|
|
||||||
The simplest way to make use of the spew custom formatter is to call one of the
|
|
||||||
convenience functions such as spew.Printf, spew.Println, or spew.Printf. The
|
|
||||||
functions have syntax you are most likely already familiar with:
|
|
||||||
|
|
||||||
spew.Printf("myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
|
||||||
spew.Printf("myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
|
||||||
spew.Println(myVar, myVar2)
|
|
||||||
spew.Fprintf(os.Stderr, "myVar1: %v -- myVar2: %+v", myVar1, myVar2)
|
|
||||||
spew.Fprintf(os.Stderr, "myVar3: %#v -- myVar4: %#+v", myVar3, myVar4)
|
|
||||||
|
|
||||||
See the Index for the full list convenience functions.
|
|
||||||
|
|
||||||
Sample Formatter Output
|
|
||||||
|
|
||||||
Double pointer to a uint8:
|
|
||||||
%v: <**>5
|
|
||||||
%+v: <**>(0xf8400420d0->0xf8400420c8)5
|
|
||||||
%#v: (**uint8)5
|
|
||||||
%#+v: (**uint8)(0xf8400420d0->0xf8400420c8)5
|
|
||||||
|
|
||||||
Pointer to circular struct with a uint8 field and a pointer to itself:
|
|
||||||
%v: <*>{1 <*><shown>}
|
|
||||||
%+v: <*>(0xf84003e260){ui8:1 c:<*>(0xf84003e260)<shown>}
|
|
||||||
%#v: (*main.circular){ui8:(uint8)1 c:(*main.circular)<shown>}
|
|
||||||
%#+v: (*main.circular)(0xf84003e260){ui8:(uint8)1 c:(*main.circular)(0xf84003e260)<shown>}
|
|
||||||
|
|
||||||
See the Printf example for details on the setup of variables being shown
|
|
||||||
here.
|
|
||||||
|
|
||||||
Errors
|
|
||||||
|
|
||||||
Since it is possible for custom Stringer/error interfaces to panic, spew
|
|
||||||
detects them and handles them internally by printing the panic information
|
|
||||||
inline with the output. Since spew is intended to provide deep pretty printing
|
|
||||||
capabilities on structures, it intentionally does not return any errors.
|
|
||||||
*/
|
|
||||||
package spew
|
|
||||||
-509
@@ -1,509 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/hex"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"reflect"
|
|
||||||
"regexp"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// uint8Type is a reflect.Type representing a uint8. It is used to
|
|
||||||
// convert cgo types to uint8 slices for hexdumping.
|
|
||||||
uint8Type = reflect.TypeOf(uint8(0))
|
|
||||||
|
|
||||||
// cCharRE is a regular expression that matches a cgo char.
|
|
||||||
// It is used to detect character arrays to hexdump them.
|
|
||||||
cCharRE = regexp.MustCompile(`^.*\._Ctype_char$`)
|
|
||||||
|
|
||||||
// cUnsignedCharRE is a regular expression that matches a cgo unsigned
|
|
||||||
// char. It is used to detect unsigned character arrays to hexdump
|
|
||||||
// them.
|
|
||||||
cUnsignedCharRE = regexp.MustCompile(`^.*\._Ctype_unsignedchar$`)
|
|
||||||
|
|
||||||
// cUint8tCharRE is a regular expression that matches a cgo uint8_t.
|
|
||||||
// It is used to detect uint8_t arrays to hexdump them.
|
|
||||||
cUint8tCharRE = regexp.MustCompile(`^.*\._Ctype_uint8_t$`)
|
|
||||||
)
|
|
||||||
|
|
||||||
// dumpState contains information about the state of a dump operation.
|
|
||||||
type dumpState struct {
|
|
||||||
w io.Writer
|
|
||||||
depth int
|
|
||||||
pointers map[uintptr]int
|
|
||||||
ignoreNextType bool
|
|
||||||
ignoreNextIndent bool
|
|
||||||
cs *ConfigState
|
|
||||||
}
|
|
||||||
|
|
||||||
// indent performs indentation according to the depth level and cs.Indent
|
|
||||||
// option.
|
|
||||||
func (d *dumpState) indent() {
|
|
||||||
if d.ignoreNextIndent {
|
|
||||||
d.ignoreNextIndent = false
|
|
||||||
return
|
|
||||||
}
|
|
||||||
d.w.Write(bytes.Repeat([]byte(d.cs.Indent), d.depth))
|
|
||||||
}
|
|
||||||
|
|
||||||
// unpackValue returns values inside of non-nil interfaces when possible.
|
|
||||||
// This is useful for data types like structs, arrays, slices, and maps which
|
|
||||||
// can contain varying types packed inside an interface.
|
|
||||||
func (d *dumpState) unpackValue(v reflect.Value) reflect.Value {
|
|
||||||
if v.Kind() == reflect.Interface && !v.IsNil() {
|
|
||||||
v = v.Elem()
|
|
||||||
}
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// dumpPtr handles formatting of pointers by indirecting them as necessary.
|
|
||||||
func (d *dumpState) dumpPtr(v reflect.Value) {
|
|
||||||
// Remove pointers at or below the current depth from map used to detect
|
|
||||||
// circular refs.
|
|
||||||
for k, depth := range d.pointers {
|
|
||||||
if depth >= d.depth {
|
|
||||||
delete(d.pointers, k)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Keep list of all dereferenced pointers to show later.
|
|
||||||
pointerChain := make([]uintptr, 0)
|
|
||||||
|
|
||||||
// Figure out how many levels of indirection there are by dereferencing
|
|
||||||
// pointers and unpacking interfaces down the chain while detecting circular
|
|
||||||
// references.
|
|
||||||
nilFound := false
|
|
||||||
cycleFound := false
|
|
||||||
indirects := 0
|
|
||||||
ve := v
|
|
||||||
for ve.Kind() == reflect.Ptr {
|
|
||||||
if ve.IsNil() {
|
|
||||||
nilFound = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
indirects++
|
|
||||||
addr := ve.Pointer()
|
|
||||||
pointerChain = append(pointerChain, addr)
|
|
||||||
if pd, ok := d.pointers[addr]; ok && pd < d.depth {
|
|
||||||
cycleFound = true
|
|
||||||
indirects--
|
|
||||||
break
|
|
||||||
}
|
|
||||||
d.pointers[addr] = d.depth
|
|
||||||
|
|
||||||
ve = ve.Elem()
|
|
||||||
if ve.Kind() == reflect.Interface {
|
|
||||||
if ve.IsNil() {
|
|
||||||
nilFound = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ve = ve.Elem()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Display type information.
|
|
||||||
d.w.Write(openParenBytes)
|
|
||||||
d.w.Write(bytes.Repeat(asteriskBytes, indirects))
|
|
||||||
d.w.Write([]byte(ve.Type().String()))
|
|
||||||
d.w.Write(closeParenBytes)
|
|
||||||
|
|
||||||
// Display pointer information.
|
|
||||||
if !d.cs.DisablePointerAddresses && len(pointerChain) > 0 {
|
|
||||||
d.w.Write(openParenBytes)
|
|
||||||
for i, addr := range pointerChain {
|
|
||||||
if i > 0 {
|
|
||||||
d.w.Write(pointerChainBytes)
|
|
||||||
}
|
|
||||||
printHexPtr(d.w, addr)
|
|
||||||
}
|
|
||||||
d.w.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Display dereferenced value.
|
|
||||||
d.w.Write(openParenBytes)
|
|
||||||
switch {
|
|
||||||
case nilFound:
|
|
||||||
d.w.Write(nilAngleBytes)
|
|
||||||
|
|
||||||
case cycleFound:
|
|
||||||
d.w.Write(circularBytes)
|
|
||||||
|
|
||||||
default:
|
|
||||||
d.ignoreNextType = true
|
|
||||||
d.dump(ve)
|
|
||||||
}
|
|
||||||
d.w.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// dumpSlice handles formatting of arrays and slices. Byte (uint8 under
|
|
||||||
// reflection) arrays and slices are dumped in hexdump -C fashion.
|
|
||||||
func (d *dumpState) dumpSlice(v reflect.Value) {
|
|
||||||
// Determine whether this type should be hex dumped or not. Also,
|
|
||||||
// for types which should be hexdumped, try to use the underlying data
|
|
||||||
// first, then fall back to trying to convert them to a uint8 slice.
|
|
||||||
var buf []uint8
|
|
||||||
doConvert := false
|
|
||||||
doHexDump := false
|
|
||||||
numEntries := v.Len()
|
|
||||||
if numEntries > 0 {
|
|
||||||
vt := v.Index(0).Type()
|
|
||||||
vts := vt.String()
|
|
||||||
switch {
|
|
||||||
// C types that need to be converted.
|
|
||||||
case cCharRE.MatchString(vts):
|
|
||||||
fallthrough
|
|
||||||
case cUnsignedCharRE.MatchString(vts):
|
|
||||||
fallthrough
|
|
||||||
case cUint8tCharRE.MatchString(vts):
|
|
||||||
doConvert = true
|
|
||||||
|
|
||||||
// Try to use existing uint8 slices and fall back to converting
|
|
||||||
// and copying if that fails.
|
|
||||||
case vt.Kind() == reflect.Uint8:
|
|
||||||
// We need an addressable interface to convert the type
|
|
||||||
// to a byte slice. However, the reflect package won't
|
|
||||||
// give us an interface on certain things like
|
|
||||||
// unexported struct fields in order to enforce
|
|
||||||
// visibility rules. We use unsafe, when available, to
|
|
||||||
// bypass these restrictions since this package does not
|
|
||||||
// mutate the values.
|
|
||||||
vs := v
|
|
||||||
if !vs.CanInterface() || !vs.CanAddr() {
|
|
||||||
vs = unsafeReflectValue(vs)
|
|
||||||
}
|
|
||||||
if !UnsafeDisabled {
|
|
||||||
vs = vs.Slice(0, numEntries)
|
|
||||||
|
|
||||||
// Use the existing uint8 slice if it can be
|
|
||||||
// type asserted.
|
|
||||||
iface := vs.Interface()
|
|
||||||
if slice, ok := iface.([]uint8); ok {
|
|
||||||
buf = slice
|
|
||||||
doHexDump = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// The underlying data needs to be converted if it can't
|
|
||||||
// be type asserted to a uint8 slice.
|
|
||||||
doConvert = true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Copy and convert the underlying type if needed.
|
|
||||||
if doConvert && vt.ConvertibleTo(uint8Type) {
|
|
||||||
// Convert and copy each element into a uint8 byte
|
|
||||||
// slice.
|
|
||||||
buf = make([]uint8, numEntries)
|
|
||||||
for i := 0; i < numEntries; i++ {
|
|
||||||
vv := v.Index(i)
|
|
||||||
buf[i] = uint8(vv.Convert(uint8Type).Uint())
|
|
||||||
}
|
|
||||||
doHexDump = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Hexdump the entire slice as needed.
|
|
||||||
if doHexDump {
|
|
||||||
indent := strings.Repeat(d.cs.Indent, d.depth)
|
|
||||||
str := indent + hex.Dump(buf)
|
|
||||||
str = strings.Replace(str, "\n", "\n"+indent, -1)
|
|
||||||
str = strings.TrimRight(str, d.cs.Indent)
|
|
||||||
d.w.Write([]byte(str))
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Recursively call dump for each item.
|
|
||||||
for i := 0; i < numEntries; i++ {
|
|
||||||
d.dump(d.unpackValue(v.Index(i)))
|
|
||||||
if i < (numEntries - 1) {
|
|
||||||
d.w.Write(commaNewlineBytes)
|
|
||||||
} else {
|
|
||||||
d.w.Write(newlineBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// dump is the main workhorse for dumping a value. It uses the passed reflect
|
|
||||||
// value to figure out what kind of object we are dealing with and formats it
|
|
||||||
// appropriately. It is a recursive function, however circular data structures
|
|
||||||
// are detected and handled properly.
|
|
||||||
func (d *dumpState) dump(v reflect.Value) {
|
|
||||||
// Handle invalid reflect values immediately.
|
|
||||||
kind := v.Kind()
|
|
||||||
if kind == reflect.Invalid {
|
|
||||||
d.w.Write(invalidAngleBytes)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle pointers specially.
|
|
||||||
if kind == reflect.Ptr {
|
|
||||||
d.indent()
|
|
||||||
d.dumpPtr(v)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print type information unless already handled elsewhere.
|
|
||||||
if !d.ignoreNextType {
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(openParenBytes)
|
|
||||||
d.w.Write([]byte(v.Type().String()))
|
|
||||||
d.w.Write(closeParenBytes)
|
|
||||||
d.w.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
d.ignoreNextType = false
|
|
||||||
|
|
||||||
// Display length and capacity if the built-in len and cap functions
|
|
||||||
// work with the value's kind and the len/cap itself is non-zero.
|
|
||||||
valueLen, valueCap := 0, 0
|
|
||||||
switch v.Kind() {
|
|
||||||
case reflect.Array, reflect.Slice, reflect.Chan:
|
|
||||||
valueLen, valueCap = v.Len(), v.Cap()
|
|
||||||
case reflect.Map, reflect.String:
|
|
||||||
valueLen = v.Len()
|
|
||||||
}
|
|
||||||
if valueLen != 0 || !d.cs.DisableCapacities && valueCap != 0 {
|
|
||||||
d.w.Write(openParenBytes)
|
|
||||||
if valueLen != 0 {
|
|
||||||
d.w.Write(lenEqualsBytes)
|
|
||||||
printInt(d.w, int64(valueLen), 10)
|
|
||||||
}
|
|
||||||
if !d.cs.DisableCapacities && valueCap != 0 {
|
|
||||||
if valueLen != 0 {
|
|
||||||
d.w.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
d.w.Write(capEqualsBytes)
|
|
||||||
printInt(d.w, int64(valueCap), 10)
|
|
||||||
}
|
|
||||||
d.w.Write(closeParenBytes)
|
|
||||||
d.w.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Call Stringer/error interfaces if they exist and the handle methods flag
|
|
||||||
// is enabled
|
|
||||||
if !d.cs.DisableMethods {
|
|
||||||
if (kind != reflect.Invalid) && (kind != reflect.Interface) {
|
|
||||||
if handled := handleMethods(d.cs, d.w, v); handled {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
switch kind {
|
|
||||||
case reflect.Invalid:
|
|
||||||
// Do nothing. We should never get here since invalid has already
|
|
||||||
// been handled above.
|
|
||||||
|
|
||||||
case reflect.Bool:
|
|
||||||
printBool(d.w, v.Bool())
|
|
||||||
|
|
||||||
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
|
||||||
printInt(d.w, v.Int(), 10)
|
|
||||||
|
|
||||||
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
|
||||||
printUint(d.w, v.Uint(), 10)
|
|
||||||
|
|
||||||
case reflect.Float32:
|
|
||||||
printFloat(d.w, v.Float(), 32)
|
|
||||||
|
|
||||||
case reflect.Float64:
|
|
||||||
printFloat(d.w, v.Float(), 64)
|
|
||||||
|
|
||||||
case reflect.Complex64:
|
|
||||||
printComplex(d.w, v.Complex(), 32)
|
|
||||||
|
|
||||||
case reflect.Complex128:
|
|
||||||
printComplex(d.w, v.Complex(), 64)
|
|
||||||
|
|
||||||
case reflect.Slice:
|
|
||||||
if v.IsNil() {
|
|
||||||
d.w.Write(nilAngleBytes)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
fallthrough
|
|
||||||
|
|
||||||
case reflect.Array:
|
|
||||||
d.w.Write(openBraceNewlineBytes)
|
|
||||||
d.depth++
|
|
||||||
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(maxNewlineBytes)
|
|
||||||
} else {
|
|
||||||
d.dumpSlice(v)
|
|
||||||
}
|
|
||||||
d.depth--
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(closeBraceBytes)
|
|
||||||
|
|
||||||
case reflect.String:
|
|
||||||
d.w.Write([]byte(strconv.Quote(v.String())))
|
|
||||||
|
|
||||||
case reflect.Interface:
|
|
||||||
// The only time we should get here is for nil interfaces due to
|
|
||||||
// unpackValue calls.
|
|
||||||
if v.IsNil() {
|
|
||||||
d.w.Write(nilAngleBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
case reflect.Ptr:
|
|
||||||
// Do nothing. We should never get here since pointers have already
|
|
||||||
// been handled above.
|
|
||||||
|
|
||||||
case reflect.Map:
|
|
||||||
// nil maps should be indicated as different than empty maps
|
|
||||||
if v.IsNil() {
|
|
||||||
d.w.Write(nilAngleBytes)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
d.w.Write(openBraceNewlineBytes)
|
|
||||||
d.depth++
|
|
||||||
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(maxNewlineBytes)
|
|
||||||
} else {
|
|
||||||
numEntries := v.Len()
|
|
||||||
keys := v.MapKeys()
|
|
||||||
if d.cs.SortKeys {
|
|
||||||
sortValues(keys, d.cs)
|
|
||||||
}
|
|
||||||
for i, key := range keys {
|
|
||||||
d.dump(d.unpackValue(key))
|
|
||||||
d.w.Write(colonSpaceBytes)
|
|
||||||
d.ignoreNextIndent = true
|
|
||||||
d.dump(d.unpackValue(v.MapIndex(key)))
|
|
||||||
if i < (numEntries - 1) {
|
|
||||||
d.w.Write(commaNewlineBytes)
|
|
||||||
} else {
|
|
||||||
d.w.Write(newlineBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
d.depth--
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(closeBraceBytes)
|
|
||||||
|
|
||||||
case reflect.Struct:
|
|
||||||
d.w.Write(openBraceNewlineBytes)
|
|
||||||
d.depth++
|
|
||||||
if (d.cs.MaxDepth != 0) && (d.depth > d.cs.MaxDepth) {
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(maxNewlineBytes)
|
|
||||||
} else {
|
|
||||||
vt := v.Type()
|
|
||||||
numFields := v.NumField()
|
|
||||||
for i := 0; i < numFields; i++ {
|
|
||||||
d.indent()
|
|
||||||
vtf := vt.Field(i)
|
|
||||||
d.w.Write([]byte(vtf.Name))
|
|
||||||
d.w.Write(colonSpaceBytes)
|
|
||||||
d.ignoreNextIndent = true
|
|
||||||
d.dump(d.unpackValue(v.Field(i)))
|
|
||||||
if i < (numFields - 1) {
|
|
||||||
d.w.Write(commaNewlineBytes)
|
|
||||||
} else {
|
|
||||||
d.w.Write(newlineBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
d.depth--
|
|
||||||
d.indent()
|
|
||||||
d.w.Write(closeBraceBytes)
|
|
||||||
|
|
||||||
case reflect.Uintptr:
|
|
||||||
printHexPtr(d.w, uintptr(v.Uint()))
|
|
||||||
|
|
||||||
case reflect.UnsafePointer, reflect.Chan, reflect.Func:
|
|
||||||
printHexPtr(d.w, v.Pointer())
|
|
||||||
|
|
||||||
// There were not any other types at the time this code was written, but
|
|
||||||
// fall back to letting the default fmt package handle it in case any new
|
|
||||||
// types are added.
|
|
||||||
default:
|
|
||||||
if v.CanInterface() {
|
|
||||||
fmt.Fprintf(d.w, "%v", v.Interface())
|
|
||||||
} else {
|
|
||||||
fmt.Fprintf(d.w, "%v", v.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// fdump is a helper function to consolidate the logic from the various public
|
|
||||||
// methods which take varying writers and config states.
|
|
||||||
func fdump(cs *ConfigState, w io.Writer, a ...interface{}) {
|
|
||||||
for _, arg := range a {
|
|
||||||
if arg == nil {
|
|
||||||
w.Write(interfaceBytes)
|
|
||||||
w.Write(spaceBytes)
|
|
||||||
w.Write(nilAngleBytes)
|
|
||||||
w.Write(newlineBytes)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
d := dumpState{w: w, cs: cs}
|
|
||||||
d.pointers = make(map[uintptr]int)
|
|
||||||
d.dump(reflect.ValueOf(arg))
|
|
||||||
d.w.Write(newlineBytes)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fdump formats and displays the passed arguments to io.Writer w. It formats
|
|
||||||
// exactly the same as Dump.
|
|
||||||
func Fdump(w io.Writer, a ...interface{}) {
|
|
||||||
fdump(&Config, w, a...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sdump returns a string with the passed arguments formatted exactly the same
|
|
||||||
// as Dump.
|
|
||||||
func Sdump(a ...interface{}) string {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
fdump(&Config, &buf, a...)
|
|
||||||
return buf.String()
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
Dump displays the passed parameters to standard out with newlines, customizable
|
|
||||||
indentation, and additional debug information such as complete types and all
|
|
||||||
pointer addresses used to indirect to the final value. It provides the
|
|
||||||
following features over the built-in printing facilities provided by the fmt
|
|
||||||
package:
|
|
||||||
|
|
||||||
* Pointers are dereferenced and followed
|
|
||||||
* Circular data structures are detected and handled properly
|
|
||||||
* Custom Stringer/error interfaces are optionally invoked, including
|
|
||||||
on unexported types
|
|
||||||
* Custom types which only implement the Stringer/error interfaces via
|
|
||||||
a pointer receiver are optionally invoked when passing non-pointer
|
|
||||||
variables
|
|
||||||
* Byte arrays and slices are dumped like the hexdump -C command which
|
|
||||||
includes offsets, byte values in hex, and ASCII output
|
|
||||||
|
|
||||||
The configuration options are controlled by an exported package global,
|
|
||||||
spew.Config. See ConfigState for options documentation.
|
|
||||||
|
|
||||||
See Fdump if you would prefer dumping to an arbitrary io.Writer or Sdump to
|
|
||||||
get the formatted result as a string.
|
|
||||||
*/
|
|
||||||
func Dump(a ...interface{}) {
|
|
||||||
fdump(&Config, os.Stdout, a...)
|
|
||||||
}
|
|
||||||
-419
@@ -1,419 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"reflect"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// supportedFlags is a list of all the character flags supported by fmt package.
|
|
||||||
const supportedFlags = "0-+# "
|
|
||||||
|
|
||||||
// formatState implements the fmt.Formatter interface and contains information
|
|
||||||
// about the state of a formatting operation. The NewFormatter function can
|
|
||||||
// be used to get a new Formatter which can be used directly as arguments
|
|
||||||
// in standard fmt package printing calls.
|
|
||||||
type formatState struct {
|
|
||||||
value interface{}
|
|
||||||
fs fmt.State
|
|
||||||
depth int
|
|
||||||
pointers map[uintptr]int
|
|
||||||
ignoreNextType bool
|
|
||||||
cs *ConfigState
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildDefaultFormat recreates the original format string without precision
|
|
||||||
// and width information to pass in to fmt.Sprintf in the case of an
|
|
||||||
// unrecognized type. Unless new types are added to the language, this
|
|
||||||
// function won't ever be called.
|
|
||||||
func (f *formatState) buildDefaultFormat() (format string) {
|
|
||||||
buf := bytes.NewBuffer(percentBytes)
|
|
||||||
|
|
||||||
for _, flag := range supportedFlags {
|
|
||||||
if f.fs.Flag(int(flag)) {
|
|
||||||
buf.WriteRune(flag)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
buf.WriteRune('v')
|
|
||||||
|
|
||||||
format = buf.String()
|
|
||||||
return format
|
|
||||||
}
|
|
||||||
|
|
||||||
// constructOrigFormat recreates the original format string including precision
|
|
||||||
// and width information to pass along to the standard fmt package. This allows
|
|
||||||
// automatic deferral of all format strings this package doesn't support.
|
|
||||||
func (f *formatState) constructOrigFormat(verb rune) (format string) {
|
|
||||||
buf := bytes.NewBuffer(percentBytes)
|
|
||||||
|
|
||||||
for _, flag := range supportedFlags {
|
|
||||||
if f.fs.Flag(int(flag)) {
|
|
||||||
buf.WriteRune(flag)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if width, ok := f.fs.Width(); ok {
|
|
||||||
buf.WriteString(strconv.Itoa(width))
|
|
||||||
}
|
|
||||||
|
|
||||||
if precision, ok := f.fs.Precision(); ok {
|
|
||||||
buf.Write(precisionBytes)
|
|
||||||
buf.WriteString(strconv.Itoa(precision))
|
|
||||||
}
|
|
||||||
|
|
||||||
buf.WriteRune(verb)
|
|
||||||
|
|
||||||
format = buf.String()
|
|
||||||
return format
|
|
||||||
}
|
|
||||||
|
|
||||||
// unpackValue returns values inside of non-nil interfaces when possible and
|
|
||||||
// ensures that types for values which have been unpacked from an interface
|
|
||||||
// are displayed when the show types flag is also set.
|
|
||||||
// This is useful for data types like structs, arrays, slices, and maps which
|
|
||||||
// can contain varying types packed inside an interface.
|
|
||||||
func (f *formatState) unpackValue(v reflect.Value) reflect.Value {
|
|
||||||
if v.Kind() == reflect.Interface {
|
|
||||||
f.ignoreNextType = false
|
|
||||||
if !v.IsNil() {
|
|
||||||
v = v.Elem()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return v
|
|
||||||
}
|
|
||||||
|
|
||||||
// formatPtr handles formatting of pointers by indirecting them as necessary.
|
|
||||||
func (f *formatState) formatPtr(v reflect.Value) {
|
|
||||||
// Display nil if top level pointer is nil.
|
|
||||||
showTypes := f.fs.Flag('#')
|
|
||||||
if v.IsNil() && (!showTypes || f.ignoreNextType) {
|
|
||||||
f.fs.Write(nilAngleBytes)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove pointers at or below the current depth from map used to detect
|
|
||||||
// circular refs.
|
|
||||||
for k, depth := range f.pointers {
|
|
||||||
if depth >= f.depth {
|
|
||||||
delete(f.pointers, k)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Keep list of all dereferenced pointers to possibly show later.
|
|
||||||
pointerChain := make([]uintptr, 0)
|
|
||||||
|
|
||||||
// Figure out how many levels of indirection there are by derferencing
|
|
||||||
// pointers and unpacking interfaces down the chain while detecting circular
|
|
||||||
// references.
|
|
||||||
nilFound := false
|
|
||||||
cycleFound := false
|
|
||||||
indirects := 0
|
|
||||||
ve := v
|
|
||||||
for ve.Kind() == reflect.Ptr {
|
|
||||||
if ve.IsNil() {
|
|
||||||
nilFound = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
indirects++
|
|
||||||
addr := ve.Pointer()
|
|
||||||
pointerChain = append(pointerChain, addr)
|
|
||||||
if pd, ok := f.pointers[addr]; ok && pd < f.depth {
|
|
||||||
cycleFound = true
|
|
||||||
indirects--
|
|
||||||
break
|
|
||||||
}
|
|
||||||
f.pointers[addr] = f.depth
|
|
||||||
|
|
||||||
ve = ve.Elem()
|
|
||||||
if ve.Kind() == reflect.Interface {
|
|
||||||
if ve.IsNil() {
|
|
||||||
nilFound = true
|
|
||||||
break
|
|
||||||
}
|
|
||||||
ve = ve.Elem()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Display type or indirection level depending on flags.
|
|
||||||
if showTypes && !f.ignoreNextType {
|
|
||||||
f.fs.Write(openParenBytes)
|
|
||||||
f.fs.Write(bytes.Repeat(asteriskBytes, indirects))
|
|
||||||
f.fs.Write([]byte(ve.Type().String()))
|
|
||||||
f.fs.Write(closeParenBytes)
|
|
||||||
} else {
|
|
||||||
if nilFound || cycleFound {
|
|
||||||
indirects += strings.Count(ve.Type().String(), "*")
|
|
||||||
}
|
|
||||||
f.fs.Write(openAngleBytes)
|
|
||||||
f.fs.Write([]byte(strings.Repeat("*", indirects)))
|
|
||||||
f.fs.Write(closeAngleBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Display pointer information depending on flags.
|
|
||||||
if f.fs.Flag('+') && (len(pointerChain) > 0) {
|
|
||||||
f.fs.Write(openParenBytes)
|
|
||||||
for i, addr := range pointerChain {
|
|
||||||
if i > 0 {
|
|
||||||
f.fs.Write(pointerChainBytes)
|
|
||||||
}
|
|
||||||
printHexPtr(f.fs, addr)
|
|
||||||
}
|
|
||||||
f.fs.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Display dereferenced value.
|
|
||||||
switch {
|
|
||||||
case nilFound:
|
|
||||||
f.fs.Write(nilAngleBytes)
|
|
||||||
|
|
||||||
case cycleFound:
|
|
||||||
f.fs.Write(circularShortBytes)
|
|
||||||
|
|
||||||
default:
|
|
||||||
f.ignoreNextType = true
|
|
||||||
f.format(ve)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// format is the main workhorse for providing the Formatter interface. It
|
|
||||||
// uses the passed reflect value to figure out what kind of object we are
|
|
||||||
// dealing with and formats it appropriately. It is a recursive function,
|
|
||||||
// however circular data structures are detected and handled properly.
|
|
||||||
func (f *formatState) format(v reflect.Value) {
|
|
||||||
// Handle invalid reflect values immediately.
|
|
||||||
kind := v.Kind()
|
|
||||||
if kind == reflect.Invalid {
|
|
||||||
f.fs.Write(invalidAngleBytes)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle pointers specially.
|
|
||||||
if kind == reflect.Ptr {
|
|
||||||
f.formatPtr(v)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print type information unless already handled elsewhere.
|
|
||||||
if !f.ignoreNextType && f.fs.Flag('#') {
|
|
||||||
f.fs.Write(openParenBytes)
|
|
||||||
f.fs.Write([]byte(v.Type().String()))
|
|
||||||
f.fs.Write(closeParenBytes)
|
|
||||||
}
|
|
||||||
f.ignoreNextType = false
|
|
||||||
|
|
||||||
// Call Stringer/error interfaces if they exist and the handle methods
|
|
||||||
// flag is enabled.
|
|
||||||
if !f.cs.DisableMethods {
|
|
||||||
if (kind != reflect.Invalid) && (kind != reflect.Interface) {
|
|
||||||
if handled := handleMethods(f.cs, f.fs, v); handled {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
switch kind {
|
|
||||||
case reflect.Invalid:
|
|
||||||
// Do nothing. We should never get here since invalid has already
|
|
||||||
// been handled above.
|
|
||||||
|
|
||||||
case reflect.Bool:
|
|
||||||
printBool(f.fs, v.Bool())
|
|
||||||
|
|
||||||
case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, reflect.Int:
|
|
||||||
printInt(f.fs, v.Int(), 10)
|
|
||||||
|
|
||||||
case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uint:
|
|
||||||
printUint(f.fs, v.Uint(), 10)
|
|
||||||
|
|
||||||
case reflect.Float32:
|
|
||||||
printFloat(f.fs, v.Float(), 32)
|
|
||||||
|
|
||||||
case reflect.Float64:
|
|
||||||
printFloat(f.fs, v.Float(), 64)
|
|
||||||
|
|
||||||
case reflect.Complex64:
|
|
||||||
printComplex(f.fs, v.Complex(), 32)
|
|
||||||
|
|
||||||
case reflect.Complex128:
|
|
||||||
printComplex(f.fs, v.Complex(), 64)
|
|
||||||
|
|
||||||
case reflect.Slice:
|
|
||||||
if v.IsNil() {
|
|
||||||
f.fs.Write(nilAngleBytes)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
fallthrough
|
|
||||||
|
|
||||||
case reflect.Array:
|
|
||||||
f.fs.Write(openBracketBytes)
|
|
||||||
f.depth++
|
|
||||||
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
|
||||||
f.fs.Write(maxShortBytes)
|
|
||||||
} else {
|
|
||||||
numEntries := v.Len()
|
|
||||||
for i := 0; i < numEntries; i++ {
|
|
||||||
if i > 0 {
|
|
||||||
f.fs.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
f.ignoreNextType = true
|
|
||||||
f.format(f.unpackValue(v.Index(i)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
f.depth--
|
|
||||||
f.fs.Write(closeBracketBytes)
|
|
||||||
|
|
||||||
case reflect.String:
|
|
||||||
f.fs.Write([]byte(v.String()))
|
|
||||||
|
|
||||||
case reflect.Interface:
|
|
||||||
// The only time we should get here is for nil interfaces due to
|
|
||||||
// unpackValue calls.
|
|
||||||
if v.IsNil() {
|
|
||||||
f.fs.Write(nilAngleBytes)
|
|
||||||
}
|
|
||||||
|
|
||||||
case reflect.Ptr:
|
|
||||||
// Do nothing. We should never get here since pointers have already
|
|
||||||
// been handled above.
|
|
||||||
|
|
||||||
case reflect.Map:
|
|
||||||
// nil maps should be indicated as different than empty maps
|
|
||||||
if v.IsNil() {
|
|
||||||
f.fs.Write(nilAngleBytes)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
f.fs.Write(openMapBytes)
|
|
||||||
f.depth++
|
|
||||||
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
|
||||||
f.fs.Write(maxShortBytes)
|
|
||||||
} else {
|
|
||||||
keys := v.MapKeys()
|
|
||||||
if f.cs.SortKeys {
|
|
||||||
sortValues(keys, f.cs)
|
|
||||||
}
|
|
||||||
for i, key := range keys {
|
|
||||||
if i > 0 {
|
|
||||||
f.fs.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
f.ignoreNextType = true
|
|
||||||
f.format(f.unpackValue(key))
|
|
||||||
f.fs.Write(colonBytes)
|
|
||||||
f.ignoreNextType = true
|
|
||||||
f.format(f.unpackValue(v.MapIndex(key)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
f.depth--
|
|
||||||
f.fs.Write(closeMapBytes)
|
|
||||||
|
|
||||||
case reflect.Struct:
|
|
||||||
numFields := v.NumField()
|
|
||||||
f.fs.Write(openBraceBytes)
|
|
||||||
f.depth++
|
|
||||||
if (f.cs.MaxDepth != 0) && (f.depth > f.cs.MaxDepth) {
|
|
||||||
f.fs.Write(maxShortBytes)
|
|
||||||
} else {
|
|
||||||
vt := v.Type()
|
|
||||||
for i := 0; i < numFields; i++ {
|
|
||||||
if i > 0 {
|
|
||||||
f.fs.Write(spaceBytes)
|
|
||||||
}
|
|
||||||
vtf := vt.Field(i)
|
|
||||||
if f.fs.Flag('+') || f.fs.Flag('#') {
|
|
||||||
f.fs.Write([]byte(vtf.Name))
|
|
||||||
f.fs.Write(colonBytes)
|
|
||||||
}
|
|
||||||
f.format(f.unpackValue(v.Field(i)))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
f.depth--
|
|
||||||
f.fs.Write(closeBraceBytes)
|
|
||||||
|
|
||||||
case reflect.Uintptr:
|
|
||||||
printHexPtr(f.fs, uintptr(v.Uint()))
|
|
||||||
|
|
||||||
case reflect.UnsafePointer, reflect.Chan, reflect.Func:
|
|
||||||
printHexPtr(f.fs, v.Pointer())
|
|
||||||
|
|
||||||
// There were not any other types at the time this code was written, but
|
|
||||||
// fall back to letting the default fmt package handle it if any get added.
|
|
||||||
default:
|
|
||||||
format := f.buildDefaultFormat()
|
|
||||||
if v.CanInterface() {
|
|
||||||
fmt.Fprintf(f.fs, format, v.Interface())
|
|
||||||
} else {
|
|
||||||
fmt.Fprintf(f.fs, format, v.String())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Format satisfies the fmt.Formatter interface. See NewFormatter for usage
|
|
||||||
// details.
|
|
||||||
func (f *formatState) Format(fs fmt.State, verb rune) {
|
|
||||||
f.fs = fs
|
|
||||||
|
|
||||||
// Use standard formatting for verbs that are not v.
|
|
||||||
if verb != 'v' {
|
|
||||||
format := f.constructOrigFormat(verb)
|
|
||||||
fmt.Fprintf(fs, format, f.value)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if f.value == nil {
|
|
||||||
if fs.Flag('#') {
|
|
||||||
fs.Write(interfaceBytes)
|
|
||||||
}
|
|
||||||
fs.Write(nilAngleBytes)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
f.format(reflect.ValueOf(f.value))
|
|
||||||
}
|
|
||||||
|
|
||||||
// newFormatter is a helper function to consolidate the logic from the various
|
|
||||||
// public methods which take varying config states.
|
|
||||||
func newFormatter(cs *ConfigState, v interface{}) fmt.Formatter {
|
|
||||||
fs := &formatState{value: v, cs: cs}
|
|
||||||
fs.pointers = make(map[uintptr]int)
|
|
||||||
return fs
|
|
||||||
}
|
|
||||||
|
|
||||||
/*
|
|
||||||
NewFormatter returns a custom formatter that satisfies the fmt.Formatter
|
|
||||||
interface. As a result, it integrates cleanly with standard fmt package
|
|
||||||
printing functions. The formatter is useful for inline printing of smaller data
|
|
||||||
types similar to the standard %v format specifier.
|
|
||||||
|
|
||||||
The custom formatter only responds to the %v (most compact), %+v (adds pointer
|
|
||||||
addresses), %#v (adds types), or %#+v (adds types and pointer addresses) verb
|
|
||||||
combinations. Any other verbs such as %x and %q will be sent to the the
|
|
||||||
standard fmt package for formatting. In addition, the custom formatter ignores
|
|
||||||
the width and precision arguments (however they will still work on the format
|
|
||||||
specifiers not handled by the custom formatter).
|
|
||||||
|
|
||||||
Typically this function shouldn't be called directly. It is much easier to make
|
|
||||||
use of the custom formatter by calling one of the convenience functions such as
|
|
||||||
Printf, Println, or Fprintf.
|
|
||||||
*/
|
|
||||||
func NewFormatter(v interface{}) fmt.Formatter {
|
|
||||||
return newFormatter(&Config, v)
|
|
||||||
}
|
|
||||||
-148
@@ -1,148 +0,0 @@
|
|||||||
/*
|
|
||||||
* Copyright (c) 2013-2016 Dave Collins <dave@davec.name>
|
|
||||||
*
|
|
||||||
* Permission to use, copy, modify, and distribute this software for any
|
|
||||||
* purpose with or without fee is hereby granted, provided that the above
|
|
||||||
* copyright notice and this permission notice appear in all copies.
|
|
||||||
*
|
|
||||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
|
||||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
|
||||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
|
||||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
|
||||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
|
||||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
|
||||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
||||||
*/
|
|
||||||
|
|
||||||
package spew
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Errorf is a wrapper for fmt.Errorf that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the formatted string as a value that satisfies error. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Errorf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Errorf(format string, a ...interface{}) (err error) {
|
|
||||||
return fmt.Errorf(format, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprint is a wrapper for fmt.Fprint that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprint(w, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Fprint(w io.Writer, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprint(w, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprintf is a wrapper for fmt.Fprintf that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprintf(w, format, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Fprintf(w io.Writer, format string, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprintf(w, format, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fprintln is a wrapper for fmt.Fprintln that treats each argument as if it
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Fprintln(w, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Fprintln(w io.Writer, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Fprintln(w, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Print is a wrapper for fmt.Print that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Print(spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Print(a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Print(convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Printf is a wrapper for fmt.Printf that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Printf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Printf(format string, a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Printf(format, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Println is a wrapper for fmt.Println that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the number of bytes written and any write error encountered. See
|
|
||||||
// NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Println(spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Println(a ...interface{}) (n int, err error) {
|
|
||||||
return fmt.Println(convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprint is a wrapper for fmt.Sprint that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprint(spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Sprint(a ...interface{}) string {
|
|
||||||
return fmt.Sprint(convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprintf is a wrapper for fmt.Sprintf that treats each argument as if it were
|
|
||||||
// passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprintf(format, spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Sprintf(format string, a ...interface{}) string {
|
|
||||||
return fmt.Sprintf(format, convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sprintln is a wrapper for fmt.Sprintln that treats each argument as if it
|
|
||||||
// were passed with a default Formatter interface returned by NewFormatter. It
|
|
||||||
// returns the resulting string. See NewFormatter for formatting details.
|
|
||||||
//
|
|
||||||
// This function is shorthand for the following syntax:
|
|
||||||
//
|
|
||||||
// fmt.Sprintln(spew.NewFormatter(a), spew.NewFormatter(b))
|
|
||||||
func Sprintln(a ...interface{}) string {
|
|
||||||
return fmt.Sprintln(convertArgs(a)...)
|
|
||||||
}
|
|
||||||
|
|
||||||
// convertArgs accepts a slice of arguments and returns a slice of the same
|
|
||||||
// length with each argument converted to a default spew Formatter interface.
|
|
||||||
func convertArgs(args []interface{}) (formatters []interface{}) {
|
|
||||||
formatters = make([]interface{}, len(args))
|
|
||||||
for index, arg := range args {
|
|
||||||
formatters[index] = NewFormatter(arg)
|
|
||||||
}
|
|
||||||
return formatters
|
|
||||||
}
|
|
||||||
-945
@@ -1,945 +0,0 @@
|
|||||||
# File @generated by scripts/docs/generate-authors.sh. DO NOT EDIT.
|
|
||||||
# This file lists all contributors to the repository.
|
|
||||||
# See scripts/docs/generate-authors.sh to make modifications.
|
|
||||||
|
|
||||||
A. Lester Buck III <github-reg@nbolt.com>
|
|
||||||
Aanand Prasad <aanand.prasad@gmail.com>
|
|
||||||
Aaron L. Xu <liker.xu@foxmail.com>
|
|
||||||
Aaron Lehmann <alehmann@netflix.com>
|
|
||||||
Aaron.L.Xu <likexu@harmonycloud.cn>
|
|
||||||
Abdur Rehman <abdur_rehman@mentor.com>
|
|
||||||
Abhinandan Prativadi <abhi@docker.com>
|
|
||||||
Abin Shahab <ashahab@altiscale.com>
|
|
||||||
Abreto FU <public@abreto.email>
|
|
||||||
Ace Tang <aceapril@126.com>
|
|
||||||
Addam Hardy <addam.hardy@gmail.com>
|
|
||||||
Adolfo Ochagavía <aochagavia92@gmail.com>
|
|
||||||
Adrian Plata <adrian.plata@docker.com>
|
|
||||||
Adrien Duermael <adrien@duermael.com>
|
|
||||||
Adrien Folie <folie.adrien@gmail.com>
|
|
||||||
Adyanth Hosavalike <ahosavalike@ucsd.edu>
|
|
||||||
Ahmet Alp Balkan <ahmetb@microsoft.com>
|
|
||||||
Aidan Feldman <aidan.feldman@gmail.com>
|
|
||||||
Aidan Hobson Sayers <aidanhs@cantab.net>
|
|
||||||
AJ Bowen <aj@soulshake.net>
|
|
||||||
Akhil Mohan <akhil.mohan@mayadata.io>
|
|
||||||
Akihiro Suda <akihiro.suda.cz@hco.ntt.co.jp>
|
|
||||||
Akim Demaille <akim.demaille@docker.com>
|
|
||||||
Alan Thompson <cloojure@gmail.com>
|
|
||||||
Alano Terblanche <alano.terblanche@docker.com>
|
|
||||||
Albert Callarisa <shark234@gmail.com>
|
|
||||||
Alberto Roura <mail@albertoroura.com>
|
|
||||||
Albin Kerouanton <albinker@gmail.com>
|
|
||||||
Aleksa Sarai <asarai@suse.de>
|
|
||||||
Aleksander Piotrowski <apiotrowski312@gmail.com>
|
|
||||||
Alessandro Boch <aboch@tetrationanalytics.com>
|
|
||||||
Alex Couture-Beil <alex@earthly.dev>
|
|
||||||
Alex Mavrogiannis <alex.mavrogiannis@docker.com>
|
|
||||||
Alex Mayer <amayer5125@gmail.com>
|
|
||||||
Alexander Boyd <alex@opengroove.org>
|
|
||||||
Alexander Chneerov <achneerov@gmail.com>
|
|
||||||
Alexander Larsson <alexl@redhat.com>
|
|
||||||
Alexander Morozov <lk4d4math@gmail.com>
|
|
||||||
Alexander Ryabov <i@sepa.spb.ru>
|
|
||||||
Alexandre González <agonzalezro@gmail.com>
|
|
||||||
Alexey Igrychev <alexey.igrychev@flant.com>
|
|
||||||
Alexis Couvreur <alexiscouvreur.pro@gmail.com>
|
|
||||||
Alfred Landrum <alfred.landrum@docker.com>
|
|
||||||
Ali Rostami <rostami.ali@gmail.com>
|
|
||||||
Alicia Lauerman <alicia@eta.im>
|
|
||||||
Allen Sun <allensun.shl@alibaba-inc.com>
|
|
||||||
Allie Sadler <allie.sadler@docker.com>
|
|
||||||
Alvin Deng <alvin.q.deng@utexas.edu>
|
|
||||||
Amen Belayneh <amenbelayneh@gmail.com>
|
|
||||||
Amey Shrivastava <72866602+AmeyShrivastava@users.noreply.github.com>
|
|
||||||
Amir Goldstein <amir73il@aquasec.com>
|
|
||||||
Amit Krishnan <amit.krishnan@oracle.com>
|
|
||||||
Amit Shukla <amit.shukla@docker.com>
|
|
||||||
Amy Lindburg <amy.lindburg@docker.com>
|
|
||||||
Anca Iordache <anca.iordache@docker.com>
|
|
||||||
Anda Xu <anda.xu@docker.com>
|
|
||||||
Andrea Luzzardi <aluzzardi@gmail.com>
|
|
||||||
Andreas Köhler <andi5.py@gmx.net>
|
|
||||||
Andres G. Aragoneses <knocte@gmail.com>
|
|
||||||
Andres Leon Rangel <aleon1220@gmail.com>
|
|
||||||
Andrew France <andrew@avito.co.uk>
|
|
||||||
Andrew He <he.andrew.mail@gmail.com>
|
|
||||||
Andrew Hsu <andrewhsu@docker.com>
|
|
||||||
Andrew Macpherson <hopscotch23@gmail.com>
|
|
||||||
Andrew McDonnell <bugs@andrewmcdonnell.net>
|
|
||||||
Andrew Po <absourd.noise@gmail.com>
|
|
||||||
Andrew-Zipperer <atzipperer@gmail.com>
|
|
||||||
Andrey Petrov <andrey.petrov@shazow.net>
|
|
||||||
Andrii Berehuliak <berkusandrew@gmail.com>
|
|
||||||
André Martins <aanm90@gmail.com>
|
|
||||||
Andy Goldstein <agoldste@redhat.com>
|
|
||||||
Andy Rothfusz <github@developersupport.net>
|
|
||||||
Anil Madhavapeddy <anil@recoil.org>
|
|
||||||
Ankush Agarwal <ankushagarwal11@gmail.com>
|
|
||||||
Anne Henmi <anne.henmi@docker.com>
|
|
||||||
Anton Polonskiy <anton.polonskiy@gmail.com>
|
|
||||||
Antonio Murdaca <antonio.murdaca@gmail.com>
|
|
||||||
Antonis Kalipetis <akalipetis@gmail.com>
|
|
||||||
Anusha Ragunathan <anusha.ragunathan@docker.com>
|
|
||||||
Ao Li <la9249@163.com>
|
|
||||||
Arash Deshmeh <adeshmeh@ca.ibm.com>
|
|
||||||
Archimedes Trajano <developer@trajano.net>
|
|
||||||
Arko Dasgupta <arko@tetrate.io>
|
|
||||||
Arnaud Porterie <icecrime@gmail.com>
|
|
||||||
Arnaud Rebillout <elboulangero@gmail.com>
|
|
||||||
Arthur Flageul <arthur.flageul@gmail.com>
|
|
||||||
Arthur Peka <arthur.peka@outlook.com>
|
|
||||||
Ashly Mathew <ashly.mathew@sap.com>
|
|
||||||
Ashwini Oruganti <ashwini.oruganti@gmail.com>
|
|
||||||
Aslam Ahemad <aslamahemad@gmail.com>
|
|
||||||
Austin Vazquez <austin.vazquez@docker.com>
|
|
||||||
Azat Khuyiyakhmetov <shadow_uz@mail.ru>
|
|
||||||
Bardia Keyoumarsi <bkeyouma@ucsc.edu>
|
|
||||||
Barnaby Gray <barnaby@pickle.me.uk>
|
|
||||||
Bastiaan Bakker <bbakker@xebia.com>
|
|
||||||
BastianHofmann <bastianhofmann@me.com>
|
|
||||||
Ben Bodenmiller <bbodenmiller@gmail.com>
|
|
||||||
Ben Bonnefoy <frenchben@docker.com>
|
|
||||||
Ben Creasy <ben@bencreasy.com>
|
|
||||||
Ben Firshman <ben@firshman.co.uk>
|
|
||||||
Benjamin Boudreau <boudreau.benjamin@gmail.com>
|
|
||||||
Benjamin Böhmke <benjamin@boehmke.net>
|
|
||||||
Benjamin Nater <me@bn4t.me>
|
|
||||||
Benoit Sigoure <tsunanet@gmail.com>
|
|
||||||
Bhumika Bayani <bhumikabayani@gmail.com>
|
|
||||||
Bill Wang <ozbillwang@gmail.com>
|
|
||||||
Bin Liu <liubin0329@gmail.com>
|
|
||||||
Bingshen Wang <bingshen.wbs@alibaba-inc.com>
|
|
||||||
Bishal Das <bishalhnj127@gmail.com>
|
|
||||||
Bjorn Neergaard <bjorn.neergaard@docker.com>
|
|
||||||
Boaz Shuster <ripcurld.github@gmail.com>
|
|
||||||
Boban Acimovic <boban.acimovic@gmail.com>
|
|
||||||
Bogdan Anton <contact@bogdananton.ro>
|
|
||||||
Boris Pruessmann <boris@pruessmann.org>
|
|
||||||
Brad Baker <brad@brad.fi>
|
|
||||||
Bradley Cicenas <bradley.cicenas@gmail.com>
|
|
||||||
Brandon Mitchell <git@bmitch.net>
|
|
||||||
Brandon Philips <brandon.philips@coreos.com>
|
|
||||||
Brent Salisbury <brent.salisbury@docker.com>
|
|
||||||
Bret Fisher <bret@bretfisher.com>
|
|
||||||
Brian (bex) Exelbierd <bexelbie@redhat.com>
|
|
||||||
Brian Goff <cpuguy83@gmail.com>
|
|
||||||
Brian Tracy <brian.tracy33@gmail.com>
|
|
||||||
Brian Wieder <brian@4wieders.com>
|
|
||||||
Bruno Sousa <bruno.sousa@docker.com>
|
|
||||||
Bryan Bess <squarejaw@bsbess.com>
|
|
||||||
Bryan Boreham <bjboreham@gmail.com>
|
|
||||||
Bryan Murphy <bmurphy1976@gmail.com>
|
|
||||||
bryfry <bryon.fryer@gmail.com>
|
|
||||||
Calvin Liu <flycalvin@qq.com>
|
|
||||||
Cameron Spear <cameronspear@gmail.com>
|
|
||||||
Cao Weiwei <cao.weiwei30@zte.com.cn>
|
|
||||||
Carlo Mion <mion00@gmail.com>
|
|
||||||
Carlos Alexandro Becker <caarlos0@gmail.com>
|
|
||||||
Carlos de Paula <me@carlosedp.com>
|
|
||||||
carsontham <carsontham@outlook.com>
|
|
||||||
Carston Schilds <Carston.Schilds@visier.com>
|
|
||||||
Casey Korver <casey@korver.dev>
|
|
||||||
Ce Gao <ce.gao@outlook.com>
|
|
||||||
Cedric Davies <cedricda@microsoft.com>
|
|
||||||
Cesar Talledo <cesar.talledo@docker.com>
|
|
||||||
Cezar Sa Espinola <cezarsa@gmail.com>
|
|
||||||
Chad Faragher <wyckster@hotmail.com>
|
|
||||||
Chao Wang <wangchao.fnst@cn.fujitsu.com>
|
|
||||||
Charles Chan <charleswhchan@users.noreply.github.com>
|
|
||||||
Charles Law <claw@conduce.com>
|
|
||||||
Charles Smith <charles.smith@docker.com>
|
|
||||||
Charlie Drage <charlie@charliedrage.com>
|
|
||||||
Charlotte Mach <charlotte.mach@fs.lmu.de>
|
|
||||||
ChaYoung You <yousbe@gmail.com>
|
|
||||||
Chee Hau Lim <cheehau.lim@mobimeo.com>
|
|
||||||
Chen Chuanliang <chen.chuanliang@zte.com.cn>
|
|
||||||
Chen Hanxiao <chenhanxiao@cn.fujitsu.com>
|
|
||||||
Chen Mingjie <chenmingjie0828@163.com>
|
|
||||||
Chen Qiu <cheney-90@hotmail.com>
|
|
||||||
Chris Chinchilla <chris@chrischinchilla.com>
|
|
||||||
Chris Couzens <ccouzens@gmail.com>
|
|
||||||
Chris Gavin <chris@chrisgavin.me>
|
|
||||||
Chris Gibson <chris@chrisg.io>
|
|
||||||
Chris McKinnel <chrismckinnel@gmail.com>
|
|
||||||
Chris Snow <chsnow123@gmail.com>
|
|
||||||
Chris Vermilion <christopher.vermilion@gmail.com>
|
|
||||||
Chris Weyl <cweyl@alumni.drew.edu>
|
|
||||||
Christian Persson <saser@live.se>
|
|
||||||
Christian Stefanescu <st.chris@gmail.com>
|
|
||||||
Christophe Robin <crobin@nekoo.com>
|
|
||||||
Christophe Vidal <kriss@krizalys.com>
|
|
||||||
Christopher Biscardi <biscarch@sketcht.com>
|
|
||||||
Christopher Crone <christopher.crone@docker.com>
|
|
||||||
Christopher Jones <tophj@linux.vnet.ibm.com>
|
|
||||||
Christopher Petito <47751006+krissetto@users.noreply.github.com>
|
|
||||||
Christopher Petito <chrisjpetito@gmail.com>
|
|
||||||
Christopher Svensson <stoffus@stoffus.com>
|
|
||||||
Christy Norman <christy@linux.vnet.ibm.com>
|
|
||||||
Chun Chen <ramichen@tencent.com>
|
|
||||||
Clinton Kitson <clintonskitson@gmail.com>
|
|
||||||
Coenraad Loubser <coenraad@wish.org.za>
|
|
||||||
Colin Hebert <hebert.colin@gmail.com>
|
|
||||||
Collin Guarino <collin.guarino@gmail.com>
|
|
||||||
Colm Hally <colmhally@gmail.com>
|
|
||||||
Comical Derskeal <27731088+derskeal@users.noreply.github.com>
|
|
||||||
Conner Crosby <conner@cavcrosby.tech>
|
|
||||||
Corey Farrell <git@cfware.com>
|
|
||||||
Corey Quon <corey.quon@docker.com>
|
|
||||||
Cory Bennet <cbennett@netflix.com>
|
|
||||||
Cory Snider <csnider@mirantis.com>
|
|
||||||
Craig Osterhout <craig.osterhout@docker.com>
|
|
||||||
Craig Wilhite <crwilhit@microsoft.com>
|
|
||||||
Cristian Staretu <cristian.staretu@gmail.com>
|
|
||||||
Daehyeok Mun <daehyeok@gmail.com>
|
|
||||||
Dafydd Crosby <dtcrsby@gmail.com>
|
|
||||||
Daisuke Ito <itodaisuke00@gmail.com>
|
|
||||||
dalanlan <dalanlan925@gmail.com>
|
|
||||||
Damien Nadé <github@livna.org>
|
|
||||||
Dan Cotora <dan@bluevision.ro>
|
|
||||||
Dan Wallis <dan@wallis.nz>
|
|
||||||
Danial Gharib <danial.mail.gh@gmail.com>
|
|
||||||
Daniel Artine <daniel.artine@ufrj.br>
|
|
||||||
Daniel Cassidy <mail@danielcassidy.me.uk>
|
|
||||||
Daniel Dao <dqminh@cloudflare.com>
|
|
||||||
Daniel Farrell <dfarrell@redhat.com>
|
|
||||||
Daniel Gasienica <daniel@gasienica.ch>
|
|
||||||
Daniel Goosen <daniel.goosen@surveysampling.com>
|
|
||||||
Daniel Helfand <dhelfand@redhat.com>
|
|
||||||
Daniel Hiltgen <daniel.hiltgen@docker.com>
|
|
||||||
Daniel J Walsh <dwalsh@redhat.com>
|
|
||||||
Daniel Nephin <dnephin@docker.com>
|
|
||||||
Daniel Norberg <dano@spotify.com>
|
|
||||||
Daniel Watkins <daniel@daniel-watkins.co.uk>
|
|
||||||
Daniel Zhang <jmzwcn@gmail.com>
|
|
||||||
Daniil Nikolenko <qoo2p5@gmail.com>
|
|
||||||
Danny Berger <dpb587@gmail.com>
|
|
||||||
Darren Shepherd <darren.s.shepherd@gmail.com>
|
|
||||||
Darren Stahl <darst@microsoft.com>
|
|
||||||
Dattatraya Kumbhar <dattatraya.kumbhar@gslab.com>
|
|
||||||
Dave Goodchild <buddhamagnet@gmail.com>
|
|
||||||
Dave Henderson <dhenderson@gmail.com>
|
|
||||||
Dave Tucker <dt@docker.com>
|
|
||||||
David Alvarez <david.alvarez@flyeralarm.com>
|
|
||||||
David Beitey <david@davidjb.com>
|
|
||||||
David Calavera <david.calavera@gmail.com>
|
|
||||||
David Cramer <davcrame@cisco.com>
|
|
||||||
David Dooling <david.dooling@docker.com>
|
|
||||||
David Gageot <david@gageot.net>
|
|
||||||
David Karlsson <david.karlsson@docker.com>
|
|
||||||
David le Blanc <systemmonkey42@users.noreply.github.com>
|
|
||||||
David Lechner <david@lechnology.com>
|
|
||||||
David Scott <dave@recoil.org>
|
|
||||||
David Sheets <dsheets@docker.com>
|
|
||||||
David Williamson <david.williamson@docker.com>
|
|
||||||
David Xia <dxia@spotify.com>
|
|
||||||
David Young <yangboh@cn.ibm.com>
|
|
||||||
Deng Guangxing <dengguangxing@huawei.com>
|
|
||||||
Denis Defreyne <denis@soundcloud.com>
|
|
||||||
Denis Gladkikh <denis@gladkikh.email>
|
|
||||||
Denis Ollier <larchunix@users.noreply.github.com>
|
|
||||||
Dennis Docter <dennis@d23.nl>
|
|
||||||
dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
|
|
||||||
Derek McGowan <derek@mcg.dev>
|
|
||||||
Des Preston <despreston@gmail.com>
|
|
||||||
Deshi Xiao <dxiao@redhat.com>
|
|
||||||
Dharmit Shah <shahdharmit@gmail.com>
|
|
||||||
Dhawal Yogesh Bhanushali <dbhanushali@vmware.com>
|
|
||||||
Dieter Reuter <dieter.reuter@me.com>
|
|
||||||
Dilep Dev <34891655+DilepDev@users.noreply.github.com>
|
|
||||||
Dima Stopel <dima@twistlock.com>
|
|
||||||
Dimitry Andric <d.andric@activevideo.com>
|
|
||||||
Ding Fei <dingfei@stars.org.cn>
|
|
||||||
Diogo Monica <diogo@docker.com>
|
|
||||||
Djordje Lukic <djordje.lukic@docker.com>
|
|
||||||
Dmitriy Fishman <fishman.code@gmail.com>
|
|
||||||
Dmitry Gusev <dmitry.gusev@gmail.com>
|
|
||||||
Dmitry Smirnov <onlyjob@member.fsf.org>
|
|
||||||
Dmitry V. Krivenok <krivenok.dmitry@gmail.com>
|
|
||||||
Dominik Braun <dominik.braun@nbsp.de>
|
|
||||||
Don Kjer <don.kjer@gmail.com>
|
|
||||||
Dong Chen <dongluo.chen@docker.com>
|
|
||||||
DongGeon Lee <secmatth1996@gmail.com>
|
|
||||||
Doug Davis <dug@us.ibm.com>
|
|
||||||
Drew Erny <derny@mirantis.com>
|
|
||||||
Ed Costello <epc@epcostello.com>
|
|
||||||
Ed Morley <501702+edmorley@users.noreply.github.com>
|
|
||||||
Elango Sivanandam <elango.siva@docker.com>
|
|
||||||
Eli Uriegas <eli.uriegas@docker.com>
|
|
||||||
Eli Uriegas <seemethere101@gmail.com>
|
|
||||||
Elias Faxö <elias.faxo@tre.se>
|
|
||||||
Elliot Luo <956941328@qq.com>
|
|
||||||
Eng Zer Jun <engzerjun@gmail.com>
|
|
||||||
Eric Bode <eric.bode@foundries.io>
|
|
||||||
Eric Curtin <ericcurtin17@gmail.com>
|
|
||||||
Eric Engestrom <eric@engestrom.ch>
|
|
||||||
Eric G. Noriega <enoriega@vizuri.com>
|
|
||||||
Eric Rosenberg <ehaydenr@gmail.com>
|
|
||||||
Eric Sage <eric.david.sage@gmail.com>
|
|
||||||
Eric-Olivier Lamey <eo@lamey.me>
|
|
||||||
Erica Windisch <erica@windisch.us>
|
|
||||||
Erik Hollensbe <github@hollensbe.org>
|
|
||||||
Erik Humphrey <erik.humphrey@carleton.ca>
|
|
||||||
Erik St. Martin <alakriti@gmail.com>
|
|
||||||
Essam A. Hassan <es.hassan187@gmail.com>
|
|
||||||
Ethan Haynes <ethanhaynes@alumni.harvard.edu>
|
|
||||||
Euan Kemp <euank@euank.com>
|
|
||||||
Eugene Yakubovich <eugene.yakubovich@coreos.com>
|
|
||||||
Evan Allrich <evan@unguku.com>
|
|
||||||
Evan Hazlett <ejhazlett@gmail.com>
|
|
||||||
Evan Krall <krall@yelp.com>
|
|
||||||
Evan Lezar <elezar@nvidia.com>
|
|
||||||
Evelyn Xu <evelynhsu21@gmail.com>
|
|
||||||
Everett Toews <everett.toews@rackspace.com>
|
|
||||||
Fabio Falci <fabiofalci@gmail.com>
|
|
||||||
Fabrizio Soppelsa <fsoppelsa@mirantis.com>
|
|
||||||
Felix Geyer <debfx@fobos.de>
|
|
||||||
Felix Hupfeld <felix@quobyte.com>
|
|
||||||
Felix Rabe <felix@rabe.io>
|
|
||||||
fezzik1620 <fezzik1620@users.noreply.github.com>
|
|
||||||
Filip Jareš <filipjares@gmail.com>
|
|
||||||
Flavio Crisciani <flavio.crisciani@docker.com>
|
|
||||||
Florian Klein <florian.klein@free.fr>
|
|
||||||
Forest Johnson <fjohnson@peoplenetonline.com>
|
|
||||||
Foysal Iqbal <foysal.iqbal.fb@gmail.com>
|
|
||||||
François Scala <francois.scala@swiss-as.com>
|
|
||||||
Fred Lifton <fred.lifton@docker.com>
|
|
||||||
Frederic Hemberger <mail@frederic-hemberger.de>
|
|
||||||
Frederick F. Kautz IV <fkautz@redhat.com>
|
|
||||||
Frederik Nordahl Jul Sabroe <frederikns@gmail.com>
|
|
||||||
Frieder Bluemle <frieder.bluemle@gmail.com>
|
|
||||||
Gabriel Gore <gabgore@cisco.com>
|
|
||||||
Gabriel Nicolas Avellaneda <avellaneda.gabriel@gmail.com>
|
|
||||||
Gabriela Georgieva <gabriela.georgieva@docker.com>
|
|
||||||
Gaetan de Villele <gdevillele@gmail.com>
|
|
||||||
Gang Qiao <qiaohai8866@gmail.com>
|
|
||||||
Gary Schaetz <gary@schaetzkc.com>
|
|
||||||
Genki Takiuchi <genki@s21g.com>
|
|
||||||
George MacRorie <gmacr31@gmail.com>
|
|
||||||
George Margaritis <gmargaritis@protonmail.com>
|
|
||||||
George Xie <georgexsh@gmail.com>
|
|
||||||
Gianluca Borello <g.borello@gmail.com>
|
|
||||||
Giau. Tran Minh <hello@giautm.dev>
|
|
||||||
Giedrius Jonikas <giedriusj1@gmail.com>
|
|
||||||
Gildas Cuisinier <gildas.cuisinier@gcuisinier.net>
|
|
||||||
Gio d'Amelio <giodamelio@gmail.com>
|
|
||||||
Gleb Stsenov <gleb.stsenov@gmail.com>
|
|
||||||
Goksu Toprak <goksu.toprak@docker.com>
|
|
||||||
Gou Rao <gou@portworx.com>
|
|
||||||
Govind Rai <raigovind93@gmail.com>
|
|
||||||
Grace Choi <grace.54109@gmail.com>
|
|
||||||
Graeme Wiebe <graeme.wiebe@gmail.com>
|
|
||||||
Grant Reaber <grant.reaber@gmail.com>
|
|
||||||
Greg Pflaum <gpflaum@users.noreply.github.com>
|
|
||||||
Gsealy <jiaojingwei1001@hotmail.com>
|
|
||||||
Guilhem Lettron <guilhem+github@lettron.fr>
|
|
||||||
Guillaume J. Charmes <guillaume.charmes@docker.com>
|
|
||||||
Guillaume Le Floch <glfloch@gmail.com>
|
|
||||||
Guillaume Tardif <guillaume.tardif@gmail.com>
|
|
||||||
gwx296173 <gaojing3@huawei.com>
|
|
||||||
Günther Jungbluth <gunther@gameslabs.net>
|
|
||||||
Hakan Özler <hakan.ozler@kodcu.com>
|
|
||||||
Hao Zhang <21521210@zju.edu.cn>
|
|
||||||
Harald Albers <github@albersweb.de>
|
|
||||||
Harold Cooper <hrldcpr@gmail.com>
|
|
||||||
Harry Zhang <harryz@hyper.sh>
|
|
||||||
He Simei <hesimei@zju.edu.cn>
|
|
||||||
Hector S <hfsam88@gmail.com>
|
|
||||||
Helen Xie <chenjg@harmonycloud.cn>
|
|
||||||
Henning Sprang <henning.sprang@gmail.com>
|
|
||||||
Henry N <henrynmail-github@yahoo.de>
|
|
||||||
Hernan Garcia <hernandanielg@gmail.com>
|
|
||||||
Hongbin Lu <hongbin034@gmail.com>
|
|
||||||
Hossein Abbasi <16090309+hsnabszhdn@users.noreply.github.com>
|
|
||||||
Hu Keping <hukeping@huawei.com>
|
|
||||||
Huayi Zhang <irachex@gmail.com>
|
|
||||||
Hugo Chastel <Hugo-C@users.noreply.github.com>
|
|
||||||
Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
|
|
||||||
huqun <huqun@zju.edu.cn>
|
|
||||||
Huu Nguyen <huu@prismskylabs.com>
|
|
||||||
Hyzhou Zhy <hyzhou.zhy@alibaba-inc.com>
|
|
||||||
Iain MacDonald <IJMacD@gmail.com>
|
|
||||||
Iain Samuel McLean Elder <iain@isme.es>
|
|
||||||
Ian Campbell <ian.campbell@docker.com>
|
|
||||||
Ian Philpot <ian.philpot@microsoft.com>
|
|
||||||
Ignacio Capurro <icapurrofagian@gmail.com>
|
|
||||||
Ilya Dmitrichenko <errordeveloper@gmail.com>
|
|
||||||
Ilya Khlopotov <ilya.khlopotov@gmail.com>
|
|
||||||
Ilya Sotkov <ilya@sotkov.com>
|
|
||||||
Ioan Eugen Stan <eu@ieugen.ro>
|
|
||||||
Isabel Jimenez <contact.isabeljimenez@gmail.com>
|
|
||||||
Ivan Grcic <igrcic@gmail.com>
|
|
||||||
Ivan Grund <ivan.grund@gmail.com>
|
|
||||||
Ivan Markin <sw@nogoegst.net>
|
|
||||||
Jacob Atzen <jacob@jacobatzen.dk>
|
|
||||||
Jacob Tomlinson <jacob@tom.linson.uk>
|
|
||||||
Jacopo Rigoli <rigoli.jacopo@gmail.com>
|
|
||||||
Jaivish Kothari <janonymous.codevulture@gmail.com>
|
|
||||||
Jake Lambert <jake.lambert@volusion.com>
|
|
||||||
Jake Sanders <jsand@google.com>
|
|
||||||
Jake Stokes <contactjake@developerjake.com>
|
|
||||||
Jakub Panek <me@panekj.dev>
|
|
||||||
James Nesbitt <james.nesbitt@wunderkraut.com>
|
|
||||||
James Turnbull <james@lovedthanlost.net>
|
|
||||||
Jamie Hannaford <jamie@limetree.org>
|
|
||||||
Jan Koprowski <jan.koprowski@gmail.com>
|
|
||||||
Jan Pazdziora <jpazdziora@redhat.com>
|
|
||||||
Jan-Jaap Driessen <janjaapdriessen@gmail.com>
|
|
||||||
Jana Radhakrishnan <mrjana@docker.com>
|
|
||||||
Jared Hocutt <jaredh@netapp.com>
|
|
||||||
Jasmine Hegman <jasmine@jhegman.com>
|
|
||||||
Jason Hall <jason@chainguard.dev>
|
|
||||||
Jason Heiss <jheiss@aput.net>
|
|
||||||
Jason Plum <jplum@devonit.com>
|
|
||||||
Jay Kamat <github@jgkamat.33mail.com>
|
|
||||||
Jean Lecordier <jeanlecordier@hotmail.fr>
|
|
||||||
Jean Rouge <rougej+github@gmail.com>
|
|
||||||
Jean-Christophe Sirot <jean-christophe.sirot@docker.com>
|
|
||||||
Jean-Pierre Huynh <jean-pierre.huynh@ounet.fr>
|
|
||||||
Jeff Lindsay <progrium@gmail.com>
|
|
||||||
Jeff Nickoloff <jeff.nickoloff@gmail.com>
|
|
||||||
Jeff Silberman <jsilberm@gmail.com>
|
|
||||||
Jennings Zhang <jenni_zh@protonmail.com>
|
|
||||||
Jeremy Chambers <jeremy@thehipbot.com>
|
|
||||||
Jeremy Unruh <jeremybunruh@gmail.com>
|
|
||||||
Jeremy Yallop <yallop@docker.com>
|
|
||||||
Jeroen Franse <jeroenfranse@gmail.com>
|
|
||||||
Jesse Adametz <jesseadametz@gmail.com>
|
|
||||||
Jessica Frazelle <jess@oxide.computer>
|
|
||||||
Jezeniel Zapanta <jpzapanta22@gmail.com>
|
|
||||||
Jian Zhang <zhangjian.fnst@cn.fujitsu.com>
|
|
||||||
Jianyong Wu <wujianyong@hygon.cn>
|
|
||||||
Jie Luo <luo612@zju.edu.cn>
|
|
||||||
Jilles Oldenbeuving <ojilles@gmail.com>
|
|
||||||
Jim Chen <njucjc@gmail.com>
|
|
||||||
Jim Galasyn <jim.galasyn@docker.com>
|
|
||||||
Jim Lin <b04705003@ntu.edu.tw>
|
|
||||||
Jimmy Leger <jimmy.leger@gmail.com>
|
|
||||||
Jimmy Song <rootsongjc@gmail.com>
|
|
||||||
jimmyxian <jimmyxian2004@yahoo.com.cn>
|
|
||||||
Jintao Zhang <zhangjintao9020@gmail.com>
|
|
||||||
Joao Fernandes <joao.fernandes@docker.com>
|
|
||||||
Joe Abbey <joe.abbey@gmail.com>
|
|
||||||
Joe Doliner <jdoliner@pachyderm.io>
|
|
||||||
Joe Gordon <joe.gordon0@gmail.com>
|
|
||||||
Joel Handwell <joelhandwell@gmail.com>
|
|
||||||
Joey Geiger <jgeiger@gmail.com>
|
|
||||||
Joffrey F <joffrey@docker.com>
|
|
||||||
Johan Euphrosine <proppy@google.com>
|
|
||||||
Johannes 'fish' Ziemke <github@freigeist.org>
|
|
||||||
John Feminella <jxf@jxf.me>
|
|
||||||
John Harris <john@johnharris.io>
|
|
||||||
John Howard <github@lowenna.com>
|
|
||||||
John Howard <howardjohn@google.com>
|
|
||||||
John Laswell <john.n.laswell@gmail.com>
|
|
||||||
John Maguire <jmaguire@duosecurity.com>
|
|
||||||
John Mulhausen <john@docker.com>
|
|
||||||
John Starks <jostarks@microsoft.com>
|
|
||||||
John Stephens <johnstep@docker.com>
|
|
||||||
John Tims <john.k.tims@gmail.com>
|
|
||||||
John V. Martinez <jvmatl@gmail.com>
|
|
||||||
John Willis <john.willis@docker.com>
|
|
||||||
Jon Johnson <jonjohnson@google.com>
|
|
||||||
Jon Zeolla <zeolla@gmail.com>
|
|
||||||
Jonatas Baldin <jonatas.baldin@gmail.com>
|
|
||||||
Jonathan A. Sternberg <jonathansternberg@gmail.com>
|
|
||||||
Jonathan Boulle <jonathanboulle@gmail.com>
|
|
||||||
Jonathan Lee <jonjohn1232009@gmail.com>
|
|
||||||
Jonathan Lomas <jonathan@floatinglomas.ca>
|
|
||||||
Jonathan McCrohan <jmccrohan@gmail.com>
|
|
||||||
Jonathan Warriss-Simmons <misterws@diogenes.ws>
|
|
||||||
Jonh Wendell <jonh.wendell@redhat.com>
|
|
||||||
Jordan Jennings <jjn2009@gmail.com>
|
|
||||||
Jorge Vallecillo <jorgevallecilloc@gmail.com>
|
|
||||||
Jose J. Escobar <53836904+jescobar-docker@users.noreply.github.com>
|
|
||||||
Joseph Kern <jkern@semafour.net>
|
|
||||||
Josh Bodah <jb3689@yahoo.com>
|
|
||||||
Josh Chorlton <jchorlton@gmail.com>
|
|
||||||
Josh Hawn <josh.hawn@docker.com>
|
|
||||||
Josh Horwitz <horwitz@addthis.com>
|
|
||||||
Josh Soref <jsoref@gmail.com>
|
|
||||||
Julian <gitea+julian@ic.thejulian.uk>
|
|
||||||
Julien Barbier <write0@gmail.com>
|
|
||||||
Julien Kassar <github@kassisol.com>
|
|
||||||
Julien Maitrehenry <julien.maitrehenry@me.com>
|
|
||||||
Julio Cesar Garcia <juliogarciamelgarejo@gmail.com>
|
|
||||||
Justas Brazauskas <brazauskasjustas@gmail.com>
|
|
||||||
Justin Chadwell <me@jedevc.com>
|
|
||||||
Justin Cormack <justin.cormack@docker.com>
|
|
||||||
Justin Simonelis <justin.p.simonelis@gmail.com>
|
|
||||||
Justyn Temme <justyntemme@gmail.com>
|
|
||||||
Jyrki Puttonen <jyrkiput@gmail.com>
|
|
||||||
Jérémie Drouet <jeremie.drouet@gmail.com>
|
|
||||||
Jérôme Petazzoni <jerome.petazzoni@docker.com>
|
|
||||||
Jörg Thalheim <joerg@higgsboson.tk>
|
|
||||||
Kai Blin <kai@samba.org>
|
|
||||||
Kai Qiang Wu (Kennan) <wkq5325@gmail.com>
|
|
||||||
Kara Alexandra <kalexandra@us.ibm.com>
|
|
||||||
Kareem Khazem <karkhaz@karkhaz.com>
|
|
||||||
Karthik Nayak <Karthik.188@gmail.com>
|
|
||||||
Kat Samperi <kat.samperi@gmail.com>
|
|
||||||
Kathryn Spiers <kathryn@spiers.me>
|
|
||||||
Katie McLaughlin <katie@glasnt.com>
|
|
||||||
Ke Xu <leonhartx.k@gmail.com>
|
|
||||||
Kei Ohmura <ohmura.kei@gmail.com>
|
|
||||||
Keith Hudgins <greenman@greenman.org>
|
|
||||||
Kelton Bassingthwaite <KeltonBassingthwaite@gmail.com>
|
|
||||||
Ken Cochrane <kencochrane@gmail.com>
|
|
||||||
Ken ICHIKAWA <ichikawa.ken@jp.fujitsu.com>
|
|
||||||
Kenfe-Mickaël Laventure <mickael.laventure@gmail.com>
|
|
||||||
Kevin Alvarez <github@crazymax.dev>
|
|
||||||
Kevin Burke <kev@inburke.com>
|
|
||||||
Kevin Feyrer <kevin.feyrer@btinternet.com>
|
|
||||||
Kevin Kern <kaiwentan@harmonycloud.cn>
|
|
||||||
Kevin Kirsche <Kev.Kirsche+GitHub@gmail.com>
|
|
||||||
Kevin Meredith <kevin.m.meredith@gmail.com>
|
|
||||||
Kevin Richardson <kevin@kevinrichardson.co>
|
|
||||||
Kevin Woblick <mail@kovah.de>
|
|
||||||
khaled souf <khaled.souf@gmail.com>
|
|
||||||
Kim Eik <kim@heldig.org>
|
|
||||||
Kir Kolyshkin <kolyshkin@gmail.com>
|
|
||||||
Kirill A. Korinsky <kirill@korins.ky>
|
|
||||||
Kotaro Yoshimatsu <kotaro.yoshimatsu@gmail.com>
|
|
||||||
Krasi Georgiev <krasi@vip-consult.solutions>
|
|
||||||
Kris-Mikael Krister <krismikael@protonmail.com>
|
|
||||||
Kun Zhang <zkazure@gmail.com>
|
|
||||||
Kunal Kushwaha <kushwaha_kunal_v7@lab.ntt.co.jp>
|
|
||||||
Kyle Mitofsky <Kylemit@gmail.com>
|
|
||||||
Lachlan Cooper <lachlancooper@gmail.com>
|
|
||||||
Lai Jiangshan <jiangshanlai@gmail.com>
|
|
||||||
Lajos Papp <lajos.papp@sequenceiq.com>
|
|
||||||
Lars Kellogg-Stedman <lars@redhat.com>
|
|
||||||
Laura Brehm <laurabrehm@hey.com>
|
|
||||||
Laura Frank <ljfrank@gmail.com>
|
|
||||||
Laurent Erignoux <lerignoux@gmail.com>
|
|
||||||
Laurent Goderre <laurent.goderre@docker.com>
|
|
||||||
Lee Gaines <eightlimbed@gmail.com>
|
|
||||||
Lei Jitang <leijitang@huawei.com>
|
|
||||||
Lennie <github@consolejunkie.net>
|
|
||||||
lentil32 <lentil32@icloud.com>
|
|
||||||
Leo Gallucci <elgalu3@gmail.com>
|
|
||||||
Leonid Skorospelov <leosko94@gmail.com>
|
|
||||||
Lewis Daly <lewisdaly@me.com>
|
|
||||||
Li Fu Bang <lifubang@acmcoder.com>
|
|
||||||
Li Yi <denverdino@gmail.com>
|
|
||||||
Li Zeghong <zeghong@hotmail.com>
|
|
||||||
Liang-Chi Hsieh <viirya@gmail.com>
|
|
||||||
Lihua Tang <lhtang@alauda.io>
|
|
||||||
Lily Guo <lily.guo@docker.com>
|
|
||||||
Lin Lu <doraalin@163.com>
|
|
||||||
Linus Heckemann <lheckemann@twig-world.com>
|
|
||||||
Liping Xue <lipingxue@gmail.com>
|
|
||||||
Liron Levin <liron@twistlock.com>
|
|
||||||
liwenqi <vikilwq@zju.edu.cn>
|
|
||||||
lixiaobing10051267 <li.xiaobing1@zte.com.cn>
|
|
||||||
Lloyd Dewolf <foolswisdom@gmail.com>
|
|
||||||
Lorenzo Fontana <lo@linux.com>
|
|
||||||
Louis Opter <kalessin@kalessin.fr>
|
|
||||||
Lovekesh Kumar <lovekesh.kumar@rtcamp.com>
|
|
||||||
Luca Favatella <luca.favatella@erlang-solutions.com>
|
|
||||||
Luca Marturana <lucamarturana@gmail.com>
|
|
||||||
Lucas Chan <lucas-github@lucaschan.com>
|
|
||||||
Luis Henrique Mulinari <luis.mulinari@gmail.com>
|
|
||||||
Luka Hartwig <mail@lukahartwig.de>
|
|
||||||
Lukas Heeren <lukas-heeren@hotmail.com>
|
|
||||||
Lukasz Zajaczkowski <Lukasz.Zajaczkowski@ts.fujitsu.com>
|
|
||||||
Lydell Manganti <LydellManganti@users.noreply.github.com>
|
|
||||||
Lénaïc Huard <lhuard@amadeus.com>
|
|
||||||
Ma Shimiao <mashimiao.fnst@cn.fujitsu.com>
|
|
||||||
Mabin <bin.ma@huawei.com>
|
|
||||||
Maciej Kalisz <maciej.d.kalisz@gmail.com>
|
|
||||||
Madhav Puri <madhav.puri@gmail.com>
|
|
||||||
Madhu Venugopal <madhu@socketplane.io>
|
|
||||||
Madhur Batra <madhurbatra097@gmail.com>
|
|
||||||
Malte Janduda <mail@janduda.net>
|
|
||||||
Manjunath A Kumatagi <mkumatag@in.ibm.com>
|
|
||||||
Mansi Nahar <mmn4185@rit.edu>
|
|
||||||
mapk0y <mapk0y@gmail.com>
|
|
||||||
Marc Bihlmaier <marc.bihlmaier@reddoxx.com>
|
|
||||||
Marc Cornellà <hello@mcornella.com>
|
|
||||||
Marco Mariani <marco.mariani@alterway.fr>
|
|
||||||
Marco Spiess <marco.spiess@hotmail.de>
|
|
||||||
Marco Vedovati <mvedovati@suse.com>
|
|
||||||
Marcus Martins <marcus@docker.com>
|
|
||||||
Marianna Tessel <mtesselh@gmail.com>
|
|
||||||
Marius Ileana <marius.ileana@gmail.com>
|
|
||||||
Marius Meschter <marius@meschter.me>
|
|
||||||
Marius Sturm <marius@graylog.com>
|
|
||||||
Mark Oates <fl0yd@me.com>
|
|
||||||
Marsh Macy <marsma@microsoft.com>
|
|
||||||
Martin Mosegaard Amdisen <martin.amdisen@praqma.com>
|
|
||||||
Mary Anthony <mary.anthony@docker.com>
|
|
||||||
Mason Fish <mason.fish@docker.com>
|
|
||||||
Mason Malone <mason.malone@gmail.com>
|
|
||||||
Mateusz Major <apkd@users.noreply.github.com>
|
|
||||||
Mathias Duedahl <64321057+Lussebullen@users.noreply.github.com>
|
|
||||||
Mathieu Champlon <mathieu.champlon@docker.com>
|
|
||||||
Mathieu Rollet <matletix@gmail.com>
|
|
||||||
Matt Gucci <matt9ucci@gmail.com>
|
|
||||||
Matt Robenolt <matt@ydekproductions.com>
|
|
||||||
Matteo Orefice <matteo.orefice@bites4bits.software>
|
|
||||||
Matthew Heon <mheon@redhat.com>
|
|
||||||
Matthieu Hauglustaine <matt.hauglustaine@gmail.com>
|
|
||||||
Matthieu MOREL <matthieu.morel35@gmail.com>
|
|
||||||
Mauro Porras P <mauroporrasp@gmail.com>
|
|
||||||
Max Shytikov <mshytikov@gmail.com>
|
|
||||||
Max-Julian Pogner <max-julian@pogner.at>
|
|
||||||
Maxime Petazzoni <max@signalfuse.com>
|
|
||||||
Maximillian Fan Xavier <maximillianfx@gmail.com>
|
|
||||||
Mei ChunTao <mei.chuntao@zte.com.cn>
|
|
||||||
Melroy van den Berg <melroy@melroy.org>
|
|
||||||
Mert Şişmanoğlu <mert190737fb@gmail.com>
|
|
||||||
Metal <2466052+tedhexaflow@users.noreply.github.com>
|
|
||||||
Micah Zoltu <micah@newrelic.com>
|
|
||||||
Michael A. Smith <michael@smith-li.com>
|
|
||||||
Michael Bridgen <mikeb@squaremobius.net>
|
|
||||||
Michael Crosby <crosbymichael@gmail.com>
|
|
||||||
Michael Friis <friism@gmail.com>
|
|
||||||
Michael Irwin <mikesir87@gmail.com>
|
|
||||||
Michael Käufl <docker@c.michael-kaeufl.de>
|
|
||||||
Michael Prokop <github@michael-prokop.at>
|
|
||||||
Michael Scharf <github@scharf.gr>
|
|
||||||
Michael Spetsiotis <michael_spets@hotmail.com>
|
|
||||||
Michael Steinert <mike.steinert@gmail.com>
|
|
||||||
Michael Tews <michael@tews.dev>
|
|
||||||
Michael West <mwest@mdsol.com>
|
|
||||||
Michal Minář <miminar@redhat.com>
|
|
||||||
Michał Czeraszkiewicz <czerasz@gmail.com>
|
|
||||||
Miguel Angel Alvarez Cabrerizo <doncicuto@gmail.com>
|
|
||||||
Mihai Borobocea <MihaiBorob@gmail.com>
|
|
||||||
Mihuleacc Sergiu <mihuleac.sergiu@gmail.com>
|
|
||||||
Mike Brown <brownwm@us.ibm.com>
|
|
||||||
Mike Casas <mkcsas0@gmail.com>
|
|
||||||
Mike Dalton <mikedalton@github.com>
|
|
||||||
Mike Danese <mikedanese@google.com>
|
|
||||||
Mike Dillon <mike@embody.org>
|
|
||||||
Mike Goelzer <mike.goelzer@docker.com>
|
|
||||||
Mike MacCana <mike.maccana@gmail.com>
|
|
||||||
mikelinjie <294893458@qq.com>
|
|
||||||
Mikhail Vasin <vasin@cloud-tv.ru>
|
|
||||||
Milind Chawre <milindchawre@gmail.com>
|
|
||||||
Mindaugas Rukas <momomg@gmail.com>
|
|
||||||
Miroslav Gula <miroslav.gula@naytrolabs.com>
|
|
||||||
Misty Stanley-Jones <misty@docker.com>
|
|
||||||
Mohammad Banikazemi <mb@us.ibm.com>
|
|
||||||
Mohammad Hossein <mhm98035@gmail.com>
|
|
||||||
Mohammed Aaqib Ansari <maaquib@gmail.com>
|
|
||||||
Mohammed Aminu Futa <mohammedfuta2000@gmail.com>
|
|
||||||
Mohini Anne Dsouza <mohini3917@gmail.com>
|
|
||||||
Moorthy RS <rsmoorthy@gmail.com>
|
|
||||||
Morgan Bauer <mbauer@us.ibm.com>
|
|
||||||
Morten Hekkvang <morten.hekkvang@sbab.se>
|
|
||||||
Morten Linderud <morten@linderud.pw>
|
|
||||||
Moysés Borges <moysesb@gmail.com>
|
|
||||||
Mozi <29089388+pzhlkj6612@users.noreply.github.com>
|
|
||||||
Mrunal Patel <mrunalp@gmail.com>
|
|
||||||
muicoder <muicoder@gmail.com>
|
|
||||||
Murukesh Mohanan <murukesh.mohanan@gmail.com>
|
|
||||||
Muthukumar R <muthur@gmail.com>
|
|
||||||
Máximo Cuadros <mcuadros@gmail.com>
|
|
||||||
Mårten Cassel <marten.cassel@gmail.com>
|
|
||||||
Nace Oroz <orkica@gmail.com>
|
|
||||||
Nahum Shalman <nshalman@omniti.com>
|
|
||||||
Nalin Dahyabhai <nalin@redhat.com>
|
|
||||||
Nao YONASHIRO <owan.orisano@gmail.com>
|
|
||||||
Nassim 'Nass' Eddequiouaq <eddequiouaq.nassim@gmail.com>
|
|
||||||
Natalie Parker <nparker@omnifone.com>
|
|
||||||
Nate Brennand <nate.brennand@clever.com>
|
|
||||||
Nathan Hsieh <hsieh.nathan@gmail.com>
|
|
||||||
Nathan LeClaire <nathan.leclaire@docker.com>
|
|
||||||
Nathan McCauley <nathan.mccauley@docker.com>
|
|
||||||
Neil Peterson <neilpeterson@outlook.com>
|
|
||||||
Nick Adcock <nick.adcock@docker.com>
|
|
||||||
Nick Santos <nick.santos@docker.com>
|
|
||||||
Nick Sieger <nick@nicksieger.com>
|
|
||||||
Nico Stapelbroek <nstapelbroek@gmail.com>
|
|
||||||
Nicola Kabar <nicolaka@gmail.com>
|
|
||||||
Nicolas Borboën <ponsfrilus@gmail.com>
|
|
||||||
Nicolas De Loof <nicolas.deloof@gmail.com>
|
|
||||||
Nikhil Chawla <chawlanikhil24@gmail.com>
|
|
||||||
Nikolas Garofil <nikolas.garofil@uantwerpen.be>
|
|
||||||
Nikolay Milovanov <nmil@itransformers.net>
|
|
||||||
NinaLua <iturf@sina.cn>
|
|
||||||
Nir Soffer <nsoffer@redhat.com>
|
|
||||||
Nishant Totla <nishanttotla@gmail.com>
|
|
||||||
NIWA Hideyuki <niwa.niwa@nifty.ne.jp>
|
|
||||||
Noah Silas <noah@hustle.com>
|
|
||||||
Noah Treuhaft <noah.treuhaft@docker.com>
|
|
||||||
O.S. Tezer <ostezer@gmail.com>
|
|
||||||
Oded Arbel <oded@geek.co.il>
|
|
||||||
Odin Ugedal <odin@ugedal.com>
|
|
||||||
ohmystack <jun.jiang02@ele.me>
|
|
||||||
OKA Naoya <git@okanaoya.com>
|
|
||||||
Oliver Pomeroy <oppomeroy@gmail.com>
|
|
||||||
Olle Jonsson <olle.jonsson@gmail.com>
|
|
||||||
Olli Janatuinen <olli.janatuinen@gmail.com>
|
|
||||||
Oscar Wieman <oscrx@icloud.com>
|
|
||||||
Otto Kekäläinen <otto@seravo.fi>
|
|
||||||
Ovidio Mallo <ovidio.mallo@gmail.com>
|
|
||||||
Pascal Borreli <pascal@borreli.com>
|
|
||||||
Patrick Böänziger <patrick.baenziger@bsi-software.com>
|
|
||||||
Patrick Daigle <114765035+pdaig@users.noreply.github.com>
|
|
||||||
Patrick Hemmer <patrick.hemmer@gmail.com>
|
|
||||||
Patrick Lang <plang@microsoft.com>
|
|
||||||
Patrick St. laurent <patrick@saint-laurent.us>
|
|
||||||
Paul <paul9869@gmail.com>
|
|
||||||
Paul Kehrer <paul.l.kehrer@gmail.com>
|
|
||||||
Paul Lietar <paul@lietar.net>
|
|
||||||
Paul Mulders <justinkb@gmail.com>
|
|
||||||
Paul Rogalski <mail@paul-rogalski.de>
|
|
||||||
Paul Seyfert <pseyfert.mathphys@gmail.com>
|
|
||||||
Paul Weaver <pauweave@cisco.com>
|
|
||||||
Pavel Pospisil <pospispa@gmail.com>
|
|
||||||
Paweł Gronowski <pawel.gronowski@docker.com>
|
|
||||||
Paweł Pokrywka <pepawel@users.noreply.github.com>
|
|
||||||
Paweł Szczekutowicz <pszczekutowicz@gmail.com>
|
|
||||||
Peeyush Gupta <gpeeyush@linux.vnet.ibm.com>
|
|
||||||
Per Lundberg <perlun@gmail.com>
|
|
||||||
Peter Dave Hello <hsu@peterdavehello.org>
|
|
||||||
Peter Edge <peter.edge@gmail.com>
|
|
||||||
Peter Hsu <shhsu@microsoft.com>
|
|
||||||
Peter Jaffe <pjaffe@nevo.com>
|
|
||||||
Peter Kehl <peter.kehl@gmail.com>
|
|
||||||
Peter Nagy <xificurC@gmail.com>
|
|
||||||
Peter Salvatore <peter@psftw.com>
|
|
||||||
Peter Waller <p@pwaller.net>
|
|
||||||
Phil Estes <estesp@gmail.com>
|
|
||||||
Philip Alexander Etling <paetling@gmail.com>
|
|
||||||
Philipp Gillé <philipp.gille@gmail.com>
|
|
||||||
Philipp Schmied <pschmied@schutzwerk.com>
|
|
||||||
Phong Tran <tran.pho@northeastern.edu>
|
|
||||||
Pieter E Smit <diepes@github.com>
|
|
||||||
pixelistik <pixelistik@users.noreply.github.com>
|
|
||||||
Pratik Karki <prertik@outlook.com>
|
|
||||||
Prayag Verma <prayag.verma@gmail.com>
|
|
||||||
Preston Cowley <preston.cowley@sony.com>
|
|
||||||
Pure White <daniel48@126.com>
|
|
||||||
Qiang Huang <h.huangqiang@huawei.com>
|
|
||||||
Qinglan Peng <qinglanpeng@zju.edu.cn>
|
|
||||||
QQ喵 <gqqnb2005@gmail.com>
|
|
||||||
qudongfang <qudongfang@gmail.com>
|
|
||||||
Raghavendra K T <raghavendra.kt@linux.vnet.ibm.com>
|
|
||||||
Rahul Kadyan <hi@znck.me>
|
|
||||||
Rahul Zoldyck <rahulzoldyck@gmail.com>
|
|
||||||
Ravi Shekhar Jethani <rsjethani@gmail.com>
|
|
||||||
Ray Tsang <rayt@google.com>
|
|
||||||
Reficul <xuzhenglun@gmail.com>
|
|
||||||
Remy Suen <remy.suen@gmail.com>
|
|
||||||
Renaud Gaubert <rgaubert@nvidia.com>
|
|
||||||
Ricardo N Feliciano <FelicianoTech@gmail.com>
|
|
||||||
Rich Moyse <rich@moyse.us>
|
|
||||||
Richard Chen Zheng <58443436+rchenzheng@users.noreply.github.com>
|
|
||||||
Richard Mathie <richard.mathie@amey.co.uk>
|
|
||||||
Richard Scothern <richard.scothern@gmail.com>
|
|
||||||
Rick Wieman <git@rickw.nl>
|
|
||||||
Ritesh H Shukla <sritesh@vmware.com>
|
|
||||||
Riyaz Faizullabhoy <riyaz.faizullabhoy@docker.com>
|
|
||||||
Rob Gulewich <rgulewich@netflix.com>
|
|
||||||
Rob Murray <rob.murray@docker.com>
|
|
||||||
Robert Wallis <smilingrob@gmail.com>
|
|
||||||
Robin Naundorf <r.naundorf@fh-muenster.de>
|
|
||||||
Robin Speekenbrink <robin@kingsquare.nl>
|
|
||||||
Roch Feuillade <roch.feuillade@pandobac.com>
|
|
||||||
Rodolfo Ortiz <rodolfo.ortiz@definityfirst.com>
|
|
||||||
Rogelio Canedo <rcanedo@mappy.priv>
|
|
||||||
Rohan Verma <hello@rohanverma.net>
|
|
||||||
Roland Kammerer <roland.kammerer@linbit.com>
|
|
||||||
Roman Dudin <katrmr@gmail.com>
|
|
||||||
Rory Hunter <roryhunter2@gmail.com>
|
|
||||||
Ross Boucher <rboucher@gmail.com>
|
|
||||||
Rubens Figueiredo <r.figueiredo.52@gmail.com>
|
|
||||||
Rui Cao <ruicao@alauda.io>
|
|
||||||
Rui JingAn <quiterace@gmail.com>
|
|
||||||
Ryan Belgrave <rmb1993@gmail.com>
|
|
||||||
Ryan Detzel <ryan.detzel@gmail.com>
|
|
||||||
Ryan Stelly <ryan.stelly@live.com>
|
|
||||||
Ryan Wilson-Perkin <ryanwilsonperkin@gmail.com>
|
|
||||||
Ryan Zhang <ryan.zhang@docker.com>
|
|
||||||
Sainath Grandhi <sainath.grandhi@intel.com>
|
|
||||||
Sakeven Jiang <jc5930@sina.cn>
|
|
||||||
Sally O'Malley <somalley@redhat.com>
|
|
||||||
Sam Neirinck <sam@samneirinck.com>
|
|
||||||
Sam Thibault <sam.thibault@docker.com>
|
|
||||||
Samarth Shah <samashah@microsoft.com>
|
|
||||||
Sambuddha Basu <sambuddhabasu1@gmail.com>
|
|
||||||
Sami Tabet <salph.tabet@gmail.com>
|
|
||||||
Samuel Cochran <sj26@sj26.com>
|
|
||||||
Samuel Karp <skarp@amazon.com>
|
|
||||||
Sandro Jäckel <sandro.jaeckel@gmail.com>
|
|
||||||
Santhosh Manohar <santhosh@docker.com>
|
|
||||||
Sarah Sanders <sarah.sanders@docker.com>
|
|
||||||
Sargun Dhillon <sargun@netflix.com>
|
|
||||||
Saswat Bhattacharya <sas.saswat@gmail.com>
|
|
||||||
Saurabh Kumar <saurabhkumar0184@gmail.com>
|
|
||||||
Scott Brenner <scott@scottbrenner.me>
|
|
||||||
Scott Collier <emailscottcollier@gmail.com>
|
|
||||||
Sean Christopherson <sean.j.christopherson@intel.com>
|
|
||||||
Sean Rodman <srodman7689@gmail.com>
|
|
||||||
Sebastiaan van Stijn <github@gone.nl>
|
|
||||||
Sergey Tryuber <Sergeant007@users.noreply.github.com>
|
|
||||||
Serhat Gülçiçek <serhat25@gmail.com>
|
|
||||||
Sevki Hasirci <s@sevki.org>
|
|
||||||
Shaun Kaasten <shaunk@gmail.com>
|
|
||||||
Sheng Yang <sheng@yasker.org>
|
|
||||||
Shijiang Wei <mountkin@gmail.com>
|
|
||||||
Shishir Mahajan <shishir.mahajan@redhat.com>
|
|
||||||
Shoubhik Bose <sbose78@gmail.com>
|
|
||||||
Shukui Yang <yangshukui@huawei.com>
|
|
||||||
Sian Lerk Lau <kiawin@gmail.com>
|
|
||||||
Sidhartha Mani <sidharthamn@gmail.com>
|
|
||||||
sidharthamani <sid@rancher.com>
|
|
||||||
Silvin Lubecki <silvin.lubecki@docker.com>
|
|
||||||
Simei He <hesimei@zju.edu.cn>
|
|
||||||
Simon Ferquel <simon.ferquel@docker.com>
|
|
||||||
Simon Heimberg <simon.heimberg@heimberg-ea.ch>
|
|
||||||
Sindhu S <sindhus@live.in>
|
|
||||||
Slava Semushin <semushin@redhat.com>
|
|
||||||
Solomon Hykes <solomon@docker.com>
|
|
||||||
Song Gao <song@gao.io>
|
|
||||||
Spencer Brown <spencer@spencerbrown.org>
|
|
||||||
Spring Lee <xi.shuai@outlook.com>
|
|
||||||
squeegels <lmscrewy@gmail.com>
|
|
||||||
Srini Brahmaroutu <srbrahma@us.ibm.com>
|
|
||||||
Stavros Panakakis <stavrospanakakis@gmail.com>
|
|
||||||
Stefan S. <tronicum@user.github.com>
|
|
||||||
Stefan Scherer <stefan.scherer@docker.com>
|
|
||||||
Stefan Weil <sw@weilnetz.de>
|
|
||||||
Stephane Jeandeaux <stephane.jeandeaux@gmail.com>
|
|
||||||
Stephen Day <stevvooe@gmail.com>
|
|
||||||
Stephen Rust <srust@blockbridge.com>
|
|
||||||
Steve Durrheimer <s.durrheimer@gmail.com>
|
|
||||||
Steve Richards <steve.richards@docker.com>
|
|
||||||
Steven Burgess <steven.a.burgess@hotmail.com>
|
|
||||||
Stoica-Marcu Floris-Andrei <floris.sm@gmail.com>
|
|
||||||
Stuart Williams <pid@pidster.com>
|
|
||||||
Subhajit Ghosh <isubuz.g@gmail.com>
|
|
||||||
Sun Jianbo <wonderflow.sun@gmail.com>
|
|
||||||
Sune Keller <absukl@almbrand.dk>
|
|
||||||
Sungwon Han <sungwon.han@navercorp.com>
|
|
||||||
Sunny Gogoi <indiasuny000@gmail.com>
|
|
||||||
Sven Dowideit <SvenDowideit@home.org.au>
|
|
||||||
Sylvain Baubeau <sbaubeau@redhat.com>
|
|
||||||
Sébastien HOUZÉ <cto@verylastroom.com>
|
|
||||||
T K Sourabh <sourabhtk37@gmail.com>
|
|
||||||
TAGOMORI Satoshi <tagomoris@gmail.com>
|
|
||||||
taiji-tech <csuhqg@foxmail.com>
|
|
||||||
Takeshi Koenuma <t.koenuma2@gmail.com>
|
|
||||||
Takuya Noguchi <takninnovationresearch@gmail.com>
|
|
||||||
Taylor Jones <monitorjbl@gmail.com>
|
|
||||||
Teiva Harsanyi <t.harsanyi@thebeat.co>
|
|
||||||
Tejaswini Duggaraju <naduggar@microsoft.com>
|
|
||||||
Tengfei Wang <tfwang@alauda.io>
|
|
||||||
Teppei Fukuda <knqyf263@gmail.com>
|
|
||||||
Thatcher Peskens <thatcher@docker.com>
|
|
||||||
Thibault Coupin <thibault.coupin@gmail.com>
|
|
||||||
Thomas Gazagnaire <thomas@gazagnaire.org>
|
|
||||||
Thomas Krzero <thomas.kovatchitch@gmail.com>
|
|
||||||
Thomas Leonard <thomas.leonard@docker.com>
|
|
||||||
Thomas Léveil <thomasleveil@gmail.com>
|
|
||||||
Thomas Riccardi <thomas@deepomatic.com>
|
|
||||||
Thomas Swift <tgs242@gmail.com>
|
|
||||||
Tianon Gravi <admwiggin@gmail.com>
|
|
||||||
Tianyi Wang <capkurmagati@gmail.com>
|
|
||||||
Tibor Vass <teabee89@gmail.com>
|
|
||||||
Tim Dettrick <t.dettrick@uq.edu.au>
|
|
||||||
Tim Hockin <thockin@google.com>
|
|
||||||
Tim Sampson <tim@sampson.fi>
|
|
||||||
Tim Smith <timbot@google.com>
|
|
||||||
Tim Waugh <twaugh@redhat.com>
|
|
||||||
Tim Welsh <timothy.welsh@docker.com>
|
|
||||||
Tim Wraight <tim.wraight@tangentlabs.co.uk>
|
|
||||||
timfeirg <kkcocogogo@gmail.com>
|
|
||||||
Timothy Hobbs <timothyhobbs@seznam.cz>
|
|
||||||
Tobias Bradtke <webwurst@gmail.com>
|
|
||||||
Tobias Gesellchen <tobias@gesellix.de>
|
|
||||||
Todd Whiteman <todd.whiteman@joyent.com>
|
|
||||||
Tom Denham <tom@tomdee.co.uk>
|
|
||||||
Tom Fotherby <tom+github@peopleperhour.com>
|
|
||||||
Tom Klingenberg <tklingenberg@lastflood.net>
|
|
||||||
Tom Milligan <code@tommilligan.net>
|
|
||||||
Tom X. Tobin <tomxtobin@tomxtobin.com>
|
|
||||||
Tomas Bäckman <larstomas@gmail.com>
|
|
||||||
Tomas Tomecek <ttomecek@redhat.com>
|
|
||||||
Tomasz Kopczynski <tomek@kopczynski.net.pl>
|
|
||||||
Tomáš Hrčka <thrcka@redhat.com>
|
|
||||||
Tony Abboud <tdabboud@hotmail.com>
|
|
||||||
Tõnis Tiigi <tonistiigi@gmail.com>
|
|
||||||
Trapier Marshall <trapier.marshall@docker.com>
|
|
||||||
Travis Cline <travis.cline@gmail.com>
|
|
||||||
Tristan Carel <tristan@cogniteev.com>
|
|
||||||
Tycho Andersen <tycho@docker.com>
|
|
||||||
Tycho Andersen <tycho@tycho.ws>
|
|
||||||
uhayate <uhayate.gong@daocloud.io>
|
|
||||||
Ulrich Bareth <ulrich.bareth@gmail.com>
|
|
||||||
Ulysses Souza <ulysses.souza@docker.com>
|
|
||||||
Umesh Yadav <umesh4257@gmail.com>
|
|
||||||
Vaclav Struhar <struharv@gmail.com>
|
|
||||||
Valentin Lorentz <progval+git@progval.net>
|
|
||||||
Vardan Pogosian <vardan.pogosyan@gmail.com>
|
|
||||||
Venkateswara Reddy Bukkasamudram <bukkasamudram@outlook.com>
|
|
||||||
Veres Lajos <vlajos@gmail.com>
|
|
||||||
Victor Vieux <victor.vieux@docker.com>
|
|
||||||
Victoria Bialas <victoria.bialas@docker.com>
|
|
||||||
Viktor Stanchev <me@viktorstanchev.com>
|
|
||||||
Ville Skyttä <ville.skytta@iki.fi>
|
|
||||||
Vimal Raghubir <vraghubir0418@gmail.com>
|
|
||||||
Vincent Batts <vbatts@redhat.com>
|
|
||||||
Vincent Bernat <Vincent.Bernat@exoscale.ch>
|
|
||||||
Vincent Demeester <vincent.demeester@docker.com>
|
|
||||||
Vincent Woo <me@vincentwoo.com>
|
|
||||||
Vishnu Kannan <vishnuk@google.com>
|
|
||||||
Vivek Goyal <vgoyal@redhat.com>
|
|
||||||
Wang Jie <wangjie5@chinaskycloud.com>
|
|
||||||
Wang Lei <wanglei@tenxcloud.com>
|
|
||||||
Wang Long <long.wanglong@huawei.com>
|
|
||||||
Wang Ping <present.wp@icloud.com>
|
|
||||||
Wang Xing <hzwangxing@corp.netease.com>
|
|
||||||
Wang Yuexiao <wang.yuexiao@zte.com.cn>
|
|
||||||
Wang Yumu <37442693@qq.com>
|
|
||||||
Wataru Ishida <ishida.wataru@lab.ntt.co.jp>
|
|
||||||
Wayne Song <wsong@docker.com>
|
|
||||||
Wen Cheng Ma <wenchma@cn.ibm.com>
|
|
||||||
Wenlong Zhang <zhangwenlong@loongson.cn>
|
|
||||||
Wenzhi Liang <wenzhi.liang@gmail.com>
|
|
||||||
Wes Morgan <cap10morgan@gmail.com>
|
|
||||||
Wewang Xiaorenfine <wang.xiaoren@zte.com.cn>
|
|
||||||
Will Wang <willww64@gmail.com>
|
|
||||||
William Henry <whenry@redhat.com>
|
|
||||||
Xianglin Gao <xlgao@zju.edu.cn>
|
|
||||||
Xiaodong Liu <liuxiaodong@loongson.cn>
|
|
||||||
Xiaodong Zhang <a4012017@sina.com>
|
|
||||||
Xiaoxi He <xxhe@alauda.io>
|
|
||||||
Xinbo Weng <xihuanbo_0521@zju.edu.cn>
|
|
||||||
Xuecong Liao <satorulogic@gmail.com>
|
|
||||||
Yan Feng <yanfeng2@huawei.com>
|
|
||||||
Yanqiang Miao <miao.yanqiang@zte.com.cn>
|
|
||||||
Yassine Tijani <yasstij11@gmail.com>
|
|
||||||
Yi EungJun <eungjun.yi@navercorp.com>
|
|
||||||
Ying Li <ying.li@docker.com>
|
|
||||||
Yong Tang <yong.tang.github@outlook.com>
|
|
||||||
Yosef Fertel <yfertel@gmail.com>
|
|
||||||
Yu Peng <yu.peng36@zte.com.cn>
|
|
||||||
Yuan Sun <sunyuan3@huawei.com>
|
|
||||||
Yucheng Wu <wyc123wyc@gmail.com>
|
|
||||||
Yue Zhang <zy675793960@yeah.net>
|
|
||||||
Yunxiang Huang <hyxqshk@vip.qq.com>
|
|
||||||
Zachary Romero <zacromero3@gmail.com>
|
|
||||||
Zander Mackie <zmackie@gmail.com>
|
|
||||||
zebrilee <zebrilee@gmail.com>
|
|
||||||
Zeel B Patel <patel_zeel@iitgn.ac.in>
|
|
||||||
Zhang Kun <zkazure@gmail.com>
|
|
||||||
Zhang Wei <zhangwei555@huawei.com>
|
|
||||||
Zhang Wentao <zhangwentao234@huawei.com>
|
|
||||||
ZhangHang <stevezhang2014@gmail.com>
|
|
||||||
zhenghenghuo <zhenghenghuo@zju.edu.cn>
|
|
||||||
Zhiwei Liang <zliang@akamai.com>
|
|
||||||
Zhou Hao <zhouhao@cn.fujitsu.com>
|
|
||||||
Zhoulin Xie <zhoulin.xie@daocloud.io>
|
|
||||||
Zhu Guihua <zhugh.fnst@cn.fujitsu.com>
|
|
||||||
Zhuo Zhi <h.dwwwwww@gmail.com>
|
|
||||||
Álex González <agonzalezro@gmail.com>
|
|
||||||
Álvaro Lázaro <alvaro.lazaro.g@gmail.com>
|
|
||||||
Átila Camurça Alves <camurca.home@gmail.com>
|
|
||||||
Александр Менщиков <__Singleton__@hackerdom.ru>
|
|
||||||
徐俊杰 <paco.xu@daocloud.io>
|
|
||||||
林博仁 Buo-ren Lin <Buo.Ren.Lin@gmail.com>
|
|
||||||
-191
@@ -1,191 +0,0 @@
|
|||||||
|
|
||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
https://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
Copyright 2013-2017 Docker, Inc.
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
https://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.
|
|
||||||
-19
@@ -1,19 +0,0 @@
|
|||||||
Docker
|
|
||||||
Copyright 2012-2017 Docker, Inc.
|
|
||||||
|
|
||||||
This product includes software developed at Docker, Inc. (https://www.docker.com).
|
|
||||||
|
|
||||||
This product contains software (https://github.com/creack/pty) developed
|
|
||||||
by Keith Rarick, licensed under the MIT License.
|
|
||||||
|
|
||||||
The following is courtesy of our legal counsel:
|
|
||||||
|
|
||||||
|
|
||||||
Use and transfer of Docker may be subject to certain restrictions by the
|
|
||||||
United States and other governments.
|
|
||||||
It is your responsibility to ensure that your use and/or transfer does not
|
|
||||||
violate applicable laws.
|
|
||||||
|
|
||||||
For more information, see https://www.bis.doc.gov
|
|
||||||
|
|
||||||
See also https://www.apache.org/dev/crypto.html and/or seek legal counsel.
|
|
||||||
-176
@@ -1,176 +0,0 @@
|
|||||||
package config
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"os/user"
|
|
||||||
"path/filepath"
|
|
||||||
"runtime"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"github.com/docker/cli/cli/config/configfile"
|
|
||||||
"github.com/docker/cli/cli/config/credentials"
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// EnvOverrideConfigDir is the name of the environment variable that can be
|
|
||||||
// used to override the location of the client configuration files (~/.docker).
|
|
||||||
//
|
|
||||||
// It takes priority over the default, but can be overridden by the "--config"
|
|
||||||
// command line option.
|
|
||||||
EnvOverrideConfigDir = "DOCKER_CONFIG"
|
|
||||||
|
|
||||||
// ConfigFileName is the name of the client configuration file inside the
|
|
||||||
// config-directory.
|
|
||||||
ConfigFileName = "config.json"
|
|
||||||
configFileDir = ".docker"
|
|
||||||
contextsDir = "contexts"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
initConfigDir = new(sync.Once)
|
|
||||||
configDir string
|
|
||||||
)
|
|
||||||
|
|
||||||
// resetConfigDir is used in testing to reset the "configDir" package variable
|
|
||||||
// and its sync.Once to force re-lookup between tests.
|
|
||||||
func resetConfigDir() {
|
|
||||||
configDir = ""
|
|
||||||
initConfigDir = new(sync.Once)
|
|
||||||
}
|
|
||||||
|
|
||||||
// getHomeDir returns the home directory of the current user with the help of
|
|
||||||
// environment variables depending on the target operating system.
|
|
||||||
// Returned path should be used with "path/filepath" to form new paths.
|
|
||||||
//
|
|
||||||
// On non-Windows platforms, it falls back to nss lookups, if the home
|
|
||||||
// directory cannot be obtained from environment-variables.
|
|
||||||
//
|
|
||||||
// If linking statically with cgo enabled against glibc, ensure the
|
|
||||||
// osusergo build tag is used.
|
|
||||||
//
|
|
||||||
// If needing to do nss lookups, do not disable cgo or set osusergo.
|
|
||||||
//
|
|
||||||
// getHomeDir is a copy of [pkg/homedir.Get] to prevent adding docker/docker
|
|
||||||
// as dependency for consumers that only need to read the config-file.
|
|
||||||
//
|
|
||||||
// [pkg/homedir.Get]: https://pkg.go.dev/github.com/docker/docker@v28.0.3+incompatible/pkg/homedir#Get
|
|
||||||
func getHomeDir() string {
|
|
||||||
home, _ := os.UserHomeDir()
|
|
||||||
if home == "" && runtime.GOOS != "windows" {
|
|
||||||
if u, err := user.Current(); err == nil {
|
|
||||||
return u.HomeDir
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return home
|
|
||||||
}
|
|
||||||
|
|
||||||
// Provider defines an interface for providing the CLI config.
|
|
||||||
type Provider interface {
|
|
||||||
ConfigFile() *configfile.ConfigFile
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dir returns the directory the configuration file is stored in
|
|
||||||
func Dir() string {
|
|
||||||
initConfigDir.Do(func() {
|
|
||||||
configDir = os.Getenv(EnvOverrideConfigDir)
|
|
||||||
if configDir == "" {
|
|
||||||
configDir = filepath.Join(getHomeDir(), configFileDir)
|
|
||||||
}
|
|
||||||
})
|
|
||||||
return configDir
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContextStoreDir returns the directory the docker contexts are stored in
|
|
||||||
func ContextStoreDir() string {
|
|
||||||
return filepath.Join(Dir(), contextsDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetDir sets the directory the configuration file is stored in
|
|
||||||
func SetDir(dir string) {
|
|
||||||
// trigger the sync.Once to synchronise with Dir()
|
|
||||||
initConfigDir.Do(func() {})
|
|
||||||
configDir = filepath.Clean(dir)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Path returns the path to a file relative to the config dir
|
|
||||||
func Path(p ...string) (string, error) {
|
|
||||||
path := filepath.Join(append([]string{Dir()}, p...)...)
|
|
||||||
if !strings.HasPrefix(path, Dir()+string(filepath.Separator)) {
|
|
||||||
return "", fmt.Errorf("path %q is outside of root config directory %q", path, Dir())
|
|
||||||
}
|
|
||||||
return path, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadFromReader is a convenience function that creates a ConfigFile object from
|
|
||||||
// a reader. It returns an error if configData is malformed.
|
|
||||||
func LoadFromReader(configData io.Reader) (*configfile.ConfigFile, error) {
|
|
||||||
configFile := configfile.ConfigFile{
|
|
||||||
AuthConfigs: make(map[string]types.AuthConfig),
|
|
||||||
}
|
|
||||||
err := configFile.LoadFromReader(configData)
|
|
||||||
return &configFile, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Load reads the configuration file ([ConfigFileName]) from the given directory.
|
|
||||||
// If no directory is given, it uses the default [Dir]. A [*configfile.ConfigFile]
|
|
||||||
// is returned containing the contents of the configuration file, or a default
|
|
||||||
// struct if no configfile exists in the given location.
|
|
||||||
//
|
|
||||||
// Load returns an error if a configuration file exists in the given location,
|
|
||||||
// but cannot be read, or is malformed. Consumers must handle errors to prevent
|
|
||||||
// overwriting an existing configuration file.
|
|
||||||
func Load(configDir string) (*configfile.ConfigFile, error) {
|
|
||||||
if configDir == "" {
|
|
||||||
configDir = Dir()
|
|
||||||
}
|
|
||||||
return load(configDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
func load(configDir string) (*configfile.ConfigFile, error) {
|
|
||||||
filename := filepath.Join(configDir, ConfigFileName)
|
|
||||||
configFile := configfile.New(filename)
|
|
||||||
|
|
||||||
file, err := os.Open(filename)
|
|
||||||
if err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
// It is OK for no configuration file to be present, in which
|
|
||||||
// case we return a default struct.
|
|
||||||
return configFile, nil
|
|
||||||
}
|
|
||||||
// Any other error happening when failing to read the file must be returned.
|
|
||||||
return configFile, fmt.Errorf("loading config file: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = file.Close() }()
|
|
||||||
err = configFile.LoadFromReader(file)
|
|
||||||
if err != nil {
|
|
||||||
err = fmt.Errorf("parsing config file (%s): %w", filename, err)
|
|
||||||
}
|
|
||||||
return configFile, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadDefaultConfigFile attempts to load the default config file and returns
|
|
||||||
// a reference to the ConfigFile struct. If none is found or when failing to load
|
|
||||||
// the configuration file, it initializes a default ConfigFile struct. If no
|
|
||||||
// credentials-store is set in the configuration file, it attempts to discover
|
|
||||||
// the default store to use for the current platform.
|
|
||||||
//
|
|
||||||
// Important: LoadDefaultConfigFile prints a warning to stderr when failing to
|
|
||||||
// load the configuration file, but otherwise ignores errors. Consumers should
|
|
||||||
// consider using [Load] (and [credentials.DetectDefaultStore]) to detect errors
|
|
||||||
// when updating the configuration file, to prevent discarding a (malformed)
|
|
||||||
// configuration file.
|
|
||||||
func LoadDefaultConfigFile(stderr io.Writer) *configfile.ConfigFile {
|
|
||||||
configFile, err := load(Dir())
|
|
||||||
if err != nil {
|
|
||||||
// FIXME(thaJeztah): we should not proceed here to prevent overwriting existing (but malformed) config files; see https://github.com/docker/cli/issues/5075
|
|
||||||
_, _ = fmt.Fprintln(stderr, "WARNING: Error", err)
|
|
||||||
}
|
|
||||||
if !configFile.ContainsAuth() {
|
|
||||||
configFile.CredentialsStore = credentials.DetectDefaultStore(configFile.CredentialsStore)
|
|
||||||
}
|
|
||||||
return configFile
|
|
||||||
}
|
|
||||||
-441
@@ -1,441 +0,0 @@
|
|||||||
package configfile
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/docker/cli/cli/config/credentials"
|
|
||||||
"github.com/docker/cli/cli/config/memorystore"
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
"github.com/sirupsen/logrus"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ConfigFile ~/.docker/config.json file info
|
|
||||||
type ConfigFile struct {
|
|
||||||
AuthConfigs map[string]types.AuthConfig `json:"auths"`
|
|
||||||
HTTPHeaders map[string]string `json:"HttpHeaders,omitempty"`
|
|
||||||
PsFormat string `json:"psFormat,omitempty"`
|
|
||||||
ImagesFormat string `json:"imagesFormat,omitempty"`
|
|
||||||
NetworksFormat string `json:"networksFormat,omitempty"`
|
|
||||||
PluginsFormat string `json:"pluginsFormat,omitempty"`
|
|
||||||
VolumesFormat string `json:"volumesFormat,omitempty"`
|
|
||||||
StatsFormat string `json:"statsFormat,omitempty"`
|
|
||||||
DetachKeys string `json:"detachKeys,omitempty"`
|
|
||||||
CredentialsStore string `json:"credsStore,omitempty"`
|
|
||||||
CredentialHelpers map[string]string `json:"credHelpers,omitempty"`
|
|
||||||
Filename string `json:"-"` // Note: for internal use only
|
|
||||||
ServiceInspectFormat string `json:"serviceInspectFormat,omitempty"`
|
|
||||||
ServicesFormat string `json:"servicesFormat,omitempty"`
|
|
||||||
TasksFormat string `json:"tasksFormat,omitempty"`
|
|
||||||
SecretFormat string `json:"secretFormat,omitempty"`
|
|
||||||
ConfigFormat string `json:"configFormat,omitempty"`
|
|
||||||
NodesFormat string `json:"nodesFormat,omitempty"`
|
|
||||||
PruneFilters []string `json:"pruneFilters,omitempty"`
|
|
||||||
Proxies map[string]ProxyConfig `json:"proxies,omitempty"`
|
|
||||||
CurrentContext string `json:"currentContext,omitempty"`
|
|
||||||
CLIPluginsExtraDirs []string `json:"cliPluginsExtraDirs,omitempty"`
|
|
||||||
Plugins map[string]map[string]string `json:"plugins,omitempty"`
|
|
||||||
Aliases map[string]string `json:"aliases,omitempty"`
|
|
||||||
Features map[string]string `json:"features,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type configEnvAuth struct {
|
|
||||||
Auth string `json:"auth"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type configEnv struct {
|
|
||||||
AuthConfigs map[string]configEnvAuth `json:"auths"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// DockerEnvConfigKey is an environment variable that contains a JSON encoded
|
|
||||||
// credential config. It only supports storing the credentials as a base64
|
|
||||||
// encoded string in the format base64("username:pat").
|
|
||||||
//
|
|
||||||
// Adding additional fields will produce a parsing error.
|
|
||||||
//
|
|
||||||
// Example:
|
|
||||||
//
|
|
||||||
// {
|
|
||||||
// "auths": {
|
|
||||||
// "example.test": {
|
|
||||||
// "auth": base64-encoded-username-pat
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
// }
|
|
||||||
const DockerEnvConfigKey = "DOCKER_AUTH_CONFIG"
|
|
||||||
|
|
||||||
// ProxyConfig contains proxy configuration settings
|
|
||||||
type ProxyConfig struct {
|
|
||||||
HTTPProxy string `json:"httpProxy,omitempty"`
|
|
||||||
HTTPSProxy string `json:"httpsProxy,omitempty"`
|
|
||||||
NoProxy string `json:"noProxy,omitempty"`
|
|
||||||
FTPProxy string `json:"ftpProxy,omitempty"`
|
|
||||||
AllProxy string `json:"allProxy,omitempty"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// New initializes an empty configuration file for the given filename 'fn'
|
|
||||||
func New(fn string) *ConfigFile {
|
|
||||||
return &ConfigFile{
|
|
||||||
AuthConfigs: make(map[string]types.AuthConfig),
|
|
||||||
HTTPHeaders: make(map[string]string),
|
|
||||||
Filename: fn,
|
|
||||||
Plugins: make(map[string]map[string]string),
|
|
||||||
Aliases: make(map[string]string),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// LoadFromReader reads the configuration data given and sets up the auth config
|
|
||||||
// information with given directory and populates the receiver object
|
|
||||||
func (configFile *ConfigFile) LoadFromReader(configData io.Reader) error {
|
|
||||||
if err := json.NewDecoder(configData).Decode(configFile); err != nil && !errors.Is(err, io.EOF) {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
var err error
|
|
||||||
for addr, ac := range configFile.AuthConfigs {
|
|
||||||
if ac.Auth != "" {
|
|
||||||
ac.Username, ac.Password, err = decodeAuth(ac.Auth)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ac.Auth = ""
|
|
||||||
ac.ServerAddress = addr
|
|
||||||
configFile.AuthConfigs[addr] = ac
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ContainsAuth returns whether there is authentication configured
|
|
||||||
// in this file or not.
|
|
||||||
func (configFile *ConfigFile) ContainsAuth() bool {
|
|
||||||
return configFile.CredentialsStore != "" ||
|
|
||||||
len(configFile.CredentialHelpers) > 0 ||
|
|
||||||
len(configFile.AuthConfigs) > 0
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAuthConfigs returns the mapping of repo to auth configuration
|
|
||||||
func (configFile *ConfigFile) GetAuthConfigs() map[string]types.AuthConfig {
|
|
||||||
if configFile.AuthConfigs == nil {
|
|
||||||
configFile.AuthConfigs = make(map[string]types.AuthConfig)
|
|
||||||
}
|
|
||||||
return configFile.AuthConfigs
|
|
||||||
}
|
|
||||||
|
|
||||||
// SaveToWriter encodes and writes out all the authorization information to
|
|
||||||
// the given writer
|
|
||||||
func (configFile *ConfigFile) SaveToWriter(writer io.Writer) error {
|
|
||||||
// Encode sensitive data into a new/temp struct
|
|
||||||
tmpAuthConfigs := make(map[string]types.AuthConfig, len(configFile.AuthConfigs))
|
|
||||||
for k, authConfig := range configFile.AuthConfigs {
|
|
||||||
authCopy := authConfig
|
|
||||||
// encode and save the authstring, while blanking out the original fields
|
|
||||||
authCopy.Auth = encodeAuth(&authCopy)
|
|
||||||
authCopy.Username = ""
|
|
||||||
authCopy.Password = ""
|
|
||||||
authCopy.ServerAddress = ""
|
|
||||||
tmpAuthConfigs[k] = authCopy
|
|
||||||
}
|
|
||||||
|
|
||||||
saveAuthConfigs := configFile.AuthConfigs
|
|
||||||
configFile.AuthConfigs = tmpAuthConfigs
|
|
||||||
defer func() { configFile.AuthConfigs = saveAuthConfigs }()
|
|
||||||
|
|
||||||
// User-Agent header is automatically set, and should not be stored in the configuration
|
|
||||||
for v := range configFile.HTTPHeaders {
|
|
||||||
if strings.EqualFold(v, "User-Agent") {
|
|
||||||
delete(configFile.HTTPHeaders, v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
data, err := json.MarshalIndent(configFile, "", "\t")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
_, err = writer.Write(data)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Save encodes and writes out all the authorization information
|
|
||||||
func (configFile *ConfigFile) Save() (retErr error) {
|
|
||||||
if configFile.Filename == "" {
|
|
||||||
return errors.New("can't save config with empty filename")
|
|
||||||
}
|
|
||||||
|
|
||||||
dir := filepath.Dir(configFile.Filename)
|
|
||||||
if err := os.MkdirAll(dir, 0o700); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
temp, err := os.CreateTemp(dir, filepath.Base(configFile.Filename))
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
defer func() {
|
|
||||||
// ignore error as the file may already be closed when we reach this.
|
|
||||||
_ = temp.Close()
|
|
||||||
if retErr != nil {
|
|
||||||
if err := os.Remove(temp.Name()); err != nil {
|
|
||||||
logrus.WithError(err).WithField("file", temp.Name()).Debug("Error cleaning up temp file")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
err = configFile.SaveToWriter(temp)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := temp.Close(); err != nil {
|
|
||||||
return fmt.Errorf("error closing temp file: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle situation where the configfile is a symlink, and allow for dangling symlinks
|
|
||||||
cfgFile := configFile.Filename
|
|
||||||
if f, err := filepath.EvalSymlinks(cfgFile); err == nil {
|
|
||||||
cfgFile = f
|
|
||||||
} else if os.IsNotExist(err) {
|
|
||||||
// extract the path from the error if the configfile does not exist or is a dangling symlink
|
|
||||||
var pathError *os.PathError
|
|
||||||
if errors.As(err, &pathError) {
|
|
||||||
cfgFile = pathError.Path
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Try copying the current config file (if any) ownership and permissions
|
|
||||||
copyFilePermissions(cfgFile, temp.Name())
|
|
||||||
return os.Rename(temp.Name(), cfgFile)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ParseProxyConfig computes proxy configuration by retrieving the config for the provided host and
|
|
||||||
// then checking this against any environment variables provided to the container
|
|
||||||
func (configFile *ConfigFile) ParseProxyConfig(host string, runOpts map[string]*string) map[string]*string {
|
|
||||||
var cfgKey string
|
|
||||||
|
|
||||||
if _, ok := configFile.Proxies[host]; !ok {
|
|
||||||
cfgKey = "default"
|
|
||||||
} else {
|
|
||||||
cfgKey = host
|
|
||||||
}
|
|
||||||
|
|
||||||
config := configFile.Proxies[cfgKey]
|
|
||||||
permitted := map[string]*string{
|
|
||||||
"HTTP_PROXY": &config.HTTPProxy,
|
|
||||||
"HTTPS_PROXY": &config.HTTPSProxy,
|
|
||||||
"NO_PROXY": &config.NoProxy,
|
|
||||||
"FTP_PROXY": &config.FTPProxy,
|
|
||||||
"ALL_PROXY": &config.AllProxy,
|
|
||||||
}
|
|
||||||
m := runOpts
|
|
||||||
if m == nil {
|
|
||||||
m = make(map[string]*string)
|
|
||||||
}
|
|
||||||
for k := range permitted {
|
|
||||||
if *permitted[k] == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if _, ok := m[k]; !ok {
|
|
||||||
m[k] = permitted[k]
|
|
||||||
}
|
|
||||||
if _, ok := m[strings.ToLower(k)]; !ok {
|
|
||||||
m[strings.ToLower(k)] = permitted[k]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return m
|
|
||||||
}
|
|
||||||
|
|
||||||
// encodeAuth creates a base64 encoded string to containing authorization information
|
|
||||||
func encodeAuth(authConfig *types.AuthConfig) string {
|
|
||||||
if authConfig.Username == "" && authConfig.Password == "" {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
authStr := authConfig.Username + ":" + authConfig.Password
|
|
||||||
msg := []byte(authStr)
|
|
||||||
encoded := make([]byte, base64.StdEncoding.EncodedLen(len(msg)))
|
|
||||||
base64.StdEncoding.Encode(encoded, msg)
|
|
||||||
return string(encoded)
|
|
||||||
}
|
|
||||||
|
|
||||||
// decodeAuth decodes a base64 encoded string and returns username and password
|
|
||||||
func decodeAuth(authStr string) (string, string, error) {
|
|
||||||
if authStr == "" {
|
|
||||||
return "", "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
decLen := base64.StdEncoding.DecodedLen(len(authStr))
|
|
||||||
decoded := make([]byte, decLen)
|
|
||||||
authByte := []byte(authStr)
|
|
||||||
n, err := base64.StdEncoding.Decode(decoded, authByte)
|
|
||||||
if err != nil {
|
|
||||||
return "", "", err
|
|
||||||
}
|
|
||||||
if n > decLen {
|
|
||||||
return "", "", errors.New("something went wrong decoding auth config")
|
|
||||||
}
|
|
||||||
userName, password, ok := strings.Cut(string(decoded), ":")
|
|
||||||
if !ok || userName == "" {
|
|
||||||
return "", "", errors.New("invalid auth configuration file")
|
|
||||||
}
|
|
||||||
return userName, strings.Trim(password, "\x00"), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetCredentialsStore returns a new credentials store from the settings in the
|
|
||||||
// configuration file
|
|
||||||
func (configFile *ConfigFile) GetCredentialsStore(registryHostname string) credentials.Store {
|
|
||||||
store := credentials.NewFileStore(configFile)
|
|
||||||
|
|
||||||
if helper := getConfiguredCredentialStore(configFile, registryHostname); helper != "" {
|
|
||||||
store = newNativeStore(configFile, helper)
|
|
||||||
}
|
|
||||||
|
|
||||||
envConfig := os.Getenv(DockerEnvConfigKey)
|
|
||||||
if envConfig == "" {
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
authConfig, err := parseEnvConfig(envConfig)
|
|
||||||
if err != nil {
|
|
||||||
_, _ = fmt.Fprintln(os.Stderr, "Failed to create credential store from DOCKER_AUTH_CONFIG: ", err)
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
// use DOCKER_AUTH_CONFIG if set
|
|
||||||
// it uses the native or file store as a fallback to fetch and store credentials
|
|
||||||
envStore, err := memorystore.New(
|
|
||||||
memorystore.WithAuthConfig(authConfig),
|
|
||||||
memorystore.WithFallbackStore(store),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
_, _ = fmt.Fprintln(os.Stderr, "Failed to create credential store from DOCKER_AUTH_CONFIG: ", err)
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
return envStore
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseEnvConfig(v string) (map[string]types.AuthConfig, error) {
|
|
||||||
envConfig := &configEnv{}
|
|
||||||
decoder := json.NewDecoder(strings.NewReader(v))
|
|
||||||
decoder.DisallowUnknownFields()
|
|
||||||
if err := decoder.Decode(envConfig); err != nil && !errors.Is(err, io.EOF) {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if decoder.More() {
|
|
||||||
return nil, errors.New("DOCKER_AUTH_CONFIG does not support more than one JSON object")
|
|
||||||
}
|
|
||||||
|
|
||||||
authConfigs := make(map[string]types.AuthConfig)
|
|
||||||
for addr, envAuth := range envConfig.AuthConfigs {
|
|
||||||
if envAuth.Auth == "" {
|
|
||||||
return nil, fmt.Errorf("DOCKER_AUTH_CONFIG environment variable is missing key `auth` for %s", addr)
|
|
||||||
}
|
|
||||||
username, password, err := decodeAuth(envAuth.Auth)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
authConfigs[addr] = types.AuthConfig{
|
|
||||||
Username: username,
|
|
||||||
Password: password,
|
|
||||||
ServerAddress: addr,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return authConfigs, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// var for unit testing.
|
|
||||||
var newNativeStore = func(configFile *ConfigFile, helperSuffix string) credentials.Store {
|
|
||||||
return credentials.NewNativeStore(configFile, helperSuffix)
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAuthConfig for a repository from the credential store
|
|
||||||
func (configFile *ConfigFile) GetAuthConfig(registryHostname string) (types.AuthConfig, error) {
|
|
||||||
return configFile.GetCredentialsStore(registryHostname).Get(registryHostname)
|
|
||||||
}
|
|
||||||
|
|
||||||
// getConfiguredCredentialStore returns the credential helper configured for the
|
|
||||||
// given registry, the default credsStore, or the empty string if neither are
|
|
||||||
// configured.
|
|
||||||
func getConfiguredCredentialStore(c *ConfigFile, registryHostname string) string {
|
|
||||||
if c.CredentialHelpers != nil && registryHostname != "" {
|
|
||||||
if helper, exists := c.CredentialHelpers[registryHostname]; exists {
|
|
||||||
return helper
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return c.CredentialsStore
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAllCredentials returns all of the credentials stored in all of the
|
|
||||||
// configured credential stores.
|
|
||||||
func (configFile *ConfigFile) GetAllCredentials() (map[string]types.AuthConfig, error) {
|
|
||||||
auths := make(map[string]types.AuthConfig)
|
|
||||||
addAll := func(from map[string]types.AuthConfig) {
|
|
||||||
for reg, ac := range from {
|
|
||||||
auths[reg] = ac
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
defaultStore := configFile.GetCredentialsStore("")
|
|
||||||
newAuths, err := defaultStore.GetAll()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
addAll(newAuths)
|
|
||||||
|
|
||||||
// Auth configs from a registry-specific helper should override those from the default store.
|
|
||||||
for registryHostname := range configFile.CredentialHelpers {
|
|
||||||
newAuth, err := configFile.GetAuthConfig(registryHostname)
|
|
||||||
if err != nil {
|
|
||||||
// TODO(thaJeztah): use context-logger, so that this output can be suppressed (in tests).
|
|
||||||
logrus.WithError(err).Warnf("Failed to get credentials for registry: %s", registryHostname)
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
auths[registryHostname] = newAuth
|
|
||||||
}
|
|
||||||
return auths, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetFilename returns the file name that this config file is based on.
|
|
||||||
func (configFile *ConfigFile) GetFilename() string {
|
|
||||||
return configFile.Filename
|
|
||||||
}
|
|
||||||
|
|
||||||
// PluginConfig retrieves the requested option for the given plugin.
|
|
||||||
func (configFile *ConfigFile) PluginConfig(pluginname, option string) (string, bool) {
|
|
||||||
if configFile.Plugins == nil {
|
|
||||||
return "", false
|
|
||||||
}
|
|
||||||
pluginConfig, ok := configFile.Plugins[pluginname]
|
|
||||||
if !ok {
|
|
||||||
return "", false
|
|
||||||
}
|
|
||||||
value, ok := pluginConfig[option]
|
|
||||||
return value, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetPluginConfig sets the option to the given value for the given
|
|
||||||
// plugin. Passing a value of "" will remove the option. If removing
|
|
||||||
// the final config item for a given plugin then also cleans up the
|
|
||||||
// overall plugin entry.
|
|
||||||
func (configFile *ConfigFile) SetPluginConfig(pluginname, option, value string) {
|
|
||||||
if configFile.Plugins == nil {
|
|
||||||
configFile.Plugins = make(map[string]map[string]string)
|
|
||||||
}
|
|
||||||
pluginConfig, ok := configFile.Plugins[pluginname]
|
|
||||||
if !ok {
|
|
||||||
pluginConfig = make(map[string]string)
|
|
||||||
configFile.Plugins[pluginname] = pluginConfig
|
|
||||||
}
|
|
||||||
if value != "" {
|
|
||||||
pluginConfig[option] = value
|
|
||||||
} else {
|
|
||||||
delete(pluginConfig, option)
|
|
||||||
}
|
|
||||||
if len(pluginConfig) == 0 {
|
|
||||||
delete(configFile.Plugins, pluginname)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-35
@@ -1,35 +0,0 @@
|
|||||||
//go:build !windows
|
|
||||||
|
|
||||||
package configfile
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os"
|
|
||||||
"syscall"
|
|
||||||
)
|
|
||||||
|
|
||||||
// copyFilePermissions copies file ownership and permissions from "src" to "dst",
|
|
||||||
// ignoring any error during the process.
|
|
||||||
func copyFilePermissions(src, dst string) {
|
|
||||||
var (
|
|
||||||
mode os.FileMode = 0o600
|
|
||||||
uid, gid int
|
|
||||||
)
|
|
||||||
|
|
||||||
fi, err := os.Stat(src)
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if fi.Mode().IsRegular() {
|
|
||||||
mode = fi.Mode()
|
|
||||||
}
|
|
||||||
if err := os.Chmod(dst, mode); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
uid = int(fi.Sys().(*syscall.Stat_t).Uid)
|
|
||||||
gid = int(fi.Sys().(*syscall.Stat_t).Gid)
|
|
||||||
|
|
||||||
if uid > 0 && gid > 0 {
|
|
||||||
_ = os.Chown(dst, uid, gid)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
package configfile
|
|
||||||
|
|
||||||
func copyFilePermissions(src, dst string) {
|
|
||||||
// TODO implement for Windows
|
|
||||||
}
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Store is the interface that any credentials store must implement.
|
|
||||||
type Store interface {
|
|
||||||
// Erase removes credentials from the store for a given server.
|
|
||||||
Erase(serverAddress string) error
|
|
||||||
// Get retrieves credentials from the store for a given server.
|
|
||||||
Get(serverAddress string) (types.AuthConfig, error)
|
|
||||||
// GetAll retrieves all the credentials from the store.
|
|
||||||
GetAll() (map[string]types.AuthConfig, error)
|
|
||||||
// Store saves credentials in the store.
|
|
||||||
Store(authConfig types.AuthConfig) error
|
|
||||||
}
|
|
||||||
-22
@@ -1,22 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import "os/exec"
|
|
||||||
|
|
||||||
// DetectDefaultStore return the default credentials store for the platform if
|
|
||||||
// no user-defined store is passed, and the store executable is available.
|
|
||||||
func DetectDefaultStore(store string) string {
|
|
||||||
if store != "" {
|
|
||||||
// use user-defined
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
platformDefault := defaultCredentialsStore()
|
|
||||||
if platformDefault == "" {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := exec.LookPath(remoteCredentialsPrefix + platformDefault); err != nil {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
return platformDefault
|
|
||||||
}
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
func defaultCredentialsStore() string {
|
|
||||||
return "osxkeychain"
|
|
||||||
}
|
|
||||||
-13
@@ -1,13 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"os/exec"
|
|
||||||
)
|
|
||||||
|
|
||||||
func defaultCredentialsStore() string {
|
|
||||||
if _, err := exec.LookPath("pass"); err == nil {
|
|
||||||
return "pass"
|
|
||||||
}
|
|
||||||
|
|
||||||
return "secretservice"
|
|
||||||
}
|
|
||||||
-7
@@ -1,7 +0,0 @@
|
|||||||
//go:build !windows && !darwin && !linux
|
|
||||||
|
|
||||||
package credentials
|
|
||||||
|
|
||||||
func defaultCredentialsStore() string {
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
-5
@@ -1,5 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
func defaultCredentialsStore() string {
|
|
||||||
return "wincred"
|
|
||||||
}
|
|
||||||
-118
@@ -1,118 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"net/url"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"sync/atomic"
|
|
||||||
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
type store interface {
|
|
||||||
Save() error
|
|
||||||
GetAuthConfigs() map[string]types.AuthConfig
|
|
||||||
GetFilename() string
|
|
||||||
}
|
|
||||||
|
|
||||||
// fileStore implements a credentials store using
|
|
||||||
// the docker configuration file to keep the credentials in plain text.
|
|
||||||
type fileStore struct {
|
|
||||||
file store
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewFileStore creates a new file credentials store.
|
|
||||||
func NewFileStore(file store) Store {
|
|
||||||
return &fileStore{file: file}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Erase removes the given credentials from the file store.This function is
|
|
||||||
// idempotent and does not update the file if credentials did not change.
|
|
||||||
func (c *fileStore) Erase(serverAddress string) error {
|
|
||||||
if _, exists := c.file.GetAuthConfigs()[serverAddress]; !exists {
|
|
||||||
// nothing to do; no credentials found for the given serverAddress
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
delete(c.file.GetAuthConfigs(), serverAddress)
|
|
||||||
return c.file.Save()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get retrieves credentials for a specific server from the file store.
|
|
||||||
func (c *fileStore) Get(serverAddress string) (types.AuthConfig, error) {
|
|
||||||
authConfig, ok := c.file.GetAuthConfigs()[serverAddress]
|
|
||||||
if !ok {
|
|
||||||
// Maybe they have a legacy config file, we will iterate the keys converting
|
|
||||||
// them to the new format and testing
|
|
||||||
for r, ac := range c.file.GetAuthConfigs() {
|
|
||||||
if serverAddress == ConvertToHostname(r) {
|
|
||||||
return ac, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
authConfig = types.AuthConfig{}
|
|
||||||
}
|
|
||||||
return authConfig, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *fileStore) GetAll() (map[string]types.AuthConfig, error) {
|
|
||||||
return c.file.GetAuthConfigs(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// unencryptedWarning warns the user when using an insecure credential storage.
|
|
||||||
// After a deprecation period, user will get prompted if stdin and stderr are a terminal.
|
|
||||||
// Otherwise, we'll assume they want it (sadly), because people may have been scripting
|
|
||||||
// insecure logins and we don't want to break them. Maybe they'll see the warning in their
|
|
||||||
// logs and fix things.
|
|
||||||
const unencryptedWarning = `
|
|
||||||
WARNING! Your credentials are stored unencrypted in '%s'.
|
|
||||||
Configure a credential helper to remove this warning. See
|
|
||||||
https://docs.docker.com/go/credential-store/
|
|
||||||
`
|
|
||||||
|
|
||||||
// alreadyPrinted ensures that we only print the unencryptedWarning once per
|
|
||||||
// CLI invocation (no need to warn the user multiple times per command).
|
|
||||||
var alreadyPrinted atomic.Bool
|
|
||||||
|
|
||||||
// Store saves the given credentials in the file store. This function is
|
|
||||||
// idempotent and does not update the file if credentials did not change.
|
|
||||||
func (c *fileStore) Store(authConfig types.AuthConfig) error {
|
|
||||||
authConfigs := c.file.GetAuthConfigs()
|
|
||||||
if oldAuthConfig, ok := authConfigs[authConfig.ServerAddress]; ok && oldAuthConfig == authConfig {
|
|
||||||
// Credentials didn't change, so skip updating the configuration file.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
authConfigs[authConfig.ServerAddress] = authConfig
|
|
||||||
if err := c.file.Save(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !alreadyPrinted.Load() && authConfig.Password != "" {
|
|
||||||
// Display a warning if we're storing the users password (not a token).
|
|
||||||
//
|
|
||||||
// FIXME(thaJeztah): make output configurable instead of hardcoding to os.Stderr
|
|
||||||
_, _ = fmt.Fprintln(os.Stderr, fmt.Sprintf(unencryptedWarning, c.file.GetFilename()))
|
|
||||||
alreadyPrinted.Store(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ConvertToHostname converts a registry url which has http|https prepended
|
|
||||||
// to just an hostname.
|
|
||||||
// Copied from github.com/docker/docker/registry.ConvertToHostname to reduce dependencies.
|
|
||||||
func ConvertToHostname(maybeURL string) string {
|
|
||||||
stripped := maybeURL
|
|
||||||
if strings.Contains(stripped, "://") {
|
|
||||||
u, err := url.Parse(stripped)
|
|
||||||
if err == nil && u.Hostname() != "" {
|
|
||||||
if u.Port() == "" {
|
|
||||||
return u.Hostname()
|
|
||||||
}
|
|
||||||
return net.JoinHostPort(u.Hostname(), u.Port())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
hostName, _, _ := strings.Cut(stripped, "/")
|
|
||||||
return hostName
|
|
||||||
}
|
|
||||||
-147
@@ -1,147 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
"github.com/docker/docker-credential-helpers/client"
|
|
||||||
"github.com/docker/docker-credential-helpers/credentials"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
remoteCredentialsPrefix = "docker-credential-" //nolint:gosec // ignore G101: Potential hardcoded credentials
|
|
||||||
tokenUsername = "<token>"
|
|
||||||
)
|
|
||||||
|
|
||||||
// nativeStore implements a credentials store
|
|
||||||
// using native keychain to keep credentials secure.
|
|
||||||
// It piggybacks into a file store to keep users' emails.
|
|
||||||
type nativeStore struct {
|
|
||||||
programFunc client.ProgramFunc
|
|
||||||
fileStore Store
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewNativeStore creates a new native store that
|
|
||||||
// uses a remote helper program to manage credentials.
|
|
||||||
func NewNativeStore(file store, helperSuffix string) Store {
|
|
||||||
name := remoteCredentialsPrefix + helperSuffix
|
|
||||||
return &nativeStore{
|
|
||||||
programFunc: client.NewShellProgramFunc(name),
|
|
||||||
fileStore: NewFileStore(file),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Erase removes the given credentials from the native store.
|
|
||||||
func (c *nativeStore) Erase(serverAddress string) error {
|
|
||||||
if err := client.Erase(c.programFunc, serverAddress); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fallback to plain text store to remove email
|
|
||||||
return c.fileStore.Erase(serverAddress)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get retrieves credentials for a specific server from the native store.
|
|
||||||
func (c *nativeStore) Get(serverAddress string) (types.AuthConfig, error) {
|
|
||||||
// load user email if it exist or an empty auth config.
|
|
||||||
auth, _ := c.fileStore.Get(serverAddress)
|
|
||||||
|
|
||||||
creds, err := c.getCredentialsFromStore(serverAddress)
|
|
||||||
if err != nil {
|
|
||||||
return auth, err
|
|
||||||
}
|
|
||||||
auth.Username = creds.Username
|
|
||||||
auth.IdentityToken = creds.IdentityToken
|
|
||||||
auth.Password = creds.Password
|
|
||||||
auth.ServerAddress = creds.ServerAddress
|
|
||||||
|
|
||||||
return auth, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetAll retrieves all the credentials from the native store.
|
|
||||||
func (c *nativeStore) GetAll() (map[string]types.AuthConfig, error) {
|
|
||||||
auths, err := c.listCredentialsInStore()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Emails are only stored in the file store.
|
|
||||||
// This call can be safely eliminated when emails are removed.
|
|
||||||
fileConfigs, _ := c.fileStore.GetAll()
|
|
||||||
|
|
||||||
authConfigs := make(map[string]types.AuthConfig)
|
|
||||||
for registry := range auths {
|
|
||||||
creds, err := c.getCredentialsFromStore(registry)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
ac := fileConfigs[registry] // might contain Email
|
|
||||||
ac.Username = creds.Username
|
|
||||||
ac.Password = creds.Password
|
|
||||||
ac.IdentityToken = creds.IdentityToken
|
|
||||||
if ac.ServerAddress == "" {
|
|
||||||
ac.ServerAddress = creds.ServerAddress
|
|
||||||
}
|
|
||||||
authConfigs[registry] = ac
|
|
||||||
}
|
|
||||||
|
|
||||||
return authConfigs, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store saves the given credentials in the file store.
|
|
||||||
func (c *nativeStore) Store(authConfig types.AuthConfig) error {
|
|
||||||
if err := c.storeCredentialsInStore(authConfig); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
authConfig.Username = ""
|
|
||||||
authConfig.Password = ""
|
|
||||||
authConfig.IdentityToken = ""
|
|
||||||
|
|
||||||
// Fallback to old credential in plain text to save only the email
|
|
||||||
return c.fileStore.Store(authConfig)
|
|
||||||
}
|
|
||||||
|
|
||||||
// storeCredentialsInStore executes the command to store the credentials in the native store.
|
|
||||||
func (c *nativeStore) storeCredentialsInStore(config types.AuthConfig) error {
|
|
||||||
creds := &credentials.Credentials{
|
|
||||||
ServerURL: config.ServerAddress,
|
|
||||||
Username: config.Username,
|
|
||||||
Secret: config.Password,
|
|
||||||
}
|
|
||||||
|
|
||||||
if config.IdentityToken != "" {
|
|
||||||
creds.Username = tokenUsername
|
|
||||||
creds.Secret = config.IdentityToken
|
|
||||||
}
|
|
||||||
|
|
||||||
return client.Store(c.programFunc, creds)
|
|
||||||
}
|
|
||||||
|
|
||||||
// getCredentialsFromStore executes the command to get the credentials from the native store.
|
|
||||||
func (c *nativeStore) getCredentialsFromStore(serverAddress string) (types.AuthConfig, error) {
|
|
||||||
var ret types.AuthConfig
|
|
||||||
|
|
||||||
creds, err := client.Get(c.programFunc, serverAddress)
|
|
||||||
if err != nil {
|
|
||||||
if credentials.IsErrCredentialsNotFound(err) {
|
|
||||||
// do not return an error if the credentials are not
|
|
||||||
// in the keychain. Let docker ask for new credentials.
|
|
||||||
return ret, nil
|
|
||||||
}
|
|
||||||
return ret, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if creds.Username == tokenUsername {
|
|
||||||
ret.IdentityToken = creds.Secret
|
|
||||||
} else {
|
|
||||||
ret.Password = creds.Secret
|
|
||||||
ret.Username = creds.Username
|
|
||||||
}
|
|
||||||
|
|
||||||
ret.ServerAddress = serverAddress
|
|
||||||
return ret, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// listCredentialsInStore returns a listing of stored credentials as a map of
|
|
||||||
// URL -> username.
|
|
||||||
func (c *nativeStore) listCredentialsInStore() (map[string]string, error) {
|
|
||||||
return client.List(c.programFunc)
|
|
||||||
}
|
|
||||||
-131
@@ -1,131 +0,0 @@
|
|||||||
// FIXME(thaJeztah): remove once we are a module; the go:build directive prevents go from downgrading language version to go1.16:
|
|
||||||
//go:build go1.24
|
|
||||||
|
|
||||||
package memorystore
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"maps"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
|
|
||||||
"github.com/docker/cli/cli/config/credentials"
|
|
||||||
"github.com/docker/cli/cli/config/types"
|
|
||||||
)
|
|
||||||
|
|
||||||
// notFoundErr is the error returned when a plugin could not be found.
|
|
||||||
type notFoundErr string
|
|
||||||
|
|
||||||
func (notFoundErr) NotFound() {}
|
|
||||||
|
|
||||||
func (e notFoundErr) Error() string {
|
|
||||||
return string(e)
|
|
||||||
}
|
|
||||||
|
|
||||||
var errValueNotFound notFoundErr = "value not found"
|
|
||||||
|
|
||||||
type Config struct {
|
|
||||||
lock sync.RWMutex
|
|
||||||
memoryCredentials map[string]types.AuthConfig
|
|
||||||
fallbackStore credentials.Store
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Config) Erase(serverAddress string) error {
|
|
||||||
e.lock.Lock()
|
|
||||||
defer e.lock.Unlock()
|
|
||||||
delete(e.memoryCredentials, serverAddress)
|
|
||||||
|
|
||||||
if e.fallbackStore != nil {
|
|
||||||
err := e.fallbackStore.Erase(serverAddress)
|
|
||||||
if err != nil {
|
|
||||||
_, _ = fmt.Fprintln(os.Stderr, "memorystore: ", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Config) Get(serverAddress string) (types.AuthConfig, error) {
|
|
||||||
e.lock.RLock()
|
|
||||||
defer e.lock.RUnlock()
|
|
||||||
authConfig, ok := e.memoryCredentials[serverAddress]
|
|
||||||
if !ok {
|
|
||||||
if e.fallbackStore != nil {
|
|
||||||
return e.fallbackStore.Get(serverAddress)
|
|
||||||
}
|
|
||||||
return types.AuthConfig{}, errValueNotFound
|
|
||||||
}
|
|
||||||
return authConfig, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Config) GetAll() (map[string]types.AuthConfig, error) {
|
|
||||||
e.lock.RLock()
|
|
||||||
defer e.lock.RUnlock()
|
|
||||||
creds := make(map[string]types.AuthConfig)
|
|
||||||
|
|
||||||
if e.fallbackStore != nil {
|
|
||||||
fileCredentials, err := e.fallbackStore.GetAll()
|
|
||||||
if err != nil {
|
|
||||||
_, _ = fmt.Fprintln(os.Stderr, "memorystore: ", err)
|
|
||||||
} else {
|
|
||||||
creds = fileCredentials
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
maps.Copy(creds, e.memoryCredentials)
|
|
||||||
return creds, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *Config) Store(authConfig types.AuthConfig) error {
|
|
||||||
e.lock.Lock()
|
|
||||||
defer e.lock.Unlock()
|
|
||||||
e.memoryCredentials[authConfig.ServerAddress] = authConfig
|
|
||||||
|
|
||||||
if e.fallbackStore != nil {
|
|
||||||
return e.fallbackStore.Store(authConfig)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithFallbackStore sets a fallback store.
|
|
||||||
//
|
|
||||||
// Write operations will be performed on both the memory store and the
|
|
||||||
// fallback store.
|
|
||||||
//
|
|
||||||
// Read operations will first check the memory store, and if the credential
|
|
||||||
// is not found, it will then check the fallback store.
|
|
||||||
//
|
|
||||||
// Retrieving all credentials will return from both the memory store and the
|
|
||||||
// fallback store, merging the results from both stores into a single map.
|
|
||||||
//
|
|
||||||
// Data stored in the memory store will take precedence over data in the
|
|
||||||
// fallback store.
|
|
||||||
func WithFallbackStore(store credentials.Store) Options {
|
|
||||||
return func(s *Config) error {
|
|
||||||
s.fallbackStore = store
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithAuthConfig allows to set the initial credentials in the memory store.
|
|
||||||
func WithAuthConfig(config map[string]types.AuthConfig) Options {
|
|
||||||
return func(s *Config) error {
|
|
||||||
s.memoryCredentials = config
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type Options func(*Config) error
|
|
||||||
|
|
||||||
// New creates a new in memory credential store
|
|
||||||
func New(opts ...Options) (credentials.Store, error) {
|
|
||||||
m := &Config{
|
|
||||||
memoryCredentials: make(map[string]types.AuthConfig),
|
|
||||||
}
|
|
||||||
for _, opt := range opts {
|
|
||||||
if err := opt(m); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return m, nil
|
|
||||||
}
|
|
||||||
-17
@@ -1,17 +0,0 @@
|
|||||||
package types
|
|
||||||
|
|
||||||
// AuthConfig contains authorization information for connecting to a Registry
|
|
||||||
type AuthConfig struct {
|
|
||||||
Username string `json:"username,omitempty"`
|
|
||||||
Password string `json:"password,omitempty"`
|
|
||||||
Auth string `json:"auth,omitempty"`
|
|
||||||
|
|
||||||
ServerAddress string `json:"serveraddress,omitempty"`
|
|
||||||
|
|
||||||
// IdentityToken is used to authenticate the user and get
|
|
||||||
// an access token for the registry.
|
|
||||||
IdentityToken string `json:"identitytoken,omitempty"`
|
|
||||||
|
|
||||||
// RegistryToken is a bearer token to be sent to a registry
|
|
||||||
RegistryToken string `json:"registrytoken,omitempty"`
|
|
||||||
}
|
|
||||||
-202
@@ -1,202 +0,0 @@
|
|||||||
Apache License
|
|
||||||
Version 2.0, January 2004
|
|
||||||
http://www.apache.org/licenses/
|
|
||||||
|
|
||||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
||||||
|
|
||||||
1. Definitions.
|
|
||||||
|
|
||||||
"License" shall mean the terms and conditions for use, reproduction,
|
|
||||||
and distribution as defined by Sections 1 through 9 of this document.
|
|
||||||
|
|
||||||
"Licensor" shall mean the copyright owner or entity authorized by
|
|
||||||
the copyright owner that is granting the License.
|
|
||||||
|
|
||||||
"Legal Entity" shall mean the union of the acting entity and all
|
|
||||||
other entities that control, are controlled by, or are under common
|
|
||||||
control with that entity. For the purposes of this definition,
|
|
||||||
"control" means (i) the power, direct or indirect, to cause the
|
|
||||||
direction or management of such entity, whether by contract or
|
|
||||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
||||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
||||||
|
|
||||||
"You" (or "Your") shall mean an individual or Legal Entity
|
|
||||||
exercising permissions granted by this License.
|
|
||||||
|
|
||||||
"Source" form shall mean the preferred form for making modifications,
|
|
||||||
including but not limited to software source code, documentation
|
|
||||||
source, and configuration files.
|
|
||||||
|
|
||||||
"Object" form shall mean any form resulting from mechanical
|
|
||||||
transformation or translation of a Source form, including but
|
|
||||||
not limited to compiled object code, generated documentation,
|
|
||||||
and conversions to other media types.
|
|
||||||
|
|
||||||
"Work" shall mean the work of authorship, whether in Source or
|
|
||||||
Object form, made available under the License, as indicated by a
|
|
||||||
copyright notice that is included in or attached to the work
|
|
||||||
(an example is provided in the Appendix below).
|
|
||||||
|
|
||||||
"Derivative Works" shall mean any work, whether in Source or Object
|
|
||||||
form, that is based on (or derived from) the Work and for which the
|
|
||||||
editorial revisions, annotations, elaborations, or other modifications
|
|
||||||
represent, as a whole, an original work of authorship. For the purposes
|
|
||||||
of this License, Derivative Works shall not include works that remain
|
|
||||||
separable from, or merely link (or bind by name) to the interfaces of,
|
|
||||||
the Work and Derivative Works thereof.
|
|
||||||
|
|
||||||
"Contribution" shall mean any work of authorship, including
|
|
||||||
the original version of the Work and any modifications or additions
|
|
||||||
to that Work or Derivative Works thereof, that is intentionally
|
|
||||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
||||||
or by an individual or Legal Entity authorized to submit on behalf of
|
|
||||||
the copyright owner. For the purposes of this definition, "submitted"
|
|
||||||
means any form of electronic, verbal, or written communication sent
|
|
||||||
to the Licensor or its representatives, including but not limited to
|
|
||||||
communication on electronic mailing lists, source code control systems,
|
|
||||||
and issue tracking systems that are managed by, or on behalf of, the
|
|
||||||
Licensor for the purpose of discussing and improving the Work, but
|
|
||||||
excluding communication that is conspicuously marked or otherwise
|
|
||||||
designated in writing by the copyright owner as "Not a Contribution."
|
|
||||||
|
|
||||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
||||||
on behalf of whom a Contribution has been received by Licensor and
|
|
||||||
subsequently incorporated within the Work.
|
|
||||||
|
|
||||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
copyright license to reproduce, prepare Derivative Works of,
|
|
||||||
publicly display, publicly perform, sublicense, and distribute the
|
|
||||||
Work and such Derivative Works in Source or Object form.
|
|
||||||
|
|
||||||
3. Grant of Patent License. Subject to the terms and conditions of
|
|
||||||
this License, each Contributor hereby grants to You a perpetual,
|
|
||||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
||||||
(except as stated in this section) patent license to make, have made,
|
|
||||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
||||||
where such license applies only to those patent claims licensable
|
|
||||||
by such Contributor that are necessarily infringed by their
|
|
||||||
Contribution(s) alone or by combination of their Contribution(s)
|
|
||||||
with the Work to which such Contribution(s) was submitted. If You
|
|
||||||
institute patent litigation against any entity (including a
|
|
||||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
||||||
or a Contribution incorporated within the Work constitutes direct
|
|
||||||
or contributory patent infringement, then any patent licenses
|
|
||||||
granted to You under this License for that Work shall terminate
|
|
||||||
as of the date such litigation is filed.
|
|
||||||
|
|
||||||
4. Redistribution. You may reproduce and distribute copies of the
|
|
||||||
Work or Derivative Works thereof in any medium, with or without
|
|
||||||
modifications, and in Source or Object form, provided that You
|
|
||||||
meet the following conditions:
|
|
||||||
|
|
||||||
(a) You must give any other recipients of the Work or
|
|
||||||
Derivative Works a copy of this License; and
|
|
||||||
|
|
||||||
(b) You must cause any modified files to carry prominent notices
|
|
||||||
stating that You changed the files; and
|
|
||||||
|
|
||||||
(c) You must retain, in the Source form of any Derivative Works
|
|
||||||
that You distribute, all copyright, patent, trademark, and
|
|
||||||
attribution notices from the Source form of the Work,
|
|
||||||
excluding those notices that do not pertain to any part of
|
|
||||||
the Derivative Works; and
|
|
||||||
|
|
||||||
(d) If the Work includes a "NOTICE" text file as part of its
|
|
||||||
distribution, then any Derivative Works that You distribute must
|
|
||||||
include a readable copy of the attribution notices contained
|
|
||||||
within such NOTICE file, excluding those notices that do not
|
|
||||||
pertain to any part of the Derivative Works, in at least one
|
|
||||||
of the following places: within a NOTICE text file distributed
|
|
||||||
as part of the Derivative Works; within the Source form or
|
|
||||||
documentation, if provided along with the Derivative Works; or,
|
|
||||||
within a display generated by the Derivative Works, if and
|
|
||||||
wherever such third-party notices normally appear. The contents
|
|
||||||
of the NOTICE file are for informational purposes only and
|
|
||||||
do not modify the License. You may add Your own attribution
|
|
||||||
notices within Derivative Works that You distribute, alongside
|
|
||||||
or as an addendum to the NOTICE text from the Work, provided
|
|
||||||
that such additional attribution notices cannot be construed
|
|
||||||
as modifying the License.
|
|
||||||
|
|
||||||
You may add Your own copyright statement to Your modifications and
|
|
||||||
may provide additional or different license terms and conditions
|
|
||||||
for use, reproduction, or distribution of Your modifications, or
|
|
||||||
for any such Derivative Works as a whole, provided Your use,
|
|
||||||
reproduction, and distribution of the Work otherwise complies with
|
|
||||||
the conditions stated in this License.
|
|
||||||
|
|
||||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
||||||
any Contribution intentionally submitted for inclusion in the Work
|
|
||||||
by You to the Licensor shall be under the terms and conditions of
|
|
||||||
this License, without any additional terms or conditions.
|
|
||||||
Notwithstanding the above, nothing herein shall supersede or modify
|
|
||||||
the terms of any separate license agreement you may have executed
|
|
||||||
with Licensor regarding such Contributions.
|
|
||||||
|
|
||||||
6. Trademarks. This License does not grant permission to use the trade
|
|
||||||
names, trademarks, service marks, or product names of the Licensor,
|
|
||||||
except as required for reasonable and customary use in describing the
|
|
||||||
origin of the Work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
||||||
agreed to in writing, Licensor provides the Work (and each
|
|
||||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
||||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
||||||
implied, including, without limitation, any warranties or conditions
|
|
||||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
||||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
||||||
appropriateness of using or redistributing the Work and assume any
|
|
||||||
risks associated with Your exercise of permissions under this License.
|
|
||||||
|
|
||||||
8. Limitation of Liability. In no event and under no legal theory,
|
|
||||||
whether in tort (including negligence), contract, or otherwise,
|
|
||||||
unless required by applicable law (such as deliberate and grossly
|
|
||||||
negligent acts) or agreed to in writing, shall any Contributor be
|
|
||||||
liable to You for damages, including any direct, indirect, special,
|
|
||||||
incidental, or consequential damages of any character arising as a
|
|
||||||
result of this License or out of the use or inability to use the
|
|
||||||
Work (including but not limited to damages for loss of goodwill,
|
|
||||||
work stoppage, computer failure or malfunction, or any and all
|
|
||||||
other commercial damages or losses), even if such Contributor
|
|
||||||
has been advised of the possibility of such damages.
|
|
||||||
|
|
||||||
9. Accepting Warranty or Additional Liability. While redistributing
|
|
||||||
the Work or Derivative Works thereof, You may choose to offer,
|
|
||||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
||||||
or other liability obligations and/or rights consistent with this
|
|
||||||
License. However, in accepting such obligations, You may act only
|
|
||||||
on Your own behalf and on Your sole responsibility, not on behalf
|
|
||||||
of any other Contributor, and only if You agree to indemnify,
|
|
||||||
defend, and hold each Contributor harmless for any liability
|
|
||||||
incurred by, or claims asserted against, such Contributor by reason
|
|
||||||
of your accepting any such warranty or additional liability.
|
|
||||||
|
|
||||||
END OF TERMS AND CONDITIONS
|
|
||||||
|
|
||||||
APPENDIX: How to apply the Apache License to your work.
|
|
||||||
|
|
||||||
To apply the Apache License to your work, attach the following
|
|
||||||
boilerplate notice, with the fields enclosed by brackets "{}"
|
|
||||||
replaced with your own identifying information. (Don't include
|
|
||||||
the brackets!) The text should be enclosed in the appropriate
|
|
||||||
comment syntax for the file format. We also recommend that a
|
|
||||||
file or class name and description of purpose be included on the
|
|
||||||
same "printed page" as the copyright notice for easier
|
|
||||||
identification within third-party archives.
|
|
||||||
|
|
||||||
Copyright {yyyy} {name of copyright owner}
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
-27
@@ -1,27 +0,0 @@
|
|||||||
package challenge
|
|
||||||
|
|
||||||
import (
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// FROM: https://golang.org/src/net/http/http.go
|
|
||||||
// Given a string of the form "host", "host:port", or "[ipv6::address]:port",
|
|
||||||
// return true if the string includes a port.
|
|
||||||
func hasPort(s string) bool { return strings.LastIndex(s, ":") > strings.LastIndex(s, "]") }
|
|
||||||
|
|
||||||
// FROM: http://golang.org/src/net/http/transport.go
|
|
||||||
var portMap = map[string]string{
|
|
||||||
"http": "80",
|
|
||||||
"https": "443",
|
|
||||||
}
|
|
||||||
|
|
||||||
// canonicalAddr returns url.Host but always with a ":port" suffix
|
|
||||||
// FROM: http://golang.org/src/net/http/transport.go
|
|
||||||
func canonicalAddr(url *url.URL) string {
|
|
||||||
addr := url.Host
|
|
||||||
if !hasPort(addr) {
|
|
||||||
return addr + ":" + portMap[url.Scheme]
|
|
||||||
}
|
|
||||||
return addr
|
|
||||||
}
|
|
||||||
Generated
Vendored
-237
@@ -1,237 +0,0 @@
|
|||||||
package challenge
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Challenge carries information from a WWW-Authenticate response header.
|
|
||||||
// See RFC 2617.
|
|
||||||
type Challenge struct {
|
|
||||||
// Scheme is the auth-scheme according to RFC 2617
|
|
||||||
Scheme string
|
|
||||||
|
|
||||||
// Parameters are the auth-params according to RFC 2617
|
|
||||||
Parameters map[string]string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Manager manages the challenges for endpoints.
|
|
||||||
// The challenges are pulled out of HTTP responses. Only
|
|
||||||
// responses which expect challenges should be added to
|
|
||||||
// the manager, since a non-unauthorized request will be
|
|
||||||
// viewed as not requiring challenges.
|
|
||||||
type Manager interface {
|
|
||||||
// GetChallenges returns the challenges for the given
|
|
||||||
// endpoint URL.
|
|
||||||
GetChallenges(endpoint url.URL) ([]Challenge, error)
|
|
||||||
|
|
||||||
// AddResponse adds the response to the challenge
|
|
||||||
// manager. The challenges will be parsed out of
|
|
||||||
// the WWW-Authenicate headers and added to the
|
|
||||||
// URL which was produced the response. If the
|
|
||||||
// response was authorized, any challenges for the
|
|
||||||
// endpoint will be cleared.
|
|
||||||
AddResponse(resp *http.Response) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewSimpleManager returns an instance of
|
|
||||||
// Manger which only maps endpoints to challenges
|
|
||||||
// based on the responses which have been added the
|
|
||||||
// manager. The simple manager will make no attempt to
|
|
||||||
// perform requests on the endpoints or cache the responses
|
|
||||||
// to a backend.
|
|
||||||
func NewSimpleManager() Manager {
|
|
||||||
return &simpleManager{
|
|
||||||
Challenges: make(map[string][]Challenge),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
type simpleManager struct {
|
|
||||||
sync.RWMutex
|
|
||||||
Challenges map[string][]Challenge
|
|
||||||
}
|
|
||||||
|
|
||||||
func normalizeURL(endpoint *url.URL) {
|
|
||||||
endpoint.Host = strings.ToLower(endpoint.Host)
|
|
||||||
endpoint.Host = canonicalAddr(endpoint)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *simpleManager) GetChallenges(endpoint url.URL) ([]Challenge, error) {
|
|
||||||
normalizeURL(&endpoint)
|
|
||||||
|
|
||||||
m.RLock()
|
|
||||||
defer m.RUnlock()
|
|
||||||
challenges := m.Challenges[endpoint.String()]
|
|
||||||
return challenges, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *simpleManager) AddResponse(resp *http.Response) error {
|
|
||||||
challenges := ResponseChallenges(resp)
|
|
||||||
if resp.Request == nil {
|
|
||||||
return fmt.Errorf("missing request reference")
|
|
||||||
}
|
|
||||||
urlCopy := url.URL{
|
|
||||||
Path: resp.Request.URL.Path,
|
|
||||||
Host: resp.Request.URL.Host,
|
|
||||||
Scheme: resp.Request.URL.Scheme,
|
|
||||||
}
|
|
||||||
normalizeURL(&urlCopy)
|
|
||||||
|
|
||||||
m.Lock()
|
|
||||||
defer m.Unlock()
|
|
||||||
m.Challenges[urlCopy.String()] = challenges
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Octet types from RFC 2616.
|
|
||||||
type octetType byte
|
|
||||||
|
|
||||||
var octetTypes [256]octetType
|
|
||||||
|
|
||||||
const (
|
|
||||||
isToken octetType = 1 << iota
|
|
||||||
isSpace
|
|
||||||
)
|
|
||||||
|
|
||||||
func init() {
|
|
||||||
// OCTET = <any 8-bit sequence of data>
|
|
||||||
// CHAR = <any US-ASCII character (octets 0 - 127)>
|
|
||||||
// CTL = <any US-ASCII control character (octets 0 - 31) and DEL (127)>
|
|
||||||
// CR = <US-ASCII CR, carriage return (13)>
|
|
||||||
// LF = <US-ASCII LF, linefeed (10)>
|
|
||||||
// SP = <US-ASCII SP, space (32)>
|
|
||||||
// HT = <US-ASCII HT, horizontal-tab (9)>
|
|
||||||
// <"> = <US-ASCII double-quote mark (34)>
|
|
||||||
// CRLF = CR LF
|
|
||||||
// LWS = [CRLF] 1*( SP | HT )
|
|
||||||
// TEXT = <any OCTET except CTLs, but including LWS>
|
|
||||||
// separators = "(" | ")" | "<" | ">" | "@" | "," | ";" | ":" | "\" | <">
|
|
||||||
// | "/" | "[" | "]" | "?" | "=" | "{" | "}" | SP | HT
|
|
||||||
// token = 1*<any CHAR except CTLs or separators>
|
|
||||||
// qdtext = <any TEXT except <">>
|
|
||||||
|
|
||||||
for c := 0; c < 256; c++ {
|
|
||||||
var t octetType
|
|
||||||
isCtl := c <= 31 || c == 127
|
|
||||||
isChar := 0 <= c && c <= 127
|
|
||||||
isSeparator := strings.ContainsRune(" \t\"(),/:;<=>?@[]\\{}", rune(c))
|
|
||||||
if strings.ContainsRune(" \t\r\n", rune(c)) {
|
|
||||||
t |= isSpace
|
|
||||||
}
|
|
||||||
if isChar && !isCtl && !isSeparator {
|
|
||||||
t |= isToken
|
|
||||||
}
|
|
||||||
octetTypes[c] = t
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ResponseChallenges returns a list of authorization challenges
|
|
||||||
// for the given http Response. Challenges are only checked if
|
|
||||||
// the response status code was a 401.
|
|
||||||
func ResponseChallenges(resp *http.Response) []Challenge {
|
|
||||||
if resp.StatusCode == http.StatusUnauthorized {
|
|
||||||
// Parse the WWW-Authenticate Header and store the challenges
|
|
||||||
// on this endpoint object.
|
|
||||||
return parseAuthHeader(resp.Header)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseAuthHeader(header http.Header) []Challenge {
|
|
||||||
challenges := []Challenge{}
|
|
||||||
for _, h := range header[http.CanonicalHeaderKey("WWW-Authenticate")] {
|
|
||||||
v, p := parseValueAndParams(h)
|
|
||||||
if v != "" {
|
|
||||||
challenges = append(challenges, Challenge{Scheme: v, Parameters: p})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return challenges
|
|
||||||
}
|
|
||||||
|
|
||||||
func parseValueAndParams(header string) (value string, params map[string]string) {
|
|
||||||
params = make(map[string]string)
|
|
||||||
value, s := expectToken(header)
|
|
||||||
if value == "" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
value = strings.ToLower(value)
|
|
||||||
s = "," + skipSpace(s)
|
|
||||||
for strings.HasPrefix(s, ",") {
|
|
||||||
var pkey string
|
|
||||||
pkey, s = expectToken(skipSpace(s[1:]))
|
|
||||||
if pkey == "" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !strings.HasPrefix(s, "=") {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
var pvalue string
|
|
||||||
pvalue, s = expectTokenOrQuoted(s[1:])
|
|
||||||
if pvalue == "" {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
pkey = strings.ToLower(pkey)
|
|
||||||
params[pkey] = pvalue
|
|
||||||
s = skipSpace(s)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func skipSpace(s string) (rest string) {
|
|
||||||
i := 0
|
|
||||||
for ; i < len(s); i++ {
|
|
||||||
if octetTypes[s[i]]&isSpace == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return s[i:]
|
|
||||||
}
|
|
||||||
|
|
||||||
func expectToken(s string) (token, rest string) {
|
|
||||||
i := 0
|
|
||||||
for ; i < len(s); i++ {
|
|
||||||
if octetTypes[s[i]]&isToken == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return s[:i], s[i:]
|
|
||||||
}
|
|
||||||
|
|
||||||
func expectTokenOrQuoted(s string) (value string, rest string) {
|
|
||||||
if !strings.HasPrefix(s, "\"") {
|
|
||||||
return expectToken(s)
|
|
||||||
}
|
|
||||||
s = s[1:]
|
|
||||||
for i := 0; i < len(s); i++ {
|
|
||||||
switch s[i] {
|
|
||||||
case '"':
|
|
||||||
return s[:i], s[i+1:]
|
|
||||||
case '\\':
|
|
||||||
p := make([]byte, len(s)-1)
|
|
||||||
j := copy(p, s[:i])
|
|
||||||
escape := true
|
|
||||||
for i = i + 1; i < len(s); i++ {
|
|
||||||
b := s[i]
|
|
||||||
switch {
|
|
||||||
case escape:
|
|
||||||
escape = false
|
|
||||||
p[j] = b
|
|
||||||
j++
|
|
||||||
case b == '\\':
|
|
||||||
escape = true
|
|
||||||
case b == '"':
|
|
||||||
return string(p[:j]), s[i+1:]
|
|
||||||
default:
|
|
||||||
p[j] = b
|
|
||||||
j++
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return "", ""
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return "", ""
|
|
||||||
}
|
|
||||||
-20
@@ -1,20 +0,0 @@
|
|||||||
Copyright (c) 2016 David Calavera
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
"Software"), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
||||||
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
||||||
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
||||||
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
||||||
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-114
@@ -1,114 +0,0 @@
|
|||||||
package client
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/docker/docker-credential-helpers/credentials"
|
|
||||||
)
|
|
||||||
|
|
||||||
// isValidCredsMessage checks if 'msg' contains invalid credentials error message.
|
|
||||||
// It returns whether the logs are free of invalid credentials errors and the error if it isn't.
|
|
||||||
// error values can be errCredentialsMissingServerURL or errCredentialsMissingUsername.
|
|
||||||
func isValidCredsMessage(msg string) error {
|
|
||||||
if credentials.IsCredentialsMissingServerURLMessage(msg) {
|
|
||||||
return credentials.NewErrCredentialsMissingServerURL()
|
|
||||||
}
|
|
||||||
if credentials.IsCredentialsMissingUsernameMessage(msg) {
|
|
||||||
return credentials.NewErrCredentialsMissingUsername()
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store uses an external program to save credentials.
|
|
||||||
func Store(program ProgramFunc, creds *credentials.Credentials) error {
|
|
||||||
cmd := program(credentials.ActionStore)
|
|
||||||
|
|
||||||
buffer := new(bytes.Buffer)
|
|
||||||
if err := json.NewEncoder(buffer).Encode(creds); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
cmd.Input(buffer)
|
|
||||||
|
|
||||||
out, err := cmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
if isValidErr := isValidCredsMessage(string(out)); isValidErr != nil {
|
|
||||||
err = isValidErr
|
|
||||||
}
|
|
||||||
return fmt.Errorf("error storing credentials - err: %v, out: `%s`", err, strings.TrimSpace(string(out)))
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get executes an external program to get the credentials from a native store.
|
|
||||||
func Get(program ProgramFunc, serverURL string) (*credentials.Credentials, error) {
|
|
||||||
cmd := program(credentials.ActionGet)
|
|
||||||
cmd.Input(strings.NewReader(serverURL))
|
|
||||||
|
|
||||||
out, err := cmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
if credentials.IsErrCredentialsNotFoundMessage(string(out)) {
|
|
||||||
return nil, credentials.NewErrCredentialsNotFound()
|
|
||||||
}
|
|
||||||
|
|
||||||
if isValidErr := isValidCredsMessage(string(out)); isValidErr != nil {
|
|
||||||
err = isValidErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("error getting credentials - err: %v, out: `%s`", err, strings.TrimSpace(string(out)))
|
|
||||||
}
|
|
||||||
|
|
||||||
resp := &credentials.Credentials{
|
|
||||||
ServerURL: serverURL,
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := json.NewDecoder(bytes.NewReader(out)).Decode(resp); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return resp, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Erase executes a program to remove the server credentials from the native store.
|
|
||||||
func Erase(program ProgramFunc, serverURL string) error {
|
|
||||||
cmd := program(credentials.ActionErase)
|
|
||||||
cmd.Input(strings.NewReader(serverURL))
|
|
||||||
out, err := cmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
t := strings.TrimSpace(string(out))
|
|
||||||
|
|
||||||
if isValidErr := isValidCredsMessage(t); isValidErr != nil {
|
|
||||||
err = isValidErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return fmt.Errorf("error erasing credentials - err: %v, out: `%s`", err, t)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// List executes a program to list server credentials in the native store.
|
|
||||||
func List(program ProgramFunc) (map[string]string, error) {
|
|
||||||
cmd := program(credentials.ActionList)
|
|
||||||
cmd.Input(strings.NewReader("unused"))
|
|
||||||
out, err := cmd.Output()
|
|
||||||
if err != nil {
|
|
||||||
t := strings.TrimSpace(string(out))
|
|
||||||
|
|
||||||
if isValidErr := isValidCredsMessage(t); isValidErr != nil {
|
|
||||||
err = isValidErr
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, fmt.Errorf("error listing credentials - err: %v, out: `%s`", err, t)
|
|
||||||
}
|
|
||||||
|
|
||||||
var resp map[string]string
|
|
||||||
if err = json.NewDecoder(bytes.NewReader(out)).Decode(&resp); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return resp, nil
|
|
||||||
}
|
|
||||||
-57
@@ -1,57 +0,0 @@
|
|||||||
package client
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"os/exec"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Program is an interface to execute external programs.
|
|
||||||
type Program interface {
|
|
||||||
Output() ([]byte, error)
|
|
||||||
Input(in io.Reader)
|
|
||||||
}
|
|
||||||
|
|
||||||
// ProgramFunc is a type of function that initializes programs based on arguments.
|
|
||||||
type ProgramFunc func(args ...string) Program
|
|
||||||
|
|
||||||
// NewShellProgramFunc creates a [ProgramFunc] to run command in a [Shell].
|
|
||||||
func NewShellProgramFunc(command string) ProgramFunc {
|
|
||||||
return func(args ...string) Program {
|
|
||||||
return createProgramCmdRedirectErr(command, args, nil)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewShellProgramFuncWithEnv creates a [ProgramFunc] tu run command
|
|
||||||
// in a [Shell] with the given environment variables.
|
|
||||||
func NewShellProgramFuncWithEnv(command string, env *map[string]string) ProgramFunc {
|
|
||||||
return func(args ...string) Program {
|
|
||||||
return createProgramCmdRedirectErr(command, args, env)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func createProgramCmdRedirectErr(command string, args []string, env *map[string]string) *Shell {
|
|
||||||
ec := exec.Command(command, args...)
|
|
||||||
if env != nil {
|
|
||||||
for k, v := range *env {
|
|
||||||
ec.Env = append(ec.Environ(), k+"="+v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
ec.Stderr = os.Stderr
|
|
||||||
return &Shell{cmd: ec}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Shell invokes shell commands to talk with a remote credentials-helper.
|
|
||||||
type Shell struct {
|
|
||||||
cmd *exec.Cmd
|
|
||||||
}
|
|
||||||
|
|
||||||
// Output returns responses from the remote credentials-helper.
|
|
||||||
func (s *Shell) Output() ([]byte, error) {
|
|
||||||
return s.cmd.Output()
|
|
||||||
}
|
|
||||||
|
|
||||||
// Input sets the input to send to a remote credentials-helper.
|
|
||||||
func (s *Shell) Input(in io.Reader) {
|
|
||||||
s.cmd.Stdin = in
|
|
||||||
}
|
|
||||||
-209
@@ -1,209 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Action defines the name of an action (sub-command) supported by a
|
|
||||||
// credential-helper binary. It is an alias for "string", and mostly
|
|
||||||
// for convenience.
|
|
||||||
type Action = string
|
|
||||||
|
|
||||||
// List of actions (sub-commands) supported by credential-helper binaries.
|
|
||||||
const (
|
|
||||||
ActionStore Action = "store"
|
|
||||||
ActionGet Action = "get"
|
|
||||||
ActionErase Action = "erase"
|
|
||||||
ActionList Action = "list"
|
|
||||||
ActionVersion Action = "version"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Credentials holds the information shared between docker and the credentials store.
|
|
||||||
type Credentials struct {
|
|
||||||
ServerURL string
|
|
||||||
Username string
|
|
||||||
Secret string
|
|
||||||
}
|
|
||||||
|
|
||||||
// isValid checks the integrity of Credentials object such that no credentials lack
|
|
||||||
// a server URL or a username.
|
|
||||||
// It returns whether the credentials are valid and the error if it isn't.
|
|
||||||
// error values can be errCredentialsMissingServerURL or errCredentialsMissingUsername
|
|
||||||
func (c *Credentials) isValid() (bool, error) {
|
|
||||||
if len(c.ServerURL) == 0 {
|
|
||||||
return false, NewErrCredentialsMissingServerURL()
|
|
||||||
}
|
|
||||||
|
|
||||||
if len(c.Username) == 0 {
|
|
||||||
return false, NewErrCredentialsMissingUsername()
|
|
||||||
}
|
|
||||||
|
|
||||||
return true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// CredsLabel holds the way Docker credentials should be labeled as such in credentials stores that allow labelling.
|
|
||||||
// That label allows to filter out non-Docker credentials too at lookup/search in macOS keychain,
|
|
||||||
// Windows credentials manager and Linux libsecret. Default value is "Docker Credentials"
|
|
||||||
var CredsLabel = "Docker Credentials"
|
|
||||||
|
|
||||||
// SetCredsLabel is a simple setter for CredsLabel
|
|
||||||
func SetCredsLabel(label string) {
|
|
||||||
CredsLabel = label
|
|
||||||
}
|
|
||||||
|
|
||||||
// Serve initializes the credentials-helper and parses the action argument.
|
|
||||||
// This function is designed to be called from a command line interface.
|
|
||||||
// It uses os.Args[1] as the key for the action.
|
|
||||||
// It uses os.Stdin as input and os.Stdout as output.
|
|
||||||
// This function terminates the program with os.Exit(1) if there is an error.
|
|
||||||
func Serve(helper Helper) {
|
|
||||||
if len(os.Args) != 2 {
|
|
||||||
_, _ = fmt.Fprintln(os.Stdout, usage())
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
|
|
||||||
switch os.Args[1] {
|
|
||||||
case "--version", "-v":
|
|
||||||
_ = PrintVersion(os.Stdout)
|
|
||||||
os.Exit(0)
|
|
||||||
case "--help", "-h":
|
|
||||||
_, _ = fmt.Fprintln(os.Stdout, usage())
|
|
||||||
os.Exit(0)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := HandleCommand(helper, os.Args[1], os.Stdin, os.Stdout); err != nil {
|
|
||||||
_, _ = fmt.Fprintln(os.Stdout, err)
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func usage() string {
|
|
||||||
return fmt.Sprintf("Usage: %s <store|get|erase|list|version>", Name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// HandleCommand runs a helper to execute a credential action.
|
|
||||||
func HandleCommand(helper Helper, action Action, in io.Reader, out io.Writer) error {
|
|
||||||
switch action {
|
|
||||||
case ActionStore:
|
|
||||||
return Store(helper, in)
|
|
||||||
case ActionGet:
|
|
||||||
return Get(helper, in, out)
|
|
||||||
case ActionErase:
|
|
||||||
return Erase(helper, in)
|
|
||||||
case ActionList:
|
|
||||||
return List(helper, out)
|
|
||||||
case ActionVersion:
|
|
||||||
return PrintVersion(out)
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("%s: unknown action: %s", Name, action)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store uses a helper and an input reader to save credentials.
|
|
||||||
// The reader must contain the JSON serialization of a Credentials struct.
|
|
||||||
func Store(helper Helper, reader io.Reader) error {
|
|
||||||
scanner := bufio.NewScanner(reader)
|
|
||||||
|
|
||||||
buffer := new(bytes.Buffer)
|
|
||||||
for scanner.Scan() {
|
|
||||||
buffer.Write(scanner.Bytes())
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := scanner.Err(); err != nil && err != io.EOF {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
var creds Credentials
|
|
||||||
if err := json.NewDecoder(buffer).Decode(&creds); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if ok, err := creds.isValid(); !ok {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return helper.Add(&creds)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get retrieves the credentials for a given server url.
|
|
||||||
// The reader must contain the server URL to search.
|
|
||||||
// The writer is used to write the JSON serialization of the credentials.
|
|
||||||
func Get(helper Helper, reader io.Reader, writer io.Writer) error {
|
|
||||||
scanner := bufio.NewScanner(reader)
|
|
||||||
|
|
||||||
buffer := new(bytes.Buffer)
|
|
||||||
for scanner.Scan() {
|
|
||||||
buffer.Write(scanner.Bytes())
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := scanner.Err(); err != nil && err != io.EOF {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
serverURL := strings.TrimSpace(buffer.String())
|
|
||||||
if len(serverURL) == 0 {
|
|
||||||
return NewErrCredentialsMissingServerURL()
|
|
||||||
}
|
|
||||||
|
|
||||||
username, secret, err := helper.Get(serverURL)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
buffer.Reset()
|
|
||||||
err = json.NewEncoder(buffer).Encode(Credentials{
|
|
||||||
ServerURL: serverURL,
|
|
||||||
Username: username,
|
|
||||||
Secret: secret,
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
_, _ = fmt.Fprint(writer, buffer.String())
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Erase removes credentials from the store.
|
|
||||||
// The reader must contain the server URL to remove.
|
|
||||||
func Erase(helper Helper, reader io.Reader) error {
|
|
||||||
scanner := bufio.NewScanner(reader)
|
|
||||||
|
|
||||||
buffer := new(bytes.Buffer)
|
|
||||||
for scanner.Scan() {
|
|
||||||
buffer.Write(scanner.Bytes())
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := scanner.Err(); err != nil && err != io.EOF {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
serverURL := strings.TrimSpace(buffer.String())
|
|
||||||
if len(serverURL) == 0 {
|
|
||||||
return NewErrCredentialsMissingServerURL()
|
|
||||||
}
|
|
||||||
|
|
||||||
return helper.Delete(serverURL)
|
|
||||||
}
|
|
||||||
|
|
||||||
// List returns all the serverURLs of keys in
|
|
||||||
// the OS store as a list of strings
|
|
||||||
func List(helper Helper, writer io.Writer) error {
|
|
||||||
accts, err := helper.List()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return json.NewEncoder(writer).Encode(accts)
|
|
||||||
}
|
|
||||||
|
|
||||||
// PrintVersion outputs the current version.
|
|
||||||
func PrintVersion(writer io.Writer) error {
|
|
||||||
_, _ = fmt.Fprintf(writer, "%s (%s) %s\n", Name, Package, Version)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
-124
@@ -1,124 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
// ErrCredentialsNotFound standardizes the not found error, so every helper returns
|
|
||||||
// the same message and docker can handle it properly.
|
|
||||||
errCredentialsNotFoundMessage = "credentials not found in native keychain"
|
|
||||||
|
|
||||||
// ErrCredentialsMissingServerURL and ErrCredentialsMissingUsername standardize
|
|
||||||
// invalid credentials or credentials management operations
|
|
||||||
errCredentialsMissingServerURLMessage = "no credentials server URL"
|
|
||||||
errCredentialsMissingUsernameMessage = "no credentials username"
|
|
||||||
)
|
|
||||||
|
|
||||||
// errCredentialsNotFound represents an error
|
|
||||||
// raised when credentials are not in the store.
|
|
||||||
type errCredentialsNotFound struct{}
|
|
||||||
|
|
||||||
// Error returns the standard error message
|
|
||||||
// for when the credentials are not in the store.
|
|
||||||
func (errCredentialsNotFound) Error() string {
|
|
||||||
return errCredentialsNotFoundMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
// NotFound implements the [ErrNotFound][errdefs.ErrNotFound] interface.
|
|
||||||
//
|
|
||||||
// [errdefs.ErrNotFound]: https://pkg.go.dev/github.com/docker/docker@v24.0.1+incompatible/errdefs#ErrNotFound
|
|
||||||
func (errCredentialsNotFound) NotFound() {}
|
|
||||||
|
|
||||||
// NewErrCredentialsNotFound creates a new error
|
|
||||||
// for when the credentials are not in the store.
|
|
||||||
func NewErrCredentialsNotFound() error {
|
|
||||||
return errCredentialsNotFound{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsErrCredentialsNotFound returns true if the error
|
|
||||||
// was caused by not having a set of credentials in a store.
|
|
||||||
func IsErrCredentialsNotFound(err error) bool {
|
|
||||||
var target errCredentialsNotFound
|
|
||||||
return errors.As(err, &target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsErrCredentialsNotFoundMessage returns true if the error
|
|
||||||
// was caused by not having a set of credentials in a store.
|
|
||||||
//
|
|
||||||
// This function helps to check messages returned by an
|
|
||||||
// external program via its standard output.
|
|
||||||
func IsErrCredentialsNotFoundMessage(err string) bool {
|
|
||||||
return strings.TrimSpace(err) == errCredentialsNotFoundMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
// errCredentialsMissingServerURL represents an error raised
|
|
||||||
// when the credentials object has no server URL or when no
|
|
||||||
// server URL is provided to a credentials operation requiring
|
|
||||||
// one.
|
|
||||||
type errCredentialsMissingServerURL struct{}
|
|
||||||
|
|
||||||
func (errCredentialsMissingServerURL) Error() string {
|
|
||||||
return errCredentialsMissingServerURLMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
// InvalidParameter implements the [ErrInvalidParameter][errdefs.ErrInvalidParameter]
|
|
||||||
// interface.
|
|
||||||
//
|
|
||||||
// [errdefs.ErrInvalidParameter]: https://pkg.go.dev/github.com/docker/docker@v24.0.1+incompatible/errdefs#ErrInvalidParameter
|
|
||||||
func (errCredentialsMissingServerURL) InvalidParameter() {}
|
|
||||||
|
|
||||||
// errCredentialsMissingUsername represents an error raised
|
|
||||||
// when the credentials object has no username or when no
|
|
||||||
// username is provided to a credentials operation requiring
|
|
||||||
// one.
|
|
||||||
type errCredentialsMissingUsername struct{}
|
|
||||||
|
|
||||||
func (errCredentialsMissingUsername) Error() string {
|
|
||||||
return errCredentialsMissingUsernameMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
// InvalidParameter implements the [ErrInvalidParameter][errdefs.ErrInvalidParameter]
|
|
||||||
// interface.
|
|
||||||
//
|
|
||||||
// [errdefs.ErrInvalidParameter]: https://pkg.go.dev/github.com/docker/docker@v24.0.1+incompatible/errdefs#ErrInvalidParameter
|
|
||||||
func (errCredentialsMissingUsername) InvalidParameter() {}
|
|
||||||
|
|
||||||
// NewErrCredentialsMissingServerURL creates a new error for
|
|
||||||
// errCredentialsMissingServerURL.
|
|
||||||
func NewErrCredentialsMissingServerURL() error {
|
|
||||||
return errCredentialsMissingServerURL{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewErrCredentialsMissingUsername creates a new error for
|
|
||||||
// errCredentialsMissingUsername.
|
|
||||||
func NewErrCredentialsMissingUsername() error {
|
|
||||||
return errCredentialsMissingUsername{}
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsCredentialsMissingServerURL returns true if the error
|
|
||||||
// was an errCredentialsMissingServerURL.
|
|
||||||
func IsCredentialsMissingServerURL(err error) bool {
|
|
||||||
var target errCredentialsMissingServerURL
|
|
||||||
return errors.As(err, &target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsCredentialsMissingServerURLMessage checks for an
|
|
||||||
// errCredentialsMissingServerURL in the error message.
|
|
||||||
func IsCredentialsMissingServerURLMessage(err string) bool {
|
|
||||||
return strings.TrimSpace(err) == errCredentialsMissingServerURLMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsCredentialsMissingUsername returns true if the error
|
|
||||||
// was an errCredentialsMissingUsername.
|
|
||||||
func IsCredentialsMissingUsername(err error) bool {
|
|
||||||
var target errCredentialsMissingUsername
|
|
||||||
return errors.As(err, &target)
|
|
||||||
}
|
|
||||||
|
|
||||||
// IsCredentialsMissingUsernameMessage checks for an
|
|
||||||
// errCredentialsMissingUsername in the error message.
|
|
||||||
func IsCredentialsMissingUsernameMessage(err string) bool {
|
|
||||||
return strings.TrimSpace(err) == errCredentialsMissingUsernameMessage
|
|
||||||
}
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
// Helper is the interface a credentials store helper must implement.
|
|
||||||
type Helper interface {
|
|
||||||
// Add appends credentials to the store.
|
|
||||||
Add(*Credentials) error
|
|
||||||
// Delete removes credentials from the store.
|
|
||||||
Delete(serverURL string) error
|
|
||||||
// Get retrieves credentials from the store.
|
|
||||||
// It returns username and secret as strings.
|
|
||||||
Get(serverURL string) (string, string, error)
|
|
||||||
// List returns the stored serverURLs and their associated usernames.
|
|
||||||
List() (map[string]string, error)
|
|
||||||
}
|
|
||||||
-16
@@ -1,16 +0,0 @@
|
|||||||
package credentials
|
|
||||||
|
|
||||||
var (
|
|
||||||
// Name is filled at linking time
|
|
||||||
Name = ""
|
|
||||||
|
|
||||||
// Package is filled at linking time
|
|
||||||
Package = "github.com/docker/docker-credential-helpers"
|
|
||||||
|
|
||||||
// Version holds the complete version number. Filled in at linking time.
|
|
||||||
Version = "v0.0.0+unknown"
|
|
||||||
|
|
||||||
// Revision is filled with the VCS (e.g. git) revision being used to build
|
|
||||||
// the program at linking time.
|
|
||||||
Revision = ""
|
|
||||||
)
|
|
||||||
-14
@@ -1,14 +0,0 @@
|
|||||||
freebsd_task:
|
|
||||||
name: 'FreeBSD'
|
|
||||||
freebsd_instance:
|
|
||||||
image_family: freebsd-14-2
|
|
||||||
install_script:
|
|
||||||
- pkg update -f
|
|
||||||
- pkg install -y go
|
|
||||||
test_script:
|
|
||||||
# run tests as user "cirrus" instead of root
|
|
||||||
- pw useradd cirrus -m
|
|
||||||
- chown -R cirrus:cirrus .
|
|
||||||
- FSNOTIFY_BUFFER=4096 sudo --preserve-env=FSNOTIFY_BUFFER -u cirrus go test -parallel 1 -race ./...
|
|
||||||
- sudo --preserve-env=FSNOTIFY_BUFFER -u cirrus go test -parallel 1 -race ./...
|
|
||||||
- FSNOTIFY_DEBUG=1 sudo --preserve-env=FSNOTIFY_BUFFER -u cirrus go test -parallel 1 -race -v ./...
|
|
||||||
-10
@@ -1,10 +0,0 @@
|
|||||||
# go test -c output
|
|
||||||
*.test
|
|
||||||
*.test.exe
|
|
||||||
|
|
||||||
# Output of go build ./cmd/fsnotify
|
|
||||||
/fsnotify
|
|
||||||
/fsnotify.exe
|
|
||||||
|
|
||||||
/test/kqueue
|
|
||||||
/test/a.out
|
|
||||||
-2
@@ -1,2 +0,0 @@
|
|||||||
Chris Howey <howeyc@gmail.com> <chris@howey.me>
|
|
||||||
Nathan Youngman <git@nathany.com> <4566+nathany@users.noreply.github.com>
|
|
||||||
-602
@@ -1,602 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
1.9.0 2024-04-04
|
|
||||||
----------------
|
|
||||||
|
|
||||||
### Changes and fixes
|
|
||||||
|
|
||||||
- all: make BufferedWatcher buffered again ([#657])
|
|
||||||
|
|
||||||
- inotify: fix race when adding/removing watches while a watched path is being
|
|
||||||
deleted ([#678], [#686])
|
|
||||||
|
|
||||||
- inotify: don't send empty event if a watched path is unmounted ([#655])
|
|
||||||
|
|
||||||
- inotify: don't register duplicate watches when watching both a symlink and its
|
|
||||||
target; previously that would get "half-added" and removing the second would
|
|
||||||
panic ([#679])
|
|
||||||
|
|
||||||
- kqueue: fix watching relative symlinks ([#681])
|
|
||||||
|
|
||||||
- kqueue: correctly mark pre-existing entries when watching a link to a dir on
|
|
||||||
kqueue ([#682])
|
|
||||||
|
|
||||||
- illumos: don't send error if changed file is deleted while processing the
|
|
||||||
event ([#678])
|
|
||||||
|
|
||||||
|
|
||||||
[#657]: https://github.com/fsnotify/fsnotify/pull/657
|
|
||||||
[#678]: https://github.com/fsnotify/fsnotify/pull/678
|
|
||||||
[#686]: https://github.com/fsnotify/fsnotify/pull/686
|
|
||||||
[#655]: https://github.com/fsnotify/fsnotify/pull/655
|
|
||||||
[#681]: https://github.com/fsnotify/fsnotify/pull/681
|
|
||||||
[#679]: https://github.com/fsnotify/fsnotify/pull/679
|
|
||||||
[#682]: https://github.com/fsnotify/fsnotify/pull/682
|
|
||||||
|
|
||||||
1.8.0 2024-10-31
|
|
||||||
----------------
|
|
||||||
|
|
||||||
### Additions
|
|
||||||
|
|
||||||
- all: add `FSNOTIFY_DEBUG` to print debug logs to stderr ([#619])
|
|
||||||
|
|
||||||
### Changes and fixes
|
|
||||||
|
|
||||||
- windows: fix behaviour of `WatchList()` to be consistent with other platforms ([#610])
|
|
||||||
|
|
||||||
- kqueue: ignore events with Ident=0 ([#590])
|
|
||||||
|
|
||||||
- kqueue: set O_CLOEXEC to prevent passing file descriptors to children ([#617])
|
|
||||||
|
|
||||||
- kqueue: emit events as "/path/dir/file" instead of "path/link/file" when watching a symlink ([#625])
|
|
||||||
|
|
||||||
- inotify: don't send event for IN_DELETE_SELF when also watching the parent ([#620])
|
|
||||||
|
|
||||||
- inotify: fix panic when calling Remove() in a goroutine ([#650])
|
|
||||||
|
|
||||||
- fen: allow watching subdirectories of watched directories ([#621])
|
|
||||||
|
|
||||||
[#590]: https://github.com/fsnotify/fsnotify/pull/590
|
|
||||||
[#610]: https://github.com/fsnotify/fsnotify/pull/610
|
|
||||||
[#617]: https://github.com/fsnotify/fsnotify/pull/617
|
|
||||||
[#619]: https://github.com/fsnotify/fsnotify/pull/619
|
|
||||||
[#620]: https://github.com/fsnotify/fsnotify/pull/620
|
|
||||||
[#621]: https://github.com/fsnotify/fsnotify/pull/621
|
|
||||||
[#625]: https://github.com/fsnotify/fsnotify/pull/625
|
|
||||||
[#650]: https://github.com/fsnotify/fsnotify/pull/650
|
|
||||||
|
|
||||||
1.7.0 - 2023-10-22
|
|
||||||
------------------
|
|
||||||
This version of fsnotify needs Go 1.17.
|
|
||||||
|
|
||||||
### Additions
|
|
||||||
|
|
||||||
- illumos: add FEN backend to support illumos and Solaris. ([#371])
|
|
||||||
|
|
||||||
- all: add `NewBufferedWatcher()` to use a buffered channel, which can be useful
|
|
||||||
in cases where you can't control the kernel buffer and receive a large number
|
|
||||||
of events in bursts. ([#550], [#572])
|
|
||||||
|
|
||||||
- all: add `AddWith()`, which is identical to `Add()` but allows passing
|
|
||||||
options. ([#521])
|
|
||||||
|
|
||||||
- windows: allow setting the ReadDirectoryChangesW() buffer size with
|
|
||||||
`fsnotify.WithBufferSize()`; the default of 64K is the highest value that
|
|
||||||
works on all platforms and is enough for most purposes, but in some cases a
|
|
||||||
highest buffer is needed. ([#521])
|
|
||||||
|
|
||||||
### Changes and fixes
|
|
||||||
|
|
||||||
- inotify: remove watcher if a watched path is renamed ([#518])
|
|
||||||
|
|
||||||
After a rename the reported name wasn't updated, or even an empty string.
|
|
||||||
Inotify doesn't provide any good facilities to update it, so just remove the
|
|
||||||
watcher. This is already how it worked on kqueue and FEN.
|
|
||||||
|
|
||||||
On Windows this does work, and remains working.
|
|
||||||
|
|
||||||
- windows: don't listen for file attribute changes ([#520])
|
|
||||||
|
|
||||||
File attribute changes are sent as `FILE_ACTION_MODIFIED` by the Windows API,
|
|
||||||
with no way to see if they're a file write or attribute change, so would show
|
|
||||||
up as a fsnotify.Write event. This is never useful, and could result in many
|
|
||||||
spurious Write events.
|
|
||||||
|
|
||||||
- windows: return `ErrEventOverflow` if the buffer is full ([#525])
|
|
||||||
|
|
||||||
Before it would merely return "short read", making it hard to detect this
|
|
||||||
error.
|
|
||||||
|
|
||||||
- kqueue: make sure events for all files are delivered properly when removing a
|
|
||||||
watched directory ([#526])
|
|
||||||
|
|
||||||
Previously they would get sent with `""` (empty string) or `"."` as the path
|
|
||||||
name.
|
|
||||||
|
|
||||||
- kqueue: don't emit spurious Create events for symbolic links ([#524])
|
|
||||||
|
|
||||||
The link would get resolved but kqueue would "forget" it already saw the link
|
|
||||||
itself, resulting on a Create for every Write event for the directory.
|
|
||||||
|
|
||||||
- all: return `ErrClosed` on `Add()` when the watcher is closed ([#516])
|
|
||||||
|
|
||||||
- other: add `Watcher.Errors` and `Watcher.Events` to the no-op `Watcher` in
|
|
||||||
`backend_other.go`, making it easier to use on unsupported platforms such as
|
|
||||||
WASM, AIX, etc. ([#528])
|
|
||||||
|
|
||||||
- other: use the `backend_other.go` no-op if the `appengine` build tag is set;
|
|
||||||
Google AppEngine forbids usage of the unsafe package so the inotify backend
|
|
||||||
won't compile there.
|
|
||||||
|
|
||||||
[#371]: https://github.com/fsnotify/fsnotify/pull/371
|
|
||||||
[#516]: https://github.com/fsnotify/fsnotify/pull/516
|
|
||||||
[#518]: https://github.com/fsnotify/fsnotify/pull/518
|
|
||||||
[#520]: https://github.com/fsnotify/fsnotify/pull/520
|
|
||||||
[#521]: https://github.com/fsnotify/fsnotify/pull/521
|
|
||||||
[#524]: https://github.com/fsnotify/fsnotify/pull/524
|
|
||||||
[#525]: https://github.com/fsnotify/fsnotify/pull/525
|
|
||||||
[#526]: https://github.com/fsnotify/fsnotify/pull/526
|
|
||||||
[#528]: https://github.com/fsnotify/fsnotify/pull/528
|
|
||||||
[#537]: https://github.com/fsnotify/fsnotify/pull/537
|
|
||||||
[#550]: https://github.com/fsnotify/fsnotify/pull/550
|
|
||||||
[#572]: https://github.com/fsnotify/fsnotify/pull/572
|
|
||||||
|
|
||||||
1.6.0 - 2022-10-13
|
|
||||||
------------------
|
|
||||||
This version of fsnotify needs Go 1.16 (this was already the case since 1.5.1,
|
|
||||||
but not documented). It also increases the minimum Linux version to 2.6.32.
|
|
||||||
|
|
||||||
### Additions
|
|
||||||
|
|
||||||
- all: add `Event.Has()` and `Op.Has()` ([#477])
|
|
||||||
|
|
||||||
This makes checking events a lot easier; for example:
|
|
||||||
|
|
||||||
if event.Op&Write == Write && !(event.Op&Remove == Remove) {
|
|
||||||
}
|
|
||||||
|
|
||||||
Becomes:
|
|
||||||
|
|
||||||
if event.Has(Write) && !event.Has(Remove) {
|
|
||||||
}
|
|
||||||
|
|
||||||
- all: add cmd/fsnotify ([#463])
|
|
||||||
|
|
||||||
A command-line utility for testing and some examples.
|
|
||||||
|
|
||||||
### Changes and fixes
|
|
||||||
|
|
||||||
- inotify: don't ignore events for files that don't exist ([#260], [#470])
|
|
||||||
|
|
||||||
Previously the inotify watcher would call `os.Lstat()` to check if a file
|
|
||||||
still exists before emitting events.
|
|
||||||
|
|
||||||
This was inconsistent with other platforms and resulted in inconsistent event
|
|
||||||
reporting (e.g. when a file is quickly removed and re-created), and generally
|
|
||||||
a source of confusion. It was added in 2013 to fix a memory leak that no
|
|
||||||
longer exists.
|
|
||||||
|
|
||||||
- all: return `ErrNonExistentWatch` when `Remove()` is called on a path that's
|
|
||||||
not watched ([#460])
|
|
||||||
|
|
||||||
- inotify: replace epoll() with non-blocking inotify ([#434])
|
|
||||||
|
|
||||||
Non-blocking inotify was not generally available at the time this library was
|
|
||||||
written in 2014, but now it is. As a result, the minimum Linux version is
|
|
||||||
bumped from 2.6.27 to 2.6.32. This hugely simplifies the code and is faster.
|
|
||||||
|
|
||||||
- kqueue: don't check for events every 100ms ([#480])
|
|
||||||
|
|
||||||
The watcher would wake up every 100ms, even when there was nothing to do. Now
|
|
||||||
it waits until there is something to do.
|
|
||||||
|
|
||||||
- macos: retry opening files on EINTR ([#475])
|
|
||||||
|
|
||||||
- kqueue: skip unreadable files ([#479])
|
|
||||||
|
|
||||||
kqueue requires a file descriptor for every file in a directory; this would
|
|
||||||
fail if a file was unreadable by the current user. Now these files are simply
|
|
||||||
skipped.
|
|
||||||
|
|
||||||
- windows: fix renaming a watched directory if the parent is also watched ([#370])
|
|
||||||
|
|
||||||
- windows: increase buffer size from 4K to 64K ([#485])
|
|
||||||
|
|
||||||
- windows: close file handle on Remove() ([#288])
|
|
||||||
|
|
||||||
- kqueue: put pathname in the error if watching a file fails ([#471])
|
|
||||||
|
|
||||||
- inotify, windows: calling Close() more than once could race ([#465])
|
|
||||||
|
|
||||||
- kqueue: improve Close() performance ([#233])
|
|
||||||
|
|
||||||
- all: various documentation additions and clarifications.
|
|
||||||
|
|
||||||
[#233]: https://github.com/fsnotify/fsnotify/pull/233
|
|
||||||
[#260]: https://github.com/fsnotify/fsnotify/pull/260
|
|
||||||
[#288]: https://github.com/fsnotify/fsnotify/pull/288
|
|
||||||
[#370]: https://github.com/fsnotify/fsnotify/pull/370
|
|
||||||
[#434]: https://github.com/fsnotify/fsnotify/pull/434
|
|
||||||
[#460]: https://github.com/fsnotify/fsnotify/pull/460
|
|
||||||
[#463]: https://github.com/fsnotify/fsnotify/pull/463
|
|
||||||
[#465]: https://github.com/fsnotify/fsnotify/pull/465
|
|
||||||
[#470]: https://github.com/fsnotify/fsnotify/pull/470
|
|
||||||
[#471]: https://github.com/fsnotify/fsnotify/pull/471
|
|
||||||
[#475]: https://github.com/fsnotify/fsnotify/pull/475
|
|
||||||
[#477]: https://github.com/fsnotify/fsnotify/pull/477
|
|
||||||
[#479]: https://github.com/fsnotify/fsnotify/pull/479
|
|
||||||
[#480]: https://github.com/fsnotify/fsnotify/pull/480
|
|
||||||
[#485]: https://github.com/fsnotify/fsnotify/pull/485
|
|
||||||
|
|
||||||
## [1.5.4] - 2022-04-25
|
|
||||||
|
|
||||||
* Windows: add missing defer to `Watcher.WatchList` [#447](https://github.com/fsnotify/fsnotify/pull/447)
|
|
||||||
* go.mod: use latest x/sys [#444](https://github.com/fsnotify/fsnotify/pull/444)
|
|
||||||
* Fix compilation for OpenBSD [#443](https://github.com/fsnotify/fsnotify/pull/443)
|
|
||||||
|
|
||||||
## [1.5.3] - 2022-04-22
|
|
||||||
|
|
||||||
* This version is retracted. An incorrect branch is published accidentally [#445](https://github.com/fsnotify/fsnotify/issues/445)
|
|
||||||
|
|
||||||
## [1.5.2] - 2022-04-21
|
|
||||||
|
|
||||||
* Add a feature to return the directories and files that are being monitored [#374](https://github.com/fsnotify/fsnotify/pull/374)
|
|
||||||
* Fix potential crash on windows if `raw.FileNameLength` exceeds `syscall.MAX_PATH` [#361](https://github.com/fsnotify/fsnotify/pull/361)
|
|
||||||
* Allow build on unsupported GOOS [#424](https://github.com/fsnotify/fsnotify/pull/424)
|
|
||||||
* Don't set `poller.fd` twice in `newFdPoller` [#406](https://github.com/fsnotify/fsnotify/pull/406)
|
|
||||||
* fix go vet warnings: call to `(*T).Fatalf` from a non-test goroutine [#416](https://github.com/fsnotify/fsnotify/pull/416)
|
|
||||||
|
|
||||||
## [1.5.1] - 2021-08-24
|
|
||||||
|
|
||||||
* Revert Add AddRaw to not follow symlinks [#394](https://github.com/fsnotify/fsnotify/pull/394)
|
|
||||||
|
|
||||||
## [1.5.0] - 2021-08-20
|
|
||||||
|
|
||||||
* Go: Increase minimum required version to Go 1.12 [#381](https://github.com/fsnotify/fsnotify/pull/381)
|
|
||||||
* Feature: Add AddRaw method which does not follow symlinks when adding a watch [#289](https://github.com/fsnotify/fsnotify/pull/298)
|
|
||||||
* Windows: Follow symlinks by default like on all other systems [#289](https://github.com/fsnotify/fsnotify/pull/289)
|
|
||||||
* CI: Use GitHub Actions for CI and cover go 1.12-1.17
|
|
||||||
[#378](https://github.com/fsnotify/fsnotify/pull/378)
|
|
||||||
[#381](https://github.com/fsnotify/fsnotify/pull/381)
|
|
||||||
[#385](https://github.com/fsnotify/fsnotify/pull/385)
|
|
||||||
* Go 1.14+: Fix unsafe pointer conversion [#325](https://github.com/fsnotify/fsnotify/pull/325)
|
|
||||||
|
|
||||||
## [1.4.9] - 2020-03-11
|
|
||||||
|
|
||||||
* Move example usage to the readme #329. This may resolve #328.
|
|
||||||
|
|
||||||
## [1.4.8] - 2020-03-10
|
|
||||||
|
|
||||||
* CI: test more go versions (@nathany 1d13583d846ea9d66dcabbfefbfb9d8e6fb05216)
|
|
||||||
* Tests: Queued inotify events could have been read by the test before max_queued_events was hit (@matthias-stone #265)
|
|
||||||
* Tests: t.Fatalf -> t.Errorf in go routines (@gdey #266)
|
|
||||||
* CI: Less verbosity (@nathany #267)
|
|
||||||
* Tests: Darwin: Exchangedata is deprecated on 10.13 (@nathany #267)
|
|
||||||
* Tests: Check if channels are closed in the example (@alexeykazakov #244)
|
|
||||||
* CI: Only run golint on latest version of go and fix issues (@cpuguy83 #284)
|
|
||||||
* CI: Add windows to travis matrix (@cpuguy83 #284)
|
|
||||||
* Docs: Remover appveyor badge (@nathany 11844c0959f6fff69ba325d097fce35bd85a8e93)
|
|
||||||
* Linux: create epoll and pipe fds with close-on-exec (@JohannesEbke #219)
|
|
||||||
* Linux: open files with close-on-exec (@linxiulei #273)
|
|
||||||
* Docs: Plan to support fanotify (@nathany ab058b44498e8b7566a799372a39d150d9ea0119 )
|
|
||||||
* Project: Add go.mod (@nathany #309)
|
|
||||||
* Project: Revise editor config (@nathany #309)
|
|
||||||
* Project: Update copyright for 2019 (@nathany #309)
|
|
||||||
* CI: Drop go1.8 from CI matrix (@nathany #309)
|
|
||||||
* Docs: Updating the FAQ section for supportability with NFS & FUSE filesystems (@Pratik32 4bf2d1fec78374803a39307bfb8d340688f4f28e )
|
|
||||||
|
|
||||||
## [1.4.7] - 2018-01-09
|
|
||||||
|
|
||||||
* BSD/macOS: Fix possible deadlock on closing the watcher on kqueue (thanks @nhooyr and @glycerine)
|
|
||||||
* Tests: Fix missing verb on format string (thanks @rchiossi)
|
|
||||||
* Linux: Fix deadlock in Remove (thanks @aarondl)
|
|
||||||
* Linux: Watch.Add improvements (avoid race, fix consistency, reduce garbage) (thanks @twpayne)
|
|
||||||
* Docs: Moved FAQ into the README (thanks @vahe)
|
|
||||||
* Linux: Properly handle inotify's IN_Q_OVERFLOW event (thanks @zeldovich)
|
|
||||||
* Docs: replace references to OS X with macOS
|
|
||||||
|
|
||||||
## [1.4.2] - 2016-10-10
|
|
||||||
|
|
||||||
* Linux: use InotifyInit1 with IN_CLOEXEC to stop leaking a file descriptor to a child process when using fork/exec [#178](https://github.com/fsnotify/fsnotify/pull/178) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## [1.4.1] - 2016-10-04
|
|
||||||
|
|
||||||
* Fix flaky inotify stress test on Linux [#177](https://github.com/fsnotify/fsnotify/pull/177) (thanks @pattyshack)
|
|
||||||
|
|
||||||
## [1.4.0] - 2016-10-01
|
|
||||||
|
|
||||||
* add a String() method to Event.Op [#165](https://github.com/fsnotify/fsnotify/pull/165) (thanks @oozie)
|
|
||||||
|
|
||||||
## [1.3.1] - 2016-06-28
|
|
||||||
|
|
||||||
* Windows: fix for double backslash when watching the root of a drive [#151](https://github.com/fsnotify/fsnotify/issues/151) (thanks @brunoqc)
|
|
||||||
|
|
||||||
## [1.3.0] - 2016-04-19
|
|
||||||
|
|
||||||
* Support linux/arm64 by [patching](https://go-review.googlesource.com/#/c/21971/) x/sys/unix and switching to to it from syscall (thanks @suihkulokki) [#135](https://github.com/fsnotify/fsnotify/pull/135)
|
|
||||||
|
|
||||||
## [1.2.10] - 2016-03-02
|
|
||||||
|
|
||||||
* Fix golint errors in windows.go [#121](https://github.com/fsnotify/fsnotify/pull/121) (thanks @tiffanyfj)
|
|
||||||
|
|
||||||
## [1.2.9] - 2016-01-13
|
|
||||||
|
|
||||||
kqueue: Fix logic for CREATE after REMOVE [#111](https://github.com/fsnotify/fsnotify/pull/111) (thanks @bep)
|
|
||||||
|
|
||||||
## [1.2.8] - 2015-12-17
|
|
||||||
|
|
||||||
* kqueue: fix race condition in Close [#105](https://github.com/fsnotify/fsnotify/pull/105) (thanks @djui for reporting the issue and @ppknap for writing a failing test)
|
|
||||||
* inotify: fix race in test
|
|
||||||
* enable race detection for continuous integration (Linux, Mac, Windows)
|
|
||||||
|
|
||||||
## [1.2.5] - 2015-10-17
|
|
||||||
|
|
||||||
* inotify: use epoll_create1 for arm64 support (requires Linux 2.6.27 or later) [#100](https://github.com/fsnotify/fsnotify/pull/100) (thanks @suihkulokki)
|
|
||||||
* inotify: fix path leaks [#73](https://github.com/fsnotify/fsnotify/pull/73) (thanks @chamaken)
|
|
||||||
* kqueue: watch for rename events on subdirectories [#83](https://github.com/fsnotify/fsnotify/pull/83) (thanks @guotie)
|
|
||||||
* kqueue: avoid infinite loops from symlinks cycles [#101](https://github.com/fsnotify/fsnotify/pull/101) (thanks @illicitonion)
|
|
||||||
|
|
||||||
## [1.2.1] - 2015-10-14
|
|
||||||
|
|
||||||
* kqueue: don't watch named pipes [#98](https://github.com/fsnotify/fsnotify/pull/98) (thanks @evanphx)
|
|
||||||
|
|
||||||
## [1.2.0] - 2015-02-08
|
|
||||||
|
|
||||||
* inotify: use epoll to wake up readEvents [#66](https://github.com/fsnotify/fsnotify/pull/66) (thanks @PieterD)
|
|
||||||
* inotify: closing watcher should now always shut down goroutine [#63](https://github.com/fsnotify/fsnotify/pull/63) (thanks @PieterD)
|
|
||||||
* kqueue: close kqueue after removing watches, fixes [#59](https://github.com/fsnotify/fsnotify/issues/59)
|
|
||||||
|
|
||||||
## [1.1.1] - 2015-02-05
|
|
||||||
|
|
||||||
* inotify: Retry read on EINTR [#61](https://github.com/fsnotify/fsnotify/issues/61) (thanks @PieterD)
|
|
||||||
|
|
||||||
## [1.1.0] - 2014-12-12
|
|
||||||
|
|
||||||
* kqueue: rework internals [#43](https://github.com/fsnotify/fsnotify/pull/43)
|
|
||||||
* add low-level functions
|
|
||||||
* only need to store flags on directories
|
|
||||||
* less mutexes [#13](https://github.com/fsnotify/fsnotify/issues/13)
|
|
||||||
* done can be an unbuffered channel
|
|
||||||
* remove calls to os.NewSyscallError
|
|
||||||
* More efficient string concatenation for Event.String() [#52](https://github.com/fsnotify/fsnotify/pull/52) (thanks @mdlayher)
|
|
||||||
* kqueue: fix regression in rework causing subdirectories to be watched [#48](https://github.com/fsnotify/fsnotify/issues/48)
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## [1.0.4] - 2014-09-07
|
|
||||||
|
|
||||||
* kqueue: add dragonfly to the build tags.
|
|
||||||
* Rename source code files, rearrange code so exported APIs are at the top.
|
|
||||||
* Add done channel to example code. [#37](https://github.com/fsnotify/fsnotify/pull/37) (thanks @chenyukang)
|
|
||||||
|
|
||||||
## [1.0.3] - 2014-08-19
|
|
||||||
|
|
||||||
* [Fix] Windows MOVED_TO now translates to Create like on BSD and Linux. [#36](https://github.com/fsnotify/fsnotify/issues/36)
|
|
||||||
|
|
||||||
## [1.0.2] - 2014-08-17
|
|
||||||
|
|
||||||
* [Fix] Missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
* [Fix] Make ./path and path equivalent. (thanks @zhsso)
|
|
||||||
|
|
||||||
## [1.0.0] - 2014-08-15
|
|
||||||
|
|
||||||
* [API] Remove AddWatch on Windows, use Add.
|
|
||||||
* Improve documentation for exported identifiers. [#30](https://github.com/fsnotify/fsnotify/issues/30)
|
|
||||||
* Minor updates based on feedback from golint.
|
|
||||||
|
|
||||||
## dev / 2014-07-09
|
|
||||||
|
|
||||||
* Moved to [github.com/fsnotify/fsnotify](https://github.com/fsnotify/fsnotify).
|
|
||||||
* Use os.NewSyscallError instead of returning errno (thanks @hariharan-uno)
|
|
||||||
|
|
||||||
## dev / 2014-07-04
|
|
||||||
|
|
||||||
* kqueue: fix incorrect mutex used in Close()
|
|
||||||
* Update example to demonstrate usage of Op.
|
|
||||||
|
|
||||||
## dev / 2014-06-28
|
|
||||||
|
|
||||||
* [API] Don't set the Write Op for attribute notifications [#4](https://github.com/fsnotify/fsnotify/issues/4)
|
|
||||||
* Fix for String() method on Event (thanks Alex Brainman)
|
|
||||||
* Don't build on Plan 9 or Solaris (thanks @4ad)
|
|
||||||
|
|
||||||
## dev / 2014-06-21
|
|
||||||
|
|
||||||
* Events channel of type Event rather than *Event.
|
|
||||||
* [internal] use syscall constants directly for inotify and kqueue.
|
|
||||||
* [internal] kqueue: rename events to kevents and fileEvent to event.
|
|
||||||
|
|
||||||
## dev / 2014-06-19
|
|
||||||
|
|
||||||
* Go 1.3+ required on Windows (uses syscall.ERROR_MORE_DATA internally).
|
|
||||||
* [internal] remove cookie from Event struct (unused).
|
|
||||||
* [internal] Event struct has the same definition across every OS.
|
|
||||||
* [internal] remove internal watch and removeWatch methods.
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* [API] Renamed Watch() to Add() and RemoveWatch() to Remove().
|
|
||||||
* [API] Pluralized channel names: Events and Errors.
|
|
||||||
* [API] Renamed FileEvent struct to Event.
|
|
||||||
* [API] Op constants replace methods like IsCreate().
|
|
||||||
|
|
||||||
## dev / 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## dev / 2014-05-23
|
|
||||||
|
|
||||||
* [API] Remove current implementation of WatchFlags.
|
|
||||||
* current implementation doesn't take advantage of OS for efficiency
|
|
||||||
* provides little benefit over filtering events as they are received, but has extra bookkeeping and mutexes
|
|
||||||
* no tests for the current implementation
|
|
||||||
* not fully implemented on Windows [#93](https://github.com/howeyc/fsnotify/issues/93#issuecomment-39285195)
|
|
||||||
|
|
||||||
## [0.9.3] - 2014-12-31
|
|
||||||
|
|
||||||
* kqueue: cleanup internal watch before sending remove event [#51](https://github.com/fsnotify/fsnotify/issues/51)
|
|
||||||
|
|
||||||
## [0.9.2] - 2014-08-17
|
|
||||||
|
|
||||||
* [Backport] Fix missing create events on macOS. [#14](https://github.com/fsnotify/fsnotify/issues/14) (thanks @zhsso)
|
|
||||||
|
|
||||||
## [0.9.1] - 2014-06-12
|
|
||||||
|
|
||||||
* Fix data race on kevent buffer (thanks @tilaks) [#98](https://github.com/howeyc/fsnotify/pull/98)
|
|
||||||
|
|
||||||
## [0.9.0] - 2014-01-17
|
|
||||||
|
|
||||||
* IsAttrib() for events that only concern a file's metadata [#79][] (thanks @abustany)
|
|
||||||
* [Fix] kqueue: fix deadlock [#77][] (thanks @cespare)
|
|
||||||
* [NOTICE] Development has moved to `code.google.com/p/go.exp/fsnotify` in preparation for inclusion in the Go standard library.
|
|
||||||
|
|
||||||
## [0.8.12] - 2013-11-13
|
|
||||||
|
|
||||||
* [API] Remove FD_SET and friends from Linux adapter
|
|
||||||
|
|
||||||
## [0.8.11] - 2013-11-02
|
|
||||||
|
|
||||||
* [Doc] Add Changelog [#72][] (thanks @nathany)
|
|
||||||
* [Doc] Spotlight and double modify events on macOS [#62][] (reported by @paulhammond)
|
|
||||||
|
|
||||||
## [0.8.10] - 2013-10-19
|
|
||||||
|
|
||||||
* [Fix] kqueue: remove file watches when parent directory is removed [#71][] (reported by @mdwhatcott)
|
|
||||||
* [Fix] kqueue: race between Close and readEvents [#70][] (reported by @bernerdschaefer)
|
|
||||||
* [Doc] specify OS-specific limits in README (thanks @debrando)
|
|
||||||
|
|
||||||
## [0.8.9] - 2013-09-08
|
|
||||||
|
|
||||||
* [Doc] Contributing (thanks @nathany)
|
|
||||||
* [Doc] update package path in example code [#63][] (thanks @paulhammond)
|
|
||||||
* [Doc] GoCI badge in README (Linux only) [#60][]
|
|
||||||
* [Doc] Cross-platform testing with Vagrant [#59][] (thanks @nathany)
|
|
||||||
|
|
||||||
## [0.8.8] - 2013-06-17
|
|
||||||
|
|
||||||
* [Fix] Windows: handle `ERROR_MORE_DATA` on Windows [#49][] (thanks @jbowtie)
|
|
||||||
|
|
||||||
## [0.8.7] - 2013-06-03
|
|
||||||
|
|
||||||
* [API] Make syscall flags internal
|
|
||||||
* [Fix] inotify: ignore event changes
|
|
||||||
* [Fix] race in symlink test [#45][] (reported by @srid)
|
|
||||||
* [Fix] tests on Windows
|
|
||||||
* lower case error messages
|
|
||||||
|
|
||||||
## [0.8.6] - 2013-05-23
|
|
||||||
|
|
||||||
* kqueue: Use EVT_ONLY flag on Darwin
|
|
||||||
* [Doc] Update README with full example
|
|
||||||
|
|
||||||
## [0.8.5] - 2013-05-09
|
|
||||||
|
|
||||||
* [Fix] inotify: allow monitoring of "broken" symlinks (thanks @tsg)
|
|
||||||
|
|
||||||
## [0.8.4] - 2013-04-07
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch all file events [#40][] (thanks @ChrisBuchholz)
|
|
||||||
|
|
||||||
## [0.8.3] - 2013-03-13
|
|
||||||
|
|
||||||
* [Fix] inoitfy/kqueue memory leak [#36][] (reported by @nbkolchin)
|
|
||||||
* [Fix] kqueue: use fsnFlags for watching a directory [#33][] (reported by @nbkolchin)
|
|
||||||
|
|
||||||
## [0.8.2] - 2013-02-07
|
|
||||||
|
|
||||||
* [Doc] add Authors
|
|
||||||
* [Fix] fix data races for map access [#29][] (thanks @fsouza)
|
|
||||||
|
|
||||||
## [0.8.1] - 2013-01-09
|
|
||||||
|
|
||||||
* [Fix] Windows path separators
|
|
||||||
* [Doc] BSD License
|
|
||||||
|
|
||||||
## [0.8.0] - 2012-11-09
|
|
||||||
|
|
||||||
* kqueue: directory watching improvements (thanks @vmirage)
|
|
||||||
* inotify: add `IN_MOVED_TO` [#25][] (requested by @cpisto)
|
|
||||||
* [Fix] kqueue: deleting watched directory [#24][] (reported by @jakerr)
|
|
||||||
|
|
||||||
## [0.7.4] - 2012-10-09
|
|
||||||
|
|
||||||
* [Fix] inotify: fixes from https://codereview.appspot.com/5418045/ (ugorji)
|
|
||||||
* [Fix] kqueue: preserve watch flags when watching for delete [#21][] (reported by @robfig)
|
|
||||||
* [Fix] kqueue: watch the directory even if it isn't a new watch (thanks @robfig)
|
|
||||||
* [Fix] kqueue: modify after recreation of file
|
|
||||||
|
|
||||||
## [0.7.3] - 2012-09-27
|
|
||||||
|
|
||||||
* [Fix] kqueue: watch with an existing folder inside the watched folder (thanks @vmirage)
|
|
||||||
* [Fix] kqueue: no longer get duplicate CREATE events
|
|
||||||
|
|
||||||
## [0.7.2] - 2012-09-01
|
|
||||||
|
|
||||||
* kqueue: events for created directories
|
|
||||||
|
|
||||||
## [0.7.1] - 2012-07-14
|
|
||||||
|
|
||||||
* [Fix] for renaming files
|
|
||||||
|
|
||||||
## [0.7.0] - 2012-07-02
|
|
||||||
|
|
||||||
* [Feature] FSNotify flags
|
|
||||||
* [Fix] inotify: Added file name back to event path
|
|
||||||
|
|
||||||
## [0.6.0] - 2012-06-06
|
|
||||||
|
|
||||||
* kqueue: watch files after directory created (thanks @tmc)
|
|
||||||
|
|
||||||
## [0.5.1] - 2012-05-22
|
|
||||||
|
|
||||||
* [Fix] inotify: remove all watches before Close()
|
|
||||||
|
|
||||||
## [0.5.0] - 2012-05-03
|
|
||||||
|
|
||||||
* [API] kqueue: return errors during watch instead of sending over channel
|
|
||||||
* kqueue: match symlink behavior on Linux
|
|
||||||
* inotify: add `DELETE_SELF` (requested by @taralx)
|
|
||||||
* [Fix] kqueue: handle EINTR (reported by @robfig)
|
|
||||||
* [Doc] Godoc example [#1][] (thanks @davecheney)
|
|
||||||
|
|
||||||
## [0.4.0] - 2012-03-30
|
|
||||||
|
|
||||||
* Go 1 released: build with go tool
|
|
||||||
* [Feature] Windows support using winfsnotify
|
|
||||||
* Windows does not have attribute change notifications
|
|
||||||
* Roll attribute notifications into IsModify
|
|
||||||
|
|
||||||
## [0.3.0] - 2012-02-19
|
|
||||||
|
|
||||||
* kqueue: add files when watch directory
|
|
||||||
|
|
||||||
## [0.2.0] - 2011-12-30
|
|
||||||
|
|
||||||
* update to latest Go weekly code
|
|
||||||
|
|
||||||
## [0.1.0] - 2011-10-19
|
|
||||||
|
|
||||||
* kqueue: add watch on file creation to match inotify
|
|
||||||
* kqueue: create file event
|
|
||||||
* inotify: ignore `IN_IGNORED` events
|
|
||||||
* event String()
|
|
||||||
* linux: common FileEvent functions
|
|
||||||
* initial commit
|
|
||||||
|
|
||||||
[#79]: https://github.com/howeyc/fsnotify/pull/79
|
|
||||||
[#77]: https://github.com/howeyc/fsnotify/pull/77
|
|
||||||
[#72]: https://github.com/howeyc/fsnotify/issues/72
|
|
||||||
[#71]: https://github.com/howeyc/fsnotify/issues/71
|
|
||||||
[#70]: https://github.com/howeyc/fsnotify/issues/70
|
|
||||||
[#63]: https://github.com/howeyc/fsnotify/issues/63
|
|
||||||
[#62]: https://github.com/howeyc/fsnotify/issues/62
|
|
||||||
[#60]: https://github.com/howeyc/fsnotify/issues/60
|
|
||||||
[#59]: https://github.com/howeyc/fsnotify/issues/59
|
|
||||||
[#49]: https://github.com/howeyc/fsnotify/issues/49
|
|
||||||
[#45]: https://github.com/howeyc/fsnotify/issues/45
|
|
||||||
[#40]: https://github.com/howeyc/fsnotify/issues/40
|
|
||||||
[#36]: https://github.com/howeyc/fsnotify/issues/36
|
|
||||||
[#33]: https://github.com/howeyc/fsnotify/issues/33
|
|
||||||
[#29]: https://github.com/howeyc/fsnotify/issues/29
|
|
||||||
[#25]: https://github.com/howeyc/fsnotify/issues/25
|
|
||||||
[#24]: https://github.com/howeyc/fsnotify/issues/24
|
|
||||||
[#21]: https://github.com/howeyc/fsnotify/issues/21
|
|
||||||
-145
@@ -1,145 +0,0 @@
|
|||||||
Thank you for your interest in contributing to fsnotify! We try to review and
|
|
||||||
merge PRs in a reasonable timeframe, but please be aware that:
|
|
||||||
|
|
||||||
- To avoid "wasted" work, please discuss changes on the issue tracker first. You
|
|
||||||
can just send PRs, but they may end up being rejected for one reason or the
|
|
||||||
other.
|
|
||||||
|
|
||||||
- fsnotify is a cross-platform library, and changes must work reasonably well on
|
|
||||||
all supported platforms.
|
|
||||||
|
|
||||||
- Changes will need to be compatible; old code should still compile, and the
|
|
||||||
runtime behaviour can't change in ways that are likely to lead to problems for
|
|
||||||
users.
|
|
||||||
|
|
||||||
Testing
|
|
||||||
-------
|
|
||||||
Just `go test ./...` runs all the tests; the CI runs this on all supported
|
|
||||||
platforms. Testing different platforms locally can be done with something like
|
|
||||||
[goon] or [Vagrant], but this isn't super-easy to set up at the moment.
|
|
||||||
|
|
||||||
Use the `-short` flag to make the "stress test" run faster.
|
|
||||||
|
|
||||||
Writing new tests
|
|
||||||
-----------------
|
|
||||||
Scripts in the testdata directory allow creating test cases in a "shell-like"
|
|
||||||
syntax. The basic format is:
|
|
||||||
|
|
||||||
script
|
|
||||||
|
|
||||||
Output:
|
|
||||||
desired output
|
|
||||||
|
|
||||||
For example:
|
|
||||||
|
|
||||||
# Create a new empty file with some data.
|
|
||||||
watch /
|
|
||||||
echo data >/file
|
|
||||||
|
|
||||||
Output:
|
|
||||||
create /file
|
|
||||||
write /file
|
|
||||||
|
|
||||||
Just create a new file to add a new test; select which tests to run with
|
|
||||||
`-run TestScript/[path]`.
|
|
||||||
|
|
||||||
script
|
|
||||||
------
|
|
||||||
The script is a "shell-like" script:
|
|
||||||
|
|
||||||
cmd arg arg
|
|
||||||
|
|
||||||
Comments are supported with `#`:
|
|
||||||
|
|
||||||
# Comment
|
|
||||||
cmd arg arg # Comment
|
|
||||||
|
|
||||||
All operations are done in a temp directory; a path like "/foo" is rewritten to
|
|
||||||
"/tmp/TestFoo/foo".
|
|
||||||
|
|
||||||
Arguments can be quoted with `"` or `'`; there are no escapes and they're
|
|
||||||
functionally identical right now, but this may change in the future, so best to
|
|
||||||
assume shell-like rules.
|
|
||||||
|
|
||||||
touch "/file with spaces"
|
|
||||||
|
|
||||||
End-of-line escapes with `\` are not supported.
|
|
||||||
|
|
||||||
### Supported commands
|
|
||||||
|
|
||||||
watch path [ops] # Watch the path, reporting events for it. Nothing is
|
|
||||||
# watched by default. Optionally a list of ops can be
|
|
||||||
# given, as with AddWith(path, WithOps(...)).
|
|
||||||
unwatch path # Stop watching the path.
|
|
||||||
watchlist n # Assert watchlist length.
|
|
||||||
|
|
||||||
stop # Stop running the script; for debugging.
|
|
||||||
debug [yes/no] # Enable/disable FSNOTIFY_DEBUG (tests are run in
|
|
||||||
parallel by default, so -parallel=1 is probably a good
|
|
||||||
idea).
|
|
||||||
print [any strings] # Print text to stdout; for debugging.
|
|
||||||
|
|
||||||
touch path
|
|
||||||
mkdir [-p] dir
|
|
||||||
ln -s target link # Only ln -s supported.
|
|
||||||
mkfifo path
|
|
||||||
mknod dev path
|
|
||||||
mv src dst
|
|
||||||
rm [-r] path
|
|
||||||
chmod mode path # Octal only
|
|
||||||
sleep time-in-ms
|
|
||||||
|
|
||||||
cat path # Read path (does nothing with the data; just reads it).
|
|
||||||
echo str >>path # Append "str" to "path".
|
|
||||||
echo str >path # Truncate "path" and write "str".
|
|
||||||
|
|
||||||
require reason # Skip the test if "reason" is true; "skip" and
|
|
||||||
skip reason # "require" behave identical; it supports both for
|
|
||||||
# readability. Possible reasons are:
|
|
||||||
#
|
|
||||||
# always Always skip this test.
|
|
||||||
# symlink Symlinks are supported (requires admin
|
|
||||||
# permissions on Windows).
|
|
||||||
# mkfifo Platform doesn't support FIFO named sockets.
|
|
||||||
# mknod Platform doesn't support device nodes.
|
|
||||||
|
|
||||||
|
|
||||||
output
|
|
||||||
------
|
|
||||||
After `Output:` the desired output is given; this is indented by convention, but
|
|
||||||
that's not required.
|
|
||||||
|
|
||||||
The format of that is:
|
|
||||||
|
|
||||||
# Comment
|
|
||||||
event path # Comment
|
|
||||||
|
|
||||||
system:
|
|
||||||
event path
|
|
||||||
system2:
|
|
||||||
event path
|
|
||||||
|
|
||||||
Every event is one line, and any whitespace between the event and path are
|
|
||||||
ignored. The path can optionally be surrounded in ". Anything after a "#" is
|
|
||||||
ignored.
|
|
||||||
|
|
||||||
Platform-specific tests can be added after GOOS; for example:
|
|
||||||
|
|
||||||
watch /
|
|
||||||
touch /file
|
|
||||||
|
|
||||||
Output:
|
|
||||||
# Tested if nothing else matches
|
|
||||||
create /file
|
|
||||||
|
|
||||||
# Windows-specific test.
|
|
||||||
windows:
|
|
||||||
write /file
|
|
||||||
|
|
||||||
You can specify multiple platforms with a comma (e.g. "windows, linux:").
|
|
||||||
"kqueue" is a shortcut for all kqueue systems (BSD, macOS).
|
|
||||||
|
|
||||||
|
|
||||||
[goon]: https://github.com/arp242/goon
|
|
||||||
[Vagrant]: https://www.vagrantup.com/
|
|
||||||
[integration_test.go]: /integration_test.go
|
|
||||||
-25
@@ -1,25 +0,0 @@
|
|||||||
Copyright © 2012 The Go Authors. All rights reserved.
|
|
||||||
Copyright © fsnotify Authors. All rights reserved.
|
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without modification,
|
|
||||||
are permitted provided that the following conditions are met:
|
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright notice, this
|
|
||||||
list of conditions and the following disclaimer.
|
|
||||||
* Redistributions in binary form must reproduce the above copyright notice, this
|
|
||||||
list of conditions and the following disclaimer in the documentation and/or
|
|
||||||
other materials provided with the distribution.
|
|
||||||
* Neither the name of Google Inc. nor the names of its contributors may be used
|
|
||||||
to endorse or promote products derived from this software without specific
|
|
||||||
prior written permission.
|
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
||||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
||||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
||||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
|
||||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
|
||||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
|
||||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
|
||||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
||||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
||||||
-182
@@ -1,182 +0,0 @@
|
|||||||
fsnotify is a Go library to provide cross-platform filesystem notifications on
|
|
||||||
Windows, Linux, macOS, BSD, and illumos.
|
|
||||||
|
|
||||||
Go 1.17 or newer is required; the full documentation is at
|
|
||||||
https://pkg.go.dev/github.com/fsnotify/fsnotify
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
Platform support:
|
|
||||||
|
|
||||||
| Backend | OS | Status |
|
|
||||||
| :-------------------- | :--------- | :------------------------------------------------------------------------ |
|
|
||||||
| inotify | Linux | Supported |
|
|
||||||
| kqueue | BSD, macOS | Supported |
|
|
||||||
| ReadDirectoryChangesW | Windows | Supported |
|
|
||||||
| FEN | illumos | Supported |
|
|
||||||
| fanotify | Linux 5.9+ | [Not yet](https://github.com/fsnotify/fsnotify/issues/114) |
|
|
||||||
| FSEvents | macOS | [Needs support in x/sys/unix][fsevents] |
|
|
||||||
| USN Journals | Windows | [Needs support in x/sys/windows][usn] |
|
|
||||||
| Polling | *All* | [Not yet](https://github.com/fsnotify/fsnotify/issues/9) |
|
|
||||||
|
|
||||||
Linux and illumos should include Android and Solaris, but these are currently
|
|
||||||
untested.
|
|
||||||
|
|
||||||
[fsevents]: https://github.com/fsnotify/fsnotify/issues/11#issuecomment-1279133120
|
|
||||||
[usn]: https://github.com/fsnotify/fsnotify/issues/53#issuecomment-1279829847
|
|
||||||
|
|
||||||
Usage
|
|
||||||
-----
|
|
||||||
A basic example:
|
|
||||||
|
|
||||||
```go
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"log"
|
|
||||||
|
|
||||||
"github.com/fsnotify/fsnotify"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
// Create new watcher.
|
|
||||||
watcher, err := fsnotify.NewWatcher()
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
defer watcher.Close()
|
|
||||||
|
|
||||||
// Start listening for events.
|
|
||||||
go func() {
|
|
||||||
for {
|
|
||||||
select {
|
|
||||||
case event, ok := <-watcher.Events:
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
log.Println("event:", event)
|
|
||||||
if event.Has(fsnotify.Write) {
|
|
||||||
log.Println("modified file:", event.Name)
|
|
||||||
}
|
|
||||||
case err, ok := <-watcher.Errors:
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
log.Println("error:", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
|
|
||||||
// Add a path.
|
|
||||||
err = watcher.Add("/tmp")
|
|
||||||
if err != nil {
|
|
||||||
log.Fatal(err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Block main goroutine forever.
|
|
||||||
<-make(chan struct{})
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Some more examples can be found in [cmd/fsnotify](cmd/fsnotify), which can be
|
|
||||||
run with:
|
|
||||||
|
|
||||||
% go run ./cmd/fsnotify
|
|
||||||
|
|
||||||
Further detailed documentation can be found in godoc:
|
|
||||||
https://pkg.go.dev/github.com/fsnotify/fsnotify
|
|
||||||
|
|
||||||
FAQ
|
|
||||||
---
|
|
||||||
### Will a file still be watched when it's moved to another directory?
|
|
||||||
No, not unless you are watching the location it was moved to.
|
|
||||||
|
|
||||||
### Are subdirectories watched?
|
|
||||||
No, you must add watches for any directory you want to watch (a recursive
|
|
||||||
watcher is on the roadmap: [#18]).
|
|
||||||
|
|
||||||
[#18]: https://github.com/fsnotify/fsnotify/issues/18
|
|
||||||
|
|
||||||
### Do I have to watch the Error and Event channels in a goroutine?
|
|
||||||
Yes. You can read both channels in the same goroutine using `select` (you don't
|
|
||||||
need a separate goroutine for both channels; see the example).
|
|
||||||
|
|
||||||
### Why don't notifications work with NFS, SMB, FUSE, /proc, or /sys?
|
|
||||||
fsnotify requires support from underlying OS to work. The current NFS and SMB
|
|
||||||
protocols does not provide network level support for file notifications, and
|
|
||||||
neither do the /proc and /sys virtual filesystems.
|
|
||||||
|
|
||||||
This could be fixed with a polling watcher ([#9]), but it's not yet implemented.
|
|
||||||
|
|
||||||
[#9]: https://github.com/fsnotify/fsnotify/issues/9
|
|
||||||
|
|
||||||
### Why do I get many Chmod events?
|
|
||||||
Some programs may generate a lot of attribute changes; for example Spotlight on
|
|
||||||
macOS, anti-virus programs, backup applications, and some others are known to do
|
|
||||||
this. As a rule, it's typically best to ignore Chmod events. They're often not
|
|
||||||
useful, and tend to cause problems.
|
|
||||||
|
|
||||||
Spotlight indexing on macOS can result in multiple events (see [#15]). A
|
|
||||||
temporary workaround is to add your folder(s) to the *Spotlight Privacy
|
|
||||||
settings* until we have a native FSEvents implementation (see [#11]).
|
|
||||||
|
|
||||||
[#11]: https://github.com/fsnotify/fsnotify/issues/11
|
|
||||||
[#15]: https://github.com/fsnotify/fsnotify/issues/15
|
|
||||||
|
|
||||||
### Watching a file doesn't work well
|
|
||||||
Watching individual files (rather than directories) is generally not recommended
|
|
||||||
as many programs (especially editors) update files atomically: it will write to
|
|
||||||
a temporary file which is then moved to to destination, overwriting the original
|
|
||||||
(or some variant thereof). The watcher on the original file is now lost, as that
|
|
||||||
no longer exists.
|
|
||||||
|
|
||||||
The upshot of this is that a power failure or crash won't leave a half-written
|
|
||||||
file.
|
|
||||||
|
|
||||||
Watch the parent directory and use `Event.Name` to filter out files you're not
|
|
||||||
interested in. There is an example of this in `cmd/fsnotify/file.go`.
|
|
||||||
|
|
||||||
Platform-specific notes
|
|
||||||
-----------------------
|
|
||||||
### Linux
|
|
||||||
When a file is removed a REMOVE event won't be emitted until all file
|
|
||||||
descriptors are closed; it will emit a CHMOD instead:
|
|
||||||
|
|
||||||
fp := os.Open("file")
|
|
||||||
os.Remove("file") // CHMOD
|
|
||||||
fp.Close() // REMOVE
|
|
||||||
|
|
||||||
This is the event that inotify sends, so not much can be changed about this.
|
|
||||||
|
|
||||||
The `fs.inotify.max_user_watches` sysctl variable specifies the upper limit for
|
|
||||||
the number of watches per user, and `fs.inotify.max_user_instances` specifies
|
|
||||||
the maximum number of inotify instances per user. Every Watcher you create is an
|
|
||||||
"instance", and every path you add is a "watch".
|
|
||||||
|
|
||||||
These are also exposed in `/proc` as `/proc/sys/fs/inotify/max_user_watches` and
|
|
||||||
`/proc/sys/fs/inotify/max_user_instances`
|
|
||||||
|
|
||||||
To increase them you can use `sysctl` or write the value to proc file:
|
|
||||||
|
|
||||||
# The default values on Linux 5.18
|
|
||||||
sysctl fs.inotify.max_user_watches=124983
|
|
||||||
sysctl fs.inotify.max_user_instances=128
|
|
||||||
|
|
||||||
To make the changes persist on reboot edit `/etc/sysctl.conf` or
|
|
||||||
`/usr/lib/sysctl.d/50-default.conf` (details differ per Linux distro; check your
|
|
||||||
distro's documentation):
|
|
||||||
|
|
||||||
fs.inotify.max_user_watches=124983
|
|
||||||
fs.inotify.max_user_instances=128
|
|
||||||
|
|
||||||
Reaching the limit will result in a "no space left on device" or "too many open
|
|
||||||
files" error.
|
|
||||||
|
|
||||||
### kqueue (macOS, all BSD systems)
|
|
||||||
kqueue requires opening a file descriptor for every file that's being watched;
|
|
||||||
so if you're watching a directory with five files then that's six file
|
|
||||||
descriptors. You will run in to your system's "max open files" limit faster on
|
|
||||||
these platforms.
|
|
||||||
|
|
||||||
The sysctl variables `kern.maxfiles` and `kern.maxfilesperproc` can be used to
|
|
||||||
control the maximum number of open files.
|
|
||||||
-467
@@ -1,467 +0,0 @@
|
|||||||
//go:build solaris
|
|
||||||
|
|
||||||
// FEN backend for illumos (supported) and Solaris (untested, but should work).
|
|
||||||
//
|
|
||||||
// See port_create(3c) etc. for docs. https://www.illumos.org/man/3C/port_create
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io/fs"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/fsnotify/fsnotify/internal"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fen struct {
|
|
||||||
*shared
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
|
|
||||||
mu sync.Mutex
|
|
||||||
port *unix.EventPort
|
|
||||||
dirs map[string]Op // Explicitly watched directories
|
|
||||||
watches map[string]Op // Explicitly watched non-directories
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultBufferSize = 0
|
|
||||||
|
|
||||||
func newBackend(ev chan Event, errs chan error) (backend, error) {
|
|
||||||
w := &fen{
|
|
||||||
shared: newShared(ev, errs),
|
|
||||||
Events: ev,
|
|
||||||
Errors: errs,
|
|
||||||
dirs: make(map[string]Op),
|
|
||||||
watches: make(map[string]Op),
|
|
||||||
}
|
|
||||||
|
|
||||||
var err error
|
|
||||||
w.port, err = unix.NewEventPort()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("fsnotify.NewWatcher: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) Close() error {
|
|
||||||
if w.shared.close() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return w.port.Close()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) Add(name string) error { return w.AddWith(name) }
|
|
||||||
|
|
||||||
func (w *fen) AddWith(name string, opts ...addOpt) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return ErrClosed
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s AddWith(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), name)
|
|
||||||
}
|
|
||||||
|
|
||||||
with := getOptions(opts...)
|
|
||||||
if !w.xSupports(with.op) {
|
|
||||||
return fmt.Errorf("%w: %s", xErrUnsupported, with.op)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Currently we resolve symlinks that were explicitly requested to be
|
|
||||||
// watched. Otherwise we would use LStat here.
|
|
||||||
stat, err := os.Stat(name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Associate all files in the directory.
|
|
||||||
if stat.IsDir() {
|
|
||||||
err := w.handleDirectory(name, stat, true, w.associateFile)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
w.dirs[name] = with.op
|
|
||||||
w.mu.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err = w.associateFile(name, stat, true)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
w.watches[name] = with.op
|
|
||||||
w.mu.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) Remove(name string) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !w.port.PathIsWatched(name) {
|
|
||||||
return fmt.Errorf("%w: %s", ErrNonExistentWatch, name)
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s Remove(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), name)
|
|
||||||
}
|
|
||||||
|
|
||||||
// The user has expressed an intent. Immediately remove this name from
|
|
||||||
// whichever watch list it might be in. If it's not in there the delete
|
|
||||||
// doesn't cause harm.
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.watches, name)
|
|
||||||
delete(w.dirs, name)
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
stat, err := os.Stat(name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove associations for every file in the directory.
|
|
||||||
if stat.IsDir() {
|
|
||||||
err := w.handleDirectory(name, stat, false, w.dissociateFile)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
err = w.port.DissociatePath(name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents contains the main loop that runs in a goroutine watching for events.
|
|
||||||
func (w *fen) readEvents() {
|
|
||||||
// If this function returns, the watcher has been closed and we can close
|
|
||||||
// these channels
|
|
||||||
defer func() {
|
|
||||||
close(w.Errors)
|
|
||||||
close(w.Events)
|
|
||||||
}()
|
|
||||||
|
|
||||||
pevents := make([]unix.PortEvent, 8)
|
|
||||||
for {
|
|
||||||
count, err := w.port.Get(pevents, 1, nil)
|
|
||||||
if err != nil && err != unix.ETIME {
|
|
||||||
// Interrupted system call (count should be 0) ignore and continue
|
|
||||||
if errors.Is(err, unix.EINTR) && count == 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
// Get failed because we called w.Close()
|
|
||||||
if errors.Is(err, unix.EBADF) && w.isClosed() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
// There was an error not caused by calling w.Close()
|
|
||||||
if !w.sendError(fmt.Errorf("port.Get: %w", err)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
p := pevents[:count]
|
|
||||||
for _, pevent := range p {
|
|
||||||
if pevent.Source != unix.PORT_SOURCE_FILE {
|
|
||||||
// Event from unexpected source received; should never happen.
|
|
||||||
if !w.sendError(errors.New("Event from unexpected source received")) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if debug {
|
|
||||||
internal.Debug(pevent.Path, pevent.Events)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = w.handleEvent(&pevent)
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) handleDirectory(path string, stat os.FileInfo, follow bool, handler func(string, os.FileInfo, bool) error) error {
|
|
||||||
files, err := os.ReadDir(path)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle all children of the directory.
|
|
||||||
for _, entry := range files {
|
|
||||||
finfo, err := entry.Info()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
err = handler(filepath.Join(path, finfo.Name()), finfo, false)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// And finally handle the directory itself.
|
|
||||||
return handler(path, stat, follow)
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleEvent might need to emit more than one fsnotify event if the events
|
|
||||||
// bitmap matches more than one event type (e.g. the file was both modified and
|
|
||||||
// had the attributes changed between when the association was created and the
|
|
||||||
// when event was returned)
|
|
||||||
func (w *fen) handleEvent(event *unix.PortEvent) error {
|
|
||||||
var (
|
|
||||||
events = event.Events
|
|
||||||
path = event.Path
|
|
||||||
fmode = event.Cookie.(os.FileMode)
|
|
||||||
reRegister = true
|
|
||||||
)
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
_, watchedDir := w.dirs[path]
|
|
||||||
_, watchedPath := w.watches[path]
|
|
||||||
w.mu.Unlock()
|
|
||||||
isWatched := watchedDir || watchedPath
|
|
||||||
|
|
||||||
if events&unix.FILE_DELETE != 0 {
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Remove}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
reRegister = false
|
|
||||||
}
|
|
||||||
if events&unix.FILE_RENAME_FROM != 0 {
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Rename}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Don't keep watching the new file name
|
|
||||||
reRegister = false
|
|
||||||
}
|
|
||||||
if events&unix.FILE_RENAME_TO != 0 {
|
|
||||||
// We don't report a Rename event for this case, because Rename events
|
|
||||||
// are interpreted as referring to the _old_ name of the file, and in
|
|
||||||
// this case the event would refer to the new name of the file. This
|
|
||||||
// type of rename event is not supported by fsnotify.
|
|
||||||
|
|
||||||
// inotify reports a Remove event in this case, so we simulate this
|
|
||||||
// here.
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Remove}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Don't keep watching the file that was removed
|
|
||||||
reRegister = false
|
|
||||||
}
|
|
||||||
|
|
||||||
// The file is gone, nothing left to do.
|
|
||||||
if !reRegister {
|
|
||||||
if watchedDir {
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.dirs, path)
|
|
||||||
w.mu.Unlock()
|
|
||||||
}
|
|
||||||
if watchedPath {
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.watches, path)
|
|
||||||
w.mu.Unlock()
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// If we didn't get a deletion the file still exists and we're going to have
|
|
||||||
// to watch it again. Let's Stat it now so that we can compare permissions
|
|
||||||
// and have what we need to continue watching the file
|
|
||||||
|
|
||||||
stat, err := os.Lstat(path)
|
|
||||||
if err != nil {
|
|
||||||
// This is unexpected, but we should still emit an event. This happens
|
|
||||||
// most often on "rm -r" of a subdirectory inside a watched directory We
|
|
||||||
// get a modify event of something happening inside, but by the time we
|
|
||||||
// get here, the sudirectory is already gone. Clearly we were watching
|
|
||||||
// this path but now it is gone. Let's tell the user that it was
|
|
||||||
// removed.
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Remove}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Suppress extra write events on removed directories; they are not
|
|
||||||
// informative and can be confusing.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// resolve symlinks that were explicitly watched as we would have at Add()
|
|
||||||
// time. this helps suppress spurious Chmod events on watched symlinks
|
|
||||||
if isWatched {
|
|
||||||
stat, err = os.Stat(path)
|
|
||||||
if err != nil {
|
|
||||||
// The symlink still exists, but the target is gone. Report the
|
|
||||||
// Remove similar to above.
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Remove}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
// Don't return the error
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if events&unix.FILE_MODIFIED != 0 {
|
|
||||||
if fmode.IsDir() && watchedDir {
|
|
||||||
if err := w.updateDirectory(path); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Write}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if events&unix.FILE_ATTRIB != 0 && stat != nil {
|
|
||||||
// Only send Chmod if perms changed
|
|
||||||
if stat.Mode().Perm() != fmode.Perm() {
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Chmod}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if stat != nil {
|
|
||||||
// If we get here, it means we've hit an event above that requires us to
|
|
||||||
// continue watching the file or directory
|
|
||||||
err := w.associateFile(path, stat, isWatched)
|
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
|
||||||
// Path may have been removed since the stat.
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// The directory was modified, so we must find unwatched entities and watch
|
|
||||||
// them. If something was removed from the directory, nothing will happen, as
|
|
||||||
// everything else should still be watched.
|
|
||||||
func (w *fen) updateDirectory(path string) error {
|
|
||||||
files, err := os.ReadDir(path)
|
|
||||||
if err != nil {
|
|
||||||
// Directory no longer exists: probably just deleted since we got the
|
|
||||||
// event.
|
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, entry := range files {
|
|
||||||
path := filepath.Join(path, entry.Name())
|
|
||||||
if w.port.PathIsWatched(path) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
finfo, err := entry.Info()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
err = w.associateFile(path, finfo, false)
|
|
||||||
if errors.Is(err, fs.ErrNotExist) {
|
|
||||||
// File may have disappeared between getting the dir listing and
|
|
||||||
// adding the port: that's okay to ignore.
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Create}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) associateFile(path string, stat os.FileInfo, follow bool) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return ErrClosed
|
|
||||||
}
|
|
||||||
// This is primarily protecting the call to AssociatePath but it is
|
|
||||||
// important and intentional that the call to PathIsWatched is also
|
|
||||||
// protected by this mutex. Without this mutex, AssociatePath has been seen
|
|
||||||
// to error out that the path is already associated.
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
if w.port.PathIsWatched(path) {
|
|
||||||
// Remove the old association in favor of this one If we get ENOENT,
|
|
||||||
// then while the x/sys/unix wrapper still thought that this path was
|
|
||||||
// associated, the underlying event port did not. This call will have
|
|
||||||
// cleared up that discrepancy. The most likely cause is that the event
|
|
||||||
// has fired but we haven't processed it yet.
|
|
||||||
err := w.port.DissociatePath(path)
|
|
||||||
if err != nil && !errors.Is(err, unix.ENOENT) {
|
|
||||||
return fmt.Errorf("port.DissociatePath(%q): %w", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var events int
|
|
||||||
if !follow {
|
|
||||||
// Watch symlinks themselves rather than their targets unless this entry
|
|
||||||
// is explicitly watched.
|
|
||||||
events |= unix.FILE_NOFOLLOW
|
|
||||||
}
|
|
||||||
if true { // TODO: implement withOps()
|
|
||||||
events |= unix.FILE_MODIFIED
|
|
||||||
}
|
|
||||||
if true {
|
|
||||||
events |= unix.FILE_ATTRIB
|
|
||||||
}
|
|
||||||
err := w.port.AssociatePath(path, stat, events, stat.Mode())
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("port.AssociatePath(%q): %w", path, err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) dissociateFile(path string, stat os.FileInfo, unused bool) error {
|
|
||||||
if !w.port.PathIsWatched(path) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
err := w.port.DissociatePath(path)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("port.DissociatePath(%q): %w", path, err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) WatchList() []string {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
entries := make([]string, 0, len(w.watches)+len(w.dirs))
|
|
||||||
for pathname := range w.dirs {
|
|
||||||
entries = append(entries, pathname)
|
|
||||||
}
|
|
||||||
for pathname := range w.watches {
|
|
||||||
entries = append(entries, pathname)
|
|
||||||
}
|
|
||||||
|
|
||||||
return entries
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *fen) xSupports(op Op) bool {
|
|
||||||
if op.Has(xUnportableOpen) || op.Has(xUnportableRead) ||
|
|
||||||
op.Has(xUnportableCloseWrite) || op.Has(xUnportableCloseRead) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
-583
@@ -1,583 +0,0 @@
|
|||||||
//go:build linux && !appengine
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"io/fs"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
"unsafe"
|
|
||||||
|
|
||||||
"github.com/fsnotify/fsnotify/internal"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
type inotify struct {
|
|
||||||
*shared
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
|
|
||||||
// Store fd here as os.File.Read() will no longer return on close after
|
|
||||||
// calling Fd(). See: https://github.com/golang/go/issues/26439
|
|
||||||
fd int
|
|
||||||
inotifyFile *os.File
|
|
||||||
watches *watches
|
|
||||||
doneResp chan struct{} // Channel to respond to Close
|
|
||||||
|
|
||||||
// Store rename cookies in an array, with the index wrapping to 0. Almost
|
|
||||||
// all of the time what we get is a MOVED_FROM to set the cookie and the
|
|
||||||
// next event inotify sends will be MOVED_TO to read it. However, this is
|
|
||||||
// not guaranteed – as described in inotify(7) – and we may get other events
|
|
||||||
// between the two MOVED_* events (including other MOVED_* ones).
|
|
||||||
//
|
|
||||||
// A second issue is that moving a file outside the watched directory will
|
|
||||||
// trigger a MOVED_FROM to set the cookie, but we never see the MOVED_TO to
|
|
||||||
// read and delete it. So just storing it in a map would slowly leak memory.
|
|
||||||
//
|
|
||||||
// Doing it like this gives us a simple fast LRU-cache that won't allocate.
|
|
||||||
// Ten items should be more than enough for our purpose, and a loop over
|
|
||||||
// such a short array is faster than a map access anyway (not that it hugely
|
|
||||||
// matters since we're talking about hundreds of ns at the most, but still).
|
|
||||||
cookies [10]koekje
|
|
||||||
cookieIndex uint8
|
|
||||||
cookiesMu sync.Mutex
|
|
||||||
}
|
|
||||||
|
|
||||||
type (
|
|
||||||
watches struct {
|
|
||||||
wd map[uint32]*watch // wd → watch
|
|
||||||
path map[string]uint32 // pathname → wd
|
|
||||||
}
|
|
||||||
watch struct {
|
|
||||||
wd uint32 // Watch descriptor (as returned by the inotify_add_watch() syscall)
|
|
||||||
flags uint32 // inotify flags of this watch (see inotify(7) for the list of valid flags)
|
|
||||||
path string // Watch path.
|
|
||||||
recurse bool // Recursion with ./...?
|
|
||||||
}
|
|
||||||
koekje struct {
|
|
||||||
cookie uint32
|
|
||||||
path string
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
func newWatches() *watches {
|
|
||||||
return &watches{
|
|
||||||
wd: make(map[uint32]*watch),
|
|
||||||
path: make(map[string]uint32),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) byPath(path string) *watch { return w.wd[w.path[path]] }
|
|
||||||
func (w *watches) byWd(wd uint32) *watch { return w.wd[wd] }
|
|
||||||
func (w *watches) len() int { return len(w.wd) }
|
|
||||||
func (w *watches) add(ww *watch) { w.wd[ww.wd] = ww; w.path[ww.path] = ww.wd }
|
|
||||||
func (w *watches) remove(watch *watch) { delete(w.path, watch.path); delete(w.wd, watch.wd) }
|
|
||||||
|
|
||||||
func (w *watches) removePath(path string) ([]uint32, error) {
|
|
||||||
path, recurse := recursivePath(path)
|
|
||||||
wd, ok := w.path[path]
|
|
||||||
if !ok {
|
|
||||||
return nil, fmt.Errorf("%w: %s", ErrNonExistentWatch, path)
|
|
||||||
}
|
|
||||||
|
|
||||||
watch := w.wd[wd]
|
|
||||||
if recurse && !watch.recurse {
|
|
||||||
return nil, fmt.Errorf("can't use /... with non-recursive watch %q", path)
|
|
||||||
}
|
|
||||||
|
|
||||||
delete(w.path, path)
|
|
||||||
delete(w.wd, wd)
|
|
||||||
if !watch.recurse {
|
|
||||||
return []uint32{wd}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
wds := make([]uint32, 0, 8)
|
|
||||||
wds = append(wds, wd)
|
|
||||||
for p, rwd := range w.path {
|
|
||||||
if strings.HasPrefix(p, path) {
|
|
||||||
delete(w.path, p)
|
|
||||||
delete(w.wd, rwd)
|
|
||||||
wds = append(wds, rwd)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return wds, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) updatePath(path string, f func(*watch) (*watch, error)) error {
|
|
||||||
var existing *watch
|
|
||||||
wd, ok := w.path[path]
|
|
||||||
if ok {
|
|
||||||
existing = w.wd[wd]
|
|
||||||
}
|
|
||||||
|
|
||||||
upd, err := f(existing)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if upd != nil {
|
|
||||||
w.wd[upd.wd] = upd
|
|
||||||
w.path[upd.path] = upd.wd
|
|
||||||
|
|
||||||
if upd.wd != wd {
|
|
||||||
delete(w.wd, wd)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultBufferSize = 0
|
|
||||||
|
|
||||||
func newBackend(ev chan Event, errs chan error) (backend, error) {
|
|
||||||
// Need to set nonblocking mode for SetDeadline to work, otherwise blocking
|
|
||||||
// I/O operations won't terminate on close.
|
|
||||||
fd, errno := unix.InotifyInit1(unix.IN_CLOEXEC | unix.IN_NONBLOCK)
|
|
||||||
if fd == -1 {
|
|
||||||
return nil, errno
|
|
||||||
}
|
|
||||||
|
|
||||||
w := &inotify{
|
|
||||||
shared: newShared(ev, errs),
|
|
||||||
Events: ev,
|
|
||||||
Errors: errs,
|
|
||||||
fd: fd,
|
|
||||||
inotifyFile: os.NewFile(uintptr(fd), ""),
|
|
||||||
watches: newWatches(),
|
|
||||||
doneResp: make(chan struct{}),
|
|
||||||
}
|
|
||||||
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) Close() error {
|
|
||||||
if w.shared.close() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Causes any blocking reads to return with an error, provided the file
|
|
||||||
// still supports deadline operations.
|
|
||||||
err := w.inotifyFile.Close()
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
<-w.doneResp // Wait for readEvents() to finish.
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) Add(name string) error { return w.AddWith(name) }
|
|
||||||
|
|
||||||
func (w *inotify) AddWith(path string, opts ...addOpt) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return ErrClosed
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s AddWith(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), path)
|
|
||||||
}
|
|
||||||
|
|
||||||
with := getOptions(opts...)
|
|
||||||
if !w.xSupports(with.op) {
|
|
||||||
return fmt.Errorf("%w: %s", xErrUnsupported, with.op)
|
|
||||||
}
|
|
||||||
|
|
||||||
add := func(path string, with withOpts, recurse bool) error {
|
|
||||||
var flags uint32
|
|
||||||
if with.noFollow {
|
|
||||||
flags |= unix.IN_DONT_FOLLOW
|
|
||||||
}
|
|
||||||
if with.op.Has(Create) {
|
|
||||||
flags |= unix.IN_CREATE
|
|
||||||
}
|
|
||||||
if with.op.Has(Write) {
|
|
||||||
flags |= unix.IN_MODIFY
|
|
||||||
}
|
|
||||||
if with.op.Has(Remove) {
|
|
||||||
flags |= unix.IN_DELETE | unix.IN_DELETE_SELF
|
|
||||||
}
|
|
||||||
if with.op.Has(Rename) {
|
|
||||||
flags |= unix.IN_MOVED_TO | unix.IN_MOVED_FROM | unix.IN_MOVE_SELF
|
|
||||||
}
|
|
||||||
if with.op.Has(Chmod) {
|
|
||||||
flags |= unix.IN_ATTRIB
|
|
||||||
}
|
|
||||||
if with.op.Has(xUnportableOpen) {
|
|
||||||
flags |= unix.IN_OPEN
|
|
||||||
}
|
|
||||||
if with.op.Has(xUnportableRead) {
|
|
||||||
flags |= unix.IN_ACCESS
|
|
||||||
}
|
|
||||||
if with.op.Has(xUnportableCloseWrite) {
|
|
||||||
flags |= unix.IN_CLOSE_WRITE
|
|
||||||
}
|
|
||||||
if with.op.Has(xUnportableCloseRead) {
|
|
||||||
flags |= unix.IN_CLOSE_NOWRITE
|
|
||||||
}
|
|
||||||
return w.register(path, flags, recurse)
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
path, recurse := recursivePath(path)
|
|
||||||
if recurse {
|
|
||||||
return filepath.WalkDir(path, func(root string, d fs.DirEntry, err error) error {
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
if !d.IsDir() {
|
|
||||||
if root == path {
|
|
||||||
return fmt.Errorf("fsnotify: not a directory: %q", path)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send a Create event when adding new directory from a recursive
|
|
||||||
// watch; this is for "mkdir -p one/two/three". Usually all those
|
|
||||||
// directories will be created before we can set up watchers on the
|
|
||||||
// subdirectories, so only "one" would be sent as a Create event and
|
|
||||||
// not "one/two" and "one/two/three" (inotifywait -r has the same
|
|
||||||
// problem).
|
|
||||||
if with.sendCreate && root != path {
|
|
||||||
w.sendEvent(Event{Name: root, Op: Create})
|
|
||||||
}
|
|
||||||
|
|
||||||
return add(root, with, true)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
return add(path, with, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) register(path string, flags uint32, recurse bool) error {
|
|
||||||
return w.watches.updatePath(path, func(existing *watch) (*watch, error) {
|
|
||||||
if existing != nil {
|
|
||||||
flags |= existing.flags | unix.IN_MASK_ADD
|
|
||||||
}
|
|
||||||
|
|
||||||
wd, err := unix.InotifyAddWatch(w.fd, path, flags)
|
|
||||||
if wd == -1 {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
if e, ok := w.watches.wd[uint32(wd)]; ok {
|
|
||||||
return e, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if existing == nil {
|
|
||||||
return &watch{
|
|
||||||
wd: uint32(wd),
|
|
||||||
path: path,
|
|
||||||
flags: flags,
|
|
||||||
recurse: recurse,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
existing.wd = uint32(wd)
|
|
||||||
existing.flags = flags
|
|
||||||
return existing, nil
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) Remove(name string) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s Remove(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), name)
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
return w.remove(filepath.Clean(name))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) remove(name string) error {
|
|
||||||
wds, err := w.watches.removePath(name)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, wd := range wds {
|
|
||||||
_, err := unix.InotifyRmWatch(w.fd, wd)
|
|
||||||
if err != nil {
|
|
||||||
// TODO: Perhaps it's not helpful to return an error here in every
|
|
||||||
// case; the only two possible errors are:
|
|
||||||
//
|
|
||||||
// EBADF, which happens when w.fd is not a valid file descriptor of
|
|
||||||
// any kind.
|
|
||||||
//
|
|
||||||
// EINVAL, which is when fd is not an inotify descriptor or wd is
|
|
||||||
// not a valid watch descriptor. Watch descriptors are invalidated
|
|
||||||
// when they are removed explicitly or implicitly; explicitly by
|
|
||||||
// inotify_rm_watch, implicitly when the file they are watching is
|
|
||||||
// deleted.
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) WatchList() []string {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
entries := make([]string, 0, w.watches.len())
|
|
||||||
for pathname := range w.watches.path {
|
|
||||||
entries = append(entries, pathname)
|
|
||||||
}
|
|
||||||
return entries
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from the inotify file descriptor, converts the
|
|
||||||
// received events into Event objects and sends them via the Events channel
|
|
||||||
func (w *inotify) readEvents() {
|
|
||||||
defer func() {
|
|
||||||
close(w.doneResp)
|
|
||||||
close(w.Errors)
|
|
||||||
close(w.Events)
|
|
||||||
}()
|
|
||||||
|
|
||||||
var buf [unix.SizeofInotifyEvent * 4096]byte // Buffer for a maximum of 4096 raw events
|
|
||||||
for {
|
|
||||||
if w.isClosed() {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
n, err := w.inotifyFile.Read(buf[:])
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, os.ErrClosed) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if n < unix.SizeofInotifyEvent {
|
|
||||||
err := errors.New("notify: short read in readEvents()") // Read was too short.
|
|
||||||
if n == 0 {
|
|
||||||
err = io.EOF // If EOF is received. This should really never happen.
|
|
||||||
}
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
// We don't know how many events we just read into the buffer While the
|
|
||||||
// offset points to at least one whole event.
|
|
||||||
var offset uint32
|
|
||||||
for offset <= uint32(n-unix.SizeofInotifyEvent) {
|
|
||||||
// Point to the event in the buffer.
|
|
||||||
inEvent := (*unix.InotifyEvent)(unsafe.Pointer(&buf[offset]))
|
|
||||||
|
|
||||||
if inEvent.Mask&unix.IN_Q_OVERFLOW != 0 {
|
|
||||||
if !w.sendError(ErrEventOverflow) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
ev, ok := w.handleEvent(inEvent, &buf, offset)
|
|
||||||
if !ok {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if !w.sendEvent(ev) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
// Move to the next event in the buffer
|
|
||||||
offset += unix.SizeofInotifyEvent + inEvent.Len
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) handleEvent(inEvent *unix.InotifyEvent, buf *[65536]byte, offset uint32) (Event, bool) {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
/// If the event happened to the watched directory or the watched file, the
|
|
||||||
/// kernel doesn't append the filename to the event, but we would like to
|
|
||||||
/// always fill the the "Name" field with a valid filename. We retrieve the
|
|
||||||
/// path of the watch from the "paths" map.
|
|
||||||
///
|
|
||||||
/// Can be nil if Remove() was called in another goroutine for this path
|
|
||||||
/// inbetween reading the events from the kernel and reading the internal
|
|
||||||
/// state. Not much we can do about it, so just skip. See #616.
|
|
||||||
watch := w.watches.byWd(uint32(inEvent.Wd))
|
|
||||||
if watch == nil {
|
|
||||||
return Event{}, true
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
name = watch.path
|
|
||||||
nameLen = uint32(inEvent.Len)
|
|
||||||
)
|
|
||||||
if nameLen > 0 {
|
|
||||||
/// Point "bytes" at the first byte of the filename
|
|
||||||
bb := *buf
|
|
||||||
bytes := (*[unix.PathMax]byte)(unsafe.Pointer(&bb[offset+unix.SizeofInotifyEvent]))[:nameLen:nameLen]
|
|
||||||
/// The filename is padded with NULL bytes. TrimRight() gets rid of those.
|
|
||||||
name += "/" + strings.TrimRight(string(bytes[0:nameLen]), "\x00")
|
|
||||||
}
|
|
||||||
|
|
||||||
if debug {
|
|
||||||
internal.Debug(name, inEvent.Mask, inEvent.Cookie)
|
|
||||||
}
|
|
||||||
|
|
||||||
if inEvent.Mask&unix.IN_IGNORED != 0 || inEvent.Mask&unix.IN_UNMOUNT != 0 {
|
|
||||||
w.watches.remove(watch)
|
|
||||||
return Event{}, true
|
|
||||||
}
|
|
||||||
|
|
||||||
// inotify will automatically remove the watch on deletes; just need
|
|
||||||
// to clean our state here.
|
|
||||||
if inEvent.Mask&unix.IN_DELETE_SELF == unix.IN_DELETE_SELF {
|
|
||||||
w.watches.remove(watch)
|
|
||||||
}
|
|
||||||
|
|
||||||
// We can't really update the state when a watched path is moved; only
|
|
||||||
// IN_MOVE_SELF is sent and not IN_MOVED_{FROM,TO}. So remove the watch.
|
|
||||||
if inEvent.Mask&unix.IN_MOVE_SELF == unix.IN_MOVE_SELF {
|
|
||||||
if watch.recurse { // Do nothing
|
|
||||||
return Event{}, true
|
|
||||||
}
|
|
||||||
|
|
||||||
err := w.remove(watch.path)
|
|
||||||
if err != nil && !errors.Is(err, ErrNonExistentWatch) {
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return Event{}, false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Skip if we're watching both this path and the parent; the parent will
|
|
||||||
/// already send a delete so no need to do it twice.
|
|
||||||
if inEvent.Mask&unix.IN_DELETE_SELF != 0 {
|
|
||||||
_, ok := w.watches.path[filepath.Dir(watch.path)]
|
|
||||||
if ok {
|
|
||||||
return Event{}, true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
ev := w.newEvent(name, inEvent.Mask, inEvent.Cookie)
|
|
||||||
// Need to update watch path for recurse.
|
|
||||||
if watch.recurse {
|
|
||||||
isDir := inEvent.Mask&unix.IN_ISDIR == unix.IN_ISDIR
|
|
||||||
/// New directory created: set up watch on it.
|
|
||||||
if isDir && ev.Has(Create) {
|
|
||||||
err := w.register(ev.Name, watch.flags, true)
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return Event{}, false
|
|
||||||
}
|
|
||||||
|
|
||||||
// This was a directory rename, so we need to update all the
|
|
||||||
// children.
|
|
||||||
//
|
|
||||||
// TODO: this is of course pretty slow; we should use a better data
|
|
||||||
// structure for storing all of this, e.g. store children in the
|
|
||||||
// watch. I have some code for this in my kqueue refactor we can use
|
|
||||||
// in the future. For now I'm okay with this as it's not publicly
|
|
||||||
// available. Correctness first, performance second.
|
|
||||||
if ev.renamedFrom != "" {
|
|
||||||
for k, ww := range w.watches.wd {
|
|
||||||
if k == watch.wd || ww.path == ev.Name {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if strings.HasPrefix(ww.path, ev.renamedFrom) {
|
|
||||||
ww.path = strings.Replace(ww.path, ev.renamedFrom, ev.Name, 1)
|
|
||||||
w.watches.wd[k] = ww
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return ev, true
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) isRecursive(path string) bool {
|
|
||||||
ww := w.watches.byPath(path)
|
|
||||||
if ww == nil { // path could be a file, so also check the Dir.
|
|
||||||
ww = w.watches.byPath(filepath.Dir(path))
|
|
||||||
}
|
|
||||||
return ww != nil && ww.recurse
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) newEvent(name string, mask, cookie uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if mask&unix.IN_CREATE == unix.IN_CREATE || mask&unix.IN_MOVED_TO == unix.IN_MOVED_TO {
|
|
||||||
e.Op |= Create
|
|
||||||
}
|
|
||||||
if mask&unix.IN_DELETE_SELF == unix.IN_DELETE_SELF || mask&unix.IN_DELETE == unix.IN_DELETE {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&unix.IN_MODIFY == unix.IN_MODIFY {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&unix.IN_OPEN == unix.IN_OPEN {
|
|
||||||
e.Op |= xUnportableOpen
|
|
||||||
}
|
|
||||||
if mask&unix.IN_ACCESS == unix.IN_ACCESS {
|
|
||||||
e.Op |= xUnportableRead
|
|
||||||
}
|
|
||||||
if mask&unix.IN_CLOSE_WRITE == unix.IN_CLOSE_WRITE {
|
|
||||||
e.Op |= xUnportableCloseWrite
|
|
||||||
}
|
|
||||||
if mask&unix.IN_CLOSE_NOWRITE == unix.IN_CLOSE_NOWRITE {
|
|
||||||
e.Op |= xUnportableCloseRead
|
|
||||||
}
|
|
||||||
if mask&unix.IN_MOVE_SELF == unix.IN_MOVE_SELF || mask&unix.IN_MOVED_FROM == unix.IN_MOVED_FROM {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
if mask&unix.IN_ATTRIB == unix.IN_ATTRIB {
|
|
||||||
e.Op |= Chmod
|
|
||||||
}
|
|
||||||
|
|
||||||
if cookie != 0 {
|
|
||||||
if mask&unix.IN_MOVED_FROM == unix.IN_MOVED_FROM {
|
|
||||||
w.cookiesMu.Lock()
|
|
||||||
w.cookies[w.cookieIndex] = koekje{cookie: cookie, path: e.Name}
|
|
||||||
w.cookieIndex++
|
|
||||||
if w.cookieIndex > 9 {
|
|
||||||
w.cookieIndex = 0
|
|
||||||
}
|
|
||||||
w.cookiesMu.Unlock()
|
|
||||||
} else if mask&unix.IN_MOVED_TO == unix.IN_MOVED_TO {
|
|
||||||
w.cookiesMu.Lock()
|
|
||||||
var prev string
|
|
||||||
for _, c := range w.cookies {
|
|
||||||
if c.cookie == cookie {
|
|
||||||
prev = c.path
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
w.cookiesMu.Unlock()
|
|
||||||
e.renamedFrom = prev
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) xSupports(op Op) bool {
|
|
||||||
return true // Supports everything.
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *inotify) state() {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
for wd, ww := range w.watches.wd {
|
|
||||||
fmt.Fprintf(os.Stderr, "%4d: recurse=%t %q\n", wd, ww.recurse, ww.path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-705
@@ -1,705 +0,0 @@
|
|||||||
//go:build freebsd || openbsd || netbsd || dragonfly || darwin
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"runtime"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/fsnotify/fsnotify/internal"
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
type kqueue struct {
|
|
||||||
*shared
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
|
|
||||||
kq int // File descriptor (as returned by the kqueue() syscall).
|
|
||||||
closepipe [2]int // Pipe used for closing kq.
|
|
||||||
watches *watches
|
|
||||||
}
|
|
||||||
|
|
||||||
type (
|
|
||||||
watches struct {
|
|
||||||
mu sync.RWMutex
|
|
||||||
wd map[int]watch // wd → watch
|
|
||||||
path map[string]int // pathname → wd
|
|
||||||
byDir map[string]map[int]struct{} // dirname(path) → wd
|
|
||||||
seen map[string]struct{} // Keep track of if we know this file exists.
|
|
||||||
byUser map[string]struct{} // Watches added with Watcher.Add()
|
|
||||||
}
|
|
||||||
watch struct {
|
|
||||||
wd int
|
|
||||||
name string
|
|
||||||
linkName string // In case of links; name is the target, and this is the link.
|
|
||||||
isDir bool
|
|
||||||
dirFlags uint32
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
func newWatches() *watches {
|
|
||||||
return &watches{
|
|
||||||
wd: make(map[int]watch),
|
|
||||||
path: make(map[string]int),
|
|
||||||
byDir: make(map[string]map[int]struct{}),
|
|
||||||
seen: make(map[string]struct{}),
|
|
||||||
byUser: make(map[string]struct{}),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) listPaths(userOnly bool) []string {
|
|
||||||
w.mu.RLock()
|
|
||||||
defer w.mu.RUnlock()
|
|
||||||
|
|
||||||
if userOnly {
|
|
||||||
l := make([]string, 0, len(w.byUser))
|
|
||||||
for p := range w.byUser {
|
|
||||||
l = append(l, p)
|
|
||||||
}
|
|
||||||
return l
|
|
||||||
}
|
|
||||||
|
|
||||||
l := make([]string, 0, len(w.path))
|
|
||||||
for p := range w.path {
|
|
||||||
l = append(l, p)
|
|
||||||
}
|
|
||||||
return l
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) watchesInDir(path string) []string {
|
|
||||||
w.mu.RLock()
|
|
||||||
defer w.mu.RUnlock()
|
|
||||||
|
|
||||||
l := make([]string, 0, 4)
|
|
||||||
for fd := range w.byDir[path] {
|
|
||||||
info := w.wd[fd]
|
|
||||||
if _, ok := w.byUser[info.name]; !ok {
|
|
||||||
l = append(l, info.name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return l
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mark path as added by the user.
|
|
||||||
func (w *watches) addUserWatch(path string) {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
w.byUser[path] = struct{}{}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) addLink(path string, fd int) {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
w.path[path] = fd
|
|
||||||
w.seen[path] = struct{}{}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) add(path, linkPath string, fd int, isDir bool) {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
w.path[path] = fd
|
|
||||||
w.wd[fd] = watch{wd: fd, name: path, linkName: linkPath, isDir: isDir}
|
|
||||||
|
|
||||||
parent := filepath.Dir(path)
|
|
||||||
byDir, ok := w.byDir[parent]
|
|
||||||
if !ok {
|
|
||||||
byDir = make(map[int]struct{}, 1)
|
|
||||||
w.byDir[parent] = byDir
|
|
||||||
}
|
|
||||||
byDir[fd] = struct{}{}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) byWd(fd int) (watch, bool) {
|
|
||||||
w.mu.RLock()
|
|
||||||
defer w.mu.RUnlock()
|
|
||||||
info, ok := w.wd[fd]
|
|
||||||
return info, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) byPath(path string) (watch, bool) {
|
|
||||||
w.mu.RLock()
|
|
||||||
defer w.mu.RUnlock()
|
|
||||||
info, ok := w.wd[w.path[path]]
|
|
||||||
return info, ok
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) updateDirFlags(path string, flags uint32) bool {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
fd, ok := w.path[path]
|
|
||||||
if !ok { // Already deleted: don't re-set it here.
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
info := w.wd[fd]
|
|
||||||
info.dirFlags = flags
|
|
||||||
w.wd[fd] = info
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) remove(fd int, path string) bool {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
isDir := w.wd[fd].isDir
|
|
||||||
delete(w.path, path)
|
|
||||||
delete(w.byUser, path)
|
|
||||||
|
|
||||||
parent := filepath.Dir(path)
|
|
||||||
delete(w.byDir[parent], fd)
|
|
||||||
|
|
||||||
if len(w.byDir[parent]) == 0 {
|
|
||||||
delete(w.byDir, parent)
|
|
||||||
}
|
|
||||||
|
|
||||||
delete(w.wd, fd)
|
|
||||||
delete(w.seen, path)
|
|
||||||
return isDir
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) markSeen(path string, exists bool) {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
if exists {
|
|
||||||
w.seen[path] = struct{}{}
|
|
||||||
} else {
|
|
||||||
delete(w.seen, path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *watches) seenBefore(path string) bool {
|
|
||||||
w.mu.RLock()
|
|
||||||
defer w.mu.RUnlock()
|
|
||||||
_, ok := w.seen[path]
|
|
||||||
return ok
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultBufferSize = 0
|
|
||||||
|
|
||||||
func newBackend(ev chan Event, errs chan error) (backend, error) {
|
|
||||||
kq, closepipe, err := newKqueue()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
w := &kqueue{
|
|
||||||
shared: newShared(ev, errs),
|
|
||||||
Events: ev,
|
|
||||||
Errors: errs,
|
|
||||||
kq: kq,
|
|
||||||
closepipe: closepipe,
|
|
||||||
watches: newWatches(),
|
|
||||||
}
|
|
||||||
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// newKqueue creates a new kernel event queue and returns a descriptor.
|
|
||||||
//
|
|
||||||
// This registers a new event on closepipe, which will trigger an event when
|
|
||||||
// it's closed. This way we can use kevent() without timeout/polling; without
|
|
||||||
// the closepipe, it would block forever and we wouldn't be able to stop it at
|
|
||||||
// all.
|
|
||||||
func newKqueue() (kq int, closepipe [2]int, err error) {
|
|
||||||
kq, err = unix.Kqueue()
|
|
||||||
if err != nil {
|
|
||||||
return kq, closepipe, err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register the close pipe.
|
|
||||||
err = unix.Pipe(closepipe[:])
|
|
||||||
if err != nil {
|
|
||||||
unix.Close(kq)
|
|
||||||
return kq, closepipe, err
|
|
||||||
}
|
|
||||||
unix.CloseOnExec(closepipe[0])
|
|
||||||
unix.CloseOnExec(closepipe[1])
|
|
||||||
|
|
||||||
// Register changes to listen on the closepipe.
|
|
||||||
changes := make([]unix.Kevent_t, 1)
|
|
||||||
// SetKevent converts int to the platform-specific types.
|
|
||||||
unix.SetKevent(&changes[0], closepipe[0], unix.EVFILT_READ,
|
|
||||||
unix.EV_ADD|unix.EV_ENABLE|unix.EV_ONESHOT)
|
|
||||||
|
|
||||||
ok, err := unix.Kevent(kq, changes, nil, nil)
|
|
||||||
if ok == -1 {
|
|
||||||
unix.Close(kq)
|
|
||||||
unix.Close(closepipe[0])
|
|
||||||
unix.Close(closepipe[1])
|
|
||||||
return kq, closepipe, err
|
|
||||||
}
|
|
||||||
return kq, closepipe, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) Close() error {
|
|
||||||
if w.shared.close() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
pathsToRemove := w.watches.listPaths(false)
|
|
||||||
for _, name := range pathsToRemove {
|
|
||||||
w.Remove(name)
|
|
||||||
}
|
|
||||||
|
|
||||||
unix.Close(w.closepipe[1]) // Send "quit" message to readEvents
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) Add(name string) error { return w.AddWith(name) }
|
|
||||||
|
|
||||||
func (w *kqueue) AddWith(name string, opts ...addOpt) error {
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s AddWith(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), name)
|
|
||||||
}
|
|
||||||
|
|
||||||
with := getOptions(opts...)
|
|
||||||
if !w.xSupports(with.op) {
|
|
||||||
return fmt.Errorf("%w: %s", xErrUnsupported, with.op)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := w.addWatch(name, noteAllEvents, false)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.watches.addUserWatch(name)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) Remove(name string) error {
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s Remove(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), name)
|
|
||||||
}
|
|
||||||
return w.remove(name, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) remove(name string, unwatchFiles bool) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
info, ok := w.watches.byPath(name)
|
|
||||||
if !ok {
|
|
||||||
return fmt.Errorf("%w: %s", ErrNonExistentWatch, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
err := w.register([]int{info.wd}, unix.EV_DELETE, 0)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
unix.Close(info.wd)
|
|
||||||
|
|
||||||
isDir := w.watches.remove(info.wd, name)
|
|
||||||
|
|
||||||
// Find all watched paths that are in this directory that are not external.
|
|
||||||
if unwatchFiles && isDir {
|
|
||||||
pathsToRemove := w.watches.watchesInDir(name)
|
|
||||||
for _, name := range pathsToRemove {
|
|
||||||
// Since these are internal, not much sense in propagating error to
|
|
||||||
// the user, as that will just confuse them with an error about a
|
|
||||||
// path they did not explicitly watch themselves.
|
|
||||||
w.Remove(name)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) WatchList() []string {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return w.watches.listPaths(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Watch all events (except NOTE_EXTEND, NOTE_LINK, NOTE_REVOKE)
|
|
||||||
const noteAllEvents = unix.NOTE_DELETE | unix.NOTE_WRITE | unix.NOTE_ATTRIB | unix.NOTE_RENAME
|
|
||||||
|
|
||||||
// addWatch adds name to the watched file set; the flags are interpreted as
|
|
||||||
// described in kevent(2).
|
|
||||||
//
|
|
||||||
// Returns the real path to the file which was added, with symlinks resolved.
|
|
||||||
func (w *kqueue) addWatch(name string, flags uint32, listDir bool) (string, error) {
|
|
||||||
if w.isClosed() {
|
|
||||||
return "", ErrClosed
|
|
||||||
}
|
|
||||||
|
|
||||||
name = filepath.Clean(name)
|
|
||||||
|
|
||||||
info, alreadyWatching := w.watches.byPath(name)
|
|
||||||
if !alreadyWatching {
|
|
||||||
fi, err := os.Lstat(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
// Don't watch sockets or named pipes.
|
|
||||||
if (fi.Mode()&os.ModeSocket == os.ModeSocket) || (fi.Mode()&os.ModeNamedPipe == os.ModeNamedPipe) {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Follow symlinks, but only for paths added with Add(), and not paths
|
|
||||||
// we're adding from internalWatch from a listdir.
|
|
||||||
if !listDir && fi.Mode()&os.ModeSymlink == os.ModeSymlink {
|
|
||||||
link, err := os.Readlink(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if !filepath.IsAbs(link) {
|
|
||||||
link = filepath.Join(filepath.Dir(name), link)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, alreadyWatching = w.watches.byPath(link)
|
|
||||||
if alreadyWatching {
|
|
||||||
// Add to watches so we don't get spurious Create events later
|
|
||||||
// on when we diff the directories.
|
|
||||||
w.watches.addLink(name, 0)
|
|
||||||
return link, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
info.linkName = name
|
|
||||||
name = link
|
|
||||||
fi, err = os.Lstat(name)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Retry on EINTR; open() can return EINTR in practice on macOS.
|
|
||||||
// See #354, and Go issues 11180 and 39237.
|
|
||||||
for {
|
|
||||||
info.wd, err = unix.Open(name, openMode, 0)
|
|
||||||
if err == nil {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
if errors.Is(err, unix.EINTR) {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
info.isDir = fi.IsDir()
|
|
||||||
}
|
|
||||||
|
|
||||||
err := w.register([]int{info.wd}, unix.EV_ADD|unix.EV_CLEAR|unix.EV_ENABLE, flags)
|
|
||||||
if err != nil {
|
|
||||||
unix.Close(info.wd)
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
|
|
||||||
if !alreadyWatching {
|
|
||||||
w.watches.add(name, info.linkName, info.wd, info.isDir)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Watch the directory if it has not been watched before, or if it was
|
|
||||||
// watched before, but perhaps only a NOTE_DELETE (watchDirectoryFiles)
|
|
||||||
if info.isDir {
|
|
||||||
watchDir := (flags&unix.NOTE_WRITE) == unix.NOTE_WRITE &&
|
|
||||||
(!alreadyWatching || (info.dirFlags&unix.NOTE_WRITE) != unix.NOTE_WRITE)
|
|
||||||
if !w.watches.updateDirFlags(name, flags) {
|
|
||||||
return "", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if watchDir {
|
|
||||||
d := name
|
|
||||||
if info.linkName != "" {
|
|
||||||
d = info.linkName
|
|
||||||
}
|
|
||||||
if err := w.watchDirectoryFiles(d); err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return name, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from kqueue and converts the received kevents into
|
|
||||||
// Event values that it sends down the Events channel.
|
|
||||||
func (w *kqueue) readEvents() {
|
|
||||||
defer func() {
|
|
||||||
close(w.Events)
|
|
||||||
close(w.Errors)
|
|
||||||
_ = unix.Close(w.kq)
|
|
||||||
unix.Close(w.closepipe[0])
|
|
||||||
}()
|
|
||||||
|
|
||||||
eventBuffer := make([]unix.Kevent_t, 10)
|
|
||||||
for {
|
|
||||||
kevents, err := w.read(eventBuffer)
|
|
||||||
// EINTR is okay, the syscall was interrupted before timeout expired.
|
|
||||||
if err != nil && err != unix.EINTR {
|
|
||||||
if !w.sendError(fmt.Errorf("fsnotify.readEvents: %w", err)) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, kevent := range kevents {
|
|
||||||
var (
|
|
||||||
wd = int(kevent.Ident)
|
|
||||||
mask = uint32(kevent.Fflags)
|
|
||||||
)
|
|
||||||
|
|
||||||
// Shut down the loop when the pipe is closed, but only after all
|
|
||||||
// other events have been processed.
|
|
||||||
if wd == w.closepipe[0] {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
path, ok := w.watches.byWd(wd)
|
|
||||||
if debug {
|
|
||||||
internal.Debug(path.name, &kevent)
|
|
||||||
}
|
|
||||||
|
|
||||||
// On macOS it seems that sometimes an event with Ident=0 is
|
|
||||||
// delivered, and no other flags/information beyond that, even
|
|
||||||
// though we never saw such a file descriptor. For example in
|
|
||||||
// TestWatchSymlink/277 (usually at the end, but sometimes sooner):
|
|
||||||
//
|
|
||||||
// fmt.Printf("READ: %2d %#v\n", kevent.Ident, kevent)
|
|
||||||
// unix.Kevent_t{Ident:0x2a, Filter:-4, Flags:0x25, Fflags:0x2, Data:0, Udata:(*uint8)(nil)}
|
|
||||||
// unix.Kevent_t{Ident:0x0, Filter:-4, Flags:0x25, Fflags:0x2, Data:0, Udata:(*uint8)(nil)}
|
|
||||||
//
|
|
||||||
// The first is a normal event, the second with Ident 0. No error
|
|
||||||
// flag, no data, no ... nothing.
|
|
||||||
//
|
|
||||||
// I read a bit through bsd/kern_event.c from the xnu source, but I
|
|
||||||
// don't really see an obvious location where this is triggered –
|
|
||||||
// this doesn't seem intentional, but idk...
|
|
||||||
//
|
|
||||||
// Technically fd 0 is a valid descriptor, so only skip it if
|
|
||||||
// there's no path, and if we're on macOS.
|
|
||||||
if !ok && kevent.Ident == 0 && runtime.GOOS == "darwin" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
event := w.newEvent(path.name, path.linkName, mask)
|
|
||||||
|
|
||||||
if event.Has(Rename) || event.Has(Remove) {
|
|
||||||
w.remove(event.Name, false)
|
|
||||||
w.watches.markSeen(event.Name, false)
|
|
||||||
}
|
|
||||||
|
|
||||||
if path.isDir && event.Has(Write) && !event.Has(Remove) {
|
|
||||||
w.dirChange(event.Name)
|
|
||||||
} else if !w.sendEvent(event) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if event.Has(Remove) {
|
|
||||||
// Look for a file that may have overwritten this; for example,
|
|
||||||
// mv f1 f2 will delete f2, then create f2.
|
|
||||||
if path.isDir {
|
|
||||||
fileDir := filepath.Clean(event.Name)
|
|
||||||
_, found := w.watches.byPath(fileDir)
|
|
||||||
if found {
|
|
||||||
// TODO: this branch is never triggered in any test.
|
|
||||||
// Added in d6220df (2012).
|
|
||||||
// isDir check added in 8611c35 (2016): https://github.com/fsnotify/fsnotify/pull/111
|
|
||||||
//
|
|
||||||
// I don't really get how this can be triggered either.
|
|
||||||
// And it wasn't triggered in the patch that added it,
|
|
||||||
// either.
|
|
||||||
//
|
|
||||||
// Original also had a comment:
|
|
||||||
// make sure the directory exists before we watch for
|
|
||||||
// changes. When we do a recursive watch and perform
|
|
||||||
// rm -rf, the parent directory might have gone
|
|
||||||
// missing, ignore the missing directory and let the
|
|
||||||
// upcoming delete event remove the watch from the
|
|
||||||
// parent directory.
|
|
||||||
err := w.dirChange(fileDir)
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
path := filepath.Clean(event.Name)
|
|
||||||
if fi, err := os.Lstat(path); err == nil {
|
|
||||||
err := w.sendCreateIfNew(path, fi)
|
|
||||||
if !w.sendError(err) {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// newEvent returns an platform-independent Event based on kqueue Fflags.
|
|
||||||
func (w *kqueue) newEvent(name, linkName string, mask uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if linkName != "" {
|
|
||||||
// If the user watched "/path/link" then emit events as "/path/link"
|
|
||||||
// rather than "/path/target".
|
|
||||||
e.Name = linkName
|
|
||||||
}
|
|
||||||
|
|
||||||
if mask&unix.NOTE_DELETE == unix.NOTE_DELETE {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_WRITE == unix.NOTE_WRITE {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_RENAME == unix.NOTE_RENAME {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
if mask&unix.NOTE_ATTRIB == unix.NOTE_ATTRIB {
|
|
||||||
e.Op |= Chmod
|
|
||||||
}
|
|
||||||
// No point sending a write and delete event at the same time: if it's gone,
|
|
||||||
// then it's gone.
|
|
||||||
if e.Op.Has(Write) && e.Op.Has(Remove) {
|
|
||||||
e.Op &^= Write
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
// watchDirectoryFiles to mimic inotify when adding a watch on a directory
|
|
||||||
func (w *kqueue) watchDirectoryFiles(dirPath string) error {
|
|
||||||
files, err := os.ReadDir(dirPath)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, f := range files {
|
|
||||||
path := filepath.Join(dirPath, f.Name())
|
|
||||||
|
|
||||||
fi, err := f.Info()
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("%q: %w", path, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cleanPath, err := w.internalWatch(path, fi)
|
|
||||||
if err != nil {
|
|
||||||
// No permission to read the file; that's not a problem: just skip.
|
|
||||||
// But do add it to w.fileExists to prevent it from being picked up
|
|
||||||
// as a "new" file later (it still shows up in the directory
|
|
||||||
// listing).
|
|
||||||
switch {
|
|
||||||
case errors.Is(err, unix.EACCES) || errors.Is(err, unix.EPERM):
|
|
||||||
cleanPath = filepath.Clean(path)
|
|
||||||
default:
|
|
||||||
return fmt.Errorf("%q: %w", path, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
w.watches.markSeen(cleanPath, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Search the directory for new files and send an event for them.
|
|
||||||
//
|
|
||||||
// This functionality is to have the BSD watcher match the inotify, which sends
|
|
||||||
// a create event for files created in a watched directory.
|
|
||||||
func (w *kqueue) dirChange(dir string) error {
|
|
||||||
files, err := os.ReadDir(dir)
|
|
||||||
if err != nil {
|
|
||||||
// Directory no longer exists: we can ignore this safely. kqueue will
|
|
||||||
// still give us the correct events.
|
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return fmt.Errorf("fsnotify.dirChange %q: %w", dir, err)
|
|
||||||
}
|
|
||||||
|
|
||||||
for _, f := range files {
|
|
||||||
fi, err := f.Info()
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, os.ErrNotExist) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return fmt.Errorf("fsnotify.dirChange: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = w.sendCreateIfNew(filepath.Join(dir, fi.Name()), fi)
|
|
||||||
if err != nil {
|
|
||||||
// Don't need to send an error if this file isn't readable.
|
|
||||||
if errors.Is(err, unix.EACCES) || errors.Is(err, unix.EPERM) || errors.Is(err, os.ErrNotExist) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
return fmt.Errorf("fsnotify.dirChange: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Send a create event if the file isn't already being tracked, and start
|
|
||||||
// watching this file.
|
|
||||||
func (w *kqueue) sendCreateIfNew(path string, fi os.FileInfo) error {
|
|
||||||
if !w.watches.seenBefore(path) {
|
|
||||||
if !w.sendEvent(Event{Name: path, Op: Create}) {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Like watchDirectoryFiles, but without doing another ReadDir.
|
|
||||||
path, err := w.internalWatch(path, fi)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.watches.markSeen(path, true)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) internalWatch(name string, fi os.FileInfo) (string, error) {
|
|
||||||
if fi.IsDir() {
|
|
||||||
// mimic Linux providing delete events for subdirectories, but preserve
|
|
||||||
// the flags used if currently watching subdirectory
|
|
||||||
info, _ := w.watches.byPath(name)
|
|
||||||
return w.addWatch(name, info.dirFlags|unix.NOTE_DELETE|unix.NOTE_RENAME, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Watch file to mimic Linux inotify.
|
|
||||||
return w.addWatch(name, noteAllEvents, true)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register events with the queue.
|
|
||||||
func (w *kqueue) register(fds []int, flags int, fflags uint32) error {
|
|
||||||
changes := make([]unix.Kevent_t, len(fds))
|
|
||||||
for i, fd := range fds {
|
|
||||||
// SetKevent converts int to the platform-specific types.
|
|
||||||
unix.SetKevent(&changes[i], fd, unix.EVFILT_VNODE, flags)
|
|
||||||
changes[i].Fflags = fflags
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register the events.
|
|
||||||
success, err := unix.Kevent(w.kq, changes, nil, nil)
|
|
||||||
if success == -1 {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// read retrieves pending events, or waits until an event occurs.
|
|
||||||
func (w *kqueue) read(events []unix.Kevent_t) ([]unix.Kevent_t, error) {
|
|
||||||
n, err := unix.Kevent(w.kq, nil, events, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return events[0:n], nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *kqueue) xSupports(op Op) bool {
|
|
||||||
//if runtime.GOOS == "freebsd" {
|
|
||||||
// return true // Supports everything.
|
|
||||||
//}
|
|
||||||
if op.Has(xUnportableOpen) || op.Has(xUnportableRead) ||
|
|
||||||
op.Has(xUnportableCloseWrite) || op.Has(xUnportableCloseRead) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
-22
@@ -1,22 +0,0 @@
|
|||||||
//go:build appengine || (!darwin && !dragonfly && !freebsd && !openbsd && !linux && !netbsd && !solaris && !windows)
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import "errors"
|
|
||||||
|
|
||||||
type other struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultBufferSize = 0
|
|
||||||
|
|
||||||
func newBackend(ev chan Event, errs chan error) (backend, error) {
|
|
||||||
return nil, errors.New("fsnotify not supported on the current platform")
|
|
||||||
}
|
|
||||||
func (w *other) Close() error { return nil }
|
|
||||||
func (w *other) WatchList() []string { return nil }
|
|
||||||
func (w *other) Add(name string) error { return nil }
|
|
||||||
func (w *other) AddWith(name string, opts ...addOpt) error { return nil }
|
|
||||||
func (w *other) Remove(name string) error { return nil }
|
|
||||||
func (w *other) xSupports(op Op) bool { return false }
|
|
||||||
-680
@@ -1,680 +0,0 @@
|
|||||||
//go:build windows
|
|
||||||
|
|
||||||
// Windows backend based on ReadDirectoryChangesW()
|
|
||||||
//
|
|
||||||
// https://learn.microsoft.com/en-us/windows/win32/api/winbase/nf-winbase-readdirectorychangesw
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"reflect"
|
|
||||||
"runtime"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"time"
|
|
||||||
"unsafe"
|
|
||||||
|
|
||||||
"github.com/fsnotify/fsnotify/internal"
|
|
||||||
"golang.org/x/sys/windows"
|
|
||||||
)
|
|
||||||
|
|
||||||
type readDirChangesW struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
|
|
||||||
port windows.Handle // Handle to completion port
|
|
||||||
input chan *input // Inputs to the reader are sent on this channel
|
|
||||||
done chan chan<- error
|
|
||||||
|
|
||||||
mu sync.Mutex // Protects access to watches, closed
|
|
||||||
watches watchMap // Map of watches (key: i-number)
|
|
||||||
closed bool // Set to true when Close() is first called
|
|
||||||
}
|
|
||||||
|
|
||||||
var defaultBufferSize = 50
|
|
||||||
|
|
||||||
func newBackend(ev chan Event, errs chan error) (backend, error) {
|
|
||||||
port, err := windows.CreateIoCompletionPort(windows.InvalidHandle, 0, 0, 0)
|
|
||||||
if err != nil {
|
|
||||||
return nil, os.NewSyscallError("CreateIoCompletionPort", err)
|
|
||||||
}
|
|
||||||
w := &readDirChangesW{
|
|
||||||
Events: ev,
|
|
||||||
Errors: errs,
|
|
||||||
port: port,
|
|
||||||
watches: make(watchMap),
|
|
||||||
input: make(chan *input, 1),
|
|
||||||
done: make(chan chan<- error, 1),
|
|
||||||
}
|
|
||||||
go w.readEvents()
|
|
||||||
return w, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) isClosed() bool {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
return w.closed
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) sendEvent(name, renamedFrom string, mask uint64) bool {
|
|
||||||
if mask == 0 {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
event := w.newEvent(name, uint32(mask))
|
|
||||||
event.renamedFrom = renamedFrom
|
|
||||||
select {
|
|
||||||
case ch := <-w.done:
|
|
||||||
w.done <- ch
|
|
||||||
case w.Events <- event:
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
|
|
||||||
// Returns true if the error was sent, or false if watcher is closed.
|
|
||||||
func (w *readDirChangesW) sendError(err error) bool {
|
|
||||||
if err == nil {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
return false
|
|
||||||
case w.Errors <- err:
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) Close() error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
w.closed = true
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
// Send "done" message to the reader goroutine
|
|
||||||
ch := make(chan error)
|
|
||||||
w.done <- ch
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-ch
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) Add(name string) error { return w.AddWith(name) }
|
|
||||||
|
|
||||||
func (w *readDirChangesW) AddWith(name string, opts ...addOpt) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return ErrClosed
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s AddWith(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), filepath.ToSlash(name))
|
|
||||||
}
|
|
||||||
|
|
||||||
with := getOptions(opts...)
|
|
||||||
if !w.xSupports(with.op) {
|
|
||||||
return fmt.Errorf("%w: %s", xErrUnsupported, with.op)
|
|
||||||
}
|
|
||||||
if with.bufsize < 4096 {
|
|
||||||
return fmt.Errorf("fsnotify.WithBufferSize: buffer size cannot be smaller than 4096 bytes")
|
|
||||||
}
|
|
||||||
|
|
||||||
in := &input{
|
|
||||||
op: opAddWatch,
|
|
||||||
path: filepath.Clean(name),
|
|
||||||
flags: sysFSALLEVENTS,
|
|
||||||
reply: make(chan error),
|
|
||||||
bufsize: with.bufsize,
|
|
||||||
}
|
|
||||||
w.input <- in
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-in.reply
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) Remove(name string) error {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if debug {
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s Remove(%q)\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), filepath.ToSlash(name))
|
|
||||||
}
|
|
||||||
|
|
||||||
in := &input{
|
|
||||||
op: opRemoveWatch,
|
|
||||||
path: filepath.Clean(name),
|
|
||||||
reply: make(chan error),
|
|
||||||
}
|
|
||||||
w.input <- in
|
|
||||||
if err := w.wakeupReader(); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return <-in.reply
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) WatchList() []string {
|
|
||||||
if w.isClosed() {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
|
|
||||||
entries := make([]string, 0, len(w.watches))
|
|
||||||
for _, entry := range w.watches {
|
|
||||||
for _, watchEntry := range entry {
|
|
||||||
for name := range watchEntry.names {
|
|
||||||
entries = append(entries, filepath.Join(watchEntry.path, name))
|
|
||||||
}
|
|
||||||
// the directory itself is being watched
|
|
||||||
if watchEntry.mask != 0 {
|
|
||||||
entries = append(entries, watchEntry.path)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return entries
|
|
||||||
}
|
|
||||||
|
|
||||||
// These options are from the old golang.org/x/exp/winfsnotify, where you could
|
|
||||||
// add various options to the watch. This has long since been removed.
|
|
||||||
//
|
|
||||||
// The "sys" in the name is misleading as they're not part of any "system".
|
|
||||||
//
|
|
||||||
// This should all be removed at some point, and just use windows.FILE_NOTIFY_*
|
|
||||||
const (
|
|
||||||
sysFSALLEVENTS = 0xfff
|
|
||||||
sysFSCREATE = 0x100
|
|
||||||
sysFSDELETE = 0x200
|
|
||||||
sysFSDELETESELF = 0x400
|
|
||||||
sysFSMODIFY = 0x2
|
|
||||||
sysFSMOVE = 0xc0
|
|
||||||
sysFSMOVEDFROM = 0x40
|
|
||||||
sysFSMOVEDTO = 0x80
|
|
||||||
sysFSMOVESELF = 0x800
|
|
||||||
sysFSIGNORED = 0x8000
|
|
||||||
)
|
|
||||||
|
|
||||||
func (w *readDirChangesW) newEvent(name string, mask uint32) Event {
|
|
||||||
e := Event{Name: name}
|
|
||||||
if mask&sysFSCREATE == sysFSCREATE || mask&sysFSMOVEDTO == sysFSMOVEDTO {
|
|
||||||
e.Op |= Create
|
|
||||||
}
|
|
||||||
if mask&sysFSDELETE == sysFSDELETE || mask&sysFSDELETESELF == sysFSDELETESELF {
|
|
||||||
e.Op |= Remove
|
|
||||||
}
|
|
||||||
if mask&sysFSMODIFY == sysFSMODIFY {
|
|
||||||
e.Op |= Write
|
|
||||||
}
|
|
||||||
if mask&sysFSMOVE == sysFSMOVE || mask&sysFSMOVESELF == sysFSMOVESELF || mask&sysFSMOVEDFROM == sysFSMOVEDFROM {
|
|
||||||
e.Op |= Rename
|
|
||||||
}
|
|
||||||
return e
|
|
||||||
}
|
|
||||||
|
|
||||||
const (
|
|
||||||
opAddWatch = iota
|
|
||||||
opRemoveWatch
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
provisional uint64 = 1 << (32 + iota)
|
|
||||||
)
|
|
||||||
|
|
||||||
type input struct {
|
|
||||||
op int
|
|
||||||
path string
|
|
||||||
flags uint32
|
|
||||||
bufsize int
|
|
||||||
reply chan error
|
|
||||||
}
|
|
||||||
|
|
||||||
type inode struct {
|
|
||||||
handle windows.Handle
|
|
||||||
volume uint32
|
|
||||||
index uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
type watch struct {
|
|
||||||
ov windows.Overlapped
|
|
||||||
ino *inode // i-number
|
|
||||||
recurse bool // Recursive watch?
|
|
||||||
path string // Directory path
|
|
||||||
mask uint64 // Directory itself is being watched with these notify flags
|
|
||||||
names map[string]uint64 // Map of names being watched and their notify flags
|
|
||||||
rename string // Remembers the old name while renaming a file
|
|
||||||
buf []byte // buffer, allocated later
|
|
||||||
}
|
|
||||||
|
|
||||||
type (
|
|
||||||
indexMap map[uint64]*watch
|
|
||||||
watchMap map[uint32]indexMap
|
|
||||||
)
|
|
||||||
|
|
||||||
func (w *readDirChangesW) wakeupReader() error {
|
|
||||||
err := windows.PostQueuedCompletionStatus(w.port, 0, 0, nil)
|
|
||||||
if err != nil {
|
|
||||||
return os.NewSyscallError("PostQueuedCompletionStatus", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) getDir(pathname string) (dir string, err error) {
|
|
||||||
attr, err := windows.GetFileAttributes(windows.StringToUTF16Ptr(pathname))
|
|
||||||
if err != nil {
|
|
||||||
return "", os.NewSyscallError("GetFileAttributes", err)
|
|
||||||
}
|
|
||||||
if attr&windows.FILE_ATTRIBUTE_DIRECTORY != 0 {
|
|
||||||
dir = pathname
|
|
||||||
} else {
|
|
||||||
dir, _ = filepath.Split(pathname)
|
|
||||||
dir = filepath.Clean(dir)
|
|
||||||
}
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) getIno(path string) (ino *inode, err error) {
|
|
||||||
h, err := windows.CreateFile(windows.StringToUTF16Ptr(path),
|
|
||||||
windows.FILE_LIST_DIRECTORY,
|
|
||||||
windows.FILE_SHARE_READ|windows.FILE_SHARE_WRITE|windows.FILE_SHARE_DELETE,
|
|
||||||
nil, windows.OPEN_EXISTING,
|
|
||||||
windows.FILE_FLAG_BACKUP_SEMANTICS|windows.FILE_FLAG_OVERLAPPED, 0)
|
|
||||||
if err != nil {
|
|
||||||
return nil, os.NewSyscallError("CreateFile", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var fi windows.ByHandleFileInformation
|
|
||||||
err = windows.GetFileInformationByHandle(h, &fi)
|
|
||||||
if err != nil {
|
|
||||||
windows.CloseHandle(h)
|
|
||||||
return nil, os.NewSyscallError("GetFileInformationByHandle", err)
|
|
||||||
}
|
|
||||||
ino = &inode{
|
|
||||||
handle: h,
|
|
||||||
volume: fi.VolumeSerialNumber,
|
|
||||||
index: uint64(fi.FileIndexHigh)<<32 | uint64(fi.FileIndexLow),
|
|
||||||
}
|
|
||||||
return ino, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (m watchMap) get(ino *inode) *watch {
|
|
||||||
if i := m[ino.volume]; i != nil {
|
|
||||||
return i[ino.index]
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (m watchMap) set(ino *inode, watch *watch) {
|
|
||||||
i := m[ino.volume]
|
|
||||||
if i == nil {
|
|
||||||
i = make(indexMap)
|
|
||||||
m[ino.volume] = i
|
|
||||||
}
|
|
||||||
i[ino.index] = watch
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *readDirChangesW) addWatch(pathname string, flags uint64, bufsize int) error {
|
|
||||||
pathname, recurse := recursivePath(pathname)
|
|
||||||
|
|
||||||
dir, err := w.getDir(pathname)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
ino, err := w.getIno(dir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
watchEntry := w.watches.get(ino)
|
|
||||||
w.mu.Unlock()
|
|
||||||
if watchEntry == nil {
|
|
||||||
_, err := windows.CreateIoCompletionPort(ino.handle, w.port, 0, 0)
|
|
||||||
if err != nil {
|
|
||||||
windows.CloseHandle(ino.handle)
|
|
||||||
return os.NewSyscallError("CreateIoCompletionPort", err)
|
|
||||||
}
|
|
||||||
watchEntry = &watch{
|
|
||||||
ino: ino,
|
|
||||||
path: dir,
|
|
||||||
names: make(map[string]uint64),
|
|
||||||
recurse: recurse,
|
|
||||||
buf: make([]byte, bufsize),
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
w.watches.set(ino, watchEntry)
|
|
||||||
w.mu.Unlock()
|
|
||||||
flags |= provisional
|
|
||||||
} else {
|
|
||||||
windows.CloseHandle(ino.handle)
|
|
||||||
}
|
|
||||||
if pathname == dir {
|
|
||||||
watchEntry.mask |= flags
|
|
||||||
} else {
|
|
||||||
watchEntry.names[filepath.Base(pathname)] |= flags
|
|
||||||
}
|
|
||||||
|
|
||||||
err = w.startRead(watchEntry)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if pathname == dir {
|
|
||||||
watchEntry.mask &= ^provisional
|
|
||||||
} else {
|
|
||||||
watchEntry.names[filepath.Base(pathname)] &= ^provisional
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *readDirChangesW) remWatch(pathname string) error {
|
|
||||||
pathname, recurse := recursivePath(pathname)
|
|
||||||
|
|
||||||
dir, err := w.getDir(pathname)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
ino, err := w.getIno(dir)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
w.mu.Lock()
|
|
||||||
watch := w.watches.get(ino)
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if recurse && !watch.recurse {
|
|
||||||
return fmt.Errorf("can't use \\... with non-recursive watch %q", pathname)
|
|
||||||
}
|
|
||||||
|
|
||||||
err = windows.CloseHandle(ino.handle)
|
|
||||||
if err != nil {
|
|
||||||
w.sendError(os.NewSyscallError("CloseHandle", err))
|
|
||||||
}
|
|
||||||
if watch == nil {
|
|
||||||
return fmt.Errorf("%w: %s", ErrNonExistentWatch, pathname)
|
|
||||||
}
|
|
||||||
if pathname == dir {
|
|
||||||
w.sendEvent(watch.path, "", watch.mask&sysFSIGNORED)
|
|
||||||
watch.mask = 0
|
|
||||||
} else {
|
|
||||||
name := filepath.Base(pathname)
|
|
||||||
w.sendEvent(filepath.Join(watch.path, name), "", watch.names[name]&sysFSIGNORED)
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
return w.startRead(watch)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *readDirChangesW) deleteWatch(watch *watch) {
|
|
||||||
for name, mask := range watch.names {
|
|
||||||
if mask&provisional == 0 {
|
|
||||||
w.sendEvent(filepath.Join(watch.path, name), "", mask&sysFSIGNORED)
|
|
||||||
}
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
if watch.mask != 0 {
|
|
||||||
if watch.mask&provisional == 0 {
|
|
||||||
w.sendEvent(watch.path, "", watch.mask&sysFSIGNORED)
|
|
||||||
}
|
|
||||||
watch.mask = 0
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Must run within the I/O thread.
|
|
||||||
func (w *readDirChangesW) startRead(watch *watch) error {
|
|
||||||
err := windows.CancelIo(watch.ino.handle)
|
|
||||||
if err != nil {
|
|
||||||
w.sendError(os.NewSyscallError("CancelIo", err))
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
}
|
|
||||||
mask := w.toWindowsFlags(watch.mask)
|
|
||||||
for _, m := range watch.names {
|
|
||||||
mask |= w.toWindowsFlags(m)
|
|
||||||
}
|
|
||||||
if mask == 0 {
|
|
||||||
err := windows.CloseHandle(watch.ino.handle)
|
|
||||||
if err != nil {
|
|
||||||
w.sendError(os.NewSyscallError("CloseHandle", err))
|
|
||||||
}
|
|
||||||
w.mu.Lock()
|
|
||||||
delete(w.watches[watch.ino.volume], watch.ino.index)
|
|
||||||
w.mu.Unlock()
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// We need to pass the array, rather than the slice.
|
|
||||||
hdr := (*reflect.SliceHeader)(unsafe.Pointer(&watch.buf))
|
|
||||||
rdErr := windows.ReadDirectoryChanges(watch.ino.handle,
|
|
||||||
(*byte)(unsafe.Pointer(hdr.Data)), uint32(hdr.Len),
|
|
||||||
watch.recurse, mask, nil, &watch.ov, 0)
|
|
||||||
if rdErr != nil {
|
|
||||||
err := os.NewSyscallError("ReadDirectoryChanges", rdErr)
|
|
||||||
if rdErr == windows.ERROR_ACCESS_DENIED && watch.mask&provisional == 0 {
|
|
||||||
// Watched directory was probably removed
|
|
||||||
w.sendEvent(watch.path, "", watch.mask&sysFSDELETESELF)
|
|
||||||
err = nil
|
|
||||||
}
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// readEvents reads from the I/O completion port, converts the
|
|
||||||
// received events into Event objects and sends them via the Events channel.
|
|
||||||
// Entry point to the I/O thread.
|
|
||||||
func (w *readDirChangesW) readEvents() {
|
|
||||||
var (
|
|
||||||
n uint32
|
|
||||||
key uintptr
|
|
||||||
ov *windows.Overlapped
|
|
||||||
)
|
|
||||||
runtime.LockOSThread()
|
|
||||||
|
|
||||||
for {
|
|
||||||
// This error is handled after the watch == nil check below.
|
|
||||||
qErr := windows.GetQueuedCompletionStatus(w.port, &n, &key, &ov, windows.INFINITE)
|
|
||||||
|
|
||||||
watch := (*watch)(unsafe.Pointer(ov))
|
|
||||||
if watch == nil {
|
|
||||||
select {
|
|
||||||
case ch := <-w.done:
|
|
||||||
w.mu.Lock()
|
|
||||||
var indexes []indexMap
|
|
||||||
for _, index := range w.watches {
|
|
||||||
indexes = append(indexes, index)
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
for _, index := range indexes {
|
|
||||||
for _, watch := range index {
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
err := windows.CloseHandle(w.port)
|
|
||||||
if err != nil {
|
|
||||||
err = os.NewSyscallError("CloseHandle", err)
|
|
||||||
}
|
|
||||||
close(w.Events)
|
|
||||||
close(w.Errors)
|
|
||||||
ch <- err
|
|
||||||
return
|
|
||||||
case in := <-w.input:
|
|
||||||
switch in.op {
|
|
||||||
case opAddWatch:
|
|
||||||
in.reply <- w.addWatch(in.path, uint64(in.flags), in.bufsize)
|
|
||||||
case opRemoveWatch:
|
|
||||||
in.reply <- w.remWatch(in.path)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
switch qErr {
|
|
||||||
case nil:
|
|
||||||
// No error
|
|
||||||
case windows.ERROR_MORE_DATA:
|
|
||||||
if watch == nil {
|
|
||||||
w.sendError(errors.New("ERROR_MORE_DATA has unexpectedly null lpOverlapped buffer"))
|
|
||||||
} else {
|
|
||||||
// The i/o succeeded but the buffer is full.
|
|
||||||
// In theory we should be building up a full packet.
|
|
||||||
// In practice we can get away with just carrying on.
|
|
||||||
n = uint32(unsafe.Sizeof(watch.buf))
|
|
||||||
}
|
|
||||||
case windows.ERROR_ACCESS_DENIED:
|
|
||||||
// Watched directory was probably removed
|
|
||||||
w.sendEvent(watch.path, "", watch.mask&sysFSDELETESELF)
|
|
||||||
w.deleteWatch(watch)
|
|
||||||
w.startRead(watch)
|
|
||||||
continue
|
|
||||||
case windows.ERROR_OPERATION_ABORTED:
|
|
||||||
// CancelIo was called on this handle
|
|
||||||
continue
|
|
||||||
default:
|
|
||||||
w.sendError(os.NewSyscallError("GetQueuedCompletionPort", qErr))
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
var offset uint32
|
|
||||||
for {
|
|
||||||
if n == 0 {
|
|
||||||
w.sendError(ErrEventOverflow)
|
|
||||||
break
|
|
||||||
}
|
|
||||||
|
|
||||||
// Point "raw" to the event in the buffer
|
|
||||||
raw := (*windows.FileNotifyInformation)(unsafe.Pointer(&watch.buf[offset]))
|
|
||||||
|
|
||||||
// Create a buf that is the size of the path name
|
|
||||||
size := int(raw.FileNameLength / 2)
|
|
||||||
var buf []uint16
|
|
||||||
// TODO: Use unsafe.Slice in Go 1.17; https://stackoverflow.com/questions/51187973
|
|
||||||
sh := (*reflect.SliceHeader)(unsafe.Pointer(&buf))
|
|
||||||
sh.Data = uintptr(unsafe.Pointer(&raw.FileName))
|
|
||||||
sh.Len = size
|
|
||||||
sh.Cap = size
|
|
||||||
name := windows.UTF16ToString(buf)
|
|
||||||
fullname := filepath.Join(watch.path, name)
|
|
||||||
|
|
||||||
if debug {
|
|
||||||
internal.Debug(fullname, raw.Action)
|
|
||||||
}
|
|
||||||
|
|
||||||
var mask uint64
|
|
||||||
switch raw.Action {
|
|
||||||
case windows.FILE_ACTION_REMOVED:
|
|
||||||
mask = sysFSDELETESELF
|
|
||||||
case windows.FILE_ACTION_MODIFIED:
|
|
||||||
mask = sysFSMODIFY
|
|
||||||
case windows.FILE_ACTION_RENAMED_OLD_NAME:
|
|
||||||
watch.rename = name
|
|
||||||
case windows.FILE_ACTION_RENAMED_NEW_NAME:
|
|
||||||
// Update saved path of all sub-watches.
|
|
||||||
old := filepath.Join(watch.path, watch.rename)
|
|
||||||
w.mu.Lock()
|
|
||||||
for _, watchMap := range w.watches {
|
|
||||||
for _, ww := range watchMap {
|
|
||||||
if strings.HasPrefix(ww.path, old) {
|
|
||||||
ww.path = filepath.Join(fullname, strings.TrimPrefix(ww.path, old))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
w.mu.Unlock()
|
|
||||||
|
|
||||||
if watch.names[watch.rename] != 0 {
|
|
||||||
watch.names[name] |= watch.names[watch.rename]
|
|
||||||
delete(watch.names, watch.rename)
|
|
||||||
mask = sysFSMOVESELF
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if raw.Action != windows.FILE_ACTION_RENAMED_NEW_NAME {
|
|
||||||
w.sendEvent(fullname, "", watch.names[name]&mask)
|
|
||||||
}
|
|
||||||
if raw.Action == windows.FILE_ACTION_REMOVED {
|
|
||||||
w.sendEvent(fullname, "", watch.names[name]&sysFSIGNORED)
|
|
||||||
delete(watch.names, name)
|
|
||||||
}
|
|
||||||
|
|
||||||
if watch.rename != "" && raw.Action == windows.FILE_ACTION_RENAMED_NEW_NAME {
|
|
||||||
w.sendEvent(fullname, filepath.Join(watch.path, watch.rename), watch.mask&w.toFSnotifyFlags(raw.Action))
|
|
||||||
} else {
|
|
||||||
w.sendEvent(fullname, "", watch.mask&w.toFSnotifyFlags(raw.Action))
|
|
||||||
}
|
|
||||||
|
|
||||||
if raw.Action == windows.FILE_ACTION_RENAMED_NEW_NAME {
|
|
||||||
w.sendEvent(filepath.Join(watch.path, watch.rename), "", watch.names[name]&mask)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Move to the next event in the buffer
|
|
||||||
if raw.NextEntryOffset == 0 {
|
|
||||||
break
|
|
||||||
}
|
|
||||||
offset += raw.NextEntryOffset
|
|
||||||
|
|
||||||
// Error!
|
|
||||||
if offset >= n {
|
|
||||||
//lint:ignore ST1005 Windows should be capitalized
|
|
||||||
w.sendError(errors.New("Windows system assumed buffer larger than it is, events have likely been missed"))
|
|
||||||
break
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := w.startRead(watch); err != nil {
|
|
||||||
w.sendError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) toWindowsFlags(mask uint64) uint32 {
|
|
||||||
var m uint32
|
|
||||||
if mask&sysFSMODIFY != 0 {
|
|
||||||
m |= windows.FILE_NOTIFY_CHANGE_LAST_WRITE
|
|
||||||
}
|
|
||||||
if mask&(sysFSMOVE|sysFSCREATE|sysFSDELETE) != 0 {
|
|
||||||
m |= windows.FILE_NOTIFY_CHANGE_FILE_NAME | windows.FILE_NOTIFY_CHANGE_DIR_NAME
|
|
||||||
}
|
|
||||||
return m
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) toFSnotifyFlags(action uint32) uint64 {
|
|
||||||
switch action {
|
|
||||||
case windows.FILE_ACTION_ADDED:
|
|
||||||
return sysFSCREATE
|
|
||||||
case windows.FILE_ACTION_REMOVED:
|
|
||||||
return sysFSDELETE
|
|
||||||
case windows.FILE_ACTION_MODIFIED:
|
|
||||||
return sysFSMODIFY
|
|
||||||
case windows.FILE_ACTION_RENAMED_OLD_NAME:
|
|
||||||
return sysFSMOVEDFROM
|
|
||||||
case windows.FILE_ACTION_RENAMED_NEW_NAME:
|
|
||||||
return sysFSMOVEDTO
|
|
||||||
}
|
|
||||||
return 0
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *readDirChangesW) xSupports(op Op) bool {
|
|
||||||
if op.Has(xUnportableOpen) || op.Has(xUnportableRead) ||
|
|
||||||
op.Has(xUnportableCloseWrite) || op.Has(xUnportableCloseRead) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
-496
@@ -1,496 +0,0 @@
|
|||||||
// Package fsnotify provides a cross-platform interface for file system
|
|
||||||
// notifications.
|
|
||||||
//
|
|
||||||
// Currently supported systems:
|
|
||||||
//
|
|
||||||
// - Linux via inotify
|
|
||||||
// - BSD, macOS via kqueue
|
|
||||||
// - Windows via ReadDirectoryChangesW
|
|
||||||
// - illumos via FEN
|
|
||||||
//
|
|
||||||
// # FSNOTIFY_DEBUG
|
|
||||||
//
|
|
||||||
// Set the FSNOTIFY_DEBUG environment variable to "1" to print debug messages to
|
|
||||||
// stderr. This can be useful to track down some problems, especially in cases
|
|
||||||
// where fsnotify is used as an indirect dependency.
|
|
||||||
//
|
|
||||||
// Every event will be printed as soon as there's something useful to print,
|
|
||||||
// with as little processing from fsnotify.
|
|
||||||
//
|
|
||||||
// Example output:
|
|
||||||
//
|
|
||||||
// FSNOTIFY_DEBUG: 11:34:23.633087586 256:IN_CREATE → "/tmp/file-1"
|
|
||||||
// FSNOTIFY_DEBUG: 11:34:23.633202319 4:IN_ATTRIB → "/tmp/file-1"
|
|
||||||
// FSNOTIFY_DEBUG: 11:34:28.989728764 512:IN_DELETE → "/tmp/file-1"
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Watcher watches a set of paths, delivering events on a channel.
|
|
||||||
//
|
|
||||||
// A watcher should not be copied (e.g. pass it by pointer, rather than by
|
|
||||||
// value).
|
|
||||||
//
|
|
||||||
// # Linux notes
|
|
||||||
//
|
|
||||||
// When a file is removed a Remove event won't be emitted until all file
|
|
||||||
// descriptors are closed, and deletes will always emit a Chmod. For example:
|
|
||||||
//
|
|
||||||
// fp := os.Open("file")
|
|
||||||
// os.Remove("file") // Triggers Chmod
|
|
||||||
// fp.Close() // Triggers Remove
|
|
||||||
//
|
|
||||||
// This is the event that inotify sends, so not much can be changed about this.
|
|
||||||
//
|
|
||||||
// The fs.inotify.max_user_watches sysctl variable specifies the upper limit
|
|
||||||
// for the number of watches per user, and fs.inotify.max_user_instances
|
|
||||||
// specifies the maximum number of inotify instances per user. Every Watcher you
|
|
||||||
// create is an "instance", and every path you add is a "watch".
|
|
||||||
//
|
|
||||||
// These are also exposed in /proc as /proc/sys/fs/inotify/max_user_watches and
|
|
||||||
// /proc/sys/fs/inotify/max_user_instances
|
|
||||||
//
|
|
||||||
// To increase them you can use sysctl or write the value to the /proc file:
|
|
||||||
//
|
|
||||||
// # Default values on Linux 5.18
|
|
||||||
// sysctl fs.inotify.max_user_watches=124983
|
|
||||||
// sysctl fs.inotify.max_user_instances=128
|
|
||||||
//
|
|
||||||
// To make the changes persist on reboot edit /etc/sysctl.conf or
|
|
||||||
// /usr/lib/sysctl.d/50-default.conf (details differ per Linux distro; check
|
|
||||||
// your distro's documentation):
|
|
||||||
//
|
|
||||||
// fs.inotify.max_user_watches=124983
|
|
||||||
// fs.inotify.max_user_instances=128
|
|
||||||
//
|
|
||||||
// Reaching the limit will result in a "no space left on device" or "too many open
|
|
||||||
// files" error.
|
|
||||||
//
|
|
||||||
// # kqueue notes (macOS, BSD)
|
|
||||||
//
|
|
||||||
// kqueue requires opening a file descriptor for every file that's being watched;
|
|
||||||
// so if you're watching a directory with five files then that's six file
|
|
||||||
// descriptors. You will run in to your system's "max open files" limit faster on
|
|
||||||
// these platforms.
|
|
||||||
//
|
|
||||||
// The sysctl variables kern.maxfiles and kern.maxfilesperproc can be used to
|
|
||||||
// control the maximum number of open files, as well as /etc/login.conf on BSD
|
|
||||||
// systems.
|
|
||||||
//
|
|
||||||
// # Windows notes
|
|
||||||
//
|
|
||||||
// Paths can be added as "C:\\path\\to\\dir", but forward slashes
|
|
||||||
// ("C:/path/to/dir") will also work.
|
|
||||||
//
|
|
||||||
// When a watched directory is removed it will always send an event for the
|
|
||||||
// directory itself, but may not send events for all files in that directory.
|
|
||||||
// Sometimes it will send events for all files, sometimes it will send no
|
|
||||||
// events, and often only for some files.
|
|
||||||
//
|
|
||||||
// The default ReadDirectoryChangesW() buffer size is 64K, which is the largest
|
|
||||||
// value that is guaranteed to work with SMB filesystems. If you have many
|
|
||||||
// events in quick succession this may not be enough, and you will have to use
|
|
||||||
// [WithBufferSize] to increase the value.
|
|
||||||
type Watcher struct {
|
|
||||||
b backend
|
|
||||||
|
|
||||||
// Events sends the filesystem change events.
|
|
||||||
//
|
|
||||||
// fsnotify can send the following events; a "path" here can refer to a
|
|
||||||
// file, directory, symbolic link, or special file like a FIFO.
|
|
||||||
//
|
|
||||||
// fsnotify.Create A new path was created; this may be followed by one
|
|
||||||
// or more Write events if data also gets written to a
|
|
||||||
// file.
|
|
||||||
//
|
|
||||||
// fsnotify.Remove A path was removed.
|
|
||||||
//
|
|
||||||
// fsnotify.Rename A path was renamed. A rename is always sent with the
|
|
||||||
// old path as Event.Name, and a Create event will be
|
|
||||||
// sent with the new name. Renames are only sent for
|
|
||||||
// paths that are currently watched; e.g. moving an
|
|
||||||
// unmonitored file into a monitored directory will
|
|
||||||
// show up as just a Create. Similarly, renaming a file
|
|
||||||
// to outside a monitored directory will show up as
|
|
||||||
// only a Rename.
|
|
||||||
//
|
|
||||||
// fsnotify.Write A file or named pipe was written to. A Truncate will
|
|
||||||
// also trigger a Write. A single "write action"
|
|
||||||
// initiated by the user may show up as one or multiple
|
|
||||||
// writes, depending on when the system syncs things to
|
|
||||||
// disk. For example when compiling a large Go program
|
|
||||||
// you may get hundreds of Write events, and you may
|
|
||||||
// want to wait until you've stopped receiving them
|
|
||||||
// (see the dedup example in cmd/fsnotify).
|
|
||||||
//
|
|
||||||
// Some systems may send Write event for directories
|
|
||||||
// when the directory content changes.
|
|
||||||
//
|
|
||||||
// fsnotify.Chmod Attributes were changed. On Linux this is also sent
|
|
||||||
// when a file is removed (or more accurately, when a
|
|
||||||
// link to an inode is removed). On kqueue it's sent
|
|
||||||
// when a file is truncated. On Windows it's never
|
|
||||||
// sent.
|
|
||||||
Events chan Event
|
|
||||||
|
|
||||||
// Errors sends any errors.
|
|
||||||
Errors chan error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Event represents a file system notification.
|
|
||||||
type Event struct {
|
|
||||||
// Path to the file or directory.
|
|
||||||
//
|
|
||||||
// Paths are relative to the input; for example with Add("dir") the Name
|
|
||||||
// will be set to "dir/file" if you create that file, but if you use
|
|
||||||
// Add("/path/to/dir") it will be "/path/to/dir/file".
|
|
||||||
Name string
|
|
||||||
|
|
||||||
// File operation that triggered the event.
|
|
||||||
//
|
|
||||||
// This is a bitmask and some systems may send multiple operations at once.
|
|
||||||
// Use the Event.Has() method instead of comparing with ==.
|
|
||||||
Op Op
|
|
||||||
|
|
||||||
// Create events will have this set to the old path if it's a rename. This
|
|
||||||
// only works when both the source and destination are watched. It's not
|
|
||||||
// reliable when watching individual files, only directories.
|
|
||||||
//
|
|
||||||
// For example "mv /tmp/file /tmp/rename" will emit:
|
|
||||||
//
|
|
||||||
// Event{Op: Rename, Name: "/tmp/file"}
|
|
||||||
// Event{Op: Create, Name: "/tmp/rename", RenamedFrom: "/tmp/file"}
|
|
||||||
renamedFrom string
|
|
||||||
}
|
|
||||||
|
|
||||||
// Op describes a set of file operations.
|
|
||||||
type Op uint32
|
|
||||||
|
|
||||||
// The operations fsnotify can trigger; see the documentation on [Watcher] for a
|
|
||||||
// full description, and check them with [Event.Has].
|
|
||||||
const (
|
|
||||||
// A new pathname was created.
|
|
||||||
Create Op = 1 << iota
|
|
||||||
|
|
||||||
// The pathname was written to; this does *not* mean the write has finished,
|
|
||||||
// and a write can be followed by more writes.
|
|
||||||
Write
|
|
||||||
|
|
||||||
// The path was removed; any watches on it will be removed. Some "remove"
|
|
||||||
// operations may trigger a Rename if the file is actually moved (for
|
|
||||||
// example "remove to trash" is often a rename).
|
|
||||||
Remove
|
|
||||||
|
|
||||||
// The path was renamed to something else; any watches on it will be
|
|
||||||
// removed.
|
|
||||||
Rename
|
|
||||||
|
|
||||||
// File attributes were changed.
|
|
||||||
//
|
|
||||||
// It's generally not recommended to take action on this event, as it may
|
|
||||||
// get triggered very frequently by some software. For example, Spotlight
|
|
||||||
// indexing on macOS, anti-virus software, backup software, etc.
|
|
||||||
Chmod
|
|
||||||
|
|
||||||
// File descriptor was opened.
|
|
||||||
//
|
|
||||||
// Only works on Linux and FreeBSD.
|
|
||||||
xUnportableOpen
|
|
||||||
|
|
||||||
// File was read from.
|
|
||||||
//
|
|
||||||
// Only works on Linux and FreeBSD.
|
|
||||||
xUnportableRead
|
|
||||||
|
|
||||||
// File opened for writing was closed.
|
|
||||||
//
|
|
||||||
// Only works on Linux and FreeBSD.
|
|
||||||
//
|
|
||||||
// The advantage of using this over Write is that it's more reliable than
|
|
||||||
// waiting for Write events to stop. It's also faster (if you're not
|
|
||||||
// listening to Write events): copying a file of a few GB can easily
|
|
||||||
// generate tens of thousands of Write events in a short span of time.
|
|
||||||
xUnportableCloseWrite
|
|
||||||
|
|
||||||
// File opened for reading was closed.
|
|
||||||
//
|
|
||||||
// Only works on Linux and FreeBSD.
|
|
||||||
xUnportableCloseRead
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
// ErrNonExistentWatch is used when Remove() is called on a path that's not
|
|
||||||
// added.
|
|
||||||
ErrNonExistentWatch = errors.New("fsnotify: can't remove non-existent watch")
|
|
||||||
|
|
||||||
// ErrClosed is used when trying to operate on a closed Watcher.
|
|
||||||
ErrClosed = errors.New("fsnotify: watcher already closed")
|
|
||||||
|
|
||||||
// ErrEventOverflow is reported from the Errors channel when there are too
|
|
||||||
// many events:
|
|
||||||
//
|
|
||||||
// - inotify: inotify returns IN_Q_OVERFLOW – because there are too
|
|
||||||
// many queued events (the fs.inotify.max_queued_events
|
|
||||||
// sysctl can be used to increase this).
|
|
||||||
// - windows: The buffer size is too small; WithBufferSize() can be used to increase it.
|
|
||||||
// - kqueue, fen: Not used.
|
|
||||||
ErrEventOverflow = errors.New("fsnotify: queue or buffer overflow")
|
|
||||||
|
|
||||||
// ErrUnsupported is returned by AddWith() when WithOps() specified an
|
|
||||||
// Unportable event that's not supported on this platform.
|
|
||||||
//lint:ignore ST1012 not relevant
|
|
||||||
xErrUnsupported = errors.New("fsnotify: not supported with this backend")
|
|
||||||
)
|
|
||||||
|
|
||||||
// NewWatcher creates a new Watcher.
|
|
||||||
func NewWatcher() (*Watcher, error) {
|
|
||||||
ev, errs := make(chan Event, defaultBufferSize), make(chan error)
|
|
||||||
b, err := newBackend(ev, errs)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &Watcher{b: b, Events: ev, Errors: errs}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewBufferedWatcher creates a new Watcher with a buffered Watcher.Events
|
|
||||||
// channel.
|
|
||||||
//
|
|
||||||
// The main use case for this is situations with a very large number of events
|
|
||||||
// where the kernel buffer size can't be increased (e.g. due to lack of
|
|
||||||
// permissions). An unbuffered Watcher will perform better for almost all use
|
|
||||||
// cases, and whenever possible you will be better off increasing the kernel
|
|
||||||
// buffers instead of adding a large userspace buffer.
|
|
||||||
func NewBufferedWatcher(sz uint) (*Watcher, error) {
|
|
||||||
ev, errs := make(chan Event, sz), make(chan error)
|
|
||||||
b, err := newBackend(ev, errs)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &Watcher{b: b, Events: ev, Errors: errs}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Add starts monitoring the path for changes.
|
|
||||||
//
|
|
||||||
// A path can only be watched once; watching it more than once is a no-op and will
|
|
||||||
// not return an error. Paths that do not yet exist on the filesystem cannot be
|
|
||||||
// watched.
|
|
||||||
//
|
|
||||||
// A watch will be automatically removed if the watched path is deleted or
|
|
||||||
// renamed. The exception is the Windows backend, which doesn't remove the
|
|
||||||
// watcher on renames.
|
|
||||||
//
|
|
||||||
// Notifications on network filesystems (NFS, SMB, FUSE, etc.) or special
|
|
||||||
// filesystems (/proc, /sys, etc.) generally don't work.
|
|
||||||
//
|
|
||||||
// Returns [ErrClosed] if [Watcher.Close] was called.
|
|
||||||
//
|
|
||||||
// See [Watcher.AddWith] for a version that allows adding options.
|
|
||||||
//
|
|
||||||
// # Watching directories
|
|
||||||
//
|
|
||||||
// All files in a directory are monitored, including new files that are created
|
|
||||||
// after the watcher is started. Subdirectories are not watched (i.e. it's
|
|
||||||
// non-recursive).
|
|
||||||
//
|
|
||||||
// # Watching files
|
|
||||||
//
|
|
||||||
// Watching individual files (rather than directories) is generally not
|
|
||||||
// recommended as many programs (especially editors) update files atomically: it
|
|
||||||
// will write to a temporary file which is then moved to destination,
|
|
||||||
// overwriting the original (or some variant thereof). The watcher on the
|
|
||||||
// original file is now lost, as that no longer exists.
|
|
||||||
//
|
|
||||||
// The upshot of this is that a power failure or crash won't leave a
|
|
||||||
// half-written file.
|
|
||||||
//
|
|
||||||
// Watch the parent directory and use Event.Name to filter out files you're not
|
|
||||||
// interested in. There is an example of this in cmd/fsnotify/file.go.
|
|
||||||
func (w *Watcher) Add(path string) error { return w.b.Add(path) }
|
|
||||||
|
|
||||||
// AddWith is like [Watcher.Add], but allows adding options. When using Add()
|
|
||||||
// the defaults described below are used.
|
|
||||||
//
|
|
||||||
// Possible options are:
|
|
||||||
//
|
|
||||||
// - [WithBufferSize] sets the buffer size for the Windows backend; no-op on
|
|
||||||
// other platforms. The default is 64K (65536 bytes).
|
|
||||||
func (w *Watcher) AddWith(path string, opts ...addOpt) error { return w.b.AddWith(path, opts...) }
|
|
||||||
|
|
||||||
// Remove stops monitoring the path for changes.
|
|
||||||
//
|
|
||||||
// Directories are always removed non-recursively. For example, if you added
|
|
||||||
// /tmp/dir and /tmp/dir/subdir then you will need to remove both.
|
|
||||||
//
|
|
||||||
// Removing a path that has not yet been added returns [ErrNonExistentWatch].
|
|
||||||
//
|
|
||||||
// Returns nil if [Watcher.Close] was called.
|
|
||||||
func (w *Watcher) Remove(path string) error { return w.b.Remove(path) }
|
|
||||||
|
|
||||||
// Close removes all watches and closes the Events channel.
|
|
||||||
func (w *Watcher) Close() error { return w.b.Close() }
|
|
||||||
|
|
||||||
// WatchList returns all paths explicitly added with [Watcher.Add] (and are not
|
|
||||||
// yet removed).
|
|
||||||
//
|
|
||||||
// The order is undefined, and may differ per call. Returns nil if
|
|
||||||
// [Watcher.Close] was called.
|
|
||||||
func (w *Watcher) WatchList() []string { return w.b.WatchList() }
|
|
||||||
|
|
||||||
// Supports reports if all the listed operations are supported by this platform.
|
|
||||||
//
|
|
||||||
// Create, Write, Remove, Rename, and Chmod are always supported. It can only
|
|
||||||
// return false for an Op starting with Unportable.
|
|
||||||
func (w *Watcher) xSupports(op Op) bool { return w.b.xSupports(op) }
|
|
||||||
|
|
||||||
func (o Op) String() string {
|
|
||||||
var b strings.Builder
|
|
||||||
if o.Has(Create) {
|
|
||||||
b.WriteString("|CREATE")
|
|
||||||
}
|
|
||||||
if o.Has(Remove) {
|
|
||||||
b.WriteString("|REMOVE")
|
|
||||||
}
|
|
||||||
if o.Has(Write) {
|
|
||||||
b.WriteString("|WRITE")
|
|
||||||
}
|
|
||||||
if o.Has(xUnportableOpen) {
|
|
||||||
b.WriteString("|OPEN")
|
|
||||||
}
|
|
||||||
if o.Has(xUnportableRead) {
|
|
||||||
b.WriteString("|READ")
|
|
||||||
}
|
|
||||||
if o.Has(xUnportableCloseWrite) {
|
|
||||||
b.WriteString("|CLOSE_WRITE")
|
|
||||||
}
|
|
||||||
if o.Has(xUnportableCloseRead) {
|
|
||||||
b.WriteString("|CLOSE_READ")
|
|
||||||
}
|
|
||||||
if o.Has(Rename) {
|
|
||||||
b.WriteString("|RENAME")
|
|
||||||
}
|
|
||||||
if o.Has(Chmod) {
|
|
||||||
b.WriteString("|CHMOD")
|
|
||||||
}
|
|
||||||
if b.Len() == 0 {
|
|
||||||
return "[no events]"
|
|
||||||
}
|
|
||||||
return b.String()[1:]
|
|
||||||
}
|
|
||||||
|
|
||||||
// Has reports if this operation has the given operation.
|
|
||||||
func (o Op) Has(h Op) bool { return o&h != 0 }
|
|
||||||
|
|
||||||
// Has reports if this event has the given operation.
|
|
||||||
func (e Event) Has(op Op) bool { return e.Op.Has(op) }
|
|
||||||
|
|
||||||
// String returns a string representation of the event with their path.
|
|
||||||
func (e Event) String() string {
|
|
||||||
if e.renamedFrom != "" {
|
|
||||||
return fmt.Sprintf("%-13s %q ← %q", e.Op.String(), e.Name, e.renamedFrom)
|
|
||||||
}
|
|
||||||
return fmt.Sprintf("%-13s %q", e.Op.String(), e.Name)
|
|
||||||
}
|
|
||||||
|
|
||||||
type (
|
|
||||||
backend interface {
|
|
||||||
Add(string) error
|
|
||||||
AddWith(string, ...addOpt) error
|
|
||||||
Remove(string) error
|
|
||||||
WatchList() []string
|
|
||||||
Close() error
|
|
||||||
xSupports(Op) bool
|
|
||||||
}
|
|
||||||
addOpt func(opt *withOpts)
|
|
||||||
withOpts struct {
|
|
||||||
bufsize int
|
|
||||||
op Op
|
|
||||||
noFollow bool
|
|
||||||
sendCreate bool
|
|
||||||
}
|
|
||||||
)
|
|
||||||
|
|
||||||
var debug = func() bool {
|
|
||||||
// Check for exactly "1" (rather than mere existence) so we can add
|
|
||||||
// options/flags in the future. I don't know if we ever want that, but it's
|
|
||||||
// nice to leave the option open.
|
|
||||||
return os.Getenv("FSNOTIFY_DEBUG") == "1"
|
|
||||||
}()
|
|
||||||
|
|
||||||
var defaultOpts = withOpts{
|
|
||||||
bufsize: 65536, // 64K
|
|
||||||
op: Create | Write | Remove | Rename | Chmod,
|
|
||||||
}
|
|
||||||
|
|
||||||
func getOptions(opts ...addOpt) withOpts {
|
|
||||||
with := defaultOpts
|
|
||||||
for _, o := range opts {
|
|
||||||
if o != nil {
|
|
||||||
o(&with)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return with
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithBufferSize sets the [ReadDirectoryChangesW] buffer size.
|
|
||||||
//
|
|
||||||
// This only has effect on Windows systems, and is a no-op for other backends.
|
|
||||||
//
|
|
||||||
// The default value is 64K (65536 bytes) which is the highest value that works
|
|
||||||
// on all filesystems and should be enough for most applications, but if you
|
|
||||||
// have a large burst of events it may not be enough. You can increase it if
|
|
||||||
// you're hitting "queue or buffer overflow" errors ([ErrEventOverflow]).
|
|
||||||
//
|
|
||||||
// [ReadDirectoryChangesW]: https://learn.microsoft.com/en-gb/windows/win32/api/winbase/nf-winbase-readdirectorychangesw
|
|
||||||
func WithBufferSize(bytes int) addOpt {
|
|
||||||
return func(opt *withOpts) { opt.bufsize = bytes }
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithOps sets which operations to listen for. The default is [Create],
|
|
||||||
// [Write], [Remove], [Rename], and [Chmod].
|
|
||||||
//
|
|
||||||
// Excluding operations you're not interested in can save quite a bit of CPU
|
|
||||||
// time; in some use cases there may be hundreds of thousands of useless Write
|
|
||||||
// or Chmod operations per second.
|
|
||||||
//
|
|
||||||
// This can also be used to add unportable operations not supported by all
|
|
||||||
// platforms; unportable operations all start with "Unportable":
|
|
||||||
// [UnportableOpen], [UnportableRead], [UnportableCloseWrite], and
|
|
||||||
// [UnportableCloseRead].
|
|
||||||
//
|
|
||||||
// AddWith returns an error when using an unportable operation that's not
|
|
||||||
// supported. Use [Watcher.Support] to check for support.
|
|
||||||
func withOps(op Op) addOpt {
|
|
||||||
return func(opt *withOpts) { opt.op = op }
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithNoFollow disables following symlinks, so the symlinks themselves are
|
|
||||||
// watched.
|
|
||||||
func withNoFollow() addOpt {
|
|
||||||
return func(opt *withOpts) { opt.noFollow = true }
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Internal" option for recursive watches on inotify.
|
|
||||||
func withCreate() addOpt {
|
|
||||||
return func(opt *withOpts) { opt.sendCreate = true }
|
|
||||||
}
|
|
||||||
|
|
||||||
var enableRecurse = false
|
|
||||||
|
|
||||||
// Check if this path is recursive (ends with "/..." or "\..."), and return the
|
|
||||||
// path with the /... stripped.
|
|
||||||
func recursivePath(path string) (string, bool) {
|
|
||||||
path = filepath.Clean(path)
|
|
||||||
if !enableRecurse { // Only enabled in tests for now.
|
|
||||||
return path, false
|
|
||||||
}
|
|
||||||
if filepath.Base(path) == "..." {
|
|
||||||
return filepath.Dir(path), true
|
|
||||||
}
|
|
||||||
return path, false
|
|
||||||
}
|
|
||||||
-39
@@ -1,39 +0,0 @@
|
|||||||
//go:build darwin
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"syscall"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrSyscallEACCES = syscall.EACCES
|
|
||||||
ErrUnixEACCES = unix.EACCES
|
|
||||||
)
|
|
||||||
|
|
||||||
var maxfiles uint64
|
|
||||||
|
|
||||||
func SetRlimit() {
|
|
||||||
// Go 1.19 will do this automatically: https://go-review.googlesource.com/c/go/+/393354/
|
|
||||||
var l syscall.Rlimit
|
|
||||||
err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
if err == nil && l.Cur != l.Max {
|
|
||||||
l.Cur = l.Max
|
|
||||||
syscall.Setrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
}
|
|
||||||
maxfiles = l.Cur
|
|
||||||
|
|
||||||
if n, err := syscall.SysctlUint32("kern.maxfiles"); err == nil && uint64(n) < maxfiles {
|
|
||||||
maxfiles = uint64(n)
|
|
||||||
}
|
|
||||||
|
|
||||||
if n, err := syscall.SysctlUint32("kern.maxfilesperproc"); err == nil && uint64(n) < maxfiles {
|
|
||||||
maxfiles = uint64(n)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func Maxfiles() uint64 { return maxfiles }
|
|
||||||
func Mkfifo(path string, mode uint32) error { return unix.Mkfifo(path, mode) }
|
|
||||||
func Mknod(path string, mode uint32, dev int) error { return unix.Mknod(path, mode, dev) }
|
|
||||||
-57
@@ -1,57 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
var names = []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"NOTE_ABSOLUTE", unix.NOTE_ABSOLUTE},
|
|
||||||
{"NOTE_ATTRIB", unix.NOTE_ATTRIB},
|
|
||||||
{"NOTE_BACKGROUND", unix.NOTE_BACKGROUND},
|
|
||||||
{"NOTE_CHILD", unix.NOTE_CHILD},
|
|
||||||
{"NOTE_CRITICAL", unix.NOTE_CRITICAL},
|
|
||||||
{"NOTE_DELETE", unix.NOTE_DELETE},
|
|
||||||
{"NOTE_EXEC", unix.NOTE_EXEC},
|
|
||||||
{"NOTE_EXIT", unix.NOTE_EXIT},
|
|
||||||
{"NOTE_EXITSTATUS", unix.NOTE_EXITSTATUS},
|
|
||||||
{"NOTE_EXIT_CSERROR", unix.NOTE_EXIT_CSERROR},
|
|
||||||
{"NOTE_EXIT_DECRYPTFAIL", unix.NOTE_EXIT_DECRYPTFAIL},
|
|
||||||
{"NOTE_EXIT_DETAIL", unix.NOTE_EXIT_DETAIL},
|
|
||||||
{"NOTE_EXIT_DETAIL_MASK", unix.NOTE_EXIT_DETAIL_MASK},
|
|
||||||
{"NOTE_EXIT_MEMORY", unix.NOTE_EXIT_MEMORY},
|
|
||||||
{"NOTE_EXIT_REPARENTED", unix.NOTE_EXIT_REPARENTED},
|
|
||||||
{"NOTE_EXTEND", unix.NOTE_EXTEND},
|
|
||||||
{"NOTE_FFAND", unix.NOTE_FFAND},
|
|
||||||
{"NOTE_FFCOPY", unix.NOTE_FFCOPY},
|
|
||||||
{"NOTE_FFCTRLMASK", unix.NOTE_FFCTRLMASK},
|
|
||||||
{"NOTE_FFLAGSMASK", unix.NOTE_FFLAGSMASK},
|
|
||||||
{"NOTE_FFNOP", unix.NOTE_FFNOP},
|
|
||||||
{"NOTE_FFOR", unix.NOTE_FFOR},
|
|
||||||
{"NOTE_FORK", unix.NOTE_FORK},
|
|
||||||
{"NOTE_FUNLOCK", unix.NOTE_FUNLOCK},
|
|
||||||
{"NOTE_LEEWAY", unix.NOTE_LEEWAY},
|
|
||||||
{"NOTE_LINK", unix.NOTE_LINK},
|
|
||||||
{"NOTE_LOWAT", unix.NOTE_LOWAT},
|
|
||||||
{"NOTE_MACHTIME", unix.NOTE_MACHTIME},
|
|
||||||
{"NOTE_MACH_CONTINUOUS_TIME", unix.NOTE_MACH_CONTINUOUS_TIME},
|
|
||||||
{"NOTE_NONE", unix.NOTE_NONE},
|
|
||||||
{"NOTE_NSECONDS", unix.NOTE_NSECONDS},
|
|
||||||
{"NOTE_OOB", unix.NOTE_OOB},
|
|
||||||
//{"NOTE_PCTRLMASK", unix.NOTE_PCTRLMASK}, -0x100000 (?!)
|
|
||||||
{"NOTE_PDATAMASK", unix.NOTE_PDATAMASK},
|
|
||||||
{"NOTE_REAP", unix.NOTE_REAP},
|
|
||||||
{"NOTE_RENAME", unix.NOTE_RENAME},
|
|
||||||
{"NOTE_REVOKE", unix.NOTE_REVOKE},
|
|
||||||
{"NOTE_SECONDS", unix.NOTE_SECONDS},
|
|
||||||
{"NOTE_SIGNAL", unix.NOTE_SIGNAL},
|
|
||||||
{"NOTE_TRACK", unix.NOTE_TRACK},
|
|
||||||
{"NOTE_TRACKERR", unix.NOTE_TRACKERR},
|
|
||||||
{"NOTE_TRIGGER", unix.NOTE_TRIGGER},
|
|
||||||
{"NOTE_USECONDS", unix.NOTE_USECONDS},
|
|
||||||
{"NOTE_VM_ERROR", unix.NOTE_VM_ERROR},
|
|
||||||
{"NOTE_VM_PRESSURE", unix.NOTE_VM_PRESSURE},
|
|
||||||
{"NOTE_VM_PRESSURE_SUDDEN_TERMINATE", unix.NOTE_VM_PRESSURE_SUDDEN_TERMINATE},
|
|
||||||
{"NOTE_VM_PRESSURE_TERMINATE", unix.NOTE_VM_PRESSURE_TERMINATE},
|
|
||||||
{"NOTE_WRITE", unix.NOTE_WRITE},
|
|
||||||
}
|
|
||||||
-33
@@ -1,33 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
var names = []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"NOTE_ATTRIB", unix.NOTE_ATTRIB},
|
|
||||||
{"NOTE_CHILD", unix.NOTE_CHILD},
|
|
||||||
{"NOTE_DELETE", unix.NOTE_DELETE},
|
|
||||||
{"NOTE_EXEC", unix.NOTE_EXEC},
|
|
||||||
{"NOTE_EXIT", unix.NOTE_EXIT},
|
|
||||||
{"NOTE_EXTEND", unix.NOTE_EXTEND},
|
|
||||||
{"NOTE_FFAND", unix.NOTE_FFAND},
|
|
||||||
{"NOTE_FFCOPY", unix.NOTE_FFCOPY},
|
|
||||||
{"NOTE_FFCTRLMASK", unix.NOTE_FFCTRLMASK},
|
|
||||||
{"NOTE_FFLAGSMASK", unix.NOTE_FFLAGSMASK},
|
|
||||||
{"NOTE_FFNOP", unix.NOTE_FFNOP},
|
|
||||||
{"NOTE_FFOR", unix.NOTE_FFOR},
|
|
||||||
{"NOTE_FORK", unix.NOTE_FORK},
|
|
||||||
{"NOTE_LINK", unix.NOTE_LINK},
|
|
||||||
{"NOTE_LOWAT", unix.NOTE_LOWAT},
|
|
||||||
{"NOTE_OOB", unix.NOTE_OOB},
|
|
||||||
{"NOTE_PCTRLMASK", unix.NOTE_PCTRLMASK},
|
|
||||||
{"NOTE_PDATAMASK", unix.NOTE_PDATAMASK},
|
|
||||||
{"NOTE_RENAME", unix.NOTE_RENAME},
|
|
||||||
{"NOTE_REVOKE", unix.NOTE_REVOKE},
|
|
||||||
{"NOTE_TRACK", unix.NOTE_TRACK},
|
|
||||||
{"NOTE_TRACKERR", unix.NOTE_TRACKERR},
|
|
||||||
{"NOTE_TRIGGER", unix.NOTE_TRIGGER},
|
|
||||||
{"NOTE_WRITE", unix.NOTE_WRITE},
|
|
||||||
}
|
|
||||||
-42
@@ -1,42 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
var names = []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"NOTE_ABSTIME", unix.NOTE_ABSTIME},
|
|
||||||
{"NOTE_ATTRIB", unix.NOTE_ATTRIB},
|
|
||||||
{"NOTE_CHILD", unix.NOTE_CHILD},
|
|
||||||
{"NOTE_CLOSE", unix.NOTE_CLOSE},
|
|
||||||
{"NOTE_CLOSE_WRITE", unix.NOTE_CLOSE_WRITE},
|
|
||||||
{"NOTE_DELETE", unix.NOTE_DELETE},
|
|
||||||
{"NOTE_EXEC", unix.NOTE_EXEC},
|
|
||||||
{"NOTE_EXIT", unix.NOTE_EXIT},
|
|
||||||
{"NOTE_EXTEND", unix.NOTE_EXTEND},
|
|
||||||
{"NOTE_FFAND", unix.NOTE_FFAND},
|
|
||||||
{"NOTE_FFCOPY", unix.NOTE_FFCOPY},
|
|
||||||
{"NOTE_FFCTRLMASK", unix.NOTE_FFCTRLMASK},
|
|
||||||
{"NOTE_FFLAGSMASK", unix.NOTE_FFLAGSMASK},
|
|
||||||
{"NOTE_FFNOP", unix.NOTE_FFNOP},
|
|
||||||
{"NOTE_FFOR", unix.NOTE_FFOR},
|
|
||||||
{"NOTE_FILE_POLL", unix.NOTE_FILE_POLL},
|
|
||||||
{"NOTE_FORK", unix.NOTE_FORK},
|
|
||||||
{"NOTE_LINK", unix.NOTE_LINK},
|
|
||||||
{"NOTE_LOWAT", unix.NOTE_LOWAT},
|
|
||||||
{"NOTE_MSECONDS", unix.NOTE_MSECONDS},
|
|
||||||
{"NOTE_NSECONDS", unix.NOTE_NSECONDS},
|
|
||||||
{"NOTE_OPEN", unix.NOTE_OPEN},
|
|
||||||
{"NOTE_PCTRLMASK", unix.NOTE_PCTRLMASK},
|
|
||||||
{"NOTE_PDATAMASK", unix.NOTE_PDATAMASK},
|
|
||||||
{"NOTE_READ", unix.NOTE_READ},
|
|
||||||
{"NOTE_RENAME", unix.NOTE_RENAME},
|
|
||||||
{"NOTE_REVOKE", unix.NOTE_REVOKE},
|
|
||||||
{"NOTE_SECONDS", unix.NOTE_SECONDS},
|
|
||||||
{"NOTE_TRACK", unix.NOTE_TRACK},
|
|
||||||
{"NOTE_TRACKERR", unix.NOTE_TRACKERR},
|
|
||||||
{"NOTE_TRIGGER", unix.NOTE_TRIGGER},
|
|
||||||
{"NOTE_USECONDS", unix.NOTE_USECONDS},
|
|
||||||
{"NOTE_WRITE", unix.NOTE_WRITE},
|
|
||||||
}
|
|
||||||
-32
@@ -1,32 +0,0 @@
|
|||||||
//go:build freebsd || openbsd || netbsd || dragonfly || darwin
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Debug(name string, kevent *unix.Kevent_t) {
|
|
||||||
mask := uint32(kevent.Fflags)
|
|
||||||
|
|
||||||
var (
|
|
||||||
l []string
|
|
||||||
unknown = mask
|
|
||||||
)
|
|
||||||
for _, n := range names {
|
|
||||||
if mask&n.m == n.m {
|
|
||||||
l = append(l, n.n)
|
|
||||||
unknown ^= n.m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if unknown > 0 {
|
|
||||||
l = append(l, fmt.Sprintf("0x%x", unknown))
|
|
||||||
}
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s %10d:%-60s → %q\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), mask, strings.Join(l, " | "), name)
|
|
||||||
}
|
|
||||||
-56
@@ -1,56 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Debug(name string, mask, cookie uint32) {
|
|
||||||
names := []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"IN_ACCESS", unix.IN_ACCESS},
|
|
||||||
{"IN_ATTRIB", unix.IN_ATTRIB},
|
|
||||||
{"IN_CLOSE", unix.IN_CLOSE},
|
|
||||||
{"IN_CLOSE_NOWRITE", unix.IN_CLOSE_NOWRITE},
|
|
||||||
{"IN_CLOSE_WRITE", unix.IN_CLOSE_WRITE},
|
|
||||||
{"IN_CREATE", unix.IN_CREATE},
|
|
||||||
{"IN_DELETE", unix.IN_DELETE},
|
|
||||||
{"IN_DELETE_SELF", unix.IN_DELETE_SELF},
|
|
||||||
{"IN_IGNORED", unix.IN_IGNORED},
|
|
||||||
{"IN_ISDIR", unix.IN_ISDIR},
|
|
||||||
{"IN_MODIFY", unix.IN_MODIFY},
|
|
||||||
{"IN_MOVE", unix.IN_MOVE},
|
|
||||||
{"IN_MOVED_FROM", unix.IN_MOVED_FROM},
|
|
||||||
{"IN_MOVED_TO", unix.IN_MOVED_TO},
|
|
||||||
{"IN_MOVE_SELF", unix.IN_MOVE_SELF},
|
|
||||||
{"IN_OPEN", unix.IN_OPEN},
|
|
||||||
{"IN_Q_OVERFLOW", unix.IN_Q_OVERFLOW},
|
|
||||||
{"IN_UNMOUNT", unix.IN_UNMOUNT},
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
l []string
|
|
||||||
unknown = mask
|
|
||||||
)
|
|
||||||
for _, n := range names {
|
|
||||||
if mask&n.m == n.m {
|
|
||||||
l = append(l, n.n)
|
|
||||||
unknown ^= n.m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if unknown > 0 {
|
|
||||||
l = append(l, fmt.Sprintf("0x%x", unknown))
|
|
||||||
}
|
|
||||||
var c string
|
|
||||||
if cookie > 0 {
|
|
||||||
c = fmt.Sprintf("(cookie: %d) ", cookie)
|
|
||||||
}
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s %-30s → %s%q\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), strings.Join(l, "|"), c, name)
|
|
||||||
}
|
|
||||||
-25
@@ -1,25 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
var names = []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"NOTE_ATTRIB", unix.NOTE_ATTRIB},
|
|
||||||
{"NOTE_CHILD", unix.NOTE_CHILD},
|
|
||||||
{"NOTE_DELETE", unix.NOTE_DELETE},
|
|
||||||
{"NOTE_EXEC", unix.NOTE_EXEC},
|
|
||||||
{"NOTE_EXIT", unix.NOTE_EXIT},
|
|
||||||
{"NOTE_EXTEND", unix.NOTE_EXTEND},
|
|
||||||
{"NOTE_FORK", unix.NOTE_FORK},
|
|
||||||
{"NOTE_LINK", unix.NOTE_LINK},
|
|
||||||
{"NOTE_LOWAT", unix.NOTE_LOWAT},
|
|
||||||
{"NOTE_PCTRLMASK", unix.NOTE_PCTRLMASK},
|
|
||||||
{"NOTE_PDATAMASK", unix.NOTE_PDATAMASK},
|
|
||||||
{"NOTE_RENAME", unix.NOTE_RENAME},
|
|
||||||
{"NOTE_REVOKE", unix.NOTE_REVOKE},
|
|
||||||
{"NOTE_TRACK", unix.NOTE_TRACK},
|
|
||||||
{"NOTE_TRACKERR", unix.NOTE_TRACKERR},
|
|
||||||
{"NOTE_WRITE", unix.NOTE_WRITE},
|
|
||||||
}
|
|
||||||
-28
@@ -1,28 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
var names = []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"NOTE_ATTRIB", unix.NOTE_ATTRIB},
|
|
||||||
// {"NOTE_CHANGE", unix.NOTE_CHANGE}, // Not on 386?
|
|
||||||
{"NOTE_CHILD", unix.NOTE_CHILD},
|
|
||||||
{"NOTE_DELETE", unix.NOTE_DELETE},
|
|
||||||
{"NOTE_EOF", unix.NOTE_EOF},
|
|
||||||
{"NOTE_EXEC", unix.NOTE_EXEC},
|
|
||||||
{"NOTE_EXIT", unix.NOTE_EXIT},
|
|
||||||
{"NOTE_EXTEND", unix.NOTE_EXTEND},
|
|
||||||
{"NOTE_FORK", unix.NOTE_FORK},
|
|
||||||
{"NOTE_LINK", unix.NOTE_LINK},
|
|
||||||
{"NOTE_LOWAT", unix.NOTE_LOWAT},
|
|
||||||
{"NOTE_PCTRLMASK", unix.NOTE_PCTRLMASK},
|
|
||||||
{"NOTE_PDATAMASK", unix.NOTE_PDATAMASK},
|
|
||||||
{"NOTE_RENAME", unix.NOTE_RENAME},
|
|
||||||
{"NOTE_REVOKE", unix.NOTE_REVOKE},
|
|
||||||
{"NOTE_TRACK", unix.NOTE_TRACK},
|
|
||||||
{"NOTE_TRACKERR", unix.NOTE_TRACKERR},
|
|
||||||
{"NOTE_TRUNCATE", unix.NOTE_TRUNCATE},
|
|
||||||
{"NOTE_WRITE", unix.NOTE_WRITE},
|
|
||||||
}
|
|
||||||
-45
@@ -1,45 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Debug(name string, mask int32) {
|
|
||||||
names := []struct {
|
|
||||||
n string
|
|
||||||
m int32
|
|
||||||
}{
|
|
||||||
{"FILE_ACCESS", unix.FILE_ACCESS},
|
|
||||||
{"FILE_MODIFIED", unix.FILE_MODIFIED},
|
|
||||||
{"FILE_ATTRIB", unix.FILE_ATTRIB},
|
|
||||||
{"FILE_TRUNC", unix.FILE_TRUNC},
|
|
||||||
{"FILE_NOFOLLOW", unix.FILE_NOFOLLOW},
|
|
||||||
{"FILE_DELETE", unix.FILE_DELETE},
|
|
||||||
{"FILE_RENAME_TO", unix.FILE_RENAME_TO},
|
|
||||||
{"FILE_RENAME_FROM", unix.FILE_RENAME_FROM},
|
|
||||||
{"UNMOUNTED", unix.UNMOUNTED},
|
|
||||||
{"MOUNTEDOVER", unix.MOUNTEDOVER},
|
|
||||||
{"FILE_EXCEPTION", unix.FILE_EXCEPTION},
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
l []string
|
|
||||||
unknown = mask
|
|
||||||
)
|
|
||||||
for _, n := range names {
|
|
||||||
if mask&n.m == n.m {
|
|
||||||
l = append(l, n.n)
|
|
||||||
unknown ^= n.m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if unknown > 0 {
|
|
||||||
l = append(l, fmt.Sprintf("0x%x", unknown))
|
|
||||||
}
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s %10d:%-30s → %q\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), mask, strings.Join(l, " | "), name)
|
|
||||||
}
|
|
||||||
-40
@@ -1,40 +0,0 @@
|
|||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"golang.org/x/sys/windows"
|
|
||||||
)
|
|
||||||
|
|
||||||
func Debug(name string, mask uint32) {
|
|
||||||
names := []struct {
|
|
||||||
n string
|
|
||||||
m uint32
|
|
||||||
}{
|
|
||||||
{"FILE_ACTION_ADDED", windows.FILE_ACTION_ADDED},
|
|
||||||
{"FILE_ACTION_REMOVED", windows.FILE_ACTION_REMOVED},
|
|
||||||
{"FILE_ACTION_MODIFIED", windows.FILE_ACTION_MODIFIED},
|
|
||||||
{"FILE_ACTION_RENAMED_OLD_NAME", windows.FILE_ACTION_RENAMED_OLD_NAME},
|
|
||||||
{"FILE_ACTION_RENAMED_NEW_NAME", windows.FILE_ACTION_RENAMED_NEW_NAME},
|
|
||||||
}
|
|
||||||
|
|
||||||
var (
|
|
||||||
l []string
|
|
||||||
unknown = mask
|
|
||||||
)
|
|
||||||
for _, n := range names {
|
|
||||||
if mask&n.m == n.m {
|
|
||||||
l = append(l, n.n)
|
|
||||||
unknown ^= n.m
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if unknown > 0 {
|
|
||||||
l = append(l, fmt.Sprintf("0x%x", unknown))
|
|
||||||
}
|
|
||||||
fmt.Fprintf(os.Stderr, "FSNOTIFY_DEBUG: %s %-65s → %q\n",
|
|
||||||
time.Now().Format("15:04:05.000000000"), strings.Join(l, " | "), filepath.ToSlash(name))
|
|
||||||
}
|
|
||||||
-31
@@ -1,31 +0,0 @@
|
|||||||
//go:build freebsd
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"syscall"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrSyscallEACCES = syscall.EACCES
|
|
||||||
ErrUnixEACCES = unix.EACCES
|
|
||||||
)
|
|
||||||
|
|
||||||
var maxfiles uint64
|
|
||||||
|
|
||||||
func SetRlimit() {
|
|
||||||
// Go 1.19 will do this automatically: https://go-review.googlesource.com/c/go/+/393354/
|
|
||||||
var l syscall.Rlimit
|
|
||||||
err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
if err == nil && l.Cur != l.Max {
|
|
||||||
l.Cur = l.Max
|
|
||||||
syscall.Setrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
}
|
|
||||||
maxfiles = uint64(l.Cur)
|
|
||||||
}
|
|
||||||
|
|
||||||
func Maxfiles() uint64 { return maxfiles }
|
|
||||||
func Mkfifo(path string, mode uint32) error { return unix.Mkfifo(path, mode) }
|
|
||||||
func Mknod(path string, mode uint32, dev int) error { return unix.Mknod(path, mode, uint64(dev)) }
|
|
||||||
-2
@@ -1,2 +0,0 @@
|
|||||||
// Package internal contains some helpers.
|
|
||||||
package internal
|
|
||||||
-31
@@ -1,31 +0,0 @@
|
|||||||
//go:build !windows && !darwin && !freebsd && !plan9
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"syscall"
|
|
||||||
|
|
||||||
"golang.org/x/sys/unix"
|
|
||||||
)
|
|
||||||
|
|
||||||
var (
|
|
||||||
ErrSyscallEACCES = syscall.EACCES
|
|
||||||
ErrUnixEACCES = unix.EACCES
|
|
||||||
)
|
|
||||||
|
|
||||||
var maxfiles uint64
|
|
||||||
|
|
||||||
func SetRlimit() {
|
|
||||||
// Go 1.19 will do this automatically: https://go-review.googlesource.com/c/go/+/393354/
|
|
||||||
var l syscall.Rlimit
|
|
||||||
err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
if err == nil && l.Cur != l.Max {
|
|
||||||
l.Cur = l.Max
|
|
||||||
syscall.Setrlimit(syscall.RLIMIT_NOFILE, &l)
|
|
||||||
}
|
|
||||||
maxfiles = uint64(l.Cur)
|
|
||||||
}
|
|
||||||
|
|
||||||
func Maxfiles() uint64 { return maxfiles }
|
|
||||||
func Mkfifo(path string, mode uint32) error { return unix.Mkfifo(path, mode) }
|
|
||||||
func Mknod(path string, mode uint32, dev int) error { return unix.Mknod(path, mode, dev) }
|
|
||||||
-7
@@ -1,7 +0,0 @@
|
|||||||
//go:build !windows
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
func HasPrivilegesForSymlink() bool {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
-41
@@ -1,41 +0,0 @@
|
|||||||
//go:build windows
|
|
||||||
|
|
||||||
package internal
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
|
|
||||||
"golang.org/x/sys/windows"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Just a dummy.
|
|
||||||
var (
|
|
||||||
ErrSyscallEACCES = errors.New("dummy")
|
|
||||||
ErrUnixEACCES = errors.New("dummy")
|
|
||||||
)
|
|
||||||
|
|
||||||
func SetRlimit() {}
|
|
||||||
func Maxfiles() uint64 { return 1<<64 - 1 }
|
|
||||||
func Mkfifo(path string, mode uint32) error { return errors.New("no FIFOs on Windows") }
|
|
||||||
func Mknod(path string, mode uint32, dev int) error { return errors.New("no device nodes on Windows") }
|
|
||||||
|
|
||||||
func HasPrivilegesForSymlink() bool {
|
|
||||||
var sid *windows.SID
|
|
||||||
err := windows.AllocateAndInitializeSid(
|
|
||||||
&windows.SECURITY_NT_AUTHORITY,
|
|
||||||
2,
|
|
||||||
windows.SECURITY_BUILTIN_DOMAIN_RID,
|
|
||||||
windows.DOMAIN_ALIAS_RID_ADMINS,
|
|
||||||
0, 0, 0, 0, 0, 0,
|
|
||||||
&sid)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
defer windows.FreeSid(sid)
|
|
||||||
token := windows.Token(0)
|
|
||||||
member, err := token.IsMember(sid)
|
|
||||||
if err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return member || token.IsElevated()
|
|
||||||
}
|
|
||||||
-64
@@ -1,64 +0,0 @@
|
|||||||
package fsnotify
|
|
||||||
|
|
||||||
import "sync"
|
|
||||||
|
|
||||||
type shared struct {
|
|
||||||
Events chan Event
|
|
||||||
Errors chan error
|
|
||||||
done chan struct{}
|
|
||||||
mu sync.Mutex
|
|
||||||
}
|
|
||||||
|
|
||||||
func newShared(ev chan Event, errs chan error) *shared {
|
|
||||||
return &shared{
|
|
||||||
Events: ev,
|
|
||||||
Errors: errs,
|
|
||||||
done: make(chan struct{}),
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Returns true if the event was sent, or false if watcher is closed.
|
|
||||||
func (w *shared) sendEvent(e Event) bool {
|
|
||||||
if e.Op == 0 {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
return false
|
|
||||||
case w.Events <- e:
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Returns true if the error was sent, or false if watcher is closed.
|
|
||||||
func (w *shared) sendError(err error) bool {
|
|
||||||
if err == nil {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
return false
|
|
||||||
case w.Errors <- err:
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *shared) isClosed() bool {
|
|
||||||
select {
|
|
||||||
case <-w.done:
|
|
||||||
return true
|
|
||||||
default:
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Mark as closed; returns true if it was already closed.
|
|
||||||
func (w *shared) close() bool {
|
|
||||||
w.mu.Lock()
|
|
||||||
defer w.mu.Unlock()
|
|
||||||
if w.isClosed() {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
close(w.done)
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
-3
@@ -1,3 +0,0 @@
|
|||||||
checks = ['all',
|
|
||||||
'-U1000', # Don't complain about unused functions.
|
|
||||||
]
|
|
||||||
-7
@@ -1,7 +0,0 @@
|
|||||||
//go:build freebsd || openbsd || netbsd || dragonfly
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
const openMode = unix.O_NONBLOCK | unix.O_RDONLY | unix.O_CLOEXEC
|
|
||||||
-8
@@ -1,8 +0,0 @@
|
|||||||
//go:build darwin
|
|
||||||
|
|
||||||
package fsnotify
|
|
||||||
|
|
||||||
import "golang.org/x/sys/unix"
|
|
||||||
|
|
||||||
// note: this constant is not defined on BSD
|
|
||||||
const openMode = unix.O_EVTONLY | unix.O_CLOEXEC
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
root = true
|
|
||||||
|
|
||||||
[*]
|
|
||||||
charset = utf-8
|
|
||||||
end_of_line = lf
|
|
||||||
indent_size = 4
|
|
||||||
indent_style = space
|
|
||||||
insert_final_newline = true
|
|
||||||
trim_trailing_whitespace = true
|
|
||||||
|
|
||||||
[*.go]
|
|
||||||
indent_style = tab
|
|
||||||
|
|
||||||
[{Makefile,*.mk}]
|
|
||||||
indent_style = tab
|
|
||||||
|
|
||||||
[*.nix]
|
|
||||||
indent_size = 2
|
|
||||||
|
|
||||||
[.golangci.yaml]
|
|
||||||
indent_size = 2
|
|
||||||
-4
@@ -1,4 +0,0 @@
|
|||||||
if ! has nix_direnv_version || ! nix_direnv_version 3.0.4; then
|
|
||||||
source_url "https://raw.githubusercontent.com/nix-community/nix-direnv/3.0.4/direnvrc" "sha256-DzlYZ33mWF/Gs8DDeyjr8mnVmQGx7ASYqA5WlxwvBG4="
|
|
||||||
fi
|
|
||||||
use flake . --impure
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
/.devenv/
|
|
||||||
/.direnv/
|
|
||||||
/.pre-commit-config.yaml
|
|
||||||
/bin/
|
|
||||||
/build/
|
|
||||||
/var/
|
|
||||||
-48
@@ -1,48 +0,0 @@
|
|||||||
version: "2"
|
|
||||||
|
|
||||||
run:
|
|
||||||
timeout: 10m
|
|
||||||
|
|
||||||
linters:
|
|
||||||
enable:
|
|
||||||
- govet
|
|
||||||
- ineffassign
|
|
||||||
# - misspell
|
|
||||||
- nolintlint
|
|
||||||
# - revive
|
|
||||||
|
|
||||||
disable:
|
|
||||||
- errcheck
|
|
||||||
- staticcheck
|
|
||||||
- unused
|
|
||||||
|
|
||||||
settings:
|
|
||||||
misspell:
|
|
||||||
locale: US
|
|
||||||
nolintlint:
|
|
||||||
allow-unused: false # report any unused nolint directives
|
|
||||||
require-specific: false # don't require nolint directives to be specific about which linter is being skipped
|
|
||||||
|
|
||||||
formatters:
|
|
||||||
enable:
|
|
||||||
- gci
|
|
||||||
- gofmt
|
|
||||||
- gofumpt
|
|
||||||
- goimports
|
|
||||||
# - golines
|
|
||||||
|
|
||||||
settings:
|
|
||||||
gci:
|
|
||||||
sections:
|
|
||||||
- standard
|
|
||||||
- default
|
|
||||||
- localmodule
|
|
||||||
gofmt:
|
|
||||||
simplify: true
|
|
||||||
rewrite-rules:
|
|
||||||
- pattern: interface{}
|
|
||||||
replacement: any
|
|
||||||
|
|
||||||
exclusions:
|
|
||||||
paths:
|
|
||||||
- internal/
|
|
||||||
-104
@@ -1,104 +0,0 @@
|
|||||||
> [!WARNING]
|
|
||||||
> As of v2 of this library, change log can be found in GitHub releases.
|
|
||||||
|
|
||||||
## 1.5.1
|
|
||||||
|
|
||||||
* Wrap errors so they're compatible with `errors.Is` and `errors.As` [GH-282]
|
|
||||||
* Fix map of slices not decoding properly in certain cases. [GH-266]
|
|
||||||
|
|
||||||
## 1.5.0
|
|
||||||
|
|
||||||
* New option `IgnoreUntaggedFields` to ignore decoding to any fields
|
|
||||||
without `mapstructure` (or the configured tag name) set [GH-277]
|
|
||||||
* New option `ErrorUnset` which makes it an error if any fields
|
|
||||||
in a target struct are not set by the decoding process. [GH-225]
|
|
||||||
* New function `OrComposeDecodeHookFunc` to help compose decode hooks. [GH-240]
|
|
||||||
* Decoding to slice from array no longer crashes [GH-265]
|
|
||||||
* Decode nested struct pointers to map [GH-271]
|
|
||||||
* Fix issue where `,squash` was ignored if `Squash` option was set. [GH-280]
|
|
||||||
* Fix issue where fields with `,omitempty` would sometimes decode
|
|
||||||
into a map with an empty string key [GH-281]
|
|
||||||
|
|
||||||
## 1.4.3
|
|
||||||
|
|
||||||
* Fix cases where `json.Number` didn't decode properly [GH-261]
|
|
||||||
|
|
||||||
## 1.4.2
|
|
||||||
|
|
||||||
* Custom name matchers to support any sort of casing, formatting, etc. for
|
|
||||||
field names. [GH-250]
|
|
||||||
* Fix possible panic in ComposeDecodeHookFunc [GH-251]
|
|
||||||
|
|
||||||
## 1.4.1
|
|
||||||
|
|
||||||
* Fix regression where `*time.Time` value would be set to empty and not be sent
|
|
||||||
to decode hooks properly [GH-232]
|
|
||||||
|
|
||||||
## 1.4.0
|
|
||||||
|
|
||||||
* A new decode hook type `DecodeHookFuncValue` has been added that has
|
|
||||||
access to the full values. [GH-183]
|
|
||||||
* Squash is now supported with embedded fields that are struct pointers [GH-205]
|
|
||||||
* Empty strings will convert to 0 for all numeric types when weakly decoding [GH-206]
|
|
||||||
|
|
||||||
## 1.3.3
|
|
||||||
|
|
||||||
* Decoding maps from maps creates a settable value for decode hooks [GH-203]
|
|
||||||
|
|
||||||
## 1.3.2
|
|
||||||
|
|
||||||
* Decode into interface type with a struct value is supported [GH-187]
|
|
||||||
|
|
||||||
## 1.3.1
|
|
||||||
|
|
||||||
* Squash should only squash embedded structs. [GH-194]
|
|
||||||
|
|
||||||
## 1.3.0
|
|
||||||
|
|
||||||
* Added `",omitempty"` support. This will ignore zero values in the source
|
|
||||||
structure when encoding. [GH-145]
|
|
||||||
|
|
||||||
## 1.2.3
|
|
||||||
|
|
||||||
* Fix duplicate entries in Keys list with pointer values. [GH-185]
|
|
||||||
|
|
||||||
## 1.2.2
|
|
||||||
|
|
||||||
* Do not add unsettable (unexported) values to the unused metadata key
|
|
||||||
or "remain" value. [GH-150]
|
|
||||||
|
|
||||||
## 1.2.1
|
|
||||||
|
|
||||||
* Go modules checksum mismatch fix
|
|
||||||
|
|
||||||
## 1.2.0
|
|
||||||
|
|
||||||
* Added support to capture unused values in a field using the `",remain"` value
|
|
||||||
in the mapstructure tag. There is an example to showcase usage.
|
|
||||||
* Added `DecoderConfig` option to always squash embedded structs
|
|
||||||
* `json.Number` can decode into `uint` types
|
|
||||||
* Empty slices are preserved and not replaced with nil slices
|
|
||||||
* Fix panic that can occur in when decoding a map into a nil slice of structs
|
|
||||||
* Improved package documentation for godoc
|
|
||||||
|
|
||||||
## 1.1.2
|
|
||||||
|
|
||||||
* Fix error when decode hook decodes interface implementation into interface
|
|
||||||
type. [GH-140]
|
|
||||||
|
|
||||||
## 1.1.1
|
|
||||||
|
|
||||||
* Fix panic that can happen in `decodePtr`
|
|
||||||
|
|
||||||
## 1.1.0
|
|
||||||
|
|
||||||
* Added `StringToIPHookFunc` to convert `string` to `net.IP` and `net.IPNet` [GH-133]
|
|
||||||
* Support struct to struct decoding [GH-137]
|
|
||||||
* If source map value is nil, then destination map value is nil (instead of empty)
|
|
||||||
* If source slice value is nil, then destination slice value is nil (instead of empty)
|
|
||||||
* If source pointer is nil, then destination pointer is set to nil (instead of
|
|
||||||
allocated zero value of type)
|
|
||||||
|
|
||||||
## 1.0.0
|
|
||||||
|
|
||||||
* Initial tagged stable release.
|
|
||||||
-21
@@ -1,21 +0,0 @@
|
|||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2013 Mitchell Hashimoto
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
|
||||||
in the Software without restriction, including without limitation the rights
|
|
||||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
||||||
copies of the Software, and to permit persons to whom the Software is
|
|
||||||
furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in
|
|
||||||
all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
||||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
||||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
||||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
||||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
||||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
||||||
THE SOFTWARE.
|
|
||||||
-81
@@ -1,81 +0,0 @@
|
|||||||
# mapstructure
|
|
||||||
|
|
||||||
[](https://github.com/go-viper/mapstructure/actions/workflows/ci.yaml)
|
|
||||||
[](https://pkg.go.dev/mod/github.com/go-viper/mapstructure/v2)
|
|
||||||

|
|
||||||
[](https://deps.dev/go/github.com%252Fgo-viper%252Fmapstructure%252Fv2)
|
|
||||||
|
|
||||||
mapstructure is a Go library for decoding generic map values to structures
|
|
||||||
and vice versa, while providing helpful error handling.
|
|
||||||
|
|
||||||
This library is most useful when decoding values from some data stream (JSON,
|
|
||||||
Gob, etc.) where you don't _quite_ know the structure of the underlying data
|
|
||||||
until you read a part of it. You can therefore read a `map[string]interface{}`
|
|
||||||
and use this library to decode it into the proper underlying native Go
|
|
||||||
structure.
|
|
||||||
|
|
||||||
## Installation
|
|
||||||
|
|
||||||
```shell
|
|
||||||
go get github.com/go-viper/mapstructure/v2
|
|
||||||
```
|
|
||||||
|
|
||||||
## Migrating from `github.com/mitchellh/mapstructure`
|
|
||||||
|
|
||||||
[@mitchehllh](https://github.com/mitchellh) announced his intent to archive some of his unmaintained projects (see [here](https://gist.github.com/mitchellh/90029601268e59a29e64e55bab1c5bdc) and [here](https://github.com/mitchellh/mapstructure/issues/349)). This is a repository achieved the "blessed fork" status.
|
|
||||||
|
|
||||||
You can migrate to this package by changing your import paths in your Go files to `github.com/go-viper/mapstructure/v2`.
|
|
||||||
The API is the same, so you don't need to change anything else.
|
|
||||||
|
|
||||||
Here is a script that can help you with the migration:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
sed -i 's|github.com/mitchellh/mapstructure|github.com/go-viper/mapstructure/v2|g' $(find . -type f -name '*.go')
|
|
||||||
```
|
|
||||||
|
|
||||||
If you need more time to migrate your code, that is absolutely fine.
|
|
||||||
|
|
||||||
Some of the latest fixes are backported to the v1 release branch of this package, so you can use the Go modules `replace` feature until you are ready to migrate:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
replace github.com/mitchellh/mapstructure => github.com/go-viper/mapstructure v1.6.0
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage & Example
|
|
||||||
|
|
||||||
For usage and examples see the [documentation](https://pkg.go.dev/mod/github.com/go-viper/mapstructure/v2).
|
|
||||||
|
|
||||||
The `Decode` function has examples associated with it there.
|
|
||||||
|
|
||||||
## But Why?!
|
|
||||||
|
|
||||||
Go offers fantastic standard libraries for decoding formats such as JSON.
|
|
||||||
The standard method is to have a struct pre-created, and populate that struct
|
|
||||||
from the bytes of the encoded format. This is great, but the problem is if
|
|
||||||
you have configuration or an encoding that changes slightly depending on
|
|
||||||
specific fields. For example, consider this JSON:
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"type": "person",
|
|
||||||
"name": "Mitchell"
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
Perhaps we can't populate a specific structure without first reading
|
|
||||||
the "type" field from the JSON. We could always do two passes over the
|
|
||||||
decoding of the JSON (reading the "type" first, and the rest later).
|
|
||||||
However, it is much simpler to just decode this into a `map[string]interface{}`
|
|
||||||
structure, read the "type" key, then use something like this library
|
|
||||||
to decode it into the proper structure.
|
|
||||||
|
|
||||||
## Credits
|
|
||||||
|
|
||||||
Mapstructure was originally created by [@mitchellh](https://github.com/mitchellh).
|
|
||||||
This is a maintained fork of the original library.
|
|
||||||
|
|
||||||
Read more about the reasons for the fork [here](https://github.com/mitchellh/mapstructure/issues/349).
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The project is licensed under the [MIT License](LICENSE).
|
|
||||||
-714
@@ -1,714 +0,0 @@
|
|||||||
package mapstructure
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"net/netip"
|
|
||||||
"net/url"
|
|
||||||
"reflect"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// typedDecodeHook takes a raw DecodeHookFunc (an any) and turns
|
|
||||||
// it into the proper DecodeHookFunc type, such as DecodeHookFuncType.
|
|
||||||
func typedDecodeHook(h DecodeHookFunc) DecodeHookFunc {
|
|
||||||
// Create variables here so we can reference them with the reflect pkg
|
|
||||||
var f1 DecodeHookFuncType
|
|
||||||
var f2 DecodeHookFuncKind
|
|
||||||
var f3 DecodeHookFuncValue
|
|
||||||
|
|
||||||
// Fill in the variables into this interface and the rest is done
|
|
||||||
// automatically using the reflect package.
|
|
||||||
potential := []any{f1, f2, f3}
|
|
||||||
|
|
||||||
v := reflect.ValueOf(h)
|
|
||||||
vt := v.Type()
|
|
||||||
for _, raw := range potential {
|
|
||||||
pt := reflect.ValueOf(raw).Type()
|
|
||||||
if vt.ConvertibleTo(pt) {
|
|
||||||
return v.Convert(pt).Interface()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// cachedDecodeHook takes a raw DecodeHookFunc (an any) and turns
|
|
||||||
// it into a closure to be used directly
|
|
||||||
// if the type fails to convert we return a closure always erroring to keep the previous behaviour
|
|
||||||
func cachedDecodeHook(raw DecodeHookFunc) func(from reflect.Value, to reflect.Value) (any, error) {
|
|
||||||
switch f := typedDecodeHook(raw).(type) {
|
|
||||||
case DecodeHookFuncType:
|
|
||||||
return func(from reflect.Value, to reflect.Value) (any, error) {
|
|
||||||
return f(from.Type(), to.Type(), from.Interface())
|
|
||||||
}
|
|
||||||
case DecodeHookFuncKind:
|
|
||||||
return func(from reflect.Value, to reflect.Value) (any, error) {
|
|
||||||
return f(from.Kind(), to.Kind(), from.Interface())
|
|
||||||
}
|
|
||||||
case DecodeHookFuncValue:
|
|
||||||
return func(from reflect.Value, to reflect.Value) (any, error) {
|
|
||||||
return f(from, to)
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
return func(from reflect.Value, to reflect.Value) (any, error) {
|
|
||||||
return nil, errors.New("invalid decode hook signature")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// DecodeHookExec executes the given decode hook. This should be used
|
|
||||||
// since it'll naturally degrade to the older backwards compatible DecodeHookFunc
|
|
||||||
// that took reflect.Kind instead of reflect.Type.
|
|
||||||
func DecodeHookExec(
|
|
||||||
raw DecodeHookFunc,
|
|
||||||
from reflect.Value, to reflect.Value,
|
|
||||||
) (any, error) {
|
|
||||||
switch f := typedDecodeHook(raw).(type) {
|
|
||||||
case DecodeHookFuncType:
|
|
||||||
return f(from.Type(), to.Type(), from.Interface())
|
|
||||||
case DecodeHookFuncKind:
|
|
||||||
return f(from.Kind(), to.Kind(), from.Interface())
|
|
||||||
case DecodeHookFuncValue:
|
|
||||||
return f(from, to)
|
|
||||||
default:
|
|
||||||
return nil, errors.New("invalid decode hook signature")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// ComposeDecodeHookFunc creates a single DecodeHookFunc that
|
|
||||||
// automatically composes multiple DecodeHookFuncs.
|
|
||||||
//
|
|
||||||
// The composed funcs are called in order, with the result of the
|
|
||||||
// previous transformation.
|
|
||||||
func ComposeDecodeHookFunc(fs ...DecodeHookFunc) DecodeHookFunc {
|
|
||||||
cached := make([]func(from reflect.Value, to reflect.Value) (any, error), 0, len(fs))
|
|
||||||
for _, f := range fs {
|
|
||||||
cached = append(cached, cachedDecodeHook(f))
|
|
||||||
}
|
|
||||||
return func(f reflect.Value, t reflect.Value) (any, error) {
|
|
||||||
var err error
|
|
||||||
data := f.Interface()
|
|
||||||
|
|
||||||
newFrom := f
|
|
||||||
for _, c := range cached {
|
|
||||||
data, err = c(newFrom, t)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
if v, ok := data.(reflect.Value); ok {
|
|
||||||
newFrom = v
|
|
||||||
} else {
|
|
||||||
newFrom = reflect.ValueOf(data)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// OrComposeDecodeHookFunc executes all input hook functions until one of them returns no error. In that case its value is returned.
|
|
||||||
// If all hooks return an error, OrComposeDecodeHookFunc returns an error concatenating all error messages.
|
|
||||||
func OrComposeDecodeHookFunc(ff ...DecodeHookFunc) DecodeHookFunc {
|
|
||||||
cached := make([]func(from reflect.Value, to reflect.Value) (any, error), 0, len(ff))
|
|
||||||
for _, f := range ff {
|
|
||||||
cached = append(cached, cachedDecodeHook(f))
|
|
||||||
}
|
|
||||||
return func(a, b reflect.Value) (any, error) {
|
|
||||||
var allErrs string
|
|
||||||
var out any
|
|
||||||
var err error
|
|
||||||
|
|
||||||
for _, c := range cached {
|
|
||||||
out, err = c(a, b)
|
|
||||||
if err != nil {
|
|
||||||
allErrs += err.Error() + "\n"
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
return out, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return nil, errors.New(allErrs)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToSliceHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// string to []string by splitting on the given sep.
|
|
||||||
func StringToSliceHookFunc(sep string) DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.SliceOf(f) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
raw := data.(string)
|
|
||||||
if raw == "" {
|
|
||||||
return []string{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Split(raw, sep), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToWeakSliceHookFunc brings back the old (pre-v2) behavior of [StringToSliceHookFunc].
|
|
||||||
//
|
|
||||||
// As of mapstructure v2.0.0 [StringToSliceHookFunc] checks if the return type is a string slice.
|
|
||||||
// This function removes that check.
|
|
||||||
func StringToWeakSliceHookFunc(sep string) DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Slice {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
raw := data.(string)
|
|
||||||
if raw == "" {
|
|
||||||
return []string{}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return strings.Split(raw, sep), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToTimeDurationHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to time.Duration.
|
|
||||||
func StringToTimeDurationHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(time.Duration(5)) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
d, err := time.ParseDuration(data.(string))
|
|
||||||
|
|
||||||
return d, wrapTimeParseDurationError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToTimeLocationHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to *time.Location.
|
|
||||||
func StringToTimeLocationHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(time.Local) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
d, err := time.LoadLocation(data.(string))
|
|
||||||
|
|
||||||
return d, wrapTimeParseLocationError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToURLHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to *url.URL.
|
|
||||||
func StringToURLHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(&url.URL{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u, err := url.Parse(data.(string))
|
|
||||||
|
|
||||||
return u, wrapUrlError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToIPHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to net.IP
|
|
||||||
func StringToIPHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(net.IP{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
ip := net.ParseIP(data.(string))
|
|
||||||
if ip == nil {
|
|
||||||
return net.IP{}, fmt.Errorf("failed parsing ip")
|
|
||||||
}
|
|
||||||
|
|
||||||
return ip, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToIPNetHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to net.IPNet
|
|
||||||
func StringToIPNetHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(net.IPNet{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
_, net, err := net.ParseCIDR(data.(string))
|
|
||||||
return net, wrapNetParseError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToTimeHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to time.Time.
|
|
||||||
func StringToTimeHookFunc(layout string) DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(time.Time{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
ti, err := time.Parse(layout, data.(string))
|
|
||||||
|
|
||||||
return ti, wrapTimeParseError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WeaklyTypedHook is a DecodeHookFunc which adds support for weak typing to
|
|
||||||
// the decoder.
|
|
||||||
//
|
|
||||||
// Note that this is significantly different from the WeaklyTypedInput option
|
|
||||||
// of the DecoderConfig.
|
|
||||||
func WeaklyTypedHook(
|
|
||||||
f reflect.Kind,
|
|
||||||
t reflect.Kind,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
dataVal := reflect.ValueOf(data)
|
|
||||||
switch t {
|
|
||||||
case reflect.String:
|
|
||||||
switch f {
|
|
||||||
case reflect.Bool:
|
|
||||||
if dataVal.Bool() {
|
|
||||||
return "1", nil
|
|
||||||
}
|
|
||||||
return "0", nil
|
|
||||||
case reflect.Float32:
|
|
||||||
return strconv.FormatFloat(dataVal.Float(), 'f', -1, 64), nil
|
|
||||||
case reflect.Int:
|
|
||||||
return strconv.FormatInt(dataVal.Int(), 10), nil
|
|
||||||
case reflect.Slice:
|
|
||||||
dataType := dataVal.Type()
|
|
||||||
elemKind := dataType.Elem().Kind()
|
|
||||||
if elemKind == reflect.Uint8 {
|
|
||||||
return string(dataVal.Interface().([]uint8)), nil
|
|
||||||
}
|
|
||||||
case reflect.Uint:
|
|
||||||
return strconv.FormatUint(dataVal.Uint(), 10), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func RecursiveStructToMapHookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Value, t reflect.Value) (any, error) {
|
|
||||||
if f.Kind() != reflect.Struct {
|
|
||||||
return f.Interface(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var i any = struct{}{}
|
|
||||||
if t.Type() != reflect.TypeOf(&i).Elem() {
|
|
||||||
return f.Interface(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
m := make(map[string]any)
|
|
||||||
t.Set(reflect.ValueOf(m))
|
|
||||||
|
|
||||||
return f.Interface(), nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TextUnmarshallerHookFunc returns a DecodeHookFunc that applies
|
|
||||||
// strings to the UnmarshalText function, when the target type
|
|
||||||
// implements the encoding.TextUnmarshaler interface
|
|
||||||
func TextUnmarshallerHookFunc() DecodeHookFuncType {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
result := reflect.New(t).Interface()
|
|
||||||
unmarshaller, ok := result.(encoding.TextUnmarshaler)
|
|
||||||
if !ok {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
str, ok := data.(string)
|
|
||||||
if !ok {
|
|
||||||
str = reflect.Indirect(reflect.ValueOf(&data)).Elem().String()
|
|
||||||
}
|
|
||||||
if err := unmarshaller.UnmarshalText([]byte(str)); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToNetIPAddrHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to netip.Addr.
|
|
||||||
func StringToNetIPAddrHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(netip.Addr{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
addr, err := netip.ParseAddr(data.(string))
|
|
||||||
|
|
||||||
return addr, wrapNetIPParseAddrError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToNetIPAddrPortHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to netip.AddrPort.
|
|
||||||
func StringToNetIPAddrPortHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(netip.AddrPort{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
addrPort, err := netip.ParseAddrPort(data.(string))
|
|
||||||
|
|
||||||
return addrPort, wrapNetIPParseAddrPortError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToNetIPPrefixHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to netip.Prefix.
|
|
||||||
func StringToNetIPPrefixHookFunc() DecodeHookFunc {
|
|
||||||
return func(
|
|
||||||
f reflect.Type,
|
|
||||||
t reflect.Type,
|
|
||||||
data any,
|
|
||||||
) (any, error) {
|
|
||||||
if f.Kind() != reflect.String {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
if t != reflect.TypeOf(netip.Prefix{}) {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
prefix, err := netip.ParsePrefix(data.(string))
|
|
||||||
|
|
||||||
return prefix, wrapNetIPParsePrefixError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToBasicTypeHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to basic types.
|
|
||||||
// int8, uint8, int16, uint16, int32, uint32, int64, uint64, int, uint, float32, float64, bool, byte, rune, complex64, complex128
|
|
||||||
func StringToBasicTypeHookFunc() DecodeHookFunc {
|
|
||||||
return ComposeDecodeHookFunc(
|
|
||||||
StringToInt8HookFunc(),
|
|
||||||
StringToUint8HookFunc(),
|
|
||||||
StringToInt16HookFunc(),
|
|
||||||
StringToUint16HookFunc(),
|
|
||||||
StringToInt32HookFunc(),
|
|
||||||
StringToUint32HookFunc(),
|
|
||||||
StringToInt64HookFunc(),
|
|
||||||
StringToUint64HookFunc(),
|
|
||||||
StringToIntHookFunc(),
|
|
||||||
StringToUintHookFunc(),
|
|
||||||
StringToFloat32HookFunc(),
|
|
||||||
StringToFloat64HookFunc(),
|
|
||||||
StringToBoolHookFunc(),
|
|
||||||
// byte and rune are aliases for uint8 and int32 respectively
|
|
||||||
// StringToByteHookFunc(),
|
|
||||||
// StringToRuneHookFunc(),
|
|
||||||
StringToComplex64HookFunc(),
|
|
||||||
StringToComplex128HookFunc(),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToInt8HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to int8.
|
|
||||||
func StringToInt8HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Int8 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
i64, err := strconv.ParseInt(data.(string), 0, 8)
|
|
||||||
return int8(i64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToUint8HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to uint8.
|
|
||||||
func StringToUint8HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Uint8 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u64, err := strconv.ParseUint(data.(string), 0, 8)
|
|
||||||
return uint8(u64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToInt16HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to int16.
|
|
||||||
func StringToInt16HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Int16 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
i64, err := strconv.ParseInt(data.(string), 0, 16)
|
|
||||||
return int16(i64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToUint16HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to uint16.
|
|
||||||
func StringToUint16HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Uint16 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u64, err := strconv.ParseUint(data.(string), 0, 16)
|
|
||||||
return uint16(u64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToInt32HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to int32.
|
|
||||||
func StringToInt32HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Int32 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
i64, err := strconv.ParseInt(data.(string), 0, 32)
|
|
||||||
return int32(i64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToUint32HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to uint32.
|
|
||||||
func StringToUint32HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Uint32 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u64, err := strconv.ParseUint(data.(string), 0, 32)
|
|
||||||
return uint32(u64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToInt64HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to int64.
|
|
||||||
func StringToInt64HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Int64 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
i64, err := strconv.ParseInt(data.(string), 0, 64)
|
|
||||||
return int64(i64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToUint64HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to uint64.
|
|
||||||
func StringToUint64HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Uint64 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u64, err := strconv.ParseUint(data.(string), 0, 64)
|
|
||||||
return uint64(u64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToIntHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to int.
|
|
||||||
func StringToIntHookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Int {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
i64, err := strconv.ParseInt(data.(string), 0, 0)
|
|
||||||
return int(i64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToUintHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to uint.
|
|
||||||
func StringToUintHookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Uint {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
u64, err := strconv.ParseUint(data.(string), 0, 0)
|
|
||||||
return uint(u64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToFloat32HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to float32.
|
|
||||||
func StringToFloat32HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Float32 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
f64, err := strconv.ParseFloat(data.(string), 32)
|
|
||||||
return float32(f64), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToFloat64HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to float64.
|
|
||||||
func StringToFloat64HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Float64 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
f64, err := strconv.ParseFloat(data.(string), 64)
|
|
||||||
return f64, wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToBoolHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to bool.
|
|
||||||
func StringToBoolHookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Bool {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
b, err := strconv.ParseBool(data.(string))
|
|
||||||
return b, wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToByteHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to byte.
|
|
||||||
func StringToByteHookFunc() DecodeHookFunc {
|
|
||||||
return StringToUint8HookFunc()
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToRuneHookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to rune.
|
|
||||||
func StringToRuneHookFunc() DecodeHookFunc {
|
|
||||||
return StringToInt32HookFunc()
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToComplex64HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to complex64.
|
|
||||||
func StringToComplex64HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Complex64 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
c128, err := strconv.ParseComplex(data.(string), 64)
|
|
||||||
return complex64(c128), wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// StringToComplex128HookFunc returns a DecodeHookFunc that converts
|
|
||||||
// strings to complex128.
|
|
||||||
func StringToComplex128HookFunc() DecodeHookFunc {
|
|
||||||
return func(f reflect.Type, t reflect.Type, data any) (any, error) {
|
|
||||||
if f.Kind() != reflect.String || t.Kind() != reflect.Complex128 {
|
|
||||||
return data, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Convert it by parsing
|
|
||||||
c128, err := strconv.ParseComplex(data.(string), 128)
|
|
||||||
return c128, wrapStrconvNumError(err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
-244
@@ -1,244 +0,0 @@
|
|||||||
package mapstructure
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"net/url"
|
|
||||||
"reflect"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Error interface is implemented by all errors emitted by mapstructure.
|
|
||||||
//
|
|
||||||
// Use [errors.As] to check if an error implements this interface.
|
|
||||||
type Error interface {
|
|
||||||
error
|
|
||||||
|
|
||||||
mapstructure()
|
|
||||||
}
|
|
||||||
|
|
||||||
// DecodeError is a generic error type that holds information about
|
|
||||||
// a decoding error together with the name of the field that caused the error.
|
|
||||||
type DecodeError struct {
|
|
||||||
name string
|
|
||||||
err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func newDecodeError(name string, err error) *DecodeError {
|
|
||||||
return &DecodeError{
|
|
||||||
name: name,
|
|
||||||
err: err,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *DecodeError) Name() string {
|
|
||||||
return e.name
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *DecodeError) Unwrap() error {
|
|
||||||
return e.err
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *DecodeError) Error() string {
|
|
||||||
return fmt.Sprintf("'%s' %s", e.name, e.err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (*DecodeError) mapstructure() {}
|
|
||||||
|
|
||||||
// ParseError is an error type that indicates a value could not be parsed
|
|
||||||
// into the expected type.
|
|
||||||
type ParseError struct {
|
|
||||||
Expected reflect.Value
|
|
||||||
Value any
|
|
||||||
Err error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *ParseError) Error() string {
|
|
||||||
return fmt.Sprintf("cannot parse value as '%s': %s", e.Expected.Type(), e.Err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (*ParseError) mapstructure() {}
|
|
||||||
|
|
||||||
// UnconvertibleTypeError is an error type that indicates a value could not be
|
|
||||||
// converted to the expected type.
|
|
||||||
type UnconvertibleTypeError struct {
|
|
||||||
Expected reflect.Value
|
|
||||||
Value any
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *UnconvertibleTypeError) Error() string {
|
|
||||||
return fmt.Sprintf(
|
|
||||||
"expected type '%s', got unconvertible type '%s'",
|
|
||||||
e.Expected.Type(),
|
|
||||||
reflect.TypeOf(e.Value),
|
|
||||||
)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (*UnconvertibleTypeError) mapstructure() {}
|
|
||||||
|
|
||||||
func wrapStrconvNumError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err, ok := err.(*strconv.NumError); ok {
|
|
||||||
return &strconvNumError{Err: err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
type strconvNumError struct {
|
|
||||||
Err *strconv.NumError
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *strconvNumError) Error() string {
|
|
||||||
return "strconv." + e.Err.Func + ": " + e.Err.Err.Error()
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *strconvNumError) Unwrap() error { return e.Err }
|
|
||||||
|
|
||||||
func wrapUrlError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err, ok := err.(*url.Error); ok {
|
|
||||||
return &urlError{Err: err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
type urlError struct {
|
|
||||||
Err *url.Error
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *urlError) Error() string {
|
|
||||||
return fmt.Sprintf("%s", e.Err.Err)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *urlError) Unwrap() error { return e.Err }
|
|
||||||
|
|
||||||
func wrapNetParseError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err, ok := err.(*net.ParseError); ok {
|
|
||||||
return &netParseError{Err: err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
type netParseError struct {
|
|
||||||
Err *net.ParseError
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *netParseError) Error() string {
|
|
||||||
return "invalid " + e.Err.Type
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *netParseError) Unwrap() error { return e.Err }
|
|
||||||
|
|
||||||
func wrapTimeParseError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if err, ok := err.(*time.ParseError); ok {
|
|
||||||
return &timeParseError{Err: err}
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
type timeParseError struct {
|
|
||||||
Err *time.ParseError
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *timeParseError) Error() string {
|
|
||||||
if e.Err.Message == "" {
|
|
||||||
return fmt.Sprintf("parsing time as %q: cannot parse as %q", e.Err.Layout, e.Err.LayoutElem)
|
|
||||||
}
|
|
||||||
|
|
||||||
return "parsing time " + e.Err.Message
|
|
||||||
}
|
|
||||||
|
|
||||||
func (e *timeParseError) Unwrap() error { return e.Err }
|
|
||||||
|
|
||||||
func wrapNetIPParseAddrError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if errMsg := err.Error(); strings.HasPrefix(errMsg, "ParseAddr") {
|
|
||||||
errPieces := strings.Split(errMsg, ": ")
|
|
||||||
|
|
||||||
return fmt.Errorf("ParseAddr: %s", errPieces[len(errPieces)-1])
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func wrapNetIPParseAddrPortError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
errMsg := err.Error()
|
|
||||||
if strings.HasPrefix(errMsg, "invalid port ") {
|
|
||||||
return errors.New("invalid port")
|
|
||||||
} else if strings.HasPrefix(errMsg, "invalid ip:port ") {
|
|
||||||
return errors.New("invalid ip:port")
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func wrapNetIPParsePrefixError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
if errMsg := err.Error(); strings.HasPrefix(errMsg, "netip.ParsePrefix") {
|
|
||||||
errPieces := strings.Split(errMsg, ": ")
|
|
||||||
|
|
||||||
return fmt.Errorf("netip.ParsePrefix: %s", errPieces[len(errPieces)-1])
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func wrapTimeParseDurationError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
errMsg := err.Error()
|
|
||||||
if strings.HasPrefix(errMsg, "time: unknown unit ") {
|
|
||||||
return errors.New("time: unknown unit")
|
|
||||||
} else if strings.HasPrefix(errMsg, "time: ") {
|
|
||||||
idx := strings.LastIndex(errMsg, " ")
|
|
||||||
|
|
||||||
return errors.New(errMsg[:idx])
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
func wrapTimeParseLocationError(err error) error {
|
|
||||||
if err == nil {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
errMsg := err.Error()
|
|
||||||
if strings.Contains(errMsg, "unknown time zone") || strings.HasPrefix(errMsg, "time: unknown format") {
|
|
||||||
return fmt.Errorf("invalid time zone format: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
-294
@@ -1,294 +0,0 @@
|
|||||||
{
|
|
||||||
"nodes": {
|
|
||||||
"cachix": {
|
|
||||||
"inputs": {
|
|
||||||
"devenv": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"flake-compat": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"git-hooks": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"nixpkgs": "nixpkgs"
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1742042642,
|
|
||||||
"narHash": "sha256-D0gP8srrX0qj+wNYNPdtVJsQuFzIng3q43thnHXQ/es=",
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "cachix",
|
|
||||||
"rev": "a624d3eaf4b1d225f918de8543ed739f2f574203",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "cachix",
|
|
||||||
"ref": "latest",
|
|
||||||
"repo": "cachix",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"devenv": {
|
|
||||||
"inputs": {
|
|
||||||
"cachix": "cachix",
|
|
||||||
"flake-compat": "flake-compat",
|
|
||||||
"git-hooks": "git-hooks",
|
|
||||||
"nix": "nix",
|
|
||||||
"nixpkgs": "nixpkgs_3"
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1744876578,
|
|
||||||
"narHash": "sha256-8MTBj2REB8t29sIBLpxbR0+AEGJ7f+RkzZPAGsFd40c=",
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "devenv",
|
|
||||||
"rev": "7ff7c351bba20d0615be25ecdcbcf79b57b85fe1",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "devenv",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"flake-compat": {
|
|
||||||
"flake": false,
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1733328505,
|
|
||||||
"narHash": "sha256-NeCCThCEP3eCl2l/+27kNNK7QrwZB1IJCrXfrbv5oqU=",
|
|
||||||
"owner": "edolstra",
|
|
||||||
"repo": "flake-compat",
|
|
||||||
"rev": "ff81ac966bb2cae68946d5ed5fc4994f96d0ffec",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "edolstra",
|
|
||||||
"repo": "flake-compat",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"flake-parts": {
|
|
||||||
"inputs": {
|
|
||||||
"nixpkgs-lib": [
|
|
||||||
"devenv",
|
|
||||||
"nix",
|
|
||||||
"nixpkgs"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1712014858,
|
|
||||||
"narHash": "sha256-sB4SWl2lX95bExY2gMFG5HIzvva5AVMJd4Igm+GpZNw=",
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "flake-parts",
|
|
||||||
"rev": "9126214d0a59633752a136528f5f3b9aa8565b7d",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "flake-parts",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"flake-parts_2": {
|
|
||||||
"inputs": {
|
|
||||||
"nixpkgs-lib": "nixpkgs-lib"
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1743550720,
|
|
||||||
"narHash": "sha256-hIshGgKZCgWh6AYJpJmRgFdR3WUbkY04o82X05xqQiY=",
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "flake-parts",
|
|
||||||
"rev": "c621e8422220273271f52058f618c94e405bb0f5",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "flake-parts",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"git-hooks": {
|
|
||||||
"inputs": {
|
|
||||||
"flake-compat": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"gitignore": "gitignore",
|
|
||||||
"nixpkgs": [
|
|
||||||
"devenv",
|
|
||||||
"nixpkgs"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1742649964,
|
|
||||||
"narHash": "sha256-DwOTp7nvfi8mRfuL1escHDXabVXFGT1VlPD1JHrtrco=",
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "git-hooks.nix",
|
|
||||||
"rev": "dcf5072734cb576d2b0c59b2ac44f5050b5eac82",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "git-hooks.nix",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"gitignore": {
|
|
||||||
"inputs": {
|
|
||||||
"nixpkgs": [
|
|
||||||
"devenv",
|
|
||||||
"git-hooks",
|
|
||||||
"nixpkgs"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1709087332,
|
|
||||||
"narHash": "sha256-HG2cCnktfHsKV0s4XW83gU3F57gaTljL9KNSuG6bnQs=",
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "gitignore.nix",
|
|
||||||
"rev": "637db329424fd7e46cf4185293b9cc8c88c95394",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "hercules-ci",
|
|
||||||
"repo": "gitignore.nix",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"libgit2": {
|
|
||||||
"flake": false,
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1697646580,
|
|
||||||
"narHash": "sha256-oX4Z3S9WtJlwvj0uH9HlYcWv+x1hqp8mhXl7HsLu2f0=",
|
|
||||||
"owner": "libgit2",
|
|
||||||
"repo": "libgit2",
|
|
||||||
"rev": "45fd9ed7ae1a9b74b957ef4f337bc3c8b3df01b5",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "libgit2",
|
|
||||||
"repo": "libgit2",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nix": {
|
|
||||||
"inputs": {
|
|
||||||
"flake-compat": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"flake-parts": "flake-parts",
|
|
||||||
"libgit2": "libgit2",
|
|
||||||
"nixpkgs": "nixpkgs_2",
|
|
||||||
"nixpkgs-23-11": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"nixpkgs-regression": [
|
|
||||||
"devenv"
|
|
||||||
],
|
|
||||||
"pre-commit-hooks": [
|
|
||||||
"devenv"
|
|
||||||
]
|
|
||||||
},
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1741798497,
|
|
||||||
"narHash": "sha256-E3j+3MoY8Y96mG1dUIiLFm2tZmNbRvSiyN7CrSKuAVg=",
|
|
||||||
"owner": "domenkozar",
|
|
||||||
"repo": "nix",
|
|
||||||
"rev": "f3f44b2baaf6c4c6e179de8cbb1cc6db031083cd",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "domenkozar",
|
|
||||||
"ref": "devenv-2.24",
|
|
||||||
"repo": "nix",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1733212471,
|
|
||||||
"narHash": "sha256-M1+uCoV5igihRfcUKrr1riygbe73/dzNnzPsmaLCmpo=",
|
|
||||||
"owner": "NixOS",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"rev": "55d15ad12a74eb7d4646254e13638ad0c4128776",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "NixOS",
|
|
||||||
"ref": "nixos-unstable",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs-lib": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1743296961,
|
|
||||||
"narHash": "sha256-b1EdN3cULCqtorQ4QeWgLMrd5ZGOjLSLemfa00heasc=",
|
|
||||||
"owner": "nix-community",
|
|
||||||
"repo": "nixpkgs.lib",
|
|
||||||
"rev": "e4822aea2a6d1cdd36653c134cacfd64c97ff4fa",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "nix-community",
|
|
||||||
"repo": "nixpkgs.lib",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs_2": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1717432640,
|
|
||||||
"narHash": "sha256-+f9c4/ZX5MWDOuB1rKoWj+lBNm0z0rs4CK47HBLxy1o=",
|
|
||||||
"owner": "NixOS",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"rev": "88269ab3044128b7c2f4c7d68448b2fb50456870",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "NixOS",
|
|
||||||
"ref": "release-24.05",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs_3": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1733477122,
|
|
||||||
"narHash": "sha256-qamMCz5mNpQmgBwc8SB5tVMlD5sbwVIToVZtSxMph9s=",
|
|
||||||
"owner": "cachix",
|
|
||||||
"repo": "devenv-nixpkgs",
|
|
||||||
"rev": "7bd9e84d0452f6d2e63b6e6da29fe73fac951857",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "cachix",
|
|
||||||
"ref": "rolling",
|
|
||||||
"repo": "devenv-nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"nixpkgs_4": {
|
|
||||||
"locked": {
|
|
||||||
"lastModified": 1744536153,
|
|
||||||
"narHash": "sha256-awS2zRgF4uTwrOKwwiJcByDzDOdo3Q1rPZbiHQg/N38=",
|
|
||||||
"owner": "NixOS",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"rev": "18dd725c29603f582cf1900e0d25f9f1063dbf11",
|
|
||||||
"type": "github"
|
|
||||||
},
|
|
||||||
"original": {
|
|
||||||
"owner": "NixOS",
|
|
||||||
"ref": "nixpkgs-unstable",
|
|
||||||
"repo": "nixpkgs",
|
|
||||||
"type": "github"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"root": {
|
|
||||||
"inputs": {
|
|
||||||
"devenv": "devenv",
|
|
||||||
"flake-parts": "flake-parts_2",
|
|
||||||
"nixpkgs": "nixpkgs_4"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"root": "root",
|
|
||||||
"version": 7
|
|
||||||
}
|
|
||||||
-46
@@ -1,46 +0,0 @@
|
|||||||
{
|
|
||||||
inputs = {
|
|
||||||
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
|
|
||||||
flake-parts.url = "github:hercules-ci/flake-parts";
|
|
||||||
devenv.url = "github:cachix/devenv";
|
|
||||||
};
|
|
||||||
|
|
||||||
outputs =
|
|
||||||
inputs@{ flake-parts, ... }:
|
|
||||||
flake-parts.lib.mkFlake { inherit inputs; } {
|
|
||||||
imports = [
|
|
||||||
inputs.devenv.flakeModule
|
|
||||||
];
|
|
||||||
|
|
||||||
systems = [
|
|
||||||
"x86_64-linux"
|
|
||||||
"x86_64-darwin"
|
|
||||||
"aarch64-darwin"
|
|
||||||
];
|
|
||||||
|
|
||||||
perSystem =
|
|
||||||
{ pkgs, ... }:
|
|
||||||
rec {
|
|
||||||
devenv.shells = {
|
|
||||||
default = {
|
|
||||||
languages = {
|
|
||||||
go.enable = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
pre-commit.hooks = {
|
|
||||||
nixpkgs-fmt.enable = true;
|
|
||||||
};
|
|
||||||
|
|
||||||
packages = with pkgs; [
|
|
||||||
golangci-lint
|
|
||||||
];
|
|
||||||
|
|
||||||
# https://github.com/cachix/devenv/issues/528#issuecomment-1556108767
|
|
||||||
containers = pkgs.lib.mkForce { };
|
|
||||||
};
|
|
||||||
|
|
||||||
ci = devenv.shells.default;
|
|
||||||
};
|
|
||||||
};
|
|
||||||
};
|
|
||||||
}
|
|
||||||
-11
@@ -1,11 +0,0 @@
|
|||||||
package errors
|
|
||||||
|
|
||||||
import "errors"
|
|
||||||
|
|
||||||
func New(text string) error {
|
|
||||||
return errors.New(text)
|
|
||||||
}
|
|
||||||
|
|
||||||
func As(err error, target interface{}) bool {
|
|
||||||
return errors.As(err, target)
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user