revel

package module
v0.0.0-...-2d8c93c Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 19, 2013 License: MIT Imports: 35 Imported by: 0

README

Revel

This is a port of the amazing Play! framework to the Go language.

It is a high productivity web framework.

Check out the web site.

Build Status

Documentation

Index

Constants

View Source 
const (
	DEFAULT_DATE_FORMAT     = "2006-01-02"
	DEFAULT_DATETIME_FORMAT = "2006-01-02 15:04"
)
View Source 
const (
	CurrentLocaleRenderArg = "currentLocale" // The key for the current locale render arg value

)
View Source 
const DefaultFileContentType = "application/octet-stream"
View Source 
const (
	REVEL_IMPORT_PATH = "github.com/robfig/revel"
)
View Source 
const (
	SESSION_ID_KEY = "_ID"
)

Variables

View Source 
var (
	// These are the lookups to find a Binder for any type of data.
	// The most specific binder found will be used (Type before Kind)
	TypeBinders = make(map[reflect.Type]Binder)
	KindBinders = make(map[reflect.Kind]Binder)

	// Applications can add custom time formats to this array, and they will be
	// automatically attempted when binding a time.Time.
	TimeFormats = []string{}

	DateFormat     string
	DateTimeFormat string

	IntBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			if len(val) == 0 {
				return reflect.Zero(typ)
			}
			intValue, err := strconv.ParseInt(val, 10, 64)
			if err != nil {
				WARN.Println(err)
				return reflect.Zero(typ)
			}
			pValue := reflect.New(typ)
			pValue.Elem().SetInt(intValue)
			return pValue.Elem()
		}),
		Unbind: func(output map[string]string, key string, val interface{}) {
			output[key] = fmt.Sprintf("%d", val)
		},
	}

	UintBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			if len(val) == 0 {
				return reflect.Zero(typ)
			}
			uintValue, err := strconv.ParseUint(val, 10, 64)
			if err != nil {
				WARN.Println(err)
				return reflect.Zero(typ)
			}
			pValue := reflect.New(typ)
			pValue.Elem().SetUint(uintValue)
			return pValue.Elem()
		}),
		Unbind: func(output map[string]string, key string, val interface{}) {
			output[key] = fmt.Sprintf("%d", val)
		},
	}

	FloatBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			if len(val) == 0 {
				return reflect.Zero(typ)
			}
			floatValue, err := strconv.ParseFloat(val, 64)
			if err != nil {
				WARN.Println(err)
				return reflect.Zero(typ)
			}
			pValue := reflect.New(typ)
			pValue.Elem().SetFloat(floatValue)
			return pValue.Elem()
		}),
		Unbind: func(output map[string]string, key string, val interface{}) {
			output[key] = fmt.Sprintf("%f", val)
		},
	}

	StringBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			return reflect.ValueOf(val)
		}),
		Unbind: func(output map[string]string, name string, val interface{}) {
			output[name] = val.(string)
		},
	}

	// Booleans support a couple different value formats:
	// "true" and "false"
	// "on" and "" (a checkbox)
	// "1" and "0" (why not)
	BoolBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			v := strings.TrimSpace(strings.ToLower(val))
			switch v {
			case "true", "on", "1":
				return reflect.ValueOf(true)
			}

			return reflect.ValueOf(false)
		}),
		Unbind: func(output map[string]string, name string, val interface{}) {
			output[name] = fmt.Sprintf("%t", val)
		},
	}

	PointerBinder = Binder{
		Bind: func(params *Params, name string, typ reflect.Type) reflect.Value {
			return Bind(params, name, typ.Elem()).Addr()
		},
		Unbind: func(output map[string]string, name string, val interface{}) {
			Unbind(output, name, reflect.ValueOf(val).Elem().Interface())
		},
	}

	TimeBinder = Binder{
		Bind: ValueBinder(func(val string, typ reflect.Type) reflect.Value {
			for _, f := range TimeFormats {
				if r, err := time.Parse(f, val); err == nil {
					return reflect.ValueOf(r)
				}
			}
			return reflect.Zero(typ)
		}),
		Unbind: func(output map[string]string, name string, val interface{}) {
			var (
				t       = val.(time.Time)
				format  = DateTimeFormat
				h, m, s = t.Clock()
			)
			if h == 0 && m == 0 && s == 0 {
				format = DateFormat
			}
			output[name] = t.Format(format)
		},
	}
)
View Source 
var (
	// App details
	AppName    string // e.g. "sample"
	BasePath   string // e.g. "/Users/robfig/gocode/src/corp/sample"
	AppPath    string // e.g. "/Users/robfig/gocode/src/corp/sample/app"
	ViewsPath  string // e.g. "/Users/robfig/gocode/src/corp/sample/app/views"
	ImportPath string // e.g. "corp/sample"
	SourcePath string // e.g. "/Users/robfig/gocode/src"

	Config  *MergedConfig
	RunMode string // Application-defined (by default, "dev" or "prod")
	DevMode bool   // if true, RunMode is a development mode.

	// Revel installation details
	RevelPath string // e.g. "/Users/robfig/gocode/src/revel"

	// Where to look for templates and configuration.
	// Ordered by priority.  (Earlier paths take precedence over later paths.)
	CodePaths     []string
	ConfPaths     []string
	TemplatePaths []string

	Modules []Module

	// Server config.
	//
	// Alert: This is how the app is configured, which may be different from
	// the current process reality.  For example, if the app is configured for
	// port 9000, HttpPort will always be 9000, even though in dev mode it is
	// run on a random port and proxied.
	HttpPort int    // e.g. 9000
	HttpAddr string // e.g. "", "127.0.0.1"

	// All cookies dropped by the framework begin with this prefix.
	CookiePrefix string

	// Loggers
	DEFAULT = log.New(ioutil.Discard, "", log.Ldate|log.Ltime|log.Lshortfile)
	TRACE   = DEFAULT
	INFO    = DEFAULT
	WARN    = DEFAULT
	ERROR   = DEFAULT

	Initialized bool
)
View Source 
var (
	MainRouter         *Router
	MainTemplateLoader *TemplateLoader
	MainWatcher        *Watcher
	Server             *http.Server
)
View Source 
var DefaultValidationKeys map[string]map[int]string

