Media

This package contains all media-related models: MediaFile and Directory

Directory

class integreat_cms.cms.models.media.directory.Directory(*args, **kwargs)

Bases: AbstractBaseModel

Model representing a directory containing documents. This is only a virtual directory and does not necessarily exist on the actual file system. Each directory is tied to a region.

Parameters:

• id (BigAutoField) – Primary key: ID

• name (CharField) – Name

• created_date (DateTimeField) – Creation date. The date and time when the directory was created

• is_hidden (BooleanField) – Hidden. Whether the directory is hidden in the regional media library

Relationship fields:

Parameters:

• region (ForeignKey to Region) – Region (related name: media_directories)

• parent (ForeignKey to Directory) – Parent directory (related name: subdirectories)

Reverse relationships:

Parameters:

• subdirectories (Reverse ForeignKey from Directory) – All subdirectories of this media directory (related name of parent)

• files (Reverse ForeignKey from MediaFile) – All files of this media directory (related name of parent_directory)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

created_date

Type: DateTimeField

Creation date. The date and time when the directory was created

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

files

Type: Reverse ForeignKey from MediaFile

All files of this media directory (related name of parent_directory)

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=True, **kwargs)

Finds next instance based on created_date. See get_next_by_FOO() for more information.

get_previous_by_created_date(*, field=<django.db.models.DateTimeField: created_date>, is_next=False, **kwargs)

Finds previous instance based on created_date. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <Directory: Directory object (id)>. It is used for logging.

Returns:

The canonical string representation of the directory

Return type:

str

id

Type: BigAutoField

Primary key: ID

is_hidden

Type: BooleanField

Hidden. Whether the directory is hidden in the regional media library

name

Type: CharField

Name

objects = <django.db.models.Manager object>

parent

Type: ForeignKey to Directory

Parent directory (related name: subdirectories)

parent_id

Internal field, use parent instead.

property pk

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

region

Type: ForeignKey to Region

Region (related name: media_directories)

region_id

Internal field, use region instead.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

classmethod search(region: Region, query: str) → QuerySet[Directory]

Searches for all directories which match the given query in their name.

Parameters:

• region (Region) – The searched region

• query (str) – The query string used for filtering the regions

Returns:

A query for all matching objects

Return type:

QuerySet[Directory]

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

serialize() → dict[str, Any]

This method creates a serialized version of that object for later use in AJAX and JSON.

Returns:

The serialized representation of the directory

Return type:

dict[str, Any]

subdirectories

Type: Reverse ForeignKey from Directory

All subdirectories of this media directory (related name of parent)

unique_error_message(model_class, unique_check)

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

Media File

This module contains the MediaFile model as well as the helper functions upload_path() and upload_path_thumbnail() which are used to determine the file system path to which the files should be uploaded.

class integreat_cms.cms.models.media.media_file.MediaFile(*args, **kwargs)

Bases: AbstractBaseModel

The MediaFile model is used to store basic information about files which are uploaded to the CMS. This is only a virtual document and does not necessarily exist on the actual file system. Each document is tied to a region via its directory.

Parameters:

• id (BigAutoField) – Primary key: ID

• file (FileField) – File

• thumbnail (FileField) – Thumbnail file

• file_size (IntegerField) – File size

• type (CharField) – File type

• name (CharField) – Name

• alt_text (CharField) – Description

• uploaded_date (DateTimeField) – Uploaded date. The date and time when the media file was uploaded

• last_modified (DateTimeField) – Last modified. The date and time when the physical media file was last modified

• is_hidden (BooleanField) – Hidden. Whether the media file is hidden in the regional media library

Relationship fields:

Parameters:

• parent_directory (ForeignKey to Directory) – Parent directory (related name: files)

• region (ForeignKey to Region) – Region (related name: files)

Reverse relationships:

Parameters:

• icon_regions (Reverse ForeignKey from Region) – All icon regions of this media file (related name of icon)

