OpenSlides/openslides/participant/models.py

259 lines
8.5 KiB
Python
Raw Normal View History

2011-07-31 10:46:29 +02:00
#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""
openslides.participant.models
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Models for the participant app.
:copyright: 20112013 by OpenSlides team, see AUTHORS.
2011-07-31 10:46:29 +02:00
:license: GNU GPL, see LICENSE for more details.
"""
from django.contrib.auth.models import User as DjangoUser, Group as DjangoGroup, Permission
from django.contrib.contenttypes.models import ContentType
2011-07-31 10:46:29 +02:00
from django.db import models
from django.db.models import signals
from django.dispatch import receiver
from django.utils.translation import ugettext_lazy, ugettext_noop
from openslides.utils.person import PersonMixin, Person
2012-08-13 14:37:49 +02:00
from openslides.utils.person.signals import receive_persons
from openslides.config.api import config
2012-11-06 00:02:44 +01:00
from openslides.projector.api import register_slidemodel
from openslides.projector.projector import SlideMixin
2011-07-31 10:46:29 +02:00
class User(PersonMixin, Person, SlideMixin, DjangoUser):
prefix = 'user' # This is for the slides
person_prefix = 'user'
2011-07-31 10:46:29 +02:00
GENDER_CHOICES = (
('male', ugettext_lazy('Male')),
('female', ugettext_lazy('Female')),
2011-07-31 10:46:29 +02:00
)
django_user = models.OneToOneField(DjangoUser, editable=False, parent_link=True)
structure_level = models.CharField(
max_length=255, blank=True, default='', verbose_name=ugettext_lazy("Structure level"),
help_text=ugettext_lazy('Will be shown after the name.'))
2013-04-08 21:47:33 +02:00
title = models.CharField(
max_length=50, blank=True, default='', verbose_name=ugettext_lazy("Title"),
help_text=ugettext_lazy('Will be shown before the name.'))
gender = models.CharField(
max_length=50, choices=GENDER_CHOICES, blank=True,
verbose_name=ugettext_lazy("Gender"), help_text=ugettext_lazy('Only for filtering the participant list.'))
committee = models.CharField(
max_length=255, blank=True, default='', verbose_name=ugettext_lazy("Committee"),
help_text=ugettext_lazy('Only for filtering the participant list.'))
about_me = models.TextField(
blank=True, default='', verbose_name=ugettext_lazy('About me'),
help_text=ugettext_lazy('Your profile text'))
comment = models.TextField(
blank=True, default='', verbose_name=ugettext_lazy('Comment'),
help_text=ugettext_lazy('Only for notes.'))
2012-08-13 14:37:49 +02:00
default_password = models.CharField(
2012-10-24 12:30:45 +02:00
max_length=100, blank=True, default='',
verbose_name=ugettext_lazy("Default password"))
2011-09-03 17:17:29 +02:00
@property
def clean_name(self):
2013-04-08 21:47:33 +02:00
if self.title:
name = "%s %s" % (self.title, self.get_full_name())
else:
name = self.get_full_name()
return name or self.username
2012-08-13 14:37:49 +02:00
def get_name_suffix(self):
return self.structure_level
2012-08-13 14:37:49 +02:00
def set_name_suffix(self, value):
self.structure_level = value
2012-08-13 14:37:49 +02:00
name_suffix = property(get_name_suffix, set_name_suffix)
2012-08-08 10:07:36 +02:00
def reset_password(self, password=None):
"""
Reset the password for the user to his default-password.
"""
2012-08-08 10:07:36 +02:00
if password is None:
2012-08-13 14:37:49 +02:00
password = self.default_password
self.set_password(password)
self.save()
2011-07-31 10:46:29 +02:00
2012-11-22 16:19:09 +01:00
@property
def sort_name(self):
if config['participant_sort_users_by_first_name']:
2012-11-22 16:54:56 +01:00
return self.first_name.lower()
return self.last_name.lower()
2012-11-22 16:19:09 +01:00
2012-04-13 11:35:53 +02:00
@models.permalink
2013-03-18 12:34:47 +01:00
def get_absolute_url(self, link='detail'):
2012-04-13 11:35:53 +02:00
"""
Return the URL to this user.
link can be:
2013-03-18 12:34:47 +01:00
* detail
2012-04-13 11:35:53 +02:00
* edit
* delete
"""
2013-03-18 12:34:47 +01:00
if link == 'detail' or link == 'view':
2012-10-30 00:07:25 +01:00
return ('user_view', [str(self.id)])
2012-04-13 11:35:53 +02:00
if link == 'edit':
return ('user_edit', [str(self.id)])
2012-04-13 11:35:53 +02:00
if link == 'delete':
return ('user_delete', [str(self.id)])
2012-04-13 11:35:53 +02:00
2011-07-31 10:46:29 +02:00
def __unicode__(self):
2012-08-13 14:37:49 +02:00
if self.name_suffix:
return u"%s (%s)" % (self.clean_name, self.name_suffix)
return u"%s" % self.clean_name
2011-07-31 10:46:29 +02:00
class Meta:
# Rename permissions
2011-07-31 10:46:29 +02:00
permissions = (
('can_see_participant', ugettext_noop("Can see participant")),
('can_manage_participant',
ugettext_noop("Can manage participant")),
2011-07-31 10:46:29 +02:00
)
ordering = ('last_name',)
2012-11-06 00:02:44 +01:00
def slide(self):
"""
Returns a map with the data for the slides.
"""
return {
'shown_user': self,
'title': self.clean_name,
'template': 'projector/UserSlide.html'}
register_slidemodel(User)
class Group(PersonMixin, Person, SlideMixin, DjangoGroup):
prefix = 'group' # This is for the slides
person_prefix = 'group'
2012-08-03 00:11:53 +02:00
django_group = models.OneToOneField(DjangoGroup, editable=False, parent_link=True)
2012-11-26 10:11:36 +01:00
group_as_person = models.BooleanField(
default=False, verbose_name=ugettext_lazy("Use this group as participant"),
help_text=ugettext_lazy('For example as submitter of a motion.'))
description = models.TextField(blank=True, verbose_name=ugettext_lazy("Description"))
2012-08-03 00:11:53 +02:00
@models.permalink
def get_absolute_url(self, link='detail'):
"""
2012-11-22 21:48:49 +01:00
Return the URL to this user group.
link can be:
2012-10-30 00:07:25 +01:00
* view
* edit
* delete
"""
if link == 'detail' or link == 'view':
2012-10-30 00:07:25 +01:00
return ('user_group_view', [str(self.id)])
if link == 'edit':
return ('user_group_edit', [str(self.id)])
if link == 'delete':
return ('user_group_delete', [str(self.id)])
2012-08-03 00:11:53 +02:00
def __unicode__(self):
return unicode(self.name)
2012-08-03 00:11:53 +02:00
class Meta:
ordering = ('name',)
2012-11-21 14:22:30 +01:00
def slide(self):
"""
Returns a map with the data for the slides.
"""
return {
'group': self,
'title': self.name,
'template': 'projector/GroupSlide.html'}
register_slidemodel(Group)
2012-08-03 00:11:53 +02:00
class UsersAndGroupsToPersons(object):
"""
Object to send all Users and Groups or a special User or Group to
the Person-API via receice_persons()
"""
2012-08-13 14:37:49 +02:00
def __init__(self, person_prefix_filter=None, id_filter=None):
self.person_prefix_filter = person_prefix_filter
self.id_filter = id_filter
2012-09-14 02:46:43 +02:00
if config['participant_sort_users_by_first_name']:
self.users = User.objects.all().order_by('first_name')
else:
self.users = User.objects.all().order_by('last_name')
2012-08-13 14:37:49 +02:00
self.groups = Group.objects.filter(group_as_person=True)
2012-08-03 00:11:53 +02:00
def __iter__(self):
2012-08-13 14:37:49 +02:00
if (not self.person_prefix_filter or
self.person_prefix_filter == User.person_prefix):
if self.id_filter:
2012-09-15 09:11:56 +02:00
try:
yield self.users.get(pk=self.id_filter)
except User.DoesNotExist:
pass
else:
2012-08-13 14:37:49 +02:00
for user in self.users:
yield user
2012-08-13 14:37:49 +02:00
if (not self.person_prefix_filter or
self.person_prefix_filter == Group.person_prefix):
if self.id_filter:
2012-09-15 09:11:56 +02:00
try:
yield self.groups.get(pk=self.id_filter)
except Group.DoesNotExist:
pass
else:
2012-08-13 14:37:49 +02:00
for group in self.groups:
yield group
2012-08-03 00:11:53 +02:00
2012-08-13 14:37:49 +02:00
@receiver(receive_persons, dispatch_uid="participant")
def receive_persons(sender, **kwargs):
"""
Answers to the Person-API
"""
return UsersAndGroupsToPersons(
person_prefix_filter=kwargs['person_prefix_filter'],
id_filter=kwargs['id_filter'])
2012-08-03 00:11:53 +02:00
@receiver(signals.post_save, sender=DjangoUser)
def djangouser_post_save(sender, instance, signal, *args, **kwargs):
try:
instance.user
except User.DoesNotExist:
User(django_user=instance).save_base(raw=True)
@receiver(signals.post_save, sender=DjangoGroup)
def djangogroup_post_save(sender, instance, signal, *args, **kwargs):
try:
instance.group
except Group.DoesNotExist:
Group(django_group=instance).save_base(raw=True)
@receiver(signals.post_save, sender=User)
def user_post_save(sender, instance, *args, **kwargs):
if not kwargs['created']:
return
2013-03-12 20:58:22 +01:00
from openslides.participant.api import get_registered_group # TODO: Test, if global import is possible
registered = get_registered_group()
instance.groups.add(registered)
instance.save()
def get_protected_perm():
"""
Returns the permission to manage participants. This function is a helper
function used to protect manager users from locking out themselves.
"""
return Permission.objects.get(
content_type=ContentType.objects.get(app_label='participant', model='user'),
codename='can_manage_participant')