/**

  * Copyright 2005-2011 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.kns.service.impl;

 import org.apache.commons.collections.map.LRUMap;

 import org.apache.commons.lang.StringUtils;

 import org.apache.log4j.Logger;

 import org.kuali.rice.core.api.CoreApiServiceLocator;

 import org.kuali.rice.core.api.encryption.EncryptionService;

 import org.kuali.rice.kew.api.WorkflowDocument;

 import org.kuali.rice.kew.api.KewApiConstants;

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

 import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;

 import org.kuali.rice.krad.UserSession;

 import org.kuali.rice.krad.bo.SessionDocument;

 import org.kuali.rice.krad.dao.SessionDocumentDao;

 import org.kuali.rice.krad.datadictionary.DocumentEntry;

 import org.kuali.rice.krad.service.BusinessObjectService;

 import org.kuali.rice.krad.service.DataDictionaryService;

 import org.kuali.rice.krad.service.KRADServiceLocatorWeb;

 import org.springframework.beans.factory.InitializingBean;

 import org.springframework.transaction.annotation.Transactional;

 import java.io.ByteArrayInputStream;

 import java.io.ByteArrayOutputStream;

 import java.io.ObjectInputStream;

 import java.io.ObjectOutputStream;

 import java.sql.Timestamp;

 import java.util.Collections;

 import java.util.HashMap;

 import java.util.Map;

 /**

  * Implementation of <code>SessionDocumentService</code> that persists the document form

  * contents to the underlying database

  *

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

  */

 @Deprecated

 @Transactional

 public class SessionDocumentServiceImpl implements SessionDocumentService, InitializingBean {

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

     protected static final String IP_ADDRESS = "ipAddress";

     protected static final String PRINCIPAL_ID = "principalId";

     protected static final String DOCUMENT_NUMBER = "documentNumber";

     protected static final String SESSION_ID = "sessionId";

     private Map<String, CachedObject> cachedObjects;

     private EncryptionService encryptionService;

     private int maxCacheSize;

     private BusinessObjectService businessObjectService;

     private DataDictionaryService dataDictionaryService;

     private SessionDocumentDao sessionDocumentDao;

     private static class CachedObject {

         private UserSession userSession;

         private String formKey;

         CachedObject(UserSession userSession, String formKey) {

             this.userSession = userSession;

             this.formKey = formKey;

         }

         @Override

         public String toString() {

             return "CachedObject: principalId=" + userSession.getPrincipalId() + " / objectWithFormKey=" +

                     userSession.retrieveObject(formKey);

         }

         public UserSession getUserSession() {

             return this.userSession;

         }

         public String getFormKey() {

             return this.formKey;

         }

     }

     /**

      * Override LRUMap removeEntity method

      *

      *

      */

     private static class KualiLRUMap extends LRUMap {

         /** Serialization version */

         private static final long serialVersionUID = 1L;

         private KualiLRUMap() {

             super();

         }

         private KualiLRUMap(int maxSize) {

             super(maxSize);

         }

         @Override

         protected void removeEntry(HashEntry entry, int hashIndex, HashEntry previous) {

             // It is for session document cache enhancement.

             // To control the size of cache. When the LRUMap reach the maxsize.

             // It will remove session document entries from the in-memory user

             // session objects.

             try {

                 CachedObject cachedObject

                         = (CachedObject)this.entryValue(entry);

                 cachedObject.getUserSession().removeObject(cachedObject.getFormKey());

             } catch (Exception ex) {

                 Logger.getLogger(getClass()).warn( "Problem purging old entry from the user session when removing from the map: ", ex);

             }

             super.removeEntry(entry, hashIndex, previous);

         }

     }

     @Override

     @SuppressWarnings("unchecked")

     public void afterPropertiesSet() throws Exception {

         cachedObjects = Collections.synchronizedMap(new KualiLRUMap(maxCacheSize));

     }

     @Override

     public KualiDocumentFormBase getDocumentForm(String documentNumber, String docFormKey, UserSession userSession,

             String ipAddress) {

         KualiDocumentFormBase documentForm = null;

         LOG.debug("getDocumentForm KualiDocumentFormBase from db");

         try {

             // re-create the KualiDocumentFormBase object

             documentForm = (KualiDocumentFormBase) retrieveDocumentForm(userSession, userSession.getKualiSessionId(),

                     documentNumber, ipAddress);

             //re-store workFlowDocument into session

             WorkflowDocument workflowDocument =

                     documentForm.getDocument().getDocumentHeader().getWorkflowDocument();

             addDocumentToUserSession(userSession, workflowDocument);

         } catch (Exception e) {

             LOG.error("getDocumentForm failed for SessId/DocNum/PrinId/IP:" + userSession.getKualiSessionId() + "/" +

                     documentNumber + "/" + userSession.getPrincipalId() + "/" + ipAddress, e);

         }

         return documentForm;

     }

     protected Object retrieveDocumentForm(UserSession userSession, String sessionId, String documentNumber,

             String ipAddress) throws Exception {

         HashMap<String, String> primaryKeys = new HashMap<String, String>(4);

         primaryKeys.put(SESSION_ID, sessionId);

         if (documentNumber != null) {

             primaryKeys.put(DOCUMENT_NUMBER, documentNumber);

         }

         primaryKeys.put(PRINCIPAL_ID, userSession.getPrincipalId());

         primaryKeys.put(IP_ADDRESS, ipAddress);

         SessionDocument sessionDoc = getBusinessObjectService().findByPrimaryKey(SessionDocument.class, primaryKeys);

         if (sessionDoc != null) {

             byte[] formAsBytes = sessionDoc.getSerializedDocumentForm();

             if (sessionDoc.isEncrypted()) {

                 formAsBytes = getEncryptionService().decryptBytes(formAsBytes);

             }

             ByteArrayInputStream baip = new ByteArrayInputStream(formAsBytes);

             ObjectInputStream ois = new ObjectInputStream(baip);

             return ois.readObject();

         }

         return null;

     }

     @Override

     public WorkflowDocument getDocumentFromSession(UserSession userSession, String docId) {

         @SuppressWarnings("unchecked") Map<String, WorkflowDocument> workflowDocMap =

                 (Map<String, WorkflowDocument>) userSession

                         .retrieveObject(KewApiConstants.WORKFLOW_DOCUMENT_MAP_ATTR_NAME);

         if (workflowDocMap == null) {

             workflowDocMap = new HashMap<String, WorkflowDocument>();

             userSession.addObject(KewApiConstants.WORKFLOW_DOCUMENT_MAP_ATTR_NAME, workflowDocMap);

             return null;

         }

         return workflowDocMap.get(docId);

     }

     /**

      * @see org.kuali.rice.krad.service.SessionDocumentService#addDocumentToUserSession(org.kuali.rice.krad.UserSession,

      *      org.kuali.rice.krad.workflow.service.KualiWorkflowDocument)

      */

     @Override

     public void addDocumentToUserSession(UserSession userSession, WorkflowDocument document) {

         @SuppressWarnings("unchecked") Map<String, WorkflowDocument> workflowDocMap =

                 (Map<String, WorkflowDocument>) userSession

                         .retrieveObject(KewApiConstants.WORKFLOW_DOCUMENT_MAP_ATTR_NAME);

         if (workflowDocMap == null) {

             workflowDocMap = new HashMap<String, WorkflowDocument>();

         }

         workflowDocMap.put(document.getDocumentId(), document);

         userSession.addObject(KewApiConstants.WORKFLOW_DOCUMENT_MAP_ATTR_NAME, workflowDocMap);

     }

     /**

      * @see org.kuali.rice.krad.service.SessionDocumentService#purgeDocumentForm(String

      *      documentNumber, String docFormKey, UserSession userSession)

      */

     @Override

     public void purgeDocumentForm(String documentNumber, String docFormKey, UserSession userSession, String ipAddress) {

         synchronized (userSession) {

             LOG.debug("purge document form from session");

             userSession.removeObject(docFormKey);

             try {

                 LOG.debug("purge document form from database");

                 HashMap<String, String> primaryKeys = new HashMap<String, String>(4);

                 primaryKeys.put(SESSION_ID, userSession.getKualiSessionId());

                 primaryKeys.put(DOCUMENT_NUMBER, documentNumber);

                 primaryKeys.put(PRINCIPAL_ID, userSession.getPrincipalId());

                 primaryKeys.put(IP_ADDRESS, ipAddress);

                 getBusinessObjectService().deleteMatching(SessionDocument.class, primaryKeys);

             } catch (Exception e) {

                 LOG.error("purgeDocumentForm failed for SessId/DocNum/PrinId/IP:" + userSession.getKualiSessionId() +

                         "/" + documentNumber + "/" + userSession.getPrincipalId() + "/" + ipAddress, e);

             }

         }

     }

     @Override

     public void setDocumentForm(KualiDocumentFormBase form, UserSession userSession, String ipAddress) {

         synchronized (userSession) {

             //formKey was set in KualiDocumentActionBase execute method

             String formKey = form.getFormKey();

             String key = userSession.getKualiSessionId() + "-" + formKey;

             cachedObjects.put(key, new CachedObject(userSession, formKey));

             String documentNumber = form.getDocument().getDocumentNumber();

             if (StringUtils.isNotBlank(documentNumber)) {

                 persistDocumentForm(form, userSession, ipAddress, userSession.getKualiSessionId(), documentNumber);

             } else {

                 LOG.warn("documentNumber is null on form's document: " + form);

             }

         }

     }

     protected void persistDocumentForm(Object form, UserSession userSession, String ipAddress, String sessionId,

             String documentNumber) {

         try {

             LOG.debug("set Document Form into database");

             Timestamp currentTime = new Timestamp(System.currentTimeMillis());

             ByteArrayOutputStream baos = new ByteArrayOutputStream();

             ObjectOutputStream oos = new ObjectOutputStream(baos);

             oos.writeObject(form);

             // serialize the KualiDocumentFormBase object into a byte array

             byte[] formAsBytes = baos.toByteArray();

             boolean encryptContent = false;

             if ((form instanceof KualiDocumentFormBase) && ((KualiDocumentFormBase) form).getDocTypeName() != null) {

                 DocumentEntry documentEntry = getDataDictionaryService().getDataDictionary()

                         .getDocumentEntry(((KualiDocumentFormBase) form).getDocTypeName());

                 if (documentEntry != null) {

                     encryptContent = documentEntry.isEncryptDocumentDataInPersistentSessionStorage();

                 }

             }

             if (encryptContent) {

                 formAsBytes = getEncryptionService().encryptBytes(formAsBytes);

             }

             // check if a record is already there in the database

             // this may only happen under jMeter testing, but there is no way to be sure

             HashMap<String, String> primaryKeys = new HashMap<String, String>(4);

             primaryKeys.put(SESSION_ID, sessionId);

             primaryKeys.put(DOCUMENT_NUMBER, documentNumber);

             primaryKeys.put(PRINCIPAL_ID, userSession.getPrincipalId());

             primaryKeys.put(IP_ADDRESS, ipAddress);

             SessionDocument sessionDocument =

                     getBusinessObjectService().findByPrimaryKey(SessionDocument.class, primaryKeys);

             if (sessionDocument == null) {

                 sessionDocument = new SessionDocument();

                 sessionDocument.setSessionId(sessionId);

                 sessionDocument.setDocumentNumber(documentNumber);

                 sessionDocument.setPrincipalId(userSession.getPrincipalId());

                 sessionDocument.setIpAddress(ipAddress);

             }

             sessionDocument.setSerializedDocumentForm(formAsBytes);

             sessionDocument.setEncrypted(encryptContent);

             sessionDocument.setLastUpdatedDate(currentTime);

             businessObjectService.save(sessionDocument);

         } catch (Exception e) {

             final String className = form != null ? form.getClass().getName() : "null";

             LOG.error("setDocumentForm failed for SessId/DocNum/PrinId/IP/class:" + userSession.getKualiSessionId() +

                     "/" + documentNumber + "/" + userSession.getPrincipalId() + "/" + ipAddress + "/" + className, e);

         }

     }

     /**

      * @see org.kuali.rice.krad.service.SessionDocumentService#purgeAllSessionDocuments(java.sql.Timestamp)

      */

     @Override

     public void purgeAllSessionDocuments(Timestamp expirationDate) {

         sessionDocumentDao.purgeAllSessionDocuments(expirationDate);

     }

     protected SessionDocumentDao getSessionDocumentDao() {

         return this.sessionDocumentDao;

     }

     public void setSessionDocumentDao(SessionDocumentDao sessionDocumentDao) {

         this.sessionDocumentDao = sessionDocumentDao;

     }

     protected BusinessObjectService getBusinessObjectService() {

         return this.businessObjectService;

     }

     public void setBusinessObjectService(BusinessObjectService businessObjectService) {

         this.businessObjectService = businessObjectService;

     }

     public int getMaxCacheSize() {

         return maxCacheSize;

     }

     public void setMaxCacheSize(int maxCacheSize) {

         this.maxCacheSize = maxCacheSize;

     }

     protected EncryptionService getEncryptionService() {

         if (encryptionService == null) {

             encryptionService = CoreApiServiceLocator.getEncryptionService();

         }

         return encryptionService;

     }

     protected DataDictionaryService getDataDictionaryService() {

         if (dataDictionaryService == null) {

             dataDictionaryService = KRADServiceLocatorWeb.getDataDictionaryService();

         }

         return dataDictionaryService;

     }

 }