1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512
|
package revel
import (
"encoding/csv"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"path"
"regexp"
"strings"
"github.com/robfig/pathtree"
)
type Route struct {
Method string // e.g. GET
Path string // e.g. /app/:id
Action string // e.g. "Application.ShowApp", "404"
ControllerName string // e.g. "Application", ""
MethodName string // e.g. "ShowApp", ""
FixedParams []string // e.g. "arg1","arg2","arg3" (CSV formatting)
TreePath string // e.g. "/GET/app/:id"
routesPath string // e.g. /Users/robfig/gocode/src/myapp/conf/routes
line int // e.g. 3
}
type RouteMatch struct {
Action string // e.g. 404
ControllerName string // e.g. Application
MethodName string // e.g. ShowApp
FixedParams []string
Params map[string][]string // e.g. {id: 123}
}
type arg struct {
name string
index int
constraint *regexp.Regexp
}
// Prepares the route to be used in matching.
func NewRoute(method, path, action, fixedArgs, routesPath string, line int) (r *Route) {
// Handle fixed arguments
argsReader := strings.NewReader(fixedArgs)
csv := csv.NewReader(argsReader)
csv.TrimLeadingSpace = true
fargs, err := csv.Read()
if err != nil && err != io.EOF {
ERROR.Printf("Invalid fixed parameters (%v): for string '%v'", err.Error(), fixedArgs)
}
r = &Route{
Method: strings.ToUpper(method),
Path: path,
Action: action,
FixedParams: fargs,
TreePath: treePath(strings.ToUpper(method), path),
routesPath: routesPath,
line: line,
}
// URL pattern
if !strings.HasPrefix(r.Path, "/") {
ERROR.Print("Absolute URL required.")
return
}
actionSplit := strings.Split(action, ".")
if len(actionSplit) == 2 {
r.ControllerName = actionSplit[0]
r.MethodName = actionSplit[1]
}
return
}
func treePath(method, path string) string {
if method == "*" {
method = ":METHOD"
}
return "/" + method + path
}
type Router struct {
Routes []*Route
Tree *pathtree.Node
path string // path to the routes file
}
var notFound = &RouteMatch{Action: "404"}
func (router *Router) Route(req *http.Request) *RouteMatch {
// Override method if set in header
if method := req.Header.Get("X-HTTP-Method-Override"); method != "" && req.Method == "POST" {
req.Method = method
}
leaf, expansions := router.Tree.Find(treePath(req.Method, req.URL.Path))
if leaf == nil {
return nil
}
route := leaf.Value.(*Route)
// Create a map of the route parameters.
var params url.Values
if len(expansions) > 0 {
params = make(url.Values)
for i, v := range expansions {
params[leaf.Wildcards[i]] = []string{v}
}
}
// Special handling for explicit 404's.
if route.Action == "404" {
return notFound
}
// If the action is variablized, replace into it with the captured args.
controllerName, methodName := route.ControllerName, route.MethodName
if controllerName[0] == ':' {
controllerName = params[controllerName[1:]][0]
}
if methodName[0] == ':' {
methodName = params[methodName[1:]][0]
}
return &RouteMatch{
ControllerName: controllerName,
MethodName: methodName,
Params: params,
FixedParams: route.FixedParams,
}
}
// 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 *Router) Refresh() (err *Error) {
router.Routes, err = parseRoutesFile(router.path, "", true)
if err != nil {
return
}
err = router.updateTree()
return
}
func (router *Router) updateTree() *Error {
router.Tree = pathtree.New()
for _, route := range router.Routes {
err := router.Tree.Add(route.TreePath, route)
// Allow GETs to respond to HEAD requests.
if err == nil && route.Method == "GET" {
err = router.Tree.Add(treePath("HEAD", route.Path), route)
}
// Error adding a route to the pathtree.
if err != nil {
return routeError(err, route.routesPath, "", route.line)
}
}
return nil
}
// parseRoutesFile reads the given routes file and returns the contained routes.
func parseRoutesFile(routesPath, joinedPath string, validate bool) ([]*Route, *Error) {
contentBytes, err := ioutil.ReadFile(routesPath)
if err != nil {
return nil, &Error{
Title: "Failed to load routes file",
Description: err.Error(),
}
}
return parseRoutes(routesPath, joinedPath, string(contentBytes), validate)
}
// parseRoutes reads the content of a routes file into the routing table.
func parseRoutes(routesPath, joinedPath, content string, validate bool) ([]*Route, *Error) {
var routes []*Route
// For each line..
for n, line := range strings.Split(content, "\n") {
line = strings.TrimSpace(line)
if len(line) == 0 || line[0] == '#' {
continue
}
const modulePrefix = "module:"
// Handle included routes from modules.
// e.g. "module:testrunner" imports all routes from that module.
if strings.HasPrefix(line, modulePrefix) {
moduleRoutes, err := getModuleRoutes(line[len(modulePrefix):], joinedPath, validate)
if err != nil {
return nil, routeError(err, routesPath, content, n)
}
routes = append(routes, moduleRoutes...)
continue
}
// A single route
method, path, action, fixedArgs, found := parseRouteLine(line)
if !found {
continue
}
// this will avoid accidental double forward slashes in a route.
// this also avoids pathtree freaking out and causing a runtime panic
// because of the double slashes
if strings.HasSuffix(joinedPath, "/") && strings.HasPrefix(path, "/") {
joinedPath = joinedPath[0 : len(joinedPath)-1]
}
path = strings.Join([]string{AppRoot, joinedPath, path}, "")
// This will import the module routes under the path described in the
// routes file (joinedPath param). e.g. "* /jobs module:jobs" -> all
// routes' paths will have the path /jobs prepended to them.
// See #282 for more info
if method == "*" && strings.HasPrefix(action, modulePrefix) {
moduleRoutes, err := getModuleRoutes(action[len(modulePrefix):], path, validate)
if err != nil {
return nil, routeError(err, routesPath, content, n)
}
routes = append(routes, moduleRoutes...)
continue
}
route := NewRoute(method, path, action, fixedArgs, routesPath, n)
routes = append(routes, route)
if validate {
if err := validateRoute(route); err != nil {
return nil, routeError(err, routesPath, content, n)
}
}
}
return routes, nil
}
// validateRoute checks that every specified action exists.
func validateRoute(route *Route) error {
// Skip 404s
if route.Action == "404" {
return nil
}
// We should be able to load the action.
parts := strings.Split(route.Action, ".")
if len(parts) != 2 {
return fmt.Errorf("Expected two parts (Controller.Action), but got %d: %s",
len(parts), route.Action)
}
// Skip variable routes.
if parts[0][0] == ':' || parts[1][0] == ':' {
return nil
}
var c Controller
if err := c.SetAction(parts[0], parts[1]); err != nil {
return err
}
return nil
}
// routeError adds context to a simple error message.
func routeError(err error, routesPath, content string, n int) *Error {
if revelError, ok := err.(*Error); ok {
return revelError
}
// Load the route file content if necessary
if content == "" {
contentBytes, err := ioutil.ReadFile(routesPath)
if err != nil {
ERROR.Printf("Failed to read route file %s: %s\n", routesPath, err)
} else {
content = string(contentBytes)
}
}
return &Error{
Title: "Route validation error",
Description: err.Error(),
Path: routesPath,
Line: n + 1,
SourceLines: strings.Split(content, "\n"),
}
}
// getModuleRoutes loads the routes file for the given module and returns the
// list of routes.
func getModuleRoutes(moduleName, joinedPath string, validate bool) ([]*Route, *Error) {
// Look up the module. It may be not found due to the common case of e.g. the
// testrunner module being active only in dev mode.
module, found := ModuleByName(moduleName)
if !found {
INFO.Println("Skipping routes for inactive module", moduleName)
return nil, nil
}
return parseRoutesFile(path.Join(module.Path, "conf", "routes"), joinedPath, validate)
}
// Groups:
// 1: method
// 4: path
// 5: action
// 6: fixedargs
var routePattern *regexp.Regexp = regexp.MustCompile(
"(?i)^(GET|POST|PUT|DELETE|PATCH|OPTIONS|HEAD|WS|\\*)" +
"[(]?([^)]*)(\\))?[ \t]+" +
"(.*/[^ \t]*)[ \t]+([^ \t(]+)" +
`\(?([^)]*)\)?[ \t]*$`)
func parseRouteLine(line string) (method, path, action, fixedArgs string, found bool) {
var matches []string = routePattern.FindStringSubmatch(line)
if matches == nil {
return
}
method, path, action, fixedArgs = matches[1], matches[4], matches[5], matches[6]
found = true
return
}
func NewRouter(routesPath string) *Router {
return &Router{
Tree: pathtree.New(),
path: routesPath,
}
}
type ActionDefinition struct {
Host, Method, Url, Action string
Star bool
Args map[string]string
}
func (a *ActionDefinition) String() string {
return a.Url
}
func (router *Router) Reverse(action string, argValues map[string]string) *ActionDefinition {
actionSplit := strings.Split(action, ".")
if len(actionSplit) != 2 {
ERROR.Print("revel/router: reverse router got invalid action ", action)
return nil
}
controllerName, methodName := actionSplit[0], actionSplit[1]
for _, route := range router.Routes {
// Skip routes without either a ControllerName or MethodName
if route.ControllerName == "" || route.MethodName == "" {
continue
}
// Check that the action matches or is a wildcard.
controllerWildcard := route.ControllerName[0] == ':'
methodWildcard := route.MethodName[0] == ':'
if (!controllerWildcard && route.ControllerName != controllerName) ||
(!methodWildcard && route.MethodName != methodName) {
continue
}
if controllerWildcard {
argValues[route.ControllerName[1:]] = controllerName
}
if methodWildcard {
argValues[route.MethodName[1:]] = methodName
}
// Build up the URL.
var (
queryValues = make(url.Values)
pathElements = strings.Split(route.Path, "/")
)
for i, el := range pathElements {
if el == "" || (el[0] != ':' && el[0] != '*') {
continue
}
val, ok := argValues[el[1:]]
if !ok {
val = "<nil>"
ERROR.Print("revel/router: reverse route missing route arg ", el[1:])
}
pathElements[i] = val
delete(argValues, el[1:])
continue
}
// Add any args that were not inserted into the path into the query string.
for k, v := range argValues {
queryValues.Set(k, v)
}
// Calculate the final URL and Method
url := strings.Join(pathElements, "/")
if len(queryValues) > 0 {
url += "?" + queryValues.Encode()
}
method := route.Method
star := false
if route.Method == "*" {
method = "GET"
star = true
}
return &ActionDefinition{
Url: url,
Method: method,
Star: star,
Action: action,
Args: argValues,
Host: "TODO",
}
}
ERROR.Println("Failed to find reverse route:", action, argValues)
return nil
}
func init() {
OnAppStart(func() {
MainRouter = NewRouter(path.Join(BasePath, "conf", "routes"))
err := MainRouter.Refresh()
if MainWatcher != nil && Config.BoolDefault("watch.routes", true) {
MainWatcher.Listen(MainRouter, MainRouter.path)
} else if err != nil {
// Not in dev mode and Route loading failed, we should crash.
ERROR.Panicln(err.Error())
}
})
}
func RouterFilter(c *Controller, fc []Filter) {
// Figure out the Controller/Action
var route *RouteMatch = MainRouter.Route(c.Request.Request)
if route == nil {
c.Result = c.NotFound("No matching route found: " + c.Request.RequestURI)
return
}
// The route may want to explicitly return a 404.
if route.Action == "404" {
c.Result = c.NotFound("(intentionally)")
return
}
// Set the action.
if err := c.SetAction(route.ControllerName, route.MethodName); err != nil {
c.Result = c.NotFound(err.Error())
return
}
// Add the route and fixed params to the Request Params.
c.Params.Route = route.Params
// Add the fixed parameters mapped by name.
// TODO: Pre-calculate this mapping.
for i, value := range route.FixedParams {
if c.Params.Fixed == nil {
c.Params.Fixed = make(url.Values)
}
if i < len(c.MethodType.Args) {
arg := c.MethodType.Args[i]
c.Params.Fixed.Set(arg.Name, value)
} else {
WARN.Println("Too many parameters to", route.Action, "trying to add", value)
break
}
}
fc[0](c, fc[1:])
}
// Override allowed http methods via form or browser param
func HttpMethodOverride(c *Controller, fc []Filter) {
// An array of HTTP verbs allowed.
verbs := []string{"POST", "PUT", "PATCH", "DELETE"}
method := strings.ToUpper(c.Request.Request.Method)
if method == "POST" {
param := strings.ToUpper(c.Request.Request.PostFormValue("_method"))
if len(param) > 0 {
override := false
// Check if param is allowed
for _, verb := range verbs {
if verb == param {
override = true
break
}
}
if override {
c.Request.Request.Method = param
} else {
c.Response.Status = 405
c.Result = c.RenderError(&Error{
Title: "Method not allowed",
Description: "Method " + param + " is not allowed (valid: " + strings.Join(verbs, ", ") + ")",
})
return
}
}
}
fc[0](c, fc[1:]) // Execute the next filter stage.
}
|