Compare commits

..

14 Commits

Author SHA1 Message Date
113aa69efc Added advanced settings for standalone connector
- max_concurrent_connections=100
- keep_alive_timeout=15
- max_tcp_clients=100
- socket_timeout=300
- max_keep_alive_requests=300
And then can be set via the options as well, and via .ini file.
Also improved the verbose console output system.
2016-06-15 09:19:23 +02:00
af5fc75743 Using passive regions.
Improve connector options mainly for standalone connector.
Updated "simple" example to return a timestamp.
2016-06-14 16:01:37 +02:00
Jocelyn Fiat
e53c960a89 Added libfcgi target, in addition to standalone target for the upload_image example. 2016-05-31 22:24:26 +02:00
Jocelyn Fiat
63be2c278c Fixed bad usage of {SOCKET}.socket_ok that resulted in bad behavior on linux. 2016-05-31 22:19:52 +02:00
Jocelyn Fiat
f8ba741aa2 Using -lfcgi as external linker flag, rather than /usr/lib/libfcgi.so .
Note on Ubuntu: apt-get install libfcgi-dev
2016-05-31 18:51:15 +02:00
Jocelyn Fiat
fe07af587d Updated link to github pages documentation. 2016-05-31 16:57:06 +02:00
Jocelyn Fiat
a3a9dd1393 Fixed link to image or source code in markdown workbook text. 2016-05-31 16:51:20 +02:00
Jocelyn Fiat
fbb860024d Updated markdown text to conform strictly to kramdown syntax. 2016-05-31 16:39:50 +02:00
Jocelyn Fiat
a14488346f Updated to kramdown markdown syntax (i.e github).
Updated various content and nav links.
2016-05-27 09:51:24 +02:00
Jocelyn Fiat
f74d1b3069 Updated markdown relative links. 2016-05-26 23:11:19 +02:00
Jocelyn Fiat
1ba3528974 Added readme.md in /doc/. And updated workbook readme.md itself. 2016-05-26 10:41:07 +02:00
5890ca6f73 Removed warning about unknown class in export clause. 2016-05-25 22:51:45 +02:00
7f4bf09d84 updated readme.md to link to workbook. 2016-05-25 19:17:38 +02:00
Colin Adams
ad90e7c135 Fix for missing error reporting in WSF_PUT/POST_HELPER 2016-05-20 17:37:47 +02:00
37 changed files with 652 additions and 263 deletions

10
doc/readme.md Normal file
View File

@@ -0,0 +1,10 @@
Welcome to the EiffelWeb framework documentation.
The EiffelWeb framework is also known as *EWF*.
The [Workbook](/doc/workbook/workbook.md) lets you discover the EiffelWeb framework.
And you may found in the *old* [Wiki](/doc/wiki/readme.md) notes that were not migrated to the [Workbook](/doc/workbook/workbook.md), but consider them as obsolete.
[Enter the documentation](/doc/workbook/workbook.md)

View File

@@ -1,3 +1,3 @@
## Diagram: Overview of the server architecture ## ## Diagram: Overview of the server architecture ##
![server_architecture.png](server_architecture.png) ![server_architecture.png](./server_architecture.png)

View File

@@ -1,4 +1,4 @@
Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/doc/workbook/handling_request/form.md) Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query Parameter](../handling_request/form.md)
## EWF basic service ## EWF basic service
@@ -11,14 +11,15 @@ Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/doc
- [Source code](#source_2) - [Source code](#source_2)
<a name="structure"/> <a name="structure"></a>
## EWF service structure ## EWF service structure
The following code describes the basic structure of an EWF basic service that handles HTTP requests. We will need to define a Service Launcher and a Request Execution implementation. The following code describes the basic structure of an EWF basic service that handles HTTP requests. We will need to define a Service Launcher and a Request Execution implementation.
```eiffel ```eiffel
class class
APPLICACTION APPLICATION
inherit inherit
WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION]
@@ -91,11 +92,11 @@ The **WSF_RESPONSE** provides features to define the response with information s
**APPLICATION** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how you want to run it cgi, fcgi,nino or standalone. For development is recommended to use a standalone web server written in Eiffel, and run the execution within the EiffelStudio debugger. For production fcgi (or cgi) using Apache or another popular web server. **APPLICATION** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how you want to run it cgi, fcgi,nino or standalone. For development is recommended to use a standalone web server written in Eiffel, and run the execution within the EiffelStudio debugger. For production fcgi (or cgi) using Apache or another popular web server.
![Launcher Hierarchy](/doc/workbook/basics/Launcher Hierarchy.png "Launcher Hierarchy") ![Launcher Hierarchy](./Launcher Hierarchy.png "Launcher Hierarchy")
**WS_LAUNCHABLE_SERVICE** inherit from **WS_SERVICE** class, which is a marker interface in EWF. And also provides a way to launch our application using different kind of connectors. The class **WSF_DEFAULT_SERVICE_I**, inherit from **WS_LAUNCHABLE_SERVICE** and has a formal generic that should conform to **WSF_SERVICE_LAUNCHER [WSF_EXECUTION]**. Below a [BON diagram] (http://www.bon-method.com/index_normal.htm) showing one of the possible options. **WS_LAUNCHABLE_SERVICE** inherit from **WS_SERVICE** class, which is a marker interface in EWF. And also provides a way to launch our application using different kind of connectors. The class **WSF_DEFAULT_SERVICE_I**, inherit from **WS_LAUNCHABLE_SERVICE** and has a formal generic that should conform to **WSF_SERVICE_LAUNCHER [WSF_EXECUTION]**. Below a [BON diagram](http://www.bon-method.com/index_normal.htm) showing one of the possible options.
![Standalone Launcher](/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png "Standalone Hierarchy") ![Standalone Launcher](./WSF_SERVICE_LAUNCHER_STANDALONE.png "Standalone Hierarchy")
Other connectors: Other connectors:
**WSF_STANDALONE_SERVICE_LAUNCHER** **WSF_STANDALONE_SERVICE_LAUNCHER**
@@ -109,11 +110,12 @@ The **APPLICATION_EXECUTION** class inherits from **WSF_EXECUTION** interface,
In the **APPLICATION_EXECUTION** class class you will need to implement implement the **execute** feature, get data from the request *req* and write the response in *res*. In the **APPLICATION_EXECUTION** class class you will need to implement implement the **execute** feature, get data from the request *req* and write the response in *res*.
![Execution Hierarchy](/doc/workbook/basics/APPLICATION_EXECUTION.png "Application Execution ") ![Execution Hierarchy](./APPLICATION_EXECUTION.png "Application Execution ")
The WSF_EXECUTION instance, in this case ```APPLICATION_EXECUTION``` is created per request, with two main attributes request: ```WSF_REQUEST``` and response: ```WSF_RESPONSE```. The WSF_EXECUTION instance, in this case ```APPLICATION_EXECUTION``` is created per request, with two main attributes request: ```WSF_REQUEST``` and response: ```WSF_RESPONSE```.
<a name="text"/> <a name="text"></a>
## A simple Service to Generate Plain Text. ## A simple Service to Generate Plain Text.
Before to continue, it is recommended to review the getting started guided. In the example we will only shows the implementation of the WSF_EXECUTION interface. Before to continue, it is recommended to review the getting started guided. In the example we will only shows the implementation of the WSF_EXECUTION interface.
@@ -142,16 +144,18 @@ end
``` ```
<a name="source_1"></a> <a name="source_1"></a>
##### Source code
### Source code
The source code is available on Github. You can get it by running the command: The source code is available on Github. You can get it by running the command:
```git clone https://github.com/EiffelWebFramework/ewf.git``` ```git clone https://github.com/EiffelWebFramework/ewf.git```
The example of simple service that generate plain text response is located in the directory $PATH/ewd/doc/workbook/basics/simple, where $PATH is where you run ```git clone``` . Just double click on the simple.ecf file and select the simple_nino target or if you prefer the command line, run the command: The example of simple service that generate plain text response is located in the directory $PATH/ewf/doc/workbook/basics/simple, where $PATH is where you run ```git clone``` . Just double click on the simple.ecf file and select the simple_nino target or if you prefer the command line, run the command:
```estudio -config simple.ecf -target simple_nino``` ```estudio -config simple.ecf -target simple_nino```
<a name="html"></a> <a name="html"></a>
## A Service to Generate HTML. ## A Service to Generate HTML.
To generate HTML, it's needed To generate HTML, it's needed
@@ -193,7 +197,10 @@ feature -- Basic operations
end end
``` ```
##### Source code
<a name="source_2"></a>
### Source code
The source code is available on Github. You can get it by running the command: The source code is available on Github. You can get it by running the command:
```git clone https://github.com/EiffelWebFramework/ewf.git``` ```git clone https://github.com/EiffelWebFramework/ewf.git```
@@ -202,5 +209,5 @@ The example of the service that generates HTML is located in the directory $PATH
```estudio -config simple_html.ecf -target simple_html_nino``` ```estudio -config simple_html.ecf -target simple_html_nino```
Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query Parameter](/doc/workbook/handling_request/form.md) Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query Parameter](../handling_request/form.md)

View File

