Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting.impl;

import java.io.File;

import java.io.IOException;

import java.io.InputStream;

import java.io.PrintStream;

import java.io.Writer;

import java.nio.charset.Charset;

import java.util.ArrayList;

import java.util.HashSet;

import java.util.List;

import java.util.Set;

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.apache.commons.lang3.StringUtils;

import org.apache.commons.lang3.exception.ExceptionUtils;

import org.gvsig.scripting.CompileErrorException;

import org.gvsig.scripting.ExecuteErrorException;

import org.gvsig.scripting.Main;

import org.gvsig.scripting.ScriptingBaseScript;

import org.gvsig.scripting.ScriptingFolder;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.scripting.ScriptingScript;

import org.gvsig.scripting.ScriptingUnit;

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.python.core.PyException;

import org.python.core.PyString;

import org.python.core.PyTraceback;

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

    protected ScriptEngine engine = null;

    protected CompiledScript compiledCode;

    private String code = null;

    private String mainName = "main";

    private final DelegateWeakReferencingObservable delegatedObservable;

    private OutputWriter stdout;

    private OutputWriter stderr;

    public static class OutputWriter extends Writer {

        private final Set<Writer> writers = new HashSet<>();

        private final PrintStream out;

        private OutputWriter(PrintStream out) {

            this.out = out;

        }

        @Override

        public void write(char[] cbuf, int off, int len) throws IOException {

            try {

                byte[] buf = new String(cbuf).getBytes(Charset.forName("UTF-8"));

                out.write(buf, off, len);

            } catch (Exception ex) {

                logger.warn("Can't output",ex);

            }

            for (Writer writer : writers) {

                try {

                    writer.write(cbuf, off, len);

                } catch (Exception ex) {

                    logger.warn("Can't output",ex);

                }

            }

        }

        @Override

        public void flush() throws IOException {

            try {

                out.flush();

            } catch (Exception ex) {

                logger.warn("Can't flush",ex);

            }

            for (Writer writer : writers) {

                try {

                    writer.flush();

                } catch (Exception ex) {

                    logger.warn("Can't flush",ex);

                }

            }

        }

        @Override

        public void close() throws IOException {

        }

        private void addWriter(Writer out) {

            this.writers.add(out);

        }

        private void removeWriter(Writer out) {

            this.writers.remove(out);

        }

    }

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

        this.stdout = new OutputWriter(System.out);

        this.stderr = new OutputWriter(System.err);

    }

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

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

    }

    @Override

    public void addStdoutWriter(Writer out) {

        this.stdout.addWriter(out);

    }

    @Override

    public void addStderrWriter(Writer err) {

        this.stderr.addWriter(err);

    }

    @Override

    public void removeStdoutWriter(Writer out) {

        this.stdout.removeWriter(out);

    }

    @Override

    public void removeStderrWriter(Writer err) {

        this.stdout.removeWriter(err);

    }

    public Object __getattr__(String name) {

        try {

            ScriptEngine engine = this.getEngine();

            this.compile();

            return engine.get(name);

        } catch(Exception ex) {

            return null;

        }

    }

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

    }

    public OutputWriter getStdout() {

        return this.stdout;

    }

    public OutputWriter getStderr() {

        return this.stderr;

    }

    protected void notifyErrors(Exception exception, String command) {

        this.delegatedObservable.notifyObservers(new BaseScriptingNotifycation(

                this, BaseScriptingNotifycation.RUNTIME_ERROR_NOTIFICATION,

                command, exception));

    }

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

    }

    @Override

    public String getLibrarySuffix() {

        return this.librarySuffix;

    }

    @Override

    public void setLibrarySuffix(String librarySuffix) {

        this.librarySuffix = librarySuffix;

    }

    public List<File> getLibFolders() {

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

        String suffix = this.getLibrarySuffix();

        if( suffix == null ) {

            return folders;

        }

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

            File folder = folders.get(i);

            File f = new File(folder.getParentFile(),folder.getName()+suffix);

            if( f.exists() ) {

                folders.set(i, f);

            }

        }

        return folders;

    }

    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;

        }

    }

    public ScriptEngine getEngine() {

        if (this.engine == null) {

            synchronized(this.getManager()) {

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

                scriptEngine.put("script", this);

                scriptEngine.put("Main", Main.class);

                scriptEngine.getContext().setWriter(stdout);

                scriptEngine.getContext().setErrorWriter(stderr);

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

        this.setLibrarySuffix((String) getInfValue(prefs, "Script", "LibraryVersion",null));

    }

    @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.setCode(null);

        this.setSaved(true);

    }

    @Override

    public void save() {

        this.saveInfo();

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

    }

    private void saveInfo() {

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

    }

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

    }

    @Override

    public List<File> getFiles() {

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

        l.add(this.getScriptFile());

        return l;

    }

    public String getExtension() {

        return this.extension;

    }

    public void setExtension(final String extension) {

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

            this.extension = "." + extension;

        } else {

            this.extension = extension;

        }

    }

    @Override

    public void addObserver(final Observer o) {

        this.delegatedObservable.addObserver(o);

    }

    @Override

    public void deleteObserver(final Observer o) {

        this.delegatedObservable.deleteObserver(o);

    }

    @Override

    public void deleteObservers() {

        this.delegatedObservable.deleteObservers();

    }

    @Override

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

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

    }

    @Override

    public void compile() {

        if (this.compiledCode == null) {

            ScriptEngine engine = this.getEngine();

            if (engine instanceof Compilable) {

                try {

                    Compilable compilable = (Compilable) engine;

                    String code = this.getCode();

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

                        // If a Unicode string with a coding declaration is passed to compile(),

                        // a SyntaxError will be raised, but this is necessary to import from 

                        // another module, so we remove it.

                        // http://bugs.jython.org/issue1696

                        code = code.replaceFirst("^\\s*#([^:\\n]*)coding:","#$1 c-o-d-i-n-g:");

                    }

                    this.compiledCode = compilable.compile(code);

                    if( engine instanceof Invocable) {

                        this.compiledCode.eval();

                    }

                } catch (ScriptException e) {

                    Object[] location = this.getLocation(e);

                    CompileErrorException ce = new CompileErrorException(

                            e.getMessage(), 

                            (File) location[0], 

                            (int) location[1], 

                            (int) location[2], 

                            e

                    );

                    notifyErrors(ce, "compile");

                    throw ce;

                } catch (Throwable e) {

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

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

                    throw ce;

                }

            } else {

                String code = this.getCode();

                try {

                    engine.eval(code);

                } catch (ScriptException e) {

                    Object[] location = this.getLocation(e);

                    CompileErrorException ce = new CompileErrorException(

                            e.getMessage(), 

                            (File) location[0], 

                            (int) location[1], 

                            (int) location[2], 

                            e

                    );                    

                    notifyErrors(ce, "compile");

                    throw ce;

                }

            }

        }

    }

    public void addDisposable(Disposable disposable) {

        //pass

    }

    /**

     * Run the main function of this script.

     * This method is created by familiarity when running the script from another script.

     * @return 

     */

    public Object main() {

        return this.run(null);

    }

    /**

     * Run the main function of this script.

     * This method is created by familiarity when running the script from another script.

     * @param args

     * @return 

     */

    public Object main(Object... args) {

        return this.run(args);

    }

    @Override

    public Object run() {

        return this.run(null);

    }

    @Override

    public Object run(Object args[]) {

        if( !this.isEnabled() ) {

            System.err.printf("The script '"+this.getName()+"' is not enabled, see properties page to change.\n");

            return null;

        }

        if (args == null) {

            args = new Object[]{};

        }

        this.compile();

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

    }

    @Override

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

        try {

            if (this.getEngine() instanceof Invocable) {

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

                this.compile();

                if (args == null) {

                    args = new Object[]{};

                }

                return invocable.invokeFunction(name, args);

            } else {

                if (this.compiledCode != null) {

                    Object x = this.compiledCode.eval();

                    if( x instanceof Main ) {

                        return ((Main) x).main(args);

                    } else if(x instanceof Runnable) {

                        ((Runnable) x).run();

                    }

                }

                return null;

            }

        } catch (ScriptException e) {

            Object[] location = this.getLocation(e);

            ExecuteErrorException ee = new ExecuteErrorException(

                    e.getMessage(), 

                    (File) location[0], 

                    (int) location[1], 

                    (int) location[2], 

                    e

            );

            notifyErrors(ee, "invoke");

            throw ee;

        } catch (Error | Exception e) {

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

            notifyErrors(ee, "invoke");

            throw ee;

        }

    }

    @Override

    public File getScriptFile() {

        return this.getFileResource(extension);

    }

    private Object[] getLocation(ScriptException e) {

        Throwable[] es = ExceptionUtils.getThrowables(e);

        Exception dbgex; // Para debug con mas comodidad

        for( Throwable t : es) {

            if( t instanceof PyException ) {

                try {

                    PyException pyex = (PyException)t;

                    PyTraceback tb = pyex.traceback;

                    if( tb!=null ) {

                        while( tb.tb_next!=null ) {

                            tb = (PyTraceback) tb.tb_next;

                        }

                        String s = tb.tb_frame.f_globals.__getitem__(new PyString("__file__")).asString();

                        if( s.endsWith("$py.class") ) {

                            s = s.substring(0, s.length()-9) + ".py";

                            File resource = new File(s);

                            return new Object[] { resource, tb.tb_lineno, 0};

                        }

                        return new Object[] { this.getScriptFile(), tb.tb_lineno, 0};

                    }

                } catch(Exception ex) {

                    // Pass

                    dbgex = ex;

                }

            }

        }        

        int column = e.getColumnNumber();

        if( column < 0 ) {

            column = 0;

        }

        return new Object[] { this.getScriptFile(), e.getLineNumber(), column };

    }

    @Override

    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.getScriptFile(), e.getLineNumber(), e.getColumnNumber(), e);

                notifyErrors(ee, "invoke");

                throw ee;

            } catch (Throwable e) {

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

                notifyErrors(ee, "invoke");

                throw ee;

            }

        } else {

            return null;

        }

    }

    @Override

    public File getResource(String filename) {

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

    }

    @Override

    public String getMimeType() {

        return "text/"+ this.getLangName();

    }

    @Override

    protected void console_println(String s) {

        super.console_println(s);

        try {

            this.stdout.write(s+"\n");

        } catch (IOException ex) {

        }

    }

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

        }

        @Override

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

        }

    }

    @Override

    public void runAsTask(Object[] args) {

        if( !this.isEnabled() ) {

            System.err.printf("The script '"+this.getName()+"' is not enabled, see properties page to change.\n");

            return;

        }

        ScriptTask task = new ScriptTask(this, args);

        task.start();

    }

    @Override

    public boolean remove() {

        boolean r = true;

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

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

        try {

            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;

    }

    @Override

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

        }

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

        if( fcode.exists() ) {

            this.saveInfo();

        } else {

            String template = this.getNewTemplate();

            if( template != null ) {

                this.setCode(template);

            }

            this.save();

        }

    }

    public String getNewTemplate() {

        String name = "org/gvsig/scripting/langs/"+this.getLangName().toLowerCase()+"/new_template.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 new-template from '"+name+"'.",ex);

            return null;

        }

    }

    public ScriptingUnit get(String name) {

        return this.manager.getScript(name);

    }

    public ScriptingUnit get(File file) {

        return this.manager.getScript(file);

    }

    @Override

    public boolean move(ScriptingFolder target) {

        if (! manager.validateUnitId(target, this.getId()) ) {

            logger.info("Can't move script '"+this.getId()+"' to '"+target.getFile().getAbsolutePath()+"', is not valid.");

            return false;

        }

        if( !this.isSaved() ) {

            logger.info("Can't move script '"+this.getId()+"', is not saved.");

            return false;

        }

        try {

            File codefile = this.getFileResource(this.extension);

            FileUtils.moveFileToDirectory(this.getFile(), target.getFile(),true);

            FileUtils.moveFileToDirectory(codefile, target.getFile(), true);

            this.parent = target;

            this.load(target, id);

        } catch (IOException ex) {

            logger.info("Can't move script '"+this.getId()+"' to '"+target.getFile().getAbsolutePath()+"', "+ex.getMessage(),ex);

            return false;

        }

        return true;

    }

    @Override

    public boolean rename(String newId) {

        if (! manager.validateUnitId(this.getParent(), newId) ) {

            logger.info("Can't rename script '"+this.getId()+"', target id '"+newId+"' is not valid.");

            return false;

        }

        if( !this.isSaved() ) {

            logger.info("Can't rename script '"+this.getId()+"', is not saved.");

            return false;

        }

        try {

            ScriptingFolder target = this.getParent();

            File codefile = this.getFileResource(this.extension);

            FileUtils.moveFile(this.getFile(),  new File(target.getFile(),newId+".inf") );

            FileUtils.moveFile(codefile, new File(target.getFile(),newId+this.extension));

            this.setId(newId);

            this.saveInfo();

            this.load(target, id);

        } catch (IOException ex) {

            logger.info("Can't rename script '"+this.getId()+"' to '"+newId+"', "+ex.getMessage(),ex);

            return false;

        }        

        return true;

    }

}