OpenSlides/openslides/motions/models.py

978 lines
31 KiB
Python
Raw Normal View History

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
2011-07-31 10:46:29 +02:00
from openslides.agenda.models import Item
2015-06-29 12:08:15 +02:00
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,
)
2015-06-29 12:08:15 +02:00
from openslides.utils.models import RESTModelMixin
2016-01-03 15:33:51 +01:00
from openslides.utils.search import user_name_helper
from .access_permissions import (
CategoryAccessPermissions,
MotionAccessPermissions,
WorkflowAccessPermissions,
)
from .exceptions import WorkflowError
2013-02-17 17:07:44 +01:00
2015-06-29 13:31:07 +02:00
class Motion(RESTModelMixin, models.Model):
2013-04-19 14:12:49 +02:00
"""
The Motion Class.
2013-01-26 12:28:51 +01:00
2013-02-05 18:46:46 +01:00
This class is the main entry point to all other classes related to a motion.
"""
access_permissions = MotionAccessPermissions()
2013-01-26 12:28:51 +01:00
active_version = models.ForeignKey(
'MotionVersion',
on_delete=models.SET_NULL,
null=True,
related_name="active_version")
2013-04-19 14:12:49 +02:00
"""
Points to a specific version.
2013-01-26 15:25:54 +01:00
2013-03-14 22:54:00 +01:00
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.
2013-02-05 18:46:46 +01:00
"""
2013-01-06 12:07:37 +01:00
state = models.ForeignKey(
'State',
related_name='+',
on_delete=models.SET_NULL,
null=True) # TODO: Check whether null=True is necessary.
2013-04-19 14:12:49 +02:00
"""
The related state object.
2013-01-06 12:07:37 +01:00
This attribute is to get the current state of the motion.
2013-01-26 12:28:51 +01:00
"""
2013-01-06 12:07:37 +01:00
recommendation = models.ForeignKey(
'State',
related_name='+',
on_delete=models.SET_NULL,
null=True)
"""
The recommendation of a person or committee for this motion.
"""
2013-01-06 12:07:37 +01:00
identifier = models.CharField(max_length=255, null=True, blank=True,
unique=True)
2013-04-19 14:12:49 +02:00
"""
A string as human readable identifier for the motion.
"""
2013-02-05 18:46:46 +01:00
2013-03-12 22:03:56 +01:00
identifier_number = models.IntegerField(null=True)
2013-04-19 14:12:49 +02:00
"""
Counts the number of the motion in one category.
2013-03-12 22:03:56 +01:00
Needed to find the next free motion identifier.
2013-03-12 22:03:56 +01:00
"""
category = models.ForeignKey(
'Category',
on_delete=models.SET_NULL,
null=True,
blank=True)
2013-04-19 14:12:49 +02:00
"""
ForeignKey to one category of motions.
"""
2013-03-11 20:17:19 +01:00
2016-07-13 14:45:40 +02:00
origin = models.CharField(max_length=255, blank=True)
"""
A string to describe the origin of this motion e. g. that it was
discussed at another assembly/conference.
"""
attachments = models.ManyToManyField(Mediafile, blank=True)
"""
Many to many relation to mediafile objects.
"""
parent = models.ForeignKey(
'self',
on_delete=models.SET_NULL,
null=True,
blank=True,
related_name='amendments')
2014-12-25 10:58:52 +01:00
"""
Field for amendments to reference to the motion that should be altered.
Null if the motion is not an amendment.
"""
2011-07-31 10:46:29 +02:00
tags = models.ManyToManyField(Tag, blank=True)
"""
Tags to categorise motions.
"""
2011-07-31 10:46:29 +02:00
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.
"""
comments = JSONField(null=True)
"""
Configurable fields for comments. Contains a list of strings.
"""
2013-01-06 12:07:37 +01:00
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
2013-01-06 12:07:37 +01:00
permissions = (
('can_see', 'Can see motions'),
('can_create', 'Can create motions'),
('can_support', 'Can support motions'),
('can_see_and_manage_comments', 'Can see and manage comments'),
('can_manage', 'Can manage motions'),
2013-01-06 12:07:37 +01:00
)
ordering = ('identifier', )
verbose_name = ugettext_noop('Motion')
def __str__(self):
2013-04-19 14:12:49 +02:00
"""
Return the title of this motion.
2013-04-19 14:12:49 +02:00
"""
return self.title
2013-01-06 12:07:37 +01:00
# TODO: Use transaction
def save(self, use_version=None, *args, **kwargs):
2013-04-19 14:12:49 +02:00
"""
Save the motion.
2013-02-05 18:46:46 +01:00
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.
2013-01-26 12:28:51 +01:00
"""
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):
2013-04-19 14:12:49 +02:00
self.identifier = None
2013-01-06 12:07:37 +01:00
super(Motion, self).save(*args, **kwargs)
2013-02-05 18:46:46 +01:00
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'])
2013-02-03 13:24:29 +01:00
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
2013-03-12 22:03:56 +01:00
def set_identifier(self):
"""
2014-12-25 10:58:52 +01:00
Sets the motion identifier automaticly according to the config value if
it is not set yet.
"""
2014-12-25 10:58:52 +01:00
# The identifier is already set or should be set manually
if config['motions_identifier'] == 'manually' or self.identifier:
2013-03-12 23:35:08 +01:00
# Do not set an identifier.
return
2014-12-25 10:58:52 +01:00
# 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':
2013-03-12 23:35:08 +01:00
motions = Motion.objects.filter(category=self.category)
2014-12-25 10:58:52 +01:00
# The motions should be counted over all.
else:
2013-03-12 23:35:08 +01:00
motions = Motion.objects.all()
number = motions.aggregate(Max('identifier_number'))['identifier_number__max'] or 0
2014-12-25 10:58:52 +01:00
if self.is_amendment():
parent_identifier = self.parent.identifier or ''
prefix = '%s %s ' % (parent_identifier, config['motions_amendments_prefix'])
2014-12-25 10:58:52 +01:00
elif self.category is None or not self.category.prefix:
2013-03-12 22:03:56 +01:00
prefix = ''
2013-03-12 23:35:08 +01:00
else:
prefix = '%s ' % self.category.prefix
2013-03-12 22:03:56 +01:00
number += 1
identifier = '%s%d' % (prefix, number)
while Motion.objects.filter(identifier=identifier).exists():
2013-03-12 22:03:56 +01:00
number += 1
identifier = '%s%d' % (prefix, number)
self.identifier = identifier
self.identifier_number = number
2013-03-12 22:03:56 +01:00
2013-01-06 12:07:37 +01:00
def get_title(self):
2013-04-19 14:12:49 +02:00
"""
Get the title of the motion.
2013-02-05 18:46:46 +01:00
The title is taken from motion.version.
2013-01-26 12:28:51 +01:00
"""
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:
return self.get_active_version().title
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def set_title(self, title):
2013-04-19 14:12:49 +02:00
"""
2013-11-12 10:57:07 +01:00
Set the title of the motion.
2013-02-05 18:46:46 +01:00
The title will be saved in the version object, when motion.save() is
2013-02-05 18:46:46 +01:00
called.
2013-01-26 12:28:51 +01:00
"""
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)
2013-04-19 14:12:49 +02:00
"""
The title of the motion.
2013-02-05 18:46:46 +01:00
Is saved in a MotionVersion object.
"""
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def get_text(self):
2013-04-19 14:12:49 +02:00
"""
Get the text of the motion.
2013-02-05 18:46:46 +01:00
Simular to get_title().
2013-01-26 12:28:51 +01:00
"""
2013-01-06 12:07:37 +01:00
try:
return self._text
except AttributeError:
return self.get_active_version().text
2011-07-31 10:46:29 +02:00
2013-01-06 12:07:37 +01:00
def set_text(self, text):
2013-04-19 14:12:49 +02:00
"""
Set the text of the motion.
2013-02-05 18:46:46 +01:00
Simular to set_title().
2013-01-26 12:28:51 +01:00
"""
2013-01-06 12:07:37 +01:00
self._text = text
text = property(get_text, set_text)
2013-04-19 14:12:49 +02:00
"""
The text of a motin.
2013-02-05 18:46:46 +01:00
Is saved in a MotionVersion object.
"""
2013-01-06 12:07:37 +01:00
def get_reason(self):
2013-04-19 14:12:49 +02:00
"""
Get the reason of the motion.
2013-02-05 18:46:46 +01:00
Simular to get_title().
2013-01-26 12:28:51 +01:00
"""
2013-01-06 12:07:37 +01:00
try:
return self._reason
except AttributeError:
return self.get_active_version().reason
2013-01-06 12:07:37 +01:00
def set_reason(self, reason):
2013-04-19 14:12:49 +02:00
"""
Set the reason of the motion.
2013-02-05 18:46:46 +01:00
Simular to set_title().
2013-01-26 12:28:51 +01:00
"""
2013-01-06 12:07:37 +01:00
self._reason = reason
reason = property(get_reason, set_reason)
2013-04-19 14:12:49 +02:00
"""
The reason for the motion.
2013-02-05 18:46:46 +01:00
Is saved in a MotionVersion object.
"""
2011-07-31 10:46:29 +02:00
def get_new_version(self, **kwargs):
2013-04-19 14:12:49 +02:00
"""
Return a version object, not saved in the database.
2013-02-05 18:46:46 +01:00
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.
2013-04-19 14:12:49 +02:00
"""
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
2013-02-05 18:46:46 +01:00
def get_active_version(self):
2013-01-26 12:28:51 +01:00
"""
Returns the active version of the motion.
2012-02-14 16:31:21 +01:00
If no active version is set by now, the last_version is used.
2013-04-19 14:12:49 +02:00
"""
if self.active_version:
return self.active_version
2013-01-06 12:07:37 +01:00
else:
return self.get_last_version()
2012-02-15 12:36:50 +01:00
def get_last_version(self):
2013-04-19 14:12:49 +02:00
"""
Return the newest version of the motion.
"""
2013-01-06 12:07:37 +01:00
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.get_new_version()
def is_submitter(self, user):
2013-04-19 14:12:49 +02:00
"""
Returns True if user is a submitter of this motion, else False.
2013-04-19 14:12:49 +02:00
"""
return user in self.submitters.all()
def is_supporter(self, user):
2013-04-19 14:12:49 +02:00
"""
Returns True if user is a supporter of this motion, else False.
2013-04-19 14:12:49 +02:00
"""
return user in self.supporters.all()
2013-02-01 12:51:54 +01:00
def create_poll(self):
2013-04-19 14:12:49 +02:00
"""
Create a new poll for this motion.
2013-02-05 18:46:46 +01:00
Return the new poll object.
2013-02-01 16:33:45 +01:00
"""
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)
2013-02-01 16:33:45 +01:00
@property
def workflow(self):
"""
Returns the id of the workflow of the motion.
"""
# TODO: Rename to workflow_id
return self.state.workflow.pk
2013-03-12 22:03:56 +01:00
def set_state(self, state):
2013-04-19 14:12:49 +02:00
"""
Set the state of the motion.
2013-03-12 22:03:56 +01:00
'state' can be the id of a state object or a state object.
2013-03-12 22:03:56 +01:00
"""
if type(state) is int:
state = State.objects.get(pk=state)
if not state.dont_set_identifier:
2013-03-12 22:03:56 +01:00
self.set_identifier()
self.state = state
def reset_state(self, workflow=None):
2013-04-19 14:12:49 +02:00
"""
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.
2013-04-19 14:12:49 +02:00
"""
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']).states.all()[0])
self.set_state(new_state)
def set_recommendation(self, recommendation):
"""
Set the recommendation of the motion.
'recommendation' can be the id of a state object or a state object.
"""
if type(recommendation) is int:
recommendation = State.objects.get(pk=recommendation)
self.recommendation = recommendation
2013-02-02 00:51:08 +01:00
def get_agenda_title(self):
2013-04-19 14:12:49 +02:00
"""
Return a simple title string for the agenda.
2016-01-27 20:03:53 +01:00
Returns only the motion title so that you have only agenda item number
and title in the agenda.
2013-04-19 14:12:49 +02:00
"""
return str(self)
2013-02-02 00:51:08 +01:00
def get_agenda_list_view_title(self):
"""
Return a title string for the agenda list view.
2016-01-27 20:03:53 +01:00
Returns only the motion title so that you have agenda item number,
title and motion identifier in the agenda.
Note: It has to be the same return value like in JavaScript.
"""
if self.identifier:
string = '%s (%s %s)' % (self.title, _(self._meta.verbose_name), self.identifier)
else:
string = '%s (%s)' % (self.title, _(self._meta.verbose_name))
return string
@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
2013-02-02 00:51:08 +01:00
def get_allowed_actions(self, person):
2013-04-19 14:12:49 +02:00
"""
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
* change_recommendation
NOTE: If you update this function please also update the
'isAllowed' function on client side in motions/site.js.
"""
# 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'),
'change_recommendation': person.has_perm('motions.can_manage'),
}
actions['edit'] = actions['update']
return actions
def write_log(self, message_list, person=None):
"""
Write a log message.
2013-02-05 18:46:46 +01:00
The message should be in English and translatable,
e. g. motion.write_log(message_list=[ugettext_noop('Message Text')])
2013-02-05 18:46:46 +01:00
"""
MotionLog.objects.create(motion=self, message_list=message_list, person=person)
2014-12-25 10:58:52 +01:00
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
2014-12-25 10:58:52 +01:00
2016-01-03 15:33:51 +01:00
def get_search_index_string(self):
"""
Returns a string that can be indexed for the search.
"""
return " ".join((
self.title or '',
self.text or '',
self.reason or '',
str(self.category) if self.category else '',
user_name_helper(self.submitters.all()),
user_name_helper(self.supporters.all()),
" ".join(tag.name for tag in self.tags.all())))
class MotionVersion(RESTModelMixin, models.Model):
2013-02-05 18:46:46 +01:00
"""
2013-04-19 14:12:49 +02:00
A MotionVersion object saves some date of the motion.
"""
2013-02-05 18:46:46 +01:00
motion = models.ForeignKey(
Motion,
on_delete=models.CASCADE,
related_name='versions')
"""The motion to which the version belongs."""
2013-02-05 18:46:46 +01:00
2013-02-03 13:24:29 +01:00
version_number = models.PositiveIntegerField(default=1)
2013-02-05 18:46:46 +01:00
"""An id for this version in realation to a motion.
Is unique for each motion.
"""
title = models.CharField(max_length=255)
"""The title of a motion."""
2013-02-05 18:46:46 +01:00
text = models.TextField()
2013-02-05 18:46:46 +01:00
"""The text of a motion."""
reason = models.TextField(null=True, blank=True)
2013-02-05 18:46:46 +01:00
"""The reason for a motion."""
2013-01-06 12:07:37 +01:00
creation_time = models.DateTimeField(auto_now=True)
"""Time when the version was saved."""
2013-02-05 18:46:46 +01:00
2013-02-03 13:24:29 +01:00
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
2013-02-03 13:24:29 +01:00
unique_together = ("motion", "version_number")
def __str__(self):
2013-02-05 18:46:46 +01:00
"""Return a string, representing this object."""
counter = self.version_number or ugettext_lazy('new')
return "Motion %s, Version %s" % (self.motion_id, counter)
2013-01-06 12:07:37 +01:00
2013-01-26 15:25:54 +01:00
@property
2013-02-03 13:24:29 +01:00
def active(self):
2013-02-05 18:46:46 +01:00
"""Return True, if the version is the active version of a motion. Else: False."""
2013-02-03 13:24:29 +01:00
return self.active_version.exists()
2012-04-12 16:21:30 +02:00
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):
"""
Model for categories of motions.
"""
access_permissions = CategoryAccessPermissions()
name = models.CharField(max_length=255)
"""Name of the category."""
prefix = models.CharField(blank=True, max_length=32)
"""Prefix of the category.
Used to build the identifier of a motion.
"""
2013-03-11 20:17:19 +01:00
2013-03-11 21:29:56 +01:00
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
2013-03-11 21:29:56 +01:00
ordering = ['prefix']
2013-02-05 18:46:46 +01:00
2015-12-10 00:20:59 +01:00
def __str__(self):
return self.name
2013-02-01 12:51:54 +01:00
class MotionLog(RESTModelMixin, models.Model):
2013-02-05 18:46:46 +01:00
"""Save a logmessage for a motion."""
motion = models.ForeignKey(
Motion,
on_delete=models.CASCADE,
related_name='log_messages')
2013-02-05 18:46:46 +01:00
"""The motion to witch the object belongs."""
message_list = JSONField()
"""
The log message. It should be a list of strings in English.
2013-02-05 18:46:46 +01:00
"""
person = models.ForeignKey(
settings.AUTH_USER_MODEL,
on_delete=models.SET_NULL,
null=True)
"""A user object, who created the log message. Optional."""
2013-02-05 18:46:46 +01:00
time = models.DateTimeField(auto_now=True)
2013-02-05 18:46:46 +01:00
"""The Time, when the loged action was performed."""
class Meta:
2015-12-10 00:20:59 +01:00
default_permissions = ()
ordering = ['-time']
def __str__(self):
"""
Return a string, representing the log message.
"""
time = formats.date_format(self.time, 'DATETIME_FORMAT')
2013-06-19 21:40:59 +02:00
time_and_messages = '%s ' % time + ''.join(map(_, self.message_list))
if self.person is not None:
2013-06-19 21:40:59 +02:00
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
2013-02-03 14:14:07 +01:00
class MotionVote(RESTModelMixin, BaseVote):
2013-02-05 18:46:46 +01:00
"""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',
on_delete=models.CASCADE)
2013-02-05 18:46:46 +01:00
"""The option object, to witch the vote belongs."""
2013-02-01 12:51:54 +01:00
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def get_root_rest_element(self):
"""
Returns the motion to this instance which is the root REST element.
"""
return self.option.poll.motion
2013-02-01 12:51:54 +01:00
class MotionOption(RESTModelMixin, BaseOption):
2013-02-05 18:46:46 +01:00
"""Links between the MotionPollClass and the MotionVoteClass.
There should be one MotionOption object for each poll."""
poll = models.ForeignKey(
'MotionPoll',
on_delete=models.CASCADE)
2013-02-05 18:46:46 +01:00
"""The poll object, to witch the object belongs."""
2013-02-01 12:51:54 +01:00
vote_class = MotionVote
2013-02-05 18:46:46 +01:00
"""The VoteClass, to witch this Class links."""
2013-02-01 12:51:54 +01:00
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def get_root_rest_element(self):
"""
Returns the motion to this instance which is the root REST element.
"""
return self.poll.motion
2013-02-01 12:51:54 +01:00
2015-06-29 13:31:07 +02:00
class MotionPoll(RESTModelMixin, CollectDefaultVotesMixin, BasePoll):
"""The Class to saves the vote result for a motion poll."""
2013-02-05 18:46:46 +01:00
motion = models.ForeignKey(
Motion,
on_delete=models.CASCADE,
related_name='polls')
2013-02-05 18:46:46 +01:00
"""The motion to witch the object belongs."""
2013-02-01 12:51:54 +01:00
option_class = MotionOption
2013-02-05 18:46:46 +01:00
"""The option class, witch links between this object the the votes."""
2015-12-07 12:40:30 +01:00
vote_values = ['Yes', 'No', 'Abstain']
2013-02-05 18:46:46 +01:00
"""The possible anwers for the poll. 'Yes, 'No' and 'Abstain'."""
2013-02-01 12:51:54 +01:00
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
def __str__(self):
"""
Representation method only for debugging purposes.
"""
return 'MotionPoll for motion %s' % self.motion
2013-02-01 12:51:54 +01:00
def set_options(self):
2013-02-05 18:46:46 +01:00
"""Create the option class for this poll."""
2014-03-27 20:38:13 +01:00
# TODO: maybe it is possible with .create() to call this without poll=self
# or call this in save()
2013-02-01 12:51:54 +01:00
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.
Additionally every motion can refer to one state as recommendation of
an person or committee (see config 'motions_recommendations_by'). This
means that the person or committee recommends to set the motion to this
state.
"""
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."""
recommendation_label = models.CharField(max_length=255, null=True)
"""A string for a recommendation to set the motion to this state."""
workflow = models.ForeignKey(
'Workflow',
on_delete=models.CASCADE,
related_name='states')
"""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."""
css_class = models.CharField(max_length=255, default='primary')
"""
A css class string for showing the state name in a coloured label based on bootstrap,
e.g. 'danger' (red), 'success' (green), 'warning' (yellow), 'default' (grey).
Default value is 'primary' (blue).
"""
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)
2014-12-25 10:58:52 +01:00
"""
Decides if the motion gets an identifier.
If true, the motion does not get an identifier if the state change to
2014-12-25 10:58:52 +01:00
this one, else it does.
"""
2013-03-12 22:03:56 +01:00
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
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. Also used to check that
recommendation_label is not an empty string.
"""
self.check_next_states()
if self.recommendation_label == '':
raise WorkflowError('The field recommendation_label of {} must not '
'be an empty string.'.format(self))
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.
"""
access_permissions = WorkflowAccessPermissions()
name = models.CharField(max_length=255)
"""A string representing the workflow."""
first_state = models.OneToOneField(
State,
on_delete=models.SET_NULL,
related_name='+',
null=True)
"""A one-to-one relation to a state, the starting point for the workflow."""
2015-12-10 00:20:59 +01:00
class Meta:
default_permissions = ()
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))