šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Skriptování.java
author František Kučera <franta-hg@frantovo.cz>
Thu, 08 Aug 2013 14:48:28 +0200
changeset 129 36c2e2bc2eb4
parent 113 18bf0044f5ab
child 136 d5feb9d8ebc3
permissions -rw-r--r--
Ant: úloha pro publikování obsahu
franta-hg@94
     1
/**
franta-hg@94
     2
 * XML Web generátor – program na generování webových stránek
franta-hg@94
     3
 * Copyright © 2012 František Kučera (frantovo.cz)
franta-hg@94
     4
 *
franta-hg@94
     5
 * This program is free software: you can redistribute it and/or modify
franta-hg@94
     6
 * it under the terms of the GNU General Public License as published by
franta-hg@94
     7
 * the Free Software Foundation, either version 3 of the License, or
franta-hg@94
     8
 * (at your option) any later version.
franta-hg@94
     9
 *
franta-hg@94
    10
 * This program is distributed in the hope that it will be useful,
franta-hg@94
    11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@94
    12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@94
    13
 * GNU General Public License for more details.
franta-hg@94
    14
 *
franta-hg@94
    15
 * You should have received a copy of the GNU General Public License
franta-hg@94
    16
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@94
    17
 */
franta-hg@94
    18
package cz.frantovo.xmlWebGenerator.makra;
franta-hg@94
    19
franta-hg@94
    20
import static cz.frantovo.xmlWebGenerator.NástrojeCLI.načtiProud;
franta-hg@113
    21
import static cz.frantovo.xmlWebGenerator.Funkce.spojText;
franta-hg@107
    22
import static cz.frantovo.xmlWebGenerator.Xmlns.*;
franta-hg@95
    23
import java.io.ByteArrayInputStream;
franta-hg@94
    24
import java.io.File;
franta-hg@94
    25
import java.io.PrintStream;
franta-hg@94
    26
import java.net.URI;
franta-hg@94
    27
import java.util.Collections;
franta-hg@94
    28
import java.util.HashMap;
franta-hg@94
    29
import java.util.Map;
franta-hg@95
    30
import javax.xml.parsers.DocumentBuilder;
franta-hg@95
    31
import javax.xml.parsers.DocumentBuilderFactory;
franta-hg@107
    32
import javax.xml.transform.Source;
franta-hg@107
    33
import javax.xml.transform.dom.DOMSource;
franta-hg@95
    34
import org.w3c.dom.Document;
franta-hg@107
    35
import org.w3c.dom.Node;
franta-hg@94
    36
franta-hg@94
    37
/**
franta-hg@94
    38
 * Provedeme skript a do stránky vložíme jeho výstup.
franta-hg@94
    39
 *
franta-hg@94
    40
 * @author František Kučera (frantovo.cz)
franta-hg@94
    41
 */
franta-hg@94
    42
