1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470
|
package shared
import (
"context"
"errors"
"fmt"
"io"
"os"
"os/exec"
"path/filepath"
"regexp"
"slices"
"strconv"
"strings"
"time"
"github.com/flosch/pongo2"
"golang.org/x/sys/unix"
yaml "gopkg.in/yaml.v2"
)
const (
ContextKeyEnviron = ContextKey("environ")
ContextKeyStderr = ContextKey("stderr")
EnvRootUUID = "DISTROBUILDER_ROOT_UUID"
)
// EnvVariable represents a environment variable.
type EnvVariable struct {
Value string
Set bool
}
// Environment represents a set of environment variables.
type Environment map[string]EnvVariable
// ContextKey type.
type ContextKey string
// WriteFunc type.
type WriteFunc func([]byte) (int, error)
// Write implements io.Writer interface.
func (w WriteFunc) Write(b []byte) (int, error) {
return w(b)
}
// CaseInsensitive returns case insensive pattern used by filepath.Glob or filepath.Match.
func CaseInsensitive(s string) (pattern string) {
s1 := strings.ToLower(s)
s2 := strings.ToUpper(s)
for i := range s {
a := s1[i : i+1]
b := s2[i : i+1]
if a != b {
pattern += "[" + a + b + "]"
} else if strings.Contains("?*[]/", a) {
pattern += a
} else {
pattern += "\\" + a
}
}
return
}
// FindFirstMatch find the first matched file case insensitive.
func FindFirstMatch(dir string, elem ...string) (found string, err error) {
matches, err := FindAllMatches(dir, elem...)
if err != nil {
return
}
found = matches[0]
return
}
// FindAllMatches find all the matched files case insensitive.
func FindAllMatches(dir string, elem ...string) (matches []string, err error) {
names := []string{dir}
for _, name := range elem {
names = append(names, CaseInsensitive(name))
}
pattern := filepath.Join(names...)
matches, err = filepath.Glob(pattern)
if err != nil {
return
}
if len(matches) == 0 {
err = fmt.Errorf("No match found %s", pattern)
return
}
return
}
// Copy copies a file.
func Copy(src, dest string) error {
var err error
srcFile, err := os.Open(src)
if err != nil {
return fmt.Errorf("Failed to open file %q: %w", src, err)
}
defer srcFile.Close()
destFile, err := os.Create(dest)
if err != nil {
return fmt.Errorf("Failed to create file %q: %w", dest, err)
}
defer destFile.Close()
_, err = io.Copy(destFile, srcFile)
if err != nil {
return fmt.Errorf("Failed to copy file: %w", err)
}
return destFile.Sync()
}
// RunCommand runs a command. Stdout is written to the given io.Writer. If nil, it's written to the real stdout. Stderr is always written to the real stderr.
func RunCommand(ctx context.Context, stdin io.Reader, stdout io.Writer, name string, arg ...string) error {
cmd := exec.CommandContext(ctx, name, arg...)
env, ok := ctx.Value(ContextKeyEnviron).([]string)
if ok && len(env) > 0 {
cmd.Env = append(os.Environ(), env...)
}
if stdin != nil {
cmd.Stdin = stdin
}
if stdout != nil {
cmd.Stdout = stdout
} else {
cmd.Stdout = os.Stdout
}
stderr, ok := ctx.Value(ContextKeyStderr).(io.Writer)
if ok && stderr != nil {
cmd.Stderr = stderr
} else {
cmd.Stderr = os.Stderr
}
return cmd.Run()
}
// RunScript runs a script hereby setting the SHELL and PATH env variables,
// and redirecting the process's stdout and stderr to the real stdout and stderr
// respectively.
func RunScript(ctx context.Context, content string) error {
fd, err := unix.MemfdCreate("tmp", 0)
if err != nil {
return fmt.Errorf("Failed to create memfd: %w", err)
}
defer unix.Close(fd)
_, err = unix.Write(int(fd), []byte(content))
if err != nil {
return fmt.Errorf("Failed to write to memfd: %w", err)
}
fdPath := fmt.Sprintf("/proc/self/fd/%d", fd)
return RunCommand(ctx, nil, nil, fdPath)
}
// Pack creates an uncompressed tarball.
func Pack(ctx context.Context, filename, compression, path string, args ...string) (string, error) {
err := RunCommand(ctx, nil, nil, "tar", append([]string{"--xattrs", "-cf", filename, "-C", path, "--sort=name"}, args...)...)
if err != nil {
// Clean up incomplete tarball
os.Remove(filename)
return "", fmt.Errorf("Failed to create tarball: %w", err)
}
return compressTarball(ctx, filename, compression)
}
// PackUpdate updates an existing tarball.
func PackUpdate(ctx context.Context, filename, compression, path string, args ...string) (string, error) {
err := RunCommand(ctx, nil, nil, "tar", append([]string{"--xattrs", "-uf", filename, "-C", path, "--sort=name"}, args...)...)
if err != nil {
return "", fmt.Errorf("Failed to update tarball: %w", err)
}
return compressTarball(ctx, filename, compression)
}
// compressTarball compresses a tarball, or not.
func compressTarball(ctx context.Context, filename, compression string) (string, error) {
fileExtension := ""
args := []string{"-f", filename}
compression, level, err := ParseCompression(compression)
if err != nil {
return "", fmt.Errorf("Failed to parse compression level: %w", err)
}
if level != nil {
if compression == "zstd" && *level > 19 {
args = append(args, "--ultra")
}
args = append(args, "-"+strconv.Itoa(*level))
}
// If supported, use as many threads as possible.
if slices.Contains([]string{"zstd", "xz", "lzma"}, compression) {
args = append(args, "--threads=0")
}
switch compression {
case "lzop", "zstd":
// Remove the uncompressed file as the compress fails to do so.
defer os.Remove(filename)
fallthrough
case "bzip2", "xz", "lzip", "lzma", "gzip":
err := RunCommand(ctx, nil, nil, compression, args...)
if err != nil {
return "", fmt.Errorf("Failed to compress tarball %q: %w", filename, err)
}
}
switch compression {
case "lzop":
fileExtension = "lzo"
case "zstd":
fileExtension = "zst"
case "bzip2":
fileExtension = "bz2"
case "xz":
fileExtension = "xz"
case "lzip":
fileExtension = "lz"
case "lzma":
fileExtension = "lzma"
case "gzip":
fileExtension = "gz"
}
if fileExtension == "" {
return filename, nil
}
return fmt.Sprintf("%s.%s", filename, fileExtension), nil
}
// GetExpiryDate returns an expiry date based on the creationDate and format.
func GetExpiryDate(creationDate time.Time, format string) time.Time {
regex := regexp.MustCompile(`(?:(\d+)(s|m|h|d|w))*`)
expiryDate := creationDate
for _, match := range regex.FindAllStringSubmatch(format, -1) {
// Ignore empty matches
if match[0] == "" {
continue
}
var duration time.Duration
switch match[2] {
case "s":
duration = time.Second
case "m":
duration = time.Minute
case "h":
duration = time.Hour
case "d":
duration = 24 * time.Hour
case "w":
duration = 7 * 24 * time.Hour
}
// Ignore any error since it will be an integer.
value, _ := strconv.Atoi(match[1])
expiryDate = expiryDate.Add(time.Duration(value) * duration)
}
return expiryDate
}
// RenderTemplate renders a pongo2 template.
func RenderTemplate(template string, iface interface{}) (string, error) {
// Serialize interface
data, err := yaml.Marshal(iface)
if err != nil {
return "", err
}
// Decode document and write it to a pongo2 Context
var ctx pongo2.Context
err = yaml.Unmarshal(data, &ctx)
if err != nil {
return "", fmt.Errorf("Failed unmarshalling data: %w", err)
}
// Load template from string
tpl, err := pongo2.FromString("{% autoescape off %}" + template + "{% endautoescape %}")
if err != nil {
return "", err
}
// Get rendered template
ret, err := tpl.Execute(ctx)
if err != nil {
return ret, err
}
// Looks like we're nesting templates so run pongo again
if strings.Contains(ret, "{{") || strings.Contains(ret, "{%") {
return RenderTemplate(ret, iface)
}
return ret, err
}
// SetEnvVariables sets the provided environment variables and returns the
// old ones.
func SetEnvVariables(env Environment) Environment {
oldEnv := Environment{}
for k, v := range env {
// Check whether the env variables are set at the moment
oldVal, set := os.LookupEnv(k)
// Store old env variables
oldEnv[k] = EnvVariable{
Value: oldVal,
Set: set,
}
if v.Set {
os.Setenv(k, v.Value)
} else {
os.Unsetenv(k)
}
}
return oldEnv
}
// RsyncLocal copies src to dest using rsync.
func RsyncLocal(ctx context.Context, src string, dest string) error {
err := RunCommand(ctx, nil, nil, "rsync", "-aHASX", "--devices", src, dest)
if err != nil {
return fmt.Errorf("Failed to copy %q to %q: %w", src, dest, err)
}
return nil
}
// Retry retries a function up to <attempts> times. This is especially useful for networking.
func Retry(f func() error, attempts uint) error {
var err error
for i := uint(0); i < attempts; i++ {
err = f()
// Stop retrying if the call succeeded or if the context has been cancelled.
if err == nil || err != nil && errors.Is(err, context.Canceled) {
break
}
time.Sleep(time.Second)
}
return err
}
// ParseCompression extracts the compression method and level (if any) from the
// compression flag.
func ParseCompression(compression string) (string, *int, error) {
levelRegex := regexp.MustCompile(`^([\w]+)-(\d{1,2})$`)
match := levelRegex.FindStringSubmatch(compression)
if match != nil {
compression = match[1]
level, err := strconv.Atoi(match[2])
if err != nil {
return "", nil, err
}
switch compression {
case "zstd":
if 1 <= level && level <= 22 {
return compression, &level, nil
}
case "bzip2", "gzip", "lzo", "lzop":
// The standalone tool is named lzop, but mksquashfs
// accepts only lzo. For convenience, accept both.
if compression == "lzo" {
compression = "lzop"
}
if 1 <= level && level <= 9 {
return compression, &level, nil
}
case "lzip", "lzma", "xz":
if 0 <= level && level <= 9 {
return compression, &level, nil
}
default:
return "", nil, fmt.Errorf("Compression method %q does not support specifying levels", compression)
}
return "", nil, fmt.Errorf("Invalid compression level %q for method %q", level, compression)
}
if compression == "lzo" {
compression = "lzop"
}
return compression, nil, nil
}
// ParseSquashfsCompression extracts the compression method and level (if any)
// from the compression flag for use with mksquashfs.
func ParseSquashfsCompression(compression string) (string, *int, error) {
levelRegex := regexp.MustCompile(`^([\w]+)-(\d{1,2})$`)
match := levelRegex.FindStringSubmatch(compression)
if match != nil {
compression = match[1]
level, err := strconv.Atoi(match[2])
if err != nil {
return "", nil, err
}
switch compression {
case "zstd":
if 1 <= level && level <= 22 {
return compression, &level, nil
}
case "gzip", "lzo", "lzop":
// mkskquashfs accepts only lzo, but the standalone
// tool is named lzop. For convenience, accept both.
if compression == "lzop" {
compression = "lzo"
}
if 1 <= level && level <= 9 {
return compression, &level, nil
}
default:
return "", nil, fmt.Errorf("Squashfs compression method %q does not support specifying levels", compression)
}
return "", nil, fmt.Errorf("Invalid squashfs compression level %q for method %q", level, compression)
}
if compression == "lzop" {
compression = "lzo"
}
if slices.Contains([]string{"gzip", "lzo", "lz4", "xz", "zstd", "lzma"}, compression) {
return compression, nil, nil
}
return "", nil, fmt.Errorf("Invalid squashfs compression method %q", compression)
}
|