geonature.core.gn_permissions.admin

Module Contents

Classes

RoleFilter	Base SQLAlchemy filter.
ModuleFilter	Base SQLAlchemy filter.
ObjectFilter	Base SQLAlchemy filter.
ActionFilter	Base SQLAlchemy filter.
ScopeFilter	Base SQLAlchemy filter.
OptionSelect2Widget	Select2 styled select widget.
OptionQuerySelectField	Overrides the QuerySelectField class from flask admin to allow
UserAjaxModelLoader	Ajax related model loader. Override this to implement custom loading behavior.
ObjectAdmin	SQLAlchemy model view
PermissionAdmin	SQLAlchemy model view
PermissionAvailableAdmin	SQLAlchemy model view
RolePermAdmin	SQLAlchemy model view
GroupPermAdmin	SQLAlchemy model view
UserPermAdmin	SQLAlchemy model view

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)
permissions_formatter(view, context, model, name)
permissions_count_formatter(view, context, model, name)

class geonature.core.gn_permissions.admin.RoleFilter(column, name, options=None, data_type=None)

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

Base SQLAlchemy filter.

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ModuleFilter(column, name, options=None, data_type=None)

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

Base SQLAlchemy filter.

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ObjectFilter(column, name, options=None, data_type=None)

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

Base SQLAlchemy filter.

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ActionFilter(column, name, options=None, data_type=None)

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

Base SQLAlchemy filter.

get_dynamic_options(view)

class geonature.core.gn_permissions.admin.ScopeFilter(column, name, options=None, data_type=None)

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

Base SQLAlchemy filter.

apply(query, value, alias=None)

Apply search criteria to the query and return new query.

Paramètres:

• query – Query

• value – Search criteria

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.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(multiple=False)

Bases: flask_admin.form.widgets.Select2Widget

Select2 styled select widget.

You must include select2.js, form-x.x.x.js and select2 stylesheet for it to work.

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

iter_choices()

Provides data for choice widget rendering. Must return a sequence or iterable of (value, label, selected, render_kw) tuples.

class geonature.core.gn_permissions.admin.UserAjaxModelLoader(name, session, model, **options)

Bases: flask_admin.contrib.sqla.ajax.QueryAjaxModelLoader

Ajax related model loader. Override this to implement custom loading behavior.

format(user)

Return (id, name) tuple from the model.

get_query()

class geonature.core.gn_permissions.admin.ObjectAdmin(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

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

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

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(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

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

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

module_code = 'ADMIN'

object_code = 'PERMISSIONS'

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

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')

form_overrides

form_args

create_template = 'admin/hide_select2_options_create.html'

edit_template = 'admin/hide_select2_options_edit.html'

form_ajax_refs

render(template, **kwargs)

Render template

Paramètres:

• template – Template path to render

• kwargs – Template arguments

create_form()

Instantiate model creation form and return it.

Override to implement custom behavior.

class geonature.core.gn_permissions.admin.PermissionAvailableAdmin(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

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

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

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')

class geonature.core.gn_permissions.admin.RolePermAdmin(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

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

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

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

class geonature.core.gn_permissions.admin.GroupPermAdmin(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

Bases: RolePermAdmin

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

column_list = ('nom_role', 'permissions_count')

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

get_query()

Return a query for the model type.

This method can be used to set a « persistent filter » on an index_view.

Example:

class MyView(ModelView):
    def get_query(self):
        return super(MyView, self).get_query().filter(User.username == current_user.username)

If you override this method, don’t forget to also override get_count_query, for displaying the correct item count in the list view, and get_one, which is used when retrieving records for the edit view.

get_count_query()

Return a the count query for the model type

A query(self.model).count() approach produces an excessive subquery, so query(func.count('*')) should be used instead.

See commit #45a2723 for details.

class geonature.core.gn_permissions.admin.UserPermAdmin(model, session, name=None, category=None, endpoint=None, url=None, static_folder=None, menu_class_name=None, menu_icon_type=None, menu_icon_value=None)

Bases: RolePermAdmin

SQLAlchemy model view

Usage sample:

admin = Admin()
admin.add_view(ModelView(User, db.session))

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()

Return a query for the model type.

This method can be used to set a « persistent filter » on an index_view.

Example:

class MyView(ModelView):
    def get_query(self):
        return super(MyView, self).get_query().filter(User.username == current_user.username)

If you override this method, don’t forget to also override get_count_query, for displaying the correct item count in the list view, and get_one, which is used when retrieving records for the edit view.

get_count_query()

Return a the count query for the model type

A query(self.model).count() approach produces an excessive subquery, so query(func.count('*')) should be used instead.

See commit #45a2723 for details.