cec.easyshop.storefront.controllers.pages.CartPageController.java Source code

Java tutorial

Introduction

Here is the source code for cec.easyshop.storefront.controllers.pages.CartPageController.java

Source

/*
 * [y] hybris Platform
 *
 * Copyright (c) 2000-2015 hybris AG
 * All rights reserved.
 *
 * This software is the confidential and proprietary information of hybris
 * ("Confidential Information"). You shall not disclose such Confidential
 * Information and shall use it only in accordance with the terms of the
 * license agreement you entered into with hybris.
 *
 *
 */
package cec.easyshop.storefront.controllers.pages;

import de.hybris.platform.acceleratorfacades.flow.impl.SessionOverrideCheckoutFlowFacade;
import de.hybris.platform.acceleratorservices.controllers.page.PageType;
import de.hybris.platform.acceleratorservices.enums.CheckoutFlowEnum;
import de.hybris.platform.acceleratorservices.enums.CheckoutPciOptionEnum;
import de.hybris.platform.acceleratorstorefrontcommons.annotations.RequireHardLogIn;
import de.hybris.platform.acceleratorstorefrontcommons.breadcrumb.ResourceBreadcrumbBuilder;
import de.hybris.platform.acceleratorstorefrontcommons.constants.WebConstants;
import de.hybris.platform.acceleratorstorefrontcommons.controllers.pages.AbstractCartPageController;
import de.hybris.platform.acceleratorstorefrontcommons.controllers.util.GlobalMessages;
import de.hybris.platform.acceleratorstorefrontcommons.forms.UpdateQuantityForm;
import de.hybris.platform.cms2.exceptions.CMSItemNotFoundException;
import de.hybris.platform.commercefacades.order.data.CartData;
import de.hybris.platform.commercefacades.order.data.CartModificationData;
import de.hybris.platform.commercefacades.order.data.OrderEntryData;
import de.hybris.platform.commercefacades.product.ProductFacade;
import de.hybris.platform.commercefacades.product.ProductOption;
import de.hybris.platform.commercefacades.product.data.ProductData;
import de.hybris.platform.commerceservices.order.CommerceCartModificationException;
import de.hybris.platform.enumeration.EnumerationService;
import cec.easyshop.storefront.controllers.ControllerConstants;

import java.util.Arrays;

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

import org.apache.commons.lang.StringUtils;
import org.apache.log4j.Logger;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
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.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.mvc.support.RedirectAttributes;

/**
 * Controller for cart page
 */
@Controller
@Scope("tenant")
@RequestMapping(value = "/cart")
public class CartPageController extends AbstractCartPageController {
    protected static final Logger LOG = Logger.getLogger(CartPageController.class);

    public static final String SHOW_CHECKOUT_STRATEGY_OPTIONS = "storefront.show.checkout.flows";
    public static final String ERROR_MSG_TYPE = "errorMsg";
    public static final String SUCCESSFUL_MODIFICATION_CODE = "success";

    @Resource(name = "simpleBreadcrumbBuilder")
    private ResourceBreadcrumbBuilder resourceBreadcrumbBuilder;

    @Resource(name = "enumerationService")
    private EnumerationService enumerationService;

    @Resource(name = "productVariantFacade")
    private ProductFacade productFacade;

    @ModelAttribute("showCheckoutStrategies")
    public boolean isCheckoutStrategyVisible() {
        return getSiteConfigService().getBoolean(SHOW_CHECKOUT_STRATEGY_OPTIONS, false);
    }

    /*
     * Display the cart page
     */
    @RequestMapping(method = RequestMethod.GET)
    public String showCart(final Model model) throws CMSItemNotFoundException, CommerceCartModificationException {
        prepareDataForPage(model);
        model.addAttribute(WebConstants.BREADCRUMBS_KEY,
                resourceBreadcrumbBuilder.getBreadcrumbs("breadcrumb.cart"));
        model.addAttribute("pageType", PageType.CART.name());
        return ControllerConstants.Views.Pages.Cart.CartPage;
    }

