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.swing.impl;

import java.awt.Color;

import java.awt.Component;

import java.awt.Font;

import java.awt.font.TextAttribute;

import java.io.IOException;

import java.io.InputStream;

import java.net.URL;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import java.util.Objects;

import java.util.Properties;

import java.util.Set;

import javax.swing.ImageIcon;

import javax.swing.JOptionPane;

import javax.swing.SwingUtilities;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.fmap.dal.DALLocator;

import org.gvsig.fmap.dal.DataManager;

import org.gvsig.fmap.dal.DataStoreParameters;

import org.gvsig.fmap.dal.StoresRepository;

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

import org.gvsig.fmap.dal.store.jdbc.JDBCStoreParameters;

import org.gvsig.fmap.geom.Geometry;

import org.gvsig.fmap.geom.GeometryUtils;

import org.gvsig.fmap.geom.primitive.Envelope;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

import org.gvsig.online.swing.api.OnlineSwingLocator;

import org.gvsig.online.swing.api.OnlineSwingManager;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.dataTypes.Coercion;

import org.gvsig.tools.dataTypes.CoercionException;

import org.gvsig.tools.i18n.I18nManager;

import org.gvsig.tools.swing.api.DataTypes;

import org.gvsig.tools.swing.api.ToolsSwingLocator;

import org.gvsig.tools.swing.api.threadsafedialogs.ThreadSafeDialogsManager;

import org.gvsig.tools.swing.icontheme.IconTheme;

import org.gvsig.tools.util.MapBuilder;

import org.slf4j.LoggerFactory;

/**

 *

 * @author gvSIG Team

 */

public class OnlineSwingCommons {

    public static final String BOOKMARKSANDHISTORY_SITE_URL = "OnlineSiteURL";

    private static final org.slf4j.Logger LOGGER = LoggerFactory.getLogger(OnlineSwingCommons.class);

    private static final String ID_COLOR_LOCAL_NEW = "COLOR_LOCAL_NEW";

    private static final String ID_COLOR_LOCAL_MODIFIED = "COLOR_LOCAL_MODIFIED";

    private static final String ID_COLOR_LOCAL_UNMODIFIED = "COLOR_LOCAL_UNMODIFIED";

    private static final String ID_COLOR_LOCAL_AND_REPOSITORY_MODIFIED = "COLOR_LOCAL_AND_REPOSITORY_MODIFIED";

    private static final String ID_COLOR_REPOSITORY_NEW = "COLOR_REPOSITORY_NEW";

    private static final String ID_COLOR_REPOSITORY_MODIFIED = "COLOR_REPOSITORY_MODIFIED";

    private static final String ID_COLOR_CONFLICT = "COLOR_CONFLICT";

    private static final String ID_COLOR_UNKNOWN_STATE = "COLOR_UNKNOWN_STATE";

    private static final String ID_COLOR_DISCONNECTED_STATE = "COLOR_DISCONNETED_STATE";

    private static final Color COLOR_LOCAL_NEW = Color.GREEN.darker();

    private static final Color COLOR_LOCAL_MODIFIED = Color.BLUE.darker();

    private static final Color COLOR_LOCAL_UNMODIFIED = Color.BLACK;

    private static final Color COLOR_LOCAL_AND_REPOSITORY_MODIFIED = Color.RED.brighter();

    private static final Color COLOR_REPOSITORY_NEW = Color.ORANGE.darker().darker();

    private static final Color COLOR_REPOSITORY_MODIFIED = Color.MAGENTA.darker();

    private static final Color COLOR_CONFLICT = Color.RED;

    private static final Color COLOR_UNKNOWN_STATE = Color.LIGHT_GRAY;

    private static final Color COLOR_DISCONNECTED_STATE = Color.DARK_GRAY;

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

            .add(OP_DELETE, "_Online_operation_delete")

            .add(OP_UPDATE, "_Online_operation_update")

            .add(OP_INSERT, "_Online_operation_insert")

//            .add(OP_ADD_ENTITY, "_Online_operation_add_entity")

            .build();

    private static Map<String, Color> entityColors = null;

    static {

        loadColors();

    }

    public static String getHTMLColorTag(Color color, String text) {

        return getHTMLColorTag(color, false, text);

    }

    public static String getHTMLColorTag(Color color, boolean bold, String text) {

        return getHTMLColorTag(color, bold, false, text);

    }

