server: String -> Stream
[nikiroo-utils.git] / src / be / nikiroo / utils / serial / SerialUtils.java
index 706d579970f9456fd430d4ae2020185aa8c7ed24..a6a02a8e06205cb5996b0a94c1124056ce2cbf60 100644 (file)
@@ -1,7 +1,11 @@
 package be.nikiroo.utils.serial;
 
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
+import java.io.InputStream;
 import java.io.NotSerializableException;
+import java.io.OutputStream;
+import java.io.UnsupportedEncodingException;
 import java.lang.reflect.Array;
 import java.lang.reflect.Constructor;
 import java.lang.reflect.Field;
@@ -13,7 +17,11 @@ import java.util.List;
 import java.util.Map;
 import java.util.UnknownFormatConversionException;
 
+import be.nikiroo.utils.IOUtils;
 import be.nikiroo.utils.Image;
+import be.nikiroo.utils.StringUtils;
+import be.nikiroo.utils.streams.NextableInputStream;
+import be.nikiroo.utils.streams.NextableInputStreamStep;
 
 /**
  * Small class to help with serialisation.
@@ -53,50 +61,58 @@ public class SerialUtils {
                // Array types:
                customTypes.put("[]", new CustomSerializer() {
                        @Override
-                       protected String toString(Object value) {
+                       protected void toStream(OutputStream out, Object value)
+                                       throws IOException {
+
+                               // TODO: we use \n to separate, and b64 to un-\n
+                               // -- but we could use \\n ?
                                String type = value.getClass().getCanonicalName();
                                type = type.substring(0, type.length() - 2); // remove the []
 
-                               StringBuilder builder = new StringBuilder();
-                               builder.append(type).append("\n");
+                               write(out, type);
                                try {
                                        for (int i = 0; true; i++) {
                                                Object item = Array.get(value, i);
+
                                                // encode it normally if direct value
-                                               if (!SerialUtils.encode(builder, item)) {
+                                               write(out, "\r");
+                                               if (!SerialUtils.encode(out, item)) {
                                                        try {
-                                                               // use ZIP: if not
-                                                               new Exporter().append(item).appendTo(builder,
-                                                                               true, false);
+                                                               // TODO: bad escaping?
+                                                               write(out, "B64:");
+                                                               OutputStream bout = StringUtils.base64(out,
+                                                                               false, false);
+                                                               new Exporter(bout).append(item);
                                                        } catch (NotSerializableException e) {
                                                                throw new UnknownFormatConversionException(e
                                                                                .getMessage());
                                                        }
                                                }
-                                               builder.append("\n");
                                        }
                                } catch (ArrayIndexOutOfBoundsException e) {
                                        // Done.
                                }
-
-                               return builder.toString();
                        }
 
                        @Override
-                       protected String getType() {
-                               return "[]";
-                       }
-
-                       @Override
-                       protected Object fromString(String content) throws IOException {
-                               String[] tab = content.split("\n");
+                       protected Object fromStream(InputStream in) throws IOException {
+                               NextableInputStream stream = new NextableInputStream(in,
+                                               new NextableInputStreamStep('\r'));
 
                                try {
+                                       List<Object> list = new ArrayList<Object>();
+                                       stream.next();
+                                       String type = IOUtils.readSmallStream(stream);
+
+                                       while (stream.next()) {
+                                               Object value = new Importer().read(stream).getValue();
+                                               list.add(value);
+                                       }
+
                                        Object array = Array.newInstance(
-                                                       SerialUtils.getClass(tab[0]), tab.length - 1);
-                                       for (int i = 1; i < tab.length; i++) {
-                                               Object value = new Importer().read(tab[i]).getValue();
-                                               Array.set(array, i - 1, value);
+                                                       SerialUtils.getClass(type), list.size());
+                                       for (int i = 0; i < list.size(); i++) {
+                                               Array.set(array, i, list.get(i));
                                        }
 
                                        return array;
@@ -107,23 +123,33 @@ public class SerialUtils {
                                        throw new IOException(e.getMessage());
                                }
                        }
+
+                       @Override
+                       protected String getType() {
+                               return "[]";
+                       }
                });
 
                // URL:
                customTypes.put("java.net.URL", new CustomSerializer() {
                        @Override
-                       protected String toString(Object value) {
+                       protected void toStream(OutputStream out, Object value)
+                                       throws IOException {
+                               String val = "";
                                if (value != null) {
-                                       return ((URL) value).toString();
+                                       val = ((URL) value).toString();
                                }
-                               return null;
+
+                               out.write(val.getBytes("UTF-8"));
                        }
 
                        @Override
-                       protected Object fromString(String content) throws IOException {
-                               if (content != null) {
-                                       return new URL(content);
+                       protected Object fromStream(InputStream in) throws IOException {
+                               String val = IOUtils.readSmallStream(in);
+                               if (!val.isEmpty()) {
+                                       return new URL(val);
                                }
+
                                return null;
                        }
 
@@ -136,8 +162,21 @@ public class SerialUtils {
                // Images (this is currently the only supported image type by default)
                customTypes.put("be.nikiroo.utils.Image", new CustomSerializer() {
                        @Override
-                       protected String toString(Object value) {
-                               return ((Image) value).toBase64();
+                       protected void toStream(OutputStream out, Object value)
+                                       throws IOException {
+                               Image img = (Image) value;
+                               OutputStream encoded = StringUtils.base64(out, false, false);
+                               try {
+                                       InputStream in = img.newInputStream();
+                                       try {
+                                               IOUtils.write(in, encoded);
+                                       } finally {
+                                               in.close();
+                                       }
+                               } finally {
+                                       encoded.flush();
+                                       // Cannot close!
+                               }
                        }
 
                        @Override
@@ -146,9 +185,11 @@ public class SerialUtils {
                        }
 
                        @Override
-                       protected Object fromString(String content) {
+                       protected Object fromStream(InputStream in) throws IOException {
                                try {
-                                       return new Image(content);
+                                       // Cannot close it!
+                                       InputStream decoded = StringUtils.unbase64(in, false);
+                                       return new Image(decoded);
                                } catch (IOException e) {
                                        throw new UnknownFormatConversionException(e.getMessage());
                                }
@@ -212,7 +253,7 @@ public class SerialUtils {
                                        ctor = clazz.getDeclaredConstructor(classes
                                                        .toArray(new Class[] {}));
                                } catch (NoSuchMethodException nsme) {
-                                       // TODO: it seems e do not always need a parameter for each
+                                       // TODO: it seems we do not always need a parameter for each
                                        // level, so we currently try "ALL" levels or "FIRST" level
                                        // only -> we should check the actual rule and use it
                                        ctor = clazz.getDeclaredConstructor(classes.get(0));
@@ -252,14 +293,14 @@ public class SerialUtils {
        }
 
        /**
-        * Serialise the given object into this {@link StringBuilder}.
+        * Serialise the given object into this {@link OutputStream}.
         * <p>
         * <b>Important: </b>If the operation fails (with a
         * {@link NotSerializableException}), the {@link StringBuilder} will be
         * corrupted (will contain bad, most probably not importable data).
         * 
-        * @param builder
-        *            the output {@link StringBuilder} to serialise to
+        * @param out
+        *            the output {@link OutputStream} to serialise to
         * @param o
         *            the object to serialise
         * @param map
@@ -271,9 +312,11 @@ public class SerialUtils {
         *             if the object cannot be serialised (in this case, the
         *             {@link StringBuilder} can contain bad, most probably not
         *             importable data)
+        * @throws IOException
+        *             in case of I/O errors
         */
