vstup/skriptování.xml
author František Kučera <franta-hg@frantovo.cz>
Thu, 05 Jul 2012 20:25:21 +0200
changeset 109 f9e3ee9cc924
parent 108 8d9cab64c335
child 110 d43098fac783
permissions -rw-r--r--
#20 Skriptování: poznámka: xml → xhtml
franta-hg@94
     1
<stránka
franta-hg@94
     2
	xmlns="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/strana"
franta-hg@94
     3
	xmlns:m="https://trac.frantovo.cz/xml-web-generator/wiki/xmlns/makro">
franta-hg@94
     4
	<nadpis>Skriptování</nadpis>
franta-hg@94
     5
	<perex>Na stránku můžeme vložit výstup skriptů.</perex>
franta-hg@97
     6
	<pořadí>50</pořadí>
franta-hg@94
     7
franta-hg@94
     8
	<text xmlns="http://www.w3.org/1999/xhtml">
franta-hg@108
     9
franta-hg@94
    10
		<p>
franta-hg@94
    11
			Na stránkách můžeme používat skripty.
franta-hg@95
    12
			Spouští se při generování a jejich standardní výstup se vloží do stránky.
franta-hg@95
    13
			Třeba doprostřed textu ostavce nebo do jiného elementu.
franta-hg@94
    14
		</p>
franta-hg@94
    15
		<p>
franta-hg@94
    16
			Příklad:
franta-hg@95
    17
			<em>
franta-hg@95
    18
				Tyto stránky byly vygenerované v systému
franta-hg@95
    19
				<span title="tento text pochází ze skriptu"><m:skript jazyk="bash">uname -o</m:skript></span>.
franta-hg@95
    20
			</em>
franta-hg@95
    21
		</p>
franta-hg@95
    22
franta-hg@95
    23
		<p>
franta-hg@103
    24
			Díky skriptování můžeme stránky obohatit o prakticky libovolný obsah – 
franta-hg@107
    25
			jak prostý text, tak i XHTML fragmenty.<m:podČarou>
franta-hg@109
    26
				Zapíná se pomocí atributu <code>výstup="xhtml"</code> a generátor pak kontroluje správné formátování – 
franta-hg@107
    27
				nestane se vám, že byste omylem vygenerovali stránky s překříženými nebo neuzavřenými značkami.
franta-hg@107
    28
				Výchozím jmenným prostorem je XHTML a je dostupný i jmenný prostor pro makra (<code>m</code>).
franta-hg@107
    29
			</m:podČarou>
franta-hg@103
    30
		</p>
franta-hg@103
    31
		<p>
franta-hg@103
    32
			Skriptování ale může být nebezpečné, pokud byste spustili generátor na stránkách,
franta-hg@95
    33
			které psal někdo nedůvěryhodný a vložil do nich škodlivý kód.
franta-hg@105
    34
			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
    35
			(ne každý musí mít nainstalovaný Perl nebo Python či další podporované interprety).
franta-hg@105
    36
			Proto je skriptování ve výchozím stavu vypnuté – je potřeba ho povolit v souboru <code>web.conf</code>.
franta-hg@95
    37
		</p>
franta-hg@95
    38
franta-hg@95
    39
		<h2>Podporované jazyky</h2>
franta-hg@95
    40
		<p>
franta-hg@95
    41
			V současnosti jsou podporované tyto jazyky:
franta-hg@94
    42
		</p>
franta-hg@108
    43
franta-hg@95
    44
		<table>
franta-hg@95
    45
			<thead>
franta-hg@95
    46
				<tr>
franta-hg@95
    47
					<td>Jazyk</td>
franta-hg@95
    48
					<td>Interpret</td>
franta-hg@95
    49
				</tr>
franta-hg@95
    50
			</thead>
franta-hg@95
    51
			<tbody>
franta-hg@108
    52
				<m:skript jazyk="perl" výstup="xhtml"><![CDATA[
franta-hg@94
    53
use strict;
franta-hg@103
    54
use warnings;
franta-hg@94
    55
franta-hg@95
    56
open(JAVA, "<", $ENV{"XWG_SKRIPTOVANI_JAVA"}) or die $!;
franta-hg@94
    57
franta-hg@94
    58
while (<JAVA>) {
franta-hg@94
    59
	if (/podporovanýJazyk\.put\("(\w+)",\s*"(.*)"\);/) {
franta-hg@95
    60
		print "<tr><td><code>$1</code></td><td><code>$2</code></td></tr>\n";
franta-hg@94
    61
	}
franta-hg@94
    62
}
franta-hg@95
    63
				]]></m:skript>
franta-hg@95
    64
			</tbody>
franta-hg@95
    65
		</table>
franta-hg@94
    66
franta-hg@107
    67
		<h2>Perl – ukázka</h2>
franta-hg@94
    68
		<p>Jazyky použité nebo citované na této stránce:</p>
franta-hg@99
    69
		<!--
franta-hg@99
    70
			Lepšího výsledku bychom samozřejmě dosáhli pomocí XPath dotazu,