Register default validation keys for all calls to Controller.Validation.Func(). Map from (package).func => (line => name of first arg to Validation func) E.g. "myapp/controllers.helper" or "myapp/controllers.(*Application).Action" This is set on initialization in the generated main.go file.

View Source 
var ERROR_CLASS = "hasError"
View Source 
var (
	// The functions available for use in the templates.
	TemplateFuncs = map[string]interface{}{
		"url": ReverseUrl,
		"eq":  Equal,
		"set": func(renderArgs map[string]interface{}, key string, value interface{}) template.HTML {
			renderArgs[key] = value
			return template.HTML("")
		},
		"append": func(renderArgs map[string]interface{}, key string, value interface{}) template.HTML {
			if renderArgs[key] == nil {
				renderArgs[key] = []interface{}{value}
			} else {
				renderArgs[key] = append(renderArgs[key].([]interface{}), value)
			}
			return template.HTML("")
		},
		"field": NewField,
		"option": func(f *Field, val, label string) template.HTML {
			selected := ""
			if f.Flash() == val {
				selected = " selected"
			}
			return template.HTML(fmt.Sprintf(`<option value="%s"%s>%s</option>`,
				html.EscapeString(val), selected, html.EscapeString(label)))
		},
		"radio": func(f *Field, val string) template.HTML {
			checked := ""
			if f.Flash() == val {
				checked = " checked"
			}
			return template.HTML(fmt.Sprintf(`<input type="radio" name="%s" value="%s"%s>`,
				html.EscapeString(f.Name), html.EscapeString(val), checked))
		},
		"checkbox": func(f *Field, val string) template.HTML {
			checked := ""
			if f.Flash() == val {
				checked = " checked"
			}
			return template.HTML(fmt.Sprintf(`<input type="checkbox" name="%s" value="%s"%s>`,
				html.EscapeString(f.Name), html.EscapeString(val), checked))
		},

		"pad": func(str string, width int) template.HTML {
			if len(str) >= width {
				return template.HTML(html.EscapeString(str))
			}
			return template.HTML(html.EscapeString(str) + strings.Repeat("&nbsp;", width-len(str)))
		},

		"errorClass": func(name string, renderArgs map[string]interface{}) template.HTML {
			errorMap, ok := renderArgs["errors"].(map[string]*ValidationError)
			if !ok {
				WARN.Println("Called 'errorClass' without 'errors' in the render args.")
				return template.HTML("")
			}
			valError, ok := errorMap[name]
			if !ok || valError == nil {
				return template.HTML("")
			}
			return template.HTML(ERROR_CLASS)
		},

		"msg": func(renderArgs map[string]interface{}, message string, args ...interface{}) template.HTML {
			return template.HTML(Message(renderArgs[CurrentLocaleRenderArg].(string), message, args...))
		},

		"nl2br": func(text string) template.HTML {
			return template.HTML(strings.Replace(template.HTMLEscapeString(text), "\n", "<br>", -1))
		},

		"raw": func(text string) template.HTML {
			return template.HTML(text)
		},

		"pluralize": func(items interface{}, pluralOverrides ...string) string {
			singular, plural := "", "s"
			if len(pluralOverrides) >= 1 {
				singular = pluralOverrides[0]
				if len(pluralOverrides) == 2 {
					plural = pluralOverrides[1]
				}
			}

			switch v := reflect.ValueOf(items); v.Kind() {
			case reflect.Int:
				if items.(int) != 1 {
					return plural
				}
			case reflect.Slice:
				if v.Len() != 1 {
					return plural
				}
			default:
				ERROR.Println("pluralize: unexpected type: ", v)
			}
			return singular
		},

		"date": func(date time.Time) string {
			return date.Format(DateFormat)
		},
		"datetime": func(date time.Time) string {
			return date.Format(DateTimeFormat)
		},
	}
)
View Source 
var TestSuites []interface{} // Array of structs that embed TestSuite

Functions

func Bind 

func Bind(params *Params, name string, typ reflect.Type) reflect.Value

Bind takes the name and type of the desired parameter and constructs it from one or more values from Params. Returns the zero value of the type upon any sort of failure.

func BindFile 

func BindFile(fileHeader *multipart.FileHeader, typ reflect.Type) reflect.Value

func BindValue 

func BindValue(val string, typ reflect.Type) reflect.Value

func CheckInit 

func CheckInit()

func ContainsString 

func ContainsString(list []string, target string) bool

func ContentTypeByFilename 

func ContentTypeByFilename(filename string) string

Returns a MIME content type based on the filename's extension. If no appropriate one is found, returns "application/octet-stream" by default. Additionally, specifies the charset as UTF-8 for text/* types.

func DirExists 

func DirExists(filename string) bool

DirExists returns true if the given path exists and is a directory.

func Equal 

func Equal(a, b interface{}) bool

Equal is a helper for comparing value equality, following these rules:

  • Values with equivalent types are compared with reflect.DeepEqual
  • int, uint, and float values are compared without regard to the type width. for example, Equal(int32(5), int64(5)) == true
  • strings and byte slices are converted to strings before comparison.
  • else, return false.

func ExecuteTemplate 

func ExecuteTemplate(tmpl ExecutableTemplate, data interface{}) string

Execute a template and returns the result as a string.

func FindMethod 

func FindMethod(recvType reflect.Type, funcVal reflect.Value) *reflect.Method

Return the reflect.Method, given a Receiver type and Func value.

func FirstNonEmpty 

func FirstNonEmpty(strs ...string) string

func Init 

func Init(mode, importPath, srcPath string)

Init initializes Revel -- it provides paths for getting around the app.

Params: 

