Application: gvSIG desktop » gvSIG scripting

        public String getMimeType();

package org.gvsig.scripting;

public interface ScriptingData extends ScriptingUnit {

}

import org.gvsig.tools.service.spi.ProviderFactory;

 * There are two top level management roles within ScriptingFramework: logical

 * and User's Interface (UI) management.

 * This class is responsible of the logical role. It provides all the services

 * to manage the information used in ScriptingFramework.

    public static final String UNIT_SCRIPT = "Script";

    public static final String UNIT_DIALOG = "Dialog";

    public static final String UNIT_FOLDER = "Folder";

    public void setHomeFolder(File home);

    public File getHomeFolder();

    /**

     * Returns the System's Folder

     *

     * @return a {@link ScriptingFolder} with the System's Folder.

     */

    public ScriptingFolder getSystemFolder();

    /**

     * Returns the User's Folder

     *

     * @return a {@link ScriptingFolder} with the User's Folder.

     */

    public ScriptingFolder getUserFolder();

    public List<ScriptingFolder> getAlternativeUserFolders();

    public void addAlternativeUserFolder(File f, String name, String description);

    /**

     * Returns the {@link ScriptingBaseScript} associated with the file

     * specified

     *

     * @param file File where is contained the {@link ScriptingBaseScript}'s

     * information

     *

     * @return {@link ScriptingBaseScript}

     */

    /**

     * Returns the {@link ScriptingFolder} associated with the file specified

     *

     * @param file File where is contained the {@link ScriptingFolder}'s

     * information

     *

     * @return {@link ScriptingFolder}

     */

    /**

     * Returns the path of the User's Folder

     *

     * @return a String with the path of the User's Folder

     */

    /**

     * Registers a File System with {@link ScriptingUnit}s in the SystemFolder

     *

     * @param name String with the identificator name of the File System

     * registered

     * @param folder File with the root of the File System to register

     */

    public List<String> getSupportedLanguages();

    public String getExtensionOfLanguage(String language);

    public String getEngineNameByLanguage(String langName);

     * Checks if an id is unique in a determinate folder

     *

     * @param folder {

     * @ScriptingFolder} with the directory to verify the id

     * @param id String with the id to validate

     *

     * @return true if there isn't another {@link ScriptingUnit} with the same

     * id, and false in the other case

    public boolean validateUnitId(ScriptingFolder folder, String id);

     * Sets a key/value pair in the state of the ScriptingManager that may

     * either create a Java Language Binding to be used in the execution of

     * scripts

     *

     * @param key The name of named value to add

     * @param value The value of named value to add.

    public void put(String key, Object value);

    /**

     * Retrieves a value set in the state of this ScriptingManager

     *

     * @param key The key whose value is to be returned

     *

     * @return an Object with the value corresponding to the key

     */

    public Object get(String key);

    /**

     * Gets the Help manager

     *

     * @return a {@link ScriptingHelpManager}

     *

     * @see ScriptingHelpManager

     */

    public ScriptingHelpManager getHelpManager();

    public void addLibFolder(File lib);

    public File getRootUserFolder();

    public ProviderFactory getInstallerFactory();

    /**

     * Devuelbe la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     * 

     * @return 

     */

    public File getPackagesFolder();

    /**

     * Establece la carpeta en la que se encuentran los paquetes

     * de la aplicacion.

     * @param folder 

     */

    public void setPackagesFolder(File folder);

        public List<ScriptingFolder> getUnitFolders();

package org.gvsig.scripting;

import org.gvsig.tools.observer.WeakReferencingObservable;

public interface ScriptingText extends ScriptingData, WeakReferencingObservable {

    public String getText();

    public void setText(String text);

    public void save();

    public String getMimeType();

}

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

<actions>

        <action>

            <actionName>CUSTOM-dependency:tree</actionName>

            <displayName>dependency:tree</displayName>

            <recursive>false</recursive>

            <goals>

                <goal>dependency:tree</goal>

            </goals>

        </action>

    </actions>

def main() {

  printf "hola\n"

}

function main() {

  print("hola\n");

}

__file__ = script.getFile().getAbsolutePath()

def __init_python_path():

    import sys

    # Add folder of script

    path = script.getFile().getParentFile().getCanonicalPath()

    if not path in sys.path:

      sys.path.append(path)

    # Add folder of root user scripts

    path = script.getManager().getUserFolder().getFile().getCanonicalPath()

    if not path in sys.path:

      sys.path.append(path)

    # Add folders of libs

    folders = script.getManager().getLibFolders()

    if folders != None:

        for folder in folders:

            path = folder.getCanonicalPath()

            if not path in sys.path:

              sys.path.append(path)

    # Add the scripts folder of system folders

    folders = script.getManager().getSystemFolder()

    if folders != None:

        for folder in folders.getUnits():

            path = folder.getFile().getCanonicalPath()

            if not path in sys.path:

              sys.path.append(path)

