models.py 21.6 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
Lukas Burgey's avatar
Lukas Burgey committed
6

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

Lukas Burgey's avatar
Lukas Burgey committed
17
from .auth.v1.models import OIDCConfig
Lukas Burgey's avatar
Lukas Burgey committed
18

Lukas Burgey's avatar
Lukas Burgey committed
19
LOGGER = logging.getLogger(__name__)
20
21

RABBITMQ_CONNECTION = None
22

Lukas Burgey's avatar
Lukas Burgey committed
23

24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
# 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
48
49
# clients are registerred at rabbitmq, when they are assigned to a site
# (because we only then know what services they provide)
50
class RabbitMQInstance(SingletonModel):
Lukas Burgey's avatar
Lukas Burgey committed
51
    host = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
52
53
54
        max_length=150,
        default='localhost',
    )
Lukas Burgey's avatar
Lukas Burgey committed
55
56
57
58
    vhost = models.CharField(
        max_length=150,
        default='%2f',
    )
Lukas Burgey's avatar
Lukas Burgey committed
59
    exchange = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
60
61
62
        max_length=150,
        default='deployments',
    )
Lukas Burgey's avatar
Lukas Burgey committed
63
    port = models.IntegerField(
Lukas Burgey's avatar
Lukas Burgey committed
64
        default=15672,
Lukas Burgey's avatar
Lukas Burgey committed
65
    )
Lukas Burgey's avatar
Lukas Burgey committed
66
    username = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
67
68
69
        max_length=150,
        default='guest',
    )
Lukas Burgey's avatar
Lukas Burgey committed
70
    password = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
71
72
73
        max_length=150,
        default='guest',
    )
Lukas Burgey's avatar
Lukas Burgey committed
74
75
76
77

    def __str__(self):
        return self.host

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

    @property
    def auth(self):
        return HTTPBasicAuth(
Lukas Burgey's avatar
Lukas Burgey committed
84
            self.username,
Lukas Burgey's avatar
Lukas Burgey committed
85
            self.password,
Lukas Burgey's avatar
Lukas Burgey committed
86
        )
Lukas Burgey's avatar
Lukas Burgey committed
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
128
129
130
    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
131
    @property
132
    def _channel(self):
Lukas Burgey's avatar
Lukas Burgey committed
133
134
135
136
137
138
139
140
        try:
            channel = self._connection.channel()
            channel.confirm_delivery()
            return channel
        except ConnectionClosed as exception:
            LOGGER.error(self.msg('ConnectionClosed: ' + str(exception)))
            self._init_connection()
            return self._channel
141
142
143
144
145
146
147
148
149
150

    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
151
        )
152
        channel.close()
153

154
    # PUBLIC API
155
    def publish_by_service(self, service, msg):
156
157
158
159
160
        self._publish(
            self.exchange,
            service.routing_key,
            msg,
        )
Lukas Burgey's avatar
Lukas Burgey committed
161

162
    def publish_to_webpage(self, user, msg):
163
164
165
166
        LOGGER.debug('Signalling webpage of user %s', user)
        self._publish(
            'update',
            str(user.id),
167
            json.dumps(msg),
168
        )
169

Lukas Burgey's avatar
Lukas Burgey committed
170

171
172
173
174
def user_info_default():
    return {}


Lukas Burgey's avatar
Lukas Burgey committed
175
class User(AbstractUser):
176
    TYPE_CHOICES = (
Lukas Burgey's avatar
Lukas Burgey committed
177
178
179
180
        ('apiclient', 'API-Client'),
        ('oidcuser', 'OIDC User'),
        ('admin', 'Admin'),
    )
181
    user_type = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
182
183
        max_length=20,
        choices=TYPE_CHOICES,
Lukas Burgey's avatar
Lukas Burgey committed
184
        default='apiclient',
Lukas Burgey's avatar
Lukas Burgey committed
185
    )
186
187
188
189
    sub = models.CharField(
        max_length=150,
        blank=True,
        null=True,
190
        editable=False,
191
192
193
194
195
196
197
198
199
200
201
202
    )
    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
