001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
013     */
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    /**
109     * @author Brian Wing Shun Chan
110     * @author Raymond Aug??
111     * @author Eduardo Lundgren
112     * @author Wesley Gong
113     * @author Shuyang Zhou
114     */
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                    // Refresh security path to portlet id mapping for all portlets
202    
203                    _portletIdsByStrutsPath.clear();
204    
205                    // Refresh company portlets
206    
207                    portletLocalService.clearCompanyPortletsPool();
208            }
209    
210            @Clusterable
211            @Override
212            @Transactional(enabled = false)
213            public void clearCompanyPortletsPool() {
214                    _companyPortletsPool.clear();
215            }
216    
217            /**
218             * @deprecated As of 6.1.0, replaced by {@link #clonePortlet(String)}
219             */
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                    // Clear pools every time initEAR is called. See LEP-5452.
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                                    servletContext, xmls[2], portletsPool);
704    
705                            liferayPortletIds.addAll(
706                                    _readLiferayPortletXML(servletContext, xmls[3], portletsPool));
707    
708                            // Check for missing entries in liferay-portlet.xml
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                            // Check for missing entries in portlet.xml
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                            // Remove portlets that should not be included
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                            // Sprite images
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, servletContext, xmls[2], portletsPool);
789    
790                            // Check for missing entries in liferay-portlet.xml
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                            // Check for missing entries in portlet.xml
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                            // Return the new portlets
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                            // Sprite images
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                            // The Upgrade scripts sometimes try to access portlet preferences
854                            // before the portal's been initialized. Return an empty pool.
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                            // Portlet may be null if it exists in the database but its portlet
873                            // WAR is not yet loaded
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                    // Portlets that do not belong to any categories should default to the
1137                    // Undefined category
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                            ServletContext servletContext, String xml,
1177                            Map<String, Portlet> portletsPool)
1178                    throws Exception {
1179    
1180                    return _readLiferayPortletXML(
1181                            StringPool.BLANK, servletContext, xml, portletsPool);
1182            }
1183    
1184            private void _readLiferayPortletXML(
1185                    String servletContextName, ServletContext servletContext,
1186                    Map<String, Portlet> portletsPool, Set<String> liferayPortletIds,
1187                    Map<String, String> roleMappers, Element portletElement) {
1188    
1189                    String portletId = portletElement.elementText("portlet-name");
1190    
1191                    if (Validator.isNotNull(servletContextName)) {
1192                            portletId = portletId.concat(PortletConstants.WAR_SEPARATOR).concat(
1193                                    servletContextName);
1194                    }
1195    
1196                    portletId = PortalUtil.getJsSafePortletId(portletId);
1197    
1198                    if (_log.isDebugEnabled()) {
1199                            _log.debug("Reading portlet extension " + portletId);
1200                    }
1201    
1202                    liferayPortletIds.add(portletId);
1203    
1204                    Portlet portletModel = portletsPool.get(portletId);
1205    
1206                    if (portletModel == null) {
1207                            return;
1208                    }
1209    
1210                    portletModel.setIcon(
1211                            GetterUtil.getString(
1212                                    portletElement.elementText("icon"), portletModel.getIcon()));
1213                    portletModel.setVirtualPath(
1214                            GetterUtil.getString(
1215                                    portletElement.elementText("virtual-path"),
1216                                    portletModel.getVirtualPath()));
1217                    portletModel.setStrutsPath(
1218                            GetterUtil.getString(
1219                                    portletElement.elementText("struts-path"),
1220                                    portletModel.getStrutsPath()));
1221    
1222                    String strutsPath = portletModel.getStrutsPath();
1223    
1224                    if (Validator.isNotNull(strutsPath)) {
1225                            if (_portletIdsByStrutsPath.containsKey(strutsPath)) {
1226                                    String strutsPathPortletId = _portletIdsByStrutsPath.get(
1227                                            strutsPath);
1228    
1229                                    if (!strutsPathPortletId.equals(portletId)) {
1230                                            if (_log.isWarnEnabled()) {
1231                                                    _log.warn("Duplicate struts path " + strutsPath);
1232                                            }
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(StringUtil.toLowerCase(timeUnit)));
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                    boolean defaultRequiresNamespacedParameters = GetterUtil.getBoolean(
1646                            servletContext.getInitParameter(
1647                                    "com.liferay.portlet.requires-namespaced-parameters"),
1648                            portletModel.isRequiresNamespacedParameters());
1649    
1650                    portletModel.setRequiresNamespacedParameters(
1651                            GetterUtil.getBoolean(
1652                                    portletElement.elementText("requires-namespaced-parameters"),
1653                                    defaultRequiresNamespacedParameters));
1654    
1655                    portletModel.setActionTimeout(
1656                            GetterUtil.getInteger(
1657                                    portletElement.elementText("action-timeout"),
1658                                    portletModel.getActionTimeout()));
1659                    portletModel.setRenderTimeout(
1660                            GetterUtil.getInteger(
1661                                    portletElement.elementText("render-timeout"),
1662                                    portletModel.getRenderTimeout()));
1663                    portletModel.setRenderWeight(
1664                            GetterUtil.getInteger(
1665                                    portletElement.elementText("render-weight"),
1666                                    portletModel.getRenderWeight()));
1667                    portletModel.setAjaxable(
1668                            GetterUtil.getBoolean(
1669                                    portletElement.elementText("ajaxable"),
1670                                    portletModel.isAjaxable()));
1671    
1672                    List<String> headerPortalCssList = new ArrayList<String>();
1673    
1674                    for (Element headerPortalCssElement :
1675                                    portletElement.elements("header-portal-css")) {
1676    
1677                            headerPortalCssList.add(headerPortalCssElement.getText());
1678                    }
1679    
1680                    portletModel.setHeaderPortalCss(headerPortalCssList);
1681    
1682                    List<String> headerPortletCssList = new ArrayList<String>();
1683    
1684                    for (Element headerPortletCssElement :
1685                                    portletElement.elements("header-portlet-css")) {
1686    
1687                            headerPortletCssList.add(headerPortletCssElement.getText());
1688                    }
1689    
1690                    portletModel.setHeaderPortletCss(headerPortletCssList);
1691    
1692                    List<String> headerPortalJavaScriptList = new ArrayList<String>();
1693    
1694                    for (Element headerPortalJavaScriptElement :
1695                                    portletElement.elements("header-portal-javascript")) {
1696    
1697                            headerPortalJavaScriptList.add(
1698                                    headerPortalJavaScriptElement.getText());
1699                    }
1700    
1701                    portletModel.setHeaderPortalJavaScript(headerPortalJavaScriptList);
1702    
1703                    List<String> headerPortletJavaScriptList = new ArrayList<String>();
1704    
1705                    for (Element headerPortletJavaScriptElement :
1706                                    portletElement.elements("header-portlet-javascript")) {
1707    
1708                            headerPortletJavaScriptList.add(
1709                                    headerPortletJavaScriptElement.getText());
1710                    }
1711    
1712                    portletModel.setHeaderPortletJavaScript(headerPortletJavaScriptList);
1713    
1714                    List<String> footerPortalCssList = new ArrayList<String>();
1715    
1716                    for (Element footerPortalCssElement :
1717                                    portletElement.elements("footer-portal-css")) {
1718    
1719                            footerPortalCssList.add(footerPortalCssElement.getText());
1720                    }
1721    
1722                    portletModel.setFooterPortalCss(footerPortalCssList);
1723    
1724                    List<String> footerPortletCssList = new ArrayList<String>();
1725    
1726                    for (Element footerPortletCssElement :
1727                                    portletElement.elements("footer-portlet-css")) {
1728    
1729                            footerPortletCssList.add(footerPortletCssElement.getText());
1730                    }
1731    
1732                    portletModel.setFooterPortletCss(footerPortletCssList);
1733    
1734                    List<String> footerPortalJavaScriptList = new ArrayList<String>();
1735    
1736                    for (Element footerPortalJavaScriptElement :
1737                                    portletElement.elements("footer-portal-javascript")) {
1738    
1739                            footerPortalJavaScriptList.add(
1740                                    footerPortalJavaScriptElement.getText());
1741                    }
1742    
1743                    portletModel.setFooterPortalJavaScript(footerPortalJavaScriptList);
1744    
1745                    List<String> footerPortletJavaScriptList = new ArrayList<String>();
1746    
1747                    for (Element footerPortletJavaScriptElement :
1748                                    portletElement.elements("footer-portlet-javascript")) {
1749    
1750                            footerPortletJavaScriptList.add(
1751                                    footerPortletJavaScriptElement.getText());
1752                    }
1753    
1754                    portletModel.setFooterPortletJavaScript(footerPortletJavaScriptList);
1755    
1756                    portletModel.setCssClassWrapper(
1757                            GetterUtil.getString(
1758                                    portletElement.elementText("css-class-wrapper"),
1759                                    portletModel.getCssClassWrapper()));
1760                    portletModel.setFacebookIntegration(
1761                            GetterUtil.getString(
1762                                    portletElement.elementText("facebook-integration"),
1763                                    portletModel.getFacebookIntegration()));
1764                    portletModel.setAddDefaultResource(
1765                            GetterUtil.getBoolean(
1766                                    portletElement.elementText("add-default-resource"),
1767                                    portletModel.isAddDefaultResource()));
1768                    portletModel.setSystem(
1769                            GetterUtil.getBoolean(
1770                                    portletElement.elementText("system"), portletModel.isSystem()));
1771                    portletModel.setActive(
1772                            GetterUtil.getBoolean(
1773                                    portletElement.elementText("active"), portletModel.isActive()));
1774                    portletModel.setInclude(
1775                            GetterUtil.getBoolean(portletElement.elementText("include"),
1776                            portletModel.isInclude()));
1777    
1778                    if (Validator.isNull(servletContextName)) {
1779                            portletModel.setReady(true);
1780                    }
1781    
1782                    if (!portletModel.isAjaxable() &&
1783                            (portletModel.getRenderWeight() < 1)) {
1784    
1785                            portletModel.setRenderWeight(1);
1786                    }
1787    
1788                    portletModel.getRoleMappers().putAll(roleMappers);
1789                    portletModel.linkRoles();
1790            }
1791    
1792            private Set<String> _readLiferayPortletXML(
1793                            String servletContextName, ServletContext servletContext,
1794                            String xml, Map<String, Portlet> portletsPool)
1795                    throws Exception {
1796    
1797                    Set<String> liferayPortletIds = new HashSet<String>();
1798    
1799                    if (xml == null) {
1800                            return liferayPortletIds;
1801                    }
1802    
1803                    Document document = UnsecureSAXReaderUtil.read(xml, true);
1804    
1805                    Element rootElement = document.getRootElement();
1806    
1807                    PortletApp portletApp = _getPortletApp(servletContextName);
1808    
1809                    Map<String, String> roleMappers = new HashMap<String, String>();
1810    
1811                    for (Element roleMapperElement : rootElement.elements("role-mapper")) {
1812                            String roleName = roleMapperElement.elementText("role-name");
1813                            String roleLink = roleMapperElement.elementText("role-link");
1814    
1815                            roleMappers.put(roleName, roleLink);
1816                    }
1817    
1818                    Map<String, String> customUserAttributes =
1819                            portletApp.getCustomUserAttributes();
1820    
1821                    for (Element customUserAttributeElement :
1822                                    rootElement.elements("custom-user-attribute")) {
1823    
1824                            String customClass = customUserAttributeElement.elementText(
1825                                    "custom-class");
1826    
1827                            for (Element nameElement :
1828                                            customUserAttributeElement.elements("name")) {
1829    
1830                                    String name = nameElement.getText();
1831    
1832                                    customUserAttributes.put(name, customClass);
1833                            }
1834                    }
1835    
1836                    for (Element portletElement : rootElement.elements("portlet")) {
1837                            _readLiferayPortletXML(
1838                                    servletContextName, servletContext, portletsPool,
1839                                    liferayPortletIds, roleMappers, portletElement);
1840                    }
1841    
1842                    return liferayPortletIds;
1843            }
1844    
1845            private Set<String> _readPortletXML(
1846                            ServletContext servletContext, String xml,
1847                            Map<String, Portlet> portletsPool, Set<String> servletURLPatterns,
1848                            PluginPackage pluginPackage)
1849                    throws Exception {
1850    
1851                    return _readPortletXML(
1852                            StringPool.BLANK, servletContext, xml, portletsPool,
1853                            servletURLPatterns, pluginPackage);
1854            }
1855    
1856            private void _readPortletXML(
1857                            String servletContextName, Map<String, Portlet> portletsPool,
1858                            PluginPackage pluginPackage, PortletApp portletApp,
1859                            Set<String> portletIds, Element portletElement)
1860                    throws PortletIdException {
1861    
1862                    String portletName = portletElement.elementText("portlet-name");
1863    
1864                    String portletId = portletName;
1865    
1866                    if (Validator.isNotNull(servletContextName)) {
1867                            portletId = portletId.concat(PortletConstants.WAR_SEPARATOR).concat(
1868                                    servletContextName);
1869                    }
1870    
1871                    portletId = PortalUtil.getJsSafePortletId(portletId);
1872    
1873                    if (portletId.length() > _PORTLET_ID_MAX_LENGTH) {
1874    
1875                            // LPS-32878
1876    
1877                            throw new PortletIdException(
1878                                    "Portlet id " + portletId + " has more than " +
1879                                            _PORTLET_ID_MAX_LENGTH + " characters");
1880                    }
1881    
1882                    if (_log.isDebugEnabled()) {
1883                            _log.debug("Reading portlet " + portletId);
1884                    }
1885    
1886                    portletIds.add(portletId);
1887    
1888                    Portlet portletModel = portletsPool.get(portletId);
1889    
1890                    if (portletModel == null) {
1891                            portletModel = new PortletImpl(CompanyConstants.SYSTEM, portletId);
1892    
1893                            portletsPool.put(portletId, portletModel);
1894                    }
1895    
1896                    portletModel.setPluginPackage(pluginPackage);
1897                    portletModel.setPortletApp(portletApp);
1898    
1899                    portletModel.setPortletName(portletName);
1900                    portletModel.setDisplayName(
1901                            GetterUtil.getString(
1902                                    portletElement.elementText("display-name"),
1903                                    portletModel.getDisplayName()));
1904                    portletModel.setPortletClass(
1905                            GetterUtil.getString(portletElement.elementText("portlet-class")));
1906    
1907                    Map<String, String> initParams = new HashMap<String, String>();
1908    
1909                    for (Element initParamElement : portletElement.elements("init-param")) {
1910                            initParams.put(
1911                                    initParamElement.elementText("name"),
1912                                    initParamElement.elementText("value"));
1913                    }
1914    
1915                    portletModel.setInitParams(initParams);
1916    
1917                    Element expirationCacheElement = portletElement.element(
1918                            "expiration-cache");
1919    
1920                    if (expirationCacheElement != null) {
1921                            portletModel.setExpCache(
1922                                    GetterUtil.getInteger(expirationCacheElement.getText()));
1923                    }
1924    
1925                    Map<String, Set<String>> portletModes =
1926                            new HashMap<String, Set<String>>();
1927                    Map<String, Set<String>> windowStates =
1928                            new HashMap<String, Set<String>>();
1929    
1930                    for (Element supportsElement : portletElement.elements("supports")) {
1931                            String mimeType = supportsElement.elementText("mime-type");
1932    
1933                            Set<String> mimeTypePortletModes = new HashSet<String>();
1934    
1935                            mimeTypePortletModes.add(
1936                                    StringUtil.toLowerCase(PortletMode.VIEW.toString()));
1937    
1938                            for (Element portletModeElement :
1939                                            supportsElement.elements("portlet-mode")) {
1940    
1941                                    mimeTypePortletModes.add(
1942                                            StringUtil.toLowerCase(portletModeElement.getTextTrim()));
1943                            }
1944    
1945                            portletModes.put(mimeType, mimeTypePortletModes);
1946    
1947                            Set<String> mimeTypeWindowStates = new HashSet<String>();
1948    
1949                            mimeTypeWindowStates.add(
1950                                    StringUtil.toLowerCase(WindowState.NORMAL.toString()));
1951    
1952                            List<Element> windowStateElements = supportsElement.elements(
1953                                    "window-state");
1954    
1955                            if (windowStateElements.isEmpty()) {
1956                                    mimeTypeWindowStates.add(
1957                                            StringUtil.toLowerCase(WindowState.MAXIMIZED.toString()));
1958                                    mimeTypeWindowStates.add(
1959                                            StringUtil.toLowerCase(WindowState.MINIMIZED.toString()));
1960                                    mimeTypeWindowStates.add(
1961                                            StringUtil.toLowerCase(
1962                                                    LiferayWindowState.EXCLUSIVE.toString()));
1963                                    mimeTypeWindowStates.add(
1964                                            StringUtil.toLowerCase(
1965                                                    LiferayWindowState.POP_UP.toString()));
1966                            }
1967    
1968                            for (Element windowStateElement : windowStateElements) {
1969                                    mimeTypeWindowStates.add(
1970                                            StringUtil.toLowerCase(windowStateElement.getTextTrim()));
1971                            }
1972    
1973                            windowStates.put(mimeType, mimeTypeWindowStates);
1974                    }
1975    
1976                    portletModel.setPortletModes(portletModes);
1977                    portletModel.setWindowStates(windowStates);
1978    
1979                    Set<String> supportedLocales = new HashSet<String>();
1980    
1981                    //supportedLocales.add(
1982                    //        LocaleUtil.toLanguageId(LocaleUtil.getDefault()));
1983    
1984                    for (Element supportedLocaleElement : portletElement.elements(
1985                                    "supported-locale")) {
1986    
1987                            String supportedLocale = supportedLocaleElement.getText();
1988    
1989                            supportedLocales.add(supportedLocale);
1990                    }
1991    
1992                    portletModel.setSupportedLocales(supportedLocales);
1993    
1994                    portletModel.setResourceBundle(
1995                            portletElement.elementText("resource-bundle"));
1996    
1997                    Element portletInfoElement = portletElement.element("portlet-info");
1998    
1999                    String portletInfoTitle = null;
2000                    String portletInfoShortTitle = null;
2001                    String portletInfoKeyWords = null;
2002                    String portletInfoDescription = null;
2003    
2004                    if (portletInfoElement != null) {
2005                            portletInfoTitle = portletInfoElement.elementText("title");
2006                            portletInfoShortTitle = portletInfoElement.elementText(
2007                                    "short-title");
2008                            portletInfoKeyWords = portletInfoElement.elementText("keywords");
2009                    }
2010    
2011                    PortletInfo portletInfo = new PortletInfo(
2012                            portletInfoTitle, portletInfoShortTitle, portletInfoKeyWords,
2013                            portletInfoDescription);
2014    
2015                    portletModel.setPortletInfo(portletInfo);
2016    
2017                    Element portletPreferencesElement = portletElement.element(
2018                            "portlet-preferences");
2019    
2020                    String defaultPreferences = null;
2021                    String preferencesValidator = null;
2022    
2023                    if (portletPreferencesElement != null) {
2024                            Element preferencesValidatorElement =
2025                                    portletPreferencesElement.element("preferences-validator");
2026    
2027                            if (preferencesValidatorElement != null) {
2028                                    preferencesValidator = preferencesValidatorElement.getText();
2029    
2030                                    portletPreferencesElement.remove(preferencesValidatorElement);
2031                            }
2032    
2033                            defaultPreferences = portletPreferencesElement.asXML();
2034                    }
2035    
2036                    portletModel.setDefaultPreferences(defaultPreferences);
2037                    portletModel.setPreferencesValidator(preferencesValidator);
2038    
2039                    if (!portletApp.isWARFile() &&
2040                            Validator.isNotNull(preferencesValidator) &&
2041                            PropsValues.PREFERENCE_VALIDATE_ON_STARTUP) {
2042    
2043                            try {
2044                                    PreferencesValidator preferencesValidatorObj =
2045                                            PortalUtil.getPreferencesValidator(portletModel);
2046    
2047                                    preferencesValidatorObj.validate(
2048                                            PortletPreferencesFactoryUtil.fromDefaultXML(
2049                                                    defaultPreferences));
2050                            }
2051                            catch (Exception e) {
2052                                    if (_log.isWarnEnabled()) {
2053                                            _log.warn(
2054                                                    "Portlet with the name " + portletId +
2055                                                            " does not have valid default preferences");
2056                                    }
2057                            }
2058                    }
2059    
2060                    Set<String> unlinkedRoles = new HashSet<String>();
2061    
2062                    for (Element roleElement :
2063                                    portletElement.elements("security-role-ref")) {
2064    
2065                            unlinkedRoles.add(roleElement.elementText("role-name"));
2066                    }
2067    
2068                    portletModel.setUnlinkedRoles(unlinkedRoles);
2069    
2070                    Set<QName> processingEvents = new HashSet<QName>();
2071    
2072                    for (Element supportedProcessingEventElement :
2073                                    portletElement.elements("supported-processing-event")) {
2074    
2075                            Element qNameElement = supportedProcessingEventElement.element(
2076                                    "qname");
2077                            Element nameElement = supportedProcessingEventElement.element(
2078                                    "name");
2079    
2080                            QName qName = PortletQNameUtil.getQName(
2081                                    qNameElement, nameElement, portletApp.getDefaultNamespace());
2082    
2083                            processingEvents.add(qName);
2084    
2085                            Set<EventDefinition> eventDefinitions =
2086                                    portletApp.getEventDefinitions();
2087    
2088                            for (EventDefinition eventDefinition : eventDefinitions) {
2089                                    Set<QName> qNames = eventDefinition.getQNames();
2090    
2091                                    if (qNames.contains(qName)) {
2092                                            processingEvents.addAll(qNames);
2093                                    }
2094                            }
2095                    }
2096    
2097                    portletModel.setProcessingEvents(processingEvents);
2098    
2099                    Set<QName> publishingEvents = new HashSet<QName>();
2100    
2101                    for (Element supportedPublishingEventElement :
2102                                    portletElement.elements("supported-publishing-event")) {
2103    
2104                            Element qNameElement = supportedPublishingEventElement.element(
2105                                    "qname");
2106                            Element nameElement = supportedPublishingEventElement.element(
2107                                    "name");
2108    
2109                            QName qName = PortletQNameUtil.getQName(
2110                                    qNameElement, nameElement, portletApp.getDefaultNamespace());
2111    
2112                            publishingEvents.add(qName);
2113                    }
2114    
2115                    portletModel.setPublishingEvents(publishingEvents);
2116    
2117                    Set<PublicRenderParameter> publicRenderParameters =
2118                            new HashSet<PublicRenderParameter>();
2119    
2120                    for (Element supportedPublicRenderParameter :
2121                                    portletElement.elements("supported-public-render-parameter")) {
2122    
2123                            String identifier = supportedPublicRenderParameter.getTextTrim();
2124    
2125                            PublicRenderParameter publicRenderParameter =
2126                                    portletApp.getPublicRenderParameter(identifier);
2127    
2128                            if (publicRenderParameter == null) {
2129                                    _log.error(
2130                                            "Supported public render parameter references " +
2131                                                    "unknown identifier " + identifier);
2132    
2133                                    continue;
2134                            }
2135    
2136                            publicRenderParameters.add(publicRenderParameter);
2137                    }
2138    
2139                    portletModel.setPublicRenderParameters(publicRenderParameters);
2140            }
2141    
2142            private Set<String> _readPortletXML(
2143                            String servletContextName, ServletContext servletContext,
2144                            String xml, Map<String, Portlet> portletsPool,
2145                            Set<String> servletURLPatterns, PluginPackage pluginPackage)
2146                    throws Exception {
2147    
2148                    Set<String> portletIds = new HashSet<String>();
2149    
2150                    if (xml == null) {
2151                            return portletIds;
2152                    }
2153    
2154                    Document document = UnsecureSAXReaderUtil.read(
2155                            xml, PropsValues.PORTLET_XML_VALIDATE);
2156    
2157                    Element rootElement = document.getRootElement();
2158    
2159                    PortletApp portletApp = _getPortletApp(servletContextName);
2160    
2161                    portletApp.addServletURLPatterns(servletURLPatterns);
2162    
2163                    Set<String> userAttributes = portletApp.getUserAttributes();
2164    
2165                    for (Element userAttributeElement :
2166                                    rootElement.elements("user-attribute")) {
2167    
2168                            String name = userAttributeElement.elementText("name");
2169    
2170                            userAttributes.add(name);
2171                    }
2172    
2173                    String defaultNamespace = rootElement.elementText("default-namespace");
2174    
2175                    if (Validator.isNotNull(defaultNamespace)) {
2176                            portletApp.setDefaultNamespace(defaultNamespace);
2177                    }
2178    
2179                    for (Element eventDefinitionElement :
2180                                    rootElement.elements("event-definition")) {
2181    
2182                            Element qNameElement = eventDefinitionElement.element("qname");
2183                            Element nameElement = eventDefinitionElement.element("name");
2184                            String valueType = eventDefinitionElement.elementText("value-type");
2185    
2186                            QName qName = PortletQNameUtil.getQName(
2187                                    qNameElement, nameElement, portletApp.getDefaultNamespace());
2188    
2189                            EventDefinition eventDefinition = new EventDefinitionImpl(
2190                                    qName, valueType, portletApp);
2191    
2192                            List<Element> aliases = eventDefinitionElement.elements("alias");
2193    
2194                            for (Element alias : aliases) {
2195                                    qName = PortletQNameUtil.getQName(
2196                                            alias, null, portletApp.getDefaultNamespace());
2197    
2198                                    eventDefinition.addAliasQName(qName);
2199                            }
2200    
2201                            portletApp.addEventDefinition(eventDefinition);
2202                    }
2203    
2204                    for (Element publicRenderParameterElement :
2205                                    rootElement.elements("public-render-parameter")) {
2206    
2207                            String identifier = publicRenderParameterElement.elementText(
2208                                    "identifier");
2209                            Element qNameElement = publicRenderParameterElement.element(
2210                                    "qname");
2211                            Element nameElement = publicRenderParameterElement.element("name");
2212    
2213                            QName qName = PortletQNameUtil.getQName(
2214                                    qNameElement, nameElement, portletApp.getDefaultNamespace());
2215    
2216                            PublicRenderParameter publicRenderParameter =
2217                                    new PublicRenderParameterImpl(identifier, qName, portletApp);
2218    
2219                            portletApp.addPublicRenderParameter(publicRenderParameter);
2220                    }
2221    
2222                    for (Element containerRuntimeOptionElement :
2223                                    rootElement.elements("container-runtime-option")) {
2224    
2225                            String name = GetterUtil.getString(
2226                                    containerRuntimeOptionElement.elementText("name"));
2227    
2228                            List<String> values = new ArrayList<String>();
2229    
2230                            for (Element valueElement :
2231                                            containerRuntimeOptionElement.elements("value")) {
2232    
2233                                    values.add(valueElement.getTextTrim());
2234                            }
2235    
2236                            Map<String, String[]> containerRuntimeOptions =
2237                                    portletApp.getContainerRuntimeOptions();
2238    
2239                            containerRuntimeOptions.put(
2240                                    name, values.toArray(new String[values.size()]));
2241    
2242                            if (name.equals(
2243                                            LiferayPortletConfig.RUNTIME_OPTION_PORTAL_CONTEXT) &&
2244                                    !values.isEmpty() && GetterUtil.getBoolean(values.get(0))) {
2245    
2246                                    portletApp.setWARFile(false);
2247                            }
2248                    }
2249    
2250                    for (Element portletElement : rootElement.elements("portlet")) {
2251                            _readPortletXML(
2252                                    servletContextName, portletsPool, pluginPackage, portletApp,
2253                                    portletIds, portletElement);
2254                    }
2255    
2256                    for (Element filterElement : rootElement.elements("filter")) {
2257                            String filterName = filterElement.elementText("filter-name");
2258                            String filterClass = filterElement.elementText("filter-class");
2259    
2260                            Set<String> lifecycles = new LinkedHashSet<String>();
2261    
2262                            for (Element lifecycleElement :
2263                                            filterElement.elements("lifecycle")) {
2264    
2265                                    lifecycles.add(lifecycleElement.getText());
2266                            }
2267    
2268                            Map<String, String> initParams = new HashMap<String, String>();
2269    
2270                            for (Element initParamElement :
2271                                            filterElement.elements("init-param")) {
2272    
2273                                    initParams.put(
2274                                            initParamElement.elementText("name"),
2275                                            initParamElement.elementText("value"));
2276                            }
2277    
2278                            PortletFilter portletFilter = new PortletFilterImpl(
2279                                    filterName, filterClass, lifecycles, initParams, portletApp);
2280    
2281                            portletApp.addPortletFilter(portletFilter);
2282                    }
2283    
2284                    for (Element filterMappingElement :
2285                                    rootElement.elements("filter-mapping")) {
2286    
2287                            String filterName = filterMappingElement.elementText("filter-name");
2288    
2289                            for (Element portletNameElement :
2290                                            filterMappingElement.elements("portlet-name")) {
2291    
2292                                    String portletName = portletNameElement.getTextTrim();
2293    
2294                                    PortletFilter portletFilter = portletApp.getPortletFilter(
2295                                            filterName);
2296    
2297                                    if (portletFilter == null) {
2298                                            _log.error(
2299                                                    "Filter mapping references unknown filter name " +
2300                                                            filterName);
2301    
2302                                            continue;
2303                                    }
2304    
2305                                    List<Portlet> portletModels = _getPortletsByPortletName(
2306                                            portletName, servletContextName, portletsPool);
2307    
2308                                    if (portletModels.size() == 0) {
2309                                            _log.error(
2310                                                    "Filter mapping with filter name " + filterName +
2311                                                            " references unknown portlet name " + portletName);
2312                                    }
2313    
2314                                    for (Portlet portletModel : portletModels) {
2315                                            portletModel.getPortletFilters().put(
2316                                                    filterName, portletFilter);
2317                                    }
2318                            }
2319                    }
2320    
2321                    for (Element listenerElement : rootElement.elements("listener")) {
2322                            String listenerClass = listenerElement.elementText(
2323                                    "listener-class");
2324    
2325                            PortletURLListener portletURLListener = new PortletURLListenerImpl(
2326                                    listenerClass, portletApp);
2327    
2328                            portletApp.addPortletURLListener(portletURLListener);
2329                    }
2330    
2331                    return portletIds;
2332            }
2333    
2334            private Set<String> _readWebXML(String xml) throws Exception {
2335                    Set<String> servletURLPatterns = new LinkedHashSet<String>();
2336    
2337                    if (xml == null) {
2338                            return servletURLPatterns;
2339                    }
2340    
2341                    Document document = UnsecureSAXReaderUtil.read(xml);
2342    
2343                    Element rootElement = document.getRootElement();
2344    
2345                    for (Element servletMappingElement :
2346                                    rootElement.elements("servlet-mapping")) {
2347    
2348                            String urlPattern = servletMappingElement.elementText(
2349                                    "url-pattern");
2350    
2351                            servletURLPatterns.add(urlPattern);
2352                    }
2353    
2354                    return servletURLPatterns;
2355            }
2356    
2357            private void _setSpriteImages(
2358                            ServletContext servletContext, PortletApp portletApp,
2359                            String resourcePath)
2360                    throws Exception {
2361    
2362                    Set<String> resourcePaths = servletContext.getResourcePaths(
2363                            resourcePath);
2364    
2365                    if ((resourcePaths == null) || resourcePaths.isEmpty()) {
2366                            return;
2367                    }
2368    
2369                    List<URL> imageURLs = new ArrayList<URL>(resourcePaths.size());
2370    
2371                    for (String curResourcePath : resourcePaths) {
2372                            if (curResourcePath.endsWith(StringPool.SLASH)) {
2373                                    _setSpriteImages(servletContext, portletApp, curResourcePath);
2374                            }
2375                            else if (curResourcePath.endsWith(".png")) {
2376                                    URL imageURL = servletContext.getResource(curResourcePath);
2377    
2378                                    if (imageURL != null) {
2379                                            imageURLs.add(imageURL);
2380                                    }
2381                                    else {
2382                                            _log.error(
2383                                                    "Resource URL for " + curResourcePath + " is null");
2384                                    }
2385                            }
2386                    }
2387    
2388                    String spriteRootDirName = PropsValues.SPRITE_ROOT_DIR;
2389                    String spriteFileName = resourcePath.concat(
2390                            PropsValues.SPRITE_FILE_NAME);
2391                    String spritePropertiesFileName = resourcePath.concat(
2392                            PropsValues.SPRITE_PROPERTIES_FILE_NAME);
2393                    String rootPath = ServletContextUtil.getRootPath(servletContext);
2394    
2395                    Properties spriteProperties = SpriteProcessorUtil.generate(
2396                            servletContext, imageURLs, spriteRootDirName, spriteFileName,
2397                            spritePropertiesFileName, rootPath, 16, 16, 10240);
2398    
2399                    if (spriteProperties == null) {
2400                            return;
2401                    }
2402    
2403                    String contextPath = ContextPathUtil.getContextPath(servletContext);
2404    
2405                    spriteFileName = contextPath.concat(SpriteProcessor.PATH).concat(
2406                            spriteFileName);
2407    
2408                    portletApp.setSpriteImages(spriteFileName, spriteProperties);
2409            }
2410    
2411            private static final int _PORTLET_ID_MAX_LENGTH =
2412                    ModelHintsUtil.getMaxLength(Portlet.class.getName(), "portletId") -
2413                            PortletConstants.INSTANCE_SEPARATOR.length() +
2414                                    PortletConstants.USER_SEPARATOR.length() + 39;
2415    
2416            private static Log _log = LogFactoryUtil.getLog(
2417                    PortletLocalServiceImpl.class);
2418    
2419            private static Map<Long, Map<String, Portlet>> _companyPortletsPool =
2420                    new ConcurrentHashMap<Long, Map<String, Portlet>>();
2421            private static Map<String, Portlet> _customAttributesDisplayPortlets =
2422                    new ConcurrentHashMap<String, Portlet>();
2423            private static Map<String, Portlet> _friendlyURLMapperPortlets =
2424                    new ConcurrentHashMap<String, Portlet>();
2425            private static Map<String, PortletApp> _portletAppsPool =
2426                    new ConcurrentHashMap<String, PortletApp>();
2427            private static Map<String, String> _portletIdsByStrutsPath =
2428                    new ConcurrentHashMap<String, String>();
2429            private static Map<String, Portlet> _portletsPool =
2430                    new ConcurrentHashMap<String, Portlet>();
2431    
2432    }