Blame view

src/core/pyros_django/common/models.py 80.7 KB
5ce2836f   Alexis Koralewski   update models (ad...
1
2
3
4
5
6
7
8
9
10
11
12
##from __future__ import unicode_literals

# Stdlib imports
from enum import Enum
from datetime import datetime, timedelta, date
from dateutil.relativedelta import relativedelta
import os
import sys
from typing import List
from django.core.validators import MaxValueValidator, MinValueValidator

# DJANGO imports
a6e63604   Alexis Koralewski   adding agentSP an...
13
from django.contrib.auth.models import AbstractUser, UserManager
5ce2836f   Alexis Koralewski   update models (ad...
14
15
16
17
18
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...
19
from django.db.models.query import QuerySet
5ce2836f   Alexis Koralewski   update models (ad...
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
from model_utils import Choices
from django.utils import timezone
# Project imports
# DeviceCommand is used by class Command
sys.path.append("../../..")
from src.device_controller.abstract_component.device_controller import DeviceCmd

''' 
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'
'''



"""
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):
    if os.environ.get('PYROS_DEBUG', '0')=='1': print('(MODEL)', *args, **kwargs)

# ---
# --- Utility functions
# ---
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)
    return model.objects.first() if model.objects.exists() else model.objects.create(id=1)


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

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

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



"""
------------------------
   OTHER MODEL CLASSES
------------------------
"""

#TODO: A VIRER car remplacé par AgentDeviceStatus
class AgentDeviceTelescopeStatus(models.Model):
    #created = models.DateTimeField('status date', blank=True, null=True, auto_now_add=True)
    updated = models.DateTimeField('status date', blank=True, null=True, auto_now=True)
    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)
    agent = models.CharField('Name of the agent that saved this parameter', max_length=45, blank=True, null=True)
    #radec = models.CharField('agent mode', max_length=30, blank=True)
    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)

    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
    def getStatusForAgent(cls, agent:str) -> str:
        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/...) |
    """

    # Statuses
    #STATUSES = Choices('new', 'verified', 'published')
    STATUS_LAUNCH = "LAUNCHED"
    STATUS_INIT = "INITIALIZING"
    STATUS_MAIN_LOOP = "IN_MAIN_LOOP"
    STATUS_PROCESS_LOOP = "IN_PROCESS_LOOP"
    STATUS_EXIT = "EXITING"

    # Modes
    MODE_ACTIVE = "ACTIVE"
    MODE_IDLE = "IDLE"

    MODE_CHOICES = (
        (MODE_ACTIVE, 'Active mode'),
        (MODE_IDLE, 'Idle mode'),
    )

    STATUS_CHOICES = (
        (STATUS_LAUNCH, "LAUNCHED"),
        (STATUS_INIT, "INITIALIZING"),
        (STATUS_MAIN_LOOP, "IN_MAIN_LOOP"),
        (STATUS_PROCESS_LOOP, "IN_PROCESS_LOOP"),
        (STATUS_EXIT, "EXITING"),
    )

    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)
    mode = models.CharField('agent mode', max_length=15, blank=True, choices=MODE_CHOICES)
    status = models.CharField(max_length=15, blank=True, choices=STATUS_CHOICES)
    iteration = models.IntegerField(blank=True, null=True)

    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}")


class Album(models.Model):
    sequence = models.ForeignKey(
        'Sequence', on_delete=models.CASCADE, related_name="albums")
3b81a22b   Alexis Koralewski   Rework on Request...
359
360
361
362
    # detector = models.ForeignKey(
    #     'Detector', models.DO_NOTHING, related_name="albums", blank=True, null=True)
    name_of_channel_group = models.CharField(blank=True,null=True,max_length=150)
    name_of_channel = models.CharField(blank=True,null=True,max_length=150)
5ce2836f   Alexis Koralewski   update models (ad...
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
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
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
    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):
    request = models.OneToOneField('Request', on_delete=models.CASCADE, default='', parent_link=True)
    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)
    burst_jd = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    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)
    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)
    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"



