symfony-cli · dunglas · Jan 15, 2024
diff --git a/commands/local_new.go b/commands/local_new.go
@@ -66,7 +66,7 @@ var localNewCmd = &console.Command{
 		&console.BoolFlag{Name: "webapp", Usage: "Add the webapp pack to get a fully configured web project"},
 		&console.BoolFlag{Name: "api", Usage: "Add the api pack to get a fully configured api project"},
 		&console.BoolFlag{Name: "book", Usage: "Clone the Symfony: The Fast Track book project"},
-		&console.BoolFlag{Name: "docker", Usage: "Enable Docker support"},
+		&console.BoolFlag{Name: "docker", Usage: "Use the Symfony Docker Skeleton (includes FrankenPHP)"},
 		&console.BoolFlag{Name: "no-git", Usage: "Do not initialize Git"},
 		&console.BoolFlag{Name: "upsun", Usage: "Initialize Upsun configuration"},
 		&console.BoolFlag{Name: "cloud", Usage: "Initialize Platform.sh configuration"},
@@ -110,6 +110,7 @@ var localNewCmd = &console.Command{
 		}

 		symfonyVersion := c.String("version")
+		symfonyDocker := c.Bool("docker")

 		if c.Bool("book") {
 			if symfonyVersion == "" {
@@ -126,9 +127,14 @@ var localNewCmd = &console.Command{
 			return book.Clone(symfonyVersion)
 		}

-		if symfonyVersion != "" && c.Bool("demo") {
+		demo := c.Bool("demo")
+
+		if symfonyVersion != "" && demo {
 			return console.Exit("The --version flag is not supported for the Symfony Demo", 1)
 		}
+		if symfonyDocker && demo {
+			return console.Exit("The --docker flag isn not supported for the Symfony Demo", 1)
+		}
 		if c.Bool("webapp") && c.Bool("no-git") {
 			return console.Exit("The --webapp flag cannot be used with --no-git", 1)
 		}
@@ -149,7 +155,11 @@ var localNewCmd = &console.Command{
 			return err
 		}

-		if err := createProjectWithComposer(c, dir, symfonyVersion); err != nil {
+		if symfonyDocker {
+			if err := createProjectWithSymfonyDocker(dir, symfonyVersion); err != nil {
+				return err
+			}
+		} else if err := createProjectWithComposer(c, dir, symfonyVersion); err != nil {
 			return err
 		}

@@ -385,6 +395,48 @@ func createProjectWithComposer(c *console.Context, dir, version string) error {
 	return runComposer(c, "", []string{"create-project", repo, dir, version}, c.Bool("debug"))
 }

+func createProjectWithSymfonyDocker(dir string, version string) error {
+	terminal.Println("* Creating a new Symfony project with Symfony Docker")
+
+	resp, err := http.Get("https://github.com/dunglas/symfony-docker/archive/refs/heads/main.tar.gz")
+	if err != nil {
+		return err
+	}
+
+	if err := os.MkdirAll(dir, 0755); err != nil {
+		return err
+	}
+	if err := util.Untar(resp.Body, dir, "symfony-docker-main"); err != nil {
+		return err
+	}
+
+	cmd := exec.Command("docker", "compose", "build", "--no-cache")
+	cmd.Dir = dir
+	cmd.Stdin = os.Stdin
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	if err := cmd.Run(); err != nil {
+		return err
+	}
+
+	// Runs the installer
+	cmd = exec.Command("docker", "compose", "run", "php", "bin/console", "--version")
+	cmd.Dir = dir
+	cmd.Stdin = os.Stdin
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	if version != "" {
+		cmd.Env = append(cmd.Environ(), "SYMFONY_VERSION="+version)
+	}
+	if err := cmd.Run(); err != nil {
+		return err
+	}
+
+	terminal.Printf("Run `docker compose up -d --wait` in \"%s\" to start your project\n", dir)
+
+	return nil
+}
+
 func runComposer(c *console.Context, dir string, args []string, debug bool) error {
 	var (
 		buf bytes.Buffer

diff --git a/util/untar.go b/util/untar.go
@@ -0,0 +1,171 @@
+package util
+
+import (
+	"archive/tar"
+	"compress/gzip"
+	"errors"
+	"fmt"
+	"io"
+	"io/fs"
+	"log"
+	"os"
+	"path"
+	"path/filepath"
+	"runtime"
+	"strings"
+	"time"
+)
+
+// Untar reads the gzipped tar file from r and writes it into dir.
+//
+// Adapted from https://raw.githubusercontent.com/dunglas/frankenphp/main/embed.go
+func Untar(r io.Reader, dir string, archiveDirectory string) (err error) {
+	t0 := time.Now()
+	nFiles := 0
+	madeDir := map[string]bool{}
+
+	gr, err := gzip.NewReader(r)
+	if err != nil {
+		return err
+	}
+
+	tr := tar.NewReader(gr)
+	loggedChtimesError := false
+
+	for {
+		f, err := tr.Next()
+		if err == io.EOF {
+			break
+		}
+		if err != nil {
+			return fmt.Errorf("tar error: %w", err)
+		}
+		if f.Typeflag == tar.TypeXGlobalHeader {
+			// golang.org/issue/22748: git archive exports
+			// a global header ('g') which after Go 1.9
+			// (for a bit?) contained an empty filename.
+			// Ignore it.
+			continue
+		}
+		rel, err := nativeRelPath(f.Name)
+		if err != nil {
+			return fmt.Errorf("tar file contained invalid name %q: %v", f.Name, err)
+		}
+
+		fi := f.FileInfo()
+		mode := fi.Mode()
+
+		if filepath.Clean(rel) == filepath.Clean(archiveDirectory) {
+			continue
+		}
+
+		abs := filepath.Join(dir, strings.TrimPrefix(rel, archiveDirectory))
+		switch {
+		case mode.IsRegular():
+			// Make the directory. This is redundant because it should
+			// already be made by a directory entry in the tar
+			// beforehand. Thus, don't check for errors; the next
+			// write will fail with the same error.
+			dir := filepath.Dir(abs)
+			if !madeDir[dir] {
+				if err := os.MkdirAll(filepath.Dir(abs), mode.Perm()); err != nil {
+					return err
+				}
+				madeDir[dir] = true
+			}
+			if runtime.GOOS == "darwin" && mode&0111 != 0 {
+				// See comment in writeFile.
+				err := os.Remove(abs)
+				if err != nil && !errors.Is(err, fs.ErrNotExist) {
+					return err
+				}
+			}
+			wf, err := os.OpenFile(abs, os.O_RDWR|os.O_CREATE|os.O_TRUNC, mode.Perm())
+			if err != nil {
+				return err
+			}
+			n, err := io.Copy(wf, tr)
+			if closeErr := wf.Close(); closeErr != nil && err == nil {
+				err = closeErr
+			}
+			if err != nil {
+				return fmt.Errorf("error writing to %s: %v", abs, err)
+			}
+			if n != f.Size {
+				return fmt.Errorf("only wrote %d bytes to %s; expected %d", n, abs, f.Size)
+			}
+			modTime := f.ModTime
+			if modTime.After(t0) {
+				// Clamp modtimes at system time. See
+				// golang.org/issue/19062 when clock on
+				// buildlet was behind the gitmirror server
+				// doing the git-archive.
+				modTime = t0
+			}
+			if !modTime.IsZero() {
+				if err := os.Chtimes(abs, modTime, modTime); err != nil && !loggedChtimesError {
+					// benign error. Gerrit doesn't even set the
+					// modtime in these, and we don't end up relying
+					// on it anywhere (the gomote push command relies
+					// on digests only), so this is a little pointless
+					// for now.
+					log.Printf("error changing modtime: %v (further Chtimes errors suppressed)", err)
+					loggedChtimesError = true // once is enough
+				}
+			}
+			nFiles++
+		case mode.IsDir():
+			if err := os.MkdirAll(abs, mode.Perm()); err != nil {
+				return err
+			}
+			madeDir[abs] = true
+		case mode&os.ModeSymlink != 0:
+			// TODO: ignore these for now. They were breaking x/build tests.
+			// Implement these if/when we ever have a test that needs them.
+			// But maybe we'd have to skip creating them on Windows for some builders
+			// without permissions.
+		default:
+			return fmt.Errorf("tar file entry %s contained unsupported file type %v", f.Name, mode)
+		}
+	}
+	return nil
+}
+
+// nativeRelPath verifies that p is a non-empty relative path
+// using either slashes or the buildlet's native path separator,
+// and returns it canonicalized to the native path separator.
+func nativeRelPath(p string) (string, error) {
+	if p == "" {
+		return "", errors.New("path not provided")
+	}
+
+	if filepath.Separator != '/' && strings.Contains(p, string(filepath.Separator)) {
+		clean := filepath.Clean(p)
+		if filepath.IsAbs(clean) {
+			return "", fmt.Errorf("path %q is not relative", p)
+		}
+		if clean == ".." || strings.HasPrefix(clean, ".."+string(filepath.Separator)) {
+			return "", fmt.Errorf("path %q refers to a parent directory", p)
+		}
+		if strings.HasPrefix(p, string(filepath.Separator)) || filepath.VolumeName(clean) != "" {
+			// On Windows, this catches semi-relative paths like "C:" (meaning “the
+			// current working directory on volume C:”) and "\windows" (meaning “the
+			// windows subdirectory of the current drive letter”).
+			return "", fmt.Errorf("path %q is relative to volume", p)
+		}
+		return p, nil
+	}
+
+	clean := path.Clean(p)
+	if path.IsAbs(clean) {
+		return "", fmt.Errorf("path %q is not relative", p)
+	}
+	if clean == ".." || strings.HasPrefix(clean, "../") {
+		return "", fmt.Errorf("path %q refers to a parent directory", p)
+	}
+	canon := filepath.FromSlash(p)
+	if filepath.VolumeName(canon) != "" {
+		return "", fmt.Errorf("path %q begins with a native volume name", p)
+	}
+	return canon, nil
+}