models.py 16.2 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 datetime import timedelta
21
from itertools import chain
22
from hashlib import md5
23 24
from logging import getLogger

25
from django.conf import settings
26
from django.contrib.auth.models import User, Group
27
from django.contrib.auth.signals import user_logged_in
28
from django.core.urlresolvers import reverse
29
from django.db.models import (
30
    Model, ForeignKey, OneToOneField, CharField, IntegerField, TextField,
31
    DateTimeField, BooleanField
32
)
33
from django.db.models.signals import post_save, pre_delete, post_delete
34
from django.templatetags.static import static
35
from django.utils import timezone
36
from django.utils.html import escape
37
from django.utils.translation import ugettext_lazy as _
38
from django_sshkey.models import UserKey
Guba Sándor committed
39
from django.core.exceptions import ObjectDoesNotExist
40

41 42
from sizefield.models import FileSizeField

43
from jsonfield import JSONField
44
from model_utils.models import TimeFramedModel, TimeStampedModel
45 46
from model_utils.fields import StatusField
from model_utils import Choices
47

48
from acl.models import AclBase
49
from common.models import HumanReadableObject, create_readable, Encoder
50

51
from vm.models.instance import ACCESS_METHODS
52

53
from .store_api import Store, NoStoreException, NotOkException, Timeout
54
from .validators import connect_command_template_validator
55

56 57
logger = getLogger(__name__)

Bach Dániel committed
58 59 60

def pwgen():
    return User.objects.make_random_password()
61

62

63
class Message(TimeStampedModel, TimeFramedModel):
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
    message = CharField(max_length=500, verbose_name=_('message'))
    effect = CharField(
        default='info', max_length=10, verbose_name=_('effect'),
        choices=(('success', _('success')), ('info', _('info')),
                 ('warning', _('warning')), ('danger', _('danger'))))
    enabled = BooleanField(default=False, verbose_name=_('enabled'))

    class Meta:
        ordering = ["id"]
        verbose_name = _('message')
        verbose_name_plural = _('messages')

    def __unicode__(self):
        return self.message

    def get_absolute_url(self):
80 81
        return reverse('dashboard.views.message-detail',
                       kwargs={'pk': self.pk})
82 83


84
class Favourite(Model):
85
    instance = ForeignKey("vm.Instance")
86
    user = ForeignKey(User)
87 88


89 90 91 92 93 94 95
class Notification(TimeStampedModel):
    STATUS = Choices(('new', _('new')),
                     ('delivered', _('delivered')),
                     ('read', _('read')))

    status = StatusField()
    to = ForeignKey(User)
96 97
    subject_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
    message_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
98
    valid_until = DateTimeField(null=True, default=None)
99 100 101 102 103

    class Meta:
        ordering = ['-created']

    @classmethod
104 105 106
    def send(cls, user, subject, template, context,
             valid_until=None, subject_context=None):
        hro = create_readable(template, user=user, **context)
107
        subject = create_readable(subject, **(subject_context or context))
108 109 110
        return cls.objects.create(to=user,
                                  subject_data=subject.to_dict(),
                                  message_data=hro.to_dict(),
111
                                  valid_until=valid_until)
112

113 114
    @property
    def subject(self):
115 116
        return HumanReadableObject.from_dict(
            self.escape_dict(self.subject_data))
117 118 119 120 121 122 123

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

    @property
    def message(self):
124 125 126 127 128 129 130 131
        return HumanReadableObject.from_dict(
            self.escape_dict(self.message_data))

    def escape_dict(self, data):
        for k, v in data['params'].items():
            if isinstance(v, basestring):
                data['params'][k] = escape(v)
        return data
132 133 134 135 136

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

137 138 139 140 141 142 143 144 145 146 147
    @property
    def has_valid_renew_url(self):
        params = self.message_data['params']
        return ('token' in params and 'suspend' in params and
                self.modified > timezone.now() - timedelta(days=3))

    @property
    def renew_url(self):
        return (settings.DJANGO_URL.rstrip("/") +
                str(self.message_data['params'].get('token')))

148

149 150 151 152
class ConnectCommand(Model):
    user = ForeignKey(User, related_name='command_set')
    access_method = CharField(max_length=10, choices=ACCESS_METHODS,
                              verbose_name=_('access method'),
153
                              help_text=_('Type of the remote access method.'))
154 155
    name = CharField(max_length="128", verbose_name=_('name'), blank=False,
                     help_text=_("Name of your custom command."))
156
    template = CharField(blank=True, null=True, max_length=256,
157 158 159 160
                         verbose_name=_('command template'),
                         help_text=_('Template for connection command string. '
                                     'Available parameters are: '
                                     'username, password, '
161 162
                                     'host, port.'),
                         validators=[connect_command_template_validator])
163

164 165 166
    class Meta:
        ordering = ('id', )

167 168
    def __unicode__(self):
        return self.template
169 170


171 172 173 174 175 176 177 178 179
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.'))
180
    instance_limit = IntegerField(default=5)
181
    use_gravatar = BooleanField(
182
        verbose_name=_("Use Gravatar"), default=True,
183
        help_text=_("Whether to use email address as Gravatar profile image"))
184 185
    email_notifications = BooleanField(
        verbose_name=_("Email notifications"), default=True,
186
        help_text=_('Whether user wants to get digested email notifications.'))
187 188
    desktop_notifications = BooleanField(
        verbose_name=_("Desktop notifications"), default=False,
189 190
        help_text=_('Whether user wants to get desktop notification when an '
                    'activity has finished and the window is not in focus.'))
191 192 193 194 195
    smb_password = CharField(
        max_length=20,
        verbose_name=_('Samba password'),
        help_text=_(
            'Generated password for accessing store from '
Kálmán Viktor committed
196
            'virtual machines.'),
197 198
        default=pwgen,
    )
199
    disk_quota = FileSizeField(
200
        verbose_name=_('disk quota'),
201
        default=2048 * 1024 * 1024,
202
        help_text=_('Disk quota in mebibytes.'))
203 204 205 206
    two_factor_secret = CharField(
        verbose_name=_("two factor secret key"),
        max_length=32, null=True, blank=True,
    )
207

208
    def get_connect_commands(self, instance, use_ipv6=False):
209
        """ Generate connection command based on template."""
210 211 212
        single_command = instance.get_connect_command(use_ipv6)
        if single_command:  # can we even connect to that VM
            commands = self.user.command_set.filter(
213
                access_method=instance.access_method)
214 215 216 217 218 219 220 221 222 223
            if commands.count() < 1:
                return [single_command]
            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,
                        'username': 'cloud',
                    } for command in commands]
224
        else:
225
            return []
226

227 228 229 230 231
    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,
232
                                 valid_until)
233

234
    def get_absolute_url(self):
Kálmán Viktor committed
235 236
        return reverse("dashboard.views.profile",
                       kwargs={'username': self.user.username})
237

238 239 240 241 242 243 244 245
    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")

246 247 248 249 250 251 252 253 254 255 256 257 258
    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()

259 260 261 262 263
    def save(self, *args, **kwargs):
        if self.org_id == "":
            self.org_id = None
        super(Profile, self).save(*args, **kwargs)

264
    class Meta:
265
        ordering = ('id', )
266 267 268 269
        permissions = (
            ('use_autocomplete', _('Can use autocomplete.')),
        )

Őry Máté committed
270

271 272 273 274 275 276
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:
277
        ordering = ('id', )
278 279 280 281 282
        unique_together = ('org_id', 'group')

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

Őry Máté committed
283

284 285 286 287 288 289 290 291 292 293
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.'))
294 295
    description = TextField(blank=True)

296 297 298
    class Meta:
        ordering = ('id', )

299 300 301
    def __unicode__(self):
        return self.group.name

302 303 304 305
    def save(self, *args, **kwargs):
        if not self.org_id:
            self.org_id = None
        super(GroupProfile, self).save(*args, **kwargs)
306 307 308 309 310 311 312 313

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

314
    def get_absolute_url(self):
315 316
        return reverse('dashboard.views.group-detail',
                       kwargs={'pk': self.group.pk})
317

318 319

def get_or_create_profile(self):
320
    obj, created = GroupProfile.objects.get_or_create(group_id=self.pk)
321 322 323 324 325
    return obj

Group.profile = property(get_or_create_profile)


326
def create_profile(user):
327 328
    if not user.pk:
        return False
