CampaignXmlSerializer.java
19.2 KB
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
/*
* Decompiled with CFR 0_118.
*
* Could not load the following classes:
* org.apache.commons.collections.MultiMap
* org.apache.commons.collections.map.MultiValueMap
* org.apache.commons.lang.StringUtils
*/
package com.day.cq.analytics.testandtarget.impl.serializer;
import com.day.cq.analytics.testandtarget.impl.TestandTargetCampaignType;
import com.day.cq.analytics.testandtarget.impl.TestandtargetCampaign;
import com.day.cq.analytics.testandtarget.impl.TestandtargetSegment;
import com.day.cq.analytics.testandtarget.impl.model.TestandtargetExperience;
import com.day.cq.analytics.testandtarget.impl.model.TestandtargetOffer;
import com.day.cq.analytics.testandtarget.impl.serializer.AbstractSerializer;
import java.io.StringWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerFactoryConfigurationError;
import javax.xml.transform.sax.SAXTransformerFactory;
import javax.xml.transform.sax.TransformerHandler;
import javax.xml.transform.stream.StreamResult;
import org.apache.commons.collections.MultiMap;
import org.apache.commons.collections.map.MultiValueMap;
import org.apache.commons.lang.StringUtils;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.AttributesImpl;
public class CampaignXmlSerializer
extends AbstractSerializer<TestandtargetCampaign> {
private static final String TARGET_PARAMETER_TYPE_PROFILE = "profile";
private static final char TARGET_MULTIVALUE_SEPARATOR = '|';
private static final String TARGET_OPERATOR_CONTAINS_IGNORE_CASE = "containsIgnoreCase";
private static final String CONVERSION_ACTION_NAME = "restartRandomExperience";
private static final int BRANCH_NAME_MAX_SIZE = 20;
private static final String HTML_CAMPAIGN_FORMAT = "<script type=\"text/javascript\">CQ_Analytics.TestTarget.pull('%s','${mbox.name}','1.0.0');</script>";
private static final String DEFAULT_HTML_OFFER = "<script type=\"text/javascript\">CQ_Analytics.TestTarget.signalDefaultOffer('${mbox.name}');</script>";
private static final String XML_TAG_CAMPAIGN = "campaign";
private static final String XML_TAG_ALGORITHM = "algorithm";
private static final String XML_TAG_NAME = "name";
private static final String XML_TAG_START = "start";
private static final String XML_TAG_END = "end";
private static final String XML_TAG_BRANCHES = "branches";
private static final String XML_TAG_BRANCH = "branch";
private static final String XML_TAG_PERCENT_CONSTRAINT = "percentConstraint";
private static final String XML_TAG_PERCENT = "percent";
private static final String XML_TAG_PARAM_CONSTRAINTS = "paramConstraints";
private static final String XML_TAG_PARAM_CONSTRAINT = "paramConstraint";
private static final String XML_TAG_PARAMETER_TYPE = "parameterType";
private static final String XML_TAG_MATCHER_TYPE = "matcherType";
private static final String XML_TAG_VALUES = "values";
private static final String XML_TAG_STRING = "string";
private static final String XML_TAG_OFFER = "offer";
private static final String XML_TAG_OFFERS = "offers";
private static final String XML_TAG_DISPLAY = "display";
private static final String XML_TAG_DISPLAYS = "displays";
private static final String XML_TAG_MBOX = "mbox";
private static final String XML_TAG_MBOXES = "mboxes";
private static final String XML_TAG_LOCATION = "location";
private static final String XML_TAG_LOCATIONS = "locations";
private static final String XML_TAG_TYPE = "type";
private static final String XML_TAG_STEP = "step";
private static final String XML_TAG_STEPS = "steps";
private static final String XML_TAG_CONTENT = "content";
private static final String XML_TAG_REUSABLE_SEGMENTS = "reusableSegments";
private static final String XML_TAG_REUSABLE_SEGMENT = "reusableSegment";
private static final String XML_TAG_CONVERSION_ACTION = "action";
private static final String XML_TAG_MAC_METADATA = "marketingCloudMetadata";
private static final String XML_TAG_MAC_SOURCE_PRODUCT = "sourceProductName";
private static final String XML_TAG_MAC_CAMPAIGN_URL = "editURL";
private static final String XML_TAG_MAC_REMOTE_MODIFIED_BY = "remoteModifiedBy";
public static final String PROFILE_PARAMETER_RESOLVED_SEGMENTS = "_cq_.resolvedSegments";
public static final String OFFER_NAME_DEFAULT_CONTENT = "Default AEM offer";
@Override
public String serialize(TestandtargetCampaign campaign) {
try {
String algorithm;
SAXTransformerFactory f = (SAXTransformerFactory)SAXTransformerFactory.newInstance();
StringWriter sw = new StringWriter();
StreamResult sr = new StreamResult(sw);
TransformerHandler handler = f.newTransformerHandler();
Transformer t = handler.getTransformer();
t.setOutputProperty("omit-xml-declaration", "yes");
MultiValueMap mboxNameToExperience = MultiValueMap.decorate(new LinkedHashMap(), LinkedHashSet.class);
for (TestandtargetExperience experience : campaign.getExperiences()) {
for (TestandtargetOffer offer : experience.getOffers()) {
mboxNameToExperience.put((Object)offer.getLocationName(), (Object)experience);
}
}
ArrayList<String> allExperienceNames = new ArrayList<String>(campaign.getExperiences().size());
for (TestandtargetExperience experience2 : campaign.getExperiences()) {
allExperienceNames.add(experience2.getInternalName());
}
handler.setResult(sr);
handler.startDocument();
this.startElement(handler, "campaign");
String string = algorithm = campaign.getCampaignType() != null ? campaign.getCampaignType().getTestAndTargetAlgorithm() : null;
if (algorithm != null) {
this.startElement(handler, "algorithm");
this.writeTag(handler, "type", algorithm);
this.endElement(handler, "algorithm");
}
this.writeTag(handler, "name", campaign.getName());
this.writeTag(handler, "start", campaign.getStart());
this.writeTag(handler, "end", campaign.getEnd());
this.startElement(handler, "marketingCloudMetadata");
this.writeTag(handler, "sourceProductName", campaign.getSourceProductName());
this.writeTag(handler, "editURL", campaign.getEditUrl());
this.writeTag(handler, "remoteModifiedBy", campaign.getRemoteModifiedBy());
this.endElement(handler, "marketingCloudMetadata");
this.writeBranches(handler, campaign);
this.startElement(handler, "steps");
this.writeMboxes(handler);
this.writeOffers(handler, (MultiMap)mboxNameToExperience, allExperienceNames);
this.writeConversionStep(handler, campaign);
this.endElement(handler, "steps");
this.endElement(handler, "campaign");
handler.endDocument();
return sw.toString();
}
catch (TransformerConfigurationException e) {
throw new RuntimeException(e);
}
catch (TransformerFactoryConfigurationError e) {
throw new RuntimeException(e);
}
catch (SAXException e) {
throw new RuntimeException(e);
}
}
@Override
public TestandtargetCampaign deserialize(String json, Class<TestandtargetCampaign> clazz) {
return null;
}
private void writeOffers(TransformerHandler handler, MultiMap mboxNameToExperience, List<String> allExperienceNames) throws SAXException {
if (mboxNameToExperience.isEmpty()) {
return;
}
this.startElement(handler, "step");
this.writeTag(handler, "type", "display");
this.startElement(handler, "locations");
for (Object mboxNameEntryAsObject : mboxNameToExperience.entrySet()) {
Map.Entry mboxNameEntry = (Map.Entry)mboxNameEntryAsObject;
String mboxName = (String)mboxNameEntry.getKey();
Collection mboxExperiences = (Collection)mboxNameEntry.getValue();
this.startElement(handler, "location");
this.startElement(handler, "mboxes");
this.startElement(handler, "mbox");
this.writeTag(handler, "name", mboxName);
this.endElement(handler, "mbox");
this.endElement(handler, "mboxes");
this.startElement(handler, "displays");
HashMap<String, TestandtargetExperience> experiencesByName = new HashMap<String, TestandtargetExperience>();
for (Object experienceAsObject : mboxExperiences) {
TestandtargetExperience experience = (TestandtargetExperience)experienceAsObject;
experiencesByName.put(experience.getInternalName(), experience);
}
ArrayList<TestandtargetExperience> allExperiences = new ArrayList<TestandtargetExperience>();
for (String experienceName : allExperienceNames) {
TestandtargetExperience experience = (TestandtargetExperience)experiencesByName.get(experienceName);
if (experience == null) {
experience = TestandtargetExperience.newSegmentBasedExperience(experienceName, new TestandtargetSegment[0]);
experience.addOffer(new TestandtargetOffer("Default AEM offer", mboxName, "", true));
}
allExperiences.add(experience);
}
for (TestandtargetExperience experience : allExperiences) {
this.startElement(handler, "display");
this.writeTag(handler, "branch", experience.getName());
this.startElement(handler, "offers");
for (TestandtargetOffer offer : experience.getOffers()) {
if (!mboxName.equals(offer.getLocationName())) continue;
if (offer.isDefault() && offer.isNeedsCreating()) {
this.startElement(handler, "offer", "type", "html");
this.writeTag(handler, "name", "Default AEM offer");
this.writeCdataTag(handler, "content", "<script type=\"text/javascript\">CQ_Analytics.TestTarget.signalDefaultOffer('${mbox.name}');</script>");
} else if (offer.isNeedsCreating()) {
this.startElement(handler, "offer", "type", "html");
this.writeTag(handler, "name", offer.getName());
this.writeCdataTag(handler, "content", this.toHtmlOfferString(offer.getContentDeliveryPath()));
} else {
this.startElement(handler, "offer");
this.writeTag(handler, "name", offer.getName());
}
this.endElement(handler, "offer");
}
this.endElement(handler, "offers");
this.endElement(handler, "display");
}
this.endElement(handler, "displays");
this.endElement(handler, "location");
}
this.endElement(handler, "locations");
this.endElement(handler, "step");
}
private String toHtmlOfferString(String contentPath) {
return String.format("<script type=\"text/javascript\">CQ_Analytics.TestTarget.pull('%s','${mbox.name}','1.0.0');</script>", contentPath);
}
private void writeMboxes(TransformerHandler handler) throws SAXException {
this.startElement(handler, "step");
this.writeTag(handler, "type", "entry");
this.startElement(handler, "locations");
this.startElement(handler, "location");
this.startElement(handler, "mboxes");
this.startElement(handler, "mbox");
this.writeTag(handler, "name", "** display mboxes **");
this.endElement(handler, "mbox");
this.endElement(handler, "mboxes");
this.endElement(handler, "location");
this.endElement(handler, "locations");
this.endElement(handler, "step");
}
private void writeBranches(TransformerHandler handler, TestandtargetCampaign campaign) throws SAXException {
if (campaign.getExperiences().isEmpty()) {
return;
}
this.startElement(handler, "branches");
for (TestandtargetExperience experience : campaign.getExperiences()) {
this.startElement(handler, "branch");
this.writeTag(handler, "name", experience.getName());
if (experience.getPercentageConstraint() != null) {
this.startElement(handler, "percentConstraint");
this.writeTag(handler, "percent", experience.getPercentageConstraint().toString());
this.endElement(handler, "percentConstraint");
} else {
List<TestandtargetSegment> explicitSegments = experience.getSegment(TestandtargetSegment.Kind.VALUE);
List<TestandtargetSegment> referenceSegments = experience.getSegment(TestandtargetSegment.Kind.REFERENCE);
List<TestandtargetSegment> byPathSegments = experience.getSegment(TestandtargetSegment.Kind.BY_PATH);
if (!explicitSegments.isEmpty() || !byPathSegments.isEmpty()) {
this.startElement(handler, "paramConstraints");
for (TestandtargetSegment segment2 : explicitSegments) {
this.startElement(handler, "paramConstraint");
this.writeTag(handler, "parameterType", "profile");
this.writeTag(handler, "name", segment2.getName().replace('/', '.'));
this.writeTag(handler, "matcherType", segment2.getOperator());
this.startElement(handler, "values");
for (String value : segment2.getValues()) {
this.writeTag(handler, "string", value);
}
this.endElement(handler, "values");
this.endElement(handler, "paramConstraint");
}
for (TestandtargetSegment segment2 : byPathSegments) {
if (segment2.getValues().size() != 1) {
throw new IllegalArgumentException("By-path segment does not have exactly one value : " + segment2.getValues());
}
this.startElement(handler, "paramConstraint");
this.writeTag(handler, "parameterType", "profile");
this.writeTag(handler, "name", "_cq_.resolvedSegments");
this.writeTag(handler, "matcherType", "containsIgnoreCase");
this.startElement(handler, "values");
this.writeTag(handler, "string", "" + '|' + segment2.getValues().get(0) + '|');
this.endElement(handler, "values");
this.endElement(handler, "paramConstraint");
}
this.endElement(handler, "paramConstraints");
}
if (!referenceSegments.isEmpty()) {
this.startElement(handler, "reusableSegments");
for (TestandtargetSegment segment2 : referenceSegments) {
this.writeTag(handler, "reusableSegment", segment2.getName());
}
this.endElement(handler, "reusableSegments");
}
}
this.endElement(handler, "branch");
}
this.endElement(handler, "branches");
}
private void writeConversionStep(TransformerHandler handler, TestandtargetCampaign campaign) throws SAXException {
this.startElement(handler, "step");
this.writeTag(handler, "name", "Conversion on click");
this.writeTag(handler, "type", "conversion");
if (campaign.isForceLandingPageCampaign()) {
HashMap<String, String> conversionActionAttrs = new HashMap<String, String>();
conversionActionAttrs.put("type", "restartRandomExperience");
this.writeTagWithAttributes(handler, "action", conversionActionAttrs);
this.startElement(handler, "locations");
this.startElement(handler, "location");
this.startElement(handler, "mboxes");
for (String location : campaign.getAllMboxLocations()) {
this.startElement(handler, "mbox");
this.writeTag(handler, "name", location);
this.endElement(handler, "mbox");
}
this.endElement(handler, "mboxes");
this.endElement(handler, "location");
this.endElement(handler, "locations");
} else {
this.startElement(handler, "locations");
this.startElement(handler, "location");
this.startElement(handler, "mboxes");
this.startElement(handler, "mbox");
this.writeTag(handler, "name", StringUtils.isBlank((String)campaign.getConversionGoal()) ? "** click from display mbox **" : campaign.getConversionGoal());
this.endElement(handler, "mbox");
this.endElement(handler, "mboxes");
this.endElement(handler, "location");
this.endElement(handler, "locations");
}
this.endElement(handler, "step");
}
private void writeTag(TransformerHandler handler, String tagName, String tagValue) throws SAXException {
handler.startElement("", tagName, tagName, null);
handler.characters(tagValue.toCharArray(), 0, tagValue.length());
handler.endElement("", tagName, tagName);
}
private void writeTagWithAttributes(TransformerHandler handler, String tagName, Map<String, String> attrs) throws SAXException {
AttributesImpl xmlAttrs = new AttributesImpl();
for (String attrName : attrs.keySet()) {
xmlAttrs.addAttribute("", attrName, attrName, null, attrs.get(attrName));
}
handler.startElement("", tagName, tagName, xmlAttrs);
handler.endElement("", tagName, tagName);
}
private void writeCdataTag(TransformerHandler handler, String tagName, String tagValue) throws SAXException {
handler.startElement("", tagName, tagName, null);
handler.startCDATA();
handler.characters(tagValue.toCharArray(), 0, tagValue.length());
handler.endCDATA();
handler.endElement("", tagName, tagName);
}
private void startElement(TransformerHandler handler, String tagName) throws SAXException {
handler.startElement("", tagName, tagName, null);
}
private void startElement(TransformerHandler handler, String tagName, String propertyName, String propertyValue) throws SAXException {
AttributesImpl attr = new AttributesImpl();
attr.addAttribute("", propertyName, propertyName, null, propertyValue);
handler.startElement("", tagName, tagName, attr);
}
private void endElement(TransformerHandler handler, String tagName) throws SAXException {
handler.endElement("", tagName, tagName);
}
}