RetailerController.java

/**
 * Most of the code in the Qalingo project is copyrighted Hoteia and licensed
 * under the Apache License Version 2.0 (release version 0.8.0)
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 *                   Copyright (c) Hoteia, 2012-2014
 * http://www.hoteia.com - http://twitter.com/hoteia - contact@hoteia.com
 *
 */
package org.hoteia.qalingo.web.mvc.controller.retailer;

import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;

import javax.servlet.http.HttpServletRequest;
import javax.validation.Valid;

import org.apache.commons.lang.StringUtils;
import org.hoteia.qalingo.core.Constants;
import org.hoteia.qalingo.core.ModelConstants;
import org.hoteia.qalingo.core.RequestConstants;
import org.hoteia.qalingo.core.domain.Localization;
import org.hoteia.qalingo.core.domain.MarketArea;
import org.hoteia.qalingo.core.domain.Retailer;
import org.hoteia.qalingo.core.domain.Warehouse;
import org.hoteia.qalingo.core.domain.enumtype.BoUrls;
import org.hoteia.qalingo.core.fetchplan.retailer.FetchPlanGraphRetailer;
import org.hoteia.qalingo.core.i18n.enumtype.ScopeWebMessage;
import org.hoteia.qalingo.core.service.RetailerService;
import org.hoteia.qalingo.core.service.WarehouseService;
import org.hoteia.qalingo.core.web.mvc.form.RetailerForm;
import org.hoteia.qalingo.core.web.mvc.viewbean.RetailerViewBean;
import org.hoteia.qalingo.core.web.mvc.viewbean.ValueBean;
import org.hoteia.qalingo.core.web.resolver.RequestData;
import org.hoteia.qalingo.core.web.servlet.ModelAndViewThemeDevice;
import org.hoteia.qalingo.core.web.servlet.view.RedirectView;
import org.hoteia.qalingo.web.mvc.controller.AbstractBusinessBackofficeController;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.support.PagedListHolder;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.ModelAttribute;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.servlet.ModelAndView;

/**
 * 
 */
@Controller("retailerController")
public class RetailerController extends AbstractBusinessBackofficeController {

	private final Logger logger = LoggerFactory.getLogger(getClass());

	public static final String SESSION_KEY = "PagedListHolder_Retailers";

	@Autowired
	private RetailerService retailerService;
	
	@Autowired
	private WarehouseService warehouseService;

	@RequestMapping(value = BoUrls.RETAILER_LIST_URL, method = RequestMethod.GET)
	public ModelAndView retailerList(final HttpServletRequest request, final Model model) throws Exception {
		ModelAndViewThemeDevice modelAndView = new ModelAndViewThemeDevice(getCurrentVelocityPath(request), BoUrls.RETAILER_LIST.getVelocityPage());
        final RequestData requestData = requestUtil.getRequestData(request);
        final MarketArea marketArea = requestData.getMarketArea();
		
		displayList(request, model, requestData, null);

        Object[] params = {marketArea.getName() + " (" + marketArea.getCode() + ")"};
        overrideDefaultMainContentTitle(request, modelAndView, BoUrls.RETAILER_LIST.getKey() + ".by.market.area", params);

        model.addAttribute(ModelConstants.URL_ADD, backofficeUrlService.generateUrl(BoUrls.RETAILER_ADD, requestData));

        return modelAndView;
	}
	
	@RequestMapping(value = BoUrls.RETAILER_LIST_URL, method = RequestMethod.POST)
	public ModelAndView searchRetailerList(final HttpServletRequest request, final Model model) throws Exception {
		ModelAndViewThemeDevice modelAndView = new ModelAndViewThemeDevice(getCurrentVelocityPath(request), BoUrls.RETAILER_LIST.getVelocityPage());
		final RequestData requestData = requestUtil.getRequestData(request);
		
		final String searchText = request.getParameter(RequestConstants.REQUEST_PARAMETER_SEARCH_TXT);
		if(StringUtils.isNotEmpty(searchText)){
			// DEFAULT WAY - BEFORE INTEGRATE SEARCH WITH SOLR
	        request.getSession().removeAttribute(SESSION_KEY); 
			List<Retailer> retailers = retailerService.findRetailersByText(searchText);
			displayList(request, model, requestData, retailers);
		} else {
			return retailerList(request, model);
		}
        return modelAndView;
	}
	
