Модуль Apache mod_cgi

Обзор

Любой файл с обработчиком cgi-script будет рассматриваться как CGI-скрипт и запускаться сервером, а его вывод будет возвращён клиенту. Файлы получают этот обработчик либо благодаря имени с расширением, определённым директивой AddHandler, либо благодаря расположению в каталоге ScriptAlias.

Для введения в использование CGI-скриптов с Apache, см. наш учебник по Динамичному содержимому с CGI.

При использовании многопоточного MPM под unix, вместо этого модуля следует использовать модуль mod_cgid. На уровне пользователя эти два модуля по существу идентичны.

Для обеспечения обратной совместимости, обработчик cgi-скрипта также будет активирован для любого файла с MIME-типом application/x-httpd-cgi. Использование магического MIME-типа устарело.

Переменные окружения CGI

Сервер будет устанавливать переменные окружения CGI, как описано в спецификации CGI, с учётом следующих положений:

PATH_INFO

Эта переменная недоступна, если директива AcceptPathInfo явно установлена в off. По умолчанию, если AcceptPathInfo не задана, mod_cgi будет принимать информацию о пути (прилагаемое /more/path/info после имени файла скрипта в URI), в то время как ядро сервера вернёт ошибку 404 NOT FOUND для запросов с дополнительной информацией о пути. Пропуск директивы AcceptPathInfo имеет тот же эффект, что и её установка в значение On для запросов mod_cgi.

REMOTE_HOST

Эта переменная будет установлена только если HostnameLookups установлена в on (по умолчанию выключена), и если обратный поиск DNS по адресу хоста, который обращается, найдёт имя хоста.

REMOTE_IDENT

Эта переменная будет установлена только если IdentityCheck установлена в on и обращающийся хост поддерживает протокол ident. Обратите внимание, что содержимое этой переменной нельзя гарантированно использовать, так как оно может легко быть подделано, а если между клиентом и сервером находится прокси-сервер, оно обычно совершенно бесполезно.

REMOTE_USER

Эта переменная будет установлена только если CGI-скрипт подвержен аутентификации.

Этот модуль также использует основные функции ap_add_common_vars и ap_add_cgi_vars для добавления переменных окружения, таких как:

DOCUMENT_ROOT

Установлена значением, указанным в соответствующей директиве DocumentRoot.

SERVER_NAME

Полное доменное имя, связанное с запросом.

SERVER_ADDR

IP-адрес виртуального хоста, обслуживающего запрос.

SERVER_ADMIN

Установлена значением, указанным в соответствующей директиве ServerAdmin.

Для получения полного списка рекомендуется написать базовый CGI-скрипт, который выводит все переменные окружения, переданные Apache, в удобном формате.

Отладка CGI-скриптов

Отладка CGI-скриптов традиционно была сложной задачей, главным образом потому, что не было возможности изучить вывод (стандартный вывод и вывод ошибок) для скриптов, которые не запускаются должным образом. Эти директивы обеспечивают более подробную запись ошибок при их возникновении.

Формат файла журнала CGI

При настройке файл журнала ошибок CGI записывает все CGI-скрипты, которые не выполняются корректно. Каждый CGI-скрипт, который не работает правильно, приводит к записи нескольких строк информации в журнал. Первые две строки всегда имеют следующий формат:

%% [time] request-line
%% HTTP-status CGI-script-filename

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

%%error
error-message

В противном случае, если ошибка вызвана тем, что скрипт возвращает неправильную информацию заголовка (часто из-за ошибки в скрипте), регистрируется следующая информация:

%request
All HTTP request headers received
POST or PUT entity (if any)
%response
All headers output by the CGI script
%stdout
CGI standard output
%stderr
CGI standard error

(Части %stdout и %stderr могут отсутствовать, если скрипт не выводил ничего в стандартный вывод или стандартный поток ошибок).

ScriptLog file-path

ScriptLog logs/cgi_log

ScriptLogBuffer bytes

ScriptLogBuffer 1024

ScriptLogLength bytes

ScriptLogLength 10385760