-       static void append(StringBuilder builder, Object o, Map<Integer, Object> map)
-                       throws NotSerializableException {
+       static void append(OutputStream out, Object o, Map<Integer, Object> map)
+                       throws NotSerializableException, IOException {
 
                Field[] fields = new Field[] {};
                String type = "";
@@ -295,9 +338,13 @@ public class SerialUtils {
                        }
                }
 
-               builder.append("{\nREF ").append(type).append("@").append(id)
-                               .append(":");
-               if (!encode(builder, o)) { // check if direct value
+               write(out, "{\nREF ");
+               write(out, type);
+               write(out, "@");
+               write(out, id);
+               write(out, ":");
+
+               if (!encode(out, o)) { // check if direct value
                        try {
                                for (Field field : fields) {
                                        field.setAccessible(true);
@@ -311,16 +358,15 @@ public class SerialUtils {
                                                continue;
                                        }
 
-                                       builder.append("\n");
-                                       builder.append(field.getName());
-                                       builder.append(":");
-                                       Object value;
+                                       write(out, "\n");
+                                       write(out, field.getName());
+                                       write(out, ":");
 
-                                       value = field.get(o);
+                                       Object value = field.get(o);
 
-                                       if (!encode(builder, value)) {
-                                               builder.append("\n");
-                                               append(builder, value, map);
+                                       if (!encode(out, value)) {
+                                               write(out, "\n");
+                                               append(out, value, map);
                                        }
                                }
                        } catch (IllegalArgumentException e) {
@@ -330,12 +376,14 @@ public class SerialUtils {
                                e.printStackTrace(); // should not happen (see
                                                                                // setAccessible)
                        }
+
+                       write(out, "\n}");
                }
-               builder.append("\n}");
        }
 
        /**
-        * Encode the object into the given builder if possible and if supported.
+        * Encode the object into the given {@link OutputStream} if possible and if
+        * supported.
         * <p>
         * A supported object in this context means an object we can directly
         * encode, like an Integer or a String. Custom objects and arrays are also
@@ -343,47 +391,57 @@ public class SerialUtils {
         * <p>
         * For compound objects, you should use {@link Exporter}.
         * 
-        * @param builder
-        *            the builder to append to
+        * @param out
+        *            the {@link OutputStream} to append to
         * @param value
         *            the object to encode (can be NULL, which will be encoded)
         * 
-        * @return TRUE if success, FALSE if not (the content of the builder won't
-        *         be changed in case of failure)
+        * @return TRUE if success, FALSE if not (the content of the
+        *         {@link OutputStream} won't be changed in case of failure)
+        * 
+        * @throws IOException
+        *             in case of I/O error
         */
-       static boolean encode(StringBuilder builder, Object value) {
+       static boolean encode(OutputStream out, Object value) throws IOException {
                if (value == null) {
-                       builder.append("NULL");
+                       write(out, "NULL");
                } else if (value.getClass().getSimpleName().endsWith("[]")) {
                        // Simple name does support [] suffix and do not return NULL for
                        // inner anonymous classes
-                       return customTypes.get("[]").encode(builder, value);
+                       customTypes.get("[]").encode(out, value);
                } else if (customTypes.containsKey(value.getClass().getCanonicalName())) {
-                       return customTypes.get(value.getClass().getCanonicalName())//
-                                       .encode(builder, value);
+                       customTypes.get(value.getClass().getCanonicalName())//
+                                       .encode(out, value);
                } else if (value instanceof String) {
-                       encodeString(builder, (String) value);
+                       encodeString(out, (String) value);
                } else if (value instanceof Boolean) {
-                       builder.append(value);
+                       write(out, value);
                } else if (value instanceof Byte) {
-                       builder.append(value).append('b');
+                       write(out, value);
+                       write(out, "b");
                } else if (value instanceof Character) {
-                       encodeString(builder, "" + value);
-                       builder.append('c');
+                       encodeString(out, "" + value);
+                       write(out, "c");
                } else if (value instanceof Short) {
-                       builder.append(value).append('s');
+                       write(out, value);
+                       write(out, "s");
                } else if (value instanceof Integer) {
-                       builder.append(value);
+                       write(out, value);
                } else if (value instanceof Long) {
-                       builder.append(value).append('L');
+                       write(out, value);
+                       write(out, "L");
                } else if (value instanceof Float) {
-                       builder.append(value).append('F');
+                       write(out, value);
+                       write(out, "F");
                } else if (value instanceof Double) {
-                       builder.append(value).append('d');
+                       write(out, value);
+                       write(out, "d");
                } else if (value instanceof Enum) {
                        String type = value.getClass().getCanonicalName();
-                       builder.append(type).append(".").append(((Enum<?>) value).name())
-                                       .append(";");
+                       write(out, type);
+                       write(out, ".");
+                       write(out, ((Enum<?>) value).name());
+                       write(out, ";");
                } else {
                        return false;
                }
@@ -419,7 +477,14 @@ public class SerialUtils {
                                // custom:TYPE_NAME:"content is String-encoded"
                                String type = CustomSerializer.typeOf(encodedValue);
                                if (customTypes.containsKey(type)) {
-                                       return customTypes.get(type).decode(encodedValue);
+                                       // TODO: we should start with a stream
+                                       InputStream streamEncodedValue = new ByteArrayInputStream(
+                                                       encodedValue.getBytes("UTF-8"));
+                                       try {
+                                               return customTypes.get(type).decode(streamEncodedValue);
+                                       } finally {
+                                               streamEncodedValue.close();
+                                       }
                                }
                                throw new IOException("Unknown custom type: " + type);
                        } else if (encodedValue.equals("NULL")
@@ -452,7 +517,28 @@ public class SerialUtils {
                        if (e instanceof IOException) {
                                throw (IOException) e;
                        }
-                       throw new IOException(e.getMessage());
+                       throw new IOException(e.getMessage(), e);
+               }
+       }
+
+       /**
+        * Write the given {@link String} into the given {@link OutputStream} in
+        * UTF-8.
+        * 
+        * @param out
+        *            the {@link OutputStream}
+        * @param data
+        *            the data to write, cannot be NULL
+        * 
+        * @throws IOException
+        *             in case of I/O error
+        */
+       static void write(OutputStream out, Object data) throws IOException {
+               try {
+                       out.write(data.toString().getBytes("UTF-8"));
+               } catch (UnsupportedEncodingException e) {
+                       // A conforming JVM is required to support UTF-8
+                       e.printStackTrace();
                }
        }
 
@@ -507,7 +593,7 @@ public class SerialUtils {
        }
 
        @SuppressWarnings({ "unchecked", "rawtypes" })
-       private static Enum<?> decodeEnum(String escaped) {
+       static private Enum<?> decodeEnum(String escaped) {
                // escaped: be.xxx.EnumType.VALUE;
                int pos = escaped.lastIndexOf(".");
                String type = escaped.substring(0, pos);
@@ -522,32 +608,57 @@ public class SerialUtils {
        }
 
        // aa bb -> "aa\tbb"
-       private static void encodeString(StringBuilder builder, String raw) {
-               builder.append('\"');
+       static void encodeString(OutputStream out, String raw) throws IOException {
+               // TODO: not. efficient.
+               out.write('\"');
+               // TODO !! utf-8 required
                for (char car : raw.toCharArray()) {
-                       switch (car) {
-                       case '\\':
-                               builder.append("\\\\");
-                               break;
-                       case '\r':
-                               builder.append("\\r");
-                               break;
-                       case '\n':
-                               builder.append("\\n");
-                               break;
-                       case '"':
-                               builder.append("\\\"");
-                               break;
-                       default:
-                               builder.append(car);
-                               break;
+                       encodeString(out, car);
+               }
+               out.write('\"');
+       }
+
+       // aa bb -> "aa\tbb"
+       static void encodeString(OutputStream out, InputStream raw)
+                       throws IOException {
+               out.write('\"');
+               byte buffer[] = new byte[4096];
+               for (int len = 0; (len = raw.read(buffer)) > 0;) {
+                       for (int i = 0; i < len; i++) {
+                               // TODO: not 100% correct, look up howto for UTF-8
+                               encodeString(out, (char) buffer[i]);
                        }
                }
-               builder.append('\"');
+               out.write('\"');
+       }
+
+       // for encode string, NOT to encode a char by itself!
+       static void encodeString(OutputStream out, char raw) throws IOException {
+               switch (raw) {
+               case '\\':
+                       out.write('\\');
+                       out.write('\\');
+                       break;
+               case '\r':
+                       out.write('\\');
+                       out.write('r');
+                       break;
+               case '\n':
+                       out.write('\\');
+                       out.write('n');
+                       break;
+               case '"':
+                       out.write('\\');
+                       out.write('\"');
+                       break;
+               default:
+                       out.write(raw);
+                       break;
+               }
        }
 
        // "aa\tbb" -> aa bb
-       private static String decodeString(String escaped) {
+       static String decodeString(String escaped) {
                StringBuilder builder = new StringBuilder();
 
                boolean escaping = false;