mode - the run mode, which determines which app.conf settings are used.
importPath - the Go import path of the application.
srcPath - the path to the source directory, containing Revel and the app.
  If not specified (""), then a functioning Go installation is required.

func InterceptFunc 

func InterceptFunc(intc InterceptorFunc, when InterceptTime, target interface{})

Install a general interceptor. This can be applied to any Controller. It must have the signature of: 

func example(c *revel.Controller) revel.Result

func InterceptMethod 

func InterceptMethod(intc InterceptorMethod, when InterceptTime)

Install an interceptor method that applies to its own Controller. 

func (c AppController) example() revel.Result
func (c *AppController) example() revel.Result

func LoadMimeConfig 

func LoadMimeConfig()

Load mime-types.conf on init.

func Message 

func Message(locale, message string, args ...interface{}) string

Perform a message look-up for the given locale and message using the given arguments.

When either an unknown locale or message is detected, a specially formatted string is returned.

func MessageLanguages 

func MessageLanguages() []string

Return all currently loaded message languages.

func MustReadLines 

func MustReadLines(filename string) []string

Reads the lines of the given file. Panics in the case of error.

func NotFound 

func NotFound(req *Request, resp *Response, msg string)

This function is useful if there is no relevant Controller available. It writes the 404 response immediately.

func OnAppStart 

func OnAppStart(f func())

A simple hook to run code on startup without having to implement a plugin.

func ParseKeyValueCookie 

func ParseKeyValueCookie(val string, cb func(key, val string))

Takes the raw (escaped) cookie value and parses out key values.

func ReadLines 

func ReadLines(filename string) ([]string, error)

Reads the lines of the given file. Panics in the case of error.

func RegisterController 

func RegisterController(c interface{}, methods []*MethodType)

Register a Controller and its Methods with Revel.

func RegisterPlugin 

func RegisterPlugin(p Plugin)

func RenderError 

func RenderError(req *Request, resp *Response, err error)

func ResolveContentType 

func ResolveContentType(req *http.Request) string

Get the content type. e.g. From "multipart/form-data; boundary=--" to "multipart/form-data" If none is specified, returns "text/html" by default.

func ResolveFormat 

func ResolveFormat(req *http.Request) string

Resolve the accept request header.

func ReverseUrl 

func ReverseUrl(args ...interface{}) (string, error)

Return a url capable of invoking a given controller method: "Application.ShowApp 123" => "/app/123"

func Run 

func Run(port int)

Run the server. This is called from the generated main file. If port is non-zero, use that. Else, read the port from app.conf.

func Sign 

func Sign(message string) string

Sign a given string with the app-configured secret key. If no secret key is set, returns the empty string. Return the signature in base64 (URLEncoding).

func Unbind 

func Unbind(output map[string]string, name string, val interface{})

func ValueBinder 

func ValueBinder(f func(value string, typ reflect.Type) reflect.Value) func(*Params, string, reflect.Type) reflect.Value

An adapter for easily making one-key-value binders.

Types

type AcceptLanguage 

type AcceptLanguage struct {
	Language string
	Quality  float32
}

A single language from the Accept-Language HTTP header.

type AcceptLanguages 

type AcceptLanguages []AcceptLanguage

A collection of sortable AcceptLanguage instances.

func ResolveAcceptLanguage 

func ResolveAcceptLanguage(req *http.Request) AcceptLanguages

Resolve the Accept-Language header value.

The results are sorted using the quality defined in the header for each language range with the most qualified language range as the first element in the slice.

See the HTTP header fields specification (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4) for more details.

func (AcceptLanguages) Len 

func (al AcceptLanguages) Len() int

func (AcceptLanguages) Less 

func (al AcceptLanguages) Less(i, j int) bool

func (AcceptLanguages) String 

func (al AcceptLanguages) String() string

func (AcceptLanguages) Swap 

func (al AcceptLanguages) Swap(i, j int)

type ActionDefinition 

type ActionDefinition struct {
	Host, Method, Url, Action string
	Star                      bool
	Args                      map[string]string
}

func (*ActionDefinition) String 

func (a *ActionDefinition) String() string

type Auditor 

type Auditor interface {
	OnRefresh(listener Listener)
}

Auditor gets notified each time a listener gets refreshed.

type BinaryResult 

type BinaryResult struct {
	Reader   io.Reader
	Name     string
	Length   int64
	Delivery ContentDisposition
	ModTime  time.Time
}

func (*BinaryResult) Apply 

func (r *BinaryResult) Apply(req *Request, resp *Response)

type Binder 

type Binder struct {
	// Bind takes the name and type of the desired parameter and constructs it
	// from one or more values from Params.
	//
	// Example
	//
	//   Request:
	//   url?id=123&ol[0]=1&ol[1]=2&ul[]=str&ul[]=array&user.Name=rob
	//
	//   Action:
	//   Example.Action(id int, ol []int, ul []string, user User)
	//
	//   Calls:
	//   Bind(params, "id", int): 123
	//   Bind(params, "ol", []int): {1, 2}
	//   Bind(params, "ul", []string): {"str", "array"}
	//   Bind(params, "user", User): User{Name:"rob"}
	//
	// Note that only exported struct fields may be bound.
	Bind func(params *Params, name string, typ reflect.Type) reflect.Value

	// Unbind serializes a given value to one or more URL parameters of the given
	// name.
	Unbind func(output map[string]string, name string, val interface{})
}

A Binder translates between string parameters and Go data structures.

type ContentDisposition 

type ContentDisposition string
var (
	Attachment ContentDisposition = "attachment"
	Inline     ContentDisposition = "inline"
)

type Controller 

