1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
Recursively embedded templates, example
===============================
Demonstrates how to recursively embed templates using template tags.
Note, that the only difference between CGI/FCGI and Apache module is in the
main project .lpr file and the web server (Apache) configuration.
=====================
1. Compiling
1.a; with FPC
1.b; with Lazarus
2. Setup
2.a; as CGI
2.b; as Apache module
2.c; as FCGI
=====================
1. Compiling:
-------------
We can either use FPC directly, or Lazarus to compile the CGI/FCGI/Apache
module application. The main project .lpr file, as well as the Lazarus .lpi is
in the cgi/fcgi/apache directories.
1.a; with FPC
-------------
Enter to the directory (cgi/fcgi/apache) that has the .lpr file you wish to
compile, and then execute the command
fpc -Fu../webmodule embedtemplates.lpr
The -Fu parameter shows FPC where to find the web module source code. All
three web applications share the same web module code.
1.b; with Lazarus
-----------------
It needs the WebLaz Package installed. Open the .lpi file from the chosen
application directory (cgi/fcgi/apache), and then
Run -> Build from the menu.
2. Setup:
---------
The application needs read access to the template file(s).
It is best to use full paths with the file names in the web module
(webmodule.pas), because Apache will probably look relative to the / (main
root) directory or main Apache directory and not relative to the application
file location.
ex: TMPTemplate.FileName := '/full/path/to/templates/'+TemplateFile+'.html';
2.a; as CGI
-----------
Usually it works if you put the templates next to the CGI executable file
under a /templates subdirectory.
(ex: ...cgi-bin/templates/maintemplate.html , etc.)
Adjust the file path in the web module (webmodule.pas) accordingly.
http://<WebServer>/cgi-bin/<CGIExecutableName>/func1call should start the
example if everything is set up properly, and the executable is copied into
the Apache cgi-bin directory with the template files under ./templates .
ex: http://127.0.0.1:8080/cgi-bin/embedtemplates.exe/func1call
If the calling URL looks too long, or you want to hide it a little bit more,
you can use a ScriptAlias in the Apache configuration file to make it shorter.
ex: ScriptAlias /mycgi "<path_to_cgi_app>/embedtemplates.exe" in your conf
file will make http://127.0.0.1:8080/mycgi/func1call work the same way.
Note: You need to change the URLs if "cgi-bin" or "embedtemplates.exe"
changes (for example on Linux it is not embedtemplates.exe).
Also, if your server is listening on port 80 instead of 8080, you can leave
the :8080 part from the calling URL.
2.b; as Apache module
---------------------
Usually it works if you put the templates into the Apache main directory (not
the DocumentRoot, but the main Apache directory).
(.../templates/maintemplate.html , etc.)
Adjust the file path in the web module (webmodule.pas) accordingly.
http://<WebServer>/<ApacheLocationName>/func1call should start the
example if everything is set up properly.
ex: http://127.0.0.1:8080/myapache/func1call
or http://127.0.0.1/myapache/func1call
if in httpd.conf it was set up as:
LoadModule mod_embedtemplates "<path_to_mod>/embedtemplates.dll"
<Location /myapache>
SetHandler mod_embedtemplates
Order allow,deny
Allow from all
</Location>
Note: You need to change the URLs in the templates if "myapache" or the
module name changes. For example on Linux the module can be
libembedtemplates.so and not embedtemplates.dll
Note: If you recompile an apache module while the module itself is loaded into
the Apache server, the compilation might fail because the file is in use
(Apache modules stay in the memory). So first, you always need to stop the
server before you recompile or before you copy over the new version of the
newly created module.
On Linux, it is enough to simply reload Apache after recompile.
2.c; as FCGI
------------
Usually it works if you put the templates next to the FCGI executable file
under a /templates subdirectory.
(..../templates/maintemplate.html , etc.)
Adjust the file path in the web module (webmodule.pas) accordingly.
http://<WebServer>/<ApacheScriptAliasName>/func1call should start the example
if everything is set up properly.
ex: http://127.0.0.1:8080/myfcgi/func1call
or http://127.0.0.1/myfcgi/func1call
if in the Apache configuration file (ex: httpd.conf) it was set up as:
LoadModule fastcgi_module "<path_to_mod>/mod_fastcgi-2.4.6-AP22.dll"
<IfModule mod_fastcgi.c>
<Directory "<path_to_fcgi_app>">
# Options +ExecCGI <- not needed if ScriptAlias is used below
Order allow,deny
Allow from all
</Directory>
#External FCGI app, has to start manually, Apache will not do it
FastCgiExternalServer "<path_to_fcgi_app>/embedtemplates.exe" -host 127.0.0.1:2015 -idle-timeout 30 -flush
#optionally, to shorten the calling URL and to not display the executable file name (if used, no +ExecCGI is needed above)
ScriptAlias /myfcgi "<path_to_fcgi_app>/embedtemplates.exe"
</IfModule>
Note: You need to change the module name if needed. For example on Linux,
the module is not mod_fastcgi-2.4.6-AP22.dll but mod_fastcgi.so (need to be
compiled from sources found at http://www.fastcgi.com/dist/ ).
The port (2015 in this example) must match the one set in the project main
file (embedtemplates.lpr).
The FCGI application must be running in order for this demo to work (external
FCGI server setup). Do not forget to restart it after changes and
recompilation.
Also, mod_fastcgi is not the same as mod_fcgid that the Apache project is
developing. The latter does not support external FCGI server apps.
There are other ways than external FCGI server apps to handle the FCGI
protocol and both mod_fastcgi and mod_fcgid supports that. However, external
FCGI servers are the best for debugging and development, that is why the
examples do it that way.
|
