Merging DEV_TEMPORARY to HEAD (RenditionService)

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@19103 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/util/FreeMarkerUtil.java

@@ -0,0 +1,66 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+package org.alfresco.util;
+
+import java.io.*;
+import java.util.LinkedList;
+import javax.xml.XMLConstants;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.w3c.dom.Document;
+import org.w3c.dom.Element;
+import org.w3c.dom.Node;
+import org.w3c.dom.NamedNodeMap;
+import org.xml.sax.SAXException;
+
+/**
+ * FreeMarker utility functions.
+ * 
+ * @author Ariel Backenroth
+ */
+public class FreeMarkerUtil
+{
+   public static String buildNamespaceDeclaration(final Document xml)
+   {
+      final Element docEl = xml.getDocumentElement();
+      final NamedNodeMap attributes = docEl.getAttributes();
+      final StringBuilder result = new StringBuilder();
+      for (int i = 0; i < attributes.getLength(); i++)
+      {
+         final Node a = attributes.item(i);
+         if (a.getNodeName().startsWith(XMLConstants.XMLNS_ATTRIBUTE))
+         {
+            final String prefix = a.getNodeName().substring((XMLConstants.XMLNS_ATTRIBUTE + ":").length());
+            final String uri = a.getNodeValue();
+            if (result.length() != 0)
+            {
+               result.append(",\n");
+            }
+            result.append("\"").append(prefix).append("\":\"").append(uri).append("\"");
+         }
+      }
+      return "<#ftl ns_prefixes={\n" + result.toString() + "}>\n";
+   }
+}

source/java/org/alfresco/util/XMLUtil.java

