748 lines
25 KiB
Python
748 lines
25 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
"""
|
|
openslides.motion.models
|
|
~~~~~~~~~~~~~~~~~~~~~~~~
|
|
|
|
Models for the motion app.
|
|
|
|
To use a motion object, you only have to import the Motion class. Any
|
|
functionality can be reached from a motion object.
|
|
|
|
:copyright: (c) 2011-2013 by the OpenSlides team, see AUTHORS.
|
|
:license: GNU GPL, see LICENSE for more details.
|
|
"""
|
|
|
|
from datetime import datetime
|
|
|
|
from django.core.urlresolvers import reverse
|
|
from django.db import models
|
|
from django.db.models import Max
|
|
from django.dispatch import receiver
|
|
from django.utils import formats
|
|
from django.utils.translation import pgettext
|
|
from django.utils.translation import ugettext_lazy, ugettext_noop, ugettext as _
|
|
|
|
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 .exceptions import MotionError, WorkflowError
|
|
|
|
|
|
class Motion(SlideMixin, models.Model):
|
|
"""The Motion Class.
|
|
|
|
This class is the main entry point to all other classes related to a motion.
|
|
"""
|
|
|
|
prefix = 'motion'
|
|
"""Prefix for the slide system."""
|
|
|
|
active_version = models.ForeignKey('MotionVersion', null=True,
|
|
related_name="active_version")
|
|
"""Points to a specific version.
|
|
|
|
Used be the permitted-version-system to deside witch version is the active
|
|
Version. Could also be used to only choose a specific version as a default
|
|
version. Like the Sighted versions on Wikipedia.
|
|
"""
|
|
|
|
state = models.ForeignKey('State', null=True) # TODO: Check whether null=True is necessary.
|
|
"""The related state object.
|
|
|
|
This attribute is to get the current state of the motion.
|
|
"""
|
|
|
|
identifier = models.CharField(max_length=255, null=True, blank=True,
|
|
unique=True)
|
|
"""A string as human readable identifier for the motion."""
|
|
|
|
category = models.ForeignKey('Category', null=True, blank=True)
|
|
"""ForeignKey to one category of motions."""
|
|
|
|
# TODO: proposal
|
|
#master = models.ForeignKey('self', null=True, blank=True)
|
|
|
|
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',)
|
|
|
|
def __unicode__(self):
|
|
"""Return a human readable name of this motion."""
|
|
return self.get_title()
|
|
|
|
# TODO: Use transaction
|
|
def save(self, *args, **kwargs):
|
|
"""Save the motion.
|
|
|
|
1. Set the state of a new motion to the default state.
|
|
2. Save the motion object.
|
|
3. Save the version data.
|
|
4. Set the active version for the motion.
|
|
|
|
A new version will be saved if motion.new_version was called
|
|
between the creation of this object and the last call of motion.save()
|
|
|
|
or
|
|
|
|
If the motion has new version data (title, text, reason)
|
|
|
|
and
|
|
|
|
the config 'motion_create_new_version' is set to
|
|
'ALWAYS_CREATE_NEW_VERSION'.
|
|
"""
|
|
if not self.state:
|
|
self.reset_state()
|
|
|
|
super(Motion, self).save(*args, **kwargs)
|
|
|
|
# Find out if the version data has changed
|
|
for attr in ['title', 'text', 'reason']:
|
|
if not self.versions.exists():
|
|
new_data = True
|
|
break
|
|
if getattr(self, attr) != getattr(self.last_version, attr):
|
|
new_data = True
|
|
break
|
|
else:
|
|
new_data = False
|
|
|
|
# TODO: Check everything here. The decision whether to create a new version has to be done in the view. Update docstings too.
|
|
need_new_version = self.state.versioning
|
|
if hasattr(self, '_new_version') or (new_data and need_new_version):
|
|
version = self.new_version
|
|
del self._new_version
|
|
version.motion = self # TODO: Test if this line is really neccessary.
|
|
elif new_data and not need_new_version:
|
|
version = self.last_version
|
|
else:
|
|
# We do not need to save the motion version.
|
|
return
|
|
|
|
# Save title, text and reason in the version object
|
|
for attr in ['title', 'text', 'reason']:
|
|
_attr = '_%s' % attr
|
|
try:
|
|
setattr(version, attr, getattr(self, _attr))
|
|
delattr(self, _attr)
|
|
except AttributeError:
|
|
if self.versions.exists():
|
|
# If the _attr was not set, use the value from last_version
|
|
setattr(version, attr, getattr(self.last_version, attr))
|
|
|
|
# Set version_number of the new Version (if neccessary) and save it into the DB
|
|
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
|
|
version.save()
|
|
|
|
# Set the active version of this motion. This has to be done after the
|
|
# version is saved to the database
|
|
if not self.state.dont_set_new_version_active or self.active_version is None:
|
|
self.active_version = version
|
|
self.save()
|
|
|
|
def get_absolute_url(self, link='detail'):
|
|
"""Return an URL for this version.
|
|
|
|
The keyword argument 'link' can be 'detail', 'view', 'edit' or 'delete'.
|
|
"""
|
|
if link == 'view' or link == 'detail':
|
|
return reverse('motion_detail', args=[str(self.id)])
|
|
if link == 'edit':
|
|
return reverse('motion_edit', args=[str(self.id)])
|
|
if link == 'delete':
|
|
return reverse('motion_delete', args=[str(self.id)])
|
|
|
|
def get_title(self):
|
|
"""Get the title of the motion.
|
|
|
|
The titel is taken from motion.version.
|
|
"""
|
|
try:
|
|
return self._title
|
|
except AttributeError:
|
|
return self.version.title
|
|
|
|
def set_title(self, title):
|
|
"""Set the titel of the motion.
|
|
|
|
The titel will me saved into the version object, wenn motion.save() is
|
|
called.
|
|
"""
|
|
self._title = title
|
|
|
|
title = property(get_title, set_title)
|
|
"""The title of the motion.
|
|
|
|
Is saved in a MotionVersion object.
|
|
"""
|
|
|
|
def get_text(self):
|
|
"""Get the text of the motion.
|
|
|
|
Simular to get_title().
|
|
"""
|
|
try:
|
|
return self._text
|
|
except AttributeError:
|
|
return self.version.text
|
|
|
|
def set_text(self, text):
|
|
""" Set the text of the motion.
|
|
|
|
Simular to set_title().
|
|
"""
|
|
self._text = text
|
|
|
|
text = property(get_text, set_text)
|
|
"""The text of a motin.
|
|
|
|
Is saved in a MotionVersion object.
|
|
"""
|
|
|
|
def get_reason(self):
|
|
"""Get the reason of the motion.
|
|
|
|
Simular to get_title().
|
|
"""
|
|
try:
|
|
return self._reason
|
|
except AttributeError:
|
|
return self.version.reason
|
|
|
|
def set_reason(self, reason):
|
|
"""Set the reason of the motion.
|
|
|
|
Simular to set_title().
|
|
"""
|
|
self._reason = reason
|
|
|
|
reason = property(get_reason, set_reason)
|
|
"""The reason for the motion.
|
|
|
|
Is saved in a MotionVersion object.
|
|
"""
|
|
|
|
@property
|
|
def new_version(self):
|
|
"""Return a version object, not saved in the database.
|
|
|
|
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.
|
|
"""
|
|
try:
|
|
return self._version
|
|
except AttributeError:
|
|
return self.last_version
|
|
|
|
def set_version(self, version):
|
|
"""Set the 'active' version object.
|
|
|
|
The keyword argument 'version' can be a MotionVersion object or the
|
|
version_number of a version object or None.
|
|
|
|
If the argument is None, the newest version will be used.
|
|
"""
|
|
if version is None:
|
|
try:
|
|
del self._version
|
|
except AttributeError:
|
|
pass
|
|
else:
|
|
if type(version) is int:
|
|
version = self.versions.get(version_number=version)
|
|
elif type(version) is not MotionVersion:
|
|
raise ValueError('The argument \'version\' has to be int or '
|
|
'MotionVersion, not %s' % type(version))
|
|
# TODO: Test, that the version is one of this motion
|
|
self._version = version
|
|
|
|
version = property(get_version, set_version)
|
|
"""The active version of this motion."""
|
|
|
|
@property
|
|
def last_version(self):
|
|
"""Return the newest version of the motion."""
|
|
# TODO: Fix the case, that the motion has no version
|
|
try:
|
|
return self.versions.order_by('-version_number')[0]
|
|
except IndexError:
|
|
return self.new_version
|
|
|
|
@property
|
|
def submitters(self):
|
|
return sorted([object.person for object in self.submitter.all()],
|
|
key=lambda person: person.sort_name)
|
|
|
|
def is_submitter(self, person):
|
|
"""Return True, if person is a submitter of this motion. Else: False."""
|
|
self.submitter.filter(person=person).exists()
|
|
|
|
@property
|
|
def supporters(self):
|
|
return sorted([object.person for object in self.supporter.all()],
|
|
key=lambda person: person.sort_name)
|
|
|
|
def is_supporter(self, person):
|
|
"""Return True, if person is a supporter of this motion. Else: False."""
|
|
return self.supporter.filter(person=person).exists()
|
|
|
|
def support(self, person):
|
|
"""Add 'person' as a supporter of this motion."""
|
|
if self.state.allow_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 'person' as supporter from this motion."""
|
|
if self.state.allow_support:
|
|
self.supporter.filter(person=person).delete()
|
|
else:
|
|
raise WorkflowError('You can not unsupport a motion in state %s.' % self.state.name)
|
|
|
|
def create_poll(self):
|
|
"""Create a new poll for this motion.
|
|
|
|
Return the new poll object.
|
|
"""
|
|
if self.state.allow_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)
|
|
|
|
def reset_state(self):
|
|
"""Set the state to the default state. If the motion is new, it chooses the default workflow from config."""
|
|
if self.state:
|
|
self.state = self.state.workflow.first_state
|
|
else:
|
|
self.state = Workflow.objects.get(pk=config['motion_workflow']).first_state
|
|
|
|
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
|
|
|
|
def get_agenda_title(self):
|
|
"""Return a title for the Agenda."""
|
|
return self.last_version.title # TODO: nutze active_version
|
|
|
|
## 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):
|
|
"""Return 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 = {
|
|
'edit': ((self.is_submitter(person) and
|
|
self.state.allow_submitter_edit) or
|
|
person.has_perm('motion.can_manage_motion')),
|
|
|
|
'create_poll': (person.has_perm('motion.can_manage_motion') and
|
|
self.state.allow_create_poll),
|
|
|
|
'support': (self.state.allow_support and
|
|
config['motion_min_supporters'] > 0 and
|
|
not self.is_submitter(person) and
|
|
not self.is_supporter(person)),
|
|
|
|
'unsupport': (self.state.allow_support and
|
|
not self.is_submitter(person) and
|
|
self.is_supporter(person)),
|
|
|
|
'change_state': person.has_perm('motion.can_manage_motion'),
|
|
|
|
}
|
|
actions['delete'] = actions['edit'] # TODO: Only if the motion has no number
|
|
actions['reset_state'] = actions['change_state']
|
|
return actions
|
|
|
|
def write_log(self, message, person=None):
|
|
"""Write a log message.
|
|
|
|
Message should be in english and translatable.
|
|
|
|
e.g.: motion.write_log(ugettext_noob('Message Text'))
|
|
"""
|
|
MotionLog.objects.create(motion=self, message=message, person=person)
|
|
|
|
def activate_version(self, version):
|
|
"""Set the active state of a version to True.
|
|
|
|
'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()
|
|
|
|
|
|
class MotionVersion(models.Model):
|
|
"""
|
|
A MotionVersion object saves some date of the motion."""
|
|
|
|
motion = models.ForeignKey(Motion, related_name='versions')
|
|
"""The motion to which the version belongs."""
|
|
|
|
version_number = models.PositiveIntegerField(default=1)
|
|
"""An id for this version in realation to a motion.
|
|
|
|
Is unique for each motion.
|
|
"""
|
|
|
|
title = models.CharField(max_length=255, verbose_name=ugettext_lazy("Title"))
|
|
"""The title of a motion."""
|
|
|
|
text = models.TextField(verbose_name=_("Text"))
|
|
"""The text of a motion."""
|
|
|
|
reason = models.TextField(null=True, blank=True, verbose_name=ugettext_lazy("Reason"))
|
|
"""The reason for a motion."""
|
|
|
|
rejected = models.BooleanField(default=False)
|
|
"""Saves if the version is rejected."""
|
|
|
|
creation_time = models.DateTimeField(auto_now=True)
|
|
"""Time when the version was saved."""
|
|
|
|
#identifier = models.CharField(max_length=255, verbose_name=ugettext_lazy("Version identifier"))
|
|
#note = models.TextField(null=True, blank=True)
|
|
|
|
class Meta:
|
|
unique_together = ("motion", "version_number")
|
|
|
|
def __unicode__(self):
|
|
"""Return a string, representing this object."""
|
|
counter = self.version_number or _('new')
|
|
return "%s Version %s" % (self.motion, counter) # TODO: Should this really be self.motion or the title of the specific version?
|
|
|
|
def get_absolute_url(self, link='detail'):
|
|
"""Return the URL of this Version.
|
|
|
|
The keyargument link can be 'view' or 'detail'.
|
|
"""
|
|
if link == 'view' or link == 'detail':
|
|
return reverse('motion_version_detail', args=[str(self.motion.id),
|
|
str(self.version_number)])
|
|
|
|
@property
|
|
def active(self):
|
|
"""Return True, if the version is the active version of a motion. Else: False."""
|
|
return self.active_version.exists()
|
|
|
|
|
|
class MotionSubmitter(models.Model):
|
|
"""Save the submitter of a Motion."""
|
|
|
|
motion = models.ForeignKey('Motion', related_name="submitter")
|
|
"""The motion to witch the object belongs."""
|
|
|
|
person = PersonField()
|
|
"""The person, who is the submitter."""
|
|
|
|
def __unicode__(self):
|
|
"""Return the name of the submitter as string."""
|
|
return unicode(self.person)
|
|
|
|
|
|
class MotionSupporter(models.Model):
|
|
"""Save the submitter of a Motion."""
|
|
|
|
motion = models.ForeignKey('Motion', related_name="supporter")
|
|
"""The motion to witch the object belongs."""
|
|
|
|
person = PersonField()
|
|
"""The person, who is the supporter."""
|
|
|
|
def __unicode__(self):
|
|
"""Return the name of the supporter as string."""
|
|
return unicode(self.person)
|
|
|
|
|
|
class Category(models.Model):
|
|
name = models.CharField(max_length=255, verbose_name=ugettext_lazy("Category name"))
|
|
prefix = models.CharField(max_length=32, verbose_name=ugettext_lazy("Prefix"))
|
|
|
|
def __unicode__(self):
|
|
return self.name
|
|
|
|
def get_absolute_url(self, link='update'):
|
|
if link == 'update' or link == 'edit':
|
|
return reverse('motion_category_update', args=[str(self.id)])
|
|
if link == 'delete':
|
|
return reverse('motion_category_delete', args=[str(self.id)])
|
|
|
|
class Meta:
|
|
ordering = ['prefix']
|
|
|
|
## class Comment(models.Model):
|
|
## motion_version = models.ForeignKey(MotionVersion)
|
|
## text = models.TextField()
|
|
## author = PersonField()
|
|
## creation_time = models.DateTimeField(auto_now=True)
|
|
|
|
|
|
class MotionLog(models.Model):
|
|
"""Save a logmessage for a motion."""
|
|
|
|
motion = models.ForeignKey(Motion, related_name='log_messages')
|
|
"""The motion to witch the object belongs."""
|
|
|
|
message = models.CharField(max_length=255) # TODO: arguments in message, not translatable
|
|
"""The log message.
|
|
|
|
Should be in english.
|
|
"""
|
|
|
|
person = PersonField(null=True)
|
|
"""A person object, who created the log message. Optional."""
|
|
|
|
time = models.DateTimeField(auto_now=True)
|
|
"""The Time, when the loged action was performed."""
|
|
|
|
class Meta:
|
|
ordering = ['-time']
|
|
|
|
def __unicode__(self):
|
|
"""Return a string, representing the log message."""
|
|
time = formats.date_format(self.time, 'DATETIME_FORMAT')
|
|
if self.person is None:
|
|
return "%s %s" % (time, _(self.message))
|
|
else:
|
|
return "%s %s by %s" % (time, _(self.message), self.person)
|
|
|
|
|
|
class MotionVote(BaseVote):
|
|
"""Saves the votes for a MotionPoll.
|
|
|
|
There should allways be three MotionVote objects for each poll,
|
|
one for 'yes', 'no', and 'abstain'."""
|
|
|
|
option = models.ForeignKey('MotionOption')
|
|
"""The option object, to witch the vote belongs."""
|
|
|
|
|
|
class MotionOption(BaseOption):
|
|
"""Links between the MotionPollClass and the MotionVoteClass.
|
|
|
|
There should be one MotionOption object for each poll."""
|
|
|
|
poll = models.ForeignKey('MotionPoll')
|
|
"""The poll object, to witch the object belongs."""
|
|
|
|
vote_class = MotionVote
|
|
"""The VoteClass, to witch this Class links."""
|
|
|
|
|
|
class MotionPoll(CountInvalid, CountVotesCast, BasePoll):
|
|
"""The Class to saves the poll results for a motion poll."""
|
|
|
|
motion = models.ForeignKey(Motion, related_name='polls')
|
|
"""The motion to witch the object belongs."""
|
|
|
|
option_class = MotionOption
|
|
"""The option class, witch links between this object the the votes."""
|
|
|
|
vote_values = [
|
|
ugettext_noop('Yes'), ugettext_noop('No'), ugettext_noop('Abstain')]
|
|
"""The possible anwers for the poll. 'Yes, 'No' and 'Abstain'."""
|
|
|
|
poll_number = models.PositiveIntegerField(default=1)
|
|
"""An id for this poll in realation to a motion.
|
|
|
|
Is unique for each motion.
|
|
"""
|
|
|
|
class Meta:
|
|
unique_together = ("motion", "poll_number")
|
|
|
|
def __unicode__(self):
|
|
"""Return a string, representing the poll."""
|
|
return _('Ballot %d') % self.poll_number
|
|
|
|
def get_absolute_url(self, link='edit'):
|
|
"""Return an URL for the poll.
|
|
|
|
The keyargument 'link' can be 'edit' or 'delete'.
|
|
"""
|
|
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)])
|
|
|
|
def set_options(self):
|
|
"""Create the option class for this poll."""
|
|
#TODO: maybe it is possible with .create() to call this without poll=self
|
|
# or call this in save()
|
|
self.get_option_class()(poll=self).save()
|
|
|
|
def append_pollform_fields(self, fields):
|
|
"""Apend the fields for invalid and votecast to the ModelForm."""
|
|
CountInvalid.append_pollform_fields(self, fields)
|
|
CountVotesCast.append_pollform_fields(self, fields)
|
|
|
|
|
|
class State(models.Model):
|
|
"""Defines a state for a motion.
|
|
|
|
Every state belongs to a workflow. All states of a workflow are linked together
|
|
via 'next_states'. One of these states is the first state, but this
|
|
is saved in the workflow table (one-to-one relation). In every state
|
|
you can configure some handling of a motion. See the following fields
|
|
for more information.
|
|
"""
|
|
|
|
name = models.CharField(max_length=255)
|
|
"""A string representing the state."""
|
|
|
|
action_word = models.CharField(max_length=255)
|
|
"""An alternative string to be used for a button to switch to this state."""
|
|
|
|
workflow = models.ForeignKey('Workflow')
|
|
"""A many-to-one relation to a workflow."""
|
|
|
|
next_states = models.ManyToManyField('self', symmetrical=False)
|
|
"""A many-to-many relation to all states, that can be choosen from this state."""
|
|
|
|
icon = models.CharField(max_length=255)
|
|
"""A string representing the url to the icon-image."""
|
|
|
|
allow_support = models.BooleanField(default=False)
|
|
"""If true, persons can support the motion in this state."""
|
|
|
|
allow_create_poll = models.BooleanField(default=False)
|
|
"""If true, polls can be created in this state."""
|
|
|
|
allow_submitter_edit = models.BooleanField(default=False)
|
|
"""If true, the submitter can edit the motion in this state."""
|
|
|
|
versioning = models.BooleanField(default=False)
|
|
"""
|
|
If true, editing the motion will create a new version by default.
|
|
This behavior can be changed by the form and view, e. g. via the
|
|
MotionDisableVersioningMixin.
|
|
"""
|
|
|
|
dont_set_new_version_active = models.BooleanField(default=False)
|
|
"""If true, new versions are not automaticly set active."""
|
|
|
|
def __unicode__(self):
|
|
"""Returns the name of the state."""
|
|
return self.name
|
|
|
|
def save(self, **kwargs):
|
|
"""Saves a state to the database.
|
|
|
|
Used to check the integrity before saving.
|
|
"""
|
|
self.check_next_states()
|
|
super(State, self).save(**kwargs)
|
|
|
|
def get_action_word(self):
|
|
"""Returns the alternative name of the state if it exists."""
|
|
return self.action_word or self.name
|
|
|
|
def check_next_states(self):
|
|
"""Checks whether all next states of a state belong to the correct workflow."""
|
|
# No check if it is a new state which has not been saved yet.
|
|
if not self.id:
|
|
return
|
|
for state in self.next_states.all():
|
|
if not state.workflow == self.workflow:
|
|
raise WorkflowError('%s can not be next state of %s because it does not belong to the same workflow.' % (state, self))
|
|
|
|
|
|
class Workflow(models.Model):
|
|
"""Defines a workflow for a motion."""
|
|
|
|
name = models.CharField(max_length=255)
|
|
"""A string representing the workflow."""
|
|
|
|
first_state = models.OneToOneField(State, related_name='+')
|
|
"""A one-to-one relation to a state, the starting point for the workflow."""
|
|
|
|
def __unicode__(self):
|
|
"""Returns the name of the workflow."""
|
|
return self.name
|
|
|
|
def save(self, **kwargs):
|
|
"""Saves a workflow to the database.
|
|
|
|
Used to check the integrity before saving.
|
|
"""
|
|
self.check_first_state()
|
|
super(Workflow, self).save(**kwargs)
|
|
|
|
def check_first_state(self):
|
|
"""Checks whether the first_state itself belongs to the workflow."""
|
|
if not self.first_state.workflow == self:
|
|
raise WorkflowError('%s can not be first state of %s because it does not belong to it.' % (self.first_state, self))
|