• icon_organizations (Reverse ForeignKey from Organization) – All icon organizations of this media file (related name of icon)

• pois (Reverse ForeignKey from POI) – All pois of this media file (related name of icon)

• events (Reverse ForeignKey from Event) – All events of this media file (related name of icon)

• pages (Reverse ForeignKey from Page) – All pages of this media file (related name of icon)

exception DoesNotExist

Bases: ObjectDoesNotExist

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

silent_variable_failure = True

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

exception MultipleObjectsReturned

Bases: MultipleObjectsReturned

__init__(*args, **kwargs)

add_note()

Exception.add_note(note) – add a note to the exception

args

with_traceback()

Exception.with_traceback(tb) – set self.__traceback__ to tb and return self.

__init__(*args, **kwargs)

async adelete(using=None, keep_parents=False)

alt_text

Type: CharField

Description

async arefresh_from_db(using=None, fields=None)

async asave(force_insert=False, force_update=False, using=None, update_fields=None)

classmethod check(**kwargs)

clean()

Hook for doing any extra model-wide validation after clean() has been called on every field by self.clean_fields. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field defined by NON_FIELD_ERRORS.

clean_fields(exclude=None)

Clean all fields and raise a ValidationError containing a dict of all validation errors if any occur.

content_usages

Check where this media file is embedded in the content

Returns:

list with the search result

date_error_message(lookup_type, field_name, unique_for)

delete(using=None, keep_parents=False)

events

Type: Reverse ForeignKey from Event

All events of this media file (related name of icon)

file

Type: FileField

File

file_size

Type: IntegerField

File size

classmethod from_db(db, field_names, values)

full_clean(exclude=None, validate_unique=True, validate_constraints=True)

Call clean_fields(), clean(), validate_unique(), and validate_constraints() on the model. Raise a ValidationError for any errors that occur.

get_constraints()

get_deferred_fields()

Return a set containing names of deferred fields for this instance.

classmethod get_model_name_plural() → str

Get the plural representation of this model name

Returns:

The plural model name

Return type:

str

get_next_by_last_modified(*, field=<django.db.models.DateTimeField: last_modified>, is_next=True, **kwargs)

Finds next instance based on last_modified. See get_next_by_FOO() for more information.

get_next_by_uploaded_date(*, field=<django.db.models.DateTimeField: uploaded_date>, is_next=True, **kwargs)

Finds next instance based on uploaded_date. See get_next_by_FOO() for more information.

get_previous_by_last_modified(*, field=<django.db.models.DateTimeField: last_modified>, is_next=False, **kwargs)

Finds previous instance based on last_modified. See get_previous_by_FOO() for more information.

get_previous_by_uploaded_date(*, field=<django.db.models.DateTimeField: uploaded_date>, is_next=False, **kwargs)

Finds previous instance based on uploaded_date. See get_previous_by_FOO() for more information.

get_repr() → str

This overwrites the default Django __repr__() method which would return <MediaFile: MediaFile object (id)>. It is used for logging.

Returns:

The canonical string representation of the document

Return type:

str

get_type_display(*, field=<django.db.models.CharField: type>)

Shows the label of the type. See get_FOO_display() for more information.

icon_organizations

Type: Reverse ForeignKey from Organization

All icon organizations of this media file (related name of icon)

icon_regions

Type: Reverse ForeignKey from Region

All icon regions of this media file (related name of icon)

icon_usages

Check where a media file is used as icon

Returns:

List of all objects that use this file as icon

id

Type: BigAutoField

Primary key: ID

is_deletable

Check if a media file deletable

Returns:

Whether a file is deletable

is_embedded

Check if a media file is embedded in the content

Returns:

Whether a file is embedded

is_hidden

Type: BooleanField

Hidden. Whether the media file is hidden in the regional media library

is_icon

Check if a media file is used as icon

Returns:

Whether a file is an icon

is_only_used_in_past_events

Check if a media file is used in past events only

Returns:

if a media file is only used in past events

