/*

  * Copyright 2005-2007 The Kuali Foundation

  * 

  * 

  * Licensed under the Educational Community 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

  * 

  * http://www.opensource.org/licenses/ecl2.php

  * 

  * 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.kuali.rice.kew.xml;

 import org.apache.commons.lang.StringUtils;

 import org.kuali.rice.core.api.impex.xml.XmlConstants;

 import org.kuali.rice.core.api.util.xml.XmlException;

 import org.kuali.rice.core.api.util.xml.XmlJotter;

 import org.kuali.rice.kew.rule.bo.RuleAttribute;

 import org.kuali.rice.kew.rule.xmlrouting.XPathHelper;

 import org.kuali.rice.kew.service.KEWServiceLocator;

 import org.kuali.rice.kew.util.KEWConstants;

 import org.w3c.dom.Element;

 import org.w3c.dom.Node;

 import org.w3c.dom.NodeList;

 import org.xml.sax.InputSource;

 import javax.xml.parsers.DocumentBuilderFactory;

 import javax.xml.xpath.XPath;

 import javax.xml.xpath.XPathConstants;

 import javax.xml.xpath.XPathExpressionException;

 import java.io.IOException;

 import java.io.InputStream;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import static org.kuali.rice.core.api.impex.xml.XmlConstants.APPLICATION_ID;

 /**

  * Parses {@link RuleAttribute}s from XML.

  *

  * @see RuleAttribute

  *

  * @author Kuali Rice Team (rice.collab@kuali.org)

  */

 public class RuleAttributeXmlParser {

     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(RuleAttributeXmlParser.class);

     private static final String XPATH_RULE_ATTRIBUTES = "//" + XmlConstants.RULE_ATTRIBUTES + "/" + XmlConstants.RULE_ATTRIBUTE;

         private static final String NAME = "name";

         private static final String CLASS_NAME = "className";

         private static final String LABEL = "label";

         private static final String DESCRIPTION = "description";

         private static final String TYPE = "type";

         private static final String CONFIG = "configuration";

         public List parseRuleAttributes(InputStream input) throws IOException, XmlException {

                 try {

                         Element root = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(new InputSource(input)).getDocumentElement();

                         return parseRuleAttributes(root);

                 } catch (Exception e) {

                         throw new XmlException("error parsing xml data", e);

                 }

         }

         public List parseRuleAttributes(Element element) throws XmlException {

                 List ruleAttributes = new ArrayList();

                 try {

                         XPath xpath = XPathHelper.newXPath();

                         NodeList nodeList = (NodeList)xpath.evaluate(XPATH_RULE_ATTRIBUTES, element, XPathConstants.NODESET);

                         for (int i = 0; i < nodeList.getLength(); i++) {

                                 Node ruleAttributeNode = nodeList.item(i);

                                 ruleAttributes.add(parseRuleAttribute(ruleAttributeNode));

                         }

                         for (Iterator iterator = ruleAttributes.iterator(); iterator.hasNext();) {

                                 RuleAttribute ruleAttribute = (RuleAttribute) iterator.next();

                                 try {

                     RuleAttribute existingAttribute = KEWServiceLocator.getRuleAttributeService().findByName(ruleAttribute.getName());

                     if (existingAttribute != null) {

                         ruleAttribute.setRuleAttributeId(existingAttribute.getRuleAttributeId());

                         ruleAttribute.setVersionNumber(existingAttribute.getVersionNumber());

                     }

                                     KEWServiceLocator.getRuleAttributeService().save(ruleAttribute);

                                 } catch (Exception e) {

                         LOG.error("Error saving rule attribute entered by XML", e);

                                 }

                         }

                 } catch (XPathExpressionException e1) {

                         throw new XmlException("Could not find a rule attribute.", e1);

                 }

                 return ruleAttributes;

         }

         private RuleAttribute parseRuleAttribute(Node ruleAttributeNode) throws XmlException {

                 String name = "";

                 String className = "";

                 String label = "";

                 String description = "";

                 String type = "";

                 String applicationId = null;

                 Node xmlConfig = null;

                 for (int i = 0; i < ruleAttributeNode.getChildNodes().getLength(); i++) {

                         Node childNode = ruleAttributeNode.getChildNodes().item(i);

                         if(NAME.equals(childNode.getNodeName())){

                                 name = childNode.getFirstChild().getNodeValue();

                         } else if(CLASS_NAME.equals(childNode.getNodeName())){

                                 className = childNode.getFirstChild().getNodeValue();

                         } else if(LABEL.equals(childNode.getNodeName())){

                                 label = childNode.getFirstChild().getNodeValue();

                         } else if(DESCRIPTION.equals(childNode.getNodeName())){

                                 description = childNode.getFirstChild().getNodeValue();

                         } else if(TYPE.equals(childNode.getNodeName())){

                                 type = childNode.getFirstChild().getNodeValue();

                         } else if(XmlConstants.ROUTING_CONFIG.equals(childNode.getNodeName()) || XmlConstants.SEARCHING_CONFIG.equals(childNode.getNodeName()) || 

                                         XmlConstants.SEARCH_RESULT_CONFIG.equals(childNode.getNodeName()) || XmlConstants.RESOLVER_CONFIG.equals(childNode.getNodeName()) ||

                                         CONFIG.equals(childNode.getNodeName())){

                                 xmlConfig = childNode;

                         } else if (XmlConstants.SERVICE_NAMESPACE.equals(childNode.getNodeName())) {

                                 applicationId = childNode.getFirstChild().getNodeValue();

                                 LOG.warn(XmlConstants.SERVICE_NAMESPACE + " element was set on rule attribute type XML but is deprecated and will be removed in a future version, please use " + APPLICATION_ID + " instead.");

                         } else if (XmlConstants.APPLICATION_ID.equals(childNode.getNodeName())) {

                                 applicationId = childNode.getFirstChild().getNodeValue();

                         }

                 }

                 if (org.apache.commons.lang.StringUtils.isEmpty(name)) {

                         throw new XmlException("RuleAttribute must have a name");

                 }

                 if (org.apache.commons.lang.StringUtils.isEmpty(className)) {

                         throw new XmlException("RuleAttribute must have a className");

                 }

                 if (org.apache.commons.lang.StringUtils.isEmpty(label)) {

                         LOG.warn("Label empty defaulting to name");

                         label = name;

                 }

                 if (org.apache.commons.lang.StringUtils.isEmpty(type)) {

                         LOG.debug("No type specified, default to " + KEWConstants.RULE_ATTRIBUTE_TYPE);

                         type = KEWConstants.RULE_ATTRIBUTE_TYPE;

                         //throw new XmlException("RuleAttribute must have an attribute type");

                 }

                 RuleAttribute ruleAttribute = new RuleAttribute();

                 ruleAttribute.setName(name.trim());

                 ruleAttribute.setClassName(className.trim());

                 ruleAttribute.setType(type.trim());

                 ruleAttribute.setLabel(label.trim());

 //                 default description to label

         if (StringUtils.isEmpty(description)) {

             description = label;

         }

                 ruleAttribute.setDescription(description.trim());

                 if (applicationId != null)

                 {

                         applicationId = applicationId.trim();

                 }

                 ruleAttribute.setApplicationId(applicationId);

                 if(xmlConfig != null){

                     ruleAttribute.setXmlConfigData(XmlJotter.jotNode(xmlConfig));

                 } else {

                         if(KEWConstants.RULE_XML_ATTRIBUTE_TYPE.equals(type)){

                                 throw new XmlException("A routing config must be present to be of type: "+type);

                         } else if(KEWConstants.SEARCHABLE_XML_ATTRIBUTE_TYPE.equals(type)){

                                 throw new XmlException("A searching config must be present to be of type: "+type);

                         } else if(KEWConstants.SEARCH_RESULT_XML_PROCESSOR_ATTRIBUTE_TYPE.equals(type)){

                                 throw new XmlException("A searching config must be present to be of type: "+type);

                         }

                 }

                 return ruleAttribute;

         }        

 }