Sith/election/models.py

179 lines
5.9 KiB
Python
Raw Normal View History

2016-12-05 19:18:03 +00:00
from django.db import models
from ordered_model.models import OrderedModel
2016-12-05 19:18:03 +00:00
from django.utils.translation import ugettext_lazy as _
from django.utils import timezone
2016-12-19 19:30:19 +00:00
from core.models import User, Group
2016-12-05 19:18:03 +00:00
class Election(models.Model):
"""
2016-12-07 22:55:05 +00:00
This class allows to create a new election
2016-12-05 19:18:03 +00:00
"""
title = models.CharField(_('title'), max_length=255)
description = models.TextField(_('description'), null=True, blank=True)
2017-06-07 17:16:55 +00:00
start_candidature = models.DateTimeField(_('start candidature'), blank=False)
2016-12-13 21:11:06 +00:00
end_candidature = models.DateTimeField(_('end candidature'), blank=False)
2016-12-05 19:18:03 +00:00
start_date = models.DateTimeField(_('start date'), blank=False)
end_date = models.DateTimeField(_('end date'), blank=False)
2017-06-07 14:22:04 +00:00
edit_groups = models.ManyToManyField(
Group, related_name="editable_elections",
verbose_name=_("edit groups"), blank=True)
2017-06-07 17:16:55 +00:00
2017-06-07 14:22:04 +00:00
view_groups = models.ManyToManyField(
Group, related_name="viewable_elections",
verbose_name=_("view groups"), blank=True)
2017-06-07 17:16:55 +00:00
2017-06-07 14:22:04 +00:00
vote_groups = models.ManyToManyField(
Group, related_name="votable_elections",
verbose_name=_("vote groups"), blank=True)
2017-06-07 17:16:55 +00:00
2017-06-07 14:22:04 +00:00
candidature_groups = models.ManyToManyField(
Group, related_name="candidate_elections",
verbose_name=_("candidature groups"), blank=True)
2017-06-07 17:16:55 +00:00
voters = models.ManyToManyField(User, verbose_name=('voters'), related_name='voted_elections')
archived = models.BooleanField(_("archived"), default=False)
2016-12-19 19:30:19 +00:00
2016-12-05 19:18:03 +00:00
def __str__(self):
return self.title
@property
def is_vote_active(self):
2016-12-05 19:18:03 +00:00
now = timezone.now()
return bool(now <= self.end_date and now >= self.start_date)
@property
def is_vote_finished(self):
return bool(timezone.now() > self.end_date)
2016-12-07 22:55:05 +00:00
@property
2016-12-13 21:11:06 +00:00
def is_candidature_active(self):
2016-12-07 22:55:05 +00:00
now = timezone.now()
2017-06-07 17:16:55 +00:00
return bool(now <= self.end_candidature and now >= self.start_candidature)
2016-12-07 22:55:05 +00:00
2016-12-24 17:29:26 +00:00
@property
def is_vote_editable(self):
return bool(timezone.now() <= self.end_candidature)
def can_candidate(self, user):
for group in self.candidature_groups.all():
if user.is_in_group(group):
return True
return False
2016-12-22 23:34:30 +00:00
def can_vote(self, user):
if not self.is_vote_active or self.has_voted(user):
return False
2016-12-22 23:34:30 +00:00
for group in self.vote_groups.all():
if user.is_in_group(group):
return True
return False
2016-12-23 22:49:00 +00:00
def has_voted(self, user):
return self.voters.filter(id=user.id).exists()
2016-12-23 16:13:46 +00:00
@property
def results(self):
2016-12-23 16:13:46 +00:00
results = {}
2016-12-23 22:49:00 +00:00
total_vote = self.voters.count()
2016-12-23 21:58:54 +00:00
for role in self.roles.all():
2016-12-23 22:49:00 +00:00
results[role.title] = role.results(total_vote)
2016-12-23 16:13:46 +00:00
return results
def delete(self):
for election_list in self.election_lists.all():
election_list.delete()
super(Election, self).delete()
2016-12-19 19:30:19 +00:00
# Permissions
2016-12-19 15:45:38 +00:00
2016-12-05 19:18:03 +00:00
class Role(OrderedModel):
2016-12-05 19:18:03 +00:00
"""
2016-12-13 21:11:06 +00:00
This class allows to create a new role avaliable for a candidature
2016-12-05 19:18:03 +00:00
"""
2017-06-07 17:16:55 +00:00
election = models.ForeignKey(Election, related_name='roles', verbose_name=_("election"))
2016-12-05 19:18:03 +00:00
title = models.CharField(_('title'), max_length=255)
description = models.TextField(_('description'), null=True, blank=True)
2016-12-19 19:30:19 +00:00
max_choice = models.IntegerField(_('max choice'), default=1)
2016-12-05 19:18:03 +00:00
2016-12-23 22:49:00 +00:00
def results(self, total_vote):
2016-12-23 16:13:46 +00:00
results = {}
2016-12-23 22:49:00 +00:00
total_vote *= self.max_choice
2016-12-23 16:13:46 +00:00
non_blank = 0
2016-12-23 21:58:54 +00:00
for candidature in self.candidatures.all():
2016-12-23 16:13:46 +00:00
cand_results = {}
2017-06-07 17:16:55 +00:00
cand_results['vote'] = self.votes.filter(candidature=candidature).count()
2017-01-10 18:06:34 +00:00
if total_vote == 0:
cand_results['percent'] = 0
else:
2017-06-07 17:16:55 +00:00
cand_results['percent'] = cand_results['vote'] * 100 / total_vote
2016-12-23 16:13:46 +00:00
non_blank += cand_results['vote']
results[candidature.user.username] = cand_results
results['total vote'] = total_vote
2017-01-10 18:06:34 +00:00
if total_vote == 0:
results['blank vote'] = {'vote': 0, 'percent': 0}
else:
2017-06-07 17:16:55 +00:00
results['blank vote'] = {'vote': total_vote - non_blank, 'percent': (total_vote - non_blank) * 100 / total_vote}
2016-12-23 16:13:46 +00:00
return results
2016-12-24 17:29:26 +00:00
@property
def edit_groups(self):
return self.election.edit_groups
2016-12-05 19:18:03 +00:00
def __str__(self):
return ("%s : %s") % (self.election.title, self.title)
2016-12-19 15:45:38 +00:00
class ElectionList(models.Model):
2016-12-14 17:10:15 +00:00
"""
To allow per list vote
"""
title = models.CharField(_('title'), max_length=255)
2017-06-07 17:16:55 +00:00
election = models.ForeignKey(Election, related_name='election_lists', verbose_name=_("election"))
2016-12-14 17:10:15 +00:00
def can_be_edited_by(self, user):
return user.can_edit(self.election)
def delete(self):
for candidature in self.candidatures.all():
candidature.delete()
super(ElectionList, self).delete()
def __str__(self):
return self.title
2016-12-14 17:10:15 +00:00
2016-12-13 21:11:06 +00:00
class Candidature(models.Model):
2016-12-05 19:18:03 +00:00
"""
2016-12-07 22:55:05 +00:00
This class is a component of responsability
2016-12-05 19:18:03 +00:00
"""
2017-06-07 17:16:55 +00:00
role = models.ForeignKey(Role, related_name='candidatures', verbose_name=_("role"))
user = models.ForeignKey(User, verbose_name=_('user'), related_name='candidates', blank=True)
2016-12-05 19:18:03 +00:00
program = models.TextField(_('description'), null=True, blank=True)
2017-06-07 17:16:55 +00:00
election_list = models.ForeignKey(ElectionList, related_name='candidatures', verbose_name=_('election list'))
2016-12-07 22:55:05 +00:00
def delete(self):
for vote in self.votes.all():
vote.delete()
super(Candidature, self).delete()
2016-12-24 17:29:26 +00:00
def can_be_edited_by(self, user):
return (user == self.user) or user.can_edit(self.role.election)
2016-12-24 17:29:26 +00:00
def __str__(self):
return "%s : %s" % (self.role.title, self.user.username)
2016-12-07 22:55:05 +00:00
class Vote(models.Model):
"""
This class allows to vote for candidates
"""
2017-06-07 17:16:55 +00:00
role = models.ForeignKey(Role, related_name='votes', verbose_name=_("role"))
candidature = models.ManyToManyField(Candidature, related_name='votes', verbose_name=_("candidature"))
2016-12-07 22:55:05 +00:00
def __str__(self):
2017-06-07 14:22:04 +00:00
return "Vote"