ssi.html.fr revision 282b62d8e9a4edbc2da22ba2d876ec94afc48084
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>Tutoriel Apache : Introduction aux "Inclusions C�t� Serveur"
(Server Side Includes - SSI) - Serveur Apache HTTP</title>
<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<body id="manual-page"><div id="page-header">
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p>
<p class="apache">Serveur Apache HTTP Version 2.3</p>
<div id="path">
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">Serveur HTTP</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.3</a> > <a href="./">Recettes et tutoriels</a></div><div id="page-content"><div id="preamble"><h1>Tutoriel Apache : Introduction aux "Inclusions C�t� Serveur"
(Server Side Includes - SSI)</h1>
<div class="toplang">
<p><span>Langues Disponibles: </span><a href="/en/howto/ssi.html" hreflang="en" rel="alternate" title="English"> en </a> |
</div>
<p>Les SSI permettent d'ajouter du contenu dynamique � des documents
HTML pr�existants.</p>
</div>
<div id="quickview"><ul id="toc"><li><img alt="" src="/images/down.gif" /> <a href="#related">Introduction</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#configuring">Configurer votre serveur pour permettre les SSI</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#additionalexamples">Exemples additionnels</a></li>
<li><img alt="" src="/images/down.gif" /> <a href="#config">Que puis-je configurer d'autre ?</a></li>
</ul></div>
<div class="section">
<h2><a name="related" id="related">Introduction</a></h2>
<table class="related"><tr><th>Modules Apparent�s</th><th>Directives Apparent�es</th></tr><tr><td><ul><li><code class="module"><a href="/mod/mod_include.html">mod_include</a></code></li><li><code class="module"><a href="/mod/mod_cgi.html">mod_cgi</a></code></li><li><code class="module"><a href="/mod/mod_expires.html">mod_expires</a></code></li></ul></td><td><ul><li><code class="directive"><a href="/mod/core.html#options">Options</a></code></li><li><code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code></li><li><code class="directive"><a href="/mod/mod_mime.html#addtype">AddType</a></code></li><li><code class="directive"><a href="/mod/core.html#setoutputfilter">SetOutputFilter</a></code></li><li><code class="directive"><a href="/mod/mod_setenvif.html#browsermatchnocase">BrowserMatchNoCase</a></code></li></ul></td></tr></table>
<p>Cet article traite des Inclusions C�t� Serveur (Server Side
Includes), plus commun�ment appel�s SSI. Vous trouverez ici la
mani�re de configurer votre serveur pour permettre les SSI, ainsi
qu'une introduction � quelques techniques SSI de base permettant
d'ajouter du contenu dynamique � vos pages HTML pr�existantes.</p>
<p>La derni�re partie de cet article sera consacr�e aux
configurations SSI plus avanc�es, telles que les expressions
conditionnelles dans les directives SSI.</p>
<div class="section">
<h2><a name="what" id="what">Qu'est-ce que SSI ?</a></h2>
<p>SSI (Server Side Includes) est constitu� de directives plac�es dans
des pages HTML, et �valu�es par le serveur au moment o� les pages
sont servies. Elles vous permettent d'ajouter du contenu g�n�r�
dynamiquement � une page HTML pr�existante, sans avoir � servir la
page enti�re via un programme CGI, ou toute autre technologie de
contenu dynamique.</p>
<p>Le choix entre l'utilisation des SSI et la g�n�ration enti�re de
la page par un programme quelconque, est en g�n�ral dict� par la
proportion de contenu statique et de contenu devant �tre g�n�r�
chaque fois que la page est servie. SSI est id�al pour ajouter de
petites quantit�s d'information, comme l'heure courante. Mais si la
plus grande partie de votre page est g�n�r�e au moment o� elle est
servie, vous devez vous tourner vers une autre solution.</p>
<div class="section">
<h2><a name="configuring" id="configuring">Configurer votre serveur pour permettre les SSI</a></h2>
<p>Pour permettre l'utilisation des SSI sur votre serveur, vous
devez ajouter la directive suivante dans votre fichier
:</p>
<div class="example"><p><code>
Options +Includes
</code></p></div>
<p>Cette directive indique � Apache que vous d�sirez permettre la
recherche de directives SSI lors de l'interpr�tation des fichiers.
Notez cependant que la plupart des configurations contiennent de
qui peuvent s'�craser les unes les autres. Vous devrez probablement
appliquer ces directives <code>Options</code> au r�pertoire
sp�cifique pour lequel vous voulez activer les SSI, afin d'�tre s�r
qu'elles y seront bien activ�es.</p>
<p>Tout fichier ne fera cependant pas l'objet de recherche de
directives SSI. Vous devez indiquer � Apache quels fichiers seront
concern�s. Vous pouvez y parvenir en indiquant une extension, comme
<code>.shtml</code>, � l'aide des directives suivantes :</p>
<div class="example"><p><code>
AddOutputFilter INCLUDES .shtml
</code></p></div>
<p>Un des d�savantages de cette approche r�side dans le fait que si
vous voulez ajouter des directives SSI � une page pr�existante, vous
devrez changer le nom de cette page, et donc tout lien qui la
contient, de fa�on � ce qu'elle poss�de l'extension
<code>.shtml</code>, condition n�cessaire pour que les directives
SSI qu'elle contient soient trait�es.</p>
<p>Une autre m�thode consiste � utiliser la directive <code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code> :</p>
<div class="example"><p><code>
XBitHack on
</code></p></div>
<p>La directive <code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code>
indique � Apache qu'il doit rechercher des directivves SSI dans les
fichiers si leur bit d'ex�cution est positionn�. Il n'est ainsi plus
n�cessaire de changer le nom du fichier pour ajouter des directives
SSI � une page pr�existante ; vous devez simplement attribuer les
droits d'ex�cution au fichier � l'aide de <code>chmod</code>.</p>
<div class="example"><p><code>
chmod +x pagename.html
</code></p></div>
<p>Un bref commentaire sur ce qu'il ne faut pas faire. Certaines
personnes peuvent vous conseiller de tout simplement indiquer �
Apache de rechercher des directives SSI dans tous les fichiers
<code>.html</code>, ce qui vous �vite d'avoir � g�rer les noms de
fichiers avec extension <code>.shtml</code>. Ils n'ont probablement
pas entendu parler de la directive <code class="directive"><a href="/mod/mod_include.html#xbithack">XBitHack</a></code>. En effet, vous devez
garder � l'esprit qu'en faisant ceci, Apache va devoir rechercher
des directives SSI dans chaque fichier qu'il sert, m�me s'il n'en
contient aucune. Ce n'est donc pas une bonne id�e car les
performances peuvent en �tre sensiblement affect�es.</p>
<p>Bien entendu, sous Windows, il n'y a pas de bit d'ex�cution �
positionner, ce qui limite un peu vos choix.</p>
<p>Dans sa configuration par d�faut, Apache n'envoie pas la date de
derni�re modification ou les en-t�tes HTTP relatifs � la taille des
contenus dans les pages SSI, car ses valeurs sont difficiles �
calculer pour les contenus dynamiques. Ceci peut induire une
impression de diminution des performances c�t� client, en emp�chant
la mise en cache de votre document. Il existe deux m�thodes pour
r�soudre ce probl�me :</p>
<ol>
<li>Utilisez la configuration <code>XBitHack Full</code>. Elle
indique � Apache de d�terminer la date de derni�re modification en
ne regardant que la date du fichier � l'origine de la requ�te,
tout en ignorant la date de modification de tout fichier inclus.</li>
<li>Utilisez les directives fournies par le module
<code class="module"><a href="/mod/mod_expires.html">mod_expires</a></code> pour d�finir de mani�re explicite la
date d'expiration de vos fichiers, laissant par la-m�me
aux navigateurs et aux mandataires le soin de d�terminer s'il est
opportun ou non de les mettre en cache.</li>
</ol>
<div class="section">
<h2><a name="basic" id="basic">Directives SSI de base</a></h2>
<p>Les directives SSI adoptent la syntaxe suivante :</p>
<div class="example"><p><code>
<!--#�l�ment attribut=valeur attribut=valeur ... -->
</code></p></div>
<p>Le format d'une directive SSI �tant similaire � celui d'un
commentaire HTML, si vous n'avez pas activ� correctement SSI, le
navigateur l'ignorera, mais elle sera encore visible dans le source
HTML. Si SSI est correctement configur�, la directive sera remplac�e
par ses r�sultats.</p>
<p>"�l�ment" peut prendre de nombreuses formes, et nous d�crirons
plus pr�cis�ment la plupart d'entre eux dans la prochaine version de
ce document. Pour le moment, voici quelques exemples de ce que vous
pouvez faire avec SSI.</p>
<h3><a name="todaysdate" id="todaysdate">La date courante</a></h3>
<div class="example"><p><code>
<!--#echo var="DATE_LOCAL" -->
</code></p></div>
<p>L'�l�ment <code>echo</code> permet d'afficher la valeur d'une
variable. Il existe un grand nombre de variables standards, y
compris l'ensemble des variables d'environnement disponibles pour
les programmes CGI. De plus, vous pouvez d�finir vos propres
variables � l'aide de l'�l�ment <code>set</code>.</p>
<p>Si vous n'aimez pas le format sous lequel la date s'affiche, vous
pouvez utiliser l'�l�ment <code>config</code> avec un attribut
<code>timefmt</code>, pour le modifier.</p>
<div class="example"><p><code>
<!--#config timefmt="%A %B %d, %Y" --><br />
Today is <!--#echo var="DATE_LOCAL" -->
</code></p></div>
<h3><a name="lastmodified" id="lastmodified">Date de modification du fichier</a></h3>
<div class="example"><p><code>
Derni�re modification du document <!--#flastmod file="index.html" -->
</code></p></div>
<p>Le format peut l� aussi �tre modifi� � l'aide de l'attribut
<code>timefmt</code>.</p>
<h3><a name="cgi" id="cgi">Inclusion des r�sultats d'un programme CGI</a></h3>
<p>C'est le cas le plus courant d'utilisation des SSI - afficher les
r�sultats d'un programme CGI, comme l'universellement ador�
"compteur d'acc�s".</p>
<div class="example"><p><code>
<!--#include virtual="/cgi-bin/counter.pl" -->
</code></p></div>
<div class="section">
<h2><a name="additionalexamples" id="additionalexamples">Exemples additionnels</a></h2>
<p>Vous trouverez dans ce qui suit quelques exemples sp�cifiques de
ce que vous pouvez faire de vos documents HTML avec SSI.</p>
<h3><a name="docmodified" id="docmodified">Quand ce document a-t-il �t� modifi� ?</a></h3>
<p>Nous avons mentionn� plus haut que vous pouviez utiliser SSI pour
informer l'utilisateur de la date de derni�re modification du
document. Cependant, la m�thode pour y parvenir n'a pas �t� vraiment
abord�e. Plac� dans votre document HTML, le code suivant va ins�rer
un rep�re de temps dans votre page. Bien entendu, SSI devra avoir
�t� correctement activ�, comme d�crit plus haut.</p>
<div class="example"><p><code>
<!--#config timefmt="%A %B %d, %Y" --><br />
Derni�re modification du fichier <!--#flastmod file="ssi.shtml" -->
</code></p></div>
nom du fichier auquel vous faites r�f�rence. Ceci ne conviendra pas
si vous recherchez un morceau de code g�n�rique que vous pourrez
ins�rer dans tout fichier ; dans ce cas, il est pr�f�rable
d'utiliser la variable <code>LAST_MODIFIED</code> :</p>
<div class="example"><p><code>
<!--#config timefmt="%D" --><br />
This file last modified <!--#echo var="LAST_MODIFIED" -->
</code></p></div>
<p>Pour plus de d�tails sur le format <code>timefmt</code>, tapez
<code>strftime</code> dans votre moteur de recherche pr�fer�. La
syntaxe est identique.</p>
<h3><a name="standard-footer" id="standard-footer">Inclusion d'un pied de page standard</a></h3>
<p>Si le site que vous g�rez comporte plus que quelques pages, vous
allez vite vous apercevoir qu'effectuer des modifications sur toutes
ces pages peut devenir tr�s contraignant, en particulier si vous
voulez qu'elles conservent un aspect homog�ne.</p>
simplifier cette corv�e de mises � jour. Il vous suffit de
confectionner un fichier de pied de page, et de l'inclure dans
chaque page � l'aide de l'�l�ment SSI <code>include</code>. Pour
d�finir le fichier � inclure, l'�l�ment <code>include</code> peut
utiliser soit l'attribut <code>file</code>, soit l'attribut
<code>virtual</code>. L'attribut <code>file</code> est un chemin de
fichier <em>relatif au r�pertoire courant</em>. C'est � dire qu'il
ne peut ni avoir pour valeur un chemin absolu (commen�ant par /), ni
comporter "../" dans son chemin. L'attribut <code>virtual</code> est
probablement plus commode, et peut sp�cifier une URL relative au
document servi. Elle peut commencer par un /, mais le fichier inclus
et le fichier servi doivent r�sider sur le m�me serveur.</p>
<div class="example"><p><code>
<!--#include virtual="/footer.html" -->
</code></p></div>
<p>Je combinerai souvent ces deux derniers points, en ajoutant une
directive <code>LAST_MODIFIED</code> dans un fichier de pied de page
destin� � �tre inclus. Le fichier inclus peut contenir des
directives SSI, et les inclusions peuvent �tre imbriqu�es - �
savoir, le fichier inclus peut inclure un autre fichier, etc...</p>
<div class="section">
<h2><a name="config" id="config">Que puis-je configurer d'autre ?</a></h2>
<p>En plus du format de date, vous pouvez utiliser l'�l�ment
<code>config</code> pour configurer deux autres choses.</p>
<p>En g�n�ral, lorsque quelque chose se passe mal avec votre
directive SSI, vous recevez le message :</p>
<div class="example"><p><code>
[an error occurred while processing this directive]
</code></p></div>
<p>Pour modifier ce message, vous pouvez utiliser l'attribut
<code>errmsg</code> avec l'�l�ment <code>config</code> :</p>
<div class="example"><p><code>
<!--#config errmsg="[Il semblerait que vous ne sachiez pas
utiliser les SSI]" -->
</code></p></div>
<p>Il est cependant probable que les utilisateurs finaux ne voient
jamais ce message, car vous aurez r�solu tous les probl�mes issus de
vos directives SSI avant que votre site ne soit mis en production.
(N'est-ce pas ?)</p>
<p>Vous pouvez aussi modifier le format sous lequel les tailles de
fichiers sont affich�es � l'aide de l'attribut <code>sizefmt</code>.
Vous pouvez sp�cifier <code>bytes</code> pour un affichage en
octets, ou <code>abbrev</code> pour un affichage plus concis en Ko
ou Mo, selon le cas.</p>
<div class="section">
<h2><a name="exec" id="exec">Ex�cution de commandes</a></h2>
<p>J'ai pour projet, dans les prochains mois, d'�crire un article �
propos de l'utilisation des SSI avec des petits programmes CGI. Pour
l'instant, voici ce que vous pouvez faire avec l'�l�ment
<code>exec</code>. Vous pouvez vraiment faire ex�cuter une commande
pr�cis - ou le shell DOS, si vous �tes sous Win32). Par exemple, ce
qui suit vous permet d'afficher le contenu d'un r�pertoire.</p>
<div class="example"><p><code>
<pre><br />
<!--#exec cmd="ls" --><br />
</pre>
</code></p></div>
<p>ou, sous Windows</p>
<div class="example"><p><code>
<pre><br />
<!--#exec cmd="dir" --><br />
</pre>
</code></p></div>
<p>Vous noterez probablement l'�trange formatage provoqu� par cette
directive sous Windows, car la sortie de <code>dir</code> contient
la cha�ne de caract�res "<<code>dir</code>>", ce qui trompe le
navigateur.</p>
<p>Notez que cette fonctionnalit� est tr�s dangereuse, car elle va
permettre d'ex�cuter tout code associ� � l'�l�ment
<code>exec</code>. Si vous �tes dans la situation o� les
utilisateurs peuvent �diter le contenu de vos pages web, dans le cas
d'un "livre d'or" par exemple, assurez-vous de d�sactiver cette
fonctionnalit�. Vous pouvez, tout en permettant les SSI, d�sactiver
la fonctionnalit� <code>exec</code> � l'aide de l'argument
<code>IncludesNOEXEC</code> de la directive
<code>Options</code>.</p>
<div class="section">
<h2><a name="advanced" id="advanced">Techniques SSI avanc�es</a></h2>
<p>Outre l'affichage de contenu, les SSI d'Apache vous permettent de
d�finir des variables, et de les utiliser dans des comparaisons et
des conditions.</p>
<h3><a name="caveat" id="caveat">Mise en garde</a></h3>
<p>La plupart des fonctionnalit�s d�crites dans cet article ne sont
disponibles que si vous utilisez la version 1.2 ou sup�rieure
d'Apache. Bien entendu, si ce n'est pas le cas, vous devez faire une
mise � jour imm�diatement, et m�me plus t�t. Allez-y. Faites-le
maintenant. Nous attendrons.</p>
<h3><a name="variables" id="variables">D�finition de variables</a></h3>
<p>Avec l'�l�ment <code>set</code>, vous pouvez d�finir des
variables pour un usage ult�rieur. Comme nous en aurons besoin plus
loin, nous allons en parler tout de suite. La syntaxe se pr�sente
comme suit :</p>
<div class="example"><p><code>
<!--#set var="name" value="Rich" -->
</code></p></div>
<p>Pour affecter une valeur � vos variables, en plus de la
d�finition litt�rale de l'exemple ci-dessus, vous pouvez utiliser
une autre variable, y compris les <a href="/env.html">variables d'environnement</a>, ou les variables
d�crites plus haut (comme <code>LAST_MODIFIED</code> par exemple).
Pour indiquer qu'il s'agit d'une variable et non d'une cha�ne, vous
devez utiliser le symbole dollar ($) devant le nom de la
variable.</p>
<div class="example"><p><code> <!--#set var="modified" value="$LAST_MODIFIED" -->
</code></p></div>
<p>Pour ins�rer un caract�re $ dans la valeur de votre variable,
vous devez l'�chapper � l'aide d'un backslash.</p>
<div class="example"><p><code>
<!--#set var="cost" value="\$100" -->
</code></p></div>
<p>Enfin, si vous voulez ins�rer une variable dans une cha�ne, et
s'il y a une chance pour que le nom de la variable se confonde avec
le reste de la cha�ne, vous pouvez l'entourer d'accolades pour
eviter toute confusion (Il est difficile de trouver un bon exemple
pour illustrer ceci, mais j'esp�re que vous comprendrez).</p>
<div class="example"><p><code>
<!--#set var="date" value="${DATE_LOCAL}_${DATE_GMT}" -->
</code></p></div>
<h3><a name="conditional" id="conditional">Expressions conditionnelles</a></h3>
<p>Maintenent que nous avons des variables, et que nous pouvons
d�finir et comparer leurs valeurs, nous sommes � m�me de les
utiliser dans des expressions conditionnelles. Ceci conf�re � SSI le
statut de petit langage de programmation.
<code class="module"><a href="/mod/mod_include.html">mod_include</a></code> fournit une structure <code>if</code>,
<code>elif</code>, <code>else</code>, <code>endif</code> pour la
construction d'expressions conditionnelles, ce qui vous permet de
g�n�rer plusieurs pages logiques � partir d'une seule vraie
page.</p>
<p>La structure de l'expression conditionnelle est :</p>
<div class="example"><p><code>
<!--#if expr="condition" --><br />
<!--#elif expr="condition" --><br />
<!--#else --><br />
<!--#endif -->
</code></p></div>
<p>Une <em>condition</em> peut rev�tir la forme de toute comparaison
logique - soit une comparaison de valeurs avec une autre, soit une
v�rification de la "v�rit�" d'une valeur particuli�re (Une cha�ne
donn�e est vraie si elle n'est pas vide). Pour une liste exhaustive
des op�rateurs de comparaison disponibles, voir la documentation du
module <code class="module"><a href="/mod/mod_include.html">mod_include</a></code>. Voici quelques exemples
illustrant l'utilisation de ces expressions.</p>
<p>Vous pouvez ajouter les lignes suivantes dans votre fichier de
configuration :</p>
<div class="example"><p><code>
BrowserMatchNoCase macintosh Mac<br />
BrowserMatchNoCase MSIE InternetExplorer
</code></p></div>
<p>Ces lignes d�finissent les variables d'environnement "Mac" et
"InternetExplorer" � true, si le client utilise InternetExplorer sur
un Macintosh.</p>
<p>Puis, dans votre document o� les SSI sont activ�es, vous ajoutez
ceci :</p>
<div class="example"><p><code>
<!--#if expr="${Mac} && ${InternetExplorer}" --><br />
Un texte d'excuses est ins�r� ici<br />
<!--#else --><br />
Ici se trouve du code JavaScipt sympa<br />
<!--#endif -->
</code></p></div>
<p>Notez que je n'ai rien contre IE sur Macintosh - J'ai juste
phosphor� quelques heures la semaine derni�re pour faire fonctionner
du JavaScript sous IE sur Macintosh, alors qu'il fonctionnait sous
tout autre environnement. Ce qui pr�c�de a constitu� un
contournement provisoire.</p>
<p>Toute autre variable (que vous avez d�finie, ou une variable
d'environnement normale) peut �tre utilis�e dans les expressions
conditionnelles. Associ�e � la possibilit� avec Apache de d�finir
des variables d'environnement � l'aide de directives
<code>SetEnvIf</code>, ainsi que d'autres directives en rapport,
cette fonctionnalit� vous permet d'ajouter des contenus dynamiques
assez �volu�s sans avoir recours aux programmes CGI.</p>
<div class="section">
<h2><a name="conclusion" id="conclusion">Conclusion</a></h2>
<p>SSI ne remplace certainement pas CGI, ou d'autres technologies
utilis�es pour la g�n�ration de pages web dynamiques. Mais c'est une
bonne m�thode pour ajouter des petits contenus dynamiques � vos
pages, sans devoir fournir un gros effort suppl�mentaire.</p>
</div></div>
<div class="bottomlang">
<p><span>Langues Disponibles: </span><a href="/en/howto/ssi.html" hreflang="en" rel="alternate" title="English"> en </a> |
</div><div id="footer">
<p class="apache">Copyright 2009 The Apache Software Foundation.<br />Autoris� sous <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossaire</a> | <a href="/sitemap.html">Plan du site</a></p></div>
</body></html>