is_used

Check if a media file is used

Returns:

Whether a file is used

last_modified

Type: DateTimeField

Last modified. The date and time when the physical media file was last modified

name

Type: CharField

Name

objects = <django.db.models.manager.ManagerFromMediaFileQuerySet object>

Django manager to access the ORM Use MediaFile.objects.all() to fetch all objects.

Custom model manager for media file objects

pages

Type: Reverse ForeignKey from Page

All pages of this media file (related name of icon)

parent_directory

Type: ForeignKey to Directory

Parent directory (related name: files)

parent_directory_id

Internal field, use parent_directory instead.

past_event_usages

Count in how many past events this file is used

Returns:

count of usages in past events

property pk

pois

Type: Reverse ForeignKey from POI

All pois of this media file (related name of icon)

prepare_database_save(field)

refresh_from_db(using=None, fields=None)

Reload field values from the database.

By default, the reloading happens from the database this instance was loaded from, or by the read router if this instance wasn’t loaded from any database. The using parameter will override the default.

Fields can be used to specify which fields to reload. The fields should be an iterable of field attnames. If fields is None, then all non-deferred fields are reloaded.

When accessing deferred fields of an instance, the deferred loading of the field will call this method.

region

Type: ForeignKey to Region

Region (related name: files)

region_id

Internal field, use region instead.

save(force_insert=False, force_update=False, using=None, update_fields=None)

Save the current instance. Override this in a subclass if you want to control the saving process.

The ‘force_insert’ and ‘force_update’ parameters can be used to insist that the “save” must be an SQL insert or update (or equivalent for non-SQL backends), respectively. Normally, they should not be set.

save_base(raw=False, force_insert=False, force_update=False, using=None, update_fields=None)

Handle the parts of saving which should be done only once per save, yet need to be done in raw saves, too. This includes some sanity checks and signal sending.

The ‘raw’ argument is telling save_base not to save any parent models and not to do any changes to the values before save. This is used by fixture loading.

classmethod search(region: Region, query: str) → QuerySet

Searches for all media files which match the given query in their name.

Parameters:

• region (Region) – The searched region

• query (str) – The query string used for filtering the media file

Returns:

A queryset for all matching objects

Return type:

QuerySet

serializable_value(field_name)

Return the value of the field name for this instance. If the field is a foreign key, return the id value instead of the object. If there’s no Field object with this name on the model, return the model attribute’s value.

Used to serialize a field’s value (in the serializer, or form output, for example). Normally, you would just access the attribute directly and not use this method.

serialize() → dict[str, Any]

This methods creates a serialized string of that document. This can later be used in the AJAX calls.

Returns:

A serialized dictionary representation of the document for JSON concatenation

Return type:

dict[str, Any]

serialize_usages() → dict[str, Any]

This methods creates a serialized dict of the file’s usages. This can later be used in the AJAX calls.

Returns:

A serialized dictionary representation of the file’s usages

Return type:

dict[str, Any]

thumbnail

Type: FileField

Thumbnail file

property thumbnail_url: str | None

Return the path of the image that should be used as the thumbnail.

Returns:

The path of the file. If the file is an image and no thumbnail could be generated the file itself will be returned.

type

Type: CharField

File type

Choices:

• image/png

• image/jpeg

• application/pdf

• image/svg+xml

• image/gif

• application/msword

• application/vnd.openxmlformats-officedocument.wordprocessingml.document

• application/vnd.ms-excel

• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

• application/vnd.ms-powerpoint

• application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

unique_error_message(model_class, unique_check)

uploaded_date

Type: DateTimeField

Uploaded date. The date and time when the media file was uploaded

property url: str | None

Returns the path of the physical file

Returns:

The path of the file

validate_constraints(exclude=None)

validate_unique(exclude=None)

Check unique constraints on the model and raise ValidationError if any failed.

class integreat_cms.cms.models.media.media_file.MediaFileQuerySet(model=None, query=None, using=None, hints=None)

