gvSIG projects pool

/*

 * gvSIG. Desktop Geographic Information System.

 * 

 * Copyright (C) 2007-2020 gvSIG Association.

 * 

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 * 

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

 * GNU General Public License for more details.

 * 

 * You should have received a copy of the GNU General Public License 

 * along with this program. If not, see <https://www.gnu.org/licenses/>. 

 * 

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.online.lib.impl;

import java.io.IOException;

import java.io.InputStream;

import java.net.MalformedURLException;

import java.net.URL;

import java.nio.charset.StandardCharsets;

import java.security.MessageDigest;

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.function.Predicate;

import javax.json.JsonObject;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang3.ArrayUtils;

import org.apache.commons.lang3.StringUtils;

import org.apache.commons.text.StringSubstitutor;

import org.apache.commons.text.lookup.StringLookup;

import org.gvsig.fmap.dal.feature.Feature;

import org.gvsig.json.Json;

import org.gvsig.json.JsonObjectBuilder;

import org.gvsig.online.lib.api.OnlineManager;

import org.gvsig.online.lib.api.workingcopy.OnlineEntity;

import org.gvsig.online.lib.api.workingcopy.OnlineEntityEditable;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.util.MapBuilder;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

/**

 *

 * @author gvSIG Team

 */

@SuppressWarnings("UseSpecificCatch")

public class OnlineUtils {

    private static final Logger LOGGER = LoggerFactory.getLogger(OnlineUtils.class);

    public static final String ENTITY_CODE = "EntityCode";

    public static final String ENTITY_NAME = "EntityName";

    public static final String ENTITY_DESCRIPTION = "Description";

    public static final String ENTITY_FEATUREIDFIELDNAME = "FeatureIdFieldName";

    public static final String ENTITY_FEATURETYPEASJSON = "FeatureTypeAsJson";

    public static final String ENTITY_FIELDFORLABEL = "FieldForLabel";

    public static final String ENTITY_GEOMETRYFIELDNAME = "GeometryFieldName";

    public static final String ENTITY_LABEL = "Label";

    public static final String ENTITY_DATA_MODELS = "DataModels";

    public static final String ENTITY_CRS = "CRS";

    public static final String ENTITY_CUSTOMDATA = "customdata";

