Automatic generation produced by ISE Eiffel
indexing
description: "The abstract class used to handle a specific group of user requests"
author: "Peizhu Li, <lip@student.ethz.ch>"
date: "12.12.2007"
revision: "$0.6$"
deferred class
REQUEST_HANDLER
feature {NONE} -- Initialization
default_create
-- Process instances of classes with no creation clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
feature -- Access
generating_type: STRING_8
-- Name of current object's generating type
-- (type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generating_type_not_void: Result /= Void
generating_type_not_empty: not Result.is_empty
end
generator: STRING_8
-- Name of current object's generating class
-- (base class of the type of which it is a direct instance)
-- (from ANY)
external
"built_in"
ensure -- from ANY
generator_not_void: Result /= Void
generator_not_empty: not Result.is_empty
end
feature -- Comparison
frozen deep_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void
-- or attached to isomorphic object structures?
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_deep_equal (other)
end
ensure -- from ANY
shallow_implies_deep: standard_equal (some, other) implies Result
both_or_none_void: (some = Void) implies (Result = (other = Void))
same_type: (Result and (some /= Void)) implies some.same_type (other)
symmetric: Result implies deep_equal (other, some)
end
frozen equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached
-- to objects considered equal?
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.is_equal (other))
end
frozen is_deep_equal (other: like Current): BOOLEAN
-- Are `Current' and `other' attached to isomorphic object structures?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
shallow_implies_deep: standard_is_equal (other) implies Result
same_type: Result implies same_type (other)
symmetric: Result implies other.is_deep_equal (Current)
end
is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object considered
-- equal to current object?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
do
Result := standard_is_equal (other)
ensure -- from ANY
symmetric: Result implies other.is_equal (Current)
consistent: standard_is_equal (other) implies Result
end
frozen standard_equal (some: ANY; other: like arg #1): BOOLEAN
-- Are `some' and `other' either both void or attached to
-- field-by-field identical objects of the same type?
-- Always uses default object comparison criterion.
-- (from ANY)
do
if some = Void then
Result := other = Void
else
Result := other /= Void and then some.standard_is_equal (other)
end
ensure -- from ANY
definition: Result = (some = Void and other = Void) or else ((some /= Void and other /= Void) and then some.standard_is_equal (other))
end
frozen standard_is_equal (other: like Current): BOOLEAN
-- Is `other' attached to an object of the same type
-- as current object, and field-by-field identical to it?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
same_type: Result implies same_type (other)
symmetric: Result implies other.standard_is_equal (Current)
end
feature -- Status report
conforms_to (other: ANY): BOOLEAN
-- Does type of current object conform to type
-- of `other' (as per Eiffel: The Language, chapter 13)?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
end
same_type (other: ANY): BOOLEAN
-- Is type of current object identical to type of `other'?
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
external
"built_in"
ensure -- from ANY
definition: Result = (conforms_to (other) and other.conforms_to (Current))
end
feature -- Duplication
frozen clone (other: ANY): like other
obsolete "Use `twin' instead."
-- Void if `other' is void; otherwise new object
-- equal to `other'
--
-- For non-void `other', clone calls copy;
-- to change copying/cloning semantics, redefine copy.
-- (from ANY)
do
if other /= Void then
Result := other.twin
end
ensure -- from ANY
equal: equal (Result, other)
end
copy (other: like Current)
-- Update current object using fields of object attached
-- to `other', so as to yield equal objects.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
external
"built_in"
ensure -- from ANY
is_equal: is_equal (other)
end
frozen deep_clone (other: ANY): like other
obsolete "Use `deep_twin' instead."
-- Void if `other' is void: otherwise, new object structure
-- recursively duplicated from the one attached to `other'
-- (from ANY)
do
if other /= Void then
Result := other.deep_twin
end
ensure -- from ANY
deep_equal: deep_equal (other, Result)
end
frozen deep_copy (other: like Current)
-- Effect equivalent to that of:
-- copy (`other' . deep_twin)
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
do
copy (other.deep_twin)
ensure -- from ANY
deep_equal: deep_equal (Current, other)
end
frozen deep_twin: like Current
-- New object structure recursively duplicated from Current.
-- (from ANY)
external
"built_in"
ensure -- from ANY
deep_twin_not_void: Result /= Void
deep_equal: deep_equal (Current, Result)
end
frozen standard_clone (other: ANY): like other
obsolete "Use `standard_twin' instead."
-- Void if `other' is void; otherwise new object
-- field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
do
if other /= Void then
Result := other.standard_twin
end
ensure -- from ANY
equal: standard_equal (Result, other)
end
frozen standard_copy (other: like Current)
-- Copy every field of `other' onto corresponding field
-- of current object.
-- (from ANY)
require -- from ANY
other_not_void: other /= Void
type_identity: same_type (other)
external
"built_in"
ensure -- from ANY
is_standard_equal: standard_is_equal (other)
end
frozen standard_twin: like Current
-- New object field-by-field identical to `other'.
-- Always uses default copying semantics.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.standard_copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
standard_twin_not_void: Result /= Void
equal: standard_equal (Result, Current)
end
frozen twin: like Current
-- New object equal to `Current'
-- twin calls copy; to change copying/twining semantics, redefine copy.
-- (from ANY)
local
l_temp: BOOLEAN
do
l_temp := {ISE_RUNTIME}.check_assert (False)
Result ?= {ISE_RUNTIME}.c_standard_clone ($Current)
Result.copy (Current)
l_temp := {ISE_RUNTIME}.check_assert (l_temp)
ensure -- from ANY
twin_not_void: Result /= Void
is_equal: Result.is_equal (Current)
end
feature -- Basic operations
frozen default: like Current
-- Default value of object's type
-- (from ANY)
do
end
frozen default_pointer: POINTER
-- Default value of type `POINTER'
-- (Avoid the need to write `p'.default for
-- some `p' of type `POINTER'.)
-- (from ANY)
do
end
default_rescue
-- Process exception for routines with no Rescue clause.
-- (Default: do nothing.)
-- (from ANY)
do
end
frozen do_nothing
-- Execute a null action.
-- (from ANY)
do
end
feature -- Output
io: STD_FILES
-- Handle to standard file setup
-- (from ANY)
once
create Result
Result.set_output_default
ensure -- from ANY
io_not_void: Result /= Void
end
out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
do
Result := tagged_out
ensure -- from ANY
out_not_void: Result /= Void
end
print (some: ANY)
-- Write terse external representation of `some'
-- on standard output.
-- (from ANY)
do
if some /= Void then
io.put_string (some.out)
end
end
frozen tagged_out: STRING_8
-- New string containing terse printable representation
-- of current object
-- (from ANY)
external
"built_in"
ensure -- from ANY
tagged_out_not_void: Result /= Void
end
feature -- Platform
operating_environment: OPERATING_ENVIRONMENT
-- Objects available from the operating system
-- (from ANY)
once
create Result
ensure -- from ANY
operating_environment_not_void: Result /= Void
end
feature {NONE} -- Retrieval
frozen internal_correct_mismatch
-- Called from runtime to perform a proper dynamic dispatch on `correct_mismatch'
-- from MISMATCH_CORRECTOR.
-- (from ANY)
local
l_corrector: MISMATCH_CORRECTOR
l_msg: STRING_8
l_exc: EXCEPTIONS
do
l_corrector ?= Current
if l_corrector /= Void then
l_corrector.correct_mismatch
else
create l_msg.make_from_string ("Mismatch: ")
create l_exc
l_msg.append (generating_type)
l_exc.raise_retrieval_exception (l_msg)
end
end
feature -- attributes
context: REQUEST_DISPATCHER
-- all http environment variables
processing_finished: BOOLEAN
-- whether processing should be stopped (prematured)
return_page: VIEW
-- result html page
session: SESSION
-- reference to actual session object
feature -- form helper
fill_form_with_submitted_values
-- trying to check all fields in request url and replace corresponding tags with their values if any
-- valid only when return_page is an HTML_TEMPLATE_VIEW instance
local
a_template_based_page: HTML_TEMPLATE_VIEW
i: INTEGER_32
field_name, field_value: STRING_8
do
a_template_based_page ?= return_page
if a_template_based_page /= Void then
from
i := 1
until
i > context.fields.count
loop
field_name := context.fields.item (i)
field_value := context.text_field_value (field_name)
if not field_name.is_empty then
a_template_based_page.replace_marker_with_string (field_name, field_value)
end
i := i + 1
end
end
end
feature {NONE} -- implementation
instantiate_handler (handler_type: STRING_8): REQUEST_HANDLER
-- based on initialized handler mapping table, lookup and initialize a handler for current request
require
handler_type_specified: handler_type /= Void and not handler_type.is_empty
local
handler: INTERNAL
type: INTEGER_32
do
create handler
type := handler.dynamic_type_from_string (handler_type)
Result ?= handler.new_instance_of (type)
if Result /= Void then
Result.initialize (context)
end
end
url_rewriting
-- rewrite urls and forms, insert 'sid=session_id' to all url/form actions, so as to enable session support
-- in certain cases post action url with field texts is not supported (z.B. on apache windows), one hidden input item will be inserted into forms
local
image, url, url_with_sid: STRING_8
form_input_sid: STRING_8
start_index, end_index, href_index, endhref_index, form_index, count: INTEGER_32
result_view: VIEW
do
image := return_page.out
image.replace_substring_all ("<A ", "<a ")
image.replace_substring_all (" Href=%"", " href=%"")
image.replace_substring_all (" HREF=%"", " href=%"")
href_index := 1
count := 0
from
start_index := 1
until
start_index = 0 or start_index >= image.count
loop
start_index := image.substring_index ("<a ", start_index)
if start_index /= 0 then
end_index := image.index_of ('>', start_index + 2)
if end_index /= 0 then
href_index := image.substring_index_in_bounds (" href=%"", start_index, end_index)
if href_index /= 0 then
endhref_index := image.index_of ('"', href_index + 7)
if endhref_index /= 0 and then endhref_index < end_index then
url := image.substring (href_index, endhref_index - 1)
if url.index_of ('?', 1) /= 0 then
url_with_sid := url + "&sid=" + session.session_id
else
url_with_sid := url + "?sid=" + session.session_id
end
image.replace_substring_all (url, url_with_sid)
end
end
end
check
end_index > 0
end
start_index := end_index + 1
end
end
image.replace_substring_all ("<Form ", "<form ")
image.replace_substring_all ("<FORM ", "<form ")
form_input_sid := "%N<div><input name=%"sid%" type=%"hidden%" value=%"" + session.session_id + "%" /></div>%N"
form_index := 1
count := 0
from
start_index := 1
until
form_index = 0
loop
form_index := image.substring_index ("<form ", start_index)
if form_index /= 0 then
end_index := image.index_of ('>', form_index + 1)
if end_index /= 0 then
image.insert_string (form_input_sid, end_index + 1)
end
end
start_index := form_index + 5
end
create result_view.make
result_view.set_content (image)
return_page ?= result_view
end
feature -- main entry
process_request: HTML_PAGE
--
do
pre_processing
if not processing_finished then
handling_request
end
if not processing_finished then
post_processing
end
if context.session_enabled and not context.cookie_enabled then
url_rewriting
end
Result := return_page
ensure
result_page_generated: Result /= Void
end
feature {REQUEST_HANDLER} -- processing
handler_redirection (type: STRING_8)
-- let another handler processing and generate
local
new_handler: REQUEST_HANDLER
do
new_handler ?= instantiate_handler (type)
if new_handler /= Void then
return_page ?= new_handler.process_request
processing_finished := True
end
end
handling_request
-- common tasks to be executed after request processed
deferred
end
post_processing
-- common tasks to be executed after request processed
deferred
end
pre_processing
-- common tasks to be executed before starting process user request
deferred
end
url_redirection (url: STRING_8; is_secure: BOOLEAN)
-- let another handler processing and generate
do
context.response_header.generate_http_redirection (url, is_secure)
processing_finished := True
end
feature --creation
initialize (dispatcher: REQUEST_DISPATCHER)
-- initialize with parameters from dispatcher object
do
make
context := dispatcher
session := dispatcher.session
processing_finished := False
end
make
-- creation
do
end
invariant
-- from ANY
reflexive_equality: standard_is_equal (Current)
reflexive_conformance: conforms_to (Current)
end -- class REQUEST_HANDLER
-- Generated by ISE Eiffel --
For more details: www.eiffel.com