S/Web Objects

Request

This object handles information relating to the HTTP request. This is perhaps the most important object existing in S/Web. This handles all information related to the actual request.

Properties:

Methods:

call www_Exec_Method( "REQUEST", method, param1, param2, param3, param4, param5, errorText)

[top]

ARCHIVE

This method saves the request header, it's content and any associated client data to the WWW_REQUEST and WWW_CONTENT tables. (NB this method only works if the SESSION objects TRACKREQUESTS property is set )

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical
......

Properties  =   "NAME"
Properties  :=  @RM : "DATA"
if www_Exec_Method( "REQUEST", "GET", Properties, RetVals, "", "", "", "", errorText ) then
   UserName  =  Field( RetVals, @RM, 1 )
   UserData  =  Field( RetVals, @RM, 2 )
end else
   abort = TRUE$
end
If Abort Else
   * Archive all guest users who are searching the tech support archives
   * We can use this to see why people come to visit and what makes them want to register to the site.
   If ( UserName = "GUEST" ) And ( UserData = "TECHSUPT" ) Then
      if www_Exec_Method( "REQUEST", "ARCHIVE", "", "", "", "", "", "", errorText ) then
         null
      end else
         abort = TRUE$
      end
   End
End

[top]

CREATE

This function creates a new request object from the header file name passed in object.
This function is never called by the end user and is just documented for completion

[top]

DESTROY

This function destroys the existing request object.
Use of this function is optional, as the system will perform the necessary actions before creating a new object.

Example

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical
if www_Exec_Method( "RESPONSE", "SEND", "", "", "", "", "", "", errorText ) then
   * The request is now back on it's way to the client.
   * We can continue processing information, if we wish, however,
   * there is no direct way to return it to the client.
   * Continue processing...
end else
   abort = TRUE$
end
...........
...........
* After sending back the request, we might want to destroy the current request...
if www_Exec_Method( "REQUEST", "DESTROY", "", "", "", "", "", "", errorText ) then
    null
end else
    abort = TRUE$
end

[top]

GET

This method retrieves properties of the request object

Example: 

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

Properties   =   "BROWSER"
Values       =   ""

if www_Exec_Method( "REQUEST", "GET", Properties, Values, "", "", "", errorText ) then
   * continue on
end else
   abort = TRUE$
end

[top]

GETCONTENT

This method returns the raw HTTP request query string as sent from the client

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

if www_Exec_Method( "REQUEST", "GETCONTENT", 1, QueryString, NextBuffer, "", "", errorText ) then
   * continue
end else
   abort = TRUE$
end

[top]

GETCOOKIE

This subroutine attempts to extract a named cookie from the HTTP Request object.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

CookieName   =   "LASTVISIT"
Value        =   ""

if www_Exec_Method( "REQUEST", "GETCOOKIE", CookieName, Value, "", "", "", errorText ) then
   * continue
end else
   abort = TRUE$
end

[top]

GETQUERYARG
GETQUERYKEY

This method looks in the query string to see if a given instance of an ARGUMENT is present, regardless of whether or not it has been assigned a value.

Note that this method is used to see if an argument exists and the fact that it returns the first frame is a bonus. Use GETQUERYVALUE to retrieve the data.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

ArgumentName   =   "ADVISOR_NAME"
Instance       =   1
ValueThere     =   1

if www_Exec_Method( "REQUEST", "GETQUERYARG", ArgumentName, INstance, ValueThere, "", "", errorText ) then
   * If ValueThere is true then we know we're in the HTML page dealing with advisors so react accordingly
   * so we know the user is submitting information not requesting a page
end else
   abort = TRUE$
end

[top]

GETQUERYVAL
QUERYPARAM

This method returns a query value to the caller based on the key of the data passed.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

ArgumentName   =   "ADVISOR_NAME"
Instance       =   1
Chunk          =   1
Value          =   1
NextChunk      =   1

if www_Exec_Method( "REQUEST", "GETQUERYVAL", ArgumentName, Instance, Chunk, Value, NextChunk, errorText ) then
   * Process data
end else
   abort = TRUE$
end

[top]

SET

This method sets properties of the request object

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

If UserName = "ADMIN" Then
   * Normal users get a query only window here - admin gets TCL so call different program
   Properties   =   "PROCNAME"
   Procedure    =   "SWEB_TCL"
   if www_Exec_Method( "REQUEST", "SET", Properties, Procedure, "", "", "", errorText ) then
      * continue on
   end else
      abort = TRUE$
   end
End

[top]

SETCONTENT

This method allows for the wholesale replacement of the current request's content.

Where this could be useful is if the developer wanted to redirect a client to another S/Web routine requiring different parameters in the query.

Example:

declare function www_Exec_Method, www_Get_Status, www_Set_Status
$insert www_Status_Equates
$insert logical

If UserName = "ADMIN" Then
   * Redirect the user to another routine
   Properties   =   "PROCNAME"
   Procedure    =   "SWEB_TCL"
   if www_Exec_Method( "REQUEST", "SET", Properties, Procedure, "", "", "", errorText ) then
      * continue on and write out a new request
      NewRequest = "USERNAME=ADMIN&SECLEVEL=1&SERVER=SERVERID"
      NewRequest = WWW_Utility("ESCAPE", NewRequest)
      if www_Exec_Method( "REQUEST", "SETCONTENT", NewRequest, Procedure, "", "", "", errorText ) then
         * continue on
      End  
   end else
      abort = TRUE$
   end
End

[top]