search.go 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119
  1. package client
  2. import (
  3. "fmt"
  4. "net/url"
  5. "sort"
  6. "strings"
  7. "text/tabwriter"
  8. "golang.org/x/net/context"
  9. Cli "github.com/docker/docker/cli"
  10. "github.com/docker/docker/opts"
  11. flag "github.com/docker/docker/pkg/mflag"
  12. "github.com/docker/docker/pkg/stringutils"
  13. "github.com/docker/docker/registry"
  14. "github.com/docker/engine-api/types"
  15. "github.com/docker/engine-api/types/filters"
  16. registrytypes "github.com/docker/engine-api/types/registry"
  17. )
  18. // CmdSearch searches the Docker Hub for images.
  19. //
  20. // Usage: docker search [OPTIONS] TERM
  21. func (cli *DockerCli) CmdSearch(args ...string) error {
  22. var (
  23. err error
  24. filterArgs = filters.NewArgs()
  25. flFilter = opts.NewListOpts(nil)
  26. )
  27. cmd := Cli.Subcmd("search", []string{"TERM"}, Cli.DockerCommands["search"].Description, true)
  28. noTrunc := cmd.Bool([]string{"-no-trunc"}, false, "Don't truncate output")
  29. cmd.Var(&flFilter, []string{"f", "-filter"}, "Filter output based on conditions provided")
  30. flLimit := cmd.Int([]string{"-limit"}, registry.DefaultSearchLimit, "Max number of search results")
  31. // Deprecated since Docker 1.12 in favor of "--filter"
  32. automated := cmd.Bool([]string{"#-automated"}, false, "Only show automated builds - DEPRECATED")
  33. stars := cmd.Uint([]string{"s", "#-stars"}, 0, "Only displays with at least x stars - DEPRECATED")
  34. cmd.Require(flag.Exact, 1)
  35. cmd.ParseFlags(args, true)
  36. for _, f := range flFilter.GetAll() {
  37. if filterArgs, err = filters.ParseFlag(f, filterArgs); err != nil {
  38. return err
  39. }
  40. }
  41. name := cmd.Arg(0)
  42. v := url.Values{}
  43. v.Set("term", name)
  44. indexInfo, err := registry.ParseSearchIndexInfo(name)
  45. if err != nil {
  46. return err
  47. }
  48. ctx := context.Background()
  49. authConfig := cli.resolveAuthConfig(ctx, indexInfo)
  50. requestPrivilege := cli.registryAuthenticationPrivilegedFunc(indexInfo, "search")
  51. encodedAuth, err := encodeAuthToBase64(authConfig)
  52. if err != nil {
  53. return err
  54. }
  55. options := types.ImageSearchOptions{
  56. RegistryAuth: encodedAuth,
  57. PrivilegeFunc: requestPrivilege,
  58. Filters: filterArgs,
  59. Limit: *flLimit,
  60. }
  61. unorderedResults, err := cli.client.ImageSearch(ctx, name, options)
  62. if err != nil {
  63. return err
  64. }
  65. results := searchResultsByStars(unorderedResults)
  66. sort.Sort(results)
  67. w := tabwriter.NewWriter(cli.out, 10, 1, 3, ' ', 0)
  68. fmt.Fprintf(w, "NAME\tDESCRIPTION\tSTARS\tOFFICIAL\tAUTOMATED\n")
  69. for _, res := range results {
  70. // --automated and -s, --stars are deprecated since Docker 1.12
  71. if (*automated && !res.IsAutomated) || (int(*stars) > res.StarCount) {
  72. continue
  73. }
  74. desc := strings.Replace(res.Description, "\n", " ", -1)
  75. desc = strings.Replace(desc, "\r", " ", -1)
  76. if !*noTrunc && len(desc) > 45 {
  77. desc = stringutils.Truncate(desc, 42) + "..."
  78. }
  79. fmt.Fprintf(w, "%s\t%s\t%d\t", res.Name, desc, res.StarCount)
  80. if res.IsOfficial {
  81. fmt.Fprint(w, "[OK]")
  82. }
  83. fmt.Fprint(w, "\t")
  84. if res.IsAutomated {
  85. fmt.Fprint(w, "[OK]")
  86. }
  87. fmt.Fprint(w, "\n")
  88. }
  89. w.Flush()
  90. return nil
  91. }
  92. // SearchResultsByStars sorts search results in descending order by number of stars.
  93. type searchResultsByStars []registrytypes.SearchResult
  94. func (r searchResultsByStars) Len() int { return len(r) }
  95. func (r searchResultsByStars) Swap(i, j int) { r[i], r[j] = r[j], r[i] }
  96. func (r searchResultsByStars) Less(i, j int) bool { return r[j].StarCount < r[i].StarCount }