@@ -0,0 +1,281 @@
+/*
+ * Copyright (C) 2005-2008 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * As a special exception to the terms and conditions of version 2.0 of
+ * the GPL, you may redistribute this Program in connection with Free/Libre
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's
+ * FLOSS exception.  You should have recieved a copy of the text describing
+ * the FLOSS exception, and it is also available here:
+ * http://www.alfresco.com/legal/licensing" */
+package org.alfresco.util;
+
+import java.io.*;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.parsers.ParserConfigurationException;
+import javax.xml.transform.OutputKeys;
+import javax.xml.transform.Transformer;
+import javax.xml.transform.TransformerException;
+import javax.xml.transform.TransformerFactory;
+import javax.xml.transform.dom.DOMSource;
+import javax.xml.transform.stream.StreamResult;
+import org.alfresco.model.ContentModel;
+import org.alfresco.service.cmr.avm.AVMService;
+import org.alfresco.service.cmr.repository.ContentReader;
+import org.alfresco.service.cmr.repository.ContentService;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.w3c.dom.*;
+import org.xml.sax.SAXException;
+
+/**
+ * XML utility functions.
+ * 
+ * @author Ariel Backenroth
+ */
+public class XMLUtil
+{   
+   private static final Log LOGGER = LogFactory.getLog(XMLUtil.class);
+
+   /** utility function for creating a document */
+   public static Document newDocument()
+   {
+      return XMLUtil.getDocumentBuilder().newDocument();
+   }
+
+   /** utility function for serializing a node */
+   public static void print(final Node n, final Writer output)
+   {
+      XMLUtil.print(n, output, true);
+   }
+   
+   /** utility function for serializing a node */
+   public static void print(final Node n, final Writer output, final boolean indent)
+   {
+      try 
+      {
+         final TransformerFactory tf = TransformerFactory.newInstance();
+         final Transformer t = tf.newTransformer();
+         t.setOutputProperty(OutputKeys.INDENT, indent ? "yes" : "no");
+         t.setOutputProperty(OutputKeys.ENCODING, "UTF-8");
+         t.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");
+         t.setOutputProperty(OutputKeys.METHOD, "xml");
+         if (LOGGER.isDebugEnabled())
+         {
+            LOGGER.debug("writing out a document for " + 
+      			 (n instanceof Document
+      			  ? ((Document)n).getDocumentElement()
+      			  : n).getNodeName() + 
+   			     " to " + (output instanceof StringWriter
+                                       ? "string"
+                                       : output));
+         }
+         t.transform(new DOMSource(n), new StreamResult(output));
+      }
+      catch (TransformerException te)
+      {
+         te.printStackTrace();
+         assert false : te.getMessage();
+      }
+   }
+
+   /** utility function for serializing a node */
+   public static void print(final Node n, final File output)
+      throws IOException
+   {
+      XMLUtil.print(n, new FileWriter(output));
+   }
+   
+   /** utility function for serializing a node */
+   public static String toString(final Node n)
+   {
+      return XMLUtil.toString(n, true);
+   }
+
+   /** utility function for serializing a node */
+   public static String toString(final Node n, final boolean indent)
+   {
+      final StringWriter result = new StringWriter();
+      XMLUtil.print(n, result, indent);
+      return result.toString();
+   }
+   
+   /** utility function for parsing xml */
+   public static Document parse(final String source)
+      throws SAXException,
+      IOException
+   {
+      return XMLUtil.parse(new ByteArrayInputStream(source.getBytes("UTF-8")));
+   }
+   
+   /** utility function for parsing xml */
+   public static Document parse(final NodeRef nodeRef,
+                                final ContentService contentService)
+      throws SAXException,
+      IOException
+   {
+      final ContentReader contentReader = 
+         contentService.getReader(nodeRef, ContentModel.TYPE_CONTENT);
+      final InputStream in = contentReader.getContentInputStream();
+      return XMLUtil.parse(in);
+   }
+
+   /** utility function for parsing xml */
+   public static Document parse(final int version, 
+                                final String path,
+                                final AVMService avmService)
+      throws SAXException,
+      IOException
+   {
+      return XMLUtil.parse(avmService.getFileInputStream(version, path));
+   }
+   
+   /** utility function for parsing xml */
+   public static Document parse(final File source)
+      throws SAXException,
+      IOException
+   {
+      return XMLUtil.parse(new FileInputStream(source));
+   }
+   
+   /** utility function for parsing xml */
+   public static Document parse(final InputStream source)
+      throws SAXException,
+      IOException
+   {
+      try
+      {
+         final DocumentBuilder db = XMLUtil.getDocumentBuilder();
+         return db.parse(source);
+      }
+      finally
+      {
+         source.close();
+      }
+   }
+
+   /** provides a document builder that is namespace aware but not validating by default */
+   public static DocumentBuilder getDocumentBuilder()
+   {
+      return XMLUtil.getDocumentBuilder(true, false);
+   }
+
+   /**
+    * FOR DIAGNOSTIC PURPOSES ONLY - incomplete<br/>
+    * Builds a path to the node relative to the to node provided.
+    * @param from the node from which to build the xpath
+    * @param to an ancestor of <tt>from</tt> which will be the root of the path
+    * @return an xpath to <tt>to</tt> rooted at <tt>from</tt>.
+    */
+   public static String buildXPath(final Node from, final Element to)
+   {
+      String result = "";
+      Node tmp = from;
+      do
+      {
+         if (tmp instanceof Attr)
+         {
+            assert result.length() == 0;
+            result = "@" + tmp.getNodeName();
+         }
+         else if (tmp instanceof Element)
+         {
+            Node tmp2 = tmp;
+            int position = 1;
+            while (tmp2.getPreviousSibling() != null)
+            {
+               if (tmp2.getNodeName().equals(tmp.getNodeName()))
+               {
+                  position++;
+               }
+               tmp2 = tmp2.getPreviousSibling();
+            }
+            String part = tmp.getNodeName() + "[" + position + "]";
+            result = "/" + part + result;
+         }
+         else if (tmp instanceof Text)
+         {
+            assert result.length() == 0;
+            result = "/text()";
+         }
+         else
+         {
+            if (LOGGER.isDebugEnabled())
+            {
+               throw new IllegalArgumentException("unsupported node type " + tmp);
+            }
+         }
+         tmp = tmp.getParentNode();
+      }
+      while (tmp != to.getParentNode() && tmp != null);
+      return result;
+   }
+
+   public static DocumentBuilder getDocumentBuilder(final boolean namespaceAware,
+                                                    final boolean validating)
+   { 
+      try
+      {
+         final DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+         dbf.setNamespaceAware(namespaceAware);
+         dbf.setValidating(validating);
+         return dbf.newDocumentBuilder();
+      }
+      catch (ParserConfigurationException pce)
+      {
+         LOGGER.error(pce);
+         return null;
+      }
+   }
+
+   /**
+    * Provides a NodeList of multiple nodelists
+    */
+   public static NodeList combine(final NodeList... nls)
+   {
+
+      return new NodeList()
+      {
+         public Node item(final int index)
+         {
+            int offset = 0;
+            for (int i = 0; i < nls.length; i++)
+            {
+               if (index - offset < nls[i].getLength())
+               {
+                  return nls[i].item(index - offset);
+               }
+               else
+               {
+                  offset += nls[i].getLength();
+               }
+            }
+            return null;
+         }
+
+         public int getLength()
+         {
+            int result = 0;
+            for (int i = 0; i < nls.length; i++)
+            {
+               result += nls[i].getLength();
+            }
+            return result;
+         }
+      };
+   }
+}

source/java/org/alfresco/util/json/AbstractJsonSerializerBean.java

@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+
+package org.alfresco.util.json;
+
+/**
+ * @author Nick Smith
+ */
+public abstract class AbstractJsonSerializerBean<T, S> implements JsonSerializer<T, S>
+{
+    private Class<? extends T> classToSerialize;
+    private AlfrescoJsonSerializer jsonSerializer;
+
+    /**
+     * @param classToSerialize the classToSerialize to set
+     */
+    public void setClassToSerialize(Class<? extends T> classToSerialize)
+    {
+        this.classToSerialize = classToSerialize;
+    }
+
+    /**
+     * @param jsonSerializer the jsonSerializer to set
+     */
+    public void setJsonSerializer(AlfrescoJsonSerializer jsonSerializer)
+    {
+        this.jsonSerializer = jsonSerializer;
+    }
+
+    public void init()
+    {
+        jsonSerializer.register(classToSerialize, this);
+    }
+
+}

