Packages
phoenix_live_view
0.2.1
1.2.7
1.2.6
1.2.5
1.2.4
1.2.3
1.2.2
1.2.1
1.2.0
1.2.0-rc.3
1.2.0-rc.2
1.2.0-rc.1
1.2.0-rc.0
1.1.32
1.1.31
1.1.30
1.1.29
1.1.28
1.1.27
1.1.26
1.1.25
1.1.24
1.1.23
1.1.22
1.1.21
1.1.20
1.1.19
1.1.18
1.1.17
1.1.16
1.1.15
1.1.14
1.1.13
1.1.12
1.1.11
1.1.10
1.1.9
1.1.8
1.1.7
1.1.6
retired
1.1.5
1.1.4
1.1.3
1.1.2
1.1.1
1.1.0
1.1.0-rc.4
1.1.0-rc.3
1.1.0-rc.2
1.1.0-rc.1
1.1.0-rc.0
1.0.18
1.0.17
1.0.16
1.0.15
1.0.14
1.0.13
1.0.12
1.0.11
1.0.10
1.0.9
1.0.8
retired
1.0.7
1.0.6
retired
1.0.5
1.0.4
1.0.3
1.0.2
1.0.1
1.0.0
1.0.0-rc.9
1.0.0-rc.8
1.0.0-rc.7
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.20.17
0.20.16
0.20.15
0.20.14
0.20.13
0.20.12
0.20.11
0.20.10
0.20.9
0.20.8
0.20.7
0.20.6
0.20.5
0.20.4
0.20.3
0.20.2
0.20.1
0.20.0
0.19.5
0.19.4
0.19.3
0.19.2
0.19.1
0.19.0
0.18.18
0.18.17
0.18.16
0.18.15
0.18.14
0.18.13
0.18.12
0.18.11
0.18.10
0.18.9
0.18.8
0.18.7
0.18.6
0.18.5
0.18.4
0.18.3
0.18.2
0.18.1
0.18.0
0.17.14
0.17.13
0.17.12
0.17.11
0.17.10
0.17.9
0.17.8
0.17.7
0.17.6
0.17.5
0.17.4
0.17.3
0.17.2
0.17.1
0.17.0
0.16.4
0.16.3
0.16.2
0.16.1
0.16.0
0.15.7
0.15.6
0.15.5
0.15.4
0.15.3
0.15.2
0.15.1
0.15.0
0.14.8
0.14.7
0.14.6
0.14.5
0.14.4
0.14.3
0.14.2
0.14.1
0.14.0
0.13.3
0.13.2
0.13.1
0.13.0
0.12.1
0.12.0
0.11.1
0.11.0
0.10.0
0.9.0
0.8.1
0.8.0
0.7.1
0.7.0
0.6.0
0.6.0-dev
0.5.2
0.5.1
0.5.0
0.4.1
0.4.0
0.3.1
0.3.0
0.2.1
0.2.0
0.1.1
0.1.0
Rich, real-time user experiences with server-rendered HTML
Current section
Files
Jump to
Current section
Files
lib/phoenix_live_view/flash.ex
defmodule Phoenix.LiveView.Flash do
@moduledoc """
Fetches Phoenix LiveView flash messages from cookie token.
## Examples
plug Phoenix.LiveView.Flash
By default, the signing salt for the token is pulled from
your endpoint's LiveView config, for example:
config :my_app, MyAppWeb.Endpoint,
...,
live_view: [signing_salt: ...]
The `:signing_salt` option may also be passed directly to the plug.
"""
@valid_keys [:signing_salt]
@behaviour Plug
@cookie_key "__phoenix_flash__"
@impl Plug
def init(opts) do
if Keyword.keys(opts) -- @valid_keys != [] do
raise ArgumentError, """
invalid options passed to #{inspect(__MODULE__)}.
Valid options include #{inspect(@valid_keys)}, got: #{inspect(opts)}
"""
end
opts
end
@doc """
Fetches the live flash from a token passed via client cookies.
"""
@impl Plug
def call(conn, opts) do
case cookie_flash(conn, salt(conn, opts)) do
{conn, nil} -> Phoenix.Controller.fetch_flash(conn, [])
{conn, flash} ->
conn
|> Plug.Conn.put_session("phoenix_flash", flash)
|> Phoenix.Controller.fetch_flash([])
end
end
defp cookie_flash(%Plug.Conn{cookies: %{@cookie_key => token}} = conn, salt) do
flash =
case Phoenix.Token.verify(conn, salt, token, max_age: 60_000) do
{:ok, json_flash} -> Phoenix.json_library().decode!(json_flash)
{:error, _reason} -> nil
end
{Plug.Conn.delete_resp_cookie(conn, @cookie_key), flash}
end
defp cookie_flash(%Plug.Conn{} = conn, _salt), do: {conn, nil}
defp salt(conn, opts) do
endpoint = Phoenix.Controller.endpoint_module(conn)
salt_base = opts[:signing_salt] || Phoenix.LiveView.View.salt!(endpoint)
computed_salt(salt_base)
end
defp computed_salt(salt_base), do: salt_base <> "flash"
@doc false
def sign_token(endpoint_mod, salt_base, %{} = flash) do
salt = computed_salt(salt_base)
Phoenix.Token.sign(endpoint_mod, salt, Phoenix.json_library().encode!(flash))
end
end