/
MultiTreeAPIImpl.java
1341 lines (1110 loc) · 61.3 KB
/
MultiTreeAPIImpl.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 com.dotmarketing.factories;
import com.dotcms.business.CloseDBIfOpened;
import com.dotcms.business.WrapInTransaction;
import com.dotcms.contenttype.exception.NotFoundInDbException;
import com.dotcms.enterprise.achecker.utility.Utility;
import com.dotcms.rendering.velocity.directive.ParseContainer;
import com.dotcms.rendering.velocity.services.PageLoader;
import com.dotcms.rendering.velocity.viewtools.DotTemplateTool;
import com.dotcms.util.DotPreconditions;
import com.dotcms.util.transform.TransformerLocator;
import com.dotcms.variant.VariantAPI;
import com.dotcms.variant.model.Variant;
import com.dotmarketing.beans.Identifier;
import com.dotmarketing.beans.MultiTree;
import com.dotmarketing.business.APILocator;
import com.dotmarketing.business.CacheLocator;
import com.dotmarketing.business.DotStateException;
import com.dotmarketing.cache.MultiTreeCache;
import com.dotmarketing.common.db.DotConnect;
import com.dotmarketing.common.db.Params;
import com.dotmarketing.db.DbConnectionFactory;
import com.dotmarketing.exception.DotDataException;
import com.dotmarketing.exception.DotRuntimeException;
import com.dotmarketing.exception.DotSecurityException;
import com.dotmarketing.portlets.containers.business.ContainerAPI;
import com.dotmarketing.portlets.containers.business.FileAssetContainerUtil;
import com.dotmarketing.portlets.containers.model.Container;
import com.dotmarketing.portlets.containers.model.FileAssetContainer;
import com.dotmarketing.portlets.contentlet.business.ContentletAPI;
import com.dotmarketing.portlets.contentlet.business.DotContentletStateException;
import com.dotmarketing.portlets.contentlet.model.Contentlet;
import com.dotmarketing.portlets.contentlet.model.ContentletVersionInfo;
import com.dotmarketing.portlets.htmlpageasset.model.IHTMLPage;
import com.dotmarketing.portlets.templates.design.bean.ContainerUUID;
import com.dotmarketing.portlets.templates.design.bean.TemplateLayout;
import com.dotmarketing.portlets.templates.model.Template;
import com.dotmarketing.util.Logger;
import com.dotmarketing.util.PageMode;
import com.dotmarketing.util.UtilMethods;
import com.google.common.collect.HashBasedTable;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.Lists;
import com.google.common.collect.Table;
import com.liferay.portal.model.User;
import com.liferay.util.StringPool;
import io.vavr.Lazy;
import io.vavr.control.Try;
import org.apache.commons.lang.StringUtils;
import java.sql.SQLException;
import java.util.Collection;
import java.util.Date;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.TreeSet;
import java.util.function.Predicate;
import java.util.stream.Collectors;
/**
* This class provides utility routines to interact with the Multi-Tree structures in the system. A
* Multi-Tree represents the relationship between a Legacy or Content Page, a container, and a
* contentlet.
* <p>
* Therefore, the content of a page can be described as the sum of several Multi-Tree records which
* represent each piece of information contained in it.
* </p>
*
* @author will
*/
public class MultiTreeAPIImpl implements MultiTreeAPI {
private final Lazy<MultiTreeCache> multiTreeCache = Lazy.of(CacheLocator::getMultiTreeCache);
private static final String DELETE_ALL_MULTI_TREE_RELATED_TO_IDENTIFIER_SQL =
"delete from multi_tree where child = ? or parent1 = ? or parent2 = ?";
private static final String DELETE_SQL = "delete from multi_tree where parent1=? and parent2=? and child=? and relation_type = ? and personalization = ? and variant_id = ?";
private static final String DELETE_SQL_PERSONALIZATION_PER_PAGE = "delete from multi_tree where parent1=? and personalization = ?";
private static final String DELETE_ALL_MULTI_TREE_SQL = "delete from multi_tree where parent1=? AND relation_type != ?";
private static final String DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION = "delete from multi_tree where parent1=? AND relation_type != ? and personalization = ? and variant_id = ?";
private static final String DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION_PER_LANGUAGE_NOT_SQL =
"delete from multi_tree where variant_id = ? and relation_type != ? and personalization = ? and multi_tree.parent1 = ? and " +
"child in (select distinct identifier from contentlet,multi_tree where multi_tree.child = contentlet.identifier and multi_tree.parent1 = ? and language_id = ?)";
private static final String SELECT_COUNT_MULTI_TREE_BY_RELATION_PERSONALIZATION_PAGE_CONTAINER_AND_CHILD =
"select count(*) cc from multi_tree where relation_type = ? and personalization = ? and " +
"multi_tree.parent1 = ? and multi_tree.parent2 = ? and multi_tree.child = ? and variant_id = ?";
private static final String DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION_PER_LANGUAGE_SQL =
"delete from multi_tree where relation_type != ? and personalization = ? and multi_tree.parent1 = ? and child in (%s)";
private static final String SELECT_MULTI_TREE_BY_LANG =
"select distinct contentlet.identifier from contentlet,multi_tree where multi_tree.child = contentlet.identifier and multi_tree.parent1 = ? and language_id = ? and variant_id = ?";
private static final String UPDATE_MULTI_TREE_PERSONALIZATION = "update multi_tree set personalization = ? where personalization = ?";
private static final String SELECT_SQL = "select * from multi_tree where parent1 = ? and parent2 = ? and child = ? and relation_type = ? and personalization = ? and variant_id = ?";
private static final String INSERT_SQL = "insert into multi_tree (parent1, parent2, child, relation_type, tree_order, personalization, variant_id) values (?,?,?,?,?,?,?) ";
private static final String SELECT_BY_PAGE = "select * from multi_tree where parent1 = ? order by tree_order";
private static final String SELECT_BY_PAGE_AND_PERSONALIZATION = "select * from multi_tree where parent1 = ? and personalization = ? and variant_id = 'DEFAULT' order by tree_order";
private static final String SELECT_UNIQUE_PERSONALIZATION = "select distinct(personalization) from multi_tree";
private static final String SELECT_BY_ONE_PARENT = "select * from multi_tree where (parent1 = ? or parent2 = ?) and variant_id = ? order by tree_order"; // search by page id or container id
private static final String SELECT_BY_TWO_PARENTS = "select * from multi_tree where parent1 = ? and parent2 = ? and variant_id = 'DEFAULT' order by tree_order";
private static final String SELECT_ALL = "select * from multi_tree ";
private static final String SELECT_BY_CHILD = "select * from multi_tree where child = ? and variant_id = 'DEFAULT' order by parent1, parent2, relation_type ";
private static final String SELECT_BY_PARENTS_AND_RELATIONS =
" select * from multi_tree where parent1 = ? and parent2 = ? and relation_type = ? and personalization = ? and variant_id = 'DEFAULT' order by tree_order";
private static final String SELECT_BY_CONTAINER_AND_STRUCTURE = "SELECT mt.* FROM multi_tree mt JOIN contentlet c "
+ " ON c.identifier = mt.child WHERE mt.parent2 = ? AND c.structure_inode = ? ";
private static final String SELECT_CONTENTLET_REFERENCES = "SELECT COUNT(*) FROM multi_tree WHERE child = ?";
private static final String SELECT_CHILD_BY_PARENT = "SELECT child FROM multi_tree WHERE multi_tree.parent1 = ? AND relation_type != ?";
private static final String SELECT_CHILD_BY_PARENT_RELATION_PERSONALIZATION_VARIANT =
SELECT_CHILD_BY_PARENT + " AND personalization = ? AND variant_id = ? ";
private static final String SELECT_CHILD_BY_PARENT_RELATION_PERSONALIZATION_VARIANT_LANGUAGE =
SELECT_CHILD_BY_PARENT_RELATION_PERSONALIZATION_VARIANT + " AND child IN (SELECT DISTINCT identifier FROM contentlet, multi_tree " +
"WHERE multi_tree.child = contentlet.identifier AND multi_tree.parent1 = ? AND language_id = ?)";
@WrapInTransaction
@Override
public void deleteMultiTree(final MultiTree mTree) throws DotDataException {
Logger.info(this, String.format("Deleting MultiTree: %s", mTree));
_dbDelete(mTree);
this.multiTreeCache.get().removeContentletReferenceCount(mTree.getContentlet());
updateHTMLPageVersionTS(mTree.getHtmlPage(), mTree.getVariantId());
refreshPageInCache(mTree.getHtmlPage(), mTree.getVariantId());
}
@WrapInTransaction
@Override
public void deleteMultiTreesRelatedToIdentifier(final String pageIdentifier) throws DotDataException {
final List<MultiTree> pagesRelatedList = getMultiTreesByPage(pageIdentifier);
new DotConnect().setSQL(DELETE_ALL_MULTI_TREE_RELATED_TO_IDENTIFIER_SQL).addParam(pageIdentifier).addParam(pageIdentifier)
.addParam(pageIdentifier).loadResult();
if (UtilMethods.isSet(pagesRelatedList)) {
for (final MultiTree multiTree : pagesRelatedList) {
this.multiTreeCache.get().removeContentletReferenceCount(multiTree.getContentlet());
updateHTMLPageVersionTS(multiTree.getHtmlPage());
refreshPageInCache(multiTree.getHtmlPage(), multiTree.getVariantId());
}
}
}
@WrapInTransaction
@Override
public void deleteMultiTree(final List<MultiTree> mTree) throws DotDataException {
for (MultiTree tree : mTree) {
deleteMultiTree(tree);
}
}
@WrapInTransaction
@Override
public void deleteMultiTreeByParent(final String pageOrContainer) throws DotDataException {
deleteMultiTree(getMultiTrees(pageOrContainer));
}
@WrapInTransaction
@Override
public void deleteMultiTreeByChild(final String contentIdentifier) throws DotDataException {
deleteMultiTree(getMultiTreesByChild(contentIdentifier));
}
/**
* Deletes multi-tree relationship given a MultiTree object. It also updates the version_ts of all
* versions of the htmlpage passed in (multiTree.parent1)
*
* @param multiTree
* @throws DotDataException
* @throws DotSecurityException
*
*/
private void _dbDelete(final MultiTree multiTree) throws DotDataException {
new DotConnect().setSQL(DELETE_SQL)
.addParam(multiTree.getHtmlPage())
.addParam(multiTree.getContainerAsID())
.addParam(multiTree.getContentlet())
.addParam(multiTree.getRelationType())
.addObject(multiTree.getPersonalization())
.addParam(multiTree.getVariantId())
.loadResult();
}
@CloseDBIfOpened
@Override
public MultiTree getMultiTree(final Identifier htmlPage, final Identifier container, final Identifier childContent,
final String containerInstance) throws DotDataException {
return getMultiTree(htmlPage.getId(), container.getId(), childContent.getId(), containerInstance);
}
@CloseDBIfOpened
@Override
public MultiTree getMultiTree(final String htmlPage, final String container, final String childContent,
final String containerInstance, final String personalization)
throws DotDataException {
return this.getMultiTree(htmlPage, container, childContent, containerInstance, personalization, VariantAPI.DEFAULT_VARIANT.name());
}
@Override
public MultiTree getMultiTree(final String htmlPage, final String container, final String childContent, final String containerInstance)
throws DotDataException {
return this.getMultiTree(htmlPage, container, childContent, containerInstance, MultiTree.DOT_PERSONALIZATION_DEFAULT, VariantAPI.DEFAULT_VARIANT.name());
}
@Override
public MultiTree getMultiTree(final String htmlPage, final String container, final String childContent,
final String containerInstance, final String personalization, final String variantId)
throws DotDataException {
final DotConnect db =
new DotConnect().setSQL(SELECT_SQL).addParam(htmlPage).addParam(container)
.addParam(childContent).addParam(containerInstance)
.addParam(personalization).addParam(variantId);
db.loadResult();
return TransformerLocator.createMultiTreeTransformer(db.loadObjectResults()).findFirst();
}
/**
* Use {@link #getMultiTree(String, String, String, String)} This method does not use the unique id
* specified in the #parseContainer code
*
* @param htmlPage
* @param container
* @param childContent
* @throws DotDataException
*/
@Override
@Deprecated
public MultiTree getMultiTree(final String htmlPage, final String container, final String childContent) throws DotDataException {
return this.getMultiTree(htmlPage, container, childContent, Container.LEGACY_RELATION_TYPE);
}
@Override
public java.util.List<MultiTree> getMultiTrees(final Identifier parent) throws DotDataException {
return getMultiTrees(parent.getId());
}
@Override
public java.util.List<MultiTree> getMultiTrees(final Identifier htmlPage, final Identifier container) throws DotDataException {
return getMultiTrees(htmlPage.getId(), container.getId());
}
@Override
public java.util.List<MultiTree> getMultiTrees(final String parentInode) throws DotDataException {
return getMultiTreesByVariant(parentInode, VariantAPI.DEFAULT_VARIANT.name());
}
@CloseDBIfOpened
public List<MultiTree> getMultiTreesByVariant(final String parentId, final String variantName) throws DotDataException {
List<MultiTree> loadObjectResults = getMultiTreeByVariantWithoutFallback(parentId, variantName);
if (!UtilMethods.isSet(loadObjectResults)) {
if (!VariantAPI.DEFAULT_VARIANT.name().equals(variantName)) {
loadObjectResults = getMultiTreeByVariantWithoutFallback(parentId, VariantAPI.DEFAULT_VARIANT.name());
}
}
return loadObjectResults;
}
private List<MultiTree> getMultiTreeByVariantWithoutFallback(final String parentId, final String variantName)
throws DotDataException {
List<Map<String, Object>> loadObjectResults = new DotConnect().setSQL(SELECT_BY_ONE_PARENT)
.addParam(parentId)
.addParam(parentId)
.addParam(variantName)
.loadObjectResults();
if (!UtilMethods.isSet(loadObjectResults)) {
if (!VariantAPI.DEFAULT_VARIANT.name().equals(variantName)) {
loadObjectResults = new DotConnect().setSQL(SELECT_BY_ONE_PARENT)
.addParam(parentId)
.addParam(parentId)
.addParam(VariantAPI.DEFAULT_VARIANT.name())
.loadObjectResults();
}
}
return TransformerLocator.createMultiTreeTransformer(loadObjectResults).asList();
}
@CloseDBIfOpened
@Override
public Set<String> getPersonalizationsForPage(final String pageID) throws DotDataException {
IHTMLPage pageId=APILocator.getHTMLPageAssetAPI().fromContentlet(APILocator.getContentletAPI().findContentletByIdentifierAnyLanguage(pageID));
return getPersonalizationsForPage(pageId);
}
@CloseDBIfOpened
@Override
public Set<String> getPersonalizationsForPage(final IHTMLPage page) throws DotDataException {
final Set<String> personas=new HashSet<>();
final Table<String, String, Set<PersonalizedContentlet>> pageContents = Try.of(()-> getPageMultiTrees(page, false)).getOrElseThrow(e->new DotRuntimeException(e));
for (final String containerId : pageContents.rowKeySet()) {
for (final String uniqueId : pageContents.row(containerId).keySet()) {
pageContents.get(containerId, uniqueId).forEach(p->personas.add(p.getPersonalization()));
}
}
return personas;
}
@CloseDBIfOpened
@Override
public Set<String> getPersonalizations () throws DotDataException {
final Set<String> personalizationSet = new HashSet<>();
final List<Map<String, Object>> personalizationMaps =
new DotConnect().setSQL(SELECT_UNIQUE_PERSONALIZATION).loadObjectResults();
for (final Map<String, Object> personalizationMap : personalizationMaps) {
personalizationSet.add(personalizationMap.values()
.stream().findFirst().orElse(StringPool.BLANK).toString());
}
return personalizationSet;
}
@WrapInTransaction
@Override
public Set<String> cleanUpUnusedPersonalization(final Predicate<String> personalizationFilter) throws DotDataException {
final Set<Params> personalizationToRemoveParamsSet = new HashSet<>();
final Set<String> personalizationToRemoveSet = new HashSet<>();
final Set<String> currentPersonalizationSet = this.getPersonalizations();
currentPersonalizationSet.stream()
.filter(personalizationFilter)
.forEach(personalization -> {
personalizationToRemoveParamsSet.add(new Params(personalization));
personalizationToRemoveSet.add(personalization);
});
if (!personalizationToRemoveParamsSet.isEmpty()) {
new DotConnect().executeBatch(
"DELETE FROM multi_tree where personalization = ?",
personalizationToRemoveParamsSet);
}
return personalizationToRemoveSet;
}
@WrapInTransaction
@Override
public List<MultiTree> copyPersonalizationForPage (final String pageId,
final String basePersonalization,
final String newPersonalization) throws DotDataException {
List<MultiTree> multiTrees = null;
final ImmutableList.Builder<MultiTree> personalizedContainerListBuilder =
new ImmutableList.Builder<>();
final List<MultiTree> basedMultiTreeList = this.getMultiTreesByPersonalizedPage(pageId, basePersonalization);
if (null != basedMultiTreeList) {
basedMultiTreeList.forEach(multiTree ->
personalizedContainerListBuilder.add(MultiTree.personalized(multiTree, newPersonalization)));
multiTrees = personalizedContainerListBuilder.build();
this.saveMultiTrees(multiTrees);
}
return multiTrees;
} // copyPersonalizationForPage.
@Override
public List<MultiTree> copyVariantForPage (final String pageId, final String baseVariant,
final String newVariant) throws DotDataException{
List<MultiTree> multiTrees = this.getMultiTreeByVariantWithoutFallback(
pageId, baseVariant);
if (UtilMethods.isSet(multiTrees)) {
multiTrees = multiTrees.stream()
.map(multiTree -> MultiTree.buildMultitreeWithVariant(multiTree, newVariant))
.collect(Collectors.toList());
this.saveMultiTrees(multiTrees);
}
return multiTrees;
}
@WrapInTransaction
@Override
public void deletePersonalizationForPage(final String pageId, final String personalization) throws DotDataException {
Logger.debug(this, "Removing personalization for: " + pageId +
", personalization: " + personalization);
final List<MultiTree> pageMultiTrees = this.getMultiTreesByPersonalizedPage(pageId, personalization);
new DotConnect().setSQL(DELETE_SQL_PERSONALIZATION_PER_PAGE)
.addParam(pageId)
.addParam(personalization)
.loadResult();
pageMultiTrees.forEach(multiTree -> this.multiTreeCache.get().removeContentletReferenceCount(multiTree.getContentlet()));
updateHTMLPageVersionTS(pageId);
refreshPageInCache(pageId, VariantAPI.DEFAULT_VARIANT.name());
} // deletePersonalizationForPage.
/**
* Returns the trees associated to a page and personalization
*
* @param pageId String page id
* @param personalization String personalization to find
* @return List of MultiTree
* @throws DotDataException
*/
@CloseDBIfOpened
@Override
public List<MultiTree> getMultiTreesByPersonalizedPage(final String pageId, final String personalization) throws DotDataException {
return TransformerLocator.createMultiTreeTransformer(
new DotConnect().setSQL(SELECT_BY_PAGE_AND_PERSONALIZATION)
.addParam(pageId).addParam(personalization).loadObjectResults())
.asList();
}
/**
* Returns the tree with the pages that matched on the parent1
*
* @param parentInode
* @return
* @throws DotDataException
*/
@CloseDBIfOpened
@Override
public List<MultiTree> getMultiTreesByPage(final String parentInode) throws DotDataException {
final DotConnect db = new DotConnect().setSQL(SELECT_BY_PAGE).addParam(parentInode);
return TransformerLocator.createMultiTreeTransformer(db.loadObjectResults()).asList();
}
@CloseDBIfOpened
@Override
public List<MultiTree> getAllMultiTrees() {
try {
final DotConnect db = new DotConnect().setSQL(SELECT_ALL);
return TransformerLocator.createMultiTreeTransformer(db.loadObjectResults()).asList();
} catch (Exception e) {
Logger.error(MultiTreeAPIImpl.class, "getMultiTree failed:" + e, e);
throw new DotRuntimeException(e);
}
}
@Override
public List<MultiTree> getMultiTrees(final String htmlPage, final String container, final String containerInstance) {
return this.getMultiTrees(htmlPage, container, containerInstance, MultiTree.DOT_PERSONALIZATION_DEFAULT);
}
@CloseDBIfOpened
@Override
public List<MultiTree> getMultiTrees(final String htmlPage, final String container,
final String containerInstance, final String personalization) {
try {
return TransformerLocator.createMultiTreeTransformer(new DotConnect().setSQL(SELECT_BY_PARENTS_AND_RELATIONS)
.addParam(htmlPage).addParam(container).addParam(containerInstance).addObject(personalization).loadObjectResults()).asList();
} catch (Exception e) {
Logger.error(MultiTreeAPIImpl.class, "getMultiTree failed:" + e, e);
throw new DotRuntimeException(e);
}
}
@Override
public List<MultiTree> getMultiTrees(final IHTMLPage htmlPage, final Container container) throws DotDataException {
return getMultiTrees(htmlPage.getIdentifier(), container.getIdentifier());
}
@CloseDBIfOpened
@Override
public List<MultiTree> getMultiTrees(final String htmlPage, final String container) throws DotDataException {
final DotConnect db = new DotConnect().setSQL(SELECT_BY_TWO_PARENTS).addParam(htmlPage).addParam(container);
return TransformerLocator.createMultiTreeTransformer(db.loadObjectResults()).asList();
}
@Override
public List<MultiTree> getMultiTrees(final IHTMLPage htmlPage, final Container container, final String containerInstance) {
return getMultiTrees(htmlPage.getIdentifier(), container.getIdentifier(), containerInstance);
}
@Override
public List<MultiTree> getContainerMultiTrees(final String containerIdentifier) throws DotDataException {
return getMultiTrees(containerIdentifier);
}
@CloseDBIfOpened
@Override
public List<MultiTree> getMultiTreesByChild(final String contentIdentifier) throws DotDataException {
final DotConnect db = new DotConnect().setSQL(SELECT_BY_CHILD).addParam(contentIdentifier);
return TransformerLocator.createMultiTreeTransformer(db.loadObjectResults()).asList();
}
/**
* Get a list of MultiTree for Contentlets using a specific Structure and specific Container
*
* @param containerIdentifier
* @param structureInode
* @return List of MultiTree
*/
@CloseDBIfOpened
@Override
public List<MultiTree> getContainerStructureMultiTree(final String containerIdentifier, final String structureInode) {
try {
final DotConnect dc =
new DotConnect().setSQL(SELECT_BY_CONTAINER_AND_STRUCTURE).addParam(containerIdentifier).addParam(structureInode);
return TransformerLocator.createMultiTreeTransformer(dc.loadObjectResults()).asList();
} catch (DotDataException e) {
Logger.error(MultiTreeAPIImpl.class, "getContainerStructureMultiTree failed:" + e, e);
throw new DotRuntimeException(e.toString());
}
}
@Override
@WrapInTransaction
public void saveMultiTree(final MultiTree mTree) throws DotDataException {
Logger.debug(this, () -> String.format("Saving MultiTree: %s", mTree));
_dbUpsert(mTree);
this.multiTreeCache.get().removeContentletReferenceCount(mTree.getContentlet());
updateHTMLPageVersionTS(mTree.getHtmlPage(), mTree.getVariantId());
refreshPageInCache(mTree.getHtmlPage(), mTree.getVariantId());
}
@Override
@WrapInTransaction
public void saveMultiTreeAndReorder(final MultiTree mTree) throws DotDataException {
Logger.debug(this, () -> String.format("Saving MultiTree and Reordering: %s", mTree));
_reorder(mTree);
updateHTMLPageVersionTS(mTree.getHtmlPage(), mTree.getVariantId());
refreshPageInCache(mTree.getHtmlPage(), mTree.getVariantId());
}
/**
* Saves a multi-tree
* <ol>
* <li>The identifier of the Content Page.</li>
* <li>The identifier of the container in the page.</li>
* <li>The identifier of the contentlet itself.</li>
* <li>The type of content relation.</li>
* <li>The order in which this construct is added to the database.</li>
* </ol>
*
* @param mTrees - The multi-tree structure.
* @throws DotDataException
*/
@Override
@WrapInTransaction
public void saveMultiTrees(final List<MultiTree> mTrees) throws DotDataException {
if (mTrees == null || mTrees.isEmpty()) {
throw new DotDataException("empty list passed in");
}
int i = 0;
for (final MultiTree tree : mTrees) {
_dbUpsert(tree.setTreeOrder(i++));
this.multiTreeCache.get().removeContentletReferenceCount(tree.getContentlet());
}
final MultiTree mTree = mTrees.get(0);
updateHTMLPageVersionTS(mTree.getHtmlPage(), mTree.getVariantId());
refreshPageInCache(mTree.getHtmlPage(), mTree.getVariantId());
}
/**
* Save a collection of {@link MultiTree} and link them with a page, Also delete all the
* {@link MultiTree} linked previously with the page.
*
* @param pageId Page's identifier
* @param multiTrees
* @throws DotDataException
*/
@Override
@WrapInTransaction
public void overridesMultitreesByPersonalization(final String pageId,
final String personalization,
final List<MultiTree> multiTrees) throws DotDataException {
this.overridesMultitreesByPersonalization(pageId, personalization, multiTrees,
Optional.empty(), VariantAPI.DEFAULT_VARIANT.name()); // no lang passed, will deletes everything
}
/**
* Save a collection of {@link MultiTree} and link them with a page, Also delete all the
* {@link MultiTree} linked previously with the page.
*
* @param pageId {@link String} Page's identifier
* @param personalization {@link String} personalization token
* @param multiTrees {@link List} of {@link MultiTree} to safe
* @param languageIdOpt {@link Optional} {@link Long} optional language, if present will deletes only the contentlets that have a version on this language.
* Since it is by identifier, when deleting for instance in spanish, will remove the english and any other lang version too.
* @throws DotDataException
*/
@Override
@WrapInTransaction
public void overridesMultitreesByPersonalization(final String pageId,
final String personalization,
final List<MultiTree> multiTrees,
final Optional<Long> languageIdOpt,
final String variantId) throws DotDataException {
Logger.info(this, String.format(
"Overriding MultiTrees: pageId -> %s personalization -> %s multiTrees-> %s ",
pageId, personalization, multiTrees));
if (multiTrees == null) {
throw new DotDataException("empty list passed in");
}
Logger.debug(MultiTreeAPIImpl.class, ()->String.format("Saving page's content: %s", multiTrees));
Set<String> originalContentletIds = new HashSet<>();
final DotConnect db = new DotConnect();
if (languageIdOpt.isPresent()) {
if (DbConnectionFactory.isMySql()) {
deleteMultiTreeToMySQL(pageId, personalization, languageIdOpt, variantId);
} else {
originalContentletIds = this.getOriginalContentlets(pageId, ContainerUUID.UUID_DEFAULT_VALUE,
personalization, variantId, languageIdOpt.get());
db.setSQL(DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION_PER_LANGUAGE_NOT_SQL)
.addParam(variantId)
.addParam(ContainerUUID.UUID_DEFAULT_VALUE)
.addParam(personalization)
.addParam(pageId)
.addParam(pageId)
.addParam(languageIdOpt.get())
.loadResult();
}
} else {
originalContentletIds = this.getOriginalContentlets(pageId, ContainerUUID.UUID_DEFAULT_VALUE,
personalization, variantId);
db.setSQL(DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION)
.addParam(pageId)
.addParam(ContainerUUID.UUID_DEFAULT_VALUE)
.addParam(personalization)
.addParam(variantId)
.loadResult();
}
if (!multiTrees.isEmpty()) {
copyMultiTree(pageId, multiTrees);
}
this.refreshContentletReferenceCount(originalContentletIds, multiTrees);
updateHTMLPageVersionTS(pageId, variantId);
refreshPageInCache(pageId, variantId);
}
public void copyMultiTree(final String pageId, final List<MultiTree> multiTrees) throws DotDataException {
copyMultiTree(pageId, multiTrees, null);
}
/**
* Copy a collection of {@link MultiTree} but to a different {@link Variant}.
*
* @param pageId {@link String} Page's identifier
* @param multiTrees {@link List} of {@link MultiTree} to copy
* @param variantName {@link String} name of the variant to copy to
* @throws DotDataException
*/
@Override
@WrapInTransaction
public void copyMultiTree(final String pageId, final List<MultiTree> multiTrees,
final String variantName) throws DotDataException {
DotPreconditions.notNull(multiTrees, () -> "multiTrees can't be null");
final DotConnect db = new DotConnect();
final List<Params> insertParams = Lists.newArrayList();
for (final MultiTree tree : multiTrees) {
final String copiedMultiTreeVariantId =
UtilMethods.isSet(variantName) ? variantName : tree.getVariantId();
//This is for checking if the content we are trying to add is already added into the container
db.setSQL(SELECT_COUNT_MULTI_TREE_BY_RELATION_PERSONALIZATION_PAGE_CONTAINER_AND_CHILD)
.addParam(tree.getRelationType())
.addParam(tree.getPersonalization())
.addParam(pageId)
.addParam(tree.getContainerAsID())
.addParam(tree.getContentlet())
.addParam(copiedMultiTreeVariantId);
final int contentExist = Integer.parseInt(db.loadObjectResults().get(0).get("cc").toString());
if(contentExist != 0){
final String contentletTitle = APILocator.getContentletAPI().findContentletByIdentifierAnyLanguage(tree.getContentlet()).getTitle();
final String errorMsg = String.format("Content '%s' [ %s ] has already been added to Container " +
"'%s'", contentletTitle, tree.getContentlet(),
tree.getContainer());
Logger.debug(MultiTreeAPIImpl.class, errorMsg);
throw new IllegalArgumentException(errorMsg);
}
insertParams
.add(new Params(pageId, tree.getContainerAsID(), tree.getContentlet(),
tree.getRelationType(), tree.getTreeOrder(), tree.getPersonalization(),
copiedMultiTreeVariantId));
}
db.executeBatch(INSERT_SQL, insertParams);
}
@Override
public void overridesMultitreesByPersonalization(String pageId,
String personalization, List<MultiTree> multiTrees,
Optional<Long> languageIdOpt) throws DotDataException {
overridesMultitreesByPersonalization(pageId, personalization, multiTrees,
languageIdOpt, VariantAPI.DEFAULT_VARIANT.name());
}
private void deleteMultiTreeToMySQL(
final String pageId,
final String personalization,
final Optional<Long> languageIdOpt, final String variantId) throws DotDataException {
final DotConnect db = new DotConnect();
final List<String> multiTreesId = db.setSQL(SELECT_MULTI_TREE_BY_LANG)
.addParam(pageId)
.addParam(languageIdOpt.get())
.addParam(variantId)
.loadObjectResults()
.stream()
.map(map -> String.format("'%s'", map.get("identifier")))
.collect(Collectors.toList());
if (!multiTreesId.isEmpty()) {
db.setSQL(String.format(DELETE_ALL_MULTI_TREE_SQL_BY_RELATION_AND_PERSONALIZATION_PER_LANGUAGE_SQL, Utility.joinList(",", multiTreesId)))
.addParam(ContainerUUID.UUID_DEFAULT_VALUE)
.addParam(personalization)
.addParam(pageId)
.loadResult();
}
}
@Override
@WrapInTransaction
public void updatePersonalization(final String currentPersonalization, final String newPersonalization) throws DotDataException {
Logger.info(this, "Updating the personalization: " + currentPersonalization +
" to " + newPersonalization);
final List<Map<String, Object>> currentPersonalizationPages =
new DotConnect().setSQL("select parent1 from multi_tree where personalization = ?")
.addObject(currentPersonalization).loadObjectResults();
new DotConnect().setSQL(UPDATE_MULTI_TREE_PERSONALIZATION)
.addParam(newPersonalization)
.addParam(currentPersonalization).loadResult();
if (UtilMethods.isSet(currentPersonalizationPages)) {
Logger.info(this, "The personalization: " + currentPersonalization + ", has been changed to : " + newPersonalization +
" all related pages multitrees will be invalidated: " + currentPersonalizationPages.size());
for (final Map<String, Object> pageMap : currentPersonalizationPages) {
final String pageId = (String) pageMap.get("parent1");
Logger.info(this, "Invalidating the multitrees for the page: " + pageId);
CacheLocator.getMultiTreeCache()
.removePageMultiTrees(pageId, VariantAPI.DEFAULT_VARIANT.name());
}
}
}
/**
* Saves a collection of {@link MultiTree} objects and links them to an HTML Page. It deletes all the
* {@link MultiTree} previously linked with the page before adding the new data.
*
* @param pageId The Page's identifier.
* @param mTrees The list of {@link MultiTree} objects that make up the HTML Page contents.
*
* @throws DotDataException The list of MultiTree entries is null.
*/
@Override
@WrapInTransaction
public void saveMultiTrees(final String pageId, final List<MultiTree> mTrees) throws DotDataException {
Logger.debug(this, () -> String
.format("Saving MultiTrees: pageId -> %s multiTrees-> %s", pageId, mTrees));
if (mTrees == null) {
throw new DotDataException(String.format("MultiTree list for page ID '%s' cannot be null", pageId));
}
Logger.debug(MultiTreeAPIImpl.class, ()->String.format("Saving page's content: %s", mTrees));
final Set<String> originalContents = this.getOriginalContentlets(pageId, ContainerUUID.UUID_DEFAULT_VALUE);
final DotConnect db = new DotConnect();
db.setSQL(DELETE_ALL_MULTI_TREE_SQL).addParam(pageId).addParam(ContainerUUID.UUID_DEFAULT_VALUE).loadResult();
final Set<String> variants = new TreeSet();
if (!mTrees.isEmpty()) {
final List<Params> insertParams = Lists.newArrayList();
for (final MultiTree tree : mTrees) {
insertParams
.add(new Params(pageId, tree.getContainerAsID(), tree.getContentlet(),
tree.getRelationType(), tree.getTreeOrder(), tree.getPersonalization(), tree.getVariantId()));
variants.add(tree.getVariantId());
}
db.executeBatch(INSERT_SQL, insertParams);
}
this.refreshContentletReferenceCount(originalContents, mTrees);
for (String variantId : variants) {
updateHTMLPageVersionTS(pageId, variantId);
refreshPageInCache(pageId,variantId );
}
if (!variants.contains(VariantAPI.DEFAULT_VARIANT.name())) {
updateHTMLPageVersionTS(pageId, VariantAPI.DEFAULT_VARIANT.name());
refreshPageInCache(pageId, VariantAPI.DEFAULT_VARIANT.name() );
}
}
@Override
public List<String> getContainersId(final String pageId) throws DotDataException {
return this.getMultiTrees(pageId).stream().map(multiTree -> multiTree.getContainer()).distinct().sorted()
.collect(Collectors.toList());
}
private void _dbUpsert(final MultiTree mtree) throws DotDataException {
_dbDelete(mtree);
_dbInsert(mtree);
}
private void _reorder(final MultiTree treeInput) throws DotDataException {
final MultiTree tree = this.checkPersonalization(treeInput);
List<MultiTree> trees = getMultiTrees(tree.getHtmlPage(), tree.getContainerAsID(), tree.getRelationType(), tree.getPersonalization());
trees = trees.stream().filter(rowTree -> !rowTree.equals(tree)).collect(Collectors.toList());
int maxOrder = (tree.getTreeOrder() > trees.size()) ? trees.size() : tree.getTreeOrder();
trees.add(maxOrder, tree);
saveMultiTrees(trees);
}
private MultiTree checkPersonalization(final MultiTree tree) {
return null != tree && null != tree.getPersonalization()?
tree: MultiTree.personalized(tree, MultiTree.DOT_PERSONALIZATION_DEFAULT);
}
private void _dbInsert(final MultiTree multiTree) throws DotDataException {
Logger.debug(this, () -> String.format("_dbInsert -> Saving MultiTree: %s", multiTree));
new DotConnect().setSQL(INSERT_SQL).addParam(multiTree.getHtmlPage()).addParam(multiTree.getContainerAsID()).addParam(multiTree.getContentlet())
.addParam(multiTree.getRelationType()).addParam(multiTree.getTreeOrder()).addObject(multiTree.getPersonalization()).addParam(multiTree.getVariantId()).loadResult();
}
/**
* Update the version_ts of all versions of the HTML Page with the given id. If a MultiTree Object
* has been added or deleted from this page, its version_ts value needs to be updated so it can be
* included in future Push Publishing tasks
*
* @param pageId The HTMLPage Identifier to pass in
* @throws DotContentletStateException
* @throws DotDataException
* @throws DotSecurityException
*
*/
private void updateHTMLPageVersionTS(final String pageId, final String variantName) throws DotDataException {
final List<ContentletVersionInfo> contentletVersionInfos =
APILocator.getVersionableAPI().findContentletVersionInfos(pageId, variantName);
for (final ContentletVersionInfo versionInfo : contentletVersionInfos) {
if (versionInfo != null) {
versionInfo.setVersionTs(new Date());
APILocator.getVersionableAPI().saveContentletVersionInfo(versionInfo);
}
}
}
private void updateHTMLPageVersionTS(final String pageId) throws DotDataException {
final List<Variant> variants = APILocator.getVariantAPI().getVariants();
for (Variant variant : variants) {
updateHTMLPageVersionTS(pageId, variant.name());
}
}
private void refreshPageInCache(final String pageIdentifier, final String variantName) throws DotDataException {
CacheLocator.getMultiTreeCache()
.removePageMultiTrees(pageIdentifier, variantName);
final Collection<String> inodeSet = getInodes(pageIdentifier, variantName);
try {
final List<Contentlet> contentlets = APILocator.getContentletAPIImpl()
.findContentlets(Lists.newArrayList(inodeSet));
final PageLoader pageLoader = new PageLoader();
for (final Contentlet pageContent : contentlets) {
final IHTMLPage htmlPage = APILocator.getHTMLPageAssetAPI().fromContentlet(pageContent);
pageLoader.invalidate(htmlPage, variantName, PageMode.EDIT_MODE);
pageLoader.invalidate(htmlPage, variantName, PageMode.PREVIEW_MODE);
}
} catch (DotStateException | DotSecurityException e) {
Logger.warn(MultiTreeAPIImpl.class, "unable to refresh page cache:" + e.getMessage());
}
}
private Collection<String> getInodes(String pageIdentifier, String variantName)
throws DotDataException {
final List<ContentletVersionInfo> contentletVersionInfos = APILocator.getVersionableAPI()
.findContentletVersionInfos(pageIdentifier, variantName);
if (UtilMethods.isSet(contentletVersionInfos)) {
return getInodes(contentletVersionInfos);
} else {
return getInodes(APILocator.getVersionableAPI()
.findContentletVersionInfos(pageIdentifier, VariantAPI.DEFAULT_VARIANT.name()));
}
}
private Collection<String> getInodes(final List<ContentletVersionInfo> contentletVersionInfos) {
final Set<String> inodeSet = new HashSet<>();
for (final ContentletVersionInfo versionInfo : contentletVersionInfos) {
inodeSet.add(versionInfo.getWorkingInode());
if (versionInfo.getLiveInode() != null) {
inodeSet.add(versionInfo.getLiveInode());
}
}
return inodeSet;
}
@WrapInTransaction
@Override
public void deleteMultiTreeByIdentifier(final Identifier identifier) throws DotDataException {
final List<MultiTree> multiTrees = this.getMultiTrees(identifier);
if (UtilMethods.isSet(multiTrees)) {
for (final MultiTree multiTree : multiTrees) {
this.deleteMultiTree(multiTree);
}
}
}
@WrapInTransaction
@Override
public void deleteMultiTreesForIdentifiers(final List<String> identifiers) throws DotDataException {
if (UtilMethods.isSet(identifiers)) {
try {
final String sInodeIds = StringUtils.join(identifiers, StringPool.COMMA);
new DotConnect().executeStatement("delete from multi_tree where child in (" + sInodeIds + ") or parent1 in (" + sInodeIds
+ ") or parent2 in (" + sInodeIds + ")");
identifiers.forEach(contentletId -> this.multiTreeCache.get().removeContentletReferenceCount(contentletId));
} catch (final SQLException e) {
throw new DotDataException(e);
}
}
}
@Override
public Table<String, String, Set<PersonalizedContentlet>> getPageMultiTrees(final IHTMLPage page, final boolean liveMode)
throws DotDataException, DotSecurityException {