diff --git a/doc/workbook/basics/APPLICATION_EXECUTION.png b/doc/workbook/basics/APPLICATION_EXECUTION.png deleted file mode 100644 index 270c78aa..00000000 Binary files a/doc/workbook/basics/APPLICATION_EXECUTION.png and /dev/null differ diff --git a/doc/workbook/basics/Launcher Hierarchy.png b/doc/workbook/basics/Launcher Hierarchy.png deleted file mode 100644 index d7c04723..00000000 Binary files a/doc/workbook/basics/Launcher Hierarchy.png and /dev/null differ diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png deleted file mode 100644 index ba484064..00000000 Binary files a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_CGI.png and /dev/null differ diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png deleted file mode 100644 index b42d4b96..00000000 Binary files a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_FCGI.png and /dev/null differ diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png deleted file mode 100644 index ecca100e..00000000 Binary files a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_NINO.png and /dev/null differ diff --git a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png b/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png deleted file mode 100644 index c3eea2fb..00000000 Binary files a/doc/workbook/basics/WSF_SERVICE_LAUNCHER_STANDALONE.png and /dev/null differ diff --git a/doc/workbook/basics/basics.md b/doc/workbook/basics/basics.md deleted file mode 100644 index 2fc0e40f..00000000 --- a/doc/workbook/basics/basics.md +++ /dev/null @@ -1,214 +0,0 @@ -Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query Parameter](../handling_request/form.md) - - -## EWF basic service - -##### Table of Contents -- [Basic Structure](#structure) -- [Service to Generate Plain Text](#text) - - [Source code](#source_1) -- [Service to Generate HTML](#html) - - [Source code](#source_2) - - - - -## 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. - -```eiffel -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - -create - make_and_launch - -end -``` - -The class ```APPLICATION``` inherit from -```WSF_DEFAULT_SERVICE [G ->WSF_EXECUTION create make end]``` it will be responsible to launch the service and set optional options. - -The class ```APPLICATION_EXECUTION``` is an implementation of ```WSF_EXECUTION``` interface, which is instantiated for each incoming request. - -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - do - -- To read incoming HTTP request, we need to use `req' - - -- May require talking to databases or other services. - - -- To send a response we need to setup, the status code and - -- the response headers and the content we want to send out our client - end -end -``` - -When using the "standalone" connector (or the deprecated "nino" connector), by default the service listens on port 80, but often this port is already used by other applications, so it is recommended to use another port. -To define another port, redefine the feature `initialize` and set up a new port number using the service options (see below). - - -```eiffel -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end -end -``` - -The **WSF_REQUEST** gives access to the incoming data; the class provides features to get information such as request method, form data, query parameters, uploaded files, HTTP request headers, and hostname of the client among others. - -The **WSF_RESPONSE** provides features to define the response with information such as HTTP status codes (10x,20x, 30x, 40x, and 50x), response headers (Content-Type, Content-Length, etc.) and obviously the body of the message itself. - -**APPLICATION** is the root class of our example, it launches the application, using the corresponding connector, Which connector? this depends how do you want to run it `cgi`, `fcgi`, `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](./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. - -![Standalone Launcher](./WSF_SERVICE_LAUNCHER_STANDALONE.png "Standalone Hierarchy") -Other connectors: - -**WSF_STANDALONE_SERVICE_LAUNCHER** -**WSF_CGI_SERVICE_LAUNCHER** -**WSF_LIBFCGI_SERVICE_LAUNCHER** - -A basic EWF service inherits from **WSF_DEFAULT_SERVICE**, which has a formal generic that should conform to **WSF_EXECUTION** class with a `make` creation procedure, in our case the class **APPLICATION_EXECUTION**. - -The **APPLICATION_EXECUTION** class inherits from **WSF_EXECUTION** interface, which is instantiated for each incoming request. **WSF_EXECUTION** inherit from **WGI_EXECUTION** which is the low level entry point in EWF, handling each incoming request with a single procedure ```execute (req: WSF_REQUEST; res: WSF_RESPONSE) ...```. - -In the **APPLICATION_EXECUTION** class class you will need to implement the **execute** feature, get data from the request *req* and write the response in *res*. - -![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```. - - - -## 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. - -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - do - -- To send a response we need to setup, the status code and - -- the response headers. - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>) - response.put_string ("Hello World") - end -end - -``` - - -### Source code -The source code is available on Github. You can get it by running the command: - -```git clone https://github.com/EiffelWebFramework/ewf.git``` - -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_standalone target or if you prefer the command line, run the command: - -```estudio -config simple.ecf -target simple_standalone``` - - - -## A Service to Generate HTML. -To generate HTML, it's needed - -1. Change the Content-Type : "text/html" -2. Build an HTML page - -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - do - -- To send a response we need to setup, the status code and - -- the response headers. - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - response.put_string (web_page) - end - - web_page: STRING = "[ - - - - Resume - - - Hello World - - -]" - -end -``` - - - -### Source code -The source code is available on Github. You can get it by running the command: - -```git clone https://github.com/EiffelWebFramework/ewf.git``` - -The example of the service that generates HTML is located in the directory $PATH/ewf/doc/workbook/basics/simple_html, where $PATH is where you run ```git clone``` . -Just double click on the simple_html.ecf file and select the simple_html_standalone target or if you prefer the command line, run the command: - -```estudio -config simple_html.ecf -target simple_html_standalone``` - -Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query Parameter](../handling_request/form.md) - diff --git a/doc/workbook/basics/simple/application.e b/doc/workbook/basics/simple/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/basics/simple/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/basics/simple/application_execution.e b/doc/workbook/basics/simple/application_execution.e deleted file mode 100644 index 58917ef8..00000000 --- a/doc/workbook/basics/simple/application_execution.e +++ /dev/null @@ -1,25 +0,0 @@ -note - description : "Basic Service that Generates Plain Text" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - do - -- To send a response we need to setup, the status code and - -- the response headers. - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/plain"], ["Content-Length", "11"]>>) - response.put_string ("Hello World") - end -end diff --git a/doc/workbook/basics/simple/simple.ecf b/doc/workbook/basics/simple/simple.ecf deleted file mode 100644 index e4ff832f..00000000 --- a/doc/workbook/basics/simple/simple.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/basics/simple_html/apache_config/Readme.md b/doc/workbook/basics/simple_html/apache_config/Readme.md deleted file mode 100644 index c2fd0777..00000000 --- a/doc/workbook/basics/simple_html/apache_config/Readme.md +++ /dev/null @@ -1,61 +0,0 @@ -Nav: [Workbook](../../../workbook.md) :: [Basic concepts](../../../basics/basics.md) - -## Run simple_html example on Apache with FCGI on Windows. - - -#### Prerequisites - -* This tutorial was written for people working under Windows environment, and using Apache Server with FCGI connector -* Compile the ewf application from command line. -* 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 setted the Listen to `8888`, the defautl value is `80` . - - - -#### 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 -and copy the _mod_fcgid.so_ to `C:/home/server/Apache24/modules` - -#### Compile the project simple_html using the fcgi connector. - - 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. - -Check if you have _libfcgi.dll_ in your PATH. - - -#### Apache configuration -Add to httpd.conf the content, you can get the configuration file [here](config.conf) - -``` -LoadModule fcgid_module modules/mod_fcgid.so - - - - SetHandler fcgid-script - Options +ExecCGI +Includes +FollowSymLinks -Indexes - AllowOverride All - Require all granted - - ScriptAlias /simple "C:/home/server/Apache24/fcgi-bin/simple_html.exe" - -``` - -Test if your httpd.conf is ok -``` -> httpd -t -``` - -Launch the server -``` -> httpd -``` - -Check the application -``` -> http://localhost:8888/simple -``` - -Nav: [Workbook](../../../workbook.md) :: [Basic concepts](../../../basics/basics.md) diff --git a/doc/workbook/basics/simple_html/apache_config/config.conf b/doc/workbook/basics/simple_html/apache_config/config.conf deleted file mode 100644 index f41212d2..00000000 --- a/doc/workbook/basics/simple_html/apache_config/config.conf +++ /dev/null @@ -1,12 +0,0 @@ -LoadModule fcgid_module modules/mod_fcgid.so - - - - SetHandler fcgid-script - Options +ExecCGI +Includes +FollowSymLinks -Indexes - AllowOverride All - Require all granted - - ScriptAlias /simple "C:/home/server/Apache24/fcgi-bin/simple_html.exe" - - diff --git a/doc/workbook/basics/simple_html/application.e b/doc/workbook/basics/simple_html/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/basics/simple_html/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/basics/simple_html/application_execution.e b/doc/workbook/basics/simple_html/application_execution.e deleted file mode 100644 index 63204435..00000000 --- a/doc/workbook/basics/simple_html/application_execution.e +++ /dev/null @@ -1,66 +0,0 @@ -note - description : "Basic Service that Generate HTML" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - do - -- To send a response we need to setup, the status code and - -- the response headers. - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - response.put_string (web_page) - end - - - web_page: STRING = "[ - - - - Resume - - - -
-
-

Objective

-

To take a position as a software engineer.

-

Experience

-

Junior Developer, Software Company (2010 - Present)

- -

Skills

-

Languages: C#, JavaScript, Python, Ruby, Eiffel

-

Frameworks: .NET, Node.js, Django, Ruby on Rails, EWF

-

Education

-

BS, Economics, My University

