/**
* Copyright (C) 2009 eXo Platform SAS.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.exoplatform.portal.webui.workspace;
import javax.servlet.http.HttpServletResponse;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang.StringUtils;
import org.exoplatform.commons.utils.PropertyManager;
import org.exoplatform.commons.utils.Safe;
import org.exoplatform.portal.Constants;
import org.exoplatform.portal.application.PortalRequestContext;
import org.exoplatform.portal.application.RequestNavigationData;
import org.exoplatform.portal.config.DataStorage;
import org.exoplatform.portal.config.UserPortalConfig;
import org.exoplatform.portal.config.model.Container;
import org.exoplatform.portal.config.model.PortalConfig;
import org.exoplatform.portal.mop.SiteKey;
import org.exoplatform.portal.mop.SiteType;
import org.exoplatform.portal.resource.Skin;
import org.exoplatform.portal.resource.SkinConfig;
import org.exoplatform.portal.resource.SkinService;
import org.exoplatform.portal.resource.SkinURL;
import org.exoplatform.portal.url.URLWriter;
import org.exoplatform.portal.resource.SkinVisitor;
import org.exoplatform.portal.webui.application.UIPortlet;
import org.exoplatform.portal.webui.page.UIPageActionListener.ChangeNodeActionListener;
import org.exoplatform.portal.webui.page.UISiteBody;
import org.exoplatform.portal.webui.portal.PageNodeEvent;
import org.exoplatform.portal.webui.portal.UIPortal;
import org.exoplatform.portal.webui.util.PortalDataMapper;
import org.exoplatform.portal.webui.util.Util;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.organization.OrganizationService;
import org.exoplatform.services.organization.UserProfile;
import org.exoplatform.services.resources.LocaleConfig;
import org.exoplatform.services.resources.LocaleConfigService;
import org.exoplatform.services.resources.LocaleContextInfo;
import org.exoplatform.services.resources.Orientation;
import org.exoplatform.web.ControllerContext;
import org.exoplatform.web.application.JavascriptManager;
import org.exoplatform.web.application.javascript.JavascriptConfigParser;
import org.exoplatform.web.application.javascript.JavascriptConfigService;
import org.exoplatform.web.url.MimeType;
import org.exoplatform.web.url.navigation.NavigationResource;
import org.exoplatform.web.url.navigation.NodeURL;
import org.exoplatform.webui.application.WebuiRequestContext;
import org.exoplatform.webui.config.annotation.ComponentConfig;
import org.exoplatform.webui.config.annotation.EventConfig;
import org.exoplatform.webui.core.UIApplication;
import org.exoplatform.webui.core.UIComponent;
import org.exoplatform.webui.core.UIComponentDecorator;
import org.exoplatform.webui.core.UIContainer;
import org.exoplatform.webui.event.Event;
import org.exoplatform.webui.url.ComponentURL;
import org.gatein.portal.controller.resource.ResourceId;
import org.gatein.portal.controller.resource.ResourceScope;
import org.gatein.portal.controller.resource.script.FetchMap;
import org.gatein.portal.controller.resource.script.FetchMode;
import org.gatein.portal.controller.resource.script.Module;
import org.gatein.portal.controller.resource.script.ScriptResource;
import org.json.JSONObject;
/**
* This extends the UIApplication and hence is a sibling of UIPortletApplication (used by any eXo Portlets as the Parent class
* to build the portlet component tree). The UIPortalApplication is responsible to build its subtree according to some
* configuration parameters. If all components are displayed it is composed of 2 UI components: -UIWorkingWorkSpace: the right
* part that can display the normal or webos portal layouts - UIPopupWindow: a popup window that display or not
*/
@ComponentConfig(lifecycle = UIPortalApplicationLifecycle.class, template = "system:/groovy/portal/webui/workspace/UIPortalApplication.gtmpl", events = { @EventConfig(listeners = ChangeNodeActionListener.class) })
public class UIPortalApplication extends UIApplication {
/**
* Property settable in the portal'S configuration.properties file. See {@link EditMode} for possible values. See also
* {@link #getDefaultEditMode()}.
*/
public static final String DEFAULT_MODE_PROPERTY = "gatein.portal.pageEditor.defaultEditMode";
public enum EditMode {
/**
* Edit mode with plain rectangles in place of portlets.
*/
BLOCK,
/**
* Edit mode with portlets rendered.
*/
PREVIEW,
NO_EDIT
}
public enum ComponentTab {
/**
* For situations when Applications Tab of Page Editor dialog is selected.
*/
APPLICATIONS,
/**
* For situations when Containers Tab of Page Editor dialog is selected.
*/
CONTAINERS,
NO_EDIT
}
public enum EditLevel {
NO_EDIT,
EDIT_SITE,
EDIT_PAGE
}
/**
* The normal, non-edit mode.
*/
public static final int NORMAL_MODE = 0;
/**
* The combination of {@link EditMode#BLOCK} and {@link ComponentTab#APPLICATIONS}.
*/
public static final int APP_BLOCK_EDIT_MODE = 1;
/**
* The combination of {@link EditMode#PREVIEW} and {@link ComponentTab#APPLICATIONS}.
*/
public static final int APP_VIEW_EDIT_MODE = 2;
/**
* The combination of {@link EditMode#BLOCK} and {@link ComponentTab#CONTAINERS}.
*/
public static final int CONTAINER_BLOCK_EDIT_MODE = 3;
/**
* The combination of {@link EditMode#PREVIEW} and {@link ComponentTab#CONTAINERS}.
*/
public static final int CONTAINER_VIEW_EDIT_MODE = 4;
public static final UIComponent EMPTY_COMPONENT = new UIComponent() {
public String getId() {
return "_portal:componentId_";
};
};
private static EditMode defaultEditMode = null;
private int modeState = NORMAL_MODE;
private EditLevel editLevel = EditLevel.NO_EDIT;
private Orientation orientation_ = Orientation.LT;
public static final String UI_WORKING_WS_ID = "UIWorkingWorkspace";
public static final String UI_VIEWING_WS_ID = "UIViewWS";
public static final String UI_EDITTING_WS_ID = "UIEditInlineWS";
public static final String UI_MASK_WS_ID = "UIMaskWorkspace";
private String skin_ = SkinService.DEFAULT_SKIN;
private boolean isSessionOpen = false;
private Map<SiteKey, UIPortal> all_UIPortals;
private UIPortal currentSite;
private boolean isAjaxInLastRequest;
private RequestNavigationData lastNonAjaxRequestNavData;
private RequestNavigationData lastRequestNavData;
private String lastPortal;
/**
* Returns a locally cached value of {@value #DEFAULT_MODE_PROPERTY} property from configuration.properties.
*
* @return
*/
public static EditMode getDefaultEditMode() {
if (defaultEditMode == null) {
/*
* Initialization: For performance reasons, we have chosen to prefer to ignore the potential concurrent updates on
* app startup to some kind of locking. The concurrent updates should be harmless as they all produce the same
* result.
*/
String val = PropertyManager.getProperty(DEFAULT_MODE_PROPERTY);
if (val == null || val.length() == 0) {
/* hard coded default */
defaultEditMode = EditMode.BLOCK;
} else {
try {
defaultEditMode = EditMode.valueOf(val.toUpperCase());
} catch (IllegalArgumentException e) {
StringBuilder msg = new StringBuilder().append("Ignoring illegal value '").append(val).append("' of ")
.append(DEFAULT_MODE_PROPERTY).append(" property in configuration.properties. One of [");
for (EditMode mode : EditMode.values()) {
if (msg.charAt(msg.length() - 1) != '[') {
msg.append(", ");
}
msg.append(mode.name());
}
msg.append("] is expected. Using default value '").append(EditMode.BLOCK.name()).append("'.");
log.warn(msg.toString());
defaultEditMode = EditMode.BLOCK;
}
}
}
return defaultEditMode;
}
/**
* The constructor of this class is used to build the tree of UI components that will be aggregated in the portal page.<br/>
* 1) The component is stored in the current PortalRequestContext ThreadLocal<br/>
* 2) The configuration for the portal associated with the current user request is extracted from the PortalRequestContext<br/>
* 3) Then according to the context path, either a public or private portal is initiated. Usually a public portal does not
* contain the left column and only the private one has it.<br/>
* 4) The skin to use is setup <br/>
* 5) Finally, the current component is associated with the current portal owner
*
* @throws Exception
*/
public UIPortalApplication() throws Exception {
log = ExoLogger.getLogger("portal:UIPortalApplication");
PortalRequestContext context = PortalRequestContext.getCurrentInstance();
// userPortalConfig_ = (UserPortalConfig)context.getAttribute(UserPortalConfig.class);
// if (userPortalConfig_ == null)
// throw new Exception("Can't load user portal config");
// dang.tung - set portal language by user preference -> browser ->
// default
// ------------------------------------------------------------------------------
LocaleConfigService localeConfigService = getApplicationComponent(LocaleConfigService.class);
Locale locale = context.getLocale();
if (locale == null) {
if (log.isWarnEnabled())
log.warn("No locale set on PortalRequestContext! Falling back to 'en'.");
locale = Locale.ENGLISH;
}
String localeName = LocaleContextInfo.getLocaleAsString(locale);
LocaleConfig localeConfig = localeConfigService.getLocaleConfig(localeName);
if (localeConfig == null) {
if (log.isWarnEnabled())
log.warn("Unsupported locale set on PortalRequestContext: " + localeName + "! Falling back to 'en'.");
localeConfig = localeConfigService.getLocaleConfig(Locale.ENGLISH.getLanguage());
}
setOrientation(localeConfig.getOrientation());
// -------------------------------------------------------------------------------
context.setUIApplication(this);
this.all_UIPortals = new HashMap<SiteKey, UIPortal>(5);
initWorkspaces();
}
/**
* Sets the specified portal to be showed in the normal mode currently
*
* @param uiPortal
*/
public void setCurrentSite(UIPortal uiPortal) {
this.currentSite = uiPortal;
UISiteBody siteBody = this.findFirstComponentOfType(UISiteBody.class);
if (siteBody != null) {
// TODO: Check this part carefully
siteBody.setUIComponent(uiPortal);
}
}
/**
* Returns current UIPortal which being showed in normal mode
*
* @return
*/
public UIPortal getCurrentSite() {
return currentSite;
}
/**
* Returns a cached UIPortal matching to OwnerType and OwnerId if any
*
* @param ownerType
* @param ownerId
* @return
*/
public UIPortal getCachedUIPortal(String ownerType, String ownerId) {
if (ownerType == null || ownerId == null) {
return null;
}
return this.all_UIPortals.get(new SiteKey(ownerType, ownerId));
}
public UIPortal getCachedUIPortal(SiteKey key) {
if (key == null) {
return null;
}
return this.all_UIPortals.get(key);
}
/**
* Associates the specified UIPortal to a cache map with specified key which bases on OwnerType and OwnerId
*
* @param uiPortal
*/
public void putCachedUIPortal(UIPortal uiPortal) {
SiteKey siteKey = uiPortal.getSiteKey();
if (siteKey != null) {
this.all_UIPortals.put(siteKey, uiPortal);
}
}
/**
* Remove the UIPortal from the cache map
*
* @param ownerType
* @param ownerId
*/
public void removeCachedUIPortal(String ownerType, String ownerId) {
if (ownerType == null || ownerId == null) {
return;
}
this.all_UIPortals.remove(new SiteKey(ownerType, ownerId));
}
/**
* Invalidate any UIPage cache object associated to UIPortal objects
*
* @param pageRef
*/
public void invalidateUIPage(String pageRef) {
for (UIPortal tmp : all_UIPortals.values()) {
tmp.clearUIPage(pageRef);
}
}
public void refreshCachedUI() throws Exception {
DataStorage storage = this.getApplicationComponent(DataStorage.class);
all_UIPortals.clear();
UIPortal uiPortal = getCurrentSite();
if (uiPortal != null) {
SiteKey siteKey = uiPortal.getSiteKey();
UIPortal tmp = null;
PortalConfig portalConfig = storage.getPortalConfig(siteKey.getTypeName(), siteKey.getName());
if (portalConfig != null) {
tmp = this.createUIComponent(UIPortal.class, null, null);
PortalDataMapper.toUIPortal(tmp, portalConfig);
this.putCachedUIPortal(tmp);
tmp.setNavPath(uiPortal.getNavPath());
tmp.refreshUIPage();
setCurrentSite(tmp);
if (SiteType.PORTAL.equals(siteKey.getType())) {
PortalRequestContext pcontext = Util.getPortalRequestContext();
if (pcontext != null) {
UserPortalConfig userPortalConfig = pcontext.getUserPortalConfig();
userPortalConfig.setPortalConfig(portalConfig);
}
}
}
}
}
public boolean isSessionOpen() {
return isSessionOpen;
}
public void setSessionOpen(boolean isSessionOpen) {
this.isSessionOpen = isSessionOpen;
}
public Orientation getOrientation() {
return orientation_;
}
public void setOrientation(Orientation orientation) {
this.orientation_ = orientation;
}
public Locale getLocale() {
return Util.getPortalRequestContext().getLocale();
}
public void setModeState(int mode) {
this.modeState = mode;
if (modeState == NORMAL_MODE) {
editLevel = EditLevel.NO_EDIT;
}
}
public void setDefaultEditMode(ComponentTab componentTab, EditLevel editLevel) {
this.editLevel = editLevel;
EditMode editMode = getDefaultEditMode();
switch (componentTab) {
case APPLICATIONS:
switch (editMode) {
case BLOCK:
this.modeState = APP_BLOCK_EDIT_MODE;
break;
case PREVIEW:
this.modeState = APP_VIEW_EDIT_MODE;
break;
default:
log.warn("Ignoring unexpected "+ EditMode.class.getName() +" value '"+ editMode.name() +"' and using '"+ EditMode.BLOCK.name() +"'.");
}
break;
case CONTAINERS:
switch (editMode) {
case BLOCK:
this.modeState = CONTAINER_BLOCK_EDIT_MODE;
break;
case PREVIEW:
this.modeState = CONTAINER_VIEW_EDIT_MODE;
break;
default:
log.warn("Ignoring unexpected "+ EditMode.class.getName() +" value '"+ editMode.name() +"' and using '"+ EditMode.BLOCK.name() +"'.");
}
break;
default:
log.warn("Ignoring unexpected "+ ComponentTab.class.getName() +" value '"+ componentTab.name() +"' and using '"+ ComponentTab.APPLICATIONS.name() +"'.");
switch (editMode) {
case BLOCK:
this.modeState = APP_BLOCK_EDIT_MODE;
break;
case PREVIEW:
this.modeState = APP_VIEW_EDIT_MODE;
break;
default:
log.warn("Ignoring unexpected "+ EditMode.class.getName() +" value '"+ editMode.name() +"' and using '"+ EditMode.BLOCK.name() +"'.");
}
}
}
public int getModeState() {
return modeState;
}
public void setLastRequestNavData(RequestNavigationData navData) {
this.lastRequestNavData = navData;
}
/**
* @deprecated use the Mode State instead
*
* @return True if the Portal is not in the normal mode
*/
public boolean isEditing() {
return (modeState != NORMAL_MODE);
}
/**
* Return a map of JS resource ids (required to be load for current page) and boolean:
* true if that script should be push on the header before html.
* false if that script should be load lazily after html has been loaded <br/>
*
* JS resources always contains SHARED/bootstrap required to be loaded eagerly
* and optionally (by configuration) contains: portal js, portlet js, and resouces registered to be load
* through JavascriptManager
*
* @return
*/
public Map<String, Boolean> getScripts() {
PortalRequestContext prc = PortalRequestContext.getCurrentInstance();
JavascriptManager jsMan = prc.getJavascriptManager();
//
FetchMap<ResourceId> requiredResources = jsMan.getScriptResources();
log.debug("Resource ids to resolve: {}", requiredResources);
//
JavascriptConfigService service = getApplicationComponent(JavascriptConfigService.class);
Map<String, Boolean> ret = new LinkedHashMap<String, Boolean>();
Map<String, Boolean> tmp = new LinkedHashMap<String, Boolean>();
Map<ScriptResource, FetchMode> resolved = service.resolveIds(requiredResources);
for (ScriptResource rs : resolved.keySet()) {
if (!rs.isNativeAmd()) {
ResourceId id = rs.getId();
// SHARED/bootstrap should be loaded first
if (ResourceScope.SHARED.equals(id.getScope()) && "bootstrap".equals(id.getName())) {
ret.put(id.toString(), false);
} else {
boolean isRemote = !rs.isEmpty() && rs.getModules().get(0) instanceof Module.Remote;
tmp.put(id.toString(), isRemote);
}
}
}
ret.putAll(tmp);
for (String url : jsMan.getExtendedScriptURLs()) {
ret.put(url, true);
}
//
log.debug("Resolved resources for page: " + ret);
return ret;
}
/**
* Return a map of GMD resource ids and their URLs that point to ResourceRequestHandler.
* this map will be used by GateIn JS module loader (currently, it is requirejs)
* @throws Exception
*/
public JSONObject getJSConfig() throws Exception {
JavascriptConfigService service = getApplicationComponent(JavascriptConfigService.class);
PortalRequestContext prc = PortalRequestContext.getCurrentInstance();
return service.getJSConfig(prc.getControllerContext(), prc.getLocale());
}
public Collection<SkinConfig> getPortalSkins(SkinVisitor visitor) {
SkinService skinService = getApplicationComponent(SkinService.class);
if (visitor != null) {
return skinService.findSkins(visitor);
} else {
return Collections.emptyList();
}
}
/**
* Return corresponding collection of Skin objects depends on current skin name,
* this object help to build URL that point to SkinResourceRequestHandler. this handler is responsible to serves for css files <br/>
*
* The collection contains:
* - portal skin modules <br/>
* - skin for specific site<br/>
*/
public Collection<Skin> getPortalSkins() {
SkinService skinService = getApplicationComponent(SkinService.class);
//
Collection<Skin> skins = new ArrayList<Skin>(skinService.getPortalSkins(skin_));
//
SkinConfig skinConfig = skinService.getSkin(Util.getUIPortal().getName(), skin_);
if (skinConfig != null) {
skins.add(skinConfig);
}
return skins;
}
private Set<SkinConfig> getPortalPortletSkins() {
Set<SkinConfig> portletConfigs = new HashSet<SkinConfig>();
for (UIComponent child : findFirstComponentOfType(UIPortal.class).getChildren()) {
getPortalPortletSkinConfig(portletConfigs, child);
}
return portletConfigs;
}
private void getPortalPortletSkinConfig(Set<SkinConfig> portletConfigs, UIComponent component) {
if(component instanceof UIPortlet) {
SkinConfig portletConfig = getPortletSkinConfig((UIPortlet) component);
if (portletConfig != null) {
portletConfigs.add(portletConfig);
}
} else if (component instanceof UIContainer) {
for(UIComponent child : ((UIContainer) component).getChildren()) {
getPortalPortletSkinConfig(portletConfigs, child);
}
}
}
public String getSkin() {
return skin_;
}
public void setSkin(String skin) {
this.skin_ = skin;
}
private SkinConfig getSkin(String module, String skin) {
SkinService skinService = getApplicationComponent(SkinService.class);
return skinService.getSkin(module, skin);
}
/**
* Returns a set of portlets skin that have to be added in the HTML head tag.
*Those portlets doesn't belongs to portal
*
* @return the portlet skins
*/
public Set<Skin> getPortletSkins() {
// Determine portlets visible on the page
List<UIPortlet> uiportlets = new ArrayList<UIPortlet>();
UIWorkingWorkspace uiWorkingWS = getChildById(UI_WORKING_WS_ID);
UIPortal uiPortal = uiWorkingWS.findFirstComponentOfType(UIPortal.class);
uiPortal.findComponentOfType(uiportlets, UIPortlet.class);
UIPortalToolPanel toolPanel = uiWorkingWS.findFirstComponentOfType(UIPortalToolPanel.class);
if (toolPanel != null && toolPanel.isRendered()) {
toolPanel.findComponentOfType(uiportlets, UIPortlet.class);
}
List<Skin> portletSkins = new ArrayList<Skin>();
//
Set<SkinConfig> portalPortletSkins = getPortalPortletSkins();
// don't merge portlet if portlet not available
if (!portalPortletSkins.isEmpty()) {
SkinService skinService = getApplicationComponent(SkinService.class);
portletSkins.add(skinService.merge(portalPortletSkins));
}
//
for (UIPortlet uiPortlet : uiportlets) {
SkinConfig skinConfig = getPortletSkinConfig(uiPortlet);
if (skinConfig == null) {
skinConfig = getDefaultPortletSkinConfig(uiPortlet);
}
if (skinConfig != null && !portalPortletSkins.contains(skinConfig)) {
portletSkins.add(skinConfig);
}
}
// Sort skins by priority
Collections.sort(portletSkins, new Comparator<Skin>() {
public int compare(Skin s1, Skin s2) {
if ((s1 instanceof SkinConfig) && (s2 instanceof SkinConfig)) {
SkinConfig o1 = (SkinConfig)s1;
SkinConfig o2 = (SkinConfig)s2;
if (o1.getCSSPriority() == o2.getCSSPriority())
return 1;// Can indicate others condition here
else if (o1.getCSSPriority() < 0)
return 1;
else if (o2.getCSSPriority() < 0)
return -1;
else
return o1.getCSSPriority() - o2.getCSSPriority();
} else {
return 0;
}
}
});
//
return (new HashSet<Skin>(portletSkins));
}
private SkinConfig getDefaultPortletSkinConfig(UIPortlet portlet) {
String portletId = portlet.getSkinId();
if (portletId != null) {
return getSkin(portletId, SkinService.DEFAULT_SKIN);
} else {
return null;
}
}
private SkinConfig getPortletSkinConfig(UIPortlet portlet) {
String portletId = portlet.getSkinId();
if (portletId != null) {
return getSkin(portletId, skin_);
} else {
return null;
}
}
/**
* The central area is called the WorkingWorkspace. It is composed of: 1) A UIPortal child which is filled with portal data
* using the PortalDataMapper helper tool 2) A UIPortalToolPanel which is not rendered by default A UIMaskWorkspace is also
* added to provide powerfull focus only popups
*
* @throws Exception
*/
private void initWorkspaces() throws Exception {
UIWorkingWorkspace uiWorkingWorkspace = addChild(UIWorkingWorkspace.class, UIPortalApplication.UI_WORKING_WS_ID, null);
uiWorkingWorkspace.addChild(UIEditInlineWorkspace.class, null, UI_EDITTING_WS_ID).setRendered(false);
UIComponentDecorator uiViewWS = uiWorkingWorkspace.addChild(UIComponentDecorator.class, null, UI_VIEWING_WS_ID);
DataStorage dataStorage = getApplicationComponent(DataStorage.class);
Container container = dataStorage.getSharedLayout();
if (container != null) {
org.exoplatform.portal.webui.container.UIContainer uiContainer = createUIComponent(
org.exoplatform.portal.webui.container.UIContainer.class, null, null);
uiContainer.setStorageId(container.getStorageId());
PortalDataMapper.toUIContainer(uiContainer, container);
uiContainer.setRendered(true);
uiViewWS.setUIComponent(uiContainer);
}
addChild(UIMaskWorkspace.class, UIPortalApplication.UI_MASK_WS_ID, null);
}
/**
* Check current portal name, if it's changing, reload portal properties (for now, skin setting)
*/
@Override
public void processDecode(WebuiRequestContext context) throws Exception {
PortalRequestContext prc = (PortalRequestContext) context;
String portalName = prc.getUserPortalConfig().getPortalName();
if (!Safe.equals(portalName, lastPortal)) {
reloadPortalProperties();
lastPortal = portalName;
}
super.processDecode(context);
}
/**
* The processAction() method is doing 3 actions: <br/>
* 1) if this is a non ajax request and the last is an ajax one, then we check if the requested nodePath is equal to last
* non ajax nodePath and is not equal to the last nodePath, the server performs a 302 redirect on the last nodePath.<br/>
* 2) if the nodePath exist but is equals to the current one then we also call super and stops here.<br/>
* 3) if the requested nodePath is not equals to the current one or current page no longer exists, then an event of type
* PageNodeEvent.CHANGE_NODE is sent to the associated EventListener; a call to super is then done.
*/
@Override
public void processAction(WebuiRequestContext context) throws Exception {
PortalRequestContext pcontext = (PortalRequestContext) context;
// String requestURI = pcontext.getRequestURI();
RequestNavigationData requestNavData = pcontext.getNavigationData();
boolean isAjax = pcontext.useAjax();
if (!isAjax) {
if (isAjaxInLastRequest) {
isAjaxInLastRequest = false;
if (requestNavData.equals(lastNonAjaxRequestNavData) && !requestNavData.equals(lastRequestNavData)) {
NodeURL nodeURL = pcontext.createURL(NodeURL.TYPE).setNode(getCurrentSite().getSelectedUserNode());
pcontext.sendRedirect(nodeURL.toString());
return;
}
}
lastNonAjaxRequestNavData = requestNavData;
}
isAjaxInLastRequest = isAjax;
if (!requestNavData.equals(lastRequestNavData)) {
lastRequestNavData = requestNavData;
StringBuilder js = new StringBuilder("eXo.env.server.portalBaseURL=\"");
js.append(getBaseURL()).append("\";\n");
String url = getPortalURLTemplate();
js.append("eXo.env.server.portalURLTemplate=\"");
js.append(url).append("\";");
pcontext.getJavascriptManager().require("SHARED/base").addScripts(js.toString());
SiteKey siteKey = new SiteKey(pcontext.getSiteType(), pcontext.getSiteName());
PageNodeEvent<UIPortalApplication> pnevent = new PageNodeEvent<UIPortalApplication>(this,
PageNodeEvent.CHANGE_NODE, siteKey, pcontext.getNodePath());
broadcast(pnevent, Event.Phase.PROCESS);
}
if (!isAjax) {
lastNonAjaxRequestNavData = requestNavData;
}
if (pcontext.isResponseComplete()) {
return;
}
if (currentSite == null || currentSite.getSelectedUserNode() == null) {
pcontext.sendError(HttpServletResponse.SC_NOT_FOUND);
}
super.processAction(pcontext);
}
/**
* The processrender() method handles the creation of the returned HTML either for a full page render or in the case of an
* AJAX call The first request, Ajax is not enabled (means no ajaxRequest parameter in the request) and hence the
* super.processRender() method is called. This will hence call the processrender() of the Lifecycle object as this method
* is not overidden in UIPortalApplicationLifecycle. There we simply render the bounded template (groovy usually). Note that
* bounded template are also defined in component annotations, so for the current class it is UIPortalApplication.gtmpl On
* second calls, request have the "ajaxRequest" parameter set to true in the URL. In that case the algorithm is a bit more
* complex: a) The list of components that should be updated is extracted using the context.getUIComponentToUpdateByAjax()
* method. That list was setup during the process action phase b) Portlets and other UI components to update are split in 2
* different lists c) Portlets full content are returned and set with the tag <div class="PortalResponse"> d) Block to
* updates (which are UI components) are set within the <div class="PortalResponseData"> tag e) Extra markup headers are in the
* <div class="MarkupHeadElements"> tag f) additional scripts are in <div class="ImmediateScripts">, JS GMD modules will be loaded by
* generated JS command on AMD js loader, and is put into PortalResponseScript block g) Then the scripts and the
* skins to reload are set in the <div class="PortalResponseScript">
*/
public void processRender(WebuiRequestContext context) throws Exception {
PortalRequestContext pcontext = (PortalRequestContext) context;
JavascriptManager jsMan = context.getJavascriptManager();
// Add JS resource of current portal
String portalOwner = pcontext.getPortalOwner();
jsMan.loadScriptResource(ResourceScope.PORTAL, portalOwner);
//
Writer w = context.getWriter();
if (!context.useAjax()) {
// Support for legacy resource declaration
jsMan.loadScriptResource(ResourceScope.SHARED, JavascriptConfigParser.LEGACY_JAVA_SCRIPT);
// Need to add bootstrap as immediate since it contains the loader
jsMan.loadScriptResource(ResourceScope.SHARED, "bootstrap");
super.processRender(context);
} else {
UIMaskWorkspace uiMaskWS = getChildById(UIPortalApplication.UI_MASK_WS_ID);
if (uiMaskWS.isUpdated())
pcontext.addUIComponentToUpdateByAjax(uiMaskWS);
if (getUIPopupMessages().hasMessage()) {
pcontext.addUIComponentToUpdateByAjax(getUIPopupMessages());
}
Set<UIComponent> list = context.getUIComponentToUpdateByAjax();
List<UIPortlet> uiPortlets = new ArrayList<UIPortlet>(3);
List<UIComponent> uiDataComponents = new ArrayList<UIComponent>(5);
if (list != null) {
for (UIComponent uicomponent : list) {
if (uicomponent instanceof UIPortlet)
uiPortlets.add((UIPortlet) uicomponent);
else
uiDataComponents.add(uicomponent);
}
}
w.write("<div class=\"PortalResponse\">");
w.write("<div class=\"PortalResponseData\">");
for (UIComponent uicomponent : uiDataComponents) {
if (log.isDebugEnabled())
log.debug("AJAX call: Need to refresh the UI component " + uicomponent.getName());
renderBlockToUpdate(uicomponent, context, w);
}
w.write("</div>");
if (!context.getFullRender()) {
for (UIPortlet uiPortlet : uiPortlets) {
if (log.isDebugEnabled())
log.debug("AJAX call: Need to refresh the Portlet " + uiPortlet.getId());
w.write("<div class=\"PortletResponse\" style=\"display: none\">");
w.append("<div class=\"PortletResponsePortletId\">" + uiPortlet.getId() + "</div>");
w.append("<div class=\"PortletResponseData\">");
/*
* If the portlet is using our UI framework or supports it then it will return a set of block to updates. If
* there is not block to update the javascript client will see that as a full refresh of the content part
*/
uiPortlet.processRender(context);
w.append("</div>");
w.append("<div class=\"PortletResponseScript\"></div>");
w.write("</div>");
}
}
w.write("<div class=\"MarkupHeadElements\">");
List<String> headElems = ((PortalRequestContext) context).getExtraMarkupHeadersAsStrings();
for (String elem : headElems) {
w.write(elem);
}
w.write("</div>");
w.write("<div class=\"LoadingScripts\">");
writeLoadingScripts(pcontext);
w.write("</div>");
w.write("<div class=\"PortalResponseScript\">");
JavascriptManager jsManager = pcontext.getJavascriptManager();
String skin = getAddSkinScript(pcontext.getControllerContext(), list);
if (skin != null) {
jsManager.require("SHARED/skin", "skin").addScripts(skin);
}
w.write(jsManager.getJavaScripts());
w.write("</div>");
w.write("</div>");
}
}
private void writeLoadingScripts(PortalRequestContext context) throws Exception {
Writer w = context.getWriter();
Map<String, Boolean> scriptURLs = getScripts();
w.write("<div class=\"ImmediateScripts\">");
w.write(StringUtils.join(scriptURLs.keySet(), ","));
w.write("</div>");
}
private String getAddSkinScript(ControllerContext context, Set<UIComponent> updateComponents) {
if (updateComponents == null)
return null;
List<UIPortlet> uiportlets = new ArrayList<UIPortlet>();
for (UIComponent uicomponent : updateComponents) {
if (uicomponent instanceof UIContainer) {
UIContainer uiContainer = (UIContainer) uicomponent;
uiContainer.findComponentOfType(uiportlets, UIPortlet.class);
}
if (uicomponent instanceof UIComponentDecorator) {
UIComponentDecorator uiDecorator = (UIComponentDecorator) uicomponent;
if (uiDecorator.getUIComponent() instanceof UIContainer) {
UIContainer uiContainer = (UIContainer) uiDecorator.getUIComponent();
uiContainer.findComponentOfType(uiportlets, UIPortlet.class);
}
}
}
List<SkinConfig> skins = new ArrayList<SkinConfig>();
SkinService skinService = getApplicationComponent(SkinService.class);
for (UIPortlet uiPortlet : uiportlets) {
String skinId = uiPortlet.getSkinId();
if (skinId != null) {
SkinConfig skinConfig = skinService.getSkin(skinId, skin_);
if (skinConfig == null && skin_ != null && !SkinService.DEFAULT_SKIN.equals(skin_)) {
skinConfig = skinService.getSkin(skinId, SkinService.DEFAULT_SKIN);
}
if (skinConfig != null) {
skins.add(skinConfig);
}
}
}
StringBuilder b = new StringBuilder(1000);
for (SkinConfig ele : skins) {
SkinURL url = ele.createURL(context);
url.setOrientation(orientation_);
b.append("skin.addSkin('").append(ele.getId()).append("','").append(url).append("');\n");
}
return b.toString();
}
/**
* Use {@link PortalRequestContext#getUserPortalConfig()} instead
*
* @return
*/
@Deprecated
public UserPortalConfig getUserPortalConfig() {
return Util.getPortalRequestContext().getUserPortalConfig();
}
/**
* Use {@link PortalRequestContext#setUserPortalConfig(UserPortalConfig)} instead
*
* @return
*/
@Deprecated
public void setUserPortalConfig(UserPortalConfig userPortalConfig) {
Util.getPortalRequestContext().setUserPortalConfig(userPortalConfig);
}
/**
* Reload portal properties. This is needed to be called when it is changing Portal site<br/>
* If user has been authenticated, get the skin name setting from user profile.<br/>
* anonymous user or no skin setting in user profile, use the skin setting in portal config
*
* @throws Exception
*/
public void reloadPortalProperties() throws Exception {
PortalRequestContext context = Util.getPortalRequestContext();
String user = context.getRemoteUser();
String portalSkin = null;
OrganizationService orgService = getApplicationComponent(OrganizationService.class);
if (user != null) {
UserProfile userProfile = orgService.getUserProfileHandler().findUserProfileByName(user);
if (userProfile != null) {
portalSkin = userProfile.getUserInfoMap().get(Constants.USER_SKIN);
} else {
if (log.isDebugEnabled())
log.debug("Could not load user profile for " + user + ". Using default portal locale.");
}
}
// use the skin from the user profile if available, otherwise use from the portal config
if (portalSkin != null && portalSkin.trim().length() > 0) {
skin_ = portalSkin;
} else {
String userPortalConfigSkin = context.getUserPortalConfig().getPortalConfig().getSkin();
if (userPortalConfigSkin != null && userPortalConfigSkin.trim().length() > 0)
skin_ = userPortalConfigSkin;
}
}
/**
* Return the portal url template which will be sent to client ( browser ) and used for JS based portal url generation.
*
* <p>
* The portal url template are calculated base on the current request and site state. Something like :
* <code>"/portal/g/:platform:administrators/administration/registry?portal:componentId={portal:uicomponentId}&portal:action={portal:action}" ;</code>
*
* @return return portal url template
* @throws UnsupportedEncodingException
*/
public String getPortalURLTemplate() throws UnsupportedEncodingException {
PortalRequestContext pcontext = Util.getPortalRequestContext();
ComponentURL urlTemplate = pcontext.createURL(ComponentURL.TYPE);
if (URLWriter.isUrlEncoded()) {
urlTemplate.setMimeType(MimeType.XHTML);
} else {
urlTemplate.setMimeType(MimeType.PLAIN);
}
urlTemplate.setPath(pcontext.getNodePath());
urlTemplate.setResource(EMPTY_COMPONENT);
urlTemplate.setAction("_portal:action_");
return urlTemplate.toString();
}
public String getBaseURL() throws UnsupportedEncodingException {
PortalRequestContext pcontext = Util.getPortalRequestContext();
NodeURL nodeURL = pcontext.createURL(NodeURL.TYPE,
new NavigationResource(pcontext.getSiteKey(), pcontext.getNodePath()));
if (URLWriter.isUrlEncoded()) {
nodeURL.setMimeType(MimeType.XHTML);
} else {
nodeURL.setMimeType(MimeType.PLAIN);
}
return nodeURL.toString();
}
/**
* @return the editLevel
*/
public EditLevel getEditLevel() {
return editLevel;
}
/**
* @param editLevel the editLevel to set
*/
public void setEditLevel(EditLevel editLevel) {
this.editLevel = editLevel;
}
public EditMode getEditMode() {
switch (modeState) {
case NORMAL_MODE:
return EditMode.NO_EDIT;
case APP_BLOCK_EDIT_MODE:
case CONTAINER_BLOCK_EDIT_MODE:
return EditMode.BLOCK;
case APP_VIEW_EDIT_MODE:
case CONTAINER_VIEW_EDIT_MODE:
return EditMode.PREVIEW;
default:
throw new IllegalStateException("Unexpected "+ UIPortalApplication.class.getName() +".modeState value "+ modeState +".");
}
}
public ComponentTab getComponentTab() {
switch (modeState) {
case NORMAL_MODE:
return ComponentTab.NO_EDIT;
case APP_VIEW_EDIT_MODE:
case APP_BLOCK_EDIT_MODE:
return ComponentTab.APPLICATIONS;
case CONTAINER_BLOCK_EDIT_MODE:
case CONTAINER_VIEW_EDIT_MODE:
return ComponentTab.CONTAINERS;
default:
throw new IllegalStateException("Unexpected "+ UIPortalApplication.class.getName() +".modeState value "+ modeState +".");
}
}
}