/
models.py
1719 lines (1207 loc) · 62.7 KB
/
models.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
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
359
360
361
362
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
# pylint: disable=no-member, line-too-long, too-many-lines, super-with-arguments, useless-object-inheritance, bad-option-value
from __future__ import print_function
from __future__ import division
from builtins import str # pylint: disable=redefined-builtin
from builtins import range # pylint: disable=redefined-builtin
from builtins import object # pylint: disable=redefined-builtin
import calendar
import datetime
import json
import random
import string
import sys
import importlib
from packaging.version import Version
from future import standard_library
from past.utils import old_div
import arrow
import requests
from six import python_2_unicode_compatible
import django
from django.conf import settings
from django.core.checks import Warning, register # pylint: disable=redefined-builtin
from django.core.exceptions import MultipleObjectsReturned, ObjectDoesNotExist
from django.db import connection
from django.db.models import Q, QuerySet
from django.db.models.signals import post_delete, pre_save, post_save
from django.dispatch.dispatcher import receiver
from django.urls import reverse
from django.utils import timezone
from django.utils.text import slugify
from django.contrib.auth import get_user_model
from django.contrib.gis.db import models
try:
from urllib.parse import urlparse, urlunsplit
except ImportError:
from urlparse import urlparse, urlunsplit
if sys.version_info[0] > 2:
from django.db.models import JSONField # pylint: disable=no-name-in-module
else:
from django.contrib.postgres.fields import JSONField
standard_library.install_aliases()
DB_SUPPORTS_JSON = None
TOTAL_DATA_POINT_COUNT_DATUM = 'Total Data Point Count'
SOURCES_DATUM = 'Data Point Sources'
SOURCE_GENERATORS_DATUM = 'Data Point Source Generator Identifiers'
LATEST_POINT_DATUM = 'Latest Data Point'
MISSING_POINT_DATUM = 'Missing Data Point'
GENERATORS_DATUM = 'Data Point Generators'
ALERT_LEVEL_CHOICES = (
('info', 'Informative'),
('warning', 'Warning'),
('critical', 'Critical'),
)
DEVICE_ISSUE_STATE_CHOICES = (
('opened', 'Opened'),
('in-progress', 'In Progress'),
('resolved', 'Resolved'),
('wont-fix', 'Won\'t Fix'),
)
METADATA_WINDOW_DAYS = 60
try:
METADATA_WINDOW_DAYS = settings.PDK_METADATA_WINDOW_DAYS
except AttributeError:
pass
CACHED_GENERATOR_DEFINITIONS = {}
CACHED_SOURCE_REFERENCES = {}
COMPRESSION_CHOICES = (
('none', 'None'),
('gzip', 'Gzip'),
)
def generator_label(identifier):
for app in settings.INSTALLED_APPS:
try:
pdk_api = importlib.import_module(app + '.pdk_api')
name = pdk_api.name_for_generator(identifier)
if name is not None:
return name
except ImportError:
pass
except AttributeError:
pass
return identifier
def generator_slugify(str_obj):
return slugify(str_obj.replace('.', ' ')).replace('-', '_')
def install_supports_jsonfield():
global DB_SUPPORTS_JSON # pylint: disable=global-statement
if DB_SUPPORTS_JSON is None:
try:
DB_SUPPORTS_JSON = connection.pg_version >= 90400
except AttributeError:
DB_SUPPORTS_JSON = False
try:
DB_SUPPORTS_JSON = (settings.PDK_DISABLE_NATIVE_JSON_FIELDS is False)
except AttributeError:
pass
return DB_SUPPORTS_JSON
@register()
def check_prettyjson_installed(app_configs, **kwargs): # pylint: disable=unused-argument
errors = []
if ('prettyjson' in settings.INSTALLED_APPS) is False:
error = Warning('"prettyjson" not found in settings.INSTALLED_APPS', hint='Add "prettyjson" to settings.INSTALLED_APPS.', obj=None, id='passive_data_kit.W001')
errors.append(error)
return errors
@python_2_unicode_compatible
class AppConfiguration(models.Model):
class Meta(object): # pylint: disable=old-style-class, no-init, too-few-public-methods, bad-option-value
index_together = [
['is_valid', 'is_enabled'],
['is_valid', 'is_enabled', 'evaluate_order'],
]
ordering = ['name']
name = models.CharField(max_length=1024)
id_pattern = models.CharField(max_length=1024, db_index=True)
context_pattern = models.CharField(max_length=1024, default='.*', db_index=True)
if install_supports_jsonfield():
configuration_json = JSONField()
else:
configuration_json = models.TextField(max_length=(32 * 1024 * 1024 * 1024))
evaluate_order = models.IntegerField(default=1)
is_valid = models.BooleanField(default=False)
is_enabled = models.BooleanField(default=True)
def configuration(self):
if install_supports_jsonfield():
return self.configuration_json
return json.loads(self.configuration_json)
def __str__(self):
return str(self.name)
@python_2_unicode_compatible
class DataGeneratorDefinition(models.Model):
generator_identifier = models.CharField(max_length=1024)
name = models.CharField(max_length=1024)
description = models.TextField(max_length=(1024 * 1024), null=True, blank=True)
def __str__(self):
return str(self.generator_identifier)
@classmethod
def definition_for_identifier(cls, generator_identifier):
try:
return DataGeneratorDefinition.objects.get(generator_identifier=generator_identifier)
except MultipleObjectsReturned:
first_definition = DataGeneratorDefinition.objects.filter(generator_identifier=generator_identifier).order_by('pk').first()
other_definitions = DataGeneratorDefinition.objects.filter(generator_identifier=generator_identifier).order_by('pk')[1:]
to_delete = []
for definition in other_definitions:
DataPoint.objects.filter(generator_definition=definition).update(generator_definition=first_definition)
to_delete.append(definition)
for definition in to_delete:
definition.delete()
return first_definition
except ObjectDoesNotExist:
definition = DataGeneratorDefinition(generator_identifier=generator_identifier)
definition.save()
return definition
@python_2_unicode_compatible
class DataSourceReference(models.Model):
source = models.CharField(max_length=1024)
def __str__(self):
return str(self.source)
@classmethod
def reference_for_source(cls, source):
try:
return DataSourceReference.objects.get(source=source)
except MultipleObjectsReturned:
first_source = DataSourceReference.objects.filter(source=source).order_by('pk').first()
other_sources = DataSourceReference.objects.filter(source=source).order_by('pk')[1:]
to_delete = []
for reference in other_sources:
DataPoint.objects.filter(source_reference=reference).update(source_reference=first_source)
to_delete.append(reference)
for reference in to_delete:
reference.delete()
return first_source
except ObjectDoesNotExist:
reference = DataSourceReference(source=source)
reference.save()
return reference
class DataPointQuerySet(QuerySet):
def count(self):
postgres_engines = ("postgis", "postgresql", "django_postgrespool")
engine = settings.DATABASES[self.db]["ENGINE"].split(".")[-1]
is_postgres = engine.startswith(postgres_engines)
# In Django 1.9 the query.having property was removed and the
# query.where property will be truthy if either where or having
# clauses are present. In earlier versions these were two separate
# properties query.where and query.having
if Version(django.get_version()) >= Version('1.9'):
is_filtered = self.query.where
else:
is_filtered = self.query.where or self.query.having
# print('WHERE: ' + str(self.query.where))
if not is_postgres or is_filtered:
return super(DataPointQuerySet, self).count()
data_point_count = DataServerMetadatum.objects.filter(key=TOTAL_DATA_POINT_COUNT_DATUM).first()
if data_point_count is None:
data_count = super(DataPointQuerySet, self).count()
DataServerMetadatum.objects.create(key=TOTAL_DATA_POINT_COUNT_DATUM, value=str(data_count))
return data_count
return int(data_point_count.value)
class DataPointManager(models.Manager):
def get_queryset(self):
return DataPointQuerySet(self.model, using=self._db)
def sources(self): # pylint: disable=no-self-use
sources = []
for reference in DataSourceReference.objects.all():
if reference.source.strip():
sources.append(reference.source)
return sources
def generator_identifiers_for_source(self, source, since=None): # pylint: disable=invalid-name, no-self-use
identifiers = []
source_reference = DataSourceReference.reference_for_source(source)
for definition in DataGeneratorDefinition.objects.all():
if since is not None:
if DataPoint.objects.filter(source_reference=source_reference, generator_definition=definition, created__gte=since).count() > 0:
identifiers.append(definition.generator_identifier)
else:
key = LATEST_POINT_DATUM + ': ' + source + '/' + definition.generator_identifier
latest_point_datum = DataServerMetadatum.objects.filter(key=key).first()
missing_key = MISSING_POINT_DATUM + ': ' + source + '/' + definition.generator_identifier
missing_point_datum = DataServerMetadatum.objects.filter(key=missing_key).first()
if latest_point_datum is not None:
identifiers.append(definition.generator_identifier)
if missing_point_datum is not None:
DataServerMetadatum.objects.filter(key=key).delete()
else:
if missing_point_datum is not None:
pass
else:
if DataPoint.objects.filter(source_reference=source_reference, generator_definition=definition).count() > 0:
identifiers.append(definition.generator_identifier)
else:
missing_point_datum = DataServerMetadatum(key=missing_key, last_updated=timezone.now(), value='Not found')
missing_point_datum.save()
return identifiers
def generator_identifiers(self): # pylint: disable=invalid-name, no-self-use
identifiers = []
for definition in DataGeneratorDefinition.objects.all():
identifiers.append(definition.generator_identifier)
return identifiers
def latest_point(self, source, identifier): # pylint: disable=no-self-use
key = LATEST_POINT_DATUM + ': ' + source + '/' + identifier
latest_point_datum = DataServerMetadatum.objects.filter(key=key).first()
point = None
if latest_point_datum is not None:
point = DataPoint.objects.filter(pk=int(latest_point_datum.value)).first()
if point is None:
source_reference = DataSourceReference.objects.filter(source=source).first()
if source_reference is None:
return None
if identifier == 'pdk-data-frequency':
data_source = DataSource.objects.filter(identifier=source).first()
if data_source is not None:
point = data_source.latest_point()
if point is None:
if DataPoint.objects.filter(source_reference=source_reference).count() > 0:
point = DataPoint.objects.filter(source_reference=source_reference).order_by('-pk').first()
else:
generator_definition = DataGeneratorDefinition.objects.filter(generator_identifier=identifier).first()
if generator_definition is None:
return None
if DataPoint.objects.filter(source_reference=source_reference, generator_definition=generator_definition).count() > 0:
point = DataPoint.objects.filter(source_reference=source_reference, generator_definition=generator_definition).order_by('-pk').first()
if point is not None:
latest_point_datum = DataServerMetadatum.objects.filter(key=key).first()
if latest_point_datum is None:
latest_point_datum = DataServerMetadatum(key=key)
latest_point_datum.value = str(point.pk)
latest_point_datum.save()
return point
def set_latest_point(self, source, identifier, new_point):
latest_point = self.latest_point(source, identifier)
if latest_point is None or latest_point.created < new_point.created:
key = LATEST_POINT_DATUM + ': ' + source + '/' + identifier
latest_point_datum = DataServerMetadatum.objects.filter(key=key).first()
if latest_point_datum is None:
latest_point_datum = DataServerMetadatum(key=key)
latest_point_datum.value = str(new_point.pk)
latest_point_datum.save()
def create_data_point(self, identifier, source, payload, user_agent='Passive Data Kit Server', created=None, skip_save=False, skip_extract_secondary_identifier=False): # pylint: disable=no-self-use, too-many-arguments, invalid-name
now = timezone.now()
if created is None:
created = now
payload['passive-data-metadata'] = {
'timestamp': calendar.timegm(created.utctimetuple()),
'generator-id': identifier,
'generator': identifier + ': ' + user_agent,
'source': source
}
point = DataPoint(source=source, generator=payload['passive-data-metadata']['generator'], generator_identifier=identifier)
if install_supports_jsonfield():
point.properties = payload
else:
point.properties = json.dumps(payload, indent=2)
point.user_agent = user_agent
point.recorded = now
point.created = created
point.fetch_generator_definition(skip_save)
point.fetch_source_reference(skip_save)
if skip_extract_secondary_identifier is False:
point.fetch_secondary_identifier()
if skip_save is False:
point.save()
point.fetch_secondary_identifier()
data_point_count = DataServerMetadatum.objects.filter(key=TOTAL_DATA_POINT_COUNT_DATUM).first()
if data_point_count is None:
count = DataPoint.objects.all().count()
data_point_count = DataServerMetadatum(key=TOTAL_DATA_POINT_COUNT_DATUM)
data_point_count.value = str(count)
data_point_count.save()
else:
count = int(data_point_count.value)
count += 1
data_point_count.value = str(count)
data_point_count.save()
return point
@python_2_unicode_compatible # pylint: disable=too-many-instance-attributes
class DataPoint(models.Model): # pylint: disable=too-many-instance-attributes
class Meta(object): # pylint: disable=old-style-class, no-init, too-few-public-methods, bad-option-value
index_together = [
['created', 'source_reference']
]
objects = DataPointManager()
source = models.CharField(max_length=1024)
generator = models.CharField(max_length=1024)
generator_identifier = models.CharField(max_length=1024, db_index=True, default='unknown-generator')
secondary_identifier = models.CharField(max_length=1024, null=True, blank=True)
generator_definition = models.ForeignKey(DataGeneratorDefinition, on_delete=models.SET_NULL, related_name='data_points', null=True, blank=True)
source_reference = models.ForeignKey(DataSourceReference, on_delete=models.SET_NULL, related_name='data_points', null=True, blank=True)
user_agent = models.CharField(max_length=1024, null=True, blank=True)
created = models.DateTimeField(db_index=True)
generated_at = models.PointField(null=True, blank=True)
server_generated = models.BooleanField(default=False, db_index=True)
recorded = models.DateTimeField(db_index=True)
if install_supports_jsonfield():
properties = JSONField()
else:
properties = models.TextField(max_length=(32 * 1024 * 1024 * 1024))
def fetch_secondary_identifier(self, skip_save=False, properties=None):
if self.secondary_identifier is not None:
return self.secondary_identifier
if properties is None:
properties = self.fetch_properties()
generator_name = generator_slugify(self.generator_identifier)
for app in settings.INSTALLED_APPS:
try:
generator = importlib.import_module(app + '.generators.' + generator_name)
identifier = generator.extract_secondary_identifier(properties)
if identifier is not None:
self.secondary_identifier = identifier
if skip_save is False:
self.save()
return self.secondary_identifier
except ImportError:
pass
except AttributeError:
pass
return None
def fetch_properties(self):
try:
return self.cached_properties # pylint: disable=access-member-before-definition
except AttributeError:
pass
if install_supports_jsonfield():
self.cached_properties = self.properties # pylint: disable=attribute-defined-outside-init
else:
self.cached_properties = json.loads(self.properties) # pylint: disable=attribute-defined-outside-init
return self.cached_properties
def fetch_user_agent(self, skip_save=False, properties=None):
if self.user_agent is None:
if properties is None:
properties = self.fetch_properties()
if 'passive-data-metadata' in properties:
if 'generator' in properties['passive-data-metadata']:
tokens = properties['passive-data-metadata']['generator'].split(':', 1)
self.user_agent = tokens[-1].strip()
if skip_save is False:
self.save()
return self.user_agent
def fetch_generator_definition(self, skip_save=False):
if self.generator_identifier in CACHED_GENERATOR_DEFINITIONS:
generator_definition = CACHED_GENERATOR_DEFINITIONS[self.generator_identifier]
else:
generator_definition = DataGeneratorDefinition.objects.filter(generator_identifier=self.generator_identifier).first()
if generator_definition is None:
generator_definition = DataGeneratorDefinition(generator_identifier=self.generator_identifier, name=self.generator_identifier)
generator_definition.save()
CACHED_GENERATOR_DEFINITIONS[self.generator_identifier] = generator_definition
if self.generator_definition_id is None:
self.generator_definition = CACHED_GENERATOR_DEFINITIONS[self.generator_identifier]
if skip_save is False:
self.save()
return CACHED_GENERATOR_DEFINITIONS[self.generator_identifier]
def fetch_source_reference(self, skip_save=False):
if self.source in CACHED_SOURCE_REFERENCES:
source_reference = CACHED_SOURCE_REFERENCES[self.source]
else:
source_reference = DataSourceReference.objects.filter(source=self.source).order_by('pk').first()
if source_reference is None:
source_reference = DataSourceReference(source=self.source)
source_reference.save()
CACHED_SOURCE_REFERENCES[self.source] = source_reference
if self.source_reference_id is None:
self.source_reference = CACHED_SOURCE_REFERENCES[self.source]
if skip_save is False:
self.save()
return CACHED_SOURCE_REFERENCES[self.source]
def attach_files(self, point_property, bundle_files):
if isinstance(point_property, dict):
for key, value in point_property.items():
if isinstance(value, str) and key.endswith('@'):
for bundle_file in bundle_files.filter(identifier=value):
bundle_file.data_point = self
bundle_file.save()
elif isinstance(value, list) and key.endswith('@'):
for identifier in value:
for bundle_file in bundle_files.filter(identifier=identifier):
bundle_file.data_point = self
bundle_file.save()
else:
self.attach_files(value, bundle_files)
elif isinstance(point_property, list):
for value in point_property:
self.attach_files(value, bundle_files)
def fetch_bundle_files(self, bundle_files):
properties = self.fetch_properties()
self.attach_files(properties, bundle_files)
def save(self, force_insert=False, force_update=False, using=None, update_fields=None):
if self.generator_identifier != 'pdk-virtual-point':
super(DataPoint, self).save(force_insert, force_update, using, update_fields)
else:
raise TypeError('Attempting to save pdk-virtual-point.')
def __str__(self):
return '%s (%s - id:%s)' % (self.generator_identifier, self.source, self.pk)
@receiver(post_save, sender=DataPoint)
def data_point_post_save(sender, instance, *args, **kwargs): # pylint: disable=unused-argument
try:
del instance.cached_properties
except AttributeError:
pass
class DataServerMetadatum(models.Model):
class Meta(object): # pylint: disable=old-style-class, no-init, too-few-public-methods, bad-option-value
verbose_name_plural = "data server metadata"
key = models.CharField(max_length=1024, db_index=True)
value = models.TextField(max_length=1048576)
last_updated = models.DateTimeField(null=True, blank=True)
def formatted_value(self): # pylint: disable=no-self-use
return '%s = %s' % (self.key, self.value)
@receiver(pre_save, sender=DataServerMetadatum)
def data_server_metadatum_pre_save(sender, instance, *args, **kwargs): # pylint: disable=unused-argument
instance.last_updated = timezone.now()
class DataBundle(models.Model):
recorded = models.DateTimeField()
errored = models.DateTimeField(null=True, blank=True)
if install_supports_jsonfield():
properties = JSONField()
else:
properties = models.TextField(max_length=(32 * 1024 * 1024 * 1024))
processed = models.BooleanField(default=False, db_index=True)
encrypted = models.BooleanField(default=False)
compression = models.CharField(max_length=128, choices=COMPRESSION_CHOICES, default='none')
class DataFile(models.Model):
data_point = models.ForeignKey(DataPoint, related_name='data_files', null=True, blank=True, on_delete=models.CASCADE)
data_bundle = models.ForeignKey(DataBundle, related_name='data_files', null=True, blank=True, on_delete=models.SET_NULL)
identifier = models.CharField(max_length=256, db_index=True)
content_type = models.CharField(max_length=256, db_index=True)
content_file = models.FileField(upload_to='data_files')
@python_2_unicode_compatible
class DataSourceGroup(models.Model):
name = models.CharField(max_length=1024, db_index=True)
suppress_alerts = models.BooleanField(default=False)
def __str__(self):
return str(self.name)
def refresh_performance_metadata(self):
for member in self.sources.all():
member.refresh_performance_metadata()
@python_2_unicode_compatible
class DataServer(models.Model):
name = models.CharField(max_length=1024, unique=True)
upload_url = models.URLField(max_length=1024, unique=True)
source_metadata_url = models.URLField(max_length=1024, null=True, blank=True)
request_key = models.CharField(max_length=1024, default='', null=True, blank=True)
def __str__(self):
return str(self.name)
class DataSourceManager(models.Manager): # pylint: disable=too-few-public-methods
def sources(self): # pylint: disable=no-self-use
source_list = []
for source in DataSource.objects.all():
if (source.identifier in source_list) is False:
source_list.append(source.identifier)
return source_list
@python_2_unicode_compatible
class DataSource(models.Model):
objects = DataSourceManager()
identifier = models.CharField(max_length=1024, db_index=True)
name = models.CharField(max_length=1024, db_index=True, unique=True)
group = models.ForeignKey(DataSourceGroup, related_name='sources', blank=True, null=True, on_delete=models.SET_NULL)
suppress_alerts = models.BooleanField(default=False)
if install_supports_jsonfield():
performance_metadata = JSONField(null=True, blank=True)
else:
performance_metadata = models.TextField(max_length=(32 * 1024 * 1024 * 1024), null=True, blank=True)
performance_metadata_updated = models.DateTimeField(db_index=True, null=True, blank=True)
server = models.ForeignKey(DataServer, related_name='sources', null=True, blank=True, on_delete=models.SET_NULL)
configuration = models.ForeignKey(AppConfiguration, related_name='sources', null=True, blank=True, on_delete=models.SET_NULL)
def __str__(self):
return self.name + ' (' + self.identifier + ')'
def details_url(self):
url = reverse('pdk_source', args=[self.identifier])
if self.server is None:
return url
components = urlparse(self.server.upload_url)
return urlunsplit((components.scheme, components.netloc, url, '', ''))
def fetch_definition(self):
definition = {
'name': self.name,
'identifier': self.identifier,
'latest_user_agent': self.latest_user_agent(),
'suppresses_alerts': self.should_suppress_alerts(),
'point_count': self.point_count(),
}
if self.group is not None:
definition['group'] = self.group.name
else:
definition['group'] = None
for app in settings.INSTALLED_APPS:
try:
pdk_api = importlib.import_module(app + '.pdk_api')
definition = pdk_api.annotate_source_definition(self, definition)
except ImportError:
pass
except AttributeError:
pass
return definition
def fetch_performance_metadata(self):
if self.performance_metadata is not None:
if install_supports_jsonfield():
return self.performance_metadata
if self.performance_metadata.strip():
return json.loads(self.performance_metadata)
return {}
def should_suppress_alerts(self, skip_server_check=False):
if self.suppress_alerts:
return True
if skip_server_check is False:
if self.server is not None:
return True
if self.group and self.group.suppress_alerts:
return True
return False
def fetch_source_reference(self):
source_reference = DataSourceReference.objects.filter(source=self.identifier).first()
if source_reference is None:
source_reference = DataSourceReference(source=self.identifier)
source_reference.save()
return source_reference
def update_performance_metadata(self): # pylint: disable=too-many-branches, too-many-statements, too-many-locals
if self.server is None:
source_reference = self.fetch_source_reference()
metadata = self.fetch_performance_metadata()
now = timezone.now()
window_start = now - datetime.timedelta(days=METADATA_WINDOW_DAYS)
day_ago = timezone.now() - datetime.timedelta(days=1)
DataPoint.objects.filter(source_reference=source_reference, server_generated=False, user_agent__icontains='Passive Data Kit Server', created__gte=day_ago).update(server_generated=True)
# Update latest_point
latest_point = self.latest_point()
query = Q(source_reference=source_reference)
if latest_point is not None:
query = query & Q(created__gt=latest_point.created)
else:
latest_point = DataPoint.objects.filter(source_reference=source_reference).order_by('-created').first()
latest_count = DataPoint.objects.filter(query).count()
latest_index = 0
point = None
while latest_index < latest_count:
for late_point in DataPoint.objects.filter(query).order_by('-created')[latest_index:(latest_index + 500)]:
if late_point.server_generated is False:
user_agent = late_point.fetch_user_agent()
if ('Passive Data Kit Server' in user_agent) is False:
point = late_point
break
if point is not None:
break
latest_index += 500
while point is not None:
user_agent = point.fetch_user_agent()
if ('Passive Data Kit Server' in user_agent) is False:
metadata['latest_point'] = point.pk
latest_point = point
point = None
else:
point = DataPoint.objects.filter(source_reference=source_reference, server_generated=False, created__lt=point.created).order_by('-created').first()
if point is not None:
metadata['latest_point'] = point.pk
if latest_point is not None:
metadata['user_agent'] = latest_point.fetch_user_agent()
metadata['latest_point_created'] = calendar.timegm(latest_point.created.timetuple())
latest_point_recorded = self.latest_point_recorded()
query = Q(source_reference=source_reference)
if latest_point_recorded is not None:
query = query & Q(recorded__gt=latest_point_recorded.recorded)
point = None
user_count = DataPoint.objects.filter(query).count()
user_index = 0
while user_index < user_count:
for user_point in DataPoint.objects.filter(query).order_by('-recorded')[user_index:(user_index + 500)]:
if user_point.server_generated is False:
user_agent = user_point.fetch_user_agent()
if ('Passive Data Kit Server' in user_agent) is False:
point = user_point
break
if point is not None:
break
user_index += 500
while point is not None:
user_agent = point.fetch_user_agent()
if ('Passive Data Kit Server' in user_agent) is False:
metadata['latest_point_recorded'] = point.pk
latest_point_recorded = point
point = None
else:
point = DataPoint.objects.filter(source_reference=source_reference, server_generated=False, recorded__lt=point.recorded).order_by('-recorded').first()
if point is not None:
metadata['latest_point_recorded'] = point.pk
if latest_point_recorded is not None:
metadata['latest_point_recorded_time'] = calendar.timegm(latest_point_recorded.recorded.timetuple())
# Update point_count
metadata['point_count'] = DataPoint.objects.filter(source_reference=source_reference, created__gte=window_start).count()
# Update point_frequency
metadata['point_frequency'] = 0
if metadata['point_count'] > 1:
earliest_point = DataPoint.objects.filter(source_reference=source_reference, created__gte=window_start).order_by('created').first()
seconds = (latest_point.created - earliest_point.created).total_seconds()
if seconds > 0:
metadata['point_frequency'] = old_div(metadata['point_count'], seconds)
generators = []
identifiers = DataPoint.objects.generator_identifiers_for_source(self.identifier, since=window_start)
for identifier in identifiers:
definition = DataGeneratorDefinition.definition_for_identifier(identifier)
generator = {}
generator['identifier'] = identifier
generator['source'] = self.identifier
generator['label'] = generator_label(identifier)
generator['points_count'] = DataPoint.objects.filter(source_reference=source_reference, created__gte=window_start, generator_definition=definition).count()
last_recorded = DataPoint.objects.filter(source_reference=source_reference, generator_definition=definition, created__gte=window_start).order_by('-recorded').first()
if last_recorded is not None:
first_point = DataPoint.objects.filter(source_reference=source_reference, generator_definition=definition, created__gte=window_start).order_by('created').first()
last_point = DataPoint.objects.filter(source_reference=source_reference, generator_definition=definition, created__gte=window_start).order_by('-created').first()
generator['last_recorded'] = calendar.timegm(last_recorded.recorded.timetuple())
generator['first_created'] = calendar.timegm(first_point.created.timetuple())
generator['last_created'] = calendar.timegm(last_point.created.timetuple())
duration = (last_point.created - first_point.created).total_seconds()
if generator['points_count'] > 1 and duration > 0:
generator['frequency'] = float(generator['points_count']) / duration
else:
generator['frequency'] = 0
generators.append(generator)
metadata['generator_statistics'] = generators
if install_supports_jsonfield():
self.performance_metadata = metadata
else:
self.performance_metadata = json.dumps(metadata, indent=2)
self.performance_metadata_updated = timezone.now()
self.save()
elif self.server.source_metadata_url is not None:
payload = {
'identifier': self.identifier,
'request-key': self.server.request_key
}
identifier_post = requests.post(self.server.source_metadata_url, data=payload, timeout=120)
if identifier_post.status_code >= 200 and identifier_post.status_code < 300:
metadata = identifier_post.json()
if install_supports_jsonfield():
self.performance_metadata = metadata
else:
self.performance_metadata = json.dumps(metadata, indent=2)
for app in settings.INSTALLED_APPS:
try:
pdk_api = importlib.import_module(app + '.pdk_api')
pdk_api.process_remote_metadata(self.identifier, metadata)
except ImportError:
pass
except AttributeError:
pass
else:
print('Server code ' + str(identifier_post.status_code) + ' received for request for ' + self.identifier + ' metadata from ' + self.server.source_metadata_url)
self.performance_metadata_updated = timezone.now()
self.save()
def refresh_performance_metadata(self):
self.performance_metadata_updated = None
self.save()
def latest_point(self):
metadata = self.fetch_performance_metadata()
if self.server is None:
if 'latest_point' in metadata:
return DataPoint.objects.filter(pk=metadata['latest_point']).first()
source_reference = DataSourceReference.reference_for_source(self.identifier)