Function fetchFile

pkg/cmd/repo/read-file/http.go:125–169

fetchFile retrieves a single path's metadata and inline content via the REST Contents API. It returns a typed error when the path is a directory, symlink, or submodule. Content is populated only when the API returns it inline; larger files come back with empty content, and it is up to the caller to

(httpClient *http.Client, repo ghrepo.Interface, filePath, ref string)

// it is up to the caller to fetch the raw bytes via fetchRawFile when the content is actually
// needed.
func fetchFile(httpClient *http.Client, repo ghrepo.Interface, filePath, ref string) (*repoFile, error) {
	content, err := fetchContent(httpClient, repo, filePath, ref)
	if err != nil {
		return nil, err
	}

	if content.Type != "file" {
		// The path resolved to something other than a regular file. Use content.Path
		// (the API-sanitized path) rather than the user input in these messages, so a
		// crafted path cannot smuggle terminal escape sequences into our output.
		switch content.Type {
		case "dir":
			return nil, fmt.Errorf("path %q is a directory; use `gh repo read-dir` instead", content.Path)
		case "symlink":
			return nil, fmt.Errorf("path %q is a symlink to %q which does not exist", content.Path, content.Target)
		case "submodule":
			return nil, fmt.Errorf("path %q is a submodule (%s at %s)", content.Path, content.SubmoduleGitURL, content.SHA)
		default:
			return nil, fmt.Errorf("path %q is not a regular file (type: %s)", content.Path, content.Type)
		}
	}

	file := &repoFile{
		Name:        content.Name,
		Path:        content.Path,
		SHA:         content.SHA,
		Size:        content.Size,
		URL:         content.URL,
		HTMLURL:     content.HTMLURL,
		GitURL:      content.GitURL,
		DownloadURL: content.DownloadURL,
		Type:        content.Type,
		Encoding:    content.Encoding,
	}

	if content.Encoding == "base64" && content.Content != "" {
		decoded, err := base64.StdEncoding.DecodeString(content.Content)
		if err != nil {
			return nil, fmt.Errorf("failed to decode base64 file content: %w", err)
		}
		file.Content = decoded
	}

	return file, nil
}

// fetchRawFile retrieves the raw bytes of a file, used for files larger than the
// 1 MB inline content limit of the Contents API.