models.py 20.9 KB
Newer Older
Lukas Burgey's avatar
Lukas Burgey committed
1
2
3
4
5
# django senders need their arguments
# pylint: disable=unused-argument

import json
import logging
6
import pika
Lukas Burgey's avatar
Lukas Burgey committed
7
from requests.auth import HTTPBasicAuth
Lukas Burgey's avatar
Lukas Burgey committed
8
from django.contrib.auth.models import AbstractUser, Group
9
from django.core.cache import cache
Lukas Burgey's avatar
Lukas Burgey committed
10
from django.db import models
Lukas Burgey's avatar
Lukas Burgey committed
11
from django.db.models.signals import post_save
Lukas Burgey's avatar
Lukas Burgey committed
12
from django.dispatch import receiver
13
from django_mysql.models import JSONField
Lukas Burgey's avatar
Lukas Burgey committed
14
from .auth.v1.models import OIDCConfig
Lukas Burgey's avatar
Lukas Burgey committed
15

Lukas Burgey's avatar
Lukas Burgey committed
16
LOGGER = logging.getLogger(__name__)
17
18

RABBITMQ_CONNECTION = None
19

Lukas Burgey's avatar
Lukas Burgey committed
20

21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
# singleton for simple configs
# https://steelkiwi.com/blog/practical-application-singleton-design-pattern/
class SingletonModel(models.Model):
    class Meta:
        abstract = True

    def set_cache(self):
        cache.set(self.__class__.__name__, self)

    # pylint: disable=invalid-name, arguments-differ
    def save(self, *args, **kwargs):
        self.pk = 1
        super(SingletonModel, self).save(*args, **kwargs)
        self.set_cache()

    @classmethod
    def load(cls):
        if cache.get(cls.__name__) is None:
            obj, created = cls.objects.get_or_create(pk=1)
            if not created:
                obj.set_cache()
        return cache.get(cls.__name__)


Lukas Burgey's avatar
Lukas Burgey committed
45
46
# clients are registerred at rabbitmq, when they are assigned to a site
# (because we only then know what services they provide)
47
class RabbitMQInstance(SingletonModel):
Lukas Burgey's avatar
Lukas Burgey committed
48
    host = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
49
50
51
        max_length=150,
        default='localhost',
    )
Lukas Burgey's avatar
Lukas Burgey committed
52
53
54
55
    vhost = models.CharField(
        max_length=150,
        default='%2f',
    )
Lukas Burgey's avatar
Lukas Burgey committed
56
    exchange = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
57
58
59
        max_length=150,
        default='deployments',
    )
Lukas Burgey's avatar
Lukas Burgey committed
60
    port = models.IntegerField(
Lukas Burgey's avatar
Lukas Burgey committed
61
        default=15672,
Lukas Burgey's avatar
Lukas Burgey committed
62
    )
Lukas Burgey's avatar
Lukas Burgey committed
63
    username = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
64
65
66
        max_length=150,
        default='guest',
    )
Lukas Burgey's avatar
Lukas Burgey committed
67
    password = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
68
69
70
        max_length=150,
        default='guest',
    )
Lukas Burgey's avatar
Lukas Burgey committed
71
72
73
74

    def __str__(self):
        return self.host

Lukas Burgey's avatar
Lukas Burgey committed
75
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
76
        return '[RabbitMQ:{}] {}'.format(self.host, msg)
Lukas Burgey's avatar
Lukas Burgey committed
77
78
79
80

    @property
    def auth(self):
        return HTTPBasicAuth(
Lukas Burgey's avatar
Lukas Burgey committed
81
            self.username,
Lukas Burgey's avatar
Lukas Burgey committed
82
            self.password,
Lukas Burgey's avatar
Lukas Burgey committed
83
        )
Lukas Burgey's avatar
Lukas Burgey committed
84

