123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355 |
- // Copyright 2019 The Gitea Authors. All rights reserved.
- // SPDX-License-Identifier: MIT
-
- package repository
-
- import (
- "bufio"
- "bytes"
- "context"
- "fmt"
- "os"
- "path"
- "path/filepath"
- "strings"
- "time"
-
- git_model "code.gitea.io/gitea/models/git"
- repo_model "code.gitea.io/gitea/models/repo"
- user_model "code.gitea.io/gitea/models/user"
- "code.gitea.io/gitea/modules/git"
- "code.gitea.io/gitea/modules/log"
- "code.gitea.io/gitea/modules/util"
-
- "github.com/gobwas/glob"
- "github.com/huandu/xstrings"
- )
-
- type transformer struct {
- Name string
- Transform func(string) string
- }
-
- type expansion struct {
- Name string
- Value string
- Transformers []transformer
- }
-
- var defaultTransformers = []transformer{
- {Name: "SNAKE", Transform: xstrings.ToSnakeCase},
- {Name: "KEBAB", Transform: xstrings.ToKebabCase},
- {Name: "CAMEL", Transform: func(str string) string {
- return xstrings.FirstRuneToLower(xstrings.ToCamelCase(str))
- }},
- {Name: "PASCAL", Transform: xstrings.ToCamelCase},
- {Name: "LOWER", Transform: strings.ToLower},
- {Name: "UPPER", Transform: strings.ToUpper},
- {Name: "TITLE", Transform: util.ToTitleCase},
- }
-
- func generateExpansion(src string, templateRepo, generateRepo *repo_model.Repository) string {
- expansions := []expansion{
- {Name: "REPO_NAME", Value: generateRepo.Name, Transformers: defaultTransformers},
- {Name: "TEMPLATE_NAME", Value: templateRepo.Name, Transformers: defaultTransformers},
- {Name: "REPO_DESCRIPTION", Value: generateRepo.Description, Transformers: nil},
- {Name: "TEMPLATE_DESCRIPTION", Value: templateRepo.Description, Transformers: nil},
- {Name: "REPO_OWNER", Value: generateRepo.OwnerName, Transformers: defaultTransformers},
- {Name: "TEMPLATE_OWNER", Value: templateRepo.OwnerName, Transformers: defaultTransformers},
- {Name: "REPO_LINK", Value: generateRepo.Link(), Transformers: nil},
- {Name: "TEMPLATE_LINK", Value: templateRepo.Link(), Transformers: nil},
- {Name: "REPO_HTTPS_URL", Value: generateRepo.CloneLink().HTTPS, Transformers: nil},
- {Name: "TEMPLATE_HTTPS_URL", Value: templateRepo.CloneLink().HTTPS, Transformers: nil},
- {Name: "REPO_SSH_URL", Value: generateRepo.CloneLink().SSH, Transformers: nil},
- {Name: "TEMPLATE_SSH_URL", Value: templateRepo.CloneLink().SSH, Transformers: nil},
- }
-
- expansionMap := make(map[string]string)
- for _, e := range expansions {
- expansionMap[e.Name] = e.Value
- for _, tr := range e.Transformers {
- expansionMap[fmt.Sprintf("%s_%s", e.Name, tr.Name)] = tr.Transform(e.Value)
- }
- }
-
- return os.Expand(src, func(key string) string {
- if expansion, ok := expansionMap[key]; ok {
- return expansion
- }
- return key
- })
- }
-
- // GiteaTemplate holds information about a .gitea/template file
- type GiteaTemplate struct {
- Path string
- Content []byte
-
- globs []glob.Glob
- }
-
- // Globs parses the .gitea/template globs or returns them if they were already parsed
- func (gt GiteaTemplate) Globs() []glob.Glob {
- if gt.globs != nil {
- return gt.globs
- }
-
- gt.globs = make([]glob.Glob, 0)
- scanner := bufio.NewScanner(bytes.NewReader(gt.Content))
- for scanner.Scan() {
- line := strings.TrimSpace(scanner.Text())
- if line == "" || strings.HasPrefix(line, "#") {
- continue
- }
- g, err := glob.Compile(line, '/')
- if err != nil {
- log.Info("Invalid glob expression '%s' (skipped): %v", line, err)
- continue
- }
- gt.globs = append(gt.globs, g)
- }
- return gt.globs
- }
-
- func checkGiteaTemplate(tmpDir string) (*GiteaTemplate, error) {
- gtPath := filepath.Join(tmpDir, ".gitea", "template")
- if _, err := os.Stat(gtPath); os.IsNotExist(err) {
- return nil, nil
- } else if err != nil {
- return nil, err
- }
-
- content, err := os.ReadFile(gtPath)
- if err != nil {
- return nil, err
- }
-
- gt := &GiteaTemplate{
- Path: gtPath,
- Content: content,
- }
-
- return gt, nil
- }
-
- func generateRepoCommit(ctx context.Context, repo, templateRepo, generateRepo *repo_model.Repository, tmpDir string) error {
- commitTimeStr := time.Now().Format(time.RFC3339)
- authorSig := repo.Owner.NewGitSig()
-
- // Because this may call hooks we should pass in the environment
- env := append(os.Environ(),
- "GIT_AUTHOR_NAME="+authorSig.Name,
- "GIT_AUTHOR_EMAIL="+authorSig.Email,
- "GIT_AUTHOR_DATE="+commitTimeStr,
- "GIT_COMMITTER_NAME="+authorSig.Name,
- "GIT_COMMITTER_EMAIL="+authorSig.Email,
- "GIT_COMMITTER_DATE="+commitTimeStr,
- )
-
- // Clone to temporary path and do the init commit.
- templateRepoPath := templateRepo.RepoPath()
- if err := git.Clone(ctx, templateRepoPath, tmpDir, git.CloneRepoOptions{
- Depth: 1,
- Branch: templateRepo.DefaultBranch,
- }); err != nil {
- return fmt.Errorf("git clone: %w", err)
- }
-
- if err := util.RemoveAll(path.Join(tmpDir, ".git")); err != nil {
- return fmt.Errorf("remove git dir: %w", err)
- }
-
- // Variable expansion
- gt, err := checkGiteaTemplate(tmpDir)
- if err != nil {
- return fmt.Errorf("checkGiteaTemplate: %w", err)
- }
-
- if gt != nil {
- if err := util.Remove(gt.Path); err != nil {
- return fmt.Errorf("remove .giteatemplate: %w", err)
- }
-
- // Avoid walking tree if there are no globs
- if len(gt.Globs()) > 0 {
- tmpDirSlash := strings.TrimSuffix(filepath.ToSlash(tmpDir), "/") + "/"
- if err := filepath.WalkDir(tmpDirSlash, func(path string, d os.DirEntry, walkErr error) error {
- if walkErr != nil {
- return walkErr
- }
-
- if d.IsDir() {
- return nil
- }
-
- base := strings.TrimPrefix(filepath.ToSlash(path), tmpDirSlash)
- for _, g := range gt.Globs() {
- if g.Match(base) {
- content, err := os.ReadFile(path)
- if err != nil {
- return err
- }
-
- if err := os.WriteFile(path,
- []byte(generateExpansion(string(content), templateRepo, generateRepo)),
- 0o644); err != nil {
- return err
- }
- break
- }
- }
- return nil
- }); err != nil {
- return err
- }
- }
- }
-
- if err := git.InitRepository(ctx, tmpDir, false); err != nil {
- return err
- }
-
- repoPath := repo.RepoPath()
- if stdout, _, err := git.NewCommand(ctx, "remote", "add", "origin").AddDynamicArguments(repoPath).
- SetDescription(fmt.Sprintf("generateRepoCommit (git remote add): %s to %s", templateRepoPath, tmpDir)).
- RunStdString(&git.RunOpts{Dir: tmpDir, Env: env}); err != nil {
- log.Error("Unable to add %v as remote origin to temporary repo to %s: stdout %s\nError: %v", repo, tmpDir, stdout, err)
- return fmt.Errorf("git remote add: %w", err)
- }
-
- // set default branch based on whether it's specified in the newly generated repo or not
- defaultBranch := repo.DefaultBranch
- if strings.TrimSpace(defaultBranch) == "" {
- defaultBranch = templateRepo.DefaultBranch
- }
-
- return initRepoCommit(ctx, tmpDir, repo, repo.Owner, defaultBranch)
- }
-
- func generateGitContent(ctx context.Context, repo, templateRepo, generateRepo *repo_model.Repository) (err error) {
- tmpDir, err := os.MkdirTemp(os.TempDir(), "gitea-"+repo.Name)
- if err != nil {
- return fmt.Errorf("Failed to create temp dir for repository %s: %w", repo.RepoPath(), err)
- }
-
- defer func() {
- if err := util.RemoveAll(tmpDir); err != nil {
- log.Error("RemoveAll: %v", err)
- }
- }()
-
- if err = generateRepoCommit(ctx, repo, templateRepo, generateRepo, tmpDir); err != nil {
- return fmt.Errorf("generateRepoCommit: %w", err)
- }
-
- // re-fetch repo
- if repo, err = repo_model.GetRepositoryByID(ctx, repo.ID); err != nil {
- return fmt.Errorf("getRepositoryByID: %w", err)
- }
-
- // if there was no default branch supplied when generating the repo, use the default one from the template
- if strings.TrimSpace(repo.DefaultBranch) == "" {
- repo.DefaultBranch = templateRepo.DefaultBranch
- }
-
- gitRepo, err := git.OpenRepository(ctx, repo.RepoPath())
- if err != nil {
- return fmt.Errorf("openRepository: %w", err)
- }
- defer gitRepo.Close()
- if err = gitRepo.SetDefaultBranch(repo.DefaultBranch); err != nil {
- return fmt.Errorf("setDefaultBranch: %w", err)
- }
- if err = UpdateRepository(ctx, repo, false); err != nil {
- return fmt.Errorf("updateRepository: %w", err)
- }
-
- return nil
- }
-
- // GenerateGitContent generates git content from a template repository
- func GenerateGitContent(ctx context.Context, templateRepo, generateRepo *repo_model.Repository) error {
- if err := generateGitContent(ctx, generateRepo, templateRepo, generateRepo); err != nil {
- return err
- }
-
- if err := UpdateRepoSize(ctx, generateRepo); err != nil {
- return fmt.Errorf("failed to update size for repository: %w", err)
- }
-
- if err := git_model.CopyLFS(ctx, generateRepo, templateRepo); err != nil {
- return fmt.Errorf("failed to copy LFS: %w", err)
- }
- return nil
- }
-
- // GenerateRepoOptions contains the template units to generate
- type GenerateRepoOptions struct {
- Name string
- DefaultBranch string
- Description string
- Private bool
- GitContent bool
- Topics bool
- GitHooks bool
- Webhooks bool
- Avatar bool
- IssueLabels bool
- }
-
- // IsValid checks whether at least one option is chosen for generation
- func (gro GenerateRepoOptions) IsValid() bool {
- return gro.GitContent || gro.Topics || gro.GitHooks || gro.Webhooks || gro.Avatar || gro.IssueLabels // or other items as they are added
- }
-
- // GenerateRepository generates a repository from a template
- func GenerateRepository(ctx context.Context, doer, owner *user_model.User, templateRepo *repo_model.Repository, opts GenerateRepoOptions) (_ *repo_model.Repository, err error) {
- generateRepo := &repo_model.Repository{
- OwnerID: owner.ID,
- Owner: owner,
- OwnerName: owner.Name,
- Name: opts.Name,
- LowerName: strings.ToLower(opts.Name),
- Description: opts.Description,
- DefaultBranch: opts.DefaultBranch,
- IsPrivate: opts.Private,
- IsEmpty: !opts.GitContent || templateRepo.IsEmpty,
- IsFsckEnabled: templateRepo.IsFsckEnabled,
- TemplateID: templateRepo.ID,
- TrustModel: templateRepo.TrustModel,
- }
-
- if err = CreateRepositoryByExample(ctx, doer, owner, generateRepo, false, false); err != nil {
- return nil, err
- }
-
- repoPath := generateRepo.RepoPath()
- isExist, err := util.IsExist(repoPath)
- if err != nil {
- log.Error("Unable to check if %s exists. Error: %v", repoPath, err)
- return nil, err
- }
- if isExist {
- return nil, repo_model.ErrRepoFilesAlreadyExist{
- Uname: generateRepo.OwnerName,
- Name: generateRepo.Name,
- }
- }
-
- if err = checkInitRepository(ctx, owner.Name, generateRepo.Name); err != nil {
- return generateRepo, err
- }
-
- if err = CheckDaemonExportOK(ctx, generateRepo); err != nil {
- return generateRepo, fmt.Errorf("checkDaemonExportOK: %w", err)
- }
-
- if stdout, _, err := git.NewCommand(ctx, "update-server-info").
- SetDescription(fmt.Sprintf("GenerateRepository(git update-server-info): %s", repoPath)).
- RunStdString(&git.RunOpts{Dir: repoPath}); err != nil {
- log.Error("GenerateRepository(git update-server-info) in %v: Stdout: %s\nError: %v", generateRepo, stdout, err)
- return generateRepo, fmt.Errorf("error in GenerateRepository(git update-server-info): %w", err)
- }
-
- return generateRepo, nil
- }
|