UIPage.java

/**
 * 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.page;

import java.util.ArrayList;
import java.util.List;

import javax.portlet.WindowState;

import org.exoplatform.commons.utils.PropertyManager;
import org.exoplatform.portal.application.PortalRequestContext;
import org.exoplatform.portal.config.DataStorage;
import org.exoplatform.portal.config.UserACL;
import org.exoplatform.portal.config.model.Page;
import org.exoplatform.portal.mop.SiteKey;
import org.exoplatform.portal.mop.page.PageContext;
import org.exoplatform.portal.mop.page.PageKey;
import org.exoplatform.portal.mop.page.PageService;
import org.exoplatform.portal.webui.application.UIPortlet;
import org.exoplatform.portal.webui.container.UIContainer;
import org.exoplatform.portal.webui.portal.UIPortalComponentActionListener.MoveChildActionListener;
import org.exoplatform.portal.webui.portal.UIPortalComposer;
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.UIPortalApplication;
import org.exoplatform.portal.webui.workspace.UIPortalApplication.ComponentTab;
import org.exoplatform.portal.webui.workspace.UIPortalApplication.EditLevel;
import org.exoplatform.portal.webui.workspace.UIPortalApplication.EditMode;
import org.exoplatform.portal.webui.workspace.UIPortalToolPanel;
import org.exoplatform.portal.webui.workspace.UIWorkingWorkspace;
import org.exoplatform.web.application.ApplicationMessage;
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.UIComponent;
import org.exoplatform.webui.event.Event;
import org.exoplatform.webui.event.EventListener;

/**
 * May 19, 2006
 */
@ComponentConfig(lifecycle = UIPageLifecycle.class, template = "system:/groovy/portal/webui/page/UIPage.gtmpl", events = {
        @EventConfig(listeners = MoveChildActionListener.class),
        @EventConfig(name = "EditCurrentPage", listeners = UIPage.EditCurrentPageActionListener.class) })
public class UIPage extends UIContainer {

    /**
     * Property settable in the portal'S configuration.properties file. See also {@link #isFullPreview()}.
     * {@link #getDefaultEditMode()}.
     */
    private static final String FULL_PREVIEW_PROPERTY = "gatein.portal.pageEditor.fullPreview";

    private static Boolean fullPreview = null;

    /**
     * Returns a locally cached value of {@value #FULL_PREVIEW_PROPERTY} property from configuration.properties.
     *
     * @return
     */
    public static boolean isFullPreview() {
        if (fullPreview == null) {
            /*
             * Lazy 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.
             */
            fullPreview = Boolean.valueOf(PropertyManager.getProperty(FULL_PREVIEW_PROPERTY));
        }
        return fullPreview.booleanValue();
    }

    public static boolean isFullPreviewInPageEditor() {
        if (!isFullPreview()) {
            return false;
        } else {
            UIPortalApplication uiPortalApp = Util.getUIPortalApplication();
            return uiPortalApp.getEditMode() == EditMode.PREVIEW
                    && uiPortalApp.getEditLevel() == EditLevel.EDIT_PAGE;
        }
    }

    /** . */
    private String pageId;

    private SiteKey siteKey;

    private String editPermission;

    private boolean showMaxWindow = false;

    private UIPortlet maximizedUIPortlet;

    public static String DEFAULT_FACTORY_ID = "Default";

    public SiteKey getSiteKey() {
        return siteKey;
    }

    public void setSiteKey(SiteKey key) {
        siteKey = key;
    }

    /**
     * @deprecated use {@link #getSiteKey()} instead
     *
     * @return
     */
    @Deprecated
    public String getOwnerType() {
        return getSiteKey().getTypeName();
    }

    /**
     * @deprecated use {@link #getSiteKey()} instead
     *
     * @return
     */
    @Deprecated
    public String getOwnerId() {
        return getSiteKey().getName();
    }

    public boolean isShowMaxWindow() {
        return showMaxWindow;
    }

    public void setShowMaxWindow(Boolean showMaxWindow) {
        this.showMaxWindow = showMaxWindow;
    }

    public String getEditPermission() {
        return editPermission;
    }

    public void setEditPermission(String editPermission) {
        this.editPermission = editPermission;
    }

    public String getPageId() {
        return pageId;
    }

    public void setPageId(String id) {
        pageId = id;
    }

    public UIPortlet getMaximizedUIPortlet() {
        return maximizedUIPortlet;
    }

    public void setMaximizedUIPortlet(UIPortlet maximizedUIPortlet) {
        this.maximizedUIPortlet = maximizedUIPortlet;
    }

