Application: gvSIG desktop » gvSIG scripting

package org.gvsig.scripting.impl;

import org.gvsig.scripting.HelpConfig;

import java.io.BufferedReader;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.FileReader;

import java.io.IOException;

import java.io.Reader;

import java.io.Writer;

import java.net.MalformedURLException;

import java.net.URISyntaxException;

import java.net.URL;

import java.util.ArrayList;

import java.util.Arrays;

import java.util.HashMap;

import java.util.HashSet;

import java.util.Iterator;

import java.util.List;

import java.util.Map;

import java.util.Set;

import java.util.logging.Level;

import javax.help.HelpSet;

import javax.help.HelpSetException;

import org.apache.commons.io.FileUtils;

import org.apache.commons.io.FilenameUtils;

import org.apache.commons.io.IOUtils;

import org.gvsig.scripting.ScriptingHelpManager;

import org.gvsig.scripting.ScriptingManager;

import org.gvsig.tools.task.SimpleTaskStatus;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

public class DefaultScriptingHelpManager implements ScriptingHelpManager {

    protected static final Logger logger = LoggerFactory.getLogger(DefaultScriptingHelpManager.class);

    private ScriptingManager manager;

    protected HelpSet helpSet = null;

    protected IndexerHelper indexer;

    protected MethodList methodsList;

    protected List<File> helpRoots = null;

    public DefaultScriptingHelpManager(ScriptingManager manager) {

        this.manager = manager;

        this.methodsList = new MethodList();

    }

    private void initializeHelpSet() {

        HelpSet helpSet = null;

        File f = new File(this.manager.getHomeFolder(), "help");

        if (!f.exists()) {

            try {

                FileUtils.forceMkdir(f);

            } catch (IOException ex) {

                logger.warn("Can't create help folder in '" + f.getAbsolutePath() + "'.", ex);

            }

        }

        ClassLoader loader = this.getClass().getClassLoader();

        URL resource = loader.getResource("org/gvsig/scripting/apihelp/api.hs");

        if (resource == null) {

            logger.info("Can't initialize help framework. Can't find 'api.hs'.");

        } else {

            try {

                helpSet = new HelpSet(loader, resource);

            } catch (HelpSetException e) {

                logger.info("Can't initialize help framework, can't create HelpSet from '" + resource.toString() + "'.", e);

            }

        }

        this.helpSet = helpSet;

        loadHelps();

    }

    public void loadHelps() {

//        HelpConfig helpConfig = new DefaultHelpConfig();

        List<File> folders = this.getHelpRoots();

        for (File folder : folders) {

            File[] helpFolders = folder.listFiles();

            for (File helpFolder : helpFolders) {

                HelpSet helpset = loadHelp(helpFolder);

                if (helpset != null) {

                    this.getHelpSet().add(helpset);

                }

            }

        }

    }

    public URL makeURL(File helpsetfolder, URL sourceurl) {

        if( sourceurl==null ) {

            return null;

        }

        URL url ;

        HelpConfig helpConfig = new DefaultHelpConfig();

        if (helpsetfolder == null) {

            List<File> folders = this.getHelpRoots();

            for (File folder : folders) {

                File[] helpFolders = folder.listFiles();

                for (File helpFolder : helpFolders) {

                    if( helpConfig.exists(helpFolder) ) {

                        if( helpConfig.load(helpFolder) ) {

                            ClassLoader loader = helpConfig.getLoader();

                            url = loader.getResource(sourceurl.getPath().substring(1));

                            if( url != null ) {

                                return url;

                            }

                        }

                    }

                }

            }

        } else {

            if( helpConfig.load(helpsetfolder) ) {

                ClassLoader loader = helpConfig.getLoader();

                url = loader.getResource(sourceurl.getPath());

                if( url != null ) {

                    return url;

                }

                if( sourceurl.getPath().startsWith(helpsetfolder.getPath()) ) {

                    int n = helpsetfolder.getPath().length()+1;

                    url = loader.getResource(sourceurl.getPath().substring(n));

                    if( url != null ) {

                        return url;

                    }

                }

            }

        }

        return sourceurl;

    }    

    private HelpSet loadHelp(File folder) {

        HelpConfig helpConfig = new DefaultHelpConfig();

        if (!helpConfig.exists(folder)) {

            return null;

        }

        if (!helpConfig.load(folder)) {

            logger.warn("Can't load help from folder '"+folder.getAbsolutePath()+"'.");

            return null;

        }

        File helpindex = helpConfig.getHelpIndex();

        if (helpindex != null) {

            this.methodsList.addMethods(helpindex);

        }

        HelpSet helpset = helpConfig.createHelpSet();

        return helpset;

    }

