Module Apache mod_xml2enc

Utilisation

Il existe deux sc�narios d'utilisation : le cas des modules programm�s pour travailler avec mod_xml2enc ; et les autres :

Modules de filtrages programm�s pour mod_xml2enc

Les modules comme mod_proxy_html versions 3.1 et sup�rieures utilisent la fonction optionnelle xml2enc_charset pour d�terminer la valeur de l'argument "jeu de caract�res" � transmettre � l'interpr�teur libxml2, et disposent de la fonction optionnelle xml2enc_filter pour effectuer un encodage ult�rieur �ventuel. L'utilisation de mod_xml2enc avec un module pr�programm� � cet effet ne n�cessite aucune configuration : ce dernier configurera mod_xml2enc pour vous (sachant que vous pouvez tout de m�me le personnaliser via les directives de configuration ci-dessous).

Modules de filtrages non programm�s pour mod_xml2enc

Pour utiliser mod_xml2enc avec un module bas� sur libxml2 qui n'a pas �t� explicitement programm� pour mod_xml2enc, vous devrez configurer la cha�ne de filtrage vous-m�me. Ainsi, pour utiliser mod_xml2enc avec un filtre foo fourni par un module mod_foo et pour am�liorer le support i18n de ce dernier avec HTML et XML, vous pouvez utiliser les directives suivantes :

    FilterProvider iconv    xml2enc Content-Type $text/html
    FilterProvider iconv    xml2enc Content-Type $xml
    FilterProvider markup   foo Content-Type $text/html
    FilterProvider markup   foo Content-Type $xml
    FilterChain     iconv markup
    

mod_foo supportera alors tout jeu de caract�re support� soit par libxml2, soit par apr_xlate/iconv, soit par les deux.

API de programmation

Les programmeurs de modules de filtrage bas�s sur libxml2 sont encourag�s � les pr�programmer pour mod_xml2enc, afin de fournir un support i18n solide aux utilisateurs sans avoir � r�inventer la roue. L'API de programmation est d�crite dans mod_xml2enc.h, et mod_proxy_html est un exemple de son utilisation.

D�tection et encodage

A la diff�rence de mod_charset_lite, mod_xml2enc est con�u pour travailler avec des donn�es dont l'encodage ne peut pas �tre connu, et donc configur�, � l'avance. Il utilise donc les techniques de 'reniflage' suivantes pour d�tecter le type d'encodage des donn�es HTTP :

1. Si l'en-t�te HTTP Content-Type contient un param�tre charset, c'est ce dernier qui sera utilis�.
2. Si les donn�es commancent par une balise XML concernant l'ordre des octets (BOM) ou par une d�claration d'encodage XML, c'est celle-ci qui sera utilis�e.
3. Si un type d'encodage est d�clar� dans un �l�ment HTML <META>, c'est ce dernier qui sera utilis�.
4. Si aucun des �l�ments pr�c�dents n'est trouv�, c'est la valeur par d�faut d�finie par la directive xml2EncDefault qui sera utilis�e.

Les conditions sont test�es dans cet ordre . D�s qu'une r�gle s'applique, elle est utilis�e et la d�tection est termin�e.

Codage en sortie

libxml2 utilise toujours UTF-8 (Unicode) en interne, et les modules de filtrage bas�s sur libxml2 utiliseront cet encodage en sortie par d�faut. mod_xml2enc peut modifier l'encodage en sortie via l'API, mais il n'y a actuellement aucun moyen de le configurer directement.

La modification de l'encodage en sortie ne devrait (du moins en th�orie) jamais �tre n�cessaire, et est m�me d�conseill�e � cause de la charge de traitement suppl�mentaire impos�e au serveur par une conversion non n�cessaire.

Codages non support�s

Si vous travaillez avec des encodages non support�s par aucune des m�thodes de conversion disponibles sur votre plateforme, vous pouvez tout de m�me leur associer un alias vers un code support� via la directive xml2EncAlias.