/*

  * Copyright 2007-2009 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 java.io.IOException;

 import java.io.InputStream;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import javax.xml.parsers.ParserConfigurationException;

 import org.apache.commons.lang.StringUtils;

 import org.jdom.Document;

 import org.jdom.Element;

 import org.jdom.JDOMException;

 import org.jdom.Namespace;

 import org.kuali.rice.kew.exception.InvalidXmlException;

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

 import org.kuali.rice.kim.bo.entity.impl.KimEntityEmailImpl;

 import org.kuali.rice.kim.bo.entity.impl.KimEntityEmploymentInformationImpl;

 import org.kuali.rice.kim.bo.entity.impl.KimEntityEntityTypeImpl;

 import org.kuali.rice.kim.bo.entity.impl.KimEntityImpl;

 import org.kuali.rice.kim.bo.entity.impl.KimEntityNameImpl;

 import org.kuali.rice.kim.bo.entity.impl.KimPrincipalImpl;

 import org.kuali.rice.kns.service.KNSServiceLocator;

 import org.kuali.rice.kns.service.SequenceAccessorService;

 import org.xml.sax.SAXException;

 /**

  * Parses users from XML.

  * 

  * This is really meant for use only in the unit tests and was written to help ease

  * transition over to KIM.  There are numerous unit tests which took advantage of

  * the ability to import "users" from XML in KEW.  KIM does not provide XML

  * import capabilities in the initial implementation so this class provides that.

  *

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

  *

  */

 public class UserXmlParser implements XmlConstants {

     private static final Namespace NAMESPACE = Namespace.getNamespace("", "ns:workflow/User");

     private static final String USERS_ELEMENT = "users";

     private static final String USER_ELEMENT = "user";

     private static final String WORKFLOW_ID_ELEMENT = "workflowId";

     private static final String AUTHENTICATION_ID_ELEMENT = "authenticationId";

     private static final String PRINCIPAL_ID_ELEMENT = "principalId";

     private static final String PRINCIPAL_NAME_ELEMENT = "principalName";

     private static final String EMPL_ID_ELEMENT = "emplId";

     private static final String EMAIL_ELEMENT = "emailAddress";

     private static final String GIVEN_NAME_ELEMENT = "givenName";

     private static final String LAST_NAME_ELEMENT = "lastName";    

     private static final String TYPE_ELEMENT = "type";

     public void parseUsers(InputStream input) throws IOException, InvalidXmlException {

         try {

             Document doc = XmlHelper.trimSAXXml(input);

             Element root = doc.getRootElement();

             parseUsers(root);

         } catch (JDOMException e) {

             throw new InvalidXmlException("Parse error.", e);

         } catch (SAXException e){

             throw new InvalidXmlException("Parse error.",e);

         } catch(ParserConfigurationException e){

             throw new InvalidXmlException("Parse error.",e);

         }

     }

     public void parseUsers(Element root) throws InvalidXmlException {

             for (Iterator usersElementIt = root.getChildren(USERS_ELEMENT, NAMESPACE).iterator(); usersElementIt.hasNext();) {

                     Element usersElement = (Element) usersElementIt.next();

                     for (Iterator iterator = usersElement.getChildren(USER_ELEMENT, NAMESPACE).iterator(); iterator.hasNext();) {

                             Element userElement = (Element) iterator.next();

                             KimEntityImpl entity = constructEntity(userElement);

                             constructPrincipal(userElement, entity.getEntityId());

                     }

             }

     }

     protected KimEntityImpl constructEntity(Element userElement) {

         SequenceAccessorService sas = KNSServiceLocator.getSequenceAccessorService();

             String firstName = userElement.getChildTextTrim(GIVEN_NAME_ELEMENT, NAMESPACE);

         String lastName = userElement.getChildTextTrim(LAST_NAME_ELEMENT, NAMESPACE);

         String emplId = userElement.getChildTextTrim(EMPL_ID_ELEMENT, NAMESPACE);

         String entityTypeCode = userElement.getChildTextTrim(TYPE_ELEMENT, NAMESPACE);

         if (StringUtils.isBlank(entityTypeCode)) {

                 entityTypeCode = "PERSON";

         }

         Long entityId = sas.getNextAvailableSequenceNumber("KRIM_ENTITY_ID_S", 

                         KimEntityEmploymentInformationImpl.class);

         // if they define an empl id, let's set that up

         KimEntityEmploymentInformationImpl emplInfo = null;

         if (!StringUtils.isBlank(emplId)) {

                 emplInfo = new KimEntityEmploymentInformationImpl();

                 emplInfo.setActive(true);

                 emplInfo.setEmployeeId(emplId);

                 emplInfo.setPrimary(true);

                 emplInfo.setEntityId("" + entityId);

                 emplInfo.setEntityEmploymentId(emplId);

         }

                 KimEntityImpl entity = new KimEntityImpl();

                 entity.setActive(true);

                 entity.setEntityId("" + entityId);

                 List<KimEntityEmploymentInformationImpl> emplInfos = new ArrayList<KimEntityEmploymentInformationImpl>();

                 if (emplInfo != null) {

                         emplInfos.add(emplInfo);

                 }

                 entity.setEmploymentInformation(emplInfos);

                 KimEntityEntityTypeImpl entityType = new KimEntityEntityTypeImpl();

                 entity.getEntityTypes().add(entityType);

                 entityType.setEntityTypeCode(entityTypeCode);

                 entityType.setEntityId(entity.getEntityId());

                 entityType.setActive(true);

                 if (!StringUtils.isBlank(firstName) || !StringUtils.isBlank(lastName)) {

                         Long entityNameId = sas.getNextAvailableSequenceNumber(

                                         "KRIM_ENTITY_NM_ID_S", KimEntityNameImpl.class);

                         KimEntityNameImpl name = new KimEntityNameImpl();

                         name.setActive(true);

                         name.setEntityNameId("" + entityNameId);

                         name.setEntityId(entity.getEntityId());

                         // must be in krim_ent_nm_typ_t.ent_nm_typ_cd

                         name.setNameTypeCode("PRFR");

                         name.setFirstName(firstName);

                         name.setMiddleName("");

                         name.setLastName(lastName);

                         name.setDefault(true);

                         entity.getNames().add(name);

                 }

                 KNSServiceLocator.getBusinessObjectService().save(entity);

                 String emailAddress = userElement.getChildTextTrim(EMAIL_ELEMENT, NAMESPACE);

                 if (!StringUtils.isBlank(emailAddress)) {

                         Long emailId = sas.getNextAvailableSequenceNumber(

                                         "KRIM_ENTITY_EMAIL_ID_S", KimEntityEmailImpl.class);

                         KimEntityEmailImpl email = new KimEntityEmailImpl();

                         email.setActive(true);

                         email.setEntityEmailId("" + emailId);

                         email.setEntityTypeCode("PERSON");

                         // must be in krim_email_typ_t.email_typ_cd:

                         email.setEmailTypeCode("WRK");

                         email.setEmailAddress(emailAddress);

                         email.setDefault(true);

                         email.setEntityId(entity.getEntityId());

                         KNSServiceLocator.getBusinessObjectService().save(email);

                 }

                 return entity;

     }

     protected KimPrincipalImpl constructPrincipal(Element userElement, String entityId) {

             String principalId = userElement.getChildTextTrim(WORKFLOW_ID_ELEMENT, NAMESPACE);

             if (principalId == null) {

                     principalId = userElement.getChildTextTrim(PRINCIPAL_ID_ELEMENT, NAMESPACE);

             }

             String principalName = userElement.getChildTextTrim(AUTHENTICATION_ID_ELEMENT, NAMESPACE);

             if (principalName == null) {

                     principalName = userElement.getChildTextTrim(PRINCIPAL_NAME_ELEMENT, NAMESPACE);

             }

                 KimPrincipalImpl principal = new KimPrincipalImpl();

                 principal.setActive(true);

                 principal.setPrincipalId(principalId);

                 principal.setPrincipalName(principalName);

                 principal.setEntityId(entityId);

                 KNSServiceLocator.getBusinessObjectService().save(principal);

                 return principal;

     }

 }