Bonfire.Boundaries.Controlleds (Bonfire v1.0.2-social-alpha.27)

View Source

An object is linked to one or more Acls by the Controlled multimixin, which pairs an object ID with an ACL ID. Because it is a multimixin, a given object can have multiple ACLs applied. In the case of overlap, permissions are combined with false being prioritised.

The Controlled multimixin link an object to one or more ACLs. This allows for applying multiple boundaries to the same object. In case of overlapping permissions, the system combines them following the logic described in Bonfire.Boundaries.

The corresponding Ecto schema is Bonfire.Data.AccessControl.Controlled which is defined in a seperate repo.

Summary

Functions

add_acls(object, acl)

Adds the given ACL to an object.

changeset(c \\ %Controlled{}, attrs)

Returns a changeset for a Controlled with the given attributes.

create(attrs)

Creates a Controlled record with the given attributes.

get_preset_on_object(object)

Gets a preset ACL applied to an object, if any.

grant_role(subject_id, object, role, opts \\ [])

Grants a role to a subject for an object.

list_acls_on_object(object, opts \\ [])

Lists ACLs applied to an object. Only call this as an admin or curator of the object.

list_grants_by_verbs(objects, verbs, value \\ true)

Lists grants of a given verb on specified object(s).

list_objects_with_followers_grants(object_ids)

Checks which objects have grants to the followers stereotype circle.

list_on_object(object, opts \\ [])

Lists ALL boundaries (ACLs and grants) applied to an object. Only call this as an admin or curator of the object.

list_on_objects_by_subject(objects, current_user)

Lists ACLs applied to the given objects by the subject (current_user).

list_preset_acl_ids_on_object(object)

Returns the set of ACL IDs for a single object, for visibility detection.

list_preset_acl_ids_on_objects(objects)

Lists all preset ACL IDs applied to each object, for visibility detection.

list_presets_on_objects(objects)

Lists presets ACLs applied to the given objects.

list_q(opts \\ [])
list_subjects_by_verb(objects, verb, value \\ true)

Lists subjects who have been granted a given verb on specified object(s).

object_has_followers_grant?(object_id)

Checks if a single object has a grant to the followers stereotype circle.

remove_acls(object, acls)

Removes the given ACLs from an object.

remove_all_acls(object)

Functions

add_acls(object, acl)

Adds the given ACL to an object.

Examples

iex> add_acls(object, :acl)
{:ok, %Controlled{}}

changeset(c \\ %Controlled{}, attrs)

Returns a changeset for a Controlled with the given attributes.

Examples

iex> changeset(%Controlled{}, %{field: value})
%Ecto.Changeset{}

create(attrs)

Creates a Controlled record with the given attributes.

Examples

iex> create(%{field: value})
{:ok, %Controlled{}}

get_preset_on_object(object)

Gets a preset ACL applied to an object, if any.

Examples

iex> get_preset_on_object(object)
%ACL{}

grant_role(subject_id, object, role, opts \\ [])

Grants a role to a subject for an object.

Examples

iex> grant_role(subject_id, object, :editor)
{:ok, %Grant{}}

list_acls_on_object(object, opts \\ [])

Lists ACLs applied to an object. Only call this as an admin or curator of the object.

Examples

iex> list_acls_on_object(object)
[%Acl{}]

list_grants_by_verbs(objects, verbs, value \\ true)

Lists grants of a given verb on specified object(s).

Examples

iex> list_grants_by_verbs(objects, :read)

iex> list_grants_by_verbs(objects, :edit, false)

list_objects_with_followers_grants(object_ids)

Checks which objects have grants to the followers stereotype circle.

Used to distinguish Mastodon "private" (followers + mentions) from "direct" (mentions only) when an object has no preset ACLs.

Returns a MapSet of object IDs that have at least one grant targeting the followers circle.

list_on_object(object, opts \\ [])

Lists ALL boundaries (ACLs and grants) applied to an object. Only call this as an admin or curator of the object.

Examples

iex> list_on_object(object)
[%Boundary{}]

list_on_objects_by_subject(objects, current_user)

Lists ACLs applied to the given objects by the subject (current_user).

Examples

iex> list_on_objects_by_subject(objects, current_user)
%{object1_id => [%Acl{}], object2_id => [%Acl{}]}

list_preset_acl_ids_on_object(object)

Returns the set of ACL IDs for a single object, for visibility detection.

list_preset_acl_ids_on_objects(objects)

Lists all preset ACL IDs applied to each object, for visibility detection.

Unlike list_presets_on_objects/1 which returns one "best" ACL per object, this returns the full set of ACL IDs, enabling set-based visibility matching (e.g., distinguishing "public" from "unlisted" by checking for remote interaction ACLs).

Returns %{object_id => MapSet.t(acl_id)}.

list_presets_on_objects(objects)

Lists presets ACLs applied to the given objects.

Examples

iex> list_presets_on_objects(objects)
%{object_id => %Preset{}}

list_q(opts \\ [])

list_subjects_by_verb(objects, verb, value \\ true)

Lists subjects who have been granted a given verb on specified object(s).

Examples

iex> list_subjects_by_verb(objects, :read)

iex> list_subjects_by_verb(objects, :edit, false)

object_has_followers_grant?(object_id)

Checks if a single object has a grant to the followers stereotype circle.

remove_acls(object, acls)

Removes the given ACLs from an object.

Examples

iex> remove_acls(object, acls)

remove_all_acls(object)