package api import ( "bytes" "encoding/json" "fmt" "io" "io/ioutil" "net/http" "os" "regexp" "sort" "strconv" "strings" "github.com/cli/cli/pkg/cmdutil" "github.com/cli/cli/pkg/iostreams" "github.com/cli/cli/pkg/jsoncolor" "github.com/spf13/cobra" ) type ApiOptions struct { IO *iostreams.IOStreams RequestMethod string RequestMethodPassed bool RequestPath string RequestInputFile string MagicFields []string RawFields []string RequestHeaders []string ShowResponseHeaders bool HttpClient func() (*http.Client, error) } func NewCmdApi(f *cmdutil.Factory, runF func(*ApiOptions) error) *cobra.Command { opts := ApiOptions{ IO: f.IOStreams, HttpClient: f.HttpClient, } cmd := &cobra.Command{ Use: "api ", Short: "Make an authenticated GitHub API request", Long: `Makes an authenticated HTTP request to the GitHub API and prints the response. The argument should either be a path of a GitHub API v3 endpoint, or "graphql" to access the GitHub API v4. The default HTTP request method is "GET" normally and "POST" if any parameters were added. Override the method with '--method'. Pass one or more '--raw-field' values in "=" format to add JSON-encoded string parameters to the POST body. The '--field' flag behaves like '--raw-field' with magic type conversion based on the format of the value: - literal values "true", "false", "null", and integer numbers get converted to appropriate JSON types; - if the value starts with "@", the rest of the value is interpreted as a filename to read the value from. Pass "-" to read from standard input. Raw request body may be passed from the outside via a file specified by '--input'. Pass "-" to read from standard input. In this mode, parameters specified via '--field' flags are serialized into URL query parameters. `, Args: cobra.ExactArgs(1), RunE: func(c *cobra.Command, args []string) error { opts.RequestPath = args[0] opts.RequestMethodPassed = c.Flags().Changed("method") if runF != nil { return runF(&opts) } return apiRun(&opts) }, } cmd.Flags().StringVarP(&opts.RequestMethod, "method", "X", "GET", "The HTTP method for the request") cmd.Flags().StringArrayVarP(&opts.MagicFields, "field", "F", nil, "Add a parameter of inferred type") cmd.Flags().StringArrayVarP(&opts.RawFields, "raw-field", "f", nil, "Add a string parameter") cmd.Flags().StringArrayVarP(&opts.RequestHeaders, "header", "H", nil, "Add an additional HTTP request header") cmd.Flags().BoolVarP(&opts.ShowResponseHeaders, "include", "i", false, "Include HTTP response headers in the output") cmd.Flags().StringVar(&opts.RequestInputFile, "input", "", "The file to use as body for the HTTP request") return cmd } func apiRun(opts *ApiOptions) error { params, err := parseFields(opts) if err != nil { return err } method := opts.RequestMethod requestPath := opts.RequestPath requestHeaders := opts.RequestHeaders var requestBody interface{} = params if !opts.RequestMethodPassed && (len(params) > 0 || opts.RequestInputFile != "") { method = "POST" } if opts.RequestInputFile != "" { file, size, err := openUserFile(opts.RequestInputFile, opts.IO.In) if err != nil { return err } defer file.Close() requestPath = addQuery(requestPath, params) requestBody = file if size >= 0 { requestHeaders = append([]string{fmt.Sprintf("Content-Length: %d", size)}, requestHeaders...) } } httpClient, err := opts.HttpClient() if err != nil { return err } resp, err := httpRequest(httpClient, method, requestPath, requestBody, requestHeaders) if err != nil { return err } if opts.ShowResponseHeaders { fmt.Fprintln(opts.IO.Out, resp.Proto, resp.Status) printHeaders(opts.IO.Out, resp.Header, opts.IO.ColorEnabled()) fmt.Fprint(opts.IO.Out, "\r\n") } if resp.StatusCode == 204 { return nil } var responseBody io.Reader = resp.Body defer resp.Body.Close() isJSON, _ := regexp.MatchString(`[/+]json(;|$)`, resp.Header.Get("Content-Type")) var serverError string if isJSON && (opts.RequestPath == "graphql" || resp.StatusCode >= 400) { responseBody, serverError, err = parseErrorResponse(responseBody, resp.StatusCode) if err != nil { return err } } if isJSON && opts.IO.ColorEnabled() { err = jsoncolor.Write(opts.IO.Out, responseBody, " ") if err != nil { return err } } else { _, err = io.Copy(opts.IO.Out, responseBody) if err != nil { return err } } if serverError != "" { fmt.Fprintf(opts.IO.ErrOut, "gh: %s\n", serverError) return cmdutil.SilentError } else if resp.StatusCode > 299 { fmt.Fprintf(opts.IO.ErrOut, "gh: HTTP %d\n", resp.StatusCode) return cmdutil.SilentError } return nil } func printHeaders(w io.Writer, headers http.Header, colorize bool) { var names []string for name := range headers { if name == "Status" { continue } names = append(names, name) } sort.Strings(names) var headerColor, headerColorReset string if colorize { headerColor = "\x1b[1;34m" // bright blue headerColorReset = "\x1b[m" } for _, name := range names { fmt.Fprintf(w, "%s%s%s: %s\r\n", headerColor, name, headerColorReset, strings.Join(headers[name], ", ")) } } func parseFields(opts *ApiOptions) (map[string]interface{}, error) { params := make(map[string]interface{}) for _, f := range opts.RawFields { key, value, err := parseField(f) if err != nil { return params, err } params[key] = value } for _, f := range opts.MagicFields { key, strValue, err := parseField(f) if err != nil { return params, err } value, err := magicFieldValue(strValue, opts.IO.In) if err != nil { return params, fmt.Errorf("error parsing %q value: %w", key, err) } params[key] = value } return params, nil } func parseField(f string) (string, string, error) { idx := strings.IndexRune(f, '=') if idx == -1 { return f, "", fmt.Errorf("field %q requires a value separated by an '=' sign", f) } return f[0:idx], f[idx+1:], nil } func magicFieldValue(v string, stdin io.ReadCloser) (interface{}, error) { if strings.HasPrefix(v, "@") { return readUserFile(v[1:], stdin) } if n, err := strconv.Atoi(v); err == nil { return n, nil } switch v { case "true": return true, nil case "false": return false, nil case "null": return nil, nil default: return v, nil } } func readUserFile(fn string, stdin io.ReadCloser) ([]byte, error) { var r io.ReadCloser if fn == "-" { r = stdin } else { var err error r, err = os.Open(fn) if err != nil { return nil, err } } defer r.Close() return ioutil.ReadAll(r) } func openUserFile(fn string, stdin io.ReadCloser) (io.ReadCloser, int64, error) { if fn == "-" { return stdin, -1, nil } r, err := os.Open(fn) if err != nil { return r, -1, err } s, err := os.Stat(fn) if err != nil { return r, -1, err } return r, s.Size(), nil } func parseErrorResponse(r io.Reader, statusCode int) (io.Reader, string, error) { bodyCopy := &bytes.Buffer{} b, err := ioutil.ReadAll(io.TeeReader(r, bodyCopy)) if err != nil { return r, "", err } var parsedBody struct { Message string Errors []struct { Message string } } err = json.Unmarshal(b, &parsedBody) if err != nil { return r, "", err } if parsedBody.Message != "" { return bodyCopy, fmt.Sprintf("%s (HTTP %d)", parsedBody.Message, statusCode), nil } else if len(parsedBody.Errors) > 0 { msgs := make([]string, len(parsedBody.Errors)) for i, e := range parsedBody.Errors { msgs[i] = e.Message } return bodyCopy, strings.Join(msgs, "\n"), nil } return bodyCopy, "", nil }