85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
    def _init_exchanges(self, channel):
        channel.exchange_declare(
            exchange=self.exchange,
            durable=True,
            auto_delete=False,
            exchange_type='topic',
        )
        # TODO put in config
        channel.exchange_declare(
            exchange='update',
            durable=True,
            auto_delete=False,
            exchange_type='topic',
        )

    def _init_connection(self):
        global RABBITMQ_CONNECTION
        LOGGER.info('Opening new BlockingConnection')
        RABBITMQ_CONNECTION = pika.BlockingConnection(
            pika.ConnectionParameters(
                host=self.host,
                ssl=True,
                heartbeat_interval=60,
            )
        )
        return RABBITMQ_CONNECTION

    @property
    def _connection(self):
        global RABBITMQ_CONNECTION
        if RABBITMQ_CONNECTION is not None:
            if RABBITMQ_CONNECTION.is_open:
                return RABBITMQ_CONNECTION
            elif RABBITMQ_CONNECTION.is_closing:
                RABBITMQ_CONNECTION.close()

        connection = self._init_connection()
        channel = connection.channel()
        self._init_exchanges(connection.channel())
        channel.close()
        RABBITMQ_CONNECTION = connection
        return connection

Lukas Burgey's avatar
Lukas Burgey committed
128
    @property
129
130
131
132
133
134
135
136
137
138
139
140
141
142
    def _channel(self):
        channel = self._connection.channel()
        channel.confirm_delivery()
        return channel

    def _publish(self, exchange, routing_key, body):
        channel = self._channel
        self._channel.basic_publish(
            exchange=exchange,
            routing_key=routing_key,
            body=body,
            properties=pika.BasicProperties(
                delivery_mode=1,
            ),
Lukas Burgey's avatar
Lukas Burgey committed
143
        )
144
        channel.close()
145

Lukas Burgey's avatar
Lukas Burgey committed
146

147
    # PUBLIC API
148
    def publish_by_service(self, service, msg):
149
150
151
152
153
        self._publish(
            self.exchange,
            service.routing_key,
            msg,
        )
Lukas Burgey's avatar
Lukas Burgey committed
154

155
    def publish_to_webpage(self, user, msg):
156
157
158
159
        LOGGER.debug('Signalling webpage of user %s', user)
        self._publish(
            'update',
            str(user.id),
160
            json.dumps(msg),
161
        )
162

Lukas Burgey's avatar
Lukas Burgey committed
163

164
165
166
167
def user_info_default():
    return {}


Lukas Burgey's avatar
Lukas Burgey committed
168
class User(AbstractUser):
169
    TYPE_CHOICES = (
Lukas Burgey's avatar
Lukas Burgey committed
170
171
172
173
        ('apiclient', 'API-Client'),
        ('oidcuser', 'OIDC User'),
        ('admin', 'Admin'),
    )
174
    user_type = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
175
176
        max_length=20,
        choices=TYPE_CHOICES,
Lukas Burgey's avatar
Lukas Burgey committed
177
        default='apiclient',
Lukas Burgey's avatar
Lukas Burgey committed
178
    )
179
180
181
182
    sub = models.CharField(
        max_length=150,
        blank=True,
        null=True,
183
        editable=False,
184
185
186
187
188
189
190
191
192
193
194
195
    )
    password = models.CharField(
        max_length=150,
        blank=True,
        null=True,
    )
    # the real state of the user
    # (self.is_active is the supposed state of the user)
    _is_active = models.BooleanField(
        default=True,
        editable=False,
    )
Lukas Burgey's avatar
Lukas Burgey committed
196
197
198
199
200
    # the idp which authenticated the user
    idp = models.ForeignKey(
        OIDCConfig,
        related_name='users',
        on_delete=models.CASCADE,
201
202
203
        blank=True,
        null=True,
        editable=False,
Lukas Burgey's avatar
Lukas Burgey committed
204
    )
205
206
207
208
    userinfo = JSONField(
        default=user_info_default,
        null=True,
        blank=True,
209
        editable=False,
210
    )
Lukas Burgey's avatar
Lukas Burgey committed
211

