redirect_back

README

Redirect Back

A Golang HTTP Handler that redirect back to last URL saved in session

Usage

package main

import (
	"net/http"

	"github.com/ecletus/redirect_back"
	"github.com/ecletus/session/manager"
)

var RedirectBack = redirect_back.New(&redirect_back.Config{
	IgnoredPaths:      []string{"/login"},     // Will ignore requests that has those paths when set return path
	IgnoredPrefixes:   []string{"/auth"},      // Will ignore requests that has those prefixes when set return path
	AllowedExtensions: []string{"", ".html"}   // Only save requests w/o extension or extension `.html` (default setting)
	IgnoreFunc: func(req *http.Request) bool { // Will ignore request if `IgnoreFunc` returns true
		return false
	},
	SessionManager: manager.SessionManager,
	FallbackPath:   "/",
})

func main() {
	mux := http.NewServeMux()
	mux.HandleFunc("/", homeHandler)
	mux.HandleFunc("/page", pageHandler)

	// Wrap your application's handlers or router with redirect back's middleware
	http.ListenAndServe(":8000", manager.SessionManager.Middleware(RedirectBack.Middleware(mux)))
}

func homeHandler(w http.ResponseWriter, req *http.Request) {
	w.Write([]byte("home"))
}

func pageHandler(w http.ResponseWriter, req *http.Request) {
	// Redirect to return path or the default one
	RedirectBack.RedirectBack(w, req)
}

Documentation

Index

• Constants
• func ReturnToUrl(ctx *core.Context) string
• func Set(ctx *core.Context) error
• type Config
• type RedirectBack
  • func New(config *Config) *RedirectBack
  • func (redirectBack *RedirectBack) Middleware() *xroute.Middleware
  • func (redirectBack *RedirectBack) RedirectBack(w http.ResponseWriter, req *http.Request, fallback ...string)

Constants

const SessionKey = "redirect_to"

Functions

func ReturnToUrl

func ReturnToUrl(ctx *core.Context) string

func Set

func Set(ctx *core.Context) error

Types

type Config

type Config struct {
	FallbackPath      string
	IgnoredPaths      []string
	IgnoredPrefixes   []string
	AllowedExtensions []string
	IgnoreFunc        func(*http.Request) bool
}

Config redirect back config

type RedirectBack

type RedirectBack struct {
	Ignore     func(req *http.Request) bool
	IgnorePath func(pth string) bool
	// contains filtered or unexported fields
}

RedirectBack redirect back struct

func New

func New(config *Config) *RedirectBack

New initialize redirect back instance

func (*RedirectBack) Middleware

func (redirectBack *RedirectBack) Middleware() *xroute.Middleware

Middleware returns a RedirectBack middleware instance that record return_to path

func (*RedirectBack) RedirectBack

func (redirectBack *RedirectBack) RedirectBack(w http.ResponseWriter, req *http.Request, fallback ...string)

RedirectBack redirect back to last visited page