šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Skriptování.java
author František Kučera <franta-hg@frantovo.cz>
Sun Jul 01 14:43:21 2012 +0200 (2012-07-01)
changeset 103 aa91d1c6d4c1
parent 101 024ee27ce4fa
child 107 379a2a893fd1
permissions -rw-r--r--
#20 Skriptování: možnost spouštět skripty ze souborů (atribut: src).
     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  */
    18 package cz.frantovo.xmlWebGenerator.makra;
    19 
    20 import static cz.frantovo.xmlWebGenerator.NástrojeCLI.načtiProud;
    21 import java.io.ByteArrayInputStream;
    22 import java.io.File;
    23 import java.io.PrintStream;
    24 import java.net.URI;
    25 import java.util.Collections;
    26 import java.util.HashMap;
    27 import java.util.Map;
    28 import javax.xml.parsers.DocumentBuilder;
    29 import javax.xml.parsers.DocumentBuilderFactory;
    30 import org.w3c.dom.Document;
    31 
    32 /**
    33  * Provedeme skript a do stránky vložíme jeho výstup.
    34  *
    35  * @author František Kučera (frantovo.cz)
    36  */
    37 public class Skriptování {
    38 
    39 	/**
    40 	 * klíč = jazyk – např. bash
    41 	 * hodnota = interpret – např. /bin/bash
    42 	 */
    43 	private static final Map<String, String> interpreti;
    44 
    45 	static {
    46 		Map<String, String> podporovanýJazyk = new HashMap<String, String>();
    47 		podporovanýJazyk.put("bash", "/bin/bash");
    48 		podporovanýJazyk.put("perl", "/usr/bin/perl");
    49 		podporovanýJazyk.put("php", "/usr/bin/php");
    50 		podporovanýJazyk.put("python", "/usr/bin/python");
    51 		interpreti = Collections.unmodifiableMap(podporovanýJazyk);
    52 	}
    53 
    54 	/**
    55 	 * TODO: podporovat i složitější scénáře (např. kompilaci),
    56 	 * než jen vložení do souboru a přidání správného záhlaví.
    57 	 *
    58 	 * @param skriptText skript k vykonání
    59 	 * @param skriptSoubor cesta k souboru se skriptem/programem
    60 	 * @param jazyk programovací jazyk
    61 	 * @param výstupníFormát text (výchozí) | xml (v tom případě kontrolujeme validitu)
    62 	 * @param uriStránky URI aktuálně generované stránky → proměnná prostředí
    63 	 * @param nadpisStránky nadpis stránky → proměnná prostředí
    64 	 * @param perexStránky perex stránky → proměnná prostředí
    65 	 * @return výstup příkazu
    66 	 */
    67 	public static String interpretuj(String skriptText, String skriptSoubor, String jazyk, String výstupníFormát, String uriStránky, String nadpisStránky, String perexStránky) {
    68 		try {
    69 			if (isNeprázdný(skriptSoubor)) {
    70 				System.err.println("\tInterpretuji skript ze souboru: " + skriptSoubor);
    71 			} else {
    72 				System.err.println("\tInterpretuji skript v jazyce:   " + jazyk);
    73 			}
    74 
    75 			File souborStránky = new File(new URI(uriStránky));
    76 			File f;
    77 
    78 			if (isNeprázdný(skriptText)) {
    79 				/** Skript je zadán uvnitř elementu přímo ve stránce */
    80 				String interpret = interpreti.get(jazyk);
    81 				if (interpret == null) {
    82 					throw new Exception("Neznámý skriptovací jazyk: " + jazyk);
    83 				}
    84 
    85 				f = File.createTempFile("xml-web-generátor-", ".skript");
    86 				f.deleteOnExit();
    87 				f.setExecutable(true);
    88 
    89 				PrintStream ps = new PrintStream(f);
    90 				ps.print("#!");
    91 				ps.println(interpret);
    92 				ps.println();
    93 				ps.print(skriptText);
    94 				ps.close();
    95 			} else if (isNeprázdný(skriptSoubor)) {
    96 				/** Skript/program je uložen v externím souboru */
    97 				if (skriptSoubor.startsWith(File.separator)) {
    98 					/** absolutní cesta */
    99 					f = new File(skriptSoubor);
   100 				} else {
   101 					/** relativní cesta */
   102 					f = new File(souborStránky.getParent(), File.separatorChar + skriptSoubor);
   103 				}
   104 
   105 				if (!f.canExecute()) {
   106 					throw new Exception("Soubor se skriptem není spustitelný → nastavte: chmod +x " + f);
   107 				}
   108 			} else {
   109 				throw new Exception("Musí být vyplněn text skriptu, nebo cesta k souboru.");
   110 			}
   111 
   112 
   113 			String[] prostředí = new String[]{
   114 				"LANG=" + System.getenv("LANG"),
   115 				"USER=" + System.getenv("USER"),
   116 				"XWG_SKRIPTOVANI_JAVA=" + "šablona" + File.separator + "funkce" + File.separator + "src" + File.separator + Skriptování.class.getName().replaceAll("\\.", File.separator) + ".java",
   117 				"XWG_STRANKA_URI=" + uriStránky, // env:URI aktuálně zpracovávané stránky
   118 				"XWG_STRANKA_SOUBOR=" + souborStránky.getAbsolutePath(), // env:absolutní cesta k souboru
   119 				"XWG_STRANKA_NADPIS=" + nadpisStránky, // env:nadpis stránky
   120 				"XWG_STRANKA_PEREX=" + perexStránky // env:perex stránky
   121 			};
   122 
   123 			Runtime r = Runtime.getRuntime();
   124 			Process p = r.exec(new String[]{f.getAbsolutePath()}, prostředí);
   125 
   126 			String výsledek = načtiProud(p.getInputStream());
   127 			String chyby = načtiProud(p.getErrorStream());
   128 
   129 			p.waitFor();
   130 
   131 			if (p.exitValue() == 0) {
   132 				if (chyby.length() > 0) {
   133 					System.err.println("--- Chybový výstup skriptu -----");
   134 					System.err.println(chyby);
   135 					System.err.println("--------------------------------");
   136 					System.err.println("Nicméně skript skončil úspěšně, takže pokračujeme dál.");
   137 				}
   138 
   139 				return připravVýstup(výsledek, výstupníFormát);
   140 			} else {
   141 				System.err.println("--- Standardní výstup skriptu: -----");
   142 				System.err.println(výsledek);
   143 				System.err.println("--- Cyhbový výstup skriptu: ---------");
   144 				System.err.println(chyby);
   145 				System.err.println("--------------------------------------");
   146 				throw new Exception("Návratová hodnota: " + p.exitValue());
   147 			}
   148 		} catch (Exception e) {
   149 			System.err.println("Došlo k chybě při vykonávání skriptu v jazyce: " + jazyk);
   150 			System.err.println("--------");
   151 			System.err.println(skriptText);
   152 			System.err.println("--------");
   153 			e.printStackTrace(System.err);
   154 			return null;
   155 		}
   156 	}
   157 
   158 	private static String připravVýstup(String výsledek, String formát) {
   159 		if ("xml".equals(formát)) {
   160 			if (zkontrolujXml(výsledek)) {
   161 				return výsledek.trim();
   162 			} else {
   163 				System.err.println("Chyba v XML generovaném skriptem:");
   164 				System.err.println(výsledek);
   165 				return null;
   166 			}
   167 		} else {
   168 			return výsledek.trim();
   169 		}
   170 	}
   171 
   172 	private static boolean isNeprázdný(String s) {
   173 		return !(s == null || s.trim().isEmpty());
   174 	}
   175 
   176 	/**
   177 	 * @param xml fragment XML vygenerovaný skriptem
   178 	 * @return true v případě, že výstup je validním fragmentem XML
   179 	 */
   180 	private static boolean zkontrolujXml(String xml) {
   181 		try {
   182 			DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
   183 			DocumentBuilder db = dbf.newDocumentBuilder();
   184 			xml = "<xml>" + xml + "</xml>";
   185 			Document d = db.parse(new ByteArrayInputStream(xml.getBytes()));
   186 			return true;
   187 		} catch (Exception e) {
   188 			e.printStackTrace(System.err);
   189 			return false;
   190 		}
   191 	}
   192 }