šablona/funkce/src/cz/frantovo/xmlWebGenerator/Funkce.java
author František Kučera <franta-hg@frantovo.cz>
Sat, 07 Jan 2012 19:06:18 +0100
changeset 69 e7908e307b61
parent 68 2e6d7bfcd84f
child 76 c7746d95283d
permissions -rw-r--r--
Diagramy #13: diagramy ve zvláštní složce zatím nebudou..
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@67
    26
import java.net.URLDecoder;
franta-hg@67
    27
import java.nio.charset.Charset;
franta-hg@38
    28
import static cz.frantovo.xmlWebGenerator.NástrojeCLI.*;
franta-hg@6
    29
franta-hg@28
    30
/**
franta-hg@28
    31
 * Knihovna funkcí volaných z XSLT.
franta-hg@28
    32
 *  
franta-hg@36
    33
 * TODO:
franta-hg@32
    34
 *	- rozdělit na více modulů (jmenných prostorů).
franta-hg@32
    35
 *	- CLI konektor
franta-hg@28
    36
 * 
franta-hg@28
    37
 * @author fiki
franta-hg@28
    38
 */
franta-hg@6
    39
public class Funkce {
franta-hg@27
    40
franta-hg@30
    41
	private static final String PŘÍKAZ_PYGMENTIZE = "pygmentize";
franta-hg@32
    42
	private static final String PŘÍKAZ_DOT = "dot";
franta-hg@37
    43
	private static final String PŘÍKAZ_MARKDOWN = "markdown";
franta-hg@32
    44
	private static final String ADRESÁŘ_VÝSTUPNÍ = "výstup";
franta-hg@32
    45
	private static int počítadloDiagramů = 0;
franta-hg@69
    46
	private static String počítadloDiagramůKontext = ""; // aktuálně zpracovávaná stránka, při změně vynulujeme počítadlo
franta-hg@30
    47
franta-hg@28
    48
	/**
franta-hg@28
    49
	 * Zjištuje, kdy byl naposledy daný soubor změněn.
franta-hg@28
    50
	 * @param soubor cesta k souboru
franta-hg@28
    51
	 * @return datum poslední změny
franta-hg@28
    52
	 * @throws URISyntaxException
franta-hg@28
    53
	 */
franta-hg@21
    54
	public static Date posledníZměna(String soubor) throws URISyntaxException {
franta-hg@28
    55
		URI uri = new URI(soubor);
franta-hg@28
    56
		File f = new File(uri);
franta-hg@28
    57
		return new Date(f.lastModified());
franta-hg@21
    58
	}
franta-hg@27
    59
franta-hg@27
    60
	/**
franta-hg@27
    61
	 * Zvýrazňuje syntaxi zdrojového kódu. Používá k tomu externí program/knihovnu pygmentize.
franta-hg@27
    62
	 * @param zdroják zdrojový kód, který předáme příkazu pygmentize na standardním vstupu
franta-hg@27
    63
	 * @param jazyk předáme příkazu pygmentize jako parametr -l &lt;lexer&gt;
franta-hg@28
    64
	 * @return zvýrazněný text nebo null, pokud došlo k chybě.
franta-hg@31
    65
	 * TODO: 
franta-hg@36
    66
	 *	- vracet místo textu instanci com.icl.saxon.om.NodeInfo http://saxon.sourceforge.net/saxon6.5.3/extensibility.html
franta-hg@31
    67
	 *  - nebo kontrolovat validitu vygenerovaného kódu (v současnosti se spoléháme na bezchybnost pygmentize)
franta-hg@27
    68
	 */
franta-hg@27
    69
	public static String zvýrazniSyntaxi(String zdroják, String jazyk) throws IOException, InterruptedException {
franta-hg@28
    70
		if (jazyk == null || jazyk.length() == 0) {
franta-hg@28
    71
			System.err.println("Není vyplněn atribut „jazyk“ → není jasné, jak se má zvýrazňovat.");
franta-hg@28
    72
			return null;
franta-hg@36
    73
		} else if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) {
franta-hg@27
    74
			Runtime r = Runtime.getRuntime();
franta-hg@30
    75
			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-f", "html", "-l", jazyk});
franta-hg@27
    76
franta-hg@27
    77
			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
franta-hg@27
    78
			vstupProcesu.print(zdroják);
franta-hg@27
    79
			vstupProcesu.close();
franta-hg@27
    80
franta-hg@27
    81
			String výsledek = načtiProud(p.getInputStream());
franta-hg@27
    82
			String chyby = načtiProud(p.getErrorStream());
franta-hg@27
    83
franta-hg@27
    84
			p.waitFor();
franta-hg@27
    85
franta-hg@27
    86
			if (chyby.length() == 0) {
franta-hg@28
    87
				// Pozor: pygmentize má i při chybě návratový kód 0 → je potřeba kontrolovat chybový výstup.
franta-hg@27
    88
				return výsledek;
franta-hg@27
    89
			} else {
franta-hg@28
    90
				System.err.print("Při zvýrazňování syntaxe došlo k chybě: " + chyby);
franta-hg@28
    91
				return null;
franta-hg@27
    92
			}
franta-hg@27
    93
		} else {
franta-hg@30
    94
			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
    95
			System.err.println("Můžete ho nainstalovat pomocí:");
franta-hg@28
    96
			System.err.println("\t$ aptitude install python-pygments   # (Debian/Ubuntu)");
franta-hg@28
    97
			System.err.println("\t$ yum install python-pygments        # (Fedora/RedHat)");
franta-hg@28
    98
			return null;
franta-hg@27
    99
		}
franta-hg@27
   100
	}