- -
- - - -]" - - -end diff --git a/doc/workbook/basics/simple_html/simple_html.ecf b/doc/workbook/basics/simple_html/simple_html.ecf deleted file mode 100644 index 5712125d..00000000 --- a/doc/workbook/basics/simple_html/simple_html.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/deployment/readme.md b/doc/workbook/deployment/readme.md deleted file mode 100644 index 8e8afd6a..00000000 --- a/doc/workbook/deployment/readme.md +++ /dev/null @@ -1,198 +0,0 @@ -Nav: [Workbook](../workbook.md) - -EWF Deployment -============== - -# Apache on Windows# - -1. Apache Install -2. Deploying EWF CGI -3. CGI overview - 1. Build EWF application - 2. Copy the generated exe file and the www content .htaccess CGI -4. Deploying EWF FCGI -5. FCGI overview - 1. Build EWF application - 2. Copy the generated exe file and the www content.htaccess CGI - - - -## Apache on Windows - -### Apache Install - ->Check the correct version (Win 32 or Win64) ->Apache Version: Apache 2.4.4 ->Windows: http://www.apachelounge.com/download/ - -note: on linux (debian), use -> sudo apt-get install apache2 - -#### Deploying EWF CGI - -#### 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. ->When a CGI program finishes handling a request, the program terminates. - -* Build EWF application - -```ec -config [app.ecf] -target [app_cgi] -finalize -c_compile -project_path``` - - ->Note: change app.ecf and target app_cgi based on your own configuration. - -* Copy the generated exe file and the www content - -Copy the app.exe and the folder _www_ into a folder served by apache2, for example under. - - -``` - /htdocs. - - = path to your apache installation - - Edit httpd.conf under c://conf - - DocumentRoot "c://htdocs" - - /htdocs"> - AllowOverride All -- - Require all granted -- this is required in Apache 2.4.4 - -``` - -Check that you have the following modules enabled - -``` - LoadModule cgi_module modules/mod_cgi.so - LoadModule rewrite_module modules/mod_rewrite.so -``` - -#### Tip: ->To check the syntax of your httpd.conf file. From command line run the following - - $>httpd - t - - ->.htaccess CGI - http://perishablepress.com/stupid-htaccess-tricks/ - -#### .htaccess - -``` - Options +ExecCGI +Includes +FollowSymLinks -Indexes - AddHandler cgi-script exe - - - RewriteEngine on - - RewriteRule ^$ $service [L] - - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteCond %{REQUEST_URI} !$service - RewriteRule ^(.*)$ $service/$1 - - RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -``` - ->Replace $service with the name of your executable service, for example app_service.exe - - -#### Deploying EWF FCGI ->To deploy FCGI you will need to download the mod_fcgi module. ->You can get it from here http://www.apachelounge.com/download/ - -note: on linux (debian), use -> sudo apt-get install libapache2-mod-fastcgi - -#### 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. - -* Build EWF application - -``` ec -config [app.ecf] -target [app_fcgi] -finalize -c_compile -project_path .``` - ->Note: change app.ecf and target app_fcgi based on your own configuration. - -* Copy the generated exe file and the www content - -Copy the app.exe and the folder "www" into a folder served by apache2, for example under - -``` - /htdocs. - - = path to your apache installation - - Edit httpd.conf under c://conf - - DocumentRoot "c://htdocs" - - /htdocs"> - AllowOverride All -- - Require all granted -- this is required in Apache 2.4.4 - -``` - ->Check that you have the following modules enabled - - LoadModule rewrite_module modules/mod_rewrite.so - LoadModule fcgid_module modules/mod_fcgid.so - ->NOTE: By default Apache does not come with fcgid module, so you will need to download it, and put the module under Apache2/modules - -It is also possible to set various parameters in the apache site configuration file such as: -``` - - # FcgidIdleTimeout 600 - # FcgidBusyScanInterval 120 - # FcgidProcessLifeTime 3600 - # FcgidMaxProcesses 5 - # FcgidMaxProcessesPerClass 100 - # FcgidMinProcessesPerClass 100 - # FcgidConnectTimeout 8 - # FcgidIOTimeout 60 - # FcgidBusyTimeout 1200 - -``` -See https://httpd.apache.org/mod_fcgid/mod/mod_fcgid.html for more information. - -# .htaccess FCGI - -``` -http://perishablepress.com/stupid-htaccess-tricks/ -``` - -#### .htaccess -``` - Options +ExecCGI +Includes +FollowSymLinks -Indexes - - - AddHandler fcgid-script .ews - FcgidWrapper $FULL_PATH/$service .ews - - - - - RewriteEngine on - - RewriteBase / - RewriteRule ^$ service.ews [L] - - RewriteCond %{REQUEST_FILENAME} !-f - RewriteCond %{REQUEST_FILENAME} !-d - RewriteCond %{REQUEST_URI} !=/favicon.ico - RewriteCond %{REQUEST_URI} !service.ews - RewriteRule ^(.*)$ service.ews/$1 - - - RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] - -``` - -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. - -Nav: [Workbook](../workbook.md) diff --git a/doc/workbook/generating_response/exel/application.e b/doc/workbook/generating_response/exel/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/generating_response/exel/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/generating_response/exel/application_execution.e b/doc/workbook/generating_response/exel/application_execution.e deleted file mode 100644 index 3c93fb5a..00000000 --- a/doc/workbook/generating_response/exel/application_execution.e +++ /dev/null @@ -1,36 +0,0 @@ -note - description : "Basic Service that show how to use common Status Code" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - do - -- To send a response we need to setup, the status code and - -- the response headers. - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/csv"],["Content-Disposition","attachment;filename=Report.xls"],["Content-Length", sheet.count.out]>>) - response.put_string (sheet) - end - - -- ,["Content-Disposition","attachment;filename=Report.xls"] - - - sheet: STRING ="[ - Q1 Q2 Q3 Q4 Total -Cherries 78 87 92 29 =SUM(B2:E2) -Grapes 77 86 93 30 =SUM(B3:E3) - ]" - - -end diff --git a/doc/workbook/generating_response/exel/exel.ecf b/doc/workbook/generating_response/exel/exel.ecf deleted file mode 100644 index e16eb9f7..00000000 --- a/doc/workbook/generating_response/exel/exel.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/generating_response/generating_response.md b/doc/workbook/generating_response/generating_response.md deleted file mode 100644 index c6d4fcd4..00000000 --- a/doc/workbook/generating_response/generating_response.md +++ /dev/null @@ -1,1007 +0,0 @@ - -Nav: [Workbook](../workbook.md) :: [Handling Requests: Header Fields](../handling_request/headers.md) :: [Handling Cookies](../handling_cookies/handling_cookies.md) - - -## EWF Generating Response - -##### Table of Contents -- [Format of the HTTP response](#format) -- [How to set status code](#status_set) -- [How to redirect to a particular location.](#redirect) -- [HTTP Status codes](#status) -- [Example Staus Codes](#example_1) -- [Generic Search Engine](#example_2) -- [Response Header Fields](#header_fields) - - - - -## 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. - -``` - GET /url[query_string] HTTP/1.1 - Host: ... - Header2: ... - ... - HeaderN: - (Blank Line) -``` - -When a Web server responds to a request, the response typically consists of a status line, some response headers, a blank line, and the document. A typical response -looks like this: - -``` - HTTP/1.1 200 OK - Content-Type: text/html - Header2: ... - ... - HeaderN: ... - (Blank Line) - - - ... - - ... - - -``` - -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 don’t. For example, responses to HEAD requests should never include a document, and various status codes essentially indicate failure or redirection (and thus either don’t include a document or include only a short error-message document). - - - -## 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. - -### Using the WSF_RESPONSE.put_header feature. -In this case you provide the status code with a collection of headers. - -```eiffel - put_header (a_status_code: INTEGER_32; a_headers: detachable ARRAY [TUPLE [name: READABLE_STRING_8; value: READABLE_STRING_8]]) - -- Put headers with status `a_status', and headers from `a_headers' - require - a_status_code_valid: a_status_code > 0 - status_not_committed: not status_committed - header_not_committed: not header_committed - ensure - status_code_set: status_code = a_status_code - status_set: status_is_set - message_writable: message_writable - -Example - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", output_size]>>) - res.put_string (web_page) -``` - -### Using the WSF_RESPONSE.set_status code - -```eiffel - custom_response (req: WSF_REQUEST; res: WSF_RESPONSE; output: STRING) - local - h: HTTP_HEADER - l_msg: STRING - do - create h.make - create l_msg.make_from_string (output) - h.put_content_type_text_html - h.put_content_length (l_msg.count) - h.put_current_date - res.set_status_code ({HTTP_STATUS_CODE}.ok) - res.put_header_text (h.string) - res.put_string (l_msg) - end -``` -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/). - - - -## 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``` - -> The 302 (Found) status code indicates that the target resource resides temporarily under a different URI. Since the redirection might be altered on occasion, the client ought to continue to use the effective request URI for future requests. - -Another way to do redirection is with 303 status code - -> The 303 (See Other) status code indicates that the server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. - -The next code show a custom feature to write a redirection, you can use found or see_other based on your particular requirements. - -```eiffel - send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32) - -- Redirect to `a_location' - local - h: HTTP_HEADER - do - create h.make - h.put_content_type_text_html - h.put_current_date - h.put_location (a_location) - res.set_status_code ({HTTP_STATUS_CODE}.found) - res.put_header_text (h.string) - end -``` - -The class `WSF_RESPONSE` provide features to work with redirection - -```eiffel - redirect_now (a_url: READABLE_STRING_8) - -- Redirect to the given url `a_url' - require - header_not_committed: not header_committed - - redirect_now_custom (a_url: READABLE_STRING_8; a_status_code: INTEGER_32; a_header: detachable HTTP_HEADER; a_content: detachable TUPLE [body: READABLE_STRING_8; type: READABLE_STRING_8]) - -- Redirect to the given url `a_url' and precise custom `a_status_code', custom header and content - -- Please see http://www.faqs.org/rfcs/rfc2616 to use proper status code. - -- if `a_status_code' is 0, use the default {HTTP_STATUS_CODE}.temp_redirect - require - header_not_committed: not header_committed - - redirect_now_with_content (a_url: READABLE_STRING_8; a_content: READABLE_STRING_8; a_content_type: READABLE_STRING_8) - -- Redirect to the given url `a_url' -``` - -The ```WSF_RESPONSE.redirect_now``` feature use the status code ```{HTTP_STATUS_CODE}.found```,the other redirect features enable customize the status code and content based on your requirements. - - -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. - - - -## [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. - -General categories: -* [1xx](https://httpwg.github.io/specs/rfc7231.html#status.1xx) Informational: The 1xx series of response codes are used only in negotiations with the HTTP server. -* [2xx](https://httpwg.github.io/specs/rfc7231.html#status.2xx) Sucessful: The 2xx error codes indicate that an operation was successful. -* [3xx](https://httpwg.github.io/specs/rfc7231.html#status.3xx) Redirection: The 3xx status codes indicate that the client needs to do some extra work to get what it wants. -* [4xx](https://httpwg.github.io/specs/rfc7231.html#status.4xx) Client Error: These status codes indicate that something is wrong on the client side. -* [5xx](https://httpwg.github.io/specs/rfc7231.html#status.5xx) Server Error: These status codes indicate that something is wrong on the server side. - -Note: use ```res.set_status_code({HTTP_STATUS_CODE}.bad_request)``` rather than ```res.set_status_code(400)```. - - - - -### Example Staus Codes -Basic Service that builds a simple web page to show the most common status codes -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - -- Execute the incomming request - local - l_message: STRING - do - -- To send a response we need to setup, the status code and - -- the response headers. - if req.is_get_request_method then - if req.path_info.same_string ("/") then - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - res.put_string (web_page) - elseif req.path_info.same_string ("/redirect") then - send_redirect (req, res, "https://httpwg.github.io/") - -- res.redirect_now (l_engine_url) - elseif req.path_info.same_string ("/bad_request") then - -- Here you can do some logic for example log, send emails to register the error, before to send the response. - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Bad Request") - l_message.replace_substring_all ("$status", "Bad Request 400") - res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - elseif req.path_info.same_string ("/internal_error") then - -- Here you can do some logic for example log, send emails to register the error, before to send the response. - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Internal Server Error") - l_message.replace_substring_all ("$status", "Internal Server Error 500") - res.put_header ({HTTP_STATUS_CODE}.internal_server_error, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Resource not found") - l_message.replace_substring_all ("$status", "Resource not found 400") - res.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Method Not Allowed") - l_message.replace_substring_all ("$status", "Method Not Allowed 405") - -- Method not allowed - res.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - end - - -feature -- Home Page - - send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32) - -- Redirect to `a_location' - local - h: HTTP_HEADER - do - create h.make - h.put_content_type_text_html - h.put_current_date - h.put_location (a_location) - res.set_status_code ({HTTP_STATUS_CODE}.see_other) - res.put_header_text (h.string) - end - - web_page: STRING = "[ - - - - Example showing common status codes - - - -
-
-

This page is an example of Status Code 200

- -

Redirect Example

-

Click on the following link will redirect you to the HTTP Specifcation, we can do the redirect from the HTML directly but - here we want to show you an exmaple, where you can do something before to send a redirect Redirect

- -

Bad Request

-

Click on the following link, the server will answer with a 400 error, check the status code Bad Request

- -

Internal Server Error

-

Click on the following link, the server will answer with a 500 error, check the status code Internal Error

- -

Resource not found

-

Click on the following link or add to the end of the url something like /1030303 the server will answer with a 404 error, check the status code Not found

- -
- - - -]" - -feature -- Generic Message - - message_template: STRING="[ - - - - $title - - - -
-
-

This page is an example of $status

- - - - -]" -end - -``` - - - - - -### 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 -redirection works, and we will use a tools to play with the API to show differents responses. - -```eiffel -note - description : "Basic Service that build a generic front end for the most used search engines." - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - -- Execute the incomming request - local - l_message: STRING - do - -- To send a response we need to setup, the status code and - -- the response headers. - if req.is_get_request_method then - if req.path_info.same_string ("/") then - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - res.put_string (web_page) - else - send_resouce_not_found (req, res) - end - elseif req.is_post_request_method then - if req.path_info.same_string ("/search") then - if attached {WSF_STRING} req.form_parameter ("query") as l_query then - if attached {WSF_STRING} req.form_parameter ("engine") as l_engine then - if attached {STRING} map.at (l_engine.value) as l_engine_url then - l_engine_url.append (l_query.value) - send_redirect (req, res, l_engine_url) - else - send_bad_request (req, res, " search engine: " + l_engine.value + " not supported,
try with Google or Bing") - end - else - send_bad_request (req, res, " search engine not selected") - end - else - send_bad_request (req, res, " form_parameter query is not present") - end - else - send_resouce_not_found (req, res) - end - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Method Not Allowed") - l_message.replace_substring_all ("$status", "Method Not Allowed 405") - -- Method not allowed - res.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - end - - -feature -- Engine Map - - map : STRING_TABLE[STRING] - do - create Result.make (2) - Result.put ("http://www.google.com/search?q=", "Google") - Result.put ("http://www.bing.com/search?q=", "Bing") - end - -feature -- Redirect - - send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32) - -- Redirect to `a_location' - local - h: HTTP_HEADER - do - create h.make - h.put_content_type_text_html - h.put_current_date - h.put_location (a_location) - res.set_status_code ({HTTP_STATUS_CODE}.see_other) - res.put_header_text (h.string) - end - -feature -- Bad Request - - send_bad_request (req: WSF_REQUEST; res: WSF_RESPONSE; description: STRING) - local - l_message: STRING - do - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Bad Request") - l_message.replace_substring_all ("$status", "Bad Request" + description) - res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - -feature -- Resource not found - - send_resouce_not_found (req: WSF_REQUEST; res: WSF_RESPONSE) - local - l_message: STRING - do - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Resource not found") - l_message.replace_substring_all ("$status", "Resource" + req.request_uri + "not found 404") - res.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - -feature -- Home Page - - web_page: STRING = "[ - - - - Generic Search Engine - - -
-

Generic Search Engine

-
-
- Search:
-
- -
- -
- -

-
- -
- - -
- - - -]" - -feature -- Generic Message - - message_template: STRING="[ - - - - $title - - - -
-
-

This page is an example of $status

- - - - -]" - -end - -``` - -Using cURL to test the application ---- - -In the first call we use the ```res.redirect_now (l_engine_url)``` feature -``` -#>curl -i -H -v -X POST -d "query=Eiffel&engine=Google" http://localhost:9090/search -HTTP/1.1 302 Found -Location: http://www.google.com/search?q=Eiffel -Content-Length: 0 -Connection: close -``` - -Here we use our custom send_redirect feature call. - -``` -#>curl -i -H -v -X POST -d "query=Eiffel&engine=Google" http://localhost:9090/search -HTTP/1.1 303 See Other -Content-Type: text/html -Date: Fri, 06 Mar 2015 14:37:33 GMT -Location: http://www.google.com/search?q=Eiffel -Connection: close -``` - -#### Engine Ask Not supported - -``` -#>curl -i -H -v -X POST -d "query=Eiffel&engine=Ask" http://localhost:9090/search -HTTP/1.1 400 Bad Request -Content-Type: text/html -Content-Length: 503 -Connection: close - - - - - Bad Request - - - -
-
-

This page is an example of Bad Request search engine: Ask not supported,
try with Google or Bing

- - - - -``` - - -#### Missing query form parameter - -``` -#>curl -i -H -v -X POST -d "engine=Google" http://localhost:9090/search -HTTP/1.1 400 Bad Request -Content-Type: text/html -Content-Length: 477 -Connection: close - - - - - Bad Request - - - -
-
-

This page is an example of Bad Request form_parameter query is not present

- - - - -``` - -#### Resource searchs not found - -``` -#>curl -i -H -v -X POST -d "query=Eiffel&engine=Google" http://localhost:9090/searchs -HTTP/1.1 404 Not Found -Content-Type: text/html -Content-Length: 449 -Connection: close - - - - - Resource not found - - - -
-
-

This page is an example of Resource /searchs not found 404