    public static String getHTMLColorTag(Color color, boolean bold, boolean strikethrough, String text) {

        String pattern;

        if( bold && strikethrough ) {

            pattern = "<html><font color='rgb(%s, %s, %s)'><b><s>%s</b></s></font></html>";

        } else if( bold ) {

            pattern = "<html><font color='rgb(%s, %s, %s)'><b>%s</b></font></html>";

        } else if( strikethrough ) {

                pattern = "<html><font color='rgb(%s, %s, %s)'><s>%s</s></font></html>";            

        } else {

            pattern = "<html><font color='rgb(%s, %s, %s)'>%s</font></html>";

        }

        String tag = String.format(pattern, 

            color.getRed(),

            color.getGreen(),

            color.getBlue(),

            text

        );

        return tag;

    }

    public static String getHTMLFontColorTag(Color color, boolean bold, boolean strikethrough, String text) {

        String pattern;

        if( bold && strikethrough ) {

            pattern = "<font color='rgb(%s, %s, %s)'><b><s>%s</b></s></font>";

        } else if( bold ) {

            pattern = "<font color='rgb(%s, %s, %s)'><b>%s</b></font>";

        } else if( strikethrough ) {

                pattern = "<font color='rgb(%s, %s, %s)'><s>%s</s></font>";            

        } else {

            pattern = "<font color='rgb(%s, %s, %s)'>%s</font>";

        }

        String tag = String.format(pattern, 

            color.getRed(),

            color.getGreen(),

            color.getBlue(),

            text

        );

        return tag;

    }

    public static String getHTMLColorTag(int state, String text) {

        switch (state) {

            case STATE_CORRUPT:

            case STATE_CORRUPT+STATE_DISCONNECTED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_DISCONNECTED_STATE), false, true, text);

