gin/utils.go

154 lines
3.3 KiB
Go
Raw Normal View History

2014-08-29 17:49:50 +00:00
// 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 (
"encoding/xml"
"net/http"
"os"
2015-04-07 10:22:38 +00:00
"path"
"reflect"
"runtime"
"strings"
)
// BindKey indicates a default bind key.
2015-06-12 21:42:54 +00:00
const BindKey = "_gin-gonic/gin/bindkey"
// Bind is a helper function for given interface object and returns a Gin middleware.
2015-06-12 21:42:54 +00:00
func Bind(val interface{}) HandlerFunc {
2015-06-12 22:01:02 +00:00
value := reflect.ValueOf(val)
if value.Kind() == reflect.Ptr {
panic(`Bind struct can not be a pointer. Example:
Use: gin.Bind(Struct{}) instead of gin.Bind(&Struct{})
`)
}
typ := value.Type()
2015-06-12 21:42:54 +00:00
return func(c *Context) {
obj := reflect.New(typ).Interface()
if c.Bind(obj) == nil {
c.Set(BindKey, obj)
}
}
}
// WrapF is a helper function for wrapping http.HandlerFunc and returns a Gin middleware.
2015-05-19 22:39:52 +00:00
func WrapF(f http.HandlerFunc) HandlerFunc {
return func(c *Context) {
f(c.Writer, c.Request)
}
}
// WrapH is a helper function for wrapping http.Handler and returns a Gin middleware.
2015-05-19 22:39:52 +00:00
func WrapH(h http.Handler) HandlerFunc {
return func(c *Context) {
h.ServeHTTP(c.Writer, c.Request)
}
}
2018-04-17 02:54:40 +00:00
// H is a shortcut for map[string]interface{}
type H map[string]interface{}
2017-08-16 03:55:50 +00:00
// MarshalXML allows type H to be used with xml.Marshal.
func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error {
start.Name = xml.Name{
Space: "",
Local: "map",
}
if err := e.EncodeToken(start); err != nil {
return err
}
for key, value := range h {
elem := xml.StartElement{
Name: xml.Name{Space: "", Local: key},
Attr: []xml.Attr{},
}
if err := e.EncodeElement(value, elem); err != nil {
return err
}
}
return e.EncodeToken(xml.EndElement{Name: start.Name})
}
2016-01-27 23:35:09 +00:00
func assert1(guard bool, text string) {
if !guard {
panic(text)
}
}
func filterFlags(content string) string {
2014-10-08 23:40:42 +00:00
for i, char := range content {
if char == ' ' || char == ';' {
return content[:i]
}
}
return content
}
2014-08-31 16:28:18 +00:00
func chooseData(custom, wildcard interface{}) interface{} {
if custom != nil {
return custom
}
if wildcard != nil {
2014-08-31 16:28:18 +00:00
return wildcard
}
panic("negotiation config is invalid")
}
2015-04-08 00:58:35 +00:00
func parseAccept(acceptHeader string) []string {
parts := strings.Split(acceptHeader, ",")
out := make([]string, 0, len(parts))
for _, part := range parts {
if i := strings.IndexByte(part, ';'); i > 0 {
part = part[:i]
}
if part = strings.TrimSpace(part); part != "" {
2015-04-08 00:58:35 +00:00
out = append(out, part)
}
}
2015-04-08 00:58:35 +00:00
return out
}
2014-10-08 19:37:26 +00:00
func lastChar(str string) uint8 {
2017-09-28 16:22:35 +00:00
if str == "" {
2015-04-08 00:58:35 +00:00
panic("The length of the string can't be 0")
2014-10-08 19:37:26 +00:00
}
2017-09-28 16:22:35 +00:00
return str[len(str)-1]
2014-10-08 19:37:26 +00:00
}
2014-10-08 23:40:42 +00:00
func nameOfFunction(f interface{}) string {
return runtime.FuncForPC(reflect.ValueOf(f).Pointer()).Name()
}
2015-03-31 19:39:06 +00:00
2015-04-07 10:22:38 +00:00
func joinPaths(absolutePath, relativePath string) string {
2017-09-28 16:22:35 +00:00
if relativePath == "" {
2015-04-07 10:22:38 +00:00
return absolutePath
}
2015-04-08 13:32:50 +00:00
finalPath := path.Join(absolutePath, relativePath)
if lastChar(relativePath) == '/' && lastChar(finalPath) != '/' {
2015-04-08 13:32:50 +00:00
return finalPath + "/"
2015-03-31 19:39:06 +00:00
}
2015-04-08 13:32:50 +00:00
return finalPath
2015-03-31 19:39:06 +00:00
}
func resolveAddress(addr []string) string {
switch len(addr) {
case 0:
2017-09-28 16:22:35 +00:00
if port := os.Getenv("PORT"); port != "" {
debugPrint("Environment variable PORT=\"%s\"", port)
return ":" + port
}
2016-04-14 23:16:46 +00:00
debugPrint("Environment variable PORT is undefined. Using port :8080 by default")
return ":8080"
case 1:
return addr[0]
default:
2019-07-03 23:57:52 +00:00
panic("too many parameters")
}
}