Add 'src/be/nikiroo/utils/' from commit '46add0670fdee4bd936a13fe2448c5e20a7ffd0a'
[nikiroo-utils.git] / src / be / nikiroo / utils / serial / Importer.java
index b3307fdc7220c4fa757b04e9038e720106ddc8a4..81814dfdbadf6a71ec2224d14be5926314bbd105 100644 (file)
@@ -1,14 +1,17 @@
 package be.nikiroo.utils.serial;
 
-import java.lang.reflect.Constructor;
+import java.io.IOException;
+import java.io.InputStream;
 import java.lang.reflect.Field;
-import java.lang.reflect.InvocationTargetException;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.Scanner;
+import java.util.zip.GZIPInputStream;
 
 import be.nikiroo.utils.IOUtils;
-import be.nikiroo.utils.StringUtils;
+import be.nikiroo.utils.streams.Base64InputStream;
+import be.nikiroo.utils.streams.BufferedInputStream;
+import be.nikiroo.utils.streams.NextableInputStream;
+import be.nikiroo.utils.streams.NextableInputStreamStep;
 
 /**
  * A simple class that can accept the output of {@link Exporter} to recreate
@@ -28,6 +31,9 @@ public class Importer {
 
        private String currentFieldName;
 
+       /**
+        * Create a new {@link Importer}.
+        */
        public Importer() {
                map = new HashMap<String, Object>();
                map.put("NULL", null);
@@ -37,38 +43,107 @@ public class Importer {
                this.map = map;
        }
 
-       public Importer readLine(String line) {
-               try {
-                       processLine(line);
-               } catch (Exception e) {
-                       throw new IllegalArgumentException(e);
-               }
-               return this;
-       }
+       /**
+        * Read some data into this {@link Importer}: it can be the full serialised
+        * content, or a number of lines of it (any given line <b>MUST</b> be
+        * complete though) and accumulate it with the already present data.
+        * 
+        * @param in
+        *            the data to parse
+        * 
+        * @return itself so it can be chained
+        * 
+        * @throws NoSuchFieldException
+        *             if the serialised data contains information about a field
+        *             which does actually not exist in the class we know of
+        * @throws NoSuchMethodException
+        *             if a class described in the serialised data cannot be created
+        *             because it is not compatible with this code
+        * @throws ClassNotFoundException
+        *             if a class described in the serialised data cannot be found
+        * @throws IOException
+        *             if the content cannot be read (for instance, corrupt data)
+        * @throws NullPointerException
+        *             if the stream is empty
+        */
+       public Importer read(InputStream in) throws NoSuchFieldException,
+                       NoSuchMethodException, ClassNotFoundException, IOException,
+                       NullPointerException {
+
+               NextableInputStream stream = new NextableInputStream(in,
+                               new NextableInputStreamStep('\n'));
 
-       public Importer read(String data) {
                try {
-                       if (data.startsWith("ZIP:")) {
-                               data = StringUtils.unzip64(data.substring("ZIP:".length()));
+                       if (in == null) {
+                               throw new NullPointerException("InputStream is null");
                        }
-                       Scanner scan = new Scanner(data);
-                       scan.useDelimiter("\n");
-                       while (scan.hasNext()) {
-                               processLine(scan.next());
+
+                       boolean first = true;
+                       while (stream.next()) {
+                               if (stream.eof()) {
+                                       if (first) {
+                                               throw new NullPointerException(
+                                                               "InputStream empty, normal termination");
+                                       }
+                                       return this;
+                               }
+                               first = false;
+
+                               boolean zip = stream.startsWith("ZIP:");
+                               boolean b64 = stream.startsWith("B64:");
+
+                               if (zip || b64) {
+                                       stream.skip("XXX:".length());
+
+                                       InputStream decoded = stream.open();
+                                       if (zip) {
+                                               decoded = new GZIPInputStream(decoded);
+                                       }
+                                       decoded = new Base64InputStream(decoded, false);
+
+                                       try {
+                                               read(decoded);
+                                       } finally {
+                                               decoded.close();
+                                       }
+                               } else {
+                                       processLine(stream);
+                               }
                        }
-                       scan.close();
-               } catch (Exception e) {
-                       throw new IllegalArgumentException(e);
+               } finally {
+                       stream.close(false);
                }
+
                return this;
        }
 
-       public boolean processLine(String line) throws IllegalArgumentException,
-                       NoSuchFieldException, SecurityException, IllegalAccessException,
-                       NoSuchMethodException, InstantiationException, ClassNotFoundException, InvocationTargetException {
+       /**
+        * Read a single (whole) line of serialised data into this {@link Importer}
+        * and accumulate it with the already present data.
+        * 
+        * @param in
+        *            the line to parse
+        * 
+        * @return TRUE if we are just done with one object or sub-object
+        * 
+        * @throws NoSuchFieldException
+        *             if the serialised data contains information about a field
+        *             which does actually not exist in the class we know of
+        * @throws NoSuchMethodException
+        *             if a class described in the serialised data cannot be created
+        *             because it is not compatible with this code
+        * @throws ClassNotFoundException
+        *             if a class described in the serialised data cannot be found
+        * @throws IOException
+        *             if the content cannot be read (for instance, corrupt data)
+        */
+       private boolean processLine(BufferedInputStream in)
+                       throws NoSuchFieldException, NoSuchMethodException,
+                       ClassNotFoundException, IOException {
+
                // Defer to latest child if any
                if (child != null) {
-                       if (child.processLine(line)) {
+                       if (child.processLine(in)) {
                                if (currentFieldName != null) {
                                        setField(currentFieldName, child.getValue());
                                        currentFieldName = null;
@@ -79,131 +154,112 @@ public class Importer {
                        return false;
                }
 
-               if (line.equals("{")) { // START: new child if needed
+               // Start/Stop object
+               if (in.is("{")) { // START: new child if needed
                        if (link != null) {
                                child = new Importer(map);
                        }
-               } else if (line.equals("}")) { // STOP: report self to parent
+                       in.end();
+                       return false;
+               } else if (in.is("}")) { // STOP: report self to parent
+                       in.end();
                        return true;
-               } else if (line.startsWith("REF ")) { // REF: create/link self
-                       String ref = line.substring(4).split("@")[1];
-                       link = map.containsKey(ref);
-                       if (link) {
-                               me = map.get(ref);
-                       } else {
-                               me = createSelf(line.substring(4).split("@")[0]);
-                               map.put(ref, me);
-                       }
-               } else { // FIELD: new field
-                       if (line.endsWith(":")) {
-                               // field value is compound
-                               currentFieldName = line.substring(0, line.length() - 1);
-                       } else {
-                               // field value is direct
-                               int pos = line.indexOf(":");
-                               String fieldName = line.substring(0, pos);
-                               String encodedValue = line.substring(pos + 1);
-                               Object value = null;
-                               value = SerialUtils.decode(encodedValue);
-
-                               // To support simple types directly:
-                               if (me == null) {
-                                       me = value;
-                               } else {
-                                       setField(fieldName, value);
-                               }
-                       }
                }
 
-               return false;
-       }
+               // Custom objects
+               if (CustomSerializer.isCustom(in)) {
+                       // not a field value but a direct value
+                       me = SerialUtils.decode(in);
+                       return false;
+               }
 
-       /**
-        * Create an empty object of the given type.
-        * 
-        * @param type
-        *            the object type
-        * @return the object
-        * 
-        * @throws NoSuchMethodException
-        * @throws SecurityException
-        * @throws InstantiationException
-        * @throws IllegalAccessException
-        * @throws ClassNotFoundException
-        * @throws IllegalArgumentException
-        * @throws InvocationTargetException
-        */
-       private Object createSelf(String type) throws NoSuchMethodException,
-                       SecurityException, InstantiationException, IllegalAccessException,
-                       ClassNotFoundException, IllegalArgumentException,
-                       InvocationTargetException {
+               // REF: (object)
+               if (in.startsWith("REF ")) { // REF: create/link self
+                       // here, line is REF type@999:xxx
+                       // xxx is optional
 
-               try {
-                       Class<?> clazz = getClass(type);
-                       if (clazz == null) {
-                               throw new ClassNotFoundException("Class not found: " + type);
-                       }
+                       NextableInputStream stream = new NextableInputStream(in,
+                                       new NextableInputStreamStep(':'));
+                       try {
+                               stream.next();
+
+                               stream.skip("REF ".length());
+                               String header = IOUtils.readSmallStream(stream);
 
-                       String className = clazz.getName();
-                       Object[] args = null;
-                       Constructor<?> ctor = null;
-                       if (className.contains("$")) {
-                               Object javaParent = createSelf(className.substring(0,
-                                               className.lastIndexOf('$')));
-                               args = new Object[] { javaParent };
-                               ctor = clazz.getDeclaredConstructor(new Class[] { javaParent
-                                               .getClass() });
-                       } else {
-                               args = new Object[] {};
-                               ctor = clazz.getDeclaredConstructor();
+                               String[] tab = header.split("@");
+                               if (tab.length != 2) {
+                                       throw new IOException("Bad import header line: " + header);
+                               }
+                               String type = tab[0];
+                               String ref = tab[1];
+
+                               stream.nextAll();
+
+                               link = map.containsKey(ref);
+                               if (link) {
+                                       me = map.get(ref);
+                                       stream.end();
+                               } else {
+                                       if (stream.eof()) {
+                                               // construct
+                                               me = SerialUtils.createObject(type);
+                                       } else {
+                                               // direct value
+                                               me = SerialUtils.decode(stream);
+                                       }
+                                       map.put(ref, me);
+                               }
+                       } finally {
+                               stream.close(false);
                        }
 
-                       ctor.setAccessible(true);
-                       return ctor.newInstance(args);
-               } catch (NoSuchMethodException e) {
-                       throw new NoSuchMethodException(
-                                       String.format(
-                                                       "Objects of type \"%s\" cannot be created by this code: maybe the class"
-                                                                       + " or its enclosing class doesn't have an empty constructor?",
-                                                       type));
+                       return false;
+               }
 
+               if (SerialUtils.isDirectValue(in)) {
+                       // not a field value but a direct value
+                       me = SerialUtils.decode(in);
+                       return false;
                }
-       }
 
-       private Class<?> getClass(String type) throws ClassNotFoundException,
-                       NoSuchMethodException {
-               Class<?> clazz = null;
-               try {
-                       clazz = Class.forName(type);
-               } catch (ClassNotFoundException e) {
-                       int pos = type.length();
-                       pos = type.lastIndexOf(".", pos);
-                       if (pos >= 0) {
-                               String parentType = type.substring(0, pos);
-                               String nestedType = type.substring(pos + 1);
-                               Class<?> javaParent = null;
-                               try {
-                                       javaParent = getClass(parentType);
-                                       parentType = javaParent.getName();
-                                       clazz = Class.forName(parentType + "$" + nestedType);
-                               } catch (Exception ee) {
-                               }
+               if (in.startsWith("^")) {
+                       in.skip(1);
+
+                       NextableInputStream nameThenContent = new NextableInputStream(in,
+                                       new NextableInputStreamStep(':'));
+
+                       try {
+                               nameThenContent.next();
+                               String fieldName = IOUtils.readSmallStream(nameThenContent);
 
-                               if (javaParent == null) {
-                                       throw new NoSuchMethodException(
-                                                       "Class not found: "
-                                                                       + type
-                                                                       + " (the enclosing class cannot be created: maybe it doesn't have an empty constructor?)");
+                               if (nameThenContent.nextAll() && !nameThenContent.eof()) {
+                                       // field value is direct or custom
+                                       Object value = null;
+                                       value = SerialUtils.decode(nameThenContent);
+
+                                       // To support simple types directly:
+                                       if (me == null) {
+                                               me = value;
+                                       } else {
+                                               setField(fieldName, value);
+                                       }
+                               } else {
+                                       // field value is compound
+                                       currentFieldName = fieldName;
                                }
+                       } finally {
+                               nameThenContent.close(false);
                        }
+
+                       return false;
                }
 
-               return clazz;
+               String line = IOUtils.readSmallStream(in);
+               throw new IOException("Line cannot be processed: <" + line + ">");
        }
 
        private void setField(String name, Object value)
-                       throws NoSuchFieldException, SecurityException,
-                       IllegalArgumentException, IllegalAccessException {
+                       throws NoSuchFieldException {
 
                try {
                        Field field = me.getClass().getDeclaredField(name);
@@ -214,9 +270,18 @@ public class Importer {
                        throw new NoSuchFieldException(String.format(
                                        "Field \"%s\" was not found in object of type \"%s\".",
                                        name, me.getClass().getCanonicalName()));
+               } catch (Exception e) {
+                       throw new NoSuchFieldException(String.format(
+                                       "Internal error when setting \"%s.%s\": %s", me.getClass()
+                                                       .getCanonicalName(), name, e.getMessage()));
                }
        }
 
+       /**
+        * Return the current deserialised value.
+        * 
+        * @return the current value
+        */
        public Object getValue() {
                return me;
        }