/*
 * Copyright 2004-2022 H2 Group. Multiple-Licensed under the MPL 2.0,
 * and the EPL 1.0 (https://h2database.com/html/license.html).
 * Initial Developer: H2 Group
 */
package org.h2.util.geometry;

import static org.h2.util.geometry.GeometryUtils.DIMENSION_SYSTEM_XY;
import static org.h2.util.geometry.GeometryUtils.DIMENSION_SYSTEM_XYM;
import static org.h2.util.geometry.GeometryUtils.DIMENSION_SYSTEM_XYZ;
import static org.h2.util.geometry.GeometryUtils.DIMENSION_SYSTEM_XYZM;
import static org.h2.util.geometry.GeometryUtils.GEOMETRY_COLLECTION;
import static org.h2.util.geometry.GeometryUtils.LINE_STRING;
import static org.h2.util.geometry.GeometryUtils.M;
import static org.h2.util.geometry.GeometryUtils.MULTI_LINE_STRING;
import static org.h2.util.geometry.GeometryUtils.MULTI_POINT;
import static org.h2.util.geometry.GeometryUtils.MULTI_POLYGON;
import static org.h2.util.geometry.GeometryUtils.POINT;
import static org.h2.util.geometry.GeometryUtils.POLYGON;
import static org.h2.util.geometry.GeometryUtils.X;
import static org.h2.util.geometry.GeometryUtils.Y;
import static org.h2.util.geometry.GeometryUtils.Z;

import java.io.ByteArrayOutputStream;
import java.util.ArrayList;

import org.h2.util.StringUtils;
import org.h2.util.geometry.EWKBUtils.EWKBTarget;
import org.h2.util.geometry.GeometryUtils.Target;

/**
 * EWKT format support for GEOMETRY data type.
 *
 * <p>
 * This class provides limited support of EWKT. EWKT is based on Well-known Text
 * Representation (WKT) from OGC 06-103r4 and includes additional <a href=
 * "https://postgis.net/docs/using_postgis_dbmanagement.html#EWKB_EWKT">PostGIS
 * extensions</a>. SRID support from EWKT is implemented.
 * </p>
 */
public final class EWKTUtils {

    /**
     * 0-based type names of geometries, subtract 1 from type code to get index
     * in this array.
     */
    static final String[] TYPES = { //
            "POINT", //
            "LINESTRING", //
            "POLYGON", //
            "MULTIPOINT", //
            "MULTILINESTRING", //
            "MULTIPOLYGON", //
            "GEOMETRYCOLLECTION", //
    };

    /**
     * Names of dimension systems.
     */
    private static final String[] DIMENSION_SYSTEMS = { //
            "XY", //
            "Z", //
            "M", //
            "ZM", //
    };

    /**
     * Converter output target that writes a EWKT.
     */
    public static final class EWKTTarget extends Target {

        private final StringBuilder output;

        private final int dimensionSystem;

        private int type;

        private boolean inMulti;

        /**
         * Creates a new EWKT output target.
         *
         * @param output
         *            output stream
         * @param dimensionSystem
         *            dimension system to use
         */
        public EWKTTarget(StringBuilder output, int dimensionSystem) {
            this.output = output;
            this.dimensionSystem = dimensionSystem;
        }

        @Override
        protected void init(int srid) {
            if (srid != 0) {
                output.append("SRID=").append(srid).append(';');
            }
        }

        @Override
        protected void startPoint() {
            writeHeader(POINT);
        }

        @Override
        protected void startLineString(int numPoints) {
            writeHeader(LINE_STRING);
            if (numPoints == 0) {
                output.append("EMPTY");
            }
        }

        @Override
        protected void startPolygon(int numInner, int numPoints) {
            writeHeader(POLYGON);
            if (numPoints == 0) {
                output.append("EMPTY");
            } else {
                output.append('(');
            }
        }

        @Override
        protected void startPolygonInner(int numInner) {
            output.append(numInner > 0 ? ", " : ", EMPTY");
        }

        @Override
        protected void endNonEmptyPolygon() {
            output.append(')');
        }

        @Override
        protected void startCollection(int type, int numItems) {
            writeHeader(type);
            if (numItems == 0) {
                output.append("EMPTY");
            }
            if (type != GEOMETRY_COLLECTION) {
                inMulti = true;
            }
        }

