app.go

// Copyright 2017-present Kirill Danshin and Gramework contributors
// Copyright 2019-present Highload LTD (UK CN: 11893420)
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//

package gramework

import (
	"time"

	"github.com/microcosm-cc/bluemonday"
)

// SetName for the server
// Deprecated: Use New() with OptAppName option instead
func (app *App) SetName(name string) {
	if len(name) > 0 {
		app.name = name
	} else {
		app.name = DefaultAppName
	}
	app.serverBase.Name = app.name
}

// SetCookieExpire allows you set cookie expire time
func (app *App) SetCookieExpire(d time.Duration) {
	if d != 0 {
		app.cookieExpire = d
	}
}

// SetCookiePath allows you set cookie path
func (app *App) SetCookiePath(path string) {
	app.cookiePath = path
}

// SetCookieDomain allows you to implement SSO and other useful features
// without additional pain
func (app *App) SetCookieDomain(domain string) {
	app.cookieDomain = domain
}

// SetSanitizerPolicy updates app's sanitizer policy to a new one, if newPolicy is not nil
func (app *App) SetSanitizerPolicy(newPolicy *bluemonday.Policy) {
	if newPolicy != nil {
		app.sanitizerPolicy = newPolicy
	}
}

// ToTLSHandler returns handler that redirects user to HTTPS scheme
func (app *App) ToTLSHandler() func(*Context) {
	return func(ctx *Context) {
		ctx.ToTLS()
	}
}

// HTTP returns HTTP-only router
func (app *App) HTTP() *Router {
	return app.defaultRouter.HTTP()
}

// HTTPS returns HTTPS-only router
func (app *App) HTTPS() *Router {
	return app.defaultRouter.HTTPS()
}

// MethodNotAllowed sets MethodNotAllowed handler
func (app *App) MethodNotAllowed(c func(ctx *Context)) *App {
	app.defaultRouter.router.MethodNotAllowed = c
	return app
}

// Redir sends 301 redirect to the given url
//
// it's equivalent to
//
//     ctx.Redirect(url, 301)
func (app *App) Redir(url string) func(*Context) {
	return func(ctx *Context) {
		ctx.Redirect(url, redirectCode)
	}
}

// Forbidden send 403 Forbidden error
func (app *App) Forbidden(ctx *Context) {
	ctx.Forbidden()
}