w3c.css.index.IndexGenerator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cssvalidator Show documentation
Backend for the W3C CSS Validation Service
There is a newer version: 1.0.8
/**
 * This class is used to generates the index pages
 * of the CSS validator in all the availables languages
 * it'll create the outputs validator.en.html, validator.fr.html, ...
 * according to the template file validator.vm
 */
package org.w3c.css.index;

import org.apache.velocity.Template;
import org.apache.velocity.VelocityContext;
import org.apache.velocity.app.Velocity;
import org.apache.velocity.exception.MethodInvocationException;
import org.apache.velocity.exception.ParseErrorException;
import org.apache.velocity.exception.ResourceNotFoundException;
import org.w3c.css.util.ApplContext;
import org.w3c.css.util.Messages;
import org.w3c.css.util.Utf8Properties;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.net.URI;
import java.net.URISyntaxException;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;

/**
 * @author julien
 */
public class IndexGenerator {

    // the velocity context used to generate the index
    // (NB: the same context is used for each index page, changing every thing
    // inside)
    public static VelocityContext vc = new VelocityContext();
    private static String template_name = "validator.vm";
    private static String html_files_path = "../../../../";
    private static boolean done = false;

    /**
     * @param args
     */
    public static void main(String[] args) {
        IndexGenerator.generatesIndex(false);
    }

    /**
     * This method generates the index in every possible language we have the translation
     *
     * @param servlet, if this method is called from the servlet,
     *                 the path is a bit different and need to be changed.
     * @see org.w3c.css.util.Messages
     */
    public static synchronized void generatesIndex(boolean servlet) {
        if (done)
            return;

        String default_lang = "en";
        String k, name, path;
        ApplContext ac_default = new ApplContext(default_lang);
        File tmpFile;
        Iterator it;

        // Getting the differents languages informations (for the lang choice)
        HashMap[] languages = new HashMap[Messages.languages_name.size()];
        for (int i = 0; i < Messages.languages_name.size(); ++i) {
            name = String.valueOf(Messages.languages_name.get(i));
            HashMap l = new HashMap();
            l.put("name", name);
            l.put("real", ((Utf8Properties) Messages.languages.get(name)).getProperty("language_name"));
            languages[i] = l;
        }
        // Adding the result to the context
        vc.put("languages", languages);

        try {
            //setting the path were to find the template
            path = IndexGenerator.class.getResource("").getPath();
            if (servlet)
                path = path.replace("file://localhost", "");
            else
                path = new URI(path).getPath();

            /*
             * This code set the velocity properties to be used
             * A new jar is needed to use file logging (avalon-logkit.jar)
             */
            Velocity.setProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path);
            Velocity.addProperty(Velocity.FILE_RESOURCE_LOADER_PATH, path + "../../../../");
            Velocity.setProperty(Velocity.RUNTIME_LOG,
                    "velocity-" + new SimpleDateFormat("yyyy-MM-dd_HHmm").format(new Date()) + ".log");

            Velocity.setProperty(Velocity.RUNTIME_LOG_LOGSYSTEM_CLASS, "org.apache.velocity.runtime.log.AvalonLogChute");
            Velocity.init();
            if (!new File(path + template_name).exists()) {
                template_name = template_name;
                html_files_path = "";
            }
            Template tpl = Velocity.getTemplate(template_name, "UTF-8");
            int count = 0;

            // For each language, we set the context are create the template
            for (int i = 0; i < Messages.languages_name.size(); ++i) {
                name = String.valueOf(Messages.languages_name.get(i));
                tmpFile = new File(path + html_files_path + "validator.html." + name);

                // Checking if the index files exists
                // and if they have been created after the last template modification
                if ((tmpFile.lastModified() < tpl.getLastModified()) || !tmpFile.exists()) {
                    ApplContext ac = new ApplContext(name);
                    vc.put("lang", name);

                    if (ac.getLang().equals(default_lang)) {
                        it = ac_default.getMsg().properties.keySet().iterator();
                        while (it.hasNext()) {
                            k = String.valueOf(it.next());
                            vc.put(k, ac.getMsg().getString(k));
                        }
                    } else {
                        it = ac_default.getMsg().properties.keySet().iterator();
                        while (it.hasNext()) {
                            k = String.valueOf(it.next());
                            if (ac.getMsg().getString(k) == null)
                                vc.put(k, ac_default.getMsg().getString(k));
                            else
                                vc.put(k, ac.getMsg().getString(k));
                        }
                    }
                    OutputStreamWriter aFileWriter = new OutputStreamWriter(new FileOutputStream(tmpFile), "UTF-8");
                    tpl.merge(vc, aFileWriter);
                    aFileWriter.close();
                    ++count;
                }
            }
            Velocity.getLog().info("IndexGenerator : " + count + " index file(s) created or modified");
            done = true;
        } catch (ResourceNotFoundException e) {
            e.printStackTrace();
        } catch (ParseErrorException e) {
            e.printStackTrace();
        } catch (MethodInvocationException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } catch (URISyntaxException e1) {
            e1.printStackTrace();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            done = true;
        }
    }

}