/**
    * This file Copyright (c) 2003-2011 Magnolia International
    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
    *
    *
    * This file is dual-licensed under both the Magnolia
    * Network Agreement and the GNU General Public License.
    * You may elect to use one or the other of these licenses.
    *
   * This file is distributed in the hope that it will be
   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
   * implied warranty of MERCHANTABILITY or FITNESS FOR A
   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
   * Redistribution, except as permitted by whichever of the GPL
   * or MNA you select, is prohibited.
   *
   * 1. For the GPL license (GPL), you can redistribute and/or
   * modify this file under the terms of the GNU General
   * Public License, Version 3, as published by the Free Software
   * Foundation.  You should have received a copy of the GNU
   * General Public License, Version 3 along with this program;
   * if not, write to the Free Software Foundation, Inc., 51
   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
   *
   * 2. For the Magnolia Network Agreement (MNA), this file
   * and the accompanying materials are made available under the
   * terms of the MNA which accompanies this distribution, and
   * is available at http://www.magnolia-cms.com/mna.html
   *
   * Any modifications to this file must keep this entire header
   * intact.
   *
   */
  package info.magnolia.cms.gui.dialog;
  
  import freemarker.template.TemplateException;
  import info.magnolia.cms.core.Content;
  import info.magnolia.cms.core.ItemType;
  import info.magnolia.cms.core.NodeData;
  import info.magnolia.cms.gui.control.ControlImpl;
  import info.magnolia.cms.gui.control.FreemarkerControl;
  import info.magnolia.cms.security.AccessDeniedException;
  import info.magnolia.cms.util.NodeDataUtil;
  
  import java.io.IOException;
  import java.io.Writer;
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.LinkedHashMap;
  import java.util.List;
  import java.util.Map;
  
  import javax.jcr.PathNotFoundException;
  import javax.jcr.PropertyType;
  import javax.jcr.RepositoryException;
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.commons.lang.exception.NestableRuntimeException;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  
  /**
   * A Magnolia dialog that renders by a freemarker template. There are two main properties for the dialog:<br/>
   * <table>
   * <tr>
   * <td>path (required)</td>
   * <td>Path to freemarker template: will be loaded from classpath or from filesystem</td>
   * </tr>
   * <tr>
   * <td>multiple</td>
   * <td>true / false. This property gives support to multiple field values storage.</td>
   * </tr>
   * </table>
   * The dialog passes some parameters to freemarker template:
   * <table>
   * <tr>
   * <td>name</td>
   * <td>Dialog / field name</td>
   * </tr>
   * <tr>
   * <td>value</td>
   * <td>Field value (multiple = false)</td>
   * </tr>
   * <tr>
   * <td>values</td>
   * <td>field values (multiple = true)</td>
   * </tr>
   * <tr>
   * <td>request</td>
   * <td>current HttpServletRequest</td>
   * </tr>
   * <tr>
   * <td>configuration</td>
   * <td>Map of dialog configuration. This allows to pass to template complex dialog configuration.<br/> Eg.
  *
  * <pre>
  * -+ Dialog node
  *  |-- property 1 = value 1
  *  |-+ subnode1
  *  | |-- property 11 = value 11
  *  | |-- property 12 = value 12
  *  | |-+ subnode 11
  *  |   |-- property 111 = value 111
  *  |
  *  |-- property 2 = value 2
  *
  * The map will contain:
  * configuration = Map {
  *    "property1" = "value1",
  *    "subnode1"  = Map {
  *        "property11" = "value11",
  *        "property12" = "value12",
  *        "subnode11"  =  Map {
  *            "property111" = "value111"
  *        }
  *    },
  *    "property2" = "value2"
  * }
  * </pre>
  * </td>
  * </tr>
  * </table>
  * @author Manuel Molaschi
  * @version $Id: $
  */
 
 public class DialogFreemarker extends DialogBox {
 
     /**
      * Logger.
      */
     private static Logger log = LoggerFactory.getLogger(DialogFreemarker.class);
 
     private Map configuration;
 
     private String path;
 
     /**
      * Sets the path.
      * @param path the path to set
      */
     public void setPath(String path) {
         this.path = path;
     }
 
     /**
      * Returns the configuration.
      * @return the configuration
      */
     public Map getConfiguration() {
         return configuration;
     }
 
     /**
      * Returns the path.
      * @return the path
      */
     public String getPath() {
         return path;
     }
 
     /**
      * {@inheritDoc}
      */
     protected List readValues() {
 
         List values = new ArrayList();
 
         if (this.getStorageNode() != null) {
             try {
                 // cycles on website content node to get multiple value
                 int size = this.getStorageNode().getContent(this.getName()).getNodeDataCollection().size();
                 for (int i = 0; i < size; i++) {
                     NodeData data = this.getStorageNode().getContent(this.getName()).getNodeData("" + i);
                     values.add(data.getString());
                 }
             }
             catch (PathNotFoundException e) {
                 // not yet existing: OK
             }
             catch (RepositoryException re) {
                 log.error("can't set values", re);
             }
         }
         return values;
     }
 
     /**
      * Get a recursive map view of a content node
      * @param node content node
      * @return recursive map view on content node properties and children
      * @throws PathNotFoundException
      * @throws RepositoryException
      * @throws AccessDeniedException
      */
     protected Map getSubNodes(Content node) throws RepositoryException, AccessDeniedException {
 
         Map values = new LinkedHashMap();
 
         // cycles on properties and stores them in map
         Collection properties = node.getNodeDataCollection();
 
         if (properties != null && properties.size() > 0) {
             Iterator propertiesIt = properties.iterator();
             while (propertiesIt.hasNext()) {
                 NodeData property = (NodeData) propertiesIt.next();
                 values.put(property.getName(), NodeDataUtil.getValueObject(property));
             }
         }
 
         // cycle on children
         Collection children = node.getChildren(ItemType.CONTENTNODE);
         if (children != null && children.size() > 0) {
             Iterator childrenIt = children.iterator();
             while (childrenIt.hasNext()) {
                 Content child = (Content) childrenIt.next();
 
                 // gets sub map
                 Map subValues = getSubNodes(child);
                 // stores it in map
                 values.put(child.getName(), subValues);
             }
         }
 
         return values;
     }
 
     /**
      * {@inheritDoc}
      */
 
     public void init(HttpServletRequest request, HttpServletResponse response, Content websiteNode, Content configNode)
         throws RepositoryException {
         super.init(request, response, websiteNode, configNode);
         configuration = this.getSubNodes(configNode);
     }
 
     /**
      * {@inheritDoc}
      */
     public void drawHtml(Writer out) throws IOException {
         String ftlPath = StringUtils.defaultIfEmpty(this.getConfigValue("path"), path);
         drawHtml(out, ftlPath);
     }
 
     /**
      * @param out Writer
      * @param freemarkerTemplate path for the freemarker template
      * @throws IOException
      */
     protected void drawHtml(Writer out, String freemarkerTemplate) throws IOException {
         Map parameters = new HashMap();
         parameters.put("name", this.getName());
         parameters.put("value", this.getValue());
         parameters.put("values", this.getValues());
         parameters.put("request", this.getRequest());
         parameters.put("configuration", this.configuration);
 
         this.drawHtmlPre(out);
 
         try {
             FreemarkerControl control = new FreemarkerControl("multiple".equals(this.getConfigValue("valueType"))
                 ? ControlImpl.VALUETYPE_MULTIPLE
                 : ControlImpl.VALUETYPE_SINGLE);
             control.setType(this.getConfigValue("type", PropertyType.TYPENAME_STRING));
             control.setName(this.getName());
             control.drawHtml(out, freemarkerTemplate, parameters);
         }
 
         catch (TemplateException ex) {
             log.error("Error processing dialog template:", ex);
             throw new NestableRuntimeException(ex);
         }
 
         this.drawHtmlPost(out);
     }
 
 }