github.com/rish1988/moby@v25.0.2+incompatible/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  	// Make sure we negotiated (if the client is configured to do so),
    16  	// as code below contains API-version specific handling of options.
    17  	//
    18  	// Normally, version-negotiation (if enabled) would not happen until
    19  	// the API request is made.
    20  	cli.checkVersion(ctx)
    21  
    22  	var images []image.Summary
    23  	query := url.Values{}
    24  
    25  	optionFilters := options.Filters
    26  	referenceFilters := optionFilters.Get("reference")
    27  	if versions.LessThan(cli.version, "1.25") && len(referenceFilters) > 0 {
    28  		query.Set("filter", referenceFilters[0])
    29  		for _, filterValue := range referenceFilters {
    30  			optionFilters.Del("reference", filterValue)
    31  		}
    32  	}
    33  	if optionFilters.Len() > 0 {
    34  		//nolint:staticcheck // ignore SA1019 for old code
    35  		filterJSON, err := filters.ToParamWithVersion(cli.version, optionFilters)
    36  		if err != nil {
    37  			return images, err
    38  		}
    39  		query.Set("filters", filterJSON)
    40  	}
    41  	if options.All {
    42  		query.Set("all", "1")
    43  	}
    44  	if options.SharedSize && versions.GreaterThanOrEqualTo(cli.version, "1.42") {
    45  		query.Set("shared-size", "1")
    46  	}
    47  
    48  	serverResp, err := cli.get(ctx, "/images/json", query, nil)
    49  	defer ensureReaderClosed(serverResp)
    50  	if err != nil {
    51  		return images, err
    52  	}
    53  
    54  	err = json.NewDecoder(serverResp.body).Decode(&images)
    55  	return images, err
    56  }