        private void writeHeader(int type) {
            this.type = type;
            if (inMulti) {
                return;
            }
            output.append(TYPES[type - 1]);
            switch (dimensionSystem) {
            case DIMENSION_SYSTEM_XYZ:
                output.append(" Z");
                break;
            case DIMENSION_SYSTEM_XYM:
                output.append(" M");
                break;
            case DIMENSION_SYSTEM_XYZM:
                output.append(" ZM");
            }
            output.append(' ');
        }

        @Override
        protected Target startCollectionItem(int index, int total) {
            if (index == 0) {
                output.append('(');
            } else {
                output.append(", ");
            }
            return this;
        }

        @Override
        protected void endCollectionItem(Target target, int type, int index, int total) {
            if (index + 1 == total) {
                output.append(')');
            }
        }

        @Override
        protected void endObject(int type) {
            switch (type) {
            case MULTI_POINT:
            case MULTI_LINE_STRING:
            case MULTI_POLYGON:
                inMulti = false;
            }
        }

        @Override
        protected void addCoordinate(double x, double y, double z, double m, int index, int total) {
            if (type == POINT && Double.isNaN(x) && Double.isNaN(y) && Double.isNaN(z) && Double.isNaN(m)) {
                output.append("EMPTY");
                return;
            }
            if (index == 0) {
                output.append('(');
            } else {
                output.append(", ");
            }
            writeDouble(x);
            output.append(' ');
            writeDouble(y);
            if ((dimensionSystem & DIMENSION_SYSTEM_XYZ) != 0) {
                output.append(' ');
                writeDouble(z);
            }
            if ((dimensionSystem & DIMENSION_SYSTEM_XYM) != 0) {
                output.append(' ');
                writeDouble(m);
            }
            if (index + 1 == total) {
                output.append(')');
            }
        }

        private void writeDouble(double v) {
            String s = Double.toString(GeometryUtils.checkFinite(v));
            if (s.endsWith(".0")) {
                output.append(s, 0, s.length() - 2);
            } else {
                int idx = s.indexOf(".0E");
                if (idx < 0) {
                    output.append(s);
                } else {
                    output.append(s, 0, idx).append(s, idx + 2, s.length());
                }
            }
        }

    }

    /**
     * Helper source object for EWKT reading.
     */
    private static final class EWKTSource {
        private final String ewkt;

        private int offset;

        EWKTSource(String ewkt) {
            this.ewkt = ewkt;
        }

        int readSRID() {
            skipWS();
            int srid;
            if (ewkt.regionMatches(true, offset, "SRID=", 0, 5)) {
                offset += 5;
                int idx = ewkt.indexOf(';', 5);
                if (idx < 0) {
                    throw new IllegalArgumentException();
                }
                int end = idx;
                while (ewkt.charAt(end - 1) <= ' ') {
                    end--;
                }
                srid = Integer.parseInt(StringUtils.trimSubstring(ewkt, offset, end));
                offset = idx + 1;
            } else {
                srid = 0;
            }
            return srid;
        }

        void read(char symbol) {
            skipWS();
            int len = ewkt.length();
            if (offset >= len) {
                throw new IllegalArgumentException();
            }
            if (ewkt.charAt(offset) != symbol) {
                throw new IllegalArgumentException();
            }
            offset++;
        }

        int readType() {
            skipWS();
            int len = ewkt.length();
            if (offset >= len) {
                throw new IllegalArgumentException();
            }
            int result = 0;
            char ch = ewkt.charAt(offset);
            switch (ch) {
            case 'P':
            case 'p':
                result = match("POINT", POINT);
                if (result == 0) {
                    result = match("POLYGON", POLYGON);
                }
                break;
            case 'L':
            case 'l':
                result = match("LINESTRING", LINE_STRING);
                break;
            case 'M':
            case 'm':
                if (match("MULTI", 1) != 0) {
                    result = match("POINT", MULTI_POINT);
                    if (result == 0) {
                        result = match("POLYGON", MULTI_POLYGON);
                        if (result == 0) {
                            result = match("LINESTRING", MULTI_LINE_STRING);
                        }
                    }
                }
                break;
            case 'G':
            case 'g':
                result = match("GEOMETRYCOLLECTION", GEOMETRY_COLLECTION);
                break;
            }
            if (result == 0) {
                throw new IllegalArgumentException();
            }
            return result;
        }

