Программирование CGI на Perl


Что такое CGI

В настоящее время CGI поддерживается NCSA. NCSA определяет CGI следующим образом:

CGI (Common Gateway Interface), общий интерфейс шлюза, — это программа, которая работает на сервере, таком как HTTP-сервер, и предоставляет интерфейс для клиентских HTML-страниц.


Просмотр веб-страниц

Чтобы лучше понять, как работает CGI, мы можем начать с процесса щелчка по ссылке или URL на веб-странице:

  • 1. Используйте браузер, чтобы открыть URL и подключиться к веб-серверу HTTP.
  • 2. После получения запроса веб-сервер разбирает URL и проверяет, существует ли запрошенный файл на сервере. Если он существует, возвращается содержимое файла; в противном случае возвращается сообщение об ошибке.
  • 3. Браузер получает информацию от сервера и отображает полученный файл или сообщение об ошибке.

Программы CGI могут быть скриптами Python, скриптами Perl, Shell-скриптами, программами на C или C++ и т. д.


Схема архитектуры CGI

cgiarch


Поддержка и настройка веб-сервера

Прежде чем начать программирование CGI, убедитесь, что ваш веб-сервер поддерживает CGI и что обработчик CGI настроен.

Настройка CGI в Apache:

Настройте каталог CGI:

ScriptAlias /cgi-bin/ /var/www/cgi-bin/

Все CGI-программы, выполняемые HTTP-серверами, хранятся в предварительно настроенном каталоге. Этот каталог называется каталогом CGI, и по соглашению он имеет имя /var/www/cgi-bin.

Файлы CGI имеют расширение .cgi. Perl также может использовать расширение .pl.

По умолчанию серверы Linux настроены так, что /var/www используется как каталог cgi-bin для запуска CGI-скриптов.

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

<Directory "/var/www/cgi-bin">
   AllowOverride None
   Options +ExecCGI
   Order allow,deny
   Allow from all
</Directory>

Добавьте суффикс .pl в AddHandler, чтобы мы могли получать доступ к файлам скриптов Perl, оканчивающимся на .pl:

AddHandler cgi-script .cgi .pl .py

Первая CGI-программа

Ниже мы создаем файл test.cgi со следующим кодом:

Код test.cgi

#!/usr/bin/perl print "Content-type:text/html\r\n\r\n"; print '<html>'; print '<head>'; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print '</head>'; print '<body>'; print '<h2>Hello Word! </h2>'; print '<p>This is the first CGI program from Example Tutorial.</p>'; print '</body>'; print '</html>'; 1;

Затем откройте http://localhost/cgi-bin/test.cgi в браузере, и вывод будет следующим:

Вывод 'Content-type:text/html\r\n\r\n' в первой строке скрипта отправляется в браузер, чтобы сообщить браузеру, что тип содержимого для отображения — 'text/html'.


HTTP-заголовок

Строка 'Content-type:text/html' в содержимом файла test.cgi является частью HTTP-заголовка. Она отправляется браузеру, чтобы сообщить ему тип содержимого файла.

Формат HTTP-заголовка следующий:

HTTP 字段名: 字段内容

Например:

Content-type:text/html\r\n\r\n

В следующей таблице описана информация, часто используемая в HTTP-заголовках в CGI-программах:

headОписание
Content-type: MIME-информация, соответствующая запрошенной сущности. Например: Content-type:text/html
Expires: Дата Дата и время истечения срока действия ответа
Location: URL Используется для перенаправления получателя на местоположение, отличное от запрошенного URL, для завершения запроса или идентификации нового ресурса
Last-modified: ДатаВремя последнего изменения запрошенного ресурса
Content-length: NДлина содержимого запроса
Set-Cookie: Строка Установка HTTP Cookie

Переменные среды CGI

Все CGI-программы получают следующие переменные среды, которые играют важную роль в CGI-программах:

Имя переменнойОписание
CONTENT_TYPEЗначение этой переменной среды указывает MIME-тип передаваемой информации. В настоящее время переменная среды CONTENT_TYPE обычно имеет значение: application/x-www-form-urlencoded, что указывает на то, что данные поступают из HTML-формы.
CONTENT_LENGTHЕсли метод передачи между сервером и CGI-программой — POST, эта переменная окружения содержит количество допустимых байтов данных, которые можно прочитать из стандартного ввода STDIN. Эту переменную окружения необходимо использовать при чтении входных данных.
HTTP_COOKIEСодержимое COOKIE на стороне клиента.
HTTP_USER_AGENTПредоставляет информацию о браузере клиента, содержащую номера версий или другие проприетарные данные.
PATH_INFOЗначение этой переменной окружения представляет дополнительную информацию о пути, сразу следующую за именем CGI-программы. Часто она выступает в качестве параметра CGI-программы.
QUERY_STRINGЕсли метод передачи между сервером и CGI-программой — GET, значение этой переменной окружения представляет собой переданную информацию. Эта информация следует за именем CGI-программы и отделяется знаком вопроса '?'.
REMOTE_ADDRЗначение этой переменной окружения — IP-адрес клиента, выполняющего запрос, например 192.168.1.67 выше. Это значение присутствует всегда. Оно также является уникальным идентификатором, который веб-клиент должен предоставить веб-серверу, и может использоваться в CGI-программах для различения разных веб-клиентов.
REMOTE_HOSTЗначение этой переменной окружения содержит имя хоста клиента, отправившего CGI-запрос. Если сервер не поддерживает нужный вам поиск, эта переменная окружения может быть не определена.
REQUEST_METHODПредоставляет метод, с помощью которого был вызван сценарий. Для сценариев, использующих протокол HTTP/1.0, имеют смысл только GET и POST.
SCRIPT_FILENAMEПолный путь к CGI-сценарию
SCRIPT_NAMEИмя CGI-сценария
SERVER_NAMEЭто имя хоста, псевдоним или IP-адрес вашего веб-сервера.
SERVER_SOFTWAREЗначение этой переменной окружения содержит имя и номер версии HTTP-сервера, который вызвал CGI-программу. Например, приведённое выше значение — Apache/2.2.14(Unix).

Ниже приведён простой CGI-скрипт, который выводит переменные среды CGI:

Пример

#!/usr/bin/perl print "Content-type: text/html\n\n"; print '<meta charset="utf-8">'; print "<font size=+1>Переменные среды:</font>\n"; foreach (sort keys %ENV) { print "<b>$_</b>: $ENV{$_}<br>\n"; } 1;

Скачивание файла

Если мы хотим реализовать скачивание файла через Perl CGI, нам нужно задать разные заголовки, как показано ниже:

Пример

#!/usr/bin/perl # HTTP-заголовок print "Content-Type:application/octet-stream; name="\"FileName\"\r\n"; print "Content-Disposition: attachment; filename="\"FileName\"\r\n\n"; # Фактическое содержимое файла будет здесь. open( FILE, "<FileName" ); while(read(FILE, $buffer, 100) ) { print("$buffer"); }

Использование метода GET для передачи данных

Метод GET отправляет закодированную информацию пользователя на сервер. Данные включаются в URL запрашиваемой страницы и отделяются знаком '?', как показано ниже:

http://www.test.com/cgi-bin/test.cgi?key1=value1&key2=value2
Некоторые другие замечания о GET-запросах:
  • GET-запросы могут кэшироваться
  • GET-запросы остаются в истории браузера
  • GET-запросы можно добавлять в закладки
  • GET-запросы не следует использовать при обработке конфиденциальных данных
  • GET-запросы имеют ограничение длины
  • GET-запросы следует использовать только для получения данных

Простой пример URL: метод GET

Ниже приведён простой URL, который отправляет два параметра программе test.cgi с использованием метода GET:

/cgi-bin/test.cgi?name=Example&url=http://www.example.com

Ниже приведён код для файла test.cgi:

