org.apereo.portal.layout.dlm.TabColumnPrefsHandler.java Source code

Introduction

Here is the source code for org.apereo.portal.layout.dlm.TabColumnPrefsHandler.java

Source

/**
 * Licensed to Apereo under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Apereo licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License.  You may obtain a
 * copy of the License at the following location:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apereo.portal.layout.dlm;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apereo.portal.PortalException;
import org.apereo.portal.security.IPerson;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/** 
 * Applies user prefs changes to the user's plf prior to persisting.
 * 
 * @since uPortal 2.5
 */
public class TabColumnPrefsHandler {
    private static Log LOG = LogFactory.getLog(TabColumnPrefsHandler.class);

    /**
       This method is called from the TabColumnPrefsState class after a node
       has already been moved from its old parent to its new in the ILF. We can
       get at the new parent via the compViewNode moved but need a separate
       handle of the parent from whence it came. The goal of this method is to
       make the appropriate change in the PLF to persist this action take by
       the user. For ILF nodes this generally means adding an entry to the
       position set for the new parent and removing any entry if it existed in
       the position set in the old parent. For nodes that are owned by the
       user (PLF owned nodes) the nodes are moved outright and now position
       set is needed unless the new parent contains ILF nodes as well
       requiring preservation of the user's ordering of the nodes for when the
       ILF and PLF are merged again later on.
     */
    public static void moveElement(Element compViewNode, Element oldCompViewParent, IPerson person)
            throws PortalException {
        if (LOG.isInfoEnabled())
            LOG.info("moving " + compViewNode.getAttribute(Constants.ATT_ID));
        Element compViewParent = (Element) compViewNode.getParentNode();

        if (oldCompViewParent != compViewParent) {
            if (LOG.isInfoEnabled())
                LOG.info("reparenting from " + oldCompViewParent.getAttribute(Constants.ATT_ID) + " to "
                        + compViewParent.getAttribute(Constants.ATT_ID));
            // update previous parent if found in PLF
            Element plfParent = HandlerUtils.getPLFNode(oldCompViewParent, person, // only needed if creating
                    false, // only look, don't create
                    false); // also not needed
            if (plfParent != null) {
                PositionManager.updatePositionSet(oldCompViewParent, plfParent, person);
                if (LOG.isInfoEnabled())
                    LOG.info("updating old parent's position set");
            }
        }
        // now take care of the destination
        Element plfParent = HandlerUtils.getPLFNode(compViewParent, person, true, // create parent if not found
                false); // don't create children
        if (compViewNode.getAttribute(Constants.ATT_ID).startsWith(Constants.FRAGMENT_ID_USER_PREFIX)) {
            // ilf node being inserted
            if (LOG.isInfoEnabled())
                LOG.info("ilf node being moved, only update new parent pos set");
            PositionManager.updatePositionSet(compViewParent, plfParent, person);
        } else {
            // plf node
            if (LOG.isInfoEnabled())
                LOG.info("plf node being moved, updating old parent's position set");
            Document plf = (Document) person.getAttribute(Constants.PLF);
            HandlerUtils.createOrMovePLFOwnedNode(compViewNode, compViewParent, false, // should always be found
                    false, // irrelevant, not creating
                    plf, plfParent, person);
        }
    }

    /**
       Handles user requests to delete UI elements. For ILF owned nodes it
       delegates to the DeleteManager to add a delete directive. For PLF
       owned nodes it deletes the node outright.
     */
    public static void deleteNode(Element compViewNode, Element compViewParent, IPerson person)
            throws PortalException {
        String ID = compViewNode.getAttribute(Constants.ATT_ID);

        if (ID.startsWith(Constants.FRAGMENT_ID_USER_PREFIX)) // ilf node
            DeleteManager.addDeleteDirective(compViewNode, ID, person);
        else {
            // plf node
            Document plf = (Document) person.getAttribute(Constants.PLF);
            Element node = plf.getElementById(ID);

            if (node == null)
                return;
            Element parent = (Element) node.getParentNode();
            if (parent == null)
                return;
            parent.removeChild(node);
        }
    }

}