franta-hg@27
   101
franta-hg@28
   102
	/**
franta-hg@31
   103
	 * Vygeneruje CSS styl pro zvýrazňování syntaxe.
franta-hg@31
   104
	 * @return obsah CSS souboru nebo null, pokud generování nebylo možné
franta-hg@31
   105
	 */
franta-hg@31
   106
	public static String generujCssSyntaxe() throws IOException, InterruptedException {
franta-hg@36
   107
		if (isPříkazDostupný(PŘÍKAZ_PYGMENTIZE)) {
franta-hg@31
   108
			Runtime r = Runtime.getRuntime();
franta-hg@31
   109
			Process p = r.exec(new String[]{PŘÍKAZ_PYGMENTIZE, "-S", "default", "-f", "html"});
franta-hg@31
   110
			return načtiProud(p.getInputStream());
franta-hg@31
   111
		} else {
franta-hg@31
   112
			return null;
franta-hg@31
   113
		}
franta-hg@31
   114
	}
franta-hg@31
   115
franta-hg@31
   116
	/**
franta-hg@32
   117
	 * Vytvoří obrázek s diagramem.
franta-hg@32
   118
	 * @param zadání definice diagramu ve formátu dot
franta-hg@52
   119
	 * @param vodorovně zda má být graf orientovaný vodorovně (funguje jen při <code>kompletní = false</code>)
franta-hg@52
   120
	 * @param kompletní false, pokud k zadání chceme doplnit <code>digraph d {…}</code>
franta-hg@67
   121
	 * @param kontext kam diagram patří – typicky název stránky, do které je vložen
franta-hg@67
   122
	 * diagramy se pak budou číslovat v rámci tohoto kontextu 
franta-hg@67
   123
	 * → nebude docházet k přepisování diagramů jiných stránek při částečném přegenerování webu.
franta-hg@67
   124
	 * @param souborZadání null pokud chceme automatické číslování | nebo zadáme název souboru se zadáním diagramu – vygenerovaný diagram se pak bude jmenovat stejně
franta-hg@32
   125
	 * @return název souboru bez přípony, který byl vytvořen, nebo null, pokud došlo k chybě.
franta-hg@32
   126
	 */
