CMS

• Constants
  • Administrative Division
  • All Day
  • Allowed Media
  • Countries
  • Custom Translations
  • Duplicate Pbo Behaviors
  • Events Time Range
  • Feedback Ratings
  • Feedback Read Status
  • Frequency
  • Language Color
  • Linkcheck
  • Machine Translation Permissions
  • Machine Translation Providers
  • Matomo Periods
  • Mirrored Page First
  • Months
  • Opening Hours
  • POIcategory
  • Position
  • Postal Code
  • Push Notifications
  • Recurrence
  • Region Status
  • Roles
  • Status
  • Text Directions
  • Translation Status
  • Weekdays
  • Weeks
• Forms
  • Chat
    • Chat Message Form
  • Contacts
    • Contact Form
  • Events
    • Event Filter Form
    • Event Form
    • Event Translation Form
    • External Calendar Form
    • Recurrence Rule Form
  • Feedback
    • Admin Feedback Filter Form
    • Region Feedback Filter Form
  • Imprint
    • Imprint Translation Form
  • Language Tree
    • Language Tree Node Form
  • Languages
    • Language Form
  • Media
    • Create Directory Form
    • Directory Form
    • Media File Form
    • Media Move Form
    • Replace Media File Form
    • Upload Media File Form
  • Offer Templates
    • Offer Template Form
  • Organizations
    • Organization Form
  • Pages
    • Mirrored Page Field Widget
    • Page Filter Form
    • Page Form
    • Page Translation Form
    • Parent Field Widget
  • POI Categories
    • POI Category Form
    • POI Category Translation Form
  • POIs
    • POI Form
    • POI Translation Form
  • Push Notifications
    • Push Notification Form
    • Push Notification Translation Form
  • Regions
    • Region Form
  • Roles
    • Group Form
    • Role Form
  • Statistics
    • Statistics Filter Form
  • Translations
    • Translations Management Form
  • Users
    • Authentication Form
    • Organization Field
    • Password Reset Form
    • Passwordless Authentication Form
    • Region User Form
    • User Email Form
    • User Filter Form
    • User Form
    • User Password Form
    • User Preferences Form
  • Custom Content Model Form
  • Custom Filter Form
  • Custom Model Form
  • Custom Tree Node Form
  • Icon Widget
  • Machine Translation Form
  • Object Search Form
• Models
  • Chat
    • Attachment Map
    • Chat Message
    • User Chat
  • Events
    • Event
    • Event Translation
    • Recurrence Rule
  • External Calendars
    • External Calendar
  • Feedback
    • Event Feedback
    • Event List Feedback
    • Feedback
    • Imprint Page Feedback
    • Map Feedback
    • Offer Feedback
    • Offer List Feedback
    • Page Feedback
    • POI Feedback
    • Region Feedback
    • Search Result Feedback
  • Firebase
    • Firebase Statistic
  • Languages
    • Language
    • Language Tree Node
  • Media
    • Directory
    • Media File
  • Offers
    • Offer Template
  • Pages
    • Abstract Base Page
    • Abstract Base Page Translation
    • Imprint Page
    • Imprint Page Translation
    • Page
    • Page Translation
  • POI Categories
    • POI Category
    • POI Category Translation
  • POIs
    • POI
    • POI Translation
  • Push Notifications
    • Push Notification
    • Push Notification Translation
  • Regions
    • Region
  • Users
    • Organization
    • Role
    • User
    • User Fido Key
  • Abstract Base Model
  • Abstract Content Model
  • Abstract Content Translation
  • Abstract Tree Node
  • Decorators
• Templatetags
  • Arithmetic
  • Base Filters
  • Content Filters
  • Form Icon Filters
  • Linkcheck Filters
  • Model Tags
  • Page Filters
  • Parse Struct Time
  • PDF Filters
  • POI Filters
  • Push Notification Filters
  • Settings Tags
  • Svg Tags
  • Tagifnotempty
  • Text Filters
  • Tree Filters
  • Url Tags
  • User Filters
• Urls
  • Protected
  • Public
• Utils
  • Account Activation Token Generator
  • Content Edit Lock
  • Content Translation Utils
  • Content Utils
  • Email Utils
  • External Calendar Utils
  • File Utils
  • Internal Link Checker
  • Internal Link Utils
  • Link Utils
  • Linkcheck Utils
  • Media Utils
  • MFA Utils
  • PDF Utils
  • Repair Tree
  • Round Hix Score
  • Shadow Instance
  • Slug Utils
  • Stringify List
  • Text Utils
  • Tinymce Icon Utils
  • Totp Utils
  • Translation Utils
  • User Utils
  • Welcome Mail Utils
• Views
  • 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 View
    • 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
  • Bulk Action Views
  • Content Version View
  • Delete Views
  • Form Views
  • List Views
  • Mixins

Admin

Debug lists and forms for all models

Apps

class integreat_cms.cms.apps.CmsConfig(app_name, app_module)

Bases: AppConfig

This class represents the Django-configuration of the backend.

See django.apps.AppConfig for more information.

Parameters:

name – The name of the app

name: Final[str] = 'integreat_cms.cms'

Full Python path to the application

ready() → None

Monkeypatch the checking of internal URLs

Return type:

None

verbose_name: Final[Promise] = 'CMS'

Human-readable name for the application

Auth

class integreat_cms.cms.auth.WPBCryptPasswordHasher

Bases: BCryptSHA256PasswordHasher

A PHP (and WordPress) compatible BCrypt password hasher that supports hashes with $2y$10$. See https://www.php.net/manual/en/function.password-hash.php. For PHP style hashes only verification is supported.

