franta-hg@94: <stránka
franta-hg@94: 	xmlns="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/strana"
franta-hg@94: 	xmlns:m="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/makro">
franta-hg@94: 	<nadpis>Skriptování</nadpis>
franta-hg@94: 	<perex>Na stránku můžeme vložit výstup skriptů.</perex>
franta-hg@97: 	<pořadí>50</pořadí>
franta-hg@94: 
franta-hg@94: 	<text xmlns="http://www.w3.org/1999/xhtml">
franta-hg@108: 
franta-hg@94: 		<p>
franta-hg@94: 			Na stránkách můžeme používat skripty.
franta-hg@95: 			Spouští se při generování a jejich standardní výstup se vloží do stránky.
franta-hg@95: 			Třeba doprostřed textu ostavce nebo do jiného elementu.
franta-hg@94: 		</p>
franta-hg@94: 		<p>
franta-hg@94: 			Příklad:
franta-hg@95: 			<em>
franta-hg@95: 				Tyto stránky byly vygenerované v systému
franta-hg@95: 				<span title="tento text pochází ze skriptu"><m:skript jazyk="bash">uname -o</m:skript></span>.
franta-hg@95: 			</em>
franta-hg@95: 		</p>
franta-hg@95: 
franta-hg@95: 		<p>
franta-hg@103: 			Díky skriptování můžeme stránky obohatit o prakticky libovolný obsah – 
franta-hg@107: 			jak prostý text, tak i XHTML fragmenty.<m:podČarou>
franta-hg@109: 				Zapíná se pomocí atributu <code>výstup="xhtml"</code> a generátor pak kontroluje správné formátování – 
franta-hg@107: 				nestane se vám, že byste omylem vygenerovali stránky s překříženými nebo neuzavřenými značkami.
franta-hg@107: 				Výchozím jmenným prostorem je XHTML a je dostupný i jmenný prostor pro makra (<code>m</code>).
franta-hg@107: 			</m:podČarou>
franta-hg@103: 		</p>
franta-hg@103: 		<p>
franta-hg@103: 			Skriptování ale může být nebezpečné, pokud byste spustili generátor na stránkách,
franta-hg@95: 			které psal někdo nedůvěryhodný a vložil do nich škodlivý kód.
franta-hg@105: 			Kromě toho, ukázková sada stránek by měla být přeložitelná kdekoli a mít minimum závislostí
franta-hg@103: 			(ne každý musí mít nainstalovaný Perl nebo Python či další podporované interprety).
franta-hg@105: 			Proto je skriptování ve výchozím stavu vypnuté – je potřeba ho povolit v souboru <code>web.conf</code>.
franta-hg@95: 		</p>
franta-hg@95: 
franta-hg@95: 		<h2>Podporované jazyky</h2>
franta-hg@95: 		<p>
franta-hg@95: 			V současnosti jsou podporované tyto jazyky:
franta-hg@94: 		</p>
franta-hg@108: 
franta-hg@95: 		<table>
franta-hg@95: 			<thead>
franta-hg@95: 				<tr>
franta-hg@95: 					<td>Jazyk</td>
franta-hg@95: 					<td>Interpret</td>
franta-hg@95: 				</tr>
franta-hg@95: 			</thead>
franta-hg@95: 			<tbody>
franta-hg@108: 				<m:skript jazyk="perl" výstup="xhtml"><![CDATA[
franta-hg@94: use strict;
franta-hg@103: use warnings;
franta-hg@94: 
franta-hg@95: open(JAVA, "<", $ENV{"XWG_SKRIPTOVANI_JAVA"}) or die $!;
franta-hg@94: 
franta-hg@94: while (<JAVA>) {
franta-hg@94: 	if (/podporovanýJazyk\.put\("(\w+)",\s*"(.*)"\);/) {
franta-hg@95: 		print "<tr><td><code>$1</code></td><td><code>$2</code></td></tr>\n";
franta-hg@94: 	}
franta-hg@94: }
franta-hg@95: 				]]></m:skript>
franta-hg@95: 			</tbody>
franta-hg@95: 		</table>
franta-hg@94: 
franta-hg@110: 		<h3>Perl – ukázka</h3>
franta-hg@94: 		<p>Jazyky použité nebo citované na této stránce:</p>
franta-hg@99: 		<!--
franta-hg@99: 			Lepšího výsledku bychom samozřejmě dosáhli pomocí XPath dotazu,
franta-hg@99: 			ale toto je příklad na Perl :-)
franta-hg@99: 		-->
franta-hg@94: 		<pre><m:skript jazyk="perl"><![CDATA[
franta-hg@94: use strict;
franta-hg@103: use warnings;
franta-hg@94: 
franta-hg@111: open(XML, "<", $ENV{"XWG_STRANKA_SOUBOR"}) or die $!;
franta-hg@94: my %skripty;
franta-hg@94: 
franta-hg@94: while (<XML>) {
franta-hg@94: 	if (/m:skript\s+jazyk="(\w+)"/) {
franta-hg@94: 		$skripty{$1}++;
franta-hg@94: 	}
franta-hg@94: }
franta-hg@94: 
franta-hg@94: for(keys(%skripty)) {
franta-hg@94: 	print "$skripty{$_}×\t $_\n";
franta-hg@94: }
franta-hg@94: 			]]></m:skript></pre>
franta-hg@94: 
franta-hg@111: 		<h3>BASH – ukázka</h3>
franta-hg@94: 		<pre><m:skript jazyk="bash"><![CDATA[
franta-hg@94: echo -n "Právě je: ";
franta-hg@94: date;
franta-hg@94: echo -n "Operační systém: ";
franta-hg@102: uname -o;
franta-hg@94: echo -n "SHA-1 otisk zdrojáku této stránky: ";
franta-hg@100: sha1sum "$XWG_STRANKA_SOUBOR" | cut -f 1 -d " ";
franta-hg@94: 			]]></m:skript></pre>
franta-hg@94: 
franta-hg@94: 			<!--
franta-hg@94: 			<h2>PHP</h2>
franta-hg@94: 			<pre style="max-height: 200px;"><m:skript jazyk="php"><![CDATA[
franta-hg@94: <?php
franta-hg@94: phpinfo();
franta-hg@94: ?>
franta-hg@94: 			]]></m:skript></pre>
franta-hg@94: 			-->
franta-hg@94: 
franta-hg@94: 			<h2>Proměnné prostředí</h2>
franta-hg@94: 			<p>
franta-hg@94: 				Ve skriptech máme dostupné následující proměnné prostředí:
franta-hg@94: 			</p>
franta-hg@108: 
franta-hg@95: 			<table>
franta-hg@95: 				<thead>
franta-hg@95: 					<tr>
franta-hg@95: 						<td>Proměnná</td>
franta-hg@95: 						<td>Význam</td>
franta-hg@95: 					</tr>
franta-hg@95: 				</thead>
franta-hg@95: 				<tbody>
franta-hg@103: 					<!-- Pokud načítáme skript ze souboru, je atribut jazyk nepovinný. -->
franta-hg@108: 					<m:skript jazyk="perl" výstup="xhtml" src="skriptování-proměnné.pl"/>
franta-hg@95: 				</tbody>
franta-hg@95: 			</table>
franta-hg@108: 
franta-hg@94: 			<p>
franta-hg@94: 				Kód:
franta-hg@94: 			</p>
franta-hg@108: 
franta-hg@94: 			<m:pre jazyk="xml"><![CDATA[<m:skript jazyk="bash">
franta-hg@94: echo "URI:    $XWG_STRANKA_URI";
franta-hg@94: echo "Soubor: $XWG_STRANKA_SOUBOR";
franta-hg@94: echo "Nadpis: $XWG_STRANKA_NADPIS";
franta-hg@94: echo "Perex:  $XWG_STRANKA_PEREX";
franta-hg@94: </m:skript>]]></m:pre>
franta-hg@108: 
franta-hg@94: 			<p>nám vypíše:</p>
franta-hg@108: 
franta-hg@94: 			<pre><m:skript jazyk="bash"><![CDATA[
franta-hg@94: echo "URI:    $XWG_STRANKA_URI" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
franta-hg@94: echo "Soubor: $XWG_STRANKA_SOUBOR" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
franta-hg@94: echo "Nadpis: $XWG_STRANKA_NADPIS";
franta-hg@94: echo "Perex:  $XWG_STRANKA_PEREX";
franta-hg@94: 		]]></m:skript></pre>
franta-hg@94: 
franta-hg@113: 		<h2 id="makraZeSkriptů">Makra ze skriptů</h2>
franta-hg@107: 		<p>
franta-hg@107: 			XML generované skriptem může také obsahovat makra, která se následně interptetují.
franta-hg@108: 			<m:skript jazyk="bash" výstup="xhtml"><![CDATA[
franta-hg@107: echo '<m:skript jazyk="bash">'; # Ty zrůdo! :-)
franta-hg@107: echo 'echo "Takže můžeš skriptovat, když skriptuješ,";';
franta-hg@107: echo '</m:skript>';
franta-hg@107: 			]]></m:skript>
franta-hg@107: 			nebo dělat něco užitečnějšího.
franta-hg@107: 		</p>
franta-hg@107: 		
franta-hg@108: 		<m:skript jazyk="perl" výstup="xhtml"><![CDATA[
franta-hg@107: use strict;
franta-hg@107: use warnings;
franta-hg@107: 
franta-hg@107: my $adresar = "vstup/makra";
franta-hg@107: 
franta-hg@107: print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
franta-hg@107: print "	node		[shape=\"box\"];\n";
franta-hg@107: print "	koren	[label=\"Uživatelská makra\"];\n";
franta-hg@107: 
franta-hg@107: opendir(DIR, $adresar) or die $!;
franta-hg@107: my $i = 0;
franta-hg@107: while (readdir(DIR)) {
franta-hg@107: 	next if (/^\./);
franta-hg@107: 	# Měli bychom ošetřit zvláštní znaky v názvech souborů,
franta-hg@107: 	# abychom nezpůsobili chybu GraphVizu.
franta-hg@107: 	print "n$i	[label=\"$_\"];\n";
franta-hg@107: 	print "koren -> n$i;\n";
franta-hg@107: 	$i++;
franta-hg@107: }
franta-hg@110: 
franta-hg@107: print "</m:diagram>";
franta-hg@107: closedir(DIR);
franta-hg@107: 		]]></m:skript>
franta-hg@108: 
franta-hg@107: 		<p>…třeba vygenerovat tento diagram následujícím perlovským skriptem:</p>
franta-hg@108: 
franta-hg@107: 		<m:pre jazyk="perl"><![CDATA[
franta-hg@107: use strict;
franta-hg@107: use warnings;
franta-hg@107: 
franta-hg@107: my $adresar = "vstup/makra";
franta-hg@107: 
franta-hg@107: print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
franta-hg@107: print "	node	[shape=\"box\"];\n";
franta-hg@107: print "	koren	[label=\"Uživatelská makra\"];\n";
franta-hg@107: 
franta-hg@107: opendir(DIR, $adresar) or die $!;
franta-hg@107: my $i = 0;
franta-hg@107: while (readdir(DIR)) {
franta-hg@107: 	next if (/^\./);
franta-hg@107: 	# Měli bychom ošetřit zvláštní znaky v názvech souborů,
franta-hg@107: 	# abychom nezpůsobili chybu GraphVizu.
franta-hg@107: 	print "n$i	[label=\"$_\"];\n";
franta-hg@107: 	print "koren -> n$i;\n";
franta-hg@107: 	$i++;
franta-hg@107: }
franta-hg@110: 
franta-hg@107: print "</m:diagram>";
franta-hg@107: closedir(DIR);]]></m:pre>
franta-hg@107: 
franta-hg@107: 		<p>
franta-hg@108: 			Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xhtml"> … </m:skript>]]></code> do stránky.
franta-hg@107: 		</p>
franta-hg@107: 		<p>
franta-hg@107: 			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í).
franta-hg@107: 		</p>
franta-hg@107: 
franta-hg@113: 		<h2>Makra ve skriptech</h2>
franta-hg@113: 		
franta-hg@113: 		<p>
franta-hg@113: 			Uvnitř zdrojového kódu skriptu můžeme používat jiná makra.
franta-hg@113: 			Např. tento kód:
franta-hg@113: 		</p>
franta-hg@113: 
franta-hg@113: 		<m:pre jazyk="xml"><![CDATA[<pre>
franta-hg@114: 	<m:skript jazyk="perl">
franta-hg@114: 		print "Náš podnik se jmenuje <m:firma/>";
franta-hg@113: 	</m:skript>
franta-hg@113: </pre>]]></m:pre>
franta-hg@113: 
franta-hg@113: 		<p>
franta-hg@113: 			nám vygeneruje:
franta-hg@113: 		</p>
franta-hg@113: 
franta-hg@114: 		<pre><m:skript jazyk="perl">
franta-hg@114: 				print "Náš podnik se jmenuje <m:firma/>";
franta-hg@113: 		</m:skript></pre>
franta-hg@113: 
franta-hg@113: 		<p>
franta-hg@113: 			Můžete si tak vytvořit makra pro opakující se části
franta-hg@114: 			a používat je jak v textu stránek, tak ve skriptech nebo diagramech.<m:podČarou>
franta-hg@114: 				Jen pozor na ošetření zvláštních znaků – pokud text takové znaky obsahuje,
franta-hg@114: 				je dobré ho zabalit ještě do jedné značky, která se postará o <em>escapování</em> 
franta-hg@114: 				pro daný kontext (skriptovací jazyk a prostředí v něm – např. apostrofy vs. uvozovky).
franta-hg@114: 			</m:podČarou>
franta-hg@114: 		</p>
franta-hg@114: 		
franta-hg@114: 		<p>
franta-hg@114: 			Jen pro připomenutí: nejedná se o nějaké primitivní zástupky a nahrazování textu
franta-hg@114: 			– makra můžou být parametrizovaná, obsahovat atributy (např. pád a číslo) nebo vnořené elementy
franta-hg@114: 			a na základě této parametrizace vytvářet odlišný výstup, který je následně předán skriptu.
franta-hg@114: 		</p>
franta-hg@114: 		
franta-hg@114: 		<pre><m:skript jazyk="bash">
franta-hg@114: 			echo "S naší <m:firma pád="7"/> budete jistě spokojeni!";
franta-hg@114: 			echo "Stejně jako my jsme spokojeni s operačním systémem `uname -o`.";
franta-hg@114: 		</m:skript></pre>
franta-hg@114: 		
franta-hg@114: 		<p>
franta-hg@114: 			Zdrojový kód:
franta-hg@114: 		</p>
franta-hg@114: 		
franta-hg@114: 		<!-- Pozor: ve zvýrazňovači syntaxe Pygmentize je chyba – neumí diakritiku – správně je: pád="7" -->
franta-hg@114: 		<m:pre jazyk="xml"><![CDATA[<pre>
franta-hg@114: 	<m:skript jazyk="bash">
franta-hg@114: 		echo "S naší <m:firma pad="7"/> budete jistě spokojeni!";
franta-hg@114: 		echo "Stejně jako my jsme spokojeni s operačním systémem `uname -o`.";
franta-hg@114: 	</m:skript>
franta-hg@114: </pre>]]></m:pre>
franta-hg@114: 
franta-hg@114: 		<p>
franta-hg@114: 			Skripty v těchto příkladech nejsou příliš užitečné, protože pouze vypisují text,
franta-hg@114: 			který by šlo vložit přímo do XML stránky
franta-hg@114: 			– předpokládá se, že ve svých skriptech budete dělat něco zajímavějšího :-)
franta-hg@113: 		</p>
franta-hg@113: 
franta-hg@107: 		<h2>Skripty v makrech</h2>
franta-hg@107: 		<p>
franta-hg@113: 			Uvnitř definic maker můžeme volat<m:podČarou>
franta-hg@107: 				Ovšem trochu jiným způsobem, než ve stránkách –
franta-hg@107: 				nacházíme se totiž v <em>programu</em> (XSL šablona definující makro)
franta-hg@107: 				nikoli v <em>datovém souboru</em> (XML stránka).
franta-hg@107: 			</m:podČarou>
franta-hg@107: 			jiná makra – mj. skripty.
franta-hg@111: 			Toho jsme využili v makru, které generuje tabulku verzí z mercurialu
franta-hg@111: 			– ten umí vypsat historii úložiště v XML, které následně snadno zpracujeme v XSLT.
franta-hg@107: 		</p>
franta-hg@107: 
franta-hg@107: 		<m:hg-verze/>
franta-hg@107: 
franta-hg@107: 		<p>
franta-hg@107: 			Toto makro naleznete v souboru <code>vstup/makra/hg-verze.xsl</code>.
franta-hg@107: 		</p>
franta-hg@107: 
franta-hg@111: 		<h2>Vnořování maker</h2>
franta-hg@111: 		<p>
franta-hg@111: 			Trochu jiný případ je vnořování maker na stránce.
franta-hg@111: 			Např. si chceme vypsat vybrané internetové služby:
franta-hg@111: 		</p>
franta-hg@111: 		<m:tabulka>
franta-hg@111: 			<m:skript jazyk="perl"><![CDATA[
franta-hg@111: use strict;
franta-hg@111: use warnings;
franta-hg@111: 
franta-hg@111: print "Port\tSlužba\tProtokol\n";
franta-hg@111: open(S, "<", "/etc/services") or die $!;
franta-hg@111: while (<S>) {
franta-hg@111: 	if (/(\w+)\s+(21|22|25|80)\/(tcp)/) {
franta-hg@111: 		print "$2\t$1\t$3\n";
franta-hg@111: 	}
franta-hg@111: }
franta-hg@111: 			]]></m:skript>
franta-hg@111: 		</m:tabulka>
franta-hg@111: 		
franta-hg@111: 		<p>
franta-hg@111: 			Pro vygenerování použijeme dvě makra – tabulku a skript – která vložíme do textu stránky:
franta-hg@111: 		</p>
franta-hg@111: 		
franta-hg@111: 		<m:pre jazyk="xml"><![CDATA[
franta-hg@111: <m:tabulka>
franta-hg@111: 	<m:skript jazyk="perl"><![CDATA[
franta-hg@111: 		print "Port\tSlužba\tProtokol\n";
franta-hg@111: 		open(S, "<", "/etc/services") or die $!;
franta-hg@111: 		while (<S>) {
franta-hg@111: 			if (/(\w+)\s+(21|22|25|80)\/(tcp)/) {
franta-hg@111: 				print "$2\t$1\t$3\n";
franta-hg@111: 			}
franta-hg@111: 		}
franta-hg@111: 	]]]]>&gt;<![CDATA[</m:skript>
franta-hg@111: </m:tabulka>]]></m:pre>
franta-hg@111: 
franta-hg@111: 		<p>
franta-hg@111: 			Ve skriptu v tomto případě negenerujeme XHTML značky, ale CSV (s tabulátory)
franta-hg@111: 			a o převod na XHTML tabulku se postará XSL šablona.
franta-hg@111: 		</p>
franta-hg@111: 
franta-hg@111: 		<!--
franta-hg@111: 			Nebo to taky můžeme napsat na jeden řádek:
franta-hg@111: 			cat /etc/services | perl -ne 'if (/(\w+)\s+(21|22|25|80)\/(tcp)/) { print "$2\t$1\t$3\n";}'
franta-hg@111: 			a vložit do tabulky jako BASH skript :-)
franta-hg@111: 		-->
franta-hg@111: 
franta-hg@111: 		<p>
franta-hg@113: 			Podobně bychom mohli postupovat i u <a href="#makraZeSkriptů">diagramu</a> –
franta-hg@111: 			negenerovat skriptem značky makra, ale pouze jeho obsah – zadání diagramu, nebo jen jeho část.
franta-hg@111: 			Někdy se ale může hodit ve skriptu nastavovat atributy elementů nebo elementy vytvářet dynamicky.
franta-hg@111: 		</p>
franta-hg@111: 
franta-hg@112: 		<p>
franta-hg@112: 			Skriptování lze použít i pro generování zdrojového kódu, který bude následně zvýrazněn
franta-hg@112: 			pomocí značky <code>&lt;m:pre jazyk="…"/&gt;</code>.
franta-hg@112: 			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.
franta-hg@112: 			Skript můžeme použít mj. i ke zkrácení zdrojáku – když chceme vypsat jen jeho relevantní část.
franta-hg@112: 		</p>
franta-hg@112: 
franta-hg@94: 	</text>
franta-hg@94: 
franta-hg@94: </stránka>
franta-hg@94: