/**
 * 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:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.apereo.portal.security.IPerson;
import org.w3c.dom.Attr;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;

/**
 * Applies user changes that are part of the uPortal User Preferences storage (not part of the
 * layout structure) to the user's plf prior to persisting.
 *
 * @since 2.5
 */
public class UserPrefsHandler {
    /**
     * Records changes made to element attributes that are defined as being part of a user's user
     * preferences object and not part of the layout. These attributes are specified in the .sdf
     * files for the structure and theme stylesheets. The value is not stored in the layout but the
     * loading of user prefs joins to a layout struct and hence that struct must exist in the
     * layout. This call gets that node into the PLF if not there already and prevents it from being
     * removed if no other changes were made to it or its children by the user.
     */
    public static void setUserPreference(Element compViewNode, String attributeName, IPerson person)
            throws Exception {
        Document doc = compViewNode.getOwnerDocument();
        NodeList nodes = doc.getElementsByTagName("layout");

        boolean layoutOwner = false;
        boolean templateUser = false;
        Attr attrib = null;
        Element e = null;
        // Search Elements in nodelist
        for (int i = 0; i < nodes.getLength(); i++) {
            e = (Element) nodes.item(i);
            attrib = e.getAttributeNodeNS(Constants.NS_URI, Constants.LCL_FRAGMENT_NAME);
            if (attrib != null) {
                layoutOwner = true;
            } else {
                attrib = e.getAttributeNodeNS(Constants.NS_URI, Constants.LCL_IS_TEMPLATE_USER);
                if (attrib != null) {
                    templateUser = true;
                }
            }
        }

        if (!layoutOwner && !templateUser) {
            Element plfNode =
                    HandlerUtils.getPLFNode(
                            compViewNode,
                            person,
                            true, // create if not found
                            false);
            if (plfNode.getAttributeNodeNS(Constants.NS_URI, Constants.LCL_ORIGIN) != null)
                EditManager.addPrefsDirective(plfNode, attributeName, person);
        }
    }
}