    private static final Map<Integer,String> ERRMSGS = new MapBuilder<>()

//            .add(ERR_NO_ERROR, "_No_errors")

//            .add(ERR_DBFILE_IS_NULL, "_dbfile_is_null")

//            .add(ERR_WSEXPLORER_IS_NULL, "_workingcopy_explorer_is_null")

//            .add(ERR_LABEL_IS_NULL, "_label_is_null")

//            .add(ERR_CANT_OPEN_WORKSPACE, "_Cant_open_workingcopy")

//            .add(ERR_CANT_OPEN_WORKSPACE_SERVEREXPLORER, "_Cant_open_workingcopy")

//            .add(ERR_STORE_NOT_IN_VERSION_CONTROL, "_Store_not_in_control_version")

//            .add(ERR_CANT_CREATE_TABLE, "_Cant_create_table")

//            .add(ERR_CANT_CREATE_TABLE_CONFIG, "_Cant_create_config_table")

//            .add(ERR_CANT_CREATE_TABLE_ENTITIES, "_Cant_create_table_entities")

//            .add(ERR_CANT_CREATE_TABLE_CHANGES, "_Cant_create_table_changes")

//            .add(ERR_ENTITY_ALREADY_EXISTS, "_Entity_already_exists")

//            .add(ERR_ENTITY_NOT_HAS_FEATURECODE, "_Entity_has_not_VCSGISCODE")

//            .add(ERR_CANT_OPEN_ENTITIES, "_Cant_open_entities")

//            .add(ERR_CANT_INSERT_ENTITIES, "_Cant_insert_entities")

//            .add(ERR_CANT_OPEN_CHANGES, "_Cant_open_changes")

//            .add(ERR_CANT_INSERT_CHANGE, "_Cant_insert_change")

//            .add(ERR_CANT_OPEN_STORE, "_Cant_open_store")

//            .add(ERR_CANT_RETRIEVE_SOURCE_FEATURES, "_Cant_retrieve_source_features")

//            .add(ERR_CANT_INSERT_FEATURES, "_Cant_insert_features")

//            .add(ERR_CANT_COMMIT, "_Cant_commit")

//            .add(ERR_CANT_COMMIT_WORKSPACE_OUTDATED, "_Cant_commit_workingcopy_is_out_of_date")

//            .add(ERR_CANT_CHECKOUT, "_Cant_checkout")

//            .add(ERR_CANT_UPDATE_ENTITIES, "_Cant_update_entities")

//            .add(ERR_CANT_PREPARE_UPDATE, "_Cant_prepare_update")

//            .add(ERR_CANT_UPDATE, "_Cant_update")

//            .add(ERR_CANT_EXECUTE_REQUEST, "_Cant_execute_request")

//            .add(ERR_CANT_BUILD_REQUEST_RESPONSE,"_Cant_build_request_response")

//            .add(ERR_CANT_HANDLE_REQUEST,"_Cant_handle_request")

//            .add(ERR_CANT_UPDATE_CLEAN,"_Cant_update_clean")

//            .add(ERR_CANT_COMMIT_WITH_FEATURE_CODE_BLANK,"_Cant_commit_with_feature_code_blank")

//            .add(ERR_CANT_ADD_ENTITY_WITHOUT_PRIMARY_KEY,"Cant_add_entity_without_primary_key")

//            .add(ERR_CANT_INITIALIZE_REPOSITORY, "_Cant_initialize_repository")

//            .add(ERR_INVALID_DATA, "_Data_can_be_empty")

//            .add(ERR_INVALID_REPOSITORY, "_Invalid_repository")

//            .add(ERR_INVALID_REVISION, "_Invalid_revision")

//            .add(ERR_INVALID_REVISION_FOR_ENTITY, "_Invalid_revision_for_entity")

//            .add(ERR_CANT_RETRIEVE_ENTITIES, "_Cant_retrieve_entities")

//            .add(ERR_CANT_RETRIEVE_USERS, "_Cant_retrieve_users")

//            .add(ERR_CANT_RETRIEVE_TOPOLOGYPLANS, "_Cant_retrieve_topologyplans")

//            .add(ERR_CANT_ADD_LAYER, "_Cant_add_layer_to_view")

//            .add(ERR_CANT_REMOVE_ENTITY, "_Cant_remove_entity")

//            .add(ERR_CANT_REMOVE_CHANGES, "_Cant_remove_change")

            .add(OnlineManager.ERR_CANT_AUTHENTICATE_USER, "_Cant_authenticate_user")

            .add(OnlineManager.ERR_INVALID_AUTHENTICATION_TOKEN, "_Invalid_authentication_token")

            .add(OnlineManager.ERR_USER_NOT_AUTHORIZED, "_User_not_authorized")

            .add(OnlineManager.ERR_AUTHENTICATION_EXPIRED,"_Authentication_expired")

            .add(OnlineManager.ERR_INVALID_USERCODE, "_Invalid_user_code")

//            .add(ERR_CANT_REVERT, "_Cant_revert")

//            .add(ERR_INVALID_RECORDCODE, "_Invalid_record_code")

//            .add(ERR_DATA_RECORD_NOT_FOUND, "_Data_record_not_found")

//            .add(ERR_EXCEPTION, "_Exception_during_operation")

//            .add(ERR_CANT_PREPARE_WORKSPACE, "_Cant_prepare_workspace")

//            .add(ERR_REPOSITORY_URL_NOT_DEFINED, "_Repository_url_not_defined")

//            .add(ERR_WORKING_COPIES_FOLDER_NOT_DEFINED, "_Working_copies_folder_not_defined")

//            .add(ERR_EXCEPTION, "_Exception_during_operation")

//            .add(ERR_CANT_COMMIT_WITH_FEATURE_CODE_BLANK, "_Cant_commit_feature_code_is_blank")

//            .add(ERR_CANT_COMMIT_WITH_FEATURE_DATA_BLANK, "_Cant_commit_feature_data_is_blank")

//            .add(ERR_OPERATION_NOT_ALLOWED_WITH_LINKEDTABLE,"_Operation_not_allowed_with_linked_table")

//            .add(ERR_TOO_MANY_REPOSITORIES,"_Too_many_repositories_only_one_allowed")

