org.jasig.schedassist.web.owner.schedule.ClearWeekFormController.java Source code

Introduction

Here is the source code for org.jasig.schedassist.web.owner.schedule.ClearWeekFormController.java

Source

/**
 * Licensed to Jasig under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Jasig licenses this file to you under the Apache 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.apache.org/licenses/LICENSE-2.0
 *
 * 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.jasig.schedassist.web.owner.schedule;

import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;

import javax.validation.Valid;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.jasig.schedassist.impl.owner.AvailableScheduleDao;
import org.jasig.schedassist.impl.owner.NotRegisteredException;
import org.jasig.schedassist.model.AvailableBlock;
import org.jasig.schedassist.model.AvailableSchedule;
import org.jasig.schedassist.model.CommonDateOperations;
import org.jasig.schedassist.model.IScheduleOwner;
import org.jasig.schedassist.model.InputFormatException;
import org.jasig.schedassist.web.security.CalendarAccountUserDetails;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.core.context.SecurityContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.WebDataBinder;
import org.springframework.web.bind.annotation.InitBinder;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.view.RedirectView;

/**
 * {@link Controller} implementation that allows an {@link IScheduleOwner}
 * to remove a week of {@link AvailableBlock}s from their {@link AvailableSchedule}.
 * 
 * @author Nicholas Blair, nblair@doit.wisc.edu
 * @version $Idr: ClearWeekFormController.java $
 */
@Controller
@RequestMapping(value = { "/owner/clear-week.html", "/delegate/clear-week.html" })
public class ClearWeekFormController {

    protected final Log log = LogFactory.getLog(this.getClass());

    private AvailableScheduleDao availableScheduleDao;

    /**
     * @param availableScheduleDao the availableScheduleDao to set
     */
    @Autowired
    public void setAvailableScheduleDao(AvailableScheduleDao availableScheduleDao) {
        this.availableScheduleDao = availableScheduleDao;
    }

    /**
     * @return the availableScheduleDao
     */
    public AvailableScheduleDao getAvailableScheduleDao() {
        return availableScheduleDao;
    }

    /**
     * 
     * @param binder
     */
    @InitBinder
    protected void initBinder(WebDataBinder binder) {
        binder.setValidator(new ClearAvailableScheduleFormBackingObjectValidator());
    }

    /**
     * 
     * @param weekOfPhrase
     * @param model
     * @return
     */
    @RequestMapping(method = RequestMethod.GET)
    protected String setupForm(@RequestParam(value = "weekOf", required = false) String weekOfPhrase,
            final ModelMap model) {
        ClearAvailableScheduleFormBackingObject fbo = new ClearAvailableScheduleFormBackingObject();
        if (StringUtils.isBlank(weekOfPhrase)) {
            setWeekOfDefault(fbo);
        } else {
            safeInterpretWeekOfPhrase(weekOfPhrase, fbo);
        }
        try {
            model.addAttribute("weekOf", CommonDateOperations.parseDatePhrase(fbo.getWeekOfPhrase()));
        } catch (InputFormatException e) {
            log.warn("illegal state, InputFormatException thrown for known safe weekOfPhrase", e);
        }
        model.addAttribute("command", fbo);
        return "owner-schedule/clear-week-form";
    }

    /**
     * Parses the weekOfPhrase query parameter, and mutates the command object with safe values
     * no matter what.
     * 
     * @param weekOfPhrase
     * @param command
     */
    protected void safeInterpretWeekOfPhrase(String weekOfPhrase, ClearAvailableScheduleFormBackingObject command) {
        try {
            // first parse the string to get the intended date
            Date weekOf = CommonDateOperations.parseDatePhrase(weekOfPhrase);
            // then calculate the sunday prior
            weekOf = CommonDateOperations.calculateSundayPrior(weekOf);
            // convert the sunday prior back into the datePhrase format
            SimpleDateFormat df = CommonDateOperations.getDateFormat();
            command.setWeekOfPhrase(df.format(weekOf));
        } catch (InputFormatException e) {
            // failed to parse weekOf, default to "this week"
            setWeekOfDefault(command);
            log.debug("failed to parse " + weekOfPhrase + ", using default values");
        }
    }

    /**
     * Mutates the command object, setting default value for weekOfPhrase based on "today".
     * @param command
     */
    protected void setWeekOfDefault(ClearAvailableScheduleFormBackingObject command) {
        Date weekOf = CommonDateOperations.calculateSundayPrior(new Date());
        SimpleDateFormat df = CommonDateOperations.getDateFormat();
        command.setWeekOfPhrase(df.format(weekOf));
    }

    /**
     * 
     * @param fbo
     * @return
     * @throws NotRegisteredException
     * @throws InputFormatException
     */
    @RequestMapping(method = RequestMethod.POST)
    protected ModelAndView clearWeek(@Valid ClearAvailableScheduleFormBackingObject fbo)
            throws NotRegisteredException, InputFormatException {
        CalendarAccountUserDetails currentUser = (CalendarAccountUserDetails) SecurityContextHolder.getContext()
                .getAuthentication().getPrincipal();
        IScheduleOwner owner = currentUser.getScheduleOwner();

        if (fbo.isConfirmedCancelWeek()) {
            Date weekOf = CommonDateOperations.parseDatePhrase(fbo.getWeekOfPhrase());
            AvailableSchedule scheduleWeekOf = availableScheduleDao.retrieveWeeklySchedule(owner, weekOf);
            availableScheduleDao.removeFromSchedule(owner, scheduleWeekOf.getAvailableBlocks());
            Map<String, Object> model = new HashMap<String, Object>();
            model.put("weekOf", weekOf);
            return new ModelAndView("owner-schedule/clear-week-success", model);
        } else {
            log.debug("owner (" + owner + ") did not confirm request to clear schedule for weekOf "
                    + fbo.getWeekOfPhrase() + ", cancelling");
            return new ModelAndView(new RedirectView("schedule.html", true));
        }
    }

}