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