Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Package
The package is also a Factory for login managers and also the base class
for all login managers.
On it's own, an object of this class is used when you specify 'none' in
the security setup section of | ||||||||
Changed: | ||||||||
< < | configure. When it is used, | |||||||
> > | configure. When it is used, | |||||||
logins are not supported. If you want to authenticate users then you should
consider TemplateLogin or ApacheLogin, which are subclasses of this class.
If you are building a new login manager, then you should write a new subclass
of this class, implementing the methods marked as VIRTUAL. There are already
examples in the lib/TWiki/Client directory.
The class has extensive tracing, which is enabled by
$TWiki::cfg{Trace}{Client.pm}. The tracing is done in such a way as to
let the perl optimiser optimise out the trace function as a no-op if tracing
is disabled. | ||||||||
Added: | ||||||||
> > | Here's an overview of how it works:
Early in TWiki::new, the login manager is created. The creation of the login manager does two things:
| |||||||
ObjectData | ||||||||
Added: | ||||||||
> > | ||||||||
The TWiki object this login manager is attached to.
On this page:
| ||||||||
Changed: | ||||||||
< < | StaticMethod makeClient ($twiki) -> $TWiki::Client | |||||||
> > | StaticMethod makeLoginManager ($twiki) -> $TWiki::Client | |||||||
Factory method, used to generate a new TWiki::Client object for the given session. | ||||||||
Changed: | ||||||||
< < | ObjectMethod loadSession () | |||||||
> > | ObjectMethod loadSession ($defaultUser) -> $login | |||||||
Get the client session data, using the cookie and/or the request URL. Set up appropriate session variables in the twiki object and return the login name. | ||||||||
Added: | ||||||||
> > | $defaultUser is a username to use if one is not available from other sources. The username passed when you create a TWiki instance is passed in here. | |||||||
ObjectMethod checkAccess () | ||||||||
Added: | ||||||||
> > | ||||||||
Check if the script being run in this session is authorised for execution.
If not, throw an access control exception.
ObjectMethod finish | ||||||||
Added: | ||||||||
> > | ||||||||
Complete processing after the client's HTTP request has been responded
to. Flush the user's session (if any) to disk.
StaticMethod expireDeadSessions () | ||||||||
Changed: | ||||||||
< < | Delete sessions that are sitting around but are really expired. | |||||||
> > | Delete sessions and passthrough files that are sitting around but are really expired. | |||||||
This assumes that the sessions are stored as files.
This is a static method, but requires TWiki::cfg. It is designed to be
run from a session or from a cron job.
ObjectMethod userLoggedIn ($login,$wikiname)Called when the user logs in. It's invoked from TWiki::UI::Register::finish for instance, when the user follows the link in their verification email message.
ObjectMethod endRenderingHandler () | ||||||||
Added: | ||||||||
> > | ||||||||
This handler is called by getRenderedVersion just before the plugins
postRenderingHandler. So it is passed all HTML text just before it is
printed.
DEPRECATED Use postRenderingHandler instead.
ObjectMethod addCookie ($c)Add a cookie to the list of cookies for this session.
ObjectMethod modifyHeader (\%header) | ||||||||
Added: | ||||||||
> > | ||||||||
Modify a HTTP header
ObjectMethod redirectCgiQuery ($url) | ||||||||
Added: | ||||||||
> > | ||||||||
Generate an HTTP redirect on STDOUT, if you can. Return 1 if you did. | ||||||||
Deleted: | ||||||||
< < | Don't forget to pass all query parameters through. | |||||||
ObjectMethod getSessionValues () -> \%values | ||||||||
Added: | ||||||||
> > | ||||||||
Get a name->value hash of all the defined session variables
ObjectMethod getSessionValue ($name) -> $value | ||||||||
Added: | ||||||||
> > | ||||||||
Get the value of a session variable.
ObjectMethod setSessionValue ($name,$value) | ||||||||
Added: | ||||||||
> > | ||||||||
Set the value of a session variable. We do not allow setting of AUTHUSER. | ||||||||
Changed: | ||||||||
< < | ObjectMethod clearSessionValue ($name) | |||||||
> > | ObjectMethod clearSessionValue ($name) -> $boolean | |||||||
Clear the value of a session variable.
We do not allow setting of AUTHUSER.
ObjectMethod forceAuthentication () -> booleanVIRTUAL METHOD implemented by subclasses Triggered by an access control violation, this method tests to see if the current session is authenticated or not. If not, it does whatever is needed so that the user can log in, and returns 1. If the user has an existing authenticated session, the function simply drops though and returns 0.ObjectMethod loginUrl (...) -> $urlVIRTUAL METHOD implemented by subclasses Return a full URL suitable for logging in.
ObjectMethod getUser ()VIRTUAL METHOD implemented by subclasses If there is some other means of getting a username - for example, Apache has remote_user() - then return it. Otherwise, return undef and the username stored in the session will be used. |