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