oauth.go

package oauth

import (
	"github.com/iris-contrib/gothic"
	"github.com/kataras/iris"
	"github.com/markbates/goth"
)

// Plugin is a plugin which helps you to use OAuth/OAuth2 apis from famous websites
// See more at https://github.com/iris-contrib/gothic
type Plugin struct {
	Config          Config
	successHandlers []iris.HandlerFunc
	failHandler     iris.HandlerFunc
	station         *iris.Framework
}

// New returns a new OAuth plugin
// receives one parameter of type 'Config'
func New(cfg Config) *Plugin {
	c := DefaultConfig().MergeSingle(cfg)
	return &Plugin{Config: c}
}

// Success registers handler(s) which fires when the user logged in successfully
func (p *Plugin) Success(handlersFn ...iris.HandlerFunc) {
	p.successHandlers = append(p.successHandlers, handlersFn...)
}

// Fail registers handler which fires when the user failed to logged in
// underhood it justs registers an error handler to the StatusUnauthorized(400 status code), same as 'iris.OnError(400,handler)'
func (p *Plugin) Fail(handler iris.HandlerFunc) {
	p.failHandler = handler
}

// User returns the user for the particular client
// if user is not validated  or not found it returns nil
// same as 'ctx.Get(config's ContextKey field).(goth.User)'
func (p *Plugin) User(ctx *iris.Context) (u goth.User) {
	return ctx.Get(p.Config.ContextKey).(goth.User)
}

// URL returns the full URL of a provider
// Use this method to get the url which you will render on your html page to create a link for user authentication
//
// same as `iris.URL(config's RouteName field, "theprovidername")`
// notes:
// If you use the Iris' view system then you can use the {{url }} func inside your template directly:
// {{ url config's RouteName field, "theprovidername"}} |  example: {{url "oauth" "facebook"}}, "oauth" is ,also, the route's name , so this will give the http(s)://yourhost:port/oauth/facebook
func (p *Plugin) URL(providerName string) string {
	return p.station.URL(p.Config.RouteName, providerName)
}

// PreBuild plugin in order to register the oauth route
func (p *Plugin) PreBuild(s *iris.Framework) {

	oauthProviders := p.Config.GenerateProviders(s.Config.VScheme + s.Config.VHost)
	if len(oauthProviders) > 0 {
		goth.UseProviders(oauthProviders...)
		// set the mux path to handle the registered providers
		s.Get(p.Config.Path+"/:provider", func(ctx *iris.Context) {
			err := gothic.BeginAuthHandler(ctx)
			if err != nil {
				s.Logger.Println("\n[IRIS OAUTH PLUGIN] Error:" + err.Error())
			}
		})(p.Config.RouteName)
		//println("registered " + p.Config.Path + "/:provider")

		authMiddleware := func(ctx *iris.Context) {
			user, err := gothic.CompleteUserAuth(ctx)
			if err != nil {
				ctx.EmitError(iris.StatusUnauthorized)
				ctx.Log(err.Error())
				return
			}
			ctx.Set(p.Config.ContextKey, user)
			ctx.Next()
		}

		p.successHandlers = append([]iris.HandlerFunc{authMiddleware}, p.successHandlers...)

		s.Get(p.Config.Path+"/:provider/callback", p.successHandlers...)
		p.station = s
		// register the error handler
		if p.failHandler != nil {
			s.OnError(iris.StatusUnauthorized, p.failHandler)
		}
	}
}