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