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