* First batch of changes for the refactor Added the support of gin in routes and other services/utils Begining implementation of JetHTML * Remove os folder * Move scrapers to own repo * Second batch of changes All .jet.html are the working templates. You can now test this PR, the index Page and upload works. If you want to complete the other html templates, you're welcome * Move captcha to util * Move uploadService to utils * Use govalidator instead of regex * Third batch of changes All the front end should as previously. I also fixed some minor things unrelated to the refactor (mostly style issues on static pages) Now errors can be accessed by importing the "errors" helpers and using the `yield errors(name="xxx")` command in templates. Same for infos. Templates are now more hierarchized with a base template "base.jet.html" which is extended depending on the context in "index_site" or "index_admin" layouts. Those layouts are extended than in every pages. Other helpers are captcha to render a captcha `yield captcha(captchaid="xxx")` And also csrf, with the command `yield csrf_field()` To translate, you don't have anymore to do `call $.T "xxx"`, you just have to do `T("xxx")`. Pages for the website part are in folders in the folder "templates/site". Pages for the admin part are in "templates/admin". Layouts are separated in "templates/layouts". Helpers and menu are in "templates/layouts/helpers" and "templates/layouts/menu". Error pages should be put in "templates/errors" * Added test on templates When adding a new template, you have to tell to template_test.go, the context of the new template (if it doesn't use the common context) * Panel admin works Now the templating part should work. The PR can now be fully tested. I think we should push the templating PR and do the routes/controllers/removal of services in another branch. So we know that this one is functional * Updated dependencies * Fixed test for modelhelper * Fix testing for commentlist * Fix travis :') * Just renamed router and removed network * Applying same SEO fix * Update form_validator.go * Added back regexp package
215 lignes
7,5 Kio
Go
215 lignes
7,5 Kio
Go
// Copyright 2014 Manu Martinez-Almeida. All rights reserved.
|
|
// Use of this source code is governed by a MIT style
|
|
// license that can be found in the LICENSE file.
|
|
|
|
package gin
|
|
|
|
import (
|
|
"net/http"
|
|
"path"
|
|
"regexp"
|
|
"strings"
|
|
)
|
|
|
|
type (
|
|
IRouter interface {
|
|
IRoutes
|
|
Group(string, ...HandlerFunc) *RouterGroup
|
|
}
|
|
|
|
IRoutes interface {
|
|
Use(...HandlerFunc) IRoutes
|
|
|
|
Handle(string, string, ...HandlerFunc) IRoutes
|
|
Any(string, ...HandlerFunc) IRoutes
|
|
GET(string, ...HandlerFunc) IRoutes
|
|
POST(string, ...HandlerFunc) IRoutes
|
|
DELETE(string, ...HandlerFunc) IRoutes
|
|
PATCH(string, ...HandlerFunc) IRoutes
|
|
PUT(string, ...HandlerFunc) IRoutes
|
|
OPTIONS(string, ...HandlerFunc) IRoutes
|
|
HEAD(string, ...HandlerFunc) IRoutes
|
|
|
|
StaticFile(string, string) IRoutes
|
|
Static(string, string) IRoutes
|
|
StaticFS(string, http.FileSystem) IRoutes
|
|
}
|
|
|
|
// RouterGroup is used internally to configure router, a RouterGroup is associated with a prefix
|
|
// and an array of handlers (middleware)
|
|
RouterGroup struct {
|
|
Handlers HandlersChain
|
|
basePath string
|
|
engine *Engine
|
|
root bool
|
|
}
|
|
)
|
|
|
|
var _ IRouter = &RouterGroup{}
|
|
|
|
// Use adds middleware to the group, see example code in github.
|
|
func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoutes {
|
|
group.Handlers = append(group.Handlers, middleware...)
|
|
return group.returnObj()
|
|
}
|
|
|
|
// Group creates a new router group. You should add all the routes that have common middlwares or the same path prefix.
|
|
// For example, all the routes that use a common middlware for authorization could be grouped.
|
|
func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup {
|
|
return &RouterGroup{
|
|
Handlers: group.combineHandlers(handlers),
|
|
basePath: group.calculateAbsolutePath(relativePath),
|
|
engine: group.engine,
|
|
}
|
|
}
|
|
|
|
func (group *RouterGroup) BasePath() string {
|
|
return group.basePath
|
|
}
|
|
|
|
func (group *RouterGroup) handle(httpMethod, relativePath string, handlers HandlersChain) IRoutes {
|
|
absolutePath := group.calculateAbsolutePath(relativePath)
|
|
handlers = group.combineHandlers(handlers)
|
|
group.engine.addRoute(httpMethod, absolutePath, handlers)
|
|
return group.returnObj()
|
|
}
|
|
|
|
// Handle registers a new request handle and middleware with the given path and method.
|
|
// The last handler should be the real handler, the other ones should be middleware that can and should be shared among different routes.
|
|
// See the example code in github.
|
|
//
|
|
// For GET, POST, PUT, PATCH and DELETE requests the respective shortcut
|
|
// functions can be used.
|
|
//
|
|
// This function is intended for bulk loading and to allow the usage of less
|
|
// frequently used, non-standardized or custom methods (e.g. for internal
|
|
// communication with a proxy).
|
|
func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
if matches, err := regexp.MatchString("^[A-Z]+$", httpMethod); !matches || err != nil {
|
|
panic("http method " + httpMethod + " is not valid")
|
|
}
|
|
return group.handle(httpMethod, relativePath, handlers)
|
|
}
|
|
|
|
// POST is a shortcut for router.Handle("POST", path, handle)
|
|
func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("POST", relativePath, handlers)
|
|
}
|
|
|
|
// GET is a shortcut for router.Handle("GET", path, handle)
|
|
func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("GET", relativePath, handlers)
|
|
}
|
|
|
|
// DELETE is a shortcut for router.Handle("DELETE", path, handle)
|
|
func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("DELETE", relativePath, handlers)
|
|
}
|
|
|
|
// PATCH is a shortcut for router.Handle("PATCH", path, handle)
|
|
func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("PATCH", relativePath, handlers)
|
|
}
|
|
|
|
// PUT is a shortcut for router.Handle("PUT", path, handle)
|
|
func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("PUT", relativePath, handlers)
|
|
}
|
|
|
|
// OPTIONS is a shortcut for router.Handle("OPTIONS", path, handle)
|
|
func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("OPTIONS", relativePath, handlers)
|
|
}
|
|
|
|
// HEAD is a shortcut for router.Handle("HEAD", path, handle)
|
|
func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
return group.handle("HEAD", relativePath, handlers)
|
|
}
|
|
|
|
// Any registers a route that matches all the HTTP methods.
|
|
// GET, POST, PUT, PATCH, HEAD, OPTIONS, DELETE, CONNECT, TRACE
|
|
func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes {
|
|
group.handle("GET", relativePath, handlers)
|
|
group.handle("POST", relativePath, handlers)
|
|
group.handle("PUT", relativePath, handlers)
|
|
group.handle("PATCH", relativePath, handlers)
|
|
group.handle("HEAD", relativePath, handlers)
|
|
group.handle("OPTIONS", relativePath, handlers)
|
|
group.handle("DELETE", relativePath, handlers)
|
|
group.handle("CONNECT", relativePath, handlers)
|
|
group.handle("TRACE", relativePath, handlers)
|
|
return group.returnObj()
|
|
}
|
|
|
|
// StaticFile registers a single route in order to server a single file of the local filesystem.
|
|
// router.StaticFile("favicon.ico", "./resources/favicon.ico")
|
|
func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes {
|
|
if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") {
|
|
panic("URL parameters can not be used when serving a static file")
|
|
}
|
|
handler := func(c *Context) {
|
|
c.File(filepath)
|
|
}
|
|
group.GET(relativePath, handler)
|
|
group.HEAD(relativePath, handler)
|
|
return group.returnObj()
|
|
}
|
|
|
|
// Static serves files from the given file system root.
|
|
// Internally a http.FileServer is used, therefore http.NotFound is used instead
|
|
// of the Router's NotFound handler.
|
|
// To use the operating system's file system implementation,
|
|
// use :
|
|
// router.Static("/static", "/var/www")
|
|
func (group *RouterGroup) Static(relativePath, root string) IRoutes {
|
|
return group.StaticFS(relativePath, Dir(root, false))
|
|
}
|
|
|
|
// StaticFS works just like `Static()` but a custom `http.FileSystem` can be used instead.
|
|
// Gin by default user: gin.Dir()
|
|
func (group *RouterGroup) StaticFS(relativePath string, fs http.FileSystem) IRoutes {
|
|
if strings.Contains(relativePath, ":") || strings.Contains(relativePath, "*") {
|
|
panic("URL parameters can not be used when serving a static folder")
|
|
}
|
|
handler := group.createStaticHandler(relativePath, fs)
|
|
urlPattern := path.Join(relativePath, "/*filepath")
|
|
|
|
// Register GET and HEAD handlers
|
|
group.GET(urlPattern, handler)
|
|
group.HEAD(urlPattern, handler)
|
|
return group.returnObj()
|
|
}
|
|
|
|
func (group *RouterGroup) createStaticHandler(relativePath string, fs http.FileSystem) HandlerFunc {
|
|
absolutePath := group.calculateAbsolutePath(relativePath)
|
|
fileServer := http.StripPrefix(absolutePath, http.FileServer(fs))
|
|
_, nolisting := fs.(*onlyfilesFS)
|
|
return func(c *Context) {
|
|
if nolisting {
|
|
c.Writer.WriteHeader(404)
|
|
}
|
|
fileServer.ServeHTTP(c.Writer, c.Request)
|
|
}
|
|
}
|
|
|
|
func (group *RouterGroup) combineHandlers(handlers HandlersChain) HandlersChain {
|
|
finalSize := len(group.Handlers) + len(handlers)
|
|
if finalSize >= int(abortIndex) {
|
|
panic("too many handlers")
|
|
}
|
|
mergedHandlers := make(HandlersChain, finalSize)
|
|
copy(mergedHandlers, group.Handlers)
|
|
copy(mergedHandlers[len(group.Handlers):], handlers)
|
|
return mergedHandlers
|
|
}
|
|
|
|
func (group *RouterGroup) calculateAbsolutePath(relativePath string) string {
|
|
return joinPaths(group.basePath, relativePath)
|
|
}
|
|
|
|
func (group *RouterGroup) returnObj() IRoutes {
|
|
if group.root {
|
|
return group.engine
|
|
}
|
|
return group
|
|
}
|