    public void reloadHelp() {

        this.helpSet = null;

        this.initializeHelpSet();

    }

    @Override

    public boolean existsHelp(String name) {

        HelpConfig helpConfig = new DefaultHelpConfig();

        List<File> folders = this.getHelpRoots();

        for (File folder : folders) {

            if (helpConfig.exists(FileUtils.getFile(folder,name))) {

                return true;

            }

        }

        return false;

    }

    @Override

    public boolean removeHelp(String name) {

        HelpConfig helpConfig = new DefaultHelpConfig();

        List<File> folders = this.getHelpRoots();

        for (File folder : folders) {

            if (helpConfig.exists(folder)) {

                try {

                    FileUtils.forceDelete(folder);

                    return true;

                } catch (IOException ex) {

                    return true;

                }

            }

        }

        return false;

    }

    @Override

    public void addMethods(URL methodsfile) {

        this.methodsList.addMethods(methodsfile);

    }

    @Override

    public List<ScriptingHelpMethod> getMethods() {

        return this.methodsList;

    }

    @Override

    public ScriptingHelpClass getHelpClass(String name) {

        return this.methodsList.getHelpClass(name);

    }

    @Override

    public List<ScriptingHelpClass> getHelpClasses() {

        return this.methodsList.getHelpClasses();

    }

    @Override

    public Map<String, ScriptingHelpMethod> findMethods(String text) {

        return this.methodsList.findMethods(text);

    }

    @Override

    public List<File> getHelpRoots() {

        if (this.helpRoots == null) {

            List<File> helpRoots = new ArrayList();

            helpRoots.add(new File(this.manager.getHomeFolder(), "help"));

            this.helpRoots = helpRoots;

        }

        return this.helpRoots;

    }

    @Override

    public HelpSet getHelpSet() {

        if (this.helpSet == null) {

            this.initializeHelpSet();

        }

        return this.helpSet;

    }

    private BufferedReader createFileReader(File f) {

        if (f == null) {

            logger.warn("Can't create reader file is null.");

            return null;

        }

        Reader fileReader;

        try {

            fileReader = new FileReader(f);

        } catch (FileNotFoundException ex) {

            logger.warn("Can't create reader from '" + f.getAbsolutePath() + "'.", ex);

            return null;

        }

        return new BufferedReader(fileReader);

    }

    private int countLines(File textfile) {

        try {

            BufferedReader reader = createFileReader(textfile);

            int nlines = 0;

            for (String line = reader.readLine(); line != null; line = reader.readLine()) {

                nlines++;

            }

            return nlines;

        } catch (IOException ex) {

            return -1;

        }

    }

    @Override

