78f3994112
Roadmap items 3-9 (download) and 3-10 (recursive upload).
SDK addition (additive, non-breaking):
- OpenKnowledgeFile(ctx, id) (filename, body io.ReadCloser, err) —
the new primitive that returns the body as a stream plus the
server-suggested Content-Disposition filename. The existing path-
form DownloadKnowledgeFile is now a thin wrapper (also gained
partial-file-on-error cleanup, a pre-existing bug exposed by the
reshape).
doc download <id>:
Borrows shape from `gh release download` (positional id, output flag,
`-` sentinel for stdout). Flag names match gh canon verified against
the gh manual: `-O, --output <file>` for destination; `--clobber` for
overwrite control.
- Default: writes to cwd under the server-suggested filename. If the
server didn't send one, errors with input.missing_flag.
- --output FILE / -O FILE: writes to FILE. Refuses overwrite without
--clobber.
- --output -: stream to stdout (binary-safe).
- Partial writes on error are cleaned up.
doc upload --recursive <dir> --glob '*.pdf':
NOTE on upstream parity: `gh release upload` does NOT support
--recursive (verified — it takes individual file args only). `aws s3
cp --recursive` does, but uses `--include`/`--exclude` glob pattern
pairs rather than a single `--glob`. weknora's single positive `--glob`
is a deliberate simplification, not a direct mirror of either tool.
- Walks the tree, filters by base-name glob, uploads each match
sequentially. Per-file line output: OK / FAIL with the underlying
error. Exit 0 only on full success; on partial failure returns the
first failure's typed code so callers can branch. Rejects --name
with --recursive.
- --dry-run lists matches without uploading.
- --json emits {kb_id, uploaded[], failed[]} envelope at completion.
Bugs caught in the post-commit reviewer round:
- SECURITY: server-supplied filename was used in os.Rename without
sanitization. A malicious / buggy server returning
"../../etc/shadow" could escape cwd. Now filepath.Base'd; "." / "/"
/ "" rejected. Regression test added.
- Wasted-bytes path eliminated via the SDK reshape: the CLI now
inspects filename and applies refuseIfExists BEFORE streaming.
Two-phase temp+rename gone.
- refuseIfExists(path, clobber) helper extracted.
- --json honored in --recursive (uploadOutcome was JSON-tagged but
the envelope was never emitted).
7 + 7 unit tests for download (+ path-traversal regression) and
recursive upload (+ JSON envelope regression).
Roadmap: 3-9, 3-10.
158 lines
5.4 KiB
Go
158 lines
5.4 KiB
Go
package doc
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
|
|
"github.com/spf13/cobra"
|
|
|
|
"github.com/Tencent/WeKnora/cli/internal/agent"
|
|
"github.com/Tencent/WeKnora/cli/internal/cmdutil"
|
|
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
|
)
|
|
|
|
// DownloadOptions captures `weknora doc download` flag state.
|
|
type DownloadOptions struct {
|
|
Output string // --output / -O: target path, "-" for stdout, "" for server-suggested filename
|
|
Clobber bool // --clobber: allow overwrite of an existing file
|
|
}
|
|
|
|
// DownloadService is the narrow SDK surface this command depends on. The
|
|
// CLI calls OpenKnowledgeFile so it can inspect the server-suggested
|
|
// filename and refuse-to-overwrite *before* streaming any bytes.
|
|
type DownloadService interface {
|
|
OpenKnowledgeFile(ctx context.Context, knowledgeID string) (string, io.ReadCloser, error)
|
|
}
|
|
|
|
// NewCmdDownload builds `weknora doc download <id>`. Borrows shape from
|
|
// `gh release download` — positional id, output flag, `-` sentinel for
|
|
// stdout. Flag names match gh canon verified against the gh manual:
|
|
// `-O, --output <file>` for destination, `--clobber` for overwrite
|
|
// control.
|
|
func NewCmdDownload(f *cmdutil.Factory) *cobra.Command {
|
|
opts := &DownloadOptions{}
|
|
cmd := &cobra.Command{
|
|
Use: "download <id>",
|
|
Short: "Download a document by ID",
|
|
Long: `Streams the document bytes to disk (or stdout with --output -).
|
|
|
|
Default behavior (no --output): writes to the cwd under the filename the
|
|
server suggests via Content-Disposition. If the server doesn't suggest
|
|
one, the command errors and asks for --output FILE explicitly.
|
|
|
|
Existing files are NOT overwritten unless --clobber is passed.`,
|
|
Example: ` weknora doc download doc_abc # writes ./<server-name>
|
|
weknora doc download doc_abc -O report.pdf
|
|
weknora doc download doc_abc --output - # stream to stdout (binary safe)
|
|
weknora doc download doc_abc -O report.pdf --clobber`,
|
|
Args: cobra.ExactArgs(1),
|
|
RunE: func(c *cobra.Command, args []string) error {
|
|
cli, err := f.Client()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return runDownload(c.Context(), opts, cli, args[0])
|
|
},
|
|
}
|
|
cmd.Flags().StringVarP(&opts.Output, "output", "O", "", `Output path; "-" for stdout. Defaults to the server-suggested filename.`)
|
|
cmd.Flags().BoolVar(&opts.Clobber, "clobber", false, "Overwrite the output file if it already exists")
|
|
agent.SetAgentHelp(cmd, "Downloads a document. Agents that pipe the bytes should pass --output - (stdout). The exit code is 0 on success, 1 on resource.not_found, 5 on missing --output when the server didn't supply a filename.")
|
|
return cmd
|
|
}
|
|
|
|
func runDownload(ctx context.Context, opts *DownloadOptions, svc DownloadService, id string) error {
|
|
suggested, body, err := svc.OpenKnowledgeFile(ctx, id)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.ClassifyHTTPError(err), err, "download %s", id)
|
|
}
|
|
defer body.Close()
|
|
|
|
dest, err := resolveDownloadDest(opts, suggested)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if dest == "-" {
|
|
_, err := io.Copy(iostreams.IO.Out, body)
|
|
return err
|
|
}
|
|
if err := refuseIfExists(dest, opts.Clobber); err != nil {
|
|
return err
|
|
}
|
|
return streamToFile(body, dest)
|
|
}
|
|
|
|
// resolveDownloadDest returns the final destination ("-" for stdout, an
|
|
// absolute or relative path otherwise) after applying the --output flag
|
|
// and sanitizing the server-suggested name. A server that returns a path-
|
|
// like filename (..\, /etc/foo) is rejected — only the basename is
|
|
// accepted.
|
|
func resolveDownloadDest(opts *DownloadOptions, suggested string) (string, error) {
|
|
if opts.Output == "-" {
|
|
return "-", nil
|
|
}
|
|
if opts.Output != "" {
|
|
return opts.Output, nil
|
|
}
|
|
if suggested == "" {
|
|
return "", &cmdutil.Error{
|
|
Code: cmdutil.CodeInputMissingFlag,
|
|
Message: "server did not supply a filename and --output is unset",
|
|
Hint: "pass --output FILE (or --output - for stdout)",
|
|
}
|
|
}
|
|
base := filepath.Base(suggested)
|
|
if base == "" || base == "." || base == string(filepath.Separator) {
|
|
return "", &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("server returned an unusable filename %q", suggested),
|
|
Hint: "pass --output FILE explicitly",
|
|
}
|
|
}
|
|
return base, nil
|
|
}
|
|
|
|
// refuseIfExists returns CodeInputInvalidArgument when path is present on
|
|
// disk and clobber is false. Missing-file is success.
|
|
func refuseIfExists(path string, clobber bool) error {
|
|
if clobber {
|
|
return nil
|
|
}
|
|
_, err := os.Stat(path)
|
|
if errors.Is(err, os.ErrNotExist) {
|
|
return nil
|
|
}
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "stat %s", path)
|
|
}
|
|
return &cmdutil.Error{
|
|
Code: cmdutil.CodeInputInvalidArgument,
|
|
Message: fmt.Sprintf("%s already exists", path),
|
|
Hint: "pass --clobber to overwrite",
|
|
}
|
|
}
|
|
|
|
// streamToFile copies body into a newly-created file at path. On any
|
|
// streaming error the partial file is removed so callers don't see a
|
|
// truncated artifact at the user-visible path.
|
|
func streamToFile(body io.Reader, path string) error {
|
|
f, err := os.Create(path)
|
|
if err != nil {
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "create %s", path)
|
|
}
|
|
if _, err := io.Copy(f, body); err != nil {
|
|
_ = f.Close()
|
|
_ = os.Remove(path)
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "write %s", path)
|
|
}
|
|
if err := f.Close(); err != nil {
|
|
_ = os.Remove(path)
|
|
return cmdutil.Wrapf(cmdutil.CodeLocalFileIO, err, "close %s", path)
|
|
}
|
|
fmt.Fprintf(iostreams.IO.Err, "✓ Saved %s\n", path)
|
|
return nil
|
|
}
|