Application: gvSIG desktop

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <modelVersion>4.0.0</modelVersion>

    <artifactId>org.gvsig.desktop.framework</artifactId>

    <packaging>pom</packaging>

    <name>${project.artifactId}</name>

    <parent>

        <groupId>org.gvsig</groupId>

        <artifactId>org.gvsig.desktop</artifactId>

        <version>2.0.288</version>

    </parent>

    <modules>

        <module>org.gvsig.andami</module>

        <module>org.gvsig.andami.updater</module>

    </modules>

    <description>Contains the launcher and plugin framework used in gvSIG.</description>

</project>

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami;

import junit.framework.Test;

import junit.framework.TestSuite;

public class AllTests {

	public static Test suite() {

		TestSuite suite = new TestSuite("Test for com.iver.andami");

		//$JUnit-BEGIN$

		//$JUnit-END$

		return suite;

	}

}

<!--

    gvSIG. Desktop Geographic Information System.

    Copyright (C) 2007-2013 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, write to the Free Software

    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

    MA  02110-1301, USA.

    For any additional information, do not hesitate to contact us

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

-->

<assembly>

  <id>gvsig-andami-package</id>

  <formats>

    <format>zip</format>

  </formats>

  <baseDirectory>.</baseDirectory>

  <!-- 

  <includeBaseDirectory>true</includeBaseDirectory>

   -->

  <files>

    <file>

      <source>target/${project.artifactId}-${project.version}.jar</source>

      <outputDirectory>lib</outputDirectory>

    </file>

    <file>

      <source>src/main/resources/default-log4j/log4j.properties</source>

      <outputDirectory>.</outputDirectory>

    </file>  

  </files>

  <fileSets>

    <fileSet>

      <directory>src/main/resources-application</directory>

      <outputDirectory>.</outputDirectory>

    </fileSet>

    <fileSet>

      <directory>src/main/resources/org/gvsig/andami</directory>

      <outputDirectory>i18n/andami</outputDirectory>

    </fileSet>

  </fileSets>

  <dependencySets>

    <dependencySet>

      <useProjectArtifact>false</useProjectArtifact>

      <useTransitiveDependencies>true</useTransitiveDependencies>

      <outputDirectory>lib</outputDirectory>

    </dependencySet>

  </dependencySets>

</assembly>

package org.gvsig.andami;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

public interface Arguments extends Iterable<String> {

    public String get(String name);

    public Object get(String name, Object defaultValue);

    public boolean contains(String name);

    public boolean contains(String name, String value);

    public Map<String,String> flags();

    public List<String> parameters();

    public int size();

    public String get(int n);

    public Iterator<String> iterator();

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.andami.actioninfo.ActionInfoManager;

import org.gvsig.andami.ui.mdiFrame.MainFrame;

import org.gvsig.tools.locator.AbstractLocator;

import org.gvsig.tools.locator.Locator;

import org.gvsig.tools.locator.LocatorException;

public class PluginsLocator extends AbstractLocator {

    private static final String LOCATOR_NAME = "PluginsLocator";

    /**

     * PluginsManager name used by the locator to access the instance

     */

    public static final String PLUGINS_MANAGER_NAME = "PluginsManager";

    public static final String PLUGINS_ACTIONINFO_MANAGER_NAME = "PluginsActionInfoManager";

    public static final String PLUGINS_LOCALE_MANAGER_NAME = "LocaleManager";

    private static final String PLUGINS_MANAGER_DESCRIPTION = "PluginsManager of Andami framework";

    private static final String PLUGINS_ACTIONINFO_MANAGER_DESCRIPTION = "PluginsActionInfoManager";

    private static final String PLUGINS_LOCALE_MANAGER_DESCRIPTION = "LocaleManager";

    /**

     * Unique instance.

     */

    private static final PluginsLocator INSTANCE = new PluginsLocator();

    /**

     * Return the singleton instance.

     *

     * @return the singleton instance

     */

    public static PluginsLocator getInstance() {

        return INSTANCE;

    }

    /**

     * Returns the Locator name.

     *

     * @return String containing the locator name.

     */