        int readDimensionSystem() {
            int o = offset;
            skipWS();
            int len = ewkt.length();
            if (offset >= len) {
                throw new IllegalArgumentException();
            }
            int result;
            char ch = ewkt.charAt(offset);
            switch (ch) {
            case 'M':
            case 'm':
                result = DIMENSION_SYSTEM_XYM;
                offset++;
                break;
            case 'Z':
            case 'z':
                offset++;
                if (offset >= len) {
                    result = DIMENSION_SYSTEM_XYZ;
                } else {
                    ch = ewkt.charAt(offset);
                    if (ch == 'M' || ch == 'm') {
                        offset++;
                        result = DIMENSION_SYSTEM_XYZM;
                    } else {
                        result = DIMENSION_SYSTEM_XYZ;
                    }
                }
                break;
            default:
                result = DIMENSION_SYSTEM_XY;
                if (o != offset) {
                    // Token is already terminated by a whitespace
                    return result;
                }
            }
            checkStringEnd(len);
            return result;
        }

        boolean readEmpty() {
            skipWS();
            int len = ewkt.length();
            if (offset >= len) {
                throw new IllegalArgumentException();
            }
            if (ewkt.charAt(offset) == '(') {
                offset++;
                return false;
            }
            if (match("EMPTY", 1) != 0) {
                checkStringEnd(len);
                return true;
            }
            throw new IllegalArgumentException();
        }

        private int match(String token, int code) {
            int l = token.length();
            if (offset <= ewkt.length() - l && ewkt.regionMatches(true, offset, token, 0, l)) {
                offset += l;
            } else {
                code = 0;
            }
            return code;
        }

        private void checkStringEnd(int len) {
            if (offset < len) {
                char ch = ewkt.charAt(offset);
                if (ch > ' ' && ch != '(' && ch != ')' && ch != ',') {
                    throw new IllegalArgumentException();
                }
            }
        }

        public boolean hasCoordinate() {
            skipWS();
            if (offset >= ewkt.length()) {
                return false;
            }
            return isNumberStart(ewkt.charAt(offset));
        }

        public double readCoordinate() {
            skipWS();
            int len = ewkt.length();
            if (offset >= len) {
                throw new IllegalArgumentException();
            }
            char ch = ewkt.charAt(offset);
            if (!isNumberStart(ch)) {
                throw new IllegalArgumentException();
            }
            int start = offset++;
            while (offset < len && isNumberPart(ch = ewkt.charAt(offset))) {
                offset++;
            }
            if (offset < len) {
                if (ch > ' ' && ch != ')' && ch != ',') {
                    throw new IllegalArgumentException();
                }
            }
            Double d = Double.parseDouble(ewkt.substring(start, offset));
            return d == 0 ? 0 : d;
        }

        private static boolean isNumberStart(char ch) {
            if (ch >= '0' && ch <= '9') {
                return true;
            }
            switch (ch) {
            case '+':
            case '-':
            case '.':
                return true;
            default:
                return false;
            }
        }

        private static boolean isNumberPart(char ch) {
            if (ch >= '0' && ch <= '9') {
                return true;
            }
            switch (ch) {
            case '+':
            case '-':
            case '.':
            case 'E':
            case 'e':
                return true;
            default:
                return false;
            }
        }

        public boolean hasMoreCoordinates() {
            skipWS();
            if (offset >= ewkt.length()) {
                throw new IllegalArgumentException();
            }
            switch (ewkt.charAt(offset)) {
            case ',':
                offset++;
                return true;
            case ')':
                offset++;
                return false;
            default:
                throw new IllegalArgumentException();
            }
        }

        boolean hasData() {
            skipWS();
            return offset < ewkt.length();
        }

        int getItemCount() {
            int result = 1;
            int offset = this.offset, level = 0, len = ewkt.length();
            while (offset < len) {
                switch (ewkt.charAt(offset++)) {
                case ',':
                    if (level == 0) {
                        result++;
                    }
                    break;
                case '(':
                    level++;
                    break;
                case ')':
                    if (--level < 0) {
                        return result;
                    }
                }
            }
            throw new IllegalArgumentException();
        }