Lukas Burgey's avatar
Lukas Burgey committed
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
    # returns the user as identified by userinfo and idp
    # if the user does not exists
    @classmethod
    def get_user(cls, userinfo, idp):
        if not 'sub' in userinfo:
            raise Exception('get_user needs a userinfo which contains the users subject')

        query_result = cls.objects.filter(
            sub=userinfo['sub'],
            idp=idp,
        )
        if not query_result.exists():
            return cls.construct_from_userinfo(userinfo, idp)

        if len(query_result) > 1:
            return Exception('Two user instances with same subject from the same idp')

        # TODO update the users userinfo when it changes
        # TODO update the users groupinfo when it changes
        return query_result.first()

    @classmethod
    def construct_from_userinfo(cls, userinfo, idp):
        LOGGER.debug('User: constructing from %s', userinfo)

        if 'sub' not in userinfo:
            raise Exception('Missing attribute in userinfo: sub')
        sub = userinfo['sub']

        if 'email' not in userinfo:
            if 'name' not in userinfo:
                raise Exception('Missing attributes in userinfo: email and name')

            username = userinfo['name']
        else:
            username = userinfo['email']

        user = cls(
            user_type='oidcuser',
            username=username,
            sub=sub,
            idp=idp,
            userinfo=userinfo,
        )
        user.save()
Lukas Burgey's avatar
Lukas Burgey committed
257
258
259
260
261
262

        for group in idp.get_user_groupinformation(
                userinfo,
        ).all():
            group.users.add(user)

Lukas Burgey's avatar
Lukas Burgey committed
263
264
265
266
267
268
269
270
271
272
273
274
        return user

    @classmethod
    def construct_client(cls, username, password):
        LOGGER.debug('APICLIENT: new client %s', username)
        client = cls(
            username=username,
            user_type='apiclient',
        )
        client.set_password(password)
        return client

Lukas Burgey's avatar
Lukas Burgey committed
275
    # we hide deleted keys here
276
    # the full list of ssh keys is self._ssh_keys
Lukas Burgey's avatar
Lukas Burgey committed
277
278
279
280
    @property
    def ssh_keys(self):
        return self._ssh_keys.filter(deleted=False)

281
282
283
284
    @property
    def is_active_at_clients(self):
        return self._is_active

285
286
287
    def __str__(self):
        if self.user_type == 'admin':
            return 'ADMIN {}'.format(self.username)
Lukas Burgey's avatar
Lukas Burgey committed
288
        elif self.user_type == 'oidcuser':
289
290
291
            if not self.is_active:
                return 'DEACTIVATED USER {}'.format(self.username)
            return 'USER {}'.format(self.username)
Lukas Burgey's avatar
Lukas Burgey committed
292
        elif self.user_type == 'apiclient':
293
294
295
296
297
            try:
                return 'APICLIENT {}@{}'.format(self.username, self.site)
            except:
                return 'APICLIENT {}'.format(self.username)

Lukas Burgey's avatar
Lukas Burgey committed
298
299
        else:
            raise Exception()
Lukas Burgey's avatar
Lukas Burgey committed
300

Lukas Burgey's avatar
Lukas Burgey committed
301
    def msg(self, msg):
302
303
304
305
306
307
308
        return '[{}] {}'.format(self, msg)

    # oidcuser: withdraw and delete all credentials and delete the user
    def remove(self):
        if self.user_type == 'oidcuser':
            self.deactivate()

Lukas Burgey's avatar
Lukas Burgey committed
309
            # FIXME: deleting the user brings problems:
310
311
            # the deletion cascades down to DeploymentTask and DeploymentTaskItem
            # but these need to be conserved so all clients withdrawals can be tracked
Lukas Burgey's avatar
Lukas Burgey committed
312
            LOGGER.info(self.msg('Deleting'))
313
314
315
            self.delete()

    def activate(self):
316
        if self._is_active:
Lukas Burgey's avatar
Lukas Burgey committed
317
            LOGGER.error(self.msg('already activated'))
318
319
            return