Пример

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение текстовой информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "GET") { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Просмотрите в браузере, вывод будет следующим:

Простой пример формы: метод GET

Ниже представлена HTML-форма, которая использует метод GET для отправки двух элементов данных на сервер. Серверный скрипт, на который выполняется отправка, также является файлом test.cgi. Код файла test.html выглядит следующим образом:

Код файла test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="get">Название сайта:<input type="text" name="name"> <br />URL сайта:<input type="text" name="url" /> <input type="submit" value="Отправить" /> </form> </body> </html>

В браузере результат выполнения следующий:


Использование метода POST для передачи данных

Использование метода POST для передачи данных на сервер безопаснее и надёжнее. Конфиденциальную информацию, такую как пароли пользователей, необходимо передавать с помощью POST.

Ниже также приведён test.cgi; он также может обрабатывать данные POST-формы, отправленные браузером:

Код test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение текстовой информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $name = $FORM{name}; $url = $FORM{url}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print "</head>"; print "<body>"; print "<h2>$nameURL:$url</h2>"; print "</body>"; print "</html>"; 1;

Ниже представлена HTML-форма, которая использует метод GET для отправки двух элементов данных на сервер. Серверный скрипт, на который выполняется отправка, также является файлом test.cgi. Код файла test.html выглядит следующим образом:

Код test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post">Имя сайта:<input type="text" name="name"> <br />URL сайта:<input type="text" name="url" /> <input type="submit" value="Отправить" /> </form> </body> </html>

В браузере результат выполнения следующий:

Передача данных флажка через CGI-программу

Флажок используется для отправки данных одной или нескольких опций. Код test.html выглядит следующим образом:

Код test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="POST" target="_blank"> <input type="checkbox" name="example" value="on" />Пример руководства<input type="checkbox" name="google" value="on" /> Google <input type="submit" value="Выберите сайт" /> </form> </body> </html>

Ниже приведён код файла test.cgi:

Код test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } if( $FORM{example} ){ $example_flag ="ON"; }else{ $example_flag ="OFF"; } if( $FORM{google} ){ $google_flag ="ON"; }else{ $google_flag ="OFF"; } print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Статус выбора учебного примера :$example_flag</h2>"; print "<h2> Статус выбора Google :$google_flag</h2>"; print "</body>"; print "</html>"; 1;

В браузере результат выполнения следующий:


Передача данных радиокнопки через CGI-программу

Радиокнопка отправляет на сервер только один элемент данных. Код test.html выглядит следующим образом:

Код test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <input type="radio" name="site" value="example" />Пример руководства<input type="radio" name="site" value="google" /> Google <input type="submit" value="Отправить" /> </form> </body> </html>

Код скрипта test.cgi выглядит так:

Код test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{site}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Выбранный веб-сайт$site</h2>"; print "</body>"; print "</html>"; 1;

В браузере результат выполнения следующий:


Передача данных Textarea через CGI-программу

Textarea отправляет несколько строк данных на сервер. Код test.html выглядит так:

Код test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <textarea name="textcontent" cols="40" rows="4">Введите содержимое здесь...</textarea> <input type="submit" value="Отправить" /> </form> </body> </html>

Код скрипта test.cgi выглядит так:

Код test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $text_content = $FORM{textcontent}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Пример руководства (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Введённое текстовое содержимое:$text_content</h2>"; print "</body>"; print "</html>"; 1;

В браузере результат выполнения следующий:


Передача данных выпадающего списка через CGI-программу

Код HTML-поля выпадающего списка выглядит следующим образом:

Код test.html

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Пример руководства (example.com)</title> </head> <body> <form action="/cgi-bin/test.cgi" method="post" target="_blank"> <select name="dropdown"> <option value="example" selected>Пример руководства</option> <option value="google">Google</option> </select> <input type="submit" value="Отправить"/> </form> </body> </html>

Код скрипта test.cgi выглядит так:

Код test.cgi

#!/usr/bin/perl local ($buffer, @pairs, $pair, $name, $value, %FORM); # Чтение информации $ENV{'REQUEST_METHOD'} =~ tr/a-z/A-Z/; if ($ENV{'REQUEST_METHOD'} eq "POST") { read(STDIN, $buffer, $ENV{'CONTENT_LENGTH'}); }else { $buffer = $ENV{'QUERY_STRING'}; } # Чтение информации о парах имя/значение @pairs = split(/&/, $buffer); foreach $pair (@pairs) { ($name, $value) = split(/=/, $pair); $value =~ tr/+/ /; $value =~ s/%(..)/pack("C", hex($1))/eg; $FORM{$name} = $value; } $site = $FORM{dropdown}; print "Content-type:text/html\r\n\r\n"; print "<html>"; print "<head>"; print '<meta charset="utf-8">'; print '<title>Example Tutorial (example.com)</title>'; print "</head>"; print "<body>"; print "<h2> Выбранный сайт:$site</h2>"; print "</body>"; print "</html>"; 1;

В браузере результат выполнения следующий:


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

Существенный недостаток протокола HTTP заключается в том, что он не определяет личность пользователя, что создаёт большие неудобства для программистов. Появление функциональности куки восполняет этот недостаток.

Куки — это когда клиент посещает скрипт и через браузер клиента данные записываются на жёсткий диск клиента. Когда клиент в следующий раз обращается к скрипту, извлекается информация, содержащаяся в этих данных, тем самым достигается функция определения личности. Куки обычно используются для проверки подлинности.

 

Синтаксис куки

HTTP-куки отправляются через HTTP-заголовок, что происходит до передачи файла. Синтаксис заголовка Set-Cookie выглядит следующим образом:

Set-cookie:name=name;expires=date;path=path;domain=domain;secure 
  • name=name:Необходимо задать значение куки (в name нельзя использовать ";",символ), когда есть несколько значений name, используйте ";" для разделения, например:name1=name1;name2=name2;name3=name3。
  • expires=date:Срок действия куки, формат: expires="Wdy,DD-Mon-YYYY HH:MM:SS"
  • path=path: Задаёт путь, поддерживаемый куки. Если path — это путь, куки действует для всех файлов и подкаталогов в этом каталоге, например: path="/cgi-bin/". Если path — это файл, куки действует только для этого файла, например: path="/cgi-bin/cookie.cgi".
  • domain=domain:Доменное имя, для которого действует куки, например: domain="www.example.com"
  • secure:Если указан этот флаг, это означает, что куки могут передаваться только через HTTPS-сервер с использованием протокола SSL.
  • Приём куки реализуется путём установки переменной среды HTTP_COOKIE. CGI-программы могут получать информацию о куки, запрашивая эту переменную.

Установка куки

Установка куки очень проста; куки отправляются отдельно в HTTP-заголовке. В следующем примере в куки задаются UserID, Password и expires:

Пример

#!/usr/bin/perl print "Set-Cookie:UserID=XYZ;\n"; print "Set-Cookie:Password=XYZ123;\n"; print "Set-Cookie:Expires=Tuesday, 31-Dec-2017 23:12:40 GMT";\n"; print "Set-Cookie:Domain=www.example.com;\n"; print "Set-Cookie:Path=/perl;\n"; print "Content-type:text/html\r\n\r\n"; ...........остальное HTML-содержимое

Извлечение cookie

Страница извлечения информации о cookie очень проста. Информация о cookie хранится в переменной окружения CGI HTTP_COOKIE в следующем формате:

Пример

#!/usr/bin/perl $rcvd_cookies = $ENV{'HTTP_COOKIE'}; @cookies = split /;/, $rcvd_cookies; foreach $cookie ( @cookies ){ ($key, $val) = split(/=/, $cookie); # разбивает по первому =. $key =~ s/^\s+//; $val =~ s/^\s+//; $key =~ s/\s+$//; $val =~ s/\s+$//; if( $key eq "UserID" ){ $user_id = $val; }elsif($key eq "Password"){ $password = $val; } } print "ID пользователя = $user_id\n"; print "Пароль = $password\n";

Результат вывода приведённого выше примера:

User ID = XYZ
Password = XYZ123

Модуль CGI

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

Другие расширения