        private void skipWS() {
            for (int len = ewkt.length(); offset < len && ewkt.charAt(offset) <= ' '; offset++) {
            }
        }

        @Override
        public String toString() {
            return new StringBuilder(ewkt.length() + 3).append(ewkt, 0, offset).append("<*>")
                    .append(ewkt, offset, ewkt.length()).toString();
        }

    }

    /**
     * Converts EWKB to EWKT.
     *
     * @param ewkb
     *            source EWKB
     * @return EWKT representation
     */
    public static String ewkb2ewkt(byte[] ewkb) {
        return ewkb2ewkt(ewkb, EWKBUtils.getDimensionSystem(ewkb));
    }

    /**
     * Converts EWKB to EWKT.
     *
     * @param ewkb
     *            source EWKB
     * @param dimensionSystem
     *            dimension system
     * @return EWKT representation
     */
    public static String ewkb2ewkt(byte[] ewkb, int dimensionSystem) {
        StringBuilder output = new StringBuilder();
        EWKBUtils.parseEWKB(ewkb, new EWKTTarget(output, dimensionSystem));
        return output.toString();
    }

    /**
     * Converts EWKT to EWKB.
     *
     * @param ewkt
     *            source EWKT
     * @return EWKB representation
     */
    public static byte[] ewkt2ewkb(String ewkt) {
        return ewkt2ewkb(ewkt, getDimensionSystem(ewkt));
    }

    /**
     * Converts EWKT to EWKB.
     *
     * @param ewkt
     *            source EWKT
     * @param dimensionSystem
     *            dimension system
     * @return EWKB representation
     */
    public static byte[] ewkt2ewkb(String ewkt, int dimensionSystem) {
        ByteArrayOutputStream output = new ByteArrayOutputStream();
        EWKBTarget target = new EWKBTarget(output, dimensionSystem);
        parseEWKT(ewkt, target);
        return output.toByteArray();
    }

    /**
     * Parses a EWKT.
     *
     * @param ewkt
     *            source EWKT
     * @param target
     *            output target
     */
    public static void parseEWKT(String ewkt, Target target) {
        parseEWKT(new EWKTSource(ewkt), target, 0, 0);
    }

    /**
     * Parses geometry type and dimension system from the given string.
     *
     * @param s
     *            string to parse
     * @return geometry type and dimension system in OGC geometry code format
     *         (type + dimensionSystem * 1000)
     * @throws IllegalArgumentException
     *             if input is not valid
     */
    public static int parseGeometryType(String s) {
        EWKTSource source = new EWKTSource(s);
        int type = source.readType();
        int dimensionSystem = 0;
        if (source.hasData()) {
            dimensionSystem = source.readDimensionSystem();
            if (source.hasData()) {
                throw new IllegalArgumentException();
            }
        }
        return dimensionSystem * 1_000 + type;
    }

    /**
     * Parses a dimension system from the given string.
     *
     * @param s
     *            string to parse
     * @return dimension system, one of XYZ, XYM, or XYZM
     * @see GeometryUtils#DIMENSION_SYSTEM_XYZ
     * @see GeometryUtils#DIMENSION_SYSTEM_XYM
     * @see GeometryUtils#DIMENSION_SYSTEM_XYZM
     * @throws IllegalArgumentException
     *             if input is not valid
     */
    public static int parseDimensionSystem(String s) {
        EWKTSource source = new EWKTSource(s);
        int dimensionSystem = source.readDimensionSystem();
        if (source.hasData() || dimensionSystem == DIMENSION_SYSTEM_XY) {
            throw new IllegalArgumentException();
        }
        return dimensionSystem;
    }

    /**
     * Formats type and dimension system as a string.
     *
     * @param builder
     *            string builder
     * @param type
     *            OGC geometry code format (type + dimensionSystem * 1000)
     * @return the specified string builder
     * @throws IllegalArgumentException
     *             if type is not valid
     */
    public static StringBuilder formatGeometryTypeAndDimensionSystem(StringBuilder builder, int type) {
        int t = type % 1_000, d = type / 1_000;
        if (t < POINT || t > GEOMETRY_COLLECTION || d < DIMENSION_SYSTEM_XY || d > DIMENSION_SYSTEM_XYZM) {
            throw new IllegalArgumentException();
        }
        builder.append(TYPES[t - 1]);
        if (d != DIMENSION_SYSTEM_XY) {
            builder.append(' ').append(DIMENSION_SYSTEMS[d]);
        }
        return builder;
    }