verify(password: str, encoded: str) → bool

Validate that entered password matches stored hash

Parameters:

• password (str) – the plain text password

• encoded (str) – the hashed and salted password, i.e. from database

Returns:

entered password matches the hash

Return type:

bool

Decorators

Django view decorators can be used to restrict the execution of a view function on certain conditions.

For more information, see View decorators.

integreat_cms.cms.decorators.modify_mfa_authenticated(function: Callable) → Callable

This decorator can be used to make sure a user can only modify his 2FA settings when he has a valid 2FA session.

Parameters:

function (Callable) – The view function which should be protected

Returns:

The decorated function

Return type:

Callable

integreat_cms.cms.decorators.permission_required(permission: str) → Callable

Decorator for views that checks whether a user has a particular permission enabled. If not, the PermissionDenied exception is raised.

Parameters:

permission (str) – The required permission

Returns:

The decorated function

Return type:

Callable

integreat_cms.cms.decorators.region_permission_required(function: Callable) → Callable

This decorator can be used to make sure a view can only be retrieved by users of the requested region.

Parameters:

function (Callable) – The view function which should be protected

Returns:

The decorated function

Return type:

Callable

Linklists

class integreat_cms.cms.linklists.ActiveLanguageLinklist

Bases: Linklist

Base class for content translation link lists

classmethod filter_callable(objects: QuerySet) → QuerySet

Get only translations in active languages

Parameters:

objects (QuerySet) – Objects to be filtered

Returns:

Objects that passed the filter

Return type:

QuerySet

class integreat_cms.cms.linklists.EventTranslationLinklist

Bases: NonArchivedLinkList

Class for selecting the EventTranslation model for link checks

classmethod filter_callable(objects: QuerySet) → QuerySet

Get only translations of upcoming events in active languages

Parameters:

objects (QuerySet) – Objects to be filtered

Returns:

Objects that passed the filter

Return type:

QuerySet

model

alias of EventTranslation

class integreat_cms.cms.linklists.ImprintTranslationLinklist

Bases: ActiveLanguageLinklist

Class for selecting the ImprintPageTranslation model for linkchecks

model

alias of ImprintPageTranslation

class integreat_cms.cms.linklists.NonArchivedLinkList

Bases: ActiveLanguageLinklist

Class for excluding archived events and locations

classmethod filter_callable(objects: QuerySet) → QuerySet

Get only latest translations for non-archived events/locations in active languages

Parameters:

objects (QuerySet) – Objects to be filtered

Returns:

Objects that passed the filter

Return type:

QuerySet

class integreat_cms.cms.linklists.OrganizationLinklist

Bases: Linklist

Class for selecting the Organization model for link checks

model

alias of Organization

class integreat_cms.cms.linklists.POITranslationLinklist

Bases: NonArchivedLinkList

Class for selecting the POITranslation model for link checks

model

alias of POITranslation

class integreat_cms.cms.linklists.PageTranslationLinklist

Bases: ActiveLanguageLinklist

Class for selecting the PageTranslation model for link checks

classmethod filter_callable(objects: QuerySet) → QuerySet

Get only latest versions for non-archived pages in active languages

Parameters:

objects (QuerySet) – Objects to be filtered

Returns:

Objects that passed the filter

Return type:

QuerySet

model

alias of PageTranslation

Rules

We use django-rules to add custom permissions for specific pages.

For a given user and page, the following permissions are added:

• ~integreat_cms.cms.edit_page if one of the following predicates return true:

  • can_edit_all_pages()

  • is_page_author()

  • can_publish_all_pages()

  • is_page_editor()

• ~integreat_cms.cms.publish_page_object if one of the following predicates return true:

  • can_publish_all_pages()

  • is_page_editor()

See the project’s README to learn more.

integreat_cms.cms.rules.is_page_author(user: User, page: Page | None) → bool

This predicate checks whether the given user is one of the authors of the given page.

Parameters:

• user (User) – The user who’s permission should be checked

• page (Page | None) – The requested page

Returns:

Whether or not user is an author of page

Return type:

bool

integreat_cms.cms.rules.is_page_editor(user: User, page: Page | None) → bool

This predicate checks whether the given user is one of the editors of the given page.

Parameters:

• user (User) – The user who’s permission should be checked

• page (Page | None) – The requested page

Returns:

Whether or not user is an editor of page

Return type:

bool

integreat_cms.cms.rules.can_edit_all_pages(user: User, page: Page | None) → bool

This predicate checks whether the given user can edit all pages.

Parameters:

• user (User) – The user who’s permission should be checked

• page (Page | None) – The page parameter is used for the region check

Returns:

Whether or not user can edit all pages

Return type:

bool

integreat_cms.cms.rules.can_publish_all_pages(user: User, page: Page | None) → bool

This predicate checks whether the given user can publish all pages.

Parameters:

• user (User) – The user who’s permission should be checked

• page (Page | None) – The page parameter is used for the region check

Returns:

Whether or not user can publish all pages

Return type:

bool

integreat_cms.cms.rules.is_in_responsible_organization(user: User, page: Page | None) → bool

This predicate checks whether the given user is a member of the page’s responsible organization.

Parameters:

• user (User) – The user who’s permission should be checked

• page (Page | None) – The requested page

Returns:

Whether or not user is a member of page.organization

Return type:

bool

integreat_cms.cms.rules.can_delete_chat_message(user: User, chat_message: ChatMessage) → bool

This predicate checks whether the given user can delete a given chat message

Parameters:

• user (User) – The user who’s permission should be checked

• chat_message (ChatMessage) – The requested chat message

Returns:

Whether or not user is allowed to delete chat_message

Return type:

bool