-
Notifications
You must be signed in to change notification settings - Fork 17
/
bcregistries.py
1357 lines (1231 loc) · 62.2 KB
/
bcregistries.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
#!/usr/bin/python
import psycopg2
import sqlite3
import datetime
import pytz
import json
import string
import decimal
import random
import types
import traceback
import logging
from bcreg.bcreg_core import BCReg_Core, MAX_WHERE_IN
from bcreg.bcreg_lear import STATE_CODES, FILING_TYPE_CODES
from bcreg.config import config
from bcreg.rocketchat_hooks import log_error, log_warning, log_info
system_type = 'BC_REG'
BC_REGISTRIES_TABLE_PREFIX = 'bc_registries.'
BC_REGISTRIES_DATABASE_NAME = 'bc_registries'
BC_REG_LEAR_DATABASE_NAME = 'bc_reg_lear'
BC_REGISTRIES_TIMEZONE = 'PST8PDT'
INMEM_CACHE_TABLE_PREFIX = ''
MIN_START_DATE = datetime.datetime(datetime.MINYEAR+1, 1, 1)
MAX_END_DATE = datetime.datetime(datetime.MAXYEAR-1, 12, 31)
DATA_CONVERSION_DATE = datetime.datetime(2004, 3, 26)
DATA_CONVERSION_DATE_STR = "2004-03-26"
# for now, we are in PST time
timezone = pytz.timezone("PST8PDT")
MIN_START_DATE_TZ = timezone.localize(MIN_START_DATE)
MAX_END_DATE_TZ = timezone.localize(MAX_END_DATE)
DATA_CONVERSION_DATE_TZ = timezone.localize(DATA_CONVERSION_DATE)
CORP_TYPES_IN_SCOPE = {
"A": "EXTRA PRO",
"B": "EXTRA PRO",
"BC": "BC COMPANY",
"BEN": "BENEFIT COMPANY",
"C": "CONTINUE IN",
"CC": "BC CCC",
"CP": "COOP",
"CS": "CONT IN SOCIETY",
"CUL": "ULC CONTINUE IN",
"EPR": "EXTRA PRO REG",
"FOR": "FOREIGN",
"FI": "FINANCIAL",
#"GP": "PARTNERSHIP",
"LIB": "LIBRARY",
"LIC": "LICENSED",
"LL": "LL PARTNERSHIP",
"LLC": "LIMITED CO",
"LP": "LIM PARTNERSHIP",
"MF": "MISC FIRM",
"PA": "PRIVATE ACT",
"PAR": "PARISHES",
"QA": "CO 1860",
"QB": "CO 1862",
"QC": "CO 1878",
"QD": "CO 1890",
"QE": "CO 1897",
"REG": "REGISTRATION",
"S": "SOCIETY",
#"SP": "SOLE PROP",
"ULC": "BC ULC COMPANY",
"XCP": "XPRO COOP",
"XL": "XPRO LL PARTNR",
"XP": "XPRO LIM PARTNR",
"XS": "XPRO SOCIETY",
}
LOGGER = logging.getLogger(__name__)
def event_dict(event_id, event_date):
event = {'event_id': event_id, 'event_date': event_date}
return event
# custom encoder to convert wierd data types to strings
class CustomJsonEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, datetime.datetime):
try:
tz_aware = timezone.localize(o)
ret = tz_aware.astimezone(pytz.utc).isoformat()
return ret
except (Exception) as error:
if o.year <= datetime.MINYEAR+1:
return MIN_START_DATE_TZ.astimezone(pytz.utc).isoformat()
elif o.year >= datetime.MAXYEAR-1:
return MAX_END_DATE_TZ.astimezone(pytz.utc).isoformat()
return o.isoformat()
if isinstance(o, (list, dict, str, int, float, bool, type(None))):
return JSONEncoder.default(self, o)
if isinstance(o, decimal.Decimal):
return (str(o) for o in [o])
if isinstance(o, set):
return list(o)
if isinstance(o, map):
return list(o)
if isinstance(o, types.GeneratorType):
ret = ""
for s in next(o):
ret = ret + str(s)
return ret
return json.JSONEncoder.default(self, o)
def is_data_conversion_event(event):
if isinstance(event['event_timestmp'], datetime.datetime):
if event['event_timestmp'].year == DATA_CONVERSION_DATE.year and event['event_timestmp'].month == DATA_CONVERSION_DATE.month and event['event_timestmp'].day == DATA_CONVERSION_DATE.day:
return True
else:
# assume string
if event['event_timestmp'].startswith(DATA_CONVERSION_DATE_STR):
return True
return False
# interface to BC Registries database
# data is returned as dictionaries, using the sql column name as identifier
class BCRegistries(BCReg_Core):
def __init__(self, cache=False):
self.sql_local_cache = cache
self.DB_TABLE_PREFIX = BC_REGISTRIES_TABLE_PREFIX
self.PG_DATABASE_NAME = BC_REGISTRIES_DATABASE_NAME
self.source_system_type = system_type
self.SEC_DB_TABLE_PREFIX = ""
self.SEC_PG_DATABASE_NAME = BC_REG_LEAR_DATABASE_NAME
super().__init__(cache)
###########################################################################
# load all bc registries data for the specified corps into our in-mem cache
###########################################################################
colin_code_tables = ['corp_type',
'corp_op_state',
'party_type',
'office_type',
'event_type',
'filing_type',
'corp_name_type',
'jurisdiction_type',
'xpro_type']
colin_corp_tables = ['corporation',
'corp_state',
'jurisdiction',
'corp_name']
colin_other_tables = ['corp_party',
'event',
'filing',
'conv_event',
'office',
'address']
# load all bc registries data for the specified corps into our in-mem cache
def cache_bcreg_corps(self, specific_corps, generate_individual_sql=False):
if self.use_local_cache():
lear_specific_corps = specific_corps.copy()
self.cache_bcreg_corp_tables(specific_corps, generate_individual_sql=generate_individual_sql)
self.cache_bcreg_code_tables(generate_individual_sql=generate_individual_sql)
# also cache LEAR data
self.cache_lear_bcreg_corp_tables(lear_specific_corps, generate_individual_sql=generate_individual_sql, use_sec=True)
self.cache_lear_bcreg_code_tables(generate_individual_sql=generate_individual_sql, use_sec=True)
# load all bc registries data for the specified corps into our in-mem cache
def cache_bcreg_corp_tables(self, specific_corps, generate_individual_sql=False):
if self.use_local_cache():
LOGGER.info('Caching data for parties and events ...')
self.generated_sqls = []
self.generated_corp_nums = {}
# ensure we have a unique list
specific_corps = list({s_corp for s_corp in specific_corps})
specific_corps_lists = self.split_list(specific_corps, MAX_WHERE_IN)
addr_id_list = []
for corp_nums_list in specific_corps_lists:
corp_list = self.id_where_in(corp_nums_list, True)
corp_party_where = 'bus_company_num in (' + corp_list + ') or corp_num in (' + corp_list + ')'
party_rows = self.get_bcreg_table(self.colin_other_tables[0], corp_party_where, '', True, generate_individual_sql)
# include all corp_num from the parties just returned (dba related companies)
for party in party_rows:
specific_corps.append(party['corp_num'])
if 'bus_company_num' in party and party['bus_company_num'] is not None and 0 < len(party['bus_company_num']):
specific_corps.append(party['bus_company_num'])
# ensure we have a unique list
specific_corps = list({s_corp for s_corp in specific_corps})
specific_corps_lists = self.split_list(specific_corps, MAX_WHERE_IN)
event_ids = []
for corp_nums_list in specific_corps_lists:
corp_nums_list = self.id_where_in(corp_nums_list, True)
event_where = 'corp_num in (' + corp_nums_list + ')'
event_rows = self.get_bcreg_table(self.colin_other_tables[1], event_where, '', True, generate_individual_sql)
for event in event_rows:
event_ids.append(str(event['event_id']))
# ensure we have a unique list
event_ids = list({event_id for event_id in event_ids})
event_ids_lists = self.split_list(event_ids, MAX_WHERE_IN)
for ids_list in event_ids_lists:
event_list = self.id_where_in(ids_list)
filing_where = 'event_id in (' + event_list + ')'
_rows = self.get_bcreg_table(self.colin_other_tables[2], filing_where, '', True, generate_individual_sql)
_rows = self.get_bcreg_table(self.colin_other_tables[3], filing_where, '', True, generate_individual_sql)
LOGGER.info('Caching data for corporations ...')
for corp_nums_list in specific_corps_lists:
corp_nums_list = self.id_where_in(corp_nums_list, True)
corp_num_where = 'corp_num in (' + corp_nums_list + ')'
for corp_table in self.colin_corp_tables:
_rows = self.get_bcreg_table(corp_table, corp_num_where, '', True, generate_individual_sql)
office_where = 'corp_num in (' + corp_nums_list + ')'
office_rows = self.get_bcreg_table(self.colin_other_tables[4], office_where, '', True, generate_individual_sql)
for office in office_rows:
if office['mailing_addr_id'] is not None:
addr_id_list.append(str(office['mailing_addr_id']))
if office['delivery_addr_id'] is not None:
addr_id_list.append(str(office['delivery_addr_id']))
# ensure we have a unique list
addr_id_list = list({addr_id for addr_id in addr_id_list})
addr_ids_lists = self.split_list(addr_id_list, MAX_WHERE_IN)
for ids_list in addr_ids_lists:
addr_list = self.id_where_in(ids_list)
address_where = 'addr_id in (' + addr_list + ')'
_rows = self.get_bcreg_table(self.colin_other_tables[5], address_where, '', True, generate_individual_sql)
# load all bc registries data for the specified corps into our in-mem cache
def cache_bcreg_code_tables(self, generate_individual_sql=False):
if self.use_local_cache():
LOGGER.info('Caching data for code tables ...')
self.generated_sqls = []
self.generated_corp_nums = {}
for code_table in self.colin_code_tables:
_rows = self.get_bcreg_table(code_table, '', '', True, generate_individual_sql)
# clear in-mem cache - delete all existing data
def cache_cleanup(self):
for table in self.colin_corp_tables:
self.cache_cleanup_data(table)
for table in self.colin_other_tables:
self.cache_cleanup_data(table)
for table in self.colin_code_tables:
self.cache_cleanup_data(table)
###########################################################################
# methods to determine un-processed corporations/events
###########################################################################
# get max event number from bc registries event log
def get_max_event(self, event_date):
cur = None
try:
# create a cursor
cur = self.conn.cursor()
cur.execute("""SELECT max(event_id) FROM """ + self.DB_TABLE_PREFIX + """event where event_timestmp = %s""", (event_date,))
row = cur.fetchone()
cur.close()
cur = None
return row[0]
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# get max event number from bc registries event log
def get_max_event_date(self):
cur = None
try:
# create a cursor
cur = self.conn.cursor()
cur.execute("""SELECT max(event_timestmp) FROM """ + self.DB_TABLE_PREFIX + """event""")
row = cur.fetchone()
cur.close()
cur = None
return row[0]
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# get the last event date on or before now
def get_max_date_before_now(self):
try:
with self.conn.cursor() as cur:
cur.execute("""SET TIME ZONE """ + BC_REGISTRIES_TIMEZONE)
cur.execute("""SELECT max(event_timestmp) FROM """ + self.DB_TABLE_PREFIX + """event where event_timestmp <= NOW()::timestamp without time zone""")
row = cur.fetchone()
return row[0]
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# get max event number from bc registries event log
def get_event_id_date(self, event_id):
cur = None
try:
# create a cursor
cur = self.conn.cursor()
cur.execute("""SELECT event_timestmp FROM """ + self.DB_TABLE_PREFIX + """event where event_id = %s""", (event_id,))
row = cur.fetchone()
cur.close()
cur = None
return row[0]
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# return a specific set of corporations, based on an event range
def get_specific_corps(self, corp_filter):
sql = """SELECT distinct(corp_num) from """ + self.DB_TABLE_PREFIX + """event
where corp_num in ({})
order by corp_num;"""
sql2 = """SELECT distinct(corp.corp_num) from """ + self.DB_TABLE_PREFIX + """corporation corp,
""" + self.DB_TABLE_PREFIX + """corp_party party
where corp.corp_typ_cd in ('SP','MF')
and corp.corp_num = party.corp_num
and party.party_typ_cd in ('FBO')
and party.bus_company_num is not null
and party.bus_company_num in ({})"""
cur = None
try:
cur = self.conn.cursor()
placeholders= ', '.join(['%s']*len(corp_filter)) # "%s, %s, %s, ... %s"
sql = sql.format(placeholders)
cur.execute(sql, tuple(corp_filter))
row = cur.fetchone()
corps = []
while row is not None:
# LOGGER.info(row)
corps.append({'CORP_NUM':row[0],})
row = cur.fetchone()
sql2 = sql2.format(placeholders)
cur.execute(sql2, tuple(corp_filter))
row = cur.fetchone()
while row is not None:
# LOGGER.info(row)
corps.append({'CORP_NUM':row[0],})
row = cur.fetchone()
cur.close()
cur = None
return corps
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# return unprocessed corporations, based on active or historical
# use for initial data load
def get_unprocessed_corps_data_load(self, last_event_id, last_event_dt, max_event_id, max_event_dt):
sqls = []
# select *all* corps - we will filter in the next stage
sqls.append("""SELECT distinct(corp.corp_num) from """ + self.DB_TABLE_PREFIX + """corporation corp """)
corps = []
for sql in sqls:
cur = None
try:
LOGGER.info("Executing: " + sql)
cur = self.conn.cursor()
cur.execute(sql)
row = cur.fetchone()
while row is not None:
# LOGGER.info(row)
corps.append({'CORP_NUM':row[0], 'PREV_EVENT': event_dict(last_event_id, last_event_dt),
'LAST_EVENT': event_dict(max_event_id, max_event_dt), })
row = cur.fetchone()
cur.close()
cur = None
LOGGER.info("Loaded corps: " + str(len(corps)))
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
return corps
# return unprocessed corporations, based on an event range
def get_unprocessed_corps(self, last_event_id, last_event_dt):
sqls = []
# select *all* corps - we will filter in the next stage
sqls.append("""SELECT corp_num, event_id from """ + self.DB_TABLE_PREFIX + """event
where event_timestmp >= %s""")
corps = []
event_ids = []
corp_set = {}
for sql in sqls:
cur = None
try:
LOGGER.info("Executing: " + sql + " with " + str(last_event_dt))
cur = self.conn.cursor()
cur.execute(sql, (last_event_dt,))
row = cur.fetchone()
while row is not None:
if not row[0] in corp_set:
corp_set[row[0]] = row[0]
corps.append({'CORP_NUM':row[0],})
event_ids.append(row[1])
row = cur.fetchone()
cur.close()
cur = None
LOGGER.info("Loaded corps: " + str(len(corps)))
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# since the event may affect more than one corp, check corp_state to see if there are any other corps to bring into scope
sql = """SELECT corp_num from """ + self.DB_TABLE_PREFIX + """corp_state
where start_event_id = %s or end_event_id = %s"""
i = 0
for event_id in event_ids:
i = i + 1
if (i % 1000 == 0):
LOGGER.info("Processing %s of %s", i, len(event_ids))
cur = None
try:
cur = self.conn.cursor()
cur.execute(sql, (event_id, event_id,))
row = cur.fetchone()
while row is not None:
if not row[0] in corp_set:
corp_set[row[0]] = row[0]
corps.append({'CORP_NUM':row[0],})
row = cur.fetchone()
cur.close()
cur = None
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
LOGGER.info("Loaded corps: " + str(len(corps)))
# since a related corp may be impacted by a corp change, check for related corps via corp_party table
sql1 = """SELECT businesses.identifier corp_num
FROM businesses businesses,
parties_version parties,
party_roles_version roles
WHERE businesses.id = roles.business_id
AND roles.party_id = parties.id
AND parties.party_type = 'organization' and roles.role in ('proprietor')
AND (parties.identifier = %s)"""
new_corps = []
for corp in corps:
cur = None
try:
cur = self.sec_conn.cursor()
corp_num = self.bc_ifiy_one(corp['CORP_NUM'])
cur.execute(sql1, (corp_num,))
row = cur.fetchone()
while row is not None and row[0] is not None:
if not row[0] in corp_set:
corp_set[row[0]] = row[0]
new_corps.append({'CORP_NUM':row[0],})
row = cur.fetchone()
cur.close()
cur = None
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
LOGGER.info("Loaded corps: " + str(len(new_corps)))
corps.extend(new_corps)
return corps
#return the (unprocessed) event range for each provided corporation
def get_unprocessed_corp_events(self, last_event_id, last_event_dt, max_event_id, max_event_dt, corps, max=None):
for i,corp in enumerate(corps):
if (i % 100 == 0) or (i+1 == len(corps)):
print('>>> Processing ' + str(i+1) + ' of ' + str(len(corps)) + ' corporations. ')
corp['PREV_EVENT'] = event_dict(last_event_id, last_event_dt)
corp['LAST_EVENT'] = event_dict(max_event_id, max_event_dt)
if max and i >= max:
break
return corps
###########################################################################
# methods to run corporation-specific queries
# (can run against the in-memory cache
# or against bc registries database directly)
###########################################################################
# return the "effective date" given an event and filing
def get_event_filing_effective_date(self, event, corp_type_cd=None):
ret_date = None
# if corp type is Firm and it is a dissolusion event the effective date will be in event.trigger_dts
if corp_type_cd and corp_type_cd in ('SP','GP','LP','XP','LL','XL','MF'):
if 'trigger_dts' in event and event['trigger_dts'] is not None:
ret_date = event['trigger_dts']
if ret_date is None:
# use the filing effective date if it is present
if 'filing' in event and 'effective_dt' in event['filing']:
ret_date = event['filing']['effective_dt']
# else use the conversion event if present
if ret_date is None and 'conv_event' in event and 'effective_dt' in event['conv_event']:
if event['conv_event']['effective_dt'] is not None:
ret_date = event['conv_event']['effective_dt']
# finally use the event timestamp if we have no other option
if ret_date is None:
if event['event_timestmp'] is None or event['event_timestmp'] == '':
ret_date = None
else:
ret_date = event['event_timestmp']
if ret_date is None:
LOGGER.error('Error ret_date is None' + str(event))
return ret_date
# return the "effective date" given an event id
def get_event_effective_date(self, event_id):
# note that corp_num is ignored in the following queries
if event_id == 0:
return datetime.datetime(datetime.MINYEAR, 1, 1) # MIN_START_DATE
event = self.get_event('0', event_id)
#filing = self.get_filing_event('0', event_id, event['event_typ_cd'])
return self.get_event_filing_effective_date(event)
# find a specific event,
# return None if not found
def get_event(self, corp_num, event_id, corp_type_cd=None, force_query_remote=False):
sql = """SELECT event_id, corp_num, event.event_typ_cd, event_timestmp, trigger_dts, event_class, short_desc, full_desc
FROM """ + self.get_table_prefix(force_query_remote) + """event event, """ + self.get_table_prefix(force_query_remote) + """event_type event_type
WHERE event_id = """ + self.get_db_sql_param(force_query_remote) + """ and event.event_typ_cd = event_type.event_typ_cd"""
# WHERE corp_num = """ + self.get_db_sql_param(force_query_remote) + """ and event_id = """ + self.get_db_sql_param(force_query_remote)
ret_event = None
cursor = None
try:
cursor = self.get_db_connection(force_query_remote).cursor()
cursor.execute(sql, (event_id,))
desc = cursor.description
column_names = [col[0] for col in desc]
event = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(event) > 0:
ret_event = event[0]
else:
# check for a cache miss
if self.use_local_cache() and (not force_query_remote):
event = self.get_event(corp_num, event_id, corp_type_cd=corp_type_cd, force_query_remote=True)
self.add_cache_miss('event', corp_num, event_id, event)
ret_event = event
if ret_event is None:
return {}
# don't use data conversion date as a timestamp
#if is_data_conversion_event(ret_event):
# ret_event['event_timestmp'] = ''
# fill in filing and conv_event
if 'filing' not in ret_event:
ret_event['filing'] = self.get_filing_event(corp_num, event_id, ret_event['event_typ_cd'], force_query_remote)
if 'conv_event' not in ret_event:
ret_event['conv_event'] = self.get_conv_event(corp_num, event_id, ret_event['event_typ_cd'], force_query_remote)
ret_event['effective_date'] = self.get_event_filing_effective_date(ret_event, corp_type_cd)
return ret_event
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_conv_event(self, corp_num, event_id, event_type, force_query_remote=False):
if not event_type.startswith('CONV'):
return {}
sql_conv = """SELECT * from """ + self.get_table_prefix(force_query_remote) + """conv_event
WHERE event_id = """ + self.get_db_sql_param(force_query_remote)
cursor = None
try:
cursor = self.get_db_connection(force_query_remote).cursor()
cursor.execute(sql_conv, (event_id,))
desc = cursor.description
column_names = [col[0] for col in desc]
conv_event = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(conv_event) > 0:
return conv_event[0]
# don't check for a cache miss - assume conv_event are all there (most CONV data in dev is missing)
#if self.use_local_cache() and (not force_query_remote):
# LOGGER.error('Cache miss for conv_event ', event_type)
# conv_event = self.get_conv_event(corp_num, event_id, event_type, True)
# self.add_cache_miss('conv_event', corp_num, event_id, conv_event)
# return conv_event
return {}
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_filing_event(self, corp_num, event_id, event_type, force_query_remote=False):
if event_type != 'FILE':
return {}
sql_filing = """SELECT event_id, filing.filing_typ_cd, effective_dt, new_corp_num, filing_typ_class, short_desc, full_desc
from """ + self.get_table_prefix(force_query_remote) + """filing filing, """ + self.get_table_prefix(force_query_remote) + """filing_type filing_type
WHERE event_id = """ + self.get_db_sql_param(force_query_remote) + """ and filing.filing_typ_cd = filing_type.filing_typ_cd """
cursor = None
try:
cursor = self.get_db_connection(force_query_remote).cursor()
cursor.execute(sql_filing, (event_id,))
desc = cursor.description
column_names = [col[0] for col in desc]
filing_event = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(filing_event) > 0:
return filing_event[0]
# check for a cache miss
if self.use_local_cache() and (not force_query_remote):
filing_event = self.get_filing_event(corp_num, event_id, event_type, True)
self.add_cache_miss('filing', corp_num, event_id, filing_event)
return filing_event
return {}
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def check_same_start_date(self, corp_num, record_type, records, date_key):
sorted_records = sorted(records, key=lambda k: k[date_key])
prev_date = None
flag = False
i = 0
active_id = None
for record in sorted_records:
if prev_date is not None and record[date_key] == prev_date:
flag = True
prev_date = record[date_key]
i = i + 1
if 'end_event_id' not in record or record['end_event_id'] is None:
active_id = i
if flag:
LOGGER.info(">>>Data Issue:Same Start Date:" + corp_num + ":" + record_type + ":" + str(records))
if active_id is not None and active_id != len(sorted_records):
LOGGER.info(">>>Data Issue:Active Record:" + corp_num + ":" + record_type + ":" + str(records))
def flag_start_events_which_are_not_also_end_events(self, corp_num, corp_recs):
if corp_recs is not None:
end_events = []
for rec in corp_recs:
if 'end_event_id' in rec and rec['end_event_id'] is not None:
end_events.append(rec['end_event_id'])
for rec in corp_recs:
flag = False
for i in end_events:
if rec['start_event_id'] == i:
flag = True
rec['start_event']['appears_as_end_event'] = flag
def get_offices(self, corp_num):
sql_office = """SELECT * from """ + self.get_table_prefix() + """office
WHERE corp_num = """ + self.get_db_sql_param() + """ and office_typ_cd in ('RG','HD','FO')"""
cursor = None
try:
cursor = self.get_db_connection().cursor()
cursor.execute(sql_office, (corp_num,))
desc = cursor.description
column_names = [col[0] for col in desc]
offices = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
for office in offices:
office['office_type'] = self.get_office_type(office['office_typ_cd'])
office['delivery_addr'] = self.get_address(corp_num, office['delivery_addr_id'])
if 'mailing_addr_id' in office and office['mailing_addr_id'] != office['delivery_addr_id']:
office['mailing_addr'] = self.get_address(corp_num, office['mailing_addr_id'])
office['start_event'] = self.get_event(corp_num, office['start_event_id'])
office['effective_start_date'] = office['start_event']['effective_date']
if office['end_event_id'] is not None:
office['end_event'] = self.get_event(corp_num, office['end_event_id'])
office['effective_end_date'] = office['end_event']['effective_date']
else:
office['effective_end_date'] = MAX_END_DATE
#if office['effective_start_date'] > office['effective_end_date']:
# LOGGER.info(">>>Data Issue:Date:" + corp_num + ":Office:", office)
#self.check_same_start_date(corp_num, 'office', offices, 'effective_start_date')
return offices
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_address(self, corp_num, address_id, force_query_remote=False):
if address_id is None:
return {}
sql_addr = """SELECT addr_id, province, country_typ_cd, postal_cd, addr_line_1, addr_line_2, addr_line_3, city, address_format_type,
address_desc, address_desc_short, unit_no, unit_type, province_state_name
FROM """ + self.get_table_prefix(force_query_remote) + """address
WHERE addr_id = """ + self.get_db_sql_param(force_query_remote)
cursor = None
try:
cursor = self.get_db_connection(force_query_remote).cursor()
cursor.execute(sql_addr, (address_id,))
desc = cursor.description
column_names = [col[0] for col in desc]
addresses = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(addresses) > 0:
address = addresses[0]
if 'addr_line_1' in address and address['addr_line_1'] is not None:
address['local_addr'] = self.addr_line(address['addr_line_1'], ', ') + \
self.addr_line(address['addr_line_2'], ', ') + \
self.addr_line(address['addr_line_3'], ', ') + \
self.addr_line(address['city'], ', ') + \
self.addr_line(address['province'], ', ') + \
self.addr_line(address['postal_cd'], ', ') + \
self.addr_line(address['country_typ_cd'], '')
elif 'address_desc' in address and address['address_desc'] is not None:
address['local_addr'] = address['address_desc']
else:
address['local_addr'] = ""
return address
# check for a cache miss
if self.use_local_cache() and (not force_query_remote):
address = self.get_address(corp_num, address_id, True)
self.add_cache_miss('address', corp_num, address_id, address)
return address
return {}
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_names(self, corp_num, name_typ_cds, registration_date):
sql_name = """SELECT corp_num, corp_name_typ_cd, start_event_id, end_event_id, corp_name_seq_num, srch_nme, corp_nme, dd_corp_num
FROM """ + self.get_table_prefix() + """corp_name
WHERE corp_num = """ + self.get_db_sql_param() + """ AND corp_name_typ_cd in ({}) """
cur = None
try:
names = []
cur = self.get_db_connection().cursor()
placeholders= ', '.join([self.get_db_sql_param()]*len(name_typ_cds)) # "%s, %s, %s, ... %s"
sql_name = sql_name.format(placeholders)
cur.execute(sql_name, (corp_num,) + tuple(name_typ_cds))
row = cur.fetchone()
while row is not None:
corp_name = {}
corp_name['corp_num'] = row[0]
corp_name['corp_name_typ_cd'] = row[1]
corp_name['start_event_id'] = row[2]
corp_name['start_event'] = self.get_event(row[0], row[2])
corp_name['effective_start_date'] = corp_name['start_event']['effective_date']
corp_name['end_event_id'] = row[3]
if corp_name['end_event_id'] is not None:
corp_name['end_event'] = self.get_event(corp_num, corp_name['end_event_id'])
corp_name['effective_end_date'] = corp_name['end_event']['effective_date']
else:
corp_name['effective_end_date'] = MAX_END_DATE
corp_name['corp_name_seq_num'] = row[4]
corp_name['srch_nme'] = row[5]
corp_name['corp_nme'] = row[6]
corp_name['dd_corp_num'] = row[7]
if corp_name['effective_start_date'] > corp_name['effective_end_date']:
#LOGGER.info(">>>Data Issue:Date:" + corp_num + ":Corp_Name:", corp_name)
if is_data_conversion_event(corp_name['start_event']) and registration_date is not None:
corp_name['start_event']['effective_date'] = registration_date
corp_name['effective_start_date'] = registration_date
names.append(corp_name)
row = cur.fetchone()
cur.close()
cur = None
if len(names) == 1 and registration_date is not None and (names[0]['effective_start_date'] is None or names[0]['effective_start_date'] == '' or is_data_conversion_event(corp_name['start_event'])):
names[0]['start_event']['effective_date'] = registration_date
names[0]['effective_start_date'] = registration_date
#self.check_same_start_date(corp_num, 'corp_name', names, 'effective_start_date')
return names
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cur is not None:
cur.close()
# get the corporation's current state
def get_corp_states(self, corp_num):
sql_state = """SELECT state.corp_num corp_num, state.start_event_id start_event_id, state.end_event_id end_event_id,
state.state_typ_cd state_typ_cd, state.dd_corp_num dd_corp_num,
op_state.op_state_typ_cd op_state_typ_cd, op_state.short_desc short_desc, op_state.full_desc full_desc
FROM """ + self.get_table_prefix() + """corp_state state, """ + self.get_table_prefix() + """corp_op_state op_state
WHERE corp_num = """ + self.get_db_sql_param() + """ and op_state.state_typ_cd = state.state_typ_cd"""
cursor = None
try:
cursor = self.get_db_connection().cursor()
cursor.execute(sql_state, (corp_num,))
desc = cursor.description
column_names = [col[0] for col in desc]
corp_states = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
return corp_states
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_jurisdictions(self, corp_num):
sql_juris = """SELECT corp_num, start_event_id, end_event_id, j.can_jur_typ_cd can_jur_typ_cd,
home_recogn_dt, othr_juris_desc, home_juris_num, home_company_nme,
short_desc, full_desc
FROM """ + self.get_table_prefix() + """jurisdiction j, """ + self.get_table_prefix() + """jurisdiction_type jt
WHERE j.corp_num = """ + self.get_db_sql_param() + """ AND j.can_jur_typ_cd = jt.can_jur_typ_cd"""
cursor = None
try:
cursor = self.get_db_connection().cursor()
cursor.execute(sql_juris, (corp_num,))
desc = cursor.description
column_names = [col[0] for col in desc]
jurisdictions = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(jurisdictions) > 0:
for jurisdiction in jurisdictions:
jurisdiction['start_event'] = self.get_event(corp_num, jurisdiction['start_event_id'])
jurisdiction['effective_start_date'] = jurisdiction['start_event']['effective_date']
if jurisdiction['end_event_id'] is not None:
jurisdiction['end_event'] = self.get_event(corp_num, jurisdiction['end_event_id'])
jurisdiction['effective_end_date'] = jurisdiction['end_event']['effective_date']
else:
jurisdiction['effective_end_date'] = MAX_END_DATE
#if jurisdiction['effective_start_date'] > jurisdiction['effective_end_date']:
# LOGGER.info(">>>Data Issue:Date:" + corp_num + ":Jurisdiction:", jurisdiction)
#self.check_same_start_date(corp_num, 'jurisdiction', jurisdictions, 'effective_start_date')
jurisdictions = sorted(jurisdictions, key=lambda k: k['effective_end_date'])
jurisdictions = sorted(jurisdictions, key=lambda k: int(k['start_event_id']))
jurisdictions = sorted(jurisdictions, key=lambda k: k['effective_start_date'])
return jurisdictions
return []
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_office_type(self, office_typ_cd):
sql_type = """SELECT office_typ_cd, short_desc, full_desc
FROM """ + self.get_table_prefix() + """office_type
WHERE office_typ_cd = """ + self.get_db_sql_param()
cursor = None
try:
cursor = self.get_db_connection().cursor()
cursor.execute(sql_type, (office_typ_cd,))
desc = cursor.description
column_names = [col[0] for col in desc]
office_type = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(office_type) > 0:
return office_type[0]
return {}
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def get_corp_type(self, corp_typ_cd):
sql_type = """SELECT corp_typ_cd, colin_ind, corp_class, short_desc, full_desc
FROM """ + self.get_table_prefix() + """corp_type
WHERE corp_typ_cd = """ + self.get_db_sql_param()
cursor = None
try:
cursor = self.get_db_connection().cursor()
cursor.execute(sql_type, (corp_typ_cd,))
desc = cursor.description
column_names = [col[0] for col in desc]
corp_type = [dict(zip(column_names, row))
for row in cursor]
cursor.close()
cursor = None
if len(corp_type) > 0:
return corp_type[0]
return {}
except (Exception, psycopg2.DatabaseError) as error:
LOGGER.error(error)
LOGGER.error(traceback.print_exc())
log_error("BCRegistries exception reading DB: " + str(error))
raise
finally:
if cursor is not None:
cursor.close()
def addr_line(self, addr_element, delimiter):