1 | <stránka |
---|
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> |
---|
6 | <pořadí>50</pořadí> |
---|
7 | |
---|
8 | <text xmlns="http://www.w3.org/1999/xhtml"> |
---|
9 | |
---|
10 | <p> |
---|
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. |
---|
14 | </p> |
---|
15 | <p> |
---|
16 | Příklad: |
---|
17 | <em> |
---|
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>. |
---|
20 | </em> |
---|
21 | </p> |
---|
22 | |
---|
23 | <p> |
---|
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>). |
---|
29 | </m:podČarou> |
---|
30 | </p> |
---|
31 | <p> |
---|
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>. |
---|
37 | </p> |
---|
38 | |
---|
39 | <h2>Podporované jazyky</h2> |
---|
40 | <p> |
---|
41 | V současnosti jsou podporované tyto jazyky: |
---|
42 | </p> |
---|
43 | |
---|
44 | <table> |
---|
45 | <thead> |
---|
46 | <tr> |
---|
47 | <td>Jazyk</td> |
---|
48 | <td>Interpret</td> |
---|
49 | </tr> |
---|
50 | </thead> |
---|
51 | <tbody> |
---|
52 | <m:skript jazyk="perl" výstup="xhtml"><![CDATA[ |
---|
53 | use strict; |
---|
54 | use warnings; |
---|
55 | |
---|
56 | open(JAVA, "<", $ENV{"XWG_SKRIPTOVANI_JAVA"}) or die $!; |
---|
57 | |
---|
58 | while (<JAVA>) { |
---|
59 | if (/podporovanýJazyk\.put\("(\w+)",\s*"(.*)"\);/) { |
---|
60 | print "<tr><td><code>$1</code></td><td><code>$2</code></td></tr>\n"; |
---|
61 | } |
---|
62 | } |
---|
63 | ]]></m:skript> |
---|
64 | </tbody> |
---|
65 | </table> |
---|
66 | |
---|
67 | <h3>Perl – ukázka</h3> |
---|
68 | <p>Jazyky použité nebo citované na této stránce:</p> |
---|
69 | <!-- |
---|
70 | Lepšího výsledku bychom samozřejmě dosáhli pomocí XPath dotazu, |
---|
71 | ale toto je příklad na Perl :-) |
---|
72 | --> |
---|
73 | <pre><m:skript jazyk="perl"><![CDATA[ |
---|
74 | use strict; |
---|
75 | use warnings; |
---|
76 | |
---|
77 | open(XML, "<", $ENV{"XWG_STRANKA_SOUBOR"}) or die $!; |
---|
78 | my %skripty; |
---|
79 | |
---|
80 | while (<XML>) { |
---|
81 | if (/m:skript\s+jazyk="(\w+)"/) { |
---|
82 | $skripty{$1}++; |
---|
83 | } |
---|
84 | } |
---|
85 | |
---|
86 | for(keys(%skripty)) { |
---|
87 | print "$skripty{$_}×\t $_\n"; |
---|
88 | } |
---|
89 | ]]></m:skript></pre> |
---|
90 | |
---|
91 | <h3>BASH – ukázka</h3> |
---|
92 | <pre><m:skript jazyk="bash"><![CDATA[ |
---|
93 | echo -n "Právě je: "; |
---|
94 | date; |
---|
95 | echo -n "Operační systém: "; |
---|
96 | uname -o; |
---|
97 | echo -n "SHA-1 otisk zdrojáku této stránky: "; |
---|
98 | sha1sum "$XWG_STRANKA_SOUBOR" | cut -f 1 -d " "; |
---|
99 | ]]></m:skript></pre> |
---|
100 | |
---|
101 | <!-- |
---|
102 | <h2>PHP</h2> |
---|
103 | <pre style="max-height: 200px;"><m:skript jazyk="php"><![CDATA[ |
---|
104 | <?php |
---|
105 | phpinfo(); |
---|
106 | ?> |
---|
107 | ]]></m:skript></pre> |
---|
108 | --> |
---|
109 | |
---|
110 | <h2>Proměnné prostředí</h2> |
---|
111 | <p> |
---|
112 | Ve skriptech máme dostupné následující proměnné prostředí: |
---|
113 | </p> |
---|
114 | |
---|
115 | <table> |
---|
116 | <thead> |
---|
117 | <tr> |
---|
118 | <td>Proměnná</td> |
---|
119 | <td>Význam</td> |
---|
120 | </tr> |
---|
121 | </thead> |
---|
122 | <tbody> |
---|
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"/> |
---|
125 | </tbody> |
---|
126 | </table> |
---|
127 | |
---|
128 | <p> |
---|
129 | Kód: |
---|
130 | </p> |
---|
131 | |
---|
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> |
---|
138 | |
---|
139 | <p>nám vypíše:</p> |
---|
140 | |
---|
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"; |
---|
146 | ]]></m:skript></pre> |
---|
147 | |
---|
148 | <h2 id="makraVeSkriptech">Makra ve skriptech</h2> |
---|
149 | <p> |
---|
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š,";'; |
---|
154 | echo '</m:skript>'; |
---|
155 | ]]></m:skript> |
---|
156 | nebo dělat něco užitečnějšího. |
---|
157 | </p> |
---|
158 | |
---|
159 | <m:skript jazyk="perl" výstup="xhtml"><![CDATA[ |
---|
160 | use strict; |
---|
161 | use warnings; |
---|
162 | |
---|
163 | my $adresar = "vstup/makra"; |
---|
164 | |
---|
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"; |
---|
168 | |
---|
169 | opendir(DIR, $adresar) or die $!; |
---|
170 | my $i = 0; |
---|
171 | while (readdir(DIR)) { |
---|
172 | next if (/^\./); |
---|
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"; |
---|
177 | $i++; |
---|
178 | } |
---|
179 | |
---|
180 | print "</m:diagram>"; |
---|
181 | closedir(DIR); |
---|
182 | ]]></m:skript> |
---|
183 | |
---|
184 | <p>…třeba vygenerovat tento diagram následujícím perlovským skriptem:</p> |
---|
185 | |
---|
186 | <m:pre jazyk="perl"><![CDATA[ |
---|
187 | use strict; |
---|
188 | use warnings; |
---|
189 | |
---|
190 | my $adresar = "vstup/makra"; |
---|
191 | |
---|
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"; |
---|
195 | |
---|
196 | opendir(DIR, $adresar) or die $!; |
---|
197 | my $i = 0; |
---|
198 | while (readdir(DIR)) { |
---|
199 | next if (/^\./); |
---|
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"; |
---|
204 | $i++; |
---|
205 | } |
---|
206 | |
---|
207 | print "</m:diagram>"; |
---|
208 | closedir(DIR);]]></m:pre> |
---|
209 | |
---|
210 | <p> |
---|
211 | Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xhtml"> … </m:skript>]]></code> do stránky. |
---|
212 | </p> |
---|
213 | <p> |
---|
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í). |
---|
215 | </p> |
---|
216 | |
---|
217 | <h2>Skripty v makrech</h2> |
---|
218 | <p> |
---|
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). |
---|
223 | </m:podČarou> |
---|
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. |
---|
227 | </p> |
---|
228 | |
---|
229 | <m:hg-verze/> |
---|
230 | |
---|
231 | <p> |
---|
232 | Toto makro naleznete v souboru <code>vstup/makra/hg-verze.xsl</code>. |
---|
233 | </p> |
---|
234 | |
---|
235 | <h2>Vnořování maker</h2> |
---|
236 | <p> |
---|
237 | Trochu jiný případ je vnořování maker na stránce. |
---|
238 | Např. si chceme vypsat vybrané internetové služby: |
---|
239 | </p> |
---|
240 | <m:tabulka> |
---|
241 | <m:skript jazyk="perl"><![CDATA[ |
---|
242 | use strict; |
---|
243 | use warnings; |
---|
244 | |
---|
245 | print "Port\tSlužba\tProtokol\n"; |
---|
246 | open(S, "<", "/etc/services") or die $!; |
---|
247 | while (<S>) { |
---|
248 | if (/(\w+)\s+(21|22|25|80)\/(tcp)/) { |
---|
249 | print "$2\t$1\t$3\n"; |
---|
250 | } |
---|
251 | } |
---|
252 | ]]></m:skript> |
---|
253 | </m:tabulka> |
---|
254 | |
---|
255 | <p> |
---|
256 | Pro vygenerování použijeme dvě makra – tabulku a skript – která vložíme do textu stránky: |
---|
257 | </p> |
---|
258 | |
---|
259 | <m:pre jazyk="xml"><![CDATA[ |
---|
260 | <m:tabulka> |
---|
261 | <m:skript jazyk="perl"><![CDATA[ |
---|
262 | print "Port\tSlužba\tProtokol\n"; |
---|
263 | open(S, "<", "/etc/services") or die $!; |
---|
264 | while (<S>) { |
---|
265 | if (/(\w+)\s+(21|22|25|80)\/(tcp)/) { |
---|
266 | print "$2\t$1\t$3\n"; |
---|
267 | } |
---|
268 | } |
---|
269 | ]]]]>><![CDATA[</m:skript> |
---|
270 | </m:tabulka>]]></m:pre> |
---|
271 | |
---|
272 | <p> |
---|
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. |
---|
275 | </p> |
---|
276 | |
---|
277 | <!-- |
---|
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 :-) |
---|
281 | --> |
---|
282 | |
---|
283 | <p> |
---|
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. |
---|
287 | </p> |
---|
288 | |
---|
289 | <p> |
---|
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. |
---|
294 | </p> |
---|
295 | |
---|
296 | </text> |
---|
297 | |
---|
298 | </stránka> |
---|
299 | |
---|