models.py 14.7 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.html import escape
35
from django.utils.translation import ugettext_lazy as _
36
from django_sshkey.models import UserKey
Guba Sándor committed
37
from django.core.exceptions import ObjectDoesNotExist
38

39 40
from sizefield.models import FileSizeField

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

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

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

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

55 56
logger = getLogger(__name__)

Bach Dániel committed
57 58 59

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

61

62
class Favourite(Model):
63
    instance = ForeignKey("vm.Instance")
64
    user = ForeignKey(User)
65 66


67 68 69 70 71 72 73
class Notification(TimeStampedModel):
    STATUS = Choices(('new', _('new')),
                     ('delivered', _('delivered')),
                     ('read', _('read')))

    status = StatusField()
    to = ForeignKey(User)
74 75
    subject_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
    message_data = JSONField(null=True, dump_kwargs={"cls": Encoder})
76
    valid_until = DateTimeField(null=True, default=None)
77 78 79 80 81

    class Meta:
        ordering = ['-created']

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

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

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

    @property
    def message(self):
102 103 104 105 106 107 108 109
        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
110 111 112 113 114

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

115

116 117 118 119
class ConnectCommand(Model):
    user = ForeignKey(User, related_name='command_set')
    access_method = CharField(max_length=10, choices=ACCESS_METHODS,
                              verbose_name=_('access method'),
120
                              help_text=_('Type of the remote access method.'))
121 122
    name = CharField(max_length="128", verbose_name=_('name'), blank=False,
                     help_text=_("Name of your custom command."))
123
    template = CharField(blank=True, null=True, max_length=256,
124 125 126 127
                         verbose_name=_('command template'),
                         help_text=_('Template for connection command string. '
                                     'Available parameters are: '
                                     'username, password, '
128 129
                                     'host, port.'),
                         validators=[connect_command_template_validator])
130

131 132 133
    class Meta:
        ordering = ('id', )

134 135
    def __unicode__(self):
        return self.template
136 137


138 139 140 141 142 143 144 145 146
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.'))
147
    instance_limit = IntegerField(default=5)
148
    use_gravatar = BooleanField(
149
        verbose_name=_("Use Gravatar"), default=True,
150
        help_text=_("Whether to use email address as Gravatar profile image"))
151 152
    email_notifications = BooleanField(
        verbose_name=_("Email notifications"), default=True,
153
        help_text=_('Whether user wants to get digested email notifications.'))
154 155 156 157 158
    smb_password = CharField(
        max_length=20,
        verbose_name=_('Samba password'),
        help_text=_(
            'Generated password for accessing store from '
Kálmán Viktor committed
159
            'virtual machines.'),
160 161
        default=pwgen,
    )
162
    disk_quota = FileSizeField(
163
        verbose_name=_('disk quota'),
164
        default=2048 * 1024 * 1024,
165
        help_text=_('Disk quota in mebibytes.'))
166

167
    def get_connect_commands(self, instance, use_ipv6=False):
168
        """ Generate connection command based on template."""
169 170 171
        single_command = instance.get_connect_command(use_ipv6)
        if single_command:  # can we even connect to that VM
            commands = self.user.command_set.filter(
172
                access_method=instance.access_method)
173 174 175 176 177 178 179 180 181 182
            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]
183
        else:
184
            return []
185

186 187 188 189 190
    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,
191
                                 valid_until)
192

193
    def get_absolute_url(self):
Kálmán Viktor committed
194 195
        return reverse("dashboard.views.profile",
                       kwargs={'username': self.user.username})
196

197 198 199 200 201 202 203 204
    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")

205 206 207 208 209 210 211 212 213 214 215 216 217
    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()

218 219 220 221 222
    def save(self, *args, **kwargs):
        if self.org_id == "":
            self.org_id = None
        super(Profile, self).save(*args, **kwargs)

223
    class Meta:
224
        ordering = ('id', )
225 226 227 228
        permissions = (
            ('use_autocomplete', _('Can use autocomplete.')),
        )

Őry Máté committed
229

230 231 232 233 234 235
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:
236
        ordering = ('id', )
