1 <?xml version=
"1.0" encoding=
"ISO-8859-1" ?>
2 <!DOCTYPE manualpage SYSTEM
"../style/manualpage.dtd">
3 <?xml-stylesheet type=
"text/xsl" href=
"../style/manual.fr.xsl"?>
4 <!-- English Revision : 659902 -->
5 <!-- French translation : Lucien GENTIS -->
6 <!-- Reviewed by : Vincent Deffontaines -->
9 Licensed to the Apache Software Foundation (ASF) under one or more
10 contributor license agreements. See the NOTICE file distributed with
11 this work for additional information regarding copyright ownership.
12 The ASF licenses this file to You under the Apache License, Version 2.0
13 (the "License"); you may not use this file except in compliance with
14 the License. You may obtain a copy of the License at
16 http://www.apache.org/licenses/LICENSE-2.0
18 Unless required by applicable law or agreed to in writing, software
19 distributed under the License is distributed on an "AS IS" BASIS,
20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
21 See the License for the specific language governing permissions and
22 limitations under the License.
25 <manualpage metafile=
"ssi.xml.meta">
26 <parentdocument href=
"./">Recettes et tutoriels
</parentdocument>
28 <title>Tutoriel Apache : Introduction aux
"Inclusions Côté Serveur"
29 (Server Side Includes - SSI)
</title>
32 <p>Les SSI permettent d'ajouter du contenu dynamique
à des documents
33 HTML pr
éexistants.
</p>
36 <section id=
"related"><title>Introduction
</title>
39 <module>mod_include
</module>
40 <module>mod_cgi
</module>
41 <module>mod_expires
</module>
45 <directive module=
"core">Options
</directive>
46 <directive module=
"mod_include">XBitHack
</directive>
47 <directive module=
"mod_mime">AddType
</directive>
48 <directive module=
"core">SetOutputFilter
</directive>
49 <directive module=
"mod_setenvif">BrowserMatchNoCase
</directive>
53 <p>Cet article traite des Inclusions C
ôt
é Serveur (Server Side
54 Includes), plus commun
ément appel
és SSI. Vous trouverez ici la
55 mani
ère de configurer votre serveur pour permettre les SSI, ainsi
56 qu'une introduction
à quelques techniques SSI de base permettant
57 d'ajouter du contenu dynamique
à vos pages HTML pr
éexistantes.
</p>
59 <p>La derni
ère partie de cet article sera consacr
ée aux
60 configurations SSI plus avanc
ées, telles que les expressions
61 conditionnelles dans les directives SSI.
</p>
65 <section id=
"what"><title>Qu'est-ce que SSI ?
</title>
67 <p>SSI (Server Side Includes) est constitu
é de directives plac
ées dans
68 des pages HTML, et
évalu
ées par le serveur au moment o
ù les pages
69 sont servies. Elles vous permettent d'ajouter du contenu g
én
ér
é
70 dynamiquement
à une page HTML pr
éexistante, sans avoir
à servir la
71 page enti
ère via un programme CGI, ou toute autre technologie de
72 contenu dynamique.
</p>
74 <p>Le choix entre l'utilisation des SSI et la g
én
ération enti
ère de
75 la page par un programme quelconque, est en g
én
éral dict
é par la
76 proportion de contenu statique et de contenu devant
être g
én
ér
é
77 chaque fois que la page est servie. SSI est id
éal pour ajouter de
78 petites quantit
és d'information, comme l'heure courante. Mais si la
79 plus grande partie de votre page est g
én
ér
ée au moment o
ù elle est
80 servie, vous devez vous tourner vers une autre solution.
</p>
83 <section id=
"configuring">
84 <title>Configurer votre serveur pour permettre les SSI
</title>
86 <p>Pour permettre l'utilisation des SSI sur votre serveur, vous
87 devez ajouter la directive suivante dans votre fichier
88 <code>httpd.conf
</code>, ou dans un fichier
<code>.htaccess
</code>
94 <p>Cette directive indique
à Apache que vous d
ésirez permettre la
95 recherche de directives SSI lors de l'interpr
étation des fichiers.
96 Notez cependant que la plupart des configurations contiennent de
97 nombreuses directives
<directive module=
"core">Options
</directive>
98 qui peuvent s'
écraser les unes les autres. Vous devrez probablement
99 appliquer ces directives
<code>Options
</code> au r
épertoire
100 sp
écifique pour lequel vous voulez activer les SSI, afin d'
être s
ûr
101 qu'elles y seront bien activ
ées.
</p>
103 <p>Tout fichier ne fera cependant pas l'objet de recherche de
104 directives SSI. Vous devez indiquer
à Apache quels fichiers seront
105 concern
és. Vous pouvez y parvenir en indiquant une extension, comme
106 <code>.shtml
</code>,
à l'aide des directives suivantes :
</p>
108 AddType text/html .shtml
<br />
109 AddOutputFilter INCLUDES .shtml
112 <p>Un des d
ésavantages de cette approche r
éside dans le fait que si
113 vous voulez ajouter des directives SSI
à une page pr
éexistante, vous
114 devrez changer le nom de cette page, et donc tout lien qui la
115 contient, de fa
çon
à ce qu'elle poss
ède l'extension
116 <code>.shtml
</code>, condition n
écessaire pour que les directives
117 SSI qu'elle contient soient trait
ées.
</p>
119 <p>Une autre m
éthode consiste
à utiliser la directive
<directive
120 module=
"mod_include">XBitHack
</directive> :
</p>
125 <p>La directive
<directive module=
"mod_include">XBitHack
</directive>
126 indique
à Apache qu'il doit rechercher des directivves SSI dans les
127 fichiers si leur bit d'ex
écution est positionn
é. Il n'est ainsi plus
128 n
écessaire de changer le nom du fichier pour ajouter des directives
129 SSI
à une page pr
éexistante ; vous devez simplement attribuer les
130 droits d'ex
écution au fichier
à l'aide de
<code>chmod
</code>.
</p>
132 chmod +x pagename.html
135 <p>Un bref commentaire sur ce qu'il ne faut pas faire. Certaines
136 personnes peuvent vous conseiller de tout simplement indiquer
à
137 Apache de rechercher des directives SSI dans tous les fichiers
138 <code>.html
</code>, ce qui vous
évite d'avoir
à g
érer les noms de
139 fichiers avec extension
<code>.shtml
</code>. Ils n'ont probablement
140 pas entendu parler de la directive
<directive
141 module=
"mod_include">XBitHack
</directive>. En effet, vous devez
142 garder
à l'esprit qu'en faisant ceci, Apache va devoir rechercher
143 des directives SSI dans chaque fichier qu'il sert, m
ême s'il n'en
144 contient aucune. Ce n'est donc pas une bonne id
ée car les
145 performances peuvent en
être sensiblement affect
ées.
</p>
147 <p>Bien entendu, sous Windows, il n'y a pas de bit d'ex
écution
à
148 positionner, ce qui limite un peu vos choix.
</p>
150 <p>Dans sa configuration par d
éfaut, Apache n'envoie pas la date de
151 derni
ère modification ou les en-t
êtes HTTP relatifs
à la taille des
152 contenus dans les pages SSI, car ses valeurs sont difficiles
à
153 calculer pour les contenus dynamiques. Ceci peut induire une
154 impression de diminution des performances c
ôt
é client, en emp
êchant
155 la mise en cache de votre document. Il existe deux m
éthodes pour
156 r
ésoudre ce probl
ème :
</p>
159 <li>Utilisez la configuration
<code>XBitHack Full
</code>. Elle
160 indique
à Apache de d
éterminer la date de derni
ère modification en
161 ne regardant que la date du fichier
à l'origine de la requ
ête,
162 tout en ignorant la date de modification de tout fichier inclus.
</li>
164 <li>Utilisez les directives fournies par le module
165 <module>mod_expires
</module> pour d
éfinir de mani
ère explicite la
166 date d'expiration de vos fichiers, laissant par la-m
ême
167 aux navigateurs et aux mandataires le soin de d
éterminer s'il est
168 opportun ou non de les mettre en cache.
</li>
172 <section id=
"basic"><title>Directives SSI de base
</title>
174 <p>Les directives SSI adoptent la syntaxe suivante :
</p>
176 <!--#
él
ément attribut=valeur attribut=valeur ... --
>
179 <p>Le format d'une directive SSI
étant similaire
à celui d'un
180 commentaire HTML, si vous n'avez pas activ
é correctement SSI, le
181 navigateur l'ignorera, mais elle sera encore visible dans le source
182 HTML. Si SSI est correctement configur
é, la directive sera remplac
ée
183 par ses r
ésultats.
</p>
185 <p>"élément" peut prendre de nombreuses formes, et nous d
écrirons
186 plus pr
écis
ément la plupart d'entre eux dans la prochaine version de
187 ce document. Pour le moment, voici quelques exemples de ce que vous
188 pouvez faire avec SSI.
</p>
190 <section id=
"todaysdate"><title>La date courante
</title>
193 <!--#echo
var=
"DATE_LOCAL" --
>
196 <p>L'
él
ément
<code>echo
</code> permet d'afficher la valeur d'une
197 variable. Il existe un grand nombre de variables standards, y
198 compris l'ensemble des variables d'environnement disponibles pour
199 les programmes CGI. De plus, vous pouvez d
éfinir vos propres
200 variables
à l'aide de l'
él
ément
<code>set
</code>.
</p>
202 <p>Si vous n'aimez pas le format sous lequel la date s'affiche, vous
203 pouvez utiliser l'
él
ément
<code>config
</code> avec un attribut
204 <code>timefmt
</code>, pour le modifier.
</p>
207 <!--#config
timefmt=
"%A %B %d, %Y" --
><br />
208 Today is
<!--#echo
var=
"DATE_LOCAL" --
>
212 <section id=
"lastmodified"><title>Date de modification du fichier
</title>
215 Derni
ère modification du document
<!--#flastmod
file=
"index.html" --
>
218 <p>Le format peut l
à aussi
être modifi
é à l'aide de l'attribut
219 <code>timefmt
</code>.
</p>
222 <section id=
"cgi"><title>Inclusion des r
ésultats d'un programme CGI
</title>
224 <p>C'est le cas le plus courant d'utilisation des SSI - afficher les
225 r
ésultats d'un programme CGI, comme l'universellement ador
é
226 "compteur d'accès".
</p>
229 <!--#include
virtual=
"/cgi-bin/counter.pl" --
>
235 <section id=
"additionalexamples">
236 <title>Exemples additionnels
</title>
238 <p>Vous trouverez dans ce qui suit quelques exemples sp
écifiques de
239 ce que vous pouvez faire de vos documents HTML avec SSI.
</p>
241 <section id=
"docmodified"><title>Quand ce document a-t-il
ét
é modifi
é ?
</title>
243 <p>Nous avons mentionn
é plus haut que vous pouviez utiliser SSI pour
244 informer l'utilisateur de la date de derni
ère modification du
245 document. Cependant, la m
éthode pour y parvenir n'a pas
ét
é vraiment
246 abord
ée. Plac
é dans votre document HTML, le code suivant va ins
érer
247 un rep
ère de temps dans votre page. Bien entendu, SSI devra avoir
248 ét
é correctement activ
é, comme d
écrit plus haut.
</p>
250 <!--#config
timefmt=
"%A %B %d, %Y" --
><br />
251 Derni
ère modification du fichier
<!--#flastmod
file=
"ssi.shtml" --
>
254 <p>Bien entendu, vous devez remplacer
<code>ssi.shtml
</code> par le
255 nom du fichier auquel vous faites r
éf
érence. Ceci ne conviendra pas
256 si vous recherchez un morceau de code g
én
érique que vous pourrez
257 ins
érer dans tout fichier ; dans ce cas, il est pr
éf
érable
258 d'utiliser la variable
<code>LAST_MODIFIED
</code> :
</p>
260 <!--#config
timefmt=
"%D" --
><br />
261 This file last modified
<!--#echo
var=
"LAST_MODIFIED" --
>
264 <p>Pour plus de d
étails sur le format
<code>timefmt
</code>, tapez
265 <code>strftime
</code> dans votre moteur de recherche pr
éfer
é. La
266 syntaxe est identique.
</p>
269 <section id=
"standard-footer">
270 <title>Inclusion d'un pied de page standard
</title>
272 <p>Si le site que vous g
érez comporte plus que quelques pages, vous
273 allez vite vous apercevoir qu'effectuer des modifications sur toutes
274 ces pages peut devenir tr
ès contraignant, en particulier si vous
275 voulez qu'elles conservent un aspect homog
ène.
</p>
277 <p>Inclure un fichier pour un en-t
ête et/ou un pied de page peut
278 simplifier cette corv
ée de mises
à jour. Il vous suffit de
279 confectionner un fichier de pied de page, et de l'inclure dans
280 chaque page
à l'aide de l'
él
ément SSI
<code>include
</code>. Pour
281 d
éfinir le fichier
à inclure, l'
él
ément
<code>include
</code> peut
282 utiliser soit l'attribut
<code>file
</code>, soit l'attribut
283 <code>virtual
</code>. L'attribut
<code>file
</code> est un chemin de
284 fichier
<em>relatif au r
épertoire courant
</em>. C'est
à dire qu'il
285 ne peut ni avoir pour valeur un chemin absolu (commen
çant par /), ni
286 comporter
"../" dans son chemin. L'attribut
<code>virtual
</code> est
287 probablement plus commode, et peut sp
écifier une URL relative au
288 document servi. Elle peut commencer par un /, mais le fichier inclus
289 et le fichier servi doivent r
ésider sur le m
ême serveur.
</p>
291 <!--#include
virtual=
"/footer.html" --
>
294 <p>Je combinerai souvent ces deux derniers points, en ajoutant une
295 directive
<code>LAST_MODIFIED
</code> dans un fichier de pied de page
296 destin
é à être inclus. Le fichier inclus peut contenir des
297 directives SSI, et les inclusions peuvent
être imbriqu
ées -
à
298 savoir, le fichier inclus peut inclure un autre fichier, etc...
</p>
303 <section id=
"config">
304 <title>Que puis-je configurer d'autre ?
</title>
306 <p>En plus du format de date, vous pouvez utiliser l'
él
ément
307 <code>config
</code> pour configurer deux autres choses.
</p>
309 <p>En g
én
éral, lorsque quelque chose se passe mal avec votre
310 directive SSI, vous recevez le message :
</p>
312 [an error occurred while processing this directive]
315 <p>Pour modifier ce message, vous pouvez utiliser l'attribut
316 <code>errmsg
</code> avec l'
él
ément
<code>config
</code> :
</p>
318 <!--#config
errmsg=
"[Il semblerait que vous ne sachiez pas
319 utiliser les SSI]" --
>
322 <p>Il est cependant probable que les utilisateurs finaux ne voient
323 jamais ce message, car vous aurez r
ésolu tous les probl
èmes issus de
324 vos directives SSI avant que votre site ne soit mis en production.
327 <p>Vous pouvez aussi modifier le format sous lequel les tailles de
328 fichiers sont affich
ées
à l'aide de l'attribut
<code>sizefmt
</code>.
329 Vous pouvez sp
écifier
<code>bytes
</code> pour un affichage en
330 octets, ou
<code>abbrev
</code> pour un affichage plus concis en Ko
331 ou Mo, selon le cas.
</p>
335 <title>Ex
écution de commandes
</title>
337 <p>J'ai pour projet, dans les prochains mois, d'
écrire un article
à
338 propos de l'utilisation des SSI avec des petits programmes CGI. Pour
339 l'instant, voici ce que vous pouvez faire avec l'
él
ément
340 <code>exec
</code>. Vous pouvez vraiment faire ex
écuter une commande
341 par SSI en utilisant le shell (
<code>/bin/sh
</code>, pour
être plus
342 pr
écis - ou le shell DOS, si vous
êtes sous Win32). Par exemple, ce
343 qui suit vous permet d'afficher le contenu d'un r
épertoire.
</p>
346 <!--#exec
cmd=
"ls" --
><br />
350 <p>ou, sous Windows
</p>
353 <!--#exec
cmd=
"dir" --
><br />
357 <p>Vous noterez probablement l'
étrange formatage provoqu
é par cette
358 directive sous Windows, car la sortie de
<code>dir
</code> contient
359 la cha
îne de caract
ères
"<<code>dir</code>>", ce qui trompe le
362 <p>Notez que cette fonctionnalit
é est tr
ès dangereuse, car elle va
363 permettre d'ex
écuter tout code associ
é à l'
él
ément
364 <code>exec
</code>. Si vous
êtes dans la situation o
ù les
365 utilisateurs peuvent
éditer le contenu de vos pages web, dans le cas
366 d'un
"livre d'or" par exemple, assurez-vous de d
ésactiver cette
367 fonctionnalit
é. Vous pouvez, tout en permettant les SSI, d
ésactiver
368 la fonctionnalit
é <code>exec
</code> à l'aide de l'argument
369 <code>IncludesNOEXEC
</code> de la directive
370 <code>Options
</code>.
</p>
373 <section id=
"advanced">
374 <title>Techniques SSI avanc
ées
</title>
376 <p>Outre l'affichage de contenu, les SSI d'Apache vous permettent de
377 d
éfinir des variables, et de les utiliser dans des comparaisons et
380 <section id=
"caveat"><title>Mise en garde
</title>
382 <p>La plupart des fonctionnalit
és d
écrites dans cet article ne sont
383 disponibles que si vous utilisez la version
1.2 ou sup
érieure
384 d'Apache. Bien entendu, si ce n'est pas le cas, vous devez faire une
385 mise
à jour imm
édiatement, et m
ême plus t
ôt. Allez-y. Faites-le
386 maintenant. Nous attendrons.
</p>
389 <section id=
"variables"><title>D
éfinition de variables
</title>
391 <p>Avec l'
él
ément
<code>set
</code>, vous pouvez d
éfinir des
392 variables pour un usage ult
érieur. Comme nous en aurons besoin plus
393 loin, nous allons en parler tout de suite. La syntaxe se pr
ésente
396 <!--#set
var=
"name" value=
"Rich" --
>
399 <p>Pour affecter une valeur
à vos variables, en plus de la
400 d
éfinition litt
érale de l'exemple ci-dessus, vous pouvez utiliser
401 une autre variable, y compris les
<a
402 href=
"../env.html">variables d'environnement
</a>, ou les variables
403 d
écrites plus haut (comme
<code>LAST_MODIFIED
</code> par exemple).
404 Pour indiquer qu'il s'agit d'une variable et non d'une cha
îne, vous
405 devez utiliser le symbole dollar ($) devant le nom de la
408 <example> <!--#set
var=
"modified" value=
"$LAST_MODIFIED" --
>
411 <p>Pour ins
érer un caract
ère $ dans la valeur de votre variable,
412 vous devez l'
échapper
à l'aide d'un backslash.
</p>
414 <!--#set
var=
"cost" value=
"\$100" --
>
417 <p>Enfin, si vous voulez ins
érer une variable dans une cha
îne, et
418 s'il y a une chance pour que le nom de la variable se confonde avec
419 le reste de la cha
îne, vous pouvez l'entourer d'accolades pour
420 eviter toute confusion (Il est difficile de trouver un bon exemple
421 pour illustrer ceci, mais j'esp
ère que vous comprendrez).
</p>
423 <!--#set
var=
"date" value=
"${DATE_LOCAL}_${DATE_GMT}" --
>
427 <section id=
"conditional">
428 <title>Expressions conditionnelles
</title>
430 <p>Maintenent que nous avons des variables, et que nous pouvons
431 d
éfinir et comparer leurs valeurs, nous sommes
à m
ême de les
432 utiliser dans des expressions conditionnelles. Ceci conf
ère
à SSI le
433 statut de petit langage de programmation.
434 <module>mod_include
</module> fournit une structure
<code>if
</code>,
435 <code>elif
</code>,
<code>else
</code>,
<code>endif
</code> pour la
436 construction d'expressions conditionnelles, ce qui vous permet de
437 g
én
érer plusieurs pages logiques
à partir d'une seule vraie
440 <p>La structure de l'expression conditionnelle est :
</p>
442 <!--#if
expr=
"condition" --
><br />
443 <!--#elif
expr=
"condition" --
><br />
444 <!--#else --
><br />
448 <p>Une
<em>condition
</em> peut rev
êtir la forme de toute comparaison
449 logique - soit une comparaison de valeurs avec une autre, soit une
450 v
érification de la
"vérité" d'une valeur particuli
ère (Une cha
îne
451 donn
ée est vraie si elle n'est pas vide). Pour une liste exhaustive
452 des op
érateurs de comparaison disponibles, voir la documentation du
453 module
<module>mod_include
</module>. Voici quelques exemples
454 illustrant l'utilisation de ces expressions.
</p>
456 <p>Vous pouvez ajouter les lignes suivantes dans votre fichier de
459 BrowserMatchNoCase macintosh Mac
<br />
460 BrowserMatchNoCase MSIE InternetExplorer
463 <p>Ces lignes d
éfinissent les variables d'environnement
"Mac" et
464 "InternetExplorer" à true, si le client utilise InternetExplorer sur
467 <p>Puis, dans votre document o
ù les SSI sont activ
ées, vous ajoutez
470 <!--#if
expr=
"${Mac} && ${InternetExplorer}" --
><br />
471 Un texte d'excuses est ins
ér
é ici
<br />
472 <!--#else --
><br />
473 Ici se trouve du code JavaScipt sympa
<br />
477 <p>Notez que je n'ai rien contre IE sur Macintosh - J'ai juste
478 phosphor
é quelques heures la semaine derni
ère pour faire fonctionner
479 du JavaScript sous IE sur Macintosh, alors qu'il fonctionnait sous
480 tout autre environnement. Ce qui pr
éc
ède a constitu
é un
481 contournement provisoire.
</p>
483 <p>Toute autre variable (que vous avez d
éfinie, ou une variable
484 d'environnement normale) peut
être utilis
ée dans les expressions
485 conditionnelles. Associ
ée
à la possibilit
é avec Apache de d
éfinir
486 des variables d'environnement
à l'aide de directives
487 <code>SetEnvIf
</code>, ainsi que d'autres directives en rapport,
488 cette fonctionnalit
é vous permet d'ajouter des contenus dynamiques
489 assez
évolu
és sans avoir recours aux programmes CGI.
</p>
493 <section id=
"conclusion"><title>Conclusion
</title>
495 <p>SSI ne remplace certainement pas CGI, ou d'autres technologies
496 utilis
ées pour la g
én
ération de pages web dynamiques. Mais c'est une
497 bonne m
éthode pour ajouter des petits contenus dynamiques
à vos
498 pages, sans devoir fournir un gros effort suppl
émentaire.
</p>