type Controller struct {
	Name          string          // The controller name, e.g. "Application"
	Type          *ControllerType // A description of the controller type.
	MethodType    *MethodType     // A description of the invoked action type.
	AppController interface{}     // The controller that was instantiated.
	Action        string          // The full action name, e.g. "Application.Index"

	Request  *Request
	Response *Response
	Result   Result

	Flash      Flash                  // User cookie, cleared after 1 request.
	Session    Session                // Session, stored in cookie, signed.
	Params     *Params                // Parameters from URL and form (including multipart).
	Args       map[string]interface{} // Per-request scratch space.
	RenderArgs map[string]interface{} // Args passed to the template.
	Validation *Validation            // Data validation helpers
	Txn        *sql.Tx                // Nil by default, but may be used by the app / plugins
}

func NewAppController 

func NewAppController(req *Request, resp *Response, controllerName, methodName string) (*Controller, reflect.Value)

func NewController 

func NewController(req *Request, resp *Response, ct *ControllerType) *Controller

func (*Controller) FlashParams 

func (c *Controller) FlashParams()

func (*Controller) Forbidden 

func (c *Controller) Forbidden(msg string, objs ...interface{}) Result

func (*Controller) Invoke 

func (c *Controller) Invoke(appControllerPtr reflect.Value, method reflect.Value, methodArgs []reflect.Value)

Invoke the given method, save headers/cookies to the response, and apply the result. (e.g. render a template to the response)

func (*Controller) Message 

func (c *Controller) Message(message string, args ...interface{}) (value string)

Perform a message lookup for the given message name using the given arguments using the current language defined for this controller.

The current language is set by the i18n plugin.

func (*Controller) NotFound 

func (c *Controller) NotFound(msg string, objs ...interface{}) Result

func (*Controller) Redirect 

func (c *Controller) Redirect(val interface{}, args ...interface{}) Result

Redirect to an action or to a URL. 

c.Redirect(Controller.Action)
c.Redirect("/controller/action")
c.Redirect("/controller/%d/action", id)

func (*Controller) Render 

func (c *Controller) Render(extraRenderArgs ...interface{}) Result

Render a template corresponding to the calling Controller method. Arguments will be added to c.RenderArgs prior to rendering the template. They are keyed on their local identifier.

For example: 

func (c Users) ShowUser(id int) revel.Result {
	 user := loadUser(id)
	 return c.Render(user)
}

This action will render views/Users/ShowUser.html, passing in an extra key-value "user": (User).

func (*Controller) RenderError 

func (c *Controller) RenderError(err error) Result

func (*Controller) RenderFile 

func (c *Controller) RenderFile(file *os.File, delivery ContentDisposition) Result

Return a file, either displayed inline or downloaded as an attachment. The name and size are taken from the file info.

func (*Controller) RenderJson 

func (c *Controller) RenderJson(o interface{}) Result

Uses encoding/json.Marshal to return JSON to the client.

func (*Controller) RenderTemplate 

func (c *Controller) RenderTemplate(templatePath string) Result

A less magical way to render a template. Renders the given template, using the current RenderArgs.

func (*Controller) RenderText 

func (c *Controller) RenderText(text string, objs ...interface{}) Result

Render plaintext in response, printf style.

func (*Controller) RenderXml 

func (c *Controller) RenderXml(o interface{}) Result

Uses encoding/xml.Marshal to return XML to the client.

func (*Controller) SetCookie 

func (c *Controller) SetCookie(cookie *http.Cookie)

func (*Controller) Todo 

func (c *Controller) Todo() Result

Render a "todo" indicating that the action isn't done yet.

type ControllerType 

type ControllerType struct {
	Type    reflect.Type
	Methods []*MethodType
}

func LookupControllerType 

func LookupControllerType(name string) *ControllerType

func (*ControllerType) Method 

func (ct *ControllerType) Method(name string) *MethodType

Searches for a given exported method (case insensitive)

type DiscerningListener 

type DiscerningListener interface {
	Listener
	WatchDir(info os.FileInfo) bool
	WatchFile(basename string) bool
}

DiscerningListener allows the receiver to selectively watch files.

type Email 

type Email struct {
	Match
}

func (Email) DefaultMessage 

func (e Email) DefaultMessage() string

type EmptyPlugin 

type EmptyPlugin struct{}

It provides default (empty) implementations for all the required methods.

func (EmptyPlugin) AfterRequest 

func (p EmptyPlugin) AfterRequest(c *Controller)

func (EmptyPlugin) BeforeRequest 

func (p EmptyPlugin) BeforeRequest(c *Controller)

func (EmptyPlugin) Finally 

func (p EmptyPlugin) Finally(c *Controller)

func (EmptyPlugin) OnAppStart 

func (p EmptyPlugin) OnAppStart()

func (EmptyPlugin) OnException 

func (p EmptyPlugin) OnException(c *Controller, err interface{})

func (EmptyPlugin) OnRoutesLoaded 

func (p EmptyPlugin) OnRoutesLoaded(router *Router)

type Error 

type Error struct {
	SourceType               string   // The type of source that failed to build.
	Title, Path, Description string   // Description of the error, as presented to the user.
	Line, Column             int      // Where the error was encountered.
	SourceLines              []string // The entire source file, split into lines.
	Stack                    string   // The raw stack trace string from debug.Stack().
	MetaError                string   // Error that occurred producing the error page.
}

An error description, used as an argument to the error template.

func NewErrorFromPanic 

func NewErrorFromPanic(err interface{}) *Error

Find the deepest stack from in uesr code and provide a code listing of that, on the line that eventually triggered the panic. Returns nil if no relevant stack frame can be found.

func (*Error) ContextSource 

func (e *Error) ContextSource() []sourceLine

Returns a snippet of the source around where the error occurred.

func (*Error) Error 

func (e *Error) Error() string

Construct a plaintext version of the error, taking account that fields are optionally set. Returns e.g. Compilation Error (in views/header.html:51): expected right delim in end; got "}"

type ErrorResult 

type ErrorResult struct {
	RenderArgs map[string]interface{}
	Error      error
}

This result handles all kinds of error codes (500, 404, ..). It renders the relevant error page (errors/CODE.format, e.g. errors/500.json). If RunMode is "dev", this results in a friendly error page.

