Compare commits

...

16 Commits

Author SHA1 Message Date
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
cc3c8af6b4 Updated HTTP_COOKIE implementation
- by default the Cookie does not set max-age and expires, so it defines a Session Cookie.
   (max_age and expires attributes are not included in the response)
 - set_* and unset_* features to define max_age and expire attributes.
 - marked old features as obsolete.
Updated test cases.

Signed-off-by: jvelilla <javier.hector@gmail.com>
2016-05-04 12:26:17 +02:00
b35ec65577 Updated EWF Windows tools to install EWF into EiffelStudio source tree. 2016-02-03 18:03:43 +01:00
4482520a86 Removed useless library declarations. 2016-02-03 15:12:54 +01:00
e9afc9ad17 Updated package.iron files. 2016-02-02 09:57:03 +01:00
55ab6969ee Do not html escape ' with &apos;
reason: the named character reference &apos; (the apostrophe, U+0027) was introduced in XML 1.0 but does not appear in HTML. Authors should therefore use &#39; instead of &apos; to work as expected in HTML 4 user agents.
2016-01-20 17:53:06 +01:00
40 changed files with 534 additions and 284 deletions

View File

@@ -8,7 +8,8 @@ note
title: Eiffel Nino Web Server title: Eiffel Nino Web Server
description: Simple HTTPd server written in Eiffel description: Simple HTTPd server written in Eiffel
tags: web, httpd, server tags: web, httpd, server
copyright: Javier Velilla, Jocelyn Fiat and Eiffel Software.
license: Eiffel Forum v2 license: Eiffel Forum v2
copyright: Javier Velilla, Jocelyn Fiat. link[license]: http://www.eiffel.com/licensing/forum.txt
end end

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:
Form Data
Request Heders
Query Parameters.
[Enter the documentation](./workbook.md)

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

@@ -10,11 +10,6 @@
</option> </option>
<setting name="concurrency" value="thread"/> <setting name="concurrency" value="thread"/>
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="connector_standalone" location="..\..\library\server\ewsgi\connectors\standalone\standalone-safe.ecf" readonly="false">
<option debug="true">
<debug name="standalone" enabled="true"/>
</option>
</library>
<library name="conneg" location="..\..\library\network\protocol\content_negotiation\conneg-safe.ecf"/> <library name="conneg" location="..\..\library\network\protocol\content_negotiation\conneg-safe.ecf"/>
<library name="crypto" location="$ISE_LIBRARY\unstable\library\text\encryption\crypto\crypto-safe.ecf" readonly="false"/> <library name="crypto" location="$ISE_LIBRARY\unstable\library\text\encryption\crypto\crypto-safe.ecf" readonly="false"/>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf" readonly="false"/> <library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf" readonly="false"/>

View File

@@ -7,7 +7,6 @@
</option> </option>
<setting name="concurrency" value="thread"/> <setting name="concurrency" value="thread"/>
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="connector_standalone" location="..\..\library\server\ewsgi\connectors\standalone\standalone-safe.ecf"/>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf"/> <library name="default_standalone" location="..\..\library\server\wsf\default\standalone-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"/>

View File

@@ -13,11 +13,6 @@
</option> </option>
<setting name="concurrency" value="thread"/> <setting name="concurrency" value="thread"/>
<library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/> <library name="base" location="$ISE_LIBRARY\library\base\base-safe.ecf"/>
<library name="connector_standalone" location="..\..\library\server\ewsgi\connectors\standalone\standalone-safe.ecf" readonly="false" use_application_options="true">
<option>
<assertions precondition="true" check="true" invariant="true" supplier_precondition="true"/>
</option>
</library>
<library name="default_standalone" location="..\..\library\server\wsf\default\standalone-safe.ecf" readonly="false" use_application_options="true"/> <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"/>

View File