329
    profile, created = Profile.objects.get_or_create(user=user)
330

Őry Máté committed
331 332 333 334
    try:
        Store(user).create_user(profile.smb_password, None, profile.disk_quota)
    except:
        logger.exception("Can't create user %s", unicode(user))
335 336
    return created

337 338 339 340 341

def create_profile_hook(sender, user, request, **kwargs):
    return create_profile(user)

user_logged_in.connect(create_profile_hook)
342

343
if hasattr(settings, 'SAML_ORG_ID_ATTRIBUTE'):
344
    logger.debug("Register save_org_id to djangosaml2 pre_user_save")
345 346
    from djangosaml2.signals import pre_user_save

347
    def save_org_id(sender, **kwargs):
348
        logger.debug("save_org_id called by %s", sender.username)
349
        attributes = kwargs.pop('attributes')
350
        atr = settings.SAML_ORG_ID_ATTRIBUTE
351
        try:
352
            value = attributes[atr][0].upper()
353 354 355 356
        except Exception as e:
            value = None
            logger.info("save_org_id couldn't find attribute. %s", unicode(e))

357 358 359 360
        if sender.pk is None:
            sender.save()
            logger.debug("save_org_id saved user %s", unicode(sender))

361 362
        profile, created = Profile.objects.get_or_create(user=sender)
        if created or profile.org_id != value:
363 364
            logger.info("org_id of %s added to user %s's profile",
                        value, sender.username)
365 366
            profile.org_id = value
            profile.save()
367 368 369
        else:
            logger.debug("org_id of %s already added to user %s's profile",
                         value, sender.username)
370
        memberatrs = getattr(settings, 'SAML_GROUP_ATTRIBUTES', [])
371 372
        for group in chain(*[attributes[i]
                             for i in memberatrs if i in attributes]):
373 374 375 376 377 378 379 380 381
            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)

382
        for i in FutureMember.objects.filter(org_id__iexact=value):
383 384 385
            i.group.user_set.add(sender)
            i.delete()

386
        owneratrs = getattr(settings, 'SAML_GROUP_OWNER_ATTRIBUTES', [])
387 388
        for group in chain(*[attributes[i]
                             for i in owneratrs if i in attributes]):
389 390 391 392 393 394 395 396 397 398
            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
399

400 401
    pre_user_save.connect(save_org_id)

402

403 404 405
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
406 407 408 409 410 411
    try:
        s = Store(profile.user)
        s.create_user(profile.smb_password, keys,
                      profile.disk_quota)
    except NoStoreException:
        logger.debug("Store is not available.")
412
    except (NotOkException, Timeout):
413
        logger.critical("Store is not accepting connections.")
Guba Sándor committed
414

415 416 417 418 419 420

post_save.connect(update_store_profile, sender=Profile)


def update_store_keys(sender, **kwargs):
    userkey = kwargs.get('instance')
Guba Sándor committed
421
    try:
Guba Sándor committed
422 423 424 425 426 427 428 429 430 431 432
        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.")
433 434
        except NotOkException:
            logger.critical("Store is not accepting connections.")
435 436 437 438 439 440


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


441 442 443 444 445
def add_ssh_keys(sender, **kwargs):
    from vm.models import Instance

    userkey = kwargs.get('instance')
    instances = Instance.get_objects_with_level(
446 447
        'user', userkey.user, disregard_superuser=True
    ).filter(status='RUNNING')
448 449
    for i in instances:
        logger.info('called add_keys(%s, %s)', i, userkey)
450 451 452 453
        try:
            i.install_keys(user=userkey.user, keys=[userkey.key])
        except Instance.NoAgentError:
            logger.info("%s has no agent running", i)
454 455 456 457 458 459 460


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

    userkey = kwargs.get('instance')
    instances = Instance.get_objects_with_level(
461 462
        'user', userkey.user, disregard_superuser=True
    ).filter(status='RUNNING')
463 464
    for i in instances:
        logger.info('called del_keys(%s, %s)', i, userkey)
465 466 467 468
        try:
            i.remove_keys(user=userkey.user, keys=[userkey.key])
        except Instance.NoAgentError:
            logger.info("%s has no agent running", i)
469 470 471 472


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