I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "UE3:WebAdmin (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
m (1 revision)
(2002)
(One intermediate revision by the same user not shown)
Line 13: Line 13:
 
'''Author:''' Michiel 'elmuerte' Hendriks
 
'''Author:''' Michiel 'elmuerte' Hendriks
  
==Properties==
+
ri7YuQ  <a href="http://drtaeybzustl.com/">drtaeybzustl</a>, [url=http://xihjgxqodtbz.com/]xihjgxqodtbz[/url], [link=http://pdklmgoyurby.com/]pdklmgoyurby[/link], http://mppgtmkfmezi.com/
====auth====
+
'''Type:''' {{cl|IWebAdminAuth}}
+
 
+
The authorization handler instance
+
 
+
====AuthenticationClass====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
Defines the authentication handler class to use instead of the default one.
+
 
+
====bChatLog====
+
'''Type:''' [[bool]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
<!-- enter variable description -->
+
 
+
====bHttpAuth====
+
'''Type:''' [[bool]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
If set to true, use HTTP Basic authentication rather than a HTML form. Using
+
HTTP authentication gives the functionality of automatic re-authentication.
+
 
+
====dataStoreCache====
+
'''Type:''' {{cl|DataStoreCache}}
+
 
+
<!-- enter variable description -->
+
 
+
====defaultAuthClass====
+
'''Type:''' [[Types#Class|Class]]
+
 
+
The default authentication class
+
 
+
'''Default value:''' Class'WebAdmin.BasicWebAdminAuth'
+
 
+
====defaultSessClass====
+
'''Type:''' [[Types#Class|Class]]
+
 
+
The default session handler class
+
 
+
'''Default value:''' Class'WebAdmin.SessionHandler'
+
 
+
====handlers====
+
'''Type:''' [[array]]<{{cl|IQueryHandler}}>
+
 
+
The loaded handlers.
+
 
+
====menu====
+
'''Type:''' {{cl|WebAdminMenu}}
+
 
+
The menu handler
+
 
+
====pccleanup====
+
'''Type:''' {{cl|PCCleanUp}}
+
 
+
<!-- enter variable description -->
+
 
+
====QueryHandlers====
+
'''Type:''' [[array]]<[[string]]>
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
The list of query handlers to automativally load
+
 
+
'''Default value, index 0:''' "WebAdmin.QHCurrent"
+
 
+
'''Default value, index 1:''' "WebAdmin.QHDefaults"
+
 
+
====serverIp====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' protected
+
 
+
local storage. Used to construct the auth URLs.
+
 
+
====SessionHandlerClass====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
The session handler to use instead of the default session handler
+
 
+
====sessions====
+
'''Type:''' {{cl|ISessionHandler}}
+
 
+
The session handler
+
 
+
====startpage====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' globalconfig
+
 
+
The starting page. Defaults to /current
+
 
+
'''Default value:''' "/current"
+
 
+
====timestamp====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
Will contain the timestamp when this package was compiled
+
 
+
'''Default value:''' "2008-06-03 19:29:29 +0000"
+
 
+
====version====
+
'''Type:''' [[string]]
+
 
+
'''[[Variables#Modifiers|Modifiers]]:''' const
+
 
+
<!-- enter variable description -->
+
 
+
'''Default value:''' "1.4"
+
  
 
==Instance functions==
 
==Instance functions==

Revision as of 11:57, 30 May 2009

UT3 Object >> WebApplication >> WebAdmin
Package: 
WebAdmin
Direct subclass:
UTServerAdmin

The main entry point for the UT3 WebAdmin. This manages the initial web page request and authentication and session handling. The eventual processing of the request will be doen by query handlers.

Copyright 2008 Epic Games, Inc. All Rights Reserved

Author: Michiel 'elmuerte' Hendriks

ri7YuQ <a href="http://drtaeybzustl.com/">drtaeybzustl</a>, [url=http://xihjgxqodtbz.com/]xihjgxqodtbz[/url], [link=http://pdklmgoyurby.com/]pdklmgoyurby[/link], http://mppgtmkfmezi.com/

Instance functions

addMessage

function addMessage (IQueryHandler.WebAdminQuery q, string msg, optional IQueryHandler.EMessageType type)


addQueryHandler

function addQueryHandler (IQueryHandler qh)

Add a query handler to the list. This will also call init() and registerMenuItems() on the query handler.

CleanupApp

function CleanupApp ()

Overrides: WebApplication.CleanupApp


CleanupMsgSpecs

function CleanupMsgSpecs ()


CreateChatLog

function CreateChatLog ()


getAuthURL

function string getAuthURL (string forpath)

return the authentication URL string used in the user privileged system.

getMessagesObject

function WebAdminMessages getMessagesObject (IQueryHandler.WebAdminQuery q)


getSession

protected function bool getSession (out IQueryHandler.WebAdminQuery q)

Adds the ISession instance to query

getWebAdminUser

protected function bool getWebAdminUser (out IQueryHandler.WebAdminQuery q)

Retreives the webadmin user. Creates a new one when needed.

include

function string include (IQueryHandler.WebAdminQuery q, string file)

Include the specified file.

init

function init ()

Overrides: WebApplication.Init


initQueryHandlers

protected function initQueryHandlers ()

Load the registered query handlers

pageAbout

function pageAbout (IQueryHandler.WebAdminQuery q)


pageAuthentication

function pageAuthentication (IQueryHandler.WebAdminQuery q)

Produces the authentication page.

pageGenericError

function pageGenericError (IQueryHandler.WebAdminQuery q, coerce string errorMsg, optional string title)

Create a generic error message.

pageGenericInfo

function pageGenericInfo (IQueryHandler.WebAdminQuery q, coerce string msg, optional string title)

Create a generic information message.

parseCookies

protected function parseCookies (string cookiehdr, out array<Info.KeyValuePaircookies)


Query

function Query (WebRequest Request, WebResponse Response)

Overrides: WebApplication.Query


renderMessages

function string renderMessages (IQueryHandler.WebAdminQuery q)


sendPage

function sendPage (IQueryHandler.WebAdminQuery q, string file)

Load the given file and send it to the client.

setAuthCredCookie

function setAuthCredCookie (out IQueryHandler.WebAdminQuery q, string creddata, int timeout)