2 xmlns="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/strana"
3 xmlns:m="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/makro">
4 <nadpis>Skriptování</nadpis>
5 <perex>Na stránku můžeme vložit výstup skriptů.</perex>
8 <text xmlns="http://www.w3.org/1999/xhtml">
11 Na stránkách můžeme používat skripty.
12 Spouští se při generování a jejich standardní výstup se vloží do stránky.
13 Třeba doprostřed textu ostavce nebo do jiného elementu.
18 Tyto stránky byly vygenerované v systému
19 <span title="tento text pochází ze skriptu"><m:skript jazyk="bash">uname -o</m:skript></span>.
24 Díky skriptování můžeme stránky obohatit o prakticky libovolný obsah –
25 jak prostý text, tak i XHTML fragmenty.<m:podČarou>
26 Zapíná se pomocí atributu <code>výstup="xhtml"</code> a generátor pak kontroluje správné formátování –
27 nestane se vám, že byste omylem vygenerovali stránky s překříženými nebo neuzavřenými značkami.
28 Výchozím jmenným prostorem je XHTML a je dostupný i jmenný prostor pro makra (<code>m</code>).
32 Skriptování ale může být nebezpečné, pokud byste spustili generátor na stránkách,
33 které psal někdo nedůvěryhodný a vložil do nich škodlivý kód.
34 Kromě toho, ukázková sada stránek by měla být přeložitelná kdekoli a mít minimum závislostí
35 (ne každý musí mít nainstalovaný Perl nebo Python či další podporované interprety).
36 Proto je skriptování ve výchozím stavu vypnuté – je potřeba ho povolit v souboru <code>web.conf</code>.
39 <h2>Podporované jazyky</h2>
41 V současnosti jsou podporované tyto jazyky:
52 <m:skript jazyk="perl" výstup="xhtml"><![CDATA[
56 open(JAVA, "<", $ENV{"XWG_SKRIPTOVANI_JAVA"}) or die $!;
59 if (/podporovanýJazyk\.put\("(\w+)",\s*"(.*)"\);/) {
60 print "<tr><td><code>$1</code></td><td><code>$2</code></td></tr>\n";
67 <h3>Perl – ukázka</h3>
68 <p>Jazyky použité nebo citované na této stránce:</p>
70 Lepšího výsledku bychom samozřejmě dosáhli pomocí XPath dotazu,
71 ale toto je příklad na Perl :-)
73 <pre><m:skript jazyk="perl"><![CDATA[
77 open(XML, "<", $ENV{"XWG_STRANKA_SOUBOR"}) or die $!;
81 if (/m:skript\s+jazyk="(\w+)"/) {
87 print "$skripty{$_}×\t $_\n";
91 <h3>BASH – ukázka</h3>
92 <pre><m:skript jazyk="bash"><![CDATA[
95 echo -n "Operační systém: ";
97 echo -n "SHA-1 otisk zdrojáku této stránky: ";
98 sha1sum "$XWG_STRANKA_SOUBOR" | cut -f 1 -d " ";
103 <pre style="max-height: 200px;"><m:skript jazyk="php"><![CDATA[
110 <h2>Proměnné prostředí</h2>
112 Ve skriptech máme dostupné následující proměnné prostředí:
123 <!-- Pokud načítáme skript ze souboru, je atribut jazyk nepovinný. -->
124 <m:skript jazyk="perl" výstup="xhtml" src="skriptování-proměnné.pl"/>
132 <m:pre jazyk="xml"><![CDATA[<m:skript jazyk="bash">
133 echo "URI: $XWG_STRANKA_URI";
134 echo "Soubor: $XWG_STRANKA_SOUBOR";
135 echo "Nadpis: $XWG_STRANKA_NADPIS";
136 echo "Perex: $XWG_STRANKA_PEREX";
137 </m:skript>]]></m:pre>
141 <pre><m:skript jazyk="bash"><![CDATA[
142 echo "URI: $XWG_STRANKA_URI" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
143 echo "Soubor: $XWG_STRANKA_SOUBOR" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
144 echo "Nadpis: $XWG_STRANKA_NADPIS";
145 echo "Perex: $XWG_STRANKA_PEREX";
148 <h2 id="makraVeSkriptech">Makra ve skriptech</h2>
150 XML generované skriptem může také obsahovat makra, která se následně interptetují.
151 <m:skript jazyk="bash" výstup="xhtml"><![CDATA[
152 echo '<m:skript jazyk="bash">'; # Ty zrůdo! :-)
153 echo 'echo "Takže můžeš skriptovat, když skriptuješ,";';
156 nebo dělat něco užitečnějšího.
159 <m:skript jazyk="perl" výstup="xhtml"><![CDATA[
163 my $adresar = "vstup/makra";
165 print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
166 print " node [shape=\"box\"];\n";
167 print " koren [label=\"Uživatelská makra\"];\n";
169 opendir(DIR, $adresar) or die $!;
171 while (readdir(DIR)) {
173 # Měli bychom ošetřit zvláštní znaky v názvech souborů,
174 # abychom nezpůsobili chybu GraphVizu.
175 print "n$i [label=\"$_\"];\n";
176 print "koren -> n$i;\n";
180 print "</m:diagram>";
184 <p>…třeba vygenerovat tento diagram následujícím perlovským skriptem:</p>
186 <m:pre jazyk="perl"><![CDATA[
190 my $adresar = "vstup/makra";
192 print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
193 print " node [shape=\"box\"];\n";
194 print " koren [label=\"Uživatelská makra\"];\n";
196 opendir(DIR, $adresar) or die $!;
198 while (readdir(DIR)) {
200 # Měli bychom ošetřit zvláštní znaky v názvech souborů,
201 # abychom nezpůsobili chybu GraphVizu.
202 print "n$i [label=\"$_\"];\n";
203 print "koren -> n$i;\n";
207 print "</m:diagram>";
208 closedir(DIR);]]></m:pre>
211 Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xhtml"> … </m:skript>]]></code> do stránky.
214 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í).
217 <h2>Skripty v makrech</h2>
219 Uvnitř maker můžeme volat<m:podČarou>
220 Ovšem trochu jiným způsobem, než ve stránkách –
221 nacházíme se totiž v <em>programu</em> (XSL šablona definující makro)
222 nikoli v <em>datovém souboru</em> (XML stránka).
224 jiná makra – mj. skripty.
225 Toho jsme využili v makru, které generuje tabulku verzí z mercurialu
226 – ten umí vypsat historii úložiště v XML, které následně snadno zpracujeme v XSLT.
232 Toto makro naleznete v souboru <code>vstup/makra/hg-verze.xsl</code>.
235 <h2>Vnořování maker</h2>
237 Trochu jiný případ je vnořování maker na stránce.
238 Např. si chceme vypsat vybrané internetové služby:
241 <m:skript jazyk="perl"><![CDATA[
245 print "Port\tSlužba\tProtokol\n";
246 open(S, "<", "/etc/services") or die $!;
248 if (/(\w+)\s+(21|22|25|80)\/(tcp)/) {
249 print "$2\t$1\t$3\n";
256 Pro vygenerování použijeme dvě makra – tabulku a skript – která vložíme do textu stránky:
259 <m:pre jazyk="xml"><![CDATA[
261 <m:skript jazyk="perl"><![CDATA[
262 print "Port\tSlužba\tProtokol\n";
263 open(S, "<", "/etc/services") or die $!;
265 if (/(\w+)\s+(21|22|25|80)\/(tcp)/) {
266 print "$2\t$1\t$3\n";
269 ]]]]>><![CDATA[</m:skript>
270 </m:tabulka>]]></m:pre>
273 Ve skriptu v tomto případě negenerujeme XHTML značky, ale CSV (s tabulátory)
274 a o převod na XHTML tabulku se postará XSL šablona.
278 Nebo to taky můžeme napsat na jeden řádek:
279 cat /etc/services | perl -ne 'if (/(\w+)\s+(21|22|25|80)\/(tcp)/) { print "$2\t$1\t$3\n";}'
280 a vložit do tabulky jako BASH skript :-)
284 Podobně bychom mohli postupovat i u <a href="#makraVeSkriptech">diagramu</a> –
285 negenerovat skriptem značky makra, ale pouze jeho obsah – zadání diagramu, nebo jen jeho část.
286 Někdy se ale může hodit ve skriptu nastavovat atributy elementů nebo elementy vytvářet dynamicky.
290 Skriptování lze použít i pro generování zdrojového kódu, který bude následně zvýrazněn
291 pomocí značky <code><m:pre jazyk="…"/></code>.
292 Toho využíváme na stránce <m:a href="zdrojáky">Zdrojové kódy</m:a> v případě SQL a XML ukázek.
293 Skript můžeme použít mj. i ke zkrácení zdrojáku – když chceme vypsat jen jeho relevantní část.