Haytni v0.0.1 Haytni.Plugin behaviour View Source
Defines a plugin to be used by Haytni
Link to this section Summary
Callbacks
Returns the Ecto.Schema.field/1
s as a quoted fragment to be injected in application’s Router
Returns a list of files to be (un)installed by the mix taks haytni.(un)install
Extract (early) the user from the HTTP request (http authentification, cookies/session, …)
Check if the user is in a valid state. This callback is intended to let know others plugins if we should reject the login (and why)
This callback is invoked when a user is editing its registration and change its email address.
It is a facility (subset) to avoid you to handle it by yourself via validate_update_registration/1
Invoked when an authentification failed (wrong password). It receives the concerned account and a Keyword to return after updating it if any change have to be done to this user
This callback is invoked when a user (manually) log out. Its purpose is mainly to do some cleanup like removing a cookie
Invoked to accomplish a task right after user’s registration (insert). This callback allows you to do some linked changes to the database, send an email or whatever by appending it to multi
Invoked when an authentification is successful. Like on_failed_authentification/2
, it receives
the current user and a Keyword to return after updating it if you want to bring any change to this
user to the database
Returns the routes as a quoted fragment to be injected in application’s Router
This callback let you do any kind of change or additionnal validation on the changeset when a user is registering
Same as validate_create_registration
but registration’s edition as logic between the two
may be completely different
Link to this section Callbacks
Returns the Ecto.Schema.field/1
s as a quoted fragment to be injected in application’s Router
Returns a list of files to be (un)installed by the mix taks haytni.(un)install
TODO: format of the list
find_user(conn :: Plug.Conn.t()) :: {Plug.Conn.t(), struct() | nil}
Extract (early) the user from the HTTP request (http authentification, cookies/session, …).
Returns a tuple of the form {conn, user}
with user being nil
if no user could be found at
this early stage.
Check if the user is in a valid state. This callback is intended to let know others plugins if we should reject the login (and why).
Returns false
if the user is allowed to login else {:error, reason}
where reason is a string,
an informative to be directly served to the end user.
For example, you may want to have some kind of ban plugin. This is the way to decline the login:
def invalid?(%{banned: true}), do: {:error, :banned} # or: {:error, dgettext("myapp", "you're banned")}
def invalid?(%{banned: _}), do: false
on_email_change(multi :: Ecto.Multi.t(), changeset :: Ecto.Changeset.t()) :: {Ecto.Multi.t(), Ecto.Changeset.t()}
This callback is invoked when a user is editing its registration and change its email address.
It is a facility (subset) to avoid you to handle it by yourself via validate_update_registration/1
.
It returns a tuple of {Ecto.Multi, Ecto.Changeset}
, same as its arguments, to permit to the
callback to add any operation to multi or change to changeset.
This callback is called before updating the user but the actions added to multi will be run after its update.
Invoked when an authentification failed (wrong password). It receives the concerned account and a Keyword to return after updating it if any change have to be done to this user.
For example, you can use it as follows to count the number of failed attempts to login:
def on_failed_authentification(user = %_{}, keyword) do
Keyword.put(keyword, :failed_attempts, user.failed_attempts + 1)
end
Note: we choose to use and pass keyword as an accumulator to let the possibility to plugins
to deal themselves on a conflict (several different plugins which want to alter a same field).
Even if Keyword
allows a same key to be defined several times, you’ll probably don’t want it
to happen as the last defined value for a given key will (silently) override the others.
This callback is invoked when a user (manually) log out. Its purpose is mainly to do some cleanup like removing a cookie.
on_registration(multi :: Ecto.Multi.t()) :: Ecto.Multi.t()
Invoked to accomplish a task right after user’s registration (insert). This callback allows you to do some linked changes to the database, send an email or whatever by appending it to multi.
Remember to comply to Ecto.Multi
functions. In particular Ecto.Multi.run
: the function
called by it have to return {:ok, your value}
or {:error, your value}
. Also note that
the inserted user will be passed to the function called by Ecto.Multi.run
as the :user
key to the map received by the last one as its (only) argument.
The following example illustrate how to send a welcome mail:
def on_registration(multi = %Ecto.Multi{}) do
multi
|> Ecto.Multi.run(:send_welcome_email, fn %{user: user} ->
send_welcome_email_to(user)
{:ok, :success}
end)
end
on_successful_authentification( conn :: Plug.Conn.t(), user :: struct(), keywords :: Keyword.t() ) :: {Plug.Conn.t(), struct(), Keyword.t()}
Invoked when an authentification is successful. Like on_failed_authentification/2
, it receives
the current user and a Keyword to return after updating it if you want to bring any change to this
user to the database.
To continue our example with a failed attempts counter, on a successful authentification it may be a good idea to reset it in this scenario:
def on_successful_authentification(conn = %Plug.Conn{}, user = %_{}, keywords) do
{conn, user, Keyword.put(keywords, :failed_attempts, 0)}
end
Returns the routes as a quoted fragment to be injected in application’s Router
validate_create_registration(changeset :: Ecto.Changeset.t()) :: Ecto.Changeset.t()
This callback let you do any kind of change or additionnal validation on the changeset when a user is registering.
validate_update_registration(changeset :: Ecto.Changeset.t()) :: Ecto.Changeset.t()
Same as validate_create_registration
but registration’s edition as logic between the two
may be completely different.