Lukas Burgey's avatar
Lukas Burgey committed
320
321
322
323
        self.is_active = True
        self._is_active = True
        self.save()
        LOGGER.info(self.msg('activated'))
324

Lukas Burgey's avatar
Lukas Burgey committed
325
326
        # oidcuser: deploy the according credentials
        if self.user_type == 'oidcuser':
327
328
329
330
            for dep in self.deployments.all():
                dep.activate()

    def deactivate(self):
331
        if not self._is_active:
Lukas Burgey's avatar
Lukas Burgey committed
332
            LOGGER.error(self.msg('already deactivated'))
333
334
            return

Lukas Burgey's avatar
Lukas Burgey committed
335
336
337
338
339
340
        self.is_active = False
        self._is_active = False
        self.save()
        LOGGER.info(self.msg('deactivated'))

        # oidcuser: withdraw all credentials
341
342
343
344
345
        if self.user_type == 'oidcuser':

            for dep in self.deployments.all():
                dep.deactivate()

Lukas Burgey's avatar
Lukas Burgey committed
346

Lukas Burgey's avatar
Lukas Burgey committed
347
348
349
350
351
352
353
354
355
356
357
358
# authorisation groups
class AuthGroup(models.Model):
    name = models.CharField(
        max_length=200,
    )
    users = models.ManyToManyField(
        User,
        related_name='auth_groups',
        blank=True,
    )


Lukas Burgey's avatar
Lukas Burgey committed
359
class Site(models.Model):
360
    client = models.OneToOneField(
Lukas Burgey's avatar
Lukas Burgey committed
361
362
        User,
        related_name='site',
363
364
365
366
367
368
369
370
371
372
373
        on_delete=models.SET_NULL,
        null=True,
        blank=True,
    )
    name = models.CharField(
        max_length=150,
        unique=True,
    )
    description = models.TextField(
        max_length=300,
        blank=True,
Lukas Burgey's avatar
Lukas Burgey committed
374
    )
Lukas Burgey's avatar
Lukas Burgey committed
375
376
377
378

    def __str__(self):
        return self.name

379
380
381
382
383
384
    # tasks which are still to be executed on this site
    @property
    def tasks(self):
        return [item.task
                for item
                in self.task_items.all()]
Lukas Burgey's avatar
Lukas Burgey committed
385

Lukas Burgey's avatar
Lukas Burgey committed
386
387
388
389

class Service(models.Model):
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
390
    site = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
391
392
        Site,
        related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
393
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
394
395
396
        Group,
        related_name='services',
        blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
397

398
399
400
401
    @property
    def routing_key(self):
        return 'service.{}'.format(self.name)

Lukas Burgey's avatar
Lukas Burgey committed
402
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
403
        return self.name
Lukas Burgey's avatar
Lukas Burgey committed
404
405
406


class SSHPublicKey(models.Model):
Lukas Burgey's avatar
Lukas Burgey committed
407
408
409
410
411
412
    name = models.CharField(
        max_length=150,
    )
    key = models.TextField(
        max_length=1000
    )
Lukas Burgey's avatar
Lukas Burgey committed
413
    # hidden field at the user
414
    # TODO checks: if the user is null
Lukas Burgey's avatar
Lukas Burgey committed
415
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
416
417
        User,
        related_name='_ssh_keys',
418
419
        on_delete=models.SET_NULL,
        null=True,
Lukas Burgey's avatar
Lukas Burgey committed
420
    )
Lukas Burgey's avatar
Lukas Burgey committed
421

Lukas Burgey's avatar
Lukas Burgey committed
422
423
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
Lukas Burgey's avatar
Lukas Burgey committed
424
425
426
        default=False,
        editable=False,
    )
427

Lukas Burgey's avatar
Lukas Burgey committed
428
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
429
        return '[SSHPublicKey:{}] {}'.format(self, msg)
430

431
432
433
    # does not directly delete the key if the key is deployed or withdrawn
    # somewhere
    # the receiver 'delete_withdrawn_ssh_key' does the actual deletion
434
    def delete_key(self):