203
204
205
206
207
    # the idp which authenticated the user
    idp = models.ForeignKey(
        OIDCConfig,
        related_name='users',
        on_delete=models.CASCADE,
208
209
210
        blank=True,
        null=True,
        editable=False,
Lukas Burgey's avatar
Lukas Burgey committed
211
    )
212
213
214
215
    userinfo = JSONField(
        default=user_info_default,
        null=True,
        blank=True,
216
        editable=False,
217
    )
Lukas Burgey's avatar
Lukas Burgey committed
218

Lukas Burgey's avatar
Lukas Burgey committed
219
220
221
222
    # returns the user as identified by userinfo and idp
    # if the user does not exists
    @classmethod
    def get_user(cls, userinfo, idp):
Lukas Burgey's avatar
Lukas Burgey committed
223
        if 'sub' not in userinfo:
Lukas Burgey's avatar
Lukas Burgey committed
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
257
258
259
260
261
262
263
            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
264
265
266
267
268
269

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

Lukas Burgey's avatar
Lukas Burgey committed
270
271
272
273
274
275
276
277
278
279
280
281
        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
282
    # we hide deleted keys here
283
    # the full list of ssh keys is self._ssh_keys
Lukas Burgey's avatar
Lukas Burgey committed
284
285
286
287
    @property
    def ssh_keys(self):
        return self._ssh_keys.filter(deleted=False)

288
289
290
291
    @property
    def is_active_at_clients(self):
        return self._is_active

292
293
294
    def __str__(self):
        if self.user_type == 'admin':
            return 'ADMIN {}'.format(self.username)
Lukas Burgey's avatar
Lukas Burgey committed
295
        elif self.user_type == 'oidcuser':
296
297
298
            if not self.is_active:
                return 'DEACTIVATED USER {}'.format(self.username)
            return 'USER {}'.format(self.username)
Lukas Burgey's avatar
Lukas Burgey committed
299
        elif self.user_type == 'apiclient':
300
301
302
303
304
            try:
                return 'APICLIENT {}@{}'.format(self.username, self.site)
            except:
                return 'APICLIENT {}'.format(self.username)

Lukas Burgey's avatar
Lukas Burgey committed
305
306
        else:
            raise Exception()
Lukas Burgey's avatar
Lukas Burgey committed
307

Lukas Burgey's avatar
Lukas Burgey committed
308
    def msg(self, msg):
309
310
311
312
313
314
315
        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
316
            # FIXME: deleting the user brings problems:
317
318
            # 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
319
            LOGGER.info(self.msg('Deleting'))
320
321
322
            self.delete()

    def activate(self):
323
        if self._is_active:
Lukas Burgey's avatar
Lukas Burgey committed
324
            LOGGER.error(self.msg('already activated'))
325
326
            return

Lukas Burgey's avatar
Lukas Burgey committed
327
328
329
330
        self.is_active = True
        self._is_active = True
        self.save()
        LOGGER.info(self.msg('activated'))
331

Lukas Burgey's avatar
Lukas Burgey committed
332
333
        # oidcuser: deploy the according credentials
        if self.user_type == 'oidcuser':
334
335
336
337
            for dep in self.deployments.all():
                dep.activate()

    def deactivate(self):
338
        if not self._is_active:
Lukas Burgey's avatar
Lukas Burgey committed
339
            LOGGER.error(self.msg('already deactivated'))
340
341
            return

Lukas Burgey's avatar
Lukas Burgey committed
342
343
344
345
346
347
        self.is_active = False
        self._is_active = False
        self.save()
        LOGGER.info(self.msg('deactivated'))

        # oidcuser: withdraw all credentials
348
349
350
351
352
        if self.user_type == 'oidcuser':

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

Lukas Burgey's avatar
Lukas Burgey committed
353

Lukas Burgey's avatar
Lukas Burgey committed
354
355
356
357
358
359
360
361
362
363
364
365
# 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
366
class Site(models.Model):
367
    client = models.OneToOneField(
Lukas Burgey's avatar
Lukas Burgey committed
368
369
        User,
        related_name='site',
370
371
372
373
374
375
376
377
378
379
380
        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
381
    )
