Method HandleResolvePath

agent/agentfiles/resolvepath.go:20–51

HandleResolvePath resolves the existing portion of an absolute path through any symlinks and returns the resulting path. Missing trailing components are preserved so callers can validate future writes against the real target.

(rw http.ResponseWriter, r *http.Request)

// any symlinks and returns the resulting path. Missing trailing components are
// preserved so callers can validate future writes against the real target.
func (api *API) HandleResolvePath(rw http.ResponseWriter, r *http.Request) {
	ctx := r.Context()

	query := r.URL.Query()
	parser := httpapi.NewQueryParamParser().RequiredNotEmpty("path")
	path := parser.String(query, "", "path")
	parser.ErrorExcessParams(query)
	if len(parser.Errors) > 0 {
		httpapi.Write(ctx, rw, http.StatusBadRequest, codersdk.Response{
			Message:     "Query parameters have invalid values.",
			Validations: parser.Errors,
		})
		return
	}

	resolved, err := api.resolvePath(path)
	if err != nil {
		status := http.StatusInternalServerError
		switch {
		case !filepath.IsAbs(path):
			status = http.StatusBadRequest
		case errors.Is(err, os.ErrPermission):
			status = http.StatusForbidden
		}
		httpapi.Write(ctx, rw, status, codersdk.Response{Message: err.Error()})
		return
	}

	httpapi.Write(ctx, rw, http.StatusOK, workspacesdk.ResolvePathResponse{
		ResolvedPath: resolved,
	})
}

// resolvePath resolves any symlinks in the existing portion of path while
// preserving missing trailing components.