public class Skriptování {
franta-hg@94
    43
franta-hg@108
    44
	private enum FORMÁT {
franta-hg@108
    45
franta-hg@108
    46
		xml,
franta-hg@108
    47
		xhtml,
franta-hg@108
    48
		text
franta-hg@108
    49
	}
franta-hg@94
    50
	/**
franta-hg@94
    51
	 * klíč = jazyk – např. bash
franta-hg@94
    52
	 * hodnota = interpret – např. /bin/bash
franta-hg@94
    53
	 */
franta-hg@94
    54
	private static final Map<String, String> interpreti;
franta-hg@94
    55
franta-hg@94
    56
	static {
franta-hg@94
    57
		Map<String, String> podporovanýJazyk = new HashMap<String, String>();
franta-hg@94
    58
		podporovanýJazyk.put("bash", "/bin/bash");
franta-hg@94
    59
		podporovanýJazyk.put("perl", "/usr/bin/perl");
franta-hg@94
    60
		podporovanýJazyk.put("php", "/usr/bin/php");
franta-hg@94
    61
		podporovanýJazyk.put("python", "/usr/bin/python");
franta-hg@94
    62
		interpreti = Collections.unmodifiableMap(podporovanýJazyk);
franta-hg@94
    63
	}
franta-hg@94
    64
franta-hg@94
    65
	/**
franta-hg@94
    66
	 * TODO: podporovat i složitější scénáře (např. kompilaci),
franta-hg@94
    67
	 * než jen vložení do souboru a přidání správného záhlaví.
franta-hg@94
    68
	 *
franta-hg@103
    69
	 * @param skriptText skript k vykonání
franta-hg@103
    70
	 * @param skriptSoubor cesta k souboru se skriptem/programem
franta-hg@94
    71
	 * @param jazyk programovací jazyk
franta-hg@95
    72
	 * @param výstupníFormát text (výchozí) | xml (v tom případě kontrolujeme validitu)
franta-hg@94
    73
	 * @param uriStránky URI aktuálně generované stránky → proměnná prostředí
franta-hg@94
    74
	 * @param nadpisStránky nadpis stránky → proměnná prostředí
franta-hg@94
    75
	 * @param perexStránky perex stránky → proměnná prostředí
franta-hg@107
    76
	 * @return výstup příkazu buď jako textový řetězec nebo jako XML (DOMSource)
franta-hg@94
    77
	 */
franta-hg@113
    78
	public static Source interpretuj(String[] skriptText, String skriptSoubor, String jazyk, String výstupníFormát, String uriStránky, String nadpisStránky, String perexStránky) throws Exception {
franta-hg@113
    79
		String výstupSkriptu = získejVýstupSkriptu(spojText(skriptText), skriptSoubor, jazyk, uriStránky, nadpisStránky, perexStránky);
franta-hg@108
    80
		return vyrobXml(výstupSkriptu, zjistiFormát(výstupníFormát));
franta-hg@107
    81
	}
franta-hg@107
    82
franta-hg@107
    83
	private static String získejVýstupSkriptu(String skriptText, String skriptSoubor, String jazyk, String uriStránky, String nadpisStránky, String perexStránky) throws Exception {
franta-hg@107
    84
franta-hg@94
    85
		try {
franta-hg@103
    86
			if (isNeprázdný(skriptSoubor)) {
franta-hg@103
    87
				System.err.println("\tInterpretuji skript ze souboru: " + skriptSoubor);
franta-hg@94
    88
			} else {
franta-hg@103
    89
				System.err.println("\tInterpretuji skript v jazyce:   " + jazyk);
franta-hg@103
    90
			}
franta-hg@103
    91
franta-hg@103
    92
			File souborStránky = new File(new URI(uriStránky));
franta-hg@103
    93
			File f;
franta-hg@103
    94
franta-hg@103
    95
			if (isNeprázdný(skriptText)) {
franta-hg@103
    96
				/** Skript je zadán uvnitř elementu přímo ve stránce */
franta-hg@103
    97
				String interpret = interpreti.get(jazyk);
franta-hg@103
    98
				if (interpret == null) {
franta-hg@103
    99
					throw new Exception("Neznámý skriptovací jazyk: " + jazyk);
franta-hg@103
   100
				}
franta-hg@103
   101
franta-hg@103
   102
				f = File.createTempFile("xml-web-generátor-", ".skript");
franta-hg@94
   103
				f.deleteOnExit();
franta-hg@103
   104
				f.setExecutable(true);
franta-hg@94
   105
franta-hg@94
   106
				PrintStream ps = new PrintStream(f);
franta-hg@94
   107
				ps.print("#!");
franta-hg@94
   108
				ps.println(interpret);
franta-hg@94
   109
				ps.println();
franta-hg@103
   110
				ps.print(skriptText);
franta-hg@94
   111
				ps.close();
franta-hg@103
   112
			} else if (isNeprázdný(skriptSoubor)) {
franta-hg@103
   113
				/** Skript/program je uložen v externím souboru */
franta-hg@103
   114
				if (skriptSoubor.startsWith(File.separator)) {
franta-hg@103
   115
					/** absolutní cesta */
franta-hg@103
   116
					f = new File(skriptSoubor);
franta-hg@103
   117
				} else {
franta-hg@103
   118
					/** relativní cesta */
franta-hg@103
   119
					f = new File(souborStránky.getParent(), File.separatorChar + skriptSoubor);
franta-hg@103
   120
				}
franta-hg@94
   121
franta-hg@103
   122
				if (!f.canExecute()) {
franta-hg@103
   123
					throw new Exception("Soubor se skriptem není spustitelný → nastavte: chmod +x " + f);
franta-hg@103
   124
				}
franta-hg@103
   125
			} else {
franta-hg@103
   126
				throw new Exception("Musí být vyplněn text skriptu, nebo cesta k souboru.");
franta-hg@103
   127
			}
franta-hg@94
   128
franta-hg@94
   129
franta-hg@103
   130
			String[] prostředí = new String[]{
franta-hg@103
   131
				"LANG=" + System.getenv("LANG"),
franta-hg@103
   132
				"USER=" + System.getenv("USER"),
franta-hg@103
   133
				"XWG_SKRIPTOVANI_JAVA=" + "šablona" + File.separator + "funkce" + File.separator + "src" + File.separator + Skriptování.class.getName().replaceAll("\\.", File.separator) + ".java",
franta-hg@103
   134
				"XWG_STRANKA_URI=" + uriStránky, // env:URI aktuálně zpracovávané stránky
franta-hg@103
   135
				"XWG_STRANKA_SOUBOR=" + souborStránky.getAbsolutePath(), // env:absolutní cesta k souboru
franta-hg@103
   136
				"XWG_STRANKA_NADPIS=" + nadpisStránky, // env:nadpis stránky
franta-hg@103
   137
				"XWG_STRANKA_PEREX=" + perexStránky // env:perex stránky
franta-hg@103
   138
			};
franta-hg@94
   139
franta-hg@103
   140
			Runtime r = Runtime.getRuntime();
franta-hg@103
   141
			Process p = r.exec(new String[]{f.getAbsolutePath()}, prostředí);
franta-hg@94
   142
franta-hg@103
   143
			String výsledek = načtiProud(p.getInputStream());
franta-hg@103
   144
			String chyby = načtiProud(p.getErrorStream());
franta-hg@94
   145
franta-hg@103
   146
			p.waitFor();
franta-hg@94
   147
franta-hg@103
   148
			if (p.exitValue() == 0) {
franta-hg@103
   149
				if (chyby.length() > 0) {
franta-hg@103
   150
					System.err.println("--- Chybový výstup skriptu -----");
franta-hg@94
   151
					System.err.println(chyby);
franta-hg@103
   152
					System.err.println("--------------------------------");
franta-hg@103
   153
					System.err.println("Nicméně skript skončil úspěšně, takže pokračujeme dál.");
franta-hg@94
   154
				}
franta-hg@103
   155
franta-hg@107
   156
				return výsledek.trim();
franta-hg@103
   157
			} else {
franta-hg@103
   158
				System.err.println("--- Standardní výstup skriptu: -----");
franta-hg@103
   159
				System.err.println(výsledek);
franta-hg@103
   160
				System.err.println("--- Cyhbový výstup skriptu: ---------");
franta-hg@103
   161
				System.err.println(chyby);
franta-hg@103
   162
				System.err.println("--------------------------------------");
franta-hg@103
   163
				throw new Exception("Návratová hodnota: " + p.exitValue());
franta-hg@94
   164
			}
franta-hg@94
   165
		} catch (Exception e) {
franta-hg@107
   166
			System.err.println("Došlo k chybě při vykonávání skriptu.");
franta-hg@94
   167
			System.err.println("--------");
franta-hg@103
   168
			System.err.println(skriptText);
franta-hg@94
   169
			System.err.println("--------");
franta-hg@94
   170
			e.printStackTrace(System.err);
franta-hg@107
   171
			throw e;
franta-hg@95
   172
		}
franta-hg@95
   173
	}
franta-hg@95
   174
franta-hg@103
   175
	private static boolean isNeprázdný(String s) {
franta-hg@103
   176
		return !(s == null || s.trim().isEmpty());
franta-hg@103
   177
	}
franta-hg@103
   178
franta-hg@108
   179
	private static FORMÁT zjistiFormát(String výstupníFormát) {
franta-hg@108
   180
		try {
franta-hg@108
   181
			return FORMÁT.valueOf(výstupníFormát);
franta-hg@108
   182
		} catch (NullPointerException e) {
franta-hg@108
   183
			return FORMÁT.text;
franta-hg@108
   184
		} catch (IllegalArgumentException e) {
franta-hg@108
   185
			return FORMÁT.text;
franta-hg@108
   186
		}
franta-hg@108
   187
	}
franta-hg@108
   188
franta-hg@95
   189
	/**
franta-hg@107
   190
	 * @param zadání výstup vygenerovaný skriptem
franta-hg@107
   191
	 * @param xmlFormát formát zadání: true = xml fragment | false = prostý text
franta-hg@107
   192
	 * @return xml fragment nebo prostý text zabalený do html/body
franta-hg@107
   193
	 * @throws Exception
franta-hg@95
   194
	 */
franta-hg@108
   195
	private static Source vyrobXml(String zadání, FORMÁT formát) throws Exception {
franta-hg@107
   196
		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
franta-hg@107
   197
		DocumentBuilder db = dbf.newDocumentBuilder();
franta-hg@107
   198
		Document d;
franta-hg@107
   199
franta-hg@108
   200
franta-hg@108
   201
		if (formát == FORMÁT.text) {
franta-hg@107
   202
			d = db.newDocument();
franta-hg@107
   203
			Node html = d.createElementNS(XHTML, "html");
franta-hg@107
   204
			Node body = d.createElementNS(XHTML, "body");
franta-hg@107
   205
			Node text = d.createTextNode(zadání);
franta-hg@107
   206
			body.appendChild(text);
franta-hg@107
   207
			html.appendChild(body);
franta-hg@107
   208
			d.appendChild(html);
franta-hg@108
   209
		} else {
franta-hg@108
   210
			if (formát == FORMÁT.xhtml) {
franta-hg@108
   211
				zadání = "<html xmlns='" + XHTML + "' xmlns:m='" + MAKRO + "'><body>" + zadání + "</body></html>";
franta-hg@108
   212
			}
franta-hg@108
   213
			try {
franta-hg@108
   214
				d = db.parse(new ByteArrayInputStream(zadání.getBytes()));
franta-hg@108
   215
			} catch (Exception e) {
franta-hg@108
   216
				System.err.println("Chyba: Skript vrátil neplatné XML.");
franta-hg@108
   217
				throw e;
franta-hg@108
   218
			}
franta-hg@95
   219
		}
franta-hg@107
   220
franta-hg@107
   221
		return new DOMSource(d);
franta-hg@95
   222
	}
franta-hg@94
   223
}