Lukas Burgey's avatar
Lukas Burgey committed
382
383
384
385

    def __str__(self):
        return self.name

386
387
388
389
390
391
    # 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
392

Lukas Burgey's avatar
Lukas Burgey committed
393
394
395
396

class Service(models.Model):
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
397
    site = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
398
399
        Site,
        related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
400
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
401
402
403
        Group,
        related_name='services',
        blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
404

405
406
407
408
    @property
    def routing_key(self):
        return 'service.{}'.format(self.name)

Lukas Burgey's avatar
Lukas Burgey committed
409
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
410
        return self.name
Lukas Burgey's avatar
Lukas Burgey committed
411
412
413


class SSHPublicKey(models.Model):
Lukas Burgey's avatar
Lukas Burgey committed
414
415
416
417
418
419
    name = models.CharField(
        max_length=150,
    )
    key = models.TextField(
        max_length=1000
    )
Lukas Burgey's avatar
Lukas Burgey committed
420
    # hidden field at the user
421
    # TODO checks: if the user is null
Lukas Burgey's avatar
Lukas Burgey committed
422
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
423
424
        User,
        related_name='_ssh_keys',
425
426
        on_delete=models.SET_NULL,
        null=True,
Lukas Burgey's avatar
Lukas Burgey committed
427
    )
Lukas Burgey's avatar
Lukas Burgey committed
428

Lukas Burgey's avatar
Lukas Burgey committed
429
430
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
Lukas Burgey's avatar
Lukas Burgey committed
431
432
433
        default=False,
        editable=False,
    )
434

Lukas Burgey's avatar
Lukas Burgey committed
435
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
436
        return '[SSHPublicKey:{}] {}'.format(self, msg)
437

438
439
440
    # does not directly delete the key if the key is deployed or withdrawn
    # somewhere
    # the receiver 'delete_withdrawn_ssh_key' does the actual deletion
441
    def delete_key(self):
Lukas Burgey's avatar
Lukas Burgey committed
442
        if (not self.tasks.exists() and not self.deployments.exists()):
Lukas Burgey's avatar
Lukas Burgey committed
443
            LOGGER.info(self.msg('Direct deletion of key'))
444
445
446
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
447
        LOGGER.info(self.msg('Deletion of key started'))
448
449
450
        self.deleted = True
        self.save()

Lukas Burgey's avatar
Lukas Burgey committed
451
        # delete implies withdrawing the key from all clients
452
453
454
        for deployment in self.deployments.all():
            deployment.withdraw_key(self)

Lukas Burgey's avatar
Lukas Burgey committed
455
456
    # 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
457
        if (self.deleted and not self.tasks.exists()):
Lukas Burgey's avatar
Lukas Burgey committed
458
            LOGGER.info(self.msg(
Lukas Burgey's avatar
Lukas Burgey committed
459
                'All clients have withdrawn this key. Final deletion'))
Lukas Burgey's avatar
Lukas Burgey committed
460
461
462
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
463
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
464
465
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
466
467
468
        return self.name


469
# Deployment describes the credential state per user as it is supposed to be
470
471
472
473
#
# (exception: if is_active=False the ssh_keys contain the keys to be deployed
# if the deployment is reactivated)
#
474
475
# 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
476
477
class Deployment(models.Model):
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
478
479
480
481
        User,
        related_name='deployments',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
482
    service = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
483
484
485
486
        Service,
        related_name='deployments',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
487
    ssh_keys = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
488
489
490
491
        SSHPublicKey,
        related_name='deployments',
        blank=True,
    )
492
    ssh_keys_to_withdraw = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
493
494
495
496
        SSHPublicKey,
        related_name='withdrawn_deployments',
        blank=True,
    )
497
    is_active = models.BooleanField(
Lukas Burgey's avatar
Lukas Burgey committed
498
499
        default=True,
    )
500

Lukas Burgey's avatar
Lukas Burgey committed
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521

    # 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


522
523
524
    @property
    def withdrawals(self):
        return self.tasks.filter(action='withdraw')
Lukas Burgey's avatar
Lukas Burgey committed
525