def use_plugin(pluginName):

  from org.gvsig.andami import PluginsLocator

  pluginsManager = PluginsLocator.getManager()

  other = pluginsManager.getPlugin(pluginName)

  scripting = pluginsManager.getPlugin("org.gvsig.scripting.app.extension")

  scripting.addDependencyWithPlugin(other)

def use_jar(fname, root=__file__):

  from java.io import File

  import sys

  import os

  if isinstance(fname,File):

    f = fname

    fname = f.getPath()

  else:

    f = File(fname)

  if not f.isAbsolute() :

    rf = File(root)

    if rf.isFile() :

      rf = rf.getParentFile()

    f = File( rf,fname)

  fname = f.getCanonicalPath()

  if not fname in sys.path:

    sys.path.append(fname) 

__init_python_path()

from gvsig import *

def main(*args):

    #Remove this lines and add here your code

    print "hola mundo"

    pass

main <- function() {

    cat( "Hello\n" );

}

public class DefaultScriptingDialog extends DefaultScriptingScript implements ScriptingDialog, ActionListener {

    private static final Logger logger = LoggerFactory.getLogger(DefaultScriptingDialog.class);

    private int showMode;

    public DefaultScriptingDialog(ScriptingFolder parent, ScriptingManager manager, String id) {

        super(parent, ScriptingManager.UNIT_DIALOG, manager, id);

        this.setMainName("onload");

        this.showMode = MODE_WINDOW;

    }

    @Override

    public void runAsTask(Object[] args) {

        // Los dialogos no se ejecutan en otro hilo.

        this.run(args);

    }

    @Override

    public Object run(Object args[]) {

        ScriptingUIManager uimanager = ScriptingSwingLocator.getUIManager();

        JThinlet thinlet = uimanager.createJThinlet();

        thinlet.addActionListener(this);

        thinlet.load(this.getFileResource(".dlg"));

        this.put("dialog", thinlet.getThinlet());

        this.compile();

        try {

            this.invokeFunction(this.getMainName(), args);

        } catch (ExecuteErrorException ex) {

            Throwable e = ex.getCause();

            if (e instanceof NoSuchMethodException) {

                // When running from the composer messages of stdout shows in the console tab.

                System.out.println("Code of dialog do not has function '" + this.getMainName() + "'.");

            } else {

                throw ex;

            }

        }

        switch (this.getShowMode()) {

            case MODE_WINDOW:

                // When running from the composer messages of stdout shows in the console tab.

                System.out.println("Showing dialog as window " + this.getName() + ".");

                uimanager.showWindow(thinlet, this.getName());

                break;

            case MODE_TOOL:

                // When running from the composer messages of stdout shows in the console tab.

                System.out.println("Showing dialog as tool " + this.getName() + ".");

                uimanager.showTool(thinlet, this.getName());

                break;

            default:

                // When running from the composer messages of stdout shows in the console tab.

                System.out.println("Showing dialog as dialog " + this.getName() + ".");

                uimanager.showDialog(thinlet, this.getName());

                break;

        }

        return null;

    }

    @Override

    protected void loadInf(Ini prefs) {

        super.loadInf(prefs);

        this.showMode = Integer.parseInt(getInfValue(prefs, "Dialog", "showMode", MODE_WINDOW).toString());

    }

    @Override

    protected void save(Ini prefs) {

        super.save(prefs);

        prefs.put("Dialog", "showMode", this.showMode);

    }

    @Override

    public String[] getIconNames() {

        return new String[]{

            "scripting_dialog",

            "scripting_dialog_open"

        };

    }

    @Override

    public void actionPerformed(ActionEvent arg0) {

        try {

            this.invokeFunction(arg0.getActionCommand(), null);

        } catch (Throwable e) {

            // Ignore, invokeFunction handle error it self.

        }

    }

    @Override

    public File getDialogFile() {

        return this.getFileResource(".dlg");

    }

    @Override

    public int getShowMode() {

        return this.showMode;

    }

    @Override

    public void setShowMode(int mode) {

        this.showMode = mode;

    }

    @Override

    public boolean remove() {

        boolean r = super.remove();

        File folder = this.getParent().getFile();

        File f = new File(folder, this.getId() + ".dlg");

        try {

            FileUtils.forceDelete(f);

        } catch (IOException e) {

            logger.warn("Can't remove dialog file '" + f.getAbsolutePath() + "'.", e);

            r = false;

        }

        return r;

    }

