| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991 |
- // ⚡️ Fiber is an Express inspired web framework written in Go with ☕️
- // 🤖 Github Repository: https://github.com/gofiber/fiber
- // 📌 API Documentation: https://docs.gofiber.io
- package fiber
- import (
- "bytes"
- "context"
- "crypto/tls"
- "encoding/xml"
- "errors"
- "fmt"
- "io"
- "mime/multipart"
- "net"
- "net/http"
- "path/filepath"
- "reflect"
- "strconv"
- "strings"
- "sync"
- "text/template"
- "time"
- "github.com/gofiber/fiber/v2/internal/schema"
- "github.com/gofiber/fiber/v2/utils"
- "github.com/valyala/bytebufferpool"
- "github.com/valyala/fasthttp"
- )
- const (
- schemeHTTP = "http"
- schemeHTTPS = "https"
- )
- // maxParams defines the maximum number of parameters per route.
- const maxParams = 30
- // Some constants for BodyParser, QueryParser, CookieParser and ReqHeaderParser.
- const (
- queryTag = "query"
- reqHeaderTag = "reqHeader"
- bodyTag = "form"
- paramsTag = "params"
- cookieTag = "cookie"
- )
- // userContextKey define the key name for storing context.Context in *fasthttp.RequestCtx
- const userContextKey = "__local_user_context__"
- var (
- // decoderPoolMap helps to improve BodyParser's, QueryParser's, CookieParser's and ReqHeaderParser's performance
- decoderPoolMap = map[string]*sync.Pool{}
- // tags is used to classify parser's pool
- tags = []string{queryTag, bodyTag, reqHeaderTag, paramsTag, cookieTag}
- )
- func init() {
- for _, tag := range tags {
- decoderPoolMap[tag] = &sync.Pool{New: func() interface{} {
- return decoderBuilder(ParserConfig{
- IgnoreUnknownKeys: true,
- ZeroEmpty: true,
- })
- }}
- }
- }
- // SetParserDecoder allow globally change the option of form decoder, update decoderPool
- func SetParserDecoder(parserConfig ParserConfig) {
- for _, tag := range tags {
- decoderPoolMap[tag] = &sync.Pool{New: func() interface{} {
- return decoderBuilder(parserConfig)
- }}
- }
- }
- // Ctx represents the Context which hold the HTTP request and response.
- // It has methods for the request query string, parameters, body, HTTP headers and so on.
- type Ctx struct {
- app *App // Reference to *App
- route *Route // Reference to *Route
- indexRoute int // Index of the current route
- indexHandler int // Index of the current handler
- method string // HTTP method
- methodINT int // HTTP method INT equivalent
- baseURI string // HTTP base uri
- path string // HTTP path with the modifications by the configuration -> string copy from pathBuffer
- pathBuffer []byte // HTTP path buffer
- detectionPath string // Route detection path -> string copy from detectionPathBuffer
- detectionPathBuffer []byte // HTTP detectionPath buffer
- treePath string // Path for the search in the tree
- pathOriginal string // Original HTTP path
- values [maxParams]string // Route parameter values
- fasthttp *fasthttp.RequestCtx // Reference to *fasthttp.RequestCtx
- matched bool // Non use route matched
- viewBindMap sync.Map // Default view map to bind template engine
- }
- // TLSHandler object
- type TLSHandler struct {
- clientHelloInfo *tls.ClientHelloInfo
- }
- // GetClientInfo Callback function to set ClientHelloInfo
- // Must comply with the method structure of https://cs.opensource.google/go/go/+/refs/tags/go1.20:src/crypto/tls/common.go;l=554-563
- // Since we overlay the method of the tls config in the listener method
- func (t *TLSHandler) GetClientInfo(info *tls.ClientHelloInfo) (*tls.Certificate, error) {
- t.clientHelloInfo = info
- return nil, nil //nolint:nilnil // Not returning anything useful here is probably fine
- }
- // Range data for c.Range
- type Range struct {
- Type string
- Ranges []RangeSet
- }
- // RangeSet represents a single content range from a request.
- type RangeSet struct {
- Start int
- End int
- }
- // Cookie data for c.Cookie
- type Cookie struct {
- Name string `json:"name"`
- Value string `json:"value"`
- Path string `json:"path"`
- Domain string `json:"domain"`
- MaxAge int `json:"max_age"`
- Expires time.Time `json:"expires"`
- Secure bool `json:"secure"`
- HTTPOnly bool `json:"http_only"`
- SameSite string `json:"same_site"`
- SessionOnly bool `json:"session_only"`
- }
- // Views is the interface that wraps the Render function.
- type Views interface {
- Load() error
- Render(io.Writer, string, interface{}, ...string) error
- }
- // ParserType require two element, type and converter for register.
- // Use ParserType with BodyParser for parsing custom type in form data.
- type ParserType struct {
- Customtype interface{}
- Converter func(string) reflect.Value
- }
- // ParserConfig form decoder config for SetParserDecoder
- type ParserConfig struct {
- IgnoreUnknownKeys bool
- SetAliasTag string
- ParserType []ParserType
- ZeroEmpty bool
- }
- // AcquireCtx retrieves a new Ctx from the pool.
- func (app *App) AcquireCtx(fctx *fasthttp.RequestCtx) *Ctx {
- c, ok := app.pool.Get().(*Ctx)
- if !ok {
- panic(fmt.Errorf("failed to type-assert to *Ctx"))
- }
- // Set app reference
- c.app = app
- // Reset route and handler index
- c.indexRoute = -1
- c.indexHandler = 0
- // Reset matched flag
- c.matched = false
- // Set paths
- c.pathOriginal = app.getString(fctx.URI().PathOriginal())
- // Set method
- c.method = app.getString(fctx.Request.Header.Method())
- c.methodINT = app.methodInt(c.method)
- // Attach *fasthttp.RequestCtx to ctx
- c.fasthttp = fctx
- // reset base uri
- c.baseURI = ""
- // Prettify path
- c.configDependentPaths()
- return c
- }
- // ReleaseCtx releases the ctx back into the pool.
- func (app *App) ReleaseCtx(c *Ctx) {
- // Reset values
- c.route = nil
- c.fasthttp = nil
- c.viewBindMap = sync.Map{}
- app.pool.Put(c)
- }
- // Accepts checks if the specified extensions or content types are acceptable.
- func (c *Ctx) Accepts(offers ...string) string {
- return getOffer(c.Get(HeaderAccept), acceptsOfferType, offers...)
- }
- // AcceptsCharsets checks if the specified charset is acceptable.
- func (c *Ctx) AcceptsCharsets(offers ...string) string {
- return getOffer(c.Get(HeaderAcceptCharset), acceptsOffer, offers...)
- }
- // AcceptsEncodings checks if the specified encoding is acceptable.
- func (c *Ctx) AcceptsEncodings(offers ...string) string {
- return getOffer(c.Get(HeaderAcceptEncoding), acceptsOffer, offers...)
- }
- // AcceptsLanguages checks if the specified language is acceptable.
- func (c *Ctx) AcceptsLanguages(offers ...string) string {
- return getOffer(c.Get(HeaderAcceptLanguage), acceptsOffer, offers...)
- }
- // App returns the *App reference to the instance of the Fiber application
- func (c *Ctx) App() *App {
- return c.app
- }
- // Append the specified value to the HTTP response header field.
- // If the header is not already set, it creates the header with the specified value.
- func (c *Ctx) Append(field string, values ...string) {
- if len(values) == 0 {
- return
- }
- h := c.app.getString(c.fasthttp.Response.Header.Peek(field))
- originalH := h
- for _, value := range values {
- if len(h) == 0 {
- h = value
- } else if h != value && !strings.HasPrefix(h, value+",") && !strings.HasSuffix(h, " "+value) &&
- !strings.Contains(h, " "+value+",") {
- h += ", " + value
- }
- }
- if originalH != h {
- c.Set(field, h)
- }
- }
- // Attachment sets the HTTP response Content-Disposition header field to attachment.
- func (c *Ctx) Attachment(filename ...string) {
- if len(filename) > 0 {
- fname := filepath.Base(filename[0])
- c.Type(filepath.Ext(fname))
- c.setCanonical(HeaderContentDisposition, `attachment; filename="`+c.app.quoteString(fname)+`"`)
- return
- }
- c.setCanonical(HeaderContentDisposition, "attachment")
- }
- // BaseURL returns (protocol + host + base path).
- func (c *Ctx) BaseURL() string {
- // TODO: Could be improved: 53.8 ns/op 32 B/op 1 allocs/op
- // Should work like https://codeigniter.com/user_guide/helpers/url_helper.html
- if c.baseURI != "" {
- return c.baseURI
- }
- c.baseURI = c.Protocol() + "://" + c.Hostname()
- return c.baseURI
- }
- // BodyRaw contains the raw body submitted in a POST request.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) BodyRaw() []byte {
- return c.getBody()
- }
- func (c *Ctx) tryDecodeBodyInOrder(
- originalBody *[]byte,
- encodings []string,
- ) ([]byte, uint8, error) {
- var (
- err error
- body []byte
- decodesRealized uint8
- )
- for index, encoding := range encodings {
- decodesRealized++
- switch encoding {
- case StrGzip:
- body, err = c.fasthttp.Request.BodyGunzip()
- case StrBr, StrBrotli:
- body, err = c.fasthttp.Request.BodyUnbrotli()
- case StrDeflate:
- body, err = c.fasthttp.Request.BodyInflate()
- default:
- decodesRealized--
- if len(encodings) == 1 {
- body = c.fasthttp.Request.Body()
- }
- return body, decodesRealized, nil
- }
- if err != nil {
- return nil, decodesRealized, err
- }
- // Only execute body raw update if it has a next iteration to try to decode
- if index < len(encodings)-1 && decodesRealized > 0 {
- if index == 0 {
- tempBody := c.fasthttp.Request.Body()
- *originalBody = make([]byte, len(tempBody))
- copy(*originalBody, tempBody)
- }
- c.fasthttp.Request.SetBodyRaw(body)
- }
- }
- return body, decodesRealized, nil
- }
- // Body contains the raw body submitted in a POST request.
- // This method will decompress the body if the 'Content-Encoding' header is provided.
- // It returns the original (or decompressed) body data which is valid only within the handler.
- // Don't store direct references to the returned data.
- // If you need to keep the body's data later, make a copy or use the Immutable option.
- func (c *Ctx) Body() []byte {
- var (
- err error
- body, originalBody []byte
- headerEncoding string
- encodingOrder = []string{"", "", ""}
- )
- // faster than peek
- c.Request().Header.VisitAll(func(key, value []byte) {
- if c.app.getString(key) == HeaderContentEncoding {
- headerEncoding = c.app.getString(value)
- }
- })
- // Split and get the encodings list, in order to attend the
- // rule defined at: https://www.rfc-editor.org/rfc/rfc9110#section-8.4-5
- encodingOrder = getSplicedStrList(headerEncoding, encodingOrder)
- if len(encodingOrder) == 0 {
- return c.getBody()
- }
- var decodesRealized uint8
- body, decodesRealized, err = c.tryDecodeBodyInOrder(&originalBody, encodingOrder)
- // Ensure that the body will be the original
- if originalBody != nil && decodesRealized > 0 {
- c.fasthttp.Request.SetBodyRaw(originalBody)
- }
- if err != nil {
- return []byte(err.Error())
- }
- if c.app.config.Immutable {
- return utils.CopyBytes(body)
- }
- return body
- }
- func decoderBuilder(parserConfig ParserConfig) interface{} {
- decoder := schema.NewDecoder()
- decoder.IgnoreUnknownKeys(parserConfig.IgnoreUnknownKeys)
- if parserConfig.SetAliasTag != "" {
- decoder.SetAliasTag(parserConfig.SetAliasTag)
- }
- for _, v := range parserConfig.ParserType {
- decoder.RegisterConverter(reflect.ValueOf(v.Customtype).Interface(), v.Converter)
- }
- decoder.ZeroEmpty(parserConfig.ZeroEmpty)
- return decoder
- }
- // BodyParser binds the request body to a struct.
- // It supports decoding the following content types based on the Content-Type header:
- // application/json, application/xml, application/x-www-form-urlencoded, multipart/form-data
- // All JSON extenstion mime types are supported (eg. application/problem+json)
- // If none of the content types above are matched, it will return a ErrUnprocessableEntity error
- func (c *Ctx) BodyParser(out interface{}) error {
- // Get content-type
- ctype := utils.ToLower(c.app.getString(c.fasthttp.Request.Header.ContentType()))
- ctype = utils.ParseVendorSpecificContentType(ctype)
- // Only use ctype string up to and excluding byte ';'
- ctypeEnd := strings.IndexByte(ctype, ';')
- if ctypeEnd != -1 {
- ctype = ctype[:ctypeEnd]
- }
- // Parse body accordingly
- if strings.HasSuffix(ctype, "json") {
- return c.app.config.JSONDecoder(c.Body(), out)
- }
- if ctype == MIMEApplicationForm {
- data := make(map[string][]string)
- var err error
- c.fasthttp.PostArgs().VisitAll(func(key, val []byte) {
- if err != nil {
- return
- }
- k := c.app.getString(key)
- v := c.app.getString(val)
- err = formatParserData(out, data, bodyTag, k, v, c.app.config.EnableSplittingOnParsers, true)
- })
- if err != nil {
- return err
- }
- return c.parseToStruct(bodyTag, out, data)
- }
- if ctype == MIMEMultipartForm {
- multipartForm, err := c.fasthttp.MultipartForm()
- if err != nil {
- return err
- }
- data := make(map[string][]string)
- for key, values := range multipartForm.Value {
- err = formatParserData(out, data, bodyTag, key, values, c.app.config.EnableSplittingOnParsers, true)
- if err != nil {
- return err
- }
- }
- return c.parseToStruct(bodyTag, out, data)
- }
- if ctype == MIMETextXML || ctype == MIMEApplicationXML {
- if err := xml.Unmarshal(c.Body(), out); err != nil {
- return fmt.Errorf("failed to unmarshal: %w", err)
- }
- return nil
- }
- // No suitable content type found
- return ErrUnprocessableEntity
- }
- // ClearCookie expires a specific cookie by key on the client side.
- // If no key is provided it expires all cookies that came with the request.
- func (c *Ctx) ClearCookie(key ...string) {
- if len(key) > 0 {
- for i := range key {
- c.fasthttp.Response.Header.DelClientCookie(key[i])
- }
- return
- }
- c.fasthttp.Request.Header.VisitAllCookie(func(k, v []byte) {
- c.fasthttp.Response.Header.DelClientCookieBytes(k)
- })
- }
- // Context returns *fasthttp.RequestCtx that carries a deadline
- // a cancellation signal, and other values across API boundaries.
- func (c *Ctx) Context() *fasthttp.RequestCtx {
- return c.fasthttp
- }
- // UserContext returns a context implementation that was set by
- // user earlier or returns a non-nil, empty context,if it was not set earlier.
- func (c *Ctx) UserContext() context.Context {
- ctx, ok := c.fasthttp.UserValue(userContextKey).(context.Context)
- if !ok {
- ctx = context.Background()
- c.SetUserContext(ctx)
- }
- return ctx
- }
- // SetUserContext sets a context implementation by user.
- func (c *Ctx) SetUserContext(ctx context.Context) {
- c.fasthttp.SetUserValue(userContextKey, ctx)
- }
- // Cookie sets a cookie by passing a cookie struct.
- func (c *Ctx) Cookie(cookie *Cookie) {
- fcookie := fasthttp.AcquireCookie()
- fcookie.SetKey(cookie.Name)
- fcookie.SetValue(cookie.Value)
- fcookie.SetPath(cookie.Path)
- fcookie.SetDomain(cookie.Domain)
- // only set max age and expiry when SessionOnly is false
- // i.e. cookie supposed to last beyond browser session
- // refer: https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies#define_the_lifetime_of_a_cookie
- if !cookie.SessionOnly {
- fcookie.SetMaxAge(cookie.MaxAge)
- fcookie.SetExpire(cookie.Expires)
- }
- fcookie.SetSecure(cookie.Secure)
- fcookie.SetHTTPOnly(cookie.HTTPOnly)
- switch utils.ToLower(cookie.SameSite) {
- case CookieSameSiteStrictMode:
- fcookie.SetSameSite(fasthttp.CookieSameSiteStrictMode)
- case CookieSameSiteNoneMode:
- fcookie.SetSameSite(fasthttp.CookieSameSiteNoneMode)
- case CookieSameSiteDisabled:
- fcookie.SetSameSite(fasthttp.CookieSameSiteDisabled)
- default:
- fcookie.SetSameSite(fasthttp.CookieSameSiteLaxMode)
- }
- c.fasthttp.Response.Header.SetCookie(fcookie)
- fasthttp.ReleaseCookie(fcookie)
- }
- // Cookies are used for getting a cookie value by key.
- // Defaults to the empty string "" if the cookie doesn't exist.
- // If a default value is given, it will return that value if the cookie doesn't exist.
- // The returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting to use the value outside the Handler.
- func (c *Ctx) Cookies(key string, defaultValue ...string) string {
- return defaultString(c.app.getString(c.fasthttp.Request.Header.Cookie(key)), defaultValue)
- }
- // CookieParser is used to bind cookies to a struct
- func (c *Ctx) CookieParser(out interface{}) error {
- data := make(map[string][]string)
- var err error
- // loop through all cookies
- c.fasthttp.Request.Header.VisitAllCookie(func(key, val []byte) {
- if err != nil {
- return
- }
- k := c.app.getString(key)
- v := c.app.getString(val)
- err = formatParserData(out, data, cookieTag, k, v, c.app.config.EnableSplittingOnParsers, true)
- })
- if err != nil {
- return err
- }
- return c.parseToStruct(cookieTag, out, data)
- }
- // Download transfers the file from path as an attachment.
- // Typically, browsers will prompt the user for download.
- // By default, the Content-Disposition header filename= parameter is the filepath (this typically appears in the browser dialog).
- // Override this default with the filename parameter.
- func (c *Ctx) Download(file string, filename ...string) error {
- var fname string
- if len(filename) > 0 {
- fname = filename[0]
- } else {
- fname = filepath.Base(file)
- }
- c.setCanonical(HeaderContentDisposition, `attachment; filename="`+c.app.quoteString(fname)+`"`)
- return c.SendFile(file)
- }
- // Request return the *fasthttp.Request object
- // This allows you to use all fasthttp request methods
- // https://godoc.org/github.com/valyala/fasthttp#Request
- func (c *Ctx) Request() *fasthttp.Request {
- return &c.fasthttp.Request
- }
- // Response return the *fasthttp.Response object
- // This allows you to use all fasthttp response methods
- // https://godoc.org/github.com/valyala/fasthttp#Response
- func (c *Ctx) Response() *fasthttp.Response {
- return &c.fasthttp.Response
- }
- // Format performs content-negotiation on the Accept HTTP header.
- // It uses Accepts to select a proper format.
- // If the header is not specified or there is no proper format, text/plain is used.
- func (c *Ctx) Format(body interface{}) error {
- // Get accepted content type
- accept := c.Accepts("html", "json", "txt", "xml")
- // Set accepted content type
- c.Type(accept)
- // Type convert provided body
- var b string
- switch val := body.(type) {
- case string:
- b = val
- case []byte:
- b = c.app.getString(val)
- default:
- b = fmt.Sprintf("%v", val)
- }
- // Format based on the accept content type
- switch accept {
- case "html":
- return c.SendString("<p>" + b + "</p>")
- case "json":
- return c.JSON(body)
- case "txt":
- return c.SendString(b)
- case "xml":
- return c.XML(body)
- }
- return c.SendString(b)
- }
- // FormFile returns the first file by key from a MultipartForm.
- func (c *Ctx) FormFile(key string) (*multipart.FileHeader, error) {
- return c.fasthttp.FormFile(key)
- }
- // FormValue returns the first value by key from a MultipartForm.
- // Search is performed in QueryArgs, PostArgs, MultipartForm and FormFile in this particular order.
- // Defaults to the empty string "" if the form value doesn't exist.
- // If a default value is given, it will return that value if the form value does not exist.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) FormValue(key string, defaultValue ...string) string {
- return defaultString(c.app.getString(c.fasthttp.FormValue(key)), defaultValue)
- }
- // Fresh returns true when the response is still “fresh” in the client's cache,
- // otherwise false is returned to indicate that the client cache is now stale
- // and the full response should be sent.
- // When a client sends the Cache-Control: no-cache request header to indicate an end-to-end
- // reload request, this module will return false to make handling these requests transparent.
- // https://github.com/jshttp/fresh/blob/10e0471669dbbfbfd8de65bc6efac2ddd0bfa057/index.js#L33
- func (c *Ctx) Fresh() bool {
- // fields
- modifiedSince := c.Get(HeaderIfModifiedSince)
- noneMatch := c.Get(HeaderIfNoneMatch)
- // unconditional request
- if modifiedSince == "" && noneMatch == "" {
- return false
- }
- // Always return stale when Cache-Control: no-cache
- // to support end-to-end reload requests
- // https://tools.ietf.org/html/rfc2616#section-14.9.4
- cacheControl := c.Get(HeaderCacheControl)
- if cacheControl != "" && isNoCache(cacheControl) {
- return false
- }
- // if-none-match
- if noneMatch != "" && noneMatch != "*" {
- etag := c.app.getString(c.fasthttp.Response.Header.Peek(HeaderETag))
- if etag == "" {
- return false
- }
- if c.app.isEtagStale(etag, c.app.getBytes(noneMatch)) {
- return false
- }
- if modifiedSince != "" {
- lastModified := c.app.getString(c.fasthttp.Response.Header.Peek(HeaderLastModified))
- if lastModified != "" {
- lastModifiedTime, err := http.ParseTime(lastModified)
- if err != nil {
- return false
- }
- modifiedSinceTime, err := http.ParseTime(modifiedSince)
- if err != nil {
- return false
- }
- return lastModifiedTime.Before(modifiedSinceTime)
- }
- }
- }
- return true
- }
- // Get returns the HTTP request header specified by field.
- // Field names are case-insensitive
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) Get(key string, defaultValue ...string) string {
- return defaultString(c.app.getString(c.fasthttp.Request.Header.Peek(key)), defaultValue)
- }
- // GetRespHeader returns the HTTP response header specified by field.
- // Field names are case-insensitive
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) GetRespHeader(key string, defaultValue ...string) string {
- return defaultString(c.app.getString(c.fasthttp.Response.Header.Peek(key)), defaultValue)
- }
- // GetReqHeaders returns the HTTP request headers.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) GetReqHeaders() map[string][]string {
- headers := make(map[string][]string)
- c.Request().Header.VisitAll(func(k, v []byte) {
- key := c.app.getString(k)
- headers[key] = append(headers[key], c.app.getString(v))
- })
- return headers
- }
- // GetRespHeaders returns the HTTP response headers.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- func (c *Ctx) GetRespHeaders() map[string][]string {
- headers := make(map[string][]string)
- c.Response().Header.VisitAll(func(k, v []byte) {
- key := c.app.getString(k)
- headers[key] = append(headers[key], c.app.getString(v))
- })
- return headers
- }
- // Hostname contains the hostname derived from the X-Forwarded-Host or Host HTTP header.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting instead.
- // Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.
- func (c *Ctx) Hostname() string {
- if c.IsProxyTrusted() {
- if host := c.Get(HeaderXForwardedHost); len(host) > 0 {
- commaPos := strings.Index(host, ",")
- if commaPos != -1 {
- return host[:commaPos]
- }
- return host
- }
- }
- return c.app.getString(c.fasthttp.Request.URI().Host())
- }
- // Port returns the remote port of the request.
- func (c *Ctx) Port() string {
- tcpaddr, ok := c.fasthttp.RemoteAddr().(*net.TCPAddr)
- if !ok {
- panic(fmt.Errorf("failed to type-assert to *net.TCPAddr"))
- }
- return strconv.Itoa(tcpaddr.Port)
- }
- // IP returns the remote IP address of the request.
- // If ProxyHeader and IP Validation is configured, it will parse that header and return the first valid IP address.
- // Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.
- func (c *Ctx) IP() string {
- if c.IsProxyTrusted() && len(c.app.config.ProxyHeader) > 0 {
- return c.extractIPFromHeader(c.app.config.ProxyHeader)
- }
- return c.fasthttp.RemoteIP().String()
- }
- // extractIPsFromHeader will return a slice of IPs it found given a header name in the order they appear.
- // When IP validation is enabled, any invalid IPs will be omitted.
- func (c *Ctx) extractIPsFromHeader(header string) []string {
- // TODO: Reuse the c.extractIPFromHeader func somehow in here
- headerValue := c.Get(header)
- // We can't know how many IPs we will return, but we will try to guess with this constant division.
- // Counting ',' makes function slower for about 50ns in general case.
- const maxEstimatedCount = 8
- estimatedCount := len(headerValue) / maxEstimatedCount
- if estimatedCount > maxEstimatedCount {
- estimatedCount = maxEstimatedCount // Avoid big allocation on big header
- }
- ipsFound := make([]string, 0, estimatedCount)
- i := 0
- j := -1
- iploop:
- for {
- var v4, v6 bool
- // Manually splitting string without allocating slice, working with parts directly
- i, j = j+1, j+2
- if j > len(headerValue) {
- break
- }
- for j < len(headerValue) && headerValue[j] != ',' {
- if headerValue[j] == ':' {
- v6 = true
- } else if headerValue[j] == '.' {
- v4 = true
- }
- j++
- }
- for i < j && (headerValue[i] == ' ' || headerValue[i] == ',') {
- i++
- }
- s := utils.TrimRight(headerValue[i:j], ' ')
- if c.app.config.EnableIPValidation {
- // Skip validation if IP is clearly not IPv4/IPv6, otherwise validate without allocations
- if (!v6 && !v4) || (v6 && !utils.IsIPv6(s)) || (v4 && !utils.IsIPv4(s)) {
- continue iploop
- }
- }
- ipsFound = append(ipsFound, s)
- }
- return ipsFound
- }
- // extractIPFromHeader will attempt to pull the real client IP from the given header when IP validation is enabled.
- // currently, it will return the first valid IP address in header.
- // when IP validation is disabled, it will simply return the value of the header without any inspection.
- // Implementation is almost the same as in extractIPsFromHeader, but without allocation of []string.
- func (c *Ctx) extractIPFromHeader(header string) string {
- if c.app.config.EnableIPValidation {
- headerValue := c.Get(header)
- i := 0
- j := -1
- iploop:
- for {
- var v4, v6 bool
- // Manually splitting string without allocating slice, working with parts directly
- i, j = j+1, j+2
- if j > len(headerValue) {
- break
- }
- for j < len(headerValue) && headerValue[j] != ',' {
- if headerValue[j] == ':' {
- v6 = true
- } else if headerValue[j] == '.' {
- v4 = true
- }
- j++
- }
- for i < j && headerValue[i] == ' ' {
- i++
- }
- s := utils.TrimRight(headerValue[i:j], ' ')
- if c.app.config.EnableIPValidation {
- if (!v6 && !v4) || (v6 && !utils.IsIPv6(s)) || (v4 && !utils.IsIPv4(s)) {
- continue iploop
- }
- }
- return s
- }
- return c.fasthttp.RemoteIP().String()
- }
- // default behavior if IP validation is not enabled is just to return whatever value is
- // in the proxy header. Even if it is empty or invalid
- return c.Get(c.app.config.ProxyHeader)
- }
- // IPs returns a string slice of IP addresses specified in the X-Forwarded-For request header.
- // When IP validation is enabled, only valid IPs are returned.
- func (c *Ctx) IPs() []string {
- return c.extractIPsFromHeader(HeaderXForwardedFor)
- }
- // Is returns the matching content type,
- // if the incoming request's Content-Type HTTP header field matches the MIME type specified by the type parameter
- func (c *Ctx) Is(extension string) bool {
- extensionHeader := utils.GetMIME(extension)
- if extensionHeader == "" {
- return false
- }
- ct := c.app.getString(c.fasthttp.Request.Header.ContentType())
- if i := strings.IndexByte(ct, ';'); i != -1 {
- ct = ct[:i]
- }
- ct = utils.Trim(ct, ' ')
- return utils.EqualFold(ct, extensionHeader)
- }
- // JSON converts any interface or string to JSON.
- // Array and slice values encode as JSON arrays,
- // except that []byte encodes as a base64-encoded string,
- // and a nil slice encodes as the null JSON value.
- // If the ctype parameter is given, this method will set the
- // Content-Type header equal to ctype. If ctype is not given,
- // The Content-Type header will be set to application/json.
- func (c *Ctx) JSON(data interface{}, ctype ...string) error {
- raw, err := c.app.config.JSONEncoder(data)
- if err != nil {
- return err
- }
- c.fasthttp.Response.SetBodyRaw(raw)
- if len(ctype) > 0 {
- c.fasthttp.Response.Header.SetContentType(ctype[0])
- } else {
- c.fasthttp.Response.Header.SetContentType(MIMEApplicationJSON)
- }
- return nil
- }
- // JSONP sends a JSON response with JSONP support.
- // This method is identical to JSON, except that it opts-in to JSONP callback support.
- // By default, the callback name is simply callback.
- func (c *Ctx) JSONP(data interface{}, callback ...string) error {
- raw, err := c.app.config.JSONEncoder(data)
- if err != nil {
- return err
- }
- var result, cb string
- if len(callback) > 0 {
- cb = callback[0]
- } else {
- cb = "callback"
- }
- result = cb + "(" + c.app.getString(raw) + ");"
- c.setCanonical(HeaderXContentTypeOptions, "nosniff")
- c.fasthttp.Response.Header.SetContentType(MIMETextJavaScriptCharsetUTF8)
- return c.SendString(result)
- }
- // XML converts any interface or string to XML.
- // This method also sets the content header to application/xml.
- func (c *Ctx) XML(data interface{}) error {
- raw, err := c.app.config.XMLEncoder(data)
- if err != nil {
- return err
- }
- c.fasthttp.Response.SetBodyRaw(raw)
- c.fasthttp.Response.Header.SetContentType(MIMEApplicationXML)
- return nil
- }
- // Links joins the links followed by the property to populate the response's Link HTTP header field.
- func (c *Ctx) Links(link ...string) {
- if len(link) == 0 {
- return
- }
- bb := bytebufferpool.Get()
- for i := range link {
- if i%2 == 0 {
- _ = bb.WriteByte('<')
- _, _ = bb.WriteString(link[i])
- _ = bb.WriteByte('>')
- } else {
- _, _ = bb.WriteString(`; rel="` + link[i] + `",`)
- }
- }
- c.setCanonical(HeaderLink, utils.TrimRight(c.app.getString(bb.Bytes()), ','))
- bytebufferpool.Put(bb)
- }
- // Locals makes it possible to pass interface{} values under keys scoped to the request
- // and therefore available to all following routes that match the request.
- //
- // All the values are removed from ctx after returning from the top
- // RequestHandler. Additionally, Close method is called on each value
- // implementing io.Closer before removing the value from ctx.
- func (c *Ctx) Locals(key interface{}, value ...interface{}) interface{} {
- if len(value) == 0 {
- return c.fasthttp.UserValue(key)
- }
- c.fasthttp.SetUserValue(key, value[0])
- return value[0]
- }
- // Location sets the response Location HTTP header to the specified path parameter.
- func (c *Ctx) Location(path string) {
- c.setCanonical(HeaderLocation, path)
- }
- // Method returns the HTTP request method for the context, optionally overridden by the provided argument.
- // If no override is given or if the provided override is not a valid HTTP method, it returns the current method from the context.
- // Otherwise, it updates the context's method and returns the overridden method as a string.
- func (c *Ctx) Method(override ...string) string {
- if len(override) == 0 {
- // Nothing to override, just return current method from context
- return c.method
- }
- method := utils.ToUpper(override[0])
- mINT := c.app.methodInt(method)
- if mINT == -1 {
- // Provided override does not valid HTTP method, no override, return current method
- return c.method
- }
- c.method = method
- c.methodINT = mINT
- return c.method
- }
- // MultipartForm parse form entries from binary.
- // This returns a map[string][]string, so given a key the value will be a string slice.
- func (c *Ctx) MultipartForm() (*multipart.Form, error) {
- return c.fasthttp.MultipartForm()
- }
- // ClientHelloInfo return CHI from context
- func (c *Ctx) ClientHelloInfo() *tls.ClientHelloInfo {
- if c.app.tlsHandler != nil {
- return c.app.tlsHandler.clientHelloInfo
- }
- return nil
- }
- // Next executes the next method in the stack that matches the current route.
- func (c *Ctx) Next() error {
- // Increment handler index
- c.indexHandler++
- var err error
- // Did we execute all route handlers?
- if c.indexHandler < len(c.route.Handlers) {
- // Continue route stack
- err = c.route.Handlers[c.indexHandler](c)
- } else {
- // Continue handler stack
- _, err = c.app.next(c)
- }
- return err
- }
- // RestartRouting instead of going to the next handler. This may be useful after
- // changing the request path. Note that handlers might be executed again.
- func (c *Ctx) RestartRouting() error {
- c.indexRoute = -1
- _, err := c.app.next(c)
- return err
- }
- // OriginalURL contains the original request URL.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting to use the value outside the Handler.
- func (c *Ctx) OriginalURL() string {
- return c.app.getString(c.fasthttp.Request.Header.RequestURI())
- }
- // Params is used to get the route parameters.
- // Defaults to empty string "" if the param doesn't exist.
- // If a default value is given, it will return that value if the param doesn't exist.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting to use the value outside the Handler.
- func (c *Ctx) Params(key string, defaultValue ...string) string {
- if key == "*" || key == "+" {
- key += "1"
- }
- for i := range c.route.Params {
- if len(key) != len(c.route.Params[i]) {
- continue
- }
- if c.route.Params[i] == key || (!c.app.config.CaseSensitive && utils.EqualFold(c.route.Params[i], key)) {
- // in case values are not here
- if len(c.values) <= i || len(c.values[i]) == 0 {
- break
- }
- return c.values[i]
- }
- }
- return defaultString("", defaultValue)
- }
- // AllParams Params is used to get all route parameters.
- // Using Params method to get params.
- func (c *Ctx) AllParams() map[string]string {
- params := make(map[string]string, len(c.route.Params))
- for _, param := range c.route.Params {
- params[param] = c.Params(param)
- }
- return params
- }
- // ParamsParser binds the param string to a struct.
- func (c *Ctx) ParamsParser(out interface{}) error {
- params := make(map[string][]string, len(c.route.Params))
- for _, param := range c.route.Params {
- params[param] = append(params[param], c.Params(param))
- }
- return c.parseToStruct(paramsTag, out, params)
- }
- // ParamsInt is used to get an integer from the route parameters
- // it defaults to zero if the parameter is not found or if the
- // parameter cannot be converted to an integer
- // If a default value is given, it will return that value in case the param
- // doesn't exist or cannot be converted to an integer
- func (c *Ctx) ParamsInt(key string, defaultValue ...int) (int, error) {
- // Use Atoi to convert the param to an int or return zero and an error
- value, err := strconv.Atoi(c.Params(key))
- if err != nil {
- if len(defaultValue) > 0 {
- return defaultValue[0], nil
- }
- return 0, fmt.Errorf("failed to convert: %w", err)
- }
- return value, nil
- }
- // Path returns the path part of the request URL.
- // Optionally, you could override the path.
- func (c *Ctx) Path(override ...string) string {
- if len(override) != 0 && c.path != override[0] {
- // Set new path to context
- c.pathOriginal = override[0]
- // Set new path to request context
- c.fasthttp.Request.URI().SetPath(c.pathOriginal)
- // Prettify path
- c.configDependentPaths()
- }
- return c.path
- }
- // Protocol contains the request protocol string: http or https for TLS requests.
- // Please use Config.EnableTrustedProxyCheck to prevent header spoofing, in case when your app is behind the proxy.
- func (c *Ctx) Protocol() string {
- if c.fasthttp.IsTLS() {
- return schemeHTTPS
- }
- if !c.IsProxyTrusted() {
- return schemeHTTP
- }
- scheme := schemeHTTP
- const lenXHeaderName = 12
- c.fasthttp.Request.Header.VisitAll(func(key, val []byte) {
- if len(key) < lenXHeaderName {
- return // Neither "X-Forwarded-" nor "X-Url-Scheme"
- }
- switch {
- case bytes.HasPrefix(key, []byte("X-Forwarded-")):
- if bytes.Equal(key, []byte(HeaderXForwardedProto)) ||
- bytes.Equal(key, []byte(HeaderXForwardedProtocol)) {
- v := c.app.getString(val)
- commaPos := strings.Index(v, ",")
- if commaPos != -1 {
- scheme = v[:commaPos]
- } else {
- scheme = v
- }
- } else if bytes.Equal(key, []byte(HeaderXForwardedSsl)) && bytes.Equal(val, []byte("on")) {
- scheme = schemeHTTPS
- }
- case bytes.Equal(key, []byte(HeaderXUrlScheme)):
- scheme = c.app.getString(val)
- }
- })
- return scheme
- }
- // Query returns the query string parameter in the url.
- // Defaults to empty string "" if the query doesn't exist.
- // If a default value is given, it will return that value if the query doesn't exist.
- // Returned value is only valid within the handler. Do not store any references.
- // Make copies or use the Immutable setting to use the value outside the Handler.
- func (c *Ctx) Query(key string, defaultValue ...string) string {
- return defaultString(c.app.getString(c.fasthttp.QueryArgs().Peek(key)), defaultValue)
- }
- // Queries returns a map of query parameters and their values.
- //
- // GET /?name=alex&wanna_cake=2&id=
- // Queries()["name"] == "alex"
- // Queries()["wanna_cake"] == "2"
- // Queries()["id"] == ""
- //
- // GET /?field1=value1&field1=value2&field2=value3
- // Queries()["field1"] == "value2"
- // Queries()["field2"] == "value3"
- //
- // GET /?list_a=1&list_a=2&list_a=3&list_b[]=1&list_b[]=2&list_b[]=3&list_c=1,2,3
- // Queries()["list_a"] == "3"
- // Queries()["list_b[]"] == "3"
- // Queries()["list_c"] == "1,2,3"
- //
- // GET /api/search?filters.author.name=John&filters.category.name=Technology&filters[customer][name]=Alice&filters[status]=pending
- // Queries()["filters.author.name"] == "John"
- // Queries()["filters.category.name"] == "Technology"
- // Queries()["filters[customer][name]"] == "Alice"
- // Queries()["filters[status]"] == "pending"
- func (c *Ctx) Queries() map[string]string {
- m := make(map[string]string, c.Context().QueryArgs().Len())
- c.Context().QueryArgs().VisitAll(func(key, value []byte) {
- m[c.app.getString(key)] = c.app.getString(value)
- })
- return m
- }
- // QueryInt returns integer value of key string parameter in the url.
- // Default to empty or invalid key is 0.
- //
- // GET /?name=alex&wanna_cake=2&id=
- // QueryInt("wanna_cake", 1) == 2
- // QueryInt("name", 1) == 1
- // QueryInt("id", 1) == 1
- // QueryInt("id") == 0
- func (c *Ctx) QueryInt(key string, defaultValue ...int) int {
- // Use Atoi to convert the param to an int or return zero and an error
- value, err := strconv.Atoi(c.app.getString(c.fasthttp.QueryArgs().Peek(key)))
- if err != nil {
- if len(defaultValue) > 0 {
- return defaultValue[0]
- }
- return 0
- }
- return value
- }
- // QueryBool returns bool value of key string parameter in the url.
- // Default to empty or invalid key is false.
- //
- // Get /?name=alex&want_pizza=false&id=
- // QueryBool("want_pizza") == false
- // QueryBool("want_pizza", true) == false
- // QueryBool("name") == false
- // QueryBool("name", true) == true
- // QueryBool("id") == false
- // QueryBool("id", true) == true
- func (c *Ctx) QueryBool(key string, defaultValue ...bool) bool {
- value, err := strconv.ParseBool(c.app.getString(c.fasthttp.QueryArgs().Peek(key)))
- if err != nil {
- if len(defaultValue) > 0 {
- return defaultValue[0]
- }
- return false
- }
- return value
- }
- // QueryFloat returns float64 value of key string parameter in the url.
- // Default to empty or invalid key is 0.
- //
- // GET /?name=alex&amount=32.23&id=
- // QueryFloat("amount") = 32.23
- // QueryFloat("amount", 3) = 32.23
- // QueryFloat("name", 1) = 1
- // QueryFloat("name") = 0
- // QueryFloat("id", 3) = 3
- func (c *Ctx) QueryFloat(key string, defaultValue ...float64) float64 {
- // use strconv.ParseFloat to convert the param to a float or return zero and an error.
- value, err := strconv.ParseFloat(c.app.getString(c.fasthttp.QueryArgs().Peek(key)), 64)
- if err != nil {
- if len(defaultValue) > 0 {
- return defaultValue[0]
- }
- return 0
- }
- return value
- }
- // QueryParser binds the query string to a struct.
- func (c *Ctx) QueryParser(out interface{}) error {
- data := make(map[string][]string)
- var err error
- c.fasthttp.QueryArgs().VisitAll(func(key, val []byte) {
- if err != nil {
- return
- }
- k := c.app.getString(key)
- v := c.app.getString(val)
- err = formatParserData(out, data, queryTag, k, v, c.app.config.EnableSplittingOnParsers, true)
- })
- if err != nil {
- return err
- }
- return c.parseToStruct(queryTag, out, data)
- }
- // ReqHeaderParser binds the request header strings to a struct.
- func (c *Ctx) ReqHeaderParser(out interface{}) error {
- data := make(map[string][]string)
- var err error
- c.fasthttp.Request.Header.VisitAll(func(key, val []byte) {
- if err != nil {
- return
- }
- k := c.app.getString(key)
- v := c.app.getString(val)
- err = formatParserData(out, data, reqHeaderTag, k, v, c.app.config.EnableSplittingOnParsers, false)
- })
- if err != nil {
- return err
- }
- return c.parseToStruct(reqHeaderTag, out, data)
- }
- func (*Ctx) parseToStruct(aliasTag string, out interface{}, data map[string][]string) error {
- // Get decoder from pool
- schemaDecoder, ok := decoderPoolMap[aliasTag].Get().(*schema.Decoder)
- if !ok {
- panic(fmt.Errorf("failed to type-assert to *schema.Decoder"))
- }
- defer decoderPoolMap[aliasTag].Put(schemaDecoder)
- // Set alias tag
- schemaDecoder.SetAliasTag(aliasTag)
- if err := schemaDecoder.Decode(out, data); err != nil {
- return fmt.Errorf("failed to decode: %w", err)
- }
- return nil
- }
- func equalFieldType(out interface{}, kind reflect.Kind, key, tag string) bool {
- outTyp := reflect.TypeOf(out).Elem()
- if outTyp.Kind() != reflect.Struct {
- return false
- }
- key = utils.ToLower(key)
- return checkEqualFieldType(outTyp, kind, key, tag)
- }
- func checkEqualFieldType(outTyp reflect.Type, kind reflect.Kind, key, tag string) bool {
- for i := 0; i < outTyp.NumField(); i++ {
- typeField := outTyp.Field(i)
- if typeField.Anonymous && typeField.Type.Kind() == reflect.Struct {
- if checkEqualFieldType(typeField.Type, kind, key, tag) {
- return true
- }
- }
- if typeField.PkgPath != "" { // unexported field
- continue
- }
- if typeField.Type.Kind() != kind {
- continue
- }
- inputFieldName := typeField.Tag.Get(tag)
- if inputFieldName == "" {
- inputFieldName = typeField.Name
- } else if idx := strings.IndexByte(inputFieldName, ','); idx > -1 {
- inputFieldName = inputFieldName[:idx]
- }
- if utils.ToLower(inputFieldName) == key {
- return true
- }
- }
- return false
- }
- var (
- ErrRangeMalformed = errors.New("range: malformed range header string")
- ErrRangeUnsatisfiable = errors.New("range: unsatisfiable range")
- )
- // Range returns a struct containing the type and a slice of ranges.
- func (c *Ctx) Range(size int) (Range, error) {
- var (
- rangeData Range
- ranges string
- )
- rangeStr := c.Get(HeaderRange)
- i := strings.IndexByte(rangeStr, '=')
- if i == -1 || strings.Contains(rangeStr[i+1:], "=") {
- return rangeData, ErrRangeMalformed
- }
- rangeData.Type = rangeStr[:i]
- ranges = rangeStr[i+1:]
- var (
- singleRange string
- moreRanges = ranges
- )
- for moreRanges != "" {
- singleRange = moreRanges
- if i := strings.IndexByte(moreRanges, ','); i >= 0 {
- singleRange = moreRanges[:i]
- moreRanges = moreRanges[i+1:]
- } else {
- moreRanges = ""
- }
- var (
- startStr, endStr string
- i int
- )
- if i = strings.IndexByte(singleRange, '-'); i == -1 {
- return rangeData, ErrRangeMalformed
- }
- startStr = singleRange[:i]
- endStr = singleRange[i+1:]
- start, startErr := fasthttp.ParseUint(utils.UnsafeBytes(startStr))
- end, endErr := fasthttp.ParseUint(utils.UnsafeBytes(endStr))
- if startErr != nil { // -nnn
- start = size - end
- end = size - 1
- } else if endErr != nil { // nnn-
- end = size - 1
- }
- if end > size-1 { // limit last-byte-pos to current length
- end = size - 1
- }
- if start > end || start < 0 {
- continue
- }
- rangeData.Ranges = append(rangeData.Ranges, struct {
- Start int
- End int
- }{
- start,
- end,
- })
- }
- if len(rangeData.Ranges) < 1 {
- return rangeData, ErrRangeUnsatisfiable
- }
- return rangeData, nil
- }
- // Redirect to the URL derived from the specified path, with specified status.
- // If status is not specified, status defaults to 302 Found.
- func (c *Ctx) Redirect(location string, status ...int) error {
- c.setCanonical(HeaderLocation, location)
- if len(status) > 0 {
- c.Status(status[0])
- } else {
- c.Status(StatusFound)
- }
- return nil
- }
- // Bind Add vars to default view var map binding to template engine.
- // Variables are read by the Render method and may be overwritten.
- func (c *Ctx) Bind(vars Map) error {
- // init viewBindMap - lazy map
- for k, v := range vars {
- c.viewBindMap.Store(k, v)
- }
- return nil
- }
- // getLocationFromRoute get URL location from route using parameters
- func (c *Ctx) getLocationFromRoute(route Route, params Map) (string, error) {
- buf := bytebufferpool.Get()
- for _, segment := range route.routeParser.segs {
- if !segment.IsParam {
- _, err := buf.WriteString(segment.Const)
- if err != nil {
- return "", fmt.Errorf("failed to write string: %w", err)
- }
- continue
- }
- for key, val := range params {
- isSame := key == segment.ParamName || (!c.app.config.CaseSensitive && utils.EqualFold(key, segment.ParamName))
- isGreedy := segment.IsGreedy && len(key) == 1 && isInCharset(key[0], greedyParameters)
- if isSame || isGreedy {
- _, err := buf.WriteString(utils.ToString(val))
- if err != nil {
- return "", fmt.Errorf("failed to write string: %w", err)
- }
- }
- }
- }
- location := buf.String()
- // release buffer
- bytebufferpool.Put(buf)
- return location, nil
- }
- // GetRouteURL generates URLs to named routes, with parameters. URLs are relative, for example: "/user/1831"
- func (c *Ctx) GetRouteURL(routeName string, params Map) (string, error) {
- return c.getLocationFromRoute(c.App().GetRoute(routeName), params)
- }
- // RedirectToRoute to the Route registered in the app with appropriate parameters
- // If status is not specified, status defaults to 302 Found.
- // If you want to send queries to route, you must add "queries" key typed as map[string]string to params.
- func (c *Ctx) RedirectToRoute(routeName string, params Map, status ...int) error {
- location, err := c.getLocationFromRoute(c.App().GetRoute(routeName), params)
- if err != nil {
- return err
- }
- // Check queries
- if queries, ok := params["queries"].(map[string]string); ok {
- queryText := bytebufferpool.Get()
- defer bytebufferpool.Put(queryText)
- i := 1
- for k, v := range queries {
- _, _ = queryText.WriteString(k + "=" + v)
- if i != len(queries) {
- _, _ = queryText.WriteString("&")
- }
- i++
- }
- return c.Redirect(location+"?"+queryText.String(), status...)
- }
- return c.Redirect(location, status...)
- }
- // RedirectBack to the URL to referer
- // If status is not specified, status defaults to 302 Found.
- func (c *Ctx) RedirectBack(fallback string, status ...int) error {
- location := c.Get(HeaderReferer)
- if location == "" {
- location = fallback
- }
- return c.Redirect(location, status...)
- }
- // Render a template with data and sends a text/html response.
- // We support the following engines: html, amber, handlebars, mustache, pug
- func (c *Ctx) Render(name string, bind interface{}, layouts ...string) error {
- // Get new buffer from pool
- buf := bytebufferpool.Get()
- defer bytebufferpool.Put(buf)
- // Initialize empty bind map if bind is nil
- if bind == nil {
- bind = make(Map)
- }
- // Pass-locals-to-views, bind, appListKeys
- c.renderExtensions(bind)
- var rendered bool
- for i := len(c.app.mountFields.appListKeys) - 1; i >= 0; i-- {
- prefix := c.app.mountFields.appListKeys[i]
- app := c.app.mountFields.appList[prefix]
- if prefix == "" || strings.Contains(c.OriginalURL(), prefix) {
- if len(layouts) == 0 && app.config.ViewsLayout != "" {
- layouts = []string{
- app.config.ViewsLayout,
- }
- }
- // Render template from Views
- if app.config.Views != nil {
- if err := app.config.Views.Render(buf, name, bind, layouts...); err != nil {
- return fmt.Errorf("failed to render: %w", err)
- }
- rendered = true
- break
- }
- }
- }
- if !rendered {
- // Render raw template using 'name' as filepath if no engine is set
- var tmpl *template.Template
- if _, err := readContent(buf, name); err != nil {
- return err
- }
- // Parse template
- tmpl, err := template.New("").Parse(c.app.getString(buf.Bytes()))
- if err != nil {
- return fmt.Errorf("failed to parse: %w", err)
- }
- buf.Reset()
- // Render template
- if err := tmpl.Execute(buf, bind); err != nil {
- return fmt.Errorf("failed to execute: %w", err)
- }
- }
- // Set Content-Type to text/html
- c.fasthttp.Response.Header.SetContentType(MIMETextHTMLCharsetUTF8)
- // Set rendered template to body
- c.fasthttp.Response.SetBody(buf.Bytes())
- return nil
- }
- func (c *Ctx) renderExtensions(bind interface{}) {
- if bindMap, ok := bind.(Map); ok {
- // Bind view map
- c.viewBindMap.Range(func(key, value interface{}) bool {
- keyValue, ok := key.(string)
- if !ok {
- return true
- }
- if _, ok := bindMap[keyValue]; !ok {
- bindMap[keyValue] = value
- }
- return true
- })
- // Check if the PassLocalsToViews option is enabled (by default it is disabled)
- if c.app.config.PassLocalsToViews {
- // Loop through each local and set it in the map
- c.fasthttp.VisitUserValues(func(key []byte, val interface{}) {
- // check if bindMap doesn't contain the key
- if _, ok := bindMap[c.app.getString(key)]; !ok {
- // Set the key and value in the bindMap
- bindMap[c.app.getString(key)] = val
- }
- })
- }
- }
- if len(c.app.mountFields.appListKeys) == 0 {
- c.app.generateAppListKeys()
- }
- }
- // Route returns the matched Route struct.
- func (c *Ctx) Route() *Route {
- if c.route == nil {
- // Fallback for fasthttp error handler
- return &Route{
- path: c.pathOriginal,
- Path: c.pathOriginal,
- Method: c.method,
- Handlers: make([]Handler, 0),
- Params: make([]string, 0),
- }
- }
- return c.route
- }
- // SaveFile saves any multipart file to disk.
- func (*Ctx) SaveFile(fileheader *multipart.FileHeader, path string) error {
- return fasthttp.SaveMultipartFile(fileheader, path)
- }
- // SaveFileToStorage saves any multipart file to an external storage system.
- func (*Ctx) SaveFileToStorage(fileheader *multipart.FileHeader, path string, storage Storage) error {
- file, err := fileheader.Open()
- if err != nil {
- return fmt.Errorf("failed to open: %w", err)
- }
- content, err := io.ReadAll(file)
- if err != nil {
- return fmt.Errorf("failed to read: %w", err)
- }
- if err := storage.Set(path, content, 0); err != nil {
- return fmt.Errorf("failed to store: %w", err)
- }
- return nil
- }
- // Secure returns whether a secure connection was established.
- func (c *Ctx) Secure() bool {
- return c.Protocol() == schemeHTTPS
- }
- // Send sets the HTTP response body without copying it.
- // From this point onward the body argument must not be changed.
- func (c *Ctx) Send(body []byte) error {
- // Write response body
- c.fasthttp.Response.SetBodyRaw(body)
- return nil
- }
- var (
- sendFileOnce sync.Once
- sendFileFS *fasthttp.FS
- sendFileHandler fasthttp.RequestHandler
- )
- // SendFile transfers the file from the given path.
- // The file is not compressed by default, enable this by passing a 'true' argument
- // Sets the Content-Type response HTTP header field based on the filenames extension.
- func (c *Ctx) SendFile(file string, compress ...bool) error {
- // Save the filename, we will need it in the error message if the file isn't found
- filename := file
- // https://github.com/valyala/fasthttp/blob/c7576cc10cabfc9c993317a2d3f8355497bea156/fs.go#L129-L134
- sendFileOnce.Do(func() {
- const cacheDuration = 10 * time.Second
- sendFileFS = &fasthttp.FS{
- Root: "",
- AllowEmptyRoot: true,
- GenerateIndexPages: false,
- AcceptByteRange: true,
- Compress: true,
- CompressedFileSuffix: c.app.config.CompressedFileSuffix,
- CacheDuration: cacheDuration,
- IndexNames: []string{"index.html"},
- PathNotFound: func(ctx *fasthttp.RequestCtx) {
- ctx.Response.SetStatusCode(StatusNotFound)
- },
- }
- sendFileHandler = sendFileFS.NewRequestHandler()
- })
- // Keep original path for mutable params
- c.pathOriginal = utils.CopyString(c.pathOriginal)
- // Disable compression
- if len(compress) == 0 || !compress[0] {
- // https://github.com/valyala/fasthttp/blob/7cc6f4c513f9e0d3686142e0a1a5aa2f76b3194a/fs.go#L55
- c.fasthttp.Request.Header.Del(HeaderAcceptEncoding)
- }
- // copy of https://github.com/valyala/fasthttp/blob/7cc6f4c513f9e0d3686142e0a1a5aa2f76b3194a/fs.go#L103-L121 with small adjustments
- if len(file) == 0 || !filepath.IsAbs(file) {
- // extend relative path to absolute path
- hasTrailingSlash := len(file) > 0 && (file[len(file)-1] == '/' || file[len(file)-1] == '\\')
- var err error
- file = filepath.FromSlash(file)
- if file, err = filepath.Abs(file); err != nil {
- return fmt.Errorf("failed to determine abs file path: %w", err)
- }
- if hasTrailingSlash {
- file += "/"
- }
- }
- // convert the path to forward slashes regardless the OS in order to set the URI properly
- // the handler will convert back to OS path separator before opening the file
- file = filepath.ToSlash(file)
- // Restore the original requested URL
- originalURL := utils.CopyString(c.OriginalURL())
- defer c.fasthttp.Request.SetRequestURI(originalURL)
- // Set new URI for fileHandler
- c.fasthttp.Request.SetRequestURI(file)
- // Save status code
- status := c.fasthttp.Response.StatusCode()
- // Serve file
- sendFileHandler(c.fasthttp)
- // Get the status code which is set by fasthttp
- fsStatus := c.fasthttp.Response.StatusCode()
- // Set the status code set by the user if it is different from the fasthttp status code and 200
- if status != fsStatus && status != StatusOK {
- c.Status(status)
- }
- // Check for error
- if status != StatusNotFound && fsStatus == StatusNotFound {
- return NewError(StatusNotFound, fmt.Sprintf("sendfile: file %s not found", filename))
- }
- return nil
- }
- // SendStatus sets the HTTP status code and if the response body is empty,
- // it sets the correct status message in the body.
- func (c *Ctx) SendStatus(status int) error {
- c.Status(status)
- // Only set status body when there is no response body
- if len(c.fasthttp.Response.Body()) == 0 {
- return c.SendString(utils.StatusMessage(status))
- }
- return nil
- }
- // SendString sets the HTTP response body for string types.
- // This means no type assertion, recommended for faster performance
- func (c *Ctx) SendString(body string) error {
- c.fasthttp.Response.SetBodyString(body)
- return nil
- }
- // SendStream sets response body stream and optional body size.
- func (c *Ctx) SendStream(stream io.Reader, size ...int) error {
- if len(size) > 0 && size[0] >= 0 {
- c.fasthttp.Response.SetBodyStream(stream, size[0])
- } else {
- c.fasthttp.Response.SetBodyStream(stream, -1)
- }
- return nil
- }
- // Set sets the response's HTTP header field to the specified key, value.
- func (c *Ctx) Set(key, val string) {
- c.fasthttp.Response.Header.Set(key, val)
- }
- func (c *Ctx) setCanonical(key, val string) {
- c.fasthttp.Response.Header.SetCanonical(c.app.getBytes(key), c.app.getBytes(val))
- }
- // Subdomains returns a string slice of subdomains in the domain name of the request.
- // The subdomain offset, which defaults to 2, is used for determining the beginning of the subdomain segments.
- func (c *Ctx) Subdomains(offset ...int) []string {
- o := 2
- if len(offset) > 0 {
- o = offset[0]
- }
- subdomains := strings.Split(c.Hostname(), ".")
- l := len(subdomains) - o
- // Check index to avoid slice bounds out of range panic
- if l < 0 {
- l = len(subdomains)
- }
- subdomains = subdomains[:l]
- return subdomains
- }
- // Stale is not implemented yet, pull requests are welcome!
- func (c *Ctx) Stale() bool {
- return !c.Fresh()
- }
- // Status sets the HTTP status for the response.
- // This method is chainable.
- func (c *Ctx) Status(status int) *Ctx {
- c.fasthttp.Response.SetStatusCode(status)
- return c
- }
- // String returns unique string representation of the ctx.
- //
- // The returned value may be useful for logging.
- func (c *Ctx) String() string {
- // Get buffer from pool
- buf := bytebufferpool.Get()
- // Start with the ID, converting it to a hex string without fmt.Sprintf
- buf.WriteByte('#')
- // Convert ID to hexadecimal
- id := strconv.FormatUint(c.fasthttp.ID(), 16)
- // Pad with leading zeros to ensure 16 characters
- for i := 0; i < (16 - len(id)); i++ {
- buf.WriteByte('0')
- }
- buf.WriteString(id)
- buf.WriteString(" - ")
- // Add local and remote addresses directly
- buf.WriteString(c.fasthttp.LocalAddr().String())
- buf.WriteString(" <-> ")
- buf.WriteString(c.fasthttp.RemoteAddr().String())
- buf.WriteString(" - ")
- // Add method and URI
- buf.Write(c.fasthttp.Request.Header.Method())
- buf.WriteByte(' ')
- buf.Write(c.fasthttp.URI().FullURI())
- // Allocate string
- str := buf.String()
- // Reset buffer
- buf.Reset()
- bytebufferpool.Put(buf)
- return str
- }
- // Type sets the Content-Type HTTP header to the MIME type specified by the file extension.
- func (c *Ctx) Type(extension string, charset ...string) *Ctx {
- if len(charset) > 0 {
- c.fasthttp.Response.Header.SetContentType(utils.GetMIME(extension) + "; charset=" + charset[0])
- } else {
- c.fasthttp.Response.Header.SetContentType(utils.GetMIME(extension))
- }
- return c
- }
- // Vary adds the given header field to the Vary response header.
- // This will append the header, if not already listed, otherwise leaves it listed in the current location.
- func (c *Ctx) Vary(fields ...string) {
- c.Append(HeaderVary, fields...)
- }
- // Write appends p into response body.
- func (c *Ctx) Write(p []byte) (int, error) {
- c.fasthttp.Response.AppendBody(p)
- return len(p), nil
- }
- // Writef appends f & a into response body writer.
- func (c *Ctx) Writef(f string, a ...interface{}) (int, error) {
- //nolint:wrapcheck // This must not be wrapped
- return fmt.Fprintf(c.fasthttp.Response.BodyWriter(), f, a...)
- }
- // WriteString appends s to response body.
- func (c *Ctx) WriteString(s string) (int, error) {
- c.fasthttp.Response.AppendBodyString(s)
- return len(s), nil
- }
- // XHR returns a Boolean property, that is true, if the request's X-Requested-With header field is XMLHttpRequest,
- // indicating that the request was issued by a client library (such as jQuery).
- func (c *Ctx) XHR() bool {
- return utils.EqualFoldBytes(c.app.getBytes(c.Get(HeaderXRequestedWith)), []byte("xmlhttprequest"))
- }
- // configDependentPaths set paths for route recognition and prepared paths for the user,
- // here the features for caseSensitive, decoded paths, strict paths are evaluated
- func (c *Ctx) configDependentPaths() {
- c.pathBuffer = append(c.pathBuffer[0:0], c.pathOriginal...)
- // If UnescapePath enabled, we decode the path and save it for the framework user
- if c.app.config.UnescapePath {
- c.pathBuffer = fasthttp.AppendUnquotedArg(c.pathBuffer[:0], c.pathBuffer)
- }
- c.path = c.app.getString(c.pathBuffer)
- // another path is specified which is for routing recognition only
- // use the path that was changed by the previous configuration flags
- c.detectionPathBuffer = append(c.detectionPathBuffer[0:0], c.pathBuffer...)
- // If CaseSensitive is disabled, we lowercase the original path
- if !c.app.config.CaseSensitive {
- c.detectionPathBuffer = utils.ToLowerBytes(c.detectionPathBuffer)
- }
- // If StrictRouting is disabled, we strip all trailing slashes
- if !c.app.config.StrictRouting && len(c.detectionPathBuffer) > 1 && c.detectionPathBuffer[len(c.detectionPathBuffer)-1] == '/' {
- c.detectionPathBuffer = utils.TrimRightBytes(c.detectionPathBuffer, '/')
- }
- c.detectionPath = c.app.getString(c.detectionPathBuffer)
- // Define the path for dividing routes into areas for fast tree detection, so that fewer routes need to be traversed,
- // since the first three characters area select a list of routes
- c.treePath = c.treePath[0:0]
- const maxDetectionPaths = 3
- if len(c.detectionPath) >= maxDetectionPaths {
- c.treePath = c.detectionPath[:maxDetectionPaths]
- }
- }
- func (c *Ctx) IsProxyTrusted() bool {
- if !c.app.config.EnableTrustedProxyCheck {
- return true
- }
- ip := c.fasthttp.RemoteIP()
- if _, trusted := c.app.config.trustedProxiesMap[ip.String()]; trusted {
- return true
- }
- for _, ipNet := range c.app.config.trustedProxyRanges {
- if ipNet.Contains(ip) {
- return true
- }
- }
- return false
- }
- var localHosts = [...]string{"127.0.0.1", "::1"}
- // IsLocalHost will return true if address is a localhost address.
- func (*Ctx) isLocalHost(address string) bool {
- for _, h := range localHosts {
- if address == h {
- return true
- }
- }
- return false
- }
- // IsFromLocal will return true if request came from local.
- func (c *Ctx) IsFromLocal() bool {
- return c.isLocalHost(c.fasthttp.RemoteIP().String())
- }
- func (c *Ctx) getBody() []byte {
- if c.app.config.Immutable {
- return utils.CopyBytes(c.fasthttp.Request.Body())
- }
- return c.fasthttp.Request.Body()
- }
|