    @Override

    public String getLocatorName() {

        return LOCATOR_NAME;

    }

    /**

     * Return a reference to PluginsManager.

     *

     * @return a reference to PluginsManager

     * @throws LocatorException

     *             if there is no access to the class or the class cannot be

     *             instantiated

     * @see Locator#get(String)

     */

    public static PluginsManager getManager() throws LocatorException {

        return (PluginsManager) getInstance().get(PLUGINS_MANAGER_NAME);

    }

    public static PluginsManager getPluginsManager() throws LocatorException {

        return (PluginsManager) getInstance().get(PLUGINS_MANAGER_NAME);

    }

    /**

     * Registers the Class implementing the PluginsManager interface.

     *

     * @param clazz

     *            implementing the PluginsManager interface

     */

    public static void registerManager(Class clazz) {

        getInstance().register(PLUGINS_MANAGER_NAME, PLUGINS_MANAGER_DESCRIPTION,

                clazz);

    }

    /**

     * Registers a class as the default PluginsManager.

     *

     * @param clazz

     *            implementing the DataManager interface

     */

    public static void registerDefaultManager(Class clazz) {

        getInstance().registerDefault(PLUGINS_MANAGER_NAME, PLUGINS_MANAGER_DESCRIPTION,

                clazz);

    }

    public static ActionInfoManager getActionInfoManager() throws LocatorException {

        return (ActionInfoManager) getInstance().get(PLUGINS_ACTIONINFO_MANAGER_NAME);

    }

    public static void registerActionInfoManager(Class clazz) {

        getInstance().register(PLUGINS_ACTIONINFO_MANAGER_NAME, PLUGINS_ACTIONINFO_MANAGER_DESCRIPTION,

                clazz);

    }

    public static MainFrame getMainFrame() {

        return Launcher.getFrame();

    }

    public static LocaleManager getLocaleManager() throws LocatorException {

        return (LocaleManager) getInstance().get(PLUGINS_LOCALE_MANAGER_NAME);

    }