    /**
     * Parses a EWKB.
     *
     * @param source
     *            EWKT source
     * @param target
     *            output target
     * @param parentType
     *            type of parent geometry collection, or 0 for the root geometry
     * @param dimensionSystem
     *            dimension system of parent geometry
     */
    private static void parseEWKT(EWKTSource source, Target target, int parentType, int dimensionSystem) {
        if (parentType == 0) {
            target.init(source.readSRID());
        }
        int type;
        switch (parentType) {
        default: {
            type = source.readType();
            dimensionSystem = source.readDimensionSystem();
            break;
        }
        case MULTI_POINT:
            type = POINT;
            break;
        case MULTI_LINE_STRING:
            type = LINE_STRING;
            break;
        case MULTI_POLYGON:
            type = POLYGON;
            break;
        }
        target.dimensionSystem(dimensionSystem);
        switch (type) {
        case POINT: {
            if (parentType != 0 && parentType != MULTI_POINT && parentType != GEOMETRY_COLLECTION) {
                throw new IllegalArgumentException();
            }
            boolean empty = source.readEmpty();
            target.startPoint();
            if (empty) {
                target.addCoordinate(Double.NaN, Double.NaN, Double.NaN, Double.NaN, 0, 1);
            } else {
                addCoordinate(source, target, dimensionSystem, 0, 1);
                source.read(')');
            }
            break;
        }
        case LINE_STRING: {
            if (parentType != 0 && parentType != MULTI_LINE_STRING && parentType != GEOMETRY_COLLECTION) {
                throw new IllegalArgumentException();
            }
            boolean empty = source.readEmpty();
            if (empty) {
                target.startLineString(0);
            } else {
                ArrayList<double[]> coordinates = new ArrayList<>();
                do {
                    coordinates.add(readCoordinate(source, dimensionSystem));
                } while (source.hasMoreCoordinates());
                int numPoints = coordinates.size();
                if (numPoints < 0 || numPoints == 1) {
                    throw new IllegalArgumentException();
                }
                target.startLineString(numPoints);
                for (int i = 0; i < numPoints; i++) {
                    double[] c = coordinates.get(i);
                    target.addCoordinate(c[X], c[Y], c[Z], c[M], i, numPoints);
                }
            }
            break;
        }
        case POLYGON: {
            if (parentType != 0 && parentType != MULTI_POLYGON && parentType != GEOMETRY_COLLECTION) {
                throw new IllegalArgumentException();
            }
            boolean empty = source.readEmpty();
            if (empty) {
                target.startPolygon(0, 0);
            } else {
                ArrayList<double[]> outer = readRing(source, dimensionSystem);
                ArrayList<ArrayList<double[]>> inner = new ArrayList<>();
                while (source.hasMoreCoordinates()) {
                    inner.add(readRing(source, dimensionSystem));
                }
                int numInner = inner.size();
                int size = outer.size();
                // Size may be 0 (EMPTY) or 4+
                if (size >= 1 && size <= 3) {
                    throw new IllegalArgumentException();
                }
                if (size == 0 && numInner > 0) {
                    throw new IllegalArgumentException();
                }
                target.startPolygon(numInner, size);
                if (size > 0) {
                    addRing(outer, target);
                    for (int i = 0; i < numInner; i++) {
                        ArrayList<double[]> ring = inner.get(i);
                        size = ring.size();
                        // Size may be 0 (EMPTY) or 4+
                        if (size >= 1 && size <= 3) {
                            throw new IllegalArgumentException();
                        }
                        target.startPolygonInner(size);
                        addRing(ring, target);
                    }
                    target.endNonEmptyPolygon();
                }
            }
            break;
        }
        case MULTI_POINT:
        case MULTI_LINE_STRING:
        case MULTI_POLYGON:
            parseCollection(source, target, type, parentType, dimensionSystem);
            break;
        case GEOMETRY_COLLECTION:
            parseCollection(source, target, GEOMETRY_COLLECTION, parentType, 0);
            break;
        default:
            throw new IllegalArgumentException();
        }
        target.endObject(type);
        if (parentType == 0 && source.hasData()) {
            throw new IllegalArgumentException();
        }
    }