    public void switchToEditMode() throws Exception {
        PageService pageService = this.getApplicationComponent(PageService.class);
        DataStorage dataStorage = this.getApplicationComponent(DataStorage.class);

        PageKey pageKey = new PageKey(getSiteKey(), getName());
        PageContext pageContext = pageService.loadPage(pageKey);
        if (pageContext == null) {
            UIPortalApplication uiApp = Util.getUIPortalApplication();
            ApplicationMessage msg = new ApplicationMessage("UIPageBrowser.msg.PageNotExist", new String[] { pageKey.format() }, 1);
            uiApp.addMessage(msg);
        } else {
            Page page = dataStorage.getPage(pageKey.format());
            pageContext.update(page);
            switchToEditMode(page);
        }
    }

    public void switchToEditMode(Page page) throws Exception {
        WebuiRequestContext context = WebuiRequestContext.getCurrentInstance();

        // check edit permission for page
        UserACL userACL = getApplicationComponent(UserACL.class);
        if (!userACL.hasEditPermission(page)) {
            context.getUIApplication().addMessage(
                    new ApplicationMessage("UIPortalManagement.msg.Invalid-EditPage-Permission", null));
            return;
        }

        UIPortalApplication uiApp = Util.getUIPortalApplication();
        UIWorkingWorkspace uiWorkingWS = uiApp.getChildById(UIPortalApplication.UI_WORKING_WS_ID);
        uiWorkingWS.setRenderedChild(UIEditInlineWorkspace.class);

        UIPortalComposer portalComposer = uiWorkingWS.findFirstComponentOfType(UIPortalComposer.class).setRendered(true);
        portalComposer.setComponentConfig(UIPortalComposer.class, UIPortalComposer.UIPAGE_EDITOR);
        portalComposer.setId(UIPortalComposer.UIPAGE_EDITOR);
        portalComposer.setShowControl(true);
        portalComposer.setEditted(false);
        portalComposer.setCollapse(false);

        UIPortalToolPanel uiToolPanel = uiWorkingWS.findFirstComponentOfType(UIPortalToolPanel.class);
        uiToolPanel.setShowMaskLayer(false);
        uiApp.setDefaultEditMode(ComponentTab.APPLICATIONS, EditLevel.EDIT_PAGE);

        // We clone the edited UIPage object, that is required for Abort action
        UIPage newUIPage = uiWorkingWS.createUIComponent(UIPage.class, null, null);
        PortalDataMapper.toUIPage(newUIPage, page);
        uiToolPanel.setWorkingComponent(newUIPage);

        // Remove current UIPage from UIPageBody
        UIPageBody pageBody = uiWorkingWS.findFirstComponentOfType(UIPageBody.class);
        pageBody.setUIComponent(null);

        PortalRequestContext prContext = Util.getPortalRequestContext();
        prContext.addUIComponentToUpdateByAjax(uiWorkingWS);
        prContext.setFullRender(true);
    }

    public static class EditCurrentPageActionListener extends EventListener<UIPage> {
        @Override
        public void execute(Event<UIPage> event) throws Exception {
            event.getSource().switchToEditMode();
        }
    }

    private List<UIPortlet> recursivelyFindUIPortlets(org.exoplatform.webui.core.UIContainer uiContainer) {
        List<UIPortlet> uiPortletList = new ArrayList<UIPortlet>();

        for(UIComponent uiComponent : uiContainer.getChildren()) {
            if(org.exoplatform.webui.core.UIContainer.class.isAssignableFrom(uiComponent.getClass())) {
                org.exoplatform.webui.core.UIContainer childUIContainer = (org.exoplatform.webui.core.UIContainer) uiComponent;
                if(UIPortlet.class.isAssignableFrom(childUIContainer.getClass())) {
                    uiPortletList.add((UIPortlet) childUIContainer);
                } else {
                    uiPortletList.addAll(recursivelyFindUIPortlets(childUIContainer));
                }
            }
        }

        return uiPortletList;
    }

    public void normalizePortletWindowStates() {
        for(UIPortlet childUIPortlet : recursivelyFindUIPortlets(this)) {
            if(!WindowState.MINIMIZED.equals(childUIPortlet.getCurrentWindowState())) {
                childUIPortlet.setCurrentWindowState(WindowState.NORMAL);
            }
        }
    }

    @Override
    public String getPermissionClasses() {
        StringBuilder permissionClasses = new StringBuilder();
        if (!hasMoveAppsPermission()) {
            permissionClasses.append(" CannotMoveApps");
        }
        if (!hasMoveContainersPermission()) {
            permissionClasses.append(" CannotMoveContainers");
        }
        return permissionClasses.toString();
    }

}