Difference between revisions of "fcl-web"

From Lazarus wiki
(Using fpWeb together with Lazarus)
(Reading GET fields)
Line 84: Line 84:
 
If you place an executable called "mywebpage.cgi" in this directory, then the page can be accessed as http://localhost/cgi-bin/mywebpage.cgi or with the corresponding domain name if accessed remotely.
 
If you place an executable called "mywebpage.cgi" in this directory, then the page can be accessed as http://localhost/cgi-bin/mywebpage.cgi or with the corresponding domain name if accessed remotely.
  
===Reading GET fields===
+
 
 +
===Formating the HTML and Reading GET fields===
 +
 
 +
To extend the previous example which just shows a plain HTML page without modification, one might wish to change the HTML page and to read the variables passed to the webpage by GET or POST fields. A simple solution for the first problem is simply using the standard Pascal routine Format and add %s or %d in the HTML file in the appropriate places which will receive a custom value.
 +
 
 +
To read the GET variables one can use ARequest.QueryFields, which is a TStrings descendent. Each variable will be in a separate line in the TStrings in the format variablename=value, similarly to how they are shown in the browser page address. To search for a specific variable one can use ARequest.QueryFields.Values[], passing the variable name in the brackets to receive it's value back, instead of parsing the string manually. This can be seen in the example bellow:
 +
 
 +
<delphi>
 +
procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;
 +
  AResponse: TResponse; var Handled: Boolean);
 +
var
 +
  HexText, AsciiText: string;
 +
begin
 +
  HexText := ARequest.QueryFields.Values['hex'];
 +
  AsciiText := HexToAnsii(HexText);
 +
 
 +
  AResponse.ContentType := 'text/html;charset=utf-8';
 +
  AResponse.Contents.LoadFromFile(ExtractFilePath(ParamStr(0)) + 'mainpage.html');
 +
  AResponse.Contents.Text := Format(AResponse.Contents.Text,
 +
    [HexText, AsciiText]);
 +
  Handled := True;
 +
end;
 +
</delphi>
  
 
== Notes ==
 
== Notes ==

Revision as of 12:05, 14 July 2010

Template:Web and Networking Programming

Using fpWeb together with Lazarus

Installing the fpWeb Lazarus Package

The first step to do is installing the package which comes in the path lazarus/components/fpweb/weblaz.lpg

Creating a cgi application

After the weblaz package is installed, a very simple cgi web application which displays an html page can be created by going to the Lazarus menu "File->New...". From the list of possible applications select "CGI Application" as in the image bellow, which will create a main cgi project file and a fpweb web module.

New cgi.PNG

To add code to show the page a request handler should be added, by double clicking the OnRequest property in the object inspector, as in the image bellow:

Webmodule.PNG

In the event handler one should write the html code which will be displayed by the browser. To avoid mixing Pascal and HTML, this page can be loaded from the same directory of the cgi executable by using AResponse.Contents.LoadFromFile(). The type of the response should be set in AResponse.ContentType and for html pages it will have the value 'text/html;charset=utf-8'. In the end Handled should be set to True to indicate that the request was successfully handled. After adding this code, the web module should look like this:

<delphi> unit mainpage;

{$mode objfpc}{$H+}

interface

uses

 Classes, SysUtils, FileUtil, HTTPDefs, websession, fpHTTP, fpWeb; 

type

 { TFPWebModule1 }
 TFPWebModule1 = class(TFPWebModule)
   procedure DataModuleRequest(Sender: TObject; ARequest: TRequest;
     AResponse: TResponse; var Handled: Boolean);
 private
   { private declarations }
 public
   { public declarations }
 end; 

var

 FPWebModule1: TFPWebModule1; 

implementation

{$R *.lfm}

{ TFPWebModule1 }

procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;

 AResponse: TResponse; var Handled: Boolean);

begin

 AResponse.ContentType := 'text/html;charset=utf-8';
 AResponse.Contents.LoadFromFile(ExtractFilePath(ParamStr(0)) + 'mainpage.html');
 Handled := True;

end;

begin

 RegisterHTTPModule('TFPWebModule1', TFPWebModule1);

end. </delphi>

Deploying this very simple application

Apache, the most popular web server, can be downloaded here: [1]

The default installation of Apache will thread all files located in it's cgi-bin directory as CGI Programs, so the user won't be able to access plain html files placed there. This directory can be set in the file httpd.conf in the following section:

   #
   # ScriptAlias: This controls which directories contain server scripts.
   # ScriptAliases are essentially the same as Aliases, except that
   # documents in the target directory are treated as applications and
   # run by the server when requested rather than as documents sent to the
   # client.  The same rules about trailing "/" apply to ScriptAlias
   # directives as to Alias.
   #
   ScriptAlias /cgi-bin/ "C:/Program Files/Apache Software Foundation/Apache2.2/cgi-bin/"

If you place an executable called "mywebpage.cgi" in this directory, then the page can be accessed as http://localhost/cgi-bin/mywebpage.cgi or with the corresponding domain name if accessed remotely.


Formating the HTML and Reading GET fields

To extend the previous example which just shows a plain HTML page without modification, one might wish to change the HTML page and to read the variables passed to the webpage by GET or POST fields. A simple solution for the first problem is simply using the standard Pascal routine Format and add %s or %d in the HTML file in the appropriate places which will receive a custom value.

To read the GET variables one can use ARequest.QueryFields, which is a TStrings descendent. Each variable will be in a separate line in the TStrings in the format variablename=value, similarly to how they are shown in the browser page address. To search for a specific variable one can use ARequest.QueryFields.Values[], passing the variable name in the brackets to receive it's value back, instead of parsing the string manually. This can be seen in the example bellow:

<delphi> procedure TFPWebModule1.DataModuleRequest(Sender: TObject; ARequest: TRequest;

 AResponse: TResponse; var Handled: Boolean);

var

 HexText, AsciiText: string;

begin

 HexText := ARequest.QueryFields.Values['hex'];
 AsciiText := HexToAnsii(HexText);
 AResponse.ContentType := 'text/html;charset=utf-8';
 AResponse.Contents.LoadFromFile(ExtractFilePath(ParamStr(0)) + 'mainpage.html');
 AResponse.Contents.Text := Format(AResponse.Contents.Text,
   [HexText, AsciiText]);
 Handled := True;

end; </delphi>

Notes

The cgiapp unit is deprecated, please use fpcgi as much as possible.

The fastcgi, custfcgi, and fpfcgi units are not supported on Darwin at this time, because it uses a different mechanism than the MSG_NOSIGNAL option for recv() to indicate that no SIGPIPE should be raised in case the connection breaks. See http://lists.apple.com/archives/macnetworkprog/2002/Dec/msg00091.html for how this should be fixed.