Changeset 107:379a2a893fd1

Timestamp:

07/05/12 19:10:42 (12 years ago)

Author:

František Kučera <franta-hg@…>

Branch:

default

Message:

#20 Skriptování: Makra ve skriptech a Skripty v makrech + výpis verzí z Mercurialu.

Files:

• vstup/makra/hg-verze.xsl (added)
• vstup/skriptování.xml (modified) (4 diffs)
• šablona/funkce/src/cz/frantovo/xmlWebGenerator/Xmlns.java (added)
• šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Skriptování.java (modified) (6 diffs)
• šablona/makra/skriptování.xsl (modified) (2 diffs)

vstup/skriptování.xml

@@ -23 +23 @@
                 <p>
                         Díky skriptování můžeme stránky obohatit o prakticky libovolný obsah – 
-                        jak prostý text, tak i XHTML fragmenty.<m:podČarou>zapíná se pomocí atributu 
-                        <code>výstup="xml"</code> a generátor pak kontroluje správné formátování – 
-                        nestane se vám, že byste omylem vygenerovali stránky s překříženými nebo neuzavřenými značkami.</m:podČarou>
+                        jak prostý text, tak i XHTML fragmenty.<m:podČarou>
+                                Zapíná se pomocí atributu <code>výstup="xml"</code> a generátor pak kontroluje správné formátování – 
+                                nestane se vám, že byste omylem vygenerovali stránky s překříženými nebo neuzavřenými značkami.
+                                Výchozím jmenným prostorem je XHTML a je dostupný i jmenný prostor pro makra (<code>m</code>).
+                        </m:podČarou>
                 </p>
                 <p>
@@ -63 +65 @@
                 </table>
 
-                <h2>Perl</h2>
+                <h2>Perl – ukázka</h2>
                 <p>Jazyky použité nebo citované na této stránce:</p>
                 <!--
@@ -87 +89 @@
                         ]]></m:skript></pre>
 
-                        <h2>BASH</h2>
+                        <h2>BASH – ukázka</h2>
                 <pre><m:skript jazyk="bash"><![CDATA[
 echo -n "Právě je: ";
@@ -144 +146 @@
                 ]]></m:skript></pre>
 
+                <h2>Makra ve skriptech</h2>
+                <p>
+                        XML generované skriptem může také obsahovat makra, která se následně interptetují.
+                        <m:skript jazyk="bash" výstup="xml"><![CDATA[
+echo '<m:skript jazyk="bash">'; # Ty zrůdo! :-)
+echo 'echo "Takže můžeš skriptovat, když skriptuješ,";';
+echo '</m:skript>';
+                        ]]></m:skript>
+                        nebo dělat něco užitečnějšího.
+                </p>
+                
+                <m:skript jazyk="perl" výstup="xml"><![CDATA[
+use strict;
+use warnings;
+
+my $adresar = "vstup/makra";
+
+print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
+print " node            [shape=\"box\"];\n";
+print " koren   [label=\"Uživatelská makra\"];\n";
+
+opendir(DIR, $adresar) or die $!;
+my $i = 0;
+while (readdir(DIR)) {
+        next if (/^\./);
+        # Měli bychom ošetřit zvláštní znaky v názvech souborů,
+        # abychom nezpůsobili chybu GraphVizu.
+        print "n$i      [label=\"$_\"];\n";
+        print "koren -> n$i;\n";
+        $i++;
+}
+print "</m:diagram>";
+closedir(DIR);
+                ]]></m:skript>
+                
+                <p>…třeba vygenerovat tento diagram následujícím perlovským skriptem:</p>
+                
+                <m:pre jazyk="perl"><![CDATA[
+use strict;
+use warnings;
+
+my $adresar = "vstup/makra";
+
+print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
+print " node    [shape=\"box\"];\n";
+print " koren   [label=\"Uživatelská makra\"];\n";
+
+opendir(DIR, $adresar) or die $!;
+my $i = 0;
+while (readdir(DIR)) {
+        next if (/^\./);
+        # Měli bychom ošetřit zvláštní znaky v názvech souborů,
+        # abychom nezpůsobili chybu GraphVizu.
+        print "n$i      [label=\"$_\"];\n";
+        print "koren -> n$i;\n";
+        $i++;
+}
+print "</m:diagram>";
+closedir(DIR);]]></m:pre>
+
+                <p>
+                        Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xml"> … </m:skript>]]></code> do stránky.
+                </p>
+                <p>
+                        Známá chyba: ve skriptech zatím nefungují poznámky pod čarou (a není jisté, jestli kdy fungovat budou – pravděpodobně by to vyžadovalo vícefázové zpracování).
+                </p>
+
+                <h2>Skripty v makrech</h2>
+                <p>
+                        Uvnitř maker můžeme volat<m:podČarou>
+                                Ovšem trochu jiným způsobem, než ve stránkách –
+                                nacházíme se totiž v <em>programu</em> (XSL šablona definující makro)
+                                nikoli v <em>datovém souboru</em> (XML stránka).
+                        </m:podČarou>
+                        jiná makra – mj. skripty.
+                        Toho jsme využili v makru, které generuje tabulku verzí z mercurialu:
+                </p>
+
+                <m:hg-verze/>
+
+                <p>
+                        Toto makro naleznete v souboru <code>vstup/makra/hg-verze.xsl</code>.
+                </p>
+
         </text>
 

šablona/funkce/src/cz/frantovo/xmlWebGenerator/makra/Skriptování.java

@@ -19 +19 @@
 
 import static cz.frantovo.xmlWebGenerator.NástrojeCLI.načtiProud;
