12a08b9732
Changed agenda item, so it can not be manualy created, but is always created when a custom slide, motion or assignment is created.
837 lines
27 KiB
Python
837 lines
27 KiB
Python
from django.conf import settings
|
|
from django.contrib.contenttypes.models import ContentType
|
|
from django.db import models
|
|
from django.db.models import Max
|
|
from django.utils import formats
|
|
from django.utils.translation import ugettext as _
|
|
from django.utils.translation import ugettext_lazy, ugettext_noop
|
|
from jsonfield import JSONField
|
|
|
|
from openslides.agenda.models import Item
|
|
from openslides.core.config import config
|
|
from openslides.core.models import Tag
|
|
from openslides.mediafiles.models import Mediafile
|
|
from openslides.poll.models import (
|
|
BaseOption,
|
|
BasePoll,
|
|
BaseVote,
|
|
CollectDefaultVotesMixin,
|
|
)
|
|
from openslides.utils.models import RESTModelMixin
|
|
|
|
from .exceptions import WorkflowError
|
|
|
|
|
|
class Motion(RESTModelMixin, models.Model):
|
|
"""
|
|
The Motion Class.
|
|
|
|
This class is the main entry point to all other classes related to a motion.
|
|
"""
|
|
|
|
slide_callback_name = 'motion'
|
|
"""
|
|
Name of the callback for the slide-system.
|
|
"""
|
|
|
|
active_version = models.ForeignKey('MotionVersion', null=True,
|
|
related_name="active_version",
|
|
on_delete=models.SET_NULL)
|
|
"""
|
|
Points to a specific version.
|
|
|
|
Used be the permitted-version-system to deside which 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.
|
|
"""
|
|
|
|
identifier_number = models.IntegerField(null=True)
|
|
"""
|
|
Counts the number of the motion in one category.
|
|
|
|
Needed to find the next free motion identifier.
|
|
"""
|
|
|
|
category = models.ForeignKey('Category', null=True, blank=True)
|
|
"""
|
|
ForeignKey to one category of motions.
|
|
"""
|
|
|
|
attachments = models.ManyToManyField(Mediafile, blank=True)
|
|
"""
|
|
Many to many relation to mediafile objects.
|
|
"""
|
|
|
|
parent = models.ForeignKey('self', null=True, blank=True, related_name='amendments')
|
|
"""
|
|
Field for amendments to reference to the motion that should be altered.
|
|
|
|
Null if the motion is not an amendment.
|
|
"""
|
|
|
|
tags = models.ManyToManyField(Tag, blank=True)
|
|
"""
|
|
Tags to categorise motions.
|
|
"""
|
|
|
|
submitters = models.ManyToManyField(settings.AUTH_USER_MODEL, related_name='motion_submitters', blank=True)
|
|
"""
|
|
Users who submit this motion.
|
|
"""
|
|
|
|
supporters = models.ManyToManyField(settings.AUTH_USER_MODEL, related_name='motion_supporters', blank=True)
|
|
"""
|
|
Users who support this motion.
|
|
"""
|
|
|
|
class Meta:
|
|
permissions = (
|
|
('can_see', ugettext_noop('Can see motions')),
|
|
('can_create', ugettext_noop('Can create motions')),
|
|
('can_support', ugettext_noop('Can support motions')),
|
|
('can_manage', ugettext_noop('Can manage motions')),
|
|
)
|
|
ordering = ('identifier', )
|
|
verbose_name = ugettext_noop('Motion')
|
|
|
|
def __str__(self):
|
|
"""
|
|
Return a human readable name of this motion.
|
|
"""
|
|
if self.identifier:
|
|
string = '%s | %s' % (self.identifier, self.title)
|
|
else:
|
|
string = self.title
|
|
return string
|
|
|
|
# TODO: Use transaction
|
|
def save(self, use_version=None, *args, **kwargs):
|
|
"""
|
|
Save the motion.
|
|
|
|
1. Set the state of a new motion to the default state.
|
|
2. Ensure that the identifier is not an empty string.
|
|
3. Save the motion object.
|
|
4. Save the version data.
|
|
5. Set the active version for the motion if a new version object was saved.
|
|
|
|
The version data is *not* saved, if
|
|
1. the django-feature 'update_fields' is used or
|
|
2. the argument use_version is False (differ to None).
|
|
|
|
The argument use_version is choose the version object into which the
|
|
version data is saved.
|
|
* If use_version is False, no version data is saved.
|
|
* If use_version is None, the last version is used.
|
|
* Else the given version is used.
|
|
|
|
To create and use a new version object, you have to set it via the
|
|
use_version argument. You have to set the title, text and reason into
|
|
this version object before giving it to this save method. The properties
|
|
motion.title, motion.text and motion.reason will be ignored.
|
|
"""
|
|
if not self.state:
|
|
self.reset_state()
|
|
|
|
# Solves the problem, that there can only be one motion with an empty
|
|
# string as identifier.
|
|
if not self.identifier and isinstance(self.identifier, str):
|
|
self.identifier = None
|
|
|
|
super(Motion, self).save(*args, **kwargs)
|
|
|
|
if 'update_fields' in kwargs:
|
|
# Do not save the version data if only some motion fields are updated.
|
|
return
|
|
|
|
if use_version is False:
|
|
# We do not need to save the version.
|
|
return
|
|
elif use_version is None:
|
|
use_version = self.get_last_version()
|
|
# Save title, text and reason into the version object.
|
|
for attr in ['title', 'text', 'reason']:
|
|
_attr = '_%s' % attr
|
|
data = getattr(self, _attr, None)
|
|
if data is not None:
|
|
setattr(use_version, attr, data)
|
|
delattr(self, _attr)
|
|
|
|
# If version is not in the database, test if it has new data and set
|
|
# the version_number.
|
|
if use_version.id is None:
|
|
if not self.version_data_changed(use_version):
|
|
# We do not need to save the version.
|
|
return
|
|
version_number = self.versions.aggregate(Max('version_number'))['version_number__max'] or 0
|
|
use_version.version_number = version_number + 1
|
|
|
|
# Necessary line if the version was set before the motion got an id.
|
|
use_version.motion = use_version.motion
|
|
|
|
use_version.save()
|
|
|
|
# Set the active version of this motion. This has to be done after the
|
|
# version is saved in the database.
|
|
# TODO: Move parts of these last lines of code outside the save method
|
|
# when other versions than the last ones should be edited later on.
|
|
if self.active_version is None or not self.state.leave_old_version_active:
|
|
# TODO: Don't call this if it was not a new version
|
|
self.active_version = use_version
|
|
self.save(update_fields=['active_version'])
|
|
|
|
def version_data_changed(self, version):
|
|
"""
|
|
Compare the version with the last version of the motion.
|
|
|
|
Returns True if the version data (title, text, reason) is different,
|
|
else returns False.
|
|
"""
|
|
if not self.versions.exists():
|
|
# If there is no version in the database, the data has always changed.
|
|
return True
|
|
|
|
last_version = self.get_last_version()
|
|
for attr in ['title', 'text', 'reason']:
|
|
if getattr(last_version, attr) != getattr(version, attr):
|
|
return True
|
|
return False
|
|
|
|
def set_identifier(self):
|
|
"""
|
|
Sets the motion identifier automaticly according to the config value if
|
|
it is not set yet.
|
|
"""
|
|
# The identifier is already set or should be set manually
|
|
if config['motions_identifier'] == 'manually' or self.identifier:
|
|
# Do not set an identifier.
|
|
return
|
|
|
|
# The motion is an amendment
|
|
elif self.is_amendment():
|
|
motions = self.parent.amendments.all()
|
|
|
|
# The motions should be counted per category
|
|
elif config['motions_identifier'] == 'per_category':
|
|
motions = Motion.objects.filter(category=self.category)
|
|
|
|
# The motions should be counted over all.
|
|
else:
|
|
motions = Motion.objects.all()
|
|
|
|
number = motions.aggregate(Max('identifier_number'))['identifier_number__max'] or 0
|
|
if self.is_amendment():
|
|
parent_identifier = self.parent.identifier or ''
|
|
prefix = '%s %s ' % (parent_identifier, config['motions_amendments_prefix'])
|
|
elif self.category is None or not self.category.prefix:
|
|
prefix = ''
|
|
else:
|
|
prefix = '%s ' % self.category.prefix
|
|
|
|
number += 1
|
|
identifier = '%s%d' % (prefix, number)
|
|
while Motion.objects.filter(identifier=identifier).exists():
|
|
number += 1
|
|
identifier = '%s%d' % (prefix, number)
|
|
|
|
self.identifier = identifier
|
|
self.identifier_number = number
|
|
|
|
def get_title(self):
|
|
"""
|
|
Get the title of the motion.
|
|
|
|
The title is taken from motion.version.
|
|
"""
|
|
try:
|
|
return self._title
|
|
except AttributeError:
|
|
return self.get_active_version().title
|
|
|
|
def set_title(self, title):
|
|
"""
|
|
Set the title of the motion.
|
|
|
|
The title will be saved in the version object, when 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.get_active_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.get_active_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.
|
|
"""
|
|
|
|
def get_new_version(self, **kwargs):
|
|
"""
|
|
Return a version object, not saved in the database.
|
|
|
|
The version data of the new version object is populated with the data
|
|
set via motion.title, motion.text, motion.reason if these data are
|
|
not given as keyword arguments. If the data is not set in the motion
|
|
attributes, it is populated with the data from the last version
|
|
object if such object exists.
|
|
"""
|
|
if self.pk is None:
|
|
# Do not reference the MotionVersion object to an unsaved motion
|
|
new_version = MotionVersion(**kwargs)
|
|
else:
|
|
new_version = MotionVersion(motion=self, **kwargs)
|
|
if self.versions.exists():
|
|
last_version = self.get_last_version()
|
|
else:
|
|
last_version = None
|
|
for attr in ['title', 'text', 'reason']:
|
|
if attr in kwargs:
|
|
continue
|
|
_attr = '_%s' % attr
|
|
data = getattr(self, _attr, None)
|
|
if data is None and last_version is not None:
|
|
data = getattr(last_version, attr)
|
|
if data is not None:
|
|
setattr(new_version, attr, data)
|
|
return new_version
|
|
|
|
def get_active_version(self):
|
|
"""
|
|
Returns the active version of the motion.
|
|
|
|
If no active version is set by now, the last_version is used.
|
|
"""
|
|
if self.active_version:
|
|
return self.active_version
|
|
else:
|
|
return self.get_last_version()
|
|
|
|
def get_last_version(self):
|
|
"""
|
|
Return the newest version of the motion.
|
|
"""
|
|
try:
|
|
return self.versions.order_by('-version_number')[0]
|
|
except IndexError:
|
|
return self.get_new_version()
|
|
|
|
def is_submitter(self, user):
|
|
"""
|
|
Returns True if user is a submitter of this motion, else False.
|
|
"""
|
|
return user in self.submitters.all()
|
|
|
|
def is_supporter(self, user):
|
|
"""
|
|
Returns True if user is a supporter of this motion, else False.
|
|
"""
|
|
return user in self.supporters.all()
|
|
|
|
def create_poll(self):
|
|
"""
|
|
Create a new poll for this motion.
|
|
|
|
Return the new poll object.
|
|
"""
|
|
if self.state.allow_create_poll:
|
|
poll = MotionPoll.objects.create(motion=self)
|
|
poll.set_options()
|
|
return poll
|
|
else:
|
|
raise WorkflowError('You can not create a poll in state %s.' % self.state.name)
|
|
|
|
@property
|
|
def workflow(self):
|
|
"""
|
|
Returns the id of the workflow of the motion.
|
|
"""
|
|
return self.state.workflow.pk
|
|
|
|
def set_state(self, state):
|
|
"""
|
|
Set the state of the motion.
|
|
|
|
'state' can be the id of a state object or a state object.
|
|
"""
|
|
if type(state) is int:
|
|
state = State.objects.get(pk=state)
|
|
|
|
if not state.dont_set_identifier:
|
|
self.set_identifier()
|
|
self.state = state
|
|
|
|
def reset_state(self, workflow=None):
|
|
"""
|
|
Set the state to the default state.
|
|
|
|
'workflow' can be a workflow, an id of a workflow or None.
|
|
|
|
If the motion is new and workflow is None, it chooses the default
|
|
workflow from config.
|
|
"""
|
|
if type(workflow) is int:
|
|
workflow = Workflow.objects.get(pk=workflow)
|
|
|
|
if workflow is not None:
|
|
new_state = workflow.first_state
|
|
elif self.state:
|
|
new_state = self.state.workflow.first_state
|
|
else:
|
|
new_state = (Workflow.objects.get(pk=config['motions_workflow']).first_state or
|
|
Workflow.objects.get(pk=config['motions_workflow']).state_set.all()[0])
|
|
self.set_state(new_state)
|
|
|
|
def get_agenda_title(self):
|
|
"""
|
|
Return a title for the agenda.
|
|
"""
|
|
# There has to be a function with the same return value in javascript.
|
|
return str(self)
|
|
|
|
@property
|
|
def agenda_item(self):
|
|
"""
|
|
Returns the related agenda item.
|
|
"""
|
|
content_type = ContentType.objects.get_for_model(self)
|
|
return Item.objects.get(object_id=self.pk, content_type=content_type)
|
|
|
|
@property
|
|
def agenda_item_id(self):
|
|
"""
|
|
Returns the id of the agenda item object related to this object.
|
|
"""
|
|
return self.agenda_item.pk
|
|
|
|
def get_allowed_actions(self, person):
|
|
"""
|
|
Return a dictonary with all allowed actions for a specific person.
|
|
|
|
The dictonary contains the following actions.
|
|
|
|
* see
|
|
* update / edit
|
|
* delete
|
|
* create_poll
|
|
* support
|
|
* unsupport
|
|
* change_state
|
|
* reset_state
|
|
"""
|
|
# TODO: Remove this method and implement these things in the views.
|
|
actions = {
|
|
'see': (person.has_perm('motions.can_see') and
|
|
(not self.state.required_permission_to_see or
|
|
person.has_perm(self.state.required_permission_to_see) or
|
|
self.is_submitter(person))),
|
|
|
|
'update': (person.has_perm('motions.can_manage') or
|
|
(self.is_submitter(person) and
|
|
self.state.allow_submitter_edit)),
|
|
|
|
'delete': person.has_perm('motions.can_manage'),
|
|
|
|
'create_poll': (person.has_perm('motions.can_manage') and
|
|
self.state.allow_create_poll),
|
|
|
|
'support': (self.state.allow_support and
|
|
config['motions_min_supporters'] > 0 and
|
|
not self.is_submitter(person) and
|
|
not self.is_supporter(person)),
|
|
|
|
'unsupport': (self.state.allow_support and
|
|
self.is_supporter(person)),
|
|
|
|
'change_state': person.has_perm('motions.can_manage'),
|
|
|
|
'reset_state': person.has_perm('motions.can_manage')}
|
|
|
|
actions['edit'] = actions['update']
|
|
|
|
return actions
|
|
|
|
def write_log(self, message_list, person=None):
|
|
"""
|
|
Write a log message.
|
|
|
|
The message should be in English and translatable,
|
|
e. g. motion.write_log(message_list=[ugettext_noop('Message Text')])
|
|
"""
|
|
MotionLog.objects.create(motion=self, message_list=message_list, person=person)
|
|
|
|
def is_amendment(self):
|
|
"""
|
|
Returns True if the motion is an amendment.
|
|
|
|
A motion is a amendment if amendments are activated in the config and
|
|
the motion has a parent.
|
|
"""
|
|
return config['motions_amendments_enabled'] and self.parent is not None
|
|
|
|
|
|
class MotionVersion(RESTModelMixin, 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=ugettext_lazy("Text"))
|
|
"""The text of a motion."""
|
|
|
|
reason = models.TextField(null=True, blank=True, verbose_name=ugettext_lazy("Reason"))
|
|
"""The reason for a motion."""
|
|
|
|
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 __str__(self):
|
|
"""Return a string, representing this object."""
|
|
counter = self.version_number or ugettext_lazy('new')
|
|
return "Motion %s, Version %s" % (self.motion_id, counter)
|
|
|
|
@property
|
|
def active(self):
|
|
"""Return True, if the version is the active version of a motion. Else: False."""
|
|
return self.active_version.exists()
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the motion to this instance which is the root REST element.
|
|
"""
|
|
return self.motion
|
|
|
|
|
|
class Category(RESTModelMixin, models.Model):
|
|
name = models.CharField(max_length=255, verbose_name=ugettext_lazy("Category name"))
|
|
"""Name of the category."""
|
|
|
|
prefix = models.CharField(blank=True, max_length=32, verbose_name=ugettext_lazy("Prefix"))
|
|
"""Prefix of the category.
|
|
|
|
Used to build the identifier of a motion.
|
|
"""
|
|
|
|
def __str__(self):
|
|
return self.name
|
|
|
|
class Meta:
|
|
ordering = ['prefix']
|
|
|
|
|
|
class MotionLog(RESTModelMixin, models.Model):
|
|
"""Save a logmessage for a motion."""
|
|
|
|
motion = models.ForeignKey(Motion, related_name='log_messages')
|
|
"""The motion to witch the object belongs."""
|
|
|
|
message_list = JSONField()
|
|
"""
|
|
The log message. It should be a list of strings in English.
|
|
"""
|
|
|
|
person = models.ForeignKey(settings.AUTH_USER_MODEL, null=True)
|
|
"""A user 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 __str__(self):
|
|
"""
|
|
Return a string, representing the log message.
|
|
"""
|
|
time = formats.date_format(self.time, 'DATETIME_FORMAT')
|
|
time_and_messages = '%s ' % time + ''.join(map(_, self.message_list))
|
|
if self.person is not None:
|
|
return _('%(time_and_messages)s by %(person)s') % {'time_and_messages': time_and_messages,
|
|
'person': self.person}
|
|
return time_and_messages
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the motion to this instance which is the root REST element.
|
|
"""
|
|
return self.motion
|
|
|
|
|
|
class MotionVote(RESTModelMixin, 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."""
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the motion to this instance which is the root REST element.
|
|
"""
|
|
return self.option.poll.motion
|
|
|
|
|
|
class MotionOption(RESTModelMixin, 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."""
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the motion to this instance which is the root REST element.
|
|
"""
|
|
return self.poll.motion
|
|
|
|
|
|
class MotionPoll(RESTModelMixin, CollectDefaultVotesMixin, BasePoll):
|
|
"""The Class to saves the vote result for a motion poll."""
|
|
|
|
slide_callback_name = 'motionpoll'
|
|
"""Name of the callback for the slide-system."""
|
|
|
|
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'."""
|
|
|
|
def __str__(self):
|
|
"""
|
|
Representation method only for debugging purposes.
|
|
"""
|
|
return 'MotionPoll for motion %s' % self.motion
|
|
|
|
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 get_percent_base_choice(self):
|
|
return config['motions_poll_100_percent_base']
|
|
|
|
def get_slide_context(self, **context):
|
|
return super(MotionPoll, self).get_slide_context(poll=self)
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the motion to this instance which is the root REST element.
|
|
"""
|
|
return self.motion
|
|
|
|
|
|
class State(RESTModelMixin, 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."""
|
|
|
|
required_permission_to_see = models.CharField(max_length=255, blank=True)
|
|
"""
|
|
A permission string. If not empty, the user has to have this permission to
|
|
see a motion in this state.
|
|
|
|
To use this feature change the database entry of a state object and add
|
|
your favourite permission string. You can do this e. g. by editing the
|
|
definitions in create_builtin_workflows() in openslides/motions/signals.py.
|
|
"""
|
|
|
|
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.
|
|
"""
|
|
|
|
leave_old_version_active = models.BooleanField(default=False)
|
|
"""If true, new versions are not automaticly set active."""
|
|
|
|
dont_set_identifier = models.BooleanField(default=False)
|
|
"""
|
|
Decides if the motion gets an identifier.
|
|
|
|
If true, the motion does not get an identifier if the state change to
|
|
this one, else it does.
|
|
"""
|
|
|
|
def __str__(self):
|
|
"""Returns the name of the state."""
|
|
return self.name
|
|
|
|
def save(self, **kwargs):
|
|
"""Saves a state in 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))
|
|
|
|
def get_root_rest_element(self):
|
|
"""
|
|
Returns the workflow to this instance which is the root REST element.
|
|
"""
|
|
return self.workflow
|
|
|
|
|
|
class Workflow(RESTModelMixin, 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='+', null=True)
|
|
"""A one-to-one relation to a state, the starting point for the workflow."""
|
|
|
|
def __str__(self):
|
|
"""Returns the name of the workflow."""
|
|
return self.name
|
|
|
|
def save(self, **kwargs):
|
|
"""Saves a workflow in 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 self.first_state and 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))
|