Lukas Burgey's avatar
Lukas Burgey committed
435
        if (not self.tasks.exists() and not self.deployments.exists()):
Lukas Burgey's avatar
Lukas Burgey committed
436
            LOGGER.info(self.msg('Direct deletion of key'))
437
438
439
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
440
        LOGGER.info(self.msg('Deletion of key started'))
441
442
443
        self.deleted = True
        self.save()

Lukas Burgey's avatar
Lukas Burgey committed
444
        # delete implies withdrawing the key from all clients
445
446
447
        for deployment in self.deployments.all():
            deployment.withdraw_key(self)

Lukas Burgey's avatar
Lukas Burgey committed
448
449
    # when a key is withdrawn by a client we try to finally delete it
    def try_final_deletion(self):
Lukas Burgey's avatar
Lukas Burgey committed
450
        if (self.deleted and not self.tasks.exists()):
Lukas Burgey's avatar
Lukas Burgey committed
451
            LOGGER.info(self.msg(
Lukas Burgey's avatar
Lukas Burgey committed
452
                'All clients have withdrawn this key. Final deletion'))
Lukas Burgey's avatar
Lukas Burgey committed
453
454
455
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
456
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
457
458
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
459
460
461
        return self.name


462
# Deployment describes the credential state per user as it is supposed to be
463
464
465
466
#
# (exception: if is_active=False the ssh_keys contain the keys to be deployed
# if the deployment is reactivated)
#
467
468
# DeploymentTask is what is sent to the clients via rabbitmq
# The DeploymentTaskItem track the acknowledgements from the clients
Lukas Burgey's avatar
Lukas Burgey committed
469
470
class Deployment(models.Model):
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
471
472
473
474
        User,
        related_name='deployments',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
475
    service = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
476
477
478
479
        Service,
        related_name='deployments',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
480
    ssh_keys = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
481
482
483
484
        SSHPublicKey,
        related_name='deployments',
        blank=True,
    )
485
    ssh_keys_to_withdraw = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
486
487
488
489
        SSHPublicKey,
        related_name='withdrawn_deployments',
        blank=True,
    )
490
    is_active = models.BooleanField(
Lukas Burgey's avatar
Lukas Burgey committed
491
492
        default=True,
    )
493

Lukas Burgey's avatar
Lukas Burgey committed
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514

    # get a deployment for a user/service.
    # if it does not exist it is created
    @classmethod
    def get_deployment(cls, user, service):
        query = cls.objects.filter(
            user=user,
        ).filter(
            service=service,
        )
        if query.exists():
            return query.first()

        deployment = cls(
            user=user,
            service=service,
        )
        deployment.save()
        return deployment


515
516
517
    @property
    def withdrawals(self):
        return self.tasks.filter(action='withdraw')
Lukas Burgey's avatar
Lukas Burgey committed
518

519
520
521
    @property
    def deploys(self):
        return self.tasks.filter(action='deploy')
Lukas Burgey's avatar
Lukas Burgey committed
522

523
524
    def __str__(self):
        return '{}:{}'.format(self.service, self.user)
525

Lukas Burgey's avatar
Lukas Burgey committed
526
    def msg(self, msg):
527
        return '[Deployment:{}] {}'.format(self, msg)
528

529
530
531
    # deploy credentials which were deployed prior to deactivation
    def activate(self):
        if self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
532
            LOGGER.error(self.msg('already active'))
533
534
            return

Lukas Burgey's avatar
Lukas Burgey committed
535
        LOGGER.debug(self.msg(str(self.ssh_keys.all())))
536
537
538
539
540
        for key in self.ssh_keys.all():
            self._deploy_key(key)

        self.is_active = True
        self.save()
Lukas Burgey's avatar
Lukas Burgey committed
541
        LOGGER.info(self.msg('activated'))
542
543
544
545

    # withdraw all credentials
    def deactivate(self):
        if not self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
546
            LOGGER.error(self.msg('already deactivated'))
547
548
549
            return

        self.is_active = False
