models.py 22.5 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
    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
105
        #LOGGER.debug('Opening new BlockingConnection')
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
        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

    def _publish(self, exchange, routing_key, body):
        channel = self._channel
144
        channel.basic_publish(
145
146
147
148
149
150
            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
            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:
249
            username = sub
Lukas Burgey's avatar
Lukas Burgey committed
250
251
        else:
            username = userinfo['email']
252
            email = userinfo['email']
Lukas Burgey's avatar
Lukas Burgey committed
253
254
255
256
257

        user = cls(
            user_type='oidcuser',
            username=username,
            sub=sub,
258
            email=email,
Lukas Burgey's avatar
Lukas Burgey committed
259
260
261
262
            idp=idp,
            userinfo=userinfo,
        )
        user.save()
Lukas Burgey's avatar
Lukas Burgey committed
263
264
265
266
267
268

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

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

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

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

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

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

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

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

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

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

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

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

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

Lukas Burgey's avatar
Lukas Burgey committed
352

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

    def __str__(self):
        return self.name

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

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

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

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

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


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

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

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

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

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

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

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

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


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

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

    # 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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Lukas Burgey's avatar
Lukas Burgey committed
635
636
637
638
639
640
641
642
643
644
645
    @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,
646
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
647
648
649
650
651
652
653
654
655
        )
        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
656
                user=deployment.user
Lukas Burgey's avatar
Lukas Burgey committed
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
            )
            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,
674
            user=deployment.user,
Lukas Burgey's avatar
Lukas Burgey committed
675
676
677
678
679
680
681
682
683
        )
        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
684
                user=deployment.user
Lukas Burgey's avatar
Lukas Burgey committed
685
686
687
688
689
690
            )
            deploy.save()
            LOGGER.debug(deploy.msg('generated'))

        return task

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

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

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

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

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

717
718
719
720
721
722
723
724
725
726
727
    # update the state of the remote webpage
    def send_state_update(self):
        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
    # the client acked the receipt and execution of the task for his site
    def item_finished(self, site):
730

Lukas Burgey's avatar
Lukas Burgey committed
731
        item = self.task_items.get(site=site)
732
        # LOGGER.debug(item.msg('done'))
Lukas Burgey's avatar
Lukas Burgey committed
733
        item.delete()
734
735

        if not self.task_items.exists():
736
            # finished sends its own message
Lukas Burgey's avatar
Lukas Burgey committed
737
            self._finished()
738
        else:
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
            self.send_state_update()

    # the client failed to execute the item
    # the client can try again later
    # we signal the user about the failure
    def item_failed(self, site):
        item = self.task_items.get(site=site)
        item.state = 'failed'
        item.save()

        self.send_state_update()

        # TODO implement

    # the client failed to execute the item
    # the client needs additional information from the user to try again
    # we have to ask the user for data
    def item_rejected(self, site):
        item = self.task_items.get(site=site)
        item.state = 'rejected'
        item.save()

        self.send_state_update()

        # TODO implement
764
765

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

Lukas Burgey's avatar
Lukas Burgey committed
769
        self.delete()
770
771
772
773
774

        # 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
775
776
777
778
779
        message = 'Completed: {} {} @ {}'.format(
            self.action,
            self.key,
            self.service,
        )
780
781
782
783
784
785
786
787
788
789
790

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

791
792
793

class DeploymentTaskItem(models.Model):
    task = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
794
795
796
797
        DeploymentTask,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
798
    site = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
799
800
801
802
        Site,
        related_name='task_items',
        on_delete=models.CASCADE,
    )
Lukas Burgey's avatar
Lukas Burgey committed
803
804
805
806
807
    user = models.ForeignKey(
        User,
        related_name='deployment_task_items',
        on_delete=models.CASCADE,
    )
808
809
810
811
812
813
814
815
816
817
818
819
    STATE_CHOICES = (
        ('pending', 'Pending'),
        ('done', 'Done'),
        ('chanceled', 'Chanceled'),
        ('failed', 'Failed'),
        ('rejected', 'Rejected'),
    )
    state = models.CharField(
        max_length=20,
        choices=STATE_CHOICES,
        default='pending',
    )
Lukas Burgey's avatar
Lukas Burgey committed
820
821
822
823
824
825
826
827
828
829
830
831

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

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

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

Lukas Burgey's avatar
Lukas Burgey committed
833
    def __str__(self):
834
        return "{}@{}#{}".format(
Lukas Burgey's avatar
Lukas Burgey committed
835
836
            self.task,
            self.site,
837
            self.id,
Lukas Burgey's avatar
Lukas Burgey committed
838
        )
839

Lukas Burgey's avatar
Lukas Burgey committed
840
    def msg(self, msg):
Lukas Burgey's avatar
Lukas Burgey committed
841
        return '[DeploymentTaskItem:{}] {}'.format(self, msg)
842

Lukas Burgey's avatar
Lukas Burgey committed
843

844
845
846
#
# RECEIVERS
#
Lukas Burgey's avatar
Lukas Burgey committed
847

848
849
850
851
852
@receiver(post_save, sender=User)
def deactivate_user(sender, instance=None, created=False, **kwargs):
    if created:
        return

853
    if not instance.is_active and instance.is_active_at_clients:
854
855
856
857
858
859
860
861
        instance.deactivate()


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

862
    if instance.is_active and not instance.is_active_at_clients:
863
        instance.activate()