Views

This package contains all views for the cms. Use Class-based views whenever possible. Before writing a view completely from scratch, have a look at the Built-in class-based views API and check whether anything meets your requirements.

• Analytics
  • App Size View
  • Translation Coverage View
• Authentication
  • Webauthn
    • Webauthn Assert View
    • Webauthn Login View
    • Webauthn Verify View
  • Account Activation View
  • Login View
  • Logout View
  • Password Reset Confirm View
  • Password Reset View
  • Passwordless Login View
  • Totp Login View
• Chat
  • Chat Actions
  • Chat Context Mixin
• Contacts
  • Contact Actions
  • Contact Bulk Actions
  • Contact Context Mixin
  • Contact Form Ajax View
  • Contact Form View
  • Contact From Existing Data
  • Contact List View
• Dashboard
  • Admin Dashboard View
  • Dashboard View
  • Region Selection
• Error Handler
  • Error Handler
• Events
  • Event Actions
  • Event Context Mixin
  • Event Form View
  • Event List View
  • Event Version View
• External Calendars
  • External Calendar Actions
  • External Calendar Form View
  • External Calendar List View
• Feedback
  • Admin Feedback Actions
  • Admin Feedback List View
  • Feedback Resource
  • Region Feedback Actions
  • Region Feedback List View
• Imprint
  • Imprint Actions
  • Imprint Context Mixin
  • Imprint Form View
  • Imprint Sbs View
  • Imprint Version View
• Language Tree
  • Language Tree Actions
  • Language Tree Bulk Actions
  • Language Tree Context Mixin
  • Language Tree Node Form View
  • Language Tree View
• Linkcheck
  • Link Replace View
  • Linkcheck List View
  • Linkcheck Redirect View
  • Linkcheck Stats View
• Media
  • Media Actions
  • Media Context Mixin
  • Media List View
• Organizations
  • Organization Actions
  • Organization Bulk Actions
  • Organization Content Mixin
  • Organization Form View
  • Organization List View
• Pages
  • Page Actions
  • Page Bulk Actions
  • Page Context Mixin
  • Page Form View
  • Page Permission Actions
  • Page Sbs View
  • Page Tree View
  • Page Version View
  • Page XLIFF Import View
  • Partial Page Tree View
• POI Categories
  • POI Category Form View
• POIs
  • POI Actions
  • POI Context Mixin
  • POI Form Ajax View
  • POI Form View
  • POI List View
  • POI Version View
• Push Notifications
  • Push Notification Form View
  • Push Notification List View
• Region Condition
  • Region Condition Actions
  • Region Condition View
• Regions
  • Region Actions
  • Region List View
  • Region Update View
• Release Notes
  • Release Notes Context Mixin
  • Release Notes View
• Roles
  • Role Form View
• Settings
  • Webauthn
    • Authenticate Modify MFA View
    • Delete User Fido Key View
    • Get MFA Challenge View
    • Register User Fido Key View
  • Dismiss Tutorial View
  • Totp Delete View
  • Totp Register View
  • User Settings View
• Statistics
  • Statistics Actions
  • Statistics View
• Translations
  • Translations Management View
• Users
  • Region User Actions
  • Region User Form View
  • Region User List View
  • User Actions
  • User Form View
  • User List View
• Utils
  • Contact Utils
  • Content Edit Lock
  • Hix
  • Machine Translations
  • Publication Status
  • Search Content Ajax
  • Slugify Ajax
  • Translation Coverage

Bulk Action Views

This module contains the base view for bulk actions

Warning

Any action modifying the database with treebeard should use @tree_mutex(MODEL_NAME) from integreat_cms.cms.utils.tree_mutex as a decorator instead of @transaction.atomic to force treebeard to actually use transactions. Otherwise, the data WILL get corrupted during concurrent treebeard calls!

class integreat_cms.cms.views.bulk_action_views.BulkActionView(**kwargs)

Bases: PermissionRequiredMixin, MultipleObjectMixin, RedirectView

View for executing a bulk action and redirect to a given location

get_extra_filters() → Q

Get extra filters for get_queryset(). Overwrite this method to specify needed filters e.g. as in ~integreat_cms.cms.views.contact.contact_bulk_actions

Returns:

Q Object to be used as filter argument

Return type:

Q

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_queryset() → Any

Get the queryset of selected items for this bulk action

Raises:

Http404 – HTTP status 404 if no objects with the given ids exist

Returns:

The QuerySet of the filtered links

Return type:

Any

get_redirect_url(*args: Any, **kwargs: Any) → str

Retrieve url for redirection

Parameters:

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

url to redirect to

Return type:

str

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. The bulk action form uses only POST as submission method.

prefetch_public_translations: bool = False

Whether the public translation objects should be prefetched

prefetch_translations: bool = False

Whether the translation objects should be prefetched

require_change_permission: bool = True

Whether the view requires change permissions

class integreat_cms.cms.views.bulk_action_views.BulkArchiveView(**kwargs)

Bases: BulkActionView