526
527
528
    @property
    def deploys(self):
        return self.tasks.filter(action='deploy')
Lukas Burgey's avatar
Lukas Burgey committed
529

530
531
    def __str__(self):
        return '{}:{}'.format(self.service, self.user)
532

Lukas Burgey's avatar
Lukas Burgey committed
533
    def msg(self, msg):
534
        return '[Deployment:{}] {}'.format(self, msg)
535

536
537
538
    # deploy credentials which were deployed prior to deactivation
    def activate(self):
        if self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
539
            LOGGER.error(self.msg('already active'))
540
541
            return

Lukas Burgey's avatar
Lukas Burgey committed
542
        LOGGER.debug(self.msg(str(self.ssh_keys.all())))
543
544
545
546
547
        for key in self.ssh_keys.all():
            self._deploy_key(key)

        self.is_active = True
        self.save()
Lukas Burgey's avatar
Lukas Burgey committed
548
        LOGGER.info(self.msg('activated'))
549
550
551
552

    # withdraw all credentials
    def deactivate(self):
        if not self.is_active:
Lukas Burgey's avatar
Lukas Burgey committed
553
            LOGGER.error(self.msg('already deactivated'))
554
555
556
            return

        self.is_active = False
557
        self.save()
558

559
560
561
        for key in self.ssh_keys.all():
            self._withdraw_key(key)

Lukas Burgey's avatar
Lukas Burgey committed
562
        LOGGER.info(self.msg('deactivated'))
563
564
565

    # only deploy the key
    def _deploy_key(self, key):
Lukas Burgey's avatar
Lukas Burgey committed
566
        task = DeploymentTask.construct_deployment_task(
Lukas Burgey's avatar
Lukas Burgey committed
567
568
569
            deployment=self,
            key=key,
        )
570
571
        # publish the task
        task.publish()
572

573
    def _withdraw_key(self, key):
Lukas Burgey's avatar
Lukas Burgey committed
574
        task = DeploymentTask.construct_withdrawal_task(
Lukas Burgey's avatar
Lukas Burgey committed
575
576
577
            deployment=self,
            key=key,
        )
578

579
580
        # publish the task
        task.publish()
Lukas Burgey's avatar
Lukas Burgey committed
581

582
583
584
    # 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
585
            LOGGER.error(self.msg('cannot deploy while deactivated'))
586
587
588
589
590
591
592
593
594
595
596
597
598
            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
599
            LOGGER.error(self.msg('cannot withdraw while deactivated'))
600
601
602
603
604
605
606
607
608
609
            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
610

611
612
class DeploymentTask(models.Model):
    ACTION_CHOICES = (
Lukas Burgey's avatar
Lukas Burgey committed
613
614
615
        ('deploy', 'deploy'),
        ('withdraw', 'withdraw'),
    )
616
    action = models.CharField(
Lukas Burgey's avatar
Lukas Burgey committed
617
618
619
        max_length=10,
        choices=ACTION_CHOICES,
    )
620
    key = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
621
622
623
624
        SSHPublicKey,
        related_name='tasks',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
625
    deployment = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
626
627
628
629
        Deployment,
        related_name='tasks',
        on_delete=models.CASCADE,
    )
630
631
632
633
634
    user = models.ForeignKey(
        User,
        related_name='deployment_tasks',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
635

Lukas Burgey's avatar
Lukas Burgey committed
636
637
638
639
640
641
642
643
644
645
646
    @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,
647
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
648
649
650
651
652
653
654
655
656
        )
        task.save()
        LOGGER.debug(task.msg('generated'))

        # generate task items
        for site in deployment.service.site.all():
            deploy = DeploymentTaskItem(
                task=task,
                site=site,
Lukas Burgey's avatar
Lukas Burgey committed
657
                user=deployment.user
Lukas Burgey's avatar
Lukas Burgey committed
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
            )
            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,
675
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
676
677
678
679
680
681
682
683
684
        )
        task.save()
        LOGGER.debug(task.msg('generated'))

        # generate task items
        for site in deployment.service.site.all():
            deploy = DeploymentTaskItem(
                task=task,
                site=site,
Lukas Burgey's avatar
Lukas Burgey committed
685
                user=deployment.user
Lukas Burgey's avatar
Lukas Burgey committed
686
687
688
689
690
691
            )
            deploy.save()
            LOGGER.debug(deploy.msg('generated'))

        return task

