models.py 10.1 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.db.models.signals import post_save, pre_delete
33
from django.template.loader import render_to_string
34
from django.templatetags.static import static
35
from django.utils.translation import ugettext_lazy as _, override, ugettext
36
from django_sshkey.models import UserKey
37 38 39 40

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

42
from acl.models import AclBase
43

44 45
from vm.tasks.agent_tasks import add_keys, del_keys

46 47
from dashboard import store_api

48 49
logger = getLogger(__name__)

50 51
pwgen = User.objects.make_random_password

52

53
class Favourite(Model):
54
    instance = ForeignKey("vm.Instance")
55
    user = ForeignKey(User)
56 57


58 59 60 61 62 63 64 65 66
class Notification(TimeStampedModel):
    STATUS = Choices(('new', _('new')),
                     ('delivered', _('delivered')),
                     ('read', _('read')))

    status = StatusField()
    to = ForeignKey(User)
    subject = CharField(max_length=128)
    message = TextField()
67
    valid_until = DateTimeField(null=True, default=None)
68 69 70 71 72

    class Meta:
        ordering = ['-created']

    @classmethod
73
    def send(cls, user, subject, template, context={}, valid_until=None):
74 75 76 77 78 79 80
        try:
            language = user.profile.preferred_language
        except:
            language = None
        with override(language):
            context['user'] = user
            rendered = render_to_string(template, context)
81
            subject = ugettext(unicode(subject))
82 83
        return cls.objects.create(to=user, subject=subject, message=rendered,
                                  valid_until=valid_until)
84 85


86 87 88 89 90 91 92 93 94
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.'))
95
    instance_limit = IntegerField(default=5)
96
    use_gravatar = BooleanField(
97
        verbose_name=_("Use Gravatar"), default=True,
98
        help_text=_("Whether to use email address as Gravatar profile image"))
99 100
    email_notifications = BooleanField(
        verbose_name=_("Email notifications"), default=True,
101
        help_text=_('Whether user wants to get digested email notifications.'))
102 103 104 105 106
    smb_password = CharField(
        max_length=20,
        verbose_name=_('Samba password'),
        help_text=_(
            'Generated password for accessing store from '
Kálmán Viktor committed
107
            'virtual machines.'),
108 109
        default=pwgen,
    )
110 111 112 113
    disk_quota = IntegerField(
        verbose_name=_('disk quota'),
        default=2048,
        help_text=_('Disk quota in mebibytes.'))
114

115 116 117
    def notify(self, subject, template, context={}, valid_until=None):
        return Notification.send(self.user, subject, template, context,
                                 valid_until)
118

119
    def get_absolute_url(self):
Kálmán Viktor committed
120 121
        return reverse("dashboard.views.profile",
                       kwargs={'username': self.user.username})
122

123 124 125 126 127 128 129 130
    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")

131 132 133 134 135 136 137 138 139 140 141 142 143
    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
144

145 146 147 148 149 150 151 152 153 154 155
class FutureMember(Model):
    org_id = CharField(max_length=64, help_text=_(
        'Unique identifier of the person, e.g. a student number.'))
    group = ForeignKey(Group)

    class Meta:
        unique_together = ('org_id', 'group')

    def __unicode__(self):
        return u"%s (%s)" % (self.org_id, self.group)

Őry Máté committed
156

157 158 159 160 161 162 163 164 165 166
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.'))
167 168 169 170 171 172
    description = TextField(blank=True)

    def save(self, *args, **kwargs):
        if not self.org_id:
            self.org_id = None
        super(GroupProfile, self).save(*args, **kwargs)
173 174 175 176 177 178 179 180

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

181 182 183 184 185
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.group-detail', None,
                {'pk': self.group.pk})

186 187

def get_or_create_profile(self):
188
    obj, created = GroupProfile.objects.get_or_create(group_id=self.pk)
189 190 191 192 193
    return obj

Group.profile = property(get_or_create_profile)


194
def create_profile(sender, user, request, **kwargs):
195 196
    if not user.pk:
        return False
197
    profile, created = Profile.objects.get_or_create(user=user)
198 199 200 201 202 203 204

    if created:
        user_home = "u-%d" % user.pk
        if not store_api.userexist(user_home):
            store_api.createuser(user_home, profile.smb_password, None,
                                 profile.disk_quota)

205 206 207 208
    return created

user_logged_in.connect(create_profile)

209
if hasattr(settings, 'SAML_ORG_ID_ATTRIBUTE'):
210
    logger.debug("Register save_org_id to djangosaml2 pre_user_save")
211 212
    from djangosaml2.signals import pre_user_save

213
    def save_org_id(sender, **kwargs):
214
        logger.debug("save_org_id called by %s", sender.username)
215
        attributes = kwargs.pop('attributes')
216
        atr = settings.SAML_ORG_ID_ATTRIBUTE
217 218 219 220 221 222
        try:
            value = attributes[atr][0]
        except Exception as e:
            value = None
            logger.info("save_org_id couldn't find attribute. %s", unicode(e))

223 224 225 226
        if sender.pk is None:
            sender.save()
            logger.debug("save_org_id saved user %s", unicode(sender))

227 228
        profile, created = Profile.objects.get_or_create(user=sender)
        if created or profile.org_id != value:
229 230
            logger.info("org_id of %s added to user %s's profile",
                        value, sender.username)
231 232
            profile.org_id = value
            profile.save()
233 234 235
        else:
            logger.debug("org_id of %s already added to user %s's profile",
                         value, sender.username)
236
        memberatrs = getattr(settings, 'SAML_GROUP_ATTRIBUTES', [])
237 238
        for group in chain(*[attributes[i]
                             for i in memberatrs if i in attributes]):
239 240 241 242 243 244 245 246 247
            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)

248 249 250 251
        for i in FutureMember.objects.filter(org_id=value):
            i.group.user_set.add(sender)
            i.delete()

252
        owneratrs = getattr(settings, 'SAML_GROUP_OWNER_ATTRIBUTES', [])
253 254
        for group in chain(*[attributes[i]
                             for i in owneratrs if i in attributes]):
255 256 257 258 259 260 261 262 263 264
            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
265

266 267
    pre_user_save.connect(save_org_id)

268 269
else:
    logger.debug("Do not register save_org_id to djangosaml2 pre_user_save")
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299


def add_ssh_keys(sender, **kwargs):
    from vm.models import Instance

    userkey = kwargs.get('instance')
    instances = Instance.get_objects_with_level(
        'user', userkey.user).filter(status='RUNNING')
    for i in instances:
        logger.info('called add_keys(%s, %s)', i, userkey)
        queue = i.get_remote_queue_name("agent")
        add_keys.apply_async(args=(i.vm_name, [userkey.key]),
                             queue=queue)


def del_ssh_keys(sender, **kwargs):
    from vm.models import Instance

    userkey = kwargs.get('instance')
    instances = Instance.get_objects_with_level(
        'user', userkey.user).filter(status='RUNNING')
    for i in instances:
        logger.info('called del_keys(%s, %s)', i, userkey)
        queue = i.get_remote_queue_name("agent")
        del_keys.apply_async(args=(i.vm_name, [userkey.key]),
                             queue=queue)


post_save.connect(add_ssh_keys, sender=UserKey)
pre_delete.connect(del_ssh_keys, sender=UserKey)