OpenSlides/openslides/mediafiles/models.py

from django.conf import settings
from django.db import models

from ..agenda.mixins import ListOfSpeakersMixin
from ..core.config import config
from ..utils.autoupdate import inform_changed_data
from ..utils.models import SET_NULL_AND_AUTOUPDATE, RESTModelMixin
from .access_permissions import MediafileAccessPermissions


class MediafileManager(models.Manager):
    """
    Customized model manager to support our get_full_queryset method.
    """

    def get_full_queryset(self):
        """
        Returns the normal queryset with all mediafiles. In the background
        all related list of speakers are prefetched from the database.
        """
        return self.get_queryset().prefetch_related("lists_of_speakers")


class Mediafile(RESTModelMixin, ListOfSpeakersMixin, models.Model):
    """
    Class for uploaded files which can be delivered under a certain url.
    """

    objects = MediafileManager()
    access_permissions = MediafileAccessPermissions()
    can_see_permission = "mediafiles.can_see"

    mediafile = models.FileField(upload_to="file")
    """
    See https://docs.djangoproject.com/en/dev/ref/models/fields/#filefield
    for more information.
    """

    title = models.CharField(max_length=255, unique=True)
    """A string representing the title of the file."""

    uploader = models.ForeignKey(
        settings.AUTH_USER_MODEL, on_delete=SET_NULL_AND_AUTOUPDATE, null=True
    )
    """A user – the uploader of a file."""

    hidden = models.BooleanField(default=False)
    """Whether or not this mediafile should be marked as hidden"""

    timestamp = models.DateTimeField(auto_now_add=True)
    """A DateTimeField to save the upload date and time."""

    class Meta:
        """
        Meta class for the mediafile model.
        """

        ordering = ["title"]
        default_permissions = ()
        permissions = (
            ("can_see", "Can see the list of files"),
            ("can_see_hidden", "Can see hidden files"),
            ("can_upload", "Can upload files"),
            ("can_manage", "Can manage files"),
        )

    def __str__(self):
        """
        Method for representation.
        """
        return self.title

    def save(self, *args, **kwargs):
        """
        Saves mediafile (mainly on create and update requests).
        """
        result = super().save(*args, **kwargs)
        # Send uploader via autoupdate because users without permission
        # to see users may not have it but can get it now.
        inform_changed_data(self.uploader)
        return result

    def get_filesize(self):
        """
        Transforms bytes to kilobytes or megabytes. Returns the size as string.
        """
        # TODO: Read http://stackoverflow.com/a/1094933 and think about it.
        try:
            size = self.mediafile.size
        except OSError:
            size_string = "unknown"
        else:
            if size < 1024:
                size_string = "< 1 kB"
            elif size >= 1024 * 1024:
                mB = size / 1024 / 1024
                size_string = "%d MB" % mB
            else:
                kB = size / 1024
                size_string = "%d kB" % kB
        return size_string

    def is_logo(self):
        for key in config["logos_available"]:
            if config[key]["path"] == self.mediafile.url:
                return True
        return False

    def is_font(self):
        for key in config["fonts_available"]:
            if config[key]["path"] == self.mediafile.url:
                return True
        return False

    def get_list_of_speakers_title_information(self):
        return {"title": self.title}