Application: gvSIG desktop

package org.gvsig.expressionevaluator.spi;

import java.io.File;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URI;

import java.net.URISyntaxException;

import java.net.URL;

import java.time.LocalDateTime;

import java.time.ZoneId;

import java.time.temporal.TemporalAccessor;

import java.util.ArrayList;

import java.util.Date;

import java.util.List;

import java.util.Locale;

import java.util.Objects;

import javax.json.JsonArray;

import javax.json.JsonObject;

import javax.json.JsonStructure;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang3.BooleanUtils;

import org.apache.commons.lang3.Range;

import org.apache.commons.lang3.StringUtils;

import org.apache.commons.math.util.MathUtils;

import org.gvsig.expressionevaluator.Code;

import org.gvsig.expressionevaluator.Codes;

import org.gvsig.expressionevaluator.ExpressionRuntimeException;

import org.gvsig.expressionevaluator.Formatter;

import org.gvsig.expressionevaluator.Function;

import org.gvsig.expressionevaluator.I18N;

import org.gvsig.expressionevaluator.Interpreter;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.util.GetItem;

import org.gvsig.tools.util.GetItem64;

import org.gvsig.tools.util.GetItemWithSize64;

import org.gvsig.tools.util.Size;

import org.gvsig.tools.util.Size64;

//import org.gvsig.fmap.geom.Geometry;

//import org.gvsig.fmap.geom.primitive.Point;

import org.json.JSONArray;

import org.json.JSONObject;

@SuppressWarnings("UseSpecificCatch")

public abstract class AbstractFunction implements Function {

    private final String name;

    private String group;

    private Range argc;

    private String description;

    private String[] descriptionArgs;

    private List<String> alias;

    private String template;

    private String returnType;

    private boolean sqlCompatible;

    protected AbstractFunction(String group, String name, Range argc, String description, String template, String[] descriptionArgs, String returnType, boolean sqlCompatible) {

        this.name = name;

        this.group = group;

        this.argc = argc;

        this.description = description;

        this.template = template;

        this.descriptionArgs = descriptionArgs;

        this.returnType = returnType;

        this.sqlCompatible = sqlCompatible;

        load_from_resource();

    }

    protected AbstractFunction(String group, String name, Range argc, String description, String template, String[] descriptionArgs, String returnType) {

        this(group, name, argc, description, template, descriptionArgs, returnType, false);

    }

    protected AbstractFunction(String group, String name, Range argc, String description, String template, String[] descriptionArgs) {

        this(group, name, argc, description, template, null, null);

    }

    protected AbstractFunction(String group, String name, Range argc, String description, String template) {

        this(group, name, argc, description, template, null, null);

    }

    protected AbstractFunction(String group, String name, Range argc) {

        this(group, name, argc, null, null, null, null);

    }

    @Override

    public String name() {

        return this.name;

    }

    @Override

    public String returnType() {

        return this.returnType;

    }

    @Override

    public String group() {

        return this.group;

    }

    @Override

    public Range argc() {

        return argc;

    }

    @Override

    public String description() {

        if( StringUtils.equalsIgnoreCase(System.getProperty("ExpressionEvaluatorReloadFunctionResources"), "true")) {

            load_from_resource();

        }

        return description;

    }

    @Override

    public String[] descriptionArgs() {

        return descriptionArgs;

    }

    @Override

    public String getFullDescription() {

        I18nManager i18n = ToolsLocator.getI18nManager();

        StringBuilder html = new StringBuilder();

        html.append("<html>\n");

        // Lo primero llamamos a description() para forzar la recarga de los

        // recursos si fuese necesaria.

        String functionDescription = this.description();

        html.append("<b>").append(i18n.getTranslation("_Function")).append("</b> ").append(this.name()).append("<br>\n<br>\n");

        List<String> aliases = this.aliases();

        if( aliases!=null && !aliases.isEmpty() ) {

            html.append("<b>").append(i18n.getTranslation("_Aliases")).append(":</b> ").append("<ul>\n");

            for (String theAlias : aliases) {

                html.append("<li>").append(theAlias).append("</li>\n");

            }

            html.append("</ul>\n");

        }

        html.append("<b>").append(i18n.getTranslation("_Return")).append("</b> ");

        html.append(StringUtils.isEmpty(this.returnType()) ? "Objec" : this.returnType());

        html.append("<br>\n");

        html.append("<b>").append(i18n.getTranslation("_Template")).append("</b> ");

        html.append(StringUtils.isEmpty(this.template()) ? this.name() + "()" : this.template());

        html.append("<br>\n");

        String[] args = this.descriptionArgs();

        if (args != null) {

            html.append("<b>").append(i18n.getTranslation("_Arguments")).append(":</b> ").append("<ul>\n");

            for (String arg : args) {

                html.append("<li>").append(arg).append("</li>\n");

            }

            html.append("</ul>\n");

            html.append("<br>\n");

        }

        if( !StringUtils.isBlank(functionDescription) ) {

            html.append("<b>").append(i18n.getTranslation("_Description")).append("</b><br>\n");

            html.append(functionDescription.replace("\n", "<br>")).append("<br>\n");

        }            

        html.append("</html>\n");

        return html.toString();

    }