+import static cz.frantovo.xmlWebGenerator.Xmlns.*;
 import java.io.ByteArrayInputStream;
 import java.io.File;
@@ -28 +29 @@
 import javax.xml.parsers.DocumentBuilder;
 import javax.xml.parsers.DocumentBuilderFactory;
+import javax.xml.transform.Source;
+import javax.xml.transform.dom.DOMSource;
 import org.w3c.dom.Document;
+import org.w3c.dom.Node;
 
 /**
@@ -63 +67 @@
          * @param nadpisStránky nadpis stránky → proměnná prostředí
          * @param perexStránky perex stránky → proměnná prostředí
-         * @return výstup příkazu
+         * @return výstup příkazu buď jako textový řetězec nebo jako XML (DOMSource)
          */
-        public static String interpretuj(String skriptText, String skriptSoubor, String jazyk, String výstupníFormát, String uriStránky, String nadpisStránky, String perexStránky) {
+        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 {
+                String výstupSkriptu = získejVýstupSkriptu(skriptText, skriptSoubor, jazyk, uriStránky, nadpisStránky, perexStránky);
+                return vyrobXml(výstupSkriptu, "xml".equals(výstupníFormát));
+        }
+
+        private static String získejVýstupSkriptu(String skriptText, String skriptSoubor, String jazyk, String uriStránky, String nadpisStránky, String perexStránky) throws Exception {
+
                 try {
                         if (isNeprázdný(skriptSoubor)) {
@@ -137 +147 @@
                                 }
 
-                                return připravVýstup(výsledek, výstupníFormát);
+                                return výsledek.trim();
                         } else {
                                 System.err.println("--- Standardní výstup skriptu: -----");
@@ -147 +157 @@
                         }
                 } catch (Exception e) {
-                        System.err.println("Došlo k chybě při vykonávání skriptu v jazyce: " + jazyk);
+                        System.err.println("Došlo k chybě při vykonávání skriptu.");
                         System.err.println("--------");
                         System.err.println(skriptText);
                         System.err.println("--------");
                         e.printStackTrace(System.err);
-                        return null;
-                }
-        }
-
-        private static String připravVýstup(String výsledek, String formát) {
-                if ("xml".equals(formát)) {
-                        if (zkontrolujXml(výsledek)) {
-                                return výsledek.trim();
-                        } else {
-                                System.err.println("Chyba v XML generovaném skriptem:");
-                                System.err.println(výsledek);
-                                return null;
-                        }
-                } else {
-                        return výsledek.trim();
+                        throw e;
                 }
         }
@@ -175 +171 @@
 
         /**
-         * @param xml fragment XML vygenerovaný skriptem
-         * @return true v případě, že výstup je validním fragmentem XML
+         * @param zadání výstup vygenerovaný skriptem
+         * @param xmlFormát formát zadání: true = xml fragment | false = prostý text
+         * @return xml fragment nebo prostý text zabalený do html/body
+         * @throws Exception
          */
-        private static boolean zkontrolujXml(String xml) {
-                try {
-                        DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
-                        DocumentBuilder db = dbf.newDocumentBuilder();
-                        xml = "<xml>" + xml + "</xml>";
-                        Document d = db.parse(new ByteArrayInputStream(xml.getBytes()));
-                        return true;
-                } catch (Exception e) {
-                        e.printStackTrace(System.err);
-                        return false;
+        private static Source vyrobXml(String zadání, boolean xmlFormát) throws Exception {
+                DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
+                DocumentBuilder db = dbf.newDocumentBuilder();
+                Document d;
+
+                if (xmlFormát) {
+                        try {
+                                zadání = "<html xmlns='" + XHTML + "' xmlns:m='" + MAKRO + "'><body>" + zadání + "</body></html>";
+                                d = db.parse(new ByteArrayInputStream(zadání.getBytes()));
+                        } catch (Exception e) {
+                                System.err.println("Chyba: Skript vrátil neplatné XML.");
+                                throw e;
+                        }
+                } else {
+                        d = db.newDocument();
+                        Node html = d.createElementNS(XHTML, "html");
+                        Node body = d.createElementNS(XHTML, "body");
+                        Node text = d.createTextNode(zadání);
+                        body.appendChild(text);
+                        html.appendChild(body);
+                        d.appendChild(html);
                 }
+
+                return new DOMSource(d);
         }
 }

šablona/makra/skriptování.xsl

@@ -19 +19 @@
 <xsl:stylesheet version="2.0"
         xmlns="http://www.w3.org/1999/xhtml"
+        xmlns:h="http://www.w3.org/1999/xhtml"
         xmlns:m="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/makro"
         xmlns:j="java:cz.frantovo.xmlWebGenerator.makra.Skriptování"
@@ -50 +51 @@
                                                                                                                                         //s:stránka/s:perex/text()
                                                                                                                                 )"/>
-                                <xsl:choose>
-                                        <xsl:when test="$výstupSkriptu">
-                                                <xsl:choose>
-                                                        <xsl:when test="@výstup = 'xml'"><xsl:value-of select="$výstupSkriptu" disable-output-escaping="yes"/></xsl:when>
-                                                        <xsl:otherwise><xsl:value-of select="$výstupSkriptu"/></xsl:otherwise>
-                                                </xsl:choose>
-                                        </xsl:when>
-                                        <xsl:otherwise>
-                                                <xsl:message terminate="yes">Při interpretaci skriptu došlo k chybě.</xsl:message>
-                                        </xsl:otherwise>
-                                </xsl:choose>
+                                <xsl:apply-templates select="$výstupSkriptu/h:html/h:body/node()"/>
                         </xsl:when>