Lukas Burgey's avatar
Lukas Burgey committed
692
693
694
695
    @property
    def service(self):
        return self.deployment.service

696
    def __str__(self):
697
        return "{}:{}:{} - {}#{}".format(
Lukas Burgey's avatar
Lukas Burgey committed
698
699
700
701
            self.deployment.service,
            self.deployment.user,
            self.key,
            self.action,
702
            self.id,
Lukas Burgey's avatar
Lukas Burgey committed
703
        )
704

Lukas Burgey's avatar
Lukas Burgey committed
705
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
706
        return '[DeploymentTask:{}] {}'.format(self, msg)
707
708

    def publish(self):
Lukas Burgey's avatar
Lukas Burgey committed
709
        # mitigating circular dependencies here
710
711
712
        from .clientapi.serializers import DeploymentTaskSerializer
        msg = json.dumps(DeploymentTaskSerializer(self).data)

713
        RabbitMQInstance.load().publish_by_service(
Lukas Burgey's avatar
Lukas Burgey committed
714
715
716
            self.service,
            msg,
        )
717
718
719

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

Lukas Burgey's avatar
Lukas Burgey committed
721
        item = self.task_items.get(site=site)
722
        # LOGGER.debug(item.msg('done'))
Lukas Burgey's avatar
Lukas Burgey committed
723
        item.delete()
724
725

        if not self.task_items.exists():
726
            # finished sends its own message
Lukas Burgey's avatar
Lukas Burgey committed
727
            self._finished()
728
729
730
731
732
733
734
735
736
        else:
            from .frontend.views import user_state_dict
            content = {
                'user_state': user_state_dict(self.user),
            }
            RabbitMQInstance.load().publish_to_webpage(
                self.user,
                content,
            )
737
738

    # maintenance after all task items are done
Lukas Burgey's avatar
Lukas Burgey committed
739
    def _finished(self):
Lukas Burgey's avatar
Lukas Burgey committed
740
        LOGGER.info(self.msg('done'))
741

Lukas Burgey's avatar
Lukas Burgey committed
742
        self.delete()
743
744
745
746
747

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

Lukas Burgey's avatar
Lukas Burgey committed
748
749
750
751
752
        message = 'Completed: {} {} @ {}'.format(
            self.action,
            self.key,
            self.service,
        )
753
754
755
756
757
758
759
760
761
762
763

        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,
        )

764
765
766

class DeploymentTaskItem(models.Model):
    task = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
767
768
769
770
        DeploymentTask,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
771
    site = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
772
773
774
775
        Site,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
    user = models.ForeignKey(
        User,
        related_name='deployment_task_items',
        on_delete=models.CASCADE,
    )

    @property
    def service(self):
        return self.task.service

    @property
    def key(self):
        return self.task.key

    @property
    def action(self):
        return self.deployment.key
793

Lukas Burgey's avatar
Lukas Burgey committed
794
    def __str__(self):
795
        return "{}@{}#{}".format(
Lukas Burgey's avatar
Lukas Burgey committed
796
797
            self.task,
            self.site,
798
            self.id,
Lukas Burgey's avatar
Lukas Burgey committed
799
        )
800

Lukas Burgey's avatar
Lukas Burgey committed
801
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
802
        return '[DeploymentTaskItem:{}] {}'.format(self, msg)
803

Lukas Burgey's avatar
Lukas Burgey committed
804

805
806
807
#
# RECEIVERS
#
Lukas Burgey's avatar
Lukas Burgey committed
808

809
810
811
812
813
@receiver(post_save, sender=User)
def deactivate_user(sender, instance=None, created=False, **kwargs):
    if created:
        return

814
    if not instance.is_active and instance.is_active_at_clients:
815
816
817
818
819
820
821
822
        instance.deactivate()


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

823
    if instance.is_active and not instance.is_active_at_clients:
824
        instance.activate()