franta-hg@67
   127
	public static String vytvořDiagram(String zadání, boolean vodorovně, boolean kompletní, String kontext, String souborZadání) throws IOException, InterruptedException {
franta-hg@36
   128
		if (isPříkazDostupný(PŘÍKAZ_DOT)) {
franta-hg@67
   129
franta-hg@67
   130
			String soubor;
franta-hg@67
   131
			if (souborZadání == null) {
franta-hg@67
   132
				if (kontext == null) {
franta-hg@67
   133
					počítadloDiagramů++;
franta-hg@67
   134
					soubor = "diagram-" + počítadloDiagramů;
franta-hg@67
   135
				} else {
franta-hg@67
   136
					// TODO: tohle by se mělo udělat v XSLT
franta-hg@67
   137
					kontext = URLDecoder.decode(kontext, Charset.defaultCharset().name());
franta-hg@67
   138
					
franta-hg@67
   139
					// Každá stránka bude mít svoje diagramy číslované od 1
franta-hg@67
   140
					if (!počítadloDiagramůKontext.equals(kontext)) {
franta-hg@67
   141
						počítadloDiagramůKontext = kontext;
franta-hg@67
   142
						počítadloDiagramů = 0;
franta-hg@67
   143
					}
franta-hg@67
   144
					
franta-hg@67
   145
					počítadloDiagramů++;
franta-hg@67
   146
					soubor = "diagram-" + kontext + "-" + počítadloDiagramů;
franta-hg@67
   147
				}
franta-hg@67
   148
			} else {
franta-hg@67
   149
				soubor = souborZadání;
franta-hg@67
   150
			}
franta-hg@69
   151
			String souborSložka = ADRESÁŘ_VÝSTUPNÍ + File.separator + soubor;
franta-hg@32
   152
franta-hg@52
   153
			String zdroják;
franta-hg@52
   154
			if (kompletní) {
franta-hg@52
   155
				zdroják = zadání;
franta-hg@52
   156
			} else {
franta-hg@52
   157
				StringBuilder b = new StringBuilder(zadání.length() + 200);
franta-hg@52
   158
				b.append("digraph d {\n");
franta-hg@52
   159
				b.append("\tbgcolor=\"transparent\";\n");
franta-hg@52
   160
				if (vodorovně) {
franta-hg@52
   161
					b.append("\trankdir=LR;");
franta-hg@52
   162
				}
franta-hg@52
   163
				b.append(zadání);
franta-hg@52
   164
				b.append("}\n");
franta-hg@52
   165
				zdroják = b.toString();
franta-hg@32
   166
			}
franta-hg@32
   167
franta-hg@32
   168
			Runtime r = Runtime.getRuntime();
franta-hg@32
   169
			Process p = r.exec(new String[]{PŘÍKAZ_DOT, "-T", "svg", "-o", souborSložka + ".svg"});
franta-hg@32
   170
franta-hg@32
   171
			/**
franta-hg@32
   172
			 * TODO: generovat i PNG bitmapu
franta-hg@32
   173
			 */
franta-hg@32
   174
			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
franta-hg@32
   175
			vstupProcesu.print(zdroják.toString());
franta-hg@32
   176
			vstupProcesu.close();
franta-hg@32
   177
franta-hg@32
   178
			String chyby = načtiProud(p.getErrorStream());
franta-hg@32
   179
franta-hg@32
   180
			p.waitFor();
franta-hg@32
   181
franta-hg@32
   182
			if (chyby.length() == 0) {
franta-hg@69
   183
				return soubor;
franta-hg@32
   184
			} else {
franta-hg@32
   185
				System.err.print("Při vytváření diagramu došlo k chybě: " + chyby);
franta-hg@32
   186
				return null;
franta-hg@32
   187
			}
franta-hg@32
   188
		} else {
franta-hg@32
   189
			System.err.println("Příkaz " + PŘÍKAZ_DOT + " není na vašem systému dostupný → diagramy nelze vygreslit.");
franta-hg@32
   190
			System.err.println("Můžete ho nainstalovat pomocí:");
franta-hg@32
   191
			System.err.println("\t$ aptitude install graphviz   # (Debian/Ubuntu)");
franta-hg@32
   192
			System.err.println("\t$ yum install graphviz        # (Fedora/RedHat)");
franta-hg@32
   193
			return null;
franta-hg@32
   194
		}
franta-hg@32
   195
	}
franta-hg@32
   196
franta-hg@32
   197
	/**
franta-hg@37
   198
	 * Převede text ve wiki syntaxi do XHTML.
franta-hg@37
   199
	 * @param wiki vstupní text v dané wiki syntaxi
franta-hg@37
   200
	 * @param syntaxe null nebo volitelně syntaxe (markdown, texy)
franta-hg@37
   201
	 * @return naformátované XHTML
franta-hg@37
   202
	 */
franta-hg@37
   203
	public static String formátujWiki(String wiki, String syntaxe) throws IOException {
franta-hg@37
   204
		if (isPříkazDostupný(PŘÍKAZ_MARKDOWN)) {
franta-hg@37
   205
			Runtime r = Runtime.getRuntime();
franta-hg@37
   206
			Process p = r.exec(new String[]{PŘÍKAZ_MARKDOWN});
franta-hg@37
   207
franta-hg@37
   208
			/**
franta-hg@37
   209
			 * TODO: oříznout mezery na začátcích řádků, pokud je jich všude stejně?
franta-hg@37
   210
			 * (odsazení v XML)
franta-hg@37
   211
			 */
franta-hg@37
   212
			PrintStream vstupProcesu = new PrintStream(p.getOutputStream());
franta-hg@37
   213
			vstupProcesu.print(wiki);
franta-hg@37
   214
			vstupProcesu.close();
franta-hg@37
   215
franta-hg@37
   216
			String chyby = načtiProud(p.getErrorStream());
franta-hg@37
   217
			String xhtml = načtiProud(p.getInputStream());
franta-hg@37
   218
franta-hg@37
   219
			if (chyby.length() == 0) {
franta-hg@37
   220
				return xhtml;
franta-hg@37
   221
			} else {
franta-hg@37
   222
				System.err.print("Při zpracování wiki syntaxe došlo k chybě: " + chyby);
franta-hg@37
   223
				return null;
franta-hg@37
   224
			}
franta-hg@37
   225
		} else {
franta-hg@37
   226
			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
   227
			System.err.println("Můžete ho nainstalovat pomocí:");
franta-hg@37
   228
			System.err.println("\t$ aptitude install markdown         # (Debian/Ubuntu)");
franta-hg@37
   229
			System.err.println("\t$ yum install perl-Text-Markdown    # (Fedora/RedHat)");
franta-hg@37
   230
			return null;
franta-hg@37
   231
		}
franta-hg@37
   232
	}
franta-hg@6
   233
}