OpenSlides/openslides/assignments/models.py

471 lines
14 KiB
Python
Raw Normal View History

from collections import OrderedDict
from decimal import Decimal
2018-08-22 22:00:08 +02:00
from typing import Any, Dict, List
from django.conf import settings
from django.contrib.contenttypes.fields import GenericRelation
from django.core.validators import MinValueValidator
2012-07-10 11:27:06 +02:00
from django.db import models
from django.utils.translation import ugettext as _, ugettext_noop
2011-07-31 10:46:29 +02:00
from openslides.agenda.models import Item, Speaker
2015-06-29 12:08:15 +02:00
from openslides.core.config import config
from openslides.core.models import Projector, Tag
from openslides.poll.models import (
BaseOption,
BasePoll,
BaseVote,
CollectDefaultVotesMixin,
PublishPollMixin,
)
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.models import RESTModelMixin
from .access_permissions import AssignmentAccessPermissions
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(
'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=models.CASCADE)
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 = ()
unique_together = ('assignment', 'user')
def __str__(self):
return "%s <-> %s" % (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(models.Manager):
2016-09-30 20:42:58 +02:00
"""
Customized model manager to support our get_full_queryset method.
"""
def get_full_queryset(self):
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 self.get_queryset().prefetch_related(
'related_users',
'agenda_items',
'polls',
'tags')
2015-06-29 13:31:07 +02:00
class Assignment(RESTModelMixin, models.Model):
"""
Model for assignments.
"""
access_permissions = AssignmentAccessPermissions()
objects = AssignmentManager()
PHASE_SEARCH = 0
PHASE_VOTING = 1
PHASE_FINISHED = 2
PHASES = (
2016-06-17 09:47:05 +02:00
(PHASE_SEARCH, 'Searching for candidates'),
(PHASE_VOTING, 'Voting'),
(PHASE_FINISHED, 'Finished'),
2011-07-31 10:46:29 +02:00
)
title = models.CharField(
max_length=100)
"""
Title of the assignment.
"""
description = models.TextField(
blank=True)
"""
Text to describe the assignment.
"""
open_posts = models.PositiveSmallIntegerField()
"""
The number of members to be elected.
"""
poll_description_default = models.CharField(
max_length=79,
blank=True)
"""
Default text for the poll description.
"""
phase = models.IntegerField(
choices=PHASES,
default=PHASE_SEARCH)
"""
Phase in which the assignment is.
"""
related_users = models.ManyToManyField(
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.
"""
2016-09-30 20:42:58 +02:00
# In theory there could be one then more agenda_item. But we support only
# one. See the property agenda_item.
agenda_items = GenericRelation(Item, related_name='assignments')
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
permissions = (
('can_see', 'Can see elections'),
('can_nominate_other', 'Can nominate another participant'),
('can_nominate_self', 'Can nominate oneself'),
('can_manage', 'Can manage elections'),
)
ordering = ('title', )
verbose_name = ugettext_noop('Election')
def __str__(self):
return self.title
def delete(self, skip_autoupdate=False, *args, **kwargs):
"""
Customized method to delete an assignment. Ensures that a respective
assignment projector element is disabled.
"""
Projector.remove_any(
skip_autoupdate=skip_autoupdate,
name='assignments/assignment',
id=self.pk)
2017-08-24 12:26:55 +02:00
return super().delete(skip_autoupdate=skip_autoupdate, *args, **kwargs) # type: ignore # TODO fix typing
2011-07-31 10:46:29 +02:00
@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
"""
return self.related_users.filter(
assignmentrelateduser__elected=False)
@property
def elected(self):
"""
Queryset that represents all elected users for the assignment.
"""
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()
def set_candidate(self, user):
"""
Adds the user as candidate.
"""
2016-12-06 12:21:29 +01:00
weight = self.assignment_related_users.aggregate(
models.Max('weight'))['weight__max'] or 0
defaults = {
'elected': False,
'weight': weight + 1}
related_user, __ = self.assignment_related_users.update_or_create(
user=user,
2016-12-06 12:21:29 +01:00
defaults=defaults)
2012-07-03 00:05:48 +02:00
def set_elected(self, user):
"""
Makes user an elected user for this assignment.
"""
related_user, __ = self.assignment_related_users.update_or_create(
user=user,
defaults={'elected': True})
def delete_related_user(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):
raise ValueError("Invalid phase %s" % phase)
self.phase = phase
def create_poll(self):
"""
Creates a new poll for the assignment and adds all candidates to all
lists of speakers of related agenda items.
"""
candidates = self.candidates.all()
# Find out the method of the election
if config['assignments_poll_vote_values'] == 'votes':
pollmethod = 'votes'
elif config['assignments_poll_vote_values'] == 'yesnoabstain':
pollmethod = 'yna'
elif config['assignments_poll_vote_values'] == 'yesno':
pollmethod = 'yn'
else:
# config['assignments_poll_vote_values'] == 'auto'
# candidates <= available posts -> yes/no/abstain
if len(candidates) <= (self.open_posts - self.elected.count()):
pollmethod = 'yna'
else:
pollmethod = 'votes'
# Create the poll with the candidates.
poll = self.polls.create(
description=self.poll_description_default,
pollmethod=pollmethod)
2016-12-06 12:21:29 +01:00
options = []
related_users = AssignmentRelatedUser.objects.filter(assignment__id=self.id).exclude(elected=True)
2016-12-06 12:21:29 +01:00
for related_user in related_users:
options.append({
'candidate': related_user.user,
'weight': related_user.weight})
poll.set_options(options, skip_autoupdate=True)
inform_changed_data(self)
# Add all candidates to list of speakers of related agenda item
# TODO: Try to do this in a bulk create
if config['assignments_add_candidates_to_list_of_speakers']:
for candidate in self.candidates:
try:
Speaker.objects.add(candidate, self.agenda_item, skip_autoupdate=True)
except OpenSlidesError:
# The Speaker is already on the list. Do nothing.
# TODO: Find a smart way not to catch the error concerning AnonymousUser.
pass
inform_changed_data(self.agenda_item)
2011-07-31 10:46:29 +02:00
return poll
def vote_results(self, only_published):
2012-07-03 00:05:48 +02:00
"""
Returns a table represented as a list with all candidates from all
2012-07-04 11:00:58 +02:00
related polls and their vote results.
2012-07-03 00:05:48 +02:00
"""
2018-08-22 22:00:08 +02:00
vote_results_dict: Dict[Any, List[AssignmentVote]] = OrderedDict()
polls = self.polls.all()
if only_published:
polls = polls.filter(published=True)
2012-07-04 11:00:58 +02:00
# All PollOption-Objects related to this assignment
2018-08-22 22:00:08 +02:00
options: List[AssignmentOption] = []
for poll in polls:
options += poll.get_options()
2012-07-03 00:05:48 +02:00
for option in options:
candidate = option.candidate
if candidate in vote_results_dict:
continue
vote_results_dict[candidate] = []
for poll in polls:
2018-08-22 22:00:08 +02:00
votes: Any = {}
2012-07-03 00:05:48 +02:00
try:
# candidate related to this poll
poll_option = poll.get_options().get(candidate=candidate)
for vote in poll_option.get_votes():
votes[vote.value] = vote.print_weight()
2012-07-03 00:05:48 +02:00
except AssignmentOption.DoesNotExist:
2012-07-04 11:00:58 +02:00
# candidate not in related to this poll
votes = None
vote_results_dict[candidate].append(votes)
2012-07-03 00:05:48 +02:00
return vote_results_dict
"""
Container for runtime information for agenda app (on create or update of this instance).
"""
2018-08-22 22:00:08 +02:00
agenda_item_update_information: Dict[str, Any] = {}
2012-06-23 10:27:58 +02:00
def get_agenda_title(self):
return str(self)
def get_agenda_list_view_title(self):
"""
Return a title string for the agenda list view.
Contains agenda item number, title and assignment verbose name.
Note: It has to be the same return value like in JavaScript.
"""
return '%s (%s)' % (self.title, _(self._meta.verbose_name))
@property
def agenda_item(self):
"""
Returns the related agenda item.
"""
2016-09-30 20:42:58 +02:00
# We support only one agenda item so just return the first element of
# the queryset.
return self.agenda_items.all()[0]
@property
def agenda_item_id(self):
"""
Returns the id of the agenda item object related to this object.
"""
return self.agenda_item.pk
2012-02-19 19:27:00 +01:00
class AssignmentVote(RESTModelMixin, BaseVote):
option = models.ForeignKey(
'AssignmentOption',
on_delete=models.CASCADE,
related_name='votes')
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def get_root_rest_element(self):
"""
Returns the assignment to this instance which is the root REST element.
"""
return self.option.poll.assignment
class AssignmentOption(RESTModelMixin, BaseOption):
poll = models.ForeignKey(
'AssignmentPoll',
on_delete=models.CASCADE,
related_name='options')
candidate = models.ForeignKey(
settings.AUTH_USER_MODEL,
on_delete=models.CASCADE)
2016-12-06 12:21:29 +01:00
weight = models.IntegerField(default=0)
vote_class = AssignmentVote
2012-02-19 19:27:00 +01:00
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def __str__(self):
return str(self.candidate)
2012-02-19 19:27:00 +01:00
def get_root_rest_element(self):
"""
Returns the assignment to this instance which is the root REST element.
"""
return self.poll.assignment
2012-02-19 19:27:00 +01:00
2017-08-23 20:51:06 +02:00
# TODO: remove the type-ignoring in the next line, after this is solved:
# https://github.com/python/mypy/issues/3855
class AssignmentPoll(RESTModelMixin, CollectDefaultVotesMixin, # type: ignore
PublishPollMixin, BasePoll):
2012-02-19 19:27:00 +01:00
option_class = AssignmentOption
assignment = models.ForeignKey(
Assignment,
on_delete=models.CASCADE,
related_name='polls')
pollmethod = models.CharField(
max_length=5,
default='yna')
description = models.CharField(
max_length=79,
blank=True)
2012-02-19 19:27:00 +01:00
votesabstain = models.DecimalField(null=True, blank=True, validators=[
MinValueValidator(Decimal('-2'))], max_digits=15, decimal_places=6)
""" General abstain votes, used for pollmethod 'votes' """
votesno = models.DecimalField(null=True, blank=True, validators=[
MinValueValidator(Decimal('-2'))], max_digits=15, decimal_places=6)
""" General no votes, used for pollmethod 'votes' """
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def delete(self, skip_autoupdate=False, *args, **kwargs):
"""
Customized method to delete an assignment poll. Ensures that a respective
assignment projector element (with poll, so called poll slide) is disabled.
"""
Projector.remove_any(
skip_autoupdate=skip_autoupdate,
name='assignments/assignment',
id=self.assignment.pk,
poll=self.pk)
2017-08-24 12:26:55 +02:00
return super().delete(skip_autoupdate=skip_autoupdate, *args, **kwargs) # type: ignore # TODO: fix typing
2012-02-19 19:27:00 +01:00
def get_assignment(self):
return self.assignment
def get_vote_values(self):
if self.pollmethod == 'yna':
2015-12-07 12:40:30 +01:00
return ['Yes', 'No', 'Abstain']
elif self.pollmethod == 'yn':
return ['Yes', 'No']
else:
2015-12-07 12:40:30 +01:00
return ['Votes']
def get_ballot(self):
return self.assignment.polls.filter(id__lte=self.pk).count()
def get_percent_base_choice(self):
return config['assignments_poll_100_percent_base']
def get_root_rest_element(self):
"""
Returns the assignment to this instance which is the root REST element.
"""
return self.assignment