001
014
015 package com.liferay.portlet.social.util;
016
017 import com.liferay.portal.kernel.log.Log;
018 import com.liferay.portal.kernel.log.LogFactoryUtil;
019 import com.liferay.portal.kernel.util.GetterUtil;
020 import com.liferay.portal.kernel.util.ListUtil;
021 import com.liferay.portal.kernel.util.ProxyFactory;
022 import com.liferay.portal.kernel.util.Tuple;
023 import com.liferay.portal.kernel.util.Validator;
024 import com.liferay.portal.kernel.xml.Document;
025 import com.liferay.portal.kernel.xml.DocumentException;
026 import com.liferay.portal.kernel.xml.DocumentType;
027 import com.liferay.portal.kernel.xml.Element;
028 import com.liferay.portal.kernel.xml.UnsecureSAXReaderUtil;
029 import com.liferay.portal.util.JavaFieldsParser;
030 import com.liferay.portlet.social.model.SocialAchievement;
031 import com.liferay.portlet.social.model.SocialActivityCounterConstants;
032 import com.liferay.portlet.social.model.SocialActivityCounterDefinition;
033 import com.liferay.portlet.social.model.SocialActivityDefinition;
034 import com.liferay.portlet.social.model.SocialActivityProcessor;
035
036 import java.util.ArrayList;
037 import java.util.Collections;
038 import java.util.HashMap;
039 import java.util.LinkedHashSet;
040 import java.util.List;
041 import java.util.Map;
042 import java.util.Set;
043
044
047 public class SocialConfigurationImpl implements SocialConfiguration {
048
049 @Override
050 public List<String> getActivityCounterNames() {
051 return getActivityCounterNames(
052 SocialActivityCounterConstants.TYPE_ALL, false);
053 }
054
055 @Override
056 public List<String> getActivityCounterNames(boolean transientCounter) {
057 return getActivityCounterNames(
058 SocialActivityCounterConstants.TYPE_ALL, transientCounter);
059 }
060
061 @Override
062 public List<String> getActivityCounterNames(int ownerType) {
063 return getActivityCounterNames(ownerType, false);
064 }
065
066 @Override
067 public List<String> getActivityCounterNames(
068 int ownerType, boolean transientCounter) {
069
070 Set<String> activityCounterNames = new LinkedHashSet<>();
071
072 for (Map<Integer, SocialActivityDefinition> activityDefinitions :
073 _activityDefinitions.values()) {
074
075 for (SocialActivityDefinition activityDefinition :
076 activityDefinitions.values()) {
077
078 for (SocialActivityCounterDefinition activityCounterDefinition :
079 activityDefinition.getActivityCounterDefinitions()) {
080
081 if ((activityCounterDefinition.isTransient() ==
082 transientCounter) &&
083 ((ownerType ==
084 SocialActivityCounterConstants.TYPE_ALL) ||
085 (ownerType ==
086 activityCounterDefinition.getOwnerType()))) {
087
088 activityCounterNames.add(
089 activityCounterDefinition.getName());
090 }
091 }
092 }
093 }
094
095 return new ArrayList<>(activityCounterNames);
096 }
097
098 @Override
099 public SocialActivityDefinition getActivityDefinition(
100 String modelName, int activityType) {
101
102 Map<Integer, SocialActivityDefinition> activityDefinitions =
103 _activityDefinitions.get(modelName);
104
105 if (activityDefinitions == null) {
106 return null;
107 }
108
109 return activityDefinitions.get(activityType);
110 }
111
112 @Override
113 public List<SocialActivityDefinition> getActivityDefinitions(
114 String modelName) {
115
116 Map<Integer, SocialActivityDefinition> activityDefinitions =
117 _activityDefinitions.get(modelName);
118
119 if (activityDefinitions == null) {
120 return Collections.emptyList();
121 }
122
123 return ListUtil.fromCollection(activityDefinitions.values());
124 }
125
126 @Override
127 public String[] getActivityModelNames() {
128 Set<String> activityModelNames = _activityDefinitions.keySet();
129
130 return activityModelNames.toArray(
131 new String[activityModelNames.size()]);
132 }
133
134 @Override
135 public List<Object> read(ClassLoader classLoader, String[] xmls)
136 throws Exception {
137
138 List<Object> objects = new ArrayList<>();
139
140 for (String xml : xmls) {
141 _read(classLoader, xml, objects);
142 }
143
144 return objects;
145 }
146
147 @Override
148 public void removeActivityDefinition(
149 SocialActivityDefinition activityDefinition) {
150
151 Map<Integer, SocialActivityDefinition> activityDefinitions =
152 _activityDefinitions.get(activityDefinition.getModelName());
153
154 if (activityDefinitions != null) {
155 activityDefinitions.remove(activityDefinition.getActivityType());
156 }
157 }
158
159 private void _read(
160 ClassLoader classLoader, String xml, List<Object> objects)
161 throws Exception {
162
163 if (xml == null) {
164 return;
165 }
166
167 xml = JavaFieldsParser.parse(classLoader, xml);
168
169 Document document = UnsecureSAXReaderUtil.read(xml);
170
171 DocumentType documentType = document.getDocumentType();
172
173 String publicId = documentType.getPublicId();
174
175 if (!publicId.equals("-
176 !publicId.equals("-
177 !publicId.equals("-
178
179 throw new DocumentException(
180 "Unsupported document type " + publicId);
181 }
182
183 Element rootElement = document.getRootElement();
184
185 List<Element> activityElements = rootElement.elements("activity");
186
187 for (Element activityElement : activityElements) {
188 _readActivity(classLoader, objects, activityElement);
189 }
190 }
191
192 private void _readAchievement(
193 ClassLoader classLoader, List<Object> objects,
194 SocialActivityDefinition activityDefinition,
195 Element achievementElement)
196 throws Exception {
197
198 String achievementClassName = GetterUtil.getString(
199 achievementElement.elementText("achievement-class"));
200
201 SocialAchievement achievement =
202 (SocialAchievement)ProxyFactory.newInstance(
203 classLoader, SocialAchievement.class, achievementClassName);
204
205 String name = GetterUtil.getString(
206 achievementElement.elementText("name"));
207
208 achievement.setName(name);
209
210 String icon = GetterUtil.getString(
211 achievementElement.elementText("icon"));
212
213 achievement.setIcon(icon);
214
215 List<Element> propertyElements = achievementElement.elements(
216 "property");
217
218 for (Element propertyElement : propertyElements) {
219 _readAchievementProperty(achievement, propertyElement);
220 }
221
222 achievement.initialize(activityDefinition);
223
224 List<SocialAchievement> achievements =
225 activityDefinition.getAchievements();
226
227 achievements.add(achievement);
228
229 Tuple tuple = new Tuple(activityDefinition, achievement);
230
231 objects.add(tuple);
232 }
233
234 private void _readAchievementProperty(
235 SocialAchievement achievement, Element propertyElement) {
236
237 String name = GetterUtil.getString(propertyElement.elementText("name"));
238 String value = GetterUtil.getString(
239 propertyElement.elementText("value"));
240
241 achievement.setProperty(name, value);
242 }
243
244 private void _readActivity(
245 ClassLoader classLoader, Element activityElement,
246 SocialActivityDefinition activityDefinition)
247 throws Exception {
248
249 boolean logActivity = GetterUtil.getBoolean(
250 activityElement.elementText("log-activity"));
251
252 activityDefinition.setLogActivity(logActivity);
253
254 boolean countersEnabled = GetterUtil.getBoolean(
255 activityElement.elementText("counters-enabled"), true);
256
257 activityDefinition.setCountersEnabled(countersEnabled);
258
259 if (!countersEnabled) {
260 return;
261 }
262
263 String languageKey = GetterUtil.getString(
264 activityElement.elementText("language-key"));
265
266 activityDefinition.setLanguageKey(languageKey);
267
268 String processorClassName = GetterUtil.getString(
269 activityElement.elementText("processor-class"));
270
271 if (Validator.isNotNull(processorClassName)) {
272 SocialActivityProcessor activityProcessor =
273 (SocialActivityProcessor)ProxyFactory.newInstance(
274 classLoader, SocialActivityProcessor.class,
275 processorClassName);
276
277 activityDefinition.setActivityProcessor(activityProcessor);
278 }
279
280 _readActivityContribution(activityElement, activityDefinition);
281 _readActivityParticipation(activityElement, activityDefinition);
282 }
283
284 private void _readActivity(
285 ClassLoader classLoader, List<Object> objects,
286 Element activityElement)
287 throws Exception {
288
289 String modelName = GetterUtil.getString(
290 activityElement.elementText("model-name"));
291
292 Map<Integer, SocialActivityDefinition> activityDefinitions =
293 _activityDefinitions.get(modelName);
294
295 if (activityDefinitions == null) {
296 activityDefinitions = new HashMap<>();
297
298 _activityDefinitions.put(modelName, activityDefinitions);
299 }
300
301 int activityType = GetterUtil.getInteger(
302 activityElement.elementText("activity-type"));
303
304 SocialActivityDefinition activityDefinition = activityDefinitions.get(
305 activityType);
306
307 if (activityDefinition == null) {
308 activityDefinition = new SocialActivityDefinition();
309
310 activityDefinition.setModelName(modelName);
311 activityDefinition.setActivityType(activityType);
312
313 _readActivity(classLoader, activityElement, activityDefinition);
314
315 activityDefinitions.put(activityType, activityDefinition);
316
317 objects.add(activityDefinition);
318 }
319
320 List<Element> counterElements = activityElement.elements("counter");
321
322 for (Element counterElement : counterElements) {
323 _readCounter(objects, activityDefinition, counterElement);
324 }
325
326 List<Element> achievementElements = activityElement.elements(
327 "achievement");
328
329 for (Element achievementElement : achievementElements) {
330 _readAchievement(
331 classLoader, objects, activityDefinition, achievementElement);
332 }
333 }
334
335 private void _readActivityContribution(
336 Element activityElement, SocialActivityDefinition activityDefinition) {
337
338 Element contributionValueElement = activityElement.element(
339 "contribution-value");
340 Element contributionLimitElement = activityElement.element(
341 "contribution-limit");
342
343 if ((contributionValueElement == null) &&
344 (contributionLimitElement == null)) {
345
346 return;
347 }
348
349 SocialActivityCounterDefinition activityCounterDefinition =
350 new SocialActivityCounterDefinition();
351
352 activityCounterDefinition.setName(
353 SocialActivityCounterConstants.NAME_CONTRIBUTION);
354 activityCounterDefinition.setOwnerType(
355 SocialActivityCounterConstants.TYPE_CREATOR);
356
357 int increment = 0;
358
359 if (contributionValueElement != null) {
360 increment = GetterUtil.getInteger(
361 contributionValueElement.getText());
362 }
363
364 activityCounterDefinition.setIncrement(increment);
365
366 if (contributionLimitElement != null) {
367 String limitEnabled = contributionLimitElement.attributeValue(
368 "enabled");
369
370 if (Validator.isNotNull(limitEnabled)) {
371 activityCounterDefinition.setLimitEnabled(
372 GetterUtil.getBoolean(limitEnabled));
373 }
374
375 String limitPeriod = contributionLimitElement.attributeValue(
376 "period");
377
378 if (Validator.isNotNull(limitPeriod)) {
379 activityCounterDefinition.setLimitPeriod(limitPeriod);
380 }
381
382 int limitValue = GetterUtil.getInteger(
383 contributionLimitElement.getText());
384
385 activityCounterDefinition.setLimitValue(limitValue);
386 }
387
388 activityDefinition.addCounter(activityCounterDefinition);
389
390 SocialActivityCounterDefinition popularityActivityCounterDefinition =
391 new SocialActivityCounterDefinition();
392
393 popularityActivityCounterDefinition.setName(
394 SocialActivityCounterConstants.NAME_POPULARITY);
395 popularityActivityCounterDefinition.setOwnerType(
396 SocialActivityCounterConstants.TYPE_ASSET);
397 popularityActivityCounterDefinition.setIncrement(
398 activityCounterDefinition.getIncrement());
399 popularityActivityCounterDefinition.setLimitEnabled(
400 activityCounterDefinition.isLimitEnabled());
401 popularityActivityCounterDefinition.setLimitPeriod(
402 activityCounterDefinition.getLimitPeriod());
403 popularityActivityCounterDefinition.setLimitValue(
404 activityCounterDefinition.getLimitValue());
405
406 activityDefinition.addCounter(popularityActivityCounterDefinition);
407 }
408
409 private void _readActivityParticipation(
410 Element activityElement, SocialActivityDefinition activityDefinition) {
411
412 Element participationValueElement = activityElement.element(
413 "participation-value");
414 Element participationLimitElement = activityElement.element(
415 "participation-limit");
416
417 if ((participationValueElement == null) &&
418 (participationLimitElement == null)) {
419
420 return;
421 }
422
423 SocialActivityCounterDefinition activityCounterDefinition =
424 new SocialActivityCounterDefinition();
425
426 activityCounterDefinition.setName(
427 SocialActivityCounterConstants.NAME_PARTICIPATION);
428 activityCounterDefinition.setOwnerType(
429 SocialActivityCounterConstants.TYPE_ACTOR);
430
431 int increment = 0;
432
433 if (participationValueElement != null) {
434 increment = GetterUtil.getInteger(
435 participationValueElement.getText());
436 }
437
438 activityCounterDefinition.setIncrement(increment);
439
440 if (participationLimitElement != null) {
441 String limitEnabled = participationLimitElement.attributeValue(
442 "enabled");
443
444 if (Validator.isNotNull(limitEnabled)) {
445 activityCounterDefinition.setLimitEnabled(
446 GetterUtil.getBoolean(limitEnabled));
447 }
448
449 String limitPeriod = participationLimitElement.attributeValue(
450 "period");
451
452 if (Validator.isNotNull(limitPeriod)) {
453 activityCounterDefinition.setLimitPeriod(limitPeriod);
454 }
455
456 int limitValue = GetterUtil.getInteger(
457 participationLimitElement.getText());
458
459 activityCounterDefinition.setLimitValue(limitValue);
460 }
461
462 activityDefinition.addCounter(activityCounterDefinition);
463 }
464
465 private void _readCounter(
466 List<Object> objects, SocialActivityDefinition activityDefinition,
467 Element counterElement) {
468
469 SocialActivityCounterDefinition activityCounterDefinition =
470 new SocialActivityCounterDefinition();
471
472 int increment = GetterUtil.getInteger(
473 counterElement.elementText("increment"), 1);
474
475 activityCounterDefinition.setIncrement(increment);
476
477 boolean enabled = GetterUtil.getBoolean(
478 counterElement.elementText("enabled"), true);
479
480 activityCounterDefinition.setEnabled(enabled);
481
482 String name = GetterUtil.getString(counterElement.elementText("name"));
483
484 activityCounterDefinition.setName(name);
485
486 String ownerType = GetterUtil.getString(
487 counterElement.elementText("owner-type"));
488
489 activityCounterDefinition.setOwnerType(ownerType);
490
491 if (activityCounterDefinition.getOwnerType() == 0) {
492 if (_log.isWarnEnabled()) {
493 _log.warn(
494 "Invalid owner type " + ownerType + " for model " +
495 activityDefinition.getModelName());
496 }
497
498 return;
499 }
500
501 activityDefinition.addCounter(activityCounterDefinition);
502
503 Tuple tuple = new Tuple(activityDefinition, activityCounterDefinition);
504
505 objects.add(tuple);
506 }
507
508 private static final Log _log = LogFactoryUtil.getLog(
509 SocialConfigurationImpl.class);
510
511 private final Map<String, Map<Integer, SocialActivityDefinition>>
512 _activityDefinitions = new HashMap<>();
513
514 }