UE3:WebAdmin (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

Properties

auth

Type: IWebAdminAuth

The authorization handler instance

AuthenticationClass

Type: string

Modifiers: globalconfig

Defines the authentication handler class to use instead of the default one.

bChatLog

Type: bool

Modifiers: globalconfig

bHttpAuth

Type: bool

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: DataStoreCache

defaultAuthClass

Type: Class

The default authentication class

Default value: Class'WebAdmin.BasicWebAdminAuth'

defaultSessClass

Type: Class

The default session handler class

Default value: Class'WebAdmin.SessionHandler'

handlers

Type: array<IQueryHandler>

The loaded handlers.

menu

Type: WebAdminMenu

The menu handler

pccleanup

Type: PCCleanUp

QueryHandlers

Type: array<string>

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

Modifiers: protected

local storage. Used to construct the auth URLs.

SessionHandlerClass

Type: string

Modifiers: globalconfig

The session handler to use instead of the default session handler

sessions

Type: ISessionHandler

The session handler

startpage

Type: string

Modifiers: globalconfig

The starting page. Defaults to /current

Default value: "/current"

timestamp

Type: string

Modifiers: const

Will contain the timestamp when this package was compiled

Default value: "2008-06-03 19:29:29 +0000"

version

Type: string

Modifiers: const

Default value: "1.4"

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.KeyValuePair> cookies)

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)