models.py 7.71 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright 2014 Budapest University of Technology and Economics (BME IK)
#
# This file is part of CIRCLE Cloud.
#
# CIRCLE is free software: you can redistribute it and/or modify it under
# the terms of the GNU General Public License as published by the Free
# Software Foundation, either version 3 of the License, or (at your option)
# any later version.
#
# CIRCLE is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along
# with CIRCLE.  If not, see <http://www.gnu.org/licenses/>.

18 19
from __future__ import absolute_import

20
from itertools import chain
21
from hashlib import md5
22 23
from logging import getLogger

24
from django.conf import settings
25
from django.contrib.auth.models import User, Group
26
from django.contrib.auth.signals import user_logged_in
27
from django.core.urlresolvers import reverse
28
from django.db.models import (
29
    Model, ForeignKey, OneToOneField, CharField, IntegerField, TextField,
30
    DateTimeField, permalink, BooleanField
31
)
32
from django.template.loader import render_to_string
33
from django.templatetags.static import static
34
from django.utils.translation import ugettext_lazy as _, override, ugettext
35 36 37 38

from model_utils.models import TimeStampedModel
from model_utils.fields import StatusField
from model_utils import Choices
39

40
from acl.models import AclBase
41

42 43
logger = getLogger(__name__)

44

45
class Favourite(Model):
46
    instance = ForeignKey("vm.Instance")
47
    user = ForeignKey(User)
48 49


50 51 52 53 54 55 56 57 58
class Notification(TimeStampedModel):
    STATUS = Choices(('new', _('new')),
                     ('delivered', _('delivered')),
                     ('read', _('read')))

    status = StatusField()
    to = ForeignKey(User)
    subject = CharField(max_length=128)
    message = TextField()
59
    valid_until = DateTimeField(null=True, default=None)
60 61 62 63 64

    class Meta:
        ordering = ['-created']

    @classmethod
65
    def send(cls, user, subject, template, context={}, valid_until=None):
66 67 68 69 70 71 72
        try:
            language = user.profile.preferred_language
        except:
            language = None
        with override(language):
            context['user'] = user
            rendered = render_to_string(template, context)
73
            subject = ugettext(unicode(subject))
74 75
        return cls.objects.create(to=user, subject=subject, message=rendered,
                                  valid_until=valid_until)
76 77


78 79 80 81 82 83 84 85 86
class Profile(Model):
    user = OneToOneField(User)
    preferred_language = CharField(verbose_name=_('preferred language'),
                                   choices=settings.LANGUAGES,
                                   max_length=32,
                                   default=settings.LANGUAGE_CODE, blank=False)
    org_id = CharField(  # may be populated from eduPersonOrgId field
        unique=True, blank=True, null=True, max_length=64,
        help_text=_('Unique identifier of the person, e.g. a student number.'))
87
    instance_limit = IntegerField(default=5)
88
    use_gravatar = BooleanField(default=False)
89 90
    email_notifications = BooleanField(
        verbose_name=_("Email notifications"), default=True,
91
        help_text=_('Whether user wants to get digested email notifications.'))
92

93 94 95
    def notify(self, subject, template, context={}, valid_until=None):
        return Notification.send(self.user, subject, template, context,
                                 valid_until)
96

97
    def get_absolute_url(self):
Kálmán Viktor committed
98 99
        return reverse("dashboard.views.profile",
                       kwargs={'username': self.user.username})
100

101 102 103 104 105 106 107 108
    def get_avatar_url(self):
        if self.use_gravatar:
            gravatar_hash = md5(self.user.email).hexdigest()
            return ("https://secure.gravatar.com/avatar/%s"
                    "?s=200" % gravatar_hash)
        else:
            return static("dashboard/img/avatar.png")