- - - - -``` - - - -## [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. - - - -### How to set response headers. - -HTTP allows multiple occurrences of the same header name, the features ```put_XYZ``` replace existing headers with the same name and -features ```add_XYZ``` add headers that can lead to duplicated entries. - - -```eiffel - add_header_line (h: READABLE_STRING_8) - -- Add header `h' - -- This can lead to duplicated header entries - require - header_not_committed: not header_committed - - add_header_text (a_text: READABLE_STRING_8) - -- Add the multiline header `a_text' - -- Does not replace existing header with same name - -- This could leads to multiple header with the same name - require - header_not_committed: not header_committed - a_text_ends_with_single_crlf: a_text.count > 2 implies not a_text.substring (a_text.count - 2, a_text.count).same_string ("%R%N") - a_text_does_not_end_with_double_crlf: a_text.count > 4 implies not a_text.substring (a_text.count - 4, a_text.count).same_string ("%R%N%R%N") - ensure - status_set: status_is_set - message_writable: message_writable - - put_header_line (h: READABLE_STRING_8) - -- Put header `h' - -- Replace any existing value - require - header_not_committed: not header_committed - - put_header_text (a_text: READABLE_STRING_8) - -- Put the multiline header `a_text' - -- Overwite potential existing header - require - header_not_committed: not header_committed - a_text_ends_with_single_crlf: a_text.count > 2 implies not a_text.substring (a_text.count - 2, a_text.count).same_string ("%R%N") - a_text_does_not_end_with_double_crlf: a_text.count > 4 implies not a_text.substring (a_text.count - 4, a_text.count).same_string ("%R%N%R%N") - ensure - message_writable: message_writable - -helpers - - add_header (a_status_code: INTEGER_32; a_headers: detachable ARRAY [TUPLE [name: READABLE_STRING_8; value: READABLE_STRING_8]]) - -- Put headers with status `a_status', and headers from `a_headers' - require - a_status_code_valid: a_status_code > 0 - status_not_committed: not status_committed - header_not_committed: not header_committed - ensure - status_code_set: status_code = a_status_code - status_set: status_is_set - message_writable: message_writable - - add_header_lines (a_lines: ITERABLE [READABLE_STRING_8]) - -- Add headers from `a_lines' - require - header_not_committed: not header_committed - - put_header (a_status_code: INTEGER_32; a_headers: detachable ARRAY [TUPLE [name: READABLE_STRING_8; value: READABLE_STRING_8]]) - -- Put headers with status `a_status', and headers from `a_headers' - require - a_status_code_valid: a_status_code > 0 - status_not_committed: not status_committed - header_not_committed: not header_committed - ensure - status_code_set: status_code = a_status_code - status_set: status_is_set - message_writable: message_writable - - put_header_lines (a_lines: ITERABLE [READABLE_STRING_8]) - -- Put headers from `a_lines' - require - header_not_committed: not header_committed - -``` - -The other way to build headers is using the class `HTTP_HEADER`, that provide routines to build a header. It's recomended to -take a look at constants classes such as `HTTP_MIME_TYPES`,`HTTP_HEADER_NAMES`,`HTTP_STATUS_CODE`,`HTTP_REQUEST_METHODS`, or -`HTTP_CONSTANTS` which groups them for convenience. - - -```eiffel - custom_answer (req: WSF_REQUEST; res: WSF_RESPONSE; output: STRING) - local - h: HTTP_HEADER - l_msg: STRING - do - create h.make - create l_msg.make_from_string (output) - h.put_content_type_text_html - h.put_content_length (l_msg.count) - h.put_current_date - res.set_status_code ({HTTP_STATUS_CODE}.bad_gateway) - res.put_header_text (h.string) - res.put_string (l_msg) - end -``` -The class `HTTP_HEADER` also supplies a number of convenience routines for specifying common headers, in fact the features are inherited from the class `HTTP_HEADER_MODIFIER`. - - -```eiffel -deferred class interface - HTTP_HEADER_MODIFIER - -feature -- Access - - date_to_rfc1123_http_date_format (dt: DATE_TIME): STRING_8 - -- String representation of `dt' using the RFC 1123 - - item alias "[]" (a_header_name: READABLE_STRING_8): detachable READABLE_STRING_8 assign force - -- First header item found for `a_name' if any - -feature -- Status report - - has (a_name: READABLE_STRING_8): BOOLEAN - -- Has header item for `n'? - -- Was declared in HTTP_HEADER_MODIFIER as synonym of has_header_named. - - has_content_length: BOOLEAN - -- Has header "Content-Length" - - has_content_type: BOOLEAN - -- Has header "Content-Type" - - has_header_named (a_name: READABLE_STRING_8): BOOLEAN - -- Has header item for `n'? - -- Was declared in HTTP_HEADER_MODIFIER as synonym of has. - - has_transfer_encoding_chunked: BOOLEAN - -- Has "Transfer-Encoding: chunked" header - -feature -- Access: deferred - - new_cursor: INDEXABLE_ITERATION_CURSOR [READABLE_STRING_8] - -- Fresh cursor associated with current structure. - -feature -- Authorization - - put_authorization (a_authorization: READABLE_STRING_8) - -- Put `a_authorization' with "Authorization" header - -- The Authorization header is constructed as follows: - -- 1. Username and password are combined into a string "username:password". - -- 2. The resulting string literal is then encoded using Base64. - -- 3. The authorization method and a space, i.e. "Basic " is then put before the encoded string. - -- ex: Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== - -feature -- Content related header - - add_content_type (a_content_type: READABLE_STRING_8) - -- same as put_content_type, but allow multiple definition of "Content-Type" - - add_content_type_with_charset (a_content_type: READABLE_STRING_8; a_charset: READABLE_STRING_8) - -- Same as put_content_type_with_charset, but allow multiple definition of "Content-Type". - - add_content_type_with_name (a_content_type: READABLE_STRING_8; a_name: READABLE_STRING_8) - -- same as put_content_type_with_name, but allow multiple definition of "Content-Type" - - add_content_type_with_parameters (a_content_type: READABLE_STRING_8; a_params: detachable ARRAY [TUPLE [name: READABLE_STRING_8; value: READABLE_STRING_8]]) - -- Add header line "Content-Type:" + type `a_content_type' and extra paramaters `a_params'. - - put_content_disposition (a_type: READABLE_STRING_8; a_params: detachable READABLE_STRING_8) - -- Put "Content-Disposition" header - - put_content_encoding (a_encoding: READABLE_STRING_8) - -- Put "Content-Encoding" header of value `a_encoding'. - - put_content_language (a_lang: READABLE_STRING_8) - -- Put "Content-Language" header of value `a_lang'. - - put_content_length (a_length: INTEGER_32) - -- Put "Content-Length:" + length `a_length'. - - put_content_transfer_encoding (a_mechanism: READABLE_STRING_8) - -- Put "Content-Transfer-Encoding" header with `a_mechanism' - - put_content_type (a_content_type: READABLE_STRING_8) - -- Put header line "Content-Type:" + type `a_content_type' - - put_content_type_with_charset (a_content_type: READABLE_STRING_8; a_charset: READABLE_STRING_8) - -- Put content type `a_content_type' with `a_charset' as "charset" parameter. - - put_content_type_with_name (a_content_type: READABLE_STRING_8; a_name: READABLE_STRING_8) - -- Put content type `a_content_type' with `a_name' as "name" parameter. - - put_content_type_with_parameters (a_content_type: READABLE_STRING_8; a_params: detachable ARRAY [TUPLE [name: READABLE_STRING_8; value: READABLE_STRING_8]]) - -- Put header line "Content-Type:" + type `a_content_type' and extra paramaters `a_params' - - put_transfer_encoding (a_encoding: READABLE_STRING_8) - -- Put "Transfer-Encoding" header with `a_encoding' value. - - put_transfer_encoding_binary - -- Put "Transfer-Encoding: binary" header - - put_transfer_encoding_chunked - -- Put "Transfer-Encoding: chunked" header - -feature -- Content-type helpers - - put_content_type_application_javascript - - put_content_type_application_json - - put_content_type_application_pdf - - put_content_type_application_x_www_form_encoded - - put_content_type_application_zip - - put_content_type_image_gif - - put_content_type_image_jpg - - put_content_type_image_png - - put_content_type_image_svg_xml - - put_content_type_message_http - - put_content_type_multipart_alternative - - put_content_type_multipart_encrypted - - put_content_type_multipart_form_data - - put_content_type_multipart_mixed - - put_content_type_multipart_related - - put_content_type_multipart_signed - - put_content_type_text_css - - put_content_type_text_csv - - put_content_type_text_html - - put_content_type_text_javascript - - put_content_type_text_json - - put_content_type_text_plain - - put_content_type_text_xml - - put_content_type_utf_8_text_plain - -feature -- Cookie - - put_cookie (key, value: READABLE_STRING_8; expiration, path, domain: detachable READABLE_STRING_8; secure, http_only: BOOLEAN) - -- Set a cookie on the client's machine - -- with key 'key' and value 'value'. - -- Note: you should avoid using "localhost" as `domain' for local cookies - -- since they are not always handled by browser (for instance Chrome) - require - make_sense: (key /= Void and value /= Void) and then (not key.is_empty and not value.is_empty) - domain_without_port_info: domain /= Void implies domain.index_of (':', 1) = 0 - - put_cookie_with_expiration_date (key, value: READABLE_STRING_8; expiration: DATE_TIME; path, domain: detachable READABLE_STRING_8; secure, http_only: BOOLEAN) - -- Set a cookie on the client's machine - -- with key 'key' and value 'value'. - require - make_sense: (key /= Void and value /= Void) and then (not key.is_empty and not value.is_empty) - -feature -- Cross-Origin Resource Sharing - - put_access_control_allow_all_origin - -- Put "Access-Control-Allow-Origin: *" header. - - put_access_control_allow_credentials (b: BOOLEAN) - -- Indicates whether or not the response to the request can be exposed when the credentials flag is true. - -- When used as part of a response to a preflight request, this indicates whether or not the actual request can be made using credentials. - -- Note that simple GET requests are not preflighted, and so if a request is made for a resource with credentials, - -- if this header is not returned with the resource, the response is ignored by the browser and not returned to web content. - -- ex: Access-Control-Allow-Credentials: true | false - - put_access_control_allow_headers (a_headers: READABLE_STRING_8) - -- Put "Access-Control-Allow-Headers" header. with value `a_headers' - -- Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request. - -- ex: Access-Control-Allow-Headers: [, ]* - - put_access_control_allow_iterable_headers (a_fields: ITERABLE [READABLE_STRING_8]) - -- Put "Access-Control-Allow-Headers" header. with value `a_headers' - -- Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request. - -- ex: Access-Control-Allow-Headers: [, ]* - - put_access_control_allow_methods (a_methods: ITERABLE [READABLE_STRING_8]) - -- If `a_methods' is not empty, put `Access-Control-Allow-Methods' header with list `a_methods' of methods - -- `a_methods' specifies the method or methods allowed when accessing the resource. - -- This is used in response to a preflight request. - -- ex: Access-Control-Allow-Methods: [, ]* - - put_access_control_allow_origin (a_origin: READABLE_STRING_8) - -- Put "Access-Control-Allow-Origin: " + `a_origin' header. - -- `a_origin' specifies a URI that may access the resource - -feature -- Date - - put_current_date - -- Put current date time with "Date" header - - put_date (a_date: READABLE_STRING_8) - -- Put "Date: " header - - put_last_modified (a_utc_date: DATE_TIME) - -- Put UTC date time `dt' with "Last-Modified" header - - put_utc_date (a_utc_date: DATE_TIME) - -- Put UTC date time `a_utc_date' with "Date" header - -- using RFC1123 date formating. - -feature -- Header change: deferred - - add_header (h: READABLE_STRING_8) - -- Add header `h' - -- if it already exists, there will be multiple header with same name - -- which can also be valid - require - h_not_empty: h /= Void and then not h.is_empty - - put_header (h: READABLE_STRING_8) - -- Add header `h' or replace existing header of same header name - require - h_not_empty: h /= Void and then not h.is_empty - -feature -- Header change: general - - add_header_key_value (a_header_name, a_value: READABLE_STRING_8) - -- Add header `a_header_name:a_value'. - -- If it already exists, there will be multiple header with same name - -- which can also be valid - ensure - added: has_header_named (a_header_name) - - force (a_value: detachable READABLE_STRING_8; a_header_name: READABLE_STRING_8) - -- Put header `a_header_name:a_value' or replace existing header of name `a_header_name'. - - put_header_key_value (a_header_name, a_value: READABLE_STRING_8) - -- Add header `a_header_name:a_value', or replace existing header of same header name/key - ensure - added: has_header_named (a_header_name) - - put_header_key_values (a_header_name: READABLE_STRING_8; a_values: ITERABLE [READABLE_STRING_8]; a_separator: detachable READABLE_STRING_8) - -- Add header `a_header_name: a_values', or replace existing header of same header values/key. - -- Use Comma_space as default separator if `a_separator' is Void or empty. - ensure - added: has_header_named (a_header_name) - -feature -- Method related - - put_allow (a_methods: ITERABLE [READABLE_STRING_8]) - -- If `a_methods' is not empty, put `Allow' header with list `a_methods' of methods - -feature -- Others - - put_cache_control (a_cache_control: READABLE_STRING_8) - -- Put "Cache-Control" header with value `a_cache_control' - - put_expires (a_seconds: INTEGER_32) - -- Put "Expires" header to `a_seconds' seconds - - put_expires_date (a_utc_date: DATE_TIME) - -- Put "Expires" header with UTC date time value - -- formatted following RFC1123 specification. - - put_expires_string (a_expires: STRING_8) - -- Put "Expires" header with `a_expires' string value - - put_pragma (a_pragma: READABLE_STRING_8) - -- Put "Pragma" header with value `a_pragma' - - put_pragma_no_cache - -- Put "Pragma" header with "no-cache" a_pragma - -feature -- Redirection - - put_location (a_uri: READABLE_STRING_8) - -- Tell the client the new location `a_uri' - -- using "Location" header. - require - a_uri_valid: not a_uri.is_empty - - put_refresh (a_uri: READABLE_STRING_8; a_timeout_in_seconds: INTEGER_32) - -- Tell the client to refresh page with `a_uri' after `a_timeout_in_seconds' in seconds - -- using "Refresh" header. - require - a_uri_valid: not a_uri.is_empty - -end -- class HTTP_HEADER_MODIFIER -``` - - - -## HTTP 1.1 Response Headers - -There are four categories for response header fields: - - [Control Data](https://httpwg.github.io/specs/rfc7231.html#response.control.data) : Supply control data that supplements the status code, directs caching, or instructs the client where to go next. - - Age,Cache-Control,Expires,Date,Location,Retry-After,Vary,Warning. - - [Validator](https://httpwg.github.io/specs/rfc7231.html#response.validator): Validator header fields convey metadata about the selected representation. In responses to safe requests, validator fields describe the selected representation chosen by the origin server while handling the response. - - [Authentication Challenges](https://httpwg.github.io/specs/rfc7231.html#response.auth): Indicate what mechanisms are available for the client to provide authentication credentials in future requests. - - [Response Context](https://httpwg.github.io/specs/rfc7231.html#response.context): Provide more information about the target resource for potential use in later requests. - - - -Nav: [Workbook](../workbook.md) :: [Handling Requests: Header Fields](../handling_request/headers.md) :: [Handling Cookies](../handling_cookies/handling_cookies.md) diff --git a/doc/workbook/generating_response/headers/application.e b/doc/workbook/generating_response/headers/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/generating_response/headers/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/generating_response/headers/application_execution.e b/doc/workbook/generating_response/headers/application_execution.e deleted file mode 100644 index 5b042d53..00000000 --- a/doc/workbook/generating_response/headers/application_execution.e +++ /dev/null @@ -1,57 +0,0 @@ -note - description : "Basic Service that build a generic front end for the most used search engines." - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_message: STRING - do - -- (1) To send a response we need to setup, the status code and the response headers. --- response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) --- response.put_string (web_page) - - -- (2) Using put_header_line --- response.set_status_code ({HTTP_STATUS_CODE}.ok) --- response.put_header_line ("Content-Type:text/html") - response.put_header_line ("Content-Length:"+ web_page.count.out) - response.put_header_line ("Content-Type:text/plain") - - response.put_string (web_page) - end - - - -feature -- Home Page - - web_page: STRING = "[ - - - - EWF Headers Responses - - -
-

Example Header Response

-

Response headers

- -
- - - -]" -end diff --git a/doc/workbook/generating_response/headers/headers.ecf b/doc/workbook/generating_response/headers/headers.ecf deleted file mode 100644 index 797eb842..00000000 --- a/doc/workbook/generating_response/headers/headers.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /EIFGENs$ - /CVS$ - /.svn$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/generating_response/search/application.e b/doc/workbook/generating_response/search/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/generating_response/search/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/generating_response/search/application_execution.e b/doc/workbook/generating_response/search/application_execution.e deleted file mode 100644 index 1e3ebe08..00000000 --- a/doc/workbook/generating_response/search/application_execution.e +++ /dev/null @@ -1,172 +0,0 @@ -note - description : "Basic Service that build a generic front end for the most used search engines." - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_message: STRING - do - -- To send a response we need to setup, the status code and - -- the response headers. - if request.is_get_request_method then - if request.path_info.same_string ("/") then - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - response.put_string (web_page) - else - send_resouce_not_found (request, response) - end - elseif request.is_post_request_method then - if request.path_info.same_string ("/search") then - if attached {WSF_STRING} request.form_parameter ("query") as l_query then - if attached {WSF_STRING} request.form_parameter ("engine") as l_engine then - if attached {STRING} map.at (l_engine.value) as l_engine_url then - l_engine_url.append (l_query.value) - send_redirect (request, response, l_engine_url) - -- response.redirect_now (l_engine_url) - else - send_bad_request (request, response, " search engine: " + l_engine.value + " not supported,
try with Google or Bing") - end - else - send_bad_request (request, response, " search engine not selected") - end - else - send_bad_request (request, response, " form_parameter query is not present") - end - else - send_resouce_not_found (request, response) - end - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Method Not Allowed") - l_message.replace_substring_all ("$status", "Method Not Allowed 405") - -- Method not allowed - response.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - response.put_string (l_message) - end - end - - -feature -- Engine Map - - map : STRING_TABLE[STRING] - do - create Result.make (2) - Result.put ("http://www.google.com/search?q=", "Google") - Result.put ("http://www.bing.com/search?q=", "Bing") - end - -feature -- Redirect - - send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32) - -- Redirect to `a_location' - local - h: HTTP_HEADER - do - create h.make - h.put_content_type_text_html - h.put_current_date - h.put_location (a_location) - res.set_status_code ({HTTP_STATUS_CODE}.see_other) - res.put_header_text (h.string) - end - -feature -- Bad Request - - send_bad_request (req: WSF_REQUEST; res: WSF_RESPONSE; description: STRING) - local - l_message: STRING - do - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Bad Request") - l_message.replace_substring_all ("$status", "Bad Request" + description) - res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - -feature -- Resource not found - - send_resouce_not_found (req: WSF_REQUEST; res: WSF_RESPONSE) - local - l_message: STRING - do - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Resource not found") - l_message.replace_substring_all ("$status", "Resource " + req.request_uri + " not found 404") - res.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - res.put_string (l_message) - end - -feature -- Home Page - - web_page: STRING = "[ - - - - Generic Search Engine - - -
-