    public static void registerLocaleManager(Class clazz) {

        getInstance().register(PLUGINS_LOCALE_MANAGER_NAME, PLUGINS_LOCALE_MANAGER_DESCRIPTION,

                clazz);

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami;

import org.gvsig.andami.actioninfo.impl.DefaultActionInfoManager;

import org.gvsig.andami.firewall.DefaultFirewallConfiguration;

import org.gvsig.andami.impl.DefaultLocaleManager;

import org.gvsig.andami.impl.DefaultPluginsManager;

import org.gvsig.andami.installer.icontheme.IconThemeInstallerFactory.RegisterIconThemeInstaller;

import org.gvsig.andami.installer.translations.TranslationsInstallerFactory.RegisterTranslationsInstaller;

import org.gvsig.andami.ui.mdiFrame.DefaultThreadSafeDialogs;

import org.gvsig.andami.ui.mdiManager.WindowInfo;

import org.gvsig.installer.lib.api.InstallerLibrary;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.library.AbstractLibrary;

import org.gvsig.tools.library.LibraryException;

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

import org.gvsig.tools.util.Caller;

import org.gvsig.tools.util.impl.DefaultCaller;

public class PluginsLibrary extends AbstractLibrary {

    @Override

    public void doRegistration() {

        registerAsAPI(PluginsLibrary.class);

        require(InstallerLibrary.class);

    }

    protected void doInitialize() throws LibraryException {

        PluginsLocator.registerDefaultManager(DefaultPluginsManager.class);

        PluginsLocator.registerActionInfoManager(DefaultActionInfoManager.class);

        PluginsLocator.registerLocaleManager(DefaultLocaleManager.class);

        ToolsLocator.registerDefaultFirewallManager(DefaultFirewallConfiguration.class);

        ToolsSwingLocator.registerThreadSafeDialogsManager(DefaultThreadSafeDialogs.class);

        // Force initialize of the LocaleManager

        PluginsLocator.getLocaleManager();

    }

    protected void doPostInitialize() throws LibraryException {

        Caller caller = new DefaultCaller();

        caller.add(new WindowInfo.RegisterPersistence() );

        caller.add(new RegisterTranslationsInstaller() );

        caller.add(new RegisterIconThemeInstaller() );

        if( !caller.call() ) {

            throw new LibraryException(PluginsLibrary.class, caller.getExceptions());

        }

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.help;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import java.awt.event.KeyEvent;

import java.io.File;

import java.net.MalformedURLException;

import java.net.URL;

import java.net.URLClassLoader;

import java.text.MessageFormat;

import java.util.ArrayList;

import java.util.Iterator;

import java.util.Locale;

import javax.help.HelpSet;

import javax.swing.JComponent;

import javax.swing.KeyStroke;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class Help  {

	private static Help help = null;

	private HelpSet mainHS = null;

	private ArrayList resources = new ArrayList();

	private ArrayList helps = new ArrayList();

	private HelpPanel window=null;

	public static Help getHelp() {

		if( help == null ) {

			help = new Help();

		}

		return help;

	}

	private Logger log() {

		return LoggerFactory.getLogger("org.gvsig");

	}

	public void show() {

		log().info("show()");

		show(null);

	}

	public void show(String id) {

		try {

			log().info("show(id) id="+id);

			initHelp();

			try {

				window.showWindow(id);

			}catch(NullPointerException e) {

				window = new AndamiHelpPanel(mainHS, id);

				window.showWindow();

			}

		} catch (Exception ex) {

			log().error("Se ha producido un error mostrando la ventana de ayuda.",ex);

		}

	}

	public void enableHelp(JComponent comp, String id)

	{

		try{

			initHelp();

			comp.registerKeyboardAction(new DisplayHelpFromFocus(id), KeyStroke.getKeyStroke(KeyEvent.VK_F1, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);

		}

		catch(Exception except){

			log().error("ID: "+id+" erronea");

		}

	}

	public boolean addResource(String path) {

		URL url = null;

		try {

			url =  (new File(path)).toURL();

		} catch (MalformedURLException e) {

			return false;

		}

		resources.add(url);

		return true;

	}

	public boolean addHelp(String helpName) {

		helps.add(helpName);

		return true;

	}

	private void initHelp()

	{

		if ( mainHS != null ) {

			return;

		}

		//

		// Obtenemos un array de URLs de array list de URLs

		//

		URL urls[] = new URL[resources.size()];

		int i=0;

	    for( Iterator it=resources.iterator(); it.hasNext() ;) {

	    	urls[i++] = (URL) it.next();

	    }

	    //

	    // Creamos la lista de helpsets que han de componer

	    // la ayuda

	    //

	    ArrayList helpSets = new ArrayList();

	    for( Iterator it=helps.iterator(); it.hasNext() ;) {

	    	String name = (String) it.next();

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

	    	HelpSet hs = createHelpSet(urls, name + "/" + lang + "/help.hs");

	    	if( hs == null ) {

	    		lang = "en";

	    		hs = createHelpSet(urls, name + "/" + lang + "/help.hs");

	    	}

	    	if( hs != null ) {

	    		helpSets.add(hs);

	    	}

	    }

	    //

	    // Fijamos el primer helpset de la lista como master y

	    // le a?adimos (merge) a este los demas helpsets

	    //

	    Iterator it=helpSets.iterator();

	    if( ! it.hasNext() ) {

	    	return;

	    }

	    mainHS = (HelpSet) it.next();

	    while( it.hasNext() ) {

			try {

		    	mainHS.add( (HelpSet) it.next() );

			} catch (Exception ex) {

				log().error(ex.toString());

			}

	    }

	}

	private HelpSet createHelpSet(URL resources[], String hsName) {

		HelpSet hs = null;

		ClassLoader loader = ClassLoader.getSystemClassLoader();

	    loader = new URLClassLoader(resources, loader);

	    URL url = HelpSet.findHelpSet(loader, hsName);

		if (url == null) {

			log().error(

					MessageFormat.format(

							"No se ha encontrado el helpset ''{0}''.",

							new Object[] { hsName }

					)

			);

			return null;

		}

		log().info("createHelpSet:  url="+url);

		try {

			hs = new HelpSet(null, url);

		} catch (Exception ex) {

			log().error(

				MessageFormat.format(

					"No se ha podido cargar el helpset desde ''{0}''.",

					new Object[] { url }

				),

			    ex

			);

			return null;

		}

		return hs;

	}

    public class DisplayHelpFromFocus implements ActionListener {

	private String id = null;

        public DisplayHelpFromFocus(String id) {

        	log().info("DisplayHelpFromFocus(id) id="+id);

            this.id=id;

        }

		public void actionPerformed(ActionEvent e) {

			Help.getHelp().show(this.id);

	    }

    }

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.help;

import java.awt.BorderLayout;

import java.awt.Frame;

import java.awt.event.ComponentEvent;

import java.awt.event.ComponentListener;

import javax.help.BadIDException;

import javax.help.HelpSet;

import javax.help.JHelp;

import javax.swing.JPanel;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class HelpPanel extends JPanel  {

	private static final long serialVersionUID = 4164482247505362337L;

	public static int WIDTH = 645;

	public static int HEIGHT = 495;

	private String title = null;

	private JHelp jh;

	private Logger log() {

		return LoggerFactory.getLogger("org.gvsig");

	}

	public HelpPanel(HelpSet hs){

		log().info("HelpPanel(hs)");

		init(hs,null);

	}

	public HelpPanel(HelpSet hs, String id){

		log().info("HelpPanel(hs,id) id="+id);

		init(hs,id);

	}

	private void init(HelpSet hs, String id){

		jh = new JHelp(hs);

		log().info("init() ID "+ id);

		if (id != null) {

			try {

				log().info("init() setCurrentID "+ id);

				jh.setCurrentID(id);

			} catch (BadIDException ex) {

				log().error(ex.toString());

			} catch (NullPointerException ex) {

				log().error(ex.toString());

			}

		}

		String hsTitle = hs.getTitle();

		if (hsTitle == null || hsTitle.equals("")) {

			hsTitle = "gvSIG Help";

		}

		title = hsTitle;

		setLayout(new BorderLayout());

		add(jh,BorderLayout.CENTER);

	}

	public void showWindow() {

		log().info("showWindow()");

		Frame frame = new Frame();

        frame.add(this);

        frame.setSize(WIDTH, HEIGHT + 30);

        frame.setTitle(getTitle());

        frame.setResizable(true);

		this.setVisible(true);

		frame.show();

	}

	public void showWindow(String id) {

		if (id != null) {

			try {

				log().info("showWindow(id) -> setCurrentID "+ id);

				jh.setCurrentID(id);

			} catch (BadIDException ex) {

				log().error(ex.toString());

			}

		}

		String hsTitle = jh.getHelpSetPresentation().getTitle();

		if (hsTitle == null || hsTitle.equals("")) {

			hsTitle = "gvSIG Help";

		}

		title = hsTitle;

		showWindow();

	}

	public String getTitle() {

		return this.title;

	}

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.help;

import javax.help.HelpSet;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.ui.mdiManager.IWindow;

import org.gvsig.andami.ui.mdiManager.MDIManager;

import org.gvsig.andami.ui.mdiManager.WindowInfo;

public class AndamiHelpPanel extends HelpPanel implements IWindow {

	private static final long serialVersionUID = 2683827167020046672L;

	private WindowInfo info = null ;

	public AndamiHelpPanel(HelpSet hs){

		super(hs);

	}

	public AndamiHelpPanel(HelpSet hs, String id){

		super(hs,id);

	}

	public void showWindow() {

		MDIManager mdim = PluginServices.getMDIManager();

		mdim.addWindow((IWindow) this);

	}

	public WindowInfo getWindowInfo() {

		if( info == null ) {

			info = new WindowInfo( WindowInfo.RESIZABLE |

	                WindowInfo.MAXIMIZABLE | WindowInfo.MODELESSDIALOG);

			info.setHeight(HEIGHT);

			info.setWidth(WIDTH);

			info.setTitle(getTitle());

		}

		return info;

	}

	public Object getWindowProfile() {

		return WindowInfo.TOOL_PROFILE;

	}

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.actioninfo;

import java.awt.event.ActionListener;

import java.util.Collection;

import java.util.Map;

import javax.swing.Action;

import javax.swing.ImageIcon;

import javax.swing.KeyStroke;

import org.gvsig.tools.lang.Cloneable;

import org.gvsig.andami.PluginServices;

import org.gvsig.andami.plugins.IExtension;

/**

 * Esta entidad representa a una accion dentro de gvSIG, que podra ser usada

 * por menus, botones de la toolbar, menus contextuales, o desde cualquier

 * otro elemento de gvSIG que precise invocar a una accion.

 * 

 * La accion esta compuesta por una definicion de cual es su etiqueta, su

 * icono, teclas aceleradoras, su tip, o su posicion respecto a otras acciones, 

 * junto con una extension (IExtension) que aporta el codigo de la accion.

 * 

 *  Una accion responde principalmente a cuatro operaciones:

 *  

 *  - isActive, que nos indica si la accion esta activa, es decir, si 

 *    debera presentarse al usuario o no. Si una extension no esta activa,

 *    los metodos isVisible y isEnabled retornaran siempre false, sin invocar

 *    al codigo de la extension asociada a la accion.

 *    

 *  - isVisible, que nos indica si la accion debera presentarse o no en el

 *    interface de usuario. De forma general podemos asumir que cuando se

 *    invoque a este metodo se delegara en el metodo isVisible de la extension

 *    asociada a la accion.

 *    

 *  - isEnabled, que nos indica si la accion debera estar habilitada o no en 

 *    el interface de usuario. De forma general podemos asumir que cuando se

 *    invoque a este metodo se delegara en el metodo isEnabled de la extension

 *    asociada a la accion.

 *    

 *  - execute, que provocara que se ejecute el codigo asociado a la accion.  

 *    De forma general podemos asumir que cuando se invoque a estos metodo se 

 *    delegara en el metodo execute de la extension asociada a esta accion, pasandole

 *    el "command" de la accion como parametro.

 *    

 * Ademas de la definicion de la accion, esta tambien puede disponer de una coleccion

 * de acciones hacia las que puede ser redirigida. Esto es, en un momento dado

 * nos puede interesar que cuando sea invocada la accion "A", en lugar de ejecutarse

 * las operaciones de esta, se ejecuten las operaciones de otra accion "B". Esto nos

 * permite atrapar la ejecucion de una accion independientemente de desde donde se este 

 * invocando. Cuando una accion tenga asignadas otras acciones a las que redirigir

 * su ejecucion, solo se redigira a una de ellas, la primera en la coleccion de acciones a

 * redirigir que responda "true" a su metodo isEnabled, y en caso de que no responda true

 * ninguna se ejecutara el codigo de la accion original. El orden de la coleccion de

 * acciones a las que redirigir de una accion sera el orden inverso en el que se han

 * ido registrandose las redirecciones. Asi primero se intentara con la ultima redireccion

 * asignada, luego con la anterior, y asi sucesivamente se recorreran todas las redireccion

 * hasta que una responda "true" a su isEnabled, ejecutandose entonces el codigo de esta.

 * 

 * 

 * @author jjdelcerro

 *

 */

public interface ActionInfo extends Action, ActionListener, Cloneable {

	public static final String ACCELERATOR = "ACCELERATOR";

	public static final String ACTIVE = "ACTIVE"; 

	public static final String VISIBLE = "VISIBLE";

	public static final String PLUGIN_NAME = "PLUGIN_NAME";

	public static final String PLUGIN = "PLUGIN";

	public static final String EXTENSION_NAME = "EXTENSION_NAME";

	public static final String EXTENSION = "EXTENSION";

	public static final String REDIRECTIONS = "REDIRECTIONS";

	public static final String REDIRECTION = "REDIRECTION";

	public static final String POSITION = "POSITION";

	public static final String TOOLTIP = "TOOLTIP";

	public static final String ICON_NAME = "ICON_NAME";

	/**

	 * returns the plugin of the extension asociated to the action.

	 * 

	 * @return pluginServices asiciated to the action.

	 */

	public PluginServices getPlugin();

	/**

	 * returns the extension asociated to the action. The action 

	 * delegates the methods isEnabled, isVisible and execute in this

	 * extension when these are invoked.

	 * 

	 * @return IExtension asociated to the action

	 */

	public IExtension getExtension();

	/**

	 * Return the plugin name of the plugin asociated to the action.

	 * This is a utility method checkins null values. is equivalent to:

	 * 

	 *   action.getPlugin().getPluginName()

	 * 

	 * 

	 * @return plugin name

	 * @see #getPlugin()

	 */

	public String getPluginName();

	/**

	 * Returns the extension name of the extension asociated to this action.

	 * This a utility method that check null values. Is equivalent to:

	 * 

	 *   action.getExtension().getClass().getName()

	 *   

	 * @return extension name.

	 * @see #getExtension()

	 */

	public String getExtensionName();

	/**

	 * Returns the name of the action. This name is usaed to retrieve the 

	 * action thwros the manager.

	 * 

	 * @return action name

	 */

	public String getName();

	/**

	 * Return a label asociated to the action. This label can be used

	 * in buttons, o menus.

	 * 

	 * @return label of action

	 */

	public String getLabel();

	/**

	 * Returns the command used for invoking the execute method of

	 * the extension asociated to this action.

	 * 

	 * @return command of action

	 */

	public String getCommand();

	/**

	 * Return an icon asociated to the action. This icon can be used

	 * in buttons, o menus.

	 * 

	 * @return ImageIcon asociated tho the action

	 */

	public ImageIcon getIcon();

	/**

	 * Returns the name of icon asociated to the action. This name is

	 * used to retrive the icon from the current icon theme of the application.

	 *   

	 * @return icon name.

	 */

	public String getIconName();

	/**

	 * returns a representation human readable of the accelerator to be used 

	 * associated to the action.

	 * 

	 * @return String representing the accelerator

	 */

	public String getAccelerator();

	/**

	 * returns the KeyStroke which represents the accelerator of this

	 * action.

	 * 

	 * @return keystroke asociated to this action

	 * @see #getAccelerator()

	 */

	public KeyStroke getKeyStroke();

	/**

	 * Return a string that represents a tip asociated whit the action,

	 * usually used as tooltip in buttons or menus.

	 * 

	 * @return the tip of the action

	 */

	public String getTooltip();

	/**

	 * Return the position absolute of the action referred to all actions.

	 * 

	 * @return the position of the action

	 */

	public long getPosition();

	/**

	 * retrurn if the action can be visible in the user interface or not.

	 * This method call the isVisible of the extension asociated to the action,

	 * unless the action is inactive.

	 * If has a ExclusiveUIExtension set, then this is invoqued instead of the

	 * the isVisible of the extension.

	 *  

	 * @return if the action if visible for the user.

	 */

	public boolean isVisible();

	/**

	 * retrurn if the action is enables.

	 * This method call the isEnabled of the extension asociated to the action,

	 * unless the action is inactive.

	 * This method is used to determine whether it is possible to redirect 

	 * to this action or not.

	 * If has a ExclusiveUIExtension set, then this is invoqued instead of the

	 * the isEnabled of the extension.

	 *  

	 * @return if the action if visible for the user.

	 */

	public boolean isEnabled();

	/**

	 * Execute the code asociated to the action.

	 * This method call the execute method of the asociated exetnsion using the

	 * command of action as argument.

	 * If the action is redirected try to call to the redirected actions.

	 *  

	 */

	public void execute();

	/**

	 * Execute the code asociated to the action.

	 * Pass the args to the execute of the asociated extension.

	 *

	 *  @see #execute()

	 */

	public void execute(Object[] args);

	public void execute(Map args);

	/**

	 * Execute the code asociated to the action.

	 * Pass the args to the execute of the asociated extension.

	 *

	 *  @see #execute()

	 */

	public void execute(Object arg);

	/**

	 * Return true is the action is active. When an action is active the methods

	 * isEnable and isVisible call the methods of the extension asociated to this.

	 * When is inactive always return false.

	 * 

	 * @return if the action is active

	 */

	public boolean isActive();

	/**

	 * Set the active state of an ActionInfo.

	 * When the active state is set to false, isEnabled, and isVisible

	 * returns false.

	 * 

	 * @param active

	 */

	public void setActive(boolean active);

	/**

	 * 

	 * An action can redirect the execution of the execute, isVisible and isEnabled methods

	 * to other action. Using this method is can be query and set this redirections.

	 * The redirect will be established only if the method isEnabled of target action

	 * returns true. Otherwise execute methods of initial action.

	 * 

	 * @return the redirections established for this action

	 */

	public Collection<ActionInfo> getRedirections();

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.actioninfo;

public interface ActionInfoStatusCache {

	public void clear();

	public boolean isEnabled(ActionInfo action);

	public boolean isVisible(ActionInfo action);

}

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2013 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, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA  02110-1301, USA.

 *

 * 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.andami.actioninfo.impl;

import java.util.HashMap;

import java.util.Map;

import org.gvsig.andami.actioninfo.ActionInfo;

import org.gvsig.andami.actioninfo.ActionInfoStatusCache;

import org.gvsig.andami.plugins.ExtensionHelper;

import org.gvsig.andami.plugins.IExtension;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.identitymanagement.SimpleIdentity;

import org.gvsig.tools.identitymanagement.SimpleIdentityManager;

public class DefaultActionInfoStatusCache implements ActionInfoStatusCache {

        private SimpleIdentityManager identityManager;

        private class Status {

		Boolean isEnabled = null;

		Boolean isVisible = null;

	}

	private Map<IExtension,Status> extensions = null;

	private Map<ActionInfo,Status> actions = null;

	public DefaultActionInfoStatusCache() {

		this.clear();

	}

        @Override

	public void clear() {

		extensions = new HashMap<>();

		actions = new HashMap<>();

	}

        private SimpleIdentityManager getIdentityManager() {

            if( this.identityManager == null ) {

                this.identityManager = ToolsLocator.getIdentityManager();

            }

            return this.identityManager;

        }

        private SimpleIdentity getCurrentUser() {

            return this.getIdentityManager().getCurrentIdentity();

        }

        @Override

	public boolean isEnabled(ActionInfo action) {

                if( !this.getCurrentUser().isAuthorized(action.getName()) ) {

                    return false;

                }

                if (!action.isActive()) {

                    //logger.info("isEnabled(), action {} not active", action.getName());

                    return false;

                }                Status status; 

		IExtension extension = action.getExtension();

		if( extension == null ) {

			return false;

		}

		if( ExtensionHelper.canQueryByAction(extension) ) {

			status = actions.get(action);

			if( status == null ) {

				status = new Status();

				actions.put(action, status);

			}

			if( status.isEnabled == null ) {

				status.isEnabled = action.isEnabled();

			}

		} else {

			status = extensions.get(extension);

			if( status == null ) {

				status = new Status();

				extensions.put(extension, status);

			}

			if( status.isEnabled == null ) {

				status.isEnabled = extension.isEnabled();

			}

		}

		return status.isEnabled;

	}

        @Override

	public boolean isVisible(ActionInfo action) {

                if( !this.getCurrentUser().isAuthorized(action.getName()) ) {

                    return false;

                }

                if (!action.isActive()) {

                    //logger.info("isVisible(), action {} not active", action.getName());

                    return false;

                }

                Status status; 

		IExtension extension = action.getExtension();

		if( extension == null ) {

			return false;

		}

		if( ExtensionHelper.canQueryByAction(extension) ) {

			status = actions.get(action);

			if( status == null ) {

				status = new Status();

				actions.put(action, status);

			}

			if( status.isVisible == null ) {

				status.isVisible = action.isVisible();

			}

		} else {

			status = extensions.get(extension);

			if( status == null ) {

				status = new Status();

				extensions.put(extension, status);

			}

			if( status.isVisible == null ) {

				status.isVisible = extension.isVisible();

			}

		}

		return status.isVisible;

	}

}

/**

 * 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, write to the Free Software Foundation, Inc., 51

 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 *

 * 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.andami.actioninfo.impl;

import java.io.File;

import java.io.FileInputStream;

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Properties;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang3.BooleanUtils;

import org.apache.commons.lang3.StringUtils;

import org.gvsig.andami.PluginsLocator;

import org.gvsig.andami.actioninfo.ActionInfo;

import org.gvsig.andami.actioninfo.ActionInfoManager;

import org.gvsig.andami.actioninfo.ActionInfoStatusCache;

import org.gvsig.andami.plugins.IExtension;

import org.gvsig.tools.ToolsLocator;

import org.gvsig.tools.identitymanagement.SimpleIdentityManager;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

@SuppressWarnings("UseSpecificCatch")

public class DefaultActionInfoManager implements ActionInfoManager {

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

    private final Map<String, ActionInfo> actions = new HashMap<>();

    private int anonymousCounter = 1;

    private Properties activeStates = null;

    @Override

    public ActionInfo createAction(Class<? extends IExtension> extension, String name, String text, String command, String icon, String accelerator, long position, String tip) {

        String actionName = name;

        if ( StringUtils.isBlank(actionName) ) {

            actionName = String.format("anonymous__%04d", this.anonymousCounter++);

        }

        ActionInfo action = new DefaultActionInfo(extension, actionName, text, command, icon, accelerator, position, tip);

        ActionInfo previous = this.getAction(action.getName());

        if (previous != null) {

            ((DefaultActionInfo) action).merge(previous);

        }

        if (name == null) {

            LOGGER.info("createAction: name of action is null/empty, rename to '" + actionName + "' (" + action.toString() + ").");

        }

        if (action.getLabel() == null && action.getIconName() == null) {

            LOGGER.info("createAction(name='" + name + "'): text and icon of action is null");

        }

        return action;

    }

    @Override

    public ActionInfo createAction(IExtension extension, String name, String text, String command, String icon, String accelerator, long position, String tip) {

        String actionName = name;

        if ( StringUtils.isBlank(actionName) ) {

            actionName = String.format("anonymous__%04d", this.anonymousCounter++);

        }

        ActionInfo action = new DefaultActionInfo(extension, actionName, text, command, icon, accelerator, position, tip);

        ActionInfo previous = this.getAction(action.getName());

        if (previous != null) {

            ((DefaultActionInfo) action).merge(previous);

        }

        if (name == null) {

            LOGGER.info("createAction: name of action is null/empty, rename to '" + actionName + "' (" + action.toString() + ").");

        }

        if (action.getLabel() == null && action.getIconName() == null) {

            LOGGER.info("createAction(name='" + name + "'): text and icon of action is null");

        }

        return action;

    }

    @Override

    public ActionInfo registerAction(ActionInfo action) {

        return this.registerAction(action, false);

    }

    @Override

    public ActionInfo registerAction(ActionInfo action, boolean override) {

        if (action == null) {

            // Avisamos en el log de que se intenta registrar una accion null, intentado

            // sacar el stack para que se pueda ver quien lo esta haciendo, pero no

            // provocamos un error, solo retornamos null.

            try {

                throw new IllegalArgumentException();

            } catch (IllegalArgumentException e) {

                LOGGER.info("registerAction(null).", e);

            }

            return null;

        }

        ActionInfo previous = this.getAction(action.getName());

        if (previous != null) {

            if( override ) {

                this.actions.put(action.getName(), action);

            } else {

                ((DefaultActionInfo) previous).merge(action);

                action = previous;

            }

        } else {

            this.actions.put(action.getName(), action);

            SimpleIdentityManager identityManager = ToolsLocator.getIdentityManager();

            identityManager.registerAction(action.getName());

        }

        this.updateActiveState(action);

        return action;

    }

    private void updateActiveState(ActionInfo action) {

        if( activeStates==null ) {

            this.activeStates = new Properties();

            File home = PluginsLocator.getManager().getApplicationHomeFolder();

            File states = new File(home,"actions-states.properties");

            if( states.exists() ) {

                FileInputStream fis = null;

                try {

                    fis = new FileInputStream(states);