#1487 Readme Template

config.codekit

@@ -424,6 +424,15 @@
 		"strictMath": 0,
 		"strictUnits": 0
 		},
+	"\/public\/ng\/css\/font-awesome.min.css": {
+		"fileType": 16,
+		"ignore": 0,
+		"ignoreWasSetByUser": 0,
+		"inputAbbreviatedPath": "\/public\/ng\/css\/font-awesome.min.css",
+		"outputAbbreviatedPath": "No Output Path",
+		"outputPathIsOutsideProject": 0,
+		"outputPathIsSetByUser": 0
+		},
 	"\/public\/ng\/css\/gogs.css": {
 		"fileType": 16,
 		"ignore": 1,

models/repo.go

@@ -5,6 +5,7 @@
 package models
 
 import (
+	"bytes"
 	"errors"
 	"fmt"
 	"html/template"
@@ -403,7 +404,12 @@ func MirrorRepository(repoId int64, userName, repoName, repoPath, url string) er
 
 // MigrateRepository migrates a existing repository from other project hosting.
 func MigrateRepository(u *User, name, desc string, private, mirror bool, url string) (*Repository, error) {
-	repo, err := CreateRepository(u, name, desc, "", "", private, mirror, false)
+	repo, err := CreateRepository(u, CreateRepoOptions{
+		Name:        name,
+		Description: desc,
+		IsPrivate:   private,
+		IsMirror:    mirror,
+	})
 	if err != nil {
 		return nil, err
 	}
@@ -488,93 +494,123 @@ func createUpdateHook(repoPath string) error {
 		[]byte(fmt.Sprintf(_TPL_UPDATE_HOOK, setting.ScriptType, "\""+appPath+"\"", setting.CustomConf)), 0777)
 }
 
-// InitRepository initializes README and .gitignore if needed.
+type CreateRepoOptions struct {
-func initRepository(e Engine, repoPath string, u *User, repo *Repository, initReadme bool, repoLang, license string) error {
+	Name        string
-	// Somehow the directory could exist.
+	Description string
-	if com.IsExist(repoPath) {
+	Gitignores  string
-		return fmt.Errorf("initRepository: path already exists: %s", repoPath)
+	License     string
+	Readme      string
+	IsPrivate   bool
+	IsMirror    bool
+	AutoInit    bool
 }
 
-	// Init bare new repository.
+func getRepoInitFile(tp, name string) ([]byte, error) {
-	os.MkdirAll(repoPath, os.ModePerm)
+	relPath := path.Join("conf", tp, name)
-	_, stderr, err := process.ExecDir(-1, repoPath,
+
-		fmt.Sprintf("initRepository(git init --bare): %s", repoPath),
+	// Use custom file when available.
-		"git", "init", "--bare")
+	customPath := path.Join(setting.CustomPath, relPath)
+	if com.IsFile(customPath) {
+		return ioutil.ReadFile(customPath)
+	}
+	return bindata.Asset(relPath)
+}
+
+func prepareRepoCommit(repo *Repository, tmpDir, repoPath string, opts CreateRepoOptions) error {
+	// Clone to temprory path and do the init commit.
+	_, stderr, err := process.Exec(
+		fmt.Sprintf("initRepository(git clone): %s", repoPath), "git", "clone", repoPath, tmpDir)
 	if err != nil {
-		return fmt.Errorf("git init --bare: %s", err)
+		return fmt.Errorf("git clone: %v - %s", err, stderr)
 	}
 
-	if err := createUpdateHook(repoPath); err != nil {
+	// README
-		return err
+	data, err := getRepoInitFile("readme", opts.Readme)
+	if err != nil {
+		return fmt.Errorf("getRepoInitFile[%s]: %v", opts.Readme, err)
 	}
 
-	// Initialize repository according to user's choice.
+	match := map[string]string{
-	fileName := map[string]string{}
+		"Name":        repo.Name,
-	if initReadme {
+		"Description": repo.Description,
-		fileName["readme"] = "README.md"
 	}
-	if repoLang != "" {
+	if err = ioutil.WriteFile(filepath.Join(tmpDir, "README.md"),
-		fileName["gitign"] = ".gitignore"
+		[]byte(com.Expand(string(data), match)), 0644); err != nil {
+		return fmt.Errorf("write README.md: %v", err)
 	}
-	if license != "" {
+
-		fileName["license"] = "LICENSE"
+	// .gitignore
+	if len(opts.Gitignores) > 0 {
+		var buf bytes.Buffer
+		names := strings.Split(opts.Gitignores, ",")
+		for _, name := range names {
+			data, err = getRepoInitFile("gitignore", name)
+			if err != nil {
+				return fmt.Errorf("getRepoInitFile[%s]: %v", name, err)
+			}
+			buf.WriteString("# ---> " + name + "\n")
+			buf.Write(data)
+			buf.WriteString("\n")
 		}
 
-	// Clone to temprory path and do the init commit.
+		if buf.Len() > 0 {
-	tmpDir := filepath.Join(os.TempDir(), com.ToStr(time.Now().Nanosecond()))
+			if err = ioutil.WriteFile(filepath.Join(tmpDir, ".gitignore"), buf.Bytes(), 0644); err != nil {
-	os.MkdirAll(tmpDir, os.ModePerm)
+				return fmt.Errorf("write .gitignore: %v", err)
-	defer os.RemoveAll(tmpDir)
+			}
+		}
+	}
 
-	_, stderr, err = process.Exec(
+	// LICENSE
-		fmt.Sprintf("initRepository(git clone): %s", repoPath),
+	if len(opts.License) > 0 {
-		"git", "clone", repoPath, tmpDir)
+		data, err = getRepoInitFile("license", opts.License)
 		if err != nil {
-		return errors.New("git clone: " + stderr)
+			return fmt.Errorf("getRepoInitFile[%s]: %v", opts.License, err)
 		}
 
-	// README
+		if err = ioutil.WriteFile(filepath.Join(tmpDir, "LICENSE"), data, 0644); err != nil {
-	if initReadme {
+			return fmt.Errorf("write LICENSE: %v", err)
-		defaultReadme := repo.Name + "\n" + strings.Repeat("=",
-			utf8.RuneCountInString(repo.Name)) + "\n\n" + repo.Description
-		if err := ioutil.WriteFile(filepath.Join(tmpDir, fileName["readme"]),
-			[]byte(defaultReadme), 0644); err != nil {
-			return err
 		}
 	}
 
-	// FIXME: following two can be merged.
+	return nil
+}
 
-	// .gitignore
+// InitRepository initializes README and .gitignore if needed.
-	// Copy custom file when available.
+func initRepository(e Engine, repoPath string, u *User, repo *Repository, opts CreateRepoOptions) error {
-	customPath := path.Join(setting.CustomPath, "conf/gitignore", repoLang)
+	// Somehow the directory could exist.
-	targetPath := path.Join(tmpDir, fileName["gitign"])
+	if com.IsExist(repoPath) {
-	if com.IsFile(customPath) {
+		return fmt.Errorf("initRepository: path already exists: %s", repoPath)
-		if err := com.Copy(customPath, targetPath); err != nil {
-			return fmt.Errorf("copy gitignore: %v", err)
 	}
-	} else if com.IsSliceContainsStr(Gitignores, repoLang) {
+
-		if err = ioutil.WriteFile(targetPath,
+	// Init bare new repository.
-			bindata.MustAsset(path.Join("conf/gitignore", repoLang)), 0644); err != nil {
+	os.MkdirAll(repoPath, os.ModePerm)
-			return fmt.Errorf("generate gitignore: %v", err)
+	_, stderr, err := process.ExecDir(-1, repoPath,
+		fmt.Sprintf("initRepository(git init --bare): %s", repoPath), "git", "init", "--bare")
+	if err != nil {
+		return fmt.Errorf("git init --bare: %v - %s", err, stderr)
 	}
-	} else {
+
-		delete(fileName, "gitign")
+	if err := createUpdateHook(repoPath); err != nil {
+		return err
 	}
 
-	// LICENSE
+	tmpDir := filepath.Join(os.TempDir(), com.ToStr(time.Now().Nanosecond()))
-	customPath = path.Join(setting.CustomPath, "conf/license", license)
+
-	targetPath = path.Join(tmpDir, fileName["license"])
+	// Initialize repository according to user's choice.
-	if com.IsFile(customPath) {
+	if opts.AutoInit {
-		if err = com.Copy(customPath, targetPath); err != nil {
+		os.MkdirAll(tmpDir, os.ModePerm)
-			return fmt.Errorf("copy license: %v", err)
+		defer os.RemoveAll(tmpDir)
+
+		if err = prepareRepoCommit(repo, tmpDir, repoPath, opts); err != nil {
+			return fmt.Errorf("prepareRepoCommit: %v", err)
 		}
-	} else if com.IsSliceContainsStr(Licenses, license) {
+
-		if err = ioutil.WriteFile(targetPath,
+		// Apply changes and commit.
-			bindata.MustAsset(path.Join("conf/license", license)), 0644); err != nil {
+		if err = initRepoCommit(tmpDir, u.NewGitSig()); err != nil {
-			return fmt.Errorf("generate license: %v", err)
+			return fmt.Errorf("initRepoCommit: %v", err)
 		}
 	} else {
-		delete(fileName, "license")
+		repo.IsBare = true
 	}
 
 	// Re-fetch the repository from database before updating it (else it would
@@ -582,23 +618,15 @@ func initRepository(e Engine, repoPath string, u *User, repo *Repository, initRe
 	if repo, err = getRepositoryByID(e, repo.ID); err != nil {
 		return fmt.Errorf("getRepositoryByID: %v", err)
 	}
-	if len(fileName) == 0 {
+
-		repo.IsBare = true
-	}
 	repo.DefaultBranch = "master"
 	if err = updateRepository(e, repo, false); err != nil {
 		return fmt.Errorf("updateRepository: %v", err)
 	}
 
-	// Ignore init process if user choose not to.
-	if len(fileName) == 0 {
 	return nil
 }
 
-	// Apply changes and commit.
-	return initRepoCommit(tmpDir, u.NewGitSig())
-}
-
 func createRepository(e *xorm.Session, u *User, repo *Repository) (err error) {
 	if err = IsUsableName(repo.Name); err != nil {
 		return err
@@ -642,14 +670,14 @@ func createRepository(e *xorm.Session, u *User, repo *Repository) (err error) {
 }
 
 // CreateRepository creates a repository for given user or organization.
-func CreateRepository(u *User, name, desc, lang, license string, isPrivate, isMirror, initReadme bool) (_ *Repository, err error) {
+func CreateRepository(u *User, opts CreateRepoOptions) (_ *Repository, err error) {
 	repo := &Repository{
 		OwnerID:     u.Id,
 		Owner:       u,
-		Name:        name,
+		Name:        opts.Name,
-		LowerName:   strings.ToLower(name),
+		LowerName:   strings.ToLower(opts.Name),
-		Description: desc,
+		Description: opts.Description,
-		IsPrivate:   isPrivate,
+		IsPrivate:   opts.IsPrivate,
 	}
 
 	sess := x.NewSession()
@@ -663,9 +691,9 @@ func CreateRepository(u *User, name, desc, lang, license string, isPrivate, isMi
 	}
 
 	// No need for init mirror.
-	if !isMirror {
+	if !opts.IsMirror {
 		repoPath := RepoPath(u.Name, repo.Name)
-		if err = initRepository(sess, repoPath, u, repo, initReadme, lang, license); err != nil {
+		if err = initRepository(sess, repoPath, u, repo, opts); err != nil {
 			if err2 := os.RemoveAll(repoPath); err2 != nil {
 				log.Error(4, "initRepository: %v", err)
 				return nil, fmt.Errorf(

modules/auth/auth.go

@@ -194,6 +194,12 @@ func GetMaxSize(field reflect.StructField) string {
 	return getSize(field, "MaxSize(")
 }
 
+// FIXME: struct contains a struct
+func validateStruct(obj interface{}) binding.Errors {
+
+	return nil
+}
+
 func validate(errs binding.Errors, data map[string]interface{}, f Form, l macaron.Locale) binding.Errors {
 	if errs.Len() == 0 {
 		return errs

modules/auth/repo_form.go

@@ -16,15 +16,11 @@ import (
 //  |____|_  /_______  / |____|   \_______  /_______  /|___| |____|   \_______  /____|_  // ______|
 //         \/        \/                   \/        \/                        \/       \/ \/
 
-type RepoForm struct {
+type CreateRepoForm struct {
 	Uid         int64  `binding:"Required"`
 	RepoName    string `binding:"Required;AlphaDashDot;MaxSize(100)"`
 	Private     bool
 	Description string `binding:"MaxSize(255)"`
-}
-
-type CreateRepoForm struct {
-	RepoForm
 	AutoInit    bool
 	Gitignores  string
 	License     string
@@ -39,8 +35,11 @@ type MigrateRepoForm struct {
 	CloneAddr    string `binding:"Required"`
 	AuthUsername string
 	AuthPassword string
-	RepoForm
 	Mirror       bool
+	Uid          int64  `binding:"Required"`
+	RepoName     string `binding:"Required;AlphaDashDot;MaxSize(100)"`
+	Private      bool
+	Description  string `binding:"MaxSize(255)"`
 }
 
 func (f *MigrateRepoForm) Validate(ctx *macaron.Context, errs binding.Errors) binding.Errors {

public/ng/css/gogs.css

@@ -284,7 +284,7 @@ img.avatar-100 {
   font-size: 16px;
   line-height: 1.6;
   word-wrap: break-word;
-  padding: 0 2em 2em !important;
+  padding: 5px 2em 2em !important;
 }
 .markdown > *:first-child {
   margin-top: 0 !important;

public/ng/less/gogs/markdown.less

@@ -4,7 +4,7 @@
   font-size:16px;
   line-height:1.6;
   word-wrap:break-word;
-  padding: 0 2em 2em !important;
+  padding: 5px 2em 2em !important;
 
   >*:first-child {
     margin-top:0 !important;

routers/api/v1/repo.go

@@ -101,8 +101,15 @@ func SearchRepos(ctx *middleware.Context) {
 }
 
 func createRepo(ctx *middleware.Context, owner *models.User, opt api.CreateRepoOption) {
-	repo, err := models.CreateRepository(owner, opt.Name, opt.Description,
+	repo, err := models.CreateRepository(owner, models.CreateRepoOptions{
-		opt.Gitignore, opt.License, opt.Private, false, opt.AutoInit)
+		Name:        opt.Name,
+		Description: opt.Description,
+		Gitignores:  opt.Gitignore,
+		License:     opt.License,
+		// Readme:      form.Readme,
+		IsPrivate: opt.Private,
+		AutoInit:  opt.AutoInit,
+	})
 	if err != nil {
 		if models.IsErrRepoAlreadyExist(err) ||
 			models.IsErrNameReserved(err) ||

routers/repo/repo.go

@@ -28,6 +28,12 @@ const (
 )
 
 func checkContextUser(ctx *middleware.Context, uid int64) *models.User {
+	if err := ctx.User.GetOrganizations(); err != nil {
+		ctx.Handle(500, "GetOrganizations", err)
+		return nil
+	}
+	ctx.Data["Orgs"] = ctx.User.Orgs
+
 	// Not equal means current user is an organization.
 	if uid == ctx.User.Id || uid == 0 {
 		return ctx.User
@@ -41,7 +47,10 @@ func checkContextUser(ctx *middleware.Context, uid int64) *models.User {
 	if err != nil {
 		ctx.Handle(500, "checkContextUser", fmt.Errorf("GetUserById(%d): %v", uid, err))
 		return nil
-	} else if !org.IsOrganization() {
+	}
+
+	// Check ownership of organization.
+	if !org.IsOrganization() || !org.IsOwnedBy(ctx.User.Id) {
 		ctx.Error(403)
 		return nil
 	}
@@ -63,13 +72,23 @@ func Create(ctx *middleware.Context) {
 	}
 	ctx.Data["ContextUser"] = ctxUser
 
-	if err := ctx.User.GetOrganizations(); err != nil {
+	ctx.HTML(200, CREATE)
-		ctx.Handle(500, "GetOrganizations", err)
-		return
 }
-	ctx.Data["Orgs"] = ctx.User.Orgs
 
-	ctx.HTML(200, CREATE)
+func handleCreateError(ctx *middleware.Context, err error, name string, tpl base.TplName, form interface{}) {
+	switch {
+	case models.IsErrRepoAlreadyExist(err):
+		ctx.Data["Err_RepoName"] = true
+		ctx.RenderWithErr(ctx.Tr("form.repo_name_been_taken"), tpl, form)
+	case models.IsErrNameReserved(err):
+		ctx.Data["Err_RepoName"] = true
+		ctx.RenderWithErr(ctx.Tr("repo.form.name_reserved", err.(models.ErrNameReserved).Name), tpl, form)
+	case models.IsErrNamePatternNotAllowed(err):
+		ctx.Data["Err_RepoName"] = true
+		ctx.RenderWithErr(ctx.Tr("repo.form.name_pattern_not_allowed", err.(models.ErrNamePatternNotAllowed).Pattern), tpl, form)
+	default:
+		ctx.Handle(500, name, err)
+	}
 }
 
 func CreatePost(ctx *middleware.Context, form auth.CreateRepoForm) {
@@ -85,27 +104,20 @@ func CreatePost(ctx *middleware.Context, form auth.CreateRepoForm) {
 	}
 	ctx.Data["ContextUser"] = ctxUser
 
-	if err := ctx.User.GetOrganizations(); err != nil {
-		ctx.Handle(500, "GetOrganizations", err)
-		return
-	}
-	ctx.Data["Orgs"] = ctx.User.Orgs
-
 	if ctx.HasError() {
 		ctx.HTML(200, CREATE)
 		return
 	}
 
-	if ctxUser.IsOrganization() {
+	repo, err := models.CreateRepository(ctxUser, models.CreateRepoOptions{
-		// Check ownership of organization.
+		Name:        form.RepoName,
-		if !ctxUser.IsOwnedBy(ctx.User.Id) {
+		Description: form.Description,
-			ctx.Error(403)
+		Gitignores:  form.Gitignores,
-			return
+		License:     form.License,
-		}
+		Readme:      form.Readme,
-	}
+		IsPrivate:   form.Private,
-
+		AutoInit:    form.AutoInit,
-	repo, err := models.CreateRepository(ctxUser, form.RepoName, form.Description,
+	})
-		form.Gitignores, form.License, form.Private, false, form.AutoInit)
 	if err == nil {
 		log.Trace("Repository created: %s/%s", ctxUser.Name, repo.Name)
 		ctx.Redirect(setting.AppSubUrl + "/" + ctxUser.Name + "/" + repo.Name)
@@ -118,19 +130,7 @@ func CreatePost(ctx *middleware.Context, form auth.CreateRepoForm) {
 		}
 	}
 
-	switch {
+	handleCreateError(ctx, err, "CreatePost", CREATE, &form)
-	case models.IsErrRepoAlreadyExist(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("form.repo_name_been_taken"), CREATE, &form)
-	case models.IsErrNameReserved(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("repo.form.name_reserved", err.(models.ErrNameReserved).Name), CREATE, &form)
-	case models.IsErrNamePatternNotAllowed(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("repo.form.name_pattern_not_allowed", err.(models.ErrNamePatternNotAllowed).Pattern), CREATE, &form)
-	default:
-		ctx.Handle(500, "CreatePost", err)
-	}
 }
 
 func Migrate(ctx *middleware.Context) {
@@ -142,12 +142,6 @@ func Migrate(ctx *middleware.Context) {
 	}
 	ctx.Data["ContextUser"] = ctxUser
 
-	if err := ctx.User.GetOrganizations(); err != nil {
-		ctx.Handle(500, "GetOrganizations", err)
-		return
-	}
-	ctx.Data["Orgs"] = ctx.User.Orgs
-
 	ctx.HTML(200, MIGRATE)
 }
 
@@ -160,25 +154,11 @@ func MigratePost(ctx *middleware.Context, form auth.MigrateRepoForm) {
 	}
 	ctx.Data["ContextUser"] = ctxUser
 
-	if err := ctx.User.GetOrganizations(); err != nil {
-		ctx.Handle(500, "GetOrganizations", err)
-		return
-	}
-	ctx.Data["Orgs"] = ctx.User.Orgs
-
 	if ctx.HasError() {
 		ctx.HTML(200, MIGRATE)
 		return
 	}
 
-	if ctxUser.IsOrganization() {
-		// Check ownership of organization.
-		if !ctxUser.IsOwnedBy(ctx.User.Id) {
-			ctx.Error(403)
-			return
-		}
-	}
-
 	// Remote address can be HTTP/HTTPS/Git URL or local path.
 	// Note: remember to change api/v1/repo.go: MigrateRepo
 	// FIXME: merge these two functions with better error handling
@@ -222,19 +202,7 @@ func MigratePost(ctx *middleware.Context, form auth.MigrateRepoForm) {
 		return
 	}
 
-	switch {
+	handleCreateError(ctx, err, "MigratePost", MIGRATE, &form)
-	case models.IsErrRepoAlreadyExist(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("form.repo_name_been_taken"), MIGRATE, &form)
-	case models.IsErrNameReserved(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("repo.form.name_reserved", err.(models.ErrNameReserved).Name), MIGRATE, &form)
-	case models.IsErrNamePatternNotAllowed(err):
-		ctx.Data["Err_RepoName"] = true
-		ctx.RenderWithErr(ctx.Tr("repo.form.name_pattern_not_allowed", err.(models.ErrNamePatternNotAllowed).Pattern), MIGRATE, &form)
-	default:
-		ctx.Handle(500, "MigratePost", err)
-	}
 }
 
 func Action(ctx *middleware.Context) {

templates/ng/base/head.tmpl

@@ -13,7 +13,7 @@
 		<link rel="shortcut icon" href="{{AppSubUrl}}/img/favicon.png" />
 
 
-		<link rel="stylesheet" href="{{AppSubUrl}}/css/font-awesome.min.css">
+		<link rel="stylesheet" href="{{AppSubUrl}}/ng/css/font-awesome.min.css">
 		
 		<script src="{{AppSubUrl}}/ng/js/lib/jquery-1.11.1.min.js"></script>
 

templates/repo/create.tmpl

@@ -57,7 +57,7 @@
           <div class="inline field">
             <label>{{.i18n.Tr "repo.repo_lang"}}</label>
             <div class="ui multiple search normal selection dropdown">
-              <input type="hidden" name="gitignores" value="{{.gitignoresValue}}">
+              <input type="hidden" name="gitignores" value="{{.gitignores}}">
               <div class="default text">{{.i18n.Tr "repo.repo_lang_helper"}}</div>
               <div class="menu">
                 {{range .Gitignores}}
@@ -82,7 +82,7 @@
           <div class="inline field">
             <label>{{.i18n.Tr "repo.readme"}}</label>
             <div class="ui selection dropdown">
-              <input type="hidden" name="license" value="{{.readme}}">
+              <input type="hidden" name="readme" value="{{.readme}}">
               <div class="default text">{{.i18n.Tr "repo.readme_helper"}}</div>
               <div class="menu">  
                 {{range .Readmes}}