Bulk action for restoring multiple objects at once

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Archive multiple objects

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponseRedirect

class integreat_cms.cms.views.bulk_action_views.BulkDraftingView(**kwargs)

Bases: BulkActionView

Bulk action to draft multiple pages at once

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Function to change the translation status to draft of multiple pages at once

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponse

class integreat_cms.cms.views.bulk_action_views.BulkMachineTranslationView(**kwargs)

Bases: BulkActionView

Bulk action for automatically translating multiple objects

form: ModelForm | None = None

the form of this bulk action

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Translate multiple objects automatically

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponseRedirect

prefetch_translations: bool = True

Whether the public translation objects should be prefetched

class integreat_cms.cms.views.bulk_action_views.BulkPublishingView(**kwargs)

Bases: BulkActionView

Bulk action to publish multiple pages at once

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Function to change the translation status to publish of multiple pages at once

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponse

class integreat_cms.cms.views.bulk_action_views.BulkRestoreView(**kwargs)

Bases: BulkActionView

Bulk action for restoring multiple objects at once

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Restore multiple objects

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponseRedirect

class integreat_cms.cms.views.bulk_action_views.BulkUpdateBooleanFieldView(**kwargs)

Bases: BulkActionView

Bulk action for toggling boolean fields of multiple objects at once

property action: str

Called when the bulk action is performed and the action attribute was not overwritten

Raises:

NotImplementedError – If the action attribute is not implemented in the subclass

property field_name: str

Called when the bulk action is performed and the field_name attribute was not overwritten

Raises:

NotImplementedError – If the field_name attribute is not implemented in the subclass

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Update the fields of the selected objects and redirect

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Returns:

The redirect

Return type:

HttpResponseRedirect

value: bool = True

The value of the field (defaults to True)

Content Version View

class integreat_cms.cms.views.content_version_view.ContentVersionView(**kwargs)

Bases: PermissionRequiredMixin, SingleObjectMixin, TemplateView

View for browsing the content versions and restoring old content versions

back_to_form_label: Promise = 'Back to the form'

The label of the “back to form” button