    public boolean importJavadoc(String name, File folder, SimpleTaskStatus status) {

        if (existsHelp(name)) {

            status.message("Help '" + name + "' already exists");

            status.abort();

            return false;

        }

        status.setIndeterminate();

        status.message(("Preparing import of javadoc..."));

        HelpConfig config = new DefaultHelpConfig();

        File rootFolder = this.getHelpRoots().get(0);

        config.create(rootFolder, name, folder);

        Writer helpsetWriter = null;

        Writer tocWriter = null;

        Writer mappingWriter = null;

        Writer indexWriter = null;

        BufferedReader packageListReader = null;

        try {

            helpsetWriter = config.getHelpSetWriter();

            helpsetWriter.write(

                    "<?xml version='1.0' encoding='ISO-8859-1' ?>\n"

                    + "<!DOCTYPE helpset\n"

                    + "  PUBLIC \"-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 1.0//EN\"\n"

                    + "                   \"http://java.sun.com/products/javahelp/helpset_1_0.dtd\">\n\n"

                    + "<?TestTarget this is data for the test target ?>\n\n"

                    + "<helpset version=\"1.0\">\n\n"

                    + "  <!-- title -->\n"

                    + "  <title>" + config.getName() + "</title>\n\n"

                    + "  <!-- maps -->\n"

                    + "  <maps>\n"

                    + "     <homeID>main</homeID>\n"

                    + "     <mapref location=\""+HelpConfig.FILENAME_HELPMAPPING+"\"/>\n"

                    + "  </maps>\n\n"

                    + "  <!-- views -->\n"

                    + "  <view>\n"

                    + "    <name>TOC</name>\n"

                    + "    <label>TOC</label>\n"

                    + "    <type>javax.help.TOCView</type>\n"

                    + "    <data>"+HelpConfig.FILENAME_HELPTOC+"</data>\n"

                    + "  </view>\n\n"

                    + "  <view>\n"

                    + "    <name>Index</name>\n"

                    + "    <label>Index</label>\n"

                    + "    <type>javax.help.IndexView</type>\n"

                    + "    <data>"+HelpConfig.FILENAME_HELPINDEX+"</data>\n"

                    + "  </view>\n"

                    + "  <view>\n"

                    + "    <name>Search</name>\n"

                    + "    <label>Search</label>\n"

                    + "    <type>javax.help.SearchView</type>\n"

                    + "    <data engine=\"com.sun.java.help.search.DefaultSearchEngine\">"+HelpConfig.FILENAME_SEARCHDB+"</data>\n"

                    + "  </view>\n\n"

                    + "  <view>\n"

                    + "    <name>Favorites</name>\n"

                    + "    <label>Favoritos</label>\n"

                    + "    <type>javax.help.FavoritesView</type>\n"

                    + "  </view>\n\n"

                    + "  <presentation default=\"true\" displayviewimages=\"false\">\n"

                    + "     <name>main window</name>\n"

                    + "     <size width=\"700\" height=\"400\" />\n"

                    + "     <location x=\"200\" y=\"200\" />\n"

                    + "     <title>gvSIG - Ayuda en linea</title>\n"

                    + "     <image>toplevelfolder</image>\n"

                    + "     <toolbar>\n"

                    + "       <helpaction image=\"action.back\">javax.help.BackAction</helpaction>\n"

                    + "       <helpaction image=\"action.forward\">javax.help.ForwardAction</helpaction>\n"

                    + "     </toolbar>\n"

                    + "  </presentation>\n"

                    + "</helpset>"

            );

            IOUtils.closeQuietly(helpsetWriter);

            tocWriter = config.getTOCWriter();

            mappingWriter = config.getHelpMappingWriter();

            packageListReader = createFileReader(new File(folder, "package-list"));

            status.message("Processing package-list");

            status.setRangeOfValues(0, countLines(new File(folder, "package-list")));

            mappingWriter.write(

                    "<?xml version='1.0' encoding='ISO-8859-1' ?>\n"

                    + "<!DOCTYPE map\n"

                    + "  PUBLIC \"-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN\"\n"

                    + "         \"http://java.sun.com/products/javahelp/map_1_0.dtd\">\n\n"

                    + "<map version=\"1.0\">\n"

            );

            tocWriter.write(

                    "<!DOCTYPE toc\n"

                    + "  PUBLIC \"-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 1.0//EN\"\n    "

                    + "         \"http://java.sun.com/products/javahelp/toc_1_0.dtd\">\n\n"

                    + "<toc version=\"1.0\">\n"

            );

            int count = 0;

            tocWriter.write("<tocitem text=\"" + name + "\">\n");

            String line = packageListReader.readLine();

            while (line != null) {

                tocWriter.write("\t<tocitem text=\"" + line + "\">\n");

                File f = new File(folder, line.replace(".", File.separator));

                if (f.isDirectory() && f.canRead()) {

                    String[] fileNames = f.list();

                    Arrays.sort(fileNames, String.CASE_INSENSITIVE_ORDER);

                    for (int i = 0; i < fileNames.length; i++) {

                        if (fileNames[i].toLowerCase().endsWith(".html") &&

                            ! fileNames[i].contains("-")    ) {

                            String fileName = FilenameUtils.removeExtension(fileNames[i]);

                            tocWriter.write("\t\t<tocitem text=\"");

                            tocWriter.write(fileName);

                            tocWriter.write("\" target=\"");

                            tocWriter.write(line);

                            tocWriter.write(".");

                            tocWriter.write(fileName);

                            tocWriter.write(".html\"/>\n");

                            String targetid = line + "." + fileName;

                            String url = "/"+targetid.replace(".", "/");

                            mappingWriter.write("\t\t<mapID target=\"");

                            mappingWriter.write(targetid);

                            mappingWriter.write(".html\" url=\"");

                            mappingWriter.write(url);

                            mappingWriter.write(".html\" />\n");

                        }

                    }

                }

                tocWriter.write("\t</tocitem>\n");

                line = packageListReader.readLine();

                status.setCurValue(count);

            }

            tocWriter.write("</tocitem>\n");

            tocWriter.write("</toc>\n");

            mappingWriter.write("</map>\n");

            IOUtils.closeQuietly(tocWriter);

            IOUtils.closeQuietly(mappingWriter);

            indexWriter = config.getHelpIndexWriter();

            indexWriter.write(

                "<?xml version='1.0' encoding='ISO-8859-1' ?>\n" +

                "<!DOCTYPE index \n" +

                "        PUBLIC \"-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN\" \n" +

                "                \"http://java.sun.com/javase/technologies/desktop/javahelp/index_1_0.dtd\">\n" +

                "\n" +

                "<index version=\"1.0\">\n"

            );

            MethodList methodsIndex = loadJavadocMethodsIndex(new File(folder, "index-all.html"), status);

            Iterator<ScriptingHelpMethod> it = methodsIndex.iterator();

            while (it.hasNext()) {

                ScriptingHelpMethod mn = it.next();

                indexWriter.write("\t<indexitem text=\"" + mn.getName() + "\" expand=\"false\">\n");

                Iterator<ScriptingHelpClass> itcn = mn.iterator();

                while (itcn.hasNext()) {

                    ScriptingHelpClass cn = itcn.next();

                    indexWriter.write("\t\t<indexitem text=\"" + cn.getName() + "\" target=\"" + cn.getUrl() + "\" />\n");

                }

                indexWriter.write("\t</indexitem>\n");

            }

            indexWriter.write("</index>\n");

            IOUtils.closeQuietly(indexWriter);

            File docsFolder = config.getDocsFolder();

            if( docsFolder!=null ) {

                // Si no puede obtener el fichero donde estan los docs como un File,

                // probablemente sea por que los documentos esten zipeados,

                // Y en ese caso no se pueden indexar.

                status.message("Indexing files");

                status.setIndeterminate();

                IndexerHelper indexer = new IndexerHelper();

                indexer.index(

                        config.getIndexerConfig(),

                        config.getSearchdb(),

                        docsFolder

                );

            }

            status.message("Loading help");

            HelpSet helpset = loadHelp(config.getFolder());

            if (helpset != null) {

                this.getHelpSet().add(helpset);

            }

        } catch (IOException ex) {

            logger.warn("Can't import help '" + name + "' from '" + folder.getAbsolutePath() + "'.", ex);

            status.abort();

            return false;

        } finally {

            IOUtils.closeQuietly(tocWriter);

            IOUtils.closeQuietly(mappingWriter);

            IOUtils.closeQuietly(helpsetWriter);

            IOUtils.closeQuietly(indexWriter);

            IOUtils.closeQuietly(packageListReader);

        }

        return true;

    }