            case STATE_DISCONNECTED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_DISCONNECTED_STATE), false, text);

            case STATE_LOCAL_UNMODIFIED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_LOCAL_UNMODIFIED), false, text);

            case STATE_LOCAL_NEW:

                return getHTMLColorTag(entityColors.get(ID_COLOR_LOCAL_NEW), false, text);

            case STATE_LOCAL_MODIFIED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_LOCAL_MODIFIED), false, text);

            case STATE_LOCAL_OUTDATED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_REPOSITORY_MODIFIED), false, text);

            case STATE_LOCAL_OUTDATED_AND_MODIFIED:

                return getHTMLColorTag(entityColors.get(ID_COLOR_LOCAL_AND_REPOSITORY_MODIFIED), false, text);

            case STATE_CONFLICT:

                return getHTMLColorTag(entityColors.get(ID_COLOR_CONFLICT), false, text);

            case STATE_REMOTE_NEW:

                return getHTMLColorTag(entityColors.get(ID_COLOR_REPOSITORY_NEW), false, text);

            default:

                return getHTMLColorTag(entityColors.get(ID_COLOR_UNKNOWN_STATE), false, text);

        }

    }

    public static String getHTMLColorTag(OnlineWorkingcopy workspace, String entityName) {

        if( workspace == null ) {

            return entityName;

        }

        OnlineEntity lentity = workspace.getWorkspaceEntity(entityName);

        if( lentity==null ) {

            return getHTMLColorTag(STATE_REMOTE_NEW,entityName);

        }

        return getHTMLColorTag(lentity.getState(),entityName);

    }

    public static String getStateDescription(OnlineWorkingcopy workspace, String entityName) {

        if( workspace == null ) {

            return getStateDescription(STATE_UNKNOWN);

        }

        OnlineEntity lentity = workspace.getWorkspaceEntity(entityName);

        if( lentity==null ) {

            return getStateDescription(STATE_REMOTE_NEW);

        }

        return getStateDescription(lentity.getState());

    }

    public static String getStateDescription(int state) {

        I18nManager i18n = ToolsLocator.getI18nManager();

        switch (state) {

            case STATE_DISCONNECTED:

                return i18n.getTranslation("_Disconnected");

            case STATE_CORRUPT:

                return i18n.getTranslation("_Corrupt");

            case STATE_CORRUPT+STATE_DISCONNECTED:

                return i18n.getTranslation("_Corrupt")+"/"+i18n.getTranslation("_Disconnected");

            case STATE_LOCAL_UNMODIFIED:

                return i18n.getTranslation("_Unmodified_locally");

            case STATE_LOCAL_NEW:

                return i18n.getTranslation("_New_locally");

            case STATE_LOCAL_MODIFIED:

                return i18n.getTranslation("_Modified_locally");

            case STATE_LOCAL_OUTDATED:

                return i18n.getTranslation("_Modified_in_the_remote");

            case STATE_LOCAL_OUTDATED_AND_MODIFIED:

                return i18n.getTranslation("_Modified_in_the_remote_and_locally");

            case STATE_CONFLICT:

                return i18n.getTranslation("_Conflict");

            case STATE_REMOTE_NEW:

                return i18n.getTranslation("_New_in_the_remote");

            case STATE_NOT_IN_LOCAL_OR_REMOTE:

                return i18n.getTranslation("_It_is_not_in_local_or_in_the_remote");

            default:

                return i18n.getTranslation("_Unknow_state");

        }

    }

    public static void setColorCompoment(Component c, Color color, boolean bold) {

        setColorCompoment(c, color, bold, false);

    }

    public static void setColorCompoment(Component c, Color color, boolean bold, boolean strikethrough) {

        if( bold ) {

            Font f = c.getFont();

            Map attributes = f.getAttributes();

            attributes.put(TextAttribute.WEIGHT, TextAttribute.WEIGHT_BOLD);

            c.setFont(c.getFont().deriveFont(attributes));

        }

        c.setForeground(color);

    }

    public static void setColorCompoment(Component c, int state) {

        switch (state) {

            case STATE_CORRUPT:

            case STATE_CORRUPT+STATE_DISCONNECTED:

                setColorCompoment(c, entityColors.get(ID_COLOR_DISCONNECTED_STATE), false, true);

                break;

            case STATE_DISCONNECTED:

                setColorCompoment(c, entityColors.get(ID_COLOR_DISCONNECTED_STATE), false);

                break;

            case STATE_LOCAL_UNMODIFIED:

                setColorCompoment(c, entityColors.get(ID_COLOR_LOCAL_UNMODIFIED), false);

                break;

            case STATE_LOCAL_NEW:

                setColorCompoment(c, entityColors.get(ID_COLOR_LOCAL_NEW), false);

                break;

            case STATE_LOCAL_MODIFIED:

                setColorCompoment(c, entityColors.get(ID_COLOR_LOCAL_MODIFIED), false);

                break;

            case STATE_LOCAL_OUTDATED:

                setColorCompoment(c, entityColors.get(ID_COLOR_REPOSITORY_MODIFIED), false);

                break;

            case STATE_LOCAL_OUTDATED_AND_MODIFIED:

                setColorCompoment(c, entityColors.get(ID_COLOR_LOCAL_AND_REPOSITORY_MODIFIED), false);

                break;

            case STATE_CONFLICT:

                setColorCompoment(c, entityColors.get(ID_COLOR_CONFLICT), false);

                break;

            case STATE_REMOTE_NEW:

                setColorCompoment(c, entityColors.get(ID_COLOR_REPOSITORY_NEW), false);

                break;

            default:

                setColorCompoment(c, entityColors.get(ID_COLOR_UNKNOWN_STATE), false);

                break;

        }

    }

    public static boolean notInSwingThreadInvokeLater(Runnable x) {

        if( SwingUtilities.isEventDispatchThread() ) {

            return false;

        }

        SwingUtilities.invokeLater(x);

        return true;

    }

    public static void cleanHighligthed() {

        OnlineManager manager = OnlineLocator.getOnlineManager();

        OnlineSwingManager swingManager = OnlineSwingLocator.getOnlineSwingManager();

        swingManager.getDefaultServices().cleanHighligthed();

    }

    public static void refreshDocument(FeatureStore store) {

//        OnlineManager manager = OnlineLocator.getOnlineManager();

        OnlineSwingManager swingManager = OnlineSwingLocator.getOnlineSwingManager();

        swingManager.getDefaultServices().refreshDocument(store);

    }

    public static void refreshDocument(Set<FeatureStore> stores) {

//        OnlineManager manager = OnlineLocator.getOnlineManager();

        OnlineSwingManager swingManager = OnlineSwingLocator.getOnlineSwingManager();

        swingManager.getDefaultServices().refreshDocument(stores);

    }

    public static Geometry createBBox(Geometry geom1, Geometry geom2){

        if(geom1 == null && geom2 == null){

            return null;

        }

        Envelope env = GeometryUtils.createEnvelope(Geometry.SUBTYPES.GEOM2D);

        if(geom1 != null){

            env.add(geom1);

        }

        if(geom2 != null){

            env.add(geom2);

        }

        return env.getGeometry();

    }

    public static boolean showAuthenticationErrors(String title, OnlineRuntimeException ex) {

        return showAuthenticationErrors(title, ex.getErrnum(), ex.getMessage());

    }

    public static boolean showAuthenticationErrors(String title, int errNum) {

        return showAuthenticationErrors(title, errNum, null);

    }

    public static boolean showAuthenticationErrors(String title, int errNum, String message) {

        if(StringUtils.isBlank(message)){

            message = OnlineLocator.getOnlineManager().getErrorMessage(errNum);

        }

        switch (errNum) {

            case ERR_CANT_AUTHENTICATE_USER:

            case ERR_INVALID_AUTHENTICATION_TOKEN:

            case ERR_USER_NOT_AUTHORIZED:

            case ERR_AUTHENTICATION_EXPIRED:

            case ERR_INVALID_USERCODE:

                ThreadSafeDialogsManager dialogs = ToolsSwingLocator.getThreadSafeDialogsManager();

                I18nManager i18n = ToolsLocator.getI18nManager();

                dialogs.messageDialog(

                        "[" + errNum + "] " + message,

                        i18n.getTranslation(title),

                        JOptionPane.WARNING_MESSAGE

                );

                return true;

        }

        return false;

    }

    public static boolean showAuthenticationRequiredMessage(String title) {

        ThreadSafeDialogsManager dialogs = ToolsSwingLocator.getThreadSafeDialogsManager();

        I18nManager i18n = ToolsLocator.getI18nManager();

        dialogs.messageDialog(

                i18n.getTranslation("_Authorization_required_for_this_operation"),

                i18n.getTranslation(title),

                JOptionPane.WARNING_MESSAGE

        );

        return true;

    }

    private static void loadColors() {

        entityColors = new HashMap<>();

        entityColors.put(ID_COLOR_LOCAL_NEW,COLOR_LOCAL_NEW);

        entityColors.put(ID_COLOR_LOCAL_MODIFIED,COLOR_LOCAL_MODIFIED);

        entityColors.put(ID_COLOR_LOCAL_UNMODIFIED,COLOR_LOCAL_UNMODIFIED);

        entityColors.put(ID_COLOR_LOCAL_AND_REPOSITORY_MODIFIED,COLOR_LOCAL_AND_REPOSITORY_MODIFIED);

        entityColors.put(ID_COLOR_REPOSITORY_NEW,COLOR_REPOSITORY_NEW);

        entityColors.put(ID_COLOR_REPOSITORY_MODIFIED,COLOR_REPOSITORY_MODIFIED);

        entityColors.put(ID_COLOR_CONFLICT,COLOR_CONFLICT);

        entityColors.put(ID_COLOR_UNKNOWN_STATE,COLOR_UNKNOWN_STATE);

        entityColors.put(ID_COLOR_DISCONNECTED_STATE,COLOR_DISCONNECTED_STATE);

        InputStream x = OnlineSwingCommons.class.getClassLoader().getResourceAsStream("/VCSGisEntityColors.properties");

        Coercion toColor = ToolsLocator.getDataTypesManager().getCoercion(DataTypes.COLOR);

        if(x != null){

            try {

                Properties prop = new Properties();

                prop.load(x);

                for (Map.Entry<Object, Object> entry : prop.entrySet()) {

                    try {

                        entityColors.put((String)entry.getKey(), (Color) toColor.coerce(entry.getValue()));

                    } catch (CoercionException ex) {

                        LOGGER.trace("Can't parse color "+Objects.toString(entry.getKey()), ex);

                        //DO NOTHING

                    }

                }

            } catch (IOException ex) {

                LOGGER.trace("Can't load colors.", ex);

                //DO NOTHING

            }

        }

    }

    public static boolean hasConflictTheDatamodelWithOtherModelAlreadyRegistered(OnlineWorkingcopy workspace, String dataModelName) {

        DataManager dataManager = DALLocator.getDataManager();

        String wsUrl = workspace.getExplorerParameters().getUrl();

        StoresRepository globalRepository = dataManager.getStoresRepository();

        for (OnlineEntity entity : workspace.getWorkspaceEntities()) {

            List<String> entityModels = entity.getDataModelsAsList();

            if( entityModels.contains(dataModelName) ) {

                DataStoreParameters params = globalRepository.get(entity.getEntityName());

                if( params instanceof JDBCStoreParameters ) {

                    String registeredUrl = ((JDBCStoreParameters) params).getUrl();

                    if( !StringUtils.equals(wsUrl, registeredUrl)) {

                        return true;

                    }

                }

            }

        }

        return false;

    }

    public static ImageIcon loadImage(String imageName) {

        String name = FilenameUtils.getBaseName(imageName);

        IconTheme theme = ToolsSwingLocator.getIconThemeManager().getDefault();

        if (theme.exists(name)) {

            return theme.get(name);

        }

        URL url = OnlineSwingCommons.class.getResource("images/"+name + ".png");

        if (url == null) {

            return null;

        }

        return new ImageIcon(url);

    }    

    public static String getOperationLabel(int operation) {

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

    }

}