001    /**
002     * Copyright 2004-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.hr.lm.leave.web;
017    
018    import java.sql.Date;
019    import java.util.HashMap;
020    import java.util.LinkedList;
021    import java.util.List;
022    import java.util.Map;
023    
024    import javax.servlet.http.HttpServletRequest;
025    import javax.servlet.http.HttpServletResponse;
026    
027    import org.apache.commons.lang.StringUtils;
028    import org.apache.log4j.Logger;
029    import org.apache.struts.action.ActionForm;
030    import org.apache.struts.action.ActionForward;
031    import org.apache.struts.action.ActionMapping;
032    import org.joda.time.DateTime;
033    import org.json.simple.JSONArray;
034    import org.json.simple.JSONValue;
035    import org.kuali.hr.lm.LMConstants;
036    import org.kuali.hr.lm.accrual.AccrualCategory;
037    import org.kuali.hr.lm.leaveSummary.LeaveSummary;
038    import org.kuali.hr.lm.leavecalendar.LeaveCalendarDocument;
039    import org.kuali.hr.lm.leavecalendar.validation.LeaveCalendarValidationUtil;
040    import org.kuali.hr.lm.leavecalendar.web.LeaveCalendarForm;
041    import org.kuali.hr.time.assignment.Assignment;
042    import org.kuali.hr.time.assignment.AssignmentDescriptionKey;
043    import org.kuali.hr.time.base.web.TkAction;
044    import org.kuali.hr.time.calendar.CalendarEntries;
045    import org.kuali.hr.time.detail.web.ActionFormUtils;
046    import org.kuali.hr.time.earncode.EarnCode;
047    import org.kuali.hr.time.service.base.TkServiceLocator;
048    import org.kuali.hr.time.util.TKContext;
049    import org.kuali.hr.time.util.TKUser;
050    import org.kuali.hr.time.util.TKUtils;
051    
052    public class LeaveCalendarWSAction extends TkAction {
053    
054        private static final Logger LOG = Logger.getLogger(LeaveCalendarWSAction.class);
055    
056        @Override
057        public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
058            //return super.execute(mapping, form, request, response);
059            LeaveCalendarWSForm lcf = (LeaveCalendarWSForm) form;
060    
061            String documentId = lcf.getDocumentId();
062            // if the reload was trigger by changing of the selectedPayPeriod, use the passed in parameter as the calendar entry id
063            String calendarEntryId = StringUtils.isNotBlank(request.getParameter("selectedPP")) ? request.getParameter("selectedPP") : lcf.getCalEntryId();
064    
065            // Here - viewPrincipal will be the principal of the user we intend to
066            // view, be it target user, backdoor or otherwise.
067            String viewPrincipal = TKUser.getCurrentTargetPersonId();
068            CalendarEntries calendarEntry = null;
069    
070            LeaveCalendarDocument lcd = null;
071            // By handling the prev/next in the execute method, we are saving one
072            // fetch/construction of a TimesheetDocument. If it were broken out into
073            // methods, we would first fetch the current document, and then fetch
074            // the next one instead of doing it in the single action.
075            if (StringUtils.isNotBlank(documentId)) {
076                lcd = TkServiceLocator.getLeaveCalendarService()
077                        .getLeaveCalendarDocument(documentId);
078                if (lcd != null) {
079                    calendarEntry = lcd.getCalendarEntry();
080                }
081            } else if (StringUtils.isNotBlank(calendarEntryId)) {
082                // do further procedure
083                calendarEntry = TkServiceLocator.getCalendarEntriesService()
084                        .getCalendarEntries(calendarEntryId);
085                lcd = TkServiceLocator.getLeaveCalendarService()
086                        .getLeaveCalendarDocument(viewPrincipal, calendarEntry);
087            } else {
088                // Default to whatever is active for "today".
089                Date currentDate = TKUtils.getTimelessDate(null);
090                calendarEntry = TkServiceLocator.getCalendarService()
091                        .getCurrentCalendarDatesForLeaveCalendar(viewPrincipal, currentDate);
092                lcd = TkServiceLocator.getLeaveCalendarService()
093                        .openLeaveCalendarDocument(viewPrincipal, calendarEntry);
094            }
095    
096            lcf.setCalendarEntry(calendarEntry);
097            lcf.setAssignmentDescriptions(TkServiceLocator.getAssignmentService().getAssignmentDescriptions(lcd));
098    
099            if (lcd != null) {
100                setupDocumentOnFormContext(lcf, lcd);
101            } else {
102                LOG.error("Null leave calendar document in LeaveCalendarAction.");
103            }
104    
105            ActionForward forward = super.execute(mapping, form, request, response);
106            if (forward.getRedirect()) {
107                return forward;
108            }
109    
110            return forward;
111        }
112    
113            
114        public ActionForward getEarnCodeInfo(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
115            LeaveCalendarWSForm lcf = (LeaveCalendarWSForm) form;
116            LOG.info(lcf.toString());
117            EarnCode earnCode = TkServiceLocator.getEarnCodeService().getEarnCodeById(lcf.getSelectedEarnCode());
118            String unitTime = ActionFormUtils.getUnitOfTimeForEarnCode(earnCode);
119            Map<String, Object> earnCodeMap = new HashMap<String, Object>();
120            earnCodeMap.put("unitOfTime", unitTime);
121            earnCodeMap.put("defaultAmountofTime", earnCode.getDefaultAmountofTime());
122            earnCodeMap.put("fractionalTimeAllowed", earnCode.getFractionalTimeAllowed());
123            lcf.setOutputString(JSONValue.toJSONString(earnCodeMap));
124            return mapping.findForward("ws");
125        }
126    
127        public ActionForward getEarnCodeJson(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
128            //TODO: copied from TimeDetailWSAction.  Need to reduce code duplication
129            LeaveCalendarWSForm lcf = (LeaveCalendarWSForm) form;
130    
131    
132            if(request.getParameter("selectedPayPeriod") != null) {
133                lcf.setSelectedPayPeriod(request.getParameter("selectedPayPeriod"));
134                CalendarEntries ce = TkServiceLocator.getCalendarEntriesService().getCalendarEntries(request.getParameter("selectedPayPeriod"));
135                lcf.setCalendarEntry(ce);
136            }
137            lcf.setPrincipalId(TKUser.getCurrentTargetPersonId());
138            boolean isPlanningCal = TkServiceLocator.getLeaveCalendarService().isLeavePlanningCalendar(lcf.getPrincipalId(), lcf.getCalendarEntry().getBeginPeriodDateTime(), lcf.getCalendarEntry().getEndPeriodDateTime());
139            lcf.setLeavePlanningCalendar(isPlanningCal);
140    
141            List<Map<String, Object>> earnCodeList = new LinkedList<Map<String, Object>>();
142    
143            if (StringUtils.isNotBlank(lcf.getSelectedAssignment())) {
144                List<Assignment> assignments = lcf.getLeaveCalendarDocument().getAssignments();
145                AssignmentDescriptionKey key = new AssignmentDescriptionKey(lcf.getSelectedAssignment());
146                for (Assignment assignment : assignments) {
147                    if (assignment.getJobNumber().compareTo(key.getJobNumber()) == 0 &&
148                            assignment.getWorkArea().compareTo(key.getWorkArea()) == 0 &&
149                            assignment.getTask().compareTo(key.getTask()) == 0) {
150                            List<EarnCode> earnCodes = TkServiceLocator.getEarnCodeService().getEarnCodesForLeave(assignment, new java.sql.Date(TKUtils.convertDateStringToTimestamp(lcf.getStartDate()).getTime()), lcf.isLeavePlanningCalendar());
151                        for (EarnCode earnCode : earnCodes) {
152                            Map<String, Object> earnCodeMap = new HashMap<String, Object>();
153                            earnCodeMap.put("assignment", assignment.getAssignmentKey());
154                            earnCodeMap.put("earnCode", earnCode.getEarnCode());
155                            earnCodeMap.put("desc", earnCode.getDescription());
156                            earnCodeMap.put("type", earnCode.getEarnCodeType());
157                            earnCodeMap.put("earnCodeId", earnCode.getHrEarnCodeId());
158                            earnCodeMap.put("unitOfTime", earnCode.getRecordMethod());
159                            earnCodeMap.put("defaultAmountofTime", earnCode.getDefaultAmountofTime());
160                            earnCodeMap.put("fractionalTimeAllowed", earnCode.getFractionalTimeAllowed());
161                            earnCodeList.add(earnCodeMap);
162                        }
163                    }
164                }
165            }
166            //LOG.info(lcf.toString());
167            lcf.setOutputString(JSONValue.toJSONString(earnCodeList));
168            return mapping.findForward("ws");
169        }
170        
171        /**
172         * This is an ajax call triggered after a user submits the leave entry form.
173         * If there is any error, it will return error messages as a json object.
174         *
175         * @param mapping
176         * @param form
177         * @param request
178         * @param response
179         * @return jsonObj
180         * @throws Exception
181         */
182        @SuppressWarnings("unchecked")
183        public ActionForward validateLeaveEntry(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
184            LeaveCalendarWSForm lcf = (LeaveCalendarWSForm) form;
185            JSONArray errorMsgList = new JSONArray();
186    
187            if(lcf.getLeaveSummary() == null && lcf.getCalendarEntry() != null) {
188                    LeaveSummary ls = TkServiceLocator.getLeaveSummaryService().getLeaveSummary(TKContext.getTargetPrincipalId(), lcf.getCalendarEntry());
189                        lcf.setLeaveSummary(ls);
190            }
191            
192            errorMsgList.addAll(LeaveCalendarValidationUtil.validateParametersAccordingToSelectedEarnCodeRecordMethod(lcf));
193            
194            errorMsgList.addAll(LeaveCalendarValidationUtil.validateAvailableLeaveBalance(lcf));
195            //KPME-1263
196            errorMsgList.addAll(LeaveCalendarValidationUtil.validateLeaveAccrualRuleMaxUsage(lcf));
197    
198            //KPME-2010                
199            errorMsgList.addAll(LeaveCalendarValidationUtil.validateSpanningWeeks(lcf));
200            
201            lcf.setOutputString(JSONValue.toJSONString(errorMsgList));
202            
203            return mapping.findForward("ws");
204        }
205    
206        protected void setupDocumentOnFormContext(LeaveCalendarForm leaveForm,
207                                                  LeaveCalendarDocument lcd) {
208            leaveForm.setLeaveCalendarDocument(lcd);
209        }
210    
211    }