source/java/org/alfresco/util/json/AlfrescoJsonSerializer.java

@@ -0,0 +1,117 @@
+/*
+ * Copyright (C) 2005-20010 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+
+package org.alfresco.util.json;
+
+import java.util.Collection;
+import java.util.Date;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Map.Entry;
+
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.namespace.NamespaceService;
+import org.alfresco.service.namespace.QName;
+import org.apache.chemistry.tck.atompub.utils.ISO8601DateFormat;
+import org.json.JSONArray;
+import org.json.JSONException;
+import org.json.JSONObject;
+
+/**
+ * @author Nick Smith
+ */
+public class AlfrescoJsonSerializer
+{
+    private final NamespaceService namespaceService;
+    private final Map<Class<?>, JsonSerializer<?, ?>> serializers = new HashMap<Class<?>, JsonSerializer<?, ?>>();
+
+    public AlfrescoJsonSerializer(NamespaceService namespaceService)
+    {
+        this.namespaceService = namespaceService;
+    }
+
+    public void register(Class<?> clazz, JsonSerializer<?, ?> serializer)
+    {
+        serializers.put(clazz, serializer);
+    }
+
+    public Object getJsonValue(Object value) throws JSONException
+    {
+        if (value instanceof Date) { return getJsonDate((Date) value); }
+        if (value instanceof QName) { return getJsonQName((QName) value); }
+        if (value instanceof NodeRef)
+        {
+            return value.toString();
+        }
+        else if (value instanceof Collection<?>)
+        {
+            return getJsonArray((Collection<?>) value);
+        }
+        else if (value instanceof Map<?, ?>) { return getJsonObject((Map<?, ?>) value); }
+        return value;
+    }
+
+    private JSONObject getJsonObject(Map<?, ?> map) throws JSONException
+    {
+        JSONObject object = new JSONObject();
+        for (Entry<?, ?> entry : map.entrySet())
+        {
+            String key = getJsonKey(entry.getKey());
+            Object value = getJsonValue(entry.getValue());
+            object.put(key, value);
+        }
+        return object;
+    }
+
+    private String getJsonKey(Object key)
+    {
+        if (key instanceof QName) { return getJsonQName((QName) key); }
+        return key.toString();
+    }
+
+    private String getJsonQName(QName name)
+    {
+        String nameString = name.toPrefixString(namespaceService);
+        return nameString.replaceFirst(":", "_");
+    }
+
+    private JSONObject getJsonDate(Date date) throws JSONException
+    {
+        JSONObject isoDate = new JSONObject();
+        isoDate.put("iso8601", ISO8601DateFormat.format(date));
+        return isoDate;
+    }
+
+    private JSONArray getJsonArray(Collection<?> values) throws JSONException
+    {
+        JSONArray array = new JSONArray();
+        for (Object val : values)
+        {
+            array.put(getJsonValue(val));
+        }
+        return array;
+    }
+
+}

source/java/org/alfresco/util/json/DefaultJsonSerializer.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+
+package org.alfresco.util.json;
+
+/**
+ *
+ * @author Nick Smith
+ */
+public class DefaultJsonSerializer implements JsonSerializer<Object, Object>
+{
+
+    /*
+     * @see org.alfresco.util.json.JsonSerializer#deserialize(java.lang.Object)
+     */
+    public Object deserialize(Object object)
+    {
+        return object;
+    }
+
+    /*
+     * @see org.alfresco.util.json.JsonSerializer#serialize(java.lang.Object)
+     */
+    public Object serialize(Object object)
+    {
+        return object;
+    }
+
+}

source/java/org/alfresco/util/json/JsonSerializer.java

@@ -0,0 +1,40 @@
+/*
+ * Copyright (C) 2005-2010 Alfresco Software Limited.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+
+ * This program 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 General Public License for more details.
+
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+
+ * As a special exception to the terms and conditions of version 2.0 of 
+ * the GPL, you may redistribute this Program in connection with Free/Libre 
+ * and Open Source Software ("FLOSS") applications as described in Alfresco's 
+ * FLOSS exception.  You should have recieved a copy of the text describing 
+ * the FLOSS exception, and it is also available here: 
+ * http://www.alfresco.com/legal/licensing"
+ */
+
+package org.alfresco.util.json;
+
+/**
+ * An interface for converting objects of a specified type (T) into a serialized
+ * Json format (of type S).
+ * 
+ * @author Nick Smith
+ */
+public interface JsonSerializer<T, S>
+{
+
+    S serialize(T object);
+
+    T deserialize(S object);
+}