	@RequestMapping(value = BoUrls.RETAILER_DETAILS_URL, method = RequestMethod.GET)
	public ModelAndView retailerDetails(final HttpServletRequest request, final Model model) throws Exception {
		ModelAndViewThemeDevice modelAndView = new ModelAndViewThemeDevice(getCurrentVelocityPath(request), BoUrls.RETAILER_DETAILS.getVelocityPage());
        final RequestData requestData = requestUtil.getRequestData(request);

        final String retailerCode = request.getParameter(RequestConstants.REQUEST_PARAMETER_RETAILER_CODE);

        // SANITY CHECK
        if (StringUtils.isEmpty(retailerCode)) {
            final String urlRedirect = backofficeUrlService.generateUrl(BoUrls.RETAILER_LIST, requestData);
            return new ModelAndView(new RedirectView(urlRedirect));
        }

        final Retailer retailer = retailerService.getRetailerByCode(retailerCode, FetchPlanGraphRetailer.fullRetailerFetchPlan());

        // SANITY CHECK
        if (retailer != null) {
            modelAndView.addObject(ModelConstants.RETAILER_VIEW_BEAN, backofficeViewBeanFactory.buildViewBeanRetailer(requestData, retailer));
        } else {
            final String url = requestUtil.getLastRequestUrl(request);
            return new ModelAndView(new RedirectView(url));
        }

        model.addAttribute(ModelConstants.URL_BACK, backofficeUrlService.generateUrl(BoUrls.RETAILER_LIST, requestData));

        Object[] params = { retailer.getName() + " (" + retailer.getCode() + ")" };
        overrideDefaultMainContentTitle(request, modelAndView, BoUrls.RETAILER_DETAILS.getKey(), params);

        return modelAndView;
	}
	
	@RequestMapping(value = BoUrls.RETAILER_EDIT_URL, method = RequestMethod.GET)
	public ModelAndView retailerEdit(final HttpServletRequest request, final Model model, @ModelAttribute(ModelConstants.RETAILER_FORM) RetailerForm retailerForm) throws Exception {
        ModelAndViewThemeDevice modelAndView = new ModelAndViewThemeDevice(getCurrentVelocityPath(request), BoUrls.RETAILER_EDIT.getVelocityPage());
        final RequestData requestData = requestUtil.getRequestData(request);
        
        final String retailerCode = request.getParameter(RequestConstants.REQUEST_PARAMETER_RETAILER_CODE);
        if(StringUtils.isNotEmpty(retailerCode)){
            // EDIT MODE
            final Retailer retailer = retailerService.getRetailerByCode(retailerCode, FetchPlanGraphRetailer.fullRetailerFetchPlan());

            // SANITY CHECK
            if (retailer != null) {
                modelAndView.addObject(ModelConstants.RETAILER_VIEW_BEAN, backofficeViewBeanFactory.buildViewBeanRetailer(requestData, retailer));
            } else {
                final String url = requestUtil.getLastRequestUrl(request);
                return new ModelAndView(new RedirectView(url));
            }
            
            model.addAttribute(ModelConstants.URL_BACK, backofficeUrlService.generateUrl(BoUrls.RETAILER_DETAILS, requestData, retailer));

            Object[] params = { retailer.getName() + " (" + retailer.getCode() + ")" };
            overrideDefaultMainContentTitle(request, modelAndView, BoUrls.RETAILER_DETAILS.getKey(), params);

        } else {
            // ADD MODE

            overrideDefaultMainContentTitle(request, modelAndView, BoUrls.RETAILER_ADD.getKey(), null);

            model.addAttribute(ModelConstants.URL_BACK, backofficeUrlService.generateUrl(BoUrls.RETAILER_LIST, requestData));
        }

        return modelAndView;
	}
	
	@RequestMapping(value = BoUrls.RETAILER_EDIT_URL, method = RequestMethod.POST)
	public ModelAndView submitRetailerEdit(final HttpServletRequest request, final Model model, @Valid @ModelAttribute(ModelConstants.RETAILER_FORM) RetailerForm retailerForm,
								BindingResult result) throws Exception {
        final RequestData requestData = requestUtil.getRequestData(request);
        final Locale locale = requestData.getLocale();
        
        if (result.hasErrors()) {
            return retailerEdit(request, model, retailerForm);
        }
        
        Retailer retailer = null;
        if(StringUtils.isNotEmpty(retailerForm.getId())){
            retailer = retailerService.getRetailerById(retailerForm.getId());
        }
        
        try {
            // CREATE OR UPDATE RETAILER
            Retailer savedRetailer = webBackofficeService.createOrUpdateRetailer(retailer, retailerForm);
            
            if(retailer == null){
                addSessionSuccessMessage(request, getSpecificMessage(ScopeWebMessage.RETAILER, "create_success_message", locale));
                
            } else {
                addSessionSuccessMessage(request, getSpecificMessage(ScopeWebMessage.RETAILER, "update_success_message", locale));
            }
            final String urlRedirect = backofficeUrlService.generateUrl(BoUrls.RETAILER_DETAILS, requestUtil.getRequestData(request), savedRetailer);
            return new ModelAndView(new RedirectView(urlRedirect));
            
        } catch (Exception e) {
            addMessageError(result, null, "code", "code", getSpecificMessage(ScopeWebMessage.RETAILER, "create_or_update_message", locale));
            logger.error("Can't save or update Retailer:" + retailerForm.getId() + "/" + retailerForm.getCode(), e);
            return retailerEdit(request, model, retailerForm);
        }
	}

