šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 31 Dec 2011 17:52:21 +0100
changeset 40 487f13126b62
parent 38 43505795334d
child 43 4a4364826e59
permissions -rw-r--r--
Zvýrazňování syntaxe: zdroják nemusí být vložen uvnitř značky <m:pre/>, ale může být v souboru určeném atributem src="název-souboru".
     1 package cz.frantovo.xmlWebGenerator;
     2 
     3 import java.io.File;
     4 import java.io.FileInputStream;
     5 import java.io.IOException;
     6 import java.io.PrintStream;
     7 import java.util.Date;
     8 import java.net.URI;
     9 import java.net.URISyntaxException;
    10 import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*;
    11 
    12 /**
    13  * Knihovna funkcí volaných z XSLT.
    14  *  
    15  * TODO:
    16  *	- rozdělit na více modulů (jmenných prostorů).
    17  *	- CLI konektor
    18  * 
    19  * @author fiki
    20  */
    21 public class Funkce {
    22 
    23 	private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize";
    24 	private static final String PŘÍKAZ_DOT = "dot";
    25 	private static final String PŘÍKAZ_MARKDOWN = "markdown";
    26 	private static final String ADRESÁŘ_VSTUPNÍ = "vstup";
    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 	 *	- vracet 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 (isPříkazDostupný(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 	 * TODO: prohodit volání mezi zvýrazniSyntaxiSouboru() a zvýrazniSyntaxi(), 
    86 	 * aby se nepřeváděl proud na text a pak zase na proud.
    87 	 * 
    88 	 * @param src cesta k souboru, jehož obsah se má zvýraznit a vložit
    89 	 */
    90 	public static String zvýrazniSyntaxiSouboru(String src, String jazyk) throws IOException, InterruptedException {
    91 		String zdroják = načtiProud(new FileInputStream(new File(ADRESÁŘ_VSTUPNÍ, src)));
    92 		return zvýrazniSyntaxi(zdroják, jazyk);
    93 	}
    94 
    95 	/**
    96 	 * Vygeneruje CSS styl pro zvýrazňování syntaxe.
    97 	 * @return obsah CSS souboru nebo null, pokud generování nebylo možné
    98 	 */
    99 	public static String generujCssSyntaxe() throws IOException, InterruptedException {
   100 		if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) {
   101 			Runtime r = Runtime.getRuntime();
   102 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"});
   103 			return načtiProud(p.getInputStream());
   104 		} else {
   105 			return null;
   106 		}
   107 	}
   108 
   109 	/**
   110 	 * Vytvoří obrázek s diagramem.
   111 	 * @param zadání definice diagramu ve formátu dot
   112 	 * @param vodorovně zda má být graf orientovaný vodorovně
   113 	 * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě.
   114 	 */
   115 	public static String vytvořDiagram(String zadání, boolean vodorovně) throws IOException, InterruptedException {
   116 		if (isPříkazDostupný(PŘÍKAZ_DOT)) {
   117 			počítadloDiagramů++;
   118 			String soubor = "diagram-" + počítadloDiagramů;
   119 			String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor;
   120 
   121 			StringBuilder zdroják = new StringBuilder(zadání.length() + 200);
   122 
   123 			zdroják.append("digraph d {\n");
   124 			zdroják.append("\tbgcolor=\"transparent\";\n");
   125 			if (vodorovně) {
   126 				zdroják.append("\trankdir=LR;");
   127 			}
   128 			zdroják.append(zadání);
   129 			zdroják.append("}\n");
   130 
   131 			Runtime r = Runtime.getRuntime();
   132 			Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"});
   133 
   134 			/**
   135 			 * TODO: generovat i PNG bitmapu
   136 			 */
   137 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   138 			vstupProcesu.print(zdroják.toString());
   139 			vstupProcesu.close();
   140 
   141 			String chyby = načtiProud(p.getErrorStream());
   142 
   143 			p.waitFor();
   144 
   145 			if (chyby.length() == 0) {
   146 				return soubor;
   147 			} else {
   148 				System.err.print("Při vytváření diagramu došlo k chybě: " + chyby);
   149 				return null;
   150 			}
   151 		} else {
   152 			System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit.");
   153 			System.err.println("Můžete ho nainstalovat pomocí:");
   154 			System.err.println("\t$ aptitude install graphviz   # (Debian/Ubuntu)");
   155 			System.err.println("\t$ yum install graphviz        # (Fedora/RedHat)");
   156 			return null;
   157 		}
   158 	}
   159 
   160 	/**
   161 	 * Převede text ve wiki syntaxi do XHTML.
   162 	 * @param wiki vstupní text v dané wiki syntaxi
   163 	 * @param syntaxe null nebo volitelně syntaxe (markdown, texy)
   164 	 * @return naformátované XHTML
   165 	 */
   166 	public static String formátujWiki(String wiki, String syntaxe) throws IOException {
   167 		if (isPříkazDostupný(PŘÍKAZ_MARKDOWN)) {
   168 			Runtime r = Runtime.getRuntime();
   169 			Process p = r.exec(new String[]{PŘÍKAZ_MARKDOWN});
   170 
   171 			/**
   172 			 * TODO: oříznout mezery na začátcích řádků, pokud je jich všude stejně?
   173 			 * (odsazení v XML)
   174 			 */
   175 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   176 			vstupProcesu.print(wiki);
   177 			vstupProcesu.close();
   178 
   179 			String chyby = načtiProud(p.getErrorStream());
   180 			String xhtml = načtiProud(p.getInputStream());
   181 
   182 			if (chyby.length() == 0) {
   183 				return xhtml;
   184 			} else {
   185 				System.err.print("Při zpracování wiki syntaxe došlo k chybě: " + chyby);
   186 				return null;
   187 			}
   188 		} else {
   189 			System.err.println("Příkaz " + PŘÍKAZ_MARKDOWN + " není na vašem systému dostupný → nelze formátovat texty ve wiki syntaxi.");
   190 			System.err.println("Můžete ho nainstalovat pomocí:");
   191 			System.err.println("\t$ aptitude install markdown         # (Debian/Ubuntu)");
   192 			System.err.println("\t$ yum install perl-Text-Markdown    # (Fedora/RedHat)");
   193 			return null;
   194 		}
   195 	}
   196 }