            .build();

    private static final Map<Integer,String> OPERATION_LABELS = new MapBuilder<Integer,String>()

            .add(OnlineManager.OP_DELETE, "Delete")

            .add(OnlineManager.OP_UPDATE, "Update")

            .add(OnlineManager.OP_INSERT, "Insert")

//            .add(OnlineManager.OP_ADD_ENTITY, "Add entity")

            .build();

    private static final Map<Integer,String> STATE_LABELS = new MapBuilder<Integer,String>()

        .add(OnlineManager.STATE_LOCAL_UNMODIFIED, "Unmodified")

        .add(OnlineManager.STATE_LOCAL_NEW, "New")

        .add(OnlineManager.STATE_LOCAL_MODIFIED, "Modified")

        .add(OnlineManager.STATE_LOCAL_OUTDATED, "Outdated")

        .add(OnlineManager.STATE_LOCAL_OUTDATED_AND_MODIFIED, "Outdated and modified")

        .add(OnlineManager.STATE_CONFLICT, "Conflict")

        .add(OnlineManager.STATE_DISCONNECTED, "Disconnected")

        .build();

    private static final Map<String, Map<String, Template>> SQL_TEMPLATES_BY_PROVIDER = new HashMap<>();

    public static String getErrorMessage(int errcode) {

        String msg = ERRMSGS.get(errcode);

        msg = ToolsLocator.getI18nManager().getTranslation(msg);

        return msg;

    }

    public static void copy(OnlineEntity source, OnlineEntityEditable target, Predicate<String> excludes) {

        if (excludes == null || !excludes.test(ENTITY_DESCRIPTION)) {

            target.setDescription(source.getDescription());

        }

        if (excludes == null || !excludes.test(ENTITY_CODE)) {

            target.setEntityCode(source.getEntityCode());

        }

        if (excludes == null || !excludes.test(ENTITY_NAME)) {

            target.setEntityName(source.getEntityName());

        }

        if (excludes == null || !excludes.test(ENTITY_FEATUREIDFIELDNAME)) {

            target.setFeatureIdFieldName(source.getFeatureIdFieldName());

        }

        if (excludes == null || !excludes.test(ENTITY_FEATURETYPEASJSON)) {

            target.setFeatureTypeAsJson(source.getFeatureTypeAsJson());

        }

        if (excludes == null || !excludes.test(ENTITY_FIELDFORLABEL)) {

            target.setFieldForLabel(source.getFieldForLabel());

        }

        if (excludes == null || !excludes.test(ENTITY_GEOMETRYFIELDNAME)) {

            target.setGeometryFieldName(source.getGeometryFieldName());

        }

        if (excludes == null || !excludes.test(ENTITY_LABEL)) {

            target.setLabel(source.getLabel());

        }

        if (excludes == null || !excludes.test(ENTITY_DATA_MODELS)) {

            target.setDataModels(source.getDataModels());

        }

        if (excludes == null || !excludes.test(ENTITY_CRS)) {

            target.setCRS(source.getCRS());

        }

    }