Generic Search Engine

-
-
- Search:
-
- -
- -
- -

-
- -
- - -
- - - -]" - -feature -- Generic Message - - message_template: STRING="[ - - - - $title - - - -
-
-

This page is an example of $status

- - - - -]" - - - - -end diff --git a/doc/workbook/generating_response/search/search.ecf b/doc/workbook/generating_response/search/search.ecf deleted file mode 100644 index 7c42d50b..00000000 --- a/doc/workbook/generating_response/search/search.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/generating_response/status/application.e b/doc/workbook/generating_response/status/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/generating_response/status/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/generating_response/status/application_execution.e b/doc/workbook/generating_response/status/application_execution.e deleted file mode 100644 index 691513b6..00000000 --- a/doc/workbook/generating_response/status/application_execution.e +++ /dev/null @@ -1,138 +0,0 @@ -note - description : "Basic Service that a simple web page to show the most common status codes" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_message: STRING - do - -- To send a response we need to setup, the status code and - -- the response headers. - if request.is_get_request_method then - if request.path_info.same_string ("/") then - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", web_page.count.out]>>) - response.put_string (web_page) - elseif request.path_info.same_string ("/redirect") then - send_redirect (request, response, "https://httpwg.github.io/") - elseif request.path_info.same_string ("/bad_request") then - -- Here you can do some logic for example log, send emails to register the error, before to send the response. - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Bad Request") - l_message.replace_substring_all ("$status", "Bad Request 400") - response.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - response.put_string (l_message) - elseif request.path_info.same_string ("/internal_error") then - -- Here you can do some logic for example log, send emails to register the error, before to send the response. - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Internal Server Error") - l_message.replace_substring_all ("$status", "Internal Server Error 500") - response.put_header ({HTTP_STATUS_CODE}.internal_server_error, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - response.put_string (l_message) - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Resource not found") - l_message.replace_substring_all ("$status", "Resource not found 400") - response.put_header ({HTTP_STATUS_CODE}.not_found, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - response.put_string (l_message) - end - else - create l_message.make_from_string (message_template) - l_message.replace_substring_all ("$title", "Method Not Allowed") - l_message.replace_substring_all ("$status", "Method Not Allowed 405") - -- Method not allowed - response.put_header ({HTTP_STATUS_CODE}.method_not_allowed, <<["Content-Type", "text/html"], ["Content-Length", l_message.count.out]>>) - response.put_string (l_message) - end - end - - -feature -- Home Page - - send_redirect (req: WSF_REQUEST; res: WSF_RESPONSE; a_location: READABLE_STRING_32) - -- Redirect to `a_location' - local - h: HTTP_HEADER - do - create h.make - h.put_content_type_text_html - h.put_current_date - h.put_location (a_location) - res.set_status_code ({HTTP_STATUS_CODE}.see_other) - res.put_header_text (h.string) - end - - web_page: STRING = "[ - - - - Example showing common status codes - - - -
-
-

This page is an example of Status Code 200

- -

Redirect Example

-

Click on the following link will redirect you to the HTTP Specifcation, we can do the redirect from the HTML directly but - here we want to show you an exmaple, where you can do something before to send a redirect Redirect

- -

Bad Request

-

Click on the following link, the server will answer with a 400 error, check the status code Bad Request

- -

Internal Server Error

-

Click on the following link, the server will answer with a 500 error, check the status code Internal Error

- -

Resource not found

-

Click on the following link or add to the end of the url something like /1030303 the server will answer with a 404 error, check the status code Not found

- -
- - - -]" - -feature -- Generic Message - - message_template: STRING="[ - - - - $title - - - -
-
-

This page is an example of $status

- - - - -]" - - - - -end diff --git a/doc/workbook/generating_response/status/status.ecf b/doc/workbook/generating_response/status/status.ecf deleted file mode 100644 index de47b96a..00000000 --- a/doc/workbook/generating_response/status/status.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_cookies/example/application.e b/doc/workbook/handling_cookies/example/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_cookies/example/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_cookies/example/application_execution.e b/doc/workbook/handling_cookies/example/application_execution.e deleted file mode 100644 index 56562904..00000000 --- a/doc/workbook/handling_cookies/example/application_execution.e +++ /dev/null @@ -1,141 +0,0 @@ -note - description : "Basic Service that build a generic front to demonstrate the use of Cookies" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_message: STRING - l_header: HTTP_HEADER - l_time: HTTP_DATE - l_cookies: STRING - l_answer: STRING - do - -- all the cookies - create l_cookies.make_empty - across request.cookies as ic loop - l_cookies.append (ic.item.name) - l_cookies.append("
") - end - - if request.path_info.same_string ("/") then - create l_header.make - create l_answer.make_from_string (web_page) - if request.cookie ("_EWF_Cookie") = Void then - -- First access the the home page, find a cookie with specific name `_EWF_Cookie' - l_answer.replace_substring_all ("$header_title", "Hey, thanks for access our cool site, this is your first acess") - l_answer.replace_substring_all ("$cookies", l_cookies) - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_header.put_cookie_with_expiration_date ("_EWF_Cookie", "EXAMPLE",l_time.date_time, "", Void, False, True) - else - -- No a new access - l_answer.replace_substring_all ("$header_title", "Welcome back, please check all the new things we have!!!") - l_answer.replace_substring_all ("$cookies", l_cookies) - end - l_header.put_content_type_text_html - l_header.put_content_length (l_answer.count) - response.put_header_text (l_header.string) - response.put_string (l_answer) - - elseif request.path_info.same_string ("/visitors") then - create l_header.make - create l_answer.make_from_string (visit_page) - if request.cookie ("_visits") = Void then - -- First access the the visit page, find a cookie with specific name `_visits' - l_answer.replace_substring_all ("$visit", "1") - l_answer.replace_substring_all ("$cookies", l_cookies) - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_header.put_cookie_with_expiration_date ("_visits", "1",l_time.date_time, "/visitors", Void, False, True) - - else - if attached {WSF_STRING} request.cookie ("_visits") as l_visit then - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_answer.replace_substring_all ("$visit", (l_visit.value.to_integer + 1).out ) - l_answer.replace_substring_all ("$cookies", l_cookies) - l_header.put_cookie_with_expiration_date ("_visits", (l_visit.value.to_integer + 1).out,l_time.date_time, "/visitors", Void, False, True) - end - end - create l_time.make_now_utc - l_time.date_time.second_add (120) - l_header.put_content_type_text_html - -- This cookie expires in 120 seconds, its valid for 120 seconds - l_header.put_cookie_with_expiration_date ("_Framework", "EWF",l_time.date_time, "/", Void, False, True) - -- This is a session cookie, valid only to the current browsing session. - l_header.put_cookie ("Session", "Cookie",Void, "/", Void, False, True) - l_header.put_content_length (l_answer.count) - response.add_header_text (l_header.string) - response.put_string (l_answer) - end - - end - -feature -- Home Page - - web_page: STRING = "[ - - - - EWF Handling Cookies - - -
-

$header_title

-
- -
- Visitors -
- -
-

Cookies for the home page

- $cookies -
- - -]" - - -visit_page: STRING = "[ - - - - EWF Handling Visit Page - - -
-

The number of visits is $visit

-
- -
-

Cookies for the Visit page

- $cookies -
-
- -
- Back to Home -
- - - - -]" - -end diff --git a/doc/workbook/handling_cookies/example/example.ecf b/doc/workbook/handling_cookies/example/example.ecf deleted file mode 100644 index dea25001..00000000 --- a/doc/workbook/handling_cookies/example/example.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_cookies/handling_cookies.md b/doc/workbook/handling_cookies/handling_cookies.md deleted file mode 100644 index d30ee90f..00000000 --- a/doc/workbook/handling_cookies/handling_cookies.md +++ /dev/null @@ -1,294 +0,0 @@ -Nav: [Workbook](../workbook.md) :: [Generating Responses](../generating_response/generating_response.md) - -# Handling Cookies - -- [Cookie](#cookie) - - [Cookie Porperties](#properties) -- [Write and Read Cookies](#set_get) - - [How to set a cookie](#set_cookie) - - [How to read a cookie](#read_cookie) -- [Examples](#examples) - - - -## 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. - -- HTTP State Management With Cookies - -- Personalized response to the client based on their preference, for example we can set background color as cookie in client browser and then use it to customize response background color, image etc. - -Server send cookies to the client - ->Set-Cookie: _Framework=EWF; Path=/; Expires=Tue, 10 Mar 2015 13:28:10 GMT; HttpOnly%R - - -Client send cookies to server - ->Cookie: _Framework=EWF - - - - - -### Cookie properties - - - Comment: describe the purpose of the cookie. Note that server doesn’t receive this information when client sends cookie in request header. - - Domain: domain name for the cookie. - - Expiration/MaxAge: Expiration time of the cookie, we could also set it in seconds. (At the moment Max-Age attribute is not supported) - - Name: name of the cookie. - - Path: path on the server to which the browser returns this cookie. Path instruct the browser to send cookie to a particular resource. - - Secure: True, if the browser is sending cookies only over a secure protocol, False in other case. - - Value: Value of th cookie as string. - - HttpOnly: Checks whether this Cookie has been marked as HttpOnly. - - Version: - - - -## 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 -```h.put_cookie_with_expiration_date``` feature, see `How to set Cookies` to learn the details, and the set it to response object **WSF_RESPONSE** as we saw previously. - -We will show an example. - -To Read incomming cookies we can read all the cookies with - -``` -cookies: ITERABLE [WSF_VALUE] - -- All cookies. -``` -which return an interable of WSF_VALUE objects corresponding to the cookies the browser has associated with the web site. -We can also check if a particular cookie by name using - -``` -WSF_REQUEST.cookie (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE - -- Field for name `a_name'. -``` -feature. - - - - -### How to set Cookies -Here we have the feature definitions to set cookies - -```eiffel -deferred class interface - HTTP_HEADER_MODIFIER - -feature -- Cookie - - put_cookie (key, value: READABLE_STRING_8; expiration, path, domain: detachable READABLE_STRING_8; secure, http_only: BOOLEAN) - -- Set a cookie on the client's machine - -- with key 'key' and value 'value'. - -- Note: you should avoid using "localhost" as `domain' for local cookies - -- since they are not always handled by browser (for instance Chrome) - require - make_sense: (key /= Void and value /= Void) and then (not key.is_empty and not value.is_empty) - domain_without_port_info: domain /= Void implies domain.index_of (':', 1) = 0 - - put_cookie_with_expiration_date (key, value: READABLE_STRING_8; expiration: DATE_TIME; path, domain: detachable READABLE_STRING_8; secure, http_only: BOOLEAN) - -- Set a cookie on the client's machine - -- with key 'key' and value 'value'. - require - make_sense: (key /= Void and value /= Void) and then (not key.is_empty and not value.is_empty) -``` - -Example of use: - -```eiffel - response_with_cookies (res: WSF_RESPONSE) - local - l_message: STRING - l_header: HTTP_HEADER - l_time: HTTP_DATE - do - create l_header.make - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_header.put_content_type_text_html - l_header.put_cookie_with_expiration_date ("EWFCookie", "EXAMPLE",l_time.date_time, "/", Void, False, True) - res.put_header_text (l_header.string) - res.put_string (web_page) - end -``` - - -### How to read Cookies - -Reading a particular cookie -```eiffel - if req.cookie ("EWFCookie") = Void then - do_something - end -```` - -Reading all the cookies - -```Eiffel - across req.cookies as ic loop - print (ic.item.name) - end -``` - - - - -### Example -The following EWF service shows a basic use of cookies. - 1. It display a message to first-time visitors. - 2. Display a welcome back message if a visitor return. - 3. A visitor page, counting the number of visits to the page (track user access counts). - 4. A cookie with an expiration of 120 seconds. - 5. A cookie with an session level, valid in browser session. - -```eiffel -note - description : "Basic Service that build a generic front to demonstrate the use of Cookies" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - -- Execute the incomming request - local - l_message: STRING - l_header: HTTP_HEADER - l_time: HTTP_DATE - l_cookies: STRING - l_answer: STRING - do - -- all the cookies - create l_cookies.make_empty - across req.cookies as ic loop - l_cookies.append (ic.item.name) - l_cookies.append("
") - end - - if req.path_info.same_string ("/") then - create l_header.make - create l_answer.make_from_string (web_page) - if req.cookie ("_EWF_Cookie") = Void then - -- First access the the home page, find a cookie with specific name `_EWF_Cookie' - l_answer.replace_substring_all ("$header_title", "Hey, thanks for access our cool site, this is your first acess") - l_answer.replace_substring_all ("$cookies", l_cookies) - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_header.put_cookie_with_expiration_date ("_EWF_Cookie", "EXAMPLE",l_time.date_time, "", Void, False, True) - else - -- No a new access - l_answer.replace_substring_all ("$header_title", "Welcome back, please check all the new things we have!!!") - l_answer.replace_substring_all ("$cookies", l_cookies) - end - l_header.put_content_type_text_html - l_header.put_content_length (l_answer.count) - res.put_header_text (l_header.string) - res.put_string (l_answer) - - elseif req.path_info.same_string ("/visitors") then - create l_header.make - create l_answer.make_from_string (visit_page) - if req.cookie ("_visits") = Void then - -- First access the the visit page, find a cookie with specific name `_visits' - l_answer.replace_substring_all ("$visit", "1") - l_answer.replace_substring_all ("$cookies", l_cookies) - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_header.put_cookie_with_expiration_date ("_visits", "1",l_time.date_time, "/visitors", Void, False, True) - - else - if attached {WSF_STRING} req.cookie ("_visits") as l_visit then - create l_time.make_now_utc - l_time.date_time.day_add (40) - l_answer.replace_substring_all ("$visit", (l_visit.value.to_integer + 1).out ) - l_answer.replace_substring_all ("$cookies", l_cookies) - l_header.put_cookie_with_expiration_date ("_visits", (l_visit.value.to_integer + 1).out,l_time.date_time, "/visitors", Void, False, True) - end - end - create l_time.make_now_utc - l_time.date_time.second_add (120) - l_header.put_content_type_text_html - -- This cookie expires in 120 seconds, its valid for 120 seconds - l_header.put_cookie_with_expiration_date ("_Framework", "EWF",l_time.date_time, "/", Void, False, True) - -- This is a session cookie, valid only to the current browsing session. - l_header.put_cookie ("Session", "Cookie",Void, "/", Void, False, True) - l_header.put_content_length (l_answer.count) - res.add_header_text (l_header.string) - res.put_string (l_answer) - end - - end - -feature -- Home Page - - web_page: STRING = "[ - - - - EWF Handling Cookies - - -
-

$header_title

-
- -
- Visitors -
- -
-

Cookies for the home page

- $cookies -
- - -]" - - -visit_page: STRING = "[ - - - - EWF Handling Visit Page - - -
-

The number of visits is $visit

-
- -
-

Cookies for the Visit page

- $cookies -
-
- -
- Back to Home -
- - - - -]" - -end - -``` - - -Nav: [Workbook](../workbook.md) :: [Generating Responses](../generating_response/generating_response.md) diff --git a/doc/workbook/handling_request/form.md b/doc/workbook/handling_request/form.md deleted file mode 100644 index 6cdf2416..00000000 --- a/doc/workbook/handling_request/form.md +++ /dev/null @@ -1,323 +0,0 @@ -Nav: [Workbook](../workbook.md) :: [Basic Concepts](../basics/basics.md) :: [Handling Requests: Header Fields](./headers.md) - -# Handling Requests: Form/Query Data - -##### Table of Contents -- [Reading Form Data](#read) - - [Query Parameters](#query) - - [Form Parameters](#form_parameters) - - [Uniform Read](#uniform) -- [Reading Parameters and Values](#reading_pv) - - [How to read all parameters names](#all_names) - - [How to read single values](#single_values) - - [How to read multiple values](#multiple_values) - - [How to read table values](#table_values) -- [Reading raw data](#raw_data) -- [Upload Files](#upload) -- [Examples](#examples) - - -An HTML Form can handle `GET` and `POST` requests. -When we use a form with method `GET`, the data is attached at the end of the url for example: - ->http://wwww.example.com/?key1=value1&...keyn=valuen - -If we use the method `POST`, the data is sent to the server in a different line. - -Extracting form data from the server side is one of the most tedious parts. If you do it by hand, you will need -to parse the input, you'll have to URL-decode the value. - -Here we will show you how to read input submitted by a user using a Form (`GET` and `POST`). - * How to handle missing values: - * client side validattion, server side validations, set default if it's a valid option. - * How to populate Eiffel objects from the request data. - - - -## Reading Form Data -EWF `WSF_REQUEST` class, provides features to handling this form parsing automatically. - - - -### Query Parameters - -```eiffel - WSF_REQUEST.query_parameters: ITERABLE [WSF_VALUE] - -- All query parameters - - WSF_REQUEST.query_parameter (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE - -- Query parameter for name `a_name'. -``` - - - -### Form Parameters - -```eiffel - WSF_REQUEST.form_parameters: ITERABLE [WSF_VALUE] - -- All form parameters sent by a POST - - WSF_REQUEST.form_parameter (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE - -- Field for name `a_name'. -``` - -The values supplied to `form_parameter` and `query_parameter` are _case_ _sensitive_. - - - -### 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. - -```eiffel - WSF_REQUEST.item (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE - -- Variable named `a_name' from any of the variables container - -- and following a specific order: form_, query_ and path_ parameters -``` - -So, you can use **WSF_REQUEST.item** feature exactly the same way for `GET` and `POST` request. - ->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` - - - - -## 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. - ->Note: it is recommended to validate client side input on the server side (as a double check) because you can protect against the malicious user, who can easily bypass your JavaScript and submit dangerous input to the server. - -``` -

EWF Handling Client Request: Form example

-
-
- Personal details -
- -
-
- -
-
- -
-
- -
-
-
-
- -
-
-
-``` - - -### How to read all parameter names -To read all the parameters names we simple call **WSF_REQUEST.form_parameters**. - -```eiffel - req: WSF_REQUEST - across req.form_parameters as ic loop show_parameter_name (ic.item.key) end -``` - - -### 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) -```eiffel - req: WSF_REQUEST - if attached {WSF_STRING} req.form_paramenter ('given-name') as l_given_name then - -- Work with the given parameter, for example populate an USER object - -- the argument is case sensitive - else - -- Value missing, check the name against the HTML form - end -``` - - -### 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) - -```eiffel - req: WSF_REQUEST - idioms: LIST[STRING] - -- the argument is case sensitive - if attached {WSF_MULTIPLE_STRING} req.form_paramenter ('languages') as l_languages then - -- Work with the given parameter, for example populate an USER object - -- Get all the associated values - create {ARRAYED_LIST[STRING]} idioms.make (2) - across l_languages as ic loop idioms.force (ic.item.value) end - elseif attached {WSF_STRING} req.form_paramenter ('languages') as l_language then - -- Value missing, check the name against the HTML form - create {ARRAYED_LIST[STRING]} idioms.make (1) - idioms.force (l_language.value) - else - -- Value missing - end -``` -In this case we are handling strings values, but in some cases you will need to do a conversion, between the strings that came from the request to map them to your domain model. - - - -### How to read table values -This is particularly useful when you have a request with the following format - -`````` - -To read table values, for example in the case of `tab`, we simple call **WSF_REQUEST.form_parameter (a_name)** and we check if it's attached to **WSF_TABLE**. - -```eiffel -if attached {WSF_TABLE} req.query_parameter ("tab") as l_tab then - l_parameter_names.append ("
") - l_parameter_names.append (l_tab.name) - from - l_tab.values.start - until - l_tab.values.after - loop - l_parameter_names.append ("
") - l_parameter_names.append (l_tab.values.key_for_iteration) - if attached {WSF_STRING} l_tab.value (l_tab.values.key_for_iteration) as l_value then - l_parameter_names.append ("=") - l_parameter_names.append (l_value.value) - end - l_tab.values.forth - end -end -``` - - - -## 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 will 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. - -To read raw data you need to do this - -```eiffel - l_raw_data:STRING - - req.set_raw_input_data_recorded (True) - create l_raw_data.make_empty - req.read_input_data_into (l_raw_data) -``` - -> 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 - - - -## Upload Files -How can we read data when the date come from an uploaded file/s?. -HTML supports a form element `````` to upload a single file and ``` ``` to upload multiple files. - -So supose we have the following form - -``` - - - - EWF Handling Client Request: File Upload Example - - -

EWF Handling Client Request: File Upload Example

-
-
- Upload file/s -
- -
-
- -
-
- - - -``` - -The class **WSF_REQUEST** has a mechanism to work with uploaded files. We can call the query - -```eiffel -WSF_REQUEST.has_uploaded_file: BOOLEAN - -- Has any uploaded file? -``` - -to check if the request form parameters has any uploaded file, we can call the feature - -```eiffel -WSF_REQUEST.uploaded_files: ITERABLE [WSF_UPLOADED_FILE] - -- uploaded files values - --| filename: original path from the user - --| type: content type - --| tmp_name: path to temp file that resides on server - --| tmp_base_name: basename of `tmp_name' - --| error: if /= 0 , there was an error : TODO ... - --| size: size of the file given by the http request -``` -to iterate over the uploaded files if any, and the details in the class **WSF_UPLOADED_FILE**. - -The following snipet code show how to work with Uploaded files using EWF **WSF_REQUEST** class, in the example -we build a simple html answer with basic information, if there is not uploaded files, we send a 400 status code -and a simple message. - -```eiffel - - if req.path_info.same_string ("/upload") then - -- Check if we have an uploaded file - if req.has_uploaded_file then - -- iterate over all the uploaded files - create l_answer.make_from_string ("

Uploaded File/s


") - across req.uploaded_files as ic loop - l_answer.append ("FileName:") - l_answer.append (ic.item.filename) - l_answer.append ("
Size:") - l_answer.append (ic.item.size.out) - l_answer.append ("
") - end - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>) - res.put_string (l_answer) - else - -- Here we should handle unexpected errors. - create l_answer.make_from_string ("No uploaded files
") - create l_answer.append ("Back to Home") - res.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>) - res.put_string (l_answer) - end - else - -- Handle error - end -``` -The source code is available on Github. You can get it by running the command: - -```git clone https://github.com/EiffelWebFramework/ewf.git``` - -The example is located in the directory $PATH/ewf/doc/workbook/upload_file where $PATH is where you run git clone. - - - - -## Examples -The source code is available on Github. You can get it by running the command: - -```git clone https://github.com/EiffelWebFramework/ewf.git``` - -The GET example is located in the directory $PATH/ewf/doc/workbook/form/get, and the post example is located in the directory $PATH/ewf_examples/workbook/form/post where $PATH is where you run git clone . To run open it using Eiffel Studio or just run theg following command - -```estudio -config .ecf -target ``` - ->Note: replace and with the corresponding values. - - -Nav: [Workbook](../workbook.md) :: [Basic Concepts](../basics/basics.md) :: [Handling Requests: Header Fields](./headers.md) diff --git a/doc/workbook/handling_request/form/get/application.e b/doc/workbook/handling_request/form/get/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/form/get/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/form/get/application_execution.e b/doc/workbook/handling_request/form/get/application_execution.e deleted file mode 100644 index 1fb05acd..00000000 --- a/doc/workbook/handling_request/form/get/application_execution.e +++ /dev/null @@ -1,101 +0,0 @@ -note - description : "Basic Service that show how to handle a GET request" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - file: WSF_FILE_RESPONSE - l_parameter_names: STRING - l_answer: STRING - idioms: LIST[STRING] - l_raw_data: STRING - do - if request.is_get_request_method then - if request.path_info.same_string ("/") then - create file.make_html ("form.html") - response.send (file) - elseif request.path_info.same_string ("/search") then - - -- (1) the parameter is case sensitive - if not (attached request.query_parameter ("GIVEN-NAME")) then - -- Wrong `GIVEN-NAME' need to be in lower case. - end - - -- (2) Multiple values - if attached {WSF_MULTIPLE_STRING} request.query_parameter ("languages") as l_languages then - -- Get all the associated values - create {ARRAYED_LIST[STRING]} idioms.make (2) - across l_languages as ic loop idioms.force (ic.item.value) end - elseif attached {WSF_STRING} request.query_parameter ("languages") as l_language then - -- Single value - print (l_language.value) - else - -- Value Missing - end - - -- Read the all parameters names and his values. - create l_parameter_names.make_from_string ("

Parameters Names

") - l_parameter_names.append ("
") - create l_answer.make_from_string ("

Parameter Names and Values

") - l_answer.append ("
") - across request.query_parameters as ic loop - l_parameter_names.append (ic.item.key) - l_parameter_names.append ("
") - - l_answer.append (ic.item.key) - l_answer.append_character ('=') - if attached {WSF_STRING} request.query_parameter (ic.item.key) as l_value then - l_answer.append_string (l_value.value) - end - l_answer.append ("
") - end - - l_parameter_names.append ("
") - l_parameter_names.append_string (l_answer) - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_parameter_names.count.out]>>) - response.put_string (l_parameter_names) - elseif request.path_info.same_string ("/link") then - -- WSF_TABLE example - create l_parameter_names.make_from_string ("

Parameters Name

") - if attached {WSF_TABLE} request.query_parameter ("tab") as l_tab then - l_parameter_names.append ("
") - l_parameter_names.append (l_tab.name) - - from - l_tab.values.start - until - l_tab.values.after - loop - l_parameter_names.append ("
") - l_parameter_names.append (l_tab.values.key_for_iteration) - if attached {WSF_STRING} l_tab.value (l_tab.values.key_for_iteration) as l_value then - l_parameter_names.append ("=") - l_parameter_names.append (l_value.value) - end - l_tab.values.forth - end - l_parameter_names.append ("
") - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_parameter_names.count.out]>>) - response.put_string (l_parameter_names) - - end - else - -- Here we should handle unexpected errors. - end - end - end - -end diff --git a/doc/workbook/handling_request/form/get/form.ecf b/doc/workbook/handling_request/form/get/form.ecf deleted file mode 100644 index 8dde5e4d..00000000 --- a/doc/workbook/handling_request/form/get/form.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/form/get/form.html b/doc/workbook/handling_request/form/get/form.html deleted file mode 100644 index 36673ba1..00000000 --- a/doc/workbook/handling_request/form/get/form.html +++ /dev/null @@ -1,49 +0,0 @@ - - - - EWF Handling Client Request: Search Form example - - -

EWF Handling Search Request: Form example

-
-
- Search by -
- -
-
- -
-
- -
-
- -
-
- -
-
-
-
- -
-
-
-

Example link

-
- Link -
- - \ No newline at end of file diff --git a/doc/workbook/handling_request/form/post/application.e b/doc/workbook/handling_request/form/post/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/form/post/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/form/post/application_execution.e b/doc/workbook/handling_request/form/post/application_execution.e deleted file mode 100644 index d893804e..00000000 --- a/doc/workbook/handling_request/form/post/application_execution.e +++ /dev/null @@ -1,83 +0,0 @@ -note - description : "Reading Parameters from a HTML FORM (method POST) " - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - file: WSF_FILE_RESPONSE - l_parameter_names: STRING - l_answer: STRING - idioms: LIST[STRING] - l_raw_data: STRING - do - if request.is_get_request_method then - create file.make_html ("form.html") - response.send (file) - elseif request.is_post_request_method then - request.set_raw_input_data_recorded (True) - - -- (3) Read Raw Data - create l_raw_data.make_empty - request.read_input_data_into (l_raw_data) - - -- (1) the parameter is case sensitive - if not (attached request.form_parameter ("GIVEN-NAME")) then - -- Wrong `GIVEN-NAME' need to be in lower case. - end - - -- (2) Multiple values - if attached {WSF_MULTIPLE_STRING} request.form_parameter ("languages") as l_languages then - -- Get all the associated values - create {ARRAYED_LIST[STRING]} idioms.make (2) - across l_languages as ic loop idioms.force (ic.item.value) end - elseif attached {WSF_STRING} request.form_parameter ("langauges") as l_language then - -- Single value - print (l_language.value) - else - -- Value Missing - end - - -- Read the all parameters names and his values. - create l_parameter_names.make_from_string ("

Parameters Names

") - l_parameter_names.append ("
") - create l_answer.make_from_string ("

Parameter Names and Values

") - l_answer.append ("
") - - across request.form_parameters as ic loop - l_parameter_names.append (ic.item.key) - l_parameter_names.append ("
") - - l_answer.append (ic.item.key) - l_answer.append_character ('=') - if attached {WSF_STRING} request.form_parameter (ic.item.key) as l_value then - l_answer.append_string (l_value.value) - end - l_answer.append ("
") - end - - l_parameter_names.append ("
") - l_parameter_names.append_string (l_answer) - l_parameter_names.append ("
") - l_parameter_names.append ("

Raw content

") - l_parameter_names.append (l_raw_data) - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_parameter_names.count.out]>>) - response.put_string (l_parameter_names) - else - -- Here we should handle unexpected errors. - end - end - -end diff --git a/doc/workbook/handling_request/form/post/form.ecf b/doc/workbook/handling_request/form/post/form.ecf deleted file mode 100644 index bd83b4bd..00000000 --- a/doc/workbook/handling_request/form/post/form.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/form/post/form.html b/doc/workbook/handling_request/form/post/form.html deleted file mode 100644 index 1e1b28c1..00000000 --- a/doc/workbook/handling_request/form/post/form.html +++ /dev/null @@ -1,56 +0,0 @@ - - - - EWF Handling Client Request: Form example - - -

EWF Handling Client Request: Form example

-
-
- Personal details -
- -
-
- -
-
- -
-
- -
-
- -
-
- -
-
- -
- -
-
-
- -
-
-
- - \ No newline at end of file diff --git a/doc/workbook/handling_request/headers.md b/doc/workbook/handling_request/headers.md deleted file mode 100644 index 416fdbfd..00000000 --- a/doc/workbook/handling_request/headers.md +++ /dev/null @@ -1,453 +0,0 @@ -Nav: [Workbook](../workbook.md) :: [Handling Requests: Form/Query parameters](./form.md) :: [Generating Responses](../generating_response/generating_response.md) - - -# Handling Requests: Headers - -##### 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`. -- Query parameters are encoded in the URL [GET requests](https://httpwg.github.io/specs/rfc7230.html#http.message). -- Form parameters are encoded in the request message for [POST/PUT requests.](https://httpwg.github.io/specs/rfc7230.html#http.message). - -A request usually includes the header fields [Accept, Accept-Encoding, Connection, Cookie, Host, Referer, and User-Agent](https://httpwg.github.io/specs/rfc7231.html#request.header), defining important information about how the server should process the request. And then, the server needs to read the request header fields to use those informations. - -##### Table of Contents -- [Reading HTTP Header fields](#read_header) -- [Reading HTTP Request line](#read_line) -- [Understanding HTTP header fields](#understand) - - [Accept](#accept) - - [Accept-Charset](#accept_charset) - - [Accept-Encoding](#accept_encoding) - - [Accept-Language](#accept_language) - - [Connection](#connection) - - [Authorization](#authorization) - - [Content-length](#content-length) - - [Cookie](#cookie) - - [Host](#host) - - [If-Modified-Since](#if-modified-since) - - [If-Unmodified-Since](#if-unmodified-since) - - [Referer](#referer) - - [User-Agent](#user-agent) -- [Example: Request Headers](#example) -- [Example: How to compress pages](#compress) -- [Example: Detecting Browser Types](#browser-types) -- [Example: CGI Variables](#cgi-variables) - - -That section explains how to read HTTP information sent by the browser via the request header fields. Mostly by defining the most important HTTP request header fields, for more information, read [HTTP 1.1 specification](https://httpwg.github.io/specs/). - -## Prerequisites -The Eiffel Web Framework is using the traditional Common Gateway Interface (CGI) programming interface to access the header fields, query and form parameters. -Among other, this means the header fields are exposed with associated CGI field names: -- the header field name are uppercased, and any dash "-" replaced by underscore "_". -- and also prefixed by "HTTP_" except for `CONTENT_TYPE` and `CONTENT_LENGTH`. -- For instance `X-Server` will be known as `HTTP_X_SERVER`. - - - -## Reading HTTP Header fields -EWF `WSF_REQUEST` class provides features to access HTTP headers. - -Reading most headers is straightforward by calling: -- the corresponding `http_*` functions such as `http_accept` for header "Accept". -- or indirectly using the `meta_string_variable (a_name)` function by passing the associated CGI field name. -In both cases, if the related header field is supplied by the request, the result is a string value, otherwise it is Void. - -Note: always check if the result of those functions is non-void before using it. - -* Cookies: - - To iterate on all cookies valued, use `cookies: ITERABLE [WSF_VALUE]` - - To retrieve a specific cookie value, use `cookie (a_name: READABLE_STRING_GENERAL): detachable WSF_VALUE` - -* Authorization - - To read the Authorization header, first check its type with: `auth_type: detachable READABLE_STRING_8` - - And its value via `http_authorization: detachable READABLE_STRING_8 --Contents of the Authorization: header from the current wgi_request, if there is one.` - -* Content_length - - If supplied, get the content length as an string value: `content_length: detachable READABLE_STRING_8` - - or directly as a natural value with `content_length_value: NATURAL_64` - -* Content_type - - If supplied, get the content type as an string value with `content_type: detachable HTTP_CONTENT_TYPE` - -Due to CGI compliance, the original header names are not available, however the function `raw_header_data` may return the http header data as a string value (warning: this may not be available, depending on the underlying connector). Apart from very specific cases (proxy, debugging, ...), it should not be useful. -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). - - - -#### Retrieve information from the Request Line - -For convenience, the following sections refer to a request starting with line: -``` -GET http://eiffel.org/search?q=EiffelBase HTTP/1.1 -``` - -Overview of the features - -* HTTP method - - The function `request_method: READABLE_STRING_8` gives access to the HTTP request method, (usually `GET` or `POST` in conventional Web Applications), but with the raise of REST APIs other methods are also frequently used such as `HEAD`, `PUT`, `DELETE`, `OPTIONS`, or `TRACE`. - A few functions helps determining quickly the nature of the request method: - - `is_get_request_method: BOOLEAN -- Is Current a GET request method?` - - `is_put_request_method: BOOLEAN -- Is Current a PUT request method?` - - `is_post_request_method: BOOLEAN -- Is Current a POST request method?` - - `is_delete_request_method: BOOLEAN -- Is Current a DELETE request method?` - - In our example the request method is `GET` - - * Query String - - The query string for the example is `q=EiffelBase` - - `query_string: READABLE_STRING_8` - - * Protocol - - The feature return the third part of the request line, which is generally HTTP/1.0 or HTTP/1.1. - - `server_protocol: READABLE_STRING_8` - In the example the request method is `HTTP/1.1` - - - - -#### 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. -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). - - - - * [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. - 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` - - - - * [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). - - - - * [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. - - - - * [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). - - - - * [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. - 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. - - - - * [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. - - - - * [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. - - - - * [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). - - - - * [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. - - - - * [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. - - - - * [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. - -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”). - - - - * [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. - -For example, if you are at Web page A and click on a link to Web page B, the URL of Web page A is -included in the Referer header when the browser requests Web page B. - - - - * [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. - -**Note**: the example shows the **WSF_EXECUTION** implementation, that will be used by the service launcher. - - - -#### Building a Table of All Request Headers - -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 also writes three components of the main request line (method, URI, and protocol), and also the raw header. - -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - -- Execute the incomming request - local - l_raw_data: STRING - l_page_response: STRING - l_rows: STRING - do - create l_page_response.make_from_string (html_template) - if req.path_info.same_string ("/") then - - -- HTTP method - l_page_response.replace_substring_all ("$http_method", req.request_method) - -- URI - l_page_response.replace_substring_all ("$uri", req.path_info) - -- Protocol - l_page_response.replace_substring_all ("$protocol", req.server_protocol) - - -- Fill the table rows with HTTP Headers - create l_rows.make_empty - across req.meta_variables as ic loop - if ic.item.name.starts_with ("HTTP_") then - l_rows.append ("") - l_rows.append ("") - l_rows.append (ic.item.name) - l_rows.append ("") - l_rows.append ("") - l_rows.append (ic.item.value) - l_rows.append ("") - l_rows.append ("") - end - end - - l_page_response.replace_substring_all ("$rows", l_rows) - - -- Reading the raw header - if attached req.raw_header_data as l_raw_header then - l_page_response.replace_substring_all ("$raw_header", l_raw_header) - end - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>) - res.put_string (l_page_response) - end - end - - html_template: STRING = "[ - - - - - - - -

EWF service example: Showing Request Headers

- - HTTP METHOD:$http_method
- URI:$uri
- PROTOCOL:$protocol
- REQUEST TIME:$time
- -
- - - - - - - - - $rows - -
Header NameHeader Value
- - -

Raw header

- - $raw_header - - - ]" -end -``` - - - -#### How to compress pages -To be completed. - - - - -#### Detecting Browser Types - -The User-Agent header identifies the specific browser/client that is sending the request. The following code shows an [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. -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``` feature to retrieve the current browser name or Unknown in other case. - -```eiffel -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute (req: WSF_REQUEST; res: WSF_RESPONSE) - -- Execute the incomming request - local - l_raw_data: STRING - l_page_response: STRING - l_rows: STRING - do - create l_page_response.make_from_string (html_template) - if req.path_info.same_string ("/") then - - -- retrieve the user-agent - if attached req.http_user_agent as l_user_agent then - l_page_response.replace_substring_all ("$user_agent", l_user_agent) - l_page_response.replace_substring_all ("$browser", browser_name (l_user_agent)) - else - l_page_response.replace_substring_all ("$user_agent", "[]") - l_page_response.replace_substring_all ("$browser", "Unknown, the user-agent was not present.") - end - res.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>) - res.put_string (l_page_response) - end - end - - -feature -- Browser utility - - browser_name (a_user_agent: READABLE_STRING_8): READABLE_STRING_32 - -- Browser name. - -- Must contain Must not contain - -- Firefox Firefox/xyz Seamonkey/xyz - -- Seamonkey Seamonkey/xyz - -- Chrome Chrome/xyz Chromium/xyz - -- Chromium Chromium/xyz - -- Safari Safari/xyz Chrome/xyz - -- Chromium/xyz - -- Opera OPR/xyz [1] - -- Opera/xyz [2] - -- Internet Explorer ;MSIE xyz; Internet Explorer doesn't put its name in the BrowserName/VersionNumber format - - do - if - a_user_agent.has_substring ("Firefox") and then - not a_user_agent.has_substring ("Seamonkey") - then - Result := "Firefox" - elseif a_user_agent.has_substring ("Seamonkey") then - Result := "Seamonkey" - elseif a_user_agent.has_substring ("Chrome") and then not a_user_agent.has_substring ("Chromium")then - Result := "Chrome" - elseif a_user_agent.has_substring ("Chromium") then - Result := "Chromiun" - elseif a_user_agent.has_substring ("Safari") and then not (a_user_agent.has_substring ("Chrome") or else a_user_agent.has_substring ("Chromium")) then - Result := "Safari" - elseif a_user_agent.has_substring ("OPR") or else a_user_agent.has_substring ("Opera") then - Result := "Opera" - elseif a_user_agent.has_substring ("MSIE") or else a_user_agent.has_substring ("Trident")then - Result := "Internet Explorer" - else - Result := "Unknown" - end - end - - - html_template: STRING = "[ - - - - - - -

EWF service example: Showing Browser Dectection Using User-Agent


- - User Agent: $user_agent
- -

Enjoy using $browser

- - - ]" -end -``` -Let see some results, we will show the html returned - -**Internet Explorer** ---- -``` -

EWF service example: Showing Browser Dectection Using User-Agent


- -User Agent: Mozilla/5.0 (Windows NT 6.3; WOW64; Trident/7.0; MDDCJS; rv:11.0) like Gecko
- -

Enjoy using Internet Explorer

-``` - -**Chrome** ---- -``` -

EWF service example: Showing Browser Dectection Using User-Agent


- -User Agent: Mozilla/5.0 (Windows NT 6.3; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/40.0.2214.91 Safari/537.36
- -

Enjoy using Chrome

-``` - -As an exercise, try to write a similar service to retrieve the OS family using the User-Agent information. - - - -[Meta-variables](https://tools.ietf.org/html/rfc3875#section-4.1) contains data about the request, they are identified by case-insensitive names. In this section, the purpose is to show a similar example to HEADERS FIELDS, but in this case building a table showing the standard CGI variables. - - - * [AUTH_TYPE](https://tools.ietf.org/html/rfc3875#section-4.1.1). - * [CONTENT_LENGTH](https://tools.ietf.org/html/rfc3875#section-4.1.2) - * [CONTENT_TYPE](https://tools.ietf.org/html/rfc3875#section-4.1.3) - * [GATEWAY_INTERFACE](https://tools.ietf.org/html/rfc3875#section-4.1.4) - * [PATH_INFO](https://tools.ietf.org/html/rfc3875#section-4.1.5) - * [PATH_TRANSLATED](https://tools.ietf.org/html/rfc3875#section-4.1.6) - * [QUERY_STRING](https://tools.ietf.org/html/rfc3875#section-4.1.7) - * [REMOTE_ADDR](https://tools.ietf.org/html/rfc3875#section-4.1.8) - * [REMOTE_HOST](https://tools.ietf.org/html/rfc3875#section-4.1.9) - * [REMOTE_IDENT](https://tools.ietf.org/html/rfc3875#section-4.1.10) - * [REMOTE_USER](https://tools.ietf.org/html/rfc3875#section-4.1.11) - * [REQUEST_METHOD](https://tools.ietf.org/html/rfc3875#section-4.1.12) - * [SCRIPT_NAME](https://tools.ietf.org/html/rfc3875#section-4.1.13) - * [SERVER_NAME](https://tools.ietf.org/html/rfc3875#section-4.1.14) - * [SERVER_PROTOCOL](https://tools.ietf.org/html/rfc3875#section-4.1.15) - * [SERVER_SOFTWARE](https://tools.ietf.org/html/rfc3875#section-4.1.16) - -**Example** -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](./form.md) :: [Generating Responses](../generating_response/generating_response.md) - diff --git a/doc/workbook/handling_request/headers/browser_name/application.e b/doc/workbook/handling_request/headers/browser_name/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/headers/browser_name/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/headers/browser_name/application_execution.e b/doc/workbook/handling_request/headers/browser_name/application_execution.e deleted file mode 100644 index 8ef85fd0..00000000 --- a/doc/workbook/handling_request/headers/browser_name/application_execution.e +++ /dev/null @@ -1,97 +0,0 @@ -note - description : "Basic Service that Read a Request, a " - date : "$Date$" - revision : "$Revision$" - EIS: "name=Browser detection using user agent","src=https://developer.mozilla.org/en-US/docs/Browser_detection_using_the_user_agent", "protocol=url" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_raw_data: STRING - l_page_response: STRING - l_rows: STRING - do - create l_page_response.make_from_string (html_template) - if request.path_info.same_string ("/") then - - -- retrieve the user-agent - if attached request.http_user_agent as l_user_agent then - l_page_response.replace_substring_all ("$user_agent", l_user_agent) - l_page_response.replace_substring_all ("$browser", browser_name (l_user_agent)) - else - l_page_response.replace_substring_all ("$user_agent", "[]") - l_page_response.replace_substring_all ("$browser", "Unknown, the user-agent was not present.") - end - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>) - response.put_string (l_page_response) - end - end - - -feature -- Browser utility - - browser_name (a_user_agent: READABLE_STRING_8): STRING_8 - -- Must contain Must not contain - -- Firefox Firefox/xyz Seamonkey/xyz - -- Seamonkey Seamonkey/xyz - -- Chrome Chrome/xyz Chromium/xyz - -- Chromium Chromium/xyz - -- Safari Safari/xyz Chrome/xyz - -- Chromium/xyz - -- Opera OPR/xyz [1] - -- Opera/xyz [2] - -- Internet Explorer ;MSIE xyz; Internet Explorer doesn't put its name in the BrowserName/VersionNumber format - - do - if - a_user_agent.has_substring ("Firefox") and then - not a_user_agent.has_substring ("Seamonkey") - then - Result := "Firefox" - elseif a_user_agent.has_substring ("Seamonkey") then - Result := "Seamonkey" - elseif a_user_agent.has_substring ("Chrome") and then not a_user_agent.has_substring ("Chromium")then - Result := "Chrome" - elseif a_user_agent.has_substring ("Chromium") then - Result := "Chromiun" - elseif a_user_agent.has_substring ("Safari") and then not (a_user_agent.has_substring ("Chrome") or else a_user_agent.has_substring ("Chromium")) then - Result := "Safari" - elseif a_user_agent.has_substring ("OPR") or else a_user_agent.has_substring ("Opera") then - Result := "Opera" - elseif a_user_agent.has_substring ("MSIE") or else a_user_agent.has_substring ("Trident")then - Result := "Internet Explorer" - else - Result := "Unknown" - end - end - - - html_template: STRING = "[ - - - - - - -

EWF service example: Showing Browser Dectection Using User-Agent


- - User Agent: $user_agent
- -

Enjoy using $browser

- - - ]" - - -end diff --git a/doc/workbook/handling_request/headers/browser_name/browsers.ecf b/doc/workbook/handling_request/headers/browser_name/browsers.ecf deleted file mode 100644 index bb1df575..00000000 --- a/doc/workbook/handling_request/headers/browser_name/browsers.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/headers/cgi_variables/application.e b/doc/workbook/handling_request/headers/cgi_variables/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/headers/cgi_variables/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/headers/cgi_variables/application_execution.e b/doc/workbook/handling_request/headers/cgi_variables/application_execution.e deleted file mode 100644 index 10063855..00000000 --- a/doc/workbook/handling_request/headers/cgi_variables/application_execution.e +++ /dev/null @@ -1,303 +0,0 @@ -note - description : "Basic Service that shows the standard CGI variables" - date : "$Date$" - revision : "$Revision$" - EIS: "name=CGI specification","src=(https://tools.ietf.org/html/rfc3875", "protocol=url" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_raw_data: STRING - l_page_response: STRING - l_rows: STRING - do - create l_page_response.make_from_string (html_template) - if request.path_info.same_string ("/") then - - -- HTTP method - l_page_response.replace_substring_all ("$http_method", request.request_method) - -- URI - l_page_response.replace_substring_all ("$uri", request.path_info) - -- Protocol - l_page_response.replace_substring_all ("$protocol", request.server_protocol) - - -- Fill the table rows with CGI standard variables - create l_rows.make_empty - - -- Auth_type - l_rows.append ("") - l_rows.append ("") - l_rows.append ("AUTH_TYPE") - l_rows.append ("") - l_rows.append ("") - if attached request.auth_type as l_type then - l_rows.append (l_type) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - -- Content length - l_rows.append ("") - l_rows.append ("") - l_rows.append ("CONTENT_LENGTH") - l_rows.append ("") - l_rows.append ("") - if attached request.content_length as l_content_length then - l_rows.append (l_content_length) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - -- Content length - l_rows.append ("") - l_rows.append ("") - l_rows.append ("CONTENT_TYPE") - l_rows.append ("") - l_rows.append ("") - if attached request.content_type as l_content_type then - l_rows.append (l_content_type.string) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - -- Gateway interface - l_rows.append ("") - l_rows.append ("") - l_rows.append ("GATEWAY_INTERFACE") - l_rows.append ("") - l_rows.append ("") - if attached request.gateway_interface as l_gateway_interface then - l_rows.append (l_gateway_interface) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - -- Path info - l_rows.append ("") - l_rows.append ("") - l_rows.append ("PATH_INFO") - l_rows.append ("") - l_rows.append ("") - if attached request.path_info as l_path_info then - l_rows.append (l_path_info) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - -- Path translated - l_rows.append ("") - l_rows.append ("") - l_rows.append ("PATH_TRANSLATED") - l_rows.append ("") - l_rows.append ("") - if attached request.path_translated as l_path_translated then - l_rows.append (l_path_translated) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - -- Query string - l_rows.append ("") - l_rows.append ("") - l_rows.append ("QUERY_STRING") - l_rows.append ("") - l_rows.append ("") - if attached request.query_string as l_query_string then - l_rows.append (l_query_string) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - -- Remote addr - l_rows.append ("") - l_rows.append ("") - l_rows.append ("REMOTE_ADDR") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.remote_addr) - l_rows.append ("") - l_rows.append ("") - - - -- Remote host - l_rows.append ("") - l_rows.append ("") - l_rows.append ("REMOTE_HOST") - l_rows.append ("") - l_rows.append ("") - if attached request.remote_host as l_remote_host then - l_rows.append (l_remote_host) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - - -- Remote ident - l_rows.append ("") - l_rows.append ("") - l_rows.append ("REMOTE_IDENT") - l_rows.append ("") - l_rows.append ("") - if attached request.remote_ident as l_remote_ident then - l_rows.append (l_remote_ident) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - -- Remote user - l_rows.append ("") - l_rows.append ("") - l_rows.append ("REMOTE_USER") - l_rows.append ("") - l_rows.append ("") - if attached request.remote_user as l_remote_user then - l_rows.append (l_remote_user) - else - l_rows.append ("Not present") - end - l_rows.append ("") - l_rows.append ("") - - - -- Request method - l_rows.append ("") - l_rows.append ("") - l_rows.append ("REQUEST_METHOD") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.request_method) - l_rows.append ("") - l_rows.append ("") - - - -- Script name - l_rows.append ("") - l_rows.append ("") - l_rows.append ("SCRIPT_NAME") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.script_name) - l_rows.append ("") - l_rows.append ("") - - -- Server name - l_rows.append ("") - l_rows.append ("") - l_rows.append ("SERVER_NAME") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.server_name) - l_rows.append ("") - l_rows.append ("") - - -- Server protocol - l_rows.append ("") - l_rows.append ("") - l_rows.append ("SERVER_PROTOCOL") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.server_protocol) - l_rows.append ("") - l_rows.append ("") - - -- Server software - l_rows.append ("") - l_rows.append ("") - l_rows.append ("SERVER_SOFTWARE") - l_rows.append ("") - l_rows.append ("") - l_rows.append (request.server_software) - l_rows.append ("") - l_rows.append ("") - - - l_page_response.replace_substring_all ("$rows", l_rows) - - -- Reading the raw header - if attached request.raw_header_data as l_raw_header then - l_page_response.replace_substring_all ("$raw_header", l_raw_header) - end - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>) - response.put_string (l_page_response) - end - end - - - - html_template: STRING = "[ - - - - - - - -

EWF service example: Showing Standard CGI Variables

- - HTTP METHOD:$http_method
- URI:$uri
- PROTOCOL:$protocol
- -
- - - - - - - - - $rows - -
CGI NameValue
- - -

Raw header

- - $raw_header - - - ]" - - -end diff --git a/doc/workbook/handling_request/headers/cgi_variables/cgi_variables.ecf b/doc/workbook/handling_request/headers/cgi_variables/cgi_variables.ecf deleted file mode 100644 index 8ba57e16..00000000 --- a/doc/workbook/handling_request/headers/cgi_variables/cgi_variables.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/headers/header_fields/application.e b/doc/workbook/handling_request/headers/header_fields/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/headers/header_fields/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/headers/header_fields/application_execution.e b/doc/workbook/handling_request/headers/header_fields/application_execution.e deleted file mode 100644 index 9f3242fc..00000000 --- a/doc/workbook/handling_request/headers/header_fields/application_execution.e +++ /dev/null @@ -1,105 +0,0 @@ -note - description : "Basic Service that Read Request Headers" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - l_raw_data: STRING - l_page_response: STRING - l_rows: STRING - do - create l_page_response.make_from_string (html_template) - if request.path_info.same_string ("/") then - - -- HTTP method - l_page_response.replace_substring_all ("$http_method", request.request_method) - -- URI - l_page_response.replace_substring_all ("$uri", request.path_info) - -- Protocol - l_page_response.replace_substring_all ("$protocol", request.server_protocol) - - -- Fill the table rows with HTTP Headers - create l_rows.make_empty - across request.meta_variables as ic loop - if ic.item.name.starts_with ("HTTP_") then - l_rows.append ("") - l_rows.append ("") - l_rows.append (ic.item.name) - l_rows.append ("") - l_rows.append ("") - l_rows.append (ic.item.value) - l_rows.append ("") - l_rows.append ("") - end - end - - l_page_response.replace_substring_all ("$rows", l_rows) - - -- Reading the raw header - if attached request.raw_header_data as l_raw_header then - l_page_response.replace_substring_all ("$raw_header", l_raw_header) - end - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-Type", "text/html"], ["Content-Length", l_page_response.count.out]>>) - response.put_string (l_page_response) - end - end - - - - html_template: STRING = "[ - - - - - - - -

EWF service example: Showing Request Headers

- - HTTP METHOD:$http_method
- URI:$uri
- PROTOCOL:$protocol
- REQUEST TIME:$time
- -
- - - - - - - - - $rows - -
Header NameHeader Value
- - -

Raw header

- - $raw_header - - - ]" - - -end diff --git a/doc/workbook/handling_request/headers/header_fields/header_fields.ecf b/doc/workbook/handling_request/headers/header_fields/header_fields.ecf deleted file mode 100644 index 39e2f8a0..00000000 --- a/doc/workbook/handling_request/headers/header_fields/header_fields.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/upload_file/application.e b/doc/workbook/handling_request/upload_file/application.e deleted file mode 100644 index cf939f60..00000000 --- a/doc/workbook/handling_request/upload_file/application.e +++ /dev/null @@ -1,24 +0,0 @@ -note - description: "Basic Service launcher" - -class - APPLICATION - -inherit - WSF_DEFAULT_SERVICE [APPLICATION_EXECUTION] - redefine - initialize - end - -create - make_and_launch - -feature {NONE} -- Initialization - - initialize - -- Initialize current service. - do - set_service_option ("port", 9090) - end - -end diff --git a/doc/workbook/handling_request/upload_file/application_execution.e b/doc/workbook/handling_request/upload_file/application_execution.e deleted file mode 100644 index 8186494e..00000000 --- a/doc/workbook/handling_request/upload_file/application_execution.e +++ /dev/null @@ -1,58 +0,0 @@ -note - description : "Basic Service that show how to Upload a file" - date : "$Date$" - revision : "$Revision$" - -class - APPLICATION_EXECUTION - -inherit - WSF_EXECUTION - -create - make - -feature -- Basic operations - - execute - -- Execute the incomming request - local - file: WSF_FILE_RESPONSE - l_answer: STRING - do - if request.is_get_request_method then - if request.path_info.same_string ("/") then - create file.make_html ("upload.html") - response.send (file) - else - -- Here we should handle unexpected errors. - end - elseif request.is_post_request_method then - if request.path_info.same_string ("/upload") then - -- Check if we have an uploaded file - if request.has_uploaded_file then - -- iterate over all the uploaded files - create l_answer.make_from_string ("

Uploaded File/s


") - across request.uploaded_files as ic loop - l_answer.append ("FileName:") - l_answer.append (ic.item.filename) - l_answer.append ("
Size:") - l_answer.append (ic.item.size.out) - l_answer.append ("
") - end - response.put_header ({HTTP_STATUS_CODE}.ok, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>) - response.put_string (l_answer) - else - -- Here we should handle unexpected errors. - create l_answer.make_from_string ("No uploaded files
") - l_answer.append ("Back to Home") - response.put_header ({HTTP_STATUS_CODE}.bad_request, <<["Content-type","text/html"],["Content-lenght", l_answer.count.out]>>) - response.put_string (l_answer) - end - else - -- Handle error - end - end - end - -end diff --git a/doc/workbook/handling_request/upload_file/upload.ecf b/doc/workbook/handling_request/upload_file/upload.ecf deleted file mode 100644 index 0722e151..00000000 --- a/doc/workbook/handling_request/upload_file/upload.ecf +++ /dev/null @@ -1,42 +0,0 @@ - - - - - /.svn$ - /CVS$ - /EIFGENs$ - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/doc/workbook/handling_request/upload_file/upload.html b/doc/workbook/handling_request/upload_file/upload.html deleted file mode 100644 index 9fde7944..00000000 --- a/doc/workbook/handling_request/upload_file/upload.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - EWF Handling Client Request: File Upload Example - - -

EWF Handling Client Request: File Upload Example

-
-
- Upload file/s -
- -
-
- -
-
- - - \ No newline at end of file diff --git a/doc/workbook/workbook.md b/doc/workbook/workbook.md deleted file mode 100644 index 558f2fde..00000000 --- a/doc/workbook/workbook.md +++ /dev/null @@ -1,2 +0,0 @@ -See [README](./readme.md) - diff --git a/doc/workbook/wui/readme.md b/doc/workbook/wui/readme.md deleted file mode 100644 index c7e24e0b..00000000 --- a/doc/workbook/wui/readme.md +++ /dev/null @@ -1,238 +0,0 @@ -# Web User Interface (WUI) - -When it comes to web user interface, HTML, CSS and Javascript are part of the solution. -To generate the HTML and CSS, there are many solution, among them: -* use template (such as can use templates like the [Eiffel Smarty lib](https://github.com/EiffelSoftware/EiffelStudio/tree/master/Src/contrib/library/text/template/smarty) -* generate the html from the Eiffel code directly -* use high level components that generate the html themselves. - -Within the EiffelWeb framework, the `wsf_html` library provides classes to build a structured representation of html and then generate expected HTML. - - -## Overview -The [`wsf_html` library](https://github.com/EiffelWebFramework/EWF/tree/master/library/server/wsf_html) provides: - -* `CSS_*` classes to generate CSS style. -* `WSF_WIDGET_*` classes representing HTML widget (such as `HTML Response") - response.send (mesg) - end -``` - -In this case, the html is hardcoded, and written manually. -Now let's see how to use the WSF widgets on a more advanced usecase, a simple sign-in web form with 2 input fields `username`, `password` and `submit` button. - -```eiffel -execute - do - -- Basic url dispatching... - if request.is_post_request_method then - execute_web_form_submission - else - execute_web_form_display - end - end - -execute_web_form_display - local - mesg: WSF_HTML_PAGE_RESPONSE - f: WSF_FORM - l_html: STRING - do - -- Build the web form - f := new_login_form - - -- Html generation - --| the first argument of `to_html` is the theme for advanced usage you can provide a custom theme - --| that can redefine how to generate link for instance. - l_html := f.to_html (create {WSF_REQUEST_THEME}.make_with_request (request)) - - -- Send the response - create mesg.make - mesg.set_title ("This is a Web form") - mesg.set_body (l_html) - response.send (mesg) - end - -execute_web_form_submission - do - ... this will be explain in next section ! - end - -new_login_form: WSF_FORM - local - f: WSF_FORM - f_set: WSF_FORM_FIELD_SET - f_username: WSF_FORM_TEXT_INPUT - f_password: WSF_FORM_PASSWORD_INPUT - f_submit: WSF_FORM_SUBMIT_INPUT - do - -- Build the web form - create f.make ("/form", "form-login") -- The form id is optional. - f.set_method_post -- it could also use the default GET method. - - -- Put specific html code - f.extend_html_text ("

Web form example

") - - -- username input field - create f_username.make ("username") - f_username.set_label ("User name") - f.extend (f_username) - - -- password input field - create f_password.make ("password") - f_password.set_label ("Password") - f.extend (f_password) - - -- submit button - create f_submit.make_with_text ("op", "Login") - f.extend (f_submit) - - Result := f - end -``` - -## Handling web form data - -When a form is submitted, the code can access the request data thanks to the `request: WSF_REQUEST` attribute. -See [Handling requests section](../handling_request/form.md) - -The `wsf_html` library, thanks to the `WSF_FORM`, provides a more powerful solution. -Indeed `WSF_HTML.process (request, .., ..)` analyze the request, fill the form fields, and process various validations, and submissions automatically. - -See - -```eiffel -process (req: WSF_REQUEST; a_before_callback, a_after_callback: detachable PROCEDURE [WSF_FORM_DATA]) - -- Process Current form with request `req`, - -- and build `last_data: WSF_FORM_DATA` object containing the field values. - -- agent `a_before_callback` is called before the validation - -- agent `a_after_callback` is called after the validation -``` - -In our previous sample code, `execute_web_form_submission` could be: - -```eiffel -execute_web_form_submission - local - mesg: WSF_HTML_PAGE_RESPONSE - l_html: STRING - f: WSF_FORM - do - create mesg.make - mesg.set_title ("Web form submission") - create l_html.make_empty - - -- Build again the same form. - f := new_login_form - - -- Process this form with `request` data. - f.process (request, Void, Void) - if attached f.last_data as form_data and then not form_data.has_error then - -- `form_data` contains the submitted fields with their value. - - -- Depending on the form data, display a response. - l_html.append ("Username: ") - if attached form_data.string_item ("username") as l_username then - -- The username may contain unicode, or characters like '<' - -- thus, it needs to be html encoded - l_html.append (mesg.html_encoded_string (l_username)) - else - l_html.append ("missing value !!") - end - l_html.append ("
") - if attached form_data.string_item ("password") as l_password then - l_html.append ("Password: ") - -- The password may contain unicode, or characters like '<' - -- thus, it needs to be html encoded - l_html.append (mesg.html_encoded_string (l_password)) - else - l_html.append ("missing value !!") - end - l_html.append ("
") - else - l_html.append ("Error while processing the web form!") - - -- Display again the form (it will contain the submitted values, if any). - f.append_to_html (create {WSF_REQUEST_THEME}.make_with_request (request), l_html) - end - - mesg.set_body (l_html) - response.send (mesg) - end -``` - -In this case, the code could report an error if the username is empty, or with unwanted character ... this could be done in the `execute_web_form_submission` code, but it is also possible to set validation on each form field. -If those validations reports error, then the `form_data.has_error` will be True. - -To set validation, -For instance, in previous sample, accepts only alpha-numeric characters: - -```eiffel -f_username.set_description ("Only alpha-numeric character are accepted.") -f_username.set_validation_action (agent (fd: WSF_FORM_DATA) - do - if attached fd.string_item ("username") as u then - if across u as ic some not ic.item.is_alpha_numeric end then - fd.report_invalid_field ("username", "Missing username value!") - elseif u.is_whitespace then - fd.report_invalid_field ("username", "Empty username value!") - end - else - fd.report_invalid_field ("username", "Missing username value!") - end - end) -``` - -Notes: -* If the validation is not satisfied, the form data will report `has_error` as True, and the associated form will be updated with submitted values, and with `class="error"` set to the related html code. -The errors are also available via the `form_data.errors` feature. -* Since the validation feature argument is the `WSF_FORM_DATA` itself, it is also possible to validate several fields at once. - -If there is no error, the form submission process will trigger the `WSF_FORM.submit_actions`. This could be used when the form is built by different components, and each component will handle the submission of its associated fields. - - -## Catalog of widgets -The `wsf_html` library includes a collection of widgets and form items: - -### `WSF_WIDGET_...` -* `.._DIV`: `..
` html element. -* `.._IMAGE`: `` html element. -* `.._RAW_TEXT`: html escaped text. -* `.._TEXT`: html text. -And more advanced widgets such as: -* `.._PAGER`: to generate pager widget like ` << 1 2 3 .. >> ` -* `.._TABLE`: a set of classes to generate `` html element. - - -### `WSF_FORM_...` -Widget usually included in web forms, such as -* `WSF_FORM_*_INPUT`: text, password, file, submit, ... -* `WSF_FORM_FIELD_SET`, `.._TEXTAREA` ... - - -## What about CSS style -The `CSS_STYLE`, `CSS_SELECTOR` and `CSS_TEXT` can be used to generate CSS style sheat, but they can also be used to set css style to `WSF_WIDGET`. - - -## Potential future evolutions -For now, the `wsf_html` provides a simple solution to build web form. It is always possible to add new `WSF_WIDGET` to support more html elements. -Advanced usage could be built on top of the `wsf_html` to include for instance javascript actions, but this is out of the scope of `wsf_html` . - -