    @Override

    public void create(ScriptingFolder folder, String id, String language) {

        super.create(folder, id, language);

        File fileDlg = this.getResource(this.getId() + ".dlg");

        try {

            fileDlg.createNewFile();

        } catch (IOException e) {

            logger.warn("Can't create the dialog in '" + fileDlg.getAbsolutePath() + "'.", e);

        }

        // Escribimos en el fichero '.dlg' lo mi?nimo para que pueda ejecutarse

        Writer output;

        try {

            output = new BufferedWriter(new FileWriter(fileDlg));

            output.write("<?xml version=\"1.0\" encoding=\"ISO-8859-1\"?>\n<panel/>");

            output.close();

        } catch (IOException e) {

            logger.warn("Can't write xml code of the dialog to '" + fileDlg.getAbsolutePath() + "'.", e);

        }

        this.save();

    }

    @Override

    public String getMimeType() {

        return "text";

    }

/* gvSIG. Geographic Information System of the Valencian Government

 *

 * Copyright (C) 2007-2008 Infrastructures and Transports Department

 * of the Valencian Government (CIT)

 * 

 * 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 2

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

 * 

 */

package org.gvsig.scripting.impl;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

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

import org.gvsig.installer.lib.api.execution.InstallPackageServiceException;

import org.gvsig.installer.lib.spi.InstallPackageProviderServices;

import org.gvsig.installer.lib.spi.InstallerProviderLocator;

import org.gvsig.installer.lib.spi.InstallerProviderManager;

import org.gvsig.installer.lib.spi.execution.InstallPackageProvider;

import org.gvsig.scripting.ScriptingLocator;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.tools.service.spi.AbstractProvider;

import org.gvsig.tools.service.spi.ProviderServices;

public class ScriptingInstallerProvider extends AbstractProvider

    implements InstallPackageProvider {

    public ScriptingInstallerProvider(ProviderServices providerServices) {

        super(providerServices);

    }

    public void install(File applicationDirectory, InputStream inputStream,

        PackageInfo packageInfo) throws InstallPackageServiceException {

    	ScriptingManager scriptingManager = ScriptingLocator.getManager();

    	File target = scriptingManager.getRootUserFolder();

        try {

            InstallerProviderManager installerProviderManager =

                InstallerProviderLocator.getProviderManager();

            InstallPackageProviderServices installerProviderServices =

                installerProviderManager.createInstallerProviderServices();

            installerProviderServices.decompress(inputStream, target);

        } catch (Exception e) {

            throw new InstallPackageServiceException(e);

        }

    }

    public void installLater(File applicationDirectory,

        InputStream inputStream, PackageInfo packageInfo)

        throws InstallPackageServiceException, IOException {

        // TODO Auto-generated method stub

    }

}

import java.io.InputStream;

import org.apache.commons.io.IOUtils;

import org.apache.commons.lang3.StringUtils;

