geonature.core.gn_permissions.admin

Classes

RoleFilter
ModuleFilter
ObjectFilter
ActionFilter
ScopeFilter
OptionSelect2Widget
OptionQuerySelectField	Overrides the QuerySelectField class from flask admin to allow
UserAjaxModelLoader
AreaAjaxModelLoader
TaxrefAjaxModelLoader
ObjectAdmin
PermissionAdmin
PermissionAvailableAdmin
RolePermAdmin
GroupPermAdmin
UserPermAdmin

Functions

filters_formatter(v, c, m, p)
modules_formatter(view, context, model, name)
groups_formatter(view, context, model, name)
role_formatter(view, context, model, name)
list_permissions_formatter(permissions, ...)	Render a list of permissions for module-object-action item as an HTML table.
permissions_formatter(view, context, model, name)
permissions_count_formatter(view, context, model, name)

Module Contents

class geonature.core.gn_permissions.admin.RoleFilter

Bases: geonature.core.admin.utils.DynamicOptionsMixin, flask_admin.contrib.sqla.filters.FilterEqual

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ModuleFilter

Bases: geonature.core.admin.utils.DynamicOptionsMixin, flask_admin.contrib.sqla.filters.FilterEqual

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ObjectFilter

Bases: geonature.core.admin.utils.DynamicOptionsMixin, flask_admin.contrib.sqla.filters.FilterEqual

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ActionFilter

Bases: geonature.core.admin.utils.DynamicOptionsMixin, flask_admin.contrib.sqla.filters.FilterEqual

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ScopeFilter

Bases: geonature.core.admin.utils.DynamicOptionsMixin, flask_admin.contrib.sqla.filters.FilterEqual

apply(query, value, alias=None)

get_dynamic_options(view)

geonature.core.gn_permissions.admin.filters_formatter(v, c, m, p)

geonature.core.gn_permissions.admin.modules_formatter(view, context, model, name)

geonature.core.gn_permissions.admin.groups_formatter(view, context, model, name)

geonature.core.gn_permissions.admin.role_formatter(view, context, model, name)

geonature.core.gn_permissions.admin.list_permissions_formatter(permissions, available_permission, managable, current_user, return_url)

Render a list of permissions for module-object-action item as an HTML table.

This function generates an HTML table that displays permissions associated to specific

module, object, or action. Each permission is rendered with its status, expiration

date, and associated filters. If the permissions are manageable, edit and delete options are included for each permission.

Parameters

permissionslist[Permission]

A list of permission objects to be rendered.

available_permissionPermissionAvailable

the permission template.

managablebool

A boolean indicating whether the permissions are manageable. If True, edit and delete options will be included in the rendered HTML.

modelUser

current user

return_urlstr

The URL to return to after performing an action (e.g., editing or deleting a permission).

Returns

str

An HTML string representing the permissions table.

Notes

The function uses Bootstrap classes for styling the table and its elements. If a permission has filters, they are displayed as a list within the table cell. If a permission is not active, it is marked with a “table-secondary” class and a “text-danger” class for the expiration date. If a permission is active but has an expiration date, it is marked with a “text-success” class for the expiration date.

geonature.core.gn_permissions.admin.permissions_formatter(view, context, model, name)

geonature.core.gn_permissions.admin.permissions_count_formatter(view, context, model, name)

class geonature.core.gn_permissions.admin.OptionSelect2Widget

Bases: flask_admin.form.widgets.Select2Widget

classmethod render_option(value, label, options)

class geonature.core.gn_permissions.admin.OptionQuerySelectField(*args, **kwargs)

Bases: flask_admin.contrib.sqla.fields.QuerySelectField

Overrides the QuerySelectField class from flask admin to allow other attributes on a select option.

options_additional_values is added in form_args, it is a list of strings, each element is the name of the attribute in the model which will be added on the option

widget

options_additional_values

iter_choices()

class geonature.core.gn_permissions.admin.UserAjaxModelLoader

Bases: flask_admin.contrib.sqla.ajax.QueryAjaxModelLoader

format(user)

