|
| 1 | +// SPDX-FileCopyrightText: Copyright The Lima Authors |
| 2 | +// SPDX-License-Identifier: Apache-2.0 |
| 3 | + |
| 4 | +package limatmpl |
| 5 | + |
| 6 | +import ( |
| 7 | + "errors" |
| 8 | + "fmt" |
| 9 | + "net/url" |
| 10 | + "path" |
| 11 | + "path/filepath" |
| 12 | + "runtime" |
| 13 | + "strings" |
| 14 | +) |
| 15 | + |
| 16 | +// UseAbsLocators will replace all relative template locators with absolute ones, so this template |
| 17 | +// can be stored anywhere and still reference the same base templates and files. |
| 18 | +func (tmpl *Template) UseAbsLocators() error { |
| 19 | + err := tmpl.useAbsLocators() |
| 20 | + return tmpl.ClearOnError(err) |
| 21 | +} |
| 22 | + |
| 23 | +func (tmpl *Template) useAbsLocators() error { |
| 24 | + if err := tmpl.Unmarshal(); err != nil { |
| 25 | + return err |
| 26 | + } |
| 27 | + basePath, err := basePath(tmpl.Locator) |
| 28 | + if err != nil { |
| 29 | + return err |
| 30 | + } |
| 31 | + for i, baseLocator := range tmpl.Config.Base { |
| 32 | + absLocator, err := absPath(baseLocator.URL, basePath) |
| 33 | + if err != nil { |
| 34 | + return err |
| 35 | + } |
| 36 | + if i == 0 { |
| 37 | + // base can be either a single string (URL), or a single locator object, or a list whose first element can be either a string or an object |
| 38 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!str\")) |= %q\n", absLocator)) |
| 39 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!map\") | .url) |= %q\n", absLocator)) |
| 40 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!seq\" and (.[0] | type) == \"!!str\") | .[0]) |= %q\n", absLocator)) |
| 41 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base | select(type == \"!!seq\" and (.[0] | type) == \"!!map\") | .[0].url) |= %q\n", absLocator)) |
| 42 | + } else { |
| 43 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base[%d] | select(type == \"!!str\")) |= %q\n", i, absLocator)) |
| 44 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.base[%d] | select(type == \"!!map\") | .url) |= %q\n", i, absLocator)) |
| 45 | + } |
| 46 | + } |
| 47 | + for i, p := range tmpl.Config.Probes { |
| 48 | + if p.File != nil { |
| 49 | + absLocator, err := absPath(p.File.URL, basePath) |
| 50 | + if err != nil { |
| 51 | + return err |
| 52 | + } |
| 53 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.probes[%d].file | select(type == \"!!str\")) = %q\n", i, absLocator)) |
| 54 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.probes[%d].file | select(type == \"!!map\") | .url) = %q\n", i, absLocator)) |
| 55 | + } |
| 56 | + } |
| 57 | + for i, p := range tmpl.Config.Provision { |
| 58 | + if p.File != nil { |
| 59 | + absLocator, err := absPath(p.File.URL, basePath) |
| 60 | + if err != nil { |
| 61 | + return err |
| 62 | + } |
| 63 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.provision[%d].file | select(type == \"!!str\")) = %q\n", i, absLocator)) |
| 64 | + tmpl.expr.WriteString(fmt.Sprintf("| ($a.provision[%d].file | select(type == \"!!map\") | .url) = %q\n", i, absLocator)) |
| 65 | + } |
| 66 | + } |
| 67 | + return tmpl.evalExpr() |
| 68 | +} |
| 69 | + |
| 70 | +// withVolume adds the volume name of the current working directory to a path without volume name. |
| 71 | +// On Windows filepath.Abs() only returns a "rooted" name, but does not add the volume name. |
| 72 | +// withVolume also normalizes all path separators to the platform native one. |
| 73 | +func withVolume(path string) (string, error) { |
| 74 | + if runtime.GOOS == "windows" && filepath.VolumeName(path) == "" { |
| 75 | + root, err := filepath.Abs("/") |
| 76 | + if err != nil { |
| 77 | + return "", err |
| 78 | + } |
| 79 | + path = filepath.VolumeName(root) + path |
| 80 | + } |
| 81 | + return filepath.Clean(path), nil |
| 82 | +} |
| 83 | + |
| 84 | +// basePath returns the locator in absolute format, but without the filename part. |
| 85 | +func basePath(locator string) (string, error) { |
| 86 | + u, err := url.Parse(locator) |
| 87 | + // Single-letter schemes will be drive names on Windows, e.g. "c:/foo" |
| 88 | + if err == nil && len(u.Scheme) > 1 { |
| 89 | + // path.Dir("") returns ".", which must be removed for url.JoinPath() to do the right thing later |
| 90 | + return u.Scheme + "://" + strings.TrimSuffix(path.Dir(path.Join(u.Host, u.Path)), "."), nil |
| 91 | + } |
| 92 | + base, err := filepath.Abs(filepath.Dir(locator)) |
| 93 | + if err != nil { |
| 94 | + return "", err |
| 95 | + } |
| 96 | + return withVolume(base) |
| 97 | +} |
| 98 | + |
| 99 | +// absPath either returns the locator directly, or combines it with the basePath if the locator is a relative path. |
| 100 | +func absPath(locator, basePath string) (string, error) { |
| 101 | + if locator == "" { |
| 102 | + return "", errors.New("locator is empty") |
| 103 | + } |
| 104 | + u, err := url.Parse(locator) |
| 105 | + if err == nil && len(u.Scheme) > 1 { |
| 106 | + return locator, nil |
| 107 | + } |
| 108 | + // Check for rooted locator; filepath.IsAbs() returns false on Windows when the volume name is missing |
| 109 | + volumeLen := len(filepath.VolumeName(locator)) |
| 110 | + if locator[volumeLen] != '/' && locator[volumeLen] != filepath.Separator { |
| 111 | + switch { |
| 112 | + case basePath == "": |
| 113 | + return "", errors.New("basePath is empty") |
| 114 | + case basePath == "-": |
| 115 | + return "", errors.New("can't use relative paths when reading template from STDIN") |
| 116 | + case strings.Contains(locator, "../"): |
| 117 | + return "", fmt.Errorf("relative locator path %q must not contain '../' segments", locator) |
| 118 | + case volumeLen != 0: |
| 119 | + return "", fmt.Errorf("relative locator path %q must not include a volume name", locator) |
| 120 | + } |
| 121 | + u, err = url.Parse(basePath) |
| 122 | + if err != nil { |
| 123 | + return "", err |
| 124 | + } |
| 125 | + if len(u.Scheme) > 1 { |
| 126 | + return u.JoinPath(locator).String(), nil |
| 127 | + } |
| 128 | + locator = filepath.Join(basePath, locator) |
| 129 | + } |
| 130 | + return withVolume(locator) |
| 131 | +} |
0 commit comments