func (ErrorResult) Apply 

func (r ErrorResult) Apply(req *Request, resp *Response)

type ExecutableTemplate 

type ExecutableTemplate interface {
	Execute(io.Writer, interface{}) error
}

Add some more methods to the default Template.

type Field 

type Field struct {
	Name  string
	Error *ValidationError
	// contains filtered or unexported fields
}

Field represents a data fieid that may be collected in a web form.

func NewField 

func NewField(name string, renderArgs map[string]interface{}) *Field

func (*Field) ErrorClass 

func (f *Field) ErrorClass() string

Return ERROR_CLASS if this field has a validation error, else empty string.

func (*Field) Flash 

func (f *Field) Flash() string

Returned the flashed value of this field.

func (*Field) FlashArray 

func (f *Field) FlashArray() []string

Returned the flashed value of this field as a list.

func (*Field) Id 

func (f *Field) Id() string

Returns an identifier suitable for use as an HTML id.

func (*Field) Value 

func (f *Field) Value() interface{}

Return the current value of this field.

type Flash 

type Flash struct {
	Data, Out map[string]string
}

Flash represents a cookie that gets overwritten on each request. It allows data to be stored across one page at a time. This is commonly used to implement success or error messages. e.g. the Post/Redirect/Get pattern: http://en.wikipedia.org/wiki/Post/Redirect/Get

func (Flash) Error 

func (f Flash) Error(msg string, args ...interface{})

func (Flash) Success 

func (f Flash) Success(msg string, args ...interface{})

type FlashPlugin 

type FlashPlugin struct{ EmptyPlugin }

func (FlashPlugin) AfterRequest 

func (p FlashPlugin) AfterRequest(c *Controller)

func (FlashPlugin) BeforeRequest 

func (p FlashPlugin) BeforeRequest(c *Controller)

type GoTemplate 

type GoTemplate struct {
	*template.Template
	// contains filtered or unexported fields
}

Adapter for Go Templates.

func (GoTemplate) Content 

func (gotmpl GoTemplate) Content() []string

func (GoTemplate) Render 

func (gotmpl GoTemplate) Render(wr io.Writer, arg interface{}) error

return a 'revel.Template' from Go's template.

type I18nPlugin 

type I18nPlugin struct {
	EmptyPlugin
}

func (I18nPlugin) BeforeRequest 

func (p I18nPlugin) BeforeRequest(c *Controller)

func (I18nPlugin) OnAppStart 

func (p I18nPlugin) OnAppStart()

type InterceptTarget 

type InterceptTarget int
const (
	ALL_CONTROLLERS InterceptTarget = iota
)

type InterceptTime 

type InterceptTime int
const (
	BEFORE InterceptTime = iota
	AFTER
	PANIC
	FINALLY
)

type Interception 

type Interception struct {
	When InterceptTime
	// contains filtered or unexported fields
}

func (Interception) Invoke 

func (i Interception) Invoke(val reflect.Value) reflect.Value

Perform the given interception. val is a pointer to the App Controller.

type InterceptorFunc 

type InterceptorFunc func(*Controller) Result

An "interceptor" is functionality invoked by the framework BEFORE or AFTER an action.

An interceptor may optionally return a Result (instead of nil). Depending on when the interceptor was invoked, the response is different: 1. BEFORE: No further interceptors are invoked, and neither is the action. 2. AFTER: Further interceptors are still run. In all cases, any returned Result will take the place of any existing Result.

In the BEFORE case, that returned Result is guaranteed to be final, while in the AFTER case it is possible that a further interceptor could emit its own Result.

Interceptors are called in the order that they are added.

***

Two types of interceptors are provided: Funcs and Methods

Func Interceptors may apply to any / all Controllers. 

func example(*revel.Controller) revel.Result

Method Interceptors are provided so that properties can be set on application controllers. 

func (c AppController) example() revel.Result
func (c *AppController) example() revel.Result

type InterceptorMethod 

type InterceptorMethod interface{}

type InterceptorPlugin 

type InterceptorPlugin struct {
	EmptyPlugin
}

func (InterceptorPlugin) AfterRequest 

func (p InterceptorPlugin) AfterRequest(c *Controller)

func (InterceptorPlugin) BeforeRequest 

func (p InterceptorPlugin) BeforeRequest(c *Controller)

func (InterceptorPlugin) Finally 

func (p InterceptorPlugin) Finally(c *Controller)

func (InterceptorPlugin) OnException 

func (p InterceptorPlugin) OnException(c *Controller, err interface{})

type Length 

type Length struct {
	N int
}

Requires an array or string to be exactly a given length.

func (Length) DefaultMessage 

func (s Length) DefaultMessage() string

func (Length) IsSatisfied 

func (s Length) IsSatisfied(obj interface{}) bool

type Listener 

type Listener interface {
	// Refresh is invoked by the watcher on relevant filesystem events.
	// If the listener returns an error, it is served to the user on the current request.
	Refresh() *Error
}

Listener is an interface for receivers of filesystem events.

type Match 

type Match struct {
	Regexp *regexp.Regexp
}

Requires a string to match a given regex.

func (Match) DefaultMessage 

func (m Match) DefaultMessage() string

func (Match) IsSatisfied 

func (m Match) IsSatisfied(obj interface{}) bool

type Max 

type Max struct {
	Max int
}

func (Max) DefaultMessage 

func (m Max) DefaultMessage() string

func (Max) IsSatisfied 

func (m Max) IsSatisfied(obj interface{}) bool

type MaxSize 

type MaxSize struct {
	Max int
}

Requires an array or string to be at most a given length.

func (MaxSize) DefaultMessage 

func (m MaxSize) DefaultMessage() string

func (MaxSize) IsSatisfied 

func (m MaxSize) IsSatisfied(obj interface{}) bool

type MergedConfig 

type MergedConfig struct {
	// contains filtered or unexported fields
}