    private MethodList loadJavadocMethodsIndex(File indexallFile, SimpleTaskStatus status) throws IOException {

        try {

            Map<String, Set<String>> classes = new HashMap();

            BufferedReader indexallReader = createFileReader(indexallFile);

            status.message("Loading methods information...");

            status.setRangeOfValues(0, countLines(indexallFile));

            int count = 0;

            for (String line = indexallReader.readLine(); line != null; line = indexallReader.readLine()) {

                line = line.replaceAll("\\<.*?\\>", "");

                String parts[] = line.split(" ");

                int l = parts.length;

                if (l > 4 && "Method".equalsIgnoreCase(parts[l - 4])) {

                    String classname = parts[l - 1];

                    String methodname = parts[0];

                    int n = methodname.indexOf("(");

                    if (n > 0) {

                        methodname = methodname.substring(0, n);

                    }

                    Set<String> classmethods = classes.get(classname);

                    if (classmethods == null) {

                        classmethods = new HashSet<String>();

                        classes.put(classname, classmethods);

                    }

                    classmethods.add(methodname);

                }

                status.setCurValue(count++);

            }

            status.message("Processing methods information...");

            status.setRangeOfValues(0, classes.size());

            count = 0;

            MethodList methodsIndex = new MethodList();

            Iterator<Map.Entry<String, Set<String>>> it = classes.entrySet().iterator();

            while (it.hasNext()) {

                Map.Entry<String, Set<String>> entry = it.next();

                String[] ss = entry.getKey().split("[.]");

                String classname = ss[ss.length - 1];

                methodsIndex.add(classname, entry.getKey() + ".html", new ArrayList(entry.getValue()));

                status.setCurValue(count++);

            }

            return methodsIndex;

        } catch (IOException ex) {

            logger.warn("Can't load methods information from '"+indexallFile.getAbsolutePath()+"'.",ex);

            throw ex;

        }

    }

//    public List<ScriptingHelpAPI> getAPI() {

//        String[] files = this.getFolder().list();

//        List<ScriptingHelpAPI> apis = new ArrayList<ScriptingHelpAPI>();

//

//        for (int i = 0; i < files.length; i++) {

//            apis.add(new DefaultScriptingHelpAPI(files[i]));

//        }

//        return apis;

//    }

//

//    private static class DefaultScriptingHelpAPI implements ScriptingHelpAPI {

//

//        private final String name;

//

//        DefaultScriptingHelpAPI(String name) {

//            this.name = name;

//        }

//

//        public String getName() {

//            return this.name;

//        }

//

//    }

}