OpenSlides/openslides/motion/models.py

517 lines
17 KiB
Python
Raw Normal View History

2011-07-31 10:46:29 +02:00
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
2012-10-24 11:04:23 +02:00
openslides.motion.models
~~~~~~~~~~~~~~~~~~~~~~~~
2011-07-31 10:46:29 +02:00
2012-10-24 11:04:23 +02:00
Models for the motion app.
2011-07-31 10:46:29 +02:00
2012-04-25 22:29:19 +02:00
:copyright: 2011, 2012 by OpenSlides team, see AUTHORS.
2011-07-31 10:46:29 +02:00
:license: GNU GPL, see LICENSE for more details.
"""
from datetime import datetime
2012-04-12 16:21:30 +02:00
from django.core.urlresolvers import reverse
from django.db import models
from django.db.models import Max
from django.dispatch import receiver
2012-06-30 15:21:27 +02:00
from django.utils.translation import pgettext
2013-01-26 16:33:55 +01:00
from django.utils.translation import ugettext_lazy, ugettext_noop, ugettext as _
2011-07-31 10:46:29 +02:00
from openslides.utils.utils import _propper_unicode
from openslides.utils.person import PersonField
from openslides.config.models import config
from openslides.config.signals import default_config_value
from openslides.poll.models import (
BaseOption, BasePoll, CountVotesCast, CountInvalid, BaseVote)
from openslides.participant.models import User
from openslides.projector.api import register_slidemodel
from openslides.projector.models import SlideMixin
from openslides.agenda.models import Item
from .workflow import (motion_workflow_choices, get_state, State, WorkflowError,
DUMMY_STATE)
2013-02-01 16:33:45 +01:00
2013-01-26 15:25:54 +01:00
# TODO: Save submitter and supporter in the same table
class MotionSubmitter(models.Model):
person = PersonField()
motion = models.ForeignKey('Motion', related_name="submitter")
2013-01-26 12:28:51 +01:00
2013-01-26 15:25:54 +01:00
def __unicode__(self):
return unicode(self.person)
2013-01-26 12:28:51 +01:00
2011-07-31 10:46:29 +02:00
2013-01-26 15:25:54 +01:00
class MotionSupporter(models.Model):
2013-01-06 12:07:37 +01:00
person = PersonField()
2013-01-26 15:25:54 +01:00
motion = models.ForeignKey('Motion', related_name="supporter")
def __unicode__(self):
return unicode(self.person)
2013-01-06 12:07:37 +01:00
class Motion(SlideMixin, models.Model):
2013-01-26 12:28:51 +01:00
"""
The Motion-Model.
"""
prefix = "motion"
2013-01-06 12:07:37 +01:00
2013-02-03 13:24:29 +01:00
active_version = models.ForeignKey(
'MotionVersion', null=True, related_name="active_version")
2013-02-01 16:33:45 +01:00
state_id = models.CharField(max_length=3)
2013-01-06 12:07:37 +01:00
# Log (Translatable)
identifier = models.CharField(max_length=255, null=True, blank=True,
unique=True)
category = models.ForeignKey('Category', null=True, blank=True)
# TODO proposal
# Maybe rename to master_copy
master = models.ForeignKey('self', null=True, blank=True)
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
class Meta:
permissions = (
('can_see_motion', ugettext_noop('Can see motions')),
('can_create_motion', ugettext_noop('Can create motions')),
('can_support_motion', ugettext_noop('Can support motions')),
('can_manage_motion', ugettext_noop('Can manage motions')),
)
# TODO: order per default by category and identifier
# ordering = ('number',)
2013-01-06 12:07:37 +01:00
def __unicode__(self):
return self.get_title()
# TODO: Use transaction
def save(self, *args, **kwargs):
2013-01-26 12:28:51 +01:00
"""
Saves the motion. Create or update a motion_version object
"""
2013-02-01 16:33:45 +01:00
if not self.state_id:
self.reset_state()
2013-02-01 16:33:45 +01:00
2013-01-06 12:07:37 +01:00
super(Motion, self).save(*args, **kwargs)
2013-02-03 13:54:01 +01:00
# Find out if the version data has changed
for attr in ['title', 'text', 'reason']:
2013-02-03 13:54:01 +01:00
if not self.versions.exists():
new_data = True
break
if getattr(self, attr) != getattr(self.last_version, attr):
2013-01-06 12:07:37 +01:00
new_data = True
break
else:
new_data = False
need_new_version = config['motion_create_new_version'] == 'ALLWASY_CREATE_NEW_VERSION'
if hasattr(self, '_new_version') or (new_data and need_new_version):
2013-01-06 12:07:37 +01:00
version = self.new_version
del self._new_version
version.motion = self # Test if this line is realy neccessary.
elif new_data and not need_new_version:
version = self.last_version
else:
2013-01-06 12:07:37 +01:00
# We do not need to save the motion version
return
2013-02-03 13:24:29 +01:00
2013-02-03 13:54:01 +01:00
# Save title, text and reason in the version object
2013-01-06 12:07:37 +01:00
for attr in ['title', 'text', 'reason']:
_attr = '_%s' % attr
2011-07-31 10:46:29 +02:00
try:
2013-01-06 12:07:37 +01:00
setattr(version, attr, getattr(self, _attr))
delattr(self, _attr)
2011-07-31 10:46:29 +02:00
except AttributeError:
2013-02-03 13:54:01 +01:00
if self.versions.exists():
# If the _attr was not set, use the value from last_version
setattr(version, attr, getattr(self.last_version, attr))
2013-02-03 13:24:29 +01:00
2013-02-03 13:54:01 +01:00
# Set version_number of the new Version (if neccessary) and save it into the DB
2013-02-03 13:24:29 +01:00
if version.id is None:
# TODO: auto increment the version_number in the Database
version_number = self.versions.aggregate(Max('version_number'))['version_number__max'] or 0
version.version_number = version_number + 1
2013-01-06 12:07:37 +01:00
version.save()
2012-02-14 16:31:21 +01:00
2013-02-03 13:54:01 +01:00
# Set the active Version of this motion. This has to be done after the
# version is saved to the db
2013-02-03 13:24:29 +01:00
if not self.state.version_permission or self.active_version is None:
self.active_version = version
self.save()
2013-01-06 12:07:37 +01:00
def get_absolute_url(self, link='detail'):
if link == 'view' or link == 'detail':
return reverse('motion_detail', args=[str(self.id)])
if link == 'edit':
2012-10-24 11:04:23 +02:00
return reverse('motion_edit', args=[str(self.id)])
2011-07-31 10:46:29 +02:00
if link == 'delete':
2012-10-24 11:04:23 +02:00
return reverse('motion_delete', args=[str(self.id)])
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def get_title(self):
2013-01-26 12:28:51 +01:00
"""
Get the title of the motion. The titel is taken from motion.version
"""
2011-07-31 10:46:29 +02:00
try:
2013-01-06 12:07:37 +01:00
return self._title
2011-07-31 10:46:29 +02:00
except AttributeError:
2013-01-26 12:28:51 +01:00
return self.version.title
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def set_title(self, title):
2013-01-26 12:28:51 +01:00
"""
Set the titel of the motion. The titel will me saved in motion.save()
"""
2013-01-06 12:07:37 +01:00
self._title = title
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
title = property(get_title, set_title)
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def get_text(self):
2013-01-26 12:28:51 +01:00
"""
Get the text of the motion. Simular to get_title()
"""
2013-01-06 12:07:37 +01:00
try:
return self._text
except AttributeError:
2013-01-26 12:28:51 +01:00
return self.version.text
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def set_text(self, text):
2013-01-26 12:28:51 +01:00
"""
Set the text of the motion. Simular to set_title()
"""
2013-01-06 12:07:37 +01:00
self._text = text
text = property(get_text, set_text)
def get_reason(self):
2013-01-26 12:28:51 +01:00
"""
Get the reason of the motion. Simular to get_title()
"""
2013-01-06 12:07:37 +01:00
try:
return self._reason
except AttributeError:
2013-01-26 12:28:51 +01:00
return self.version.reason
2013-01-06 12:07:37 +01:00
def set_reason(self, reason):
2013-01-26 12:28:51 +01:00
"""
Set the reason of the motion. Simular to set_title()
"""
2013-01-06 12:07:37 +01:00
self._reason = reason
reason = property(get_reason, set_reason)
2011-07-31 10:46:29 +02:00
2013-01-26 12:28:51 +01:00
@property
def new_version(self):
"""
On the first call, it creates a new version. On any later call, it
use the existing new version.
The new_version object will be deleted when it is saved into the db
"""
try:
return self._new_version
except AttributeError:
self._new_version = MotionVersion(motion=self)
return self._new_version
def get_version(self):
"""
Get the "active" version object. This version will be used to get the
data for this motion.
"""
2013-01-06 12:07:37 +01:00
try:
2013-01-26 12:28:51 +01:00
return self._version
2013-01-06 12:07:37 +01:00
except AttributeError:
return self.last_version
2012-02-14 16:31:21 +01:00
2013-01-26 12:28:51 +01:00
def set_version(self, version):
"""
Set the "active" version object.
If version is None, the last_version will be used.
If version is a version object, this object will be used.
If version is Int, the N version of this motion will be used.
"""
2013-01-06 12:07:37 +01:00
if version is None:
try:
2013-01-26 12:28:51 +01:00
del self._version
2013-01-06 12:07:37 +01:00
except AttributeError:
pass
else:
if type(version) is int:
2013-02-03 13:24:29 +01:00
version = self.versions.get(version_number=version)
2013-01-06 12:07:37 +01:00
elif type(version) is not MotionVersion:
raise ValueError('The argument \'version\' has to be int or '
'MotionVersion, not %s' % type(version))
2013-01-26 12:28:51 +01:00
# TODO: Test, that the version is one of this motion
self._version = version
2012-02-14 16:31:21 +01:00
2013-01-26 12:28:51 +01:00
version = property(get_version, set_version)
2012-02-15 12:36:50 +01:00
2013-01-06 12:07:37 +01:00
@property
def last_version(self):
2013-01-26 12:28:51 +01:00
"""
Get the newest version of the motion
"""
2013-01-06 12:07:37 +01:00
# TODO: Fix the case, that the motion has no Version
try:
2013-02-03 13:24:29 +01:00
return self.versions.order_by('-version_number')[0]
2013-01-06 12:07:37 +01:00
except IndexError:
return self.new_version
def is_submitter(self, person):
self.submitter.filter(person=person).exists()
def is_supporter(self, person):
return self.supporter.filter(person=person).exists()
def support(self, person):
"""
Add a Supporter to the list of supporters of the motion.
"""
if self.state.support:
if not self.is_supporter(person):
MotionSupporter(motion=self, person=person).save()
else:
raise WorkflowError("You can not support a motion in state %s" % self.state.name)
def unsupport(self, person):
"""
Remove a supporter from the list of supporters of the motion
"""
if self.state.support:
self.supporter.filter(person=person).delete()
else:
raise WorkflowError("You can not unsupport a motion in state %s" % self.state.name)
2013-02-01 12:51:54 +01:00
def create_poll(self):
2013-02-01 16:33:45 +01:00
"""
Create a new poll for this motion
"""
if self.state.create_poll:
# TODO: auto increment the poll_number in the Database
poll_number = self.polls.aggregate(Max('poll_number'))['poll_number__max'] or 0
poll = MotionPoll.objects.create(motion=self, poll_number=poll_number + 1)
poll.set_options()
return poll
else:
raise WorkflowError("You can not create a poll in state %s" % self.state.name)
2013-02-01 12:51:54 +01:00
2013-02-01 16:33:45 +01:00
def get_state(self):
"""
Get the state of this motion. Return a State object.
"""
try:
return get_state(self.state_id)
except WorkflowError:
return DUMMY_STATE
2013-02-01 16:33:45 +01:00
def set_state(self, next_state):
2013-02-01 16:33:45 +01:00
"""
Set the state of this motion.
next_state has to be a valid state id or State object.
2013-02-01 16:33:45 +01:00
"""
if not isinstance(next_state, State):
next_state = get_state(next_state)
if next_state in self.state.next_states:
self.state_id = next_state.id
else:
raise WorkflowError('%s is not a valid next_state' % next_state)
2013-02-01 16:33:45 +01:00
state = property(get_state, set_state)
def reset_state(self):
"""
Set the state to the default state.
"""
self.state_id = get_state('default').id
2013-02-02 00:37:43 +01:00
def slide(self):
"""
return the slide dict
"""
data = super(Motion, self).slide()
data['motion'] = self
data['title'] = self.title
data['template'] = 'projector/Motion.html'
return data
2013-02-02 00:51:08 +01:00
def get_agenda_title(self):
return self.last_version.title
## def get_agenda_title_supplement(self):
## number = self.number or '<i>[%s]</i>' % ugettext('no number')
## return '(%s %s)' % (ugettext('motion'), number)
def get_allowed_actions(self, person):
"""
Gets a dictonary with all allowed actions for a specific person.
The dictonary contains the following actions.
* edit
* delete
* create_poll
* support
* unsupport
* change_state
* reset_state
"""
actions = {
2013-02-02 10:52:13 +01:00
'edit': ((self.is_submitter(person) and
self.state.edit_as_submitter) or
person.has_perm('motion.can_manage_motion')),
2013-02-02 10:52:13 +01:00
'create_poll': (person.has_perm('motion.can_manage_motion') and
self.state.create_poll),
2013-02-02 10:52:13 +01:00
'support': (self.state.support and
config['motion_min_supporters'] > 0 and
not self.is_submitter(person)),
'change_state': person.has_perm('motion.can_manage_motion'),
}
2013-02-02 10:52:13 +01:00
actions['delete'] = actions['edit'] # TODO: Only if the motion has no number
actions['unsupport'] = actions['support']
actions['reset_state'] = 'change_state'
return actions
def write_log(self, message, person=None):
MotionLog.objects.create(motion=self, message=message, person=person)
2013-02-03 13:24:29 +01:00
def activate_version(self, version):
"""
Activate a version of this motion.
'version' can be a version object, or the version_number of a version.
"""
if type(version) is int:
version = self.versions.get(version_number=version)
self.active_version = version
if version.rejected:
version.rejected = False
version.save()
def reject_version(self, version):
"""
Reject a version of this motion.
'version' can be a version object, or the version_number of a version.
"""
if type(version) is int:
version = self.versions.get(version_number=version)
if version.active:
raise MotionError('The active version can not be rejected')
version.rejected = True
version.save()
2013-01-06 12:07:37 +01:00
class MotionVersion(models.Model):
2013-02-03 13:24:29 +01:00
version_number = models.PositiveIntegerField(default=1)
2013-01-26 16:33:55 +01:00
title = models.CharField(max_length=255, verbose_name=ugettext_lazy("Title"))
2013-01-06 12:07:37 +01:00
text = models.TextField(verbose_name=_("Text"))
2013-01-26 16:33:55 +01:00
reason = models.TextField(null=True, blank=True, verbose_name=ugettext_lazy("Reason"))
2013-01-06 12:07:37 +01:00
rejected = models.BooleanField(default=False)
creation_time = models.DateTimeField(auto_now=True)
motion = models.ForeignKey(Motion, related_name='versions')
2013-01-26 16:33:55 +01:00
identifier = models.CharField(max_length=255, verbose_name=ugettext_lazy("Version identifier"))
2013-01-06 12:07:37 +01:00
note = models.TextField(null=True, blank=True)
2013-02-03 13:24:29 +01:00
class Meta:
unique_together = ("motion", "version_number")
2013-01-06 12:07:37 +01:00
def __unicode__(self):
2013-02-03 13:24:29 +01:00
counter = self.version_number or _('new')
return "%s Version %s" % (self.motion, counter)
2013-01-06 12:07:37 +01:00
2013-01-26 15:25:54 +01:00
def get_absolute_url(self, link='detail'):
if link == 'view' or link == 'detail':
return reverse('motion_version_detail', args=[str(self.motion.id),
str(self.version_number)])
@property
2013-02-03 13:24:29 +01:00
def active(self):
return self.active_version.exists()
2012-04-12 16:21:30 +02:00
2013-01-06 12:07:37 +01:00
class Category(models.Model):
2013-01-26 16:33:55 +01:00
name = models.CharField(max_length=255, verbose_name=ugettext_lazy("Category name"))
prefix = models.CharField(max_length=32, verbose_name=ugettext_lazy("Category prefix"))
2013-01-06 12:07:37 +01:00
def __unicode__(self):
return self.name
2013-01-06 12:07:37 +01:00
class Comment(models.Model):
motion_version = models.ForeignKey(MotionVersion)
text = models.TextField()
author = PersonField()
creation_time = models.DateTimeField(auto_now=True)
2013-02-01 12:51:54 +01:00
class MotionLog(models.Model):
motion = models.ForeignKey(Motion, related_name='log_messages')
message = models.CharField(max_length=255)
person = PersonField(null=True)
time = models.DateTimeField(auto_now=True)
class Meta:
ordering = ['-time']
def __unicode__(self):
# TODO: write time in the local time format.
if self.person is None:
return "%s %s" % (self.time, _(self.message))
else:
return "%s %s by %s" % (self.time, _(self.message), self.person)
2013-02-03 14:14:07 +01:00
2013-02-03 13:24:29 +01:00
class MotionError(Exception):
pass
2013-02-01 12:51:54 +01:00
class MotionVote(BaseVote):
option = models.ForeignKey('MotionOption')
class MotionOption(BaseOption):
poll = models.ForeignKey('MotionPoll')
vote_class = MotionVote
class MotionPoll(CountInvalid, CountVotesCast, BasePoll):
option_class = MotionOption
vote_values = [
ugettext_noop('Yes'), ugettext_noop('No'), ugettext_noop('Abstain')]
motion = models.ForeignKey(Motion, related_name='polls')
poll_number = models.PositiveIntegerField(default=1)
class Meta:
unique_together = ("motion", "poll_number")
def __unicode__(self):
return _('Ballot %d') % self.poll_number
2013-02-01 12:51:54 +01:00
def get_absolute_url(self, link='edit'):
if link == 'edit':
return reverse('motion_poll_edit', args=[str(self.motion.pk),
str(self.poll_number)])
if link == 'delete':
return reverse('motion_poll_delete', args=[str(self.motion.pk),
str(self.poll_number)])
2013-02-01 12:51:54 +01:00
def get_motion(self):
return self.motion
def set_options(self):
#TODO: maybe it is possible with .create() to call this without poll=self
self.get_option_class()(poll=self).save()
def append_pollform_fields(self, fields):
CountInvalid.append_pollform_fields(self, fields)
CountVotesCast.append_pollform_fields(self, fields)
def get_ballot(self):
return self.motion.motionpoll_set.filter(id__lte=self.id).count()