@@ -3,13 +3,25 @@ package http_client
project project
http_client = "http_client-safe.ecf" http_client = "http_client-safe.ecf"
http_client = "http_client.ecf" http_client = "http_client.ecf"
libcurl_http_client = "libcurl_http_client-safe.ecf"
libcurl_http_client = "libcurl_http_client.ecf"
net_http_client = "net_http_client-safe.ecf"
net_http_client = "net_http_client.ecf"
note note
-- title: title: HTTP client
-- description: description: "[
-- tags: Provides simple routines to perform http requests, and get associated response.
-- license: It has two implementations:
-- copyright: - using Eiffel cURL (i.e libcurl)
-- link[doc]: "Documentation" http:// - using EiffelNET (and the EiffelNET SSL extension)
]"
collection:EWF
tags: http,client,network,request,web,curl,EWF
copyright: 1984-2016 Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/http_client
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/http_client/README.md
end end

View File

@@ -5,11 +5,16 @@ project
conneg = "conneg.ecf" conneg = "conneg.ecf"
note note
-- title: title: CONneg Content Negotiation
-- description: description: "[
-- tags: CONneg is a library that provides utilities to select the best repesentation of a resource for a client where there are multiple representations available.
-- license: ]"
-- copyright: collection: EWF
-- link[doc]: "Documentation" http:// tags: content,accept,conneg,negotiation,EWF,web,request
copyright: 2011-2016, Javier Velilla, Jocelyn Fiat, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/protocol/content_negotiation
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/protocol/content_negotiation/README.md
end end

View File

@@ -5,11 +5,22 @@ project
http = "http.ecf" http = "http.ecf"
note note
-- title: title: HTTP protocol
-- description: description: "[
-- tags: Collection of interfaces related to HTTP protocol:
-- license: - header
-- copyright: - status codes, request methods
-- link[doc]: "Documentation" http:// - content type, media type, mime type.
- cookie
- date used in web protocol
- file extension mime mapping
]"
collection: EWF
tags: http,web,header,status,method,type,mime,cookie
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/protocol/http
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/network/protocol/http/README.md
end end

View File