109 110 111 112 113 114 115 116 117 118 119 120 121
    def get_display_name(self):
        if self.user.get_full_name():
            name = self.user.get_full_name()
        else:
            name = self.user.username

        if self.org_id:
            name = "%s (%s)" % (name, self.org_id)
        return name

    def __unicode__(self):
        return self.get_display_name()

Őry Máté committed
122

123 124 125 126 127 128 129 130 131 132
class GroupProfile(AclBase):
    ACL_LEVELS = (
        ('operator', _('operator')),
        ('owner', _('owner')),
    )

    group = OneToOneField(Group)
    org_id = CharField(
        unique=True, blank=True, null=True, max_length=64,
        help_text=_('Unique identifier of the group at the organization.'))
133 134 135 136 137 138
    description = TextField(blank=True)

    def save(self, *args, **kwargs):
        if not self.org_id:
            self.org_id = None
        super(GroupProfile, self).save(*args, **kwargs)
139 140 141 142 143 144 145 146

    @classmethod
    def search(cls, name):
        try:
            return cls.objects.get(org_id=name).group
        except cls.DoesNotExist:
            return Group.objects.get(name=name)

147 148 149 150 151
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.group-detail', None,
                {'pk': self.group.pk})

152 153

def get_or_create_profile(self):
154
    obj, created = GroupProfile.objects.get_or_create(group_id=self.pk)
155 156 157 158 159
    return obj

Group.profile = property(get_or_create_profile)


160
def create_profile(sender, user, request, **kwargs):
161 162
    if not user.pk:
        return False
163 164 165 166 167
    profile, created = Profile.objects.get_or_create(user=user)
    return created

user_logged_in.connect(create_profile)

168
if hasattr(settings, 'SAML_ORG_ID_ATTRIBUTE'):
169
    logger.debug("Register save_org_id to djangosaml2 pre_user_save")
170 171
    from djangosaml2.signals import pre_user_save

172
    def save_org_id(sender, **kwargs):
173
        logger.debug("save_org_id called by %s", sender.username)
174
        attributes = kwargs.pop('attributes')
175
        atr = settings.SAML_ORG_ID_ATTRIBUTE
176 177 178 179 180 181
        try:
            value = attributes[atr][0]
        except Exception as e:
            value = None
            logger.info("save_org_id couldn't find attribute. %s", unicode(e))

182 183 184 185
        if sender.pk is None:
            sender.save()
            logger.debug("save_org_id saved user %s", unicode(sender))

186 187
        profile, created = Profile.objects.get_or_create(user=sender)
        if created or profile.org_id != value:
188 189
            logger.info("org_id of %s added to user %s's profile",
                        value, sender.username)
190 191
            profile.org_id = value
            profile.save()
192 193 194
        else:
            logger.debug("org_id of %s already added to user %s's profile",
                         value, sender.username)
195
        memberatrs = getattr(settings, 'SAML_GROUP_ATTRIBUTES', [])
196 197
        for group in chain(*[attributes[i]
                             for i in memberatrs if i in attributes]):
198 199 200 201 202 203 204 205 206 207
            try:
                g = GroupProfile.search(group)
            except Group.DoesNotExist:
                logger.debug('cant find membergroup %s', group)
            else:
                logger.debug('could find membergroup %s (%s)',
                             group, unicode(g))
                g.user_set.add(sender)

        owneratrs = getattr(settings, 'SAML_GROUP_OWNER_ATTRIBUTES', [])
208 209
        for group in chain(*[attributes[i]
                             for i in owneratrs if i in attributes]):
210 211 212 213 214 215 216 217 218 219
            try:
                g = GroupProfile.search(group)
            except Group.DoesNotExist:
                logger.debug('cant find ownergroup %s', group)
            else:
                logger.debug('could find ownergroup %s (%s)',
                             group, unicode(g))
                g.profile.set_level(sender, 'owner')

        return False  # User did not change
220

221 222
    pre_user_save.connect(save_org_id)

223 224
else:
    logger.debug("Do not register save_org_id to djangosaml2 pre_user_save")