mirrors/EWF
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Removed extra indentations in code.

Browse Source
This commit is contained in:
Jocelyn FIAT
2017-02-14 19:51:23 +01:00
parent f216e98430
commit ff8da87fe3
1 changed files with 127 additions and 129 deletions
Download Patch File Download Diff File Expand all files Collapse all files

254
doc/workbook/wui/readme.md
View File

@@ -24,89 +24,88 @@ A simple solution to return html content is to use the `WSF_HTML_PAGE_RESPONSE`
In a `WSF_EXECUTION` descendant, see how to implement the `execute` procedure.
```
execute
local
mesg: WSF_HTML_PAGE_RESPONSE
do
create mesg.make
mesg.set_title ("This is an HTML page")
mesg.set_body ("<h1>HTML Response</h1>")
response.send (mesg)
end
execute
local
mesg: WSF_HTML_PAGE_RESPONSE
do
create mesg.make
mesg.set_title ("This is an HTML page")
mesg.set_body ("<h1>HTML Response</h1>")
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.
```
execute
do
-- Basic url dispatching...
if request.is_post_request_method then
execute_web_form_submission
else
execute_web_form_display
end
end
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
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))
-- 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
-- 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
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.
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 ("<h1>Web form example</h1>")
-- Put specific html code
f.extend_html_text ("<h1>Web form example</h1>")
-- username input field
create f_username.make ("username")
f_username.set_label ("User name")
f.extend (f_username)
-- 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)
-- 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)
-- submit button
create f_submit.make_with_text ("op", "Login")
f.extend (f_submit)
Result := f
end
Result := f
end
```
## Handling web form data
@@ -120,63 +119,63 @@ Indeed `WSF_HTML.process (request, .., ..)` analyze the request, fill the form f
See
```
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
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:
```
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
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
-- 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.
-- 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 ("<br/>")
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 ("<br/>")
else
l_html.append ("Error while processing the web form!")
-- 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 ("<br/>")
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 ("<br/>")
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
-- 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
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.
@@ -186,19 +185,19 @@ To set validation,
For instance, in previous sample, accepts only alpha-numeric characters:
```
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)
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:
@@ -237,4 +236,3 @@ For now, the `wsf_html` provides a simple solution to build web form. It is alwa
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` .