Модуль Apache mod_xml2enc

Краткое описание

Этот модуль предоставляет расширенную поддержку интернационализации для модулей фильтров, учитывающих разметку, таких как mod_proxy_html. Он может автоматически определять кодировку входных данных и обеспечивать их корректную обработку парсером libxml2, включая преобразование в Unicode (UTF-8), если это необходимо. Он также может преобразовывать данные в выбранную кодировку после обработки разметки и обеспечивать установку правильного значения charset в заголовке HTTP Content-Type.

Использование

Предусмотрено два сценария использования: с модулями, запрограммированными для работы с mod_xml2enc, и с модулями, которые о нём не знают:

Модули фильтров с поддержкой mod_xml2enc

Такие модули, как mod_proxy_html версии 3.1 и выше, используют необязательную функцию xml2enc_charset для получения аргумента кодировки, передаваемого парсеру libxml2, и могут использовать необязательную функцию xml2enc_filter для последующей обработки с преобразованием в другую кодировку. При использовании mod_xml2enc с модулем, имеющим поддержку, конфигурация не требуется: другой модуль настроит mod_xml2enc за вас (хотя при необходимости вы можете настроить его с помощью приведённых ниже директив).

Модули без поддержки

Чтобы использовать его с модулем на основе libxml2, который явно не поддерживает mod_xml2enc, необходимо самостоятельно настроить цепочку фильтров. Например, чтобы улучшить поддержку i18n для HTML и XML у фильтра foo, предоставляемого модулем mod_foo, можно использовать

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 будет поддерживать все кодировки, поддерживаемые libxml2 и/или apr_xlate/iconv.

Программный API

Разработчикам, создающим модули фильтров на основе libxml2, рекомендуется обеспечить их поддержку mod_xml2enc, чтобы предоставить пользователям надёжную поддержку i18n и не изобретать велосипед. Программный API описан в mod_xml2enc.h, а пример использования доступен mod_proxy_html.

Определение кодировки

В отличие от mod_charset_lite, mod_xml2enc предназначен для работы с данными, кодировка которых заранее неизвестна и поэтому не может быть задана в конфигурации. Поэтому для определения кодировки данных HTTP он использует следующие методы «распознавания»:

1. Если заголовок HTTP Content-Type содержит параметр charset, используется его значение.
2. Если данные начинаются с маркера порядка байтов (BOM) XML или объявления кодировки XML, используется указанная кодировка.
3. Если кодировка объявлена в элементе HTML <META>, используется указанная кодировка.
4. Если ни одно из перечисленных условий не выполняется, используется значение по умолчанию, заданное директивой xml2EncDefault.

Правила применяются по порядку. Как только найдено совпадение, используется соответствующее значение, а определение кодировки прекращается.

Кодировка вывода

libxml2 всегда использует внутри UTF-8 (Unicode), и модули фильтров на основе libxml2 по умолчанию выводят данные в этой кодировке. mod_xml2enc может изменить кодировку вывода через API, но в настоящее время настроить её напрямую невозможно.

Изменение кодировки вывода (по крайней мере, теоретически) никогда не должно требоваться и не рекомендуется из-за дополнительной нагрузки на сервер при ненужном преобразовании.

Неподдерживаемые кодировки

Если вы используете кодировки, не поддерживаемые ни одним из доступных на вашей платформе методов преобразования, их всё равно можно связать с поддерживаемой кодировкой с помощью xml2EncAlias.

xml2EncAlias charset alias [alias ...]

xml2EncDefault name

xml2EncDefault iso-8859-1

xml2StartParse element [element ...]