/*

  * Licensed to the Apache Software Foundation (ASF) under one or more

  * contributor license agreements.  See the NOTICE file distributed with

  * this work for additional information regarding copyright ownership.

  * The ASF licenses this file to You under the Apache 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.apache.org/licenses/LICENSE-2.0

  *

  * 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.apache.commons.configuration.plist;

 import java.io.File;

 import java.io.PrintWriter;

 import java.io.Reader;

 import java.io.Writer;

 import java.net.URL;

 import java.util.ArrayList;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Map;

 import org.apache.commons.codec.binary.Hex;

 import org.apache.commons.configuration.AbstractHierarchicalFileConfiguration;

 import org.apache.commons.configuration.Configuration;

 import org.apache.commons.configuration.ConfigurationException;

 import org.apache.commons.configuration.HierarchicalConfiguration;

 import org.apache.commons.configuration.MapConfiguration;

 import org.apache.commons.lang.StringUtils;

 /**

  * NeXT / OpenStep style configuration.

  * (http://developer.apple.com/documentation/Cocoa/Conceptual/PropertyLists/Concepts/OldStylePListsConcept.html)

  *

  * <p>Example:</p>

  * <pre>

  * {

  *     foo = "bar";

  *

  *     array = ( value1, value2, value3 );

  *

  *     data = <4f3e0145ab>;

  *

  *     nested =

  *     {

  *         key1 = value1;

  *         key2 = value;

  *         nested =

  *         {

  *             foo = bar

  *         }

  *     }

  * }

  * </pre>

  *

  * @since 1.2

  *

  * @author Emmanuel Bourg

  * @version $Revision: 439648 $, $Date: 2006-09-02 22:42:10 +0200 (Sa, 02 Sep 2006) $

  */

 public class PropertyListConfiguration extends AbstractHierarchicalFileConfiguration

 {

     /**

      * The serial version UID.

      */

     private static final long serialVersionUID = 3227248503779092127L;

     /** Size of the indentation for the generated file. */

     private static final int INDENT_SIZE = 4;

     /**

      * Creates an empty PropertyListConfiguration object which can be

      * used to synthesize a new plist file by adding values and

      * then saving().

      */

     public PropertyListConfiguration()

     {

     }

     /**

      * Creates and loads the property list from the specified file.

      *

      * @param fileName The name of the plist file to load.

      * @throws ConfigurationException Error while loading the plist file

      */

     public PropertyListConfiguration(String fileName) throws ConfigurationException

     {

         super(fileName);

     }

     /**

      * Creates and loads the property list from the specified file.

      *

      * @param file The plist file to load.

      * @throws ConfigurationException Error while loading the plist file

      */

     public PropertyListConfiguration(File file) throws ConfigurationException

     {

         super(file);

     }

     /**

      * Creates and loads the property list from the specified URL.

      *

      * @param url The location of the plist file to load.

      * @throws ConfigurationException Error while loading the plist file

      */

     public PropertyListConfiguration(URL url) throws ConfigurationException

     {

         super(url);

     }

     public void load(Reader in) throws ConfigurationException

     {

         PropertyListParser parser = new PropertyListParser(in);

         try

         {

             HierarchicalConfiguration config = parser.parse();

             setRoot(config.getRoot());

         }

         catch (ParseException e)

         {

             throw new ConfigurationException(e);

         }

     }

     public void save(Writer out) throws ConfigurationException

     {

         PrintWriter writer = new PrintWriter(out);

         printNode(writer, 0, getRoot());

         writer.flush();

     }

     /**

      * Append a node to the writer, indented according to a specific level.

      */

     private void printNode(PrintWriter out, int indentLevel, Node node)

     {

         String padding = StringUtils.repeat(" ", indentLevel * INDENT_SIZE);

         if (node.getName() != null)

         {

             out.print(padding + quoteString(node.getName()) + " = ");

         }

         // get all non trivial nodes

         List children = new ArrayList(node.getChildren());

         Iterator it = children.iterator();

         while (it.hasNext())

         {

             Node child = (Node) it.next();

             if (child.getValue() == null && (child.getChildren() == null || child.getChildren().isEmpty()))

             {

                 it.remove();

             }

         }

         if (!children.isEmpty())

         {

             // skip a line, except for the root dictionary

             if (indentLevel > 0)

             {

                 out.println();

             }

             out.println(padding + "{");

             // display the children

             it = children.iterator();

             while (it.hasNext())

             {

                 Node child = (Node) it.next();

                 printNode(out, indentLevel + 1, child);

                 // add a semi colon for elements that are not dictionaries

                 Object value = child.getValue();

                 if (value != null && !(value instanceof Map) && !(value instanceof Configuration))

                 {

                     out.println(";");

                 }

                 // skip a line after arrays and dictionaries

                 if (it.hasNext() && (value == null || value instanceof List))

                 {

                     out.println();

                 }

             }

             out.print(padding + "}");

             // line feed if the dictionary is not in an array

             if (node.getParent() != null)

             {

                 out.println();

             }

         }

         else

         {

             // display the leaf value

             Object value = node.getValue();

             printValue(out, indentLevel, value);

         }

     }

     /**

      * Append a value to the writer, indented according to a specific level.

      */

     private void printValue(PrintWriter out, int indentLevel, Object value)

     {

         String padding = StringUtils.repeat(" ", indentLevel * INDENT_SIZE);

         if (value instanceof List)

         {

             out.print("( ");

             Iterator it = ((List) value).iterator();

             while (it.hasNext())

             {

                 printValue(out, indentLevel + 1, it.next());

                 if (it.hasNext())

                 {

                     out.print(", ");

                 }

             }

             out.print(" )");

         }

         else if (value instanceof HierarchicalConfiguration)

         {

             printNode(out, indentLevel, ((HierarchicalConfiguration) value).getRoot());

         }

         else if (value instanceof Configuration)

         {

             // display a flat Configuration as a dictionary

             out.println();

             out.println(padding + "{");

             Configuration config = (Configuration) value;

             Iterator it = config.getKeys();

             while (it.hasNext())

             {

                 String key = (String) it.next();

                 Node node = new Node(key);

                 node.setValue(config.getProperty(key));

                 printNode(out, indentLevel + 1, node);

                 out.println(";");

             }

             out.println(padding + "}");

         }

         else if (value instanceof Map)

         {

             // display a Map as a dictionary

             Map map = (Map) value;

             printValue(out, indentLevel, new MapConfiguration(map));

         }

         else if (value instanceof byte[])

         {

             out.print("<" + new String(Hex.encodeHex((byte[]) value)) + ">");

         }

         else if (value != null)

         {

             out.print(quoteString(String.valueOf(value)));

         }

     }

     /**

      * Quote the specified string if necessary, that's if the string contains:

      * <ul>

      *   <li>a space character (' ', '\t', '\r', '\n')</li>

      *   <li>a quote '"'</li>

      *   <li>special characters in plist files ('(', ')', '{', '}', '=', ';', ',')</li>

      * </ul>

      * Quotes within the string are escaped.

      *

      * <p>Examples:</p>

      * <ul>

      *   <li>abcd -> abcd</li>

      *   <li>ab cd -> "ab cd"</li>

      *   <li>foo"bar -> "foo\"bar"</li>

      *   <li>foo;bar -> "foo;bar"</li>

      * </ul>

      */

     String quoteString(String s)

     {

         if (s == null)

         {

             return null;

         }

         if (s.indexOf(' ') != -1

                 || s.indexOf('\t') != -1

                 || s.indexOf('\r') != -1

                 || s.indexOf('\n') != -1

                 || s.indexOf('"') != -1

                 || s.indexOf('(') != -1

                 || s.indexOf(')') != -1

                 || s.indexOf('{') != -1

                 || s.indexOf('}') != -1

                 || s.indexOf('=') != -1

                 || s.indexOf(',') != -1

                 || s.indexOf(';') != -1)

         {

             s = StringUtils.replace(s, "\"", "\\\"");

             s = "\"" + s + "\"";

         }

         return s;

     }

 }