This handles the parsing of app.conf It has a "preferred" section that is checked first for option queries. If the preferred section does not have the option, the DEFAULT section is checked fallback.

func LoadConfig 

func LoadConfig(confName string) (*MergedConfig, error)

func (*MergedConfig) Bool 

func (c *MergedConfig) Bool(option string) (result, found bool)

func (*MergedConfig) BoolDefault 

func (c *MergedConfig) BoolDefault(option string, dfault bool) bool

func (*MergedConfig) HasSection 

func (c *MergedConfig) HasSection(section string) bool

func (*MergedConfig) Int 

func (c *MergedConfig) Int(option string) (result int, found bool)

func (*MergedConfig) IntDefault 

func (c *MergedConfig) IntDefault(option string, dfault int) int

func (*MergedConfig) Options 

func (c *MergedConfig) Options(prefix string) []string

Options returns all configuration option keys. If a prefix is provided, then that is applied as a filter.

func (*MergedConfig) SetOption 

func (c *MergedConfig) SetOption(name, value string)

func (*MergedConfig) SetSection 

func (c *MergedConfig) SetSection(section string)

func (*MergedConfig) String 

func (c *MergedConfig) String(option string) (result string, found bool)

func (*MergedConfig) StringDefault 

func (c *MergedConfig) StringDefault(option, dfault string) string

type MethodArg 

type MethodArg struct {
	Name string
	Type reflect.Type
}

type MethodType 

type MethodType struct {
	Name           string
	Args           []*MethodArg
	RenderArgNames map[int][]string
	// contains filtered or unexported fields
}

type Min 

type Min struct {
	Min int
}

func (Min) DefaultMessage 

func (m Min) DefaultMessage() string

func (Min) IsSatisfied 

func (m Min) IsSatisfied(obj interface{}) bool

type MinSize 

type MinSize struct {
	Min int
}

Requires an array or string to be at least a given length.

func (MinSize) DefaultMessage 

func (m MinSize) DefaultMessage() string

func (MinSize) IsSatisfied 

func (m MinSize) IsSatisfied(obj interface{}) bool

type Module 

type Module struct {
	Name, ImportPath, Path string
}

func ModuleByName 

func ModuleByName(name string) (m Module, found bool)

ModuleByName returns the module of the given name, if loaded.

type Params 

type Params struct {
	url.Values
	Files map[string][]*multipart.FileHeader
	// contains filtered or unexported fields
}

These provide a unified view of the request params. Includes: - URL query string - Form values - File uploads

func ParseParams 

func ParseParams(req *Request) *Params

func (*Params) Bind 

func (p *Params) Bind(name string, typ reflect.Type) reflect.Value

type PlaintextErrorResult 

type PlaintextErrorResult struct {
	Error error
}

func (PlaintextErrorResult) Apply 

func (r PlaintextErrorResult) Apply(req *Request, resp *Response)

This method is used when the template loader or error template is not available.

type Plugin 

type Plugin interface {
	// Called on server startup (and on each code reload).
	OnAppStart()
	// Called after the router has finished configuration.
	OnRoutesLoaded(router *Router)
	// Called before every request.
	BeforeRequest(c *Controller)
	// Called after every non-panicking request, before the Result has been applied.
	AfterRequest(c *Controller)
	// Called when a panic exits an action, with the recovered error value.
	OnException(c *Controller, err interface{})
	// Called after every request (panic or not), after the Result has been applied.
	Finally(c *Controller)
}

An plugin that allows the user to inject behavior at various points in the request cycle.

type PluginCollection 

type PluginCollection []Plugin

func (PluginCollection) AfterRequest 

func (plugins PluginCollection) AfterRequest(c *Controller)

func (PluginCollection) BeforeRequest 

func (plugins PluginCollection) BeforeRequest(c *Controller)

func (PluginCollection) Finally 

func (plugins PluginCollection) Finally(c *Controller)

func (PluginCollection) OnAppStart 

func (plugins PluginCollection) OnAppStart()

func (PluginCollection) OnException 

func (plugins PluginCollection) OnException(c *Controller, err interface{})

func (PluginCollection) OnRoutesLoaded 

func (plugins PluginCollection) OnRoutesLoaded(router *Router)

type PluginNotifier 

type PluginNotifier struct {
	// contains filtered or unexported fields
}

The PluginNotifier glues the watcher and the plugin collection together. It audits refreshes and invokes the appropriate method to inform the plugins.

func (PluginNotifier) OnRefresh 

func (pn PluginNotifier) OnRefresh(l Listener)

type Range 

type Range struct {
	Min
	Max
}

Requires an integer to be within Min, Max inclusive.

func (Range) DefaultMessage 

func (r Range) DefaultMessage() string

func (Range) IsSatisfied 

func (r Range) IsSatisfied(obj interface{}) bool

type RedirectToActionResult 

type RedirectToActionResult struct {
	// contains filtered or unexported fields
}

func (*RedirectToActionResult) Apply 

func (r *RedirectToActionResult) Apply(req *Request, resp *Response)

type RedirectToUrlResult 

type RedirectToUrlResult struct {
	// contains filtered or unexported fields
}

func (*RedirectToUrlResult) Apply 

func (r *RedirectToUrlResult) Apply(req *Request, resp *Response)

type RenderHtmlResult 

type RenderHtmlResult struct {
	// contains filtered or unexported fields
}

func (RenderHtmlResult) Apply 

func (r RenderHtmlResult) Apply(req *Request, resp *Response)

type RenderJsonResult 

type RenderJsonResult struct {
	// contains filtered or unexported fields
}

func (RenderJsonResult) Apply 

func (r RenderJsonResult) Apply(req *Request, resp *Response)

type RenderTemplateResult 

type RenderTemplateResult struct {
	Template   Template
	RenderArgs map[string]interface{}
}

Action methods return this result to request a template be rendered.

func (*RenderTemplateResult) Apply 

func (r *RenderTemplateResult) Apply(req *Request, resp *Response)