550
        self.save()
551

552
553
554
        for key in self.ssh_keys.all():
            self._withdraw_key(key)

Lukas Burgey's avatar
Lukas Burgey committed
555
        LOGGER.info(self.msg('deactivated'))
556
557
558

    # only deploy the key
    def _deploy_key(self, key):
Lukas Burgey's avatar
Lukas Burgey committed
559
        task = DeploymentTask.construct_deployment_task(
Lukas Burgey's avatar
Lukas Burgey committed
560
561
562
            deployment=self,
            key=key,
        )
563
564
        # publish the task
        task.publish()
565

566
    def _withdraw_key(self, key):
Lukas Burgey's avatar
Lukas Burgey committed
567
        task = DeploymentTask.construct_withdrawal_task(
Lukas Burgey's avatar
Lukas Burgey committed
568
569
570
            deployment=self,
            key=key,
        )
571

572
573
        # publish the task
        task.publish()
Lukas Burgey's avatar
Lukas Burgey committed
574

575
576
577
    # deploy key and track changes in the key lists
    def deploy_key(self, key):
        if not self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
578
            LOGGER.error(self.msg('cannot deploy while deactivated'))
579
580
581
582
583
584
585
586
587
588
589
590
591
            raise Exception('deployment deactivated')

        self.ssh_keys.add(key)

        if key in self.ssh_keys_to_withdraw.all():
            self.ssh_keys_to_withdraw.remove(key)
        self.save()

        self._deploy_key(key)

    # withdraw key and track changes in the key lists
    def withdraw_key(self, key):
        if not self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
592
            LOGGER.error(self.msg('cannot withdraw while deactivated'))
593
594
595
596
597
598
599
600
601
602
            raise Exception('deployment deactivated')

        self.ssh_keys.remove(key)

        # keys which are to be withdrawn by the clients
        self.ssh_keys_to_withdraw.add(key)
        self.save()

        self._withdraw_key(key)

Lukas Burgey's avatar
Lukas Burgey committed
603

604
605
class DeploymentTask(models.Model):
    ACTION_CHOICES = (
Lukas Burgey's avatar
Lukas Burgey committed
606
607
608
        ('deploy', 'deploy'),
        ('withdraw', 'withdraw'),
    )
609
    action = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
610
611
612
        max_length=10,
        choices=ACTION_CHOICES,
    )
613
    key = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
614
615
616
617
        SSHPublicKey,
        related_name='tasks',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
618
    deployment = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
619
620
621
622
        Deployment,
        related_name='tasks',
        on_delete=models.CASCADE,
    )