franta-hg@99
    71
			ale toto je příklad na Perl :-)
franta-hg@99
    72
		-->
franta-hg@94
    73
		<pre><m:skript jazyk="perl"><![CDATA[
franta-hg@94
    74
use strict;
franta-hg@103
    75
use warnings;
franta-hg@94
    76
franta-hg@94
    77
open(XML, "<", $ENV{"XWG_STRANKA_SOUBOR"});
franta-hg@94
    78
my %skripty;
franta-hg@94
    79
franta-hg@94
    80
while (<XML>) {
franta-hg@94
    81
	if (/m:skript\s+jazyk="(\w+)"/) {
franta-hg@94
    82
		$skripty{$1}++;
franta-hg@94
    83
	}
franta-hg@94
    84
}
franta-hg@94
    85
franta-hg@94
    86
for(keys(%skripty)) {
franta-hg@94
    87
	print "$skripty{$_}×\t $_\n";
franta-hg@94
    88
}
franta-hg@94
    89
			]]></m:skript></pre>
franta-hg@94
    90
franta-hg@107
    91
			<h2>BASH – ukázka</h2>
franta-hg@94
    92
		<pre><m:skript jazyk="bash"><![CDATA[
franta-hg@94
    93
echo -n "Právě je: ";
franta-hg@94
    94
date;
franta-hg@94
    95
echo -n "Operační systém: ";
franta-hg@102
    96
uname -o;
franta-hg@94
    97
echo -n "SHA-1 otisk zdrojáku této stránky: ";
franta-hg@100
    98
sha1sum "$XWG_STRANKA_SOUBOR" | cut -f 1 -d " ";
franta-hg@94
    99
			]]></m:skript></pre>
franta-hg@94
   100
franta-hg@94
   101
			<!--
franta-hg@94
   102
			<h2>PHP</h2>
franta-hg@94
   103
			<pre style="max-height: 200px;"><m:skript jazyk="php"><![CDATA[
franta-hg@94
   104
<?php
franta-hg@94
   105
phpinfo();
franta-hg@94
   106
?>
franta-hg@94
   107
			]]></m:skript></pre>
franta-hg@94
   108
			-->
franta-hg@94
   109
franta-hg@94
   110
			<h2>Proměnné prostředí</h2>
franta-hg@94
   111
			<p>
franta-hg@94
   112
				Ve skriptech máme dostupné následující proměnné prostředí:
franta-hg@94
   113
			</p>
franta-hg@108
   114
franta-hg@95
   115
			<table>
franta-hg@95
   116
				<thead>
franta-hg@95
   117
					<tr>
franta-hg@95
   118
						<td>Proměnná</td>
franta-hg@95
   119
						<td>Význam</td>
franta-hg@95
   120
					</tr>
franta-hg@95
   121
				</thead>
franta-hg@95
   122
				<tbody>
franta-hg@103
   123
					<!-- Pokud načítáme skript ze souboru, je atribut jazyk nepovinný. -->
franta-hg@108
   124
					<m:skript jazyk="perl" výstup="xhtml" src="skriptování-proměnné.pl"/>
franta-hg@95
   125
				</tbody>
franta-hg@95
   126
			</table>
franta-hg@108
   127
franta-hg@94
   128
			<p>
franta-hg@94
   129
				Kód:
franta-hg@94
   130
			</p>
franta-hg@108
   131
franta-hg@94
   132
			<m:pre jazyk="xml"><![CDATA[<m:skript jazyk="bash">
franta-hg@94
   133
echo "URI:    $XWG_STRANKA_URI";
franta-hg@94
   134
echo "Soubor: $XWG_STRANKA_SOUBOR";
franta-hg@94
   135
echo "Nadpis: $XWG_STRANKA_NADPIS";
franta-hg@94
   136
echo "Perex:  $XWG_STRANKA_PEREX";
franta-hg@94
   137
</m:skript>]]></m:pre>
franta-hg@108
   138
franta-hg@94
   139
			<p>nám vypíše:</p>
franta-hg@108
   140
franta-hg@94
   141
			<pre><m:skript jazyk="bash"><![CDATA[
franta-hg@94
   142
echo "URI:    $XWG_STRANKA_URI" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
franta-hg@94
   143
echo "Soubor: $XWG_STRANKA_SOUBOR" | sed s/\\/home\\/$USER/\\/home\\/xwg/g;
franta-hg@94
   144
echo "Nadpis: $XWG_STRANKA_NADPIS";
franta-hg@94
   145
echo "Perex:  $XWG_STRANKA_PEREX";
franta-hg@94
   146
		]]></m:skript></pre>
franta-hg@94
   147
franta-hg@107
   148
		<h2>Makra ve skriptech</h2>
franta-hg@107
   149
		<p>
franta-hg@107
   150
			XML generované skriptem může také obsahovat makra, která se následně interptetují.
