Packages
phoenix
0.6.1
1.8.9
1.8.8
1.8.7
1.8.6
1.8.5
1.8.4
1.8.3
1.8.2
1.8.1
1.8.0
1.8.0-rc.4
1.8.0-rc.3
1.8.0-rc.2
1.8.0-rc.1
1.8.0-rc.0
1.7.24
1.7.23
1.7.22
1.7.21
1.7.20
1.7.19
1.7.18
1.7.17
1.7.16
1.7.15
1.7.14
1.7.13
1.7.12
1.7.11
1.7.10
1.7.9
1.7.8
1.7.7
1.7.6
1.7.5
1.7.4
1.7.3
1.7.2
1.7.1
1.7.0
1.7.0-rc.3
1.7.0-rc.2
1.7.0-rc.1
1.7.0-rc.0
1.6.17
1.6.16
1.6.15
1.6.14
1.6.13
1.6.12
1.6.11
1.6.10
1.6.9
1.6.8
1.6.7
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0
1.6.0-rc.1
1.6.0-rc.0
1.5.15
1.5.14
1.5.13
1.5.12
1.5.11
1.5.10
1.5.9
1.5.8
1.5.7
1.5.6
1.5.5
1.5.4
1.5.3
1.5.2
1.5.1
1.5.0
1.5.0-rc.0
1.4.18
1.4.17
1.4.16
1.4.15
1.4.14
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.4.0-rc.3
1.4.0-rc.2
1.4.0-rc.1
1.4.0-rc.0
1.3.5
1.3.4
1.3.3
1.3.2
1.3.1
1.3.0
1.3.0-rc.3
1.3.0-rc.2
1.3.0-rc.1
1.3.0-rc.0
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.1
1.2.0-rc.0
1.1.9
1.1.8
1.1.7
1.1.6
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.0.6
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
0.17.1
0.17.0
0.16.1
0.16.0
0.15.0
0.14.0
0.13.1
0.13.0
0.12.0
0.11.0
0.10.0
0.9.0
0.8.0
0.7.2
0.7.1
0.7.0
0.6.2
0.6.1
0.6.0
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.11
0.2.10
0.2.9
0.2.8
0.2.7
0.2.6
0.2.5
0.2.4
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0
Productive. Reliable. Fast. A productive web framework that does not compromise speed or maintainability.
Security advisory:
This version has known vulnerabilities.
View advisories
Current section
Files
Jump to
Current section
Files
lib/phoenix/router/helpers.ex
defmodule Phoenix.Router.Helpers do
# Module that generates the routing helpers.
@moduledoc false
alias Phoenix.Router.Route
@doc """
Generates the router module for the given environment and routes.
"""
def define(env, routes) do
ast = for route <- routes, do: defhelper(route)
# It is in general bad practice to generate large chunks of code
# inside quoted expressions. However, we can get away with this
# here for two reasons:
#
# * Helper modules are quite uncommon, typically one per project.
#
# * We inline most of the code for performance, so it is specific
# per helper module anyway.
#
code = quote do
@moduledoc """
Module with named helpers generated from #{inspect unquote(env.module)}.
"""
unquote(ast)
@doc """
Generates a URL for the given path.
"""
def url(path) do
Phoenix.Config.cache(unquote(env.module),
:__phoenix_url_helper__,
&Phoenix.Router.Helpers.url/1) <> path
end
@doc """
Generates a URL for the given path considering the connection data.
"""
def url(%Plug.Conn{}, path), do: url(path)
# Functions used by generated helpers
defp to_path(segments, [], _reserved) do
segments
end
defp to_path(segments, query, reserved) do
dict = for {k, v} <- query,
not (k = to_string(k)) in reserved,
do: {k, v}
case Plug.Conn.Query.encode dict do
"" -> segments
o -> segments <> "?" <> o
end
end
end
Module.create(Module.concat(env.module, Helpers), code,
line: env.line, file: env.file)
end
@doc """
Builds the url from the router configuration.
"""
def url(router) do
{scheme, port} =
cond do
config = router.config(:https) ->
{"https", config[:port]}
config = router.config(:http) ->
{"http", config[:port]}
true ->
{"http", "80"}
end
url = router.config(:url)
scheme = url[:scheme] || scheme
host = url[:host]
port = to_string(url[:port] || port)
case {scheme, port} do
{"https", "443"} -> "https://" <> host
{"http", "80"} -> "http://" <> host
{_, _} -> scheme <> "://" <> host <> ":" <> port
end
end
@doc """
Receives a route and returns the quoted definition for its helper function.
In case a helper name was not given, returns nil.
"""
def defhelper(%Route{helper: nil}), do: nil
def defhelper(%Route{} = route) do
helper = route.helper
action = route.action
{bins, vars} = :lists.unzip(route.binding)
segs = optimize_segments(route.path_segments)
# We are using -1 to avoid warnings in case a path has already been defined.
quote line: -1 do
def unquote(:"#{helper}_path")(unquote(action), unquote_splicing(vars)) do
unquote(:"#{helper}_path")(unquote(action), unquote_splicing(vars), [])
end
def unquote(:"#{helper}_path")(unquote(action), unquote_splicing(vars), params) do
to_path(unquote(segs), params, unquote(bins))
end
end
end
defp optimize_segments([]), do: "/"
defp optimize_segments(segments) when is_list(segments),
do: optimize_segments(segments, "")
defp optimize_segments(segments),
do: quote(do: "/" <> Enum.join(unquote(segments), "/"))
defp optimize_segments([{:|, _, [h, t]}], acc),
do: quote(do: unquote(optimize_segments([h], acc)) <> "/" <> Enum.join(unquote(t), "/"))
defp optimize_segments([h|t], acc) when is_binary(h),
do: optimize_segments(t, quote(do: unquote(acc) <> unquote("/" <> h)))
defp optimize_segments([h|t], acc),
do: optimize_segments(t, quote(do: unquote(acc) <> "/" <> to_string(unquote(h))))
defp optimize_segments([], acc),
do: acc
end