LeaveCalendarValidationUtil

/**
 * Copyright 2004-2013 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.hr.lm.leavecalendar.validation;

import org.apache.commons.collections.CollectionUtils;
import org.apache.commons.lang.StringUtils;
import org.joda.time.DateTime;
import org.joda.time.DateTimeConstants;
import org.kuali.hr.lm.LMConstants;
import org.kuali.hr.lm.accrual.AccrualCategory;
import org.kuali.hr.lm.employeeoverride.EmployeeOverride;
import org.kuali.hr.lm.leave.web.LeaveCalendarWSForm;
import org.kuali.hr.lm.leaveSummary.LeaveSummary;
import org.kuali.hr.lm.leaveSummary.LeaveSummaryRow;
import org.kuali.hr.lm.leaveblock.LeaveBlock;
import org.kuali.hr.time.calendar.CalendarEntries;
import org.kuali.hr.time.earncode.EarnCode;
import org.kuali.hr.time.earncodegroup.EarnCodeGroup;
import org.kuali.hr.time.service.base.TkServiceLocator;
import org.kuali.hr.time.util.TKContext;
import org.kuali.hr.time.util.TKUtils;
import org.kuali.hr.time.util.TkConstants;

import java.math.BigDecimal;
import java.sql.Date;
import java.util.*;

import org.kuali.rice.kew.api.KewApiServiceLocator;
import org.kuali.rice.kew.api.document.DocumentStatus;
import org.kuali.rice.krad.util.ObjectUtils;

public class LeaveCalendarValidationUtil {

    //begin KPME-1263
    public static List<String> validateLeaveAccrualRuleMaxUsage(LeaveCalendarWSForm lcf) {
    	LeaveBlock updatedLeaveBlock = null;
    	if(lcf.getLeaveBlockId() != null) {
    		updatedLeaveBlock = TkServiceLocator.getLeaveBlockService().getLeaveBlock(lcf.getLeaveBlockId());
    	}
    	return validateLeaveAccrualRuleMaxUsage(lcf.getLeaveSummary(), lcf.getSelectedEarnCode(), lcf.getStartDate(),
    			lcf.getEndDate(), lcf.getLeaveAmount(), updatedLeaveBlock);
    }

	public static List<String> validateLeaveAccrualRuleMaxUsage(LeaveSummary ls, String selectedEarnCode, String leaveStartDateString,
			String leaveEndDateString, BigDecimal leaveAmount, LeaveBlock updatedLeaveBlock) {
    	List<String> errors = new ArrayList<String>();
        String principalId = TKContext.getTargetPrincipalId();
    	long daysSpan = TKUtils.getDaysBetween(TKUtils.formatDateString(leaveStartDateString), TKUtils.formatDateString(leaveEndDateString));
    	if(ls != null && CollectionUtils.isNotEmpty(ls.getLeaveSummaryRows())) {
	    	BigDecimal oldLeaveAmount = null;
	    	boolean earnCodeChanged = false;
    		if(updatedLeaveBlock != null) {
    			if(!updatedLeaveBlock.getEarnCode().equals(selectedEarnCode)) {
    				earnCodeChanged = true;
    			}
    			if(!updatedLeaveBlock.getLeaveAmount().equals(leaveAmount)) {
    				oldLeaveAmount = updatedLeaveBlock.getLeaveAmount();
    			}
    		}
    		Date aDate = TKUtils.formatDateString(leaveEndDateString);
	    	EarnCode earnCodeObj = TkServiceLocator.getEarnCodeService().getEarnCode(selectedEarnCode, aDate);
	    	if(earnCodeObj != null) {
	    		AccrualCategory accrualCategory = TkServiceLocator.getAccrualCategoryService().getAccrualCategory(earnCodeObj.getAccrualCategory(), aDate);
	    		if(accrualCategory != null) {
	    			List<LeaveSummaryRow> rows = ls.getLeaveSummaryRows();
	    			for(LeaveSummaryRow aRow : rows) {
	    				if(aRow.getAccrualCategory().equals(accrualCategory.getAccrualCategory())) {
	    					//Does employee have overrides in place?
	    					List<EmployeeOverride> employeeOverrides = TkServiceLocator.getEmployeeOverrideService().getEmployeeOverrides(principalId,TKUtils.formatDateString(leaveEndDateString));
	    					String leavePlan = accrualCategory.getLeavePlan();
	    					BigDecimal maxUsage = aRow.getUsageLimit();
	    					for(EmployeeOverride eo : employeeOverrides) {
	    						if(eo.getLeavePlan().equals(leavePlan) && eo.getAccrualCategory().equals(aRow.getAccrualCategory())) {
	    							if(eo.getOverrideType().equals("MU") && eo.isActive()) {
	    								if(eo.getOverrideValue()!=null && !eo.getOverrideValue().equals(""))
	    									maxUsage = new BigDecimal(eo.getOverrideValue());
	    								else // no limit flag
	    									maxUsage = null;
	    							}
	    						}
	    					}
	    					BigDecimal ytdUsage = aRow.getYtdApprovedUsage();
	    					BigDecimal pendingLeaveBalance = aRow.getPendingLeaveRequests();
	    					BigDecimal desiredUsage = new BigDecimal(0);
	    					if(pendingLeaveBalance!=null) {
	    						if(oldLeaveAmount!=null) {

	    							if(!earnCodeChanged ||
	    									updatedLeaveBlock.getAccrualCategory().equals(accrualCategory.getAccrualCategory())) {
   			    						pendingLeaveBalance = pendingLeaveBalance.subtract(oldLeaveAmount.abs());
	    							}
	    						}

    							desiredUsage = desiredUsage.add(pendingLeaveBalance);
	    					}

	    					desiredUsage = desiredUsage.add(leaveAmount.multiply(new BigDecimal(daysSpan+1)));

   							if(ytdUsage!=null) {
    							desiredUsage = desiredUsage.add(ytdUsage);
    						}
	    					if(maxUsage!=null) {
		    					if(desiredUsage.compareTo(maxUsage) > 0 ) {
		    						errors.add("This leave request would exceed the usage limit for " + aRow.getAccrualCategory());                        //errorMessages
		    					}
	    					}
	    				}
	    			}
	    		}
	    	}
    	}
    	return errors;
    }
	//End KPME-1263

	//TODO: Move to WarningService
	public static Map<String, Set<String>> validatePendingTransactions(String principalId, Date fromDate, Date toDate) {
		Map<String, Set<String>> allMessages = new HashMap<String, Set<String>>();

        Set<String> actionMessages = new HashSet<String>();
        Set<String> infoMessages = new HashSet<String>();
        Set<String> warningMessages = new HashSet<String>();

        allMessages.put("actionMessages", actionMessages);
        allMessages.put("infoMessages", infoMessages);
        allMessages.put("warningMessages", warningMessages);
        List<LeaveBlock> leaveBlocks = TkServiceLocator.getLeaveBlockService().getLeaveBlocksWithType(principalId, fromDate, toDate, LMConstants.LEAVE_BLOCK_TYPE.BALANCE_TRANSFER);
        Set<String> workflowDocIds = new HashSet<String>();
        for(LeaveBlock lb : leaveBlocks) {
        	if(lb.getTransactionalDocId() != null)
        		workflowDocIds.add(lb.getTransactionalDocId());
        	else
        		if(lb.getDescription().contains("Forfeited balance transfer amount"))
        			allMessages.get("infoMessages").add("A max balance action that forfeited accrued leave occurred on this calendar");
        }
        for(String workflowDocId : workflowDocIds) {
            DocumentStatus status = KewApiServiceLocator.getWorkflowDocumentService().getDocumentStatus(workflowDocId);

            if(StringUtils.equals(status.getCode(), TkConstants.ROUTE_STATUS.FINAL)) {
            	allMessages.get("infoMessages").add("A transfer action occurred on this calendar");
            }
            else if(StringUtils.equals(status.getCode(), TkConstants.ROUTE_STATUS.ENROUTE)) {
            	allMessages.get("actionMessages").add("A pending balance transfer exists on this calendar. It must be finalized before this calendar can be approved");
            }
            else
            	allMessages.get("warningMessages").add("A balance transfer document exists for this calendar with status neither final or enroute");
        }

        leaveBlocks = TkServiceLocator.getLeaveBlockService().getLeaveBlocksWithType(principalId, fromDate, toDate, LMConstants.LEAVE_BLOCK_TYPE.LEAVE_PAYOUT);
        workflowDocIds = new HashSet<String>();
        for(LeaveBlock lb : leaveBlocks) {
        	if(lb.getTransactionalDocId() != null)
        		workflowDocIds.add(lb.getTransactionalDocId());
        }
        for(String workflowDocId : workflowDocIds) {
            DocumentStatus status = KewApiServiceLocator.getWorkflowDocumentService().getDocumentStatus(workflowDocId);

            if(StringUtils.equals(status.getCode(), TkConstants.ROUTE_STATUS.FINAL)) {
            	allMessages.get("infoMessages").add("A payout action occurred on this calendar");
            }
            else if(StringUtils.equals(status.getCode(), TkConstants.ROUTE_STATUS.ENROUTE)) {
            	allMessages.get("actionMessages").add("A pending payout exists on this calendar. It must be finalized before this calendar can be approved");
            }
            else
            	allMessages.get("warningMessages").add("A payout document exists for this calendar with status neither final or enroute");
        }
/*        //TODO: Re-combine balance transfer and leave payout...
        List<BalanceTransfer> transfers = TkServiceLocator.getBalanceTransferService().getBalanceTransfers(principalId, fromDate, toDate);
        for(BalanceTransfer transfer : transfers) {
        	if(StringUtils.equals(transfer.getStatus(), TkConstants.ROUTE_STATUS.ENROUTE)) {
        		allMessages.get("actionMessages").add("A pending balance transfer exists on this calendar. It must be finalized before this calendar can be approved");	//action
        	}
    		if(StringUtils.equals(transfer.getStatus() ,TkConstants.ROUTE_STATUS.FINAL)) {
    			if(StringUtils.isEmpty(transfer.getSstoId())) {
	            	if(transfer.getTransferAmount().compareTo(BigDecimal.ZERO) == 0 && transfer.getAmountTransferred().compareTo(BigDecimal.ZERO) == 0) {
	            		if(transfer.getForfeitedAmount() != null && transfer.getForfeitedAmount().signum() != 0)
	            			allMessages.get("infoMessages").add("A transfer action that forfeited leave occured on this calendar");	//info
	            	}
	            	else
	            		allMessages.get("infoMessages").add("A transfer action occurred on this calendar");	//info
    			}
    			else
    				allMessages.get("infoMessages").add("System scheduled time off was transferred on this calendar");	//info
    		}
    		if(StringUtils.equals(transfer.getStatus() ,TkConstants.ROUTE_STATUS.DISAPPROVED)) {
    			if(StringUtils.isEmpty(transfer.getSstoId())) {
    	        	if(transfer.getTransferAmount().compareTo(BigDecimal.ZERO) == 0 && transfer.getAmountTransferred().compareTo(BigDecimal.ZERO) == 0) {
    	        		if(transfer.getForfeitedAmount() != null && transfer.getForfeitedAmount().signum() != 0)
    	        			allMessages.get("infoMessages").add("A transfer action that forfeited leave occured on this calendar");	//info
    	        	}
    	        	else
    	        		allMessages.get("infoMessages").add("A transfer action occurred on this calendar");	//info
    			}
    		}
        }

        List<LeavePayout> payouts = TkServiceLocator.getLeavePayoutService().getLeavePayouts(principalId, fromDate, toDate);
        for(LeavePayout payout : payouts) {
        	if(StringUtils.equals(payout.getStatus(), TkConstants.ROUTE_STATUS.ENROUTE)) {
        		allMessages.get("actionMessages").add("A pending payout exists on this calendar. It must be finalized before this calendar can be approved");
        	}
    		if(StringUtils.equals(payout.getStatus() ,TkConstants.ROUTE_STATUS.FINAL)) {
            	if(payout.getPayoutAmount().compareTo(BigDecimal.ZERO) == 0) {
            		if(payout.getForfeitedAmount() != null && payout.getForfeitedAmount().signum() != 0)
            			allMessages.get("infoMessages").add("A payout action that forfeited leave occured on this calendar");
            	}
            	else
            		allMessages.get("infoMessages").add("A payout action occurred on this calendar");
    		}
    		if(StringUtils.equals(payout.getStatus() ,TkConstants.ROUTE_STATUS.DISAPPROVED)) {
	        	if(payout.getPayoutAmount().compareTo(BigDecimal.ZERO) == 0) {
	        		if(payout.getForfeitedAmount() != null && payout.getForfeitedAmount().signum() != 0)
	        			allMessages.get("infoMessages").add("A disapproved payout that forfeited leave occured on this calendar");
	        	}
	        	else
	        		allMessages.get("infoMessages").add("A disapproved payout occurred on this calendar");
    		}
        }*/

        return allMessages;
	}

    // get warning messages associated with earn codes of leave blocks
    public static Map<String, Set<String>> getWarningMessagesForLeaveBlocks(List<LeaveBlock> leaveBlocks) {
//        List<String> warningMessages = new ArrayList<String>();
        Map<String, Set<String>> allMessages = new HashMap<String, Set<String>>();

        Set<String> actionMessages = new HashSet<String>();
        Set<String> infoMessages = new HashSet<String>();
        Set<String> warningMessages = new HashSet<String>();

        if (CollectionUtils.isNotEmpty(leaveBlocks)) {
            for(LeaveBlock lb : leaveBlocks) {
                EarnCode ec = TkServiceLocator.getEarnCodeService().getEarnCode(lb.getEarnCode(), lb.getLeaveDate());
                if(ec != null) {
                    EarnCodeGroup eg = TkServiceLocator.getEarnCodeGroupService().getEarnCodeGroupForEarnCode(lb.getEarnCode(), lb.getLeaveDate());
                    if(eg != null && !StringUtils.isEmpty(eg.getWarningText())) {
                        warningMessages.add(eg.getWarningText());
                    }
                }
            }
        }
        allMessages.put("actionMessages", actionMessages);
        allMessages.put("infoMessages", infoMessages);
        allMessages.put("warningMessages", warningMessages);

//        warningMessages.addAll(aSet);
        return allMessages;
    }

    public static List<String> validateAvailableLeaveBalance(LeaveCalendarWSForm lcf) {
    	LeaveBlock updatedLeaveBlock = null;
    	if(lcf.getLeaveBlockId() != null) {
			updatedLeaveBlock = TkServiceLocator.getLeaveBlockService().getLeaveBlock(lcf.getLeaveBlockId());
    	}
    	return validateAvailableLeaveBalanceForUsage(lcf.getSelectedEarnCode(), lcf.getStartDate(), lcf.getEndDate(), lcf.getLeaveAmount(), updatedLeaveBlock);
    }

    public static List<String> validateAvailableLeaveBalanceForUsage(String earnCode, String leaveStartDateString, String leaveEndDateString,
    		BigDecimal leaveAmount, LeaveBlock updatedLeaveBlock) {
    	List<String> errors = new ArrayList<String>();
    	boolean earnCodeChanged = false;
    	BigDecimal oldAmount = null;

		if(updatedLeaveBlock != null) {
			if(!updatedLeaveBlock.getEarnCode().equals(earnCode)) {
				earnCodeChanged = true;
			}
			if(!updatedLeaveBlock.getLeaveAmount().equals(leaveAmount)) {
				oldAmount = updatedLeaveBlock.getLeaveAmount();
			}
		}
		Date startDate = TKUtils.formatDateString(leaveStartDateString);
		Date endDate = TKUtils.formatDateString(leaveEndDateString);
		long daysSpan = TKUtils.getDaysBetween(startDate,endDate);
    	EarnCode earnCodeObj = TkServiceLocator.getEarnCodeService().getEarnCode(earnCode, endDate);
    	if(earnCodeObj != null && earnCodeObj.getAllowNegativeAccrualBalance().equals("N")) {
    		AccrualCategory accrualCategory = TkServiceLocator.getAccrualCategoryService().getAccrualCategory(earnCodeObj.getAccrualCategory(), endDate);
    		if(accrualCategory != null) {
				java.util.Date nextIntervalDate = TkServiceLocator.getAccrualService().getNextAccrualIntervalDate(accrualCategory.getAccrualEarnInterval(), endDate);
				// get the usage checking cut off Date, normally it's the day before the next interval date
				java.util.Date usageEndDate = nextIntervalDate;
				if(nextIntervalDate.compareTo(endDate) > 0) {
					Calendar aCal = Calendar.getInstance();
					aCal.setTime(nextIntervalDate);
					aCal.add(Calendar.DAY_OF_YEAR, -1);
					usageEndDate = aCal.getTime();
				}
				// use the end of the year as the interval date for usage checking of no-accrual hours,
				// normally no-accrual hours are from banked/transferred system scheduled time offs
				if(accrualCategory.getAccrualEarnInterval().equals(LMConstants.ACCRUAL_EARN_INTERVAL_CODE.NO_ACCRUAL)) {
					Calendar aCal = Calendar.getInstance();
					aCal.setTime(endDate);
					aCal.set(Calendar.MONTH, Calendar.DECEMBER);
					aCal.set(Calendar.DAY_OF_MONTH, 31);
					nextIntervalDate = aCal.getTime();
					usageEndDate = nextIntervalDate;
				}
				BigDecimal availableBalance = TkServiceLocator.getLeaveSummaryService()
							.getLeaveBalanceForAccrCatUpToDate(TKContext.getTargetPrincipalId(), startDate, endDate, accrualCategory.getAccrualCategory(), usageEndDate);

				if(oldAmount!=null) {
					if(!earnCodeChanged ||
							updatedLeaveBlock.getAccrualCategory().equals(accrualCategory.getAccrualCategory())) {
						availableBalance = availableBalance.add(oldAmount.abs());
					}
				}
				//multiply by days in span in case the user has also edited the start/end dates.
				BigDecimal desiredUsage = leaveAmount.multiply(new BigDecimal(daysSpan+1));
				if(desiredUsage.compareTo(availableBalance) >  0 ) {
					errors.add("Requested leave amount " + desiredUsage.toString() + " is greater than available leave balance " + availableBalance.toString());      //errorMessages
				}
    		}
    	}

    	return errors;
    }

    // KPME-2010
    public static List<String> validateSpanningWeeks(LeaveCalendarWSForm lcf) {
    	boolean spanningWeeks = lcf.getSpanningWeeks().equalsIgnoreCase("y");
    	DateTime startTemp = new DateTime(TKUtils.convertDateStringToTimestamp(lcf.getStartDate()).getTime());
        DateTime endTemp = new DateTime(TKUtils.convertDateStringToTimestamp(lcf.getEndDate()).getTime());

        List<String> errors = new ArrayList<String>();
    	boolean valid = true;
    	while ((startTemp.isBefore(endTemp) || startTemp.isEqual(endTemp)) && valid) {
           	if (!spanningWeeks &&
        		(startTemp.getDayOfWeek() == DateTimeConstants.SATURDAY || startTemp.getDayOfWeek() == DateTimeConstants.SUNDAY)) {
        		valid = false;
        	}
        	startTemp = startTemp.plusDays(1);
        }
        if (!valid) {
        	errors.add("Weekend day is selected, but include weekends checkbox is not checked");            //errorMessages
        }
    	return errors;
    }
}