001
014
015 package com.liferay.portal.service.impl;
016
017 import com.liferay.portal.PortletIdException;
018 import com.liferay.portal.kernel.cluster.Clusterable;
019 import com.liferay.portal.kernel.exception.PortalException;
020 import com.liferay.portal.kernel.exception.SystemException;
021 import com.liferay.portal.kernel.image.SpriteProcessor;
022 import com.liferay.portal.kernel.image.SpriteProcessorUtil;
023 import com.liferay.portal.kernel.lar.DefaultConfigurationPortletDataHandler;
024 import com.liferay.portal.kernel.log.Log;
025 import com.liferay.portal.kernel.log.LogFactoryUtil;
026 import com.liferay.portal.kernel.plugin.PluginPackage;
027 import com.liferay.portal.kernel.portlet.FriendlyURLMapper;
028 import com.liferay.portal.kernel.portlet.LiferayPortletConfig;
029 import com.liferay.portal.kernel.portlet.LiferayWindowState;
030 import com.liferay.portal.kernel.portlet.PortletLayoutListener;
031 import com.liferay.portal.kernel.scheduler.SchedulerEntry;
032 import com.liferay.portal.kernel.scheduler.SchedulerEntryImpl;
033 import com.liferay.portal.kernel.scheduler.TimeUnit;
034 import com.liferay.portal.kernel.scheduler.TriggerType;
035 import com.liferay.portal.kernel.servlet.ServletContextUtil;
036 import com.liferay.portal.kernel.spring.aop.Skip;
037 import com.liferay.portal.kernel.transaction.Transactional;
038 import com.liferay.portal.kernel.util.CharPool;
039 import com.liferay.portal.kernel.util.ContentTypes;
040 import com.liferay.portal.kernel.util.ContextPathUtil;
041 import com.liferay.portal.kernel.util.GetterUtil;
042 import com.liferay.portal.kernel.util.ListUtil;
043 import com.liferay.portal.kernel.util.StringPool;
044 import com.liferay.portal.kernel.util.StringUtil;
045 import com.liferay.portal.kernel.util.Validator;
046 import com.liferay.portal.kernel.xml.Document;
047 import com.liferay.portal.kernel.xml.Element;
048 import com.liferay.portal.kernel.xml.QName;
049 import com.liferay.portal.kernel.xml.SAXReaderUtil;
050 import com.liferay.portal.model.CompanyConstants;
051 import com.liferay.portal.model.EventDefinition;
052 import com.liferay.portal.model.ModelHintsUtil;
053 import com.liferay.portal.model.Portlet;
054 import com.liferay.portal.model.PortletApp;
055 import com.liferay.portal.model.PortletCategory;
056 import com.liferay.portal.model.PortletConstants;
057 import com.liferay.portal.model.PortletFilter;
058 import com.liferay.portal.model.PortletInfo;
059 import com.liferay.portal.model.PortletPreferences;
060 import com.liferay.portal.model.PortletURLListener;
061 import com.liferay.portal.model.PublicRenderParameter;
062 import com.liferay.portal.model.ResourceConstants;
063 import com.liferay.portal.model.Role;
064 import com.liferay.portal.model.impl.EventDefinitionImpl;
065 import com.liferay.portal.model.impl.PortletAppImpl;
066 import com.liferay.portal.model.impl.PortletFilterImpl;
067 import com.liferay.portal.model.impl.PortletImpl;
068 import com.liferay.portal.model.impl.PortletURLListenerImpl;
069 import com.liferay.portal.model.impl.PublicRenderParameterImpl;
070 import com.liferay.portal.security.permission.ActionKeys;
071 import com.liferay.portal.security.permission.ResourceActionsUtil;
072 import com.liferay.portal.service.base.PortletLocalServiceBaseImpl;
073 import com.liferay.portal.service.permission.PortletPermissionUtil;
074 import com.liferay.portal.util.PortalUtil;
075 import com.liferay.portal.util.PortletCategoryKeys;
076 import com.liferay.portal.util.PortletKeys;
077 import com.liferay.portal.util.PropsValues;
078 import com.liferay.portal.util.WebAppPool;
079 import com.liferay.portal.util.WebKeys;
080 import com.liferay.portlet.PortletConfigFactoryUtil;
081 import com.liferay.portlet.PortletContextFactory;
082 import com.liferay.portlet.PortletInstanceFactoryUtil;
083 import com.liferay.portlet.PortletPreferencesFactoryUtil;
084 import com.liferay.portlet.PortletQNameUtil;
085 import com.liferay.portlet.expando.model.CustomAttributesDisplay;
086 import com.liferay.util.ContentUtil;
087 import com.liferay.util.bridges.mvc.MVCPortlet;
088
089 import java.net.URL;
090
091 import java.util.ArrayList;
092 import java.util.HashMap;
093 import java.util.HashSet;
094 import java.util.Iterator;
095 import java.util.LinkedHashSet;
096 import java.util.List;
097 import java.util.Map;
098 import java.util.Properties;
099 import java.util.Set;
100 import java.util.concurrent.ConcurrentHashMap;
101
102 import javax.portlet.PortletMode;
103 import javax.portlet.PreferencesValidator;
104 import javax.portlet.WindowState;
105
106 import javax.servlet.ServletContext;
107
108
115 public class PortletLocalServiceImpl extends PortletLocalServiceBaseImpl {
116
117 @Override
118 @Skip
119 public void addPortletCategory(long companyId, String categoryName) {
120 PortletCategory portletCategory = (PortletCategory)WebAppPool.get(
121 companyId, WebKeys.PORTLET_CATEGORY);
122
123 if (portletCategory == null) {
124 _log.error(
125 "Unable to add portlet category for company " + companyId +
126 " because it does not exist");
127
128 return;
129 }
130
131 PortletCategory newPortletCategory = new PortletCategory(categoryName);
132
133 if (newPortletCategory.getParentCategory() == null) {
134 PortletCategory rootPortletCategory = new PortletCategory();
135
136 rootPortletCategory.addCategory(newPortletCategory);
137 }
138
139 portletCategory.merge(newPortletCategory.getRootCategory());
140 }
141
142 @Override
143 public void checkPortlet(Portlet portlet)
144 throws PortalException, SystemException {
145
146 if (portlet.isSystem()) {
147 return;
148 }
149
150 String[] roleNames = portlet.getRolesArray();
151
152 if (roleNames.length == 0) {
153 return;
154 }
155
156 long companyId = portlet.getCompanyId();
157 String name = portlet.getPortletId();
158 int scope = ResourceConstants.SCOPE_COMPANY;
159 String primKey = String.valueOf(companyId);
160 String actionId = ActionKeys.ADD_TO_PAGE;
161
162 List<String> actionIds = ResourceActionsUtil.getPortletResourceActions(
163 name);
164
165 if (actionIds.contains(actionId)) {
166 for (String roleName : roleNames) {
167 Role role = roleLocalService.getRole(companyId, roleName);
168
169 if (resourceBlockLocalService.isSupported(name)) {
170 resourceBlockLocalService.addCompanyScopePermission(
171 companyId, name, role.getRoleId(), actionId);
172 }
173 else {
174 resourcePermissionLocalService.addResourcePermission(
175 companyId, name, scope, primKey, role.getRoleId(),
176 actionId);
177 }
178 }
179 }
180
181 updatePortlet(
182 companyId, portlet.getPortletId(), StringPool.BLANK,
183 portlet.isActive());
184 }
185
186 @Override
187 public void checkPortlets(long companyId)
188 throws PortalException, SystemException {
189
190 List<Portlet> portlets = getPortlets(companyId);
191
192 for (Portlet portlet : portlets) {
193 checkPortlet(portlet);
194 }
195 }
196
197 @Override
198 @Skip
199 public void clearCache() {
200
201
202
203 _portletIdsByStrutsPath.clear();
204
205
206
207 portletLocalService.clearCompanyPortletsPool();
208 }
209
210 @Clusterable
211 @Override
212 @Transactional(enabled = false)
213 public void clearCompanyPortletsPool() {
214 _companyPortletsPool.clear();
215 }
216
217
220 @Override
221 @Skip
222 public Portlet clonePortlet(long companyId, String portletId) {
223 return clonePortlet(portletId);
224 }
225
226 @Override
227 @Skip
228 public Portlet clonePortlet(String portletId) {
229 Portlet portlet = getPortletById(portletId);
230
231 return (Portlet)portlet.clone();
232 }
233
234 @Override
235 public void deletePortlet(long companyId, String portletId, long plid)
236 throws PortalException, SystemException {
237
238 String rootPortletId = PortletConstants.getRootPortletId(portletId);
239
240 resourceLocalService.deleteResource(
241 companyId, rootPortletId, ResourceConstants.SCOPE_INDIVIDUAL,
242 PortletPermissionUtil.getPrimaryKey(plid, portletId));
243
244 int ownerType = PortletKeys.PREFS_OWNER_TYPE_LAYOUT;
245
246 if (PortletConstants.hasUserId(portletId)) {
247 ownerType = PortletKeys.PREFS_OWNER_TYPE_USER;
248 }
249
250 List<PortletPreferences> portletPreferencesList =
251 portletPreferencesLocalService.getPortletPreferences(
252 ownerType, plid, portletId);
253
254 Portlet portlet = getPortletById(companyId, portletId);
255
256 PortletLayoutListener portletLayoutListener = null;
257
258 if (portlet != null) {
259 portletLayoutListener = portlet.getPortletLayoutListenerInstance();
260
261 PortletInstanceFactoryUtil.delete(portlet);
262 }
263
264 for (PortletPreferences portletPreferences : portletPreferencesList) {
265 if (portletLayoutListener != null) {
266 portletLayoutListener.onRemoveFromLayout(
267 portletPreferences.getPortletId(), plid);
268 }
269
270 portletPreferencesLocalService.deletePortletPreferences(
271 portletPreferences.getPortletPreferencesId());
272 }
273 }
274
275 @Override
276 public void deletePortlets(long companyId, String[] portletIds, long plid)
277 throws PortalException, SystemException {
278
279 for (String portletId : portletIds) {
280 deletePortlet(companyId, portletId, plid);
281 }
282 }
283
284 @Override
285 public Portlet deployRemotePortlet(Portlet portlet, String categoryName)
286 throws PortalException, SystemException {
287
288 return deployRemotePortlet(portlet, new String[] {categoryName});
289 }
290
291 @Override
292 public Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames)
293 throws PortalException, SystemException {
294
295 Map<String, Portlet> portletsPool = _getPortletsPool();
296
297 portletsPool.put(portlet.getPortletId(), portlet);
298
299 PortletInstanceFactoryUtil.clear(portlet, false);
300
301 PortletConfigFactoryUtil.destroy(portlet);
302
303 clearCache();
304
305 List<String> portletActions =
306 ResourceActionsUtil.getPortletResourceActions(
307 portlet.getPortletId());
308
309 resourceActionLocalService.checkResourceActions(
310 portlet.getPortletId(), portletActions);
311
312 PortletCategory portletCategory = (PortletCategory)WebAppPool.get(
313 portlet.getCompanyId(), WebKeys.PORTLET_CATEGORY);
314
315 if (portletCategory == null) {
316 _log.error(
317 "Unable to register remote portlet for company " +
318 portlet.getCompanyId() + " because it does not exist");
319
320 return portlet;
321 }
322
323 portletCategory.separate(portlet.getPortletId());
324
325 for (String categoryName : categoryNames) {
326 PortletCategory newPortletCategory = new PortletCategory(
327 categoryName);
328
329 if (newPortletCategory.getParentCategory() == null) {
330 PortletCategory rootPortletCategory = new PortletCategory();
331
332 rootPortletCategory.addCategory(newPortletCategory);
333 }
334
335 Set<String> portletIds = newPortletCategory.getPortletIds();
336
337 portletIds.add(portlet.getPortletId());
338
339 portletCategory.merge(newPortletCategory.getRootCategory());
340 }
341
342 checkPortlet(portlet);
343
344 return portlet;
345 }
346
347 @Override
348 @Skip
349 public void destroyPortlet(Portlet portlet) {
350 String portletId = portlet.getRootPortletId();
351
352 _friendlyURLMapperPortlets.remove(portletId);
353
354 Map<String, Portlet> portletsPool = _getPortletsPool();
355
356 portletsPool.remove(portletId);
357
358 PortletApp portletApp = portlet.getPortletApp();
359
360 if (portletApp != null) {
361 _portletAppsPool.remove(portletApp.getServletContextName());
362 }
363
364 clearCache();
365 }
366
367 @Override
368 @Skip
369 public void destroyRemotePortlet(Portlet portlet) {
370 destroyPortlet(portlet);
371 }
372
373 @Override
374 @Skip
375 public List<CustomAttributesDisplay> getCustomAttributesDisplays() {
376 List<CustomAttributesDisplay> customAttributesDisplays =
377 new ArrayList<CustomAttributesDisplay>(
378 _customAttributesDisplayPortlets.size());
379
380 for (Map.Entry<String, Portlet> entry :
381 _customAttributesDisplayPortlets.entrySet()) {
382
383 Portlet portlet = entry.getValue();
384
385 List<CustomAttributesDisplay> portletCustomAttributesDisplays =
386 portlet.getCustomAttributesDisplayInstances();
387
388 if ((portletCustomAttributesDisplays != null) &&
389 !portletCustomAttributesDisplays.isEmpty()) {
390
391 customAttributesDisplays.addAll(
392 portletCustomAttributesDisplays);
393 }
394 }
395
396 return customAttributesDisplays;
397 }
398
399 @Override
400 @Skip
401 public PortletCategory getEARDisplay(String xml) throws SystemException {
402 try {
403 return _readLiferayDisplayXML(xml);
404 }
405 catch (Exception e) {
406 throw new SystemException(e);
407 }
408 }
409
410 @Override
411 @Skip
412 public List<Portlet> getFriendlyURLMapperPortlets() {
413 List<Portlet> portlets = new ArrayList<Portlet>(
414 _friendlyURLMapperPortlets.size());
415
416 for (Map.Entry<String, Portlet> entry :
417 _friendlyURLMapperPortlets.entrySet()) {
418
419 Portlet portlet = entry.getValue();
420
421 FriendlyURLMapper friendlyURLMapper =
422 portlet.getFriendlyURLMapperInstance();
423
424 if (friendlyURLMapper != null) {
425 portlets.add(portlet);
426 }
427 }
428
429 return portlets;
430 }
431
432 @Override
433 @Skip
434 public List<FriendlyURLMapper> getFriendlyURLMappers() {
435 List<FriendlyURLMapper> friendlyURLMappers =
436 new ArrayList<FriendlyURLMapper>(_friendlyURLMapperPortlets.size());
437
438 for (Map.Entry<String, Portlet> entry :
439 _friendlyURLMapperPortlets.entrySet()) {
440
441 Portlet portlet = entry.getValue();
442
443 FriendlyURLMapper friendlyURLMapper =
444 portlet.getFriendlyURLMapperInstance();
445
446 if (friendlyURLMapper != null) {
447 friendlyURLMappers.add(friendlyURLMapper);
448 }
449 }
450
451 return friendlyURLMappers;
452 }
453
454 @Override
455 @Skip
456 public PortletApp getPortletApp(String servletContextName) {
457 return _getPortletApp(servletContextName);
458 }
459
460 @Override
461 @Skip
462 public Portlet getPortletById(long companyId, String portletId)
463 throws SystemException {
464
465 portletId = PortalUtil.getJsSafePortletId(portletId);
466
467 Portlet portlet = null;
468
469 Map<String, Portlet> companyPortletsPool = _getPortletsPool(companyId);
470
471 String rootPortletId = PortletConstants.getRootPortletId(portletId);
472
473 if (portletId.equals(rootPortletId)) {
474 portlet = companyPortletsPool.get(portletId);
475 }
476 else {
477 portlet = companyPortletsPool.get(rootPortletId);
478
479 if (portlet != null) {
480 portlet = portlet.getClonedInstance(portletId);
481 }
482 }
483
484 if (portlet != null) {
485 return portlet;
486 }
487
488 if (portletId.equals(PortletKeys.LIFERAY_PORTAL)) {
489 return portlet;
490 }
491
492 if (_portletsPool.isEmpty()) {
493 if (_log.isDebugEnabled()) {
494 _log.debug("No portlets are installed");
495 }
496 }
497 else {
498 if (_log.isInfoEnabled()) {
499 _log.info(
500 "Portlet not found for " + companyId + " " + portletId);
501 }
502
503 portlet = new PortletImpl(CompanyConstants.SYSTEM, portletId);
504
505 portlet.setTimestamp(System.currentTimeMillis());
506
507 PortletApp portletApp = _getPortletApp(StringPool.BLANK);
508
509 portlet.setPortletApp(portletApp);
510
511 portlet.setPortletName(portletId);
512 portlet.setDisplayName(portletId);
513 portlet.setPortletClass(MVCPortlet.class.getName());
514
515 Map<String, String> initParams = portlet.getInitParams();
516
517 initParams.put("view-jsp", "/html/portal/undeployed_portlet.jsp");
518
519 Set<String> mimeTypePortletModes = new HashSet<String>();
520
521 mimeTypePortletModes.add(PortletMode.VIEW.toString().toLowerCase());
522
523 Map<String, Set<String>> portletModes = portlet.getPortletModes();
524
525 portletModes.put(ContentTypes.TEXT_HTML, mimeTypePortletModes);
526
527 Set<String> mimeTypeWindowStates = new HashSet<String>();
528
529 mimeTypeWindowStates.add(
530 WindowState.NORMAL.toString().toLowerCase());
531
532 Map<String, Set<String>> windowStates = portlet.getWindowStates();
533
534 windowStates.put(ContentTypes.TEXT_HTML, mimeTypeWindowStates);
535
536 portlet.setPortletInfo(
537 new PortletInfo(portletId, portletId, portletId, portletId));
538
539 if (PortletConstants.hasInstanceId(portletId)) {
540 portlet.setInstanceable(true);
541 }
542
543 portlet.setActive(true);
544 portlet.setUndeployedPortlet(true);
545 }
546
547 return portlet;
548 }
549
550 @Override
551 @Skip
552 public Portlet getPortletById(String portletId) {
553 Map<String, Portlet> portletsPool = _getPortletsPool();
554
555 String rootPortletId = PortletConstants.getRootPortletId(portletId);
556
557 return portletsPool.get(rootPortletId);
558 }
559
560 @Override
561 @Skip
562 public Portlet getPortletByStrutsPath(long companyId, String strutsPath)
563 throws SystemException {
564
565 return getPortletById(companyId, _getPortletId(strutsPath));
566 }
567
568 @Override
569 @Skip
570 public List<Portlet> getPortlets() {
571 Map<String, Portlet> portletsPool = _getPortletsPool();
572
573 return ListUtil.fromMapValues(portletsPool);
574 }
575
576 @Override
577 @Skip
578 public List<Portlet> getPortlets(long companyId) throws SystemException {
579 return getPortlets(companyId, true, true);
580 }
581
582 @Override
583 @Skip
584 public List<Portlet> getPortlets(
585 long companyId, boolean showSystem, boolean showPortal)
586 throws SystemException {
587
588 Map<String, Portlet> portletsPool = _getPortletsPool(companyId);
589
590 List<Portlet> portlets = ListUtil.fromMapValues(portletsPool);
591
592 if (showSystem && showPortal) {
593 return portlets;
594 }
595
596 Iterator<Portlet> itr = portlets.iterator();
597
598 while (itr.hasNext()) {
599 Portlet portlet = itr.next();
600
601 if (showPortal &&
602 portlet.getPortletId().equals(PortletKeys.PORTAL)) {
603
604 }
605 else if (!showPortal &&
606 portlet.getPortletId().equals(PortletKeys.PORTAL)) {
607
608 itr.remove();
609 }
610 else if (!showSystem && portlet.isSystem()) {
611 itr.remove();
612 }
613 }
614
615 return portlets;
616 }
617
618 @Override
619 @Skip
620 public List<Portlet> getScopablePortlets() {
621 Map<String, Portlet> portletsPool = _getPortletsPool();
622
623 List<Portlet> portlets = ListUtil.fromMapValues(portletsPool);
624
625 Iterator<Portlet> itr = portlets.iterator();
626
627 while (itr.hasNext()) {
628 Portlet portlet = itr.next();
629
630 if (!portlet.isScopeable()) {
631 itr.remove();
632 }
633 }
634
635 return portlets;
636 }
637
638 @Override
639 @Skip
640 public PortletCategory getWARDisplay(String servletContextName, String xml)
641 throws SystemException {
642
643 try {
644 return _readLiferayDisplayXML(servletContextName, xml);
645 }
646 catch (Exception e) {
647 throw new SystemException(e);
648 }
649 }
650
651 @Override
652 @Skip
653 public boolean hasPortlet(long companyId, String portletId)
654 throws SystemException {
655
656 portletId = PortalUtil.getJsSafePortletId(portletId);
657
658 Portlet portlet = null;
659
660 Map<String, Portlet> companyPortletsPool = _getPortletsPool(companyId);
661
662 String rootPortletId = PortletConstants.getRootPortletId(portletId);
663
664 if (portletId.equals(rootPortletId)) {
665 portlet = companyPortletsPool.get(portletId);
666 }
667 else {
668 portlet = companyPortletsPool.get(rootPortletId);
669 }
670
671 if (portlet == null) {
672 return false;
673 }
674 else {
675 return true;
676 }
677 }
678
679 @Override
680 @Skip
681 public void initEAR(
682 ServletContext servletContext, String[] xmls,
683 PluginPackage pluginPackage) {
684
685
686
687 portletLocalService.clearCompanyPortletsPool();
688
689 _portletAppsPool.clear();
690 _portletsPool.clear();
691 _portletIdsByStrutsPath.clear();
692 _friendlyURLMapperPortlets.clear();
693
694 Map<String, Portlet> portletsPool = _getPortletsPool();
695
696 try {
697 Set<String> servletURLPatterns = _readWebXML(xmls[4]);
698
699 Set<String> portletIds = _readPortletXML(
700 servletContext, xmls[0], portletsPool, servletURLPatterns,
701 pluginPackage);
702
703 portletIds.addAll(
704 _readPortletXML(
705 servletContext, xmls[1], portletsPool, servletURLPatterns,
706 pluginPackage));
707
708 Set<String> liferayPortletIds = _readLiferayPortletXML(
709 xmls[2], portletsPool);
710
711 liferayPortletIds.addAll(
712 _readLiferayPortletXML(xmls[3], portletsPool));
713
714
715
716 for (String portletId : portletIds) {
717 if (_log.isWarnEnabled() &&
718 !liferayPortletIds.contains(portletId)) {
719
720 _log.warn(
721 "Portlet with the name " + portletId +
722 " is described in portlet.xml but does not " +
723 "have a matching entry in liferay-portlet.xml");
724 }
725 }
726
727
728
729 for (String portletId : liferayPortletIds) {
730 if (_log.isWarnEnabled() && !portletIds.contains(portletId)) {
731 _log.warn(
732 "Portlet with the name " + portletId +
733 " is described in liferay-portlet.xml but does " +
734 "not have a matching entry in portlet.xml");
735 }
736 }
737
738
739
740 Iterator<Map.Entry<String, Portlet>> portletPoolsItr =
741 portletsPool.entrySet().iterator();
742
743 while (portletPoolsItr.hasNext()) {
744 Map.Entry<String, Portlet> entry = portletPoolsItr.next();
745
746 Portlet portletModel = entry.getValue();
747
748 if (!portletModel.getPortletId().equals(PortletKeys.ADMIN) &&
749 !portletModel.getPortletId().equals(
750 PortletKeys.MY_ACCOUNT) &&
751 !portletModel.isInclude()) {
752
753 portletPoolsItr.remove();
754
755 _friendlyURLMapperPortlets.remove(
756 portletModel.getPortletId());
757 }
758 }
759
760
761
762 PortletApp portletApp = _getPortletApp(StringPool.BLANK);
763
764 _setSpriteImages(servletContext, portletApp, "/html/icons/");
765 }
766 catch (Exception e) {
767 _log.error(e, e);
768 }
769 }
770
771 @Override
772 @Skip
773 public List<Portlet> initWAR(
774 String servletContextName, ServletContext servletContext, String[] xmls,
775 PluginPackage pluginPackage) {
776
777 List<Portlet> portlets = new ArrayList<Portlet>();
778
779 Map<String, Portlet> portletsPool = _getPortletsPool();
780
781 try {
782 Set<String> servletURLPatterns = _readWebXML(xmls[3]);
783
784 Set<String> portletIds = _readPortletXML(
785 servletContextName, servletContext, xmls[0], portletsPool,
786 servletURLPatterns, pluginPackage);
787
788 portletIds.addAll(
789 _readPortletXML(
790 servletContextName, servletContext, xmls[1], portletsPool,
791 servletURLPatterns, pluginPackage));
792
793 Set<String> liferayPortletIds = _readLiferayPortletXML(
794 servletContextName, xmls[2], portletsPool);
795
796
797
798 for (String portletId : portletIds) {
799 if (_log.isWarnEnabled() &&
800 !liferayPortletIds.contains(portletId)) {
801
802 _log.warn(
803 "Portlet with the name " + portletId +
804 " is described in portlet.xml but does not " +
805 "have a matching entry in liferay-portlet.xml");
806 }
807 }
808
809
810
811 for (String portletId : liferayPortletIds) {
812 if (_log.isWarnEnabled() && !portletIds.contains(portletId)) {
813 _log.warn(
814 "Portlet with the name " + portletId +
815 " is described in liferay-portlet.xml but does " +
816 "not have a matching entry in portlet.xml");
817 }
818 }
819
820
821
822 for (String portletId : portletIds) {
823 Portlet portlet = _getPortletsPool().get(portletId);
824
825 portlets.add(portlet);
826
827 PortletInstanceFactoryUtil.clear(portlet);
828
829 PortletConfigFactoryUtil.destroy(portlet);
830 PortletContextFactory.destroy(portlet);
831 }
832
833
834
835 PortletApp portletApp = _getPortletApp(servletContextName);
836
837 _setSpriteImages(servletContext, portletApp, "/icons/");
838 }
839 catch (Exception e) {
840 _log.error(e, e);
841 }
842
843 clearCache();
844
845 return portlets;
846 }
847
848 @Override
849 public Map<String, Portlet> loadGetPortletsPool(long companyId)
850 throws SystemException {
851
852 Map<String, Portlet> portletsPool =
853 new ConcurrentHashMap<String, Portlet>();
854
855 Map<String, Portlet> parentPortletsPool = _getPortletsPool();
856
857 if (parentPortletsPool == null) {
858
859
860
861
862 return portletsPool;
863 }
864
865 for (Portlet portlet : parentPortletsPool.values()) {
866 portlet = (Portlet)portlet.clone();
867
868 portlet.setCompanyId(companyId);
869
870 portletsPool.put(portlet.getPortletId(), portlet);
871 }
872
873 List<Portlet> portlets = portletPersistence.findByCompanyId(companyId);
874
875 for (Portlet portlet : portlets) {
876 Portlet portletModel = portletsPool.get(portlet.getPortletId());
877
878
879
880
881 if (portletModel != null) {
882 portletModel.setPluginPackage(portlet.getPluginPackage());
883 portletModel.setDefaultPluginSetting(
884 portlet.getDefaultPluginSetting());
885 portletModel.setRoles(portlet.getRoles());
886 portletModel.setActive(portlet.getActive());
887 }
888 }
889
890 return portletsPool;
891 }
892
893 @Clusterable
894 @Override
895 @Transactional(enabled = false)
896 public void removeCompanyPortletsPool(long companyId) {
897 _companyPortletsPool.remove(companyId);
898 }
899
900 @Override
901 public Portlet updatePortlet(
902 long companyId, String portletId, String roles, boolean active)
903 throws SystemException {
904
905 portletId = PortalUtil.getJsSafePortletId(portletId);
906
907 Portlet portlet = portletPersistence.fetchByC_P(companyId, portletId);
908
909 if (portlet == null) {
910 long id = counterLocalService.increment();
911
912 portlet = portletPersistence.create(id);
913
914 portlet.setCompanyId(companyId);
915 portlet.setPortletId(portletId);
916 }
917
918 portlet.setRoles(roles);
919 portlet.setActive(active);
920
921 portletPersistence.update(portlet);
922
923 portlet = getPortletById(companyId, portletId);
924
925 portlet.setRoles(roles);
926 portlet.setActive(active);
927
928 portletLocalService.removeCompanyPortletsPool(companyId);
929
930 return portlet;
931 }
932
933 private PortletApp _getPortletApp(String servletContextName) {
934 PortletApp portletApp = _portletAppsPool.get(servletContextName);
935
936 if (portletApp == null) {
937 portletApp = new PortletAppImpl(servletContextName);
938
939 _portletAppsPool.put(servletContextName, portletApp);
940 }
941
942 return portletApp;
943 }
944
945 private String _getPortletId(String securityPath) {
946 if (_portletIdsByStrutsPath.isEmpty()) {
947 for (Portlet portlet : _getPortletsPool().values()) {
948 String strutsPath = portlet.getStrutsPath();
949
950 if (_portletIdsByStrutsPath.containsKey(strutsPath)) {
951 _log.warn("Duplicate struts path " + strutsPath);
952 }
953
954 _portletIdsByStrutsPath.put(strutsPath, portlet.getPortletId());
955 }
956 }
957
958 String portletId = _portletIdsByStrutsPath.get(securityPath);
959
960 if (Validator.isNull(portletId)) {
961 for (String strutsPath : _portletIdsByStrutsPath.keySet()) {
962 if (securityPath.startsWith(
963 strutsPath.concat(StringPool.SLASH))) {
964
965 portletId = _portletIdsByStrutsPath.get(strutsPath);
966
967 break;
968 }
969 }
970 }
971
972 if (Validator.isNull(portletId)) {
973 _log.error(
974 "Struts path " + securityPath + " is not mapped to a portlet " +
975 "in liferay-portlet.xml");
976 }
977
978 return portletId;
979 }
980
981 private List<Portlet> _getPortletsByPortletName(
982 String portletName, String servletContextName,
983 Map<String, Portlet> portletsPool) {
984
985 List<Portlet> portlets = null;
986
987 int pos = portletName.indexOf(CharPool.STAR);
988
989 if (pos == -1) {
990 portlets = new ArrayList<Portlet>();
991
992 String portletId = portletName;
993
994 if (Validator.isNotNull(servletContextName)) {
995 portletId =
996 portletId + PortletConstants.WAR_SEPARATOR +
997 servletContextName;
998 }
999
1000 portletId = PortalUtil.getJsSafePortletId(portletId);
1001
1002 Portlet portlet = portletsPool.get(portletId);
1003
1004 if (portlet != null) {
1005 portlets.add(portlet);
1006 }
1007
1008 return portlets;
1009 }
1010
1011 String portletNamePrefix = portletName.substring(0, pos);
1012
1013 portlets = _getPortletsByServletContextName(
1014 servletContextName, portletsPool);
1015
1016 Iterator<Portlet> itr = portlets.iterator();
1017
1018 while (itr.hasNext()) {
1019 Portlet portlet = itr.next();
1020
1021 String portletId = portlet.getPortletId();
1022
1023 if (!portletId.startsWith(portletNamePrefix)) {
1024 itr.remove();
1025 }
1026 }
1027
1028 return portlets;
1029 }
1030
1031 private List<Portlet> _getPortletsByServletContextName(
1032 String servletContextName, Map<String, Portlet> portletsPool) {
1033
1034 List<Portlet> portlets = new ArrayList<Portlet>();
1035
1036 String servletContextNameSuffix = servletContextName;
1037
1038 if (Validator.isNotNull(servletContextName)) {
1039 servletContextNameSuffix = PortalUtil.getJsSafePortletId(
1040 PortletConstants.WAR_SEPARATOR.concat(servletContextName));
1041 }
1042
1043 for (Map.Entry<String, Portlet> entry : portletsPool.entrySet()) {
1044 String portletId = entry.getKey();
1045 Portlet portlet = entry.getValue();
1046
1047 if (Validator.isNotNull(servletContextNameSuffix)) {
1048 if (portletId.endsWith(servletContextNameSuffix)) {
1049 portlets.add(portlet);
1050 }
1051 }
1052 else {
1053 if (!portletId.contains(PortletConstants.WAR_SEPARATOR)) {
1054 portlets.add(portlet);
1055 }
1056 }
1057 }
1058
1059 return portlets;
1060 }
1061
1062 private Map<String, Portlet> _getPortletsPool() {
1063 return _portletsPool;
1064 }
1065
1066 private Map<String, Portlet> _getPortletsPool(long companyId)
1067 throws SystemException {
1068
1069 Map<String, Portlet> portletsPool = _companyPortletsPool.get(companyId);
1070
1071 if (portletsPool == null) {
1072 portletsPool = portletLocalService.loadGetPortletsPool(companyId);
1073
1074 _companyPortletsPool.put(companyId, portletsPool);
1075 }
1076
1077 return portletsPool;
1078 }
1079
1080 private void _readLiferayDisplay(
1081 String servletContextName, Element element,
1082 PortletCategory portletCategory, Set<String> portletIds) {
1083
1084 for (Element categoryElement : element.elements("category")) {
1085 String name = categoryElement.attributeValue("name");
1086
1087 PortletCategory curPortletCategory = new PortletCategory(name);
1088
1089 portletCategory.addCategory(curPortletCategory);
1090
1091 Set<String> curPortletIds = curPortletCategory.getPortletIds();
1092
1093 for (Element portletElement : categoryElement.elements("portlet")) {
1094 String portletId = portletElement.attributeValue("id");
1095
1096 if (Validator.isNotNull(servletContextName)) {
1097 portletId =
1098 portletId + PortletConstants.WAR_SEPARATOR +
1099 servletContextName;
1100 }
1101
1102 portletId = PortalUtil.getJsSafePortletId(portletId);
1103
1104 portletIds.add(portletId);
1105 curPortletIds.add(portletId);
1106 }
1107
1108 _readLiferayDisplay(
1109 servletContextName, categoryElement, curPortletCategory,
1110 portletIds);
1111 }
1112 }
1113
1114 private PortletCategory _readLiferayDisplayXML(String xml)
1115 throws Exception {
1116
1117 return _readLiferayDisplayXML(null, xml);
1118 }
1119
1120 private PortletCategory _readLiferayDisplayXML(
1121 String servletContextName, String xml)
1122 throws Exception {
1123
1124 PortletCategory portletCategory = new PortletCategory();
1125
1126 if (xml == null) {
1127 xml = ContentUtil.get(
1128 "com/liferay/portal/deploy/dependencies/liferay-display.xml");
1129 }
1130
1131 Document document = SAXReaderUtil.read(xml, true);
1132
1133 Element rootElement = document.getRootElement();
1134
1135 Set<String> portletIds = new HashSet<String>();
1136
1137 _readLiferayDisplay(
1138 servletContextName, rootElement, portletCategory, portletIds);
1139
1140
1141
1142
1143 Set<String> undefinedPortletIds = new HashSet<String>();
1144
1145 for (Portlet portlet : _getPortletsPool().values()) {
1146 String portletId = portlet.getPortletId();
1147
1148 PortletApp portletApp = portlet.getPortletApp();
1149
1150 if ((servletContextName != null) && portletApp.isWARFile() &&
1151 (portletId.endsWith(
1152 PortletConstants.WAR_SEPARATOR +
1153 PortalUtil.getJsSafePortletId(servletContextName)) &&
1154 !portletIds.contains(portletId))) {
1155
1156 undefinedPortletIds.add(portletId);
1157 }
1158 else if ((servletContextName == null) &&
1159 !portletApp.isWARFile() &&
1160 !portletId.contains(PortletConstants.WAR_SEPARATOR) &&
1161 !portletIds.contains(portletId)) {
1162
1163 undefinedPortletIds.add(portletId);
1164 }
1165 }
1166
1167 if (!undefinedPortletIds.isEmpty()) {
1168 PortletCategory undefinedCategory = new PortletCategory(
1169 "category.undefined");
1170
1171 portletCategory.addCategory(undefinedCategory);
1172
1173 undefinedCategory.getPortletIds().addAll(undefinedPortletIds);
1174 }
1175
1176 return portletCategory;
1177 }
1178
1179 private Set<String> _readLiferayPortletXML(
1180 String xml, Map<String, Portlet> portletsPool)
1181 throws Exception {
1182
1183 return _readLiferayPortletXML(StringPool.BLANK, xml, portletsPool);
1184 }
1185
1186 private void _readLiferayPortletXML(
1187 String servletContextName, Map<String, Portlet> portletsPool,
1188 Set<String> liferayPortletIds, Map<String, String> roleMappers,
1189 Element portletElement) {
1190
1191 String portletId = portletElement.elementText("portlet-name");
1192
1193 if (Validator.isNotNull(servletContextName)) {
1194 portletId = portletId.concat(PortletConstants.WAR_SEPARATOR).concat(
1195 servletContextName);
1196 }
1197
1198 portletId = PortalUtil.getJsSafePortletId(portletId);
1199
1200 if (_log.isDebugEnabled()) {
1201 _log.debug("Reading portlet extension " + portletId);
1202 }
1203
1204 liferayPortletIds.add(portletId);
1205
1206 Portlet portletModel = portletsPool.get(portletId);
1207
1208 if (portletModel == null) {
1209 return;
1210 }
1211
1212 portletModel.setIcon(
1213 GetterUtil.getString(
1214 portletElement.elementText("icon"), portletModel.getIcon()));
1215 portletModel.setVirtualPath(
1216 GetterUtil.getString(
1217 portletElement.elementText("virtual-path"),
1218 portletModel.getVirtualPath()));
1219 portletModel.setStrutsPath(
1220 GetterUtil.getString(
1221 portletElement.elementText("struts-path"),
1222 portletModel.getStrutsPath()));
1223
1224 String strutsPath = portletModel.getStrutsPath();
1225
1226 if (Validator.isNotNull(strutsPath)) {
1227 if (_portletIdsByStrutsPath.containsKey(strutsPath)) {
1228 String strutsPathPortletId = _portletIdsByStrutsPath.get(
1229 strutsPath);
1230
1231 if (!strutsPathPortletId.equals(portletId)) {
1232 _log.warn("Duplicate struts path " + strutsPath);
1233 }
1234 }
1235
1236 _portletIdsByStrutsPath.put(strutsPath, portletId);
1237 }
1238
1239 portletModel.setParentStrutsPath(
1240 GetterUtil.getString(
1241 portletElement.elementText("parent-struts-path"),
1242 portletModel.getParentStrutsPath()));
1243
1244 if (Validator.isNotNull(
1245 portletElement.elementText("configuration-path"))) {
1246
1247 _log.error(
1248 "The configuration-path element is no longer supported. Use " +
1249 "configuration-action-class instead.");
1250 }
1251
1252 portletModel.setConfigurationActionClass(
1253 GetterUtil.getString(
1254 portletElement.elementText("configuration-action-class"),
1255 portletModel.getConfigurationActionClass()));
1256
1257 List<String> indexerClasses = new ArrayList<String>();
1258
1259 for (Element indexerClassElement :
1260 portletElement.elements("indexer-class")) {
1261
1262 indexerClasses.add(indexerClassElement.getText());
1263 }
1264
1265 portletModel.setIndexerClasses(indexerClasses);
1266
1267 portletModel.setOpenSearchClass(
1268 GetterUtil.getString(
1269 portletElement.elementText("open-search-class"),
1270 portletModel.getOpenSearchClass()));
1271
1272 for (Element schedulerEntryElement :
1273 portletElement.elements("scheduler-entry")) {
1274
1275 SchedulerEntry schedulerEntry = new SchedulerEntryImpl();
1276
1277 schedulerEntry.setDescription(
1278 GetterUtil.getString(
1279 schedulerEntryElement.elementText(
1280 "scheduler-description")));
1281 schedulerEntry.setEventListenerClass(
1282 GetterUtil.getString(
1283 schedulerEntryElement.elementText(
1284 "scheduler-event-listener-class"),
1285 schedulerEntry.getEventListenerClass()));
1286
1287 Element triggerElement = schedulerEntryElement.element("trigger");
1288
1289 Element cronElement = triggerElement.element("cron");
1290 Element simpleElement = triggerElement.element("simple");
1291
1292 if (cronElement != null) {
1293 schedulerEntry.setTriggerType(TriggerType.CRON);
1294
1295 Element propertyKeyElement = cronElement.element(
1296 "property-key");
1297
1298 if (propertyKeyElement != null) {
1299 schedulerEntry.setPropertyKey(
1300 propertyKeyElement.getTextTrim());
1301 }
1302 else {
1303 schedulerEntry.setTriggerValue(
1304 cronElement.elementText("cron-trigger-value"));
1305 }
1306 }
1307 else if (simpleElement != null) {
1308 schedulerEntry.setTriggerType(TriggerType.SIMPLE);
1309
1310 Element propertyKeyElement = simpleElement.element(
1311 "property-key");
1312
1313 if (propertyKeyElement != null) {
1314 schedulerEntry.setPropertyKey(
1315 propertyKeyElement.getTextTrim());
1316 }
1317 else {
1318 Element simpleTriggerValueElement = simpleElement.element(
1319 "simple-trigger-value");
1320
1321 schedulerEntry.setTriggerValue(
1322 simpleTriggerValueElement.getTextTrim());
1323 }
1324
1325 String timeUnit = GetterUtil.getString(
1326 simpleElement.elementText("time-unit"),
1327 TimeUnit.SECOND.getValue());
1328
1329 schedulerEntry.setTimeUnit(
1330 TimeUnit.parse(timeUnit.toLowerCase()));
1331 }
1332
1333 portletModel.addSchedulerEntry(schedulerEntry);
1334 }
1335
1336 portletModel.setPortletURLClass(
1337 GetterUtil.getString(
1338 portletElement.elementText("portlet-url-class"),
1339 portletModel.getPortletURLClass()));
1340
1341 portletModel.setFriendlyURLMapperClass(
1342 GetterUtil.getString(
1343 portletElement.elementText("friendly-url-mapper-class"),
1344 portletModel.getFriendlyURLMapperClass()));
1345
1346 if (Validator.isNull(portletModel.getFriendlyURLMapperClass())) {
1347 _friendlyURLMapperPortlets.remove(portletId);
1348 }
1349 else {
1350 _friendlyURLMapperPortlets.put(portletId, portletModel);
1351 }
1352
1353 portletModel.setFriendlyURLMapping(
1354 GetterUtil.getString(
1355 portletElement.elementText("friendly-url-mapping"),
1356 portletModel.getFriendlyURLMapping()));
1357 portletModel.setFriendlyURLRoutes(
1358 GetterUtil.getString(
1359 portletElement.elementText("friendly-url-routes"),
1360 portletModel.getFriendlyURLRoutes()));
1361 portletModel.setURLEncoderClass(
1362 GetterUtil.getString(
1363 portletElement.elementText("url-encoder-class"),
1364 portletModel.getURLEncoderClass()));
1365
1366 String portletDataHandlerClass = GetterUtil.getString(
1367 portletElement.elementText("portlet-data-handler-class"),
1368 portletModel.getPortletDataHandlerClass());
1369
1370 if (Validator.isNull(portletDataHandlerClass)) {
1371 portletDataHandlerClass =
1372 DefaultConfigurationPortletDataHandler.class.getName();
1373 }
1374
1375 portletModel.setPortletDataHandlerClass(portletDataHandlerClass);
1376
1377 List<String> stagedModelDataHandlerClasses = new ArrayList<String>();
1378
1379 for (Element stagedModelDataHandlerClassElement :
1380 portletElement.elements("staged-model-data-handler-class")) {
1381
1382 stagedModelDataHandlerClasses.add(
1383 stagedModelDataHandlerClassElement.getText());
1384 }
1385
1386 portletModel.setStagedModelDataHandlerClasses(
1387 stagedModelDataHandlerClasses);
1388
1389 portletModel.setTemplateHandlerClass(
1390 GetterUtil.getString(
1391 portletElement.elementText("template-handler"),
1392 portletModel.getTemplateHandlerClass()));
1393 portletModel.setPortletLayoutListenerClass(
1394 GetterUtil.getString(
1395 portletElement.elementText("portlet-layout-listener-class"),
1396 portletModel.getPortletLayoutListenerClass()));
1397 portletModel.setPollerProcessorClass(
1398 GetterUtil.getString(
1399 portletElement.elementText("poller-processor-class"),
1400 portletModel.getPollerProcessorClass()));
1401 portletModel.setPopMessageListenerClass(
1402 GetterUtil.getString(
1403 portletElement.elementText("pop-message-listener-class"),
1404 portletModel.getPopMessageListenerClass()));
1405
1406 List<String> socialActivityInterpreterClasses = new ArrayList<String>();
1407
1408 for (Element socialActivityInterpreterClassElement :
1409 portletElement.elements("social-activity-interpreter-class")) {
1410
1411 socialActivityInterpreterClasses.add(
1412 socialActivityInterpreterClassElement.getText());
1413 }
1414
1415 portletModel.setSocialActivityInterpreterClasses(
1416 socialActivityInterpreterClasses);
1417
1418 portletModel.setSocialRequestInterpreterClass(
1419 GetterUtil.getString(
1420 portletElement.elementText("social-request-interpreter-class"),
1421 portletModel.getSocialRequestInterpreterClass()));
1422 portletModel.setUserNotificationDefinitions(
1423 GetterUtil.getString(
1424 portletElement.elementText("user-notification-definitions"),
1425 portletModel.getUserNotificationDefinitions()));
1426
1427 List<String> userNotificationHandlerClasses = new ArrayList<String>();
1428
1429 for (Element userNotificationHandlerClassElement :
1430 portletElement.elements(
1431 "user-notification-handler-class")) {
1432
1433 userNotificationHandlerClasses.add(
1434 userNotificationHandlerClassElement.getText());
1435 }
1436
1437 portletModel.setUserNotificationHandlerClasses(
1438 userNotificationHandlerClasses);
1439
1440 portletModel.setWebDAVStorageToken(
1441 GetterUtil.getString(
1442 portletElement.elementText("webdav-storage-token"),
1443 portletModel.getWebDAVStorageToken()));
1444 portletModel.setWebDAVStorageClass(
1445 GetterUtil.getString(
1446 portletElement.elementText("webdav-storage-class"),
1447 portletModel.getWebDAVStorageClass()));
1448 portletModel.setXmlRpcMethodClass(
1449 GetterUtil.getString(
1450 portletElement.elementText("xml-rpc-method-class"),
1451 portletModel.getXmlRpcMethodClass()));
1452
1453 String controlPanelEntryCategory = GetterUtil.getString(
1454 portletElement.elementText("control-panel-entry-category"),
1455 portletModel.getControlPanelEntryCategory());
1456
1457 if (Validator.equals(controlPanelEntryCategory, "content")) {
1458 controlPanelEntryCategory =
1459 PortletCategoryKeys.SITE_ADMINISTRATION_CONTENT;
1460 }
1461 else if (Validator.equals(controlPanelEntryCategory, "marketplace")) {
1462 controlPanelEntryCategory = PortletCategoryKeys.APPS;
1463 }
1464 else if (Validator.equals(controlPanelEntryCategory, "portal")) {
1465 controlPanelEntryCategory = PortletCategoryKeys.USERS;
1466 }
1467 else if (Validator.equals(controlPanelEntryCategory, "server")) {
1468 controlPanelEntryCategory = PortletCategoryKeys.APPS;
1469 }
1470
1471 portletModel.setControlPanelEntryCategory(controlPanelEntryCategory);
1472
1473 portletModel.setControlPanelEntryWeight(
1474 GetterUtil.getDouble(
1475 portletElement.elementText("control-panel-entry-weight"),
1476 portletModel.getControlPanelEntryWeight()));
1477 portletModel.setControlPanelEntryClass(
1478 GetterUtil.getString(
1479 portletElement.elementText("control-panel-entry-class"),
1480 portletModel.getControlPanelEntryClass()));
1481
1482 List<String> assetRendererFactoryClasses = new ArrayList<String>();
1483
1484 for (Element assetRendererFactoryClassElement :
1485 portletElement.elements("asset-renderer-factory")) {
1486
1487 assetRendererFactoryClasses.add(
1488 assetRendererFactoryClassElement.getText());
1489 }
1490
1491 portletModel.setAssetRendererFactoryClasses(
1492 assetRendererFactoryClasses);
1493
1494 List<String> atomCollectionAdapterClasses = new ArrayList<String>();
1495
1496 for (Element atomCollectionAdapterClassElement :
1497 portletElement.elements("atom-collection-adapter")) {
1498
1499 atomCollectionAdapterClasses.add(
1500 atomCollectionAdapterClassElement.getText());
1501 }
1502
1503 portletModel.setAtomCollectionAdapterClasses(
1504 atomCollectionAdapterClasses);
1505
1506 List<String> customAttributesDisplayClasses = new ArrayList<String>();
1507
1508 for (Element customAttributesDisplayClassElement :
1509 portletElement.elements("custom-attributes-display")) {
1510
1511 customAttributesDisplayClasses.add(
1512 customAttributesDisplayClassElement.getText());
1513 }
1514
1515 portletModel.setCustomAttributesDisplayClasses(
1516 customAttributesDisplayClasses);
1517
1518 if (customAttributesDisplayClasses.isEmpty()) {
1519 _customAttributesDisplayPortlets.remove(portletId);
1520 }
1521 else {
1522 _customAttributesDisplayPortlets.put(portletId, portletModel);
1523 }
1524
1525 portletModel.setDDMDisplayClass(
1526 GetterUtil.getString(
1527 portletElement.elementText("ddm-display"),
1528 portletModel.getDDMDisplayClass()));
1529 portletModel.setPermissionPropagatorClass(
1530 GetterUtil.getString(
1531 portletElement.elementText("permission-propagator"),
1532 portletModel.getPermissionPropagatorClass()));
1533
1534 List<String> trashHandlerClasses = new ArrayList<String>();
1535
1536 for (Element trashHandlerClassElement :
1537 portletElement.elements("trash-handler")) {
1538
1539 trashHandlerClasses.add(trashHandlerClassElement.getText());
1540 }
1541
1542 portletModel.setTrashHandlerClasses(trashHandlerClasses);
1543
1544 List<String> workflowHandlerClasses = new ArrayList<String>();
1545
1546 for (Element workflowHandlerClassElement :
1547 portletElement.elements("workflow-handler")) {
1548
1549 workflowHandlerClasses.add(workflowHandlerClassElement.getText());
1550 }
1551
1552 portletModel.setWorkflowHandlerClasses(workflowHandlerClasses);
1553
1554 portletModel.setPreferencesCompanyWide(
1555 GetterUtil.getBoolean(
1556 portletElement.elementText("preferences-company-wide"),
1557 portletModel.isPreferencesCompanyWide()));
1558 portletModel.setPreferencesUniquePerLayout(
1559 GetterUtil.getBoolean(
1560 portletElement.elementText("preferences-unique-per-layout"),
1561 portletModel.isPreferencesUniquePerLayout()));
1562 portletModel.setPreferencesOwnedByGroup(
1563 GetterUtil.getBoolean(
1564 portletElement.elementText("preferences-owned-by-group"),
1565 portletModel.isPreferencesOwnedByGroup()));
1566 portletModel.setUseDefaultTemplate(
1567 GetterUtil.getBoolean(
1568 portletElement.elementText("use-default-template"),
1569 portletModel.isUseDefaultTemplate()));
1570 portletModel.setShowPortletAccessDenied(
1571 GetterUtil.getBoolean(
1572 portletElement.elementText("show-portlet-access-denied"),
1573 portletModel.isShowPortletAccessDenied()));
1574 portletModel.setShowPortletInactive(
1575 GetterUtil.getBoolean(
1576 portletElement.elementText("show-portlet-inactive"),
1577 portletModel.isShowPortletInactive()));
1578 portletModel.setActionURLRedirect(
1579 GetterUtil.getBoolean(
1580 portletElement.elementText("action-url-redirect"),
1581 portletModel.isActionURLRedirect()));
1582 portletModel.setRestoreCurrentView(
1583 GetterUtil.getBoolean(
1584 portletElement.elementText("restore-current-view"),
1585 portletModel.isRestoreCurrentView()));
1586 portletModel.setMaximizeEdit(
1587 GetterUtil.getBoolean(
1588 portletElement.elementText("maximize-edit"),
1589 portletModel.isMaximizeEdit()));
1590 portletModel.setMaximizeHelp(
1591 GetterUtil.getBoolean(
1592 portletElement.elementText("maximize-help"),
1593 portletModel.isMaximizeHelp()));
1594 portletModel.setPopUpPrint(
1595 GetterUtil.getBoolean(
1596 portletElement.elementText("pop-up-print"),
1597 portletModel.isPopUpPrint()));
1598 portletModel.setLayoutCacheable(
1599 GetterUtil.getBoolean(
1600 portletElement.elementText("layout-cacheable"),
1601 portletModel.isLayoutCacheable()));
1602 portletModel.setInstanceable(
1603 GetterUtil.getBoolean(
1604 portletElement.elementText("instanceable"),
1605 portletModel.isInstanceable()));
1606 portletModel.setRemoteable(
1607 GetterUtil.getBoolean(
1608 portletElement.elementText("remoteable"),
1609 portletModel.isRemoteable()));
1610 portletModel.setScopeable(
1611 GetterUtil.getBoolean(
1612 portletElement.elementText("scopeable"),
1613 portletModel.isScopeable()));
1614 portletModel.setUserPrincipalStrategy(
1615 GetterUtil.getString(
1616 portletElement.elementText("user-principal-strategy"),
1617 portletModel.getUserPrincipalStrategy()));
1618 portletModel.setPrivateRequestAttributes(
1619 GetterUtil.getBoolean(
1620 portletElement.elementText("private-request-attributes"),
1621 portletModel.isPrivateRequestAttributes()));
1622 portletModel.setPrivateSessionAttributes(
1623 GetterUtil.getBoolean(
1624 portletElement.elementText("private-session-attributes"),
1625 portletModel.isPrivateSessionAttributes()));
1626
1627 Element autopropagatedParametersElement = portletElement.element(
1628 "autopropagated-parameters");
1629
1630 Set<String> autopropagatedParameters = new HashSet<String>();
1631
1632 if (autopropagatedParametersElement != null) {
1633 String[] autopropagatedParametersArray = StringUtil.split(
1634 autopropagatedParametersElement.getText());
1635
1636 for (String autopropagatedParameter :
1637 autopropagatedParametersArray) {
1638
1639 autopropagatedParameters.add(autopropagatedParameter);
1640 }
1641 }
1642
1643 portletModel.setAutopropagatedParameters(autopropagatedParameters);
1644
1645 portletModel.setRequiresNamespacedParameters(
1646 GetterUtil.getBoolean(
1647 portletElement.elementText("requires-namespaced-parameters"),
1648 portletModel.isRequiresNamespacedParameters()));
1649 portletModel.setActionTimeout(
1650 GetterUtil.getInteger(
1651 portletElement.elementText("action-timeout"),
1652 portletModel.getActionTimeout()));
1653 portletModel.setRenderTimeout(
1654 GetterUtil.getInteger(
1655 portletElement.elementText("render-timeout"),
1656 portletModel.getRenderTimeout()));
1657 portletModel.setRenderWeight(
1658 GetterUtil.getInteger(
1659 portletElement.elementText("render-weight"),
1660 portletModel.getRenderWeight()));
1661 portletModel.setAjaxable(
1662 GetterUtil.getBoolean(
1663 portletElement.elementText("ajaxable"),
1664 portletModel.isAjaxable()));
1665
1666 List<String> headerPortalCssList = new ArrayList<String>();
1667
1668 for (Element headerPortalCssElement :
1669 portletElement.elements("header-portal-css")) {
1670
1671 headerPortalCssList.add(headerPortalCssElement.getText());
1672 }
1673
1674 portletModel.setHeaderPortalCss(headerPortalCssList);
1675
1676 List<String> headerPortletCssList = new ArrayList<String>();
1677
1678 for (Element headerPortletCssElement :
1679 portletElement.elements("header-portlet-css")) {
1680
1681 headerPortletCssList.add(headerPortletCssElement.getText());
1682 }
1683
1684 portletModel.setHeaderPortletCss(headerPortletCssList);
1685
1686 List<String> headerPortalJavaScriptList = new ArrayList<String>();
1687
1688 for (Element headerPortalJavaScriptElement :
1689 portletElement.elements("header-portal-javascript")) {
1690
1691 headerPortalJavaScriptList.add(
1692 headerPortalJavaScriptElement.getText());
1693 }
1694
1695 portletModel.setHeaderPortalJavaScript(headerPortalJavaScriptList);
1696
1697 List<String> headerPortletJavaScriptList = new ArrayList<String>();
1698
1699 for (Element headerPortletJavaScriptElement :
1700 portletElement.elements("header-portlet-javascript")) {
1701
1702 headerPortletJavaScriptList.add(
1703 headerPortletJavaScriptElement.getText());
1704 }
1705
1706 portletModel.setHeaderPortletJavaScript(headerPortletJavaScriptList);
1707
1708 List<String> footerPortalCssList = new ArrayList<String>();
1709
1710 for (Element footerPortalCssElement :
1711 portletElement.elements("footer-portal-css")) {
1712
1713 footerPortalCssList.add(footerPortalCssElement.getText());
1714 }
1715
1716 portletModel.setFooterPortalCss(footerPortalCssList);
1717
1718 List<String> footerPortletCssList = new ArrayList<String>();
1719
1720 for (Element footerPortletCssElement :
1721 portletElement.elements("footer-portlet-css")) {
1722
1723 footerPortletCssList.add(footerPortletCssElement.getText());
1724 }
1725
1726 portletModel.setFooterPortletCss(footerPortletCssList);
1727
1728 List<String> footerPortalJavaScriptList = new ArrayList<String>();
1729
1730 for (Element footerPortalJavaScriptElement :
1731 portletElement.elements("footer-portal-javascript")) {
1732
1733 footerPortalJavaScriptList.add(
1734 footerPortalJavaScriptElement.getText());
1735 }
1736
1737 portletModel.setFooterPortalJavaScript(footerPortalJavaScriptList);
1738
1739 List<String> footerPortletJavaScriptList = new ArrayList<String>();
1740
1741 for (Element footerPortletJavaScriptElement :
1742 portletElement.elements("footer-portlet-javascript")) {
1743
1744 footerPortletJavaScriptList.add(
1745 footerPortletJavaScriptElement.getText());
1746 }
1747
1748 portletModel.setFooterPortletJavaScript(footerPortletJavaScriptList);
1749
1750 portletModel.setCssClassWrapper(
1751 GetterUtil.getString(
1752 portletElement.elementText("css-class-wrapper"),
1753 portletModel.getCssClassWrapper()));
1754 portletModel.setFacebookIntegration(
1755 GetterUtil.getString(
1756 portletElement.elementText("facebook-integration"),
1757 portletModel.getFacebookIntegration()));
1758 portletModel.setAddDefaultResource(
1759 GetterUtil.getBoolean(
1760 portletElement.elementText("add-default-resource"),
1761 portletModel.isAddDefaultResource()));
1762 portletModel.setSystem(
1763 GetterUtil.getBoolean(
1764 portletElement.elementText("system"), portletModel.isSystem()));
1765 portletModel.setActive(
1766 GetterUtil.getBoolean(
1767 portletElement.elementText("active"), portletModel.isActive()));
1768 portletModel.setInclude(
1769 GetterUtil.getBoolean(portletElement.elementText("include"),
1770 portletModel.isInclude()));
1771
1772 if (Validator.isNull(servletContextName)) {
1773 portletModel.setReady(true);
1774 }
1775
1776 if (!portletModel.isAjaxable() &&
1777 (portletModel.getRenderWeight() < 1)) {
1778
1779 portletModel.setRenderWeight(1);
1780 }
1781
1782 portletModel.getRoleMappers().putAll(roleMappers);
1783 portletModel.linkRoles();
1784 }
1785
1786 private Set<String> _readLiferayPortletXML(
1787 String servletContextName, String xml,
1788 Map<String, Portlet> portletsPool)
1789 throws Exception {
1790
1791 Set<String> liferayPortletIds = new HashSet<String>();
1792
1793 if (xml == null) {
1794 return liferayPortletIds;
1795 }
1796
1797 Document document = SAXReaderUtil.read(xml, true);
1798
1799 Element rootElement = document.getRootElement();
1800
1801 PortletApp portletApp = _getPortletApp(servletContextName);
1802
1803 Map<String, String> roleMappers = new HashMap<String, String>();
1804
1805 for (Element roleMapperElement : rootElement.elements("role-mapper")) {
1806 String roleName = roleMapperElement.elementText("role-name");
1807 String roleLink = roleMapperElement.elementText("role-link");
1808
1809 roleMappers.put(roleName, roleLink);
1810 }
1811
1812 Map<String, String> customUserAttributes =
1813 portletApp.getCustomUserAttributes();
1814
1815 for (Element customUserAttributeElement :
1816 rootElement.elements("custom-user-attribute")) {
1817
1818 String customClass = customUserAttributeElement.elementText(
1819 "custom-class");
1820
1821 for (Element nameElement :
1822 customUserAttributeElement.elements("name")) {
1823
1824 String name = nameElement.getText();
1825
1826 customUserAttributes.put(name, customClass);
1827 }
1828 }
1829
1830 for (Element portletElement : rootElement.elements("portlet")) {
1831 _readLiferayPortletXML(
1832 servletContextName, portletsPool, liferayPortletIds,
1833 roleMappers, portletElement);
1834 }
1835
1836 return liferayPortletIds;
1837 }
1838
1839 private Set<String> _readPortletXML(
1840 ServletContext servletContext, String xml,
1841 Map<String, Portlet> portletsPool, Set<String> servletURLPatterns,
1842 PluginPackage pluginPackage)
1843 throws Exception {
1844
1845 return _readPortletXML(
1846 StringPool.BLANK, servletContext, xml, portletsPool,
1847 servletURLPatterns, pluginPackage);
1848 }
1849
1850 private void _readPortletXML(
1851 String servletContextName, Map<String, Portlet> portletsPool,
1852 PluginPackage pluginPackage, PortletApp portletApp,
1853 Set<String> portletIds, long timestamp, Element portletElement)
1854 throws PortletIdException {
1855
1856 String portletName = portletElement.elementText("portlet-name");
1857
1858 String portletId = portletName;
1859
1860 if (Validator.isNotNull(servletContextName)) {
1861 portletId = portletId.concat(PortletConstants.WAR_SEPARATOR).concat(
1862 servletContextName);
1863 }
1864
1865 portletId = PortalUtil.getJsSafePortletId(portletId);
1866
1867 if (portletId.length() > _PORTLET_ID_MAX_LENGTH) {
1868
1869
1870
1871 throw new PortletIdException(
1872 "Portlet id " + portletId + " has more than " +
1873 _PORTLET_ID_MAX_LENGTH + " characters");
1874 }
1875
1876 if (_log.isDebugEnabled()) {
1877 _log.debug("Reading portlet " + portletId);
1878 }
1879
1880 portletIds.add(portletId);
1881
1882 Portlet portletModel = portletsPool.get(portletId);
1883
1884 if (portletModel == null) {
1885 portletModel = new PortletImpl(CompanyConstants.SYSTEM, portletId);
1886
1887 portletsPool.put(portletId, portletModel);
1888 }
1889
1890 portletModel.setTimestamp(timestamp);
1891
1892 portletModel.setPluginPackage(pluginPackage);
1893 portletModel.setPortletApp(portletApp);
1894
1895 portletModel.setPortletName(portletName);
1896 portletModel.setDisplayName(
1897 GetterUtil.getString(
1898 portletElement.elementText("display-name"),
1899 portletModel.getDisplayName()));
1900 portletModel.setPortletClass(
1901 GetterUtil.getString(portletElement.elementText("portlet-class")));
1902
1903 Map<String, String> initParams = new HashMap<String, String>();
1904
1905 for (Element initParamElement : portletElement.elements("init-param")) {
1906 initParams.put(
1907 initParamElement.elementText("name"),
1908 initParamElement.elementText("value"));
1909 }
1910
1911 portletModel.setInitParams(initParams);
1912
1913 Element expirationCacheElement = portletElement.element(
1914 "expiration-cache");
1915
1916 if (expirationCacheElement != null) {
1917 portletModel.setExpCache(
1918 GetterUtil.getInteger(expirationCacheElement.getText()));
1919 }
1920
1921 Map<String, Set<String>> portletModes =
1922 new HashMap<String, Set<String>>();
1923 Map<String, Set<String>> windowStates =
1924 new HashMap<String, Set<String>>();
1925
1926 for (Element supportsElement : portletElement.elements("supports")) {
1927 String mimeType = supportsElement.elementText("mime-type");
1928
1929 Set<String> mimeTypePortletModes = new HashSet<String>();
1930
1931 mimeTypePortletModes.add(PortletMode.VIEW.toString().toLowerCase());
1932
1933 for (Element portletModeElement :
1934 supportsElement.elements("portlet-mode")) {
1935
1936 mimeTypePortletModes.add(
1937 portletModeElement.getTextTrim().toLowerCase());
1938 }
1939
1940 portletModes.put(mimeType, mimeTypePortletModes);
1941
1942 Set<String> mimeTypeWindowStates = new HashSet<String>();
1943
1944 mimeTypeWindowStates.add(
1945 WindowState.NORMAL.toString().toLowerCase());
1946
1947 List<Element> windowStateElements = supportsElement.elements(
1948 "window-state");
1949
1950 if (windowStateElements.isEmpty()) {
1951 mimeTypeWindowStates.add(
1952 WindowState.MAXIMIZED.toString().toLowerCase());
1953 mimeTypeWindowStates.add(
1954 WindowState.MINIMIZED.toString().toLowerCase());
1955 mimeTypeWindowStates.add(
1956 LiferayWindowState.EXCLUSIVE.toString().toLowerCase());
1957 mimeTypeWindowStates.add(
1958 LiferayWindowState.POP_UP.toString().toLowerCase());
1959 }
1960
1961 for (Element windowStateElement : windowStateElements) {
1962 mimeTypeWindowStates.add(
1963 windowStateElement.getTextTrim().toLowerCase());
1964 }
1965
1966 windowStates.put(mimeType, mimeTypeWindowStates);
1967 }
1968
1969 portletModel.setPortletModes(portletModes);
1970 portletModel.setWindowStates(windowStates);
1971
1972 Set<String> supportedLocales = new HashSet<String>();
1973
1974
1975
1976
1977 for (Element supportedLocaleElement : portletElement.elements(
1978 "supported-locale")) {
1979
1980 String supportedLocale = supportedLocaleElement.getText();
1981
1982 supportedLocales.add(supportedLocale);
1983 }
1984
1985 portletModel.setSupportedLocales(supportedLocales);
1986
1987 portletModel.setResourceBundle(
1988 portletElement.elementText("resource-bundle"));
1989
1990 Element portletInfoElement = portletElement.element("portlet-info");
1991
1992 String portletInfoTitle = null;
1993 String portletInfoShortTitle = null;
1994 String portletInfoKeyWords = null;
1995 String portletInfoDescription = null;
1996
1997 if (portletInfoElement != null) {
1998 portletInfoTitle = portletInfoElement.elementText("title");
1999 portletInfoShortTitle = portletInfoElement.elementText(
2000 "short-title");
2001 portletInfoKeyWords = portletInfoElement.elementText("keywords");
2002 }
2003
2004 PortletInfo portletInfo = new PortletInfo(
2005 portletInfoTitle, portletInfoShortTitle, portletInfoKeyWords,
2006 portletInfoDescription);
2007
2008 portletModel.setPortletInfo(portletInfo);
2009
2010 Element portletPreferencesElement = portletElement.element(
2011 "portlet-preferences");
2012
2013 String defaultPreferences = null;
2014 String preferencesValidator = null;
2015
2016 if (portletPreferencesElement != null) {
2017 Element preferencesValidatorElement =
2018 portletPreferencesElement.element("preferences-validator");
2019
2020 if (preferencesValidatorElement != null) {
2021 preferencesValidator = preferencesValidatorElement.getText();
2022
2023 portletPreferencesElement.remove(preferencesValidatorElement);
2024 }
2025
2026 defaultPreferences = portletPreferencesElement.asXML();
2027 }
2028
2029 portletModel.setDefaultPreferences(defaultPreferences);
2030 portletModel.setPreferencesValidator(preferencesValidator);
2031
2032 if (!portletApp.isWARFile() &&
2033 Validator.isNotNull(preferencesValidator) &&
2034 PropsValues.PREFERENCE_VALIDATE_ON_STARTUP) {
2035
2036 try {
2037 PreferencesValidator preferencesValidatorObj =
2038 PortalUtil.getPreferencesValidator(portletModel);
2039
2040 preferencesValidatorObj.validate(
2041 PortletPreferencesFactoryUtil.fromDefaultXML(
2042 defaultPreferences));
2043 }
2044 catch (Exception e) {
2045 if (_log.isWarnEnabled()) {
2046 _log.warn(
2047 "Portlet with the name " + portletId +
2048 " does not have valid default preferences");
2049 }
2050 }
2051 }
2052
2053 Set<String> unlinkedRoles = new HashSet<String>();
2054
2055 for (Element roleElement :
2056 portletElement.elements("security-role-ref")) {
2057
2058 unlinkedRoles.add(roleElement.elementText("role-name"));
2059 }
2060
2061 portletModel.setUnlinkedRoles(unlinkedRoles);
2062
2063 Set<QName> processingEvents = new HashSet<QName>();
2064
2065 for (Element supportedProcessingEventElement :
2066 portletElement.elements("supported-processing-event")) {
2067
2068 Element qNameElement = supportedProcessingEventElement.element(
2069 "qname");
2070 Element nameElement = supportedProcessingEventElement.element(
2071 "name");
2072
2073 QName qName = PortletQNameUtil.getQName(
2074 qNameElement, nameElement, portletApp.getDefaultNamespace());
2075
2076 processingEvents.add(qName);
2077
2078 Set<EventDefinition> eventDefinitions =
2079 portletApp.getEventDefinitions();
2080
2081 for (EventDefinition eventDefinition : eventDefinitions) {
2082 Set<QName> qNames = eventDefinition.getQNames();
2083
2084 if (qNames.contains(qName)) {
2085 processingEvents.addAll(qNames);
2086 }
2087 }
2088 }
2089
2090 portletModel.setProcessingEvents(processingEvents);
2091
2092 Set<QName> publishingEvents = new HashSet<QName>();
2093
2094 for (Element supportedPublishingEventElement :
2095 portletElement.elements("supported-publishing-event")) {
2096
2097 Element qNameElement = supportedPublishingEventElement.element(
2098 "qname");
2099 Element nameElement = supportedPublishingEventElement.element(
2100 "name");
2101
2102 QName qName = PortletQNameUtil.getQName(
2103 qNameElement, nameElement, portletApp.getDefaultNamespace());
2104
2105 publishingEvents.add(qName);
2106 }
2107
2108 portletModel.setPublishingEvents(publishingEvents);
2109
2110 Set<PublicRenderParameter> publicRenderParameters =
2111 new HashSet<PublicRenderParameter>();
2112
2113 for (Element supportedPublicRenderParameter :
2114 portletElement.elements("supported-public-render-parameter")) {
2115
2116 String identifier = supportedPublicRenderParameter.getTextTrim();
2117
2118 PublicRenderParameter publicRenderParameter =
2119 portletApp.getPublicRenderParameter(identifier);
2120
2121 if (publicRenderParameter == null) {
2122 _log.error(
2123 "Supported public render parameter references " +
2124 "unnknown identifier " + identifier);
2125
2126 continue;
2127 }
2128
2129 publicRenderParameters.add(publicRenderParameter);
2130 }
2131
2132 portletModel.setPublicRenderParameters(publicRenderParameters);
2133 }
2134
2135 private Set<String> _readPortletXML(
2136 String servletContextName, ServletContext servletContext,
2137 String xml, Map<String, Portlet> portletsPool,
2138 Set<String> servletURLPatterns, PluginPackage pluginPackage)
2139 throws Exception {
2140
2141 Set<String> portletIds = new HashSet<String>();
2142
2143 if (xml == null) {
2144 return portletIds;
2145 }
2146
2147 Document document = SAXReaderUtil.read(
2148 xml, PropsValues.PORTLET_XML_VALIDATE);
2149
2150 Element rootElement = document.getRootElement();
2151
2152 PortletApp portletApp = _getPortletApp(servletContextName);
2153
2154 portletApp.addServletURLPatterns(servletURLPatterns);
2155
2156 Set<String> userAttributes = portletApp.getUserAttributes();
2157
2158 for (Element userAttributeElement :
2159 rootElement.elements("user-attribute")) {
2160
2161 String name = userAttributeElement.elementText("name");
2162
2163 userAttributes.add(name);
2164 }
2165
2166 String defaultNamespace = rootElement.elementText("default-namespace");
2167
2168 if (Validator.isNotNull(defaultNamespace)) {
2169 portletApp.setDefaultNamespace(defaultNamespace);
2170 }
2171
2172 for (Element eventDefinitionElement :
2173 rootElement.elements("event-definition")) {
2174
2175 Element qNameElement = eventDefinitionElement.element("qname");
2176 Element nameElement = eventDefinitionElement.element("name");
2177 String valueType = eventDefinitionElement.elementText("value-type");
2178
2179 QName qName = PortletQNameUtil.getQName(
2180 qNameElement, nameElement, portletApp.getDefaultNamespace());
2181
2182 EventDefinition eventDefinition = new EventDefinitionImpl(
2183 qName, valueType, portletApp);
2184
2185 List<Element> aliases = eventDefinitionElement.elements("alias");
2186
2187 for (Element alias : aliases) {
2188 qName = PortletQNameUtil.getQName(
2189 alias, null, portletApp.getDefaultNamespace());
2190
2191 eventDefinition.addAliasQName(qName);
2192 }
2193
2194 portletApp.addEventDefinition(eventDefinition);
2195 }
2196
2197 for (Element publicRenderParameterElement :
2198 rootElement.elements("public-render-parameter")) {
2199
2200 String identifier = publicRenderParameterElement.elementText(
2201 "identifier");
2202 Element qNameElement = publicRenderParameterElement.element(
2203 "qname");
2204 Element nameElement = publicRenderParameterElement.element("name");
2205
2206 QName qName = PortletQNameUtil.getQName(
2207 qNameElement, nameElement, portletApp.getDefaultNamespace());
2208
2209 PublicRenderParameter publicRenderParameter =
2210 new PublicRenderParameterImpl(identifier, qName, portletApp);
2211
2212 portletApp.addPublicRenderParameter(publicRenderParameter);
2213 }
2214
2215 for (Element containerRuntimeOptionElement :
2216 rootElement.elements("container-runtime-option")) {
2217
2218 String name = GetterUtil.getString(
2219 containerRuntimeOptionElement.elementText("name"));
2220
2221 List<String> values = new ArrayList<String>();
2222
2223 for (Element valueElement :
2224 containerRuntimeOptionElement.elements("value")) {
2225
2226 values.add(valueElement.getTextTrim());
2227 }
2228
2229 Map<String, String[]> containerRuntimeOptions =
2230 portletApp.getContainerRuntimeOptions();
2231
2232 containerRuntimeOptions.put(
2233 name, values.toArray(new String[values.size()]));
2234
2235 if (name.equals(
2236 LiferayPortletConfig.RUNTIME_OPTION_PORTAL_CONTEXT) &&
2237 !values.isEmpty() && GetterUtil.getBoolean(values.get(0))) {
2238
2239 portletApp.setWARFile(false);
2240 }
2241 }
2242
2243 long timestamp = ServletContextUtil.getLastModified(servletContext);
2244
2245 for (Element portletElement : rootElement.elements("portlet")) {
2246 _readPortletXML(
2247 servletContextName, portletsPool, pluginPackage, portletApp,
2248 portletIds, timestamp, portletElement);
2249 }
2250
2251 for (Element filterElement : rootElement.elements("filter")) {
2252 String filterName = filterElement.elementText("filter-name");
2253 String filterClass = filterElement.elementText("filter-class");
2254
2255 Set<String> lifecycles = new LinkedHashSet<String>();
2256
2257 for (Element lifecycleElement :
2258 filterElement.elements("lifecycle")) {
2259
2260 lifecycles.add(lifecycleElement.getText());
2261 }
2262
2263 Map<String, String> initParams = new HashMap<String, String>();
2264
2265 for (Element initParamElement :
2266 filterElement.elements("init-param")) {
2267
2268 initParams.put(
2269 initParamElement.elementText("name"),
2270 initParamElement.elementText("value"));
2271 }
2272
2273 PortletFilter portletFilter = new PortletFilterImpl(
2274 filterName, filterClass, lifecycles, initParams, portletApp);
2275
2276 portletApp.addPortletFilter(portletFilter);
2277 }
2278
2279 for (Element filterMappingElement :
2280 rootElement.elements("filter-mapping")) {
2281
2282 String filterName = filterMappingElement.elementText("filter-name");
2283
2284 for (Element portletNameElement :
2285 filterMappingElement.elements("portlet-name")) {
2286
2287 String portletName = portletNameElement.getTextTrim();
2288
2289 PortletFilter portletFilter = portletApp.getPortletFilter(
2290 filterName);
2291
2292 if (portletFilter == null) {
2293 _log.error(
2294 "Filter mapping references unnknown filter name " +
2295 filterName);
2296
2297 continue;
2298 }
2299
2300 List<Portlet> portletModels = _getPortletsByPortletName(
2301 portletName, servletContextName, portletsPool);
2302
2303 if (portletModels.size() == 0) {
2304 _log.error(
2305 "Filter mapping with filter name " + filterName +
2306 " references unnknown portlet name " + portletName);
2307 }
2308
2309 for (Portlet portletModel : portletModels) {
2310 portletModel.getPortletFilters().put(
2311 filterName, portletFilter);
2312 }
2313 }
2314 }
2315
2316 for (Element listenerElement : rootElement.elements("listener")) {
2317 String listenerClass = listenerElement.elementText(
2318 "listener-class");
2319
2320 PortletURLListener portletURLListener = new PortletURLListenerImpl(
2321 listenerClass, portletApp);
2322
2323 portletApp.addPortletURLListener(portletURLListener);
2324 }
2325
2326 return portletIds;
2327 }
2328
2329 private Set<String> _readWebXML(String xml) throws Exception {
2330 Set<String> servletURLPatterns = new LinkedHashSet<String>();
2331
2332 if (xml == null) {
2333 return servletURLPatterns;
2334 }
2335
2336 Document document = SAXReaderUtil.read(xml);
2337
2338 Element rootElement = document.getRootElement();
2339
2340 for (Element servletMappingElement :
2341 rootElement.elements("servlet-mapping")) {
2342
2343 String urlPattern = servletMappingElement.elementText(
2344 "url-pattern");
2345
2346 servletURLPatterns.add(urlPattern);
2347 }
2348
2349 return servletURLPatterns;
2350 }
2351
2352 private void _setSpriteImages(
2353 ServletContext servletContext, PortletApp portletApp,
2354 String resourcePath)
2355 throws Exception {
2356
2357 Set<String> resourcePaths = servletContext.getResourcePaths(
2358 resourcePath);
2359
2360 if ((resourcePaths == null) || resourcePaths.isEmpty()) {
2361 return;
2362 }
2363
2364 List<URL> imageURLs = new ArrayList<URL>(resourcePaths.size());
2365
2366 for (String curResourcePath : resourcePaths) {
2367 if (curResourcePath.endsWith(StringPool.SLASH)) {
2368 _setSpriteImages(servletContext, portletApp, curResourcePath);
2369 }
2370 else if (curResourcePath.endsWith(".png")) {
2371 URL imageURL = servletContext.getResource(curResourcePath);
2372
2373 if (imageURL != null) {
2374 imageURLs.add(imageURL);
2375 }
2376 else {
2377 _log.error(
2378 "Resource URL for " + curResourcePath + " is null");
2379 }
2380 }
2381 }
2382
2383 String spriteRootDirName = PropsValues.SPRITE_ROOT_DIR;
2384 String spriteFileName = resourcePath.concat(
2385 PropsValues.SPRITE_FILE_NAME);
2386 String spritePropertiesFileName = resourcePath.concat(
2387 PropsValues.SPRITE_PROPERTIES_FILE_NAME);
2388 String rootPath = ServletContextUtil.getRootPath(servletContext);
2389
2390 Properties spriteProperties = SpriteProcessorUtil.generate(
2391 servletContext, imageURLs, spriteRootDirName, spriteFileName,
2392 spritePropertiesFileName, rootPath, 16, 16, 10240);
2393
2394 if (spriteProperties == null) {
2395 return;
2396 }
2397
2398 String contextPath = ContextPathUtil.getContextPath(servletContext);
2399
2400 spriteFileName = contextPath.concat(SpriteProcessor.PATH).concat(
2401 spriteFileName);
2402
2403 portletApp.setSpriteImages(spriteFileName, spriteProperties);
2404 }
2405
2406 private static final int _PORTLET_ID_MAX_LENGTH =
2407 ModelHintsUtil.getMaxLength(Portlet.class.getName(), "portletId") -
2408 PortletConstants.INSTANCE_SEPARATOR.length() +
2409 PortletConstants.USER_SEPARATOR.length() + 39;
2410
2411 private static Log _log = LogFactoryUtil.getLog(
2412 PortletLocalServiceImpl.class);
2413
2414 private static Map<Long, Map<String, Portlet>> _companyPortletsPool =
2415 new ConcurrentHashMap<Long, Map<String, Portlet>>();
2416 private static Map<String, Portlet> _customAttributesDisplayPortlets =
2417 new ConcurrentHashMap<String, Portlet>();
2418 private static Map<String, Portlet> _friendlyURLMapperPortlets =
2419 new ConcurrentHashMap<String, Portlet>();
2420 private static Map<String, PortletApp> _portletAppsPool =
2421 new ConcurrentHashMap<String, PortletApp>();
2422 private static Map<String, String> _portletIdsByStrutsPath =
2423 new ConcurrentHashMap<String, String>();
2424 private static Map<String, Portlet> _portletsPool =
2425 new ConcurrentHashMap<String, Portlet>();
2426
2427 }