    /**
     * Handle the '/cart/checkout' request url. This method checks to see if the cart is valid before allowing the
     * checkout to begin. Note that this method does not require the user to be authenticated and therefore allows us to
     * validate that the cart is valid without first forcing the user to login. The cart will be checked again once the
     * user has logged in.
     *
     * @return The page to redirect to
     */
    @RequestMapping(value = "/checkout", method = RequestMethod.GET)
    @RequireHardLogIn
    public String cartCheck(final Model model, final RedirectAttributes redirectModel)
            throws CommerceCartModificationException {
        SessionOverrideCheckoutFlowFacade.resetSessionOverrides();

        if (!getCartFacade().hasEntries()) {
            LOG.info("Missing or empty cart");

            // No session cart or empty session cart. Bounce back to the cart page.
            return REDIRECT_PREFIX + "/cart";
        }

        if (validateCart(redirectModel)) {
            return REDIRECT_PREFIX + "/cart";
        }

        // Redirect to the start of the checkout flow to begin the checkout process
        // We just redirect to the generic '/checkout' page which will actually select the checkout flow
        // to use. The customer is not necessarily logged in on this request, but will be forced to login
        // when they arrive on the '/checkout' page.
        return REDIRECT_PREFIX + "/checkout";
    }

    @RequestMapping(value = "/getProductVariantMatrix", method = RequestMethod.GET)
    @RequireHardLogIn
    public String getProductVariantMatrix(@RequestParam("productCode") final String productCode,
            final Model model) {

        final ProductData productData = productFacade.getProductForCodeAndOptions(productCode,
                Arrays.asList(ProductOption.BASIC, ProductOption.CATEGORIES, ProductOption.VARIANT_MATRIX_BASE,
                        ProductOption.VARIANT_MATRIX_PRICE, ProductOption.VARIANT_MATRIX_MEDIA,
                        ProductOption.VARIANT_MATRIX_STOCK, ProductOption.VARIANT_MATRIX_URL));

        model.addAttribute("product", productData);

        return ControllerConstants.Views.Fragments.Cart.ExpandGridInCart;
    }

    // This controller method is used to allow the site to force the visitor through a specified checkout flow.
    // If you only have a static configured checkout flow then you can remove this method.
    @RequestMapping(value = "/checkout/select-flow", method = RequestMethod.GET)
    @RequireHardLogIn
    public String initCheck(final Model model, final RedirectAttributes redirectModel,
            @RequestParam(value = "flow", required = false) final String flow,
            @RequestParam(value = "pci", required = false) final String pci)
            throws CommerceCartModificationException {
        SessionOverrideCheckoutFlowFacade.resetSessionOverrides();

        if (!getCartFacade().hasEntries()) {
            LOG.info("Missing or empty cart");

            // No session cart or empty session cart. Bounce back to the cart page.
            return REDIRECT_PREFIX + "/cart";
        }

        // Override the Checkout Flow setting in the session
        if (StringUtils.isNotBlank(flow)) {
            final CheckoutFlowEnum checkoutFlow = enumerationService.getEnumerationValue(CheckoutFlowEnum.class,
                    StringUtils.upperCase(flow));
            SessionOverrideCheckoutFlowFacade.setSessionOverrideCheckoutFlow(checkoutFlow);
        }

        // Override the Checkout PCI setting in the session
        if (StringUtils.isNotBlank(pci)) {
            final CheckoutPciOptionEnum checkoutPci = enumerationService
                    .getEnumerationValue(CheckoutPciOptionEnum.class, StringUtils.upperCase(pci));
            SessionOverrideCheckoutFlowFacade.setSessionOverrideSubscriptionPciOption(checkoutPci);
        }

        // Redirect to the start of the checkout flow to begin the checkout process
        // We just redirect to the generic '/checkout' page which will actually select the checkout flow
        // to use. The customer is not necessarily logged in on this request, but will be forced to login
        // when they arrive on the '/checkout' page.
        return REDIRECT_PREFIX + "/checkout";
    }

