-
Notifications
You must be signed in to change notification settings - Fork 51
/
ResourceUtils.java
1436 lines (1367 loc) · 53.2 KB
/
ResourceUtils.java
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
package org.zanata.rest.service;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.Serializable;
import java.io.StringReader;
import java.io.UnsupportedEncodingException;
import java.net.URLDecoder;
import java.net.URLEncoder;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.annotation.PostConstruct;
import javax.enterprise.context.RequestScoped;
import javax.persistence.EntityManager;
import javax.ws.rs.WebApplicationException;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.Response.Status;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang3.StringUtils;
import org.fedorahosted.tennera.jgettext.HeaderFields;
import javax.inject.Inject;
import javax.inject.Named;
import org.zanata.ApplicationConfiguration;
import org.zanata.common.ContentState;
import org.zanata.common.LocaleId;
import org.zanata.common.MergeType;
import org.zanata.common.ResourceType;
import org.zanata.dao.LocaleDAO;
import org.zanata.model.HDocument;
import org.zanata.model.HLocale;
import org.zanata.model.HPerson;
import org.zanata.model.HSimpleComment;
import org.zanata.model.HTextFlow;
import org.zanata.model.HTextFlowTarget;
import org.zanata.model.po.HPoHeader;
import org.zanata.model.po.HPoTargetHeader;
import org.zanata.model.po.HPotEntryData;
import org.zanata.rest.dto.Person;
import org.zanata.rest.dto.extensions.ExtensionType;
import org.zanata.rest.dto.extensions.comment.SimpleComment;
import org.zanata.rest.dto.extensions.gettext.AbstractResourceMetaExtension;
import org.zanata.rest.dto.extensions.gettext.HeaderEntry;
import org.zanata.rest.dto.extensions.gettext.PoHeader;
import org.zanata.rest.dto.extensions.gettext.PoTargetHeader;
import org.zanata.rest.dto.extensions.gettext.PotEntryHeader;
import org.zanata.rest.dto.extensions.gettext.TextFlowExtension;
import org.zanata.rest.dto.extensions.gettext.TextFlowTargetExtension;
import org.zanata.rest.dto.extensions.gettext.TranslationsResourceExtension;
import org.zanata.rest.dto.resource.AbstractResourceMeta;
import org.zanata.rest.dto.resource.ExtensionSet;
import org.zanata.rest.dto.resource.Resource;
import org.zanata.rest.dto.resource.TextFlow;
import org.zanata.rest.dto.resource.TextFlowTarget;
import org.zanata.rest.dto.resource.TranslationsResource;
import org.zanata.util.ServiceLocator;
import org.zanata.util.StringUtil;
import com.google.common.base.Optional;
import static org.apache.commons.lang3.StringUtils.isBlank;
import static org.apache.commons.lang3.StringUtils.isEmpty;
import static org.apache.commons.lang3.StringUtils.isNotEmpty;
// TODO move plural logic out of ResourceUtils into a dedicated class
@Named("resourceUtils")
@RequestScoped
public class ResourceUtils implements Serializable {
private static final org.slf4j.Logger log =
org.slf4j.LoggerFactory.getLogger(ResourceUtils.class);
private static final long serialVersionUID = -969189290416018542L;
/**
* Newline character used for multi-line comments
*/
private static final char NEWLINE = '\n';
private static final String ZANATA_GENERATOR_PREFIX = "Zanata";
private static final String ZANATA_TAG = "#zanata";
private static final String PO_DATE_FORMAT = "yyyy-MM-dd hh:mmZ";
private static final String PO_DEFAULT_CONTENT_TYPE =
"text/plain; charset=UTF-8";
/**
* PO Header entries
*/
private static final String LAST_TRANSLATOR_HDR = "Last-Translator";
private static final String PO_REVISION_DATE_HDR =
HeaderFields.KEY_PoRevisionDate;
private static final String LANGUAGE_TEAM_HDR =
HeaderFields.KEY_LanguageTeam;
private static final String X_GENERATOR_HDR = "X-Generator";
private static final String LANGUAGE_HDR = HeaderFields.KEY_Language;
private static final String CONTENT_TYPE_HDR = HeaderFields.KEY_ContentType;
private static final String PLURAL_FORMS_HDR = "Plural-Forms";
// TODO we should need only one regex, with a capture group for nplurals
private static final Pattern PLURAL_FORM_PATTERN =
Pattern.compile("nplurals=[0-9]+;\\s?plural=*");
private static final Pattern NPLURALS_TAG_PATTERN =
Pattern.compile("nplurals=");
private static final Pattern NPLURALS_PATTERN =
Pattern.compile("nplurals=[0-9]+");
private static final String PLURALS_FILE = "pluralforms.properties";
private static final int DEFAULT_NPLURALS = 1;
private static final String DEFAULT_PLURAL_FORM = "nplurals=1; plural=0";
public static final int MAX_TARGET_CONTENTS = 6;
private Properties pluralForms;
public static final String COPIED_BY_ZANATA_NAME = "Copied by Zanata";
public static final String COPIED_BY_ZANATA_NAME_EMAIL =
"copied-by-zanata@zanata.org";
@SuppressFBWarnings("SE_BAD_FIELD")
@Inject
private EntityManager entityManager;
@Inject
private LocaleDAO localeDAO;
@PostConstruct
public void create() {
try {
if (pluralForms == null) {
pluralForms = new Properties();
pluralForms.load(this.getClass().getClassLoader()
.getResourceAsStream(PLURALS_FILE));
}
} catch (IOException e) {
log.error("There was an error loading plural forms.", e);
}
}
Properties getPluralForms() {
return pluralForms;
}
/**
* Merges the list of TextFlows into the target HDocument, adding and
* obsoleting TextFlows as necessary.
*
* @param from
* @param to
* @return
*/
boolean transferFromTextFlows(List<TextFlow> from, HDocument to,
Set<String> enabledExtensions, int nextDocRev) {
boolean changed = false;
to.getTextFlows().clear();
Set<String> incomingIds = new HashSet<String>();
Set<String> previousIds =
new HashSet<String>(to.getAllTextFlows().keySet());
int count = 0;
for (TextFlow tf : from) {
if (!incomingIds.add(tf.getId())) {
Response response = Response.status(Status.BAD_REQUEST).entity(
"Encountered TextFlow with duplicate ID")
.build();
log.warn(
"encountered TextFlow with duplicate ID {}", tf.getId());
throw new WebApplicationException(response);
}
HTextFlow textFlow;
if (previousIds.contains(tf.getId())) {
previousIds.remove(tf.getId());
textFlow = to.getAllTextFlows().get(tf.getId());
textFlow.setObsolete(false);
to.getTextFlows().add(textFlow);
// avoid changing revision when resurrecting an unchanged TF
if (transferFromTextFlow(tf, textFlow, enabledExtensions)) {
// content
// has
// changed
textFlow.setRevision(nextDocRev);
changed = true;
for (HTextFlowTarget targ : textFlow.getTargets()
.values()) {
// if (targ.getState() != ContentState.New)
if (targ.getState().isTranslated()) {
targ.setState(ContentState.NeedReview);
targ.setVersionNum(targ.getVersionNum() + 1);
}
}
log.debug("TextFlow with id {} has changed", tf.getId());
}
} else {
textFlow = new HTextFlow();
textFlow.setDocument(to);
textFlow.setResId(tf.getId());
textFlow.setRevision(nextDocRev);
transferFromTextFlow(tf, textFlow, enabledExtensions);
changed = true;
to.getAllTextFlows().put(textFlow.getResId(), textFlow);
to.getTextFlows().add(textFlow);
entityManager.persist(textFlow);
log.debug("TextFlow with id {} is new", tf.getId());
}
count++;
if (count % 100 == 0) {
entityManager.flush();
}
// FIXME we can't clear entityManager here. See
// org.zanata.feature.rest.CopyTransTest.testPushTranslationAndCopyTrans.
// If you clear, last copyTran REST call will trigger exception on
// the server (hDocument.getTextFlows() will contain null entries -
// corrupted collection.
// see
// https://github.com/zanata/zanata-server/pull/571#issuecomment-55547577)
/*
* if (count % 500 == 0) { // this in some cases seem to slow down
* overall performance entityManager.clear(); to =
* entityManager.find(HDocument.class, to.getId()); }
*/
}
// set remaining textflows to obsolete.
for (String id : previousIds) {
HTextFlow textFlow = to.getAllTextFlows().get(id);
if (!textFlow.isObsolete()) {
changed = true;
log.debug("TextFlow with id {} is now obsolete", id);
textFlow.setRevision(to.getRevision());
textFlow.setObsolete(true);
}
}
if (changed)
to.setRevision(nextDocRev);
return changed;
}
/**
* Merges from the DTO Resource into HDocument, adding and obsoleting
* textflows, including metadata and the specified extensions
*
* @param from
* @param to
* @param enabledExtensions
* @return
*/
public boolean transferFromResource(Resource from, HDocument to,
Set<String> enabledExtensions, HLocale locale, int nextDocRev) {
boolean changed = false;
changed |= transferFromResourceMetadata(from, to, enabledExtensions,
locale, nextDocRev);
changed |= transferFromTextFlows(from.getTextFlows(), to,
enabledExtensions, nextDocRev);
return changed;
}
/**
* Transfers metadata and the specified extensions from DTO
* AbstractResourceMeta into HDocument
*
* @param from
* @param to
* @param enabledExtensions
* @return
*/
public boolean transferFromResourceMetadata(AbstractResourceMeta from,
HDocument to, Set<String> enabledExtensions, HLocale locale,
int nextDocRev) {
boolean changed = false;
// name
if (!equals(from.getName(), to.getDocId())) {
to.setFullPath(from.getName());
changed = true;
}
// locale
if (!equals(from.getLang(), to.getLocale().getLocaleId())) {
log.debug("locale: {}", from.getLang());
to.setLocale(locale);
changed = true;
}
// contentType
if (!equals(from.getContentType(), to.getContentType())) {
to.setContentType(from.getContentType());
changed = true;
}
// handle extensions
changed |= transferFromResourceExtensions(from.getExtensions(true), to,
enabledExtensions);
if (changed)
to.setRevision(nextDocRev);
return changed;
}
/**
* Transfers the specified extensions from DTO AbstractResourceMeta into
* HDocument
*
* @param from
* @param to
* @param enabledExtensions
* @return
* @see #transferFromResource
*/
private boolean transferFromResourceExtensions(
ExtensionSet<AbstractResourceMetaExtension> from, HDocument to,
Set<String> enabledExtensions) {
boolean changed = false;
if (enabledExtensions.contains(PoHeader.ID)) {
PoHeader poHeaderExt = from.findByType(PoHeader.class);
if (poHeaderExt != null) {
HPoHeader poHeader = to.getPoHeader();
if (poHeader == null) {
log.debug("create a new HPoHeader");
poHeader = new HPoHeader();
}
changed |= transferFromPoHeader(poHeaderExt, poHeader);
if (to.getPoHeader() == null && changed) {
to.setPoHeader(poHeader);
}
}
}
return changed;
}
/**
* Transfers enabled extensions from TranslationsResource into HDocument for
* a single locale
*
* @param from
* @param doc
* @param enabledExtensions
* @param locale
* @param mergeType
* @return
* @see #transferToTranslationsResourceExtensions
*/
public boolean transferFromTranslationsResourceExtensions(
ExtensionSet<TranslationsResourceExtension> from, HDocument doc,
Set<String> enabledExtensions, HLocale locale,
MergeType mergeType) {
boolean changed = false;
if (enabledExtensions.contains(PoTargetHeader.ID)) {
PoTargetHeader fromTargetHeader =
from.findByType(PoTargetHeader.class);
if (fromTargetHeader != null) {
log.debug("found PO header for locale: {}", locale);
try {
changed = tryGetOrCreateTargetHeader(doc, locale, mergeType,
changed, fromTargetHeader);
} catch (org.hibernate.exception.ConstraintViolationException e) {
entityManager.refresh(doc);
changed = tryGetOrCreateTargetHeader(doc, locale, mergeType,
changed, fromTargetHeader);
}
} else {
changed |= doc.getPoTargetHeaders().remove(locale) != null;
}
}
return changed;
}
private boolean tryGetOrCreateTargetHeader(HDocument doc, HLocale locale,
MergeType mergeType, boolean changed,
PoTargetHeader fromTargetHeader) {
HPoTargetHeader toTargetHeader = doc.getPoTargetHeaders().get(locale);
if (toTargetHeader == null) {
changed = true;
toTargetHeader = new HPoTargetHeader();
toTargetHeader.setTargetLanguage(locale);
toTargetHeader.setDocument(doc);
transferFromPoTargetHeader(fromTargetHeader, toTargetHeader,
MergeType.IMPORT); // return
// value
// not
// needed
entityManager.persist(toTargetHeader);
entityManager.flush();
} else {
changed |= transferFromPoTargetHeader(fromTargetHeader,
toTargetHeader, mergeType);
}
return changed;
}
private boolean transferFromTextFlowExtensions(TextFlow from, HTextFlow to,
Set<String> enabledExtensions) {
boolean changed = false;
ExtensionSet<TextFlowExtension> extensions = from.getExtensions(true);
if (enabledExtensions.contains(PotEntryHeader.ID)) {
PotEntryHeader entryHeader =
extensions.findByType(PotEntryHeader.class);
if (entryHeader != null) {
HPotEntryData hEntryHeader = to.getPotEntryData();
if (hEntryHeader == null) {
changed = true;
hEntryHeader = new HPotEntryData();
to.setPotEntryData(hEntryHeader);
log.debug("set potentryheader");
}
changed |= transferFromPotEntryHeader(entryHeader, hEntryHeader,
from);
}
}
if (enabledExtensions.contains(SimpleComment.ID)) {
SimpleComment comment = extensions.findByType(SimpleComment.class);
if (comment != null) {
HSimpleComment hComment = to.getComment();
if (hComment == null) {
hComment = new HSimpleComment();
}
if (!equals(comment.getValue(), hComment.getComment())) {
changed = true;
hComment.setComment(comment.getValue());
to.setComment(hComment);
log.debug("set comment:{}", comment.getValue());
}
}
}
return changed;
}
/**
* @see #transferToPotEntryHeader(HPotEntryData, PotEntryHeader)
* @param from
* @param to
* @param textFlow
* @return
*/
private boolean transferFromPotEntryHeader(PotEntryHeader from,
HPotEntryData to, TextFlow textFlow) {
boolean changed = false;
if (!equals(from.getContext(), to.getContext())) {
changed = true;
to.setContext(from.getContext());
}
List<String> flagList = from.getFlags();
// rhbz1012502 - should not store fuzzy tag in source document
if (flagList.contains("fuzzy")) {
throw new WebApplicationException(String.format(
"Please remove fuzzy flags from document. First fuzzy flag was found on text flow %s with content %s",
textFlow.getId(), textFlow.getContents()), 422);
}
String flags = StringUtil.concat(flagList, ',');
if (flagList.isEmpty()) {
flags = null;
}
if (!equals(flags, to.getFlags())) {
changed = true;
to.setFlags(flags);
}
List<String> refList = from.getReferences();
String refs = StringUtil.concat(from.getReferences(), ',');
if (refList.isEmpty()) {
refs = null;
}
if (!equals(refs, to.getReferences())) {
changed = true;
to.setReferences(refs);
}
return changed;
}
/**
* @param from
* @param to
* @param mergeType
* @return
* @see #transferFromTranslationsResourceExtensions
* @see #transferToPoTargetHeader
*/
private boolean transferFromPoTargetHeader(PoTargetHeader from,
HPoTargetHeader to, MergeType mergeType) {
boolean changed = pushPoTargetComment(from, to, mergeType);
// TODO we should probably block PoHeader/POT-specific entries
// ie POT-Creation-Date, Project-Id-Version, Report-Msgid-Bugs-To
String entries = PoUtility.listToHeader(from.getEntries());
if (!equals(entries, to.getEntries())) {
to.setEntries(entries);
changed = true;
}
return changed;
}
/**
* @param fromHeader
* @param toHeader
* @param mergeType
* @return
* @see #pullPoTargetComment
*/
protected boolean pushPoTargetComment(PoTargetHeader fromHeader,
HPoTargetHeader toHeader, MergeType mergeType) {
boolean changed = false;
HSimpleComment hComment = toHeader.getComment();
if (hComment == null) {
hComment = new HSimpleComment();
}
String fromComment = fromHeader.getComment();
String toComment = hComment.getComment();
if (!equals(fromComment, toComment)) {
// skip #zanata lines
List<String> fromLines = splitLines(fromComment, ZANATA_TAG);
StringBuilder sb = new StringBuilder(fromComment.length());
switch (mergeType) {
case IMPORT:
for (String line : fromLines) {
if (sb.length() != 0)
sb.append(NEWLINE);
sb.append(line);
changed = true;
}
break;
default:
// AUTO or anything else will merge comments
// to merge, we just append new lines, skip old lines
List<String> toLines = Collections.emptyList();
if (toComment != null) {
sb.append(toComment);
toLines = splitLines(toComment, null);
}
for (String line : fromLines) {
if (!toLines.contains(line)) {
if (sb.length() != 0)
sb.append(NEWLINE);
sb.append(line);
changed = true;
}
}
break;
}
if (changed) {
hComment.setComment(sb.toString());
toHeader.setComment(hComment);
}
}
return changed;
}
/**
* splits s into lines, skipping any which contain tagToSkip
*
* @param s
* @param tagToSkip
* @return
*/
static List<String> splitLines(String s, String tagToSkip) {
if (s.isEmpty()) {
return Collections.emptyList();
}
try {
List<String> lineList = new ArrayList<String>(s.length() / 40);
BufferedReader reader = new BufferedReader(new StringReader(s));
String line;
while ((line = reader.readLine()) != null) {
if (tagToSkip == null || !line.contains(tagToSkip)) {
lineList.add(line);
}
}
return lineList;
} catch (IOException e) {
throw new RuntimeException(e);
}
}
private boolean transferFromPoHeader(PoHeader from, HPoHeader to) {
boolean changed = false;
HSimpleComment comment = to.getComment();
if (comment == null) {
comment = new HSimpleComment();
}
if (!equals(from.getComment(), comment.getComment())) {
changed = true;
comment.setComment(from.getComment());
to.setComment(comment);
}
String entries = PoUtility.listToHeader(from.getEntries());
if (!equals(entries, to.getEntries())) {
to.setEntries(entries);
changed = true;
}
return changed;
}
public static <T> boolean equals(T a, T b) {
if (a == null && b == null) {
return true;
}
if (a == null || b == null) {
return false;
}
return a.equals(b);
}
private boolean transferFromTextFlow(TextFlow from, HTextFlow to,
Set<String> enabledExtensions) {
boolean changed = false;
if (!equals(from.getContents(), to.getContents())) {
to.setContents(from.getContents());
changed = true;
}
if (!equals(from.isPlural(), to.isPlural())) {
to.setPlural(from.isPlural());
changed = true;
}
// TODO from.getLang()
transferFromTextFlowExtensions(from, to, enabledExtensions);
return changed;
}
public void transferToResource(HDocument from, Resource to) {
transferToAbstractResourceMeta(from, to);
}
private void transferToPoHeader(HPoHeader from, PoHeader to) {
if (from.getComment() != null) {
to.setComment(from.getComment().getComment());
}
to.getEntries().addAll(PoUtility.headerToList(from.getEntries()));
}
/**
* @param from
* @param to
* @param hTargets
* @param locale
* @see #transferToTranslationsResourceExtensions
* @see #transferFromPoTargetHeader
*/
private void transferToPoTargetHeader(HPoTargetHeader from,
PoTargetHeader to, List<HTextFlowTarget> hTargets, HLocale locale) {
pullPoTargetComment(from, to, hTargets);
to.getEntries().addAll(this.headerToList(from.getEntries()));
populateHeaderEntries(to.getEntries(), hTargets, locale);
}
/**
* Transforms a set of header entries from a String to a list of POJOs.
*
* @param entries
* The header entries' string.
*/
private List<HeaderEntry> headerToList(final String entries) {
return PoUtility.headerToList(entries);
}
/**
* Populates a list of header entries with values stored in the system. For
* certain headers, the original value will remain if present.
*
* @param headerEntries
* The header entries to be populated.
* @param hTargets
* The Text Flow Targets that the header applies to.
* @param locale
* The locale that is bein
*/
private void populateHeaderEntries(final List<HeaderEntry> headerEntries,
final List<HTextFlowTarget> hTargets, final HLocale locale) {
final Map<String, HeaderEntry> containedHeaders =
new LinkedHashMap<String, HeaderEntry>(headerEntries.size());
HTextFlowTarget lastChangedTarget = getLastChangedTarget(hTargets);
// Collect the existing header entries
for (HeaderEntry entry : headerEntries) {
containedHeaders.put(entry.getKey(), entry);
}
// Add / Replace headers
Date revisionDate =
this.getRevisionDate(headerEntries, lastChangedTarget);
HeaderEntry headerEntry = containedHeaders.get(PO_REVISION_DATE_HDR);
if (headerEntry == null) {
headerEntry = new HeaderEntry(PO_REVISION_DATE_HDR,
this.toPoHeaderString(revisionDate));
headerEntries.add(headerEntry);
} else {
headerEntry.setValue(this.toPoHeaderString(revisionDate));
}
headerEntry = containedHeaders.get(LAST_TRANSLATOR_HDR);
if (headerEntry == null) {
headerEntry = new HeaderEntry(LAST_TRANSLATOR_HDR,
this.getLastTranslator(lastChangedTarget, headerEntries));
headerEntries.add(headerEntry);
} else {
headerEntry.setValue(
this.getLastTranslator(lastChangedTarget, headerEntries));
}
headerEntry = containedHeaders.get(LANGUAGE_TEAM_HDR);
if (headerEntry == null) {
headerEntry = new HeaderEntry(LANGUAGE_TEAM_HDR,
this.getLanguageTeam(locale));
headerEntries.add(headerEntry);
} else {
// Keep the original value if provided
}
headerEntry = containedHeaders.get(LANGUAGE_HDR);
if (headerEntry == null) {
headerEntry =
new HeaderEntry(LANGUAGE_HDR, this.getLanguage(locale));
headerEntries.add(headerEntry);
} else {
headerEntry.setValue(this.getLanguage(locale));
}
headerEntry = containedHeaders.get(X_GENERATOR_HDR);
if (headerEntry == null) {
headerEntry =
new HeaderEntry(X_GENERATOR_HDR, this.getSystemVersion());
headerEntries.add(headerEntry);
} else {
headerEntry.setValue(this.getSystemVersion());
}
headerEntry = containedHeaders.get(CONTENT_TYPE_HDR);
if (headerEntry == null) {
headerEntry =
new HeaderEntry(CONTENT_TYPE_HDR, PO_DEFAULT_CONTENT_TYPE);
headerEntries.add(headerEntry);
} else {
headerEntry.setValue(PO_DEFAULT_CONTENT_TYPE);
}
headerEntry = containedHeaders.get(PLURAL_FORMS_HDR);
if (headerEntry == null || isBlank(headerEntry.getValue())) {
headerEntry = new HeaderEntry(PLURAL_FORMS_HDR,
this.getPluralForms(locale));
headerEntries.add(headerEntry);
} else {
// Keep the original if provided
}
}
/**
* Finds and returns the Revision Date stored in a PO file's header entries.
*
* @param headerEntries
* A single PO file's header entries.
* @return The Revision Date header value, or null if no such header is
* found or the date cannot be parsed.
*/
private Date getHeaderRevisionDate(final List<HeaderEntry> headerEntries) {
Date poFileRevisionDate = null;
for (HeaderEntry entry : headerEntries) {
if (entry.getKey().equalsIgnoreCase(PO_REVISION_DATE_HDR)) {
SimpleDateFormat dateFormat =
new SimpleDateFormat(PO_DATE_FORMAT);
try {
poFileRevisionDate = dateFormat.parse(entry.getValue());
} catch (ParseException e) {
// found the header but date could not be parsed
}
break;
}
}
return poFileRevisionDate;
}
private String
getHeaderLastTranslator(final List<HeaderEntry> headerEntries) {
for (HeaderEntry entry : headerEntries) {
if (entry.getKey().equalsIgnoreCase(LAST_TRANSLATOR_HDR)) {
return entry.getValue();
}
}
return "";
}
/**
* Returns a PO file's Revision Date based on the values stored in the
* file's header and in the last translated target. If the system cannot
* determine a suitable Revision date, a null value is returned.
*/
private Date getRevisionDate(final List<HeaderEntry> headerEntries,
final HTextFlowTarget lastTranslated) {
Date poFileRevisionDate = this.getHeaderRevisionDate(headerEntries);
Date translationsRevisionDate = null;
if (lastTranslated != null) {
translationsRevisionDate = lastTranslated.getLastChanged();
}
if (translationsRevisionDate != null) {
if (poFileRevisionDate != null) {
return translationsRevisionDate.after(poFileRevisionDate)
? translationsRevisionDate : poFileRevisionDate;
} else {
return translationsRevisionDate;
}
} else {
return poFileRevisionDate == null ? null : poFileRevisionDate;
}
}
/**
* @param translations
* - List of HTextFlowTarget
* @return last changed/updated HTextFlowTarget from the list
*/
private HTextFlowTarget
getLastChangedTarget(final List<HTextFlowTarget> translations) {
Date lastUpdate = new Date(Long.MIN_VALUE);
HTextFlowTarget lastChanged = null;
for (HTextFlowTarget tft : translations) {
if (tft.getLastChanged().after(lastUpdate)) {
lastChanged = tft;
lastUpdate = tft.getLastChanged();
}
}
return lastChanged;
}
/**
* Gets the last translator header value for a set of header entries and the
* last translated target.
*
* @param lastTranslated
* The most currently translated target.
* @param headerEntries
* The PO header entries.
* @return A string with the value of the last translator.
*/
private String getLastTranslator(final HTextFlowTarget lastTranslated,
final List<HeaderEntry> headerEntries) {
Date headerRevisionDate = this.getHeaderRevisionDate(headerEntries);
String lastTranslator = this.getHeaderLastTranslator(headerEntries);
if (lastTranslated != null) {
HPerson lastTranslatedBy = lastTranslated.getTranslator();
Date lastModifiedDate = lastTranslated.getLastChanged();
if (lastTranslatedBy != null) {
if (lastModifiedDate == null
|| lastModifiedDate.after(headerRevisionDate)) {
/**
* Use translator details from last translated target if the
* lastModifiedDate is null or if lastModifiedDate is after
* date in header entries
*/
lastTranslator =
generateLastTranslator(lastTranslatedBy.getName(),
lastTranslatedBy.getEmail());
}
} else {
/**
* When last translated target is being created in Zanata
* without user (e.g upload, copyTrans), set translator to be
* Zanata
*/
lastTranslator = generateLastTranslator(COPIED_BY_ZANATA_NAME,
COPIED_BY_ZANATA_NAME_EMAIL);
}
}
return lastTranslator;
}
/**
* @param name
* - name of person
* @param email
* - email of person
* @return {name} <{email}>
*/
private String generateLastTranslator(String name, String email) {
return name + " <" + email + ">";
}
/**
* Returns a string representation of a Date for use in a PO file header.
*
* @param aDate
* Date object to include in the Header
* @return A string with the value of the date suitable for a PO file
* header.
*/
private String toPoHeaderString(Date aDate) {
if (aDate != null) {
SimpleDateFormat dateFormat = new SimpleDateFormat(PO_DATE_FORMAT);
return dateFormat.format(aDate);
} else {
return "";
}
}
/**
* Returns the Language Team PO file header for a given locale.
*/
private String getLanguageTeam(final HLocale hLocale) {
return hLocale.retrieveDisplayName();
}
/**
* Retrieves the language PO file header for a given locale.
*
* @param locale
*/
String getLanguage(HLocale locale) {
return StringUtils.replace(locale.getLocaleId().toString(), "-", "_");
}
/**
* Returns the application version.
*/
private String getSystemVersion() {
try {
return ZANATA_GENERATOR_PREFIX + " "
+ (ServiceLocator.instance()
.getInstance(ApplicationConfiguration.class))
.getVersion();
} catch (Exception e) {
return ZANATA_GENERATOR_PREFIX + " UNKNOWN";
}
}
/**
* Returns the appropriate plural form for a given Locale. Returns a default
* value if there is no plural form information for the provided locale.
*/
public String getPluralForms(HLocale locale) {
return getPluralForms(locale.getLocaleId());
}
/**
* Returns the appropriate plural form for a given Locale Id. Returns a
* default value if there is no plural form information for the provided
* locale id.
*
* @see {@link ResourceUtils#getPluralForms(org.zanata.common.LocaleId, boolean, boolean)}
*/
public String getPluralForms(LocaleId localeId) {
return getPluralForms(localeId, true, true);
}
/**
* Returns the appropriate plural from for a given locale Id.
*
* From HLocale.plurals if available, else from pluralforms.properties
*
* @return A default value if useDefault is True. Otherwise, null.
*/
public String getPluralForms(LocaleId localeId, boolean checkDB,
boolean useDefault) {
if (checkDB) {
String dbPluralForms = getPluralFormsFromDB(localeId);
if (isNotEmpty(dbPluralForms)) {
return dbPluralForms;
}
}
final char[] alternateSeparators = { '.', '@' };
String javaLocale = localeId.toJavaName().toLowerCase();
// Replace all alternate separators for the "_" (Java) separator.
for (char sep : alternateSeparators) {
javaLocale = javaLocale.replace(sep, '_');
}
if (pluralForms.containsKey(javaLocale)) {
return pluralForms.getProperty(javaLocale);
}
// Try out every combination. e.g: for xxx_yyy_zzz, try xxx_yyyy_zzz,
// then
// xxx_yyy, then xxx
while (javaLocale.indexOf('_') > 0) {
javaLocale = javaLocale.substring(0, javaLocale.lastIndexOf('_'));
if (pluralForms.containsKey(javaLocale)) {
return pluralForms.getProperty(javaLocale);
}
}
if (useDefault) {
return DEFAULT_PLURAL_FORM;
} else {
return null;
}
}
public int getNumPlurals(HDocument document, HLocale hLocale) {
HPoTargetHeader headers = document.getPoTargetHeaders().get(hLocale);
String headerEntries = headers != null ? headers.getEntries() : "";
return getNumPlurals(headerEntries, hLocale.getLocaleId());
}
/**
* return plural count info from 1) PO Header entry if available, else 2)
* HLocale.plurals if available, else 3) pluralforms.properties, else 4)
* assume no plural forms (nplurals=1)
*
* @param poHeaders
* - HPoTargetHeader.entries
* @param localeId
* - locale identifier
*/
int getNumPlurals(@Nullable String poHeaders, LocaleId localeId) {
if (!isEmpty(poHeaders)) {
Properties headerList = loadHeaders(poHeaders);
String pluralFormsHeader = headerList.getProperty(PLURAL_FORMS_HDR);
if (pluralFormsHeader != null) {
if (!pluralFormsHeader.isEmpty()) {
try {
// try to parse plurals from the header
return extractNPlurals(pluralFormsHeader);
} catch (NumberFormatException | PluralParseException e) {
log.debug("Unable to parse plurals", e);
// TODO return a warning to the user when uploading
log.warn(
"Error parsing plural forms header; using defaults for locale {}; headers: {}",
localeId, poHeaders);
}
} else {