franta-hg@108
   151
			<m:skript jazyk="bash" výstup="xhtml"><![CDATA[
franta-hg@107
   152
echo '<m:skript jazyk="bash">'; # Ty zrůdo! :-)
franta-hg@107
   153
echo 'echo "Takže můžeš skriptovat, když skriptuješ,";';
franta-hg@107
   154
echo '</m:skript>';
franta-hg@107
   155
			]]></m:skript>
franta-hg@107
   156
			nebo dělat něco užitečnějšího.
franta-hg@107
   157
		</p>
franta-hg@107
   158
		
franta-hg@108
   159
		<m:skript jazyk="perl" výstup="xhtml"><![CDATA[
franta-hg@107
   160
use strict;
franta-hg@107
   161
use warnings;
franta-hg@107
   162
franta-hg@107
   163
my $adresar = "vstup/makra";
franta-hg@107
   164
franta-hg@107
   165
print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
franta-hg@107
   166
print "	node		[shape=\"box\"];\n";
franta-hg@107
   167
print "	koren	[label=\"Uživatelská makra\"];\n";
franta-hg@107
   168
franta-hg@107
   169
opendir(DIR, $adresar) or die $!;
franta-hg@107
   170
my $i = 0;
franta-hg@107
   171
while (readdir(DIR)) {
franta-hg@107
   172
	next if (/^\./);
franta-hg@107
   173
	# Měli bychom ošetřit zvláštní znaky v názvech souborů,
franta-hg@107
   174
	# abychom nezpůsobili chybu GraphVizu.
franta-hg@107
   175
	print "n$i	[label=\"$_\"];\n";
franta-hg@107
   176
	print "koren -> n$i;\n";
franta-hg@107
   177
	$i++;
franta-hg@107
   178
}
franta-hg@107
   179
print "</m:diagram>";
franta-hg@107
   180
closedir(DIR);
franta-hg@107
   181
		]]></m:skript>
franta-hg@108
   182
franta-hg@107
   183
		<p>…třeba vygenerovat tento diagram následujícím perlovským skriptem:</p>
franta-hg@108
   184
franta-hg@107
   185
		<m:pre jazyk="perl"><![CDATA[
franta-hg@107
   186
use strict;
franta-hg@107
   187
use warnings;
franta-hg@107
   188
franta-hg@107
   189
my $adresar = "vstup/makra";
franta-hg@107
   190
franta-hg@107
   191
print "<m:diagram nadpis='Uživatelská makra v adresáři $adresar'>\n";
franta-hg@107
   192
print "	node	[shape=\"box\"];\n";
franta-hg@107
   193
print "	koren	[label=\"Uživatelská makra\"];\n";
franta-hg@107
   194
franta-hg@107
   195
opendir(DIR, $adresar) or die $!;
franta-hg@107
   196
my $i = 0;
franta-hg@107
   197
while (readdir(DIR)) {
franta-hg@107
   198
	next if (/^\./);
franta-hg@107
   199
	# Měli bychom ošetřit zvláštní znaky v názvech souborů,
franta-hg@107
   200
	# abychom nezpůsobili chybu GraphVizu.
franta-hg@107
   201
	print "n$i	[label=\"$_\"];\n";
franta-hg@107
   202
	print "koren -> n$i;\n";
franta-hg@107
   203
	$i++;
franta-hg@107
   204
}
franta-hg@107
   205
print "</m:diagram>";
franta-hg@107
   206
closedir(DIR);]]></m:pre>
franta-hg@107
   207
franta-hg@107
   208
		<p>
franta-hg@108
   209
			Který vložíme zabalený v <code><![CDATA[<m:skript jazyk="perl" výstup="xhtml"> … </m:skript>]]></code> do stránky.
franta-hg@107
   210
		</p>
franta-hg@107
   211
		<p>
franta-hg@107
   212
			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
   213
		</p>
franta-hg@107
   214
franta-hg@107
   215
		<h2>Skripty v makrech</h2>
franta-hg@107
   216
		<p>
franta-hg@107
   217
			Uvnitř maker můžeme volat<m:podČarou>
franta-hg@107
   218
				Ovšem trochu jiným způsobem, než ve stránkách –
franta-hg@107
   219
				nacházíme se totiž v <em>programu</em> (XSL šablona definující makro)
franta-hg@107
   220
				nikoli v <em>datovém souboru</em> (XML stránka).
franta-hg@107
   221
			</m:podČarou>
franta-hg@107
   222
			jiná makra – mj. skripty.
franta-hg@107
   223
			Toho jsme využili v makru, které generuje tabulku verzí z mercurialu:
franta-hg@107
   224
		</p>
franta-hg@107
   225
franta-hg@107
   226
		<m:hg-verze/>
franta-hg@107
   227
franta-hg@107
   228
		<p>
franta-hg@107
   229
			Toto makro naleznete v souboru <code>vstup/makra/hg-verze.xsl</code>.
franta-hg@107
   230
		</p>
franta-hg@107
   231
franta-hg@94
   232
	</text>
franta-hg@94
   233
franta-hg@94
   234
</stránka>
franta-hg@94
   235