Changeset 108:8d9cab64c335

Timestamp:

07/05/12 20:13:56 (12 years ago)

Author:

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

Branch:

default

Message:

#20 Skriptování: výstupní formáty: text (prostý), xhtml (fragment), xml (celý dokument, může mít XML deklaraci).

Files:

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

vstup/makra/hg-verze.xsl

@@ -11 +11 @@
         xmlns:xs="http://www.w3.org/2001/XMLSchema"
         exclude-result-prefixes="fn h s k m xs">
-
+        
         <!-- Vypíše verze z verzovacího systému: -->
         <xsl:template match="m:hg-verze">
+
                 <xsl:variable name="zadáníSkriptu">
-                        <!--
-                                TODO:
-                                Zahazovat XML deklaraci bychom mohli v Javě u všech skriptů… 
-                                Nicméně současná dohoda je taková, že skripty vracejí fragment, ne celý dokument,
-                                což má výhodu v tom, že můžou vrátit kus textu a nějakou tu značku
-                                a nemusí to být zabalené v kořenovém elementu.
-                                
-                        -->
-                        <m:skript jazyk="bash" výstup="xml">hg log --style xml | awk '{if(NR&gt;1)print}';</m:skript>
-                        <!--
-                                Také bychom filtrování mohli provés ve skriptu…
-                                hg log … | xpath -e "//logentry[tag[starts-with(., 'v')]]" 2>/dev/null
-                                 …ale to by bylo trochu zbytečně pracné.
-                        -->
+                        <m:skript jazyk="bash" výstup="xml">hg log --style xml</m:skript>
                 </xsl:variable>
 
@@ -43 +31 @@
                         </thead>
                         <tbody style="text-align: right;">
-                                <!--
-                                        Výstup skriptu se bude nacházet v XHTML jmenném prostoru, což je obvykle v pořádku,
-                                        ale pro mezivýsledky to není úplně vhodné.
-                                -->
                                 <xsl:for-each select="$výstupSkriptu/h:log/h:logentry[h:tag[starts-with(text(), 'v')]]">
                                         <tr>

vstup/skriptování.xml

@@ -7 +7 @@
 
         <text xmlns="http://www.w3.org/1999/xhtml">
-        
+
                 <p>
                         Na stránkách můžeme používat skripty.
@@ -41 +41 @@
                         V současnosti jsou podporované tyto jazyky:
                 </p>
-                
+
                 <table>
                         <thead>
@@ -50 +50 @@
                         </thead>
                         <tbody>
-                                <m:skript jazyk="perl" výstup="xml"><![CDATA[
+                                <m:skript jazyk="perl" výstup="xhtml"><![CDATA[
 use strict;
 use warnings;
@@ -112 +112 @@
                                 Ve skriptech máme dostupné následující proměnné prostředí:
                         </p>
-                        
+
                         <table>
                                 <thead>
@@ -122 +122 @@
                                 <tbody>
                                         <!-- Pokud načítáme skript ze souboru, je atribut jazyk nepovinný. -->
-                                        <m:skript jazyk="perl" výstup="xml" src="skriptování-proměnné.pl"/>
+                                        <m:skript jazyk="perl" výstup="xhtml" src="skriptování-proměnné.pl"/>
                                 </tbody>
                         </table>
-                        
+
                         <p>
                                 Kód:
                         </p>
-                        
+
                         <m:pre jazyk="xml"><![CDATA[<m:skript jazyk="bash">
 echo "URI:    $XWG_STRANKA_URI";
@@ -136 +136 @@
 echo "Perex:  $XWG_STRANKA_PEREX";
 </m:skript>]]></m:pre>
-                        
+
                         <p>nám vypíše:</p>
-                        
+
                         <pre><m:skript jazyk="bash"><![CDATA[
 echo "URI:    $XWG_STRANKA_URI" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
@@ -149 +149 @@
                 <p>
                         XML generované skriptem může také obsahovat makra, která se následně interptetují.
-                        <m:skript jazyk="bash" výstup="xml"><![CDATA[
+                        <m:skript jazyk="bash" výstup="xhtml"><![CDATA[
 echo '<m:skript jazyk="bash">'; # Ty zrůdo! :-)
 echo 'echo "Takže můžeš skriptovat, když skriptuješ,";';
@@ -157 +157 @@
                 </p>
                 
-                <m:skript jazyk="perl" výstup="xml"><![CDATA[
+                <m:skript jazyk="perl" výstup="xhtml"><![CDATA[
 use strict;
 use warnings;
@@ -180 +180 @@
 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;
@@ -207 +207 @@
 
                 <p>
-                        Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xml"> … </m:skript>]]></code> do stránky.
+                        Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xhtml"> … </m:skript>]]></code> do stránky.
                 </p>
                 <p>

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

@@ -41 +41 @@
 public class Skriptování {
 
+        private enum FORMÁT {
+
+                xml,
+                xhtml,
+                text
+        }
         /**
          * klíč = jazyk – např. bash
@@ -71 +77 @@
         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));
+                return vyrobXml(výstupSkriptu, zjistiFormát(výstupníFormát));
         }
 
@@ -170 +176 @@
         }
 
+        private static FORMÁT zjistiFormát(String výstupníFormát) {
+                try {
+                        return FORMÁT.valueOf(výstupníFormát);
+                } catch (NullPointerException e) {
+                        return FORMÁT.text;
+                } catch (IllegalArgumentException e) {
+                        return FORMÁT.text;
+                }
+        }
+
         /**
          * @param zadání výstup vygenerovaný skriptem
@@ -176 +192 @@
          * @throws Exception
          */
-        private static Source vyrobXml(String zadání, boolean xmlFormát) throws Exception {
+        private static Source vyrobXml(String zadání, FORMÁT formá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 {
+
+                if (formát == FORMÁT.text) {
                         d = db.newDocument();
                         Node html = d.createElementNS(XHTML, "html");
@@ -197 +206 @@
                         html.appendChild(body);
                         d.appendChild(html);
+                } else {
+                        if (formát == FORMÁT.xhtml) {
+                                zadání = "<html xmlns='" + XHTML + "' xmlns:m='" + MAKRO + "'><body>" + zadání + "</body></html>";
+                        }
+                        try {
+                                d = db.parse(new ByteArrayInputStream(zadání.getBytes()));
+                        } catch (Exception e) {
+                                System.err.println("Chyba: Skript vrátil neplatné XML.");
+                                throw e;
+                        }
                 }
 

šablona/makra/skriptování.xsl

@@ -33 +33 @@
                 *
                 @jazyk programovací jazyk, např. bash, perl, php (nepovinné, pokud je vyplněn atribut src)
-                @výstup formát výstupu skriptu: text (výchozí) | xml (musí být validním fragmentem XML)
+                @výstup formát výstupu skriptu:
+                        text – libovolný text, escapujeme (výchozí)
+                        xhtml – platný XML fragment, přidáme mu výchozí jmenný prostor XHTML a jmenný prostor pro makra
+                        xml – platný XML dokument – vhodné pro další zpracování v jiných makrech
                 @src soubor se skriptem/programem (volitelný parametr – buď zadáme skript do těla elementu, nebo nastavíme tento atribut)
         -->
@@ -51 +54 @@
                                                                                                                                         //s:stránka/s:perex/text()
                                                                                                                                 )"/>
-                                <xsl:apply-templates select="$výstupSkriptu/h:html/h:body/node()"/>
+                                <xsl:choose>
+                                        <xsl:when test="@výstup = 'xml'">
+                                                <!-- XML výstup zpracujeme, jak je: -->
+                                                <xsl:apply-templates select="$výstupSkriptu/*"/>
+                                        </xsl:when>
+                                        <xsl:otherwise>
+                                                <!-- Prostý text a XHTML fragmenty dostáváme zabalené v html/body -->
+                                                <xsl:apply-templates select="$výstupSkriptu/h:html/h:body/node()"/>
+                                        </xsl:otherwise>
+                                </xsl:choose>
                         </xsl:when>
 
@@ -60 +72 @@
                                 <xsl:message>Stránka obsahuje skripty, ale skripty jsou ignorovány – změnu lze provést ve web.conf.</xsl:message>
                         </xsl:when>
-                        <xsl:when test="$režim = 'vložit' and @výstup = 'xml'">
+                        <xsl:when test="$režim = 'vložit' and (@výstup = 'xml' or @výstup = 'xhtml')">
                                 <xsl:message>Není možné jen tak vložit text, který měl mít výstup ve formátu XML – změnu lze provést ve web.conf</xsl:message>
                         </xsl:when>
@@ -70 +82 @@
                         <xsl:otherwise><!-- varovat = výchozí možnost -->
                                 <xsl:choose>
-                                        <xsl:when test="@výstup = 'xml'">
+                                        <xsl:when test="@výstup = 'xml' or @výstup = 'xhtml'">
                                                 <xsl:message>Není možné možné vložit varování na místo, kde měl být skript generující XML – změnu lze provést ve web.conf</xsl:message>
                                         </xsl:when>