šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java
author František Kučera <franta-hg@frantovo.cz>
Tue, 23 Aug 2011 18:43:44 +0200
changeset 35 860cc8ae1808
parent 32 6bc25517ac4f
child 36 5be21d1ef5f8
permissions -rw-r--r--
zjednodušení a zpřehlednění kódu diagramu #13
     1 package cz.frantovo.xmlWebGenerator;
     2 
     3 import java.io.BufferedReader;
     4 import java.io.File;
     5 import java.io.IOException;
     6 import java.io.InputStream;
     7 import java.io.InputStreamReader;
     8 import java.io.PrintStream;
     9 import java.util.Date;
    10 import java.net.URI;
    11 import java.net.URISyntaxException;
    12 
    13 /**
    14  * Knihovna funkcí volaných z XSLT.
    15  *  
    16  * TODO: 
    17  *	- rozdělit na více modulů (jmenných prostorů).
    18  *	- CLI konektor
    19  * 
    20  * @author fiki
    21  */
    22 public class Funkce {
    23 
    24 	private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize";
    25 	private static final String PŘÍKAZ_DOT = "dot";
    26 	private static final String PŘÍKAZ_WHICH = "which";
    27 	private static final String ADRESÁŘ_VÝSTUPNÍ = "výstup";
    28 	private static int počítadloDiagramů = 0;
    29 
    30 	/**
    31 	 * Zjištuje, kdy byl naposledy daný soubor změněn.
    32 	 * @param soubor cesta k souboru
    33 	 * @return datum poslední změny
    34 	 * @throws URISyntaxException
    35 	 */
    36 	public static Date posledníZměna(String soubor) throws URISyntaxException {
    37 		URI uri = new URI(soubor);
    38 		File f = new File(uri);
    39 		return new Date(f.lastModified());
    40 	}
    41 
    42 	/**
    43 	 * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize.
    44 	 * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu
    45 	 * @param jazyk předáme příkazu pygmentize jako parametr -l &lt;lexer&gt;
    46 	 * @return zvýrazněný text nebo null, pokud došlo k chybě.
    47 	 * TODO: 
    48 	 *	- použít (?) místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html
    49 	 *  - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize)
    50 	 */
    51 	public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException {
    52 		if (jazyk == null || jazyk.length() == 0) {
    53 			System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat.");
    54 			return null;
    55 		} else if (isPrikazDostupny(PŘÍKAZ_PYGMENTIZE)) {
    56 			Runtime r = Runtime.getRuntime();
    57 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk});
    58 
    59 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
    60 			vstupProcesu.print(zdroják);
    61 			vstupProcesu.close();
    62 
    63 			String výsledek = načtiProud(p.getInputStream());
    64 			String chyby = načtiProud(p.getErrorStream());
    65 
    66 			p.waitFor();
    67 
    68 			if (chyby.length() == 0) {
    69 				// Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup.
    70 				return výsledek;
    71 			} else {
    72 				System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby);
    73 				return null;
    74 			}
    75 		} else {
    76 			System.err.println("Příkaz " + PŘÍKAZ_PYGMENTIZE + " není na vašem systému dostupný → zvýrazňování syntaxe nebude fungovat.");
    77 			System.err.println("Můžete ho nainstalovat pomocí:");
    78 			System.err.println("\t$ aptitude install python-pygments   # (Debian/Ubuntu)");
    79 			System.err.println("\t$ yum install python-pygments        # (Fedora/RedHat)");
    80 			return null;
    81 		}
    82 	}
    83 
    84 	/**
    85 	 * Vygeneruje CSS styl pro zvýrazňování syntaxe.
    86 	 * @return obsah CSS souboru nebo null, pokud generování nebylo možné
    87 	 */
    88 	public static String generujCssSyntaxe() throws IOException, InterruptedException {
    89 		if (isPrikazDostupny(PŘÍKAZ_PYGMENTIZE)) {
    90 			Runtime r = Runtime.getRuntime();
    91 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"});
    92 			return načtiProud(p.getInputStream());
    93 		} else {
    94 			return null;
    95 		}
    96 	}
    97 
    98 	/**
    99 	 * Vytvoří obrázek s diagramem.
   100 	 * @param zadání definice diagramu ve formátu dot
   101 	 * @param vodorovně zda má být graf orientovaný vodorovně
   102 	 * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě.
   103 	 */
   104 	public static String vytvořDiagram(String zadání, boolean vodorovně) throws IOException, InterruptedException {
   105 		if (isPrikazDostupny(PŘÍKAZ_DOT)) {
   106 			počítadloDiagramů++;
   107 			String soubor = "diagram-" + počítadloDiagramů;
   108 			String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor;
   109 
   110 			StringBuilder zdroják = new StringBuilder(zadání.length() + 200);
   111 
   112 			zdroják.append("digraph d {\n");
   113 			zdroják.append("\tbgcolor=\"transparent\";\n");
   114 			if (vodorovně) {
   115 				zdroják.append("\trankdir=LR;");
   116 			}
   117 			zdroják.append(zadání);
   118 			zdroják.append("}\n");
   119 
   120 			Runtime r = Runtime.getRuntime();
   121 			Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"});
   122 
   123 			/**
   124 			 * TODO: generovat i PNG bitmapu
   125 			 */
   126 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   127 			vstupProcesu.print(zdroják.toString());
   128 			vstupProcesu.close();
   129 
   130 			String chyby = načtiProud(p.getErrorStream());
   131 
   132 			p.waitFor();
   133 
   134 			if (chyby.length() == 0) {
   135 				return soubor;
   136 			} else {
   137 				System.err.print("Při vytváření diagramu došlo k chybě: " + chyby);
   138 				return null;
   139 			}
   140 		} else {
   141 			System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit.");
   142 			System.err.println("Můžete ho nainstalovat pomocí:");
   143 			System.err.println("\t$ aptitude install graphviz   # (Debian/Ubuntu)");
   144 			System.err.println("\t$ yum install graphviz        # (Fedora/RedHat)");
   145 			return null;
   146 		}
   147 	}
   148 
   149 	/**
   150 	 * Čte proud dat dokud to jde a výsledek pak vrátí jako text.
   151 	 * @param proud vstupní proud
   152 	 * @return obsah proudu jako text
   153 	 * @throws IOException 
   154 	 */
   155 	private static String načtiProud(InputStream proud) throws IOException {
   156 		StringBuilder výsledek = new StringBuilder();
   157 		BufferedReader buf = new BufferedReader(new InputStreamReader(proud));
   158 		while (true) {
   159 			String radek = buf.readLine();
   160 			if (radek == null) {
   161 				break;
   162 			} else {
   163 				výsledek.append(radek);
   164 				výsledek.append("\n");
   165 			}
   166 		}
   167 		return výsledek.toString();
   168 	}
   169 
   170 	/**
   171 	 * Pomocí programu which zjistí, jestli je daný příkaz v systému přítomný.
   172 	 * @param příkaz jehož přítomnost zjišťujeme
   173 	 * @return true pokud příkaz v systému existuje
   174 	 */
   175 	private static boolean isPrikazDostupny(String příkaz) {
   176 		try {
   177 			Runtime r = Runtime.getRuntime();
   178 			Process p = r.exec(new String[]{PŘÍKAZ_WHICH, příkaz});
   179 			p.waitFor();
   180 			return p.exitValue() == 0;
   181 		} catch (Exception e) {
   182 			System.err.printf("Při zjišťování dostupnosti příkazu „%s“ došlo k chybě: %s", příkaz, e.getLocalizedMessage());
   183 			return false;
   184 		}
   185 	}
   186 }