    @Override

    public void addAlias(String name) {

        if( StringUtils.isBlank(name) ) {

            return;

        }

        if( this.alias == null ) {

            this.alias = new ArrayList<>();

        }

        if( this.alias.contains(name) ) {

            return;

        }

        this.alias.add(name);

    }

    @Override

    public List<String> aliases() {

        return this.alias;

    }

    @Override

    public String template() {

        return this.template;

    }

    @Override

    public boolean isOperator() {

        return false;

    }

    @Override

    public boolean isHidden() {

      return false;

    }

    @Override

    public boolean useArgumentsInsteadObjects() {

        return false;

    }

    @Override

    public boolean isSQLCompatible() {

        return sqlCompatible;

    }

    @Override

    public boolean allowConstantFolding() {

        return false;

    }

    @Override

    public Object call(Interpreter interpreter, Codes args) throws Exception {

        return null;

    }

    protected int getInt(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getInt(args[n],n);

    }

    protected int getInt(Object value, int n) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), n));

        }

        if( !(value instanceof Number) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Number",type)

            );

        }

        return ((Number)value).intValue();

    }

    protected long getLong(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getLong(args[n],n);

    }

    protected long getLong(Object value, int n) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), n));

        }

        if( !(value instanceof Number) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Number",type)

            );

        }

        return ((Number)value).longValue();

    }

    protected double getDouble(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getDouble(args[n],n);

    }

    protected double getDouble(Object value, int arg) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), arg));

        }

        if( !(value instanceof Number) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), arg) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Number",type)

            );

        }

        return ((Number)value).doubleValue();

    }

    protected float getFloat(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getFloat(args[n],n);

    }

    protected float getFloat(Object value, int arg) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), arg));

        }

        if( !(value instanceof Number) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), arg) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Number",type)

            );

        }

        return ((Number)value).floatValue();

    }

    protected String getStr(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getStr(args[n],n);

    }

    protected String getStr(Object value, int n) {

        return Objects.toString(value, "");

    }

    protected File getFile(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getFile(args[n],n);

    }

    protected File getFile(Object value, int n) {

        if( value == null ) {

            return null;

        }

        if( value instanceof File ) {

            return (File)value;

        }

        if( value instanceof URL ) {

            try {

                return new File(((URL)value).toURI());

            } catch (URISyntaxException ex) {

                return null;

            }

        }

        if( value instanceof URI ) {

            return new File(((URI)value));

        }

        String s = Objects.toString(value, null);

        if( s == null ) {

            return null;

        }

        File f = new File(s);

        return f;

    }

    protected boolean isNull(Object args[], int n) {

        return getObject(args, n)==null;

    }

    protected Object getObject(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return args[n];

    }

    protected JsonObject getJsonObject(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getJsonObject(args[n],n);

    }

    protected JsonObject getJsonObject(Object value, int n) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), n));

        }

        if( !(value instanceof JSONObject) ) {

            try {

                value = JsonUtils.toJsonObject(value);

            } catch(Throwable th) {

                String type = value.getClass().getCanonicalName();

                throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("JsonObject",type),

                    th

                );

            }

        }

        return (JsonObject) value;

    }

    protected JsonArray getJsonArray(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getJsonArray(args[n],n);

    }

    protected JsonArray getJsonArray(Object value, int n) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), n));

        }

        if( !(value instanceof JsonArray) ) {

            try {

                value = JsonUtils.toJsonArray(value);

            } catch(Throwable th) {

                String type = value.getClass().getCanonicalName();

                throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("JsonObject",type),

                    th

                );

            }

        }

        return (JsonArray) value;

    }

    protected JsonStructure getJsonStructure(Object args[], int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getJsonStructure(args[n],n);

    }

    protected JsonStructure getJsonStructure(Object value, int n) {

        if( value == null ) {

            throw new IllegalArgumentException(I18N.Illegal_null_value_for_argument_XargnX_of_XIdentifierX_function(name(), n));

        }

        if( !(value instanceof JsonStructure) ) {

            try {

                value = JsonUtils.toJson(value);

            } catch(Throwable th) {

                String type = value.getClass().getCanonicalName();

                throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("JsonObject",type),

                    th

                );

            }

        }

        return (JsonStructure) value;

    }

    protected Object getObject(Interpreter interpreter, Codes args, int n) {

        if( args.size() < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.size(), n));

        }

        Code arg = args.get(n);

        if( arg==null ) {

            return null;

        }

        Object value = interpreter.run(arg);

        return value;

    }

    protected Comparable getComparable(Object[] args, int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getComparable(args[n],n);

    }

    protected Comparable getComparable(Object value, int n) {

        if( value == null ) {

            return null;

        }

        if( !(value instanceof Comparable) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Comparable",type)

            );

        }

        return (Comparable)value;

    }

    protected Comparable getDate(Object[] args, int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getDate(args[n],n);

    }

    protected Date getDate(Object value, int n) {

        if( value == null ) {

            return null;

        }

        if( !(value instanceof Date) ) {

            String type = value.getClass().getCanonicalName();

            throw new IllegalArgumentException(

                    I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                    I18N.Expected_XexpectedX_and_found_XfoundX("Date",type)

            );

        }

        return (Date)value;

    }

    protected LocalDateTime getLocalDateTime(Object[] args, int n) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getLocalDateTime(args[n],n);

    }

    protected LocalDateTime getLocalDateTime(Object value, int n) {

        if( value == null ) {

            return null;

        }

        if( value instanceof Date ) {

            Date date = ((Date)value);

            return date.toInstant().atZone(ZoneId.systemDefault()).toLocalDateTime();

        }

        if( value instanceof LocalDateTime ) {

            return (LocalDateTime) value;

        }

        if( value instanceof TemporalAccessor ) {

            return LocalDateTime.from(((TemporalAccessor)value));

        }

        String type = value.getClass().getCanonicalName();

        throw new IllegalArgumentException(

                I18N.The_type_of_the_argument_XargnX_for_the_XIdentifierX_function_is_incorrect(name(), n) + " " +

                I18N.Expected_XexpectedX_and_found_XfoundX("Temporal/Date",type)

        );

    }

    public URL getURL(Object[] args, int index) throws MalformedURLException {

        Object obj = getObject(args, index);

        if( obj == null ) {

            return null;

        }  

        URL url;

        if( obj instanceof URL ) {

            url = (URL) obj;        } else if( obj instanceof CharSequence ) {

            url = new URL(((CharSequence)obj).toString());

        } else if( obj instanceof File ) {

            url = ((File)obj).toURI().toURL();

        } else if( obj instanceof URI ) {

            url = ((URI)obj).toURL();

        } else {

            throw new ExpressionRuntimeException("The "+this.name()+" function require a File, URI or a String and a received a '"+obj.getClass().getSimpleName()+"'.");

        }  

        return url;

    }

    protected boolean getBoolean(Object args[], int n, Double accuracy) {

        if( args.length < n  ) {

            throw new IllegalArgumentException(I18N.Required_argument_XargnX_and_only_found_XargcX_in_call_to_XIdentifierX(name(), args.length, n));

        }

        return getBoolean(args[n], n, accuracy);

    }

    protected boolean getBoolean(Object value, int n) {

        return getBoolean(value, n, MathUtils.EPSILON);

    }

    protected boolean getBoolean(Object value, int n, Double accuracy) {

        return toBoolean(value, accuracy);

    }

    protected boolean getBoolean(Interpreter interpreter, Codes args, int n) {

        Object value = getObject(interpreter, args, n);

        return toBoolean(value, interpreter.getAccuracy());

    }

    protected boolean toBoolean(Object value, Double accuracy) {

        if( value == null ) {

            return false;

        }

        if( value instanceof Boolean ) {

            return (Boolean)value;

        }        

        if( value instanceof Number ) {

            return MathUtils.compareTo(

                ((Number) value).doubleValue(), 

                0,

                accuracy==null? MathUtils.EPSILON:accuracy

            ) == 0;

        }

        return BooleanUtils.toBoolean(value.toString());

    } 

    protected GetItemWithSize64 getList(Object[] args, int index)  {

        Object value = getObject(args, index);

        if( value == null ) {

            return null;

        }  

        GetItemWithSize64 list = null;

        if (value instanceof List) {

            list = new GetItemWithSize64<Object>() {

                @Override

                public long size64() {

                    return ((List) value).size();

                }

                @Override

                public Object get64(long index) {

                    return ((List) value).get((int) index);

                }

            };

        } else if (value instanceof Object[]) {

            list = new GetItemWithSize64<Object>() {

                @Override

                public long size64() {

                    return ((Object[]) value).length;

                }

                @Override

                public Object get64(long index) {

                    return ((Object[]) value)[(int) index];

                }

            };

        } else if (value instanceof GetItemWithSize64 ) {

            list = (GetItemWithSize64) value;

        } else if (value instanceof GetItem && value instanceof Size) {

            list = new GetItemWithSize64<Object>() {

                @Override

                public long size64() {

                    return ((Size) value).size();

                }

                @Override

                public Object get64(long index) {

                    return ((GetItem) value).get((int) index);

                }

            };

        } else if (value instanceof GetItem64 && value instanceof Size64) {

            list = new GetItemWithSize64<Object>() {

                @Override

                public long size64() {

                    return ((Size64) value).size64();

                }

                @Override

                public Object get64(long index) {

                    return ((GetItem64) value).get64((int) index);

                }

            };

        }

        return list;

    }

    private void load_from_resource() {

        String lang = Locale.getDefault().getLanguage();

        URL url = this.getClass().getResource("/org/gvsig/expressionevaluator/functions/"+lang+"/"+this.name()+".json");

        if( url == null ) {

            url = this.getClass().getResource("/org/gvsig/expressionevaluator/functions/en/"+this.name()+".json");

            if( url == null ) {

                return;

            }

        }

        InputStream is = null;

        JSONObject json;

        try {

            is = url.openStream();

            List<String> lines = IOUtils.readLines(is);

            json = new JSONObject(StringUtils.join(lines,  "\n"));

        } catch (Exception ex) {

            return;

        } finally {

            IOUtils.closeQuietly(is);

        }

        if( json.has("group") ) {

            this.group = json.getString("group");

        }

        if( json.has("description") ) {

            Object x = json.get("description");

            if( x instanceof String ) {

                this.description = (String) x;

            } else if( x instanceof JSONArray ) {

                StringBuilder builder = new StringBuilder();

                for (int i = 0; i < ((JSONArray)x).length(); i++) {

                    if( i>0 ) {

                        builder.append(" ");

                    }

                    builder.append(((JSONArray)x).getString(i));

                }

                this.description = builder.toString();

            } else {

                this.description = Objects.toString(x, null);

            }

            this.description = StringUtils.replace(

                    this.description, 

                    "@@@", 

                    url.toString()

            );

        }

        if( json.has("template") ) {

            this.template = json.getString("template");

        }

        if( json.has("returnType") ) {

            this.returnType = json.getString("returnType");

        }

        if( json.has("sqlCompatible") ) {

            this.sqlCompatible = json.getBoolean("sqlCompatible");

        }

        if( json.has("args") ) {

            JSONArray x = json.getJSONArray("args");

            String[] args = new String[x.length()];

            for (int i = 0; i < x.length(); i++) {

                args[i] = x.getString(i);

            }

            this.descriptionArgs = args;

        }

        if( json.has("alias") ) {

            JSONArray x = json.getJSONArray("alias");

            for (int i = 0; i < x.length(); i++) {

                this.addAlias(x.getString(i));

            }

        }

    }

    protected static final int TYPE_INT =     0b00000001;

    protected static final int TYPE_LONG =    0b00000010;

    protected static final int TYPE_FLOAT =   0b00000100;

    protected static final int TYPE_DOUBLE =  0b00001000;

    protected static final int TYPE_BOOLEAN = 0b00010000;

    protected static final int TYPE_STRING =  0b00100000;

    protected static final int TYPE_DATE =    0b01000000;

    protected static final int TYPE_NULL =    0b10000000;

    protected int getType(Object op1, Object op2) {

        int r = 0;

        if( op1 == null ) {

            r |= TYPE_NULL;

        } else if( op1 instanceof Double ) {

            r |= TYPE_DOUBLE;

        } else if( op1 instanceof Float ) {

            r |= TYPE_FLOAT;

        } else if( op1 instanceof Long ) {

            r |= TYPE_LONG;

        } else if( op1 instanceof Integer ) {

            r |= TYPE_INT;

        } else if( op1 instanceof Boolean ) {

            r |= TYPE_BOOLEAN;

        } else if( op1 instanceof String ) {

            r |= TYPE_STRING;

        } else if( op1 instanceof Date ) {

            r |= TYPE_DATE;

        }

        if( op2 == null ) {

            r |= TYPE_NULL;

        } else if( op2 instanceof Double ) {

            r |= TYPE_DOUBLE;

        } else if( op2 instanceof Float ) {

            r |= TYPE_FLOAT;

        } else if( op2 instanceof Long ) {

            r |= TYPE_LONG;

        } else if( op2 instanceof Integer ) {

            r |= TYPE_INT;

        } else if( op2 instanceof Boolean ) {

            r |= TYPE_BOOLEAN;

        } else if( op2 instanceof String ) {

            r |= TYPE_STRING;

        } else if( op2 instanceof Date ) {

            r |= TYPE_DATE;

        }

        return r;

    }

    @Override

    public String toString(Codes args, Formatter<Code> formatter) {

        return null;

    }

}