-
Notifications
You must be signed in to change notification settings - Fork 5
/
database.py
4247 lines (3810 loc) · 189 KB
/
database.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
import sqlite3
import mysql.connector as mariadb
from datetime import datetime, timedelta
from hashlib import md5
from csv import writer
from io import StringIO
import pycountry
import json
import random
import re
from yaml import load, Loader
# The following 9 lines are necessary until the trusat-orbit repo is public
import inspect
import os
import sys
currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
parentdir = os.path.dirname(currentdir)
tle_path = os.path.join(parentdir, "trusat-orbit")
sys.path.insert(1,tle_path)
import tle_util
import iod
import logging
log = logging.getLogger(__name__)
"""
database.py: Does database interactions for the Open Satellite Catalog
"""
def batch(iterable, n=1):
"Produce batch from <iterable> of size <n>."
l = len(iterable)
for ndx in range(0, l, n):
yield iterable[ndx : min(ndx + n, l)]
def QueryRowToJSON_JSON(var):
""" Take the results of an SQL fetchone and returns a dictionary version of the string """
try:
return json.loads(var[0])
except:
return {}
def stringArrayToJSONArray(string_array):
""" Convert a string array into a string version of a json array. """
json_array = []
for item in string_array:
json_array.append(json.loads(item[0]))
return json.dumps(
json_array,
sort_keys=False,
indent=4)
def stringArrayToJSONArray_JSON(string_array):
""" Convert a string array into a json array. """
json_array = []
for item in string_array:
json_array.append(json.loads(item[0]))
return json_array
def QueryTupleListToList(var):
""" Take the result of a SQL fetchall single variable query tuple list and make a regular python list """
list = []
for i in var:
list.append(i[0])
return list
def datetime_from_sqldatetime(sql_date_string):
""" The 4 digit sub-seconds are not the standard 3 or 6, which creates problems with datetime.fromisoformat """
date_format = '%Y-%m-%d %H:%M:%S.%f'
return datetime.strptime(sql_date_string, date_format)
def convert_country_names(object_observed):
""" Convert country names into two letter abbreviation for a list """
for observation in object_observed:
countries_two_letters = ''
country_count = 0
try:
countries = observation["object_origin"].split("/")
for country in countries:
c = pycountry.countries.get(name=country)
if c == None:
c = pycountry.countries.get(alpha_3=country)
if c:
if country_count == 0:
country_count = 1
countries_two_letters = c.alpha_2
else:
countries_two_letters = countries_two_letters + '/' + c.alpha_2
else:
if country_count == 0:
country_count = 1
countries_two_letters = c.alpha_2
else:
countries_two_letters = countries_two_letters + '/' + c.alpha_2
observation["object_origin"] = countries_two_letters
except:
observation["object_origin"] = ''
return
def convert_country_names_single(observation):
""" Convert country names into two letter abbreviation for a single object """
countries_two_letters = ''
country_count = 0
try:
countries = observation["object_origin"].split("/")
for country in countries:
c = pycountry.countries.get(name=country)
if c == None:
c = pycountry.countries.get(alpha_3=country)
if c:
if country_count == 0:
country_count = 1
countries_two_letters = c.alpha_2
else:
countries_two_letters = countries_two_letters + '/' + c.alpha_2
else:
if country_count == 0:
country_count = 1
countries_two_letters = c.alpha_2
else:
countries_two_letters = countries_two_letters + '/' + c.alpha_2
observation["object_origin"] = countries_two_letters
except:
observation["object_origin"] = ''
return
def generateUsername():
EXCLUDE = [
'General', 'Our Dwarves', 'Our Moons', 'Exoplanets',
'Stars', 'wiki', 'Crux', 'Greek letters'
]
regex = re.compile('[^a-zA-Z]') # to remove non-letter characters
# create list of all keywords from text file
f = open('./database_tools/keywords.txt', 'r').read()
_keywords = f.split('\n')
keywords = []
for k in _keywords:
sample = regex.sub('', k)
if sample in EXCLUDE or k in EXCLUDE:
continue
if sample != '':
keywords.append(sample)
# generate unique username
total_keywords = len(keywords) - 1
_username = []
while True:
x = random.randint(0,total_keywords)
if keywords[x] not in _username:
_username.append(keywords[x])
if len(_username) == 2:
break
username = ''.join(_username)
return username
# We haven't defined a Station class anywhere, so might as well do it here.
class Station:
""" Class object to contain all the database details for an COSPAR Station record
"""
def __init__(self):
self.station_num = None
self.initial = None
self.latitude = None
self.longitude = None
self.elevation_m = None
self.name = None
self.MPC = None
self.details = None
self.preferred_format = None
self.source_url = None
self.notes = None
self.user = None
class Database:
""" Database class opens and stores connection to the database, and performs database operations.
Connect to database
inputs:
dbname - name of the database
dbtype - database type INFILE, sqlserver or sqlite3
dbhostname - hostname for sqlserver
dbusername - username for sqlserver
dbpassword - password for sqlserver
"""
def __init__(self, db_config_path):
with open(db_config_path) as f:
db_config = load(f, Loader=Loader)["Database"]
self._dbname = db_config["name"] or os.getenv('TRUSAT_DATABASE_NAME', None)
self._dbtype = db_config.get("type")
self._dbhostname = db_config.get("hostname") or os.getenv('TRUSAT_DATABASE_HOST', None)
self._dbusername = db_config.get("username") or os.getenv('TRUSAT_DATABASE_USER', None)
self._dbpassword = db_config.get("password") or os.getenv('TRUSAT_DATABASE_PASSWORD', "")
self._dbname or log.error("No database name specified")
self._dbhostname or log.error("No database host specified")
self._dbpassword or log.error("No database user specified")
self._last_observer_id = None
self._IODentryList = []
self._IODPendingEntryFingerprintList = [] # Used for dupe-checking within an INSERT batch
self._TLEentryList = []
self._TLEFileDict = {} # Used for INFILE method
self._observerDict = {} # Used for INFILE method
self._tle_fingerprintDict = {} # Used for INFILE method
self._obsid = 0
self._new_observerid = 0
self._iod_line_fingerprintDict = {} # Used for INFILE method
self._tle_file_fingerprintDict = {} # Used for INFILE method
self._SATCAT_file_fingerprintDict = {} # Used for INFILE method
self._UCSDB_file_fingerprintDict = {} # Used for INFILE method
# Account for differences in SQL expressions
if (self._dbtype == "sqlserver"):
self.charset_string = "CHARSET=utf8 ENGINE=Aria;"
self.increment = " AUTO_INCREMENT"
else:
self.charset_string = ""
self.increment = " AUTOINCREMENT"
if self._dbtype == "INFILE": # Make CSV files
self._f_ParsedIOD = open(self._dbname + "_ParsedIOD.csv", 'w')
self._writer_ParsedIOD = writer(self._f_ParsedIOD, dialect='unix')
self._f_Observer = open(self._dbname + "_Observer.csv", 'w')
self._writer_Observer = writer(self._f_Observer, dialect='unix')
self._f_TLE = open(self._dbname + "_TLE.csv", 'w')
self._writer_TLE = writer(self._f_TLE, dialect='unix')
self._f_TLEFile = open(self._dbname + "_TLEFILE.csv", 'w')
self._writer_TLEFile = writer(self._f_TLEFile, dialect='unix')
self._f_SATCAT = open(self._dbname + "_SATCAT.csv", 'w')
self._writer_SATCAT = writer(self._f_SATCAT, dialect='unix')
self._f_UCSDB = open(self._dbname + "_UCSDB.csv", 'w')
self._writer_UCSDB = writer(self._f_UCSDB, dialect='unix')
elif self._dbtype == "sqlserver": # Make database
log.info("Connecting to the sqlserver Database...")
self.conn = mariadb.connect(
host=self._dbhostname,
user=self._dbusername,
passwd=self._dbpassword,
db=self._dbname,
charset='utf8',
use_unicode=True
)
self.c = self.conn.cursor()
self.cdict = self.conn.cursor(dictionary=True)
# Need a cursor for each prepared statement
# TODO: Probably don't need prepared statements for all of these
self.c_addParsedIOD = self.conn.cursor(prepared=True)
self.c_addStation_query = None
self.c_addObserver_query = self.conn.cursor(prepared=True)
self.c_addObserverEmail_query = self.conn.cursor(prepared=True)
self.c_selectObserver_query = self.conn.cursor(prepared=True)
self.c_updateObserverNonceBytes_query = self.conn.cursor(prepared=True)
self.c_updateObserverJWT_query = self.conn.cursor(prepared=True)
self.c_updateObserverUsername_query = self.conn.cursor(prepared=True)
self.c_updateObserverEmail_query = self.conn.cursor(prepared=True)
self.c_updateObserverBio_query = self.conn.cursor(prepared=True)
self.c_updateObserverLocation_query = self.conn.cursor(prepared=True)
self.c_updateObserverPrivate_query = self.conn.cursor(prepared=True)
self.c_updateObserverPassword_query = self.conn.cursor(prepared=True)
self.c_updateObserverAddress_query = self.conn.cursor(prepared=True)
self.c_getObserverNonceBytes_query = self.conn.cursor(prepared=True)
self.c_getObserverJWT_query = self.conn.cursor(prepared=True)
self.c_getObserverCountByID_query = self.conn.cursor(prepared=True)
self.c_selectTLEFile_query = self.conn.cursor(prepared=True)
self.c_selectTLEFingerprint_query = self.conn.cursor(prepared=True)
self.c_selectIODFingerprint_query = self.conn.cursor(prepared=True)
self.c_addTLE_query = self.conn.cursor(prepared=True)
self.c_addTLEFile_query = self.conn.cursor(prepared=True)
self.c_addTLEProcess_query = self.conn.cursor(prepared=True)
self.c_addSATCAT_query = self.conn.cursor(prepared=True)
self.c_addUCSDB_query = self.conn.cursor(prepared=True)
self.c_selectObserverID_query = self.conn.cursor(prepared=True)
self.c_selectObserverAddressFromEmail_query = self.conn.cursor(prepared=True)
self.c_selectEmailFromObserverAddress_query = self.conn.cursor(prepared=True)
self.c_selectObserverPasswordFromAddress_query = self.conn.cursor(prepared=True)
self.c_selectObserverAddressFromPassword_query = self.conn.cursor(prepared=True)
self.selectObserverID_query = '''SELECT max(id) from Observer'''
try:
self.c_selectObserverID_query.execute(self.selectObserverID_query, [])
self._new_observerid = self.c_selectObserverID_query.fetchone()[0]
except Exception as e:
log.error("Could not get ObserverID: {}".format(e))
self._new_observerid = 0
else:
log.info("Connecting to the SQLite Database...")
self.conn = sqlite3.connect(self._dbname + ".db")
self.c = self.conn.cursor()
# Predefined queries - In the case of sqlserver, prepared statements accelerate / secure import queries
# %s only works for sqlserver, ? works for both sqlite and sqlserver
self.addStation_query = None
self.addObserver_query = '''INSERT INTO Observer(id, eth_addr, name, reputation, reference) VALUES(?,?,?,?,?)'''
self.addObserverEmail_query = '''INSERT INTO Observer_email(user_id, email) VALUES(?,?)'''
self.selectObserver_query = '''SELECT id FROM Observer WHERE verified LIKE ? LIMIT 1'''
self.updateObserverNonceBytes_query = '''UPDATE Observer SET nonce_bytes=? WHERE eth_addr=?'''
self.updateObserverJWT_query = '''UPDATE Observer SET jwt=?, jwt_secret=? WHERE eth_addr=?'''
self.updateObserverUsername_query = '''UPDATE Observer SET name=? WHERE eth_addr=?'''
self.updateObserverEmail_query = '''UPDATE Observer_email INNER JOIN Observer ON Observer_email.user_id=Observer.id SET Observer_email.email=? WHERE Observer.eth_addr=?'''
self.updateObserverLocation_query = '''UPDATE Observer SET location=? WHERE eth_addr=?'''
self.updateObserverBio_query = '''UPDATE Observer SET bio=? WHERE eth_addr=?'''
self.updateObserverPassword_query = '''UPDATE Observer SET password=? WHERE eth_addr=?'''
self.updateObserverAddress_query = '''UPDATE Observer SET eth_addr=? WHERE eth_addr=?'''
self.getObserverNonceBytes_query = '''SELECT nonce_bytes FROM Observer WHERE eth_addr=?'''
self.getObserverJWT_query = '''SELECT jwt FROM Observer WHERE eth_addr=?'''
self.getObserverCountByID_query = '''SELECT id, COUNT(*) from Observer WHERE eth_addr=?'''
self.selectObserverAddressFromEmail_query = '''SELECT Observer.eth_addr FROM Observer INNER JOIN Observer_email ON Observer.id=Observer_email.user_id WHERE Observer_email.email=? LIMIT 1'''
self.selectEmailFromObserverAddress_query = '''SELECT Observer_email.email FROM Observer_email INNER JOIN Observer ON Observer_email.user_id=Observer.id WHERE Observer.eth_addr=? LIMIT 1'''
self.selectObserverPasswordFromAddress_query = '''SELECT password FROM Observer WHERE eth_addr=? LIMIT 1'''
self.selectObserverAddressFromPassword_query = '''SELECT eth_addr FROM Observer WHERE password=? LIMIT 1'''
self.selectTLEFile_query = '''SELECT file_fingerprint FROM TLEFILE WHERE file_fingerprint LIKE ? LIMIT 1'''
self.selectTLEFingerprint_query = '''SELECT tle_fingerprint FROM TLE WHERE tle_fingerprint LIKE ? LIMIT 1'''
self.selectIODFingerprint_query = '''SELECT obsFingerPrint FROM ParsedIOD WHERE obsFingerPrint LIKE ? LIMIT 1'''
# !TODO: there may be more than one IOD for a given {object, observation time}. Limit to 1, perhaps arbitrarily if we have no way of discriminating.
# Latest TLEs for each object that are not known to be decayed
self.selectLatestTLEPerObject = """
SELECT TLE.line0, TLE.line1, TLE.line2, TLE.satellite_number, TLE.epoch FROM
(SELECT max(epoch) AS epoch, satellite_number
FROM TLE
GROUP BY satellite_number) AS latest_tles
LEFT JOIN TLE ON (TLE.satellite_number = latest_tles.satellite_number AND TLE.epoch = latest_tles.epoch)
LEFT JOIN celestrak_SATCAT SatCat ON (TLE.satellite_number = SatCat.norad_num)
WHERE (SatCat.ops_status_code <> 'D' OR SatCat.ops_status_code IS NULL)
"""
self.selectLatestTLEPerObjectCount = """
SELECT COUNT(TLE.line0) FROM
(SELECT max(epoch) AS epoch, satellite_number
FROM TLE
GROUP BY satellite_number) AS latest_tles
LEFT JOIN TLE ON (TLE.satellite_number = latest_tles.satellite_number AND TLE.epoch = latest_tles.epoch)
LEFT JOIN celestrak_SATCAT SatCat ON (TLE.satellite_number = SatCat.norad_num)
WHERE (SatCat.ops_status_code <> 'D' OR SatCat.ops_status_code IS NULL)
"""
self.selectLatestTLEPerObjectCountCategories = """
SELECT COUNT(TLE.line0) FROM
(SELECT max(epoch) AS epoch, satellite_number
FROM TLE
GROUP BY satellite_number) AS latest_tles
LEFT JOIN TLE ON (TLE.satellite_number = latest_tles.satellite_number AND TLE.epoch = latest_tles.epoch)
LEFT JOIN celestrak_SATCAT SatCat ON (TLE.satellite_number = SatCat.norad_num)
JOIN categories ON (TLE.satellite_number = categories.obj_no)
WHERE (SatCat.ops_status_code <> 'D' OR SatCat.ops_status_code IS NULL)
"""
self.selectCatalogQueryPrefix = """
WITH catalog as (
WITH latest_obs_times as (SELECT object_number, max(obs_time) max_obs_time
FROM ParsedIOD
WHERE ParsedIOD.valid_position = 1
and object_number is not null
group by object_number)
-- There can be multiple obs_ids per {object_number, obs_time}, so we GROUP BY object_number again to ensure only one match
,latest_obs_ids as (SELECT P.obs_id, P.object_number, P.obs_time, P.station_number obs_station_number
FROM latest_obs_times L
LEFT JOIN ParsedIOD P on (L.object_number = P.object_number and L.max_obs_time = P.obs_time)
group by object_number)
-- There can theoretically be multiple users per station, so we GROUP BY object_number again to ensure only one match
,latest_obs_with_users as (SELECT L.*, S.user obs_user
FROM latest_obs_ids L
LEFT JOIN Station S on (S.station_num = L.obs_station_number)
group by object_number)
,obj_with_categories as (
SELECT LU.*, U.comments obj_comments, U.purpose obj_purpose, U.purpose_detailed obj_purpose_detailed,
U.country_owner obj_country_owner, SatCat.name obj_name, SatCat.launch_date obj_launch_date, SatCat.orbit_status_code,
C.obj_no, C.sub_category, C.description as CT_description, C.obj_categories
FROM latest_obs_with_users LU
LEFT JOIN ucs_SATDB U ON (LU.object_number = U.norad_number)
LEFT JOIN celestrak_SATCAT SatCat ON (LU.object_number = SatCat.norad_num)
LEFT JOIN (
SELECT obj_no, sub_category, description, GROUP_CONCAT(sub_category SEPARATOR ', ') as obj_categories
FROM categories
GROUP BY obj_no
) AS C ON LU.object_number = C.obj_no
WHERE (SatCat.ops_status_code <> 'D' OR SatCat.ops_status_code IS NULL)
)
SELECT
IODs.*,
Obs.eth_addr obs_eth_addr, Obs.name obs_user_name,
CONCAT_WS(' — ',CT_description, obj_categories, obj_purpose_detailed, obj_comments) as obj_merged_description
FROM obj_with_categories as IODs
LEFT JOIN Observer Obs on (IODs.obs_user = Obs.id)
)
"""
self.selectCatalogJsonObject = """
Json_Object(
'object_norad_number', object_number,
'object_name', obj_name,
'object_origin', obj_country_owner,
'object_type', obj_purpose,
'object_primary_purpose', obj_purpose_detailed,
'object_secondary_purpose', obj_comments,
'object_merged_description', obj_merged_description,
'object_observation_quality', %(QUALITY)s,
'object_launch_date', obj_launch_date,
'time_last_tracked', date_format(obs_time, '%M %d, %Y'),
'address_last_tracked', obs_eth_addr,
'username_last_tracked',obs_user_name)
"""
self.addParsedIOD_query = '''INSERT INTO ParsedIOD (
submitted,
object_number,
international_designation,
station_number,
station_status_code,
obs_time_string,
obs_time,
time_uncertainty,
time_standard_code,
angle_format_code,
epoch_code,
epoch,
ra,
declination,
azimuth,
elevation,
positional_uncertainty,
optical_behavior_code,
visual_magnitude,
visual_magnitude_high,
visual_magnitude_low,
magnitude_uncertainty,
flash_period,
remarks,
iod_type,
iod_string,
valid_position,
message_id,
obsFingerPrint
) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)'''
# TODO: add mean_motion_radians_per_minute from the TLE class to here
self.addTLE_query = '''INSERT INTO TLE (
line0,
line1,
line2,
sat_name,
satellite_number,
classification,
designation,
epoch,
mean_motion_derivative,
mean_motion_sec_derivative,
bstar,
ephemeris_type,
element_set_number,
inclination,
inclination_radians,
raan_degrees,
raan_radians,
eccentricity,
arg_perigee_degrees,
arg_perigee_radians,
mean_anomaly_degrees,
mean_anomaly_radians,
mean_motion_orbits_per_day,
mean_motion_radians_per_second,
orbit_number,
launch_piece_number,
analyst_object,
strict_import,
tle_fingerprint,
tle_file_fingerprint
) VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)'''
self.addTLEFile_query = '''INSERT INTO TLEFILE (file_fingerprint, source_filename) VALUES (?,?)'''
self.addTLEProcess_query = '''INSERT INTO TLE_process (
object_number,
obs_id,
tle_source_id,
tle_result_id,
aspect,
cross_track_err,
time_err,
position_err,
obs_weight,
tle_start_rms,
tle_result_rms,
remarks
) VALUES (%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)'''
""" TruSat Table Schema overview:
- ParsedIOD - Observations from IOD, RDE or UK formats
- Observer - User table
- Observer_email - User emails
- Station - Observation Station details
- station_status - Lookup of Character-pack to status description
- TLE - Two Line Elements
- TLEFILE - File record of externally-source elements (for dupe detection or source traceability)
- celestrak_SATCAT - Catalog description (externally sourced from Celestrak)
- ucs_SATDB_raw - Catalog description (raw data, externally sourced from UCS database)
- ucs_SATDB - ucs_SATDB fixed with data from celestrak.org
"""
def checkTableExists(self, tablename):
""" Determine if the requested database exists on the server """
try:
self.c.execute(
"""
SELECT COUNT(*)
FROM information_schema.tables
WHERE
table_schema = %s
AND table_name = %s
""",
(self._dbname,tablename)
)
if self.c.fetchone()[0] == 1:
return True
except Exception as e:
log.error("MYSQL ERROR: {}".format(e))
return False
return False
def createObsTables(self):
""" Generate Observation tables """
if self.checkTableExists("ParsedIOD"):
log.info("ParsedIOD table found.")
else:
log.info("Creating Observation tables...")
""" ParsedIOD """
createquery = '''CREATE TABLE IF NOT EXISTS ParsedIOD (
obs_id INT NOT NULL ''' + self.increment + ''', /* Unique internal ID */
submitted DATETIME, /* Datetime when the user submitted the observation (receipt time or time of email) */
object_number MEDIUMINT(5) UNSIGNED, /* NORAD number */
international_designation VARCHAR(14), /* International designation */
station_number VARCHAR(4) NOT NULL, /* Station number that made observation */
station_status_code CHAR(1), /* Packed code of station status - unpacked in station_status table */
obs_time_string VARCHAR(27), /* Source ascii string for observation time (for IOD.py debugging) */
obs_time DATETIME(6), /* Exact time of observation */
time_uncertainty FLOAT, /* Observation uncertainty (seconds) */
time_standard_code TINYINT, /* Coded time standard */
angle_format_code TINYINT(4), /* Packed code of angle format */
epoch_code TINYINT(4), /* Packed code of angle EPOCH format */
epoch SMALLINT, /* Decoded EPOCH year */
ra DOUBLE, /* right ascension (radians) - derived from az/el by iod.py if not provided */
declination DOUBLE, /* declination of observation (radians) - 'dec' appears to be namespace collision. derived from az/el by iod.py if not provided */
azimuth DOUBLE, /* azimuth of observation (radians) - derived from ra/dec by iod.py if not provided */
elevation DOUBLE, /* elevation of observation (radians) - derived from ra/dec by iod.py if not provided */
positional_uncertainty DOUBLE, /* Position uncertainy of observation (radians) */
optical_behavior_code CHAR(1), /* Packed code of optical behavior */
visual_magnitude FLOAT,
visual_magnitude_high FLOAT,
visual_magnitude_low FLOAT,
magnitude_uncertainty FLOAT,
flash_period FLOAT, /* seconds */
remarks TEXT, /* Any comments right of the formatted portion of the record */
iod_type VARCHAR(3), /* Source type of Observation: IOD, RDE, UK */
iod_string TEXT NOT NULL, /* Full / original unparsed observation record */
valid_position BOOL, /* Status flag pertaining to iod.py validity checks */
message_id TEXT, /* Source mail header message ID (if available) */
obsFingerPrint CHAR(32) NOT NULL UNIQUE, /* Unique MD5 fingerprint of observation */
import_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL, /* Timestamp of DB record creation */
PRIMARY KEY (`obs_id`),
UNIQUE KEY `ParsedIOD_obsFingerPrint_idx` (`obsFingerPrint`),
KEY `ParsedIOD_object_number_idx` (`object_number`) USING BTREE,
KEY `ParsedIOD_international_designation_idx` (`international_designation` (14)) USING BTREE,
KEY `ParsedIOD_station_number_idx` (`station_number`) USING BTREE,
KEY `ParsedIOD_obs_time_idx` (`obs_time`) USING BTREE,
KEY `ParsedIOD_valid_position_idx` (`valid_position`) USING BTREE
)''' + self.charset_string
self.c.execute(createquery)
# Requires setting log_bin_trust_function_creators=1 on the AWS RDS instance
# https://stackoverflow.com/a/30874794
# Note we're counting on iod.py to set object_number to 0 if it is not available (UK/RDE formats)
""" Populate the NORAD object number on INSERT by looking up known International Designation """
create_trigger_query = """CREATE TRIGGER IF NOT EXISTS add_object_number
BEFORE INSERT ON ParsedIOD FOR EACH ROW
BEGIN
IF NEW.object_number = 0 THEN
SET NEW.object_number = (
SELECT celestrak_SATCAT.norad_num from celestrak_SATCAT
WHERE NEW.international_designation = celestrak_SATCAT.intl_desg LIMIT 1);
END IF;
END;"""
try:
self.c.execute(create_trigger_query)
except (MySQLdb.Error, MySQLdb.Warning) as e:
log.warning(e)
log.warning("You may need to set log_bin_trust_function_creators=1 in your database instance.")
# Note we're counting on iod.py to set international designation to "?" if it's questionable
""" Populate the International Designation on INSERT by looking up known NORAD object number """
create_trigger_query = """CREATE TRIGGER IF NOT EXISTS add_international_designation
BEFORE INSERT ON ParsedIOD FOR EACH ROW
BEGIN
IF NEW.international_designation = "?" THEN
SET NEW.international_designation = (
SELECT celestrak_SATCAT.intl_desg from celestrak_SATCAT
WHERE NEW.object_number = celestrak_SATCAT.norad_num LIMIT 1);
END IF;
END;"""
try:
self.c.execute(create_trigger_query)
except (MySQLdb.Error, MySQLdb.Warning) as e:
log.warning(e)
log.warning("You may need to set log_bin_trust_function_creators=1 in your database instance.")
if self.checkTableExists("TLE_process"):
log.info("TLE_process table found.")
else:
log.info("Creating TLE_process table...")
""" TLE_process """
createquery = '''CREATE TABLE IF NOT EXISTS TLE_process (
process_id INT NOT NULL ''' + self.increment + ''', /* Unique internal ID of observation */
object_number MEDIUMINT(5) UNSIGNED, /* NORAD Num of TLE/Obs */
obs_id INT NOT NULL, /* ID of observation */
tle_source_id INT NOT NULL, /* ID of starting reference TLE */
tle_result_id INT NOT NULL, /* ID of TLE created with this obs_id */
aspect FLOAT, /* degrees */
cross_track_err FLOAT, /* degrees, left of track is positive */
time_err FLOAT, /* seconds */
position_err FLOAT, /* degrees */
obs_weight FLOAT, /* percentage */
tle_start_rms FLOAT, /* degrees^2 - value of RMS against reference TLE */
tle_result_rms FLOAT, /* degrees^2 - value of RMS against refined TLE */
remarks TEXT, /* Most likely for debugging notes */
process_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL, /* Timestamp of record creation */
PRIMARY KEY (`process_id`),
KEY `Process_object_number_idx` (`object_number`) USING BTREE,
KEY `Process_obs_id_idx` (`obs_id`) USING BTREE,
KEY `Process_tle_source_id_idx` (`tle_source_id`) USING BTREE,
KEY `Process_tle_result_id_idx` (`tle_result_id`) USING BTREE
)''' + self.charset_string
self.c.execute(createquery)
if self.checkTableExists("Station"):
log.info("Station table found.")
else:
log.info("Creating Station table...")
""" Station Table. These records are a mix of observer identity and station identity.
TODO: Will need to provide better separation between Observers / Stations in future releases.
"""
createquery = """CREATE TABLE IF NOT EXISTS Station (
station_num VARCHAR(4) NOT NULL, /* 4 Digit COSPAR number of observation station */
user INT, /* Associated User table ID */
initial TINYTEXT, /* Observer initials */
latitude FLOAT, /* WGS84 Latitude (degrees) */
longitude FLOAT, /* WGS84 Longitude (degrees) */
elevation_m SMALLINT(4), /* Elevation above mean sea level (meters) */
name TINYTEXT, /* Name field for station/observer */
MPC TINYTEXT, /* Minor Planet Center observatory code (if available) */
details TINYTEXT, /* Details describing the station */
preferred_format TINYTEXT, /* TruSat team notes on observer preferred reporting format IOD/RDE/UK */
source_url TINYTEXT, /* URL where confirming data can be found */
notes TINYTEXT, /* TruSat team processing notes */
opt_out TINYINT(1) DEFAULT NULL, /* Flag to prevent processing of data from disinterested stations */
UNIQUE KEY Station_station_num_idx (station_num) USING BTREE,
KEY Station_user_idx (user) USING BTREE,
KEY Station_user_station_idx (user, station_num),
KEY Station_opt_out_idx (opt_out) USING BTREE
)""" + self.charset_string
self.c.execute(createquery)
if self.checkTableExists("station_status"):
log.info("station_status table found.")
else:
log.info("Creating station_status table...")
""" Station Status """
createquery = """CREATE TABLE IF NOT EXISTS station_status (
code ENUM('B','C','E','F','G','O','P','T') NOT NULL, /* Single character station status code */
short_description TINYTEXT DEFAULT NULL, /* Terse status description */
description TINYTEXT DEFAULT NULL, /* Full status description */
KEY station_status_code_id (code) USING BTREE
)""" + self.charset_string
self.c.execute(createquery)
""" Station Status contents """
insertquery = """INSERT INTO station_status (code, short_description, description) VALUES
('E', 'excellent', 'no Moon/clouds, great seeing, minimal air/light pollution'),
('G', 'good', 'no Moon/clouds, conditions could be better, but not much'),
('F', 'fair ', 'young/old Moon, some air/light pollution making fainter stars invisible'),
('P', 'poor', 'gibbous Moon, haze, more air/light pollution making more stars invisible'),
('B', 'bad', 'bright Moon, air/light pollution, some clouds; difficult'),
('T', 'terrible', 'bright Moon, air/light pollution, looking through clouds'),
('C', 'clouded out', 'station unavailable'),
('O', 'sky clear, but observer not available', 'station unavailable');"""
self.c.execute(insertquery)
if self.checkTableExists("Observer"):
log.info("Observer table found.")
else:
log.info("Creating Observer table...")
""" Observer """
createquery = '''CREATE TABLE IF NOT EXISTS Observer (
id INTEGER PRIMARY KEY ''' + self.increment + ''', /* Internal ID */
eth_addr CHAR(42), /* Ethereum address for user */
verified TEXT, /* DEPRECATED */
reputation INTEGER, /* User rank value */
reference TEXT, /* Internal user ref notes for SeeSat archive */
nonce INTEGER,
jwt TEXT,
password TEXT,
jwt_secret CHAR(78),
location TINYTEXT, /* User-specified (publicly visible) location */
bio TEXT, /* User-specified (publicly visible) bio */
url_profile TEXT, /* Profile URL - notionally gravitar or similar. FIXME: need to protect for exploits */
url_image TEXT, /* Profile Image URL - notionally gravitar or similar. FIXME: need to protect for exploits */
KEY `Observer_id_idx` (`id`) USING BTREE,
KEY `Observer_eth_addr_idx` (`eth_addr`) USING BTREE,
KEY `Observer_reputation_idx` (`reputation`) USING BTREE
)''' + self.charset_string
self.c.execute(createquery)
if self.checkTableExists("Observer_email"):
log.info("Observer_email table found.")
else:
log.info("Creating Observer_email table...")
""" Observer_email """
createquery = '''CREATE TABLE IF NOT EXISTS Observer_email (
`user_id` INT(11) NOT NULL, /* Internal ID for Observer */
`email` TEXT DEFAULT NULL, /* Email Associated with Observer */
`primary` INT(11) DEFAULT NULL, /* Order to use Emails */
`notes` TEXT DEFAULT NULL, /* Internal Notes */
KEY `Observer_email_User_num_idx` (`user_id`) USING BTREE
)''' + self.charset_string
self.c.execute(createquery)
self.conn.commit()
def createTLETables(self):
if self.checkTableExists("TLE"):
log.info("TLE table found.")
else:
log.info("Creating TLE table...")
""" TLE """
# TODO: add mean_motion_radians_per_minute from the TLE class to here
createquery = '''CREATE TABLE IF NOT EXISTS TLE (
tle_id INTEGER PRIMARY KEY ''' + self.increment + ''', /* Internal unique record ID */
line0 TINYTEXT, /* line0/name from TLE */
line1 TINYTEXT, /* line1 of TLE */
line2 TINYTEXT, /* line2 of TLE record */
sat_name TINYTEXT, /* Name of object (may be same as line0) */
satellite_number MEDIUMINT NOT NULL, /* NORAD catalog number */
classification CHAR(1), /* Classification Code - TruSat generated TLEs use T */
designation CHAR(24), /* International Designator */
epoch DATETIME(6) NOT NULL, /* FIXME: Python Datetime of TLE epoch. Rename to epoch_datetime for clarity */
mean_motion_derivative DOUBLE,
mean_motion_sec_derivative DOUBLE,
bstar DOUBLE,
ephemeris_type TINYINT,
element_set_number MEDIUMINT,
inclination DOUBLE NOT NULL, /* FIXME - need to rename to degrees */
inclination_radians DOUBLE, /* Orbit inclination (radians) */
raan_degrees DOUBLE, /* Right Ascension of the Ascending Node (degrees) */
raan_radians DOUBLE, /* Right Ascension of the Ascending Node (radians) */
eccentricity DOUBLE NOT NULL, /* Orbit eccentricity */
arg_perigee_degrees DOUBLE, /* Argument of perigee (degrees) */
arg_perigee_radians DOUBLE, /* Argument of perigee (radians) */
mean_anomaly_degrees DOUBLE,
mean_anomaly_radians DOUBLE,
mean_motion_orbits_per_day DOUBLE,
mean_motion_radians_per_second DOUBLE, /* FIXME - need to at mean_motion_radians_per_minute for SGP4 convenience */
orbit_number MEDIUMINT, /* Orbit number since launch */
launch_piece_number SMALLINT, /* Derived number of launch piece (from international desg) */
analyst_object BOOL, /* Flag of whether this is an uncorrelated object */
strict_import BOOL, /* Whether this record was imported / created through strict_import checks */
tle_fingerprint CHAR(32) NOT NULL, /* MD5 fingerprint of this record */
tle_file_fingerprint CHAR(32), /* MD5 fingerprint of the file this record was imported from (optional) */
import_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL, /* Timestamp of record creation */
KEY `TLE_epoch_idx` (`epoch`) USING BTREE,
KEY `TLE_sat_name_idx` (`sat_name`(24)) USING BTREE,
UNIQUE KEY `TLE_tle_fingerprint_idx` (`tle_fingerprint`(32)) USING BTREE,
KEY `TLE_tle_file_fingerprint_idx` (`tle_file_fingerprint`(32)) USING BTREE,
KEY `TLE_norad_idx` (`satellite_number`) USING BTREE
)''' + self.charset_string
try:
self.c.execute(createquery)
self.conn.commit()
finally:
True
if self.checkTableExists("TLEFILE"):
log.info("TLEFILE table found.")
else:
log.info("Creating TLEFILE table...")
createquery = '''CREATE TABLE IF NOT EXISTS TLEFILE (
file_id INTEGER PRIMARY KEY ''' + self.increment + ''', /* Unique internal record ID */
file_fingerprint CHAR(32) NOT NULL, /* MD5 finger print of file */
source_filename TINYTEXT, /* Name of source file */
import_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL, /* Timestamp of record creation */
UNIQUE KEY `TLEFILE_file_fingerprint_33_idx` (`file_fingerprint`(32)) USING BTREE
)''' + self.charset_string
try:
self.c.execute(createquery)
self.conn.commit()
finally:
True
def create_celestrak_satcat_table(self):
""" Celestrak SATCAT """
if self.checkTableExists("celestrak_SATCAT"):
log.info("celestrak_SATCAT table found.")
else:
log.info("Creating celestrak_SATCAT table...")
# TODO: make another table from the multiple_name_flag data in https://celestrak.com/pub/satcat-annex.txt
createquery = (
"""CREATE TABLE IF NOT EXISTS celestrak_SATCAT (
sat_cat_id INTEGER """
+ self.increment
+ """,
intl_desg VARCHAR(11) NOT NULL,
norad_num MEDIUMINT UNSIGNED NOT NULL,
multiple_name_flag TINYINT(1) UNSIGNED NOT NULL,
payload_flag TINYINT(1) UNSIGNED NOT NULL,
ops_status_code VARCHAR(24),
name VARCHAR(24) NOT NULL,
source CHAR(5),
launch_date DATE,
launch_site VARCHAR(11),
decay_date DATE,
orbit_period_minutes DOUBLE,
inclination_deg DOUBLE,
apogee MEDIUMINT UNSIGNED,
perigee MEDIUMINT UNSIGNED,
radar_crosssec DOUBLE,
orbit_status_code CHAR(3),
line_fingerprint CHAR(32) NOT NULL,
import_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,
PRIMARY KEY (`sat_cat_id`),
KEY `celestrak_SATCAT_intl_desg_idx` (`intl_desg`(11)) USING BTREE,
KEY `celestrak_SATCAT_norad_num_idx` (`norad_num`) USING BTREE,
KEY `line_fingerprint` (`line_fingerprint`) USING BTREE,
KEY `celestrak_SATCAT_name_idx` (`name`) USING BTREE,
KEY `celestrak_SATCAT_orbit_status_code_idx` (`orbit_status_code`) USING BTREE
)"""
+ self.charset_string
)
try:
self.c.execute(createquery)
self.conn.commit()
finally:
True
def create_ucs_satdb_raw_table(self, ext=""):
""" Raw table is direct from UCS, with no errors corrected from Celestrak SATCAT """
self.create_ucs_satdb_table("_raw")
def create_ucs_satdb_table(self, ext=""):
""" Union of Concerned Scientists Satellite Database """
if self.checkTableExists("ucs_SATDB" + ext):
log.info("UCS SAT DB" + ext + " table found.")
else:
log.info("Creating Union of Concerned Scientists Satellite Database (ucs_SATDB" + ext + " ) table...")
# FIXME: Need to optimize these auto-gen types
createquery = ("""CREATE TABLE IF NOT EXISTS ucs_SATDB"""
+ ext
+ """(
satdb_id INTEGER PRIMARY KEY"""
+ self.increment
+ """,
name text DEFAULT NULL,
country_registered text DEFAULT NULL,
country_owner text DEFAULT NULL,
owner_operator text DEFAULT NULL,
users text DEFAULT NULL,
purpose text DEFAULT NULL,
purpose_detailed text DEFAULT NULL,
orbit_class text DEFAULT NULL,
orbit_type text DEFAULT NULL,
GEO_longitude int(11) DEFAULT NULL,
perigee_km int(11) DEFAULT NULL,
apogee_km int(11) DEFAULT NULL,
eccentricity float DEFAULT NULL,
inclination_degrees float DEFAULT NULL,
period_minutes int(11) DEFAULT NULL,
launch_mass_kg int(11) DEFAULT NULL,
dry_mass_kg text DEFAULT NULL,
power_watts text DEFAULT NULL,
launch_date DATE DEFAULT NULL,
expected_lifetime_years text DEFAULT NULL,
contractor text DEFAULT NULL,
contractor_country text DEFAULT NULL,
launch_site text DEFAULT NULL,
launch_vehicle text DEFAULT NULL,
international_designator text DEFAULT NULL,
norad_number int(11) DEFAULT NULL,
comments text DEFAULT NULL,
detailed_comments text DEFAULT NULL,
source_1 text DEFAULT NULL,
source_2 text DEFAULT NULL,
source_3 text DEFAULT NULL,
source_4 text DEFAULT NULL,
source_5 text DEFAULT NULL,
source_6 text DEFAULT NULL,
source_7 text DEFAULT NULL,
line_fingerprint CHAR(32) NOT NULL,
import_timestamp TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL,
KEY `ucs_SATDB_satdb_id_idx` (`satdb_id`) USING BTREE,
KEY `line_fingerprint` (`line_fingerprint`) USING BTREE,
KEY `ucs_SATDB_norad_number_idx` (`norad_number`) USING BTREE,
KEY `ucs_SATDB_international_designator_idx` (`international_designator`(11)) USING BTREE
)"""
+ self.charset_string
)
try:
self.c.execute(createquery)
self.conn.commit()
finally:
True
def add_celestrak_satcat_batch(self, data_batch):
""" Add an SATCAT entry to the database """
fingerprint_query = """
SELECT line_fingerprint FROM `celestrak_SATCAT`;
"""
find_with_norad = """
SELECT * FROM `celestrak_SATCAT`
WHERE `norad_numb`=%s;
"""
delete_by_norad = """
DELETE FROM celestrak_SATCAT
WHERE `norad_num`=%s;
"""
insert_query = """
INSERT INTO celestrak_SATCAT VALUES
(NULL, %s, %s, %s, %s, %s, %s, %s, %s, %s,
%s, %s, %s, %s, %s, %s, %s, %s, NULL)
"""
data_to_insert = []
updated_entries = 0
try:
self.c.execute(fingerprint_query)
SATCAT_fingerprints = QueryTupleListToList(self.c.fetchall())
for data in data_batch:
norad_number = data[1]
fingerprint = data[-1]
if fingerprint not in SATCAT_fingerprints:
self.c.execute(find_with_norad, (norad_number,))
existing_rows = self.c.fetchall()
if existing_rows:
self.c.execute(delete_by_norad, (norad_number,))
log.info(
f"""
Removing existing entries with norad number {norad_number}.
Satellite with Norad Number {norad_number} will be updated.
"""
)
updated_entries += 1
data_to_insert.append(data)
if len(data_to_insert) > 0:
for data in batch(data_to_insert, 1000):
self.c.executemany(insert_query, data)
self.conn.commit()
log.info(f"{len(data_to_insert)-updated_entries} new rows added to celestrak_SATCAT")
log.info(f"{updated_entries} existing rows updated in celestrak_SATCAT")
except Exception as e:
log.error("MYSQL ERROR: {}".format(e))
def add_ucs_satdb_batch(self, data_batch):
""" Add an UCS DB (corrected) entry to the database """