Coverage Report - org.kuali.rice.edl.framework.util.EDLFunctions
 
Classes in this File Line Coverage Branch Coverage Complexity
EDLFunctions
0%
0/67
0%
0/20
2.312
 
 1  
 /*
 2  
  * Copyright 2005-2007 The Kuali Foundation
 3  
  *
 4  
  *
 5  
  * Licensed under the Educational Community License, Version 2.0 (the "License");
 6  
  * you may not use this file except in compliance with the License.
 7  
  * You may obtain a copy of the License at
 8  
  *
 9  
  * http://www.opensource.org/licenses/ecl2.php
 10  
  *
 11  
  * Unless required by applicable law or agreed to in writing, software
 12  
  * distributed under the License is distributed on an "AS IS" BASIS,
 13  
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 14  
  * See the License for the specific language governing permissions and
 15  
  * limitations under the License.
 16  
  */
 17  
 package org.kuali.rice.edl.framework.util;
 18  
 
 19  
 import org.kuali.rice.core.api.exception.RiceRuntimeException;
 20  
 import org.kuali.rice.kew.dto.RouteNodeInstanceDTO;
 21  
 import org.kuali.rice.kew.exception.WorkflowException;
 22  
 import org.kuali.rice.kew.exception.WorkflowRuntimeException;
 23  
 import org.kuali.rice.kew.service.WorkflowInfo;
 24  
 import org.kuali.rice.kim.bo.Person;
 25  
 import org.kuali.rice.kns.UserSession;
 26  
 import org.kuali.rice.kns.util.GlobalVariables;
 27  
 
 28  
 
 29  
 
 30  
 /**
 31  
  * A collection of handy workflow queries to be used from style sheets.
 32  
  *
 33  
  * @author Kuali Rice Team (rice.collab@kuali.org)
 34  
  *
 35  
  */
 36  0
 public class EDLFunctions {
 37  
 
 38  
 
 39  0
     private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(EDLFunctions.class);
 40  
 
 41  
     public static boolean isUserInitiator(String id) throws WorkflowException {
 42  0
             boolean initiator = false;
 43  0
             UserSession userSession = GlobalVariables.getUserSession();
 44  0
             if (userSession != null) {
 45  
                     try {
 46  0
                             String documentId = id.trim();
 47  0
                             WorkflowInfo workflowInfo = new WorkflowInfo();
 48  0
                             if (userSession.getPrincipalId().equals(workflowInfo.getRouteHeader(documentId).getInitiatorPrincipalId())) {
 49  0
                                     initiator = true;
 50  
                             }
 51  0
                     } catch (Exception e) {
 52  0
                             LOG.debug("Exception encountered trying to determine if user is the document initiator:" + e );
 53  0
                     }
 54  
             }
 55  0
             return initiator;
 56  
     }
 57  
 
 58  
         public static boolean isUserRouteLogAuthenticated(String documentId) {
 59  0
                 boolean authenticated=false;
 60  0
                 WorkflowInfo workflowInfo = new WorkflowInfo();
 61  0
                 UserSession userSession=GlobalVariables.getUserSession();
 62  0
                 if(userSession!=null){
 63  0
                         String principalId = userSession.getPrincipalId();
 64  
                         try {
 65  0
                                 authenticated = workflowInfo.isUserAuthenticatedByRouteLog(documentId, principalId, true);
 66  0
                         } catch (NumberFormatException e) {
 67  0
                                 LOG.debug("Invalid format documentId (should be LONG): " + documentId);
 68  0
                         } catch (WorkflowException e) {
 69  0
                                 LOG.debug("Error checking if user is route log authenticated: userId: " + principalId + ";documentId: " + documentId);
 70  
 
 71  0
                     } catch (RiceRuntimeException e) {
 72  0
                             LOG.error("Runtime Exception checking if user is route log authenticated: userId: " + principalId + ";documentId: " + documentId);
 73  
 
 74  0
                     }
 75  
                 }
 76  
 
 77  0
             return authenticated;
 78  
         }
 79  
 
 80  
         public static boolean isPrincipalIdAuthenticated(String principalId) {
 81  0
                 return GlobalVariables.getUserSession().getPrincipalId().equals(principalId);
 82  
         }
 83  
         
 84  
         public static boolean isPrincipalNameAuthenticated(String principalName) {
 85  0
                 return GlobalVariables.getUserSession().getPrincipalName().equals(principalName);
 86  
         }
 87  
         
 88  
         public static boolean isEmployeeIdAuthenticated(String employeeId) {
 89  0
                 return GlobalVariables.getUserSession().getPerson().getEmployeeId().equals(employeeId);
 90  
         }
 91  
 
 92  
         public static Person getAuthenticatedPerson(){
 93  0
                 UserSession userSession=GlobalVariables.getUserSession();
 94  0
                 Person user = userSession.getPerson();
 95  0
                 return user;
 96  
         }
 97  
 
 98  
         public static String getUserId() {
 99  0
                 return getAuthenticatedPerson().getPrincipalId();
 100  
         }
 101  
 
 102  
         public static String getLastName() {
 103  0
                 return getAuthenticatedPerson().getLastName();
 104  
         }
 105  
 
 106  
         public static String getGivenName() {
 107  0
             return getAuthenticatedPerson().getFirstName();
 108  
         }
 109  
 
 110  
         public static String getEmailAddress() {
 111  0
             return getAuthenticatedPerson().getEmailAddress();
 112  
         }
 113  
 
 114  
         public static boolean isNodeInPreviousNodeList(String nodeName, String id) {
 115  0
                 LOG.debug("nodeName came in as: " + nodeName);
 116  0
                 LOG.debug("id came in as: " + id);
 117  
                 //get list of previous node names
 118  
                 String[] previousNodeNames;
 119  0
                 WorkflowInfo workflowInfo = new WorkflowInfo();
 120  
                 try {
 121  0
                         previousNodeNames = workflowInfo.getPreviousRouteNodeNames(id);
 122  0
                 } catch (Exception e) {
 123  0
                         throw new WorkflowRuntimeException("Problem generating list of previous node names for documentID = " + id, e);
 124  0
                 }
 125  
                 //see if node name is in the list of previous node names
 126  0
                 for (String previousNodeName : previousNodeNames) {
 127  0
                         if (previousNodeName.equals(nodeName)) {
 128  0
                                 return true;
 129  
                         }
 130  
                 }
 131  0
                 return false;
 132  
         }
 133  
 
 134  
         public static String escapeJavascript(String value) {
 135  0
                 return value.replace("\\", "\\\\").replace("\"", "\\\"");
 136  
         }
 137  
 
 138  
         public static boolean isNodeBetween(String firstNodeName, String lastNodeName, String id) {
 139  0
                 if (isNodeInPreviousNodeList(firstNodeName, id)) {
 140  0
                         if (isNodeInPreviousNodeList(lastNodeName, id)) {
 141  0
                                 return false;
 142  
                         }else {
 143  0
                                 return true;
 144  
                         }
 145  
                 } else {
 146  0
                         return false;
 147  
                 }
 148  
         }
 149  
 
 150  
         public static boolean isAtNode(String documentId, String nodeName) throws Exception {
 151  0
             WorkflowInfo workflowInfo = new WorkflowInfo();
 152  0
             RouteNodeInstanceDTO[] activeNodeInstances = workflowInfo.getActiveNodeInstances(documentId);
 153  0
             for (RouteNodeInstanceDTO nodeInstance : activeNodeInstances) {
 154  0
                 if (nodeInstance.getName().equals(nodeName)) {
 155  0
                     return true;
 156  
                 }
 157  
             }
 158  0
             return false;
 159  
         }
 160  
 
 161  
         public static boolean hasActiveNode(String documentId) throws Exception {
 162  0
             WorkflowInfo workflowInfo = new WorkflowInfo();
 163  0
             RouteNodeInstanceDTO[] activeNodeInstances = workflowInfo.getActiveNodeInstances(documentId);
 164  0
             if (activeNodeInstances.length > 0) {
 165  0
                     return true;
 166  
             }
 167  0
             return false;
 168  
         }
 169  
 
 170  
         public static String getAuthenticationId() {
 171  0
             UserSession userSession=GlobalVariables.getUserSession();
 172  0
             return userSession.getPrincipalName();
 173  
         
 174  
         }
 175  
         
 176  
 }