Imprint

This package contains all views related to the imprint

Imprint Actions

This module contains view actions related to the imprint.

integreat_cms.cms.views.imprint.imprint_actions.delete_imprint(request: HttpRequest, region_slug: str) → HttpResponseRedirect

Delete imprint object

Parameters:

• request (HttpRequest) – The current request

• region_slug (str) – The slug of the current region

Raises:

Http404 – If no imprint exists for the region

Returns:

A redirection to the ImprintFormView

Return type:

HttpResponseRedirect

integreat_cms.cms.views.imprint.imprint_actions.expand_imprint_translation_id(request: HttpRequest, imprint_translation_id: int) → HttpResponseRedirect | HttpResponseNotFound

Searches for an imprint translation with corresponding ID and redirects browser to web app

Parameters:

• request (HttpRequest) – The current request

• imprint_translation_id (int) – The id of the requested imprint translation

Returns:

A redirection to WEBAPP_URL

Return type:

HttpResponseRedirect | HttpResponseNotFound

Imprint Context Mixin

class integreat_cms.cms.views.imprint.imprint_context_mixin.ImprintContextMixin

Bases: ContextMixin

This mixin provides extra context for imprint views

__init__()

extra_context = None

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]

Imprint Form View

class integreat_cms.cms.views.imprint.imprint_form_view.ImprintFormView(**kwargs)

Bases: TemplateView, ImprintContextMixin, MediaContextMixin

View for the imprint page form and imprint page translation form

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = {'translation_status': <module 'integreat_cms.cms.constants.translation_status' from '/home/circleci/project/integreat_cms/cms/constants/translation_status.py'>}

The context dict passed to the template (see ContextMixin)

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

Render ImprintTranslationForm

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

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

Returns:

The rendered template response

Return type:

HttpResponse

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]

static get_side_by_side_language_options(region: Region, language: Language, imprint: ImprintPage | None) → list[dict[str, Any]]

This is a helper function to generate the side-by-side language options for both the get and post requests.

Parameters:

• region (Region) – The current region

• language (Language) – The current language

• imprint (ImprintPage | None) – The current imprint

Returns:

The list of language options, each represented by a dict

Return type:

list[dict[str, Any]]

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

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

Binds the user input data to the imprint form and validates the input. Forms containing images/files need to be additionally instantiated with the FILES attribute of request objects, see File Uploads

Parameters:

• request (HttpRequest) – Request submitted for saving imprint form

• *args (Any) – The supplied arguments

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

Returns:

Redirection to the populated imprint form

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'imprint/imprint_form.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

Imprint Sbs View

class integreat_cms.cms.views.imprint.imprint_sbs_view.ImprintSideBySideView(**kwargs)

Bases: TemplateView, ImprintContextMixin, MediaContextMixin

View for the imprint side by side form

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

content_type = None

dispatch(request, *args, **kwargs)

extra_context = None

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

Render ImprintTranslationForm on the side by side view

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

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

Raises:

Http404 – If no imprint exists for the region

Returns:

The rendered template response

Return type:

HttpResponse

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

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

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

Submit ImprintTranslationForm and save ImprintPageTranslation object

Parameters:

• request (HttpRequest) – The current request

• *args (Any) – The supplied arguments

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

Raises:

Http404 – If no imprint exists for the region

Returns:

The rendered template response

Return type:

HttpResponse

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

template_engine = None

template_name = 'imprint/imprint_sbs.html'

The template to render (see TemplateResponseMixin)

view_is_async = False

integreat_cms.cms.views.imprint.imprint_sbs_view.get_old_source_content(imprint: ImprintPage, source_language: Language, target_language: Language) → str

This function returns the content of the source language translation that was up to date when the latest (no minor edit) target language translation was created.

Parameters:

• imprint (ImprintPage) – The imprint

• source_language (Language) – The source language of the imprint

• target_language (Language) – The target language of the imprint

Returns:

The content of the translation

Return type:

str

Imprint Version View

class integreat_cms.cms.views.imprint.imprint_version_view.ImprintVersionView(**kwargs)

Bases: ImprintContextMixin, ContentVersionView

View for browsing the imprint versions and restoring old imprint versions

__init__(**kwargs)

Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.

classmethod as_view(**initkwargs)

Main entry point for a request-response process.

back_to_form_label: Promise = 'Back to the imprint form'

The label of the “back to form” button

content_type = None

context_object_name = None

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

extra_context = None

get(request, *args, **kwargs)

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

Get the name to use for the object.

get_login_url()

Override this method to override the login_url attribute.

get_object(queryset: Any | None = None) → ImprintPage

Get the current imprint object

Raises:

Http404 – HTTP status 404 if the imprint is not found

Returns:

The imprint object

Parameters:

queryset (Any | None)

Return type:

ImprintPage

get_permission_denied_message()

Override this method to override the permission_denied_message attribute.

get_permission_required()

Override this method to override the permission_required attribute. Must return an iterable.

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)

get_redirect_field_name()

Override this method to override the redirect_field_name attribute.

get_slug_field()

Get the name of a slug field to be used to look up by slug.

get_template_names()

Return a list of template names to be used for the request. Must return a list. May not be called if render_to_response() is overridden.

handle_no_permission()

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

All users who can change the imprint also can publish these changes

Returns:

Whether the user can publish the imprint

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

http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace']

http_method_not_allowed(request, *args, **kwargs)

language: Language | None = None

The current language

login_url = None

model

The current content model (see SingleObjectMixin)

Parameters:

• id (BigAutoField) – Primary key: ID

• created_date (DateTimeField) – Creation date

Relationship fields:

Parameters:

region (ForeignKey to Region) – Region (related name: imprints)

Reverse relationships:

Parameters:

translations (Reverse ForeignKey from ImprintPageTranslation) – All translations of this imprint (related name of page)

alias of ImprintPage

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)

options(request, *args, **kwargs)

Handle responding to requests for the OPTIONS HTTP verb.

permission_denied_message = ''

permission_required = None

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

query_pk_and_slug = False

queryset = None

raise_exception = False

redirect_field_name = 'next'

render_to_response(context, **response_kwargs)

Return a response, using the response_class for this view, with a template rendered with the given context.

Pass response_kwargs to the constructor of the response class.

response_class

alias of TemplateResponse

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

setup(request, *args, **kwargs)

Initialize attributes shared by all view methods.

slug_field = 'slug'

slug_url_kwarg = 'slug'

template_engine = None

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

view_is_async = False