franta-hg@94: /**
franta-hg@94:  * XML Web generátor – program na generování webových stránek
franta-hg@94:  * Copyright © 2012 František Kučera (frantovo.cz)
franta-hg@94:  *
franta-hg@94:  * This program is free software: you can redistribute it and/or modify
franta-hg@94:  * it under the terms of the GNU General Public License as published by
franta-hg@94:  * the Free Software Foundation, either version 3 of the License, or
franta-hg@94:  * (at your option) any later version.
franta-hg@94:  *
franta-hg@94:  * This program is distributed in the hope that it will be useful,
franta-hg@94:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
franta-hg@94:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
franta-hg@94:  * GNU General Public License for more details.
franta-hg@94:  *
franta-hg@94:  * You should have received a copy of the GNU General Public License
franta-hg@94:  * along with this program. If not, see <http://www.gnu.org/licenses/>.
franta-hg@94:  */
franta-hg@94: package cz.frantovo.xmlWebGenerator.makra;
franta-hg@94: 
franta-hg@94: import static cz.frantovo.xmlWebGenerator.NástrojeCLI.načtiProud;
franta-hg@107: import static cz.frantovo.xmlWebGenerator.Xmlns.*;
franta-hg@95: import java.io.ByteArrayInputStream;
franta-hg@94: import java.io.File;
franta-hg@94: import java.io.PrintStream;
franta-hg@94: import java.net.URI;
franta-hg@94: import java.util.Collections;
franta-hg@94: import java.util.HashMap;
franta-hg@94: import java.util.Map;
franta-hg@95: import javax.xml.parsers.DocumentBuilder;
franta-hg@95: import javax.xml.parsers.DocumentBuilderFactory;
franta-hg@107: import javax.xml.transform.Source;
franta-hg@107: import javax.xml.transform.dom.DOMSource;
franta-hg@95: import org.w3c.dom.Document;
franta-hg@107: import org.w3c.dom.Node;
franta-hg@94: 
franta-hg@94: /**
franta-hg@94:  * Provedeme skript a do stránky vložíme jeho výstup.
franta-hg@94:  *
franta-hg@94:  * @author František Kučera (frantovo.cz)
franta-hg@94:  */
franta-hg@94: public class Skriptování {
franta-hg@94: 
franta-hg@94: 	/**
franta-hg@94: 	 * klíč = jazyk – např. bash
franta-hg@94: 	 * hodnota = interpret – např. /bin/bash
franta-hg@94: 	 */
franta-hg@94: 	private static final Map<String, String> interpreti;
franta-hg@94: 
franta-hg@94: 	static {
franta-hg@94: 		Map<String, String> podporovanýJazyk = new HashMap<String, String>();
franta-hg@94: 		podporovanýJazyk.put("bash", "/bin/bash");
franta-hg@94: 		podporovanýJazyk.put("perl", "/usr/bin/perl");
franta-hg@94: 		podporovanýJazyk.put("php", "/usr/bin/php");
franta-hg@94: 		podporovanýJazyk.put("python", "/usr/bin/python");
franta-hg@94: 		interpreti = Collections.unmodifiableMap(podporovanýJazyk);
franta-hg@94: 	}
franta-hg@94: 
franta-hg@94: 	/**
franta-hg@94: 	 * TODO: podporovat i složitější scénáře (např. kompilaci),
franta-hg@94: 	 * než jen vložení do souboru a přidání správného záhlaví.
franta-hg@94: 	 *
franta-hg@103: 	 * @param skriptText skript k vykonání
franta-hg@103: 	 * @param skriptSoubor cesta k souboru se skriptem/programem
franta-hg@94: 	 * @param jazyk programovací jazyk
franta-hg@95: 	 * @param výstupníFormát text (výchozí) | xml (v tom případě kontrolujeme validitu)
franta-hg@94: 	 * @param uriStránky URI aktuálně generované stránky → proměnná prostředí
franta-hg@94: 	 * @param nadpisStránky nadpis stránky → proměnná prostředí
franta-hg@94: 	 * @param perexStránky perex stránky → proměnná prostředí
franta-hg@107: 	 * @return výstup příkazu buď jako textový řetězec nebo jako XML (DOMSource)
franta-hg@94: 	 */
franta-hg@107: 	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@107: 		String výstupSkriptu = získejVýstupSkriptu(skriptText, skriptSoubor, jazyk, uriStránky, nadpisStránky, perexStránky);
franta-hg@107: 		return vyrobXml(výstupSkriptu, "xml".equals(výstupníFormát));
franta-hg@107: 	}
franta-hg@107: 
franta-hg@107: 	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: 
franta-hg@94: 		try {
franta-hg@103: 			if (isNeprázdný(skriptSoubor)) {
franta-hg@103: 				System.err.println("\tInterpretuji skript ze souboru: " + skriptSoubor);
franta-hg@94: 			} else {
franta-hg@103: 				System.err.println("\tInterpretuji skript v jazyce:   " + jazyk);
franta-hg@103: 			}
franta-hg@103: 
franta-hg@103: 			File souborStránky = new File(new URI(uriStránky));
franta-hg@103: 			File f;
franta-hg@103: 
franta-hg@103: 			if (isNeprázdný(skriptText)) {
franta-hg@103: 				/** Skript je zadán uvnitř elementu přímo ve stránce */
franta-hg@103: 				String interpret = interpreti.get(jazyk);
franta-hg@103: 				if (interpret == null) {
franta-hg@103: 					throw new Exception("Neznámý skriptovací jazyk: " + jazyk);
franta-hg@103: 				}
franta-hg@103: 
franta-hg@103: 				f = File.createTempFile("xml-web-generátor-", ".skript");
franta-hg@94: 				f.deleteOnExit();
franta-hg@103: 				f.setExecutable(true);
franta-hg@94: 
franta-hg@94: 				PrintStream ps = new PrintStream(f);
franta-hg@94: 				ps.print("#!");
franta-hg@94: 				ps.println(interpret);
franta-hg@94: 				ps.println();
franta-hg@103: 				ps.print(skriptText);
franta-hg@94: 				ps.close();
franta-hg@103: 			} else if (isNeprázdný(skriptSoubor)) {
franta-hg@103: 				/** Skript/program je uložen v externím souboru */
franta-hg@103: 				if (skriptSoubor.startsWith(File.separator)) {
franta-hg@103: 					/** absolutní cesta */
franta-hg@103: 					f = new File(skriptSoubor);
franta-hg@103: 				} else {
franta-hg@103: 					/** relativní cesta */
franta-hg@103: 					f = new File(souborStránky.getParent(), File.separatorChar + skriptSoubor);
franta-hg@103: 				}
franta-hg@94: 
franta-hg@103: 				if (!f.canExecute()) {
franta-hg@103: 					throw new Exception("Soubor se skriptem není spustitelný → nastavte: chmod +x " + f);
franta-hg@103: 				}
franta-hg@103: 			} else {
franta-hg@103: 				throw new Exception("Musí být vyplněn text skriptu, nebo cesta k souboru.");
franta-hg@103: 			}
franta-hg@94: 
franta-hg@94: 
franta-hg@103: 			String[] prostředí = new String[]{
franta-hg@103: 				"LANG=" + System.getenv("LANG"),
franta-hg@103: 				"USER=" + System.getenv("USER"),
franta-hg@103: 				"XWG_SKRIPTOVANI_JAVA=" + "šablona" + File.separator + "funkce" + File.separator + "src" + File.separator + Skriptování.class.getName().replaceAll("\\.", File.separator) + ".java",
franta-hg@103: 				"XWG_STRANKA_URI=" + uriStránky, // env:URI aktuálně zpracovávané stránky
franta-hg@103: 				"XWG_STRANKA_SOUBOR=" + souborStránky.getAbsolutePath(), // env:absolutní cesta k souboru
franta-hg@103: 				"XWG_STRANKA_NADPIS=" + nadpisStránky, // env:nadpis stránky
franta-hg@103: 				"XWG_STRANKA_PEREX=" + perexStránky // env:perex stránky
franta-hg@103: 			};
franta-hg@94: 
franta-hg@103: 			Runtime r = Runtime.getRuntime();
franta-hg@103: 			Process p = r.exec(new String[]{f.getAbsolutePath()}, prostředí);
franta-hg@94: 
franta-hg@103: 			String výsledek = načtiProud(p.getInputStream());
franta-hg@103: 			String chyby = načtiProud(p.getErrorStream());
franta-hg@94: 
franta-hg@103: 			p.waitFor();
franta-hg@94: 
franta-hg@103: 			if (p.exitValue() == 0) {
franta-hg@103: 				if (chyby.length() > 0) {
franta-hg@103: 					System.err.println("--- Chybový výstup skriptu -----");
franta-hg@94: 					System.err.println(chyby);
franta-hg@103: 					System.err.println("--------------------------------");
franta-hg@103: 					System.err.println("Nicméně skript skončil úspěšně, takže pokračujeme dál.");
franta-hg@94: 				}
franta-hg@103: 
franta-hg@107: 				return výsledek.trim();
franta-hg@103: 			} else {
franta-hg@103: 				System.err.println("--- Standardní výstup skriptu: -----");
franta-hg@103: 				System.err.println(výsledek);
franta-hg@103: 				System.err.println("--- Cyhbový výstup skriptu: ---------");
franta-hg@103: 				System.err.println(chyby);
franta-hg@103: 				System.err.println("--------------------------------------");
franta-hg@103: 				throw new Exception("Návratová hodnota: " + p.exitValue());
franta-hg@94: 			}
franta-hg@94: 		} catch (Exception e) {
franta-hg@107: 			System.err.println("Došlo k chybě při vykonávání skriptu.");
franta-hg@94: 			System.err.println("--------");
franta-hg@103: 			System.err.println(skriptText);
franta-hg@94: 			System.err.println("--------");
franta-hg@94: 			e.printStackTrace(System.err);
franta-hg@107: 			throw e;
franta-hg@95: 		}
franta-hg@95: 	}
franta-hg@95: 
franta-hg@103: 	private static boolean isNeprázdný(String s) {
franta-hg@103: 		return !(s == null || s.trim().isEmpty());
franta-hg@103: 	}
franta-hg@103: 
franta-hg@95: 	/**
franta-hg@107: 	 * @param zadání výstup vygenerovaný skriptem
franta-hg@107: 	 * @param xmlFormát formát zadání: true = xml fragment | false = prostý text
franta-hg@107: 	 * @return xml fragment nebo prostý text zabalený do html/body
franta-hg@107: 	 * @throws Exception
franta-hg@95: 	 */
franta-hg@107: 	private static Source vyrobXml(String zadání, boolean xmlFormát) throws Exception {
franta-hg@107: 		DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
franta-hg@107: 		DocumentBuilder db = dbf.newDocumentBuilder();
franta-hg@107: 		Document d;
franta-hg@107: 
franta-hg@107: 		if (xmlFormát) {
franta-hg@107: 			try {
franta-hg@107: 				zadání = "<html xmlns='" + XHTML + "' xmlns:m='" + MAKRO + "'><body>" + zadání + "</body></html>";
franta-hg@107: 				d = db.parse(new ByteArrayInputStream(zadání.getBytes()));
franta-hg@107: 			} catch (Exception e) {
franta-hg@107: 				System.err.println("Chyba: Skript vrátil neplatné XML.");
franta-hg@107: 				throw e;
franta-hg@107: 			}
franta-hg@107: 		} else {
franta-hg@107: 			d = db.newDocument();
franta-hg@107: 			Node html = d.createElementNS(XHTML, "html");
franta-hg@107: 			Node body = d.createElementNS(XHTML, "body");
franta-hg@107: 			Node text = d.createTextNode(zadání);
franta-hg@107: 			body.appendChild(text);
franta-hg@107: 			html.appendChild(body);
franta-hg@107: 			d.appendChild(html);
franta-hg@95: 		}
franta-hg@107: 
franta-hg@107: 		return new DOMSource(d);
franta-hg@95: 	}
franta-hg@94: }