        ScriptingScript {

    private static final Logger logger = LoggerFactory.getLogger(DefaultScriptingScript.class);

    protected String langName;

    protected String extension = null;

    protected ScriptEngine engine = null;

    protected CompiledScript compiledCode;

    private String code = null;

    private String mainName = "main";

    private boolean saved;

    private final DelegateWeakReferencingObservable delegatedObservable;

    protected DefaultScriptingScript(ScriptingFolder parent, String typename, ScriptingManager manager, String id) {

        super(parent, typename, manager, id);

        this.setLangName("python");

        this.setSaved(true);

        this.delegatedObservable = new DelegateWeakReferencingObservable(this);

    }

    public DefaultScriptingScript(ScriptingFolder parent, ScriptingManager manager, String id) {

        this(parent, ScriptingManager.UNIT_SCRIPT, manager, id);

    }

    public Object __getattr__(String name) {

        ScriptEngine engine = this.getEngine();

        this.compile();

        return engine.get(name);

    }

    public void __setattr__(String name, Object value) {

        ScriptEngine engine = this.getEngine();

        this.compile();

        engine.put(name, value);

    }

    public Object __call__() {

        return this.run();

    }

    public Object __call__(Object[] args) {

        return this.run(args);

    }

    protected void notifyErrors(Exception exception, String command) {

        this.delegatedObservable.notifyObservers(new BaseScriptingNotifycation(

                this, BaseScriptingNotifycation.RUNTIME_ERROR_NOTIFICATION,

                command, exception));

    }

    @Override

    public void setSaved(boolean saved) {

        this.saved = saved;

    }

    @Override

    public String getCode() {

        if (this.code == null) {

            File f = null;

            try {

                f = this.getFileResource(this.extension);

                this.code = FileUtils.readFileToString(f);

            } catch (IOException e) {

                String fname = (f == null) ? "(null)" : f.getAbsolutePath();

                logger.warn("Can't load code from file '" + fname + "'.");

            }

        }

        return this.code;

    }

    @Override

    public void setCode(String code) {

        this.code = code;

        this.engine = null;

        this.compiledCode = null;

        this.setSaved(false);

    }

    protected String getCodeToInitializeEngine() {

        String name = "org/gvsig/scripting/langs/"+this.getLangName().toLowerCase()+"/init.txt";

        try {

            InputStream template = this.getClass().getClassLoader().getResourceAsStream(name);

            if( template == null ) {

                return null;

            }

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

            return StringUtils.join(lines, "\n");

        } catch (Exception ex) {

            logger.warn("Can't load code to initialize the script from '"+name+".",ex);

            return null;

        }

    }

    protected ScriptEngine getEngine() {

        if (this.engine == null) {

            ScriptEngine scriptEngine = this.manager.getEngineByLanguage(langName);

            scriptEngine.put("script", this);

            this.engine = scriptEngine;

            String code = this.getCodeToInitializeEngine();

            if (code != null) {

                try {

                    this.engine.eval(code);

                } catch (Exception ex) {

                    logger.warn("Can't initialize engine with the code:\n" + code, ex);

                }

            }

        }

        return this.engine;

    }

    @Override

    protected void loadInf(Ini prefs) {

        super.loadInf(prefs);

        this.setMainName((String) getInfValue(prefs, "Script", "main", "main"));

        this.setLangName((String) getInfValue(prefs, "Script", "Lang",

                this.getLangName()));

    }

    @Override

    public void load(ScriptingFolder folder, String id) {

        this.setId(id);

        this.setParent(folder);

        String extension = FilenameUtils.getExtension(id);

        if( extension != null ) {

            String language = this.manager.getLanguageOfExtension(extension);

            if( language != null ) {

                this.setLangName(language);

            }

            this.setExtension(extension);

        }

        File f = getFileResource(".inf");

        if (f.isFile()) {

            Ini prefs = null;

            try {

                prefs = new Ini(f);

            } catch (Exception e) {

                logger.warn("Can't load 'inf' file '" + f.getAbsolutePath() + "'.", e);

            }

            loadInf(prefs);

        }

        this.setSaved(true);

    }

    @Override

    public void save() {

        File f = getFileResource(".inf");

        if (!f.isFile()) {

            try {

                f.createNewFile();

            } catch (Exception e) {

                logger.warn("Can't create 'inf' file '" + f.getAbsolutePath() + "'.", e);

            }

        }

        Ini prefs = null;

        try {

            prefs = new Ini(f);

        } catch (Exception e) {

            logger.warn("Can't load 'inf' file '" + f.getAbsolutePath() + "'.", e);

        }

        save(prefs);

        // Guardo el codigo en el fichero

        File fcode = this.getFileResource(this.getExtension());

        try {

            FileUtils.write(fcode, this.getCode());

        } catch (Exception e) {

            logger.warn("Can't write code to file '" + fcode.getAbsolutePath() + "'.", e);

        }

        this.setSaved(true);

    }

    @Override

    protected void save(Ini prefs) {

        super.save(prefs);

        prefs.put("Script", "main", this.getMainName());

        prefs.put("Script", "Lang", this.getLangName());

        try {

            prefs.store();

        } catch (IOException e) {

            String fname = (prefs.getFile() == null) ? "(null)" : prefs.getFile().getAbsolutePath();

            logger.warn("Can't save inf file (" + fname + ").", e);

        }

    }

    @Override

    public String getLangName() {

        return this.langName;

    }

    protected void setLangName(final String langName) {

        if( langName == null ) {

            return;

        }

        this.langName = langName;

        this.setExtension(this.manager.getExtensionOfLanguage(this.langName));

    }

    @Override

    public String[] getIconNames() {

        return new String[]{

            "scripting_" + this.getLangName().toLowerCase(),

            "scripting_" + this.getLangName().toLowerCase() + "_open"

        };

    }

    @Override

    public String getMainName() {

        return this.mainName;

    }

    @Override

    public void setMainName(final String mainName) {

        this.mainName = mainName;

    }

    public String getExtension() {

        return this.extension;

    }

    public void setExtension(final String extension) {

        if (!extension.startsWith(".")) {

            this.extension = "." + extension;

        } else {

            this.extension = extension;

        }

    }

    @Override

    public boolean isSaved() {

        return this.saved;

    }