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