models.py 7.39 KB
Newer Older
Lukas Burgey's avatar
Lukas Burgey committed
1
2
from django.contrib.auth.models import AbstractUser, Group
from django.db import models
3
from django.conf import settings
4
from django.dispatch import receiver, Signal
Lukas Burgey's avatar
Lukas Burgey committed
5
from django.utils.timezone import make_aware
6
from rest_framework.authtoken.models import Token
7
from django.db.models.signals import post_save, pre_delete
Lukas Burgey's avatar
Lukas Burgey committed
8
# from django.db.models.signals import m2m_changed
Lukas Burgey's avatar
Lukas Burgey committed
9
from datetime import datetime
Lukas Burgey's avatar
Lukas Burgey committed
10

Lukas Burgey's avatar
Lukas Burgey committed
11
from .rabbitmq import RabbitMQInstance
12

13
14
deployment_change = Signal(providing_args=['instance'])

Lukas Burgey's avatar
Lukas Burgey committed
15
16

class User(AbstractUser):
17
18
19
20
21
22
23
24
25
26
    TYPE_CHOICES = (
            ('apiclient', 'API-Client'),
            ('oidcuser', 'OIDC User'),
            ('admin', 'Admin'),
            )
    user_type = models.CharField(
            max_length=20,
            choices=TYPE_CHOICES,
            default='oidcuser',
            )
Lukas Burgey's avatar
Lukas Burgey committed
27
28
29
    sub = models.CharField(max_length=150, blank=True, null=True)
    password = models.CharField(max_length=150, blank=True, null=True)

Lukas Burgey's avatar
Lukas Burgey committed
30
31
32
33
34
35
    # we hide deleted keys here
    # the full list of ssh keys is at self._ssh_keys
    @property
    def ssh_keys(self):
        return self._ssh_keys.filter(deleted=False)

Lukas Burgey's avatar
Lukas Burgey committed
36

37
38
@receiver(post_save, sender=settings.AUTH_USER_MODEL)
def create_auth_token(sender, instance=None, created=False, **kwargs):
39
40
    if instance.user_type == 'apiclient' and created:
        Token.objects.create(user=instance)
41
42


Lukas Burgey's avatar
Lukas Burgey committed
43
44
45
46
47
48
49
50
51
52
53
54
def construct_user(user_info):
    return User(
            sub=user_info['sub'],
            name=user_info['name'],
            first_name=user_info['given_name'],
            last_name=user_info['family_name'],
            email=user_info['email'],
            username=user_info['email'],
            )


class Site(models.Model):
55
56
57
    client = models.OneToOneField(
            User,
            related_name='site',
58
            )
Lukas Burgey's avatar
Lukas Burgey committed
59
60
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
61
62
63
    last_fetch = models.DateTimeField(
            default=make_aware(datetime.utcfromtimestamp(0)),
            editable=False)
Lukas Burgey's avatar
Lukas Burgey committed
64
65
66
67

    def __str__(self):
        return self.name

Lukas Burgey's avatar
Lukas Burgey committed
68
    def client_updated(self):
69
        print("Client of site {} got updated".format(self.name))
Lukas Burgey's avatar
Lukas Burgey committed
70
71
72
        self.last_fetch = make_aware(datetime.now())
        self.save()

73
    def clientapi_get_deployments(self, all=False):
74
75
76
77
78
79
80
81
82
83
84
85
86
87
        def service_deployments(service):
            if all:
                ds = (
                    service.deployments
                    # only oidcuser are supposed to have deployments
                    .filter(user__user_type='oidcuser')
                    )
            else:
                ds = (
                    service.deployments
                    # only oidcuser are supposed to have deployments
                    .filter(user__user_type='oidcuser')
                    .filter(last_change__gte=self.last_fetch)
                    )
88

Lukas Burgey's avatar
Lukas Burgey committed
89
            for deployment in ds:
90
                # TODO replace this optimism with an acknowledgement
Lukas Burgey's avatar
Lukas Burgey committed
91
                deployment.client_updated()
92

93
            return ds
Lukas Burgey's avatar
Lukas Burgey committed
94

95
96
97
98
99
100
101
102
103
        deployments = {service.name: service_deployments(service)
                       for service
                       in self.services.all()}

        # TODO we expect the client to get the update here
        self.client_updated()

        # deployments of the services of this site
        return deployments
Lukas Burgey's avatar
Lukas Burgey committed
104

Lukas Burgey's avatar
Lukas Burgey committed
105

106
@receiver(post_save, sender=Site)
Lukas Burgey's avatar
Lukas Burgey committed
107
108
def register_at_rabbitmq(
        sender, instance=None, created=False, **kwargs):
109
110
111
    if not created:
        return

