OpenSlides/openslides/assignments/models.py

403 lines
12 KiB
Python
Raw Normal View History

2019-10-29 09:44:19 +01:00
from decimal import Decimal
from django.conf import settings
from django.core.validators import MinValueValidator
2012-07-10 11:27:06 +02:00
from django.db import models
2011-07-31 10:46:29 +02:00
from openslides.agenda.mixins import AgendaItemWithListOfSpeakersMixin
from openslides.agenda.models import Speaker
2015-06-29 12:08:15 +02:00
from openslides.core.config import config
2018-12-23 11:05:38 +01:00
from openslides.core.models import Tag
2019-04-26 13:25:45 +02:00
from openslides.mediafiles.models import Mediafile
2019-10-18 14:18:49 +02:00
from openslides.poll.models import BaseOption, BasePoll, BaseVote
2016-10-01 01:30:55 +02:00
from openslides.utils.autoupdate import inform_changed_data
from openslides.utils.exceptions import OpenSlidesError
from openslides.utils.manager import BaseManager
from openslides.utils.models import RESTModelMixin
from ..utils.models import CASCADE_AND_AUTOUPDATE, SET_NULL_AND_AUTOUPDATE
2019-10-18 14:18:49 +02:00
from .access_permissions import (
AssignmentAccessPermissions,
AssignmentOptionAccessPermissions,
2019-10-18 14:18:49 +02:00
AssignmentPollAccessPermissions,
2019-10-29 09:00:11 +01:00
AssignmentVoteAccessPermissions,
2019-10-18 14:18:49 +02:00
)
class AssignmentRelatedUser(RESTModelMixin, models.Model):
"""
Many to Many table between an assignment and user.
"""
2016-12-06 12:21:29 +01:00
assignment = models.ForeignKey(
2019-01-06 16:22:33 +01:00
"Assignment", on_delete=models.CASCADE, related_name="assignment_related_users"
)
2016-12-06 12:21:29 +01:00
"""
ForeinKey to the assignment.
"""
user = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=CASCADE_AND_AUTOUPDATE)
2016-12-06 12:21:29 +01:00
"""
ForeinKey to the user who is related to the assignment.
"""
elected = models.BooleanField(default=False)
2016-12-06 12:21:29 +01:00
"""
Saves the election state of each user
"""
weight = models.IntegerField(default=0)
"""
The sort order of the candidates.
"""
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
2019-01-06 16:22:33 +01:00
unique_together = ("assignment", "user")
def __str__(self):
2019-01-12 23:01:42 +01:00
return f"{self.assignment} <-> {self.user}"
def get_root_rest_element(self):
"""
Returns the assignment to this instance which is the root REST element.
"""
return self.assignment
class AssignmentManager(BaseManager):
2016-09-30 20:42:58 +02:00
"""
Customized model manager to support our get_prefetched_queryset method.
2016-09-30 20:42:58 +02:00
"""
2019-01-06 16:22:33 +01:00
def get_prefetched_queryset(self, *args, **kwargs):
2016-09-30 20:42:58 +02:00
"""
Returns the normal queryset with all assignments. In the background
all related users (candidates), the related agenda item and all
polls are prefetched from the database.
"""
return (
super()
.get_prefetched_queryset(*args, **kwargs)
.prefetch_related(
"assignment_related_users",
"agenda_items",
"lists_of_speakers",
"tags",
"attachments",
)
2019-01-06 16:22:33 +01:00
)
class Assignment(RESTModelMixin, AgendaItemWithListOfSpeakersMixin, models.Model):
"""
Model for assignments.
"""
2019-01-06 16:22:33 +01:00
access_permissions = AssignmentAccessPermissions()
2019-01-06 16:22:33 +01:00
can_see_permission = "assignments.can_see"
objects = AssignmentManager()
PHASE_SEARCH = 0
PHASE_VOTING = 1
PHASE_FINISHED = 2
PHASES = (
2019-01-06 16:22:33 +01:00
(PHASE_SEARCH, "Searching for candidates"),
(PHASE_VOTING, "Voting"),
(PHASE_FINISHED, "Finished"),
2011-07-31 10:46:29 +02:00
)
2019-01-06 16:22:33 +01:00
title = models.CharField(max_length=100)
"""
Title of the assignment.
"""
2019-01-06 16:22:33 +01:00
description = models.TextField(blank=True)
"""
Text to describe the assignment.
"""
open_posts = models.PositiveSmallIntegerField()
"""
The number of members to be elected.
"""
2019-10-29 09:44:19 +01:00
default_poll_description = models.CharField(max_length=255, blank=True)
"""
Default text for the poll description.
"""
2019-01-06 16:22:33 +01:00
phase = models.IntegerField(choices=PHASES, default=PHASE_SEARCH)
"""
Phase in which the assignment is.
"""
related_users = models.ManyToManyField(
2019-01-06 16:22:33 +01:00
settings.AUTH_USER_MODEL, through="AssignmentRelatedUser"
)
"""
Users that are candidates or elected.
See AssignmentRelatedUser for more information.
"""
tags = models.ManyToManyField(Tag, blank=True)
"""
Tags for the assignment.
"""
2019-04-26 13:25:45 +02:00
attachments = models.ManyToManyField(Mediafile, blank=True)
"""
Mediafiles as attachments for this assignment.
"""
2019-11-12 09:20:10 +01:00
number_poll_candidates = models.BooleanField(default=False)
"""
Controls whether the candidates in polls for this assignment should be numbered or listed with bullet points.
"""
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
permissions = (
2019-01-06 16:22:33 +01:00
("can_see", "Can see elections"),
("can_nominate_other", "Can nominate another participant"),
("can_nominate_self", "Can nominate oneself"),
("can_manage", "Can manage elections"),
)
2019-01-06 16:22:33 +01:00
ordering = ("title",)
2019-01-12 23:01:42 +01:00
verbose_name = "Election"
def __str__(self):
return self.title
@property
def candidates(self):
2011-07-31 10:46:29 +02:00
"""
Queryset that represents the candidates for the assignment.
2011-07-31 10:46:29 +02:00
"""
2019-01-06 16:22:33 +01:00
return self.related_users.filter(assignmentrelateduser__elected=False)
@property
def elected(self):
"""
Queryset that represents all elected users for the assignment.
"""
2019-01-06 16:22:33 +01:00
return self.related_users.filter(assignmentrelateduser__elected=True)
2011-07-31 10:46:29 +02:00
def is_candidate(self, user):
"""
Returns True if user is a candidate.
Costs one database query.
"""
return self.candidates.filter(pk=user.pk).exists()
def is_elected(self, user):
"""
Returns True if the user is elected for this assignment.
Costs one database query.
"""
return self.elected.filter(pk=user.pk).exists()
2019-10-18 14:18:49 +02:00
def add_candidate(self, user):
"""
Adds the user as candidate.
"""
2019-01-06 16:22:33 +01:00
weight = (
self.assignment_related_users.aggregate(models.Max("weight"))["weight__max"]
or 0
)
defaults = {"elected": False, "weight": weight + 1}
2019-01-12 23:01:42 +01:00
self.assignment_related_users.update_or_create(user=user, defaults=defaults)
2012-07-03 00:05:48 +02:00
def set_elected(self, user):
"""
Makes user an elected user for this assignment.
"""
2019-01-12 23:01:42 +01:00
self.assignment_related_users.update_or_create(
2019-01-06 16:22:33 +01:00
user=user, defaults={"elected": True}
)
2019-10-18 14:18:49 +02:00
def remove_candidate(self, user):
"""
Delete the connection from the assignment to the user.
"""
self.assignment_related_users.filter(user=user).delete()
2016-10-01 01:30:55 +02:00
inform_changed_data(self)
def set_phase(self, phase):
"""
Sets the phase attribute of the assignment.
Raises a ValueError if the phase is not valide.
"""
if phase not in dict(self.PHASES):
2019-01-12 23:01:42 +01:00
raise ValueError(f"Invalid phase {phase}")
self.phase = phase
def get_title_information(self):
2019-02-15 12:17:08 +01:00
return {"title": self.title}
2012-02-19 19:27:00 +01:00
class AssignmentVoteManager(BaseManager):
"""
Customized model manager to support our get_prefetched_queryset method.
"""
def get_prefetched_queryset(self, *args, **kwargs):
"""
Returns the normal queryset with all assignment votes. In the background we
join and prefetch all related models.
"""
return (
super()
.get_prefetched_queryset(*args, **kwargs)
.select_related("user", "option", "option__poll")
)
class AssignmentVote(RESTModelMixin, BaseVote):
2019-10-29 09:00:11 +01:00
access_permissions = AssignmentVoteAccessPermissions()
objects = AssignmentVoteManager()
option = models.ForeignKey(
2019-01-06 16:22:33 +01:00
"AssignmentOption", on_delete=models.CASCADE, related_name="votes"
)
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
class AssignmentOption(RESTModelMixin, BaseOption):
access_permissions = AssignmentOptionAccessPermissions()
2019-10-18 14:18:49 +02:00
vote_class = AssignmentVote
poll = models.ForeignKey(
2019-01-06 16:22:33 +01:00
"AssignmentPoll", on_delete=models.CASCADE, related_name="options"
)
2019-10-18 14:18:49 +02:00
user = models.ForeignKey(
settings.AUTH_USER_MODEL, on_delete=SET_NULL_AND_AUTOUPDATE, null=True
)
2016-12-06 12:21:29 +01:00
weight = models.IntegerField(default=0)
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
class AssignmentPollManager(BaseManager):
"""
Customized model manager to support our get_prefetched_queryset method.
"""
def get_prefetched_queryset(self, *args, **kwargs):
"""
Returns the normal queryset with all assignment polls. In the background we
join and prefetch all related models.
"""
return (
super()
.get_prefetched_queryset(*args, **kwargs)
.select_related("assignment")
.prefetch_related(
"options", "options__user", "options__votes", "groups", "voted"
)
)
2019-10-18 14:18:49 +02:00
class AssignmentPoll(RESTModelMixin, BasePoll):
access_permissions = AssignmentPollAccessPermissions()
objects = AssignmentPollManager()
2012-02-19 19:27:00 +01:00
option_class = AssignmentOption
assignment = models.ForeignKey(
2019-01-06 16:22:33 +01:00
Assignment, on_delete=models.CASCADE, related_name="polls"
)
2019-10-29 09:44:19 +01:00
description = models.CharField(max_length=255, blank=True)
2019-10-18 14:18:49 +02:00
POLLMETHOD_YN = "YN"
POLLMETHOD_YNA = "YNA"
POLLMETHOD_VOTES = "votes"
POLLMETHODS = (("YN", "YN"), ("YNA", "YNA"), ("votes", "votes"))
pollmethod = models.CharField(max_length=5, choices=POLLMETHODS)
2015-12-10 00:20:59 +01:00
2019-10-29 09:44:19 +01:00
PERCENT_BASE_YN = "YN"
PERCENT_BASE_YNA = "YNA"
PERCENT_BASE_VOTES = "votes"
PERCENT_BASE_VALID = "valid"
PERCENT_BASE_CAST = "cast"
PERCENT_BASE_DISABLED = "disabled"
PERCENT_BASES = (
(PERCENT_BASE_YN, "Yes/No per candidate"),
(PERCENT_BASE_YNA, "Yes/No/Abstain per candidate"),
(PERCENT_BASE_VOTES, "Sum of votes inclusive global ones"),
(PERCENT_BASE_VALID, "All valid ballots"),
(PERCENT_BASE_CAST, "All casted ballots"),
(PERCENT_BASE_DISABLED, "Disabled (no percents)"),
)
onehundred_percent_base = models.CharField(
max_length=8, blank=False, null=False, choices=PERCENT_BASES
)
2019-10-18 14:18:49 +02:00
global_abstain = models.BooleanField(default=True)
global_no = models.BooleanField(default=True)
2012-02-19 19:27:00 +01:00
2019-10-18 14:18:49 +02:00
votes_amount = models.IntegerField(default=1, validators=[MinValueValidator(1)])
""" For "votes" mode: The amount of votes a voter can give. """
2019-10-18 14:18:49 +02:00
allow_multiple_votes_per_candidate = models.BooleanField(default=False)
2019-10-18 14:18:49 +02:00
class Meta:
default_permissions = ()
2019-10-29 09:44:19 +01:00
@property
def amount_global_no(self):
if self.pollmethod != AssignmentPoll.POLLMETHOD_VOTES or not self.global_no:
return None
no_sum = Decimal(0)
for option in self.options.all():
no_sum += option.no
return no_sum
@property
def amount_global_abstain(self):
if (
self.pollmethod != AssignmentPoll.POLLMETHOD_VOTES
or not self.global_abstain
):
return None
abstain_sum = Decimal(0)
for option in self.options.all():
abstain_sum += option.abstain
return abstain_sum
2019-10-18 14:18:49 +02:00
def create_options(self):
related_users = AssignmentRelatedUser.objects.filter(
assignment__id=self.assignment.id
).exclude(elected=True)
for related_user in related_users:
AssignmentOption.objects.create(
2019-10-18 14:18:49 +02:00
user=related_user.user, weight=related_user.weight, poll=self
)
# Add all candidates to list of speakers of related agenda item
2019-10-29 09:44:19 +01:00
if config["assignment_poll_add_candidates_to_list_of_speakers"]:
2019-10-18 14:18:49 +02:00
for related_user in related_users:
try:
Speaker.objects.add(
related_user.user,
self.assignment.list_of_speakers,
skip_autoupdate=True,
)
except OpenSlidesError:
# The Speaker is already on the list. Do nothing.
pass
inform_changed_data(self.assignment.list_of_speakers)