Instead of returning a list of tuple (id, label), we return a list of tuple (id, label, excluded_availabilities). The third element of each tuple is the list of type of permissions the user already have, so it is useless to add this permission to the user, and they will be not available in the front select. Two remarks: - We only consider active permissions of the user - If the type of the permission allows two or more filters, we do not exclude it as it makes sens to add several

permissions of the same type with differents set of filters.

get_query()

class geonature.core.gn_permissions.admin.AreaAjaxModelLoader

Bases: flask_admin.contrib.sqla.ajax.QueryAjaxModelLoader

format(area)

get_one(pk)

get_query()

class geonature.core.gn_permissions.admin.TaxrefAjaxModelLoader

Bases: flask_admin.contrib.sqla.ajax.QueryAjaxModelLoader

format(taxref)

get_query()

get_one(pk)

class geonature.core.gn_permissions.admin.ObjectAdmin

Bases: geonature.core.admin.utils.CruvedProtectedMixin, flask_admin.contrib.sqla.ModelView

module_code = 'ADMIN'

object_code = 'PERMISSIONS'

can_create = False

can_edit = False

can_delete = False

column_list = ('code_object', 'description_object', 'modules')

column_labels

column_default_sort = 'id_object'

column_formatters

class geonature.core.gn_permissions.admin.PermissionAdmin

Bases: geonature.core.admin.utils.CruvedProtectedMixin, flask_admin.contrib.sqla.ModelView

module_code = 'ADMIN'

object_code = 'PERMISSIONS'

column_list = ('role', 'module', 'object', 'action', 'label', 'filters', 'expire_on')

column_labels

column_select_related_list = ('availability',)

column_searchable_list = ('role.identifiant', 'role.nom_complet')

column_formatters

column_filters

named_filter_urls = True

column_sortable_list = (('role', 'role.nom_complet'), ('module', 'module.module_code'), ('object',...

column_default_sort = [('role.nom_complet', False), ('module.module_code', False), ('object.code_object', False),...

form_columns = ('role', 'availability', 'scope', 'sensitivity_filter', 'areas_filter', 'taxons_filter', 'expire_on')

form_overrides

form_args

create_template = 'admin/hide_select2_options_create.html'

edit_template = 'admin/hide_select2_options_edit.html'

form_ajax_refs

get_query()

get_count_query()

render(template, **kwargs)

create_form()

class geonature.core.gn_permissions.admin.PermissionAvailableAdmin

Bases: geonature.core.admin.utils.CruvedProtectedMixin, flask_admin.contrib.sqla.ModelView

module_code = 'ADMIN'

object_code = 'PERMISSIONS'

can_create = False

can_delete = False

can_export = False

column_labels

column_formatters

column_sortable_list = (('module', 'module.module_code'), ('object', 'object.code_object'), ('action', 'action.code_action'))

column_filters

column_default_sort = [('module.module_code', False), ('object.code_object', False), ('id_action', False)]

form_columns = ('scope_filter', 'sensitivity_filter', 'areas_filter', 'taxons_filter')

class geonature.core.gn_permissions.admin.RolePermAdmin

Bases: geonature.core.admin.utils.CruvedProtectedMixin, flask_admin.contrib.sqla.ModelView

module_code = 'ADMIN'

object_code = 'PERMISSIONS'

can_create = False

can_edit = False

can_delete = False

can_export = False

can_view_details = True

details_template = 'role_or_group_detail.html'

column_select_related_list = ('permissions',)

column_labels

column_searchable_list = ('identifiant', 'nom_complet')

column_formatters

column_formatters_detail

get_query()

get_count_query()

class geonature.core.gn_permissions.admin.GroupPermAdmin

Bases: RolePermAdmin

column_list = ('nom_role', 'permissions_count')

column_details_list = ('nom_role', 'permissions_count', 'permissions')

get_query()

get_count_query()

class geonature.core.gn_permissions.admin.UserPermAdmin

Bases: RolePermAdmin

column_list = ('identifiant', 'nom_role', 'prenom_role', 'groups', 'permissions_count')

column_labels

column_details_list = ('identifiant', 'nom_role', 'prenom_role', 'groups', 'permissions_count', 'permissions')

get_query()

get_count_query()