    @RequestMapping(value = "/update", method = RequestMethod.POST)
    public String updateCartQuantities(@RequestParam("entryNumber") final long entryNumber, final Model model,
            @Valid final UpdateQuantityForm form, final BindingResult bindingResult,
            final HttpServletRequest request, final RedirectAttributes redirectModel)
            throws CMSItemNotFoundException {
        if (bindingResult.hasErrors()) {
            for (final ObjectError error : bindingResult.getAllErrors()) {
                if (error.getCode().equals("typeMismatch")) {
                    GlobalMessages.addErrorMessage(model, "basket.error.quantity.invalid");
                } else {
                    GlobalMessages.addErrorMessage(model, error.getDefaultMessage());
                }
            }
        } else if (getCartFacade().hasEntries()) {
            try {
                final CartModificationData cartModification = getCartFacade().updateCartEntry(entryNumber,
                        form.getQuantity().longValue());
                if (cartModification.getQuantity() == form.getQuantity().longValue()) {
                    // Success

                    if (cartModification.getQuantity() == 0) {
                        // Success in removing entry
                        GlobalMessages.addFlashMessage(redirectModel, GlobalMessages.CONF_MESSAGES_HOLDER,
                                "basket.page.message.remove");
                    } else {
                        // Success in update quantity
                        GlobalMessages.addFlashMessage(redirectModel, GlobalMessages.CONF_MESSAGES_HOLDER,
                                "basket.page.message.update");
                    }
                } else if (cartModification.getQuantity() > 0) {
                    // Less than successful
                    GlobalMessages.addFlashMessage(redirectModel, GlobalMessages.ERROR_MESSAGES_HOLDER,
                            "basket.page.message.update.reducedNumberOfItemsAdded.lowStock",
                            new Object[] { cartModification.getEntry().getProduct().getName(),
                                    cartModification.getQuantity(), form.getQuantity(), request.getRequestURL()
                                            .append(cartModification.getEntry().getProduct().getUrl()) });
                } else {
                    // No more stock available
                    GlobalMessages.addFlashMessage(redirectModel, GlobalMessages.ERROR_MESSAGES_HOLDER,
                            "basket.page.message.update.reducedNumberOfItemsAdded.noStock",
                            new Object[] { cartModification.getEntry().getProduct().getName(), request
                                    .getRequestURL().append(cartModification.getEntry().getProduct().getUrl()) });
                }

                // Redirect to the cart page on update success so that the browser doesn't re-post again
                return REDIRECT_PREFIX + "/cart";
            } catch (final CommerceCartModificationException ex) {
                LOG.warn("Couldn't update product with the entry number: " + entryNumber + ".", ex);
            }
        }

        prepareDataForPage(model);

        model.addAttribute(WebConstants.BREADCRUMBS_KEY,
                resourceBreadcrumbBuilder.getBreadcrumbs("breadcrumb.cart"));
        model.addAttribute("pageType", PageType.CART.name());

        return ControllerConstants.Views.Pages.Cart.CartPage;
    }

    @SuppressWarnings("boxing")
    @ResponseBody
    @RequestMapping(value = "/updateMultiD", method = RequestMethod.POST)
    public CartData updateCartQuantitiesMultiD(@RequestParam("entryNumber") final Integer entryNumber,
            @RequestParam("productCode") final String productCode, final Model model,
            @Valid final UpdateQuantityForm form, final BindingResult bindingResult) {
        if (bindingResult.hasErrors()) {
            for (final ObjectError error : bindingResult.getAllErrors()) {
                if (error.getCode().equals("typeMismatch")) {
                    GlobalMessages.addErrorMessage(model, "basket.error.quantity.invalid");
                } else {
                    GlobalMessages.addErrorMessage(model, error.getDefaultMessage());
                }
            }
        } else {
            try {
                final CartModificationData cartModification = getCartFacade()
                        .updateCartEntry(getOrderEntryData(form.getQuantity(), productCode, entryNumber));
                if (cartModification.getStatusCode().equals(SUCCESSFUL_MODIFICATION_CODE)) {
                    GlobalMessages.addMessage(model, GlobalMessages.CONF_MESSAGES_HOLDER,
                            cartModification.getStatusMessage(), null);
                } else if (!model.containsAttribute(ERROR_MSG_TYPE)) {
                    GlobalMessages.addMessage(model, GlobalMessages.ERROR_MESSAGES_HOLDER,
                            cartModification.getStatusMessage(), null);
                }
            } catch (final CommerceCartModificationException ex) {
                LOG.warn("Couldn't update product with the entry number: " + entryNumber + ".", ex);
            }

        }
        return getCartFacade().getSessionCart();
    }

    @SuppressWarnings("boxing")
    protected OrderEntryData getOrderEntryData(final long quantity, final String productCode,
            final Integer entryNumber) {
        final OrderEntryData orderEntry = new OrderEntryData();
        orderEntry.setQuantity(quantity);
        orderEntry.setProduct(new ProductData());
        orderEntry.getProduct().setCode(productCode);
        orderEntry.setEntryNumber(entryNumber);
        return orderEntry;
    }

}