    public static JsonObjectBuilder toJsonBuilder(OnlineEntity entity, Predicate<String> excludes) {

        JsonObjectBuilder jsonEntity = Json.createObjectBuilder();

        if( excludes==null || !excludes.test(ENTITY_DESCRIPTION) ) {

            jsonEntity.add(ENTITY_DESCRIPTION, entity.getDescription());

        }

        if( excludes==null || !excludes.test(ENTITY_CODE) ) {

            jsonEntity.add(ENTITY_CODE, entity.getEntityCode());

        }

        if( excludes==null || !excludes.test(ENTITY_NAME) ) {

            jsonEntity.add(ENTITY_NAME, entity.getEntityName());

        }

        if( excludes==null || !excludes.test(ENTITY_FEATUREIDFIELDNAME) ) {

            jsonEntity.add(ENTITY_FEATUREIDFIELDNAME, entity.getFeatureIdFieldName());

        }

        if( excludes==null || !excludes.test(ENTITY_FEATURETYPEASJSON) ) {

            jsonEntity.add(ENTITY_FEATURETYPEASJSON, entity.getFeatureTypeAsJson());

        }

        if( excludes==null || !excludes.test(ENTITY_FIELDFORLABEL) ) {

            jsonEntity.add(ENTITY_FIELDFORLABEL, entity.getFieldForLabel());

        }

        if( excludes==null || !excludes.test(ENTITY_GEOMETRYFIELDNAME) ) {

            jsonEntity.add(ENTITY_GEOMETRYFIELDNAME, entity.getGeometryFieldName());

        }

        if( excludes==null || !excludes.test(ENTITY_LABEL) ) {

            jsonEntity.add(ENTITY_LABEL, entity.getLabel());

        }

        if( excludes==null || !excludes.test(ENTITY_DATA_MODELS) ) {

            jsonEntity.add(ENTITY_DATA_MODELS, entity.getDataModels());

        }

        if( excludes==null || !excludes.test(ENTITY_CRS) ) {

            if( entity.getCRS()!=null ) {

                jsonEntity.add(ENTITY_CRS, entity.getCRS());

            }

        }

        if( excludes==null || !excludes.test(ENTITY_CUSTOMDATA) ) {

            if( StringUtils.isNotBlank(entity.getCustomData()) ) {

                jsonEntity.add(ENTITY_CUSTOMDATA, entity.getCustomData());

            }

        }

        return jsonEntity;

    }

    public static void fromJson(OnlineEntityEditable entity, JsonObject jsonEntity) {

        if( jsonEntity.containsKey(ENTITY_DESCRIPTION) ) {

            entity.setDescription(jsonEntity.getString(ENTITY_DESCRIPTION, null));

        }

        if( jsonEntity.containsKey(ENTITY_CODE) ) {

            entity.setEntityCode(jsonEntity.getString(ENTITY_CODE, null));

        }

        if( jsonEntity.containsKey(ENTITY_NAME) ) {

            entity.setEntityName(jsonEntity.getString(ENTITY_NAME, null));

        }

        if( jsonEntity.containsKey(ENTITY_FEATUREIDFIELDNAME) ) {

            entity.setFeatureIdFieldName(jsonEntity.getString(ENTITY_FEATUREIDFIELDNAME, null));

        }

        if( jsonEntity.containsKey(ENTITY_FEATURETYPEASJSON) ) {

            entity.setFeatureTypeAsJson(jsonEntity.getString(ENTITY_FEATURETYPEASJSON, null));

        }

        if( jsonEntity.containsKey(ENTITY_FIELDFORLABEL) ) {

            entity.setFieldForLabel(jsonEntity.getString(ENTITY_FIELDFORLABEL, null));

        }

        if( jsonEntity.containsKey(ENTITY_GEOMETRYFIELDNAME) ) {

            entity.setGeometryFieldName(jsonEntity.getString(ENTITY_GEOMETRYFIELDNAME, null));

        }

        if( jsonEntity.containsKey(ENTITY_LABEL) ) {

            entity.setLabel(jsonEntity.getString(ENTITY_LABEL, null));                

        }

        if( jsonEntity.containsKey(ENTITY_DATA_MODELS) ) {

            entity.setDataModels(jsonEntity.getString(ENTITY_DATA_MODELS, null));                

        }

        if( jsonEntity.containsKey(ENTITY_CRS) ) {

            entity.setCRS(jsonEntity.getString(ENTITY_CRS, null));                

        }

        if( jsonEntity.containsKey(ENTITY_CUSTOMDATA) ) {

            entity.setCustomData(jsonEntity.getString(ENTITY_CUSTOMDATA, null));                

        }

    }

