models.py 13.5 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, post_delete
33
from django.templatetags.static import static
34
from django.utils.translation import ugettext_lazy as _
35
from django_sshkey.models import UserKey
Guba Sándor committed
36
from django.core.exceptions import ObjectDoesNotExist
37

38 39
from sizefield.models import FileSizeField

40
from jsonfield import JSONField
41 42 43
from model_utils.models import TimeStampedModel
from model_utils.fields import StatusField
from model_utils import Choices
44

45
from acl.models import AclBase
46
from common.models import HumanReadableObject, create_readable, Encoder
47

48
from vm.tasks.agent_tasks import add_keys, del_keys
49
from vm.models.instance import ACCESS_METHODS
50

51
from .store_api import Store, NoStoreException, NotOkException
52

53 54
logger = getLogger(__name__)

55 56
pwgen = User.objects.make_random_password

57

58
class Favourite(Model):
59
    instance = ForeignKey("vm.Instance")
60
    user = ForeignKey(User)
61 62


63 64 65 66 67 68 69
class Notification(TimeStampedModel):
    STATUS = Choices(('new', _('new')),
                     ('delivered', _('delivered')),
                     ('read', _('read')))

    status = StatusField()
    to = ForeignKey(User)
70 71
    subject_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
    message_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
72
    valid_until = DateTimeField(null=True, default=None)
73 74 75 76 77

    class Meta:
        ordering = ['-created']

    @classmethod
78 79 80
    def send(cls, user, subject, template, context,
             valid_until=None, subject_context=None):
        hro = create_readable(template, user=user, **context)
81
        subject = create_readable(subject, **(subject_context or context))
82 83 84
        return cls.objects.create(to=user,
                                  subject_data=subject.to_dict(),
                                  message_data=hro.to_dict(),
85
                                  valid_until=valid_until)
86

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102
    @property
    def subject(self):
        return HumanReadableObject.from_dict(self.subject_data)

    @subject.setter
    def subject(self, value):
        self.subject_data = None if value is None else value.to_dict()

    @property
    def message(self):
        return HumanReadableObject.from_dict(self.message_data)

    @message.setter
    def message(self, value):
        self.message_data = None if value is None else value.to_dict()

103

104 105 106 107 108 109 110 111 112 113 114 115 116
class ConnectCommand(Model):
    user = ForeignKey(User, related_name='command_set')
    access_method = CharField(max_length=10, choices=ACCESS_METHODS,
                              verbose_name=_('access method'),
                              help_text=_('Primary remote access method.'))
    application = CharField(max_length="128", verbose_name=_('application'),
                            help_text=_(
                                'Application name to use for this type '
                                'of connection protocol.'))
    template = CharField(blank=True, null=True, max_length=256,
                         help_text=_('Template for connection command.'))


117 118 119 120 121 122 123 124 125
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.'))
126
    instance_limit = IntegerField(default=5)
127
    use_gravatar = BooleanField(
128
        verbose_name=_("Use Gravatar"), default=True,
129
        help_text=_("Whether to use email address as Gravatar profile image"))
130 131
    email_notifications = BooleanField(
        verbose_name=_("Email notifications"), default=True,
132
        help_text=_('Whether user wants to get digested email notifications.'))
133 134 135 136 137
    smb_password = CharField(
        max_length=20,
        verbose_name=_('Samba password'),
        help_text=_(
            'Generated password for accessing store from '
Kálmán Viktor committed
138
            'virtual machines.'),
139 140
        default=pwgen,
    )
141
    disk_quota = FileSizeField(
142
        verbose_name=_('disk quota'),
143
        default=2048 * 1024 * 1024,
144
        help_text=_('Disk quota in mebibytes.'))
145

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162
    def get_connect_command(self, instance, use_ipv6=False):
        """ Generate connection command based on template."""
        try:
            command = self.user.command_set.get(
                access_method=instance.access_method)
        except ConnectCommand.DoesNotExist:
            # No template for this protocol return default
            return instance.get_connect_command(use_ipv6)
        else:
            return command.template % {
                'port': instance.get_connect_port(use_ipv6=use_ipv6),
                'host':  instance.get_connect_host(use_ipv6=use_ipv6),
                'password': instance.pw,
                'app': command.application,
                'username': 'cloud'
            }

163 164 165 166 167
    def notify(self, subject, template, context=None, valid_until=None,
               **kwargs):
        if context is not None:
            kwargs.update(context)
        return Notification.send(self.user, subject, template, kwargs,
168
                                 valid_until)
169

170
    def get_absolute_url(self):
Kálmán Viktor committed
171 172
        return reverse("dashboard.views.profile",
                       kwargs={'username': self.user.username})
173

174 175 176 177 178 179 180 181
    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")

