Blame view

src/core/pyros_django/common/models.py 97.3 KB
5ce2836f   Alexis Koralewski   update models (ad...
1
2
##from __future__ import unicode_literals

7735aaa7   Etienne Pallier   updated Agent spe...
3
4
5
# (EP 21/9/22) To allow autoreferencing (ex: AgentCmd.create() returns a AgentCmd)
from __future__ import annotations

5ce2836f   Alexis Koralewski   update models (ad...
6
# Stdlib imports
7138789e   Etienne Pallier   new Agent with 3 ...
7
from numpy import False_
1ba49504   Alexis Koralewski   fixing CSS and JS...
8
from src.device_controller.abstract_component.device_controller import DeviceCmd
5ce2836f   Alexis Koralewski   update models (ad...
9
10
11
12
13
from enum import Enum
from datetime import datetime, timedelta, date
from dateutil.relativedelta import relativedelta
import os
import sys
1f638223   Etienne Pallier   Ameliorations Age...
14
from typing import Any, List, Tuple
5ce2836f   Alexis Koralewski   update models (ad...
15
16
17
from django.core.validators import MaxValueValidator, MinValueValidator

# DJANGO imports
a6e63604   Alexis Koralewski   adding agentSP an...
18
from django.contrib.auth.models import AbstractUser, UserManager
5ce2836f   Alexis Koralewski   update models (ad...
19
20
21
22
23
from django.db import models
from django.db.models import Q, Max
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db.models.deletion import DO_NOTHING
from django.db.models.expressions import F
5a434264   Alexis Koralewski   New version of Sc...
24
from django.db.models.query import QuerySet
5ce2836f   Alexis Koralewski   update models (ad...
25
26
27
28
29
from model_utils import Choices
from django.utils import timezone
# Project imports
# DeviceCommand is used by class Command
sys.path.append("../../..")
5ce2836f   Alexis Koralewski   update models (ad...
30
31
32
33
34
35
36
37
38
39
40
41
42
43

''' 
NOT USED - to be removed
class PyrosState(Enum):
    START = 'Starting'
    PA = 'Passive'
    INI = "INIT"
    STAND = "Standby"
    SCHED_START = 'Scheduler startup'
    SCHED = 'Scheduler'
    SCHED_CLOSE = 'Scheduler closing'
'''


5ce2836f   Alexis Koralewski   update models (ad...
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
"""
STYLE RULES
===========
https://simpleisbetterthancomplex.com/tips/2018/02/10/django-tip-22-designing-better-models.html
https://steelkiwi.com/blog/best-practices-working-django-models-python/

- Model name => singular
    Call it Company instead of Companies. 
    A model definition is the representation of a single object (the object in this example is a company), 
    and not a collection of companies
    The model definition is a class, so always use CapWords convention (no underscores)
    E.g. User, Permission, ContentType, etc.

- For the model’s attributes use snake_case.
    E.g. first_name, last_name, etc

- Blank and Null Fields (https://simpleisbetterthancomplex.com/tips/2016/07/25/django-tip-8-blank-or-null.html)
    - Null: It is database-related. Defines if a given database column will accept null values or not.
    - Blank: It is validation-related. It will be used during forms validation, when calling form.is_valid().
    Do not use null=True for text-based fields that are optional.
    Otherwise, you will end up having two possible values for “no data”, that is: None and an empty string.
    Having two possible values for “no data” is redundant.
    The Django convention is to use the empty string, not NULL.
    Example:
        # The default values of `null` and `blank` are `False`.
        class Person(models.Model):
            name = models.CharField(max_length=255)  # Mandatory
            bio = models.TextField(max_length=500, blank=True)  # Optional (don't put null=True)
            birth_date = models.DateField(null=True, blank=True) # Optional (here you may add null=True)
    The default values of null and blank are False.
    Special case, when you need to accept NULL values for a BooleanField, use NullBooleanField instead.

- Choices : you can use Choices from the model_utils library. Take model Article, for instance:
    from model_utils import Choices
    class Article(models.Model):
        STATUSES = Choices(
            (0, 'draft', _('draft')),
            (1, 'published', _('published'))   )
        status = models.IntegerField(choices=STATUSES, default=STATUSES.draft)

- Reverse Relationships

    - related_name :
    Rule of thumb: if you are not sure what would be the related_name, 
    use the plural of the model holding the ForeignKey.
    ex:
        class Company:
            name = models.CharField(max_length=30)
        class Employee:
            first_name = models.CharField(max_length=30)
            last_name = models.CharField(max_length=30)
            company = models.ForeignKey(Company, on_delete=models.CASCADE, related_name='employees')
    usage:
        google = Company.objects.get(name='Google')
        google.employees.all()
        You can also use the reverse relationship to modify the company field on the Employee instances:
        vitor = Employee.objects.get(first_name='Vitor')
        google = Company.objects.get(name='Google')
        google.employees.add(vitor)

    - related_query_name :
        This kind of relationship also applies to query filters. 
        For example, if I wanted to list all companies that employs people named ‘Vitor’, I could do the following:
        companies = Company.objects.filter(employee__first_name='Vitor')
        If you want to customize the name of this relationship, here is how we do it:
            class Employee:
                first_name = models.CharField(max_length=30)
                last_name = models.CharField(max_length=30)
                company = models.ForeignKey(
                    Company,
                    on_delete=models.CASCADE,
                    related_name='employees',
                    related_query_name='person'
                )
        Then the usage would be:
        companies = Company.objects.filter(person__first_name='Vitor')

    To use it consistently, related_name goes as plural and related_query_name goes as singular.


GENERAL EXAMPLE
=======

from django.db import models
from django.urls import reverse

class Company(models.Model):
    # CHOICES
    PUBLIC_LIMITED_COMPANY = 'PLC'
    PRIVATE_COMPANY_LIMITED = 'LTD'
    LIMITED_LIABILITY_PARTNERSHIP = 'LLP'
    COMPANY_TYPE_CHOICES = (
        (PUBLIC_LIMITED_COMPANY, 'Public limited company'),
        (PRIVATE_COMPANY_LIMITED, 'Private company limited by shares'),
        (LIMITED_LIABILITY_PARTNERSHIP, 'Limited liability partnership'),
    )

    # DATABASE FIELDS
    name = models.CharField('name', max_length=30)
    vat_identification_number = models.CharField('VAT', max_length=20)
    company_type = models.CharField('type', max_length=3, choices=COMPANY_TYPE_CHOICES)

    # MANAGERS
    objects = models.Manager()
    limited_companies = LimitedCompanyManager()

    # META CLASS
    class Meta:
        verbose_name = 'company'
        verbose_name_plural = 'companies'

    # TO STRING METHOD
    def __str__(self):
        return self.name

    # SAVE METHOD
    def save(self, *args, **kwargs):
        do_something()
        super().save(*args, **kwargs)  # Call the "real" save() method.
        do_something_else()

    # ABSOLUTE URL METHOD
    def get_absolute_url(self):
        return reverse('company_details', kwargs={'pk': self.id})

    # OTHER METHODS
    def process_invoices(self):
        do_something()

"""


def printd(*args, **kwargs):
1ba49504   Alexis Koralewski   fixing CSS and JS...
177
178
    if os.environ.get('PYROS_DEBUG', '0') == '1':
        print('(MODEL)', *args, **kwargs)
5ce2836f   Alexis Koralewski   update models (ad...
179
180
181
182

# ---
# --- Utility functions
# ---
1ba49504   Alexis Koralewski   fixing CSS and JS...
183
184
185
186


def get_or_create_unique_row_from_model(model: models.Model):
    # return model.objects.get(id=1) if model.objects.exists() else model.objects.create(id=1)
5ce2836f   Alexis Koralewski   update models (ad...
187
188
189
190
191
192
193
194
195
    return model.objects.first() if model.objects.exists() else model.objects.create(id=1)


"""
------------------------
   BASE MODEL CLASSES
------------------------
"""

1ba49504   Alexis Koralewski   fixing CSS and JS...
196

5ce2836f   Alexis Koralewski   update models (ad...
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
class Device(models.Model):
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    is_online = models.BooleanField(default=False)
    status = models.CharField(max_length=11, blank=True, null=True)
    maintenance_date = models.DateTimeField(blank=True, null=True)

    class Meta:
        abstract = True

    def __str__(self):
        return (str(self.name))

1ba49504   Alexis Koralewski   fixing CSS and JS...
212

5ce2836f   Alexis Koralewski   update models (ad...
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
class Request(models.Model):
    pyros_user = models.ForeignKey(
        'PyrosUser', on_delete=models.DO_NOTHING, related_name="requests")
    scientific_program = models.ForeignKey(
        'ScientificProgram', on_delete=models.DO_NOTHING, related_name="requests", blank=True, null=True)
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    is_alert = models.BooleanField(default=False)
    target_type = models.CharField(max_length=8, blank=True, null=True)
    status = models.CharField(max_length=10, blank=True, null=True)
    autodeposit = models.BooleanField(default=False)
    checkpoint = models.CharField(max_length=45, blank=True, null=True)
    flag = models.CharField(max_length=45, blank=True, null=True)
    complete = models.BooleanField(default=False)
    submitted = models.BooleanField(default=False)

    class Meta:
        managed = True
        db_table = 'request'

    def __str__(self):
        return (str(self.name))


5ce2836f   Alexis Koralewski   update models (ad...
239
240
241
242
243
244
"""
------------------------
   OTHER MODEL CLASSES
------------------------
"""

1ba49504   Alexis Koralewski   fixing CSS and JS...
245
246
247
# TODO: A VIRER car remplacé par AgentDeviceStatus


5ce2836f   Alexis Koralewski   update models (ad...
248
249
class AgentDeviceTelescopeStatus(models.Model):
    #created = models.DateTimeField('status date', blank=True, null=True, auto_now_add=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
250
251
    updated = models.DateTimeField(
        'status date', blank=True, null=True, auto_now=True)
5ce2836f   Alexis Koralewski   update models (ad...
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
    radec = models.CharField('agent mode', max_length=30, blank=True)

    class Meta:
        managed = True
        db_table = 'agent_device_telescope_status'
        #verbose_name = "agent survey"
        #verbose_name_plural = "agents survey"

    """
    def __str__(self):
        return (f"Agent {self.name} at {self.updated} in mode {self.mode} and status {self.status}")
    """


class AgentDeviceStatus(models.Model):
    """Table storing various status parameters for EACH Device.

    Attributes:
        attr1 (str): Description of `attr1`.
        attr2 (:obj:`int`, optional): Description of `attr2`.

    """
    #created = models.DateTimeField('status date', blank=True, null=True, auto_now_add=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
275
276
    agent = models.CharField(
        'Name of the agent that saved this parameter', max_length=45, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
277
    #radec = models.CharField('agent mode', max_length=30, blank=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
278
279
280
281
    status = models.CharField(
        'status parameters json dictionnary (ex: {radec:..., speed:...})', max_length=300, blank=True, null=True)
    date_updated = models.DateTimeField(
        'status parameter date', blank=True, null=True, auto_now=True)
5ce2836f   Alexis Koralewski   update models (ad...
282
283
284
285
286
287
288
289
290
291
292

    class Meta:
        managed = True
        db_table = 'agent_device_status'
        verbose_name = "agent device status"
        verbose_name_plural = "agent devices status"

    def __str__(self):
        return (f"Agent {self.agent} last status is ({self.status}) (saved at {self.date_updated})")

    @classmethod
1ba49504   Alexis Koralewski   fixing CSS and JS...
293
    def getStatusForAgent(cls, agent: str) -> str:
5ce2836f   Alexis Koralewski   update models (ad...
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
        return cls.objects.filter(agent=agent)[0] if cls.objects.filter(agent=agent).exists() else cls.objects.create(agent=agent)
        '''
        return cls.objects.filter(agent=agent)[0].status if cls.objects.filter(agent=agent).exists() else cls.objects.create(agent=agent).status
        agent_status = cls.objects.filter(agent=agent)
        if agent_status.exists(): 
            return agent_status[0].status
        else:
            return cls.objects.create(agent=agent)
        '''


class AgentLogs(models.Model):
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    name = models.CharField(max_length=50)
    message = models.TextField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'agent_logs'

    def __str__(self):
        return (f"{self.created} {self.name} {self.message}")


class AgentSurvey(models.Model):
    """
    | id | name | created | updated | validity_duration (default=1mn) | mode (active/idle) | status (launch/init/loop/exit/...) |
    """

6fbe2e20   Etienne Pallier   last minute.com m...
323
324
325
326
327
328
329
330
    # --- MODES ---
    '''
    In all modes, the Agent listens to commands sent to him and executes Agent level GENERAL ones.
    - MODE_IDLE : "idle" mode, does nothing, only executes Agent level GENERAL commands (DO_RESTART, DO_EXIT, DO_ABORT, DO_FLUSH, SET_ACTIVE, ...)
    - MODE_ROUTINE : idem IDLE + executes routine process (before & after)
    - MODE_ATTENTIVE : idem ROUTINE + executes Agent level SPECIFIC commands (commands specific to this agent, that only this agent understands and can execute)
    Default mode is MODE_ATTENTIVE (most active mode)
    '''
97331a11   Etienne Pallier   Simplification de...
331
332
333
334
    MODE_CHOICES = Choices(
        "IDLE",  
        "ROUTINE",  
        "ATTENTIVE",
6fbe2e20   Etienne Pallier   last minute.com m...
335
336
    )

6fbe2e20   Etienne Pallier   last minute.com m...
337
    # --- STATUSES ---
97331a11   Etienne Pallier   Simplification de...
338
339
340
341
342
343
344
345
346
    ''' Agent steps '''
    STATUS_CHOICES = Choices(
        'LAUNCHED',
        'INITIALIZING',
        'IN_MAIN_LOOP',
        'IN_ROUTINE_BEF',
        'IN_GET_NEXT_CMD',
        'IN_ROUTINE_AFT',
        'EXITING',
340ca843   Etienne Pallier   fixed get_specifi...
347
        'RESTARTING',
6fbe2e20   Etienne Pallier   last minute.com m...
348
    )
5ce2836f   Alexis Koralewski   update models (ad...
349
350
351
352
353
354
355
356

    name = models.CharField(max_length=50, unique=True)
    #name = models.CharField(max_length=50, blank=True, null=True, unique=True)
    #created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    validity_duration = models.PositiveIntegerField(default=90)
    #validity_duration = models.DurationField(default=90)
1ba49504   Alexis Koralewski   fixing CSS and JS...
357
    mode = models.CharField('agent mode', max_length=15,
97331a11   Etienne Pallier   Simplification de...
358
359
360
                            blank=True, choices=MODE_CHOICES,
                            #default = MODE_CHOICES.ATTENTIVE
    )
1ba49504   Alexis Koralewski   fixing CSS and JS...
361
362
    status = models.CharField(
        max_length=15, blank=True, choices=STATUS_CHOICES)
5ce2836f   Alexis Koralewski   update models (ad...
363
    iteration = models.IntegerField(blank=True, null=True)
9bd7ac9e   Alexis Koralewski   Adding timeout co...
364
    nb_restart_max = models.IntegerField(blank=True,null=True,default=3)
6a41fe96   Alexis Koralewski   Add current_nb_re...
365
    current_nb_restart = models.IntegerField(blank=True,null=True,default=0)
5ce2836f   Alexis Koralewski   update models (ad...
366
367
368
369
370
371
372
373
    class Meta:
        managed = True
        db_table = 'agent_survey'
        #verbose_name = "agent survey"
        #verbose_name_plural = "agents survey"

    def __str__(self):
        return (f"Agent {self.name} at {self.updated} in mode {self.mode} and status {self.status}")
8b41b6cc   Etienne Pallier   ajout methodes is...
374
375
376
377
378
379
380
381
382
383

    # Testing agent status    
    def is_launched(self): return self.status == self.STATUS_CHOICES.LAUNCHED
    def is_initializing(self): return self.status == self.STATUS_CHOICES.INITIALIZING
    def is_in_main_loop(self): return self.status == self.STATUS_CHOICES.IN_MAIN_LOOP
    def is_in_routine_bef(self): return self.status == self.STATUS_CHOICES.IN_ROUTINE_BEF
    def is_in_get_next_cmd(self): return self.status == self.STATUS_CHOICES.IN_GET_NEXT_CMD
    def is_in_routine_aft(self): return self.status == self.STATUS_CHOICES.IN_ROUTINE_AFT
    def is_stopping(self): return self.status == self.STATUS_CHOICES.EXITING
    def is_restarting(self): return self.status == self.STATUS_CHOICES.RESTARTING
d4cf685d   Etienne Pallier   ajout methode is_...
384
    def is_stopping_or_restarting(self): return self.is_stopping() or self.is_restarting()
5ce2836f   Alexis Koralewski   update models (ad...
385
386
387
388
389


class Album(models.Model):
    sequence = models.ForeignKey(
        'Sequence', on_delete=models.CASCADE, related_name="albums")
3b81a22b   Alexis Koralewski   Rework on Request...
390
391
    # detector = models.ForeignKey(
    #     'Detector', models.DO_NOTHING, related_name="albums", blank=True, null=True)
0318e3c9   Alexis Koralewski   Add tests for F05...
392
    #name_of_channel = models.CharField(blank=True,null=True,max_length=150)
5ce2836f   Alexis Koralewski   update models (ad...
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    complete = models.BooleanField(default=False)

    class Meta:
        managed = True
        db_table = 'album'
        #verbose_name_plural = "Albums"

    def __str__(self):
        return (str(self.name))


class Alert(Request):
1ba49504   Alexis Koralewski   fixing CSS and JS...
409
410
    request = models.OneToOneField(
        'Request', on_delete=models.CASCADE, default='', parent_link=True)
5ce2836f   Alexis Koralewski   update models (ad...
411
412
413
414
    strategyobs = models.ForeignKey(
        'StrategyObs', models.DO_NOTHING, related_name="alerts", blank=True, null=True)
    voevent_file = models.CharField(max_length=45, blank=True, null=True)
    author = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
415
416
    burst_jd = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
417
418
419
    burst_ra = models.FloatField(max_length=45, blank=True, null=True)
    burst_dec = models.FloatField(max_length=45, blank=True, null=True)
    astro_coord_system = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
420
421
422
423
    jd_send = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
    jd_received = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
    trig_id = models.IntegerField(blank=True, null=True)
    error_radius = models.FloatField(max_length=45, blank=True, null=True)
    defly_not_grb = models.BooleanField(default=False)
    editor = models.CharField(max_length=45, blank=True, null=True)
    soln_status = models.CharField(max_length=45, blank=True, null=True)
    pkt_ser_num = models.IntegerField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'alert'

    def __str__(self):
        return str(self.trig_id)

    def request_name(self):
        return self.__str__()

    request_name.short_description = "Name"


5ce2836f   Alexis Koralewski   update models (ad...
444
class AgentCmd(models.Model):
5ce2836f   Alexis Koralewski   update models (ad...
445
    """
573eeae6   Etienne Pallier   Agent ne depend p...
446
447
448
449
450
451
452
    Command sent to an Agent

    Can be either :
    - an "agent level" (general or specific) command
    OR
    - a "device level" command

5ce2836f   Alexis Koralewski   update models (ad...
453
454
    | id | sender | recipient | name | validity_duration (default=60) | s_deposit_time | r_read_time

6875e6b1   Etienne Pallier   Ajout Sequence st...
455
    See doc/models_Command_state_diag.pu for PlantUML state diagram
5ce2836f   Alexis Koralewski   update models (ad...
456
457
458
459
    """

    # -------------- Command CONSTANTS --------------

1a6fd283   Etienne Pallier   ajout gestion val...
460
    # Command status codes
5ce2836f   Alexis Koralewski   update models (ad...
461
    CMD_STATUS_CODES = Choices(
cbbd0c65   Etienne Pallier   Updated models.Ag...
462
        
1a6fd283   Etienne Pallier   ajout gestion val...
463
464
465
        # Cmd is pending, waiting for execution
        "CMD_PENDING",  

cbbd0c65   Etienne Pallier   Updated models.Ag...
466
467
468
469
470
471
472
473
474
475

        ### 1 - ERRORS BEFORE EVEN BEING RUN ###

        # Cmd is invalid (unknown or bad args)
        "CMD_INVALID",

        # Cmd is not yet implemented (by recipient agent)
        "CMD_UNIMPLEMENTED",

        # Cmd was skipped (not run, because the agent is IDLE (or in a mode which does not allow execution of this command)
1ba49504   Alexis Koralewski   fixing CSS and JS...
476
        "CMD_SKIPPED",
1a6fd283   Etienne Pallier   ajout gestion val...
477
478
479

        # Cmd is out of date (expired)
        # because it has been pending for too long
cbbd0c65   Etienne Pallier   Updated models.Ag...
480
481
482
        #"CMD_OUTOFDATE",
        "CMD_EXPIRED",

1a6fd283   Etienne Pallier   ajout gestion val...
483

cbbd0c65   Etienne Pallier   Updated models.Ag...
484
485
486
487
488
489
490
491
        ### 2 - RUNNING ###
        # Cmd is running (after having been "read")
        "CMD_RUNNING",  


        ### 3 - ERRORS WHILE RUNNING ###

        # - Cmd was run and finished ok 
1a6fd283   Etienne Pallier   ajout gestion val...
492
493
        # ( simulé par un sleep(3) dans AgentX.core_process() )
        "CMD_EXECUTED",
cbbd0c65   Etienne Pallier   Updated models.Ag...
494
495
496
497
498
499
500
501
502
503
504

        # - Cmd was running, but then an error occured
        "CMD_EXEC_ERROR",  

        # - Cmd was running, but took too much time and timeout was reached
        "CMD_EXEC_TIMEOUT",  

        # - Cmd was aborted, killed by another agent
        #"CMD_KILLED",
        "CMD_EXEC_KILLED",

5ce2836f   Alexis Koralewski   update models (ad...
505
    )
f3a4f48f   Etienne Pallier   Agent : nombreux ...
506

0685952d   Etienne Pallier   Implementation pr...
507
508
509
    # Command default validity duration (from sending time) BEFORE execution, before being perempted (in sec)
    # => Each command validity can be set by SENDER when sending command, it will then be managed by RECIPIENT
    # => From the time a command was sent (cmd.s_deposit_time), it is still valid during DEFAULT_VALIDITY_DURATION sec.
1a6fd283   Etienne Pallier   ajout gestion val...
510
511
512
513
514
515
    # => After that, it is considered as "expired" (obsolete) and must be marked as "CMD_OUTOFDATE" and not be executed anymore (and can be purged)
    # => Thus, a command is expired FROM time = s_deposit_time + VALIDITY_DURATION
    # (except if it is RUNNING, i.e. in state CMD_RUNNING)
    DEFAULT_VALIDITY_DURATION = 1 * 3600 # s

    # Command default execution timeout (in sec)
0685952d   Etienne Pallier   Implementation pr...
516
    # => Each command timeout is set by RECIPIENT (in AGENT_SPECIFIC_COMMANDS), and it will be managed by RECIPIENT
1a6fd283   Etienne Pallier   ajout gestion val...
517
518
519
520
521
522
523
524
525
526
527
528
529
    # => Execution of a command MUST NOT last more than EXEC_TIMEOUT seconds (from execution start time cmd.r_start_time)
    # => Otherwise the (recipient) agent executing the command is responsible to abort it and mark it as "CMD_KILLED"
    DEFAULT_EXEC_TIMEOUT = 60 # s

    # -------------- Command FIELDS --------------

    #sender = models.CharField(max_length=50, blank=True, null=True, unique=True)
    # Sender and Recipient agents
    sender = models.CharField(max_length=50, help_text='sender agent name', null=False)
    recipient = models.CharField(max_length=50, help_text='recipient agent name', null=False)
    ##name = models.CharField(max_length=400, help_text='command name', null=False)
    full_name = models.CharField(max_length=400, help_text='command full name (with type and args)', null=False)
    
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
530
    validity_duration = models.PositiveIntegerField('(in sec)', default=DEFAULT_VALIDITY_DURATION)
1a6fd283   Etienne Pallier   ajout gestion val...
531
532
533
534
535
    exec_timeout = models.PositiveIntegerField('(in sec)', default=DEFAULT_EXEC_TIMEOUT)
    
    #state = models.CharField(choices = CMD_STATUS_CODES, default=CMD_STATUS_CODES.CMD_PENDING, max_length=20)
    state = models.CharField(choices=CMD_STATUS_CODES, default=CMD_STATUS_CODES.CMD_PENDING, max_length=20)
    #state = models.IntegerField(choices=CMD_STATUS_CODES, default=RSCODE_PENDING)
cbbd0c65   Etienne Pallier   Updated models.Ag...
536
    
1a6fd283   Etienne Pallier   ajout gestion val...
537
538
539
540
541
542
543
544
545
    # TODO: maybe à mettre au format json (key:value)
    result = models.CharField(max_length=400, blank=True)

    # - on creation: (AUTO) Automatically set at table line creation (line created by the sender)
    s_deposit_time = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    # - on reading:
    r_read_time = models.DateTimeField(null=True)
    # - on launching:
    r_start_time = models.DateTimeField(null=True)
cbbd0c65   Etienne Pallier   Updated models.Ag...
546
547
548
    # - on end (after execution started or not)
    #end_time = models.DateTimeField(null=True)
    r_end_time = models.DateTimeField(null=True)
1a6fd283   Etienne Pallier   ajout gestion val...
549
550
551
552
553
554
555
556
557
558
559
560
561
562

    # Other agent (than sender or recipient) that set this command to KILLED or EXPIRED
    killer_agent_name = models.CharField(max_length=50, help_text='sender agent name', null=True)

    # Intern field, not saved in DB
    _device_command = None

    class Meta:
        managed = True
        db_table = 'command'
        #verbose_name = "agent survey"
        #verbose_name_plural = "agents survey"

    _AGENT_GENERAL_COMMANDS = [
7b4ee4fe   Etienne Pallier   cleanup, mark som...
563
        
573eeae6   Etienne Pallier   Agent ne depend p...
564
        # DO commands
f3a4f48f   Etienne Pallier   Agent : nombreux ...
565
566
        # -----------
        
573eeae6   Etienne Pallier   Agent ne depend p...
567
        # - Evaluate the expression given (ex: do_eval 4+3)
1ba49504   Alexis Koralewski   fixing CSS and JS...
568
        "do_eval",
0685952d   Etienne Pallier   Implementation pr...
569
                
573eeae6   Etienne Pallier   Agent ne depend p...
570
        # GET commands
f3a4f48f   Etienne Pallier   Agent : nombreux ...
571
        # ------------
7b4ee4fe   Etienne Pallier   cleanup, mark som...
572

f3a4f48f   Etienne Pallier   Agent : nombreux ...
573
        # - Get agent current STATE (IN_MAIN_LOOP, ...)
340ca843   Etienne Pallier   fixed get_specifi...
574
        ##"get_current_state",
573eeae6   Etienne Pallier   Agent ne depend p...
575
        "get_state",
f3a4f48f   Etienne Pallier   Agent : nombreux ...
576
577
        
        # - Get agent current MODE (idle, routine, attentive)
f3a4f48f   Etienne Pallier   Agent : nombreux ...
578
579
        "get_mode",
        
573eeae6   Etienne Pallier   Agent ne depend p...
580
        # SET commands
f3a4f48f   Etienne Pallier   Agent : nombreux ...
581
        # -----------
4d01f948   Etienne Pallier   Agent test bugfix...
582
583
584

        # - Set agent current STATE (IN_MAIN_LOOP, ...) => forbidden
        #"set_state",
f3a4f48f   Etienne Pallier   Agent : nombreux ...
585
586
        
        # - Set agent current MODE (idle, routine, attentive)
340ca843   Etienne Pallier   fixed get_specifi...
587
        ##"set_current_mode", # + value to set
f3a4f48f   Etienne Pallier   Agent : nombreux ...
588
589
        "set_mode", # + value to set

1efe537f   Etienne Pallier   ajout des command...
590
591
        
        # -----------
f3a4f48f   Etienne Pallier   Agent : nombreux ...
592
593
594
        # ### (PRIORITY) DO Commands => executed in priority (even if other pending commands exist) ###
        # -----------
        
0685952d   Etienne Pallier   Implementation pr...
595
596
597
598
599
600
601
        # - Finish your current command and then make a normal clean stop
        # ARGS (optional) :
        #   - "asap" (default) (wait for agent to finish its current processing, then exit)
        #   - "now" (abort agent current processing + exit)
        #   - "noprio" (not priority) (priority by default)
        "do_stop",
        # TODO: a virer => do_stop asap
7b4ee4fe   Etienne Pallier   cleanup, mark som...
602
        # @deprecated
0685952d   Etienne Pallier   Implementation pr...
603
604
        "do_exit",
        # TODO: a virer => do_stop now
7b4ee4fe   Etienne Pallier   cleanup, mark som...
605
        # @deprecated
0685952d   Etienne Pallier   Implementation pr...
606
607
608
609
610
611
612
613
614
615
        "do_abort",

        # - 
        # ARGS :
        #   - "stop" : Temporaly stop execution of new commands (let them accumulate)
        #   - "resume" : Resume execution of commands (accumulated since "do_exec_commands stop")
        #   - "noprio" : not priority (by default => priority)        
        "do_exec_commands",

        # - Stop currently running command or/and routine
1efe537f   Etienne Pallier   ajout des command...
616
617
618
        # ARGS :
        #   - "cmd" : stop currently running specific command
        #   - "routine" : stop currently running routine process
0685952d   Etienne Pallier   Implementation pr...
619
        #   - "both" : stop currently running current cmd and routine process
1efe537f   Etienne Pallier   ajout des command...
620
        "do_stop_current", # + arg "cmd" or "routine"
0685952d   Etienne Pallier   Implementation pr...
621
        # TODO: a virer => do_stop_current now
340ca843   Etienne Pallier   fixed get_specifi...
622
        # @deprecated
0685952d   Etienne Pallier   Implementation pr...
623
        "do_abort_current_command",
1efe537f   Etienne Pallier   ajout des command...
624
        
573eeae6   Etienne Pallier   Agent ne depend p...
625
626
        # - Remove all your pending commands
        "do_flush_commands", 
1efe537f   Etienne Pallier   ajout des command...
627
        
1efe537f   Etienne Pallier   ajout des command...
628
629
630
631
        # - Restart your global loop (starting with init())
        # ARGS (optional) :
        #   - "asap" (default) (wait for agent to finish its current processing, then restart loop)
        #   - "now" (abort agent current processing + restart loop)
0685952d   Etienne Pallier   Implementation pr...
632
        #   - "noprio" (not priority, priority by default)
340ca843   Etienne Pallier   fixed get_specifi...
633
634
        "do_restart", # + arg "asap" (default) or "now"
        # @deprecated
1efe537f   Etienne Pallier   ajout des command...
635
        "do_restart_loop", # + arg "asap" (default) or "now"
f3a4f48f   Etienne Pallier   Agent : nombreux ...
636

3ec16e74   Alexis Koralewski   Add flexible form...
637
        "get_specific_cmds",
c655f27d   Alexis Koralewski   fixing agent_deta...
638

5ce2836f   Alexis Koralewski   update models (ad...
639
    ]
f3a4f48f   Etienne Pallier   Agent : nombreux ...
640
641
642
643
644
645

    # Priority commands, executed as soon as in the received commands list (BEFORE any other pending command)
    # NB : must be a subset of _AGENT_GENERAL_COMMANDS
    _AGENT_GENERAL_PRIORITY_COMMANDS = [
        #"do_exit",
        "do_flush_commands", 
0685952d   Etienne Pallier   Implementation pr...
646
        "do_exec_commands"
340ca843   Etienne Pallier   fixed get_specifi...
647
648
649
        
        "do_restart",
        # @deprecated
f3a4f48f   Etienne Pallier   Agent : nombreux ...
650
        "do_restart_loop",
340ca843   Etienne Pallier   fixed get_specifi...
651
        
0685952d   Etienne Pallier   Implementation pr...
652
653
        "do_stop_current",
        "do_stop",
f3a4f48f   Etienne Pallier   Agent : nombreux ...
654
655
    ]

5ce2836f   Alexis Koralewski   update models (ad...
656
657
658
    # -------------- Command CLASS (static) METHODS --------------

    # Avoid to override the Model __init__ method
7735aaa7   Etienne Pallier   updated Agent spe...
659
    # See https://docs.djangoproject.com/en/stable/ref/models/instances/#creating-objects
5ce2836f   Alexis Koralewski   update models (ad...
660
    @classmethod
7735aaa7   Etienne Pallier   updated Agent spe...
661
    def create(cls, agent_from:str, agent_to:str, cmd_name:str, cmd_args:str=None, cmd_validity:int=None) -> AgentCmd :
1a6fd283   Etienne Pallier   ajout gestion val...
662
663
664
        #print(agent_to)
        if '.' in agent_to:
            agent_to, component_name = agent_to.split('.')
5ce2836f   Alexis Koralewski   update models (ad...
665
            cmd_name = component_name+'.'+cmd_name
1ba49504   Alexis Koralewski   fixing CSS and JS...
666
        if cmd_args:
1a6fd283   Etienne Pallier   ajout gestion val...
667
            cmd_name += ' ' + cmd_args
1ba49504   Alexis Koralewski   fixing CSS and JS...
668
        # cls._device_command=DeviceCommand(cmd_name)
1a6fd283   Etienne Pallier   ajout gestion val...
669
        if cmd_validity is None: cmd_validity = cls.DEFAULT_VALIDITY_DURATION
0685952d   Etienne Pallier   Implementation pr...
670
        #if cmd_timeout is None: cmd_timeout = cls.DEFAULT_EXEC_TIMEOUT
5ce2836f   Alexis Koralewski   update models (ad...
671
        return cls(
1a6fd283   Etienne Pallier   ajout gestion val...
672
673
            sender=agent_from,
            recipient=agent_to,
5ce2836f   Alexis Koralewski   update models (ad...
674
            full_name=cmd_name,
1a6fd283   Etienne Pallier   ajout gestion val...
675
            validity_duration=cmd_validity,
0685952d   Etienne Pallier   Implementation pr...
676
            #exec_timeout=cmd_timeout,
5ce2836f   Alexis Koralewski   update models (ad...
677
678
679
680
681
682
683
684
685
        )

    """
    @classmethod
    def send(cls, cmd:Command):
        cls.objects.create(sender=cmd.name, recipient=cmd.recipient, name=cmd.name)
    """

    @classmethod
7735aaa7   Etienne Pallier   updated Agent spe...
686
687
    def send_cmd_from_to(cls, agent_from, agent_to, cmd_name, cmd_args=None, cmd_validity:int=None)->AgentCmd:
        """ Create and send a command, then return it """
1ba49504   Alexis Koralewski   fixing CSS and JS...
688
        # def send(cls, from_agent, to_agent, cmd_name, cmd_args=None):
5ce2836f   Alexis Koralewski   update models (ad...
689
690
691
692
693
694
695
696
        """
        ex: send("AgentA",“AgentB”,"EVAL”,“3+4”)
        """
        '''
        if cmd_args: cmd_name += ' '+cmd_args
        #Command.objects.create(sender=self.name, recipient=r_agent, name=cmd_name)
        cmd = cls(sender=from_agent, recipient=to_agent, name=cmd_name)
        '''
0685952d   Etienne Pallier   Implementation pr...
697
        cmd = cls.create(agent_from, agent_to, cmd_name, cmd_args, cmd_validity)
5ce2836f   Alexis Koralewski   update models (ad...
698
        cmd.send()
1ba49504   Alexis Koralewski   fixing CSS and JS...
699
700
        # cmd.set_as_pending()
        # cmd.save()
5ce2836f   Alexis Koralewski   update models (ad...
701
702
        return cmd

5ce2836f   Alexis Koralewski   update models (ad...
703
    @classmethod
1a6fd283   Etienne Pallier   ajout gestion val...
704
    def max_deposit_date_for_peremption(cls):
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
705
706
        return datetime.utcnow().astimezone() - timedelta(seconds=cls.DEFAULT_VALIDITY_DURATION)
        #return datetime.utcnow().astimezone() - timedelta(hours=cls.DEFAULT_VALIDITY_DURATION)
5ce2836f   Alexis Koralewski   update models (ad...
707
708
709
710
711
712

    @classmethod
    def delete_commands_with_running_status_for_agent(cls, agent_name):
        printd("Delete (false) 'running' commands if exists:")
        running_commands = cls.objects.filter(
            # only commands for agent agent_name
1ba49504   Alexis Koralewski   fixing CSS and JS...
713
            recipient=agent_name,
5ce2836f   Alexis Koralewski   update models (ad...
714
            # only running commands
1ba49504   Alexis Koralewski   fixing CSS and JS...
715
            state=cls.CMD_STATUS_CODES.CMD_RUNNING,
5ce2836f   Alexis Koralewski   update models (ad...
716
            # only not expired commands
1a6fd283   Etienne Pallier   ajout gestion val...
717
            #s_deposit_time__gte = cls.max_deposit_date_for_peremption(),
5ce2836f   Alexis Koralewski   update models (ad...
718
719
720
721
        )
        if running_commands:
            AgentCmd.show_commands(running_commands)
            running_commands.delete()
1ba49504   Alexis Koralewski   fixing CSS and JS...
722
723
        else:
            printd("<None>")
5ce2836f   Alexis Koralewski   update models (ad...
724
725
726
727
728
729
730
731
732
733
734
735

    @classmethod
    def delete_pending_commands_for_agent(cls, agent_name):
        """
        Delete all pending commands sent to agent_name,
        except very recent commands.
        This (exception) is to avoid a "data race" where for example agentB is executing a "flush" command 
        while agentA is sending command to agentB... :
        - agentB will then delete the command just sent by agentA
        - agentA will check regularly the status of its sent command, and this will crash as this command exists no more !!
        """
        printd("Delete all pending command(s) if exists (except very recent ones):")
1ba49504   Alexis Koralewski   fixing CSS and JS...
736
        now_minus_2sec = datetime.utcnow().astimezone() - timedelta(seconds=2)
5ce2836f   Alexis Koralewski   update models (ad...
737
738
739
        #print("now_minus_2sec", now_minus_2sec)
        pending_commands = cls.objects.filter(
            # only commands for agent agent_name
1ba49504   Alexis Koralewski   fixing CSS and JS...
740
            recipient=agent_name,
5ce2836f   Alexis Koralewski   update models (ad...
741
            # only running commands
1ba49504   Alexis Koralewski   fixing CSS and JS...
742
            state=cls.CMD_STATUS_CODES.CMD_PENDING,
5ce2836f   Alexis Koralewski   update models (ad...
743
            # except very recent commands : take only commands that are more than 2 sec old
1ba49504   Alexis Koralewski   fixing CSS and JS...
744
            s_deposit_time__lt=now_minus_2sec
5ce2836f   Alexis Koralewski   update models (ad...
745
746
747
748
        )
        if pending_commands:
            AgentCmd.show_commands(pending_commands)
            pending_commands.delete()
1ba49504   Alexis Koralewski   fixing CSS and JS...
749
750
        else:
            printd("<None>")
5ce2836f   Alexis Koralewski   update models (ad...
751
752
753
754
755

    @classmethod
    def get_pending_and_running_commands_for_agent(cls, agent_name):
        #print("peremption date", COMMAND_PEREMPTION_DATE_FROM_NOW)
        return cls.objects.filter(
1a6fd283   Etienne Pallier   ajout gestion val...
756
757
            # only pending or running commands
            Q(state=cls.CMD_STATUS_CODES.CMD_PENDING) | Q(state=cls.CMD_STATUS_CODES.CMD_RUNNING),
5ce2836f   Alexis Koralewski   update models (ad...
758
            # only commands for agent agent_name
1ba49504   Alexis Koralewski   fixing CSS and JS...
759
760
761
            recipient=agent_name,
            # recipient__startswith=agent_name,
            # Q(recipient.split('.')[0] = agent_name),
5ce2836f   Alexis Koralewski   update models (ad...
762
            # only not expired commands
1a6fd283   Etienne Pallier   ajout gestion val...
763
            #s_deposit_time__gte = cls.max_deposit_date_for_peremption(),
5ce2836f   Alexis Koralewski   update models (ad...
764
765
766
767
768
769
770
771
772
773
774
775
        ).order_by("s_deposit_time")

    @classmethod
    def get_commands_sent_to_agent(cls, agent_name):
        return cls.objects.filter(recipient=agent_name)

    @classmethod
    def get_commands_sent_by_agent(cls, agent_name):
        return cls.objects.filter(sender=agent_name)

    @classmethod
    def get_last_N_commands_sent_to_agent(cls, agent_name, N):
1ba49504   Alexis Koralewski   fixing CSS and JS...
776
777
        # filter(since=since)
        # return cls.objects.all()[:nb_cmds]
5ce2836f   Alexis Koralewski   update models (ad...
778
        #commands = cls.objects.filter(recipient = agent_name).order_by('-id')[:N]
1ba49504   Alexis Koralewski   fixing CSS and JS...
779
780
        commands = cls.get_commands_sent_to_agent(
            agent_name).order_by('-id')[:N]
5ce2836f   Alexis Koralewski   update models (ad...
781
782
783
784
        return list(reversed(commands))

    @classmethod
    def get_last_N_commands_sent_by_agent(cls, agent_name, N):
1ba49504   Alexis Koralewski   fixing CSS and JS...
785
786
        # filter(since=since)
        # return cls.objects.all()[:nb_cmds]
5ce2836f   Alexis Koralewski   update models (ad...
787
        #commands = cls.objects.filter(recipient = agent_name).order_by('-id')[:N]
1ba49504   Alexis Koralewski   fixing CSS and JS...
788
789
        commands = cls.get_commands_sent_by_agent(
            agent_name).order_by('-id')[:N]
5ce2836f   Alexis Koralewski   update models (ad...
790
791
792
793
794
        return list(reversed(commands))

    @classmethod
    def purge_old_commands_sent_to_agent(cls, agent_name):
        """
1a6fd283   Etienne Pallier   ajout gestion val...
795
        Delete commands (which agent_name is recipient of) older than VALIDITY_DURATION (like 1h)
5ce2836f   Alexis Koralewski   update models (ad...
796
797
798
        ATTENTION !!! EXCEPT the RUNNING command !!!
        NB: datetime.utcnow() is equivalent to datetime.now(timezone.utc)
        """
1ba49504   Alexis Koralewski   fixing CSS and JS...
799
        printd(
eb6649f7   Etienne Pallier   bugfix DEFAULT_VA...
800
            f"(Looking for commands sent to me that are not executing and perempted - i.e. older than {cls.DEFAULT_VALIDITY_DURATION/60} minute(s))")
5ce2836f   Alexis Koralewski   update models (ad...
801
802
803
804
        #COMMAND_PEREMPTION_DATE_FROM_NOW = datetime.utcnow() - timedelta(hours = cls.COMMANDS_PEREMPTION_HOURS)
        #print("peremption date", COMMAND_PEREMPTION_DATE_FROM_NOW)
        old_commands = cls.objects.filter(
            # only commands for agent agent_name
1ba49504   Alexis Koralewski   fixing CSS and JS...
805
            recipient=agent_name,
5ce2836f   Alexis Koralewski   update models (ad...
806
            # only expired commands
1a6fd283   Etienne Pallier   ajout gestion val...
807
            s_deposit_time__lt=cls.max_deposit_date_for_peremption(),
5ce2836f   Alexis Koralewski   update models (ad...
808
        ).exclude(
1ba49504   Alexis Koralewski   fixing CSS and JS...
809
            state=cls.CMD_STATUS_CODES.CMD_RUNNING
5ce2836f   Alexis Koralewski   update models (ad...
810
811
812
813
814
815
816
817
818
819
        )
        if old_commands.exists():
            printd("Found old commands to delete:")
            #for cmd in old_commands: print(cmd)
            cls.show_commands(old_commands)
            old_commands.delete()
        else:
            printd("<None>")

    @classmethod
1ba49504   Alexis Koralewski   fixing CSS and JS...
820
821
822
    # def show_commands(cls, commands:models.query):
    def show_commands(cls, commands: list, do_it: bool = False):
        # def show_commands(cls, commands:List[Commmand]):
5ce2836f   Alexis Koralewski   update models (ad...
823
824
        #if not commands.exists(): print("<No command>")
        commands = list(commands)
1ba49504   Alexis Koralewski   fixing CSS and JS...
825
        if len(commands) == 0:
f3a4f48f   Etienne Pallier   Agent : nombreux ...
826
827
828
            print("<None>")
            #if do_it: print("<None>")
            #else: printd("<None>")
1ba49504   Alexis Koralewski   fixing CSS and JS...
829
        for cmd in commands:
f3a4f48f   Etienne Pallier   Agent : nombreux ...
830
831
832
            print("-", cmd.name, cmd)
            #if do_it: print("-", cmd.name, cmd)
            #else: printd("-", cmd.name, cmd)
5ce2836f   Alexis Koralewski   update models (ad...
833
834
835
836

    # -------------- AgentCmd INSTANCE METHODS --------------

    def __str__(self):
1ba49504   Alexis Koralewski   fixing CSS and JS...
837
        # return (f"Commmand '{self.name}' ({self.state}) sent by agent {self.sender} to agent {self.recipient} at {self.s_deposit_time}")
5ce2836f   Alexis Koralewski   update models (ad...
838
        cmd_sent_time = f" at {self.s_deposit_time}" if self.s_deposit_time else ''
607a7131   Etienne Pallier   validity and time...
839
        return (f"Commmand '{self.full_name}' ({self.state}) sent to agent {self.recipient}{cmd_sent_time} (validity={self.validity_duration}s,timeout={self.exec_timeout}s) [by agent {self.sender}]")
5ce2836f   Alexis Koralewski   update models (ad...
840
841

    @property
573eeae6   Etienne Pallier   Agent ne depend p...
842
    def device_command(self) -> DeviceCmd :
5ce2836f   Alexis Koralewski   update models (ad...
843
844
845
846
847
848
849
        if not self._device_command:
            self._device_command = DeviceCmd(self.full_name)
            #dc = self._device_command
            #print("...DEVICE CMD:", dc.full_name, dc.name, dc.devtype, dc.args)
        return self._device_command

    @property
1f638223   Etienne Pallier   Ameliorations Age...
850
851
852
    #def name_and_args(self) -> Tuple[str, str] :
    def name_and_args(self) -> Tuple[str, List] :
        ###return self.device_command.name_and_args
5ce2836f   Alexis Koralewski   update models (ad...
853
854
855
856
857
858
        '''
        cmd_name_and_args = self.full_name
        if '.' in cmd_name_and_args:
            cmd_name_and_args = cmd_name_and_args.split('.')[1]
        return cmd_name_and_args
        '''
573eeae6   Etienne Pallier   Agent ne depend p...
859
860
        ''' Return command name and args if exist '''
        # By default, no args
2912abf2   Etienne Pallier   Agent specific co...
861
862
        #cmd_args = None
        cmd_args = []
573eeae6   Etienne Pallier   Agent ne depend p...
863
        cmd_name = self.full_name
5ce2836f   Alexis Koralewski   update models (ad...
864
865
        if ' ' in cmd_name:
            cmd_name, *cmd_args = cmd_name.split(' ')
573eeae6   Etienne Pallier   Agent ne depend p...
866
867
868
        return cmd_name, cmd_args


ba30549a   Etienne Pallier   updated methods r...
869
870
    #def get_full_name_parts(self) -> list :
    def get_full_name_parts(self) -> Tuple[str, str, str] :
573eeae6   Etienne Pallier   Agent ne depend p...
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
        ''' Return command device type, name, and args from any command type (agent or device level) '''

        # No device type by default for an Agent command
        # cmd_type ?
        dev_type = None
        
        # By default, no args
        cmd_args = None

        cmd_name = self.full_name
        
        # Device command with device component type (dev_type)
        if '.' in cmd_name: 
            return self.device_command.get_full_name_parts()

        # Simple command with args (no dev_type)
        if ' ' in cmd_name:
1f638223   Etienne Pallier   Ameliorations Age...
888
            cmd_name, *cmd_args = self.name_and_args
573eeae6   Etienne Pallier   Agent ne depend p...
889
890
891

        return dev_type, cmd_name, cmd_args

5ce2836f   Alexis Koralewski   update models (ad...
892
893
894

    @property
    def name(self):
1f638223   Etienne Pallier   Ameliorations Age...
895
896
897
        ###return self.device_command.name
        #_,cmd_name,_ = self.get_full_name_parts()
        cmd_name,_ = self.name_and_args
5ce2836f   Alexis Koralewski   update models (ad...
898
        return cmd_name
5ce2836f   Alexis Koralewski   update models (ad...
899
900
901

    @property
    def args(self):
1f638223   Etienne Pallier   Ameliorations Age...
902
903
904
        ###return self.device_command.args
        #_,_,cmd_args = self.get_full_name_parts()
        _,cmd_args = self.name_and_args
5ce2836f   Alexis Koralewski   update models (ad...
905
        return cmd_args
5ce2836f   Alexis Koralewski   update models (ad...
906
907
908
909
910

    @property
    def device_type(self): return self.device_command.devtype

    def send(self):
1ba49504   Alexis Koralewski   fixing CSS and JS...
911
        # self.save()
5ce2836f   Alexis Koralewski   update models (ad...
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
        self.set_as_pending()

    '''
    def tokenize(self):
        cmd_name, *cmd_args = self.full_name.split(' ')
        return cmd_name, cmd_args
    '''

    # --- BOOLEAN (test) functions ---

    def is_agent_general_cmd(self):
        """
        Is this a general command ?
        It is the case if command is of style "do_set:state:idle" or "do_restart" or "do_flush"...
        """
        ##name = self.name
        ##if " " in name: name,args = name.split()
        ##name = self.name.split(' ')[0]
        ##cmd_name, _ = self.tokenize()
1ba49504   Alexis Koralewski   fixing CSS and JS...
931
        # return cmd_name in self.GENERIC_COMMANDS
5ce2836f   Alexis Koralewski   update models (ad...
932
933
        #print("**********************CMD NAME is", self.name, "in ???", self._AGENT_GENERAL_COMMANDS)
        return self.name in self._AGENT_GENERAL_COMMANDS
1ba49504   Alexis Koralewski   fixing CSS and JS...
934
        # "CMD_OUTOFDATE" # cde périmée
5ce2836f   Alexis Koralewski   update models (ad...
935

f3a4f48f   Etienne Pallier   Agent : nombreux ...
936
937
938
    def is_agent_general_priority_cmd(self):
        return self.name in self._AGENT_GENERAL_PRIORITY_COMMANDS

5ce2836f   Alexis Koralewski   update models (ad...
939
940
941
    def is_read(self):
        return self.r_read_time is not None

d6441fe9   Etienne Pallier   new methods is_xx...
942
943
944
    # CMD status

    # 1 - pending
5ce2836f   Alexis Koralewski   update models (ad...
945
946
947
    def is_pending(self):
        return self.state == self.CMD_STATUS_CODES.CMD_PENDING

d6441fe9   Etienne Pallier   new methods is_xx...
948
949
950
951
    # 2 - ERROR cases (from PENDING)
    def is_invalid(self): return self.state == self.CMD_STATUS_CODES.CMD_INVALID
    def is_unimplemented(self): return self.state == self.CMD_STATUS_CODES.CMD_UNIMPLEMENTED
    def is_skipped(self): return self.state == self.CMD_STATUS_CODES.CMD_SKIPPED
5ce2836f   Alexis Koralewski   update models (ad...
952
    def is_expired(self):
cbbd0c65   Etienne Pallier   Updated models.Ag...
953
954
955
        if self.state == self.CMD_STATUS_CODES.CMD_EXPIRED: return True
        # Must NOT be running
        if self.is_running(): return False
1ba49504   Alexis Koralewski   fixing CSS and JS...
956
        # return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
5ce2836f   Alexis Koralewski   update models (ad...
957
958
        elapsed_time = (datetime.utcnow().astimezone() - self.s_deposit_time)
        printd("elapsed_time", elapsed_time)
1ba49504   Alexis Koralewski   fixing CSS and JS...
959
        return elapsed_time > timedelta(seconds=self.validity_duration)
5ce2836f   Alexis Koralewski   update models (ad...
960
961
962
963
964
965
        """
        elapsed_time = cmd.r_read_time - cmd.s_deposit_time
        max_time = timedelta(seconds = cmd.validity_duration)
        print(f"Elapsed time is {elapsed_time}, (max is {max_time})")
        if elapsed_time > max_time:
        """
d6441fe9   Etienne Pallier   new methods is_xx...
966
967
968
969
970
971
    # finished with issue (from pending)
    def is_pending_issue(self): return self.is_invalid() or self.is_unimplemented() or self.is_skipped() or self.is_expired()

    # 3 - running
    def is_running(self):
        return self.state == self.CMD_STATUS_CODES.CMD_RUNNING
5ce2836f   Alexis Koralewski   update models (ad...
972

d6441fe9   Etienne Pallier   new methods is_xx...
973
974
975
976
977
978
979
980
    # 4 - ERROR cases (from RUNNING)
    def is_exec_error(self): return self.state == self.CMD_STATUS_CODES.CMD_EXEC_ERROR
    def is_exec_killed(self): return self.state == self.CMD_STATUS_CODES.CMD_EXEC_KILLED
    # alias
    def is_killed(self): return self.is_exec_killed()
    # alias
    def is_timeout(self): return self.is_exec_timeout()
    def is_exec_timeout(self):
cbbd0c65   Etienne Pallier   Updated models.Ag...
981
        if self.state == self.CMD_STATUS_CODES.CMD_EXEC_TIMEOUT: return True
1a6fd283   Etienne Pallier   ajout gestion val...
982
983
984
985
986
987
        # Must be running
        if not self.is_running(): return False
        # return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
        elapsed_time = (datetime.utcnow().astimezone() - self.r_start_time)
        printd("elapsed_time since exec", elapsed_time)
        return elapsed_time > timedelta(seconds=self.exec_timeout)
d6441fe9   Etienne Pallier   new methods is_xx...
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
    # finished with any execution issue
    def is_exec_issue(self): return self.state.startswith("CMD_EXEC_")

    # 5 - Execution finished
    # Cmd is finished if not pending or running
    def is_finished(self):
        return not (self.is_pending() or self.is_running())
    # Cmd is finished with error : finished but NOT executed
    def is_finished_with_error(self):
        return self.is_finished() and not self.is_executed()
    # Cmd is finished without error (normal case)
    def is_executed(self):
        return self.state == self.CMD_STATUS_CODES.CMD_EXECUTED

1a6fd283   Etienne Pallier   ajout gestion val...
1002

5ce2836f   Alexis Koralewski   update models (ad...
1003
1004
1005
1006
1007
1008
1009
1010
1011
    # --- GETTERS/SETTERS functions ---

    def get_result(self):
        return self.result

    def get_updated_result(self):
        self.refresh_from_db()
        return self.result

7138789e   Etienne Pallier   new Agent with 3 ...
1012
    def set_result(self, result: str, do_save:bool=True):
5ce2836f   Alexis Koralewski   update models (ad...
1013
        self.result = result
7138789e   Etienne Pallier   new Agent with 3 ...
1014
        if do_save: self.save()
5ce2836f   Alexis Koralewski   update models (ad...
1015

7138789e   Etienne Pallier   new Agent with 3 ...
1016
    def set_read_time(self, do_save:bool=True):
5ce2836f   Alexis Koralewski   update models (ad...
1017
1018
        self.r_read_time = datetime.utcnow().astimezone()
        # Optimization: update only 1 field
7138789e   Etienne Pallier   new Agent with 3 ...
1019
        if do_save: self.save(update_fields=["r_read_time"])
5ce2836f   Alexis Koralewski   update models (ad...
1020

7735aaa7   Etienne Pallier   updated Agent spe...
1021
1022
1023
1024
1025
1026
1027
1028
1029
    #
    # Set cmd status
    #

    def set_as_pending(self):
        self.set_state_to(self.CMD_STATUS_CODES.CMD_PENDING)

    # from PENDING
    def set_as_unimplemented(self, result:str=None):
fb7896e6   Etienne Pallier   Ajout cmd running...
1030
        assert self.is_pending(), "An Unimplemented Command must have been PENDING"
7735aaa7   Etienne Pallier   updated Agent spe...
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
        self.set_state_to(self.CMD_STATUS_CODES.CMD_UNIMPLEMENTED)

    # from PENDING
    def set_as_invalid(self, result:str=None):
        assert self.is_pending()
        self.set_state_to(self.CMD_STATUS_CODES.CMD_INVALID)

    # from PENDING
    def set_as_skipped(self, result:str=None):
        assert self.is_pending()
        self.set_state_to(self.CMD_STATUS_CODES.CMD_SKIPPED, result=result)

    # from PENDING
    def set_as_expired(self):
        assert self.is_pending()
        print(f"- Set this command as expired (older than its validity duration of {self.validity_duration}s): {self}")
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXPIRED)
    
    # from PENDING
    def set_as_running(self):
        assert self.is_pending()
        printd(f"- Set command {self.name} as running")
        self.set_state_to(self.CMD_STATUS_CODES.CMD_RUNNING)

    '''
    def set_as_executed(self):
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
    '''
    # from RUNNING
7138789e   Etienne Pallier   new Agent with 3 ...
1060
    def set_as_processed(self, result:str=None):
fb7896e6   Etienne Pallier   Ajout cmd running...
1061
        assert self.is_running(), "a PROCESSED command must have been RUNNING"
5ce2836f   Alexis Koralewski   update models (ad...
1062
        printd(f"- Set command {self.name} as processed")
7138789e   Etienne Pallier   new Agent with 3 ...
1063
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXECUTED, result=result)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1064
        # print(self)
5ce2836f   Alexis Koralewski   update models (ad...
1065
1066
1067
1068
1069
1070
1071
        """
        self.state = self.CMD_STATUS_CODES.CMD_EXECUTED
        self.r_processed_time = datetime.utcnow().astimezone()
        self.save()
        """
        # Optimization: update the related fields, but does not work, why ?
        ##self.save(update_fields=["state", "r_processed_time"])
cbbd0c65   Etienne Pallier   Updated models.Ag...
1072
    #def set_as_outofdate(self):
5ce2836f   Alexis Koralewski   update models (ad...
1073

7735aaa7   Etienne Pallier   updated Agent spe...
1074
1075
1076
1077
    # from RUNNING
    def set_as_exec_error(self, result:str=None):
        assert self.is_running()
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXEC_ERROR, result=result)
5ce2836f   Alexis Koralewski   update models (ad...
1078

7735aaa7   Etienne Pallier   updated Agent spe...
1079
1080
1081
1082
    # from RUNNING
    def set_as_exec_timeout(self, result:str=None):
        assert self.is_running()
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXEC_TIMEOUT, result=result)
5ce2836f   Alexis Koralewski   update models (ad...
1083

7735aaa7   Etienne Pallier   updated Agent spe...
1084
1085
1086
1087
1088
1089
    # from RUNNING
    def set_as_exec_timeout(self, result:str=None):
        assert self.is_running()
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXEC_TIMEOUT, result=result)

    # from RUNNING
1ba49504   Alexis Koralewski   fixing CSS and JS...
1090
    def set_as_killed_by(self, author_agent: str):
7735aaa7   Etienne Pallier   updated Agent spe...
1091
        assert self.is_running()
5ce2836f   Alexis Koralewski   update models (ad...
1092
1093
        printd(f"- Set command {self.name} as killed")
        #print(f"- Set this command as killed: {self}")
cbbd0c65   Etienne Pallier   Updated models.Ag...
1094
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXEC_KILLED, author_agent)
5ce2836f   Alexis Koralewski   update models (ad...
1095

7138789e   Etienne Pallier   new Agent with 3 ...
1096
1097
1098
1099
    def set_state_to(self, status: str, author_agent_name: str = None, result:str=None):
        '''
        If comment is present it will be set in the "result" field
        '''
5ce2836f   Alexis Koralewski   update models (ad...
1100
        now_time = datetime.utcnow().astimezone()
7138789e   Etienne Pallier   new Agent with 3 ...
1101
1102
        if result: 
            self.set_result(result, False)
cbbd0c65   Etienne Pallier   Updated models.Ag...
1103
        if status in (self.CMD_STATUS_CODES.CMD_RUNNING, self.CMD_STATUS_CODES.CMD_SKIPPED, self.CMD_STATUS_CODES.CMD_EXPIRED):
5ce2836f   Alexis Koralewski   update models (ad...
1104
1105
1106
1107
            assert self.is_pending()
            if status == self.CMD_STATUS_CODES.CMD_RUNNING:
                self.r_start_time = now_time
            elif status in (self.CMD_STATUS_CODES.CMD_SKIPPED):
cbbd0c65   Etienne Pallier   Updated models.Ag...
1108
                self.r_end_time = now_time
5ce2836f   Alexis Koralewski   update models (ad...
1109
            # EXPIRED
cbbd0c65   Etienne Pallier   Updated models.Ag...
1110
1111
            elif status == self.CMD_STATUS_CODES.CMD_EXPIRED:
                self.r_end_time = now_time
5ce2836f   Alexis Koralewski   update models (ad...
1112
                self.killer_agent_name = author_agent_name
cbbd0c65   Etienne Pallier   Updated models.Ag...
1113
        elif status in (self.CMD_STATUS_CODES.CMD_EXECUTED, self.CMD_STATUS_CODES.CMD_EXEC_KILLED):
5ce2836f   Alexis Koralewski   update models (ad...
1114
            assert self.is_running()
cbbd0c65   Etienne Pallier   Updated models.Ag...
1115
1116
            self.r_end_time = now_time
            if status == self.CMD_STATUS_CODES.CMD_EXEC_KILLED:
5ce2836f   Alexis Koralewski   update models (ad...
1117
1118
1119
1120
1121
                self.killer_agent_name = author_agent_name
        # Update command status
        self.state = status
        self.save()
        # Optimization, but does not work, why ?...
1ba49504   Alexis Koralewski   fixing CSS and JS...
1122
        # self.save(update_fields=["state"])
5ce2836f   Alexis Koralewski   update models (ad...
1123
1124
1125


class Config(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1126
1127
    PYROS_STATE = ["Starting", "Passive", "Standby",
                   "Remote", "Startup", "Scheduler", "Closing"]
5ce2836f   Alexis Koralewski   update models (ad...
1128
1129
1130
1131

    id = models.IntegerField(default='1', primary_key=True)
    #latitude = models.FloatField(default=1)
    latitude = models.DecimalField(
1ba49504   Alexis Koralewski   fixing CSS and JS...
1132
        max_digits=4, decimal_places=2,
5ce2836f   Alexis Koralewski   update models (ad...
1133
1134
1135
1136
1137
1138
1139
1140
1141
        default=1,
        validators=[
            MaxValueValidator(90),
            MinValueValidator(-90)
        ]
    )
    local_time_zone = models.FloatField(default=1)
    #longitude = models.FloatField(default=1)
    longitude = models.DecimalField(
1ba49504   Alexis Koralewski   fixing CSS and JS...
1142
        max_digits=5, decimal_places=2,
5ce2836f   Alexis Koralewski   update models (ad...
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
        default=1,
        validators=[
            MaxValueValidator(360),
            MinValueValidator(-360)
        ]
    )
    altitude = models.FloatField(default=1)
    horizon_line = models.FloatField(default=1)
    row_data_save_frequency = models.IntegerField(default='300')
    request_frequency = models.IntegerField(default='300')
    analysed_data_save = models.IntegerField(default='300')
    telescope_ip_address = models.CharField(max_length=45, default="127.0.0.1")
    camera_ip_address = models.CharField(max_length=45, default="127.0.0.1")
    plc_ip_address = models.CharField(max_length=45, default="127.0.0.1")

    # TODO: changer ça, c'est pas clair du tout...
    # True = mode Scheduler-standby, False = mode Remote !!!!
    global_mode = models.BooleanField(default='True')

    ack = models.BooleanField(default='False')
    bypass = models.BooleanField(default='True')
    lock = models.BooleanField(default='False')
    pyros_state = models.CharField(max_length=25, default=PYROS_STATE[0])
    force_passive_mode = models.BooleanField(default='False')
    plc_timeout_seconds = models.PositiveIntegerField(default=60)
    majordome_state = models.CharField(max_length=25, default="")
    ntc = models.BooleanField(default='False')
    majordome_restarted = models.BooleanField(default='False')

    class Meta:
        managed = True
        db_table = 'config'
        verbose_name_plural = "Config"

    def __str__(self):
        return (str(self.__dict__))


5ce2836f   Alexis Koralewski   update models (ad...
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
class Country(models.Model):
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    quota = models.FloatField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'country'
        verbose_name_plural = "Countries"

    def __str__(self):
        return (str(self.name))


class Detector(Device):
    VIS = "Visible camera"
    NIR = "Cagire"

    telescope = models.ForeignKey(
        'Telescope', models.DO_NOTHING, related_name="detectors")
    nb_photo_x = models.IntegerField(blank=True, null=True)
    nb_photo_y = models.IntegerField(blank=True, null=True)
    photo_size_x = models.IntegerField(blank=True, null=True)
    photo_size_y = models.IntegerField(blank=True, null=True)
    has_shutter = models.BooleanField(default=False)
    equivalent_foc_len = models.CharField(max_length=45, blank=True, null=True)
    acq_start = models.DateTimeField(blank=True, null=True)
    acq_stop = models.DateTimeField(blank=True, null=True)
    check_temp = models.FloatField(blank=True, null=True)
    gain = models.FloatField(blank=True, null=True)
    readout_noise = models.FloatField(blank=True, null=True)
    readout_time = models.FloatField(blank=True, null=True)
    idcam_readout_mode = models.IntegerField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'detector'

    def __str__(self):
        return str(self.name)

    def device_name(self):
        return self.__str__()
    device_name.short_description = "Name"


class Dome(Device):
    DOME = "Dome"

    open = models.BooleanField(default=False, blank=True)

    class Meta:
        managed = True
        db_table = 'dome'

    def __str__(self):
        return str(self.name)

    def device_name(self):
        return self.__str__()
    device_name.short_description = "Name"


5ce2836f   Alexis Koralewski   update models (ad...
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
class Filter(Device):
    VIS_FILTER_1 = "First visible filter"
    VIS_FILTER_2 = "Second visible filter"
    NIR_FILTER_1 = "First infrared filter"
    NIR_FILTER_2 = "Second infrared filter"

    filter_wheel = models.ForeignKey(
        "FilterWheel", models.DO_NOTHING, related_name="filters", blank=True, null=True)
    category = models.CharField(max_length=1, blank=True, null=True)
    transmission_curve_doc = models.CharField(
        max_length=45, blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'filter'

    def __str__(self):
        return (str(self.name))

    def device_name(self):
        return self.__str__()
    device_name.short_description = "Name"


class FilterWheel(Device):
    detector = models.OneToOneField(Detector, on_delete=models.CASCADE,
                                    related_name="filter_wheel", blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'filter_wheel'

    def __str__(self):
        return (str(self.name))

    def device_name(self):
        return self.__str__()
    device_name.short_description = "Name"


class Image(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1285
1286
    plan = models.ForeignKey(
        'Plan', on_delete=models.CASCADE, related_name="images")
5ce2836f   Alexis Koralewski   update models (ad...
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
    nrtanalysis = models.ForeignKey(
        'NrtAnalysis', models.DO_NOTHING, blank=True, null=True, related_name="images")
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    date_from_gps = models.CharField(max_length=45, blank=True, null=True)
    level = models.IntegerField(blank=True, null=True)
    type = models.CharField(max_length=5, blank=True, null=True)
    quality = models.CharField(max_length=45, blank=True, null=True)
    flaggps = models.CharField(max_length=45, blank=True, null=True)
    exposure = models.CharField(max_length=45, blank=True, null=True)
    tempext = models.CharField(max_length=45, blank=True, null=True)
    pressure = models.CharField(max_length=45, blank=True, null=True)
    humidext = models.CharField(max_length=45, blank=True, null=True)
    wind = models.CharField(max_length=45, blank=True, null=True)
    wind_dir = models.CharField(max_length=45, blank=True, null=True)
    dwnimg = models.CharField(max_length=45, blank=True, null=True)
    dwncata = models.CharField(max_length=45, blank=True, null=True)
    dwn = models.CharField(max_length=45, blank=True, null=True)
    level0_fits_name = models.CharField(max_length=45, blank=True, null=True)
    level1a_fits_name = models.CharField(max_length=45, blank=True, null=True)
    level1b_fits_name = models.CharField(max_length=45, blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'image'

    def __str__(self):
        return (str(self.name))


class Log(models.Model):
    agent = models.CharField(max_length=45, blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    message = models.TextField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'log'

    def __str__(self):
        return (str(self.agent))


class NrtAnalysis(models.Model):
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    analysis = models.TextField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'nrtanalysis'
        verbose_name_plural = "Nrt analyzes"

    def __str__(self):
        return (str(self.name))


3b81a22b   Alexis Koralewski   Rework on Request...
1348
"""
5ce2836f   Alexis Koralewski   update models (ad...
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
class Plan(models.Model):
    album = models.ForeignKey(Album, on_delete=models.CASCADE, related_name="plans")
    filter = models.ForeignKey(Filter, models.DO_NOTHING, related_name="plans", blank=True, null=True)
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.CharField(max_length=45, blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    duration = models.FloatField(default=0, blank=True, null=True)
    position = models.CharField(max_length=45, blank=True, null=True)
    exposure_time = models.FloatField(blank=True, null=True)
    nb_images = models.IntegerField(blank=True, null=True)
    dithering = models.BooleanField(default=False)
    complete = models.BooleanField(default=False)

    class Meta:
        managed = True
        db_table = 'plan'

    def __str__(self):
        return (str(self.name))
3b81a22b   Alexis Koralewski   Rework on Request...
1369
"""
5ce2836f   Alexis Koralewski   update models (ad...
1370

1ba49504   Alexis Koralewski   fixing CSS and JS...
1371

3b81a22b   Alexis Koralewski   Rework on Request...
1372
class Plan(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1373
1374
    album = models.ForeignKey(
        Album, on_delete=models.CASCADE, related_name="plans")
3b81a22b   Alexis Koralewski   Rework on Request...
1375
1376
1377
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    duration = models.FloatField(default=0, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1378
1379
1380
    nb_images = models.PositiveIntegerField(
        blank=True, null=True, validators=[MinValueValidator(1)])
    config_attributes = models.JSONField(blank=True, null=True)
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1381
    complete = models.BooleanField(default=False)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1382

864ec466   Alexis Koralewski   Renaming common t...
1383
1384
    class Meta:
        db_table = "plan"
5ce2836f   Alexis Koralewski   update models (ad...
1385

bbf0ac6e   Alexis Koralewski   Adding unique con...
1386
1387
1388
    def __str__(self) -> str:
        return f"Plan of Album {self.album.name} has {self.nb_images} image(s)"

5ce2836f   Alexis Koralewski   update models (ad...
1389
class PlcDeviceStatus(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1390
1391
1392
1393
1394
1395
    device = models.ForeignKey(
        'PlcDevice', on_delete=models.CASCADE, related_name='current_status')
    created = models.DateTimeField(
        auto_now_add=True, editable=False, blank=True)
    outside_temp = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1396
    outside_temp_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1397
1398
1399
1400
1401
1402
    outside_humidity = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
    outside_humidity_unit = models.CharField(
        max_length=45, blank=True, null=True)
    pressure = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1403
    pressure_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1404
1405
    rain_rate = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1406
    rain_rate_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1407
1408
    wind_speed = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1409
    wind_speed_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1410
1411
    wind_dir = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1412
    wind_dir_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1413
1414
    dew_point = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1415
    dew_point_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1416
1417
    analog = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1418
    analog_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1419
1420
    digital = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1421
    digital_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1422
1423
    inside_temp = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1424
    inside_temp_unit = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1425
1426
1427
1428
    inside_humidity = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
    inside_humidity_unit = models.CharField(
        max_length=45, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1429
    wind_dir_cardinal = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
    wind_dir_cardinal_unit = models.CharField(
        max_length=45, blank=True, null=True)
    sensor_temperature = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
    sensor_temperature_unit = models.CharField(
        max_length=45, blank=True, null=True)
    sky_temperature = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
    sky_temperature_unit = models.CharField(
        max_length=45,  blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1440
    status = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1441
1442
    current = models.DecimalField(
        max_digits=15, decimal_places=8, blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
    current_unit = models.CharField(max_length=45, blank=True, null=True)
    is_safe = models.BooleanField(default=True)
    plc_mode = models.CharField(max_length=4, null=True)
    lights = models.CharField(max_length=3, null=True)
    shutters = models.CharField(max_length=5, null=True)

    class Meta:
        managed = True
        db_table = 'plc_devices_status'

    def __str__(self):
        return (str(self.__dict__))

    '''
        TODO : This function is Ugly,
        we should change this with a function pointer array
        and setters getters for each attribute
    '''
1ba49504   Alexis Koralewski   fixing CSS and JS...
1461

5ce2836f   Alexis Koralewski   update models (ad...
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
    def setValue(self, key, value, unit=""):
        if key == "Temperature_outside":
            self.outside_temp = value
            self.outside_temp_unit = unit
        elif key == "Humidity_outside":
            self.outside_humidity = value
            self.outside_humidity_unit = unit
        elif key == "_Pressure":
            self.pressure = value
            self.pressure_unit = unit
1ba49504   Alexis Koralewski   fixing CSS and JS...
1472
        elif key == "Rain_boolean":  # RainRate
5ce2836f   Alexis Koralewski   update models (ad...
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
            self.rain_rate = value
            self.rain_rate_unit = 'boulean'
        elif key == "Wind_speed":
            self.wind_speed = value
            self.wind_speed_unit = unit
        elif key == "Wind_dir":
            self.wind_dir = value
            self.wind_dir_unit = unit
        elif key == "_DewPoint":
            self.dew_point = value
            self.dew_point_unit = unit
        elif key == "_analog":
            self.analog = value
            self.analog_unit = unit
        elif key == "_digital":
            self.digital = value
            self.digital_unit = unit
        elif key == "_InsideTemp":
            self.inside_temp = value
            self.inside_temp_unit = unit
        elif key == "_InsideHumidity":
            self.inside_humidity = value
            self.inside_humidity_unit = unit
        elif key == "_WindDirCardinal":
            self.wind_dir_cardinal = value
            self.wind_dir_cardinal_unit = unit
        elif key == "_SensorTemperature":
            self.sensor_temperature = value
            self.sensor_temperature_unit = unit
        elif key == "_SkyTemperature":
            self.sky_temperature = value
            self.sky_temperature_unit = unit
        # PM 20190222 try patch
        elif key == "Error_code":
            self.status = value
        elif key == "current":
            self.current = value
            self.current_unit = unit
        elif key == "mode":
            self.plc_mode = value
        elif key == "is_safe":
            self.is_safe = value
        elif key == "LIGHTS":
            self.lights = value
        elif key == "SHUTTERS":
            self.shutters = value
        else:
            # PM 20190222 ignore unrecognized
            #raise KeyError("Key " + str(key) + " unrecognized")
            pass

1ba49504   Alexis Koralewski   fixing CSS and JS...
1524

5ce2836f   Alexis Koralewski   update models (ad...
1525
1526
1527
1528
1529
1530
1531
class PlcDevice(Device):
    #device = models.ForeignKey('Plc', on_delete=models.CASCADE, related_name='plc_devices')
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)

5ce2836f   Alexis Koralewski   update models (ad...
1532
1533
1534
1535
1536
1537
1538
1539
    class Meta:
        managed = True
        db_table = 'plc_devices'

    def __str__(self):
        return str(self.name)


1ba49504   Alexis Koralewski   fixing CSS and JS...
1540
# class Plc(Device):
5ce2836f   Alexis Koralewski   update models (ad...
1541
1542
1543
1544
1545
1546
 #   last_update_status = models.DateTimeField(blank=True, null=True)
#    i
 #   class Meta:
  #      managed = True
   #     db_table = 'plc'

5a434264   Alexis Koralewski   New version of Sc...
1547
class ScienceTheme(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1548
1549
    name = models.CharField(max_length=120, blank=False,
                            null=False, default="", unique=True)
5a434264   Alexis Koralewski   New version of Sc...
1550
1551
1552

    def __str__(self) -> str:
        return str(self.name)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1553

864ec466   Alexis Koralewski   Renaming common t...
1554
1555
    class Meta:
        db_table = "science_theme"
1ba49504   Alexis Koralewski   fixing CSS and JS...
1556

5ce2836f   Alexis Koralewski   update models (ad...
1557
class Institute(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1558
1559
1560
1561
    name = models.CharField(max_length=100, blank=False,
                            null=False, unique=True)
    quota = models.IntegerField(
        validators=[MinValueValidator(0), MaxValueValidator(100)])
5ce2836f   Alexis Koralewski   update models (ad...
1562
1563
1564
1565
1566
    #representative_user = models.ForeignKey("PyrosUser", on_delete=models.DO_NOTHING,related_name="institutes",default=1)

    def __str__(self) -> str:
        return str(self.name)

864ec466   Alexis Koralewski   Renaming common t...
1567
1568
    class Meta:
        db_table = "institute"
1ba49504   Alexis Koralewski   fixing CSS and JS...
1569

a6e63604   Alexis Koralewski   adding agentSP an...
1570
1571
1572
class PyrosUserManager(UserManager):
    def tac_users(self):
        return PyrosUser.objects.filter(user_level__name="TAC")
1ba49504   Alexis Koralewski   fixing CSS and JS...
1573

a6e63604   Alexis Koralewski   adding agentSP an...
1574
    def unit_users(self):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1575
1576
        return PyrosUser.objects.filter(Q(user_level__name="Unit-PI") | Q(user_level__name="Unit-board"))

a6e63604   Alexis Koralewski   adding agentSP an...
1577

5ce2836f   Alexis Koralewski   update models (ad...
1578
class PyrosUser(AbstractUser):
1ba49504   Alexis Koralewski   fixing CSS and JS...
1579
1580
    username = models.CharField(
        max_length=255, blank=False, null=False, unique=True)
5ce2836f   Alexis Koralewski   update models (ad...
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
    is_active = models.BooleanField(default='False')
    first_time = models.BooleanField(default='False')
    country = models.ForeignKey(
        Country, on_delete=models.DO_NOTHING, related_name="pyros_users")
    user_level = models.ManyToManyField(
        'UserLevel', related_name="pyros_users")
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    tel = models.CharField(max_length=45, blank=True, null=True)
    address = models.TextField(max_length=100, blank=True, null=True)
    laboratory = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1593
1594
    institute = models.ForeignKey(
        Institute, on_delete=DO_NOTHING, related_name="pyros_users")
5ce2836f   Alexis Koralewski   update models (ad...
1595
    is_institute_representative = models.BooleanField(default=False)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1596
1597
    motive_of_registration = models.TextField(
        max_length=300, blank=False, default="")
5ce2836f   Alexis Koralewski   update models (ad...
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
    # last_connect = models.DateTimeField(blank=True, null=True)
    # cur_connect = models.DateTimeField(blank=True, null=True)
    # putvalid_beg = models.DateTimeField(blank=True, null=True)
    # putvalid_end = models.DateTimeField(blank=True, null=True)
    # acqvalid_beg = models.CharField(max_length=45, blank=True, null=True)
    # acqvalid_end = models.CharField(max_length=45, blank=True, null=True)
    # quota = models.FloatField(blank=True, null=True)
    # quota_rea = models.FloatField(blank=True, null=True)
    # u_priority = models.IntegerField(blank=True, null=True)
    # p_priority = models.IntegerField(blank=True, null=True)
    # dir_level = models.IntegerField(blank=True, null=True)
    # can_del_void_req = models.BooleanField(default=False)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1610
1611
1612
1613
    validator = models.ForeignKey(
        "PyrosUser", on_delete=models.DO_NOTHING, null=True, related_name="pyros_users")
    referee_themes = models.ManyToManyField(
        "ScienceTheme", related_name="referee_themes", blank=True)
a6e63604   Alexis Koralewski   adding agentSP an...
1614
1615

    objects = PyrosUserManager()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1616

5ce2836f   Alexis Koralewski   update models (ad...
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
    class Meta:
        managed = True
        db_table = 'pyros_user'

    def __str__(self):
        return (str(self.get_username()))

    def user_username(self):
        return self.__str__()
    user_username.short_description = "Username"

1ba49504   Alexis Koralewski   fixing CSS and JS...
1628
    def get_priority(self) -> int:
5ce2836f   Alexis Koralewski   update models (ad...
1629
1630
1631
1632
1633
1634
        """
        return maximum priority of all roles of the user

        Returns:
            int: maximum priority
        """
1ba49504   Alexis Koralewski   fixing CSS and JS...
1635
        return PyrosUser.objects.get(id=self.id).user_level.all().aggregate(Max("priority"))["priority__max"]
5ce2836f   Alexis Koralewski   update models (ad...
1636

1ba49504   Alexis Koralewski   fixing CSS and JS...
1637
    def get_roles_str(self) -> str:
5ce2836f   Alexis Koralewski   update models (ad...
1638
1639
1640
1641
1642
1643
1644
1645
        """
        return string that represent all roles assigned to the user

        Returns:
            str: string of all roles assigned to user
        """
        roles_str = ""
        # loop on all roles assigned to user
1ba49504   Alexis Koralewski   fixing CSS and JS...
1646
1647
        for role in PyrosUser.objects.get(id=self.id).user_level.all():
            roles_str += role.name + ", "
5ce2836f   Alexis Koralewski   update models (ad...
1648
1649
        return roles_str[:-2]

1ba49504   Alexis Koralewski   fixing CSS and JS...
1650
    def get_list_of_roles(self) -> list:
5ce2836f   Alexis Koralewski   update models (ad...
1651
1652
1653
1654
1655
1656
        """
        return list of all roles assigned to the user

        Returns:
            list: list of all roles assigned to user
        """
1ba49504   Alexis Koralewski   fixing CSS and JS...
1657
        return PyrosUser.objects.get(id=self.id).user_level.all().values_list("name", flat=True)
5ce2836f   Alexis Koralewski   update models (ad...
1658
1659

    # Note for the next functions : We take the first result of the query because it should be only one result with the filter applied since each UserLevel has a unique priority.
1ba49504   Alexis Koralewski   fixing CSS and JS...
1660
    def get_max_priority_desc(self) -> str:
5ce2836f   Alexis Koralewski   update models (ad...
1661
1662
1663
1664
1665
1666
        """
        return the desc of the maximum priority of all roles assigned to user

        Returns:
            str:  desc of the maximum priority of all roles assigned to user
        """
1ba49504   Alexis Koralewski   fixing CSS and JS...
1667
        return PyrosUser.objects.get(id=self.id).user_level.filter(priority=self.get_priority())[0].desc
5ce2836f   Alexis Koralewski   update models (ad...
1668

1ba49504   Alexis Koralewski   fixing CSS and JS...
1669
    def get_max_priority_quota(self) -> int:
5ce2836f   Alexis Koralewski   update models (ad...
1670
1671
1672
1673
1674
1675
        """
        return the quota of the maximum priority of all roles assigned to user

        Returns:
            int:  quota of the maximum priority of all roles assigned to user
        """
1ba49504   Alexis Koralewski   fixing CSS and JS...
1676
        return PyrosUser.objects.get(id=self.id).user_level.filter(priority=self.get_priority())[0].quota
5ce2836f   Alexis Koralewski   update models (ad...
1677

1ba49504   Alexis Koralewski   fixing CSS and JS...
1678
    def get_referee_themes_as_str(self) -> str:
077d5a23   Alexis Koralewski   adding science th...
1679
1680
1681
        """
        Return the list of science themes associated to that user if user is a TAC.
        Return empty string otherwise
5ce2836f   Alexis Koralewski   update models (ad...
1682

077d5a23   Alexis Koralewski   adding science th...
1683
1684
1685
1686
1687
        Returns:
            str: list of science themes associated to that user
        """
        str = ""
        if self.referee_themes != None:
1ba49504   Alexis Koralewski   fixing CSS and JS...
1688
1689
            for science_theme in PyrosUser.objects.get(id=self.id).referee_themes.all():
                str += science_theme.name + ", "
077d5a23   Alexis Koralewski   adding science th...
1690
1691
1692
            return str[:-2]
        else:
            return str
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1693

4a596eec   Alexis Koralewski   Updating SP, Sequ...
1694
    def get_scientific_program(self) -> QuerySet:
1ba49504   Alexis Koralewski   fixing CSS and JS...
1695
1696
1697
1698
        sp_where_user_is_sp_pi = ScientificProgram.objects.filter(
            sp_pi=self.id)
        other_sp_of_user = ScientificProgram.objects.filter(id__in=SP_Period.objects.filter(id__in=SP_Period_User.objects.filter(
            user=PyrosUser.objects.get(username=self.username)).values("SP_Period")).values_list("scientific_program", flat=True))
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1699
1700
        sp_of_user = sp_where_user_is_sp_pi | other_sp_of_user
        return sp_of_user
1ba49504   Alexis Koralewski   fixing CSS and JS...
1701

ad3b297c   Alexis Koralewski   add pagination to...
1702
    def get_scientific_program_where_user_is_sp_pi(self) -> QuerySet:
1ba49504   Alexis Koralewski   fixing CSS and JS...
1703
1704
        sp_where_user_is_sp_pi = ScientificProgram.objects.filter(
            sp_pi=self.id)
ad3b297c   Alexis Koralewski   add pagination to...
1705
        return sp_where_user_is_sp_pi
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1706

5ce2836f   Alexis Koralewski   update models (ad...
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
# class Schedule(models.Model):
#     created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
#     plan_start = models.DecimalField(
#         default=0.0, max_digits=15, decimal_places=8)
#     plan_end = models.DecimalField(
#         default=0.0, max_digits=15, decimal_places=8)
#     flag = models.CharField(max_length=45, blank=True, null=True)
#
#     class Meta:
#         managed = True
#         db_table = 'schedule'
#
#     def __str__(self):
#         return (str(self.created))


class Schedule(models.Model):
    sequences = models.ManyToManyField(
        'Sequence', through='ScheduleHasSequences', related_name='schedules')
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    plan_night_start = models.DecimalField(
        default=0.0, max_digits=15, decimal_places=8)
    plan_end = models.DecimalField(
        default=0.0, max_digits=15, decimal_places=8)
    plan_start = models.DecimalField(
        default=0.0, max_digits=15, decimal_places=8)
    flag = models.CharField(max_length=45, blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'schedule'
        verbose_name_plural = "Schedules"

    def __str__(self):
        return (str(self.created))

1ba49504   Alexis Koralewski   fixing CSS and JS...
1743

5a434264   Alexis Koralewski   New version of Sc...
1744
class PeriodManager(models.Manager):
077d5a23   Alexis Koralewski   adding science th...
1745
    # to get the currently active period, use exploitation_period()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1746
    def currently_active_period(self) -> QuerySet:
5a434264   Alexis Koralewski   New version of Sc...
1747
        today = timezone.now().date()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1748
        return Period.objects.get(start_date__lte=today, end_date__gt=today)
5ce2836f   Alexis Koralewski   update models (ad...
1749

1ba49504   Alexis Koralewski   fixing CSS and JS...
1750
    def submission_periods(self) -> QuerySet:
077d5a23   Alexis Koralewski   adding science th...
1751
1752
1753
1754
        today = timezone.now().date()
        submission_periods_id = []
        periods = Period.objects.filter(start_date__gte=today)
        for period in periods:
077d5a23   Alexis Koralewski   adding science th...
1755
1756
1757
1758
1759
            if period.submission_start_date <= today and period.submission_end_date > today:
                submission_periods_id.append(period.id)
        periods = periods.filter(id__in=submission_periods_id)
        return periods

1ba49504   Alexis Koralewski   fixing CSS and JS...
1760
    def evaluation_periods(self) -> QuerySet:
077d5a23   Alexis Koralewski   adding science th...
1761
1762
1763
1764
1765
1766
1767
1768
1769
        today = timezone.now().date()
        evaluation_periods_id = []
        periods = Period.objects.filter(start_date__gte=today)
        for period in periods:
            if period.submission_end_date <= today and period.unit_pi_validation_start_date > today:
                evaluation_periods_id.append(period.id)
        periods = periods.filter(id__in=evaluation_periods_id)
        return periods

1ba49504   Alexis Koralewski   fixing CSS and JS...
1770
    def validation_periods(self) -> QuerySet:
077d5a23   Alexis Koralewski   adding science th...
1771
1772
1773
1774
        today = timezone.now().date()
        validation_periods_id = []
        periods = Period.objects.filter(start_date__gte=today)
        for period in periods:
a6e63604   Alexis Koralewski   adding agentSP an...
1775
            if period.unit_pi_validation_start_date <= today and period.notification_start_date > today:
077d5a23   Alexis Koralewski   adding science th...
1776
1777
1778
1779
                validation_periods_id.append(period.id)
        periods = periods.filter(id__in=validation_periods_id)
        return periods

1ba49504   Alexis Koralewski   fixing CSS and JS...
1780
    def notification_periods(self) -> QuerySet:
077d5a23   Alexis Koralewski   adding science th...
1781
1782
1783
1784
        today = timezone.now().date()
        notification_periods_id = []
        periods = Period.objects.filter(start_date__gte=today)
        for period in periods:
a6e63604   Alexis Koralewski   adding agentSP an...
1785
            if period.notification_start_date <= today and period.start_date > today:
077d5a23   Alexis Koralewski   adding science th...
1786
1787
1788
1789
                notification_periods_id.append(period.id)
        periods = periods.filter(id__in=notification_periods_id)
        return periods

1ba49504   Alexis Koralewski   fixing CSS and JS...
1790
    def exploitation_period(self) -> any:
077d5a23   Alexis Koralewski   adding science th...
1791
1792
1793
1794
1795
1796
1797
        today = timezone.now().date()
        periods = Period.objects.filter(start_date__lte=today)
        for period in periods:
            if period.start_date <= today and period.end_date > today:
                return period
        return None

1ba49504   Alexis Koralewski   fixing CSS and JS...
1798
    def latest_period(self) -> any:
077d5a23   Alexis Koralewski   adding science th...
1799
        today = timezone.now().date()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1800
1801
        future_period = Period.objects.filter(
            start_date__gt=today).order_by("-start_date").first()
077d5a23   Alexis Koralewski   adding science th...
1802
1803
1804
1805
        if future_period is None:
            # no future period defined so we return the current period
            return self.exploitation_period()
        return future_period
1ba49504   Alexis Koralewski   fixing CSS and JS...
1806
1807

    def previous_periods(self) -> any:
077d5a23   Alexis Koralewski   adding science th...
1808
        today = timezone.now().date()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1809
1810
        previous_periods = Period.objects.filter(start_date__lt=today).order_by(
            "-start_date").exclude(id=self.exploitation_period().id)
077d5a23   Alexis Koralewski   adding science th...
1811
        return previous_periods
1ba49504   Alexis Koralewski   fixing CSS and JS...
1812
1813

    def next_period(self) -> any:
a6e63604   Alexis Koralewski   adding agentSP an...
1814
        current_period = self.exploitation_period()
1ba49504   Alexis Koralewski   fixing CSS and JS...
1815
1816
        next_period = Period.objects.filter(
            start_date__gt=current_period.start_date).order_by("start_date").first()
a6e63604   Alexis Koralewski   adding agentSP an...
1817
1818
        return next_period

077d5a23   Alexis Koralewski   adding science th...
1819

5ce2836f   Alexis Koralewski   update models (ad...
1820
class Period(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1821
1822
    # if change of default value, those values need to be changed also in create_period and edit_period.html (Javascript )
    today = timezone.now().date()
5ce2836f   Alexis Koralewski   update models (ad...
1823
    today_plus_six_months = today + relativedelta(months=+6)
5a434264   Alexis Koralewski   New version of Sc...
1824
    today_minus_six_months = today + relativedelta(months=-6)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1825
1826
    today_minus_one_month_and_half = today + \
        relativedelta(months=-1) + relativedelta(days=-15)
5a434264   Alexis Koralewski   New version of Sc...
1827
1828
    today_minus_fifteen_days = today + relativedelta(days=-15)
    end_date_plus_one_year = today_plus_six_months + relativedelta(years=+1)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
    end_date_plus_eleven_year = today_plus_six_months + \
        relativedelta(years=+11)

    start_date = models.DateField(
        blank=True, null=True, default=timezone.now, editable=True)

    exploitation_duration = models.PositiveIntegerField(
        blank=True, null=True, default=182, editable=True)
    submission_duration = models.PositiveIntegerField(
        blank=True, null=True, default=136, editable=True)
    evaluation_duration = models.PositiveIntegerField(
        blank=True, null=True, default=31, editable=True)
    validation_duration = models.PositiveIntegerField(
        blank=True, null=True, default=5, editable=True)
    notification_duration = models.PositiveIntegerField(
        blank=True, null=True, default=10, editable=True)
    property_of_data_duration = models.PositiveIntegerField(
        blank=True, null=True, default=365, editable=True)
    data_accessibility_duration = models.PositiveIntegerField(
        blank=True, null=True, default=365*10, editable=True)
077d5a23   Alexis Koralewski   adding science th...
1849
1850
1851
1852
1853
1854
1855

    @property
    def end_date(self):
        return self.start_date + relativedelta(days=self.exploitation_duration)

    @property
    def submission_start_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1856
        return self.start_date + relativedelta(days=-(self.submission_duration+self.evaluation_duration+self.validation_duration+self.notification_duration))
1ba49504   Alexis Koralewski   fixing CSS and JS...
1857

077d5a23   Alexis Koralewski   adding science th...
1858
1859
    @property
    def submission_end_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1860
        return self.submission_start_date + relativedelta(days=self.submission_duration)
077d5a23   Alexis Koralewski   adding science th...
1861
1862
1863

    @property
    def unit_pi_validation_start_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1864
        return self.submission_end_date + relativedelta(days=self.evaluation_duration)
077d5a23   Alexis Koralewski   adding science th...
1865
1866
1867

    @property
    def notification_start_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1868
        return self.unit_pi_validation_start_date + relativedelta(days=self.validation_duration)
077d5a23   Alexis Koralewski   adding science th...
1869
1870
1871
1872
1873
1874
1875
1876
1877

    @property
    def property_of_data_end_date(self):
        return self.end_date + relativedelta(days=self.property_of_data_duration)

    @property
    def data_accessibility_end_date(self):
        return self.end_date + relativedelta(days=self.data_accessibility_duration)

077d5a23   Alexis Koralewski   adding science th...
1878
1879
    """
    end_date =  models.DateField(blank=True, null=True, default=start_date_plus_six_months,editable=True)    
5a434264   Alexis Koralewski   New version of Sc...
1880
1881
1882
1883
1884
    submission_start_date = models.DateField(blank=True, null=True, default=today_minus_six_months,editable=True)    
    submission_end_date = models.DateField(blank=True, null=True, default=today_minus_one_month_and_half,editable=True)    
    unit_pi_validation_start_date = models.DateField(blank=True, null=True, default=today_minus_fifteen_days,editable=True)    
    property_of_data_end_date = models.DateField(blank=True, null=True, default=end_date_plus_one_year,editable=True)     
    data_accessibility_end_date = models.DateField(blank=True, null=True, default=end_date_plus_eleven_year,editable=True)    
077d5a23   Alexis Koralewski   adding science th...
1885
1886
    
    #class Meta:
5ce2836f   Alexis Koralewski   update models (ad...
1887
        # constrains start_date and duration to be unique (We don't want to have multiple records in db that represent the same period)
077d5a23   Alexis Koralewski   adding science th...
1888
1889
1890
    #    constraints = [
    #        models.UniqueConstraint(fields=["start_date","duration"], name="unique_period")   
    #    ]
5ce2836f   Alexis Koralewski   update models (ad...
1891
    """
5a434264   Alexis Koralewski   New version of Sc...
1892
1893

    objects = PeriodManager()
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1894

5ce2836f   Alexis Koralewski   update models (ad...
1895
    def __str__(self) -> str:
1ba49504   Alexis Koralewski   fixing CSS and JS...
1896
        return "P"+str(self.id)+" ("+self.start_date.strftime("%d/%m/%Y") + " to " + self.end_date.strftime("%d/%m/%Y")+")"
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1897

1ba49504   Alexis Koralewski   fixing CSS and JS...
1898
    def is_currently_active(self) -> bool:
5a434264   Alexis Koralewski   New version of Sc...
1899
        today = timezone.now().date()
fce7ff0f   Alexis Koralewski   Change of compari...
1900
        return self.start_date <= today < self.end_date
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1901
1902
1903
1904

    def can_submit_sequence(self) -> bool:
        today = timezone.now().date()
        return today >= self.notification_start_date
1ba49504   Alexis Koralewski   fixing CSS and JS...
1905

864ec466   Alexis Koralewski   Renaming common t...
1906
1907
1908
    class Meta:
        db_table = "period"

5a434264   Alexis Koralewski   New version of Sc...
1909

4a596eec   Alexis Koralewski   Updating SP, Sequ...
1910
1911
1912
class ScientificProgramManager(models.Manager):
    def observable_programs(self):
        exploitable_sp = []
1ba49504   Alexis Koralewski   fixing CSS and JS...
1913

4a596eec   Alexis Koralewski   Updating SP, Sequ...
1914
1915
        for sp_period in SP_Period.objects.all():
            if sp_period.can_submit_sequence():
1ba49504   Alexis Koralewski   fixing CSS and JS...
1916
                exploitable_sp.append(sp_period.scientific_program.id)
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1917
1918
        return ScientificProgram.objects.filter(id__in=exploitable_sp)

5a434264   Alexis Koralewski   New version of Sc...
1919

5ce2836f   Alexis Koralewski   update models (ad...
1920
class ScientificProgram(models.Model):
5ce2836f   Alexis Koralewski   update models (ad...
1921

1ba49504   Alexis Koralewski   fixing CSS and JS...
1922
1923
1924
1925
1926
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    name = models.CharField(max_length=30, blank=False,
                            null=False, default="", unique=True)
    description_short = models.TextField(default="", max_length=320)
5a434264   Alexis Koralewski   New version of Sc...
1927
    description_long = models.TextField(default="")
1ba49504   Alexis Koralewski   fixing CSS and JS...
1928
1929
1930
1931
1932
1933
    institute = models.ForeignKey(
        Institute, on_delete=models.DO_NOTHING, related_name="scientific_programs")
    sp_pi = models.ForeignKey(
        "PyrosUser", on_delete=models.DO_NOTHING, related_name="Scientific_Program_Users")
    science_theme = models.ForeignKey(
        "ScienceTheme", on_delete=models.DO_NOTHING, related_name="scientific_program_theme", default=1)
5a434264   Alexis Koralewski   New version of Sc...
1934
    is_auto_validated = models.BooleanField(default=False)
4a596eec   Alexis Koralewski   Updating SP, Sequ...
1935
1936
    objects = ScientificProgramManager()

5ce2836f   Alexis Koralewski   update models (ad...
1937
1938
1939
1940
    class Meta:
        managed = True
        db_table = 'scientific_program'

5ce2836f   Alexis Koralewski   update models (ad...
1941
1942
1943
    def __str__(self):
        return (str(self.name))

4a596eec   Alexis Koralewski   Updating SP, Sequ...
1944

5ce2836f   Alexis Koralewski   update models (ad...
1945
class SP_Period(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1946
1947
1948
1949
1950
1951
    STATUSES_DRAFT = "Draft"
    STATUSES_SUBMITTED = "Submitted"
    STATUSES_EVALUATED = "Evaluated"
    STATUSES_ACCEPTED = "Accepted"
    STATUSES_REJECTED = "Rejected"
    STATUSES = [
1ba49504   Alexis Koralewski   fixing CSS and JS...
1952
1953
1954
1955
1956
        (STATUSES_DRAFT, "Draft"),
        (STATUSES_SUBMITTED, "Submitted"),
        (STATUSES_EVALUATED, "Evaluated"),
        (STATUSES_ACCEPTED, "Accepted"),
        (STATUSES_REJECTED, "Rejected")
5a434264   Alexis Koralewski   New version of Sc...
1957
1958
1959
1960
1961
    ]
    VOTES_YES = "A: Accepted"
    VOTES_NO = "C: Refused"
    VOTES_TO_DISCUSS = "B: To be discussed"
    VOTES = [
1ba49504   Alexis Koralewski   fixing CSS and JS...
1962
1963
1964
        (VOTES_YES, "A: Accepted"),
        (VOTES_TO_DISCUSS, "B: To be discussed"),
        (VOTES_NO, "C: Refused")
5a434264   Alexis Koralewski   New version of Sc...
1965
1966
1967
1968
    ]
    IS_VALID_ACCEPTED = "Accepted"
    IS_VALID_REJECTED = "Rejected"
    IS_VALID = [
1ba49504   Alexis Koralewski   fixing CSS and JS...
1969
1970
        (IS_VALID_ACCEPTED, "Accepted"),
        (IS_VALID_REJECTED, "Rejected")
5a434264   Alexis Koralewski   New version of Sc...
1971
1972
1973
1974
1975
    ]

    VISIBILITY_YES = "Yes"
    VISIBILITY_NO = "No"
    VISIBILITY_CHOICES = [
1ba49504   Alexis Koralewski   fixing CSS and JS...
1976
1977
        (VISIBILITY_YES, "Yes"),
        (VISIBILITY_NO, "No"),
5a434264   Alexis Koralewski   New version of Sc...
1978
    ]
1ba49504   Alexis Koralewski   fixing CSS and JS...
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
    period = models.ForeignKey(
        Period, on_delete=models.DO_NOTHING, related_name="SP_Periods")
    scientific_program = models.ForeignKey(
        ScientificProgram, on_delete=models.DO_NOTHING, related_name="SP_Periods")
    public_visibility = models.TextField(
        choices=VISIBILITY_CHOICES, default=VISIBILITY_YES)
    referee1 = models.ForeignKey(
        PyrosUser, on_delete=models.DO_NOTHING, related_name="TAC1_judgement", null=True)
    vote_referee1 = models.TextField(
        choices=VOTES, default=VOTES_YES, blank=True)
5a434264   Alexis Koralewski   New version of Sc...
1989
    reason_referee1 = models.TextField(blank=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1990
1991
1992
1993
    referee2 = models.ForeignKey(
        PyrosUser, on_delete=models.DO_NOTHING, related_name="TAC2_judgement", null=True)
    vote_referee2 = models.TextField(
        choices=VOTES, default=VOTES_YES, blank=True)
5a434264   Alexis Koralewski   New version of Sc...
1994
    reason_referee2 = models.TextField(blank=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
1995
1996
1997
    is_valid = models.TextField(
        choices=IS_VALID, default=IS_VALID_REJECTED, blank=True)
    status = models.TextField(choices=STATUSES, default=STATUSES_DRAFT)
5a434264   Alexis Koralewski   New version of Sc...
1998
1999
    quota_minimal = models.PositiveIntegerField(default=0)
    quota_nominal = models.PositiveIntegerField(default=0)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2000
2001
    quota_allocated = models.PositiveIntegerField(default=0, blank=True)
    quota_remaining = models.PositiveIntegerField(default=0, blank=True)
5a434264   Alexis Koralewski   New version of Sc...
2002
    over_quota_duration = models.PositiveIntegerField(default=0)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2003
2004
2005
    over_quota_duration_allocated = models.PositiveIntegerField(
        default=0, blank=True)
    over_quota_duration_remaining = models.PositiveIntegerField(default=0)
5a434264   Alexis Koralewski   New version of Sc...
2006
    token = models.PositiveIntegerField(default=0)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2007
2008
2009
    token_allocated = models.PositiveIntegerField(default=0, blank=True)
    token_remaining = models.PositiveIntegerField(default=0, blank=True)
    priority = models.PositiveIntegerField(default=0, blank=True)
5a434264   Alexis Koralewski   New version of Sc...
2010

5ce2836f   Alexis Koralewski   update models (ad...
2011
2012
    def is_currently_active(self):
        return self.period.is_currently_active()
5a434264   Alexis Koralewski   New version of Sc...
2013

4a596eec   Alexis Koralewski   Updating SP, Sequ...
2014
2015
2016
    def can_submit_sequence(self) -> bool:
        return self.is_currently_active() or self.period.can_submit_sequence() and self.status == self.STATUSES_ACCEPTED

864ec466   Alexis Koralewski   Renaming common t...
2017
2018
    class Meta:
        db_table = "sp_period"
1ba49504   Alexis Koralewski   fixing CSS and JS...
2019

5ce2836f   Alexis Koralewski   update models (ad...
2020
class SP_Period_User(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
2021
2022
2023
2024
    SP_Period = models.ForeignKey(
        SP_Period, on_delete=models.DO_NOTHING, related_name="SP_Period_Users")
    user = models.ForeignKey(
        "PyrosUser", on_delete=models.CASCADE, related_name="SP_Period_Users")
5a434264   Alexis Koralewski   New version of Sc...
2025
    #is_SP_PI = models.BooleanField(default=False)
5ce2836f   Alexis Koralewski   update models (ad...
2026

5a434264   Alexis Koralewski   New version of Sc...
2027
2028
    class Meta:
        unique_together = ('SP_Period', 'user')
864ec466   Alexis Koralewski   Renaming common t...
2029
        db_table = "sp_period_user"
1ba49504   Alexis Koralewski   fixing CSS and JS...
2030
2031


5a434264   Alexis Koralewski   New version of Sc...
2032
class SP_Period_Guest(models.Model):
1ba49504   Alexis Koralewski   fixing CSS and JS...
2033
2034
    SP_Period = models.ForeignKey(
        SP_Period, on_delete=models.DO_NOTHING, related_name="SP_Period_Guests")
5a434264   Alexis Koralewski   New version of Sc...
2035
    email = models.EmailField(max_length=254)
a6e63604   Alexis Koralewski   adding agentSP an...
2036

864ec466   Alexis Koralewski   Renaming common t...
2037
2038
    class Meta:
        db_table = "sp_period_guest"
1ba49504   Alexis Koralewski   fixing CSS and JS...
2039

a6e63604   Alexis Koralewski   adding agentSP an...
2040
2041
2042
2043
2044
2045
class SP_PeriodWorkflow(models.Model):
    SUBMISSION = "SUB"
    EVALUATION = "EVAL"
    VALIDATION = "VALI"
    NOTIFICATION = "NOTI"
    ACTIONS_CHOICES = (
1ba49504   Alexis Koralewski   fixing CSS and JS...
2046
2047
2048
2049
        (SUBMISSION, "Submission"),
        (EVALUATION, "Evaluation"),
        (VALIDATION, "Validation"),
        (NOTIFICATION, "Notification")
a6e63604   Alexis Koralewski   adding agentSP an...
2050
    )
1ba49504   Alexis Koralewski   fixing CSS and JS...
2051
2052
2053
    action = models.CharField(max_length=120, choices=ACTIONS_CHOICES)
    period = models.ForeignKey(
        "Period", on_delete=models.DO_NOTHING, related_name="SP_Period_Workflows")
a6e63604   Alexis Koralewski   adding agentSP an...
2054
2055
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)

864ec466   Alexis Koralewski   Renaming common t...
2056
2057
    class Meta:
        db_table = "sp_period_workflow"
1ba49504   Alexis Koralewski   fixing CSS and JS...
2058

5ce2836f   Alexis Koralewski   update models (ad...
2059
class Sequence(models.Model):
5ce2836f   Alexis Koralewski   update models (ad...
2060
2061

    """ Definition of Status enum values """
ad3b297c   Alexis Koralewski   add pagination to...
2062
2063
    INVALID = "INVL"
    DRAFT = "DRAFT"
5ce2836f   Alexis Koralewski   update models (ad...
2064

ad3b297c   Alexis Koralewski   add pagination to...
2065
2066
    # INCOMPLETE = "INCPL"
    # COMPLETE = "CPL"
5ce2836f   Alexis Koralewski   update models (ad...
2067
2068
    TOBEPLANNED = "TBP"
    PLANNED = "PLND"
ad3b297c   Alexis Koralewski   add pagination to...
2069
    UNPLANNABLE = "UNPLN"
5ce2836f   Alexis Koralewski   update models (ad...
2070
    REJECTED = "RJTD"
ad3b297c   Alexis Koralewski   add pagination to...
2071
2072
2073
2074
2075
2076
2077
2078
2079
    REC_RUNNING = "RUN"
    REC_FINISHED = "EXD"
    REC_CANCELED = "CNCLD"
    PROC_RUNNING = "PROC_RUN"
    PROC_CANCELED = "PROC_CNCLD"
    PROC_FINISHED = "PROC_EXD"
    # PENDING = "PNDG"
    # EXECUTING = "EXING"
    # EXECUTED = "EXD"
5ce2836f   Alexis Koralewski   update models (ad...
2080
    CANCELLED = "CNCLD"
5ce2836f   Alexis Koralewski   update models (ad...
2081
    STATUS_CHOICES = (
ad3b297c   Alexis Koralewski   add pagination to...
2082
2083
        (INVALID, "Invalid"),
        (DRAFT, "DRAFT"),
5ce2836f   Alexis Koralewski   update models (ad...
2084
2085
2086
        (TOBEPLANNED, "To be planned"),
        (PLANNED, "Planned"),
        (UNPLANNABLE, "Unplannable"),
5ce2836f   Alexis Koralewski   update models (ad...
2087
        (REJECTED, "Rejected"),
ad3b297c   Alexis Koralewski   add pagination to...
2088
        (REC_RUNNING, "Recording running"),
1ba49504   Alexis Koralewski   fixing CSS and JS...
2089
        (REC_FINISHED, "Recording finished"),
ad3b297c   Alexis Koralewski   add pagination to...
2090
2091
2092
2093
        (REC_CANCELED, "Recording canceled"),
        (PROC_RUNNING, "Processing running"),
        (PROC_FINISHED, "Processing finished"),
        (PROC_CANCELED, "Processing canceled"),
5ce2836f   Alexis Koralewski   update models (ad...
2094
        (CANCELLED, "Cancelled"),
ad3b297c   Alexis Koralewski   add pagination to...
2095
2096
2097
2098
2099
    )
    START_EXPO_PREF_CHOICES = (
        ('IMMEDIATE', 'IMMEDIATE'),
        ('BEST_ELEVATION', 'BEST_ELEVATION'),
        ('NO_CONSTRAINT', 'NO_CONSTRAINT'),
5ce2836f   Alexis Koralewski   update models (ad...
2100
2101
    )

1ba49504   Alexis Koralewski   fixing CSS and JS...
2102
2103
2104
    start_expo_pref = models.CharField(max_length=50, blank=False, null=True,
                                       choices=START_EXPO_PREF_CHOICES, default=START_EXPO_PREF_CHOICES[0])
    # request = models.ForeignKey(
3b81a22b   Alexis Koralewski   Rework on Request...
2105
2106
    #    Request, on_delete=models.CASCADE, related_name="sequences")
    pyros_user = models.ForeignKey(
1ba49504   Alexis Koralewski   fixing CSS and JS...
2107
        'PyrosUser', on_delete=models.DO_NOTHING, related_name="sequences", blank=True, null=True)
3b81a22b   Alexis Koralewski   Rework on Request...
2108
2109
    scientific_program = models.ForeignKey(
        'ScientificProgram', on_delete=models.DO_NOTHING, related_name="sequences", blank=True, null=True)
bbf0ac6e   Alexis Koralewski   Adding unique con...
2110
    name = models.CharField(max_length=45, blank=True, null=True, unique=True)
5ce2836f   Alexis Koralewski   update models (ad...
2111
2112
2113
    desc = models.TextField(blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
bce55cd9   Alexis Koralewski   Reworking Sequenc...
2114
2115
    last_modified_by =  models.ForeignKey(
        'PyrosUser', on_delete=models.DO_NOTHING, related_name="+", blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
    is_alert = models.BooleanField(default=False)
    status = models.CharField(
        max_length=11, blank=True, null=True, choices=STATUS_CHOICES)
    target_coords = models.CharField(max_length=100, blank=True, null=True)
    with_drift = models.BooleanField(default=False)
    priority = models.IntegerField(blank=True, null=True)
    analysis_method = models.CharField(max_length=45, blank=True, null=True)
    moon_min = models.IntegerField(blank=True, null=True)
    alt_min = models.IntegerField(blank=True, null=True)
    type = models.CharField(max_length=6, blank=True, null=True)
    img_current = models.CharField(max_length=45, blank=True, null=True)
    img_total = models.CharField(max_length=45, blank=True, null=True)
    not_obs = models.BooleanField(default=False)
    obsolete = models.BooleanField(default=False)
    processing = models.BooleanField(default=False)
    flag = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2132
2133
2134
2135
2136
2137
2138
2139
    period = models.ForeignKey(
        "Period", on_delete=models.DO_NOTHING, related_name="sequences", blank=True, null=True)

    start_date = models.DateTimeField(
        blank=True, null=True, default=timezone.now, editable=True)
    end_date = models.DateTimeField(
        blank=True, null=True, default=timezone.now, editable=True)
    # jd1 et jd2 = julian day start / end
5ce2836f   Alexis Koralewski   update models (ad...
2140
2141
    jd1 = models.DecimalField(default=0.0, max_digits=15, decimal_places=8)
    jd2 = models.DecimalField(default=0.0, max_digits=15, decimal_places=8)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2142
2143
2144
2145
2146
    tolerance_before = models.CharField(
        max_length=50, default="1s", blank=True, null=True)
    tolerance_after = models.CharField(
        max_length=50, default="1min", blank=True, null=True)

ad3b297c   Alexis Koralewski   add pagination to...
2147
    #t_prefered = models.DecimalField(default=-1.0, max_digits=15, decimal_places=8)
5ce2836f   Alexis Koralewski   update models (ad...
2148
2149
    duration = models.DecimalField(
        default=-1.0, max_digits=15, decimal_places=8)
077d5a23   Alexis Koralewski   adding science th...
2150
    # décomposer duration en duration pointing + duration album
5ce2836f   Alexis Koralewski   update models (ad...
2151
    overhead = models.DecimalField(default=0, max_digits=15, decimal_places=8)
3b81a22b   Alexis Koralewski   Rework on Request...
2152
    submitted = models.BooleanField(default=False)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2153
    config_attributes = models.JSONField(blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
2154
2155
2156

    ra = models.FloatField(blank=True, null=True)
    dec = models.FloatField(blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2157
    complete = models.BooleanField(default=False, null=True, blank=True)
5ce2836f   Alexis Koralewski   update models (ad...
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203

    class Meta:
        managed = True
        db_table = 'sequence'

    def __str__(self):
        return (str(self.name))


class ScheduleHasSequences(models.Model):
    # (EP) TODO: C'est pas un pb d'utiliser 2 fois le meme nom "shs" pour 2 choses differentes ???!!!
    schedule = models.ForeignKey(
        'Schedule', on_delete=models.CASCADE, related_name="shs")
    sequence = models.ForeignKey(
        'Sequence', on_delete=models.CASCADE, related_name="shs")

    status = models.CharField(
        max_length=11, blank=True, null=True, choices=Sequence.STATUS_CHOICES)
    desc = models.CharField(max_length=45, blank=True, null=True)
    tsp = models.DecimalField(default=-1.0, max_digits=15, decimal_places=8)
    tep = models.DecimalField(default=-1.0, max_digits=15, decimal_places=8)
    deltaTL = models.DecimalField(
        default=-1.0, max_digits=15, decimal_places=8)
    deltaTR = models.DecimalField(
        default=-1.0, max_digits=15, decimal_places=8)

    class Meta:
        managed = True
        db_table = 'schedule_has_sequences'


class SiteWatch(models.Model):
    OPEN = "OPEN"
    CLOSE = "CLOSE"
    ON = "ON"
    OFF = "OFF"

    global_status = models.CharField(max_length=255, blank=True, null=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    lights = models.CharField(max_length=45, blank=True, null=True)
    dome = models.CharField(max_length=45, blank=True, null=True)
    doors = models.CharField(max_length=45, blank=True, null=True)
    temperature = models.FloatField(blank=True, null=True)
    shutter = models.FloatField(blank=True, null=True)
    pressure = models.FloatField(blank=True, null=True)
    humidity = models.FloatField(blank=True, null=True)
9ee7867b   Alexis Koralewski   Fixing issue with...
2204
    power_input = models.IntegerField(blank=True, null=True)
b9068dc6   Alexis Koralewski   Adding WeatherWat...
2205
    
5ce2836f   Alexis Koralewski   update models (ad...
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
    class Meta:
        managed = True
        db_table = 'sitewatch'
        verbose_name_plural = "Site watches"

    def __str__(self):
        return (str(self.__dict__))

    # TODO
    def setGlobalStatus(self):
        self.global_status = ""
        if self.doors and self.doors.find("open") != -1:
            self.global_status += "DOOR_OPEN "
        if self.lights and self.lights == "on":
            self.global_status += "LIGHTS_ON "
        if self.temperature and float(self.temperature) > 40:
            self.global_status += "TOO_HOT "
        if self.humidity and float(self.humidity) > 80:
            self.global_status += "HUMIDITY_TOO_HIGH "
        if self.global_status == "":
            self.global_status = "OK"
        return 0

    # TODO HANDLE FLAT LAMPS ...
    def setAttribute(self, key, value):
        self.doors = ""
        if key == "InsideHumidity":
            self.humidity = value
        elif key == "Pressure":
            self.pressure = value
        elif key == "InsideTemp":
            self.temperature = value
b9068dc6   Alexis Koralewski   Adding WeatherWat...
2238
2239
2240
        elif key == "Roof_state":
            self.dome = value
        elif key == "Power_input":
9ee7867b   Alexis Koralewski   Fixing issue with...
2241
            self.power_input = value
5ce2836f   Alexis Koralewski   update models (ad...
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
        else:
            return 1
        return 0


class SiteWatchHistory(models.Model):
    id = models.IntegerField(primary_key=True)

    class Meta:
        managed = True
        db_table = 'sitewatchhistory'
        verbose_name_plural = "Site watch histories"


class StrategyObs(models.Model):
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    xml_file = models.CharField(max_length=45, blank=True, null=True)
    is_default = models.BooleanField(default=False)

    class Meta:
        managed = True
        db_table = 'strategyobs'
        verbose_name_plural = "Strategy obs"

    def __str__(self):
        return (str(self.name))


1ba49504   Alexis Koralewski   fixing CSS and JS...
2271
# TODO: à virer car utilisé pour Celery (ou bien à utiliser pour les agents)
5ce2836f   Alexis Koralewski   update models (ad...
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
class TaskId(models.Model):
    task = models.CharField(max_length=45, blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    task_id = models.CharField(max_length=45, blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'task_id'

    def __str__(self):
        return (str(self.task) + " - " + str(self.task_id))


5ce2836f   Alexis Koralewski   update models (ad...
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
class Telescope(Device):
    TELESCOPE = "Telescope"

    mount_type = models.CharField(max_length=9, blank=True, null=True)
    diameter = models.FloatField(blank=True, null=True)
    latitude = models.FloatField(blank=True, null=True)
    longitude = models.FloatField(blank=True, null=True)
    sens = models.CharField(max_length=1, blank=True, null=True)
    altitude = models.FloatField(blank=True, null=True)
    readout_time = models.IntegerField(blank=True, null=True)
    slew_time = models.IntegerField(blank=True, null=True)
    slew_dead = models.IntegerField(blank=True, null=True)
    slew_rate_max = models.FloatField(blank=True, null=True)
    horizon_type = models.CharField(max_length=45, blank=True, null=True)
    horizon_def = models.FloatField(blank=True, null=True)
    lim_dec_max = models.FloatField(blank=True, null=True)
    lim_dec_min = models.FloatField(blank=True, null=True)
    lim_ha_rise = models.FloatField(blank=True, null=True)
    lim_ha_set = models.FloatField(blank=True, null=True)
    address = models.CharField(max_length=45, blank=True, null=True)
    night_elev_sun = models.FloatField(blank=True, null=True)
    mpc_code = models.CharField(max_length=45, blank=True, null=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2307

5ce2836f   Alexis Koralewski   update models (ad...
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
    class Meta:
        managed = True
        db_table = 'telescope'

    def __str__(self):
        return (self.name)


class TelescopeCommand(models.Model):
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    answered = models.DateTimeField(blank=True, null=True)
    request = models.CharField(blank=False, null=False, max_length=255)
    answer = models.TextField(null=True, blank=True)
1ba49504   Alexis Koralewski   fixing CSS and JS...
2321

5ce2836f   Alexis Koralewski   update models (ad...
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
    class Meta:
        managed = True
        db_table = "telescopecommand"

    def __str__(self):
        return str(self.request) + str(self.created)


class UserLevel(models.Model):
    name = models.CharField(max_length=45, blank=True, null=True)
    desc = models.TextField(blank=True, null=True)
    priority = models.IntegerField(blank=True, null=True)
    quota = models.FloatField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'user_level'

    def __str__(self):
        return (str(self.name))


class Version(models.Model):
    module_name = models.CharField(max_length=45, blank=True, null=True)
    version = models.CharField(max_length=15, blank=True, null=True)
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)

    class Meta:
        managed = True
        db_table = 'version'

    def __str__(self):
        return (str(self.module_name) + " - " + str(self.version))


class WeatherWatch(models.Model):
    WIND_LIMIT = 100
    RAIN_LIMIT = 5

    global_status = models.CharField(max_length=255, blank=True, null=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    humidity = models.FloatField(blank=True, null=True)
    wind = models.FloatField(blank=True, null=True)
    wind_dir = models.CharField(max_length=45, blank=True, null=True)
    temperature = models.FloatField(blank=True, null=True)
    pressure = models.FloatField(blank=True, null=True)
    rain = models.FloatField(blank=True, null=True)
    cloud = models.FloatField(blank=True, null=True)

    class Meta:
        managed = True
        db_table = 'weatherwatch'
        verbose_name_plural = "Weather watches"

    def __str__(self):
        return (str(self.__dict__))

    # TODO
    def setGlobalStatus(self):
1ba49504   Alexis Koralewski   fixing CSS and JS...
2382
        # print(self.rain)
5ce2836f   Alexis Koralewski   update models (ad...
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
        self.global_status = ""
        if self.rain and float(self.rain) > 0:
            self.global_status += "RAINING "
        if self.wind and float(self.wind) > 80:
            self.global_status += "WIND_TOO_STRONG "
        if self.humidity and float(self.humidity) > 80:
            self.global_status += "HUMIDITY_TOO_HIGH "
        if self.cloud and float(self.cloud) > 10:
            self.global_status += "TOO_MUCH_CLOUDY "
        if self.global_status == "":
            self.global_status = "OK"
        return 0

    def setAttribute(self, key, value):
        if key == "Rain_boolean":
            self.rain = value
        elif key == "_CloudRate":
            self.cloud = value
        elif key == "Wind_speed":
            self.wind = value
        elif key == "Wind_direction":
            self.wind_dir = value
        elif key == "Temperature_outside":
            self.temperature = value
        elif key == "Humidity_outside":
            self.humidity = value
        elif key == "_Pressure":
            self.pressure = value
        else:
            return 1
        return 0


class WeatherWatchHistory(models.Model):
b9068dc6   Alexis Koralewski   Adding WeatherWat...
2417
    weather = models.ForeignKey('WeatherWatch', on_delete=models.DO_NOTHING, related_name="weatherhistory", null=True, blank=True)
5ce2836f   Alexis Koralewski   update models (ad...
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
    datetime = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    humid_int = models.FloatField(blank=True, null=True)
    humid_ext = models.CharField(max_length=45, blank=True, null=True)
    wind = models.CharField(max_length=45, blank=True, null=True)
    wind_dir = models.CharField(max_length=45, blank=True, null=True)
    temp_int = models.CharField(max_length=45, blank=True, null=True)
    temp_ext = models.CharField(max_length=45, blank=True, null=True)
    pressure = models.CharField(max_length=45, blank=True, null=True)
    rain = models.CharField(max_length=45, blank=True, null=True)
    dwn = models.CharField(max_length=45, blank=True, null=True)

800f4279   Alexis Koralewski   Updating WeatherW...
2429
2430
2431
2432
2433
2434
    humidity = models.FloatField(blank=True, null=True)
    wind = models.FloatField(blank=True, null=True)
    wind_dir = models.CharField(max_length=45, blank=True, null=True)
    temperature = models.FloatField(blank=True, null=True)
    cloud = models.FloatField(blank=True, null=True)

5ce2836f   Alexis Koralewski   update models (ad...
2435
2436
2437
2438
2439
2440
2441
    class Meta:
        managed = True
        db_table = 'weatherwatchhistory'
        verbose_name_plural = "Weather watch histories"

    def __str__(self):
        return (str(self.datetime))
b9068dc6   Alexis Koralewski   Adding WeatherWat...
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459

    def setAttribute(self, key, value):
        if key == "Rain_boolean":
            self.rain = value
        elif key == "_CloudRate":
            self.cloud = value
        elif key == "Wind_speed":
            self.wind = value
        elif key == "Wind_direction":
            self.wind_dir = value
        elif key == "Temperature_outside":
            self.temperature = value
        elif key == "Humidity_outside":
            self.humidity = value
        elif key == "_Pressure":
            self.pressure = value
        else:
            return 1
e186733f   Alexis Koralewski   Adding Majordome ...
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
        return 0

class Majordome(models.Model):
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField(blank=True, null=True, auto_now=True)
    # Software Modes
    AUTO_MODE = "AUTO"
    MANUAL_MODE = "MANUAL"
    SOFT_MODE_CHOICES = (
        (AUTO_MODE, 'Auto mode'),
        (MANUAL_MODE, 'Manual mode'),
    )
    DAY_MODE = "DAY"
    NIGHT_MODE = "NIGHT"
    OBS_MODE_CHOICES = (
        (DAY_MODE, "Day mode"),
        (NIGHT_MODE, "Night mode")
    )
    soft_mode = models.CharField(
        choices=SOFT_MODE_CHOICES,
        default=AUTO_MODE,
        max_length=15
    )
    
    obs_mode = models.CharField(
        choices = OBS_MODE_CHOICES,
        default = DAY_MODE,
        max_length=15
    )

    @classmethod
    def object(cls):
        return cls._default_manager.first() 

    def save(self, *args, **kwargs):
        self.pk = self.id = 1
        return super().save(*args, **kwargs)