Lukas Burgey's avatar
Lukas Burgey committed
112
    RabbitMQInstance().register_site(instance)
113
114


115
116
117
118
119
120
121
@receiver(pre_delete, sender=Site)
def deregister_at_rabbitmq(
        sender, instance=None, **kwargs):

    RabbitMQInstance().deregister_site(instance)


Lukas Burgey's avatar
Lukas Burgey committed
122
123
124
125
class Service(models.Model):
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
    site = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
126
127
            Site,
            related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
128
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
129
130
131
            Group,
            related_name='services',
            blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
132
133
134
135
136
137
138
139

    def __str__(self):
        return self.name + '@' + self.site.name


class SSHPublicKey(models.Model):
    name = models.CharField(max_length=150, unique=True)
    key = models.TextField(max_length=1000)
Lukas Burgey's avatar
Lukas Burgey committed
140
    # hidden field at the user
Lukas Burgey's avatar
Lukas Burgey committed
141
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
142
            User,
Lukas Burgey's avatar
Lukas Burgey committed
143
            related_name='_ssh_keys')
Lukas Burgey's avatar
Lukas Burgey committed
144

Lukas Burgey's avatar
Lukas Burgey committed
145
146
147
148
149
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
            default=False,
            editable=False,
            )
150

151
152
153
    # does not directly delete the key if the key is deployed or withdrawn
    # somewhere
    # the receiver 'delete_withdrawn_ssh_key' does the actual deletion
154
    def delete_key(self):
155
156
157
158
159
        if (not self.deployments.exists()
                and not self.withdrawn_deployments.exists()):
            self.delete()
            return

160
161
162
        self.deleted = True
        self.save()

Lukas Burgey's avatar
Lukas Burgey committed
163
        # delete implies withdrawing the key from all clients
164
165
166
        for deployment in self.deployments.all():
            deployment.withdraw_key(self)

Lukas Burgey's avatar
Lukas Burgey committed
167
168
169
170
171
172
173
174
    # when a key is withdrawn by a client we try to finally delete it
    def try_final_deletion(self):
        if (self.deleted
                and not self.deployments.exists()
                and not self.withdrawn_deployments.exists()):
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
175
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
176
177
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
178
179
180
        return self.name


Lukas Burgey's avatar
Lukas Burgey committed
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
class Deployment(models.Model):
    user = models.ForeignKey(
            User,
            related_name='deployments',
            on_delete=models.CASCADE,
            )
    service = models.ForeignKey(
            Service,
            related_name='deployments',
            on_delete=models.CASCADE,
            )
    # SET_NULL: we allow credentials to be deleted after deployment
    ssh_keys = models.ManyToManyField(
            SSHPublicKey,
            related_name='deployments',
            blank=True,
            )
198
199
200
201
202
203
204
205

    # these ssh keys are to be withdrawn by the clients
    ssh_keys_to_withdraw = models.ManyToManyField(
            SSHPublicKey,
            related_name='withdrawn_deployments',
            blank=True,
            )

206
    last_change = models.DateTimeField(
207
208
            editable=False,
            default=make_aware(datetime.utcfromtimestamp(0)),
209
            )
Lukas Burgey's avatar
Lukas Burgey committed
210

Lukas Burgey's avatar
Lukas Burgey committed
211
212
213
    def __str__(self):
        return '{}@{}'.format(self.user, self.service)

214
215
216
217
218
    def changed(self):
        print("Deployment {} changed".format(self))
        self.last_change = make_aware(datetime.now())
        self.save()

219
220
221
222
223
224
225
    def deploy_key(self, key):
        # key state: -> (2.5)
        self.ssh_keys.add(key)

        if key in self.ssh_keys_to_withdraw.all():
            self.ssh_keys_to_withdraw.remove(key)
        self.save()
226
        self.changed()
227
        self.send_change()
228
229
230
231
232
233
234
235

    def withdraw_key(self, key):
        # key state: -> (4)
        self.ssh_keys.remove(key)

        # keys which are to be withdrawn by the clients
        self.ssh_keys_to_withdraw.add(key)
        self.save()
236
        self.changed()
237
        self.send_change()
238

Lukas Burgey's avatar
Lukas Burgey committed
239
240
241
    def client_updated(self):
        withdrawn_keys = list(self.ssh_keys_to_withdraw.all())

242
243
        # the client has withdrawn the keys so we can empty the list
        self.ssh_keys_to_withdraw.clear()
Lukas Burgey's avatar
Lukas Burgey committed
244
245
246
247

        for key in withdrawn_keys:
            key.try_final_deletion()

248
249
        self.save()

250
251
    def send_change(self):
        deployment_change.send(sender=self.__class__, instance=self)