mirror of
https://github.com/moby/moby.git
synced 2026-01-11 10:41:43 +00:00
This change changes the default for noOverwriteDirNonDir to be true internally, with the intent to change the default at the API to follow accordingly. The `AllowOverwriteDirWithFile` option in the Client was added when reimplementing the CLI using the API Client lib in [moby@1b2b91b]. Before that refactor, the `noOverwriteDirNonDir` query argument [would be set unconditionally][1] by the CLI, with no options to control the behavior. The `noOverwriteDirNonDir` query parameter was added in [moby@db9cc91] to set the `NoOverwriteDirNonDir` option that was implemented in pkg/archive in [moby@a74799b]. It was added in [PR13171-comment2], following a discussion on the risk of replacing a directory with a file and vice-versa in [PR13171-comment]. > In my latest changes from yesterday: > > - Removed the `GET stat-path` endpoint and added a `HEAD` handler to > the `archive-path` endpoint. Updated the api docs to reflect this. > Also moved api docs changes from `v1.19` to `v1.20`. > - Added a `NoOverwriteDirNonDir` flag to `archive.TarOptions` to indicate > that we do not want to overwrite a directory with a non-directory (and > vice versa) when unpacking an archive. > - Added a corresponding but optional `noOverwriteDirNonDir` parameter > to the `PUT extract-to-dir` endpoint to specify desired behavior. > > These changes combine to keep the behavior we want It's unclear why these were added as an *option* and why it was implemented as opt-in (not opt-out), as overwriting a file with a directory (or vice-versa) would generally be unexpected behavior. [1]:8c9ad7b818/api/client/cp.go (L345-L346)[moby@1b2b91b]:1b2b91ba43[moby@a74799b]:a74799b701[moby@db9cc91]:db9cc91a9e[PR13171-comment]: https://github.com/moby/moby/pull/13171#issuecomment-106559765 [PR13171-comment2]: https://github.com/moby/moby/pull/13171#issuecomment-108538643 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
102 lines
2.7 KiB
Go
102 lines
2.7 KiB
Go
package container
|
|
|
|
import (
|
|
"compress/flate"
|
|
"compress/gzip"
|
|
"context"
|
|
"encoding/base64"
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
|
|
"github.com/docker/docker/api/types/container"
|
|
"github.com/docker/docker/daemon/server/httputils"
|
|
gddohttputil "github.com/golang/gddo/httputil"
|
|
)
|
|
|
|
// setContainerPathStatHeader encodes the stat to JSON, base64 encode, and place in a header.
|
|
func setContainerPathStatHeader(stat *container.PathStat, header http.Header) error {
|
|
statJSON, err := json.Marshal(stat)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
header.Set(
|
|
"X-Docker-Container-Path-Stat",
|
|
base64.StdEncoding.EncodeToString(statJSON),
|
|
)
|
|
|
|
return nil
|
|
}
|
|
|
|
func (c *containerRouter) headContainersArchive(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
v, err := httputils.ArchiveFormValues(r, vars)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
stat, err := c.backend.ContainerStatPath(v.Name, v.Path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
return setContainerPathStatHeader(stat, w.Header())
|
|
}
|
|
|
|
func writeCompressedResponse(w http.ResponseWriter, r *http.Request, body io.Reader) error {
|
|
var cw io.Writer
|
|
switch gddohttputil.NegotiateContentEncoding(r, []string{"gzip", "deflate"}) {
|
|
case "gzip":
|
|
gw := gzip.NewWriter(w)
|
|
defer gw.Close()
|
|
cw = gw
|
|
w.Header().Set("Content-Encoding", "gzip")
|
|
case "deflate":
|
|
fw, err := flate.NewWriter(w, flate.DefaultCompression)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer fw.Close()
|
|
cw = fw
|
|
w.Header().Set("Content-Encoding", "deflate")
|
|
default:
|
|
cw = w
|
|
}
|
|
_, err := io.Copy(cw, body)
|
|
return err
|
|
}
|
|
|
|
func (c *containerRouter) getContainersArchive(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
v, err := httputils.ArchiveFormValues(r, vars)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
tarArchive, stat, err := c.backend.ContainerArchivePath(v.Name, v.Path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer tarArchive.Close()
|
|
|
|
if err := setContainerPathStatHeader(stat, w.Header()); err != nil {
|
|
return err
|
|
}
|
|
|
|
w.Header().Set("Content-Type", "application/x-tar")
|
|
return writeCompressedResponse(w, r, tarArchive)
|
|
}
|
|
|
|
func (c *containerRouter) putContainersArchive(ctx context.Context, w http.ResponseWriter, r *http.Request, vars map[string]string) error {
|
|
v, err := httputils.ArchiveFormValues(r, vars)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
// TODO(thaJeztah): reverse the default: deprecate noOverwriteDirNonDir and add "allowOverwriteDirWithFile" (or similar) argument to opt-in.
|
|
allowOverwriteDirWithFile := !r.Form.Has("noOverwriteDirNonDir") || !httputils.BoolValue(r, "noOverwriteDirNonDir")
|
|
|
|
copyUIDGID := httputils.BoolValue(r, "copyUIDGID")
|
|
|
|
return c.backend.ContainerExtractToDir(v.Name, v.Path, copyUIDGID, allowOverwriteDirWithFile, r.Body)
|
|
}
|