	private void displayList(final HttpServletRequest request, final Model model, final RequestData requestData, List<Retailer> retailers) throws Exception{
		final MarketArea marketArea = requestData.getMarketArea();
		final Retailer retailer = requestData.getMarketAreaRetailer();
		
		String url = request.getRequestURI();
		String page = request.getParameter(Constants.PAGINATION_PAGE_PARAMETER);
		
		PagedListHolder<RetailerViewBean> retailerViewBeanPagedListHolder = new PagedListHolder<RetailerViewBean>();

       	if(retailers == null){
    		retailers = retailerService.findRetailers(marketArea.getId(), retailer.getId());
    	}
       	
        if(StringUtils.isEmpty(page)){
        	retailerViewBeanPagedListHolder = initList(request, SESSION_KEY, requestData, retailers);
    		
        } else {
        	retailerViewBeanPagedListHolder = (PagedListHolder) request.getSession().getAttribute(SESSION_KEY); 
	        if (retailerViewBeanPagedListHolder == null) { 
	        	retailerViewBeanPagedListHolder = initList(request, SESSION_KEY, requestData, retailers);
	        }
	        int pageTarget = new Integer(page).intValue() - 1;
	        int pageCurrent = retailerViewBeanPagedListHolder.getPage();
	        if (pageCurrent < pageTarget) { 
	        	for (int i = pageCurrent; i < pageTarget; i++) {
	        		retailerViewBeanPagedListHolder.nextPage(); 
				}
	        } else if (pageCurrent > pageTarget) { 
	        	for (int i = pageTarget; i < pageCurrent; i++) {
	        		retailerViewBeanPagedListHolder.previousPage(); 
				}
	        } 
        }
        model.addAttribute(Constants.PAGINATION_PAGE_URL, url);
        model.addAttribute(Constants.PAGINATION_PAGE_PAGED_LIST_HOLDER, retailerViewBeanPagedListHolder);
	}
	
	private PagedListHolder<RetailerViewBean> initList(final HttpServletRequest request, String sessionKey, final RequestData requestData, final List<Retailer> retailers) throws Exception {
		PagedListHolder<RetailerViewBean> retailerViewBeanPagedListHolder = new PagedListHolder<RetailerViewBean>();
		
		final List<RetailerViewBean> RetailerViewBeans = new ArrayList<RetailerViewBean>();
		for (Iterator<Retailer> iterator = retailers.iterator(); iterator.hasNext();) {
			Retailer retailerIt = (Retailer) iterator.next();
			RetailerViewBeans.add(backofficeViewBeanFactory.buildViewBeanRetailer(requestData, retailerIt));
		}
		retailerViewBeanPagedListHolder = new PagedListHolder<RetailerViewBean>(RetailerViewBeans);
		retailerViewBeanPagedListHolder.setPageSize(Constants.PAGE_SIZE);
        request.getSession().setAttribute(sessionKey, retailerViewBeanPagedListHolder); 
        
        return retailerViewBeanPagedListHolder;
	}
    
	/**
	 * 
	 */
    @ModelAttribute(ModelConstants.RETAILER_FORM)
	protected RetailerForm initRetailerForm(final HttpServletRequest request, final Model model) throws Exception {
		final RequestData requestData = requestUtil.getRequestData(request);
		final String retailerCode = request.getParameter(RequestConstants.REQUEST_PARAMETER_RETAILER_CODE);
		if(StringUtils.isNotEmpty(retailerCode)){
	        final Retailer retailer = retailerService.getRetailerByCode(retailerCode, FetchPlanGraphRetailer.fullRetailerFetchPlan());
	        return backofficeFormFactory.buildRetailerForm(requestData, retailer);
		}
    	return backofficeFormFactory.buildRetailerForm(requestData, null);
	}
    
    @ModelAttribute(ModelConstants.COUNTRIES)
    public List<ValueBean> getCountries(HttpServletRequest request) throws Exception {
        Localization currentMarketAreaLocalization = requestUtil.getCurrentMarketAreaLocalization(request);
        return getCountries(currentMarketAreaLocalization.getLocale());
    }
    
    @ModelAttribute(ModelConstants.WAREHOUSES_VIEW_BEAN)
    public List<ValueBean> getWarehouses(HttpServletRequest request) throws Exception{
    	List<ValueBean> warehousesValues = new ArrayList<ValueBean>();
		try {
	        List<Warehouse> warehouses = warehouseService.findWarehouses();
	        if(warehouses != null){
		        for (Iterator<Warehouse> iterator = warehouses.iterator(); iterator.hasNext();) {
		            Warehouse warehouseIt = (Warehouse) iterator.next();
		            final String warehouseId = warehouseIt.getId().toString();
					warehousesValues.add(new ValueBean(warehouseId, warehouseIt.getName()));
		        }
		        Collections.sort(warehousesValues, new Comparator<ValueBean>() {
					@Override
					public int compare(ValueBean o1, ValueBean o2) {
						return o1.getValue().compareTo(o2.getValue());
					}
				});
	        }
		} catch (Exception e) {
			logger.error(e.getMessage(), e);
		}
		return warehousesValues;
    }

}