CGI

Аббревиатура означает Common Gateway Interface, и является связевым протоколом между формой в Web браузере (клиент) и приложением запущенным на Web сервере (сервер). Приложение обычно называется скрипт, но мы можем использовать Дельфи для написания приложений без скриптов. Имеется два типа : стандартное или консольное приложение и позже появилась версия для Windows называемая Win. 1.3.1. Консольное приложение Стандартное или консольное приложение взаимодействует с формой на клиенте с помощью переменных среды (управляющая информация), стандартным входом (данные формы) и стандартным выводом (возвращаемая динамическая HTML страница). 1.3.2. Win Приложение Win взаимодействует с формой на клиенте с помощью Windows .INI файла вместо переменных среды. Windows .INI файл содержит управляющую информацию, иногда данные формы и имена входного, данных и выходного файлов. 1.3.3. Delphi и В данной главе я расскажу, как написать простое Дельфи приложение, без использования Web Modules или других Client/Server модулей. Во первых аббревиатура означает Common Gateway Interface, и это только имя для передачи информации от клиента серверу. На клиентской стороне это реализуется с помощью формы, содержащей только теги. На серверной стороне На сервере запускается приложение, которое иногда называется скрипт (для примера на Unix машинах, где Perl используется для исполнения скриптов). В данной главе я сконцентрирую внимание на написание приложения для Windows NT web сервера, и использовании 32-битной Дельфи (например Delphi 2.x или 3.x) для данной задачи, данный код может быть также без проблем откомпилирован в C++Builder. Стандартное приложение получает данные через стандартный вход и должно выдать ответ через стандартный вывод. (например сгенерированную HTML страницу). Это означает необходимость написания консольного приложения. Если даже нет входных данных мы все равно можем использовать приложение для генерации динамических HTML страниц (например для выдачи данных их таблицы). 1.3.4. Динамический вывод Для начала посмотрим на стандартное "hello world" приложение. Единственное, что оно должно сделать, это вернуть HTML страницу со строкой "hello, world". Перед тем как мы начнем делать это - обратим внимание на следующее: приложение должно сообщить миру какой (MIME) формат оно выдает. В нашем случае это "text/html", которое мы должны указать как: content-type: text/html, и затем одну пустую строку. Вот код нашего первого "Hello, world!" приложения:

program 1;
 {$APPTYPE CONSOLE}
 begin
  writeln('content-type: text/html');
  writeln;
  writeln('<HTML');
  writeln('<BODY');
  writeln('Hello, world!');
  writeln('</BODY');
  writeln('</HTML')
 end.

Если вы откомпилируете данную программу в Дельфи 2 или 3 и затем запустите ее из web браузера подключенного к web серверу, где оно записано в исполнимом виде в исполняемом каталоге таком как cgi-bin, то вы увидите текст "Hello, world!" на странице.
1.3.5. ввод
Теперь, мы знаем как создавать приложение, которое может генерировать динамическую HTML страницу (или в действительности почти статическую). Но как насчет ввода? Здесь более чем одно действие: мы должны проверять переменную DOS 'CONTENT LENGTH' что бы знать как много символов мы можем прочитать со стандартного ввода (если мы попытаемся читать больше чем есть, то мы повиснем навсегда). Конечно, это широко известный факт. Я написал компонент TBDosEnvironment чтобы вы могли иметь доступ до переменных среды DOS:

unit DrBobDOS;

 interface

 uses

  SysUtils, WinTypes, WinProcs, Classes;

 type

  TBDosEnvironment = class(TComponent)

  public

  { Public class declarations (override) }

  constructor Create(AOwner: TComponent); override;

  destructor Destroy; override;

  private

  { Private field declarations }

  FDosEnvList: TStringList;

  procedure DoNothing(const Value: TStringList);

  protected

  { Protected method declarations }

  Dummy: Word;

  function GetDosEnvCount: Word;

  public

  { Public interface declarations }

  function GetDosEnvStr(const Name: String): String;

  { This function is a modified version of the GetEnvVar function that appears in the WinDos unit that comes with Delphi. This function's interface uses Pascal strings instead of null-terminated strings.

  }


  published

  { Published design declarations }

  property DosEnvCount: Word read GetDosEnvCount write Dummy;

  property DosEnvList: TStringList read FDosEnvList write DoNothing;

  end;

 implementation

  constructor TBDosEnvironment.Create(AOwner: TComponent);

  var

  P: PChar;

  begin

  inherited Create(AOwner);

  FDosEnvList := TStringList.Create;

  {$IFDEF WIN32}

  P := GetEnvironmentStrings;

  {$ELSE}

  P := GetDosEnvironment;

  {$ENDIF}

  while P^ <> #0 do

  begin

  FDosEnvList.Add(StrPas(P));

  Inc(P, StrLen(P)+1) { Fast Jump to  Var }

  end;

  end {Create};

  destructor TBDosEnvironment.Destroy;

  begin

  FDosEnvList.Free;

  FDosEnvList := nil;

  inherited Destroy

  end {Destroy};

  procedure TBDosEnvironment.DoNothing(const Value: StringList);

  begin

  end {DoNothing};

  function TBDosEnvironment.GetDosEnvCount: Word;

  begin

  if Assigned(FDosEnvList) then

  Result := FDosEnvList.Count

  else

  Result := 0;

  end {GetDosEnvCount};

  function TBDosEnvironment.GetDosEnvStr(const Name: String): String;

  var

  i: Integer;

  Tmp: String;

  begin

  i := 0;

  Result := '';

  if Assigned(FDosEnvList) then while i < FDosEnvList.Count do

  begin

  Tmp := FDosEnvList[i];

  Inc(i);

  if Pos(Name,Tmp) = 1 then

  begin

  Delete(Tmp,1,Length(Name));

  if Tmp[1] = '=' then

  begin

  Delete(Tmp,1,1);

  Result := Tmp;

  i := FDosEnvList.Count { end while-loop }

  end

  end

  end

  end {GetDosEnvStr};

 end.

Здесь список переменных среды (предоставленный Deepak Shenoy), которые доступны для программ. Даже ISAPI программы могут использовать эти переменные:
Environment Variable
Purpose/Meaning/Value
GATEWAY_INTERFACE 
Версия для которой скомпилирован web сервер
SERVER_NAME
IP адрес сервера или имя.
SERVER_PORT
Порт на сервер, которые принимает HTTP запросы.
SERVER_PROTOCOL
Имя и версия протокола, используемая для обработки запросов.
SERVER_SOFTWARE
Имя (и обычно версия) программного обеспечения сервера.
AUTH_TYPE
Схема проверки прав используемая сервером (NULL , BASIC)
CONTENT_FILE
Файл используемый для передачи данных программе (только Windows HTTPd/Win).
CONTENT_LENGTH
Количество байтов переданное на стандартный вход (STDIN) как содержимое POST запроса.
CONTENT_TYPE
Тип данных переданных на сервер.
OUTPUT_FILE
Имя файла для результата (только Windows HTTPd/Win).
PATH_INFO
Дополнительный, относительный путь переданный на сервер после имени скрипта, но до данных запроса.
PATH_TRANSLATED
Та же самая информация, но преобразованная из относительного пути в абсолютный.
QUERY_STRING
Данные переданные как часть URL, все после символа ? в URL.
REMOTE_ADDR
Адрес IP или имя сервера конечного пользователя.
REMOTE_USER
Имя пользователя, если используется схема проверки прав.
REQUEST_LINE
Полный HTTP запрос представляемый сервером (зависит от сервера).
REQUEST_METHOD
Указывает метод передачи данных, как часть URL (GET) или через стандартный ввод STDIN (POST).
SCRIPT_NAME
Имя запущенного скрипта.
Немного еще дополнительной, но важной информации. Немного об переменных среды, которые особо важны для обработки запроса, и небольшое описание по обработке стандартных приложений:
REQUEST_METHOD - указывает, как посланы данные, как POST или как GET метод.
QUERY_STRING - если используется GET
CONTENT_LENGTH - если мы используем POST, то мы должны прочитать "CONTENT_LENGTH" символов со стандартного ввода (которые оканчиваются "Query", подобно QUERY_STRING при использовании метода GET).
Во всех случаях стандартное приложение должно писать свой вывод на стандартный выход, если мы используем консольное приложение.
Теперь с помощью компонента TBDosEnvironment мы создадим приложение, которое примет все три переменных среды, описанных выше и получит необходимые данные. После этого мы напишем код генерирующий вывод.
Правда просто? Для другого очень маленького (39 Кб) стандартного приложения, проверьте Search Engine на моем web сайте. Краткий исходный код будет опубликован в одной из статей в The Delphi Magazine, но я могу сказать, что базовый протокол связи не более сложный, чем представленный здесь.
1.3.6. Input Queries
Сейчас мы попробуем прочитать запрос в стандартном приложении с помощью 32-битной версии Дельфи (Delphi 2.x или 3.x).
Обычно это двух ступенчатый процесс. Первый шаг создание HTML и специальный Form-тегов, второй шаг получение данных внутри приложения на сервере.
HTML форма определяется с помощью тегов