class AgentCmd(models.Model):

    """
    | id | sender | recipient | name | validity_duration (default=60) | s_deposit_time | r_read_time

    See models_Command_state_diag.pu for PlantUML state diagram
    """

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

    # Receiver status codes
    """
    RSCODE_RUNNING = -1 # en cours d’exécution => une fois la cde lue
    RSCODE_EXECUTED = 0 # cde exécutée => simulé par un sleep(3) dans AgentX.core_process())
    RSCODE_PENDING = 1 # cde en attente d'exécution
    RSCODE_SKIPPED = 2 # cde ignorée (je suis idle… et j’ai ignoré cette commande, et je passe à la cde suivante) 
    RSCODE_OUTOFDATE = 3 # cde périmée 
    CMD_STATUS_CODES = (
        RSCODE_RUNNING, # en cours d’exécution => une fois la cde lue
        RSCODE_EXECUTED, # cde exécutée => simulé par un sleep(3) dans AgentX.core_process())
        RSCODE_PENDING, # cde en attente d'exécution
        RSCODE_SKIPPED, # cde ignorée (je suis idle… et j’ai ignoré cette commande, et je passe à la cde suivante) 
        RSCODE_OUTOFDATE, # cde périmée 
    )
    """
    CMD_STATUS_CODES = Choices(
        "CMD_RUNNING", # en cours d’exécution => une fois la cde lue
        "CMD_EXECUTED", # cde exécutée => simulé par un sleep(3) dans AgentX.core_process())
        "CMD_PENDING", # cde en attente d'exécution
        "CMD_SKIPPED", # cde ignorée (je suis idle… et j’ai ignoré cette commande, et je passe à la cde suivante) 
        "CMD_KILLED", # cde ignorée (je suis idle… et j’ai ignoré cette commande, et je passe à la cde suivante) 
        "CMD_OUTOFDATE" # cde périmée 
    )
    _AGENT_GENERAL_COMMANDS = [
        #"do_eval", "set_state:idle", "set_state:active",
        "do_eval", 
        "set_state",
        # Commands executed in priority (even if other pending commands exist)
        "do_flush_commands", "do_abort", "do_exit", "do_restart_init"
    ]
    #COMMANDS_PEREMPTION_HOURS = 48
    COMMANDS_PEREMPTION_HOURS = 60/60
    COMMANDS_VALIDITY_DURATION_SEC_DEFAULT = 60


    # -------------- 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)
    validity_duration = models.PositiveIntegerField('(in sec)', default=COMMANDS_VALIDITY_DURATION_SEC_DEFAULT)
    #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)
    # 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)
    # - on skipping (because idle), expiration (because too old), kill, or end of execution
    end_time = models.DateTimeField(null=True)

    # 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"


    # -------------- Command CLASS (static) METHODS --------------

    # Avoid to override the Model __init__ method
    @classmethod
    def create(cls, from_agent, to_agent, cmd_name, cmd_args=None):
        if '.' in to_agent:
            to_agent, component_name = to_agent.split('.')
            cmd_name = component_name+'.'+cmd_name
        if cmd_args: cmd_name += ' '+cmd_args
        #cls._device_command=DeviceCommand(cmd_name)
        return cls(
            sender=from_agent,
            recipient=to_agent,
            full_name=cmd_name,
        )

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

    @classmethod
    def send_cmd(cls, from_agent, to_agent, cmd_name, cmd_args=None):
    ##def send(cls, from_agent, to_agent, cmd_name, cmd_args=None):
        """
        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)
        '''
        cmd = cls.create(from_agent, to_agent, cmd_name, cmd_args)
        cmd.send()
        #cmd.set_as_pending()
        #cmd.save()
        return cmd


    @classmethod
    def get_peremption_date_from_now(cls):
        return datetime.utcnow().astimezone() - timedelta(hours = cls.COMMANDS_PEREMPTION_HOURS)

    @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
            recipient = agent_name,
            # only running commands
            state = cls.CMD_STATUS_CODES.CMD_RUNNING,
            # only not expired commands
            #s_deposit_time__gte = cls.get_peremption_date_from_now(),
        )
        if running_commands:
            AgentCmd.show_commands(running_commands)
            running_commands.delete()
        else: printd("<None>")

    @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):")
        now_minus_2sec = datetime.utcnow().astimezone() - timedelta(seconds = 2)
        #print("now_minus_2sec", now_minus_2sec)
        pending_commands = cls.objects.filter(
            # only commands for agent agent_name
            recipient = agent_name,
            # only running commands
            state = cls.CMD_STATUS_CODES.CMD_PENDING,
            # except very recent commands : take only commands that are more than 2 sec old
            s_deposit_time__lt = now_minus_2sec
        )
        if pending_commands:
            AgentCmd.show_commands(pending_commands)
            pending_commands.delete()
        else: printd("<None>")

    @classmethod
    def get_pending_and_running_commands_for_agent(cls, agent_name):
        #print("peremption date", COMMAND_PEREMPTION_DATE_FROM_NOW)
        return cls.objects.filter(
            # only pending commands
            # but also including the currently running command
            Q(state = cls.CMD_STATUS_CODES.CMD_PENDING) | Q(state = cls.CMD_STATUS_CODES.CMD_RUNNING),
            # only commands for agent agent_name
            recipient = agent_name,
            #recipient__startswith=agent_name,
            #Q(recipient.split('.')[0] = agent_name),
            # only not expired commands
            #s_deposit_time__gte = cls.get_peremption_date_from_now(),
        ).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):
        #filter(since=since)
        #return cls.objects.all()[:nb_cmds]
        #commands = cls.objects.filter(recipient = agent_name).order_by('-id')[:N]
        commands = cls.get_commands_sent_to_agent(agent_name).order_by('-id')[:N]
        return list(reversed(commands))

    @classmethod
    def get_last_N_commands_sent_by_agent(cls, agent_name, N):
        #filter(since=since)
        #return cls.objects.all()[:nb_cmds]
        #commands = cls.objects.filter(recipient = agent_name).order_by('-id')[:N]
        commands = cls.get_commands_sent_by_agent(agent_name).order_by('-id')[:N]
        return list(reversed(commands))

    @classmethod
    def purge_old_commands_sent_to_agent(cls, agent_name):
        """
        Delete commands (which agent_name is recipient of) older than COMMANDS_PEREMPTION_HOURS (like 48h)
        ATTENTION !!! EXCEPT the RUNNING command !!!
        NB: datetime.utcnow() is equivalent to datetime.now(timezone.utc)
        """

        printd(f"(Looking for commands sent to me that are not executing and older than {cls.COMMANDS_PEREMPTION_HOURS} hour(s))")
        #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
            recipient = agent_name,
            # only expired commands
            s_deposit_time__lt = cls.get_peremption_date_from_now(),
        ).exclude(
            state = cls.CMD_STATUS_CODES.CMD_RUNNING
        )
        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
    #def show_commands(cls, commands:models.query):
    def show_commands(cls, commands:list, do_it:bool=False):
    #def show_commands(cls, commands:List[Commmand]):
        #if not commands.exists(): print("<No command>")
        commands = list(commands)
        if len(commands) == 0: 
            if do_it: print("<None>")
            else: printd("<None>")
        for cmd in commands: 
            if do_it: print("-", cmd.name, cmd)
            else: printd("-", cmd.name, cmd)


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

    def __str__(self):
        #return (f"Commmand '{self.name}' ({self.state}) sent by agent {self.sender} to agent {self.recipient} at {self.s_deposit_time}")
        cmd_sent_time = f" at {self.s_deposit_time}" if self.s_deposit_time else ''
        return (f"Commmand '{self.full_name}' ({self.state}) sent to agent {self.recipient}{cmd_sent_time} [by agent {self.sender}]")

    @property
    def device_command(self):
        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
    def name_and_args(self):
        return self.device_command.name_and_args
        '''
        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
        '''

    def get_full_name_parts(self):
        return self.device_command.get_full_name_parts()
        '''
        cmd_name = self.full_name
        cmd_type = None
        cmd_args = None
        if '.' in cmd_name:
            cmd_type, cmd_name = cmd_name.split('.')
        if ' ' in cmd_name:
            cmd_name, *cmd_args = cmd_name.split(' ')
        return cmd_type, cmd_name, cmd_args
        '''

    @property
    def name(self):
        '''
        _,cmd_name,_ = self.get_full_name_parts()
        return cmd_name
        '''
        return self.device_command.name

    @property
    def args(self):
        '''
        _,_,cmd_args = self.get_full_name_parts()
        return cmd_args
        '''
        return self.device_command.args

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

    def send(self):
        #self.save()
        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()
        #return cmd_name in self.GENERIC_COMMANDS
        #print("**********************CMD NAME is", self.name, "in ???", self._AGENT_GENERAL_COMMANDS)
        return self.name in self._AGENT_GENERAL_COMMANDS
        #"CMD_OUTOFDATE" # cde périmée 

    def is_read(self):
        return self.r_read_time is not None

    def is_pending(self):
        return self.state == self.CMD_STATUS_CODES.CMD_PENDING

    def is_running(self):
        #return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
        return self.state == self.CMD_STATUS_CODES.CMD_RUNNING

    def is_executed(self):
        return self.state == self.CMD_STATUS_CODES.CMD_EXECUTED

    def is_skipped(self):
        return self.state == self.CMD_STATUS_CODES.CMD_SKIPPED

    def is_killed(self):
        return self.state == self.CMD_STATUS_CODES.CMD_KILLED

    def is_expired(self):
        #return (datetime.utcnow() - self.s_deposit_time) > timedelta(seconds = self.validity_duration)
        elapsed_time = (datetime.utcnow().astimezone() - self.s_deposit_time)
        printd("elapsed_time", elapsed_time)
        return elapsed_time > timedelta(seconds = self.validity_duration)
        """
        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:
        """

    # --- GETTERS/SETTERS functions ---

    def get_result(self):
        return self.result

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

    def set_result(self, result:str):
        self.result = result
        self.save()

    def set_read_time(self):
        self.r_read_time = datetime.utcnow().astimezone()
        # Optimization: update only 1 field
        self.save(update_fields=["r_read_time"])

    def set_as_processed(self):
        printd(f"- Set command {self.name} as processed")
        self.set_state_to(self.CMD_STATUS_CODES.CMD_EXECUTED)
        #print(self)
        """
        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"])

    def set_as_outofdate(self):
        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_OUTOFDATE)

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

    def set_as_skipped(self):
        self.set_state_to(self.CMD_STATUS_CODES.CMD_SKIPPED)

    def set_as_killed_by(self, author_agent:str):
        printd(f"- Set command {self.name} as killed")
        #print(f"- Set this command as killed: {self}")
        self.set_state_to(self.CMD_STATUS_CODES.CMD_KILLED, author_agent)

    def set_as_running(self):
        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)
    '''

    def set_state_to(self, status:str, author_agent_name:str=None):
        now_time = datetime.utcnow().astimezone()
        if status in (self.CMD_STATUS_CODES.CMD_RUNNING, self.CMD_STATUS_CODES.CMD_SKIPPED, self.CMD_STATUS_CODES.CMD_OUTOFDATE):
            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):
                self.end_time = now_time
            # EXPIRED
            elif status == self.CMD_STATUS_CODES.CMD_OUTOFDATE:
                self.end_time = now_time
                self.killer_agent_name = author_agent_name
        elif status in (self.CMD_STATUS_CODES.CMD_EXECUTED, self.CMD_STATUS_CODES.CMD_KILLED):
            assert self.is_running()
            self.end_time = now_time
            if status == self.CMD_STATUS_CODES.CMD_KILLED:
                self.killer_agent_name = author_agent_name
        # Update command status
        self.state = status
        self.save()
        # Optimization, but does not work, why ?...
        ##self.save(update_fields=["state"])



class Config(models.Model):
    PYROS_STATE = ["Starting", "Passive", "Standby", "Remote", "Startup", "Scheduler", "Closing" ]

    id = models.IntegerField(default='1', primary_key=True)
    #latitude = models.FloatField(default=1)
    latitude = models.DecimalField(
        max_digits=4, decimal_places=2, 
        default=1,
        validators=[
            MaxValueValidator(90),
            MinValueValidator(-90)
        ]
    )
    local_time_zone = models.FloatField(default=1)
    #longitude = models.FloatField(default=1)
    longitude = models.DecimalField(
        max_digits=5, decimal_places=2, 
        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__))



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"



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):
    plan = models.ForeignKey('Plan', on_delete=models.CASCADE, related_name="images")
    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...
1074
"""
5ce2836f   Alexis Koralewski   update models (ad...
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
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...
1095
"""
5ce2836f   Alexis Koralewski   update models (ad...
1096

3b81a22b   Alexis Koralewski   Rework on Request...
1097
1098
1099
1100
1101
1102
1103
1104
class Plan(models.Model):
    album = models.ForeignKey(Album, on_delete=models.CASCADE, related_name="plans")
    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)
    nb_images = models.PositiveIntegerField(blank=True, null=True,validators=[MinValueValidator(1)])
    config_attributes = models.JSONField(blank=True,null = True)
    
5ce2836f   Alexis Koralewski   update models (ad...
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
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
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

class PlcDeviceStatus(models.Model):
    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)
    outside_temp_unit = models.CharField(max_length=45, blank=True, null=True)
    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)
    pressure_unit = models.CharField(max_length=45, blank=True, null=True)
    rain_rate = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    rain_rate_unit = models.CharField(max_length=45, blank=True, null=True)
    wind_speed = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    wind_speed_unit = models.CharField(max_length=45, blank=True, null=True)
    wind_dir = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    wind_dir_unit = models.CharField(max_length=45, blank=True, null=True)
    dew_point = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    dew_point_unit = models.CharField(max_length=45, blank=True, null=True)
    analog = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    analog_unit = models.CharField(max_length=45, blank=True, null=True)
    digital = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    digital_unit = models.CharField(max_length=45, blank=True, null=True)
    inside_temp = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    inside_temp_unit = models.CharField(max_length=45, blank=True, null=True)
    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)
    wind_dir_cardinal = models.CharField(max_length=45, blank=True, null=True)
    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)
    status = models.CharField(max_length=45, blank=True, null=True)
    current = models.DecimalField(max_digits=15, decimal_places=8, blank=True, null=True)
    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
    '''
    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
        elif key == "Rain_boolean": # RainRate
            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

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)


    class Meta:
        managed = True
        db_table = 'plc_devices'

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


