github.com/tonistiigi/docker@v0.10.1-0.20240229224939-974013b0dc6a/client/image_list.go (about)

     1  package client // import "github.com/docker/docker/client"
     2  
     3  import (
     4  	"context"
     5  	"encoding/json"
     6  	"net/url"
     7  
     8  	"github.com/docker/docker/api/types/filters"
     9  	"github.com/docker/docker/api/types/image"
    10  	"github.com/docker/docker/api/types/versions"
    11  )
    12  
    13  // ImageList returns a list of images in the docker host.
    14  func (cli *Client) ImageList(ctx context.Context, options image.ListOptions) ([]image.Summary, error) {
    15  	var images []image.Summary
    16  
    17  	// Make sure we negotiated (if the client is configured to do so),
    18  	// as code below contains API-version specific handling of options.
    19  	//
    20  	// Normally, version-negotiation (if enabled) would not happen until
    21  	// the API request is made.
    22  	if err := cli.checkVersion(ctx); err != nil {
    23  		return images, err
    24  	}
    25  
    26  	query := url.Values{}
    27  
    28  	optionFilters := options.Filters
    29  	referenceFilters := optionFilters.Get("reference")
    30  	if versions.LessThan(cli.version, "1.25") && len(referenceFilters) > 0 {
    31  		query.Set("filter", referenceFilters[0])
    32  		for _, filterValue := range referenceFilters {
    33  			optionFilters.Del("reference", filterValue)
    34  		}
    35  	}
    36  	if optionFilters.Len() > 0 {
    37  		//nolint:staticcheck // ignore SA1019 for old code
    38  		filterJSON, err := filters.ToParamWithVersion(cli.version, optionFilters)
    39  		if err != nil {
    40  			return images, err
    41  		}
    42  		query.Set("filters", filterJSON)
    43  	}
    44  	if options.All {
    45  		query.Set("all", "1")
    46  	}
    47  	if options.SharedSize && versions.GreaterThanOrEqualTo(cli.version, "1.42") {
    48  		query.Set("shared-size", "1")
    49  	}
    50  
    51  	serverResp, err := cli.get(ctx, "/images/json", query, nil)
    52  	defer ensureReaderClosed(serverResp)
    53  	if err != nil {
    54  		return images, err
    55  	}
    56  
    57  	err = json.NewDecoder(serverResp.body).Decode(&images)
    58  	return images, err
    59  }