CGI - Общий Интерфейс ШлюзовCGI -- Common Gateway Interface является стандартом интерфейса внешней прикладной программы с информационным сервером типа HTTP -- WWW.
Обычно гипертекстовые документы, написанные на языке HTML, представляемые на WWW сервере, содержат статические данные. С помощью CGI можно создавать CGI-программы, называемые шлюзами или скриптами (CGI Script), которые во взаимодействии с такими прикладными системами, как система управления базой данных, электронная таблица, деловая графика и др., смогут выдать на экран пользователя динамическую информацию.
Программа-шлюз запускается WWW сервером в реальном масштабе времени. WWW сервер обеспечивает передачу запроса пользователя шлюзу, а она в свою очередь, используя средства прикладной системы, возвращает результат обработки запроса на экран пользователя. Программа-шлюз (CGI Script) может быть написана на языках:
Как выполняемый модуль, такая программа как правило помещается в поддиректорию с именем cgi-bin WWW сервера. В принципе она может быть помещена в любую другую директорию, в которой разрешено выполнение исполняемых модулей.
Оригинал описания CGI -- интерфейса между CGI-Script и WWW сервером находится по адресу http://hoohoo.ncsa.uiuc.edu/cgi/.
Для передачи данных об информационном запросе от сервера к программе CGI Script, сервер использует командную строку и переменные окружения. Переменные окружения устанавливаются в тот момент, когда сервер выполняет программу CGI Script.
Информация программе CGI Script передается в следующей форме:
имя=значение&имя1=значение1&.., |
где имя -- имя переменной (для команды FORM, например), и значение -- ее реальное значение. В зависимости от метода, который используется для запроса, эта строка появляется или как часть URL (в случае метода GET), или как содержимое HTTP запроса (метод POST). В последнем случае, эта информация будет послана программе на стандартный ввод.
На файловый дескриптор стандартного потока ввода посылается CONTENT_LENGTH байт. Так же сервер передает шлюзу CONTENT_TYPE (тип передаваемых данных). Сервер не обязан посылать символ конца файла после отсылки CONTENT_LENGTH байт данных и после того, как шлюз их прочитает.
Возьмем результат работы формы с методом POST (METHOD="POST") в качестве примера.
Пусть получено 7 байт, закодированных примерно так:
a=b&b=c |
CONTENT_LENGTH=7 CONTENT_TYPE=application/x-www-form-urlencoded.Первым символом в стандартном потоке ввода для программы CGI Script будет "a", за которым будет следовать остаток закодированной строки.
Программа CGI Script в командной строке от сервера получает:
Ключевые слова, имена полей формы и значения передаются раскодированными (HTTP -- URL формат кодирования) и перекодированными в соответствии с правилами кодирования Bourne shell, так что программа в командной строке получит информацию в том виде, как она есть, без необходимости осуществлять дополнительные преобразования.
Запросы команды FORM обрабатываются таким образом, что каждый параметр, отвечающий за имя поля, оканчивается знаком равенства, а остаток представляет собой значение этого параметра. Если присутствует что либо после имени программы, то эта информация передается в качестве первого параметра, иначе первый параметр будет пуст.
/test-cgi.sh/foo/x/y/z?name1=value1&name2=value2 |
вызывается как:
/.../foo /x/y/z name1=value1 name2=value2 |
http://www.ict.nsc.ru/cgi-bin/test-cgi.sh/foo/x/y/z?name1=value1&name2=value2
/test-cgi.sh/foo?name1=value1&name2=value2 |
вызывается как:
/.../foo name1=value1 name2=value2 |
http://www.ict.nsc.ru/cgi-bin/test-cgi.sh/foo?name1=value1&name2=value2
Следующие переменные окружения не являются специфичными по типу запросов и устанавливаются для всех запросов.
Следующие переменные окружения являются специфичными для разных запросов, и заполняются перед вызовом программы CGI Script:
В дополнение к этим, если запрос содержит дополнительные поля в заголовке запроса, они помещаются в переменные окружения с префиксом HTTP_, за которым следует имя заголовка запроса. Любые символы '-' в заголовке запроса меняются на символы подчеркивания '_' в переменных окружения. Сервер может исключить любые заголовки, которые он уже обработал, такие как Authorization, Content-type, и Content-length. Если необходимо, сервер может исключить любые (или вообще все) дополнительные поля заголовка в случае, когда их включение может привести к превышению предела размера переменных окружения. Примером такой переменной может служить переменная HTTP_ACCEPT, которая была определена в спецификации CGI/1.0. Другим примером может служить заголовок User-Agent.
Программа CGI Script осуществляет свой вывод на стандартный вывод системы. Этот вывод может представлять собой или документ, сгенерированный программой, или инструкции серверу, где получить необходимый документ.
Как правило, программа производит свой вывод, который интерпретируется и посылается обратно клиенту. Преимущество этого подхода состоит в том, что программа не должна посылать полный HTTP/1.0 заголовок на каждый запрос.
Для некоторых программ может быть необходимо избегать обработки сервером их вывода, и общаться с клиентом непосредственно. Для того, чтобы отличить такие программы от остальных, CGI требует, чтобы их имена начинались с префикса nph-. В этом случае, на программе лежит ответственность за возвращение клиенту синтаксически правильного ответа.
Заголовки с синтаксическим разбором
Вывод программы начинается с маленького заголовка. Он содержит текстовые строки, в том же формате, как и в HTTP заголовке и завершается пустой строкой (содержащей только символ перевода строки или [CR/LF]).
Любые строки заголовка, не являющиеся директивами сервера, посылаются непосредственно клиенту. В настоящий момент, CGI спецификация определяет три директивы сервера:
Если аргументом является URL, то сервер передаст клиенту указание на перенаправление запроса. Если аргумент представляет собой виртуальный путь, сервер вернет клиенту заданный этим путем документ, как если бы клиент запрашивал его непосредственно.
--- начало вывода --- Content-type: text/html --- вывод --- --- конец вывода ---
--- начало вывода --- Location: /path/doc.txt --- конец вывода ---
--- начало вывода --- Location: gopher://gopher.ncsa.uiuc.edu/ --- конец вывода ---
Рассмотрим CGI программу, которая общается с клиентом непосредственно. Как уже отмечалось, ее имя должно начинаться с префикса nph- и она должна возвращать клиенту допустимый HTTP заголовок. В этом случае, если доступ к шлюзу был осуществлен со значением SERVER_PROTOCOL равным HTTP/1.0, его вывод должен удовлетворять HTTP/1.0:
--- начало вывода --- HTTP/1.0 200 OK Server: NCSA/1.0a6 Content-type: text/plain --- конец вывода ---
Пример полного задания Заголовка протокола HTTP/1.0:
--- начало вывода --- HTTP/1.0 200 OK Date: Tuesday, 26-Dec-95 15:17:10 GMT Server: NCSA/1.3 MIME-version: 1.0 Content-type: text/html Last-modified: Tuesday, 24-Dec-95 15:15:41 GMT Content-length: 3132 --- Здесь находится документ, подготовленный для клиента --- --- конец вывода ---Замечание: в качесве значений типа протокола и программного обеспечения сервера можно подставить соответствующие значения переменных окружения:
$SERVER_PROTOCOL $SERVER_SOFTWARE
Пример
-------------
Last-Modified: Tue, 15 Nov 1994 12:45:26 GMT
---------------
В качестве примера использавния CGI см. Perl Scrint обработки ошибок сервера, с узла NCSA.