#class Plc(Device):
 #   last_update_status = models.DateTimeField(blank=True, null=True)
#    i
 #   class Meta:
  #      managed = True
   #     db_table = 'plc'

5a434264   Alexis Koralewski   New version of Sc...
1242
1243
1244
1245
1246
class ScienceTheme(models.Model):
    name = models.CharField(max_length=120, blank=False, null=False,default="",unique=True)

    def __str__(self) -> str:
        return str(self.name)
5ce2836f   Alexis Koralewski   update models (ad...
1247
1248
1249
1250
1251
1252
1253
1254
class Institute(models.Model):
    name = models.CharField(max_length=100,blank=False,null=False,unique=True)
    quota = models.IntegerField(validators=[MinValueValidator(0), MaxValueValidator(100)])
    #representative_user = models.ForeignKey("PyrosUser", on_delete=models.DO_NOTHING,related_name="institutes",default=1)

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

a6e63604   Alexis Koralewski   adding agentSP an...
1255
1256
1257
1258
1259
1260
1261
class PyrosUserManager(UserManager):
    def tac_users(self):
        return PyrosUser.objects.filter(user_level__name="TAC")
    
    def unit_users(self):
        return PyrosUser.objects.filter(Q(user_level__name="Unit-PI")|Q(user_level__name="Unit-board"))

5ce2836f   Alexis Koralewski   update models (ad...
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
class PyrosUser(AbstractUser):
    username = models.CharField(max_length=255, blank=False, null=False, unique=True)
    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)
    institute = models.ForeignKey(Institute, on_delete=DO_NOTHING, related_name="pyros_users")
    is_institute_representative = models.BooleanField(default=False)
    motive_of_registration = models.TextField(max_length=300, blank=False, default="")
    # 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)
    validator = models.ForeignKey("PyrosUser", on_delete=models.DO_NOTHING, null=True, related_name="pyros_users")
077d5a23   Alexis Koralewski   adding science th...
1292
    referee_themes = models.ManyToManyField("ScienceTheme",related_name="referee_themes",blank=True)
a6e63604   Alexis Koralewski   adding agentSP an...
1293
1294

    objects = PyrosUserManager()
5ce2836f   Alexis Koralewski   update models (ad...
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
1348
1349
1350
1351
1352
1353
1354
1355
    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"

    def get_priority(self)->int:
        """
        return maximum priority of all roles of the user

        Returns:
            int: maximum priority
        """
        return PyrosUser.objects.get(id = self.id).user_level.all().aggregate(Max("priority"))["priority__max"]

    def get_roles_str(self)->str:
        """
        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
        for role in PyrosUser.objects.get(id = self.id).user_level.all():
            roles_str += role.name+ ", "
        return roles_str[:-2]

    def get_list_of_roles(self)->list:
        """
        return list of all roles assigned to the user

        Returns:
            list: list of all roles assigned to user
        """
        return PyrosUser.objects.get(id = self.id).user_level.all().values_list("name",flat=True)

    # 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.
    def get_max_priority_desc(self)->str:
        """
        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
        """
        return PyrosUser.objects.get(id = self.id).user_level.filter(priority=self.get_priority())[0].desc

    def get_max_priority_quota(self)->int:
        """
        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
        """
        return PyrosUser.objects.get(id = self.id).user_level.filter(priority=self.get_priority())[0].quota

077d5a23   Alexis Koralewski   adding science th...
1356
1357
1358
1359
    def get_referee_themes_as_str(self)->str:
        """
        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...
1360

077d5a23   Alexis Koralewski   adding science th...
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
        Returns:
            str: list of science themes associated to that user
        """
        str = ""
        if self.referee_themes != None:
            for science_theme in PyrosUser.objects.get(id = self.id).referee_themes.all():
                str += science_theme.name+ ", "
            return str[:-2]
        else:
            return str
5ce2836f   Alexis Koralewski   update models (ad...
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
# 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))

5a434264   Alexis Koralewski   New version of Sc...
1407
class PeriodManager(models.Manager):
077d5a23   Alexis Koralewski   adding science th...
1408
    # to get the currently active period, use exploitation_period()
5a434264   Alexis Koralewski   New version of Sc...
1409
1410
1411
    def currently_active_period(self)->QuerySet:
        today = timezone.now().date()
        return Period.objects.get(start_date__lte=today,end_date__gt=today)
5ce2836f   Alexis Koralewski   update models (ad...
1412

077d5a23   Alexis Koralewski   adding science th...
1413
1414
1415
1416
1417
    def submission_periods(self)->QuerySet:
        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...
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
            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

    def evaluation_periods(self)->QuerySet:
        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

    def validation_periods(self)->QuerySet:
        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...
1438
            if period.unit_pi_validation_start_date <= today and period.notification_start_date > today:
077d5a23   Alexis Koralewski   adding science th...
1439
1440
1441
1442
1443
1444
1445
1446
1447
                validation_periods_id.append(period.id)
        periods = periods.filter(id__in=validation_periods_id)
        return periods

    def notification_periods(self)->QuerySet:
        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...
1448
            if period.notification_start_date <= today and period.start_date > today:
077d5a23   Alexis Koralewski   adding science th...
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
                notification_periods_id.append(period.id)
        periods = periods.filter(id__in=notification_periods_id)
        return periods

    def exploitation_period(self)->any:
        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

    def latest_period(self)->any:
        today = timezone.now().date()
        future_period = Period.objects.filter(start_date__gt=today).order_by("-start_date").first()
        if future_period is None:
            # no future period defined so we return the current period
            return self.exploitation_period()
        return future_period
        
    def previous_periods(self)->any:
        today = timezone.now().date()
        previous_periods = Period.objects.filter(start_date__lt=today).order_by("-start_date").exclude(id=self.exploitation_period().id)
        return previous_periods
a6e63604   Alexis Koralewski   adding agentSP an...
1473
1474
1475
1476
1477
1478
    
    def next_period(self)->any:
        current_period = self.exploitation_period()
        next_period =  Period.objects.filter(start_date__gt=current_period.start_date).order_by("start_date").first()
        return next_period

077d5a23   Alexis Koralewski   adding science th...
1479

5ce2836f   Alexis Koralewski   update models (ad...
1480
class Period(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1481
1482
    # 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...
1483
    today_plus_six_months = today + relativedelta(months=+6)
5a434264   Alexis Koralewski   New version of Sc...
1484
1485
1486
1487
1488
1489
    today_minus_six_months = today + relativedelta(months=-6)
    today_minus_one_month_and_half = today + relativedelta(months=-1) + relativedelta(days=-15)
    today_minus_fifteen_days = today + relativedelta(days=-15)
    end_date_plus_one_year = today_plus_six_months + relativedelta(years=+1)
    end_date_plus_eleven_year = today_plus_six_months + relativedelta(years=+11)

f98e645c   Alexis Koralewski   fixing warning fo...
1490
    start_date = models.DateField(blank=True, null=True, default=timezone.now,editable=True)    
077d5a23   Alexis Koralewski   adding science th...
1491
1492

    exploitation_duration =  models.PositiveIntegerField(blank=True, null=True, default=182,editable=True)    
a6e63604   Alexis Koralewski   adding agentSP an...
1493
    submission_duration = models.PositiveIntegerField(blank=True, null=True, default=136,editable=True)    
077d5a23   Alexis Koralewski   adding science th...
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
    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) 

    @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...
1506
        return self.start_date + relativedelta(days=-(self.submission_duration+self.evaluation_duration+self.validation_duration+self.notification_duration))
077d5a23   Alexis Koralewski   adding science th...
1507
1508
1509
    
    @property
    def submission_end_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1510
        return self.submission_start_date + relativedelta(days=self.submission_duration)
077d5a23   Alexis Koralewski   adding science th...
1511
1512
1513

    @property
    def unit_pi_validation_start_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1514
        return self.submission_end_date + relativedelta(days=self.evaluation_duration)
077d5a23   Alexis Koralewski   adding science th...
1515
1516
1517

    @property
    def notification_start_date(self):
a6e63604   Alexis Koralewski   adding agentSP an...
1518
        return self.unit_pi_validation_start_date + relativedelta(days=self.validation_duration)
077d5a23   Alexis Koralewski   adding science th...
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530

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


    """
    end_date =  models.DateField(blank=True, null=True, default=start_date_plus_six_months,editable=True)    
5a434264   Alexis Koralewski   New version of Sc...
1531
1532
1533
1534
1535
    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...
1536
1537
    
    #class Meta:
5ce2836f   Alexis Koralewski   update models (ad...
1538
        # 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...
1539
1540
1541
    #    constraints = [
    #        models.UniqueConstraint(fields=["start_date","duration"], name="unique_period")   
    #    ]
5ce2836f   Alexis Koralewski   update models (ad...
1542
    """
5a434264   Alexis Koralewski   New version of Sc...
1543
1544

    objects = PeriodManager()
5ce2836f   Alexis Koralewski   update models (ad...
1545
    def __str__(self) -> str:
5a434264   Alexis Koralewski   New version of Sc...
1546
        return "P"+str(self.id)+" ("+self.start_date.strftime("%d/%m/%Y")+ " to "+ self.end_date.strftime("%d/%m/%Y")+")"
5ce2836f   Alexis Koralewski   update models (ad...
1547
    def is_currently_active(self)->bool:
5a434264   Alexis Koralewski   New version of Sc...
1548
        today = timezone.now().date()
fce7ff0f   Alexis Koralewski   Change of compari...
1549
        return self.start_date <= today < self.end_date
5ce2836f   Alexis Koralewski   update models (ad...
1550
            
5a434264   Alexis Koralewski   New version of Sc...
1551
1552


5ce2836f   Alexis Koralewski   update models (ad...
1553
class ScientificProgram(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1554
    
5ce2836f   Alexis Koralewski   update models (ad...
1555

5a434264   Alexis Koralewski   New version of Sc...
1556
1557
1558
1559
1560
    name = models.CharField(max_length=30, blank=False, null=False,default="",unique=True)
    description_short = models.TextField(default="",max_length=320)
    description_long = models.TextField(default="")
    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")
077d5a23   Alexis Koralewski   adding science th...
1561
    science_theme = models.ForeignKey("ScienceTheme",on_delete=models.DO_NOTHING,related_name="scientific_program_theme",default=1)
5a434264   Alexis Koralewski   New version of Sc...
1562
    is_auto_validated = models.BooleanField(default=False)
5ce2836f   Alexis Koralewski   update models (ad...
1563
1564
1565
1566
1567
1568
1569
1570
1571
    
    class Meta:
        managed = True
        db_table = 'scientific_program'

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

class SP_Period(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
    STATUSES_DRAFT = "Draft"
    STATUSES_SUBMITTED = "Submitted"
    STATUSES_EVALUATED = "Evaluated"
    STATUSES_ACCEPTED = "Accepted"
    STATUSES_REJECTED = "Rejected"
    STATUSES = [
        (STATUSES_DRAFT,"Draft"),
        (STATUSES_SUBMITTED,"Submitted"),
        (STATUSES_EVALUATED,"Evaluated"),
        (STATUSES_ACCEPTED,"Accepted"),
        (STATUSES_REJECTED,"Rejected")
    ]
    VOTES_YES = "A: Accepted"
    VOTES_NO = "C: Refused"
    VOTES_TO_DISCUSS = "B: To be discussed"
    VOTES = [
        (VOTES_YES,"A: Accepted"),
        (VOTES_TO_DISCUSS,"B: To be discussed"),
        (VOTES_NO,"C: Refused")
    ]
    IS_VALID_ACCEPTED = "Accepted"
    IS_VALID_REJECTED = "Rejected"
    IS_VALID = [
        (IS_VALID_ACCEPTED,"Accepted"),
        (IS_VALID_REJECTED,"Rejected")
    ]

    VISIBILITY_YES = "Yes"
    VISIBILITY_NO = "No"
    VISIBILITY_CHOICES = [
        (VISIBILITY_YES,"Yes"),
        (VISIBILITY_NO,"No"),
    ]
5ce2836f   Alexis Koralewski   update models (ad...
1605
1606
    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")
5a434264   Alexis Koralewski   New version of Sc...
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
    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)
    reason_referee1 = models.TextField(blank=True)
    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)
    reason_referee2 = models.TextField(blank=True)
    is_valid = models.TextField(choices=IS_VALID,default=IS_VALID_REJECTED,blank=True)
    status = models.TextField(choices=STATUSES,default=STATUSES_DRAFT)
    quota_minimal = models.PositiveIntegerField(default=0)
    quota_nominal = models.PositiveIntegerField(default=0)
    quota_allocated = models.PositiveIntegerField(default=0,blank=True)
    quota_remaining = models.PositiveIntegerField(default=0,blank=True)
    over_quota_duration = models.PositiveIntegerField(default=0)
    over_quota_duration_allocated = models.PositiveIntegerField(default=0,blank=True)
    over_quota_duration_remaining= models.PositiveIntegerField(default=0)
    token = models.PositiveIntegerField(default=0)
    token_allocated = models.PositiveIntegerField(default=0,blank=True)
    token_remaining = models.PositiveIntegerField(default=0,blank=True)
    priority = models.PositiveIntegerField(default=0,blank=True)
    

5ce2836f   Alexis Koralewski   update models (ad...
1629
1630
    def is_currently_active(self):
        return self.period.is_currently_active()
5a434264   Alexis Koralewski   New version of Sc...
1631

5ce2836f   Alexis Koralewski   update models (ad...
1632
class SP_Period_User(models.Model):
5a434264   Alexis Koralewski   New version of Sc...
1633
    SP_Period = models.ForeignKey(SP_Period, on_delete=models.DO_NOTHING,related_name="SP_Period_Users")
fce7ff0f   Alexis Koralewski   Change of compari...
1634
    user = models.ForeignKey("PyrosUser", on_delete=models.CASCADE,related_name="SP_Period_Users")
5a434264   Alexis Koralewski   New version of Sc...
1635
    #is_SP_PI = models.BooleanField(default=False)
5ce2836f   Alexis Koralewski   update models (ad...
1636

5a434264   Alexis Koralewski   New version of Sc...
1637
1638
1639
1640
1641
    class Meta:
        unique_together = ('SP_Period', 'user')
class SP_Period_Guest(models.Model):
    SP_Period = models.ForeignKey(SP_Period, on_delete=models.DO_NOTHING,related_name="SP_Period_Guests")
    email = models.EmailField(max_length=254)
a6e63604   Alexis Koralewski   adding agentSP an...
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657

class SP_PeriodWorkflow(models.Model):
    SUBMISSION = "SUB"
    EVALUATION = "EVAL"
    VALIDATION = "VALI"
    NOTIFICATION = "NOTI"
    ACTIONS_CHOICES = (
        (SUBMISSION,"Submission"),
        (EVALUATION,"Evaluation"),
        (VALIDATION,"Validation"),
        (NOTIFICATION,"Notification")
    )
    action = models.CharField(max_length=120,choices=ACTIONS_CHOICES)
    period = models.ForeignKey("Period",on_delete=models.DO_NOTHING,related_name="SP_Period_Workflows")
    created = models.DateTimeField(blank=True, null=True, auto_now_add=True)

5ce2836f   Alexis Koralewski   update models (ad...
1658
class Sequence(models.Model):
3b81a22b   Alexis Koralewski   Rework on Request...
1659
    # TODO : mettre un status : draft ou submitted
5ce2836f   Alexis Koralewski   update models (ad...
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687

    """ Definition of Status enum values """

    INCOMPLETE = "INCPL"
    COMPLETE = "CPL"
    TOBEPLANNED = "TBP"
    PLANNED = "PLND"
    PENDING = "PNDG"
    EXECUTING = "EXING"
    EXECUTED = "EXD"
    REJECTED = "RJTD"
    INVALID = "INVL"
    CANCELLED = "CNCLD"
    UNPLANNABLE = "UNPLN"
    STATUS_CHOICES = (
        (INCOMPLETE, "Incomplete"),
        (COMPLETE, "Complete"),
        (TOBEPLANNED, "To be planned"),
        (PLANNED, "Planned"),
        (UNPLANNABLE, "Unplannable"),
        (PENDING, "Pending"),
        (EXECUTED, "Executed"),
        (EXECUTING, "Executing"),
        (REJECTED, "Rejected"),
        (CANCELLED, "Cancelled"),
        (INVALID, "Invalid"),
    )

3b81a22b   Alexis Koralewski   Rework on Request...
1688
1689
1690
    #request = models.ForeignKey(
    #    Request, on_delete=models.CASCADE, related_name="sequences")
    pyros_user = models.ForeignKey(
a9908737   Alexis Koralewski   allow 'null' pyro...
1691
        'PyrosUser', on_delete=models.DO_NOTHING, related_name="sequences", blank=True, null= True)
3b81a22b   Alexis Koralewski   Rework on Request...
1692
1693
    scientific_program = models.ForeignKey(
        'ScientificProgram', on_delete=models.DO_NOTHING, related_name="sequences", blank=True, null=True)
5ce2836f   Alexis Koralewski   update models (ad...
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
    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)
    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)
3b81a22b   Alexis Koralewski   Rework on Request...
1714
1715
1716
    
    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)    
077d5a23   Alexis Koralewski   adding science th...
1717
    # jd1 et jd2 = julian day start / end 
5ce2836f   Alexis Koralewski   update models (ad...
1718
1719
1720
1721
1722
1723
    jd1 = models.DecimalField(default=0.0, max_digits=15, decimal_places=8)
    jd2 = models.DecimalField(default=0.0, max_digits=15, decimal_places=8)
    t_prefered = models.DecimalField(
        default=-1.0, max_digits=15, decimal_places=8)
    duration = models.DecimalField(
        default=-1.0, max_digits=15, decimal_places=8)
077d5a23   Alexis Koralewski   adding science th...
1724
    # décomposer duration en duration pointing + duration album
5ce2836f   Alexis Koralewski   update models (ad...
1725
    overhead = models.DecimalField(default=0, max_digits=15, decimal_places=8)
3b81a22b   Alexis Koralewski   Rework on Request...
1726
1727
    submitted = models.BooleanField(default=False)
    config_attributes = models.JSONField(blank=True,null = True)
5ce2836f   Alexis Koralewski   update models (ad...
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008

    ra = models.FloatField(blank=True, null=True)
    dec = models.FloatField(blank=True, null=True)

    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)

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


#TODO: à virer car utilisé pour Celery (ou bien à utiliser pour les agents)
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))



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)
    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)
    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):
        #print(self.rain)
        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):
    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)

    class Meta:
        managed = True
        db_table = 'weatherwatchhistory'
        verbose_name_plural = "Weather watch histories"

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