    public static String getOperationLabel(int operation) {

        return OPERATION_LABELS.getOrDefault(operation, "unknown");

    }

    public static String getStateLabel(int state) {

        return STATE_LABELS.getOrDefault(state, "unknown");

    }

    private static class Template {

        List<String> parameters;

        Map<String,String> constants;

        String code;

        String name;

        public Template(String name) {

            this.name = name;

            this.parameters = new ArrayList<>();

            this.constants = new HashMap<>();

            this.code = null;

        }

        public void setCode(String code) {

            this.code = code;

        }

        public void addParameter(String parameter) {

            this.parameters.add(parameter);

        }

        public void addConstant(String name, String value) {

            this.constants.put(name, value);

        }

        public String getName() {

            return this.name;

        }

        public String getCode(Object...params) {

            if( this.parameters.isEmpty() ) {

                return String.format(this.code, params);

            }

            String s = this.code;

            for (int i = 0; i < parameters.size(); i++) {

                s = s.replace("%"+parameters.get(i)+"$", "%"+(i+1)+"$");

            }

            for (Map.Entry<String, String> entry : constants.entrySet()) {

                String cname = entry.getKey();

                String cvalue = entry.getValue();

                s = s.replace("%"+cname+"$s", cvalue);

            }

            if( ArrayUtils.isEmpty(params) ) {

                return s;

            }

            s = String.format(s, params);

            return s;

        }

        @Override

        public String toString() {

            return this.name;

        }

    }

    @SuppressWarnings("null")

    private static Map<String,Template> getSqlTemplates(String name) {

      final int SEARCHING_ITEM = 0;

      final int READING_ITEM = 1;

      InputStream sqls = OnlineUtils.class.getResourceAsStream("/org/gvsig/online/lib/"+name+".sql"); 

      Map<String,Template> expecteds = new HashMap<>();

      List<String> lines;

        try {

            lines = IOUtils.readLines(sqls);

        } catch (IOException ex) {

            throw new RuntimeException("Can't read sql templates for provider "+name, ex);

        }

      StringBuilder sb = null;

      Template currentItem = null;

      int lineno = 1;

      int state = SEARCHING_ITEM;

      for (String line : lines) {

          line = line + "\n";

          switch(state) {

            case SEARCHING_ITEM:

                if( line.toLowerCase().startsWith("@begin ") ) {

                    currentItem = new Template(line.substring(7).trim());

                    sb = new StringBuilder();

                    state = READING_ITEM;

                } else if( line.toLowerCase().startsWith("-- ") || line.toLowerCase().startsWith("@rem") ) {

                    // do nothing skip comment

                } else if( !StringUtils.isBlank(line) ) {

                    throw new IllegalStateException("Syntax error at '"+name+"', line "+lineno+ ".");

                }

                break;

            case READING_ITEM:

                if( line.toLowerCase().startsWith("@end ") ) {

                    String found = line.substring(5).trim();

                    if( !StringUtils.equals(currentItem.getName(),found) ) {

                      throw new IllegalStateException("Syntax error at '"+name+"', line "+lineno+ ", expected @end "+currentItem.getName()+", and found "+line+".");

                    }

                    String s = sb.toString();

                    if( s.endsWith("\n") ) {

                        s = s.substring(0, s.length()-1);

                    }

                    currentItem.setCode(s);

                    expecteds.put(currentItem.getName(), currentItem);

                    state = SEARCHING_ITEM;

                } else if( line.toLowerCase().startsWith("-- ") || line.toLowerCase().startsWith("@rem") ) {

                    // do nothing skip comment

                } else if( line.toLowerCase().startsWith("@param ") ) {

                    currentItem.addParameter(line.substring(7).trim());

                } else if( line.toLowerCase().startsWith("@const ") ) {

                    String s = line.substring(7).trim();

                    String[] ss = StringUtils.split(s, "=");

                    currentItem.addConstant(ss[0].trim(),ss[1].trim());

                } else {

                    sb.append(line);

                }

                break;

        }

        lineno++;

      }

      if( state!=SEARCHING_ITEM ) {

          throw new IllegalStateException("Syntax error at '"+name+"', expected @end "+currentItem.getName()+" and found EOF .");

      }

      return expecteds;

    }