Bases: QuerySet

Custom queryset for media files

__init__(model=None, query=None, using=None, hints=None)

async aaggregate(*args, **kwargs)

async abulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

async abulk_update(objs, fields, batch_size=None)

async acontains(obj)

async acount()

async acreate(**kwargs)

async adelete()

async aearliest(*fields)

async aexists()

async aexplain(*, format=None, **options)

async afirst()

async aget(*args, **kwargs)

async aget_or_create(defaults=None, **kwargs)

aggregate(*args, **kwargs)

Return a dictionary containing the calculations (aggregation) over the current queryset.

If args is present the expression is passed as a kwarg using the Aggregate object’s default alias.

async ain_bulk(id_list=None, *, field_name='pk')

async aiterator(chunk_size=2000)

An asynchronous iterator over the results from applying this QuerySet to the database.

async alast()

async alatest(*fields)

alias(*args, **kwargs)

Return a query set with added aliases for extra data or aggregations.

all()

Return a new QuerySet that is a copy of the current one. This allows a QuerySet to proxy for a model manager in some cases.

annotate(*args, **kwargs)

Return a query set in which the returned objects have been annotated with extra data or aggregations.

classmethod as_manager()

async aupdate(**kwargs)

async aupdate_or_create(defaults=None, **kwargs)

bulk_create(objs, batch_size=None, ignore_conflicts=False, update_conflicts=False, update_fields=None, unique_fields=None)

Insert each of the instances into the database. Do not call save() on each of the instances, do not send any pre/post_save signals, and do not set the primary key attribute if it is an autoincrement field (except if features.can_return_rows_from_bulk_insert=True). Multi-table models are not supported.

bulk_update(objs, fields, batch_size=None)

Update the given fields in each of the given objects in the database.

complex_filter(filter_obj)

Return a new QuerySet instance with filter_obj added to the filters.

filter_obj can be a Q object or a dictionary of keyword lookup arguments.

This exists to support framework features such as ‘limit_choices_to’, and usually it will be more natural to use other methods.

contains(obj)

Return True if the QuerySet contains the provided obj, False otherwise.

count()

Perform a SELECT COUNT() and return the number of records as an integer.

If the QuerySet is already fully cached, return the length of the cached results set to avoid multiple SELECT COUNT(*) calls.

create(**kwargs)

Create a new object with the given kwargs, saving it to the database and returning the created object.

dates(field_name, kind, order='ASC')

Return a list of date objects representing all available dates for the given field_name, scoped to ‘kind’.

datetimes(field_name, kind, order='ASC', tzinfo=None, is_dst=<object object>)

Return a list of datetime objects representing all available datetimes for the given field_name, scoped to ‘kind’.

property db

Return the database used if this query is executed now.

defer(*fields)

Defer the loading of data for certain fields until they are accessed. Add the set of deferred fields to any existing set of deferred fields. The only exception to this is if None is passed in as the only parameter, in which case removal all deferrals.

delete()

Delete the records in the current QuerySet.

difference(*other_qs)

distinct(*field_names)

Return a new QuerySet instance that will select only distinct results.

earliest(*fields)

exclude(*args, **kwargs)

Return a new QuerySet instance with NOT (args) ANDed to the existing set.

exists()

Return True if the QuerySet would have any results, False otherwise.

explain(*, format=None, **options)

Runs an EXPLAIN on the SQL query this QuerySet would perform, and returns the results.

extra(select=None, where=None, params=None, tables=None, order_by=None, select_params=None)

Add extra SQL fragments to the query.

filter(*args, **kwargs)

Return a new QuerySet instance with the args ANDed to the existing set.

filter_unused() → MediaFileQuerySet

Filter for unused media files

Returns:

The queryset of unused media files

Return type:

MediaFileQuerySet

first()

Return the first object of a query or None if no match is found.

get(*args, **kwargs)

Perform the query and return a single object matching the given keyword arguments.