237 238 239 240 241
        unique_together = ('org_id', 'group')

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

Őry Máté committed
242

243 244 245 246 247 248 249 250 251 252
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.'))
253 254
    description = TextField(blank=True)

255 256 257
    class Meta:
        ordering = ('id', )

258 259 260
    def __unicode__(self):
        return self.group.name

261 262 263 264
    def save(self, *args, **kwargs):
        if not self.org_id:
            self.org_id = None
        super(GroupProfile, self).save(*args, **kwargs)
265 266 267 268 269 270 271 272

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

273 274 275 276 277
    @permalink
    def get_absolute_url(self):
        return ('dashboard.views.group-detail', None,
                {'pk': self.group.pk})

278 279

def get_or_create_profile(self):
280
    obj, created = GroupProfile.objects.get_or_create(group_id=self.pk)
281 282 283 284 285
    return obj

Group.profile = property(get_or_create_profile)


286
def create_profile(user):
287 288
    if not user.pk:
        return False
289
    profile, created = Profile.objects.get_or_create(user=user)
290

Őry Máté committed
291 292 293 294
    try:
        Store(user).create_user(profile.smb_password, None, profile.disk_quota)
    except:
        logger.exception("Can't create user %s", unicode(user))
295 296
    return created

297 298 299 300 301

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

user_logged_in.connect(create_profile_hook)
302

303
if hasattr(settings, 'SAML_ORG_ID_ATTRIBUTE'):
304
    logger.debug("Register save_org_id to djangosaml2 pre_user_save")
305 306
    from djangosaml2.signals import pre_user_save

307
    def save_org_id(sender, **kwargs):
308
        logger.debug("save_org_id called by %s", sender.username)
309
        attributes = kwargs.pop('attributes')
310
        atr = settings.SAML_ORG_ID_ATTRIBUTE
311
        try:
312
            value = attributes[atr][0].upper()
313 314 315 316
        except Exception as e:
            value = None
            logger.info("save_org_id couldn't find attribute. %s", unicode(e))

317 318 319 320
        if sender.pk is None:
            sender.save()
            logger.debug("save_org_id saved user %s", unicode(sender))

321 322
        profile, created = Profile.objects.get_or_create(user=sender)
        if created or profile.org_id != value:
323 324
            logger.info("org_id of %s added to user %s's profile",
                        value, sender.username)
325 326
            profile.org_id = value
            profile.save()
327 328 329
        else:
            logger.debug("org_id of %s already added to user %s's profile",
                         value, sender.username)
330
        memberatrs = getattr(settings, 'SAML_GROUP_ATTRIBUTES', [])
331 332
        for group in chain(*[attributes[i]
                             for i in memberatrs if i in attributes]):
333 334 335 336 337 338 339 340 341
            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)

342
        for i in FutureMember.objects.filter(org_id__iexact=value):
343 344 345
            i.group.user_set.add(sender)
            i.delete()

346
        owneratrs = getattr(settings, 'SAML_GROUP_OWNER_ATTRIBUTES', [])
347 348
        for group in chain(*[attributes[i]
                             for i in owneratrs if i in attributes]):
349 350 351 352 353 354 355 356 357 358
            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
359

360 361
    pre_user_save.connect(save_org_id)

362 363
else:
    logger.debug("Do not register save_org_id to djangosaml2 pre_user_save")
364 365


366 367 368
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
369 370 371 372 373 374
    try:
        s = Store(profile.user)
        s.create_user(profile.smb_password, keys,
                      profile.disk_quota)
    except NoStoreException:
        logger.debug("Store is not available.")
375
    except (NotOkException, Timeout):
376
        logger.critical("Store is not accepting connections.")
Guba Sándor committed
377

378 379 380 381 382 383

post_save.connect(update_store_profile, sender=Profile)


def update_store_keys(sender, **kwargs):
    userkey = kwargs.get('instance')
Guba Sándor committed
384
    try:
Guba Sándor committed
385 386 387 388 389 390 391 392 393 394 395
        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.")
396 397
        except NotOkException:
            logger.critical("Store is not accepting connections.")
398 399 400 401 402 403


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


404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
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)