@@ -1,31 +1,32 @@
##Run simple_html example on Apache with FCGI on Windows. Nav: [Workbook](../../../workbook.md) :: [Basic concepts](../../../basics/basics.md)
## Run simple_html example on Apache with FCGI on Windows.
#### Prerequisites
####Prerequisites
* This tutorial was written for people working under Windows environment, and using Apache Server with FCGI connector * This tutorial was written for people working under Windows environment, and using Apache Server with FCGI connector
* Compile the ewf application from command line. * Compile the ewf application from command line.
* Assuming you have installed Apache Server under C:/home/server/Apache24. * Assuming you have installed Apache Server under `C:/home/server/Apache24`.
* Assuming you have placed your current project under C:/home/server/Apache24/fcgi-bin. * Assuming you have placed your current project under `C:/home/server/Apache24/fcgi-bin`.
* Assuming you have setted the Listen to 8888, the defautl value is 80 . * Assuming you have setted the Listen to `8888`, the defautl value is `80` .
####FCGI module #### FCGI module
If you don't have the FCGI module installed, you can get it from https://www.apachelounge.com/download/, download the module based on your platform [modules-2.4-win64-VC11.zip](https://www.apachelounge.com/download/VC11/modules/modules-2.4-win64-VC11.zip) or [modules-2.4-win32-VC11.zip](https://www.apachelounge.com/download/VC11/modules/modules-2.4-win32-VC11.zip), uncompress it If you don't have the FCGI module installed, you can get it from https://www.apachelounge.com/download/, download the module based on your platform [modules-2.4-win64-VC11.zip](https://www.apachelounge.com/download/VC11/modules/modules-2.4-win64-VC11.zip) or [modules-2.4-win32-VC11.zip](https://www.apachelounge.com/download/VC11/modules/modules-2.4-win32-VC11.zip), uncompress it
and copy the _mod_fcgid.so_ to C:/home/server/Apache24/modules and copy the _mod_fcgid.so_ to `C:/home/server/Apache24/modules`
####Compile the project simple_html using the fcgi connector. #### Compile the project simple_html using the fcgi connector.
ec -config simple_html.ecf -target simple_html_fcgi -finalize -c_compile -project_path . ec -config simple_html.ecf -target simple_html_fcgi -finalize -c_compile -project_path .
Copy the genereted exe to C:/home/server/Apache24/fcgi-bin folder. Copy the genereted exe to `C:/home/server/Apache24/fcgi-bin` folder.
Check if you have _libfcgi.dll_ in your PATH. Check if you have _libfcgi.dll_ in your PATH.
####Apache configuration #### Apache configuration
Add to httpd.conf the content, you can get the configuration file [here](config.conf) Add to httpd.conf the content, you can get the configuration file [here](config.conf)
``` ```
@@ -43,10 +44,18 @@ LoadModule fcgid_module modules/mod_fcgid.so
``` ```
Test if your httpd.conf is ok Test if your httpd.conf is ok
>httpd -t ```
> httpd -t
```
Luanch the server Launch the server
>httpd ```
> httpd
```
Check the application Check the application
>http://localhost:8888/simple ```
> http://localhost:8888/simple
```
Nav: [Workbook](../../../workbook.md) :: [Basic concepts](../../../basics/basics.md)

View File

@@ -1,6 +0,0 @@
#include <windows.h>
STRINGTABLE
BEGIN
1 "This Program was made using EiffelStudio using Visual Studio C++"
END

View File

@@ -1,7 +1,9 @@
Nav: [Workbook](../workbook.md)
EWF Deployment EWF Deployment
============== ==============
#Apache on Windows# # Apache on Windows#
1. Apache Install 1. Apache Install
2. Deploying EWF CGI 2. Deploying EWF CGI
@@ -15,17 +17,17 @@ EWF Deployment
##Apache on Windows ## Apache on Windows
###Apache Install ### Apache Install
>Check the correct version (Win 32 or Win64) >Check the correct version (Win 32 or Win64)
>Apache Version: Apache 2.4.4 >Apache Version: Apache 2.4.4
>Windows: http://www.apachelounge.com/download/ >Windows: http://www.apachelounge.com/download/
####Deploying EWF CGI #### Deploying EWF CGI
####CGI overview #### CGI overview
>A new process is started for each HTTP request. So if there are N requests to the same >CGI program, the code of the CGI program is loaded into memory N times. >A new process is started for each HTTP request. So if there are N requests to the same >CGI program, the code of the CGI program is loaded into memory N times.
>When a CGI program finishes handling a request, the program terminates. >When a CGI program finishes handling a request, the program terminates.
@@ -59,7 +61,7 @@ Check that you have the following modules enabled
LoadModule cgi_module modules/mod_cgi.so LoadModule cgi_module modules/mod_cgi.so
LoadModule rewrite_module modules/mod_rewrite.so LoadModule rewrite_module modules/mod_rewrite.so
####Tip: #### Tip:
>To check the syntax of your httpd.conf file. From command line run the following >To check the syntax of your httpd.conf file. From command line run the following
$>httpd - t $>httpd - t
@@ -68,7 +70,7 @@ Check that you have the following modules enabled
>.htaccess CGI >.htaccess CGI
http://perishablepress.com/stupid-htaccess-tricks/ http://perishablepress.com/stupid-htaccess-tricks/
####.htaccess #### .htaccess
Options +ExecCGI +Includes +FollowSymLinks -Indexes Options +ExecCGI +Includes +FollowSymLinks -Indexes
AddHandler cgi-script exe AddHandler cgi-script exe
@@ -89,11 +91,11 @@ Check that you have the following modules enabled
>Replace $service with the name of your executable service, for example app_service.exe >Replace $service with the name of your executable service, for example app_service.exe
####Deploying EWF FCGI #### Deploying EWF FCGI
>To deploy FCGI you will need to download the mod_fcgi module. >To deploy FCGI you will need to download the mod_fcgi module.
>You can get it from here http://www.apachelounge.com/download/ >You can get it from here http://www.apachelounge.com/download/
####FCGI overview #### FCGI overview
>FastCGI allows a single, long-running process to handle more than one user request while keeping close to the CGI programming model, retaining the simplicity while eliminating the overhead of creating a new process for each request. Unlike converting an application to a web server plug-in, FastCGI applications remain independent of the web server. >FastCGI allows a single, long-running process to handle more than one user request while keeping close to the CGI programming model, retaining the simplicity while eliminating the overhead of creating a new process for each request. Unlike converting an application to a web server plug-in, FastCGI applications remain independent of the web server.
* Build EWF application * Build EWF application
@@ -126,10 +128,13 @@ Copy the app.exe and the folder "www" into a folder served by apache2, for exam
>NOTE: By default Apache does not come with fcgid module, so you will need to download it, and put the module under Apache2/modules >NOTE: By default Apache does not come with fcgid module, so you will need to download it, and put the module under Apache2/modules
#.htaccess FCGI # .htaccess FCGI
>http://perishablepress.com/stupid-htaccess-tricks/
####.htaccess ```
http://perishablepress.com/stupid-htaccess-tricks/
```
#### .htaccess
Options +ExecCGI +Includes +FollowSymLinks -Indexes Options +ExecCGI +Includes +FollowSymLinks -Indexes
@@ -158,6 +163,4 @@ Copy the app.exe and the folder "www" into a folder served by apache2, for exam
Replace $service with the name of your executable $service, for example app_service.exe Replace $service with the name of your executable $service, for example app_service.exe
You will need to create an service.ews file, this file will be located at the same place where you copy your app service executable. You will need to create an service.ews file, this file will be located at the same place where you copy your app service executable.
Nav: [Workbook](../workbook.md)

View File

@@ -1,5 +1,5 @@
Nav: [Workbook](../workbook.md) | [Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md) | [Handling Cookies](/doc/workbook/handling_cookies/handling_cookies.md) Nav: [Workbook](../workbook.md) :: [Handling Requests: Header Fields](../handling_request/headers.md) :: [Handling Cookies](../handling_cookies/handling_cookies.md)
## EWF Generating Response ## EWF Generating Response
@@ -14,7 +14,8 @@ Nav: [Workbook](../workbook.md) | [Handling Requests: Header Fields](/doc/workbo
- [Response Header Fields](#header_fields) - [Response Header Fields](#header_fields)
<a name="format"/> <a name="format"></a>
## Format of the HTTP response ## Format of the HTTP response
As we saw in the previous documents, a request from a user-agent (browser or other client) consists of an HTTP command (usually GET or POST), zero or more request headers (one or more in HTTP 1.1, since Host is required), a blank line, and only in the case of POST/PUT requests, payload data. A typical request looks like the following. As we saw in the previous documents, a request from a user-agent (browser or other client) consists of an HTTP command (usually GET or POST), zero or more request headers (one or more in HTTP 1.1, since Host is required), a blank line, and only in the case of POST/PUT requests, payload data. A typical request looks like the following.
@@ -49,7 +50,8 @@ looks like this:
The status line consists of the HTTP version (HTTP/1.1 in the preceding example), a status code (an integer 200 in the example), and a very short message corresponding to the status code (OK in the example). In most cases, the headers are optional except for Content-Type, which specifies the MIME type of the document that follows. Although most responses contain a document, some dont. For example, responses to HEAD requests should never include a document, and various status codes essentially indicate failure or redirection (and thus either dont include a document or include only a short error-message document). The status line consists of the HTTP version (HTTP/1.1 in the preceding example), a status code (an integer 200 in the example), and a very short message corresponding to the status code (OK in the example). In most cases, the headers are optional except for Content-Type, which specifies the MIME type of the document that follows. Although most responses contain a document, some dont. For example, responses to HEAD requests should never include a document, and various status codes essentially indicate failure or redirection (and thus either dont include a document or include only a short error-message document).
<a name="status_set"/> <a name="status_set"></a>
## How to set the status code ## How to set the status code
If you need to set an arbitrary status code, you can use the ```WSF_RESPONSE.put_header``` feature or the ```WSF_RESPONSE.set_status_code``` feature. An status code of 200 is a default value. See below examples using the mentioned features. If you need to set an arbitrary status code, you can use the ```WSF_RESPONSE.put_header``` feature or the ```WSF_RESPONSE.set_status_code``` feature. An status code of 200 is a default value. See below examples using the mentioned features.
@@ -94,7 +96,8 @@ Example
``` ```
Both features takes an INTEGER (the status code) as an formal argument, you can use 200, 300, 500 etc directly, but instead of using explicit numbers, it's recommended to use the constants defined in the class [HTTP_STATUS_CODE](). The name of each constant is based from the standard [HTTP 1.1](https://httpwg.github.io/). Both features takes an INTEGER (the status code) as an formal argument, you can use 200, 300, 500 etc directly, but instead of using explicit numbers, it's recommended to use the constants defined in the class [HTTP_STATUS_CODE](). The name of each constant is based from the standard [HTTP 1.1](https://httpwg.github.io/).
<a name="redirect"/> <a name="redirect"></a>
## How to redirect to a particular location. ## How to redirect to a particular location.
To redirect the response to a new location, we need to send a 302 status code, to do that we use ```{HTTP_STATUS_CODE}.found``` To redirect the response to a new location, we need to send a 302 status code, to do that we use ```{HTTP_STATUS_CODE}.found```
@@ -145,7 +148,8 @@ The ```WSF_RESPONSE.redirect_now``` feature use the status code ```{HTTP_STATUS_
Using a similar approach we can build features to answer a bad request (400), internal server error (500), etc. We will build a simple example showing the most common HTTP status codes. Using a similar approach we can build features to answer a bad request (400), internal server error (500), etc. We will build a simple example showing the most common HTTP status codes.
<a name="status"/> <a name="status"></a>
## [HTTP 1.1 Status Codes](https://httpwg.github.io/specs/rfc7231.html#status.codes) ## [HTTP 1.1 Status Codes](https://httpwg.github.io/specs/rfc7231.html#status.codes)
The status-code element is a three-digit integer code giving the result of the attempt to understand and satisfy the request. The first digit of the status-code defines the class of response. The status-code element is a three-digit integer code giving the result of the attempt to understand and satisfy the request. The first digit of the status-code defines the class of response.
@@ -159,7 +163,8 @@ General categories:
Note: use ```res.set_status_code({HTTP_STATUS_CODE}.bad_request)``` rather than ```res.set_status_code(400)```. Note: use ```res.set_status_code({HTTP_STATUS_CODE}.bad_request)``` rather than ```res.set_status_code(400)```.
<a name="example_1"/> <a name="example_1"></a>
### Example Staus Codes ### Example Staus Codes
Basic Service that builds a simple web page to show the most common status codes Basic Service that builds a simple web page to show the most common status codes
```eiffel ```eiffel
@@ -298,7 +303,8 @@ end
<a name="example_2"/> <a name="example_2"></a>
### Example Generic Search Engine ### Example Generic Search Engine
The following example shows a basic EWF service that builds a generic front end for the most used search engines. This example shows how The following example shows a basic EWF service that builds a generic front end for the most used search engines. This example shows how
redirection works, and we will use a tools to play with the API to show differents responses. redirection works, and we will use a tools to play with the API to show differents responses.
@@ -585,7 +591,8 @@ Connection: close
</html> </html>
``` ```
<a name="header_fields"/> <a name="header_fields"></a>
## [Response Header Fields](https://httpwg.github.io/specs/rfc7231.html#response.header.fields) ## [Response Header Fields](https://httpwg.github.io/specs/rfc7231.html#response.header.fields)
The response header fields allow the server to pass additional information about the response beyond what is placed in the status-line. These header fields give information about the server, about further access to the target resource, or about related resources. We can specify cookies, page modification date (for caching), reload a page after a designated period of time, size of the document. The response header fields allow the server to pass additional information about the response beyond what is placed in the status-line. These header fields give information about the server, about further access to the target resource, or about related resources. We can specify cookies, page modification date (for caching), reload a page after a designated period of time, size of the document.
@@ -996,4 +1003,4 @@ There are four categories for response header fields:
Nav: [Workbook](../workbook.md) | [Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md) | [Handling Cookies](/doc/workbook/handling_cookies/handling_cookies.md) Nav: [Workbook](../workbook.md) :: [Handling Requests: Header Fields](../handling_request/headers.md) :: [Handling Cookies](../handling_cookies/handling_cookies.md)

View File

@@ -1,4 +1,4 @@
Nav: [Workbook](../workbook.md) | [Generating Responses](/doc/workbook/generating_response/generating_response.md) Nav: [Workbook](../workbook.md) :: [Generating Responses](../generating_response/generating_response.md)
# Handling Cookies # Handling Cookies
@@ -9,9 +9,10 @@ Nav: [Workbook](../workbook.md) | [Generating Responses](/doc/workbook/generatin
- [How to read a cookie](#read_cookie) - [How to read a cookie](#read_cookie)
- [Examples](#examples) - [Examples](#examples)
<a name="cookie"/> <a name="cookie"></a>
## [Cookie](http://httpwg.github.io/specs/rfc6265.html)
A cookie is a piece of data that can be stored in a browser's cache. If you visit a web site and then revisit it, the cookie data can be used to identify you as a return visitor. Cookies enable state information, such as an online shopping cart, to be remembered. A cookie can be short term, holding data for a single web session, that is, until you close the browser, or a cookie can be longer term, holding data for a week or a year. ## Cookie
A [cookie](http://httpwg.github.io/specs/rfc6265.html) is a piece of data that can be stored in a browser's cache. If you visit a web site and then revisit it, the cookie data can be used to identify you as a return visitor. Cookies enable state information, such as an online shopping cart, to be remembered. A cookie can be short term, holding data for a single web session, that is, until you close the browser, or a cookie can be longer term, holding data for a week or a year.
Cookies are used a lot in web client-server communication. Cookies are used a lot in web client-server communication.
@@ -30,7 +31,8 @@ Client send cookies to server
<a name="properties"/> <a name="properties"></a>
### Cookie properties ### Cookie properties
- Comment: describe the purpose of the cookie. Note that server doesnt receive this information when client sends cookie in request header. - Comment: describe the purpose of the cookie. Note that server doesnt receive this information when client sends cookie in request header.
@@ -43,7 +45,8 @@ Client send cookies to server
- HttpOnly: Checks whether this Cookie has been marked as HttpOnly. - HttpOnly: Checks whether this Cookie has been marked as HttpOnly.
- Version: - Version:
<a name="set_get"/> <a name="set_get"></a>
## Write and Read Cookies. ## Write and Read Cookies.
To send a cookie to the client we should use the [HTTP_HEADER] class, and call ```h.put_cookie``` feature or To send a cookie to the client we should use the [HTTP_HEADER] class, and call ```h.put_cookie``` feature or
@@ -67,7 +70,8 @@ WSF_REQUEST.cookie (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE
feature. feature.
<a name="set_cookie"/> <a name="set_cookie"></a>
### How to set Cookies ### How to set Cookies
Here we have the feature definitions to set cookies Here we have the feature definitions to set cookies
@@ -111,7 +115,8 @@ Example of use:
res.put_string (web_page) res.put_string (web_page)
end end
``` ```
<a name="read_cookie"/> <a name="read_cookie"></a>
### How to read Cookies ### How to read Cookies
Reading a particular cookie Reading a particular cookie
@@ -130,7 +135,8 @@ Reading all the cookies
``` ```
<a name="examples"/> <a name="examples"></a>
### Example ### Example
The following EWF service shows a basic use of cookies. The following EWF service shows a basic use of cookies.
1. It display a message to first-time visitors. 1. It display a message to first-time visitors.
@@ -285,4 +291,4 @@ end
``` ```
Nav: [Workbook](../workbook.md) | [Generating Responses](/doc/workbook/generating_response/generating_response.md) Nav: [Workbook](../workbook.md) :: [Generating Responses](../generating_response/generating_response.md)

View File

@@ -1,13 +1,11 @@
Nav: [Workbook](../workbook.md) | [Basic Concepts] (/doc/workbook/basics/basics.md) | [Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md) Nav: [Workbook](../workbook.md) :: [Basic Concepts](../basics/basics.md) :: [Handling Requests: Header Fields](./headers.md)
#Handling Requests: Form/Query Data
# Handling Requests: Form/Query Data
##### Table of Contents ##### Table of Contents
- [Reading Form Data](#read) - [Reading Form Data](#read)
- [Query Parameters](#query) - [Query Parameters](#query)
- [Form Parameters](#form) - [Form Parameters](#form_parameters)
- [Uniform Read](#uniform) - [Uniform Read](#uniform)
- [Reading Parameters and Values](#reading_pv) - [Reading Parameters and Values](#reading_pv)
- [How to read all parameters names](#all_names) - [How to read all parameters names](#all_names)
@@ -34,11 +32,13 @@ Here we will show you how to read input submitted by a user using a Form (GET an
* client side validattion, server side validations, set default if it's a valid option. * client side validattion, server side validations, set default if it's a valid option.
* How to populate Eiffel objects from the request data. * How to populate Eiffel objects from the request data.
<a name="read"/> <a name="read"></a>
## Reading Form Data ## Reading Form Data
EWF [WSF_REQUEST]() class, provides features to handling this form parsing automatically. EWF [WSF_REQUEST]() class, provides features to handling this form parsing automatically.
<a name="query"/> <a name="query"></a>
### Query Parameters ### Query Parameters
WSF_REQUEST.query_parameters: ITERABLE [WSF_VALUE] WSF_REQUEST.query_parameters: ITERABLE [WSF_VALUE]
@@ -46,7 +46,8 @@ EWF [WSF_REQUEST]() class, provides features to handling this form parsing autom
WSF_REQUEST.query_parameter (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE WSF_REQUEST.query_parameter (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE
-- Query parameter for name `a_name'. -- Query parameter for name `a_name'.
<a name="form"/> <a name="form_parameters"></a>
### Form Parameters ### Form Parameters
WSF_REQUEST.form_parameters: ITERABLE [WSF_VALUE] WSF_REQUEST.form_parameters: ITERABLE [WSF_VALUE]
@@ -57,7 +58,8 @@ EWF [WSF_REQUEST]() class, provides features to handling this form parsing autom
The values supplied to form_parameter and query_parameter are case sensitive. The values supplied to form_parameter and query_parameter are case sensitive.
<a name="uniform"/> <a name="uniform"></a>
### Read Data ### Read Data
The previous features, let you read the data one way for GET request and a different way for POST request. WSF_REQUEST provide a feature to read all the data in a uniform way. The previous features, let you read the data one way for GET request and a different way for POST request. WSF_REQUEST provide a feature to read all the data in a uniform way.
@@ -70,7 +72,8 @@ So, you use **WSF_REQUEST.item** feature exactly the same way for GET and POST r
>Note: if a query parameter has the same name as a form paramenter req.item will retrieve the form paramenter. Remember the precedence: form > query > path >Note: if a query parameter has the same name as a form paramenter req.item will retrieve the form paramenter. Remember the precedence: form > query > path
<a name="reading_pv"> <a name="reading_pv"></a>
## Reading Parameters and Values ## Reading Parameters and Values
Suppose we have the following HTML5 form using Method POST. This HTML5 form has client side form validation using the new HTML5 attribute, you can do the same using Javascript. So in this case if the user does not fill the fields as expected the form will not be submitted to the server. Suppose we have the following HTML5 form using Method POST. This HTML5 form has client side form validation using the new HTML5 attribute, you can do the same using Javascript. So in this case if the user does not fill the fields as expected the form will not be submitted to the server.
@@ -111,7 +114,8 @@ Suppose we have the following HTML5 form using Method POST. This HTML5 form has
</fieldset> </fieldset>
</form> </form>
``` ```
<a name="all_names"> <a name="all_names"></a>
### How to read all parameter names ### How to read all parameter names
To read all the parameters names we simple call WSF_REQUEST.form_parameters. To read all the parameters names we simple call WSF_REQUEST.form_parameters.
@@ -119,7 +123,8 @@ To read all the parameters names we simple call WSF_REQUEST.form_parameters.
req: WSF_REQUEST req: WSF_REQUEST
across req.form_parameters as ic loop show_parameter_name (ic.item.key) end across req.form_parameters as ic loop show_parameter_name (ic.item.key) end
``` ```
<a name="single_values"> <a name="single_values"></a>
### How to read single values ### How to read single values
To read a particular parameter, a single value, for example `given-name', we simple call WSF_REQUEST.form_parameter (a_name) and we check if it's attached to WSF_STRING (represents a String parameter) To read a particular parameter, a single value, for example `given-name', we simple call WSF_REQUEST.form_parameter (a_name) and we check if it's attached to WSF_STRING (represents a String parameter)
``` ```
@@ -131,7 +136,8 @@ To read a particular parameter, a single value, for example `given-name', we sim
-- Value missing, check the name against the HTML form -- Value missing, check the name against the HTML form
end end
``` ```
<a name="multiple_values"> <a name="multiple_values"></a>
### How to read multiple values ### How to read multiple values
To read multiple values, for example in the case of `languages', we simple call WSF_REQUEST.form_parameter (a_name) and we check if it's attached to WSF_MULTIPLE_STRING (represents a String parameter) To read multiple values, for example in the case of `languages', we simple call WSF_REQUEST.form_parameter (a_name) and we check if it's attached to WSF_MULTIPLE_STRING (represents a String parameter)
@@ -155,7 +161,8 @@ To read multiple values, for example in the case of `languages', we simple call
``` ```
In this case we are handling strings values, but in some cases you will need to do a conversion, betweend the strings that came from the request to map them to your domain model. In this case we are handling strings values, but in some cases you will need to do a conversion, betweend the strings that came from the request to map them to your domain model.
<a name="table_values"> <a name="table_values"></a>
### How to read table values ### How to read table values
This is particularly useful when you have a request with the following format This is particularly useful when you have a request with the following format
@@ -183,7 +190,8 @@ if attached {WSF_TABLE} req.query_parameter ("tab") as l_tab then
end end
``` ```
<a name="raw_data"> <a name="raw_data"></a>
## Reading Raw Data ## Reading Raw Data
You can also access the data in raw format, it means you will need to parse and url-decode it, and also you will not be able to use the previous features, by default, to enable that you need to call `req.set_raw_input_data_recorded (True)'. This feature (reading raw data) is useful if you are reading POST data with JSON or XML formats, but it's not convinient for HTML forms. You can also access the data in raw format, it means you will need to parse and url-decode it, and also you will not be able to use the previous features, by default, to enable that you need to call `req.set_raw_input_data_recorded (True)'. This feature (reading raw data) is useful if you are reading POST data with JSON or XML formats, but it's not convinient for HTML forms.
@@ -199,7 +207,8 @@ To read raw data you need to do this
> given-name=testr&family-name=test&dob=1976-08-26&email=test%40gmail.com&url=http%3A%2F%2Fwww.eiffelroom.com&phone=455555555555&languages=Spanish&languages=English > given-name=testr&family-name=test&dob=1976-08-26&email=test%40gmail.com&url=http%3A%2F%2Fwww.eiffelroom.com&phone=455555555555&languages=Spanish&languages=English
<a name=upload></a> <a name="upload"></a>
## Upload Files ## Upload Files
How can we read data when the date come from an uploaded file/s?. How can we read data when the date come from an uploaded file/s?.
HTML supports a form element ```<input type="File" ... > ``` to upload a single file and ```<input type="File" ... multiplr> ``` to upload multiple files. HTML supports a form element ```<input type="File" ... > ``` to upload a single file and ```<input type="File" ... multiplr> ``` to upload multiple files.
@@ -290,7 +299,8 @@ The source code is available on Github. You can get it by running the command:
The example is located in the directory $PATH/ewf/doc/workbook/upload_file where $PATH is where you run git clone. The example is located in the directory $PATH/ewf/doc/workbook/upload_file where $PATH is where you run git clone.
<a name=examples> <a name="examples"></a>
## Examples ## Examples
The source code is available on Github. You can get it by running the command: The source code is available on Github. You can get it by running the command:
@@ -303,5 +313,4 @@ The GET example is located in the directory $PATH/ewf/doc/workbook/form/get, and
>Note: replace <ecf_name> and<target_name> with the corresponding values. >Note: replace <ecf_name> and<target_name> with the corresponding values.
Nav: [Workbook](../workbook.md) | [Basic Concepts] (/doc/workbook/basics/basics.md) | [Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md) Nav: [Workbook](../workbook.md) :: [Basic Concepts](../basics/basics.md) :: [Handling Requests: Header Fields](./headers.md)

View File

@@ -1,7 +1,7 @@
Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query parameters] (/doc/workbook/handling_request/form.md) | [Generating Responses](/doc/workbook/generating_response/generating_response.md) Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query parameters](./form.md) :: [Generating Responses](../generating_response/generating_response.md)
#Handling Requests: Headers # Handling Requests: Headers
##### Introduction ##### Introduction
- The [HTTP request header fields (also known as "headers")](https://httpwg.github.io/specs/rfc7231.html#request.header.fields) are set by the client (usually web browser) and sent in the header of the http request text (see http protocol), as opposed to form or query parameters [Form Data](). - The [HTTP request header fields (also known as "headers")](https://httpwg.github.io/specs/rfc7231.html#request.header.fields) are set by the client (usually web browser) and sent in the header of the http request text (see http protocol), as opposed to form or query parameters [Form Data]().
@@ -43,6 +43,7 @@ Among other, this means the header fields are exposed with associated CGI field
- For instance `X-Server` will be known as `HTTP_X_SERVER`. - For instance `X-Server` will be known as `HTTP_X_SERVER`.
<a name="read_header"></a> <a name="read_header"></a>
## Reading HTTP Header fields ## Reading HTTP Header fields
EWF [WSF_REQUEST]() class provides features to access HTTP headers. EWF [WSF_REQUEST]() class provides features to access HTTP headers.
@@ -72,7 +73,8 @@ Due to CGI compliance, the original header names are not available, however the
Note: CGI variables are information about the current request (and also about the server). Some are based on the HTTP request line and headers (e.g., form parameters, query parameters), others are derived from the socket itself (e.g., the name and IP address of the requesting host), and still others are taken from server installation parameters (e.g., the mapping of URLs to actual paths). Note: CGI variables are information about the current request (and also about the server). Some are based on the HTTP request line and headers (e.g., form parameters, query parameters), others are derived from the socket itself (e.g., the name and IP address of the requesting host), and still others are taken from server installation parameters (e.g., the mapping of URLs to actual paths).
<a name="read_line"></a> <a name="read_line"></a>
####Retrieve information from the Request Line
#### Retrieve information from the Request Line
For convenience, the following sections refer to a request starting with line: For convenience, the following sections refer to a request starting with line:
``` ```
@@ -102,59 +104,72 @@ Overview of the features
<a name="understand"></a> <a name="understand"></a>
#### Understanding HTTP 1.1 Request Headers #### Understanding HTTP 1.1 Request Headers
Access to the request headers permits the web server applications or APIs to perform optimizations and provide behavior that would not be possible without them for instance such as adapting the response according to the browser preferences. Access to the request headers permits the web server applications or APIs to perform optimizations and provide behavior that would not be possible without them for instance such as adapting the response according to the browser preferences.
This section summarizes the headers most often used; for more information, see the [HTTP 1.1 specification](https://httpwg.github.io/specs/), note that [RFC 2616 is dead](https://www.mnot.net/blog/2014/06/07/rfc2616_is_dead). This section summarizes the headers most often used; for more information, see the [HTTP 1.1 specification](https://httpwg.github.io/specs/), note that [RFC 2616 is dead](https://www.mnot.net/blog/2014/06/07/rfc2616_is_dead).
<a name="accept"></a> <a name="accept"></a>
* [Accept](https://httpwg.github.io/specs/rfc7231.html#header.accept) * [Accept](https://httpwg.github.io/specs/rfc7231.html#header.accept)
- The "Accept" header field can be used by user agents (browser or other clients) to define response media types that are acceptable. Accept header fields can be used to indicate that the request is limited to a small set of desired types, as in the case of a request for an inline image. - The "Accept" header field can be used by user agents (browser or other clients) to define response media types that are acceptable. Accept header fields can be used to indicate that the request is limited to a small set of desired types, as in the case of a request for an inline image.
For example, assume an APIs Learn4Kids can respond with XML or JSON data (JSON format have some advantages over XML, readability, parsing etc...), a client can define its preference using "Accept: application/json" to request data in JSON format, or "Accept: application/xml" to get XML format. In other case the server sends a not acceptable response. Note that the client can define an ordered list of accepted content types, including "*", the client will get the response and know the content type via the response header field "Content-Type". Related [Content-Negotiation]() For example, assume an APIs Learn4Kids can respond with XML or JSON data (JSON format have some advantages over XML, readability, parsing etc...), a client can define its preference using "Accept: application/json" to request data in JSON format, or "Accept: application/xml" to get XML format. In other case the server sends a not acceptable response. Note that the client can define an ordered list of accepted content types, including "*", the client will get the response and know the content type via the response header field "Content-Type". Related [Content-Negotiation]()
<a name="accept_charset"></a> <a name="accept_charset"></a>
* [Accept-Charset](https://httpwg.github.io/specs/rfc7231.html#header.accept-charset) * [Accept-Charset](https://httpwg.github.io/specs/rfc7231.html#header.accept-charset)
- The "Accept-Charset" header field can be sent by a user agent (browser or other clients) to indicate which charsets are acceptable in textual response content (e.g., ISO-8859-1). - The "Accept-Charset" header field can be sent by a user agent (browser or other clients) to indicate which charsets are acceptable in textual response content (e.g., ISO-8859-1).
<a name="accept_encoding"></a> <a name="accept_encoding"></a>
* [Accept-Encoding](https://httpwg.github.io/specs/rfc7231.html#header.accept-encoding) * [Accept-Encoding](https://httpwg.github.io/specs/rfc7231.html#header.accept-encoding)
- The "Accept-Encoding" header field can be used by user agents (browser or other clients) to indicate which response content-codings (`gzip`, `compress`) are acceptable in the response. An "identity" token is used as a synonym for "no encoding" in order to communicate when no encoding is preferred. If the server receives this header, it is free to encode the page by using one of the content-encodings specified (usually to reduce transmission time), sending the `Content-Encoding` response header to indicate that it has done so. - The "Accept-Encoding" header field can be used by user agents (browser or other clients) to indicate which response content-codings (`gzip`, `compress`) are acceptable in the response. An "identity" token is used as a synonym for "no encoding" in order to communicate when no encoding is preferred. If the server receives this header, it is free to encode the page by using one of the content-encodings specified (usually to reduce transmission time), sending the `Content-Encoding` response header to indicate that it has done so.
<a name="accept_language"></a> <a name="accept_language"></a>
* [Accept-Language](https://httpwg.github.io/specs/rfc7231.html#header.accept-language) * [Accept-Language](https://httpwg.github.io/specs/rfc7231.html#header.accept-language)
- The "Accept-Language" header field can be used by user agents (browser or other client) to indicate the set of natural languages that are preferred in the response in case the server can produce representation in more than one language. The value of the header should be one of the standard language codes such as en, en-us, da, etc. See RFC 1766 for details (start at http://www.rfc-editor.org/ to get a current list of the RFC archive sites). - The "Accept-Language" header field can be used by user agents (browser or other client) to indicate the set of natural languages that are preferred in the response in case the server can produce representation in more than one language. The value of the header should be one of the standard language codes such as en, en-us, da, etc. See RFC 1766 for details (start at http://www.rfc-editor.org/ to get a current list of the RFC archive sites).
<a name="connection"></a> <a name="connection"></a>
* [Connection](https://httpwg.github.io/specs/rfc7230.html#header.connection) * [Connection](https://httpwg.github.io/specs/rfc7230.html#header.connection)
- The "Connection" header field allows the sender to indicate desired control options for the current connection, for example if it can hanlde persistent HTTP connections. - The "Connection" header field allows the sender to indicate desired control options for the current connection, for example if it can hanlde persistent HTTP connections.
By default HTTP/1.1 uses "persistent connections", allowing multiple requests and responses to be carried over a single connection. The "close" connection option is used to signal that a connection will not persist after the current request/response. By default HTTP/1.1 uses "persistent connections", allowing multiple requests and responses to be carried over a single connection. The "close" connection option is used to signal that a connection will not persist after the current request/response.
<a name="authorization"></a> <a name="authorization"></a>
* [Authorization](https://httpwg.github.io/specs/rfc7235.html#header.authorization) * [Authorization](https://httpwg.github.io/specs/rfc7235.html#header.authorization)
- The header is used by user agents to authenticate themselves when accessing password protected resources. - The header is used by user agents to authenticate themselves when accessing password protected resources.
<a name="content-length"></a> <a name="content-length"></a>
* [Content-Length](https://httpwg.github.io/specs/rfc7230.html#header.content-length) * [Content-Length](https://httpwg.github.io/specs/rfc7230.html#header.content-length)
- For messages that includes a payload body, the Content-Length field-value provides the framing information necessary to determine where the body (and message) ends. - For messages that includes a payload body, the Content-Length field-value provides the framing information necessary to determine where the body (and message) ends.
<a name="cookie"></a> <a name="cookie"></a>
* [Cookie](https://httpwg.github.io/specs/rfc6265.html) * [Cookie](https://httpwg.github.io/specs/rfc6265.html)
- The Cookie header contains cookies received by the user agent in previous Set-Cookie headers. The origin server is free to ignore the Cookie header or use its contents for an application-specific purpose. (Related State Management). - The Cookie header contains cookies received by the user agent in previous Set-Cookie headers. The origin server is free to ignore the Cookie header or use its contents for an application-specific purpose. (Related State Management).
<a name="host"></a> <a name="host"></a>
* [Host](https://httpwg.github.io/specs/rfc7230.html#header.host) * [Host](https://httpwg.github.io/specs/rfc7230.html#header.host)
- The "Host" header field provides the host and port information from the target URI, enabling the origin server to distinguish among resources while serving requests for multiple host names on a single IP address. In HTTP 1.1, browsers and other clients are required to specify this header, which indicates the host and port as given in the original URL. - The "Host" header field provides the host and port information from the target URI, enabling the origin server to distinguish among resources while serving requests for multiple host names on a single IP address. In HTTP 1.1, browsers and other clients are required to specify this header, which indicates the host and port as given in the original URL.
<a name="if-modified-since"></a> <a name="if-modified-since"></a>
* [If-Modified-Since](https://httpwg.github.io/specs/rfc7232.html#header.if-modified-since) * [If-Modified-Since](https://httpwg.github.io/specs/rfc7232.html#header.if-modified-since)
- The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfering of the selected representation's data is avoided if that data has not changed. So, indicates that the user agents wants the page only if it has been changes after the specified date. The server sends a 304 resource not modified if not has a newer result representation available. - The "If-Modified-Since" header field makes a GET or HEAD request method conditional on the selected representation's modification date being more recent than the date provided in the field-value. Transfering of the selected representation's data is avoided if that data has not changed. So, indicates that the user agents wants the page only if it has been changes after the specified date. The server sends a 304 resource not modified if not has a newer result representation available.
<a name="if-unmodified-since"></a> <a name="if-unmodified-since"></a>
* [If-Unmodified-Since](https://httpwg.github.io/specs/rfc7232.html#header.if-unmodified-since) * [If-Unmodified-Since](https://httpwg.github.io/specs/rfc7232.html#header.if-unmodified-since)
- The "If-Unmodified-Since" header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. The operation should succeed only if the document is older than the specified date. - The "If-Unmodified-Since" header field makes the request method conditional on the selected representation's last modification date being earlier than or equal to the date provided in the field-value. The operation should succeed only if the document is older than the specified date.
Generally, If-Modified-Since is used for GET requests (“give me the document only if it is newer than my cached version”), whereas If-Unmodified-Since is used for PUT requests (“update this document only if nobody else has changed it since I generated it”). Generally, If-Modified-Since is used for GET requests (“give me the document only if it is newer than my cached version”), whereas If-Unmodified-Since is used for PUT requests (“update this document only if nobody else has changed it since I generated it”).
<a name="referer"></a> <a name="referer"></a>
* [Referer](https://httpwg.github.io/specs/rfc7231.html#header.referer) * [Referer](https://httpwg.github.io/specs/rfc7231.html#header.referer)
- The "Referer" header field allows the user agent to specify a URI reference for the resource from which the target URI was obtained (i.e., the "referrer", though the field name is misspelled). A user agent MUST NOT include the fragment and userinfo components of the URI reference [RFC3986], if any, when generating the Referer field value. This header indicates the URL of the referring Web page. - The "Referer" header field allows the user agent to specify a URI reference for the resource from which the target URI was obtained (i.e., the "referrer", though the field name is misspelled). A user agent MUST NOT include the fragment and userinfo components of the URI reference [RFC3986], if any, when generating the Referer field value. This header indicates the URL of the referring Web page.
@@ -162,15 +177,17 @@ For example, if you are at Web page A and click on a link to Web page B, the URL
included in the Referer header when the browser requests Web page B. included in the Referer header when the browser requests Web page B.
<a name="user-agent"></a> <a name="user-agent"></a>
* [User-Agent](https://httpwg.github.io/specs/rfc7231.html#header.user-agent) * [User-Agent](https://httpwg.github.io/specs/rfc7231.html#header.user-agent)
- The "User-Agent" header field contains information about the user agent of the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use or device. - The "User-Agent" header field contains information about the user agent of the request, which is often used by servers to help identify the scope of reported interoperability problems, to work around or tailor responses to avoid particular user agent limitations, and for analytics regarding browser or operating system use or device.
**Note**: the example shows the **WSF_EXECUTION** implementation, that will be used by the service launcher. **Note**: the example shows the **WSF_EXECUTION** implementation, that will be used by the service launcher.
<a name="example"></a> <a name="example"></a>
#### Building a Table of All Request Headers #### Building a Table of All Request Headers
The following [EWF service](/doc/workbook/handling_request/headers/header_fields/application.e) code simply uses an ```html_template``` to fill a table (names and values) with all the headers fields it receives. The following [EWF service](./headers/header_fields/application.e) code simply uses an ```html_template``` to fill a table (names and values) with all the headers fields it receives.
The service accomplishes this task by calling ```req.meta_variables``` feature to get an ```ITERABLE [WSF_STRING]```, an structure that can be iterated over using ```across...loop...end```, then it checks if the name has the prefix ```HTTP_``` and if it is true, put the header name and value in a row. (the name in the left cell, the value in the right cell). The service accomplishes this task by calling ```req.meta_variables``` feature to get an ```ITERABLE [WSF_STRING]```, an structure that can be iterated over using ```across...loop...end```, then it checks if the name has the prefix ```HTTP_``` and if it is true, put the header name and value in a row. (the name in the left cell, the value in the right cell).
@@ -276,6 +293,7 @@ end
``` ```
<a name="compress"></a> <a name="compress"></a>
#### How to compress pages #### How to compress pages
To be completed. To be completed.
@@ -284,7 +302,7 @@ To be completed.
#### Detecting Browser Types #### Detecting Browser Types
The User-Agent header identifies the specific browser/client that is sending the request. The following code shows a [EWF service](/doc/workbook/handling_request/headers/browser_name/application.e) that sends browser-specific responses. The User-Agent header identifies the specific browser/client that is sending the request. The following code shows a [EWF service](./headers/browser_name/application.e) that sends browser-specific responses.
The examples uses the ideas based on the [Browser detection using the user agent](https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent) article. The examples uses the ideas based on the [Browser detection using the user agent](https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent) article.
Basically the code check if the header user_agent exist and then call the ```browser_name (a_user_agent: READABLE_STRING_8): READABLE_STRING_32``` Basically the code check if the header user_agent exist and then call the ```browser_name (a_user_agent: READABLE_STRING_8): READABLE_STRING_32```
@@ -429,10 +447,8 @@ As an exercise, try to write a similar service to retrieve the OS family using t
* [SERVER_SOFTWARE](https://tools.ietf.org/html/rfc3875#section-4.1.16) * [SERVER_SOFTWARE](https://tools.ietf.org/html/rfc3875#section-4.1.16)
**Example** **Example**
An [EWF service](/doc/workbook/handling_request/headers/cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables. An [EWF service](./headers/cgi_variables/application.e) that shows the CGI variables, creates a table showing the values of all the CGI variables.
Nav: [Workbook](../workbook.md) | [Handling Requests: Form/Query parameters] (/doc/workbook/handling_request/form.md) | [Generating Responses](/doc/workbook/generating_response/generating_response.md)
Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query parameters](./form.md) :: [Generating Responses](../generating_response/generating_response.md)

View File

@@ -1,13 +1,4 @@
Introduction The [Workbook](./workbook.md) lets you discover the EiffelWeb framework.
Basic Concepts
Generating Plain Text
Generation HTML
Handling Client Request: [Enter the documentation](./workbook.md)
Form Data
Request Heders
Query Parameters.

View File

@@ -5,38 +5,46 @@
* [EWF Introduction](#introduction) * [EWF Introduction](#introduction)
* [Handling Requests: Form/Query Parameter](#form_query_parameters) * [Handling Requests: Form/Query Parameter](#form_query_parameters)
* [Handling Requests: Header Fields](#header_fields) * [Handling Requests: Header Fields](#header_fields)
* [Generating Responses](#generating responses) * [Generating Responses](#generating_responses)
* [Handling Cookies](#handling_cookies) * [Handling Cookies](#handling_cookies)
* [EWF Deployment](#deployment) * [EWF Deployment](#deployment)
<a name="core"></a> <a name="core"></a>
# EWF Core # EWF Core
Before reading (or walking throught) the workbook, to get a quick overview of EWF, it is recommended to read the following articles: Before reading (or walking throught) the workbook, to get a quick overview of EWF, it is recommended to read the following articles:
* [Getting Started with EWF](http://eiffelwebframework.github.io/EWF/getting-started/) * [Getting Started with EWF](http://eiffelwebframework.github.io/EWF/getting-started/)
* [EWF Documentation](http://eiffelwebframework.github.io/EWF/wiki/Documentation/) * [EWF Documentation](http://eiffelwebframework.github.io/EWF/workbook/workbook)
* [EWF Application Lifecyle](https://github.com/EiffelWebFramework/ewf_examples/wiki/Application-Lifecycle) * [EWF Application Lifecyle](https://github.com/EiffelWebFramework/ewf_examples/wiki/Application-Lifecycle)
<a name="introduction"></a> <a name="introduction"></a>
## Introduction ## Introduction
[Basic Concepts] (/doc/workbook/basics/basics.md). [Basic Concepts](./basics/basics.md).
<a name="form_query_parameters"></a> <a name="form_query_parameters"></a>
## Handling Requests: Form/Query Parameter ## Handling Requests: Form/Query Parameter
[Handling Requests: Form/Query Parameter] (/doc/workbook/handling_request/form.md). [Handling Requests: Form/Query Parameter](./handling_request/form.md).
<a name="header_fields"></a> <a name="header_fields"></a>
## Handling Requests: Header Fields ## Handling Requests: Header Fields
[Handling Requests: Header Fields](/doc/workbook/handling_request/headers.md). [Handling Requests: Header Fields](./handling_request/headers.md).
<a name="generating_responses"></a> <a name="generating_responses"></a>
## Generating Response ## Generating Response
[Generating Responses](/doc/workbook/generating_response/generating_response.md) [Generating Responses](./generating_response/generating_response.md)
<a name="handling_cookies"></a> <a name="handling_cookies"></a>
## Handling Cookies
[Handling Cookies](/doc/workbook/handling_cookies/handling_cookies.md)
<a name="deployment"/> ## Handling Cookies
[Handling Cookies](./handling_cookies/handling_cookies.md)
<a name="deployment"></a>
## EWF Deployment ## EWF Deployment
[EWF Deployment](/doc/workbook/deployment.md) [EWF Deployment](./deployment/readme.md)

View File

@@ -20,9 +20,10 @@ feature {NONE} -- Initialization
initialize initialize
-- Initialize current service. -- Initialize current service.
do do
set_service_option ("port", 9090) -- Specific to `standalone' connector (the EiffelWeb server).
-- See `{WSF_STANDALONE_SERVICE_LAUNCHER}.initialize'
set_service_option ("port", 9090)
import_service_options (create {WSF_SERVICE_LAUNCHER_OPTIONS_FROM_INI}.make_from_file ("simple.ini"))
end end
end end

View File

@@ -17,10 +17,13 @@ feature -- Basic operations
execute execute
local local
s: STRING s: STRING
do dt: HTTP_DATE
-- To send a response we need to setup, the status code and do
-- the response headers. -- To send a response we need to setup, the status code and
s := "Hello World!" -- the response headers.
s := "Hello World!"
create dt.make_now_utc
s.append (" (UTC time is " + dt.rfc850_string + ").")
response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", s.count.out]>>) response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", s.count.out]>>)
response.set_status_code ({HTTP_STATUS_CODE}.ok) response.set_status_code ({HTTP_STATUS_CODE}.ok)
response.header.put_content_type_text_html response.header.put_content_type_text_html

View File

@@ -1,35 +1,28 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-13-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-13-0 http://www.eiffel.com/developers/xml/configuration-1-13-0.xsd" name="simple" uuid="C28C4F53-9963-46C0-A080-8F13E94E7486" library_target="simple"> <system xmlns="http://www.eiffel.com/developers/xml/configuration-1-15-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-15-0 http://www.eiffel.com/developers/xml/configuration-1-15-0.xsd" name="simple" uuid="C28C4F53-9963-46C0-A080-8F13E94E7486" library_target="simple">
<target name="common" abstract="true"> <target name="common" abstract="true">
<file_rule> <file_rule>
<exclude>/EIFGENs$</exclude>
<exclude>/CVS$</exclude>
<exclude>/.svn$</exclude> <exclude>/.svn$</exclude>
<exclude>/CVS$</exclude>
<exclude>/EIFGENs$</exclude>
</file_rule> </file_rule>
<option warning="true" full_class_checking="false" is_attached_by_default="true" void_safety="transitional" syntax="transitional"> <option warning="true" full_class_checking="false" is_attached_by_default="true" is_obsolete_routine_type="true" void_safety="transitional" syntax="transitional">
<assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/> <assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/>
</option> </option>
<setting name="console_application" value="true"/>
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="http" location="..\..\library\network\protocol\http\http-safe.ecf"/> <library name="http" location="..\..\library\network\protocol\http\http-safe.ecf"/>
<library name="wsf" location="..\..\library\server\wsf\wsf-safe.ecf"/> <library name="wsf" location="..\..\library\server\wsf\wsf-safe.ecf"/>
</target> </target>
<target name="simple_standalone" extends="common"> <target name="simple_standalone" extends="common">
<root class="APPLICATION" feature="make_and_launch"/> <root class="APPLICATION" feature="make_and_launch"/>
<option warning="true" is_attached_by_default="true" void_safety="transitional" syntax="transitional"> <option warning="true" is_attached_by_default="true" void_safety="all" syntax="transitional">
<assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/> <assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/>
</option> </option>
<setting name="concurrency" value="thread"/> <setting name="concurrency" value="scoop"/>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf"/> <library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf"/>
<cluster name="simple" location=".\" recursive="true"/> <cluster name="simple" location=".\" recursive="true"/>
</target> </target>
<target name="simple_nino" extends="common">
<root class="APPLICATION" feature="make_and_launch"/>
<option warning="true" is_attached_by_default="true" void_safety="transitional" syntax="transitional">
<assertions precondition="true" postcondition="true" check="true" invariant="true" loop="true" supplier_precondition="true"/>
</option>
<library name="default_nino" location="..\..\library\server\wsf\default\nino-safe.ecf"/>
<cluster name="simple" location=".\" recursive="true"/>
</target>
<target name="simple_cgi" extends="common"> <target name="simple_cgi" extends="common">
<root class="APPLICATION" feature="make_and_launch"/> <root class="APPLICATION" feature="make_and_launch"/>
<option warning="true" is_attached_by_default="true" void_safety="transitional" syntax="transitional"> <option warning="true" is_attached_by_default="true" void_safety="transitional" syntax="transitional">

View File

@@ -0,0 +1,8 @@
verbose=true
verbose_level=ALERT
port=9090
#max_concurrent_connections=100
#keep_alive_timeout=15
#max_tcp_clients=100
#socket_timeout=300
#max_keep_alive_requests=300

View File

@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="ISO-8859-1"?> <?xml version="1.0" encoding="ISO-8859-1"?>
<system xmlns="http://www.eiffel.com/developers/xml/configuration-1-12-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-12-0 http://www.eiffel.com/developers/xml/configuration-1-12-0.xsd" name="upload_image" uuid="F2400BE8-D8EB-48EB-B4E4-5D4377062A7F" library_target="upload_image"> <system xmlns="http://www.eiffel.com/developers/xml/configuration-1-12-0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.eiffel.com/developers/xml/configuration-1-12-0 http://www.eiffel.com/developers/xml/configuration-1-12-0.xsd" name="upload_image" uuid="F2400BE8-D8EB-48EB-B4E4-5D4377062A7F" library_target="upload_image">
<target name="upload_image"> <target name="upload_image_common">
<root class="IMAGE_UPLOADER" feature="make"/>
<file_rule> <file_rule>
<exclude>/EIFGENs$</exclude> <exclude>/EIFGENs$</exclude>
<exclude>/\.git$</exclude> <exclude>/\.git$</exclude>
@@ -11,14 +10,26 @@
<debug name="standalone" enabled="true"/> <debug name="standalone" enabled="true"/>
<assertions precondition="true" postcondition="true" check="true" invariant="true" supplier_precondition="true"/> <assertions precondition="true" postcondition="true" check="true" invariant="true" supplier_precondition="true"/>
</option> </option>
<setting name="concurrency" value="thread"/> <setting name="concurrency" value="scoop"/>
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf" readonly="false" use_application_options="true"/>
<library name="encoder" location="..\..\library\text\encoder\encoder-safe.ecf" readonly="false"/> <library name="encoder" location="..\..\library\text\encoder\encoder-safe.ecf" readonly="false"/>
<library name="http" location="..\..\library\network\protocol\http\http-safe.ecf" readonly="false"/> <library name="http" location="..\..\library\network\protocol\http\http-safe.ecf" readonly="false"/>
<library name="testing" location="$ISE_LIBRARY\library\testing\testing-safe.ecf"/> <library name="testing" location="$ISE_LIBRARY\library\testing\testing-safe.ecf"/>
<library name="uri_template" location="..\..\library\text\parser\uri_template\uri_template-safe.ecf" readonly="false"/> <library name="uri_template" location="..\..\library\text\parser\uri_template\uri_template-safe.ecf" readonly="false"/>
<library name="wsf" location="..\..\library\server\wsf\wsf-safe.ecf" readonly="false" use_application_options="true"/> <library name="wsf" location="..\..\library\server\wsf\wsf-safe.ecf" readonly="false" use_application_options="true"/>
</target>
<target name="upload_image_standalone" extends="upload_image_common">
<root class="IMAGE_UPLOADER" feature="make"/>
<setting name="concurrency" value="thread"/>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf" readonly="false" use_application_options="true"/>
<cluster name="src" location="src\" recursive="true"/> <cluster name="src" location="src\" recursive="true"/>
</target> </target>
<target name="upload_image_libfcgi" extends="upload_image_common">
<root class="IMAGE_UPLOADER" feature="make"/>
<setting name="concurrency" value="none"/>
<library name="default_libfcgi" location="..\..\library\server\wsf\default\libfcgi-safe.ecf" readonly="false" use_application_options="true"/>
<cluster name="src" location="src\" recursive="true"/>
</target>
<target name="upload_image" extends="upload_image_standalone">
</target>
</system> </system>

View File

@@ -23,8 +23,8 @@ feature {NONE} -- Initialization
local local
n: INTEGER n: INTEGER
p: like pool p: like pool
do do
n := max_concurrent_connections (server) n := max_concurrent_connections (server).max (1) -- At least one processor!
create p.make (n) create p.make (n)
initialize_pool (p, n) initialize_pool (p, n)
pool := p pool := p

View File

@@ -23,7 +23,7 @@ feature {NONE} -- Initialization
local local
n: INTEGER n: INTEGER
do do
n := max_concurrent_connections (server) n := max_concurrent_connections (server).max (1) -- At least one thread!
create pool.make (n.to_natural_32) create pool.make (n.to_natural_32)
end end

View File

@@ -10,17 +10,26 @@ feature {NONE} -- Initialization
make make
do do
http_server_port := 80 http_server_port := default_http_server_port
max_concurrent_connections := 100 max_concurrent_connections := default_max_concurrent_connections
max_tcp_clients := 100 max_tcp_clients := default_max_tcp_clients
socket_accept_timeout := 1_000 socket_timeout := default_socket_timeout
socket_connect_timeout := 5_000 keep_alive_timeout := default_keep_alive_timeout
keep_alive_timeout := 5 max_keep_alive_requests := default_max_keep_alive_requests
is_secure := False is_secure := False
create ca_crt.make_empty create ca_crt.make_empty
create ca_key.make_empty create ca_key.make_empty
end end
feature -- Defaults
default_http_server_port: INTEGER = 80
default_max_concurrent_connections: INTEGER = 100
default_max_tcp_clients: INTEGER = 100
default_socket_timeout: INTEGER = 300 -- seconds
default_keep_alive_timeout: INTEGER = 15 -- seconds
default_max_keep_alive_requests: INTEGER = 100
feature -- Access feature -- Access
Server_details: STRING_8 Server_details: STRING_8
@@ -31,26 +40,53 @@ feature -- Access
http_server_name: detachable READABLE_STRING_8 assign set_http_server_name http_server_name: detachable READABLE_STRING_8 assign set_http_server_name
http_server_port: INTEGER assign set_http_server_port http_server_port: INTEGER assign set_http_server_port
max_tcp_clients: INTEGER assign set_max_tcp_clients max_tcp_clients: INTEGER assign set_max_tcp_clients
-- Listen on socket for at most `queue' connections.
socket_timeout: INTEGER assign set_socket_timeout
-- Amount of seconds that the server waits for receipts and transmissions during communications.
-- note: with timeout of 0, socket can wait for ever.
-- By default: 300 seconds, which is appropriate for most situations.
max_concurrent_connections: INTEGER assign set_max_concurrent_connections max_concurrent_connections: INTEGER assign set_max_concurrent_connections
socket_accept_timeout: INTEGER assign set_socket_accept_timeout -- Max number of concurrent connections.
socket_connect_timeout: INTEGER assign set_socket_connect_timeout
force_single_threaded: BOOLEAN assign set_force_single_threaded force_single_threaded: BOOLEAN assign set_force_single_threaded
do do
Result := (max_concurrent_connections = 0) Result := max_concurrent_connections = 0
end end
is_verbose: BOOLEAN assign set_is_verbose is_verbose: BOOLEAN assign set_is_verbose
-- Display verbose message to the output? -- Display verbose message to the output?
verbose_level: INTEGER assign set_verbose_level
-- Verbosity of output.
keep_alive_timeout: INTEGER assign set_keep_alive_timeout keep_alive_timeout: INTEGER assign set_keep_alive_timeout
-- Persistent connection timeout -- Persistent connection timeout.
-- Number of seconds the server waits after a request has been served before it closes the connection.
-- Timeout unit in Seconds. -- Timeout unit in Seconds.
-- By default: 5 seconds.
max_keep_alive_requests: INTEGER assign set_max_keep_alive_requests
-- Maximum number of requests allowed per persistent connection.
-- Recommended a high setting.
-- To disable KeepAlive, set `max_keep_alive_requests' to 0.
-- By default: 100 .
has_ssl_support: BOOLEAN has_ssl_support: BOOLEAN
-- Has SSL support? -- Has SSL support?
deferred deferred
end end
request_settings: HTTPD_REQUEST_SETTINGS
do
Result.is_verbose := is_verbose
Result.verbose_level := verbose_level
Result.timeout := socket_timeout
Result.keep_alive_timeout := keep_alive_timeout
Result.max_keep_alive_requests := max_keep_alive_requests
end
feature -- Access: SSL feature -- Access: SSL
is_secure: BOOLEAN is_secure: BOOLEAN
@@ -74,7 +110,6 @@ feature -- Element change
else else
create {IMMUTABLE_STRING_8} http_server_name.make_from_separate (v) create {IMMUTABLE_STRING_8} http_server_name.make_from_separate (v)
end end
--| Missing postcondition.
end end
unset_http_server_name unset_http_server_name
@@ -109,23 +144,35 @@ feature -- Element change
max_concurrent_connections_set : max_concurrent_connections = v max_concurrent_connections_set : max_concurrent_connections = v
end end
set_socket_accept_timeout (v: like socket_accept_timeout) set_socket_timeout (a_nb_seconds: like socket_timeout)
-- Set `socket_accept_timeout' with `v' -- Set `socket_timeout' with `a_nb_seconds'
do do
socket_accept_timeout := v socket_timeout := a_nb_seconds
ensure ensure
socket_accept_timeout_set: socket_accept_timeout = v socket_timeout_set: socket_timeout = a_nb_seconds
end end
set_socket_connect_timeout (v: like socket_connect_timeout) set_keep_alive_timeout (a_seconds: like keep_alive_timeout)
-- Set `socket_connect_timeout' with `v' -- Set `keep_alive_timeout' with `a_seconds'
do do
socket_connect_timeout := v keep_alive_timeout := a_seconds
ensure ensure
socket_connect_timeout_set: socket_connect_timeout = v keep_alive_timeout_set: keep_alive_timeout = a_seconds
end
set_max_keep_alive_requests (nb: like max_keep_alive_requests)
-- Set `max_keep_alive_requests' with `nb'
do
max_keep_alive_requests := nb
ensure
max_keep_alive_requests_set: max_keep_alive_requests = nb
end end
set_force_single_threaded (v: like force_single_threaded) set_force_single_threaded (v: like force_single_threaded)
-- Force server to handle incoming request in a single thread.
-- i.e set max_concurrent_connections to 0!
obsolete
"Use set_max_concurrent_connections (0) [June/2016]"
do do
if v then if v then
set_max_concurrent_connections (0) set_max_concurrent_connections (0)
@@ -143,12 +190,12 @@ feature -- Element change
is_verbose_set: is_verbose = b is_verbose_set: is_verbose = b
end end
set_keep_alive_timeout (a_seconds: like keep_alive_timeout) set_verbose_level (lev: INTEGER)
-- Set `keep_alive_timeout' with `a_seconds' -- Set `verbose_level' to `lev'.
do do
keep_alive_timeout := a_seconds verbose_level := lev
ensure ensure
keep_alive_timeout_set: keep_alive_timeout = a_seconds verbose_level_set: verbose_level = lev
end end
mark_secure mark_secure

View File

@@ -0,0 +1,64 @@
note
description: "[
Request settings for the standalone HTTPd server.
]"
author: "$Author$"
date: "$Date$"
revision: "$Revision$"
expanded class
HTTPD_REQUEST_SETTINGS
feature -- Access
is_verbose: BOOLEAN assign set_is_verbose
-- Is verbose?
verbose_level: INTEGER assign set_verbose_level
-- Verbosity of output.
timeout: INTEGER assign set_timeout
-- Amount of seconds that the server waits for receipts and transmissions during communications.
keep_alive_timeout: INTEGER assign set_keep_alive_timeout
-- Keep-alive timeout, also known as persistent-connection timeout.
-- Number of seconds the server waits after a request has been served before it closes the connection.
-- Unit in Seconds.
max_keep_alive_requests: INTEGER assign set_max_keep_alive_requests
-- Maximum number of requests allowed per persistent connection.
feature -- Change
set_is_verbose (b: BOOLEAN)
-- Set `is_verbose' to `b'.
do
is_verbose := b
end
set_verbose_level (lev: INTEGER)
-- Set `verbose_level' to `lev'.
do
verbose_level := lev
end
set_timeout (a_timeout_in_seconds: INTEGER)
-- Set `timeout' to `a_timeout_in_seconds'.
do
timeout := a_timeout_in_seconds
end
set_keep_alive_timeout (a_timeout_in_seconds: INTEGER)
-- Set `keep_alive_timeout' to `a_timeout_in_seconds'.
do
keep_alive_timeout := a_timeout_in_seconds
end
set_max_keep_alive_requests (nb: like max_keep_alive_requests)
-- Set `max_keep_alive_requests' with `nb'
do
max_keep_alive_requests := nb
end
end

View File

@@ -0,0 +1,22 @@
note
description: "[
Constant value to define the logging level.
]"
date: "$Date$"
revision: "$Revision$"
deferred class
HTTPD_LOGGER_CONSTANTS
feature -- Access
alert_level: INTEGER = 1 -- 0000 0001
critical_level: INTEGER = 2 -- 0000 0010
error_level: INTEGER = 4 -- 0000 0100
warning_level: INTEGER = 8 -- 0000 1000
notice_level: INTEGER = 16 -- 0001 0000
information_level: INTEGER = 32 -- 0010 0000
debug_level: INTEGER = 64 -- 0100 0000
end

View File

@@ -9,11 +9,20 @@ deferred class
inherit inherit
HTTPD_DEBUG_FACILITIES HTTPD_DEBUG_FACILITIES
HTTPD_LOGGER_CONSTANTS
feature {NONE} -- Initialization feature {NONE} -- Initialization
make make (a_request_settings: HTTPD_REQUEST_SETTINGS)
do do
reset reset
-- Import global request settings.
timeout := a_request_settings.timeout -- seconds
keep_alive_timeout := a_request_settings.keep_alive_timeout -- seconds
max_keep_alive_requests := a_request_settings.max_keep_alive_requests
is_verbose := a_request_settings.is_verbose
verbose_level := a_request_settings.verbose_level
end end
reset reset
@@ -107,16 +116,29 @@ feature -- Access
feature -- Settings feature -- Settings
is_verbose: BOOLEAN is_verbose: BOOLEAN
-- Output messages?
verbose_level: INTEGER
-- Output verbosity.
is_persistent_connection_supported: BOOLEAN is_persistent_connection_supported: BOOLEAN
-- Is persistent connection supported? -- Is persistent connection supported?
do do
Result := {HTTPD_SERVER}.is_persistent_connection_supported Result := {HTTPD_SERVER}.is_persistent_connection_supported and then max_keep_alive_requests > 0
end end
persistent_connection_timeout: INTEGER = 5 -- seconds is_next_persistent_connection_supported: BOOLEAN
-- Is next persistent connection supported?
-- note: it is relevant only if `is_persistent_connection_supported' is True.
timeout: INTEGER -- seconds
-- Amount of seconds that the server waits for receipts and transmissions during communications.
max_keep_alive_requests: INTEGER
-- Maximum number of requests allowed per persistent connection.
keep_alive_timeout: INTEGER -- seconds
-- Number of seconds for persistent connection timeout. -- Number of seconds for persistent connection timeout.
-- Default: 5 sec.
feature -- Status report feature -- Status report
@@ -162,7 +184,7 @@ feature -- Execution
local local
l_socket: like client_socket l_socket: like client_socket
l_exit: BOOLEAN l_exit: BOOLEAN
n: INTEGER n,m: INTEGER
do do
l_socket := client_socket l_socket := client_socket
check check
@@ -172,15 +194,21 @@ feature -- Execution
from from
-- Process persistent connection as long the socket is not closed. -- Process persistent connection as long the socket is not closed.
n := 0 n := 0
m := max_keep_alive_requests
is_next_persistent_connection_supported := True
until until
l_exit l_exit
loop loop
n := n + 1 n := n + 1
if n >= m then
is_next_persistent_connection_supported := False
end
-- FIXME: it seems to be called one more time, mostly to see this is done. -- FIXME: it seems to be called one more time, mostly to see this is done.
execute_request execute_request
l_exit := not is_persistent_connection_supported l_exit := not is_persistent_connection_supported
or has_error or l_socket.is_closed or not l_socket.is_open_read or not is_next_persistent_connection_supported -- related to `max_keep_alive_requests'
or not is_persistent_connection_requested or not is_persistent_connection_requested
or has_error or l_socket.is_closed or not l_socket.is_open_read
reset_request reset_request
end end
end end
@@ -192,7 +220,6 @@ feature -- Execution
l_remote_info: detachable like remote_info l_remote_info: detachable like remote_info
l_socket: like client_socket l_socket: like client_socket
l_is_ready: BOOLEAN l_is_ready: BOOLEAN
i: INTEGER
do do
l_socket := client_socket l_socket := client_socket
check check
@@ -210,19 +237,11 @@ feature -- Execution
--| TODO: add configuration options for socket timeout. --| TODO: add configuration options for socket timeout.
--| set by default 5 seconds. --| set by default 5 seconds.
-- l_socket.set_timeout (persistent_connection_timeout) -- 5 seconds! l_socket.set_timeout (keep_alive_timeout) -- 5 seconds!
l_socket.set_timeout (1) -- 1 second! l_is_ready := l_socket.ready_for_reading
from
i := persistent_connection_timeout -- * 1 sec
until
l_is_ready or i <= 0 or has_error
loop
l_is_ready := l_socket.ready_for_reading
check not l_socket.is_closed end
i := i - 1
end
if l_is_ready then if l_is_ready then
l_socket.set_timeout (timeout) -- FIXME: return a 408 Request Timeout response ..
create l_remote_info create l_remote_info
if attached l_socket.peer_address as l_addr then if attached l_socket.peer_address as l_addr then
l_remote_info.addr := l_addr.host_address.host_address l_remote_info.addr := l_addr.host_address.host_address
@@ -242,10 +261,13 @@ feature -- Execution
if l_is_ready then if l_is_ready then
-- check catch_bad_incoming_connection: False end -- check catch_bad_incoming_connection: False end
if is_verbose then if is_verbose then
log ("ERROR: invalid HTTP incoming request") log (request_header + "%NWARNING: invalid HTTP incoming request", warning_level)
end end
end end
else else
if is_verbose then
log (request_header, information_level)
end
process_request (l_socket) process_request (l_socket)
end end
debug ("dbglog") debug ("dbglog")
@@ -289,7 +311,12 @@ feature -- Parsing
do do
create txt.make (64) create txt.make (64)
request_header := txt request_header := txt
if a_socket.is_readable and then attached next_line (a_socket) as l_request_line and then not l_request_line.is_empty then if
not has_error and then
a_socket.is_readable and then
attached next_line (a_socket) as l_request_line and then
not l_request_line.is_empty
then
txt.append (l_request_line) txt.append (l_request_line)
txt.append_character ('%N') txt.append_character ('%N')
analyze_request_line (l_request_line) analyze_request_line (l_request_line)
@@ -302,11 +329,13 @@ feature -- Parsing
from from
line := next_line (a_socket) line := next_line (a_socket)
until until
line = Void or end_of_stream line = Void or end_of_stream or has_error
loop loop
n := line.count n := line.count
if l_is_verbose then debug ("ew_standalone")
log (line) if l_is_verbose then
log (line, debug_level)
end
end end
pos := line.index_of (':', 1) pos := line.index_of (':', 1)
if pos > 0 then if pos > 0 then
@@ -353,9 +382,11 @@ feature -- Parsing
local local
n, pos, next_pos: INTEGER n, pos, next_pos: INTEGER
do do
if is_verbose then debug ("ew_standalone")
log ("%N## Parse HTTP request line ##") if is_verbose then
log (line) log ("%N## Parse HTTP request line ##", debug_level)
log (line, debug_level)
end
end end
pos := line.index_of (' ', 1) pos := line.index_of (' ', 1)
method := line.substring (1, pos - 1) method := line.substring (1, pos - 1)
@@ -372,15 +403,31 @@ feature -- Parsing
next_line (a_socket: HTTPD_STREAM_SOCKET): detachable STRING next_line (a_socket: HTTPD_STREAM_SOCKET): detachable STRING
-- Next line fetched from `a_socket' is available. -- Next line fetched from `a_socket' is available.
require require
not_has_error: not has_error or is_verbose
is_readable: a_socket.is_open_read is_readable: a_socket.is_open_read
local local
retried: BOOLEAN retried: BOOLEAN
do do
if retried then if retried then
has_error := True
Result := Void Result := Void
elseif a_socket.socket_ok then elseif a_socket.readable then
a_socket.read_line_thread_aware a_socket.read_line_thread_aware
Result := a_socket.last_string Result := a_socket.last_string
-- Do no check `socket_ok' before socket operation,
-- otherwise it may be False, due to error during other socket operation in same thread.
if not a_socket.socket_ok then
has_error := True
if is_verbose then
log (request_header +"%N" + Result + "%N## socket_ok=False! ##", debug_level)
end
end
else
-- Error with socket...
has_error := True
if is_verbose then
log (request_header + "%N## Socket is not readable! ##", debug_level)
end
end end
rescue rescue
retried := True retried := True
@@ -399,13 +446,17 @@ feature -- Output
logger_set: logger = a_logger logger_set: logger = a_logger
end end
log (m: STRING) log (m: STRING; a_level: INTEGER)
-- Log message `m'. -- Log message `m'.
require
is_verbose: is_verbose
do do
if attached logger as l_logger then if is_verbose and (verbose_level & a_level) = a_level then
l_logger.log (m) if attached logger as l_logger then
else l_logger.log (m)
io.put_string (m + "%N") else
io.put_string (m + "%N")
end
end end
end end

View File

@@ -37,7 +37,7 @@ feature {NONE} -- Initialization
build_controller build_controller
-- Build `controller'. -- Build `controller'.
do do
create controller create <NONE> controller
end end
initialize initialize
@@ -51,6 +51,9 @@ feature -- Access
is_verbose: BOOLEAN is_verbose: BOOLEAN
-- Is verbose for output messages. -- Is verbose for output messages.
verbose_level: INTEGER
-- Verbosity of output.
configuration: HTTPD_CONFIGURATION configuration: HTTPD_CONFIGURATION
-- Associated server configuration. -- Associated server configuration.
@@ -100,7 +103,16 @@ feature -- Execution
apply_configuration apply_configuration
is_terminated := False is_terminated := False
if is_verbose then if is_verbose then
log ("%N%NStarting Web Application Server (port=" + configuration.http_server_port.out + "):%N") log ("%N%NStarting Web Application Server ...")
log (" - port = " + configuration.http_server_port.out)
log (" - max_tcp_clients = " + configuration.max_tcp_clients.out)
log (" - max_concurrent_connections = " + configuration.max_concurrent_connections.out)
log (" - socket_timeout = " + configuration.socket_timeout.out + " seconds")
log (" - keep_alive_timeout = " + configuration.keep_alive_timeout.out + " seconds")
log (" - max_keep_alive_requests = " + configuration.max_keep_alive_requests.out)
if configuration.verbose_level > 0 then
log (" - verbose_level = " + configuration.verbose_level.out)
end
end end
is_shutdown_requested := False is_shutdown_requested := False
listen listen
@@ -150,7 +162,7 @@ feature -- Listening
if not l_listening_socket.is_bound then if not l_listening_socket.is_bound then
if is_verbose then if is_verbose then
log ("Socket could not be bound on port " + l_http_port.out) log ("Socket could not be bound on port " + l_http_port.out + " !")
end end
else else
l_http_port := l_listening_socket.port l_http_port := l_listening_socket.port
@@ -159,9 +171,9 @@ feature -- Listening
l_listening_socket.listen (configuration.max_tcp_clients) l_listening_socket.listen (configuration.max_tcp_clients)
if is_verbose then if is_verbose then
if configuration.is_secure then if configuration.is_secure then
log ("%NHTTP Connection Server ready on port " + l_http_port.out +" : https://localhost:" + l_http_port.out + "/") log ("%NListening on port " + l_http_port.out +" : https://localhost:" + l_http_port.out + "/")
else else
log ("%NHTTP Connection Server ready on port " + l_http_port.out +" : http://localhost:" + l_http_port.out + "/") log ("%NListening on port " + l_http_port.out +" : http://localhost:" + l_http_port.out + "/")
end end
end end
on_launched (l_http_port) on_launched (l_http_port)
@@ -312,6 +324,7 @@ feature -- Configuration change
is_not_launched: not is_launched is_not_launched: not is_launched
do do
is_verbose := configuration.is_verbose is_verbose := configuration.is_verbose
verbose_level := configuration.verbose_level
end end
feature -- Output feature -- Output

View File

@@ -24,13 +24,10 @@ create
feature {NONE} -- Initialization feature {NONE} -- Initialization
make_with_connector (conn: like connector) make_with_connector (a_request_settings: HTTPD_REQUEST_SETTINGS; conn: like connector)
do do
make make (a_request_settings)
connector := conn connector := conn
-- if conn /= Void then
-- set_is_verbose (is_connector_verbose (conn))
-- end
end end
feature -- Access feature -- Access
@@ -56,11 +53,6 @@ feature -- SCOOP helpers
Result := conn.base Result := conn.base
end end
is_connector_verbose (conn: separate WGI_STANDALONE_CONNECTOR [G]): BOOLEAN
do
Result := conn.is_verbose
end
feature -- Request processing feature -- Request processing
process_request (a_socket: HTTPD_STREAM_SOCKET) process_request (a_socket: HTTPD_STREAM_SOCKET)
@@ -87,7 +79,7 @@ feature -- Request processing
else else
l_output.set_http_version (version) l_output.set_http_version (version)
end end
res.set_is_persistent_connection_supported ({HTTPD_SERVER}.is_persistent_connection_supported) res.set_is_persistent_connection_supported (is_persistent_connection_supported and is_next_persistent_connection_supported)
res.set_is_persistent_connection_requested (is_persistent_connection_requested) res.set_is_persistent_connection_requested (is_persistent_connection_requested)
req.set_meta_string_variable ("RAW_HEADER_DATA", request_header) req.set_meta_string_variable ("RAW_HEADER_DATA", request_header)

View File

@@ -1,5 +1,5 @@
note note
description: "Implementation of WGI request handler factory for WGI_STANDALOE_CONNECTOR." description: "Implementation of WGI request handler factory for WGI_STANDALONE_CONNECTOR."
date: "$Date$" date: "$Date$"
revision: "$Revision$" revision: "$Revision$"
@@ -14,19 +14,23 @@ feature -- Access
connector: detachable separate WGI_STANDALONE_CONNECTOR [G] connector: detachable separate WGI_STANDALONE_CONNECTOR [G]
-- httpd solution. -- httpd solution.
request_settings: HTTPD_REQUEST_SETTINGS
-- Settings specific to request handling.
feature -- Element change feature -- Element change
set_connector (conn: like connector) update_with (conn: like connector; a_conf: separate HTTPD_CONFIGURATION)
-- Set `connector' with `conn'. -- Set `connector' with `conn'.
do do
connector := conn connector := conn
request_settings := a_conf.request_settings
end end
feature -- Factory feature -- Factory
new_handler: separate WGI_HTTPD_REQUEST_HANDLER [G] new_handler: separate WGI_HTTPD_REQUEST_HANDLER [G]
do do
create Result.make_with_connector (connector) create Result.make_with_connector (request_settings, connector)
end end
note note

View File

@@ -26,12 +26,12 @@ feature {NONE} -- Initialization
create on_launched_actions create on_launched_actions
-- Server -- Server
create fac create <NONE> fac
request_handler_factory := fac
create server.make (fac) create server.make (fac)
create observer create <NONE> observer
configuration := server_configuration (server) configuration := server_configuration (server)
controller := server_controller (server) controller := server_controller (server)
set_factory_connector (Current, fac)
initialize_server (server) initialize_server (server)
end end
@@ -51,9 +51,9 @@ feature {NONE} -- Separate helper
a_server.set_observer (observer) a_server.set_observer (observer)
end end
set_factory_connector (conn: detachable separate WGI_STANDALONE_CONNECTOR [G]; fac: separate WGI_HTTPD_REQUEST_HANDLER_FACTORY [G]) update_factory (conn: detachable separate WGI_STANDALONE_CONNECTOR [G]; fac: separate WGI_HTTPD_REQUEST_HANDLER_FACTORY [G]; a_conf: separate HTTPD_CONFIGURATION)
do do
fac.set_connector (conn) fac.update_with (conn, a_conf)
end end
server_configuration (a_server: like server): like configuration server_configuration (a_server: like server): like configuration
@@ -74,6 +74,9 @@ feature -- Access
server: separate HTTPD_SERVER server: separate HTTPD_SERVER
-- HTTPd server object. -- HTTPd server object.
request_handler_factory: separate WGI_HTTPD_REQUEST_HANDLER_FACTORY [G]
-- Factory for request handlers.
controller: separate HTTPD_CONTROLLER controller: separate HTTPD_CONTROLLER
-- Controller used to shutdown server. -- Controller used to shutdown server.
@@ -97,9 +100,6 @@ feature -- Status report
-- Listening port. -- Listening port.
--| 0: not launched --| 0: not launched
is_verbose: BOOLEAN
-- Is verbose?
feature -- Callbacks feature -- Callbacks
on_launched_actions: ACTION_SEQUENCE [TUPLE [WGI_STANDALONE_CONNECTOR [WGI_EXECUTION]]] on_launched_actions: ACTION_SEQUENCE [TUPLE [WGI_STANDALONE_CONNECTOR [WGI_EXECUTION]]]
@@ -190,18 +190,22 @@ feature {NONE} -- Implementation
Result := a_server.controller Result := a_server.controller
end end
configure_server (a_configuration: like configuration) apply_configuration (a_configuration: like configuration)
local
v: BOOLEAN
do do
if a_configuration.is_verbose then v := a_configuration.is_verbose
if attached base as l_base then if v then
if attached base as l_base and then not l_base.is_whitespace then
io.error.put_string ("Base=" + l_base + "%N") io.error.put_string ("Base=" + l_base + "%N")
end end
end end
update_factory (Current, request_handler_factory, a_configuration)
end end
launch_server (a_server: like server) launch_server (a_server: like server)
do do
configure_server (a_server.configuration) apply_configuration (a_server.configuration)
a_server.launch a_server.launch
end end
@@ -229,7 +233,6 @@ feature {NONE} -- Implementation: element change
set_is_verbose_on_configuration (b: BOOLEAN; cfg: like configuration) set_is_verbose_on_configuration (b: BOOLEAN; cfg: like configuration)
do do
is_verbose := b
cfg.set_is_verbose (b) cfg.set_is_verbose (b)
end end

View File

@@ -0,0 +1,10 @@
note
description: "Export HTTPD_LOGGER_CONSTANTS to Standlone connector interfaces."
class
WGI_STANDALONE_HTTPD_LOGGER_CONSTANTS
inherit
HTTPD_LOGGER_CONSTANTS
end

View File

@@ -108,7 +108,6 @@ feature -- Header output operation
l_connection := s.substring (i + 12, j - 1) l_connection := s.substring (i + 12, j - 1)
l_connection.adjust l_connection.adjust
if if
not is_http_version_1_0 and
not l_connection.is_case_insensitive_equal_general ("close") not l_connection.is_case_insensitive_equal_general ("close")
then then
s.replace_substring ("Connection: close", i + 1, j - 1) s.replace_substring ("Connection: close", i + 1, j - 1)

View File

@@ -24,11 +24,11 @@
<platform value="windows"/> <platform value="windows"/>
</condition> </condition>
</external_library> </external_library>
<external_library location="/usr/lib/libfcgi.so"> <external_linker_flag value="-lfcgi">
<condition> <condition>
<platform value="unix"/> <platform value="unix"/>
</condition> </condition>
</external_library> </external_linker_flag>
<external_library location="/opt/local/lib/libfcgi.dylib"> <external_library location="/opt/local/lib/libfcgi.dylib">
<condition> <condition>
<platform value="macintosh"/> <platform value="macintosh"/>

View File

@@ -25,11 +25,11 @@
<platform value="windows"/> <platform value="windows"/>
</condition> </condition>
</external_library> </external_library>
<external_library location="/usr/lib/libfcgi.so"> <external_linker_flag value="-lfcgi">
<condition> <condition>
<platform value="unix"/> <platform value="unix"/>
</condition> </condition>
</external_library> </external_linker_flag>
<external_library location="/opt/local/lib/libfcgi.dylib"> <external_library location="/opt/local/lib/libfcgi.dylib">
<condition> <condition>
<platform value="macintosh"/> <platform value="macintosh"/>

View File

@@ -25,6 +25,8 @@ inherit
launchable launchable
end end
WGI_STANDALONE_HTTPD_LOGGER_CONSTANTS
create create
make, make,
make_and_launch make_and_launch
@@ -34,38 +36,68 @@ feature {NONE} -- Initialization
initialize initialize
local local
conn: like connector conn: like connector
s: READABLE_STRING_GENERAL
do do
create on_launched_actions create on_launched_actions
create on_stopped_actions create on_stopped_actions
port_number := 80 --| Default, but quite often, this port is already used ... port_number := 80 --| Default, but quite often, this port is already used ...
max_concurrent_connections := 100
max_tcp_clients := 100
socket_timeout := 300 -- 300 seconds
keep_alive_timeout := 15 -- 15 seconds.
max_keep_alive_requests := 100
verbose := False
verbose_level := notice_level
base_url := "" base_url := ""
if attached options as opts then if attached options as opts then
if attached {READABLE_STRING_GENERAL} opts.option ("server_name") as l_server_name then if attached {READABLE_STRING_GENERAL} opts.option ("server_name") as l_server_name then
server_name := l_server_name.to_string_8 server_name := l_server_name.to_string_8
end end
if attached {INTEGER} opts.option ("port") as l_port then
port_number := l_port
elseif
attached {READABLE_STRING_GENERAL} opts.option ("port") as l_port_str and then
l_port_str.is_integer
then
port_number := l_port_str.as_string_8.to_integer
end
if attached {READABLE_STRING_GENERAL} opts.option ("base") as l_base_str then if attached {READABLE_STRING_GENERAL} opts.option ("base") as l_base_str then
base_url := l_base_str.as_string_8 base_url := l_base_str.as_string_8
end end
if attached {BOOLEAN} opts.option ("force_single_threaded") as l_single_threaded then verbose := opts.option_boolean_value ("verbose", verbose)
single_threaded := l_single_threaded -- See `{HTTPD_REQUEST_HANDLER_I}.*_verbose_level`
elseif attached {READABLE_STRING_GENERAL} opts.option ("force_single_threaded") as l_single_threaded_str then
single_threaded := l_single_threaded_str.as_lower.same_string ("true") if opts.has_integer_option ("verbose_level") then
verbose_level := opts.option_integer_value ("verbose_level", verbose_level)
elseif attached {READABLE_STRING_GENERAL} opts.option ("verbose_level") as s_verbose_level then
verbose_level := 0 -- Reset
across
s_verbose_level.split ('+') as ic
loop
s := ic.item
if s.is_case_insensitive_equal ("alert") then
verbose_level := verbose_level | alert_level
elseif s.is_case_insensitive_equal ("critical") then
verbose_level := verbose_level | critical_level
elseif s.is_case_insensitive_equal ("error") then
verbose_level := verbose_level | error_level
elseif s.is_case_insensitive_equal ("warning") then
verbose_level := verbose_level | warning_level
elseif s.is_case_insensitive_equal ("notice") then
verbose_level := verbose_level | notice_level
elseif s.is_case_insensitive_equal ("information") then
verbose_level := verbose_level | information_level
elseif s.is_case_insensitive_equal ("debug") then
verbose_level := verbose_level | debug_level
else
end
end
end end
if attached {BOOLEAN} opts.option ("verbose") as l_verbose then port_number := opts.option_integer_value ("port", port_number)
verbose := l_verbose
elseif attached {READABLE_STRING_GENERAL} opts.option ("verbose") as l_verbose_str then if opts.option_boolean_value ("force_single_threaded", False) then
verbose := l_verbose_str.as_lower.same_string ("true") force_single_threaded
end end
max_concurrent_connections := opts.option_integer_value ("max_concurrent_connections", max_concurrent_connections)
max_tcp_clients := opts.option_integer_value ("max_tcp_clients", max_tcp_clients)
socket_timeout := opts.option_integer_value ("socket_timeout", socket_timeout)
keep_alive_timeout := opts.option_integer_value ("keep_alive_timeout", keep_alive_timeout)
max_keep_alive_requests := opts.option_integer_value ("max_keep_alive_requests", max_keep_alive_requests)
end end
create conn.make create conn.make
@@ -76,18 +108,25 @@ feature {NONE} -- Initialization
update_configuration (conn.configuration) update_configuration (conn.configuration)
end end
force_single_threaded
-- Set `single_threaded' to True.
do
max_concurrent_connections := 1
end
feature -- Execution feature -- Execution
update_configuration (cfg: like connector.configuration) update_configuration (cfg: like connector.configuration)
do do
if single_threaded then
cfg.set_force_single_threaded (True)
end
cfg.set_is_verbose (verbose) cfg.set_is_verbose (verbose)
if attached server_name as l_server_name then cfg.set_verbose_level (verbose_level)
cfg.set_http_server_name (l_server_name) cfg.set_http_server_name (server_name)
end
cfg.http_server_port := port_number cfg.http_server_port := port_number
cfg.set_max_concurrent_connections (max_concurrent_connections)
cfg.set_max_tcp_clients (max_tcp_clients)
cfg.set_socket_timeout (socket_timeout)
cfg.set_keep_alive_timeout (keep_alive_timeout)
cfg.set_max_keep_alive_requests (max_keep_alive_requests)
end end
launch launch
@@ -98,7 +137,7 @@ feature -- Execution
do do
conn := connector conn := connector
conn.set_base (base_url) conn.set_base (base_url)
debug ("nino") debug ("ew_standalone")
if verbose then if verbose then
io.error.put_string ("Launching standalone web server on port " + port_number.out) io.error.put_string ("Launching standalone web server on port " + port_number.out)
if attached server_name as l_name then if attached server_name as l_name then
@@ -134,8 +173,20 @@ feature {NONE} -- Implementation
base_url: READABLE_STRING_8 base_url: READABLE_STRING_8
verbose: BOOLEAN verbose: BOOLEAN
verbose_level: INTEGER
-- Help defining the verbosity.
-- The higher, the more output.
max_concurrent_connections: INTEGER
max_tcp_clients: INTEGER
socket_timeout: INTEGER
keep_alive_timeout: INTEGER
max_keep_alive_requests: INTEGER
single_threaded: BOOLEAN single_threaded: BOOLEAN
do
Result := max_concurrent_connections = 0
end
feature -- Status report feature -- Status report

View File

@@ -62,6 +62,9 @@ feature {NONE} -- Implementation
a_handler.append_resource (req, res) a_handler.append_resource (req, res)
-- 200 or 204 or 303 or 500 (add support for this?) -- 200 or 204 or 303 or 500 (add support for this?)
-- FIXME: more support, such as includes_response_entity -- FIXME: more support, such as includes_response_entity
if not a_handler.response_ok (req) then
write_error_response (req, res)
end
end end
end end
end end

View File

@@ -62,6 +62,9 @@ feature {NONE} -- Implementation
a_handler.update_resource (req, res) a_handler.update_resource (req, res)
-- 204 or 500 (add support for this?) -- 204 or 500 (add support for this?)
-- FIXME: more support, such as includes_response_entity -- FIXME: more support, such as includes_response_entity
if not a_handler.response_ok (req) then
write_error_response (req, res)
end
end end
end end
end end

View File

@@ -83,6 +83,57 @@ feature -- Access
Result := options.item (a_name) Result := options.item (a_name)
end end
feature -- Helpers
has_integer_option (a_opt_name: READABLE_STRING_GENERAL): BOOLEAN
-- Is there any INTEGER value associated to option name `a_opt_name'?
local
s: READABLE_STRING_GENERAL
do
if attached option (a_opt_name) as opt then
if attached {INTEGER} opt as i then
Result := True
else
s := opt.out
Result := s.is_integer
end
end
end
option_integer_value (a_opt_name: READABLE_STRING_GENERAL; a_default: INTEGER): INTEGER
-- INTEGER value associated to option name `a_opt_name', other return `a_default'.
local
s: READABLE_STRING_GENERAL
do
Result := a_default
if attached option (a_opt_name) as opt then
if attached {INTEGER} opt as i then
Result := i
else
s := opt.out
if s.is_integer then
Result := s.to_integer
end
end
end
end
option_boolean_value (a_opt_name: READABLE_STRING_GENERAL; a_default: BOOLEAN): BOOLEAN
-- BOOLEAN value associated to option name `a_opt_name', other return `a_default'.
local
s: READABLE_STRING_GENERAL
do
Result := a_default
if attached option (a_opt_name) as opt then
if attached {BOOLEAN} opt as b then
Result := b
else
s := opt.out
Result := s.is_case_insensitive_equal ("true")
end
end
end
feature -- Access feature -- Access
new_cursor: TABLE_ITERATION_CURSOR [detachable ANY, READABLE_STRING_GENERAL] new_cursor: TABLE_ITERATION_CURSOR [detachable ANY, READABLE_STRING_GENERAL]

View File

@@ -10,7 +10,7 @@ class
inherit inherit
WSF_REQUEST WSF_REQUEST
create {WSF_TO_WGI_SERVICE, WSF_SERVICE} create {WSF_SERVICE}
make_from_wgi make_from_wgi
end end

Binary file not shown.