BasePartialUpdateToolbar.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.toolbar.webui.component;

import java.util.Collection;
import java.util.Collections;

import javax.portlet.MimeResponse;
import javax.portlet.PortletPreferences;
import javax.portlet.PortletRequest;
import javax.portlet.ResourceRequest;
import javax.portlet.ResourceURL;

import org.exoplatform.portal.application.PortalRequestContext;
import org.exoplatform.portal.mop.SiteKey;
import org.exoplatform.portal.mop.navigation.GenericScope;
import org.exoplatform.portal.mop.navigation.NodeChange;
import org.exoplatform.portal.mop.navigation.NodeChangeQueue;
import org.exoplatform.portal.mop.navigation.Scope;
import org.exoplatform.portal.mop.user.UserNavigation;
import org.exoplatform.portal.mop.user.UserNode;
import org.exoplatform.portal.mop.user.UserNodeFilterConfig;
import org.exoplatform.portal.mop.user.UserPortal;
import org.exoplatform.portal.webui.util.Util;
import org.exoplatform.web.url.navigation.NavigationResource;
import org.exoplatform.web.url.navigation.NodeURL;
import org.exoplatform.webui.application.WebuiRequestContext;
import org.exoplatform.webui.application.portlet.PortletRequestContext;
import org.exoplatform.webui.core.UIPortletApplication;
import org.json.JSONArray;
import org.json.JSONObject;

/**
 * @author <a href="mailto:phuong.vu@exoplatform.com">Vu Viet Phuong</a>
 * @version $Id$
 *
 */
public abstract class BasePartialUpdateToolbar extends UIPortletApplication {

    protected UserNodeFilterConfig toolbarFilterConfig;
    protected Scope toolbarScope;
    protected static final int DEFAULT_LEVEL = 2;

    public BasePartialUpdateToolbar() throws Exception {
        int level = DEFAULT_LEVEL;
        try {
            PortletRequestContext context = (PortletRequestContext) WebuiRequestContext.getCurrentInstance();
            PortletRequest prequest = context.getRequest();
            PortletPreferences prefers = prequest.getPreferences();

            level = Integer.valueOf(prefers.getValue("level", String.valueOf(DEFAULT_LEVEL)));
        } catch (Exception ex) {
            log.warn("Preference for navigation level can only be integer");
        }

        if (level <= 0) {
            toolbarScope = Scope.ALL;
        } else {
            toolbarScope = GenericScope.treeShape(level);
        }
    }

    protected Collection<UserNode> getNavigationNodes(UserNavigation nav) {
        UserPortal userPortal = getUserPortal();
        if (nav != null) {
            try {
                UserNode rootNodes = userPortal.getNode(nav, toolbarScope, toolbarFilterConfig, null);
                return rootNodes.getChildren();
            } catch (Exception ex) {
                log.warn(nav.getKey().getName() + " has been deleted");
            }
        }
        return Collections.emptyList();
    }

    protected UserNavigation getNavigation(SiteKey key) {
        UserPortal userPortal = getUserPortal();
        return userPortal.getNavigation(key);
    }

    @Override
    public void serveResource(WebuiRequestContext context) throws Exception {
        super.serveResource(context);

        ResourceRequest req = context.getRequest();
        String id = req.getResourceID();

        JSONArray jsChilds = getChildrenAsJSON(getNodeFromResourceID(id));
        if (jsChilds == null) {
            return;
        }

        MimeResponse res = context.getResponse();
        res.setContentType("text/json");
        res.getWriter().write(jsChilds.toString());
    }

    private JSONArray getChildrenAsJSON(UserNode userNode) throws Exception {
        if (userNode == null) {
            return null;
        }

        NodeChangeQueue<UserNode> queue = new NodeChangeQueue<UserNode>();
        getUserPortal().updateNode(userNode, toolbarScope, queue);
        for (NodeChange<UserNode> change : queue) {
            if (change instanceof NodeChange.Removed) {
                UserNode deletedNode = ((NodeChange.Removed<UserNode>) change).getTarget();
                if (hasRelationship(deletedNode, userNode)) {
                    return null;
                }
            }
        }
        Collection<UserNode> childs = userNode.getChildren();

        JSONArray jsChilds = new JSONArray();
        WebuiRequestContext context = WebuiRequestContext.getCurrentInstance();
        MimeResponse res = context.getResponse();
        for (UserNode child : childs) {
            jsChilds.put(toJSON(child, userNode.getNavigation().getKey().getName(), res));
        }
        return jsChilds;
    }

    protected JSONObject toJSON(UserNode node, String navId, MimeResponse res) throws Exception {
        JSONObject json = new JSONObject();
        String nodeId = node.getId();

        json.put("label", node.getEncodedResolvedLabel());
        json.put("hasChild", node.getChildrenCount() > 0);
        json.put("isSelected", nodeId.equals(getSelectedNode().getId()));
        json.put("icon", node.getIcon());

        ResourceURL rsURL = res.createResourceURL();
        rsURL.setResourceID(getResourceIdFromNode(node, navId));
        json.put("getNodeURL", rsURL.toString());

        if (node.getPageRef() != null) {
            NavigationResource resource = new NavigationResource(node);
            NodeURL url = Util.getPortalRequestContext().createURL(NodeURL.TYPE, resource);
            json.put("actionLink", url.setAjax(false).toString());
        }

        JSONArray childs = new JSONArray();
        for (UserNode child : node.getChildren()) {
            childs.put(toJSON(child, navId, res));
        }
        json.put("childs", childs);
        return json;
    }

    protected UserPortal getUserPortal() {
        PortalRequestContext prc = Util.getPortalRequestContext();
        return prc.getUserPortalConfig().getUserPortal();
    }

    protected UserNode getSelectedNode() throws Exception {
        return Util.getUIPortal().getSelectedUserNode();
    }

    private boolean hasRelationship(UserNode parent, UserNode userNode) {
        if (parent.getId().equals(userNode.getId())) {
            return true;
        }
        for (UserNode child : parent.getChildren()) {
            if (hasRelationship(child, userNode)) {
                return true;
            }
        }
        return false;
    }

    protected abstract String getResourceIdFromNode(UserNode node, String navId);

    protected abstract UserNode getNodeFromResourceID(String resourceId) throws Exception;
}