/**
* 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.portal;
import java.util.List;
import org.exoplatform.application.registry.Application;
import org.exoplatform.portal.application.PortalRequestContext;
import org.exoplatform.portal.config.DataStorage;
import org.exoplatform.portal.config.UserACL;
import org.exoplatform.portal.config.UserPortalConfigService;
import org.exoplatform.portal.config.model.ApplicationState;
import org.exoplatform.portal.config.model.ApplicationType;
import org.exoplatform.portal.config.model.CloneApplicationState;
import org.exoplatform.portal.config.model.Container;
import org.exoplatform.portal.config.model.TransientApplicationState;
import org.exoplatform.portal.webui.application.PortletState;
import org.exoplatform.portal.webui.application.UIPortlet;
import org.exoplatform.portal.webui.container.UIComponentFactory;
import org.exoplatform.portal.webui.container.UITabContainer;
import org.exoplatform.portal.webui.login.UILogin;
import org.exoplatform.portal.webui.login.UIResetPassword;
import org.exoplatform.portal.webui.page.UIPage;
import org.exoplatform.portal.webui.page.UIPageBody;
import org.exoplatform.portal.webui.util.PortalDataMapper;
import org.exoplatform.portal.webui.util.Util;
import org.exoplatform.portal.webui.workspace.UIEditInlineWorkspace;
import org.exoplatform.portal.webui.workspace.UIMaskWorkspace;
import org.exoplatform.portal.webui.workspace.UIPortalApplication;
import org.exoplatform.portal.webui.workspace.UIPortalToolPanel;
import org.exoplatform.portal.webui.workspace.UIWorkingWorkspace;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import org.exoplatform.services.organization.OrganizationService;
import org.exoplatform.services.organization.User;
import org.exoplatform.services.organization.UserStatus;
import org.exoplatform.web.application.ApplicationMessage;
import org.exoplatform.web.application.RequireJS;
import org.exoplatform.web.security.GateInToken;
import org.exoplatform.web.security.security.RemindPasswordTokenService;
import org.exoplatform.webui.application.WebuiRequestContext;
import org.exoplatform.webui.core.UIComponent;
import org.exoplatform.webui.core.UIContainer;
import org.exoplatform.webui.core.UITabPane;
import org.exoplatform.webui.event.Event;
import org.exoplatform.webui.event.EventListener;
/** Author : Nhu Dinh Thuan nhudinhthuan@yahoo.com Jun 14, 2006 */
public class UIPortalComponentActionListener {
private static Log log = ExoLogger.getLogger(UIPortalComponentActionListener.class);
private static final String UI_PORTLET_PREFIX = "UIPortlet-";
public static class ViewChildActionListener extends EventListener<UIContainer> {
public void execute(Event<UIContainer> event) throws Exception {
UIContainer uiContainer = event.getSource();
String id = event.getRequestContext().getRequestParameter(UIComponent.OBJECTID);
uiContainer.setRenderedChild(id);
}
}
public static class ShowLoginFormActionListener extends EventListener<UIPortalComponent> {
public void execute(Event<UIPortalComponent> event) throws Exception {
UIPortal uiPortal = Util.getUIPortal();
UIPortalApplication uiApp = uiPortal.getAncestorOfType(UIPortalApplication.class);
UIMaskWorkspace uiMaskWS = uiApp.getChildById(UIPortalApplication.UI_MASK_WS_ID);
UILogin uiLogin = uiMaskWS.createUIComponent(UILogin.class, null, null);
uiMaskWS.setUIComponent(uiLogin);
uiMaskWS.setWindowSize(630, -1);
event.getRequestContext().addUIComponentToUpdateByAjax(uiMaskWS);
}
}
public static class DeleteComponentActionListener extends EventListener<UIComponent> {
public void execute(Event<UIComponent> event) throws Exception {
UIComponent uiComponentTobeRemoved = event.getSource();
String id = uiComponentTobeRemoved.getId();
UIPortalApplication uiApp = Util.getUIPortalApplication();
if (uiComponentTobeRemoved.findFirstComponentOfType(UIPageBody.class) != null) {
uiApp.addMessage(new ApplicationMessage("UIPortalApplication.msg.deletePageBody", new Object[] {},
ApplicationMessage.WARNING));
return;
}
org.exoplatform.portal.webui.container.UIContainer uiParent = uiComponentTobeRemoved.getParent();
if (!canMove(uiComponentTobeRemoved, (org.exoplatform.portal.webui.container.UIContainer) uiParent)) {
/* deletion not allowed */
return;
}
UIPortalComposer portalComposer = uiApp.findFirstComponentOfType(UIPortalComposer.class);
portalComposer.setEditted(true);
UIPage uiPage = uiComponentTobeRemoved.getAncestorOfType(UIPage.class);
if (uiPage != null && uiPage.getMaximizedUIPortlet() != null) {
if (id.equals(uiPage.getMaximizedUIPortlet().getId())) {
uiPage.setMaximizedUIPortlet(null);
}
} else {
UIPortal uiPortal = Util.getUIPortal();
if (uiPortal != null && uiPortal.getMaximizedUIComponent() != null) {
if (id.equals(uiPortal.getMaximizedUIComponent().getId())) {
uiPortal.setMaximizedUIComponent(null);
}
}
}
PortalRequestContext pcontext = (PortalRequestContext) event.getRequestContext();
if (UITabContainer.TAB_CONTAINER.equals(uiParent.getFactoryId())) {
/*
* Check if it is removing the last tab then we will remove the TabContainer as well
*
* Indeed, a TabContainer is nested into a normal container so we should remove the its parent instead of itself
* when we delete the last tab
*/
if (uiParent.getChildren().size() == 1) {
UIContainer uiTabParent = uiParent.getParent();
if (uiTabParent.getChildren().size() > 1) {
uiComponentTobeRemoved = uiParent;
} else {
uiComponentTobeRemoved = uiTabParent;
}
} else {
removeUIComponent(uiComponentTobeRemoved, pcontext, true);
return;
}
} else if (org.exoplatform.portal.webui.container.UIContainer.TABLE_COLUMN_CONTAINER
.equals(uiParent.getFactoryId())) {
if (uiParent.getChildren().size() == 1) {
uiComponentTobeRemoved = uiParent;
}
}
removeUIComponent(uiComponentTobeRemoved, pcontext, false);
}
}
/**
* Remove an UIComponent from server side and adding removing behaviors in javascript to clients if necessary
*/
private static void removeUIComponent(UIComponent uiComponent, PortalRequestContext pcontext, boolean isUpdate) {
UIContainer uiParent = uiComponent.getParent();
uiParent.getChildren().remove(uiComponent);
RequireJS module = pcontext.getJavascriptManager().require("SHARED/portal", "portal");
if (isUpdate) {
pcontext.addUIComponentToUpdateByAjax(uiParent);
pcontext.ignoreAJAXUpdateOnPortlets(true);
} else {
StringBuffer buffer = new StringBuffer();
buffer.append("portal.UIPortal.removeComponent('");
if (uiComponent instanceof UIPortlet) {
buffer.append(UI_PORTLET_PREFIX);
}
buffer.append(uiComponent.getId());
buffer.append("');");
module.addScripts(buffer.toString());
}
module.require("SHARED/portalComposer", "portalComposer").addScripts("portalComposer.toggleSaveButton();");
}
private static boolean canMove(UIComponent child, final UIContainer parent) {
if (parent instanceof org.exoplatform.portal.webui.container.UIContainer) {
org.exoplatform.portal.webui.container.UIContainer targetContainer = (org.exoplatform.portal.webui.container.UIContainer) parent;
if (child instanceof UIPortlet<?, ?>) {
return targetContainer.hasMoveAppsPermission();
} else if (child instanceof org.exoplatform.portal.webui.container.UIContainer) {
return targetContainer.hasMoveContainersPermission();
} else if (child instanceof org.exoplatform.portal.webui.page.UIPageBody) {
/* Allowed always to everyone */
return true;
} else {
log.warn("Unexpected uiSource type '"+ child.getClass().getName() +"'.");
return false;
}
} else {
return false;
}
}
public static class MoveChildActionListener extends EventListener<UIContainer> {
public void execute(Event<UIContainer> event) throws Exception {
PortalRequestContext pcontext = (PortalRequestContext) event.getRequestContext();
String insertPosition = pcontext.getRequestParameter("insertPosition");
int position = -1;
try {
position = Integer.parseInt(insertPosition);
} catch (Exception exp) {
position = -1;
}
boolean newComponent = false;
String paramNewComponent = pcontext.getRequestParameter("isAddingNewly");
if (paramNewComponent != null)
newComponent = Boolean.valueOf(paramNewComponent).booleanValue();
UIPortalApplication uiApp = event.getSource().getAncestorOfType(UIPortalApplication.class);
UIPortalComposer portalComposer = uiApp.findFirstComponentOfType(UIPortalComposer.class);
if (newComponent) {
portalComposer.updateWorkspaceComponent();
pcontext.ignoreAJAXUpdateOnPortlets(true);
}
UIWorkingWorkspace uiWorkingWS = uiApp.getChild(UIWorkingWorkspace.class);
UIComponent uiWorking = uiWorkingWS.findFirstComponentOfType(UIPortalToolPanel.class);
if (!uiWorking.isRendered()) {
UIEditInlineWorkspace uiEditWS = uiWorkingWS.getChild(UIEditInlineWorkspace.class);
uiWorking = uiEditWS.getUIComponent();
}
String sourceId = pcontext.getRequestParameter("srcID");
UIComponent uiSource = uiWorking.findComponentById(sourceId);
final UIContainer uiTarget = uiWorking.findComponentById(pcontext.getRequestParameter("targetID"));
if (position < 0 && uiTarget.getChildren().size() > 0) {
position = uiTarget.getChildren().size();
} else if (position < 0) {
position = 0;
}
if (uiSource == null) {
uiSource = prepareUiSource(newComponent, uiApp, portalComposer, sourceId, uiTarget);
}
if (canMove(uiSource, uiTarget)) {
move(position, uiSource, uiTarget, pcontext);
} else {
portalComposer.updateWorkspaceComponent();
pcontext.ignoreAJAXUpdateOnPortlets(true);
}
}
/**
* @param pcontext
* @param uiSource
*/
private void tidyUp(PortalRequestContext pcontext, UIComponent uiSource) {
org.exoplatform.portal.webui.container.UIContainer uiParent = uiSource.getParent();
if (UITabContainer.TAB_CONTAINER.equals(uiParent.getFactoryId())) {
if (uiParent.getChildren().size() == 1) {
UIContainer uiTabParent = uiParent.getParent();
if (uiTabParent.getChildren().size() > 1) {
removeUIComponent(uiParent, pcontext, false);
} else {
removeUIComponent(uiTabParent, pcontext, false);
}
} else {
uiParent.getChildren().remove(uiSource);
pcontext.addUIComponentToUpdateByAjax(uiParent);
pcontext.ignoreAJAXUpdateOnPortlets(true);
}
} else if (org.exoplatform.portal.webui.container.UIContainer.TABLE_COLUMN_CONTAINER
.equals(uiParent.getFactoryId()) && uiParent.getChildren().size() == 1) {
removeUIComponent(uiParent, pcontext, false);
} else {
uiParent.getChildren().remove(uiSource);
}
}
private UIComponent prepareUiSource(boolean newComponent, UIPortalApplication uiApp, UIPortalComposer portalComposer,
String sourceId, final UIContainer uiTarget) throws Exception {
UIComponent uiSource;
UITabPane subTabPane = portalComposer.getChild(UITabPane.class);
UIContainerList uiContainerConfig = subTabPane.getChild(UIContainerList.class);
if (uiContainerConfig != null && subTabPane.getSelectedTabId().equals(uiContainerConfig.getId())) {
Container container = uiContainerConfig.getContainer(sourceId);
UIComponentFactory<? extends org.exoplatform.portal.webui.container.UIContainer> factory =
UIComponentFactory.getInstance(org.exoplatform.portal.webui.container.UIContainer.class);
org.exoplatform.portal.webui.container.UIContainer uiContainer =
factory.createUIComponent(container.getFactoryId(), WebuiRequestContext.<WebuiRequestContext>getCurrentInstance());
if (uiContainer == null) {
log.warn("Can't find container factory for: {}. Default container is used", container.getFactoryId());
uiContainer = uiTarget.createUIComponent(org.exoplatform.portal.webui.container.UIContainer.class, null, null);
}
// GTNPORTAL-3118: IBM JDK creates negative hashCodes and drag and drop webui logic expects abs values.
container.setId(String.valueOf(Math.abs(container.hashCode())));
uiContainer.setStorageId(container.getStorageId());
PortalDataMapper.toUIContainer(uiContainer, container);
uiSource = uiContainer;
} else {
Application app = null;
UIApplicationList appList = uiApp.findFirstComponentOfType(UIApplicationList.class);
app = appList.getApplication(sourceId);
@SuppressWarnings("unchecked")
ApplicationType<Object> applicationType = app.getType();
//
@SuppressWarnings("unchecked")
UIPortlet<Object, ?> uiPortlet = uiTarget.createUIComponent(UIPortlet.class, null, null);
// Only setting title for Gadgets as it's using Portlet wrapper for displaying
if (app.getType().equals(ApplicationType.GADGET)) {
uiPortlet.setTitle(app.getDisplayName());
}
uiPortlet.setDescription(app.getDescription());
List<String> accessPersList = app.getAccessPermissions();
String[] accessPers = accessPersList.toArray(new String[accessPersList.size()]);
for (String accessPer : accessPers) {
if (accessPer.equals(""))
accessPers = null;
}
if (accessPers == null || accessPers.length == 0)
accessPers = new String[] { UserACL.EVERYONE };
uiPortlet.setAccessPermissions(accessPers);
// Hardcode on state to fix error while drag/drop Dashboard
if ("dashboard/DashboardPortlet".equals(app.getContentId())) {
TransientApplicationState<Object> state = new TransientApplicationState<Object>(app.getContentId());
uiPortlet.setState(new PortletState<Object>(state, applicationType));
} else {
ApplicationState<Object> state;
// if we have a new portlet added to the page we need for it to have its own state.
// otherwise all new portlets added to a page will have the same state.
if (newComponent) {
state = new TransientApplicationState<Object>(app.getContentId());
// if the portlet is not new, then we should clone it from the original portlet
} else {
state = new CloneApplicationState<Object>(app.getStorageId());
}
uiPortlet.setState(new PortletState<Object>(state, applicationType));
}
uiPortlet.setPortletInPortal(uiTarget instanceof UIPortal);
// TODO Wait to fix issue EXOGTN-213 and then
// we should get "showInfobar" from current UI portal instead of Storage service
UIPortal currentPortal = Util.getUIPortal();
DataStorage storage = uiApp.getApplicationComponent(DataStorage.class);
uiPortlet.setShowInfoBar(storage.getPortalConfig(currentPortal.getSiteKey().getTypeName(),
currentPortal.getSiteKey().getName()).isShowInfobar());
uiSource = uiPortlet;
}
return uiSource;
}
/**
* @param position
* @param uiSource
* @param uiTarget
* @param pcontext
*/
private void move(int position, UIComponent uiSource, final UIContainer uiTarget, PortalRequestContext pcontext) {
org.exoplatform.portal.webui.container.UIContainer uiParent = uiSource.getParent();
List<UIComponent> children = uiTarget.getChildren();
if (uiParent == uiTarget) {
int currentIdx = children.indexOf(uiSource);
if (position != currentIdx) {
children.remove(currentIdx);
if (position > children.size()) {
children.add(uiSource);
} else {
children.add(position, uiSource);
}
}
} else {
boolean hadParent = uiSource.getParent() != null;
children.add(position, uiSource);
if (hadParent) {
tidyUp(pcontext, uiSource);
}
uiSource.setParent(uiTarget);
}
}
}
public static class ChangeLanguageActionListener extends EventListener<UIPortal> {
@Override
public void execute(Event<UIPortal> event) throws Exception {
UIPortal uiPortal = event.getSource();
UIPortalApplication uiPortalApp = uiPortal.getAncestorOfType(UIPortalApplication.class);
UIMaskWorkspace uiMaskWorkspace = uiPortalApp.getChildById(UIPortalApplication.UI_MASK_WS_ID);
uiMaskWorkspace.createUIComponent(UILanguageSelector.class, null, null);
event.getRequestContext().addUIComponentToUpdateByAjax(uiMaskWorkspace);
}
}
public static class RecoveryPasswordAndUsernameActionListener extends EventListener<UIPortal> {
@Override
public void execute(Event<UIPortal> event) throws Exception {
UIPortal uiPortal = event.getSource();
RemindPasswordTokenService tokenService = uiPortal.getApplicationComponent(RemindPasswordTokenService.class);
String tokenId = event.getRequestContext().getRequestParameter("tokenId");
WebuiRequestContext requestContext = event.getRequestContext();
GateInToken token = tokenService.getToken(tokenId);
if (token == null) {
requestContext.getUIApplication().addMessage(new ApplicationMessage("UIForgetPassword.msg.expration", null));
requestContext.addUIComponentToUpdateByAjax(uiPortal.getParent());
return;
}
OrganizationService orgSrc = uiPortal.getApplicationComponent(OrganizationService.class);
// get user
User user = orgSrc.getUserHandler().findUserByName(token.getPayload().getUsername(), UserStatus.ANY);
if (user == null) {
requestContext.getUIApplication().addMessage(new ApplicationMessage("UIForgetPassword.msg.user-delete", null));
return;
} else if (!user.isEnabled()) {
requestContext.getUIApplication().addMessage(new ApplicationMessage("UIForgetPassword.msg.user-is-disabled", null));
return;
}
UIPortalApplication uiApp = uiPortal.getAncestorOfType(UIPortalApplication.class);
UIMaskWorkspace uiMaskWS = uiApp.getChildById(UIPortalApplication.UI_MASK_WS_ID);
UIResetPassword uiReset = uiMaskWS.createUIComponent(UIResetPassword.class, null, null);
uiReset.setUser(user);
uiReset.setTokenId(tokenId);
uiMaskWS.setUIComponent(uiReset);
uiMaskWS.setWindowSize(630, -1);
event.getRequestContext().addUIComponentToUpdateByAjax(uiMaskWS);
}
}
public static class ChangeSkinActionListener extends EventListener<UIPortal> {
public void execute(Event<UIPortal> event) throws Exception {
UIPortal uiPortal = event.getSource();
UIPortalApplication uiApp = uiPortal.getAncestorOfType(UIPortalApplication.class);
UIMaskWorkspace uiMaskWS = uiApp.getChildById(UIPortalApplication.UI_MASK_WS_ID);
UISkinSelector uiChangeSkin = uiMaskWS.createUIComponent(UISkinSelector.class, null, null);
uiMaskWS.setUIComponent(uiChangeSkin);
uiMaskWS.setWindowSize(640, 400);
uiMaskWS.setShow(true);
event.getRequestContext().addUIComponentToUpdateByAjax(uiMaskWS);
}
}
public static class ChangeApplicationListActionListener extends EventListener<UIPortal> {
public void execute(Event<UIPortal> event) throws Exception {
UIPortalApplication application = Util.getUIPortalApplication();
UIPortalComposer composer = application.findFirstComponentOfType(UIPortalComposer.class);
UITabPane uiTabPane = composer.getChild(UITabPane.class);
String appListId = uiTabPane.getChild(UIApplicationList.class).getId();
uiTabPane.replaceChild(appListId, composer.createUIComponent(UIApplicationList.class, null, null));
}
}
public static class EditPortalPropertiesActionListener extends EventListener<UIPortal> {
public void execute(Event<UIPortal> event) throws Exception {
String portalName = event.getRequestContext().getRequestParameter("portalName");
UIPortal uiPortal = Util.getUIPortal();
UIPortalApplication uiApp = uiPortal.getAncestorOfType(UIPortalApplication.class);
UserPortalConfigService service = uiApp.getApplicationComponent(UserPortalConfigService.class);
PortalRequestContext context = Util.getPortalRequestContext();
if (portalName != null
&& service.getUserPortalConfig(portalName, event.getRequestContext().getRemoteUser()) == null) {
uiApp.addMessage(new ApplicationMessage("UISiteManagement.msg.portal-not-exist", new String[] { portalName }));
context.addUIComponentToUpdateByAjax(uiApp.findFirstComponentOfType(UIWorkingWorkspace.class));
context.setFullRender(true);
return;
}
UIMaskWorkspace uiMaskWS = uiApp.getChildById(UIPortalApplication.UI_MASK_WS_ID);
UIPortalForm portalForm = uiMaskWS.createUIComponent(UIPortalForm.class, null, "UIPortalForm");
portalForm.setPortalOwner(portalName);
portalForm.setBindingBean();
uiMaskWS.setWindowSize(700, -1);
context.addUIComponentToUpdateByAjax(uiMaskWS);
}
}
}