šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java
author František Kučera <franta-hg@frantovo.cz>
Sat Jan 07 01:57:27 2012 +0100 (2012-01-07)
changeset 57 768a7eecb0cf
parent 43 4a4364826e59
child 61 9503eb8377f1
permissions -rw-r--r--
odkaz #16 na RFCčko musí být číselný
     1 package cz.frantovo.xmlWebGenerator;
     2 
     3 import java.io.File;
     4 import java.io.IOException;
     5 import java.io.PrintStream;
     6 import java.util.Date;
     7 import java.net.URI;
     8 import java.net.URISyntaxException;
     9 import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*;
    10 
    11 /**
    12  * Knihovna funkcí volaných z XSLT.
    13  *  
    14  * TODO:
    15  *	- rozdělit na více modulů (jmenných prostorů).
    16  *	- CLI konektor
    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_DOT = "dot";
    24 	private static final String PŘÍKAZ_MARKDOWN = "markdown";
    25 	private static final String ADRESÁŘ_VÝSTUPNÍ = "výstup";
    26 	private static int počítadloDiagramů = 0;
    27 
    28 	/**
    29 	 * Zjištuje, kdy byl naposledy daný soubor změněn.
    30 	 * @param soubor cesta k souboru
    31 	 * @return datum poslední změny
    32 	 * @throws URISyntaxException
    33 	 */
    34 	public static Date posledníZměna(String soubor) throws URISyntaxException {
    35 		URI uri = new URI(soubor);
    36 		File f = new File(uri);
    37 		return new Date(f.lastModified());
    38 	}
    39 
    40 	/**
    41 	 * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize.
    42 	 * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu
    43 	 * @param jazyk předáme příkazu pygmentize jako parametr -l &lt;lexer&gt;
    44 	 * @return zvýrazněný text nebo null, pokud došlo k chybě.
    45 	 * TODO: 
    46 	 *	- vracet místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html
    47 	 *  - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize)
    48 	 */
    49 	public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException {
    50 		if (jazyk == null || jazyk.length() == 0) {
    51 			System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat.");
    52 			return null;
    53 		} else if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) {
    54 			Runtime r = Runtime.getRuntime();
    55 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk});
    56 
    57 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
    58 			vstupProcesu.print(zdroják);
    59 			vstupProcesu.close();
    60 
    61 			String výsledek = načtiProud(p.getInputStream());
    62 			String chyby = načtiProud(p.getErrorStream());
    63 
    64 			p.waitFor();
    65 
    66 			if (chyby.length() == 0) {
    67 				// Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup.
    68 				return výsledek;
    69 			} else {
    70 				System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby);
    71 				return null;
    72 			}
    73 		} else {
    74 			System.err.println("Příkaz " + PŘÍKAZ_PYGMENTIZE + " není na vašem systému dostupný → zvýrazňování syntaxe nebude fungovat.");
    75 			System.err.println("Můžete ho nainstalovat pomocí:");
    76 			System.err.println("\t$ aptitude install python-pygments   # (Debian/Ubuntu)");
    77 			System.err.println("\t$ yum install python-pygments        # (Fedora/RedHat)");
    78 			return null;
    79 		}
    80 	}
    81 
    82 	/**
    83 	 * Vygeneruje CSS styl pro zvýrazňování syntaxe.
    84 	 * @return obsah CSS souboru nebo null, pokud generování nebylo možné
    85 	 */
    86 	public static String generujCssSyntaxe() throws IOException, InterruptedException {
    87 		if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) {
    88 			Runtime r = Runtime.getRuntime();
    89 			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"});
    90 			return načtiProud(p.getInputStream());
    91 		} else {
    92 			return null;
    93 		}
    94 	}
    95 
    96 	/**
    97 	 * Vytvoří obrázek s diagramem.
    98 	 * @param zadání definice diagramu ve formátu dot
    99 	 * @param vodorovně zda má být graf orientovaný vodorovně (funguje jen při <code>kompletní = false</code>)
   100 	 * @param kompletní false, pokud k zadání chceme doplnit <code>digraph d {…}</code>
   101 	 * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě.
   102 	 */
   103 	public static String vytvořDiagram(String zadání, boolean vodorovně, boolean kompletní) throws IOException, InterruptedException {
   104 		if (isPříkazDostupný(PŘÍKAZ_DOT)) {
   105 			počítadloDiagramů++;
   106 			String soubor = "diagram-" + počítadloDiagramů;
   107 			String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor;
   108 
   109 			String zdroják;
   110 			if (kompletní) {
   111 				zdroják = zadání;
   112 			} else {
   113 				StringBuilder b = new StringBuilder(zadání.length() + 200);
   114 				b.append("digraph d {\n");
   115 				b.append("\tbgcolor=\"transparent\";\n");
   116 				if (vodorovně) {
   117 					b.append("\trankdir=LR;");
   118 				}
   119 				b.append(zadání);
   120 				b.append("}\n");
   121 				zdroják = b.toString();
   122 			}
   123 
   124 			Runtime r = Runtime.getRuntime();
   125 			Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"});
   126 
   127 			/**
   128 			 * TODO: generovat i PNG bitmapu
   129 			 */
   130 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   131 			vstupProcesu.print(zdroják.toString());
   132 			vstupProcesu.close();
   133 
   134 			String chyby = načtiProud(p.getErrorStream());
   135 
   136 			p.waitFor();
   137 
   138 			if (chyby.length() == 0) {
   139 				return soubor;
   140 			} else {
   141 				System.err.print("Při vytváření diagramu došlo k chybě: " + chyby);
   142 				return null;
   143 			}
   144 		} else {
   145 			System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit.");
   146 			System.err.println("Můžete ho nainstalovat pomocí:");
   147 			System.err.println("\t$ aptitude install graphviz   # (Debian/Ubuntu)");
   148 			System.err.println("\t$ yum install graphviz        # (Fedora/RedHat)");
   149 			return null;
   150 		}
   151 	}
   152 
   153 	/**
   154 	 * Převede text ve wiki syntaxi do XHTML.
   155 	 * @param wiki vstupní text v dané wiki syntaxi
   156 	 * @param syntaxe null nebo volitelně syntaxe (markdown, texy)
   157 	 * @return naformátované XHTML
   158 	 */
   159 	public static String formátujWiki(String wiki, String syntaxe) throws IOException {
   160 		if (isPříkazDostupný(PŘÍKAZ_MARKDOWN)) {
   161 			Runtime r = Runtime.getRuntime();
   162 			Process p = r.exec(new String[]{PŘÍKAZ_MARKDOWN});
   163 
   164 			/**
   165 			 * TODO: oříznout mezery na začátcích řádků, pokud je jich všude stejně?
   166 			 * (odsazení v XML)
   167 			 */
   168 			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
   169 			vstupProcesu.print(wiki);
   170 			vstupProcesu.close();
   171 
   172 			String chyby = načtiProud(p.getErrorStream());
   173 			String xhtml = načtiProud(p.getInputStream());
   174 
   175 			if (chyby.length() == 0) {
   176 				return xhtml;
   177 			} else {
   178 				System.err.print("Při zpracování wiki syntaxe došlo k chybě: " + chyby);
   179 				return null;
   180 			}
   181 		} else {
   182 			System.err.println("Příkaz " + PŘÍKAZ_MARKDOWN + " není na vašem systému dostupný → nelze formátovat texty ve wiki syntaxi.");
   183 			System.err.println("Můžete ho nainstalovat pomocí:");
   184 			System.err.println("\t$ aptitude install markdown         # (Debian/Ubuntu)");
   185 			System.err.println("\t$ yum install perl-Text-Markdown    # (Fedora/RedHat)");
   186 			return null;
   187 		}
   188 	}
   189 }