623
624
625
626
627
    user = models.ForeignKey(
        User,
        related_name='deployment_tasks',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
628

Lukas Burgey's avatar
Lukas Burgey committed
629
630
631
632
633
634
635
636
637
638
639
    @classmethod
    def construct_deployment_task(cls, deployment, key):
        # delete outstanding tasks which are made obsolete by this task
        for withdrawal in deployment.withdrawals.filter(key=key):
            LOGGER.debug(withdrawal.msg('now obsolete'))
            withdrawal.delete()

        task = cls(
            action='deploy',
            deployment=deployment,
            key=key,
640
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
        )
        task.save()
        LOGGER.debug(task.msg('generated'))

        # generate task items
        for site in deployment.service.site.all():
            deploy = DeploymentTaskItem(
                task=task,
                site=site,
            )
            deploy.save()
            LOGGER.debug(deploy.msg('generated'))

        return task

    @classmethod
    def construct_withdrawal_task(cls, deployment, key):
        # delete outstanding tasks which are made obsolete by this task
        for withdrawal in deployment.deploys.filter(key=key):
            LOGGER.debug(withdrawal.msg('now obsolete'))
            withdrawal.delete()

        task = cls(
            action='withdraw',
            deployment=deployment,
            key=key,
667
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
        )
        task.save()
        LOGGER.debug(task.msg('generated'))

        # generate task items
        for site in deployment.service.site.all():
            deploy = DeploymentTaskItem(
                task=task,
                site=site,
            )
            deploy.save()
            LOGGER.debug(deploy.msg('generated'))

        return task

Lukas Burgey's avatar
Lukas Burgey committed
683
684
685
686
    @property
    def service(self):
        return self.deployment.service

687
    def __str__(self):
688
        return "{}:{}:{} - {}#{}".format(
Lukas Burgey's avatar
Lukas Burgey committed
689
690
691
692
            self.deployment.service,
            self.deployment.user,
            self.key,
            self.action,
693
            self.id,
Lukas Burgey's avatar
Lukas Burgey committed
694
        )
695

Lukas Burgey's avatar
Lukas Burgey committed
696
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
697
        return '[DeploymentTask:{}] {}'.format(self, msg)
698
699

    def publish(self):
700
        # FIXME mitigating circular dependencies here
701
702
703
        from .clientapi.serializers import DeploymentTaskSerializer
        msg = json.dumps(DeploymentTaskSerializer(self).data)

704
        RabbitMQInstance.load().publish_by_service(
Lukas Burgey's avatar
Lukas Burgey committed
705
706
707
            self.service,
            msg,
        )
708
709
710

    # the client acked the receipt and execution of the task for his site
    def item_finished(self, site):
711

Lukas Burgey's avatar
Lukas Burgey committed
712
        item = self.task_items.get(site=site)
713
        # LOGGER.debug(item.msg('done'))
Lukas Burgey's avatar
Lukas Burgey committed
714
        item.delete()
715
716

        if not self.task_items.exists():
717
            # finished sends its own message
718
            self.finished()
719
720
721
722
723
724
725
726
727
        else:
            from .frontend.views import user_state_dict
            content = {
                'user_state': user_state_dict(self.user),
            }
            RabbitMQInstance.load().publish_to_webpage(
                self.user,
                content,
            )
728
729
730

    # maintenance after all task items are done
    def finished(self):
Lukas Burgey's avatar
Lukas Burgey committed
731
        LOGGER.info(self.msg('done'))
732

Lukas Burgey's avatar
Lukas Burgey committed
733
        self.delete()
734
735
736
737
738

        # check if this was the final withdraw in a key deletion
        if self.action == 'withdraw':
            self.key.try_final_deletion()

739
740
741
742
743
744
745
746
747
748
749
750
        message = 'Completed: ' + str(self.action) + ' ' + str(self.key) + ' '+ str(self.site)

        from .frontend.views import user_state_dict
        content = {
            'user_state': user_state_dict(self.user),
            'message': message,
        }
        RabbitMQInstance.load().publish_to_webpage(
            self.user,
            content,
        )

751
752
753

class DeploymentTaskItem(models.Model):
    task = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
754
755
756
757
        DeploymentTask,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
758
    site = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
759
760
761
762
        Site,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
763

Lukas Burgey's avatar
Lukas Burgey committed
764
    def __str__(self):
765
        return "{}@{}#{}".format(
Lukas Burgey's avatar
Lukas Burgey committed
766
767
            self.task,
            self.site,
768
            self.id,
Lukas Burgey's avatar
Lukas Burgey committed
769
        )
770

Lukas Burgey's avatar
Lukas Burgey committed
771
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
772
        return '[DeploymentTaskItem:{}] {}'.format(self, msg)
773

Lukas Burgey's avatar
Lukas Burgey committed
774

775
776
777
#
# RECEIVERS
#
Lukas Burgey's avatar
Lukas Burgey committed
778

779
780
781
782
783
@receiver(post_save, sender=User)
def deactivate_user(sender, instance=None, created=False, **kwargs):
    if created:
        return

784
    if not instance.is_active and instance.is_active_at_clients:
785
786
787
788
789
790
791
792
        instance.deactivate()


@receiver(post_save, sender=User)
def activate_user(sender, instance=None, created=False, **kwargs):
    if created:
        return

793
    if instance.is_active and not instance.is_active_at_clients:
794
        instance.activate()