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