Current section

Files

Jump to
phoenix lib phoenix endpoint adapter.ex
Raw

lib/phoenix/endpoint/adapter.ex

defmodule Phoenix.Endpoint.Adapter do
# This module contains the logic used by most functions
# in Phoenix.Endpoint as well the supervisor for starting
# the adapters/handlers.
@moduledoc false
require Logger
import Supervisor.Spec
@doc """
Starts the endpoint supervision tree.
"""
def start_link(otp_app, mod) do
conf = config(otp_app, mod)
server? = server?(conf)
children =
config_children(mod, conf) ++
pubsub_children(mod, conf) ++
server_children(mod, conf, server?) ++
watcher_children(mod, conf, server?) ++
code_reloader_children(mod, conf)
case Supervisor.start_link(children, strategy: :one_for_one, name: mod) do
{:ok, pid} ->
warmup(mod)
{:ok, pid}
{:error, reason} ->
{:error, reason}
end
end
defp config_children(mod, conf) do
id = :crypto.strong_rand_bytes(16) |> Base.encode64
app = conf[:otp_app]
conf = [endpoint_id: id] ++ defaults(app, mod)
args = [app, mod, conf, [name: Module.concat(mod, Config)]]
[worker(Phoenix.Config, args)]
end
defp pubsub_children(mod, conf) do
pub_conf = conf[:pubsub]
if adapter = pub_conf[:adapter] do
pub_conf = [fastlane: Phoenix.Channel.Server] ++ pub_conf
[supervisor(adapter, [mod.__pubsub_server__(), pub_conf])]
else
[]
end
end
defp server_children(mod, conf, server?) do
if server? do
args = [conf[:otp_app], mod, [name: Module.concat(mod, Server)]]
[supervisor(Phoenix.Endpoint.Server, args)]
else
[]
end
end
defp watcher_children(_mod, conf, server?) do
if server? do
Enum.map(conf[:watchers], fn {cmd, args} ->
worker(Phoenix.Endpoint.Watcher, watcher_args(cmd, args),
id: {cmd, args}, restart: :transient)
end)
else
[]
end
end
defp watcher_args(cmd, cmd_args) do
{args, opts} = Enum.split_while(cmd_args, &is_binary(&1))
[cmd, args, opts]
end
defp code_reloader_children(mod, conf) do
if conf[:code_reloader] do
args = [conf[:otp_app], mod, conf[:reloadable_compilers],
[name: Module.concat(mod, CodeReloader)]]
[worker(Phoenix.CodeReloader.Server, args)]
else
[]
end
end
@doc """
The endpoint configuration used at compile time.
"""
def config(otp_app, endpoint) do
Phoenix.Config.from_env(otp_app, endpoint, defaults(otp_app, endpoint))
end
@doc """
Checks if Endpoint's web server has been configured to start.
"""
def server?(otp_app, endpoint) when is_atom(otp_app) and is_atom(endpoint) do
otp_app
|> config(endpoint)
|> server?()
end
def server?(conf) when is_list(conf) do
Keyword.get(conf, :server, Application.get_env(:phoenix, :serve_endpoints, false))
end
defp defaults(otp_app, module) do
[otp_app: otp_app,
handler: Phoenix.Endpoint.CowboyHandler,
# Compile-time config
code_reloader: false,
debug_errors: false,
render_errors: [view: render_errors(module), accepts: ~w(html), layout: false],
# Runtime config
cache_static_manifest: nil,
check_origin: true,
http: false,
https: false,
reloadable_compilers: [:gettext, :phoenix, :elixir],
secret_key_base: nil,
static_url: nil,
url: [host: "localhost", path: "/"],
# Supervisor config
pubsub: [pool_size: 1],
watchers: []]
end
defp render_errors(module) do
module
|> Module.split
|> Enum.at(0)
|> Module.concat("ErrorView")
end
@doc """
Callback that changes the configuration from the app callback.
"""
def config_change(endpoint, changed, removed) do
res = Phoenix.Config.config_change(endpoint, changed, removed)
warmup(endpoint)
res
end
@doc """
Builds the endpoint url from its configuration.
The result is wrapped in a `{:cache, value}` tuple so
the Phoenix.Config layer knows how to cache it.
"""
def url(endpoint) do
{:cache, build_url(endpoint, endpoint.config(:url)) |> String.Chars.URI.to_string()}
end
@doc """
Builds the static url from its configuration.
The result is wrapped in a `{:cache, value}` tuple so
the Phoenix.Config layer knows how to cache it.
"""
def static_url(endpoint) do
url = endpoint.config(:static_url) || endpoint.config(:url)
{:cache, build_url(endpoint, url) |> String.Chars.URI.to_string()}
end
@doc """
Builds a struct url for user processing.
The result is wrapped in a `{:cache, value}` tuple so
the Phoenix.Config layer knows how to cache it.
"""
def struct_url(endpoint) do
url = endpoint.config(:url)
struct = build_url(endpoint, url)
{:cache,
case url[:path] do
"/" -> struct
path -> %{struct | path: path}
end}
end
defp build_url(endpoint, url) do
build_url(endpoint.config(:https), endpoint.config(:http), url)
end
defp build_url(https, http, url) do
{scheme, port} =
cond do
https ->
{"https", https[:port]}
http ->
{"http", http[:port]}
true ->
{"http", 80}
end
scheme = url[:scheme] || scheme
host = host_to_binary(url[:host])
port = port_to_integer(url[:port] || port)
%URI{scheme: scheme, port: port, host: host}
end
@doc """
Returns the static path of a file in the static root directory.
When the file exists, it includes a timestamp. When it doesn't exist,
just the static path is returned.
The result is wrapped in a `{:cache | :nocache, value}` tuple so
the Phoenix.Config layer knows how to cache it.
"""
def static_path(_endpoint, "/" <> _ = path) do
{:nocache, path}
end
def static_path(_endpoint, path) when is_binary(path) do
raise ArgumentError, "static_path/2 expects a path starting with / as argument"
end
defp host_to_binary({:system, env_var}), do: host_to_binary(System.get_env(env_var))
defp host_to_binary(host), do: host
defp port_to_integer({:system, env_var}), do: port_to_integer(System.get_env(env_var))
defp port_to_integer(port) when is_binary(port), do: String.to_integer(port)
defp port_to_integer(port) when is_integer(port), do: port
@doc """
Invoked to warm up caches on start and config change.
"""
def warmup(endpoint) do
warmup_url(endpoint)
warmup_static(endpoint)
:ok
rescue
_ -> :ok
end
defp warmup_url(endpoint) do
endpoint.url
end
defp warmup_static(endpoint) do
for {key, value} <- cache_static_manifest(endpoint) do
# This should be in sync with the endpoint lookup.
Phoenix.Config.cache(endpoint, {:__phoenix_static__, "/" <> key}, fn _ ->
{:cache, "/" <> value <> "?vsn=d"}
end)
end
end
defp cache_static_manifest(endpoint) do
if inner = endpoint.config(:cache_static_manifest) do
outer = Application.app_dir(endpoint.config(:otp_app), inner)
if File.exists?(outer) do
Poison.decode!(File.read!(outer))
else
Logger.error "Could not find static manifest at #{inspect outer}. " <>
"Run \"mix phoenix.digest\" after building your static files " <>
"or remove the configuration from \"config/prod.exs\"."
end
else
%{}
end
end
end