šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java
author František Kučera <franta-hg@frantovo.cz>
Mon Aug 22 13:57:20 2011 +0200 (2011-08-22)
changeset 31 da6ae32853cb
parent 30 cefd5fe75cb8
child 32 6bc25517ac4f
permissions -rw-r--r--
Zvýrazňování syntaxe #12 – prakticky hotové.
     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: časem rozdělit na více modulů (jmenných prostorů).
    17  * 
    18  * @author fiki
    19  */
    20 public class Funkce {
    21 
    22 	private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize";
    23 	private static final String PŘÍKAZ_WHICH = "which";
    24 
    25 	/**
    26 	 * Zjištuje, kdy byl naposledy daný soubor změněn.
    27 	 * @param soubor cesta k souboru
    28 	 * @return datum poslední změny
    29 	 * @throws URISyntaxException
    30 	 */
    31 	public static Date posledníZměna(String soubor) throws URISyntaxException {
    32 		URI uri = new URI(soubor);
    33 		File f = new File(uri);
    34 		return new Date(f.lastModified());
    35 	}
    36 
    37 	/**
    38 	 * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize.
    39 	 * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu
    40 	 * @param jazyk předáme příkazu pygmentize jako parametr -l &lt;lexer&gt;
    41 	 * @return zvýrazněný text nebo null, pokud došlo k chybě.
    42 	 * TODO: 
    43 	 *	- použít (?) místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html
    44 	 *  - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize)
    45 	 */
    46 	public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException {
    47 		if (jazyk == null || jazyk.length() == 0) {
    48 			System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat.");
    49 			return null;
    50 		} else if (isPrikazDostupny(PŘÍKAZ_PYGMENTIZE)) {
    51 			Runtime r = Runtime.getRuntime();
    52 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk});
    53 
    54 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
    55 			vstupProcesu.print(zdroják);
    56 			vstupProcesu.close();
    57 
    58 			String výsledek = načtiProud(p.getInputStream());
    59 			String chyby = načtiProud(p.getErrorStream());
    60 
    61 			p.waitFor();
    62 
    63 			if (chyby.length() == 0) {
    64 				// Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup.
    65 				return výsledek;
    66 			} else {
    67 				System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby);
    68 				return null;
    69 			}
    70 		} else {
    71 			System.err.println("Příkaz " + PŘÍKAZ_PYGMENTIZE + " není na vašem systému dostupný → zvýrazňování syntaxe nebude fungovat.");
    72 			System.err.println("Můžete ho nainstalovat pomocí:");
    73 			System.err.println("\t$ aptitude install python-pygments   # (Debian/Ubuntu)");
    74 			System.err.println("\t$ yum install python-pygments        # (Fedora/RedHat)");
    75 			return null;
    76 		}
    77 	}
    78 
    79 	/**
    80 	 * Vygeneruje CSS styl pro zvýrazňování syntaxe.
    81 	 * @return obsah CSS souboru nebo null, pokud generování nebylo možné
    82 	 */
    83 	public static String generujCssSyntaxe() throws IOException, InterruptedException {
    84 		if (isPrikazDostupny(PŘÍKAZ_PYGMENTIZE)) {
    85 			Runtime r = Runtime.getRuntime();
    86 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"});
    87 			return načtiProud(p.getInputStream());
    88 		} else {
    89 			return null;
    90 		}
    91 	}
    92 
    93 	/**
    94 	 * Čte proud dat dokud to jde a výsledek pak vrátí jako text.
    95 	 * @param proud vstupní proud
    96 	 * @return obsah proudu jako text
    97 	 * @throws IOException 
    98 	 */
    99 	private static String načtiProud(InputStream proud) throws IOException {
   100 		StringBuilder výsledek = new StringBuilder();
   101 		BufferedReader buf = new BufferedReader(new InputStreamReader(proud));
   102 		while (true) {
   103 			String radek = buf.readLine();
   104 			if (radek == null) {
   105 				break;
   106 			} else {
   107 				výsledek.append(radek);
   108 				výsledek.append("\n");
   109 			}
   110 		}
   111 		return výsledek.toString();
   112 	}
   113 
   114 	/**
   115 	 * Pomocí programu which zjistí, jestli je daný příkaz v systému přítomný.
   116 	 * @param příkaz jehož přítomnost zjišťujeme
   117 	 * @return true pokud příkaz v systému existuje
   118 	 */
   119 	private static boolean isPrikazDostupny(String příkaz) {
   120 		try {
   121 			Runtime r = Runtime.getRuntime();
   122 			Process p = r.exec(new String[]{PŘÍKAZ_WHICH, příkaz});
   123 			p.waitFor();
   124 			return p.exitValue() == 0;
   125 		} catch (Exception e) {
   126 			System.err.printf("Při zjišťování dostupnosti příkazu „%s“ došlo k chybě: %s", příkaz, e.getLocalizedMessage());
   127 			return false;
   128 		}
   129 	}
   130 }