mirror of
				https://github.com/go-gitea/gitea
				synced 2025-11-03 04:48:25 +00:00 
			
		
		
		
	Use [chi](https://github.com/go-chi/chi) instead of the forked [macaron](https://gitea.com/macaron/macaron). Since macaron and chi have conflicts with session share, this big PR becomes a have-to thing. According my previous idea, we can replace macaron step by step but I'm wrong. :( Below is a list of big changes on this PR. - [x] Define `context.ResponseWriter` interface with an implementation `context.Response`. - [x] Use chi instead of macaron, and also a customize `Route` to wrap chi so that the router usage is similar as before. - [x] Create different routers for `web`, `api`, `internal` and `install` so that the codes will be more clear and no magic . - [x] Use https://github.com/unrolled/render instead of macaron's internal render - [x] Use https://github.com/NYTimes/gziphandler instead of https://gitea.com/macaron/gzip - [x] Use https://gitea.com/go-chi/session which is a modified version of https://gitea.com/macaron/session and removed `nodb` support since it will not be maintained. **BREAK** - [x] Use https://gitea.com/go-chi/captcha which is a modified version of https://gitea.com/macaron/captcha - [x] Use https://gitea.com/go-chi/cache which is a modified version of https://gitea.com/macaron/cache - [x] Use https://gitea.com/go-chi/binding which is a modified version of https://gitea.com/macaron/binding - [x] Use https://github.com/go-chi/cors instead of https://gitea.com/macaron/cors - [x] Dropped https://gitea.com/macaron/i18n and make a new one in `code.gitea.io/gitea/modules/translation` - [x] Move validation form structs from `code.gitea.io/gitea/modules/auth` to `code.gitea.io/gitea/modules/forms` to avoid dependency cycle. - [x] Removed macaron log service because it's not need any more. **BREAK** - [x] All form structs have to be get by `web.GetForm(ctx)` in the route function but not as a function parameter on routes definition. - [x] Move Git HTTP protocol implementation to use routers directly. - [x] Fix the problem that chi routes don't support trailing slash but macaron did. - [x] `/api/v1/swagger` now will be redirect to `/api/swagger` but not render directly so that `APIContext` will not create a html render. Notices: - Chi router don't support request with trailing slash - Integration test `TestUserHeatmap` maybe mysql version related. It's failed on my macOS(mysql 5.7.29 installed via brew) but succeed on CI. Co-authored-by: 6543 <6543@obermui.de>
		
			
				
	
	
		
			156 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			156 lines
		
	
	
		
			3.3 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
// +build bindata
 | 
						||
 | 
						||
// Copyright 2016 The Gitea Authors. All rights reserved.
 | 
						||
// Use of this source code is governed by a MIT-style
 | 
						||
// license that can be found in the LICENSE file.
 | 
						||
 | 
						||
package templates
 | 
						||
 | 
						||
import (
 | 
						||
	"html/template"
 | 
						||
	"io/ioutil"
 | 
						||
	"os"
 | 
						||
	"path"
 | 
						||
	"path/filepath"
 | 
						||
	"strings"
 | 
						||
	texttmpl "text/template"
 | 
						||
 | 
						||
	"code.gitea.io/gitea/modules/log"
 | 
						||
	"code.gitea.io/gitea/modules/setting"
 | 
						||
	"code.gitea.io/gitea/modules/util"
 | 
						||
)
 | 
						||
 | 
						||
var (
 | 
						||
	subjectTemplates = texttmpl.New("")
 | 
						||
	bodyTemplates    = template.New("")
 | 
						||
)
 | 
						||
 | 
						||
// GetAsset get a special asset, only for chi
 | 
						||
func GetAsset(name string) ([]byte, error) {
 | 
						||
	bs, err := ioutil.ReadFile(filepath.Join(setting.CustomPath, name))
 | 
						||
	if err != nil && !os.IsNotExist(err) {
 | 
						||
		return nil, err
 | 
						||
	} else if err == nil {
 | 
						||
		return bs, nil
 | 
						||
	}
 | 
						||
	return Asset(strings.TrimPrefix(name, "templates/"))
 | 
						||
}
 | 
						||
 | 
						||
// GetAssetNames only for chi
 | 
						||
func GetAssetNames() []string {
 | 
						||
	realFS := Assets.(vfsgen۰FS)
 | 
						||
	var tmpls = make([]string, 0, len(realFS))
 | 
						||
	for k := range realFS {
 | 
						||
		tmpls = append(tmpls, "templates/"+k[1:])
 | 
						||
	}
 | 
						||
 | 
						||
	customDir := path.Join(setting.CustomPath, "templates")
 | 
						||
	customTmpls := getDirAssetNames(customDir)
 | 
						||
	return append(tmpls, customTmpls...)
 | 
						||
}
 | 
						||
 | 
						||
// Mailer provides the templates required for sending notification mails.
 | 
						||
func Mailer() (*texttmpl.Template, *template.Template) {
 | 
						||
	for _, funcs := range NewTextFuncMap() {
 | 
						||
		subjectTemplates.Funcs(funcs)
 | 
						||
	}
 | 
						||
	for _, funcs := range NewFuncMap() {
 | 
						||
		bodyTemplates.Funcs(funcs)
 | 
						||
	}
 | 
						||
 | 
						||
	for _, assetPath := range AssetNames() {
 | 
						||
		if !strings.HasPrefix(assetPath, "mail/") {
 | 
						||
			continue
 | 
						||
		}
 | 
						||
 | 
						||
		if !strings.HasSuffix(assetPath, ".tmpl") {
 | 
						||
			continue
 | 
						||
		}
 | 
						||
 | 
						||
		content, err := Asset(assetPath)
 | 
						||
 | 
						||
		if err != nil {
 | 
						||
			log.Warn("Failed to read embedded %s template. %v", assetPath, err)
 | 
						||
			continue
 | 
						||
		}
 | 
						||
 | 
						||
		buildSubjectBodyTemplate(subjectTemplates,
 | 
						||
			bodyTemplates,
 | 
						||
			strings.TrimPrefix(
 | 
						||
				strings.TrimSuffix(
 | 
						||
					assetPath,
 | 
						||
					".tmpl",
 | 
						||
				),
 | 
						||
				"mail/",
 | 
						||
			),
 | 
						||
			content)
 | 
						||
	}
 | 
						||
 | 
						||
	customDir := path.Join(setting.CustomPath, "templates", "mail")
 | 
						||
	isDir, err := util.IsDir(customDir)
 | 
						||
	if err != nil {
 | 
						||
		log.Warn("Failed to check if custom directory %s is a directory. %v", err)
 | 
						||
	}
 | 
						||
	if isDir {
 | 
						||
		files, err := util.StatDir(customDir)
 | 
						||
 | 
						||
		if err != nil {
 | 
						||
			log.Warn("Failed to read %s templates dir. %v", customDir, err)
 | 
						||
		} else {
 | 
						||
			for _, filePath := range files {
 | 
						||
				if !strings.HasSuffix(filePath, ".tmpl") {
 | 
						||
					continue
 | 
						||
				}
 | 
						||
 | 
						||
				content, err := ioutil.ReadFile(path.Join(customDir, filePath))
 | 
						||
 | 
						||
				if err != nil {
 | 
						||
					log.Warn("Failed to read custom %s template. %v", filePath, err)
 | 
						||
					continue
 | 
						||
				}
 | 
						||
 | 
						||
				buildSubjectBodyTemplate(subjectTemplates,
 | 
						||
					bodyTemplates,
 | 
						||
					strings.TrimSuffix(
 | 
						||
						filePath,
 | 
						||
						".tmpl",
 | 
						||
					),
 | 
						||
					content)
 | 
						||
			}
 | 
						||
		}
 | 
						||
	}
 | 
						||
 | 
						||
	return subjectTemplates, bodyTemplates
 | 
						||
}
 | 
						||
 | 
						||
func Asset(name string) ([]byte, error) {
 | 
						||
	f, err := Assets.Open("/" + name)
 | 
						||
	if err != nil {
 | 
						||
		return nil, err
 | 
						||
	}
 | 
						||
	defer f.Close()
 | 
						||
	return ioutil.ReadAll(f)
 | 
						||
}
 | 
						||
 | 
						||
func AssetNames() []string {
 | 
						||
	realFS := Assets.(vfsgen۰FS)
 | 
						||
	var results = make([]string, 0, len(realFS))
 | 
						||
	for k := range realFS {
 | 
						||
		results = append(results, k[1:])
 | 
						||
	}
 | 
						||
	return results
 | 
						||
}
 | 
						||
 | 
						||
func AssetIsDir(name string) (bool, error) {
 | 
						||
	if f, err := Assets.Open("/" + name); err != nil {
 | 
						||
		return false, err
 | 
						||
	} else {
 | 
						||
		defer f.Close()
 | 
						||
		if fi, err := f.Stat(); err != nil {
 | 
						||
			return false, err
 | 
						||
		} else {
 | 
						||
			return fi.IsDir(), nil
 | 
						||
		}
 | 
						||
	}
 | 
						||
}
 |