dispatch(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect | TemplateResponse

Validate the versions view

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

PermissionDenied – If user does not have the permission to edit the specific page

Returns:

The rendered template response

Return type:

HttpResponseRedirect | TemplateResponse

property edit_url: str

The url to the form in the current language

Returns:

The edit url

get_context_data(**kwargs: Any) → dict[str, Any]

Get revision context data

Returns:

The context dictionary

Parameters:

kwargs (Any)

Return type:

dict[str, Any]

get_queryset()

Filter the content objects by the current region

Raises:

Http404 – HTTP status 404 if the content is not found

Returns:

The rendered template response

Return type:

ContentQuerySet | (EventQuerySet | PageQuerySet)

has_change_permission() → bool

Whether the user has the permission to change objects

Returns:

Whether the user can change objects

Return type:

bool

has_permission() → bool

Override django.contrib.auth.mixins.PermissionRequiredMixin.has_permission()

Returns:

Whether the current user can access this view

Return type:

bool

has_publish_permission() → bool

Whether the user has the permission to publish objects

Returns:

Whether the user can publish objects

Return type:

bool

has_view_permission() → bool

Whether the user has the permission to change objects

Returns:

Whether the user can change objects

Return type:

bool

language: Language | None = None

The current language

model: ModelBase | None = None

The current content model (see SingleObjectMixin)

property model_name: str

The name of this model

Returns:

The name of this model

object: AbstractContentModel | None = None

The current content object (see SingleObjectMixin)

property pk_url_kwarg: str

The name of the URLConf keyword argument that contains the primary key. By default, pk_url_kwarg is ‘pk’. See django.views.generic.detail.SingleObjectMixin.pk_url_kwarg.

Returns:

The name of URL kwarg of the id

post(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponseRedirect

Restore a previous revision of a page translation

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

PermissionDenied – If user does not have the permission to edit the specific page

Returns:

The rendered template response

Return type:

HttpResponseRedirect

restore_version(restored_version: Any) → None

Restore the given version

Parameters:

restored_version (Any) – The version which should be restored

Return type:

None

selected_version: AbstractContentTranslation | None = None

The currently selected translation version

template_name: str = 'content_versions.html'

The template to render (see TemplateResponseMixin)

translations: list[AbstractContentTranslation] = []

All translations of the content object in the current language

property versions_url: str

The url to the form in the current language

Returns:

The edit url

Delete Views

This module contains deletion views for our models that don’t need custom handling.

class integreat_cms.cms.views.delete_views.CustomDeleteView(*args, **kwargs)

Bases: CustomModelDeleteMixin, DeleteView

View for deleting an object retrieved with self.get_object()

http_method_names: list[str] = ['post']

The list of HTTP method names that this view will accept. Since we’re doing confirmation dynamically, we don’t need the get-request part of this view

class integreat_cms.cms.views.delete_views.CustomModelDeleteMixin

Bases: PermissionRequiredMixin

This mixin handles error messages in form views of subclasses of CustomModelForm

delete(request: HttpRequest, *args: Any, **kwargs: Any) → HttpResponse

Call the delete() method on the fetched object and then redirect to the success URL.

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

• **kwargs (Any) – The supplied keyword arguments

Raises:

django.db.IntegrityError – If the object has many to many relationships that prevent deletion

Returns:

A redirection to the success_url

Return type:

HttpResponse

get_permission_required() → tuple[str, ...]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str, …]

get_success_url() → str

Determine the URL to redirect to when the object is successfully deleted

Returns:

The url to redirect on success

Return type:

str

protect_manytomany: str | None = None

Whether the objects should be protected from deletion if it is used in many to many relationships

Form Views

This module contains form views for our models that don’t need custom handling.

class integreat_cms.cms.views.form_views.CustomCreateView(**kwargs)

Bases: CustomModelFormMixin, BaseCreateView

A view that displays a form for creating a region object, redisplaying the form with validation errors (if there are any) and saving the object.

class integreat_cms.cms.views.form_views.CustomModelFormMixin

Bases: PermissionRequiredMixin, ModelTemplateResponseMixin, ModelFormMixin, ModelConfirmationContextMixin, MediaContextMixin

This mixin handles error messages in form views of subclasses of CustomModelForm

form_invalid(form: CustomModelForm) → HttpResponse

Renders a response, providing the invalid form as context.

Parameters:

form (CustomModelForm) – The invalid form instance

Returns:

The rendered invalid form

Return type:

HttpResponse

form_valid(form: CustomModelForm) → HttpResponseRedirect

Saves the form instance, sets the current object for the view, and redirects to get_success_url().

Parameters:

form (CustomModelForm) – The valid form instance

Returns:

A redirection to the success url

Return type:

HttpResponseRedirect

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

get_form_kwargs() → dict[str, Any]

Return the keyword arguments for instantiating the form

Returns:

The form kwargs

Return type:

dict[str, Any]

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_success_url() → str

Determine the URL to redirect to when the form is successfully validated

Returns:

The url to redirect on success

Return type:

str

property model: ModelBase

Return the model class of this form mixin

Returns:

The corresponding Django model

template_name_suffix: str = '_form'

The suffix to append to the auto-generated candidate template name.

class integreat_cms.cms.views.form_views.CustomUpdateView(**kwargs)

Bases: CustomModelFormMixin, BaseUpdateView

A view that displays a form for editing an existing region object, redisplaying the form with validation errors (if there are any) and saving changes to the object. This uses a form automatically generated from the object’s model class (unless a form class is manually specified).

List Views

This module contains list views for our models that don’t need custom handling.

class integreat_cms.cms.views.list_views.ModelListView(**kwargs)

Bases: PermissionRequiredMixin, ModelTemplateResponseMixin, ModelConfirmationContextMixin, ListView

Render some list of objects, set by self.model or self.queryset.

property context_object_name: str

Designates the name of the variable to use in the context (see MultipleObjectMixin).

Returns:

The name of the objects in this list view

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

get_permission_required() → tuple[str]

Override this method to override the permission_required attribute.

Returns:

The permissions that are required for views inheriting from this Mixin

Return type:

tuple[str]

get_queryset() → QuerySet

Get the model’s queryset (optionally filtered by the current region)

Returns:

The queryset of the current list view

Return type:

QuerySet

property model: ModelBase

Return the model class of this list view.

Returns:

The corresponding Django model

property paginate_by: int | None

An integer specifying how many objects should be displayed per page. This either returns the current size GET parameter or the value defined in PER_PAGE. (see MultipleObjectMixin)

Returns:

The page size

Mixins

This module contains mixins for our views

class integreat_cms.cms.views.mixins.ContentEditLockMixin

Bases: ContextMixin

A mixin that provides some variables required for the content edit lock

back_url_name: str | None = None

The reverse name of the url of the associated list view

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

class integreat_cms.cms.views.mixins.MachineTranslationContextMixin

Bases: ContextMixin

This mixin provides extra context for machine translation options

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

class integreat_cms.cms.views.mixins.ModelConfirmationContextMixin

Bases: ContextMixin

A mixin that can be used to inject confirmation text into a template of a model (e.g. list or form)

get_context_data(**kwargs: Any) → dict[str, Any]

Returns a dictionary representing the template context (see get_context_data()).

Parameters:

**kwargs (Any) – The given keyword arguments

Returns:

The template context

Return type:

dict[str, Any]

class integreat_cms.cms.views.mixins.ModelTemplateResponseMixin

Bases: TemplateResponseMixin

A mixin that can be used to render a template of a model (e.g. list or form)

property template_name: str

Return the template name to be used for the request.

Returns:

The template to be rendered

class integreat_cms.cms.views.mixins.RegionPermissionRequiredMixing

Bases: UserPassesTestMixin

A mixin that can be used for class-based views that require that the user is has access to the current region of this request

test_func() → bool

The test this account has to pass

Returns:

Whether this account has passed the test

Return type:

bool