Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting.impl;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.util.List;

import java.util.Map;

import javax.script.Compilable;

import javax.script.CompiledScript;

import javax.script.Invocable;

import javax.script.ScriptEngine;

import javax.script.ScriptException;

import org.apache.commons.io.FileUtils;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.io.IOUtils;

import org.gvsig.scripting.CompileErrorException;

import org.gvsig.scripting.ExecuteErrorException;

import org.gvsig.scripting.ScriptingBaseScript;

import org.gvsig.scripting.ScriptingFolder;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.scripting.ScriptingScript;

import org.gvsig.tools.dispose.Disposable;

import org.gvsig.tools.observer.Observer;

import org.gvsig.tools.observer.impl.DelegateWeakReferencingObservable;

import org.gvsig.tools.task.AbstractMonitorableTask;

import org.ini4j.Ini;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class DefaultScriptingScript extends AbstractScript implements

                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);

        }

        protected void notifyErrors(Exception exception, String command) {

                this.delegatedObservable.notifyObservers(new BaseScriptingNotifycation(

                                this, BaseScriptingNotifycation.RUNTIME_ERROR_NOTIFICATION,

                                command, exception));

        }

        public void setSaved(boolean saved) {

                this.saved = saved;

        }

        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;

        }

        public void setCode(String code) {

                this.code = code;

                this.engine = null;

                this.compiledCode = null;

                this.setSaved(false);

        }

        private String getPreparedCode() {

                return this.getCode();

        }

        protected String getCodeToInitializeEngine() {

                List<File> libFolders = this.manager.getLibFolders();

                if (libFolders == null || libFolders.size() < 1) {

                        return null;

                }

                StringBuffer buffer = new StringBuffer();

                buffer.append("import sys\n");

                buffer.append("sys_path = list()\n");

                for (File file : libFolders) {

                        buffer.append("sys_path.append(r'");

                        buffer.append(file.getAbsolutePath());

                        buffer.append("')\n");

                }

                buffer.append("sys.path.extend(sys_path)\n\n\n");

                String resname = "/org/gvsig/scripting/impl/InitializaEngine.py";

                InputStream code_is = this.getClass().getResourceAsStream(resname); 

                if( code_is != null ) {

                        try {

                                String code = IOUtils.toString(code_is);

                                buffer.append(code);

                        } catch (IOException e) {

                                logger.warn("Can't read code to initialize engine from resource '"+resname+"'.",e);

                        }

                } else {

                        logger.warn("Can't open resurce '"+resname+"'.");

                }

                return buffer.toString();

        }

        protected ScriptEngine getEngine() {

                if (this.engine == null) {

                        ScriptEngine scriptEngine = this.manager.getEngine(this

                                        .getLangName());

                        scriptEngine.put("script", this);

                        this.engine = scriptEngine;

                        try {

                                String code = this.getCodeToInitializeEngine();

                                if( code != null ) {

                                        this.engine.eval(code);

                                }

                        } catch(Exception ex) {

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

                        }

                }

                return this.engine;

        }

        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()));

        }

        public void load(ScriptingFolder folder, String id) {

                this.setId(id);

                this.setParent(folder);

                Map<String, String> languages = this.manager

                                .getSupportedLanguagesByExtension();

                String extension = FilenameUtils.getExtension(id);

                String langName = languages.get(extension);

                this.setLangName(langName);

                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);

        }

        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 = null;

                try {

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

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

                } catch (Exception e) {

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

                }

                this.setSaved(true);

        }

        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);

                }

        }

        public String getLangName() {

                return this.langName;

        }

        protected void setLangName(final String langName) {

                this.langName = langName;

                this.extension = this.manager.getExtensionByLanguage(this.langName);

        }

        public String[] getIconNames() {

                return new String[] { 

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

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

                };

        }

        public String getMainName() {

                return this.mainName;

        }

        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;        

                }

        }

        public boolean isSaved() {

                return this.saved;

        }

        public void addObserver(final Observer o) {

                this.delegatedObservable.addObserver(o);

        }

        public void deleteObserver(final Observer o) {

                this.delegatedObservable.deleteObserver(o);

        }

        public void deleteObservers() {

                this.delegatedObservable.deleteObservers();

        }

        public void put(final String name, final Object value) {

                this.getEngine().put(name, value);

        }

        public void compile() {

                if (this.compiledCode == null) {

                        ScriptEngine engine = this.getEngine();

                        if (engine instanceof Compilable) {

                                try {

                                        Compilable compilable = (Compilable) engine;

                                        this.compiledCode = compilable.compile(this.getPreparedCode());

                                        this.compiledCode.eval();

                                } catch (ScriptException e) {

                                        CompileErrorException ce = new CompileErrorException(e.getMessage(), this.getName(), e.getLineNumber(), e.getColumnNumber(), e);

                                        notifyErrors(ce, "compile");

                                        throw ce;

                                } catch (Throwable e) {

                                        CompileErrorException ce = new CompileErrorException(e.getMessage(), this.getName(), e);

                                        notifyErrors(new Exception(e), "compile");

                                        throw ce;

                                }

                        }

                }

        }

        public Object run() {

                return this.run(null);

        }

        public void addDisposable(Disposable disposable){

                //pass

        }

        public Object run(Object args[]) {

                if (args == null) {

                        args = new Object[] {};

                }

                this.compile();

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

        }

        public Object invokeFunction(final String name, Object args[]) {

                if (this.getEngine() instanceof Invocable) {

                        Invocable invocable = (Invocable) this.getEngine();

                        this.compile();

                        if( args == null ) {

                                args = new Object[] {};

                        }

                        try {

                                return invocable.invokeFunction(name, args);

                        } catch (ScriptException e) {

                                ExecuteErrorException ee = new ExecuteErrorException(e.getMessage(), this.getName(), e.getLineNumber(), e.getColumnNumber(), e);

                                notifyErrors(ee, "invoke");

                                throw ee;

                        } catch (Throwable e) {

                                ExecuteErrorException ee = new ExecuteErrorException(e.getMessage(), this.getName(), e);

                                notifyErrors(ee, "invoke");

                                throw ee;

                        }

                } else {

                        return null;

                }

        }

        public Object invokeMethod(final Object obj, final String name, Object[] args)

                        throws NoSuchMethodException {

                if (this.getEngine() instanceof Invocable) {

                        Invocable invocable = (Invocable) this.getEngine();

                        this.compile();

                        if( args == null ) {

                                args = new Object[] {};

                        }

                        try {

                                return invocable.invokeMethod(obj, name, args);

                        } catch (ScriptException e) {

                                ExecuteErrorException ee = new ExecuteErrorException(e.getMessage(), this.getName(), e.getLineNumber(), e.getColumnNumber(), e);

                                notifyErrors(ee, "invoke");

                                throw ee;

                        } catch (Throwable e) {

                                ExecuteErrorException ee = new ExecuteErrorException(e.getMessage(), this.getName(), e);

                                notifyErrors(ee, "invoke");

                                throw ee;

                        }

                } else {

                        return null;

                }

        }

        public File getResource(String filename) {

                return new File( this.getParent().getFile(), filename);

        }

        class ScriptTask extends AbstractMonitorableTask {

                ScriptingBaseScript script = null;

                Object[] args = null; 

                protected ScriptTask(ScriptingBaseScript script, Object[] args) {

                        super(script.getName(),false);

                        this.args = args;

                        this.script = script;

                        this.script.put("task",this);

                        this.script.put("taskStatus",this.getTaskStatus());

                }

                public void run() {

                        try {

                                console_println("Running script "+ this.script.getName()+".");

                                script.run(this.args);

                                console_println("Script "+ this.script.getName()+ " terminated.");

                        } catch(Throwable e) {

                                console_println("Stript "+ this.script.getName()+ " aborted.");

                        } finally {

                                this.taskStatus.terminate();

                                try {

                                        Thread.sleep(3000);

                                } catch (InterruptedException e) {

                                        // Ignore

                                }

                                this.taskStatus.remove(); 

                        }

                }

                public void showTaskStatus() {

                        this.taskStatus.add();

                }

        }

        public void runAsTask(Object[] args) {

                ScriptTask task = new ScriptTask(this, args);

                task.start();

        }

        public boolean remove() {

                boolean r = true;

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

                File f = null;

                try {

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

                        FileUtils.forceDelete(f);

                } catch (IOException e) {

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

                        r = false;

                }

                try {

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

                        FileUtils.forceDelete(f);

                } catch (IOException e) {

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

                        r = false;

                }

                return r;

        }

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

                this.setParent(folder);

                this.setId(id);

                if( language==null ) {

                        this.setLangName("python");

                } else {

                        this.setLangName(language);

                }

                this.setExtension(this.manager.getExtensionByLanguage(getLangName()));

                File file = new File(folder.getFile(),id +".inf");

                try {

                        file.createNewFile();

                } catch (IOException e) {

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

                }

                if( "python".equalsIgnoreCase(this.getLangName()) ) {

                        this.setCode("\nfrom gvsig import *\n\ndef main():\n    #Remove this lines and add here your code\n\n    print \"hola mundo\"\n    pass\n\n");

                }

                this.save();

        }

}