    public static String getSqlTemplate(String providerName, String sqlId, Object... args){

        if(SQL_TEMPLATES_BY_PROVIDER.get(providerName) == null) {

            SQL_TEMPLATES_BY_PROVIDER.put(providerName, getSqlTemplates(providerName));

        }

        Template template = SQL_TEMPLATES_BY_PROVIDER.get(providerName).get(sqlId);

        if( template==null ) {

            return null;

        }

        return template.getCode(args);

    }

    public static void updateMessageDigest(MessageDigest md, Feature f, String fieldName) {

        String s = f.getString(fieldName);

        if( s!=null ) {

            md.update(s.getBytes(StandardCharsets.UTF_8));

        }

    }

    public static String getFirst(String s) {

        if( StringUtils.isBlank(s) ) {

            return null;

        }

        try{

            String[] ss = StringUtils.split(s, ",");

            if( ss.length<1 ) {

                return null;

            }

            return ss[0];

        } catch (Exception ex) {

            return null;

        }

    }

    public static List<String> getAsList(String s) {

        return getAsList(s, true);

    }

    public static List<String> getAsList(String s, boolean toLowerCase) {

        if( StringUtils.isBlank(s) ) {

            return Collections.EMPTY_LIST;

        }

        try{

            List<String> l = new ArrayList<>();

            String[] ss = StringUtils.split(s, ",");

            for (String s1 : ss) {

                if (StringUtils.isBlank(s1)) {

                    continue;

                }

                if (toLowerCase) {

                    l.add(s1.trim().toLowerCase());

                } else {

                    l.add(s1.trim());

                }

            }

            return l;

        } catch (Exception ex) {

            return Collections.EMPTY_LIST;

        }

    }

    public static String getLabelOrName(OnlineEntity entity) {

        String label = entity.getLabel();

        if (StringUtils.isBlank(label)) {

            label = entity.getEntityName();

        }

        return label;

    }

    public static String getFormatedLabel(OnlineEntity entity, String template) {

        try {

            StringSubstitutor sub = new StringSubstitutor(new StringLookup() {

                @Override

                public String lookup(String key) {

                    if (StringUtils.equalsIgnoreCase("label", key)) {

                        return entity.getLabel();

                    }

                    if (StringUtils.equalsIgnoreCase("name", key)) {

                        return entity.getEntityName();

                    }

                    if (StringUtils.equalsIgnoreCase("code", key)) {

                        return entity.getEntityCode();

                    }

                    if (StringUtils.equalsIgnoreCase("datamodels", key)) {

                        return entity.getDataModels();

                    }

                    if (StringUtils.equalsIgnoreCase("description", key)) {

                        return entity.getDescription();

                    }

                    return "";

                }

            });

            String s = sub.replace(template);

            if( StringUtils.isBlank(s) ) {

                s = getLabelOrName(entity);

            }

            return s;

        } catch (Throwable th) {

            return getLabelOrName(entity);

        }

    }

    public static URL getURL(URL base, String s) {

        return getURL(base.toString(),s);

    }

    public static URL getURL(String base, String s) {

        try {

            String base_s = StringUtils.removeEnd(base.toString(), "/");

            if( StringUtils.startsWith(s, "/") ) {

                return new URL(base_s+s);

            }

            return new URL(base_s+"/"+s);

        } catch (MalformedURLException ex) {

            throw new RuntimeException("Can't get URL",ex);

        }

    }

}