type RenderTextResult 

type RenderTextResult struct {
	// contains filtered or unexported fields
}

func (RenderTextResult) Apply 

func (r RenderTextResult) Apply(req *Request, resp *Response)

type RenderXmlResult 

type RenderXmlResult struct {
	// contains filtered or unexported fields
}

func (RenderXmlResult) Apply 

func (r RenderXmlResult) Apply(req *Request, resp *Response)

type Request 

type Request struct {
	*http.Request
	ContentType     string
	Format          string // "html", "xml", "json", or "text"
	AcceptLanguages AcceptLanguages
	Locale          string
}

func NewRequest 

func NewRequest(r *http.Request) *Request

type Required 

type Required struct{}

func (Required) DefaultMessage 

func (r Required) DefaultMessage() string

func (Required) IsSatisfied 

func (r Required) IsSatisfied(obj interface{}) bool

type Response 

type Response struct {
	Status      int
	ContentType string

	Out http.ResponseWriter
}

func NewResponse 

func NewResponse(w http.ResponseWriter) *Response

func (*Response) WriteHeader 

func (resp *Response) WriteHeader(defaultStatusCode int, defaultContentType string)

Write the header (for now, just the status code). The status may be set directly by the application (c.Response.Status = 501). if it isn't, then fall back to the provided status code.

type Result 

type Result interface {
	Apply(req *Request, resp *Response)
}

type Route 

type Route struct {
	Method      string   // e.g. GET
	Path        string   // e.g. /app/{id}
	Action      string   // e.g. Application.ShowApp
	FixedParams []string // e.g. "arg1","arg2","arg3" (CSV formatting)
	// contains filtered or unexported fields
}

func NewRoute 

func NewRoute(method, path, action, fixedArgs string) (r *Route)

Prepares the route to be used in matching.

func (*Route) Match 

func (r *Route) Match(method string, reqPath string) *RouteMatch

Return nil if no match.

type RouteMatch 

type RouteMatch struct {
	Action         string // e.g. Application.ShowApp
	ControllerName string // e.g. Application
	MethodName     string // e.g. ShowApp
	FixedParams    []string
	Params         map[string]string // e.g. {id: 123}
}

type Router 

type Router struct {
	Routes []*Route
	// contains filtered or unexported fields
}

func NewRouter 

func NewRouter(routesPath string) *Router

func (*Router) Refresh 

func (router *Router) Refresh() (err *Error)

Refresh re-reads the routes file and re-calculates the routing table. Returns an error if a specified action could not be found.

func (*Router) Reverse 

func (router *Router) Reverse(action string, argValues map[string]string) *ActionDefinition

func (*Router) Route 

func (router *Router) Route(req *http.Request) *RouteMatch

type Session 

type Session map[string]string

A signed cookie (and thus limited to 4kb in size). Restriction: Keys may not have a colon in them.

func (Session) Id 

func (s Session) Id() string

Return a UUID identifying this session.

type SessionPlugin 

type SessionPlugin struct{ EmptyPlugin }

func (SessionPlugin) AfterRequest 

func (p SessionPlugin) AfterRequest(c *Controller)

func (SessionPlugin) BeforeRequest 

func (p SessionPlugin) BeforeRequest(c *Controller)

type StartupPlugin 

type StartupPlugin struct {
	EmptyPlugin
}

func (StartupPlugin) OnAppStart 

func (p StartupPlugin) OnAppStart()

type Template 

type Template interface {
	Name() string
	Content() []string
	Render(wr io.Writer, arg interface{}) error
}

type TemplateLoader 

type TemplateLoader struct {
	// contains filtered or unexported fields
}

This object handles loading and parsing of templates. Everything below the application's views directory is treated as a template.

func NewTemplateLoader 

func NewTemplateLoader(paths []string) *TemplateLoader

func (*TemplateLoader) Refresh 

func (loader *TemplateLoader) Refresh() *Error