182 183 184 185 186 187 188 189 190 191 192 193 194
    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()

195 196 197 198 199
    class Meta:
        permissions = (
            ('use_autocomplete', _('Can use autocomplete.')),
        )

Őry Máté committed
200

201 202 203 204 205 206 207 208 209 210 211
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
212

213 214 215 216 217 218 219 220 221 222
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.'))
223 224 225 226 227 228
    description = TextField(blank=True)

    def save(self, *args, **kwargs):
        if not self.org_id:
            self.org_id = None
        super(GroupProfile, self).save(*args, **kwargs)
229 230 231 232 233 234 235 236

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

237 238 239 240 241
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.group-detail', None,
                {'pk': self.group.pk})

242 243

def get_or_create_profile(self):
244
    obj, created = GroupProfile.objects.get_or_create(group_id=self.pk)
245 246 247 248 249
    return obj

Group.profile = property(get_or_create_profile)


250
def create_profile(sender, user, request, **kwargs):
251 252
    if not user.pk:
        return False
253
    profile, created = Profile.objects.get_or_create(user=user)
254

Őry Máté committed
255 256 257 258
    try:
        Store(user).create_user(profile.smb_password, None, profile.disk_quota)
    except:
        logger.exception("Can't create user %s", unicode(user))
259 260 261 262
    return created

user_logged_in.connect(create_profile)

263
if hasattr(settings, 'SAML_ORG_ID_ATTRIBUTE'):
264
    logger.debug("Register save_org_id to djangosaml2 pre_user_save")
265 266
    from djangosaml2.signals import pre_user_save

267
    def save_org_id(sender, **kwargs):
268
        logger.debug("save_org_id called by %s", sender.username)
269
        attributes = kwargs.pop('attributes')
270
        atr = settings.SAML_ORG_ID_ATTRIBUTE
271 272 273 274 275 276
        try:
            value = attributes[atr][0]
        except Exception as e:
            value = None
            logger.info("save_org_id couldn't find attribute. %s", unicode(e))

277 278 279 280
        if sender.pk is None:
            sender.save()
            logger.debug("save_org_id saved user %s", unicode(sender))

281 282
        profile, created = Profile.objects.get_or_create(user=sender)
        if created or profile.org_id != value:
283 284
            logger.info("org_id of %s added to user %s's profile",
                        value, sender.username)
285 286
            profile.org_id = value
            profile.save()
287 288 289
        else:
            logger.debug("org_id of %s already added to user %s's profile",
                         value, sender.username)
290
        memberatrs = getattr(settings, 'SAML_GROUP_ATTRIBUTES', [])
291 292
        for group in chain(*[attributes[i]
                             for i in memberatrs if i in attributes]):
293 294 295 296 297 298 299 300 301
            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)

302 303 304 305
        for i in FutureMember.objects.filter(org_id=value):
            i.group.user_set.add(sender)
            i.delete()

306
        owneratrs = getattr(settings, 'SAML_GROUP_OWNER_ATTRIBUTES', [])
307 308
        for group in chain(*[attributes[i]
                             for i in owneratrs if i in attributes]):
309 310 311 312 313 314 315 316 317 318
            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
319

320 321
    pre_user_save.connect(save_org_id)

322 323
else:
    logger.debug("Do not register save_org_id to djangosaml2 pre_user_save")
324 325


326 327 328
def update_store_profile(sender, **kwargs):
    profile = kwargs.get('instance')
    keys = [i.key for i in profile.user.userkey_set.all()]
Guba Sándor committed
329 330 331 332 333 334
    try:
        s = Store(profile.user)
        s.create_user(profile.smb_password, keys,
                      profile.disk_quota)
    except NoStoreException:
        logger.debug("Store is not available.")
335 336
    except NotOkException:
        logger.critical("Store is not accepting connections.")
Guba Sándor committed
337

338 339 340 341 342 343

post_save.connect(update_store_profile, sender=Profile)


def update_store_keys(sender, **kwargs):
    userkey = kwargs.get('instance')
Guba Sándor committed
344
    try:
Guba Sándor committed
345 346 347 348 349 350 351 352 353 354 355
        profile = userkey.user.profile
    except ObjectDoesNotExist:
        pass  # If there is no profile the user is deleted
    else:
        keys = [i.key for i in profile.user.userkey_set.all()]
        try:
            s = Store(userkey.user)
            s.create_user(profile.smb_password, keys,
                          profile.disk_quota)
        except NoStoreException:
            logger.debug("Store is not available.")
356 357
        except NotOkException:
            logger.critical("Store is not accepting connections.")
358 359 360 361 362 363


post_save.connect(update_store_keys, sender=UserKey)
post_delete.connect(update_store_keys, sender=UserKey)


364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391
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)