forked from dhis2/dhis2-utils
-
Notifications
You must be signed in to change notification settings - Fork 0
/
metatran.py
1358 lines (1074 loc) · 61.3 KB
/
metatran.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/env python3
# -*- coding: utf-8 -*-
"""
Copyright (c) 2022, University of Oslo
All rights reserved.
@author: philld
"""
import requests
import json
import configargparse
import argparse
import threading
import concurrent.futures
import os
import glob
import sys
import tempfile
from translayer import tx3
import hashlib
from bs4 import BeautifulSoup
import re
import copy
from jinja2 import Template
import logging
from slugify import slugify
console = logging.StreamHandler()
mt_logger = logging.getLogger('mtran')
mt_logger.addHandler(console)
class d2t():
def __init__(self,server, user, password, project, resource, base, tx_org='', tx_token='', object_filter=''):
mt_logger.setLevel(20)
# DHIS2 connection details
self.dhis2_server = server
self.dhis2_user = user
self.dhis2_password = password
self.dhis2_AUTH=(self.dhis2_user, self.dhis2_password)
self.fromDHIS2={}
self.customForms={}
self.translatable_fields={}
self.translatable_max_chars={}
# package details
self.package_filter = None
self.object_filter = object_filter.split(',')
# set the default format to STRUCTURED_JSON
self.tx_i18n_type = "STRUCTURED_JSON"
self.tx_resource="tempfile"
# We need to map language codes that DHIS2 doesn't support natively
# uz@Cyrl --> uz
# uz@Latn --> uz_UZ
self.langmap={'uz@Cyrl':'uz','uz@Latn':'uz_UZ'}
if project:
# transifex details (if a transifex project is defined)
self.tx_project=project
self.tx_resource_name=resource
self.tx_resource=slugify(resource)
#create an instance of a transifex organisation (pass organisation slug and transifex API token)
self.tx = tx3.tx(tx_org,tx_token,log_level=10)
self.txp = self.tx.project(self.tx_project)
if not self.txp:
sys.exit("Project "+self.tx_project+" not found in transifex! Aborting transifex synchronisation.")
if self.txp.resource(self.tx_resource):
self.tx_i18n_type = self.txp.resource(self.tx_resource).attributes['i18n_type']
self.base_lang = 'en'
if base:
self.base_lang = base.split(':')[0]
mt_logger.info("Current main locale: "+self.base_lang)
self.form_text_prefix = 'formText_'
self.localiser_script_id = 'localiser'
class tmpdir():
def __init__(self):
self.name = "i18n"
self.mode = "SYNC" # "SYNC" or "CONVERT"
# self.localisation_dir = tempfile.TemporaryDirectory(prefix="i18n") # use this for cleanliness
self.localisation_dir = tmpdir() # use this instead of above for debugging
os.makedirs(self.localisation_dir.name, exist_ok=True)
self.locale_file_pattern = self.localisation_dir.name + "/{m}/{p}_{l}.json"
self.locale_file_pattern_prefix = self.localisation_dir.name + "/{m}/{p}_"
self.source_file_pattern = self.localisation_dir.name + "/{m}/{p}.json"
self.locale_file_glob_pattern = self.localisation_dir.name + "/{m}/{p}_*.json"
self.all_file_pattern = self.localisation_dir.name + "/{m}/{p}*.json"
def set_filter(self,package_url):
"""
We try to get the list of the object IDs from the package file, and use that to filter
the objects we translate
"""
export_response=requests.get(package_url)
if export_response.status_code == requests.codes['OK']:
export=json.loads(export_response.text)
self.package_filter = set()
for m in self.__find_ids__("id", export):
self.package_filter.add(m)
return True
# return false if not set
return False
def set_object_filter(self,object_filter):
self.object_filter = object_filter.split(',')
def __find_ids__(self, key, var, parent=""):
"""
Recursive function to find IDs in a package file
"""
if hasattr(var,'items'):
for k, v in var.items():
if k == key:
yield v
if isinstance(v, dict):
for result in self.__find_ids__(key, v, k):
yield result
elif isinstance(v, list):
for d in v:
for result in self.__find_ids__(key, d, k):
yield result
def dhis2_to_json(self):
"""
Extracts the translatable metadata from the DHIS2 instance and converts
into a JSON format suitable for transifex.
"""
print("Pulling translatable metadata from", self.dhis2_server, "...")
# first we will find out which fields are translatable, and store them with the resource.
tflds = {}
tchar = {}
dhis2_schemas = requests.get(self.dhis2_server+"/api/schemas.json",auth=self.dhis2_AUTH)
if dhis2_schemas.status_code == 401:
sys.exit("DHIS2 user not authorised! Aborting transifex synchronisation.")
for schema in dhis2_schemas.json()["schemas"]:
# if the schema is in the exclude_objects list, skip it
if self.object_filter:
if schema['collectionName'] in self.object_filter:
continue
# mt_logger.debug(schema['name'])
if schema['translatable'] == True and 'apiEndpoint' in schema:
# print("\t",schema['name'])
# print("\t\t",schema['href'])
fields= [t for t in schema["properties"] if 'translationKey' in t]
mapped_fields={}
max_chars={}
for f in fields:
if 'length' not in f:
f['length'] = 2147483647
mapped_fields[f['fieldName']]=f['translationKey']
max_chars[f['translationKey']]=f['length']
tflds[f['fieldName']]=f['translationKey']
tchar[f['translationKey']]=f['length']
# print(schema['name']+"."+f['fieldName'],"==>",f['translationKey'])
self.translatable_fields[schema['collectionName']]=mapped_fields
self.translatable_max_chars[schema['collectionName']]=max_chars
# print(json.dumps(tflds, indent=2, separators=(',', ': ')))
# print(json.dumps(tchar, indent=2, separators=(',', ': ')))
locales={}
locales["source"]={}
for resource in copy.deepcopy(self.translatable_fields):
# print(resource, translatable_fields[resource])
tfs = ''
for transField in self.translatable_fields[resource]:
tfs += ','+transField
collection = (requests.get(self.dhis2_server+"/api/"+resource+".json"+"?fields=id,translations,htmlCode"+tfs+"&paging=false",auth=self.dhis2_AUTH)).json()[resource]
# Apply the filter for a specific package here
if self.package_filter:
collection = [x for x in collection if x['id'] in self.package_filter]
for element in collection:
# if we want to translate custom forms
self.get_custom_form_translations(resource, element)
try:
# form_dict = self.customForms[resource][element['id']]['form_dict']
form_trans = self.customForms[resource][element['id']]['translations']
# if self.base_lang in form_dict:
# print(json.dumps(form_dict[self.base_lang], sort_keys=True, indent=2, ensure_ascii=False))
# if there was a custom form with translations, add the translations to the current element
element['translations'] += form_trans
except KeyError:
pass
translations= element["translations"]
if translations != []:
if resource not in self.fromDHIS2:
self.fromDHIS2[resource] = {}
if element['id'] not in self.fromDHIS2[resource]:
self.fromDHIS2[resource][element['id']] = {}
self.fromDHIS2[resource][element['id']]['translations'] = translations
else:
self.fromDHIS2[resource][element['id']]['translations'] += translations
# print(resource, element['id'], translations)
for transField in self.translatable_fields[resource]:
transFieldKey = self.translatable_fields[resource][transField]
# we can only create translation strings in transifex when a source base field has a value
if transField in element:
matching_translations=[m for m in translations if m['property'] == transFieldKey]
# print( transField, element[transField])
char_limit = self.translatable_max_chars[resource][transFieldKey]
if resource not in locales['source']:
locales['source'][resource] = {}
if element['id'] not in locales['source'][resource]:
locales['source'][resource][element['id']] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales['source'][resource][element['id']][transFieldKey] = { "string":element[transField] }
if char_limit < 2147483647:
locales['source'][resource][element['id']][transFieldKey]["character_limit"] = char_limit
else:
locales['source'][resource][element['id']][transFieldKey] = element[transField]
for m in matching_translations:
if m['locale'] not in self.langmap.keys():
if m['locale'] not in locales:
locales[m['locale']]={}
if resource not in locales[m['locale']]:
locales[m['locale']][resource] = {}
if element['id'] not in locales[m['locale']][resource]:
locales[m['locale']][resource][element['id']] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales[m['locale']][resource][element['id']][transFieldKey] = { "string":m['value'], "character_limit":char_limit}
else:
locales[m['locale']][resource][element['id']][transFieldKey] = m['value']
else:
# check and warn if we have translations with no base string
matching_translations=[m for m in translations if m['property'] == transFieldKey]
for m in matching_translations:
print("WARNING: Translation without base string for",resource,">",element['id'],":", m)
mfile=open(self.localisation_dir.name + "/" + "fromDHIS2.json",'w')
mfile.write(json.dumps(self.fromDHIS2, sort_keys=True, indent=2, ensure_ascii=False, separators=(',', ': ')))
mfile.close()
for locale in locales:
locale_filename = self.locale_file_pattern.format(m=self.mode, p=self.tx_resource, l=locale)
if locale == "source":
locale_filename = self.source_file_pattern.format(m=self.mode, p=self.tx_resource)
os.makedirs(os.path.dirname(locale_filename), exist_ok=True)
jsonfile= open(locale_filename,'w')
jsonfile.write(json.dumps(locales[locale] , sort_keys=True, indent=2, ensure_ascii=False, separators=(',', ': ')))
jsonfile.close()
cfile=open(self.localisation_dir.name + "/" + "fromFORMSs.json",'w')
cfile.write(json.dumps(self.customForms, sort_keys=True, indent=2, ensure_ascii=False, separators=(',', ': ')))
cfile.close()
def json_to_transifex(self, force_new=False):
print("Pushing source strings to transifex...")
path=self.source_file_pattern.format(m=self.mode, p=self.tx_resource)
if not self.txp.resource(self.tx_resource) or force_new:
self.txp.new_resource(self.tx_resource_name,self.tx_resource,'STRUCTURED_JSON',path)
else:
# push a resource (source)
self.txp.resource(self.tx_resource).push(path)
def transifex_to_json(self):
print("Pulling translations from transifex...")
# get project languages
langs = self.txp.languages()
with concurrent.futures.ThreadPoolExecutor(max_workers=20) as executor:
for l in langs:
print(l.code)
# We need to map language codes that DHIS2 doesn't support natively
mapped_language_code = l.code
if l.code in self.langmap.keys():
mapped_language_code = self.langmap[l.code]
path=self.locale_file_pattern.format(m=self.mode, p=self.tx_resource, l=mapped_language_code)
# pull translation
# self.txp.resource(self.tx_resource).pull(l.code,path,mode="onlytranslated")
executor.submit(self.txp.resource(self.tx_resource).pull,l.code,path)
def json_to_transifex_langs(self):
print("Pushing translations to transifex...")
# get project languages
langs = self.txp.languages()
with concurrent.futures.ThreadPoolExecutor(max_workers=20) as executor:
for l in langs:
print(l.code)
# We need to map language codes that DHIS2 doesn't support natively
mapped_language_code = l.code
if l.code in self.langmap.keys():
mapped_language_code = self.langmap[l.code]
path=self.locale_file_pattern.format(m=self.mode, p=self.tx_resource, l=mapped_language_code)
# pull
# self.txp.resource(self.tx_resource).push(path,l.code)
executor.submit(self.txp.resource(self.tx_resource).push,path,l.code)
def transifex_source_to_json(self):
print("Pulling source from transifex...")
# pull translation
path=self.source_file_pattern.format(m=self.mode, p=self.tx_resource)
self.txp.resource(self.tx_resource).pull_source(path)
def resolve_updates(self):
locales = {}
for localefile in glob.iglob(self.locale_file_glob_pattern.format(m=self.mode, p=self.tx_resource)):
# print(localefile)
lfile=open(localefile,'r')
locale = json.load(lfile)
lfile.close()
locale_name = localefile.replace(self.locale_file_pattern_prefix.format(m=self.mode, p=self.tx_resource),'').split('.')[0]
if locale_name != self.base_lang:
# print("locale", locale)
for resource in locale:
# print("\tresource", resource)
for id in locale[resource]:
for property in locale[resource][id]:
# form text translations are written directly into the custom form
property_value = locale[resource][id][property]["string"]
if self.form_text_prefix in property and resource in self.customForms:
if locale_name not in self.customForms[resource][id]['form_dict']:
self.customForms[resource][id]['form_dict'][locale_name] = {}
self.customForms[resource][id]['form_dict'][locale_name][property] = property_value
else:
# print("property",property)
if self.tx_i18n_type == 'STRUCTURED_JSON':
if property_value:
translation = [{ "property": property, "locale": locale_name, "value": property_value }]
entry = { resource : { id : { "translations" : translation }}}
self.merge_translations(locales,entry)
else:
property_value = locale[resource][id][property]
if property_value:
translation = [{ "property": property, "locale": locale_name, "value": property_value }]
entry = { resource : { id : { "translations" : translation }}}
self.merge_translations(locales,entry)
# locales.merge(locale)
# print(json.dumps(locales, sort_keys=True, indent=2, separators=(',', ': ')))
mfile= open(self.localisation_dir.name + "/" + "toMeta.json",'w')
mfile.write(json.dumps(locales, sort_keys=True, indent=2, ensure_ascii=False, separators=(',', ': ')))
mfile.close()
# compare downloaded translations with those pulled from DHIS2, so that we only have
# to push back updates
toDHIS2 = self.minimise_translations(self.fromDHIS2,locales)
mfile= open(self.localisation_dir.name + "/" + "toMetaMin.json",'w')
mfile.write(json.dumps(toDHIS2, sort_keys=True, indent=2, ensure_ascii=False, separators=(',', ': ')))
mfile.close()
return toDHIS2
def json_to_dhis2(self):
print("Pushing translations to",self.dhis2_server,"...")
toDHIS2 = self.resolve_updates()
for resource in toDHIS2:
for id in toDHIS2[resource]:
payload = json.dumps(toDHIS2[resource][id], sort_keys=True, indent=2, ensure_ascii=True, separators=(',', ': '))
url = self.dhis2_server+"/api/"+resource+"/"+id+"/translations"
# print("PUT ",url)
r = requests.put(url, data=payload,auth=self.dhis2_AUTH)
print(r.status_code,": PUT ",url)
print("payload:",payload)
if r.status_code > 204:
print(payload)
print(r.headers)
for resource in self.customForms:
for element in self.customForms[resource]:
print("want to update html:",element)
newForm = {}
el = { 'id': element, 'htmlCode': ''}
newForm['htmlCode'] = self.set_custom_form_translations(resource, el)
url = self.dhis2_server+"/api/"+resource+"/"+element
r = requests.patch(url, json=newForm,auth=self.dhis2_AUTH,params={'mergeMode': 'REPLACE'})
print(r.status_code,": PUT ",url)
if r.status_code > 204:
print(payload)
print(r.headers)
def merge_translations(self, dict1, dict2):
""" Recursively merges dict2 into dict1 """
if not isinstance(dict1, dict) or not isinstance(dict2, dict):
return dict1 + dict2
for k in dict2:
if k in dict1:
dict1[k] = self.merge_translations(dict1[k], dict2[k])
else:
dict1[k] = dict2[k]
return dict1
def compare_translations(self, t1, t2):
if t1['locale'] == t2['locale']:
if t1['property'] == t2['property']:
if t1['value'] == t2['value']:
# translations are the same
return 0
else:
# different value
return 1
else:
# different property
return -2
else:
# different locale
return -1
def minimise_translations(self, in_trans, out_trans):
""" Keeps only altered sets of translations """
tin = in_trans.copy()
if isinstance(out_trans, list):
i_match = 0
i_new = 0
for o in out_trans:
# s_out = json.dumps(o , sort_keys=True)
comp = 0
for i in in_trans:
# s_in = json.dumps(i , sort_keys=True)
comp = self.compare_translations(i,o)
if comp in [0,1]:
if comp == 1:
for t in tin:
if t['locale'] == o['locale'] and t['property'] == o['property']:
t['value'] = o['value']
i_match += comp
break
if comp < 0:
# if comp is less than zero at this point then the translation is new
i_new = 1
tin.append(o)
if i_match == 0 and i_new == 0:
# there is nothing new for this object
return []
else:
# there are differences
# we don't want to lose any translations that are only in DHIS2, so we
# take that and merge any changes
return tin
return []
delta = {}
for k in out_trans:
if k in in_trans:
delta[k] = self.minimise_translations(in_trans[k], out_trans[k])
if len(delta[k]) == 0:
delta.pop(k,None)
else:
delta[k] = out_trans[k]
return delta
def set_custom_form_translations(self, resource, element):
if isinstance(element,dict) and 'htmlCode' in element and element['id'] in self.customForms[resource] and 'htmlCode_new' in self.customForms[resource][element['id']]:
html_code = self.customForms[resource][element['id']]['htmlCode_new']
soup = BeautifulSoup(html_code, "html.parser")
if resource not in self.customForms:
# we didn't extract this so cannot push any changes back. Ignore.
self.customForms[resource] = {}
else:
print("\tInserting translations into custom form",resource,element['id'])
soup = BeautifulSoup(html_code, "html.parser")
localiser_script = self.__extract_localiser_script__(soup)
if not localiser_script:
# there is no localiser script in the htmlCode, so we add one.
localiser_script = soup.new_tag('script', id=self.localiser_script_id)
soup.insert(len(soup.contents), localiser_script)
with open('src/template.js') as f:
script_template=f.read()
t = Template(script_template)
form_dict = self.customForms[resource][element['id']]['form_dict']
localiser_script.string = t.render(form_dict=json.dumps(form_dict, indent=4, sort_keys=True, ensure_ascii=False))
return str(soup)
def __get_js_object__(self, offset, str):
count = 0
len = offset
start = 0
end = 0
for i in str[offset:]:
len +=1
if i == "{":
count += 1
if count == 1:
start = len -1
elif i == "}":
count -= 1
if count == 0:
end = len
return json.loads(str[start:end])
def get_custom_form_translations(self, resource, element):
form_trans = []
old_to_new = {}
form_dict = {}
if isinstance(element,dict) and 'htmlCode' in element:
# print('HTML:',resource, element['id'])
html_code = element['htmlCode']
soup = BeautifulSoup(html_code, "html.parser")
langspans = soup.findAll("span", {"class": "lang"})
if langspans:
# there are spans with class "lang" in this form, so it should be localised
print("\tExtracting localisation strings from custom form",resource,element['id'])
if resource not in self.customForms:
self.customForms[resource] = {}
if element['id'] not in self.customForms[resource]:
self.customForms[resource][element['id']] = {"htmlCode":html_code, "spans":{}}
localiser_script = self.__extract_localiser_script__(soup)
if localiser_script:
# print(parse(formscript.string)[0]['declarations'][0])
match = re.search("arrLang =", localiser_script.string)
form_dict = self.__get_js_object__(match.start(),localiser_script.string)
localiser_script['id'] = self.localiser_script_id
# remove the content of the html, we'll build it again when we pull translations back
localiser_script.string = ''
for langspan in langspans:
source = langspan.string.strip()
key = self.form_text_prefix + hashlib.md5(source.encode()).hexdigest()
# add key to translatable fields for metadata
# if resource_based:
self.translatable_fields[resource][key] = key
self.translatable_max_chars[resource][key] = 2147483647
self.customForms[resource][element['id']]['spans'][key] = source
element[key] = source
# create a map of old to new keys
try:
old_to_new[langspan['langkey']] = key
except KeyError:
pass
langspan['langkey'] = key
# self.customForms[resource][element['id']]['htmlCode_new'] = str(soup)
for l in form_dict:
# print(json.dumps(form_dict[l], sort_keys=True, indent=2, ensure_ascii=False))
# print(json.dumps(old_to_new, sort_keys=True, indent=2, ensure_ascii=False))
if '' in form_dict[l]:
del form_dict[l]['']
f_dic = {}
for k, v in form_dict[l].items():
if k in old_to_new:
if l != self.base_lang:
new_tran = {"locale":l,"property":old_to_new[k],"value":v}
form_trans.append(new_tran)
f_dic[old_to_new[k]] = v
form_dict[l] = f_dic
# if form_dict is empty (did not already exist) start it
if form_dict == {}:
form_dict[self.base_lang] = {}
for key,source in self.customForms[resource][element['id']]['spans'].items():
if key not in form_dict[self.base_lang]:
# add any new keys to the base language in the form_dict
form_dict[self.base_lang][key] = source
localiser_script = self.__extract_localiser_script__(soup)
if not localiser_script:
# there is no localiser script in the htmlCode, so we add one.
localiser_script = soup.new_tag('script', id=self.localiser_script_id)
soup.insert(len(soup.contents), localiser_script)
with open('src/template.js') as f:
script_template=f.read()
t = Template(script_template)
localiser_script.string = t.render(form_dict=json.dumps(form_dict, indent=4, sort_keys=True, ensure_ascii=False))
# we have converted the customForm to support localisation - save it as htmlCode_new
# (If it already supported localisation, htmlCode_new will represent updated keys and translations)
self.customForms[resource][element['id']]['htmlCode_new'] = str(soup)
self.customForms[resource][element['id']]['form_dict'] = form_dict
self.customForms[resource][element['id']]['translations'] = form_trans
# return form_dict,form_trans
# print(json.dumps(form_dict, sort_keys=True, indent=2, ensure_ascii=False))
def swap_custom_form_translations(self, resource, element):
form_dict = {}
if isinstance(element,dict) and 'htmlCode' in element:
# print('HTML:',resource, element['id'])
html_code = element['htmlCode']
soup = BeautifulSoup(html_code, "html.parser")
langspans = soup.findAll("span", {"class": "lang"})
if langspans:
# there are spans with class "lang" in this form, so it should be localised
# as long as we have a dictionary
localiser_script = self.__extract_localiser_script__(soup)
if localiser_script:
print("\tSwapping localisation strings in custom form",resource,element['id'])
# extract the dictionary
match = re.search("arrLang =", localiser_script.string)
form_dict = self.__get_js_object__(match.start(),localiser_script.string)
if self.target_lang in form_dict:
for langspan in langspans:
try:
if langspan['langkey'] in form_dict[self.target_lang]:
langspan.string = form_dict[self.target_lang][langspan['langkey']]
except KeyError:
pass
element['htmlCode'] = str(soup)
def exclude_custom_form_translations(self, resource, element):
form_dict = {}
if isinstance(element,dict) and 'htmlCode' in element:
# print('HTML:',resource, element['id'])
html_code = element['htmlCode']
soup = BeautifulSoup(html_code, "html.parser")
langspans = soup.findAll("span", {"class": "lang"})
if langspans:
# there are spans with class "lang" in this form, so it should be localised
# as long as we have a dictionary
localiser_script = self.__extract_localiser_script__(soup)
if localiser_script:
print("\tFiltering localisation strings in custom form",resource,element['id'])
# extract the dictionary
match = re.search("arrLang =", localiser_script.string)
form_dict = self.__get_js_object__(match.start(),localiser_script.string)
if self.include_locales:
filtered_dict = [f for f in form_dict if f in self.include_locales]
else:
if self.exclude_locales:
filtered_dict = [f for f in form_dict if f not in self.exclude_locales]
else:
filtered_dict = form_dict
with open('src/template.js') as f:
script_template=f.read()
t = Template(script_template)
localiser_script.string = t.render(form_dict=json.dumps(filtered_dict, indent=4, sort_keys=True, ensure_ascii=False))
element['htmlCode'] = str(soup)
def __extract_localiser_script__(self, soup):
localiser = soup.find('script', id=self.localiser_script_id)
if not localiser:
# we didn't find the localiser script by id, it might be an "old" script from Manu tool
for f_script in soup.findAll("script"):
if "Applying translations" in f_script.string:
# this looks like the Manu script
localiser = f_script
break
if localiser:
return localiser
else:
return None
class f2t(d2t):
def __init__(self, project, resource, package_url, base='', include='', exclude='', tx_org='', tx_token='', object_filter=''):
d2t.__init__(self,"","","",project, resource, base, tx_org=tx_org, tx_token=tx_token, object_filter=object_filter)
self.package = {}
self.set_package(package_url)
if not self.__valid_package__():
sys.exit("Package file invalid! Aborting.")
# get the DHIS2 version from the package
self.DHIS2Version = self.package['package']['DHIS2Version']
if self.DHIS2Version[0:2] == '2.':
self.DHIS2Major = self.DHIS2Version[2:4]
else:
self.DHIS2Major = self.DHIS2Version[0:2]
self.__set_schemas__()
self.package_url = package_url
self.target_lang = None
if base and len(base.split(':')) > 1:
self.target_lang = base.split(':')[1]
if self.target_lang == self.base_lang:
self.target_lang = None
if self.target_lang:
mt_logger.info("Target main locale: "+self.target_lang)
self.include_locales = []
self.exclude_locales = []
if include:
self.include_locales = include.split(',')
# if there are include_locales, then exclusions will be ignored
else:
if exclude:
self.exclude_locales = exclude.split(',')
def __set_schemas__(self):
transfields = {}
for schemafile in glob.iglob('schemas/'+self.DHIS2Major+'*.json'):
sfile=open(schemafile,'r')
if transfields:
transfields = self.merge_translations(transfields, json.load(sfile))
else:
transfields = json.load(sfile)
sfile.close()
self.translatable_fields = {}
self.translatable_max_chars = {}
self.translatable_fields = {r:transfields['translatable_fields'][r] for r in transfields['translatable_fields'] if r not in self.object_filter}
self.translatable_max_chars = {r:transfields['translatable_max_chars'][r] for r in transfields['translatable_max_chars'] if r not in self.object_filter}
print(self.translatable_fields)
def set_package(self,package_url):
"""
We try to get the list of the object IDs from the package file, and use that to filter
the objects we translate
"""
if os.path.isfile(package_url):
f = open(package_url,'r')
self.package=json.load(f)
f.close()
return True
else:
export_response=requests.get(package_url)
if export_response.status_code == requests.codes['OK']:
self.package=json.loads(export_response.text)
return True
# return false if not set
return False
def __valid_package__(self):
if self.package:
if 'package' in self.package:
if 'locale' in self.package['package']:
if self.package['package']['locale'] == self.base_lang:
return True
else:
print("Package file base locale is '"+self.package['package']['locale']+"', expected '"+self.base_lang+"'")
return False
def __second_level_extraction__(self,parent_resource,package,locales,translatable_fields,translatable_max_chars):
for resource in package:
collection = package[resource]
if isinstance(collection, list):
for element in collection:
if resource in translatable_fields:
if isinstance(element,dict):
try:
el_id = parent_resource + '/' + package['id'] + '/' + resource + '/' + element['id']
translations= element["translations"]
if translations != []:
if resource not in self.fromDHIS2:
self.fromDHIS2[resource] = {}
if el_id not in self.fromDHIS2[resource]:
self.fromDHIS2[resource][el_id] = {}
self.fromDHIS2[resource][el_id]['translations'] = translations
else:
self.fromDHIS2[resource][el_id]['translations'] += translations
for transField in translatable_fields[resource]:
transFieldKey = translatable_fields[resource][transField]
# we can only create translation strings in transifex when a source base field has a value
if transField in element:
matching_translations=[m for m in translations if m['property'] == transFieldKey]
# print( transField, element[transField])
# char_limit = translatable_max_chars[transFieldKey]
if resource not in locales['source']:
locales['source'][resource] = {}
if el_id not in locales['source'][resource]:
locales['source'][resource][el_id] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales['source'][resource][el_id][transFieldKey] = { "string":element[transField] }
if translatable_max_chars[resource][transFieldKey] < 2147483647:
locales['source'][resource][el_id][transFieldKey]["character_limit"] = translatable_max_chars[resource][transFieldKey]
else:
locales['source'][resource][el_id][transFieldKey] = element[transField]
for m in matching_translations:
if m['locale'] not in self.langmap.keys():
if m['locale'] not in locales:
locales[m['locale']]={}
if resource not in locales[m['locale']]:
locales[m['locale']][resource] = {}
if el_id not in locales[m['locale']][resource]:
locales[m['locale']][resource][el_id] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales[m['locale']][resource][el_id][transFieldKey] = { "string":m['value'] }
if translatable_max_chars[resource][transFieldKey] < 2147483647:
locales[m['locale']][resource][el_id][transFieldKey]["character_limit"] = translatable_max_chars[resource][transFieldKey]
else:
locales[m['locale']][resource][el_id][transFieldKey] = m['value']
else:
# check and warn if we have translations with no base string
matching_translations=[m for m in translations if m['property'] == transFieldKey]
for m in matching_translations:
print("WARNING: Translation without base string for",resource,">",el_id,":", m)
except KeyError:
pass
def file_to_json(self):
"""
Extracts the translatable metadata from the package file and converts into a JSON format suitable for transifex.
"""
print("Pulling translatable metadata from", self.package_url, "...")
translatable_fields = self.translatable_fields
translatable_max_chars= self.translatable_max_chars
locales={}
locales["source"]={}
# We don't want to modify the original package, so make a deep copy
# We will modify the copy to make it easy to pull out the custom form strings
package = copy.deepcopy(self.package)
for resource in package:
# skip the resource if it is in the exclude_objects list
if self.object_filter:
if resource in self.object_filter:
print("Skipping",resource,"(in exclude-objects list)")
continue
# skip the object that contains the packages own metadata
if resource != "package":
collection = package[resource]
for element in collection:
# if we want to translate custom forms
self.get_custom_form_translations(resource, element)
try:
# form_dict = self.customForms[resource][element['id']]['form_dict']
form_trans = self.customForms[resource][element['id']]['translations']
# if self.base_lang in form_dict:
# print(json.dumps(form_dict[self.base_lang], sort_keys=True, indent=2, ensure_ascii=False))
# if there was a custom form with translations, add the translations
element['translations'] += form_trans
except KeyError:
pass
self.__second_level_extraction__(resource,element,locales,translatable_fields,translatable_max_chars)
if 'translations' in element:
translations= element["translations"]
el_id = element['id']
if translations != []:
if resource not in self.fromDHIS2:
self.fromDHIS2[resource] = {}
if el_id not in self.fromDHIS2[resource]:
self.fromDHIS2[resource][el_id] = {}
self.fromDHIS2[resource][el_id]['translations'] = translations
else:
self.fromDHIS2[resource][el_id]['translations'] += translations
if resource in translatable_fields:
for transField in translatable_fields[resource]:
transFieldKey = translatable_fields[resource][transField]
# we can only create translation strings in transifex when a source base field has a value
if transField in element:
matching_translations=[m for m in translations if m['property'] == transFieldKey]
# print( transField, element[transField])
# char_limit = translatable_max_chars[transFieldKey]
if resource not in locales['source']:
locales['source'][resource] = {}
if el_id not in locales['source'][resource]:
locales['source'][resource][el_id] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales['source'][resource][el_id][transFieldKey] = { "string":element[transField] }
if translatable_max_chars[resource][transFieldKey] < 2147483647:
locales['source'][resource][el_id][transFieldKey]["character_limit"] = translatable_max_chars[resource][transFieldKey]
else:
locales['source'][resource][el_id][transFieldKey] = element[transField]
for m in matching_translations:
if m['locale'] not in self.langmap.keys():
if m['locale'] not in locales:
locales[m['locale']]={}
if resource not in locales[m['locale']]:
locales[m['locale']][resource] = {}
if el_id not in locales[m['locale']][resource]:
locales[m['locale']][resource][el_id] = {}
if self.tx_i18n_type == 'STRUCTURED_JSON':
locales[m['locale']][resource][el_id][transFieldKey] = { "string":m['value'] }
if translatable_max_chars[resource][transFieldKey] < 2147483647:
locales[m['locale']][resource][el_id][transFieldKey]["character_limit"] = translatable_max_chars[resource][transFieldKey]
else:
locales[m['locale']][resource][el_id][transFieldKey] = m['value']
else:
# check and warn if we have translations with no base string
matching_translations=[m for m in translations if m['property'] == transFieldKey]