This scans the views directory and parses all templates as Go Templates. If a template fails to parse, the error is set on the loader. (It's awkward to refresh a single Go Template)

func (*TemplateLoader) Template 

func (loader *TemplateLoader) Template(name string) (Template, error)

Return the Template with the given name. The name is the template's path relative to a template loader root.

An Error is returned if there was any problem with any of the templates. (In this case, if a template is returned, it may still be usable.)

func (*TemplateLoader) WatchDir 

func (loader *TemplateLoader) WatchDir(info os.FileInfo) bool

func (*TemplateLoader) WatchFile 

func (loader *TemplateLoader) WatchFile(basename string) bool

type TestSuite 

type TestSuite struct {
	Client       *http.Client
	Response     *http.Response
	ResponseBody []byte
	Session      Session
}

func NewTestSuite 

func NewTestSuite() TestSuite

NewTestSuite returns an initialized TestSuite ready for use. It is invoked by the test harness to initialize the embedded field in application tests.

func (*TestSuite) Assert 

func (t *TestSuite) Assert(exp bool)

func (*TestSuite) AssertContains 

func (t *TestSuite) AssertContains(s string)

Assert that the response contains the given string.

func (*TestSuite) AssertContainsRegex 

func (t *TestSuite) AssertContainsRegex(regex string)

Assert that the response matches the given regular expression.BUG

func (*TestSuite) AssertContentType 

func (t *TestSuite) AssertContentType(contentType string)

func (*TestSuite) AssertEqual 

func (t *TestSuite) AssertEqual(expected, actual interface{})

func (*TestSuite) AssertHeader 

func (t *TestSuite) AssertHeader(name, value string)

func (*TestSuite) AssertNotFound 

func (t *TestSuite) AssertNotFound()

func (*TestSuite) AssertOk 

func (t *TestSuite) AssertOk()

func (*TestSuite) AssertStatus 

func (t *TestSuite) AssertStatus(status int)

func (*TestSuite) Assertf 

func (t *TestSuite) Assertf(exp bool, formatStr string, args ...interface{})

func (*TestSuite) BaseUrl 

func (t *TestSuite) BaseUrl() string

Return the base http URL of the server, e.g. "http://127.0.0.1:8557"

func (*TestSuite) Get 

func (t *TestSuite) Get(path string)

Issue a GET request to the given path and store the result in Request and RequestBody.

func (*TestSuite) Host 

func (t *TestSuite) Host() string

Return the address and port of the server, e.g. "127.0.0.1:8557"

func (*TestSuite) MakeRequest 

func (t *TestSuite) MakeRequest(req *http.Request)

Issue any request and read the response. If successful, the caller may examine the Response and ResponseBody properties. You will need to manage session / cookie data manually

func (*TestSuite) MakeRequestSession 

func (t *TestSuite) MakeRequestSession(req *http.Request)

Issue any request and read the response. If successful, the caller may examine the Response and ResponseBody properties. Session data will be added to the request cookies for you.

func (*TestSuite) Post 

func (t *TestSuite) Post(path string, contentType string, reader io.Reader)

Issue a POST request to the given path, sending the given Content-Type and data, and store the result in Request and RequestBody. "data" may be nil.

func (*TestSuite) PostForm 

func (t *TestSuite) PostForm(path string, data url.Values)

Issue a POST request to the given path as a form post of the given key and values, and store the result in Request and RequestBody.

func (*TestSuite) WebSocket 

func (t *TestSuite) WebSocket(path string) *websocket.Conn

Create a websocket connection to the given path and return the connection

func (*TestSuite) WebSocketUrl 

func (t *TestSuite) WebSocketUrl() string

Return the base websocket URL of the server, e.g. "ws://127.0.0.1:8557"

type Validation 

type Validation struct {
	Errors []*ValidationError
	// contains filtered or unexported fields
}

A Validation context manages data validation and error messages.

func (*Validation) Check 

func (v *Validation) Check(obj interface{}, checks ...Validator) *ValidationResult

Apply a group of validators to a field, in order, and return the ValidationResult from the first one that fails, or the last one that succeeds.

func (*Validation) Clear 

func (v *Validation) Clear()

func (*Validation) Email 

func (v *Validation) Email(str string) *ValidationResult

func (*Validation) Error 

func (v *Validation) Error(message string, args ...interface{}) *ValidationResult

Add an error to the validation context.

func (*Validation) ErrorMap 

func (v *Validation) ErrorMap() map[string]*ValidationError

Return the errors mapped by key. If there are multiple validation errors associated with a single key, the first one "wins". (Typically the first validation will be the more basic).

func (*Validation) HasErrors 

func (v *Validation) HasErrors() bool

func (*Validation) Keep 

func (v *Validation) Keep()

func (*Validation) Length 

func (v *Validation) Length(obj interface{}, n int) *ValidationResult

func (*Validation) Match 

func (v *Validation) Match(str string, regex *regexp.Regexp) *ValidationResult

func (*Validation) Max 

func (v *Validation) Max(n int, max int) *ValidationResult

func (*Validation) MaxSize 

func (v *Validation) MaxSize(obj interface{}, max int) *ValidationResult

func (*Validation) Min 

func (v *Validation) Min(n int, min int) *ValidationResult

func (*Validation) MinSize 

func (v *Validation) MinSize(obj interface{}, min int) *ValidationResult

func (*Validation) Range 

func (v *Validation) Range(n, min, max int) *ValidationResult

func (*Validation) Required 

func (v *Validation) Required(obj interface{}) *ValidationResult

Test that the argument is non-nil and non-empty (if string or list)

type ValidationError 

type ValidationError struct {
	Message, Key string
}

func (*ValidationError) String 

func (e *ValidationError) String() string

Returns the Message.

type ValidationPlugin 

type ValidationPlugin struct{ EmptyPlugin }

func (ValidationPlugin) AfterRequest 

func (p ValidationPlugin) AfterRequest(c *Controller)

func (ValidationPlugin) BeforeRequest 

func (p ValidationPlugin) BeforeRequest(c *Controller)

type ValidationResult 

type ValidationResult struct {
	Error *ValidationError
	Ok    bool
}

A ValidationResult is returned from every validation method. It provides an indication of success, and a pointer to the Error (if any).

func (*ValidationResult) Key 

func (r *ValidationResult) Key(key string) *ValidationResult

func (*ValidationResult) Message 

func (r *ValidationResult) Message(message string, args ...interface{}) *ValidationResult

type Validator 

type Validator interface {
	IsSatisfied(interface{}) bool
	DefaultMessage() string
}

type Watcher 

type Watcher struct {
	// contains filtered or unexported fields
}

Watcher allows listeners to register to be notified of changes under a given directory.

func NewWatcher 

func NewWatcher() *Watcher

func (*Watcher) Listen 

func (w *Watcher) Listen(listener Listener, roots ...string)

Listen registers for events within the given root directories (recursively).

func (*Watcher) Notify 

func (w *Watcher) Notify() *Error

Notify causes the watcher to forward any change events to listeners. It returns the first (if any) error returned.

Source Files

View all Source files

Directories

Path Synopsis
The command line tool for running Revel apps.
 The command line tool for running Revel apps.
modules
db/app
This plugin provides a database transaction to the application.
 This plugin provides a database transaction to the application.
jobs/app/controllers
jobs/app/jobs
A job runner for executing scheduled or ad-hoc tasks asynchronously from HTTP requests.
 A job runner for executing scheduled or ad-hoc tasks asynchronously from HTTP requests.
static/app/controllers
testrunner/app
testrunner/app/controllers
samples
booking/app/controllers
booking/app/jobs
booking/app/models
booking/tests
chat/app/chatroom
chat/app/controllers
facebook-oauth2/app/controllers
facebook-oauth2/app/models
i18n/app/controllers
i18n/tests
twitter-oauth/app/controllers
twitter-oauth/app/models
validation/app/controllers
validation/app/models
skeleton
app/controllers
tests

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.