get_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, creating one if necessary. Return a tuple of (object, created), where created is a boolean specifying whether an object was created.

in_bulk(id_list=None, *, field_name='pk')

Return a dictionary mapping each of the given IDs to the object with that ID. If id_list isn’t provided, evaluate the entire QuerySet.

intersection(*other_qs)

iterator(chunk_size=None)

An iterator over the results from applying this QuerySet to the database. chunk_size must be provided for QuerySets that prefetch related objects. Otherwise, a default chunk_size of 2000 is supplied.

last()

Return the last object of a query or None if no match is found.

latest(*fields)

Return the latest object according to fields (if given) or by the model’s Meta.get_latest_by.

none()

Return an empty QuerySet.

only(*fields)

Essentially, the opposite of defer(). Only the fields passed into this method and that are not already specified as deferred are loaded immediately when the queryset is evaluated.

order_by(*field_names)

Return a new QuerySet instance with the ordering changed.

property ordered

Return True if the QuerySet is ordered – i.e. has an order_by() clause or a default ordering on the model (or is empty).

prefetch_related(*lookups)

Return a new QuerySet instance that will prefetch the specified Many-To-One and Many-To-Many related objects when the QuerySet is evaluated.

When prefetch_related() is called more than once, append to the list of prefetch lookups. If prefetch_related(None) is called, clear the list.

property query

raw(raw_query, params=(), translations=None, using=None)

resolve_expression(*args, **kwargs)

reverse()

Reverse the ordering of the QuerySet.

select_for_update(nowait=False, skip_locked=False, of=(), no_key=False)

Return a new QuerySet instance that will select objects with a FOR UPDATE lock.

select_related(*fields)

Return a new QuerySet instance that will select related objects.

If fields are specified, they must be ForeignKey fields and only those related objects are included in the selection.

If select_related(None) is called, clear the list.

union(*other_qs, all=False)

update(**kwargs)

Update all elements in the current QuerySet, setting all the given fields to the appropriate values.

update_or_create(defaults=None, **kwargs)

Look up an object with the given kwargs, updating one with defaults if it exists, otherwise create a new one. Return a tuple (object, created), where created is a boolean specifying whether an object was created.

using(alias)

Select which database this QuerySet should execute against.

values(*fields, **expressions)

values_list(*fields, flat=False, named=False)

integreat_cms.cms.models.media.media_file.file_size_limit(value: FieldFile) → None

This function checks if the uploaded file exceeds the file size limit

Parameters:

value (FieldFile) – the size of upload file

Raises:

ValidationError – when the file size exceeds the size given in the settings.

Return type:

None

integreat_cms.cms.models.media.media_file.upload_path(instance: MediaFile, filename: str) → str

This function calculates the path for a file which is uploaded to the media library. It contains the region id, the current year and month as subdirectories and the filename. It also contains the current epoch time to make sure that no path will be used twice. It is just the provisionally requested path for the media storage. If it already exists, Django will automatically append a random string to make sure the file name is unique.

Parameters:

• instance (MediaFile) – The media library object

• filename (str) – The filename of media library object

Returns:

The upload path of the file

Return type:

str

integreat_cms.cms.models.media.media_file.upload_path_thumbnail(instance: MediaFile, filename: str) → str

This function derives the upload path of a thumbnail file from it’s original file. This makes it a bit easier to determine which thumbnail belongs to which file if there are multiple files with the same file name (in which case Django automatically appends a random string to the original’s file name).

E.g. if the files A.jpg and A_thumbnail.jpg already exist, and A.jpg is uploaded again, the resulting file names might be e.g. A_EOHRFQ2.jpg and A_thumbnail_IWxPiOq.jpg, while with this function, the thumbnail will be stored as A_EOHRFQ2_thumbnail.jpg, making it easier to examine these files on the file system.

Parameters:

• instance (MediaFile) – The media library object

• filename (str) – The (unused) initial filename of thumbnail

Returns:

The upload path of the thumbnail

Return type:

str