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