Line: 5 to 5 | ||||||||
---|---|---|---|---|---|---|---|---|
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. | ||||||||
Line: 18 to 18 | ||||||||
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. | ||||||||
Line: 24 to 42 | ||||||||
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 () | ||||||||
Line: 51 to 76 | ||||||||
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 | ||||||||
Line: 92 to 120 | ||||||||
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. | |||||||
| ||||||||
Line: 114 to 145 | ||||||||
Changed: | ||||||||
< < | ObjectMethod clearSessionValue ($name) | |||||||
> > | ObjectMethod clearSessionValue ($name) -> $boolean | |||||||
Clear the value of a session variable. We do not allow setting of AUTHUSER. |
Line: 13 to 13 | ||||||||
---|---|---|---|---|---|---|---|---|
of this class, implementing the methods marked as VIRTUAL. There are already
examples in the lib/TWiki/Client directory. | ||||||||
Added: | ||||||||
> > | 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.
ObjectData?
The TWiki object this login manager is attached to. | |||||||
Line: 1 to 1 | ||||||||
---|---|---|---|---|---|---|---|---|
Added: | ||||||||
> > | 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
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 |