UIFormLifecycle.java

/**
 * Copyright (C) 2009 eXo Platform SAS.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.exoplatform.webui.core.lifecycle;

import java.util.ArrayList;
import java.util.List;

import org.exoplatform.web.application.ApplicationMessage;
import org.exoplatform.webui.application.WebuiRequestContext;
import org.exoplatform.webui.core.UIApplication;
import org.exoplatform.webui.core.UIComponent;
import org.exoplatform.webui.event.Event;
import org.exoplatform.webui.exception.MessageException;
import org.exoplatform.webui.form.UIForm;
import org.exoplatform.webui.form.UIFormInput;
import org.exoplatform.webui.form.UIFormInputBase;
import org.exoplatform.webui.form.UIFormInputContainer;
import org.exoplatform.webui.form.UIFormInputSet;
import org.exoplatform.webui.form.UIFormMultiValueInputSet;
import org.exoplatform.webui.form.validator.Validator;

/** Author : Nhu Dinh Thuan nhudinhthuan@yahoo.com Jun 1, 2006 */
public class UIFormLifecycle extends Lifecycle<UIForm> {

    public void processDecode(UIForm uicomponent, WebuiRequestContext context) throws Exception {
        uicomponent.setSubmitAction(null);
        processNormalRequest(uicomponent, context);
        List<UIComponent> children = uicomponent.getChildren();
        for (UIComponent uiChild : children) {
            uiChild.processDecode(context);
        }
        String action = uicomponent.getSubmitAction();
        String subComponentId = context.getRequestParameter(UIForm.SUBCOMPONENT_ID);
        if (subComponentId == null || subComponentId.trim().length() < 1) {
            Event<UIComponent> event = uicomponent.createEvent(action, Event.Phase.DECODE, context);
            if (event != null) {
                event.broadcast();
            }
            return;
        }
        UIComponent uiSubComponent = uicomponent.findComponentById(subComponentId);
        Event<UIComponent> event = uiSubComponent.createEvent(action, Event.Phase.DECODE, context);
        if (event == null) {
            event = uicomponent.createEvent(action, Event.Phase.DECODE, context);
        }
        if (event != null) {
            event.broadcast();
        }
    }

    public void processAction(UIForm uicomponent, WebuiRequestContext context) throws Exception {
        String action = context.getRequestParameter(UIForm.ACTION);
        if (action == null) {
            action = uicomponent.getSubmitAction();
        }
        if (action == null) {
            return;
        }
        Event<UIComponent> event = uicomponent.createEvent(action, Event.Phase.PROCESS, context);
        if (event == null) {
            event = uicomponent.<UIComponent> getParent().createEvent(action, Event.Phase.PROCESS, context);
        }
        if (event == null) {
            return;
        }
        UIApplication uiApp = uicomponent.getAncestorOfType(UIApplication.class);
        List<UIComponent> children = uicomponent.getChildren();
        validateChildren(children, uiApp, context);

        if (context.getProcessRender()) {
            return;
        }
        event.broadcast();
    }

    private void processNormalRequest(UIForm uiForm, WebuiRequestContext context) throws Exception {
        List<UIFormInputBase> inputs = new ArrayList<UIFormInputBase>();
        uiForm.findComponentOfType(inputs, UIFormInputBase.class);
        uiForm.setSubmitAction(context.getRequestParameter(UIForm.ACTION));
        for (UIFormInputBase input : inputs) {
            if (!input.isValid()) {
                continue;
            }
            String inputValue = context.getRequestParameter(input.getId());
            if (inputValue == null || inputValue.trim().length() == 0) {
                inputValue = context.getRequestParameter(input.getName());
            }
            input.decode(inputValue, context);
        }
    }

    @SuppressWarnings("unchecked")
    private void validateChildren(List<UIComponent> children, UIApplication uiApp, WebuiRequestContext context) {
        for (UIComponent uiChild : children) {
            if (uiChild instanceof UIFormInputBase) {
                UIFormInputBase uiInput = (UIFormInputBase) uiChild;
                if (!uiInput.isValid()) {
                    continue;
                }
                List<Validator> validators = uiInput.getValidators();
                if (validators == null) {
                    continue;
                }
                try {
                    for (Validator validator : validators) {
                        validator.validate(uiInput);
                    }
                } catch (MessageException ex) {
                    uiApp.addMessage(ex.getDetailMessage());
                    context.setProcessRender(true);
                } catch (Exception ex) {
                    // TODO: This is a critical exception and should be handle in the UIApplication
                    uiApp.addMessage(new ApplicationMessage(ex.getMessage(), null));
                    context.setProcessRender(true);
                }
            } else if (uiChild instanceof UIFormInputSet) {
                UIFormInputSet uiInputSet = (UIFormInputSet) uiChild;
                validateChildren(uiInputSet.getChildren(), uiApp, context);
            } else if (uiChild instanceof UIFormMultiValueInputSet) {
                UIFormMultiValueInputSet uiInput = (UIFormMultiValueInputSet) uiChild;
                List<Validator> validators = uiInput.getValidators();
                if (validators == null) {
                    continue;
                }
                try {
                    for (Validator validator : validators) {
                        List<UIComponent> uiInputChild = uiInput.getChildren();
                        for (int i = 0; i < uiInputChild.size(); i++) {
                            try {
                                validator.validate((UIFormInput) uiInputChild.get(i));
                            } catch (MessageException ex) {
                                uiApp.addMessage(ex.getDetailMessage());
                                context.setProcessRender(true);
                            }
                        }
                    }
                } catch (Exception ex) {
                    // TODO: This is a critical exception and should be handle in the UIApplication
                    uiApp.addMessage(new ApplicationMessage(ex.getMessage(), null));
                    context.setProcessRender(true);
                }
            } else if (uiChild instanceof UIFormInputContainer) {
                UIFormInputContainer uiInput = (UIFormInputContainer) uiChild;
                List<Validator> validators = uiInput.getValidators();
                if (validators == null) {
                    continue;
                }
                try {
                    for (Validator validator : validators) {
                        validator.validate(uiInput);
                    }
                } catch (MessageException ex) {
                    uiApp.addMessage(ex.getDetailMessage());
                    context.setProcessRender(true);
                } catch (Exception ex) {
                    // TODO: This is a critical exception and should be handle in the UIApplication
                    uiApp.addMessage(new ApplicationMessage(ex.getMessage(), null));
                    context.setProcessRender(true);
                }
            }
        }
    }
}