    private static void parseCollection(EWKTSource source, Target target, int type, int parentType,
            int dimensionSystem) {
        if (parentType != 0 && parentType != GEOMETRY_COLLECTION) {
            throw new IllegalArgumentException();
        }
        if (source.readEmpty()) {
            target.startCollection(type, 0);
        } else {
            if (type == MULTI_POINT && source.hasCoordinate()) {
                parseMultiPointAlternative(source, target, dimensionSystem);
            } else {
                int numItems = source.getItemCount();
                target.startCollection(type, numItems);
                for (int i = 0; i < numItems; i++) {
                    if (i > 0) {
                        source.read(',');
                    }
                    Target innerTarget = target.startCollectionItem(i, numItems);
                    parseEWKT(source, innerTarget, type, dimensionSystem);
                    target.endCollectionItem(innerTarget, type, i, numItems);
                }
                source.read(')');
            }
        }
    }

    private static void parseMultiPointAlternative(EWKTSource source, Target target, int dimensionSystem) {
        // Special case for MULTIPOINT (1 2, 3 4)
        ArrayList<double[]> points = new ArrayList<>();
        do {
            points.add(readCoordinate(source, dimensionSystem));
        } while (source.hasMoreCoordinates());
        int numItems = points.size();
        target.startCollection(MULTI_POINT, numItems);
        for (int i = 0; i < points.size(); i++) {
            Target innerTarget = target.startCollectionItem(i, numItems);
            target.startPoint();
            double[] c = points.get(i);
            target.addCoordinate(c[X], c[Y], c[Z], c[M], 0, 1);
            target.endCollectionItem(innerTarget, MULTI_POINT, i, numItems);
        }
    }

    private static ArrayList<double[]> readRing(EWKTSource source, int dimensionSystem) {
        if (source.readEmpty()) {
            return new ArrayList<>(0);
        }
        ArrayList<double[]> result = new ArrayList<>();
        double[] c = readCoordinate(source, dimensionSystem);
        double startX = c[X], startY = c[Y];
        result.add(c);
        while (source.hasMoreCoordinates()) {
            result.add(readCoordinate(source, dimensionSystem));
        }
        int size = result.size();
        if (size < 4) {
            throw new IllegalArgumentException();
        }
        c = result.get(size - 1);
        double endX = c[X], endY = c[Y];
        /*
         * TODO OGC 06-103r4 determines points as equal if they have the same X
         * and Y coordinates. Should we check Z and M here too?
         */
        if (startX != endX || startY != endY) {
            throw new IllegalArgumentException();
        }
        return result;
    }

    private static void addRing(ArrayList<double[]> ring, Target target) {
        for (int i = 0, size = ring.size(); i < size; i++) {
            double[] coordinates = ring.get(i);
            target.addCoordinate(coordinates[X], coordinates[Y], coordinates[Z], coordinates[M], i, size);
        }
    }

    private static void addCoordinate(EWKTSource source, Target target, int dimensionSystem, int index, int total) {
        double x = source.readCoordinate();
        double y = source.readCoordinate();
        double z = (dimensionSystem & DIMENSION_SYSTEM_XYZ) != 0 ? source.readCoordinate() : Double.NaN;
        double m = (dimensionSystem & DIMENSION_SYSTEM_XYM) != 0 ? source.readCoordinate() : Double.NaN;
        target.addCoordinate(x, y, z, m, index, total);
    }

    private static double[] readCoordinate(EWKTSource source, int dimensionSystem) {
        double x = source.readCoordinate();
        double y = source.readCoordinate();
        double z = (dimensionSystem & DIMENSION_SYSTEM_XYZ) != 0 ? source.readCoordinate() : Double.NaN;
        double m = (dimensionSystem & DIMENSION_SYSTEM_XYM) != 0 ? source.readCoordinate() : Double.NaN;
        return new double[] { x, y, z, m };
    }

    /**
     * Reads the dimension system from EWKT.
     *
     * @param ewkt
     *            EWKT source
     * @return the dimension system
     */
    public static int getDimensionSystem(String ewkt) {
        EWKTSource source = new EWKTSource(ewkt);
        source.readSRID();
        source.readType();
        return source.readDimensionSystem();
    }

    private EWKTUtils() {
    }

}
