Method Get

client.go:47–127

Get downloads the configured source to the destination.

(ctx context.Context, req *Request)

// Get downloads the configured source to the destination.
func (c *Client) Get(ctx context.Context, req *Request) (*GetResult, error) {
	if err := c.configure(); err != nil {
		return nil, err
	}

	// Pass along the configured Getter client in the context for usage with the X-Terraform-Get feature.
	ctx = NewContextWithClient(ctx, c)

	// Store this locally since there are cases we swap this
	if req.GetMode == ModeInvalid {
		req.GetMode = ModeAny
	}

	// Client setting takes precedence for all requests
	if c.DisableSymlinks {
		req.DisableSymlinks = true
	}

	// If there is a subdir component, then we download the root separately
	// and then copy over the proper subdir.
	req.Src, req.subDir = SourceDirSubdir(req.Src)

	if req.subDir != "" {
		// Check if the subdirectory is attempting to traverse upwards, outside of
		// the cloned repository path.
		req.subDir = filepath.Clean(req.subDir)
		if containsDotDot(req.subDir) {
			return nil, fmt.Errorf("subdirectory component contain path traversal out of the repository")
		}

		// Prevent absolute paths, remove a leading path separator from the subdirectory
		if req.subDir[0] == os.PathSeparator {
			req.subDir = req.subDir[1:]
		}

		td, tdcloser, err := safetemp.Dir("", "getter")
		if err != nil {
			return nil, err
		}
		defer tdcloser.Close()

		req.realDst = req.Dst
		req.Dst = td
	}

	var multierr []error
	for _, g := range c.Getters {
		shouldDownload, err := Detect(req, g)
		if err != nil {
			return nil, err
		}
		if !shouldDownload {
			// the request should not be processed by that getter
			continue
		}

		result, getErr := c.get(ctx, req, g)
		if getErr != nil {