1 HTTP referrer

Gerasimos (Makis) Maropoulos edited this page 2020-06-11 04:16:35 +03:00

Table of Contents

• Example

The Referrer-Policy HTTP header controls how much referrer information (sent via the Referer header) should be included with requests.

Read more at developer.mozilla.org

---

Iris uses the Shopify's goreferrer package to expose the Context.GetReferrer() method.

The GetReferrer method extracts and returns the information from the "Referer" (or "Referrer") header and url query parameter as specified in https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy.

GetReferrer() Referrer

Which Referrer looks like that:

type (
    Referrer struct {
        Type       ReferrerType
        Label      string
        URL        string
        Subdomain  string
        Domain     string
        Tld        string         
        Path       string              
        Query      string                 
        GoogleType ReferrerGoogleSearchType
    }

The ReferrerType is the enum for a Referrer.Type value (indirect, direct, email, search, social). The available types are:

ReferrerInvalid
ReferrerIndirect
ReferrerDirect
ReferrerEmail
ReferrerSearch
ReferrerSocial

The GoogleType can be one of those:

ReferrerNotGoogleSearch
ReferrerGoogleOrganicSearch
ReferrerGoogleAdwords

Example

package main

import "github.com/kataras/iris/v12"

func main() {
    app := iris.New()

    app.Get("/", func(ctx iris.Context) {
        r := ctx.GetReferrer()
        switch r.Type {
        case iris.ReferrerSearch:
            ctx.Writef("Search %s: %s\n", r.Label, r.Query)
            ctx.Writef("Google: %s\n", r.GoogleType)
        case iris.ReferrerSocial:
            ctx.Writef("Social %s\n", r.Label)
        case iris.ReferrerIndirect:
            ctx.Writef("Indirect: %s\n", r.URL)
        }
    })

    app.Listen(":8080")
}

How to curl:

curl http://localhost:8080?\
referrer=https://twitter.com/Xinterio/status/1023566830974251008

curl http://localhost:8080?\
referrer=https://www.google.com/search?q=Top+6+golang+web+frameworks\
&oq=Top+6+golang+web+frameworks

• What is Iris
• 📌Getting Started
  • Installing Iris
  • Quick start
• Host
  • Automatic Public Domain with TLS
• Configuration
• Routing
  • Path Parameter Types
  • Reverse Lookups
  • Middleware
  • Handle HTTP errors
  • Subdomains
  • Wrap the Router
  • Override Context
  • Context Methods
• HTTP Method Override
• API Versioning
• Content Negotiation
• Response Recorder
• HTTP Referrer
• Request Authentication
• URL Query Parameters
• Forms
• Model Validation
• Cache
• View
• Cookies
• Sessions
  • Database
  • Flash Messages
• Websockets
• Dependency Injection
• MVC
• gRPC
• Sitemap
• Localization
• Testing

• 🤓Resources
  • Starter Kits
  • Publications
  • Benchmarks
  • Support
  • Examples

Home | Project | Quick Start | Technical Docs | Copyright © 2019-2020 Gerasimos Maropoulos. Documentation terms of use.