/*

  * 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.doctype.service.impl;

 import org.apache.commons.lang.StringUtils;

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

 import org.kuali.rice.core.api.datetime.DateTimeService;

 import org.kuali.rice.core.api.resourceloader.GlobalResourceLoader;

 import org.kuali.rice.core.util.KeyValue;

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

 import org.kuali.rice.kew.api.document.Document;

 import org.kuali.rice.kew.docsearch.DocSearchDTO;

 import org.kuali.rice.kew.doctype.DocumentTypeSecurity;

 import org.kuali.rice.kew.doctype.SecurityAttribute;

 import org.kuali.rice.kew.doctype.SecurityPermissionInfo;

 import org.kuali.rice.kew.doctype.SecuritySession;

 import org.kuali.rice.kew.doctype.bo.DocumentType;

 import org.kuali.rice.kew.doctype.service.DocumentSecurityService;

 import org.kuali.rice.kew.routeheader.DocumentRouteHeaderValue;

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

 import org.kuali.rice.kew.user.UserUtils;

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

 import org.kuali.rice.kim.api.group.Group;

 import org.kuali.rice.kim.api.services.KimApiServiceLocator;

 import org.kuali.rice.kim.bo.Person;

 import org.kuali.rice.krad.UserSession;

 import java.lang.reflect.Field;

 import java.util.Calendar;

 import java.util.Collection;

 import java.util.HashMap;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Map;

 public class DocumentSecurityServiceImpl implements DocumentSecurityService {

   public static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(DocumentSecurityServiceImpl.class);

   @Override

 public boolean docSearchAuthorized(UserSession userSession, DocSearchDTO docCriteriaDTO, SecuritySession session) {

       return checkAuthorization(userSession, session, docCriteriaDTO.getDocTypeName(), docCriteriaDTO.getDocumentId(), docCriteriaDTO.getInitiatorWorkflowId());

   }

   @Override

 public boolean routeLogAuthorized(UserSession userSession, DocumentRouteHeaderValue routeHeader, SecuritySession session) {

       return checkAuthorization(userSession, session, routeHeader.getDocumentType().getName(), routeHeader.getDocumentId(), routeHeader.getInitiatorWorkflowId());

   }

   protected boolean checkAuthorization(UserSession userSession, SecuritySession session, String documentTypeName, String documentId, String initiatorPrincipalId) {

       DocumentTypeSecurity security = null;

       try {

           security = getDocumentTypeSecurity(userSession, documentTypeName, session);

           if (security == null || !security.isActive()) {

             // Security is not enabled for this doctype.  Everyone can see this doc.

             return true;

           }

           if (isAdmin(session)) {

               return true;

           }

           for (SecurityAttribute securityAttribute : security.getSecurityAttributes()) {

               Boolean authorized = securityAttribute.docSearchAuthorized(userSession.getPerson(), documentTypeName, documentId, initiatorPrincipalId);

               if (authorized != null) {

                   return authorized.booleanValue();

               }

           }

       } 

       catch (Exception e) {

           LOG.warn("Not able to retrieve DocumentTypeSecurity from remote system for doctype: " + documentTypeName, e);

           return false;

       }

       return checkStandardAuthorization(security, userSession, documentTypeName, documentId, initiatorPrincipalId, session);

   }

   protected boolean isAdmin(SecuritySession session) {

           if (session.getUserSession() == null) {

                   return false;

           }

           return KimApiServiceLocator.getPermissionService().isAuthorized(session.getUserSession().getPrincipalId(), KEWConstants.KEW_NAMESPACE,        KEWConstants.PermissionNames.UNRESTRICTED_DOCUMENT_SEARCH, new HashMap<String, String>(), new HashMap<String, String>());

   }

   protected boolean checkStandardAuthorization(DocumentTypeSecurity security, UserSession userSession, String docTypeName, String documentId, String initiatorPrincipalId, SecuritySession session) {

         Person user = userSession.getPerson();

     LOG.debug("auth check user=" + user.getPrincipalId() +" docId=" + documentId);

     // Doc Initiator Authorization

     if (security.getInitiatorOk() != null && security.getInitiatorOk()) {

       boolean isInitiator = StringUtils.equals(initiatorPrincipalId, user.getPrincipalId());

       if (isInitiator) {

         return true;

       }

     }

     // Role authorization

     /* Removing in Rice 1.1

     List<String> allowedRoles = security.getAllowedRoles();

     List<String> disallowedRoles = security.getDisallowedRoles();

     // only execute role security if they have it defined

     if ((allowedRoles != null && !allowedRoles.isEmpty()) ||

                     (disallowedRoles != null && !disallowedRoles.isEmpty())) {

             Boolean passesRoleSecurity = session.getPassesRoleSecurity().get(docTypeName);

             if (passesRoleSecurity != null) {

                     if (passesRoleSecurity) {

                             return true;

                     }

             } else {

                     passesRoleSecurity = isRoleAuthenticated(allowedRoles, disallowedRoles, userSession, session);

                     session.getPassesRoleSecurity().put(docTypeName, passesRoleSecurity);

                     if (passesRoleSecurity) {

                             return true;

                     }

             }

     }

     */

     // Permission Authorization

     List<SecurityPermissionInfo> securityPermissions = security.getPermissions();

     if (securityPermissions != null) {

             for (SecurityPermissionInfo securityPermission : securityPermissions) {

                     if (isAuthenticatedByPermission(documentId, securityPermission.getPermissionNamespaceCode(), securityPermission.getPermissionName(), securityPermission.getPermissionDetails(), securityPermission.getQualifications(), session)) {

                             return true;

                     }

             }

     }

     //  Workgroup Authorization

     List<Group> securityWorkgroups = security.getWorkgroups();

     if (securityWorkgroups != null) {

       for (Group securityWorkgroup : securityWorkgroups) {

         if (isWorkgroupAuthenticated(securityWorkgroup.getNamespaceCode(), securityWorkgroup.getName(), session)) {

                 return true;

         }

       }

     }

     // Searchable Attribute Authorization

     Collection searchableAttributes = security.getSearchableAttributes();

     if (searchableAttributes != null) {

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

         KeyValue searchableAttr = (KeyValue) iterator.next();

         String attrName = searchableAttr.getKey();

         String idType = searchableAttr.getValue();

         String idValue = UserUtils.getIdValue(idType, user);

         if (!StringUtils.isEmpty(idValue)) {

           if (KEWServiceLocator.getRouteHeaderService().hasSearchableAttributeValue(documentId, attrName, idValue)) {

             return true;

           }

         }

       }

     }

     // Route Log Authorization

     if (security.getRouteLogAuthenticatedOk() != null && security.getRouteLogAuthenticatedOk()) {

       boolean isInitiator = StringUtils.equals(initiatorPrincipalId, user.getPrincipalId());

       if (isInitiator) {

         return true;

       }

       boolean hasTakenAction = KEWServiceLocator.getActionTakenService().hasUserTakenAction(user.getPrincipalId(), documentId);

       if (hasTakenAction) {

         return true;

       }

       boolean hasRequest = KEWServiceLocator.getActionRequestService().doesPrincipalHaveRequest(user.getPrincipalId(), documentId);

       if (hasRequest) {

         return true;

       }

     }

     LOG.debug("user not authorized");

     return false;

   }

 protected DocumentTypeSecurity getDocumentTypeSecurity(UserSession userSession, String documentTypeName, SecuritySession session) {

       if (session == null) {

           session = new SecuritySession(userSession);

       }

           DocumentTypeSecurity security = session.getDocumentTypeSecurity().get(documentTypeName);

           if (security == null) {

                   DocumentType docType = KEWServiceLocator.getDocumentTypeService().findByName(documentTypeName);

                   security = docType.getDocumentTypeSecurity();

                   session.getDocumentTypeSecurity().put(documentTypeName, security);

           }

           return security;

   }

   protected boolean isWorkgroupAuthenticated(String namespace, String workgroupName, SecuritySession session) {

           String key = namespace.trim() + KEWConstants.KIM_GROUP_NAMESPACE_NAME_DELIMITER_CHARACTER + workgroupName.trim();

       Boolean existingAuth = session.getAuthenticatedWorkgroups().get(key);

           if (existingAuth != null) {

                   return existingAuth;

           }

           boolean memberOfGroup = isMemberOfGroupWithName(namespace, workgroupName, session.getUserSession().getPrincipalId());

           session.getAuthenticatedWorkgroups().put(key, memberOfGroup);

           return memberOfGroup;

   }

         private boolean isMemberOfGroupWithName(String namespace, String groupName, String principalId) {

                 for (Group group : KimApiServiceLocator.getGroupService().getGroupsForPrincipal(principalId)) {

                         if (StringUtils.equals(namespace, group.getNamespaceCode()) && StringUtils.equals(groupName, group.getName())) {

                                 return true;

                         }

                 }

                 return false;

         }

         protected boolean isAuthenticatedByPermission(String documentId, String permissionNamespaceCode,

                         String permissionName, Map<String, String> permissionDetails,

                         Map<String, String> qualification, SecuritySession session)  {

                 Document document;

                 try {

                     document = KewApiServiceLocator.getWorkflowDocumentService().getDocument(documentId);

                         for (String qualificationKey : qualification.keySet()){

                                 String qualificationValue = qualification.get(qualificationKey);

                                 String replacementValue = getReplacementString(document, qualificationValue);

                         qualification.put(qualificationKey, replacementValue);

                         }

                         for (String permissionDetailKey : permissionDetails.keySet()){

                                 String detailValue = qualification.get(permissionDetailKey);

                                 String replacementValue = getReplacementString(document, detailValue);

                         qualification.put(permissionDetailKey, replacementValue);

                         }

                 } catch (Exception e) {

                         LOG.error(e.getMessage(), e);

                         return false;

                 }

                 return KimApiServiceLocator.getPermissionService().isAuthorized(session.getUserSession().getPrincipalId(), permissionNamespaceCode, permissionName, permissionDetails, qualification);

         }

         private String getReplacementString(Document document, String value) throws Exception {

                 String startsWith = "${document.";

                 String endsWith = "}";

                 if (value.startsWith(startsWith)) {

                         int tokenStart = value.indexOf(startsWith);

             int tokenEnd = value.indexOf(endsWith, tokenStart + startsWith.length());

             if (tokenEnd == -1) {

                 throw new RuntimeException("No ending bracket on token in value " +value);

             }

             String token = value.substring(tokenStart + startsWith.length(), tokenEnd);

             return getRouteHeaderVariableValue(document, token);

                 }

                 return value;

         }

         private String getRouteHeaderVariableValue(Document document, String variableName) throws Exception {

                 Field field = document.getClass().getDeclaredField(variableName);

                 field.setAccessible(true);

                 Object fieldValue = field.get(document);

                 Class<?> clazzType = field.getType();

                 if (clazzType.equals(String.class)) {

                         return (String)fieldValue;

                 } else if (clazzType.getName().equals("boolean") || clazzType.getName().equals("java.lang.Boolean")) {

                         if ((Boolean)fieldValue) {

                                 return "Y";

                         } 

                         return "N";

                 } else if (clazzType.getName().equals("java.util.Calendar")) {

                         DateTimeService dateTimeService = GlobalResourceLoader.getService(CoreConstants.Services.DATETIME_SERVICE);

                         return dateTimeService.toDateString(((Calendar)fieldValue).getTime());

                 }

                 return String.valueOf(fieldValue);

         }

 }