/*
    * Copyright 2006-2012 The Kuali Foundation
    *
    * Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
    *
   * 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.kuali.rice.krad.uif.element;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.rice.krad.uif.component.Component;
  import org.kuali.rice.krad.uif.container.CollectionGroup;
  import org.kuali.rice.krad.uif.container.Container;
  import org.kuali.rice.krad.uif.container.PageGroup;
  import org.kuali.rice.krad.uif.field.FieldGroup;
  import org.kuali.rice.krad.uif.field.InputField;
  import org.kuali.rice.krad.uif.layout.StackedLayoutManager;
  import org.kuali.rice.krad.uif.layout.TableLayoutManager;
  import org.kuali.rice.krad.uif.util.ScriptUtils;
  import org.kuali.rice.krad.uif.view.View;
  
  import java.util.ArrayList;
  import java.util.List;
  
  /**
   * ValidationMessages for logic and options specific to groups
   */
  public class GroupValidationMessages extends ValidationMessages {
      private static final long serialVersionUID = -5389990220206079052L;
  
      private boolean displayFieldLabelWithMessages;
      private boolean collapseAdditionalFieldLinkMessages;
  
      private static final String SECTION_TOKEN = "s$";
      private static final String FIELDGROUP_TOKEN = "f$";
  
      @Override
      /**
       * Calls super and adds dataAttributes that are appropriate for group level validationMessages
       * data.  This data is used by the validation framework clientside.
       *
       * Some special handling at this level includes retrieving the groups and fields generated by
       * different collection layouts and handling page and fieldGroup scenarios slightly differently
       * due to the nature of how they are built out in the js.
       *
       * @see krad.validate.js
       */
      public void generateMessages(boolean reset, View view, Object model, Component parent) {
          super.generateMessages(reset, view, model, parent);
  
          Object parentContainer = parent.getContext().get("parent");
  
          List<? extends Component> items = ((Container) parent).getItems();
          boolean skipSections = false;
  
          //Handle the special CollectionGroup case by getting the StackedGroups and DataFields generated by them
          if (parent instanceof CollectionGroup) {
              if (((CollectionGroup) parent).getLayoutManager() instanceof StackedLayoutManager) {
                  items = ((StackedLayoutManager) ((CollectionGroup) parent).getLayoutManager()).getStackedGroups();
              } else if (((CollectionGroup) parent).getLayoutManager() instanceof TableLayoutManager) {
                  items = ((TableLayoutManager) ((CollectionGroup) parent).getLayoutManager()).getDataFields();
                  skipSections = true;
              }
          }
  
          List<String> sectionIds = new ArrayList<String>();
          List<String> fieldOrder = new ArrayList<String>();
          collectIdsFromItems(items, sectionIds, fieldOrder, skipSections);
  
          boolean pageLevel = false;
          boolean forceShow = false;
          if (parent instanceof PageGroup) {
              pageLevel = true;
              forceShow = true;
          } else if (parentContainer instanceof FieldGroup) {
              //note this means container of the parent is a FieldGroup
              forceShow = true;
          }
  
          parent.addDataAttribute("validationMessages", "{"
                  + "summarize:"
                  + true
                  + ","
                  + "displayMessages:"
                  + this.isDisplayMessages()
                  + ","
                  + "collapseFieldMessages:"
                  + collapseAdditionalFieldLinkMessages
                  + ","
                  + "displayLabel:"
                 + displayFieldLabelWithMessages
                 + ","
                 + "pageLevel:"
                 + pageLevel
                 + ","
                 + "forceShow:"
                 + forceShow
                 + ","
                 + "sections:"
                 + ScriptUtils.convertStringListToJsArray(sectionIds)
                 + ","
                 + "order:"
                 + ScriptUtils.convertStringListToJsArray(fieldOrder)
                 + ","
                 + "serverErrors:"
                 + ScriptUtils.convertStringListToJsArray(ScriptUtils.escapeHtml(this.getErrors()))
                 + ","
                 + "serverWarnings:"
                 + ScriptUtils.convertStringListToJsArray(ScriptUtils.escapeHtml(this.getWarnings()))
                 + ","
                 + "serverInfo:"
                 + ScriptUtils.convertStringListToJsArray(ScriptUtils.escapeHtml(this.getInfos()))
                 + "}");
     }
 
     /**
      * Collects all the ids from the items passed into this method.  Puts the ids of items determined to be sections
      * into the sectionIds list, and orders all items by the order they appear on the page in the order list with
      * special identifiers
      * to determine the type of item they are (used by the client js).  When skipSections is true do not
      * include sectionIds found in the lists.
      *
      * @param items
      * @param sectionIds
      * @param order
      * @param skipSections
      */
     protected void collectIdsFromItems(List<? extends Component> items, List<String> sectionIds, List<String> order,
             boolean skipSections) {
 
         if (items != null) {
             for (Component c : items) {
                 if (c instanceof Container || c instanceof FieldGroup) {
                     if (c instanceof FieldGroup) {
                         if (!skipSections &&
                                 ((FieldGroup) c).getFieldLabel().isRender() &&
                                 !((FieldGroup) c).getFieldLabel().isHidden() &&
                                 (StringUtils.isNotEmpty(((FieldGroup) c).getLabel()) || StringUtils.isNotEmpty(
                                         ((FieldGroup) c).getFieldLabel().getLabelText()))) {
                             sectionIds.add(c.getId());
                             order.add(FIELDGROUP_TOKEN + c.getId());
                             continue;
                         } else {
                             c = ((FieldGroup) c).getGroup();
                             if (c == null) {
                                 continue;
                             }
                         }
                     }
 
                     //If any kind of header text is showing consider this group a section
                     if (!skipSections
                             && ((Container) c).getHeader() != null
                             && ((Container) c).getHeader().isRender()
                             && (StringUtils.isNotBlank(((Container) c).getHeader().getHeaderText()) || StringUtils
                             .isNotBlank(c.getTitle()))) {
                         sectionIds.add(c.getId());
                         order.add(SECTION_TOKEN + c.getId());
                     } else {
                         collectIdsFromItems(((Container) c).getItems(), sectionIds, order, skipSections);
                     }
                 } else if (c instanceof InputField) {
                     order.add(c.getId());
                 }
             }
         }
     }
 
     /**
      * If true, the error messages will display the an InputField's title
      * alongside the error, warning, and info messages related to it. This
      * setting has no effect on messages which do not relate directly to a
      * single InputField.
      *
      * @return the displayFieldLabelWithMessages
      */
     public boolean isDisplayFieldLabelWithMessages() {
         return this.displayFieldLabelWithMessages;
     }
 
     /**
      * @param displayFieldLabelWithMessages the displayFieldLabelWithMessages to set
      */
     public void setDisplayFieldLabelWithMessages(boolean displayFieldLabelWithMessages) {
         this.displayFieldLabelWithMessages = displayFieldLabelWithMessages;
     }
 
     /**
      * When collapseAdditionalFieldLinkMessages is set to true, the messages generated on field links will be
      * summarized to limit the space they take up with an appendage similar to [+n message type] appended for
      * additional
      * messages that are omitted.  When this flag is false, all messages will be part of the link separated by
      * a comma.
      *
      * @return if field link messages are being collapsed
      */
     public boolean isCollapseAdditionalFieldLinkMessages() {
         return collapseAdditionalFieldLinkMessages;
     }
 
     /**
      * Set collapseAdditionalFieldLinkMessages
      *
      * @param collapseAdditionalFieldLinkMessages - true if field link messages are being collapsed
      */
     public void setCollapseAdditionalFieldLinkMessages(boolean collapseAdditionalFieldLinkMessages) {
         this.collapseAdditionalFieldLinkMessages = collapseAdditionalFieldLinkMessages;
     }
 }