@@ -38,7 +38,7 @@ feature {NONE} -- Initialization
do do
set_name (a_name) set_name (a_name)
set_value(a_value) set_value(a_value)
set_max_age (-1) unset_max_age
ensure ensure
name_set: name = a_name name_set: name = a_name
value_set: value = a_value value_set: value = a_value
@@ -101,15 +101,6 @@ feature -- Access
end end
end end
include_max_age: BOOLEAN
-- Does the Set-Cookie header include Max-Age attribute?
--|By default will include both.
include_expires: BOOLEAN
-- Does the Set-Cookie header include Expires attribute?
--|By default will include both.
is_valid_rfc1123_date (a_string: READABLE_STRING_8): BOOLEAN is_valid_rfc1123_date (a_string: READABLE_STRING_8): BOOLEAN
-- Is the date represented by `a_string' a valid rfc1123 date? -- Is the date represented by `a_string' a valid rfc1123 date?
local local
@@ -119,10 +110,56 @@ feature -- Access
Result := not d.has_error and then d.rfc1123_string.same_string (a_string) Result := not d.has_error and then d.rfc1123_string.same_string (a_string)
end end
feature -- Obsolete query
include_max_age: BOOLEAN
obsolete
"Use `max_age > 0' [April-2016]"
do
Result := max_age > 0
end
include_expires: BOOLEAN
obsolete
"Use `expires /= Void' [April-2016]"
do
Result := expiration /= Void
end
feature -- Obsolete element change
mark_max_age
-- Set `max_age > 0'
-- Set `expires to void'
-- Set-Cookie will include only Max-Age attribute and not Expires.
obsolete
"Uset `set_max_age' and `unset_*' features to add or remove the attributes from the response header [April-2016]"
do
max_age := 1
expiration := Void
ensure
max_age_true: include_max_age
expire_false: not include_expires
end
mark_expires
-- Set `mark_age' to -1.
-- Set `expiration to a default date'
-- Set-Cookie will include only Expires attribute and not Max_Age.
obsolete
"Use `set_expiration' and `unset_*' features to add or remove the attribute from the response header [April-2016]"
do
max_age := -1
set_expiration_date (create {DATE_TIME}.make_now_utc)
ensure
expires_true: include_expires
max_age_false: not include_max_age
end
feature -- Change Element feature -- Change Element
set_name (a_name: READABLE_STRING_8) set_name (a_name: READABLE_STRING_8)
-- Set `name' with `a_name'. -- Set `name' to `a_name'.
require require
a_name_not_blank: a_name /= Void and then not a_name.is_whitespace a_name_not_blank: a_name /= Void and then not a_name.is_whitespace
a_name_has_valid_characters: a_name /= Void and then has_valid_characters (a_name) a_name_has_valid_characters: a_name /= Void and then has_valid_characters (a_name)
@@ -133,7 +170,7 @@ feature -- Change Element
end end
set_value (a_value: READABLE_STRING_8) set_value (a_value: READABLE_STRING_8)
-- Set `value' with `a_value'. -- Set `value' to `a_value'.
require require
a_value_has_valid_characters: a_value /= Void and then has_valid_characters (a_value) a_value_has_valid_characters: a_value /= Void and then has_valid_characters (a_value)
do do
@@ -143,7 +180,7 @@ feature -- Change Element
end end
set_expiration (a_date: READABLE_STRING_8) set_expiration (a_date: READABLE_STRING_8)
-- Set `expiration' with `a_date' -- Set `expiration' to RFC1123 date string `a_date'.
require require
rfc1133_date: a_date /= Void and then is_valid_rfc1123_date (a_date) rfc1133_date: a_date /= Void and then is_valid_rfc1123_date (a_date)
do do
@@ -153,7 +190,7 @@ feature -- Change Element
end end
set_expiration_date (a_date: DATE_TIME) set_expiration_date (a_date: DATE_TIME)
-- Set `expiration' with `a_date' -- Set `expiration' to `a_date'.
do do
set_expiration (date_to_rfc1123_http_date_format (a_date)) set_expiration (date_to_rfc1123_http_date_format (a_date))
ensure ensure
@@ -161,7 +198,7 @@ feature -- Change Element
end end
set_path (a_path: READABLE_STRING_8) set_path (a_path: READABLE_STRING_8)
-- Set `path' with `a_path' -- Set `path' to `a_path'.
do do
path := a_path path := a_path
ensure ensure
@@ -169,7 +206,7 @@ feature -- Change Element
end end
set_domain (a_domain: READABLE_STRING_8) set_domain (a_domain: READABLE_STRING_8)
-- Set `domain' with `a_domain' -- Set `domain' to `a_domain'.
-- Note: you should avoid using "localhost" as `domain' for local cookies -- Note: you should avoid using "localhost" as `domain' for local cookies
-- since they are not always handled by browser (for instance Chrome) -- since they are not always handled by browser (for instance Chrome)
require require
@@ -181,7 +218,7 @@ feature -- Change Element
end end
set_secure (a_secure: BOOLEAN) set_secure (a_secure: BOOLEAN)
-- Set `secure' with `a_secure' -- Set `secure' to `a_secure'.
do do
secure := a_secure secure := a_secure
ensure ensure
@@ -189,7 +226,7 @@ feature -- Change Element
end end
set_http_only (a_http_only: BOOLEAN) set_http_only (a_http_only: BOOLEAN)
-- Set `http_only' with `a_http_only' -- Set `http_only' to `a_http_only'.
do do
http_only := a_http_only http_only := a_http_only
ensure ensure
@@ -197,48 +234,29 @@ feature -- Change Element
end end
set_max_age (a_max_age: INTEGER) set_max_age (a_max_age: INTEGER)
-- Set `max_age' with `a_max_age' -- Set `max_age' to `a_max_age'.
require
valid_max_age: a_max_age >= 0
do do
max_age := a_max_age max_age := a_max_age
ensure ensure
max_age_set: max_age = a_max_age max_age_set: max_age = a_max_age
end end
unset_max_age
mark_max_age -- Set `max_age' to -1.
-- Set `include_max_age' to True.
-- Set `include_expires' to False.
-- Set-Cookie will include only Max-Age attribute and not Expires.
do do
include_max_age := True max_age := -1
include_expires := False
ensure ensure
max_age_true: include_max_age max_age_unset: max_age = -1
expire_false: not include_expires
end end
mark_expires unset_expiration
-- Set `include_expires' to True. -- Set `expiration' to Void.
-- Set `include_max_age' to False
-- Set-Cookie will include only Expires attribute and not Max_Age.
do do
include_expires := True expiration := Void
include_max_age := False
ensure ensure
expires_true: include_expires expiration_void: expiration = Void
max_age_false: not include_max_age
end
set_default_expires_max_age
-- Set `include_expires' to False.
-- Set `include_max_age' to False
-- Set-Cookie will include both Max-Age, Expires attributes.
do
include_expires := False
include_max_age := False
ensure
expires_false: not include_expires
max_age_false: not include_max_age
end end
feature {NONE} -- Date Utils feature {NONE} -- Date Utils
@@ -270,28 +288,14 @@ feature -- Output
s.append ("; Path=") s.append ("; Path=")
s.append (l_path) s.append (l_path)
end end
-- Expire
if include_expires then
if attached expiration as l_expires then
s.append ("; Expires=")
s.append (l_expires)
end
-- Max-Age
elseif include_max_age then
s.append ("; Max-Age=")
s.append_integer (max_age)
else
-- Default
check
-- By default the attributes include_expires and include_max_age are False.
-- Meaning that Expires and Max-Age headers are included in the response.
default: (not include_expires) and (not include_max_age)
end
if attached expiration as l_expires then
s.append ("; Expires=")
s.append (l_expires)
end
-- Expires
if attached expiration as l_expires then
s.append ("; Expires=")
s.append (l_expires)
end
-- Max-age
if max_age >= 0 then
s.append ("; Max-Age=") s.append ("; Max-Age=")
s.append_integer (max_age) s.append_integer (max_age)
end end
@@ -339,7 +343,7 @@ feature {NONE} -- Constants
end end
note note
copyright: "2011-2015, Jocelyn Fiat, Eiffel Software and others" copyright: "2011-2016, Jocelyn Fiat, Eiffel Software and others"
license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)" license: "Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)"
source: "[ source: "[
Eiffel Software Eiffel Software

View File

@@ -20,7 +20,7 @@ feature -- Test routines
l_cookie: HTTP_COOKIE l_cookie: HTTP_COOKIE
do do
create l_cookie.make ("user_id", "u12345") create l_cookie.make ("user_id", "u12345")
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Max-Age=-1")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345"))
end end
test_cookie_value_with_illegal_characters test_cookie_value_with_illegal_characters
@@ -42,7 +42,7 @@ feature -- Test routines
l_cookie: HTTP_COOKIE l_cookie: HTTP_COOKIE
do do
create l_cookie.make ("user_id", "") create l_cookie.make ("user_id", "")
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=; Max-Age=-1")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id="))
end end
test_cookie_full_attributes test_cookie_full_attributes
@@ -55,7 +55,8 @@ feature -- Test routines
l_cookie.set_path ("/") l_cookie.set_path ("/")
l_cookie.set_secure (True) l_cookie.set_secure (True)
l_cookie.set_http_only (True) l_cookie.set_http_only (True)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Expires=Sat, 18 Apr 2015 21:22:05 GMT; Max-Age=-1; Secure; HttpOnly")) l_cookie.set_max_age (1)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Expires=Sat, 18 Apr 2015 21:22:05 GMT; Max-Age=1; Secure; HttpOnly"))
end end
test_cookie_include_expires test_cookie_include_expires
@@ -68,7 +69,6 @@ feature -- Test routines
l_cookie.set_path ("/") l_cookie.set_path ("/")
l_cookie.set_secure (True) l_cookie.set_secure (True)
l_cookie.set_http_only (True) l_cookie.set_http_only (True)
l_cookie.mark_expires
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Expires=Sat, 18 Apr 2015 21:22:05 GMT; Secure; HttpOnly")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Expires=Sat, 18 Apr 2015 21:22:05 GMT; Secure; HttpOnly"))
end end
@@ -82,8 +82,8 @@ feature -- Test routines
l_cookie.set_path ("/") l_cookie.set_path ("/")
l_cookie.set_secure (True) l_cookie.set_secure (True)
l_cookie.set_http_only (True) l_cookie.set_http_only (True)
l_cookie.mark_max_age l_cookie.set_max_age (1)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Max-Age=-1; Secure; HttpOnly")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Expires=Sat, 18 Apr 2015 21:22:05 GMT; Max-Age=1; Secure; HttpOnly"))
end end
test_cookie_defaults_and_http_only test_cookie_defaults_and_http_only
@@ -92,7 +92,7 @@ feature -- Test routines
do do
create l_cookie.make ("user_id", "u12345") create l_cookie.make ("user_id", "u12345")
l_cookie.set_http_only (True) l_cookie.set_http_only (True)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Max-Age=-1; HttpOnly")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; HttpOnly"))
end end
test_cookie_defaults_and_secure test_cookie_defaults_and_secure
@@ -101,7 +101,7 @@ feature -- Test routines
do do
create l_cookie.make ("user_id", "u12345") create l_cookie.make ("user_id", "u12345")
l_cookie.set_secure (True) l_cookie.set_secure (True)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Max-Age=-1; Secure")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Secure"))
end end
@@ -111,7 +111,7 @@ feature -- Test routines
do do
create l_cookie.make ("user_id", "u12345") create l_cookie.make ("user_id", "u12345")
l_cookie.set_domain ("www.example.com") l_cookie.set_domain ("www.example.com")
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Max-Age=-1")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com"))
end end
@@ -121,7 +121,7 @@ feature -- Test routines
do do
create l_cookie.make ("user_id", "u12345") create l_cookie.make ("user_id", "u12345")
l_cookie.set_path ("/") l_cookie.set_path ("/")
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Path=/; Max-Age=-1")) assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Path=/"))
end end
test_cookie_default_and_custom_max_age test_cookie_default_and_custom_max_age
@@ -149,6 +149,18 @@ feature -- Test routines
assert ("Invalid RFC1123", not l_cookie.is_valid_rfc1123_date ("Thuesday, 19 Mar 2015 16:14:03 GMT")) assert ("Invalid RFC1123", not l_cookie.is_valid_rfc1123_date ("Thuesday, 19 Mar 2015 16:14:03 GMT"))
end end
test_cookie_without_max_age_and_expires
local
l_cookie: HTTP_COOKIE
do
create l_cookie.make ("user_id", "u12345")
l_cookie.set_domain ("www.example.com")
l_cookie.set_path ("/")
l_cookie.set_secure (True)
l_cookie.set_http_only (True)
assert("Expected", l_cookie.header_line.same_string ("Set-Cookie: user_id=u12345; Domain=www.example.com; Path=/; Secure; HttpOnly"))
end
end end

View File

@@ -5,11 +5,21 @@ project
notification_email = "notification_email.ecf" notification_email = "notification_email.ecf"
note note
-- title: title: Notification Email
-- description: description: "[
-- tags: Abstract interface to send message via various mailers:
-- license: - smtp
-- copyright: - sendmail
-- link[doc]: "Documentation" http:// - external script
- store on local file
- ...
]"
collection: EWF
tags: message,smtp,sendmail,mailer
copyright: "2011-2016, Jocelyn Fiat, Javier Velilla, Olivier Ligot, Eiffel Software and others"
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/runtime/process/notification_email
end end

View File

@@ -3,14 +3,17 @@ package openid
project project
openid = "consumer/openid.ecf" openid = "consumer/openid.ecf"
openid = "consumer/openid-safe.ecf" openid = "consumer/openid-safe.ecf"
demo = "consumer/demo/demo-safe.ecf"
note note
title: Eiffel OpenID title: Eiffel OpenID
description: OpenID library (for now only consumer) description: OpenID consumer library
tags: openid,security tags: openid,security,web,authentication,sso
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt) license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
-- copyright: copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
-- link[doc]: "Documentation" http:// license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/security/http_authorization
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/security/http_authorization/README.md
end end

View File

@@ -5,11 +5,16 @@ project
http_authorization = "http_authorization.ecf" http_authorization = "http_authorization.ecf"
note note
-- title: title: HTTP Authorization
-- description: description: "[
-- tags: Class to manipulate HTTP 'Authorization' header value.
-- license: ]"
-- copyright: collection: EWF
-- link[doc]: "Documentation" http:// tags: http,authorization,authentication,web
copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/server/authentication/http_authorization
end end

View File

@@ -289,7 +289,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,7 +307,7 @@ 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 if l_is_verbose then
@@ -372,15 +377,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
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 ("%N## Socket is not ok! ##")
end
end
else
-- Error with socket...
has_error := True
if is_verbose then
log ("%N## Socket is not readable! ##")
end
end end
rescue rescue
retried := True retried := True

View File

@@ -3,21 +3,28 @@ package ewsgi
project project
ewsgi = "ewsgi-safe.ecf" ewsgi = "ewsgi-safe.ecf"
ewsgi = "ewsgi.ecf" ewsgi = "ewsgi.ecf"
ewsgi_spec = "ewsgi_spec-safe.ecf"
ewsgi_spec = "ewsgi_spec.ecf"
connector_cgi = "connectors/cgi/cgi-safe.ecf" connector_cgi = "connectors/cgi/cgi-safe.ecf"
connector_cgi = "connectors/cgi/cgi.ecf" connector_cgi = "connectors/cgi/cgi.ecf"
connector_libfcgi = "connectors/libfcgi/libfcgi-safe.ecf" connector_libfcgi = "connectors/libfcgi/libfcgi-safe.ecf"
connector_libfcgi = "connectors/libfcgi/libfcgi.ecf" connector_libfcgi = "connectors/libfcgi/libfcgi.ecf"
connector_nino = "connectors/nino/nino-safe.ecf"
connector_nino = "connectors/nino/nino.ecf"
connector_null = "connectors/null/null-safe.ecf" connector_null = "connectors/null/null-safe.ecf"
connector_null = "connectors/null/null.ecf" connector_null = "connectors/null/null.ecf"
connector_standalone = "connectors/standalone/standalone-safe.ecf"
connector_standalone = "connectors/standalone/standalone.ecf"
httpd = "connectors/standalone/src/httpd/httpd-safe.ecf"
httpd = "connectors/standalone/src/httpd/httpd.ecf"
note note
title: EWSGI title: EWSGI
description: EWSGI specification, and a few connectors. description: "[
tags: web, httpd, ewf Eiffel Web Server Gateway Interface (EWSGI) specification, and a few connectors.
license: Eiffel Forum v2 ]"
collection: EWF
tags: ewsgi,cgi,web,httpd,ewf
copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/server/ewsgi
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/server/ewsgi/doc
end end

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

@@ -0,0 +1,25 @@
package libfcgi
setup
compile_library = Clib
project
libfcgi = "libfcgi-safe.ecf"
libfcgi = "libfcgi.ecf"
note
title: Eiffel libfcgi wrapper
description: "[
Wrapper on modified libfcgi.
(modification: added 64 bits support)
It brings implementation for FCGI protocol.
]"
collection: EWF
tags: fcgi,libfcgi,cgi,http,web,ewf
copyright: 2011-2016, Jocelyn Fiat, Javier Velilla, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "Github" https://github.com/EiffelWebFramework/EWF/library/server/libfcgi
link[doc]: "Documentation" http://eiffelwebframework.github.io/EWF/
end

View File

@@ -1,3 +1,14 @@
note
title: Web Server Foundation
description: Core of the Eiffel Web Framework, used to build web server application.
tags: ewf,server,httpd,request,connector
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: https://github.com/EiffelWebFramework/EWF/blob/master/LICENSE
link[source]: "Github" https://github.com/EiffelWebFramework/EWF
link[doc]: "Documentation" http://eiffelwebframework.github.io/EWF/
end
package wsf package wsf
project project
@@ -11,29 +22,35 @@ project
wsf_router_context = "wsf_router_context.ecf" wsf_router_context = "wsf_router_context.ecf"
wsf_session = "wsf_session-safe.ecf" wsf_session = "wsf_session-safe.ecf"
wsf_session = "wsf_session.ecf" wsf_session = "wsf_session.ecf"
wsf_all = "connector/all-safe.ecf"
wsf_cgi = "connector/cgi-safe.ecf" wsf_cgi = "connector/cgi-safe.ecf"
wsf_cgi = "connector/cgi.ecf" wsf_cgi = "connector/cgi.ecf"
wsf_libfcgi = "connector/libfcgi-safe.ecf" wsf_libfcgi = "connector/libfcgi-safe.ecf"
wsf_libfcgi = "connector/libfcgi.ecf" wsf_libfcgi = "connector/libfcgi.ecf"
wsf_nino = "connector/nino-safe.ecf"
wsf_nino = "connector/nino.ecf"
wsf_openshift = "connector/openshift-safe.ecf" wsf_openshift = "connector/openshift-safe.ecf"
default_cgi = "default/cgi-safe.ecf" default_cgi = "default/cgi-safe.ecf"
default_cgi = "default/cgi.ecf" default_cgi = "default/cgi.ecf"
default_libfcgi = "default/libfcgi-safe.ecf" default_libfcgi = "default/libfcgi-safe.ecf"
default_libfcgi = "default/libfcgi.ecf" default_libfcgi = "default/libfcgi.ecf"
default_nino = "default/nino-safe.ecf"
default_nino = "default/nino.ecf"
default_openshift = "default/openshift-safe.ecf" default_openshift = "default/openshift-safe.ecf"
wsf_standalone = "connector/standalone-safe.ecf"
wsf_standalone = "connector/standalone.ecf"
default_standalone = "default/standalone-safe.ecf"
default_standalone = "default/standalone.ecf"
note note
title: Web Server Foundation title: Web Server Foundation
description: Core of the Eiffel Web Framework, used to build web server application. description: "[
tags: ewf,server,httpd,request,connector Core of the Eiffel Web Framework (EWF).
Provide the request, response, router, ... interfaces.
The foundation to build web server application.
]"
tags: ewf,server,httpd,request,connector,web
collection: EWF
copyright: 2011-2016, Jocelyn Fiat, Javier Velilla, Olivier Ligot, Colin Adams, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt) license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: https://github.com/EiffelWebFramework/EWF/blob/master/LICENSE link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "Github" https://github.com/EiffelWebFramework/EWF link[source]: "Github" https://github.com/EiffelWebFramework/EWF/library/server/wsf
link[doc]: "Documentation" http://eiffelwebframework.github.io/EWF/ link[doc]: "Documentation" http://eiffelwebframework.github.io/EWF/
end end

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

@@ -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

View File

@@ -0,0 +1,26 @@
package encoder
project
encoder = "encoder-safe.ecf"
encoder = "encoder.ecf"
note
title: Text encoders
description: "[
Text encoders used in web technologies:
- HTML encoder
- XML encoder
- JSON encoder
- UTF8
- BASE64
]"
collection: EWF
tags: html,xml,percent encoding,web,json,utf
copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "Github" https://github.com/EiffelWebFramework/EWF/library/text/encoder
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/blob/master/library/text/encoder/README.md
end

View File

@@ -61,7 +61,11 @@ feature -- Encoder
Result.extend (c) Result.extend (c)
when '%"' then Result.append_string ("&quot;") when '%"' then Result.append_string ("&quot;")
when '&' then Result.append_string ("&amp;") when '&' then Result.append_string ("&amp;")
when '%'' then Result.append_string ("&apos;") when '%'' then Result.append_string ("&#39;")
-- The named character reference &apos; (the apostrophe, U+0027)
-- was introduced in XML 1.0 but does not appear in HTML.
-- Authors should therefore use &#39; instead of &apos;
-- to work as expected in HTML 4 user agents.
when '<' then Result.append_string ("&lt;") when '<' then Result.append_string ("&lt;")
when '>' then Result.append_string ("&gt;") when '>' then Result.append_string ("&gt;")
else else

View File

@@ -0,0 +1,19 @@
package feed
project
feed = "feed-safe.ecf"
feed = "feed.ecf"
note
title: Eiffel FEED parser
description: "[
RSS2.0 and ATOM feed parser.
Feed visitor including HTML generation from FEED Eiffel objects.
]"
tags: rss,atom,feed,html,generator,parser
copyright: 2011-2016, Jocelyn Fiat, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/text/parser/feed
end

View File

@@ -5,11 +5,20 @@ project
uri_template = "uri_template.ecf" uri_template = "uri_template.ecf"
note note
-- title: title: URI Template
-- description: description: "[
-- tags: Implement URI Template as described at http://tools.ietf.org/rfc/rfc6570.txt
-- license:
-- copyright: Support for URI template string expansion
-- link[doc]: "Documentation" http:// But also partial URI Template matching
]"
collection: EWF
tags: uri template,router,generator,url
copyright: 2011-2016, Jocelyn Fiat, Javier Velilla, Eiffel Software and others
license: Eiffel Forum License v2 (see http://www.eiffel.com/licensing/forum.txt)
link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/text/parser/uri_template
link[doc]: "Documentation" https://github.com/EiffelWebFramework/EWF/tree/master/library/text/parser/uri_template/README.md
end end

View File

@@ -7,11 +7,15 @@ project
note note
title: Error framework title: Error framework
description: "[ description: "[
Errors and associated handler, to manage errors and also provides a way to synchronize one or many error handlers. Errors and associated handler, to manage errors and also provides a way to synchronize one or many error handlers.
This is convenient to propagate error from a layer to another without adding unwanted dependencies. This is convenient to propagate error from a layer to another without adding unwanted dependencies.
tags: error ]"
collection: EWF
tags: error,framework
license: Eiffel Forum License v2 license: Eiffel Forum License v2
copyright: Jocelyn Fiat, Eiffel Software and others. copyright: Jocelyn Fiat, Eiffel Software and others.
link[license]: http://www.eiffel.com/licensing/forum.txt link[license]: http://www.eiffel.com/licensing/forum.txt
link[source]: "github" https://github.com/EiffelWebFramework/EWF/tree/master/library/utility/general/error
end end

View File

@@ -11,9 +11,9 @@ if "%ECF_TOOL_PATH%" == "" goto SEARCH_ECF_TOOL
goto START goto START
:SEARCH_ECF_TOOL :SEARCH_ECF_TOOL
for %%f in (ecf_tool.exe) do ( :: for %%f in (ecf_tool.exe) do (
if exist "%%~dp$PATH:f" set ECF_TOOL_PATH="%%~dp$PATH:f" :: if exist "%%~dp$PATH:f" set ECF_TOOL_PATH="%%~dp$PATH:f"
) :: )
if "%ECF_TOOL_PATH%" == "" goto BUILD_ECF_TOOL if "%ECF_TOOL_PATH%" == "" goto BUILD_ECF_TOOL
echo Using ecf_tool.exe from %ECF_TOOL_PATH% echo Using ecf_tool.exe from %ECF_TOOL_PATH%
goto START goto START

View File

@@ -147,7 +147,7 @@ set TMP_ECF_TOOL_CMD=%~dp0\bin\ecf_tool.bat
goto call_ecf_update goto call_ecf_update
:call_ecf_update :call_ecf_update
call %TMP_ECF_TOOL_CMD% updater --root %TMP_TARGET_DIR% --force %2 %3 %4 %5 %6 %7 %8 %9 %TMP_TARGET_DIR%\contrib call %TMP_ECF_TOOL_CMD% updater --root %TMP_TARGET_DIR% --include %TMP_TARGET_DIR%\library --include %TMP_TARGET_DIR%\contrib\library --force %TMP_TARGET_DIR%\contrib
:end :end
del %TMP_EXCLUDE% del %TMP_EXCLUDE%