...
. Открывающий тег также содержит имя метода (GET or POST) и действие, которое является URLом приложения на web сервере. Например:
...
Данная HTML форма посылает свои данные методом POST на мой web сервер, и выполняет программу debug.exe (из каталога cgi-bin). В данный момент мы пока не знакомы с концепцией различий между методами POST и GET (Я всегда использую метод POST). Мы заметим, что здесь пока нет ничего что бы посылать на сервер методом POST, это позже. Мы должны указать поля ввода внутри формы. Для этого мы поместим некоторое количество наиболее стандартных Windows органов управления, все они предопределены, подобно editbox, memo, listbox, drop-down combobox, radiobuttons, checkboxes и конечно клавиши "action" (reset или submit).
Простой editbox это поля ввода типа "text", которое обязано иметь имя и необязательно размер и ширину в пикселях, и может иметь значение:

Результатом этой фразы будет нарисован editbox в котором можно ввести до восьми символов, и которое будет послано нашему приложению как "login=xxxxxxxx", где xxxxxxxx данные веденные на форме в окошке подобному этому
Стандартное приложение обязано проверить переменную среды REQUEST-METHOD для определения метода передачи данных. В случае POST, мы должны проверить CONTENT-LENGTH для определения количества символов, которые необходимо прочесть со стандартного ввода. Стандартный ввод содержит данные (такие как "login-xxxxxxxx") для нашего приложения.
Вместо написания сложного стартового кода для каждого приложения, я написал модуль DrBob для выполнения всех необходимых стартовых процедур и извлечения входных данных и доступных затем через вызов единственной функции, называемой "Value". Так для выше приведенного примера мы можем вызвать "Value('login')" для получения строки 'xxxxxxxx'.

unit DrBob;

 {$I-}

 interface

 var

  ContentLength: Integer = 0;

  function Value(const Field: ShortString): ShortString;

  { use this function to get the inputquery values }

 implementation

 uses

  SysUtils, Windows;

 var

  Data: String = '';

  function Value(const Field: ShortString): ShortString;

  var

  i: Integer;

  begin

  Result := '';

  i := Pos(Field+'=',Data);

  if i > 0 then

  begin

  Inc(i,Length(Field)+1);

  while Data[i] <> '&' do

  begin

  Result := Result + Data[i];

  Inc(i)

  end

  end

  end {Value};

 var

  P: PChar;

  i: Integer;

  Str: ShortString;

 type

  TRequestMethod = (Unknown,Get,Post);

 var

  RequestMethod: TRequestMethod = Unknown;

 initialization

  P := GetEnvironmentStrings;

  while P^ <> #0 do

  begin

  Str := StrPas(P);

  if Pos('REQUEST_METHOD=',Str) > 0 then

  begin

  Delete(Str,1,Pos('=',Str));

  if Str = 'POST' then RequestMethod := Post

  else

  if Str = 'GET' then RequestMethod := Get

  end;

  if Pos('CONTENT_LENGTH=',Str) = 1 then

  begin

  Delete(Str,1,Pos('=',Str));

  ContentLength := StrToInt(Str)

  end;

  if Pos('QUERY_STRING=',Str) > 0 then

  begin

  Delete(Str,1,Pos('=',Str));

  SetLength(Data,Length(Str)+1);

  Data := Str

  end;

  Inc(P, StrLen(P)+1)

  end;

  if RequestMethod = Post then

  begin

  SetLength(Data,ContentLength+1);

  for i:=1 to ContentLength do read(Data[i]);

  Data[ContentLength+1] := '&';

  { if IOResult <> 0 then { skip }

  end;

  i := 0;

  while i < Length(Data) do

  begin

  Inc(i);

  if Data[i] = '+' then Data[i] := ' ';

  if (Data[i] = '%') then { special code }

  begin

  Str := '$00';

  Str[2] := Data[i+1];

  Str[3] := Data[i+2];

  Delete(Data,i+1,2);

  Data[i] := Chr(StrToInt(Str))

  end

  end;

  if i > 0 then Data[i+1] := '&'

  else Data := '&'

 finalization

  Data := ''

 end.

Я написал кучу приложений за последний год и все они используют модуль DrBobю Теперь реальное пример: стандартное приложение - гостевая книга (guestbook), в которой запрашивается ваше имя и небольшой комментарий, написанное с помощью всего нескольких строк на Дельфи.
Вначале форма:


Dr.Bob's Guestbook


METHOD=POST>
Name:

Comments:
Проверка
Антиспам проверка
Image CAPTCHA
...